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>
63 #include <sys/zfs_debug.h>
64 #include <sys/fm/fs/zfs.h>
65 #include <sys/sunddi.h>
66 #include <sys/ctype.h>
68 #include <linux/dcache_compat.h>
74 #define _SYS_CONDVAR_H
100 #include <sys/note.h>
101 #include <sys/types.h>
102 #include <sys/cred.h>
103 #include <sys/sysmacros.h>
104 #include <sys/bitmap.h>
105 #include <sys/resource.h>
106 #include <sys/byteorder.h>
107 #include <sys/list.h>
109 #include <sys/zfs_debug.h>
111 #include <sys/kstat.h>
112 #include <sys/u8_textprep.h>
113 #include <sys/fm/fs/zfs.h>
114 #include <sys/sunddi.h>
115 #include <sys/debug.h>
121 #define noinline __attribute__((noinline))
128 * Note that we are not using the debugging levels.
131 #define CE_CONT 0 /* continuation */
132 #define CE_NOTE 1 /* notice */
133 #define CE_WARN 2 /* warning */
134 #define CE_PANIC 3 /* panic */
135 #define CE_IGNORE 4 /* print nothing */
143 extern void dprintf_setup(int *argc
, char **argv
);
144 extern void __dprintf(const char *file
, const char *func
,
145 int line
, const char *fmt
, ...);
146 extern void cmn_err(int, const char *, ...);
147 extern void vcmn_err(int, const char *, __va_list
);
148 extern void panic(const char *, ...);
149 extern void vpanic(const char *, __va_list
);
151 #define fm_panic panic
155 * DTrace SDT probes have different signatures in userland than they do in
156 * kernel. If they're being used in kernel code, re-define them out of
157 * existence for their counterparts in libzpool.
162 #endif /* DTRACE_PROBE */
163 #define DTRACE_PROBE(a) \
168 #endif /* DTRACE_PROBE1 */
169 #define DTRACE_PROBE1(a, b, c) \
170 ZFS_PROBE1(#a, (unsigned long)c)
174 #endif /* DTRACE_PROBE2 */
175 #define DTRACE_PROBE2(a, b, c, d, e) \
176 ZFS_PROBE2(#a, (unsigned long)c, (unsigned long)e)
180 #endif /* DTRACE_PROBE3 */
181 #define DTRACE_PROBE3(a, b, c, d, e, f, g) \
182 ZFS_PROBE3(#a, (unsigned long)c, (unsigned long)e, (unsigned long)g)
186 #endif /* DTRACE_PROBE4 */
187 #define DTRACE_PROBE4(a, b, c, d, e, f, g, h, i) \
188 ZFS_PROBE4(#a, (unsigned long)c, (unsigned long)e, (unsigned long)g, \
192 * We use the comma operator so that this macro can be used without much
193 * additional code. For example, "return (EINVAL);" becomes
194 * "return (SET_ERROR(EINVAL));". Note that the argument will be evaluated
195 * twice, so it should not have side effects (e.g. something like:
196 * "return (SET_ERROR(log_error(EINVAL, info)));" would log the error twice).
198 #define SET_ERROR(err) (ZFS_SET_ERROR(err), err)
200 #define SET_ERROR(err) (err)
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 /* 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
;
219 #define curproc (&p0)
221 typedef void (*thread_func_t
)(void *);
222 typedef void (*thread_func_arg_t
)(void *);
223 typedef pthread_t kt_did_t
;
225 typedef struct kthread
{
227 thread_func_t t_func
;
231 #define curthread zk_thread_current()
232 #define getcomm() "unknown"
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, PTHREAD_CREATE_DETACHED)
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
, int detachstate
);
245 extern void zk_thread_join(kt_did_t tid
);
247 #define kpreempt_disable() ((void)0)
248 #define kpreempt_enable() ((void)0)
252 #define issig(why) (FALSE)
253 #define ISSIG(thr, why) (FALSE)
258 #define MTX_MAGIC 0x9522f51362a6e326ull
259 #define MTX_INIT ((void *)NULL)
260 #define MTX_DEST ((void *)-1UL)
262 typedef struct kmutex
{
265 pthread_mutex_t m_lock
;
268 #define MUTEX_DEFAULT 0
269 #define MUTEX_HELD(m) ((m)->m_owner == curthread)
270 #define MUTEX_NOT_HELD(m) (!MUTEX_HELD(m))
272 extern void mutex_init(kmutex_t
*mp
, char *name
, int type
, void *cookie
);
273 extern void mutex_destroy(kmutex_t
*mp
);
274 extern void mutex_enter(kmutex_t
*mp
);
275 extern void mutex_exit(kmutex_t
*mp
);
276 extern int mutex_tryenter(kmutex_t
*mp
);
277 extern void *mutex_owner(kmutex_t
*mp
);
278 extern int mutex_held(kmutex_t
*mp
);
283 #define RW_MAGIC 0x4d31fb123648e78aull
284 #define RW_INIT ((void *)NULL)
285 #define RW_DEST ((void *)-1UL)
287 typedef struct krwlock
{
291 pthread_rwlock_t rw_lock
;
299 #define RW_DEFAULT RW_READER
301 #define RW_READ_HELD(x) ((x)->rw_readers > 0)
302 #define RW_WRITE_HELD(x) ((x)->rw_wr_owner == curthread)
303 #define RW_LOCK_HELD(x) (RW_READ_HELD(x) || RW_WRITE_HELD(x))
306 #define RW_LOCK_HELD(x) (RW_READ_HELD(x) || RW_WRITE_HELD(x))
309 #define RW_LOCK_HELD(x) (RW_READ_HELD(x) || RW_WRITE_HELD(x))
311 extern void rw_init(krwlock_t
*rwlp
, char *name
, int type
, void *arg
);
312 extern void rw_destroy(krwlock_t
*rwlp
);
313 extern void rw_enter(krwlock_t
*rwlp
, krw_t rw
);
314 extern int rw_tryenter(krwlock_t
*rwlp
, krw_t rw
);
315 extern int rw_tryupgrade(krwlock_t
*rwlp
);
316 extern void rw_exit(krwlock_t
*rwlp
);
317 #define rw_downgrade(rwlp) do { } while (0)
319 extern uid_t
crgetuid(cred_t
*cr
);
320 extern uid_t
crgetruid(cred_t
*cr
);
321 extern gid_t
crgetgid(cred_t
*cr
);
322 extern int crgetngroups(cred_t
*cr
);
323 extern gid_t
*crgetgroups(cred_t
*cr
);
326 * Condition variables
328 #define CV_MAGIC 0xd31ea9a83b1b30c4ull
330 typedef struct kcondvar
{
337 extern void cv_init(kcondvar_t
*cv
, char *name
, int type
, void *arg
);
338 extern void cv_destroy(kcondvar_t
*cv
);
339 extern void cv_wait(kcondvar_t
*cv
, kmutex_t
*mp
);
340 extern clock_t cv_timedwait(kcondvar_t
*cv
, kmutex_t
*mp
, clock_t abstime
);
341 extern void cv_signal(kcondvar_t
*cv
);
342 extern void cv_broadcast(kcondvar_t
*cv
);
343 #define cv_timedwait_interruptible(cv, mp, at) cv_timedwait(cv, mp, at)
344 #define cv_wait_interruptible(cv, mp) cv_wait(cv, mp)
345 #define cv_wait_io(cv, mp) cv_wait(cv, mp)
348 * Thread-specific data
350 #define tsd_get(k) pthread_getspecific(k)
351 #define tsd_set(k, v) pthread_setspecific(k, v)
352 #define tsd_create(kp, d) pthread_key_create(kp, d)
353 #define tsd_destroy(kp) /* nothing */
356 * Thread-specific data
358 #define tsd_get(k) pthread_getspecific(k)
359 #define tsd_set(k, v) pthread_setspecific(k, v)
360 #define tsd_create(kp, d) pthread_key_create(kp, d)
361 #define tsd_destroy(kp) /* nothing */
364 * kstat creation, installation and deletion
366 extern kstat_t
*kstat_create(const char *, int,
367 const char *, const char *, uchar_t
, ulong_t
, uchar_t
);
368 extern void kstat_install(kstat_t
*);
369 extern void kstat_delete(kstat_t
*);
370 extern void kstat_waitq_enter(kstat_io_t
*);
371 extern void kstat_waitq_exit(kstat_io_t
*);
372 extern void kstat_runq_enter(kstat_io_t
*);
373 extern void kstat_runq_exit(kstat_io_t
*);
374 extern void kstat_waitq_to_runq(kstat_io_t
*);
375 extern void kstat_runq_back_to_waitq(kstat_io_t
*);
376 extern void kstat_set_raw_ops(kstat_t
*ksp
,
377 int (*headers
)(char *buf
, size_t size
),
378 int (*data
)(char *buf
, size_t size
, void *data
),
379 void *(*addr
)(kstat_t
*ksp
, loff_t index
));
384 #define KM_SLEEP UMEM_NOFAIL
385 #define KM_PUSHPAGE KM_SLEEP
386 #define KM_NOSLEEP UMEM_DEFAULT
387 #define KM_NODEBUG 0x0
388 #define KMC_NODEBUG UMC_NODEBUG
391 #define kmem_alloc(_s, _f) umem_alloc(_s, _f)
392 #define kmem_zalloc(_s, _f) umem_zalloc(_s, _f)
393 #define kmem_free(_b, _s) umem_free(_b, _s)
394 #define vmem_alloc(_s, _f) kmem_alloc(_s, _f)
395 #define vmem_zalloc(_s, _f) kmem_zalloc(_s, _f)
396 #define vmem_free(_b, _s) kmem_free(_b, _s)
397 #define kmem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i) \
398 umem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i)
399 #define kmem_cache_destroy(_c) umem_cache_destroy(_c)
400 #define kmem_cache_alloc(_c, _f) umem_cache_alloc(_c, _f)
401 #define kmem_cache_free(_c, _b) umem_cache_free(_c, _b)
402 #define kmem_debugging() 0
403 #define kmem_cache_reap_now(_c) /* nothing */
404 #define kmem_cache_set_move(_c, _cb) /* nothing */
405 #define POINTER_INVALIDATE(_pp) /* nothing */
406 #define POINTER_IS_VALID(_p) 0
408 typedef umem_cache_t kmem_cache_t
;
410 typedef enum kmem_cbrc
{
421 typedef struct taskq taskq_t
;
422 typedef uintptr_t taskqid_t
;
423 typedef void (task_func_t
)(void *);
425 typedef struct taskq_ent
{
426 struct taskq_ent
*tqent_next
;
427 struct taskq_ent
*tqent_prev
;
428 task_func_t
*tqent_func
;
430 uintptr_t tqent_flags
;
433 #define TQENT_FLAG_PREALLOC 0x1 /* taskq_dispatch_ent used */
435 #define TASKQ_PREPOPULATE 0x0001
436 #define TASKQ_CPR_SAFE 0x0002 /* Use CPR safe protocol */
437 #define TASKQ_DYNAMIC 0x0004 /* Use dynamic thread scheduling */
438 #define TASKQ_THREADS_CPU_PCT 0x0008 /* Scale # threads by # cpus */
439 #define TASKQ_DC_BATCH 0x0010 /* Mark threads as batch */
441 #define TQ_SLEEP KM_SLEEP /* Can block for memory */
442 #define TQ_NOSLEEP KM_NOSLEEP /* cannot block for memory; may fail */
443 #define TQ_PUSHPAGE KM_PUSHPAGE /* Cannot perform I/O */
444 #define TQ_NOQUEUE 0x02 /* Do not enqueue if can't dispatch */
445 #define TQ_FRONT 0x08 /* Queue in front */
447 extern taskq_t
*system_taskq
;
449 extern taskq_t
*taskq_create(const char *, int, pri_t
, int, int, uint_t
);
450 #define taskq_create_proc(a, b, c, d, e, p, f) \
451 (taskq_create(a, b, c, d, e, f))
452 #define taskq_create_sysdc(a, b, d, e, p, dc, f) \
453 (taskq_create(a, b, maxclsyspri, d, e, f))
454 extern taskqid_t
taskq_dispatch(taskq_t
*, task_func_t
, void *, uint_t
);
455 extern taskqid_t
taskq_dispatch_delay(taskq_t
*, task_func_t
, void *, uint_t
,
457 extern void taskq_dispatch_ent(taskq_t
*, task_func_t
, void *, uint_t
,
459 extern int taskq_empty_ent(taskq_ent_t
*);
460 extern void taskq_init_ent(taskq_ent_t
*);
461 extern void taskq_destroy(taskq_t
*);
462 extern void taskq_wait(taskq_t
*);
463 extern void taskq_wait_id(taskq_t
*, taskqid_t
);
464 extern int taskq_member(taskq_t
*, kthread_t
*);
465 extern int taskq_cancel_id(taskq_t
*, taskqid_t
);
466 extern void system_taskq_init(void);
467 extern void system_taskq_fini(void);
469 #define XVA_MAPSIZE 3
470 #define XVA_MAGIC 0x78766174
475 typedef struct vnode
{
481 #define AV_SCANSTAMP_SZ 32 /* length of anti-virus scanstamp */
483 typedef struct xoptattr
{
484 timestruc_t xoa_createtime
; /* Create time of file */
487 uint8_t xoa_readonly
;
489 uint8_t xoa_nounlink
;
490 uint8_t xoa_immutable
;
491 uint8_t xoa_appendonly
;
493 uint8_t xoa_settable
;
495 uint8_t xoa_av_quarantined
;
496 uint8_t xoa_av_modified
;
497 uint8_t xoa_av_scanstamp
[AV_SCANSTAMP_SZ
];
503 typedef struct vattr
{
504 uint_t va_mask
; /* bit-mask of attributes */
505 u_offset_t va_size
; /* file size in bytes */
509 typedef struct xvattr
{
510 vattr_t xva_vattr
; /* Embedded vattr structure */
511 uint32_t xva_magic
; /* Magic Number */
512 uint32_t xva_mapsize
; /* Size of attr bitmap (32-bit words) */
513 uint32_t *xva_rtnattrmapp
; /* Ptr to xva_rtnattrmap[] */
514 uint32_t xva_reqattrmap
[XVA_MAPSIZE
]; /* Requested attrs */
515 uint32_t xva_rtnattrmap
[XVA_MAPSIZE
]; /* Returned attrs */
516 xoptattr_t xva_xoptattrs
; /* Optional attributes */
519 typedef struct vsecattr
{
520 uint_t vsa_mask
; /* See below */
521 int vsa_aclcnt
; /* ACL entry count */
522 void *vsa_aclentp
; /* pointer to ACL entries */
523 int vsa_dfaclcnt
; /* default ACL entry count */
524 void *vsa_dfaclentp
; /* pointer to default ACL entries */
525 size_t vsa_aclentsz
; /* ACE size in bytes of vsa_aclentp */
528 #define AT_TYPE 0x00001
529 #define AT_MODE 0x00002
530 #define AT_UID 0x00004
531 #define AT_GID 0x00008
532 #define AT_FSID 0x00010
533 #define AT_NODEID 0x00020
534 #define AT_NLINK 0x00040
535 #define AT_SIZE 0x00080
536 #define AT_ATIME 0x00100
537 #define AT_MTIME 0x00200
538 #define AT_CTIME 0x00400
539 #define AT_RDEV 0x00800
540 #define AT_BLKSIZE 0x01000
541 #define AT_NBLOCKS 0x02000
542 #define AT_SEQ 0x08000
543 #define AT_XVATTR 0x10000
547 extern int fop_getattr(vnode_t
*vp
, vattr_t
*vap
);
549 #define VOP_CLOSE(vp, f, c, o, cr, ct) vn_close(vp)
550 #define VOP_PUTPAGE(vp, of, sz, fl, cr, ct) 0
551 #define VOP_GETATTR(vp, vap, fl, cr, ct) fop_getattr((vp), (vap));
553 #define VOP_FSYNC(vp, f, cr, ct) fsync((vp)->v_fd)
555 #define VN_RELE(vp) vn_close(vp)
557 extern int vn_open(char *path
, int x1
, int oflags
, int mode
, vnode_t
**vpp
,
559 extern int vn_openat(char *path
, int x1
, int oflags
, int mode
, vnode_t
**vpp
,
560 int x2
, int x3
, vnode_t
*vp
, int fd
);
561 extern int vn_rdwr(int uio
, vnode_t
*vp
, void *addr
, ssize_t len
,
562 offset_t offset
, int x1
, int x2
, rlim64_t x3
, void *x4
, ssize_t
*residp
);
563 extern void vn_close(vnode_t
*vp
);
565 #define vn_remove(path, x1, x2) remove(path)
566 #define vn_rename(from, to, seg) rename((from), (to))
567 #define vn_is_readonly(vp) B_FALSE
569 extern vnode_t
*rootdir
;
571 #include <sys/file.h> /* for FREAD, FWRITE, etc */
576 #define ddi_get_lbolt() (gethrtime() >> 23)
577 #define ddi_get_lbolt64() (gethrtime() >> 23)
578 #define hz 119 /* frequency when using gethrtime() >> 23 for lbolt */
580 extern void delay(clock_t ticks
);
582 #define SEC_TO_TICK(sec) ((sec) * hz)
583 #define MSEC_TO_TICK(msec) ((msec) / (MILLISEC / hz))
584 #define USEC_TO_TICK(usec) ((usec) / (MICROSEC / hz))
585 #define NSEC_TO_TICK(usec) ((usec) / (NANOSEC / hz))
587 #define gethrestime_sec() time(NULL)
588 #define gethrestime(t) \
590 (t)->tv_sec = gethrestime_sec();\
596 #define minclsyspri 60
597 #define maxclsyspri 99
599 #define CPU_SEQID (pthread_self() & (max_ncpus - 1))
604 #define ptob(x) ((x) * PAGESIZE)
606 extern uint64_t physmem
;
608 extern int highbit(ulong_t i
);
609 extern int random_get_bytes(uint8_t *ptr
, size_t len
);
610 extern int random_get_pseudo_bytes(uint8_t *ptr
, size_t len
);
612 extern void kernel_init(int);
613 extern void kernel_fini(void);
616 extern void nicenum(uint64_t num
, char *buf
);
617 extern void show_pool_stats(struct spa
*);
619 typedef struct callb_cpr
{
623 #define CALLB_CPR_INIT(cp, lockp, func, name) { \
624 (cp)->cc_lockp = lockp; \
627 #define CALLB_CPR_SAFE_BEGIN(cp) { \
628 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
631 #define CALLB_CPR_SAFE_END(cp, lockp) { \
632 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
635 #define CALLB_CPR_EXIT(cp) { \
636 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
637 mutex_exit((cp)->cc_lockp); \
640 #define zone_dataset_visible(x, y) (1)
641 #define INGLOBALZONE(z) (1)
643 extern char *kmem_vasprintf(const char *fmt
, va_list adx
);
644 extern char *kmem_asprintf(const char *fmt
, ...);
645 #define strfree(str) kmem_free((str), strlen(str) + 1)
648 * Hostname information
650 extern char hw_serial
[]; /* for userland-emulated hostid access */
651 extern int ddi_strtoul(const char *str
, char **nptr
, int base
,
652 unsigned long *result
);
654 extern int ddi_strtoull(const char *str
, char **nptr
, int base
,
655 u_longlong_t
*result
);
657 /* ZFS Boot Related stuff. */
667 typedef struct ace_object
{
669 uint32_t a_access_mask
;
672 uint8_t a_obj_type
[16];
673 uint8_t a_inherit_obj_type
[16];
677 #define ACE_ACCESS_ALLOWED_OBJECT_ACE_TYPE 0x05
678 #define ACE_ACCESS_DENIED_OBJECT_ACE_TYPE 0x06
679 #define ACE_SYSTEM_AUDIT_OBJECT_ACE_TYPE 0x07
680 #define ACE_SYSTEM_ALARM_OBJECT_ACE_TYPE 0x08
682 extern struct _buf
*kobj_open_file(char *name
);
683 extern int kobj_read_file(struct _buf
*file
, char *buf
, unsigned size
,
685 extern void kobj_close_file(struct _buf
*file
);
686 extern int kobj_get_filesize(struct _buf
*file
, uint64_t *size
);
687 extern int zfs_secpolicy_snapshot_perms(const char *name
, cred_t
*cr
);
688 extern int zfs_secpolicy_rename_perms(const char *from
, const char *to
,
690 extern int zfs_secpolicy_destroy_perms(const char *name
, cred_t
*cr
);
691 extern zoneid_t
getzoneid(void);
694 typedef struct ksiddomain
{
700 ksiddomain_t
*ksid_lookupdomain(const char *);
701 void ksiddomain_rele(ksiddomain_t
*);
703 #define DDI_SLEEP KM_SLEEP
704 #define ddi_log_sysevent(_a, _b, _c, _d, _e, _f, _g) \
705 sysevent_post_event(_c, _d, _b, "libzpool", _e, _f)
709 #endif /* _SYS_ZFS_CONTEXT_H */