[apple/xnu.git] / bsd / sys / domain.h

/*
 * Copyright (c) 2000-2012 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 *
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 *
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 *
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/* Copyright (c) 1998, 1999 Apple Computer, Inc. All Rights Reserved */
/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
/*
 * Copyright (c) 1982, 1986, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * 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. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. 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.
 *
 *	@(#)domain.h	8.1 (Berkeley) 6/2/93
 * $FreeBSD: src/sys/sys/domain.h,v 1.14 1999/12/29 04:24:40 peter Exp $
 */

#ifndef _SYS_DOMAIN_H_
#define _SYS_DOMAIN_H_

#ifdef PRIVATE
#include <sys/appleapiopts.h>
#include <sys/cdefs.h>
#ifdef KERNEL_PRIVATE
#include <kern/locks.h>
/*
 * Structure per communications domain.
 */

/*
 * Forward structure declarations for function prototypes [sic].
 */
struct	mbuf;

#pragma pack(4)

#ifdef XNU_KERNEL_PRIVATE
/*
 * Legacy domain.
 *
 * NOTE: Do not modify this structure, as there are modules outside of xnu
 * which rely on the size and layout for binary compatibility.  This structure
 * is simply used by the exported net_{add,del}_domain_old, pffinddomain_old
 * routines.  Internally, domains are stored in the private variant of domain
 * defined down below.
 */
