]> git.saurik.com Git - apple/xnu.git/blobdiff - bsd/netinet/igmp_var.h
xnu-4903.270.47.tar.gz
[apple/xnu.git] / bsd / netinet / igmp_var.h
index 22181c9e372e7dd50fb23dc65dfbe1501565121f..5a592101d1ac7c09567b19a574e550067094f8a3 100644 (file)
@@ -2,7 +2,7 @@
  * Copyright (c) 2000-2013 Apple Inc. All rights reserved.
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
- * 
+ *
  * This file contains Original Code and/or Modifications of Original Code
  * as defined in and that are subject to the Apple Public Source License
  * Version 2.0 (the 'License'). You may not use this file except in
  * unlawful or unlicensed copies of an Apple operating system, or to
  * circumvent, violate, or enable the circumvention or violation of, any
  * terms of an Apple operating system software license agreement.
- * 
+ *
  * Please obtain a copy of the License at
  * http://www.opensource.apple.com/apsl/ and read it before using this file.
- * 
+ *
  * The Original Code and all software distributed under the License are
  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
@@ -22,7 +22,7 @@
  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  * Please see the License for the specific language governing rights and
  * limitations under the License.
- * 
+ *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 /*
@@ -81,33 +81,33 @@ struct igmpstat_v3 {
        /*
         * Structure header (to insulate ABI changes).
         */
-       uint32_t igps_version;          /* version of this structure */
-       uint32_t igps_len;              /* length of this structure */
+       uint32_t igps_version;          /* version of this structure */
+       uint32_t igps_len;              /* length of this structure */
        /*
         * Message statistics.
         */
-       uint64_t igps_rcv_total;        /* total IGMP messages received */
-       uint64_t igps_rcv_tooshort;     /* received with too few bytes */
-       uint64_t igps_rcv_badttl;       /* received with ttl other than 1 */
-       uint64_t igps_rcv_badsum;       /* received with bad checksum */
+       uint64_t igps_rcv_total;        /* total IGMP messages received */
+       uint64_t igps_rcv_tooshort;     /* received with too few bytes */
+       uint64_t igps_rcv_badttl;       /* received with ttl other than 1 */
+       uint64_t igps_rcv_badsum;       /* received with bad checksum */
        /*
         * Query statistics.
         */
-       uint64_t igps_rcv_v1v2_queries; /* received IGMPv1/IGMPv2 queries */
-       uint64_t igps_rcv_v3_queries;   /* received IGMPv3 queries */
-       uint64_t igps_rcv_badqueries;   /* received invalid queries */
-       uint64_t igps_rcv_gen_queries;  /* received general queries */
+       uint64_t igps_rcv_v1v2_queries; /* received IGMPv1/IGMPv2 queries */
+       uint64_t igps_rcv_v3_queries;   /* received IGMPv3 queries */
+       uint64_t igps_rcv_badqueries;   /* received invalid queries */
+       uint64_t igps_rcv_gen_queries;  /* received general queries */
        uint64_t igps_rcv_group_queries;/* received group queries */
-       uint64_t igps_rcv_gsr_queries;  /* received group-source queries */
-       uint64_t igps_drop_gsr_queries; /* dropped group-source queries */
+       uint64_t igps_rcv_gsr_queries;  /* received group-source queries */
+       uint64_t igps_drop_gsr_queries; /* dropped group-source queries */
        /*
         * Report statistics.
         */
-       uint64_t igps_rcv_reports;      /* received membership reports */
-       uint64_t igps_rcv_badreports;   /* received invalid reports */
-       uint64_t igps_rcv_ourreports;   /* received reports for our groups */
-       uint64_t igps_rcv_nora;         /* received w/o Router Alert option */
-       uint64_t igps_snd_reports;      /* sent membership reports */
+       uint64_t igps_rcv_reports;      /* received membership reports */
+       uint64_t igps_rcv_badreports;   /* received invalid reports */
+       uint64_t igps_rcv_ourreports;   /* received reports for our groups */
+       uint64_t igps_rcv_nora;         /* received w/o Router Alert option */
+       uint64_t igps_snd_reports;      /* sent membership reports */
        /*
         * Padding for future additions.
         */
