mem.c 36.5 KB
Newer Older
Bob Halley's avatar
base  
Bob Halley committed
1
/*
Brian Wellington's avatar
Brian Wellington committed
2
 * Copyright (C) 1997-2001  Internet Software Consortium.
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.
7
 *
8 9 10 11 12 13 14 15
 * 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
base  
Bob Halley committed
16 17
 */

18
/* $Id: mem.c,v 1.98 2001/07/17 10:02:46 marka Exp $ */
David Lawrence's avatar
David Lawrence committed
19

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

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

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

28
#include <isc/magic.h>
Bob Halley's avatar
Bob Halley committed
29
#include <isc/mem.h>
30
#include <isc/msgs.h>
31
#include <isc/ondestroy.h>
32
#include <isc/string.h>
Bob Halley's avatar
Bob Halley committed
33

Bob Halley's avatar
update  
Bob Halley committed
34
#include <isc/mutex.h>
Michael Graff's avatar
Michael Graff committed
35
#include <isc/util.h>
Bob Halley's avatar
update  
Bob Halley committed
36

37 38 39
#ifndef ISC_MEM_DEBUGGING
#define ISC_MEM_DEBUGGING 0
#endif
40
LIBISC_EXTERNAL_DATA unsigned int isc_mem_debugging = ISC_MEM_DEBUGGING;
41

42 43 44 45 46 47 48 49 50 51
/*
 * Define ISC_MEM_USE_INTERNAL_MALLOC=1 to use the internal malloc()
 * implementation in preference to the system one.  The internal malloc()
 * is very space-efficient, and quite fast on uniprocessor systems.  It
 * performs poorly on multiprocessor machines.
 */
#ifndef ISC_MEM_USE_INTERNAL_MALLOC
#define ISC_MEM_USE_INTERNAL_MALLOC 0
#endif

52 53 54 55 56 57
/*
 * Constants.
 */

#define DEF_MAX_SIZE		1100
#define DEF_MEM_TARGET		4096
58 59
#define ALIGNMENT_SIZE		8		/* must be a power of 2 */
#define NUM_BASIC_BLOCKS	64		/* must be > 1 */
60
#define TABLE_INCREMENT		1024
Michael Graff's avatar
Michael Graff committed
61
#define DEBUGLIST_COUNT		1024
62

Bob Halley's avatar
base  
Bob Halley committed
63 64 65
/*
 * Types.
 */
66
#if ISC_MEM_TRACKLINES
Michael Graff's avatar
Michael Graff committed
67 68 69 70 71 72 73 74
typedef struct debuglink debuglink_t;
struct debuglink {
	ISC_LINK(debuglink_t)	link;
	const void	       *ptr[DEBUGLIST_COUNT];
	const char	       *file[DEBUGLIST_COUNT];
	unsigned int		line[DEBUGLIST_COUNT];
	unsigned int		count;
};
Bob Halley's avatar
base  
Bob Halley committed
75

Michael Graff's avatar
Michael Graff committed
76 77 78 79 80 81
#define FLARG_PASS	, file, line
#define FLARG		, const char *file, int line
#else
#define FLARG_PASS
#define FLARG
#endif
82

Michael Graff's avatar
Michael Graff committed
83
typedef struct element element;
84 85 86
struct element {
	element *		next;
};
Bob Halley's avatar
base  
Bob Halley committed
87 88 89 90 91

typedef struct {
	/*
	 * This structure must be ALIGNMENT_SIZE bytes.
	 */
92 93 94 95
	union {
		size_t		size;
		char		bytes[ALIGNMENT_SIZE];
	} u;
Bob Halley's avatar
Bob Halley committed
96
} size_info;
Bob Halley's avatar
base  
Bob Halley committed
97 98

struct stats {
Bob Halley's avatar
Bob Halley committed
99 100
	unsigned long		gets;
	unsigned long		totalgets;
101
#if ISC_MEM_USE_INTERNAL_MALLOC
Bob Halley's avatar
Bob Halley committed
102 103
	unsigned long		blocks;
	unsigned long		freefrags;
104
#endif /* ISC_MEM_USE_INTERNAL_MALLOC */
Bob Halley's avatar
base  
Bob Halley committed
105 106
};

107 108
#define MEM_MAGIC		ISC_MAGIC('M', 'e', 'm', 'C')
#define VALID_CONTEXT(c)	ISC_MAGIC_VALID(c, MEM_MAGIC)
Bob Halley's avatar
Bob Halley committed
109

110
struct isc_mem {
Bob Halley's avatar
Bob Halley committed
111
	unsigned int		magic;
112
	isc_ondestroy_t		ondestroy;
Bob Halley's avatar
Bob Halley committed
113
	isc_mutex_t		lock;
114 115 116
	isc_memalloc_t		memalloc;
	isc_memfree_t		memfree;
	void *			arg;
Bob Halley's avatar
base  
Bob Halley committed
117
	size_t			max_size;
118
	isc_boolean_t		checkfree;
Bob Halley's avatar
base  
Bob Halley committed
119
	struct stats *		stats;
120
	unsigned int		references;
121
	size_t			quota;
Bob Halley's avatar
Bob Halley committed
122
	size_t			total;
123
	size_t			inuse;
124
	size_t			maxinuse;
125 126 127 128 129
	size_t			hi_water;
	size_t			lo_water;
	isc_boolean_t		hi_called;
	isc_mem_water_t		water;
	void *			water_arg;
Michael Graff's avatar
Michael Graff committed
130
	ISC_LIST(isc_mempool_t)	pools;
131 132 133 134 135 136 137 138 139 140 141 142

#if ISC_MEM_USE_INTERNAL_MALLOC
	size_t			mem_target;
	element **		freelists;
	element *		basic_blocks;
	unsigned char **	basic_table;
	unsigned int		basic_table_count;
	unsigned int		basic_table_size;
	unsigned char *		lowest;
	unsigned char *		highest;
#endif /* ISC_MEM_USE_INTERNAL_MALLOC */

143
#if ISC_MEM_TRACKLINES
Michael Graff's avatar
Michael Graff committed
144
	ISC_LIST(debuglink_t)	debuglist;
145
	unsigned int		debugging;
Michael Graff's avatar
Michael Graff committed
146
#endif
147 148

