xref: /openbsd/sys/netinet/in_var.h (revision 78b63d65)
1 /*	$OpenBSD: in_var.h,v 1.4 2001/06/09 07:03:41 angelos Exp $	*/
2 /*	$NetBSD: in_var.h,v 1.16 1996/02/13 23:42:15 christos Exp $	*/
3 
4 /*
5  * Copyright (c) 1985, 1986, 1993
6  *	The Regents of the University of California.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *	This product includes software developed by the University of
19  *	California, Berkeley and its contributors.
20  * 4. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  *	@(#)in_var.h	8.1 (Berkeley) 6/10/93
37  */
38 
39 #ifndef _NETINET_IN_VAR_H_
40 #define _NETINET_IN_VAR_H_
41 
42 #include <sys/queue.h>
43 
44 /*
45  * Interface address, Internet version.  One of these structures
46  * is allocated for each interface with an Internet address.
47  * The ifaddr structure contains the protocol-independent part
48  * of the structure and is assumed to be first.
49  */
50 struct in_ifaddr {
51 	struct	ifaddr ia_ifa;		/* protocol-independent info */
52 #define	ia_ifp		ia_ifa.ifa_ifp
53 #define ia_flags	ia_ifa.ifa_flags
54 					/* ia_{,sub}net{,mask} in host order */
55 	u_int32_t ia_net;		/* network number of interface */
56 	u_int32_t ia_netmask;		/* mask of net part */
57 	u_int32_t ia_subnet;		/* subnet number, including net */
58 	u_int32_t ia_subnetmask;	/* mask of subnet part */
59 	struct	in_addr ia_netbroadcast; /* to recognize net broadcasts */
60 	TAILQ_ENTRY(in_ifaddr) ia_list;	/* list of internet addresses */
61 	struct	sockaddr_in ia_addr;	/* reserve space for interface name */
62 	struct	sockaddr_in ia_dstaddr;	/* reserve space for broadcast addr */
63 #define	ia_broadaddr	ia_dstaddr
64 	struct	sockaddr_in ia_sockmask; /* reserve space for general netmask */
65 	LIST_HEAD(, in_multi) ia_multiaddrs; /* list of multicast addresses */
66 };
67 
68 struct	in_aliasreq {
69 	char	ifra_name[IFNAMSIZ];		/* if name, e.g. "en0" */
70 	struct	sockaddr_in ifra_addr;
71 	struct	sockaddr_in ifra_dstaddr;
72 #define	ifra_broadaddr	ifra_dstaddr
73 	struct	sockaddr_in ifra_mask;
74 };
75 /*
76  * Given a pointer to an in_ifaddr (ifaddr),
77  * return a pointer to the addr as a sockaddr_in.
78  */
79 #define	IA_SIN(ia) (&(((struct in_ifaddr *)(ia))->ia_addr))
80 
81 
82 #ifdef	_KERNEL
83 TAILQ_HEAD(in_ifaddrhead, in_ifaddr);
84 extern	struct	in_ifaddrhead in_ifaddr;
85 extern	struct	ifqueue	ipintrq;		/* ip packet input queue */
86 extern	int	inetctlerrmap[];
87 void	in_socktrim __P((struct sockaddr_in *));
88 
89 
90 /*
91  * Macro for finding the interface (ifnet structure) corresponding to one
92  * of our IP addresses.
93  */
94 #define INADDR_TO_IFP(addr, ifp) \
95 	/* struct in_addr addr; */ \
96 	/* struct ifnet *ifp; */ \
97 { \
98 	register struct in_ifaddr *ia; \
99 \
100 	for (ia = in_ifaddr.tqh_first; \
101 	    ia != NULL && ia->ia_addr.sin_addr.s_addr != (addr).s_addr; \
102 	    ia = ia->ia_list.tqe_next) \
103 		 continue; \
104 	(ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \
105 }
106 
107 /*
108  * Macro for finding the internet address structure (in_ifaddr) corresponding
109  * to a given interface (ifnet structure).
110  */
111 #define IFP_TO_IA(ifp, ia) \
112 	/* struct ifnet *ifp; */ \
113 	/* struct in_ifaddr *ia; */ \
114 { \
115 	for ((ia) = in_ifaddr.tqh_first; \
116 	    (ia) != NULL && (ia)->ia_ifp != (ifp); \
117 	    (ia) = (ia)->ia_list.tqe_next) \
118 		continue; \
119 }
120 #endif
121 
122 /*
123  * Per-interface router version information.
124  */
125 struct router_info {
126 	struct	ifnet *rti_ifp;
127 	int	rti_type;	/* type of router on this interface */
128 	int	rti_age;	/* time since last v1 query */
129 	struct	router_info *rti_next;
130 };
131 
132 /*
133  * Internet multicast address structure.  There is one of these for each IP
134  * multicast group to which this host belongs on a given network interface.
135  * They are kept in a linked list, rooted in the interface's in_ifaddr
136  * structure.
137  */
138 struct in_multi {
139 	struct	in_addr inm_addr;	/* IP multicast address */
140 	struct	ifnet *inm_ifp;		/* back pointer to ifnet */
141 	struct	in_ifaddr *inm_ia;	/* back pointer to in_ifaddr */
142 	u_int	inm_refcount;		/* no. membership claims by sockets */
143 	u_int	inm_timer;		/* IGMP membership report timer */
144 	LIST_ENTRY(in_multi) inm_list;	/* list of multicast addresses */
145 	u_int	inm_state;		/* state of membership */
146 	struct	router_info *inm_rti;	/* router version info */
147 };
148 
149 #ifdef _KERNEL
150 /*
151  * Structure used by macros below to remember position when stepping through
152  * all of the in_multi records.
153  */
154 struct in_multistep {
155 	struct in_ifaddr *i_ia;
156 	struct in_multi *i_inm;
157 };
158 
159 /*
160  * Macro for looking up the in_multi record for a given IP multicast address
161  * on a given interface.  If no matching record is found, "inm" returns NULL.
162  */
163 #define IN_LOOKUP_MULTI(addr, ifp, inm) \
164 	/* struct in_addr addr; */ \
165 	/* struct ifnet *ifp; */ \
166 	/* struct in_multi *inm; */ \
167 { \
168 	register struct in_ifaddr *ia; \
169 \
170 	IFP_TO_IA((ifp), ia); \
171 	if (ia == NULL) \
172 		(inm) = NULL; \
173 	else \
174 		for ((inm) = ia->ia_multiaddrs.lh_first; \
175 		    (inm) != NULL && (inm)->inm_addr.s_addr != (addr).s_addr; \
176 		     (inm) = inm->inm_list.le_next) \
177 			 continue; \
178 }
179 
180 /*
181  * Macro to step through all of the in_multi records, one at a time.
182  * The current position is remembered in "step", which the caller must
183  * provide.  IN_FIRST_MULTI(), below, must be called to initialize "step"
184  * and get the first record.  Both macros return a NULL "inm" when there
185  * are no remaining records.
186  */
187 #define IN_NEXT_MULTI(step, inm) \
188 	/* struct in_multistep  step; */ \
189 	/* struct in_multi *inm; */ \
190 { \
191 	if (((inm) = (step).i_inm) != NULL) \
192 		(step).i_inm = (inm)->inm_list.le_next; \
193 	else \
194 		while ((step).i_ia != NULL) { \
195 			(inm) = (step).i_ia->ia_multiaddrs.lh_first; \
196 			(step).i_ia = (step).i_ia->ia_list.tqe_next; \
197 			if ((inm) != NULL) { \
198 				(step).i_inm = (inm)->inm_list.le_next; \
199 				break; \
200 			} \
201 		} \
202 }
203 
204 #define IN_FIRST_MULTI(step, inm) \
205 	/* struct in_multistep step; */ \
206 	/* struct in_multi *inm; */ \
207 { \
208 	(step).i_ia = in_ifaddr.tqh_first; \
209 	(step).i_inm = NULL; \
210 	IN_NEXT_MULTI((step), (inm)); \
211 }
212 
213 int	in_ifinit __P((struct ifnet *,
214 	    struct in_ifaddr *, struct sockaddr_in *, int));
215 struct	in_multi *in_addmulti __P((struct in_addr *, struct ifnet *));
216 void	in_delmulti __P((struct in_multi *));
217 void	in_ifscrub __P((struct ifnet *, struct in_ifaddr *));
218 int	in_control __P((struct socket *, u_long, caddr_t, struct ifnet *));
219 #endif
220 
221 
222 /* INET6 stuff */
223 #include <netinet6/in6_var.h>
224 
225 #endif /* _NETINET_IN_VAR_H_ */
226