@@ -120,19 +120,19 @@ struct igmpstat_v3 {
  */
 
 struct igmpstat {
-       u_int   igps_rcv_total;         /* total IGMP messages received */
-       u_int   igps_rcv_tooshort;      /* received with too few bytes */
-       u_int   igps_rcv_badsum;        /* received with bad checksum */
-       u_int   igps_rcv_queries;       /* received membership queries */
-       u_int   igps_rcv_badqueries;    /* received invalid queries */
-       u_int   igps_rcv_reports;       /* received membership reports */
-       u_int   igps_rcv_badreports;    /* received invalid reports */
-       u_int   igps_rcv_ourreports;    /* received reports for our groups */
-       u_int   igps_snd_reports;       /* sent membership reports */
+       u_int   igps_rcv_total;         /* total IGMP messages received */
+       u_int   igps_rcv_tooshort;      /* received with too few bytes */
+       u_int   igps_rcv_badsum;        /* received with bad checksum */
+       u_int   igps_rcv_queries;       /* received membership queries */
+       u_int   igps_rcv_badqueries;    /* received invalid queries */
+       u_int   igps_rcv_reports;       /* received membership reports */
+       u_int   igps_rcv_badreports;    /* received invalid reports */
+       u_int   igps_rcv_ourreports;    /* received reports for our groups */
+       u_int   igps_snd_reports;       /* sent membership reports */
 };
 
-#define IGPS_VERSION_3 3
-#define IGPS_VERSION3_LEN              168
+#define IGPS_VERSION_3  3
+#define IGPS_VERSION3_LEN               168
 
 #ifdef PRIVATE
 /*
@@ -143,28 +143,28 @@ struct igmp_ifinfo {
 #else
 struct igmp_ifinfo_u {
 #endif /* XNU_KERNEL_PRIVATE */
-       uint32_t igi_ifindex;   /* interface this instance belongs to */
-       uint32_t igi_version;   /* IGMPv3 Host Compatibility Mode */
-       uint32_t igi_v1_timer;  /* IGMPv1 Querier Present timer (s) */
-       uint32_t igi_v2_timer;  /* IGMPv2 Querier Present timer (s) */
-       uint32_t igi_v3_timer;  /* IGMPv3 General Query (interface) timer (s)*/
-       uint32_t igi_flags;     /* IGMP per-interface flags */
-       uint32_t igi_rv;        /* IGMPv3 Robustness Variable */
-       uint32_t igi_qi;        /* IGMPv3 Query Interval (s) */
-       uint32_t igi_qri;       /* IGMPv3 Query Response Interval (s) */
-       uint32_t igi_uri;       /* IGMPv3 Unsolicited Report Interval (s) */
+       uint32_t igi_ifindex;   /* interface this instance belongs to */
+       uint32_t igi_version;   /* IGMPv3 Host Compatibility Mode */
+       uint32_t igi_v1_timer;  /* IGMPv1 Querier Present timer (s) */
+       uint32_t igi_v2_timer;  /* IGMPv2 Querier Present timer (s) */
+       uint32_t igi_v3_timer;  /* IGMPv3 General Query (interface) timer (s)*/
+       uint32_t igi_flags;     /* IGMP per-interface flags */
+       uint32_t igi_rv;        /* IGMPv3 Robustness Variable */
+       uint32_t igi_qi;        /* IGMPv3 Query Interval (s) */
+       uint32_t igi_qri;       /* IGMPv3 Query Response Interval (s) */
+       uint32_t igi_uri;       /* IGMPv3 Unsolicited Report Interval (s) */
 };
 
-#define IGIF_SILENT    0x00000001      /* Do not use IGMP on this ifp */
-#define IGIF_LOOPBACK  0x00000002      /* Send IGMP reports to loopback */
+#define IGIF_SILENT     0x00000001      /* Do not use IGMP on this ifp */
+#define IGIF_LOOPBACK   0x00000002      /* Send IGMP reports to loopback */
 
 /*
  * IGMP version tag.
  */
-#define IGMP_VERSION_NONE              0 /* Invalid */
-#define IGMP_VERSION_1                 1
-#define IGMP_VERSION_2                 2
-#define IGMP_VERSION_3                 3 /* Default */
+#define IGMP_VERSION_NONE               0 /* Invalid */
+#define IGMP_VERSION_1                  1
+#define IGMP_VERSION_2                  2
+#define IGMP_VERSION_3                  3 /* Default */
 #endif /* PRIVATE */
 
 #ifdef BSD_KERNEL_PRIVATE
