tc.alloc.c 17.1 KB
Newer Older
1
/* $Header: /p/tcsh/cvsroot/tcsh/tc.alloc.c,v 3.53 2015/02/22 16:31:54 christos Exp $ */
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
/*
 * tc.alloc.c (Caltech) 2/21/82
 * Chris Kingsley, kingsley@cit-20.
 *
 * This is a very fast storage allocator.  It allocates blocks of a small
 * number of different sizes, and keeps free lists of each size.  Blocks that
 * don't exactly fit are passed up to the next larger size.  In this
 * implementation, the available sizes are 2^n-4 (or 2^n-12) bytes long.
 * This is designed for use in a program that uses vast quantities of memory,
 * but bombs when it runs out.
 */
/*-
 * Copyright (c) 1980, 1991 The Regents of the University of California.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */
#include "sh.h"
42 43 44
#ifdef HAVE_MALLINFO
#include <malloc.h>
#endif
45 46 47
#if defined(HAVE_SBRK) && !defined(__APPLE__)
#define USE_SBRK
#endif
48

49
RCSID("$tcsh: tc.alloc.c,v 3.53 2015/02/22 16:31:54 christos Exp $")
50 51 52

#define RCHECK
#define DEBUG
53 54 55 56 57 58 59 60 61 62 63 64 65

static char   *memtop = NULL;		/* PWP: top of current memory */
static char   *membot = NULL;		/* PWP: bottom of allocatable memory */

int dont_free = 0;

#ifdef WINNT_NATIVE
# define malloc		fmalloc
# define free		ffree
# define calloc		fcalloc
# define realloc	frealloc
#endif /* WINNT_NATIVE */

66 67 68 69 70 71
#if !defined(DEBUG) || defined(SYSMALLOC)
static void
out_of_memory (void)
{
    static const char msg[] = "Out of memory\n";

72
    TCSH_IGNORE(write(didfds ? 2 : SHDIAG, msg, strlen(msg)));
73 74 75
    _exit(1);
}
#endif
76

77
#ifndef SYSMALLOC
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153

#ifdef SX
extern void* sbrk();
#endif
/*
 * Lots of os routines are busted and try to free invalid pointers. 
 * Although our free routine is smart enough and it will pick bad 
 * pointers most of the time, in cases where we know we are going to get
 * a bad pointer, we'd rather leak.
 */

#ifndef NULL
#define	NULL 0
#endif

typedef unsigned char U_char;	/* we don't really have signed chars */
typedef unsigned int U_int;
typedef unsigned short U_short;
typedef unsigned long U_long;


/*
 * The overhead on a block is at least 4 bytes.  When free, this space
 * contains a pointer to the next free block, and the bottom two bits must
 * be zero.  When in use, the first byte is set to MAGIC, and the second
 * byte is the size index.  The remaining bytes are for alignment.
 * If range checking is enabled and the size of the block fits
 * in two bytes, then the top two bytes hold the size of the requested block
 * plus the range checking words, and the header word MINUS ONE.
 */


#define MEMALIGN(a) (((a) + ROUNDUP) & ~ROUNDUP)

union overhead {
    union overhead *ov_next;	/* when free */
    struct {
	U_char  ovu_magic;	/* magic number */
	U_char  ovu_index;	/* bucket # */
#ifdef RCHECK
	U_short ovu_size;	/* actual block size */
	U_int   ovu_rmagic;	/* range magic number */
#endif
    }       ovu;
#define	ov_magic	ovu.ovu_magic
#define	ov_index	ovu.ovu_index
#define	ov_size		ovu.ovu_size
#define	ov_rmagic	ovu.ovu_rmagic
};

#define	MAGIC		0xfd	/* magic # on accounting info */
#define RMAGIC		0x55555555	/* magic # on range info */
#ifdef RCHECK
#define	RSLOP		sizeof (U_int)
#else
#define	RSLOP		0
#endif


#define ROUNDUP	7

/*
 * nextf[i] is the pointer to the next free block of size 2^(i+3).  The
 * smallest allocatable block is 8 bytes.  The overhead information
 * precedes the data area returned to the user.
 */
#define	NBUCKETS ((sizeof(long) << 3) - 3)
static union overhead *nextf[NBUCKETS] IZERO_STRUCT;

/*
 * nmalloc[i] is the difference between the number of mallocs and frees
 * for a given block size.
 */
