mem.c 11.7 KB
Newer Older
Bob Halley's avatar
base  
Bob Halley committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
/*
 * Copyright (c) 1997, 1998 by Internet Software Consortium.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
 * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
 * CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
 * SOFTWARE.
 */

#include <sys/types.h>

#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#include "attribute.h"
#include <isc/assertions.h>
26
#include <isc/error.h>
Bob Halley's avatar
base  
Bob Halley committed
27

Bob Halley's avatar
Bob Halley committed
28
#include <isc/memcluster.h>
Bob Halley's avatar
base  
Bob Halley committed
29

30
#ifndef ISC_SINGLETHREADED
Bob Halley's avatar
update  
Bob Halley committed
31 32 33
#include <isc/mutex.h>
#endif

Bob Halley's avatar
base  
Bob Halley committed
34
#if !defined(LINT) && !defined(CODECENTER)
35
static char rcsid[] __attribute__((unused)) = "$Id: mem.c,v 1.9 1998/12/04 20:00:13 halley Exp $";
Bob Halley's avatar
base  
Bob Halley committed
36 37 38 39 40 41 42 43
#endif /* not lint */

/*
 * Types.
 */

typedef struct {
	void *			next;
Bob Halley's avatar
Bob Halley committed
44
} element;
Bob Halley's avatar
base  
Bob Halley committed
45 46 47 48 49 50 51 52 53

typedef struct {
	size_t			size;
	/*
	 * This structure must be ALIGNMENT_SIZE bytes.
	 */
} *size_info;

struct stats {
Bob Halley's avatar
Bob Halley committed
54 55 56 57
	unsigned long		gets;
	unsigned long		totalgets;
	unsigned long		blocks;
	unsigned long		freefrags;
Bob Halley's avatar
base  
Bob Halley committed
58 59
};

Bob Halley's avatar
Bob Halley committed
60
struct isc_memctx {
Bob Halley's avatar
base  
Bob Halley committed
61 62
	size_t			max_size;
	size_t			mem_target;
Bob Halley's avatar
Bob Halley committed
63 64
	element **		freelists;
	element *		basic_blocks;
65 66 67
	unsigned char **	basic_table;
	unsigned int		basic_table_count;
	unsigned int		basic_table_size;
Bob Halley's avatar
Bob Halley committed
68 69
	unsigned char *		lowest;
	unsigned char *		highest;
Bob Halley's avatar
base  
Bob Halley committed
70
	struct stats *		stats;
Bob Halley's avatar
Bob Halley committed
71
	isc_mutex_t		mutex;
Bob Halley's avatar
base  
Bob Halley committed
72 73 74 75 76 77 78 79 80 81 82 83
};

/* Forward. */

static size_t			quantize(size_t);

/* Macros. */

#define DEF_MAX_SIZE		1100
#define DEF_MEM_TARGET		4096
#define ALIGNMENT_SIZE		sizeof (void *)
#define NUM_BASIC_BLOCKS	64			/* must be > 1 */
84
#define TABLE_INCREMENT		1024
Bob Halley's avatar
base  
Bob Halley committed
85

86
#ifndef ISC_SINGLETHREADED
Bob Halley's avatar
Bob Halley committed
87 88 89 90
#define LOCK_CONTEXT(ctx) \
	INSIST(isc_mutex_lock(&(ctx)->mutex) == ISC_R_SUCCESS)
#define UNLOCK_CONTEXT(ctx) \
	INSIST(isc_mutex_unlock(&(ctx)->mutex) == ISC_R_SUCCESS)
Bob Halley's avatar
update  
Bob Halley committed
91 92 93 94
#else
#define LOCK_CONTEXT(ctx)
#define UNLOCK_CONTEXT(ctx)
#endif
Bob Halley's avatar
base  
Bob Halley committed
95 96 97

/* Private Inline-able. */

Bob Halley's avatar
update  
Bob Halley committed
98
static inline size_t 
Bob Halley's avatar
base  
Bob Halley committed
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
quantize(size_t size) {
	int remainder;

	/*
	 * If there is no remainder for the integer division of 
	 *
	 *	(rightsize/ALIGNMENT_SIZE)
	 *
	 * then we already have a good size; if not, then we need
	 * to round up the result in order to get a size big
	 * enough to satisfy the request and be aligned on ALIGNMENT_SIZE
	 * byte boundaries.
	 */
	remainder = size % ALIGNMENT_SIZE;
	if (remainder != 0)
        	size += ALIGNMENT_SIZE - remainder;
	return (size);
}

