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 2008 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
63 #include <sys/types.h>
65 #include <sys/sysmacros.h>
66 #include <sys/bitmap.h>
67 #include <sys/resource.h>
68 #include <sys/byteorder.h>
71 #include <sys/zfs_debug.h>
73 #include <sys/kstat.h>
74 #include <sys/u8_textprep.h>
75 #include <sys/sysevent/eventdefs.h>
82 * Note that we are not using the debugging levels.
85 #define CE_CONT 0 /* continuation */
86 #define CE_NOTE 1 /* notice */
87 #define CE_WARN 2 /* warning */
88 #define CE_PANIC 3 /* panic */
89 #define CE_IGNORE 4 /* print nothing */
96 extern void dprintf_setup(int *argc
, char **argv
);
97 #endif /* ZFS_DEBUG */
99 extern void cmn_err(int, const char *, ...);
100 extern void vcmn_err(int, const char *, __va_list
);
101 extern void panic(const char *, ...);
102 extern void vpanic(const char *, __va_list
);
104 #define fm_panic panic
106 /* This definition is copied from assert.h. */
107 #if defined(__STDC__)
108 #if __STDC_VERSION__ - 0 >= 199901L
109 #define verify(EX) (void)((EX) || \
110 (__assert_c99(#EX, __FILE__, __LINE__, __func__), 0))
112 #define verify(EX) (void)((EX) || (__assert(#EX, __FILE__, __LINE__), 0))
113 #endif /* __STDC_VERSION__ - 0 >= 199901L */
115 #define verify(EX) (void)((EX) || (_assert("EX", __FILE__, __LINE__), 0))
116 #endif /* __STDC__ */
119 #define VERIFY verify
120 #define ASSERT assert
122 extern void __assert(const char *, const char *, int);
125 #define VERIFY3_IMPL(x, y, z, t) if (x == z) ((void)0)
128 #define VERIFY3_IMPL(LEFT, OP, RIGHT, TYPE) do { \
129 const TYPE __left = (TYPE)(LEFT); \
130 const TYPE __right = (TYPE)(RIGHT); \
131 if (!(__left OP __right)) { \
132 char *__buf = alloca(256); \
133 (void) snprintf(__buf, 256, "%s %s %s (0x%llx %s 0x%llx)", \
134 #LEFT, #OP, #RIGHT, \
135 (u_longlong_t)__left, #OP, (u_longlong_t)__right); \
136 __assert(__buf, __FILE__, __LINE__); \
138 _NOTE(CONSTCOND) } while (0)
142 #define VERIFY3S(x, y, z) VERIFY3_IMPL(x, y, z, int64_t)
143 #define VERIFY3U(x, y, z) VERIFY3_IMPL(x, y, z, uint64_t)
144 #define VERIFY3P(x, y, z) VERIFY3_IMPL(x, y, z, uintptr_t)
147 #define ASSERT3S(x, y, z) ((void)0)
148 #define ASSERT3U(x, y, z) ((void)0)
149 #define ASSERT3P(x, y, z) ((void)0)
151 #define ASSERT3S(x, y, z) VERIFY3S(x, y, z)
152 #define ASSERT3U(x, y, z) VERIFY3U(x, y, z)
153 #define ASSERT3P(x, y, z) VERIFY3P(x, y, z)
157 * DTrace SDT probes have different signatures in userland than they do in
158 * kernel. If they're being used in kernel code, re-define them out of
159 * existence for their counterparts in libzpool.
164 #define DTRACE_PROBE(a) ((void)0)
165 #endif /* DTRACE_PROBE */
169 #define DTRACE_PROBE1(a, b, c) ((void)0)
170 #endif /* DTRACE_PROBE1 */
174 #define DTRACE_PROBE2(a, b, c, d, e) ((void)0)
175 #endif /* DTRACE_PROBE2 */
179 #define DTRACE_PROBE3(a, b, c, d, e, f, g) ((void)0)
180 #endif /* DTRACE_PROBE3 */
184 #define DTRACE_PROBE4(a, b, c, d, e, f, g, h, i) ((void)0)
185 #endif /* DTRACE_PROBE4 */
190 #define curthread ((void *)(uintptr_t)thr_self())
192 typedef struct kthread kthread_t
;
194 #define thread_create(stk, stksize, func, arg, len, pp, state, pri) \
195 zk_thread_create(func, arg)
196 #define thread_exit() thr_exit(NULL)
198 extern kthread_t
*zk_thread_create(void (*func
)(), void *arg
);
200 #define issig(why) (FALSE)
201 #define ISSIG(thr, why) (FALSE)
206 typedef struct kmutex
{
208 boolean_t initialized
;
212 #define MUTEX_DEFAULT USYNC_THREAD
214 #define MUTEX_HELD(m) _mutex_held(&(m)->m_lock)
217 * Argh -- we have to get cheesy here because the kernel and userland
218 * have different signatures for the same routine.
220 extern int _mutex_init(mutex_t
*mp
, int type
, void *arg
);
221 extern int _mutex_destroy(mutex_t
*mp
);
223 #define mutex_init(mp, b, c, d) zmutex_init((kmutex_t *)(mp))
224 #define mutex_destroy(mp) zmutex_destroy((kmutex_t *)(mp))
226 extern void zmutex_init(kmutex_t
*mp
);
227 extern void zmutex_destroy(kmutex_t
*mp
);
228 extern void mutex_enter(kmutex_t
*mp
);
229 extern void mutex_exit(kmutex_t
*mp
);
230 extern int mutex_tryenter(kmutex_t
*mp
);
231 extern void *mutex_owner(kmutex_t
*mp
);
236 typedef struct krwlock
{
238 boolean_t initialized
;
246 #define RW_DEFAULT USYNC_THREAD
249 #define RW_READ_HELD(x) _rw_read_held(&(x)->rw_lock)
252 #define RW_WRITE_HELD(x) _rw_write_held(&(x)->rw_lock)
254 extern void rw_init(krwlock_t
*rwlp
, char *name
, int type
, void *arg
);
255 extern void rw_destroy(krwlock_t
*rwlp
);
256 extern void rw_enter(krwlock_t
*rwlp
, krw_t rw
);
257 extern int rw_tryenter(krwlock_t
*rwlp
, krw_t rw
);
258 extern int rw_tryupgrade(krwlock_t
*rwlp
);
259 extern void rw_exit(krwlock_t
*rwlp
);
260 #define rw_downgrade(rwlp) do { } while (0)
262 extern uid_t
crgetuid(cred_t
*cr
);
263 extern gid_t
crgetgid(cred_t
*cr
);
264 extern int crgetngroups(cred_t
*cr
);
265 extern gid_t
*crgetgroups(cred_t
*cr
);
268 * Condition variables
270 typedef cond_t kcondvar_t
;
272 #define CV_DEFAULT USYNC_THREAD
274 extern void cv_init(kcondvar_t
*cv
, char *name
, int type
, void *arg
);
275 extern void cv_destroy(kcondvar_t
*cv
);
276 extern void cv_wait(kcondvar_t
*cv
, kmutex_t
*mp
);
277 extern clock_t cv_timedwait(kcondvar_t
*cv
, kmutex_t
*mp
, clock_t abstime
);
278 extern void cv_signal(kcondvar_t
*cv
);
279 extern void cv_broadcast(kcondvar_t
*cv
);
282 * kstat creation, installation and deletion
284 extern kstat_t
*kstat_create(char *, int,
285 char *, char *, uchar_t
, ulong_t
, uchar_t
);
286 extern void kstat_install(kstat_t
*);
287 extern void kstat_delete(kstat_t
*);
292 #define KM_SLEEP UMEM_NOFAIL
293 #define KM_PUSHPAGE KM_SLEEP
294 #define KM_NOSLEEP UMEM_DEFAULT
295 #define KMC_NODEBUG UMC_NODEBUG
296 #define kmem_alloc(_s, _f) umem_alloc(_s, _f)
297 #define kmem_zalloc(_s, _f) umem_zalloc(_s, _f)
298 #define kmem_free(_b, _s) umem_free(_b, _s)
299 #define kmem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i) \
300 umem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i)
301 #define kmem_cache_destroy(_c) umem_cache_destroy(_c)
302 #define kmem_cache_alloc(_c, _f) umem_cache_alloc(_c, _f)
303 #define kmem_cache_free(_c, _b) umem_cache_free(_c, _b)
304 #define kmem_debugging() 0
305 #define kmem_cache_reap_now(c)
307 typedef umem_cache_t kmem_cache_t
;
312 typedef struct taskq taskq_t
;
313 typedef uintptr_t taskqid_t
;
314 typedef void (task_func_t
)(void *);
316 #define TASKQ_PREPOPULATE 0x0001
317 #define TASKQ_CPR_SAFE 0x0002 /* Use CPR safe protocol */
318 #define TASKQ_DYNAMIC 0x0004 /* Use dynamic thread scheduling */
320 #define TQ_SLEEP KM_SLEEP /* Can block for memory */
321 #define TQ_NOSLEEP KM_NOSLEEP /* cannot block for memory; may fail */
322 #define TQ_NOQUEUE 0x02 /* Do not enqueue if can't dispatch */
324 extern taskq_t
*system_taskq
;
326 extern taskq_t
*taskq_create(const char *, int, pri_t
, int, int, uint_t
);
327 extern taskqid_t
taskq_dispatch(taskq_t
*, task_func_t
, void *, uint_t
);
328 extern void taskq_destroy(taskq_t
*);
329 extern void taskq_wait(taskq_t
*);
330 extern int taskq_member(taskq_t
*, void *);
331 extern void system_taskq_init(void);
333 #define XVA_MAPSIZE 3
334 #define XVA_MAGIC 0x78766174
339 typedef struct vnode
{
346 typedef struct xoptattr
{
347 timestruc_t xoa_createtime
; /* Create time of file */
350 uint8_t xoa_readonly
;
352 uint8_t xoa_nounlink
;
353 uint8_t xoa_immutable
;
354 uint8_t xoa_appendonly
;
356 uint8_t xoa_settable
;
358 uint8_t xoa_av_quarantined
;
359 uint8_t xoa_av_modified
;
362 typedef struct vattr
{
363 uint_t va_mask
; /* bit-mask of attributes */
364 u_offset_t va_size
; /* file size in bytes */
368 typedef struct xvattr
{
369 vattr_t xva_vattr
; /* Embedded vattr structure */
370 uint32_t xva_magic
; /* Magic Number */
371 uint32_t xva_mapsize
; /* Size of attr bitmap (32-bit words) */
372 uint32_t *xva_rtnattrmapp
; /* Ptr to xva_rtnattrmap[] */
373 uint32_t xva_reqattrmap
[XVA_MAPSIZE
]; /* Requested attrs */
374 uint32_t xva_rtnattrmap
[XVA_MAPSIZE
]; /* Returned attrs */
375 xoptattr_t xva_xoptattrs
; /* Optional attributes */
378 typedef struct vsecattr
{
379 uint_t vsa_mask
; /* See below */
380 int vsa_aclcnt
; /* ACL entry count */
381 void *vsa_aclentp
; /* pointer to ACL entries */
382 int vsa_dfaclcnt
; /* default ACL entry count */
383 void *vsa_dfaclentp
; /* pointer to default ACL entries */
384 size_t vsa_aclentsz
; /* ACE size in bytes of vsa_aclentp */
387 #define AT_TYPE 0x00001
388 #define AT_MODE 0x00002
389 #define AT_UID 0x00004
390 #define AT_GID 0x00008
391 #define AT_FSID 0x00010
392 #define AT_NODEID 0x00020
393 #define AT_NLINK 0x00040
394 #define AT_SIZE 0x00080
395 #define AT_ATIME 0x00100
396 #define AT_MTIME 0x00200
397 #define AT_CTIME 0x00400
398 #define AT_RDEV 0x00800
399 #define AT_BLKSIZE 0x01000
400 #define AT_NBLOCKS 0x02000
401 #define AT_SEQ 0x08000
402 #define AT_XVATTR 0x10000
406 #define VOP_CLOSE(vp, f, c, o, cr, ct) 0
407 #define VOP_PUTPAGE(vp, of, sz, fl, cr, ct) 0
408 #define VOP_GETATTR(vp, vap, fl, cr, ct) ((vap)->va_size = (vp)->v_size, 0)
410 #define VOP_FSYNC(vp, f, cr, ct) fsync((vp)->v_fd)
412 #define VN_RELE(vp) vn_close(vp)
414 extern int vn_open(char *path
, int x1
, int oflags
, int mode
, vnode_t
**vpp
,
416 extern int vn_openat(char *path
, int x1
, int oflags
, int mode
, vnode_t
**vpp
,
417 int x2
, int x3
, vnode_t
*vp
, int fd
);
418 extern int vn_rdwr(int uio
, vnode_t
*vp
, void *addr
, ssize_t len
,
419 offset_t offset
, int x1
, int x2
, rlim64_t x3
, void *x4
, ssize_t
*residp
);
420 extern void vn_close(vnode_t
*vp
);
422 #define vn_remove(path, x1, x2) remove(path)
423 #define vn_rename(from, to, seg) rename((from), (to))
424 #define vn_is_readonly(vp) B_FALSE
426 extern vnode_t
*rootdir
;
428 #include <sys/file.h> /* for FREAD, FWRITE, etc */
433 #define lbolt (gethrtime() >> 23)
434 #define lbolt64 (gethrtime() >> 23)
435 #define hz 119 /* frequency when using gethrtime() >> 23 for lbolt */
437 extern void delay(clock_t ticks
);
439 #define gethrestime_sec() time(NULL)
443 #define minclsyspri 60
444 #define maxclsyspri 99
446 #define CPU_SEQID (thr_self() & (max_ncpus - 1))
451 #define ptob(x) ((x) * PAGESIZE)
453 extern uint64_t physmem
;
455 extern int highbit(ulong_t i
);
456 extern int random_get_bytes(uint8_t *ptr
, size_t len
);
457 extern int random_get_pseudo_bytes(uint8_t *ptr
, size_t len
);
459 extern void kernel_init(int);
460 extern void kernel_fini(void);
463 extern void nicenum(uint64_t num
, char *buf
);
464 extern void show_pool_stats(struct spa
*);
466 typedef struct callb_cpr
{
470 #define CALLB_CPR_INIT(cp, lockp, func, name) { \
471 (cp)->cc_lockp = lockp; \
474 #define CALLB_CPR_SAFE_BEGIN(cp) { \
475 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
478 #define CALLB_CPR_SAFE_END(cp, lockp) { \
479 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
482 #define CALLB_CPR_EXIT(cp) { \
483 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \
484 mutex_exit((cp)->cc_lockp); \
487 #define zone_dataset_visible(x, y) (1)
488 #define INGLOBALZONE(z) (1)
491 * Hostname information
493 extern char hw_serial
[];
494 extern int ddi_strtoul(const char *str
, char **nptr
, int base
,
495 unsigned long *result
);
497 /* ZFS Boot Related stuff. */
507 typedef struct ace_object
{
509 uint32_t a_access_mask
;
512 uint8_t a_obj_type
[16];
513 uint8_t a_inherit_obj_type
[16];
517 #define ACE_ACCESS_ALLOWED_OBJECT_ACE_TYPE 0x05
518 #define ACE_ACCESS_DENIED_OBJECT_ACE_TYPE 0x06
519 #define ACE_SYSTEM_AUDIT_OBJECT_ACE_TYPE 0x07
520 #define ACE_SYSTEM_ALARM_OBJECT_ACE_TYPE 0x08
522 extern struct _buf
*kobj_open_file(char *name
);
523 extern int kobj_read_file(struct _buf
*file
, char *buf
, unsigned size
,
525 extern void kobj_close_file(struct _buf
*file
);
526 extern int kobj_get_filesize(struct _buf
*file
, uint64_t *size
);
527 extern int zfs_secpolicy_snapshot_perms(const char *name
, cred_t
*cr
);
528 extern int zfs_secpolicy_rename_perms(const char *from
, const char *to
,
530 extern int zfs_secpolicy_destroy_perms(const char *name
, cred_t
*cr
);
531 extern zoneid_t
getzoneid(void);
534 typedef struct ksiddomain
{
540 ksiddomain_t
*ksid_lookupdomain(const char *);
541 void ksiddomain_rele(ksiddomain_t
*);
547 #endif /* _SYS_ZFS_CONTEXT_H */