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.
28 * Copyright (c) 2012 by Delphix. All rights reserved.
31 #ifndef _SYS_ZFS_CONTEXT_H
32 #define _SYS_ZFS_CONTEXT_H
37 #include <sys/types.h>
38 #include <sys/t_lock.h>
39 #include <sys/atomic.h>
40 #include <sys/sysmacros.h>
41 #include <sys/bitmap.h>
42 #include <sys/cmn_err.h>
44 #include <sys/taskq.h>
46 #include <sys/param.h>
47 #include <sys/systm.h>
48 #include <sys/cpuvar.h>
52 #include <sys/debug.h>
53 #include <sys/random.h>
54 #include <sys/byteorder.h>
55 #include <sys/systm.h>
57 #include <sys/uio_impl.h>
58 #include <sys/dirent.h>
60 #include <vm/seg_kmem.h>
62 #include <sys/zfs_debug.h>
63 #include <sys/fm/fs/zfs.h>
64 #include <sys/sunddi.h>
65 #include <sys/ctype.h>
67 #include <linux/dcache_compat.h>
73 #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>
114 #include <sys/debug.h>
120 #define noinline __attribute__((noinline))
127 * Note that we are not using the debugging levels.
130 #define CE_CONT 0 /* continuation */
131 #define CE_NOTE 1 /* notice */
132 #define CE_WARN 2 /* warning */
133 #define CE_PANIC 3 /* panic */
134 #define CE_IGNORE 4 /* print nothing */
142 extern void dprintf_setup(int *argc, char **argv);
143 extern void __dprintf(const char *file, const char *func,
144 int line, const char *fmt, ...);
145 extern void cmn_err(int, const char *, ...);
146 extern void vcmn_err(int, const char *, __va_list);
147 extern void panic(const char *, ...);
148 extern void vpanic(const char *, __va_list);
150 #define fm_panic panic
153 * DTrace SDT probes have different signatures in userland than they do in
154 * kernel. If they're being used in kernel code, re-define them out of
155 * existence for their counterparts in libzpool.
160 #define DTRACE_PROBE(a) ((void)0)
161 #endif /* DTRACE_PROBE */
165 #define DTRACE_PROBE1(a, b, c) ((void)0)
166 #endif /* DTRACE_PROBE1 */
170 #define DTRACE_PROBE2(a, b, c, d, e) ((void)0)
171 #endif /* DTRACE_PROBE2 */
175 #define DTRACE_PROBE3(a, b, c, d, e, f, g) ((void)0)
176 #endif /* DTRACE_PROBE3 */
180 #define DTRACE_PROBE4(a, b, c, d, e, f, g, h, i) ((void)0)
181 #endif /* DTRACE_PROBE4 */
186 #define TS_MAGIC 0x72f158ab4261e538ull
187 #define TS_RUN 0x00000002
189 #define STACK_SIZE 8192 /* Linux x86 and amd64 */
191 #define STACK_SIZE 24576 /* Solaris */
194 /* in libzpool, p0 exists only to have its address taken */
195 typedef struct proc {
196 uintptr_t this_is_never_used_dont_dereference_it;
199 extern struct proc p0;
200 #define curproc (&p0)
202 typedef void (*thread_func_t)(void *);
203 typedef void (*thread_func_arg_t)(void *);
204 typedef pthread_t kt_did_t;
206 typedef struct kthread {
208 thread_func_t t_func;
212 #define tsd_get(key) pthread_getspecific(key)
213 #define tsd_set(key, val) pthread_setspecific(key, val)
214 #define curthread zk_thread_current()
215 #define thread_exit zk_thread_exit
216 #define thread_create(stk, stksize, func, arg, len, pp, state, pri) \
217 zk_thread_create(stk, stksize, (thread_func_t)func, arg, \
218 len, NULL, state, pri, PTHREAD_CREATE_DETACHED)
219 #define thread_join(t) zk_thread_join(t)
220 #define newproc(f,a,cid,pri,ctp,pid) (ENOSYS)
222 extern kthread_t *zk_thread_current(void);
223 extern void zk_thread_exit(void);
224 extern kthread_t *zk_thread_create(caddr_t stk, size_t stksize,
225 thread_func_t func, void *arg, size_t len,
226 proc_t *pp, int state, pri_t pri, int detachstate);
227 extern void zk_thread_join(kt_did_t tid);
229 #define kpreempt_disable() ((void)0)
230 #define kpreempt_enable() ((void)0)
234 #define issig(why) (FALSE)
235 #define ISSIG(thr, why) (FALSE)
240 #define MTX_MAGIC 0x9522f51362a6e326ull
241 #define MTX_INIT ((void *)NULL)
242 #define MTX_DEST ((void *)-1UL)
244 typedef struct kmutex {
247 pthread_mutex_t m_lock;
250 #define MUTEX_DEFAULT 0
251 #define MUTEX_HELD(m) ((m)->m_owner == curthread)
252 #define MUTEX_NOT_HELD(m) (!MUTEX_HELD(m))
254 extern void mutex_init(kmutex_t *mp, char *name, int type, void *cookie);
255 extern void mutex_destroy(kmutex_t *mp);
256 extern void mutex_enter(kmutex_t *mp);
257 extern void mutex_exit(kmutex_t *mp);
258 extern int mutex_tryenter(kmutex_t *mp);
259 extern void *mutex_owner(kmutex_t *mp);
260 extern int mutex_held(kmutex_t *mp);
265 #define RW_MAGIC 0x4d31fb123648e78aull
266 #define RW_INIT ((void *)NULL)
267 #define RW_DEST ((void *)-1UL)
269 typedef struct krwlock {
273 pthread_rwlock_t rw_lock;
281 #define RW_DEFAULT RW_READER
283 #define RW_READ_HELD(x) ((x)->rw_readers > 0)
284 #define RW_WRITE_HELD(x) ((x)->rw_wr_owner == curthread)
285 #define RW_LOCK_HELD(x) (RW_READ_HELD(x) || RW_WRITE_HELD(x))
287 extern void rw_init(krwlock_t *rwlp, char *name, int type, void *arg);
288 extern void rw_destroy(krwlock_t *rwlp);
289 extern void rw_enter(krwlock_t *rwlp, krw_t rw);
290 extern int rw_tryenter(krwlock_t *rwlp, krw_t rw);
291 extern int rw_tryupgrade(krwlock_t *rwlp);
292 extern void rw_exit(krwlock_t *rwlp);
293 #define rw_downgrade(rwlp) do { } while (0)
295 extern uid_t crgetuid(cred_t *cr);
296 extern gid_t crgetgid(cred_t *cr);
297 extern int crgetngroups(cred_t *cr);
298 extern gid_t *crgetgroups(cred_t *cr);
301 * Condition variables
303 #define CV_MAGIC 0xd31ea9a83b1b30c4ull
305 typedef struct kcondvar {
312 extern void cv_init(kcondvar_t *cv, char *name, int type, void *arg);
313 extern void cv_destroy(kcondvar_t *cv);
314 extern void cv_wait(kcondvar_t *cv, kmutex_t *mp);
315 extern clock_t cv_timedwait(kcondvar_t *cv, kmutex_t *mp, clock_t abstime);
316 extern void cv_signal(kcondvar_t *cv);
317 extern void cv_broadcast(kcondvar_t *cv);
318 #define cv_timedwait_interruptible(cv, mp, at) cv_timedwait(cv, mp, at)
319 #define cv_wait_interruptible(cv, mp) cv_wait(cv, mp)
320 #define cv_wait_io(cv, mp) cv_wait(cv, mp)
323 * kstat creation, installation and deletion
325 extern kstat_t *kstat_create(char *, int,
326 char *, char *, uchar_t, ulong_t, uchar_t);
327 extern void kstat_install(kstat_t *);
328 extern void kstat_delete(kstat_t *);
333 #define KM_SLEEP UMEM_NOFAIL
334 #define KM_PUSHPAGE KM_SLEEP
335 #define KM_NOSLEEP UMEM_DEFAULT
336 #define KM_NODEBUG 0x0
337 #define KMC_NODEBUG UMC_NODEBUG
340 #define kmem_alloc(_s, _f) umem_alloc(_s, _f)
341 #define kmem_zalloc(_s, _f) umem_zalloc(_s, _f)
342 #define kmem_free(_b, _s) umem_free(_b, _s)
343 #define vmem_alloc(_s, _f) kmem_alloc(_s, _f)
344 #define vmem_zalloc(_s, _f) kmem_zalloc(_s, _f)
345 #define vmem_free(_b, _s) kmem_free(_b, _s)
346 #define kmem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i) \
347 umem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i)
348 #define kmem_cache_destroy(_c) umem_cache_destroy(_c)
349 #define kmem_cache_alloc(_c, _f) umem_cache_alloc(_c, _f)
350 #define kmem_cache_free(_c, _b) umem_cache_free(_c, _b)
351 #define kmem_debugging() 0
352 #define kmem_cache_reap_now(_c) /* nothing */
353 #define kmem_cache_set_move(_c, _cb) /* nothing */
354 #define POINTER_INVALIDATE(_pp) /* nothing */
355 #define POINTER_IS_VALID(_p) 0
357 typedef umem_cache_t kmem_cache_t;
359 typedef enum kmem_cbrc {
370 typedef struct taskq taskq_t;
371 typedef uintptr_t taskqid_t;
372 typedef void (task_func_t)(void *);
374 typedef struct taskq_ent {
375 struct taskq_ent *tqent_next;
376 struct taskq_ent *tqent_prev;
377 task_func_t *tqent_func;
379 uintptr_t tqent_flags;
382 #define TQENT_FLAG_PREALLOC 0x1 /* taskq_dispatch_ent used */
384 #define TASKQ_PREPOPULATE 0x0001
385 #define TASKQ_CPR_SAFE 0x0002 /* Use CPR safe protocol */
386 #define TASKQ_DYNAMIC 0x0004 /* Use dynamic thread scheduling */
387 #define TASKQ_THREADS_CPU_PCT 0x0008 /* Scale # threads by # cpus */
388 #define TASKQ_DC_BATCH 0x0010 /* Mark threads as batch */
390 #define TQ_SLEEP KM_SLEEP /* Can block for memory */
391 #define TQ_NOSLEEP KM_NOSLEEP /* cannot block for memory; may fail */
392 #define TQ_PUSHPAGE KM_PUSHPAGE /* Cannot perform I/O */
393 #define TQ_NOQUEUE 0x02 /* Do not enqueue if can't dispatch */
394 #define TQ_FRONT 0x08 /* Queue in front */
396 extern taskq_t *system_taskq;
398 extern taskq_t *taskq_create(const char *, int, pri_t, int, int, uint_t);
399 #define taskq_create_proc(a, b, c, d, e, p, f) \
400 (taskq_create(a, b, c, d, e, f))
401 #define taskq_create_sysdc(a, b, d, e, p, dc, f) \
402 (taskq_create(a, b, maxclsyspri, d, e, f))
403 extern taskqid_t taskq_dispatch(taskq_t *, task_func_t, void *, uint_t);
404 extern taskqid_t taskq_dispatch_delay(taskq_t *, task_func_t, void *, uint_t,
406 extern void taskq_dispatch_ent(taskq_t *, task_func_t, void *, uint_t,
408 extern int taskq_empty_ent(taskq_ent_t *);
409 extern void taskq_init_ent(taskq_ent_t *);
410 extern void taskq_destroy(taskq_t *);
411 extern void taskq_wait(taskq_t *);
412 extern void taskq_wait_id(taskq_t *, taskqid_t);
413 extern int taskq_member(taskq_t *, kthread_t *);
414 extern int taskq_cancel_id(taskq_t *, taskqid_t);
415 extern void system_taskq_init(void);
416 extern void system_taskq_fini(void);
418 #define XVA_MAPSIZE 3
419 #define XVA_MAGIC 0x78766174
424 typedef struct vnode {
430 #define AV_SCANSTAMP_SZ 32 /* length of anti-virus scanstamp */
432 typedef struct xoptattr {
433 timestruc_t xoa_createtime; /* Create time of file */
436 uint8_t xoa_readonly;
438 uint8_t xoa_nounlink;
439 uint8_t xoa_immutable;
440 uint8_t xoa_appendonly;
442 uint8_t xoa_settable;
444 uint8_t xoa_av_quarantined;
445 uint8_t xoa_av_modified;
446 uint8_t xoa_av_scanstamp[AV_SCANSTAMP_SZ];
452 typedef struct vattr {
453 uint_t va_mask; /* bit-mask of attributes */
454 u_offset_t va_size; /* file size in bytes */
458 typedef struct xvattr {
459 vattr_t xva_vattr; /* Embedded vattr structure */
460 uint32_t xva_magic; /* Magic Number */
461 uint32_t xva_mapsize; /* Size of attr bitmap (32-bit words) */
462 uint32_t *xva_rtnattrmapp; /* Ptr to xva_rtnattrmap[] */
463 uint32_t xva_reqattrmap[XVA_MAPSIZE]; /* Requested attrs */
464 uint32_t xva_rtnattrmap[XVA_MAPSIZE]; /* Returned attrs */
465 xoptattr_t xva_xoptattrs; /* Optional attributes */
468 typedef struct vsecattr {
469 uint_t vsa_mask; /* See below */
470 int vsa_aclcnt; /* ACL entry count */
471 void *vsa_aclentp; /* pointer to ACL entries */
472 int vsa_dfaclcnt; /* default ACL entry count */
473 void *vsa_dfaclentp; /* pointer to default ACL entries */
474 size_t vsa_aclentsz; /* ACE size in bytes of vsa_aclentp */
477 #define AT_TYPE 0x00001
478 #define AT_MODE 0x00002
479 #define AT_UID 0x00004
480 #define AT_GID 0x00008
481 #define AT_FSID 0x00010
482 #define AT_NODEID 0x00020
483 #define AT_NLINK 0x00040
484 #define AT_SIZE 0x00080
485 #define AT_ATIME 0x00100
486 #define AT_MTIME 0x00200
487 #define AT_CTIME 0x00400
488 #define AT_RDEV 0x00800
489 #define AT_BLKSIZE 0x01000
490 #define AT_NBLOCKS 0x02000
491 #define AT_SEQ 0x08000
492 #define AT_XVATTR 0x10000
496 extern int fop_getattr(vnode_t *vp, vattr_t *vap);
498 #define VOP_CLOSE(vp, f, c, o, cr, ct) vn_close(vp)
499 #define VOP_PUTPAGE(vp, of, sz, fl, cr, ct) 0
500 #define VOP_GETATTR(vp, vap, fl, cr, ct) fop_getattr((vp), (vap));
502 #define VOP_FSYNC(vp, f, cr, ct) fsync((vp)->v_fd)
504 #define VN_RELE(vp) vn_close(vp)
506 extern int vn_open(char *path, int x1, int oflags, int mode, vnode_t **vpp,
508 extern int vn_openat(char *path, int x1, int oflags, int mode, vnode_t **vpp,
509 int x2, int x3, vnode_t *vp, int fd);
510 extern int vn_rdwr(int uio, vnode_t *vp, void *addr, ssize_t len,
511 offset_t offset, int x1, int x2, rlim64_t x3, void *x4, ssize_t *residp);
512 extern void vn_close(vnode_t *vp);
514 #define vn_remove(path, x1, x2) remove(path)
515 #define vn_rename(from, to, seg) rename((from), (to))
516 #define vn_is_readonly(vp) B_FALSE
518 extern vnode_t *rootdir;
520 #include <sys/file.h> /* for FREAD, FWRITE, etc */
525 #define ddi_get_lbolt() (gethrtime() >> 23)
526 #define ddi_get_lbolt64() (gethrtime() >> 23)
527 #define hz 119 /* frequency when using gethrtime() >> 23 for lbolt */
529 extern void delay(clock_t ticks);
531 #define SEC_TO_TICK(sec) ((sec) * hz)
532 #define MSEC_TO_TICK(msec) ((msec) / (MILLISEC / hz))
533 #define USEC_TO_TICK(usec) ((usec) / (MICROSEC / hz))
534 #define NSEC_TO_TICK(usec) ((usec) / (NANOSEC / hz))
536 #define gethrestime_sec() time(NULL)
537 #define gethrestime(t) \
539 (t)->tv_sec = gethrestime_sec();\
545 #define minclsyspri 60
546 #define maxclsyspri 99
548 #define CPU_SEQID (pthread_self() & (max_ncpus - 1))
553 #define ptob(x) ((x) * PAGESIZE)
555 extern uint64_t physmem;
557 extern int highbit(ulong_t i);
558 extern int random_get_bytes(uint8_t *ptr, size_t len);
559 extern int random_get_pseudo_bytes(uint8_t *ptr, size_t len);
561 extern void kernel_init(int);
562 extern void kernel_fini(void);
565 extern void nicenum(uint64_t num, char *buf);
566 extern void show_pool_stats(struct spa *);
568 typedef struct callb_cpr {
572 #define CALLB_CPR_INIT(cp, lockp, func, name) { \
573 (cp)->cc_lockp = lockp; \
576 #define CALLB_CPR_SAFE_BEGIN(cp) { \
577 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
580 #define CALLB_CPR_SAFE_END(cp, lockp) { \
581 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
584 #define CALLB_CPR_EXIT(cp) { \
585 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
586 mutex_exit((cp)->cc_lockp); \
589 #define zone_dataset_visible(x, y) (1)
590 #define INGLOBALZONE(z) (1)
592 extern char *kmem_vasprintf(const char *fmt, va_list adx);
593 extern char *kmem_asprintf(const char *fmt, ...);
594 #define strfree(str) kmem_free((str), strlen(str)+1)
597 * Hostname information
599 extern char hw_serial[]; /* for userland-emulated hostid access */
600 extern int ddi_strtoul(const char *str, char **nptr, int base,
601 unsigned long *result);
603 extern int ddi_strtoull(const char *str, char **nptr, int base,
604 u_longlong_t *result);
606 /* ZFS Boot Related stuff. */
616 typedef struct ace_object {
618 uint32_t a_access_mask;
621 uint8_t a_obj_type[16];
622 uint8_t a_inherit_obj_type[16];
626 #define ACE_ACCESS_ALLOWED_OBJECT_ACE_TYPE 0x05
627 #define ACE_ACCESS_DENIED_OBJECT_ACE_TYPE 0x06
628 #define ACE_SYSTEM_AUDIT_OBJECT_ACE_TYPE 0x07
629 #define ACE_SYSTEM_ALARM_OBJECT_ACE_TYPE 0x08
631 extern struct _buf *kobj_open_file(char *name);
632 extern int kobj_read_file(struct _buf *file, char *buf, unsigned size,
634 extern void kobj_close_file(struct _buf *file);
635 extern int kobj_get_filesize(struct _buf *file, uint64_t *size);
636 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
637 extern int zfs_secpolicy_rename_perms(const char *from, const char *to,
639 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
640 extern zoneid_t getzoneid(void);
643 typedef struct ksiddomain {
649 ksiddomain_t *ksid_lookupdomain(const char *);
650 void ksiddomain_rele(ksiddomain_t *);
652 #define DDI_SLEEP KM_SLEEP
653 #define ddi_log_sysevent(_a, _b, _c, _d, _e, _f, _g) \
654 sysevent_post_event(_c, _d, _b, "libzpool", _e, _f)
658 #endif /* _SYS_ZFS_CONTEXT_H */