struct domain_old {
#else
struct domain {
#endif /* !XNU_KERNEL_PRIVATE */
	int	dom_family;		/* AF_xxx */
	const char *dom_name;
	void	(*dom_init)(void);	/* initialize domain data structures */
	int	(*dom_externalize)	/* externalize access rights */
		    (struct mbuf *);
	void	(*dom_dispose)		/* dispose of internalized rights */
		    (struct mbuf *);
#ifdef XNU_KERNEL_PRIVATE
	struct	protosw_old *dom_protosw; /* Chain of protosw's for AF */
	struct	domain_old *dom_next;
#else
	struct	protosw *dom_protosw;	/* Chain of protosw's for AF */
	struct	domain *dom_next;
#endif /* !XNU_KERNEL_PRIVATE */
	int	(*dom_rtattach)		/* initialize routing table */
		    (void **, int);
	int	dom_rtoffset;		/* an arg to rtattach, in bits */
	int	dom_maxrtkey;		/* for routing layer */
	int	dom_protohdrlen;	/* len of protocol header */
	int	dom_refs;		/* # socreates outstanding */
	lck_mtx_t *dom_mtx;		/* domain global mutex */
	uint32_t dom_flags;
	uint32_t reserved[2];
};

#pragma pack()

#ifdef XNU_KERNEL_PRIVATE
/*
 * Internal, private and extendable representation of domain.
 */
struct domain {
	int	dom_family;		/* AF_xxx */
	uint32_t dom_flags;		/* domain flags (see below ) */
	uint32_t dom_refs;		/* # socreates outstanding */
	lck_mtx_t *dom_mtx;		/* domain global mutex */
	decl_lck_mtx_data(, dom_mtx_s);
	TAILQ_ENTRY(domain) dom_entry;	/* next domain in list */
	TAILQ_HEAD(, protosw) dom_protosw; /* protosw chain */
	void	(*dom_init)		/* initialize domain data structures */
		    (struct domain *);
	int	(*dom_externalize)	/* externalize access rights */
		    (struct mbuf *);
	void	(*dom_dispose)		/* dispose of internalized rights */
		    (struct mbuf *);
	int	(*dom_rtattach)		/* initialize routing table */
		    (void **, int);
	int	dom_rtoffset;		/* an arg to rtattach, in bits */
	int	dom_maxrtkey;		/* for routing layer */
	int	dom_protohdrlen;	/* len of protocol header */
	const char *dom_name;
	struct domain_old *dom_old;	/* domain pointer per net_add_domain */
};

extern TAILQ_HEAD(domains_head, domain) domains;
extern struct domain *localdomain;
#endif /* XNU_KERNEL_PRIVATE */

/*
 * Values for dom_flags
 */
#define DOM_REENTRANT	0x1
#ifdef BSD_KERNEL_PRIVATE
#define	DOM_INITIALIZED	0x2		/* domain has been initialized */
#define	DOM_ATTACHED	0x4		/* domain is in the global list */
#define	DOM_OLD		0x10000000	/* domain added via net_add_domain */

/* pseudo-public domain flags */
#define	DOMF_USERFLAGS	(DOM_REENTRANT)
#endif /* BSD_KERNEL_PRIVATE */

__BEGIN_DECLS
#ifdef XNU_KERNEL_PRIVATE
extern void net_add_domain_old(struct domain_old *dp);
extern int net_del_domain_old(struct domain_old *);
extern void net_drain_domains(void);
extern void domain_proto_mtx_lock_assert_held(void);
extern void domain_proto_mtx_lock_assert_notheld(void);
struct domain_guard;
typedef struct domain_guard *domain_guard_t;
extern domain_guard_t domain_guard_deploy(void);
extern void domain_guard_release(domain_guard_t);
struct domain_unguard;
typedef struct domain_unguard *domain_unguard_t;
extern domain_unguard_t domain_unguard_deploy(void);
extern void domain_unguard_release(domain_unguard_t);
extern struct domain_old *pffinddomain_old(int);
#else
extern void net_add_domain(struct domain *dp);
extern int net_del_domain(struct domain *);
#endif /* XNU_KERNEL_PRIVATE */
extern struct domain *pffinddomain(int);
__END_DECLS
#endif /* KERNEL_PRIVATE */
#endif /* PRIVATE */
#endif	/* _SYS_DOMAIN_H_ */
Commit	Line	Data
1c79356b	1	/*
39236c6e	2	* Copyright (c) 2000-2012 Apple Inc. All rights reserved.
5d5c5d0d	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
39236c6e	5	*
2d21ac55 A	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. The rights granted to you under the License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
39236c6e	14	*
2d21ac55 A	15	* Please obtain a copy of the License at
2d21ac55 A	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
39236c6e	17	*
2d21ac55 A	18	* The Original Code and all software distributed under the License are
2d21ac55 A	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
	24	* limitations under the License.
39236c6e	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/* Copyright (c) 1998, 1999 Apple Computer, Inc. All Rights Reserved */
	29	/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
	30	/*
	31	* Copyright (c) 1982, 1986, 1993
	32	* The Regents of the University of California. All rights reserved.
	33	*
	34	* Redistribution and use in source and binary forms, with or without
	35	* modification, are permitted provided that the following conditions
	36	* are met:
	37	* 1. Redistributions of source code must retain the above copyright
	38	* notice, this list of conditions and the following disclaimer.
	39	* 2. Redistributions in binary form must reproduce the above copyright
	40	* notice, this list of conditions and the following disclaimer in the
	41	* documentation and/or other materials provided with the distribution.
	42	* 3. All advertising materials mentioning features or use of this software
	43	* must display the following acknowledgement:
	44	* This product includes software developed by the University of
	45	* California, Berkeley and its contributors.
	46	* 4. Neither the name of the University nor the names of its contributors
	47	* may be used to endorse or promote products derived from this software
	48	* without specific prior written permission.
	49	*
	50	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	51	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	52	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	53	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	54	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	55	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	56	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	57	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	58	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	59	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	60	* SUCH DAMAGE.
	61	*
	62	* @(#)domain.h 8.1 (Berkeley) 6/2/93
9bccf70c	63	* $FreeBSD: src/sys/sys/domain.h,v 1.14 1999/12/29 04:24:40 peter Exp $
1c79356b A	64	*/
1c79356b A	65
9bccf70c	66	#ifndef _SYS_DOMAIN_H_
1c79356b A	67	#define _SYS_DOMAIN_H_
1c79356b A	68
91447636	69	#ifdef PRIVATE
91447636	70	#include <sys/appleapiopts.h>
39236c6e A	71	#include <sys/cdefs.h>
39236c6e A	72	#ifdef KERNEL_PRIVATE
91447636	73	#include <kern/locks.h>
1c79356b A	74	/*
	75	* Structure per communications domain.
	76	*/
	77
	78	/*
	79	* Forward structure declarations for function prototypes [sic].
	80	*/
	81	struct mbuf;
91447636	82
0c530ab8	83	#pragma pack(4)
1c79356b	84
39236c6e A	85	#ifdef XNU_KERNEL_PRIVATE
	86	/*
	87	* Legacy domain.
	88	*
	89	* NOTE: Do not modify this structure, as there are modules outside of xnu
	90	* which rely on the size and layout for binary compatibility. This structure
	91	* is simply used by the exported net_{add,del}_domain_old, pffinddomain_old
	92	* routines. Internally, domains are stored in the private variant of domain
	93	* defined down below.
	94	*/
	95	struct domain_old {
	96	#else
	97	struct domain {
	98	#endif /* !XNU_KERNEL_PRIVATE */
1c79356b	99	int dom_family; /* AF_xxx */
39236c6e	100	const char *dom_name;
91447636	101	void (dom_init)(void); / initialize domain data structures */
39236c6e A	102	int (dom_externalize) / externalize access rights */
	103	(struct mbuf *);
	104	void (dom_dispose) / dispose of internalized rights */
	105	(struct mbuf *);
	106	#ifdef XNU_KERNEL_PRIVATE
	107	struct protosw_old dom_protosw; / Chain of protosw's for AF */
	108	struct domain_old *dom_next;
	109	#else
1c79356b A	110	struct protosw dom_protosw; / Chain of protosw's for AF */
1c79356b A	111	struct domain *dom_next;
39236c6e A	112	#endif /* !XNU_KERNEL_PRIVATE */
	113	int (dom_rtattach) / initialize routing table */
	114	(void **, int);
1c79356b A	115	int dom_rtoffset; /* an arg to rtattach, in bits */
1c79356b A	116	int dom_maxrtkey; /* for routing layer */
39236c6e	117	int dom_protohdrlen; /* len of protocol header */
1c79356b	118	int dom_refs; /* # socreates outstanding */
39236c6e A	119	lck_mtx_t dom_mtx; / domain global mutex */
	120	uint32_t dom_flags;
	121	uint32_t reserved[2];
1c79356b A	122	};
1c79356b A	123
0c530ab8	124	#pragma pack()
91447636	125
39236c6e A	126	#ifdef XNU_KERNEL_PRIVATE
	127	/*
	128	* Internal, private and extendable representation of domain.
	129	*/
	130	struct domain {
	131	int dom_family; /* AF_xxx */
	132	uint32_t dom_flags; /* domain flags (see below ) */
	133	uint32_t dom_refs; /* # socreates outstanding */
	134	lck_mtx_t dom_mtx; / domain global mutex */
	135	decl_lck_mtx_data(, dom_mtx_s);
	136	TAILQ_ENTRY(domain) dom_entry; /* next domain in list */
	137	TAILQ_HEAD(, protosw) dom_protosw; /* protosw chain */
	138	void (dom_init) / initialize domain data structures */
	139	(struct domain *);
	140	int (dom_externalize) / externalize access rights */
	141	(struct mbuf *);
	142	void (dom_dispose) / dispose of internalized rights */
	143	(struct mbuf *);
	144	int (dom_rtattach) / initialize routing table */
	145	(void **, int);
	146	int dom_rtoffset; /* an arg to rtattach, in bits */
	147	int dom_maxrtkey; /* for routing layer */
	148	int dom_protohdrlen; /* len of protocol header */
	149	const char *dom_name;
	150	struct domain_old dom_old; / domain pointer per net_add_domain */
	151	};
91447636	152
39236c6e A	153	extern TAILQ_HEAD(domains_head, domain) domains;
	154	extern struct domain *localdomain;
	155	#endif /* XNU_KERNEL_PRIVATE */
	156
	157	/*
	158	* Values for dom_flags
	159	*/
	160	#define DOM_REENTRANT 0x1
	161	#ifdef BSD_KERNEL_PRIVATE
	162	#define DOM_INITIALIZED 0x2 /* domain has been initialized */
	163	#define DOM_ATTACHED 0x4 /* domain is in the global list */
	164	#define DOM_OLD 0x10000000 /* domain added via net_add_domain */
1c79356b	165
39236c6e A	166	/* pseudo-public domain flags */
	167	#define DOMF_USERFLAGS (DOM_REENTRANT)
	168	#endif /* BSD_KERNEL_PRIVATE */
1c79356b	169
39236c6e A	170	__BEGIN_DECLS
	171	#ifdef XNU_KERNEL_PRIVATE
	172	extern void net_add_domain_old(struct domain_old *dp);
	173	extern int net_del_domain_old(struct domain_old *);
	174	extern void net_drain_domains(void);
	175	extern void domain_proto_mtx_lock_assert_held(void);
	176	extern void domain_proto_mtx_lock_assert_notheld(void);
	177	struct domain_guard;
	178	typedef struct domain_guard *domain_guard_t;
	179	extern domain_guard_t domain_guard_deploy(void);
	180	extern void domain_guard_release(domain_guard_t);
	181	struct domain_unguard;
	182	typedef struct domain_unguard *domain_unguard_t;
	183	extern domain_unguard_t domain_unguard_deploy(void);
	184	extern void domain_unguard_release(domain_unguard_t);
	185	extern struct domain_old *pffinddomain_old(int);
	186	#else
	187	extern void net_add_domain(struct domain *dp);
	188	extern int net_del_domain(struct domain *);
	189	#endif /* XNU_KERNEL_PRIVATE */
	190	extern struct domain *pffinddomain(int);
	191	__END_DECLS
	192	#endif /* KERNEL_PRIVATE */
91447636	193	#endif /* PRIVATE */
1c79356b	194	#endif /* _SYS_DOMAIN_H_ */