CK Sin / Mbed 2 deprecated Ethernetwebsocket

Ethernetwebsoc

Dependencies:   C12832_lcd LM75B WebSocketClient mbed-rtos mbed Socket lwip-eth lwip-sys lwip

EthernetInterface/lwip/core/ipv4/igmp.c@0:0ed2a7c7190c, 2013-05-31 (annotated)

Committer:
GordonSin
Date:
Fri May 31 04:09:54 2013 +0000
Revision:
0:0ed2a7c7190c
31/5/2013;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
GordonSin 0:0ed2a7c7190c 1 /**
GordonSin 0:0ed2a7c7190c 2 * @file
GordonSin 0:0ed2a7c7190c 3 * IGMP - Internet Group Management Protocol
GordonSin 0:0ed2a7c7190c 4 *
GordonSin 0:0ed2a7c7190c 5 */
GordonSin 0:0ed2a7c7190c 6
GordonSin 0:0ed2a7c7190c 7 /*
GordonSin 0:0ed2a7c7190c 8 * Copyright (c) 2002 CITEL Technologies Ltd.
GordonSin 0:0ed2a7c7190c 9 * All rights reserved.
GordonSin 0:0ed2a7c7190c 10 *
GordonSin 0:0ed2a7c7190c 11 * Redistribution and use in source and binary forms, with or without
GordonSin 0:0ed2a7c7190c 12 * modification, are permitted provided that the following conditions
GordonSin 0:0ed2a7c7190c 13 * are met:
GordonSin 0:0ed2a7c7190c 14 * 1. Redistributions of source code must retain the above copyright
GordonSin 0:0ed2a7c7190c 15 * notice, this list of conditions and the following disclaimer.
GordonSin 0:0ed2a7c7190c 16 * 2. Redistributions in binary form must reproduce the above copyright
GordonSin 0:0ed2a7c7190c 17 * notice, this list of conditions and the following disclaimer in the
GordonSin 0:0ed2a7c7190c 18 * documentation and/or other materials provided with the distribution.
GordonSin 0:0ed2a7c7190c 19 * 3. Neither the name of CITEL Technologies Ltd nor the names of its contributors
GordonSin 0:0ed2a7c7190c 20 * may be used to endorse or promote products derived from this software
GordonSin 0:0ed2a7c7190c 21 * without specific prior written permission.
GordonSin 0:0ed2a7c7190c 22 *
GordonSin 0:0ed2a7c7190c 23 * THIS SOFTWARE IS PROVIDED BY CITEL TECHNOLOGIES AND CONTRIBUTORS ``AS IS''
GordonSin 0:0ed2a7c7190c 24 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
GordonSin 0:0ed2a7c7190c 25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
GordonSin 0:0ed2a7c7190c 26 * ARE DISCLAIMED. IN NO EVENT SHALL CITEL TECHNOLOGIES OR CONTRIBUTORS BE LIABLE
GordonSin 0:0ed2a7c7190c 27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
GordonSin 0:0ed2a7c7190c 28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
GordonSin 0:0ed2a7c7190c 29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
GordonSin 0:0ed2a7c7190c 30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
GordonSin 0:0ed2a7c7190c 31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
GordonSin 0:0ed2a7c7190c 32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
GordonSin 0:0ed2a7c7190c 33 * SUCH DAMAGE.
GordonSin 0:0ed2a7c7190c 34 *
GordonSin 0:0ed2a7c7190c 35 * This file is a contribution to the lwIP TCP/IP stack.
GordonSin 0:0ed2a7c7190c 36 * The Swedish Institute of Computer Science and Adam Dunkels
GordonSin 0:0ed2a7c7190c 37 * are specifically granted permission to redistribute this
GordonSin 0:0ed2a7c7190c 38 * source code.
GordonSin 0:0ed2a7c7190c 39 */
GordonSin 0:0ed2a7c7190c 40
GordonSin 0:0ed2a7c7190c 41 /*-------------------------------------------------------------
GordonSin 0:0ed2a7c7190c 42 Note 1)
GordonSin 0:0ed2a7c7190c 43 Although the rfc requires V1 AND V2 capability
GordonSin 0:0ed2a7c7190c 44 we will only support v2 since now V1 is very old (August 1989)
GordonSin 0:0ed2a7c7190c 45 V1 can be added if required
GordonSin 0:0ed2a7c7190c 46
GordonSin 0:0ed2a7c7190c 47 a debug print and statistic have been implemented to
GordonSin 0:0ed2a7c7190c 48 show this up.
GordonSin 0:0ed2a7c7190c 49 -------------------------------------------------------------
GordonSin 0:0ed2a7c7190c 50 -------------------------------------------------------------
GordonSin 0:0ed2a7c7190c 51 Note 2)
GordonSin 0:0ed2a7c7190c 52 A query for a specific group address (as opposed to ALLHOSTS)
GordonSin 0:0ed2a7c7190c 53 has now been implemented as I am unsure if it is required
GordonSin 0:0ed2a7c7190c 54
GordonSin 0:0ed2a7c7190c 55 a debug print and statistic have been implemented to
GordonSin 0:0ed2a7c7190c 56 show this up.
GordonSin 0:0ed2a7c7190c 57 -------------------------------------------------------------
GordonSin 0:0ed2a7c7190c 58 -------------------------------------------------------------
GordonSin 0:0ed2a7c7190c 59 Note 3)
GordonSin 0:0ed2a7c7190c 60 The router alert rfc 2113 is implemented in outgoing packets
GordonSin 0:0ed2a7c7190c 61 but not checked rigorously incoming
GordonSin 0:0ed2a7c7190c 62 -------------------------------------------------------------
GordonSin 0:0ed2a7c7190c 63 Steve Reynolds
GordonSin 0:0ed2a7c7190c 64 ------------------------------------------------------------*/
GordonSin 0:0ed2a7c7190c 65
GordonSin 0:0ed2a7c7190c 66 /*-----------------------------------------------------------------------------
GordonSin 0:0ed2a7c7190c 67 * RFC 988 - Host extensions for IP multicasting - V0
GordonSin 0:0ed2a7c7190c 68 * RFC 1054 - Host extensions for IP multicasting -
GordonSin 0:0ed2a7c7190c 69 * RFC 1112 - Host extensions for IP multicasting - V1
GordonSin 0:0ed2a7c7190c 70 * RFC 2236 - Internet Group Management Protocol, Version 2 - V2 <- this code is based on this RFC (it's the "de facto" standard)
GordonSin 0:0ed2a7c7190c 71 * RFC 3376 - Internet Group Management Protocol, Version 3 - V3
GordonSin 0:0ed2a7c7190c 72 * RFC 4604 - Using Internet Group Management Protocol Version 3... - V3+
GordonSin 0:0ed2a7c7190c 73 * RFC 2113 - IP Router Alert Option -
GordonSin 0:0ed2a7c7190c 74 *----------------------------------------------------------------------------*/
GordonSin 0:0ed2a7c7190c 75
GordonSin 0:0ed2a7c7190c 76 /*-----------------------------------------------------------------------------
GordonSin 0:0ed2a7c7190c 77 * Includes
GordonSin 0:0ed2a7c7190c 78 *----------------------------------------------------------------------------*/
GordonSin 0:0ed2a7c7190c 79
GordonSin 0:0ed2a7c7190c 80 #include "lwip/opt.h"
GordonSin 0:0ed2a7c7190c 81
GordonSin 0:0ed2a7c7190c 82 #if LWIP_IGMP /* don't build if not configured for use in lwipopts.h */
GordonSin 0:0ed2a7c7190c 83
GordonSin 0:0ed2a7c7190c 84 #include "lwip/igmp.h"
GordonSin 0:0ed2a7c7190c 85 #include "lwip/debug.h"
GordonSin 0:0ed2a7c7190c 86 #include "lwip/def.h"
GordonSin 0:0ed2a7c7190c 87 #include "lwip/mem.h"
GordonSin 0:0ed2a7c7190c 88 #include "lwip/ip.h"
GordonSin 0:0ed2a7c7190c 89 #include "lwip/inet_chksum.h"
GordonSin 0:0ed2a7c7190c 90 #include "lwip/netif.h"
GordonSin 0:0ed2a7c7190c 91 #include "lwip/icmp.h"
GordonSin 0:0ed2a7c7190c 92 #include "lwip/udp.h"
GordonSin 0:0ed2a7c7190c 93 #include "lwip/tcp.h"
GordonSin 0:0ed2a7c7190c 94 #include "lwip/stats.h"
GordonSin 0:0ed2a7c7190c 95
GordonSin 0:0ed2a7c7190c 96 #include "string.h"
GordonSin 0:0ed2a7c7190c 97
GordonSin 0:0ed2a7c7190c 98 /*
GordonSin 0:0ed2a7c7190c 99 * IGMP constants
GordonSin 0:0ed2a7c7190c 100 */
GordonSin 0:0ed2a7c7190c 101 #define IGMP_TTL 1
GordonSin 0:0ed2a7c7190c 102 #define IGMP_MINLEN 8
GordonSin 0:0ed2a7c7190c 103 #define ROUTER_ALERT 0x9404U
GordonSin 0:0ed2a7c7190c 104 #define ROUTER_ALERTLEN 4
GordonSin 0:0ed2a7c7190c 105
GordonSin 0:0ed2a7c7190c 106 /*
GordonSin 0:0ed2a7c7190c 107 * IGMP message types, including version number.
GordonSin 0:0ed2a7c7190c 108 */
GordonSin 0:0ed2a7c7190c 109 #define IGMP_MEMB_QUERY 0x11 /* Membership query */
GordonSin 0:0ed2a7c7190c 110 #define IGMP_V1_MEMB_REPORT 0x12 /* Ver. 1 membership report */
GordonSin 0:0ed2a7c7190c 111 #define IGMP_V2_MEMB_REPORT 0x16 /* Ver. 2 membership report */
GordonSin 0:0ed2a7c7190c 112 #define IGMP_LEAVE_GROUP 0x17 /* Leave-group message */
GordonSin 0:0ed2a7c7190c 113
GordonSin 0:0ed2a7c7190c 114 /* Group membership states */
GordonSin 0:0ed2a7c7190c 115 #define IGMP_GROUP_NON_MEMBER 0
GordonSin 0:0ed2a7c7190c 116 #define IGMP_GROUP_DELAYING_MEMBER 1
GordonSin 0:0ed2a7c7190c 117 #define IGMP_GROUP_IDLE_MEMBER 2
GordonSin 0:0ed2a7c7190c 118
GordonSin 0:0ed2a7c7190c 119 /**
GordonSin 0:0ed2a7c7190c 120 * IGMP packet format.
GordonSin 0:0ed2a7c7190c 121 */
GordonSin 0:0ed2a7c7190c 122 #ifdef PACK_STRUCT_USE_INCLUDES
GordonSin 0:0ed2a7c7190c 123 # include "arch/bpstruct.h"
GordonSin 0:0ed2a7c7190c 124 #endif
GordonSin 0:0ed2a7c7190c 125 PACK_STRUCT_BEGIN
GordonSin 0:0ed2a7c7190c 126 struct igmp_msg {
GordonSin 0:0ed2a7c7190c 127 PACK_STRUCT_FIELD(u8_t igmp_msgtype);
GordonSin 0:0ed2a7c7190c 128 PACK_STRUCT_FIELD(u8_t igmp_maxresp);
GordonSin 0:0ed2a7c7190c 129 PACK_STRUCT_FIELD(u16_t igmp_checksum);
GordonSin 0:0ed2a7c7190c 130 PACK_STRUCT_FIELD(ip_addr_p_t igmp_group_address);
GordonSin 0:0ed2a7c7190c 131 } PACK_STRUCT_STRUCT;
GordonSin 0:0ed2a7c7190c 132 PACK_STRUCT_END
GordonSin 0:0ed2a7c7190c 133 #ifdef PACK_STRUCT_USE_INCLUDES
GordonSin 0:0ed2a7c7190c 134 # include "arch/epstruct.h"
GordonSin 0:0ed2a7c7190c 135 #endif
GordonSin 0:0ed2a7c7190c 136
GordonSin 0:0ed2a7c7190c 137
GordonSin 0:0ed2a7c7190c 138 static struct igmp_group *igmp_lookup_group(struct netif *ifp, ip_addr_t *addr);
GordonSin 0:0ed2a7c7190c 139 static err_t igmp_remove_group(struct igmp_group *group);
GordonSin 0:0ed2a7c7190c 140 static void igmp_timeout( struct igmp_group *group);
GordonSin 0:0ed2a7c7190c 141 static void igmp_start_timer(struct igmp_group *group, u8_t max_time);
GordonSin 0:0ed2a7c7190c 142 static void igmp_stop_timer(struct igmp_group *group);
GordonSin 0:0ed2a7c7190c 143 static void igmp_delaying_member(struct igmp_group *group, u8_t maxresp);
GordonSin 0:0ed2a7c7190c 144 static err_t igmp_ip_output_if(struct pbuf *p, ip_addr_t *src, ip_addr_t *dest, struct netif *netif);
GordonSin 0:0ed2a7c7190c 145 static void igmp_send(struct igmp_group *group, u8_t type);
GordonSin 0:0ed2a7c7190c 146
GordonSin 0:0ed2a7c7190c 147
GordonSin 0:0ed2a7c7190c 148 static struct igmp_group* igmp_group_list;
GordonSin 0:0ed2a7c7190c 149 static ip_addr_t allsystems;
GordonSin 0:0ed2a7c7190c 150 static ip_addr_t allrouters;
GordonSin 0:0ed2a7c7190c 151
GordonSin 0:0ed2a7c7190c 152
GordonSin 0:0ed2a7c7190c 153 /**
GordonSin 0:0ed2a7c7190c 154 * Initialize the IGMP module
GordonSin 0:0ed2a7c7190c 155 */
GordonSin 0:0ed2a7c7190c 156 void
GordonSin 0:0ed2a7c7190c 157 igmp_init(void)
GordonSin 0:0ed2a7c7190c 158 {
GordonSin 0:0ed2a7c7190c 159 LWIP_DEBUGF(IGMP_DEBUG, ("igmp_init: initializing\n"));
GordonSin 0:0ed2a7c7190c 160
GordonSin 0:0ed2a7c7190c 161 IP4_ADDR(&allsystems, 224, 0, 0, 1);
GordonSin 0:0ed2a7c7190c 162 IP4_ADDR(&allrouters, 224, 0, 0, 2);
GordonSin 0:0ed2a7c7190c 163 }
GordonSin 0:0ed2a7c7190c 164
GordonSin 0:0ed2a7c7190c 165 #ifdef LWIP_DEBUG
GordonSin 0:0ed2a7c7190c 166 /**
GordonSin 0:0ed2a7c7190c 167 * Dump global IGMP groups list
GordonSin 0:0ed2a7c7190c 168 */
GordonSin 0:0ed2a7c7190c 169 void
GordonSin 0:0ed2a7c7190c 170 igmp_dump_group_list()
GordonSin 0:0ed2a7c7190c 171 {
GordonSin 0:0ed2a7c7190c 172 struct igmp_group *group = igmp_group_list;
GordonSin 0:0ed2a7c7190c 173
GordonSin 0:0ed2a7c7190c 174 while (group != NULL) {
GordonSin 0:0ed2a7c7190c 175 LWIP_DEBUGF(IGMP_DEBUG, ("igmp_dump_group_list: [%"U32_F"] ", (u32_t)(group->group_state)));
GordonSin 0:0ed2a7c7190c 176 ip_addr_debug_print(IGMP_DEBUG, &group->group_address);
GordonSin 0:0ed2a7c7190c 177 LWIP_DEBUGF(IGMP_DEBUG, (" on if %p\n", group->netif));
GordonSin 0:0ed2a7c7190c 178 group = group->next;
GordonSin 0:0ed2a7c7190c 179 }
GordonSin 0:0ed2a7c7190c 180 LWIP_DEBUGF(IGMP_DEBUG, ("\n"));
GordonSin 0:0ed2a7c7190c 181 }
GordonSin 0:0ed2a7c7190c 182 #else
GordonSin 0:0ed2a7c7190c 183 #define igmp_dump_group_list()
GordonSin 0:0ed2a7c7190c 184 #endif /* LWIP_DEBUG */
GordonSin 0:0ed2a7c7190c 185
GordonSin 0:0ed2a7c7190c 186 /**
GordonSin 0:0ed2a7c7190c 187 * Start IGMP processing on interface
GordonSin 0:0ed2a7c7190c 188 *
GordonSin 0:0ed2a7c7190c 189 * @param netif network interface on which start IGMP processing
GordonSin 0:0ed2a7c7190c 190 */
GordonSin 0:0ed2a7c7190c 191 err_t
GordonSin 0:0ed2a7c7190c 192 igmp_start(struct netif *netif)
GordonSin 0:0ed2a7c7190c 193 {
GordonSin 0:0ed2a7c7190c 194 struct igmp_group* group;
GordonSin 0:0ed2a7c7190c 195
GordonSin 0:0ed2a7c7190c 196 LWIP_DEBUGF(IGMP_DEBUG, ("igmp_start: starting IGMP processing on if %p\n", netif));
GordonSin 0:0ed2a7c7190c 197
GordonSin 0:0ed2a7c7190c 198 group = igmp_lookup_group(netif, &allsystems);
GordonSin 0:0ed2a7c7190c 199
GordonSin 0:0ed2a7c7190c 200 if (group != NULL) {
GordonSin 0:0ed2a7c7190c 201 group->group_state = IGMP_GROUP_IDLE_MEMBER;
GordonSin 0:0ed2a7c7190c 202 group->use++;
GordonSin 0:0ed2a7c7190c 203
GordonSin 0:0ed2a7c7190c 204 /* Allow the igmp messages at the MAC level */
GordonSin 0:0ed2a7c7190c 205 if (netif->igmp_mac_filter != NULL) {
GordonSin 0:0ed2a7c7190c 206 LWIP_DEBUGF(IGMP_DEBUG, ("igmp_start: igmp_mac_filter(ADD "));
GordonSin 0:0ed2a7c7190c 207 ip_addr_debug_print(IGMP_DEBUG, &allsystems);
GordonSin 0:0ed2a7c7190c 208 LWIP_DEBUGF(IGMP_DEBUG, (") on if %p\n", netif));
GordonSin 0:0ed2a7c7190c 209 netif->igmp_mac_filter(netif, &allsystems, IGMP_ADD_MAC_FILTER);
GordonSin 0:0ed2a7c7190c 210 }
GordonSin 0:0ed2a7c7190c 211
GordonSin 0:0ed2a7c7190c 212 return ERR_OK;
GordonSin 0:0ed2a7c7190c 213 }
GordonSin 0:0ed2a7c7190c 214
GordonSin 0:0ed2a7c7190c 215 return ERR_MEM;
GordonSin 0:0ed2a7c7190c 216 }
GordonSin 0:0ed2a7c7190c 217
GordonSin 0:0ed2a7c7190c 218 /**
GordonSin 0:0ed2a7c7190c 219 * Stop IGMP processing on interface
GordonSin 0:0ed2a7c7190c 220 *
GordonSin 0:0ed2a7c7190c 221 * @param netif network interface on which stop IGMP processing
GordonSin 0:0ed2a7c7190c 222 */
GordonSin 0:0ed2a7c7190c 223 err_t
GordonSin 0:0ed2a7c7190c 224 igmp_stop(struct netif *netif)
GordonSin 0:0ed2a7c7190c 225 {
GordonSin 0:0ed2a7c7190c 226 struct igmp_group *group = igmp_group_list;
GordonSin 0:0ed2a7c7190c 227 struct igmp_group *prev = NULL;
GordonSin 0:0ed2a7c7190c 228 struct igmp_group *next;
GordonSin 0:0ed2a7c7190c 229
GordonSin 0:0ed2a7c7190c 230 /* look for groups joined on this interface further down the list */
GordonSin 0:0ed2a7c7190c 231 while (group != NULL) {
GordonSin 0:0ed2a7c7190c 232 next = group->next;
GordonSin 0:0ed2a7c7190c 233 /* is it a group joined on this interface? */
GordonSin 0:0ed2a7c7190c 234 if (group->netif == netif) {
GordonSin 0:0ed2a7c7190c 235 /* is it the first group of the list? */
GordonSin 0:0ed2a7c7190c 236 if (group == igmp_group_list) {
GordonSin 0:0ed2a7c7190c 237 igmp_group_list = next;
GordonSin 0:0ed2a7c7190c 238 }
GordonSin 0:0ed2a7c7190c 239 /* is there a "previous" group defined? */
GordonSin 0:0ed2a7c7190c 240 if (prev != NULL) {
GordonSin 0:0ed2a7c7190c 241 prev->next = next;
GordonSin 0:0ed2a7c7190c 242 }
GordonSin 0:0ed2a7c7190c 243 /* disable the group at the MAC level */
GordonSin 0:0ed2a7c7190c 244 if (netif->igmp_mac_filter != NULL) {
GordonSin 0:0ed2a7c7190c 245 LWIP_DEBUGF(IGMP_DEBUG, ("igmp_stop: igmp_mac_filter(DEL "));
GordonSin 0:0ed2a7c7190c 246 ip_addr_debug_print(IGMP_DEBUG, &group->group_address);
GordonSin 0:0ed2a7c7190c 247 LWIP_DEBUGF(IGMP_DEBUG, (") on if %p\n", netif));
GordonSin 0:0ed2a7c7190c 248 netif->igmp_mac_filter(netif, &(group->group_address), IGMP_DEL_MAC_FILTER);
GordonSin 0:0ed2a7c7190c 249 }
GordonSin 0:0ed2a7c7190c 250 /* free group */
GordonSin 0:0ed2a7c7190c 251 memp_free(MEMP_IGMP_GROUP, group);
GordonSin 0:0ed2a7c7190c 252 } else {
GordonSin 0:0ed2a7c7190c 253 /* change the "previous" */
GordonSin 0:0ed2a7c7190c 254 prev = group;
GordonSin 0:0ed2a7c7190c 255 }
GordonSin 0:0ed2a7c7190c 256 /* move to "next" */
GordonSin 0:0ed2a7c7190c 257 group = next;
GordonSin 0:0ed2a7c7190c 258 }
GordonSin 0:0ed2a7c7190c 259 return ERR_OK;
GordonSin 0:0ed2a7c7190c 260 }
GordonSin 0:0ed2a7c7190c 261
GordonSin 0:0ed2a7c7190c 262 /**
GordonSin 0:0ed2a7c7190c 263 * Report IGMP memberships for this interface
GordonSin 0:0ed2a7c7190c 264 *
GordonSin 0:0ed2a7c7190c 265 * @param netif network interface on which report IGMP memberships
GordonSin 0:0ed2a7c7190c 266 */
GordonSin 0:0ed2a7c7190c 267 void
GordonSin 0:0ed2a7c7190c 268 igmp_report_groups(struct netif *netif)
GordonSin 0:0ed2a7c7190c 269 {
GordonSin 0:0ed2a7c7190c 270 struct igmp_group *group = igmp_group_list;
GordonSin 0:0ed2a7c7190c 271
GordonSin 0:0ed2a7c7190c 272 LWIP_DEBUGF(IGMP_DEBUG, ("igmp_report_groups: sending IGMP reports on if %p\n", netif));
GordonSin 0:0ed2a7c7190c 273
GordonSin 0:0ed2a7c7190c 274 while (group != NULL) {
GordonSin 0:0ed2a7c7190c 275 if (group->netif == netif) {
GordonSin 0:0ed2a7c7190c 276 igmp_delaying_member(group, IGMP_JOIN_DELAYING_MEMBER_TMR);
GordonSin 0:0ed2a7c7190c 277 }
GordonSin 0:0ed2a7c7190c 278 group = group->next;
GordonSin 0:0ed2a7c7190c 279 }
GordonSin 0:0ed2a7c7190c 280 }
GordonSin 0:0ed2a7c7190c 281
GordonSin 0:0ed2a7c7190c 282 /**
GordonSin 0:0ed2a7c7190c 283 * Search for a group in the global igmp_group_list
GordonSin 0:0ed2a7c7190c 284 *
GordonSin 0:0ed2a7c7190c 285 * @param ifp the network interface for which to look
GordonSin 0:0ed2a7c7190c 286 * @param addr the group ip address to search for
GordonSin 0:0ed2a7c7190c 287 * @return a struct igmp_group* if the group has been found,
GordonSin 0:0ed2a7c7190c 288 * NULL if the group wasn't found.
GordonSin 0:0ed2a7c7190c 289 */
GordonSin 0:0ed2a7c7190c 290 struct igmp_group *
GordonSin 0:0ed2a7c7190c 291 igmp_lookfor_group(struct netif *ifp, ip_addr_t *addr)
GordonSin 0:0ed2a7c7190c 292 {
GordonSin 0:0ed2a7c7190c 293 struct igmp_group *group = igmp_group_list;
GordonSin 0:0ed2a7c7190c 294
GordonSin 0:0ed2a7c7190c 295 while (group != NULL) {
GordonSin 0:0ed2a7c7190c 296 if ((group->netif == ifp) && (ip_addr_cmp(&(group->group_address), addr))) {
GordonSin 0:0ed2a7c7190c 297 return group;
GordonSin 0:0ed2a7c7190c 298 }
GordonSin 0:0ed2a7c7190c 299 group = group->next;
GordonSin 0:0ed2a7c7190c 300 }
GordonSin 0:0ed2a7c7190c 301
GordonSin 0:0ed2a7c7190c 302 /* to be clearer, we return NULL here instead of
GordonSin 0:0ed2a7c7190c 303 * 'group' (which is also NULL at this point).
GordonSin 0:0ed2a7c7190c 304 */
GordonSin 0:0ed2a7c7190c 305 return NULL;
GordonSin 0:0ed2a7c7190c 306 }
GordonSin 0:0ed2a7c7190c 307
GordonSin 0:0ed2a7c7190c 308 /**
GordonSin 0:0ed2a7c7190c 309 * Search for a specific igmp group and create a new one if not found-
GordonSin 0:0ed2a7c7190c 310 *
GordonSin 0:0ed2a7c7190c 311 * @param ifp the network interface for which to look
GordonSin 0:0ed2a7c7190c 312 * @param addr the group ip address to search
GordonSin 0:0ed2a7c7190c 313 * @return a struct igmp_group*,
GordonSin 0:0ed2a7c7190c 314 * NULL on memory error.
GordonSin 0:0ed2a7c7190c 315 */
GordonSin 0:0ed2a7c7190c 316 struct igmp_group *
GordonSin 0:0ed2a7c7190c 317 igmp_lookup_group(struct netif *ifp, ip_addr_t *addr)
GordonSin 0:0ed2a7c7190c 318 {
GordonSin 0:0ed2a7c7190c 319 struct igmp_group *group = igmp_group_list;
GordonSin 0:0ed2a7c7190c 320
GordonSin 0:0ed2a7c7190c 321 /* Search if the group already exists */
GordonSin 0:0ed2a7c7190c 322 group = igmp_lookfor_group(ifp, addr);
GordonSin 0:0ed2a7c7190c 323 if (group != NULL) {
GordonSin 0:0ed2a7c7190c 324 /* Group already exists. */
GordonSin 0:0ed2a7c7190c 325 return group;
GordonSin 0:0ed2a7c7190c 326 }
GordonSin 0:0ed2a7c7190c 327
GordonSin 0:0ed2a7c7190c 328 /* Group doesn't exist yet, create a new one */
GordonSin 0:0ed2a7c7190c 329 group = (struct igmp_group *)memp_malloc(MEMP_IGMP_GROUP);
GordonSin 0:0ed2a7c7190c 330 if (group != NULL) {
GordonSin 0:0ed2a7c7190c 331 group->netif = ifp;
GordonSin 0:0ed2a7c7190c 332 ip_addr_set(&(group->group_address), addr);
GordonSin 0:0ed2a7c7190c 333 group->timer = 0; /* Not running */
GordonSin 0:0ed2a7c7190c 334 group->group_state = IGMP_GROUP_NON_MEMBER;
GordonSin 0:0ed2a7c7190c 335 group->last_reporter_flag = 0;
GordonSin 0:0ed2a7c7190c 336 group->use = 0;
GordonSin 0:0ed2a7c7190c 337 group->next = igmp_group_list;
GordonSin 0:0ed2a7c7190c 338
GordonSin 0:0ed2a7c7190c 339 igmp_group_list = group;
GordonSin 0:0ed2a7c7190c 340 }
GordonSin 0:0ed2a7c7190c 341
GordonSin 0:0ed2a7c7190c 342 LWIP_DEBUGF(IGMP_DEBUG, ("igmp_lookup_group: %sallocated a new group with address ", (group?"":"impossible to ")));
GordonSin 0:0ed2a7c7190c 343 ip_addr_debug_print(IGMP_DEBUG, addr);
GordonSin 0:0ed2a7c7190c 344 LWIP_DEBUGF(IGMP_DEBUG, (" on if %p\n", ifp));
GordonSin 0:0ed2a7c7190c 345
GordonSin 0:0ed2a7c7190c 346 return group;
GordonSin 0:0ed2a7c7190c 347 }
GordonSin 0:0ed2a7c7190c 348
GordonSin 0:0ed2a7c7190c 349 /**
GordonSin 0:0ed2a7c7190c 350 * Remove a group in the global igmp_group_list
GordonSin 0:0ed2a7c7190c 351 *
GordonSin 0:0ed2a7c7190c 352 * @param group the group to remove from the global igmp_group_list
GordonSin 0:0ed2a7c7190c 353 * @return ERR_OK if group was removed from the list, an err_t otherwise
GordonSin 0:0ed2a7c7190c 354 */
GordonSin 0:0ed2a7c7190c 355 static err_t
GordonSin 0:0ed2a7c7190c 356 igmp_remove_group(struct igmp_group *group)
GordonSin 0:0ed2a7c7190c 357 {
GordonSin 0:0ed2a7c7190c 358 err_t err = ERR_OK;
GordonSin 0:0ed2a7c7190c 359
GordonSin 0:0ed2a7c7190c 360 /* Is it the first group? */
GordonSin 0:0ed2a7c7190c 361 if (igmp_group_list == group) {
GordonSin 0:0ed2a7c7190c 362 igmp_group_list = group->next;
GordonSin 0:0ed2a7c7190c 363 } else {
GordonSin 0:0ed2a7c7190c 364 /* look for group further down the list */
GordonSin 0:0ed2a7c7190c 365 struct igmp_group *tmpGroup;
GordonSin 0:0ed2a7c7190c 366 for (tmpGroup = igmp_group_list; tmpGroup != NULL; tmpGroup = tmpGroup->next) {
GordonSin 0:0ed2a7c7190c 367 if (tmpGroup->next == group) {
GordonSin 0:0ed2a7c7190c 368 tmpGroup->next = group->next;
GordonSin 0:0ed2a7c7190c 369 break;
GordonSin 0:0ed2a7c7190c 370 }
GordonSin 0:0ed2a7c7190c 371 }
GordonSin 0:0ed2a7c7190c 372 /* Group not found in the global igmp_group_list */
GordonSin 0:0ed2a7c7190c 373 if (tmpGroup == NULL)
GordonSin 0:0ed2a7c7190c 374 err = ERR_ARG;
GordonSin 0:0ed2a7c7190c 375 }
GordonSin 0:0ed2a7c7190c 376 /* free group */
GordonSin 0:0ed2a7c7190c 377 memp_free(MEMP_IGMP_GROUP, group);
GordonSin 0:0ed2a7c7190c 378
GordonSin 0:0ed2a7c7190c 379 return err;
GordonSin 0:0ed2a7c7190c 380 }
GordonSin 0:0ed2a7c7190c 381
GordonSin 0:0ed2a7c7190c 382 /**
GordonSin 0:0ed2a7c7190c 383 * Called from ip_input() if a new IGMP packet is received.
GordonSin 0:0ed2a7c7190c 384 *
GordonSin 0:0ed2a7c7190c 385 * @param p received igmp packet, p->payload pointing to the ip header
GordonSin 0:0ed2a7c7190c 386 * @param inp network interface on which the packet was received
GordonSin 0:0ed2a7c7190c 387 * @param dest destination ip address of the igmp packet
GordonSin 0:0ed2a7c7190c 388 */
GordonSin 0:0ed2a7c7190c 389 void
GordonSin 0:0ed2a7c7190c 390 igmp_input(struct pbuf *p, struct netif *inp, ip_addr_t *dest)
GordonSin 0:0ed2a7c7190c 391 {
GordonSin 0:0ed2a7c7190c 392 struct ip_hdr * iphdr;
GordonSin 0:0ed2a7c7190c 393 struct igmp_msg* igmp;
GordonSin 0:0ed2a7c7190c 394 struct igmp_group* group;
GordonSin 0:0ed2a7c7190c 395 struct igmp_group* groupref;
GordonSin 0:0ed2a7c7190c 396
GordonSin 0:0ed2a7c7190c 397 IGMP_STATS_INC(igmp.recv);
GordonSin 0:0ed2a7c7190c 398
GordonSin 0:0ed2a7c7190c 399 /* Note that the length CAN be greater than 8 but only 8 are used - All are included in the checksum */
GordonSin 0:0ed2a7c7190c 400 iphdr = (struct ip_hdr *)p->payload;
GordonSin 0:0ed2a7c7190c 401 if (pbuf_header(p, -(s16_t)(IPH_HL(iphdr) * 4)) || (p->len < IGMP_MINLEN)) {
GordonSin 0:0ed2a7c7190c 402 pbuf_free(p);
GordonSin 0:0ed2a7c7190c 403 IGMP_STATS_INC(igmp.lenerr);
GordonSin 0:0ed2a7c7190c 404 LWIP_DEBUGF(IGMP_DEBUG, ("igmp_input: length error\n"));
GordonSin 0:0ed2a7c7190c 405 return;
GordonSin 0:0ed2a7c7190c 406 }
GordonSin 0:0ed2a7c7190c 407
GordonSin 0:0ed2a7c7190c 408 LWIP_DEBUGF(IGMP_DEBUG, ("igmp_input: message from "));
GordonSin 0:0ed2a7c7190c 409 ip_addr_debug_print(IGMP_DEBUG, &(iphdr->src));
GordonSin 0:0ed2a7c7190c 410 LWIP_DEBUGF(IGMP_DEBUG, (" to address "));
GordonSin 0:0ed2a7c7190c 411 ip_addr_debug_print(IGMP_DEBUG, &(iphdr->dest));
GordonSin 0:0ed2a7c7190c 412 LWIP_DEBUGF(IGMP_DEBUG, (" on if %p\n", inp));
GordonSin 0:0ed2a7c7190c 413
GordonSin 0:0ed2a7c7190c 414 /* Now calculate and check the checksum */
GordonSin 0:0ed2a7c7190c 415 igmp = (struct igmp_msg *)p->payload;
GordonSin 0:0ed2a7c7190c 416 if (inet_chksum(igmp, p->len)) {
GordonSin 0:0ed2a7c7190c 417 pbuf_free(p);
GordonSin 0:0ed2a7c7190c 418 IGMP_STATS_INC(igmp.chkerr);
GordonSin 0:0ed2a7c7190c 419 LWIP_DEBUGF(IGMP_DEBUG, ("igmp_input: checksum error\n"));
GordonSin 0:0ed2a7c7190c 420 return;
GordonSin 0:0ed2a7c7190c 421 }
GordonSin 0:0ed2a7c7190c 422
GordonSin 0:0ed2a7c7190c 423 /* Packet is ok so find an existing group */
GordonSin 0:0ed2a7c7190c 424 group = igmp_lookfor_group(inp, dest); /* use the destination IP address of incoming packet */
GordonSin 0:0ed2a7c7190c 425
GordonSin 0:0ed2a7c7190c 426 /* If group can be found or create... */
GordonSin 0:0ed2a7c7190c 427 if (!group) {
GordonSin 0:0ed2a7c7190c 428 pbuf_free(p);
GordonSin 0:0ed2a7c7190c 429 IGMP_STATS_INC(igmp.drop);
GordonSin 0:0ed2a7c7190c 430 LWIP_DEBUGF(IGMP_DEBUG, ("igmp_input: IGMP frame not for us\n"));
GordonSin 0:0ed2a7c7190c 431 return;
GordonSin 0:0ed2a7c7190c 432 }
GordonSin 0:0ed2a7c7190c 433
GordonSin 0:0ed2a7c7190c 434 /* NOW ACT ON THE INCOMING MESSAGE TYPE... */
GordonSin 0:0ed2a7c7190c 435 switch (igmp->igmp_msgtype) {
GordonSin 0:0ed2a7c7190c 436 case IGMP_MEMB_QUERY: {
GordonSin 0:0ed2a7c7190c 437 /* IGMP_MEMB_QUERY to the "all systems" address ? */
GordonSin 0:0ed2a7c7190c 438 if ((ip_addr_cmp(dest, &allsystems)) && ip_addr_isany(&igmp->igmp_group_address)) {
GordonSin 0:0ed2a7c7190c 439 /* THIS IS THE GENERAL QUERY */
GordonSin 0:0ed2a7c7190c 440 LWIP_DEBUGF(IGMP_DEBUG, ("igmp_input: General IGMP_MEMB_QUERY on \"ALL SYSTEMS\" address (224.0.0.1) [igmp_maxresp=%i]\n", (int)(igmp->igmp_maxresp)));
GordonSin 0:0ed2a7c7190c 441
GordonSin 0:0ed2a7c7190c 442 if (igmp->igmp_maxresp == 0) {
GordonSin 0:0ed2a7c7190c 443 IGMP_STATS_INC(igmp.rx_v1);
GordonSin 0:0ed2a7c7190c 444 LWIP_DEBUGF(IGMP_DEBUG, ("igmp_input: got an all hosts query with time== 0 - this is V1 and not implemented - treat as v2\n"));
GordonSin 0:0ed2a7c7190c 445 igmp->igmp_maxresp = IGMP_V1_DELAYING_MEMBER_TMR;
GordonSin 0:0ed2a7c7190c 446 } else {
GordonSin 0:0ed2a7c7190c 447 IGMP_STATS_INC(igmp.rx_general);
GordonSin 0:0ed2a7c7190c 448 }
GordonSin 0:0ed2a7c7190c 449
GordonSin 0:0ed2a7c7190c 450 groupref = igmp_group_list;
GordonSin 0:0ed2a7c7190c 451 while (groupref) {
GordonSin 0:0ed2a7c7190c 452 /* Do not send messages on the all systems group address! */
GordonSin 0:0ed2a7c7190c 453 if ((groupref->netif == inp) && (!(ip_addr_cmp(&(groupref->group_address), &allsystems)))) {
GordonSin 0:0ed2a7c7190c 454 igmp_delaying_member(groupref, igmp->igmp_maxresp);
GordonSin 0:0ed2a7c7190c 455 }
GordonSin 0:0ed2a7c7190c 456 groupref = groupref->next;
GordonSin 0:0ed2a7c7190c 457 }
GordonSin 0:0ed2a7c7190c 458 } else {
GordonSin 0:0ed2a7c7190c 459 /* IGMP_MEMB_QUERY to a specific group ? */
GordonSin 0:0ed2a7c7190c 460 if (!ip_addr_isany(&igmp->igmp_group_address)) {
GordonSin 0:0ed2a7c7190c 461 LWIP_DEBUGF(IGMP_DEBUG, ("igmp_input: IGMP_MEMB_QUERY to a specific group "));
GordonSin 0:0ed2a7c7190c 462 ip_addr_debug_print(IGMP_DEBUG, &igmp->igmp_group_address);
GordonSin 0:0ed2a7c7190c 463 if (ip_addr_cmp(dest, &allsystems)) {
GordonSin 0:0ed2a7c7190c 464 ip_addr_t groupaddr;
GordonSin 0:0ed2a7c7190c 465 LWIP_DEBUGF(IGMP_DEBUG, (" using \"ALL SYSTEMS\" address (224.0.0.1) [igmp_maxresp=%i]\n", (int)(igmp->igmp_maxresp)));
GordonSin 0:0ed2a7c7190c 466 /* we first need to re-look for the group since we used dest last time */
GordonSin 0:0ed2a7c7190c 467 ip_addr_copy(groupaddr, igmp->igmp_group_address);
GordonSin 0:0ed2a7c7190c 468 group = igmp_lookfor_group(inp, &groupaddr);
GordonSin 0:0ed2a7c7190c 469 } else {
GordonSin 0:0ed2a7c7190c 470 LWIP_DEBUGF(IGMP_DEBUG, (" with the group address as destination [igmp_maxresp=%i]\n", (int)(igmp->igmp_maxresp)));
GordonSin 0:0ed2a7c7190c 471 }
GordonSin 0:0ed2a7c7190c 472
GordonSin 0:0ed2a7c7190c 473 if (group != NULL) {
GordonSin 0:0ed2a7c7190c 474 IGMP_STATS_INC(igmp.rx_group);
GordonSin 0:0ed2a7c7190c 475 igmp_delaying_member(group, igmp->igmp_maxresp);
GordonSin 0:0ed2a7c7190c 476 } else {
GordonSin 0:0ed2a7c7190c 477 IGMP_STATS_INC(igmp.drop);
GordonSin 0:0ed2a7c7190c 478 }
GordonSin 0:0ed2a7c7190c 479 } else {
GordonSin 0:0ed2a7c7190c 480 IGMP_STATS_INC(igmp.proterr);
GordonSin 0:0ed2a7c7190c 481 }
GordonSin 0:0ed2a7c7190c 482 }
GordonSin 0:0ed2a7c7190c 483 break;
GordonSin 0:0ed2a7c7190c 484 }
GordonSin 0:0ed2a7c7190c 485 case IGMP_V2_MEMB_REPORT: {
GordonSin 0:0ed2a7c7190c 486 LWIP_DEBUGF(IGMP_DEBUG, ("igmp_input: IGMP_V2_MEMB_REPORT\n"));
GordonSin 0:0ed2a7c7190c 487 IGMP_STATS_INC(igmp.rx_report);
GordonSin 0:0ed2a7c7190c 488 if (group->group_state == IGMP_GROUP_DELAYING_MEMBER) {
GordonSin 0:0ed2a7c7190c 489 /* This is on a specific group we have already looked up */
GordonSin 0:0ed2a7c7190c 490 group->timer = 0; /* stopped */
GordonSin 0:0ed2a7c7190c 491 group->group_state = IGMP_GROUP_IDLE_MEMBER;
GordonSin 0:0ed2a7c7190c 492 group->last_reporter_flag = 0;
GordonSin 0:0ed2a7c7190c 493 }
GordonSin 0:0ed2a7c7190c 494 break;
GordonSin 0:0ed2a7c7190c 495 }
GordonSin 0:0ed2a7c7190c 496 default: {
GordonSin 0:0ed2a7c7190c 497 LWIP_DEBUGF(IGMP_DEBUG, ("igmp_input: unexpected msg %d in state %d on group %p on if %p\n",
GordonSin 0:0ed2a7c7190c 498 igmp->igmp_msgtype, group->group_state, &group, group->netif));
GordonSin 0:0ed2a7c7190c 499 IGMP_STATS_INC(igmp.proterr);
GordonSin 0:0ed2a7c7190c 500 break;
GordonSin 0:0ed2a7c7190c 501 }
GordonSin 0:0ed2a7c7190c 502 }
GordonSin 0:0ed2a7c7190c 503
GordonSin 0:0ed2a7c7190c 504 pbuf_free(p);
GordonSin 0:0ed2a7c7190c 505 return;
GordonSin 0:0ed2a7c7190c 506 }
GordonSin 0:0ed2a7c7190c 507
GordonSin 0:0ed2a7c7190c 508 /**
GordonSin 0:0ed2a7c7190c 509 * Join a group on one network interface.
GordonSin 0:0ed2a7c7190c 510 *
GordonSin 0:0ed2a7c7190c 511 * @param ifaddr ip address of the network interface which should join a new group
GordonSin 0:0ed2a7c7190c 512 * @param groupaddr the ip address of the group which to join
GordonSin 0:0ed2a7c7190c 513 * @return ERR_OK if group was joined on the netif(s), an err_t otherwise
GordonSin 0:0ed2a7c7190c 514 */
GordonSin 0:0ed2a7c7190c 515 err_t
GordonSin 0:0ed2a7c7190c 516 igmp_joingroup(ip_addr_t *ifaddr, ip_addr_t *groupaddr)
GordonSin 0:0ed2a7c7190c 517 {
GordonSin 0:0ed2a7c7190c 518 err_t err = ERR_VAL; /* no matching interface */
GordonSin 0:0ed2a7c7190c 519 struct igmp_group *group;
GordonSin 0:0ed2a7c7190c 520 struct netif *netif;
GordonSin 0:0ed2a7c7190c 521
GordonSin 0:0ed2a7c7190c 522 /* make sure it is multicast address */
GordonSin 0:0ed2a7c7190c 523 LWIP_ERROR("igmp_joingroup: attempt to join non-multicast address", ip_addr_ismulticast(groupaddr), return ERR_VAL;);
GordonSin 0:0ed2a7c7190c 524 LWIP_ERROR("igmp_joingroup: attempt to join allsystems address", (!ip_addr_cmp(groupaddr, &allsystems)), return ERR_VAL;);
GordonSin 0:0ed2a7c7190c 525
GordonSin 0:0ed2a7c7190c 526 /* loop through netif's */
GordonSin 0:0ed2a7c7190c 527 netif = netif_list;
GordonSin 0:0ed2a7c7190c 528 while (netif != NULL) {
GordonSin 0:0ed2a7c7190c 529 /* Should we join this interface ? */
GordonSin 0:0ed2a7c7190c 530 if ((netif->flags & NETIF_FLAG_IGMP) && ((ip_addr_isany(ifaddr) || ip_addr_cmp(&(netif->ip_addr), ifaddr)))) {
GordonSin 0:0ed2a7c7190c 531 /* find group or create a new one if not found */
GordonSin 0:0ed2a7c7190c 532 group = igmp_lookup_group(netif, groupaddr);
GordonSin 0:0ed2a7c7190c 533
GordonSin 0:0ed2a7c7190c 534 if (group != NULL) {
GordonSin 0:0ed2a7c7190c 535 /* This should create a new group, check the state to make sure */
GordonSin 0:0ed2a7c7190c 536 if (group->group_state != IGMP_GROUP_NON_MEMBER) {
GordonSin 0:0ed2a7c7190c 537 LWIP_DEBUGF(IGMP_DEBUG, ("igmp_joingroup: join to group not in state IGMP_GROUP_NON_MEMBER\n"));
GordonSin 0:0ed2a7c7190c 538 } else {
GordonSin 0:0ed2a7c7190c 539 /* OK - it was new group */
GordonSin 0:0ed2a7c7190c 540 LWIP_DEBUGF(IGMP_DEBUG, ("igmp_joingroup: join to new group: "));
GordonSin 0:0ed2a7c7190c 541 ip_addr_debug_print(IGMP_DEBUG, groupaddr);
GordonSin 0:0ed2a7c7190c 542 LWIP_DEBUGF(IGMP_DEBUG, ("\n"));
GordonSin 0:0ed2a7c7190c 543
GordonSin 0:0ed2a7c7190c 544 /* If first use of the group, allow the group at the MAC level */
GordonSin 0:0ed2a7c7190c 545 if ((group->use==0) && (netif->igmp_mac_filter != NULL)) {
GordonSin 0:0ed2a7c7190c 546 LWIP_DEBUGF(IGMP_DEBUG, ("igmp_joingroup: igmp_mac_filter(ADD "));
GordonSin 0:0ed2a7c7190c 547 ip_addr_debug_print(IGMP_DEBUG, groupaddr);
GordonSin 0:0ed2a7c7190c 548 LWIP_DEBUGF(IGMP_DEBUG, (") on if %p\n", netif));
GordonSin 0:0ed2a7c7190c 549 netif->igmp_mac_filter(netif, groupaddr, IGMP_ADD_MAC_FILTER);
GordonSin 0:0ed2a7c7190c 550 }
GordonSin 0:0ed2a7c7190c 551
GordonSin 0:0ed2a7c7190c 552 IGMP_STATS_INC(igmp.tx_join);
GordonSin 0:0ed2a7c7190c 553 igmp_send(group, IGMP_V2_MEMB_REPORT);
GordonSin 0:0ed2a7c7190c 554
GordonSin 0:0ed2a7c7190c 555 igmp_start_timer(group, IGMP_JOIN_DELAYING_MEMBER_TMR);
GordonSin 0:0ed2a7c7190c 556
GordonSin 0:0ed2a7c7190c 557 /* Need to work out where this timer comes from */
GordonSin 0:0ed2a7c7190c 558 group->group_state = IGMP_GROUP_DELAYING_MEMBER;
GordonSin 0:0ed2a7c7190c 559 }
GordonSin 0:0ed2a7c7190c 560 /* Increment group use */
GordonSin 0:0ed2a7c7190c 561 group->use++;
GordonSin 0:0ed2a7c7190c 562 /* Join on this interface */
GordonSin 0:0ed2a7c7190c 563 err = ERR_OK;
GordonSin 0:0ed2a7c7190c 564 } else {
GordonSin 0:0ed2a7c7190c 565 /* Return an error even if some network interfaces are joined */
GordonSin 0:0ed2a7c7190c 566 /** @todo undo any other netif already joined */
GordonSin 0:0ed2a7c7190c 567 LWIP_DEBUGF(IGMP_DEBUG, ("igmp_joingroup: Not enought memory to join to group\n"));
GordonSin 0:0ed2a7c7190c 568 return ERR_MEM;
GordonSin 0:0ed2a7c7190c 569 }
GordonSin 0:0ed2a7c7190c 570 }
GordonSin 0:0ed2a7c7190c 571 /* proceed to next network interface */
GordonSin 0:0ed2a7c7190c 572 netif = netif->next;
GordonSin 0:0ed2a7c7190c 573 }
GordonSin 0:0ed2a7c7190c 574
GordonSin 0:0ed2a7c7190c 575 return err;
GordonSin 0:0ed2a7c7190c 576 }
GordonSin 0:0ed2a7c7190c 577
GordonSin 0:0ed2a7c7190c 578 /**
GordonSin 0:0ed2a7c7190c 579 * Leave a group on one network interface.
GordonSin 0:0ed2a7c7190c 580 *
GordonSin 0:0ed2a7c7190c 581 * @param ifaddr ip address of the network interface which should leave a group
GordonSin 0:0ed2a7c7190c 582 * @param groupaddr the ip address of the group which to leave
GordonSin 0:0ed2a7c7190c 583 * @return ERR_OK if group was left on the netif(s), an err_t otherwise
GordonSin 0:0ed2a7c7190c 584 */
GordonSin 0:0ed2a7c7190c 585 err_t
GordonSin 0:0ed2a7c7190c 586 igmp_leavegroup(ip_addr_t *ifaddr, ip_addr_t *groupaddr)
GordonSin 0:0ed2a7c7190c 587 {
GordonSin 0:0ed2a7c7190c 588 err_t err = ERR_VAL; /* no matching interface */
GordonSin 0:0ed2a7c7190c 589 struct igmp_group *group;
GordonSin 0:0ed2a7c7190c 590 struct netif *netif;
GordonSin 0:0ed2a7c7190c 591
GordonSin 0:0ed2a7c7190c 592 /* make sure it is multicast address */
GordonSin 0:0ed2a7c7190c 593 LWIP_ERROR("igmp_leavegroup: attempt to leave non-multicast address", ip_addr_ismulticast(groupaddr), return ERR_VAL;);
GordonSin 0:0ed2a7c7190c 594 LWIP_ERROR("igmp_leavegroup: attempt to leave allsystems address", (!ip_addr_cmp(groupaddr, &allsystems)), return ERR_VAL;);
GordonSin 0:0ed2a7c7190c 595
GordonSin 0:0ed2a7c7190c 596 /* loop through netif's */
GordonSin 0:0ed2a7c7190c 597 netif = netif_list;
GordonSin 0:0ed2a7c7190c 598 while (netif != NULL) {
GordonSin 0:0ed2a7c7190c 599 /* Should we leave this interface ? */
GordonSin 0:0ed2a7c7190c 600 if ((netif->flags & NETIF_FLAG_IGMP) && ((ip_addr_isany(ifaddr) || ip_addr_cmp(&(netif->ip_addr), ifaddr)))) {
GordonSin 0:0ed2a7c7190c 601 /* find group */
GordonSin 0:0ed2a7c7190c 602 group = igmp_lookfor_group(netif, groupaddr);
GordonSin 0:0ed2a7c7190c 603
GordonSin 0:0ed2a7c7190c 604 if (group != NULL) {
GordonSin 0:0ed2a7c7190c 605 /* Only send a leave if the flag is set according to the state diagram */
GordonSin 0:0ed2a7c7190c 606 LWIP_DEBUGF(IGMP_DEBUG, ("igmp_leavegroup: Leaving group: "));
GordonSin 0:0ed2a7c7190c 607 ip_addr_debug_print(IGMP_DEBUG, groupaddr);
GordonSin 0:0ed2a7c7190c 608 LWIP_DEBUGF(IGMP_DEBUG, ("\n"));
GordonSin 0:0ed2a7c7190c 609
GordonSin 0:0ed2a7c7190c 610 /* If there is no other use of the group */
GordonSin 0:0ed2a7c7190c 611 if (group->use <= 1) {
GordonSin 0:0ed2a7c7190c 612 /* If we are the last reporter for this group */
GordonSin 0:0ed2a7c7190c 613 if (group->last_reporter_flag) {
GordonSin 0:0ed2a7c7190c 614 LWIP_DEBUGF(IGMP_DEBUG, ("igmp_leavegroup: sending leaving group\n"));
GordonSin 0:0ed2a7c7190c 615 IGMP_STATS_INC(igmp.tx_leave);
GordonSin 0:0ed2a7c7190c 616 igmp_send(group, IGMP_LEAVE_GROUP);
GordonSin 0:0ed2a7c7190c 617 }
GordonSin 0:0ed2a7c7190c 618
GordonSin 0:0ed2a7c7190c 619 /* Disable the group at the MAC level */
GordonSin 0:0ed2a7c7190c 620 if (netif->igmp_mac_filter != NULL) {
GordonSin 0:0ed2a7c7190c 621 LWIP_DEBUGF(IGMP_DEBUG, ("igmp_leavegroup: igmp_mac_filter(DEL "));
GordonSin 0:0ed2a7c7190c 622 ip_addr_debug_print(IGMP_DEBUG, groupaddr);
GordonSin 0:0ed2a7c7190c 623 LWIP_DEBUGF(IGMP_DEBUG, (") on if %p\n", netif));
GordonSin 0:0ed2a7c7190c 624 netif->igmp_mac_filter(netif, groupaddr, IGMP_DEL_MAC_FILTER);
GordonSin 0:0ed2a7c7190c 625 }
GordonSin 0:0ed2a7c7190c 626
GordonSin 0:0ed2a7c7190c 627 LWIP_DEBUGF(IGMP_DEBUG, ("igmp_leavegroup: remove group: "));
GordonSin 0:0ed2a7c7190c 628 ip_addr_debug_print(IGMP_DEBUG, groupaddr);
GordonSin 0:0ed2a7c7190c 629 LWIP_DEBUGF(IGMP_DEBUG, ("\n"));
GordonSin 0:0ed2a7c7190c 630
GordonSin 0:0ed2a7c7190c 631 /* Free the group */
GordonSin 0:0ed2a7c7190c 632 igmp_remove_group(group);
GordonSin 0:0ed2a7c7190c 633 } else {
GordonSin 0:0ed2a7c7190c 634 /* Decrement group use */
GordonSin 0:0ed2a7c7190c 635 group->use--;
GordonSin 0:0ed2a7c7190c 636 }
GordonSin 0:0ed2a7c7190c 637 /* Leave on this interface */
GordonSin 0:0ed2a7c7190c 638 err = ERR_OK;
GordonSin 0:0ed2a7c7190c 639 } else {
GordonSin 0:0ed2a7c7190c 640 /* It's not a fatal error on "leavegroup" */
GordonSin 0:0ed2a7c7190c 641 LWIP_DEBUGF(IGMP_DEBUG, ("igmp_leavegroup: not member of group\n"));
GordonSin 0:0ed2a7c7190c 642 }
GordonSin 0:0ed2a7c7190c 643 }
GordonSin 0:0ed2a7c7190c 644 /* proceed to next network interface */
GordonSin 0:0ed2a7c7190c 645 netif = netif->next;
GordonSin 0:0ed2a7c7190c 646 }
GordonSin 0:0ed2a7c7190c 647
GordonSin 0:0ed2a7c7190c 648 return err;
GordonSin 0:0ed2a7c7190c 649 }
GordonSin 0:0ed2a7c7190c 650
GordonSin 0:0ed2a7c7190c 651 /**
GordonSin 0:0ed2a7c7190c 652 * The igmp timer function (both for NO_SYS=1 and =0)
GordonSin 0:0ed2a7c7190c 653 * Should be called every IGMP_TMR_INTERVAL milliseconds (100 ms is default).
GordonSin 0:0ed2a7c7190c 654 */
GordonSin 0:0ed2a7c7190c 655 void
GordonSin 0:0ed2a7c7190c 656 igmp_tmr(void)
GordonSin 0:0ed2a7c7190c 657 {
GordonSin 0:0ed2a7c7190c 658 struct igmp_group *group = igmp_group_list;
GordonSin 0:0ed2a7c7190c 659
GordonSin 0:0ed2a7c7190c 660 while (group != NULL) {
GordonSin 0:0ed2a7c7190c 661 if (group->timer > 0) {
GordonSin 0:0ed2a7c7190c 662 group->timer--;
GordonSin 0:0ed2a7c7190c 663 if (group->timer == 0) {
GordonSin 0:0ed2a7c7190c 664 igmp_timeout(group);
GordonSin 0:0ed2a7c7190c 665 }
GordonSin 0:0ed2a7c7190c 666 }
GordonSin 0:0ed2a7c7190c 667 group = group->next;
GordonSin 0:0ed2a7c7190c 668 }
GordonSin 0:0ed2a7c7190c 669 }
GordonSin 0:0ed2a7c7190c 670
GordonSin 0:0ed2a7c7190c 671 /**
GordonSin 0:0ed2a7c7190c 672 * Called if a timeout for one group is reached.
GordonSin 0:0ed2a7c7190c 673 * Sends a report for this group.
GordonSin 0:0ed2a7c7190c 674 *
GordonSin 0:0ed2a7c7190c 675 * @param group an igmp_group for which a timeout is reached
GordonSin 0:0ed2a7c7190c 676 */
GordonSin 0:0ed2a7c7190c 677 static void
GordonSin 0:0ed2a7c7190c 678 igmp_timeout(struct igmp_group *group)
GordonSin 0:0ed2a7c7190c 679 {
GordonSin 0:0ed2a7c7190c 680 /* If the state is IGMP_GROUP_DELAYING_MEMBER then we send a report for this group */
GordonSin 0:0ed2a7c7190c 681 if (group->group_state == IGMP_GROUP_DELAYING_MEMBER) {
GordonSin 0:0ed2a7c7190c 682 LWIP_DEBUGF(IGMP_DEBUG, ("igmp_timeout: report membership for group with address "));
GordonSin 0:0ed2a7c7190c 683 ip_addr_debug_print(IGMP_DEBUG, &(group->group_address));
GordonSin 0:0ed2a7c7190c 684 LWIP_DEBUGF(IGMP_DEBUG, (" on if %p\n", group->netif));
GordonSin 0:0ed2a7c7190c 685
GordonSin 0:0ed2a7c7190c 686 IGMP_STATS_INC(igmp.tx_report);
GordonSin 0:0ed2a7c7190c 687 igmp_send(group, IGMP_V2_MEMB_REPORT);
GordonSin 0:0ed2a7c7190c 688 }
GordonSin 0:0ed2a7c7190c 689 }
GordonSin 0:0ed2a7c7190c 690
GordonSin 0:0ed2a7c7190c 691 /**
GordonSin 0:0ed2a7c7190c 692 * Start a timer for an igmp group
GordonSin 0:0ed2a7c7190c 693 *
GordonSin 0:0ed2a7c7190c 694 * @param group the igmp_group for which to start a timer
GordonSin 0:0ed2a7c7190c 695 * @param max_time the time in multiples of IGMP_TMR_INTERVAL (decrease with
GordonSin 0:0ed2a7c7190c 696 * every call to igmp_tmr())
GordonSin 0:0ed2a7c7190c 697 */
GordonSin 0:0ed2a7c7190c 698 static void
GordonSin 0:0ed2a7c7190c 699 igmp_start_timer(struct igmp_group *group, u8_t max_time)
GordonSin 0:0ed2a7c7190c 700 {
GordonSin 0:0ed2a7c7190c 701 /* ensure the input value is > 0 */
GordonSin 0:0ed2a7c7190c 702 if (max_time == 0) {
GordonSin 0:0ed2a7c7190c 703 max_time = 1;
GordonSin 0:0ed2a7c7190c 704 }
GordonSin 0:0ed2a7c7190c 705 /* ensure the random value is > 0 */
GordonSin 0:0ed2a7c7190c 706 group->timer = (LWIP_RAND() % (max_time - 1)) + 1;
GordonSin 0:0ed2a7c7190c 707 }
GordonSin 0:0ed2a7c7190c 708
GordonSin 0:0ed2a7c7190c 709 /**
GordonSin 0:0ed2a7c7190c 710 * Stop a timer for an igmp_group
GordonSin 0:0ed2a7c7190c 711 *
GordonSin 0:0ed2a7c7190c 712 * @param group the igmp_group for which to stop the timer
GordonSin 0:0ed2a7c7190c 713 */
GordonSin 0:0ed2a7c7190c 714 static void
GordonSin 0:0ed2a7c7190c 715 igmp_stop_timer(struct igmp_group *group)
GordonSin 0:0ed2a7c7190c 716 {
GordonSin 0:0ed2a7c7190c 717 group->timer = 0;
GordonSin 0:0ed2a7c7190c 718 }
GordonSin 0:0ed2a7c7190c 719
GordonSin 0:0ed2a7c7190c 720 /**
GordonSin 0:0ed2a7c7190c 721 * Delaying membership report for a group if necessary
GordonSin 0:0ed2a7c7190c 722 *
GordonSin 0:0ed2a7c7190c 723 * @param group the igmp_group for which "delaying" membership report
GordonSin 0:0ed2a7c7190c 724 * @param maxresp query delay
GordonSin 0:0ed2a7c7190c 725 */
GordonSin 0:0ed2a7c7190c 726 static void
GordonSin 0:0ed2a7c7190c 727 igmp_delaying_member(struct igmp_group *group, u8_t maxresp)
GordonSin 0:0ed2a7c7190c 728 {
GordonSin 0:0ed2a7c7190c 729 if ((group->group_state == IGMP_GROUP_IDLE_MEMBER) ||
GordonSin 0:0ed2a7c7190c 730 ((group->group_state == IGMP_GROUP_DELAYING_MEMBER) &&
GordonSin 0:0ed2a7c7190c 731 ((group->timer == 0) || (maxresp < group->timer)))) {
GordonSin 0:0ed2a7c7190c 732 igmp_start_timer(group, maxresp);
GordonSin 0:0ed2a7c7190c 733 group->group_state = IGMP_GROUP_DELAYING_MEMBER;
GordonSin 0:0ed2a7c7190c 734 }
GordonSin 0:0ed2a7c7190c 735 }
GordonSin 0:0ed2a7c7190c 736
GordonSin 0:0ed2a7c7190c 737
GordonSin 0:0ed2a7c7190c 738 /**
GordonSin 0:0ed2a7c7190c 739 * Sends an IP packet on a network interface. This function constructs the IP header
GordonSin 0:0ed2a7c7190c 740 * and calculates the IP header checksum. If the source IP address is NULL,
GordonSin 0:0ed2a7c7190c 741 * the IP address of the outgoing network interface is filled in as source address.
GordonSin 0:0ed2a7c7190c 742 *
GordonSin 0:0ed2a7c7190c 743 * @param p the packet to send (p->payload points to the data, e.g. next
GordonSin 0:0ed2a7c7190c 744 protocol header; if dest == IP_HDRINCL, p already includes an IP
GordonSin 0:0ed2a7c7190c 745 header and p->payload points to that IP header)
GordonSin 0:0ed2a7c7190c 746 * @param src the source IP address to send from (if src == IP_ADDR_ANY, the
GordonSin 0:0ed2a7c7190c 747 * IP address of the netif used to send is used as source address)
GordonSin 0:0ed2a7c7190c 748 * @param dest the destination IP address to send the packet to
GordonSin 0:0ed2a7c7190c 749 * @param ttl the TTL value to be set in the IP header
GordonSin 0:0ed2a7c7190c 750 * @param proto the PROTOCOL to be set in the IP header
GordonSin 0:0ed2a7c7190c 751 * @param netif the netif on which to send this packet
GordonSin 0:0ed2a7c7190c 752 * @return ERR_OK if the packet was sent OK
GordonSin 0:0ed2a7c7190c 753 * ERR_BUF if p doesn't have enough space for IP/LINK headers
GordonSin 0:0ed2a7c7190c 754 * returns errors returned by netif->output
GordonSin 0:0ed2a7c7190c 755 */
GordonSin 0:0ed2a7c7190c 756 static err_t
GordonSin 0:0ed2a7c7190c 757 igmp_ip_output_if(struct pbuf *p, ip_addr_t *src, ip_addr_t *dest, struct netif *netif)
GordonSin 0:0ed2a7c7190c 758 {
GordonSin 0:0ed2a7c7190c 759 /* This is the "router alert" option */
GordonSin 0:0ed2a7c7190c 760 u16_t ra[2];
GordonSin 0:0ed2a7c7190c 761 ra[0] = PP_HTONS(ROUTER_ALERT);
GordonSin 0:0ed2a7c7190c 762 ra[1] = 0x0000; /* Router shall examine packet */
GordonSin 0:0ed2a7c7190c 763 IGMP_STATS_INC(igmp.xmit);
GordonSin 0:0ed2a7c7190c 764 return ip_output_if_opt(p, src, dest, IGMP_TTL, 0, IP_PROTO_IGMP, netif, ra, ROUTER_ALERTLEN);
GordonSin 0:0ed2a7c7190c 765 }
GordonSin 0:0ed2a7c7190c 766
GordonSin 0:0ed2a7c7190c 767 /**
GordonSin 0:0ed2a7c7190c 768 * Send an igmp packet to a specific group.
GordonSin 0:0ed2a7c7190c 769 *
GordonSin 0:0ed2a7c7190c 770 * @param group the group to which to send the packet
GordonSin 0:0ed2a7c7190c 771 * @param type the type of igmp packet to send
GordonSin 0:0ed2a7c7190c 772 */
GordonSin 0:0ed2a7c7190c 773 static void
GordonSin 0:0ed2a7c7190c 774 igmp_send(struct igmp_group *group, u8_t type)
GordonSin 0:0ed2a7c7190c 775 {
GordonSin 0:0ed2a7c7190c 776 struct pbuf* p = NULL;
GordonSin 0:0ed2a7c7190c 777 struct igmp_msg* igmp = NULL;
GordonSin 0:0ed2a7c7190c 778 ip_addr_t src = *IP_ADDR_ANY;
GordonSin 0:0ed2a7c7190c 779 ip_addr_t* dest = NULL;
GordonSin 0:0ed2a7c7190c 780
GordonSin 0:0ed2a7c7190c 781 /* IP header + "router alert" option + IGMP header */
GordonSin 0:0ed2a7c7190c 782 p = pbuf_alloc(PBUF_TRANSPORT, IGMP_MINLEN, PBUF_RAM);
GordonSin 0:0ed2a7c7190c 783
GordonSin 0:0ed2a7c7190c 784 if (p) {
GordonSin 0:0ed2a7c7190c 785 igmp = (struct igmp_msg *)p->payload;
GordonSin 0:0ed2a7c7190c 786 LWIP_ASSERT("igmp_send: check that first pbuf can hold struct igmp_msg",
GordonSin 0:0ed2a7c7190c 787 (p->len >= sizeof(struct igmp_msg)));
GordonSin 0:0ed2a7c7190c 788 ip_addr_copy(src, group->netif->ip_addr);
GordonSin 0:0ed2a7c7190c 789
GordonSin 0:0ed2a7c7190c 790 if (type == IGMP_V2_MEMB_REPORT) {
GordonSin 0:0ed2a7c7190c 791 dest = &(group->group_address);
GordonSin 0:0ed2a7c7190c 792 ip_addr_copy(igmp->igmp_group_address, group->group_address);
GordonSin 0:0ed2a7c7190c 793 group->last_reporter_flag = 1; /* Remember we were the last to report */
GordonSin 0:0ed2a7c7190c 794 } else {
GordonSin 0:0ed2a7c7190c 795 if (type == IGMP_LEAVE_GROUP) {
GordonSin 0:0ed2a7c7190c 796 dest = &allrouters;
GordonSin 0:0ed2a7c7190c 797 ip_addr_copy(igmp->igmp_group_address, group->group_address);
GordonSin 0:0ed2a7c7190c 798 }
GordonSin 0:0ed2a7c7190c 799 }
GordonSin 0:0ed2a7c7190c 800
GordonSin 0:0ed2a7c7190c 801 if ((type == IGMP_V2_MEMB_REPORT) || (type == IGMP_LEAVE_GROUP)) {
GordonSin 0:0ed2a7c7190c 802 igmp->igmp_msgtype = type;
GordonSin 0:0ed2a7c7190c 803 igmp->igmp_maxresp = 0;
GordonSin 0:0ed2a7c7190c 804 igmp->igmp_checksum = 0;
GordonSin 0:0ed2a7c7190c 805 igmp->igmp_checksum = inet_chksum(igmp, IGMP_MINLEN);
GordonSin 0:0ed2a7c7190c 806
GordonSin 0:0ed2a7c7190c 807 igmp_ip_output_if(p, &src, dest, group->netif);
GordonSin 0:0ed2a7c7190c 808 }
GordonSin 0:0ed2a7c7190c 809
GordonSin 0:0ed2a7c7190c 810 pbuf_free(p);
GordonSin 0:0ed2a7c7190c 811 } else {
GordonSin 0:0ed2a7c7190c 812 LWIP_DEBUGF(IGMP_DEBUG, ("igmp_send: not enough memory for igmp_send\n"));
GordonSin 0:0ed2a7c7190c 813 IGMP_STATS_INC(igmp.memerr);
GordonSin 0:0ed2a7c7190c 814 }
GordonSin 0:0ed2a7c7190c 815 }
GordonSin 0:0ed2a7c7190c 816
GordonSin 0:0ed2a7c7190c 817 #endif /* LWIP_IGMP */