	unsigned int		memalloc_failures;
Michael Graff's avatar
Michael Graff committed
149 150
};

151 152
#define MEMPOOL_MAGIC		ISC_MAGIC('M', 'E', 'M', 'p')
#define VALID_MEMPOOL(c)	ISC_MAGIC_VALID(c, MEMPOOL_MAGIC)
Michael Graff's avatar
Michael Graff committed
153 154

struct isc_mempool {
Michael Graff's avatar
Michael Graff committed
155
	/* always unlocked */
Michael Graff's avatar
Michael Graff committed
156
	unsigned int	magic;		/* magic number */
Michael Graff's avatar
Michael Graff committed
157
	isc_mutex_t    *lock;		/* optional lock */
Michael Graff's avatar
Michael Graff committed
158
	isc_mem_t      *mctx;		/* our memory context */
Michael Graff's avatar
Michael Graff committed
159 160 161
	/* 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
162 163 164 165 166 167 168 169 170
	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
171
	/* Debugging only. */
172
#if ISC_MEMPOOL_NAMES
Michael Graff's avatar
Michael Graff committed
173 174
	char		name[16];	/* printed name in stats reports */
#endif
Bob Halley's avatar
base  
Bob Halley committed
175 176
};

177 178 179
/*
 * Private Inline-able.
 */
Bob Halley's avatar
base  
Bob Halley committed
180

181
#if ! ISC_MEM_TRACKLINES
Michael Graff's avatar
Michael Graff committed
182 183 184
#define ADD_TRACE(a, b, c, d, e)
#define DELETE_TRACE(a, b, c, d, e)
#else
185 186
#define ADD_TRACE(a, b, c, d, e) \
	do { if (b != NULL) add_trace_entry(a, b, c, d, e); } while (0)
Michael Graff's avatar
Michael Graff committed
187 188 189
#define DELETE_TRACE(a, b, c, d, e)	delete_trace_entry(a, b, c, d, e)

#define MEM_TRACE	((isc_mem_debugging & ISC_MEM_DEBUGTRACE) != 0)
190
#define MEM_RECORD	((mctx->debugging & ISC_MEM_DEBUGRECORD) != 0)
Michael Graff's avatar
Michael Graff committed
191

192 193 194
static void
print_active(isc_mem_t *ctx, FILE *out);

Michael Graff's avatar
Michael Graff committed
195 196 197 198 199
/*
 * mctx must be locked.
 */
static inline void
add_trace_entry(isc_mem_t *mctx, const void *ptr, unsigned int size
Michael Graff's avatar
pasto  
Michael Graff committed
200
		FLARG)
Michael Graff's avatar
Michael Graff committed
201 202 203 204 205
{
	debuglink_t *dl;
	unsigned int i;

	if (MEM_TRACE)
206 207 208 209
		fprintf(stderr, isc_msgcat_get(isc_msgcat, ISC_MSGSET_MEM,
					       ISC_MSG_ADDTRACE,
					       "add %p size %u "
					       "file %s line %u mctx %p\n"),
210
			ptr, size, file, line, mctx);
Michael Graff's avatar
Michael Graff committed
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257

	if (!MEM_RECORD)
		return;

	dl = ISC_LIST_HEAD(mctx->debuglist);
	while (dl != NULL) {
		if (dl->count == DEBUGLIST_COUNT)
			goto next;
		for (i = 0 ; i < DEBUGLIST_COUNT ; i++) {
			if (dl->ptr[i] == NULL) {
				dl->ptr[i] = ptr;
				dl->file[i] = file;
				dl->line[i] = line;
				dl->count++;
				return;
			}
		}
	next:
		dl = ISC_LIST_NEXT(dl, link);
	}

	dl = malloc(sizeof(debuglink_t));
	INSIST(dl != NULL);

	ISC_LINK_INIT(dl, link);
	for (i = 1 ; i < DEBUGLIST_COUNT ; i++) {
		dl->ptr[i] = NULL;
		dl->file[i] = NULL;
		dl->line[i] = 0;
	}

	dl->ptr[0] = ptr;
	dl->file[0] = file;
	dl->line[0] = line;
	dl->count = 1;

	ISC_LIST_PREPEND(mctx->debuglist, dl, link);
}

