mem.c 27 KB
Newer Older
Bob Halley's avatar
base  
Bob Halley committed
1
/*
Bob Halley's avatar
Bob Halley committed
2
 * Copyright (C) 1997, 1998, 1999  Internet Software Consortium.
Bob Halley's avatar
Bob Halley committed
3
 * 
Bob Halley's avatar
base  
Bob Halley committed
4 5 6
 * 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.
Bob Halley's avatar
Bob Halley committed
7
 * 
Bob Halley's avatar
base  
Bob Halley committed
8 9 10 11 12 13 14 15 16 17
 * 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.
 */

Bob Halley's avatar
Bob Halley committed
18
#include <config.h>
Bob Halley's avatar
base  
Bob Halley committed
19 20 21

#include <stdio.h>
#include <stdlib.h>
Bob Halley's avatar
Bob Halley committed
22
#include <stddef.h>
Bob Halley's avatar
base  
Bob Halley committed
23 24
#include <string.h>

Michael Graff's avatar
Michael Graff committed
25 26
#include <limits.h>

Bob Halley's avatar
base  
Bob Halley committed
27
#include <isc/assertions.h>
28
#include <isc/error.h>
Bob Halley's avatar
Bob Halley committed
29
#include <isc/mem.h>
Bob Halley's avatar
Bob Halley committed
30

31
#ifndef ISC_SINGLETHREADED
Bob Halley's avatar
update  
Bob Halley committed
32
#include <isc/mutex.h>
Bob Halley's avatar
Bob Halley committed
33 34
#include "util.h"
#else
Bob Halley's avatar
Bob Halley committed
35 36
#define LOCK(l)
#define UNLOCK(l)
Bob Halley's avatar
update  
Bob Halley committed
37 38
#endif

Bob Halley's avatar
Bob Halley committed
39
#ifndef ISC_MEM_FILL
40 41
	/*
	 * XXXMPA
Bob Halley's avatar
Bob Halley committed
42
	 * We want this on during development to catch:
43 44 45 46 47 48
	 * 1. some reference after free bugs.
	 * 2. some failure to initalise bugs.
	 */
#define ISC_MEM_FILL 1
#endif

Michael Graff's avatar
Michael Graff committed
49 50 51 52 53 54 55 56
#ifndef ISC_MEMPOOL_NAMES
/*
 * During development it is nice to be able to see names associated with
 * memory pools.
 */
#define ISC_MEMPOOL_NAMES 1
#endif

57 58 59 60 61 62 63 64 65 66 67

/*
 * Constants.
 */

#define DEF_MAX_SIZE		1100
#define DEF_MEM_TARGET		4096
#define ALIGNMENT_SIZE		8
#define NUM_BASIC_BLOCKS	64			/* must be > 1 */
#define TABLE_INCREMENT		1024

Bob Halley's avatar
base  
Bob Halley committed
68 69 70 71
/*
 * Types.
 */

72
typedef struct element {
Bob Halley's avatar
base  
Bob Halley committed
73
	void *			next;
74 75
	const char *		file;
	int			line;
Bob Halley's avatar
Bob Halley committed
76
} element;
Bob Halley's avatar
base  
Bob Halley committed
77 78 79 80 81

typedef struct {
	/*
	 * This structure must be ALIGNMENT_SIZE bytes.
	 */
82 83 84 85
	union {
		size_t		size;
		char		bytes[ALIGNMENT_SIZE];
	} u;
Bob Halley's avatar
Bob Halley committed
86
} size_info;
Bob Halley's avatar
base  
Bob Halley committed
87 88

struct stats {
Bob Halley's avatar
Bob Halley committed
89 90 91 92
	unsigned long		gets;
	unsigned long		totalgets;
	unsigned long		blocks;
	unsigned long		freefrags;
Bob Halley's avatar
base  
Bob Halley committed
93 94
};

95 96
#define MEM_MAGIC		0x4D656d43U	/* MemC. */
#define VALID_CONTEXT(c)	((c) != NULL && (c)->magic == MEM_MAGIC)
Bob Halley's avatar
Bob Halley committed
97

98
struct isc_mem {
Bob Halley's avatar
Bob Halley committed
99 100
	unsigned int		magic;
	isc_mutex_t		lock;
101 102 103
	isc_memalloc_t		memalloc;
	isc_memfree_t		memfree;
	void *			arg;
Bob Halley's avatar
base  
Bob Halley committed
104 105
	size_t			max_size;
	size_t			mem_target;
Bob Halley's avatar
Bob Halley committed
106 107
	element **		freelists;
	element *		basic_blocks;
108
	element **		allocated;
109 110 111
	unsigned char **	basic_table;
	unsigned int		basic_table_count;
	unsigned int		basic_table_size;
Bob Halley's avatar
Bob Halley committed
112 113
	unsigned char *		lowest;
	unsigned char *		highest;
114
	isc_boolean_t		checkfree;
Bob Halley's avatar
base  
Bob Halley committed
115
	struct stats *		stats;
116
	size_t			quota;
Bob Halley's avatar
Bob Halley committed
117
	size_t			total;
Michael Graff's avatar
Michael Graff committed
118 119 120 121 122 123 124
	ISC_LIST(isc_mempool_t)	pools;
};

#define MEMPOOL_MAGIC		0x4D454d70U	/* MEMp. */
#define VALID_MEMPOOL(c)	((c) != NULL && (c)->magic == MEMPOOL_MAGIC)

