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 * kernel. If they're being used in kernel code, re-define them out of
139 * existence for their counterparts in libzpool.
144 #endif /* DTRACE_PROBE */
146 #define DTRACE_PROBE(a) \
152 #endif /* DTRACE_PROBE1 */
154 #define DTRACE_PROBE1(a, b, c) \
155 ZFS_PROBE1(#a, (unsigned long)c)
160 #endif /* DTRACE_PROBE2 */
162 #define DTRACE_PROBE2(a, b, c, d, e) \
163 ZFS_PROBE2(#a, (unsigned long)c, (unsigned long)e)
168 #endif /* DTRACE_PROBE3 */
170 #define DTRACE_PROBE3(a, b, c, d, e, f, g) \
171 ZFS_PROBE3(#a, (unsigned long)c, (unsigned long)e, (unsigned long)g)
176 #endif /* DTRACE_PROBE4 */
178 #define DTRACE_PROBE4(a, b, c, d, e, f, g, h, i) \
179 ZFS_PROBE4(#a, (unsigned long)c, (unsigned long)e, (unsigned long)g, \
185 * We use the comma operator so that this macro can be used without much
186 * additional code. For example, "return (EINVAL);" becomes
187 * "return (SET_ERROR(EINVAL));". Note that the argument will be evaluated
188 * twice, so it should not have side effects (e.g. something like:
189 * "return (SET_ERROR(log_error(EINVAL, info)));" would log the error twice).
191 #define SET_ERROR(err) (ZFS_SET_ERROR(err), err)
194 #define DTRACE_PROBE(a) ((void)0)
195 #define DTRACE_PROBE1(a, b, c) ((void)0)
196 #define DTRACE_PROBE2(a, b, c, d, e) ((void)0)
197 #define DTRACE_PROBE3(a, b, c, d, e, f, g) ((void)0)
198 #define DTRACE_PROBE4(a, b, c, d, e, f, g, h, i) ((void)0)
200 #define SET_ERROR(err) (err)
201 #endif /* !illumos */
206 #define curthread ((void *)(uintptr_t)thr_self())
208 #define kpreempt(x) sched_yield()
210 typedef struct kthread kthread_t;
212 #define thread_create(stk, stksize, func, arg, len, pp, state, pri) \
213 zk_thread_create(func, arg)
214 #define thread_exit() thr_exit(NULL)
215 #define thread_join(t) panic("libzpool cannot join threads")
217 #define newproc(f, a, cid, pri, ctp, pid) (ENOSYS)
219 /* in libzpool, p0 exists only to have its address taken */
221 uintptr_t this_is_never_used_dont_dereference_it;
224 extern struct proc p0;
225 #define curproc (&p0)
229 extern kthread_t *zk_thread_create(void (*func)(), void *arg);
231 #define issig(why) (FALSE)
232 #define ISSIG(thr, why) (FALSE)
237 typedef struct kmutex {
239 boolean_t initialized;
243 #define MUTEX_DEFAULT USYNC_THREAD
245 #undef MUTEX_NOT_HELD
246 #define MUTEX_HELD(m) ((m)->m_owner == curthread)
247 #define MUTEX_NOT_HELD(m) (!MUTEX_HELD(m))
248 #define _mutex_held(m) pthread_mutex_isowned_np(m)
251 * Argh -- we have to get cheesy here because the kernel and userland
252 * have different signatures for the same routine.
254 //extern int _mutex_init(mutex_t *mp, int type, void *arg);
255 //extern int _mutex_destroy(mutex_t *mp);
256 //extern int _mutex_owned(mutex_t *mp);
258 #define mutex_init(mp, b, c, d) zmutex_init((kmutex_t *)(mp))
259 #define mutex_destroy(mp) zmutex_destroy((kmutex_t *)(mp))
260 #define mutex_owned(mp) zmutex_owned((kmutex_t *)(mp))
262 extern void zmutex_init(kmutex_t *mp);
263 extern void zmutex_destroy(kmutex_t *mp);
264 extern int zmutex_owned(kmutex_t *mp);
265 extern void mutex_enter(kmutex_t *mp);
266 extern void mutex_exit(kmutex_t *mp);
267 extern int mutex_tryenter(kmutex_t *mp);
268 extern void *mutex_owner(kmutex_t *mp);
273 typedef struct krwlock {
276 boolean_t initialized;
284 #define RW_DEFAULT USYNC_THREAD
287 #define RW_READ_HELD(x) ((x)->rw_owner == NULL && (x)->rw_count > 0)
290 #define RW_WRITE_HELD(x) ((x)->rw_owner == curthread)
291 #define RW_LOCK_HELD(x) rw_lock_held(x)
294 #define RW_LOCK_HELD(x) (RW_READ_HELD(x) || RW_WRITE_HELD(x))
296 extern void rw_init(krwlock_t *rwlp, char *name, int type, void *arg);
297 extern void rw_destroy(krwlock_t *rwlp);
298 extern void rw_enter(krwlock_t *rwlp, krw_t rw);
299 extern int rw_tryenter(krwlock_t *rwlp, krw_t rw);
300 extern int rw_tryupgrade(krwlock_t *rwlp);
301 extern void rw_exit(krwlock_t *rwlp);
302 extern int rw_lock_held(krwlock_t *rwlp);
303 #define rw_downgrade(rwlp) do { } while (0)
305 extern uid_t crgetuid(cred_t *cr);
306 extern uid_t crgetruid(cred_t *cr);
307 extern gid_t crgetgid(cred_t *cr);
308 extern int crgetngroups(cred_t *cr);
309 extern gid_t *crgetgroups(cred_t *cr);
312 * Condition variables
314 typedef cond_t kcondvar_t;
316 #define CV_DEFAULT USYNC_THREAD
318 extern void cv_init(kcondvar_t *cv, char *name, int type, void *arg);
319 extern void cv_destroy(kcondvar_t *cv);
320 extern void cv_wait(kcondvar_t *cv, kmutex_t *mp);
321 extern clock_t cv_timedwait(kcondvar_t *cv, kmutex_t *mp, clock_t abstime);
322 extern clock_t cv_timedwait_hires(kcondvar_t *cvp, kmutex_t *mp, hrtime_t tim,
323 hrtime_t res, int flag);
324 extern void cv_signal(kcondvar_t *cv);
325 extern void cv_broadcast(kcondvar_t *cv);
328 * Thread-specific data
330 #define tsd_get(k) pthread_getspecific(k)
331 #define tsd_set(k, v) pthread_setspecific(k, v)
332 #define tsd_create(kp, d) pthread_key_create(kp, d)
333 #define tsd_destroy(kp) /* nothing */
338 #define KM_SLEEP UMEM_NOFAIL
339 #define KM_PUSHPAGE KM_SLEEP
340 #define KM_NOSLEEP UMEM_DEFAULT
341 #define KMC_NODEBUG UMC_NODEBUG
342 #define KMC_NOTOUCH 0 /* not needed for userland caches */
344 #define kmem_alloc(_s, _f) umem_alloc(_s, _f)
345 #define kmem_zalloc(_s, _f) umem_zalloc(_s, _f)
346 #define kmem_free(_b, _s) umem_free(_b, _s)
347 #define kmem_size() (physmem * PAGESIZE)
348 #define kmem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i) \
349 umem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i)
350 #define kmem_cache_destroy(_c) umem_cache_destroy(_c)
351 #define kmem_cache_alloc(_c, _f) umem_cache_alloc(_c, _f)
352 #define kmem_cache_free(_c, _b) umem_cache_free(_c, _b)
353 #define kmem_debugging() 0
354 #define kmem_cache_reap_now(_c) /* nothing */
355 #define kmem_cache_set_move(_c, _cb) /* nothing */
356 #define POINTER_INVALIDATE(_pp) /* nothing */
357 #define POINTER_IS_VALID(_p) 0
359 typedef umem_cache_t kmem_cache_t;
361 typedef enum kmem_cbrc {
372 typedef struct taskq taskq_t;
373 typedef uintptr_t taskqid_t;
374 typedef void (task_func_t)(void *);
376 typedef struct taskq_ent {
377 struct taskq_ent *tqent_next;
378 struct taskq_ent *tqent_prev;
379 task_func_t *tqent_func;
381 uintptr_t tqent_flags;
384 #define TQENT_FLAG_PREALLOC 0x1 /* taskq_dispatch_ent used */
386 #define TASKQ_PREPOPULATE 0x0001
387 #define TASKQ_CPR_SAFE 0x0002 /* Use CPR safe protocol */
388 #define TASKQ_DYNAMIC 0x0004 /* Use dynamic thread scheduling */
389 #define TASKQ_THREADS_CPU_PCT 0x0008 /* Scale # threads by # cpus */
390 #define TASKQ_DC_BATCH 0x0010 /* Mark threads as batch */
392 #define TQ_SLEEP KM_SLEEP /* Can block for memory */
393 #define TQ_NOSLEEP KM_NOSLEEP /* cannot block for memory; may fail */
394 #define TQ_NOQUEUE 0x02 /* Do not enqueue if can't dispatch */
395 #define TQ_FRONT 0x08 /* Queue in front */
398 extern taskq_t *system_taskq;
400 extern taskq_t *taskq_create(const char *, int, pri_t, int, int, uint_t);
401 #define taskq_create_proc(a, b, c, d, e, p, f) \
402 (taskq_create(a, b, c, d, e, f))
403 #define taskq_create_sysdc(a, b, d, e, p, dc, f) \
404 (taskq_create(a, b, maxclsyspri, d, e, f))
405 extern taskqid_t taskq_dispatch(taskq_t *, task_func_t, void *, uint_t);
406 extern void taskq_dispatch_ent(taskq_t *, task_func_t, void *, uint_t,
408 extern void taskq_destroy(taskq_t *);
409 extern void taskq_wait(taskq_t *);
410 extern int taskq_member(taskq_t *, void *);
411 extern void system_taskq_init(void);
412 extern void system_taskq_fini(void);
414 #define taskq_dispatch_safe(tq, func, arg, flags, task) \
415 taskq_dispatch((tq), (func), (arg), (flags))
417 #define XVA_MAPSIZE 3
418 #define XVA_MAGIC 0x78766174
423 typedef struct vnode {
430 extern char *vn_dumpdir;
431 #define AV_SCANSTAMP_SZ 32 /* length of anti-virus scanstamp */
433 typedef struct xoptattr {
434 timestruc_t xoa_createtime; /* Create time of file */
437 uint8_t xoa_readonly;
439 uint8_t xoa_nounlink;
440 uint8_t xoa_immutable;
441 uint8_t xoa_appendonly;
443 uint8_t xoa_settable;
445 uint8_t xoa_av_quarantined;
446 uint8_t xoa_av_modified;
447 uint8_t xoa_av_scanstamp[AV_SCANSTAMP_SZ];
453 typedef struct vattr {
454 uint_t va_mask; /* bit-mask of attributes */
455 u_offset_t va_size; /* file size in bytes */
459 typedef struct xvattr {
460 vattr_t xva_vattr; /* Embedded vattr structure */
461 uint32_t xva_magic; /* Magic Number */
462 uint32_t xva_mapsize; /* Size of attr bitmap (32-bit words) */
463 uint32_t *xva_rtnattrmapp; /* Ptr to xva_rtnattrmap[] */
464 uint32_t xva_reqattrmap[XVA_MAPSIZE]; /* Requested attrs */
465 uint32_t xva_rtnattrmap[XVA_MAPSIZE]; /* Returned attrs */
466 xoptattr_t xva_xoptattrs; /* Optional attributes */
469 typedef struct vsecattr {
470 uint_t vsa_mask; /* See below */
471 int vsa_aclcnt; /* ACL entry count */
472 void *vsa_aclentp; /* pointer to ACL entries */
473 int vsa_dfaclcnt; /* default ACL entry count */
474 void *vsa_dfaclentp; /* pointer to default ACL entries */
475 size_t vsa_aclentsz; /* ACE size in bytes of vsa_aclentp */
478 #define AT_TYPE 0x00001
479 #define AT_MODE 0x00002
480 #define AT_UID 0x00004
481 #define AT_GID 0x00008
482 #define AT_FSID 0x00010
483 #define AT_NODEID 0x00020
484 #define AT_NLINK 0x00040
485 #define AT_SIZE 0x00080
486 #define AT_ATIME 0x00100
487 #define AT_MTIME 0x00200
488 #define AT_CTIME 0x00400
489 #define AT_RDEV 0x00800
490 #define AT_BLKSIZE 0x01000
491 #define AT_NBLOCKS 0x02000
492 #define AT_SEQ 0x08000
493 #define AT_XVATTR 0x10000
497 extern int fop_getattr(vnode_t *vp, vattr_t *vap);
499 #define VOP_CLOSE(vp, f, c, o, cr, ct) 0
500 #define VOP_PUTPAGE(vp, of, sz, fl, cr, ct) 0
501 #define VOP_GETATTR(vp, vap, cr) fop_getattr((vp), (vap));
503 #define VOP_FSYNC(vp, f, cr, ct) fsync((vp)->v_fd)
505 #define VN_RELE(vp) vn_close(vp, 0, NULL, NULL)
506 #define VN_RELE_ASYNC(vp, taskq) vn_close(vp, 0, NULL, NULL)
508 #define vn_lock(vp, type)
509 #define VOP_UNLOCK(vp, type)
511 extern int vn_open(char *path, int x1, int oflags, int mode, vnode_t **vpp,
513 extern int vn_openat(char *path, int x1, int oflags, int mode, vnode_t **vpp,
514 int x2, int x3, vnode_t *vp, int fd);
515 extern int vn_rdwr(int uio, vnode_t *vp, void *addr, ssize_t len,
516 offset_t offset, int x1, int x2, rlim64_t x3, void *x4, ssize_t *residp);
517 extern void vn_close(vnode_t *vp, int openflag, cred_t *cr, kthread_t *td);
519 #define vn_remove(path, x1, x2) remove(path)
520 #define vn_rename(from, to, seg) rename((from), (to))
521 #define vn_is_readonly(vp) B_FALSE
523 extern vnode_t *rootdir;
525 #include <sys/file.h> /* for FREAD, FWRITE, etc */
526 #define FTRUNC O_TRUNC
531 #define ddi_get_lbolt() (gethrtime() >> 23)
532 #define ddi_get_lbolt64() (gethrtime() >> 23)
533 #define hz 119 /* frequency when using gethrtime() >> 23 for lbolt */
535 extern void delay(clock_t ticks);
537 #define SEC_TO_TICK(sec) ((sec) * hz)
538 #define NSEC_TO_TICK(usec) ((usec) / (NANOSEC / hz))
540 #define gethrestime_sec() time(NULL)
541 #define gethrestime(t) \
543 (t)->tv_sec = gethrestime_sec();\
549 #define minclsyspri 60
550 #define maxclsyspri 99
552 #define CPU_SEQID (thr_self() & (max_ncpus - 1))
558 #define ptob(x) ((x) * PAGESIZE)
561 extern uint64_t physmem;
563 extern int highbit64(uint64_t i);
564 extern int random_get_bytes(uint8_t *ptr, size_t len);
565 extern int random_get_pseudo_bytes(uint8_t *ptr, size_t len);
567 extern void kernel_init(int);
568 extern void kernel_fini(void);
571 extern void nicenum(uint64_t num, char *buf);
572 extern void show_pool_stats(struct spa *);
574 typedef struct callb_cpr {
578 #define CALLB_CPR_INIT(cp, lockp, func, name) { \
579 (cp)->cc_lockp = lockp; \
582 #define CALLB_CPR_SAFE_BEGIN(cp) { \
583 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
586 #define CALLB_CPR_SAFE_END(cp, lockp) { \
587 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
590 #define CALLB_CPR_EXIT(cp) { \
591 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
592 mutex_exit((cp)->cc_lockp); \
595 #define zone_dataset_visible(x, y) (1)
596 #define INGLOBALZONE(z) (1)
598 extern char *kmem_asprintf(const char *fmt, ...);
599 #define strfree(str) kmem_free((str), strlen(str) + 1)
602 * Hostname information
604 extern struct utsname utsname;
605 extern char hw_serial[]; /* for userland-emulated hostid access */
606 extern int ddi_strtoul(const char *str, char **nptr, int base,
607 unsigned long *result);
609 extern int ddi_strtoull(const char *str, char **nptr, int base,
610 u_longlong_t *result);
612 /* ZFS Boot Related stuff. */
622 typedef struct ace_object {
624 uint32_t a_access_mask;
627 uint8_t a_obj_type[16];
628 uint8_t a_inherit_obj_type[16];
632 #define ACE_ACCESS_ALLOWED_OBJECT_ACE_TYPE 0x05
633 #define ACE_ACCESS_DENIED_OBJECT_ACE_TYPE 0x06
634 #define ACE_SYSTEM_AUDIT_OBJECT_ACE_TYPE 0x07
635 #define ACE_SYSTEM_ALARM_OBJECT_ACE_TYPE 0x08
637 extern struct _buf *kobj_open_file(char *name);
638 extern int kobj_read_file(struct _buf *file, char *buf, unsigned size,
640 extern void kobj_close_file(struct _buf *file);
641 extern int kobj_get_filesize(struct _buf *file, uint64_t *size);
642 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
643 extern int zfs_secpolicy_rename_perms(const char *from, const char *to,
645 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
646 extern zoneid_t getzoneid(void);
647 /* Random compatibility stuff. */
648 #define lbolt (gethrtime() >> 23)
649 #define lbolt64 (gethrtime() >> 23)
651 extern uint64_t physmem;
653 #define gethrestime_sec() time(NULL)
655 #define pwrite64(d, p, n, o) pwrite(d, p, n, o)
656 #define readdir64(d) readdir(d)
657 #define SIGPENDING(td) (0)
658 #define root_mount_wait() do { } while (0)
659 #define root_mounted() (1)
665 #define FCREAT O_CREAT
669 typedef struct ksiddomain {
675 ksiddomain_t *ksid_lookupdomain(const char *);
676 void ksiddomain_rele(ksiddomain_t *);
678 typedef uint32_t idmap_rid_t;
680 #define DDI_SLEEP KM_SLEEP
681 #define ddi_log_sysevent(_a, _b, _c, _d, _e, _f, _g) (0)
683 #define SX_SYSINIT(name, lock, desc)
685 #define SYSCTL_HANDLER_ARGS struct sysctl_oid *oidp, void *arg1, \
686 intptr_t arg2, struct sysctl_req *req
689 * This describes the access space for a sysctl request. This is needed
690 * so that we can use the interface from the kernel or from user-space.
693 struct thread *td; /* used for access checking */
694 int lock; /* wiring state */
698 int (*oldfunc)(struct sysctl_req *, const void *, size_t);
702 int (*newfunc)(struct sysctl_req *, void *, size_t);
707 SLIST_HEAD(sysctl_oid_list, sysctl_oid);
710 * This describes one "oid" in the MIB tree. Potentially more nodes can
711 * be hidden behind it, expanded by the handler.
714 struct sysctl_oid_list *oid_parent;
715 SLIST_ENTRY(sysctl_oid) oid_link;
720 const char *oid_name;
721 int (*oid_handler)(SYSCTL_HANDLER_ARGS);
725 const char *oid_descr;
728 #define SYSCTL_DECL(...)
729 #define SYSCTL_NODE(...)
730 #define SYSCTL_INT(...)
731 #define SYSCTL_UINT(...)
732 #define SYSCTL_ULONG(...)
733 #define SYSCTL_PROC(...)
734 #define SYSCTL_QUAD(...)
735 #define SYSCTL_UQUAD(...)
741 #define TUNABLE_INT(...)
742 #define TUNABLE_ULONG(...)
743 #define TUNABLE_QUAD(...)
745 int sysctl_handle_64(SYSCTL_HANDLER_ARGS);
750 #define ERESTART (-1)
757 extern kmutex_t cpu_lock;
759 typedef uintptr_t cyclic_id_t;
760 typedef uint16_t cyc_level_t;
761 typedef void (*cyc_func_t)(void *);
763 #define CY_LOW_LEVEL 0
764 #define CY_INFINITY INT64_MAX
765 #define CYCLIC_NONE ((cyclic_id_t)0)
767 typedef struct cyc_time {
769 hrtime_t cyt_interval;
772 typedef struct cyc_handler {
775 cyc_level_t cyh_level;
778 extern cyclic_id_t cyclic_add(cyc_handler_t *, cyc_time_t *);
779 extern void cyclic_remove(cyclic_id_t);
780 extern int cyclic_reprogram(cyclic_id_t, hrtime_t);
787 #define B_BUSY 0x0001
788 #define B_DONE 0x0002
789 #define B_ERROR 0x0004
790 #define B_READ 0x0040 /* read when I/O occurs */
791 #define B_WRITE 0x0100 /* non-read pseudo-flag */
801 #define b_lblkno _b_blkno._f
804 int (*b_iodone)(struct buf *);
809 extern void bioinit(buf_t *);
810 extern void biodone(buf_t *);
811 extern void bioerror(buf_t *, int);
812 extern int geterror(buf_t *);
819 #endif /* _SYS_ZFS_CONTEXT_H */