/*

 * 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 2009 Sun Microsystems, Inc.  All rights reserved.

 * Use is subject to license terms.

 */

#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

/* This definition is copied from assert.h. */

#if defined(__STDC__)

#if __STDC_VERSION__ - 0 >= 199901L

#define	verify(EX) (void)((EX) || \

	(__assert_c99(#EX, __FILE__, __LINE__, __func__), 0))

#else

#define	verify(EX) (void)((EX) || (__assert(#EX, __FILE__, __LINE__), 0))

#endif /* __STDC_VERSION__ - 0 >= 199901L */

#else

#define	verify(EX) (void)((EX) || (_assert("EX", __FILE__, __LINE__), 0))

#endif	/* __STDC__ */

#define	VERIFY	verify

#define	ASSERT	assert

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)) { \

		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)

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

#define	MUTEX_HELD(m) _mutex_held(&(m)->m_lock)

/*

 * 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)

typedef umem_cache_t kmem_cache_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	TQ_SLEEP	KM_SLEEP	/* Can block for memory */

#define	TQ_NOSLEEP	KM_NOSLEEP	/* cannot block for memory; may fail */

extern taskq_t *system_taskq;

extern taskq_t	*taskq_create(const char *, int, pri_t, int, int, uint_t);

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;

} 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));			\

}