struct isc_mempool {
Michael Graff's avatar
Michael Graff committed
125
	/* always unlocked */
Michael Graff's avatar
Michael Graff committed
126
	unsigned int	magic;		/* magic number */
Michael Graff's avatar
Michael Graff committed
127
	isc_mutex_t    *lock;		/* optional lock */
Michael Graff's avatar
Michael Graff committed
128
	isc_mem_t      *mctx;		/* our memory context */
Michael Graff's avatar
Michael Graff committed
129 130 131
	/* locked via the memory context's lock */
	ISC_LINK(isc_mempool_t)	link;	/* next pool in this mem context */
	/* optionally locked from here down */
Michael Graff's avatar
Michael Graff committed
132 133 134 135 136 137 138 139 140
	element	       *items;		/* low water item list */
	size_t		size;		/* size of each item on this pool */
	unsigned int	maxalloc;	/* max number of items allowed */
	unsigned int	allocated;	/* # of items currently given out */
	unsigned int	freecount;	/* # of items on reserved list */
	unsigned int	freemax;	/* # of items allowed on free list */
	unsigned int	fillcount;	/* # of items to fetch on each fill */
	/* Stats only. */
	unsigned int	gets;		/* # of requests to this pool */
Michael Graff's avatar
Michael Graff committed
141 142 143 144
	/* Debugging only. */
#if ISC_MEMPOOL_NAMES
	char		name[16];	/* printed name in stats reports */
#endif
Bob Halley's avatar
base  
Bob Halley committed
145 146
};

147 148 149
/*
 * Forward.
 */
Bob Halley's avatar
base  
Bob Halley committed
150

Michael Graff's avatar
Michael Graff committed
151
static inline size_t		quantize(size_t);
152 153 154 155
static inline void		mem_putunlocked(isc_mem_t *, void *, size_t,
						const char *, int);
static inline void *		mem_getunlocked(isc_mem_t *, size_t, 
						const char *, int);
Bob Halley's avatar
base  
Bob Halley committed
156

157 158 159
/*
 * Private Inline-able.
 */
Bob Halley's avatar
base  
Bob Halley committed
160

161
static inline size_t
Bob Halley's avatar
base  
Bob Halley committed
162
quantize(size_t size) {
163
	int temp;
Bob Halley's avatar
base  
Bob Halley committed
164 165

	/*
166
	 * Round up the result in order to get a size big
Bob Halley's avatar
base  
Bob Halley committed
167 168 169
	 * enough to satisfy the request and be aligned on ALIGNMENT_SIZE
	 * byte boundaries.
	 */
170

171
	temp = size + sizeof(element) + (ALIGNMENT_SIZE - 1);
172
	return (temp - temp % ALIGNMENT_SIZE); 
Bob Halley's avatar
base  
Bob Halley committed
173 174
}

175 176 177
/*
 * Private.
 */
178 179 180 181 182 183 184 185 186 187

static void *
default_memalloc(void *arg, size_t size) {
	(void)arg;
	return (malloc(size));
}

static void
default_memfree(void *arg, void *ptr) {
	(void)arg;
James Brister's avatar
James Brister committed
188
	free(ptr);
189 190
}

191 192 193
/*
 * Public.
 */
Bob Halley's avatar
base  
Bob Halley committed
194

Bob Halley's avatar
Bob Halley committed
195
isc_result_t
196 197 198
isc_mem_createx(size_t init_max_size, size_t target_size,
		isc_memalloc_t memalloc, isc_memfree_t memfree, void *arg,
		isc_mem_t **ctxp)