static inline void
delete_trace_entry(isc_mem_t *mctx, const void *ptr, unsigned int size,
		   const char *file, unsigned int line)
{
	debuglink_t *dl;
	unsigned int i;

	if (MEM_TRACE)
258 259 260 261
		fprintf(stderr, isc_msgcat_get(isc_msgcat, ISC_MSGSET_MEM,
					       ISC_MSG_DELTRACE,
					       "del %p size %u "
					       "file %s line %u mctx %p\n"),
262
			ptr, size, file, line, mctx);
Michael Graff's avatar
Michael Graff committed
263 264 265 266 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 294 295

	if (!MEM_RECORD)
		return;

	dl = ISC_LIST_HEAD(mctx->debuglist);
	while (dl != NULL) {
		for (i = 0 ; i < DEBUGLIST_COUNT ; i++) {
			if (dl->ptr[i] == ptr) {
				dl->ptr[i] = NULL;
				dl->file[i] = NULL;
				dl->line[i] = 0;

				INSIST(dl->count > 0);
				dl->count--;
				if (dl->count == 0) {
					ISC_LIST_UNLINK(mctx->debuglist,
							dl, link);
					free(dl);
				}
				return;
			}
		}
		dl = ISC_LIST_NEXT(dl, link);
	}

	/*
	 * If we get here, we didn't find the item on the list.  We're
	 * screwed.
	 */
	INSIST(dl != NULL);
}
#endif /* ISC_MEM_TRACKLINES */

296
#if ISC_MEM_USE_INTERNAL_MALLOC
297 298 299 300 301
static inline size_t
rmsize(size_t size) {
	/*
 	 * round down to ALIGNMENT_SIZE
	 */
302
	return (size & (~(ALIGNMENT_SIZE - 1)));
303 304
}

305
static inline size_t
Bob Halley's avatar
base  
Bob Halley committed
306 307
quantize(size_t size) {
	/*
308
	 * Round up the result in order to get a size big
Bob Halley's avatar
base  
Bob Halley committed
309 310 311
	 * enough to satisfy the request and be aligned on ALIGNMENT_SIZE
	 * byte boundaries.
	 */
312

313 314
	if (size == 0)
		return (ALIGNMENT_SIZE);
315
	return ((size + ALIGNMENT_SIZE - 1) & (~(ALIGNMENT_SIZE - 1)));
Bob Halley's avatar
base  
Bob Halley committed
316 317
}

318
static inline isc_boolean_t
319
more_basic_blocks(isc_mem_t *ctx) {
320 321 322 323 324
	void *new;
	unsigned char *curr, *next;
	unsigned char *first, *last;
	unsigned char **table;
	unsigned int table_size;
Bob Halley's avatar
Bob Halley committed
325
	size_t increment;
326 327 328 329
	int i;

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

330 331 332
	/*
	 * Did we hit the quota for this context?
	 */
Bob Halley's avatar
Bob Halley committed
333 334
	increment = NUM_BASIC_BLOCKS * ctx->mem_target;
	if (ctx->quota != 0 && ctx->total + increment > ctx->quota)
335
		return (ISC_FALSE);
336 337 338

	INSIST(ctx->basic_table_count <= ctx->basic_table_size);
	if (ctx->basic_table_count == ctx->basic_table_size) {
339
		table_size = ctx->basic_table_size + TABLE_INCREMENT;
340 341
		table = (ctx->memalloc)(ctx->arg,
					table_size * sizeof (unsigned char *));
342 343
		if (table == NULL) {
			ctx->memalloc_failures++;
344
			return (ISC_FALSE);
345
		}
346 347 348 349
		if (ctx->basic_table_size != 0) {
			memcpy(table, ctx->basic_table,
			       ctx->basic_table_size *
			       sizeof (unsigned char *));
350
			(ctx->memfree)(ctx->arg, ctx->basic_table);
351
		}
352 353
		ctx->basic_table = table;
		ctx->basic_table_size = table_size;
354
	}
355

356
	new = (ctx->memalloc)(ctx->arg, NUM_BASIC_BLOCKS * ctx->mem_target);
357 358
	if (new == NULL) {
		ctx->memalloc_failures++;
359
		return (ISC_FALSE);
360
	}
Bob Halley's avatar
Bob Halley committed
361
	ctx->total += increment;
362 363
	ctx->basic_table[ctx->basic_table_count] = new;
	ctx->basic_table_count++;
364

365 366 367
	curr = new;
	next = curr + ctx->mem_target;
	for (i = 0; i < (NUM_BASIC_BLOCKS - 1); i++) {
368
		((element *)curr)->next = (element *)next;
369 370 371 372 373 374 375
		curr = next;
		next += ctx->mem_target;
	}
	/*
	 * curr is now pointing at the last block in the
	 * array.
	 */
Bob Halley's avatar
Bob Halley committed
376
	((element *)curr)->next = NULL;
377 378 379 380 381 382 383
	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;
384 385

	return (ISC_TRUE);
386 387
}

388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
static inline isc_boolean_t
more_frags(isc_mem_t *ctx, size_t new_size) {
	int i, frags;
	size_t total_size;
	void *new;
	unsigned char *curr, *next;

	/*
	 * Try to get more fragments by chopping up a basic block.
	 */

	if (ctx->basic_blocks == NULL) {
		if (!more_basic_blocks(ctx)) {
			/*
			 * We can't get more memory from the OS, or we've
			 * hit the quota for this context.
			 */
			/*
406
			 * XXXRTH  "At quota" notification here.
407
			 */
408
			return (ISC_FALSE);
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
		}
	}

	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;
424
	total_size -= new_size;
425 426 427 428
	for (i = 0; i < (frags - 1); i++) {
		((element *)curr)->next = (element *)next;
		curr = next;
		next += new_size;
429 430 431 432 433 434 435 436 437 438
		total_size -= new_size;
	}
	/*
	 * Add the remaining fragment of the basic block to a free list.
	 */
	total_size = rmsize(total_size);
	if (total_size > 0) {
		((element *)next)->next = ctx->freelists[total_size];
		ctx->freelists[total_size] = (element *)next;
		ctx->stats[total_size].freefrags++;
439 440 441 442 443 444 445 446 447 448 449
	}
	/*
	 * curr is now pointing at the last block in the
	 * array.
	 */
	((element *)curr)->next = NULL;
	ctx->freelists[new_size] = new;

	return (ISC_TRUE);
}

