1fa9e4066Sahrens /*
2fa9e4066Sahrens  * CDDL HEADER START
3fa9e4066Sahrens  *
4fa9e4066Sahrens  * The contents of this file are subject to the terms of the
5ea8dc4b6Seschrock  * Common Development and Distribution License (the "License").
6ea8dc4b6Seschrock  * You may not use this file except in compliance with the License.
7fa9e4066Sahrens  *
8fa9e4066Sahrens  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9fa9e4066Sahrens  * or http://www.opensolaris.org/os/licensing.
10fa9e4066Sahrens  * See the License for the specific language governing permissions
11fa9e4066Sahrens  * and limitations under the License.
12fa9e4066Sahrens  *
13fa9e4066Sahrens  * When distributing Covered Code, include this CDDL HEADER in each
14fa9e4066Sahrens  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15fa9e4066Sahrens  * If applicable, add the following below this CDDL HEADER, with the
16fa9e4066Sahrens  * fields enclosed by brackets "[]" replaced with your own identifying
17fa9e4066Sahrens  * information: Portions Copyright [yyyy] [name of copyright owner]
18fa9e4066Sahrens  *
19fa9e4066Sahrens  * CDDL HEADER END
20fa9e4066Sahrens  */
21fa9e4066Sahrens /*
22744947dcSTom Erickson  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
235aeb9474SGarrett D'Amore  * Copyright 2011 Nexenta Systems, Inc.  All rights reserved.
24bf16b11eSMatthew Ahrens  * Copyright (c) 2012, 2014 by Delphix. All rights reserved.
254e3c9f44SBill Pijewski  * Copyright (c) 2012, Joyent, Inc. All rights reserved.
265aeb9474SGarrett D'Amore  */
27fa9e4066Sahrens 
28fa9e4066Sahrens #ifndef _SYS_ZFS_CONTEXT_H
29fa9e4066Sahrens #define	_SYS_ZFS_CONTEXT_H
30fa9e4066Sahrens 
31fa9e4066Sahrens #ifdef	__cplusplus
32fa9e4066Sahrens extern "C" {
33fa9e4066Sahrens #endif
34fa9e4066Sahrens 
35fa9e4066Sahrens #define	_SYS_MUTEX_H
36fa9e4066Sahrens #define	_SYS_RWLOCK_H
37fa9e4066Sahrens #define	_SYS_CONDVAR_H
38fa9e4066Sahrens #define	_SYS_SYSTM_H
39fa9e4066Sahrens #define	_SYS_T_LOCK_H
40fa9e4066Sahrens #define	_SYS_VNODE_H
41fa9e4066Sahrens #define	_SYS_VFS_H
42fa9e4066Sahrens #define	_SYS_SUNDDI_H
43fa9e4066Sahrens #define	_SYS_CALLB_H
44fa9e4066Sahrens 
45fa9e4066Sahrens #include <stdio.h>
46fa9e4066Sahrens #include <stdlib.h>
47fa9e4066Sahrens #include <stddef.h>
48fa9e4066Sahrens #include <stdarg.h>
49fa9e4066Sahrens #include <fcntl.h>
50fa9e4066Sahrens #include <unistd.h>
51fa9e4066Sahrens #include <errno.h>
52fa9e4066Sahrens #include <string.h>
53fa9e4066Sahrens #include <strings.h>
54fa9e4066Sahrens #include <synch.h>
55fa9e4066Sahrens #include <thread.h>
56fa9e4066Sahrens #include <assert.h>
57fa9e4066Sahrens #include <alloca.h>
58fa9e4066Sahrens #include <umem.h>
59fa9e4066Sahrens #include <limits.h>
60fa9e4066Sahrens #include <atomic.h>
61fa9e4066Sahrens #include <dirent.h>
62fa9e4066Sahrens #include <time.h>
63cd1c8b85SMatthew Ahrens #include <procfs.h>
643b2aab18SMatthew Ahrens #include <pthread.h>
653b2aab18SMatthew Ahrens #include <sys/debug.h>
66573ca77eSGeorge Wilson #include <libsysevent.h>
67fa9e4066Sahrens #include <sys/note.h>
68fa9e4066Sahrens #include <sys/types.h>
69ecd6cf80Smarks #include <sys/cred.h>
70fa9e4066Sahrens #include <sys/sysmacros.h>
71fa9e4066Sahrens #include <sys/bitmap.h>
72fa9e4066Sahrens #include <sys/resource.h>
73fa9e4066Sahrens #include <sys/byteorder.h>
74fa9e4066Sahrens #include <sys/list.h>
75fa9e4066Sahrens #include <sys/uio.h>
76fa9e4066Sahrens #include <sys/zfs_debug.h>
77fa9e4066Sahrens #include <sys/sdt.h>
7844cb6abcSbmc #include <sys/kstat.h>
79de8267e0Stimh #include <sys/u8_textprep.h>
803d7072f8Seschrock #include <sys/sysevent/eventdefs.h>
81573ca77eSGeorge Wilson #include <sys/sysevent/dev.h>
8292241e0bSTom Erickson #include <sys/sunddi.h>
83fb09f5aaSMadhav Suresh #include <sys/debug.h>
84be6fd75aSMatthew Ahrens #include "zfs.h"
85fa9e4066Sahrens 
86fa9e4066Sahrens /*
87fa9e4066Sahrens  * Debugging
88fa9e4066Sahrens  */
89fa9e4066Sahrens 
90fa9e4066Sahrens /*
91fa9e4066Sahrens  * Note that we are not using the debugging levels.
92fa9e4066Sahrens  */
93fa9e4066Sahrens 
94fa9e4066Sahrens #define	CE_CONT		0	/* continuation		*/
95fa9e4066Sahrens #define	CE_NOTE		1	/* notice		*/
96fa9e4066Sahrens #define	CE_WARN		2	/* warning		*/
97fa9e4066Sahrens #define	CE_PANIC	3	/* panic		*/
98fa9e4066Sahrens #define	CE_IGNORE	4	/* print nothing	*/
99fa9e4066Sahrens 
100fa9e4066Sahrens /*
101fa9e4066Sahrens  * ZFS debugging
102fa9e4066Sahrens  */
103fa9e4066Sahrens 
104fa9e4066Sahrens #ifdef ZFS_DEBUG
105fa9e4066Sahrens extern void dprintf_setup(int *argc, char **argv);
106fa9e4066Sahrens #endif /* ZFS_DEBUG */
107fa9e4066Sahrens 
108fa9e4066Sahrens extern void cmn_err(int, const char *, ...);
1090125049cSahrens extern void vcmn_err(int, const char *, __va_list);
110fa9e4066Sahrens extern void panic(const char *, ...);
111fa9e4066Sahrens extern void vpanic(const char *, __va_list);
112fa9e4066Sahrens 
1130a4e9518Sgw #define	fm_panic	panic
1140a4e9518Sgw 
115feef89cfSVictor Latushkin extern int aok;
116feef89cfSVictor Latushkin 
117fa9e4066Sahrens /*
1183d7072f8Seschrock  * DTrace SDT probes have different signatures in userland than they do in
119*a2cdcdd2SPaul Dagnelie  * the kernel.  If they're being used in kernel code, re-define them out of
120fa9e4066Sahrens  * existence for their counterparts in libzpool.
121*a2cdcdd2SPaul Dagnelie  *
122*a2cdcdd2SPaul Dagnelie  * Here's an example of how to use the set-error probes in userland:
123*a2cdcdd2SPaul Dagnelie  * zfs$target:::set-error /arg0 == EBUSY/ {stack();}
124*a2cdcdd2SPaul Dagnelie  *
125*a2cdcdd2SPaul Dagnelie  * Here's an example of how to use DTRACE_PROBE probes in userland:
126*a2cdcdd2SPaul Dagnelie  * If there is a probe declared as follows:
127*a2cdcdd2SPaul Dagnelie  * DTRACE_PROBE2(zfs__probe_name, uint64_t, blkid, dnode_t *, dn);
128*a2cdcdd2SPaul Dagnelie  * Then you can use it as follows:
129*a2cdcdd2SPaul Dagnelie  * zfs$target:::probe2 /copyinstr(arg0) == "zfs__probe_name"/
130*a2cdcdd2SPaul Dagnelie  *     {printf("%u %p\n", arg1, arg2);}
131fa9e4066Sahrens  */
132fa9e4066Sahrens 
13305715f94SMark Maybee #ifdef DTRACE_PROBE
13405715f94SMark Maybee #undef	DTRACE_PROBE
13505715f94SMark Maybee #endif	/* DTRACE_PROBE */
136be6fd75aSMatthew Ahrens #define	DTRACE_PROBE(a) \
137be6fd75aSMatthew Ahrens 	ZFS_PROBE0(#a)
13805715f94SMark Maybee 
139fa9e4066Sahrens #ifdef DTRACE_PROBE1
140fa9e4066Sahrens #undef	DTRACE_PROBE1
141fa9e4066Sahrens #endif	/* DTRACE_PROBE1 */
142be6fd75aSMatthew Ahrens #define	DTRACE_PROBE1(a, b, c) \
143be6fd75aSMatthew Ahrens 	ZFS_PROBE1(#a, (unsigned long)c)
144fa9e4066Sahrens 
145fa9e4066Sahrens #ifdef DTRACE_PROBE2
146fa9e4066Sahrens #undef	DTRACE_PROBE2
147fa9e4066Sahrens #endif	/* DTRACE_PROBE2 */
148be6fd75aSMatthew Ahrens #define	DTRACE_PROBE2(a, b, c, d, e) \
149be6fd75aSMatthew Ahrens 	ZFS_PROBE2(#a, (unsigned long)c, (unsigned long)e)
150fa9e4066Sahrens 
151c543ec06Sahrens #ifdef DTRACE_PROBE3
152c543ec06Sahrens #undef	DTRACE_PROBE3
153c543ec06Sahrens #endif	/* DTRACE_PROBE3 */
154be6fd75aSMatthew Ahrens #define	DTRACE_PROBE3(a, b, c, d, e, f, g) \
155be6fd75aSMatthew Ahrens 	ZFS_PROBE3(#a, (unsigned long)c, (unsigned long)e, (unsigned long)g)
156c543ec06Sahrens 
157faafa6e3Sahrens #ifdef DTRACE_PROBE4
158faafa6e3Sahrens #undef	DTRACE_PROBE4
159faafa6e3Sahrens #endif	/* DTRACE_PROBE4 */
160be6fd75aSMatthew Ahrens #define	DTRACE_PROBE4(a, b, c, d, e, f, g, h, i) \
161be6fd75aSMatthew Ahrens 	ZFS_PROBE4(#a, (unsigned long)c, (unsigned long)e, (unsigned long)g, \
162be6fd75aSMatthew Ahrens 	(unsigned long)i)
163be6fd75aSMatthew Ahrens 
164be6fd75aSMatthew Ahrens /*
165be6fd75aSMatthew Ahrens  * We use the comma operator so that this macro can be used without much
166be6fd75aSMatthew Ahrens  * additional code.  For example, "return (EINVAL);" becomes
167be6fd75aSMatthew Ahrens  * "return (SET_ERROR(EINVAL));".  Note that the argument will be evaluated
168be6fd75aSMatthew Ahrens  * twice, so it should not have side effects (e.g. something like:
169be6fd75aSMatthew Ahrens  * "return (SET_ERROR(log_error(EINVAL, info)));" would log the error twice).
170be6fd75aSMatthew Ahrens  */
171be6fd75aSMatthew Ahrens #define	SET_ERROR(err) (ZFS_SET_ERROR(err), err)
172faafa6e3Sahrens 
173fa9e4066Sahrens /*
174fa9e4066Sahrens  * Threads
175fa9e4066Sahrens  */
176fa9e4066Sahrens #define	curthread	((void *)(uintptr_t)thr_self())
177fa9e4066Sahrens 
17869962b56SMatthew Ahrens #define	kpreempt(x)	yield()
17969962b56SMatthew Ahrens 
180fa9e4066Sahrens typedef struct kthread kthread_t;
181fa9e4066Sahrens 
182fa9e4066Sahrens #define	thread_create(stk, stksize, func, arg, len, pp, state, pri)	\
183fa9e4066Sahrens 	zk_thread_create(func, arg)
1845ad82045Snd #define	thread_exit() thr_exit(NULL)
18535a5a358SJonathan Adams #define	thread_join(t)	panic("libzpool cannot join threads")
18635a5a358SJonathan Adams 
18735a5a358SJonathan Adams #define	newproc(f, a, cid, pri, ctp, pid)	(ENOSYS)
18835a5a358SJonathan Adams 
18935a5a358SJonathan Adams /* in libzpool, p0 exists only to have its address taken */
19035a5a358SJonathan Adams struct proc {
19135a5a358SJonathan Adams 	uintptr_t	this_is_never_used_dont_dereference_it;
19235a5a358SJonathan Adams };
19335a5a358SJonathan Adams 
19435a5a358SJonathan Adams extern struct proc p0;
1954e3c9f44SBill Pijewski #define	curproc		(&p0)
19635a5a358SJonathan Adams 
19735a5a358SJonathan Adams #define	PS_NONE		-1
198fa9e4066Sahrens 
199fa9e4066Sahrens extern kthread_t *zk_thread_create(void (*func)(), void *arg);
200fa9e4066Sahrens 
201fa9e4066Sahrens #define	issig(why)	(FALSE)
202fa9e4066Sahrens #define	ISSIG(thr, why)	(FALSE)
203fa9e4066Sahrens 
204fa9e4066Sahrens /*
205fa9e4066Sahrens  * Mutexes
206fa9e4066Sahrens  */
207fa9e4066Sahrens typedef struct kmutex {
208c25056deSgw 	void		*m_owner;
209c25056deSgw 	boolean_t	initialized;
210c25056deSgw 	mutex_t		m_lock;
211fa9e4066Sahrens } kmutex_t;
212fa9e4066Sahrens 
213fa9e4066Sahrens #define	MUTEX_DEFAULT	USYNC_THREAD
214744947dcSTom Erickson #undef	MUTEX_HELD
215744947dcSTom Erickson #undef	MUTEX_NOT_HELD
216fa9e4066Sahrens #define	MUTEX_HELD(m) _mutex_held(&(m)->m_lock)
217744947dcSTom Erickson #define	MUTEX_NOT_HELD(m) (!MUTEX_HELD(m))
218fa9e4066Sahrens 
219fa9e4066Sahrens /*
220fa9e4066Sahrens  * Argh -- we have to get cheesy here because the kernel and userland
221fa9e4066Sahrens  * have different signatures for the same routine.
222fa9e4066Sahrens  */
223fa9e4066Sahrens extern int _mutex_init(mutex_t *mp, int type, void *arg);
224fa9e4066Sahrens extern int _mutex_destroy(mutex_t *mp);
225fa9e4066Sahrens 
226fa9e4066Sahrens #define	mutex_init(mp, b, c, d)		zmutex_init((kmutex_t *)(mp))
227fa9e4066Sahrens #define	mutex_destroy(mp)		zmutex_destroy((kmutex_t *)(mp))
228fa9e4066Sahrens 
229fa9e4066Sahrens extern void zmutex_init(kmutex_t *mp);
230fa9e4066Sahrens extern void zmutex_destroy(kmutex_t *mp);
231fa9e4066Sahrens extern void mutex_enter(kmutex_t *mp);
232fa9e4066Sahrens extern void mutex_exit(kmutex_t *mp);
233fa9e4066Sahrens extern int mutex_tryenter(kmutex_t *mp);
234fa9e4066Sahrens extern void *mutex_owner(kmutex_t *mp);
235fa9e4066Sahrens 
236fa9e4066Sahrens /*
237fa9e4066Sahrens  * RW locks
238fa9e4066Sahrens  */
239fa9e4066Sahrens typedef struct krwlock {
240fa9e4066Sahrens 	void		*rw_owner;
241c25056deSgw 	boolean_t	initialized;
242fa9e4066Sahrens 	rwlock_t	rw_lock;
243fa9e4066Sahrens } krwlock_t;
244fa9e4066Sahrens 
245fa9e4066Sahrens typedef int krw_t;
246fa9e4066Sahrens 
247fa9e4066Sahrens #define	RW_READER	0
248fa9e4066Sahrens #define	RW_WRITER	1
249fa9e4066Sahrens #define	RW_DEFAULT	USYNC_THREAD
250fa9e4066Sahrens 
251fa9e4066Sahrens #undef RW_READ_HELD
252fa9e4066Sahrens #define	RW_READ_HELD(x)		_rw_read_held(&(x)->rw_lock)
253fa9e4066Sahrens 
254fa9e4066Sahrens #undef RW_WRITE_HELD
255fa9e4066Sahrens #define	RW_WRITE_HELD(x)	_rw_write_held(&(x)->rw_lock)
256fa9e4066Sahrens 
2573b2aab18SMatthew Ahrens #undef RW_LOCK_HELD
2583b2aab18SMatthew Ahrens #define	RW_LOCK_HELD(x)		(RW_READ_HELD(x) || RW_WRITE_HELD(x))
2593b2aab18SMatthew Ahrens 
260fa9e4066Sahrens extern void rw_init(krwlock_t *rwlp, char *name, int type, void *arg);
261fa9e4066Sahrens extern void rw_destroy(krwlock_t *rwlp);
262fa9e4066Sahrens extern void rw_enter(krwlock_t *rwlp, krw_t rw);
263fa9e4066Sahrens extern int rw_tryenter(krwlock_t *rwlp, krw_t rw);
264fa9e4066Sahrens extern int rw_tryupgrade(krwlock_t *rwlp);
265fa9e4066Sahrens extern void rw_exit(krwlock_t *rwlp);
266fa9e4066Sahrens #define	rw_downgrade(rwlp) do { } while (0)
267fa9e4066Sahrens 
268ecd6cf80Smarks extern uid_t crgetuid(cred_t *cr);
2694445fffbSMatthew Ahrens extern uid_t crgetruid(cred_t *cr);
270ecd6cf80Smarks extern gid_t crgetgid(cred_t *cr);
271ecd6cf80Smarks extern int crgetngroups(cred_t *cr);
272ecd6cf80Smarks extern gid_t *crgetgroups(cred_t *cr);
273ecd6cf80Smarks 
274fa9e4066Sahrens /*
275fa9e4066Sahrens  * Condition variables
276fa9e4066Sahrens  */
277fa9e4066Sahrens typedef cond_t kcondvar_t;
278fa9e4066Sahrens 
279fa9e4066Sahrens #define	CV_DEFAULT	USYNC_THREAD
280fa9e4066Sahrens 
281fa9e4066Sahrens extern void cv_init(kcondvar_t *cv, char *name, int type, void *arg);
282fa9e4066Sahrens extern void cv_destroy(kcondvar_t *cv);
283fa9e4066Sahrens extern void cv_wait(kcondvar_t *cv, kmutex_t *mp);
284fa9e4066Sahrens extern clock_t cv_timedwait(kcondvar_t *cv, kmutex_t *mp, clock_t abstime);
2850689f76cSAdam Leventhal extern clock_t cv_timedwait_hires(kcondvar_t *cvp, kmutex_t *mp, hrtime_t tim,
2860689f76cSAdam Leventhal     hrtime_t res, int flag);
287fa9e4066Sahrens extern void cv_signal(kcondvar_t *cv);
288fa9e4066Sahrens extern void cv_broadcast(kcondvar_t *cv);
289fa9e4066Sahrens 
2903b2aab18SMatthew Ahrens /*
2913b2aab18SMatthew Ahrens  * Thread-specific data
2923b2aab18SMatthew Ahrens  */
2933b2aab18SMatthew Ahrens #define	tsd_get(k) pthread_getspecific(k)
2943b2aab18SMatthew Ahrens #define	tsd_set(k, v) pthread_setspecific(k, v)
2953b2aab18SMatthew Ahrens #define	tsd_create(kp, d) pthread_key_create(kp, d)
2963b2aab18SMatthew Ahrens #define	tsd_destroy(kp) /* nothing */
2973b2aab18SMatthew Ahrens 
29844cb6abcSbmc /*
29944cb6abcSbmc  * kstat creation, installation and deletion
30044cb6abcSbmc  */
301c3a66015SMatthew Ahrens extern kstat_t *kstat_create(const char *, int,
302c3a66015SMatthew Ahrens     const char *, const char *, uchar_t, ulong_t, uchar_t);
30344cb6abcSbmc extern void kstat_install(kstat_t *);
30444cb6abcSbmc extern void kstat_delete(kstat_t *);
305c3a66015SMatthew Ahrens extern void kstat_waitq_enter(kstat_io_t *);
306c3a66015SMatthew Ahrens extern void kstat_waitq_exit(kstat_io_t *);
307c3a66015SMatthew Ahrens extern void kstat_runq_enter(kstat_io_t *);
308c3a66015SMatthew Ahrens extern void kstat_runq_exit(kstat_io_t *);
309c3a66015SMatthew Ahrens extern void kstat_waitq_to_runq(kstat_io_t *);
310c3a66015SMatthew Ahrens extern void kstat_runq_back_to_waitq(kstat_io_t *);
31144cb6abcSbmc 
312fa9e4066Sahrens /*
313fa9e4066Sahrens  * Kernel memory
314fa9e4066Sahrens  */
315fa9e4066Sahrens #define	KM_SLEEP		UMEM_NOFAIL
3161ab7f2deSmaybee #define	KM_PUSHPAGE		KM_SLEEP
317fa9e4066Sahrens #define	KM_NOSLEEP		UMEM_DEFAULT
318a0965f35Sbonwick #define	KMC_NODEBUG		UMC_NODEBUG
319e291592aSJonathan Adams #define	KMC_NOTOUCH		0	/* not needed for userland caches */
320fa9e4066Sahrens #define	kmem_alloc(_s, _f)	umem_alloc(_s, _f)
321fa9e4066Sahrens #define	kmem_zalloc(_s, _f)	umem_zalloc(_s, _f)
322fa9e4066Sahrens #define	kmem_free(_b, _s)	umem_free(_b, _s)
323fa9e4066Sahrens #define	kmem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i) \
324fa9e4066Sahrens 	umem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i)
325fa9e4066Sahrens #define	kmem_cache_destroy(_c)	umem_cache_destroy(_c)
326fa9e4066Sahrens #define	kmem_cache_alloc(_c, _f) umem_cache_alloc(_c, _f)
327fa9e4066Sahrens #define	kmem_cache_free(_c, _b)	umem_cache_free(_c, _b)
328fa9e4066Sahrens #define	kmem_debugging()	0
329744947dcSTom Erickson #define	kmem_cache_reap_now(_c)		/* nothing */
330744947dcSTom Erickson #define	kmem_cache_set_move(_c, _cb)	/* nothing */
33194dd93aeSGeorge Wilson #define	vmem_qcache_reap(_v)		/* nothing */
332744947dcSTom Erickson #define	POINTER_INVALIDATE(_pp)		/* nothing */
333744947dcSTom Erickson #define	POINTER_IS_VALID(_p)	0
334fa9e4066Sahrens 
33594dd93aeSGeorge Wilson extern vmem_t *zio_arena;
33694dd93aeSGeorge Wilson 
337fa9e4066Sahrens typedef umem_cache_t kmem_cache_t;
338fa9e4066Sahrens 
339744947dcSTom Erickson typedef enum kmem_cbrc {
340744947dcSTom Erickson 	KMEM_CBRC_YES,
341744947dcSTom Erickson 	KMEM_CBRC_NO,
342744947dcSTom Erickson 	KMEM_CBRC_LATER,
343744947dcSTom Erickson 	KMEM_CBRC_DONT_NEED,
344744947dcSTom Erickson 	KMEM_CBRC_DONT_KNOW
345744947dcSTom Erickson } kmem_cbrc_t;
346744947dcSTom Erickson 
347fa9e4066Sahrens /*
348fa9e4066Sahrens  * Task queues
349fa9e4066Sahrens  */
350fa9e4066Sahrens typedef struct taskq taskq_t;
351fa9e4066Sahrens typedef uintptr_t taskqid_t;
352fa9e4066Sahrens typedef void (task_func_t)(void *);
353fa9e4066Sahrens 
3545aeb9474SGarrett D'Amore typedef struct taskq_ent {
3555aeb9474SGarrett D'Amore 	struct taskq_ent	*tqent_next;
3565aeb9474SGarrett D'Amore 	struct taskq_ent	*tqent_prev;
3575aeb9474SGarrett D'Amore 	task_func_t		*tqent_func;
3585aeb9474SGarrett D'Amore 	void			*tqent_arg;
3595aeb9474SGarrett D'Amore 	uintptr_t		tqent_flags;
3605aeb9474SGarrett D'Amore } taskq_ent_t;
3615aeb9474SGarrett D'Amore 
3625aeb9474SGarrett D'Amore #define	TQENT_FLAG_PREALLOC	0x1	/* taskq_dispatch_ent used */
3635aeb9474SGarrett D'Amore 
364fa9e4066Sahrens #define	TASKQ_PREPOPULATE	0x0001
365fa9e4066Sahrens #define	TASKQ_CPR_SAFE		0x0002	/* Use CPR safe protocol */
366fa9e4066Sahrens #define	TASKQ_DYNAMIC		0x0004	/* Use dynamic thread scheduling */
36735a5a358SJonathan Adams #define	TASKQ_THREADS_CPU_PCT	0x0008	/* Scale # threads by # cpus */
36835a5a358SJonathan Adams #define	TASKQ_DC_BATCH		0x0010	/* Mark threads as batch */
369fa9e4066Sahrens 
370fa9e4066Sahrens #define	TQ_SLEEP	KM_SLEEP	/* Can block for memory */
371fa9e4066Sahrens #define	TQ_NOSLEEP	KM_NOSLEEP	/* cannot block for memory; may fail */
37235a5a358SJonathan Adams #define	TQ_NOQUEUE	0x02		/* Do not enqueue if can't dispatch */
37335a5a358SJonathan Adams #define	TQ_FRONT	0x08		/* Queue in front */
374fa9e4066Sahrens 
3755aeb9474SGarrett D'Amore 
37688b7b0f2SMatthew Ahrens extern taskq_t *system_taskq;
37788b7b0f2SMatthew Ahrens 
378fa9e4066Sahrens extern taskq_t	*taskq_create(const char *, int, pri_t, int, int, uint_t);
37935a5a358SJonathan Adams #define	taskq_create_proc(a, b, c, d, e, p, f) \
38035a5a358SJonathan Adams 	    (taskq_create(a, b, c, d, e, f))
38135a5a358SJonathan Adams #define	taskq_create_sysdc(a, b, d, e, p, dc, f) \
38235a5a358SJonathan Adams 	    (taskq_create(a, b, maxclsyspri, d, e, f))
383fa9e4066Sahrens extern taskqid_t taskq_dispatch(taskq_t *, task_func_t, void *, uint_t);
3845aeb9474SGarrett D'Amore extern void	taskq_dispatch_ent(taskq_t *, task_func_t, void *, uint_t,
3855aeb9474SGarrett D'Amore     taskq_ent_t *);
386fa9e4066Sahrens extern void	taskq_destroy(taskq_t *);
387fa9e4066Sahrens extern void	taskq_wait(taskq_t *);
388fa9e4066Sahrens extern int	taskq_member(taskq_t *, void *);
38988b7b0f2SMatthew Ahrens extern void	system_taskq_init(void);
390d20e665cSRicardo M. Correia extern void	system_taskq_fini(void);
391fa9e4066Sahrens 
392da6c28aaSamw #define	XVA_MAPSIZE	3
393da6c28aaSamw #define	XVA_MAGIC	0x78766174
394da6c28aaSamw 
395fa9e4066Sahrens /*
396fa9e4066Sahrens  * vnodes
397fa9e4066Sahrens  */
398fa9e4066Sahrens typedef struct vnode {
399fa9e4066Sahrens 	uint64_t	v_size;
400fa9e4066Sahrens 	int		v_fd;
401fa9e4066Sahrens 	char		*v_path;
402df15e419SMatthew Ahrens 	int		v_dump_fd;
403fa9e4066Sahrens } vnode_t;
404fa9e4066Sahrens 
405df15e419SMatthew Ahrens extern char *vn_dumpdir;
4067a286c47SDai Ngo #define	AV_SCANSTAMP_SZ	32		/* length of anti-virus scanstamp */
407da6c28aaSamw 
408da6c28aaSamw typedef struct xoptattr {
409da6c28aaSamw 	timestruc_t	xoa_createtime;	/* Create time of file */
410da6c28aaSamw 	uint8_t		xoa_archive;
411da6c28aaSamw 	uint8_t		xoa_system;
412da6c28aaSamw 	uint8_t		xoa_readonly;
413da6c28aaSamw 	uint8_t		xoa_hidden;
414da6c28aaSamw 	uint8_t		xoa_nounlink;
415da6c28aaSamw 	uint8_t		xoa_immutable;
416da6c28aaSamw 	uint8_t		xoa_appendonly;
417da6c28aaSamw 	uint8_t		xoa_nodump;
418da6c28aaSamw 	uint8_t		xoa_settable;
419da6c28aaSamw 	uint8_t		xoa_opaque;
420da6c28aaSamw 	uint8_t		xoa_av_quarantined;
421da6c28aaSamw 	uint8_t		xoa_av_modified;
4227a286c47SDai Ngo 	uint8_t		xoa_av_scanstamp[AV_SCANSTAMP_SZ];
4237a286c47SDai Ngo 	uint8_t		xoa_reparse;
424fd9ee8b5Sjoyce mcintosh 	uint8_t		xoa_offline;
425fd9ee8b5Sjoyce mcintosh 	uint8_t		xoa_sparse;
426da6c28aaSamw } xoptattr_t;
427da6c28aaSamw 
428fa9e4066Sahrens typedef struct vattr {
429fa9e4066Sahrens 	uint_t		va_mask;	/* bit-mask of attributes */
430fa9e4066Sahrens 	u_offset_t	va_size;	/* file size in bytes */
431fa9e4066Sahrens } vattr_t;
432fa9e4066Sahrens 
433da6c28aaSamw 
434da6c28aaSamw typedef struct xvattr {
435da6c28aaSamw 	vattr_t		xva_vattr;	/* Embedded vattr structure */
436da6c28aaSamw 	uint32_t	xva_magic;	/* Magic Number */
437da6c28aaSamw 	uint32_t	xva_mapsize;	/* Size of attr bitmap (32-bit words) */
438da6c28aaSamw 	uint32_t	*xva_rtnattrmapp;	/* Ptr to xva_rtnattrmap[] */
439da6c28aaSamw 	uint32_t	xva_reqattrmap[XVA_MAPSIZE];	/* Requested attrs */
440da6c28aaSamw 	uint32_t	xva_rtnattrmap[XVA_MAPSIZE];	/* Returned attrs */
441da6c28aaSamw 	xoptattr_t	xva_xoptattrs;	/* Optional attributes */
442da6c28aaSamw } xvattr_t;
443da6c28aaSamw 
444da6c28aaSamw typedef struct vsecattr {
445da6c28aaSamw 	uint_t		vsa_mask;	/* See below */
446da6c28aaSamw 	int		vsa_aclcnt;	/* ACL entry count */
447da6c28aaSamw 	void		*vsa_aclentp;	/* pointer to ACL entries */
448da6c28aaSamw 	int		vsa_dfaclcnt;	/* default ACL entry count */
449da6c28aaSamw 	void		*vsa_dfaclentp;	/* pointer to default ACL entries */
450da6c28aaSamw 	size_t		vsa_aclentsz;	/* ACE size in bytes of vsa_aclentp */
451da6c28aaSamw } vsecattr_t;
452da6c28aaSamw 
453da6c28aaSamw #define	AT_TYPE		0x00001
454da6c28aaSamw #define	AT_MODE		0x00002
455da6c28aaSamw #define	AT_UID		0x00004
456da6c28aaSamw #define	AT_GID		0x00008
457da6c28aaSamw #define	AT_FSID		0x00010
458da6c28aaSamw #define	AT_NODEID	0x00020
459da6c28aaSamw #define	AT_NLINK	0x00040
460da6c28aaSamw #define	AT_SIZE		0x00080
461da6c28aaSamw #define	AT_ATIME	0x00100
462da6c28aaSamw #define	AT_MTIME	0x00200
463da6c28aaSamw #define	AT_CTIME	0x00400
464da6c28aaSamw #define	AT_RDEV		0x00800
465da6c28aaSamw #define	AT_BLKSIZE	0x01000
466da6c28aaSamw #define	AT_NBLOCKS	0x02000
467da6c28aaSamw #define	AT_SEQ		0x08000
468da6c28aaSamw #define	AT_XVATTR	0x10000
469fa9e4066Sahrens 
470fa9e4066Sahrens #define	CRCREAT		0
471fa9e4066Sahrens 
472095bcd66SGeorge Wilson extern int fop_getattr(vnode_t *vp, vattr_t *vap);
473095bcd66SGeorge Wilson 
474da6c28aaSamw #define	VOP_CLOSE(vp, f, c, o, cr, ct)	0
475da6c28aaSamw #define	VOP_PUTPAGE(vp, of, sz, fl, cr, ct)	0
476095bcd66SGeorge Wilson #define	VOP_GETATTR(vp, vap, fl, cr, ct)  fop_getattr((vp), (vap));
477fa9e4066Sahrens 
478da6c28aaSamw #define	VOP_FSYNC(vp, f, cr, ct)	fsync((vp)->v_fd)
479fa9e4066Sahrens 
480fa9e4066Sahrens #define	VN_RELE(vp)	vn_close(vp)
481fa9e4066Sahrens 
482fa9e4066Sahrens extern int vn_open(char *path, int x1, int oflags, int mode, vnode_t **vpp,
483fa9e4066Sahrens     int x2, int x3);
484fa9e4066Sahrens extern int vn_openat(char *path, int x1, int oflags, int mode, vnode_t **vpp,
485da6c28aaSamw     int x2, int x3, vnode_t *vp, int fd);
486fa9e4066Sahrens extern int vn_rdwr(int uio, vnode_t *vp, void *addr, ssize_t len,
487fa9e4066Sahrens     offset_t offset, int x1, int x2, rlim64_t x3, void *x4, ssize_t *residp);
488fa9e4066Sahrens extern void vn_close(vnode_t *vp);
489fa9e4066Sahrens 
490fa9e4066Sahrens #define	vn_remove(path, x1, x2)		remove(path)
491fa9e4066Sahrens #define	vn_rename(from, to, seg)	rename((from), (to))
4920373e76bSbonwick #define	vn_is_readonly(vp)		B_FALSE
493fa9e4066Sahrens 
494fa9e4066Sahrens extern vnode_t *rootdir;
495fa9e4066Sahrens 
496fa9e4066Sahrens #include <sys/file.h>		/* for FREAD, FWRITE, etc */
497fa9e4066Sahrens 
498fa9e4066Sahrens /*
499fa9e4066Sahrens  * Random stuff
500fa9e4066Sahrens  */
501d3d50737SRafael Vanoni #define	ddi_get_lbolt()		(gethrtime() >> 23)
502d3d50737SRafael Vanoni #define	ddi_get_lbolt64()	(gethrtime() >> 23)
503fa9e4066Sahrens #define	hz	119	/* frequency when using gethrtime() >> 23 for lbolt */
504fa9e4066Sahrens 
505fa9e4066Sahrens extern void delay(clock_t ticks);
506fa9e4066Sahrens 
507283b8460SGeorge.Wilson #define	SEC_TO_TICK(sec)	((sec) * hz)
508283b8460SGeorge.Wilson #define	NSEC_TO_TICK(usec)	((usec) / (NANOSEC / hz))
509283b8460SGeorge.Wilson 
510fa9e4066Sahrens #define	gethrestime_sec() time(NULL)
51171eb0538SChris Kirby #define	gethrestime(t) \
51271eb0538SChris Kirby 	do {\
51371eb0538SChris Kirby 		(t)->tv_sec = gethrestime_sec();\
51471eb0538SChris Kirby 		(t)->tv_nsec = 0;\
51571eb0538SChris Kirby 	} while (0);
516fa9e4066Sahrens 
517fa9e4066Sahrens #define	max_ncpus	64
518244781f1SPrakash Surya #define	boot_ncpus	(sysconf(_SC_NPROCESSORS_ONLN))
519fa9e4066Sahrens 
520fa9e4066Sahrens #define	minclsyspri	60
521fa9e4066Sahrens #define	maxclsyspri	99
522fa9e4066Sahrens 
523fa9e4066Sahrens #define	CPU_SEQID	(thr_self() & (max_ncpus - 1))
524fa9e4066Sahrens 
525fa9e4066Sahrens #define	kcred		NULL
526fa9e4066Sahrens #define	CRED()		NULL
527fa9e4066Sahrens 
52805715f94SMark Maybee #define	ptob(x)		((x) * PAGESIZE)
52905715f94SMark Maybee 
530fa9e4066Sahrens extern uint64_t physmem;
531fa9e4066Sahrens 
532bf16b11eSMatthew Ahrens extern int highbit64(uint64_t i);
533fa9e4066Sahrens extern int random_get_bytes(uint8_t *ptr, size_t len);
534fa9e4066Sahrens extern int random_get_pseudo_bytes(uint8_t *ptr, size_t len);
535fa9e4066Sahrens 
536fa9e4066Sahrens extern void kernel_init(int);
537fa9e4066Sahrens extern void kernel_fini(void);
538fa9e4066Sahrens 
539fa9e4066Sahrens struct spa;
540fa9e4066Sahrens extern void nicenum(uint64_t num, char *buf);
541fa9e4066Sahrens extern void show_pool_stats(struct spa *);
542fa9e4066Sahrens 
543fa9e4066Sahrens typedef struct callb_cpr {
544fa9e4066Sahrens 	kmutex_t	*cc_lockp;
545fa9e4066Sahrens } callb_cpr_t;
546fa9e4066Sahrens 
547fa9e4066Sahrens #define	CALLB_CPR_INIT(cp, lockp, func, name)	{		\
548fa9e4066Sahrens 	(cp)->cc_lockp = lockp;					\
549fa9e4066Sahrens }
550fa9e4066Sahrens 
551fa9e4066Sahrens #define	CALLB_CPR_SAFE_BEGIN(cp) {				\
552fa9e4066Sahrens 	ASSERT(MUTEX_HELD((cp)->cc_lockp));			\
553fa9e4066Sahrens }
554fa9e4066Sahrens 
555fa9e4066Sahrens #define	CALLB_CPR_SAFE_END(cp, lockp) {				\
556fa9e4066Sahrens 	ASSERT(MUTEX_HELD((cp)->cc_lockp));			\
557fa9e4066Sahrens }
558fa9e4066Sahrens 
559fa9e4066Sahrens #define	CALLB_CPR_EXIT(cp) {					\
560fa9e4066Sahrens 	ASSERT(MUTEX_HELD((cp)->cc_lockp));			\
561fa9e4066Sahrens 	mutex_exit((cp)->cc_lockp);				\
562fa9e4066Sahrens }
563fa9e4066Sahrens 
564fa9e4066Sahrens #define	zone_dataset_visible(x, y)	(1)
565fa9e4066Sahrens #define	INGLOBALZONE(z)			(1)
566fa9e4066Sahrens 
567ae46e4c7SMatthew Ahrens extern char *kmem_asprintf(const char *fmt, ...);
5683b2aab18SMatthew Ahrens #define	strfree(str) kmem_free((str), strlen(str) + 1)
569ae46e4c7SMatthew Ahrens 
57095173954Sek /*
57195173954Sek  * Hostname information
57295173954Sek  */
5735679c89fSjv extern char hw_serial[];	/* for userland-emulated hostid access */
57495173954Sek extern int ddi_strtoul(const char *str, char **nptr, int base,
57595173954Sek     unsigned long *result);
57695173954Sek 
5770a586ceaSMark Shellenbaum extern int ddi_strtoull(const char *str, char **nptr, int base,
5780a586ceaSMark Shellenbaum     u_longlong_t *result);
5790a586ceaSMark Shellenbaum 
580ea8dc4b6Seschrock /* ZFS Boot Related stuff. */
581ea8dc4b6Seschrock 
582ea8dc4b6Seschrock struct _buf {
583ea8dc4b6Seschrock 	intptr_t	_fd;
584ea8dc4b6Seschrock };
585ea8dc4b6Seschrock 
586ea8dc4b6Seschrock struct bootstat {
587ea8dc4b6Seschrock 	uint64_t st_size;
588ea8dc4b6Seschrock };
589ea8dc4b6Seschrock 
590da6c28aaSamw typedef struct ace_object {
591da6c28aaSamw 	uid_t		a_who;
592da6c28aaSamw 	uint32_t	a_access_mask;
593da6c28aaSamw 	uint16_t	a_flags;
594da6c28aaSamw 	uint16_t	a_type;
595da6c28aaSamw 	uint8_t		a_obj_type[16];
596da6c28aaSamw 	uint8_t		a_inherit_obj_type[16];
597da6c28aaSamw } ace_object_t;
598da6c28aaSamw 
599da6c28aaSamw 
600da6c28aaSamw #define	ACE_ACCESS_ALLOWED_OBJECT_ACE_TYPE	0x05
601da6c28aaSamw #define	ACE_ACCESS_DENIED_OBJECT_ACE_TYPE	0x06
602da6c28aaSamw #define	ACE_SYSTEM_AUDIT_OBJECT_ACE_TYPE	0x07
603da6c28aaSamw #define	ACE_SYSTEM_ALARM_OBJECT_ACE_TYPE	0x08
604da6c28aaSamw 
605ea8dc4b6Seschrock extern struct _buf *kobj_open_file(char *name);
606ea8dc4b6Seschrock extern int kobj_read_file(struct _buf *file, char *buf, unsigned size,
607ea8dc4b6Seschrock     unsigned off);
608ea8dc4b6Seschrock extern void kobj_close_file(struct _buf *file);
609b1b8ab34Slling extern int kobj_get_filesize(struct _buf *file, uint64_t *size);
610ecd6cf80Smarks extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
611ecd6cf80Smarks extern int zfs_secpolicy_rename_perms(const char *from, const char *to,
612ecd6cf80Smarks     cred_t *cr);
613ecd6cf80Smarks extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
614ecd6cf80Smarks extern zoneid_t getzoneid(void);
615ea8dc4b6Seschrock 
616e0d35c44Smarks /* SID stuff */
617e0d35c44Smarks typedef struct ksiddomain {
618e0d35c44Smarks 	uint_t	kd_ref;
619e0d35c44Smarks 	uint_t	kd_len;
620e0d35c44Smarks 	char	*kd_name;
621e0d35c44Smarks } ksiddomain_t;
622e0d35c44Smarks 
623e0d35c44Smarks ksiddomain_t *ksid_lookupdomain(const char *);
624e0d35c44Smarks void ksiddomain_rele(ksiddomain_t *);
625e0d35c44Smarks 
626573ca77eSGeorge Wilson #define	DDI_SLEEP	KM_SLEEP
627573ca77eSGeorge Wilson #define	ddi_log_sysevent(_a, _b, _c, _d, _e, _f, _g) \
628573ca77eSGeorge Wilson 	sysevent_post_event(_c, _d, _b, "libzpool", _e, _f)
629573ca77eSGeorge Wilson 
630283b8460SGeorge.Wilson /*
631283b8460SGeorge.Wilson  * Cyclic information
632283b8460SGeorge.Wilson  */
633283b8460SGeorge.Wilson extern kmutex_t cpu_lock;
634283b8460SGeorge.Wilson 
635283b8460SGeorge.Wilson typedef uintptr_t cyclic_id_t;
636283b8460SGeorge.Wilson typedef uint16_t cyc_level_t;
637283b8460SGeorge.Wilson typedef void (*cyc_func_t)(void *);
638283b8460SGeorge.Wilson 
639283b8460SGeorge.Wilson #define	CY_LOW_LEVEL	0
640283b8460SGeorge.Wilson #define	CY_INFINITY	INT64_MAX
641283b8460SGeorge.Wilson #define	CYCLIC_NONE	((cyclic_id_t)0)
642283b8460SGeorge.Wilson 
643283b8460SGeorge.Wilson typedef struct cyc_time {
644283b8460SGeorge.Wilson 	hrtime_t cyt_when;
645283b8460SGeorge.Wilson 	hrtime_t cyt_interval;
646283b8460SGeorge.Wilson } cyc_time_t;
647283b8460SGeorge.Wilson 
648283b8460SGeorge.Wilson typedef struct cyc_handler {
649283b8460SGeorge.Wilson 	cyc_func_t cyh_func;
650283b8460SGeorge.Wilson 	void *cyh_arg;
651283b8460SGeorge.Wilson 	cyc_level_t cyh_level;
652283b8460SGeorge.Wilson } cyc_handler_t;
653283b8460SGeorge.Wilson 
654283b8460SGeorge.Wilson extern cyclic_id_t cyclic_add(cyc_handler_t *, cyc_time_t *);
655283b8460SGeorge.Wilson extern void cyclic_remove(cyclic_id_t);
656283b8460SGeorge.Wilson extern int cyclic_reprogram(cyclic_id_t, hrtime_t);
657283b8460SGeorge.Wilson 
65831d7e8faSGeorge Wilson /*
65931d7e8faSGeorge Wilson  * Buf structure
66031d7e8faSGeorge Wilson  */
66131d7e8faSGeorge Wilson #define	B_BUSY		0x0001
66231d7e8faSGeorge Wilson #define	B_DONE		0x0002
66331d7e8faSGeorge Wilson #define	B_ERROR		0x0004
66431d7e8faSGeorge Wilson #define	B_READ		0x0040	/* read when I/O occurs */
66531d7e8faSGeorge Wilson #define	B_WRITE		0x0100	/* non-read pseudo-flag */
66631d7e8faSGeorge Wilson 
66731d7e8faSGeorge Wilson typedef struct buf {
66831d7e8faSGeorge Wilson 	int	b_flags;
66931d7e8faSGeorge Wilson 	size_t b_bcount;
67031d7e8faSGeorge Wilson 	union {
67131d7e8faSGeorge Wilson 		caddr_t b_addr;
67231d7e8faSGeorge Wilson 	} b_un;
67331d7e8faSGeorge Wilson 
67431d7e8faSGeorge Wilson 	lldaddr_t	_b_blkno;
67531d7e8faSGeorge Wilson #define	b_lblkno	_b_blkno._f
67631d7e8faSGeorge Wilson 	size_t	b_resid;
67731d7e8faSGeorge Wilson 	size_t	b_bufsize;
67831d7e8faSGeorge Wilson 	int	(*b_iodone)(struct buf *);
67931d7e8faSGeorge Wilson 	int	b_error;
68031d7e8faSGeorge Wilson 	void	*b_private;
68131d7e8faSGeorge Wilson } buf_t;
68231d7e8faSGeorge Wilson 
68331d7e8faSGeorge Wilson extern void bioinit(buf_t *);
68431d7e8faSGeorge Wilson extern void biodone(buf_t *);
68531d7e8faSGeorge Wilson extern void bioerror(buf_t *, int);
68631d7e8faSGeorge Wilson extern int geterror(buf_t *);
68731d7e8faSGeorge Wilson 
688f0547164Slling #ifdef	__cplusplus
689f0547164Slling }
690f0547164Slling #endif
691f0547164Slling 
692fa9e4066Sahrens #endif	/* _SYS_ZFS_CONTEXT_H */
693