1 /* 2 * CDDL HEADER START 3 * 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. 7 * 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. 12 * 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] 18 * 19 * CDDL HEADER END 20 */ 21 /* 22 * Copyright 2007 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 #ifndef _SYS_ZFS_CONTEXT_H 27 #define _SYS_ZFS_CONTEXT_H 28 29 #pragma ident "%Z%%M% %I% %E% SMI" 30 31 #ifdef __cplusplus 32 extern "C" { 33 #endif 34 35 #define _SYS_MUTEX_H 36 #define _SYS_RWLOCK_H 37 #define _SYS_CONDVAR_H 38 #define _SYS_SYSTM_H 39 #define _SYS_DEBUG_H 40 #define _SYS_T_LOCK_H 41 #define _SYS_VNODE_H 42 #define _SYS_VFS_H 43 #define _SYS_SUNDDI_H 44 #define _SYS_CALLB_H 45 46 #include <stdio.h> 47 #include <stdlib.h> 48 #include <stddef.h> 49 #include <stdarg.h> 50 #include <fcntl.h> 51 #include <unistd.h> 52 #include <errno.h> 53 #include <string.h> 54 #include <strings.h> 55 #include <synch.h> 56 #include <thread.h> 57 #include <assert.h> 58 #include <alloca.h> 59 #include <umem.h> 60 #include <limits.h> 61 #include <atomic.h> 62 #include <dirent.h> 63 #include <time.h> 64 #include <sys/note.h> 65 #include <sys/types.h> 66 #include <sys/sysmacros.h> 67 #include <sys/bitmap.h> 68 #include <sys/resource.h> 69 #include <sys/byteorder.h> 70 #include <sys/list.h> 71 #include <sys/uio.h> 72 #include <sys/zfs_debug.h> 73 #include <sys/sdt.h> 74 #include <sys/kstat.h> 75 #include <sys/sysevent/eventdefs.h> 76 77 /* 78 * Debugging 79 */ 80 81 /* 82 * Note that we are not using the debugging levels. 83 */ 84 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 */ 90 91 /* 92 * ZFS debugging 93 */ 94 95 #ifdef ZFS_DEBUG 96 extern void dprintf_setup(int *argc, char **argv); 97 #endif /* ZFS_DEBUG */ 98 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); 103 104 /* This definition is copied from assert.h. */ 105 #if defined(__STDC__) 106 #if __STDC_VERSION__ - 0 >= 199901L 107 #define verify(EX) (void)((EX) || \ 108 (__assert_c99(#EX, __FILE__, __LINE__, __func__), 0)) 109 #else 110 #define verify(EX) (void)((EX) || (__assert(#EX, __FILE__, __LINE__), 0)) 111 #endif /* __STDC_VERSION__ - 0 >= 199901L */ 112 #else 113 #define verify(EX) (void)((EX) || (_assert("EX", __FILE__, __LINE__), 0)) 114 #endif /* __STDC__ */ 115 116 117 #define VERIFY verify 118 #define ASSERT assert 119 120 extern void __assert(const char *, const char *, int); 121 122 #ifdef lint 123 #define VERIFY3_IMPL(x, y, z, t) if (x == z) ((void)0) 124 #else 125 /* BEGIN CSTYLED */ 126 #define VERIFY3_IMPL(LEFT, OP, RIGHT, TYPE) do { \ 127 const TYPE __left = (TYPE)(LEFT); \ 128 const TYPE __right = (TYPE)(RIGHT); \ 129 if (!(__left OP __right)) { \ 130 char *__buf = alloca(256); \ 131 (void) snprintf(__buf, 256, "%s %s %s (0x%llx %s 0x%llx)", \ 132 #LEFT, #OP, #RIGHT, \ 133 (u_longlong_t)__left, #OP, (u_longlong_t)__right); \ 134 __assert(__buf, __FILE__, __LINE__); \ 135 } \ 136 _NOTE(CONSTCOND) } while (0) 137 /* END CSTYLED */ 138 #endif /* lint */ 139 140 #define VERIFY3S(x, y, z) VERIFY3_IMPL(x, y, z, int64_t) 141 #define VERIFY3U(x, y, z) VERIFY3_IMPL(x, y, z, uint64_t) 142 #define VERIFY3P(x, y, z) VERIFY3_IMPL(x, y, z, uintptr_t) 143 144 #ifdef NDEBUG 145 #define ASSERT3S(x, y, z) ((void)0) 146 #define ASSERT3U(x, y, z) ((void)0) 147 #define ASSERT3P(x, y, z) ((void)0) 148 #else 149 #define ASSERT3S(x, y, z) VERIFY3S(x, y, z) 150 #define ASSERT3U(x, y, z) VERIFY3U(x, y, z) 151 #define ASSERT3P(x, y, z) VERIFY3P(x, y, z) 152 #endif 153 154 /* 155 * DTrace SDT probes have different signatures in userland than they do in 156 * kernel. If they're being used in kernel code, re-define them out of 157 * existence for their counterparts in libzpool. 158 */ 159 160 #ifdef DTRACE_PROBE1 161 #undef DTRACE_PROBE1 162 #define DTRACE_PROBE1(a, b, c) ((void)0) 163 #endif /* DTRACE_PROBE1 */ 164 165 #ifdef DTRACE_PROBE2 166 #undef DTRACE_PROBE2 167 #define DTRACE_PROBE2(a, b, c, d, e) ((void)0) 168 #endif /* DTRACE_PROBE2 */ 169 170 #ifdef DTRACE_PROBE3 171 #undef DTRACE_PROBE3 172 #define DTRACE_PROBE3(a, b, c, d, e, f, g) ((void)0) 173 #endif /* DTRACE_PROBE3 */ 174 175 #ifdef DTRACE_PROBE4 176 #undef DTRACE_PROBE4 177 #define DTRACE_PROBE4(a, b, c, d, e, f, g, h, i) ((void)0) 178 #endif /* DTRACE_PROBE4 */ 179 180 /* 181 * Threads 182 */ 183 #define curthread ((void *)(uintptr_t)thr_self()) 184 185 typedef struct kthread kthread_t; 186 187 #define thread_create(stk, stksize, func, arg, len, pp, state, pri) \ 188 zk_thread_create(func, arg) 189 #define thread_exit() thr_exit(NULL) 190 191 extern kthread_t *zk_thread_create(void (*func)(), void *arg); 192 193 #define issig(why) (FALSE) 194 #define ISSIG(thr, why) (FALSE) 195 196 /* 197 * Mutexes 198 */ 199 typedef struct kmutex { 200 void *m_owner; 201 mutex_t m_lock; 202 } kmutex_t; 203 204 #define MUTEX_DEFAULT USYNC_THREAD 205 #undef MUTEX_HELD 206 #define MUTEX_HELD(m) _mutex_held(&(m)->m_lock) 207 208 /* 209 * Argh -- we have to get cheesy here because the kernel and userland 210 * have different signatures for the same routine. 211 */ 212 extern int _mutex_init(mutex_t *mp, int type, void *arg); 213 extern int _mutex_destroy(mutex_t *mp); 214 215 #define mutex_init(mp, b, c, d) zmutex_init((kmutex_t *)(mp)) 216 #define mutex_destroy(mp) zmutex_destroy((kmutex_t *)(mp)) 217 218 extern void zmutex_init(kmutex_t *mp); 219 extern void zmutex_destroy(kmutex_t *mp); 220 extern void mutex_enter(kmutex_t *mp); 221 extern void mutex_exit(kmutex_t *mp); 222 extern int mutex_tryenter(kmutex_t *mp); 223 extern void *mutex_owner(kmutex_t *mp); 224 225 /* 226 * RW locks 227 */ 228 typedef struct krwlock { 229 void *rw_owner; 230 rwlock_t rw_lock; 231 } krwlock_t; 232 233 typedef int krw_t; 234 235 #define RW_READER 0 236 #define RW_WRITER 1 237 #define RW_DEFAULT USYNC_THREAD 238 239 #undef RW_READ_HELD 240 #define RW_READ_HELD(x) _rw_read_held(&(x)->rw_lock) 241 242 #undef RW_WRITE_HELD 243 #define RW_WRITE_HELD(x) _rw_write_held(&(x)->rw_lock) 244 245 extern void rw_init(krwlock_t *rwlp, char *name, int type, void *arg); 246 extern void rw_destroy(krwlock_t *rwlp); 247 extern void rw_enter(krwlock_t *rwlp, krw_t rw); 248 extern int rw_tryenter(krwlock_t *rwlp, krw_t rw); 249 extern int rw_tryupgrade(krwlock_t *rwlp); 250 extern void rw_exit(krwlock_t *rwlp); 251 #define rw_downgrade(rwlp) do { } while (0) 252 253 /* 254 * Condition variables 255 */ 256 typedef cond_t kcondvar_t; 257 258 #define CV_DEFAULT USYNC_THREAD 259 260 extern void cv_init(kcondvar_t *cv, char *name, int type, void *arg); 261 extern void cv_destroy(kcondvar_t *cv); 262 extern void cv_wait(kcondvar_t *cv, kmutex_t *mp); 263 extern clock_t cv_timedwait(kcondvar_t *cv, kmutex_t *mp, clock_t abstime); 264 extern void cv_signal(kcondvar_t *cv); 265 extern void cv_broadcast(kcondvar_t *cv); 266 267 /* 268 * kstat creation, installation and deletion 269 */ 270 extern kstat_t *kstat_create(char *, int, 271 char *, char *, uchar_t, ulong_t, uchar_t); 272 extern void kstat_install(kstat_t *); 273 extern void kstat_delete(kstat_t *); 274 275 /* 276 * Kernel memory 277 */ 278 #define KM_SLEEP UMEM_NOFAIL 279 #define KM_NOSLEEP UMEM_DEFAULT 280 #define KMC_NODEBUG UMC_NODEBUG 281 #define kmem_alloc(_s, _f) umem_alloc(_s, _f) 282 #define kmem_zalloc(_s, _f) umem_zalloc(_s, _f) 283 #define kmem_free(_b, _s) umem_free(_b, _s) 284 #define kmem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i) \ 285 umem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i) 286 #define kmem_cache_destroy(_c) umem_cache_destroy(_c) 287 #define kmem_cache_alloc(_c, _f) umem_cache_alloc(_c, _f) 288 #define kmem_cache_free(_c, _b) umem_cache_free(_c, _b) 289 #define kmem_debugging() 0 290 #define kmem_cache_reap_now(c) 291 292 typedef umem_cache_t kmem_cache_t; 293 294 /* 295 * Task queues 296 */ 297 typedef struct taskq taskq_t; 298 typedef uintptr_t taskqid_t; 299 typedef void (task_func_t)(void *); 300 301 #define TASKQ_PREPOPULATE 0x0001 302 #define TASKQ_CPR_SAFE 0x0002 /* Use CPR safe protocol */ 303 #define TASKQ_DYNAMIC 0x0004 /* Use dynamic thread scheduling */ 304 305 #define TQ_SLEEP KM_SLEEP /* Can block for memory */ 306 #define TQ_NOSLEEP KM_NOSLEEP /* cannot block for memory; may fail */ 307 #define TQ_NOQUEUE 0x02 /* Do not enqueue if can't dispatch */ 308 309 extern taskq_t *taskq_create(const char *, int, pri_t, int, int, uint_t); 310 extern taskqid_t taskq_dispatch(taskq_t *, task_func_t, void *, uint_t); 311 extern void taskq_destroy(taskq_t *); 312 extern void taskq_wait(taskq_t *); 313 extern int taskq_member(taskq_t *, void *); 314 315 /* 316 * vnodes 317 */ 318 typedef struct vnode { 319 uint64_t v_size; 320 int v_fd; 321 char *v_path; 322 } vnode_t; 323 324 typedef struct vattr { 325 uint_t va_mask; /* bit-mask of attributes */ 326 u_offset_t va_size; /* file size in bytes */ 327 } vattr_t; 328 329 #define AT_TYPE 0x0001 330 #define AT_MODE 0x0002 331 #define AT_UID 0x0004 332 #define AT_GID 0x0008 333 #define AT_FSID 0x0010 334 #define AT_NODEID 0x0020 335 #define AT_NLINK 0x0040 336 #define AT_SIZE 0x0080 337 #define AT_ATIME 0x0100 338 #define AT_MTIME 0x0200 339 #define AT_CTIME 0x0400 340 #define AT_RDEV 0x0800 341 #define AT_BLKSIZE 0x1000 342 #define AT_NBLOCKS 0x2000 343 #define AT_SEQ 0x8000 344 345 #define CRCREAT 0 346 347 #define VOP_CLOSE(vp, f, c, o, cr) 0 348 #define VOP_PUTPAGE(vp, of, sz, fl, cr) 0 349 #define VOP_GETATTR(vp, vap, fl, cr) ((vap)->va_size = (vp)->v_size, 0) 350 351 #define VOP_FSYNC(vp, f, cr) fsync((vp)->v_fd) 352 353 #define VN_RELE(vp) vn_close(vp) 354 355 extern int vn_open(char *path, int x1, int oflags, int mode, vnode_t **vpp, 356 int x2, int x3); 357 extern int vn_openat(char *path, int x1, int oflags, int mode, vnode_t **vpp, 358 int x2, int x3, vnode_t *vp); 359 extern int vn_rdwr(int uio, vnode_t *vp, void *addr, ssize_t len, 360 offset_t offset, int x1, int x2, rlim64_t x3, void *x4, ssize_t *residp); 361 extern void vn_close(vnode_t *vp); 362 363 #define vn_remove(path, x1, x2) remove(path) 364 #define vn_rename(from, to, seg) rename((from), (to)) 365 #define vn_is_readonly(vp) B_FALSE 366 367 extern vnode_t *rootdir; 368 369 #include <sys/file.h> /* for FREAD, FWRITE, etc */ 370 371 /* 372 * Random stuff 373 */ 374 #define lbolt (gethrtime() >> 23) 375 #define lbolt64 (gethrtime() >> 23) 376 #define hz 119 /* frequency when using gethrtime() >> 23 for lbolt */ 377 378 extern void delay(clock_t ticks); 379 380 #define gethrestime_sec() time(NULL) 381 382 #define max_ncpus 64 383 384 #define minclsyspri 60 385 #define maxclsyspri 99 386 387 #define CPU_SEQID (thr_self() & (max_ncpus - 1)) 388 389 #define kcred NULL 390 #define CRED() NULL 391 392 extern uint64_t physmem; 393 394 extern int highbit(ulong_t i); 395 extern int random_get_bytes(uint8_t *ptr, size_t len); 396 extern int random_get_pseudo_bytes(uint8_t *ptr, size_t len); 397 398 extern void kernel_init(int); 399 extern void kernel_fini(void); 400 401 struct spa; 402 extern void nicenum(uint64_t num, char *buf); 403 extern void show_pool_stats(struct spa *); 404 405 typedef struct callb_cpr { 406 kmutex_t *cc_lockp; 407 } callb_cpr_t; 408 409 #define CALLB_CPR_INIT(cp, lockp, func, name) { \ 410 (cp)->cc_lockp = lockp; \ 411 } 412 413 #define CALLB_CPR_SAFE_BEGIN(cp) { \ 414 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \ 415 } 416 417 #define CALLB_CPR_SAFE_END(cp, lockp) { \ 418 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \ 419 } 420 421 #define CALLB_CPR_EXIT(cp) { \ 422 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \ 423 mutex_exit((cp)->cc_lockp); \ 424 } 425 426 #define zone_dataset_visible(x, y) (1) 427 #define INGLOBALZONE(z) (1) 428 429 /* 430 * Hostname information 431 */ 432 extern char hw_serial[]; 433 extern int ddi_strtoul(const char *str, char **nptr, int base, 434 unsigned long *result); 435 436 /* ZFS Boot Related stuff. */ 437 438 struct _buf { 439 intptr_t _fd; 440 }; 441 442 struct bootstat { 443 uint64_t st_size; 444 }; 445 446 extern struct _buf *kobj_open_file(char *name); 447 extern int kobj_read_file(struct _buf *file, char *buf, unsigned size, 448 unsigned off); 449 extern void kobj_close_file(struct _buf *file); 450 extern int kobj_get_filesize(struct _buf *file, uint64_t *size); 451 452 #ifdef __cplusplus 453 } 454 #endif 455 456 #endif /* _SYS_ZFS_CONTEXT_H */ 457