xref: /freebsd/sys/sys/domain.h (revision 289bee16be9c9e32451538fd5d31916b2a348947)
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 
32 #ifndef _SYS_DOMAIN_H_
33 #define _SYS_DOMAIN_H_
34 #include <sys/queue.h>
35 
36 /*
37  * Structure per communications domain.
38  */
39 
40 /*
41  * Forward structure declarations for function prototypes [sic].
42  */
43 struct	mbuf;
44 struct	ifnet;
45 struct	socket;
46 struct	rib_head;
47 
48 struct domain {
49 	SLIST_ENTRY(domain) dom_next;
50 	int	dom_family;		/* AF_xxx */
51 	u_int	dom_nprotosw;		/* length of dom_protosw[] */
52 	char	*dom_name;
53 	int	dom_flags;
54 	int	(*dom_probe)(void);	/* check for support (optional) */
55 	int	(*dom_externalize)	/* externalize access rights */
56 		(struct mbuf *, struct mbuf **, int);
57 	struct rib_head *(*dom_rtattach)	/* initialize routing table */
58 		(uint32_t);
59 	void	(*dom_rtdetach)		/* clean up routing table */
60 		(struct rib_head *);
61 	void	*(*dom_ifattach)(struct ifnet *);
62 	void	(*dom_ifdetach)(struct ifnet *, void *);
63 	int	(*dom_ifmtu)(struct ifnet *);
64 					/* af-dependent data on ifnet */
65 	struct	protosw *dom_protosw[];
66 };
67 
68 /* dom_flags */
69 #define	DOMF_UNLOADABLE	0x0004	/* Can be unloaded */
70 
71 #ifdef _KERNEL
72 extern int	domain_init_status;
73 extern SLIST_HEAD(domainhead, domain) domains;
74 void		domain_add(struct domain *);
75 void		domain_remove(struct domain *);
76 #ifdef VIMAGE
77 void		vnet_domain_init(void *);
78 void		vnet_domain_uninit(void *);
79 #endif
80 
81 #define	DOMAIN_SET(name)						\
82 	SYSINIT(domain_add_ ## name, SI_SUB_PROTO_DOMAIN,		\
83 	    SI_ORDER_FIRST, domain_add, & name ## domain);		\
84 	SYSUNINIT(domain_remove_ ## name, SI_SUB_PROTO_DOMAIN,		\
85 	    SI_ORDER_FIRST, domain_remove, & name ## domain);
86 #endif /* _KERNEL */
87 
88 #endif /* !_SYS_DOMAIN_H_ */
89