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