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.
25 #ifndef _SYS_ZFS_CONTEXT_H
26 #define _SYS_ZFS_CONTEXT_H
34 #define _SYS_CONDVAR_H
64 #include <sys/types.h>
66 #include <sys/atomic.h>
67 #include <sys/sysmacros.h>
68 #include <sys/bitmap.h>
69 #include <sys/resource.h>
70 #include <sys/byteorder.h>
74 #include <sys/mntent.h>
75 #include <sys/mnttab.h>
76 #include <sys/zfs_debug.h>
77 #include <sys/debug.h>
79 #include <sys/kstat.h>
80 #include <sys/u8_textprep.h>
81 #include <sys/kernel.h>
83 #include <sys/sysevent.h>
84 #include <sys/sysevent/eventdefs.h>
85 #include <sys/sysevent/dev.h>
86 #include <machine/atomic.h>
88 #define ZFS_EXPORTS_PATH "/etc/zfs/exports"
95 * Note that we are not using the debugging levels.
98 #define CE_CONT 0 /* continuation */
99 #define CE_NOTE 1 /* notice */
100 #define CE_WARN 2 /* warning */
101 #define CE_PANIC 3 /* panic */
102 #define CE_IGNORE 4 /* print nothing */
108 #define ZFS_LOG(...) do { } while (0)
110 typedef u_longlong_t rlim64_t;
111 #define RLIM64_INFINITY ((rlim64_t)-3)
114 extern void dprintf_setup(int *argc, char **argv);
115 #endif /* ZFS_DEBUG */
117 extern void cmn_err(int, const char *, ...);
118 extern void vcmn_err(int, const char *, __va_list);
119 extern void panic(const char *, ...);
120 extern void vpanic(const char *, __va_list);
122 #define fm_panic panic
126 /* This definition is copied from assert.h. */
127 #if defined(__STDC__)
128 #if __STDC_VERSION__ - 0 >= 199901L
129 #define zverify(EX) (void)((EX) || (aok) || \
130 (__assert(#EX, __FILE__, __LINE__), 0))
132 #define zverify(EX) (void)((EX) || (aok) || \
133 (__assert(#EX, __FILE__, __LINE__), 0))
134 #endif /* __STDC_VERSION__ - 0 >= 199901L */
136 #define zverify(EX) (void)((EX) || (aok) || \
137 (_assert("EX", __FILE__, __LINE__), 0))
138 #endif /* __STDC__ */
141 #define VERIFY zverify
142 #define ASSERT zverify
144 #define assert zverify
146 extern void __assert(const char *, const char *, int);
149 #define VERIFY3_IMPL(x, y, z, t) if (x == z) ((void)0)
152 #define VERIFY3_IMPL(LEFT, OP, RIGHT, TYPE) do { \
153 const TYPE __left = (TYPE)(LEFT); \
154 const TYPE __right = (TYPE)(RIGHT); \
155 if (!(__left OP __right) && (!aok)) { \
156 char *__buf = alloca(256); \
157 (void) snprintf(__buf, 256, "%s %s %s (0x%llx %s 0x%llx)", \
158 #LEFT, #OP, #RIGHT, \
159 (u_longlong_t)__left, #OP, (u_longlong_t)__right); \
160 __assert(__buf, __FILE__, __LINE__); \
162 _NOTE(CONSTCOND) } while (0)
166 #define VERIFY3S(x, y, z) VERIFY3_IMPL(x, y, z, int64_t)
167 #define VERIFY3U(x, y, z) VERIFY3_IMPL(x, y, z, uint64_t)
168 #define VERIFY3P(x, y, z) VERIFY3_IMPL(x, y, z, uintptr_t)
171 #define ASSERT3S(x, y, z) ((void)0)
172 #define ASSERT3U(x, y, z) ((void)0)
173 #define ASSERT3P(x, y, z) ((void)0)
175 #define ASSERT3S(x, y, z) VERIFY3S(x, y, z)
176 #define ASSERT3U(x, y, z) VERIFY3U(x, y, z)
177 #define ASSERT3P(x, y, z) VERIFY3P(x, y, z)
181 * DTrace SDT probes have different signatures in userland than they do in
182 * kernel. If they're being used in kernel code, re-define them out of
183 * existence for their counterparts in libzpool.
188 #define DTRACE_PROBE(a) ((void)0)
189 #endif /* DTRACE_PROBE */
193 #define DTRACE_PROBE1(a, b, c) ((void)0)
194 #endif /* DTRACE_PROBE1 */
198 #define DTRACE_PROBE2(a, b, c, d, e) ((void)0)
199 #endif /* DTRACE_PROBE2 */
203 #define DTRACE_PROBE3(a, b, c, d, e, f, g) ((void)0)
204 #endif /* DTRACE_PROBE3 */
208 #define DTRACE_PROBE4(a, b, c, d, e, f, g, h, i) ((void)0)
209 #endif /* DTRACE_PROBE4 */
214 #define curthread ((void *)(uintptr_t)thr_self())
216 typedef struct kthread kthread_t;
218 #define thread_create(stk, stksize, func, arg, len, pp, state, pri) \
219 zk_thread_create(func, arg)
220 #define thread_exit() thr_exit(NULL)
221 #define thread_join(t) panic("libzpool cannot join threads")
223 #define newproc(f, a, cid, pri, ctp, pid) (ENOSYS)
225 /* in libzpool, p0 exists only to have its address taken */
227 uintptr_t this_is_never_used_dont_dereference_it;
230 extern struct proc p0;
234 extern kthread_t *zk_thread_create(void (*func)(), void *arg);
236 #define issig(why) (FALSE)
237 #define ISSIG(thr, why) (FALSE)
242 typedef struct kmutex {
244 boolean_t initialized;
248 #define MUTEX_DEFAULT USYNC_THREAD
250 #undef MUTEX_NOT_HELD
251 #define MUTEX_HELD(m) ((m)->m_owner == curthread)
252 #define MUTEX_NOT_HELD(m) (!MUTEX_HELD(m))
253 #define _mutex_held(m) pthread_mutex_isowned_np(m)
256 * Argh -- we have to get cheesy here because the kernel and userland
257 * have different signatures for the same routine.
259 //extern int _mutex_init(mutex_t *mp, int type, void *arg);
260 //extern int _mutex_destroy(mutex_t *mp);
261 //extern int _mutex_owned(mutex_t *mp);
263 #define mutex_init(mp, b, c, d) zmutex_init((kmutex_t *)(mp))
264 #define mutex_destroy(mp) zmutex_destroy((kmutex_t *)(mp))
265 #define mutex_owned(mp) zmutex_owned((kmutex_t *)(mp))
267 extern void zmutex_init(kmutex_t *mp);
268 extern void zmutex_destroy(kmutex_t *mp);
269 extern int zmutex_owned(kmutex_t *mp);
270 extern void mutex_enter(kmutex_t *mp);
271 extern void mutex_exit(kmutex_t *mp);
272 extern int mutex_tryenter(kmutex_t *mp);
273 extern void *mutex_owner(kmutex_t *mp);
278 typedef struct krwlock {
281 boolean_t initialized;
289 #define RW_DEFAULT USYNC_THREAD
292 #define RW_READ_HELD(x) ((x)->rw_owner == NULL && (x)->rw_count > 0)
295 #define RW_WRITE_HELD(x) ((x)->rw_owner == curthread)
296 #define RW_LOCK_HELD(x) rw_lock_held(x)
298 extern void rw_init(krwlock_t *rwlp, char *name, int type, void *arg);
299 extern void rw_destroy(krwlock_t *rwlp);
300 extern void rw_enter(krwlock_t *rwlp, krw_t rw);
301 extern int rw_tryenter(krwlock_t *rwlp, krw_t rw);
302 extern int rw_tryupgrade(krwlock_t *rwlp);
303 extern void rw_exit(krwlock_t *rwlp);
304 extern int rw_lock_held(krwlock_t *rwlp);
305 #define rw_downgrade(rwlp) do { } while (0)
307 extern uid_t crgetuid(cred_t *cr);
308 extern gid_t crgetgid(cred_t *cr);
309 extern int crgetngroups(cred_t *cr);
310 extern gid_t *crgetgroups(cred_t *cr);
313 * Condition variables
315 typedef cond_t kcondvar_t;
317 #define CV_DEFAULT USYNC_THREAD
319 extern void cv_init(kcondvar_t *cv, char *name, int type, void *arg);
320 extern void cv_destroy(kcondvar_t *cv);
321 extern void cv_wait(kcondvar_t *cv, kmutex_t *mp);
322 extern clock_t cv_timedwait(kcondvar_t *cv, kmutex_t *mp, clock_t abstime);
323 extern void cv_signal(kcondvar_t *cv);
324 extern void cv_broadcast(kcondvar_t *cv);
329 #define KM_SLEEP UMEM_NOFAIL
330 #define KM_PUSHPAGE KM_SLEEP
331 #define KM_NOSLEEP UMEM_DEFAULT
332 #define KMC_NODEBUG UMC_NODEBUG
333 #define KMC_NOTOUCH 0 /* not needed for userland caches */
334 #define kmem_alloc(_s, _f) umem_alloc(_s, _f)
335 #define kmem_zalloc(_s, _f) umem_zalloc(_s, _f)
336 #define kmem_free(_b, _s) umem_free(_b, _s)
337 #define kmem_size() (physmem * PAGESIZE)
338 #define kmem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i) \
339 umem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i)
340 #define kmem_cache_destroy(_c) umem_cache_destroy(_c)
341 #define kmem_cache_alloc(_c, _f) umem_cache_alloc(_c, _f)
342 #define kmem_cache_free(_c, _b) umem_cache_free(_c, _b)
343 #define kmem_debugging() 0
344 #define kmem_cache_reap_now(_c) /* nothing */
345 #define kmem_cache_set_move(_c, _cb) /* nothing */
346 #define POINTER_INVALIDATE(_pp) /* nothing */
347 #define POINTER_IS_VALID(_p) 0
349 typedef umem_cache_t kmem_cache_t;
351 typedef enum kmem_cbrc {
362 typedef struct taskq taskq_t;
363 typedef uintptr_t taskqid_t;
364 typedef void (task_func_t)(void *);
366 #define TASKQ_PREPOPULATE 0x0001
367 #define TASKQ_CPR_SAFE 0x0002 /* Use CPR safe protocol */
368 #define TASKQ_DYNAMIC 0x0004 /* Use dynamic thread scheduling */
369 #define TASKQ_THREADS_CPU_PCT 0x0008 /* Scale # threads by # cpus */
370 #define TASKQ_DC_BATCH 0x0010 /* Mark threads as batch */
372 #define TQ_SLEEP KM_SLEEP /* Can block for memory */
373 #define TQ_NOSLEEP KM_NOSLEEP /* cannot block for memory; may fail */
374 #define TQ_NOQUEUE 0x02 /* Do not enqueue if can't dispatch */
375 #define TQ_FRONT 0x08 /* Queue in front */
377 extern taskq_t *system_taskq;
379 extern taskq_t *taskq_create(const char *, int, pri_t, int, int, uint_t);
380 #define taskq_create_proc(a, b, c, d, e, p, f) \
381 (taskq_create(a, b, c, d, e, f))
382 #define taskq_create_sysdc(a, b, d, e, p, dc, f) \
383 (taskq_create(a, b, maxclsyspri, d, e, f))
384 extern taskqid_t taskq_dispatch(taskq_t *, task_func_t, void *, uint_t);
385 extern void taskq_destroy(taskq_t *);
386 extern void taskq_wait(taskq_t *);
387 extern int taskq_member(taskq_t *, void *);
388 extern void system_taskq_init(void);
389 extern void system_taskq_fini(void);
391 #define taskq_dispatch_safe(tq, func, arg, flags, task) \
392 taskq_dispatch((tq), (func), (arg), (flags))
394 #define XVA_MAPSIZE 3
395 #define XVA_MAGIC 0x78766174
400 typedef struct vnode {
406 #define AV_SCANSTAMP_SZ 32 /* length of anti-virus scanstamp */
408 typedef struct xoptattr {
409 timestruc_t xoa_createtime; /* Create time of file */
412 uint8_t xoa_readonly;
414 uint8_t xoa_nounlink;
415 uint8_t xoa_immutable;
416 uint8_t xoa_appendonly;
418 uint8_t xoa_settable;
420 uint8_t xoa_av_quarantined;
421 uint8_t xoa_av_modified;
422 uint8_t xoa_av_scanstamp[AV_SCANSTAMP_SZ];
428 typedef struct vattr {
429 uint_t va_mask; /* bit-mask of attributes */
430 u_offset_t va_size; /* file size in bytes */
434 typedef struct xvattr {
435 vattr_t xva_vattr; /* Embedded vattr structure */
436 uint32_t xva_magic; /* Magic Number */
437 uint32_t xva_mapsize; /* Size of attr bitmap (32-bit words) */
438 uint32_t *xva_rtnattrmapp; /* Ptr to xva_rtnattrmap[] */
439 uint32_t xva_reqattrmap[XVA_MAPSIZE]; /* Requested attrs */
440 uint32_t xva_rtnattrmap[XVA_MAPSIZE]; /* Returned attrs */
441 xoptattr_t xva_xoptattrs; /* Optional attributes */
444 typedef struct vsecattr {
445 uint_t vsa_mask; /* See below */
446 int vsa_aclcnt; /* ACL entry count */
447 void *vsa_aclentp; /* pointer to ACL entries */
448 int vsa_dfaclcnt; /* default ACL entry count */
449 void *vsa_dfaclentp; /* pointer to default ACL entries */
450 size_t vsa_aclentsz; /* ACE size in bytes of vsa_aclentp */
453 #define AT_TYPE 0x00001
454 #define AT_MODE 0x00002
455 #define AT_UID 0x00004
456 #define AT_GID 0x00008
457 #define AT_FSID 0x00010
458 #define AT_NODEID 0x00020
459 #define AT_NLINK 0x00040
460 #define AT_SIZE 0x00080
461 #define AT_ATIME 0x00100
462 #define AT_MTIME 0x00200
463 #define AT_CTIME 0x00400
464 #define AT_RDEV 0x00800
465 #define AT_BLKSIZE 0x01000
466 #define AT_NBLOCKS 0x02000
467 #define AT_SEQ 0x08000
468 #define AT_XVATTR 0x10000
472 extern int fop_getattr(vnode_t *vp, vattr_t *vap);
474 #define VOP_CLOSE(vp, f, c, o, cr, ct) 0
475 #define VOP_PUTPAGE(vp, of, sz, fl, cr, ct) 0
476 #define VOP_GETATTR(vp, vap, cr) fop_getattr((vp), (vap));
478 #define VOP_FSYNC(vp, f, cr, ct) fsync((vp)->v_fd)
480 #define VN_RELE(vp) vn_close(vp, 0, NULL, NULL)
481 #define VN_RELE_ASYNC(vp, taskq) vn_close(vp, 0, NULL, NULL)
483 #define vn_lock(vp, type)
484 #define VOP_UNLOCK(vp, type)
485 #ifdef VFS_LOCK_GIANT
486 #undef VFS_LOCK_GIANT
488 #define VFS_LOCK_GIANT(mp) 0
489 #ifdef VFS_UNLOCK_GIANT
490 #undef VFS_UNLOCK_GIANT
492 #define VFS_UNLOCK_GIANT(vfslocked)
494 extern int vn_open(char *path, int x1, int oflags, int mode, vnode_t **vpp,
496 extern int vn_openat(char *path, int x1, int oflags, int mode, vnode_t **vpp,
497 int x2, int x3, vnode_t *vp, int fd);
498 extern int vn_rdwr(int uio, vnode_t *vp, void *addr, ssize_t len,
499 offset_t offset, int x1, int x2, rlim64_t x3, void *x4, ssize_t *residp);
500 extern void vn_close(vnode_t *vp, int openflag, cred_t *cr, kthread_t *td);
502 #define vn_remove(path, x1, x2) remove(path)
503 #define vn_rename(from, to, seg) rename((from), (to))
504 #define vn_is_readonly(vp) B_FALSE
506 extern vnode_t *rootdir;
508 #include <sys/file.h> /* for FREAD, FWRITE, etc */
509 #define FTRUNC O_TRUNC
514 #define ddi_get_lbolt() (gethrtime() >> 23)
515 #define ddi_get_lbolt64() (gethrtime() >> 23)
516 #define hz 119 /* frequency when using gethrtime() >> 23 for lbolt */
518 extern void delay(clock_t ticks);
520 #define gethrestime_sec() time(NULL)
521 #define gethrestime(t) \
523 (t)->tv_sec = gethrestime_sec();\
529 #define minclsyspri 60
530 #define maxclsyspri 99
532 #define CPU_SEQID (thr_self() & (max_ncpus - 1))
538 #define ptob(x) ((x) * PAGESIZE)
541 extern uint64_t physmem;
543 extern int highbit(ulong_t i);
544 extern int random_get_bytes(uint8_t *ptr, size_t len);
545 extern int random_get_pseudo_bytes(uint8_t *ptr, size_t len);
547 extern void kernel_init(int);
548 extern void kernel_fini(void);
551 extern void nicenum(uint64_t num, char *buf);
552 extern void show_pool_stats(struct spa *);
554 typedef struct callb_cpr {
558 #define CALLB_CPR_INIT(cp, lockp, func, name) { \
559 (cp)->cc_lockp = lockp; \
562 #define CALLB_CPR_SAFE_BEGIN(cp) { \
563 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
566 #define CALLB_CPR_SAFE_END(cp, lockp) { \
567 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
570 #define CALLB_CPR_EXIT(cp) { \
571 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
572 mutex_exit((cp)->cc_lockp); \
575 #define zone_dataset_visible(x, y) (1)
576 #define INGLOBALZONE(z) (1)
578 extern char *kmem_asprintf(const char *fmt, ...);
579 #define strfree(str) kmem_free((str), strlen(str)+1)
582 * Hostname information
584 extern struct utsname utsname;
585 extern char hw_serial[]; /* for userland-emulated hostid access */
586 extern int ddi_strtoul(const char *str, char **nptr, int base,
587 unsigned long *result);
589 extern int ddi_strtoull(const char *str, char **nptr, int base,
590 u_longlong_t *result);
592 /* ZFS Boot Related stuff. */
602 typedef struct ace_object {
604 uint32_t a_access_mask;
607 uint8_t a_obj_type[16];
608 uint8_t a_inherit_obj_type[16];
612 #define ACE_ACCESS_ALLOWED_OBJECT_ACE_TYPE 0x05
613 #define ACE_ACCESS_DENIED_OBJECT_ACE_TYPE 0x06
614 #define ACE_SYSTEM_AUDIT_OBJECT_ACE_TYPE 0x07
615 #define ACE_SYSTEM_ALARM_OBJECT_ACE_TYPE 0x08
617 extern struct _buf *kobj_open_file(char *name);
618 extern int kobj_read_file(struct _buf *file, char *buf, unsigned size,
620 extern void kobj_close_file(struct _buf *file);
621 extern int kobj_get_filesize(struct _buf *file, uint64_t *size);
622 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
623 extern int zfs_secpolicy_rename_perms(const char *from, const char *to,
625 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
626 extern zoneid_t getzoneid(void);
627 /* Random compatibility stuff. */
628 #define lbolt (gethrtime() >> 23)
629 #define lbolt64 (gethrtime() >> 23)
631 extern uint64_t physmem;
633 #define gethrestime_sec() time(NULL)
635 #define pwrite64(d, p, n, o) pwrite(d, p, n, o)
636 #define readdir64(d) readdir(d)
637 #define SIGPENDING(td) (0)
638 #define root_mount_wait() do { } while (0)
639 #define root_mounted() (1)
645 #define FCREAT O_CREAT
649 typedef struct ksiddomain {
655 ksiddomain_t *ksid_lookupdomain(const char *);
656 void ksiddomain_rele(ksiddomain_t *);
658 typedef uint32_t idmap_rid_t;
660 #define DDI_SLEEP KM_SLEEP
661 #define ddi_log_sysevent(_a, _b, _c, _d, _e, _f, _g) (0)
663 #define SX_SYSINIT(name, lock, desc)
665 #define SYSCTL_DECL(...)
666 #define SYSCTL_NODE(...)
667 #define SYSCTL_INT(...)
668 #define SYSCTL_UINT(...)
669 #define SYSCTL_ULONG(...)
670 #define SYSCTL_QUAD(...)
671 #define SYSCTL_UQUAD(...)
677 #define TUNABLE_INT(...)
678 #define TUNABLE_ULONG(...)
679 #define TUNABLE_QUAD(...)
684 #define ERESTART (-1)
691 #endif /* _SYS_ZFS_CONTEXT_H */