xref: /freebsd/sys/netinet/in_var.h (revision 17ee9d00bc1ae1e598c38f25826f861e4bc6c3ce)
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.1 (Berkeley) 6/10/93
34  * $Id: in_var.h,v 1.6 1994/09/06 22:42:20 wollman Exp $
35  */
36 
37 #ifndef _NETINET_IN_VAR_H_
38 #define _NETINET_IN_VAR_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_{,sub}net{,mask} in host order */
51 	u_long	ia_net;			/* network number of interface */
52 	u_long	ia_netmask;		/* mask of net part */
53 	u_long	ia_subnet;		/* subnet number, including net */
54 	u_long	ia_subnetmask;		/* mask of subnet part */
55 	struct	in_addr ia_netbroadcast; /* to recognize net broadcasts */
56 	struct	in_ifaddr *ia_next;	/* next in list of internet addresses */
57 	struct	sockaddr_in ia_addr;	/* reserve space for interface name */
58 	struct	sockaddr_in ia_dstaddr; /* reserve space for broadcast addr */
59 #define	ia_broadaddr	ia_dstaddr
60 	struct	sockaddr_in ia_sockmask; /* reserve space for general netmask */
61 	struct	in_multi *ia_multiaddrs; /* list of multicast addresses */
62 };
63 
64 struct	in_aliasreq {
65 	char	ifra_name[IFNAMSIZ];		/* if name, e.g. "en0" */
66 	struct	sockaddr_in ifra_addr;
67 	struct	sockaddr_in ifra_broadaddr;
68 #define ifra_dstaddr ifra_broadaddr
69 	struct	sockaddr_in ifra_mask;
70 };
71 /*
72  * Given a pointer to an in_ifaddr (ifaddr),
73  * return a pointer to the addr as a sockaddr_in.
74  */
75 #define IA_SIN(ia)    (&(((struct in_ifaddr *)(ia))->ia_addr))
76 #define IA_DSTSIN(ia) (&(((struct in_ifaddr *)(ia))->ia_dstaddr))
77 
78 #define IN_LNAOF(in, ifa) \
79 	((ntohl((in).s_addr) & ~((struct in_ifaddr *)(ifa)->ia_subnetmask))
80 
81 
82 #ifdef	KERNEL
83 extern	struct	in_ifaddr *in_ifaddr;
84 extern	struct	ifqueue	ipintrq;		/* ip packet input queue */
85 
86 /*
87  * Macro for finding the interface (ifnet structure) corresponding to one
88  * of our IP addresses.
89  */
90 #define INADDR_TO_IFP(addr, ifp) \
91 	/* struct in_addr addr; */ \
92 	/* struct ifnet *ifp; */ \
93 { \
94 	register struct in_ifaddr *ia; \
95 \
96 	for (ia = in_ifaddr; \
97 	    ia != NULL && ((ia->ia_ifp->if_flags & IFF_POINTOPOINT)? \
98 		IA_DSTSIN(ia):IA_SIN(ia))->sin_addr.s_addr != (addr).s_addr; \
99 	    ia = ia->ia_next) \
100 		 continue; \
101 	(ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \
102 }
103 
104 /*
105  * Macro for finding the internet address structure (in_ifaddr) corresponding
106  * to a given interface (ifnet structure).
107  */
108 #define IFP_TO_IA(ifp, ia) \
109 	/* struct ifnet *ifp; */ \
110 	/* struct in_ifaddr *ia; */ \
111 { \
112 	for ((ia) = in_ifaddr; \
113 	    (ia) != NULL && (ia)->ia_ifp != (ifp); \
114 	    (ia) = (ia)->ia_next) \
115 		continue; \
116 }
117 #endif
118 
119 /*
120  * This information should be part of the ifnet structure but we don't wish
121  * to change that - as it might break a number of things
122  */
123 
124 struct router_info {
125 	struct ifnet *ifp;
126 	int    type; /* type of router which is querier on this interface */
127 	int    time; /* # of slow timeouts since last old query */
128 	struct router_info *next;
129 };
130 
131 /*
132  * Internet multicast address structure.  There is one of these for each IP
133  * multicast group to which this host belongs on a given network interface.
134  * They are kept in a linked list, rooted in the interface's in_ifaddr
135  * structure.
136  */
137 struct in_multi {
138 	struct	in_addr inm_addr;	/* IP multicast address */
139 	struct	ifnet *inm_ifp;		/* back pointer to ifnet */
140 	struct	in_ifaddr *inm_ia;	/* back pointer to in_ifaddr */
141 	u_int	inm_refcount;		/* no. membership claims by sockets */
142 	u_int	inm_timer;		/* IGMP membership report timer */
143 	struct	in_multi *inm_next;	/* ptr to next multicast address */
144 	u_int	inm_state;		/*  state of the membership */
145 	struct	router_info *inm_rti;	/* router info*/
146 };
147 
148 #ifdef KERNEL
149 /*
150  * Structure used by macros below to remember position when stepping through
151  * all of the in_multi records.
152  */
153 struct in_multistep {
154 	struct in_ifaddr *i_ia;
155 	struct in_multi *i_inm;
156 };
157 
158 /*
159  * Macro for looking up the in_multi record for a given IP multicast address
160  * on a given interface.  If no matching record is found, "inm" returns NULL.
161  */
162 #define IN_LOOKUP_MULTI(addr, ifp, inm) \
163 	/* struct in_addr addr; */ \
164 	/* struct ifnet *ifp; */ \
165 	/* struct in_multi *inm; */ \
166 { \
167 	register struct in_ifaddr *ia; \
168 \
169 	IFP_TO_IA((ifp), ia); \
170 	if (ia == NULL) \
171 		(inm) = NULL; \
172 	else \
173 		for ((inm) = ia->ia_multiaddrs; \
174 		    (inm) != NULL && (inm)->inm_addr.s_addr != (addr).s_addr; \
175 		     (inm) = inm->inm_next) \
176 			 continue; \
177 }
178 
179 /*
180  * Macro to step through all of the in_multi records, one at a time.
181  * The current position is remembered in "step", which the caller must
182  * provide.  IN_FIRST_MULTI(), below, must be called to initialize "step"
183  * and get the first record.  Both macros return a NULL "inm" when there
184  * are no remaining records.
185  */
186 #define IN_NEXT_MULTI(step, inm) \
187 	/* struct in_multistep  step; */ \
188 	/* struct in_multi *inm; */ \
189 { \
190 	if (((inm) = (step).i_inm) != NULL) \
191 		(step).i_inm = (inm)->inm_next; \
192 	else \
193 		while ((step).i_ia != NULL) { \
194 			(inm) = (step).i_ia->ia_multiaddrs; \
195 			(step).i_ia = (step).i_ia->ia_next; \
196 			if ((inm) != NULL) { \
197 				(step).i_inm = (inm)->inm_next; \
198 				break; \
199 			} \
200 		} \
201 }
202 
203 #define IN_FIRST_MULTI(step, inm) \
204 	/* struct in_multistep step; */ \
205 	/* struct in_multi *inm; */ \
206 { \
207 	(step).i_ia = in_ifaddr; \
208 	(step).i_inm = NULL; \
209 	IN_NEXT_MULTI((step), (inm)); \
210 }
211 
212 int	in_ifinit __P((struct ifnet *,
213 	    struct in_ifaddr *, struct sockaddr_in *, int));
214 struct	in_multi *in_addmulti __P((struct in_addr *, struct ifnet *));
215 void	in_delmulti __P((struct in_multi *));
216 void	in_ifscrub __P((struct ifnet *, struct in_ifaddr *));
217 int	in_control __P((struct socket *, int, caddr_t, struct ifnet *));
218 
219 #endif
220 #endif
221