Bob Halley's avatar
Bob Halley committed
199
{
200
	isc_mem_t *ctx;
Bob Halley's avatar
Bob Halley committed
201 202

	REQUIRE(ctxp != NULL && *ctxp == NULL);
203 204
	REQUIRE(memalloc != NULL);
	REQUIRE(memfree != NULL);
Bob Halley's avatar
base  
Bob Halley committed
205

206
	ctx = (memalloc)(arg, sizeof *ctx);
Michael Graff's avatar
Michael Graff committed
207 208 209
	if (ctx == NULL)
		return (ISC_R_NOMEMORY);

Bob Halley's avatar
base  
Bob Halley committed
210 211 212 213 214 215 216 217
	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;
218 219 220 221
	ctx->memalloc = memalloc;
	ctx->memfree = memfree;
	ctx->arg = arg;
	ctx->freelists = (memalloc)(arg, ctx->max_size * sizeof (element *));
222 223 224 225 226 227
	ctx->allocated = (memalloc)(arg, ctx->max_size * sizeof (element *));
	if (ctx->freelists == NULL || ctx->allocated == NULL) {
		if (ctx->freelists != NULL)
			(memfree)(arg, ctx->freelists);
		if (ctx->allocated != NULL)
			(memfree)(arg, ctx->allocated);
228
		(memfree)(arg, ctx);
Bob Halley's avatar
Bob Halley committed
229
		return (ISC_R_NOMEMORY);
Bob Halley's avatar
base  
Bob Halley committed
230
	}
231
	ctx->checkfree = ISC_TRUE;
Bob Halley's avatar
Bob Halley committed
232 233
	memset(ctx->freelists, 0,
	       ctx->max_size * sizeof (element *));
234 235
	memset(ctx->allocated, 0,
	       ctx->max_size * sizeof (element *));
236 237
	ctx->stats = (memalloc)(arg,
				(ctx->max_size+1) * sizeof (struct stats));
Bob Halley's avatar
base  
Bob Halley committed
238
	if (ctx->stats == NULL) {
239
		(memfree)(arg, ctx->freelists);
240
		(memfree)(arg, ctx->allocated);
241
		(memfree)(arg, ctx);
Bob Halley's avatar
Bob Halley committed
242
		return (ISC_R_NOMEMORY);
Bob Halley's avatar
base  
Bob Halley committed
243 244 245
	}
	memset(ctx->stats, 0, (ctx->max_size + 1) * sizeof (struct stats));
	ctx->basic_blocks = NULL;
246 247 248
	ctx->basic_table = NULL;
	ctx->basic_table_count = 0;
	ctx->basic_table_size = 0;
Bob Halley's avatar
base  
Bob Halley committed
249 250
	ctx->lowest = NULL;
	ctx->highest = NULL;
Bob Halley's avatar
Bob Halley committed
251
	if (isc_mutex_init(&ctx->lock) != ISC_R_SUCCESS) {
252 253
		(memfree)(arg, ctx->stats);
		(memfree)(arg, ctx->freelists);
254
		(memfree)(arg, ctx->allocated);
255
		(memfree)(arg, ctx);
Bob Halley's avatar
Bob Halley committed
256
		UNEXPECTED_ERROR(__FILE__, __LINE__,
Bob Halley's avatar
Bob Halley committed
257
				 "isc_mutex_init() failed");
Bob Halley's avatar
Bob Halley committed
258
		return (ISC_R_UNEXPECTED);
Bob Halley's avatar
update  
Bob Halley committed
259
	}
260
	ctx->quota = 0;
Bob Halley's avatar
Bob Halley committed
261
	ctx->total = 0;
Bob Halley's avatar
Bob Halley committed
262
	ctx->magic = MEM_MAGIC;
Michael Graff's avatar
Michael Graff committed
263 264
	ISC_LIST_INIT(ctx->pools);

Bob Halley's avatar
base  
Bob Halley committed
265
	*ctxp = ctx;
Bob Halley's avatar
Bob Halley committed
266
	return (ISC_R_SUCCESS);
Bob Halley's avatar
base  
Bob Halley committed
267 268
}

269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
void
isc_mem_allocated(isc_mem_t *ctx, FILE *file) {
	unsigned int i;
	element *el;

	REQUIRE(VALID_CONTEXT(ctx));
	REQUIRE(file != NULL);

	fflush(stdout);
	fflush(stderr);
	fflush(file);
	for (i = 0 ; i <= ctx->max_size; i++) {
		el = ctx->allocated[i];
		while (el != NULL) {
			fprintf(file,
				"bytes %d: address %p: file %s: line %d\n",
				i, el + 1,
				(el->file != NULL) ? el->file : "<UNKNOWN>",
				el->line);
			el = el->next;
		}
	}
	fflush(file);
}

294 295 296 297 298 299 300 301 302
isc_result_t
isc_mem_create(size_t init_max_size, size_t target_size,
	       isc_mem_t **ctxp)
{
	return (isc_mem_createx(init_max_size, target_size,
				default_memalloc, default_memfree, NULL,
				ctxp));
}

Bob Halley's avatar
base  
Bob Halley committed
303
void
304
isc_mem_destroy(isc_mem_t **ctxp) {
305
	unsigned int i;
306
	isc_mem_t *ctx;
307

Bob Halley's avatar
base  
Bob Halley committed
308
	REQUIRE(ctxp != NULL);
309
	ctx = *ctxp;
Bob Halley's avatar
Bob Halley committed
310 311
	REQUIRE(VALID_CONTEXT(ctx));

312 313
	isc_mem_allocated(ctx, stderr);

Bob Halley's avatar
Bob Halley committed
314
	ctx->magic = 0;
315

Michael Graff's avatar
Michael Graff committed
316 317
	INSIST(ISC_LIST_EMPTY(ctx->pools));

318 319 320 321 322 323 324 325 326 327 328
	if (ctx->checkfree) {
		for (i = 0; i <= ctx->max_size; i++)
			INSIST(ctx->stats[i].gets == 0);
	}

#if 0					/* XXX brister debugging */
	for (i = 0; i < ctx->basic_table_count; i++)
		memset(ctx->basic_table[i], 0x0,
		       NUM_BASIC_BLOCKS * ctx->mem_target);
#endif
	
329 330

	for (i = 0; i < ctx->basic_table_count; i++)
331 332
		(ctx->memfree)(ctx->arg, ctx->basic_table[i]);
	(ctx->memfree)(ctx->arg, ctx->freelists);
333
	(ctx->memfree)(ctx->arg, ctx->allocated);
334 335
	(ctx->memfree)(ctx->arg, ctx->stats);
	(ctx->memfree)(ctx->arg, ctx->basic_table);
336

Bob Halley's avatar
Bob Halley committed
337
	(void)isc_mutex_destroy(&ctx->lock);
338
	(ctx->memfree)(ctx->arg, ctx);
Bob Halley's avatar
base  
Bob Halley committed
339 340 341 342

	*ctxp = NULL;
}

343 344 345 346 347 348 349 350 351 352 353
isc_result_t
isc_mem_restore(isc_mem_t *ctx) {
	isc_result_t result;

	result = isc_mutex_init(&ctx->lock); 
	if (result != ISC_R_SUCCESS)
		ctx->magic = 0;

	return (result);
}

