4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
24 * Copyright (c) 2012, 2016 by Delphix. All rights reserved.
25 * Copyright (c) 2012, Joyent, Inc. All rights reserved.
28 #ifndef _SYS_ZFS_CONTEXT_H
29 #define _SYS_ZFS_CONTEXT_H
37 #define _SYS_CONDVAR_H
66 #include <sys/debug.h>
67 #include <libsysevent.h>
69 #include <sys/types.h>
71 #include <sys/sysmacros.h>
72 #include <sys/bitmap.h>
73 #include <sys/resource.h>
74 #include <sys/byteorder.h>
77 #include <sys/zfs_debug.h>
79 #include <sys/kstat.h>
80 #include <sys/u8_textprep.h>
81 #include <sys/sysevent/eventdefs.h>
82 #include <sys/sysevent/dev.h>
83 #include <sys/sunddi.h>
84 #include <sys/debug.h>
92 * Note that we are not using the debugging levels.
95 #define CE_CONT 0 /* continuation */
96 #define CE_NOTE 1 /* notice */
97 #define CE_WARN 2 /* warning */
98 #define CE_PANIC 3 /* panic */
99 #define CE_IGNORE 4 /* print nothing */
106 extern void dprintf_setup(int *argc
, char **argv
);
107 #endif /* ZFS_DEBUG */
109 extern void cmn_err(int, const char *, ...);
110 extern void vcmn_err(int, const char *, __va_list
);
111 extern void panic(const char *, ...) __NORETURN
;
112 extern void vpanic(const char *, __va_list
) __NORETURN
;
114 #define fm_panic panic
119 * DTrace SDT probes have different signatures in userland than they do in
120 * the kernel. If they're being used in kernel code, re-define them out of
121 * existence for their counterparts in libzpool.
123 * Here's an example of how to use the set-error probes in userland:
124 * zfs$target:::set-error /arg0 == EBUSY/ {stack();}
126 * Here's an example of how to use DTRACE_PROBE probes in userland:
127 * If there is a probe declared as follows:
128 * DTRACE_PROBE2(zfs__probe_name, uint64_t, blkid, dnode_t *, dn);
129 * Then you can use it as follows:
130 * zfs$target:::probe2 /copyinstr(arg0) == "zfs__probe_name"/
131 * {printf("%u %p\n", arg1, arg2);}
136 #endif /* DTRACE_PROBE */
137 #define DTRACE_PROBE(a) \
142 #endif /* DTRACE_PROBE1 */
143 #define DTRACE_PROBE1(a, b, c) \
144 ZFS_PROBE1(#a, (unsigned long)c)
148 #endif /* DTRACE_PROBE2 */
149 #define DTRACE_PROBE2(a, b, c, d, e) \
150 ZFS_PROBE2(#a, (unsigned long)c, (unsigned long)e)
154 #endif /* DTRACE_PROBE3 */
155 #define DTRACE_PROBE3(a, b, c, d, e, f, g) \
156 ZFS_PROBE3(#a, (unsigned long)c, (unsigned long)e, (unsigned long)g)
160 #endif /* DTRACE_PROBE4 */
161 #define DTRACE_PROBE4(a, b, c, d, e, f, g, h, i) \
162 ZFS_PROBE4(#a, (unsigned long)c, (unsigned long)e, (unsigned long)g, \
166 * We use the comma operator so that this macro can be used without much
167 * additional code. For example, "return (EINVAL);" becomes
168 * "return (SET_ERROR(EINVAL));". Note that the argument will be evaluated
169 * twice, so it should not have side effects (e.g. something like:
170 * "return (SET_ERROR(log_error(EINVAL, info)));" would log the error twice).
172 #define SET_ERROR(err) (ZFS_SET_ERROR(err), err)
177 #define curthread ((void *)(uintptr_t)thr_self())
179 #define kpreempt(x) yield()
181 typedef struct kthread kthread_t
;
183 #define thread_create(stk, stksize, func, arg, len, pp, state, pri) \
184 zk_thread_create(func, arg, len)
185 #define thread_exit() thr_exit(NULL)
186 #define thread_join(t) panic("libzpool cannot join threads")
188 #define newproc(f, a, cid, pri, ctp, pid) (ENOSYS)
190 /* in libzpool, p0 exists only to have its address taken */
192 uintptr_t this_is_never_used_dont_dereference_it
;
195 extern struct proc p0
;
196 #define curproc (&p0)
200 extern kthread_t
*zk_thread_create(void (*func
)(void*), void *arg
,
203 #define issig(why) (FALSE)
204 #define ISSIG(thr, why) (FALSE)
209 typedef struct kmutex
{
211 boolean_t initialized
;
215 #define MUTEX_DEFAULT USYNC_THREAD
217 #undef MUTEX_NOT_HELD
218 #define MUTEX_HELD(m) _mutex_held(&(m)->m_lock)
219 #define MUTEX_NOT_HELD(m) (!MUTEX_HELD(m))
222 * Argh -- we have to get cheesy here because the kernel and userland
223 * have different signatures for the same routine.
225 extern int _mutex_init(mutex_t
*mp
, int type
, void *arg
);
226 extern int _mutex_destroy(mutex_t
*mp
);
228 #define mutex_init(mp, b, c, d) zmutex_init((kmutex_t *)(mp))
229 #define mutex_destroy(mp) zmutex_destroy((kmutex_t *)(mp))
230 #define mutex_enter(mp) zmutex_enter(mp)
231 #define mutex_exit(mp) zmutex_exit(mp)
233 extern void zmutex_init(kmutex_t
*mp
);
234 extern void zmutex_destroy(kmutex_t
*mp
);
235 extern void zmutex_enter(kmutex_t
*mp
);
236 extern void zmutex_exit(kmutex_t
*mp
);
237 extern int mutex_tryenter(kmutex_t
*mp
);
238 extern void *mutex_owner(kmutex_t
*mp
);
243 typedef struct krwlock
{
245 boolean_t initialized
;
253 #define RW_DEFAULT USYNC_THREAD
256 #define RW_READ_HELD(x) _rw_read_held(&(x)->rw_lock)
259 #define RW_WRITE_HELD(x) _rw_write_held(&(x)->rw_lock)
262 #define RW_LOCK_HELD(x) (RW_READ_HELD(x) || RW_WRITE_HELD(x))
264 extern void rw_init(krwlock_t
*rwlp
, char *name
, int type
, void *arg
);
265 extern void rw_destroy(krwlock_t
*rwlp
);
266 extern void rw_enter(krwlock_t
*rwlp
, krw_t rw
);
267 extern int rw_tryenter(krwlock_t
*rwlp
, krw_t rw
);
268 extern int rw_tryupgrade(krwlock_t
*rwlp
);
269 extern void rw_exit(krwlock_t
*rwlp
);
270 #define rw_downgrade(rwlp) do { } while (0)
272 extern uid_t
crgetuid(cred_t
*cr
);
273 extern uid_t
crgetruid(cred_t
*cr
);
274 extern gid_t
crgetgid(cred_t
*cr
);
275 extern int crgetngroups(cred_t
*cr
);
276 extern gid_t
*crgetgroups(cred_t
*cr
);
279 * Condition variables
281 typedef cond_t kcondvar_t
;
283 #define CV_DEFAULT USYNC_THREAD
284 #define CALLOUT_FLAG_ABSOLUTE 0x2
286 extern void cv_init(kcondvar_t
*cv
, char *name
, int type
, void *arg
);
287 extern void cv_destroy(kcondvar_t
*cv
);
288 extern void cv_wait(kcondvar_t
*cv
, kmutex_t
*mp
);
289 extern clock_t cv_timedwait(kcondvar_t
*cv
, kmutex_t
*mp
, clock_t abstime
);
290 extern clock_t cv_timedwait_hires(kcondvar_t
*cvp
, kmutex_t
*mp
, hrtime_t tim
,
291 hrtime_t res
, int flag
);
292 extern void cv_signal(kcondvar_t
*cv
);
293 extern void cv_broadcast(kcondvar_t
*cv
);
296 * Thread-specific data
298 #define tsd_get(k) pthread_getspecific(k)
299 #define tsd_set(k, v) pthread_setspecific(k, v)
300 #define tsd_create(kp, d) pthread_key_create(kp, d)
301 #define tsd_destroy(kp) /* nothing */
304 * kstat creation, installation and deletion
306 extern kstat_t
*kstat_create(const char *, int,
307 const char *, const char *, uchar_t
, ulong_t
, uchar_t
);
308 extern void kstat_named_init(kstat_named_t
*, const char *, uchar_t
);
309 extern void kstat_install(kstat_t
*);
310 extern void kstat_delete(kstat_t
*);
311 extern void kstat_waitq_enter(kstat_io_t
*);
312 extern void kstat_waitq_exit(kstat_io_t
*);
313 extern void kstat_runq_enter(kstat_io_t
*);
314 extern void kstat_runq_exit(kstat_io_t
*);
315 extern void kstat_waitq_to_runq(kstat_io_t
*);
316 extern void kstat_runq_back_to_waitq(kstat_io_t
*);
321 #define KM_SLEEP UMEM_NOFAIL
322 #define KM_PUSHPAGE KM_SLEEP
323 #define KM_NOSLEEP UMEM_DEFAULT
324 #define KM_NORMALPRI 0 /* not needed with UMEM_DEFAULT */
325 #define KMC_NODEBUG UMC_NODEBUG
326 #define KMC_NOTOUCH 0 /* not needed for userland caches */
327 #define kmem_alloc(_s, _f) umem_alloc(_s, _f)
328 #define kmem_zalloc(_s, _f) umem_zalloc(_s, _f)
329 #define kmem_free(_b, _s) umem_free(_b, _s)
330 #define kmem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i) \
331 umem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i)
332 #define kmem_cache_destroy(_c) umem_cache_destroy(_c)
333 #define kmem_cache_alloc(_c, _f) umem_cache_alloc(_c, _f)
334 #define kmem_cache_free(_c, _b) umem_cache_free(_c, _b)
335 #define kmem_debugging() 0
336 #define kmem_cache_reap_now(_c) /* nothing */
337 #define kmem_cache_set_move(_c, _cb) /* nothing */
338 #define vmem_qcache_reap(_v) /* nothing */
339 #define POINTER_INVALIDATE(_pp) /* nothing */
340 #define POINTER_IS_VALID(_p) 0
342 extern vmem_t
*zio_arena
;
344 typedef umem_cache_t kmem_cache_t
;
346 typedef enum kmem_cbrc
{
357 typedef struct taskq taskq_t
;
358 typedef uintptr_t taskqid_t
;
359 typedef void (task_func_t
)(void *);
361 typedef struct taskq_ent
{
362 struct taskq_ent
*tqent_next
;
363 struct taskq_ent
*tqent_prev
;
364 task_func_t
*tqent_func
;
366 uintptr_t tqent_flags
;
369 #define TQENT_FLAG_PREALLOC 0x1 /* taskq_dispatch_ent used */
371 #define TASKQ_PREPOPULATE 0x0001
372 #define TASKQ_CPR_SAFE 0x0002 /* Use CPR safe protocol */
373 #define TASKQ_DYNAMIC 0x0004 /* Use dynamic thread scheduling */
374 #define TASKQ_THREADS_CPU_PCT 0x0008 /* Scale # threads by # cpus */
375 #define TASKQ_DC_BATCH 0x0010 /* Mark threads as batch */
377 #define TQ_SLEEP KM_SLEEP /* Can block for memory */
378 #define TQ_NOSLEEP KM_NOSLEEP /* cannot block for memory; may fail */
379 #define TQ_NOQUEUE 0x02 /* Do not enqueue if can't dispatch */
380 #define TQ_FRONT 0x08 /* Queue in front */
383 extern taskq_t
*system_taskq
;
385 extern taskq_t
*taskq_create(const char *, int, pri_t
, int, int, uint_t
);
386 #define taskq_create_proc(a, b, c, d, e, p, f) \
387 (taskq_create(a, b, c, d, e, f))
388 #define taskq_create_sysdc(a, b, d, e, p, dc, f) \
389 (taskq_create(a, b, maxclsyspri, d, e, f))
390 extern taskqid_t
taskq_dispatch(taskq_t
*, task_func_t
, void *, uint_t
);
391 extern void taskq_dispatch_ent(taskq_t
*, task_func_t
, void *, uint_t
,
393 extern void taskq_destroy(taskq_t
*);
394 extern void taskq_wait(taskq_t
*);
395 extern int taskq_member(taskq_t
*, void *);
396 extern void system_taskq_init(void);
397 extern void system_taskq_fini(void);
399 #define XVA_MAPSIZE 3
400 #define XVA_MAGIC 0x78766174
405 typedef struct vnode
{
412 extern char *vn_dumpdir
;
413 #define AV_SCANSTAMP_SZ 32 /* length of anti-virus scanstamp */
415 typedef struct xoptattr
{
416 timestruc_t xoa_createtime
; /* Create time of file */
419 uint8_t xoa_readonly
;
421 uint8_t xoa_nounlink
;
422 uint8_t xoa_immutable
;
423 uint8_t xoa_appendonly
;
425 uint8_t xoa_settable
;
427 uint8_t xoa_av_quarantined
;
428 uint8_t xoa_av_modified
;
429 uint8_t xoa_av_scanstamp
[AV_SCANSTAMP_SZ
];
435 typedef struct vattr
{
436 uint_t va_mask
; /* bit-mask of attributes */
437 uoff_t va_size
; /* file size in bytes */
441 typedef struct xvattr
{
442 vattr_t xva_vattr
; /* Embedded vattr structure */
443 uint32_t xva_magic
; /* Magic Number */
444 uint32_t xva_mapsize
; /* Size of attr bitmap (32-bit words) */
445 uint32_t *xva_rtnattrmapp
; /* Ptr to xva_rtnattrmap[] */
446 uint32_t xva_reqattrmap
[XVA_MAPSIZE
]; /* Requested attrs */
447 uint32_t xva_rtnattrmap
[XVA_MAPSIZE
]; /* Returned attrs */
448 xoptattr_t xva_xoptattrs
; /* Optional attributes */
451 typedef struct vsecattr
{
452 uint_t vsa_mask
; /* See below */
453 int vsa_aclcnt
; /* ACL entry count */
454 void *vsa_aclentp
; /* pointer to ACL entries */
455 int vsa_dfaclcnt
; /* default ACL entry count */
456 void *vsa_dfaclentp
; /* pointer to default ACL entries */
457 size_t vsa_aclentsz
; /* ACE size in bytes of vsa_aclentp */
460 #define AT_TYPE 0x00001
461 #define AT_MODE 0x00002
462 #define AT_UID 0x00004
463 #define AT_GID 0x00008
464 #define AT_FSID 0x00010
465 #define AT_NODEID 0x00020
466 #define AT_NLINK 0x00040
467 #define AT_SIZE 0x00080
468 #define AT_ATIME 0x00100
469 #define AT_MTIME 0x00200
470 #define AT_CTIME 0x00400
471 #define AT_RDEV 0x00800
472 #define AT_BLKSIZE 0x01000
473 #define AT_NBLOCKS 0x02000
474 #define AT_SEQ 0x08000
475 #define AT_XVATTR 0x10000
479 extern int fop_getattr_real(vnode_t
*vp
, vattr_t
*vap
);
481 #define fop_close(vp, f, c, o, cr, ct) 0
482 #define fop_putpage(vp, of, sz, fl, cr, ct) 0
483 #define fop_getattr(vp, vap, fl, cr, ct) fop_getattr_real((vp), (vap))
485 #define fop_fsync(vp, f, cr, ct) fsync((vp)->v_fd)
487 #define VN_RELE(vp) vn_close(vp)
489 extern int vn_open(char *path
, int x1
, int oflags
, int mode
, vnode_t
**vpp
,
491 extern int vn_openat(char *path
, int x1
, int oflags
, int mode
, vnode_t
**vpp
,
492 int x2
, int x3
, vnode_t
*vp
, int fd
);
493 extern int vn_rdwr(int uio
, vnode_t
*vp
, void *addr
, ssize_t len
,
494 offset_t offset
, int x1
, int x2
, rlim64_t x3
, void *x4
, ssize_t
*residp
);
495 extern void vn_close(vnode_t
*vp
);
497 #define vn_remove(path, x1, x2) remove(path)
498 #define vn_rename(from, to, seg) rename((from), (to))
499 #define vn_is_readonly(vp) B_FALSE
501 extern vnode_t
*rootdir
;
503 #include <sys/file.h> /* for FREAD, FWRITE, etc */
508 #define ddi_get_lbolt() (gethrtime() >> 23)
509 #define ddi_get_lbolt64() (gethrtime() >> 23)
510 #define hz 119 /* frequency when using gethrtime() >> 23 for lbolt */
512 extern void delay(clock_t ticks
);
514 #define SEC_TO_TICK(sec) ((sec) * hz)
515 #define NSEC_TO_TICK(usec) ((usec) / (NANOSEC / hz))
517 #define gethrestime_sec() time(NULL)
518 #define gethrestime(t) \
520 (t)->tv_sec = gethrestime_sec();\
525 #define boot_ncpus (sysconf(_SC_NPROCESSORS_ONLN))
527 #define minclsyspri 60
528 #define maxclsyspri 99
530 #define CPU_SEQID (thr_self() & (max_ncpus - 1))
535 #define ptob(x) ((x) * PAGESIZE)
537 extern uint64_t physmem
;
539 extern int highbit64(uint64_t i
);
540 extern int random_get_bytes(uint8_t *ptr
, size_t len
);
541 extern int random_get_pseudo_bytes(uint8_t *ptr
, size_t len
);
543 extern void kernel_init(int);
544 extern void kernel_fini(void);
547 extern void nicenum(uint64_t num
, char *buf
, size_t);
548 extern void show_pool_stats(struct spa
*);
549 extern int set_global_var(char *arg
);
551 typedef struct callb_cpr
{
555 #define CALLB_CPR_INIT(cp, lockp, func, name) { \
556 (cp)->cc_lockp = lockp; \
559 #define CALLB_CPR_SAFE_BEGIN(cp) { \
560 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
563 #define CALLB_CPR_SAFE_END(cp, lockp) { \
564 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
567 #define CALLB_CPR_EXIT(cp) { \
568 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
569 mutex_exit((cp)->cc_lockp); \
572 #define zone_dataset_visible(x, y) (1)
573 #define INGLOBALZONE(z) (1)
575 extern char *kmem_asprintf(const char *fmt
, ...);
576 #define strfree(str) kmem_free((str), strlen(str) + 1)
579 * Hostname information
581 extern char hw_serial
[]; /* for userland-emulated hostid access */
582 extern int ddi_strtoul(const char *str
, char **nptr
, int base
,
583 unsigned long *result
);
585 extern int ddi_strtoull(const char *str
, char **nptr
, int base
,
586 u_longlong_t
*result
);
588 /* ZFS Boot Related stuff. */
598 typedef struct ace_object
{
600 uint32_t a_access_mask
;
603 uint8_t a_obj_type
[16];
604 uint8_t a_inherit_obj_type
[16];
608 #define ACE_ACCESS_ALLOWED_OBJECT_ACE_TYPE 0x05
609 #define ACE_ACCESS_DENIED_OBJECT_ACE_TYPE 0x06
610 #define ACE_SYSTEM_AUDIT_OBJECT_ACE_TYPE 0x07
611 #define ACE_SYSTEM_ALARM_OBJECT_ACE_TYPE 0x08
613 extern struct _buf
*kobj_open_file(char *name
);
614 extern int kobj_read_file(struct _buf
*file
, char *buf
, unsigned size
,
616 extern void kobj_close_file(struct _buf
*file
);
617 extern int kobj_get_filesize(struct _buf
*file
, uint64_t *size
);
618 extern int zfs_secpolicy_snapshot_perms(const char *name
, cred_t
*cr
);
619 extern int zfs_secpolicy_rename_perms(const char *from
, const char *to
,
621 extern int zfs_secpolicy_destroy_perms(const char *name
, cred_t
*cr
);
622 extern zoneid_t
getzoneid(void);
625 typedef struct ksiddomain
{
631 ksiddomain_t
*ksid_lookupdomain(const char *);
632 void ksiddomain_rele(ksiddomain_t
*);
634 #define DDI_SLEEP KM_SLEEP
635 #define ddi_log_sysevent(_a, _b, _c, _d, _e, _f, _g) \
636 sysevent_post_event(_c, _d, _b, "libzpool", _e, _f)
641 extern kmutex_t cpu_lock
;
643 typedef uintptr_t cyclic_id_t
;
644 typedef uint16_t cyc_level_t
;
645 typedef void (*cyc_func_t
)(void *);
647 #define CY_LOW_LEVEL 0
648 #define CY_INFINITY INT64_MAX
649 #define CYCLIC_NONE ((cyclic_id_t)0)
651 typedef struct cyc_time
{
653 hrtime_t cyt_interval
;
656 typedef struct cyc_handler
{
659 cyc_level_t cyh_level
;
662 extern cyclic_id_t
cyclic_add(cyc_handler_t
*, cyc_time_t
*);
663 extern void cyclic_remove(cyclic_id_t
);
664 extern int cyclic_reprogram(cyclic_id_t
, hrtime_t
);
669 #define B_BUSY 0x0001
670 #define B_DONE 0x0002
671 #define B_ERROR 0x0004
672 #define B_READ 0x0040 /* read when I/O occurs */
673 #define B_WRITE 0x0100 /* non-read pseudo-flag */
683 #define b_lblkno _b_blkno._f
686 int (*b_iodone
)(struct buf
*);
691 extern void bioinit(buf_t
*);
692 extern void biodone(buf_t
*);
693 extern void bioerror(buf_t
*, int);
694 extern int geterror(buf_t
*);
700 #endif /* _SYS_ZFS_CONTEXT_H */