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  * 4. 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$
  31  */
  32
  33 #ifndef _NETINET_IN_VAR_H_
  34 #define _NETINET_IN_VAR_H_
  35
  36 #include <sys/queue.h>
  37 #include <sys/fnv_hash.h>
  38 #include <sys/tree.h>
  39
  40 struct igmp_ifinfo;
  41 struct in_multi;
  42 struct lltable;
  43
  44 /*
  45  * IPv4 per-interface state.
  46  */
  47 struct in_ifinfo {
  48         struct lltable          *ii_llt;        /* ARP state */
  49         struct igmp_ifinfo      *ii_igmp;       /* IGMP state */
  50         struct in_multi         *ii_allhosts;   /* 224.0.0.1 membership */
  51 };
  52
  53 #if defined(_KERNEL) || defined(_WANT_IFADDR)
  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_subnet{,mask} in host order */
  65         u_long  ia_subnet;              /* subnet address */
  66         u_long  ia_subnetmask;          /* mask of subnet */
  67         LIST_ENTRY(in_ifaddr) ia_hash;  /* entry in bucket of inet addresses */
  68         TAILQ_ENTRY(in_ifaddr) ia_link; /* list of internet addresses */
  69         struct  sockaddr_in ia_addr;    /* reserve space for interface name */
  70         struct  sockaddr_in ia_dstaddr; /* reserve space for broadcast addr */
  71 #define ia_broadaddr    ia_dstaddr
  72         struct  sockaddr_in ia_sockmask; /* reserve space for general netmask */
  73 };
  74 #endif
  75
  76 struct  in_aliasreq {
  77         char    ifra_name[IFNAMSIZ];            /* if name, e.g. "en0" */
  78         struct  sockaddr_in ifra_addr;
  79         struct  sockaddr_in ifra_broadaddr;
  80 #define ifra_dstaddr ifra_broadaddr
  81         struct  sockaddr_in ifra_mask;
  82         int     ifra_vhid;
  83 };
  84 /*
  85  * Given a pointer to an in_ifaddr (ifaddr),
  86  * return a pointer to the addr as a sockaddr_in.
  87  */
  88 #define IA_SIN(ia)    (&(((struct in_ifaddr *)(ia))->ia_addr))
  89 #define IA_DSTSIN(ia) (&(((struct in_ifaddr *)(ia))->ia_dstaddr))
  90 #define IA_MASKSIN(ia) (&(((struct in_ifaddr *)(ia))->ia_sockmask))
  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  u_char  inetctlerrmap[];
  98
  99 #define LLTABLE(ifp)    \
 100         ((struct in_ifinfo *)(ifp)->if_afdata[AF_INET])->ii_llt
 101 /*
 102  * Hash table for IP addresses.
 103  */
 104 TAILQ_HEAD(in_ifaddrhead, in_ifaddr);
 105 LIST_HEAD(in_ifaddrhashhead, in_ifaddr);
 106
 107 VNET_DECLARE(struct in_ifaddrhashhead *, in_ifaddrhashtbl);
 108 VNET_DECLARE(struct in_ifaddrhead, in_ifaddrhead);
 109 VNET_DECLARE(u_long, in_ifaddrhmask);           /* mask for hash table */
 110
 111 #define V_in_ifaddrhashtbl      VNET(in_ifaddrhashtbl)
 112 #define V_in_ifaddrhead         VNET(in_ifaddrhead)
 113 #define V_in_ifaddrhmask        VNET(in_ifaddrhmask)
 114
 115 #define INADDR_NHASH_LOG2       9
 116 #define INADDR_NHASH            (1 << INADDR_NHASH_LOG2)
 117 #define INADDR_HASHVAL(x)       fnv_32_buf((&(x)), sizeof(x), FNV1_32_INIT)
 118 #define INADDR_HASH(x) \
 119         (&V_in_ifaddrhashtbl[INADDR_HASHVAL(x) & V_in_ifaddrhmask])
 120
 121 extern  struct rwlock in_ifaddr_lock;
 122
 123 #define IN_IFADDR_LOCK_ASSERT() rw_assert(&in_ifaddr_lock, RA_LOCKED)
 124 #define IN_IFADDR_RLOCK()       rw_rlock(&in_ifaddr_lock)
 125 #define IN_IFADDR_RLOCK_ASSERT()        rw_assert(&in_ifaddr_lock, RA_RLOCKED)
 126 #define IN_IFADDR_RUNLOCK()     rw_runlock(&in_ifaddr_lock)
 127 #define IN_IFADDR_WLOCK()       rw_wlock(&in_ifaddr_lock)
 128 #define IN_IFADDR_WLOCK_ASSERT()        rw_assert(&in_ifaddr_lock, RA_WLOCKED)
 129 #define IN_IFADDR_WUNLOCK()     rw_wunlock(&in_ifaddr_lock)
 130
 131 /*
 132  * Macro for finding the internet address structure (in_ifaddr)
 133  * corresponding to one of our IP addresses (in_addr).
 134  */
 135 #define INADDR_TO_IFADDR(addr, ia) \
 136         /* struct in_addr addr; */ \
 137         /* struct in_ifaddr *ia; */ \
 138 do { \
 139 \
 140         LIST_FOREACH(ia, INADDR_HASH((addr).s_addr), ia_hash) \
 141                 if (IA_SIN(ia)->sin_addr.s_addr == (addr).s_addr) \
 142                         break; \
 143 } while (0)
 144
 145 /*
 146  * Macro for finding the interface (ifnet structure) corresponding to one
 147  * of our IP addresses.
 148  */
 149 #define INADDR_TO_IFP(addr, ifp) \
 150         /* struct in_addr addr; */ \
 151         /* struct ifnet *ifp; */ \
 152 { \
 153         struct in_ifaddr *ia; \
 154 \
 155         INADDR_TO_IFADDR(addr, ia); \
 156         (ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \
 157 }
 158
 159 /*
 160  * Macro for finding the internet address structure (in_ifaddr) corresponding
 161  * to a given interface (ifnet structure).
 162  */
 163 #define IFP_TO_IA(ifp, ia)                                              \
 164         /* struct ifnet *ifp; */                                        \
 165         /* struct in_ifaddr *ia; */                                     \
 166 do {                                                                    \
 167         IN_IFADDR_RLOCK();                                              \
 168         for ((ia) = TAILQ_FIRST(&V_in_ifaddrhead);                      \
 169             (ia) != NULL && (ia)->ia_ifp != (ifp);                      \
 170             (ia) = TAILQ_NEXT((ia), ia_link))                           \
 171                 continue;                                               \
 172         if ((ia) != NULL)                                               \
 173                 ifa_ref(&(ia)->ia_ifa);                                 \
 174         IN_IFADDR_RUNLOCK();                                            \
 175 } while (0)
 176 #endif
 177
 178 /*
 179  * IP datagram reassembly.
 180  */
 181 #define IPREASS_NHASH_LOG2      6
 182 #define IPREASS_NHASH           (1 << IPREASS_NHASH_LOG2)
 183 #define IPREASS_HMASK           (IPREASS_NHASH - 1)
 184 #define IPREASS_HASH(x,y) \
 185         (((((x) & 0xF) | ((((x) >> 8) & 0xF) << 4)) ^ (y)) & IPREASS_HMASK)
 186
 187 /*
 188  * Legacy IPv4 IGMP per-link structure.
 189  */
 190 struct router_info {
 191         struct ifnet *rti_ifp;
 192         int    rti_type; /* type of router which is querier on this interface */
 193         int    rti_time; /* # of slow timeouts since last old query */
 194         SLIST_ENTRY(router_info) rti_list;
 195 };
 196
 197 /*
 198  * Per-interface IGMP router version information.
 199  */
 200 struct igmp_ifinfo {
 201         LIST_ENTRY(igmp_ifinfo) igi_link;
 202         struct ifnet *igi_ifp;  /* interface this instance belongs to */
 203         uint32_t igi_version;   /* IGMPv3 Host Compatibility Mode */
 204         uint32_t igi_v1_timer;  /* IGMPv1 Querier Present timer (s) */
 205         uint32_t igi_v2_timer;  /* IGMPv2 Querier Present timer (s) */
 206         uint32_t igi_v3_timer;  /* IGMPv3 General Query (interface) timer (s)*/
 207         uint32_t igi_flags;     /* IGMP per-interface flags */
 208         uint32_t igi_rv;        /* IGMPv3 Robustness Variable */
 209         uint32_t igi_qi;        /* IGMPv3 Query Interval (s) */
 210         uint32_t igi_qri;       /* IGMPv3 Query Response Interval (s) */
 211         uint32_t igi_uri;       /* IGMPv3 Unsolicited Report Interval (s) */
 212         SLIST_HEAD(,in_multi)   igi_relinmhead; /* released groups */
 213         struct ifqueue   igi_gq;        /* queue of general query responses */
 214 };
 215
 216 #define IGIF_SILENT     0x00000001      /* Do not use IGMP on this ifp */
 217 #define IGIF_LOOPBACK   0x00000002      /* Send IGMP reports to loopback */
 218
 219 /*
 220  * IPv4 multicast IGMP-layer source entry.
 221  */
 222 struct ip_msource {
 223         RB_ENTRY(ip_msource)    ims_link;       /* RB tree links */
 224         in_addr_t               ims_haddr;      /* host byte order */
 225         struct ims_st {
 226                 uint16_t        ex;             /* # of exclusive members */
 227                 uint16_t        in;             /* # of inclusive members */
 228         }                       ims_st[2];      /* state at t0, t1 */
 229         uint8_t                 ims_stp;        /* pending query */
 230 };
 231
 232 /*
 233  * IPv4 multicast PCB-layer source entry.
 234  */
 235 struct in_msource {
 236         RB_ENTRY(ip_msource)    ims_link;       /* RB tree links */
 237         in_addr_t               ims_haddr;      /* host byte order */
 238         uint8_t                 imsl_st[2];     /* state before/at commit */
 239 };
 240
 241 RB_HEAD(ip_msource_tree, ip_msource);   /* define struct ip_msource_tree */
 242
 243 static __inline int
 244 ip_msource_cmp(const struct ip_msource *a, const struct ip_msource *b)
 245 {
 246
 247         if (a->ims_haddr < b->ims_haddr)
 248                 return (-1);
 249         if (a->ims_haddr == b->ims_haddr)
 250                 return (0);
 251         return (1);
 252 }
 253 RB_PROTOTYPE(ip_msource_tree, ip_msource, ims_link, ip_msource_cmp);
 254
 255 /*
 256  * IPv4 multicast PCB-layer group filter descriptor.
 257  */
 258 struct in_mfilter {
 259         struct ip_msource_tree  imf_sources; /* source list for (S,G) */
 260         u_long                  imf_nsrc;    /* # of source entries */
 261         uint8_t                 imf_st[2];   /* state before/at commit */
 262 };
 263
 264 /*
 265  * IPv4 group descriptor.
 266  *
 267  * For every entry on an ifnet's if_multiaddrs list which represents
 268  * an IP multicast group, there is one of these structures.
 269  *
 270  * If any source filters are present, then a node will exist in the RB-tree
 271  * to permit fast lookup by source whenever an operation takes place.
 272  * This permits pre-order traversal when we issue reports.
 273  * Source filter trees are kept separately from the socket layer to
 274  * greatly simplify locking.
 275  *
 276  * When IGMPv3 is active, inm_timer is the response to group query timer.
 277  * The state-change timer inm_sctimer is separate; whenever state changes
 278  * for the group the state change record is generated and transmitted,
 279  * and kept if retransmissions are necessary.
 280  *
 281  * FUTURE: inm_link is now only used when groups are being purged
 282  * on a detaching ifnet. It could be demoted to a SLIST_ENTRY, but
 283  * because it is at the very start of the struct, we can't do this
 284  * w/o breaking the ABI for ifmcstat.
 285  */
 286 struct in_multi {
 287         LIST_ENTRY(in_multi) inm_link;  /* to-be-released by in_ifdetach */
 288         struct  in_addr inm_addr;       /* IP multicast address, convenience */
 289         struct  ifnet *inm_ifp;         /* back pointer to ifnet */
 290         struct  ifmultiaddr *inm_ifma;  /* back pointer to ifmultiaddr */
 291         u_int   inm_timer;              /* IGMPv1/v2 group / v3 query timer */
 292         u_int   inm_state;              /* state of the membership */
 293         void    *inm_rti;               /* unused, legacy field */
 294         u_int   inm_refcount;           /* reference count */
 295
 296         /* New fields for IGMPv3 follow. */
 297         struct igmp_ifinfo      *inm_igi;       /* IGMP info */
 298         SLIST_ENTRY(in_multi)    inm_nrele;     /* to-be-released by IGMP */
 299         struct ip_msource_tree   inm_srcs;      /* tree of sources */
 300         u_long                   inm_nsrc;      /* # of tree entries */
 301
 302         struct ifqueue           inm_scq;       /* queue of pending
 303                                                  * state-change packets */
 304         struct timeval           inm_lastgsrtv; /* Time of last G-S-R query */
 305         uint16_t                 inm_sctimer;   /* state-change timer */
 306         uint16_t                 inm_scrv;      /* state-change rexmit count */
 307
 308         /*
 309          * SSM state counters which track state at T0 (the time the last
 310          * state-change report's RV timer went to zero) and T1
 311          * (time of pending report, i.e. now).
 312          * Used for computing IGMPv3 state-change reports. Several refcounts
 313          * are maintained here to optimize for common use-cases.
 314          */
 315         struct inm_st {
 316                 uint16_t        iss_fmode;      /* IGMP filter mode */
 317                 uint16_t        iss_asm;        /* # of ASM listeners */
 318                 uint16_t        iss_ex;         /* # of exclusive members */
 319                 uint16_t        iss_in;         /* # of inclusive members */
 320                 uint16_t        iss_rec;        /* # of recorded sources */
 321         }                       inm_st[2];      /* state at t0, t1 */
 322 };
 323
 324 /*
 325  * Helper function to derive the filter mode on a source entry
 326  * from its internal counters. Predicates are:
 327  *  A source is only excluded if all listeners exclude it.
 328  *  A source is only included if no listeners exclude it,
 329  *  and at least one listener includes it.
 330  * May be used by ifmcstat(8).
 331  */
 332 static __inline uint8_t
 333 ims_get_mode(const struct in_multi *inm, const struct ip_msource *ims,
 334     uint8_t t)
 335 {
 336
 337         t = !!t;
 338         if (inm->inm_st[t].iss_ex > 0 &&
 339             inm->inm_st[t].iss_ex == ims->ims_st[t].ex)
 340                 return (MCAST_EXCLUDE);
 341         else if (ims->ims_st[t].in > 0 && ims->ims_st[t].ex == 0)
 342                 return (MCAST_INCLUDE);
 343         return (MCAST_UNDEFINED);
 344 }
 345
 346 #ifdef _KERNEL
 347
 348 #ifdef SYSCTL_DECL
 349 SYSCTL_DECL(_net_inet);
 350 SYSCTL_DECL(_net_inet_ip);
 351 SYSCTL_DECL(_net_inet_raw);
 352 #endif
 353
 354 /*
 355  * Lock macros for IPv4 layer multicast address lists.  IPv4 lock goes
 356  * before link layer multicast locks in the lock order.  In most cases,
 357  * consumers of IN_*_MULTI() macros should acquire the locks before
 358  * calling them; users of the in_{add,del}multi() functions should not.
 359  */
 360 extern struct mtx in_multi_mtx;
 361 #define IN_MULTI_LOCK()         mtx_lock(&in_multi_mtx)
 362 #define IN_MULTI_UNLOCK()       mtx_unlock(&in_multi_mtx)
 363 #define IN_MULTI_LOCK_ASSERT()  mtx_assert(&in_multi_mtx, MA_OWNED)
 364 #define IN_MULTI_UNLOCK_ASSERT() mtx_assert(&in_multi_mtx, MA_NOTOWNED)
 365
 366 /* Acquire an in_multi record. */
 367 static __inline void
 368 inm_acquire_locked(struct in_multi *inm)
 369 {
 370
 371         IN_MULTI_LOCK_ASSERT();
 372         ++inm->inm_refcount;
 373 }
 374
 375 /*
 376  * Return values for imo_multi_filter().
 377  */
 378 #define MCAST_PASS              0       /* Pass */
 379 #define MCAST_NOTGMEMBER        1       /* This host not a member of group */
 380 #define MCAST_NOTSMEMBER        2       /* This host excluded source */
 381 #define MCAST_MUTED             3       /* [deprecated] */
 382
 383 struct  rtentry;
 384 struct  route;
 385 struct  ip_moptions;
 386 struct radix_node_head;
 387
 388 struct in_multi *inm_lookup_locked(struct ifnet *, const struct in_addr);
 389 struct in_multi *inm_lookup(struct ifnet *, const struct in_addr);
 390 int     imo_multi_filter(const struct ip_moptions *, const struct ifnet *,
 391             const struct sockaddr *, const struct sockaddr *);
 392 void    inm_commit(struct in_multi *);
 393 void    inm_clear_recorded(struct in_multi *);
 394 void    inm_print(const struct in_multi *);
 395 int     inm_record_source(struct in_multi *inm, const in_addr_t);
 396 void    inm_release(struct in_multi *);
 397 void    inm_release_locked(struct in_multi *);
 398 struct  in_multi *
 399         in_addmulti(struct in_addr *, struct ifnet *);
 400 void    in_delmulti(struct in_multi *);
 401 int     in_joingroup(struct ifnet *, const struct in_addr *,
 402             /*const*/ struct in_mfilter *, struct in_multi **);
 403 int     in_joingroup_locked(struct ifnet *, const struct in_addr *,
 404             /*const*/ struct in_mfilter *, struct in_multi **);
 405 int     in_leavegroup(struct in_multi *, /*const*/ struct in_mfilter *);
 406 int     in_leavegroup_locked(struct in_multi *,
 407             /*const*/ struct in_mfilter *);
 408 int     in_control(struct socket *, u_long, caddr_t, struct ifnet *,
 409             struct thread *);
 410 int     in_addprefix(struct in_ifaddr *, int);
 411 int     in_scrubprefix(struct in_ifaddr *, u_int);
 412 void    ip_input(struct mbuf *);
 413 void    ip_direct_input(struct mbuf *);
 414 void    in_ifadown(struct ifaddr *ifa, int);
 415 struct  mbuf    *ip_fastforward(struct mbuf *);
 416 void    *in_domifattach(struct ifnet *);
 417 void    in_domifdetach(struct ifnet *, void *);
 418
 419
 420 /* XXX */
 421 void     in_rtalloc_ign(struct route *ro, u_long ignflags, u_int fibnum);
 422 void     in_rtalloc(struct route *ro, u_int fibnum);
 423 struct rtentry *in_rtalloc1(struct sockaddr *, int, u_long, u_int);
 424 void     in_rtredirect(struct sockaddr *, struct sockaddr *,
 425             struct sockaddr *, int, struct sockaddr *, u_int);
 426 int      in_rtrequest(int, struct sockaddr *,
 427             struct sockaddr *, struct sockaddr *, int, struct rtentry **, u_int);
 428
 429 #if 0
 430 int      in_rt_getifa(struct rt_addrinfo *, u_int fibnum);
 431 int      in_rtioctl(u_long, caddr_t, u_int);
 432 int      in_rtrequest1(int, struct rt_addrinfo *, struct rtentry **, u_int);
 433 #endif
 434 #endif /* _KERNEL */
 435
 436 /* INET6 stuff */
 437 #include <netinet6/in6_var.h>
 438
 439 #endif /* _NETINET_IN_VAR_H_ */