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