xref: /titanic_51/usr/src/lib/libzpool/common/sys/zfs_context.h (revision b72c368a02e0464faeef362bc5a1cf0fc69981da)
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 #define	thread_join(t)	panic("libzpool cannot join threads")
201 
202 #define	newproc(f, a, cid, pri, ctp, pid)	(ENOSYS)
203 
204 /* in libzpool, p0 exists only to have its address taken */
205 struct proc {
206 	uintptr_t	this_is_never_used_dont_dereference_it;
207 };
208 
209 extern struct proc p0;
210 
211 #define	PS_NONE		-1
212 
213 extern kthread_t *zk_thread_create(void (*func)(), void *arg);
214 
215 #define	issig(why)	(FALSE)
216 #define	ISSIG(thr, why)	(FALSE)
217 
218 /*
219  * Mutexes
220  */
221 typedef struct kmutex {
222 	void		*m_owner;
223 	boolean_t	initialized;
224 	mutex_t		m_lock;
225 } kmutex_t;
226 
227 #define	MUTEX_DEFAULT	USYNC_THREAD
228 #undef MUTEX_HELD
229 #define	MUTEX_HELD(m) _mutex_held(&(m)->m_lock)
230 
231 /*
232  * Argh -- we have to get cheesy here because the kernel and userland
233  * have different signatures for the same routine.
234  */
235 extern int _mutex_init(mutex_t *mp, int type, void *arg);
236 extern int _mutex_destroy(mutex_t *mp);
237 
238 #define	mutex_init(mp, b, c, d)		zmutex_init((kmutex_t *)(mp))
239 #define	mutex_destroy(mp)		zmutex_destroy((kmutex_t *)(mp))
240 
241 extern void zmutex_init(kmutex_t *mp);
242 extern void zmutex_destroy(kmutex_t *mp);
243 extern void mutex_enter(kmutex_t *mp);
244 extern void mutex_exit(kmutex_t *mp);
245 extern int mutex_tryenter(kmutex_t *mp);
246 extern void *mutex_owner(kmutex_t *mp);
247 
248 /*
249  * RW locks
250  */
251 typedef struct krwlock {
252 	void		*rw_owner;
253 	boolean_t	initialized;
254 	rwlock_t	rw_lock;
255 } krwlock_t;
256 
257 typedef int krw_t;
258 
259 #define	RW_READER	0
260 #define	RW_WRITER	1
261 #define	RW_DEFAULT	USYNC_THREAD
262 
263 #undef RW_READ_HELD
264 #define	RW_READ_HELD(x)		_rw_read_held(&(x)->rw_lock)
265 
266 #undef RW_WRITE_HELD
267 #define	RW_WRITE_HELD(x)	_rw_write_held(&(x)->rw_lock)
268 
269 extern void rw_init(krwlock_t *rwlp, char *name, int type, void *arg);
270 extern void rw_destroy(krwlock_t *rwlp);
271 extern void rw_enter(krwlock_t *rwlp, krw_t rw);
272 extern int rw_tryenter(krwlock_t *rwlp, krw_t rw);
273 extern int rw_tryupgrade(krwlock_t *rwlp);
274 extern void rw_exit(krwlock_t *rwlp);
275 #define	rw_downgrade(rwlp) do { } while (0)
276 
277 extern uid_t crgetuid(cred_t *cr);
278 extern gid_t crgetgid(cred_t *cr);
279 extern int crgetngroups(cred_t *cr);
280 extern gid_t *crgetgroups(cred_t *cr);
281 
282 /*
283  * Condition variables
284  */
285 typedef cond_t kcondvar_t;
286 
287 #define	CV_DEFAULT	USYNC_THREAD
288 
289 extern void cv_init(kcondvar_t *cv, char *name, int type, void *arg);
290 extern void cv_destroy(kcondvar_t *cv);
291 extern void cv_wait(kcondvar_t *cv, kmutex_t *mp);
292 extern clock_t cv_timedwait(kcondvar_t *cv, kmutex_t *mp, clock_t abstime);
293 extern void cv_signal(kcondvar_t *cv);
294 extern void cv_broadcast(kcondvar_t *cv);
295 
296 /*
297  * kstat creation, installation and deletion
298  */
299 extern kstat_t *kstat_create(char *, int,
300     char *, char *, uchar_t, ulong_t, uchar_t);
301 extern void kstat_install(kstat_t *);
302 extern void kstat_delete(kstat_t *);
303 
304 /*
305  * Kernel memory
306  */
307 #define	KM_SLEEP		UMEM_NOFAIL
308 #define	KM_PUSHPAGE		KM_SLEEP
309 #define	KM_NOSLEEP		UMEM_DEFAULT
310 #define	KMC_NODEBUG		UMC_NODEBUG
311 #define	kmem_alloc(_s, _f)	umem_alloc(_s, _f)
312 #define	kmem_zalloc(_s, _f)	umem_zalloc(_s, _f)
313 #define	kmem_free(_b, _s)	umem_free(_b, _s)
314 #define	kmem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i) \
315 	umem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i)
316 #define	kmem_cache_destroy(_c)	umem_cache_destroy(_c)
317 #define	kmem_cache_alloc(_c, _f) umem_cache_alloc(_c, _f)
318 #define	kmem_cache_free(_c, _b)	umem_cache_free(_c, _b)
319 #define	kmem_debugging()	0
320 #define	kmem_cache_reap_now(c)
321 
322 typedef umem_cache_t kmem_cache_t;
323 
324 /*
325  * Task queues
326  */
327 typedef struct taskq taskq_t;
328 typedef uintptr_t taskqid_t;
329 typedef void (task_func_t)(void *);
330 
331 #define	TASKQ_PREPOPULATE	0x0001
332 #define	TASKQ_CPR_SAFE		0x0002	/* Use CPR safe protocol */
333 #define	TASKQ_DYNAMIC		0x0004	/* Use dynamic thread scheduling */
334 #define	TASKQ_THREADS_CPU_PCT	0x0008	/* Scale # threads by # cpus */
335 #define	TASKQ_DC_BATCH		0x0010	/* Mark threads as batch */
336 
337 #define	TQ_SLEEP	KM_SLEEP	/* Can block for memory */
338 #define	TQ_NOSLEEP	KM_NOSLEEP	/* cannot block for memory; may fail */
339 #define	TQ_NOQUEUE	0x02		/* Do not enqueue if can't dispatch */
340 #define	TQ_FRONT	0x08		/* Queue in front */
341 
342 extern taskq_t *system_taskq;
343 
344 extern taskq_t	*taskq_create(const char *, int, pri_t, int, int, uint_t);
345 #define	taskq_create_proc(a, b, c, d, e, p, f) \
346 	    (taskq_create(a, b, c, d, e, f))
347 #define	taskq_create_sysdc(a, b, d, e, p, dc, f) \
348 	    (taskq_create(a, b, maxclsyspri, d, e, f))
349 extern taskqid_t taskq_dispatch(taskq_t *, task_func_t, void *, uint_t);
350 extern void	taskq_destroy(taskq_t *);
351 extern void	taskq_wait(taskq_t *);
352 extern int	taskq_member(taskq_t *, void *);
353 extern void	system_taskq_init(void);
354 extern void	system_taskq_fini(void);
355 
356 #define	XVA_MAPSIZE	3
357 #define	XVA_MAGIC	0x78766174
358 
359 /*
360  * vnodes
361  */
362 typedef struct vnode {
363 	uint64_t	v_size;
364 	int		v_fd;
365 	char		*v_path;
366 } vnode_t;
367 
368 #define	AV_SCANSTAMP_SZ	32		/* length of anti-virus scanstamp */
369 
370 typedef struct xoptattr {
371 	timestruc_t	xoa_createtime;	/* Create time of file */
372 	uint8_t		xoa_archive;
373 	uint8_t		xoa_system;
374 	uint8_t		xoa_readonly;
375 	uint8_t		xoa_hidden;
376 	uint8_t		xoa_nounlink;
377 	uint8_t		xoa_immutable;
378 	uint8_t		xoa_appendonly;
379 	uint8_t		xoa_nodump;
380 	uint8_t		xoa_settable;
381 	uint8_t		xoa_opaque;
382 	uint8_t		xoa_av_quarantined;
383 	uint8_t		xoa_av_modified;
384 	uint8_t		xoa_av_scanstamp[AV_SCANSTAMP_SZ];
385 	uint8_t		xoa_reparse;
386 } xoptattr_t;
387 
388 typedef struct vattr {
389 	uint_t		va_mask;	/* bit-mask of attributes */
390 	u_offset_t	va_size;	/* file size in bytes */
391 } vattr_t;
392 
393 
394 typedef struct xvattr {
395 	vattr_t		xva_vattr;	/* Embedded vattr structure */
396 	uint32_t	xva_magic;	/* Magic Number */
397 	uint32_t	xva_mapsize;	/* Size of attr bitmap (32-bit words) */
398 	uint32_t	*xva_rtnattrmapp;	/* Ptr to xva_rtnattrmap[] */
399 	uint32_t	xva_reqattrmap[XVA_MAPSIZE];	/* Requested attrs */
400 	uint32_t	xva_rtnattrmap[XVA_MAPSIZE];	/* Returned attrs */
401 	xoptattr_t	xva_xoptattrs;	/* Optional attributes */
402 } xvattr_t;
403 
404 typedef struct vsecattr {
405 	uint_t		vsa_mask;	/* See below */
406 	int		vsa_aclcnt;	/* ACL entry count */
407 	void		*vsa_aclentp;	/* pointer to ACL entries */
408 	int		vsa_dfaclcnt;	/* default ACL entry count */
409 	void		*vsa_dfaclentp;	/* pointer to default ACL entries */
410 	size_t		vsa_aclentsz;	/* ACE size in bytes of vsa_aclentp */
411 } vsecattr_t;
412 
413 #define	AT_TYPE		0x00001
414 #define	AT_MODE		0x00002
415 #define	AT_UID		0x00004
416 #define	AT_GID		0x00008
417 #define	AT_FSID		0x00010
418 #define	AT_NODEID	0x00020
419 #define	AT_NLINK	0x00040
420 #define	AT_SIZE		0x00080
421 #define	AT_ATIME	0x00100
422 #define	AT_MTIME	0x00200
423 #define	AT_CTIME	0x00400
424 #define	AT_RDEV		0x00800
425 #define	AT_BLKSIZE	0x01000
426 #define	AT_NBLOCKS	0x02000
427 #define	AT_SEQ		0x08000
428 #define	AT_XVATTR	0x10000
429 
430 #define	CRCREAT		0
431 
432 extern int fop_getattr(vnode_t *vp, vattr_t *vap);
433 
434 #define	VOP_CLOSE(vp, f, c, o, cr, ct)	0
435 #define	VOP_PUTPAGE(vp, of, sz, fl, cr, ct)	0
436 #define	VOP_GETATTR(vp, vap, fl, cr, ct)  fop_getattr((vp), (vap));
437 
438 #define	VOP_FSYNC(vp, f, cr, ct)	fsync((vp)->v_fd)
439 
440 #define	VN_RELE(vp)	vn_close(vp)
441 
442 extern int vn_open(char *path, int x1, int oflags, int mode, vnode_t **vpp,
443     int x2, int x3);
444 extern int vn_openat(char *path, int x1, int oflags, int mode, vnode_t **vpp,
445     int x2, int x3, vnode_t *vp, int fd);
446 extern int vn_rdwr(int uio, vnode_t *vp, void *addr, ssize_t len,
447     offset_t offset, int x1, int x2, rlim64_t x3, void *x4, ssize_t *residp);
448 extern void vn_close(vnode_t *vp);
449 
450 #define	vn_remove(path, x1, x2)		remove(path)
451 #define	vn_rename(from, to, seg)	rename((from), (to))
452 #define	vn_is_readonly(vp)		B_FALSE
453 
454 extern vnode_t *rootdir;
455 
456 #include <sys/file.h>		/* for FREAD, FWRITE, etc */
457 
458 /*
459  * Random stuff
460  */
461 #define	ddi_get_lbolt()		(gethrtime() >> 23)
462 #define	ddi_get_lbolt64()	(gethrtime() >> 23)
463 #define	hz	119	/* frequency when using gethrtime() >> 23 for lbolt */
464 
465 extern void delay(clock_t ticks);
466 
467 #define	gethrestime_sec() time(NULL)
468 #define	gethrestime(t) \
469 	do {\
470 		(t)->tv_sec = gethrestime_sec();\
471 		(t)->tv_nsec = 0;\
472 	} while (0);
473 
474 #define	max_ncpus	64
475 
476 #define	minclsyspri	60
477 #define	maxclsyspri	99
478 
479 #define	CPU_SEQID	(thr_self() & (max_ncpus - 1))
480 
481 #define	kcred		NULL
482 #define	CRED()		NULL
483 
484 #define	ptob(x)		((x) * PAGESIZE)
485 
486 extern uint64_t physmem;
487 
488 extern int highbit(ulong_t i);
489 extern int random_get_bytes(uint8_t *ptr, size_t len);
490 extern int random_get_pseudo_bytes(uint8_t *ptr, size_t len);
491 
492 extern void kernel_init(int);
493 extern void kernel_fini(void);
494 
495 struct spa;
496 extern void nicenum(uint64_t num, char *buf);
497 extern void show_pool_stats(struct spa *);
498 
499 typedef struct callb_cpr {
500 	kmutex_t	*cc_lockp;
501 } callb_cpr_t;
502 
503 #define	CALLB_CPR_INIT(cp, lockp, func, name)	{		\
504 	(cp)->cc_lockp = lockp;					\
505 }
506 
507 #define	CALLB_CPR_SAFE_BEGIN(cp) {				\
508 	ASSERT(MUTEX_HELD((cp)->cc_lockp));			\
509 }
510 
511 #define	CALLB_CPR_SAFE_END(cp, lockp) {				\
512 	ASSERT(MUTEX_HELD((cp)->cc_lockp));			\
513 }
514 
515 #define	CALLB_CPR_EXIT(cp) {					\
516 	ASSERT(MUTEX_HELD((cp)->cc_lockp));			\
517 	mutex_exit((cp)->cc_lockp);				\
518 }
519 
520 #define	zone_dataset_visible(x, y)	(1)
521 #define	INGLOBALZONE(z)			(1)
522 
523 extern char *kmem_asprintf(const char *fmt, ...);
524 #define	strfree(str) kmem_free((str), strlen(str)+1)
525 
526 /*
527  * Hostname information
528  */
529 extern char hw_serial[];	/* for userland-emulated hostid access */
530 extern int ddi_strtoul(const char *str, char **nptr, int base,
531     unsigned long *result);
532 
533 /* ZFS Boot Related stuff. */
534 
535 struct _buf {
536 	intptr_t	_fd;
537 };
538 
539 struct bootstat {
540 	uint64_t st_size;
541 };
542 
543 typedef struct ace_object {
544 	uid_t		a_who;
545 	uint32_t	a_access_mask;
546 	uint16_t	a_flags;
547 	uint16_t	a_type;
548 	uint8_t		a_obj_type[16];
549 	uint8_t		a_inherit_obj_type[16];
550 } ace_object_t;
551 
552 
553 #define	ACE_ACCESS_ALLOWED_OBJECT_ACE_TYPE	0x05
554 #define	ACE_ACCESS_DENIED_OBJECT_ACE_TYPE	0x06
555 #define	ACE_SYSTEM_AUDIT_OBJECT_ACE_TYPE	0x07
556 #define	ACE_SYSTEM_ALARM_OBJECT_ACE_TYPE	0x08
557 
558 extern struct _buf *kobj_open_file(char *name);
559 extern int kobj_read_file(struct _buf *file, char *buf, unsigned size,
560     unsigned off);
561 extern void kobj_close_file(struct _buf *file);
562 extern int kobj_get_filesize(struct _buf *file, uint64_t *size);
563 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
564 extern int zfs_secpolicy_rename_perms(const char *from, const char *to,
565     cred_t *cr);
566 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
567 extern zoneid_t getzoneid(void);
568 
569 /* SID stuff */
570 typedef struct ksiddomain {
571 	uint_t	kd_ref;
572 	uint_t	kd_len;
573 	char	*kd_name;
574 } ksiddomain_t;
575 
576 ksiddomain_t *ksid_lookupdomain(const char *);
577 void ksiddomain_rele(ksiddomain_t *);
578 
579 #define	DDI_SLEEP	KM_SLEEP
580 #define	ddi_log_sysevent(_a, _b, _c, _d, _e, _f, _g) \
581 	sysevent_post_event(_c, _d, _b, "libzpool", _e, _f)
582 
583 #ifdef	__cplusplus
584 }
585 #endif
586 
587 #endif	/* _SYS_ZFS_CONTEXT_H */
588