/* Public. */

Bob Halley's avatar
Bob Halley committed
120 121 122 123 124 125 126
isc_result_t
isc_memctx_create(size_t init_max_size, size_t target_size,
		  isc_memctx_t *ctxp)
{
	isc_memctx_t ctx;

	REQUIRE(ctxp != NULL && *ctxp == NULL);
Bob Halley's avatar
base  
Bob Halley committed
127 128 129 130 131 132 133 134 135 136

	ctx = malloc(sizeof *ctx);
	if (init_max_size == 0)
		ctx->max_size = DEF_MAX_SIZE;
	else
		ctx->max_size = init_max_size;
	if (target_size == 0)
		ctx->mem_target = DEF_MEM_TARGET;
	else
		ctx->mem_target = target_size;
Bob Halley's avatar
Bob Halley committed
137
	ctx->freelists = malloc(ctx->max_size * sizeof (element *));
Bob Halley's avatar
base  
Bob Halley committed
138 139
	if (ctx->freelists == NULL) {
		free(ctx);
Bob Halley's avatar
Bob Halley committed
140
		return (ISC_R_NOMEMORY);
Bob Halley's avatar
base  
Bob Halley committed
141 142
	}
	memset(ctx->freelists, 0,
Bob Halley's avatar
Bob Halley committed
143
	       ctx->max_size * sizeof (element *));
Bob Halley's avatar
base  
Bob Halley committed
144 145 146 147
	ctx->stats = malloc((ctx->max_size+1) * sizeof (struct stats));
	if (ctx->stats == NULL) {
		free(ctx->freelists);
		free(ctx);
Bob Halley's avatar
Bob Halley committed
148
		return (ISC_R_NOMEMORY);
Bob Halley's avatar
base  
Bob Halley committed
149 150 151
	}
	memset(ctx->stats, 0, (ctx->max_size + 1) * sizeof (struct stats));
	ctx->basic_blocks = NULL;
152 153 154
	ctx->basic_table = NULL;
	ctx->basic_table_count = 0;
	ctx->basic_table_size = 0;
Bob Halley's avatar
base  
Bob Halley committed
155 156
	ctx->lowest = NULL;
	ctx->highest = NULL;
Bob Halley's avatar
Bob Halley committed
157
	if (isc_mutex_init(&ctx->mutex) != ISC_R_SUCCESS) {
Bob Halley's avatar
update  
Bob Halley committed
158 159 160
		free(ctx->stats);
		free(ctx->freelists);
		free(ctx);
Bob Halley's avatar
Bob Halley committed
161
		UNEXPECTED_ERROR(__FILE__, __LINE__,
Bob Halley's avatar
Bob Halley committed
162
				 "isc_mutex_init() failed");
Bob Halley's avatar
Bob Halley committed
163
		return (ISC_R_UNEXPECTED);
Bob Halley's avatar
update  
Bob Halley committed
164
	}
Bob Halley's avatar
base  
Bob Halley committed
165
	*ctxp = ctx;
Bob Halley's avatar
Bob Halley committed
166
	return (ISC_R_SUCCESS);
Bob Halley's avatar
base  
Bob Halley committed
167 168 169
}

void
Bob Halley's avatar
Bob Halley committed
170
isc_memctx_destroy(isc_memctx_t *ctxp) {
171
	unsigned int i;
Bob Halley's avatar
Bob Halley committed
172
	isc_memctx_t ctx;
173

Bob Halley's avatar
base  
Bob Halley committed
174
	REQUIRE(ctxp != NULL);
Bob Halley's avatar
Bob Halley committed
175

176 177 178 179 180 181 182 183 184 185
	ctx = *ctxp;

	for (i = 0; i <= ctx->max_size; i++)
		INSIST(ctx->stats[i].gets == 0);

	for (i = 0; i < ctx->basic_table_count; i++)
		free(ctx->basic_table[i]);
	free(ctx->freelists);
	free(ctx->stats);
	free(ctx->basic_table);
Bob Halley's avatar
Bob Halley committed
186
	(void)isc_mutex_destroy(&ctx->mutex);
187
	free(ctx);
Bob Halley's avatar
base  
Bob Halley committed
188 189 190 191

	*ctxp = NULL;
}

