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 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  * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
  27  * Copyright (c) 2012, Joyent, Inc. All rights reserved.
  28  * Copyright (c) 2012, 2015 by Delphix. All rights reserved.
  29  */
  30
  31 #ifndef _SYS_ZFS_CONTEXT_H
  32 #define _SYS_ZFS_CONTEXT_H
  33
  34 #ifdef __KERNEL__
  35
  36 #include <sys/note.h>
  37 #include <sys/types.h>
  38 #include <sys/t_lock.h>
  39 #include <sys/atomic.h>
  40 #include <sys/sysmacros.h>
  41 #include <sys/bitmap.h>
  42 #include <sys/cmn_err.h>
  43 #include <sys/kmem.h>
  44 #include <sys/kmem_cache.h>
  45 #include <sys/vmem.h>
  46 #include <sys/taskq.h>
  47 #include <sys/buf.h>
  48 #include <sys/param.h>
  49 #include <sys/systm.h>
  50 #include <sys/cpuvar.h>
  51 #include <sys/kobj.h>
  52 #include <sys/conf.h>
  53 #include <sys/disp.h>
  54 #include <sys/debug.h>
  55 #include <sys/random.h>
  56 #include <sys/byteorder.h>
  57 #include <sys/systm.h>
  58 #include <sys/list.h>
  59 #include <sys/uio_impl.h>
  60 #include <sys/dirent.h>
  61 #include <sys/time.h>
  62 #include <vm/seg_kmem.h>
  63 #include <sys/zone.h>
  64 #include <sys/sdt.h>
  65 #include <sys/kstat.h>
  66 #include <sys/zfs_debug.h>
  67 #include <sys/zfs_delay.h>
  68 #include <sys/fm/fs/zfs.h>
  69 #include <sys/sunddi.h>
  70 #include <sys/ctype.h>
  71 #include <sys/disp.h>
  72 #include <sys/trace.h>
  73 #include <linux/dcache_compat.h>
  74 #include <linux/utsname_compat.h>
  75
  76 #else /* _KERNEL */
  77
  78 #define _SYS_MUTEX_H
  79 #define _SYS_RWLOCK_H
  80 #define _SYS_CONDVAR_H
  81 #define _SYS_SYSTM_H
  82 #define _SYS_T_LOCK_H
  83 #define _SYS_VNODE_H
  84 #define _SYS_VFS_H
  85 #define _SYS_SUNDDI_H
  86 #define _SYS_CALLB_H
  87
  88 #include <stdio.h>
  89 #include <stdlib.h>
  90 #include <stddef.h>
  91 #include <stdarg.h>
  92 #include <fcntl.h>
  93 #include <unistd.h>
  94 #include <errno.h>
  95 #include <string.h>
  96 #include <strings.h>
  97 #include <pthread.h>
  98 #include <synch.h>
  99 #include <assert.h>
 100 #include <alloca.h>
 101 #include <umem.h>
 102 #include <limits.h>
 103 #include <atomic.h>
 104 #include <dirent.h>
 105 #include <time.h>
 106 #include <ctype.h>
 107 #include <signal.h>
 108 #include <sys/mman.h>
 109 #include <sys/note.h>
 110 #include <sys/types.h>
 111 #include <sys/cred.h>
 112 #include <sys/sysmacros.h>
 113 #include <sys/bitmap.h>
 114 #include <sys/resource.h>
 115 #include <sys/byteorder.h>
 116 #include <sys/list.h>
 117 #include <sys/uio.h>
 118 #include <sys/zfs_debug.h>
 119 #include <sys/sdt.h>
 120 #include <sys/kstat.h>
 121 #include <sys/u8_textprep.h>
 122 #include <sys/fm/fs/zfs.h>
 123 #include <sys/sunddi.h>
 124 #include <sys/debug.h>
 125 #include <sys/utsname.h>
 126
 127 /*
 128  * Stack
 129  */
 130
 131 #define noinline        __attribute__((noinline))
 132
 133 /*
 134  * Debugging
 135  */
 136
 137 /*
 138  * Note that we are not using the debugging levels.
 139  */
 140
 141 #define CE_CONT         0       /* continuation         */
 142 #define CE_NOTE         1       /* notice               */
 143 #define CE_WARN         2       /* warning              */
 144 #define CE_PANIC        3       /* panic                */
 145 #define CE_IGNORE       4       /* print nothing        */
 146
 147 /*
 148  * ZFS debugging
 149  */
 150
 151 extern void dprintf_setup(int *argc, char **argv);
 152
 153 extern void cmn_err(int, const char *, ...);
 154 extern void vcmn_err(int, const char *, va_list);
 155 extern void panic(const char *, ...);
 156 extern void vpanic(const char *, va_list);
 157
 158 #define fm_panic        panic
 159
 160 extern int aok;
 161
 162 /*
 163  * DTrace SDT probes have different signatures in userland than they do in
 164  * the kernel.  If they're being used in kernel code, re-define them out of
 165  * existence for their counterparts in libzpool.
 166  *
 167  * Here's an example of how to use the set-error probes in userland:
 168  * zfs$target:::set-error /arg0 == EBUSY/ {stack();}
 169  *
 170  * Here's an example of how to use DTRACE_PROBE probes in userland:
 171  * If there is a probe declared as follows:
 172  * DTRACE_PROBE2(zfs__probe_name, uint64_t, blkid, dnode_t *, dn);
 173  * Then you can use it as follows:
 174  * zfs$target:::probe2 /copyinstr(arg0) == "zfs__probe_name"/
 175  *     {printf("%u %p\n", arg1, arg2);}
 176  */
 177
 178 #ifdef DTRACE_PROBE
 179 #undef  DTRACE_PROBE
 180 #endif  /* DTRACE_PROBE */
 181 #define DTRACE_PROBE(a) \
 182         ZFS_PROBE0(#a)
 183
 184 #ifdef DTRACE_PROBE1
 185 #undef  DTRACE_PROBE1
 186 #endif  /* DTRACE_PROBE1 */
 187 #define DTRACE_PROBE1(a, b, c) \
 188         ZFS_PROBE1(#a, (unsigned long)c)
 189
 190 #ifdef DTRACE_PROBE2
 191 #undef  DTRACE_PROBE2
 192 #endif  /* DTRACE_PROBE2 */
 193 #define DTRACE_PROBE2(a, b, c, d, e) \
 194         ZFS_PROBE2(#a, (unsigned long)c, (unsigned long)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         ZFS_PROBE3(#a, (unsigned long)c, (unsigned long)e, (unsigned long)g)
 201
 202 #ifdef DTRACE_PROBE4
 203 #undef  DTRACE_PROBE4
 204 #endif  /* DTRACE_PROBE4 */
 205 #define DTRACE_PROBE4(a, b, c, d, e, f, g, h, i) \
 206         ZFS_PROBE4(#a, (unsigned long)c, (unsigned long)e, (unsigned long)g, \
 207         (unsigned long)i)
 208
 209 /*
 210  * We use the comma operator so that this macro can be used without much
 211  * additional code.  For example, "return (EINVAL);" becomes
 212  * "return (SET_ERROR(EINVAL));".  Note that the argument will be evaluated
 213  * twice, so it should not have side effects (e.g. something like:
 214  * "return (SET_ERROR(log_error(EINVAL, info)));" would log the error twice).
 215  */
 216 #define SET_ERROR(err) (ZFS_SET_ERROR(err), err)
 217
 218 /*
 219  * Threads.  TS_STACK_MIN is dictated by the minimum allowed pthread stack
 220  * size.  While TS_STACK_MAX is somewhat arbitrary, it was selected to be
 221  * large enough for the expected stack depth while small enough to avoid
 222  * exhausting address space with high thread counts.
 223  */
 224 #define TS_MAGIC                0x72f158ab4261e538ull
 225 #define TS_RUN                  0x00000002
 226 #define TS_STACK_MIN            MAX(PTHREAD_STACK_MIN, 32768)
 227 #define TS_STACK_MAX            (256 * 1024)
 228
 229 /* in libzpool, p0 exists only to have its address taken */
 230 typedef struct proc {
 231         uintptr_t       this_is_never_used_dont_dereference_it;
 232 } proc_t;
 233
 234 extern struct proc p0;
 235 #define curproc         (&p0)
 236
 237 typedef void (*thread_func_t)(void *);
 238 typedef void (*thread_func_arg_t)(void *);
 239 typedef pthread_t kt_did_t;
 240
 241 #define kpreempt(x)     ((void)0)
 242
 243 typedef struct kthread {
 244         kt_did_t        t_tid;
 245         thread_func_t   t_func;
 246         void *          t_arg;
 247         pri_t           t_pri;
 248 } kthread_t;
 249
 250 #define curthread                       zk_thread_current()
 251 #define getcomm()                       "unknown"
 252 #define thread_exit                     zk_thread_exit
 253 #define thread_create(stk, stksize, func, arg, len, pp, state, pri)     \
 254         zk_thread_create(stk, stksize, (thread_func_t)func, arg,        \
 255             len, NULL, state, pri, PTHREAD_CREATE_DETACHED)
 256 #define thread_join(t)                  zk_thread_join(t)
 257 #define newproc(f, a, cid, pri, ctp, pid)       (ENOSYS)
 258
 259 extern kthread_t *zk_thread_current(void);
 260 extern void zk_thread_exit(void);
 261 extern kthread_t *zk_thread_create(caddr_t stk, size_t  stksize,
 262         thread_func_t func, void *arg, size_t len,
 263         proc_t *pp, int state, pri_t pri, int detachstate);
 264 extern void zk_thread_join(kt_did_t tid);
 265
 266 #define kpreempt_disable()      ((void)0)
 267 #define kpreempt_enable()       ((void)0)
 268
 269 #define PS_NONE         -1
 270
 271 #define issig(why)      (FALSE)
 272 #define ISSIG(thr, why) (FALSE)
 273
 274 /*
 275  * Mutexes
 276  */
 277 #define MTX_MAGIC       0x9522f51362a6e326ull
 278 #define MTX_INIT        ((void *)NULL)
 279 #define MTX_DEST        ((void *)-1UL)
 280
 281 typedef struct kmutex {
 282         void            *m_owner;
 283         uint64_t        m_magic;
 284         pthread_mutex_t m_lock;
 285 } kmutex_t;
 286
 287 #define MUTEX_DEFAULT   0
 288 #define MUTEX_NOLOCKDEP MUTEX_DEFAULT
 289 #define MUTEX_HELD(m)   ((m)->m_owner == curthread)
 290 #define MUTEX_NOT_HELD(m) (!MUTEX_HELD(m))
 291
 292 extern void mutex_init(kmutex_t *mp, char *name, int type, void *cookie);
 293 extern void mutex_destroy(kmutex_t *mp);
 294 extern void mutex_enter(kmutex_t *mp);
 295 extern void mutex_exit(kmutex_t *mp);
 296 extern int mutex_tryenter(kmutex_t *mp);
 297 extern void *mutex_owner(kmutex_t *mp);
 298 extern int mutex_held(kmutex_t *mp);
 299
 300 /*
 301  * RW locks
 302  */
 303 #define RW_MAGIC        0x4d31fb123648e78aull
 304 #define RW_INIT         ((void *)NULL)
 305 #define RW_DEST         ((void *)-1UL)
 306
 307 typedef struct krwlock {
 308         void                    *rw_owner;
 309         void                    *rw_wr_owner;
 310         uint64_t                rw_magic;
 311         pthread_rwlock_t        rw_lock;
 312         uint_t                  rw_readers;
 313 } krwlock_t;
 314
 315 typedef int krw_t;
 316
 317 #define RW_READER       0
 318 #define RW_WRITER       1
 319 #define RW_DEFAULT      RW_READER
 320 #define RW_NOLOCKDEP    RW_READER
 321
 322 #define RW_READ_HELD(x)         ((x)->rw_readers > 0)
 323 #define RW_WRITE_HELD(x)        ((x)->rw_wr_owner == curthread)
 324 #define RW_LOCK_HELD(x)         (RW_READ_HELD(x) || RW_WRITE_HELD(x))
 325
 326 #undef RW_LOCK_HELD
 327 #define RW_LOCK_HELD(x)         (RW_READ_HELD(x) || RW_WRITE_HELD(x))
 328
 329 #undef RW_LOCK_HELD
 330 #define RW_LOCK_HELD(x)         (RW_READ_HELD(x) || RW_WRITE_HELD(x))
 331
 332 extern void rw_init(krwlock_t *rwlp, char *name, int type, void *arg);
 333 extern void rw_destroy(krwlock_t *rwlp);
 334 extern void rw_enter(krwlock_t *rwlp, krw_t rw);
 335 extern int rw_tryenter(krwlock_t *rwlp, krw_t rw);
 336 extern int rw_tryupgrade(krwlock_t *rwlp);
 337 extern void rw_exit(krwlock_t *rwlp);
 338 #define rw_downgrade(rwlp) do { } while (0)
 339
 340 extern uid_t crgetuid(cred_t *cr);
 341 extern uid_t crgetruid(cred_t *cr);
 342 extern gid_t crgetgid(cred_t *cr);
 343 extern int crgetngroups(cred_t *cr);
 344 extern gid_t *crgetgroups(cred_t *cr);
 345
 346 /*
 347  * Condition variables
 348  */
 349 #define CV_MAGIC        0xd31ea9a83b1b30c4ull
 350
 351 typedef struct kcondvar {
 352         uint64_t                cv_magic;
 353         pthread_cond_t          cv;
 354 } kcondvar_t;
 355
 356 #define CV_DEFAULT      0
 357 #define CALLOUT_FLAG_ABSOLUTE   0x2
 358
 359 extern void cv_init(kcondvar_t *cv, char *name, int type, void *arg);
 360 extern void cv_destroy(kcondvar_t *cv);
 361 extern void cv_wait(kcondvar_t *cv, kmutex_t *mp);
 362 extern clock_t cv_timedwait(kcondvar_t *cv, kmutex_t *mp, clock_t abstime);
 363 extern clock_t cv_timedwait_hires(kcondvar_t *cvp, kmutex_t *mp, hrtime_t tim,
 364     hrtime_t res, int flag);
 365 extern void cv_signal(kcondvar_t *cv);
 366 extern void cv_broadcast(kcondvar_t *cv);
 367 #define cv_timedwait_sig(cv, mp, at)            cv_timedwait(cv, mp, at)
 368 #define cv_wait_sig(cv, mp)                     cv_wait(cv, mp)
 369 #define cv_wait_io(cv, mp)                      cv_wait(cv, mp)
 370 #define cv_timedwait_sig_hires(cv, mp, t, r, f) \
 371         cv_timedwait_hires(cv, mp, t, r, f)
 372
 373 /*
 374  * Thread-specific data
 375  */
 376 #define tsd_get(k) pthread_getspecific(k)
 377 #define tsd_set(k, v) pthread_setspecific(k, v)
 378 #define tsd_create(kp, d) pthread_key_create(kp, d)
 379 #define tsd_destroy(kp) /* nothing */
 380
 381 /*
 382  * Thread-specific data
 383  */
 384 #define tsd_get(k) pthread_getspecific(k)
 385 #define tsd_set(k, v) pthread_setspecific(k, v)
 386 #define tsd_create(kp, d) pthread_key_create(kp, d)
 387 #define tsd_destroy(kp) /* nothing */
 388
 389 /*
 390  * kstat creation, installation and deletion
 391  */
 392 extern kstat_t *kstat_create(const char *, int,
 393     const char *, const char *, uchar_t, ulong_t, uchar_t);
 394 extern void kstat_install(kstat_t *);
 395 extern void kstat_delete(kstat_t *);
 396 extern void kstat_waitq_enter(kstat_io_t *);
 397 extern void kstat_waitq_exit(kstat_io_t *);
 398 extern void kstat_runq_enter(kstat_io_t *);
 399 extern void kstat_runq_exit(kstat_io_t *);
 400 extern void kstat_waitq_to_runq(kstat_io_t *);
 401 extern void kstat_runq_back_to_waitq(kstat_io_t *);
 402 extern void kstat_set_raw_ops(kstat_t *ksp,
 403     int (*headers)(char *buf, size_t size),
 404     int (*data)(char *buf, size_t size, void *data),
 405     void *(*addr)(kstat_t *ksp, loff_t index));
 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 KMC_NODEBUG             UMC_NODEBUG
 414 #define KMC_KMEM                0x0
 415 #define KMC_VMEM                0x0
 416 #define kmem_alloc(_s, _f)      umem_alloc(_s, _f)
 417 #define kmem_zalloc(_s, _f)     umem_zalloc(_s, _f)
 418 #define kmem_free(_b, _s)       umem_free(_b, _s)
 419 #define vmem_alloc(_s, _f)      kmem_alloc(_s, _f)
 420 #define vmem_zalloc(_s, _f)     kmem_zalloc(_s, _f)
 421 #define vmem_free(_b, _s)       kmem_free(_b, _s)
 422 #define kmem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i) \
 423         umem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i)
 424 #define kmem_cache_destroy(_c)  umem_cache_destroy(_c)
 425 #define kmem_cache_alloc(_c, _f) umem_cache_alloc(_c, _f)
 426 #define kmem_cache_free(_c, _b) umem_cache_free(_c, _b)
 427 #define kmem_debugging()        0
 428 #define kmem_cache_reap_now(_c) umem_cache_reap_now(_c);
 429 #define kmem_cache_set_move(_c, _cb)    /* nothing */
 430 #define vmem_qcache_reap(_v)            /* nothing */
 431 #define POINTER_INVALIDATE(_pp)         /* nothing */
 432 #define POINTER_IS_VALID(_p)    0
 433
 434 extern vmem_t *zio_arena;
 435
 436 typedef umem_cache_t kmem_cache_t;
 437
 438 typedef enum kmem_cbrc {
 439         KMEM_CBRC_YES,
 440         KMEM_CBRC_NO,
 441         KMEM_CBRC_LATER,
 442         KMEM_CBRC_DONT_NEED,
 443         KMEM_CBRC_DONT_KNOW
 444 } kmem_cbrc_t;
 445
 446 /*
 447  * Task queues
 448  */
 449
 450 #define TASKQ_NAMELEN   31
 451
 452 typedef uintptr_t taskqid_t;
 453 typedef void (task_func_t)(void *);
 454
 455 typedef struct taskq_ent {
 456         struct taskq_ent        *tqent_next;
 457         struct taskq_ent        *tqent_prev;
 458         task_func_t             *tqent_func;
 459         void                    *tqent_arg;
 460         uintptr_t               tqent_flags;
 461 } taskq_ent_t;
 462
 463 typedef struct taskq {
 464         char            tq_name[TASKQ_NAMELEN + 1];
 465         kmutex_t        tq_lock;
 466         krwlock_t       tq_threadlock;
 467         kcondvar_t      tq_dispatch_cv;
 468         kcondvar_t      tq_wait_cv;
 469         kthread_t       **tq_threadlist;
 470         int             tq_flags;
 471         int             tq_active;
 472         int             tq_nthreads;
 473         int             tq_nalloc;
 474         int             tq_minalloc;
 475         int             tq_maxalloc;
 476         kcondvar_t      tq_maxalloc_cv;
 477         int             tq_maxalloc_wait;
 478         taskq_ent_t     *tq_freelist;
 479         taskq_ent_t     tq_task;
 480 } taskq_t;
 481
 482 #define TQENT_FLAG_PREALLOC     0x1     /* taskq_dispatch_ent used */
 483
 484 #define TASKQ_PREPOPULATE       0x0001
 485 #define TASKQ_CPR_SAFE          0x0002  /* Use CPR safe protocol */
 486 #define TASKQ_DYNAMIC           0x0004  /* Use dynamic thread scheduling */
 487 #define TASKQ_THREADS_CPU_PCT   0x0008  /* Scale # threads by # cpus */
 488 #define TASKQ_DC_BATCH          0x0010  /* Mark threads as batch */
 489
 490 #define TQ_SLEEP        KM_SLEEP        /* Can block for memory */
 491 #define TQ_NOSLEEP      KM_NOSLEEP      /* cannot block for memory; may fail */
 492 #define TQ_NOQUEUE      0x02            /* Do not enqueue if can't dispatch */
 493 #define TQ_FRONT        0x08            /* Queue in front */
 494
 495 extern taskq_t *system_taskq;
 496
 497 extern taskq_t  *taskq_create(const char *, int, pri_t, int, int, uint_t);
 498 #define taskq_create_proc(a, b, c, d, e, p, f) \
 499             (taskq_create(a, b, c, d, e, f))
 500 #define taskq_create_sysdc(a, b, d, e, p, dc, f) \
 501             (taskq_create(a, b, maxclsyspri, d, e, f))
 502 extern taskqid_t taskq_dispatch(taskq_t *, task_func_t, void *, uint_t);
 503 extern taskqid_t taskq_dispatch_delay(taskq_t *, task_func_t, void *, uint_t,
 504     clock_t);
 505 extern void     taskq_dispatch_ent(taskq_t *, task_func_t, void *, uint_t,
 506     taskq_ent_t *);
 507 extern int      taskq_empty_ent(taskq_ent_t *);
 508 extern void     taskq_init_ent(taskq_ent_t *);
 509 extern void     taskq_destroy(taskq_t *);
 510 extern void     taskq_wait(taskq_t *);
 511 extern void     taskq_wait_id(taskq_t *, taskqid_t);
 512 extern void     taskq_wait_outstanding(taskq_t *, taskqid_t);
 513 extern int      taskq_member(taskq_t *, kthread_t *);
 514 extern int      taskq_cancel_id(taskq_t *, taskqid_t);
 515 extern void     system_taskq_init(void);
 516 extern void     system_taskq_fini(void);
 517
 518 #define XVA_MAPSIZE     3
 519 #define XVA_MAGIC       0x78766174
 520
 521 /*
 522  * vnodes
 523  */
 524 typedef struct vnode {
 525         uint64_t        v_size;
 526         int             v_fd;
 527         char            *v_path;
 528         int             v_dump_fd;
 529 } vnode_t;
 530
 531 extern char *vn_dumpdir;
 532 #define AV_SCANSTAMP_SZ 32              /* length of anti-virus scanstamp */
 533
 534 typedef struct xoptattr {
 535         timestruc_t     xoa_createtime; /* Create time of file */
 536         uint8_t         xoa_archive;
 537         uint8_t         xoa_system;
 538         uint8_t         xoa_readonly;
 539         uint8_t         xoa_hidden;
 540         uint8_t         xoa_nounlink;
 541         uint8_t         xoa_immutable;
 542         uint8_t         xoa_appendonly;
 543         uint8_t         xoa_nodump;
 544         uint8_t         xoa_settable;
 545         uint8_t         xoa_opaque;
 546         uint8_t         xoa_av_quarantined;
 547         uint8_t         xoa_av_modified;
 548         uint8_t         xoa_av_scanstamp[AV_SCANSTAMP_SZ];
 549         uint8_t         xoa_reparse;
 550         uint8_t         xoa_offline;
 551         uint8_t         xoa_sparse;
 552 } xoptattr_t;
 553
 554 typedef struct vattr {
 555         uint_t          va_mask;        /* bit-mask of attributes */
 556         u_offset_t      va_size;        /* file size in bytes */
 557 } vattr_t;
 558
 559
 560 typedef struct xvattr {
 561         vattr_t         xva_vattr;      /* Embedded vattr structure */
 562         uint32_t        xva_magic;      /* Magic Number */
 563         uint32_t        xva_mapsize;    /* Size of attr bitmap (32-bit words) */
 564         uint32_t        *xva_rtnattrmapp;       /* Ptr to xva_rtnattrmap[] */
 565         uint32_t        xva_reqattrmap[XVA_MAPSIZE];    /* Requested attrs */
 566         uint32_t        xva_rtnattrmap[XVA_MAPSIZE];    /* Returned attrs */
 567         xoptattr_t      xva_xoptattrs;  /* Optional attributes */
 568 } xvattr_t;
 569
 570 typedef struct vsecattr {
 571         uint_t          vsa_mask;       /* See below */
 572         int             vsa_aclcnt;     /* ACL entry count */
 573         void            *vsa_aclentp;   /* pointer to ACL entries */
 574         int             vsa_dfaclcnt;   /* default ACL entry count */
 575         void            *vsa_dfaclentp; /* pointer to default ACL entries */
 576         size_t          vsa_aclentsz;   /* ACE size in bytes of vsa_aclentp */
 577 } vsecattr_t;
 578
 579 #define AT_TYPE         0x00001
 580 #define AT_MODE         0x00002
 581 #define AT_UID          0x00004
 582 #define AT_GID          0x00008
 583 #define AT_FSID         0x00010
 584 #define AT_NODEID       0x00020
 585 #define AT_NLINK        0x00040
 586 #define AT_SIZE         0x00080
 587 #define AT_ATIME        0x00100
 588 #define AT_MTIME        0x00200
 589 #define AT_CTIME        0x00400
 590 #define AT_RDEV         0x00800
 591 #define AT_BLKSIZE      0x01000
 592 #define AT_NBLOCKS      0x02000
 593 #define AT_SEQ          0x08000
 594 #define AT_XVATTR       0x10000
 595
 596 #define CRCREAT         0
 597
 598 extern int fop_getattr(vnode_t *vp, vattr_t *vap);
 599
 600 #define VOP_CLOSE(vp, f, c, o, cr, ct)  vn_close(vp)
 601 #define VOP_PUTPAGE(vp, of, sz, fl, cr, ct)     0
 602 #define VOP_GETATTR(vp, vap, fl, cr, ct)  fop_getattr((vp), (vap));
 603
 604 #define VOP_FSYNC(vp, f, cr, ct)        fsync((vp)->v_fd)
 605
 606 #define VN_RELE(vp)     vn_close(vp)
 607
 608 extern int vn_open(char *path, int x1, int oflags, int mode, vnode_t **vpp,
 609     int x2, int x3);
 610 extern int vn_openat(char *path, int x1, int oflags, int mode, vnode_t **vpp,
 611     int x2, int x3, vnode_t *vp, int fd);
 612 extern int vn_rdwr(int uio, vnode_t *vp, void *addr, ssize_t len,
 613     offset_t offset, int x1, int x2, rlim64_t x3, void *x4, ssize_t *residp);
 614 extern void vn_close(vnode_t *vp);
 615
 616 #define vn_remove(path, x1, x2)         remove(path)
 617 #define vn_rename(from, to, seg)        rename((from), (to))
 618 #define vn_is_readonly(vp)              B_FALSE
 619
 620 extern vnode_t *rootdir;
 621
 622 #include <sys/file.h>           /* for FREAD, FWRITE, etc */
 623
 624 /*
 625  * Random stuff
 626  */
 627 #define ddi_get_lbolt()         (gethrtime() >> 23)
 628 #define ddi_get_lbolt64()       (gethrtime() >> 23)
 629 #define hz      119     /* frequency when using gethrtime() >> 23 for lbolt */
 630
 631 #define ddi_time_before(a, b)           (a < b)
 632 #define ddi_time_after(a, b)            ddi_time_before(b, a)
 633 #define ddi_time_before_eq(a, b)        (!ddi_time_after(a, b))
 634 #define ddi_time_after_eq(a, b)         ddi_time_before_eq(b, a)
 635
 636 #define ddi_time_before64(a, b)         (a < b)
 637 #define ddi_time_after64(a, b)          ddi_time_before64(b, a)
 638 #define ddi_time_before_eq64(a, b)      (!ddi_time_after64(a, b))
 639 #define ddi_time_after_eq64(a, b)       ddi_time_before_eq64(b, a)
 640
 641 extern void delay(clock_t ticks);
 642
 643 #define SEC_TO_TICK(sec)        ((sec) * hz)
 644 #define MSEC_TO_TICK(msec)      ((msec) / (MILLISEC / hz))
 645 #define USEC_TO_TICK(usec)      ((usec) / (MICROSEC / hz))
 646 #define NSEC_TO_TICK(usec)      ((usec) / (NANOSEC / hz))
 647
 648 #define gethrestime_sec() time(NULL)
 649 #define gethrestime(t) \
 650         do {\
 651                 (t)->tv_sec = gethrestime_sec();\
 652                 (t)->tv_nsec = 0;\
 653         } while (0);
 654
 655 #define max_ncpus       64
 656 #define boot_ncpus      (sysconf(_SC_NPROCESSORS_ONLN))
 657
 658 /*
 659  * Process priorities as defined by setpriority(2) and getpriority(2).
 660  */
 661 #define minclsyspri     19
 662 #define maxclsyspri     -20
 663 #define defclsyspri     0
 664
 665 #define CPU_SEQID       ((uintptr_t)pthread_self() & (max_ncpus - 1))
 666
 667 #define kcred           NULL
 668 #define CRED()          NULL
 669
 670 #define ptob(x)         ((x) * PAGESIZE)
 671
 672 extern uint64_t physmem;
 673
 674 extern int highbit64(uint64_t i);
 675 extern int lowbit64(uint64_t i);
 676 extern int highbit(ulong_t i);
 677 extern int lowbit(ulong_t i);
 678 extern int random_get_bytes(uint8_t *ptr, size_t len);
 679 extern int random_get_pseudo_bytes(uint8_t *ptr, size_t len);
 680
 681 extern void kernel_init(int);
 682 extern void kernel_fini(void);
 683 extern void thread_init(void);
 684 extern void thread_fini(void);
 685 extern void random_init(void);
 686 extern void random_fini(void);
 687
 688 struct spa;
 689 extern void nicenum(uint64_t num, char *buf);
 690 extern void show_pool_stats(struct spa *);
 691
 692 typedef struct callb_cpr {
 693         kmutex_t        *cc_lockp;
 694 } callb_cpr_t;
 695
 696 #define CALLB_CPR_INIT(cp, lockp, func, name)   {               \
 697         (cp)->cc_lockp = lockp;                                 \
 698 }
 699
 700 #define CALLB_CPR_SAFE_BEGIN(cp) {                              \
 701         ASSERT(MUTEX_HELD((cp)->cc_lockp));                     \
 702 }
 703
 704 #define CALLB_CPR_SAFE_END(cp, lockp) {                         \
 705         ASSERT(MUTEX_HELD((cp)->cc_lockp));                     \
 706 }
 707
 708 #define CALLB_CPR_EXIT(cp) {                                    \
 709         ASSERT(MUTEX_HELD((cp)->cc_lockp));                     \
 710         mutex_exit((cp)->cc_lockp);                             \
 711 }
 712
 713 #define zone_dataset_visible(x, y)      (1)
 714 #define INGLOBALZONE(z)                 (1)
 715
 716 extern char *kmem_vasprintf(const char *fmt, va_list adx);
 717 extern char *kmem_asprintf(const char *fmt, ...);
 718 #define strfree(str) kmem_free((str), strlen(str) + 1)
 719
 720 /*
 721  * Hostname information
 722  */
 723 extern char hw_serial[];        /* for userland-emulated hostid access */
 724 extern int ddi_strtoul(const char *str, char **nptr, int base,
 725     unsigned long *result);
 726
 727 extern int ddi_strtoull(const char *str, char **nptr, int base,
 728     u_longlong_t *result);
 729
 730 typedef struct utsname  utsname_t;
 731 extern utsname_t *utsname(void);
 732
 733 /* ZFS Boot Related stuff. */
 734
 735 struct _buf {
 736         intptr_t        _fd;
 737 };
 738
 739 struct bootstat {
 740         uint64_t st_size;
 741 };
 742
 743 typedef struct ace_object {
 744         uid_t           a_who;
 745         uint32_t        a_access_mask;
 746         uint16_t        a_flags;
 747         uint16_t        a_type;
 748         uint8_t         a_obj_type[16];
 749         uint8_t         a_inherit_obj_type[16];
 750 } ace_object_t;
 751
 752
 753 #define ACE_ACCESS_ALLOWED_OBJECT_ACE_TYPE      0x05
 754 #define ACE_ACCESS_DENIED_OBJECT_ACE_TYPE       0x06
 755 #define ACE_SYSTEM_AUDIT_OBJECT_ACE_TYPE        0x07
 756 #define ACE_SYSTEM_ALARM_OBJECT_ACE_TYPE        0x08
 757
 758 extern struct _buf *kobj_open_file(char *name);
 759 extern int kobj_read_file(struct _buf *file, char *buf, unsigned size,
 760     unsigned off);
 761 extern void kobj_close_file(struct _buf *file);
 762 extern int kobj_get_filesize(struct _buf *file, uint64_t *size);
 763 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
 764 extern int zfs_secpolicy_rename_perms(const char *from, const char *to,
 765     cred_t *cr);
 766 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
 767 extern int secpolicy_zfs(const cred_t *cr);
 768 extern zoneid_t getzoneid(void);
 769
 770 /* SID stuff */
 771 typedef struct ksiddomain {
 772         uint_t  kd_ref;
 773         uint_t  kd_len;
 774         char    *kd_name;
 775 } ksiddomain_t;
 776
 777 ksiddomain_t *ksid_lookupdomain(const char *);
 778 void ksiddomain_rele(ksiddomain_t *);
 779
 780 #define DDI_SLEEP       KM_SLEEP
 781 #define ddi_log_sysevent(_a, _b, _c, _d, _e, _f, _g) \
 782         sysevent_post_event(_c, _d, _b, "libzpool", _e, _f)
 783
 784 #define zfs_sleep_until(wakeup)                                         \
 785         do {                                                            \
 786                 hrtime_t delta = wakeup - gethrtime();                  \
 787                 struct timespec ts;                                     \
 788                 ts.tv_sec = delta / NANOSEC;                            \
 789                 ts.tv_nsec = delta % NANOSEC;                           \
 790                 (void) nanosleep(&ts, NULL);                            \
 791         } while (0)
 792
 793 typedef int fstrans_cookie_t;
 794
 795 extern fstrans_cookie_t spl_fstrans_mark(void);
 796 extern void spl_fstrans_unmark(fstrans_cookie_t);
 797 extern int spl_fstrans_check(void);
 798
 799 #endif /* _KERNEL */
 800 #endif  /* _SYS_ZFS_CONTEXT_H */