354
static void
355
more_basic_blocks(isc_mem_t *ctx) {
356 357 358 359 360
	void *new;
	unsigned char *curr, *next;
	unsigned char *first, *last;
	unsigned char **table;
	unsigned int table_size;
Bob Halley's avatar
Bob Halley committed
361
	size_t increment;
362 363 364 365
	int i;

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

366 367 368
	/*
	 * Did we hit the quota for this context?
	 */
Bob Halley's avatar
Bob Halley committed
369 370 371
	increment = NUM_BASIC_BLOCKS * ctx->mem_target;
	if (ctx->quota != 0 && ctx->total + increment > ctx->quota)
		return;
372 373 374

	INSIST(ctx->basic_table_count <= ctx->basic_table_size);
	if (ctx->basic_table_count == ctx->basic_table_size) {
375
		table_size = ctx->basic_table_size + TABLE_INCREMENT;
376 377
		table = (ctx->memalloc)(ctx->arg,
					table_size * sizeof (unsigned char *));
378 379
		if (table == NULL)
			return;
380 381 382 383
		if (ctx->basic_table_size != 0) {
			memcpy(table, ctx->basic_table,
			       ctx->basic_table_size *
			       sizeof (unsigned char *));
384
			(ctx->memfree)(ctx->arg, ctx->basic_table);
385
		}
386 387
		ctx->basic_table = table;
		ctx->basic_table_size = table_size;
388
	}
389

390
	new = (ctx->memalloc)(ctx->arg, NUM_BASIC_BLOCKS * ctx->mem_target);
391
	if (new == NULL)
392
		return;
Bob Halley's avatar
Bob Halley committed
393
	ctx->total += increment;
394 395
	ctx->basic_table[ctx->basic_table_count] = new;
	ctx->basic_table_count++;
396

397 398 399
	curr = new;
	next = curr + ctx->mem_target;
	for (i = 0; i < (NUM_BASIC_BLOCKS - 1); i++) {
Bob Halley's avatar
Bob Halley committed
400
		((element *)curr)->next = next;
401 402 403 404 405 406 407
		curr = next;
		next += ctx->mem_target;
	}
	/*
	 * curr is now pointing at the last block in the
	 * array.
	 */
Bob Halley's avatar
Bob Halley committed
408
	((element *)curr)->next = NULL;
409 410 411 412 413 414 415 416 417
	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
418
void *
419
__isc_mem_get(isc_mem_t *ctx, size_t size, const char *file, int line)
Michael Graff's avatar
Michael Graff committed
420
{
Bob Halley's avatar
base  
Bob Halley committed
421 422 423
	void *ret;

	REQUIRE(size > 0);
Bob Halley's avatar
Bob Halley committed
424
	REQUIRE(VALID_CONTEXT(ctx));
Michael Graff's avatar
Michael Graff committed
425

Bob Halley's avatar
Bob Halley committed
426
	LOCK(&ctx->lock);
427
	ret = mem_getunlocked(ctx, size, file, line);
Michael Graff's avatar
Michael Graff committed
428 429 430 431 432 433
	UNLOCK(&ctx->lock);

	return (ret);
}

static inline void *
434
mem_getunlocked(isc_mem_t *ctx, size_t size, const char *file, int line)
Michael Graff's avatar
Michael Graff committed
435 436 437
{
	size_t new_size = quantize(size);
	void *ret;
438
	element *el;
Bob Halley's avatar
base  
Bob Halley committed
439 440 441

	if (size >= ctx->max_size || new_size >= ctx->max_size) {
		/* memget() was called on something beyond our upper limit. */
Bob Halley's avatar
Bob Halley committed
442 443 444 445
		if (ctx->quota != 0 && ctx->total + size > ctx->quota) {
			ret = NULL;
			goto done;
		}
446
		ret = (ctx->memalloc)(ctx->arg, new_size);
Bob Halley's avatar
base  
Bob Halley committed
447
		if (ret != NULL) {
Bob Halley's avatar
Bob Halley committed
448
			ctx->total += size;
Bob Halley's avatar
base  
Bob Halley committed
449 450
			ctx->stats[ctx->max_size].gets++;
			ctx->stats[ctx->max_size].totalgets++;
451 452 453 454 455
			el = ret;
			el->file = file;
			el->line = line;
			el->next = ctx->allocated[ctx->max_size];
			ctx->allocated[ctx->max_size] = el;
Bob Halley's avatar
base  
Bob Halley committed
456
		}
457

Bob Halley's avatar
base  
Bob Halley committed
458 459 460 461 462 463 464 465 466 467 468 469
		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
470
		unsigned char *curr, *next;
Bob Halley's avatar
base  
Bob Halley committed
471 472

		if (ctx->basic_blocks == NULL) {
473 474
			more_basic_blocks(ctx);
			if (ctx->basic_blocks == NULL) {
Bob Halley's avatar
base  
Bob Halley committed
475 476 477 478 479 480 481 482 483 484 485 486 487 488
				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
489
			((element *)curr)->next = next;
490 491
			((element *)curr)->file = NULL;
			((element *)curr)->line = -1;
Bob Halley's avatar
base  
Bob Halley committed
492 493 494 495
			curr = next;
			next += new_size;
		}
		/* curr is now pointing at the last block in the array. */
Bob Halley's avatar
Bob Halley committed
496
		((element *)curr)->next = NULL;
497 498
		((element *)curr)->file = NULL;
		((element *)curr)->line = -1;
Bob Halley's avatar
base  
Bob Halley committed
499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
		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++;
514 515 516 517 518
	el = ret;
	el->file = file;
	el->line = line;
	el->next = ctx->allocated[size];
	ctx->allocated[size] = el;
Bob Halley's avatar
base  
Bob Halley committed
519 520 521 522
	ctx->stats[new_size].freefrags--;

 done:

523 524
	ret = (element *)ret + 1;
	new_size -= sizeof(element);
525 526 527 528 529
#if ISC_MEM_FILL
	if (ret != NULL)
		memset(ret, 0xbe, new_size); /* Mnemonic for "beef". */
#endif

Bob Halley's avatar
base  
Bob Halley committed
530 531 532 533
	return (ret);
}

void
534 535
__isc_mem_put(isc_mem_t *ctx, void *mem, size_t size,
	      const char *file, int line)
Michael Graff's avatar
Michael Graff committed
536
{
Bob Halley's avatar
base  
Bob Halley committed
537
	REQUIRE(size > 0);
Bob Halley's avatar
Bob Halley committed
538
	REQUIRE(VALID_CONTEXT(ctx));
Michael Graff's avatar
Michael Graff committed
539

Bob Halley's avatar
Bob Halley committed
540
	LOCK(&ctx->lock);
541
	mem_putunlocked(ctx, mem, size, file, line);
Michael Graff's avatar
Michael Graff committed
542 543 544 545
	UNLOCK(&ctx->lock);
}

static inline void
546 547
mem_putunlocked(isc_mem_t *ctx, void *mem, size_t size,
		const char *file, int line)
Michael Graff's avatar
Michael Graff committed
548 549
{
	size_t new_size = quantize(size);
550
	element *el, *e, *p;
Bob Halley's avatar
base  
Bob Halley committed
551

552
#if ISC_MEM_FILL
553 554
	/* Mnemonic for "dead". */
	memset(mem, 0xde, new_size - sizeof(element));
555
#endif
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571

	mem = (element *)mem - 1;
	el = mem;
	if (size == ctx->max_size || new_size >= ctx->max_size) {
		/* memput() called on something beyond our upper limit */
		e = ctx->allocated[ctx->max_size];
		p = NULL;
		while (e != NULL && e != el) {
			p = e;
			e = e->next;
		}
		INSIST(e != NULL);
		if (p == NULL)
			ctx->allocated[ctx->max_size] = el->next;
		else
			p->next = el->next;
572
		(ctx->memfree)(ctx->arg, mem);
Bob Halley's avatar
base  
Bob Halley committed
573 574
		INSIST(ctx->stats[ctx->max_size].gets != 0);
		ctx->stats[ctx->max_size].gets--;
Bob Halley's avatar
Bob Halley committed
575 576
		INSIST(size <= ctx->total);
		ctx->total -= size;
Michael Graff's avatar
Michael Graff committed
577
		return;
Bob Halley's avatar
base  
Bob Halley committed
578 579
	}

580 581 582 583 584 585 586 587 588 589 590 591
	/* Remove element from allocated list */
	e = ctx->allocated[size];
	p = NULL;
	while (e != NULL && e != el) {
		p = e;
		e = e->next;
	}
	INSIST(e != NULL);
	if (p == NULL)
		ctx->allocated[size] = el->next;
	else
		p->next = el->next;
592

Bob Halley's avatar
base  
Bob Halley committed
593
	/* The free list uses the "rounded-up" size "new_size": */
594 595 596 597
	el->next = ctx->freelists[new_size];
	el->file = file;
	el->line = line;
	ctx->freelists[new_size] = el;
Bob Halley's avatar
base  
Bob Halley committed
598 599 600 601 602 603 604 605 606 607 608 609 610

	/* 
	 * 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++;
}

void *
611
__isc_mem_getdebug(isc_mem_t *ctx, size_t size, const char *file, int line) {
Bob Halley's avatar
base  
Bob Halley committed
612
	void *ptr;
Bob Halley's avatar
Bob Halley committed
613

614
	ptr = __isc_mem_get(ctx, size, file, line);
Bob Halley's avatar
base  
Bob Halley committed
615
	fprintf(stderr, "%s:%d: mem_get(%p, %lu) -> %p\n", file, line,
Bob Halley's avatar
Bob Halley committed
616
		ctx, (unsigned long)size, ptr);
Bob Halley's avatar
base  
Bob Halley committed
617 618 619 620
	return (ptr);
}

void
621
__isc_mem_putdebug(isc_mem_t *ctx, void *ptr, size_t size, const char *file,
Bob Halley's avatar
Bob Halley committed
622
		 int line)
Bob Halley's avatar
base  
Bob Halley committed
623 624
{
	fprintf(stderr, "%s:%d: mem_put(%p, %p, %lu)\n", file, line, 
Bob Halley's avatar
Bob Halley committed
625
		ctx, ptr, (unsigned long)size);
626
	__isc_mem_put(ctx, ptr, size, file, line);
Bob Halley's avatar
base  
Bob Halley committed
627 628 629 630 631 632
}

/*
 * Print the stats[] on the stream "out" with suitable formatting.
 */
void
Michael Graff's avatar
Michael Graff committed
633 634
isc_mem_stats(isc_mem_t *ctx, FILE *out)
{
Bob Halley's avatar
base  
Bob Halley committed
635
	size_t i;
Michael Graff's avatar
Michael Graff committed
636 637
	const struct stats *s;
	const isc_mempool_t *pool;
Bob Halley's avatar
base  
Bob Halley committed
638

Bob Halley's avatar
Bob Halley committed
639 640
	REQUIRE(VALID_CONTEXT(ctx));
	LOCK(&ctx->lock);
Bob Halley's avatar
base  
Bob Halley committed
641

Michael Graff's avatar
Michael Graff committed
642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657
	if (ctx->freelists != NULL) {
		for (i = 1; i <= ctx->max_size; i++) {
			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);
		}
	}

Michael Graff's avatar
Michael Graff committed
658 659 660 661 662 663 664
	/*
	 * Note that since a pool can be locked now, these stats might be
	 * somewhat off if the pool is in active use at the time the stats
	 * are dumped.  The link fields are protected by the isc_mem_t's
	 * lock, however, so walking this list and extracting integers from
	 * stats fields is always safe.
	 */
Michael Graff's avatar
Michael Graff committed
665 666 667
	pool = ISC_LIST_HEAD(ctx->pools);
	if (pool != NULL) {
		fprintf(out, "[Pool statistics]\n");
Michael Graff's avatar
Michael Graff committed
668 669
		fprintf(out, "%15s %10s %10s %10s %10s %10s %10s %10s %1s\n",
			"name", "size", "maxalloc", "allocated", "freecount",
Michael Graff's avatar
Michael Graff committed
670
			"freemax", "fillcount", "gets", "L");
Michael Graff's avatar
Michael Graff committed
671 672
	}
	while (pool != NULL) {
Michael Graff's avatar
Michael Graff committed
673 674 675 676
		fprintf(out, "%15s %10u %10u %10u %10u %10u %10u %10u %s\n",
			pool->name, pool->size, pool->maxalloc,
			pool->allocated, pool->freecount, pool->freemax,
			pool->fillcount, pool->gets,
Michael Graff's avatar
Michael Graff committed
677
			(pool->lock == NULL ? "N" : "Y"));
Michael Graff's avatar
Michael Graff committed
678
		pool = ISC_LIST_NEXT(pool, link);
Bob Halley's avatar
base  
Bob Halley committed
679 680
	}

Bob Halley's avatar
Bob Halley committed
681
	UNLOCK(&ctx->lock);
Bob Halley's avatar
base  
Bob Halley committed
682 683
}

Bob Halley's avatar
Bob Halley committed
684
isc_boolean_t
685
isc_mem_valid(isc_mem_t *ctx, void *ptr) {
Bob Halley's avatar
Bob Halley committed
686
	unsigned char *cp = ptr;
Bob Halley's avatar
Bob Halley committed
687
	isc_boolean_t result = ISC_FALSE;
Bob Halley's avatar
base  
Bob Halley committed
688

Bob Halley's avatar
Bob Halley committed
689 690
	REQUIRE(VALID_CONTEXT(ctx));
	LOCK(&ctx->lock);
Bob Halley's avatar
base  
Bob Halley committed
691 692

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

Bob Halley's avatar
Bob Halley committed
695
	UNLOCK(&ctx->lock);
Bob Halley's avatar
base  
Bob Halley committed
696

Bob Halley's avatar
Bob Halley committed
697
	return (result);
Bob Halley's avatar
base  
Bob Halley committed
698 699 700 701 702 703 704
}

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

void *
705
isc_mem_allocate(isc_mem_t *ctx, size_t size) {
Bob Halley's avatar
Bob Halley committed
706
	size_info *si;
Bob Halley's avatar
base  
Bob Halley committed
707 708

	size += ALIGNMENT_SIZE;
Bob Halley's avatar
Bob Halley committed
709
	si = isc_mem_get(ctx, size);
Bob Halley's avatar
base  
Bob Halley committed
710 711
	if (si == NULL)
		return (NULL);
712
	si->u.size = size;
Bob Halley's avatar
base  
Bob Halley committed
713 714 715 716
	return (&si[1]);
}

void
717
isc_mem_free(isc_mem_t *ctx, void *ptr) {
Bob Halley's avatar
Bob Halley committed
718
	size_info *si;
Bob Halley's avatar
base  
Bob Halley committed
719

Bob Halley's avatar
Bob Halley committed
720
	si = &(((size_info *)ptr)[-1]);
721
	isc_mem_put(ctx, si, si->u.size);
Bob Halley's avatar
base  
Bob Halley committed
722 723
}

Bob Halley's avatar
Bob Halley committed
724 725 726 727
/*
 * Other useful things.
 */

Bob Halley's avatar
Bob Halley committed
728 729 730 731 732 733 734 735 736 737 738 739 740 741
char *
isc_mem_strdup(isc_mem_t *mctx, const char *s) {
	size_t len;
	char *ns;

	len = strlen(s);
	ns = isc_mem_allocate(mctx, len + 1);
	if (ns == NULL)
		return (NULL);
	strncpy(ns, s, len + 1);
	
	return (ns);
}

742 743 744 745 746 747 748 749 750 751 752 753
isc_boolean_t
isc_mem_destroy_check(isc_mem_t *mctx, isc_boolean_t flag) {
	isc_boolean_t oldval;

	INSIST(mctx != NULL);

	oldval = mctx->checkfree;
	mctx->checkfree = flag;
	return (oldval);
}


754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781
/*
 * Quotas
 */

void
isc_mem_setquota(isc_mem_t *ctx, size_t quota) {
	REQUIRE(VALID_CONTEXT(ctx));
	LOCK(&ctx->lock);

	ctx->quota = quota;

	UNLOCK(&ctx->lock);
}

size_t
isc_mem_getquota(isc_mem_t *ctx) {
	size_t quota;

	REQUIRE(VALID_CONTEXT(ctx));
	LOCK(&ctx->lock);

	quota = ctx->quota;

	UNLOCK(&ctx->lock);

	return (quota);
}

Bob Halley's avatar
Bob Halley committed
782 783
#ifdef ISC_MEMCLUSTER_LEGACY

Bob Halley's avatar
base  
Bob Halley committed
784 785 786 787
/*
 * Public Legacy.
 */

788
static isc_mem_t *default_context = NULL;
Bob Halley's avatar
Bob Halley committed
789

Bob Halley's avatar
base  
Bob Halley committed
790 791 792 793 794
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
795
	return (isc_mem_create(init_max_size, target_size, &default_context));
Bob Halley's avatar
base  
Bob Halley committed
796 797
}

798
isc_mem_t *
Bob Halley's avatar
base  
Bob Halley committed
799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825
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
826
		(unsigned long)size, ptr);
Bob Halley's avatar
base  
Bob Halley committed
827 828 829 830 831 832
	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
833
		ptr, (unsigned long)size);
