xref: /illumos-gate/usr/src/uts/common/sys/vmem_impl.h (revision 24da5b34f49324ed742a340010ed5bd3d4e06625)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License, Version 1.0 only
6  * (the "License").  You may not use this file except in compliance
7  * with the License.
8  *
9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10  * or http://www.opensolaris.org/os/licensing.
11  * See the License for the specific language governing permissions
12  * and limitations under the License.
13  *
14  * When distributing Covered Code, include this CDDL HEADER in each
15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16  * If applicable, add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your own identifying
18  * information: Portions Copyright [yyyy] [name of copyright owner]
19  *
20  * CDDL HEADER END
21  */
22 /*
23  * Copyright 1999-2001, 2003 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef _SYS_VMEM_IMPL_H
28 #define	_SYS_VMEM_IMPL_H
29 
30 #pragma ident	"%Z%%M%	%I%	%E% SMI"
31 
32 #include <sys/vmem.h>
33 #include <sys/kstat.h>
34 #include <sys/mutex.h>
35 #include <sys/condvar.h>
36 #include <sys/thread.h>
37 #include <sys/systm.h>
38 
39 #ifdef	__cplusplus
40 extern "C" {
41 #endif
42 
43 typedef struct vmem_seg vmem_seg_t;
44 
45 #define	VMEM_STACK_DEPTH	20
46 
47 struct vmem_seg {
48 	/*
49 	 * The first four fields must match vmem_freelist_t exactly.
50 	 */
51 	uintptr_t	vs_start;	/* start of segment (inclusive) */
52 	uintptr_t	vs_end;		/* end of segment (exclusive) */
53 	vmem_seg_t	*vs_knext;	/* next of kin (alloc, free, span) */
54 	vmem_seg_t	*vs_kprev;	/* prev of kin */
55 
56 	vmem_seg_t	*vs_anext;	/* next in arena */
57 	vmem_seg_t	*vs_aprev;	/* prev in arena */
58 	uint8_t		vs_type;	/* alloc, free, span */
59 	uint8_t		vs_import;	/* non-zero if segment was imported */
60 	uint8_t		vs_depth;	/* stack depth if KMF_AUDIT active */
61 	/*
62 	 * The following fields are present only when KMF_AUDIT is set.
63 	 */
64 	kthread_t	*vs_thread;
65 	hrtime_t	vs_timestamp;
66 	pc_t		vs_stack[VMEM_STACK_DEPTH];
67 };
68 
69 typedef struct vmem_freelist {
70 	uintptr_t	vs_start;	/* always zero */
71 	uintptr_t	vs_end;		/* segment size */
72 	vmem_seg_t	*vs_knext;	/* next of kin */
73 	vmem_seg_t	*vs_kprev;	/* prev of kin */
74 } vmem_freelist_t;
75 
76 #define	VS_SIZE(vsp)	((vsp)->vs_end - (vsp)->vs_start)
77 
78 /*
79  * Segment hashing
80  */
81 #define	VMEM_HASH_INDEX(a, s, q, m)					\
82 	((((a) + ((a) >> (s)) + ((a) >> ((s) << 1))) >> (q)) & (m))
83 
84 #define	VMEM_HASH(vmp, addr)						\
85 	(&(vmp)->vm_hash_table[VMEM_HASH_INDEX(addr,			\
86 	(vmp)->vm_hash_shift, (vmp)->vm_qshift, (vmp)->vm_hash_mask)])
87 
88 #define	VMEM_QCACHE_SLABSIZE(max) \
89 	MAX(1 << highbit(3 * (max)), 64)
90 
91 #define	VMEM_NAMELEN		30
92 #define	VMEM_HASH_INITIAL	16
93 #define	VMEM_NQCACHE_MAX	16
94 #define	VMEM_FREELISTS		(sizeof (void *) * 8)
95 
96 typedef struct vmem_kstat {
97 	kstat_named_t	vk_mem_inuse;	/* memory in use */
98 	kstat_named_t	vk_mem_import;	/* memory imported */
99 	kstat_named_t	vk_mem_total;	/* total memory in arena */
100 	kstat_named_t	vk_source_id;	/* vmem id of vmem source */
101 	kstat_named_t	vk_alloc;	/* number of allocations */
102 	kstat_named_t	vk_free;	/* number of frees */
103 	kstat_named_t	vk_wait;	/* number of allocations that waited */
104 	kstat_named_t	vk_fail;	/* number of allocations that failed */
105 	kstat_named_t	vk_lookup;	/* hash lookup count */
106 	kstat_named_t	vk_search;	/* freelist search count */
107 	kstat_named_t	vk_populate_wait;	/* populates that waited */
108 	kstat_named_t	vk_populate_fail;	/* populates that failed */
109 	kstat_named_t	vk_contains;		/* vmem_contains() calls */
110 	kstat_named_t	vk_contains_search;	/* vmem_contains() search cnt */
111 } vmem_kstat_t;
112 
113 struct vmem {
114 	char		vm_name[VMEM_NAMELEN];	/* arena name */
115 	kcondvar_t	vm_cv;		/* cv for blocking allocations */
116 	kmutex_t	vm_lock;	/* arena lock */
117 	uint32_t	vm_id;		/* vmem id */
118 	uint32_t	vm_mtbf;	/* induced alloc failure rate */
119 	int		vm_cflags;	/* arena creation flags */
120 	int		vm_qshift;	/* log2(vm_quantum) */
121 	size_t		vm_quantum;	/* vmem quantum */
122 	size_t		vm_qcache_max;	/* maximum size to front by kmem */
123 	size_t		vm_min_import;	/* smallest amount to import */
124 	void		*(*vm_source_alloc)(vmem_t *, size_t, int);
125 	void		(*vm_source_free)(vmem_t *, void *, size_t);
126 	vmem_t		*vm_source;	/* vmem source for imported memory */
127 	vmem_t		*vm_next;	/* next in vmem_list */
128 	kstat_t		*vm_ksp;	/* kstat */
129 	ssize_t		vm_nsegfree;	/* number of free vmem_seg_t's */
130 	vmem_seg_t	*vm_segfree;	/* free vmem_seg_t list */
131 	vmem_seg_t	**vm_hash_table; /* allocated-segment hash table */
132 	size_t		vm_hash_mask;	/* hash_size - 1 */
133 	size_t		vm_hash_shift;	/* log2(vm_hash_mask + 1) */
134 	ulong_t		vm_freemap;	/* bitmap of non-empty freelists */
135 	vmem_seg_t	vm_seg0;	/* anchor segment */
136 	vmem_seg_t	vm_rotor;	/* rotor for VM_NEXTFIT allocations */
137 	vmem_seg_t	*vm_hash0[VMEM_HASH_INITIAL];	/* initial hash table */
138 	void		*vm_qcache[VMEM_NQCACHE_MAX];	/* quantum caches */
139 	vmem_freelist_t	vm_freelist[VMEM_FREELISTS + 1]; /* power-of-2 flists */
140 	vmem_kstat_t	vm_kstat;	/* kstat data */
141 };
142 
143 #ifdef	__cplusplus
144 }
145 #endif
146 
147 #endif	/* _SYS_VMEM_IMPL_H */
148