192
static void
Bob Halley's avatar
Bob Halley committed
193
more_basic_blocks(isc_memctx_t ctx) {
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
	void *new;
	unsigned char *curr, *next;
	unsigned char *first, *last;
	unsigned char **table;
	unsigned int table_size;
	int i;

	/* Require: we hold the context lock. */

	if (ctx->basic_table_count <= ctx->basic_table_size) {
		table_size = ctx->basic_table_size + TABLE_INCREMENT;
		table = malloc(table_size * sizeof (unsigned char *));
		if (table == NULL)
			return;
		memcpy(table, ctx->basic_table,
		       ctx->basic_table_size * sizeof (unsigned char *));
		free(ctx->basic_table);
		ctx->basic_table = table;
		ctx->basic_table_size = table_size;
	} else
		table = NULL;

	new = malloc(NUM_BASIC_BLOCKS * ctx->mem_target);
	if (new == NULL) {
		if (table != NULL)
			free(table);
		return;
	}
	ctx->basic_table[ctx->basic_table_count] = new;
	ctx->basic_table_count++;
	curr = new;
	next = curr + ctx->mem_target;
	for (i = 0; i < (NUM_BASIC_BLOCKS - 1); i++) {
Bob Halley's avatar
Bob Halley committed
227
		((element *)curr)->next = next;
228 229 230 231 232 233 234
		curr = next;
		next += ctx->mem_target;
	}
	/*
	 * curr is now pointing at the last block in the
	 * array.
	 */
Bob Halley's avatar
Bob Halley committed
235
	((element *)curr)->next = NULL;
236 237 238 239 240 241 242 243 244
	first = new;
	last = first + NUM_BASIC_BLOCKS * ctx->mem_target - 1;
	if (first < ctx->lowest || ctx->lowest == NULL)
		ctx->lowest = first;
	if (last > ctx->highest)
		ctx->highest = last;
	ctx->basic_blocks = new;
}

Bob Halley's avatar
base  
Bob Halley committed
245
void *
Bob Halley's avatar
Bob Halley committed
246
__isc_mem_get(isc_memctx_t ctx, size_t size) {
Bob Halley's avatar
base  
Bob Halley committed
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
	size_t new_size = quantize(size);
	void *ret;

	REQUIRE(size > 0);

	LOCK_CONTEXT(ctx);

	if (size >= ctx->max_size || new_size >= ctx->max_size) {
		/* memget() was called on something beyond our upper limit. */
		ret = malloc(size);
		if (ret != NULL) {
			ctx->stats[ctx->max_size].gets++;
			ctx->stats[ctx->max_size].totalgets++;
		}
		goto done;
	}

	/* 
	 * If there are no blocks in the free list for this size, get a chunk
	 * of memory and then break it up into "new_size"-sized blocks, adding
	 * them to the free list.
	 */
	if (ctx->freelists[new_size] == NULL) {
		int i, frags;
		size_t total_size;
		void *new;
Bob Halley's avatar
Bob Halley committed
273
		unsigned char *curr, *next;
Bob Halley's avatar
base  
Bob Halley committed
274 275

		if (ctx->basic_blocks == NULL) {
276 277
			more_basic_blocks(ctx);
			if (ctx->basic_blocks == NULL) {
Bob Halley's avatar
base  
Bob Halley committed
278 279 280 281 282 283 284 285 286 287 288 289 290 291
				ret = NULL;
				goto done;
			}
		}
		total_size = ctx->mem_target;
		new = ctx->basic_blocks;
		ctx->basic_blocks = ctx->basic_blocks->next;
		frags = total_size / new_size;
		ctx->stats[new_size].blocks++;
		ctx->stats[new_size].freefrags += frags;
		/* Set up a linked-list of blocks of size "new_size". */
		curr = new;
		next = curr + new_size;
		for (i = 0; i < (frags - 1); i++) {
Bob Halley's avatar
Bob Halley committed
292
			((element *)curr)->next = next;
Bob Halley's avatar
base  
Bob Halley committed
293 294 295 296
			curr = next;
			next += new_size;
		}
		/* curr is now pointing at the last block in the array. */
Bob Halley's avatar
Bob Halley committed
297
		((element *)curr)->next = NULL;
Bob Halley's avatar
base  
Bob Halley committed
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
		ctx->freelists[new_size] = new;
	}

	/* The free list uses the "rounded-up" size "new_size": */
	ret = ctx->freelists[new_size];
	ctx->freelists[new_size] = ctx->freelists[new_size]->next;

	/* 
	 * The stats[] uses the _actual_ "size" requested by the
	 * caller, with the caveat (in the code above) that "size" >= the
	 * max. size (max_size) ends up getting recorded as a call to
	 * max_size.
	 */
	ctx->stats[size].gets++;
	ctx->stats[size].totalgets++;
	ctx->stats[new_size].freefrags--;

 done:
	UNLOCK_CONTEXT(ctx);

	return (ret);
}