Bob Halley's avatar
base  
Bob Halley committed
834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849
	__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
850 851

#endif /* ISC_MEMCLUSTER_LEGACY */
Michael Graff's avatar
Michael Graff committed
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879


/*
 * Memory pool stuff
 */


#if 0
/*
 * Free all but "n" items from the pool's free list.  If n == 0, all items
 * will be returned to the mctx.
 */
static void
mempool_release(isc_mempool_t *mpctx, unsigned int n)
{
	isc_mem_t *mctx;
	element *item;
	element *next;
	unsigned int count;

	mctx = mpctx->mctx;

	if (mpctx->freecount <= n)
		return;

	INSIST(mpctx->items != NULL);
	item = mpctx->items;
	for (count = 0 ; count < n ; count++) {
Michael Graff's avatar
Michael Graff committed
880
		item = item->next;
Michael Graff's avatar
Michael Graff committed
881 882 883 884 885 886 887 888 889
		INSIST(item != NULL);
	}

	/*
	 * All remaining items are to be freed.  Lock the context once,
	 * free them all, and unlock the context.
	 */
	LOCK(&mctx->lock);
	do {
Michael Graff's avatar
Michael Graff committed
890
		next = item->next;
Michael Graff's avatar
Michael Graff committed
891 892 893 894 895 896 897 898 899 900 901
		mem_putunlocked(mctx, item, mpctx->size);
		INSIST(mpctx->freecount > 0);
		mpctx->freecount--;
		item = next;
	} while (item != NULL);
	UNLOCK(&mctx->lock);
}
#endif

