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 2009 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 #ifdef __cplusplus 30 extern "C" { 31 #endif 32 33 #define _SYS_MUTEX_H 34 #define _SYS_RWLOCK_H 35 #define _SYS_CONDVAR_H 36 #define _SYS_SYSTM_H 37 #define _SYS_DEBUG_H 38 #define _SYS_T_LOCK_H 39 #define _SYS_VNODE_H 40 #define _SYS_VFS_H 41 #define _SYS_SUNDDI_H 42 #define _SYS_CALLB_H 43 44 #include <stdio.h> 45 #include <stdlib.h> 46 #include <stddef.h> 47 #include <stdarg.h> 48 #include <fcntl.h> 49 #include <unistd.h> 50 #include <errno.h> 51 #include <string.h> 52 #include <strings.h> 53 #include <synch.h> 54 #include <thread.h> 55 #include <assert.h> 56 #include <alloca.h> 57 #include <umem.h> 58 #include <limits.h> 59 #include <atomic.h> 60 #include <dirent.h> 61 #include <time.h> 62 #include <libsysevent.h> 63 #include <sys/note.h> 64 #include <sys/types.h> 65 #include <sys/cred.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/u8_textprep.h> 76 #include <sys/sysevent/eventdefs.h> 77 #include <sys/sysevent/dev.h> 78 79 /* 80 * Debugging 81 */ 82 83 /* 84 * Note that we are not using the debugging levels. 85 */ 86 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 */ 92 93 /* 94 * ZFS debugging 95 */ 96 97 #ifdef ZFS_DEBUG 98 extern void dprintf_setup(int *argc, char **argv); 99 #endif /* ZFS_DEBUG */ 100 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); 105 106 #define fm_panic panic 107 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)) 113 #else 114 #define verify(EX) (void)((EX) || (__assert(#EX, __FILE__, __LINE__), 0)) 115 #endif /* __STDC_VERSION__ - 0 >= 199901L */ 116 #else 117 #define verify(EX) (void)((EX) || (_assert("EX", __FILE__, __LINE__), 0)) 118 #endif /* __STDC__ */ 119 120 121 #define VERIFY verify 122 #define ASSERT assert 123 124 extern void __assert(const char *, const char *, int); 125 126 #ifdef lint 127 #define VERIFY3_IMPL(x, y, z, t) if (x == z) ((void)0) 128 #else 129 /* BEGIN CSTYLED */ 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__); \ 139 } \ 140 _NOTE(CONSTCOND) } while (0) 141 /* END CSTYLED */ 142 #endif /* lint */ 143 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) 147 148 #ifdef NDEBUG 149 #define ASSERT3S(x, y, z) ((void)0) 150 #define ASSERT3U(x, y, z) ((void)0) 151 #define ASSERT3P(x, y, z) ((void)0) 152 #else 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) 156 #endif 157 158 /* 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. 162 */ 163 164 #ifdef DTRACE_PROBE 165 #undef DTRACE_PROBE 166 #define DTRACE_PROBE(a) ((void)0) 167 #endif /* DTRACE_PROBE */ 168 169 #ifdef DTRACE_PROBE1 170 #undef DTRACE_PROBE1 171 #define DTRACE_PROBE1(a, b, c) ((void)0) 172 #endif /* DTRACE_PROBE1 */ 173 174 #ifdef DTRACE_PROBE2 175 #undef DTRACE_PROBE2 176 #define DTRACE_PROBE2(a, b, c, d, e) ((void)0) 177 #endif /* DTRACE_PROBE2 */ 178 179 #ifdef DTRACE_PROBE3 180 #undef DTRACE_PROBE3 181 #define DTRACE_PROBE3(a, b, c, d, e, f, g) ((void)0) 182 #endif /* DTRACE_PROBE3 */ 183 184 #ifdef DTRACE_PROBE4 185 #undef DTRACE_PROBE4 186 #define DTRACE_PROBE4(a, b, c, d, e, f, g, h, i) ((void)0) 187 #endif /* DTRACE_PROBE4 */ 188 189 /* 190 * Threads 191 */ 192 #define curthread ((void *)(uintptr_t)thr_self()) 193 194 typedef struct kthread kthread_t; 195 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) 199 200 extern kthread_t *zk_thread_create(void (*func)(), void *arg); 201 202 #define issig(why) (FALSE) 203 #define ISSIG(thr, why) (FALSE) 204 205 /* 206 * Mutexes 207 */ 208 typedef struct kmutex { 209 void *m_owner; 210 boolean_t initialized; 211 mutex_t m_lock; 212 } kmutex_t; 213 214 #define MUTEX_DEFAULT USYNC_THREAD 215 #undef MUTEX_HELD 216 #define MUTEX_HELD(m) _mutex_held(&(m)->m_lock) 217 218 /* 219 * Argh -- we have to get cheesy here because the kernel and userland 220 * have different signatures for the same routine. 221 */ 222 extern int _mutex_init(mutex_t *mp, int type, void *arg); 223 extern int _mutex_destroy(mutex_t *mp); 224 225 #define mutex_init(mp, b, c, d) zmutex_init((kmutex_t *)(mp)) 226 #define mutex_destroy(mp) zmutex_destroy((kmutex_t *)(mp)) 227 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); 234 235 /* 236 * RW locks 237 */ 238 typedef struct krwlock { 239 void *rw_owner; 240 boolean_t initialized; 241 rwlock_t rw_lock; 242 } krwlock_t; 243 244 typedef int krw_t; 245 246 #define RW_READER 0 247 #define RW_WRITER 1 248 #define RW_DEFAULT USYNC_THREAD 249 250 #undef RW_READ_HELD 251 #define RW_READ_HELD(x) _rw_read_held(&(x)->rw_lock) 252 253 #undef RW_WRITE_HELD 254 #define RW_WRITE_HELD(x) _rw_write_held(&(x)->rw_lock) 255 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) 263 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); 268 269 /* 270 * Condition variables 271 */ 272 typedef cond_t kcondvar_t; 273 274 #define CV_DEFAULT USYNC_THREAD 275 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); 282 283 /* 284 * kstat creation, installation and deletion 285 */ 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 *); 290 291 /* 292 * Kernel memory 293 */ 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) 308 309 typedef umem_cache_t kmem_cache_t; 310 311 /* 312 * Task queues 313 */ 314 typedef struct taskq taskq_t; 315 typedef uintptr_t taskqid_t; 316 typedef void (task_func_t)(void *); 317 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 */ 322 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 */ 326 327 extern taskq_t *system_taskq; 328 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); 335 336 #define XVA_MAPSIZE 3 337 #define XVA_MAGIC 0x78766174 338 339 /* 340 * vnodes 341 */ 342 typedef struct vnode { 343 uint64_t v_size; 344 int v_fd; 345 char *v_path; 346 } vnode_t; 347 348 349 typedef struct xoptattr { 350 timestruc_t xoa_createtime; /* Create time of file */ 351 uint8_t xoa_archive; 352 uint8_t xoa_system; 353 uint8_t xoa_readonly; 354 uint8_t xoa_hidden; 355 uint8_t xoa_nounlink; 356 uint8_t xoa_immutable; 357 uint8_t xoa_appendonly; 358 uint8_t xoa_nodump; 359 uint8_t xoa_settable; 360 uint8_t xoa_opaque; 361 uint8_t xoa_av_quarantined; 362 uint8_t xoa_av_modified; 363 } xoptattr_t; 364 365 typedef struct vattr { 366 uint_t va_mask; /* bit-mask of attributes */ 367 u_offset_t va_size; /* file size in bytes */ 368 } vattr_t; 369 370 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 */ 379 } xvattr_t; 380 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 */ 388 } vsecattr_t; 389 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 406 407 #define CRCREAT 0 408 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) 412 413 #define VOP_FSYNC(vp, f, cr, ct) fsync((vp)->v_fd) 414 415 #define VN_RELE(vp) vn_close(vp) 416 417 extern int vn_open(char *path, int x1, int oflags, int mode, vnode_t **vpp, 418 int x2, int x3); 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); 424 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 428 429 extern vnode_t *rootdir; 430 431 #include <sys/file.h> /* for FREAD, FWRITE, etc */ 432 433 /* 434 * Random stuff 435 */ 436 #define lbolt (gethrtime() >> 23) 437 #define lbolt64 (gethrtime() >> 23) 438 #define hz 119 /* frequency when using gethrtime() >> 23 for lbolt */ 439 440 extern void delay(clock_t ticks); 441 442 #define gethrestime_sec() time(NULL) 443 #define gethrestime(t) \ 444 do {\ 445 (t)->tv_sec = gethrestime_sec();\ 446 (t)->tv_nsec = 0;\ 447 } while (0); 448 449 #define max_ncpus 64 450 451 #define minclsyspri 60 452 #define maxclsyspri 99 453 454 #define CPU_SEQID (thr_self() & (max_ncpus - 1)) 455 456 #define kcred NULL 457 #define CRED() NULL 458 459 #define ptob(x) ((x) * PAGESIZE) 460 461 extern uint64_t physmem; 462 463 extern int highbit(ulong_t i); 464 extern int random_get_bytes(uint8_t *ptr, size_t len); 465 extern int random_get_pseudo_bytes(uint8_t *ptr, size_t len); 466 467 extern void kernel_init(int); 468 extern void kernel_fini(void); 469 470 struct spa; 471 extern void nicenum(uint64_t num, char *buf); 472 extern void show_pool_stats(struct spa *); 473 474 typedef struct callb_cpr { 475 kmutex_t *cc_lockp; 476 } callb_cpr_t; 477 478 #define CALLB_CPR_INIT(cp, lockp, func, name) { \ 479 (cp)->cc_lockp = lockp; \ 480 } 481 482 #define CALLB_CPR_SAFE_BEGIN(cp) { \ 483 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \ 484 } 485 486 #define CALLB_CPR_SAFE_END(cp, lockp) { \ 487 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \ 488 } 489 490 #define CALLB_CPR_EXIT(cp) { \ 491 ASSERT(MUTEX_HELD((cp)->cc_lockp)); \ 492 mutex_exit((cp)->cc_lockp); \ 493 } 494 495 #define zone_dataset_visible(x, y) (1) 496 #define INGLOBALZONE(z) (1) 497 498 extern char *kmem_asprintf(const char *fmt, ...); 499 #define strfree(str) kmem_free((str), strlen(str)+1) 500 501 /* 502 * Hostname information 503 */ 504 extern char hw_serial[]; /* for userland-emulated hostid access */ 505 extern int ddi_strtoul(const char *str, char **nptr, int base, 506 unsigned long *result); 507 508 /* ZFS Boot Related stuff. */ 509 510 struct _buf { 511 intptr_t _fd; 512 }; 513 514 struct bootstat { 515 uint64_t st_size; 516 }; 517 518 typedef struct ace_object { 519 uid_t a_who; 520 uint32_t a_access_mask; 521 uint16_t a_flags; 522 uint16_t a_type; 523 uint8_t a_obj_type[16]; 524 uint8_t a_inherit_obj_type[16]; 525 } ace_object_t; 526 527 528 #define ACE_ACCESS_ALLOWED_OBJECT_ACE_TYPE 0x05 529 #define ACE_ACCESS_DENIED_OBJECT_ACE_TYPE 0x06 530 #define ACE_SYSTEM_AUDIT_OBJECT_ACE_TYPE 0x07 531 #define ACE_SYSTEM_ALARM_OBJECT_ACE_TYPE 0x08 532 533 extern struct _buf *kobj_open_file(char *name); 534 extern int kobj_read_file(struct _buf *file, char *buf, unsigned size, 535 unsigned off); 536 extern void kobj_close_file(struct _buf *file); 537 extern int kobj_get_filesize(struct _buf *file, uint64_t *size); 538 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr); 539 extern int zfs_secpolicy_rename_perms(const char *from, const char *to, 540 cred_t *cr); 541 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr); 542 extern zoneid_t getzoneid(void); 543 544 /* SID stuff */ 545 typedef struct ksiddomain { 546 uint_t kd_ref; 547 uint_t kd_len; 548 char *kd_name; 549 } ksiddomain_t; 550 551 ksiddomain_t *ksid_lookupdomain(const char *); 552 void ksiddomain_rele(ksiddomain_t *); 553 554 #define DDI_SLEEP KM_SLEEP 555 #define ddi_log_sysevent(_a, _b, _c, _d, _e, _f, _g) \ 556 sysevent_post_event(_c, _d, _b, "libzpool", _e, _f) 557 558 #ifdef __cplusplus 559 } 560 #endif 561 562 #endif /* _SYS_ZFS_CONTEXT_H */ 563