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 2008 Sun Microsystems, Inc. All rights reserved.
23 * Use is subject to license terms.
26 #ifndef _SYS_ZFS_CONTEXT_H
27 #define _SYS_ZFS_CONTEXT_H
35 #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/eventdefs.h>
84 #include <machine/atomic.h>
86 #define ZFS_EXPORTS_PATH "/etc/zfs/exports"
93 * Note that we are not using the debugging levels.
96 #define CE_CONT 0 /* continuation */
97 #define CE_NOTE 1 /* notice */
98 #define CE_WARN 2 /* warning */
99 #define CE_PANIC 3 /* panic */
100 #define CE_IGNORE 4 /* print nothing */
106 #define ZFS_LOG(...) do { } while (0)
108 typedef u_longlong_t rlim64_t;
109 #define RLIM64_INFINITY ((rlim64_t)-3)
112 extern void dprintf_setup(int *argc, char **argv);
113 #endif /* ZFS_DEBUG */
115 extern void cmn_err(int, const char *, ...);
116 extern void vcmn_err(int, const char *, __va_list);
117 extern void panic(const char *, ...);
118 extern void vpanic(const char *, __va_list);
120 #define fm_panic panic
122 /* This definition is copied from assert.h. */
123 #if defined(__STDC__)
124 #if __STDC_VERSION__ - 0 >= 199901L
125 #define verify(EX) (void)((EX) || (__assert(#EX, __FILE__, __LINE__), 0))
127 #define verify(EX) (void)((EX) || (__assert(#EX, __FILE__, __LINE__), 0))
128 #endif /* __STDC_VERSION__ - 0 >= 199901L */
130 #define verify(EX) (void)((EX) || (_assert("EX", __FILE__, __LINE__), 0))
131 #endif /* __STDC__ */
134 #define VERIFY verify
135 #define ASSERT assert
137 extern void __assert(const char *, const char *, int);
140 #define VERIFY3_IMPL(x, y, z, t) if (x == z) ((void)0)
143 #define VERIFY3_IMPL(LEFT, OP, RIGHT, TYPE) do { \
144 const TYPE __left = (TYPE)(LEFT); \
145 const TYPE __right = (TYPE)(RIGHT); \
146 if (!(__left OP __right)) { \
147 char *__buf = alloca(256); \
148 (void) snprintf(__buf, 256, "%s %s %s (0x%llx %s 0x%llx)", \
149 #LEFT, #OP, #RIGHT, \
150 (u_longlong_t)__left, #OP, (u_longlong_t)__right); \
151 __assert(__buf, __FILE__, __LINE__); \
153 _NOTE(CONSTCOND) } while (0)
157 #define VERIFY3S(x, y, z) VERIFY3_IMPL(x, y, z, int64_t)
158 #define VERIFY3U(x, y, z) VERIFY3_IMPL(x, y, z, uint64_t)
159 #define VERIFY3P(x, y, z) VERIFY3_IMPL(x, y, z, uintptr_t)
162 #define ASSERT3S(x, y, z) ((void)0)
163 #define ASSERT3U(x, y, z) ((void)0)
164 #define ASSERT3P(x, y, z) ((void)0)
166 #define ASSERT3S(x, y, z) VERIFY3S(x, y, z)
167 #define ASSERT3U(x, y, z) VERIFY3U(x, y, z)
168 #define ASSERT3P(x, y, z) VERIFY3P(x, y, z)
172 * DTrace SDT probes have different signatures in userland than they do in
173 * kernel. If they're being used in kernel code, re-define them out of
174 * existence for their counterparts in libzpool.
179 #define DTRACE_PROBE(a) ((void)0)
180 #endif /* DTRACE_PROBE */
184 #define DTRACE_PROBE1(a, b, c) ((void)0)
185 #endif /* DTRACE_PROBE1 */
189 #define DTRACE_PROBE2(a, b, c, d, e) ((void)0)
190 #endif /* DTRACE_PROBE2 */
194 #define DTRACE_PROBE3(a, b, c, d, e, f, g) ((void)0)
195 #endif /* DTRACE_PROBE3 */
199 #define DTRACE_PROBE4(a, b, c, d, e, f, g, h, i) ((void)0)
200 #endif /* DTRACE_PROBE4 */
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)
213 extern kthread_t *zk_thread_create(void (*func)(), void *arg);
215 #define issig(why) (FALSE)
216 #define ISSIG(thr, why) (FALSE)
221 typedef struct kmutex {
223 boolean_t initialized;
227 #define MUTEX_DEFAULT USYNC_THREAD
229 #define MUTEX_HELD(m) ((m)->m_owner == curthread)
232 * Argh -- we have to get cheesy here because the kernel and userland
233 * have different signatures for the same routine.
235 //extern int _mutex_init(mutex_t *mp, int type, void *arg);
236 //extern int _mutex_destroy(mutex_t *mp);
238 #define mutex_init(mp, b, c, d) zmutex_init((kmutex_t *)(mp))
239 #define mutex_destroy(mp) zmutex_destroy((kmutex_t *)(mp))
240 #define mutex_owned(mp) zmutex_owned((kmutex_t *)(mp))
242 extern void zmutex_init(kmutex_t *mp);
243 extern void zmutex_destroy(kmutex_t *mp);
244 extern int zmutex_owned(kmutex_t *mp);
245 extern void mutex_enter(kmutex_t *mp);
246 extern void mutex_exit(kmutex_t *mp);
247 extern int mutex_tryenter(kmutex_t *mp);
248 extern void *mutex_owner(kmutex_t *mp);
253 typedef struct krwlock {
256 boolean_t initialized;
264 #define RW_DEFAULT USYNC_THREAD
267 #define RW_READ_HELD(x) ((x)->rw_owner == NULL && (x)->rw_count > 0)
270 #define RW_WRITE_HELD(x) ((x)->rw_owner == curthread)
271 #define RW_LOCK_HELD(x) rw_lock_held(x)
273 extern void rw_init(krwlock_t *rwlp, char *name, int type, void *arg);
274 extern void rw_destroy(krwlock_t *rwlp);
275 extern void rw_enter(krwlock_t *rwlp, krw_t rw);
276 extern int rw_tryenter(krwlock_t *rwlp, krw_t rw);
277 extern int rw_tryupgrade(krwlock_t *rwlp);
278 extern void rw_exit(krwlock_t *rwlp);
279 extern int rw_lock_held(krwlock_t *rwlp);
280 #define rw_downgrade(rwlp) do { } while (0)
282 extern uid_t crgetuid(cred_t *cr);
283 extern gid_t crgetgid(cred_t *cr);
284 extern int crgetngroups(cred_t *cr);
285 extern gid_t *crgetgroups(cred_t *cr);
288 * Condition variables
290 typedef cond_t kcondvar_t;
292 #define CV_DEFAULT USYNC_THREAD
294 extern void cv_init(kcondvar_t *cv, char *name, int type, void *arg);
295 extern void cv_destroy(kcondvar_t *cv);
296 extern void cv_wait(kcondvar_t *cv, kmutex_t *mp);
297 extern clock_t cv_timedwait(kcondvar_t *cv, kmutex_t *mp, clock_t abstime);
298 extern void cv_signal(kcondvar_t *cv);
299 extern void cv_broadcast(kcondvar_t *cv);
304 #define KM_SLEEP UMEM_NOFAIL
305 #define KM_PUSHPAGE KM_SLEEP
306 #define KM_NOSLEEP UMEM_DEFAULT
307 #define KMC_NODEBUG UMC_NODEBUG
308 #define kmem_alloc(_s, _f) umem_alloc(_s, _f)
309 #define kmem_zalloc(_s, _f) umem_zalloc(_s, _f)
310 #define kmem_free(_b, _s) umem_free(_b, _s)
311 #define kmem_size() (physmem * PAGESIZE)
312 #define kmem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i) \
313 umem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i)
314 #define kmem_cache_destroy(_c) umem_cache_destroy(_c)
315 #define kmem_cache_alloc(_c, _f) umem_cache_alloc(_c, _f)
316 #define kmem_cache_free(_c, _b) umem_cache_free(_c, _b)
317 #define kmem_debugging() 0
318 #define kmem_cache_reap_now(c)
320 typedef umem_cache_t kmem_cache_t;
325 typedef struct taskq taskq_t;
326 typedef uintptr_t taskqid_t;
327 typedef void (task_func_t)(void *);
329 #define TASKQ_PREPOPULATE 0x0001
330 #define TASKQ_CPR_SAFE 0x0002 /* Use CPR safe protocol */
331 #define TASKQ_DYNAMIC 0x0004 /* Use dynamic thread scheduling */
333 #define TQ_SLEEP KM_SLEEP /* Can block for memory */
334 #define TQ_NOSLEEP KM_NOSLEEP /* cannot block for memory; may fail */
335 #define TQ_NOQUEUE 0x02 /* Do not enqueue if can't dispatch */
337 extern taskq_t *system_taskq;
339 extern taskq_t *taskq_create(const char *, int, pri_t, int, int, uint_t);
340 extern taskqid_t taskq_dispatch(taskq_t *, task_func_t, void *, uint_t);
341 extern void taskq_destroy(taskq_t *);
342 extern void taskq_wait(taskq_t *);
343 extern int taskq_member(taskq_t *, void *);
344 extern void system_taskq_init(void);
346 #define taskq_dispatch_safe(tq, func, arg, task) \
347 taskq_dispatch((tq), (func), (arg), TQ_SLEEP)
349 #define XVA_MAPSIZE 3
350 #define XVA_MAGIC 0x78766174
355 typedef struct vnode {
362 typedef struct xoptattr {
363 timestruc_t xoa_createtime; /* Create time of file */
366 uint8_t xoa_readonly;
368 uint8_t xoa_nounlink;
369 uint8_t xoa_immutable;
370 uint8_t xoa_appendonly;
372 uint8_t xoa_settable;
374 uint8_t xoa_av_quarantined;
375 uint8_t xoa_av_modified;
378 typedef struct vattr {
379 uint_t va_mask; /* bit-mask of attributes */
380 u_offset_t va_size; /* file size in bytes */
384 typedef struct xvattr {
385 vattr_t xva_vattr; /* Embedded vattr structure */
386 uint32_t xva_magic; /* Magic Number */
387 uint32_t xva_mapsize; /* Size of attr bitmap (32-bit words) */
388 uint32_t *xva_rtnattrmapp; /* Ptr to xva_rtnattrmap[] */
389 uint32_t xva_reqattrmap[XVA_MAPSIZE]; /* Requested attrs */
390 uint32_t xva_rtnattrmap[XVA_MAPSIZE]; /* Returned attrs */
391 xoptattr_t xva_xoptattrs; /* Optional attributes */
394 typedef struct vsecattr {
395 uint_t vsa_mask; /* See below */
396 int vsa_aclcnt; /* ACL entry count */
397 void *vsa_aclentp; /* pointer to ACL entries */
398 int vsa_dfaclcnt; /* default ACL entry count */
399 void *vsa_dfaclentp; /* pointer to default ACL entries */
400 size_t vsa_aclentsz; /* ACE size in bytes of vsa_aclentp */
403 #define AT_TYPE 0x00001
404 #define AT_MODE 0x00002
405 #define AT_UID 0x00004
406 #define AT_GID 0x00008
407 #define AT_FSID 0x00010
408 #define AT_NODEID 0x00020
409 #define AT_NLINK 0x00040
410 #define AT_SIZE 0x00080
411 #define AT_ATIME 0x00100
412 #define AT_MTIME 0x00200
413 #define AT_CTIME 0x00400
414 #define AT_RDEV 0x00800
415 #define AT_BLKSIZE 0x01000
416 #define AT_NBLOCKS 0x02000
417 #define AT_SEQ 0x08000
418 #define AT_XVATTR 0x10000
422 #define VOP_CLOSE(vp, f, c, o, cr, ct) 0
423 #define VOP_PUTPAGE(vp, of, sz, fl, cr, ct) 0
424 #define VOP_GETATTR(vp, vap, cr) ((vap)->va_size = (vp)->v_size, 0)
426 #define VOP_FSYNC(vp, f, cr, ct) fsync((vp)->v_fd)
428 #define VN_RELE(vp) vn_close(vp, 0, NULL, NULL)
429 #define VN_RELE_ASYNC(vp, taskq) vn_close(vp, 0, NULL, NULL)
431 #define vn_lock(vp, type)
432 #define VOP_UNLOCK(vp, type)
433 #ifdef VFS_LOCK_GIANT
434 #undef VFS_LOCK_GIANT
436 #define VFS_LOCK_GIANT(mp) 0
437 #ifdef VFS_UNLOCK_GIANT
438 #undef VFS_UNLOCK_GIANT
440 #define VFS_UNLOCK_GIANT(vfslocked)
442 extern int vn_open(char *path, int x1, int oflags, int mode, vnode_t **vpp,
444 extern int vn_openat(char *path, int x1, int oflags, int mode, vnode_t **vpp,
445 int x2, int x3, vnode_t *vp, int fd);
446 extern int vn_rdwr(int uio, vnode_t *vp, void *addr, ssize_t len,
447 offset_t offset, int x1, int x2, rlim64_t x3, void *x4, ssize_t *residp);
448 extern void vn_close(vnode_t *vp, int openflag, cred_t *cr, kthread_t *td);
450 #define vn_remove(path, x1, x2) remove(path)
451 #define vn_rename(from, to, seg) rename((from), (to))
452 #define vn_is_readonly(vp) B_FALSE
454 extern vnode_t *rootdir;
456 #include <sys/file.h> /* for FREAD, FWRITE, etc */
457 #define FTRUNC O_TRUNC
462 #define lbolt (gethrtime() >> 23)
463 #define lbolt64 (gethrtime() >> 23)
464 //#define hz 119 /* frequency when using gethrtime() >> 23 for lbolt */
466 extern void delay(clock_t ticks);
468 #define gethrestime_sec() time(NULL)
472 #define minclsyspri 60
473 #define maxclsyspri 99
475 #define CPU_SEQID (thr_self() & (max_ncpus - 1))
478 #define ptob(x) ((x) * PAGESIZE)
481 extern uint64_t physmem;
483 extern int highbit(ulong_t i);
484 extern int random_get_bytes(uint8_t *ptr, size_t len);
485 extern int random_get_pseudo_bytes(uint8_t *ptr, size_t len);
487 extern void kernel_init(int);
488 extern void kernel_fini(void);
491 extern void nicenum(uint64_t num, char *buf);
492 extern void show_pool_stats(struct spa *);
494 typedef struct callb_cpr {
498 #define CALLB_CPR_INIT(cp, lockp, func, name) { \
499 (cp)->cc_lockp = lockp; \
502 #define CALLB_CPR_SAFE_BEGIN(cp) { \
503 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
506 #define CALLB_CPR_SAFE_END(cp, lockp) { \
507 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
510 #define CALLB_CPR_EXIT(cp) { \
511 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
512 mutex_exit((cp)->cc_lockp); \
515 #define zone_dataset_visible(x, y) (1)
516 #define INGLOBALZONE(z) (1)
519 * Hostname information
521 extern struct utsname utsname;
522 extern char hw_serial[];
523 extern int ddi_strtoul(const char *str, char **nptr, int base,
524 unsigned long *result);
526 /* ZFS Boot Related stuff. */
536 typedef struct ace_object {
538 uint32_t a_access_mask;
541 uint8_t a_obj_type[16];
542 uint8_t a_inherit_obj_type[16];
546 #define ACE_ACCESS_ALLOWED_OBJECT_ACE_TYPE 0x05
547 #define ACE_ACCESS_DENIED_OBJECT_ACE_TYPE 0x06
548 #define ACE_SYSTEM_AUDIT_OBJECT_ACE_TYPE 0x07
549 #define ACE_SYSTEM_ALARM_OBJECT_ACE_TYPE 0x08
551 extern struct _buf *kobj_open_file(char *name);
552 extern int kobj_read_file(struct _buf *file, char *buf, unsigned size,
554 extern void kobj_close_file(struct _buf *file);
555 extern int kobj_get_filesize(struct _buf *file, uint64_t *size);
556 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
557 extern int zfs_secpolicy_rename_perms(const char *from, const char *to,
559 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
560 extern zoneid_t getzoneid(void);
561 /* Random compatibility stuff. */
562 #define lbolt (gethrtime() >> 23)
563 #define lbolt64 (gethrtime() >> 23)
566 extern uint64_t physmem;
568 #define gethrestime_sec() time(NULL)
570 #define pwrite64(d, p, n, o) pwrite(d, p, n, o)
571 #define readdir64(d) readdir(d)
572 #define SIGPENDING(td) (0)
573 #define root_mount_wait() do { } while (0)
574 #define root_mounted() (1)
580 #define FCREAT O_CREAT
584 typedef struct ksiddomain {
590 ksiddomain_t *ksid_lookupdomain(const char *);
591 void ksiddomain_rele(ksiddomain_t *);
593 #define SX_SYSINIT(name, lock, desc)
595 #define SYSCTL_DECL(...)
596 #define SYSCTL_NODE(...)
597 #define SYSCTL_INT(...)
598 #define SYSCTL_UINT(...)
599 #define SYSCTL_ULONG(...)
600 #define SYSCTL_QUAD(...)
606 #define TUNABLE_INT(...)
607 #define TUNABLE_ULONG(...)
608 #define TUNABLE_QUAD(...)
613 #define ERESTART (-1)
620 #endif /* _SYS_ZFS_CONTEXT_H */