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;
89 } ip4_full_reass_key_t;
96 u32 memory_owner_thread_index;
99 } ip4_full_reass_val_t;
105 ip4_full_reass_key_t k;
106 ip4_full_reass_val_t v;
108 clib_bihash_kv_16_8_t kv;
109 } ip4_full_reass_kv_t;
112 ip4_full_reass_buffer_get_data_offset (vlib_buffer_t * b)
114 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
115 return vnb->ip.reass.range_first - vnb->ip.reass.fragment_first;
119 ip4_full_reass_buffer_get_data_len (vlib_buffer_t * b)
121 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
122 return clib_min (vnb->ip.reass.range_last, vnb->ip.reass.fragment_last) -
123 (vnb->ip.reass.fragment_first +
124 ip4_full_reass_buffer_get_data_offset (b)) + 1;
130 ip4_full_reass_key_t key;
131 // time when last packet was received
133 // internal id of this reassembly
135 // buffer index of first buffer in this reassembly context
137 // last octet of packet, ~0 until fragment without more_fragments arrives
138 u32 last_packet_octet;
139 // length of data collected so far
141 // trace operation counter
142 u32 trace_op_counter;
143 // next index - used by non-feature node
145 // error next index - used by custom apps (~0 if not used)
146 u32 error_next_index;
147 // minimum fragment length for this reassembly - used to estimate MTU
148 u16 min_fragment_length;
149 // number of fragments in this reassembly
151 // thread owning memory for this context (whose pool contains this ctx)
152 u32 memory_owner_thread_index;
153 // thread which received fragment with offset 0 and which sends out the
154 // completed reassembly
155 u32 sendout_thread_index;
160 ip4_full_reass_t *pool;
163 // for pacing the main thread timeouts
165 clib_spinlock_t lock;
166 } ip4_full_reass_per_thread_t;
173 u32 expire_walk_interval_ms;
174 // maximum number of fragments in one reassembly
176 // maximum number of reassemblies
180 clib_bihash_16_8_t hash;
182 ip4_full_reass_per_thread_t *per_thread_data;
185 vlib_main_t *vlib_main;
187 u32 ip4_full_reass_expire_node_idx;
189 /** Worker handoff */
192 u32 fq_feature_index;
195 // reference count for enabling/disabling feature - per interface
196 u32 *feature_use_refcount_per_intf;
198 // whether local fragmented packets are reassembled or not
199 int is_local_reass_enabled;
200 } ip4_full_reass_main_t;
202 extern ip4_full_reass_main_t ip4_full_reass_main;
204 #ifndef CLIB_MARCH_VARIANT
205 ip4_full_reass_main_t ip4_full_reass_main;
206 #endif /* CLIB_MARCH_VARIANT */
210 IP4_FULL_REASS_NEXT_INPUT,
211 IP4_FULL_REASS_NEXT_DROP,
212 IP4_FULL_REASS_NEXT_HANDOFF,
213 IP4_FULL_REASS_N_NEXT,
214 } ip4_full_reass_next_t;
221 } ip4_full_reass_node_type_t;
232 } ip4_full_reass_trace_operation_e;
242 } ip4_full_reass_range_trace_t;
246 ip4_full_reass_trace_operation_e action;
248 ip4_full_reass_range_trace_t trace_range;
256 bool is_after_handoff;
257 ip4_header_t ip4_header;
258 } ip4_full_reass_trace_t;
260 extern vlib_node_registration_t ip4_full_reass_node;
261 extern vlib_node_registration_t ip4_full_reass_node_feature;
262 extern vlib_node_registration_t ip4_full_reass_node_custom;
265 ip4_full_reass_trace_details (vlib_main_t * vm, u32 bi,
266 ip4_full_reass_range_trace_t * trace)
268 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
269 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
270 trace->range_first = vnb->ip.reass.range_first;
271 trace->range_last = vnb->ip.reass.range_last;
272 trace->data_offset = ip4_full_reass_buffer_get_data_offset (b);
273 trace->data_len = ip4_full_reass_buffer_get_data_len (b);
274 trace->range_bi = bi;
278 format_ip4_full_reass_range_trace (u8 * s, va_list * args)
280 ip4_full_reass_range_trace_t *trace =
281 va_arg (*args, ip4_full_reass_range_trace_t *);
283 format (s, "range: [%u, %u], off %d, len %u, bi %u", trace->range_first,
284 trace->range_last, trace->data_offset, trace->data_len,
290 format_ip4_full_reass_trace (u8 * s, va_list * args)
292 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
293 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
294 ip4_full_reass_trace_t *t = va_arg (*args, ip4_full_reass_trace_t *);
296 if (~0 != t->reass_id)
298 if (t->is_after_handoff)
301 format (s, "%U\n", format_ip4_header, &t->ip4_header,
302 sizeof (t->ip4_header));
306 format (s, "%Ureass id: %u, op id: %u, ", format_white_space, indent,
307 t->reass_id, t->op_id);
308 indent = format_get_indent (s);
311 "first bi: %u, data len: %u, ip/fragment[%u, %u]",
312 t->trace_range.first_bi, t->total_data_len, t->fragment_first,
318 s = format (s, "\n%Ushrink %U by %u", format_white_space, indent,
319 format_ip4_full_reass_range_trace, &t->trace_range,
323 s = format (s, "\n%Udiscard %U", format_white_space, indent,
324 format_ip4_full_reass_range_trace, &t->trace_range);
327 s = format (s, "\n%Unew %U", format_white_space, indent,
328 format_ip4_full_reass_range_trace, &t->trace_range);
331 s = format (s, "\n%Uoverlapping/ignored %U", format_white_space, indent,
332 format_ip4_full_reass_range_trace, &t->trace_range);
335 s = format (s, "\n%Ufinalize reassembly", format_white_space, indent);
339 format (s, "handoff from thread #%u to thread #%u", t->thread_id,
343 s = format (s, "passthrough - not a fragment");
350 ip4_full_reass_add_trace (vlib_main_t * vm, vlib_node_runtime_t * node,
351 ip4_full_reass_t * reass, u32 bi,
352 ip4_full_reass_trace_operation_e action,
353 u32 size_diff, u32 thread_id_to)
355 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
356 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
357 if (pool_is_free_index
358 (vm->trace_main.trace_buffer_pool, vlib_buffer_get_trace_index (b)))
360 // this buffer's trace is gone
361 b->flags &= ~VLIB_BUFFER_IS_TRACED;
364 bool is_after_handoff = false;
365 if (vlib_buffer_get_trace_thread (b) != vm->thread_index)
367 is_after_handoff = true;
369 ip4_full_reass_trace_t *t = vlib_add_trace (vm, node, b, sizeof (t[0]));
370 t->is_after_handoff = is_after_handoff;
371 if (t->is_after_handoff)
373 clib_memcpy (&t->ip4_header, vlib_buffer_get_current (b),
374 clib_min (sizeof (t->ip4_header), b->current_length));
378 t->reass_id = reass->id;
379 t->op_id = reass->trace_op_counter;
380 t->trace_range.first_bi = reass->first_bi;
381 t->total_data_len = reass->data_len;
382 ++reass->trace_op_counter;
388 t->trace_range.first_bi = 0;
389 t->total_data_len = 0;
392 ip4_full_reass_trace_details (vm, bi, &t->trace_range);
393 t->size_diff = size_diff;
394 t->thread_id = vm->thread_index;
395 t->thread_id_to = thread_id_to;
396 t->fragment_first = vnb->ip.reass.fragment_first;
397 t->fragment_last = vnb->ip.reass.fragment_last;
400 s = format (s, "%U", format_ip4_full_reass_trace, NULL, NULL, t);
401 printf ("%.*s\n", vec_len (s), s);
403 vec_reset_length (s);
408 ip4_full_reass_free_ctx (ip4_full_reass_per_thread_t * rt,
409 ip4_full_reass_t * reass)
411 pool_put (rt->pool, reass);
416 ip4_full_reass_free (ip4_full_reass_main_t * rm,
417 ip4_full_reass_per_thread_t * rt,
418 ip4_full_reass_t * reass)
420 clib_bihash_kv_16_8_t kv;
421 kv.key[0] = reass->key.as_u64[0];
422 kv.key[1] = reass->key.as_u64[1];
423 clib_bihash_add_del_16_8 (&rm->hash, &kv, 0);
424 return ip4_full_reass_free_ctx (rt, reass);
427 /* n_left_to_next, and to_next are taken as input params, as this function
428 * could be called from a graphnode, where its managing local copy of these
429 * variables, and ignoring those and still trying to enqueue the buffers
430 * with local variables would cause either buffer leak or corruption */
432 ip4_full_reass_drop_all (vlib_main_t *vm, vlib_node_runtime_t *node,
433 ip4_full_reass_t *reass, u32 *n_left_to_next,
436 u32 range_bi = reass->first_bi;
437 vlib_buffer_t *range_b;
438 vnet_buffer_opaque_t *range_vnb;
441 while (~0 != range_bi)
443 range_b = vlib_get_buffer (vm, range_bi);
444 range_vnb = vnet_buffer (range_b);
448 vec_add1 (to_free, range_bi);
451 range_bi = range_vnb->ip.reass.next_range_bi;
454 /* send to next_error_index */
455 if (~0 != reass->error_next_index &&
456 reass->error_next_index < node->n_next_nodes)
460 next_index = reass->error_next_index;
463 /* record number of packets sent to custom app */
464 vlib_node_increment_counter (vm, node->node_index,
465 IP4_ERROR_REASS_TO_CUSTOM_APP,
468 while (vec_len (to_free) > 0)
470 vlib_get_next_frame (vm, node, next_index, *to_next,
473 while (vec_len (to_free) > 0 && (*n_left_to_next) > 0)
475 bi = vec_pop (to_free);
479 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
480 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
482 ip4_full_reass_add_trace (vm, node, reass, bi,
483 RANGE_DISCARD, 0, ~0);
487 (*n_left_to_next) -= 1;
490 vlib_put_next_frame (vm, node, next_index, (*n_left_to_next));
495 vlib_buffer_free (vm, to_free, vec_len (to_free));
501 sanitize_reass_buffers_add_missing (vlib_main_t *vm, ip4_full_reass_t *reass,
504 u32 range_bi = reass->first_bi;
505 vlib_buffer_t *range_b;
506 vnet_buffer_opaque_t *range_vnb;
508 while (~0 != range_bi)
510 range_b = vlib_get_buffer (vm, range_bi);
511 range_vnb = vnet_buffer (range_b);
517 if (range_b->flags & VLIB_BUFFER_NEXT_PRESENT)
520 vlib_buffer_t *_b = vlib_get_buffer (vm, _bi);
521 while (_b->flags & VLIB_BUFFER_NEXT_PRESENT)
523 if (_b->next_buffer != range_vnb->ip.reass.next_range_bi)
525 _bi = _b->next_buffer;
526 _b = vlib_get_buffer (vm, _bi);
530 _b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
535 range_bi = range_vnb->ip.reass.next_range_bi;
540 vlib_buffer_t *fb = vlib_get_buffer (vm, *bi0);
541 vnet_buffer_opaque_t *fvnb = vnet_buffer (fb);
542 if (~0 != reass->first_bi)
544 fvnb->ip.reass.next_range_bi = reass->first_bi;
545 reass->first_bi = *bi0;
549 reass->first_bi = *bi0;
550 fvnb->ip.reass.next_range_bi = ~0;
557 ip4_full_reass_init (ip4_full_reass_t * reass)
559 reass->first_bi = ~0;
560 reass->last_packet_octet = ~0;
562 reass->next_index = ~0;
563 reass->error_next_index = ~0;
566 always_inline ip4_full_reass_t *
567 ip4_full_reass_find_or_create (vlib_main_t *vm, vlib_node_runtime_t *node,
568 ip4_full_reass_main_t *rm,
569 ip4_full_reass_per_thread_t *rt,
570 ip4_full_reass_kv_t *kv, u8 *do_handoff,
571 u32 *n_left_to_next, u32 **to_next)
573 ip4_full_reass_t *reass;
579 now = vlib_time_now (vm);
580 if (!clib_bihash_search_16_8 (&rm->hash, &kv->kv, &kv->kv))
582 if (vm->thread_index != kv->v.memory_owner_thread_index)
588 pool_elt_at_index (rm->per_thread_data
589 [kv->v.memory_owner_thread_index].pool,
592 if (now > reass->last_heard + rm->timeout)
594 vlib_node_increment_counter (vm, node->node_index,
595 IP4_ERROR_REASS_TIMEOUT, 1);
596 ip4_full_reass_drop_all (vm, node, reass, n_left_to_next, to_next);
597 ip4_full_reass_free (rm, rt, reass);
604 reass->last_heard = now;
608 if (rt->reass_n >= rm->max_reass_n)
615 pool_get (rt->pool, reass);
616 clib_memset (reass, 0, sizeof (*reass));
617 reass->id = ((u64) vm->thread_index * 1000000000) + rt->id_counter;
618 reass->memory_owner_thread_index = vm->thread_index;
620 ip4_full_reass_init (reass);
624 reass->key.as_u64[0] = kv->kv.key[0];
625 reass->key.as_u64[1] = kv->kv.key[1];
626 kv->v.reass_index = (reass - rt->pool);
627 kv->v.memory_owner_thread_index = vm->thread_index;
628 reass->last_heard = now;
630 int rv = clib_bihash_add_del_16_8 (&rm->hash, &kv->kv, 2);
633 ip4_full_reass_free_ctx (rt, reass);
635 // if other worker created a context already work with the other copy
643 always_inline ip4_full_reass_rc_t
644 ip4_full_reass_finalize (vlib_main_t * vm, vlib_node_runtime_t * node,
645 ip4_full_reass_main_t * rm,
646 ip4_full_reass_per_thread_t * rt,
647 ip4_full_reass_t * reass, u32 * bi0,
648 u32 * next0, u32 * error0, bool is_custom)
650 vlib_buffer_t *first_b = vlib_get_buffer (vm, reass->first_bi);
651 vlib_buffer_t *last_b = NULL;
652 u32 sub_chain_bi = reass->first_bi;
653 u32 total_length = 0;
657 u32 tmp_bi = sub_chain_bi;
658 vlib_buffer_t *tmp = vlib_get_buffer (vm, tmp_bi);
659 ip4_header_t *ip = vlib_buffer_get_current (tmp);
660 vnet_buffer_opaque_t *vnb = vnet_buffer (tmp);
661 if (!(vnb->ip.reass.range_first >= vnb->ip.reass.fragment_first) &&
662 !(vnb->ip.reass.range_last > vnb->ip.reass.fragment_first))
664 return IP4_REASS_RC_INTERNAL_ERROR;
667 u32 data_len = ip4_full_reass_buffer_get_data_len (tmp);
669 ip4_header_bytes (ip) + ip4_full_reass_buffer_get_data_offset (tmp);
671 vlib_buffer_length_in_chain (vm, tmp) - trim_front - data_len;
672 if (tmp_bi == reass->first_bi)
674 /* first buffer - keep ip4 header */
675 if (0 != ip4_full_reass_buffer_get_data_offset (tmp))
677 return IP4_REASS_RC_INTERNAL_ERROR;
680 trim_end = vlib_buffer_length_in_chain (vm, tmp) - data_len -
681 ip4_header_bytes (ip);
682 if (!(vlib_buffer_length_in_chain (vm, tmp) - trim_end > 0))
684 return IP4_REASS_RC_INTERNAL_ERROR;
688 vlib_buffer_length_in_chain (vm, tmp) - trim_front - trim_end;
694 if (trim_front > tmp->current_length)
696 /* drop whole buffer */
697 u32 to_be_freed_bi = tmp_bi;
698 trim_front -= tmp->current_length;
699 if (!(tmp->flags & VLIB_BUFFER_NEXT_PRESENT))
701 return IP4_REASS_RC_INTERNAL_ERROR;
703 tmp->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
704 tmp_bi = tmp->next_buffer;
705 tmp->next_buffer = 0;
706 tmp = vlib_get_buffer (vm, tmp_bi);
707 vlib_buffer_free_one (vm, to_be_freed_bi);
712 vlib_buffer_advance (tmp, trim_front);
720 last_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
721 last_b->next_buffer = tmp_bi;
724 if (keep_data <= tmp->current_length)
726 tmp->current_length = keep_data;
731 keep_data -= tmp->current_length;
732 if (!(tmp->flags & VLIB_BUFFER_NEXT_PRESENT))
734 return IP4_REASS_RC_INTERNAL_ERROR;
737 total_length += tmp->current_length;
738 if (tmp->flags & VLIB_BUFFER_NEXT_PRESENT)
740 tmp_bi = tmp->next_buffer;
741 tmp = vlib_get_buffer (vm, tmp->next_buffer);
750 u32 to_be_freed_bi = tmp_bi;
751 if (reass->first_bi == tmp_bi)
753 return IP4_REASS_RC_INTERNAL_ERROR;
755 if (tmp->flags & VLIB_BUFFER_NEXT_PRESENT)
757 tmp->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
758 tmp_bi = tmp->next_buffer;
759 tmp->next_buffer = 0;
760 tmp = vlib_get_buffer (vm, tmp_bi);
761 vlib_buffer_free_one (vm, to_be_freed_bi);
765 tmp->next_buffer = 0;
766 vlib_buffer_free_one (vm, to_be_freed_bi);
772 vnet_buffer (vlib_get_buffer (vm, sub_chain_bi))->ip.
775 while (~0 != sub_chain_bi);
779 return IP4_REASS_RC_INTERNAL_ERROR;
781 last_b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
783 if (total_length < first_b->current_length)
785 return IP4_REASS_RC_INTERNAL_ERROR;
787 total_length -= first_b->current_length;
788 first_b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
789 first_b->total_length_not_including_first_buffer = total_length;
790 ip4_header_t *ip = vlib_buffer_get_current (first_b);
791 ip->flags_and_fragment_offset = 0;
792 ip->length = clib_host_to_net_u16 (first_b->current_length + total_length);
793 ip->checksum = ip4_header_checksum (ip);
794 if (!vlib_buffer_chain_linearize (vm, first_b))
796 return IP4_REASS_RC_NO_BUF;
798 // reset to reconstruct the mbuf linking
799 first_b->flags &= ~VLIB_BUFFER_EXT_HDR_VALID;
800 if (PREDICT_FALSE (first_b->flags & VLIB_BUFFER_IS_TRACED))
802 ip4_full_reass_add_trace (vm, node, reass, reass->first_bi, FINALIZE, 0,
805 // following code does a hexdump of packet fragments to stdout ...
808 u32 bi = reass->first_bi;
812 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
813 s = format (s, "%u: %U\n", bi, format_hexdump,
814 vlib_buffer_get_current (b), b->current_length);
815 if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
824 printf ("%.*s\n", vec_len (s), s);
831 *bi0 = reass->first_bi;
834 *next0 = IP4_FULL_REASS_NEXT_INPUT;
838 *next0 = reass->next_index;
840 vnet_buffer (first_b)->ip.reass.estimated_mtu = reass->min_fragment_length;
842 /* Keep track of number of successfully reassembled packets and number of
843 * fragments reassembled */
844 vlib_node_increment_counter (vm, node->node_index, IP4_ERROR_REASS_SUCCESS,
847 vlib_node_increment_counter (vm, node->node_index,
848 IP4_ERROR_REASS_FRAGMENTS_REASSEMBLED,
851 *error0 = IP4_ERROR_NONE;
852 ip4_full_reass_free (rm, rt, reass);
854 return IP4_REASS_RC_OK;
857 always_inline ip4_full_reass_rc_t
858 ip4_full_reass_insert_range_in_chain (vlib_main_t * vm,
859 ip4_full_reass_t * reass,
860 u32 prev_range_bi, u32 new_next_bi)
862 vlib_buffer_t *new_next_b = vlib_get_buffer (vm, new_next_bi);
863 vnet_buffer_opaque_t *new_next_vnb = vnet_buffer (new_next_b);
864 if (~0 != prev_range_bi)
866 vlib_buffer_t *prev_b = vlib_get_buffer (vm, prev_range_bi);
867 vnet_buffer_opaque_t *prev_vnb = vnet_buffer (prev_b);
868 new_next_vnb->ip.reass.next_range_bi = prev_vnb->ip.reass.next_range_bi;
869 prev_vnb->ip.reass.next_range_bi = new_next_bi;
873 if (~0 != reass->first_bi)
875 new_next_vnb->ip.reass.next_range_bi = reass->first_bi;
877 reass->first_bi = new_next_bi;
879 vnet_buffer_opaque_t *vnb = vnet_buffer (new_next_b);
880 if (!(vnb->ip.reass.range_first >= vnb->ip.reass.fragment_first) &&
881 !(vnb->ip.reass.range_last > vnb->ip.reass.fragment_first))
883 return IP4_REASS_RC_INTERNAL_ERROR;
885 reass->data_len += ip4_full_reass_buffer_get_data_len (new_next_b);
886 return IP4_REASS_RC_OK;
889 always_inline ip4_full_reass_rc_t
890 ip4_full_reass_remove_range_from_chain (vlib_main_t * vm,
891 vlib_node_runtime_t * node,
892 ip4_full_reass_t * reass,
893 u32 prev_range_bi, u32 discard_bi)
895 vlib_buffer_t *discard_b = vlib_get_buffer (vm, discard_bi);
896 vnet_buffer_opaque_t *discard_vnb = vnet_buffer (discard_b);
897 if (~0 != prev_range_bi)
899 vlib_buffer_t *prev_b = vlib_get_buffer (vm, prev_range_bi);
900 vnet_buffer_opaque_t *prev_vnb = vnet_buffer (prev_b);
901 if (!(prev_vnb->ip.reass.next_range_bi == discard_bi))
903 return IP4_REASS_RC_INTERNAL_ERROR;
905 prev_vnb->ip.reass.next_range_bi = discard_vnb->ip.reass.next_range_bi;
909 reass->first_bi = discard_vnb->ip.reass.next_range_bi;
911 vnet_buffer_opaque_t *vnb = vnet_buffer (discard_b);
912 if (!(vnb->ip.reass.range_first >= vnb->ip.reass.fragment_first) &&
913 !(vnb->ip.reass.range_last > vnb->ip.reass.fragment_first))
915 return IP4_REASS_RC_INTERNAL_ERROR;
917 reass->data_len -= ip4_full_reass_buffer_get_data_len (discard_b);
920 u32 to_be_freed_bi = discard_bi;
921 if (PREDICT_FALSE (discard_b->flags & VLIB_BUFFER_IS_TRACED))
923 ip4_full_reass_add_trace (vm, node, reass, discard_bi, RANGE_DISCARD,
926 if (discard_b->flags & VLIB_BUFFER_NEXT_PRESENT)
928 discard_b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
929 discard_bi = discard_b->next_buffer;
930 discard_b->next_buffer = 0;
931 discard_b = vlib_get_buffer (vm, discard_bi);
932 vlib_buffer_free_one (vm, to_be_freed_bi);
936 discard_b->next_buffer = 0;
937 vlib_buffer_free_one (vm, to_be_freed_bi);
941 return IP4_REASS_RC_OK;
944 always_inline ip4_full_reass_rc_t
945 ip4_full_reass_update (vlib_main_t * vm, vlib_node_runtime_t * node,
946 ip4_full_reass_main_t * rm,
947 ip4_full_reass_per_thread_t * rt,
948 ip4_full_reass_t * reass, u32 * bi0, u32 * next0,
949 u32 * error0, bool is_custom, u32 * handoff_thread_idx)
951 vlib_buffer_t *fb = vlib_get_buffer (vm, *bi0);
952 vnet_buffer_opaque_t *fvnb = vnet_buffer (fb);
955 // store (error_)next_index before it's overwritten
956 reass->next_index = fvnb->ip.reass.next_index;
957 reass->error_next_index = fvnb->ip.reass.error_next_index;
959 ip4_full_reass_rc_t rc = IP4_REASS_RC_OK;
961 ip4_header_t *fip = vlib_buffer_get_current (fb);
962 const u32 fragment_first = ip4_get_fragment_offset_bytes (fip);
963 const u32 fragment_length =
964 clib_net_to_host_u16 (fip->length) - ip4_header_bytes (fip);
965 const u32 fragment_last = fragment_first + fragment_length - 1;
966 fvnb->ip.reass.fragment_first = fragment_first;
967 fvnb->ip.reass.fragment_last = fragment_last;
968 int more_fragments = ip4_get_fragment_more (fip);
969 u32 candidate_range_bi = reass->first_bi;
970 u32 prev_range_bi = ~0;
971 fvnb->ip.reass.range_first = fragment_first;
972 fvnb->ip.reass.range_last = fragment_last;
973 fvnb->ip.reass.next_range_bi = ~0;
976 reass->last_packet_octet = fragment_last;
978 if (~0 == reass->first_bi)
980 // starting a new reassembly
982 ip4_full_reass_insert_range_in_chain (vm, reass, prev_range_bi, *bi0);
983 if (IP4_REASS_RC_OK != rc)
987 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
989 ip4_full_reass_add_trace (vm, node, reass, *bi0, RANGE_NEW, 0, ~0);
992 reass->min_fragment_length = clib_net_to_host_u16 (fip->length);
993 reass->fragments_n = 1;
994 return IP4_REASS_RC_OK;
996 reass->min_fragment_length =
997 clib_min (clib_net_to_host_u16 (fip->length),
998 fvnb->ip.reass.estimated_mtu);
999 while (~0 != candidate_range_bi)
1001 vlib_buffer_t *candidate_b = vlib_get_buffer (vm, candidate_range_bi);
1002 vnet_buffer_opaque_t *candidate_vnb = vnet_buffer (candidate_b);
1003 if (fragment_first > candidate_vnb->ip.reass.range_last)
1005 // this fragments starts after candidate range
1006 prev_range_bi = candidate_range_bi;
1007 candidate_range_bi = candidate_vnb->ip.reass.next_range_bi;
1008 if (candidate_vnb->ip.reass.range_last < fragment_last &&
1009 ~0 == candidate_range_bi)
1011 // special case - this fragment falls beyond all known ranges
1012 rc = ip4_full_reass_insert_range_in_chain (vm, reass,
1013 prev_range_bi, *bi0);
1014 if (IP4_REASS_RC_OK != rc)
1023 if (fragment_last < candidate_vnb->ip.reass.range_first)
1025 // this fragment ends before candidate range without any overlap
1026 rc = ip4_full_reass_insert_range_in_chain (vm, reass, prev_range_bi,
1028 if (IP4_REASS_RC_OK != rc)
1036 if (fragment_first >= candidate_vnb->ip.reass.range_first &&
1037 fragment_last <= candidate_vnb->ip.reass.range_last)
1039 // this fragment is a (sub)part of existing range, ignore it
1040 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
1042 ip4_full_reass_add_trace (vm, node, reass, *bi0,
1043 RANGE_OVERLAP, 0, ~0);
1047 int discard_candidate = 0;
1048 if (fragment_first < candidate_vnb->ip.reass.range_first)
1051 fragment_last - candidate_vnb->ip.reass.range_first + 1;
1052 if (overlap < ip4_full_reass_buffer_get_data_len (candidate_b))
1054 candidate_vnb->ip.reass.range_first += overlap;
1055 if (reass->data_len < overlap)
1057 return IP4_REASS_RC_INTERNAL_ERROR;
1059 reass->data_len -= overlap;
1060 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
1062 ip4_full_reass_add_trace (vm, node, reass,
1064 RANGE_SHRINK, 0, ~0);
1066 rc = ip4_full_reass_insert_range_in_chain (
1067 vm, reass, prev_range_bi, *bi0);
1068 if (IP4_REASS_RC_OK != rc)
1076 discard_candidate = 1;
1079 else if (fragment_last > candidate_vnb->ip.reass.range_last)
1082 candidate_vnb->ip.reass.range_last - fragment_first + 1;
1083 if (overlap < ip4_full_reass_buffer_get_data_len (candidate_b))
1085 fvnb->ip.reass.range_first += overlap;
1086 if (~0 != candidate_vnb->ip.reass.next_range_bi)
1088 prev_range_bi = candidate_range_bi;
1089 candidate_range_bi =
1090 candidate_vnb->ip.reass.next_range_bi;
1095 // special case - last range discarded
1096 rc = ip4_full_reass_insert_range_in_chain (
1097 vm, reass, candidate_range_bi, *bi0);
1098 if (IP4_REASS_RC_OK != rc)
1107 discard_candidate = 1;
1112 discard_candidate = 1;
1114 if (discard_candidate)
1116 u32 next_range_bi = candidate_vnb->ip.reass.next_range_bi;
1117 // discard candidate range, probe next range
1118 rc = ip4_full_reass_remove_range_from_chain (
1119 vm, node, reass, prev_range_bi, candidate_range_bi);
1120 if (IP4_REASS_RC_OK != rc)
1124 if (~0 != next_range_bi)
1126 candidate_range_bi = next_range_bi;
1131 // special case - last range discarded
1132 rc = ip4_full_reass_insert_range_in_chain (
1133 vm, reass, prev_range_bi, *bi0);
1134 if (IP4_REASS_RC_OK != rc)
1144 ++reass->fragments_n;
1147 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
1149 ip4_full_reass_add_trace (vm, node, reass, *bi0, RANGE_NEW, 0, ~0);
1152 if (~0 != reass->last_packet_octet &&
1153 reass->data_len == reass->last_packet_octet + 1)
1155 *handoff_thread_idx = reass->sendout_thread_index;
1157 reass->memory_owner_thread_index != reass->sendout_thread_index;
1159 ip4_full_reass_finalize (vm, node, rm, rt, reass, bi0, next0, error0,
1161 if (IP4_REASS_RC_OK == rc && handoff)
1163 rc = IP4_REASS_RC_HANDOFF;
1171 if (reass->fragments_n > rm->max_reass_len)
1173 rc = IP4_REASS_RC_TOO_MANY_FRAGMENTS;
1178 *next0 = IP4_FULL_REASS_NEXT_DROP;
1179 *error0 = IP4_ERROR_REASS_DUPLICATE_FRAGMENT;
1186 ip4_full_reass_inline (vlib_main_t *vm, vlib_node_runtime_t *node,
1187 vlib_frame_t *frame, ip4_full_reass_node_type_t type,
1190 u32 *from = vlib_frame_vector_args (frame);
1191 u32 n_left_from, n_left_to_next, *to_next, next_index;
1192 ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1193 ip4_full_reass_per_thread_t *rt = &rm->per_thread_data[vm->thread_index];
1194 clib_spinlock_lock (&rt->lock);
1196 n_left_from = frame->n_vectors;
1197 next_index = node->cached_next_index;
1198 while (n_left_from > 0)
1200 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
1202 while (n_left_from > 0 && n_left_to_next > 0)
1207 u32 error0 = IP4_ERROR_NONE;
1210 b0 = vlib_get_buffer (vm, bi0);
1212 ip4_header_t *ip0 = vlib_buffer_get_current (b0);
1213 if (!ip4_get_fragment_more (ip0) && !ip4_get_fragment_offset (ip0))
1215 // this is a whole packet - no fragmentation
1218 next0 = IP4_FULL_REASS_NEXT_INPUT;
1222 next0 = vnet_buffer (b0)->ip.reass.next_index;
1224 ip4_full_reass_add_trace (vm, node, NULL, bi0, PASSTHROUGH, 0,
1226 goto packet_enqueue;
1229 if (is_local && !rm->is_local_reass_enabled)
1231 next0 = IP4_FULL_REASS_NEXT_DROP;
1232 goto packet_enqueue;
1235 const u32 fragment_first = ip4_get_fragment_offset_bytes (ip0);
1236 const u32 fragment_length =
1237 clib_net_to_host_u16 (ip0->length) - ip4_header_bytes (ip0);
1238 const u32 fragment_last = fragment_first + fragment_length - 1;
1240 /* Keep track of received fragments */
1241 vlib_node_increment_counter (vm, node->node_index,
1242 IP4_ERROR_REASS_FRAGMENTS_RCVD, 1);
1244 if (fragment_first > fragment_last ||
1245 fragment_first + fragment_length > UINT16_MAX - 20 ||
1246 (fragment_length < 8 && // 8 is minimum frag length per RFC 791
1247 ip4_get_fragment_more (ip0)))
1249 next0 = IP4_FULL_REASS_NEXT_DROP;
1250 error0 = IP4_ERROR_REASS_MALFORMED_PACKET;
1251 goto packet_enqueue;
1253 ip4_full_reass_kv_t kv;
1257 (u64) vec_elt (ip4_main.fib_index_by_sw_if_index,
1258 vnet_buffer (b0)->sw_if_index[VLIB_RX]) |
1259 (u64) ip0->src_address.as_u32 << 32;
1261 (u64) ip0->dst_address.
1262 as_u32 | (u64) ip0->fragment_id << 32 | (u64) ip0->protocol << 48;
1264 ip4_full_reass_t *reass = ip4_full_reass_find_or_create (
1265 vm, node, rm, rt, &kv, &do_handoff, &n_left_to_next, &to_next);
1269 const u32 fragment_first = ip4_get_fragment_offset_bytes (ip0);
1270 if (0 == fragment_first)
1272 reass->sendout_thread_index = vm->thread_index;
1276 if (PREDICT_FALSE (do_handoff))
1278 next0 = IP4_FULL_REASS_NEXT_HANDOFF;
1279 vnet_buffer (b0)->ip.reass.owner_thread_index =
1280 kv.v.memory_owner_thread_index;
1284 u32 handoff_thread_idx;
1286 switch (ip4_full_reass_update
1287 (vm, node, rm, rt, reass, &bi0, &next0,
1288 &error0, CUSTOM == type, &handoff_thread_idx))
1290 case IP4_REASS_RC_OK:
1291 /* nothing to do here */
1293 case IP4_REASS_RC_HANDOFF:
1294 next0 = IP4_FULL_REASS_NEXT_HANDOFF;
1295 b0 = vlib_get_buffer (vm, bi0);
1296 vnet_buffer (b0)->ip.reass.owner_thread_index =
1299 case IP4_REASS_RC_TOO_MANY_FRAGMENTS:
1300 counter = IP4_ERROR_REASS_FRAGMENT_CHAIN_TOO_LONG;
1302 case IP4_REASS_RC_NO_BUF:
1303 counter = IP4_ERROR_REASS_NO_BUF;
1305 case IP4_REASS_RC_INTERNAL_ERROR:
1306 counter = IP4_ERROR_REASS_INTERNAL_ERROR;
1307 /* Sanitization is needed in internal error cases only, as
1308 * the incoming packet is already dropped in other cases,
1309 * also adding bi0 back to the reassembly list, fixes the
1310 * leaking of buffers during internal errors.
1312 * Also it doesnt make sense to send these buffers custom
1313 * app, these fragments are with internal errors */
1314 sanitize_reass_buffers_add_missing (vm, reass, &bi0);
1315 reass->error_next_index = ~0;
1321 vlib_node_increment_counter (vm, node->node_index, counter,
1323 ip4_full_reass_drop_all (vm, node, reass, &n_left_to_next,
1325 ip4_full_reass_free (rm, rt, reass);
1331 next0 = IP4_FULL_REASS_NEXT_DROP;
1332 error0 = IP4_ERROR_REASS_LIMIT_REACHED;
1342 n_left_to_next -= 1;
1344 /* bi0 might have been updated by reass_finalize, reload */
1345 b0 = vlib_get_buffer (vm, bi0);
1346 if (IP4_ERROR_NONE != error0)
1348 b0->error = node->errors[error0];
1351 if (next0 == IP4_FULL_REASS_NEXT_HANDOFF)
1353 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
1355 ip4_full_reass_add_trace (
1356 vm, node, NULL, bi0, HANDOFF, 0,
1357 vnet_buffer (b0)->ip.reass.owner_thread_index);
1360 else if (FEATURE == type && IP4_ERROR_NONE == error0)
1362 vnet_feature_next (&next0, b0);
1365 /* Increment the counter to-custom-app also as this fragment is
1366 * also going to application */
1369 vlib_node_increment_counter (
1370 vm, node->node_index, IP4_ERROR_REASS_TO_CUSTOM_APP, 1);
1373 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
1374 to_next, n_left_to_next,
1376 IP4_REASS_DEBUG_BUFFER (bi0, enqueue_next);
1384 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1387 clib_spinlock_unlock (&rt->lock);
1388 return frame->n_vectors;
1391 VLIB_NODE_FN (ip4_full_reass_node) (vlib_main_t * vm,
1392 vlib_node_runtime_t * node,
1393 vlib_frame_t * frame)
1395 return ip4_full_reass_inline (vm, node, frame, NORMAL, false /* is_local */);
1398 VLIB_REGISTER_NODE (ip4_full_reass_node) = {
1399 .name = "ip4-full-reassembly",
1400 .vector_size = sizeof (u32),
1401 .format_trace = format_ip4_full_reass_trace,
1402 .n_errors = IP4_N_ERROR,
1403 .error_counters = ip4_error_counters,
1404 .n_next_nodes = IP4_FULL_REASS_N_NEXT,
1407 [IP4_FULL_REASS_NEXT_INPUT] = "ip4-input",
1408 [IP4_FULL_REASS_NEXT_DROP] = "ip4-drop",
1409 [IP4_FULL_REASS_NEXT_HANDOFF] = "ip4-full-reassembly-handoff",
1414 VLIB_NODE_FN (ip4_local_full_reass_node)
1415 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
1417 return ip4_full_reass_inline (vm, node, frame, NORMAL, true /* is_local */);
1420 VLIB_REGISTER_NODE (ip4_local_full_reass_node) = {
1421 .name = "ip4-local-full-reassembly",
1422 .vector_size = sizeof (u32),
1423 .format_trace = format_ip4_full_reass_trace,
1424 .n_errors = IP4_N_ERROR,
1425 .error_counters = ip4_error_counters,
1426 .n_next_nodes = IP4_FULL_REASS_N_NEXT,
1429 [IP4_FULL_REASS_NEXT_INPUT] = "ip4-input",
1430 [IP4_FULL_REASS_NEXT_DROP] = "ip4-drop",
1431 [IP4_FULL_REASS_NEXT_HANDOFF] = "ip4-local-full-reassembly-handoff",
1436 VLIB_NODE_FN (ip4_full_reass_node_feature) (vlib_main_t * vm,
1437 vlib_node_runtime_t * node,
1438 vlib_frame_t * frame)
1440 return ip4_full_reass_inline (vm, node, frame, FEATURE,
1441 false /* is_local */);
1444 VLIB_REGISTER_NODE (ip4_full_reass_node_feature) = {
1445 .name = "ip4-full-reassembly-feature",
1446 .vector_size = sizeof (u32),
1447 .format_trace = format_ip4_full_reass_trace,
1448 .n_errors = IP4_N_ERROR,
1449 .error_counters = ip4_error_counters,
1450 .n_next_nodes = IP4_FULL_REASS_N_NEXT,
1453 [IP4_FULL_REASS_NEXT_INPUT] = "ip4-input",
1454 [IP4_FULL_REASS_NEXT_DROP] = "ip4-drop",
1455 [IP4_FULL_REASS_NEXT_HANDOFF] = "ip4-full-reass-feature-hoff",
1459 VNET_FEATURE_INIT (ip4_full_reass_feature, static) = {
1460 .arc_name = "ip4-unicast",
1461 .node_name = "ip4-full-reassembly-feature",
1462 .runs_before = VNET_FEATURES ("ip4-lookup",
1463 "ipsec4-input-feature"),
1467 VLIB_NODE_FN (ip4_full_reass_node_custom) (vlib_main_t * vm,
1468 vlib_node_runtime_t * node,
1469 vlib_frame_t * frame)
1471 return ip4_full_reass_inline (vm, node, frame, CUSTOM, false /* is_local */);
1474 VLIB_REGISTER_NODE (ip4_full_reass_node_custom) = {
1475 .name = "ip4-full-reassembly-custom",
1476 .vector_size = sizeof (u32),
1477 .format_trace = format_ip4_full_reass_trace,
1478 .n_errors = IP4_N_ERROR,
1479 .error_counters = ip4_error_counters,
1480 .n_next_nodes = IP4_FULL_REASS_N_NEXT,
1483 [IP4_FULL_REASS_NEXT_INPUT] = "ip4-input",
1484 [IP4_FULL_REASS_NEXT_DROP] = "ip4-drop",
1485 [IP4_FULL_REASS_NEXT_HANDOFF] = "ip4-full-reass-custom-hoff",
1489 VNET_FEATURE_INIT (ip4_full_reass_custom, static) = {
1490 .arc_name = "ip4-unicast",
1491 .node_name = "ip4-full-reassembly-feature",
1492 .runs_before = VNET_FEATURES ("ip4-lookup",
1493 "ipsec4-input-feature"),
1498 #ifndef CLIB_MARCH_VARIANT
1500 ip4_full_reass_custom_register_next_node (uword node_index)
1502 return vlib_node_add_next (vlib_get_main (),
1503 ip4_full_reass_node_custom.index, node_index);
1507 ip4_full_reass_get_nbuckets ()
1509 ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1513 /* need more mem with more workers */
1514 nbuckets = (u32) (rm->max_reass_n * (vlib_num_workers () + 1) /
1515 IP4_REASS_HT_LOAD_FACTOR);
1517 for (i = 0; i < 31; i++)
1518 if ((1 << i) >= nbuckets)
1524 #endif /* CLIB_MARCH_VARIANT */
1528 IP4_EVENT_CONFIG_CHANGED = 1,
1529 } ip4_full_reass_event_t;
1534 clib_bihash_16_8_t *new_hash;
1535 } ip4_rehash_cb_ctx;
1537 #ifndef CLIB_MARCH_VARIANT
1539 ip4_rehash_cb (clib_bihash_kv_16_8_t * kv, void *_ctx)
1541 ip4_rehash_cb_ctx *ctx = _ctx;
1542 if (clib_bihash_add_del_16_8 (ctx->new_hash, kv, 1))
1546 return (BIHASH_WALK_CONTINUE);
1550 ip4_full_reass_set_params (u32 timeout_ms, u32 max_reassemblies,
1551 u32 max_reassembly_length,
1552 u32 expire_walk_interval_ms)
1554 ip4_full_reass_main.timeout_ms = timeout_ms;
1555 ip4_full_reass_main.timeout = (f64) timeout_ms / (f64) MSEC_PER_SEC;
1556 ip4_full_reass_main.max_reass_n = max_reassemblies;
1557 ip4_full_reass_main.max_reass_len = max_reassembly_length;
1558 ip4_full_reass_main.expire_walk_interval_ms = expire_walk_interval_ms;
1562 ip4_full_reass_set (u32 timeout_ms, u32 max_reassemblies,
1563 u32 max_reassembly_length, u32 expire_walk_interval_ms)
1565 u32 old_nbuckets = ip4_full_reass_get_nbuckets ();
1566 ip4_full_reass_set_params (timeout_ms, max_reassemblies,
1567 max_reassembly_length, expire_walk_interval_ms);
1568 vlib_process_signal_event (ip4_full_reass_main.vlib_main,
1569 ip4_full_reass_main.ip4_full_reass_expire_node_idx,
1570 IP4_EVENT_CONFIG_CHANGED, 0);
1571 u32 new_nbuckets = ip4_full_reass_get_nbuckets ();
1572 if (ip4_full_reass_main.max_reass_n > 0 && new_nbuckets > old_nbuckets)
1574 clib_bihash_16_8_t new_hash;
1575 clib_memset (&new_hash, 0, sizeof (new_hash));
1576 ip4_rehash_cb_ctx ctx;
1578 ctx.new_hash = &new_hash;
1579 clib_bihash_init_16_8 (&new_hash, "ip4-dr", new_nbuckets,
1580 new_nbuckets * 1024);
1581 clib_bihash_foreach_key_value_pair_16_8 (&ip4_full_reass_main.hash,
1582 ip4_rehash_cb, &ctx);
1585 clib_bihash_free_16_8 (&new_hash);
1590 clib_bihash_free_16_8 (&ip4_full_reass_main.hash);
1591 clib_memcpy_fast (&ip4_full_reass_main.hash, &new_hash,
1592 sizeof (ip4_full_reass_main.hash));
1593 clib_bihash_copied (&ip4_full_reass_main.hash, &new_hash);
1600 ip4_full_reass_get (u32 * timeout_ms, u32 * max_reassemblies,
1601 u32 * max_reassembly_length,
1602 u32 * expire_walk_interval_ms)
1604 *timeout_ms = ip4_full_reass_main.timeout_ms;
1605 *max_reassemblies = ip4_full_reass_main.max_reass_n;
1606 *max_reassembly_length = ip4_full_reass_main.max_reass_len;
1607 *expire_walk_interval_ms = ip4_full_reass_main.expire_walk_interval_ms;
1611 static clib_error_t *
1612 ip4_full_reass_init_function (vlib_main_t * vm)
1614 ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1615 clib_error_t *error = 0;
1621 vec_validate (rm->per_thread_data, vlib_num_workers ());
1622 ip4_full_reass_per_thread_t *rt;
1623 vec_foreach (rt, rm->per_thread_data)
1625 clib_spinlock_init (&rt->lock);
1626 pool_alloc (rt->pool, rm->max_reass_n);
1629 node = vlib_get_node_by_name (vm, (u8 *) "ip4-full-reassembly-expire-walk");
1631 rm->ip4_full_reass_expire_node_idx = node->index;
1633 ip4_full_reass_set_params (IP4_REASS_TIMEOUT_DEFAULT_MS,
1634 IP4_REASS_MAX_REASSEMBLIES_DEFAULT,
1635 IP4_REASS_MAX_REASSEMBLY_LENGTH_DEFAULT,
1636 IP4_REASS_EXPIRE_WALK_INTERVAL_DEFAULT_MS);
1638 nbuckets = ip4_full_reass_get_nbuckets ();
1639 clib_bihash_init_16_8 (&rm->hash, "ip4-dr", nbuckets, nbuckets * 1024);
1641 rm->fq_index = vlib_frame_queue_main_init (ip4_full_reass_node.index, 0);
1642 rm->fq_local_index =
1643 vlib_frame_queue_main_init (ip4_local_full_reass_node.index, 0);
1644 rm->fq_feature_index =
1645 vlib_frame_queue_main_init (ip4_full_reass_node_feature.index, 0);
1646 rm->fq_custom_index =
1647 vlib_frame_queue_main_init (ip4_full_reass_node_custom.index, 0);
1649 rm->feature_use_refcount_per_intf = NULL;
1650 rm->is_local_reass_enabled = 1;
1655 VLIB_INIT_FUNCTION (ip4_full_reass_init_function);
1656 #endif /* CLIB_MARCH_VARIANT */
1659 ip4_full_reass_walk_expired (vlib_main_t *vm, vlib_node_runtime_t *node,
1660 CLIB_UNUSED (vlib_frame_t *f))
1662 ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1663 uword event_type, *event_data = 0;
1667 vlib_process_wait_for_event_or_clock (vm,
1669 rm->expire_walk_interval_ms /
1670 (f64) MSEC_PER_SEC);
1671 event_type = vlib_process_get_events (vm, &event_data);
1676 /* no events => timeout */
1678 case IP4_EVENT_CONFIG_CHANGED:
1679 /* nothing to do here */
1682 clib_warning ("BUG: event type 0x%wx", event_type);
1685 f64 now = vlib_time_now (vm);
1687 ip4_full_reass_t *reass;
1688 int *pool_indexes_to_free = NULL;
1690 uword thread_index = 0;
1692 const uword nthreads = vlib_num_workers () + 1;
1693 u32 n_left_to_next, *to_next;
1695 for (thread_index = 0; thread_index < nthreads; ++thread_index)
1697 ip4_full_reass_per_thread_t *rt =
1698 &rm->per_thread_data[thread_index];
1699 clib_spinlock_lock (&rt->lock);
1701 vec_reset_length (pool_indexes_to_free);
1703 /* Pace the number of timeouts handled per thread,to avoid barrier
1704 * sync issues in real world scenarios */
1706 u32 beg = rt->last_id;
1707 /* to ensure we walk at least once per sec per context */
1709 beg + (IP4_REASS_MAX_REASSEMBLIES_DEFAULT *
1710 IP4_REASS_EXPIRE_WALK_INTERVAL_DEFAULT_MS / MSEC_PER_SEC +
1712 if (end > vec_len (rt->pool))
1714 end = vec_len (rt->pool);
1722 pool_foreach_stepping_index (index, beg, end, rt->pool)
1724 reass = pool_elt_at_index (rt->pool, index);
1725 if (now > reass->last_heard + rm->timeout)
1727 vec_add1 (pool_indexes_to_free, index);
1731 if (vec_len (pool_indexes_to_free))
1732 vlib_node_increment_counter (vm, node->node_index,
1733 IP4_ERROR_REASS_TIMEOUT,
1734 vec_len (pool_indexes_to_free));
1736 vec_foreach (i, pool_indexes_to_free)
1738 ip4_full_reass_t *reass = pool_elt_at_index (rt->pool, i[0]);
1739 ip4_full_reass_drop_all (vm, node, reass, &n_left_to_next,
1741 ip4_full_reass_free (rm, rt, reass);
1744 clib_spinlock_unlock (&rt->lock);
1747 vec_free (pool_indexes_to_free);
1750 vec_set_len (event_data, 0);
1757 VLIB_REGISTER_NODE (ip4_full_reass_expire_node) = {
1758 .function = ip4_full_reass_walk_expired,
1759 .type = VLIB_NODE_TYPE_PROCESS,
1760 .name = "ip4-full-reassembly-expire-walk",
1761 .format_trace = format_ip4_full_reass_trace,
1762 .n_errors = IP4_N_ERROR,
1763 .error_counters = ip4_error_counters,
1767 format_ip4_full_reass_key (u8 * s, va_list * args)
1769 ip4_full_reass_key_t *key = va_arg (*args, ip4_full_reass_key_t *);
1772 "xx_id: %u, src: %U, dst: %U, frag_id: %u, proto: %u",
1773 key->xx_id, format_ip4_address, &key->src, format_ip4_address,
1774 &key->dst, clib_net_to_host_u16 (key->frag_id), key->proto);
1779 format_ip4_reass (u8 * s, va_list * args)
1781 vlib_main_t *vm = va_arg (*args, vlib_main_t *);
1782 ip4_full_reass_t *reass = va_arg (*args, ip4_full_reass_t *);
1784 s = format (s, "ID: %lu, key: %U\n first_bi: %u, data_len: %u, "
1785 "last_packet_octet: %u, trace_op_counter: %u\n",
1786 reass->id, format_ip4_full_reass_key, &reass->key,
1787 reass->first_bi, reass->data_len,
1788 reass->last_packet_octet, reass->trace_op_counter);
1790 u32 bi = reass->first_bi;
1794 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
1795 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
1798 " #%03u: range: [%u, %u], bi: %u, off: %d, len: %u, "
1799 "fragment[%u, %u]\n", counter, vnb->ip.reass.range_first,
1800 vnb->ip.reass.range_last, bi,
1801 ip4_full_reass_buffer_get_data_offset (b),
1802 ip4_full_reass_buffer_get_data_len (b),
1803 vnb->ip.reass.fragment_first, vnb->ip.reass.fragment_last);
1804 if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
1806 bi = b->next_buffer;
1816 static clib_error_t *
1817 show_ip4_reass (vlib_main_t * vm,
1818 unformat_input_t * input,
1819 CLIB_UNUSED (vlib_cli_command_t * lmd))
1821 ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1823 vlib_cli_output (vm, "---------------------");
1824 vlib_cli_output (vm, "IP4 reassembly status");
1825 vlib_cli_output (vm, "---------------------");
1826 bool details = false;
1827 if (unformat (input, "details"))
1832 u32 sum_reass_n = 0;
1833 ip4_full_reass_t *reass;
1835 const uword nthreads = vlib_num_workers () + 1;
1836 for (thread_index = 0; thread_index < nthreads; ++thread_index)
1838 ip4_full_reass_per_thread_t *rt = &rm->per_thread_data[thread_index];
1839 clib_spinlock_lock (&rt->lock);
1842 pool_foreach (reass, rt->pool) {
1843 vlib_cli_output (vm, "%U", format_ip4_reass, vm, reass);
1846 sum_reass_n += rt->reass_n;
1847 clib_spinlock_unlock (&rt->lock);
1849 vlib_cli_output (vm, "---------------------");
1850 vlib_cli_output (vm, "Current full IP4 reassemblies count: %lu\n",
1851 (long unsigned) sum_reass_n);
1852 vlib_cli_output (vm,
1853 "Maximum configured concurrent full IP4 reassemblies per worker-thread: %lu\n",
1854 (long unsigned) rm->max_reass_n);
1855 vlib_cli_output (vm,
1856 "Maximum configured amount of fragments "
1857 "per full IP4 reassembly: %lu\n",
1858 (long unsigned) rm->max_reass_len);
1859 vlib_cli_output (vm,
1860 "Maximum configured full IP4 reassembly timeout: %lums\n",
1861 (long unsigned) rm->timeout_ms);
1862 vlib_cli_output (vm,
1863 "Maximum configured full IP4 reassembly expire walk interval: %lums\n",
1864 (long unsigned) rm->expire_walk_interval_ms);
1868 VLIB_CLI_COMMAND (show_ip4_full_reass_cmd, static) = {
1869 .path = "show ip4-full-reassembly",
1870 .short_help = "show ip4-full-reassembly [details]",
1871 .function = show_ip4_reass,
1874 #ifndef CLIB_MARCH_VARIANT
1876 ip4_full_reass_enable_disable (u32 sw_if_index, u8 enable_disable)
1878 return vnet_feature_enable_disable ("ip4-unicast",
1879 "ip4-full-reassembly-feature",
1880 sw_if_index, enable_disable, 0, 0);
1882 #endif /* CLIB_MARCH_VARIANT */
1885 #define foreach_ip4_full_reass_handoff_error \
1886 _(CONGESTION_DROP, "congestion drop")
1891 #define _(sym,str) IP4_FULL_REASS_HANDOFF_ERROR_##sym,
1892 foreach_ip4_full_reass_handoff_error
1894 IP4_FULL_REASS_HANDOFF_N_ERROR,
1895 } ip4_full_reass_handoff_error_t;
1897 static char *ip4_full_reass_handoff_error_strings[] = {
1898 #define _(sym,string) string,
1899 foreach_ip4_full_reass_handoff_error
1905 u32 next_worker_index;
1906 } ip4_full_reass_handoff_trace_t;
1909 format_ip4_full_reass_handoff_trace (u8 * s, va_list * args)
1911 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
1912 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
1913 ip4_full_reass_handoff_trace_t *t =
1914 va_arg (*args, ip4_full_reass_handoff_trace_t *);
1917 format (s, "ip4-full-reassembly-handoff: next-worker %d",
1918 t->next_worker_index);
1924 ip4_full_reass_handoff_node_inline (vlib_main_t *vm, vlib_node_runtime_t *node,
1925 vlib_frame_t *frame,
1926 ip4_full_reass_node_type_t type,
1929 ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1931 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
1932 u32 n_enq, n_left_from, *from;
1933 u16 thread_indices[VLIB_FRAME_SIZE], *ti;
1936 from = vlib_frame_vector_args (frame);
1937 n_left_from = frame->n_vectors;
1938 vlib_get_buffers (vm, from, bufs, n_left_from);
1941 ti = thread_indices;
1948 fq_index = rm->fq_local_index;
1952 fq_index = rm->fq_index;
1956 fq_index = rm->fq_feature_index;
1959 fq_index = rm->fq_custom_index;
1962 clib_warning ("Unexpected `type' (%d)!", type);
1965 while (n_left_from > 0)
1967 ti[0] = vnet_buffer (b[0])->ip.reass.owner_thread_index;
1970 ((node->flags & VLIB_NODE_FLAG_TRACE)
1971 && (b[0]->flags & VLIB_BUFFER_IS_TRACED)))
1973 ip4_full_reass_handoff_trace_t *t =
1974 vlib_add_trace (vm, node, b[0], sizeof (*t));
1975 t->next_worker_index = ti[0];
1982 n_enq = vlib_buffer_enqueue_to_thread (vm, node, fq_index, from,
1983 thread_indices, frame->n_vectors, 1);
1985 if (n_enq < frame->n_vectors)
1986 vlib_node_increment_counter (vm, node->node_index,
1987 IP4_FULL_REASS_HANDOFF_ERROR_CONGESTION_DROP,
1988 frame->n_vectors - n_enq);
1989 return frame->n_vectors;
1992 VLIB_NODE_FN (ip4_full_reass_handoff_node) (vlib_main_t * vm,
1993 vlib_node_runtime_t * node,
1994 vlib_frame_t * frame)
1996 return ip4_full_reass_handoff_node_inline (vm, node, frame, NORMAL,
1997 false /* is_local */);
2001 VLIB_REGISTER_NODE (ip4_full_reass_handoff_node) = {
2002 .name = "ip4-full-reassembly-handoff",
2003 .vector_size = sizeof (u32),
2004 .n_errors = ARRAY_LEN(ip4_full_reass_handoff_error_strings),
2005 .error_strings = ip4_full_reass_handoff_error_strings,
2006 .format_trace = format_ip4_full_reass_handoff_trace,
2015 VLIB_NODE_FN (ip4_local_full_reass_handoff_node)
2016 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
2018 return ip4_full_reass_handoff_node_inline (vm, node, frame, NORMAL,
2019 true /* is_local */);
2022 VLIB_REGISTER_NODE (ip4_local_full_reass_handoff_node) = {
2023 .name = "ip4-local-full-reassembly-handoff",
2024 .vector_size = sizeof (u32),
2025 .n_errors = ARRAY_LEN(ip4_full_reass_handoff_error_strings),
2026 .error_strings = ip4_full_reass_handoff_error_strings,
2027 .format_trace = format_ip4_full_reass_handoff_trace,
2036 VLIB_NODE_FN (ip4_full_reass_feature_handoff_node) (vlib_main_t * vm,
2037 vlib_node_runtime_t *
2039 vlib_frame_t * frame)
2041 return ip4_full_reass_handoff_node_inline (vm, node, frame, FEATURE,
2042 false /* is_local */);
2045 VLIB_REGISTER_NODE (ip4_full_reass_feature_handoff_node) = {
2046 .name = "ip4-full-reass-feature-hoff",
2047 .vector_size = sizeof (u32),
2048 .n_errors = ARRAY_LEN(ip4_full_reass_handoff_error_strings),
2049 .error_strings = ip4_full_reass_handoff_error_strings,
2050 .format_trace = format_ip4_full_reass_handoff_trace,
2059 VLIB_NODE_FN (ip4_full_reass_custom_handoff_node) (vlib_main_t * vm,
2060 vlib_node_runtime_t *
2062 vlib_frame_t * frame)
2064 return ip4_full_reass_handoff_node_inline (vm, node, frame, CUSTOM,
2065 false /* is_local */);
2068 VLIB_REGISTER_NODE (ip4_full_reass_custom_handoff_node) = {
2069 .name = "ip4-full-reass-custom-hoff",
2070 .vector_size = sizeof (u32),
2071 .n_errors = ARRAY_LEN(ip4_full_reass_handoff_error_strings),
2072 .error_strings = ip4_full_reass_handoff_error_strings,
2073 .format_trace = format_ip4_full_reass_handoff_trace,
2082 #ifndef CLIB_MARCH_VARIANT
2084 ip4_full_reass_enable_disable_with_refcnt (u32 sw_if_index, int is_enable)
2086 ip4_full_reass_main_t *rm = &ip4_full_reass_main;
2087 vec_validate (rm->feature_use_refcount_per_intf, sw_if_index);
2090 if (!rm->feature_use_refcount_per_intf[sw_if_index])
2092 ++rm->feature_use_refcount_per_intf[sw_if_index];
2093 return vnet_feature_enable_disable ("ip4-unicast",
2094 "ip4-full-reassembly-feature",
2095 sw_if_index, 1, 0, 0);
2097 ++rm->feature_use_refcount_per_intf[sw_if_index];
2101 --rm->feature_use_refcount_per_intf[sw_if_index];
2102 if (!rm->feature_use_refcount_per_intf[sw_if_index])
2103 return vnet_feature_enable_disable ("ip4-unicast",
2104 "ip4-full-reassembly-feature",
2105 sw_if_index, 0, 0, 0);
2111 ip4_local_full_reass_enable_disable (int enable)
2115 ip4_full_reass_main.is_local_reass_enabled = 1;
2119 ip4_full_reass_main.is_local_reass_enabled = 0;
2124 ip4_local_full_reass_enabled ()
2126 return ip4_full_reass_main.is_local_reass_enabled;
2132 * fd.io coding-style-patch-verification: ON
2135 * eval: (c-set-style "gnu")