FD.io VPP  v21.10.1-2-g0a485f517
Vector Packet Processing
igmp_group.h
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * Copyright (c) 2018 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_GROUP_H__
19 #define __IGMP_GROUP_H__
20 
21 #include <igmp/igmp_types.h>
22 #include <igmp/igmp_src.h>
23 
24 /**
25  * QUERY_REPLY = Timer running to reply to a G/SG specific query
26  * QUERY_SENT = wait for response from a sent G/SG specific query.
27  * Sent when a host leaves a group
28  * RESEND_REPORT = Timer running to resend report
29  * FILTER_MODE_CHANGE = to check if the group can swap to
30  * INCLUDE mode (section 6.2.2)
31  */
32 #define foreach_igmp_group_timer \
33  _(QUERY_REPLY, "query-reply") \
34  _(QUERY_SENT, "query-sent") \
35  _(RESEND_REPORT, "resend-report") \
36  _(FILTER_MODE_CHANGE, "filter-mode-change")
37 
38 /**
39  * Types of timers maintained for each group
40  */
42 {
43 #define _(v,s) IGMP_GROUP_TIMER_##v,
45 #undef _
47 
48 #define IGMP_GROUP_N_TIMERS (IGMP_GROUP_TIMER_FILTER_MODE_CHANGE + 1)
49 
50 extern u8 *format_igmp_group_timer_type (u8 * s, va_list * args);
51 
52 /**
53  * @brief IGMP group
54  * A multicast group address for which reception has been requested.
55  */
56 typedef struct igmp_group_t_
57 {
58  /** The group's key within the per-interface config */
60 
61  /**
62  * A vector of running timers for the group. this can include:
63  * - group-specific query, sent on reception of a host 'leave'
64  * - filter-mode change timer, to check if the group can swap to
65  * INCLUDE mode (section 6.2.2)
66  */
68 
69  /**
70  * The current filter mode of the group (see 6.2.1)
71  */
73 
74  /**
75  * The pool index of the config object this group is in
76  */
78 
79  /**
80  * The number of times the last report has been sent
81  */
83 
84  /**
85  * Source list per-filter mode
86  */
88 } igmp_group_t;
89 
90 #define FOR_EACH_SRC(_src, _group, _filter, _body) \
91 do { \
92  igmp_key_t *__key__; \
93  u32 __sid__; \
94  hash_foreach_mem(__key__, __sid__, ((igmp_group_t*)_group)->igmp_src_by_key[(_filter)], \
95  ({ \
96  _src = pool_elt_at_index(igmp_main.srcs, __sid__); \
97  do { _body; } while (0); \
98  })); \
99  } while (0);
100 
101 /**
102  * Forward declarations
103  */
104 struct igmp_config_t_;
105 
106 extern void igmp_group_clear (igmp_group_t ** group);
107 extern void igmp_group_free_all_srcs (igmp_group_t * group);
108 
109 extern igmp_group_t *igmp_group_alloc (struct igmp_config_t_ *config,
110  const igmp_key_t * gkey,
112 
114  const igmp_key_t * skey,
115  igmp_mode_t mode);
116 
117 extern void igmp_group_src_remove (igmp_group_t * group, igmp_src_t * src);
118 extern u8 *format_igmp_group (u8 * s, va_list * args);
119 
120 
121 extern ip46_address_t *igmp_group_present_minus_new (igmp_group_t * group,
123  const ip46_address_t *
124  saddrs);
125 
126 extern ip46_address_t *igmp_group_new_minus_present (igmp_group_t * group,
128  const ip46_address_t *
129  saddrs);
130 
131 extern ip46_address_t *igmp_group_new_intersect_present (igmp_group_t * group,
133  mode,
134  const ip46_address_t
135  * saddrs);
136 
137 extern u32 igmp_group_n_srcs (const igmp_group_t * group,
139 
140 
141 /** \brief igmp group lookup
142  @param group - igmp group
143  @param key - igmp key
144 */
145 extern igmp_src_t *igmp_src_lookup (igmp_group_t * group,
146  const igmp_key_t * key);
147 
148 extern u32 igmp_group_index (const igmp_group_t * g);
150 
151 #endif
152 
153 /*
154  * fd.io coding-style-patch-verification: ON
155  *
156  * Local Variables:
157  * eval: (c-set-style "gnu")
158  * End:
159  */
igmp_mode_t
enum igmp_mode_t_ igmp_mode_t
igmp_src_t_
IGMP source The representation of a specified source address with in multicast group.
Definition: igmp_src.h:41
igmp_group_alloc
igmp_group_t * igmp_group_alloc(struct igmp_config_t_ *config, const igmp_key_t *gkey, igmp_filter_mode_t mode)
Definition: igmp_group.c:104
igmp_group_index
u32 igmp_group_index(const igmp_group_t *g)
Definition: igmp_group.c:273
igmp_config_t_
IGMP interface configuration.
Definition: igmp_config.h:47
igmp_group_t_
IGMP group A multicast group address for which reception has been requested.
Definition: igmp_group.h:56
mode
vl_api_tunnel_mode_t mode
Definition: gre.api:48
igmp_src.h
igmp_group_n_srcs
u32 igmp_group_n_srcs(const igmp_group_t *group, igmp_filter_mode_t mode)
Definition: igmp_group.c:251
igmp_types.h
igmp_group_src_remove
void igmp_group_src_remove(igmp_group_t *group, igmp_src_t *src)
Definition: igmp_group.c:38
igmp_group_t_::n_reports_sent
u32 n_reports_sent
The number of times the last report has been sent.
Definition: igmp_group.h:82
igmp_group_timer_type_t_
igmp_group_timer_type_t_
Types of timers maintained for each group.
Definition: igmp_group.h:41
igmp_group_t_::config
u32 config
The pool index of the config object this group is in.
Definition: igmp_group.h:77
key
typedef key
Definition: ipsec_types.api:91
igmp_src_lookup
igmp_src_t * igmp_src_lookup(igmp_group_t *group, const igmp_key_t *key)
igmp group lookup
Definition: igmp_group.c:258
igmp_group_new_intersect_present
ip46_address_t * igmp_group_new_intersect_present(igmp_group_t *group, igmp_filter_mode_t mode, const ip46_address_t *saddrs)
Definition: igmp_group.c:223
IGMP_GROUP_N_TIMERS
#define IGMP_GROUP_N_TIMERS
Definition: igmp_group.h:48
igmp_group_t_::timers
u32 timers[IGMP_GROUP_N_TIMERS]
A vector of running timers for the group.
Definition: igmp_group.h:67
foreach_igmp_group_timer
#define foreach_igmp_group_timer
QUERY_REPLY = Timer running to reply to a G/SG specific query QUERY_SENT = wait for response from a s...
Definition: igmp_group.h:32
uword
u64 uword
Definition: types.h:112
igmp_group_clear
void igmp_group_clear(igmp_group_t **group)
Definition: igmp_group.c:68
format_igmp_group_timer_type
u8 * format_igmp_group_timer_type(u8 *s, va_list *args)
Definition: igmp_group.c:285
src
vl_api_address_t src
Definition: gre.api:54
igmp_group_new_minus_present
ip46_address_t * igmp_group_new_minus_present(igmp_group_t *group, igmp_filter_mode_t mode, const ip46_address_t *saddrs)
the set of new sources minus the present set
Definition: igmp_group.c:190
igmp_group_free_all_srcs
void igmp_group_free_all_srcs(igmp_group_t *group)
Definition: igmp_group.c:22
index
u32 index
Definition: flow_types.api:221
igmp_group_present_minus_new
ip46_address_t * igmp_group_present_minus_new(igmp_group_t *group, igmp_filter_mode_t mode, const ip46_address_t *saddrs)
the set of present sources minus the new set
Definition: igmp_group.c:144
format_igmp_group
u8 * format_igmp_group(u8 *s, va_list *args)
Definition: igmp_group.c:299
igmp_group_t_::key
igmp_key_t * key
The group's key within the per-interface config.
Definition: igmp_group.h:59
saddrs
vl_api_ip4_address_t saddrs[n_srcs]
Definition: igmp.api:71
u32
unsigned int u32
Definition: types.h:88
IGMP_N_FILTER_MODES
#define IGMP_N_FILTER_MODES
Definition: igmp_types.h:67
igmp_group_t
struct igmp_group_t_ igmp_group_t
IGMP group A multicast group address for which reception has been requested.
u8
unsigned char u8
Definition: types.h:56
igmp_group_t_::router_filter_mode
igmp_filter_mode_t router_filter_mode
The current filter mode of the group (see 6.2.1)
Definition: igmp_group.h:72
igmp_group_timer_type_t
enum igmp_group_timer_type_t_ igmp_group_timer_type_t
Types of timers maintained for each group.
igmp_filter_mode_t
enum igmp_filter_mode_t_ igmp_filter_mode_t
igmp_group_get
igmp_group_t * igmp_group_get(u32 index)
Definition: igmp_group.c:279
igmp_group_src_update
igmp_src_t * igmp_group_src_update(igmp_group_t *group, const igmp_key_t *skey, igmp_mode_t mode)
Definition: igmp_group.c:45
igmp_group_t_::igmp_src_by_key
uword * igmp_src_by_key[IGMP_N_FILTER_MODES]
Source list per-filter mode.
Definition: igmp_group.h:87
igmp_key_t
ip46_address_t igmp_key_t
IGMP Key Used to index groups within an interface config and sources within a list.
Definition: igmp_types.h:49