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