2 *------------------------------------------------------------------
3 * Copyright (c) 2017 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *------------------------------------------------------------------
21 #include <vlib/vlib.h>
22 #include <vnet/ip/ip.h>
23 #define REPLY_MSG_ID_BASE (igmp_main.msg_id_base)
24 #include <vlibapi/api_helper_macros.h>
25 #include <vnet/ip/igmp_packet.h>
26 #include <vnet/adj/adj_mcast.h>
27 #include <igmp/igmp_types.h>
28 #include <igmp/igmp_format.h>
29 #include <igmp/igmp_timer.h>
30 #include <igmp/igmp_group.h>
31 #include <igmp/igmp_config.h>
32 #include <igmp/igmp_proxy.h>
35 * RFC 3376 Section 8.1
37 #define IGMP_DEFAULT_ROBUSTNESS_VARIABLE (2)
39 #define IGMP_DBG(...) \
40 vlib_log_debug (igmp_main.logger, __VA_ARGS__);
43 * General Query address - 224.0.0.1
44 * Membership Report address - 224.0.0.22
45 * SSM default range 232/8
47 #if CLIB_ARCH_IS_BIG_ENDIAN
48 #define IGMP_GENERAL_QUERY_ADDRESS (0xE0000001)
49 #define IGMP_MEMBERSHIP_REPORT_ADDRESS (0xE0000016)
50 #define IGMP_SSM_DEFAULT (0xE8000000)
52 #define IGMP_GENERAL_QUERY_ADDRESS (0x010000E0)
53 #define IGMP_MEMBERSHIP_REPORT_ADDRESS (0x160000E0)
54 #define IGMP_SSM_DEFAULT (0x000000E8)
57 /** helper macro to get igmp membership group from pointer plus offset */
58 #define group_ptr(p, l) ((igmp_membership_group_v3_t *)((u8*)(p) + (l)))
59 #define group_cptr(p, l) ((const igmp_membership_group_v3_t *)((u8*)(p) + (l)))
62 * collection of data related to IGMP
64 typedef struct igmp_main_t_
71 uword *igmp_api_client_by_client_index;
74 * API client registered for events
76 vpe_client_registration_t *api_clients;
79 * per-interface DB of configs
81 u32 *igmp_config_by_sw_if_index;
84 * the number of igmp configs for each mfib_index (VRF)
86 u32 *n_configs_per_mfib_index;
89 * logger - VLIB log class
91 vlib_log_class_t logger;
96 igmp_config_t *configs;
101 igmp_group_t *groups;
108 * per-vrf DB of proxy devices
110 u32 *igmp_proxy_device_by_vrf_id;
113 * pool of proxy devices
115 igmp_proxy_device_t *proxy_devices;
118 extern igmp_main_t igmp_main;
121 * @brief IGMP interface enable/disable
122 * @param sw_if_index - Interface
123 * @param enable - enable/disable
124 * @param mode - Host or router
126 int igmp_enable_disable (u32 sw_if_index, u8 enable, igmp_mode_t mode);
130 * Called by a host to request reception of multicast packets
131 * @param vm - vlib main
132 * @param filter - Filter mode
133 * @param sw_if_index - interface sw_if_index
134 * @param saddr - source address
135 * @param gaddr - group address
137 * Add/del (S,G) on an interface.
138 * send a status change report from the interface.
140 int igmp_listen (vlib_main_t * vm,
141 igmp_filter_mode_t filter,
143 const ip46_address_t * saddr, const ip46_address_t * gaddr);
146 * @brief Send an IGMP event to listening parties
152 void igmp_event (igmp_filter_mode_t filter,
154 const ip46_address_t * saddr, const ip46_address_t * gaddr);
156 #endif /* _IGMP_H_ */
159 * fd.io coding-style-patch-verification: ON
162 * eval: (c-set-style "gnu")