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