/*
 * Copyright (c) 1989, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * Mike Karels at Berkeley Software Design, Inc.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)sysctl.h	8.1 (Berkeley) 6/2/93
 * $FreeBSD: head/sys/sys/sysctl.h 204170 2010-02-21 13:57:02Z ed $
 */

#ifndef _SYS_SYSCTL_H_
#define	_SYS_SYSCTL_H_

#ifndef _SYS_TYPES_H_
#include <sys/types.h>
#endif
#ifndef _SYS_QUEUE_H_
#include <sys/queue.h>
#endif

/*
 * Definitions for sysctl call.  The sysctl call uses a hierarchical name
 * for objects that can be examined or modified.  The name is expressed as
 * a sequence of integers.  Like a file path name, the meaning of each
 * component depends on its place in the hierarchy.  The top-level and kern
 * identifiers are defined here, and other identifiers are defined in the
 * respective subsystem header files.
 */

#define CTL_MAXNAME	12	/* largest number of components supported */

/*
 * Each subsystem defined by sysctl defines a list of variables
 * for that subsystem. Each name is either a node with further
 * levels defined below it, or it is a leaf of some particular
 * type given below. Each sysctl level defines a set of name/type
 * pairs to be used by sysctl(1) in manipulating the subsystem.
 */
struct ctlname {
	char	*ctl_name;	/* subsystem name */
	int	ctl_type;	/* type of name */
};

#define CTLTYPE		0x1f	/* Mask for the type */
#define	CTLTYPE_NODE	0x01	/* name is a node */
#define	CTLTYPE_INT	0x02	/* name describes an integer */
#define	CTLTYPE_STRING	0x03	/* name describes a string */
#define	CTLTYPE_S64	0x04	/* name describes a signed 64-bit number */
#define	CTLTYPE_QUAD	CTLTYPE_S64 /* name describes a signed 64-bit number */
#define	CTLTYPE_OPAQUE	0x05	/* name describes a structure */
#define	CTLTYPE_STRUCT	CTLTYPE_OPAQUE	/* name describes a structure */
#define	CTLTYPE_UINT	0x06	/* name describes an unsigned integer */
#define	CTLTYPE_LONG	0x07	/* name describes a long */
#define	CTLTYPE_ULONG	0x08	/* name describes an unsigned long */
#define	CTLTYPE_U64	0x09	/* name describes an unsigned 64-bit number */
#define	CTLTYPE_UQUAD	CTLTYPE_U64 /* name describes an unsgn 64-bit number */
#define	CTLTYPE_U8	0x0a	/* name describes an unsigned 8-bit number */
#define	CTLTYPE_U16	0x0b	/* name describes an unsigned 16-bit number */
#define	CTLTYPE_S8	0x0c	/* name describes a signed 8-bit number */
#define	CTLTYPE_S16	0x0d	/* name describes a signed 16-bit number */
#define	CTLTYPE_S32	0x0e	/* name describes a signed 32-bit number */
#define	CTLTYPE_U32	0x0f	/* name describes an unsigned 32-bit number */

#define CTLTYPE_BIT32(n) (0x10 | ((n) << CTLSHIFT_BITFLD))
#define CTLTYPE_BIT64(n) (0x11 | ((n) << CTLSHIFT_BITFLD))

#define	CTLFLAG_RD	0x80000000	/* Allow reads of variable */
#define	CTLFLAG_WR	0x40000000	/* Allow writes to the variable */
#define	CTLFLAG_RW	(CTLFLAG_RD|CTLFLAG_WR)
#define	CTLFLAG_ANYBODY	0x10000000	/* All users can set this var */
#define	CTLFLAG_SECURE	0x08000000	/* Permit set only if securelevel<=0 */
#define	CTLFLAG_PRISON	0x04000000	/* Prisoned roots can fiddle */
#define	CTLFLAG_DYN	0x02000000	/* Dynamic oid - can be freed */
#define	CTLFLAG_SKIP	0x01000000	/* Skip this sysctl when listing */
#define	CTLMASK_SECURE	0x00F00000	/* Secure level */
#define	CTLFLAG_DYING	0x00010000	/* Oid is being removed */
#define CTLFLAG_SHLOCK	0x00008000	/* shlock on write (def is exlock) */
#define CTLFLAG_EXLOCK	0x00004000	/* exlock on read (def is shlock) */
#define CTLFLAG_NOLOCK	0x00002000	/* no lock required */
#define CTLFLAG_RSV12	0x00001000
#define CTLMASK_BITFLD	0x00000FC0	/* bitfield extension */
#define CTLFLAG_RSV5	0x00000020
#define CTLMASK_TYPE	0x0000001F	/* type field */

#define CTLSHIFT_BITFLD	6
#define CTLINFO_MAXBITN	64