/*
 * Release all items on the free list.  No locking is done, the memory
Michael Graff's avatar
Michael Graff committed
902
 * context must be locked, and the pool if needed.
Michael Graff's avatar
Michael Graff committed
903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919
 */
static void
mempool_releaseall(isc_mempool_t *mpctx)
{
	isc_mem_t *mctx;
	element *item;
	element *next;

	mctx = mpctx->mctx;

	if (mpctx->freecount == 0)
		return;

	INSIST(mpctx->items != NULL);
	item = mpctx->items;

	do {
Michael Graff's avatar
Michael Graff committed
920
		next = item->next;
921
		mem_putunlocked(mctx, item, mpctx->size, __FILE__, __LINE__);
Michael Graff's avatar
Michael Graff committed
922 923 924 925 926 927 928
		INSIST(mpctx->freecount > 0);
		mpctx->freecount--;
		item = next;
	} while (item != NULL);
}

isc_result_t
Michael Graff's avatar
Michael Graff committed
929
isc_mempool_create(isc_mem_t *mctx, size_t size, isc_mempool_t **mpctxp)
Michael Graff's avatar
Michael Graff committed
930 931 932 933
{
	isc_mempool_t *mpctx;

	REQUIRE(VALID_CONTEXT(mctx));
Michael Graff's avatar
Michael Graff committed
934
	REQUIRE(size > 0);
Michael Graff's avatar
Michael Graff committed
935 936 937 938 939 940 941 942
	REQUIRE(mpctxp != NULL && *mpctxp == NULL);

	/*
	 * Allocate space for this pool, initialize values, and if all works
	 * well, attach to the memory context.
	 */
	LOCK(&mctx->lock);

943 944
	mpctx = mem_getunlocked(mctx, sizeof(isc_mempool_t),
				__FILE__, __LINE__);
Michael Graff's avatar
Michael Graff committed
945 946 947 948 949 950
	if (mpctx == NULL) {
		UNLOCK(&mctx->lock);
		return (ISC_R_NOMEMORY);
	}

	mpctx->magic = MEMPOOL_MAGIC;
Michael Graff's avatar
Michael Graff committed
951
	mpctx->lock = NULL;
Michael Graff's avatar
Michael Graff committed
952
	mpctx->mctx = mctx;
Michael Graff's avatar
Michael Graff committed
953
	mpctx->size = size;
Michael Graff's avatar
Michael Graff committed
954 955 956 957 958 959
	mpctx->maxalloc = UINT_MAX;
	mpctx->allocated = 0;
	mpctx->freecount = 0;
	mpctx->freemax = 1;
	mpctx->fillcount = 1;
	mpctx->gets = 0;
Michael Graff's avatar
Michael Graff committed
960 961 962
#if ISC_MEMPOOL_NAMES
	mpctx->name[0] = 0;
#endif
Michael Graff's avatar
Michael Graff committed
963 964 965 966 967 968 969 970 971 972 973
	mpctx->items = NULL;

	*mpctxp = mpctx;

	ISC_LIST_APPEND(mctx->pools, mpctx, link);

	UNLOCK(&mctx->lock);

	return (ISC_R_SUCCESS);
}

