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) 2013 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
68 #include <sys/debug.h>
70 #include <sys/types.h>
72 #include <sys/atomic.h>
73 #include <sys/sysmacros.h>
74 #include <sys/bitmap.h>
75 #include <sys/resource.h>
76 #include <sys/byteorder.h>
80 #include <sys/mntent.h>
81 #include <sys/mnttab.h>
82 #include <sys/zfs_debug.h>
84 #include <sys/kstat.h>
85 #include <sys/u8_textprep.h>
86 #include <sys/kernel.h>
88 #include <sys/sysevent.h>
89 #include <sys/sysevent/eventdefs.h>
90 #include <sys/sysevent/dev.h>
91 #include <machine/atomic.h>
92 #include <sys/debug.h>
97 #define ZFS_EXPORTS_PATH "/etc/zfs/exports"
104 * Note that we are not using the debugging levels.
107 #define CE_CONT 0 /* continuation */
108 #define CE_NOTE 1 /* notice */
109 #define CE_WARN 2 /* warning */
110 #define CE_PANIC 3 /* panic */
111 #define CE_IGNORE 4 /* print nothing */
117 #define ZFS_LOG(...) do { } while (0)
119 typedef u_longlong_t rlim64_t;
120 #define RLIM64_INFINITY ((rlim64_t)-3)
123 extern void dprintf_setup(int *argc, char **argv);
124 #endif /* ZFS_DEBUG */
126 extern void cmn_err(int, const char *, ...);
127 extern void vcmn_err(int, const char *, __va_list);
128 extern void panic(const char *, ...);
129 extern void vpanic(const char *, __va_list);
131 #define fm_panic panic
136 * DTrace SDT probes have different signatures in userland than they do in
137 * kernel. If they're being used in kernel code, re-define them out of
138 * existence for their counterparts in libzpool.
143 #endif /* DTRACE_PROBE */
145 #define DTRACE_PROBE(a) \
151 #endif /* DTRACE_PROBE1 */
153 #define DTRACE_PROBE1(a, b, c) \
154 ZFS_PROBE1(#a, (unsigned long)c)
159 #endif /* DTRACE_PROBE2 */
161 #define DTRACE_PROBE2(a, b, c, d, e) \
162 ZFS_PROBE2(#a, (unsigned long)c, (unsigned long)e)
167 #endif /* DTRACE_PROBE3 */
169 #define DTRACE_PROBE3(a, b, c, d, e, f, g) \
170 ZFS_PROBE3(#a, (unsigned long)c, (unsigned long)e, (unsigned long)g)
175 #endif /* DTRACE_PROBE4 */
177 #define DTRACE_PROBE4(a, b, c, d, e, f, g, h, i) \
178 ZFS_PROBE4(#a, (unsigned long)c, (unsigned long)e, (unsigned long)g, \
184 * We use the comma operator so that this macro can be used without much
185 * additional code. For example, "return (EINVAL);" becomes
186 * "return (SET_ERROR(EINVAL));". Note that the argument will be evaluated
187 * twice, so it should not have side effects (e.g. something like:
188 * "return (SET_ERROR(log_error(EINVAL, info)));" would log the error twice).
190 #define SET_ERROR(err) (ZFS_SET_ERROR(err), err)
193 #define DTRACE_PROBE(a) ((void)0)
194 #define DTRACE_PROBE1(a, b, c) ((void)0)
195 #define DTRACE_PROBE2(a, b, c, d, e) ((void)0)
196 #define DTRACE_PROBE3(a, b, c, d, e, f, g) ((void)0)
197 #define DTRACE_PROBE4(a, b, c, d, e, f, g, h, i) ((void)0)
199 #define SET_ERROR(err) (err)
200 #endif /* !illumos */
205 #define curthread ((void *)(uintptr_t)thr_self())
207 typedef struct kthread kthread_t;
209 #define thread_create(stk, stksize, func, arg, len, pp, state, pri) \
210 zk_thread_create(func, arg)
211 #define thread_exit() thr_exit(NULL)
212 #define thread_join(t) panic("libzpool cannot join threads")
214 #define newproc(f, a, cid, pri, ctp, pid) (ENOSYS)
216 /* in libzpool, p0 exists only to have its address taken */
218 uintptr_t this_is_never_used_dont_dereference_it;
221 extern struct proc p0;
222 #define curproc (&p0)
226 extern kthread_t *zk_thread_create(void (*func)(), void *arg);
228 #define issig(why) (FALSE)
229 #define ISSIG(thr, why) (FALSE)
234 typedef struct kmutex {
236 boolean_t initialized;
240 #define MUTEX_DEFAULT USYNC_THREAD
242 #undef MUTEX_NOT_HELD
243 #define MUTEX_HELD(m) ((m)->m_owner == curthread)
244 #define MUTEX_NOT_HELD(m) (!MUTEX_HELD(m))
245 #define _mutex_held(m) pthread_mutex_isowned_np(m)
248 * Argh -- we have to get cheesy here because the kernel and userland
249 * have different signatures for the same routine.
251 //extern int _mutex_init(mutex_t *mp, int type, void *arg);
252 //extern int _mutex_destroy(mutex_t *mp);
253 //extern int _mutex_owned(mutex_t *mp);
255 #define mutex_init(mp, b, c, d) zmutex_init((kmutex_t *)(mp))
256 #define mutex_destroy(mp) zmutex_destroy((kmutex_t *)(mp))
257 #define mutex_owned(mp) zmutex_owned((kmutex_t *)(mp))
259 extern void zmutex_init(kmutex_t *mp);
260 extern void zmutex_destroy(kmutex_t *mp);
261 extern int zmutex_owned(kmutex_t *mp);
262 extern void mutex_enter(kmutex_t *mp);
263 extern void mutex_exit(kmutex_t *mp);
264 extern int mutex_tryenter(kmutex_t *mp);
265 extern void *mutex_owner(kmutex_t *mp);
270 typedef struct krwlock {
273 boolean_t initialized;
281 #define RW_DEFAULT USYNC_THREAD
284 #define RW_READ_HELD(x) ((x)->rw_owner == NULL && (x)->rw_count > 0)
287 #define RW_WRITE_HELD(x) ((x)->rw_owner == curthread)
288 #define RW_LOCK_HELD(x) rw_lock_held(x)
291 #define RW_LOCK_HELD(x) (RW_READ_HELD(x) || RW_WRITE_HELD(x))
293 extern void rw_init(krwlock_t *rwlp, char *name, int type, void *arg);
294 extern void rw_destroy(krwlock_t *rwlp);
295 extern void rw_enter(krwlock_t *rwlp, krw_t rw);
296 extern int rw_tryenter(krwlock_t *rwlp, krw_t rw);
297 extern int rw_tryupgrade(krwlock_t *rwlp);
298 extern void rw_exit(krwlock_t *rwlp);
299 extern int rw_lock_held(krwlock_t *rwlp);
300 #define rw_downgrade(rwlp) do { } while (0)
302 extern uid_t crgetuid(cred_t *cr);
303 extern uid_t crgetruid(cred_t *cr);
304 extern gid_t crgetgid(cred_t *cr);
305 extern int crgetngroups(cred_t *cr);
306 extern gid_t *crgetgroups(cred_t *cr);
309 * Condition variables
311 typedef cond_t kcondvar_t;
313 #define CV_DEFAULT USYNC_THREAD
315 extern void cv_init(kcondvar_t *cv, char *name, int type, void *arg);
316 extern void cv_destroy(kcondvar_t *cv);
317 extern void cv_wait(kcondvar_t *cv, kmutex_t *mp);
318 extern clock_t cv_timedwait(kcondvar_t *cv, kmutex_t *mp, clock_t abstime);
319 extern void cv_signal(kcondvar_t *cv);
320 extern void cv_broadcast(kcondvar_t *cv);
323 * Thread-specific data
325 #define tsd_get(k) pthread_getspecific(k)
326 #define tsd_set(k, v) pthread_setspecific(k, v)
327 #define tsd_create(kp, d) pthread_key_create(kp, d)
328 #define tsd_destroy(kp) /* nothing */
333 #define KM_SLEEP UMEM_NOFAIL
334 #define KM_PUSHPAGE KM_SLEEP
335 #define KM_NOSLEEP UMEM_DEFAULT
337 #define KMC_NODEBUG UMC_NODEBUG
338 #define KMC_NOTOUCH 0 /* not needed for userland caches */
339 #define kmem_alloc(_s, _f) umem_alloc(_s, _f)
340 #define kmem_zalloc(_s, _f) umem_zalloc(_s, _f)
341 #define kmem_free(_b, _s) umem_free(_b, _s)
342 #define kmem_size() (physmem * PAGESIZE)
343 #define kmem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i) \
344 umem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i)
345 #define kmem_cache_destroy(_c) umem_cache_destroy(_c)
346 #define kmem_cache_alloc(_c, _f) umem_cache_alloc(_c, _f)
347 #define kmem_cache_free(_c, _b) umem_cache_free(_c, _b)
348 #define kmem_debugging() 0
349 #define kmem_cache_reap_now(_c) /* nothing */
350 #define kmem_cache_set_move(_c, _cb) /* nothing */
351 #define POINTER_INVALIDATE(_pp) /* nothing */
352 #define POINTER_IS_VALID(_p) 0
354 typedef umem_cache_t kmem_cache_t;
356 typedef enum kmem_cbrc {
367 typedef struct taskq taskq_t;
368 typedef uintptr_t taskqid_t;
369 typedef void (task_func_t)(void *);
371 typedef struct taskq_ent {
372 struct taskq_ent *tqent_next;
373 struct taskq_ent *tqent_prev;
374 task_func_t *tqent_func;
376 uintptr_t tqent_flags;
379 #define TQENT_FLAG_PREALLOC 0x1 /* taskq_dispatch_ent used */
381 #define TASKQ_PREPOPULATE 0x0001
382 #define TASKQ_CPR_SAFE 0x0002 /* Use CPR safe protocol */
383 #define TASKQ_DYNAMIC 0x0004 /* Use dynamic thread scheduling */
384 #define TASKQ_THREADS_CPU_PCT 0x0008 /* Scale # threads by # cpus */
385 #define TASKQ_DC_BATCH 0x0010 /* Mark threads as batch */
387 #define TQ_SLEEP KM_SLEEP /* Can block for memory */
388 #define TQ_NOSLEEP KM_NOSLEEP /* cannot block for memory; may fail */
389 #define TQ_NOQUEUE 0x02 /* Do not enqueue if can't dispatch */
390 #define TQ_FRONT 0x08 /* Queue in front */
393 extern taskq_t *system_taskq;
395 extern taskq_t *taskq_create(const char *, int, pri_t, int, int, uint_t);
396 #define taskq_create_proc(a, b, c, d, e, p, f) \
397 (taskq_create(a, b, c, d, e, f))
398 #define taskq_create_sysdc(a, b, d, e, p, dc, f) \
399 (taskq_create(a, b, maxclsyspri, d, e, f))
400 extern taskqid_t taskq_dispatch(taskq_t *, task_func_t, void *, uint_t);
401 extern void taskq_dispatch_ent(taskq_t *, task_func_t, void *, uint_t,
403 extern void taskq_destroy(taskq_t *);
404 extern void taskq_wait(taskq_t *);
405 extern int taskq_member(taskq_t *, void *);
406 extern void system_taskq_init(void);
407 extern void system_taskq_fini(void);
409 #define taskq_dispatch_safe(tq, func, arg, flags, task) \
410 taskq_dispatch((tq), (func), (arg), (flags))
412 #define XVA_MAPSIZE 3
413 #define XVA_MAGIC 0x78766174
418 typedef struct vnode {
424 #define AV_SCANSTAMP_SZ 32 /* length of anti-virus scanstamp */
426 typedef struct xoptattr {
427 timestruc_t xoa_createtime; /* Create time of file */
430 uint8_t xoa_readonly;
432 uint8_t xoa_nounlink;
433 uint8_t xoa_immutable;
434 uint8_t xoa_appendonly;
436 uint8_t xoa_settable;
438 uint8_t xoa_av_quarantined;
439 uint8_t xoa_av_modified;
440 uint8_t xoa_av_scanstamp[AV_SCANSTAMP_SZ];
446 typedef struct vattr {
447 uint_t va_mask; /* bit-mask of attributes */
448 u_offset_t va_size; /* file size in bytes */
452 typedef struct xvattr {
453 vattr_t xva_vattr; /* Embedded vattr structure */
454 uint32_t xva_magic; /* Magic Number */
455 uint32_t xva_mapsize; /* Size of attr bitmap (32-bit words) */
456 uint32_t *xva_rtnattrmapp; /* Ptr to xva_rtnattrmap[] */
457 uint32_t xva_reqattrmap[XVA_MAPSIZE]; /* Requested attrs */
458 uint32_t xva_rtnattrmap[XVA_MAPSIZE]; /* Returned attrs */
459 xoptattr_t xva_xoptattrs; /* Optional attributes */
462 typedef struct vsecattr {
463 uint_t vsa_mask; /* See below */
464 int vsa_aclcnt; /* ACL entry count */
465 void *vsa_aclentp; /* pointer to ACL entries */
466 int vsa_dfaclcnt; /* default ACL entry count */
467 void *vsa_dfaclentp; /* pointer to default ACL entries */
468 size_t vsa_aclentsz; /* ACE size in bytes of vsa_aclentp */
471 #define AT_TYPE 0x00001
472 #define AT_MODE 0x00002
473 #define AT_UID 0x00004
474 #define AT_GID 0x00008
475 #define AT_FSID 0x00010
476 #define AT_NODEID 0x00020
477 #define AT_NLINK 0x00040
478 #define AT_SIZE 0x00080
479 #define AT_ATIME 0x00100
480 #define AT_MTIME 0x00200
481 #define AT_CTIME 0x00400
482 #define AT_RDEV 0x00800
483 #define AT_BLKSIZE 0x01000
484 #define AT_NBLOCKS 0x02000
485 #define AT_SEQ 0x08000
486 #define AT_XVATTR 0x10000
490 extern int fop_getattr(vnode_t *vp, vattr_t *vap);
492 #define VOP_CLOSE(vp, f, c, o, cr, ct) 0
493 #define VOP_PUTPAGE(vp, of, sz, fl, cr, ct) 0
494 #define VOP_GETATTR(vp, vap, cr) fop_getattr((vp), (vap));
496 #define VOP_FSYNC(vp, f, cr, ct) fsync((vp)->v_fd)
498 #define VN_RELE(vp) vn_close(vp, 0, NULL, NULL)
499 #define VN_RELE_ASYNC(vp, taskq) vn_close(vp, 0, NULL, NULL)
501 #define vn_lock(vp, type)
502 #define VOP_UNLOCK(vp, type)
503 #ifdef VFS_LOCK_GIANT
504 #undef VFS_LOCK_GIANT
506 #define VFS_LOCK_GIANT(mp) 0
507 #ifdef VFS_UNLOCK_GIANT
508 #undef VFS_UNLOCK_GIANT
510 #define VFS_UNLOCK_GIANT(vfslocked)
512 extern int vn_open(char *path, int x1, int oflags, int mode, vnode_t **vpp,
514 extern int vn_openat(char *path, int x1, int oflags, int mode, vnode_t **vpp,
515 int x2, int x3, vnode_t *vp, int fd);
516 extern int vn_rdwr(int uio, vnode_t *vp, void *addr, ssize_t len,
517 offset_t offset, int x1, int x2, rlim64_t x3, void *x4, ssize_t *residp);
518 extern void vn_close(vnode_t *vp, int openflag, cred_t *cr, kthread_t *td);
520 #define vn_remove(path, x1, x2) remove(path)
521 #define vn_rename(from, to, seg) rename((from), (to))
522 #define vn_is_readonly(vp) B_FALSE
524 extern vnode_t *rootdir;
526 #include <sys/file.h> /* for FREAD, FWRITE, etc */
527 #define FTRUNC O_TRUNC
532 #define ddi_get_lbolt() (gethrtime() >> 23)
533 #define ddi_get_lbolt64() (gethrtime() >> 23)
534 #define hz 119 /* frequency when using gethrtime() >> 23 for lbolt */
536 extern void delay(clock_t ticks);
538 #define SEC_TO_TICK(sec) ((sec) * hz)
539 #define NSEC_TO_TICK(usec) ((usec) / (NANOSEC / hz))
541 #define gethrestime_sec() time(NULL)
542 #define gethrestime(t) \
544 (t)->tv_sec = gethrestime_sec();\
550 #define minclsyspri 60
551 #define maxclsyspri 99
553 #define CPU_SEQID (thr_self() & (max_ncpus - 1))
559 #define ptob(x) ((x) * PAGESIZE)
562 extern uint64_t physmem;
564 extern int highbit(ulong_t i);
565 extern int random_get_bytes(uint8_t *ptr, size_t len);
566 extern int random_get_pseudo_bytes(uint8_t *ptr, size_t len);
568 extern void kernel_init(int);
569 extern void kernel_fini(void);
572 extern void nicenum(uint64_t num, char *buf);
573 extern void show_pool_stats(struct spa *);
575 typedef struct callb_cpr {
579 #define CALLB_CPR_INIT(cp, lockp, func, name) { \
580 (cp)->cc_lockp = lockp; \
583 #define CALLB_CPR_SAFE_BEGIN(cp) { \
584 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
587 #define CALLB_CPR_SAFE_END(cp, lockp) { \
588 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
591 #define CALLB_CPR_EXIT(cp) { \
592 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
593 mutex_exit((cp)->cc_lockp); \
596 #define zone_dataset_visible(x, y) (1)
597 #define INGLOBALZONE(z) (1)
599 extern char *kmem_asprintf(const char *fmt, ...);
600 #define strfree(str) kmem_free((str), strlen(str) + 1)
603 * Hostname information
605 extern struct utsname utsname;
606 extern char hw_serial[]; /* for userland-emulated hostid access */
607 extern int ddi_strtoul(const char *str, char **nptr, int base,
608 unsigned long *result);
610 extern int ddi_strtoull(const char *str, char **nptr, int base,
611 u_longlong_t *result);
613 /* ZFS Boot Related stuff. */
623 typedef struct ace_object {
625 uint32_t a_access_mask;
628 uint8_t a_obj_type[16];
629 uint8_t a_inherit_obj_type[16];
633 #define ACE_ACCESS_ALLOWED_OBJECT_ACE_TYPE 0x05
634 #define ACE_ACCESS_DENIED_OBJECT_ACE_TYPE 0x06
635 #define ACE_SYSTEM_AUDIT_OBJECT_ACE_TYPE 0x07
636 #define ACE_SYSTEM_ALARM_OBJECT_ACE_TYPE 0x08
638 extern struct _buf *kobj_open_file(char *name);
639 extern int kobj_read_file(struct _buf *file, char *buf, unsigned size,
641 extern void kobj_close_file(struct _buf *file);
642 extern int kobj_get_filesize(struct _buf *file, uint64_t *size);
643 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
644 extern int zfs_secpolicy_rename_perms(const char *from, const char *to,
646 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
647 extern zoneid_t getzoneid(void);
648 /* Random compatibility stuff. */
649 #define lbolt (gethrtime() >> 23)
650 #define lbolt64 (gethrtime() >> 23)
652 extern uint64_t physmem;
654 #define gethrestime_sec() time(NULL)
656 #define pwrite64(d, p, n, o) pwrite(d, p, n, o)
657 #define readdir64(d) readdir(d)
658 #define SIGPENDING(td) (0)
659 #define root_mount_wait() do { } while (0)
660 #define root_mounted() (1)
666 #define FCREAT O_CREAT
670 typedef struct ksiddomain {
676 ksiddomain_t *ksid_lookupdomain(const char *);
677 void ksiddomain_rele(ksiddomain_t *);
679 typedef uint32_t idmap_rid_t;
681 #define DDI_SLEEP KM_SLEEP
682 #define ddi_log_sysevent(_a, _b, _c, _d, _e, _f, _g) (0)
684 #define SX_SYSINIT(name, lock, desc)
686 #define SYSCTL_DECL(...)
687 #define SYSCTL_NODE(...)
688 #define SYSCTL_INT(...)
689 #define SYSCTL_UINT(...)
690 #define SYSCTL_ULONG(...)
691 #define SYSCTL_QUAD(...)
692 #define SYSCTL_UQUAD(...)
698 #define TUNABLE_INT(...)
699 #define TUNABLE_ULONG(...)
700 #define TUNABLE_QUAD(...)
705 #define ERESTART (-1)
712 extern kmutex_t cpu_lock;
714 typedef uintptr_t cyclic_id_t;
715 typedef uint16_t cyc_level_t;
716 typedef void (*cyc_func_t)(void *);
718 #define CY_LOW_LEVEL 0
719 #define CY_INFINITY INT64_MAX
720 #define CYCLIC_NONE ((cyclic_id_t)0)
722 typedef struct cyc_time {
724 hrtime_t cyt_interval;
727 typedef struct cyc_handler {
730 cyc_level_t cyh_level;
733 extern cyclic_id_t cyclic_add(cyc_handler_t *, cyc_time_t *);
734 extern void cyclic_remove(cyclic_id_t);
735 extern int cyclic_reprogram(cyclic_id_t, hrtime_t);
742 #endif /* _SYS_ZFS_CONTEXT_H */