/*
 * USE THIS instead of a hardwired number from the categories below
 * to get dynamically assigned sysctl entries using the linker-set
 * technology. This is the way nearly all new sysctl variables should
 * be implemented.
 * e.g. SYSCTL_INT(_parent, OID_AUTO, name, CTLFLAG_RW, &variable, 0, "");
 */
#define OID_AUTO	(-1)

#ifdef _KERNEL

#include <sys/kernel.h>			/* for DATA_SET */
#ifndef _SYS_LOCK_H_
#include <sys/lock.h>
#endif

#define SYSCTL_HANDLER_ARGS struct sysctl_oid *oidp, void *arg1, int arg2, \
	struct sysctl_req *req

/*
 * This describes the access space for a sysctl request.  This is needed
 * so that we can use the interface from the kernel or from user-space.
 */
struct sysctl_req {
	struct thread	*td;		/* used for access checking */
	int		 lock;		/* wiring state */
	void		*oldptr;
	size_t		 oldlen;
	size_t		 oldidx;
	int		(*oldfunc)(struct sysctl_req *, const void *, size_t);
	void		*newptr;
	size_t		 newlen;
	size_t		 newidx;
	int		(*newfunc)(struct sysctl_req *, void *, size_t);
	size_t		 validlen;
	int		 flags;
};

SLIST_HEAD(sysctl_oid_list, sysctl_oid);

/*
 * This describes one "oid" in the MIB tree.  Potentially more nodes can
 * be hidden behind it, expanded by the handler.
 */
struct sysctl_oid {
	struct sysctl_oid_list *oid_parent;
	SLIST_ENTRY(sysctl_oid) oid_link;
	int		oid_number;
	int		oid_kind;
	void		*oid_arg1;
	int		oid_arg2;
	const char	*oid_name;
	int 		(*oid_handler)(SYSCTL_HANDLER_ARGS);
	const char	*oid_fmt;
	int		oid_refcnt;
	u_int		 oid_running;
	const char	*oid_descr;
	struct lock	oid_lock;	/* per-node lock */
};

#define SYSCTL_IN(r, p, l)	(r->newfunc)(r, p, l)
#define SYSCTL_OUT(r, p, l)	(r->oldfunc)(r, p, l)
#define SYSCTL_OUT_STR(r, p)	(r->oldfunc)(r, p, strlen(p) + 1)

int sysctl_handle_8(SYSCTL_HANDLER_ARGS);
int sysctl_handle_16(SYSCTL_HANDLER_ARGS);
int sysctl_handle_32(SYSCTL_HANDLER_ARGS);
int sysctl_handle_64(SYSCTL_HANDLER_ARGS);
int sysctl_handle_int(SYSCTL_HANDLER_ARGS);
int sysctl_handle_long(SYSCTL_HANDLER_ARGS);
int sysctl_handle_quad(SYSCTL_HANDLER_ARGS);
int sysctl_handle_bit32(SYSCTL_HANDLER_ARGS);
int sysctl_handle_bit64(SYSCTL_HANDLER_ARGS);
int sysctl_handle_intptr(SYSCTL_HANDLER_ARGS);
int sysctl_handle_string(SYSCTL_HANDLER_ARGS);
int sysctl_handle_opaque(SYSCTL_HANDLER_ARGS);

extern struct lock sysctllock;

#define	SYSCTL_XLOCK()		_sysctl_xlock()
#define	SYSCTL_XUNLOCK()	_sysctl_xunlock()
#define	SYSCTL_SLOCK()		lockmgr(&mycpu->gd_sysctllock, LK_SHARED)
#define	SYSCTL_SUNLOCK()	lockmgr(&mycpu->gd_sysctllock, LK_RELEASE)
#define	SYSCTL_ASSERT_LOCKED() \
	KKASSERT(lockstatus(&mycpu->gd_sysctllock, curthread) != 0)

/*
 * These functions are used to add/remove an oid from the mib.
 */
void sysctl_register_oid(struct sysctl_oid *oidp);
void sysctl_unregister_oid(struct sysctl_oid *oidp);

/* Declare a static oid to allow child oids to be added to it. */
#define SYSCTL_DECL(name)					\
	extern struct sysctl_oid_list sysctl_##name##_children

/* Hide these in macros */
#define	SYSCTL_SET_CHILDREN(oid_ptr, children) do {			\
	(oid_ptr)->oid_arg1 = (children);				\
} while(0)
#define	SYSCTL_CHILDREN(oid_ptr) (struct sysctl_oid_list *) \
	(oid_ptr)->oid_arg1