Michael Graff's avatar
Michael Graff committed
450
static inline void *
451
mem_getunlocked(isc_mem_t *ctx, size_t size) {
Michael Graff's avatar
Michael Graff committed
452 453
	size_t new_size = quantize(size);
	void *ret;
Bob Halley's avatar
base  
Bob Halley committed
454 455

	if (size >= ctx->max_size || new_size >= ctx->max_size) {
456 457 458
		/*
		 * memget() was called on something beyond our upper limit.
		 */
Bob Halley's avatar
Bob Halley committed
459 460 461 462
		if (ctx->quota != 0 && ctx->total + size > ctx->quota) {
			ret = NULL;
			goto done;
		}
Mark Andrews's avatar
Mark Andrews committed
463
		ret = (ctx->memalloc)(ctx->arg, size);
464 465 466
		if (ret == NULL) {
			ctx->memalloc_failures++;
			goto done;
Bob Halley's avatar
base  
Bob Halley committed
467
		}
468 469 470 471 472 473 474 475 476 477
		ctx->total += size;
		ctx->inuse += size;
		ctx->stats[ctx->max_size].gets++;
		ctx->stats[ctx->max_size].totalgets++;
		/*
		 * If we don't set new_size to size, then the
		 * ISC_MEM_FILL code might write over bytes we
		 * don't own.
		 */
		new_size = size;
Bob Halley's avatar
base  
Bob Halley committed
478 479
	}

480
	/*
Bob Halley's avatar
base  
Bob Halley committed
481 482 483 484
	 * 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.
	 */
485 486
	if (ctx->freelists[new_size] == NULL && !more_frags(ctx, new_size))
		return (NULL);
Bob Halley's avatar
base  
Bob Halley committed
487

488 489 490
	/*
	 * The free list uses the "rounded-up" size "new_size".
	 */
Bob Halley's avatar
base  
Bob Halley committed
491 492 493
	ret = ctx->freelists[new_size];
	ctx->freelists[new_size] = ctx->freelists[new_size]->next;

494
	/*
Bob Halley's avatar
base  
Bob Halley committed
495 496 497 498 499 500 501 502
	 * 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--;
503
	ctx->inuse += new_size;
Bob Halley's avatar
base  
Bob Halley committed
504 505 506

 done:

507
#if ISC_MEM_FILL
508 509
	if (ret != NULL)
		memset(ret, 0xbe, new_size); /* Mnemonic for "beef". */
David Lawrence's avatar
David Lawrence committed
510 511 512
#endif

	return (ret);
Michael Graff's avatar
Michael Graff committed
513 514
}

515 516 517 518 519 520 521 522 523 524 525 526 527 528 529
#if ISC_MEM_FILL && ISC_MEM_CHECKOVERRUN
static inline void
check_overrun(void *mem, size_t size, size_t new_size) {
	unsigned char *cp;

	cp = (unsigned char *)mem;
	cp += size;
	while (size < new_size) {
		INSIST(*cp == 0xbe);
		cp++;
		size++;
	}
}
#endif