@@ -173,147 +173,147 @@ struct igmp_ifinfo_u {
 #ifdef IGMP_DEBUG
 extern int igmp_debug;
 
-#define IGMP_PRINTF(x) do { if (igmp_debug) printf x; } while (0)
-#define        IGMP_INET_PRINTF(addr, x) do {                                  \
-       if (igmp_debug) {                                               \
-               char _igmp_inet_buf[MAX_IPv4_STR_LEN];                  \
-               inet_ntop(AF_INET, &(addr), _igmp_inet_buf,             \
-                   sizeof(_igmp_inet_buf));                            \
-               printf x;                                               \
-       }                                                               \
+#define IGMP_PRINTF(x)  do { if (igmp_debug) printf x; } while (0)
+#define IGMP_INET_PRINTF(addr, x) do {                                  \
+       if (igmp_debug) {                                               \
+               char _igmp_inet_buf[MAX_IPv4_STR_LEN];                  \
+               inet_ntop(AF_INET, &(addr), _igmp_inet_buf,             \
+                   sizeof(_igmp_inet_buf));                            \
+               printf x;                                               \
+       }                                                               \
 } while (0)
 #else
-#define        IGMP_PRINTF(x)
+#define IGMP_PRINTF(x)
 #endif
 
-#define        OIGMPSTAT_ADD(name, val)        atomic_add_32(&igmpstat.name , (val))
-#define        OIGMPSTAT_INC(name)             OIGMPSTAT_ADD(name, 1)
+#define OIGMPSTAT_ADD(name, val)        atomic_add_32(&igmpstat.name , (val))
+#define OIGMPSTAT_INC(name)             OIGMPSTAT_ADD(name, 1)
 
-#define        IGMPSTAT_ADD(name, val)         atomic_add_64(&igmpstat_v3.name , (val))
-#define        IGMPSTAT_INC(name)              IGMPSTAT_ADD(name, 1)
+#define IGMPSTAT_ADD(name, val)         atomic_add_64(&igmpstat_v3.name , (val))
+#define IGMPSTAT_INC(name)              IGMPSTAT_ADD(name, 1)
 
 #define IGMP_RANDOM_DELAY(X) (random() % (X) + 1)
 
-#define IGMP_MAX_STATE_CHANGES         24 /* Max pending changes per group */
+#define IGMP_MAX_STATE_CHANGES          24 /* Max pending changes per group */
 
 /*
  * IGMP per-group states.
  */
-#define IGMP_NOT_MEMBER                        0 /* Can garbage collect in_multi */
-#define IGMP_SILENT_MEMBER             1 /* Do not perform IGMP for group */
-#define IGMP_REPORTING_MEMBER          2 /* IGMPv1/2/3 we are reporter */
-#define IGMP_IDLE_MEMBER               3 /* IGMPv1/2 we reported last */
-#define IGMP_LAZY_MEMBER               4 /* IGMPv1/2 other member reporting */
-#define IGMP_SLEEPING_MEMBER           5 /* IGMPv1/2 start query response */
-#define IGMP_AWAKENING_MEMBER          6 /* IGMPv1/2 group timer will start */
-#define IGMP_G_QUERY_PENDING_MEMBER    7 /* IGMPv3 group query pending */
-#define IGMP_SG_QUERY_PENDING_MEMBER   8 /* IGMPv3 source query pending */
-#define IGMP_LEAVING_MEMBER            9 /* IGMPv3 dying gasp (pending last */
-                                         /* retransmission of INCLUDE {}) */
+#define IGMP_NOT_MEMBER                 0 /* Can garbage collect in_multi */
+#define IGMP_SILENT_MEMBER              1 /* Do not perform IGMP for group */
+#define IGMP_REPORTING_MEMBER           2 /* IGMPv1/2/3 we are reporter */
+#define IGMP_IDLE_MEMBER                3 /* IGMPv1/2 we reported last */
+#define IGMP_LAZY_MEMBER                4 /* IGMPv1/2 other member reporting */
+#define IGMP_SLEEPING_MEMBER            5 /* IGMPv1/2 start query response */
+#define IGMP_AWAKENING_MEMBER           6 /* IGMPv1/2 group timer will start */
+#define IGMP_G_QUERY_PENDING_MEMBER     7 /* IGMPv3 group query pending */
+#define IGMP_SG_QUERY_PENDING_MEMBER    8 /* IGMPv3 source query pending */
+#define IGMP_LEAVING_MEMBER             9 /* IGMPv3 dying gasp (pending last */
+                                          /* retransmission of INCLUDE {}) */
 /*
  * IGMPv3 protocol control variables.
  */
-#define IGMP_RV_INIT           2       /* Robustness Variable */
-#define IGMP_RV_MIN            1
-#define IGMP_RV_MAX            7
+#define IGMP_RV_INIT            2       /* Robustness Variable */
+#define IGMP_RV_MIN             1
+#define IGMP_RV_MAX             7
 