#define	SYSCTL_STATIC_CHILDREN(oid_name) \
	(&sysctl_##oid_name##_children)

/* === Structs and macros related to context handling === */

/* All dynamically created sysctls can be tracked in a context list. */
struct sysctl_ctx_entry {
	struct sysctl_oid *entry;
	TAILQ_ENTRY(sysctl_ctx_entry) link;
};

TAILQ_HEAD(sysctl_ctx_list, sysctl_ctx_entry);

#define	SYSCTL_NODE_CHILDREN(parent, name) \
	sysctl_##parent##_##name##_children

#ifndef NO_SYSCTL_DESCR
#define	__DESCR(d) d
#else
#define	__DESCR(d) ""
#endif

/* This constructs a "raw" MIB oid. */
#define	SYSCTL_OID(parent, nbr, name, kind, a1, a2, handler, fmt, descr)\
	static struct sysctl_oid sysctl__##parent##_##name = {		\
		&sysctl_##parent##_children,				\
		{ NULL },						\
		nbr,							\
		kind,							\
		a1,							\
		a2,							\
		#name,							\
		handler,						\
		fmt,							\
		0,							\
		0,							\
		__DESCR(descr)						\
		};							\
	DATA_SET(sysctl_set, sysctl__##parent##_##name)

#define	SYSCTL_ADD_OID(ctx, parent, nbr, name, kind, a1, a2, handler, fmt, descr) \
	sysctl_add_oid(ctx, parent, nbr, name, kind, a1, a2, handler, fmt, descr);

/* This constructs a node from which other oids can hang. */
#define	SYSCTL_NODE(parent, nbr, name, access, handler, descr)		\
	struct sysctl_oid_list SYSCTL_NODE_CHILDREN(parent, name);	\
	SYSCTL_OID(parent, nbr, name, CTLTYPE_NODE|(access),		\
	    (void*)&SYSCTL_NODE_CHILDREN(parent, name), 0, handler, "N", descr)

#define SYSCTL_ADD_NODE(ctx, parent, nbr, name, access, handler, descr)	\
	sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_NODE|(access),	\
	0, 0, handler, "N", descr)

/* Oid for a string.  len can be 0 to indicate '\0' termination. */
#define SYSCTL_STRING(parent, nbr, name, access, arg, len, descr)	\
	SYSCTL_OID(parent, nbr, name, CTLTYPE_STRING|(access),		\
		arg, len, sysctl_handle_string, "A", descr)

#define SYSCTL_ADD_STRING(ctx, parent, nbr, name, access, arg, len, descr) \
	sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_STRING|(access),	\
	arg, len, sysctl_handle_string, "A", descr)

/* Oid for an int.  If ptr is NULL, val is returned. */
#define	SYSCTL_INT(parent, nbr, name, access, ptr, val, descr)		\
	SYSCTL_OID(parent, nbr, name,					\
		CTLTYPE_INT|CTLFLAG_NOLOCK|(access),			\
		ptr, val, sysctl_handle_int, "I", descr)

#define SYSCTL_ADD_INT(ctx, parent, nbr, name, access, ptr, val, descr)	\
	sysctl_add_oid(ctx, parent, nbr, name,				\
		CTLTYPE_INT|CTLFLAG_NOLOCK|(access),			\
	ptr, val, sysctl_handle_int, "I", descr)

/* Oid for a quad.  If ptr is NULL, val is returned. */
#define SYSCTL_QUAD(parent, nbr, name, access, ptr, val, descr)		\
	SYSCTL_OID(parent, nbr, name,					\
		CTLTYPE_QUAD|CTLFLAG_NOLOCK|(access),			\
		ptr, val, sysctl_handle_quad, "Q", descr)

#define SYSCTL_ADD_QUAD(ctx, parent, nbr, name, access, ptr, val, descr) \
	sysctl_add_oid(ctx, parent, nbr, name,				\
		CTLTYPE_QUAD|CTLFLAG_NOLOCK|(access),			\
		ptr, val, sysctl_handle_quad, "Q", descr)

/* Oid for an unsigned quad.  If ptr is NULL, val is returned. */
#define SYSCTL_UQUAD(parent, nbr, name, access, ptr, val, descr)	\
	SYSCTL_OID(parent, nbr, name,					\
		CTLTYPE_UQUAD|CTLFLAG_NOLOCK|(access),			\
		ptr, val, sysctl_handle_quad, "QU", descr)

#define SYSCTL_ADD_UQUAD(ctx, parent, nbr, name, access, ptr, val, descr) \
	sysctl_add_oid(ctx, parent, nbr, name,				\
		CTLTYPE_UQUAD|CTLFLAG_NOLOCK|(access),			\
		ptr, val, sysctl_handle_quad, "QU", descr)

/* Oid for an unsigned int.  If ptr is NULL, val is returned. */
#define SYSCTL_UINT(parent, nbr, name, access, ptr, val, descr)		\
	SYSCTL_OID(parent, nbr, name,					\
		CTLTYPE_UINT|CTLFLAG_NOLOCK|(access),			\
		ptr, val, sysctl_handle_int, "IU", descr)

