xref: /freebsd/sys/contrib/openzfs/include/sys/zfs_context.h (revision fd141584cf89d7d24543ef5be83c6927a5d67ffa)
1 // SPDX-License-Identifier: CDDL-1.0
2 /*
3  * CDDL HEADER START
4  *
5  * The contents of this file are subject to the terms of the
6  * Common Development and Distribution License (the "License").
7  * You may not use this file except in compliance with the License.
8  *
9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10  * or https://opensource.org/licenses/CDDL-1.0.
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 (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Copyright 2011 Nexenta Systems, Inc.  All rights reserved.
25  * Copyright (c) 2012, 2018 by Delphix. All rights reserved.
26  * Copyright (c) 2012, Joyent, Inc. All rights reserved.
27  */
28 
29 #ifndef _SYS_ZFS_CONTEXT_H
30 #define	_SYS_ZFS_CONTEXT_H
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 /*
37  * This code compiles in three different contexts. When __KERNEL__ is defined,
38  * the code uses "unix-like" kernel interfaces. When _STANDALONE is defined, the
39  * code is running in a reduced capacity environment of the boot loader which is
40  * generally a subset of both POSIX and kernel interfaces (with a few unique
41  * interfaces too). When neither are defined, it's in a userland POSIX or
42  * similar environment.
43  */
44 #if defined(__KERNEL__) || defined(_STANDALONE)
45 #include <sys/types.h>
46 #include <sys/atomic.h>
47 #include <sys/sysmacros.h>
48 #include <sys/vmsystm.h>
49 #include <sys/condvar.h>
50 #include <sys/cmn_err.h>
51 #include <sys/kmem.h>
52 #include <sys/kmem_cache.h>
53 #include <sys/vmem.h>
54 #include <sys/misc.h>
55 #include <sys/taskq.h>
56 #include <sys/param.h>
57 #include <sys/disp.h>
58 #include <sys/debug.h>
59 #include <sys/random.h>
60 #include <sys/string.h>
61 #include <sys/byteorder.h>
62 #include <sys/list.h>
63 #include <sys/time.h>
64 #include <sys/zone.h>
65 #include <sys/kstat.h>
66 #include <sys/zfs_debug.h>
67 #include <sys/sysevent.h>
68 #include <sys/sysevent/eventdefs.h>
69 #include <sys/zfs_delay.h>
70 #include <sys/sunddi.h>
71 #include <sys/ctype.h>
72 #include <sys/disp.h>
73 #include <sys/trace.h>
74 #include <sys/procfs_list.h>
75 #include <sys/mod.h>
76 #include <sys/uio_impl.h>
77 #include <sys/zfs_context_os.h>
78 #else /* _KERNEL || _STANDALONE */
79 
80 #define	_SYS_MUTEX_H
81 #define	_SYS_RWLOCK_H
82 #define	_SYS_CONDVAR_H
83 #define	_SYS_VNODE_H
84 #define	_SYS_VFS_H
85 #define	_SYS_SUNDDI_H
86 #define	_SYS_CALLB_H
87 
88 #include <stdio.h>
89 #include <stdlib.h>
90 #include <stddef.h>
91 #include <stdarg.h>
92 #include <fcntl.h>
93 #include <unistd.h>
94 #include <errno.h>
95 #include <string.h>
96 #include <pthread.h>
97 #include <setjmp.h>
98 #include <assert.h>
99 #include <umem.h>
100 #include <limits.h>
101 #include <atomic.h>
102 #include <dirent.h>
103 #include <time.h>
104 #include <ctype.h>
105 #include <signal.h>
106 #include <sys/mman.h>
107 #include <sys/types.h>
108 #include <sys/cred.h>
109 #include <sys/sysmacros.h>
110 #include <sys/resource.h>
111 #include <sys/byteorder.h>
112 #include <sys/list.h>
113 #include <sys/mod.h>
114 #include <sys/uio.h>
115 #include <sys/zfs_debug.h>
116 #include <sys/kstat.h>
117 #include <sys/u8_textprep.h>
118 #include <sys/sysevent.h>
119 #include <sys/sysevent/eventdefs.h>
120 #include <sys/sunddi.h>
121 #include <sys/debug.h>
122 #include <sys/utsname.h>
123 #include <sys/trace_zfs.h>
124 
125 #include <sys/zfs_context_os.h>
126 
127 /*
128  * Stack
129  */
130 
131 #define	noinline	__attribute__((noinline))
132 #define	likely(x)	__builtin_expect((x), 1)
133 #define	unlikely(x)	__builtin_expect((x), 0)
134 
135 /*
136  * Debugging
137  */
138 
139 /*
140  * Note that we are not using the debugging levels.
141  */
142 
143 #define	CE_CONT		0	/* continuation		*/
144 #define	CE_NOTE		1	/* notice		*/
145 #define	CE_WARN		2	/* warning		*/
146 #define	CE_PANIC	3	/* panic		*/
147 #define	CE_IGNORE	4	/* print nothing	*/
148 
149 /*
150  * ZFS debugging
151  */
152 
153 extern void dprintf_setup(int *argc, char **argv);
154 
155 extern void cmn_err(int, const char *, ...)
156     __attribute__((format(printf, 2, 3)));
157 extern void vcmn_err(int, const char *, va_list)
158     __attribute__((format(printf, 2, 0)));
159 extern void panic(const char *, ...)
160     __attribute__((format(printf, 1, 2), noreturn));
161 extern void vpanic(const char *, va_list)
162     __attribute__((format(printf, 1, 0), noreturn));
163 
164 #define	fm_panic	panic
165 
166 /*
167  * DTrace SDT probes have different signatures in userland than they do in
168  * the kernel.  If they're being used in kernel code, re-define them out of
169  * existence for their counterparts in libzpool.
170  *
171  * Here's an example of how to use the set-error probes in userland:
172  * zfs$target:::set-error /arg0 == EBUSY/ {stack();}
173  *
174  * Here's an example of how to use DTRACE_PROBE probes in userland:
175  * If there is a probe declared as follows:
176  * DTRACE_PROBE2(zfs__probe_name, uint64_t, blkid, dnode_t *, dn);
177  * Then you can use it as follows:
178  * zfs$target:::probe2 /copyinstr(arg0) == "zfs__probe_name"/
179  *     {printf("%u %p\n", arg1, arg2);}
180  */
181 
182 #ifdef DTRACE_PROBE
183 #undef	DTRACE_PROBE
184 #endif	/* DTRACE_PROBE */
185 #define	DTRACE_PROBE(a)
186 
187 #ifdef DTRACE_PROBE1
188 #undef	DTRACE_PROBE1
189 #endif	/* DTRACE_PROBE1 */
190 #define	DTRACE_PROBE1(a, b, c)
191 
192 #ifdef DTRACE_PROBE2
193 #undef	DTRACE_PROBE2
194 #endif	/* DTRACE_PROBE2 */
195 #define	DTRACE_PROBE2(a, b, c, d, e)
196 
197 #ifdef DTRACE_PROBE3
198 #undef	DTRACE_PROBE3
199 #endif	/* DTRACE_PROBE3 */
200 #define	DTRACE_PROBE3(a, b, c, d, e, f, g)
201 
202 #ifdef DTRACE_PROBE4
203 #undef	DTRACE_PROBE4
204 #endif	/* DTRACE_PROBE4 */
205 #define	DTRACE_PROBE4(a, b, c, d, e, f, g, h, i)
206 
207 /*
208  * Tunables.
209  */
210 typedef struct zfs_kernel_param {
211 	const char *name;	/* unused stub */
212 } zfs_kernel_param_t;
213 
214 #define	ZFS_MODULE_PARAM(scope_prefix, name_prefix, name, type, perm, desc)
215 #define	ZFS_MODULE_PARAM_ARGS void
216 #define	ZFS_MODULE_PARAM_CALL(scope_prefix, name_prefix, name, setfunc, \
217 	getfunc, perm, desc)
218 
219 /*
220  * Threads.
221  */
222 typedef pthread_t	kthread_t;
223 
224 #define	TS_RUN		0x00000002
225 #define	TS_JOINABLE	0x00000004
226 
227 #define	curthread	((void *)(uintptr_t)pthread_self())
228 #define	getcomm()	"unknown"
229 
230 #define	thread_create_named(name, stk, stksize, func, arg, len, \
231     pp, state, pri)	\
232 	zk_thread_create(name, func, arg, stksize, state)
233 #define	thread_create(stk, stksize, func, arg, len, pp, state, pri)	\
234 	zk_thread_create(#func, func, arg, stksize, state)
235 #define	thread_exit()	pthread_exit(NULL)
236 #define	thread_join(t)	pthread_join((pthread_t)(t), NULL)
237 
238 #define	newproc(f, a, cid, pri, ctp, pid)	(ENOSYS)
239 
240 /* in libzpool, p0 exists only to have its address taken */
241 typedef struct proc {
242 	uintptr_t	this_is_never_used_dont_dereference_it;
243 } proc_t;
244 
245 extern struct proc p0;
246 #define	curproc		(&p0)
247 
248 #define	PS_NONE		-1
249 
250 extern kthread_t *zk_thread_create(const char *name, void (*func)(void *),
251     void *arg, size_t stksize, int state);
252 
253 #define	issig()		(FALSE)
254 
255 #define	KPREEMPT_SYNC		(-1)
256 
257 #define	kpreempt(x)		sched_yield()
258 #define	kpreempt_disable()	((void)0)
259 #define	kpreempt_enable()	((void)0)
260 
261 /*
262  * Mutexes
263  */
264 typedef struct kmutex {
265 	pthread_mutex_t		m_lock;
266 	pthread_t		m_owner;
267 } kmutex_t;
268 
269 #define	MUTEX_DEFAULT		0
270 #define	MUTEX_NOLOCKDEP		MUTEX_DEFAULT
271 #define	MUTEX_HELD(mp)		pthread_equal((mp)->m_owner, pthread_self())
272 #define	MUTEX_NOT_HELD(mp)	!MUTEX_HELD(mp)
273 
274 extern void mutex_init(kmutex_t *mp, char *name, int type, void *cookie);
275 extern void mutex_destroy(kmutex_t *mp);
276 extern void mutex_enter(kmutex_t *mp);
277 extern int mutex_enter_check_return(kmutex_t *mp);
278 extern void mutex_exit(kmutex_t *mp);
279 extern int mutex_tryenter(kmutex_t *mp);
280 
281 #define	NESTED_SINGLE 1
282 #define	mutex_enter_nested(mp, class) mutex_enter(mp)
283 #define	mutex_enter_interruptible(mp) mutex_enter_check_return(mp)
284 /*
285  * RW locks
286  */
287 typedef struct krwlock {
288 	pthread_rwlock_t	rw_lock;
289 	pthread_t		rw_owner;
290 	uint_t			rw_readers;
291 } krwlock_t;
292 
293 typedef int krw_t;
294 
295 #define	RW_READER		0
296 #define	RW_WRITER		1
297 #define	RW_DEFAULT		RW_READER
298 #define	RW_NOLOCKDEP		RW_READER
299 
300 #define	RW_READ_HELD(rw)	((rw)->rw_readers > 0)
301 #define	RW_WRITE_HELD(rw)	pthread_equal((rw)->rw_owner, pthread_self())
302 #define	RW_LOCK_HELD(rw)	(RW_READ_HELD(rw) || RW_WRITE_HELD(rw))
303 
304 extern void rw_init(krwlock_t *rwlp, char *name, int type, void *arg);
305 extern void rw_destroy(krwlock_t *rwlp);
306 extern void rw_enter(krwlock_t *rwlp, krw_t rw);
307 extern int rw_tryenter(krwlock_t *rwlp, krw_t rw);
308 extern int rw_tryupgrade(krwlock_t *rwlp);
309 extern void rw_exit(krwlock_t *rwlp);
310 #define	rw_downgrade(rwlp) do { } while (0)
311 
312 /*
313  * Credentials
314  */
315 extern uid_t crgetuid(cred_t *cr);
316 extern uid_t crgetruid(cred_t *cr);
317 extern gid_t crgetgid(cred_t *cr);
318 extern int crgetngroups(cred_t *cr);
319 extern gid_t *crgetgroups(cred_t *cr);
320 
321 /*
322  * Condition variables
323  */
324 typedef pthread_cond_t		kcondvar_t;
325 
326 #define	CV_DEFAULT		0
327 #define	CALLOUT_FLAG_ABSOLUTE	0x2
328 
329 extern void cv_init(kcondvar_t *cv, char *name, int type, void *arg);
330 extern void cv_destroy(kcondvar_t *cv);
331 extern void cv_wait(kcondvar_t *cv, kmutex_t *mp);
332 extern int cv_wait_sig(kcondvar_t *cv, kmutex_t *mp);
333 extern int cv_timedwait(kcondvar_t *cv, kmutex_t *mp, clock_t abstime);
334 extern int cv_timedwait_hires(kcondvar_t *cvp, kmutex_t *mp, hrtime_t tim,
335     hrtime_t res, int flag);
336 extern void cv_signal(kcondvar_t *cv);
337 extern void cv_broadcast(kcondvar_t *cv);
338 
339 #define	cv_timedwait_io(cv, mp, at)		cv_timedwait(cv, mp, at)
340 #define	cv_timedwait_idle(cv, mp, at)		cv_timedwait(cv, mp, at)
341 #define	cv_timedwait_sig(cv, mp, at)		cv_timedwait(cv, mp, at)
342 #define	cv_wait_io(cv, mp)			cv_wait(cv, mp)
343 #define	cv_wait_idle(cv, mp)			cv_wait(cv, mp)
344 #define	cv_wait_io_sig(cv, mp)			cv_wait_sig(cv, mp)
345 #define	cv_timedwait_sig_hires(cv, mp, t, r, f) \
346 	cv_timedwait_hires(cv, mp, t, r, f)
347 #define	cv_timedwait_idle_hires(cv, mp, t, r, f) \
348 	cv_timedwait_hires(cv, mp, t, r, f)
349 
350 /*
351  * Thread-specific data
352  */
353 #define	tsd_get(k) pthread_getspecific(k)
354 #define	tsd_set(k, v) pthread_setspecific(k, v)
355 #define	tsd_create(kp, d) pthread_key_create((pthread_key_t *)kp, d)
356 #define	tsd_destroy(kp) /* nothing */
357 #ifdef __FreeBSD__
358 typedef off_t loff_t;
359 #endif
360 
361 /*
362  * kstat creation, installation and deletion
363  */
364 extern kstat_t *kstat_create(const char *, int,
365     const char *, const char *, uchar_t, ulong_t, uchar_t);
366 extern void kstat_install(kstat_t *);
367 extern void kstat_delete(kstat_t *);
368 extern void kstat_set_raw_ops(kstat_t *ksp,
369     int (*headers)(char *buf, size_t size),
370     int (*data)(char *buf, size_t size, void *data),
371     void *(*addr)(kstat_t *ksp, loff_t index));
372 
373 /*
374  * procfs list manipulation
375  */
376 
377 typedef struct procfs_list {
378 	void		*pl_private;
379 	kmutex_t	pl_lock;
380 	list_t		pl_list;
381 	uint64_t	pl_next_id;
382 	size_t		pl_node_offset;
383 } procfs_list_t;
384 
385 #ifndef __cplusplus
386 struct seq_file { };
387 void seq_printf(struct seq_file *m, const char *fmt, ...);
388 
389 typedef struct procfs_list_node {
390 	list_node_t	pln_link;
391 	uint64_t	pln_id;
392 } procfs_list_node_t;
393 
394 void procfs_list_install(const char *module,
395     const char *submodule,
396     const char *name,
397     mode_t mode,
398     procfs_list_t *procfs_list,
399     int (*show)(struct seq_file *f, void *p),
400     int (*show_header)(struct seq_file *f),
401     int (*clear)(procfs_list_t *procfs_list),
402     size_t procfs_list_node_off);
403 void procfs_list_uninstall(procfs_list_t *procfs_list);
404 void procfs_list_destroy(procfs_list_t *procfs_list);
405 void procfs_list_add(procfs_list_t *procfs_list, void *p);
406 #endif
407 
408 /*
409  * Kernel memory
410  */
411 #define	KM_SLEEP		UMEM_NOFAIL
412 #define	KM_PUSHPAGE		KM_SLEEP
413 #define	KM_NOSLEEP		UMEM_DEFAULT
414 #define	KM_NORMALPRI		0	/* not needed with UMEM_DEFAULT */
415 #define	KMC_NODEBUG		UMC_NODEBUG
416 #define	KMC_KVMEM		0x0
417 #define	KMC_RECLAIMABLE		0x0
418 #define	kmem_alloc(_s, _f)	umem_alloc(_s, _f)
419 #define	kmem_zalloc(_s, _f)	umem_zalloc(_s, _f)
420 #define	kmem_free(_b, _s)	umem_free(_b, _s)
421 #define	vmem_alloc(_s, _f)	kmem_alloc(_s, _f)
422 #define	vmem_zalloc(_s, _f)	kmem_zalloc(_s, _f)
423 #define	vmem_free(_b, _s)	kmem_free(_b, _s)
424 #define	kmem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i) \
425 	umem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i)
426 #define	kmem_cache_destroy(_c)	umem_cache_destroy(_c)
427 #define	kmem_cache_alloc(_c, _f) umem_cache_alloc(_c, _f)
428 #define	kmem_cache_free(_c, _b)	umem_cache_free(_c, _b)
429 #define	kmem_debugging()	0
430 #define	kmem_cache_reap_now(_c)	umem_cache_reap_now(_c);
431 #define	kmem_cache_set_move(_c, _cb)	/* nothing */
432 #define	POINTER_INVALIDATE(_pp)		/* nothing */
433 #define	POINTER_IS_VALID(_p)	0
434 
435 typedef umem_cache_t kmem_cache_t;
436 
437 typedef enum kmem_cbrc {
438 	KMEM_CBRC_YES,
439 	KMEM_CBRC_NO,
440 	KMEM_CBRC_LATER,
441 	KMEM_CBRC_DONT_NEED,
442 	KMEM_CBRC_DONT_KNOW
443 } kmem_cbrc_t;
444 
445 /*
446  * Task queues
447  */
448 
449 #define	TASKQ_NAMELEN	31
450 
451 typedef uintptr_t taskqid_t;
452 typedef void (task_func_t)(void *);
453 
454 typedef struct taskq_ent {
455 	struct taskq_ent	*tqent_next;
456 	struct taskq_ent	*tqent_prev;
457 	task_func_t		*tqent_func;
458 	void			*tqent_arg;
459 	uintptr_t		tqent_flags;
460 } taskq_ent_t;
461 
462 typedef struct taskq {
463 	char		tq_name[TASKQ_NAMELEN + 1];
464 	kmutex_t	tq_lock;
465 	krwlock_t	tq_threadlock;
466 	kcondvar_t	tq_dispatch_cv;
467 	kcondvar_t	tq_wait_cv;
468 	kthread_t	**tq_threadlist;
469 	int		tq_flags;
470 	int		tq_active;
471 	int		tq_nthreads;
472 	int		tq_nalloc;
473 	int		tq_minalloc;
474 	int		tq_maxalloc;
475 	kcondvar_t	tq_maxalloc_cv;
476 	int		tq_maxalloc_wait;
477 	taskq_ent_t	*tq_freelist;
478 	taskq_ent_t	tq_task;
479 } taskq_t;
480 
481 #define	TQENT_FLAG_PREALLOC	0x1	/* taskq_dispatch_ent used */
482 
483 #define	TASKQ_PREPOPULATE	0x0001
484 #define	TASKQ_CPR_SAFE		0x0002	/* Use CPR safe protocol */
485 #define	TASKQ_DYNAMIC		0x0004	/* Use dynamic thread scheduling */
486 #define	TASKQ_THREADS_CPU_PCT	0x0008	/* Scale # threads by # cpus */
487 #define	TASKQ_DC_BATCH		0x0010	/* Mark threads as batch */
488 
489 #define	TQ_SLEEP	KM_SLEEP	/* Can block for memory */
490 #define	TQ_NOSLEEP	KM_NOSLEEP	/* cannot block for memory; may fail */
491 #define	TQ_NOQUEUE	0x02		/* Do not enqueue if can't dispatch */
492 #define	TQ_FRONT	0x08		/* Queue in front */
493 
494 #define	TASKQID_INVALID		((taskqid_t)0)
495 
496 extern taskq_t *system_taskq;
497 extern taskq_t *system_delay_taskq;
498 
499 extern taskq_t	*taskq_create(const char *, int, pri_t, int, int, uint_t);
500 extern taskq_t	*taskq_create_synced(const char *, int, pri_t, int, int, uint_t,
501     kthread_t ***);
502 #define	taskq_create_proc(a, b, c, d, e, p, f) \
503 	    (taskq_create(a, b, c, d, e, f))
504 #define	taskq_create_sysdc(a, b, d, e, p, dc, f) \
505 	    ((void) sizeof (dc), taskq_create(a, b, maxclsyspri, d, e, f))
506 extern taskqid_t taskq_dispatch(taskq_t *, task_func_t, void *, uint_t);
507 extern taskqid_t taskq_dispatch_delay(taskq_t *, task_func_t, void *, uint_t,
508     clock_t);
509 extern void	taskq_dispatch_ent(taskq_t *, task_func_t, void *, uint_t,
510     taskq_ent_t *);
511 extern int	taskq_empty_ent(taskq_ent_t *);
512 extern void	taskq_init_ent(taskq_ent_t *);
513 extern void	taskq_destroy(taskq_t *);
514 extern void	taskq_wait(taskq_t *);
515 extern void	taskq_wait_id(taskq_t *, taskqid_t);
516 extern void	taskq_wait_outstanding(taskq_t *, taskqid_t);
517 extern int	taskq_member(taskq_t *, kthread_t *);
518 extern taskq_t	*taskq_of_curthread(void);
519 extern int	taskq_cancel_id(taskq_t *, taskqid_t);
520 extern void	system_taskq_init(void);
521 extern void	system_taskq_fini(void);
522 
523 #define	XVA_MAPSIZE	3
524 #define	XVA_MAGIC	0x78766174
525 
526 extern char *vn_dumpdir;
527 #define	AV_SCANSTAMP_SZ	32		/* length of anti-virus scanstamp */
528 
529 typedef struct xoptattr {
530 	inode_timespec_t xoa_createtime;	/* Create time of file */
531 	uint8_t		xoa_archive;
532 	uint8_t		xoa_system;
533 	uint8_t		xoa_readonly;
534 	uint8_t		xoa_hidden;
535 	uint8_t		xoa_nounlink;
536 	uint8_t		xoa_immutable;
537 	uint8_t		xoa_appendonly;
538 	uint8_t		xoa_nodump;
539 	uint8_t		xoa_settable;
540 	uint8_t		xoa_opaque;
541 	uint8_t		xoa_av_quarantined;
542 	uint8_t		xoa_av_modified;
543 	uint8_t		xoa_av_scanstamp[AV_SCANSTAMP_SZ];
544 	uint8_t		xoa_reparse;
545 	uint8_t		xoa_offline;
546 	uint8_t		xoa_sparse;
547 } xoptattr_t;
548 
549 typedef struct vattr {
550 	uint_t		va_mask;	/* bit-mask of attributes */
551 	u_offset_t	va_size;	/* file size in bytes */
552 } vattr_t;
553 
554 
555 typedef struct xvattr {
556 	vattr_t		xva_vattr;	/* Embedded vattr structure */
557 	uint32_t	xva_magic;	/* Magic Number */
558 	uint32_t	xva_mapsize;	/* Size of attr bitmap (32-bit words) */
559 	uint32_t	*xva_rtnattrmapp;	/* Ptr to xva_rtnattrmap[] */
560 	uint32_t	xva_reqattrmap[XVA_MAPSIZE];	/* Requested attrs */
561 	uint32_t	xva_rtnattrmap[XVA_MAPSIZE];	/* Returned attrs */
562 	xoptattr_t	xva_xoptattrs;	/* Optional attributes */
563 } xvattr_t;
564 
565 typedef struct vsecattr {
566 	uint_t		vsa_mask;	/* See below */
567 	int		vsa_aclcnt;	/* ACL entry count */
568 	void		*vsa_aclentp;	/* pointer to ACL entries */
569 	int		vsa_dfaclcnt;	/* default ACL entry count */
570 	void		*vsa_dfaclentp;	/* pointer to default ACL entries */
571 	size_t		vsa_aclentsz;	/* ACE size in bytes of vsa_aclentp */
572 } vsecattr_t;
573 
574 #define	AT_MODE		0x00002
575 #define	AT_UID		0x00004
576 #define	AT_GID		0x00008
577 #define	AT_FSID		0x00010
578 #define	AT_NODEID	0x00020
579 #define	AT_NLINK	0x00040
580 #define	AT_SIZE		0x00080
581 #define	AT_ATIME	0x00100
582 #define	AT_MTIME	0x00200
583 #define	AT_CTIME	0x00400
584 #define	AT_RDEV		0x00800
585 #define	AT_BLKSIZE	0x01000
586 #define	AT_NBLOCKS	0x02000
587 #define	AT_SEQ		0x08000
588 #define	AT_XVATTR	0x10000
589 
590 #define	CRCREAT		0
591 
592 #define	F_FREESP	11
593 #define	FIGNORECASE	0x80000 /* request case-insensitive lookups */
594 
595 /*
596  * Random stuff
597  */
598 #define	ddi_get_lbolt()		(gethrtime() >> 23)
599 #define	ddi_get_lbolt64()	(gethrtime() >> 23)
600 #define	hz	119	/* frequency when using gethrtime() >> 23 for lbolt */
601 
602 #define	ddi_time_before(a, b)		(a < b)
603 #define	ddi_time_after(a, b)		ddi_time_before(b, a)
604 #define	ddi_time_before_eq(a, b)	(!ddi_time_after(a, b))
605 #define	ddi_time_after_eq(a, b)		ddi_time_before_eq(b, a)
606 
607 #define	ddi_time_before64(a, b)		(a < b)
608 #define	ddi_time_after64(a, b)		ddi_time_before64(b, a)
609 #define	ddi_time_before_eq64(a, b)	(!ddi_time_after64(a, b))
610 #define	ddi_time_after_eq64(a, b)	ddi_time_before_eq64(b, a)
611 
612 extern void delay(clock_t ticks);
613 
614 #define	SEC_TO_TICK(sec)	((sec) * hz)
615 #define	MSEC_TO_TICK(msec)	(howmany((hrtime_t)(msec) * hz, MILLISEC))
616 #define	USEC_TO_TICK(usec)	(howmany((hrtime_t)(usec) * hz, MICROSEC))
617 #define	NSEC_TO_TICK(nsec)	(howmany((hrtime_t)(nsec) * hz, NANOSEC))
618 
619 #define	max_ncpus	64
620 #define	boot_ncpus	(sysconf(_SC_NPROCESSORS_ONLN))
621 
622 /*
623  * Process priorities as defined by setpriority(2) and getpriority(2).
624  */
625 #define	minclsyspri	19
626 #define	defclsyspri	0
627 /* Write issue taskq priority. */
628 #define	wtqclsyspri	-19
629 #define	maxclsyspri	-20
630 
631 #define	CPU_SEQID	((uintptr_t)pthread_self() & (max_ncpus - 1))
632 #define	CPU_SEQID_UNSTABLE	CPU_SEQID
633 
634 #define	kcred		NULL
635 #define	CRED()		NULL
636 
637 #define	crhold(cr)	((void)cr)
638 #define	crfree(cr)	((void)cr)
639 
640 #define	ptob(x)		((x) * PAGESIZE)
641 
642 #define	NN_DIVISOR_1000	(1U << 0)
643 #define	NN_NUMBUF_SZ	(6)
644 
645 extern uint64_t physmem;
646 extern const char *random_path;
647 extern const char *urandom_path;
648 
649 extern int highbit64(uint64_t i);
650 extern int lowbit64(uint64_t i);
651 extern int random_get_bytes(uint8_t *ptr, size_t len);
652 extern int random_get_pseudo_bytes(uint8_t *ptr, size_t len);
653 
654 static __inline__ uint32_t
655 random_in_range(uint32_t range)
656 {
657 	uint32_t r;
658 
659 	ASSERT(range != 0);
660 
661 	if (range == 1)
662 		return (0);
663 
664 	(void) random_get_pseudo_bytes((uint8_t *)&r, sizeof (r));
665 
666 	return (r % range);
667 }
668 
669 extern void kernel_init(int mode);
670 extern void kernel_fini(void);
671 extern void random_init(void);
672 extern void random_fini(void);
673 
674 struct spa;
675 extern void show_pool_stats(struct spa *);
676 extern int set_global_var(char const *arg);
677 
678 typedef struct callb_cpr {
679 	kmutex_t	*cc_lockp;
680 } callb_cpr_t;
681 
682 #define	CALLB_CPR_INIT(cp, lockp, func, name)	{		\
683 	(cp)->cc_lockp = lockp;					\
684 }
685 
686 #define	CALLB_CPR_SAFE_BEGIN(cp) {				\
687 	ASSERT(MUTEX_HELD((cp)->cc_lockp));			\
688 }
689 
690 #define	CALLB_CPR_SAFE_END(cp, lockp) {				\
691 	ASSERT(MUTEX_HELD((cp)->cc_lockp));			\
692 }
693 
694 #define	CALLB_CPR_EXIT(cp) {					\
695 	ASSERT(MUTEX_HELD((cp)->cc_lockp));			\
696 	mutex_exit((cp)->cc_lockp);				\
697 }
698 
699 #define	zone_dataset_visible(x, y)	(1)
700 #define	INGLOBALZONE(z)			(1)
701 extern uint32_t zone_get_hostid(void *zonep);
702 
703 extern char *kmem_vasprintf(const char *fmt, va_list adx);
704 extern char *kmem_asprintf(const char *fmt, ...);
705 #define	kmem_strfree(str) kmem_free((str), strlen(str) + 1)
706 #define	kmem_strdup(s)  strdup(s)
707 
708 #ifndef __cplusplus
709 extern int kmem_scnprintf(char *restrict str, size_t size,
710     const char *restrict fmt, ...);
711 #endif
712 
713 /*
714  * Hostname information
715  */
716 extern int ddi_strtoull(const char *str, char **nptr, int base,
717     u_longlong_t *result);
718 
719 typedef struct utsname	utsname_t;
720 extern utsname_t *utsname(void);
721 
722 /* ZFS Boot Related stuff. */
723 
724 struct _buf {
725 	intptr_t	_fd;
726 };
727 
728 struct bootstat {
729 	uint64_t st_size;
730 };
731 
732 typedef struct ace_object {
733 	uid_t		a_who;
734 	uint32_t	a_access_mask;
735 	uint16_t	a_flags;
736 	uint16_t	a_type;
737 	uint8_t		a_obj_type[16];
738 	uint8_t		a_inherit_obj_type[16];
739 } ace_object_t;
740 
741 
742 #define	ACE_ACCESS_ALLOWED_OBJECT_ACE_TYPE	0x05
743 #define	ACE_ACCESS_DENIED_OBJECT_ACE_TYPE	0x06
744 #define	ACE_SYSTEM_AUDIT_OBJECT_ACE_TYPE	0x07
745 #define	ACE_SYSTEM_ALARM_OBJECT_ACE_TYPE	0x08
746 
747 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
748 extern int zfs_secpolicy_rename_perms(const char *from, const char *to,
749     cred_t *cr);
750 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
751 extern int secpolicy_zfs(const cred_t *cr);
752 extern zoneid_t getzoneid(void);
753 
754 /* SID stuff */
755 typedef struct ksiddomain {
756 	uint_t	kd_ref;
757 	uint_t	kd_len;
758 	char	*kd_name;
759 } ksiddomain_t;
760 
761 ksiddomain_t *ksid_lookupdomain(const char *);
762 void ksiddomain_rele(ksiddomain_t *);
763 
764 #define	DDI_SLEEP	KM_SLEEP
765 #define	ddi_log_sysevent(_a, _b, _c, _d, _e, _f, _g) \
766 	sysevent_post_event(_c, _d, _b, "libzpool", _e, _f)
767 
768 #define	zfs_sleep_until(wakeup)						\
769 	do {								\
770 		hrtime_t delta = wakeup - gethrtime();			\
771 		struct timespec ts;					\
772 		ts.tv_sec = delta / NANOSEC;				\
773 		ts.tv_nsec = delta % NANOSEC;				\
774 		(void) nanosleep(&ts, NULL);				\
775 	} while (0)
776 
777 typedef int fstrans_cookie_t;
778 
779 extern fstrans_cookie_t spl_fstrans_mark(void);
780 extern void spl_fstrans_unmark(fstrans_cookie_t);
781 extern int __spl_pf_fstrans_check(void);
782 extern int kmem_cache_reap_active(void);
783 
784 
785 /*
786  * Kernel modules
787  */
788 #define	__init
789 #define	__exit
790 
791 #endif  /* _KERNEL || _STANDALONE */
792 
793 #ifdef __cplusplus
794 };
795 #endif
796 
797 #endif	/* _SYS_ZFS_CONTEXT_H */
798