/* 
 * This is a call from an external caller, 
 * so we want to count this as a user "put". 
 */
void
Bob Halley's avatar
Bob Halley committed
326
__isc_mem_put(isc_memctx_t ctx, void *mem, size_t size) {
Bob Halley's avatar
base  
Bob Halley committed
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
	size_t new_size = quantize(size);

	REQUIRE(size > 0);

	LOCK_CONTEXT(ctx);

	if (size == ctx->max_size || new_size >= ctx->max_size) {
		/* memput() called on something beyond our upper limit */
		free(mem);
		INSIST(ctx->stats[ctx->max_size].gets != 0);
		ctx->stats[ctx->max_size].gets--;
		goto done;
	}

	/* The free list uses the "rounded-up" size "new_size": */
Bob Halley's avatar
Bob Halley committed
342 343
	((element *)mem)->next = ctx->freelists[new_size];
	ctx->freelists[new_size] = (element *)mem;
Bob Halley's avatar
base  
Bob Halley committed
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359

	/* 
	 * The stats[] uses the _actual_ "size" requested by the
	 * caller, with the caveat (in the code above) that "size" >= the
	 * max. size (max_size) ends up getting recorded as a call to
	 * max_size.
	 */
	INSIST(ctx->stats[size].gets != 0);
	ctx->stats[size].gets--;
	ctx->stats[new_size].freefrags++;

 done:
	UNLOCK_CONTEXT(ctx);
}

void *
Bob Halley's avatar
Bob Halley committed
360
__isc_mem_getdebug(isc_memctx_t ctx, size_t size, const char *file, int line) {
Bob Halley's avatar
base  
Bob Halley committed
361
	void *ptr;
Bob Halley's avatar
Bob Halley committed
362 363

	ptr = __isc_mem_get(ctx, size);
Bob Halley's avatar
base  
Bob Halley committed
364
	fprintf(stderr, "%s:%d: mem_get(%p, %lu) -> %p\n", file, line,
Bob Halley's avatar
Bob Halley committed
365
		ctx, (unsigned long)size, ptr);
Bob Halley's avatar
base  
Bob Halley committed
366 367 368 369
	return (ptr);
}

void
Bob Halley's avatar
Bob Halley committed
370 371
__isc_mem_putdebug(isc_memctx_t ctx, void *ptr, size_t size, const char *file,
		   int line)
Bob Halley's avatar
base  
Bob Halley committed
372 373
{
	fprintf(stderr, "%s:%d: mem_put(%p, %p, %lu)\n", file, line, 
Bob Halley's avatar
Bob Halley committed
374
		ctx, ptr, (unsigned long)size);
Bob Halley's avatar
Bob Halley committed
375
	__isc_mem_put(ctx, ptr, size);
Bob Halley's avatar
base  
Bob Halley committed
376 377 378 379 380 381
}

/*
 * Print the stats[] on the stream "out" with suitable formatting.
 */
void
Bob Halley's avatar
Bob Halley committed
382
isc_mem_stats(isc_memctx_t ctx, FILE *out) {
Bob Halley's avatar
base  
Bob Halley committed
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
	size_t i;

	LOCK_CONTEXT(ctx);

	if (ctx->freelists == NULL)
		return;
	for (i = 1; i <= ctx->max_size; i++) {
		const struct stats *s = &ctx->stats[i];

		if (s->totalgets == 0 && s->gets == 0)
			continue;
		fprintf(out, "%s%5d: %11lu gets, %11lu rem",
			(i == ctx->max_size) ? ">=" : "  ",
			i, s->totalgets, s->gets);
		if (s->blocks != 0)
			fprintf(out, " (%lu bl, %lu ff)",
				s->blocks, s->freefrags);
		fputc('\n', out);
	}

	UNLOCK_CONTEXT(ctx);
}

