xnu-3789.1.32.tar.gz

[apple/xnu.git] / bsd / netinet / igmp.h

diff --git a/bsd/netinet/igmp.h b/bsd/netinet/igmp.h
index dc62c7da57cd884c7e304cbb1ae77a9fbb193d35..28352317df0acb753837ede8f35a0cefc5327679 100644 (file)
--- a/bsd/netinet/igmp.h
+++ b/bsd/netinet/igmp.h
@@ -1,23 +1,29 @@
 /*
 /*

- * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2010 Apple, Inc. All rights reserved.

  *
  *

- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@

  * 
  * 

- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * 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
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * 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.

  * 
  * 

- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * 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,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,

- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * 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_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@

  */
 /*
  * Copyright (c) 1988 Stephen Deering.
  */
 /*
  * Copyright (c) 1988 Stephen Deering.


@@ -71,8 +77,11 @@
  * MULTICAST Revision: 3.5.1.2
  */
 
  * MULTICAST Revision: 3.5.1.2
  */
 

+/* Minimum length of any IGMP protocol message. */
+#define IGMP_MINLEN                    8
+

 /*
 /*

- * IGMP packet format.
+ * IGMPv1/v2 query and host report format.

  */
 struct igmp {
        u_char          igmp_type;      /* version & type of IGMP message  */
  */
 struct igmp {
        u_char          igmp_type;      /* version & type of IGMP message  */


@@ -81,38 +90,91 @@ struct igmp {
        struct in_addr  igmp_group;     /* group address being reported    */
 };                                     /*  (zero for queries)             */
 
        struct in_addr  igmp_group;     /* group address being reported    */
 };                                     /*  (zero for queries)             */
 

-#define IGMP_MINLEN                 8
+/*
+ * IGMP v3 query format.
+ */
+struct igmpv3 {
+       u_char          igmp_type;      /* version & type of IGMP message  */
+       u_char          igmp_code;      /* subtype for routing msgs        */
+       u_short         igmp_cksum;     /* IP-style checksum               */
+       struct in_addr  igmp_group;     /* group address being reported    */
+                                       /*  (zero for queries)             */
+       u_char          igmp_misc;      /* reserved/suppress/robustness    */
+       u_char          igmp_qqi;       /* querier's query interval        */
+       u_short         igmp_numsrc;    /* number of sources               */
+       /*struct in_addr        igmp_sources[1];*/ /* source addresses */
+};
+#define IGMP_V3_QUERY_MINLEN           12
+#define IGMP_EXP(x)                    (((x) >> 4) & 0x07)
+#define IGMP_MANT(x)                   ((x) & 0x0f)
+#define IGMP_QRESV(x)                  (((x) >> 4) & 0x0f)
+#define IGMP_SFLAG(x)                  (((x) >> 3) & 0x01)
+#define IGMP_QRV(x)                    ((x) & 0x07)
+
+struct igmp_grouprec {
+       u_char          ig_type;        /* record type */
+       u_char          ig_datalen;     /* length of auxiliary data */
+       u_short         ig_numsrc;      /* number of sources */
+       struct in_addr  ig_group;       /* group address being reported */
+       /*struct in_addr        ig_sources[1];*/ /* source addresses */
+};
+#define IGMP_GRPREC_HDRLEN             8

 
 /*
 
 /*

- * Message types, including version number.
+ * IGMPv3 host membership report header.

  */
  */

-#define IGMP_MEMBERSHIP_QUERY          0x11    /* membership query         */
-#define IGMP_V1_MEMBERSHIP_REPORT      0x12    /* Ver. 1 membership report */
-#define IGMP_V2_MEMBERSHIP_REPORT      0x16    /* Ver. 2 membership report */
-#define IGMP_V2_LEAVE_GROUP            0x17    /* Leave-group message      */
+struct igmp_report {
+       u_char          ir_type;        /* IGMP_v3_HOST_MEMBERSHIP_REPORT */
+       u_char          ir_rsv1;        /* must be zero */
+       u_short         ir_cksum;       /* checksum */
+       u_short         ir_rsv2;        /* must be zero */
+       u_short         ir_numgrps;     /* number of group records */
+       /*struct        igmp_grouprec ir_groups[1];*/   /* group records */
+};
+#define IGMP_V3_REPORT_MINLEN          8
+#define IGMP_V3_REPORT_MAXRECS         65535

 
 

+/*
+ * Message types, including version number.
+ */
+#define IGMP_HOST_MEMBERSHIP_QUERY     0x11    /* membership query         */
+#define IGMP_v1_HOST_MEMBERSHIP_REPORT 0x12    /* Ver. 1 membership report */

 #define IGMP_DVMRP                     0x13    /* DVMRP routing message    */
 #define IGMP_DVMRP                     0x13    /* DVMRP routing message    */

-#define IGMP_PIM                       0x14    /* PIM routing message      */
+#define IGMP_PIM                       0x14    /* PIMv1 message (historic) */
+#define IGMP_v2_HOST_MEMBERSHIP_REPORT 0x16    /* Ver. 2 membership report */
+#define IGMP_HOST_LEAVE_MESSAGE                0x17    /* Leave-group message     */
+#define IGMP_MTRACE_REPLY              0x1e    /* mtrace(8) reply */
+#define IGMP_MTRACE_QUERY              0x1f    /* mtrace(8) probe */
+#define IGMP_v3_HOST_MEMBERSHIP_REPORT 0x22    /* Ver. 3 membership report */

 
 

-#define IGMP_MTRACE_RESP               0x1e  /* traceroute resp.(to sender)*/
-#define IGMP_MTRACE                    0x1f  /* mcast traceroute messages  */
-
-#define IGMP_MAX_HOST_REPORT_DELAY   10    /* max delay for response to     */
-                                          /*  query (in seconds) according */
-                                          /*  to RFC1112                   */
+/*
+ * IGMPv3 report modes.
+ */
+#define IGMP_DO_NOTHING                        0       /* don't send a record */
+#define IGMP_MODE_IS_INCLUDE           1       /* MODE_IN */
+#define IGMP_MODE_IS_EXCLUDE           2       /* MODE_EX */
+#define IGMP_CHANGE_TO_INCLUDE_MODE    3       /* TO_IN */
+#define IGMP_CHANGE_TO_EXCLUDE_MODE    4       /* TO_EX */
+#define IGMP_ALLOW_NEW_SOURCES         5       /* ALLOW_NEW */
+#define IGMP_BLOCK_OLD_SOURCES         6       /* BLOCK_OLD */

 
 

+/*
+ * IGMPv3 query types.
+ */
+#define IGMP_V3_GENERAL_QUERY          1
+#define IGMP_V3_GROUP_QUERY            2
+#define IGMP_V3_GROUP_SOURCE_QUERY     3

 
 

-#define IGMP_TIMER_SCALE     10                /* denotes that the igmp code field */
-                                       /* specifies time in 10th of seconds*/
+/*
+ * Maximum report interval for IGMP v1/v2 host membership reports [RFC 1112]
+ */
+#define IGMP_V1V2_MAX_RI               10
+#define IGMP_MAX_HOST_REPORT_DELAY     IGMP_V1V2_MAX_RI

 
 /*
 
 /*

- * The following four defininitions are for backwards compatibility.
- * They should be removed as soon as all applications are updated to
- * use the new constant names.
+ * IGMP_TIMER_SCALE denotes that the igmp code field specifies
+ * time in tenths of a second.

  */
  */

-#define IGMP_HOST_MEMBERSHIP_QUERY     IGMP_MEMBERSHIP_QUERY
-#define IGMP_HOST_MEMBERSHIP_REPORT    IGMP_V1_MEMBERSHIP_REPORT
-#define IGMP_HOST_NEW_MEMBERSHIP_REPORT        IGMP_V2_MEMBERSHIP_REPORT
-#define IGMP_HOST_LEAVE_MESSAGE                IGMP_V2_LEAVE_GROUP
+#define IGMP_TIMER_SCALE               10

 
 #endif /* _NETINET_IGMP_H_ */
 
 #endif /* _NETINET_IGMP_H_ */