#define SYSCTL_ADD_UINT(ctx, parent, nbr, name, access, ptr, val, descr) \
	sysctl_add_oid(ctx, parent, nbr, name,				\
		CTLTYPE_UINT|CTLFLAG_NOLOCK|(access),			\
		ptr, val, sysctl_handle_int, "IU", descr)

/* Oid for a long.  The pointer must be non NULL. */
#define SYSCTL_LONG(parent, nbr, name, access, ptr, val, descr)		\
	SYSCTL_OID(parent, nbr, name,					\
		CTLTYPE_LONG|CTLFLAG_NOLOCK|(access),			\
		ptr, val, sysctl_handle_long, "L", descr)

#define SYSCTL_ADD_LONG(ctx, parent, nbr, name, access, ptr, descr)	\
	sysctl_add_oid(ctx, parent, nbr, name,				\
		CTLTYPE_LONG|CTLFLAG_NOLOCK|(access),			\
		ptr, 0, sysctl_handle_long, "L", descr)

/* Oid for a long.  The pointer must be non NULL. */
#define SYSCTL_ULONG(parent, nbr, name, access, ptr, val, descr)	\
	SYSCTL_OID(parent, nbr, name,					\
		CTLTYPE_ULONG|CTLFLAG_NOLOCK|(access),			\
		ptr, val, sysctl_handle_long, "LU", descr)

#define SYSCTL_ADD_ULONG(ctx, parent, nbr, name, access, ptr, descr)	\
	sysctl_add_oid(ctx, parent, nbr, name,				\
		CTLTYPE_ULONG|CTLFLAG_NOLOCK|(access),			\
		ptr, 0, sysctl_handle_long, "LU", descr)

/* Oid for a signed 8-bit int.  The pointer must be non NULL. */
#define SYSCTL_S8(parent, nbr, name, access, ptr, val, descr)	\
	SYSCTL_OID(parent, nbr, name, CTLTYPE_S8|(access),		\
		ptr, val, sysctl_handle_8, "C", descr)

#define SYSCTL_ADD_S8(ctx, parent, nbr, name, access, ptr, descr)	\
	sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_S8|(access),	\
	ptr, 0, sysctl_handle_8, "C", descr)

/* Oid for a signed 16-bit int.  The pointer must be non NULL. */
#define SYSCTL_S16(parent, nbr, name, access, ptr, val, descr)	\
	SYSCTL_OID(parent, nbr, name, CTLTYPE_S16|(access),		\
		ptr, val, sysctl_handle_16, "S", descr)

#define SYSCTL_ADD_S16(ctx, parent, nbr, name, access, ptr, descr)	\
	sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_S16|(access),	\
	ptr, 0, sysctl_handle_16, "S", descr)

/* Oid for a signed 32-bit int.  The pointer must be non NULL. */
#define SYSCTL_S32(parent, nbr, name, access, ptr, val, descr)	\
	SYSCTL_OID(parent, nbr, name, CTLTYPE_S32|(access),		\
		ptr, val, sysctl_handle_32, "I", descr)

#define SYSCTL_ADD_S32(ctx, parent, nbr, name, access, ptr, descr)	\
	sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_S32|(access),	\
	ptr, 0, sysctl_handle_32, "I", descr)

/* Oid for a signed 64-bit int.  The pointer must be non NULL. */
#define SYSCTL_S64(parent, nbr, name, access, ptr, val, descr)	\
	SYSCTL_OID(parent, nbr, name, CTLTYPE_S64|(access),		\
		ptr, val, sysctl_handle_64, "Q", descr)

#define SYSCTL_ADD_S64(ctx, parent, nbr, name, access, ptr, descr)	\
	sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_S64|(access),	\
	ptr, 0, sysctl_handle_64, "Q", descr)

/* Oid for an unsigned 8-bit int.  The pointer must be non NULL. */
#define SYSCTL_U8(parent, nbr, name, access, ptr, val, descr)	\
	SYSCTL_OID(parent, nbr, name, CTLTYPE_U8|(access),		\
		ptr, val, sysctl_handle_8, "CU", descr)

#define SYSCTL_ADD_U8(ctx, parent, nbr, name, access, ptr, descr)	\
	sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_U8|(access),	\
	ptr, 0, sysctl_handle_8, "CU", descr)

/* Oid for an unsigned 16-bit int.  The pointer must be non NULL. */
#define SYSCTL_U16(parent, nbr, name, access, ptr, val, descr)	\
	SYSCTL_OID(parent, nbr, name, CTLTYPE_U16|(access),		\
		ptr, val, sysctl_handle_16, "SU", descr)

#define SYSCTL_ADD_U16(ctx, parent, nbr, name, access, ptr, descr)	\
	sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_U16|(access),	\
	ptr, 0, sysctl_handle_16, "SU", descr)

/* Oid for an unsigned 32-bit int.  The pointer must be non NULL. */
#define SYSCTL_U32(parent, nbr, name, access, ptr, val, descr)	\
	SYSCTL_OID(parent, nbr, name, CTLTYPE_U32|(access),		\
		ptr, val, sysctl_handle_32, "IU", descr)

