xref: /dragonfly/sys/netinet/in_var.h (revision 7485684fa5c3fadb6c7a1da0d8bb6ea5da4e0f2f)
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. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  *        @(#)in_var.h        8.2 (Berkeley) 1/9/95
30  * $FreeBSD: src/sys/netinet/in_var.h,v 1.33.2.3 2001/12/14 20:09:34 jlemon Exp $
31  */
32 
33 #ifndef _NETINET_IN_VAR_H_
34 #define _NETINET_IN_VAR_H_
35 
36 #ifndef _SYS_QUEUE_H_
37 #include <sys/queue.h>
38 #endif
39 #ifndef _NET_IF_VAR_H_
40 #include <net/if_var.h>
41 #endif
42 #ifndef _NETINET_IN_H_
43 #include <netinet/in.h>
44 #endif
45 
46 /*
47  * Interface address, Internet version.  One of these structures
48  * is allocated for each Internet address on an interface.
49  * The ifaddr structure contains the protocol-independent part
50  * of the structure and is assumed to be first.
51  */
52 struct in_ifaddr {
53           struct    ifaddr ia_ifa;                /* protocol-independent info */
54 #define   ia_ifp              ia_ifa.ifa_ifp
55 #define   ia_flags  ia_ifa.ifa_flags
56                                                   /* ia_{,sub}net{,mask} in host order */
57           u_long    ia_net;                       /* network number of interface */
58           u_long    ia_netmask;                   /* mask of net part */
59           u_long    ia_subnet;                    /* subnet number, including net */
60           u_long    ia_subnetmask;                /* mask of subnet part */
61           struct    in_addr ia_netbroadcast; /* to recognize net broadcasts */
62           void      *ia_pad1[2];
63           void      *ia_pad2[2];
64           struct    sockaddr_in ia_addr;          /* reserve space for interface name */
65           struct    sockaddr_in ia_dstaddr; /* reserve space for broadcast addr */
66 #define   ia_broadaddr        ia_dstaddr
67           struct    sockaddr_in ia_sockmask; /* reserve space for general netmask */
68 };
69 
70 struct in_aliasreq {
71           char      ifra_name[IFNAMSIZ];                    /* if name, e.g. "en0" */
72           struct    sockaddr_in ifra_addr;
73           struct    sockaddr_in ifra_broadaddr;
74 #define   ifra_dstaddr        ifra_broadaddr
75           struct    sockaddr_in ifra_mask;
76 };
77 
78 /*
79  * Given a pointer to an in_ifaddr (ifaddr),
80  * return a pointer to the addr as a sockaddr_in.
81  */
82 #define IA_SIN(ia)    (&(((struct in_ifaddr *)(ia))->ia_addr))
83 #if 0
84 #define IA_DSTSIN(ia) (&(((struct in_ifaddr *)(ia))->ia_dstaddr))
85 
86 #define IN_LNAOF(in, ifa) \
87           ((ntohl((in).s_addr) & ~((struct in_ifaddr *)(ifa)->ia_subnetmask))
88 #endif
89 
90 
91 #ifdef _KERNEL
92 #include <sys/fnv_hash.h>
93 
94 struct in_ifaddr_container;
95 
96 extern    struct    in_addr zeroin_addr;
97 extern    u_char    inetctlerrmap[];
98 
99 /*
100  * Hash table for IP addresses.
101  */
102 extern    LIST_HEAD(in_ifaddrhashhead, in_ifaddr_container) *in_ifaddrhashtbls[];
103 extern    TAILQ_HEAD(in_ifaddrhead, in_ifaddr_container) in_ifaddrheads[];
104 extern    u_long in_ifaddrhmask;                            /* mask for hash table */
105 
106 #define INADDR_NHASH_LOG2       9
107 #define INADDR_NHASH                    (1 << INADDR_NHASH_LOG2)
108 #define INADDR_HASHVAL(x)     fnv_32_buf((&(x)), sizeof(x), FNV1_32_INIT)
109 #define INADDR_HASH(x) \
110           (&in_ifaddrhashtbls[mycpuid][INADDR_HASHVAL(x) & in_ifaddrhmask])
111 
112 
113 /*
114  * Function for finding the interface (ifnet structure) corresponding to one
115  * of our IP addresses.
116  */
117 static __inline struct ifnet *
INADDR_TO_IFP(const struct in_addr * _addr)118 INADDR_TO_IFP(const struct in_addr *_addr)
119 {
120           struct in_ifaddr_container *_iac;
121 
122           LIST_FOREACH(_iac, INADDR_HASH(_addr->s_addr), ia_hash) {
123                     if (IA_SIN(_iac->ia)->sin_addr.s_addr == _addr->s_addr)
124                               return _iac->ia->ia_ifp;
125           }
126           return NULL;
127 }
128 
129 /*
130  * Function for finding the internet address structure (in_ifaddr) corresponding
131  * to a given interface (ifnet structure).
132  */
133 static __inline struct in_ifaddr *
IFP_TO_IA(const struct ifnet * _ifp)134 IFP_TO_IA(const struct ifnet *_ifp)
135 {
136           struct in_ifaddr_container *_iac;
137 
138           TAILQ_FOREACH(_iac, &in_ifaddrheads[mycpuid], ia_link)
139                     if (_iac->ia->ia_ifp == _ifp)
140                               return _iac->ia;
141           return NULL;
142 }
143 
144 #endif    /* _KERNEL */
145 
146 #ifdef _KERNEL
147 /*
148  * This information should be part of the ifnet structure but we don't wish
149  * to change that - as it might break a number of things
150  */
151 
152 struct router_info {
153           struct ifnet *rti_ifp;
154           int    rti_type; /* type of router which is querier on this interface */
155           int    rti_time; /* # of slow timeouts since last old query */
156           struct router_info *rti_next;
157 };
158 
159 /*
160  * Internet multicast address structure.  There is one of these for each IP
161  * multicast group to which this host belongs on a given network interface.
162  * For every entry on the interface's if_multiaddrs list which represents
163  * an IP multicast group, there is one of these structures.  They are also
164  * kept on a system-wide list to make it easier to keep our legacy IGMP code
165  * compatible with the rest of the world (see IN_FIRST_MULTI et al, below).
166  */
167 struct in_multi {
168           LIST_ENTRY(in_multi) inm_link;          /* queue macro glue */
169           struct    in_addr inm_addr;   /* IP multicast address, convenience */
170           struct    ifnet *inm_ifp;               /* back pointer to ifnet */
171           struct    ifmultiaddr *inm_ifma;        /* back pointer to ifmultiaddr */
172           u_int     inm_timer;                    /* IGMP membership report timer */
173           u_int     inm_state;                    /*  state of the membership */
174           struct    router_info *inm_rti;         /* router info*/
175 };
176 #endif    /* _KERNEL */
177 
178 #ifdef _KERNEL
179 
180 #ifdef SYSCTL_DECL
181 SYSCTL_DECL(_net_inet_ip);
182 SYSCTL_DECL(_net_inet_raw);
183 #endif
184 
185 extern LIST_HEAD(in_multihead, in_multi) in_multihead;
186 
187 /*
188  * Structure used by macros below to remember position when stepping through
189  * all of the in_multi records.
190  */
191 struct in_multistep {
192           struct in_multi *i_inm;
193 };
194 
195 /*
196  * Look up the in_multi record for a given IP multicast address on a given
197  * interface.  If no matching record is found, NULL is returned.
198  */
199 static __inline struct in_multi *
IN_LOOKUP_MULTI(const struct in_addr * _addr,struct ifnet * _ifp)200 IN_LOOKUP_MULTI(const struct in_addr *_addr, struct ifnet *_ifp)
201 {
202           const struct ifmultiaddr *_ifma;
203           struct in_multi *_inm = NULL;
204 
205           if (_ifp == NULL)
206                     return NULL;
207 
208           /* TODO: need ifnet_serialize_main */
209           ifnet_serialize_all(_ifp);
210           TAILQ_FOREACH(_ifma, &_ifp->if_multiaddrs, ifma_link) {
211                     if (_ifma->ifma_addr->sa_family == AF_INET &&
212                         ((struct sockaddr_in *)_ifma->ifma_addr)->sin_addr.s_addr ==
213                         _addr->s_addr) {
214                               _inm = _ifma->ifma_protospec;
215                               break;
216                     }
217           }
218           ifnet_deserialize_all(_ifp);
219 
220           return _inm;
221 }
222 
223 /*
224  * Macro to step through all of the in_multi records, one at a time.
225  * The current position is remembered in "step", which the caller must
226  * provide.  IN_FIRST_MULTI(), below, must be called to initialize "step"
227  * and get the first record.  Both macros return a NULL "inm" when there
228  * are no remaining records.
229  */
230 #define IN_NEXT_MULTI(step, inm) \
231           /* struct in_multistep step; */ \
232           /* struct in_multi *inm; */ \
233 do { \
234           if (((inm) = (step).i_inm) != NULL) \
235                     (step).i_inm = LIST_NEXT((step).i_inm, inm_link); \
236 } while(0)
237 
238 #define IN_FIRST_MULTI(step, inm) \
239           /* struct in_multistep step; */ \
240           /* struct in_multi *inm; */ \
241 do { \
242           (step).i_inm = LIST_FIRST(&in_multihead); \
243           IN_NEXT_MULTI((step), (inm)); \
244 } while(0)
245 
246 struct    route;
247 struct    lwkt_serialize;
248 union     netmsg;
249 
250 void      in_ifdetach(struct ifnet *ifp);
251 void      in_if_down(struct ifnet *ifp);
252 struct    in_multi *in_addmulti (struct in_addr *, struct ifnet *);
253 void      in_delmulti (struct in_multi *);
254 int       in_control (u_long, caddr_t, struct ifnet *, struct thread *);
255 void      in_control_dispatch(union netmsg *);
256 void      in_rtqdrain (void);
257 void      ip_input (struct mbuf *);
258 void      ip_forward (struct mbuf *, boolean_t, struct sockaddr_in *);
259 int       in_ifadown (struct ifaddr *ifa, int);
260 int       in_ifadown_force (struct ifaddr *ifa, int);
261 void      in_ifscrub (struct ifnet *, struct in_ifaddr *);
262 void      in_iaunlink (struct in_ifaddr *);
263 void      in_iahash_insert (struct in_ifaddr *);
264 void      in_iahash_remove (struct in_ifaddr *);
265 
266 #endif /* _KERNEL */
267 
268 /* INET6 stuff */
269 #include <netinet6/in6_var.h>
270 
271 #endif /* _NETINET_IN_VAR_H_ */
272