sys/kern/kern_malloc.c

   1 /*-
   2  * Copyright (c) 1987, 1991, 1993
   3  *      The Regents of the University of California.
   4  * Copyright (c) 2005-2009 Robert N. M. Watson
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 4. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  *      @(#)kern_malloc.c       8.3 (Berkeley) 1/4/94
  32  */
  33
  34 /*
  35  * Kernel malloc(9) implementation -- general purpose kernel memory allocator
  36  * based on memory types.  Back end is implemented using the UMA(9) zone
  37  * allocator.  A set of fixed-size buckets are used for smaller allocations,
  38  * and a special UMA allocation interface is used for larger allocations.
  39  * Callers declare memory types, and statistics are maintained independently
  40  * for each memory type.  Statistics are maintained per-CPU for performance
  41  * reasons.  See malloc(9) and comments in malloc.h for a detailed
  42  * description.
  43  */
  44
  45 #include <sys/cdefs.h>
  46 __FBSDID("$FreeBSD$");
  47
  48 #include "opt_ddb.h"
  49 #include "opt_kdtrace.h"
  50 #include "opt_vm.h"
  51
  52 #include <sys/param.h>
  53 #include <sys/systm.h>
  54 #include <sys/kdb.h>
  55 #include <sys/kernel.h>
  56 #include <sys/lock.h>
  57 #include <sys/malloc.h>
  58 #include <sys/mbuf.h>
  59 #include <sys/mutex.h>
  60 #include <sys/vmmeter.h>
  61 #include <sys/proc.h>
  62 #include <sys/sbuf.h>
  63 #include <sys/sysctl.h>
  64 #include <sys/time.h>
  65
  66 #include <vm/vm.h>
  67 #include <vm/pmap.h>
  68 #include <vm/vm_param.h>
  69 #include <vm/vm_kern.h>
  70 #include <vm/vm_extern.h>
  71 #include <vm/vm_map.h>
  72 #include <vm/vm_page.h>
  73 #include <vm/uma.h>
  74 #include <vm/uma_int.h>
  75 #include <vm/uma_dbg.h>
  76
  77 #ifdef DEBUG_MEMGUARD
  78 #include <vm/memguard.h>
  79 #endif
  80 #ifdef DEBUG_REDZONE
  81 #include <vm/redzone.h>
  82 #endif
  83
  84 #if defined(INVARIANTS) && defined(__i386__)
  85 #include <machine/cpu.h>
  86 #endif
  87
  88 #include <ddb/ddb.h>
  89
  90 #ifdef KDTRACE_HOOKS
  91 #include <sys/dtrace_bsd.h>
  92
  93 dtrace_malloc_probe_func_t      dtrace_malloc_probe;
  94 #endif
  95
  96 /*
  97  * When realloc() is called, if the new size is sufficiently smaller than
  98  * the old size, realloc() will allocate a new, smaller block to avoid
  99  * wasting memory. 'Sufficiently smaller' is defined as: newsize <=
 100  * oldsize / 2^n, where REALLOC_FRACTION defines the value of 'n'.
 101  */
 102 #ifndef REALLOC_FRACTION
 103 #define REALLOC_FRACTION        1       /* new block if <= half the size */
 104 #endif
 105
 106 /*
 107  * Centrally define some common malloc types.
 108  */
 109 MALLOC_DEFINE(M_CACHE, "cache", "Various Dynamically allocated caches");
 110 MALLOC_DEFINE(M_DEVBUF, "devbuf", "device driver memory");
 111 MALLOC_DEFINE(M_TEMP, "temp", "misc temporary data buffers");
 112
 113 MALLOC_DEFINE(M_IP6OPT, "ip6opt", "IPv6 options");
 114 MALLOC_DEFINE(M_IP6NDP, "ip6ndp", "IPv6 Neighbor Discovery");
 115
 116 static void kmeminit(void *);
 117 SYSINIT(kmem, SI_SUB_KMEM, SI_ORDER_FIRST, kmeminit, NULL);
 118
 119 static MALLOC_DEFINE(M_FREE, "free", "should be on free list");
 120
 121 static struct malloc_type *kmemstatistics;
 122 static vm_offset_t kmembase;
 123 static vm_offset_t kmemlimit;
 124 static int kmemcount;
 125
 126 #define KMEM_ZSHIFT     4
 127 #define KMEM_ZBASE      16
 128 #define KMEM_ZMASK      (KMEM_ZBASE - 1)
 129
 130 #define KMEM_ZMAX       PAGE_SIZE
 131 #define KMEM_ZSIZE      (KMEM_ZMAX >> KMEM_ZSHIFT)
 132 static uint8_t kmemsize[KMEM_ZSIZE + 1];
 133
 134 #ifndef MALLOC_DEBUG_MAXZONES
 135 #define MALLOC_DEBUG_MAXZONES   1
 136 #endif
 137 static int numzones = MALLOC_DEBUG_MAXZONES;
 138
 139 /*
 140  * Small malloc(9) memory allocations are allocated from a set of UMA buckets
 141  * of various sizes.
 142  *
 143  * XXX: The comment here used to read "These won't be powers of two for
 144  * long."  It's possible that a significant amount of wasted memory could be
 145  * recovered by tuning the sizes of these buckets.
 146  */
 147 struct {
 148         int kz_size;
 149         char *kz_name;
 150         uma_zone_t kz_zone[MALLOC_DEBUG_MAXZONES];
 151 } kmemzones[] = {
 152         {16, "16", },
 153         {32, "32", },
 154         {64, "64", },
 155         {128, "128", },
 156         {256, "256", },
 157         {512, "512", },
 158         {1024, "1024", },
 159         {2048, "2048", },
 160         {4096, "4096", },
 161 #if PAGE_SIZE > 4096
 162         {8192, "8192", },
 163 #if PAGE_SIZE > 8192
 164         {16384, "16384", },
 165 #if PAGE_SIZE > 16384
 166         {32768, "32768", },
 167 #if PAGE_SIZE > 32768
 168         {65536, "65536", },
 169 #if PAGE_SIZE > 65536
 170 #error  "Unsupported PAGE_SIZE"
 171 #endif  /* 65536 */
 172 #endif  /* 32768 */
 173 #endif  /* 16384 */
 174 #endif  /* 8192 */
 175 #endif  /* 4096 */
 176         {0, NULL},
 177 };
 178
 179 /*
 180  * Zone to allocate malloc type descriptions from.  For ABI reasons, memory
 181  * types are described by a data structure passed by the declaring code, but
 182  * the malloc(9) implementation has its own data structure describing the
 183  * type and statistics.  This permits the malloc(9)-internal data structures
 184  * to be modified without breaking binary-compiled kernel modules that
 185  * declare malloc types.
 186  */
 187 static uma_zone_t mt_zone;
 188
 189 u_long vm_kmem_size;
 190 SYSCTL_ULONG(_vm, OID_AUTO, kmem_size, CTLFLAG_RDTUN, &vm_kmem_size, 0,
 191     "Size of kernel memory");
 192
 193 static u_long vm_kmem_size_min;
 194 SYSCTL_ULONG(_vm, OID_AUTO, kmem_size_min, CTLFLAG_RDTUN, &vm_kmem_size_min, 0,
 195     "Minimum size of kernel memory");
 196
 197 static u_long vm_kmem_size_max;
 198 SYSCTL_ULONG(_vm, OID_AUTO, kmem_size_max, CTLFLAG_RDTUN, &vm_kmem_size_max, 0,
 199     "Maximum size of kernel memory");
 200
 201 static u_int vm_kmem_size_scale;
 202 SYSCTL_UINT(_vm, OID_AUTO, kmem_size_scale, CTLFLAG_RDTUN, &vm_kmem_size_scale, 0,
 203     "Scale factor for kernel memory size");
 204
 205 static int sysctl_kmem_map_size(SYSCTL_HANDLER_ARGS);
 206 SYSCTL_PROC(_vm, OID_AUTO, kmem_map_size,
 207     CTLFLAG_RD | CTLTYPE_ULONG | CTLFLAG_MPSAFE, NULL, 0,
 208     sysctl_kmem_map_size, "LU", "Current kmem_map allocation size");
 209
 210 static int sysctl_kmem_map_free(SYSCTL_HANDLER_ARGS);
 211 SYSCTL_PROC(_vm, OID_AUTO, kmem_map_free,
 212     CTLFLAG_RD | CTLTYPE_ULONG | CTLFLAG_MPSAFE, NULL, 0,
 213     sysctl_kmem_map_free, "LU", "Largest contiguous free range in kmem_map");
 214
 215 /*
 216  * The malloc_mtx protects the kmemstatistics linked list.
 217  */
 218 struct mtx malloc_mtx;
 219
 220 #ifdef MALLOC_PROFILE
 221 uint64_t krequests[KMEM_ZSIZE + 1];
 222
 223 static int sysctl_kern_mprof(SYSCTL_HANDLER_ARGS);
 224 #endif
 225
 226 static int sysctl_kern_malloc_stats(SYSCTL_HANDLER_ARGS);
 227
 228 /*
 229  * time_uptime of the last malloc(9) failure (induced or real).
 230  */
 231 static time_t t_malloc_fail;
 232
 233 #if defined(MALLOC_MAKE_FAILURES) || (MALLOC_DEBUG_MAXZONES > 1)
 234 static SYSCTL_NODE(_debug, OID_AUTO, malloc, CTLFLAG_RD, 0,
 235     "Kernel malloc debugging options");
 236 #endif
 237
 238 /*
 239  * malloc(9) fault injection -- cause malloc failures every (n) mallocs when
 240  * the caller specifies M_NOWAIT.  If set to 0, no failures are caused.
 241  */
 242 #ifdef MALLOC_MAKE_FAILURES
 243 static int malloc_failure_rate;
 244 static int malloc_nowait_count;
 245 static int malloc_failure_count;
 246 SYSCTL_INT(_debug_malloc, OID_AUTO, failure_rate, CTLFLAG_RW,
 247     &malloc_failure_rate, 0, "Every (n) mallocs with M_NOWAIT will fail");
 248 TUNABLE_INT("debug.malloc.failure_rate", &malloc_failure_rate);
 249 SYSCTL_INT(_debug_malloc, OID_AUTO, failure_count, CTLFLAG_RD,
 250     &malloc_failure_count, 0, "Number of imposed M_NOWAIT malloc failures");
 251 #endif
 252
 253 static int
 254 sysctl_kmem_map_size(SYSCTL_HANDLER_ARGS)
 255 {
 256         u_long size;
 257
 258         size = kmem_map->size;
 259         return (sysctl_handle_long(oidp, &size, 0, req));
 260 }
 261
 262 static int
 263 sysctl_kmem_map_free(SYSCTL_HANDLER_ARGS)
 264 {
 265         u_long size;
 266
 267         vm_map_lock_read(kmem_map);
 268         size = kmem_map->root != NULL ? kmem_map->root->max_free :
 269             kmem_map->max_offset - kmem_map->min_offset;
 270         vm_map_unlock_read(kmem_map);
 271         return (sysctl_handle_long(oidp, &size, 0, req));
 272 }
 273
 274 /*
 275  * malloc(9) uma zone separation -- sub-page buffer overruns in one
 276  * malloc type will affect only a subset of other malloc types.
 277  */
 278 #if MALLOC_DEBUG_MAXZONES > 1
 279 static void
 280 tunable_set_numzones(void)
 281 {
 282
 283         TUNABLE_INT_FETCH("debug.malloc.numzones",
 284             &numzones);
 285
 286         /* Sanity check the number of malloc uma zones. */
 287         if (numzones <= 0)
 288                 numzones = 1;
 289         if (numzones > MALLOC_DEBUG_MAXZONES)
 290                 numzones = MALLOC_DEBUG_MAXZONES;
 291 }
 292 SYSINIT(numzones, SI_SUB_TUNABLES, SI_ORDER_ANY, tunable_set_numzones, NULL);
 293 SYSCTL_INT(_debug_malloc, OID_AUTO, numzones, CTLFLAG_RDTUN,
 294     &numzones, 0, "Number of malloc uma subzones");
 295
 296 /*
 297  * Any number that changes regularly is an okay choice for the
 298  * offset.  Build numbers are pretty good of you have them.
 299  */
 300 static u_int zone_offset = __FreeBSD_version;
 301 TUNABLE_INT("debug.malloc.zone_offset", &zone_offset);
 302 SYSCTL_UINT(_debug_malloc, OID_AUTO, zone_offset, CTLFLAG_RDTUN,
 303     &zone_offset, 0, "Separate malloc types by examining the "
 304     "Nth character in the malloc type short description.");
 305
 306 static u_int
 307 mtp_get_subzone(const char *desc)
 308 {
 309         size_t len;
 310         u_int val;
 311
 312         if (desc == NULL || (len = strlen(desc)) == 0)
 313                 return (0);
 314         val = desc[zone_offset % len];
 315         return (val % numzones);
 316 }
 317 #elif MALLOC_DEBUG_MAXZONES == 0
 318 #error "MALLOC_DEBUG_MAXZONES must be positive."
 319 #else
 320 static inline u_int
 321 mtp_get_subzone(const char *desc)
 322 {
 323
 324         return (0);
 325 }
 326 #endif /* MALLOC_DEBUG_MAXZONES > 1 */
 327
 328 int
 329 malloc_last_fail(void)
 330 {
 331
 332         return (time_uptime - t_malloc_fail);
 333 }
 334
 335 /*
 336  * An allocation has succeeded -- update malloc type statistics for the
 337  * amount of bucket size.  Occurs within a critical section so that the
 338  * thread isn't preempted and doesn't migrate while updating per-PCU
 339  * statistics.
 340  */
 341 static void
 342 malloc_type_zone_allocated(struct malloc_type *mtp, unsigned long size,
 343     int zindx)
 344 {
 345         struct malloc_type_internal *mtip;
 346         struct malloc_type_stats *mtsp;
 347
 348         critical_enter();
 349         mtip = mtp->ks_handle;
 350         mtsp = &mtip->mti_stats[curcpu];
 351         if (size > 0) {
 352                 mtsp->mts_memalloced += size;
 353                 mtsp->mts_numallocs++;
 354         }
 355         if (zindx != -1)
 356                 mtsp->mts_size |= 1 << zindx;
 357
 358 #ifdef KDTRACE_HOOKS
 359         if (dtrace_malloc_probe != NULL) {
 360                 uint32_t probe_id = mtip->mti_probes[DTMALLOC_PROBE_MALLOC];
 361                 if (probe_id != 0)
 362                         (dtrace_malloc_probe)(probe_id,
 363                             (uintptr_t) mtp, (uintptr_t) mtip,
 364                             (uintptr_t) mtsp, size, zindx);
 365         }
 366 #endif
 367
 368         critical_exit();
 369 }
 370
 371 void
 372 malloc_type_allocated(struct malloc_type *mtp, unsigned long size)
 373 {
 374
 375         if (size > 0)
 376                 malloc_type_zone_allocated(mtp, size, -1);
 377 }
 378
 379 /*
 380  * A free operation has occurred -- update malloc type statistics for the
 381  * amount of the bucket size.  Occurs within a critical section so that the
 382  * thread isn't preempted and doesn't migrate while updating per-CPU
 383  * statistics.
 384  */
 385 void
 386 malloc_type_freed(struct malloc_type *mtp, unsigned long size)
 387 {
 388         struct malloc_type_internal *mtip;
 389         struct malloc_type_stats *mtsp;
 390
 391         critical_enter();
 392         mtip = mtp->ks_handle;
 393         mtsp = &mtip->mti_stats[curcpu];
 394         mtsp->mts_memfreed += size;
 395         mtsp->mts_numfrees++;
 396
 397 #ifdef KDTRACE_HOOKS
 398         if (dtrace_malloc_probe != NULL) {
 399                 uint32_t probe_id = mtip->mti_probes[DTMALLOC_PROBE_FREE];
 400                 if (probe_id != 0)
 401                         (dtrace_malloc_probe)(probe_id,
 402                             (uintptr_t) mtp, (uintptr_t) mtip,
 403                             (uintptr_t) mtsp, size, 0);
 404         }
 405 #endif
 406
 407         critical_exit();
 408 }
 409
 410 /*
 411  *      contigmalloc:
 412  *
 413  *      Allocate a block of physically contiguous memory.
 414  *
 415  *      If M_NOWAIT is set, this routine will not block and return NULL if
 416  *      the allocation fails.
 417  */
 418 void *
 419 contigmalloc(unsigned long size, struct malloc_type *type, int flags,
 420     vm_paddr_t low, vm_paddr_t high, unsigned long alignment,
 421     vm_paddr_t boundary)
 422 {
 423         void *ret;
 424
 425         ret = (void *)kmem_alloc_contig(kernel_map, size, flags, low, high,
 426             alignment, boundary, VM_MEMATTR_DEFAULT);
 427         if (ret != NULL)
 428                 malloc_type_allocated(type, round_page(size));
 429         return (ret);
 430 }
 431
 432 /*
 433  *      contigfree:
 434  *
 435  *      Free a block of memory allocated by contigmalloc.
 436  *
 437  *      This routine may not block.
 438  */
 439 void
 440 contigfree(void *addr, unsigned long size, struct malloc_type *type)
 441 {
 442
 443         kmem_free(kernel_map, (vm_offset_t)addr, size);
 444         malloc_type_freed(type, round_page(size));
 445 }
 446
 447 /*
 448  *      malloc:
 449  *
 450  *      Allocate a block of memory.
 451  *
 452  *      If M_NOWAIT is set, this routine will not block and return NULL if
 453  *      the allocation fails.
 454  */
 455 void *
 456 malloc(unsigned long size, struct malloc_type *mtp, int flags)
 457 {
 458         int indx;
 459         struct malloc_type_internal *mtip;
 460         caddr_t va;
 461         uma_zone_t zone;
 462 #if defined(DIAGNOSTIC) || defined(DEBUG_REDZONE)
 463         unsigned long osize = size;
 464 #endif
 465
 466 #ifdef INVARIANTS
 467         KASSERT(mtp->ks_magic == M_MAGIC, ("malloc: bad malloc type magic"));
 468         /*
 469          * Check that exactly one of M_WAITOK or M_NOWAIT is specified.
 470          */
 471         indx = flags & (M_WAITOK | M_NOWAIT);
 472         if (indx != M_NOWAIT && indx != M_WAITOK) {
 473                 static  struct timeval lasterr;
 474                 static  int curerr, once;
 475                 if (once == 0 && ppsratecheck(&lasterr, &curerr, 1)) {
 476                         printf("Bad malloc flags: %x\n", indx);
 477                         kdb_backtrace();
 478                         flags |= M_WAITOK;
 479                         once++;
 480                 }
 481         }
 482 #endif
 483 #ifdef MALLOC_MAKE_FAILURES
 484         if ((flags & M_NOWAIT) && (malloc_failure_rate != 0)) {
 485                 atomic_add_int(&malloc_nowait_count, 1);
 486                 if ((malloc_nowait_count % malloc_failure_rate) == 0) {
 487                         atomic_add_int(&malloc_failure_count, 1);
 488                         t_malloc_fail = time_uptime;
 489                         return (NULL);
 490                 }
 491         }
 492 #endif
 493         if (flags & M_WAITOK)
 494                 KASSERT(curthread->td_intr_nesting_level == 0,
 495                    ("malloc(M_WAITOK) in interrupt context"));
 496
 497 #ifdef DEBUG_MEMGUARD
 498         if (memguard_cmp_mtp(mtp, size)) {
 499                 va = memguard_alloc(size, flags);
 500                 if (va != NULL)
 501                         return (va);
 502                 /* This is unfortunate but should not be fatal. */
 503         }
 504 #endif
 505
 506 #ifdef DEBUG_REDZONE
 507         size = redzone_size_ntor(size);
 508 #endif
 509
 510         if (size <= KMEM_ZMAX) {
 511                 mtip = mtp->ks_handle;
 512                 if (size & KMEM_ZMASK)
 513                         size = (size & ~KMEM_ZMASK) + KMEM_ZBASE;
 514                 indx = kmemsize[size >> KMEM_ZSHIFT];
 515                 KASSERT(mtip->mti_zone < numzones,
 516                     ("mti_zone %u out of range %d",
 517                     mtip->mti_zone, numzones));
 518                 zone = kmemzones[indx].kz_zone[mtip->mti_zone];
 519 #ifdef MALLOC_PROFILE
 520                 krequests[size >> KMEM_ZSHIFT]++;
 521 #endif
 522                 va = uma_zalloc(zone, flags);
 523                 if (va != NULL)
 524                         size = zone->uz_size;
 525                 malloc_type_zone_allocated(mtp, va == NULL ? 0 : size, indx);
 526         } else {
 527                 size = roundup(size, PAGE_SIZE);
 528                 zone = NULL;
 529                 va = uma_large_malloc(size, flags);
 530                 malloc_type_allocated(mtp, va == NULL ? 0 : size);
 531         }
 532         if (flags & M_WAITOK)
 533                 KASSERT(va != NULL, ("malloc(M_WAITOK) returned NULL"));
 534         else if (va == NULL)
 535                 t_malloc_fail = time_uptime;
 536 #ifdef DIAGNOSTIC
 537         if (va != NULL && !(flags & M_ZERO)) {
 538                 memset(va, 0x70, osize);
 539         }
 540 #endif
 541 #ifdef DEBUG_REDZONE
 542         if (va != NULL)
 543                 va = redzone_setup(va, osize);
 544 #endif
 545         return ((void *) va);
 546 }
 547
 548 /*
 549  *      free:
 550  *
 551  *      Free a block of memory allocated by malloc.
 552  *
 553  *      This routine may not block.
 554  */
 555 void
 556 free(void *addr, struct malloc_type *mtp)
 557 {
 558         uma_slab_t slab;
 559         u_long size;
 560
 561         KASSERT(mtp->ks_magic == M_MAGIC, ("free: bad malloc type magic"));
 562
 563         /* free(NULL, ...) does nothing */
 564         if (addr == NULL)
 565                 return;
 566
 567 #ifdef DEBUG_MEMGUARD
 568         if (is_memguard_addr(addr)) {
 569                 memguard_free(addr);
 570                 return;
 571         }
 572 #endif
 573
 574 #ifdef DEBUG_REDZONE
 575         redzone_check(addr);
 576         addr = redzone_addr_ntor(addr);
 577 #endif
 578
 579         slab = vtoslab((vm_offset_t)addr & (~UMA_SLAB_MASK));
 580
 581         if (slab == NULL)
 582                 panic("free: address %p(%p) has not been allocated.\n",
 583                     addr, (void *)((u_long)addr & (~UMA_SLAB_MASK)));
 584
 585         if (!(slab->us_flags & UMA_SLAB_MALLOC)) {
 586 #ifdef INVARIANTS
 587                 struct malloc_type **mtpp = addr;
 588 #endif
 589                 size = slab->us_keg->uk_size;
 590 #ifdef INVARIANTS
 591                 /*
 592                  * Cache a pointer to the malloc_type that most recently freed
 593                  * this memory here.  This way we know who is most likely to
 594                  * have stepped on it later.
 595                  *
 596                  * This code assumes that size is a multiple of 8 bytes for
 597                  * 64 bit machines
 598                  */
 599                 mtpp = (struct malloc_type **)
 600                     ((unsigned long)mtpp & ~UMA_ALIGN_PTR);
 601                 mtpp += (size - sizeof(struct malloc_type *)) /
 602                     sizeof(struct malloc_type *);
 603                 *mtpp = mtp;
 604 #endif
 605                 uma_zfree_arg(LIST_FIRST(&slab->us_keg->uk_zones), addr, slab);
 606         } else {
 607                 size = slab->us_size;
 608                 uma_large_free(slab);
 609         }
 610         malloc_type_freed(mtp, size);
 611 }
 612
 613 /*
 614  *      realloc: change the size of a memory block
 615  */
 616 void *
 617 realloc(void *addr, unsigned long size, struct malloc_type *mtp, int flags)
 618 {
 619         uma_slab_t slab;
 620         unsigned long alloc;
 621         void *newaddr;
 622
 623         KASSERT(mtp->ks_magic == M_MAGIC,
 624             ("realloc: bad malloc type magic"));
 625
 626         /* realloc(NULL, ...) is equivalent to malloc(...) */
 627         if (addr == NULL)
 628                 return (malloc(size, mtp, flags));
 629
 630         /*
 631          * XXX: Should report free of old memory and alloc of new memory to
 632          * per-CPU stats.
 633          */
 634
 635 #ifdef DEBUG_MEMGUARD
 636         if (is_memguard_addr(addr))
 637                 return (memguard_realloc(addr, size, mtp, flags));
 638 #endif
 639
 640 #ifdef DEBUG_REDZONE
 641         slab = NULL;
 642         alloc = redzone_get_size(addr);
 643 #else
 644         slab = vtoslab((vm_offset_t)addr & ~(UMA_SLAB_MASK));
 645
 646         /* Sanity check */
 647         KASSERT(slab != NULL,
 648             ("realloc: address %p out of range", (void *)addr));
 649
 650         /* Get the size of the original block */
 651         if (!(slab->us_flags & UMA_SLAB_MALLOC))
 652                 alloc = slab->us_keg->uk_size;
 653         else
 654                 alloc = slab->us_size;
 655
 656         /* Reuse the original block if appropriate */
 657         if (size <= alloc
 658             && (size > (alloc >> REALLOC_FRACTION) || alloc == MINALLOCSIZE))
 659                 return (addr);
 660 #endif /* !DEBUG_REDZONE */
 661
 662         /* Allocate a new, bigger (or smaller) block */
 663         if ((newaddr = malloc(size, mtp, flags)) == NULL)
 664                 return (NULL);
 665
 666         /* Copy over original contents */
 667         bcopy(addr, newaddr, min(size, alloc));
 668         free(addr, mtp);
 669         return (newaddr);
 670 }
 671
 672 /*
 673  *      reallocf: same as realloc() but free memory on failure.
 674  */
 675 void *
 676 reallocf(void *addr, unsigned long size, struct malloc_type *mtp, int flags)
 677 {
 678         void *mem;
 679
 680         if ((mem = realloc(addr, size, mtp, flags)) == NULL)
 681                 free(addr, mtp);
 682         return (mem);
 683 }
 684
 685 /*
 686  * Initialize the kernel memory allocator
 687  */
 688 /* ARGSUSED*/
 689 static void
 690 kmeminit(void *dummy)
 691 {
 692         uint8_t indx;
 693         u_long mem_size, tmp;
 694         int i;
 695
 696         mtx_init(&malloc_mtx, "malloc", NULL, MTX_DEF);
 697
 698         /*
 699          * Try to auto-tune the kernel memory size, so that it is
 700          * more applicable for a wider range of machine sizes.  The
 701          * VM_KMEM_SIZE_MAX is dependent on the maximum KVA space
 702          * available.
 703          *
 704          * Note that the kmem_map is also used by the zone allocator,
 705          * so make sure that there is enough space.
 706          */
 707         vm_kmem_size = VM_KMEM_SIZE + nmbclusters * PAGE_SIZE;
 708         mem_size = cnt.v_page_count;
 709
 710 #if defined(VM_KMEM_SIZE_SCALE)
 711         vm_kmem_size_scale = VM_KMEM_SIZE_SCALE;
 712 #endif
 713         TUNABLE_INT_FETCH("vm.kmem_size_scale", &vm_kmem_size_scale);
 714         if (vm_kmem_size_scale > 0 &&
 715             (mem_size / vm_kmem_size_scale) > (vm_kmem_size / PAGE_SIZE))
 716                 vm_kmem_size = (mem_size / vm_kmem_size_scale) * PAGE_SIZE;
 717
 718 #if defined(VM_KMEM_SIZE_MIN)
 719         vm_kmem_size_min = VM_KMEM_SIZE_MIN;
 720 #endif
 721         TUNABLE_ULONG_FETCH("vm.kmem_size_min", &vm_kmem_size_min);
 722         if (vm_kmem_size_min > 0 && vm_kmem_size < vm_kmem_size_min) {
 723                 vm_kmem_size = vm_kmem_size_min;
 724         }
 725
 726 #if defined(VM_KMEM_SIZE_MAX)
 727         vm_kmem_size_max = VM_KMEM_SIZE_MAX;
 728 #endif
 729         TUNABLE_ULONG_FETCH("vm.kmem_size_max", &vm_kmem_size_max);
 730         if (vm_kmem_size_max > 0 && vm_kmem_size >= vm_kmem_size_max)
 731                 vm_kmem_size = vm_kmem_size_max;
 732
 733         /* Allow final override from the kernel environment */
 734         TUNABLE_ULONG_FETCH("vm.kmem_size", &vm_kmem_size);
 735
 736         /*
 737          * Limit kmem virtual size to twice the physical memory.
 738          * This allows for kmem map sparseness, but limits the size
 739          * to something sane.  Be careful to not overflow the 32bit
 740          * ints while doing the check or the adjustment.
 741          */
 742         if (vm_kmem_size / 2 / PAGE_SIZE > mem_size)
 743                 vm_kmem_size = 2 * mem_size * PAGE_SIZE;
 744
 745 #ifdef DEBUG_MEMGUARD
 746         tmp = memguard_fudge(vm_kmem_size, kernel_map);
 747 #else
 748         tmp = vm_kmem_size;
 749 #endif
 750         kmem_map = kmem_suballoc(kernel_map, &kmembase, &kmemlimit,
 751             tmp, TRUE);
 752         kmem_map->system_map = 1;
 753
 754 #ifdef DEBUG_MEMGUARD
 755         /*
 756          * Initialize MemGuard if support compiled in.  MemGuard is a
 757          * replacement allocator used for detecting tamper-after-free
 758          * scenarios as they occur.  It is only used for debugging.
 759          */
 760         memguard_init(kmem_map);
 761 #endif
 762
 763         uma_startup2();
 764
 765         mt_zone = uma_zcreate("mt_zone", sizeof(struct malloc_type_internal),
 766 #ifdef INVARIANTS
 767             mtrash_ctor, mtrash_dtor, mtrash_init, mtrash_fini,
 768 #else
 769             NULL, NULL, NULL, NULL,
 770 #endif
 771             UMA_ALIGN_PTR, UMA_ZONE_MALLOC);
 772         for (i = 0, indx = 0; kmemzones[indx].kz_size != 0; indx++) {
 773                 int size = kmemzones[indx].kz_size;
 774                 char *name = kmemzones[indx].kz_name;
 775                 int subzone;
 776
 777                 for (subzone = 0; subzone < numzones; subzone++) {
 778                         kmemzones[indx].kz_zone[subzone] =
 779                             uma_zcreate(name, size,
 780 #ifdef INVARIANTS
 781                             mtrash_ctor, mtrash_dtor, mtrash_init, mtrash_fini,
 782 #else
 783                             NULL, NULL, NULL, NULL,
 784 #endif
 785                             UMA_ALIGN_PTR, UMA_ZONE_MALLOC);
 786                 }
 787                 for (;i <= size; i+= KMEM_ZBASE)
 788                         kmemsize[i >> KMEM_ZSHIFT] = indx;
 789
 790         }
 791 }
 792
 793 void
 794 malloc_init(void *data)
 795 {
 796         struct malloc_type_internal *mtip;
 797         struct malloc_type *mtp;
 798
 799         KASSERT(cnt.v_page_count != 0, ("malloc_register before vm_init"));
 800
 801         mtp = data;
 802         if (mtp->ks_magic != M_MAGIC)
 803                 panic("malloc_init: bad malloc type magic");
 804
 805         mtip = uma_zalloc(mt_zone, M_WAITOK | M_ZERO);
 806         mtp->ks_handle = mtip;
 807         mtip->mti_zone = mtp_get_subzone(mtp->ks_shortdesc);
 808
 809         mtx_lock(&malloc_mtx);
 810         mtp->ks_next = kmemstatistics;
 811         kmemstatistics = mtp;
 812         kmemcount++;
 813         mtx_unlock(&malloc_mtx);
 814 }
 815
 816 void
 817 malloc_uninit(void *data)
 818 {
 819         struct malloc_type_internal *mtip;
 820         struct malloc_type_stats *mtsp;
 821         struct malloc_type *mtp, *temp;
 822         uma_slab_t slab;
 823         long temp_allocs, temp_bytes;
 824         int i;
 825
 826         mtp = data;
 827         KASSERT(mtp->ks_magic == M_MAGIC,
 828             ("malloc_uninit: bad malloc type magic"));
 829         KASSERT(mtp->ks_handle != NULL, ("malloc_deregister: cookie NULL"));
 830
 831         mtx_lock(&malloc_mtx);
 832         mtip = mtp->ks_handle;
 833         mtp->ks_handle = NULL;
 834         if (mtp != kmemstatistics) {
 835                 for (temp = kmemstatistics; temp != NULL;
 836                     temp = temp->ks_next) {
 837                         if (temp->ks_next == mtp) {
 838                                 temp->ks_next = mtp->ks_next;
 839                                 break;
 840                         }
 841                 }
 842                 KASSERT(temp,
 843                     ("malloc_uninit: type '%s' not found", mtp->ks_shortdesc));
 844         } else
 845                 kmemstatistics = mtp->ks_next;
 846         kmemcount--;
 847         mtx_unlock(&malloc_mtx);
 848
 849         /*
 850          * Look for memory leaks.
 851          */
 852         temp_allocs = temp_bytes = 0;
 853         for (i = 0; i < MAXCPU; i++) {
 854                 mtsp = &mtip->mti_stats[i];
 855                 temp_allocs += mtsp->mts_numallocs;
 856                 temp_allocs -= mtsp->mts_numfrees;
 857                 temp_bytes += mtsp->mts_memalloced;
 858                 temp_bytes -= mtsp->mts_memfreed;
 859         }
 860         if (temp_allocs > 0 || temp_bytes > 0) {
 861                 printf("Warning: memory type %s leaked memory on destroy "
 862                     "(%ld allocations, %ld bytes leaked).\n", mtp->ks_shortdesc,
 863                     temp_allocs, temp_bytes);
 864         }
 865
 866         slab = vtoslab((vm_offset_t) mtip & (~UMA_SLAB_MASK));
 867         uma_zfree_arg(mt_zone, mtip, slab);
 868 }
 869
 870 struct malloc_type *
 871 malloc_desc2type(const char *desc)
 872 {
 873         struct malloc_type *mtp;
 874
 875         mtx_assert(&malloc_mtx, MA_OWNED);
 876         for (mtp = kmemstatistics; mtp != NULL; mtp = mtp->ks_next) {
 877                 if (strcmp(mtp->ks_shortdesc, desc) == 0)
 878                         return (mtp);
 879         }
 880         return (NULL);
 881 }
 882
 883 static int
 884 sysctl_kern_malloc_stats(SYSCTL_HANDLER_ARGS)
 885 {
 886         struct malloc_type_stream_header mtsh;
 887         struct malloc_type_internal *mtip;
 888         struct malloc_type_header mth;
 889         struct malloc_type *mtp;
 890         int error, i;
 891         struct sbuf sbuf;
 892
 893         error = sysctl_wire_old_buffer(req, 0);
 894         if (error != 0)
 895                 return (error);
 896         sbuf_new_for_sysctl(&sbuf, NULL, 128, req);
 897         mtx_lock(&malloc_mtx);
 898
 899         /*
 900          * Insert stream header.
 901          */
 902         bzero(&mtsh, sizeof(mtsh));
 903         mtsh.mtsh_version = MALLOC_TYPE_STREAM_VERSION;
 904         mtsh.mtsh_maxcpus = MAXCPU;
 905         mtsh.mtsh_count = kmemcount;
 906         (void)sbuf_bcat(&sbuf, &mtsh, sizeof(mtsh));
 907
 908         /*
 909          * Insert alternating sequence of type headers and type statistics.
 910          */
 911         for (mtp = kmemstatistics; mtp != NULL; mtp = mtp->ks_next) {
 912                 mtip = (struct malloc_type_internal *)mtp->ks_handle;
 913
 914                 /*
 915                  * Insert type header.
 916                  */
 917                 bzero(&mth, sizeof(mth));
 918                 strlcpy(mth.mth_name, mtp->ks_shortdesc, MALLOC_MAX_NAME);
 919                 (void)sbuf_bcat(&sbuf, &mth, sizeof(mth));
 920
 921                 /*
 922                  * Insert type statistics for each CPU.
 923                  */
 924                 for (i = 0; i < MAXCPU; i++) {
 925                         (void)sbuf_bcat(&sbuf, &mtip->mti_stats[i],
 926                             sizeof(mtip->mti_stats[i]));
 927                 }
 928         }
 929         mtx_unlock(&malloc_mtx);
 930         error = sbuf_finish(&sbuf);
 931         sbuf_delete(&sbuf);
 932         return (error);
 933 }
 934
 935 SYSCTL_PROC(_kern, OID_AUTO, malloc_stats, CTLFLAG_RD|CTLTYPE_STRUCT,
 936     0, 0, sysctl_kern_malloc_stats, "s,malloc_type_ustats",
 937     "Return malloc types");
 938
 939 SYSCTL_INT(_kern, OID_AUTO, malloc_count, CTLFLAG_RD, &kmemcount, 0,
 940     "Count of kernel malloc types");
 941
 942 void
 943 malloc_type_list(malloc_type_list_func_t *func, void *arg)
 944 {
 945         struct malloc_type *mtp, **bufmtp;
 946         int count, i;
 947         size_t buflen;
 948
 949         mtx_lock(&malloc_mtx);
 950 restart:
 951         mtx_assert(&malloc_mtx, MA_OWNED);
 952         count = kmemcount;
 953         mtx_unlock(&malloc_mtx);
 954
 955         buflen = sizeof(struct malloc_type *) * count;
 956         bufmtp = malloc(buflen, M_TEMP, M_WAITOK);
 957
 958         mtx_lock(&malloc_mtx);
 959
 960         if (count < kmemcount) {
 961                 free(bufmtp, M_TEMP);
 962                 goto restart;
 963         }
 964
 965         for (mtp = kmemstatistics, i = 0; mtp != NULL; mtp = mtp->ks_next, i++)
 966                 bufmtp[i] = mtp;
 967
 968         mtx_unlock(&malloc_mtx);
 969
 970         for (i = 0; i < count; i++)
 971                 (func)(bufmtp[i], arg);
 972
 973         free(bufmtp, M_TEMP);
 974 }
 975
 976 #ifdef DDB
 977 DB_SHOW_COMMAND(malloc, db_show_malloc)
 978 {
 979         struct malloc_type_internal *mtip;
 980         struct malloc_type *mtp;
 981         uint64_t allocs, frees;
 982         uint64_t alloced, freed;
 983         int i;
 984
 985         db_printf("%18s %12s  %12s %12s\n", "Type", "InUse", "MemUse",
 986             "Requests");
 987         for (mtp = kmemstatistics; mtp != NULL; mtp = mtp->ks_next) {
 988                 mtip = (struct malloc_type_internal *)mtp->ks_handle;
 989                 allocs = 0;
 990                 frees = 0;
 991                 alloced = 0;
 992                 freed = 0;
 993                 for (i = 0; i < MAXCPU; i++) {
 994                         allocs += mtip->mti_stats[i].mts_numallocs;
 995                         frees += mtip->mti_stats[i].mts_numfrees;
 996                         alloced += mtip->mti_stats[i].mts_memalloced;
 997                         freed += mtip->mti_stats[i].mts_memfreed;
 998                 }
 999                 db_printf("%18s %12ju %12juK %12ju\n",
1000                     mtp->ks_shortdesc, allocs - frees,
1001                     (alloced - freed + 1023) / 1024, allocs);
1002                 if (db_pager_quit)
1003                         break;
1004         }
1005 }
1006
1007 #if MALLOC_DEBUG_MAXZONES > 1
1008 DB_SHOW_COMMAND(multizone_matches, db_show_multizone_matches)
1009 {
1010         struct malloc_type_internal *mtip;
1011         struct malloc_type *mtp;
1012         u_int subzone;
1013
1014         if (!have_addr) {
1015                 db_printf("Usage: show multizone_matches <malloc type/addr>\n");
1016                 return;
1017         }
1018         mtp = (void *)addr;
1019         if (mtp->ks_magic != M_MAGIC) {
1020                 db_printf("Magic %lx does not match expected %x\n",
1021                     mtp->ks_magic, M_MAGIC);
1022                 return;
1023         }
1024
1025         mtip = mtp->ks_handle;
1026         subzone = mtip->mti_zone;
1027
1028         for (mtp = kmemstatistics; mtp != NULL; mtp = mtp->ks_next) {
1029                 mtip = mtp->ks_handle;
1030                 if (mtip->mti_zone != subzone)
1031                         continue;
1032                 db_printf("%s\n", mtp->ks_shortdesc);
1033                 if (db_pager_quit)
1034                         break;
1035         }
1036 }
1037 #endif /* MALLOC_DEBUG_MAXZONES > 1 */
1038 #endif /* DDB */
1039
1040 #ifdef MALLOC_PROFILE
1041
1042 static int
1043 sysctl_kern_mprof(SYSCTL_HANDLER_ARGS)
1044 {
1045         struct sbuf sbuf;
1046         uint64_t count;
1047         uint64_t waste;
1048         uint64_t mem;
1049         int error;
1050         int rsize;
1051         int size;
1052         int i;
1053
1054         waste = 0;
1055         mem = 0;
1056
1057         error = sysctl_wire_old_buffer(req, 0);
1058         if (error != 0)
1059                 return (error);
1060         sbuf_new_for_sysctl(&sbuf, NULL, 128, req);
1061         sbuf_printf(&sbuf,
1062             "\n  Size                    Requests  Real Size\n");
1063         for (i = 0; i < KMEM_ZSIZE; i++) {
1064                 size = i << KMEM_ZSHIFT;
1065                 rsize = kmemzones[kmemsize[i]].kz_size;
1066                 count = (long long unsigned)krequests[i];
1067
1068                 sbuf_printf(&sbuf, "%6d%28llu%11d\n", size,
1069                     (unsigned long long)count, rsize);
1070
1071                 if ((rsize * count) > (size * count))
1072                         waste += (rsize * count) - (size * count);
1073                 mem += (rsize * count);
1074         }
1075         sbuf_printf(&sbuf,
1076             "\nTotal memory used:\t%30llu\nTotal Memory wasted:\t%30llu\n",
1077             (unsigned long long)mem, (unsigned long long)waste);
1078         error = sbuf_finish(&sbuf);
1079         sbuf_delete(&sbuf);
1080         return (error);
1081 }
1082
1083 SYSCTL_OID(_kern, OID_AUTO, mprof, CTLTYPE_STRING|CTLFLAG_RD,
1084     NULL, 0, sysctl_kern_mprof, "A", "Malloc Profiling");
1085 #endif /* MALLOC_PROFILE */