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.
29 #ifndef _SYS_ZFS_CONTEXT_H
30 #define _SYS_ZFS_CONTEXT_H
35 #include <sys/types.h>
36 #include <sys/t_lock.h>
37 #include <sys/atomic.h>
38 #include <sys/sysmacros.h>
39 #include <sys/bitmap.h>
40 #include <sys/cmn_err.h>
42 #include <sys/taskq.h>
44 #include <sys/param.h>
45 #include <sys/systm.h>
46 #include <sys/cpuvar.h>
50 #include <sys/debug.h>
51 #include <sys/random.h>
52 #include <sys/byteorder.h>
53 #include <sys/systm.h>
55 #include <sys/uio_impl.h>
56 #include <sys/dirent.h>
58 #include <vm/seg_kmem.h>
60 #include <sys/zfs_debug.h>
61 #include <sys/fm/fs/zfs.h>
62 #include <sys/sunddi.h>
63 #include <linux/dcache_compat.h>
69 #define _SYS_CONDVAR_H
96 #include <sys/types.h>
98 #include <sys/sysmacros.h>
99 #include <sys/bitmap.h>
100 #include <sys/resource.h>
101 #include <sys/byteorder.h>
102 #include <sys/list.h>
104 #include <sys/zfs_debug.h>
106 #include <sys/kstat.h>
107 #include <sys/u8_textprep.h>
108 #include <sys/fm/fs/zfs.h>
109 #include <sys/sunddi.h>
115 #define noinline __attribute__((noinline))
122 * Note that we are not using the debugging levels.
125 #define CE_CONT 0 /* continuation */
126 #define CE_NOTE 1 /* notice */
127 #define CE_WARN 2 /* warning */
128 #define CE_PANIC 3 /* panic */
129 #define CE_IGNORE 4 /* print nothing */
137 extern void dprintf_setup(int *argc, char **argv);
138 extern void __dprintf(const char *file, const char *func,
139 int line, const char *fmt, ...);
140 extern void cmn_err(int, const char *, ...);
141 extern void vcmn_err(int, const char *, __va_list);
142 extern void panic(const char *, ...);
143 extern void vpanic(const char *, __va_list);
145 #define fm_panic panic
148 * DTrace SDT probes have different signatures in userland than they do in
149 * kernel. If they're being used in kernel code, re-define them out of
150 * existence for their counterparts in libzpool.
155 #define DTRACE_PROBE(a) ((void)0)
156 #endif /* DTRACE_PROBE */
160 #define DTRACE_PROBE1(a, b, c) ((void)0)
161 #endif /* DTRACE_PROBE1 */
165 #define DTRACE_PROBE2(a, b, c, d, e) ((void)0)
166 #endif /* DTRACE_PROBE2 */
170 #define DTRACE_PROBE3(a, b, c, d, e, f, g) ((void)0)
171 #endif /* DTRACE_PROBE3 */
175 #define DTRACE_PROBE4(a, b, c, d, e, f, g, h, i) ((void)0)
176 #endif /* DTRACE_PROBE4 */
181 #define TS_MAGIC 0x72f158ab4261e538ull
182 #define TS_RUN 0x00000002
184 #define STACK_SIZE 8192 /* Linux x86 and amd64 */
186 #define STACK_SIZE 24576 /* Solaris */
189 #ifdef NPTL_GUARD_WITHIN_STACK
190 #define EXTRA_GUARD_BYTES PAGESIZE
192 #define EXTRA_GUARD_BYTES 0
195 /* in libzpool, p0 exists only to have its address taken */
196 typedef struct proc {
197 uintptr_t this_is_never_used_dont_dereference_it;
200 extern struct proc 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)
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);
227 extern void zk_thread_join(kt_did_t tid);
231 #define issig(why) (FALSE)
232 #define ISSIG(thr, why) (FALSE)
237 #define MTX_MAGIC 0x9522f51362a6e326ull
238 #define MTX_INIT ((void *)NULL)
239 #define MTX_DEST ((void *)-1UL)
241 typedef struct kmutex {
244 pthread_mutex_t m_lock;
247 #define MUTEX_DEFAULT 0
248 #define MUTEX_HELD(m) ((m)->m_owner == curthread)
249 #define MUTEX_NOT_HELD(m) (!MUTEX_HELD(m))
251 extern void mutex_init(kmutex_t *mp, char *name, int type, void *cookie);
252 extern void mutex_destroy(kmutex_t *mp);
253 extern void mutex_enter(kmutex_t *mp);
254 extern void mutex_exit(kmutex_t *mp);
255 extern int mutex_tryenter(kmutex_t *mp);
256 extern void *mutex_owner(kmutex_t *mp);
257 extern int mutex_held(kmutex_t *mp);
262 #define RW_MAGIC 0x4d31fb123648e78aull
263 #define RW_INIT ((void *)NULL)
264 #define RW_DEST ((void *)-1UL)
266 typedef struct krwlock {
270 pthread_rwlock_t rw_lock;
278 #define RW_DEFAULT RW_READER
280 #define RW_READ_HELD(x) ((x)->rw_readers > 0)
281 #define RW_WRITE_HELD(x) ((x)->rw_wr_owner == curthread)
282 #define RW_LOCK_HELD(x) (RW_READ_HELD(x) || RW_WRITE_HELD(x))
284 extern void rw_init(krwlock_t *rwlp, char *name, int type, void *arg);
285 extern void rw_destroy(krwlock_t *rwlp);
286 extern void rw_enter(krwlock_t *rwlp, krw_t rw);
287 extern int rw_tryenter(krwlock_t *rwlp, krw_t rw);
288 extern int rw_tryupgrade(krwlock_t *rwlp);
289 extern void rw_exit(krwlock_t *rwlp);
290 #define rw_downgrade(rwlp) do { } while (0)
292 extern uid_t crgetuid(cred_t *cr);
293 extern gid_t crgetgid(cred_t *cr);
294 extern int crgetngroups(cred_t *cr);
295 extern gid_t *crgetgroups(cred_t *cr);
298 * Condition variables
300 #define CV_MAGIC 0xd31ea9a83b1b30c4ull
302 typedef struct kcondvar {
309 extern void cv_init(kcondvar_t *cv, char *name, int type, void *arg);
310 extern void cv_destroy(kcondvar_t *cv);
311 extern void cv_wait(kcondvar_t *cv, kmutex_t *mp);
312 extern clock_t cv_timedwait(kcondvar_t *cv, kmutex_t *mp, clock_t abstime);
313 extern void cv_signal(kcondvar_t *cv);
314 extern void cv_broadcast(kcondvar_t *cv);
315 #define cv_timedwait_interruptible(cv, mp, at) cv_timedwait(cv, mp, at)
316 #define cv_wait_interruptible(cv, mp) cv_wait(cv, mp)
319 * kstat creation, installation and deletion
321 extern kstat_t *kstat_create(char *, int,
322 char *, char *, uchar_t, ulong_t, uchar_t);
323 extern void kstat_install(kstat_t *);
324 extern void kstat_delete(kstat_t *);
329 #define KM_SLEEP UMEM_NOFAIL
330 #define KM_PUSHPAGE KM_SLEEP
331 #define KM_NOSLEEP UMEM_DEFAULT
332 #define KM_NODEBUG 0x0
333 #define KMC_NODEBUG UMC_NODEBUG
336 #define kmem_alloc(_s, _f) umem_alloc(_s, _f)
337 #define kmem_zalloc(_s, _f) umem_zalloc(_s, _f)
338 #define kmem_free(_b, _s) umem_free(_b, _s)
339 #define vmem_alloc(_s, _f) kmem_alloc(_s, _f)
340 #define vmem_zalloc(_s, _f) kmem_zalloc(_s, _f)
341 #define vmem_free(_b, _s) kmem_free(_b, _s)
342 #define kmem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i) \
343 umem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i)
344 #define kmem_cache_destroy(_c) umem_cache_destroy(_c)
345 #define kmem_cache_alloc(_c, _f) umem_cache_alloc(_c, _f)
346 #define kmem_cache_free(_c, _b) umem_cache_free(_c, _b)
347 #define kmem_debugging() 0
348 #define kmem_cache_reap_now(_c) /* nothing */
349 #define kmem_cache_set_move(_c, _cb) /* nothing */
350 #define POINTER_INVALIDATE(_pp) /* nothing */
351 #define POINTER_IS_VALID(_p) 0
353 typedef umem_cache_t kmem_cache_t;
355 typedef enum kmem_cbrc {
366 typedef struct taskq taskq_t;
367 typedef uintptr_t taskqid_t;
368 typedef void (task_func_t)(void *);
370 typedef struct taskq_ent {
371 struct taskq_ent *tqent_next;
372 struct taskq_ent *tqent_prev;
373 task_func_t *tqent_func;
375 uintptr_t tqent_flags;
378 #define TQENT_FLAG_PREALLOC 0x1 /* taskq_dispatch_ent used */
380 #define TASKQ_PREPOPULATE 0x0001
381 #define TASKQ_CPR_SAFE 0x0002 /* Use CPR safe protocol */
382 #define TASKQ_DYNAMIC 0x0004 /* Use dynamic thread scheduling */
383 #define TASKQ_THREADS_CPU_PCT 0x0008 /* Scale # threads by # cpus */
384 #define TASKQ_DC_BATCH 0x0010 /* Mark threads as batch */
385 #define TASKQ_NORECLAIM 0x0020 /* Disable direct memory reclaim */
387 #define TQ_SLEEP KM_SLEEP /* Can block for memory */
388 #define TQ_NOSLEEP KM_NOSLEEP /* cannot block for memory; may fail */
389 #define TQ_NOQUEUE 0x02 /* Do not enqueue if can't dispatch */
390 #define TQ_FRONT 0x08 /* Queue in front */
392 extern taskq_t *system_taskq;
394 extern taskq_t *taskq_create(const char *, int, pri_t, int, int, uint_t);
395 #define taskq_create_proc(a, b, c, d, e, p, f) \
396 (taskq_create(a, b, c, d, e, f))
397 #define taskq_create_sysdc(a, b, d, e, p, dc, f) \
398 (taskq_create(a, b, maxclsyspri, d, e, f))
399 extern taskqid_t taskq_dispatch(taskq_t *, task_func_t, void *, uint_t);
400 extern void taskq_dispatch_ent(taskq_t *, task_func_t, void *, uint_t,
402 extern int taskq_empty_ent(taskq_ent_t *);
403 extern void taskq_init_ent(taskq_ent_t *);
404 extern void taskq_destroy(taskq_t *);
405 extern void taskq_wait(taskq_t *);
406 extern int taskq_member(taskq_t *, kthread_t *);
407 extern void system_taskq_init(void);
408 extern void system_taskq_fini(void);
410 #define XVA_MAPSIZE 3
411 #define XVA_MAGIC 0x78766174
416 typedef struct vnode {
422 #define AV_SCANSTAMP_SZ 32 /* length of anti-virus scanstamp */
424 typedef struct xoptattr {
425 timestruc_t xoa_createtime; /* Create time of file */
428 uint8_t xoa_readonly;
430 uint8_t xoa_nounlink;
431 uint8_t xoa_immutable;
432 uint8_t xoa_appendonly;
434 uint8_t xoa_settable;
436 uint8_t xoa_av_quarantined;
437 uint8_t xoa_av_modified;
438 uint8_t xoa_av_scanstamp[AV_SCANSTAMP_SZ];
444 typedef struct vattr {
445 uint_t va_mask; /* bit-mask of attributes */
446 u_offset_t va_size; /* file size in bytes */
450 typedef struct xvattr {
451 vattr_t xva_vattr; /* Embedded vattr structure */
452 uint32_t xva_magic; /* Magic Number */
453 uint32_t xva_mapsize; /* Size of attr bitmap (32-bit words) */
454 uint32_t *xva_rtnattrmapp; /* Ptr to xva_rtnattrmap[] */
455 uint32_t xva_reqattrmap[XVA_MAPSIZE]; /* Requested attrs */
456 uint32_t xva_rtnattrmap[XVA_MAPSIZE]; /* Returned attrs */
457 xoptattr_t xva_xoptattrs; /* Optional attributes */
460 typedef struct vsecattr {
461 uint_t vsa_mask; /* See below */
462 int vsa_aclcnt; /* ACL entry count */
463 void *vsa_aclentp; /* pointer to ACL entries */
464 int vsa_dfaclcnt; /* default ACL entry count */
465 void *vsa_dfaclentp; /* pointer to default ACL entries */
466 size_t vsa_aclentsz; /* ACE size in bytes of vsa_aclentp */
469 #define AT_TYPE 0x00001
470 #define AT_MODE 0x00002
471 #define AT_UID 0x00004
472 #define AT_GID 0x00008
473 #define AT_FSID 0x00010
474 #define AT_NODEID 0x00020
475 #define AT_NLINK 0x00040
476 #define AT_SIZE 0x00080
477 #define AT_ATIME 0x00100
478 #define AT_MTIME 0x00200
479 #define AT_CTIME 0x00400
480 #define AT_RDEV 0x00800
481 #define AT_BLKSIZE 0x01000
482 #define AT_NBLOCKS 0x02000
483 #define AT_SEQ 0x08000
484 #define AT_XVATTR 0x10000
488 extern int fop_getattr(vnode_t *vp, vattr_t *vap);
490 #define VOP_CLOSE(vp, f, c, o, cr, ct) 0
491 #define VOP_PUTPAGE(vp, of, sz, fl, cr, ct) 0
492 #define VOP_GETATTR(vp, vap, fl, cr, ct) fop_getattr((vp), (vap));
494 #define VOP_FSYNC(vp, f, cr, ct) fsync((vp)->v_fd)
496 #define VN_RELE(vp) vn_close(vp)
498 extern int vn_open(char *path, int x1, int oflags, int mode, vnode_t **vpp,
500 extern int vn_openat(char *path, int x1, int oflags, int mode, vnode_t **vpp,
501 int x2, int x3, vnode_t *vp, int fd);
502 extern int vn_rdwr(int uio, vnode_t *vp, void *addr, ssize_t len,
503 offset_t offset, int x1, int x2, rlim64_t x3, void *x4, ssize_t *residp);
504 extern void vn_close(vnode_t *vp);
506 #define vn_remove(path, x1, x2) remove(path)
507 #define vn_rename(from, to, seg) rename((from), (to))
508 #define vn_is_readonly(vp) B_FALSE
510 extern vnode_t *rootdir;
512 #include <sys/file.h> /* for FREAD, FWRITE, etc */
517 #define ddi_get_lbolt() (gethrtime() >> 23)
518 #define ddi_get_lbolt64() (gethrtime() >> 23)
519 #define hz 119 /* frequency when using gethrtime() >> 23 for lbolt */
521 extern void delay(clock_t ticks);
523 #define gethrestime_sec() time(NULL)
524 #define gethrestime(t) \
526 (t)->tv_sec = gethrestime_sec();\
532 #define minclsyspri 60
533 #define maxclsyspri 99
535 #define CPU_SEQID (pthread_self() & (max_ncpus - 1))
540 #define ptob(x) ((x) * PAGESIZE)
542 extern uint64_t physmem;
544 extern int highbit(ulong_t i);
545 extern int random_get_bytes(uint8_t *ptr, size_t len);
546 extern int random_get_pseudo_bytes(uint8_t *ptr, size_t len);
548 extern void kernel_init(int);
549 extern void kernel_fini(void);
552 extern void nicenum(uint64_t num, char *buf);
553 extern void show_pool_stats(struct spa *);
555 typedef struct callb_cpr {
559 #define CALLB_CPR_INIT(cp, lockp, func, name) { \
560 (cp)->cc_lockp = lockp; \
563 #define CALLB_CPR_SAFE_BEGIN(cp) { \
564 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
567 #define CALLB_CPR_SAFE_END(cp, lockp) { \
568 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
571 #define CALLB_CPR_EXIT(cp) { \
572 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
573 mutex_exit((cp)->cc_lockp); \
576 #define zone_dataset_visible(x, y) (1)
577 #define INGLOBALZONE(z) (1)
579 extern char *kmem_vasprintf(const char *fmt, va_list adx);
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)
645 #endif /* _SYS_ZFS_CONTEXT_H */