2 .\" Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice(s), this list of conditions and the following disclaimer as
9 .\" the first lines of this file unmodified other than the possible
10 .\" addition of one or more copyright notices.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice(s), this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
15 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
16 .\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 .\" DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
19 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20 .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21 .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22 .\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
40 .Nd "network domain management"
47 .Fn domain_add "void *data"
49 .Fn domain_init "void *data"
51 .Fn pfctlinput "int cmd" "struct sockaddr *sa"
53 .Fn pffinddomain "int family"
55 .Fn pffindproto "int family" "int protocol" "int type"
57 .Fn pffindtype "int family" "int type"
61 Network protocols installed in the system are maintained within what
69 int dom_family; /* AF_xxx */
72 void (*dom_init) /* initialize domain data structures */
74 int (*dom_probe)(void); /* check for support (optional) */
75 void (*dom_destroy) /* cleanup structures / state */
77 int (*dom_externalize) /* externalize access rights */
78 (struct mbuf *, struct mbuf **);
79 void (*dom_dispose) /* dispose of internalized rights */
81 struct protosw *dom_protosw, *dom_protoswNPROTOSW;
82 struct domain *dom_next;
83 int (*dom_rtattach) /* initialize routing table */
85 int (*dom_rtdetach) /* clean up routing table */
87 void *(*dom_ifattach)(struct ifnet *);
88 void (*dom_ifdetach)(struct ifnet *, void *);
89 int (*dom_ifmtu)(struct ifnet *);
90 /* af-dependent data on ifnet */
94 Each domain contains an array of protocol switch structures
95 .Pq Vt "struct protosw *" ,
96 one for each socket type supported.
99 short pr_type; /* socket type used for */
100 struct domain *pr_domain; /* domain protocol a member of */
101 short pr_protocol; /* protocol number */
102 short pr_flags; /* see below */
103 /* protocol-protocol hooks */
104 pr_input_t *pr_input; /* input to protocol (from below) */
105 pr_output_t *pr_output; /* output to protocol (from above) */
106 pr_ctlinput_t *pr_ctlinput; /* control input (from below) */
107 pr_ctloutput_t *pr_ctloutput; /* control output (from above) */
110 pr_fasttimo_t *pr_fasttimo; /* fast timeout (200ms) */
111 pr_slowtimo_t *pr_slowtimo; /* slow timeout (500ms) */
112 pr_drain_t *pr_drain; /* flush any excess space possible */
114 struct pr_usrreqs *pr_usrreqs; /* user-protocol hook */
118 The following functions handle the registration of a new domain,
119 lookups of specific protocols and protocol types within those domains,
120 and handle control messages from the system.
123 is called by the system whenever an event occurs that could affect every
125 Examples of those types of events are routing table changes, interface
131 calls the protocol specific
133 function for each protocol in that has defined one, in every domain.
136 adds a new protocol domain to the system.
140 .Vt "struct domain *"
141 within the function, but is declared
143 in order to prevent compiler warnings when new domains are registered with
147 is not called directly, instead
151 If the new domain has defined a probe routine, it is called first in
153 to determine if the domain should be supported on the current system.
154 If the probe routine returns a non-0 value, then the domain will not be
156 Unsupported domains do not proceed with the initialization process and are not
166 during boot and for each
168 If the new domain has defined an initialization routine, it is called during
170 as well, each of the protocols within the domain that have defined an
171 initialization routine will have theirs called.
172 Note that domain initialization cannot fail at this time.
174 Once a domain is added it cannot be completely unloaded.
175 This is because there is
176 no reference counting system in place to determine if there are any
177 active references from sockets within that domain.
178 If the domain defines a
180 routine, then it will be invoked during vnet teardown.
183 finds a domain by family.
184 If the domain cannot be found,
191 look up a protocol by its number or by its type.
192 In most cases, if the protocol or type cannot be found,
196 may return the default if the requested type is
198 a protocol switch type of
200 is found, and the domain has a default raw protocol.
202 Both functions are called by
204 in order to resolve the protocol for the socket currently being created.
207 is a macro that simplifies the registration of a domain via
209 The code resulting from the macro expects there to be a domain structure
211 .Dq Fa name Ns Li domain
217 struct domain localdomain =
218 { AF_LOCAL, "local", unp_init, unp_externalize, unp_dispose,
219 localsw, &localsw[sizeof(localsw)/sizeof(localsw[0])] };
229 .Vt "struct protosw *"
230 for the protocol requested.
231 If the protocol or socket type is not found,
236 the default protocol may be returned for
238 types if the domain has a default raw protocol.
253 This manual page was written by
254 .An Chad David Aq Mt davidc@acns.ab.ca .