include/sys/zfs_context.h

   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 https://opensource.org/licenses/CDDL-1.0.
  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 (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
  23  * Copyright 2011 Nexenta Systems, Inc.  All rights reserved.
  24  * Copyright (c) 2012, 2018 by Delphix. All rights reserved.
  25  * Copyright (c) 2012, Joyent, Inc. All rights reserved.
  26  */
  27
  28 #ifndef _SYS_ZFS_CONTEXT_H
  29 #define _SYS_ZFS_CONTEXT_H
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 /*
  36  * This code compiles in three different contexts. When __KERNEL__ is defined,
  37  * the code uses "unix-like" kernel interfaces. When _STANDALONE is defined, the
  38  * code is running in a reduced capacity environment of the boot loader which is
  39  * generally a subset of both POSIX and kernel interfaces (with a few unique
  40  * interfaces too). When neither are defined, it's in a userland POSIX or
  41  * similar environment.
  42  */
  43 #if defined(__KERNEL__) || defined(_STANDALONE)
  44 #include <sys/types.h>
  45 #include <sys/atomic.h>
  46 #include <sys/sysmacros.h>
  47 #include <sys/vmsystm.h>
  48 #include <sys/condvar.h>
  49 #include <sys/cmn_err.h>
  50 #include <sys/kmem.h>
  51 #include <sys/kmem_cache.h>
  52 #include <sys/vmem.h>
  53 #include <sys/misc.h>
  54 #include <sys/taskq.h>
  55 #include <sys/param.h>
  56 #include <sys/disp.h>
  57 #include <sys/debug.h>
  58 #include <sys/random.h>
  59 #include <sys/string.h>
  60 #include <sys/byteorder.h>
  61 #include <sys/list.h>
  62 #include <sys/time.h>
  63 #include <sys/zone.h>
  64 #include <sys/kstat.h>
  65 #include <sys/zfs_debug.h>
  66 #include <sys/sysevent.h>
  67 #include <sys/sysevent/eventdefs.h>
  68 #include <sys/zfs_delay.h>
  69 #include <sys/sunddi.h>
  70 #include <sys/ctype.h>
  71 #include <sys/disp.h>
  72 #include <sys/trace.h>
  73 #include <sys/procfs_list.h>
  74 #include <sys/mod.h>
  75 #include <sys/uio_impl.h>
  76 #include <sys/zfs_context_os.h>
  77 #else /* _KERNEL || _STANDALONE */
  78
  79 #define _SYS_MUTEX_H
  80 #define _SYS_RWLOCK_H
  81 #define _SYS_CONDVAR_H
  82 #define _SYS_VNODE_H
  83 #define _SYS_VFS_H
  84 #define _SYS_SUNDDI_H
  85 #define _SYS_CALLB_H
  86
  87 #include <stdio.h>
  88 #include <stdlib.h>
  89 #include <stddef.h>
  90 #include <stdarg.h>
  91 #include <fcntl.h>
  92 #include <unistd.h>
  93 #include <errno.h>
  94 #include <string.h>
  95 #include <pthread.h>
  96 #include <setjmp.h>
  97 #include <assert.h>
  98 #include <umem.h>
  99 #include <limits.h>
 100 #include <atomic.h>
 101 #include <dirent.h>
 102 #include <time.h>
 103 #include <ctype.h>
 104 #include <signal.h>
 105 #include <sys/mman.h>
 106 #include <sys/types.h>
 107 #include <sys/cred.h>
 108 #include <sys/sysmacros.h>
 109 #include <sys/resource.h>
 110 #include <sys/byteorder.h>
 111 #include <sys/list.h>
 112 #include <sys/mod.h>
 113 #include <sys/uio.h>
 114 #include <sys/zfs_debug.h>
 115 #include <sys/kstat.h>
 116 #include <sys/u8_textprep.h>
 117 #include <sys/sysevent.h>
 118 #include <sys/sysevent/eventdefs.h>
 119 #include <sys/sunddi.h>
 120 #include <sys/debug.h>
 121 #include <sys/utsname.h>
 122 #include <sys/trace_zfs.h>
 123
 124 #include <sys/zfs_context_os.h>
 125
 126 /*
 127  * Stack
 128  */
 129
 130 #define noinline        __attribute__((noinline))
 131 #define likely(x)       __builtin_expect((x), 1)
 132 #define unlikely(x)     __builtin_expect((x), 0)
 133
 134 /*
 135  * Debugging
 136  */
 137
 138 /*
 139  * Note that we are not using the debugging levels.
 140  */
 141
 142 #define CE_CONT         0       /* continuation         */
 143 #define CE_NOTE         1       /* notice               */
 144 #define CE_WARN         2       /* warning              */
 145 #define CE_PANIC        3       /* panic                */
 146 #define CE_IGNORE       4       /* print nothing        */
 147
 148 /*
 149  * ZFS debugging
 150  */
 151
 152 extern void dprintf_setup(int *argc, char **argv);
 153
 154 extern void cmn_err(int, const char *, ...)
 155     __attribute__((format(printf, 2, 3)));
 156 extern void vcmn_err(int, const char *, va_list)
 157     __attribute__((format(printf, 2, 0)));
 158 extern void panic(const char *, ...)
 159     __attribute__((format(printf, 1, 2), noreturn));
 160 extern void vpanic(const char *, va_list)
 161     __attribute__((format(printf, 1, 0), noreturn));
 162
 163 #define fm_panic        panic
 164
 165 /*
 166  * DTrace SDT probes have different signatures in userland than they do in
 167  * the kernel.  If they're being used in kernel code, re-define them out of
 168  * existence for their counterparts in libzpool.
 169  *
 170  * Here's an example of how to use the set-error probes in userland:
 171  * zfs$target:::set-error /arg0 == EBUSY/ {stack();}
 172  *
 173  * Here's an example of how to use DTRACE_PROBE probes in userland:
 174  * If there is a probe declared as follows:
 175  * DTRACE_PROBE2(zfs__probe_name, uint64_t, blkid, dnode_t *, dn);
 176  * Then you can use it as follows:
 177  * zfs$target:::probe2 /copyinstr(arg0) == "zfs__probe_name"/
 178  *     {printf("%u %p\n", arg1, arg2);}
 179  */
 180
 181 #ifdef DTRACE_PROBE
 182 #undef  DTRACE_PROBE
 183 #endif  /* DTRACE_PROBE */
 184 #define DTRACE_PROBE(a)
 185
 186 #ifdef DTRACE_PROBE1
 187 #undef  DTRACE_PROBE1
 188 #endif  /* DTRACE_PROBE1 */
 189 #define DTRACE_PROBE1(a, b, c)
 190
 191 #ifdef DTRACE_PROBE2
 192 #undef  DTRACE_PROBE2
 193 #endif  /* DTRACE_PROBE2 */
 194 #define DTRACE_PROBE2(a, b, c, d, e)
 195
 196 #ifdef DTRACE_PROBE3
 197 #undef  DTRACE_PROBE3
 198 #endif  /* DTRACE_PROBE3 */
 199 #define DTRACE_PROBE3(a, b, c, d, e, f, g)
 200
 201 #ifdef DTRACE_PROBE4
 202 #undef  DTRACE_PROBE4
 203 #endif  /* DTRACE_PROBE4 */
 204 #define DTRACE_PROBE4(a, b, c, d, e, f, g, h, i)
 205
 206 /*
 207  * Tunables.
 208  */
 209 typedef struct zfs_kernel_param {
 210         const char *name;       /* unused stub */
 211 } zfs_kernel_param_t;
 212
 213 #define ZFS_MODULE_PARAM(scope_prefix, name_prefix, name, type, perm, desc)
 214 #define ZFS_MODULE_PARAM_ARGS void
 215 #define ZFS_MODULE_PARAM_CALL(scope_prefix, name_prefix, name, setfunc, \
 216         getfunc, perm, desc)
 217
 218 /*
 219  * Threads.
 220  */
 221 typedef pthread_t       kthread_t;
 222
 223 #define TS_RUN          0x00000002
 224 #define TS_JOINABLE     0x00000004
 225
 226 #define curthread       ((void *)(uintptr_t)pthread_self())
 227 #define getcomm()       "unknown"
 228
 229 #define thread_create_named(name, stk, stksize, func, arg, len, \
 230     pp, state, pri)     \
 231         zk_thread_create(name, func, arg, stksize, state)
 232 #define thread_create(stk, stksize, func, arg, len, pp, state, pri)     \
 233         zk_thread_create(#func, func, arg, stksize, state)
 234 #define thread_exit()   pthread_exit(NULL)
 235 #define thread_join(t)  pthread_join((pthread_t)(t), NULL)
 236
 237 #define newproc(f, a, cid, pri, ctp, pid)       (ENOSYS)
 238
 239 /* in libzpool, p0 exists only to have its address taken */
 240 typedef struct proc {
 241         uintptr_t       this_is_never_used_dont_dereference_it;
 242 } proc_t;
 243
 244 extern struct proc p0;
 245 #define curproc         (&p0)
 246
 247 #define PS_NONE         -1
 248
 249 extern kthread_t *zk_thread_create(const char *name, void (*func)(void *),
 250     void *arg, size_t stksize, int state);
 251
 252 #define issig()         (FALSE)
 253
 254 #define KPREEMPT_SYNC           (-1)
 255
 256 #define kpreempt(x)             sched_yield()
 257 #define kpreempt_disable()      ((void)0)
 258 #define kpreempt_enable()       ((void)0)
 259
 260 /*
 261  * Mutexes
 262  */
 263 typedef struct kmutex {
 264         pthread_mutex_t         m_lock;
 265         pthread_t               m_owner;
 266 } kmutex_t;
 267
 268 #define MUTEX_DEFAULT           0
 269 #define MUTEX_NOLOCKDEP         MUTEX_DEFAULT
 270 #define MUTEX_HELD(mp)          pthread_equal((mp)->m_owner, pthread_self())
 271 #define MUTEX_NOT_HELD(mp)      !MUTEX_HELD(mp)
 272
 273 extern void mutex_init(kmutex_t *mp, char *name, int type, void *cookie);
 274 extern void mutex_destroy(kmutex_t *mp);
 275 extern void mutex_enter(kmutex_t *mp);
 276 extern int mutex_enter_check_return(kmutex_t *mp);
 277 extern void mutex_exit(kmutex_t *mp);
 278 extern int mutex_tryenter(kmutex_t *mp);
 279
 280 #define NESTED_SINGLE 1
 281 #define mutex_enter_nested(mp, class) mutex_enter(mp)
 282 #define mutex_enter_interruptible(mp) mutex_enter_check_return(mp)
 283 /*
 284  * RW locks
 285  */
 286 typedef struct krwlock {
 287         pthread_rwlock_t        rw_lock;
 288         pthread_t               rw_owner;
 289         uint_t                  rw_readers;
 290 } krwlock_t;
 291
 292 typedef int krw_t;
 293
 294 #define RW_READER               0
 295 #define RW_WRITER               1
 296 #define RW_DEFAULT              RW_READER
 297 #define RW_NOLOCKDEP            RW_READER
 298
 299 #define RW_READ_HELD(rw)        ((rw)->rw_readers > 0)
 300 #define RW_WRITE_HELD(rw)       pthread_equal((rw)->rw_owner, pthread_self())
 301 #define RW_LOCK_HELD(rw)        (RW_READ_HELD(rw) || RW_WRITE_HELD(rw))
 302
 303 extern void rw_init(krwlock_t *rwlp, char *name, int type, void *arg);
 304 extern void rw_destroy(krwlock_t *rwlp);
 305 extern void rw_enter(krwlock_t *rwlp, krw_t rw);
 306 extern int rw_tryenter(krwlock_t *rwlp, krw_t rw);
 307 extern int rw_tryupgrade(krwlock_t *rwlp);
 308 extern void rw_exit(krwlock_t *rwlp);
 309 #define rw_downgrade(rwlp) do { } while (0)
 310
 311 /*
 312  * Credentials
 313  */
 314 extern uid_t crgetuid(cred_t *cr);
 315 extern uid_t crgetruid(cred_t *cr);
 316 extern gid_t crgetgid(cred_t *cr);
 317 extern int crgetngroups(cred_t *cr);
 318 extern gid_t *crgetgroups(cred_t *cr);
 319
 320 /*
 321  * Condition variables
 322  */
 323 typedef pthread_cond_t          kcondvar_t;
 324
 325 #define CV_DEFAULT              0
 326 #define CALLOUT_FLAG_ABSOLUTE   0x2
 327
 328 extern void cv_init(kcondvar_t *cv, char *name, int type, void *arg);
 329 extern void cv_destroy(kcondvar_t *cv);
 330 extern void cv_wait(kcondvar_t *cv, kmutex_t *mp);
 331 extern int cv_wait_sig(kcondvar_t *cv, kmutex_t *mp);
 332 extern int cv_timedwait(kcondvar_t *cv, kmutex_t *mp, clock_t abstime);
 333 extern int cv_timedwait_hires(kcondvar_t *cvp, kmutex_t *mp, hrtime_t tim,
 334     hrtime_t res, int flag);
 335 extern void cv_signal(kcondvar_t *cv);
 336 extern void cv_broadcast(kcondvar_t *cv);
 337
 338 #define cv_timedwait_io(cv, mp, at)             cv_timedwait(cv, mp, at)
 339 #define cv_timedwait_idle(cv, mp, at)           cv_timedwait(cv, mp, at)
 340 #define cv_timedwait_sig(cv, mp, at)            cv_timedwait(cv, mp, at)
 341 #define cv_wait_io(cv, mp)                      cv_wait(cv, mp)
 342 #define cv_wait_idle(cv, mp)                    cv_wait(cv, mp)
 343 #define cv_wait_io_sig(cv, mp)                  cv_wait_sig(cv, mp)
 344 #define cv_timedwait_sig_hires(cv, mp, t, r, f) \
 345         cv_timedwait_hires(cv, mp, t, r, f)
 346 #define cv_timedwait_idle_hires(cv, mp, t, r, f) \
 347         cv_timedwait_hires(cv, mp, t, r, f)
 348
 349 /*
 350  * Thread-specific data
 351  */
 352 #define tsd_get(k) pthread_getspecific(k)
 353 #define tsd_set(k, v) pthread_setspecific(k, v)
 354 #define tsd_create(kp, d) pthread_key_create((pthread_key_t *)kp, d)
 355 #define tsd_destroy(kp) /* nothing */
 356 #ifdef __FreeBSD__
 357 typedef off_t loff_t;
 358 #endif
 359
 360 /*
 361  * kstat creation, installation and deletion
 362  */
 363 extern kstat_t *kstat_create(const char *, int,
 364     const char *, const char *, uchar_t, ulong_t, uchar_t);
 365 extern void kstat_install(kstat_t *);
 366 extern void kstat_delete(kstat_t *);
 367 extern void kstat_set_raw_ops(kstat_t *ksp,
 368     int (*headers)(char *buf, size_t size),
 369     int (*data)(char *buf, size_t size, void *data),
 370     void *(*addr)(kstat_t *ksp, loff_t index));
 371
 372 /*
 373  * procfs list manipulation
 374  */
 375
 376 typedef struct procfs_list {
 377         void            *pl_private;
 378         kmutex_t        pl_lock;
 379         list_t          pl_list;
 380         uint64_t        pl_next_id;
 381         size_t          pl_node_offset;
 382 } procfs_list_t;
 383
 384 #ifndef __cplusplus
 385 struct seq_file { };
 386 void seq_printf(struct seq_file *m, const char *fmt, ...);
 387
 388 typedef struct procfs_list_node {
 389         list_node_t     pln_link;
 390         uint64_t        pln_id;
 391 } procfs_list_node_t;
 392
 393 void procfs_list_install(const char *module,
 394     const char *submodule,
 395     const char *name,
 396     mode_t mode,
 397     procfs_list_t *procfs_list,
 398     int (*show)(struct seq_file *f, void *p),
 399     int (*show_header)(struct seq_file *f),
 400     int (*clear)(procfs_list_t *procfs_list),
 401     size_t procfs_list_node_off);
 402 void procfs_list_uninstall(procfs_list_t *procfs_list);
 403 void procfs_list_destroy(procfs_list_t *procfs_list);
 404 void procfs_list_add(procfs_list_t *procfs_list, void *p);
 405 #endif
 406
 407 /*
 408  * Kernel memory
 409  */
 410 #define KM_SLEEP                UMEM_NOFAIL
 411 #define KM_PUSHPAGE             KM_SLEEP
 412 #define KM_NOSLEEP              UMEM_DEFAULT
 413 #define KM_NORMALPRI            0       /* not needed with UMEM_DEFAULT */
 414 #define KMC_NODEBUG             UMC_NODEBUG
 415 #define KMC_KVMEM               0x0
 416 #define KMC_RECLAIMABLE         0x0
 417 #define kmem_alloc(_s, _f)      umem_alloc(_s, _f)
 418 #define kmem_zalloc(_s, _f)     umem_zalloc(_s, _f)
 419 #define kmem_free(_b, _s)       umem_free(_b, _s)
 420 #define vmem_alloc(_s, _f)      kmem_alloc(_s, _f)
 421 #define vmem_zalloc(_s, _f)     kmem_zalloc(_s, _f)
 422 #define vmem_free(_b, _s)       kmem_free(_b, _s)
 423 #define kmem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i) \
 424         umem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i)
 425 #define kmem_cache_destroy(_c)  umem_cache_destroy(_c)
 426 #define kmem_cache_alloc(_c, _f) umem_cache_alloc(_c, _f)
 427 #define kmem_cache_free(_c, _b) umem_cache_free(_c, _b)
 428 #define kmem_debugging()        0
 429 #define kmem_cache_reap_now(_c) umem_cache_reap_now(_c);
 430 #define kmem_cache_set_move(_c, _cb)    /* nothing */
 431 #define POINTER_INVALIDATE(_pp)         /* nothing */
 432 #define POINTER_IS_VALID(_p)    0
 433
 434 typedef umem_cache_t kmem_cache_t;
 435
 436 typedef enum kmem_cbrc {
 437         KMEM_CBRC_YES,
 438         KMEM_CBRC_NO,
 439         KMEM_CBRC_LATER,
 440         KMEM_CBRC_DONT_NEED,
 441         KMEM_CBRC_DONT_KNOW
 442 } kmem_cbrc_t;
 443
 444 /*
 445  * Task queues
 446  */
 447
 448 #define TASKQ_NAMELEN   31
 449
 450 typedef uintptr_t taskqid_t;
 451 typedef void (task_func_t)(void *);
 452
 453 typedef struct taskq_ent {
 454         struct taskq_ent        *tqent_next;
 455         struct taskq_ent        *tqent_prev;
 456         task_func_t             *tqent_func;
 457         void                    *tqent_arg;
 458         uintptr_t               tqent_flags;
 459 } taskq_ent_t;
 460
 461 typedef struct taskq {
 462         char            tq_name[TASKQ_NAMELEN + 1];
 463         kmutex_t        tq_lock;
 464         krwlock_t       tq_threadlock;
 465         kcondvar_t      tq_dispatch_cv;
 466         kcondvar_t      tq_wait_cv;
 467         kthread_t       **tq_threadlist;
 468         int             tq_flags;
 469         int             tq_active;
 470         int             tq_nthreads;
 471         int             tq_nalloc;
 472         int             tq_minalloc;
 473         int             tq_maxalloc;
 474         kcondvar_t      tq_maxalloc_cv;
 475         int             tq_maxalloc_wait;
 476         taskq_ent_t     *tq_freelist;
 477         taskq_ent_t     tq_task;
 478 } taskq_t;
 479
 480 #define TQENT_FLAG_PREALLOC     0x1     /* taskq_dispatch_ent used */
 481
 482 #define TASKQ_PREPOPULATE       0x0001
 483 #define TASKQ_CPR_SAFE          0x0002  /* Use CPR safe protocol */
 484 #define TASKQ_DYNAMIC           0x0004  /* Use dynamic thread scheduling */
 485 #define TASKQ_THREADS_CPU_PCT   0x0008  /* Scale # threads by # cpus */
 486 #define TASKQ_DC_BATCH          0x0010  /* Mark threads as batch */
 487
 488 #define TQ_SLEEP        KM_SLEEP        /* Can block for memory */
 489 #define TQ_NOSLEEP      KM_NOSLEEP      /* cannot block for memory; may fail */
 490 #define TQ_NOQUEUE      0x02            /* Do not enqueue if can't dispatch */
 491 #define TQ_FRONT        0x08            /* Queue in front */
 492
 493 #define TASKQID_INVALID         ((taskqid_t)0)
 494
 495 extern taskq_t *system_taskq;
 496 extern taskq_t *system_delay_taskq;
 497
 498 extern taskq_t  *taskq_create(const char *, int, pri_t, int, int, uint_t);
 499 extern taskq_t  *taskq_create_synced(const char *, int, pri_t, int, int, uint_t,
 500     kthread_t ***);
 501 #define taskq_create_proc(a, b, c, d, e, p, f) \
 502             (taskq_create(a, b, c, d, e, f))
 503 #define taskq_create_sysdc(a, b, d, e, p, dc, f) \
 504             ((void) sizeof (dc), taskq_create(a, b, maxclsyspri, d, e, f))
 505 extern taskqid_t taskq_dispatch(taskq_t *, task_func_t, void *, uint_t);
 506 extern taskqid_t taskq_dispatch_delay(taskq_t *, task_func_t, void *, uint_t,
 507     clock_t);
 508 extern void     taskq_dispatch_ent(taskq_t *, task_func_t, void *, uint_t,
 509     taskq_ent_t *);
 510 extern int      taskq_empty_ent(taskq_ent_t *);
 511 extern void     taskq_init_ent(taskq_ent_t *);
 512 extern void     taskq_destroy(taskq_t *);
 513 extern void     taskq_wait(taskq_t *);
 514 extern void     taskq_wait_id(taskq_t *, taskqid_t);
 515 extern void     taskq_wait_outstanding(taskq_t *, taskqid_t);
 516 extern int      taskq_member(taskq_t *, kthread_t *);
 517 extern taskq_t  *taskq_of_curthread(void);
 518 extern int      taskq_cancel_id(taskq_t *, taskqid_t);
 519 extern void     system_taskq_init(void);
 520 extern void     system_taskq_fini(void);
 521
 522 #define XVA_MAPSIZE     3
 523 #define XVA_MAGIC       0x78766174
 524
 525 extern char *vn_dumpdir;
 526 #define AV_SCANSTAMP_SZ 32              /* length of anti-virus scanstamp */
 527
 528 typedef struct xoptattr {
 529         inode_timespec_t xoa_createtime;        /* Create time of file */
 530         uint8_t         xoa_archive;
 531         uint8_t         xoa_system;
 532         uint8_t         xoa_readonly;
 533         uint8_t         xoa_hidden;
 534         uint8_t         xoa_nounlink;
 535         uint8_t         xoa_immutable;
 536         uint8_t         xoa_appendonly;
 537         uint8_t         xoa_nodump;
 538         uint8_t         xoa_settable;
 539         uint8_t         xoa_opaque;
 540         uint8_t         xoa_av_quarantined;
 541         uint8_t         xoa_av_modified;
 542         uint8_t         xoa_av_scanstamp[AV_SCANSTAMP_SZ];
 543         uint8_t         xoa_reparse;
 544         uint8_t         xoa_offline;
 545         uint8_t         xoa_sparse;
 546 } xoptattr_t;
 547
 548 typedef struct vattr {
 549         uint_t          va_mask;        /* bit-mask of attributes */
 550         u_offset_t      va_size;        /* file size in bytes */
 551 } vattr_t;
 552
 553
 554 typedef struct xvattr {
 555         vattr_t         xva_vattr;      /* Embedded vattr structure */
 556         uint32_t        xva_magic;      /* Magic Number */
 557         uint32_t        xva_mapsize;    /* Size of attr bitmap (32-bit words) */
 558         uint32_t        *xva_rtnattrmapp;       /* Ptr to xva_rtnattrmap[] */
 559         uint32_t        xva_reqattrmap[XVA_MAPSIZE];    /* Requested attrs */
 560         uint32_t        xva_rtnattrmap[XVA_MAPSIZE];    /* Returned attrs */
 561         xoptattr_t      xva_xoptattrs;  /* Optional attributes */
 562 } xvattr_t;
 563
 564 typedef struct vsecattr {
 565         uint_t          vsa_mask;       /* See below */
 566         int             vsa_aclcnt;     /* ACL entry count */
 567         void            *vsa_aclentp;   /* pointer to ACL entries */
 568         int             vsa_dfaclcnt;   /* default ACL entry count */
 569         void            *vsa_dfaclentp; /* pointer to default ACL entries */
 570         size_t          vsa_aclentsz;   /* ACE size in bytes of vsa_aclentp */
 571 } vsecattr_t;
 572
 573 #define AT_MODE         0x00002
 574 #define AT_UID          0x00004
 575 #define AT_GID          0x00008
 576 #define AT_FSID         0x00010
 577 #define AT_NODEID       0x00020
 578 #define AT_NLINK        0x00040
 579 #define AT_SIZE         0x00080
 580 #define AT_ATIME        0x00100
 581 #define AT_MTIME        0x00200
 582 #define AT_CTIME        0x00400
 583 #define AT_RDEV         0x00800
 584 #define AT_BLKSIZE      0x01000
 585 #define AT_NBLOCKS      0x02000
 586 #define AT_SEQ          0x08000
 587 #define AT_XVATTR       0x10000
 588
 589 #define CRCREAT         0
 590
 591 #define F_FREESP        11
 592 #define FIGNORECASE     0x80000 /* request case-insensitive lookups */
 593
 594 /*
 595  * Random stuff
 596  */
 597 #define ddi_get_lbolt()         (gethrtime() >> 23)
 598 #define ddi_get_lbolt64()       (gethrtime() >> 23)
 599 #define hz      119     /* frequency when using gethrtime() >> 23 for lbolt */
 600
 601 #define ddi_time_before(a, b)           (a < b)
 602 #define ddi_time_after(a, b)            ddi_time_before(b, a)
 603 #define ddi_time_before_eq(a, b)        (!ddi_time_after(a, b))
 604 #define ddi_time_after_eq(a, b)         ddi_time_before_eq(b, a)
 605
 606 #define ddi_time_before64(a, b)         (a < b)
 607 #define ddi_time_after64(a, b)          ddi_time_before64(b, a)
 608 #define ddi_time_before_eq64(a, b)      (!ddi_time_after64(a, b))
 609 #define ddi_time_after_eq64(a, b)       ddi_time_before_eq64(b, a)
 610
 611 extern void delay(clock_t ticks);
 612
 613 #define SEC_TO_TICK(sec)        ((sec) * hz)
 614 #define MSEC_TO_TICK(msec)      (howmany((hrtime_t)(msec) * hz, MILLISEC))
 615 #define USEC_TO_TICK(usec)      (howmany((hrtime_t)(usec) * hz, MICROSEC))
 616 #define NSEC_TO_TICK(nsec)      (howmany((hrtime_t)(nsec) * hz, NANOSEC))
 617
 618 #define max_ncpus       64
 619 #define boot_ncpus      (sysconf(_SC_NPROCESSORS_ONLN))
 620
 621 /*
 622  * Process priorities as defined by setpriority(2) and getpriority(2).
 623  */
 624 #define minclsyspri     19
 625 #define maxclsyspri     -20
 626 #define defclsyspri     0
 627
 628 #define CPU_SEQID       ((uintptr_t)pthread_self() & (max_ncpus - 1))
 629 #define CPU_SEQID_UNSTABLE      CPU_SEQID
 630
 631 #define kcred           NULL
 632 #define CRED()          NULL
 633
 634 #define ptob(x)         ((x) * PAGESIZE)
 635
 636 #define NN_DIVISOR_1000 (1U << 0)
 637 #define NN_NUMBUF_SZ    (6)
 638
 639 extern uint64_t physmem;
 640 extern const char *random_path;
 641 extern const char *urandom_path;
 642
 643 extern int highbit64(uint64_t i);
 644 extern int lowbit64(uint64_t i);
 645 extern int random_get_bytes(uint8_t *ptr, size_t len);
 646 extern int random_get_pseudo_bytes(uint8_t *ptr, size_t len);
 647
 648 static __inline__ uint32_t
 649 random_in_range(uint32_t range)
 650 {
 651         uint32_t r;
 652
 653         ASSERT(range != 0);
 654
 655         if (range == 1)
 656                 return (0);
 657
 658         (void) random_get_pseudo_bytes((uint8_t *)&r, sizeof (r));
 659
 660         return (r % range);
 661 }
 662
 663 extern void kernel_init(int mode);
 664 extern void kernel_fini(void);
 665 extern void random_init(void);
 666 extern void random_fini(void);
 667
 668 struct spa;
 669 extern void show_pool_stats(struct spa *);
 670 extern int set_global_var(char const *arg);
 671
 672 typedef struct callb_cpr {
 673         kmutex_t        *cc_lockp;
 674 } callb_cpr_t;
 675
 676 #define CALLB_CPR_INIT(cp, lockp, func, name)   {               \
 677         (cp)->cc_lockp = lockp;                                 \
 678 }
 679
 680 #define CALLB_CPR_SAFE_BEGIN(cp) {                              \
 681         ASSERT(MUTEX_HELD((cp)->cc_lockp));                     \
 682 }
 683
 684 #define CALLB_CPR_SAFE_END(cp, lockp) {                         \
 685         ASSERT(MUTEX_HELD((cp)->cc_lockp));                     \
 686 }
 687
 688 #define CALLB_CPR_EXIT(cp) {                                    \
 689         ASSERT(MUTEX_HELD((cp)->cc_lockp));                     \
 690         mutex_exit((cp)->cc_lockp);                             \
 691 }
 692
 693 #define zone_dataset_visible(x, y)      (1)
 694 #define INGLOBALZONE(z)                 (1)
 695 extern uint32_t zone_get_hostid(void *zonep);
 696
 697 extern char *kmem_vasprintf(const char *fmt, va_list adx);
 698 extern char *kmem_asprintf(const char *fmt, ...);
 699 #define kmem_strfree(str) kmem_free((str), strlen(str) + 1)
 700 #define kmem_strdup(s)  strdup(s)
 701
 702 #ifndef __cplusplus
 703 extern int kmem_scnprintf(char *restrict str, size_t size,
 704     const char *restrict fmt, ...);
 705 #endif
 706
 707 /*
 708  * Hostname information
 709  */
 710 extern int ddi_strtoull(const char *str, char **nptr, int base,
 711     u_longlong_t *result);
 712
 713 typedef struct utsname  utsname_t;
 714 extern utsname_t *utsname(void);
 715
 716 /* ZFS Boot Related stuff. */
 717
 718 struct _buf {
 719         intptr_t        _fd;
 720 };
 721
 722 struct bootstat {
 723         uint64_t st_size;
 724 };
 725
 726 typedef struct ace_object {
 727         uid_t           a_who;
 728         uint32_t        a_access_mask;
 729         uint16_t        a_flags;
 730         uint16_t        a_type;
 731         uint8_t         a_obj_type[16];
 732         uint8_t         a_inherit_obj_type[16];
 733 } ace_object_t;
 734
 735
 736 #define ACE_ACCESS_ALLOWED_OBJECT_ACE_TYPE      0x05
 737 #define ACE_ACCESS_DENIED_OBJECT_ACE_TYPE       0x06
 738 #define ACE_SYSTEM_AUDIT_OBJECT_ACE_TYPE        0x07
 739 #define ACE_SYSTEM_ALARM_OBJECT_ACE_TYPE        0x08
 740
 741 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
 742 extern int zfs_secpolicy_rename_perms(const char *from, const char *to,
 743     cred_t *cr);
 744 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
 745 extern int secpolicy_zfs(const cred_t *cr);
 746 extern int secpolicy_zfs_proc(const cred_t *cr, proc_t *proc);
 747 extern zoneid_t getzoneid(void);
 748
 749 /* SID stuff */
 750 typedef struct ksiddomain {
 751         uint_t  kd_ref;
 752         uint_t  kd_len;
 753         char    *kd_name;
 754 } ksiddomain_t;
 755
 756 ksiddomain_t *ksid_lookupdomain(const char *);
 757 void ksiddomain_rele(ksiddomain_t *);
 758
 759 #define DDI_SLEEP       KM_SLEEP
 760 #define ddi_log_sysevent(_a, _b, _c, _d, _e, _f, _g) \
 761         sysevent_post_event(_c, _d, _b, "libzpool", _e, _f)
 762
 763 #define zfs_sleep_until(wakeup)                                         \
 764         do {                                                            \
 765                 hrtime_t delta = wakeup - gethrtime();                  \
 766                 struct timespec ts;                                     \
 767                 ts.tv_sec = delta / NANOSEC;                            \
 768                 ts.tv_nsec = delta % NANOSEC;                           \
 769                 (void) nanosleep(&ts, NULL);                            \
 770         } while (0)
 771
 772 typedef int fstrans_cookie_t;
 773
 774 extern fstrans_cookie_t spl_fstrans_mark(void);
 775 extern void spl_fstrans_unmark(fstrans_cookie_t);
 776 extern int __spl_pf_fstrans_check(void);
 777 extern int kmem_cache_reap_active(void);
 778
 779
 780 /*
 781  * Kernel modules
 782  */
 783 #define __init
 784 #define __exit
 785
 786 #endif  /* _KERNEL || _STANDALONE */
 787
 788 #ifdef __cplusplus
 789 };
 790 #endif
 791
 792 #endif  /* _SYS_ZFS_CONTEXT_H */