Michael Graff's avatar
Michael Graff committed
974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993
void
isc_mempool_setname(isc_mempool_t *mpctx, char *name)
{
	REQUIRE(name != NULL);

#if ISC_MEMPOOL_NAMES
	if (mpctx->lock != NULL)
		LOCK(mpctx->lock);

	memset(mpctx->name, 0, sizeof(mpctx->name));
	strncpy(mpctx->name, name, sizeof(mpctx->name) - 1);

	if (mpctx->lock != NULL)
		UNLOCK(mpctx->lock);
#else
	(void)mpctx;
	(void)name;
#endif
}

Michael Graff's avatar
Michael Graff committed
994 995 996 997 998
void
isc_mempool_destroy(isc_mempool_t **mpctxp)
{
	isc_mempool_t *mpctx;
	isc_mem_t *mctx;
Michael Graff's avatar
Michael Graff committed
999
	isc_mutex_t *lock;
Michael Graff's avatar
Michael Graff committed
1000 1001 1002 1003 1004 1005 1006 1007

	REQUIRE(mpctxp != NULL);
	mpctx = *mpctxp;
	REQUIRE(VALID_MEMPOOL(mpctx));
	REQUIRE(mpctx->allocated == 0);

	mctx = mpctx->mctx;

Michael Graff's avatar
Michael Graff committed
1008 1009 1010 1011 1012
	lock = mpctx->lock;

	if (lock != NULL)
		LOCK(lock);

Michael Graff's avatar
Michael Graff committed
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
	LOCK(&mctx->lock);

	/*
	 * Return any items on the free list
	 */
	mempool_releaseall(mpctx);

	/*
	 * Remove our linked list entry from the memory context.
	 */
	ISC_LIST_UNLINK(mctx->pools, mpctx, link);
	
	mpctx->magic = 0;

1027 1028
	mem_putunlocked(mpctx->mctx, mpctx, sizeof(isc_mempool_t),
			__FILE__, __LINE__);
Michael Graff's avatar
Michael Graff committed
1029 1030 1031

	UNLOCK(&mctx->lock);

Michael Graff's avatar
Michael Graff committed
1032 1033 1034
	if (lock != NULL)
		UNLOCK(lock);

Michael Graff's avatar
Michael Graff committed
1035 1036 1037
	*mpctxp = NULL;
}

