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  */
  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  * Given a pointer to an in_ifaddr (ifaddr),
  79  * return a pointer to the addr as a sockaddr_in.
  80  */
  81 #define IA_SIN(ia)    (&(((struct in_ifaddr *)(ia))->ia_addr))
  82 #if 0
  83 #define IA_DSTSIN(ia) (&(((struct in_ifaddr *)(ia))->ia_dstaddr))
  84
  85 #define IN_LNAOF(in, ifa) \
  86         ((ntohl((in).s_addr) & ~((struct in_ifaddr *)(ifa)->ia_subnetmask))
  87 #endif
  88
  89
  90 #ifdef _KERNEL
  91 #include <sys/fnv_hash.h>
  92
  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 #ifdef _KERNEL
 146 /*
 147  * This information should be part of the ifnet structure but we don't wish
 148  * to change that - as it might break a number of things
 149  */
 150
 151 struct router_info {
 152         struct ifnet *rti_ifp;
 153         int    rti_type; /* type of router which is querier on this interface */
 154         int    rti_time; /* # of slow timeouts since last old query */
 155         struct router_info *rti_next;
 156 };
 157
 158 /*
 159  * Internet multicast address structure.  There is one of these for each IP
 160  * multicast group to which this host belongs on a given network interface.
 161  * For every entry on the interface's if_multiaddrs list which represents
 162  * an IP multicast group, there is one of these structures.  They are also
 163  * kept on a system-wide list to make it easier to keep our legacy IGMP code
 164  * compatible with the rest of the world (see IN_FIRST_MULTI et al, below).
 165  */
 166 struct in_multi {
 167         LIST_ENTRY(in_multi) inm_link;  /* queue macro glue */
 168         struct  in_addr inm_addr;       /* IP multicast address, convenience */
 169         struct  ifnet *inm_ifp;         /* back pointer to ifnet */
 170         struct  ifmultiaddr *inm_ifma;  /* back pointer to ifmultiaddr */
 171         u_int   inm_timer;              /* IGMP membership report timer */
 172         u_int   inm_state;              /*  state of the membership */
 173         struct  router_info *inm_rti;   /* router info*/
 174 };
 175 #endif  /* _KERNEL */
 176
 177 #ifdef _KERNEL
 178
 179 #ifdef SYSCTL_DECL
 180 SYSCTL_DECL(_net_inet_ip);
 181 SYSCTL_DECL(_net_inet_raw);
 182 #endif
 183
 184 extern LIST_HEAD(in_multihead, in_multi) in_multihead;
 185
 186 /*
 187  * Structure used by macros below to remember position when stepping through
 188  * all of the in_multi records.
 189  */
 190 struct in_multistep {
 191         struct in_multi *i_inm;
 192 };
 193
 194 /*
 195  * Look up the in_multi record for a given IP multicast address on a given
 196  * interface.  If no matching record is found, NULL is returned.
 197  */
 198 static __inline struct in_multi *
 199 IN_LOOKUP_MULTI(const struct in_addr *_addr, struct ifnet *_ifp)
 200 {
 201         const struct ifmultiaddr *_ifma;
 202         struct in_multi *_inm = NULL;
 203
 204         if (_ifp == NULL)
 205                 return NULL;
 206
 207         /* TODO: need ifnet_serialize_main */
 208         ifnet_serialize_all(_ifp);
 209         TAILQ_FOREACH(_ifma, &_ifp->if_multiaddrs, ifma_link) {
 210                 if (_ifma->ifma_addr->sa_family == AF_INET &&
 211                     ((struct sockaddr_in *)_ifma->ifma_addr)->sin_addr.s_addr ==
 212                     _addr->s_addr) {
 213                         _inm = _ifma->ifma_protospec;
 214                         break;
 215                 }
 216         }
 217         ifnet_deserialize_all(_ifp);
 218
 219         return _inm;
 220 }
 221
 222 /*
 223  * Macro to step through all of the in_multi records, one at a time.
 224  * The current position is remembered in "step", which the caller must
 225  * provide.  IN_FIRST_MULTI(), below, must be called to initialize "step"
 226  * and get the first record.  Both macros return a NULL "inm" when there
 227  * are no remaining records.
 228  */
 229 #define IN_NEXT_MULTI(step, inm) \
 230         /* struct in_multistep  step; */ \
 231         /* struct in_multi *inm; */ \
 232 do { \
 233         if (((inm) = (step).i_inm) != NULL) \
 234                 (step).i_inm = LIST_NEXT((step).i_inm, inm_link); \
 235 } while(0)
 236
 237 #define IN_FIRST_MULTI(step, inm) \
 238         /* struct in_multistep step; */ \
 239         /* struct in_multi *inm; */ \
 240 do { \
 241         (step).i_inm = LIST_FIRST(&in_multihead); \
 242         IN_NEXT_MULTI((step), (inm)); \
 243 } while(0)
 244
 245 struct  route;
 246 struct  lwkt_serialize;
 247 union   netmsg;
 248
 249 void    in_ifdetach(struct ifnet *ifp);
 250 void    in_if_down(struct ifnet *ifp);
 251 struct  in_multi *in_addmulti (struct in_addr *, struct ifnet *);
 252 void    in_delmulti (struct in_multi *);
 253 int     in_control (u_long, caddr_t, struct ifnet *, struct thread *);
 254 void    in_control_dispatch(union netmsg *);
 255 void    in_rtqdrain (void);
 256 void    ip_input (struct mbuf *);
 257 void    ip_forward (struct mbuf *, boolean_t, struct sockaddr_in *);
 258 int     in_ifadown (struct ifaddr *ifa, int);
 259 int     in_ifadown_force (struct ifaddr *ifa, int);
 260 void    in_ifscrub (struct ifnet *, struct in_ifaddr *);
 261 void    in_iaunlink (struct in_ifaddr *);
 262 void    in_iahash_insert (struct in_ifaddr *);
 263 void    in_iahash_remove (struct in_ifaddr *);
 264
 265 #endif /* _KERNEL */
 266
 267 /* INET6 stuff */
 268 #include <netinet6/in6_var.h>
 269
 270 #endif /* _NETINET_IN_VAR_H_ */