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