static U_int nmalloc[NBUCKETS] IZERO_STRUCT;

#ifndef lint
154 155
static	int	findbucket	(union overhead *, int);
static	void	morecore	(int);
156 157 158 159 160 161 162
#endif


#ifdef DEBUG
# define CHECK(a, str, p) \
    if (a) { \
	xprintf(str, p);	\
163
	xprintf(" (memtop = %p membot = %p)\n", memtop, membot);	\
164 165 166 167 168 169
	abort(); \
    }
#else
# define CHECK(a, str, p) \
    if (a) { \
	xprintf(str, p);	\
170
	xprintf(" (memtop = %p membot = %p)\n", memtop, membot);	\
171 172 173 174 175
	return; \
    }
#endif

memalign_t
176
malloc(size_t nbytes)
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
{
#ifndef lint
    union overhead *p;
    int bucket = 0;
    unsigned shiftr;

    /*
     * Convert amount of memory requested into closest block size stored in
     * hash buckets which satisfies request.  Account for space used per block
     * for accounting.
     */
#ifdef SUNOS4
    /*
     * SunOS localtime() overwrites the 9th byte on an 8 byte malloc()....
     * so we get one more...
     * From Michael Schroeder: This is not true. It depends on the 
     * timezone string. In Europe it can overwrite the 13th byte on a
     * 12 byte malloc.
     * So we punt and we always allocate an extra byte.
     */
    nbytes++;
#endif

    nbytes = MEMALIGN(MEMALIGN(sizeof(union overhead)) + nbytes + RSLOP);
    shiftr = (nbytes - 1) >> 2;

    /* apart from this loop, this is O(1) */
    while ((shiftr >>= 1) != 0)
	bucket++;
    /*
     * If nothing in hash bucket right now, request more memory from the
     * system.
     */
    if (nextf[bucket] == NULL)
	morecore(bucket);
212
    if ((p = nextf[bucket]) == NULL) {
213 214
	child++;
#ifndef DEBUG
215
	out_of_memory();
216 217
#else
	showall(NULL, NULL);
218
	xprintf(CGETS(19, 1, "nbytes=%zu: Out of memory\n"), nbytes);
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
	abort();
#endif
	/* fool lint */
	return ((memalign_t) 0);
    }
    /* remove from linked list */
    nextf[bucket] = nextf[bucket]->ov_next;
    p->ov_magic = MAGIC;
    p->ov_index = bucket;
    nmalloc[bucket]++;
#ifdef RCHECK
    /*
     * Record allocated size of block and bound space with magic numbers.
     */
    p->ov_size = (p->ov_index <= 13) ? nbytes - 1 : 0;
    p->ov_rmagic = RMAGIC;
    *((U_int *) (((caddr_t) p) + nbytes - RSLOP)) = RMAGIC;
#endif
    return ((memalign_t) (((caddr_t) p) + MEMALIGN(sizeof(union overhead))));
#else
    if (nbytes)
	return ((memalign_t) 0);
    else
	return ((memalign_t) 0);
#endif /* !lint */
}

#ifndef lint
/*
 * Allocate more memory to the indicated bucket.
 */
static void
251
morecore(int bucket)
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
{
    union overhead *op;
    int rnu;		/* 2^rnu bytes will be requested */
    int nblks;		/* become nblks blocks of the desired size */
    int siz;

    if (nextf[bucket])
	return;
    /*
     * Insure memory is allocated on a page boundary.  Should make getpageize
     * call?
     */
    op = (union overhead *) sbrk(0);
    memtop = (char *) op;
    if (membot == NULL)
	membot = memtop;
    if ((long) op & 0x3ff) {
269
	memtop = sbrk((int) (1024 - ((long) op & 0x3ff)));
270 271 272 273 274 275
	memtop += (long) (1024 - ((long) op & 0x3ff));
    }

    /* take 2k unless the block is bigger than that */
    rnu = (bucket <= 8) ? 11 : bucket + 3;
    nblks = 1 << (rnu - (bucket + 3));	/* how many blocks to get */
276
    memtop = sbrk(1 << rnu);	/* PWP */
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
    op = (union overhead *) memtop;
    /* no more room! */
    if ((long) op == -1)
	return;
    memtop += (long) (1 << rnu);
    /*
     * Round up to minimum allocation size boundary and deduct from block count
     * to reflect.
     */
    if (((U_long) op) & ROUNDUP) {
	op = (union overhead *) (((U_long) op + (ROUNDUP + 1)) & ~ROUNDUP);
	nblks--;
    }
    /*
     * Add new memory allocated to that on free list for this hash bucket.
     */
    nextf[bucket] = op;
    siz = 1 << (bucket + 3);
    while (--nblks > 0) {
	op->ov_next = (union overhead *) (((caddr_t) op) + siz);
	op = (union overhead *) (((caddr_t) op) + siz);
    }
    op->ov_next = NULL;
}

