mem.c 11.7 KB
Newer Older
Bob Halley's avatar
base  
Bob Halley committed
1
/*
Bob Halley's avatar
Bob Halley committed
2 3
 * Copyright (C) 1997, 1998  Internet Software Consortium.
 * 
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 25
#include <string.h>

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

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

Bob Halley's avatar
base  
Bob Halley committed
37 38 39 40 41 42
/*
 * Types.
 */

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

typedef struct {
	size_t			size;
	/*
	 * This structure must be ALIGNMENT_SIZE bytes.
	 */
Bob Halley's avatar
Bob Halley committed
50
} size_info;
Bob Halley's avatar
base  
Bob Halley committed
51 52

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

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

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

/* Forward. */

static size_t			quantize(size_t);

Bob Halley's avatar
Bob Halley committed
81
/* Constants. */
Bob Halley's avatar
base  
Bob Halley committed
82 83 84 85 86

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

/* Private Inline-able. */

Bob Halley's avatar
update  
Bob Halley committed
91
static inline size_t 
Bob Halley's avatar
base  
Bob Halley committed
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
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
113
isc_result_t
114 115
isc_mem_create(size_t init_max_size, size_t target_size,
	       isc_mem_t **ctxp)
Bob Halley's avatar
Bob Halley committed
116
{
117
	isc_mem_t *ctx;
Bob Halley's avatar
Bob Halley committed
118 119

	REQUIRE(ctxp != NULL && *ctxp == NULL);
Bob Halley's avatar
base  
Bob Halley committed
120 121 122 123 124 125 126 127 128 129

	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
130
	ctx->freelists = malloc(ctx->max_size * sizeof (element *));
Bob Halley's avatar
base  
Bob Halley committed
131 132
	if (ctx->freelists == NULL) {
		free(ctx);
Bob Halley's avatar
Bob Halley committed
133
		return (ISC_R_NOMEMORY);
Bob Halley's avatar
base  
Bob Halley committed
134 135
	}
	memset(ctx->freelists, 0,
Bob Halley's avatar
Bob Halley committed
136
	       ctx->max_size * sizeof (element *));
Bob Halley's avatar
base  
Bob Halley committed
137 138 139 140
	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
141
		return (ISC_R_NOMEMORY);
Bob Halley's avatar
base  
Bob Halley committed
142 143 144
	}
	memset(ctx->stats, 0, (ctx->max_size + 1) * sizeof (struct stats));
	ctx->basic_blocks = NULL;
145 146 147
	ctx->basic_table = NULL;
	ctx->basic_table_count = 0;
	ctx->basic_table_size = 0;
Bob Halley's avatar
base  
Bob Halley committed
148 149
	ctx->lowest = NULL;
	ctx->highest = NULL;
Bob Halley's avatar
Bob Halley committed
150
	if (isc_mutex_init(&ctx->lock) != ISC_R_SUCCESS) {
Bob Halley's avatar
update  
Bob Halley committed
151 152 153
		free(ctx->stats);
		free(ctx->freelists);
		free(ctx);
Bob Halley's avatar
Bob Halley committed
154
		UNEXPECTED_ERROR(__FILE__, __LINE__,
Bob Halley's avatar
Bob Halley committed
155
				 "isc_mutex_init() failed");
Bob Halley's avatar
Bob Halley committed
156
		return (ISC_R_UNEXPECTED);
Bob Halley's avatar
update  
Bob Halley committed
157
	}
Bob Halley's avatar
Bob Halley committed
158
	ctx->magic = MEM_MAGIC;
Bob Halley's avatar
base  
Bob Halley committed
159
	*ctxp = ctx;
Bob Halley's avatar
Bob Halley committed
160
	return (ISC_R_SUCCESS);
Bob Halley's avatar
base  
Bob Halley committed
161 162 163
}