Bob Halley's avatar
Bob Halley committed
406 407
isc_boolean_t
isc_mem_valid(isc_memctx_t ctx, void *ptr) {
Bob Halley's avatar
Bob Halley committed
408
	unsigned char *cp = ptr;
Bob Halley's avatar
Bob Halley committed
409
	isc_boolean_t result = ISC_FALSE;
Bob Halley's avatar
base  
Bob Halley committed
410 411 412 413

	LOCK_CONTEXT(ctx);

	if (ctx->lowest != NULL && cp >= ctx->lowest && cp <= ctx->highest)
Bob Halley's avatar
Bob Halley committed
414
		result = ISC_TRUE;
Bob Halley's avatar
base  
Bob Halley committed
415 416 417

	UNLOCK_CONTEXT(ctx);

Bob Halley's avatar
Bob Halley committed
418
	return (result);
Bob Halley's avatar
base  
Bob Halley committed
419 420 421 422 423 424 425
}

/*
 * Replacements for malloc() and free().
 */

void *
Bob Halley's avatar
Bob Halley committed
426
isc_mem_allocate(isc_memctx_t ctx, size_t size) {
Bob Halley's avatar
base  
Bob Halley committed
427 428 429
	size_info si;

	size += ALIGNMENT_SIZE;
Bob Halley's avatar
Bob Halley committed
430
	si = isc_mem_get(ctx, size);
Bob Halley's avatar
base  
Bob Halley committed
431 432 433 434 435 436 437
	if (si == NULL)
		return (NULL);
	si->size = size;
	return (&si[1]);
}

void
Bob Halley's avatar
Bob Halley committed
438
isc_mem_free(isc_memctx_t ctx, void *ptr) {
Bob Halley's avatar
base  
Bob Halley committed
439 440 441
	size_info si;

	si = &(((size_info)ptr)[-1]);
Bob Halley's avatar
Bob Halley committed
442
	isc_mem_put(ctx, si, si->size);
Bob Halley's avatar
base  
Bob Halley committed
443 444
}

Bob Halley's avatar
Bob Halley committed
445 446
#ifdef ISC_MEMCLUSTER_LEGACY

Bob Halley's avatar
base  
Bob Halley committed
447 448 449 450
/*
 * Public Legacy.
 */

Bob Halley's avatar
Bob Halley committed
451 452
static isc_memctx_t 		default_context = NULL;

Bob Halley's avatar
base  
Bob Halley committed
453 454 455 456 457
int
meminit(size_t init_max_size, size_t target_size) {
	/* need default_context lock here */
	if (default_context != NULL)
		return (-1);
Bob Halley's avatar
Bob Halley committed
458
	return (isc_mem_create(init_max_size, target_size, &default_context));
Bob Halley's avatar
base  
Bob Halley committed
459 460
}

Bob Halley's avatar
Bob Halley committed
461
isc_memctx_t
Bob Halley's avatar
base  
Bob Halley committed
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488
mem_default_context(void) {
	/* need default_context lock here */
	if (default_context == NULL && meminit(0, 0) == -1)
		return (NULL);
	return (default_context);
}

void *
__memget(size_t size) {
	/* need default_context lock here */
	if (default_context == NULL && meminit(0, 0) == -1)
		return (NULL);
	return (__mem_get(default_context, size));
}

void
__memput(void *mem, size_t size) {
	/* need default_context lock here */
	REQUIRE(default_context != NULL);
	__mem_put(default_context, mem, size);
}

void *
__memget_debug(size_t size, const char *file, int line) {
	void *ptr;
	ptr = __memget(size);
	fprintf(stderr, "%s:%d: memget(%lu) -> %p\n", file, line,
Bob Halley's avatar
Bob Halley committed
489
		(unsigned long)size, ptr);
Bob Halley's avatar
base  
Bob Halley committed
490 491 492 493 494 495
	return (ptr);
}

void
__memput_debug(void *ptr, size_t size, const char *file, int line) {
	fprintf(stderr, "%s:%d: memput(%p, %lu)\n", file, line, 
Bob Halley's avatar
Bob Halley committed
496
		ptr, (unsigned long)size);
Bob Halley's avatar
base  
Bob Halley committed
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
	__memput(ptr, size);
}

int
memvalid(void *ptr) {
	/* need default_context lock here */
	REQUIRE(default_context != NULL);
	return (mem_valid(default_context, ptr));
}

void
memstats(FILE *out) {
	/* need default_context lock here */
	REQUIRE(default_context != NULL);
	mem_stats(default_context, out);
}
Bob Halley's avatar
Bob Halley committed
513 514

#endif /* ISC_MEMCLUSTER_LEGACY */