Michael Graff's avatar
Michael Graff committed
530
static inline void
531
mem_putunlocked(isc_mem_t *ctx, void *mem, size_t size) {
Michael Graff's avatar
Michael Graff committed
532
	size_t new_size = quantize(size);
Bob Halley's avatar
base  
Bob Halley committed
533

534
	if (size == ctx->max_size || new_size >= ctx->max_size) {
535 536 537
		/*
		 * memput() called on something beyond our upper limit.
		 */
538
#if ISC_MEM_FILL
Mark Andrews's avatar
Mark Andrews committed
539 540
		memset(mem, 0xde, size); /* Mnemonic for "dead". */
#endif
541
		(ctx->memfree)(ctx->arg, mem);
Bob Halley's avatar
base  
Bob Halley committed
542 543
		INSIST(ctx->stats[ctx->max_size].gets != 0);
		ctx->stats[ctx->max_size].gets--;
Bob Halley's avatar
Bob Halley committed
544
		INSIST(size <= ctx->total);
545
		ctx->inuse -= size;
Bob Halley's avatar
Bob Halley committed
546
		ctx->total -= size;
Michael Graff's avatar
Michael Graff committed
547
		return;
Bob Halley's avatar
base  
Bob Halley committed
548 549
	}

550 551
#if ISC_MEM_FILL
#if ISC_MEM_CHECKOVERRUN
552 553
	check_overrun(mem, size, new_size);
#endif
Mark Andrews's avatar
Mark Andrews committed
554 555
	memset(mem, 0xde, new_size); /* Mnemonic for "dead". */
#endif
556

557 558 559
	/*
	 * The free list uses the "rounded-up" size "new_size".
	 */
Mark Andrews's avatar
Mark Andrews committed
560 561
	((element *)mem)->next = ctx->freelists[new_size];
	ctx->freelists[new_size] = (element *)mem;
Bob Halley's avatar
base  
Bob Halley committed
562

563
	/*
Bob Halley's avatar
base  
Bob Halley committed
564 565 566 567 568 569 570 571
	 * 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++;
572
	ctx->inuse -= new_size;
Bob Halley's avatar
base  
Bob Halley committed
573 574
}

575 576 577 578 579 580 581 582 583 584 585 586 587 588
#else /* ISC_MEM_USE_INTERNAL_MALLOC */

/*
 * Perform a malloc, doing memory filling and overrun detection as necessary.
 */
static inline void *
mem_get(isc_mem_t *ctx, size_t size) {
	char *ret;

#if ISC_MEM_CHECKOVERRUN
	size += 1;
#endif

	ret = (ctx->memalloc)(ctx->arg, size);
589 590
	if (ret == NULL)
		ctx->memalloc_failures++;	
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610

#if ISC_MEM_FILL
	if (ret != NULL)
		memset(ret, 0xbe, size); /* Mnemonic for "beef". */
#else
#  if ISC_MEM_CHECKOVERRUN
	if (ret != NULL)
		ret[size-1] = 0xbe;
#  endif
#endif

	return (ret);
}

/*
 * Perform a free, doing memory filling and overrun detection as necessary.
 */
static inline void
mem_put(isc_mem_t *ctx, void *mem, size_t size) {
#if ISC_MEM_CHECKOVERRUN
611
	INSIST(((unsigned char *)mem)[size] == 0xbe);
612 613 614
#endif
#if ISC_MEM_FILL
	memset(mem, 0xde, size); /* Mnemonic for "dead". */
Andreas Gustafsson's avatar
Andreas Gustafsson committed
615 616
#else
	UNUSED(size);
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
#endif
	(ctx->memfree)(ctx->arg, mem);
}

/*
 * Update internal counters after a memory get.
 */
static inline void
mem_getstats(isc_mem_t *ctx, size_t size) {
	ctx->total += size;
	ctx->inuse += size;

	if (size > ctx->max_size) {
		ctx->stats[ctx->max_size].gets++;
		ctx->stats[ctx->max_size].totalgets++;
	} else {
		ctx->stats[size].gets++;
		ctx->stats[size].totalgets++;
	}
}

/*
 * Update internal counters after a memory put.
 */
static inline void
mem_putstats(isc_mem_t *ctx, void *ptr, size_t size) {
	UNUSED(ptr);

	INSIST(ctx->inuse >= size);
	ctx->inuse -= size;

	if (size > ctx->max_size) {
		INSIST(ctx->stats[ctx->max_size].gets > 0);
		ctx->stats[ctx->max_size].gets--;
	} else {
		INSIST(ctx->stats[size].gets > 0);
		ctx->stats[size].gets--;
	}
}

#endif /* ISC_MEM_USE_INTERNAL_MALLOC */

David Lawrence's avatar
David Lawrence committed
659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684
/*
 * Private.
 */

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

static void
default_memfree(void *arg, void *ptr) {
	UNUSED(arg);
	free(ptr);
}

/*
 * Public.
 */

isc_result_t
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)
{
	isc_mem_t *ctx;
685
	isc_result_t result;
David Lawrence's avatar
David Lawrence committed
686 687 688 689 690

	REQUIRE(ctxp != NULL && *ctxp == NULL);
	REQUIRE(memalloc != NULL);
	REQUIRE(memfree != NULL);

691 692
	INSIST((ALIGNMENT_SIZE & (ALIGNMENT_SIZE - 1)) == 0);

693 694 695 696
#if !ISC_MEM_USE_INTERNAL_MALLOC
	UNUSED(target_size);
#endif

David Lawrence's avatar
David Lawrence committed
697 698 699 700 701 702 703 704
	ctx = (memalloc)(arg, sizeof *ctx);
	if (ctx == NULL)
		return (ISC_R_NOMEMORY);

	if (init_max_size == 0)
		ctx->max_size = DEF_MAX_SIZE;
	else
		ctx->max_size = init_max_size;
705 706 707 708
	ctx->references = 1;
	ctx->quota = 0;
	ctx->total = 0;
	ctx->inuse = 0;
709
	ctx->maxinuse = 0;
710 711 712 713 714 715 716 717 718 719 720
	ctx->hi_water = 0;
	ctx->lo_water = 0;
	ctx->hi_called = ISC_FALSE;
	ctx->water = NULL;
	ctx->water_arg = NULL;
	ctx->magic = MEM_MAGIC;
	isc_ondestroy_init(&ctx->ondestroy);
	ctx->memalloc = memalloc;
	ctx->memfree = memfree;
	ctx->arg = arg;
	ctx->stats = NULL;
721
	ctx->checkfree = ISC_TRUE;
722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
	ISC_LIST_INIT(ctx->pools);

#if ISC_MEM_USE_INTERNAL_MALLOC
	ctx->freelists = NULL;
#endif /* ISC_MEM_USE_INTERNAL_MALLOC */

	ctx->stats = (memalloc)(arg,
				(ctx->max_size+1) * sizeof (struct stats));
	if (ctx->stats == NULL) {
		result = ISC_R_NOMEMORY;
		goto error;
	}
	memset(ctx->stats, 0, (ctx->max_size + 1) * sizeof (struct stats));

#if ISC_MEM_USE_INTERNAL_MALLOC
David Lawrence's avatar
David Lawrence committed
737 738 739 740 741 742
	if (target_size == 0)
		ctx->mem_target = DEF_MEM_TARGET;
	else
		ctx->mem_target = target_size;
	ctx->freelists = (memalloc)(arg, ctx->max_size * sizeof (element *));
	if (ctx->freelists == NULL) {
743 744
		result = ISC_R_NOMEMORY;
		goto error;
David Lawrence's avatar
David Lawrence committed
745 746 747 748 749 750 751 752 753
	}
	memset(ctx->freelists, 0,
	       ctx->max_size * sizeof (element *));
	ctx->basic_blocks = NULL;
	ctx->basic_table = NULL;
	ctx->basic_table_count = 0;
	ctx->basic_table_size = 0;
	ctx->lowest = NULL;
	ctx->highest = NULL;
754 755
#endif /* ISC_MEM_USE_INTERNAL_MALLOC */

David Lawrence's avatar
David Lawrence committed
756 757
	if (isc_mutex_init(&ctx->lock) != ISC_R_SUCCESS) {
		UNEXPECTED_ERROR(__FILE__, __LINE__,
758 759 760
				 "isc_mutex_init() %s",
				 isc_msgcat_get(isc_msgcat, ISC_MSGSET_GENERAL,
						ISC_MSG_FAILED, "failed"));
761 762
		result = ISC_R_UNEXPECTED;
		goto error;
David Lawrence's avatar
David Lawrence committed
763
	}
764

765
#if ISC_MEM_TRACKLINES
Michael Graff's avatar
Michael Graff committed
766
	ISC_LIST_INIT(ctx->debuglist);
767
	ctx->debugging = isc_mem_debugging;
Michael Graff's avatar
Michael Graff committed
768
#endif
David Lawrence's avatar
David Lawrence committed
769

770 771
	ctx->memalloc_failures = 0;

David Lawrence's avatar
David Lawrence committed
772 773
	*ctxp = ctx;
	return (ISC_R_SUCCESS);
774 775 776 777 778 779 780 781 782 783 784 785 786

  error:
	if (ctx) {
		if (ctx->stats)
			(memfree)(arg, ctx->stats);
#if ISC_MEM_USE_INTERNAL_MALLOC
		if (ctx->freelists)
			(memfree)(arg, ctx->freelists);
#endif /* ISC_MEM_USE_INTERNAL_MALLOC */
		(memfree)(arg, ctx);
	}

	return (result);
David Lawrence's avatar
David Lawrence committed
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804
}

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));
}

