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