xref: /freebsd/sys/netinet/in_var.h (revision afe61c15161c324a7af299a9b8457aba5afc92db)
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  */
35 
36 /*
37  * Interface address, Internet version.  One of these structures
38  * is allocated for each interface with an Internet address.
39  * The ifaddr structure contains the protocol-independent part
40  * of the structure and is assumed to be first.
41  */
42 struct in_ifaddr {
43 	struct	ifaddr ia_ifa;		/* protocol-independent info */
44 #define	ia_ifp		ia_ifa.ifa_ifp
45 #define ia_flags	ia_ifa.ifa_flags
46 					/* ia_{,sub}net{,mask} in host order */
47 	u_long	ia_net;			/* network number of interface */
48 	u_long	ia_netmask;		/* mask of net part */
49 	u_long	ia_subnet;		/* subnet number, including net */
50 	u_long	ia_subnetmask;		/* mask of subnet part */
51 	struct	in_addr ia_netbroadcast; /* to recognize net broadcasts */
52 	struct	in_ifaddr *ia_next;	/* next in list of internet addresses */
53 	struct	sockaddr_in ia_addr;	/* reserve space for interface name */
54 	struct	sockaddr_in ia_dstaddr; /* reserve space for broadcast addr */
55 #define	ia_broadaddr	ia_dstaddr
56 	struct	sockaddr_in ia_sockmask; /* reserve space for general netmask */
57 	struct	in_multi *ia_multiaddrs; /* list of multicast addresses */
58 };
59 
60 struct	in_aliasreq {
61 	char	ifra_name[IFNAMSIZ];		/* if name, e.g. "en0" */
62 	struct	sockaddr_in ifra_addr;
63 	struct	sockaddr_in ifra_broadaddr;
64 #define ifra_dstaddr ifra_broadaddr
65 	struct	sockaddr_in ifra_mask;
66 };
67 /*
68  * Given a pointer to an in_ifaddr (ifaddr),
69  * return a pointer to the addr as a sockaddr_in.
70  */
71 #define	IA_SIN(ia) (&(((struct in_ifaddr *)(ia))->ia_addr))
72 
73 #define IN_LNAOF(in, ifa) \
74 	((ntohl((in).s_addr) & ~((struct in_ifaddr *)(ifa)->ia_subnetmask))
75 
76 
77 #ifdef	KERNEL
78 extern	struct	in_ifaddr *in_ifaddr;
79 extern	struct	ifqueue	ipintrq;		/* ip packet input queue */
80 void	in_socktrim __P((struct sockaddr_in *));
81 
82 
83 /*
84  * Macro for finding the interface (ifnet structure) corresponding to one
85  * of our IP addresses.
86  */
87 #define INADDR_TO_IFP(addr, ifp) \
88 	/* struct in_addr addr; */ \
89 	/* struct ifnet *ifp; */ \
90 { \
91 	register struct in_ifaddr *ia; \
92 \
93 	for (ia = in_ifaddr; \
94 	    ia != NULL && IA_SIN(ia)->sin_addr.s_addr != (addr).s_addr; \
95 	    ia = ia->ia_next) \
96 		 continue; \
97 	(ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \
98 }
99 
100 /*
101  * Macro for finding the internet address structure (in_ifaddr) corresponding
102  * to a given interface (ifnet structure).
103  */
104 #define IFP_TO_IA(ifp, ia) \
105 	/* struct ifnet *ifp; */ \
106 	/* struct in_ifaddr *ia; */ \
107 { \
108 	for ((ia) = in_ifaddr; \
109 	    (ia) != NULL && (ia)->ia_ifp != (ifp); \
110 	    (ia) = (ia)->ia_next) \
111 		continue; \
112 }
113 #endif
114 
115 /*
116  * Internet multicast address structure.  There is one of these for each IP
117  * multicast group to which this host belongs on a given network interface.
118  * They are kept in a linked list, rooted in the interface's in_ifaddr
119  * structure.
120  */
121 struct in_multi {
122 	struct	in_addr inm_addr;	/* IP multicast address */
123 	struct	ifnet *inm_ifp;		/* back pointer to ifnet */
124 	struct	in_ifaddr *inm_ia;	/* back pointer to in_ifaddr */
125 	u_int	inm_refcount;		/* no. membership claims by sockets */
126 	u_int	inm_timer;		/* IGMP membership report timer */
127 	struct	in_multi *inm_next;	/* ptr to next multicast address */
128 };
129 
130 #ifdef KERNEL
131 /*
132  * Structure used by macros below to remember position when stepping through
133  * all of the in_multi records.
134  */
135 struct in_multistep {
136 	struct in_ifaddr *i_ia;
137 	struct in_multi *i_inm;
138 };
139 
140 /*
141  * Macro for looking up the in_multi record for a given IP multicast address
142  * on a given interface.  If no matching record is found, "inm" returns NULL.
143  */
144 #define IN_LOOKUP_MULTI(addr, ifp, inm) \
145 	/* struct in_addr addr; */ \
146 	/* struct ifnet *ifp; */ \
147 	/* struct in_multi *inm; */ \
148 { \
149 	register struct in_ifaddr *ia; \
150 \
151 	IFP_TO_IA((ifp), ia); \
152 	if (ia == NULL) \
153 		(inm) = NULL; \
154 	else \
155 		for ((inm) = ia->ia_multiaddrs; \
156 		    (inm) != NULL && (inm)->inm_addr.s_addr != (addr).s_addr; \
157 		     (inm) = inm->inm_next) \
158 			 continue; \
159 }
160 
161 /*
162  * Macro to step through all of the in_multi records, one at a time.
163  * The current position is remembered in "step", which the caller must
164  * provide.  IN_FIRST_MULTI(), below, must be called to initialize "step"
165  * and get the first record.  Both macros return a NULL "inm" when there
166  * are no remaining records.
167  */
168 #define IN_NEXT_MULTI(step, inm) \
169 	/* struct in_multistep  step; */ \
170 	/* struct in_multi *inm; */ \
171 { \
172 	if (((inm) = (step).i_inm) != NULL) \
173 		(step).i_inm = (inm)->inm_next; \
174 	else \
175 		while ((step).i_ia != NULL) { \
176 			(inm) = (step).i_ia->ia_multiaddrs; \
177 			(step).i_ia = (step).i_ia->ia_next; \
178 			if ((inm) != NULL) { \
179 				(step).i_inm = (inm)->inm_next; \
180 				break; \
181 			} \
182 		} \
183 }
184 
185 #define IN_FIRST_MULTI(step, inm) \
186 	/* struct in_multistep step; */ \
187 	/* struct in_multi *inm; */ \
188 { \
189 	(step).i_ia = in_ifaddr; \
190 	(step).i_inm = NULL; \
191 	IN_NEXT_MULTI((step), (inm)); \
192 }
193 
194 int	in_ifinit __P((struct ifnet *,
195 	    struct in_ifaddr *, struct sockaddr_in *, int));
196 struct	in_multi *in_addmulti __P((struct in_addr *, struct ifnet *));
197 void	in_delmulti __P((struct in_multi *));
198 void	in_ifscrub __P((struct ifnet *, struct in_ifaddr *));
199 int	in_control __P((struct socket *, int, caddr_t, struct ifnet *));
200 #endif
201