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