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 2009 Sun Microsystems, Inc. All rights reserved.
23 * Use is subject to license terms.
26 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
27 * Copyright (c) 2012, Joyent, Inc. All rights reserved.
30 #ifndef _SYS_ZFS_CONTEXT_H
31 #define _SYS_ZFS_CONTEXT_H
36 #include <sys/types.h>
37 #include <sys/t_lock.h>
38 #include <sys/atomic.h>
39 #include <sys/sysmacros.h>
40 #include <sys/bitmap.h>
41 #include <sys/cmn_err.h>
43 #include <sys/taskq.h>
45 #include <sys/param.h>
46 #include <sys/systm.h>
47 #include <sys/cpuvar.h>
51 #include <sys/debug.h>
52 #include <sys/random.h>
53 #include <sys/byteorder.h>
54 #include <sys/systm.h>
56 #include <sys/uio_impl.h>
57 #include <sys/dirent.h>
59 #include <vm/seg_kmem.h>
61 #include <sys/zfs_debug.h>
62 #include <sys/fm/fs/zfs.h>
63 #include <sys/sunddi.h>
64 #include <sys/ctype.h>
66 #include <linux/dcache_compat.h>
72 #define _SYS_CONDVAR_H
100 #include <sys/types.h>
101 #include <sys/cred.h>
102 #include <sys/sysmacros.h>
103 #include <sys/bitmap.h>
104 #include <sys/resource.h>
105 #include <sys/byteorder.h>
106 #include <sys/list.h>
108 #include <sys/zfs_debug.h>
110 #include <sys/kstat.h>
111 #include <sys/u8_textprep.h>
112 #include <sys/fm/fs/zfs.h>
113 #include <sys/sunddi.h>
119 #define noinline __attribute__((noinline))
126 * Note that we are not using the debugging levels.
129 #define CE_CONT 0 /* continuation */
130 #define CE_NOTE 1 /* notice */
131 #define CE_WARN 2 /* warning */
132 #define CE_PANIC 3 /* panic */
133 #define CE_IGNORE 4 /* print nothing */
141 extern void dprintf_setup(int *argc, char **argv);
142 extern void __dprintf(const char *file, const char *func,
143 int line, const char *fmt, ...);
144 extern void cmn_err(int, const char *, ...);
145 extern void vcmn_err(int, const char *, __va_list);
146 extern void panic(const char *, ...);
147 extern void vpanic(const char *, __va_list);
149 #define fm_panic panic
152 * DTrace SDT probes have different signatures in userland than they do in
153 * kernel. If they're being used in kernel code, re-define them out of
154 * existence for their counterparts in libzpool.
159 #define DTRACE_PROBE(a) ((void)0)
160 #endif /* DTRACE_PROBE */
164 #define DTRACE_PROBE1(a, b, c) ((void)0)
165 #endif /* DTRACE_PROBE1 */
169 #define DTRACE_PROBE2(a, b, c, d, e) ((void)0)
170 #endif /* DTRACE_PROBE2 */
174 #define DTRACE_PROBE3(a, b, c, d, e, f, g) ((void)0)
175 #endif /* DTRACE_PROBE3 */
179 #define DTRACE_PROBE4(a, b, c, d, e, f, g, h, i) ((void)0)
180 #endif /* DTRACE_PROBE4 */
185 #define TS_MAGIC 0x72f158ab4261e538ull
186 #define TS_RUN 0x00000002
188 #define STACK_SIZE 8192 /* Linux x86 and amd64 */
190 #define STACK_SIZE 24576 /* Solaris */
193 #ifdef NPTL_GUARD_WITHIN_STACK
194 #define EXTRA_GUARD_BYTES PAGESIZE
196 #define EXTRA_GUARD_BYTES 0
199 /* in libzpool, p0 exists only to have its address taken */
200 typedef struct proc {
201 uintptr_t this_is_never_used_dont_dereference_it;
204 extern struct proc p0;
205 #define curproc (&p0)
207 typedef void (*thread_func_t)(void *);
208 typedef void (*thread_func_arg_t)(void *);
209 typedef pthread_t kt_did_t;
211 typedef struct kthread {
213 thread_func_t t_func;
217 #define tsd_get(key) pthread_getspecific(key)
218 #define tsd_set(key, val) pthread_setspecific(key, val)
219 #define curthread zk_thread_current()
220 #define thread_exit zk_thread_exit
221 #define thread_create(stk, stksize, func, arg, len, pp, state, pri) \
222 zk_thread_create(stk, stksize, (thread_func_t)func, arg, \
223 len, NULL, state, pri, PTHREAD_CREATE_DETACHED)
224 #define thread_join(t) zk_thread_join(t)
225 #define newproc(f,a,cid,pri,ctp,pid) (ENOSYS)
227 extern kthread_t *zk_thread_current(void);
228 extern void zk_thread_exit(void);
229 extern kthread_t *zk_thread_create(caddr_t stk, size_t stksize,
230 thread_func_t func, void *arg, size_t len,
231 proc_t *pp, int state, pri_t pri, int detachstate);
232 extern void zk_thread_join(kt_did_t tid);
234 #define kpreempt_disable() ((void)0)
235 #define kpreempt_enable() ((void)0)
239 #define issig(why) (FALSE)
240 #define ISSIG(thr, why) (FALSE)
245 #define MTX_MAGIC 0x9522f51362a6e326ull
246 #define MTX_INIT ((void *)NULL)
247 #define MTX_DEST ((void *)-1UL)
249 typedef struct kmutex {
252 pthread_mutex_t m_lock;
255 #define MUTEX_DEFAULT 0
256 #define MUTEX_HELD(m) ((m)->m_owner == curthread)
257 #define MUTEX_NOT_HELD(m) (!MUTEX_HELD(m))
259 extern void mutex_init(kmutex_t *mp, char *name, int type, void *cookie);
260 extern void mutex_destroy(kmutex_t *mp);
261 extern void mutex_enter(kmutex_t *mp);
262 extern void mutex_exit(kmutex_t *mp);
263 extern int mutex_tryenter(kmutex_t *mp);
264 extern void *mutex_owner(kmutex_t *mp);
265 extern int mutex_held(kmutex_t *mp);
270 #define RW_MAGIC 0x4d31fb123648e78aull
271 #define RW_INIT ((void *)NULL)
272 #define RW_DEST ((void *)-1UL)
274 typedef struct krwlock {
278 pthread_rwlock_t rw_lock;
286 #define RW_DEFAULT RW_READER
288 #define RW_READ_HELD(x) ((x)->rw_readers > 0)
289 #define RW_WRITE_HELD(x) ((x)->rw_wr_owner == curthread)
290 #define RW_LOCK_HELD(x) (RW_READ_HELD(x) || RW_WRITE_HELD(x))
292 extern void rw_init(krwlock_t *rwlp, char *name, int type, void *arg);
293 extern void rw_destroy(krwlock_t *rwlp);
294 extern void rw_enter(krwlock_t *rwlp, krw_t rw);
295 extern int rw_tryenter(krwlock_t *rwlp, krw_t rw);
296 extern int rw_tryupgrade(krwlock_t *rwlp);
297 extern void rw_exit(krwlock_t *rwlp);
298 #define rw_downgrade(rwlp) do { } while (0)
300 extern uid_t crgetuid(cred_t *cr);
301 extern gid_t crgetgid(cred_t *cr);
302 extern int crgetngroups(cred_t *cr);
303 extern gid_t *crgetgroups(cred_t *cr);
306 * Condition variables
308 #define CV_MAGIC 0xd31ea9a83b1b30c4ull
310 typedef struct kcondvar {
317 extern void cv_init(kcondvar_t *cv, char *name, int type, void *arg);
318 extern void cv_destroy(kcondvar_t *cv);
319 extern void cv_wait(kcondvar_t *cv, kmutex_t *mp);
320 extern clock_t cv_timedwait(kcondvar_t *cv, kmutex_t *mp, clock_t abstime);
321 extern void cv_signal(kcondvar_t *cv);
322 extern void cv_broadcast(kcondvar_t *cv);
323 #define cv_timedwait_interruptible(cv, mp, at) cv_timedwait(cv, mp, at)
324 #define cv_wait_interruptible(cv, mp) cv_wait(cv, mp)
325 #define cv_wait_io(cv, mp) cv_wait(cv, mp)
328 * kstat creation, installation and deletion
330 extern kstat_t *kstat_create(char *, int,
331 char *, char *, uchar_t, ulong_t, uchar_t);
332 extern void kstat_install(kstat_t *);
333 extern void kstat_delete(kstat_t *);
338 #define KM_SLEEP UMEM_NOFAIL
339 #define KM_PUSHPAGE KM_SLEEP
340 #define KM_NOSLEEP UMEM_DEFAULT
341 #define KM_NODEBUG 0x0
342 #define KMC_NODEBUG UMC_NODEBUG
345 #define kmem_alloc(_s, _f) umem_alloc(_s, _f)
346 #define kmem_zalloc(_s, _f) umem_zalloc(_s, _f)
347 #define kmem_free(_b, _s) umem_free(_b, _s)
348 #define vmem_alloc(_s, _f) kmem_alloc(_s, _f)
349 #define vmem_zalloc(_s, _f) kmem_zalloc(_s, _f)
350 #define vmem_free(_b, _s) kmem_free(_b, _s)
351 #define kmem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i) \
352 umem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i)
353 #define kmem_cache_destroy(_c) umem_cache_destroy(_c)
354 #define kmem_cache_alloc(_c, _f) umem_cache_alloc(_c, _f)
355 #define kmem_cache_free(_c, _b) umem_cache_free(_c, _b)
356 #define kmem_debugging() 0
357 #define kmem_cache_reap_now(_c) /* nothing */
358 #define kmem_cache_set_move(_c, _cb) /* nothing */
359 #define POINTER_INVALIDATE(_pp) /* nothing */
360 #define POINTER_IS_VALID(_p) 0
362 typedef umem_cache_t kmem_cache_t;
364 typedef enum kmem_cbrc {
375 typedef struct taskq taskq_t;
376 typedef uintptr_t taskqid_t;
377 typedef void (task_func_t)(void *);
379 typedef struct taskq_ent {
380 struct taskq_ent *tqent_next;
381 struct taskq_ent *tqent_prev;
382 task_func_t *tqent_func;
384 uintptr_t tqent_flags;
387 #define TQENT_FLAG_PREALLOC 0x1 /* taskq_dispatch_ent used */
389 #define TASKQ_PREPOPULATE 0x0001
390 #define TASKQ_CPR_SAFE 0x0002 /* Use CPR safe protocol */
391 #define TASKQ_DYNAMIC 0x0004 /* Use dynamic thread scheduling */
392 #define TASKQ_THREADS_CPU_PCT 0x0008 /* Scale # threads by # cpus */
393 #define TASKQ_DC_BATCH 0x0010 /* Mark threads as batch */
395 #define TQ_SLEEP KM_SLEEP /* Can block for memory */
396 #define TQ_NOSLEEP KM_NOSLEEP /* cannot block for memory; may fail */
397 #define TQ_PUSHPAGE KM_PUSHPAGE /* Cannot perform I/O */
398 #define TQ_NOQUEUE 0x02 /* Do not enqueue if can't dispatch */
399 #define TQ_FRONT 0x08 /* Queue in front */
401 extern taskq_t *system_taskq;
403 extern taskq_t *taskq_create(const char *, int, pri_t, int, int, uint_t);
404 #define taskq_create_proc(a, b, c, d, e, p, f) \
405 (taskq_create(a, b, c, d, e, f))
406 #define taskq_create_sysdc(a, b, d, e, p, dc, f) \
407 (taskq_create(a, b, maxclsyspri, d, e, f))
408 extern taskqid_t taskq_dispatch(taskq_t *, task_func_t, void *, uint_t);
409 extern void taskq_dispatch_ent(taskq_t *, task_func_t, void *, uint_t,
411 extern int taskq_empty_ent(taskq_ent_t *);
412 extern void taskq_init_ent(taskq_ent_t *);
413 extern void taskq_destroy(taskq_t *);
414 extern void taskq_wait(taskq_t *);
415 extern int taskq_member(taskq_t *, kthread_t *);
416 extern void system_taskq_init(void);
417 extern void system_taskq_fini(void);
419 #define XVA_MAPSIZE 3
420 #define XVA_MAGIC 0x78766174
425 typedef struct vnode {
431 #define AV_SCANSTAMP_SZ 32 /* length of anti-virus scanstamp */
433 typedef struct xoptattr {
434 timestruc_t xoa_createtime; /* Create time of file */
437 uint8_t xoa_readonly;
439 uint8_t xoa_nounlink;
440 uint8_t xoa_immutable;
441 uint8_t xoa_appendonly;
443 uint8_t xoa_settable;
445 uint8_t xoa_av_quarantined;
446 uint8_t xoa_av_modified;
447 uint8_t xoa_av_scanstamp[AV_SCANSTAMP_SZ];
453 typedef struct vattr {
454 uint_t va_mask; /* bit-mask of attributes */
455 u_offset_t va_size; /* file size in bytes */
459 typedef struct xvattr {
460 vattr_t xva_vattr; /* Embedded vattr structure */
461 uint32_t xva_magic; /* Magic Number */
462 uint32_t xva_mapsize; /* Size of attr bitmap (32-bit words) */
463 uint32_t *xva_rtnattrmapp; /* Ptr to xva_rtnattrmap[] */
464 uint32_t xva_reqattrmap[XVA_MAPSIZE]; /* Requested attrs */
465 uint32_t xva_rtnattrmap[XVA_MAPSIZE]; /* Returned attrs */
466 xoptattr_t xva_xoptattrs; /* Optional attributes */
469 typedef struct vsecattr {
470 uint_t vsa_mask; /* See below */
471 int vsa_aclcnt; /* ACL entry count */
472 void *vsa_aclentp; /* pointer to ACL entries */
473 int vsa_dfaclcnt; /* default ACL entry count */
474 void *vsa_dfaclentp; /* pointer to default ACL entries */
475 size_t vsa_aclentsz; /* ACE size in bytes of vsa_aclentp */
478 #define AT_TYPE 0x00001
479 #define AT_MODE 0x00002
480 #define AT_UID 0x00004
481 #define AT_GID 0x00008
482 #define AT_FSID 0x00010
483 #define AT_NODEID 0x00020
484 #define AT_NLINK 0x00040
485 #define AT_SIZE 0x00080
486 #define AT_ATIME 0x00100
487 #define AT_MTIME 0x00200
488 #define AT_CTIME 0x00400
489 #define AT_RDEV 0x00800
490 #define AT_BLKSIZE 0x01000
491 #define AT_NBLOCKS 0x02000
492 #define AT_SEQ 0x08000
493 #define AT_XVATTR 0x10000
497 extern int fop_getattr(vnode_t *vp, vattr_t *vap);
499 #define VOP_CLOSE(vp, f, c, o, cr, ct) vn_close(vp)
500 #define VOP_PUTPAGE(vp, of, sz, fl, cr, ct) 0
501 #define VOP_GETATTR(vp, vap, fl, cr, ct) fop_getattr((vp), (vap));
503 #define VOP_FSYNC(vp, f, cr, ct) fsync((vp)->v_fd)
505 #define VN_RELE(vp) vn_close(vp)
507 extern int vn_open(char *path, int x1, int oflags, int mode, vnode_t **vpp,
509 extern int vn_openat(char *path, int x1, int oflags, int mode, vnode_t **vpp,
510 int x2, int x3, vnode_t *vp, int fd);
511 extern int vn_rdwr(int uio, vnode_t *vp, void *addr, ssize_t len,
512 offset_t offset, int x1, int x2, rlim64_t x3, void *x4, ssize_t *residp);
513 extern void vn_close(vnode_t *vp);
515 #define vn_remove(path, x1, x2) remove(path)
516 #define vn_rename(from, to, seg) rename((from), (to))
517 #define vn_is_readonly(vp) B_FALSE
519 extern vnode_t *rootdir;
521 #include <sys/file.h> /* for FREAD, FWRITE, etc */
526 #define ddi_get_lbolt() (gethrtime() >> 23)
527 #define ddi_get_lbolt64() (gethrtime() >> 23)
528 #define hz 119 /* frequency when using gethrtime() >> 23 for lbolt */
530 extern void delay(clock_t ticks);
532 #define gethrestime_sec() time(NULL)
533 #define gethrestime(t) \
535 (t)->tv_sec = gethrestime_sec();\
541 #define minclsyspri 60
542 #define maxclsyspri 99
544 #define CPU_SEQID (pthread_self() & (max_ncpus - 1))
549 #define ptob(x) ((x) * PAGESIZE)
551 extern uint64_t physmem;
553 extern int highbit(ulong_t i);
554 extern int random_get_bytes(uint8_t *ptr, size_t len);
555 extern int random_get_pseudo_bytes(uint8_t *ptr, size_t len);
557 extern void kernel_init(int);
558 extern void kernel_fini(void);
561 extern void nicenum(uint64_t num, char *buf);
562 extern void show_pool_stats(struct spa *);
564 typedef struct callb_cpr {
568 #define CALLB_CPR_INIT(cp, lockp, func, name) { \
569 (cp)->cc_lockp = lockp; \
572 #define CALLB_CPR_SAFE_BEGIN(cp) { \
573 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
576 #define CALLB_CPR_SAFE_END(cp, lockp) { \
577 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
580 #define CALLB_CPR_EXIT(cp) { \
581 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
582 mutex_exit((cp)->cc_lockp); \
585 #define zone_dataset_visible(x, y) (1)
586 #define INGLOBALZONE(z) (1)
588 extern char *kmem_vasprintf(const char *fmt, va_list adx);
589 extern char *kmem_asprintf(const char *fmt, ...);
590 #define strfree(str) kmem_free((str), strlen(str)+1)
593 * Hostname information
595 extern char hw_serial[]; /* for userland-emulated hostid access */
596 extern int ddi_strtoul(const char *str, char **nptr, int base,
597 unsigned long *result);
599 extern int ddi_strtoull(const char *str, char **nptr, int base,
600 u_longlong_t *result);
602 /* ZFS Boot Related stuff. */
612 typedef struct ace_object {
614 uint32_t a_access_mask;
617 uint8_t a_obj_type[16];
618 uint8_t a_inherit_obj_type[16];
622 #define ACE_ACCESS_ALLOWED_OBJECT_ACE_TYPE 0x05
623 #define ACE_ACCESS_DENIED_OBJECT_ACE_TYPE 0x06
624 #define ACE_SYSTEM_AUDIT_OBJECT_ACE_TYPE 0x07
625 #define ACE_SYSTEM_ALARM_OBJECT_ACE_TYPE 0x08
627 extern struct _buf *kobj_open_file(char *name);
628 extern int kobj_read_file(struct _buf *file, char *buf, unsigned size,
630 extern void kobj_close_file(struct _buf *file);
631 extern int kobj_get_filesize(struct _buf *file, uint64_t *size);
632 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
633 extern int zfs_secpolicy_rename_perms(const char *from, const char *to,
635 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
636 extern zoneid_t getzoneid(void);
639 typedef struct ksiddomain {
645 ksiddomain_t *ksid_lookupdomain(const char *);
646 void ksiddomain_rele(ksiddomain_t *);
648 #define DDI_SLEEP KM_SLEEP
649 #define ddi_log_sysevent(_a, _b, _c, _d, _e, _f, _g) \
650 sysevent_post_event(_c, _d, _b, "libzpool", _e, _f)
654 #endif /* _SYS_ZFS_CONTEXT_H */