void
164
isc_mem_destroy(isc_mem_t **ctxp) {
165
	unsigned int i;
166
	isc_mem_t *ctx;
167

Bob Halley's avatar
base  
Bob Halley committed
168
	REQUIRE(ctxp != NULL);
169
	ctx = *ctxp;
Bob Halley's avatar
Bob Halley committed
170 171 172
	REQUIRE(VALID_CONTEXT(ctx));

	ctx->magic = 0;
173 174 175 176 177 178 179 180 181

	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
182
	(void)isc_mutex_destroy(&ctx->lock);
183
	free(ctx);
Bob Halley's avatar
base  
Bob Halley committed
184 185 186 187

	*ctxp = NULL;
}

188 189


190
static void
191
more_basic_blocks(isc_mem_t *ctx) {
192 193 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
	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
225
		((element *)curr)->next = next;
226 227 228 229 230 231 232
		curr = next;
		next += ctx->mem_target;
	}
	/*
	 * curr is now pointing at the last block in the
	 * array.
	 */
Bob Halley's avatar
Bob Halley committed
233
	((element *)curr)->next = NULL;
234 235 236 237 238 239 240 241 242
	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
243
void *
244
__isc_mem_get(isc_mem_t *ctx, size_t size) {
Bob Halley's avatar
base  
Bob Halley committed
245 246 247 248
	size_t new_size = quantize(size);
	void *ret;

	REQUIRE(size > 0);
Bob Halley's avatar
Bob Halley committed
249 250
	REQUIRE(VALID_CONTEXT(ctx));
	LOCK(&ctx->lock);
Bob Halley's avatar
base  
Bob Halley committed
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270

	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
271
		unsigned char *curr, *next;
Bob Halley's avatar
base  
Bob Halley committed
272 273

		if (ctx->basic_blocks == NULL) {
274 275
			more_basic_blocks(ctx);
			if (ctx->basic_blocks == NULL) {
Bob Halley's avatar
base  
Bob Halley committed
276 277 278 279 280 281 282 283 284 285 286 287 288 289
				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
290
			((element *)curr)->next = next;
Bob Halley's avatar
base  
Bob Halley committed
291 292 293 294
			curr = next;
			next += new_size;
		}
		/* curr is now pointing at the last block in the array. */
Bob Halley's avatar
Bob Halley committed
295
		((element *)curr)->next = NULL;
Bob Halley's avatar
base  
Bob Halley committed
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
		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:
Bob Halley's avatar
Bob Halley committed
314
	UNLOCK(&ctx->lock);
Bob Halley's avatar
base  
Bob Halley committed
315 316 317 318 319

	return (ret);
}

void
320
__isc_mem_put(isc_mem_t *ctx, void *mem, size_t size) {
Bob Halley's avatar
base  
Bob Halley committed
321 322 323
	size_t new_size = quantize(size);

	REQUIRE(size > 0);
Bob Halley's avatar
Bob Halley committed
324 325
	REQUIRE(VALID_CONTEXT(ctx));
	LOCK(&ctx->lock);
Bob Halley's avatar
base  
Bob Halley committed
326 327 328 329 330 331 332 333 334 335

	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
336 337
	((element *)mem)->next = ctx->freelists[new_size];
	ctx->freelists[new_size] = (element *)mem;
Bob Halley's avatar
base  
Bob Halley committed
338 339 340 341 342 343 344 345 346 347 348 349

	/* 
	 * 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:
Bob Halley's avatar
Bob Halley committed
350
	UNLOCK(&ctx->lock);
Bob Halley's avatar
base  
Bob Halley committed
351 352 353
}

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

357
	ptr = __isc_mem_get(ctx, size);
Bob Halley's avatar
base  
Bob Halley committed
358
	fprintf(stderr, "%s:%d: mem_get(%p, %lu) -> %p\n", file, line,
Bob Halley's avatar
Bob Halley committed
359
		ctx, (unsigned long)size, ptr);
Bob Halley's avatar
base  
Bob Halley committed
360 361 362 363
	return (ptr);
}

void
364
__isc_mem_putdebug(isc_mem_t *ctx, void *ptr, size_t size, const char *file,
Bob Halley's avatar
Bob Halley committed
365
		 int line)
Bob Halley's avatar
base  
Bob Halley committed
366 367
{
	fprintf(stderr, "%s:%d: mem_put(%p, %p, %lu)\n", file, line, 
Bob Halley's avatar
Bob Halley committed
368
		ctx, ptr, (unsigned long)size);
369
	__isc_mem_put(ctx, ptr, size);
Bob Halley's avatar
base  
Bob Halley committed
370 371 372 373 374 375
}

/*
 * Print the stats[] on the stream "out" with suitable formatting.
 */
void
376
isc_mem_stats(isc_mem_t *ctx, FILE *out) {
Bob Halley's avatar
base  
Bob Halley committed
377 378
	size_t i;

Bob Halley's avatar
Bob Halley committed
379 380
	REQUIRE(VALID_CONTEXT(ctx));
	LOCK(&ctx->lock);
Bob Halley's avatar
base  
Bob Halley committed
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397

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

Bob Halley's avatar
Bob Halley committed
398
	UNLOCK(&ctx->lock);
Bob Halley's avatar
base  
Bob Halley committed
399 400
}

Bob Halley's avatar
Bob Halley committed
401
isc_boolean_t
402
isc_mem_valid(isc_mem_t *ctx, void *ptr) {
Bob Halley's avatar
Bob Halley committed
403
	unsigned char *cp = ptr;
Bob Halley's avatar
Bob Halley committed
404
	isc_boolean_t result = ISC_FALSE;
Bob Halley's avatar
base  
Bob Halley committed
405

Bob Halley's avatar
Bob Halley committed
406 407
	REQUIRE(VALID_CONTEXT(ctx));
	LOCK(&ctx->lock);
Bob Halley's avatar
base  
Bob Halley committed
408 409

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

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

Bob Halley's avatar
Bob Halley committed
414
	return (result);
Bob Halley's avatar
base  
Bob Halley committed
415 416 417 418 419 420 421
}

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

void *
422
isc_mem_allocate(isc_mem_t *ctx, size_t size) {
Bob Halley's avatar
Bob Halley committed
423
	size_info *si;
Bob Halley's avatar
base  
Bob Halley committed
424 425

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

void
434
isc_mem_free(isc_mem_t *ctx, void *ptr) {
Bob Halley's avatar
Bob Halley committed
435
	size_info *si;
Bob Halley's avatar
base  
Bob Halley committed
436

Bob Halley's avatar
Bob Halley committed
437
	si = &(((size_info *)ptr)[-1]);
Bob Halley's avatar
Bob Halley committed
438
	isc_mem_put(ctx, si, si->size);
Bob Halley's avatar
base  
Bob Halley committed
439 440
}

Bob Halley's avatar
Bob Halley committed
441 442 443 444 445 446 447 448 449 450 451 452 453 454
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);
}

Bob Halley's avatar
Bob Halley committed
455 456
#ifdef ISC_MEMCLUSTER_LEGACY

Bob Halley's avatar
base  
Bob Halley committed
457 458 459 460
/*
 * Public Legacy.
 */

461
static isc_mem_t *default_context = NULL;
Bob Halley's avatar
Bob Halley committed
462

Bob Halley's avatar
base  
Bob Halley committed
463 464 465 466 467
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
468
	return (isc_mem_create(init_max_size, target_size, &default_context));
Bob Halley's avatar
base  
Bob Halley committed
469 470
}

471
isc_mem_t *
Bob Halley's avatar
base  
Bob Halley committed
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498
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
499
		(unsigned long)size, ptr);
Bob Halley's avatar
base  
Bob Halley committed
500 501 502 503 504 505
	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
506
		ptr, (unsigned long)size);
Bob Halley's avatar
base  
Bob Halley committed
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522
	__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
523 524

#endif /* ISC_MEMCLUSTER_LEGACY */