-#define IGMP_QI_INIT           125     /* Query Interval (s) */
-#define IGMP_QI_MIN            1
-#define IGMP_QI_MAX            255
+#define IGMP_QI_INIT            125     /* Query Interval (s) */
+#define IGMP_QI_MIN             1
+#define IGMP_QI_MAX             255
 
-#define IGMP_QRI_INIT          10      /* Query Response Interval (s) */
-#define IGMP_QRI_MIN           1
-#define IGMP_QRI_MAX           255
+#define IGMP_QRI_INIT           10      /* Query Response Interval (s) */
+#define IGMP_QRI_MIN            1
+#define IGMP_QRI_MAX            255
 
-#define IGMP_URI_INIT          3       /* Unsolicited Report Interval (s) */
-#define IGMP_URI_MIN           0
-#define IGMP_URI_MAX           10
+#define IGMP_URI_INIT           3       /* Unsolicited Report Interval (s) */
+#define IGMP_URI_MIN            0
+#define IGMP_URI_MAX            10
 
-#define IGMP_MAX_G_GS_PACKETS          8 /* # of packets to answer G/GS */
-#define IGMP_MAX_STATE_CHANGE_PACKETS  8 /* # of packets per state change */
-#define IGMP_MAX_RESPONSE_PACKETS      16 /* # of packets for general query */
-#define IGMP_MAX_RESPONSE_BURST                4 /* # of responses to send at once */
-#define IGMP_RESPONSE_BURST_INTERVAL   1 /* 1 second */
+#define IGMP_MAX_G_GS_PACKETS           8 /* # of packets to answer G/GS */
+#define IGMP_MAX_STATE_CHANGE_PACKETS   8 /* # of packets per state change */
+#define IGMP_MAX_RESPONSE_PACKETS       16 /* # of packets for general query */
+#define IGMP_MAX_RESPONSE_BURST         4 /* # of responses to send at once */
+#define IGMP_RESPONSE_BURST_INTERVAL    1 /* 1 second */
 
 /*
  * IGMP-specific mbuf flags.
  */
-#define M_IGMPV2       M_PROTO1        /* Packet is IGMPv2 */
-#define M_IGMPV3_HDR   M_PROTO2        /* Packet has IGMPv3 headers */
-#define M_GROUPREC     M_PROTO3        /* mbuf chain is a group record */
-#define M_IGMP_LOOP    M_LOOP          /* transmit on loif, not real ifp */
+#define M_IGMPV2        M_PROTO1        /* Packet is IGMPv2 */
+#define M_IGMPV3_HDR    M_PROTO2        /* Packet has IGMPv3 headers */
+#define M_GROUPREC      M_PROTO3        /* mbuf chain is a group record */
+#define M_IGMP_LOOP     M_LOOP          /* transmit on loif, not real ifp */
 
 /*
  * Default amount of leading space for IGMPv3 to allocate at the
  * beginning of its mbuf packet chains, to avoid fragmentation and
  * unnecessary allocation of leading mbufs.
  */
-#define RAOPT_LEN      4               /* Length of IP Router Alert option */
-#define        IGMP_LEADINGSPACE               \
+#define RAOPT_LEN       4               /* Length of IP Router Alert option */
+#define IGMP_LEADINGSPACE               \
        (sizeof(struct ip) + RAOPT_LEN + sizeof(struct igmp_report))
 
 struct igmp_ifinfo {
        decl_lck_mtx_data(, igi_lock);
-       uint32_t igi_refcnt;    /* reference count */
-       uint32_t igi_debug;     /* see ifa_debug flags */
+       uint32_t igi_refcnt;    /* reference count */
+       uint32_t igi_debug;     /* see ifa_debug flags */
        LIST_ENTRY(igmp_ifinfo) igi_link;
-       struct ifnet *igi_ifp;  /* interface this instance belongs to */
-       uint32_t igi_version;   /* IGMPv3 Host Compatibility Mode */
-       uint32_t igi_v1_timer;  /* IGMPv1 Querier Present timer (s) */
-       uint32_t igi_v2_timer;  /* IGMPv2 Querier Present timer (s) */
-       uint32_t igi_v3_timer;  /* IGMPv3 General Query (interface) timer (s)*/
-       uint32_t igi_flags;     /* IGMP per-interface flags */
-       uint32_t igi_rv;        /* IGMPv3 Robustness Variable */
-       uint32_t igi_qi;        /* IGMPv3 Query Interval (s) */
-       uint32_t igi_qri;       /* IGMPv3 Query Response Interval (s) */
-       uint32_t igi_uri;       /* IGMPv3 Unsolicited Report Interval (s) */
-       SLIST_HEAD(,in_multi)   igi_relinmhead; /* released groups */
-       struct ifqueue   igi_gq;        /* queue of general query responses */
+       struct ifnet *igi_ifp;  /* interface this instance belongs to */
+       uint32_t igi_version;   /* IGMPv3 Host Compatibility Mode */
+       uint32_t igi_v1_timer;  /* IGMPv1 Querier Present timer (s) */
+       uint32_t igi_v2_timer;  /* IGMPv2 Querier Present timer (s) */
+       uint32_t igi_v3_timer;  /* IGMPv3 General Query (interface) timer (s)*/
+       uint32_t igi_flags;     /* IGMP per-interface flags */
+       uint32_t igi_rv;        /* IGMPv3 Robustness Variable */
+       uint32_t igi_qi;        /* IGMPv3 Query Interval (s) */
+       uint32_t igi_qri;       /* IGMPv3 Query Response Interval (s) */
+       uint32_t igi_uri;       /* IGMPv3 Unsolicited Report Interval (s) */
+       SLIST_HEAD(, in_multi)   igi_relinmhead; /* released groups */
+       struct ifqueue   igi_gq;        /* queue of general query responses */
        struct ifqueue   igi_v2q; /* queue of v1/v2 packets */
 };
 
