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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 * igmp_packet.h: igmp packet format
18 * Copyright (c) 2011 Eliot Dresselhaus
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:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
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.
40 #ifndef included_vnet_igmp_packet_h
41 #define included_vnet_igmp_packet_h
43 #include <vnet/ip/ip4_packet.h>
44 #include <vnet/ip/ip6_packet.h>
46 #define foreach_igmp_type \
47 _ (0x11, membership_query) \
48 _ (0x12, membership_report_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)
63 #define _(n,f) IGMP_TYPE_##f = n,
66 } __attribute__ ((packed)) igmp_type_t;
78 * Calculate the maximum response time allowed from the header.
79 * - RFC 3367 Section 4.1.1
82 igmp_header_get_max_resp_time (const igmp_header_t * header)
86 if (header->code < 128)
90 u8 mant = header->code << 4;
91 u8 exp = (header->code & 0x7) << 1;
93 qqi = ((mant | 0x10) << (exp + 3));
96 /* Querier's Query Interval (QQI), is represented in units of seconds */
102 /* type 0x11 (IGMPv3) */
103 igmp_header_t header;
105 ip4_address_t group_address;
107 /* Reserved, Suppress Router-Side Processing flag and
108 Querier's Robustness Variable RRRRSQQQ. */
111 /* Querier's Query Interval Code */
115 ip4_address_t src_addresses[0];
116 } igmp_membership_query_v3_t;
119 igmp_membership_query_v3_length (const igmp_membership_query_v3_t * q)
121 return (sizeof (*q) +
122 (sizeof (ip4_address_t) *
123 clib_net_to_host_u16 (q->n_src_addresses)));
127 igmp_membership_query_v3_is_geeral (const igmp_membership_query_v3_t * q)
129 return (0 == q->group_address.as_u32);
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)
142 #define _(n,f) IGMP_MEMBERSHIP_GROUP_##f = n,
143 foreach_igmp_membership_group_v3_type
145 } __attribute__ ((packed)) igmp_membership_group_v3_type_t;
149 igmp_membership_group_v3_type_t type;
151 /* Number of 32 bit words of aux data after source addresses. */
154 /* Number of source addresses that follow. */
157 /* Destination multicast group address. */
158 ip4_address_t group_address;
160 ip4_address_t src_addresses[0];
161 } igmp_membership_group_v3_t;
164 igmp_membership_group_v3_length (const igmp_membership_group_v3_t * g)
166 return (sizeof (*g) +
167 (sizeof (ip4_address_t) *
168 clib_net_to_host_u16 (g->n_src_addresses)));
171 always_inline igmp_membership_group_v3_t *
172 igmp_membership_group_v3_next (igmp_membership_group_v3_t * g)
175 + g->n_src_addresses * sizeof (g->src_addresses[0])
176 + g->n_aux_u32s * sizeof (u32));
182 igmp_header_t header;
186 /* Number of groups which follow. */
189 igmp_membership_group_v3_t groups[0];
190 } igmp_membership_report_v3_t;
193 igmp_membership_report_v3_length (const igmp_membership_report_v3_t * r)
195 const igmp_membership_group_v3_t *g;
198 len = sizeof (igmp_membership_report_v3_t);
201 for (ii = 0; ii < clib_net_to_host_u16 (r->n_groups); ii++)
203 glen = igmp_membership_group_v3_length (g);
204 g = (const igmp_membership_group_v3_t *) (((u8 *) g) + glen);
210 /* IP6 flavor of IGMP is called MLD which is embedded in ICMP6. */
213 /* Preceeded by ICMP v6 header. */
214 u16 max_response_delay_in_milliseconds;
219 #endif /* included_vnet_igmp_packet_h */
222 * fd.io coding-style-patch-verification: ON
225 * eval: (c-set-style "gnu")