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.11 2006/05/20 02:42:12 dillon 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         LIST_ENTRY(in_ifaddr) ia_hash;  /* entry in bucket of inet addresses */
  71         TAILQ_ENTRY(in_ifaddr) ia_link; /* list of internet addresses */
  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 extern  struct  in_addr zeroin_addr;
  98 extern  u_char  inetctlerrmap[];
  99
 100 /*
 101  * Hash table for IP addresses.
 102  */
 103 extern  LIST_HEAD(in_ifaddrhashhead, in_ifaddr) *in_ifaddrhashtbl;
 104 extern  TAILQ_HEAD(in_ifaddrhead, in_ifaddr) in_ifaddrhead;
 105 extern  u_long in_ifaddrhmask;                  /* mask for hash table */
 106
 107 #define INADDR_NHASH_LOG2       9
 108 #define INADDR_NHASH            (1 << INADDR_NHASH_LOG2)
 109 #define INADDR_HASHVAL(x)       fnv_32_buf((&(x)), sizeof(x), FNV1_32_INIT)
 110 #define INADDR_HASH(x) \
 111         (&in_ifaddrhashtbl[INADDR_HASHVAL(x) & in_ifaddrhmask])
 112
 113
 114 /*
 115  * Macro for finding the interface (ifnet structure) corresponding to one
 116  * of our IP addresses.
 117  */
 118 #define INADDR_TO_IFP(addr, ifp) \
 119         /* struct in_addr addr; */ \
 120         /* struct ifnet *ifp; */ \
 121 { \
 122         struct in_ifaddr *ia; \
 123 \
 124         LIST_FOREACH(ia, INADDR_HASH((addr).s_addr), ia_hash) \
 125                 if (IA_SIN(ia)->sin_addr.s_addr == (addr).s_addr) \
 126                         break; \
 127         (ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \
 128 }
 129
 130 /*
 131  * Macro for finding the internet address structure (in_ifaddr) corresponding
 132  * to a given interface (ifnet structure).
 133  */
 134 #define IFP_TO_IA(ifp, ia) \
 135         /* struct ifnet *ifp; */ \
 136         /* struct in_ifaddr *ia; */ \
 137 { \
 138         for ((ia) = TAILQ_FIRST(&in_ifaddrhead); \
 139             (ia) != NULL && (ia)->ia_ifp != (ifp); \
 140             (ia) = TAILQ_NEXT((ia), ia_link)) \
 141                 continue; \
 142 }
 143 #endif
 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  * Macro for looking up the in_multi record for a given IP multicast address
 194  * on a given interface.  If no matching record is found, "inm" is set null.
 195  */
 196 #define IN_LOOKUP_MULTI(addr, ifp, inm) \
 197         /* struct in_addr addr; */ \
 198         /* struct ifnet *ifp; */ \
 199         /* struct in_multi *inm; */ \
 200 do { \
 201         struct ifmultiaddr *ifma; \
 202 \
 203         LIST_FOREACH(ifma, &((ifp)->if_multiaddrs), ifma_link) { \
 204                 if (ifma->ifma_addr->sa_family == AF_INET \
 205                     && ((struct sockaddr_in *)ifma->ifma_addr)->sin_addr.s_addr == \
 206                     (addr).s_addr) \
 207                         break; \
 208         } \
 209         (inm) = ifma ? ifma->ifma_protospec : 0; \
 210 } while(0)
 211
 212 /*
 213  * Macro to step through all of the in_multi records, one at a time.
 214  * The current position is remembered in "step", which the caller must
 215  * provide.  IN_FIRST_MULTI(), below, must be called to initialize "step"
 216  * and get the first record.  Both macros return a NULL "inm" when there
 217  * are no remaining records.
 218  */
 219 #define IN_NEXT_MULTI(step, inm) \
 220         /* struct in_multistep  step; */ \
 221         /* struct in_multi *inm; */ \
 222 do { \
 223         if (((inm) = (step).i_inm) != NULL) \
 224                 (step).i_inm = LIST_NEXT((step).i_inm, inm_link); \
 225 } while(0)
 226
 227 #define IN_FIRST_MULTI(step, inm) \
 228         /* struct in_multistep step; */ \
 229         /* struct in_multi *inm; */ \
 230 do { \
 231         (step).i_inm = LIST_FIRST(&in_multihead); \
 232         IN_NEXT_MULTI((step), (inm)); \
 233 } while(0)
 234
 235 struct  route;
 236 struct  netmsg;
 237 struct  lwkt_serialize;
 238
 239 void    in_ifdetach(struct ifnet *ifp);
 240 struct  in_multi *in_addmulti (struct in_addr *, struct ifnet *);
 241 void    in_delmulti (struct in_multi *);
 242 int     in_control (struct socket *, u_long, caddr_t, struct ifnet *,
 243                         struct thread *);
 244 void    in_rtqdrain (void);
 245 void    ip_input (struct mbuf *);
 246 int     in_ifadown (struct ifaddr *ifa, int);
 247 void    in_ifscrub (struct ifnet *, struct in_ifaddr *);
 248 int     ipflow_fastforward (struct mbuf *, struct lwkt_serialize *);
 249 void    ipflow_create (const struct route *, struct mbuf *);
 250 void    ipflow_slowtimo (void);
 251
 252 #endif /* _KERNEL */
 253
 254 /* INET6 stuff */
 255 #include <netinet6/in6_var.h>
 256
 257 #endif /* _NETINET_IN_VAR_H_ */