2N/A/*
2N/A * CDDL HEADER START
2N/A *
2N/A * The contents of this file are subject to the terms of the
2N/A * Common Development and Distribution License (the "License").
2N/A * You may not use this file except in compliance with the License.
2N/A *
2N/A * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
2N/A * or http://www.opensolaris.org/os/licensing.
2N/A * See the License for the specific language governing permissions
2N/A * and limitations under the License.
2N/A *
2N/A * When distributing Covered Code, include this CDDL HEADER in each
2N/A * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
2N/A * If applicable, add the following below this CDDL HEADER, with the
2N/A * fields enclosed by brackets "[]" replaced with your own identifying
2N/A * information: Portions Copyright [yyyy] [name of copyright owner]
2N/A *
2N/A * CDDL HEADER END
2N/A */
2N/A/*
2N/A * Copyright (c) 2002, 2004, Oracle and/or its affiliates. All rights reserved.
2N/A */
2N/A
2N/A#ifndef _UMEM_IMPL_H
2N/A#define _UMEM_IMPL_H
2N/A
2N/A#include <umem.h>
2N/A
2N/A#include <sys/sysmacros.h>
2N/A#include <sys/time.h>
2N/A#include <sys/vmem.h>
2N/A#include <thread.h>
2N/A
2N/A#ifdef __cplusplus
2N/Aextern "C" {
2N/A#endif
2N/A
2N/A/*
2N/A * umem memory allocator: implementation-private data structures
2N/A */
2N/A
2N/A/*
2N/A * Internal flags for umem_cache_create
2N/A */
2N/A#define UMC_QCACHE 0x00100000
2N/A#define UMC_INTERNAL 0x80000000
2N/A
2N/A/*
2N/A * Cache flags
2N/A */
2N/A#define UMF_AUDIT 0x00000001 /* transaction auditing */
2N/A#define UMF_DEADBEEF 0x00000002 /* deadbeef checking */
2N/A#define UMF_REDZONE 0x00000004 /* redzone checking */
2N/A#define UMF_CONTENTS 0x00000008 /* freed-buffer content logging */
2N/A#define UMF_CHECKSIGNAL 0x00000010 /* abort when in signal context */
2N/A#define UMF_NOMAGAZINE 0x00000020 /* disable per-cpu magazines */
2N/A#define UMF_FIREWALL 0x00000040 /* put all bufs before unmapped pages */
2N/A#define UMF_LITE 0x00000100 /* lightweight debugging */
2N/A
2N/A#define UMF_HASH 0x00000200 /* cache has hash table */
2N/A#define UMF_RANDOMIZE 0x00000400 /* randomize other umem_flags */
2N/A
2N/A#define UMF_BUFTAG (UMF_DEADBEEF | UMF_REDZONE)
2N/A#define UMF_TOUCH (UMF_BUFTAG | UMF_LITE | UMF_CONTENTS)
2N/A#define UMF_RANDOM (UMF_TOUCH | UMF_AUDIT | UMF_NOMAGAZINE)
2N/A#define UMF_DEBUG (UMF_RANDOM | UMF_FIREWALL)
2N/A
2N/A#define UMEM_STACK_DEPTH umem_stack_depth
2N/A
2N/A#define UMEM_FREE_PATTERN 0xdeadbeefdeadbeefULL
2N/A#define UMEM_UNINITIALIZED_PATTERN 0xbaddcafebaddcafeULL
2N/A#define UMEM_REDZONE_PATTERN 0xfeedfacefeedfaceULL
2N/A#define UMEM_REDZONE_BYTE 0xbb
2N/A
2N/A#define UMEM_FATAL_FLAGS (UMEM_NOFAIL)
2N/A#define UMEM_SLEEP_FLAGS (0)
2N/A
2N/A/*
2N/A * Redzone size encodings for umem_alloc() / umem_free(). We encode the
2N/A * allocation size, rather than storing it directly, so that umem_free()
2N/A * can distinguish frees of the wrong size from redzone violations.
2N/A */
2N/A#define UMEM_SIZE_ENCODE(x) (251 * (x) + 1)
2N/A#define UMEM_SIZE_DECODE(x) ((x) / 251)
2N/A#define UMEM_SIZE_VALID(x) ((x) % 251 == 1)
2N/A
2N/A/*
2N/A * The bufctl (buffer control) structure keeps some minimal information
2N/A * about each buffer: its address, its slab, and its current linkage,
2N/A * which is either on the slab's freelist (if the buffer is free), or
2N/A * on the cache's buf-to-bufctl hash table (if the buffer is allocated).
2N/A * In the case of non-hashed, or "raw", caches (the common case), only
2N/A * the freelist linkage is necessary: the buffer address is at a fixed
2N/A * offset from the bufctl address, and the slab is at the end of the page.
2N/A *
2N/A * NOTE: bc_next must be the first field; raw buffers have linkage only.
2N/A */
2N/Atypedef struct umem_bufctl {
2N/A struct umem_bufctl *bc_next; /* next bufctl struct */
2N/A void *bc_addr; /* address of buffer */
2N/A struct umem_slab *bc_slab; /* controlling slab */
2N/A} umem_bufctl_t;
2N/A
2N/A/*
2N/A * The UMF_AUDIT version of the bufctl structure. The beginning of this
2N/A * structure must be identical to the normal bufctl structure so that
2N/A * pointers are interchangeable.
2N/A */
2N/A
2N/A#define UMEM_BUFCTL_AUDIT_SIZE_DEPTH(frames) \
2N/A ((size_t)(&((umem_bufctl_audit_t *)0)->bc_stack[frames]))
2N/A
2N/A/*
2N/A * umem_bufctl_audits must be allocated from a UMC_NOHASH cache, so we
2N/A * require that 2 of them, plus 2 buftags, plus a umem_slab_t, all fit on
2N/A * a single page.
2N/A *
2N/A * For ILP32, this is about 1000 frames.
2N/A * For LP64, this is about 490 frames.
2N/A */
2N/A
2N/A#define UMEM_BUFCTL_AUDIT_ALIGN 32
2N/A
2N/A#define UMEM_BUFCTL_AUDIT_MAX_SIZE \
2N/A (P2ALIGN((PAGESIZE - sizeof (umem_slab_t))/2 - \
2N/A sizeof (umem_buftag_t), UMEM_BUFCTL_AUDIT_ALIGN))
2N/A
2N/A#define UMEM_MAX_STACK_DEPTH \
2N/A ((UMEM_BUFCTL_AUDIT_MAX_SIZE - \
2N/A UMEM_BUFCTL_AUDIT_SIZE_DEPTH(0)) / sizeof (uintptr_t))
2N/A
2N/Atypedef struct umem_bufctl_audit {
2N/A struct umem_bufctl *bc_next; /* next bufctl struct */
2N/A void *bc_addr; /* address of buffer */
2N/A struct umem_slab *bc_slab; /* controlling slab */
2N/A umem_cache_t *bc_cache; /* controlling cache */
2N/A hrtime_t bc_timestamp; /* transaction time */
2N/A thread_t bc_thread; /* thread doing transaction */
2N/A struct umem_bufctl *bc_lastlog; /* last log entry */
2N/A void *bc_contents; /* contents at last free */
2N/A int bc_depth; /* stack depth */
2N/A uintptr_t bc_stack[1]; /* pc stack */
2N/A} umem_bufctl_audit_t;
2N/A
2N/A#define UMEM_LOCAL_BUFCTL_AUDIT(bcpp) \
2N/A *(bcpp) = (umem_bufctl_audit_t *) \
2N/A alloca(UMEM_BUFCTL_AUDIT_SIZE)
2N/A
2N/A#define UMEM_BUFCTL_AUDIT_SIZE \
2N/A UMEM_BUFCTL_AUDIT_SIZE_DEPTH(UMEM_STACK_DEPTH)
2N/A
2N/A/*
2N/A * A umem_buftag structure is appended to each buffer whenever any of the
2N/A * UMF_BUFTAG flags (UMF_DEADBEEF, UMF_REDZONE, UMF_VERIFY) are set.
2N/A */
2N/Atypedef struct umem_buftag {
2N/A uint64_t bt_redzone; /* 64-bit redzone pattern */
2N/A umem_bufctl_t *bt_bufctl; /* bufctl */
2N/A intptr_t bt_bxstat; /* bufctl ^ (alloc/free) */
2N/A} umem_buftag_t;
2N/A
2N/A#define UMEM_BUFTAG(cp, buf) \
2N/A ((umem_buftag_t *)((char *)(buf) + (cp)->cache_buftag))
2N/A
2N/A#define UMEM_BUFCTL(cp, buf) \
2N/A ((umem_bufctl_t *)((char *)(buf) + (cp)->cache_bufctl))
2N/A
2N/A#define UMEM_BUF(cp, bcp) \
2N/A ((void *)((char *)(bcp) - (cp)->cache_bufctl))
2N/A
2N/A#define UMEM_SLAB(cp, buf) \
2N/A ((umem_slab_t *)P2END((uintptr_t)(buf), (cp)->cache_slabsize) - 1)
2N/A
2N/A#define UMEM_CPU_CACHE(cp, cpu) \
2N/A (umem_cpu_cache_t *)((char *)cp + cpu->cpu_cache_offset)
2N/A
2N/A#define UMEM_MAGAZINE_VALID(cp, mp) \
2N/A (((umem_slab_t *)P2END((uintptr_t)(mp), PAGESIZE) - 1)->slab_cache == \
2N/A (cp)->cache_magtype->mt_cache)
2N/A
2N/A#define UMEM_SLAB_MEMBER(sp, buf) \
2N/A ((size_t)(buf) - (size_t)(sp)->slab_base < \
2N/A (sp)->slab_cache->cache_slabsize)
2N/A
2N/A#define UMEM_BUFTAG_ALLOC 0xa110c8edUL
2N/A#define UMEM_BUFTAG_FREE 0xf4eef4eeUL
2N/A
2N/Atypedef struct umem_slab {
2N/A struct umem_cache *slab_cache; /* controlling cache */
2N/A void *slab_base; /* base of allocated memory */
2N/A struct umem_slab *slab_next; /* next slab on freelist */
2N/A struct umem_slab *slab_prev; /* prev slab on freelist */
2N/A struct umem_bufctl *slab_head; /* first free buffer */
2N/A long slab_refcnt; /* outstanding allocations */
2N/A long slab_chunks; /* chunks (bufs) in this slab */
2N/A} umem_slab_t;
2N/A
2N/A#define UMEM_HASH_INITIAL 64
2N/A
2N/A#define UMEM_HASH(cp, buf) \
2N/A ((cp)->cache_hash_table + \
2N/A (((uintptr_t)(buf) >> (cp)->cache_hash_shift) & (cp)->cache_hash_mask))
2N/A
2N/Atypedef struct umem_magazine {
2N/A void *mag_next;
2N/A void *mag_round[1]; /* one or more rounds */
2N/A} umem_magazine_t;
2N/A
2N/A/*
2N/A * The magazine types for fast per-cpu allocation
2N/A */
2N/Atypedef struct umem_magtype {
2N/A int mt_magsize; /* magazine size (number of rounds) */
2N/A int mt_align; /* magazine alignment */
2N/A size_t mt_minbuf; /* all smaller buffers qualify */
2N/A size_t mt_maxbuf; /* no larger buffers qualify */
2N/A umem_cache_t *mt_cache; /* magazine cache */
2N/A} umem_magtype_t;
2N/A
2N/A#define UMEM_CPU_CACHE_SIZE 64 /* must be power of 2 */
2N/A#define UMEM_CPU_PAD (UMEM_CPU_CACHE_SIZE - sizeof (mutex_t) - \
2N/A 2 * sizeof (uint_t) - 2 * sizeof (void *) - 4 * sizeof (int))
2N/A#define UMEM_CACHE_SIZE(ncpus) \
2N/A ((size_t)(&((umem_cache_t *)0)->cache_cpu[ncpus]))
2N/A
2N/Atypedef struct umem_cpu_cache {
2N/A mutex_t cc_lock; /* protects this cpu's local cache */
2N/A uint_t cc_alloc; /* allocations from this cpu */
2N/A uint_t cc_free; /* frees to this cpu */
2N/A umem_magazine_t *cc_loaded; /* the currently loaded magazine */
2N/A umem_magazine_t *cc_ploaded; /* the previously loaded magazine */
2N/A int cc_rounds; /* number of objects in loaded mag */
2N/A int cc_prounds; /* number of objects in previous mag */
2N/A int cc_magsize; /* number of rounds in a full mag */
2N/A int cc_flags; /* CPU-local copy of cache_flags */
2N/A#ifndef _LP64
2N/A char cc_pad[UMEM_CPU_PAD]; /* for nice alignment (32-bit) */
2N/A#endif
2N/A} umem_cpu_cache_t;
2N/A
2N/A/*
2N/A * The magazine lists used in the depot.
2N/A */
2N/Atypedef struct umem_maglist {
2N/A umem_magazine_t *ml_list; /* magazine list */
2N/A long ml_total; /* number of magazines */
2N/A long ml_min; /* min since last update */
2N/A long ml_reaplimit; /* max reapable magazines */
2N/A uint64_t ml_alloc; /* allocations from this list */
2N/A} umem_maglist_t;
2N/A
2N/A#define UMEM_CACHE_NAMELEN 31
2N/A
2N/Astruct umem_cache {
2N/A /*
2N/A * Statistics
2N/A */
2N/A uint64_t cache_slab_create; /* slab creates */
2N/A uint64_t cache_slab_destroy; /* slab destroys */
2N/A uint64_t cache_slab_alloc; /* slab layer allocations */
2N/A uint64_t cache_slab_free; /* slab layer frees */
2N/A uint64_t cache_alloc_fail; /* total failed allocations */
2N/A uint64_t cache_buftotal; /* total buffers */
2N/A uint64_t cache_bufmax; /* max buffers ever */
2N/A uint64_t cache_rescale; /* # of hash table rescales */
2N/A uint64_t cache_lookup_depth; /* hash lookup depth */
2N/A uint64_t cache_depot_contention; /* mutex contention count */
2N/A uint64_t cache_depot_contention_prev; /* previous snapshot */
2N/A
2N/A /*
2N/A * Cache properties
2N/A */
2N/A char cache_name[UMEM_CACHE_NAMELEN + 1];
2N/A size_t cache_bufsize; /* object size */
2N/A size_t cache_align; /* object alignment */
2N/A umem_constructor_t *cache_constructor;
2N/A umem_destructor_t *cache_destructor;
2N/A umem_reclaim_t *cache_reclaim;
2N/A void *cache_private; /* opaque arg to callbacks */
2N/A vmem_t *cache_arena; /* vmem source for slabs */
2N/A int cache_cflags; /* cache creation flags */
2N/A int cache_flags; /* various cache state info */
2N/A int cache_uflags; /* UMU_* flags */
2N/A uint32_t cache_mtbf; /* induced alloc failure rate */
2N/A umem_cache_t *cache_next; /* forward cache linkage */
2N/A umem_cache_t *cache_prev; /* backward cache linkage */
2N/A umem_cache_t *cache_unext; /* next in update list */
2N/A umem_cache_t *cache_uprev; /* prev in update list */
2N/A uint32_t cache_cpu_mask; /* mask for cpu offset */
2N/A
2N/A /*
2N/A * Slab layer
2N/A */
2N/A mutex_t cache_lock; /* protects slab layer */
2N/A size_t cache_chunksize; /* buf + alignment [+ debug] */
2N/A size_t cache_slabsize; /* size of a slab */
2N/A size_t cache_bufctl; /* buf-to-bufctl distance */
2N/A size_t cache_buftag; /* buf-to-buftag distance */
2N/A size_t cache_verify; /* bytes to verify */
2N/A size_t cache_contents; /* bytes of saved content */
2N/A size_t cache_color; /* next slab color */
2N/A size_t cache_mincolor; /* maximum slab color */
2N/A size_t cache_maxcolor; /* maximum slab color */
2N/A size_t cache_hash_shift; /* get to interesting bits */
2N/A size_t cache_hash_mask; /* hash table mask */
2N/A umem_slab_t *cache_freelist; /* slab free list */
2N/A umem_slab_t cache_nullslab; /* end of freelist marker */
2N/A umem_cache_t *cache_bufctl_cache; /* source of bufctls */
2N/A umem_bufctl_t **cache_hash_table; /* hash table base */
2N/A /*
2N/A * Depot layer
2N/A */
2N/A mutex_t cache_depot_lock; /* protects depot */
2N/A umem_magtype_t *cache_magtype; /* magazine type */
2N/A umem_maglist_t cache_full; /* full magazines */
2N/A umem_maglist_t cache_empty; /* empty magazines */
2N/A
2N/A /*
2N/A * Per-CPU layer
2N/A */
2N/A umem_cpu_cache_t cache_cpu[1]; /* cache_cpu_mask + 1 entries */
2N/A};
2N/A
2N/Atypedef struct umem_cpu_log_header {
2N/A mutex_t clh_lock;
2N/A char *clh_current;
2N/A size_t clh_avail;
2N/A int clh_chunk;
2N/A int clh_hits;
2N/A char clh_pad[64 - sizeof (mutex_t) - sizeof (char *) -
2N/A sizeof (size_t) - 2 * sizeof (int)];
2N/A} umem_cpu_log_header_t;
2N/A
2N/Atypedef struct umem_log_header {
2N/A mutex_t lh_lock;
2N/A char *lh_base;
2N/A int *lh_free;
2N/A size_t lh_chunksize;
2N/A int lh_nchunks;
2N/A int lh_head;
2N/A int lh_tail;
2N/A int lh_hits;
2N/A umem_cpu_log_header_t lh_cpu[1]; /* actually umem_max_ncpus */
2N/A} umem_log_header_t;
2N/A
2N/Atypedef struct umem_cpu {
2N/A uint32_t cpu_cache_offset;
2N/A uint32_t cpu_number;
2N/A} umem_cpu_t;
2N/A
2N/A#define UMEM_MAXBUF 16384
2N/A
2N/A#define UMEM_ALIGN 8 /* min guaranteed alignment */
2N/A#define UMEM_ALIGN_SHIFT 3 /* log2(UMEM_ALIGN) */
2N/A#define UMEM_VOID_FRACTION 8 /* never waste more than 1/8 of slab */
2N/A
2N/A/*
2N/A * For 64 bits, buffers >= 16 bytes must be 16-byte aligned
2N/A */
2N/A#ifdef _LP64
2N/A#define UMEM_SECOND_ALIGN 16
2N/A#else
2N/A#define UMEM_SECOND_ALIGN UMEM_ALIGN
2N/A#endif
2N/A
2N/A#define MALLOC_MAGIC 0x3a10c000 /* 8-byte tag */
2N/A#define MEMALIGN_MAGIC 0x3e3a1000
2N/A
2N/A#ifdef _LP64
2N/A#define MALLOC_SECOND_MAGIC 0x16ba7000 /* 8-byte tag, 16-aligned */
2N/A#define MALLOC_OVERSIZE_MAGIC 0x06e47000 /* 16-byte tag, _LP64 */
2N/A#endif
2N/A
2N/A#define UMEM_MALLOC_ENCODE(type, sz) (uint32_t)((type) - (sz))
2N/A#define UMEM_MALLOC_DECODE(stat, sz) (uint32_t)((stat) + (sz))
2N/A#define UMEM_FREE_PATTERN_32 (uint32_t)(UMEM_FREE_PATTERN)
2N/A
2N/A#define UMU_MAGAZINE_RESIZE 0x00000001
2N/A#define UMU_HASH_RESCALE 0x00000002
2N/A#define UMU_REAP 0x00000004
2N/A#define UMU_NOTIFY 0x08000000
2N/A#define UMU_ACTIVE 0x80000000
2N/A
2N/A#define UMEM_READY_INIT_FAILED -1
2N/A#define UMEM_READY_STARTUP 1
2N/A#define UMEM_READY_INITING 2
2N/A#define UMEM_READY 3
2N/A
2N/A#ifdef UMEM_STANDALONE
2N/Aextern void umem_startup(caddr_t, size_t, size_t, caddr_t, caddr_t);
2N/Aextern int umem_add(caddr_t, size_t);
2N/A#endif
2N/A
2N/A#ifdef __cplusplus
2N/A}
2N/A#endif
2N/A
2N/A#endif /* _UMEM_IMPL_H */