X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/de355530ae67247cbd0da700edb3a2a1dae884c2..3903760236c30e3b5ace7a4eefac3a269d68957c:/bsd/netinet/igmp_var.h

diff --git a/bsd/netinet/igmp_var.h b/bsd/netinet/igmp_var.h
index 8d440ff63..0d299ef24 100644
--- a/bsd/netinet/igmp_var.h
+++ b/bsd/netinet/igmp_var.h
@@ -1,23 +1,29 @@
 /*
- * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2013 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,
- * 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.
@@ -62,8 +68,6 @@
 #define _NETINET_IGMP_VAR_H_
 #include <sys/appleapiopts.h>
 
-#ifdef __APPLE_API_UNSTABLE
-
 /*
  * Internet Group Management Protocol (IGMP),
  * implementation-specific definitions.
@@ -73,6 +77,48 @@
  * MULTICAST Revision: 3.5.1.3
  */
 
+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 */
+	/*
+	 * 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 */
+	/*
+	 * 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_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 */
+	/*
+	 * 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 */
+	/*
+	 * Padding for future additions.
+	 */
+	uint64_t __igps_pad[4];
+} __attribute__((aligned(8)));
+
+/*
+ * Old IGMPv2 stat structure for backward compatibility
+ *
+ */
+
 struct igmpstat {
 	u_int	igps_rcv_total;		/* total IGMP messages received */
 	u_int	igps_rcv_tooshort;	/* received with too few bytes */
@@ -85,41 +131,207 @@ struct igmpstat {
 	u_int	igps_snd_reports;	/* sent membership reports */
 };
 
-#ifdef KERNEL
-#ifdef __APPLE_API_PRIVATE
+#define IGPS_VERSION_3	3
+#define IGPS_VERSION3_LEN		168
+
+#ifdef PRIVATE
+/*
+ * Per-interface IGMP router version information.
+ */
+#ifndef XNU_KERNEL_PRIVATE
+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) */
+};
+
+#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 */
+#endif /* PRIVATE */
+
+#ifdef BSD_KERNEL_PRIVATE
+#include <libkern/libkern.h>
+#define IGMP_DEBUG 1
+#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;						\
+	}								\
+} while (0)
+#else
+#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	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 */
+
+/*
+ * 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 {}) */
+/*
+ * IGMPv3 protocol control variables.
+ */
+#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_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_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 */
+
 /*
- * States for IGMPv2's leave processing
+ * 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 IGMP_OTHERMEMBER			0
-#define IGMP_IREPORTEDLAST			1
+#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 */
+	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 ifqueue   igi_v2q; /* queue of v1/v2 packets */
+};
+
+#define	IGI_LOCK_ASSERT_HELD(_igi)					\
+	lck_mtx_assert(&(_igi)->igi_lock, LCK_MTX_ASSERT_OWNED)
+
+#define	IGI_LOCK_ASSERT_NOTHELD(_igi)					\
+	lck_mtx_assert(&(_igi)->igi_lock, LCK_MTX_ASSERT_NOTOWNED)
+
+#define	IGI_LOCK(_igi)							\
+	lck_mtx_lock(&(_igi)->igi_lock)
+
+#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);			\
+} while (0)
+
+#define	IGI_UNLOCK(_igi)						\
+	lck_mtx_unlock(&(_igi)->igi_lock)
+
+#define	IGI_ADDREF(_igi)						\
+	igi_addref(_igi, 0)
+
+#define	IGI_ADDREF_LOCKED(_igi)						\
+	igi_addref(_igi, 1)
+
+#define	IGI_REMREF(_igi)						\
+	igi_remref(_igi)
 
 /*
- * We must remember what version the subnet's querier is.
- * We conveniently use the IGMP message type for the proper
- * membership report to keep this state.
+ * Per-link IGMP context.
  */
-#define IGMP_V1_ROUTER				IGMP_V1_MEMBERSHIP_REPORT
-#define IGMP_V2_ROUTER				IGMP_V2_MEMBERSHIP_REPORT
+#define IGMP_IFINFO(ifp)	((ifp)->if_igi)
 
 /*
- * Revert to new router if we haven't heard from an old router in
- * this amount of time.
+ * IGMP timer schedule parameters
  */
-#define IGMP_AGE_THRESHOLD			540
+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 */
+};
 
-void	igmp_init __P((void));
-void	igmp_input __P((struct mbuf *, int));
-void	igmp_joingroup __P((struct in_multi *));
-void	igmp_leavegroup __P((struct in_multi *));
-void	igmp_fasttimo __P((void));
-void	igmp_slowtimo __P((void));
+extern void igmp_init(struct protosw *, struct domain *);
+extern int igmp_change_state(struct in_multi *, struct igmp_tparams *);
+extern struct igmp_ifinfo *igmp_domifattach(struct ifnet *, int);
+extern void igmp_domifreattach(struct igmp_ifinfo *);
+extern void igmp_domifdetach(struct ifnet *);
+extern void igmp_input(struct mbuf *, int);
+extern int igmp_joingroup(struct in_multi *);
+extern void igmp_leavegroup(struct in_multi *);
+extern void igmp_set_timeout(struct igmp_tparams *);
+extern void igi_addref(struct igmp_ifinfo *, int);
+extern void igi_remref(struct igmp_ifinfo *);
+__private_extern__ void igmp_initsilent(struct ifnet *, struct igmp_ifinfo *);
 
 SYSCTL_DECL(_net_inet_igmp);
 
-#endif /* __APPLE_API_PRIVATE */
-#endif
+#endif /* BSD_KERNEL_PRIVATE */
 
 /*
  * Names for IGMP sysctl objects
@@ -127,11 +339,11 @@ SYSCTL_DECL(_net_inet_igmp);
 #define IGMPCTL_STATS		1	/* statistics (read-only) */
 #define IGMPCTL_MAXID		2
 
+#ifdef BSD_KERNEL_PRIVATE
 #define IGMPCTL_NAMES { \
 	{ 0, 0 }, \
 	{ "stats", CTLTYPE_STRUCT }, \
 }
 
-#endif /* __APPLE_API_UNSTABLE */
+#endif /* BSD_KERNEL_PRIVATE */
 #endif
-