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, u32 *n_left_to_next,
433 u32 range_bi = reass->first_bi;
434 vlib_buffer_t *range_b;
435 vnet_buffer_opaque_t *range_vnb;
438 while (~0 != range_bi)
440 range_b = vlib_get_buffer (vm, range_bi);
441 range_vnb = vnet_buffer (range_b);
445 vec_add1 (to_free, range_bi);
448 range_bi = range_vnb->ip.reass.next_range_bi;
451 /* send to next_error_index */
452 if (~0 != reass->error_next_index &&
453 reass->error_next_index < node->n_next_nodes)
457 next_index = reass->error_next_index;
460 /* record number of packets sent to custom app */
461 vlib_node_increment_counter (vm, node->node_index,
462 IP4_ERROR_REASS_TO_CUSTOM_APP,
465 while (vec_len (to_free) > 0)
467 vlib_get_next_frame (vm, node, next_index, *to_next,
470 while (vec_len (to_free) > 0 && (*n_left_to_next) > 0)
472 bi = vec_pop (to_free);
476 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
477 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
479 ip4_full_reass_add_trace (vm, node, reass, bi,
480 RANGE_DISCARD, 0, ~0);
484 (*n_left_to_next) -= 1;
487 vlib_put_next_frame (vm, node, next_index, (*n_left_to_next));
492 vlib_buffer_free (vm, to_free, vec_len (to_free));
498 sanitize_reass_buffers_add_missing (vlib_main_t *vm, ip4_full_reass_t *reass,
501 u32 range_bi = reass->first_bi;
502 vlib_buffer_t *range_b;
503 vnet_buffer_opaque_t *range_vnb;
505 while (~0 != range_bi)
507 range_b = vlib_get_buffer (vm, range_bi);
508 range_vnb = vnet_buffer (range_b);
514 if (range_b->flags & VLIB_BUFFER_NEXT_PRESENT)
517 vlib_buffer_t *_b = vlib_get_buffer (vm, _bi);
518 while (_b->flags & VLIB_BUFFER_NEXT_PRESENT)
520 if (_b->next_buffer != range_vnb->ip.reass.next_range_bi)
522 _bi = _b->next_buffer;
523 _b = vlib_get_buffer (vm, _bi);
527 _b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
532 range_bi = range_vnb->ip.reass.next_range_bi;
537 vlib_buffer_t *fb = vlib_get_buffer (vm, *bi0);
538 vnet_buffer_opaque_t *fvnb = vnet_buffer (fb);
539 if (~0 != reass->first_bi)
541 fvnb->ip.reass.next_range_bi = reass->first_bi;
542 reass->first_bi = *bi0;
546 reass->first_bi = *bi0;
547 fvnb->ip.reass.next_range_bi = ~0;
554 ip4_full_reass_init (ip4_full_reass_t * reass)
556 reass->first_bi = ~0;
557 reass->last_packet_octet = ~0;
559 reass->next_index = ~0;
560 reass->error_next_index = ~0;
563 always_inline ip4_full_reass_t *
564 ip4_full_reass_find_or_create (vlib_main_t *vm, vlib_node_runtime_t *node,
565 ip4_full_reass_main_t *rm,
566 ip4_full_reass_per_thread_t *rt,
567 ip4_full_reass_kv_t *kv, u8 *do_handoff,
568 u32 *n_left_to_next, u32 **to_next)
570 ip4_full_reass_t *reass;
576 now = vlib_time_now (vm);
577 if (!clib_bihash_search_16_8 (&rm->hash, &kv->kv, &kv->kv))
579 if (vm->thread_index != kv->v.memory_owner_thread_index)
585 pool_elt_at_index (rm->per_thread_data
586 [kv->v.memory_owner_thread_index].pool,
589 if (now > reass->last_heard + rm->timeout)
591 vlib_node_increment_counter (vm, node->node_index,
592 IP4_ERROR_REASS_TIMEOUT, 1);
593 ip4_full_reass_drop_all (vm, node, reass, n_left_to_next, to_next);
594 ip4_full_reass_free (rm, rt, reass);
601 reass->last_heard = now;
605 if (rt->reass_n >= rm->max_reass_n)
612 pool_get (rt->pool, reass);
613 clib_memset (reass, 0, sizeof (*reass));
614 reass->id = ((u64) vm->thread_index * 1000000000) + rt->id_counter;
615 reass->memory_owner_thread_index = vm->thread_index;
617 ip4_full_reass_init (reass);
621 clib_memcpy_fast (&reass->key, &kv->kv.key, sizeof (reass->key));
622 kv->v.reass_index = (reass - rt->pool);
623 kv->v.memory_owner_thread_index = vm->thread_index;
624 reass->last_heard = now;
626 int rv = clib_bihash_add_del_16_8 (&rm->hash, &kv->kv, 2);
629 ip4_full_reass_free_ctx (rt, reass);
631 // if other worker created a context already work with the other copy
639 always_inline ip4_full_reass_rc_t
640 ip4_full_reass_finalize (vlib_main_t * vm, vlib_node_runtime_t * node,
641 ip4_full_reass_main_t * rm,
642 ip4_full_reass_per_thread_t * rt,
643 ip4_full_reass_t * reass, u32 * bi0,
644 u32 * next0, u32 * error0, bool is_custom)
646 vlib_buffer_t *first_b = vlib_get_buffer (vm, reass->first_bi);
647 vlib_buffer_t *last_b = NULL;
648 u32 sub_chain_bi = reass->first_bi;
649 u32 total_length = 0;
652 u32 tmp_bi = sub_chain_bi;
653 vlib_buffer_t *tmp = vlib_get_buffer (vm, tmp_bi);
654 ip4_header_t *ip = vlib_buffer_get_current (tmp);
655 vnet_buffer_opaque_t *vnb = vnet_buffer (tmp);
656 if (!(vnb->ip.reass.range_first >= vnb->ip.reass.fragment_first) &&
657 !(vnb->ip.reass.range_last > vnb->ip.reass.fragment_first))
659 return IP4_REASS_RC_INTERNAL_ERROR;
662 u32 data_len = ip4_full_reass_buffer_get_data_len (tmp);
664 ip4_header_bytes (ip) + ip4_full_reass_buffer_get_data_offset (tmp);
666 vlib_buffer_length_in_chain (vm, tmp) - trim_front - data_len;
667 if (tmp_bi == reass->first_bi)
669 /* first buffer - keep ip4 header */
670 if (0 != ip4_full_reass_buffer_get_data_offset (tmp))
672 return IP4_REASS_RC_INTERNAL_ERROR;
675 trim_end = vlib_buffer_length_in_chain (vm, tmp) - data_len -
676 ip4_header_bytes (ip);
677 if (!(vlib_buffer_length_in_chain (vm, tmp) - trim_end > 0))
679 return IP4_REASS_RC_INTERNAL_ERROR;
683 vlib_buffer_length_in_chain (vm, tmp) - trim_front - trim_end;
688 if (trim_front > tmp->current_length)
690 /* drop whole buffer */
691 u32 to_be_freed_bi = tmp_bi;
692 trim_front -= tmp->current_length;
693 if (!(tmp->flags & VLIB_BUFFER_NEXT_PRESENT))
695 return IP4_REASS_RC_INTERNAL_ERROR;
697 tmp->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
698 tmp_bi = tmp->next_buffer;
699 tmp->next_buffer = 0;
700 tmp = vlib_get_buffer (vm, tmp_bi);
701 vlib_buffer_free_one (vm, to_be_freed_bi);
706 vlib_buffer_advance (tmp, trim_front);
714 last_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
715 last_b->next_buffer = tmp_bi;
718 if (keep_data <= tmp->current_length)
720 tmp->current_length = keep_data;
725 keep_data -= tmp->current_length;
726 if (!(tmp->flags & VLIB_BUFFER_NEXT_PRESENT))
728 return IP4_REASS_RC_INTERNAL_ERROR;
731 total_length += tmp->current_length;
732 if (tmp->flags & VLIB_BUFFER_NEXT_PRESENT)
734 tmp_bi = tmp->next_buffer;
735 tmp = vlib_get_buffer (vm, tmp->next_buffer);
744 u32 to_be_freed_bi = tmp_bi;
745 if (reass->first_bi == tmp_bi)
747 return IP4_REASS_RC_INTERNAL_ERROR;
749 if (tmp->flags & VLIB_BUFFER_NEXT_PRESENT)
751 tmp->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
752 tmp_bi = tmp->next_buffer;
753 tmp->next_buffer = 0;
754 tmp = vlib_get_buffer (vm, tmp_bi);
755 vlib_buffer_free_one (vm, to_be_freed_bi);
759 tmp->next_buffer = 0;
760 vlib_buffer_free_one (vm, to_be_freed_bi);
766 vnet_buffer (vlib_get_buffer (vm, sub_chain_bi))->ip.
769 while (~0 != sub_chain_bi);
773 return IP4_REASS_RC_INTERNAL_ERROR;
775 last_b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
777 if (total_length < first_b->current_length)
779 return IP4_REASS_RC_INTERNAL_ERROR;
781 total_length -= first_b->current_length;
782 first_b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
783 first_b->total_length_not_including_first_buffer = total_length;
784 ip4_header_t *ip = vlib_buffer_get_current (first_b);
785 ip->flags_and_fragment_offset = 0;
786 ip->length = clib_host_to_net_u16 (first_b->current_length + total_length);
787 ip->checksum = ip4_header_checksum (ip);
788 if (!vlib_buffer_chain_linearize (vm, first_b))
790 return IP4_REASS_RC_NO_BUF;
792 // reset to reconstruct the mbuf linking
793 first_b->flags &= ~VLIB_BUFFER_EXT_HDR_VALID;
794 if (PREDICT_FALSE (first_b->flags & VLIB_BUFFER_IS_TRACED))
796 ip4_full_reass_add_trace (vm, node, reass, reass->first_bi, FINALIZE, 0,
799 // following code does a hexdump of packet fragments to stdout ...
802 u32 bi = reass->first_bi;
806 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
807 s = format (s, "%u: %U\n", bi, format_hexdump,
808 vlib_buffer_get_current (b), b->current_length);
809 if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
818 printf ("%.*s\n", vec_len (s), s);
825 *bi0 = reass->first_bi;
828 *next0 = IP4_FULL_REASS_NEXT_INPUT;
832 *next0 = reass->next_index;
834 vnet_buffer (first_b)->ip.reass.estimated_mtu = reass->min_fragment_length;
836 /* Keep track of number of successfully reassembled packets and number of
837 * fragments reassembled */
838 vlib_node_increment_counter (vm, node->node_index, IP4_ERROR_REASS_SUCCESS,
841 vlib_node_increment_counter (vm, node->node_index,
842 IP4_ERROR_REASS_FRAGMENTS_REASSEMBLED,
845 *error0 = IP4_ERROR_NONE;
846 ip4_full_reass_free (rm, rt, reass);
848 return IP4_REASS_RC_OK;
851 always_inline ip4_full_reass_rc_t
852 ip4_full_reass_insert_range_in_chain (vlib_main_t * vm,
853 ip4_full_reass_t * reass,
854 u32 prev_range_bi, u32 new_next_bi)
856 vlib_buffer_t *new_next_b = vlib_get_buffer (vm, new_next_bi);
857 vnet_buffer_opaque_t *new_next_vnb = vnet_buffer (new_next_b);
858 if (~0 != prev_range_bi)
860 vlib_buffer_t *prev_b = vlib_get_buffer (vm, prev_range_bi);
861 vnet_buffer_opaque_t *prev_vnb = vnet_buffer (prev_b);
862 new_next_vnb->ip.reass.next_range_bi = prev_vnb->ip.reass.next_range_bi;
863 prev_vnb->ip.reass.next_range_bi = new_next_bi;
867 if (~0 != reass->first_bi)
869 new_next_vnb->ip.reass.next_range_bi = reass->first_bi;
871 reass->first_bi = new_next_bi;
873 vnet_buffer_opaque_t *vnb = vnet_buffer (new_next_b);
874 if (!(vnb->ip.reass.range_first >= vnb->ip.reass.fragment_first) &&
875 !(vnb->ip.reass.range_last > vnb->ip.reass.fragment_first))
877 return IP4_REASS_RC_INTERNAL_ERROR;
879 reass->data_len += ip4_full_reass_buffer_get_data_len (new_next_b);
880 return IP4_REASS_RC_OK;
883 always_inline ip4_full_reass_rc_t
884 ip4_full_reass_remove_range_from_chain (vlib_main_t * vm,
885 vlib_node_runtime_t * node,
886 ip4_full_reass_t * reass,
887 u32 prev_range_bi, u32 discard_bi)
889 vlib_buffer_t *discard_b = vlib_get_buffer (vm, discard_bi);
890 vnet_buffer_opaque_t *discard_vnb = vnet_buffer (discard_b);
891 if (~0 != prev_range_bi)
893 vlib_buffer_t *prev_b = vlib_get_buffer (vm, prev_range_bi);
894 vnet_buffer_opaque_t *prev_vnb = vnet_buffer (prev_b);
895 if (!(prev_vnb->ip.reass.next_range_bi == discard_bi))
897 return IP4_REASS_RC_INTERNAL_ERROR;
899 prev_vnb->ip.reass.next_range_bi = discard_vnb->ip.reass.next_range_bi;
903 reass->first_bi = discard_vnb->ip.reass.next_range_bi;
905 vnet_buffer_opaque_t *vnb = vnet_buffer (discard_b);
906 if (!(vnb->ip.reass.range_first >= vnb->ip.reass.fragment_first) &&
907 !(vnb->ip.reass.range_last > vnb->ip.reass.fragment_first))
909 return IP4_REASS_RC_INTERNAL_ERROR;
911 reass->data_len -= ip4_full_reass_buffer_get_data_len (discard_b);
914 u32 to_be_freed_bi = discard_bi;
915 if (PREDICT_FALSE (discard_b->flags & VLIB_BUFFER_IS_TRACED))
917 ip4_full_reass_add_trace (vm, node, reass, discard_bi, RANGE_DISCARD,
920 if (discard_b->flags & VLIB_BUFFER_NEXT_PRESENT)
922 discard_b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
923 discard_bi = discard_b->next_buffer;
924 discard_b->next_buffer = 0;
925 discard_b = vlib_get_buffer (vm, discard_bi);
926 vlib_buffer_free_one (vm, to_be_freed_bi);
930 discard_b->next_buffer = 0;
931 vlib_buffer_free_one (vm, to_be_freed_bi);
935 return IP4_REASS_RC_OK;
938 always_inline ip4_full_reass_rc_t
939 ip4_full_reass_update (vlib_main_t * vm, vlib_node_runtime_t * node,
940 ip4_full_reass_main_t * rm,
941 ip4_full_reass_per_thread_t * rt,
942 ip4_full_reass_t * reass, u32 * bi0, u32 * next0,
943 u32 * error0, bool is_custom, u32 * handoff_thread_idx)
945 vlib_buffer_t *fb = vlib_get_buffer (vm, *bi0);
946 vnet_buffer_opaque_t *fvnb = vnet_buffer (fb);
949 // store (error_)next_index before it's overwritten
950 reass->next_index = fvnb->ip.reass.next_index;
951 reass->error_next_index = fvnb->ip.reass.error_next_index;
953 ip4_full_reass_rc_t rc = IP4_REASS_RC_OK;
955 ip4_header_t *fip = vlib_buffer_get_current (fb);
956 const u32 fragment_first = ip4_get_fragment_offset_bytes (fip);
957 const u32 fragment_length =
958 clib_net_to_host_u16 (fip->length) - ip4_header_bytes (fip);
959 const u32 fragment_last = fragment_first + fragment_length - 1;
960 fvnb->ip.reass.fragment_first = fragment_first;
961 fvnb->ip.reass.fragment_last = fragment_last;
962 int more_fragments = ip4_get_fragment_more (fip);
963 u32 candidate_range_bi = reass->first_bi;
964 u32 prev_range_bi = ~0;
965 fvnb->ip.reass.range_first = fragment_first;
966 fvnb->ip.reass.range_last = fragment_last;
967 fvnb->ip.reass.next_range_bi = ~0;
970 reass->last_packet_octet = fragment_last;
972 if (~0 == reass->first_bi)
974 // starting a new reassembly
976 ip4_full_reass_insert_range_in_chain (vm, reass, prev_range_bi, *bi0);
977 if (IP4_REASS_RC_OK != rc)
981 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
983 ip4_full_reass_add_trace (vm, node, reass, *bi0, RANGE_NEW, 0, ~0);
986 reass->min_fragment_length = clib_net_to_host_u16 (fip->length);
987 reass->fragments_n = 1;
988 return IP4_REASS_RC_OK;
990 reass->min_fragment_length =
991 clib_min (clib_net_to_host_u16 (fip->length),
992 fvnb->ip.reass.estimated_mtu);
993 while (~0 != candidate_range_bi)
995 vlib_buffer_t *candidate_b = vlib_get_buffer (vm, candidate_range_bi);
996 vnet_buffer_opaque_t *candidate_vnb = vnet_buffer (candidate_b);
997 if (fragment_first > candidate_vnb->ip.reass.range_last)
999 // this fragments starts after candidate range
1000 prev_range_bi = candidate_range_bi;
1001 candidate_range_bi = candidate_vnb->ip.reass.next_range_bi;
1002 if (candidate_vnb->ip.reass.range_last < fragment_last &&
1003 ~0 == candidate_range_bi)
1005 // special case - this fragment falls beyond all known ranges
1006 rc = ip4_full_reass_insert_range_in_chain (vm, reass,
1007 prev_range_bi, *bi0);
1008 if (IP4_REASS_RC_OK != rc)
1017 if (fragment_last < candidate_vnb->ip.reass.range_first)
1019 // this fragment ends before candidate range without any overlap
1020 rc = ip4_full_reass_insert_range_in_chain (vm, reass, prev_range_bi,
1022 if (IP4_REASS_RC_OK != rc)
1030 if (fragment_first >= candidate_vnb->ip.reass.range_first &&
1031 fragment_last <= candidate_vnb->ip.reass.range_last)
1033 // this fragment is a (sub)part of existing range, ignore it
1034 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
1036 ip4_full_reass_add_trace (vm, node, reass, *bi0,
1037 RANGE_OVERLAP, 0, ~0);
1041 int discard_candidate = 0;
1042 if (fragment_first < candidate_vnb->ip.reass.range_first)
1045 fragment_last - candidate_vnb->ip.reass.range_first + 1;
1046 if (overlap < ip4_full_reass_buffer_get_data_len (candidate_b))
1048 candidate_vnb->ip.reass.range_first += overlap;
1049 if (reass->data_len < overlap)
1051 return IP4_REASS_RC_INTERNAL_ERROR;
1053 reass->data_len -= overlap;
1054 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
1056 ip4_full_reass_add_trace (vm, node, reass,
1058 RANGE_SHRINK, 0, ~0);
1060 rc = ip4_full_reass_insert_range_in_chain (
1061 vm, reass, prev_range_bi, *bi0);
1062 if (IP4_REASS_RC_OK != rc)
1070 discard_candidate = 1;
1073 else if (fragment_last > candidate_vnb->ip.reass.range_last)
1076 candidate_vnb->ip.reass.range_last - fragment_first + 1;
1077 if (overlap < ip4_full_reass_buffer_get_data_len (candidate_b))
1079 fvnb->ip.reass.range_first += overlap;
1080 if (~0 != candidate_vnb->ip.reass.next_range_bi)
1082 prev_range_bi = candidate_range_bi;
1083 candidate_range_bi =
1084 candidate_vnb->ip.reass.next_range_bi;
1089 // special case - last range discarded
1090 rc = ip4_full_reass_insert_range_in_chain (
1091 vm, reass, candidate_range_bi, *bi0);
1092 if (IP4_REASS_RC_OK != rc)
1101 discard_candidate = 1;
1106 discard_candidate = 1;
1108 if (discard_candidate)
1110 u32 next_range_bi = candidate_vnb->ip.reass.next_range_bi;
1111 // discard candidate range, probe next range
1112 rc = ip4_full_reass_remove_range_from_chain (
1113 vm, node, reass, prev_range_bi, candidate_range_bi);
1114 if (IP4_REASS_RC_OK != rc)
1118 if (~0 != next_range_bi)
1120 candidate_range_bi = next_range_bi;
1125 // special case - last range discarded
1126 rc = ip4_full_reass_insert_range_in_chain (
1127 vm, reass, prev_range_bi, *bi0);
1128 if (IP4_REASS_RC_OK != rc)
1138 ++reass->fragments_n;
1141 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
1143 ip4_full_reass_add_trace (vm, node, reass, *bi0, RANGE_NEW, 0, ~0);
1146 if (~0 != reass->last_packet_octet &&
1147 reass->data_len == reass->last_packet_octet + 1)
1149 *handoff_thread_idx = reass->sendout_thread_index;
1151 reass->memory_owner_thread_index != reass->sendout_thread_index;
1153 ip4_full_reass_finalize (vm, node, rm, rt, reass, bi0, next0, error0,
1155 if (IP4_REASS_RC_OK == rc && handoff)
1157 rc = IP4_REASS_RC_HANDOFF;
1165 if (reass->fragments_n > rm->max_reass_len)
1167 rc = IP4_REASS_RC_TOO_MANY_FRAGMENTS;
1172 *next0 = IP4_FULL_REASS_NEXT_DROP;
1173 *error0 = IP4_ERROR_REASS_DUPLICATE_FRAGMENT;
1180 ip4_full_reass_inline (vlib_main_t *vm, vlib_node_runtime_t *node,
1181 vlib_frame_t *frame, ip4_full_reass_node_type_t type,
1184 u32 *from = vlib_frame_vector_args (frame);
1185 u32 n_left_from, n_left_to_next, *to_next, next_index;
1186 ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1187 ip4_full_reass_per_thread_t *rt = &rm->per_thread_data[vm->thread_index];
1188 clib_spinlock_lock (&rt->lock);
1190 n_left_from = frame->n_vectors;
1191 next_index = node->cached_next_index;
1192 while (n_left_from > 0)
1194 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
1196 while (n_left_from > 0 && n_left_to_next > 0)
1201 u32 error0 = IP4_ERROR_NONE;
1204 b0 = vlib_get_buffer (vm, bi0);
1206 ip4_header_t *ip0 = vlib_buffer_get_current (b0);
1207 if (!ip4_get_fragment_more (ip0) && !ip4_get_fragment_offset (ip0))
1209 // this is a whole packet - no fragmentation
1212 next0 = IP4_FULL_REASS_NEXT_INPUT;
1216 next0 = vnet_buffer (b0)->ip.reass.next_index;
1218 ip4_full_reass_add_trace (vm, node, NULL, bi0, PASSTHROUGH, 0,
1220 goto packet_enqueue;
1223 if (is_local && !rm->is_local_reass_enabled)
1225 next0 = IP4_FULL_REASS_NEXT_DROP;
1226 goto packet_enqueue;
1229 const u32 fragment_first = ip4_get_fragment_offset_bytes (ip0);
1230 const u32 fragment_length =
1231 clib_net_to_host_u16 (ip0->length) - ip4_header_bytes (ip0);
1232 const u32 fragment_last = fragment_first + fragment_length - 1;
1234 /* Keep track of received fragments */
1235 vlib_node_increment_counter (vm, node->node_index,
1236 IP4_ERROR_REASS_FRAGMENTS_RCVD, 1);
1238 if (fragment_first > fragment_last ||
1239 fragment_first + fragment_length > UINT16_MAX - 20 ||
1240 (fragment_length < 8 && // 8 is minimum frag length per RFC 791
1241 ip4_get_fragment_more (ip0)))
1243 next0 = IP4_FULL_REASS_NEXT_DROP;
1244 error0 = IP4_ERROR_REASS_MALFORMED_PACKET;
1245 goto packet_enqueue;
1248 u32 fib_index = vec_elt (ip4_main.fib_index_by_sw_if_index,
1249 vnet_buffer (b0)->sw_if_index[VLIB_RX]);
1251 ip4_full_reass_kv_t kv = { .k.fib_index = fib_index,
1252 .k.src.as_u32 = ip0->src_address.as_u32,
1253 .k.dst.as_u32 = ip0->dst_address.as_u32,
1254 .k.frag_id = ip0->fragment_id,
1255 .k.proto = ip0->protocol
1260 ip4_full_reass_t *reass = ip4_full_reass_find_or_create (
1261 vm, node, rm, rt, &kv, &do_handoff, &n_left_to_next, &to_next);
1265 const u32 fragment_first = ip4_get_fragment_offset_bytes (ip0);
1266 if (0 == fragment_first)
1268 reass->sendout_thread_index = vm->thread_index;
1272 if (PREDICT_FALSE (do_handoff))
1274 next0 = IP4_FULL_REASS_NEXT_HANDOFF;
1275 vnet_buffer (b0)->ip.reass.owner_thread_index =
1276 kv.v.memory_owner_thread_index;
1280 u32 handoff_thread_idx;
1282 switch (ip4_full_reass_update
1283 (vm, node, rm, rt, reass, &bi0, &next0,
1284 &error0, CUSTOM == type, &handoff_thread_idx))
1286 case IP4_REASS_RC_OK:
1287 /* nothing to do here */
1289 case IP4_REASS_RC_HANDOFF:
1290 next0 = IP4_FULL_REASS_NEXT_HANDOFF;
1291 b0 = vlib_get_buffer (vm, bi0);
1292 vnet_buffer (b0)->ip.reass.owner_thread_index =
1295 case IP4_REASS_RC_TOO_MANY_FRAGMENTS:
1296 counter = IP4_ERROR_REASS_FRAGMENT_CHAIN_TOO_LONG;
1298 case IP4_REASS_RC_NO_BUF:
1299 counter = IP4_ERROR_REASS_NO_BUF;
1301 case IP4_REASS_RC_INTERNAL_ERROR:
1302 counter = IP4_ERROR_REASS_INTERNAL_ERROR;
1303 /* Sanitization is needed in internal error cases only, as
1304 * the incoming packet is already dropped in other cases,
1305 * also adding bi0 back to the reassembly list, fixes the
1306 * leaking of buffers during internal errors.
1308 * Also it doesnt make sense to send these buffers custom
1309 * app, these fragments are with internal errors */
1310 sanitize_reass_buffers_add_missing (vm, reass, &bi0);
1311 reass->error_next_index = ~0;
1317 vlib_node_increment_counter (vm, node->node_index, counter,
1319 ip4_full_reass_drop_all (vm, node, reass, &n_left_to_next,
1321 ip4_full_reass_free (rm, rt, reass);
1327 next0 = IP4_FULL_REASS_NEXT_DROP;
1328 error0 = IP4_ERROR_REASS_LIMIT_REACHED;
1338 n_left_to_next -= 1;
1340 /* bi0 might have been updated by reass_finalize, reload */
1341 b0 = vlib_get_buffer (vm, bi0);
1342 if (IP4_ERROR_NONE != error0)
1344 b0->error = node->errors[error0];
1347 if (next0 == IP4_FULL_REASS_NEXT_HANDOFF)
1349 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
1351 ip4_full_reass_add_trace (
1352 vm, node, NULL, bi0, HANDOFF, 0,
1353 vnet_buffer (b0)->ip.reass.owner_thread_index);
1356 else if (FEATURE == type && IP4_ERROR_NONE == error0)
1358 vnet_feature_next (&next0, b0);
1361 /* Increment the counter to-custom-app also as this fragment is
1362 * also going to application */
1365 vlib_node_increment_counter (
1366 vm, node->node_index, IP4_ERROR_REASS_TO_CUSTOM_APP, 1);
1369 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
1370 to_next, n_left_to_next,
1372 IP4_REASS_DEBUG_BUFFER (bi0, enqueue_next);
1380 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1383 clib_spinlock_unlock (&rt->lock);
1384 return frame->n_vectors;
1387 VLIB_NODE_FN (ip4_full_reass_node) (vlib_main_t * vm,
1388 vlib_node_runtime_t * node,
1389 vlib_frame_t * frame)
1391 return ip4_full_reass_inline (vm, node, frame, NORMAL, false /* is_local */);
1394 VLIB_REGISTER_NODE (ip4_full_reass_node) = {
1395 .name = "ip4-full-reassembly",
1396 .vector_size = sizeof (u32),
1397 .format_trace = format_ip4_full_reass_trace,
1398 .n_errors = IP4_N_ERROR,
1399 .error_counters = ip4_error_counters,
1400 .n_next_nodes = IP4_FULL_REASS_N_NEXT,
1403 [IP4_FULL_REASS_NEXT_INPUT] = "ip4-input",
1404 [IP4_FULL_REASS_NEXT_DROP] = "ip4-drop",
1405 [IP4_FULL_REASS_NEXT_HANDOFF] = "ip4-full-reassembly-handoff",
1410 VLIB_NODE_FN (ip4_local_full_reass_node)
1411 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
1413 return ip4_full_reass_inline (vm, node, frame, NORMAL, true /* is_local */);
1416 VLIB_REGISTER_NODE (ip4_local_full_reass_node) = {
1417 .name = "ip4-local-full-reassembly",
1418 .vector_size = sizeof (u32),
1419 .format_trace = format_ip4_full_reass_trace,
1420 .n_errors = IP4_N_ERROR,
1421 .error_counters = ip4_error_counters,
1422 .n_next_nodes = IP4_FULL_REASS_N_NEXT,
1425 [IP4_FULL_REASS_NEXT_INPUT] = "ip4-input",
1426 [IP4_FULL_REASS_NEXT_DROP] = "ip4-drop",
1427 [IP4_FULL_REASS_NEXT_HANDOFF] = "ip4-local-full-reassembly-handoff",
1432 VLIB_NODE_FN (ip4_full_reass_node_feature) (vlib_main_t * vm,
1433 vlib_node_runtime_t * node,
1434 vlib_frame_t * frame)
1436 return ip4_full_reass_inline (vm, node, frame, FEATURE,
1437 false /* is_local */);
1440 VLIB_REGISTER_NODE (ip4_full_reass_node_feature) = {
1441 .name = "ip4-full-reassembly-feature",
1442 .vector_size = sizeof (u32),
1443 .format_trace = format_ip4_full_reass_trace,
1444 .n_errors = IP4_N_ERROR,
1445 .error_counters = ip4_error_counters,
1446 .n_next_nodes = IP4_FULL_REASS_N_NEXT,
1449 [IP4_FULL_REASS_NEXT_INPUT] = "ip4-input",
1450 [IP4_FULL_REASS_NEXT_DROP] = "ip4-drop",
1451 [IP4_FULL_REASS_NEXT_HANDOFF] = "ip4-full-reass-feature-hoff",
1455 VNET_FEATURE_INIT (ip4_full_reass_feature, static) = {
1456 .arc_name = "ip4-unicast",
1457 .node_name = "ip4-full-reassembly-feature",
1458 .runs_before = VNET_FEATURES ("ip4-lookup",
1459 "ipsec4-input-feature"),
1463 VLIB_NODE_FN (ip4_full_reass_node_custom) (vlib_main_t * vm,
1464 vlib_node_runtime_t * node,
1465 vlib_frame_t * frame)
1467 return ip4_full_reass_inline (vm, node, frame, CUSTOM, false /* is_local */);
1470 VLIB_REGISTER_NODE (ip4_full_reass_node_custom) = {
1471 .name = "ip4-full-reassembly-custom",
1472 .vector_size = sizeof (u32),
1473 .format_trace = format_ip4_full_reass_trace,
1474 .n_errors = IP4_N_ERROR,
1475 .error_counters = ip4_error_counters,
1476 .n_next_nodes = IP4_FULL_REASS_N_NEXT,
1479 [IP4_FULL_REASS_NEXT_INPUT] = "ip4-input",
1480 [IP4_FULL_REASS_NEXT_DROP] = "ip4-drop",
1481 [IP4_FULL_REASS_NEXT_HANDOFF] = "ip4-full-reass-custom-hoff",
1485 VNET_FEATURE_INIT (ip4_full_reass_custom, static) = {
1486 .arc_name = "ip4-unicast",
1487 .node_name = "ip4-full-reassembly-feature",
1488 .runs_before = VNET_FEATURES ("ip4-lookup",
1489 "ipsec4-input-feature"),
1494 #ifndef CLIB_MARCH_VARIANT
1496 ip4_full_reass_custom_register_next_node (uword node_index)
1498 return vlib_node_add_next (vlib_get_main (),
1499 ip4_full_reass_node_custom.index, node_index);
1503 ip4_full_reass_get_nbuckets ()
1505 ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1509 /* need more mem with more workers */
1510 nbuckets = (u32) (rm->max_reass_n * (vlib_num_workers () + 1) /
1511 IP4_REASS_HT_LOAD_FACTOR);
1513 for (i = 0; i < 31; i++)
1514 if ((1 << i) >= nbuckets)
1520 #endif /* CLIB_MARCH_VARIANT */
1524 IP4_EVENT_CONFIG_CHANGED = 1,
1525 } ip4_full_reass_event_t;
1530 clib_bihash_16_8_t *new_hash;
1531 } ip4_rehash_cb_ctx;
1533 #ifndef CLIB_MARCH_VARIANT
1535 ip4_rehash_cb (clib_bihash_kv_16_8_t * kv, void *_ctx)
1537 ip4_rehash_cb_ctx *ctx = _ctx;
1538 if (clib_bihash_add_del_16_8 (ctx->new_hash, kv, 1))
1542 return (BIHASH_WALK_CONTINUE);
1546 ip4_full_reass_set_params (u32 timeout_ms, u32 max_reassemblies,
1547 u32 max_reassembly_length,
1548 u32 expire_walk_interval_ms)
1550 ip4_full_reass_main.timeout_ms = timeout_ms;
1551 ip4_full_reass_main.timeout = (f64) timeout_ms / (f64) MSEC_PER_SEC;
1552 ip4_full_reass_main.max_reass_n = max_reassemblies;
1553 ip4_full_reass_main.max_reass_len = max_reassembly_length;
1554 ip4_full_reass_main.expire_walk_interval_ms = expire_walk_interval_ms;
1558 ip4_full_reass_set (u32 timeout_ms, u32 max_reassemblies,
1559 u32 max_reassembly_length, u32 expire_walk_interval_ms)
1561 u32 old_nbuckets = ip4_full_reass_get_nbuckets ();
1562 ip4_full_reass_set_params (timeout_ms, max_reassemblies,
1563 max_reassembly_length, expire_walk_interval_ms);
1564 vlib_process_signal_event (ip4_full_reass_main.vlib_main,
1565 ip4_full_reass_main.ip4_full_reass_expire_node_idx,
1566 IP4_EVENT_CONFIG_CHANGED, 0);
1567 u32 new_nbuckets = ip4_full_reass_get_nbuckets ();
1568 if (ip4_full_reass_main.max_reass_n > 0 && new_nbuckets > old_nbuckets)
1570 clib_bihash_16_8_t new_hash;
1571 clib_memset (&new_hash, 0, sizeof (new_hash));
1572 ip4_rehash_cb_ctx ctx;
1574 ctx.new_hash = &new_hash;
1575 clib_bihash_init_16_8 (&new_hash, "ip4-dr", new_nbuckets,
1576 new_nbuckets * 1024);
1577 clib_bihash_foreach_key_value_pair_16_8 (&ip4_full_reass_main.hash,
1578 ip4_rehash_cb, &ctx);
1581 clib_bihash_free_16_8 (&new_hash);
1586 clib_bihash_free_16_8 (&ip4_full_reass_main.hash);
1587 clib_memcpy_fast (&ip4_full_reass_main.hash, &new_hash,
1588 sizeof (ip4_full_reass_main.hash));
1589 clib_bihash_copied (&ip4_full_reass_main.hash, &new_hash);
1596 ip4_full_reass_get (u32 * timeout_ms, u32 * max_reassemblies,
1597 u32 * max_reassembly_length,
1598 u32 * expire_walk_interval_ms)
1600 *timeout_ms = ip4_full_reass_main.timeout_ms;
1601 *max_reassemblies = ip4_full_reass_main.max_reass_n;
1602 *max_reassembly_length = ip4_full_reass_main.max_reass_len;
1603 *expire_walk_interval_ms = ip4_full_reass_main.expire_walk_interval_ms;
1607 static clib_error_t *
1608 ip4_full_reass_init_function (vlib_main_t * vm)
1610 ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1611 clib_error_t *error = 0;
1617 vec_validate (rm->per_thread_data, vlib_num_workers ());
1618 ip4_full_reass_per_thread_t *rt;
1619 vec_foreach (rt, rm->per_thread_data)
1621 clib_spinlock_init (&rt->lock);
1622 pool_alloc (rt->pool, rm->max_reass_n);
1625 node = vlib_get_node_by_name (vm, (u8 *) "ip4-full-reassembly-expire-walk");
1627 rm->ip4_full_reass_expire_node_idx = node->index;
1629 ip4_full_reass_set_params (IP4_REASS_TIMEOUT_DEFAULT_MS,
1630 IP4_REASS_MAX_REASSEMBLIES_DEFAULT,
1631 IP4_REASS_MAX_REASSEMBLY_LENGTH_DEFAULT,
1632 IP4_REASS_EXPIRE_WALK_INTERVAL_DEFAULT_MS);
1634 nbuckets = ip4_full_reass_get_nbuckets ();
1635 clib_bihash_init_16_8 (&rm->hash, "ip4-dr", nbuckets, nbuckets * 1024);
1637 rm->fq_index = vlib_frame_queue_main_init (ip4_full_reass_node.index, 0);
1638 rm->fq_local_index =
1639 vlib_frame_queue_main_init (ip4_local_full_reass_node.index, 0);
1640 rm->fq_feature_index =
1641 vlib_frame_queue_main_init (ip4_full_reass_node_feature.index, 0);
1642 rm->fq_custom_index =
1643 vlib_frame_queue_main_init (ip4_full_reass_node_custom.index, 0);
1645 rm->feature_use_refcount_per_intf = NULL;
1646 rm->is_local_reass_enabled = 1;
1651 VLIB_INIT_FUNCTION (ip4_full_reass_init_function);
1652 #endif /* CLIB_MARCH_VARIANT */
1655 ip4_full_reass_walk_expired (vlib_main_t *vm, vlib_node_runtime_t *node,
1656 CLIB_UNUSED (vlib_frame_t *f))
1658 ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1659 uword event_type, *event_data = 0;
1663 vlib_process_wait_for_event_or_clock (vm,
1665 rm->expire_walk_interval_ms /
1666 (f64) MSEC_PER_SEC);
1667 event_type = vlib_process_get_events (vm, &event_data);
1672 /* no events => timeout */
1674 case IP4_EVENT_CONFIG_CHANGED:
1675 /* nothing to do here */
1678 clib_warning ("BUG: event type 0x%wx", event_type);
1681 f64 now = vlib_time_now (vm);
1683 ip4_full_reass_t *reass;
1684 int *pool_indexes_to_free = NULL;
1686 uword thread_index = 0;
1688 const uword nthreads = vlib_num_workers () + 1;
1689 u32 n_left_to_next, *to_next;
1691 for (thread_index = 0; thread_index < nthreads; ++thread_index)
1693 ip4_full_reass_per_thread_t *rt =
1694 &rm->per_thread_data[thread_index];
1695 clib_spinlock_lock (&rt->lock);
1697 vec_reset_length (pool_indexes_to_free);
1699 /* Pace the number of timeouts handled per thread,to avoid barrier
1700 * sync issues in real world scenarios */
1702 u32 beg = rt->last_id;
1703 /* to ensure we walk at least once per sec per context */
1705 beg + (IP4_REASS_MAX_REASSEMBLIES_DEFAULT *
1706 IP4_REASS_EXPIRE_WALK_INTERVAL_DEFAULT_MS / MSEC_PER_SEC +
1708 if (end > vec_len (rt->pool))
1710 end = vec_len (rt->pool);
1718 pool_foreach_stepping_index (index, beg, end, rt->pool)
1720 reass = pool_elt_at_index (rt->pool, index);
1721 if (now > reass->last_heard + rm->timeout)
1723 vec_add1 (pool_indexes_to_free, index);
1727 if (vec_len (pool_indexes_to_free))
1728 vlib_node_increment_counter (vm, node->node_index,
1729 IP4_ERROR_REASS_TIMEOUT,
1730 vec_len (pool_indexes_to_free));
1732 vec_foreach (i, pool_indexes_to_free)
1734 ip4_full_reass_t *reass = pool_elt_at_index (rt->pool, i[0]);
1735 ip4_full_reass_drop_all (vm, node, reass, &n_left_to_next,
1737 ip4_full_reass_free (rm, rt, reass);
1740 clib_spinlock_unlock (&rt->lock);
1743 vec_free (pool_indexes_to_free);
1746 vec_set_len (event_data, 0);
1753 VLIB_REGISTER_NODE (ip4_full_reass_expire_node) = {
1754 .function = ip4_full_reass_walk_expired,
1755 .type = VLIB_NODE_TYPE_PROCESS,
1756 .name = "ip4-full-reassembly-expire-walk",
1757 .format_trace = format_ip4_full_reass_trace,
1758 .n_errors = IP4_N_ERROR,
1759 .error_counters = ip4_error_counters,
1763 format_ip4_full_reass_key (u8 * s, va_list * args)
1765 ip4_full_reass_key_t *key = va_arg (*args, ip4_full_reass_key_t *);
1767 format (s, "fib_index: %u, src: %U, dst: %U, frag_id: %u, proto: %u",
1768 key->fib_index, format_ip4_address, &key->src, format_ip4_address,
1769 &key->dst, clib_net_to_host_u16 (key->frag_id), key->proto);
1774 format_ip4_reass (u8 * s, va_list * args)
1776 vlib_main_t *vm = va_arg (*args, vlib_main_t *);
1777 ip4_full_reass_t *reass = va_arg (*args, ip4_full_reass_t *);
1779 s = format (s, "ID: %lu, key: %U\n first_bi: %u, data_len: %u, "
1780 "last_packet_octet: %u, trace_op_counter: %u\n",
1781 reass->id, format_ip4_full_reass_key, &reass->key,
1782 reass->first_bi, reass->data_len,
1783 reass->last_packet_octet, reass->trace_op_counter);
1785 u32 bi = reass->first_bi;
1789 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
1790 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
1793 " #%03u: range: [%u, %u], bi: %u, off: %d, len: %u, "
1794 "fragment[%u, %u]\n", counter, vnb->ip.reass.range_first,
1795 vnb->ip.reass.range_last, bi,
1796 ip4_full_reass_buffer_get_data_offset (b),
1797 ip4_full_reass_buffer_get_data_len (b),
1798 vnb->ip.reass.fragment_first, vnb->ip.reass.fragment_last);
1799 if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
1801 bi = b->next_buffer;
1811 static clib_error_t *
1812 show_ip4_reass (vlib_main_t * vm,
1813 unformat_input_t * input,
1814 CLIB_UNUSED (vlib_cli_command_t * lmd))
1816 ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1818 vlib_cli_output (vm, "---------------------");
1819 vlib_cli_output (vm, "IP4 reassembly status");
1820 vlib_cli_output (vm, "---------------------");
1821 bool details = false;
1822 if (unformat (input, "details"))
1827 u32 sum_reass_n = 0;
1828 ip4_full_reass_t *reass;
1830 const uword nthreads = vlib_num_workers () + 1;
1831 for (thread_index = 0; thread_index < nthreads; ++thread_index)
1833 ip4_full_reass_per_thread_t *rt = &rm->per_thread_data[thread_index];
1834 clib_spinlock_lock (&rt->lock);
1837 pool_foreach (reass, rt->pool) {
1838 vlib_cli_output (vm, "%U", format_ip4_reass, vm, reass);
1841 sum_reass_n += rt->reass_n;
1842 clib_spinlock_unlock (&rt->lock);
1844 vlib_cli_output (vm, "---------------------");
1845 vlib_cli_output (vm, "Current full IP4 reassemblies count: %lu\n",
1846 (long unsigned) sum_reass_n);
1847 vlib_cli_output (vm,
1848 "Maximum configured concurrent full IP4 reassemblies per worker-thread: %lu\n",
1849 (long unsigned) rm->max_reass_n);
1850 vlib_cli_output (vm,
1851 "Maximum configured amount of fragments "
1852 "per full IP4 reassembly: %lu\n",
1853 (long unsigned) rm->max_reass_len);
1854 vlib_cli_output (vm,
1855 "Maximum configured full IP4 reassembly timeout: %lums\n",
1856 (long unsigned) rm->timeout_ms);
1857 vlib_cli_output (vm,
1858 "Maximum configured full IP4 reassembly expire walk interval: %lums\n",
1859 (long unsigned) rm->expire_walk_interval_ms);
1863 VLIB_CLI_COMMAND (show_ip4_full_reass_cmd, static) = {
1864 .path = "show ip4-full-reassembly",
1865 .short_help = "show ip4-full-reassembly [details]",
1866 .function = show_ip4_reass,
1869 #ifndef CLIB_MARCH_VARIANT
1871 ip4_full_reass_enable_disable (u32 sw_if_index, u8 enable_disable)
1873 return vnet_feature_enable_disable ("ip4-unicast",
1874 "ip4-full-reassembly-feature",
1875 sw_if_index, enable_disable, 0, 0);
1877 #endif /* CLIB_MARCH_VARIANT */
1880 #define foreach_ip4_full_reass_handoff_error \
1881 _(CONGESTION_DROP, "congestion drop")
1886 #define _(sym,str) IP4_FULL_REASS_HANDOFF_ERROR_##sym,
1887 foreach_ip4_full_reass_handoff_error
1889 IP4_FULL_REASS_HANDOFF_N_ERROR,
1890 } ip4_full_reass_handoff_error_t;
1892 static char *ip4_full_reass_handoff_error_strings[] = {
1893 #define _(sym,string) string,
1894 foreach_ip4_full_reass_handoff_error
1900 u32 next_worker_index;
1901 } ip4_full_reass_handoff_trace_t;
1904 format_ip4_full_reass_handoff_trace (u8 * s, va_list * args)
1906 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
1907 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
1908 ip4_full_reass_handoff_trace_t *t =
1909 va_arg (*args, ip4_full_reass_handoff_trace_t *);
1912 format (s, "ip4-full-reassembly-handoff: next-worker %d",
1913 t->next_worker_index);
1919 ip4_full_reass_handoff_node_inline (vlib_main_t *vm, vlib_node_runtime_t *node,
1920 vlib_frame_t *frame,
1921 ip4_full_reass_node_type_t type,
1924 ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1926 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
1927 u32 n_enq, n_left_from, *from;
1928 u16 thread_indices[VLIB_FRAME_SIZE], *ti;
1931 from = vlib_frame_vector_args (frame);
1932 n_left_from = frame->n_vectors;
1933 vlib_get_buffers (vm, from, bufs, n_left_from);
1936 ti = thread_indices;
1943 fq_index = rm->fq_local_index;
1947 fq_index = rm->fq_index;
1951 fq_index = rm->fq_feature_index;
1954 fq_index = rm->fq_custom_index;
1957 clib_warning ("Unexpected `type' (%d)!", type);
1960 while (n_left_from > 0)
1962 ti[0] = vnet_buffer (b[0])->ip.reass.owner_thread_index;
1965 ((node->flags & VLIB_NODE_FLAG_TRACE)
1966 && (b[0]->flags & VLIB_BUFFER_IS_TRACED)))
1968 ip4_full_reass_handoff_trace_t *t =
1969 vlib_add_trace (vm, node, b[0], sizeof (*t));
1970 t->next_worker_index = ti[0];
1977 n_enq = vlib_buffer_enqueue_to_thread (vm, node, fq_index, from,
1978 thread_indices, frame->n_vectors, 1);
1980 if (n_enq < frame->n_vectors)
1981 vlib_node_increment_counter (vm, node->node_index,
1982 IP4_FULL_REASS_HANDOFF_ERROR_CONGESTION_DROP,
1983 frame->n_vectors - n_enq);
1984 return frame->n_vectors;
1987 VLIB_NODE_FN (ip4_full_reass_handoff_node) (vlib_main_t * vm,
1988 vlib_node_runtime_t * node,
1989 vlib_frame_t * frame)
1991 return ip4_full_reass_handoff_node_inline (vm, node, frame, NORMAL,
1992 false /* is_local */);
1996 VLIB_REGISTER_NODE (ip4_full_reass_handoff_node) = {
1997 .name = "ip4-full-reassembly-handoff",
1998 .vector_size = sizeof (u32),
1999 .n_errors = ARRAY_LEN(ip4_full_reass_handoff_error_strings),
2000 .error_strings = ip4_full_reass_handoff_error_strings,
2001 .format_trace = format_ip4_full_reass_handoff_trace,
2010 VLIB_NODE_FN (ip4_local_full_reass_handoff_node)
2011 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
2013 return ip4_full_reass_handoff_node_inline (vm, node, frame, NORMAL,
2014 true /* is_local */);
2017 VLIB_REGISTER_NODE (ip4_local_full_reass_handoff_node) = {
2018 .name = "ip4-local-full-reassembly-handoff",
2019 .vector_size = sizeof (u32),
2020 .n_errors = ARRAY_LEN(ip4_full_reass_handoff_error_strings),
2021 .error_strings = ip4_full_reass_handoff_error_strings,
2022 .format_trace = format_ip4_full_reass_handoff_trace,
2031 VLIB_NODE_FN (ip4_full_reass_feature_handoff_node) (vlib_main_t * vm,
2032 vlib_node_runtime_t *
2034 vlib_frame_t * frame)
2036 return ip4_full_reass_handoff_node_inline (vm, node, frame, FEATURE,
2037 false /* is_local */);
2040 VLIB_REGISTER_NODE (ip4_full_reass_feature_handoff_node) = {
2041 .name = "ip4-full-reass-feature-hoff",
2042 .vector_size = sizeof (u32),
2043 .n_errors = ARRAY_LEN(ip4_full_reass_handoff_error_strings),
2044 .error_strings = ip4_full_reass_handoff_error_strings,
2045 .format_trace = format_ip4_full_reass_handoff_trace,
2054 VLIB_NODE_FN (ip4_full_reass_custom_handoff_node) (vlib_main_t * vm,
2055 vlib_node_runtime_t *
2057 vlib_frame_t * frame)
2059 return ip4_full_reass_handoff_node_inline (vm, node, frame, CUSTOM,
2060 false /* is_local */);
2063 VLIB_REGISTER_NODE (ip4_full_reass_custom_handoff_node) = {
2064 .name = "ip4-full-reass-custom-hoff",
2065 .vector_size = sizeof (u32),
2066 .n_errors = ARRAY_LEN(ip4_full_reass_handoff_error_strings),
2067 .error_strings = ip4_full_reass_handoff_error_strings,
2068 .format_trace = format_ip4_full_reass_handoff_trace,
2077 #ifndef CLIB_MARCH_VARIANT
2079 ip4_full_reass_enable_disable_with_refcnt (u32 sw_if_index, int is_enable)
2081 ip4_full_reass_main_t *rm = &ip4_full_reass_main;
2082 vec_validate (rm->feature_use_refcount_per_intf, sw_if_index);
2085 if (!rm->feature_use_refcount_per_intf[sw_if_index])
2087 ++rm->feature_use_refcount_per_intf[sw_if_index];
2088 return vnet_feature_enable_disable ("ip4-unicast",
2089 "ip4-full-reassembly-feature",
2090 sw_if_index, 1, 0, 0);
2092 ++rm->feature_use_refcount_per_intf[sw_if_index];
2096 --rm->feature_use_refcount_per_intf[sw_if_index];
2097 if (!rm->feature_use_refcount_per_intf[sw_if_index])
2098 return vnet_feature_enable_disable ("ip4-unicast",
2099 "ip4-full-reassembly-feature",
2100 sw_if_index, 0, 0, 0);
2106 ip4_local_full_reass_enable_disable (int enable)
2110 ip4_full_reass_main.is_local_reass_enabled = 1;
2114 ip4_full_reass_main.is_local_reass_enabled = 0;
2119 ip4_local_full_reass_enabled ()
2121 return ip4_full_reass_main.is_local_reass_enabled;
2127 * fd.io coding-style-patch-verification: ON
2130 * eval: (c-set-style "gnu")