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
35 #define _SYS_CONDVAR_H
62 #include <libsysevent.h>
64 #include <sys/types.h>
66 #include <sys/sysmacros.h>
67 #include <sys/bitmap.h>
68 #include <sys/resource.h>
69 #include <sys/byteorder.h>
72 #include <sys/zfs_debug.h>
74 #include <sys/kstat.h>
75 #include <sys/u8_textprep.h>
76 #include <sys/sysevent/eventdefs.h>
77 #include <sys/sysevent/dev.h>
84 * Note that we are not using the debugging levels.
87 #define CE_CONT 0 /* continuation */
88 #define CE_NOTE 1 /* notice */
89 #define CE_WARN 2 /* warning */
90 #define CE_PANIC 3 /* panic */
91 #define CE_IGNORE 4 /* print nothing */
98 extern void dprintf_setup(int *argc, char **argv);
99 #endif /* ZFS_DEBUG */
101 extern void cmn_err(int, const char *, ...);
102 extern void vcmn_err(int, const char *, __va_list);
103 extern void panic(const char *, ...);
104 extern void vpanic(const char *, __va_list);
106 #define fm_panic panic
108 /* This definition is copied from assert.h. */
109 #if defined(__STDC__)
110 #if __STDC_VERSION__ - 0 >= 199901L
111 #define verify(EX) (void)((EX) || \
112 (__assert_c99(#EX, __FILE__, __LINE__, __func__), 0))
114 #define verify(EX) (void)((EX) || (__assert(#EX, __FILE__, __LINE__), 0))
115 #endif /* __STDC_VERSION__ - 0 >= 199901L */
117 #define verify(EX) (void)((EX) || (_assert("EX", __FILE__, __LINE__), 0))
118 #endif /* __STDC__ */
121 #define VERIFY verify
122 #define ASSERT assert
124 extern void __assert(const char *, const char *, int);
127 #define VERIFY3_IMPL(x, y, z, t) if (x == z) ((void)0)
130 #define VERIFY3_IMPL(LEFT, OP, RIGHT, TYPE) do { \
131 const TYPE __left = (TYPE)(LEFT); \
132 const TYPE __right = (TYPE)(RIGHT); \
133 if (!(__left OP __right)) { \
134 char *__buf = alloca(256); \
135 (void) snprintf(__buf, 256, "%s %s %s (0x%llx %s 0x%llx)", \
136 #LEFT, #OP, #RIGHT, \
137 (u_longlong_t)__left, #OP, (u_longlong_t)__right); \
138 __assert(__buf, __FILE__, __LINE__); \
140 _NOTE(CONSTCOND) } while (0)
144 #define VERIFY3S(x, y, z) VERIFY3_IMPL(x, y, z, int64_t)
145 #define VERIFY3U(x, y, z) VERIFY3_IMPL(x, y, z, uint64_t)
146 #define VERIFY3P(x, y, z) VERIFY3_IMPL(x, y, z, uintptr_t)
149 #define ASSERT3S(x, y, z) ((void)0)
150 #define ASSERT3U(x, y, z) ((void)0)
151 #define ASSERT3P(x, y, z) ((void)0)
153 #define ASSERT3S(x, y, z) VERIFY3S(x, y, z)
154 #define ASSERT3U(x, y, z) VERIFY3U(x, y, z)
155 #define ASSERT3P(x, y, z) VERIFY3P(x, y, z)
159 * DTrace SDT probes have different signatures in userland than they do in
160 * kernel. If they're being used in kernel code, re-define them out of
161 * existence for their counterparts in libzpool.
166 #define DTRACE_PROBE(a) ((void)0)
167 #endif /* DTRACE_PROBE */
171 #define DTRACE_PROBE1(a, b, c) ((void)0)
172 #endif /* DTRACE_PROBE1 */
176 #define DTRACE_PROBE2(a, b, c, d, e) ((void)0)
177 #endif /* DTRACE_PROBE2 */
181 #define DTRACE_PROBE3(a, b, c, d, e, f, g) ((void)0)
182 #endif /* DTRACE_PROBE3 */
186 #define DTRACE_PROBE4(a, b, c, d, e, f, g, h, i) ((void)0)
187 #endif /* DTRACE_PROBE4 */
192 #define curthread ((void *)(uintptr_t)thr_self())
194 typedef struct kthread kthread_t;
196 #define thread_create(stk, stksize, func, arg, len, pp, state, pri) \
197 zk_thread_create(func, arg)
198 #define thread_exit() thr_exit(NULL)
200 extern kthread_t *zk_thread_create(void (*func)(), void *arg);
202 #define issig(why) (FALSE)
203 #define ISSIG(thr, why) (FALSE)
208 typedef struct kmutex {
210 boolean_t initialized;
214 #define MUTEX_DEFAULT USYNC_THREAD
216 #define MUTEX_HELD(m) _mutex_held(&(m)->m_lock)
219 * Argh -- we have to get cheesy here because the kernel and userland
220 * have different signatures for the same routine.
222 extern int _mutex_init(mutex_t *mp, int type, void *arg);
223 extern int _mutex_destroy(mutex_t *mp);
225 #define mutex_init(mp, b, c, d) zmutex_init((kmutex_t *)(mp))
226 #define mutex_destroy(mp) zmutex_destroy((kmutex_t *)(mp))
228 extern void zmutex_init(kmutex_t *mp);
229 extern void zmutex_destroy(kmutex_t *mp);
230 extern void mutex_enter(kmutex_t *mp);
231 extern void mutex_exit(kmutex_t *mp);
232 extern int mutex_tryenter(kmutex_t *mp);
233 extern void *mutex_owner(kmutex_t *mp);
238 typedef struct krwlock {
240 boolean_t initialized;
248 #define RW_DEFAULT USYNC_THREAD
251 #define RW_READ_HELD(x) _rw_read_held(&(x)->rw_lock)
254 #define RW_WRITE_HELD(x) _rw_write_held(&(x)->rw_lock)
256 extern void rw_init(krwlock_t *rwlp, char *name, int type, void *arg);
257 extern void rw_destroy(krwlock_t *rwlp);
258 extern void rw_enter(krwlock_t *rwlp, krw_t rw);
259 extern int rw_tryenter(krwlock_t *rwlp, krw_t rw);
260 extern int rw_tryupgrade(krwlock_t *rwlp);
261 extern void rw_exit(krwlock_t *rwlp);
262 #define rw_downgrade(rwlp) do { } while (0)
264 extern uid_t crgetuid(cred_t *cr);
265 extern gid_t crgetgid(cred_t *cr);
266 extern int crgetngroups(cred_t *cr);
267 extern gid_t *crgetgroups(cred_t *cr);
270 * Condition variables
272 typedef cond_t kcondvar_t;
274 #define CV_DEFAULT USYNC_THREAD
276 extern void cv_init(kcondvar_t *cv, char *name, int type, void *arg);
277 extern void cv_destroy(kcondvar_t *cv);
278 extern void cv_wait(kcondvar_t *cv, kmutex_t *mp);
279 extern clock_t cv_timedwait(kcondvar_t *cv, kmutex_t *mp, clock_t abstime);
280 extern void cv_signal(kcondvar_t *cv);
281 extern void cv_broadcast(kcondvar_t *cv);
284 * kstat creation, installation and deletion
286 extern kstat_t *kstat_create(char *, int,
287 char *, char *, uchar_t, ulong_t, uchar_t);
288 extern void kstat_install(kstat_t *);
289 extern void kstat_delete(kstat_t *);
294 #define KM_SLEEP UMEM_NOFAIL
295 #define KM_PUSHPAGE KM_SLEEP
296 #define KM_NOSLEEP UMEM_DEFAULT
297 #define KMC_NODEBUG UMC_NODEBUG
298 #define kmem_alloc(_s, _f) umem_alloc(_s, _f)
299 #define kmem_zalloc(_s, _f) umem_zalloc(_s, _f)
300 #define kmem_free(_b, _s) umem_free(_b, _s)
301 #define kmem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i) \
302 umem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i)
303 #define kmem_cache_destroy(_c) umem_cache_destroy(_c)
304 #define kmem_cache_alloc(_c, _f) umem_cache_alloc(_c, _f)
305 #define kmem_cache_free(_c, _b) umem_cache_free(_c, _b)
306 #define kmem_debugging() 0
307 #define kmem_cache_reap_now(c)
309 typedef umem_cache_t kmem_cache_t;
314 typedef struct taskq taskq_t;
315 typedef uintptr_t taskqid_t;
316 typedef void (task_func_t)(void *);
318 #define TASKQ_PREPOPULATE 0x0001
319 #define TASKQ_CPR_SAFE 0x0002 /* Use CPR safe protocol */
320 #define TASKQ_DYNAMIC 0x0004 /* Use dynamic thread scheduling */
321 #define TASKQ_THREADS_CPU_PCT 0x0008 /* Use dynamic thread scheduling */
323 #define TQ_SLEEP KM_SLEEP /* Can block for memory */
324 #define TQ_NOSLEEP KM_NOSLEEP /* cannot block for memory; may fail */
325 #define TQ_NOQUEUE 0x02 /* Do not enqueue if can't dispatch */
327 extern taskq_t *system_taskq;
329 extern taskq_t *taskq_create(const char *, int, pri_t, int, int, uint_t);
330 extern taskqid_t taskq_dispatch(taskq_t *, task_func_t, void *, uint_t);
331 extern void taskq_destroy(taskq_t *);
332 extern void taskq_wait(taskq_t *);
333 extern int taskq_member(taskq_t *, void *);
334 extern void system_taskq_init(void);
336 #define XVA_MAPSIZE 3
337 #define XVA_MAGIC 0x78766174
342 typedef struct vnode {
349 typedef struct xoptattr {
350 timestruc_t xoa_createtime; /* Create time of file */
353 uint8_t xoa_readonly;
355 uint8_t xoa_nounlink;
356 uint8_t xoa_immutable;
357 uint8_t xoa_appendonly;
359 uint8_t xoa_settable;
361 uint8_t xoa_av_quarantined;
362 uint8_t xoa_av_modified;
365 typedef struct vattr {
366 uint_t va_mask; /* bit-mask of attributes */
367 u_offset_t va_size; /* file size in bytes */
371 typedef struct xvattr {
372 vattr_t xva_vattr; /* Embedded vattr structure */
373 uint32_t xva_magic; /* Magic Number */
374 uint32_t xva_mapsize; /* Size of attr bitmap (32-bit words) */
375 uint32_t *xva_rtnattrmapp; /* Ptr to xva_rtnattrmap[] */
376 uint32_t xva_reqattrmap[XVA_MAPSIZE]; /* Requested attrs */
377 uint32_t xva_rtnattrmap[XVA_MAPSIZE]; /* Returned attrs */
378 xoptattr_t xva_xoptattrs; /* Optional attributes */
381 typedef struct vsecattr {
382 uint_t vsa_mask; /* See below */
383 int vsa_aclcnt; /* ACL entry count */
384 void *vsa_aclentp; /* pointer to ACL entries */
385 int vsa_dfaclcnt; /* default ACL entry count */
386 void *vsa_dfaclentp; /* pointer to default ACL entries */
387 size_t vsa_aclentsz; /* ACE size in bytes of vsa_aclentp */
390 #define AT_TYPE 0x00001
391 #define AT_MODE 0x00002
392 #define AT_UID 0x00004
393 #define AT_GID 0x00008
394 #define AT_FSID 0x00010
395 #define AT_NODEID 0x00020
396 #define AT_NLINK 0x00040
397 #define AT_SIZE 0x00080
398 #define AT_ATIME 0x00100
399 #define AT_MTIME 0x00200
400 #define AT_CTIME 0x00400
401 #define AT_RDEV 0x00800
402 #define AT_BLKSIZE 0x01000
403 #define AT_NBLOCKS 0x02000
404 #define AT_SEQ 0x08000
405 #define AT_XVATTR 0x10000
409 #define VOP_CLOSE(vp, f, c, o, cr, ct) 0
410 #define VOP_PUTPAGE(vp, of, sz, fl, cr, ct) 0
411 #define VOP_GETATTR(vp, vap, fl, cr, ct) ((vap)->va_size = (vp)->v_size, 0)
413 #define VOP_FSYNC(vp, f, cr, ct) fsync((vp)->v_fd)
415 #define VN_RELE(vp) vn_close(vp)
417 extern int vn_open(char *path, int x1, int oflags, int mode, vnode_t **vpp,
419 extern int vn_openat(char *path, int x1, int oflags, int mode, vnode_t **vpp,
420 int x2, int x3, vnode_t *vp, int fd);
421 extern int vn_rdwr(int uio, vnode_t *vp, void *addr, ssize_t len,
422 offset_t offset, int x1, int x2, rlim64_t x3, void *x4, ssize_t *residp);
423 extern void vn_close(vnode_t *vp);
425 #define vn_remove(path, x1, x2) remove(path)
426 #define vn_rename(from, to, seg) rename((from), (to))
427 #define vn_is_readonly(vp) B_FALSE
429 extern vnode_t *rootdir;
431 #include <sys/file.h> /* for FREAD, FWRITE, etc */
436 #define lbolt (gethrtime() >> 23)
437 #define lbolt64 (gethrtime() >> 23)
438 #define hz 119 /* frequency when using gethrtime() >> 23 for lbolt */
440 extern void delay(clock_t ticks);
442 #define gethrestime_sec() time(NULL)
446 #define minclsyspri 60
447 #define maxclsyspri 99
449 #define CPU_SEQID (thr_self() & (max_ncpus - 1))
454 #define ptob(x) ((x) * PAGESIZE)
456 extern uint64_t physmem;
458 extern int highbit(ulong_t i);
459 extern int random_get_bytes(uint8_t *ptr, size_t len);
460 extern int random_get_pseudo_bytes(uint8_t *ptr, size_t len);
462 extern void kernel_init(int);
463 extern void kernel_fini(void);
466 extern void nicenum(uint64_t num, char *buf);
467 extern void show_pool_stats(struct spa *);
469 typedef struct callb_cpr {
473 #define CALLB_CPR_INIT(cp, lockp, func, name) { \
474 (cp)->cc_lockp = lockp; \
477 #define CALLB_CPR_SAFE_BEGIN(cp) { \
478 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
481 #define CALLB_CPR_SAFE_END(cp, lockp) { \
482 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
485 #define CALLB_CPR_EXIT(cp) { \
486 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
487 mutex_exit((cp)->cc_lockp); \
490 #define zone_dataset_visible(x, y) (1)
491 #define INGLOBALZONE(z) (1)
494 * Hostname information
496 extern char hw_serial[]; /* for userland-emulated hostid access */
497 extern int ddi_strtoul(const char *str, char **nptr, int base,
498 unsigned long *result);
500 /* ZFS Boot Related stuff. */
510 typedef struct ace_object {
512 uint32_t a_access_mask;
515 uint8_t a_obj_type[16];
516 uint8_t a_inherit_obj_type[16];
520 #define ACE_ACCESS_ALLOWED_OBJECT_ACE_TYPE 0x05
521 #define ACE_ACCESS_DENIED_OBJECT_ACE_TYPE 0x06
522 #define ACE_SYSTEM_AUDIT_OBJECT_ACE_TYPE 0x07
523 #define ACE_SYSTEM_ALARM_OBJECT_ACE_TYPE 0x08
525 extern struct _buf *kobj_open_file(char *name);
526 extern int kobj_read_file(struct _buf *file, char *buf, unsigned size,
528 extern void kobj_close_file(struct _buf *file);
529 extern int kobj_get_filesize(struct _buf *file, uint64_t *size);
530 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
531 extern int zfs_secpolicy_rename_perms(const char *from, const char *to,
533 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
534 extern zoneid_t getzoneid(void);
537 typedef struct ksiddomain {
543 ksiddomain_t *ksid_lookupdomain(const char *);
544 void ksiddomain_rele(ksiddomain_t *);
546 #define DDI_SLEEP KM_SLEEP
547 #define ddi_log_sysevent(_a, _b, _c, _d, _e, _f, _g) \
548 sysevent_post_event(_c, _d, _b, "libzpool", _e, _f)
554 #endif /* _SYS_ZFS_CONTEXT_H */