#endif

void
305
free(ptr_t cp)
306 307 308 309 310 311 312 313 314 315 316 317
{
#ifndef lint
    int size;
    union overhead *op;

    /*
     * the don't free flag is there so that we avoid os bugs in routines
     * that free invalid pointers!
     */
    if (cp == NULL || dont_free)
	return;
    CHECK(!memtop || !membot,
318
	  CGETS(19, 2, "free(%p) called before any allocations."), cp);
319
    CHECK(cp > (ptr_t) memtop,
320
	  CGETS(19, 3, "free(%p) above top of memory."), cp);
321
    CHECK(cp < (ptr_t) membot,
322
	  CGETS(19, 4, "free(%p) below bottom of memory."), cp);
323 324
    op = (union overhead *) (((caddr_t) cp) - MEMALIGN(sizeof(union overhead)));
    CHECK(op->ov_magic != MAGIC,
325
	  CGETS(19, 5, "free(%p) bad block."), cp);
326 327 328 329

#ifdef RCHECK
    if (op->ov_index <= 13)
	CHECK(*(U_int *) ((caddr_t) op + op->ov_size + 1 - RSLOP) != RMAGIC,
330
	      CGETS(19, 6, "free(%p) bad range check."), cp);
331 332
#endif
    CHECK(op->ov_index >= NBUCKETS,
333
	  CGETS(19, 7, "free(%p) bad block index."), cp);
334 335 336 337 338 339 340 341 342 343 344 345 346
    size = op->ov_index;
    op->ov_next = nextf[size];
    nextf[size] = op;

    nmalloc[size]--;

#else
    if (cp == NULL)
	return;
#endif
}

memalign_t
347
calloc(size_t i, size_t j)
348 349
{
#ifndef lint
350
    char *cp;
351 352

    i *= j;
353 354
    cp = xmalloc(i);
    memset(cp, 0, i);
355

356
    return ((memalign_t) cp);
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
#else
    if (i && j)
	return ((memalign_t) 0);
    else
	return ((memalign_t) 0);
#endif
}

/*
 * When a program attempts "storage compaction" as mentioned in the
 * old malloc man page, it realloc's an already freed block.  Usually
 * this is the last block it freed; occasionally it might be farther
 * back.  We have to search all the free lists for the block in order
 * to determine its bucket: 1st we make one pass thru the lists
 * checking only the first block in each; if that fails we search
 * ``realloc_srchlen'' blocks in each list for a match (the variable
 * is extern so the caller can modify it).  If that fails we just copy
 * however many bytes was given to realloc() and hope it's not huge.
 */
#ifndef lint
/* 4 should be plenty, -1 =>'s whole list */
static int     realloc_srchlen = 4;	
#endif /* lint */