Michael Graff's avatar
Michael Graff committed
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
void
isc_mempool_associatelock(isc_mempool_t *mpctx, isc_mutex_t *lock)
{
	REQUIRE(VALID_MEMPOOL(mpctx));
	REQUIRE(mpctx->lock == NULL);
	REQUIRE(lock != NULL);

	mpctx->lock = lock;
}

Michael Graff's avatar
Michael Graff committed
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
void *
__isc_mempool_get(isc_mempool_t *mpctx)
{
	element *item;
	isc_mem_t *mctx;
	unsigned int i;

	REQUIRE(VALID_MEMPOOL(mpctx));

	mctx = mpctx->mctx;

Michael Graff's avatar
Michael Graff committed
1059 1060 1061
	if (mpctx->lock != NULL)
		LOCK(mpctx->lock);

Michael Graff's avatar
Michael Graff committed
1062 1063 1064
	/*
	 * Don't let the caller go over quota
	 */
Michael Graff's avatar
Michael Graff committed
1065 1066 1067 1068
	if (mpctx->allocated >= mpctx->maxalloc) {
		item = NULL;
		goto out;
	}
Michael Graff's avatar
Michael Graff committed
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079

	/*
	 * if we have a free list item, return the first here
	 */
	item = mpctx->items;
	if (item != NULL) {
		mpctx->items = item->next;
		INSIST(mpctx->freecount > 0);
		mpctx->freecount--;
		mpctx->gets++;
		mpctx->allocated++;
Michael Graff's avatar
Michael Graff committed
1080
		goto out;
Michael Graff's avatar
Michael Graff committed
1081 1082 1083 1084 1085 1086 1087 1088
	}

	/*
	 * We need to dip into the well.  Lock the memory context here and
	 * fill up our free list.
	 */
	LOCK(&mctx->lock);
	for (i = 0 ; i < mpctx->fillcount ; i++) {
1089
		item = mem_getunlocked(mctx, mpctx->size, __FILE__, __LINE__);
Michael Graff's avatar
Michael Graff committed
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102
		if (item == NULL)
			break;
		item->next = mpctx->items;
		mpctx->items = item;
		mpctx->freecount++;
	}
	UNLOCK(&mctx->lock);

	/*
	 * If we didn't get any items, return NULL.
	 */
	item = mpctx->items;
	if (item == NULL)
Michael Graff's avatar
Michael Graff committed
1103
		goto out;
Michael Graff's avatar
Michael Graff committed
1104 1105 1106 1107 1108

	mpctx->items = item->next;
	mpctx->freecount--;
	mpctx->gets++;
	mpctx->allocated++;