#define SYSCTL_ADD_U32(ctx, parent, nbr, name, access, ptr, descr)	\
	sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_U32|(access),	\
	ptr, 0, sysctl_handle_32, "IU", descr)

/* Oid for an unsigned 64-bit int.  The pointer must be non NULL. */
#define SYSCTL_U64(parent, nbr, name, access, ptr, val, descr)	\
	SYSCTL_OID(parent, nbr, name, CTLTYPE_U64|(access),		\
		ptr, val, sysctl_handle_64, "QU", descr)

#define SYSCTL_ADD_U64(ctx, parent, nbr, name, access, ptr, descr)	\
	sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_U64|(access),	\
	ptr, 0, sysctl_handle_64, "QU", descr)

/* Oid for a bit in a uint32_t.  If ptr is NULL, val is returned. */
/* API passes and returns an integer */
#define	SYSCTL_BIT32(parent, nbr, name, access, ptr, val, bit, descr)	\
	SYSCTL_OID(parent, nbr, name,					\
		CTLTYPE_BIT32(bit)|CTLFLAG_NOLOCK|(access),		\
		ptr, val, sysctl_handle_bit32, "I", descr)

#define SYSCTL_ADD_BIT32(ctx, parent, nbr, name, access, ptr, val, bit, descr) \
	sysctl_add_oid(ctx, parent, nbr, name,				\
	    CTLTYPE_BIT32(bit)|CTLFLAG_NOLOCK|(access),			\
	    ptr, val, sysctl_handle_bit32, "I", descr)

/* Oid for a bit in a uint64_t.  If ptr is NULL, val is returned. */
/* API passes and returns an integer */
#define	SYSCTL_BIT64(parent, nbr, name, access, ptr, val, bit, descr)	\
	SYSCTL_OID(parent, nbr, name,					\
		CTLTYPE_BIT64(bit)|CTLFLAG_NOLOCK|(access),		\
		ptr, val, sysctl_handle_bit64, "I", descr)

#define SYSCTL_ADD_BIT64(ctx, parent, nbr, name, access, ptr, val, bit, descr) \
	sysctl_add_oid(ctx, parent, nbr, name,				\
	    CTLTYPE_BIT64(bit)|CTLFLAG_NOLOCK|(access),			\
	    ptr, val, sysctl_handle_bit64, "I", descr)

/* Oid for an opaque object.  Specified by a pointer and a length. */
#define SYSCTL_OPAQUE(parent, nbr, name, access, ptr, len, fmt, descr)	\
	SYSCTL_OID(parent, nbr, name, CTLTYPE_OPAQUE|(access),		\
		ptr, len, sysctl_handle_opaque, fmt, descr)

#define SYSCTL_ADD_OPAQUE(ctx, parent, nbr, name, access, ptr, len, fmt, descr) \
	sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_OPAQUE|(access),	\
	ptr, len, sysctl_handle_opaque, fmt, descr)

