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