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