/* Oid for a struct.  Specified by a pointer and a type. */
#define SYSCTL_STRUCT(parent, nbr, name, access, ptr, type, descr)	\
	SYSCTL_OID(parent, nbr, name, CTLTYPE_OPAQUE|(access),		\
		ptr, sizeof(struct type), sysctl_handle_opaque,		\
		"S," #type, descr)

#define SYSCTL_ADD_STRUCT(ctx, parent, nbr, name, access, ptr, type, descr) \
	sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_OPAQUE|(access),	\
	ptr, sizeof(struct type), sysctl_handle_opaque, "S," #type, descr)

/* Oid for a procedure.  Specified by a pointer and an arg. */
#define SYSCTL_PROC(parent, nbr, name, access, ptr, arg, handler, fmt, descr) \
	SYSCTL_OID(parent, nbr, name, (access),				\
		ptr, arg, handler, fmt, descr)

#define SYSCTL_ADD_PROC(ctx, parent, nbr, name, access, ptr, arg, handler, fmt, descr) \
	sysctl_add_oid(ctx, parent, nbr, name, (access),		\
	ptr, arg, handler, fmt, descr)

#endif /* _KERNEL */

/*
 * Top-level identifiers
 */
#define	CTL_SYSCTL	0		/* "magic" numbers */
#define	CTL_KERN	1		/* "high kernel": proc, limits */
#define	CTL_VM		2		/* virtual memory */
#define	CTL_VFS		3		/* file system, mount type is next */
#define	CTL_NET		4		/* network, see socket.h */
#define	CTL_DEBUG	5		/* debugging parameters */
#define	CTL_HW		6		/* generic cpu/io */
#define	CTL_MACHDEP	7		/* machine dependent */
#define	CTL_USER	8		/* user-level */
#define	CTL_P1003_1B	9		/* POSIX 1003.1B */
#define	CTL_LWKT	10		/* light weight kernel threads */
#define	CTL_MAXID	11		/* number of valid top-level ids */

/*
 * CTL_SYSCTL identifiers
 */
#define	CTL_SYSCTL_DEBUG	0	/* printf all nodes */
#define	CTL_SYSCTL_NAME		1	/* string name of OID */
#define	CTL_SYSCTL_NEXT		2	/* next OID */
#define	CTL_SYSCTL_NAME2OID	3	/* int array of name */
#define	CTL_SYSCTL_OIDFMT	4	/* OID's kind and format */
#define	CTL_SYSCTL_OIDDESCR	5	/* OID's description */

/*
 * CTL_KERN identifiers
 */
#define	KERN_OSTYPE	 	 1	/* string: system version */
#define	KERN_OSRELEASE	 	 2	/* string: system release */
#define	KERN_OSREV	 	 3	/* int: system revision */
#define	KERN_VERSION	 	 4	/* string: compile time info */
#define	KERN_MAXVNODES	 	 5	/* int: max vnodes */
#define	KERN_MAXPROC	 	 6	/* int: max processes */
#define	KERN_MAXFILES	 	 7	/* int: max open files */
#define	KERN_ARGMAX	 	 8	/* int: max arguments to exec */
#define	KERN_SECURELVL	 	 9	/* int: system security level */
#define	KERN_HOSTNAME		10	/* string: hostname */
#define	KERN_HOSTID		11	/* int: host identifier */
#define	KERN_CLOCKRATE		12	/* struct: struct clockrate */
#define	KERN_VNODE		13	/* struct: vnode structures */
#define	KERN_PROC		14	/* struct: process entries */
#define	KERN_FILE		15	/* struct: file entries */
#define	KERN_UNUSED16		16	/* was: node: kernel profiling info */
#define	KERN_POSIX1		17	/* int: POSIX.1 version */
#define	KERN_NGROUPS		18	/* int: # of supplemental group ids */
#define	KERN_JOB_CONTROL	19	/* int: is job control available */
#define	KERN_SAVED_IDS		20	/* int: saved set-user/group-ID */
#define	KERN_BOOTTIME		21	/* struct: time kernel was booted */
#define KERN_NISDOMAINNAME	22	/* string: YP domain name */
#define KERN_UPDATEINTERVAL	23	/* int: update process sleep time */
#define KERN_OSRELDATE		24	/* int: OS release date */
#define KERN_NTP_PLL		25	/* node: NTP PLL control */
#define	KERN_BOOTFILE		26	/* string: name of booted kernel */
#define	KERN_MAXFILESPERPROC	27	/* int: max open files per proc */
#define	KERN_MAXPROCPERUID 	28	/* int: max processes per uid */
#define	KERN_DUMPDEV		29	/* dev_t: device to dump on */
#define	KERN_IPC		30	/* node: anything related to IPC */
#define	KERN_DUMMY		31	/* unused */
#define	KERN_PS_STRINGS		32	/* int: address of PS_STRINGS */
#define	KERN_USRSTACK		33	/* int: address of USRSTACK */
#define	KERN_LOGSIGEXIT		34	/* int: do we log sigexit procs? */
#define	KERN_IOV_MAX		35	/* int: value of UIO_MAXIOV */
#define KERN_MAXPOSIXLOCKSPERUID 36	/* int: max POSIX locks per uid */
#define KERN_STATIC_TLS_EXTRA	37	/* int: extra tls space for rtld */
#define KERN_MAXID		38      /* number of valid kern ids */

/*
 * CTL_VFS identifiers
 */
/* empty */

/*
 * KERN_PROC subtypes
 */
#define KERN_PROC_ALL		0	/* everything */
#define	KERN_PROC_PID		1	/* by process id */
#define	KERN_PROC_PGRP		2	/* by process group id */
#define	KERN_PROC_SESSION	3	/* by session of pid */
#define	KERN_PROC_TTY		4	/* by controlling tty */
#define	KERN_PROC_UID		5	/* by effective uid */
#define	KERN_PROC_RUID		6	/* by real uid */
#define	KERN_PROC_ARGS		7	/* get/set arguments/proctitle */
#define	KERN_PROC_CWD		8	/* get cwd */
#define	KERN_PROC_PATHNAME      9	/* path to executable */
#define KERN_PROC_SIGTRAMP	10	/* addr[2]: sigtramp addr range */

#define KERN_PROC_FLAGMASK	0xF0
#define KERN_PROC_FLAG_LWP	0x10
#define KERN_PROC_FLAG_LWKT	0x20

/*
 * KERN_IPC identifiers
 */
#define KIPC_MAXSOCKBUF		1	/* int: max size of a socket buffer */
#define	KIPC_SOCKBUF_WASTE	2	/* int: wastage factor in sockbuf */
#define	KIPC_SOMAXCONN		3	/* int: max length of connection q */
#define	KIPC_MAX_LINKHDR	4	/* int: max length of link header */
#define	KIPC_MAX_PROTOHDR	5	/* int: max length of network header */
#define	KIPC_MAX_HDR		6	/* int: max total length of headers */
#define	KIPC_MAX_DATALEN	7	/* int: max length of data? */
#define	KIPC_MBSTAT		8	/* struct: mbuf usage statistics */
#define	KIPC_NMBCLUSTERS	9	/* int: maximum mbuf clusters */

/*
 * CTL_HW identifiers
 */
#define	HW_MACHINE	 1		/* string: machine class */
#define	HW_MODEL	 2		/* string: specific machine model */
#define	HW_NCPU		 3		/* int: number of cpus */
#define	HW_BYTEORDER	 4		/* int: machine byte order */
#define	HW_PHYSMEM	 5		/* int: total memory */
#define	HW_USERMEM	 6		/* int: non-kernel memory */
#define	HW_PAGESIZE	 7		/* int: software page size */
#define	HW_DISKNAMES	 8		/* strings: disk drive names */
#define	HW_DISKSTATS	 9		/* struct: diskstats[] */
#define HW_FLOATINGPT	10		/* int: has HW floating point? */
#define HW_MACHINE_ARCH	11		/* string: machine architecture */
#define HW_MACHINE_PLATFORM 12		/* string: platform architecture */
#define HW_SENSORS	13		/* node: hardware sensors */
#define HW_MAXID	14		/* number of valid hw ids */

/*
 * CTL_USER definitions
 */
#define	USER_CS_PATH		 1	/* string: _CS_PATH */
#define	USER_BC_BASE_MAX	 2	/* int: BC_BASE_MAX */
#define	USER_BC_DIM_MAX		 3	/* int: BC_DIM_MAX */
#define	USER_BC_SCALE_MAX	 4	/* int: BC_SCALE_MAX */
#define	USER_BC_STRING_MAX	 5	/* int: BC_STRING_MAX */
#define	USER_COLL_WEIGHTS_MAX	 6	/* int: COLL_WEIGHTS_MAX */
#define	USER_EXPR_NEST_MAX	 7	/* int: EXPR_NEST_MAX */
#define	USER_LINE_MAX		 8	/* int: LINE_MAX */
#define	USER_RE_DUP_MAX		 9	/* int: RE_DUP_MAX */
#define	USER_POSIX2_VERSION	10	/* int: _POSIX2_VERSION */
#define	USER_POSIX2_C_BIND	11	/* int: _POSIX2_C_BIND */
#define	USER_POSIX2_C_DEV	12	/* int: _POSIX2_C_DEV */
#define	USER_POSIX2_CHAR_TERM	13	/* int: _POSIX2_CHAR_TERM */
#define	USER_POSIX2_FORT_DEV	14	/* int: _POSIX2_FORT_DEV */
#define	USER_POSIX2_FORT_RUN	15	/* int: _POSIX2_FORT_RUN */
#define	USER_POSIX2_LOCALEDEF	16	/* int: _POSIX2_LOCALEDEF */
#define	USER_POSIX2_SW_DEV	17	/* int: _POSIX2_SW_DEV */
#define	USER_POSIX2_UPE		18	/* int: _POSIX2_UPE */
#define	USER_STREAM_MAX		19	/* int: _POSIX2_STREAM_MAX */
#define	USER_TZNAME_MAX		20	/* int: _POSIX2_TZNAME_MAX */
#define	USER_MAXID		21	/* number of valid user ids */

/*
 * P1003_1B definitions
 */
#define CTL_P1003_1B_ASYNCHRONOUS_IO		1	/* boolean */
#define CTL_P1003_1B_MAPPED_FILES		2	/* boolean */
#define CTL_P1003_1B_MEMLOCK			3	/* boolean */
#define CTL_P1003_1B_MEMLOCK_RANGE		4	/* boolean */
#define CTL_P1003_1B_MEMORY_PROTECTION		5	/* boolean */
#define CTL_P1003_1B_MESSAGE_PASSING		6	/* boolean */
#define CTL_P1003_1B_PRIORITIZED_IO		7	/* boolean */
#define CTL_P1003_1B_PRIORITY_SCHEDULING	8	/* boolean */
#define CTL_P1003_1B_REALTIME_SIGNALS		9	/* boolean */
#define CTL_P1003_1B_SEMAPHORES			10	/* boolean */
#define CTL_P1003_1B_FSYNC			11	/* boolean */
#define CTL_P1003_1B_SHARED_MEMORY_OBJECTS	12	/* boolean */
#define CTL_P1003_1B_SYNCHRONIZED_IO		13	/* boolean */
#define CTL_P1003_1B_TIMERS			14	/* boolean */
#define CTL_P1003_1B_AIO_LISTIO_MAX		15	/* int */
#define CTL_P1003_1B_AIO_MAX			16	/* int */
#define CTL_P1003_1B_AIO_PRIO_DELTA_MAX		17	/* int */
#define CTL_P1003_1B_DELAYTIMER_MAX		18	/* int */
#define CTL_P1003_1B_UNUSED19			19	/* int */
#define CTL_P1003_1B_PAGESIZE			20	/* int */
#define CTL_P1003_1B_RTSIG_MAX			21	/* int */
#define CTL_P1003_1B_SEM_NSEMS_MAX		22	/* int */
#define CTL_P1003_1B_UNUSED23			23	/* int */
#define CTL_P1003_1B_SIGQUEUE_MAX		24	/* int */
#define CTL_P1003_1B_TIMER_MAX			25	/* int */

#ifdef _KERNEL

#define CTL_P1003_1B_MAXID		26

/*
 * Declare some common oids.
 */
extern struct sysctl_oid_list sysctl__children;
SYSCTL_DECL(_kern);
SYSCTL_DECL(_kern_features);
SYSCTL_DECL(_sysctl);
SYSCTL_DECL(_vm);
SYSCTL_DECL(_vfs);
SYSCTL_DECL(_net);
SYSCTL_DECL(_debug);
SYSCTL_DECL(_debug_sizeof);
SYSCTL_DECL(_dev);
SYSCTL_DECL(_hw);
SYSCTL_DECL(_hw_bus);
SYSCTL_DECL(_machdep);
SYSCTL_DECL(_user);
SYSCTL_DECL(_compat);
SYSCTL_DECL(_lwkt);
SYSCTL_DECL(_security);

/*
 * Common second-level oids.
 */
SYSCTL_DECL(_kern_ipc);

extern char	machine[];
extern char	osrelease[];
extern char	ostype[];
extern char	kern_ident[];

/* Dynamic oid handling */
struct sysctl_oid *sysctl_add_oid(struct sysctl_ctx_list *clist,
		struct sysctl_oid_list *parent, int nbr, const char *name,
		int kind, void *arg1, int arg2,
		int (*handler) (SYSCTL_HANDLER_ARGS),
		const char *fmt, const char *descr);
void	sysctl_rename_oid(struct sysctl_oid *oidp, const char *name);
int	sysctl_remove_name(struct sysctl_oid *parent, const char *name, int del,
	    int recurse);
int	sysctl_remove_oid(struct sysctl_oid *oidp, int del, int recurse);
int	sysctl_ctx_init(struct sysctl_ctx_list *clist);
int	sysctl_ctx_free(struct sysctl_ctx_list *clist);
struct	sysctl_ctx_entry *sysctl_ctx_entry_add(struct sysctl_ctx_list *clist,
		struct sysctl_oid *oidp);
struct	sysctl_ctx_entry *sysctl_ctx_entry_find(struct sysctl_ctx_list *clist,
		struct sysctl_oid *oidp);
int	sysctl_ctx_entry_del(struct sysctl_ctx_list *clist,
		struct sysctl_oid *oidp);

int	kernel_sysctl(int *name, u_int namelen, void *old,
		      size_t *oldlenp, void *new, size_t newlen,
		      size_t *retval);
int	kernel_sysctlbyname(char *name,
		void *old, size_t *oldlenp, void *new, size_t newlen,
		size_t *retval);
int	userland_sysctl(int *name, u_int namelen, void *old,
	    size_t *oldlenp, int inkernel, void *new, size_t newlen,
	    size_t *retval);
int	sysctl_find_oid(int *name, u_int namelen, struct sysctl_oid **noid,
			int *nindx, struct sysctl_req *req);

int	sysctl_int_range(SYSCTL_HANDLER_ARGS, int low, int high);
void	_sysctl_xlock(void);
void	_sysctl_xunlock(void);

struct sbuf;
struct sbuf *sbuf_new_for_sysctl(struct sbuf *, char *, int,
	    struct sysctl_req *);

/*
 * A macro to generate a read-only sysctl to indicate the presence of optional
 * kernel features.
 */
#define FEATURE(name, desc)						\
	SYSCTL_INT(_kern_features, OID_AUTO, name,		\
	    CTLFLAG_RD, NULL, 1, desc)

#endif	/* _KERNEL */

#if !defined(_KERNEL) || defined(_KERNEL_VIRTUAL)

#include <sys/cdefs.h>

__BEGIN_DECLS
int	sysctl(const int *, u_int, void *, size_t *, const void *, size_t);
int	sysctlbyname(const char *, void *, size_t *, const void *, size_t);
int	sysctlnametomib (const char *, int *, size_t *);
__END_DECLS

#endif	/* _KERNEL && _KERNEL_VIRTUAL */

#endif	/* !_SYS_SYSCTL_H_ */