-#define        IGI_LOCK_ASSERT_HELD(_igi)                                      \
+#define IGI_LOCK_ASSERT_HELD(_igi)                                      \
        LCK_MTX_ASSERT(&(_igi)->igi_lock, LCK_MTX_ASSERT_OWNED)
 
-#define        IGI_LOCK_ASSERT_NOTHELD(_igi)                                   \
+#define IGI_LOCK_ASSERT_NOTHELD(_igi)                                   \
        LCK_MTX_ASSERT(&(_igi)->igi_lock, LCK_MTX_ASSERT_NOTOWNED)
 
-#define        IGI_LOCK(_igi)                                                  \
+#define IGI_LOCK(_igi)                                                  \
        lck_mtx_lock(&(_igi)->igi_lock)
 
-#define        IGI_LOCK_SPIN(_igi)                                             \
+#define IGI_LOCK_SPIN(_igi)                                             \
        lck_mtx_lock_spin(&(_igi)->igi_lock)
 
-#define        IGI_CONVERT_LOCK(_igi) do {                                     \
-       IGI_LOCK_ASSERT_HELD(_igi);                                     \
-       lck_mtx_convert_spin(&(_igi)->igi_lock);                        \
+#define IGI_CONVERT_LOCK(_igi) do {                                     \
+       IGI_LOCK_ASSERT_HELD(_igi);                                     \
+       lck_mtx_convert_spin(&(_igi)->igi_lock);                        \
 } while (0)
 
-#define        IGI_UNLOCK(_igi)                                                \
+#define IGI_UNLOCK(_igi)                                                \
        lck_mtx_unlock(&(_igi)->igi_lock)
 
-#define        IGI_ADDREF(_igi)                                                \
+#define IGI_ADDREF(_igi)                                                \
        igi_addref(_igi, 0)
 
-#define        IGI_ADDREF_LOCKED(_igi)                                         \
+#define IGI_ADDREF_LOCKED(_igi)                                         \
        igi_addref(_igi, 1)
 
-#define        IGI_REMREF(_igi)                                                \
+#define IGI_REMREF(_igi)                                                \
        igi_remref(_igi)
 
 /*
  * Per-link IGMP context.
  */
-#define IGMP_IFINFO(ifp)       ((ifp)->if_igi)
+#define IGMP_IFINFO(ifp)        ((ifp)->if_igi)
 
 /*
  * IGMP timer schedule parameters
  */
 struct igmp_tparams {
-       int     qpt;    /* querier_present_timers_running */
-       int     it;     /* interface_timers_running */
-       int     cst;    /* current_state_timers_running */
-       int     sct;    /* state_change_timers_running */
+       int     qpt;    /* querier_present_timers_running */
+       int     it;     /* interface_timers_running */
+       int     cst;    /* current_state_timers_running */
+       int     sct;    /* state_change_timers_running */
 };
 
 extern void igmp_init(struct protosw *, struct domain *);
@@ -336,8 +336,8 @@ SYSCTL_DECL(_net_inet_igmp);
 /*
  * Names for IGMP sysctl objects
  */
-#define IGMPCTL_STATS          1       /* statistics (read-only) */
-#define IGMPCTL_MAXID          2
+#define IGMPCTL_STATS           1       /* statistics (read-only) */
+#define IGMPCTL_MAXID           2
 
 #ifdef BSD_KERNEL_PRIVATE
 #define IGMPCTL_NAMES { \