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