memalign_t
382
realloc(ptr_t cp, size_t nbytes)
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
{
#ifndef lint
    U_int onb;
    union overhead *op;
    ptr_t res;
    int i;
    int     was_alloced = 0;

    if (cp == NULL)
	return (malloc(nbytes));
    op = (union overhead *) (((caddr_t) cp) - MEMALIGN(sizeof(union overhead)));
    if (op->ov_magic == MAGIC) {
	was_alloced++;
	i = op->ov_index;
    }
    else
	/*
	 * Already free, doing "compaction".
	 * 
	 * Search for the old block of memory on the free list.  First, check the
	 * most common case (last element free'd), then (this failing) the last
	 * ``realloc_srchlen'' items free'd. If all lookups fail, then assume
	 * the size of the memory block being realloc'd is the smallest
	 * possible.
	 */
	if ((i = findbucket(op, 1)) < 0 &&
	    (i = findbucket(op, realloc_srchlen)) < 0)
	    i = 0;

    onb = MEMALIGN(nbytes + MEMALIGN(sizeof(union overhead)) + RSLOP);

    /* avoid the copy if same size block */
    if (was_alloced && (onb <= (U_int) (1 << (i + 3))) && 
	(onb > (U_int) (1 << (i + 2)))) {
#ifdef RCHECK
	/* JMR: formerly this wasn't updated ! */
	nbytes = MEMALIGN(MEMALIGN(sizeof(union overhead))+nbytes+RSLOP);
	*((U_int *) (((caddr_t) op) + nbytes - RSLOP)) = RMAGIC;
	op->ov_rmagic = RMAGIC;
	op->ov_size = (op->ov_index <= 13) ? nbytes - 1 : 0;
#endif
	return ((memalign_t) cp);
    }
    if ((res = malloc(nbytes)) == NULL)
	return ((memalign_t) NULL);
    if (cp != res) {		/* common optimization */
	/* 
	 * christos: this used to copy nbytes! It should copy the 
	 * smaller of the old and new size
	 */
	onb = (1 << (i + 3)) - MEMALIGN(sizeof(union overhead)) - RSLOP;
434
	(void) memmove(res, cp, onb < nbytes ? onb : nbytes);
435 436 437 438 439 440 441 442 443 444 445 446
    }
    if (was_alloced)
	free(cp);
    return ((memalign_t) res);
#else
    if (cp && nbytes)
	return ((memalign_t) 0);
    else
	return ((memalign_t) 0);
#endif /* !lint */
}

447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464
/*
 * On linux, _nss_nis_setnetgrent() calls this function to determine
 * the usable size of the pointer passed, but this is not a portable
 * API, so we cannot use our malloc replacement without providing one.
 * Thanks a lot glibc!
 */
#ifdef __linux__
#define M_U_S_CONST
#else
#define M_U_S_CONST
#endif
size_t malloc_usable_size(M_U_S_CONST void *);
size_t
malloc_usable_size(M_U_S_CONST void *ptr)
{
    const union overhead *op = (const union overhead *)
	(((const char *) ptr) - MEMALIGN(sizeof(*op)));
    if (op->ov_magic == MAGIC)
465
	    return 1 << (op->ov_index + 3);
466 467 468
    else
	    return 0;
}
469 470 471 472 473 474 475 476 477


#ifndef lint
/*
 * Search ``srchlen'' elements of each free list for a block whose
 * header starts at ``freep''.  If srchlen is -1 search the whole list.
 * Return bucket number, or -1 if not found.
 */
static int
478
findbucket(union overhead *freep, int srchlen)
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
{
    union overhead *p;
    size_t i;
    int j;

    for (i = 0; i < NBUCKETS; i++) {
	j = 0;
	for (p = nextf[i]; p && j != srchlen; p = p->ov_next) {
	    if (p == freep)
		return (i);
	    j++;
	}
    }
    return (-1);
}

#endif


#else				/* SYSMALLOC */

/**
 ** ``Protected versions'' of malloc, realloc, calloc, and free
 **
 ** On many systems:
 **
 ** 1. malloc(0) is bad
 ** 2. free(0) is bad
 ** 3. realloc(0, n) is bad
 ** 4. realloc(n, 0) is bad
 **
 ** Also we call our error routine if we run out of memory.
 **/
memalign_t
513
smalloc(size_t n)
514 515 516 517 518
{
    ptr_t   ptr;

    n = n ? n : 1;

519
#ifdef USE_SBRK
520
    if (membot == NULL)
521
	membot = sbrk(0);
522
#endif /* USE_SBRK */
523

524 525
    if ((ptr = malloc(n)) == NULL)
	out_of_memory();
526
#ifndef USE_SBRK
527 528 529
    if (memtop < ((char *) ptr) + n)
	memtop = ((char *) ptr) + n;
    if (membot == NULL)
530
	membot = ptr;
531
#endif /* !USE_SBRK */
532 533 534 535
    return ((memalign_t) ptr);
}

memalign_t
536
srealloc(ptr_t p, size_t n)
537 538 539 540 541
{
    ptr_t   ptr;

    n = n ? n : 1;

542
#ifdef USE_SBRK
543
    if (membot == NULL)
544
	membot = sbrk(0);
545
#endif /* USE_SBRK */
546

547 548
    if ((ptr = (p ? realloc(p, n) : malloc(n))) == NULL)
	out_of_memory();
549
#ifndef USE_SBRK
550 551 552
    if (memtop < ((char *) ptr) + n)
	memtop = ((char *) ptr) + n;
    if (membot == NULL)
553
	membot = ptr;
554
#endif /* !USE_SBRK */
555 556 557 558
    return ((memalign_t) ptr);
}

