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 (c) 2012, 2014 by Delphix. All rights reserved.
24 * Copyright (c) 2012, Joyent, Inc. All rights reserved.
27 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
30 #ifndef _SYS_ZFS_CONTEXT_H
31 #define _SYS_ZFS_CONTEXT_H
39 #define _SYS_CONDVAR_H
69 #include <sys/debug.h>
71 #include <sys/types.h>
73 #include <sys/atomic.h>
74 #include <sys/sysmacros.h>
75 #include <sys/bitmap.h>
76 #include <sys/resource.h>
77 #include <sys/byteorder.h>
81 #include <sys/mntent.h>
82 #include <sys/mnttab.h>
83 #include <sys/zfs_debug.h>
85 #include <sys/kstat.h>
86 #include <sys/u8_textprep.h>
87 #include <sys/kernel.h>
89 #include <sys/sysevent.h>
90 #include <sys/sysevent/eventdefs.h>
91 #include <sys/sysevent/dev.h>
92 #include <machine/atomic.h>
93 #include <sys/debug.h>
98 #define ZFS_EXPORTS_PATH "/etc/zfs/exports"
105 * Note that we are not using the debugging levels.
108 #define CE_CONT 0 /* continuation */
109 #define CE_NOTE 1 /* notice */
110 #define CE_WARN 2 /* warning */
111 #define CE_PANIC 3 /* panic */
112 #define CE_IGNORE 4 /* print nothing */
118 #define ZFS_LOG(...) do { } while (0)
120 typedef u_longlong_t rlim64_t;
121 #define RLIM64_INFINITY ((rlim64_t)-3)
124 extern void dprintf_setup(int *argc, char **argv);
125 #endif /* ZFS_DEBUG */
127 extern void cmn_err(int, const char *, ...);
128 extern void vcmn_err(int, const char *, __va_list);
129 extern void panic(const char *, ...);
130 extern void vpanic(const char *, __va_list);
132 #define fm_panic panic
137 * DTrace SDT probes have different signatures in userland than they do in
138 * the kernel. If they're being used in kernel code, re-define them out of
139 * existence for their counterparts in libzpool.
141 * Here's an example of how to use the set-error probes in userland:
142 * zfs$target:::set-error /arg0 == EBUSY/ {stack();}
144 * Here's an example of how to use DTRACE_PROBE probes in userland:
145 * If there is a probe declared as follows:
146 * DTRACE_PROBE2(zfs__probe_name, uint64_t, blkid, dnode_t *, dn);
147 * Then you can use it as follows:
148 * zfs$target:::probe2 /copyinstr(arg0) == "zfs__probe_name"/
149 * {printf("%u %p\n", arg1, arg2);}
154 #endif /* DTRACE_PROBE */
156 #define DTRACE_PROBE(a) \
162 #endif /* DTRACE_PROBE1 */
164 #define DTRACE_PROBE1(a, b, c) \
165 ZFS_PROBE1(#a, (unsigned long)c)
170 #endif /* DTRACE_PROBE2 */
172 #define DTRACE_PROBE2(a, b, c, d, e) \
173 ZFS_PROBE2(#a, (unsigned long)c, (unsigned long)e)
178 #endif /* DTRACE_PROBE3 */
180 #define DTRACE_PROBE3(a, b, c, d, e, f, g) \
181 ZFS_PROBE3(#a, (unsigned long)c, (unsigned long)e, (unsigned long)g)
186 #endif /* DTRACE_PROBE4 */
188 #define DTRACE_PROBE4(a, b, c, d, e, f, g, h, i) \
189 ZFS_PROBE4(#a, (unsigned long)c, (unsigned long)e, (unsigned long)g, \
195 * We use the comma operator so that this macro can be used without much
196 * additional code. For example, "return (EINVAL);" becomes
197 * "return (SET_ERROR(EINVAL));". Note that the argument will be evaluated
198 * twice, so it should not have side effects (e.g. something like:
199 * "return (SET_ERROR(log_error(EINVAL, info)));" would log the error twice).
201 #define SET_ERROR(err) (ZFS_SET_ERROR(err), err)
204 #define DTRACE_PROBE(a) ((void)0)
205 #define DTRACE_PROBE1(a, b, c) ((void)0)
206 #define DTRACE_PROBE2(a, b, c, d, e) ((void)0)
207 #define DTRACE_PROBE3(a, b, c, d, e, f, g) ((void)0)
208 #define DTRACE_PROBE4(a, b, c, d, e, f, g, h, i) ((void)0)
210 #define SET_ERROR(err) (err)
211 #endif /* !illumos */
216 #define curthread ((void *)(uintptr_t)thr_self())
218 #define kpreempt(x) sched_yield()
220 typedef struct kthread kthread_t;
222 #define thread_create(stk, stksize, func, arg, len, pp, state, pri) \
223 zk_thread_create(func, arg)
224 #define thread_exit() thr_exit(NULL)
225 #define thread_join(t) panic("libzpool cannot join threads")
227 #define newproc(f, a, cid, pri, ctp, pid) (ENOSYS)
229 /* in libzpool, p0 exists only to have its address taken */
231 uintptr_t this_is_never_used_dont_dereference_it;
234 extern struct proc p0;
235 #define curproc (&p0)
239 extern kthread_t *zk_thread_create(void (*func)(), void *arg);
241 #define issig(why) (FALSE)
242 #define ISSIG(thr, why) (FALSE)
247 typedef struct kmutex {
249 boolean_t initialized;
253 #define MUTEX_DEFAULT USYNC_THREAD
255 #undef MUTEX_NOT_HELD
256 #define MUTEX_HELD(m) ((m)->m_owner == curthread)
257 #define MUTEX_NOT_HELD(m) (!MUTEX_HELD(m))
258 #define _mutex_held(m) pthread_mutex_isowned_np(m)
261 * Argh -- we have to get cheesy here because the kernel and userland
262 * have different signatures for the same routine.
264 //extern int _mutex_init(mutex_t *mp, int type, void *arg);
265 //extern int _mutex_destroy(mutex_t *mp);
266 //extern int _mutex_owned(mutex_t *mp);
268 #define mutex_init(mp, b, c, d) zmutex_init((kmutex_t *)(mp))
269 #define mutex_destroy(mp) zmutex_destroy((kmutex_t *)(mp))
270 #define mutex_owned(mp) zmutex_owned((kmutex_t *)(mp))
272 extern void zmutex_init(kmutex_t *mp);
273 extern void zmutex_destroy(kmutex_t *mp);
274 extern int zmutex_owned(kmutex_t *mp);
275 extern void mutex_enter(kmutex_t *mp);
276 extern void mutex_exit(kmutex_t *mp);
277 extern int mutex_tryenter(kmutex_t *mp);
278 extern void *mutex_owner(kmutex_t *mp);
283 typedef struct krwlock {
286 boolean_t initialized;
294 #define RW_DEFAULT USYNC_THREAD
297 #define RW_READ_HELD(x) ((x)->rw_owner == NULL && (x)->rw_count > 0)
300 #define RW_WRITE_HELD(x) ((x)->rw_owner == curthread)
301 #define RW_LOCK_HELD(x) rw_lock_held(x)
304 #define RW_LOCK_HELD(x) (RW_READ_HELD(x) || RW_WRITE_HELD(x))
306 extern void rw_init(krwlock_t *rwlp, char *name, int type, void *arg);
307 extern void rw_destroy(krwlock_t *rwlp);
308 extern void rw_enter(krwlock_t *rwlp, krw_t rw);
309 extern int rw_tryenter(krwlock_t *rwlp, krw_t rw);
310 extern int rw_tryupgrade(krwlock_t *rwlp);
311 extern void rw_exit(krwlock_t *rwlp);
312 extern int rw_lock_held(krwlock_t *rwlp);
313 #define rw_downgrade(rwlp) do { } while (0)
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);
322 * Condition variables
324 typedef cond_t kcondvar_t;
326 #define CV_DEFAULT USYNC_THREAD
328 extern void cv_init(kcondvar_t *cv, char *name, int type, void *arg);
329 extern void cv_destroy(kcondvar_t *cv);
330 extern void cv_wait(kcondvar_t *cv, kmutex_t *mp);
331 extern clock_t cv_timedwait(kcondvar_t *cv, kmutex_t *mp, clock_t abstime);
332 extern clock_t cv_timedwait_hires(kcondvar_t *cvp, kmutex_t *mp, hrtime_t tim,
333 hrtime_t res, int flag);
334 extern void cv_signal(kcondvar_t *cv);
335 extern void cv_broadcast(kcondvar_t *cv);
338 * Thread-specific data
340 #define tsd_get(k) pthread_getspecific(k)
341 #define tsd_set(k, v) pthread_setspecific(k, v)
342 #define tsd_create(kp, d) pthread_key_create(kp, d)
343 #define tsd_destroy(kp) /* nothing */
348 #define KM_SLEEP UMEM_NOFAIL
349 #define KM_PUSHPAGE KM_SLEEP
350 #define KM_NOSLEEP UMEM_DEFAULT
351 #define KMC_NODEBUG UMC_NODEBUG
352 #define KMC_NOTOUCH 0 /* not needed for userland caches */
354 #define kmem_alloc(_s, _f) umem_alloc(_s, _f)
355 #define kmem_zalloc(_s, _f) umem_zalloc(_s, _f)
356 #define kmem_free(_b, _s) umem_free(_b, _s)
357 #define kmem_size() (physmem * PAGESIZE)
358 #define kmem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i) \
359 umem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i)
360 #define kmem_cache_destroy(_c) umem_cache_destroy(_c)
361 #define kmem_cache_alloc(_c, _f) umem_cache_alloc(_c, _f)
362 #define kmem_cache_free(_c, _b) umem_cache_free(_c, _b)
363 #define kmem_debugging() 0
364 #define kmem_cache_reap_now(_c) /* nothing */
365 #define kmem_cache_set_move(_c, _cb) /* nothing */
366 #define POINTER_INVALIDATE(_pp) /* nothing */
367 #define POINTER_IS_VALID(_p) 0
369 typedef umem_cache_t kmem_cache_t;
371 typedef enum kmem_cbrc {
382 typedef struct taskq taskq_t;
383 typedef uintptr_t taskqid_t;
384 typedef void (task_func_t)(void *);
386 typedef struct taskq_ent {
387 struct taskq_ent *tqent_next;
388 struct taskq_ent *tqent_prev;
389 task_func_t *tqent_func;
391 uintptr_t tqent_flags;
394 #define TQENT_FLAG_PREALLOC 0x1 /* taskq_dispatch_ent used */
396 #define TASKQ_PREPOPULATE 0x0001
397 #define TASKQ_CPR_SAFE 0x0002 /* Use CPR safe protocol */
398 #define TASKQ_DYNAMIC 0x0004 /* Use dynamic thread scheduling */
399 #define TASKQ_THREADS_CPU_PCT 0x0008 /* Scale # threads by # cpus */
400 #define TASKQ_DC_BATCH 0x0010 /* Mark threads as batch */
402 #define TQ_SLEEP KM_SLEEP /* Can block for memory */
403 #define TQ_NOSLEEP KM_NOSLEEP /* cannot block for memory; may fail */
404 #define TQ_NOQUEUE 0x02 /* Do not enqueue if can't dispatch */
405 #define TQ_FRONT 0x08 /* Queue in front */
408 extern taskq_t *system_taskq;
410 extern taskq_t *taskq_create(const char *, int, pri_t, int, int, uint_t);
411 #define taskq_create_proc(a, b, c, d, e, p, f) \
412 (taskq_create(a, b, c, d, e, f))
413 #define taskq_create_sysdc(a, b, d, e, p, dc, f) \
414 (taskq_create(a, b, maxclsyspri, d, e, f))
415 extern taskqid_t taskq_dispatch(taskq_t *, task_func_t, void *, uint_t);
416 extern void taskq_dispatch_ent(taskq_t *, task_func_t, void *, uint_t,
418 extern void taskq_destroy(taskq_t *);
419 extern void taskq_wait(taskq_t *);
420 extern int taskq_member(taskq_t *, void *);
421 extern void system_taskq_init(void);
422 extern void system_taskq_fini(void);
424 #define taskq_dispatch_safe(tq, func, arg, flags, task) \
425 taskq_dispatch((tq), (func), (arg), (flags))
427 #define XVA_MAPSIZE 3
428 #define XVA_MAGIC 0x78766174
433 typedef struct vnode {
440 extern char *vn_dumpdir;
441 #define AV_SCANSTAMP_SZ 32 /* length of anti-virus scanstamp */
443 typedef struct xoptattr {
444 timestruc_t xoa_createtime; /* Create time of file */
447 uint8_t xoa_readonly;
449 uint8_t xoa_nounlink;
450 uint8_t xoa_immutable;
451 uint8_t xoa_appendonly;
453 uint8_t xoa_settable;
455 uint8_t xoa_av_quarantined;
456 uint8_t xoa_av_modified;
457 uint8_t xoa_av_scanstamp[AV_SCANSTAMP_SZ];
463 typedef struct vattr {
464 uint_t va_mask; /* bit-mask of attributes */
465 u_offset_t va_size; /* file size in bytes */
469 typedef struct xvattr {
470 vattr_t xva_vattr; /* Embedded vattr structure */
471 uint32_t xva_magic; /* Magic Number */
472 uint32_t xva_mapsize; /* Size of attr bitmap (32-bit words) */
473 uint32_t *xva_rtnattrmapp; /* Ptr to xva_rtnattrmap[] */
474 uint32_t xva_reqattrmap[XVA_MAPSIZE]; /* Requested attrs */
475 uint32_t xva_rtnattrmap[XVA_MAPSIZE]; /* Returned attrs */
476 xoptattr_t xva_xoptattrs; /* Optional attributes */
479 typedef struct vsecattr {
480 uint_t vsa_mask; /* See below */
481 int vsa_aclcnt; /* ACL entry count */
482 void *vsa_aclentp; /* pointer to ACL entries */
483 int vsa_dfaclcnt; /* default ACL entry count */
484 void *vsa_dfaclentp; /* pointer to default ACL entries */
485 size_t vsa_aclentsz; /* ACE size in bytes of vsa_aclentp */
488 #define AT_TYPE 0x00001
489 #define AT_MODE 0x00002
490 #define AT_UID 0x00004
491 #define AT_GID 0x00008
492 #define AT_FSID 0x00010
493 #define AT_NODEID 0x00020
494 #define AT_NLINK 0x00040
495 #define AT_SIZE 0x00080
496 #define AT_ATIME 0x00100
497 #define AT_MTIME 0x00200
498 #define AT_CTIME 0x00400
499 #define AT_RDEV 0x00800
500 #define AT_BLKSIZE 0x01000
501 #define AT_NBLOCKS 0x02000
502 #define AT_SEQ 0x08000
503 #define AT_XVATTR 0x10000
507 extern int fop_getattr(vnode_t *vp, vattr_t *vap);
509 #define VOP_CLOSE(vp, f, c, o, cr, ct) 0
510 #define VOP_PUTPAGE(vp, of, sz, fl, cr, ct) 0
511 #define VOP_GETATTR(vp, vap, cr) fop_getattr((vp), (vap));
513 #define VOP_FSYNC(vp, f, cr, ct) fsync((vp)->v_fd)
515 #define VN_RELE(vp) vn_close(vp, 0, NULL, NULL)
516 #define VN_RELE_ASYNC(vp, taskq) vn_close(vp, 0, NULL, NULL)
518 #define vn_lock(vp, type)
519 #define VOP_UNLOCK(vp, type)
521 extern int vn_open(char *path, int x1, int oflags, int mode, vnode_t **vpp,
523 extern int vn_openat(char *path, int x1, int oflags, int mode, vnode_t **vpp,
524 int x2, int x3, vnode_t *vp, int fd);
525 extern int vn_rdwr(int uio, vnode_t *vp, void *addr, ssize_t len,
526 offset_t offset, int x1, int x2, rlim64_t x3, void *x4, ssize_t *residp);
527 extern void vn_close(vnode_t *vp, int openflag, cred_t *cr, kthread_t *td);
529 #define vn_remove(path, x1, x2) remove(path)
530 #define vn_rename(from, to, seg) rename((from), (to))
531 #define vn_is_readonly(vp) B_FALSE
533 extern vnode_t *rootdir;
535 #include <sys/file.h> /* for FREAD, FWRITE, etc */
536 #define FTRUNC O_TRUNC
541 #define ddi_get_lbolt() (gethrtime() >> 23)
542 #define ddi_get_lbolt64() (gethrtime() >> 23)
543 #define hz 119 /* frequency when using gethrtime() >> 23 for lbolt */
545 extern void delay(clock_t ticks);
547 #define SEC_TO_TICK(sec) ((sec) * hz)
548 #define NSEC_TO_TICK(usec) ((usec) / (NANOSEC / hz))
550 #define gethrestime_sec() time(NULL)
551 #define gethrestime(t) \
553 (t)->tv_sec = gethrestime_sec();\
559 #define minclsyspri 60
560 #define maxclsyspri 99
562 #define CPU_SEQID (thr_self() & (max_ncpus - 1))
568 #define ptob(x) ((x) * PAGESIZE)
571 extern uint64_t physmem;
573 extern int highbit64(uint64_t i);
574 extern int random_get_bytes(uint8_t *ptr, size_t len);
575 extern int random_get_pseudo_bytes(uint8_t *ptr, size_t len);
577 extern void kernel_init(int);
578 extern void kernel_fini(void);
581 extern void nicenum(uint64_t num, char *buf);
582 extern void show_pool_stats(struct spa *);
584 typedef struct callb_cpr {
588 #define CALLB_CPR_INIT(cp, lockp, func, name) { \
589 (cp)->cc_lockp = lockp; \
592 #define CALLB_CPR_SAFE_BEGIN(cp) { \
593 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
596 #define CALLB_CPR_SAFE_END(cp, lockp) { \
597 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
600 #define CALLB_CPR_EXIT(cp) { \
601 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
602 mutex_exit((cp)->cc_lockp); \
605 #define zone_dataset_visible(x, y) (1)
606 #define INGLOBALZONE(z) (1)
608 extern char *kmem_asprintf(const char *fmt, ...);
609 #define strfree(str) kmem_free((str), strlen(str) + 1)
612 * Hostname information
614 extern struct utsname utsname;
615 extern char hw_serial[]; /* for userland-emulated hostid access */
616 extern int ddi_strtoul(const char *str, char **nptr, int base,
617 unsigned long *result);
619 extern int ddi_strtoull(const char *str, char **nptr, int base,
620 u_longlong_t *result);
622 /* ZFS Boot Related stuff. */
632 typedef struct ace_object {
634 uint32_t a_access_mask;
637 uint8_t a_obj_type[16];
638 uint8_t a_inherit_obj_type[16];
642 #define ACE_ACCESS_ALLOWED_OBJECT_ACE_TYPE 0x05
643 #define ACE_ACCESS_DENIED_OBJECT_ACE_TYPE 0x06
644 #define ACE_SYSTEM_AUDIT_OBJECT_ACE_TYPE 0x07
645 #define ACE_SYSTEM_ALARM_OBJECT_ACE_TYPE 0x08
647 extern struct _buf *kobj_open_file(char *name);
648 extern int kobj_read_file(struct _buf *file, char *buf, unsigned size,
650 extern void kobj_close_file(struct _buf *file);
651 extern int kobj_get_filesize(struct _buf *file, uint64_t *size);
652 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
653 extern int zfs_secpolicy_rename_perms(const char *from, const char *to,
655 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
656 extern zoneid_t getzoneid(void);
657 /* Random compatibility stuff. */
658 #define pwrite64(d, p, n, o) pwrite(d, p, n, o)
659 #define readdir64(d) readdir(d)
660 #define SIGPENDING(td) (0)
661 #define root_mount_wait() do { } while (0)
662 #define root_mounted() (1)
668 #define FCREAT O_CREAT
672 typedef struct ksiddomain {
678 ksiddomain_t *ksid_lookupdomain(const char *);
679 void ksiddomain_rele(ksiddomain_t *);
681 typedef uint32_t idmap_rid_t;
683 #define DDI_SLEEP KM_SLEEP
684 #define ddi_log_sysevent(_a, _b, _c, _d, _e, _f, _g) (0)
686 #define SX_SYSINIT(name, lock, desc)
688 #define SYSCTL_HANDLER_ARGS struct sysctl_oid *oidp, void *arg1, \
689 intptr_t arg2, struct sysctl_req *req
692 * This describes the access space for a sysctl request. This is needed
693 * so that we can use the interface from the kernel or from user-space.
696 struct thread *td; /* used for access checking */
697 int lock; /* wiring state */
701 int (*oldfunc)(struct sysctl_req *, const void *, size_t);
705 int (*newfunc)(struct sysctl_req *, void *, size_t);
710 SLIST_HEAD(sysctl_oid_list, sysctl_oid);
713 * This describes one "oid" in the MIB tree. Potentially more nodes can
714 * be hidden behind it, expanded by the handler.
717 struct sysctl_oid_list *oid_parent;
718 SLIST_ENTRY(sysctl_oid) oid_link;
723 const char *oid_name;
724 int (*oid_handler)(SYSCTL_HANDLER_ARGS);
728 const char *oid_descr;
731 #define SYSCTL_DECL(...)
732 #define SYSCTL_NODE(...)
733 #define SYSCTL_INT(...)
734 #define SYSCTL_UINT(...)
735 #define SYSCTL_ULONG(...)
736 #define SYSCTL_PROC(...)
737 #define SYSCTL_QUAD(...)
738 #define SYSCTL_UQUAD(...)
744 #define TUNABLE_INT(...)
745 #define TUNABLE_ULONG(...)
746 #define TUNABLE_QUAD(...)
748 int sysctl_handle_64(SYSCTL_HANDLER_ARGS);
753 #define ERESTART (-1)
760 extern kmutex_t cpu_lock;
762 typedef uintptr_t cyclic_id_t;
763 typedef uint16_t cyc_level_t;
764 typedef void (*cyc_func_t)(void *);
766 #define CY_LOW_LEVEL 0
767 #define CY_INFINITY INT64_MAX
768 #define CYCLIC_NONE ((cyclic_id_t)0)
770 typedef struct cyc_time {
772 hrtime_t cyt_interval;
775 typedef struct cyc_handler {
778 cyc_level_t cyh_level;
781 extern cyclic_id_t cyclic_add(cyc_handler_t *, cyc_time_t *);
782 extern void cyclic_remove(cyclic_id_t);
783 extern int cyclic_reprogram(cyclic_id_t, hrtime_t);
790 #define B_BUSY 0x0001
791 #define B_DONE 0x0002
792 #define B_ERROR 0x0004
793 #define B_READ 0x0040 /* read when I/O occurs */
794 #define B_WRITE 0x0100 /* non-read pseudo-flag */
804 #define b_lblkno _b_blkno._f
807 int (*b_iodone)(struct buf *);
812 extern void bioinit(buf_t *);
813 extern void biodone(buf_t *);
814 extern void bioerror(buf_t *, int);
815 extern int geterror(buf_t *);
822 #endif /* _SYS_ZFS_CONTEXT_H */