static void
destroy(isc_mem_t *ctx) {
	unsigned int i;
	isc_ondestroy_t ondest;

	ctx->magic = 0;

805
#if ISC_MEM_USE_INTERNAL_MALLOC
David Lawrence's avatar
David Lawrence committed
806
	INSIST(ISC_LIST_EMPTY(ctx->pools));
807 808
#endif /* ISC_MEM_USE_INTERNAL_MALLOC */

809
#if ISC_MEM_TRACKLINES
810 811 812
	if (ctx->checkfree) {
		if (!ISC_LIST_EMPTY(ctx->debuglist))
			print_active(ctx, stderr);
813
		INSIST(ISC_LIST_EMPTY(ctx->debuglist));
814
	} else {
815 816 817 818 819 820 821 822 823
		debuglink_t *dl;

		for (dl = ISC_LIST_HEAD(ctx->debuglist);
		     dl != NULL;
		     dl = ISC_LIST_HEAD(ctx->debuglist)) {
			ISC_LIST_UNLINK(ctx->debuglist, dl, link);
			free(dl);
		}
	}
Michael Graff's avatar
Michael Graff committed
824
#endif
David Lawrence's avatar
David Lawrence committed
825 826 827
	INSIST(ctx->references == 0);

	if (ctx->checkfree) {
828 829 830 831 832
		for (i = 0; i <= ctx->max_size; i++) {
#if ISC_MEM_TRACKLINES
			if (ctx->stats[i].gets != 0)
				print_active(ctx, stderr);
#endif
David Lawrence's avatar
David Lawrence committed
833
			INSIST(ctx->stats[i].gets == 0);
834
		}
David Lawrence's avatar
David Lawrence committed
835 836
	}

837
	(ctx->memfree)(ctx->arg, ctx->stats);
David Lawrence's avatar
David Lawrence committed
838

839
#if ISC_MEM_USE_INTERNAL_MALLOC
David Lawrence's avatar
David Lawrence committed
840 841 842 843
	for (i = 0; i < ctx->basic_table_count; i++)
		(ctx->memfree)(ctx->arg, ctx->basic_table[i]);
	(ctx->memfree)(ctx->arg, ctx->freelists);
	(ctx->memfree)(ctx->arg, ctx->basic_table);
844
#endif /* ISC_MEM_USE_INTERNAL_MALLOC */
David Lawrence's avatar
David Lawrence committed
845 846 847

	ondest = ctx->ondestroy;

848
	DESTROYLOCK(&ctx->lock);
David Lawrence's avatar
David Lawrence committed
849 850 851 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 880 881 882 883 884 885 886 887
	(ctx->memfree)(ctx->arg, ctx);

	isc_ondestroy_notify(&ondest, ctx);
}

void
isc_mem_attach(isc_mem_t *source, isc_mem_t **targetp) {
	REQUIRE(VALID_CONTEXT(source));
	REQUIRE(targetp != NULL && *targetp == NULL);

	LOCK(&source->lock);
	source->references++;
	UNLOCK(&source->lock);

	*targetp = source;
}

