21be456f5095a4759c6ca262c7e4d6b22c0234a0
[dragonfly.git] / sys / netinet / in_var.h
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  * $FreeBSD: src/sys/netinet/in_var.h,v 1.33.2.3 2001/12/14 20:09:34 jlemon Exp $
35  * $DragonFly: src/sys/netinet/in_var.h,v 1.16 2008/10/26 07:11:28 sephe Exp $
36  */
37
38 #ifndef _NETINET_IN_VAR_H_
39 #define _NETINET_IN_VAR_H_
40
41 #ifndef _SYS_QUEUE_H_
42 #include <sys/queue.h>
43 #endif
44 #ifndef _SYS_FNV_HASH_H_
45 #include <sys/fnv_hash.h>
46 #endif
47 #ifndef _NET_IF_VAR_H_
48 #include <net/if_var.h>
49 #endif
50 #ifndef _NETINET_IN_H_
51 #include <netinet/in.h>
52 #endif
53
54 /*
55  * Interface address, Internet version.  One of these structures
56  * is allocated for each Internet address on an interface.
57  * The ifaddr structure contains the protocol-independent part
58  * of the structure and is assumed to be first.
59  */
60 struct in_ifaddr {
61         struct  ifaddr ia_ifa;          /* protocol-independent info */
62 #define ia_ifp          ia_ifa.ifa_ifp
63 #define ia_flags        ia_ifa.ifa_flags
64                                         /* ia_{,sub}net{,mask} in host order */
65         u_long  ia_net;                 /* network number of interface */
66         u_long  ia_netmask;             /* mask of net part */
67         u_long  ia_subnet;              /* subnet number, including net */
68         u_long  ia_subnetmask;          /* mask of subnet part */
69         struct  in_addr ia_netbroadcast; /* to recognize net broadcasts */
70         void    *ia_pad1[2];
71         void    *ia_pad2[2];
72         struct  sockaddr_in ia_addr;    /* reserve space for interface name */
73         struct  sockaddr_in ia_dstaddr; /* reserve space for broadcast addr */
74 #define ia_broadaddr    ia_dstaddr
75         struct  sockaddr_in ia_sockmask; /* reserve space for general netmask */
76 };
77
78 struct  in_aliasreq {
79         char    ifra_name[IFNAMSIZ];            /* if name, e.g. "en0" */
80         struct  sockaddr_in ifra_addr;
81         struct  sockaddr_in ifra_broadaddr;
82 #define ifra_dstaddr ifra_broadaddr
83         struct  sockaddr_in ifra_mask;
84 };
85 /*
86  * Given a pointer to an in_ifaddr (ifaddr),
87  * return a pointer to the addr as a sockaddr_in.
88  */
89 #define IA_SIN(ia)    (&(((struct in_ifaddr *)(ia))->ia_addr))
90 #define IA_DSTSIN(ia) (&(((struct in_ifaddr *)(ia))->ia_dstaddr))
91
92 #define IN_LNAOF(in, ifa) \
93         ((ntohl((in).s_addr) & ~((struct in_ifaddr *)(ifa)->ia_subnetmask))
94
95
96 #ifdef  _KERNEL
97 struct in_ifaddr_container;
98
99 #define IA_PRF_RTEXISTOK        IFA_PRF_FLAG0   /* don't fail even if rtentry
100                                                  * already exist */
101
102 extern  struct  in_addr zeroin_addr;
103 extern  u_char  inetctlerrmap[];
104
105 /*
106  * Hash table for IP addresses.
107  */
108 extern  LIST_HEAD(in_ifaddrhashhead, in_ifaddr_container) *in_ifaddrhashtbls[];
109 extern  TAILQ_HEAD(in_ifaddrhead, in_ifaddr_container) in_ifaddrheads[];
110 extern  u_long in_ifaddrhmask;                  /* mask for hash table */
111
112 #define INADDR_NHASH_LOG2       9
113 #define INADDR_NHASH            (1 << INADDR_NHASH_LOG2)
114 #define INADDR_HASHVAL(x)       fnv_32_buf((&(x)), sizeof(x), FNV1_32_INIT)
115 #define INADDR_HASH(x) \
116         (&in_ifaddrhashtbls[mycpuid][INADDR_HASHVAL(x) & in_ifaddrhmask])
117
118
119 /*
120  * Function for finding the interface (ifnet structure) corresponding to one
121  * of our IP addresses.
122  */
123 static __inline struct ifnet *
124 INADDR_TO_IFP(const struct in_addr *_addr)
125 {
126         struct in_ifaddr_container *_iac;
127
128         LIST_FOREACH(_iac, INADDR_HASH(_addr->s_addr), ia_hash) {
129                 if (IA_SIN(_iac->ia)->sin_addr.s_addr == _addr->s_addr)
130                         return _iac->ia->ia_ifp;
131         }
132         return NULL;
133 }
134
135 /*
136  * Function for finding the internet address structure (in_ifaddr) corresponding
137  * to a given interface (ifnet structure).
138  */
139 static __inline struct in_ifaddr *
140 IFP_TO_IA(const struct ifnet *_ifp)
141 {
142         struct in_ifaddr_container *_iac;
143
144         TAILQ_FOREACH(_iac, &in_ifaddrheads[mycpuid], ia_link)
145                 if (_iac->ia->ia_ifp == _ifp)
146                         return _iac->ia;
147         return NULL;
148 }
149
150 #endif  /* _KERNEL */
151
152 /*
153  * This information should be part of the ifnet structure but we don't wish
154  * to change that - as it might break a number of things
155  */
156
157 struct router_info {
158         struct ifnet *rti_ifp;
159         int    rti_type; /* type of router which is querier on this interface */
160         int    rti_time; /* # of slow timeouts since last old query */
161         struct router_info *rti_next;
162 };
163
164 /*
165  * Internet multicast address structure.  There is one of these for each IP
166  * multicast group to which this host belongs on a given network interface.
167  * For every entry on the interface's if_multiaddrs list which represents
168  * an IP multicast group, there is one of these structures.  They are also
169  * kept on a system-wide list to make it easier to keep our legacy IGMP code
170  * compatible with the rest of the world (see IN_FIRST_MULTI et al, below).
171  */
172 struct in_multi {
173         LIST_ENTRY(in_multi) inm_link;  /* queue macro glue */
174         struct  in_addr inm_addr;       /* IP multicast address, convenience */
175         struct  ifnet *inm_ifp;         /* back pointer to ifnet */
176         struct  ifmultiaddr *inm_ifma;  /* back pointer to ifmultiaddr */
177         u_int   inm_timer;              /* IGMP membership report timer */
178         u_int   inm_state;              /*  state of the membership */
179         struct  router_info *inm_rti;   /* router info*/
180 };
181
182 #ifdef _KERNEL
183
184 #ifdef SYSCTL_DECL
185 SYSCTL_DECL(_net_inet_ip);
186 SYSCTL_DECL(_net_inet_raw);
187 #endif
188
189 extern LIST_HEAD(in_multihead, in_multi) in_multihead;
190
191 /*
192  * Structure used by macros below to remember position when stepping through
193  * all of the in_multi records.
194  */
195 struct in_multistep {
196         struct in_multi *i_inm;
197 };
198
199 /*
200  * Macro for looking up the in_multi record for a given IP multicast address
201  * on a given interface.  If no matching record is found, "inm" is set null.
202  */
203 #define IN_LOOKUP_MULTI(addr, ifp, inm) \
204         /* struct in_addr addr; */ \
205         /* struct ifnet *ifp; */ \
206         /* struct in_multi *inm; */ \
207 do { \
208         struct ifmultiaddr *ifma; \
209 \
210         LIST_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                         break; \
215         } \
216         (inm) = ifma ? ifma->ifma_protospec : 0; \
217 } while(0)
218
219 /*
220  * Macro to step through all of the in_multi records, one at a time.
221  * The current position is remembered in "step", which the caller must
222  * provide.  IN_FIRST_MULTI(), below, must be called to initialize "step"
223  * and get the first record.  Both macros return a NULL "inm" when there
224  * are no remaining records.
225  */
226 #define IN_NEXT_MULTI(step, inm) \
227         /* struct in_multistep  step; */ \
228         /* struct in_multi *inm; */ \
229 do { \
230         if (((inm) = (step).i_inm) != NULL) \
231                 (step).i_inm = LIST_NEXT((step).i_inm, inm_link); \
232 } while(0)
233
234 #define IN_FIRST_MULTI(step, inm) \
235         /* struct in_multistep step; */ \
236         /* struct in_multi *inm; */ \
237 do { \
238         (step).i_inm = LIST_FIRST(&in_multihead); \
239         IN_NEXT_MULTI((step), (inm)); \
240 } while(0)
241
242 struct  route;
243 struct  netmsg;
244 struct  lwkt_serialize;
245
246 void    in_ifdetach(struct ifnet *ifp);
247 struct  in_multi *in_addmulti (struct in_addr *, struct ifnet *);
248 void    in_delmulti (struct in_multi *);
249 int     in_control (struct socket *, u_long, caddr_t, struct ifnet *,
250                         struct thread *);
251 void    in_rtqdrain (void);
252 void    ip_input (struct mbuf *);
253 void    ip_forward (struct mbuf *, boolean_t, struct sockaddr_in *);
254 int     in_ifadown (struct ifaddr *ifa, int);
255 void    in_ifscrub (struct ifnet *, struct in_ifaddr *);
256 void    in_iaunlink (struct in_ifaddr *);
257 void    in_iahash_insert (struct in_ifaddr *);
258 void    in_iahash_remove (struct in_ifaddr *);
259
260 #endif /* _KERNEL */
261
262 /* INET6 stuff */
263 #include <netinet6/in6_var.h>
264
265 #endif /* _NETINET_IN_VAR_H_ */