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 IPv4 Full Reassembly.
20 * This file contains the source code for IPv4 full reassembly.
23 #include <vppinfra/vec.h>
24 #include <vnet/vnet.h>
25 #include <vnet/ip/ip.h>
26 #include <vnet/ip/ip.api_enum.h>
27 #include <vppinfra/fifo.h>
28 #include <vppinfra/bihash_16_8.h>
29 #include <vnet/ip/reass/ip4_full_reass.h>
32 #define MSEC_PER_SEC 1000
33 #define IP4_REASS_TIMEOUT_DEFAULT_MS 200
35 /* As there are only 1024 reass context per thread, either the DDOS attacks
36 * or fractions of real timeouts, would consume these contexts quickly and
37 * running out context space and unable to perform reassembly */
38 #define IP4_REASS_EXPIRE_WALK_INTERVAL_DEFAULT_MS 50 // 50 ms default
39 #define IP4_REASS_MAX_REASSEMBLIES_DEFAULT 1024
40 #define IP4_REASS_MAX_REASSEMBLY_LENGTH_DEFAULT 3
41 #define IP4_REASS_HT_LOAD_FACTOR (0.75)
43 #define IP4_REASS_DEBUG_BUFFERS 0
44 #if IP4_REASS_DEBUG_BUFFERS
45 #define IP4_REASS_DEBUG_BUFFER(bi, what) \
49 printf (#what "buffer %u", _bi); \
50 vlib_buffer_t *_b = vlib_get_buffer (vm, _bi); \
51 while (_b->flags & VLIB_BUFFER_NEXT_PRESENT) \
53 _bi = _b->next_buffer; \
54 printf ("[%u]", _bi); \
55 _b = vlib_get_buffer (vm, _bi); \
62 #define IP4_REASS_DEBUG_BUFFER(...)
68 IP4_REASS_RC_TOO_MANY_FRAGMENTS,
69 IP4_REASS_RC_INTERNAL_ERROR,
72 } ip4_full_reass_rc_t;
85 } ip4_full_reass_key_t;
87 STATIC_ASSERT_SIZEOF (ip4_full_reass_key_t, 16);
94 u32 memory_owner_thread_index;
97 } ip4_full_reass_val_t;
103 ip4_full_reass_key_t k;
104 ip4_full_reass_val_t v;
106 clib_bihash_kv_16_8_t kv;
107 } ip4_full_reass_kv_t;
110 ip4_full_reass_buffer_get_data_offset (vlib_buffer_t * b)
112 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
113 return vnb->ip.reass.range_first - vnb->ip.reass.fragment_first;
117 ip4_full_reass_buffer_get_data_len (vlib_buffer_t * b)
119 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
120 return clib_min (vnb->ip.reass.range_last, vnb->ip.reass.fragment_last) -
121 (vnb->ip.reass.fragment_first +
122 ip4_full_reass_buffer_get_data_offset (b)) + 1;
128 ip4_full_reass_key_t key;
129 // time when last packet was received
131 // internal id of this reassembly
133 // buffer index of first buffer in this reassembly context
135 // last octet of packet, ~0 until fragment without more_fragments arrives
136 u32 last_packet_octet;
137 // length of data collected so far
139 // trace operation counter
140 u32 trace_op_counter;
141 // next index - used by non-feature node
143 // error next index - used by custom apps (~0 if not used)
144 u32 error_next_index;
145 // minimum fragment length for this reassembly - used to estimate MTU
146 u16 min_fragment_length;
147 // number of fragments in this reassembly
149 // thread owning memory for this context (whose pool contains this ctx)
150 u32 memory_owner_thread_index;
151 // thread which received fragment with offset 0 and which sends out the
152 // completed reassembly
153 u32 sendout_thread_index;
158 ip4_full_reass_t *pool;
161 // for pacing the main thread timeouts
163 clib_spinlock_t lock;
164 } ip4_full_reass_per_thread_t;
171 u32 expire_walk_interval_ms;
172 // maximum number of fragments in one reassembly
174 // maximum number of reassemblies
178 clib_bihash_16_8_t hash;
180 ip4_full_reass_per_thread_t *per_thread_data;
183 vlib_main_t *vlib_main;
185 u32 ip4_full_reass_expire_node_idx;
187 /** Worker handoff */
190 u32 fq_feature_index;
193 // reference count for enabling/disabling feature - per interface
194 u32 *feature_use_refcount_per_intf;
196 // whether local fragmented packets are reassembled or not
197 int is_local_reass_enabled;
198 } ip4_full_reass_main_t;
200 extern ip4_full_reass_main_t ip4_full_reass_main;
202 #ifndef CLIB_MARCH_VARIANT
203 ip4_full_reass_main_t ip4_full_reass_main;
204 #endif /* CLIB_MARCH_VARIANT */
208 IP4_FULL_REASS_NEXT_INPUT,
209 IP4_FULL_REASS_NEXT_DROP,
210 IP4_FULL_REASS_NEXT_HANDOFF,
211 IP4_FULL_REASS_N_NEXT,
212 } ip4_full_reass_next_t;
219 } ip4_full_reass_node_type_t;
230 } ip4_full_reass_trace_operation_e;
240 } ip4_full_reass_range_trace_t;
244 ip4_full_reass_trace_operation_e action;
246 ip4_full_reass_range_trace_t trace_range;
254 bool is_after_handoff;
255 ip4_header_t ip4_header;
256 } ip4_full_reass_trace_t;
258 extern vlib_node_registration_t ip4_full_reass_node;
259 extern vlib_node_registration_t ip4_full_reass_node_feature;
260 extern vlib_node_registration_t ip4_full_reass_node_custom;
263 ip4_full_reass_trace_details (vlib_main_t * vm, u32 bi,
264 ip4_full_reass_range_trace_t * trace)
266 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
267 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
268 trace->range_first = vnb->ip.reass.range_first;
269 trace->range_last = vnb->ip.reass.range_last;
270 trace->data_offset = ip4_full_reass_buffer_get_data_offset (b);
271 trace->data_len = ip4_full_reass_buffer_get_data_len (b);
272 trace->range_bi = bi;
276 format_ip4_full_reass_range_trace (u8 * s, va_list * args)
278 ip4_full_reass_range_trace_t *trace =
279 va_arg (*args, ip4_full_reass_range_trace_t *);
281 format (s, "range: [%u, %u], off %d, len %u, bi %u", trace->range_first,
282 trace->range_last, trace->data_offset, trace->data_len,
288 format_ip4_full_reass_trace (u8 * s, va_list * args)
290 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
291 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
292 ip4_full_reass_trace_t *t = va_arg (*args, ip4_full_reass_trace_t *);
294 if (~0 != t->reass_id)
296 if (t->is_after_handoff)
299 format (s, "%U\n", format_ip4_header, &t->ip4_header,
300 sizeof (t->ip4_header));
304 format (s, "%Ureass id: %u, op id: %u, ", format_white_space, indent,
305 t->reass_id, t->op_id);
306 indent = format_get_indent (s);
309 "first bi: %u, data len: %u, ip/fragment[%u, %u]",
310 t->trace_range.first_bi, t->total_data_len, t->fragment_first,
316 s = format (s, "\n%Ushrink %U by %u", format_white_space, indent,
317 format_ip4_full_reass_range_trace, &t->trace_range,
321 s = format (s, "\n%Udiscard %U", format_white_space, indent,
322 format_ip4_full_reass_range_trace, &t->trace_range);
325 s = format (s, "\n%Unew %U", format_white_space, indent,
326 format_ip4_full_reass_range_trace, &t->trace_range);
329 s = format (s, "\n%Uoverlapping/ignored %U", format_white_space, indent,
330 format_ip4_full_reass_range_trace, &t->trace_range);
333 s = format (s, "\n%Ufinalize reassembly", format_white_space, indent);
337 format (s, "handoff from thread #%u to thread #%u", t->thread_id,
341 s = format (s, "passthrough - not a fragment");
348 ip4_full_reass_add_trace (vlib_main_t * vm, vlib_node_runtime_t * node,
349 ip4_full_reass_t * reass, u32 bi,
350 ip4_full_reass_trace_operation_e action,
351 u32 size_diff, u32 thread_id_to)
353 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
354 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
355 if (pool_is_free_index
356 (vm->trace_main.trace_buffer_pool, vlib_buffer_get_trace_index (b)))
358 // this buffer's trace is gone
359 b->flags &= ~VLIB_BUFFER_IS_TRACED;
362 bool is_after_handoff = false;
363 if (vlib_buffer_get_trace_thread (b) != vm->thread_index)
365 is_after_handoff = true;
367 ip4_full_reass_trace_t *t = vlib_add_trace (vm, node, b, sizeof (t[0]));
368 t->is_after_handoff = is_after_handoff;
369 if (t->is_after_handoff)
371 clib_memcpy (&t->ip4_header, vlib_buffer_get_current (b),
372 clib_min (sizeof (t->ip4_header), b->current_length));
376 t->reass_id = reass->id;
377 t->op_id = reass->trace_op_counter;
378 t->trace_range.first_bi = reass->first_bi;
379 t->total_data_len = reass->data_len;
380 ++reass->trace_op_counter;
386 t->trace_range.first_bi = 0;
387 t->total_data_len = 0;
390 ip4_full_reass_trace_details (vm, bi, &t->trace_range);
391 t->size_diff = size_diff;
392 t->thread_id = vm->thread_index;
393 t->thread_id_to = thread_id_to;
394 t->fragment_first = vnb->ip.reass.fragment_first;
395 t->fragment_last = vnb->ip.reass.fragment_last;
398 s = format (s, "%U", format_ip4_full_reass_trace, NULL, NULL, t);
399 printf ("%.*s\n", vec_len (s), s);
401 vec_reset_length (s);
406 ip4_full_reass_free_ctx (ip4_full_reass_per_thread_t * rt,
407 ip4_full_reass_t * reass)
409 pool_put (rt->pool, reass);
414 ip4_full_reass_free (ip4_full_reass_main_t * rm,
415 ip4_full_reass_per_thread_t * rt,
416 ip4_full_reass_t * reass)
418 clib_bihash_kv_16_8_t kv = {};
419 clib_memcpy_fast (&kv, &reass->key, sizeof (kv.key));
420 clib_bihash_add_del_16_8 (&rm->hash, &kv, 0);
421 return ip4_full_reass_free_ctx (rt, reass);
424 /* n_left_to_next, and to_next are taken as input params, as this function
425 * could be called from a graphnode, where its managing local copy of these
426 * variables, and ignoring those and still trying to enqueue the buffers
427 * with local variables would cause either buffer leak or corruption */
429 ip4_full_reass_drop_all (vlib_main_t *vm, vlib_node_runtime_t *node,
430 ip4_full_reass_t *reass)
432 u32 range_bi = reass->first_bi;
433 vlib_buffer_t *range_b;
434 vnet_buffer_opaque_t *range_vnb;
437 while (~0 != range_bi)
439 range_b = vlib_get_buffer (vm, range_bi);
440 range_vnb = vnet_buffer (range_b);
444 vec_add1 (to_free, range_bi);
447 range_bi = range_vnb->ip.reass.next_range_bi;
450 /* send to next_error_index */
451 if (~0 != reass->error_next_index &&
452 reass->error_next_index < node->n_next_nodes)
454 u32 n_free = vec_len (to_free);
456 /* record number of packets sent to custom app */
457 vlib_node_increment_counter (vm, node->node_index,
458 IP4_ERROR_REASS_TO_CUSTOM_APP, n_free);
460 if (node->flags & VLIB_NODE_FLAG_TRACE)
461 for (u32 i = 0; i < n_free; i++)
463 vlib_buffer_t *b = vlib_get_buffer (vm, to_free[i]);
464 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
465 ip4_full_reass_add_trace (vm, node, reass, to_free[i],
466 RANGE_DISCARD, 0, ~0);
469 vlib_buffer_enqueue_to_single_next (vm, node, to_free,
470 reass->error_next_index, n_free);
474 vlib_buffer_free (vm, to_free, vec_len (to_free));
480 sanitize_reass_buffers_add_missing (vlib_main_t *vm, ip4_full_reass_t *reass,
483 u32 range_bi = reass->first_bi;
484 vlib_buffer_t *range_b;
485 vnet_buffer_opaque_t *range_vnb;
487 while (~0 != range_bi)
489 range_b = vlib_get_buffer (vm, range_bi);
490 range_vnb = vnet_buffer (range_b);
496 if (range_b->flags & VLIB_BUFFER_NEXT_PRESENT)
499 vlib_buffer_t *_b = vlib_get_buffer (vm, _bi);
500 while (_b->flags & VLIB_BUFFER_NEXT_PRESENT)
502 if (_b->next_buffer != range_vnb->ip.reass.next_range_bi)
504 _bi = _b->next_buffer;
505 _b = vlib_get_buffer (vm, _bi);
509 _b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
514 range_bi = range_vnb->ip.reass.next_range_bi;
519 vlib_buffer_t *fb = vlib_get_buffer (vm, *bi0);
520 vnet_buffer_opaque_t *fvnb = vnet_buffer (fb);
521 if (~0 != reass->first_bi)
523 fvnb->ip.reass.next_range_bi = reass->first_bi;
524 reass->first_bi = *bi0;
528 reass->first_bi = *bi0;
529 fvnb->ip.reass.next_range_bi = ~0;
536 ip4_full_reass_init (ip4_full_reass_t * reass)
538 reass->first_bi = ~0;
539 reass->last_packet_octet = ~0;
541 reass->next_index = ~0;
542 reass->error_next_index = ~0;
545 always_inline ip4_full_reass_t *
546 ip4_full_reass_find_or_create (vlib_main_t *vm, vlib_node_runtime_t *node,
547 ip4_full_reass_main_t *rm,
548 ip4_full_reass_per_thread_t *rt,
549 ip4_full_reass_kv_t *kv, u8 *do_handoff)
551 ip4_full_reass_t *reass;
557 now = vlib_time_now (vm);
558 if (!clib_bihash_search_16_8 (&rm->hash, &kv->kv, &kv->kv))
560 if (vm->thread_index != kv->v.memory_owner_thread_index)
566 pool_elt_at_index (rm->per_thread_data
567 [kv->v.memory_owner_thread_index].pool,
570 if (now > reass->last_heard + rm->timeout)
572 vlib_node_increment_counter (vm, node->node_index,
573 IP4_ERROR_REASS_TIMEOUT, 1);
574 ip4_full_reass_drop_all (vm, node, reass);
575 ip4_full_reass_free (rm, rt, reass);
582 reass->last_heard = now;
586 if (rt->reass_n >= rm->max_reass_n)
593 pool_get (rt->pool, reass);
594 clib_memset (reass, 0, sizeof (*reass));
595 reass->id = ((u64) vm->thread_index * 1000000000) + rt->id_counter;
596 reass->memory_owner_thread_index = vm->thread_index;
598 ip4_full_reass_init (reass);
602 clib_memcpy_fast (&reass->key, &kv->kv.key, sizeof (reass->key));
603 kv->v.reass_index = (reass - rt->pool);
604 kv->v.memory_owner_thread_index = vm->thread_index;
605 reass->last_heard = now;
607 int rv = clib_bihash_add_del_16_8 (&rm->hash, &kv->kv, 2);
610 ip4_full_reass_free_ctx (rt, reass);
612 // if other worker created a context already work with the other copy
620 always_inline ip4_full_reass_rc_t
621 ip4_full_reass_finalize (vlib_main_t * vm, vlib_node_runtime_t * node,
622 ip4_full_reass_main_t * rm,
623 ip4_full_reass_per_thread_t * rt,
624 ip4_full_reass_t * reass, u32 * bi0,
625 u32 * next0, u32 * error0, bool is_custom)
627 vlib_buffer_t *first_b = vlib_get_buffer (vm, reass->first_bi);
628 vlib_buffer_t *last_b = NULL;
629 u32 sub_chain_bi = reass->first_bi;
630 u32 total_length = 0;
633 u32 tmp_bi = sub_chain_bi;
634 vlib_buffer_t *tmp = vlib_get_buffer (vm, tmp_bi);
635 ip4_header_t *ip = vlib_buffer_get_current (tmp);
636 vnet_buffer_opaque_t *vnb = vnet_buffer (tmp);
637 if (!(vnb->ip.reass.range_first >= vnb->ip.reass.fragment_first) &&
638 !(vnb->ip.reass.range_last > vnb->ip.reass.fragment_first))
640 return IP4_REASS_RC_INTERNAL_ERROR;
643 u32 data_len = ip4_full_reass_buffer_get_data_len (tmp);
645 ip4_header_bytes (ip) + ip4_full_reass_buffer_get_data_offset (tmp);
647 vlib_buffer_length_in_chain (vm, tmp) - trim_front - data_len;
648 if (tmp_bi == reass->first_bi)
650 /* first buffer - keep ip4 header */
651 if (0 != ip4_full_reass_buffer_get_data_offset (tmp))
653 return IP4_REASS_RC_INTERNAL_ERROR;
656 trim_end = vlib_buffer_length_in_chain (vm, tmp) - data_len -
657 ip4_header_bytes (ip);
658 if (!(vlib_buffer_length_in_chain (vm, tmp) - trim_end > 0))
660 return IP4_REASS_RC_INTERNAL_ERROR;
664 vlib_buffer_length_in_chain (vm, tmp) - trim_front - trim_end;
669 if (trim_front > tmp->current_length)
671 /* drop whole buffer */
672 u32 to_be_freed_bi = tmp_bi;
673 trim_front -= tmp->current_length;
674 if (!(tmp->flags & VLIB_BUFFER_NEXT_PRESENT))
676 return IP4_REASS_RC_INTERNAL_ERROR;
678 tmp->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
679 tmp_bi = tmp->next_buffer;
680 tmp->next_buffer = 0;
681 tmp = vlib_get_buffer (vm, tmp_bi);
682 vlib_buffer_free_one (vm, to_be_freed_bi);
687 vlib_buffer_advance (tmp, trim_front);
695 last_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
696 last_b->next_buffer = tmp_bi;
699 if (keep_data <= tmp->current_length)
701 tmp->current_length = keep_data;
706 keep_data -= tmp->current_length;
707 if (!(tmp->flags & VLIB_BUFFER_NEXT_PRESENT))
709 return IP4_REASS_RC_INTERNAL_ERROR;
712 total_length += tmp->current_length;
713 if (tmp->flags & VLIB_BUFFER_NEXT_PRESENT)
715 tmp_bi = tmp->next_buffer;
716 tmp = vlib_get_buffer (vm, tmp->next_buffer);
725 u32 to_be_freed_bi = tmp_bi;
726 if (reass->first_bi == tmp_bi)
728 return IP4_REASS_RC_INTERNAL_ERROR;
730 if (tmp->flags & VLIB_BUFFER_NEXT_PRESENT)
732 tmp->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
733 tmp_bi = tmp->next_buffer;
734 tmp->next_buffer = 0;
735 tmp = vlib_get_buffer (vm, tmp_bi);
736 vlib_buffer_free_one (vm, to_be_freed_bi);
740 tmp->next_buffer = 0;
741 vlib_buffer_free_one (vm, to_be_freed_bi);
747 vnet_buffer (vlib_get_buffer (vm, sub_chain_bi))->ip.
750 while (~0 != sub_chain_bi);
754 return IP4_REASS_RC_INTERNAL_ERROR;
756 last_b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
758 if (total_length < first_b->current_length)
760 return IP4_REASS_RC_INTERNAL_ERROR;
762 total_length -= first_b->current_length;
763 first_b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
764 first_b->total_length_not_including_first_buffer = total_length;
765 ip4_header_t *ip = vlib_buffer_get_current (first_b);
766 ip->flags_and_fragment_offset = 0;
767 ip->length = clib_host_to_net_u16 (first_b->current_length + total_length);
768 ip->checksum = ip4_header_checksum (ip);
769 if (!vlib_buffer_chain_linearize (vm, first_b))
771 return IP4_REASS_RC_NO_BUF;
773 // reset to reconstruct the mbuf linking
774 first_b->flags &= ~VLIB_BUFFER_EXT_HDR_VALID;
775 if (PREDICT_FALSE (first_b->flags & VLIB_BUFFER_IS_TRACED))
777 ip4_full_reass_add_trace (vm, node, reass, reass->first_bi, FINALIZE, 0,
780 // following code does a hexdump of packet fragments to stdout ...
783 u32 bi = reass->first_bi;
787 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
788 s = format (s, "%u: %U\n", bi, format_hexdump,
789 vlib_buffer_get_current (b), b->current_length);
790 if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
799 printf ("%.*s\n", vec_len (s), s);
806 *bi0 = reass->first_bi;
809 *next0 = IP4_FULL_REASS_NEXT_INPUT;
813 *next0 = reass->next_index;
815 vnet_buffer (first_b)->ip.reass.estimated_mtu = reass->min_fragment_length;
817 /* Keep track of number of successfully reassembled packets and number of
818 * fragments reassembled */
819 vlib_node_increment_counter (vm, node->node_index, IP4_ERROR_REASS_SUCCESS,
822 vlib_node_increment_counter (vm, node->node_index,
823 IP4_ERROR_REASS_FRAGMENTS_REASSEMBLED,
826 *error0 = IP4_ERROR_NONE;
827 ip4_full_reass_free (rm, rt, reass);
829 return IP4_REASS_RC_OK;
832 always_inline ip4_full_reass_rc_t
833 ip4_full_reass_insert_range_in_chain (vlib_main_t * vm,
834 ip4_full_reass_t * reass,
835 u32 prev_range_bi, u32 new_next_bi)
837 vlib_buffer_t *new_next_b = vlib_get_buffer (vm, new_next_bi);
838 vnet_buffer_opaque_t *new_next_vnb = vnet_buffer (new_next_b);
839 if (~0 != prev_range_bi)
841 vlib_buffer_t *prev_b = vlib_get_buffer (vm, prev_range_bi);
842 vnet_buffer_opaque_t *prev_vnb = vnet_buffer (prev_b);
843 new_next_vnb->ip.reass.next_range_bi = prev_vnb->ip.reass.next_range_bi;
844 prev_vnb->ip.reass.next_range_bi = new_next_bi;
848 if (~0 != reass->first_bi)
850 new_next_vnb->ip.reass.next_range_bi = reass->first_bi;
852 reass->first_bi = new_next_bi;
854 vnet_buffer_opaque_t *vnb = vnet_buffer (new_next_b);
855 if (!(vnb->ip.reass.range_first >= vnb->ip.reass.fragment_first) &&
856 !(vnb->ip.reass.range_last > vnb->ip.reass.fragment_first))
858 return IP4_REASS_RC_INTERNAL_ERROR;
860 reass->data_len += ip4_full_reass_buffer_get_data_len (new_next_b);
861 return IP4_REASS_RC_OK;
864 always_inline ip4_full_reass_rc_t
865 ip4_full_reass_remove_range_from_chain (vlib_main_t * vm,
866 vlib_node_runtime_t * node,
867 ip4_full_reass_t * reass,
868 u32 prev_range_bi, u32 discard_bi)
870 vlib_buffer_t *discard_b = vlib_get_buffer (vm, discard_bi);
871 vnet_buffer_opaque_t *discard_vnb = vnet_buffer (discard_b);
872 if (~0 != prev_range_bi)
874 vlib_buffer_t *prev_b = vlib_get_buffer (vm, prev_range_bi);
875 vnet_buffer_opaque_t *prev_vnb = vnet_buffer (prev_b);
876 if (!(prev_vnb->ip.reass.next_range_bi == discard_bi))
878 return IP4_REASS_RC_INTERNAL_ERROR;
880 prev_vnb->ip.reass.next_range_bi = discard_vnb->ip.reass.next_range_bi;
884 reass->first_bi = discard_vnb->ip.reass.next_range_bi;
886 vnet_buffer_opaque_t *vnb = vnet_buffer (discard_b);
887 if (!(vnb->ip.reass.range_first >= vnb->ip.reass.fragment_first) &&
888 !(vnb->ip.reass.range_last > vnb->ip.reass.fragment_first))
890 return IP4_REASS_RC_INTERNAL_ERROR;
892 reass->data_len -= ip4_full_reass_buffer_get_data_len (discard_b);
895 u32 to_be_freed_bi = discard_bi;
896 if (PREDICT_FALSE (discard_b->flags & VLIB_BUFFER_IS_TRACED))
898 ip4_full_reass_add_trace (vm, node, reass, discard_bi, RANGE_DISCARD,
901 if (discard_b->flags & VLIB_BUFFER_NEXT_PRESENT)
903 discard_b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
904 discard_bi = discard_b->next_buffer;
905 discard_b->next_buffer = 0;
906 discard_b = vlib_get_buffer (vm, discard_bi);
907 vlib_buffer_free_one (vm, to_be_freed_bi);
911 discard_b->next_buffer = 0;
912 vlib_buffer_free_one (vm, to_be_freed_bi);
916 return IP4_REASS_RC_OK;
919 always_inline ip4_full_reass_rc_t
920 ip4_full_reass_update (vlib_main_t * vm, vlib_node_runtime_t * node,
921 ip4_full_reass_main_t * rm,
922 ip4_full_reass_per_thread_t * rt,
923 ip4_full_reass_t * reass, u32 * bi0, u32 * next0,
924 u32 * error0, bool is_custom, u32 * handoff_thread_idx)
926 vlib_buffer_t *fb = vlib_get_buffer (vm, *bi0);
927 vnet_buffer_opaque_t *fvnb = vnet_buffer (fb);
930 // store (error_)next_index before it's overwritten
931 reass->next_index = fvnb->ip.reass.next_index;
932 reass->error_next_index = fvnb->ip.reass.error_next_index;
934 ip4_full_reass_rc_t rc = IP4_REASS_RC_OK;
936 ip4_header_t *fip = vlib_buffer_get_current (fb);
937 const u32 fragment_first = ip4_get_fragment_offset_bytes (fip);
938 const u32 fragment_length =
939 clib_net_to_host_u16 (fip->length) - ip4_header_bytes (fip);
940 const u32 fragment_last = fragment_first + fragment_length - 1;
941 fvnb->ip.reass.fragment_first = fragment_first;
942 fvnb->ip.reass.fragment_last = fragment_last;
943 int more_fragments = ip4_get_fragment_more (fip);
944 u32 candidate_range_bi = reass->first_bi;
945 u32 prev_range_bi = ~0;
946 fvnb->ip.reass.range_first = fragment_first;
947 fvnb->ip.reass.range_last = fragment_last;
948 fvnb->ip.reass.next_range_bi = ~0;
951 reass->last_packet_octet = fragment_last;
953 if (~0 == reass->first_bi)
955 // starting a new reassembly
957 ip4_full_reass_insert_range_in_chain (vm, reass, prev_range_bi, *bi0);
958 if (IP4_REASS_RC_OK != rc)
962 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
964 ip4_full_reass_add_trace (vm, node, reass, *bi0, RANGE_NEW, 0, ~0);
967 reass->min_fragment_length = clib_net_to_host_u16 (fip->length);
968 reass->fragments_n = 1;
969 return IP4_REASS_RC_OK;
971 reass->min_fragment_length =
972 clib_min (clib_net_to_host_u16 (fip->length),
973 fvnb->ip.reass.estimated_mtu);
974 while (~0 != candidate_range_bi)
976 vlib_buffer_t *candidate_b = vlib_get_buffer (vm, candidate_range_bi);
977 vnet_buffer_opaque_t *candidate_vnb = vnet_buffer (candidate_b);
978 if (fragment_first > candidate_vnb->ip.reass.range_last)
980 // this fragments starts after candidate range
981 prev_range_bi = candidate_range_bi;
982 candidate_range_bi = candidate_vnb->ip.reass.next_range_bi;
983 if (candidate_vnb->ip.reass.range_last < fragment_last &&
984 ~0 == candidate_range_bi)
986 // special case - this fragment falls beyond all known ranges
987 rc = ip4_full_reass_insert_range_in_chain (vm, reass,
988 prev_range_bi, *bi0);
989 if (IP4_REASS_RC_OK != rc)
998 if (fragment_last < candidate_vnb->ip.reass.range_first)
1000 // this fragment ends before candidate range without any overlap
1001 rc = ip4_full_reass_insert_range_in_chain (vm, reass, prev_range_bi,
1003 if (IP4_REASS_RC_OK != rc)
1011 if (fragment_first >= candidate_vnb->ip.reass.range_first &&
1012 fragment_last <= candidate_vnb->ip.reass.range_last)
1014 // this fragment is a (sub)part of existing range, ignore it
1015 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
1017 ip4_full_reass_add_trace (vm, node, reass, *bi0,
1018 RANGE_OVERLAP, 0, ~0);
1022 int discard_candidate = 0;
1023 if (fragment_first < candidate_vnb->ip.reass.range_first)
1026 fragment_last - candidate_vnb->ip.reass.range_first + 1;
1027 if (overlap < ip4_full_reass_buffer_get_data_len (candidate_b))
1029 candidate_vnb->ip.reass.range_first += overlap;
1030 if (reass->data_len < overlap)
1032 return IP4_REASS_RC_INTERNAL_ERROR;
1034 reass->data_len -= overlap;
1035 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
1037 ip4_full_reass_add_trace (vm, node, reass,
1039 RANGE_SHRINK, 0, ~0);
1041 rc = ip4_full_reass_insert_range_in_chain (
1042 vm, reass, prev_range_bi, *bi0);
1043 if (IP4_REASS_RC_OK != rc)
1051 discard_candidate = 1;
1054 else if (fragment_last > candidate_vnb->ip.reass.range_last)
1057 candidate_vnb->ip.reass.range_last - fragment_first + 1;
1058 if (overlap < ip4_full_reass_buffer_get_data_len (candidate_b))
1060 fvnb->ip.reass.range_first += overlap;
1061 if (~0 != candidate_vnb->ip.reass.next_range_bi)
1063 prev_range_bi = candidate_range_bi;
1064 candidate_range_bi =
1065 candidate_vnb->ip.reass.next_range_bi;
1070 // special case - last range discarded
1071 rc = ip4_full_reass_insert_range_in_chain (
1072 vm, reass, candidate_range_bi, *bi0);
1073 if (IP4_REASS_RC_OK != rc)
1082 discard_candidate = 1;
1087 discard_candidate = 1;
1089 if (discard_candidate)
1091 u32 next_range_bi = candidate_vnb->ip.reass.next_range_bi;
1092 // discard candidate range, probe next range
1093 rc = ip4_full_reass_remove_range_from_chain (
1094 vm, node, reass, prev_range_bi, candidate_range_bi);
1095 if (IP4_REASS_RC_OK != rc)
1099 if (~0 != next_range_bi)
1101 candidate_range_bi = next_range_bi;
1106 // special case - last range discarded
1107 rc = ip4_full_reass_insert_range_in_chain (
1108 vm, reass, prev_range_bi, *bi0);
1109 if (IP4_REASS_RC_OK != rc)
1119 ++reass->fragments_n;
1122 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
1124 ip4_full_reass_add_trace (vm, node, reass, *bi0, RANGE_NEW, 0, ~0);
1127 if (~0 != reass->last_packet_octet &&
1128 reass->data_len == reass->last_packet_octet + 1)
1130 *handoff_thread_idx = reass->sendout_thread_index;
1132 reass->memory_owner_thread_index != reass->sendout_thread_index;
1134 ip4_full_reass_finalize (vm, node, rm, rt, reass, bi0, next0, error0,
1136 if (IP4_REASS_RC_OK == rc && handoff)
1138 rc = IP4_REASS_RC_HANDOFF;
1146 if (reass->fragments_n > rm->max_reass_len)
1148 rc = IP4_REASS_RC_TOO_MANY_FRAGMENTS;
1153 *next0 = IP4_FULL_REASS_NEXT_DROP;
1154 *error0 = IP4_ERROR_REASS_DUPLICATE_FRAGMENT;
1161 ip4_full_reass_inline (vlib_main_t *vm, vlib_node_runtime_t *node,
1162 vlib_frame_t *frame, ip4_full_reass_node_type_t type,
1165 u32 *from = vlib_frame_vector_args (frame);
1166 u32 n_left, n_next = 0, to_next[VLIB_FRAME_SIZE];
1167 ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1168 ip4_full_reass_per_thread_t *rt = &rm->per_thread_data[vm->thread_index];
1169 u16 nexts[VLIB_FRAME_SIZE];
1171 clib_spinlock_lock (&rt->lock);
1173 n_left = frame->n_vectors;
1179 u32 error0 = IP4_ERROR_NONE;
1182 b0 = vlib_get_buffer (vm, bi0);
1184 ip4_header_t *ip0 = vlib_buffer_get_current (b0);
1185 if (!ip4_get_fragment_more (ip0) && !ip4_get_fragment_offset (ip0))
1187 // this is a whole packet - no fragmentation
1190 next0 = IP4_FULL_REASS_NEXT_INPUT;
1194 next0 = vnet_buffer (b0)->ip.reass.next_index;
1196 ip4_full_reass_add_trace (vm, node, NULL, bi0, PASSTHROUGH, 0, ~0);
1197 goto packet_enqueue;
1200 if (is_local && !rm->is_local_reass_enabled)
1202 next0 = IP4_FULL_REASS_NEXT_DROP;
1203 goto packet_enqueue;
1206 const u32 fragment_first = ip4_get_fragment_offset_bytes (ip0);
1207 const u32 fragment_length =
1208 clib_net_to_host_u16 (ip0->length) - ip4_header_bytes (ip0);
1209 const u32 fragment_last = fragment_first + fragment_length - 1;
1211 /* Keep track of received fragments */
1212 vlib_node_increment_counter (vm, node->node_index,
1213 IP4_ERROR_REASS_FRAGMENTS_RCVD, 1);
1215 if (fragment_first > fragment_last ||
1216 fragment_first + fragment_length > UINT16_MAX - 20 ||
1217 (fragment_length < 8 && // 8 is minimum frag length per RFC 791
1218 ip4_get_fragment_more (ip0)))
1220 next0 = IP4_FULL_REASS_NEXT_DROP;
1221 error0 = IP4_ERROR_REASS_MALFORMED_PACKET;
1222 goto packet_enqueue;
1225 u32 fib_index = (vnet_buffer (b0)->sw_if_index[VLIB_TX] == (u32) ~0) ?
1226 vec_elt (ip4_main.fib_index_by_sw_if_index,
1227 vnet_buffer (b0)->sw_if_index[VLIB_RX]) :
1228 vnet_buffer (b0)->sw_if_index[VLIB_TX];
1230 ip4_full_reass_kv_t kv = { .k.fib_index = fib_index,
1231 .k.src.as_u32 = ip0->src_address.as_u32,
1232 .k.dst.as_u32 = ip0->dst_address.as_u32,
1233 .k.frag_id = ip0->fragment_id,
1234 .k.proto = ip0->protocol
1239 ip4_full_reass_t *reass =
1240 ip4_full_reass_find_or_create (vm, node, rm, rt, &kv, &do_handoff);
1244 const u32 fragment_first = ip4_get_fragment_offset_bytes (ip0);
1245 if (0 == fragment_first)
1247 reass->sendout_thread_index = vm->thread_index;
1251 if (PREDICT_FALSE (do_handoff))
1253 next0 = IP4_FULL_REASS_NEXT_HANDOFF;
1254 vnet_buffer (b0)->ip.reass.owner_thread_index =
1255 kv.v.memory_owner_thread_index;
1259 u32 handoff_thread_idx;
1261 switch (ip4_full_reass_update (vm, node, rm, rt, reass, &bi0, &next0,
1262 &error0, CUSTOM == type,
1263 &handoff_thread_idx))
1265 case IP4_REASS_RC_OK:
1266 /* nothing to do here */
1268 case IP4_REASS_RC_HANDOFF:
1269 next0 = IP4_FULL_REASS_NEXT_HANDOFF;
1270 b0 = vlib_get_buffer (vm, bi0);
1271 vnet_buffer (b0)->ip.reass.owner_thread_index =
1274 case IP4_REASS_RC_TOO_MANY_FRAGMENTS:
1275 counter = IP4_ERROR_REASS_FRAGMENT_CHAIN_TOO_LONG;
1277 case IP4_REASS_RC_NO_BUF:
1278 counter = IP4_ERROR_REASS_NO_BUF;
1280 case IP4_REASS_RC_INTERNAL_ERROR:
1281 counter = IP4_ERROR_REASS_INTERNAL_ERROR;
1282 /* Sanitization is needed in internal error cases only, as
1283 * the incoming packet is already dropped in other cases,
1284 * also adding bi0 back to the reassembly list, fixes the
1285 * leaking of buffers during internal errors.
1287 * Also it doesnt make sense to send these buffers custom
1288 * app, these fragments are with internal errors */
1289 sanitize_reass_buffers_add_missing (vm, reass, &bi0);
1290 reass->error_next_index = ~0;
1296 vlib_node_increment_counter (vm, node->node_index, counter, 1);
1297 ip4_full_reass_drop_all (vm, node, reass);
1298 ip4_full_reass_free (rm, rt, reass);
1304 next0 = IP4_FULL_REASS_NEXT_DROP;
1305 error0 = IP4_ERROR_REASS_LIMIT_REACHED;
1312 /* bi0 might have been updated by reass_finalize, reload */
1313 b0 = vlib_get_buffer (vm, bi0);
1314 if (IP4_ERROR_NONE != error0)
1316 b0->error = node->errors[error0];
1319 if (next0 == IP4_FULL_REASS_NEXT_HANDOFF)
1321 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
1323 ip4_full_reass_add_trace (
1324 vm, node, NULL, bi0, HANDOFF, 0,
1325 vnet_buffer (b0)->ip.reass.owner_thread_index);
1328 else if (FEATURE == type && IP4_ERROR_NONE == error0)
1330 vnet_feature_next (&next0, b0);
1333 /* Increment the counter to-custom-app also as this fragment is
1334 * also going to application */
1337 vlib_node_increment_counter (vm, node->node_index,
1338 IP4_ERROR_REASS_TO_CUSTOM_APP, 1);
1341 to_next[n_next] = bi0;
1342 nexts[n_next] = next0;
1344 IP4_REASS_DEBUG_BUFFER (bi0, enqueue_next);
1352 clib_spinlock_unlock (&rt->lock);
1354 vlib_buffer_enqueue_to_next (vm, node, to_next, nexts, n_next);
1355 return frame->n_vectors;
1358 VLIB_NODE_FN (ip4_full_reass_node) (vlib_main_t * vm,
1359 vlib_node_runtime_t * node,
1360 vlib_frame_t * frame)
1362 return ip4_full_reass_inline (vm, node, frame, NORMAL, false /* is_local */);
1365 VLIB_REGISTER_NODE (ip4_full_reass_node) = {
1366 .name = "ip4-full-reassembly",
1367 .vector_size = sizeof (u32),
1368 .format_trace = format_ip4_full_reass_trace,
1369 .n_errors = IP4_N_ERROR,
1370 .error_counters = ip4_error_counters,
1371 .n_next_nodes = IP4_FULL_REASS_N_NEXT,
1374 [IP4_FULL_REASS_NEXT_INPUT] = "ip4-input",
1375 [IP4_FULL_REASS_NEXT_DROP] = "ip4-drop",
1376 [IP4_FULL_REASS_NEXT_HANDOFF] = "ip4-full-reassembly-handoff",
1381 VLIB_NODE_FN (ip4_local_full_reass_node)
1382 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
1384 return ip4_full_reass_inline (vm, node, frame, NORMAL, true /* is_local */);
1387 VLIB_REGISTER_NODE (ip4_local_full_reass_node) = {
1388 .name = "ip4-local-full-reassembly",
1389 .vector_size = sizeof (u32),
1390 .format_trace = format_ip4_full_reass_trace,
1391 .n_errors = IP4_N_ERROR,
1392 .error_counters = ip4_error_counters,
1393 .n_next_nodes = IP4_FULL_REASS_N_NEXT,
1396 [IP4_FULL_REASS_NEXT_INPUT] = "ip4-input",
1397 [IP4_FULL_REASS_NEXT_DROP] = "ip4-drop",
1398 [IP4_FULL_REASS_NEXT_HANDOFF] = "ip4-local-full-reassembly-handoff",
1403 VLIB_NODE_FN (ip4_full_reass_node_feature) (vlib_main_t * vm,
1404 vlib_node_runtime_t * node,
1405 vlib_frame_t * frame)
1407 return ip4_full_reass_inline (vm, node, frame, FEATURE,
1408 false /* is_local */);
1411 VLIB_REGISTER_NODE (ip4_full_reass_node_feature) = {
1412 .name = "ip4-full-reassembly-feature",
1413 .vector_size = sizeof (u32),
1414 .format_trace = format_ip4_full_reass_trace,
1415 .n_errors = IP4_N_ERROR,
1416 .error_counters = ip4_error_counters,
1417 .n_next_nodes = IP4_FULL_REASS_N_NEXT,
1420 [IP4_FULL_REASS_NEXT_INPUT] = "ip4-input",
1421 [IP4_FULL_REASS_NEXT_DROP] = "ip4-drop",
1422 [IP4_FULL_REASS_NEXT_HANDOFF] = "ip4-full-reass-feature-hoff",
1426 VNET_FEATURE_INIT (ip4_full_reass_feature, static) = {
1427 .arc_name = "ip4-unicast",
1428 .node_name = "ip4-full-reassembly-feature",
1429 .runs_before = VNET_FEATURES ("ip4-lookup", "ipsec4-input-feature",
1430 "ip4-sv-reassembly-feature"),
1434 VLIB_NODE_FN (ip4_full_reass_node_custom) (vlib_main_t * vm,
1435 vlib_node_runtime_t * node,
1436 vlib_frame_t * frame)
1438 return ip4_full_reass_inline (vm, node, frame, CUSTOM, false /* is_local */);
1441 VLIB_REGISTER_NODE (ip4_full_reass_node_custom) = {
1442 .name = "ip4-full-reassembly-custom",
1443 .vector_size = sizeof (u32),
1444 .format_trace = format_ip4_full_reass_trace,
1445 .n_errors = IP4_N_ERROR,
1446 .error_counters = ip4_error_counters,
1447 .n_next_nodes = IP4_FULL_REASS_N_NEXT,
1450 [IP4_FULL_REASS_NEXT_INPUT] = "ip4-input",
1451 [IP4_FULL_REASS_NEXT_DROP] = "ip4-drop",
1452 [IP4_FULL_REASS_NEXT_HANDOFF] = "ip4-full-reass-custom-hoff",
1456 #ifndef CLIB_MARCH_VARIANT
1458 ip4_full_reass_custom_register_next_node (uword node_index)
1460 return vlib_node_add_next (vlib_get_main (),
1461 ip4_full_reass_node_custom.index, node_index);
1465 ip4_full_reass_get_nbuckets ()
1467 ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1471 /* need more mem with more workers */
1472 nbuckets = (u32) (rm->max_reass_n * (vlib_num_workers () + 1) /
1473 IP4_REASS_HT_LOAD_FACTOR);
1475 for (i = 0; i < 31; i++)
1476 if ((1 << i) >= nbuckets)
1482 #endif /* CLIB_MARCH_VARIANT */
1486 IP4_EVENT_CONFIG_CHANGED = 1,
1487 } ip4_full_reass_event_t;
1492 clib_bihash_16_8_t *new_hash;
1493 } ip4_rehash_cb_ctx;
1495 #ifndef CLIB_MARCH_VARIANT
1497 ip4_rehash_cb (clib_bihash_kv_16_8_t * kv, void *_ctx)
1499 ip4_rehash_cb_ctx *ctx = _ctx;
1500 if (clib_bihash_add_del_16_8 (ctx->new_hash, kv, 1))
1504 return (BIHASH_WALK_CONTINUE);
1508 ip4_full_reass_set_params (u32 timeout_ms, u32 max_reassemblies,
1509 u32 max_reassembly_length,
1510 u32 expire_walk_interval_ms)
1512 ip4_full_reass_main.timeout_ms = timeout_ms;
1513 ip4_full_reass_main.timeout = (f64) timeout_ms / (f64) MSEC_PER_SEC;
1514 ip4_full_reass_main.max_reass_n = max_reassemblies;
1515 ip4_full_reass_main.max_reass_len = max_reassembly_length;
1516 ip4_full_reass_main.expire_walk_interval_ms = expire_walk_interval_ms;
1520 ip4_full_reass_set (u32 timeout_ms, u32 max_reassemblies,
1521 u32 max_reassembly_length, u32 expire_walk_interval_ms)
1523 u32 old_nbuckets = ip4_full_reass_get_nbuckets ();
1524 ip4_full_reass_set_params (timeout_ms, max_reassemblies,
1525 max_reassembly_length, expire_walk_interval_ms);
1526 vlib_process_signal_event (ip4_full_reass_main.vlib_main,
1527 ip4_full_reass_main.ip4_full_reass_expire_node_idx,
1528 IP4_EVENT_CONFIG_CHANGED, 0);
1529 u32 new_nbuckets = ip4_full_reass_get_nbuckets ();
1530 if (ip4_full_reass_main.max_reass_n > 0 && new_nbuckets > old_nbuckets)
1532 clib_bihash_16_8_t new_hash;
1533 clib_memset (&new_hash, 0, sizeof (new_hash));
1534 ip4_rehash_cb_ctx ctx;
1536 ctx.new_hash = &new_hash;
1537 clib_bihash_init_16_8 (&new_hash, "ip4-dr", new_nbuckets,
1538 new_nbuckets * 1024);
1539 clib_bihash_foreach_key_value_pair_16_8 (&ip4_full_reass_main.hash,
1540 ip4_rehash_cb, &ctx);
1543 clib_bihash_free_16_8 (&new_hash);
1548 clib_bihash_free_16_8 (&ip4_full_reass_main.hash);
1549 clib_memcpy_fast (&ip4_full_reass_main.hash, &new_hash,
1550 sizeof (ip4_full_reass_main.hash));
1551 clib_bihash_copied (&ip4_full_reass_main.hash, &new_hash);
1558 ip4_full_reass_get (u32 * timeout_ms, u32 * max_reassemblies,
1559 u32 * max_reassembly_length,
1560 u32 * expire_walk_interval_ms)
1562 *timeout_ms = ip4_full_reass_main.timeout_ms;
1563 *max_reassemblies = ip4_full_reass_main.max_reass_n;
1564 *max_reassembly_length = ip4_full_reass_main.max_reass_len;
1565 *expire_walk_interval_ms = ip4_full_reass_main.expire_walk_interval_ms;
1569 static clib_error_t *
1570 ip4_full_reass_init_function (vlib_main_t * vm)
1572 ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1573 clib_error_t *error = 0;
1579 vec_validate (rm->per_thread_data, vlib_num_workers ());
1580 ip4_full_reass_per_thread_t *rt;
1581 vec_foreach (rt, rm->per_thread_data)
1583 clib_spinlock_init (&rt->lock);
1584 pool_alloc (rt->pool, rm->max_reass_n);
1587 node = vlib_get_node_by_name (vm, (u8 *) "ip4-full-reassembly-expire-walk");
1589 rm->ip4_full_reass_expire_node_idx = node->index;
1591 ip4_full_reass_set_params (IP4_REASS_TIMEOUT_DEFAULT_MS,
1592 IP4_REASS_MAX_REASSEMBLIES_DEFAULT,
1593 IP4_REASS_MAX_REASSEMBLY_LENGTH_DEFAULT,
1594 IP4_REASS_EXPIRE_WALK_INTERVAL_DEFAULT_MS);
1596 nbuckets = ip4_full_reass_get_nbuckets ();
1597 clib_bihash_init_16_8 (&rm->hash, "ip4-dr", nbuckets, nbuckets * 1024);
1599 rm->fq_index = vlib_frame_queue_main_init (ip4_full_reass_node.index, 0);
1600 rm->fq_local_index =
1601 vlib_frame_queue_main_init (ip4_local_full_reass_node.index, 0);
1602 rm->fq_feature_index =
1603 vlib_frame_queue_main_init (ip4_full_reass_node_feature.index, 0);
1604 rm->fq_custom_index =
1605 vlib_frame_queue_main_init (ip4_full_reass_node_custom.index, 0);
1607 rm->feature_use_refcount_per_intf = NULL;
1608 rm->is_local_reass_enabled = 1;
1613 VLIB_INIT_FUNCTION (ip4_full_reass_init_function);
1614 #endif /* CLIB_MARCH_VARIANT */
1617 ip4_full_reass_walk_expired (vlib_main_t *vm, vlib_node_runtime_t *node,
1618 CLIB_UNUSED (vlib_frame_t *f))
1620 ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1621 uword event_type, *event_data = 0;
1625 vlib_process_wait_for_event_or_clock (vm,
1627 rm->expire_walk_interval_ms /
1628 (f64) MSEC_PER_SEC);
1629 event_type = vlib_process_get_events (vm, &event_data);
1634 /* no events => timeout */
1636 case IP4_EVENT_CONFIG_CHANGED:
1637 /* nothing to do here */
1640 clib_warning ("BUG: event type 0x%wx", event_type);
1643 f64 now = vlib_time_now (vm);
1645 ip4_full_reass_t *reass;
1646 int *pool_indexes_to_free = NULL;
1648 uword thread_index = 0;
1650 const uword nthreads = vlib_num_workers () + 1;
1652 for (thread_index = 0; thread_index < nthreads; ++thread_index)
1654 ip4_full_reass_per_thread_t *rt =
1655 &rm->per_thread_data[thread_index];
1656 clib_spinlock_lock (&rt->lock);
1658 vec_reset_length (pool_indexes_to_free);
1660 /* Pace the number of timeouts handled per thread,to avoid barrier
1661 * sync issues in real world scenarios */
1663 u32 beg = rt->last_id;
1664 /* to ensure we walk at least once per sec per context */
1666 beg + (IP4_REASS_MAX_REASSEMBLIES_DEFAULT *
1667 IP4_REASS_EXPIRE_WALK_INTERVAL_DEFAULT_MS / MSEC_PER_SEC +
1669 if (end > vec_len (rt->pool))
1671 end = vec_len (rt->pool);
1679 pool_foreach_stepping_index (index, beg, end, rt->pool)
1681 reass = pool_elt_at_index (rt->pool, index);
1682 if (now > reass->last_heard + rm->timeout)
1684 vec_add1 (pool_indexes_to_free, index);
1688 if (vec_len (pool_indexes_to_free))
1689 vlib_node_increment_counter (vm, node->node_index,
1690 IP4_ERROR_REASS_TIMEOUT,
1691 vec_len (pool_indexes_to_free));
1693 vec_foreach (i, pool_indexes_to_free)
1695 ip4_full_reass_t *reass = pool_elt_at_index (rt->pool, i[0]);
1696 ip4_full_reass_drop_all (vm, node, reass);
1697 ip4_full_reass_free (rm, rt, reass);
1700 clib_spinlock_unlock (&rt->lock);
1703 vec_free (pool_indexes_to_free);
1706 vec_set_len (event_data, 0);
1713 VLIB_REGISTER_NODE (ip4_full_reass_expire_node) = {
1714 .function = ip4_full_reass_walk_expired,
1715 .type = VLIB_NODE_TYPE_PROCESS,
1716 .name = "ip4-full-reassembly-expire-walk",
1717 .format_trace = format_ip4_full_reass_trace,
1718 .n_errors = IP4_N_ERROR,
1719 .error_counters = ip4_error_counters,
1723 format_ip4_full_reass_key (u8 * s, va_list * args)
1725 ip4_full_reass_key_t *key = va_arg (*args, ip4_full_reass_key_t *);
1727 format (s, "fib_index: %u, src: %U, dst: %U, frag_id: %u, proto: %u",
1728 key->fib_index, format_ip4_address, &key->src, format_ip4_address,
1729 &key->dst, clib_net_to_host_u16 (key->frag_id), key->proto);
1734 format_ip4_reass (u8 * s, va_list * args)
1736 vlib_main_t *vm = va_arg (*args, vlib_main_t *);
1737 ip4_full_reass_t *reass = va_arg (*args, ip4_full_reass_t *);
1739 s = format (s, "ID: %lu, key: %U\n first_bi: %u, data_len: %u, "
1740 "last_packet_octet: %u, trace_op_counter: %u\n",
1741 reass->id, format_ip4_full_reass_key, &reass->key,
1742 reass->first_bi, reass->data_len,
1743 reass->last_packet_octet, reass->trace_op_counter);
1745 u32 bi = reass->first_bi;
1749 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
1750 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
1753 " #%03u: range: [%u, %u], bi: %u, off: %d, len: %u, "
1754 "fragment[%u, %u]\n", counter, vnb->ip.reass.range_first,
1755 vnb->ip.reass.range_last, bi,
1756 ip4_full_reass_buffer_get_data_offset (b),
1757 ip4_full_reass_buffer_get_data_len (b),
1758 vnb->ip.reass.fragment_first, vnb->ip.reass.fragment_last);
1759 if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
1761 bi = b->next_buffer;
1771 static clib_error_t *
1772 show_ip4_reass (vlib_main_t * vm,
1773 unformat_input_t * input,
1774 CLIB_UNUSED (vlib_cli_command_t * lmd))
1776 ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1778 vlib_cli_output (vm, "---------------------");
1779 vlib_cli_output (vm, "IP4 reassembly status");
1780 vlib_cli_output (vm, "---------------------");
1781 bool details = false;
1782 if (unformat (input, "details"))
1787 u32 sum_reass_n = 0;
1788 ip4_full_reass_t *reass;
1790 const uword nthreads = vlib_num_workers () + 1;
1791 for (thread_index = 0; thread_index < nthreads; ++thread_index)
1793 ip4_full_reass_per_thread_t *rt = &rm->per_thread_data[thread_index];
1794 clib_spinlock_lock (&rt->lock);
1797 pool_foreach (reass, rt->pool) {
1798 vlib_cli_output (vm, "%U", format_ip4_reass, vm, reass);
1801 sum_reass_n += rt->reass_n;
1802 clib_spinlock_unlock (&rt->lock);
1804 vlib_cli_output (vm, "---------------------");
1805 vlib_cli_output (vm, "Current full IP4 reassemblies count: %lu\n",
1806 (long unsigned) sum_reass_n);
1807 vlib_cli_output (vm,
1808 "Maximum configured concurrent full IP4 reassemblies per worker-thread: %lu\n",
1809 (long unsigned) rm->max_reass_n);
1810 vlib_cli_output (vm,
1811 "Maximum configured amount of fragments "
1812 "per full IP4 reassembly: %lu\n",
1813 (long unsigned) rm->max_reass_len);
1814 vlib_cli_output (vm,
1815 "Maximum configured full IP4 reassembly timeout: %lums\n",
1816 (long unsigned) rm->timeout_ms);
1817 vlib_cli_output (vm,
1818 "Maximum configured full IP4 reassembly expire walk interval: %lums\n",
1819 (long unsigned) rm->expire_walk_interval_ms);
1823 VLIB_CLI_COMMAND (show_ip4_full_reass_cmd, static) = {
1824 .path = "show ip4-full-reassembly",
1825 .short_help = "show ip4-full-reassembly [details]",
1826 .function = show_ip4_reass,
1829 #ifndef CLIB_MARCH_VARIANT
1831 ip4_full_reass_enable_disable (u32 sw_if_index, u8 enable_disable)
1833 return vnet_feature_enable_disable ("ip4-unicast",
1834 "ip4-full-reassembly-feature",
1835 sw_if_index, enable_disable, 0, 0);
1837 #endif /* CLIB_MARCH_VARIANT */
1840 #define foreach_ip4_full_reass_handoff_error \
1841 _(CONGESTION_DROP, "congestion drop")
1846 #define _(sym,str) IP4_FULL_REASS_HANDOFF_ERROR_##sym,
1847 foreach_ip4_full_reass_handoff_error
1849 IP4_FULL_REASS_HANDOFF_N_ERROR,
1850 } ip4_full_reass_handoff_error_t;
1852 static char *ip4_full_reass_handoff_error_strings[] = {
1853 #define _(sym,string) string,
1854 foreach_ip4_full_reass_handoff_error
1860 u32 next_worker_index;
1861 } ip4_full_reass_handoff_trace_t;
1864 format_ip4_full_reass_handoff_trace (u8 * s, va_list * args)
1866 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
1867 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
1868 ip4_full_reass_handoff_trace_t *t =
1869 va_arg (*args, ip4_full_reass_handoff_trace_t *);
1872 format (s, "ip4-full-reassembly-handoff: next-worker %d",
1873 t->next_worker_index);
1879 ip4_full_reass_handoff_node_inline (vlib_main_t *vm, vlib_node_runtime_t *node,
1880 vlib_frame_t *frame,
1881 ip4_full_reass_node_type_t type,
1884 ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1886 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
1887 u32 n_enq, n_left_from, *from;
1888 u16 thread_indices[VLIB_FRAME_SIZE], *ti;
1891 from = vlib_frame_vector_args (frame);
1892 n_left_from = frame->n_vectors;
1893 vlib_get_buffers (vm, from, bufs, n_left_from);
1896 ti = thread_indices;
1903 fq_index = rm->fq_local_index;
1907 fq_index = rm->fq_index;
1911 fq_index = rm->fq_feature_index;
1914 fq_index = rm->fq_custom_index;
1917 clib_warning ("Unexpected `type' (%d)!", type);
1920 while (n_left_from > 0)
1922 ti[0] = vnet_buffer (b[0])->ip.reass.owner_thread_index;
1925 ((node->flags & VLIB_NODE_FLAG_TRACE)
1926 && (b[0]->flags & VLIB_BUFFER_IS_TRACED)))
1928 ip4_full_reass_handoff_trace_t *t =
1929 vlib_add_trace (vm, node, b[0], sizeof (*t));
1930 t->next_worker_index = ti[0];
1937 n_enq = vlib_buffer_enqueue_to_thread (vm, node, fq_index, from,
1938 thread_indices, frame->n_vectors, 1);
1940 if (n_enq < frame->n_vectors)
1941 vlib_node_increment_counter (vm, node->node_index,
1942 IP4_FULL_REASS_HANDOFF_ERROR_CONGESTION_DROP,
1943 frame->n_vectors - n_enq);
1944 return frame->n_vectors;
1947 VLIB_NODE_FN (ip4_full_reass_handoff_node) (vlib_main_t * vm,
1948 vlib_node_runtime_t * node,
1949 vlib_frame_t * frame)
1951 return ip4_full_reass_handoff_node_inline (vm, node, frame, NORMAL,
1952 false /* is_local */);
1956 VLIB_REGISTER_NODE (ip4_full_reass_handoff_node) = {
1957 .name = "ip4-full-reassembly-handoff",
1958 .vector_size = sizeof (u32),
1959 .n_errors = ARRAY_LEN(ip4_full_reass_handoff_error_strings),
1960 .error_strings = ip4_full_reass_handoff_error_strings,
1961 .format_trace = format_ip4_full_reass_handoff_trace,
1970 VLIB_NODE_FN (ip4_local_full_reass_handoff_node)
1971 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
1973 return ip4_full_reass_handoff_node_inline (vm, node, frame, NORMAL,
1974 true /* is_local */);
1977 VLIB_REGISTER_NODE (ip4_local_full_reass_handoff_node) = {
1978 .name = "ip4-local-full-reassembly-handoff",
1979 .vector_size = sizeof (u32),
1980 .n_errors = ARRAY_LEN(ip4_full_reass_handoff_error_strings),
1981 .error_strings = ip4_full_reass_handoff_error_strings,
1982 .format_trace = format_ip4_full_reass_handoff_trace,
1991 VLIB_NODE_FN (ip4_full_reass_feature_handoff_node) (vlib_main_t * vm,
1992 vlib_node_runtime_t *
1994 vlib_frame_t * frame)
1996 return ip4_full_reass_handoff_node_inline (vm, node, frame, FEATURE,
1997 false /* is_local */);
2000 VLIB_REGISTER_NODE (ip4_full_reass_feature_handoff_node) = {
2001 .name = "ip4-full-reass-feature-hoff",
2002 .vector_size = sizeof (u32),
2003 .n_errors = ARRAY_LEN(ip4_full_reass_handoff_error_strings),
2004 .error_strings = ip4_full_reass_handoff_error_strings,
2005 .format_trace = format_ip4_full_reass_handoff_trace,
2014 VLIB_NODE_FN (ip4_full_reass_custom_handoff_node) (vlib_main_t * vm,
2015 vlib_node_runtime_t *
2017 vlib_frame_t * frame)
2019 return ip4_full_reass_handoff_node_inline (vm, node, frame, CUSTOM,
2020 false /* is_local */);
2023 VLIB_REGISTER_NODE (ip4_full_reass_custom_handoff_node) = {
2024 .name = "ip4-full-reass-custom-hoff",
2025 .vector_size = sizeof (u32),
2026 .n_errors = ARRAY_LEN(ip4_full_reass_handoff_error_strings),
2027 .error_strings = ip4_full_reass_handoff_error_strings,
2028 .format_trace = format_ip4_full_reass_handoff_trace,
2037 #ifndef CLIB_MARCH_VARIANT
2039 ip4_full_reass_enable_disable_with_refcnt (u32 sw_if_index, int is_enable)
2041 ip4_full_reass_main_t *rm = &ip4_full_reass_main;
2042 vec_validate (rm->feature_use_refcount_per_intf, sw_if_index);
2045 if (!rm->feature_use_refcount_per_intf[sw_if_index])
2047 ++rm->feature_use_refcount_per_intf[sw_if_index];
2048 return vnet_feature_enable_disable ("ip4-unicast",
2049 "ip4-full-reassembly-feature",
2050 sw_if_index, 1, 0, 0);
2052 ++rm->feature_use_refcount_per_intf[sw_if_index];
2056 --rm->feature_use_refcount_per_intf[sw_if_index];
2057 if (!rm->feature_use_refcount_per_intf[sw_if_index])
2058 return vnet_feature_enable_disable ("ip4-unicast",
2059 "ip4-full-reassembly-feature",
2060 sw_if_index, 0, 0, 0);
2066 ip4_local_full_reass_enable_disable (int enable)
2070 ip4_full_reass_main.is_local_reass_enabled = 1;
2074 ip4_full_reass_main.is_local_reass_enabled = 0;
2079 ip4_local_full_reass_enabled ()
2081 return ip4_full_reass_main.is_local_reass_enabled;
2087 * fd.io coding-style-patch-verification: ON
2090 * eval: (c-set-style "gnu")