memalign_t
559
scalloc(size_t s, size_t n)
560 561 562 563 564 565
{
    ptr_t   ptr;

    n *= s;
    n = n ? n : 1;

566
#ifdef USE_SBRK
567
    if (membot == NULL)
568
	membot = sbrk(0);
569
#endif /* USE_SBRK */
570

571 572
    if ((ptr = malloc(n)) == NULL)
	out_of_memory();
573

574
    memset (ptr, 0, n);
575

576
#ifndef USE_SBRK
577 578 579
    if (memtop < ((char *) ptr) + n)
	memtop = ((char *) ptr) + n;
    if (membot == NULL)
580
	membot = ptr;
581
#endif /* !USE_SBRK */
582 583 584 585 586

    return ((memalign_t) ptr);
}

void
587
sfree(ptr_t p)
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
{
    if (p && !dont_free)
	free(p);
}

#endif /* SYSMALLOC */

/*
 * mstats - print out statistics about malloc
 *
 * Prints two lines of numbers, one showing the length of the free list
 * for each size category, the second showing the number of mallocs -
 * frees for each size category.
 */
/*ARGSUSED*/
void
604
showall(Char **v, struct command *c)
605 606 607 608 609 610 611 612 613 614
{
#ifndef SYSMALLOC
    size_t i, j;
    union overhead *p;
    int     totfree = 0, totused = 0;

    xprintf(CGETS(19, 8, "%s current memory allocation:\nfree:\t"), progname);
    for (i = 0; i < NBUCKETS; i++) {
	for (j = 0, p = nextf[i]; p; p = p->ov_next, j++)
	    continue;
615
	xprintf(" %4zd", j);
616 617
	totfree += j * (1 << (i + 3));
    }
618
    xprintf("\n%s:\t", CGETS(19, 9, "used"));
619
    for (i = 0; i < NBUCKETS; i++) {
620
	xprintf(" %4d", nmalloc[i]);
621 622 623 624 625 626 627 628
	totused += nmalloc[i] * (1 << (i + 3));
    }
    xprintf(CGETS(19, 10, "\n\tTotal in use: %d, total free: %d\n"),
	    totused, totfree);
    xprintf(CGETS(19, 11,
	    "\tAllocated memory from 0x%lx to 0x%lx.  Real top at 0x%lx\n"),
	    (unsigned long) membot, (unsigned long) memtop,
	    (unsigned long) sbrk(0));
629 630
#else /* SYSMALLOC */
#ifndef HAVE_MALLINFO
631
#ifdef USE_SBRK
632
    memtop = sbrk(0);
633
#endif /* USE_SBRK */
634 635 636
    xprintf(CGETS(19, 12, "Allocated memory from 0x%lx to 0x%lx (%ld).\n"),
	    (unsigned long) membot, (unsigned long) memtop, 
	    (unsigned long) (memtop - membot));
637 638 639 640 641 642 643 644 645 646 647 648 649
#else /* HAVE_MALLINFO */
    struct mallinfo mi;

    mi = mallinfo();
    xprintf(CGETS(19, 13, "%s current memory allocation:\n"), progname);
    xprintf(CGETS(19, 14, "Total space allocated from system: %d\n"), mi.arena);
    xprintf(CGETS(19, 15, "Number of non-inuse chunks: %d\n"), mi.ordblks);
    xprintf(CGETS(19, 16, "Number of mmapped regions: %d\n"), mi.hblks);
    xprintf(CGETS(19, 17, "Total space in mmapped regions: %d\n"), mi.hblkhd);
    xprintf(CGETS(19, 18, "Total allocated space: %d\n"), mi.uordblks);
    xprintf(CGETS(19, 19, "Total non-inuse space: %d\n"), mi.fordblks);
    xprintf(CGETS(19, 20, "Top-most, releasable space: %d\n"), mi.keepcost);
#endif /* HAVE_MALLINFO */
650 651 652 653
#endif /* SYSMALLOC */
    USE(c);
    USE(v);
}