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 *------------------------------------------------------------------
18 #include <igmp/igmp_pkt.h>
19 #include <vnet/fib/fib_sas.h>
22 vlib_buffer_append (vlib_buffer_t * b, uword l)
25 b->current_length += l;
28 static vlib_buffer_t *
29 igmp_pkt_get_buffer (igmp_pkt_build_t * bk)
35 vm = vlib_get_main ();
37 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
40 b = vlib_get_buffer (vm, bi);
41 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b);
43 b->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
44 b->flags |= VLIB_BUFFER_IS_TRACED;
46 /* clear out stale data */
47 vnet_buffer (b)->sw_if_index[VLIB_RX] = ~0;
50 * save progress in the builder
52 vec_add1 (bk->buffers, bi);
53 bk->n_avail = vnet_sw_interface_get_mtu (vnet_get_main (),
54 bk->sw_if_index, VNET_MTU_IP4);
59 static vlib_buffer_t *
60 igmp_pkt_build_ip_header (igmp_pkt_build_t * bk,
61 igmp_msg_type_t msg_type,
62 const igmp_group_t * group)
68 b = igmp_pkt_get_buffer (bk);
73 ip4 = vlib_buffer_get_current (b);
74 clib_memset (ip4, 0, sizeof (ip4_header_t));
75 ip4->ip_version_and_header_length = 0x46;
77 ip4->protocol = IP_PROTOCOL_IGMP;
80 fib_sas4_get (bk->sw_if_index, NULL, &ip4->src_address);
82 vlib_buffer_append (b, sizeof (*ip4));
83 bk->n_avail -= sizeof (*ip4);
88 ip4->dst_address.as_u32 = IGMP_MEMBERSHIP_REPORT_ADDRESS;
92 clib_memcpy_fast (&ip4->dst_address, &group->key->ip4,
93 sizeof (ip4_address_t));
95 ip4->dst_address.as_u32 = IGMP_GENERAL_QUERY_ADDRESS;
99 /* add the router alert options */
100 option = vlib_buffer_get_current (b);
101 option[0] = 0x80 | 20; // IP4_ROUTER_ALERT_OPTION;
102 option[1] = 4; // length
103 option[2] = option[3] = 0;
105 vlib_buffer_append (b, 4);
111 static vlib_buffer_t *
112 igmp_pkt_build_report_v3 (igmp_pkt_build_report_t * br,
113 const igmp_group_t * group)
115 igmp_membership_report_v3_t *report;
118 b = igmp_pkt_build_ip_header (&br->base, IGMP_MSG_REPORT, group);
123 report = vlib_buffer_get_current (b);
124 report->header.type = IGMP_TYPE_membership_report_v3;
125 report->header.code = 0;
126 report->header.checksum = 0;
129 vlib_buffer_append (b, sizeof (igmp_membership_report_v3_t));
130 br->base.n_avail -= sizeof (igmp_membership_report_v3_t);
131 br->base.n_bytes += sizeof (igmp_membership_report_v3_t);
137 igmp_pkt_tx (igmp_pkt_build_t * bk)
139 const igmp_config_t *config;
146 vm = vlib_get_main ();
147 config = igmp_config_lookup (bk->sw_if_index);
152 f = vlib_get_frame_to_node (vm, ip4_rewrite_mcast_node.index);
153 to_next = vlib_frame_vector_args (f);
155 vec_foreach_index (ii, bk->buffers)
157 b = vlib_get_buffer (vm, bk->buffers[ii]);
158 vnet_buffer (b)->ip.adj_index[VLIB_TX] = config->adj_index;
159 to_next[ii] = bk->buffers[ii];
163 vlib_put_frame_to_node (vm, ip4_rewrite_mcast_node.index, f);
165 IGMP_DBG (" ..tx: %U", format_vnet_sw_if_index_name,
166 vnet_get_main (), bk->sw_if_index);
168 vec_free (bk->buffers);
172 static vlib_buffer_t *
173 igmp_pkt_build_report_get_active (igmp_pkt_build_report_t * br)
175 if (NULL == br->base.buffers)
178 return (vlib_get_buffer (vlib_get_main (),
179 br->base.buffers[vec_len (br->base.buffers) - 1]));
183 igmp_pkt_build_report_bake (igmp_pkt_build_report_t * br)
185 igmp_membership_report_v3_t *igmp;
189 b = igmp_pkt_build_report_get_active (br);
193 ip4 = vlib_buffer_get_current (b);
194 igmp = (igmp_membership_report_v3_t *) (((u32 *) ip4) + 6);
196 igmp->n_groups = clib_host_to_net_u16 (br->n_groups);
198 igmp->header.checksum =
199 ~ip_csum_fold (ip_incremental_checksum (0, igmp, br->base.n_bytes));
201 ip4->length = clib_host_to_net_u16 (b->current_length);
202 ip4->checksum = ip4_header_checksum (ip4);
204 br->base.n_bytes = br->base.n_avail = br->n_groups = 0;
208 igmp_pkt_report_v3_send (igmp_pkt_build_report_t * br)
210 if (NULL == br->base.buffers)
213 igmp_pkt_build_report_bake (br);
214 igmp_pkt_tx (&br->base);
218 igmp_pkt_report_v3_get_size (const igmp_group_t * group)
220 ASSERT (IGMP_FILTER_MODE_INCLUDE == group->router_filter_mode);
222 return ((hash_elts (group->igmp_src_by_key[IGMP_FILTER_MODE_INCLUDE]) *
223 sizeof (ip4_address_t)) + sizeof (igmp_membership_group_v3_t));
226 static igmp_membership_group_v3_t *
227 igmp_pkt_report_v3_append_group (igmp_pkt_build_report_t * br,
228 const ip46_address_t * grp,
229 igmp_membership_group_v3_type_t type)
231 igmp_membership_group_v3_t *igmp_group;
234 b = igmp_pkt_build_report_get_active (br);
236 if (br->base.n_avail < sizeof (igmp_membership_group_v3_t))
238 igmp_pkt_build_report_bake (br);
239 b = igmp_pkt_build_report_v3 (br, NULL);
243 br->base.n_avail -= sizeof (igmp_membership_group_v3_t);
244 br->base.n_bytes += sizeof (igmp_membership_group_v3_t);
248 igmp_group = vlib_buffer_get_current (b);
249 vlib_buffer_append (b, sizeof (igmp_membership_group_v3_t));
251 igmp_group->type = type;
252 igmp_group->n_aux_u32s = 0;
253 igmp_group->n_src_addresses = 0;
254 igmp_group->group_address.as_u32 = grp->ip4.as_u32;
261 " If the set of Group Records required in a Report does not fit within
262 * the size limit of a single Report message (as determined by the MTU
263 * of the network on which it will be sent), the Group Records are sent
264 * in as many Report messages as needed to report the entire set.
266 * If a single Group Record contains so many source addresses that it
267 * does not fit within the size limit of a single Report message, if its
268 * Type is not MODE_IS_EXCLUDE or CHANGE_TO_EXCLUDE_MODE, it is split
269 * into multiple Group Records, each containing a different subset of
270 * the source addresses and each sent in a separate Report message. If
271 * its Type is MODE_IS_EXCLUDE or CHANGE_TO_EXCLUDE_MODE, a single Group
272 * Record is sent, containing as many source addresses as can fit, and
273 * the remaining source addresses are not reported; though the choice of
274 * which sources to report is arbitrary, it is preferable to report the
275 * same set of sources in each subsequent report, rather than reporting
276 * different sources each time."
278 static igmp_membership_group_v3_t *
279 igmp_pkt_report_v3_append_src (igmp_pkt_build_report_t * br,
280 igmp_membership_group_v3_t * igmp_group,
281 const ip46_address_t * grp,
282 igmp_membership_group_v3_type_t type,
283 const ip46_address_t * src)
287 b = igmp_pkt_build_report_get_active (br);
289 if (br->base.n_avail < sizeof (ip4_address_t))
291 igmp_group->n_src_addresses = clib_host_to_net_u16 (br->n_srcs);
292 igmp_pkt_build_report_bake (br);
293 b = igmp_pkt_build_report_v3 (br, NULL);
296 igmp_group = igmp_pkt_report_v3_append_group (br, grp, type);
299 igmp_group->src_addresses[br->n_srcs].as_u32 = src->ip4.as_u32;
301 br->base.n_avail -= sizeof (ip4_address_t);
302 br->base.n_bytes += sizeof (ip4_address_t);
303 vlib_buffer_append (b, sizeof (ip4_address_t));
309 igmp_pkt_report_v3_add_report (igmp_pkt_build_report_t * br,
310 const ip46_address_t * grp,
311 const ip46_address_t * srcs,
312 igmp_membership_group_v3_type_t type)
314 igmp_membership_group_v3_t *igmp_group;
315 const ip46_address_t *s;
318 b = igmp_pkt_build_report_get_active (br);
322 b = igmp_pkt_build_report_v3 (br, NULL);
324 /* failed to allocate buffer */
328 igmp_group = igmp_pkt_report_v3_append_group (br, grp, type);
330 if (NULL == igmp_group)
336 igmp_group = igmp_pkt_report_v3_append_src(br, igmp_group,
338 if (NULL == igmp_group)
343 igmp_group->n_src_addresses = clib_host_to_net_u16 (br->n_srcs);
345 IGMP_DBG (" ..add-group: %U", format_ip46_address, grp, IP46_TYPE_IP4);
349 igmp_pkt_report_v3_add_group (igmp_pkt_build_report_t * br,
350 const igmp_group_t * group,
351 igmp_membership_group_v3_type_t type)
353 igmp_membership_group_v3_t *igmp_group;
357 b = igmp_pkt_build_report_get_active (br);
361 b = igmp_pkt_build_report_v3 (br, NULL);
363 /* failed to allocate buffer */
368 * if the group won't fit in a partially full buffer, start again
370 if ((0 != br->n_groups) &&
371 (igmp_pkt_report_v3_get_size (group) > br->base.n_avail))
373 igmp_pkt_build_report_bake (br);
374 b = igmp_pkt_build_report_v3 (br, NULL);
376 /* failed to allocate buffer */
380 igmp_group = igmp_pkt_report_v3_append_group (br, group->key, type);
383 FOR_EACH_SRC (src, group, IGMP_FILTER_MODE_INCLUDE,
385 igmp_group = igmp_pkt_report_v3_append_src(br, igmp_group,
388 if (NULL == igmp_group)
392 igmp_group->n_src_addresses = clib_host_to_net_u16 (br->n_srcs);
394 IGMP_DBG (" ..add-group: %U srcs:%d",
395 format_igmp_key, group->key,
396 hash_elts (group->igmp_src_by_key[IGMP_FILTER_MODE_INCLUDE]));
400 igmp_pkt_build_report_init (igmp_pkt_build_report_t * br, u32 sw_if_index)
402 clib_memset (br, 0, sizeof (*br));
403 br->base.sw_if_index = sw_if_index;
406 static vlib_buffer_t *
407 igmp_pkt_build_query_get_active (igmp_pkt_build_query_t * bq)
409 if (NULL == bq->base.buffers)
412 return (vlib_get_buffer (vlib_get_main (),
413 bq->base.buffers[vec_len (bq->base.buffers) - 1]));
416 static vlib_buffer_t *
417 igmp_pkt_build_query_v3 (igmp_pkt_build_query_t * bq,
418 const igmp_group_t * group)
420 igmp_membership_query_v3_t *query;
423 b = igmp_pkt_build_ip_header (&bq->base, IGMP_MSG_QUERY, group);
428 query = vlib_buffer_get_current (b);
429 query->header.type = IGMP_TYPE_membership_query;
430 query->header.code = 0;
431 query->header.checksum = 0;
433 query->resv_s_qrv = 0;
436 query->group_address.as_u32 = group->key->ip4.as_u32;
438 query->group_address.as_u32 = 0;
440 vlib_buffer_append (b, sizeof (igmp_membership_query_v3_t));
441 bq->base.n_avail -= sizeof (igmp_membership_query_v3_t);
442 bq->base.n_bytes += sizeof (igmp_membership_query_v3_t);
448 igmp_pkt_query_v3_add_group (igmp_pkt_build_query_t * bq,
449 const igmp_group_t * group,
450 const ip46_address_t * srcs)
454 b = igmp_pkt_build_query_get_active (bq);
458 b = igmp_pkt_build_query_v3 (bq, group);
460 /* failed to allocate buffer */
466 igmp_membership_query_v3_t *query;
467 const ip46_address_t *src;
469 query = vlib_buffer_get_current (b);
471 vec_foreach (src, srcs)
473 query->src_addresses[bq->n_srcs++].as_u32 = src->ip4.as_u32;
475 vlib_buffer_append (b, sizeof (ip4_address_t));
476 bq->base.n_bytes += sizeof (ip4_address_t);
477 bq->base.n_avail += sizeof (ip4_address_t);
482 * general query and we're done
487 igmp_pkt_build_query_bake (igmp_pkt_build_query_t * bq)
489 igmp_membership_query_v3_t *igmp;
493 b = igmp_pkt_build_query_get_active (bq);
497 ip4 = vlib_buffer_get_current (b);
498 // account for options
499 igmp = (igmp_membership_query_v3_t *) (((u32 *) ip4) + 6);
501 igmp->n_src_addresses = clib_host_to_net_u16 (bq->n_srcs);
503 igmp->header.checksum =
504 ~ip_csum_fold (ip_incremental_checksum (0, igmp, bq->base.n_bytes));
506 ip4->length = clib_host_to_net_u16 (b->current_length);
507 ip4->checksum = ip4_header_checksum (ip4);
509 bq->base.n_bytes = bq->base.n_avail = bq->n_srcs = 0;
513 igmp_pkt_query_v3_send (igmp_pkt_build_query_t * bq)
515 if (NULL == bq->base.buffers)
518 igmp_pkt_build_query_bake (bq);
519 igmp_pkt_tx (&bq->base);
523 igmp_pkt_build_query_init (igmp_pkt_build_query_t * bq, u32 sw_if_index)
525 clib_memset (bq, 0, sizeof (*bq));
526 bq->base.sw_if_index = sw_if_index;
530 * fd.io coding-style-patch-verification: ON
533 * eval: (c-set-style "gnu")