[mirror_zfs.git] / lib / libzpool / include / sys / zfs_context.h

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
 */

#ifndef _SYS_ZFS_CONTEXT_H
#define	_SYS_ZFS_CONTEXT_H

#ifdef	__cplusplus
extern "C" {
#endif

#define	_SYS_MUTEX_H
#define	_SYS_RWLOCK_H
#define	_SYS_CONDVAR_H
#define	_SYS_SYSTM_H
#define	_SYS_DEBUG_H
#define	_SYS_T_LOCK_H
#define	_SYS_VNODE_H
#define	_SYS_VFS_H
#define	_SYS_SUNDDI_H
#define	_SYS_CALLB_H

#include <stdio.h>
#include <stdlib.h>
#include <stddef.h>
#include <stdarg.h>
#include <fcntl.h>
#include <unistd.h>
#include <errno.h>
#include <string.h>
#include <strings.h>
#include <synch.h>
#include <thread.h>
#include <assert.h>
#include <alloca.h>
#include <umem.h>
#include <limits.h>
#include <atomic.h>
#include <dirent.h>
#include <time.h>
#include <libsysevent.h>
#include <sys/note.h>
#include <sys/types.h>
#include <sys/cred.h>
#include <sys/sysmacros.h>
#include <sys/bitmap.h>
#include <sys/resource.h>
#include <sys/byteorder.h>
#include <sys/list.h>
#include <sys/uio.h>
#include <sys/zfs_debug.h>
#include <sys/sdt.h>
#include <sys/kstat.h>
#include <sys/u8_textprep.h>
#include <sys/sysevent/eventdefs.h>
#include <sys/sysevent/dev.h>
#include <sys/sunddi.h>

/*
 * Debugging
 */

/*
 * Note that we are not using the debugging levels.
 */

#define	CE_CONT		0	/* continuation		*/
#define	CE_NOTE		1	/* notice		*/
#define	CE_WARN		2	/* warning		*/
#define	CE_PANIC	3	/* panic		*/
#define	CE_IGNORE	4	/* print nothing	*/

/*
 * ZFS debugging
 */

#ifdef ZFS_DEBUG
extern void dprintf_setup(int *argc, char **argv);
#endif /* ZFS_DEBUG */

extern void cmn_err(int, const char *, ...);
extern void vcmn_err(int, const char *, __va_list);
extern void panic(const char *, ...);
extern void vpanic(const char *, __va_list);

#define	fm_panic	panic

extern int aok;

/* This definition is copied from assert.h. */
#if defined(__STDC__)
#if __STDC_VERSION__ - 0 >= 199901L
#define	zverify(EX) (void)((EX) || (aok) || \
	(__assert_c99(#EX, __FILE__, __LINE__, __func__), 0))
#else
#define	zverify(EX) (void)((EX) || (aok) || \
	(__assert(#EX, __FILE__, __LINE__), 0))
#endif /* __STDC_VERSION__ - 0 >= 199901L */
#else
#define	zverify(EX) (void)((EX) || (aok) || \
	(_assert("EX", __FILE__, __LINE__), 0))
#endif	/* __STDC__ */


#define	VERIFY	zverify
#define	ASSERT	zverify
#undef	assert
#define	assert	zverify

extern void __assert(const char *, const char *, int);

#ifdef lint
#define	VERIFY3_IMPL(x, y, z, t)	if (x == z) ((void)0)
#else
/* BEGIN CSTYLED */
#define	VERIFY3_IMPL(LEFT, OP, RIGHT, TYPE) do { \
	const TYPE __left = (TYPE)(LEFT); \
	const TYPE __right = (TYPE)(RIGHT); \
	if (!(__left OP __right) && (!aok)) { \
		char *__buf = alloca(256); \
		(void) snprintf(__buf, 256, "%s %s %s (0x%llx %s 0x%llx)", \
			#LEFT, #OP, #RIGHT, \
			(u_longlong_t)__left, #OP, (u_longlong_t)__right); \
		__assert(__buf, __FILE__, __LINE__); \
	} \
_NOTE(CONSTCOND) } while (0)
/* END CSTYLED */
#endif /* lint */

#define	VERIFY3S(x, y, z)	VERIFY3_IMPL(x, y, z, int64_t)
#define	VERIFY3U(x, y, z)	VERIFY3_IMPL(x, y, z, uint64_t)
#define	VERIFY3P(x, y, z)	VERIFY3_IMPL(x, y, z, uintptr_t)

#ifdef NDEBUG
#define	ASSERT3S(x, y, z)	((void)0)
#define	ASSERT3U(x, y, z)	((void)0)
#define	ASSERT3P(x, y, z)	((void)0)
#else
#define	ASSERT3S(x, y, z)	VERIFY3S(x, y, z)
#define	ASSERT3U(x, y, z)	VERIFY3U(x, y, z)
#define	ASSERT3P(x, y, z)	VERIFY3P(x, y, z)
#endif

/*
 * DTrace SDT probes have different signatures in userland than they do in
 * kernel.  If they're being used in kernel code, re-define them out of
 * existence for their counterparts in libzpool.
 */

#ifdef DTRACE_PROBE
#undef	DTRACE_PROBE
#define	DTRACE_PROBE(a)	((void)0)
#endif	/* DTRACE_PROBE */

#ifdef DTRACE_PROBE1
#undef	DTRACE_PROBE1
#define	DTRACE_PROBE1(a, b, c)	((void)0)
#endif	/* DTRACE_PROBE1 */

#ifdef DTRACE_PROBE2
#undef	DTRACE_PROBE2
#define	DTRACE_PROBE2(a, b, c, d, e)	((void)0)
#endif	/* DTRACE_PROBE2 */

#ifdef DTRACE_PROBE3
#undef	DTRACE_PROBE3
#define	DTRACE_PROBE3(a, b, c, d, e, f, g)	((void)0)
#endif	/* DTRACE_PROBE3 */

#ifdef DTRACE_PROBE4
#undef	DTRACE_PROBE4
#define	DTRACE_PROBE4(a, b, c, d, e, f, g, h, i)	((void)0)
#endif	/* DTRACE_PROBE4 */

/*
 * Threads
 */
#define	curthread	((void *)(uintptr_t)thr_self())

typedef struct kthread kthread_t;

#define	thread_create(stk, stksize, func, arg, len, pp, state, pri)	\
	zk_thread_create(func, arg)
#define	thread_exit() thr_exit(NULL)
#define	thread_join(t)	panic("libzpool cannot join threads")

#define	newproc(f, a, cid, pri, ctp, pid)	(ENOSYS)

/* in libzpool, p0 exists only to have its address taken */
struct proc {
	uintptr_t	this_is_never_used_dont_dereference_it;
};

extern struct proc p0;

#define	PS_NONE		-1

extern kthread_t *zk_thread_create(void (*func)(), void *arg);

#define	issig(why)	(FALSE)
#define	ISSIG(thr, why)	(FALSE)

/*
 * Mutexes
 */
typedef struct kmutex {
	void		*m_owner;
	boolean_t	initialized;
	mutex_t		m_lock;
} kmutex_t;

#define	MUTEX_DEFAULT	USYNC_THREAD
#undef	MUTEX_HELD
#undef	MUTEX_NOT_HELD
#define	MUTEX_HELD(m) _mutex_held(&(m)->m_lock)
#define	MUTEX_NOT_HELD(m) (!MUTEX_HELD(m))

/*
 * Argh -- we have to get cheesy here because the kernel and userland
 * have different signatures for the same routine.
 */
extern int _mutex_init(mutex_t *mp, int type, void *arg);
extern int _mutex_destroy(mutex_t *mp);

#define	mutex_init(mp, b, c, d)		zmutex_init((kmutex_t *)(mp))
#define	mutex_destroy(mp)		zmutex_destroy((kmutex_t *)(mp))

extern void zmutex_init(kmutex_t *mp);
extern void zmutex_destroy(kmutex_t *mp);
extern void mutex_enter(kmutex_t *mp);
extern void mutex_exit(kmutex_t *mp);
extern int mutex_tryenter(kmutex_t *mp);
extern void *mutex_owner(kmutex_t *mp);

/*
 * RW locks
 */
typedef struct krwlock {
	void		*rw_owner;
	boolean_t	initialized;
	rwlock_t	rw_lock;
} krwlock_t;

typedef int krw_t;

#define	RW_READER	0
#define	RW_WRITER	1
#define	RW_DEFAULT	USYNC_THREAD

#undef RW_READ_HELD
#define	RW_READ_HELD(x)		_rw_read_held(&(x)->rw_lock)

#undef RW_WRITE_HELD
#define	RW_WRITE_HELD(x)	_rw_write_held(&(x)->rw_lock)

extern void rw_init(krwlock_t *rwlp, char *name, int type, void *arg);
extern void rw_destroy(krwlock_t *rwlp);
extern void rw_enter(krwlock_t *rwlp, krw_t rw);
extern int rw_tryenter(krwlock_t *rwlp, krw_t rw);
extern int rw_tryupgrade(krwlock_t *rwlp);
extern void rw_exit(krwlock_t *rwlp);
#define	rw_downgrade(rwlp) do { } while (0)

extern uid_t crgetuid(cred_t *cr);
extern gid_t crgetgid(cred_t *cr);
extern int crgetngroups(cred_t *cr);
extern gid_t *crgetgroups(cred_t *cr);

/*
 * Condition variables
 */
typedef cond_t kcondvar_t;

#define	CV_DEFAULT	USYNC_THREAD

extern void cv_init(kcondvar_t *cv, char *name, int type, void *arg);
extern void cv_destroy(kcondvar_t *cv);
extern void cv_wait(kcondvar_t *cv, kmutex_t *mp);
extern clock_t cv_timedwait(kcondvar_t *cv, kmutex_t *mp, clock_t abstime);
extern void cv_signal(kcondvar_t *cv);
extern void cv_broadcast(kcondvar_t *cv);

/*
 * kstat creation, installation and deletion
 */
extern kstat_t *kstat_create(char *, int,
    char *, char *, uchar_t, ulong_t, uchar_t);
extern void kstat_install(kstat_t *);
extern void kstat_delete(kstat_t *);

/*
 * Kernel memory
 */
#define	KM_SLEEP		UMEM_NOFAIL
#define	KM_PUSHPAGE		KM_SLEEP
#define	KM_NOSLEEP		UMEM_DEFAULT
#define	KMC_NODEBUG		UMC_NODEBUG
#define	kmem_alloc(_s, _f)	umem_alloc(_s, _f)
#define	kmem_zalloc(_s, _f)	umem_zalloc(_s, _f)
#define	kmem_free(_b, _s)	umem_free(_b, _s)
#define	kmem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i) \
	umem_cache_create(_a, _b, _c, _d, _e, _f, _g, _h, _i)
#define	kmem_cache_destroy(_c)	umem_cache_destroy(_c)
#define	kmem_cache_alloc(_c, _f) umem_cache_alloc(_c, _f)
#define	kmem_cache_free(_c, _b)	umem_cache_free(_c, _b)
#define	kmem_debugging()	0
#define	kmem_cache_reap_now(_c)		/* nothing */
#define	kmem_cache_set_move(_c, _cb)	/* nothing */
#define	POINTER_INVALIDATE(_pp)		/* nothing */
#define	POINTER_IS_VALID(_p)	0

typedef umem_cache_t kmem_cache_t;

typedef enum kmem_cbrc {
	KMEM_CBRC_YES,
	KMEM_CBRC_NO,
	KMEM_CBRC_LATER,
	KMEM_CBRC_DONT_NEED,
	KMEM_CBRC_DONT_KNOW
} kmem_cbrc_t;

/*
 * Task queues
 */
typedef struct taskq taskq_t;
typedef uintptr_t taskqid_t;
typedef void (task_func_t)(void *);

#define	TASKQ_PREPOPULATE	0x0001
#define	TASKQ_CPR_SAFE		0x0002	/* Use CPR safe protocol */
#define	TASKQ_DYNAMIC		0x0004	/* Use dynamic thread scheduling */
#define	TASKQ_THREADS_CPU_PCT	0x0008	/* Scale # threads by # cpus */
#define	TASKQ_DC_BATCH		0x0010	/* Mark threads as batch */

#define	TQ_SLEEP	KM_SLEEP	/* Can block for memory */
#define	TQ_NOSLEEP	KM_NOSLEEP	/* cannot block for memory; may fail */
#define	TQ_NOQUEUE	0x02		/* Do not enqueue if can't dispatch */
#define	TQ_FRONT	0x08		/* Queue in front */

extern taskq_t *system_taskq;

extern taskq_t	*taskq_create(const char *, int, pri_t, int, int, uint_t);
#define	taskq_create_proc(a, b, c, d, e, p, f) \
	    (taskq_create(a, b, c, d, e, f))
#define	taskq_create_sysdc(a, b, d, e, p, dc, f) \
	    (taskq_create(a, b, maxclsyspri, d, e, f))
extern taskqid_t taskq_dispatch(taskq_t *, task_func_t, void *, uint_t);
extern void	taskq_destroy(taskq_t *);
extern void	taskq_wait(taskq_t *);
extern int	taskq_member(taskq_t *, void *);
extern void	system_taskq_init(void);
extern void	system_taskq_fini(void);

#define	XVA_MAPSIZE	3
#define	XVA_MAGIC	0x78766174

/*
 * vnodes
 */
typedef struct vnode {
	uint64_t	v_size;
	int		v_fd;
	char		*v_path;
} vnode_t;

#define	AV_SCANSTAMP_SZ	32		/* length of anti-virus scanstamp */

typedef struct xoptattr {
	timestruc_t	xoa_createtime;	/* Create time of file */
	uint8_t		xoa_archive;
	uint8_t		xoa_system;
	uint8_t		xoa_readonly;
	uint8_t		xoa_hidden;
	uint8_t		xoa_nounlink;
	uint8_t		xoa_immutable;
	uint8_t		xoa_appendonly;
	uint8_t		xoa_nodump;
	uint8_t		xoa_settable;
	uint8_t		xoa_opaque;
	uint8_t		xoa_av_quarantined;
	uint8_t		xoa_av_modified;
	uint8_t		xoa_av_scanstamp[AV_SCANSTAMP_SZ];
	uint8_t		xoa_reparse;
	uint8_t		xoa_offline;
	uint8_t		xoa_sparse;
} xoptattr_t;

typedef struct vattr {
	uint_t		va_mask;	/* bit-mask of attributes */
	u_offset_t	va_size;	/* file size in bytes */
} vattr_t;


typedef struct xvattr {
	vattr_t		xva_vattr;	/* Embedded vattr structure */
	uint32_t	xva_magic;	/* Magic Number */
	uint32_t	xva_mapsize;	/* Size of attr bitmap (32-bit words) */
	uint32_t	*xva_rtnattrmapp;	/* Ptr to xva_rtnattrmap[] */
	uint32_t	xva_reqattrmap[XVA_MAPSIZE];	/* Requested attrs */
	uint32_t	xva_rtnattrmap[XVA_MAPSIZE];	/* Returned attrs */
	xoptattr_t	xva_xoptattrs;	/* Optional attributes */
} xvattr_t;

typedef struct vsecattr {
	uint_t		vsa_mask;	/* See below */
	int		vsa_aclcnt;	/* ACL entry count */
	void		*vsa_aclentp;	/* pointer to ACL entries */
	int		vsa_dfaclcnt;	/* default ACL entry count */
	void		*vsa_dfaclentp;	/* pointer to default ACL entries */
	size_t		vsa_aclentsz;	/* ACE size in bytes of vsa_aclentp */
} vsecattr_t;

#define	AT_TYPE		0x00001
#define	AT_MODE		0x00002
#define	AT_UID		0x00004
#define	AT_GID		0x00008
#define	AT_FSID		0x00010
#define	AT_NODEID	0x00020
#define	AT_NLINK	0x00040
#define	AT_SIZE		0x00080
#define	AT_ATIME	0x00100
#define	AT_MTIME	0x00200
#define	AT_CTIME	0x00400
#define	AT_RDEV		0x00800
#define	AT_BLKSIZE	0x01000
#define	AT_NBLOCKS	0x02000
#define	AT_SEQ		0x08000
#define	AT_XVATTR	0x10000

#define	CRCREAT		0

extern int fop_getattr(vnode_t *vp, vattr_t *vap);

#define	VOP_CLOSE(vp, f, c, o, cr, ct)	0
#define	VOP_PUTPAGE(vp, of, sz, fl, cr, ct)	0
#define	VOP_GETATTR(vp, vap, fl, cr, ct)  fop_getattr((vp), (vap));

#define	VOP_FSYNC(vp, f, cr, ct)	fsync((vp)->v_fd)

#define	VN_RELE(vp)	vn_close(vp)

extern int vn_open(char *path, int x1, int oflags, int mode, vnode_t **vpp,
    int x2, int x3);
extern int vn_openat(char *path, int x1, int oflags, int mode, vnode_t **vpp,
    int x2, int x3, vnode_t *vp, int fd);
extern int vn_rdwr(int uio, vnode_t *vp, void *addr, ssize_t len,
    offset_t offset, int x1, int x2, rlim64_t x3, void *x4, ssize_t *residp);
extern void vn_close(vnode_t *vp);

#define	vn_remove(path, x1, x2)		remove(path)
#define	vn_rename(from, to, seg)	rename((from), (to))
#define	vn_is_readonly(vp)		B_FALSE

extern vnode_t *rootdir;

#include <sys/file.h>		/* for FREAD, FWRITE, etc */

/*
 * Random stuff
 */
#define	ddi_get_lbolt()		(gethrtime() >> 23)
#define	ddi_get_lbolt64()	(gethrtime() >> 23)
#define	hz	119	/* frequency when using gethrtime() >> 23 for lbolt */

extern void delay(clock_t ticks);

#define	gethrestime_sec() time(NULL)
#define	gethrestime(t) \
	do {\
		(t)->tv_sec = gethrestime_sec();\
		(t)->tv_nsec = 0;\
	} while (0);

#define	max_ncpus	64

#define	minclsyspri	60
#define	maxclsyspri	99

#define	CPU_SEQID	(thr_self() & (max_ncpus - 1))

#define	kcred		NULL
#define	CRED()		NULL

#define	ptob(x)		((x) * PAGESIZE)

extern uint64_t physmem;

extern int highbit(ulong_t i);
extern int random_get_bytes(uint8_t *ptr, size_t len);
extern int random_get_pseudo_bytes(uint8_t *ptr, size_t len);

extern void kernel_init(int);
extern void kernel_fini(void);

struct spa;
extern void nicenum(uint64_t num, char *buf);
extern void show_pool_stats(struct spa *);

typedef struct callb_cpr {
	kmutex_t	*cc_lockp;
} callb_cpr_t;

#define	CALLB_CPR_INIT(cp, lockp, func, name)	{		\
	(cp)->cc_lockp = lockp;					\
}

#define	CALLB_CPR_SAFE_BEGIN(cp) {				\
	ASSERT(MUTEX_HELD((cp)->cc_lockp));			\
}

#define	CALLB_CPR_SAFE_END(cp, lockp) {				\
	ASSERT(MUTEX_HELD((cp)->cc_lockp));			\
}

#define	CALLB_CPR_EXIT(cp) {					\
	ASSERT(MUTEX_HELD((cp)->cc_lockp));			\
	mutex_exit((cp)->cc_lockp);				\
}

