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