bsd/netinet/igmp_var.h

   1 /*
   2  * Copyright (c) 2006 Apple Computer, Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License.  The rights granted to you under the
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30 /*
  31  * Copyright (c) 1988 Stephen Deering.
  32  * Copyright (c) 1992, 1993
  33  *      The Regents of the University of California.  All rights reserved.
  34  *
  35  * This code is derived from software contributed to Berkeley by
  36  * Stephen Deering of Stanford University.
  37  *
  38  * Redistribution and use in source and binary forms, with or without
  39  * modification, are permitted provided that the following conditions
  40  * are met:
  41  * 1. Redistributions of source code must retain the above copyright
  42  *    notice, this list of conditions and the following disclaimer.
  43  * 2. Redistributions in binary form must reproduce the above copyright
  44  *    notice, this list of conditions and the following disclaimer in the
  45  *    documentation and/or other materials provided with the distribution.
  46  * 3. All advertising materials mentioning features or use of this software
  47  *    must display the following acknowledgement:
  48  *      This product includes software developed by the University of
  49  *      California, Berkeley and its contributors.
  50  * 4. Neither the name of the University nor the names of its contributors
  51  *    may be used to endorse or promote products derived from this software
  52  *    without specific prior written permission.
  53  *
  54  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  55  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  56  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  57  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  58  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  59  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  60  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  61  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  62  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  63  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  64  * SUCH DAMAGE.
  65  *
  66  *      from: @(#)igmp_var.h    8.1 (Berkeley) 7/19/93
  67  */
  68
  69 #ifndef _NETINET_IGMP_VAR_H_
  70 #define _NETINET_IGMP_VAR_H_
  71 #include <sys/appleapiopts.h>
  72
  73
  74 /*
  75  * Internet Group Management Protocol (IGMP),
  76  * implementation-specific definitions.
  77  *
  78  * Written by Steve Deering, Stanford, May 1988.
  79  *
  80  * MULTICAST Revision: 3.5.1.3
  81  */
  82
  83 struct igmpstat {
  84         u_int   igps_rcv_total;         /* total IGMP messages received */
  85         u_int   igps_rcv_tooshort;      /* received with too few bytes */
  86         u_int   igps_rcv_badsum;        /* received with bad checksum */
  87         u_int   igps_rcv_queries;       /* received membership queries */
  88         u_int   igps_rcv_badqueries;    /* received invalid queries */
  89         u_int   igps_rcv_reports;       /* received membership reports */
  90         u_int   igps_rcv_badreports;    /* received invalid reports */
  91         u_int   igps_rcv_ourreports;    /* received reports for our groups */
  92         u_int   igps_snd_reports;       /* sent membership reports */
  93 };
  94
  95 #ifdef KERNEL_PRIVATE
  96 #ifdef KERNEL
  97 #define IGMP_RANDOM_DELAY(X) (random() % (X) + 1)
  98
  99 /*
 100  * States for IGMPv2's leave processing
 101  */
 102 #define IGMP_OTHERMEMBER                        0
 103 #define IGMP_IREPORTEDLAST                      1
 104
 105 /*
 106  * We must remember what version the subnet's querier is.
 107  * We conveniently use the IGMP message type for the proper
 108  * membership report to keep this state.
 109  */
 110 #define IGMP_V1_ROUTER                          IGMP_V1_MEMBERSHIP_REPORT
 111 #define IGMP_V2_ROUTER                          IGMP_V2_MEMBERSHIP_REPORT
 112
 113 /*
 114  * Revert to new router if we haven't heard from an old router in
 115  * this amount of time.
 116  */
 117 #define IGMP_AGE_THRESHOLD                      540
 118
 119 void    igmp_init(void);
 120 void    igmp_input(struct mbuf *, int);
 121 int             igmp_joingroup(struct in_multi *);
 122 void    igmp_leavegroup(struct in_multi *);
 123 void    igmp_fasttimo(void);
 124 void    igmp_slowtimo(void);
 125
 126 SYSCTL_DECL(_net_inet_igmp);
 127
 128 #endif /* KERNEL */
 129 #endif /* KERNEL_PRIVATE */
 130
 131 /*
 132  * Names for IGMP sysctl objects
 133  */
 134 #define IGMPCTL_STATS           1       /* statistics (read-only) */
 135 #define IGMPCTL_MAXID           2
 136
 137 #ifdef KERNEL_PRIVATE
 138 #define IGMPCTL_NAMES { \
 139         { 0, 0 }, \
 140         { "stats", CTLTYPE_STRUCT }, \
 141 }
 142
 143 #endif /* KERNEL_PRIVATE */
 144 #endif