FD.io VPP  v21.01.1
Vector Packet Processing
igmp_packet.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 /*
16  * igmp_packet.h: igmp packet format
17  *
18  * Copyright (c) 2011 Eliot Dresselhaus
19  *
20  * Permission is hereby granted, free of charge, to any person obtaining
21  * a copy of this software and associated documentation files (the
22  * "Software"), to deal in the Software without restriction, including
23  * without limitation the rights to use, copy, modify, merge, publish,
24  * distribute, sublicense, and/or sell copies of the Software, and to
25  * permit persons to whom the Software is furnished to do so, subject to
26  * the following conditions:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
31  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38  */
39 
40 #ifndef included_vnet_igmp_packet_h
41 #define included_vnet_igmp_packet_h
42 
43 #include <vnet/ip/ip4_packet.h>
44 #include <vnet/ip/ip6_packet.h>
45 
46 #define foreach_igmp_type \
47  _ (0x11, membership_query) \
48  _ (0x12, membership_report_v1) \
49  _ (0x13, dvmrp) \
50  _ (0x14, pim_v1) \
51  _ (0x15, cisco_trace) \
52  _ (0x16, membership_report_v2) \
53  _ (0x17, leave_group_v2) \
54  _ (0x1e, traceroute_response) \
55  _ (0x1f, traceroute_request) \
56  _ (0x22, membership_report_v3) \
57  _ (0x30, router_advertisement) \
58  _ (0x31, router_solicitation) \
59  _ (0x32, router_termination)
60 
61 typedef enum
62 {
63 #define _(n,f) IGMP_TYPE_##f = n,
65 #undef _
66 } __attribute__ ((packed)) igmp_type_t;
67 
68 typedef struct
69 {
70  igmp_type_t type;
71 
73 
76 
77 /**
78  * Calculate the maximum response time allowed from the header.
79  * - RFC 3367 Section 4.1.1
80  */
83 {
84  f64 qqi;
85 
86  if (header->code < 128)
87  qqi = header->code;
88  else
89  {
90  u8 mant = header->code << 4;
91  u8 exp = (header->code & 0x7) << 1;
92 
93  qqi = ((mant | 0x10) << (exp + 3));
94  }
95 
96  /* Querier's Query Interval (QQI), is represented in units of seconds */
97  return (qqi / 10);
98 }
99 
100 typedef struct
101 {
102  /* type 0x11 (IGMPv3) */
104 
106 
107  /* Reserved, Suppress Router-Side Processing flag and
108  Querier's Robustness Variable RRRRSQQQ. */
110 
111  /* Querier's Query Interval Code */
113 
115  ip4_address_t src_addresses[0];
117 
120 {
121  return (sizeof (*q) +
122  (sizeof (ip4_address_t) *
123  clib_net_to_host_u16 (q->n_src_addresses)));
124 }
125 
126 always_inline int
128 {
129  return (0 == q->group_address.as_u32);
130 }
131 
132 #define foreach_igmp_membership_group_v3_type \
133  _ (1, mode_is_include) \
134  _ (2, mode_is_exclude) \
135  _ (3, change_to_include) \
136  _ (4, change_to_exclude) \
137  _ (5, allow_new_sources) \
138  _ (6, block_old_sources)
139 
140 typedef enum
141 {
142 #define _(n,f) IGMP_MEMBERSHIP_GROUP_##f = n,
144 #undef _
145 } __attribute__ ((packed)) igmp_membership_group_v3_type_t;
146 
147 typedef struct
148 {
149  igmp_membership_group_v3_type_t type;
150 
151  /* Number of 32 bit words of aux data after source addresses. */
153 
154  /* Number of source addresses that follow. */
156 
157  /* Destination multicast group address. */
159 
160  ip4_address_t src_addresses[0];
162 
165 {
166  return (sizeof (*g) +
167  (sizeof (ip4_address_t) *
168  clib_net_to_host_u16 (g->n_src_addresses)));
169 }
170 
173 {
174  return ((void *) g
175  + g->n_src_addresses * sizeof (g->src_addresses[0])
176  + g->n_aux_u32s * sizeof (u32));
177 }
178 
179 typedef struct
180 {
181  /* Type 0x22. */
183 
185 
186  /* Number of groups which follow. */
188 
191 
194 {
196  u32 len, ii, glen;
197 
198  len = sizeof (igmp_membership_report_v3_t);
199  g = r->groups;
200 
201  for (ii = 0; ii < clib_net_to_host_u16 (r->n_groups); ii++)
202  {
204  g = (const igmp_membership_group_v3_t *) (((u8 *) g) + glen);
205  len += glen;
206  }
207  return (len);
208 }
209 
210 /* IP6 flavor of IGMP is called MLD which is embedded in ICMP6. */
211 typedef struct
212 {
213  /* Preceeded by ICMP v6 header. */
216  ip6_address_t dst;
217 } mld_header_t;
218 
219 #endif /* included_vnet_igmp_packet_h */
220 
221 /*
222  * fd.io coding-style-patch-verification: ON
223  *
224  * Local Variables:
225  * eval: (c-set-style "gnu")
226  * End:
227  */
igmp_membership_group_v3_type_t type
Definition: igmp_packet.h:149
igmp_membership_group_v3_t groups[0]
Definition: igmp_packet.h:189
static igmp_membership_group_v3_t * igmp_membership_group_v3_next(igmp_membership_group_v3_t *g)
Definition: igmp_packet.h:172
igmp_membership_group_v3_type_t
Definition: igmp_packet.h:140
static u32 igmp_membership_query_v3_length(const igmp_membership_query_v3_t *q)
Definition: igmp_packet.h:119
#define foreach_igmp_membership_group_v3_type
Definition: igmp_packet.h:132
unsigned char u8
Definition: types.h:56
double f64
Definition: types.h:142
unsigned int u32
Definition: types.h:88
ip6_address_t dst
Definition: igmp_packet.h:216
unsigned short u16
Definition: types.h:57
#define always_inline
Definition: ipsec.h:28
igmp_type_t type
Definition: igmp_packet.h:70
u8 len
Definition: ip_types.api:103
static f64 igmp_header_get_max_resp_time(const igmp_header_t *header)
Calculate the maximum response time allowed from the header.
Definition: igmp_packet.h:82
u8 exp
Definition: fib_types.api:27
#define foreach_igmp_type
Definition: igmp_packet.h:46
ip4_address_t group_address
Definition: igmp_packet.h:158
static u32 igmp_membership_group_v3_length(const igmp_membership_group_v3_t *g)
Definition: igmp_packet.h:164
static int igmp_membership_query_v3_is_general(const igmp_membership_query_v3_t *q)
Definition: igmp_packet.h:127
u16 max_response_delay_in_milliseconds
Definition: igmp_packet.h:214
ip4_address_t src_addresses[0]
Definition: igmp_packet.h:160
static u32 igmp_membership_report_v3_length(const igmp_membership_report_v3_t *r)
Definition: igmp_packet.h:193
igmp_type_t
Definition: igmp_packet.h:61
ip4_address_t group_address
Definition: igmp_packet.h:105