FD.io VPP  v18.11-rc0-18-g2a3fb1a
Vector Packet Processing
igmp.h
Go to the documentation of this file.
1 /*
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:
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
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  *------------------------------------------------------------------
16  */
17 
18 #ifndef _IGMP_H_
19 #define _IGMP_H_
20 
21 #include <vlib/vlib.h>
22 #include <vnet/ip/ip.h>
24 #include <vnet/ip/igmp_packet.h>
25 #include <vnet/adj/adj_mcast.h>
26 #include <igmp/igmp_types.h>
27 #include <igmp/igmp_format.h>
28 #include <igmp/igmp_timer.h>
29 #include <igmp/igmp_group.h>
30 #include <igmp/igmp_config.h>
31 
32 /**
33  * RFC 3376 Section 8.1
34  */
35 #define IGMP_DEFAULT_ROBUSTNESS_VARIABLE (2)
36 
37 #define IGMP_DBG(...) \
38  vlib_log_debug (igmp_main.logger, __VA_ARGS__);
39 
40 /**
41  * General Query address - 224.0.0.1
42  * Membership Report address - 224.0.0.22
43  * SSM default range 232/8
44  */
45 #if CLIB_ARCH_IS_BIG_ENDIAN
46 #define IGMP_GENERAL_QUERY_ADDRESS (0xE0000001)
47 #define IGMP_MEMBERSHIP_REPORT_ADDRESS (0xE0000016)
48 #define IGMP_SSM_DEFAULT (0xE8000000)
49 #else
50 #define IGMP_GENERAL_QUERY_ADDRESS (0x010000E0)
51 #define IGMP_MEMBERSHIP_REPORT_ADDRESS (0x160000E0)
52 #define IGMP_SSM_DEFAULT (0x000000E8)
53 #endif
54 
55 /** helper macro to get igmp mebership group from pointer plus offset */
56 #define group_ptr(p, l) ((igmp_membership_group_v3_t *)((u8*)(p) + (l)))
57 #define group_cptr(p, l) ((const igmp_membership_group_v3_t *)((u8*)(p) + (l)))
58 
59 /**
60  * collection of data related to IGMP
61  */
62 typedef struct igmp_main_t_
63 {
64  /**
65  * API base message ID
66  */
68 
70 
71  /**
72  * API client registered for events
73  */
75 
76  /**
77  * per-interface DB of configs
78  */
80 
81  /**
82  * the number of igmp configs for each mfib_index (VRF)
83  */
85 
86  /**
87  * logger - VLIB log class
88  */
90 
91  /**
92  * pool of configs
93  */
95 
96  /**
97  * pool of groups
98  */
100  /**
101  * pool of sources
102  */
104 } igmp_main_t;
105 
106 extern igmp_main_t igmp_main;
107 
108 /**
109  * @brief IGMP interface enable/disable
110  * @param sw_if_index - Interface
111  * @param enable - enable/disable
112  * @param mode - Host or router
113  */
114 int igmp_enable_disable (u32 sw_if_index, u8 enable, igmp_mode_t mode);
115 
116 /**
117  * @brief igmp listen
118  * Called by a host to request reception of multicast packets
119  * @param vm - vlib main
120  * @param filter - Filter mode
121  * @param sw_if_index - interface sw_if_index
122  * @param saddr - source address
123  * @param gaddr - group address
124  *
125  * Add/del (S,G) on an interface.
126  * send a status change report from the interface.
127  */
128 int igmp_listen (vlib_main_t * vm,
129  igmp_filter_mode_t filter,
130  u32 sw_if_index,
131  const ip46_address_t * saddr, const ip46_address_t * gaddr);
132 
133 /**
134  * @brief Send an IGMP event to listening parties
135  * @param filter mode
136  * @param sw_if_index
137  * @param saddr
138  * @param gaddr
139  */
140 void igmp_event (igmp_filter_mode_t filter,
141  u32 sw_if_index,
142  const ip46_address_t * saddr, const ip46_address_t * gaddr);
143 
144 #endif /* _IGMP_H_ */
145 
146 /*
147  * fd.io coding-style-patch-verification: ON
148  *
149  * Local Variables:
150  * eval: (c-set-style "gnu")
151  * End:
152  */
u32 vlib_log_class_t
Definition: log.h:21
igmp_config_t * configs
pool of configs
Definition: igmp.h:94
unsigned char u8
Definition: types.h:56
u16 msg_id_base
API base message ID.
Definition: igmp.h:67
unsigned int u32
Definition: types.h:88
void igmp_event(igmp_filter_mode_t filter, u32 sw_if_index, const ip46_address_t *saddr, const ip46_address_t *gaddr)
Send an IGMP event to listening parties.
Definition: igmp_api.c:382
igmp_main_t igmp_main
Definition: igmp.c:36
vlib_log_class_t logger
logger - VLIB log class
Definition: igmp.h:89
unsigned short u16
Definition: types.h:57
collection of data related to IGMP
Definition: igmp.h:62
int igmp_listen(vlib_main_t *vm, igmp_filter_mode_t filter, u32 sw_if_index, const ip46_address_t *saddr, const ip46_address_t *gaddr)
igmp listen Called by a host to request reception of multicast packets
Definition: igmp.c:133
vlib_main_t * vm
Definition: buffer.c:294
vpe_client_registration_t * api_clients
API client registered for events.
Definition: igmp.h:74
u32 * igmp_config_by_sw_if_index
per-interface DB of configs
Definition: igmp.h:79
enum igmp_filter_mode_t_ igmp_filter_mode_t
u32 * n_configs_per_mfib_index
the number of igmp configs for each mfib_index (VRF)
Definition: igmp.h:84
int igmp_enable_disable(u32 sw_if_index, u8 enable, igmp_mode_t mode)
IGMP interface enable/disable.
Definition: igmp.c:340
IGMP interface configuration.
Definition: igmp_config.h:43
igmp_group_t * groups
pool of groups
Definition: igmp.h:99
IGMP group A multicast group address for which reception has been requested.
Definition: igmp_group.h:55
u64 uword
Definition: types.h:112
enum igmp_mode_t_ igmp_mode_t
struct igmp_main_t_ igmp_main_t
collection of data related to IGMP
uword * igmp_api_client_by_client_index
Definition: igmp.h:69
igmp_src_t * srcs
pool of sources
Definition: igmp.h:103
IGMP source The representation of a specified source address with in multicast group.
Definition: igmp_src.h:41