xref: /f-stack/freebsd/sys/domain.h (revision 22ce4aff)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1982, 1986, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  *	@(#)domain.h	8.1 (Berkeley) 6/2/93
32  * $FreeBSD$
33  */
34 
35 #ifndef _SYS_DOMAIN_H_
36 #define _SYS_DOMAIN_H_
37 
38 /*
39  * Structure per communications domain.
40  */
41 
42 /*
43  * Forward structure declarations for function prototypes [sic].
44  */
45 struct	mbuf;
46 struct	ifnet;
47 struct	socket;
48 struct	rib_head;
49 
50 struct domain {
51 	int	dom_family;		/* AF_xxx */
52 	char	*dom_name;
53 	void	(*dom_init)		/* initialize domain data structures */
54 		(void);
55 	void	(*dom_destroy)		/* cleanup structures / state */
56 		(void);
57 	int	(*dom_externalize)	/* externalize access rights */
58 		(struct mbuf *, struct mbuf **, int);
59 	void	(*dom_dispose)		/* dispose of internalized rights */
60 		(struct socket *);
61 	struct	protosw *dom_protosw, *dom_protoswNPROTOSW;
62 	struct	domain *dom_next;
63 	struct rib_head *(*dom_rtattach)	/* initialize routing table */
64 		(uint32_t);
65 	void	(*dom_rtdetach)		/* clean up routing table */
66 		(struct rib_head *);
67 	void	*(*dom_ifattach)(struct ifnet *);
68 	void	(*dom_ifdetach)(struct ifnet *, void *);
69 	int	(*dom_ifmtu)(struct ifnet *);
70 					/* af-dependent data on ifnet */
71 };
72 
73 #ifdef _KERNEL
74 extern int	domain_init_status;
75 extern struct	domain *domains;
76 void		domain_add(void *);
77 void		domain_init(void *);
78 #ifdef VIMAGE
79 void		vnet_domain_init(void *);
80 void		vnet_domain_uninit(void *);
81 #endif
82 
83 #define	DOMAIN_SET(name)						\
84 	SYSINIT(domain_add_ ## name, SI_SUB_PROTO_DOMAIN,		\
85 	    SI_ORDER_FIRST, domain_add, & name ## domain);		\
86 	SYSINIT(domain_init_ ## name, SI_SUB_PROTO_DOMAIN,		\
87 	    SI_ORDER_SECOND, domain_init, & name ## domain);
88 #ifdef VIMAGE
89 #define	VNET_DOMAIN_SET(name)						\
90 	SYSINIT(domain_add_ ## name, SI_SUB_PROTO_DOMAIN,		\
91 	    SI_ORDER_FIRST, domain_add, & name ## domain);		\
92 	VNET_SYSINIT(vnet_domain_init_ ## name, SI_SUB_PROTO_DOMAIN,	\
93 	    SI_ORDER_SECOND, vnet_domain_init, & name ## domain);	\
94 	VNET_SYSUNINIT(vnet_domain_uninit_ ## name,			\
95 	    SI_SUB_PROTO_DOMAIN, SI_ORDER_SECOND, vnet_domain_uninit,	\
96 	    & name ## domain)
97 #else /* !VIMAGE */
98 #define	VNET_DOMAIN_SET(name)	DOMAIN_SET(name)
99 #endif /* VIMAGE */
100 
101 #endif /* _KERNEL */
102 
103 #endif /* !_SYS_DOMAIN_H_ */
104