void
isc_mem_detach(isc_mem_t **ctxp) {
	isc_mem_t *ctx;
	isc_boolean_t want_destroy = ISC_FALSE;

	REQUIRE(ctxp != NULL);
	ctx = *ctxp;
	REQUIRE(VALID_CONTEXT(ctx));

	LOCK(&ctx->lock);
	INSIST(ctx->references > 0);
	ctx->references--;
	if (ctx->references == 0)
		want_destroy = ISC_TRUE;
	UNLOCK(&ctx->lock);

	if (want_destroy)
		destroy(ctx);

	*ctxp = NULL;
}

888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913
/*
 * isc_mem_putanddetach() is the equivalent of:
 *
 * mctx = NULL;
 * isc_mem_attach(ptr->mctx, &mctx);
 * isc_mem_detach(&ptr->mctx);
 * isc_mem_put(mctx, ptr, sizeof(*ptr);
 * isc_mem_detach(&mctx);
 */

void
isc__mem_putanddetach(isc_mem_t **ctxp, void *ptr, size_t size FLARG) {
	isc_mem_t *ctx;
	isc_boolean_t want_destroy = ISC_FALSE;

	REQUIRE(ctxp != NULL);
	ctx = *ctxp;
	REQUIRE(VALID_CONTEXT(ctx));
	REQUIRE(ptr != NULL);

	/*
	 * Must be before mem_putunlocked() as ctxp is usually within
	 * [ptr..ptr+size).
	 */
	*ctxp = NULL;

914
#if ISC_MEM_USE_INTERNAL_MALLOC
915 916
	LOCK(&ctx->lock);
	mem_putunlocked(ctx, ptr, size);
917 918 919 920 921 922 923
#else /* ISC_MEM_USE_INTERNAL_MALLOC */
	mem_put(ctx, ptr, size);
	LOCK(&ctx->lock);
	mem_putstats(ctx, ptr, size);
#endif /* ISC_MEM_USE_INTERNAL_MALLOC */

	DELETE_TRACE(ctx, ptr, size, file, line);
924 925 926 927
	INSIST(ctx->references > 0);
	ctx->references--;
	if (ctx->references == 0)
		want_destroy = ISC_TRUE;
928

929 930 931 932 933 934
	UNLOCK(&ctx->lock);

	if (want_destroy)
		destroy(ctx);
}

David Lawrence's avatar
David Lawrence committed
935 936 937 938 939 940 941 942 943 944 945 946 947 948
void
isc_mem_destroy(isc_mem_t **ctxp) {
	isc_mem_t *ctx;

	/*
	 * This routine provides legacy support for callers who use mctxs
	 * without attaching/detaching.
	 */

	REQUIRE(ctxp != NULL);
	ctx = *ctxp;
	REQUIRE(VALID_CONTEXT(ctx));

	LOCK(&ctx->lock);
949
#if ISC_MEM_TRACKLINES
950 951 952
	if (ctx->references != 1)
		print_active(ctx, stderr);
#endif
David Lawrence's avatar
David Lawrence committed
953 954 955 956
	REQUIRE(ctx->references == 1);
	ctx->references--;
	UNLOCK(&ctx->lock);

Brian Wellington's avatar
Brian Wellington committed
957
	destroy(ctx);
David Lawrence's avatar
David Lawrence committed
958 959 960 961 962 963 964

	*ctxp = NULL;
}

isc_result_t
isc_mem_ondestroy(isc_mem_t *ctx, isc_task_t *task, isc_event_t **event) {
	isc_result_t res;
965

David Lawrence's avatar
David Lawrence committed
966 967 968 969 970 971 972 973
	LOCK(&ctx->lock);
	res = isc_ondestroy_register(&ctx->ondestroy, task, event);
	UNLOCK(&ctx->lock);

	return (res);
}


Michael Graff's avatar
Michael Graff committed
974 975 976
void *
isc__mem_get(isc_mem_t *ctx, size_t size FLARG) {
	void *ptr;
977
	isc_boolean_t call_water = ISC_FALSE;
Michael Graff's avatar
Michael Graff committed
978

David Lawrence's avatar
David Lawrence committed
979 980
	REQUIRE(VALID_CONTEXT(ctx));

981
#if ISC_MEM_USE_INTERNAL_MALLOC
David Lawrence's avatar
David Lawrence committed
982
	LOCK(&ctx->lock);
Michael Graff's avatar
Michael Graff committed
983
	ptr = mem_getunlocked(ctx, size);
984 985 986
#else /* ISC_MEM_USE_INTERNAL_MALLOC */
	ptr = mem_get(ctx, size);
	LOCK(&ctx->lock);
987 988
	if (ptr)
		mem_getstats(ctx, size);
989 990
#endif /* ISC_MEM_USE_INTERNAL_MALLOC */

Michael Graff's avatar
Michael Graff committed
991
	ADD_TRACE(ctx, ptr, size, file, line);
992 993 994 995 996
	if (ctx->hi_water != 0 && !ctx->hi_called &&
	    ctx->inuse > ctx->hi_water) {
		ctx->hi_called = ISC_TRUE;
		call_water = ISC_TRUE;
	}
997 998 999 1000 1001 1002
	if (ctx->inuse > ctx->maxinuse) {
		ctx->maxinuse = ctx->inuse;
		if (ctx->hi_water != 0 && ctx->inuse > ctx->hi_water &&
		    (isc_mem_debugging & ISC_MEM_DEBUGUSAGE) != 0)
			fprintf(stderr, "maxinuse = %d\n", ctx->inuse);
	}
David Lawrence's avatar
David Lawrence committed
1003
	UNLOCK(&ctx->lock);
1004 1005 1006 1007 1008

	if (call_water) {
		(ctx->water)(ctx->water_arg, ISC_MEM_HIWATER);
	}

Bob Halley's avatar
base  
Bob Halley committed
1009 1010 1011 1012
	return (ptr);
}

