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>
82 #define noinline __attribute__((noinline))
89 * Note that we are not using the debugging levels.
92 #define CE_CONT 0 /* continuation */
93 #define CE_NOTE 1 /* notice */
94 #define CE_WARN 2 /* warning */
95 #define CE_PANIC 3 /* panic */
96 #define CE_IGNORE 4 /* print nothing */
105 extern void dprintf_setup(int *argc, char **argv);
106 #endif /* ZFS_DEBUG */
108 extern void cmn_err(int, const char *, ...);
109 extern void vcmn_err(int, const char *, __va_list);
110 extern void panic(const char *, ...);
111 extern void vpanic(const char *, __va_list);
113 #define fm_panic panic
117 /* This definition is copied from assert.h. */
118 #if defined(__STDC__)
119 #if __STDC_VERSION__ - 0 >= 199901L
120 #define zverify(EX) (void)((EX) || (aok) || \
121 (__assert_c99(#EX, __FILE__, __LINE__, __func__), 0))
123 #define zverify(EX) (void)((EX) || (aok) || \
124 (__assert(#EX, __FILE__, __LINE__), 0))
125 #endif /* __STDC_VERSION__ - 0 >= 199901L */
127 #define zverify(EX) (void)((EX) || (aok) || \
128 (_assert("EX", __FILE__, __LINE__), 0))
129 #endif /* __STDC__ */
132 #define VERIFY zverify
133 #define ASSERT zverify
135 #define assert zverify
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) && (!aok)) { \
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 TS_MAGIC 0x72f158ab4261e538ull
206 #define TS_RUN 0x00000002
208 #define STACK_SIZE 8192 /* Linux x86 and amd64 */
210 #define STACK_SIZE 24576 /* Solaris */
213 #ifdef NPTL_GUARD_WITHIN_STACK
214 #define EXTRA_GUARD_BYTES PAGESIZE
216 #define EXTRA_GUARD_BYTES 0
219 /* in libzpool, p0 exists only to have its address taken */
220 typedef struct proc {
221 uintptr_t this_is_never_used_dont_dereference_it;
224 extern struct proc p0;
226 typedef void (*thread_func_t)(void *);
227 typedef void (*thread_func_arg_t)(void *);
228 typedef pthread_t kt_did_t;
230 typedef struct kthread {
232 thread_func_t t_func;
236 #define tsd_get(key) pthread_getspecific(key)
237 #define tsd_set(key, val) pthread_setspecific(key, val)
238 #define curthread zk_thread_current()
239 #define thread_exit zk_thread_exit
240 #define thread_create(stk, stksize, func, arg, len, pp, state, pri) \
241 zk_thread_create(stk, stksize, (thread_func_t)func, arg, \
242 len, NULL, state, pri)
243 #define thread_join(t) zk_thread_join(t)
244 #define newproc(f,a,cid,pri,ctp,pid) (ENOSYS)
246 extern kthread_t *zk_thread_current(void);
247 extern void zk_thread_exit(void);
248 extern kthread_t *zk_thread_create(caddr_t stk, size_t stksize,
249 thread_func_t func, void *arg, size_t len,
250 proc_t *pp, int state, pri_t pri);
251 extern void zk_thread_join(kt_did_t tid);
255 #define issig(why) (FALSE)
256 #define ISSIG(thr, why) (FALSE)
261 #define MTX_MAGIC 0x9522f51362a6e326ull
262 #define MTX_INIT ((void *)NULL)
263 #define MTX_DEST ((void *)-1UL)
265 typedef struct kmutex {
268 pthread_mutex_t m_lock;
271 #define MUTEX_DEFAULT 0
272 #define MUTEX_HELD(m) ((m)->m_owner == curthread)
273 #define MUTEX_NOT_HELD(m) (!MUTEX_HELD(m))
275 extern void mutex_init(kmutex_t *mp, char *name, int type, void *cookie);
276 extern void mutex_destroy(kmutex_t *mp);
277 extern void mutex_enter(kmutex_t *mp);
278 extern void mutex_exit(kmutex_t *mp);
279 extern int mutex_tryenter(kmutex_t *mp);
280 extern void *mutex_owner(kmutex_t *mp);
281 extern int mutex_held(kmutex_t *mp);
286 #define RW_MAGIC 0x4d31fb123648e78aull
287 #define RW_INIT ((void *)NULL)
288 #define RW_DEST ((void *)-1UL)
290 typedef struct krwlock {
294 pthread_rwlock_t rw_lock;
302 #define RW_DEFAULT RW_READER
304 #define RW_READ_HELD(x) ((x)->rw_readers > 0)
305 #define RW_WRITE_HELD(x) ((x)->rw_wr_owner == curthread)
306 #define RW_LOCK_HELD(x) (RW_READ_HELD(x) || RW_WRITE_HELD(x))
308 extern void rw_init(krwlock_t *rwlp, char *name, int type, void *arg);
309 extern void rw_destroy(krwlock_t *rwlp);
310 extern void rw_enter(krwlock_t *rwlp, krw_t rw);
311 extern int rw_tryenter(krwlock_t *rwlp, krw_t rw);
312 extern int rw_tryupgrade(krwlock_t *rwlp);
313 extern void rw_exit(krwlock_t *rwlp);
314 #define rw_downgrade(rwlp) do { } while (0)
316 extern uid_t crgetuid(cred_t *cr);
317 extern gid_t crgetgid(cred_t *cr);
318 extern int crgetngroups(cred_t *cr);
319 extern gid_t *crgetgroups(cred_t *cr);
322 * Condition variables
324 #define CV_MAGIC 0xd31ea9a83b1b30c4ull
326 typedef struct kcondvar {
333 extern void cv_init(kcondvar_t *cv, char *name, int type, void *arg);
334 extern void cv_destroy(kcondvar_t *cv);
335 extern void cv_wait(kcondvar_t *cv, kmutex_t *mp);
336 extern clock_t cv_timedwait(kcondvar_t *cv, kmutex_t *mp, clock_t abstime);
337 extern void cv_signal(kcondvar_t *cv);
338 extern void cv_broadcast(kcondvar_t *cv);
341 * kstat creation, installation and deletion
343 extern kstat_t *kstat_create(char *, int,
344 char *, char *, uchar_t, ulong_t, uchar_t);
345 extern void kstat_install(kstat_t *);
346 extern void kstat_delete(kstat_t *);
351 #define KM_SLEEP UMEM_NOFAIL
352 #define KM_PUSHPAGE KM_SLEEP
353 #define KM_NOSLEEP UMEM_DEFAULT
354 #define KMC_NODEBUG UMC_NODEBUG
355 #define kmem_alloc(_s, _f) umem_alloc(_s, _f)
356 #define kmem_zalloc(_s, _f) umem_zalloc(_s, _f)
357 #define kmem_free(_b, _s) umem_free(_b, _s)
358 #define kmem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i) \
359 umem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i)
360 #define kmem_cache_destroy(_c) umem_cache_destroy(_c)
361 #define kmem_cache_alloc(_c, _f) umem_cache_alloc(_c, _f)
362 #define kmem_cache_free(_c, _b) umem_cache_free(_c, _b)
363 #define kmem_debugging() 0
364 #define kmem_cache_reap_now(_c) /* nothing */
365 #define kmem_cache_set_move(_c, _cb) /* nothing */
366 #define POINTER_INVALIDATE(_pp) /* nothing */
367 #define POINTER_IS_VALID(_p) 0
369 typedef umem_cache_t kmem_cache_t;
371 typedef enum kmem_cbrc {
382 typedef struct taskq taskq_t;
383 typedef uintptr_t taskqid_t;
384 typedef void (task_func_t)(void *);
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 */
397 extern taskq_t *system_taskq;
399 extern taskq_t *taskq_create(const char *, int, pri_t, int, int, uint_t);
400 #define taskq_create_proc(a, b, c, d, e, p, f) \
401 (taskq_create(a, b, c, d, e, f))
402 #define taskq_create_sysdc(a, b, d, e, p, dc, f) \
403 (taskq_create(a, b, maxclsyspri, d, e, f))
404 extern taskqid_t taskq_dispatch(taskq_t *, task_func_t, void *, uint_t);
405 extern void taskq_destroy(taskq_t *);
406 extern void taskq_wait(taskq_t *);
407 extern int taskq_member(taskq_t *, kthread_t *);
408 extern void system_taskq_init(void);
409 extern void system_taskq_fini(void);
411 #define XVA_MAPSIZE 3
412 #define XVA_MAGIC 0x78766174
417 typedef struct vnode {
423 #define AV_SCANSTAMP_SZ 32 /* length of anti-virus scanstamp */
425 typedef struct xoptattr {
426 timestruc_t xoa_createtime; /* Create time of file */
429 uint8_t xoa_readonly;
431 uint8_t xoa_nounlink;
432 uint8_t xoa_immutable;
433 uint8_t xoa_appendonly;
435 uint8_t xoa_settable;
437 uint8_t xoa_av_quarantined;
438 uint8_t xoa_av_modified;
439 uint8_t xoa_av_scanstamp[AV_SCANSTAMP_SZ];
445 typedef struct vattr {
446 uint_t va_mask; /* bit-mask of attributes */
447 u_offset_t va_size; /* file size in bytes */
451 typedef struct xvattr {
452 vattr_t xva_vattr; /* Embedded vattr structure */
453 uint32_t xva_magic; /* Magic Number */
454 uint32_t xva_mapsize; /* Size of attr bitmap (32-bit words) */
455 uint32_t *xva_rtnattrmapp; /* Ptr to xva_rtnattrmap[] */
456 uint32_t xva_reqattrmap[XVA_MAPSIZE]; /* Requested attrs */
457 uint32_t xva_rtnattrmap[XVA_MAPSIZE]; /* Returned attrs */
458 xoptattr_t xva_xoptattrs; /* Optional attributes */
461 typedef struct vsecattr {
462 uint_t vsa_mask; /* See below */
463 int vsa_aclcnt; /* ACL entry count */
464 void *vsa_aclentp; /* pointer to ACL entries */
465 int vsa_dfaclcnt; /* default ACL entry count */
466 void *vsa_dfaclentp; /* pointer to default ACL entries */
467 size_t vsa_aclentsz; /* ACE size in bytes of vsa_aclentp */
470 #define AT_TYPE 0x00001
471 #define AT_MODE 0x00002
472 #define AT_UID 0x00004
473 #define AT_GID 0x00008
474 #define AT_FSID 0x00010
475 #define AT_NODEID 0x00020
476 #define AT_NLINK 0x00040
477 #define AT_SIZE 0x00080
478 #define AT_ATIME 0x00100
479 #define AT_MTIME 0x00200
480 #define AT_CTIME 0x00400
481 #define AT_RDEV 0x00800
482 #define AT_BLKSIZE 0x01000
483 #define AT_NBLOCKS 0x02000
484 #define AT_SEQ 0x08000
485 #define AT_XVATTR 0x10000
489 extern int fop_getattr(vnode_t *vp, vattr_t *vap);
491 #define VOP_CLOSE(vp, f, c, o, cr, ct) 0
492 #define VOP_PUTPAGE(vp, of, sz, fl, cr, ct) 0
493 #define VOP_GETATTR(vp, vap, fl, cr, ct) fop_getattr((vp), (vap));
495 #define VOP_FSYNC(vp, f, cr, ct) fsync((vp)->v_fd)
497 #define VN_RELE(vp) vn_close(vp)
499 extern int vn_open(char *path, int x1, int oflags, int mode, vnode_t **vpp,
501 extern int vn_openat(char *path, int x1, int oflags, int mode, vnode_t **vpp,
502 int x2, int x3, vnode_t *vp, int fd);
503 extern int vn_rdwr(int uio, vnode_t *vp, void *addr, ssize_t len,
504 offset_t offset, int x1, int x2, rlim64_t x3, void *x4, ssize_t *residp);
505 extern void vn_close(vnode_t *vp);
507 #define vn_remove(path, x1, x2) remove(path)
508 #define vn_rename(from, to, seg) rename((from), (to))
509 #define vn_is_readonly(vp) B_FALSE
511 extern vnode_t *rootdir;
513 #include <sys/file.h> /* for FREAD, FWRITE, etc */
518 #define ddi_get_lbolt() (gethrtime() >> 23)
519 #define ddi_get_lbolt64() (gethrtime() >> 23)
520 #define hz 119 /* frequency when using gethrtime() >> 23 for lbolt */
522 extern void delay(clock_t ticks);
524 #define gethrestime_sec() time(NULL)
525 #define gethrestime(t) \
527 (t)->tv_sec = gethrestime_sec();\
533 #define minclsyspri 60
534 #define maxclsyspri 99
536 #define CPU_SEQID (pthread_self() & (max_ncpus - 1))
541 #define ptob(x) ((x) * PAGESIZE)
543 extern uint64_t physmem;
545 extern int highbit(ulong_t i);
546 extern int random_get_bytes(uint8_t *ptr, size_t len);
547 extern int random_get_pseudo_bytes(uint8_t *ptr, size_t len);
549 extern void kernel_init(int);
550 extern void kernel_fini(void);
553 extern void nicenum(uint64_t num, char *buf);
554 extern void show_pool_stats(struct spa *);
556 typedef struct callb_cpr {
560 #define CALLB_CPR_INIT(cp, lockp, func, name) { \
561 (cp)->cc_lockp = lockp; \
564 #define CALLB_CPR_SAFE_BEGIN(cp) { \
565 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
568 #define CALLB_CPR_SAFE_END(cp, lockp) { \
569 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
572 #define CALLB_CPR_EXIT(cp) { \
573 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
574 mutex_exit((cp)->cc_lockp); \
577 #define zone_dataset_visible(x, y) (1)
578 #define INGLOBALZONE(z) (1)
580 extern char *kmem_asprintf(const char *fmt, ...);
581 #define strfree(str) kmem_free((str), strlen(str)+1)
584 * Hostname information
586 extern char hw_serial[]; /* for userland-emulated hostid access */
587 extern int ddi_strtoul(const char *str, char **nptr, int base,
588 unsigned long *result);
590 extern int ddi_strtoull(const char *str, char **nptr, int base,
591 u_longlong_t *result);
593 /* ZFS Boot Related stuff. */
603 typedef struct ace_object {
605 uint32_t a_access_mask;
608 uint8_t a_obj_type[16];
609 uint8_t a_inherit_obj_type[16];
613 #define ACE_ACCESS_ALLOWED_OBJECT_ACE_TYPE 0x05
614 #define ACE_ACCESS_DENIED_OBJECT_ACE_TYPE 0x06
615 #define ACE_SYSTEM_AUDIT_OBJECT_ACE_TYPE 0x07
616 #define ACE_SYSTEM_ALARM_OBJECT_ACE_TYPE 0x08
618 extern struct _buf *kobj_open_file(char *name);
619 extern int kobj_read_file(struct _buf *file, char *buf, unsigned size,
621 extern void kobj_close_file(struct _buf *file);
622 extern int kobj_get_filesize(struct _buf *file, uint64_t *size);
623 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
624 extern int zfs_secpolicy_rename_perms(const char *from, const char *to,
626 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
627 extern zoneid_t getzoneid(void);
630 typedef struct ksiddomain {
636 ksiddomain_t *ksid_lookupdomain(const char *);
637 void ksiddomain_rele(ksiddomain_t *);
639 #define DDI_SLEEP KM_SLEEP
640 #define ddi_log_sysevent(_a, _b, _c, _d, _e, _f, _g) \
641 sysevent_post_event(_c, _d, _b, "libzpool", _e, _f)
647 #endif /* _SYS_ZFS_CONTEXT_H */