1/*
2 * Copyright (c) 2000-2012 Apple Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
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.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
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.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
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
63 * $FreeBSD: src/sys/sys/domain.h,v 1.14 1999/12/29 04:24:40 peter Exp $
64 */
65
66#ifndef _SYS_DOMAIN_H_
67#define _SYS_DOMAIN_H_
68
69#ifdef PRIVATE
70#include <sys/appleapiopts.h>
71#include <sys/cdefs.h>
72#ifdef KERNEL_PRIVATE
73#include <kern/locks.h>
74/*
75 * Structure per communications domain.
76 */
77
78/*
79 * Forward structure declarations for function prototypes [sic].
80 */
81struct mbuf;
82
83#pragma pack(4)
84
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 */
95struct domain_old {
96#else
97struct domain {
98#endif /* !XNU_KERNEL_PRIVATE */
99 int dom_family; /* AF_xxx */
100 const char *dom_name;
101 void (*dom_init)(void); /* initialize domain data structures */
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
110 struct protosw *dom_protosw; /* Chain of protosw's for AF */
111 struct domain *dom_next;
112#endif /* !XNU_KERNEL_PRIVATE */
113 int (*dom_rtattach) /* initialize routing table */
114 (void **, int);
115 int dom_rtoffset; /* an arg to rtattach, in bits */
116 int dom_maxrtkey; /* for routing layer */
117 int dom_protohdrlen; /* len of protocol header */
118 int dom_refs; /* # socreates outstanding */
119 lck_mtx_t *dom_mtx; /* domain global mutex */
120 uint32_t dom_flags;
121 uint32_t reserved[2];
122};
123
124#pragma pack()
125
126#ifdef XNU_KERNEL_PRIVATE
127
128#include <sys/queue.h>
129
130/*
131 * Internal, private and extendable representation of domain.
132 */
133struct domain {
134 int dom_family; /* AF_xxx */
135 uint32_t dom_flags; /* domain flags (see below ) */
136 uint32_t dom_refs; /* # socreates outstanding */
137 lck_mtx_t *dom_mtx; /* domain global mutex */
138 decl_lck_mtx_data(, dom_mtx_s);
139 TAILQ_ENTRY(domain) dom_entry; /* next domain in list */
140 TAILQ_HEAD(, protosw) dom_protosw; /* protosw chain */
141 void (*dom_init) /* initialize domain data structures */
142 (struct domain *);
143 int (*dom_externalize) /* externalize access rights */
144 (struct mbuf *);
145 void (*dom_dispose) /* dispose of internalized rights */
146 (struct mbuf *);
147 int (*dom_rtattach) /* initialize routing table */
148 (void **, int);
149 int dom_rtoffset; /* an arg to rtattach, in bits */
150 int dom_maxrtkey; /* for routing layer */
151 int dom_protohdrlen; /* len of protocol header */
152 const char *dom_name;
153 struct domain_old *dom_old; /* domain pointer per net_add_domain */
154};
155
156extern TAILQ_HEAD(domains_head, domain) domains;
157extern struct domain *localdomain;
158#endif /* XNU_KERNEL_PRIVATE */
159
160/*
161 * Values for dom_flags
162 */
163#define DOM_REENTRANT 0x1
164#ifdef BSD_KERNEL_PRIVATE
165#define DOM_INITIALIZED 0x2 /* domain has been initialized */
166#define DOM_ATTACHED 0x4 /* domain is in the global list */
167#define DOM_OLD 0x10000000 /* domain added via net_add_domain */
168
169/* pseudo-public domain flags */
170#define DOMF_USERFLAGS (DOM_REENTRANT)
171#endif /* BSD_KERNEL_PRIVATE */
172
173__BEGIN_DECLS
174#ifdef XNU_KERNEL_PRIVATE
175extern void net_add_domain_old(struct domain_old *dp);
176extern int net_del_domain_old(struct domain_old *);
177extern void net_drain_domains(void);
178extern void domain_proto_mtx_lock_assert_held(void);
179extern void domain_proto_mtx_lock_assert_notheld(void);
180struct domain_guard;
181typedef const struct domain_guard *domain_guard_t;
182extern domain_guard_t domain_guard_deploy(void);
183extern void domain_guard_release(domain_guard_t);
184struct domain_unguard;
185typedef const struct domain_unguard *domain_unguard_t;
186extern domain_unguard_t domain_unguard_deploy(void);
187extern void domain_unguard_release(domain_unguard_t);
188extern struct domain_old *pffinddomain_old(int);
189extern struct domain *pffinddomain(int) __XNU_INTERNAL(pffinddomain);
190#else
191extern void net_add_domain(struct domain *dp);
192extern int net_del_domain(struct domain *);
193extern struct domain *pffinddomain(int);
194#endif /* XNU_KERNEL_PRIVATE */
195__END_DECLS
196#endif /* KERNEL_PRIVATE */
197#endif /* PRIVATE */
198#endif /* _SYS_DOMAIN_H_ */
199