#define	zone_dataset_visible(x, y)	(1)
#define	INGLOBALZONE(z)			(1)

extern char *kmem_asprintf(const char *fmt, ...);
#define	strfree(str) kmem_free((str), strlen(str)+1)

/*
 * Hostname information
 */
extern char hw_serial[];	/* for userland-emulated hostid access */
extern int ddi_strtoul(const char *str, char **nptr, int base,
    unsigned long *result);

extern int ddi_strtoull(const char *str, char **nptr, int base,
    u_longlong_t *result);

/* ZFS Boot Related stuff. */

struct _buf {
	intptr_t	_fd;
};

struct bootstat {
	uint64_t st_size;
};

typedef struct ace_object {
	uid_t		a_who;
	uint32_t	a_access_mask;
	uint16_t	a_flags;
	uint16_t	a_type;
	uint8_t		a_obj_type[16];
	uint8_t		a_inherit_obj_type[16];
} ace_object_t;


#define	ACE_ACCESS_ALLOWED_OBJECT_ACE_TYPE	0x05
#define	ACE_ACCESS_DENIED_OBJECT_ACE_TYPE	0x06
#define	ACE_SYSTEM_AUDIT_OBJECT_ACE_TYPE	0x07
#define	ACE_SYSTEM_ALARM_OBJECT_ACE_TYPE	0x08

extern struct _buf *kobj_open_file(char *name);
extern int kobj_read_file(struct _buf *file, char *buf, unsigned size,
    unsigned off);
extern void kobj_close_file(struct _buf *file);
extern int kobj_get_filesize(struct _buf *file, uint64_t *size);
extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
extern int zfs_secpolicy_rename_perms(const char *from, const char *to,
    cred_t *cr);
extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
extern zoneid_t getzoneid(void);

/* SID stuff */
typedef struct ksiddomain {
	uint_t	kd_ref;
	uint_t	kd_len;
	char	*kd_name;
} ksiddomain_t;

ksiddomain_t *ksid_lookupdomain(const char *);
void ksiddomain_rele(ksiddomain_t *);

#define	DDI_SLEEP	KM_SLEEP
#define	ddi_log_sysevent(_a, _b, _c, _d, _e, _f, _g) \
	sysevent_post_event(_c, _d, _b, "libzpool", _e, _f)

#ifdef	__cplusplus
}
#endif

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