void
Michael Graff's avatar
Michael Graff committed
1013
isc__mem_put(isc_mem_t *ctx, void *ptr, size_t size FLARG)
Bob Halley's avatar
base  
Bob Halley committed
1014
{
1015 1016
	isc_boolean_t call_water = ISC_FALSE;

Michael Graff's avatar
Michael Graff committed
1017 1018 1019
	REQUIRE(VALID_CONTEXT(ctx));
	REQUIRE(ptr != NULL);

1020
#if ISC_MEM_USE_INTERNAL_MALLOC
Michael Graff's avatar
Michael Graff committed
1021 1022
	LOCK(&ctx->lock);
	mem_putunlocked(ctx, ptr, size);
1023 1024 1025 1026 1027 1028 1029
#else /* ISC_MEM_USE_INTERNAL_MALLOC */
	mem_put(ctx, ptr, size);
	LOCK(&ctx->lock);
	mem_putstats(ctx, ptr, size);
#endif /* ISC_MEM_USE_INTERNAL_MALLOC */

	DELETE_TRACE(ctx, ptr, size, file, line);
1030 1031 1032 1033 1034 1035 1036 1037

	/*
	 * The check against ctx->lo_water == 0 is for the condition
	 * when the context was pushed over hi_water but then had
	 * isc_mem_setwater() called with 0 for hi_water and lo_water.
	 */
	if (ctx->hi_called && 
	    (ctx->inuse < ctx->lo_water || ctx->lo_water == 0)) {
1038
		ctx->hi_called = ISC_FALSE;
1039 1040 1041

		if (ctx->water != NULL)
			call_water = ISC_TRUE;
1042
	}
Michael Graff's avatar
Michael Graff committed
1043
	UNLOCK(&ctx->lock);
1044 1045 1046 1047

	if (call_water) {
		(ctx->water)(ctx->water_arg, ISC_MEM_LOWATER);
	}
Bob Halley's avatar
base  
Bob Halley committed
1048 1049
}

1050
#if ISC_MEM_TRACKLINES
1051
static void
1052
print_active(isc_mem_t *mctx, FILE *out) {
1053
	if (MEM_RECORD) {
1054 1055 1056 1057 1058
		debuglink_t *dl;
		unsigned int i;

		fprintf(out, isc_msgcat_get(isc_msgcat, ISC_MSGSET_MEM,
					    ISC_MSG_DUMPALLOC,
Andreas Gustafsson's avatar
Andreas Gustafsson committed
1059 1060
					    "Dump of all outstanding "
					    "memory allocations:\n"));
1061
		dl = ISC_LIST_HEAD(mctx->debuglist);
1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086
		if (dl == NULL)
			fprintf(out, isc_msgcat_get(isc_msgcat, ISC_MSGSET_MEM,
						    ISC_MSG_NONE,
						    "\tNone.\n"));
		while (dl != NULL) {
			for (i = 0 ; i < DEBUGLIST_COUNT ; i++)
				if (dl->ptr[i] != NULL)
					fprintf(out,
						isc_msgcat_get(isc_msgcat,
							   ISC_MSGSET_MEM,
							   ISC_MSG_PTRFILELINE,
							   "\tptr %p "
							   "file %s "
							   "line %u\n"),
						dl->ptr[i], dl->file[i],
						dl->line[i]);
			dl = ISC_LIST_NEXT(dl, link);
		}
	}
}
#endif

/*
 * Print the stats[] on the stream "out" with suitable formatting.
 */
Bob Halley's avatar
base  
Bob Halley committed
1087
void
1088
isc_mem_stats(isc_mem_t *ctx, FILE *out) {
Bob Halley's avatar
base  
Bob Halley committed
1089
	size_t i;
Michael Graff's avatar
Michael Graff committed
1090 1091
	const struct stats *s;
	const isc_mempool_t *pool;
Bob Halley's avatar
base  
Bob Halley committed
1092

Bob Halley's avatar
Bob Halley committed
1093 1094
	REQUIRE(VALID_CONTEXT(ctx));
	LOCK(&ctx->lock);
Bob Halley's avatar
base  
Bob Halley committed
1095

1096 1097
	for (i = 0; i <= ctx->max_size; i++) {
		s = &ctx->stats[i];
Michael Graff's avatar
Michael Graff committed
1098

1099 1100 1101 1102 1103
		if (s->totalgets == 0 && s->gets == 0)
			continue;
		fprintf(out, "%s%5lu: %11lu gets, %11lu rem",
			(i == ctx->max_size) ? ">=" : "  ",
			(unsigned long) i, s->totalgets, s->gets);
1104
#if ISC_MEM_USE_INTERNAL_MALLOC
1105 1106 1107
		if (s->blocks != 0 || s->freefrags != 0)
			fprintf(out, " (%lu bl, %lu ff)",
				s->blocks, s->freefrags);
1108
#endif /* ISC_MEM_USE_INTERNAL_MALLOC */
1109
		fputc('\n', out);
Michael Graff's avatar
Michael Graff committed
1110 1111
	}

Michael Graff's avatar
Michael Graff committed
1112 1113 1114 1115 1116 1117 1118
	/*
	 * 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.
	 */