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
60 #include <libsysevent.h>
62 #include <sys/types.h>
64 #include <sys/sysmacros.h>
65 #include <sys/bitmap.h>
66 #include <sys/resource.h>
67 #include <sys/byteorder.h>
70 #include <sys/zfs_debug.h>
72 #include <sys/kstat.h>
73 #include <sys/u8_textprep.h>
74 #include <sys/sysevent/eventdefs.h>
75 #include <sys/sysevent/dev.h>
76 #include <sys/sunddi.h>
83 * Note that we are not using the debugging levels.
86 #define CE_CONT 0 /* continuation */
87 #define CE_NOTE 1 /* notice */
88 #define CE_WARN 2 /* warning */
89 #define CE_PANIC 3 /* panic */
90 #define CE_IGNORE 4 /* print nothing */
99 extern void dprintf_setup(int *argc, char **argv);
100 #endif /* ZFS_DEBUG */
102 extern void cmn_err(int, const char *, ...);
103 extern void vcmn_err(int, const char *, __va_list);
104 extern void panic(const char *, ...);
105 extern void vpanic(const char *, __va_list);
107 #define fm_panic panic
111 /* This definition is copied from assert.h. */
112 #if defined(__STDC__)
113 #if __STDC_VERSION__ - 0 >= 199901L
114 #define zverify(EX) (void)((EX) || (aok) || \
115 (__assert_c99(#EX, __FILE__, __LINE__, __func__), 0))
117 #define zverify(EX) (void)((EX) || (aok) || \
118 (__assert(#EX, __FILE__, __LINE__), 0))
119 #endif /* __STDC_VERSION__ - 0 >= 199901L */
121 #define zverify(EX) (void)((EX) || (aok) || \
122 (_assert("EX", __FILE__, __LINE__), 0))
123 #endif /* __STDC__ */
126 #define VERIFY zverify
127 #define ASSERT zverify
129 #define assert zverify
131 extern void __assert(const char *, const char *, int);
134 #define VERIFY3_IMPL(x, y, z, t) if (x == z) ((void)0)
137 #define VERIFY3_IMPL(LEFT, OP, RIGHT, TYPE) do { \
138 const TYPE __left = (TYPE)(LEFT); \
139 const TYPE __right = (TYPE)(RIGHT); \
140 if (!(__left OP __right) && (!aok)) { \
141 char *__buf = alloca(256); \
142 (void) snprintf(__buf, 256, "%s %s %s (0x%llx %s 0x%llx)", \
143 #LEFT, #OP, #RIGHT, \
144 (u_longlong_t)__left, #OP, (u_longlong_t)__right); \
145 __assert(__buf, __FILE__, __LINE__); \
147 _NOTE(CONSTCOND) } while (0)
151 #define VERIFY3S(x, y, z) VERIFY3_IMPL(x, y, z, int64_t)
152 #define VERIFY3U(x, y, z) VERIFY3_IMPL(x, y, z, uint64_t)
153 #define VERIFY3P(x, y, z) VERIFY3_IMPL(x, y, z, uintptr_t)
156 #define ASSERT3S(x, y, z) ((void)0)
157 #define ASSERT3U(x, y, z) ((void)0)
158 #define ASSERT3P(x, y, z) ((void)0)
160 #define ASSERT3S(x, y, z) VERIFY3S(x, y, z)
161 #define ASSERT3U(x, y, z) VERIFY3U(x, y, z)
162 #define ASSERT3P(x, y, z) VERIFY3P(x, y, z)
166 * DTrace SDT probes have different signatures in userland than they do in
167 * kernel. If they're being used in kernel code, re-define them out of
168 * existence for their counterparts in libzpool.
173 #define DTRACE_PROBE(a) ((void)0)
174 #endif /* DTRACE_PROBE */
178 #define DTRACE_PROBE1(a, b, c) ((void)0)
179 #endif /* DTRACE_PROBE1 */
183 #define DTRACE_PROBE2(a, b, c, d, e) ((void)0)
184 #endif /* DTRACE_PROBE2 */
188 #define DTRACE_PROBE3(a, b, c, d, e, f, g) ((void)0)
189 #endif /* DTRACE_PROBE3 */
193 #define DTRACE_PROBE4(a, b, c, d, e, f, g, h, i) ((void)0)
194 #endif /* DTRACE_PROBE4 */
199 #define TS_MAGIC 0x72f158ab4261e538ull
200 #define TS_RUN 0x00000002
202 #define STACK_SIZE 8192 /* Linux x86 and amd64 */
204 #define STACK_SIZE 24576 /* Solaris */
207 #ifdef NPTL_GUARD_WITHIN_STACK
208 #define EXTRA_GUARD_BYTES PAGESIZE
210 #define EXTRA_GUARD_BYTES 0
213 /* in libzpool, p0 exists only to have its address taken */
214 typedef struct proc {
215 uintptr_t this_is_never_used_dont_dereference_it;
218 extern struct proc p0;
220 typedef void (*thread_func_t)(void *);
221 typedef void (*thread_func_arg_t)(void *);
222 typedef pthread_t kt_did_t;
224 typedef struct kthread {
226 thread_func_t t_func;
230 #define tsd_get(key) pthread_getspecific(key)
231 #define tsd_set(key, val) pthread_setspecific(key, val)
232 #define curthread zk_thread_current()
233 #define thread_exit zk_thread_exit
234 #define thread_create(stk, stksize, func, arg, len, pp, state, pri) \
235 zk_thread_create(stk, stksize, (thread_func_t)func, arg, \
236 len, NULL, state, pri)
237 #define thread_join(t) zk_thread_join(t)
238 #define newproc(f,a,cid,pri,ctp,pid) (ENOSYS)
240 extern kthread_t *zk_thread_current(void);
241 extern void zk_thread_exit(void);
242 extern kthread_t *zk_thread_create(caddr_t stk, size_t stksize,
243 thread_func_t func, void *arg, size_t len,
244 proc_t *pp, int state, pri_t pri);
245 extern void zk_thread_join(kt_did_t tid);
249 #define issig(why) (FALSE)
250 #define ISSIG(thr, why) (FALSE)
255 #define MTX_MAGIC 0x9522f51362a6e326ull
256 #define MTX_INIT ((void *)NULL)
257 #define MTX_DEST ((void *)-1UL)
259 typedef struct kmutex {
262 pthread_mutex_t m_lock;
265 #define MUTEX_DEFAULT 0
266 #define MUTEX_HELD(m) ((m)->m_owner == curthread)
267 #define MUTEX_NOT_HELD(m) (!MUTEX_HELD(m))
269 extern void mutex_init(kmutex_t *mp, char *name, int type, void *cookie);
270 extern void mutex_destroy(kmutex_t *mp);
271 extern void mutex_enter(kmutex_t *mp);
272 extern void mutex_exit(kmutex_t *mp);
273 extern int mutex_tryenter(kmutex_t *mp);
274 extern void *mutex_owner(kmutex_t *mp);
275 extern int mutex_held(kmutex_t *mp);
280 #define RW_MAGIC 0x4d31fb123648e78aull
281 #define RW_INIT ((void *)NULL)
282 #define RW_DEST ((void *)-1UL)
284 typedef struct krwlock {
288 pthread_rwlock_t rw_lock;
296 #define RW_DEFAULT RW_READER
298 #define RW_READ_HELD(x) ((x)->rw_readers > 0)
299 #define RW_WRITE_HELD(x) ((x)->rw_wr_owner == curthread)
300 #define RW_LOCK_HELD(x) (RW_READ_HELD(x) || RW_WRITE_HELD(x))
302 extern void rw_init(krwlock_t *rwlp, char *name, int type, void *arg);
303 extern void rw_destroy(krwlock_t *rwlp);
304 extern void rw_enter(krwlock_t *rwlp, krw_t rw);
305 extern int rw_tryenter(krwlock_t *rwlp, krw_t rw);
306 extern int rw_tryupgrade(krwlock_t *rwlp);
307 extern void rw_exit(krwlock_t *rwlp);
308 #define rw_downgrade(rwlp) do { } while (0)
310 extern uid_t crgetuid(cred_t *cr);
311 extern gid_t crgetgid(cred_t *cr);
312 extern int crgetngroups(cred_t *cr);
313 extern gid_t *crgetgroups(cred_t *cr);
316 * Condition variables
318 #define CV_MAGIC 0xd31ea9a83b1b30c4ull
320 typedef struct kcondvar {
327 extern void cv_init(kcondvar_t *cv, char *name, int type, void *arg);
328 extern void cv_destroy(kcondvar_t *cv);
329 extern void cv_wait(kcondvar_t *cv, kmutex_t *mp);
330 extern clock_t cv_timedwait(kcondvar_t *cv, kmutex_t *mp, clock_t abstime);
331 extern void cv_signal(kcondvar_t *cv);
332 extern void cv_broadcast(kcondvar_t *cv);
335 * kstat creation, installation and deletion
337 extern kstat_t *kstat_create(char *, int,
338 char *, char *, uchar_t, ulong_t, uchar_t);
339 extern void kstat_install(kstat_t *);
340 extern void kstat_delete(kstat_t *);
345 #define KM_SLEEP UMEM_NOFAIL
346 #define KM_PUSHPAGE KM_SLEEP
347 #define KM_NOSLEEP UMEM_DEFAULT
348 #define KMC_NODEBUG UMC_NODEBUG
349 #define kmem_alloc(_s, _f) umem_alloc(_s, _f)
350 #define kmem_zalloc(_s, _f) umem_zalloc(_s, _f)
351 #define kmem_free(_b, _s) umem_free(_b, _s)
352 #define kmem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i) \
353 umem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i)
354 #define kmem_cache_destroy(_c) umem_cache_destroy(_c)
355 #define kmem_cache_alloc(_c, _f) umem_cache_alloc(_c, _f)
356 #define kmem_cache_free(_c, _b) umem_cache_free(_c, _b)
357 #define kmem_debugging() 0
358 #define kmem_cache_reap_now(_c) /* nothing */
359 #define kmem_cache_set_move(_c, _cb) /* nothing */
360 #define POINTER_INVALIDATE(_pp) /* nothing */
361 #define POINTER_IS_VALID(_p) 0
363 typedef umem_cache_t kmem_cache_t;
365 typedef enum kmem_cbrc {
376 typedef struct taskq taskq_t;
377 typedef uintptr_t taskqid_t;
378 typedef void (task_func_t)(void *);
380 #define TASKQ_PREPOPULATE 0x0001
381 #define TASKQ_CPR_SAFE 0x0002 /* Use CPR safe protocol */
382 #define TASKQ_DYNAMIC 0x0004 /* Use dynamic thread scheduling */
383 #define TASKQ_THREADS_CPU_PCT 0x0008 /* Scale # threads by # cpus */
384 #define TASKQ_DC_BATCH 0x0010 /* Mark threads as batch */
386 #define TQ_SLEEP KM_SLEEP /* Can block for memory */
387 #define TQ_NOSLEEP KM_NOSLEEP /* cannot block for memory; may fail */
388 #define TQ_NOQUEUE 0x02 /* Do not enqueue if can't dispatch */
389 #define TQ_FRONT 0x08 /* Queue in front */
391 extern taskq_t *system_taskq;
393 extern taskq_t *taskq_create(const char *, int, pri_t, int, int, uint_t);
394 #define taskq_create_proc(a, b, c, d, e, p, f) \
395 (taskq_create(a, b, c, d, e, f))
396 #define taskq_create_sysdc(a, b, d, e, p, dc, f) \
397 (taskq_create(a, b, maxclsyspri, d, e, f))
398 extern taskqid_t taskq_dispatch(taskq_t *, task_func_t, void *, uint_t);
399 extern void taskq_destroy(taskq_t *);
400 extern void taskq_wait(taskq_t *);
401 extern int taskq_member(taskq_t *, kthread_t *);
402 extern void system_taskq_init(void);
403 extern void system_taskq_fini(void);
405 #define XVA_MAPSIZE 3
406 #define XVA_MAGIC 0x78766174
411 typedef struct vnode {
417 #define AV_SCANSTAMP_SZ 32 /* length of anti-virus scanstamp */
419 typedef struct xoptattr {
420 timestruc_t xoa_createtime; /* Create time of file */
423 uint8_t xoa_readonly;
425 uint8_t xoa_nounlink;
426 uint8_t xoa_immutable;
427 uint8_t xoa_appendonly;
429 uint8_t xoa_settable;
431 uint8_t xoa_av_quarantined;
432 uint8_t xoa_av_modified;
433 uint8_t xoa_av_scanstamp[AV_SCANSTAMP_SZ];
439 typedef struct vattr {
440 uint_t va_mask; /* bit-mask of attributes */
441 u_offset_t va_size; /* file size in bytes */
445 typedef struct xvattr {
446 vattr_t xva_vattr; /* Embedded vattr structure */
447 uint32_t xva_magic; /* Magic Number */
448 uint32_t xva_mapsize; /* Size of attr bitmap (32-bit words) */
449 uint32_t *xva_rtnattrmapp; /* Ptr to xva_rtnattrmap[] */
450 uint32_t xva_reqattrmap[XVA_MAPSIZE]; /* Requested attrs */
451 uint32_t xva_rtnattrmap[XVA_MAPSIZE]; /* Returned attrs */
452 xoptattr_t xva_xoptattrs; /* Optional attributes */
455 typedef struct vsecattr {
456 uint_t vsa_mask; /* See below */
457 int vsa_aclcnt; /* ACL entry count */
458 void *vsa_aclentp; /* pointer to ACL entries */
459 int vsa_dfaclcnt; /* default ACL entry count */
460 void *vsa_dfaclentp; /* pointer to default ACL entries */
461 size_t vsa_aclentsz; /* ACE size in bytes of vsa_aclentp */
464 #define AT_TYPE 0x00001
465 #define AT_MODE 0x00002
466 #define AT_UID 0x00004
467 #define AT_GID 0x00008
468 #define AT_FSID 0x00010
469 #define AT_NODEID 0x00020
470 #define AT_NLINK 0x00040
471 #define AT_SIZE 0x00080
472 #define AT_ATIME 0x00100
473 #define AT_MTIME 0x00200
474 #define AT_CTIME 0x00400
475 #define AT_RDEV 0x00800
476 #define AT_BLKSIZE 0x01000
477 #define AT_NBLOCKS 0x02000
478 #define AT_SEQ 0x08000
479 #define AT_XVATTR 0x10000
483 extern int fop_getattr(vnode_t *vp, vattr_t *vap);
485 #define VOP_CLOSE(vp, f, c, o, cr, ct) 0
486 #define VOP_PUTPAGE(vp, of, sz, fl, cr, ct) 0
487 #define VOP_GETATTR(vp, vap, fl, cr, ct) fop_getattr((vp), (vap));
489 #define VOP_FSYNC(vp, f, cr, ct) fsync((vp)->v_fd)
491 #define VN_RELE(vp) vn_close(vp)
493 extern int vn_open(char *path, int x1, int oflags, int mode, vnode_t **vpp,
495 extern int vn_openat(char *path, int x1, int oflags, int mode, vnode_t **vpp,
496 int x2, int x3, vnode_t *vp, int fd);
497 extern int vn_rdwr(int uio, vnode_t *vp, void *addr, ssize_t len,
498 offset_t offset, int x1, int x2, rlim64_t x3, void *x4, ssize_t *residp);
499 extern void vn_close(vnode_t *vp);
501 #define vn_remove(path, x1, x2) remove(path)
502 #define vn_rename(from, to, seg) rename((from), (to))
503 #define vn_is_readonly(vp) B_FALSE
505 extern vnode_t *rootdir;
507 #include <sys/file.h> /* for FREAD, FWRITE, etc */
512 #define ddi_get_lbolt() (gethrtime() >> 23)
513 #define ddi_get_lbolt64() (gethrtime() >> 23)
514 #define hz 119 /* frequency when using gethrtime() >> 23 for lbolt */
516 extern void delay(clock_t ticks);
518 #define gethrestime_sec() time(NULL)
519 #define gethrestime(t) \
521 (t)->tv_sec = gethrestime_sec();\
527 #define minclsyspri 60
528 #define maxclsyspri 99
530 #define CPU_SEQID (pthread_self() & (max_ncpus - 1))
535 #define ptob(x) ((x) * PAGESIZE)
537 extern uint64_t physmem;
539 extern int highbit(ulong_t i);
540 extern int random_get_bytes(uint8_t *ptr, size_t len);
541 extern int random_get_pseudo_bytes(uint8_t *ptr, size_t len);
543 extern void kernel_init(int);
544 extern void kernel_fini(void);
547 extern void nicenum(uint64_t num, char *buf);
548 extern void show_pool_stats(struct spa *);
550 typedef struct callb_cpr {
554 #define CALLB_CPR_INIT(cp, lockp, func, name) { \
555 (cp)->cc_lockp = lockp; \
558 #define CALLB_CPR_SAFE_BEGIN(cp) { \
559 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
562 #define CALLB_CPR_SAFE_END(cp, lockp) { \
563 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
566 #define CALLB_CPR_EXIT(cp) { \
567 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
568 mutex_exit((cp)->cc_lockp); \
571 #define zone_dataset_visible(x, y) (1)
572 #define INGLOBALZONE(z) (1)
574 extern char *kmem_asprintf(const char *fmt, ...);
575 #define strfree(str) kmem_free((str), strlen(str)+1)
578 * Hostname information
580 extern char hw_serial[]; /* for userland-emulated hostid access */
581 extern int ddi_strtoul(const char *str, char **nptr, int base,
582 unsigned long *result);
584 extern int ddi_strtoull(const char *str, char **nptr, int base,
585 u_longlong_t *result);
587 /* ZFS Boot Related stuff. */
597 typedef struct ace_object {
599 uint32_t a_access_mask;
602 uint8_t a_obj_type[16];
603 uint8_t a_inherit_obj_type[16];
607 #define ACE_ACCESS_ALLOWED_OBJECT_ACE_TYPE 0x05
608 #define ACE_ACCESS_DENIED_OBJECT_ACE_TYPE 0x06
609 #define ACE_SYSTEM_AUDIT_OBJECT_ACE_TYPE 0x07
610 #define ACE_SYSTEM_ALARM_OBJECT_ACE_TYPE 0x08
612 extern struct _buf *kobj_open_file(char *name);
613 extern int kobj_read_file(struct _buf *file, char *buf, unsigned size,
615 extern void kobj_close_file(struct _buf *file);
616 extern int kobj_get_filesize(struct _buf *file, uint64_t *size);
617 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
618 extern int zfs_secpolicy_rename_perms(const char *from, const char *to,
620 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
621 extern zoneid_t getzoneid(void);
624 typedef struct ksiddomain {
630 ksiddomain_t *ksid_lookupdomain(const char *);
631 void ksiddomain_rele(ksiddomain_t *);
633 #define DDI_SLEEP KM_SLEEP
634 #define ddi_log_sysevent(_a, _b, _c, _d, _e, _f, _g) \
635 sysevent_post_event(_c, _d, _b, "libzpool", _e, _f)
641 #endif /* _SYS_ZFS_CONTEXT_H */