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/cred.h> 67 #include <sys/sysmacros.h> 68 #include <sys/bitmap.h> 69 #include <sys/resource.h> 70 #include <sys/byteorder.h> 71 #include <sys/list.h> 72 #include <sys/uio.h> 73 #include <sys/zfs_debug.h> 74 #include <sys/sdt.h> 75 #include <sys/kstat.h> 76 #include <sys/sysevent/eventdefs.h> 77 78 /* 79 * Debugging 80 */ 81 82 /* 83 * Note that we are not using the debugging levels. 84 */ 85 86 #define CE_CONT 0 /* continuation */ 87 #define CE_NOTE 1 /* notice */ 88 #define CE_WARN 2 /* warning */ 89 #define CE_PANIC 3 /* panic */ 90 #define CE_IGNORE 4 /* print nothing */ 91 92 /* 93 * ZFS debugging 94 */ 95 96 #ifdef ZFS_DEBUG 97 extern void dprintf_setup(int *argc, char **argv); 98 #endif /* ZFS_DEBUG */ 99 100 extern void cmn_err(int, const char *, ...); 101 extern void vcmn_err(int, const char *, __va_list); 102 extern void panic(const char *, ...); 103 extern void vpanic(const char *, __va_list); 104 105 #define fm_panic panic 106 107 /* This definition is copied from assert.h. */ 108 #if defined(__STDC__) 109 #if __STDC_VERSION__ - 0 >= 199901L 110 #define verify(EX) (void)((EX) || \ 111 (__assert_c99(#EX, __FILE__, __LINE__, __func__), 0)) 112 #else 113 #define verify(EX) (void)((EX) || (__assert(#EX, __FILE__, __LINE__), 0)) 114 #endif /* __STDC_VERSION__ - 0 >= 199901L */ 115 #else 116 #define verify(EX) (void)((EX) || (_assert("EX", __FILE__, __LINE__), 0)) 117 #endif /* __STDC__ */ 118 119 120 #define VERIFY verify 121 #define ASSERT assert 122 123 extern void __assert(const char *, const char *, int); 124 125 #ifdef lint 126 #define VERIFY3_IMPL(x, y, z, t) if (x == z) ((void)0) 127 #else 128 /* BEGIN CSTYLED */ 129 #define VERIFY3_IMPL(LEFT, OP, RIGHT, TYPE) do { \ 130 const TYPE __left = (TYPE)(LEFT); \ 131 const TYPE __right = (TYPE)(RIGHT); \ 132 if (!(__left OP __right)) { \ 133 char *__buf = alloca(256); \ 134 (void) snprintf(__buf, 256, "%s %s %s (0x%llx %s 0x%llx)", \ 135 #LEFT, #OP, #RIGHT, \ 136 (u_longlong_t)__left, #OP, (u_longlong_t)__right); \ 137 __assert(__buf, __FILE__, __LINE__); \ 138 } \ 139 _NOTE(CONSTCOND) } while (0) 140 /* END CSTYLED */ 141 #endif /* lint */ 142 143 #define VERIFY3S(x, y, z) VERIFY3_IMPL(x, y, z, int64_t) 144 #define VERIFY3U(x, y, z) VERIFY3_IMPL(x, y, z, uint64_t) 145 #define VERIFY3P(x, y, z) VERIFY3_IMPL(x, y, z, uintptr_t) 146 147 #ifdef NDEBUG 148 #define ASSERT3S(x, y, z) ((void)0) 149 #define ASSERT3U(x, y, z) ((void)0) 150 #define ASSERT3P(x, y, z) ((void)0) 151 #else 152 #define ASSERT3S(x, y, z) VERIFY3S(x, y, z) 153 #define ASSERT3U(x, y, z) VERIFY3U(x, y, z) 154 #define ASSERT3P(x, y, z) VERIFY3P(x, y, z) 155 #endif 156 157 /* 158 * DTrace SDT probes have different signatures in userland than they do in 159 * kernel. If they're being used in kernel code, re-define them out of 160 * existence for their counterparts in libzpool. 161 */ 162 163 #ifdef DTRACE_PROBE1 164 #undef DTRACE_PROBE1 165 #define DTRACE_PROBE1(a, b, c) ((void)0) 166 #endif /* DTRACE_PROBE1 */ 167 168 #ifdef DTRACE_PROBE2 169 #undef DTRACE_PROBE2 170 #define DTRACE_PROBE2(a, b, c, d, e) ((void)0) 171 #endif /* DTRACE_PROBE2 */ 172 173 #ifdef DTRACE_PROBE3 174 #undef DTRACE_PROBE3 175 #define DTRACE_PROBE3(a, b, c, d, e, f, g) ((void)0) 176 #endif /* DTRACE_PROBE3 */ 177 178 #ifdef DTRACE_PROBE4 179 #undef DTRACE_PROBE4 180 #define DTRACE_PROBE4(a, b, c, d, e, f, g, h, i) ((void)0) 181 #endif /* DTRACE_PROBE4 */ 182 183 /* 184 * Threads 185 */ 186 #define curthread ((void *)(uintptr_t)thr_self()) 187 188 typedef struct kthread kthread_t; 189 190 #define thread_create(stk, stksize, func, arg, len, pp, state, pri) \ 191 zk_thread_create(func, arg) 192 #define thread_exit() thr_exit(NULL) 193 194 extern kthread_t *zk_thread_create(void (*func)(), void *arg); 195 196 #define issig(why) (FALSE) 197 #define ISSIG(thr, why) (FALSE) 198 199 /* 200 * Mutexes 201 */ 202 typedef struct kmutex { 203 void *m_owner; 204 boolean_t initialized; 205 mutex_t m_lock; 206 } kmutex_t; 207 208 #define MUTEX_DEFAULT USYNC_THREAD 209 #undef MUTEX_HELD 210 #define MUTEX_HELD(m) _mutex_held(&(m)->m_lock) 211 212 /* 213 * Argh -- we have to get cheesy here because the kernel and userland 214 * have different signatures for the same routine. 215 */ 216 extern int _mutex_init(mutex_t *mp, int type, void *arg); 217 extern int _mutex_destroy(mutex_t *mp); 218 219 #define mutex_init(mp, b, c, d) zmutex_init((kmutex_t *)(mp)) 220 #define mutex_destroy(mp) zmutex_destroy((kmutex_t *)(mp)) 221 222 extern void zmutex_init(kmutex_t *mp); 223 extern void zmutex_destroy(kmutex_t *mp); 224 extern void mutex_enter(kmutex_t *mp); 225 extern void mutex_exit(kmutex_t *mp); 226 extern int mutex_tryenter(kmutex_t *mp); 227 extern void *mutex_owner(kmutex_t *mp); 228 229 /* 230 * RW locks 231 */ 232 typedef struct krwlock { 233 void *rw_owner; 234 boolean_t initialized; 235 rwlock_t rw_lock; 236 } krwlock_t; 237 238 typedef int krw_t; 239 240 #define RW_READER 0 241 #define RW_WRITER 1 242 #define RW_DEFAULT USYNC_THREAD 243 244 #undef RW_READ_HELD 245 #define RW_READ_HELD(x) _rw_read_held(&(x)->rw_lock) 246 247 #undef RW_WRITE_HELD 248 #define RW_WRITE_HELD(x) _rw_write_held(&(x)->rw_lock) 249 250 extern void rw_init(krwlock_t *rwlp, char *name, int type, void *arg); 251 extern void rw_destroy(krwlock_t *rwlp); 252 extern void rw_enter(krwlock_t *rwlp, krw_t rw); 253 extern int rw_tryenter(krwlock_t *rwlp, krw_t rw); 254 extern int rw_tryupgrade(krwlock_t *rwlp); 255 extern void rw_exit(krwlock_t *rwlp); 256 #define rw_downgrade(rwlp) do { } while (0) 257 258 extern uid_t crgetuid(cred_t *cr); 259 extern gid_t crgetgid(cred_t *cr); 260 extern int crgetngroups(cred_t *cr); 261 extern gid_t *crgetgroups(cred_t *cr); 262 263 /* 264 * Condition variables 265 */ 266 typedef cond_t kcondvar_t; 267 268 #define CV_DEFAULT USYNC_THREAD 269 270 extern void cv_init(kcondvar_t *cv, char *name, int type, void *arg); 271 extern void cv_destroy(kcondvar_t *cv); 272 extern void cv_wait(kcondvar_t *cv, kmutex_t *mp); 273 extern clock_t cv_timedwait(kcondvar_t *cv, kmutex_t *mp, clock_t abstime); 274 extern void cv_signal(kcondvar_t *cv); 275 extern void cv_broadcast(kcondvar_t *cv); 276 277 /* 278 * kstat creation, installation and deletion 279 */ 280 extern kstat_t *kstat_create(char *, int, 281 char *, char *, uchar_t, ulong_t, uchar_t); 282 extern void kstat_install(kstat_t *); 283 extern void kstat_delete(kstat_t *); 284 285 /* 286 * Kernel memory 287 */ 288 #define KM_SLEEP UMEM_NOFAIL 289 #define KM_NOSLEEP UMEM_DEFAULT 290 #define KMC_NODEBUG UMC_NODEBUG 291 #define kmem_alloc(_s, _f) umem_alloc(_s, _f) 292 #define kmem_zalloc(_s, _f) umem_zalloc(_s, _f) 293 #define kmem_free(_b, _s) umem_free(_b, _s) 294 #define kmem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i) \ 295 umem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i) 296 #define kmem_cache_destroy(_c) umem_cache_destroy(_c) 297 #define kmem_cache_alloc(_c, _f) umem_cache_alloc(_c, _f) 298 #define kmem_cache_free(_c, _b) umem_cache_free(_c, _b) 299 #define kmem_debugging() 0 300 #define kmem_cache_reap_now(c) 301 302 typedef umem_cache_t kmem_cache_t; 303 304 /* 305 * Task queues 306 */ 307 typedef struct taskq taskq_t; 308 typedef uintptr_t taskqid_t; 309 typedef void (task_func_t)(void *); 310 311 #define TASKQ_PREPOPULATE 0x0001 312 #define TASKQ_CPR_SAFE 0x0002 /* Use CPR safe protocol */ 313 #define TASKQ_DYNAMIC 0x0004 /* Use dynamic thread scheduling */ 314 315 #define TQ_SLEEP KM_SLEEP /* Can block for memory */ 316 #define TQ_NOSLEEP KM_NOSLEEP /* cannot block for memory; may fail */ 317 #define TQ_NOQUEUE 0x02 /* Do not enqueue if can't dispatch */ 318 319 extern taskq_t *taskq_create(const char *, int, pri_t, int, int, uint_t); 320 extern taskqid_t taskq_dispatch(taskq_t *, task_func_t, void *, uint_t); 321 extern void taskq_destroy(taskq_t *); 322 extern void taskq_wait(taskq_t *); 323 extern int taskq_member(taskq_t *, void *); 324 325 #define XVA_MAPSIZE 3 326 #define XVA_MAGIC 0x78766174 327 328 /* 329 * vnodes 330 */ 331 typedef struct vnode { 332 uint64_t v_size; 333 int v_fd; 334 char *v_path; 335 } vnode_t; 336 337 338 typedef struct xoptattr { 339 timestruc_t xoa_createtime; /* Create time of file */ 340 uint8_t xoa_archive; 341 uint8_t xoa_system; 342 uint8_t xoa_readonly; 343 uint8_t xoa_hidden; 344 uint8_t xoa_nounlink; 345 uint8_t xoa_immutable; 346 uint8_t xoa_appendonly; 347 uint8_t xoa_nodump; 348 uint8_t xoa_settable; 349 uint8_t xoa_opaque; 350 uint8_t xoa_av_quarantined; 351 uint8_t xoa_av_modified; 352 } xoptattr_t; 353 354 typedef struct vattr { 355 uint_t va_mask; /* bit-mask of attributes */ 356 u_offset_t va_size; /* file size in bytes */ 357 } vattr_t; 358 359 360 typedef struct xvattr { 361 vattr_t xva_vattr; /* Embedded vattr structure */ 362 uint32_t xva_magic; /* Magic Number */ 363 uint32_t xva_mapsize; /* Size of attr bitmap (32-bit words) */ 364 uint32_t *xva_rtnattrmapp; /* Ptr to xva_rtnattrmap[] */ 365 uint32_t xva_reqattrmap[XVA_MAPSIZE]; /* Requested attrs */ 366 uint32_t xva_rtnattrmap[XVA_MAPSIZE]; /* Returned attrs */ 367 xoptattr_t xva_xoptattrs; /* Optional attributes */ 368 } xvattr_t; 369 370 typedef struct vsecattr { 371 uint_t vsa_mask; /* See below */ 372 int vsa_aclcnt; /* ACL entry count */ 373 void *vsa_aclentp; /* pointer to ACL entries */ 374 int vsa_dfaclcnt; /* default ACL entry count */ 375 void *vsa_dfaclentp; /* pointer to default ACL entries */ 376 size_t vsa_aclentsz; /* ACE size in bytes of vsa_aclentp */ 377 } vsecattr_t; 378 379 #define AT_TYPE 0x00001 380 #define AT_MODE 0x00002 381 #define AT_UID 0x00004 382 #define AT_GID 0x00008 383 #define AT_FSID 0x00010 384 #define AT_NODEID 0x00020 385 #define AT_NLINK 0x00040 386 #define AT_SIZE 0x00080 387 #define AT_ATIME 0x00100 388 #define AT_MTIME 0x00200 389 #define AT_CTIME 0x00400 390 #define AT_RDEV 0x00800 391 #define AT_BLKSIZE 0x01000 392 #define AT_NBLOCKS 0x02000 393 #define AT_SEQ 0x08000 394 #define AT_XVATTR 0x10000 395 396 #define CRCREAT 0 397 398 #define VOP_CLOSE(vp, f, c, o, cr, ct) 0 399 #define VOP_PUTPAGE(vp, of, sz, fl, cr, ct) 0 400 #define VOP_GETATTR(vp, vap, fl, cr, ct) ((vap)->va_size = (vp)->v_size, 0) 401 402 #define VOP_FSYNC(vp, f, cr, ct) fsync((vp)->v_fd) 403 404 #define VN_RELE(vp) vn_close(vp) 405 406 extern int vn_open(char *path, int x1, int oflags, int mode, vnode_t **vpp, 407 int x2, int x3); 408 extern int vn_openat(char *path, int x1, int oflags, int mode, vnode_t **vpp, 409 int x2, int x3, vnode_t *vp, int fd); 410 extern int vn_rdwr(int uio, vnode_t *vp, void *addr, ssize_t len, 411 offset_t offset, int x1, int x2, rlim64_t x3, void *x4, ssize_t *residp); 412 extern void vn_close(vnode_t *vp); 413 414 #define vn_remove(path, x1, x2) remove(path) 415 #define vn_rename(from, to, seg) rename((from), (to)) 416 #define vn_is_readonly(vp) B_FALSE 417 418 extern vnode_t *rootdir; 419 420 #include <sys/file.h> /* for FREAD, FWRITE, etc */ 421 422 /* 423 * Random stuff 424 */ 425 #define lbolt (gethrtime() >> 23) 426 #define lbolt64 (gethrtime() >> 23) 427 #define hz 119 /* frequency when using gethrtime() >> 23 for lbolt */ 428 429 extern void delay(clock_t ticks); 430 431 #define gethrestime_sec() time(NULL) 432 433 #define max_ncpus 64 434 435 #define minclsyspri 60 436 #define maxclsyspri 99 437 438 #define CPU_SEQID (thr_self() & (max_ncpus - 1)) 439 440 #define kcred NULL 441 #define CRED() NULL 442 443 extern uint64_t physmem; 444 445 extern int highbit(ulong_t i); 446 extern int random_get_bytes(uint8_t *ptr, size_t len); 447 extern int random_get_pseudo_bytes(uint8_t *ptr, size_t len); 448 449 extern void kernel_init(int); 450 extern void kernel_fini(void); 451 452 struct spa; 453 extern void nicenum(uint64_t num, char *buf); 454 extern void show_pool_stats(struct spa *); 455 456 typedef struct callb_cpr { 457 kmutex_t *cc_lockp; 458 } callb_cpr_t; 459 460 #define CALLB_CPR_INIT(cp, lockp, func, name) { \ 461 (cp)->cc_lockp = lockp; \ 462 } 463 464 #define CALLB_CPR_SAFE_BEGIN(cp) { \ 465 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \ 466 } 467 468 #define CALLB_CPR_SAFE_END(cp, lockp) { \ 469 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \ 470 } 471 472 #define CALLB_CPR_EXIT(cp) { \ 473 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \ 474 mutex_exit((cp)->cc_lockp); \ 475 } 476 477 #define zone_dataset_visible(x, y) (1) 478 #define INGLOBALZONE(z) (1) 479 480 /* 481 * Hostname information 482 */ 483 extern char hw_serial[]; 484 extern int ddi_strtoul(const char *str, char **nptr, int base, 485 unsigned long *result); 486 487 /* ZFS Boot Related stuff. */ 488 489 struct _buf { 490 intptr_t _fd; 491 }; 492 493 struct bootstat { 494 uint64_t st_size; 495 }; 496 497 typedef struct ace_object { 498 uid_t a_who; 499 uint32_t a_access_mask; 500 uint16_t a_flags; 501 uint16_t a_type; 502 uint8_t a_obj_type[16]; 503 uint8_t a_inherit_obj_type[16]; 504 } ace_object_t; 505 506 507 #define ACE_ACCESS_ALLOWED_OBJECT_ACE_TYPE 0x05 508 #define ACE_ACCESS_DENIED_OBJECT_ACE_TYPE 0x06 509 #define ACE_SYSTEM_AUDIT_OBJECT_ACE_TYPE 0x07 510 #define ACE_SYSTEM_ALARM_OBJECT_ACE_TYPE 0x08 511 512 extern struct _buf *kobj_open_file(char *name); 513 extern int kobj_read_file(struct _buf *file, char *buf, unsigned size, 514 unsigned off); 515 extern void kobj_close_file(struct _buf *file); 516 extern int kobj_get_filesize(struct _buf *file, uint64_t *size); 517 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr); 518 extern int zfs_secpolicy_rename_perms(const char *from, const char *to, 519 cred_t *cr); 520 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr); 521 extern zoneid_t getzoneid(void); 522 523 /* 524 * UTF-8 text preparation functions and their macros. 525 * (sunddi.h) 526 */ 527 #define U8_STRCMP_CS 0x00000001 528 #define U8_STRCMP_CI_UPPER 0x00000002 529 #define U8_STRCMP_CI_LOWER 0x00000004 530 531 #define U8_TEXTPREP_TOUPPER U8_STRCMP_CI_UPPER 532 #define U8_TEXTPREP_TOLOWER U8_STRCMP_CI_LOWER 533 #define U8_TEXTPREP_IGNORE_NULL 0x00010000 534 535 #define U8_UNICODE_320 (0) 536 #define U8_UNICODE_500 (1) 537 #define U8_UNICODE_LATEST U8_UNICODE_500 538 539 extern size_t u8_textprep_str(char *, size_t *, char *, size_t *, int, size_t, 540 int *); 541 542 #ifdef __cplusplus 543 } 544 #endif 545 546 #endif /* _SYS_ZFS_CONTEXT_H */ 547