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 #ifndef _SYS_ZFS_CONTEXT_H
27 #define _SYS_ZFS_CONTEXT_H
32 #include <sys/types.h>
33 #include <sys/t_lock.h>
34 #include <sys/atomic.h>
35 #include <sys/sysmacros.h>
36 #include <sys/bitmap.h>
37 #include <sys/cmn_err.h>
39 #include <sys/taskq.h>
41 #include <sys/param.h>
42 #include <sys/systm.h>
43 #include <sys/cpuvar.h>
47 #include <sys/debug.h>
48 #include <sys/random.h>
49 #include <sys/byteorder.h>
50 #include <sys/systm.h>
53 #include <sys/dirent.h>
55 #include <vm/seg_kmem.h>
58 #include <sys/zfs_debug.h>
59 #include <sys/fm/fs/zfs.h>
60 #include <sys/sunddi.h>
66 #define _SYS_CONDVAR_H
93 #include <sys/types.h>
95 #include <sys/sysmacros.h>
96 #include <sys/bitmap.h>
97 #include <sys/resource.h>
98 #include <sys/byteorder.h>
101 #include <sys/zfs_debug.h>
103 #include <sys/kstat.h>
104 #include <sys/u8_textprep.h>
105 #include <sys/fm/fs/zfs.h>
106 #include <sys/sunddi.h>
112 #define noinline __attribute__((noinline))
119 * Note that we are not using the debugging levels.
122 #define CE_CONT 0 /* continuation */
123 #define CE_NOTE 1 /* notice */
124 #define CE_WARN 2 /* warning */
125 #define CE_PANIC 3 /* panic */
126 #define CE_IGNORE 4 /* print nothing */
135 extern void dprintf_setup(int *argc, char **argv);
136 #endif /* ZFS_DEBUG */
138 extern void cmn_err(int, const char *, ...);
139 extern void vcmn_err(int, const char *, __va_list);
140 extern void panic(const char *, ...);
141 extern void vpanic(const char *, __va_list);
143 #define fm_panic panic
146 * DTrace SDT probes have different signatures in userland than they do in
147 * kernel. If they're being used in kernel code, re-define them out of
148 * existence for their counterparts in libzpool.
153 #define DTRACE_PROBE(a) ((void)0)
154 #endif /* DTRACE_PROBE */
158 #define DTRACE_PROBE1(a, b, c) ((void)0)
159 #endif /* DTRACE_PROBE1 */
163 #define DTRACE_PROBE2(a, b, c, d, e) ((void)0)
164 #endif /* DTRACE_PROBE2 */
168 #define DTRACE_PROBE3(a, b, c, d, e, f, g) ((void)0)
169 #endif /* DTRACE_PROBE3 */
173 #define DTRACE_PROBE4(a, b, c, d, e, f, g, h, i) ((void)0)
174 #endif /* DTRACE_PROBE4 */
179 #define TS_MAGIC 0x72f158ab4261e538ull
180 #define TS_RUN 0x00000002
182 #define STACK_SIZE 8192 /* Linux x86 and amd64 */
184 #define STACK_SIZE 24576 /* Solaris */
187 #ifdef NPTL_GUARD_WITHIN_STACK
188 #define EXTRA_GUARD_BYTES PAGESIZE
190 #define EXTRA_GUARD_BYTES 0
193 /* in libzpool, p0 exists only to have its address taken */
194 typedef struct proc {
195 uintptr_t this_is_never_used_dont_dereference_it;
198 extern struct proc p0;
200 typedef void (*thread_func_t)(void *);
201 typedef void (*thread_func_arg_t)(void *);
202 typedef pthread_t kt_did_t;
204 typedef struct kthread {
206 thread_func_t t_func;
210 #define tsd_get(key) pthread_getspecific(key)
211 #define tsd_set(key, val) pthread_setspecific(key, val)
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)
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);
225 extern void zk_thread_join(kt_did_t tid);
229 #define issig(why) (FALSE)
230 #define ISSIG(thr, why) (FALSE)
235 #define MTX_MAGIC 0x9522f51362a6e326ull
236 #define MTX_INIT ((void *)NULL)
237 #define MTX_DEST ((void *)-1UL)
239 typedef struct kmutex {
242 pthread_mutex_t m_lock;
245 #define MUTEX_DEFAULT 0
246 #define MUTEX_HELD(m) ((m)->m_owner == curthread)
247 #define MUTEX_NOT_HELD(m) (!MUTEX_HELD(m))
249 extern void mutex_init(kmutex_t *mp, char *name, int type, void *cookie);
250 extern void mutex_destroy(kmutex_t *mp);
251 extern void mutex_enter(kmutex_t *mp);
252 extern void mutex_exit(kmutex_t *mp);
253 extern int mutex_tryenter(kmutex_t *mp);
254 extern void *mutex_owner(kmutex_t *mp);
255 extern int mutex_held(kmutex_t *mp);
260 #define RW_MAGIC 0x4d31fb123648e78aull
261 #define RW_INIT ((void *)NULL)
262 #define RW_DEST ((void *)-1UL)
264 typedef struct krwlock {
268 pthread_rwlock_t rw_lock;
276 #define RW_DEFAULT RW_READER
278 #define RW_READ_HELD(x) ((x)->rw_readers > 0)
279 #define RW_WRITE_HELD(x) ((x)->rw_wr_owner == curthread)
280 #define RW_LOCK_HELD(x) (RW_READ_HELD(x) || RW_WRITE_HELD(x))
282 extern void rw_init(krwlock_t *rwlp, char *name, int type, void *arg);
283 extern void rw_destroy(krwlock_t *rwlp);
284 extern void rw_enter(krwlock_t *rwlp, krw_t rw);
285 extern int rw_tryenter(krwlock_t *rwlp, krw_t rw);
286 extern int rw_tryupgrade(krwlock_t *rwlp);
287 extern void rw_exit(krwlock_t *rwlp);
288 #define rw_downgrade(rwlp) do { } while (0)
290 extern uid_t crgetuid(cred_t *cr);
291 extern gid_t crgetgid(cred_t *cr);
292 extern int crgetngroups(cred_t *cr);
293 extern gid_t *crgetgroups(cred_t *cr);
296 * Condition variables
298 #define CV_MAGIC 0xd31ea9a83b1b30c4ull
300 typedef struct kcondvar {
307 extern void cv_init(kcondvar_t *cv, char *name, int type, void *arg);
308 extern void cv_destroy(kcondvar_t *cv);
309 extern void cv_wait(kcondvar_t *cv, kmutex_t *mp);
310 extern clock_t cv_timedwait(kcondvar_t *cv, kmutex_t *mp, clock_t abstime);
311 extern void cv_signal(kcondvar_t *cv);
312 extern void cv_broadcast(kcondvar_t *cv);
313 #define cv_timedwait_interruptible(cv, mp, at) cv_timedwait(cv, mp, at);
316 * kstat creation, installation and deletion
318 extern kstat_t *kstat_create(char *, int,
319 char *, char *, uchar_t, ulong_t, uchar_t);
320 extern void kstat_install(kstat_t *);
321 extern void kstat_delete(kstat_t *);
326 #define KM_SLEEP UMEM_NOFAIL
327 #define KM_PUSHPAGE KM_SLEEP
328 #define KM_NOSLEEP UMEM_DEFAULT
329 #define KM_NODEBUG 0x0
330 #define KMC_NODEBUG UMC_NODEBUG
331 #define kmem_alloc(_s, _f) umem_alloc(_s, _f)
332 #define kmem_zalloc(_s, _f) umem_zalloc(_s, _f)
333 #define kmem_free(_b, _s) umem_free(_b, _s)
334 #define vmem_alloc(_s, _f) kmem_alloc(_s, _f)
335 #define vmem_zalloc(_s, _f) kmem_zalloc(_s, _f)
336 #define vmem_free(_b, _s) kmem_free(_b, _s)
337 #define kmem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i) \
338 umem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i)
339 #define kmem_cache_destroy(_c) umem_cache_destroy(_c)
340 #define kmem_cache_alloc(_c, _f) umem_cache_alloc(_c, _f)
341 #define kmem_cache_free(_c, _b) umem_cache_free(_c, _b)
342 #define kmem_debugging() 0
343 #define kmem_cache_reap_now(_c) /* nothing */
344 #define kmem_cache_set_move(_c, _cb) /* nothing */
345 #define POINTER_INVALIDATE(_pp) /* nothing */
346 #define POINTER_IS_VALID(_p) 0
348 typedef umem_cache_t kmem_cache_t;
350 typedef enum kmem_cbrc {
361 typedef struct taskq taskq_t;
362 typedef uintptr_t taskqid_t;
363 typedef void (task_func_t)(void *);
365 #define TASKQ_PREPOPULATE 0x0001
366 #define TASKQ_CPR_SAFE 0x0002 /* Use CPR safe protocol */
367 #define TASKQ_DYNAMIC 0x0004 /* Use dynamic thread scheduling */
368 #define TASKQ_THREADS_CPU_PCT 0x0008 /* Scale # threads by # cpus */
369 #define TASKQ_DC_BATCH 0x0010 /* Mark threads as batch */
371 #define TQ_SLEEP KM_SLEEP /* Can block for memory */
372 #define TQ_NOSLEEP KM_NOSLEEP /* cannot block for memory; may fail */
373 #define TQ_NOQUEUE 0x02 /* Do not enqueue if can't dispatch */
374 #define TQ_FRONT 0x08 /* Queue in front */
376 extern taskq_t *system_taskq;
378 extern taskq_t *taskq_create(const char *, int, pri_t, int, int, uint_t);
379 #define taskq_create_proc(a, b, c, d, e, p, f) \
380 (taskq_create(a, b, c, d, e, f))
381 #define taskq_create_sysdc(a, b, d, e, p, dc, f) \
382 (taskq_create(a, b, maxclsyspri, d, e, f))
383 extern taskqid_t taskq_dispatch(taskq_t *, task_func_t, void *, uint_t);
384 extern void taskq_destroy(taskq_t *);
385 extern void taskq_wait(taskq_t *);
386 extern int taskq_member(taskq_t *, kthread_t *);
387 extern void system_taskq_init(void);
388 extern void system_taskq_fini(void);
390 #define XVA_MAPSIZE 3
391 #define XVA_MAGIC 0x78766174
396 typedef struct vnode {
402 #define AV_SCANSTAMP_SZ 32 /* length of anti-virus scanstamp */
404 typedef struct xoptattr {
405 timestruc_t xoa_createtime; /* Create time of file */
408 uint8_t xoa_readonly;
410 uint8_t xoa_nounlink;
411 uint8_t xoa_immutable;
412 uint8_t xoa_appendonly;
414 uint8_t xoa_settable;
416 uint8_t xoa_av_quarantined;
417 uint8_t xoa_av_modified;
418 uint8_t xoa_av_scanstamp[AV_SCANSTAMP_SZ];
424 typedef struct vattr {
425 uint_t va_mask; /* bit-mask of attributes */
426 u_offset_t va_size; /* file size in bytes */
430 typedef struct xvattr {
431 vattr_t xva_vattr; /* Embedded vattr structure */
432 uint32_t xva_magic; /* Magic Number */
433 uint32_t xva_mapsize; /* Size of attr bitmap (32-bit words) */
434 uint32_t *xva_rtnattrmapp; /* Ptr to xva_rtnattrmap[] */
435 uint32_t xva_reqattrmap[XVA_MAPSIZE]; /* Requested attrs */
436 uint32_t xva_rtnattrmap[XVA_MAPSIZE]; /* Returned attrs */
437 xoptattr_t xva_xoptattrs; /* Optional attributes */
440 typedef struct vsecattr {
441 uint_t vsa_mask; /* See below */
442 int vsa_aclcnt; /* ACL entry count */
443 void *vsa_aclentp; /* pointer to ACL entries */
444 int vsa_dfaclcnt; /* default ACL entry count */
445 void *vsa_dfaclentp; /* pointer to default ACL entries */
446 size_t vsa_aclentsz; /* ACE size in bytes of vsa_aclentp */
449 #define AT_TYPE 0x00001
450 #define AT_MODE 0x00002
451 #define AT_UID 0x00004
452 #define AT_GID 0x00008
453 #define AT_FSID 0x00010
454 #define AT_NODEID 0x00020
455 #define AT_NLINK 0x00040
456 #define AT_SIZE 0x00080
457 #define AT_ATIME 0x00100
458 #define AT_MTIME 0x00200
459 #define AT_CTIME 0x00400
460 #define AT_RDEV 0x00800
461 #define AT_BLKSIZE 0x01000
462 #define AT_NBLOCKS 0x02000
463 #define AT_SEQ 0x08000
464 #define AT_XVATTR 0x10000
468 extern int fop_getattr(vnode_t *vp, vattr_t *vap);
470 #define VOP_CLOSE(vp, f, c, o, cr, ct) 0
471 #define VOP_PUTPAGE(vp, of, sz, fl, cr, ct) 0
472 #define VOP_GETATTR(vp, vap, fl, cr, ct) fop_getattr((vp), (vap));
474 #define VOP_FSYNC(vp, f, cr, ct) fsync((vp)->v_fd)
476 #define VN_RELE(vp) vn_close(vp)
478 extern int vn_open(char *path, int x1, int oflags, int mode, vnode_t **vpp,
480 extern int vn_openat(char *path, int x1, int oflags, int mode, vnode_t **vpp,
481 int x2, int x3, vnode_t *vp, int fd);
482 extern int vn_rdwr(int uio, vnode_t *vp, void *addr, ssize_t len,
483 offset_t offset, int x1, int x2, rlim64_t x3, void *x4, ssize_t *residp);
484 extern void vn_close(vnode_t *vp);
486 #define vn_remove(path, x1, x2) remove(path)
487 #define vn_rename(from, to, seg) rename((from), (to))
488 #define vn_is_readonly(vp) B_FALSE
490 extern vnode_t *rootdir;
492 #include <sys/file.h> /* for FREAD, FWRITE, etc */
497 #define ddi_get_lbolt() (gethrtime() >> 23)
498 #define ddi_get_lbolt64() (gethrtime() >> 23)
499 #define hz 119 /* frequency when using gethrtime() >> 23 for lbolt */
501 extern void delay(clock_t ticks);
503 #define gethrestime_sec() time(NULL)
504 #define gethrestime(t) \
506 (t)->tv_sec = gethrestime_sec();\
512 #define minclsyspri 60
513 #define maxclsyspri 99
515 #define CPU_SEQID (pthread_self() & (max_ncpus - 1))
520 #define ptob(x) ((x) * PAGESIZE)
522 extern uint64_t physmem;
524 extern int highbit(ulong_t i);
525 extern int random_get_bytes(uint8_t *ptr, size_t len);
526 extern int random_get_pseudo_bytes(uint8_t *ptr, size_t len);
528 extern void kernel_init(int);
529 extern void kernel_fini(void);
532 extern void nicenum(uint64_t num, char *buf);
533 extern void show_pool_stats(struct spa *);
535 typedef struct callb_cpr {
539 #define CALLB_CPR_INIT(cp, lockp, func, name) { \
540 (cp)->cc_lockp = lockp; \
543 #define CALLB_CPR_SAFE_BEGIN(cp) { \
544 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
547 #define CALLB_CPR_SAFE_END(cp, lockp) { \
548 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
551 #define CALLB_CPR_EXIT(cp) { \
552 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
553 mutex_exit((cp)->cc_lockp); \
556 #define zone_dataset_visible(x, y) (1)
557 #define INGLOBALZONE(z) (1)
559 extern char *kmem_vasprintf(const char *fmt, va_list adx);
560 extern char *kmem_asprintf(const char *fmt, ...);
561 #define strfree(str) kmem_free((str), strlen(str)+1)
564 * Hostname information
566 extern char hw_serial[]; /* for userland-emulated hostid access */
567 extern int ddi_strtoul(const char *str, char **nptr, int base,
568 unsigned long *result);
570 extern int ddi_strtoull(const char *str, char **nptr, int base,
571 u_longlong_t *result);
573 /* ZFS Boot Related stuff. */
583 typedef struct ace_object {
585 uint32_t a_access_mask;
588 uint8_t a_obj_type[16];
589 uint8_t a_inherit_obj_type[16];
593 #define ACE_ACCESS_ALLOWED_OBJECT_ACE_TYPE 0x05
594 #define ACE_ACCESS_DENIED_OBJECT_ACE_TYPE 0x06
595 #define ACE_SYSTEM_AUDIT_OBJECT_ACE_TYPE 0x07
596 #define ACE_SYSTEM_ALARM_OBJECT_ACE_TYPE 0x08
598 extern struct _buf *kobj_open_file(char *name);
599 extern int kobj_read_file(struct _buf *file, char *buf, unsigned size,
601 extern void kobj_close_file(struct _buf *file);
602 extern int kobj_get_filesize(struct _buf *file, uint64_t *size);
603 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
604 extern int zfs_secpolicy_rename_perms(const char *from, const char *to,
606 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
607 extern zoneid_t getzoneid(void);
610 typedef struct ksiddomain {
616 ksiddomain_t *ksid_lookupdomain(const char *);
617 void ksiddomain_rele(ksiddomain_t *);
619 #define DDI_SLEEP KM_SLEEP
620 #define ddi_log_sysevent(_a, _b, _c, _d, _e, _f, _g) \
621 sysevent_post_event(_c, _d, _b, "libzpool", _e, _f)
625 #endif /* _SYS_ZFS_CONTEXT_H */