2 * Copyright (c) 2017 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.
18 * @brief IPv6 Full Reassembly.
20 * This file contains the source code for IPv6 full reassembly.
23 #include <vppinfra/vec.h>
24 #include <vnet/vnet.h>
25 #include <vnet/ip/ip.h>
26 #include <vppinfra/bihash_48_8.h>
27 #include <vnet/ip/reass/ip6_full_reass.h>
28 #include <vnet/ip/ip6_inlines.h>
30 #define MSEC_PER_SEC 1000
31 #define IP6_FULL_REASS_TIMEOUT_DEFAULT_MS 200
32 /* As there are only 1024 reass context per thread, either the DDOS attacks
33 * or fractions of real timeouts, would consume these contexts quickly and
34 * running out context space and unable to perform reassembly */
35 #define IP6_FULL_REASS_EXPIRE_WALK_INTERVAL_DEFAULT_MS 50 // 50 ms default
36 #define IP6_FULL_REASS_MAX_REASSEMBLIES_DEFAULT 1024
37 #define IP6_FULL_REASS_MAX_REASSEMBLY_LENGTH_DEFAULT 3
38 #define IP6_FULL_REASS_HT_LOAD_FACTOR (0.75)
43 IP6_FULL_REASS_RC_INTERNAL_ERROR,
44 IP6_FULL_REASS_RC_TOO_MANY_FRAGMENTS,
45 IP6_FULL_REASS_RC_NO_BUF,
46 IP6_FULL_REASS_RC_HANDOFF,
47 IP6_FULL_REASS_RC_INVALID_FRAG_LEN,
48 IP6_FULL_REASS_RC_OVERLAP,
49 } ip6_full_reass_rc_t;
66 } ip6_full_reass_key_t;
73 u32 memory_owner_thread_index;
76 } ip6_full_reass_val_t;
82 ip6_full_reass_key_t k;
83 ip6_full_reass_val_t v;
85 clib_bihash_kv_48_8_t kv;
86 } ip6_full_reass_kv_t;
90 ip6_full_reass_buffer_get_data_offset (vlib_buffer_t * b)
92 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
93 return vnb->ip.reass.range_first - vnb->ip.reass.fragment_first;
97 ip6_full_reass_buffer_get_data_len (vlib_buffer_t * b)
99 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
100 return clib_min (vnb->ip.reass.range_last, vnb->ip.reass.fragment_last) -
101 (vnb->ip.reass.fragment_first +
102 ip6_full_reass_buffer_get_data_offset (b)) + 1;
108 ip6_full_reass_key_t key;
109 // time when last packet was received
111 // internal id of this reassembly
113 // buffer index of first buffer in this reassembly context
115 // last octet of packet, ~0 until fragment without more_fragments arrives
116 u32 last_packet_octet;
117 // length of data collected so far
119 // trace operation counter
120 u32 trace_op_counter;
121 // next index - used by custom apps (~0 if not set)
123 // error next index - used by custom apps (~0 if not set)
124 u32 error_next_index;
125 // minimum fragment length for this reassembly - used to estimate MTU
126 u16 min_fragment_length;
127 // number of fragments for this reassembly
129 // thread owning memory for this context (whose pool contains this ctx)
130 u32 memory_owner_thread_index;
131 // thread which received fragment with offset 0 and which sends out the
132 // completed reassembly
133 u32 sendout_thread_index;
138 ip6_full_reass_t *pool;
141 // for pacing the main thread timeouts
143 clib_spinlock_t lock;
144 } ip6_full_reass_per_thread_t;
151 u32 expire_walk_interval_ms;
152 // maximum number of fragments in one reassembly
154 // maximum number of reassemblies
158 clib_bihash_48_8_t hash;
161 ip6_full_reass_per_thread_t *per_thread_data;
164 vlib_main_t *vlib_main;
166 u32 ip6_icmp_error_idx;
167 u32 ip6_full_reass_expire_node_idx;
169 /** Worker handoff */
172 u32 fq_feature_index;
175 // reference count for enabling/disabling feature - per interface
176 u32 *feature_use_refcount_per_intf;
178 // whether local fragmented packets are reassembled or not
179 int is_local_reass_enabled;
180 } ip6_full_reass_main_t;
182 extern ip6_full_reass_main_t ip6_full_reass_main;
184 #ifndef CLIB_MARCH_VARIANT
185 ip6_full_reass_main_t ip6_full_reass_main;
186 #endif /* CLIB_MARCH_VARIANT */
190 IP6_FULL_REASSEMBLY_NEXT_INPUT,
191 IP6_FULL_REASSEMBLY_NEXT_DROP,
192 IP6_FULL_REASSEMBLY_NEXT_ICMP_ERROR,
193 IP6_FULL_REASSEMBLY_NEXT_HANDOFF,
194 IP6_FULL_REASSEMBLY_N_NEXT,
195 } ip6_full_reass_next_t;
202 } ip6_full_reass_node_type_t;
209 ICMP_ERROR_RT_EXCEEDED,
210 ICMP_ERROR_FL_TOO_BIG,
211 ICMP_ERROR_FL_NOT_MULT_8,
215 } ip6_full_reass_trace_operation_e;
225 } ip6_full_reass_range_trace_t;
229 ip6_full_reass_trace_operation_e action;
231 ip6_full_reass_range_trace_t trace_range;
238 bool is_after_handoff;
239 ip6_header_t ip6_header;
240 ip6_frag_hdr_t ip6_frag_header;
241 } ip6_full_reass_trace_t;
244 ip6_full_reass_trace_details (vlib_main_t * vm, u32 bi,
245 ip6_full_reass_range_trace_t * trace)
247 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
248 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
249 trace->range_first = vnb->ip.reass.range_first;
250 trace->range_last = vnb->ip.reass.range_last;
251 trace->data_offset = ip6_full_reass_buffer_get_data_offset (b);
252 trace->data_len = ip6_full_reass_buffer_get_data_len (b);
253 trace->range_bi = bi;
257 format_ip6_full_reass_range_trace (u8 * s, va_list * args)
259 ip6_full_reass_range_trace_t *trace =
260 va_arg (*args, ip6_full_reass_range_trace_t *);
262 format (s, "range: [%u, %u], off %d, len %u, bi %u", trace->range_first,
263 trace->range_last, trace->data_offset, trace->data_len,
269 format_ip6_full_reass_trace (u8 * s, va_list * args)
271 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
272 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
273 ip6_full_reass_trace_t *t = va_arg (*args, ip6_full_reass_trace_t *);
275 if (~0 != t->reass_id)
277 if (t->is_after_handoff)
280 format (s, "%U\n", format_ip6_header, &t->ip6_header,
281 sizeof (t->ip6_header));
283 format (s, " %U\n", format_ip6_frag_hdr, &t->ip6_frag_header,
284 sizeof (t->ip6_frag_header));
288 format (s, "%Ureass id: %u, op id: %u, ", format_white_space, indent,
289 t->reass_id, t->op_id);
290 indent = format_get_indent (s);
291 s = format (s, "first bi: %u, data len: %u, ip/fragment[%u, %u]",
292 t->trace_range.first_bi, t->total_data_len,
293 t->fragment_first, t->fragment_last);
298 s = format (s, "\n%Unew %U", format_white_space, indent,
299 format_ip6_full_reass_range_trace, &t->trace_range);
302 s = format (s, "\n%Udiscard %U", format_white_space, indent,
303 format_ip6_full_reass_range_trace, &t->trace_range);
306 s = format (s, "\n%Uoverlap %U", format_white_space, indent,
307 format_ip6_full_reass_range_trace, &t->trace_range);
309 case ICMP_ERROR_FL_TOO_BIG:
310 s = format (s, "\n%Uicmp-error - frag_len > 65535 %U",
311 format_white_space, indent,
312 format_ip6_full_reass_range_trace, &t->trace_range);
314 case ICMP_ERROR_FL_NOT_MULT_8:
315 s = format (s, "\n%Uicmp-error - frag_len mod 8 != 0 %U",
316 format_white_space, indent,
317 format_ip6_full_reass_range_trace, &t->trace_range);
319 case ICMP_ERROR_RT_EXCEEDED:
320 s = format (s, "\n%Uicmp-error - reassembly time exceeded",
321 format_white_space, indent);
324 s = format (s, "\n%Ufinalize reassembly", format_white_space, indent);
328 format (s, "handoff from thread #%u to thread #%u", t->thread_id,
332 s = format (s, "passthrough - not a fragment");
339 ip6_full_reass_add_trace (vlib_main_t * vm, vlib_node_runtime_t * node,
340 ip6_full_reass_t * reass, u32 bi,
341 ip6_frag_hdr_t * ip6_frag_header,
342 ip6_full_reass_trace_operation_e action,
345 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
346 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
347 bool is_after_handoff = false;
348 if (pool_is_free_index
349 (vm->trace_main.trace_buffer_pool, vlib_buffer_get_trace_index (b)))
351 // this buffer's trace is gone
352 b->flags &= ~VLIB_BUFFER_IS_TRACED;
355 if (vlib_buffer_get_trace_thread (b) != vm->thread_index)
357 is_after_handoff = true;
359 ip6_full_reass_trace_t *t = vlib_add_trace (vm, node, b, sizeof (t[0]));
360 t->is_after_handoff = is_after_handoff;
361 if (t->is_after_handoff)
363 clib_memcpy (&t->ip6_header, vlib_buffer_get_current (b),
364 clib_min (sizeof (t->ip6_header), b->current_length));
367 clib_memcpy (&t->ip6_frag_header, ip6_frag_header,
368 sizeof (t->ip6_frag_header));
372 clib_memset (&t->ip6_frag_header, 0, sizeof (t->ip6_frag_header));
377 t->reass_id = reass->id;
378 t->op_id = reass->trace_op_counter;
379 t->trace_range.first_bi = reass->first_bi;
380 t->total_data_len = reass->data_len;
381 ++reass->trace_op_counter;
388 t->thread_id = vm->thread_index;
389 t->thread_id_to = thread_id_to;
390 ip6_full_reass_trace_details (vm, bi, &t->trace_range);
391 t->fragment_first = vnb->ip.reass.fragment_first;
392 t->fragment_last = vnb->ip.reass.fragment_last;
395 s = format (s, "%U", format_ip6_full_reass_trace, NULL, NULL, t);
396 printf ("%.*s\n", vec_len (s), s);
398 vec_reset_length (s);
403 ip6_full_reass_free_ctx (ip6_full_reass_per_thread_t * rt,
404 ip6_full_reass_t * reass)
406 pool_put (rt->pool, reass);
411 ip6_full_reass_free (ip6_full_reass_main_t * rm,
412 ip6_full_reass_per_thread_t * rt,
413 ip6_full_reass_t * reass)
415 clib_bihash_kv_48_8_t kv;
416 kv.key[0] = reass->key.as_u64[0];
417 kv.key[1] = reass->key.as_u64[1];
418 kv.key[2] = reass->key.as_u64[2];
419 kv.key[3] = reass->key.as_u64[3];
420 kv.key[4] = reass->key.as_u64[4];
421 kv.key[5] = reass->key.as_u64[5];
422 clib_bihash_add_del_48_8 (&rm->hash, &kv, 0);
423 ip6_full_reass_free_ctx (rt, reass);
426 /* n_left_to_next, and to_next are taken as input params, as this function
427 * could be called from a graphnode, where its managing local copy of these
428 * variables, and ignoring those and still trying to enqueue the buffers
429 * with local variables would cause either buffer leak or corruption */
431 ip6_full_reass_drop_all (vlib_main_t *vm, vlib_node_runtime_t *node,
432 ip6_full_reass_t *reass, u32 *n_left_to_next,
435 u32 range_bi = reass->first_bi;
436 vlib_buffer_t *range_b;
437 vnet_buffer_opaque_t *range_vnb;
440 while (~0 != range_bi)
442 range_b = vlib_get_buffer (vm, range_bi);
443 range_vnb = vnet_buffer (range_b);
447 vec_add1 (to_free, range_bi);
449 range_bi = range_vnb->ip.reass.next_range_bi;
452 /* send to next_error_index */
453 if (~0 != reass->error_next_index &&
454 reass->error_next_index < node->n_next_nodes)
458 next_index = reass->error_next_index;
461 /* record number of packets sent to custom app */
462 vlib_node_increment_counter (vm, node->node_index,
463 IP6_ERROR_REASS_TO_CUSTOM_APP,
466 while (vec_len (to_free) > 0)
468 vlib_get_next_frame (vm, node, next_index, *to_next,
471 while (vec_len (to_free) > 0 && (*n_left_to_next) > 0)
473 bi = vec_pop (to_free);
477 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
478 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
480 ip6_full_reass_add_trace (vm, node, reass, bi, NULL,
485 (*n_left_to_next) -= 1;
488 vlib_put_next_frame (vm, node, next_index, (*n_left_to_next));
493 vlib_buffer_free (vm, to_free, vec_len (to_free));
499 sanitize_reass_buffers_add_missing (vlib_main_t *vm, ip6_full_reass_t *reass,
502 u32 range_bi = reass->first_bi;
503 vlib_buffer_t *range_b;
504 vnet_buffer_opaque_t *range_vnb;
506 while (~0 != range_bi)
508 range_b = vlib_get_buffer (vm, range_bi);
509 range_vnb = vnet_buffer (range_b);
515 if (range_b->flags & VLIB_BUFFER_NEXT_PRESENT)
518 vlib_buffer_t *_b = vlib_get_buffer (vm, _bi);
519 while (_b->flags & VLIB_BUFFER_NEXT_PRESENT)
521 if (_b->next_buffer != range_vnb->ip.reass.next_range_bi)
523 _bi = _b->next_buffer;
524 _b = vlib_get_buffer (vm, _bi);
528 _b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
533 range_bi = range_vnb->ip.reass.next_range_bi;
538 vlib_buffer_t *fb = vlib_get_buffer (vm, *bi0);
539 vnet_buffer_opaque_t *fvnb = vnet_buffer (fb);
540 if (~0 != reass->first_bi)
542 fvnb->ip.reass.next_range_bi = reass->first_bi;
543 reass->first_bi = *bi0;
547 reass->first_bi = *bi0;
548 fvnb->ip.reass.next_range_bi = ~0;
555 ip6_full_reass_on_timeout (vlib_main_t *vm, vlib_node_runtime_t *node,
556 ip6_full_reass_t *reass, u32 *icmp_bi,
557 u32 *n_left_to_next, u32 **to_next)
559 if (~0 == reass->first_bi)
563 if (~0 == reass->next_index) // custom apps don't want icmp
565 vlib_buffer_t *b = vlib_get_buffer (vm, reass->first_bi);
566 if (0 == vnet_buffer (b)->ip.reass.fragment_first)
568 *icmp_bi = reass->first_bi;
569 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
571 ip6_full_reass_add_trace (vm, node, reass, reass->first_bi, NULL,
572 ICMP_ERROR_RT_EXCEEDED, ~0);
574 // fragment with offset zero received - send icmp message back
575 if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
577 // separate first buffer from chain and steer it towards icmp node
578 b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
579 reass->first_bi = b->next_buffer;
583 reass->first_bi = vnet_buffer (b)->ip.reass.next_range_bi;
585 icmp6_error_set_vnet_buffer (b, ICMP6_time_exceeded,
586 ICMP6_time_exceeded_fragment_reassembly_time_exceeded,
590 ip6_full_reass_drop_all (vm, node, reass, n_left_to_next, to_next);
593 always_inline ip6_full_reass_t *
594 ip6_full_reass_find_or_create (vlib_main_t *vm, vlib_node_runtime_t *node,
595 ip6_full_reass_main_t *rm,
596 ip6_full_reass_per_thread_t *rt,
597 ip6_full_reass_kv_t *kv, u32 *icmp_bi,
598 u8 *do_handoff, int skip_bihash,
599 u32 *n_left_to_next, u32 **to_next)
601 ip6_full_reass_t *reass;
607 now = vlib_time_now (vm);
609 if (!skip_bihash && !clib_bihash_search_48_8 (&rm->hash, &kv->kv, &kv->kv))
611 if (vm->thread_index != kv->v.memory_owner_thread_index)
618 pool_elt_at_index (rm->per_thread_data
619 [kv->v.memory_owner_thread_index].pool,
622 if (now > reass->last_heard + rm->timeout)
624 vlib_node_increment_counter (vm, node->node_index,
625 IP6_ERROR_REASS_TIMEOUT, 1);
626 ip6_full_reass_on_timeout (vm, node, reass, icmp_bi, n_left_to_next,
628 ip6_full_reass_free (rm, rt, reass);
635 reass->last_heard = now;
639 if (rt->reass_n >= rm->max_reass_n)
646 pool_get (rt->pool, reass);
647 clib_memset (reass, 0, sizeof (*reass));
648 reass->id = ((u64) vm->thread_index * 1000000000) + rt->id_counter;
650 reass->first_bi = ~0;
651 reass->last_packet_octet = ~0;
653 reass->next_index = ~0;
654 reass->error_next_index = ~0;
655 reass->memory_owner_thread_index = vm->thread_index;
659 kv->v.reass_index = (reass - rt->pool);
660 kv->v.memory_owner_thread_index = vm->thread_index;
661 reass->last_heard = now;
665 reass->key.as_u64[0] = kv->kv.key[0];
666 reass->key.as_u64[1] = kv->kv.key[1];
667 reass->key.as_u64[2] = kv->kv.key[2];
668 reass->key.as_u64[3] = kv->kv.key[3];
669 reass->key.as_u64[4] = kv->kv.key[4];
670 reass->key.as_u64[5] = kv->kv.key[5];
672 int rv = clib_bihash_add_del_48_8 (&rm->hash, &kv->kv, 2);
675 ip6_full_reass_free (rm, rt, reass);
677 // if other worker created a context already work with the other copy
684 reass->key.as_u64[0] = ~0;
685 reass->key.as_u64[1] = ~0;
686 reass->key.as_u64[2] = ~0;
687 reass->key.as_u64[3] = ~0;
688 reass->key.as_u64[4] = ~0;
689 reass->key.as_u64[5] = ~0;
695 always_inline ip6_full_reass_rc_t
696 ip6_full_reass_finalize (vlib_main_t * vm, vlib_node_runtime_t * node,
697 ip6_full_reass_main_t * rm,
698 ip6_full_reass_per_thread_t * rt,
699 ip6_full_reass_t * reass, u32 * bi0, u32 * next0,
700 u32 * error0, bool is_custom_app)
702 *bi0 = reass->first_bi;
703 *error0 = IP6_ERROR_NONE;
704 ip6_frag_hdr_t *frag_hdr;
705 vlib_buffer_t *last_b = NULL;
706 u32 sub_chain_bi = reass->first_bi;
707 u32 total_length = 0;
708 u32 *vec_drop_compress = NULL;
709 ip6_full_reass_rc_t rv = IP6_FULL_REASS_RC_OK;
712 u32 tmp_bi = sub_chain_bi;
713 vlib_buffer_t *tmp = vlib_get_buffer (vm, tmp_bi);
714 vnet_buffer_opaque_t *vnb = vnet_buffer (tmp);
715 if (!(vnb->ip.reass.range_first >= vnb->ip.reass.fragment_first) &&
716 !(vnb->ip.reass.range_last > vnb->ip.reass.fragment_first))
718 rv = IP6_FULL_REASS_RC_INTERNAL_ERROR;
719 goto free_buffers_and_return;
722 u32 data_len = ip6_full_reass_buffer_get_data_len (tmp);
723 u32 trim_front = vnet_buffer (tmp)->ip.reass.ip6_frag_hdr_offset +
724 sizeof (*frag_hdr) + ip6_full_reass_buffer_get_data_offset (tmp);
726 vlib_buffer_length_in_chain (vm, tmp) - trim_front - data_len;
727 if (tmp_bi == reass->first_bi)
729 /* first buffer - keep ip6 header */
730 if (0 != ip6_full_reass_buffer_get_data_offset (tmp))
732 rv = IP6_FULL_REASS_RC_INTERNAL_ERROR;
733 goto free_buffers_and_return;
736 trim_end = vlib_buffer_length_in_chain (vm, tmp) - data_len -
737 (vnet_buffer (tmp)->ip.reass.ip6_frag_hdr_offset +
739 if (!(vlib_buffer_length_in_chain (vm, tmp) - trim_end > 0))
741 rv = IP6_FULL_REASS_RC_INTERNAL_ERROR;
742 goto free_buffers_and_return;
746 vlib_buffer_length_in_chain (vm, tmp) - trim_front - trim_end;
751 if (trim_front > tmp->current_length)
753 /* drop whole buffer */
754 if (!(tmp->flags & VLIB_BUFFER_NEXT_PRESENT))
756 rv = IP6_FULL_REASS_RC_INTERNAL_ERROR;
757 goto free_buffers_and_return;
759 trim_front -= tmp->current_length;
760 vec_add1 (vec_drop_compress, tmp_bi);
761 tmp->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
762 tmp_bi = tmp->next_buffer;
763 tmp = vlib_get_buffer (vm, tmp_bi);
768 vlib_buffer_advance (tmp, trim_front);
776 last_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
777 last_b->next_buffer = tmp_bi;
780 if (keep_data <= tmp->current_length)
782 tmp->current_length = keep_data;
787 keep_data -= tmp->current_length;
788 if (!(tmp->flags & VLIB_BUFFER_NEXT_PRESENT))
790 rv = IP6_FULL_REASS_RC_INTERNAL_ERROR;
791 goto free_buffers_and_return;
794 total_length += tmp->current_length;
798 if (reass->first_bi == tmp_bi)
800 rv = IP6_FULL_REASS_RC_INTERNAL_ERROR;
801 goto free_buffers_and_return;
803 vec_add1 (vec_drop_compress, tmp_bi);
805 if (tmp->flags & VLIB_BUFFER_NEXT_PRESENT)
807 tmp_bi = tmp->next_buffer;
808 tmp = vlib_get_buffer (vm, tmp->next_buffer);
816 vnet_buffer (vlib_get_buffer (vm, sub_chain_bi))->ip.
819 while (~0 != sub_chain_bi);
823 rv = IP6_FULL_REASS_RC_INTERNAL_ERROR;
824 goto free_buffers_and_return;
826 last_b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
827 vlib_buffer_t *first_b = vlib_get_buffer (vm, reass->first_bi);
828 if (total_length < first_b->current_length)
830 rv = IP6_FULL_REASS_RC_INTERNAL_ERROR;
831 goto free_buffers_and_return;
833 total_length -= first_b->current_length;
834 first_b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
835 first_b->total_length_not_including_first_buffer = total_length;
836 // drop fragment header
837 vnet_buffer_opaque_t *first_b_vnb = vnet_buffer (first_b);
838 ip6_header_t *ip = vlib_buffer_get_current (first_b);
839 u16 ip6_frag_hdr_offset = first_b_vnb->ip.reass.ip6_frag_hdr_offset;
840 ip6_ext_hdr_chain_t hdr_chain;
841 ip6_ext_header_t *prev_hdr = 0;
842 int res = ip6_ext_header_walk (first_b, ip, IP_PROTOCOL_IPV6_FRAGMENTATION,
845 (hdr_chain.eh[res].protocol != IP_PROTOCOL_IPV6_FRAGMENTATION))
847 rv = IP6_FULL_REASS_RC_INTERNAL_ERROR;
848 goto free_buffers_and_return;
850 frag_hdr = ip6_ext_next_header_offset (ip, hdr_chain.eh[res].offset);
853 prev_hdr = ip6_ext_next_header_offset (ip, hdr_chain.eh[res - 1].offset);
854 prev_hdr->next_hdr = frag_hdr->next_hdr;
858 ip->protocol = frag_hdr->next_hdr;
860 if (hdr_chain.eh[res].offset != ip6_frag_hdr_offset)
862 rv = IP6_FULL_REASS_RC_INTERNAL_ERROR;
863 goto free_buffers_and_return;
865 memmove (frag_hdr, (u8 *) frag_hdr + sizeof (*frag_hdr),
866 first_b->current_length - ip6_frag_hdr_offset -
867 sizeof (ip6_frag_hdr_t));
868 first_b->current_length -= sizeof (*frag_hdr);
870 clib_host_to_net_u16 (total_length + first_b->current_length -
872 if (!vlib_buffer_chain_linearize (vm, first_b))
874 rv = IP6_FULL_REASS_RC_NO_BUF;
875 goto free_buffers_and_return;
877 first_b->flags &= ~VLIB_BUFFER_EXT_HDR_VALID;
878 if (PREDICT_FALSE (first_b->flags & VLIB_BUFFER_IS_TRACED))
880 ip6_full_reass_add_trace (vm, node, reass, reass->first_bi, NULL,
883 // following code does a hexdump of packet fragments to stdout ...
886 u32 bi = reass->first_bi;
890 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
891 s = format (s, "%u: %U\n", bi, format_hexdump,
892 vlib_buffer_get_current (b), b->current_length);
893 if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
902 printf ("%.*s\n", vec_len (s), s);
911 *next0 = IP6_FULL_REASSEMBLY_NEXT_INPUT;
915 *next0 = reass->next_index;
917 vnet_buffer (first_b)->ip.reass.estimated_mtu = reass->min_fragment_length;
918 /* Keep track of number of successfully reassembled packets and number of
919 * fragments reassembled */
920 vlib_node_increment_counter (vm, node->node_index, IP6_ERROR_REASS_SUCCESS,
923 vlib_node_increment_counter (vm, node->node_index,
924 IP6_ERROR_REASS_FRAGMENTS_REASSEMBLED,
927 ip6_full_reass_free (rm, rt, reass);
929 free_buffers_and_return:
930 vlib_buffer_free (vm, vec_drop_compress, vec_len (vec_drop_compress));
931 vec_free (vec_drop_compress);
936 ip6_full_reass_insert_range_in_chain (vlib_main_t * vm,
937 ip6_full_reass_t * reass,
938 u32 prev_range_bi, u32 new_next_bi)
941 vlib_buffer_t *new_next_b = vlib_get_buffer (vm, new_next_bi);
942 vnet_buffer_opaque_t *new_next_vnb = vnet_buffer (new_next_b);
943 if (~0 != prev_range_bi)
945 vlib_buffer_t *prev_b = vlib_get_buffer (vm, prev_range_bi);
946 vnet_buffer_opaque_t *prev_vnb = vnet_buffer (prev_b);
947 new_next_vnb->ip.reass.next_range_bi = prev_vnb->ip.reass.next_range_bi;
948 prev_vnb->ip.reass.next_range_bi = new_next_bi;
952 if (~0 != reass->first_bi)
954 new_next_vnb->ip.reass.next_range_bi = reass->first_bi;
956 reass->first_bi = new_next_bi;
958 reass->data_len += ip6_full_reass_buffer_get_data_len (new_next_b);
961 always_inline ip6_full_reass_rc_t
962 ip6_full_reass_update (vlib_main_t *vm, vlib_node_runtime_t *node,
963 ip6_full_reass_main_t *rm,
964 ip6_full_reass_per_thread_t *rt,
965 ip6_full_reass_t *reass, u32 *bi0, u32 *next0,
966 u32 *error0, ip6_frag_hdr_t *frag_hdr,
967 bool is_custom_app, u32 *handoff_thread_idx,
971 vlib_buffer_t *fb = vlib_get_buffer (vm, *bi0);
972 vnet_buffer_opaque_t *fvnb = vnet_buffer (fb);
975 reass->next_index = fvnb->ip.reass.next_index; // store next_index before it's overwritten
976 reass->error_next_index = fvnb->ip.reass.error_next_index; // store error_next_index before it is overwritten
979 fvnb->ip.reass.ip6_frag_hdr_offset =
980 (u8 *) frag_hdr - (u8 *) vlib_buffer_get_current (fb);
981 ip6_header_t *fip = vlib_buffer_get_current (fb);
982 if (fb->current_length < sizeof (*fip) ||
983 fvnb->ip.reass.ip6_frag_hdr_offset == 0 ||
984 fvnb->ip.reass.ip6_frag_hdr_offset >= fb->current_length)
986 return IP6_FULL_REASS_RC_INTERNAL_ERROR;
989 u32 fragment_first = fvnb->ip.reass.fragment_first =
990 ip6_frag_hdr_offset_bytes (frag_hdr);
991 u32 fragment_length =
992 vlib_buffer_length_in_chain (vm, fb) -
993 (fvnb->ip.reass.ip6_frag_hdr_offset + sizeof (*frag_hdr));
994 if (0 == fragment_length)
996 return IP6_FULL_REASS_RC_INVALID_FRAG_LEN;
998 u32 fragment_last = fvnb->ip.reass.fragment_last =
999 fragment_first + fragment_length - 1;
1000 int more_fragments = ip6_frag_hdr_more (frag_hdr);
1001 u32 candidate_range_bi = reass->first_bi;
1002 u32 prev_range_bi = ~0;
1003 fvnb->ip.reass.range_first = fragment_first;
1004 fvnb->ip.reass.range_last = fragment_last;
1005 fvnb->ip.reass.next_range_bi = ~0;
1006 if (!more_fragments)
1008 reass->last_packet_octet = fragment_last;
1010 if (~0 == reass->first_bi)
1012 // starting a new reassembly
1013 ip6_full_reass_insert_range_in_chain (vm, reass, prev_range_bi, *bi0);
1014 reass->min_fragment_length = clib_net_to_host_u16 (fip->payload_length);
1016 reass->fragments_n = 1;
1017 goto check_if_done_maybe;
1019 reass->min_fragment_length =
1020 clib_min (clib_net_to_host_u16 (fip->payload_length),
1021 fvnb->ip.reass.estimated_mtu);
1022 while (~0 != candidate_range_bi)
1024 vlib_buffer_t *candidate_b = vlib_get_buffer (vm, candidate_range_bi);
1025 vnet_buffer_opaque_t *candidate_vnb = vnet_buffer (candidate_b);
1026 if (fragment_first > candidate_vnb->ip.reass.range_last)
1028 // this fragments starts after candidate range
1029 prev_range_bi = candidate_range_bi;
1030 candidate_range_bi = candidate_vnb->ip.reass.next_range_bi;
1031 if (candidate_vnb->ip.reass.range_last < fragment_last &&
1032 ~0 == candidate_range_bi)
1034 // special case - this fragment falls beyond all known ranges
1035 ip6_full_reass_insert_range_in_chain (vm, reass, prev_range_bi,
1042 if (fragment_last < candidate_vnb->ip.reass.range_first)
1044 // this fragment ends before candidate range without any overlap
1045 ip6_full_reass_insert_range_in_chain (vm, reass, prev_range_bi,
1049 else if (fragment_first == candidate_vnb->ip.reass.range_first &&
1050 fragment_last == candidate_vnb->ip.reass.range_last)
1052 // duplicate fragment - ignore
1056 // overlapping fragment - not allowed by RFC 8200
1057 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
1059 ip6_full_reass_add_trace (vm, node, reass, *bi0, frag_hdr,
1062 return IP6_FULL_REASS_RC_OVERLAP;
1066 ++reass->fragments_n;
1067 check_if_done_maybe:
1070 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
1072 ip6_full_reass_add_trace (vm, node, reass, *bi0, frag_hdr, RANGE_NEW,
1076 else if (skip_bihash)
1078 // if this reassembly is not in bihash, then the packet must have been
1080 return IP6_FULL_REASS_RC_INTERNAL_ERROR;
1082 if (~0 != reass->last_packet_octet &&
1083 reass->data_len == reass->last_packet_octet + 1)
1085 *handoff_thread_idx = reass->sendout_thread_index;
1087 reass->memory_owner_thread_index != reass->sendout_thread_index;
1088 ip6_full_reass_rc_t rc =
1089 ip6_full_reass_finalize (vm, node, rm, rt, reass, bi0, next0, error0,
1091 if (IP6_FULL_REASS_RC_OK == rc && handoff)
1093 return IP6_FULL_REASS_RC_HANDOFF;
1101 // if this reassembly is not in bihash, it should've been an atomic
1102 // fragment and thus finalized
1103 return IP6_FULL_REASS_RC_INTERNAL_ERROR;
1108 if (reass->fragments_n > rm->max_reass_len)
1110 return IP6_FULL_REASS_RC_TOO_MANY_FRAGMENTS;
1115 *next0 = IP6_FULL_REASSEMBLY_NEXT_DROP;
1116 *error0 = IP6_ERROR_REASS_DUPLICATE_FRAGMENT;
1119 return IP6_FULL_REASS_RC_OK;
1123 ip6_full_reass_verify_upper_layer_present (vlib_node_runtime_t *node,
1125 ip6_ext_hdr_chain_t *hc)
1127 int nh = hc->eh[hc->length - 1].protocol;
1128 /* Checking to see if it's a terminating header */
1129 if (ip6_ext_hdr (nh))
1131 icmp6_error_set_vnet_buffer (
1132 b, ICMP6_parameter_problem,
1133 ICMP6_parameter_problem_first_fragment_has_incomplete_header_chain, 0);
1134 b->error = node->errors[IP6_ERROR_REASS_MISSING_UPPER];
1141 ip6_full_reass_verify_fragment_multiple_8 (vlib_main_t *vm,
1142 vlib_node_runtime_t *node,
1144 ip6_frag_hdr_t *frag_hdr)
1146 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
1147 ip6_header_t *ip = vlib_buffer_get_current (b);
1148 int more_fragments = ip6_frag_hdr_more (frag_hdr);
1149 u32 fragment_length =
1150 vlib_buffer_length_in_chain (vm, b) -
1151 (vnb->ip.reass.ip6_frag_hdr_offset + sizeof (*frag_hdr));
1152 if (more_fragments && 0 != fragment_length % 8)
1154 icmp6_error_set_vnet_buffer (b, ICMP6_parameter_problem,
1155 ICMP6_parameter_problem_erroneous_header_field,
1156 (u8 *) & ip->payload_length - (u8 *) ip);
1157 b->error = node->errors[IP6_ERROR_REASS_INVALID_FRAG_SIZE];
1164 ip6_full_reass_verify_packet_size_lt_64k (vlib_main_t *vm,
1165 vlib_node_runtime_t *node,
1167 ip6_frag_hdr_t *frag_hdr)
1169 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
1170 u32 fragment_first = ip6_frag_hdr_offset_bytes (frag_hdr);
1171 u32 fragment_length =
1172 vlib_buffer_length_in_chain (vm, b) -
1173 (vnb->ip.reass.ip6_frag_hdr_offset + sizeof (*frag_hdr));
1174 if (fragment_first + fragment_length > 65535)
1176 ip6_header_t *ip0 = vlib_buffer_get_current (b);
1177 icmp6_error_set_vnet_buffer (b, ICMP6_parameter_problem,
1178 ICMP6_parameter_problem_erroneous_header_field,
1179 (u8 *) & frag_hdr->fragment_offset_and_more
1181 b->error = node->errors[IP6_ERROR_REASS_INVALID_FRAG_SIZE];
1188 ip6_full_reassembly_inline (vlib_main_t *vm, vlib_node_runtime_t *node,
1189 vlib_frame_t *frame, bool is_feature,
1190 bool is_custom_app, bool is_local)
1192 u32 *from = vlib_frame_vector_args (frame);
1193 u32 n_left_from, n_left_to_next, *to_next, next_index;
1194 ip6_full_reass_main_t *rm = &ip6_full_reass_main;
1195 ip6_full_reass_per_thread_t *rt = &rm->per_thread_data[vm->thread_index];
1196 clib_spinlock_lock (&rt->lock);
1198 n_left_from = frame->n_vectors;
1199 next_index = node->cached_next_index;
1200 while (n_left_from > 0)
1202 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
1204 while (n_left_from > 0 && n_left_to_next > 0)
1208 u32 next0 = IP6_FULL_REASSEMBLY_NEXT_DROP;
1209 u32 error0 = IP6_ERROR_NONE;
1213 b0 = vlib_get_buffer (vm, bi0);
1215 ip6_header_t *ip0 = vlib_buffer_get_current (b0);
1216 ip6_frag_hdr_t *frag_hdr = NULL;
1217 ip6_ext_hdr_chain_t hdr_chain;
1218 vnet_buffer_opaque_t *fvnb = vnet_buffer (b0);
1220 int res = ip6_ext_header_walk (
1221 b0, ip0, IP_PROTOCOL_IPV6_FRAGMENTATION, &hdr_chain);
1223 hdr_chain.eh[res].protocol != IP_PROTOCOL_IPV6_FRAGMENTATION)
1225 vlib_node_increment_counter (vm, node->node_index,
1226 IP6_ERROR_REASS_NO_FRAG_HDR, 1);
1227 // this is a mangled packet - no fragmentation
1228 next0 = is_custom_app ? fvnb->ip.reass.error_next_index :
1229 IP6_FULL_REASSEMBLY_NEXT_DROP;
1230 ip6_full_reass_add_trace (vm, node, NULL, bi0, NULL, PASSTHROUGH,
1234 if (is_local && !rm->is_local_reass_enabled)
1236 next0 = IP6_FULL_REASSEMBLY_NEXT_DROP;
1240 /* Keep track of received fragments */
1241 vlib_node_increment_counter (vm, node->node_index,
1242 IP6_ERROR_REASS_FRAGMENTS_RCVD, 1);
1244 ip6_ext_next_header_offset (ip0, hdr_chain.eh[res].offset);
1245 vnet_buffer (b0)->ip.reass.ip6_frag_hdr_offset =
1246 hdr_chain.eh[res].offset;
1248 if (0 == ip6_frag_hdr_offset (frag_hdr))
1250 // first fragment - verify upper-layer is present
1251 if (!ip6_full_reass_verify_upper_layer_present (node, b0,
1254 next0 = is_custom_app ? fvnb->ip.reass.error_next_index :
1255 IP6_FULL_REASSEMBLY_NEXT_ICMP_ERROR;
1260 if (!ip6_full_reass_verify_fragment_multiple_8 (vm, node, b0,
1262 !ip6_full_reass_verify_packet_size_lt_64k (vm, node, b0,
1265 next0 = is_custom_app ? fvnb->ip.reass.error_next_index :
1266 IP6_FULL_REASSEMBLY_NEXT_ICMP_ERROR;
1270 int skip_bihash = 0;
1271 ip6_full_reass_kv_t kv;
1274 if (0 == ip6_frag_hdr_offset (frag_hdr) &&
1275 !ip6_frag_hdr_more (frag_hdr))
1277 // this is atomic fragment and needs to be processed separately
1282 kv.k.as_u64[0] = ip0->src_address.as_u64[0];
1283 kv.k.as_u64[1] = ip0->src_address.as_u64[1];
1284 kv.k.as_u64[2] = ip0->dst_address.as_u64[0];
1285 kv.k.as_u64[3] = ip0->dst_address.as_u64[1];
1287 ((u64) vec_elt (ip6_main.fib_index_by_sw_if_index,
1288 vnet_buffer (b0)->sw_if_index[VLIB_RX]))
1290 (u64) frag_hdr->identification;
1291 /* RFC 8200: The Next Header values in the Fragment headers of
1292 * different fragments of the same original packet may differ.
1293 * Only the value from the Offset zero fragment packet is used
1296 * Also, IPv6 Header doesnt contain the protocol value unlike
1301 ip6_full_reass_t *reass = ip6_full_reass_find_or_create (
1302 vm, node, rm, rt, &kv, &icmp_bi, &do_handoff, skip_bihash,
1303 &n_left_to_next, &to_next);
1307 const u32 fragment_first = ip6_frag_hdr_offset (frag_hdr);
1308 if (0 == fragment_first)
1310 reass->sendout_thread_index = vm->thread_index;
1313 if (PREDICT_FALSE (do_handoff))
1315 next0 = IP6_FULL_REASSEMBLY_NEXT_HANDOFF;
1316 vnet_buffer (b0)->ip.reass.owner_thread_index =
1317 kv.v.memory_owner_thread_index;
1321 u32 handoff_thread_idx;
1323 switch (ip6_full_reass_update (
1324 vm, node, rm, rt, reass, &bi0, &next0, &error0, frag_hdr,
1325 is_custom_app, &handoff_thread_idx, skip_bihash))
1327 case IP6_FULL_REASS_RC_OK:
1328 /* nothing to do here */
1330 case IP6_FULL_REASS_RC_HANDOFF:
1331 next0 = IP6_FULL_REASSEMBLY_NEXT_HANDOFF;
1332 b0 = vlib_get_buffer (vm, bi0);
1333 vnet_buffer (b0)->ip.reass.owner_thread_index =
1336 case IP6_FULL_REASS_RC_TOO_MANY_FRAGMENTS:
1337 counter = IP6_ERROR_REASS_FRAGMENT_CHAIN_TOO_LONG;
1339 case IP6_FULL_REASS_RC_NO_BUF:
1340 counter = IP6_ERROR_REASS_NO_BUF;
1342 case IP6_FULL_REASS_RC_INVALID_FRAG_LEN:
1343 counter = IP6_ERROR_REASS_INVALID_FRAG_LEN;
1345 case IP6_FULL_REASS_RC_OVERLAP:
1346 counter = IP6_ERROR_REASS_OVERLAPPING_FRAGMENT;
1348 case IP6_FULL_REASS_RC_INTERNAL_ERROR:
1349 counter = IP6_ERROR_REASS_INTERNAL_ERROR;
1350 /* Sanitization is needed in internal error cases only, as
1351 * the incoming packet is already dropped in other cases,
1352 * also adding bi0 back to the reassembly list, fixes the
1353 * leaking of buffers during internal errors.
1355 * Also it doesnt make sense to send these buffers custom
1356 * app, these fragments are with internal errors */
1357 sanitize_reass_buffers_add_missing (vm, reass, &bi0);
1358 reass->error_next_index = ~0;
1363 vlib_node_increment_counter (vm, node->node_index, counter,
1365 ip6_full_reass_drop_all (vm, node, reass, &n_left_to_next,
1367 ip6_full_reass_free (rm, rt, reass);
1376 next0 = IP6_FULL_REASSEMBLY_NEXT_DROP;
1380 next0 = fvnb->ip.reass.error_next_index;
1382 error0 = IP6_ERROR_REASS_LIMIT_REACHED;
1390 n_left_to_next -= 1;
1392 /* bi0 might have been updated by reass_finalize, reload */
1393 b0 = vlib_get_buffer (vm, bi0);
1394 if (IP6_ERROR_NONE != error0)
1396 b0->error = node->errors[error0];
1399 if (next0 == IP6_FULL_REASSEMBLY_NEXT_HANDOFF)
1401 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
1403 ip6_full_reass_add_trace (
1404 vm, node, NULL, bi0, frag_hdr, HANDOFF,
1405 vnet_buffer (b0)->ip.reass.owner_thread_index);
1408 else if (is_feature && IP6_ERROR_NONE == error0)
1410 vnet_feature_next (&next0, b0);
1413 /* Increment the counter to-custom-app also as this fragment is
1414 * also going to application */
1417 vlib_node_increment_counter (
1418 vm, node->node_index, IP6_ERROR_REASS_TO_CUSTOM_APP, 1);
1421 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
1422 n_left_to_next, bi0, next0);
1427 next0 = IP6_FULL_REASSEMBLY_NEXT_ICMP_ERROR;
1428 to_next[0] = icmp_bi;
1430 n_left_to_next -= 1;
1431 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
1432 n_left_to_next, icmp_bi,
1440 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1443 clib_spinlock_unlock (&rt->lock);
1444 return frame->n_vectors;
1447 VLIB_NODE_FN (ip6_full_reass_node) (vlib_main_t * vm,
1448 vlib_node_runtime_t * node,
1449 vlib_frame_t * frame)
1451 return ip6_full_reassembly_inline (vm, node, frame, false /* is_feature */,
1452 false /* is_custom_app */,
1453 false /* is_local */);
1456 VLIB_REGISTER_NODE (ip6_full_reass_node) = {
1457 .name = "ip6-full-reassembly",
1458 .vector_size = sizeof (u32),
1459 .format_trace = format_ip6_full_reass_trace,
1460 .n_errors = IP6_N_ERROR,
1461 .error_counters = ip6_error_counters,
1462 .n_next_nodes = IP6_FULL_REASSEMBLY_N_NEXT,
1465 [IP6_FULL_REASSEMBLY_NEXT_INPUT] = "ip6-input",
1466 [IP6_FULL_REASSEMBLY_NEXT_DROP] = "ip6-drop",
1467 [IP6_FULL_REASSEMBLY_NEXT_ICMP_ERROR] = "ip6-icmp-error",
1468 [IP6_FULL_REASSEMBLY_NEXT_HANDOFF] = "ip6-full-reassembly-handoff",
1472 VLIB_NODE_FN (ip6_local_full_reass_node)
1473 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
1475 return ip6_full_reassembly_inline (vm, node, frame, false /* is_feature */,
1476 false /* is_custom_app */,
1477 true /* is_local */);
1480 VLIB_REGISTER_NODE (ip6_local_full_reass_node) = {
1481 .name = "ip6-local-full-reassembly",
1482 .vector_size = sizeof (u32),
1483 .format_trace = format_ip6_full_reass_trace,
1484 .n_errors = IP6_N_ERROR,
1485 .error_counters = ip6_error_counters,
1486 .n_next_nodes = IP6_FULL_REASSEMBLY_N_NEXT,
1489 [IP6_FULL_REASSEMBLY_NEXT_INPUT] = "ip6-input",
1490 [IP6_FULL_REASSEMBLY_NEXT_DROP] = "ip6-drop",
1491 [IP6_FULL_REASSEMBLY_NEXT_ICMP_ERROR] = "ip6-icmp-error",
1492 [IP6_FULL_REASSEMBLY_NEXT_HANDOFF] = "ip6-local-full-reassembly-handoff",
1496 VLIB_NODE_FN (ip6_full_reass_node_feature) (vlib_main_t * vm,
1497 vlib_node_runtime_t * node,
1498 vlib_frame_t * frame)
1500 return ip6_full_reassembly_inline (vm, node, frame, true /* is_feature */,
1501 false /* is_custom_app */,
1502 false /* is_local */);
1505 VLIB_REGISTER_NODE (ip6_full_reass_node_feature) = {
1506 .name = "ip6-full-reassembly-feature",
1507 .vector_size = sizeof (u32),
1508 .format_trace = format_ip6_full_reass_trace,
1509 .n_errors = IP6_N_ERROR,
1510 .error_counters = ip6_error_counters,
1511 .n_next_nodes = IP6_FULL_REASSEMBLY_N_NEXT,
1514 [IP6_FULL_REASSEMBLY_NEXT_INPUT] = "ip6-input",
1515 [IP6_FULL_REASSEMBLY_NEXT_DROP] = "ip6-drop",
1516 [IP6_FULL_REASSEMBLY_NEXT_ICMP_ERROR] = "ip6-icmp-error",
1517 [IP6_FULL_REASSEMBLY_NEXT_HANDOFF] = "ip6-full-reass-feature-hoff",
1521 VNET_FEATURE_INIT (ip6_full_reassembly_feature, static) = {
1522 .arc_name = "ip6-unicast",
1523 .node_name = "ip6-full-reassembly-feature",
1524 .runs_before = VNET_FEATURES ("ip6-lookup",
1525 "ipsec6-input-feature"),
1529 VLIB_NODE_FN (ip6_full_reass_node_custom)
1530 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
1532 return ip6_full_reassembly_inline (vm, node, frame, false /* is_feature */,
1533 true /* is_custom_app */,
1534 false /* is_local */);
1537 VLIB_REGISTER_NODE (ip6_full_reass_node_custom) = {
1538 .name = "ip6-full-reassembly-custom",
1539 .vector_size = sizeof (u32),
1540 .format_trace = format_ip6_full_reass_trace,
1541 .n_errors = IP6_N_ERROR,
1542 .error_counters = ip6_error_counters,
1543 .n_next_nodes = IP6_FULL_REASSEMBLY_N_NEXT,
1546 [IP6_FULL_REASSEMBLY_NEXT_INPUT] = "ip6-input",
1547 [IP6_FULL_REASSEMBLY_NEXT_DROP] = "ip6-drop",
1548 [IP6_FULL_REASSEMBLY_NEXT_ICMP_ERROR] = "ip6-icmp-error",
1549 [IP6_FULL_REASSEMBLY_NEXT_HANDOFF] = "ip6-full-reass-custom-hoff",
1553 #ifndef CLIB_MARCH_VARIANT
1555 ip6_full_reass_get_nbuckets ()
1557 ip6_full_reass_main_t *rm = &ip6_full_reass_main;
1561 /* need more mem with more workers */
1562 nbuckets = (u32) (rm->max_reass_n * (vlib_num_workers () + 1) /
1563 IP6_FULL_REASS_HT_LOAD_FACTOR);
1565 for (i = 0; i < 31; i++)
1566 if ((1 << i) >= nbuckets)
1572 #endif /* CLIB_MARCH_VARIANT */
1576 IP6_EVENT_CONFIG_CHANGED = 1,
1577 } ip6_full_reass_event_t;
1579 #ifndef CLIB_MARCH_VARIANT
1583 clib_bihash_48_8_t *new_hash;
1584 } ip6_rehash_cb_ctx;
1587 ip6_rehash_cb (clib_bihash_kv_48_8_t * kv, void *_ctx)
1589 ip6_rehash_cb_ctx *ctx = _ctx;
1590 if (clib_bihash_add_del_48_8 (ctx->new_hash, kv, 1))
1594 return (BIHASH_WALK_CONTINUE);
1598 ip6_full_reass_set_params (u32 timeout_ms, u32 max_reassemblies,
1599 u32 max_reassembly_length,
1600 u32 expire_walk_interval_ms)
1602 ip6_full_reass_main.timeout_ms = timeout_ms;
1603 ip6_full_reass_main.timeout = (f64) timeout_ms / (f64) MSEC_PER_SEC;
1604 ip6_full_reass_main.max_reass_n = max_reassemblies;
1605 ip6_full_reass_main.max_reass_len = max_reassembly_length;
1606 ip6_full_reass_main.expire_walk_interval_ms = expire_walk_interval_ms;
1610 ip6_full_reass_set (u32 timeout_ms, u32 max_reassemblies,
1611 u32 max_reassembly_length, u32 expire_walk_interval_ms)
1613 u32 old_nbuckets = ip6_full_reass_get_nbuckets ();
1614 ip6_full_reass_set_params (timeout_ms, max_reassemblies,
1615 max_reassembly_length, expire_walk_interval_ms);
1616 vlib_process_signal_event (ip6_full_reass_main.vlib_main,
1617 ip6_full_reass_main.ip6_full_reass_expire_node_idx,
1618 IP6_EVENT_CONFIG_CHANGED, 0);
1619 u32 new_nbuckets = ip6_full_reass_get_nbuckets ();
1620 if (ip6_full_reass_main.max_reass_n > 0 && new_nbuckets > old_nbuckets)
1622 clib_bihash_48_8_t new_hash;
1623 clib_memset (&new_hash, 0, sizeof (new_hash));
1624 ip6_rehash_cb_ctx ctx;
1626 ctx.new_hash = &new_hash;
1627 clib_bihash_init_48_8 (&new_hash, "ip6-full-reass", new_nbuckets,
1628 new_nbuckets * 1024);
1629 clib_bihash_foreach_key_value_pair_48_8 (&ip6_full_reass_main.hash,
1630 ip6_rehash_cb, &ctx);
1633 clib_bihash_free_48_8 (&new_hash);
1638 clib_bihash_free_48_8 (&ip6_full_reass_main.hash);
1639 clib_memcpy_fast (&ip6_full_reass_main.hash, &new_hash,
1640 sizeof (ip6_full_reass_main.hash));
1641 clib_bihash_copied (&ip6_full_reass_main.hash, &new_hash);
1648 ip6_full_reass_get (u32 * timeout_ms, u32 * max_reassemblies,
1649 u32 * max_reassembly_length,
1650 u32 * expire_walk_interval_ms)
1652 *timeout_ms = ip6_full_reass_main.timeout_ms;
1653 *max_reassemblies = ip6_full_reass_main.max_reass_n;
1654 *max_reassembly_length = ip6_full_reass_main.max_reass_len;
1655 *expire_walk_interval_ms = ip6_full_reass_main.expire_walk_interval_ms;
1659 static clib_error_t *
1660 ip6_full_reass_init_function (vlib_main_t * vm)
1662 ip6_full_reass_main_t *rm = &ip6_full_reass_main;
1663 clib_error_t *error = 0;
1669 vec_validate (rm->per_thread_data, vlib_num_workers ());
1670 ip6_full_reass_per_thread_t *rt;
1671 vec_foreach (rt, rm->per_thread_data)
1673 clib_spinlock_init (&rt->lock);
1674 pool_alloc (rt->pool, rm->max_reass_n);
1677 node = vlib_get_node_by_name (vm, (u8 *) "ip6-full-reassembly-expire-walk");
1679 rm->ip6_full_reass_expire_node_idx = node->index;
1681 ip6_full_reass_set_params (IP6_FULL_REASS_TIMEOUT_DEFAULT_MS,
1682 IP6_FULL_REASS_MAX_REASSEMBLIES_DEFAULT,
1683 IP6_FULL_REASS_MAX_REASSEMBLY_LENGTH_DEFAULT,
1684 IP6_FULL_REASS_EXPIRE_WALK_INTERVAL_DEFAULT_MS);
1686 nbuckets = ip6_full_reass_get_nbuckets ();
1687 clib_bihash_init_48_8 (&rm->hash, "ip6-full-reass", nbuckets,
1690 node = vlib_get_node_by_name (vm, (u8 *) "ip6-icmp-error");
1692 rm->ip6_icmp_error_idx = node->index;
1694 if ((error = vlib_call_init_function (vm, ip_main_init)))
1696 ip6_register_protocol (IP_PROTOCOL_IPV6_FRAGMENTATION,
1697 ip6_local_full_reass_node.index);
1698 rm->is_local_reass_enabled = 1;
1700 rm->fq_index = vlib_frame_queue_main_init (ip6_full_reass_node.index, 0);
1701 rm->fq_local_index =
1702 vlib_frame_queue_main_init (ip6_local_full_reass_node.index, 0);
1703 rm->fq_feature_index =
1704 vlib_frame_queue_main_init (ip6_full_reass_node_feature.index, 0);
1705 rm->fq_custom_index =
1706 vlib_frame_queue_main_init (ip6_full_reass_node_custom.index, 0);
1708 rm->feature_use_refcount_per_intf = NULL;
1712 VLIB_INIT_FUNCTION (ip6_full_reass_init_function);
1713 #endif /* CLIB_MARCH_VARIANT */
1716 ip6_full_reass_walk_expired (vlib_main_t *vm, vlib_node_runtime_t *node,
1717 CLIB_UNUSED (vlib_frame_t *f))
1719 ip6_full_reass_main_t *rm = &ip6_full_reass_main;
1720 uword event_type, *event_data = 0;
1724 vlib_process_wait_for_event_or_clock (vm,
1725 (f64) rm->expire_walk_interval_ms
1726 / (f64) MSEC_PER_SEC);
1727 event_type = vlib_process_get_events (vm, &event_data);
1732 /* no events => timeout */
1734 case IP6_EVENT_CONFIG_CHANGED:
1735 /* nothing to do here */
1738 clib_warning ("BUG: event type 0x%wx", event_type);
1741 f64 now = vlib_time_now (vm);
1743 ip6_full_reass_t *reass;
1744 int *pool_indexes_to_free = NULL;
1746 uword thread_index = 0;
1748 const uword nthreads = vlib_num_workers () + 1;
1749 u32 *vec_icmp_bi = NULL;
1750 u32 n_left_to_next, *to_next;
1752 for (thread_index = 0; thread_index < nthreads; ++thread_index)
1754 ip6_full_reass_per_thread_t *rt =
1755 &rm->per_thread_data[thread_index];
1756 u32 reass_timeout_cnt = 0;
1757 clib_spinlock_lock (&rt->lock);
1759 vec_reset_length (pool_indexes_to_free);
1760 /* Pace the number of timeouts handled per thread,to avoid barrier
1761 * sync issues in real world scenarios */
1763 u32 beg = rt->last_id;
1764 /* to ensure we walk at least once per sec per context */
1765 u32 end = beg + (IP6_FULL_REASS_MAX_REASSEMBLIES_DEFAULT *
1766 IP6_FULL_REASS_EXPIRE_WALK_INTERVAL_DEFAULT_MS /
1769 if (end > vec_len (rt->pool))
1771 end = vec_len (rt->pool);
1779 pool_foreach_stepping_index (index, beg, end, rt->pool)
1781 reass = pool_elt_at_index (rt->pool, index);
1782 if (now > reass->last_heard + rm->timeout)
1784 vec_add1 (pool_indexes_to_free, index);
1789 vec_foreach (i, pool_indexes_to_free)
1791 ip6_full_reass_t *reass = pool_elt_at_index (rt->pool, i[0]);
1794 reass_timeout_cnt += reass->fragments_n;
1795 ip6_full_reass_on_timeout (vm, node, reass, &icmp_bi,
1796 &n_left_to_next, &to_next);
1798 vec_add1 (vec_icmp_bi, icmp_bi);
1800 ip6_full_reass_free (rm, rt, reass);
1803 clib_spinlock_unlock (&rt->lock);
1804 if (reass_timeout_cnt)
1805 vlib_node_increment_counter (vm, node->node_index,
1806 IP6_ERROR_REASS_TIMEOUT,
1810 while (vec_len (vec_icmp_bi) > 0)
1813 vlib_get_frame_to_node (vm, rm->ip6_icmp_error_idx);
1814 u32 *to_next = vlib_frame_vector_args (f);
1815 u32 n_left_to_next = VLIB_FRAME_SIZE - f->n_vectors;
1816 int trace_frame = 0;
1817 while (vec_len (vec_icmp_bi) > 0 && n_left_to_next > 0)
1819 u32 bi = vec_pop (vec_icmp_bi);
1820 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
1821 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
1826 n_left_to_next -= 1;
1828 f->frame_flags |= (trace_frame * VLIB_FRAME_TRACE);
1829 vlib_put_frame_to_node (vm, rm->ip6_icmp_error_idx, f);
1832 vec_free (pool_indexes_to_free);
1833 vec_free (vec_icmp_bi);
1836 vec_set_len (event_data, 0);
1843 VLIB_REGISTER_NODE (ip6_full_reass_expire_node) = {
1844 .function = ip6_full_reass_walk_expired,
1845 .format_trace = format_ip6_full_reass_trace,
1846 .type = VLIB_NODE_TYPE_PROCESS,
1847 .name = "ip6-full-reassembly-expire-walk",
1849 .n_errors = IP6_N_ERROR,
1850 .error_counters = ip6_error_counters,
1854 format_ip6_full_reass_key (u8 * s, va_list * args)
1856 ip6_full_reass_key_t *key = va_arg (*args, ip6_full_reass_key_t *);
1857 s = format (s, "xx_id: %u, src: %U, dst: %U, frag_id: %u, proto: %u",
1858 key->xx_id, format_ip6_address, &key->src, format_ip6_address,
1859 &key->dst, clib_net_to_host_u16 (key->frag_id), key->proto);
1864 format_ip6_full_reass (u8 * s, va_list * args)
1866 vlib_main_t *vm = va_arg (*args, vlib_main_t *);
1867 ip6_full_reass_t *reass = va_arg (*args, ip6_full_reass_t *);
1869 s = format (s, "ID: %lu, key: %U\n first_bi: %u, data_len: %u, "
1870 "last_packet_octet: %u, trace_op_counter: %u\n",
1871 reass->id, format_ip6_full_reass_key, &reass->key,
1872 reass->first_bi, reass->data_len, reass->last_packet_octet,
1873 reass->trace_op_counter);
1874 u32 bi = reass->first_bi;
1878 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
1879 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
1880 s = format (s, " #%03u: range: [%u, %u], bi: %u, off: %d, len: %u, "
1881 "fragment[%u, %u]\n",
1882 counter, vnb->ip.reass.range_first,
1883 vnb->ip.reass.range_last, bi,
1884 ip6_full_reass_buffer_get_data_offset (b),
1885 ip6_full_reass_buffer_get_data_len (b),
1886 vnb->ip.reass.fragment_first, vnb->ip.reass.fragment_last);
1887 if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
1889 bi = b->next_buffer;
1899 static clib_error_t *
1900 show_ip6_full_reass (vlib_main_t * vm, unformat_input_t * input,
1901 CLIB_UNUSED (vlib_cli_command_t * lmd))
1903 ip6_full_reass_main_t *rm = &ip6_full_reass_main;
1905 vlib_cli_output (vm, "---------------------");
1906 vlib_cli_output (vm, "IP6 reassembly status");
1907 vlib_cli_output (vm, "---------------------");
1908 bool details = false;
1909 if (unformat (input, "details"))
1914 u32 sum_reass_n = 0;
1915 u64 sum_buffers_n = 0;
1916 ip6_full_reass_t *reass;
1918 const uword nthreads = vlib_num_workers () + 1;
1919 for (thread_index = 0; thread_index < nthreads; ++thread_index)
1921 ip6_full_reass_per_thread_t *rt = &rm->per_thread_data[thread_index];
1922 clib_spinlock_lock (&rt->lock);
1925 pool_foreach (reass, rt->pool) {
1926 vlib_cli_output (vm, "%U", format_ip6_full_reass, vm, reass);
1929 sum_reass_n += rt->reass_n;
1930 clib_spinlock_unlock (&rt->lock);
1932 vlib_cli_output (vm, "---------------------");
1933 vlib_cli_output (vm, "Current IP6 reassemblies count: %lu\n",
1934 (long unsigned) sum_reass_n);
1935 vlib_cli_output (vm,
1936 "Maximum configured concurrent full IP6 reassemblies per worker-thread: %lu\n",
1937 (long unsigned) rm->max_reass_n);
1938 vlib_cli_output (vm,
1939 "Maximum configured amount of fragments "
1940 "per full IP6 reassembly: %lu\n",
1941 (long unsigned) rm->max_reass_len);
1942 vlib_cli_output (vm,
1943 "Maximum configured full IP6 reassembly timeout: %lums\n",
1944 (long unsigned) rm->timeout_ms);
1945 vlib_cli_output (vm,
1946 "Maximum configured full IP6 reassembly expire walk interval: %lums\n",
1947 (long unsigned) rm->expire_walk_interval_ms);
1948 vlib_cli_output (vm, "Buffers in use: %lu\n",
1949 (long unsigned) sum_buffers_n);
1953 VLIB_CLI_COMMAND (show_ip6_full_reassembly_cmd, static) = {
1954 .path = "show ip6-full-reassembly",
1955 .short_help = "show ip6-full-reassembly [details]",
1956 .function = show_ip6_full_reass,
1959 #ifndef CLIB_MARCH_VARIANT
1961 ip6_full_reass_enable_disable (u32 sw_if_index, u8 enable_disable)
1963 return vnet_feature_enable_disable ("ip6-unicast",
1964 "ip6-full-reassembly-feature",
1965 sw_if_index, enable_disable, 0, 0);
1967 #endif /* CLIB_MARCH_VARIANT */
1969 #define foreach_ip6_full_reassembly_handoff_error \
1970 _(CONGESTION_DROP, "congestion drop")
1975 #define _(sym,str) IP6_FULL_REASSEMBLY_HANDOFF_ERROR_##sym,
1976 foreach_ip6_full_reassembly_handoff_error
1978 IP6_FULL_REASSEMBLY_HANDOFF_N_ERROR,
1979 } ip6_full_reassembly_handoff_error_t;
1981 static char *ip6_full_reassembly_handoff_error_strings[] = {
1982 #define _(sym,string) string,
1983 foreach_ip6_full_reassembly_handoff_error
1989 u32 next_worker_index;
1990 } ip6_full_reassembly_handoff_trace_t;
1993 format_ip6_full_reassembly_handoff_trace (u8 * s, va_list * args)
1995 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
1996 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
1997 ip6_full_reassembly_handoff_trace_t *t =
1998 va_arg (*args, ip6_full_reassembly_handoff_trace_t *);
2001 format (s, "ip6-full-reassembly-handoff: next-worker %d",
2002 t->next_worker_index);
2008 ip6_full_reassembly_handoff_inline (vlib_main_t *vm, vlib_node_runtime_t *node,
2009 vlib_frame_t *frame,
2010 ip6_full_reass_node_type_t type,
2013 ip6_full_reass_main_t *rm = &ip6_full_reass_main;
2015 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
2016 u32 n_enq, n_left_from, *from;
2017 u16 thread_indices[VLIB_FRAME_SIZE], *ti;
2020 from = vlib_frame_vector_args (frame);
2021 n_left_from = frame->n_vectors;
2022 vlib_get_buffers (vm, from, bufs, n_left_from);
2025 ti = thread_indices;
2032 fq_index = rm->fq_local_index;
2036 fq_index = rm->fq_index;
2040 fq_index = rm->fq_feature_index;
2043 fq_index = rm->fq_custom_index;
2046 clib_warning ("Unexpected `type' (%d)!", type);
2049 while (n_left_from > 0)
2051 ti[0] = vnet_buffer (b[0])->ip.reass.owner_thread_index;
2054 ((node->flags & VLIB_NODE_FLAG_TRACE)
2055 && (b[0]->flags & VLIB_BUFFER_IS_TRACED)))
2057 ip6_full_reassembly_handoff_trace_t *t =
2058 vlib_add_trace (vm, node, b[0], sizeof (*t));
2059 t->next_worker_index = ti[0];
2066 n_enq = vlib_buffer_enqueue_to_thread (vm, node, fq_index, from,
2067 thread_indices, frame->n_vectors, 1);
2069 if (n_enq < frame->n_vectors)
2070 vlib_node_increment_counter (vm, node->node_index,
2071 IP6_FULL_REASSEMBLY_HANDOFF_ERROR_CONGESTION_DROP,
2072 frame->n_vectors - n_enq);
2073 return frame->n_vectors;
2076 VLIB_NODE_FN (ip6_full_reassembly_handoff_node) (vlib_main_t * vm,
2077 vlib_node_runtime_t * node,
2078 vlib_frame_t * frame)
2080 return ip6_full_reassembly_handoff_inline (vm, node, frame, NORMAL,
2081 false /* is_local */);
2084 VLIB_REGISTER_NODE (ip6_full_reassembly_handoff_node) = {
2085 .name = "ip6-full-reassembly-handoff",
2086 .vector_size = sizeof (u32),
2087 .n_errors = ARRAY_LEN(ip6_full_reassembly_handoff_error_strings),
2088 .error_strings = ip6_full_reassembly_handoff_error_strings,
2089 .format_trace = format_ip6_full_reassembly_handoff_trace,
2098 VLIB_NODE_FN (ip6_local_full_reassembly_handoff_node)
2099 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
2101 return ip6_full_reassembly_handoff_inline (vm, node, frame, NORMAL,
2102 true /* is_feature */);
2105 VLIB_REGISTER_NODE (ip6_local_full_reassembly_handoff_node) = {
2106 .name = "ip6-local-full-reassembly-handoff",
2107 .vector_size = sizeof (u32),
2108 .n_errors = ARRAY_LEN(ip6_full_reassembly_handoff_error_strings),
2109 .error_strings = ip6_full_reassembly_handoff_error_strings,
2110 .format_trace = format_ip6_full_reassembly_handoff_trace,
2119 VLIB_NODE_FN (ip6_full_reassembly_feature_handoff_node) (vlib_main_t * vm,
2120 vlib_node_runtime_t * node, vlib_frame_t * frame)
2122 return ip6_full_reassembly_handoff_inline (vm, node, frame, FEATURE,
2123 false /* is_local */);
2126 VLIB_REGISTER_NODE (ip6_full_reassembly_feature_handoff_node) = {
2127 .name = "ip6-full-reass-feature-hoff",
2128 .vector_size = sizeof (u32),
2129 .n_errors = ARRAY_LEN(ip6_full_reassembly_handoff_error_strings),
2130 .error_strings = ip6_full_reassembly_handoff_error_strings,
2131 .format_trace = format_ip6_full_reassembly_handoff_trace,
2140 VLIB_NODE_FN (ip6_full_reassembly_custom_handoff_node)
2141 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
2143 return ip6_full_reassembly_handoff_inline (vm, node, frame, CUSTOM,
2144 false /* is_local */);
2147 VLIB_REGISTER_NODE (ip6_full_reassembly_custom_handoff_node) = {
2148 .name = "ip6-full-reass-custom-hoff",
2149 .vector_size = sizeof (u32),
2150 .n_errors = ARRAY_LEN(ip6_full_reassembly_handoff_error_strings),
2151 .error_strings = ip6_full_reassembly_handoff_error_strings,
2152 .format_trace = format_ip6_full_reassembly_handoff_trace,
2161 #ifndef CLIB_MARCH_VARIANT
2163 ip6_full_reass_enable_disable_with_refcnt (u32 sw_if_index, int is_enable)
2165 ip6_full_reass_main_t *rm = &ip6_full_reass_main;
2166 vec_validate (rm->feature_use_refcount_per_intf, sw_if_index);
2169 if (!rm->feature_use_refcount_per_intf[sw_if_index])
2171 ++rm->feature_use_refcount_per_intf[sw_if_index];
2172 return vnet_feature_enable_disable ("ip6-unicast",
2173 "ip6-full-reassembly-feature",
2174 sw_if_index, 1, 0, 0);
2176 ++rm->feature_use_refcount_per_intf[sw_if_index];
2180 --rm->feature_use_refcount_per_intf[sw_if_index];
2181 if (!rm->feature_use_refcount_per_intf[sw_if_index])
2182 return vnet_feature_enable_disable ("ip6-unicast",
2183 "ip6-full-reassembly-feature",
2184 sw_if_index, 0, 0, 0);
2190 ip6_local_full_reass_enable_disable (int enable)
2194 if (!ip6_full_reass_main.is_local_reass_enabled)
2196 ip6_full_reass_main.is_local_reass_enabled = 1;
2197 ip6_register_protocol (IP_PROTOCOL_IPV6_FRAGMENTATION,
2198 ip6_local_full_reass_node.index);
2203 if (ip6_full_reass_main.is_local_reass_enabled)
2205 ip6_full_reass_main.is_local_reass_enabled = 0;
2206 ip6_unregister_protocol (IP_PROTOCOL_IPV6_FRAGMENTATION);
2212 ip6_local_full_reass_enabled ()
2214 return ip6_full_reass_main.is_local_reass_enabled;
2220 * fd.io coding-style-patch-verification: ON
2223 * eval: (c-set-style "gnu")