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