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 curthread zk_thread_current()
213 #define thread_exit zk_thread_exit
214 #define thread_create(stk, stksize, func, arg, len, pp, state, pri) \
215 zk_thread_create(stk, stksize, (thread_func_t)func, arg, \
216 len, NULL, state, pri, PTHREAD_CREATE_DETACHED)
217 #define thread_join(t) zk_thread_join(t)
218 #define newproc(f,a,cid,pri,ctp,pid) (ENOSYS)
220 extern kthread_t
*zk_thread_current(void);
221 extern void zk_thread_exit(void);
222 extern kthread_t
*zk_thread_create(caddr_t stk
, size_t stksize
,
223 thread_func_t func
, void *arg
, size_t len
,
224 proc_t
*pp
, int state
, pri_t pri
, int detachstate
);
225 extern void zk_thread_join(kt_did_t tid
);
227 #define kpreempt_disable() ((void)0)
228 #define kpreempt_enable() ((void)0)
232 #define issig(why) (FALSE)
233 #define ISSIG(thr, why) (FALSE)
238 #define MTX_MAGIC 0x9522f51362a6e326ull
239 #define MTX_INIT ((void *)NULL)
240 #define MTX_DEST ((void *)-1UL)
242 typedef struct kmutex
{
245 pthread_mutex_t m_lock
;
248 #define MUTEX_DEFAULT 0
249 #define MUTEX_HELD(m) ((m)->m_owner == curthread)
250 #define MUTEX_NOT_HELD(m) (!MUTEX_HELD(m))
252 extern void mutex_init(kmutex_t
*mp
, char *name
, int type
, void *cookie
);
253 extern void mutex_destroy(kmutex_t
*mp
);
254 extern void mutex_enter(kmutex_t
*mp
);
255 extern void mutex_exit(kmutex_t
*mp
);
256 extern int mutex_tryenter(kmutex_t
*mp
);
257 extern void *mutex_owner(kmutex_t
*mp
);
258 extern int mutex_held(kmutex_t
*mp
);
263 #define RW_MAGIC 0x4d31fb123648e78aull
264 #define RW_INIT ((void *)NULL)
265 #define RW_DEST ((void *)-1UL)
267 typedef struct krwlock
{
271 pthread_rwlock_t rw_lock
;
279 #define RW_DEFAULT RW_READER
281 #define RW_READ_HELD(x) ((x)->rw_readers > 0)
282 #define RW_WRITE_HELD(x) ((x)->rw_wr_owner == curthread)
283 #define RW_LOCK_HELD(x) (RW_READ_HELD(x) || RW_WRITE_HELD(x))
286 #define RW_LOCK_HELD(x) (RW_READ_HELD(x) || RW_WRITE_HELD(x))
289 #define RW_LOCK_HELD(x) (RW_READ_HELD(x) || RW_WRITE_HELD(x))
291 extern void rw_init(krwlock_t
*rwlp
, char *name
, int type
, void *arg
);
292 extern void rw_destroy(krwlock_t
*rwlp
);
293 extern void rw_enter(krwlock_t
*rwlp
, krw_t rw
);
294 extern int rw_tryenter(krwlock_t
*rwlp
, krw_t rw
);
295 extern int rw_tryupgrade(krwlock_t
*rwlp
);
296 extern void rw_exit(krwlock_t
*rwlp
);
297 #define rw_downgrade(rwlp) do { } while (0)
299 extern uid_t
crgetuid(cred_t
*cr
);
300 extern uid_t
crgetruid(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 * Thread-specific data
330 #define tsd_get(k) pthread_getspecific(k)
331 #define tsd_set(k, v) pthread_setspecific(k, v)
332 #define tsd_create(kp, d) pthread_key_create(kp, d)
333 #define tsd_destroy(kp) /* nothing */
336 * Thread-specific data
338 #define tsd_get(k) pthread_getspecific(k)
339 #define tsd_set(k, v) pthread_setspecific(k, v)
340 #define tsd_create(kp, d) pthread_key_create(kp, d)
341 #define tsd_destroy(kp) /* nothing */
344 * kstat creation, installation and deletion
346 extern kstat_t
*kstat_create(char *, int,
347 char *, char *, uchar_t
, ulong_t
, uchar_t
);
348 extern void kstat_install(kstat_t
*);
349 extern void kstat_delete(kstat_t
*);
354 #define KM_SLEEP UMEM_NOFAIL
355 #define KM_PUSHPAGE KM_SLEEP
356 #define KM_NOSLEEP UMEM_DEFAULT
357 #define KM_NODEBUG 0x0
358 #define KMC_NODEBUG UMC_NODEBUG
361 #define kmem_alloc(_s, _f) umem_alloc(_s, _f)
362 #define kmem_zalloc(_s, _f) umem_zalloc(_s, _f)
363 #define kmem_free(_b, _s) umem_free(_b, _s)
364 #define vmem_alloc(_s, _f) kmem_alloc(_s, _f)
365 #define vmem_zalloc(_s, _f) kmem_zalloc(_s, _f)
366 #define vmem_free(_b, _s) kmem_free(_b, _s)
367 #define kmem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i) \
368 umem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i)
369 #define kmem_cache_destroy(_c) umem_cache_destroy(_c)
370 #define kmem_cache_alloc(_c, _f) umem_cache_alloc(_c, _f)
371 #define kmem_cache_free(_c, _b) umem_cache_free(_c, _b)
372 #define kmem_debugging() 0
373 #define kmem_cache_reap_now(_c) /* nothing */
374 #define kmem_cache_set_move(_c, _cb) /* nothing */
375 #define POINTER_INVALIDATE(_pp) /* nothing */
376 #define POINTER_IS_VALID(_p) 0
378 typedef umem_cache_t kmem_cache_t
;
380 typedef enum kmem_cbrc
{
391 typedef struct taskq taskq_t
;
392 typedef uintptr_t taskqid_t
;
393 typedef void (task_func_t
)(void *);
395 typedef struct taskq_ent
{
396 struct taskq_ent
*tqent_next
;
397 struct taskq_ent
*tqent_prev
;
398 task_func_t
*tqent_func
;
400 uintptr_t tqent_flags
;
403 #define TQENT_FLAG_PREALLOC 0x1 /* taskq_dispatch_ent used */
405 #define TASKQ_PREPOPULATE 0x0001
406 #define TASKQ_CPR_SAFE 0x0002 /* Use CPR safe protocol */
407 #define TASKQ_DYNAMIC 0x0004 /* Use dynamic thread scheduling */
408 #define TASKQ_THREADS_CPU_PCT 0x0008 /* Scale # threads by # cpus */
409 #define TASKQ_DC_BATCH 0x0010 /* Mark threads as batch */
411 #define TQ_SLEEP KM_SLEEP /* Can block for memory */
412 #define TQ_NOSLEEP KM_NOSLEEP /* cannot block for memory; may fail */
413 #define TQ_PUSHPAGE KM_PUSHPAGE /* Cannot perform I/O */
414 #define TQ_NOQUEUE 0x02 /* Do not enqueue if can't dispatch */
415 #define TQ_FRONT 0x08 /* Queue in front */
417 extern taskq_t
*system_taskq
;
419 extern taskq_t
*taskq_create(const char *, int, pri_t
, int, int, uint_t
);
420 #define taskq_create_proc(a, b, c, d, e, p, f) \
421 (taskq_create(a, b, c, d, e, f))
422 #define taskq_create_sysdc(a, b, d, e, p, dc, f) \
423 (taskq_create(a, b, maxclsyspri, d, e, f))
424 extern taskqid_t
taskq_dispatch(taskq_t
*, task_func_t
, void *, uint_t
);
425 extern taskqid_t
taskq_dispatch_delay(taskq_t
*, task_func_t
, void *, uint_t
,
427 extern void taskq_dispatch_ent(taskq_t
*, task_func_t
, void *, uint_t
,
429 extern int taskq_empty_ent(taskq_ent_t
*);
430 extern void taskq_init_ent(taskq_ent_t
*);
431 extern void taskq_destroy(taskq_t
*);
432 extern void taskq_wait(taskq_t
*);
433 extern void taskq_wait_id(taskq_t
*, taskqid_t
);
434 extern int taskq_member(taskq_t
*, kthread_t
*);
435 extern int taskq_cancel_id(taskq_t
*, taskqid_t
);
436 extern void system_taskq_init(void);
437 extern void system_taskq_fini(void);
439 #define XVA_MAPSIZE 3
440 #define XVA_MAGIC 0x78766174
445 typedef struct vnode
{
451 #define AV_SCANSTAMP_SZ 32 /* length of anti-virus scanstamp */
453 typedef struct xoptattr
{
454 timestruc_t xoa_createtime
; /* Create time of file */
457 uint8_t xoa_readonly
;
459 uint8_t xoa_nounlink
;
460 uint8_t xoa_immutable
;
461 uint8_t xoa_appendonly
;
463 uint8_t xoa_settable
;
465 uint8_t xoa_av_quarantined
;
466 uint8_t xoa_av_modified
;
467 uint8_t xoa_av_scanstamp
[AV_SCANSTAMP_SZ
];
473 typedef struct vattr
{
474 uint_t va_mask
; /* bit-mask of attributes */
475 u_offset_t va_size
; /* file size in bytes */
479 typedef struct xvattr
{
480 vattr_t xva_vattr
; /* Embedded vattr structure */
481 uint32_t xva_magic
; /* Magic Number */
482 uint32_t xva_mapsize
; /* Size of attr bitmap (32-bit words) */
483 uint32_t *xva_rtnattrmapp
; /* Ptr to xva_rtnattrmap[] */
484 uint32_t xva_reqattrmap
[XVA_MAPSIZE
]; /* Requested attrs */
485 uint32_t xva_rtnattrmap
[XVA_MAPSIZE
]; /* Returned attrs */
486 xoptattr_t xva_xoptattrs
; /* Optional attributes */
489 typedef struct vsecattr
{
490 uint_t vsa_mask
; /* See below */
491 int vsa_aclcnt
; /* ACL entry count */
492 void *vsa_aclentp
; /* pointer to ACL entries */
493 int vsa_dfaclcnt
; /* default ACL entry count */
494 void *vsa_dfaclentp
; /* pointer to default ACL entries */
495 size_t vsa_aclentsz
; /* ACE size in bytes of vsa_aclentp */
498 #define AT_TYPE 0x00001
499 #define AT_MODE 0x00002
500 #define AT_UID 0x00004
501 #define AT_GID 0x00008
502 #define AT_FSID 0x00010
503 #define AT_NODEID 0x00020
504 #define AT_NLINK 0x00040
505 #define AT_SIZE 0x00080
506 #define AT_ATIME 0x00100
507 #define AT_MTIME 0x00200
508 #define AT_CTIME 0x00400
509 #define AT_RDEV 0x00800
510 #define AT_BLKSIZE 0x01000
511 #define AT_NBLOCKS 0x02000
512 #define AT_SEQ 0x08000
513 #define AT_XVATTR 0x10000
517 extern int fop_getattr(vnode_t
*vp
, vattr_t
*vap
);
519 #define VOP_CLOSE(vp, f, c, o, cr, ct) vn_close(vp)
520 #define VOP_PUTPAGE(vp, of, sz, fl, cr, ct) 0
521 #define VOP_GETATTR(vp, vap, fl, cr, ct) fop_getattr((vp), (vap));
523 #define VOP_FSYNC(vp, f, cr, ct) fsync((vp)->v_fd)
525 #define VN_RELE(vp) vn_close(vp)
527 extern int vn_open(char *path
, int x1
, int oflags
, int mode
, vnode_t
**vpp
,
529 extern int vn_openat(char *path
, int x1
, int oflags
, int mode
, vnode_t
**vpp
,
530 int x2
, int x3
, vnode_t
*vp
, int fd
);
531 extern int vn_rdwr(int uio
, vnode_t
*vp
, void *addr
, ssize_t len
,
532 offset_t offset
, int x1
, int x2
, rlim64_t x3
, void *x4
, ssize_t
*residp
);
533 extern void vn_close(vnode_t
*vp
);
535 #define vn_remove(path, x1, x2) remove(path)
536 #define vn_rename(from, to, seg) rename((from), (to))
537 #define vn_is_readonly(vp) B_FALSE
539 extern vnode_t
*rootdir
;
541 #include <sys/file.h> /* for FREAD, FWRITE, etc */
546 #define ddi_get_lbolt() (gethrtime() >> 23)
547 #define ddi_get_lbolt64() (gethrtime() >> 23)
548 #define hz 119 /* frequency when using gethrtime() >> 23 for lbolt */
550 extern void delay(clock_t ticks
);
552 #define SEC_TO_TICK(sec) ((sec) * hz)
553 #define MSEC_TO_TICK(msec) ((msec) / (MILLISEC / hz))
554 #define USEC_TO_TICK(usec) ((usec) / (MICROSEC / hz))
555 #define NSEC_TO_TICK(usec) ((usec) / (NANOSEC / hz))
557 #define gethrestime_sec() time(NULL)
558 #define gethrestime(t) \
560 (t)->tv_sec = gethrestime_sec();\
566 #define minclsyspri 60
567 #define maxclsyspri 99
569 #define CPU_SEQID (pthread_self() & (max_ncpus - 1))
574 #define ptob(x) ((x) * PAGESIZE)
576 extern uint64_t physmem
;
578 extern int highbit(ulong_t i
);
579 extern int random_get_bytes(uint8_t *ptr
, size_t len
);
580 extern int random_get_pseudo_bytes(uint8_t *ptr
, size_t len
);
582 extern void kernel_init(int);
583 extern void kernel_fini(void);
586 extern void nicenum(uint64_t num
, char *buf
);
587 extern void show_pool_stats(struct spa
*);
589 typedef struct callb_cpr
{
593 #define CALLB_CPR_INIT(cp, lockp, func, name) { \
594 (cp)->cc_lockp = lockp; \
597 #define CALLB_CPR_SAFE_BEGIN(cp) { \
598 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
601 #define CALLB_CPR_SAFE_END(cp, lockp) { \
602 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
605 #define CALLB_CPR_EXIT(cp) { \
606 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
607 mutex_exit((cp)->cc_lockp); \
610 #define zone_dataset_visible(x, y) (1)
611 #define INGLOBALZONE(z) (1)
613 extern char *kmem_vasprintf(const char *fmt
, va_list adx
);
614 extern char *kmem_asprintf(const char *fmt
, ...);
615 #define strfree(str) kmem_free((str), strlen(str) + 1)
618 * Hostname information
620 extern char hw_serial
[]; /* for userland-emulated hostid access */
621 extern int ddi_strtoul(const char *str
, char **nptr
, int base
,
622 unsigned long *result
);
624 extern int ddi_strtoull(const char *str
, char **nptr
, int base
,
625 u_longlong_t
*result
);
627 /* ZFS Boot Related stuff. */
637 typedef struct ace_object
{
639 uint32_t a_access_mask
;
642 uint8_t a_obj_type
[16];
643 uint8_t a_inherit_obj_type
[16];
647 #define ACE_ACCESS_ALLOWED_OBJECT_ACE_TYPE 0x05
648 #define ACE_ACCESS_DENIED_OBJECT_ACE_TYPE 0x06
649 #define ACE_SYSTEM_AUDIT_OBJECT_ACE_TYPE 0x07
650 #define ACE_SYSTEM_ALARM_OBJECT_ACE_TYPE 0x08
652 extern struct _buf
*kobj_open_file(char *name
);
653 extern int kobj_read_file(struct _buf
*file
, char *buf
, unsigned size
,
655 extern void kobj_close_file(struct _buf
*file
);
656 extern int kobj_get_filesize(struct _buf
*file
, uint64_t *size
);
657 extern int zfs_secpolicy_snapshot_perms(const char *name
, cred_t
*cr
);
658 extern int zfs_secpolicy_rename_perms(const char *from
, const char *to
,
660 extern int zfs_secpolicy_destroy_perms(const char *name
, cred_t
*cr
);
661 extern zoneid_t
getzoneid(void);
664 typedef struct ksiddomain
{
670 ksiddomain_t
*ksid_lookupdomain(const char *);
671 void ksiddomain_rele(ksiddomain_t
*);
673 #define DDI_SLEEP KM_SLEEP
674 #define ddi_log_sysevent(_a, _b, _c, _d, _e, _f, _g) \
675 sysevent_post_event(_c, _d, _b, "libzpool", _e, _f)
679 #endif /* _SYS_ZFS_CONTEXT_H */