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 <vppinfra/fifo.h>
27 #include <vppinfra/bihash_16_8.h>
28 #include <vnet/ip/reass/ip4_full_reass.h>
31 #define MSEC_PER_SEC 1000
32 #define IP4_REASS_TIMEOUT_DEFAULT_MS 100
33 #define IP4_REASS_EXPIRE_WALK_INTERVAL_DEFAULT_MS 10000 // 10 seconds default
34 #define IP4_REASS_MAX_REASSEMBLIES_DEFAULT 1024
35 #define IP4_REASS_MAX_REASSEMBLY_LENGTH_DEFAULT 3
36 #define IP4_REASS_HT_LOAD_FACTOR (0.75)
38 #define IP4_REASS_DEBUG_BUFFERS 0
39 #if IP4_REASS_DEBUG_BUFFERS
40 #define IP4_REASS_DEBUG_BUFFER(bi, what) \
44 printf (#what "buffer %u", _bi); \
45 vlib_buffer_t *_b = vlib_get_buffer (vm, _bi); \
46 while (_b->flags & VLIB_BUFFER_NEXT_PRESENT) \
48 _bi = _b->next_buffer; \
49 printf ("[%u]", _bi); \
50 _b = vlib_get_buffer (vm, _bi); \
57 #define IP4_REASS_DEBUG_BUFFER(...)
63 IP4_REASS_RC_TOO_MANY_FRAGMENTS,
64 IP4_REASS_RC_INTERNAL_ERROR,
67 } ip4_full_reass_rc_t;
84 } ip4_full_reass_key_t;
91 u32 memory_owner_thread_index;
94 } ip4_full_reass_val_t;
100 ip4_full_reass_key_t k;
101 ip4_full_reass_val_t v;
103 clib_bihash_kv_16_8_t kv;
104 } ip4_full_reass_kv_t;
107 ip4_full_reass_buffer_get_data_offset (vlib_buffer_t * b)
109 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
110 return vnb->ip.reass.range_first - vnb->ip.reass.fragment_first;
114 ip4_full_reass_buffer_get_data_len (vlib_buffer_t * b)
116 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
117 return clib_min (vnb->ip.reass.range_last, vnb->ip.reass.fragment_last) -
118 (vnb->ip.reass.fragment_first +
119 ip4_full_reass_buffer_get_data_offset (b)) + 1;
125 ip4_full_reass_key_t key;
126 // time when last packet was received
128 // internal id of this reassembly
130 // buffer index of first buffer in this reassembly context
132 // last octet of packet, ~0 until fragment without more_fragments arrives
133 u32 last_packet_octet;
134 // length of data collected so far
136 // trace operation counter
137 u32 trace_op_counter;
138 // next index - used by non-feature node
140 // error next index - used by custom apps (~0 if not used)
141 u32 error_next_index;
142 // minimum fragment length for this reassembly - used to estimate MTU
143 u16 min_fragment_length;
144 // number of fragments in this reassembly
146 // thread owning memory for this context (whose pool contains this ctx)
147 u32 memory_owner_thread_index;
148 // thread which received fragment with offset 0 and which sends out the
149 // completed reassembly
150 u32 sendout_thread_index;
155 ip4_full_reass_t *pool;
158 clib_spinlock_t lock;
159 } ip4_full_reass_per_thread_t;
166 u32 expire_walk_interval_ms;
167 // maximum number of fragments in one reassembly
169 // maximum number of reassemblies
173 clib_bihash_16_8_t hash;
175 ip4_full_reass_per_thread_t *per_thread_data;
178 vlib_main_t *vlib_main;
180 u32 ip4_full_reass_expire_node_idx;
182 /** Worker handoff */
185 u32 fq_feature_index;
188 // reference count for enabling/disabling feature - per interface
189 u32 *feature_use_refcount_per_intf;
191 // whether local fragmented packets are reassembled or not
192 int is_local_reass_enabled;
193 } ip4_full_reass_main_t;
195 extern ip4_full_reass_main_t ip4_full_reass_main;
197 #ifndef CLIB_MARCH_VARIANT
198 ip4_full_reass_main_t ip4_full_reass_main;
199 #endif /* CLIB_MARCH_VARIANT */
203 IP4_FULL_REASS_NEXT_INPUT,
204 IP4_FULL_REASS_NEXT_DROP,
205 IP4_FULL_REASS_NEXT_HANDOFF,
206 IP4_FULL_REASS_N_NEXT,
207 } ip4_full_reass_next_t;
214 } ip4_full_reass_node_type_t;
225 } ip4_full_reass_trace_operation_e;
235 } ip4_full_reass_range_trace_t;
239 ip4_full_reass_trace_operation_e action;
241 ip4_full_reass_range_trace_t trace_range;
249 bool is_after_handoff;
250 ip4_header_t ip4_header;
251 } ip4_full_reass_trace_t;
253 extern vlib_node_registration_t ip4_full_reass_node;
254 extern vlib_node_registration_t ip4_full_reass_node_feature;
255 extern vlib_node_registration_t ip4_full_reass_node_custom;
258 ip4_full_reass_trace_details (vlib_main_t * vm, u32 bi,
259 ip4_full_reass_range_trace_t * trace)
261 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
262 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
263 trace->range_first = vnb->ip.reass.range_first;
264 trace->range_last = vnb->ip.reass.range_last;
265 trace->data_offset = ip4_full_reass_buffer_get_data_offset (b);
266 trace->data_len = ip4_full_reass_buffer_get_data_len (b);
267 trace->range_bi = bi;
271 format_ip4_full_reass_range_trace (u8 * s, va_list * args)
273 ip4_full_reass_range_trace_t *trace =
274 va_arg (*args, ip4_full_reass_range_trace_t *);
276 format (s, "range: [%u, %u], off %d, len %u, bi %u", trace->range_first,
277 trace->range_last, trace->data_offset, trace->data_len,
283 format_ip4_full_reass_trace (u8 * s, va_list * args)
285 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
286 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
287 ip4_full_reass_trace_t *t = va_arg (*args, ip4_full_reass_trace_t *);
289 if (~0 != t->reass_id)
291 if (t->is_after_handoff)
294 format (s, "%U\n", format_ip4_header, &t->ip4_header,
295 sizeof (t->ip4_header));
299 format (s, "%Ureass id: %u, op id: %u, ", format_white_space, indent,
300 t->reass_id, t->op_id);
301 indent = format_get_indent (s);
304 "first bi: %u, data len: %u, ip/fragment[%u, %u]",
305 t->trace_range.first_bi, t->total_data_len, t->fragment_first,
311 s = format (s, "\n%Ushrink %U by %u", format_white_space, indent,
312 format_ip4_full_reass_range_trace, &t->trace_range,
316 s = format (s, "\n%Udiscard %U", format_white_space, indent,
317 format_ip4_full_reass_range_trace, &t->trace_range);
320 s = format (s, "\n%Unew %U", format_white_space, indent,
321 format_ip4_full_reass_range_trace, &t->trace_range);
324 s = format (s, "\n%Uoverlapping/ignored %U", format_white_space, indent,
325 format_ip4_full_reass_range_trace, &t->trace_range);
328 s = format (s, "\n%Ufinalize reassembly", format_white_space, indent);
332 format (s, "handoff from thread #%u to thread #%u", t->thread_id,
336 s = format (s, "passthrough - not a fragment");
343 ip4_full_reass_add_trace (vlib_main_t * vm, vlib_node_runtime_t * node,
344 ip4_full_reass_t * reass, u32 bi,
345 ip4_full_reass_trace_operation_e action,
346 u32 size_diff, u32 thread_id_to)
348 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
349 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
350 if (pool_is_free_index
351 (vm->trace_main.trace_buffer_pool, vlib_buffer_get_trace_index (b)))
353 // this buffer's trace is gone
354 b->flags &= ~VLIB_BUFFER_IS_TRACED;
357 bool is_after_handoff = false;
358 if (vlib_buffer_get_trace_thread (b) != vm->thread_index)
360 is_after_handoff = true;
362 ip4_full_reass_trace_t *t = vlib_add_trace (vm, node, b, sizeof (t[0]));
363 t->is_after_handoff = is_after_handoff;
364 if (t->is_after_handoff)
366 clib_memcpy (&t->ip4_header, vlib_buffer_get_current (b),
367 clib_min (sizeof (t->ip4_header), b->current_length));
371 t->reass_id = reass->id;
372 t->op_id = reass->trace_op_counter;
373 t->trace_range.first_bi = reass->first_bi;
374 t->total_data_len = reass->data_len;
375 ++reass->trace_op_counter;
381 t->trace_range.first_bi = 0;
382 t->total_data_len = 0;
385 ip4_full_reass_trace_details (vm, bi, &t->trace_range);
386 t->size_diff = size_diff;
387 t->thread_id = vm->thread_index;
388 t->thread_id_to = thread_id_to;
389 t->fragment_first = vnb->ip.reass.fragment_first;
390 t->fragment_last = vnb->ip.reass.fragment_last;
393 s = format (s, "%U", format_ip4_full_reass_trace, NULL, NULL, t);
394 printf ("%.*s\n", vec_len (s), s);
396 vec_reset_length (s);
401 ip4_full_reass_free_ctx (ip4_full_reass_per_thread_t * rt,
402 ip4_full_reass_t * reass)
404 pool_put (rt->pool, reass);
409 ip4_full_reass_free (ip4_full_reass_main_t * rm,
410 ip4_full_reass_per_thread_t * rt,
411 ip4_full_reass_t * reass)
413 clib_bihash_kv_16_8_t kv;
414 kv.key[0] = reass->key.as_u64[0];
415 kv.key[1] = reass->key.as_u64[1];
416 clib_bihash_add_del_16_8 (&rm->hash, &kv, 0);
417 return ip4_full_reass_free_ctx (rt, reass);
420 /* n_left_to_next, and to_next are taken as input params, as this function
421 * could be called from a graphnode, where its managing local copy of these
422 * variables, and ignoring those and still trying to enqueue the buffers
423 * with local variables would cause either buffer leak or corruption */
425 ip4_full_reass_drop_all (vlib_main_t *vm, vlib_node_runtime_t *node,
426 ip4_full_reass_t *reass, u32 *n_left_to_next,
429 u32 range_bi = reass->first_bi;
430 vlib_buffer_t *range_b;
431 vnet_buffer_opaque_t *range_vnb;
434 while (~0 != range_bi)
436 range_b = vlib_get_buffer (vm, range_bi);
437 range_vnb = vnet_buffer (range_b);
441 vec_add1 (to_free, range_bi);
444 range_bi = range_vnb->ip.reass.next_range_bi;
447 /* send to next_error_index */
448 if (~0 != reass->error_next_index &&
449 reass->error_next_index < node->n_next_nodes)
453 next_index = reass->error_next_index;
456 while (vec_len (to_free) > 0)
458 vlib_get_next_frame (vm, node, next_index, *to_next,
461 while (vec_len (to_free) > 0 && (*n_left_to_next) > 0)
463 bi = vec_pop (to_free);
467 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
468 if ((b->flags & VLIB_BUFFER_IS_TRACED))
470 ip4_full_reass_add_trace (vm, node, reass, bi,
471 RANGE_DISCARD, 0, ~0);
475 (*n_left_to_next) -= 1;
478 vlib_put_next_frame (vm, node, next_index, (*n_left_to_next));
483 vlib_buffer_free (vm, to_free, vec_len (to_free));
489 sanitize_reass_buffers_add_missing (vlib_main_t *vm, ip4_full_reass_t *reass,
492 u32 range_bi = reass->first_bi;
493 vlib_buffer_t *range_b;
494 vnet_buffer_opaque_t *range_vnb;
496 while (~0 != range_bi)
498 range_b = vlib_get_buffer (vm, range_bi);
499 range_vnb = vnet_buffer (range_b);
505 if (range_b->flags & VLIB_BUFFER_NEXT_PRESENT)
508 vlib_buffer_t *_b = vlib_get_buffer (vm, _bi);
509 while (_b->flags & VLIB_BUFFER_NEXT_PRESENT)
511 if (_b->next_buffer != range_vnb->ip.reass.next_range_bi)
513 _bi = _b->next_buffer;
514 _b = vlib_get_buffer (vm, _bi);
518 _b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
523 range_bi = range_vnb->ip.reass.next_range_bi;
528 vlib_buffer_t *fb = vlib_get_buffer (vm, *bi0);
529 vnet_buffer_opaque_t *fvnb = vnet_buffer (fb);
530 if (~0 != reass->first_bi)
532 fvnb->ip.reass.next_range_bi = reass->first_bi;
533 reass->first_bi = *bi0;
537 reass->first_bi = *bi0;
538 fvnb->ip.reass.next_range_bi = ~0;
545 ip4_full_reass_init (ip4_full_reass_t * reass)
547 reass->first_bi = ~0;
548 reass->last_packet_octet = ~0;
550 reass->next_index = ~0;
551 reass->error_next_index = ~0;
554 always_inline ip4_full_reass_t *
555 ip4_full_reass_find_or_create (vlib_main_t *vm, vlib_node_runtime_t *node,
556 ip4_full_reass_main_t *rm,
557 ip4_full_reass_per_thread_t *rt,
558 ip4_full_reass_kv_t *kv, u8 *do_handoff,
559 u32 *n_left_to_next, u32 **to_next)
561 ip4_full_reass_t *reass;
567 now = vlib_time_now (vm);
568 if (!clib_bihash_search_16_8 (&rm->hash, &kv->kv, &kv->kv))
570 if (vm->thread_index != kv->v.memory_owner_thread_index)
576 pool_elt_at_index (rm->per_thread_data
577 [kv->v.memory_owner_thread_index].pool,
580 if (now > reass->last_heard + rm->timeout)
582 ip4_full_reass_drop_all (vm, node, reass, n_left_to_next, to_next);
583 ip4_full_reass_free (rm, rt, reass);
590 reass->last_heard = now;
594 if (rt->reass_n >= rm->max_reass_n)
601 pool_get (rt->pool, reass);
602 clib_memset (reass, 0, sizeof (*reass));
603 reass->id = ((u64) vm->thread_index * 1000000000) + rt->id_counter;
604 reass->memory_owner_thread_index = vm->thread_index;
606 ip4_full_reass_init (reass);
610 reass->key.as_u64[0] = kv->kv.key[0];
611 reass->key.as_u64[1] = kv->kv.key[1];
612 kv->v.reass_index = (reass - rt->pool);
613 kv->v.memory_owner_thread_index = vm->thread_index;
614 reass->last_heard = now;
616 int rv = clib_bihash_add_del_16_8 (&rm->hash, &kv->kv, 2);
619 ip4_full_reass_free_ctx (rt, reass);
621 // if other worker created a context already work with the other copy
629 always_inline ip4_full_reass_rc_t
630 ip4_full_reass_finalize (vlib_main_t * vm, vlib_node_runtime_t * node,
631 ip4_full_reass_main_t * rm,
632 ip4_full_reass_per_thread_t * rt,
633 ip4_full_reass_t * reass, u32 * bi0,
634 u32 * next0, u32 * error0, bool is_custom)
636 vlib_buffer_t *first_b = vlib_get_buffer (vm, reass->first_bi);
637 vlib_buffer_t *last_b = NULL;
638 u32 sub_chain_bi = reass->first_bi;
639 u32 total_length = 0;
643 u32 tmp_bi = sub_chain_bi;
644 vlib_buffer_t *tmp = vlib_get_buffer (vm, tmp_bi);
645 ip4_header_t *ip = vlib_buffer_get_current (tmp);
646 vnet_buffer_opaque_t *vnb = vnet_buffer (tmp);
647 if (!(vnb->ip.reass.range_first >= vnb->ip.reass.fragment_first) &&
648 !(vnb->ip.reass.range_last > vnb->ip.reass.fragment_first))
650 return IP4_REASS_RC_INTERNAL_ERROR;
653 u32 data_len = ip4_full_reass_buffer_get_data_len (tmp);
655 ip4_header_bytes (ip) + ip4_full_reass_buffer_get_data_offset (tmp);
657 vlib_buffer_length_in_chain (vm, tmp) - trim_front - data_len;
658 if (tmp_bi == reass->first_bi)
660 /* first buffer - keep ip4 header */
661 if (0 != ip4_full_reass_buffer_get_data_offset (tmp))
663 return IP4_REASS_RC_INTERNAL_ERROR;
666 trim_end = vlib_buffer_length_in_chain (vm, tmp) - data_len -
667 ip4_header_bytes (ip);
668 if (!(vlib_buffer_length_in_chain (vm, tmp) - trim_end > 0))
670 return IP4_REASS_RC_INTERNAL_ERROR;
674 vlib_buffer_length_in_chain (vm, tmp) - trim_front - trim_end;
680 if (trim_front > tmp->current_length)
682 /* drop whole buffer */
683 u32 to_be_freed_bi = tmp_bi;
684 trim_front -= tmp->current_length;
685 if (!(tmp->flags & VLIB_BUFFER_NEXT_PRESENT))
687 return IP4_REASS_RC_INTERNAL_ERROR;
689 tmp->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
690 tmp_bi = tmp->next_buffer;
691 tmp->next_buffer = 0;
692 tmp = vlib_get_buffer (vm, tmp_bi);
693 vlib_buffer_free_one (vm, to_be_freed_bi);
698 vlib_buffer_advance (tmp, trim_front);
706 last_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
707 last_b->next_buffer = tmp_bi;
710 if (keep_data <= tmp->current_length)
712 tmp->current_length = keep_data;
717 keep_data -= tmp->current_length;
718 if (!(tmp->flags & VLIB_BUFFER_NEXT_PRESENT))
720 return IP4_REASS_RC_INTERNAL_ERROR;
723 total_length += tmp->current_length;
724 if (tmp->flags & VLIB_BUFFER_NEXT_PRESENT)
726 tmp_bi = tmp->next_buffer;
727 tmp = vlib_get_buffer (vm, tmp->next_buffer);
736 u32 to_be_freed_bi = tmp_bi;
737 if (reass->first_bi == tmp_bi)
739 return IP4_REASS_RC_INTERNAL_ERROR;
741 if (tmp->flags & VLIB_BUFFER_NEXT_PRESENT)
743 tmp->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
744 tmp_bi = tmp->next_buffer;
745 tmp->next_buffer = 0;
746 tmp = vlib_get_buffer (vm, tmp_bi);
747 vlib_buffer_free_one (vm, to_be_freed_bi);
751 tmp->next_buffer = 0;
752 vlib_buffer_free_one (vm, to_be_freed_bi);
758 vnet_buffer (vlib_get_buffer (vm, sub_chain_bi))->ip.
761 while (~0 != sub_chain_bi);
765 return IP4_REASS_RC_INTERNAL_ERROR;
767 last_b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
769 if (total_length < first_b->current_length)
771 return IP4_REASS_RC_INTERNAL_ERROR;
773 total_length -= first_b->current_length;
774 first_b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
775 first_b->total_length_not_including_first_buffer = total_length;
776 ip4_header_t *ip = vlib_buffer_get_current (first_b);
777 ip->flags_and_fragment_offset = 0;
778 ip->length = clib_host_to_net_u16 (first_b->current_length + total_length);
779 ip->checksum = ip4_header_checksum (ip);
780 if (!vlib_buffer_chain_linearize (vm, first_b))
782 return IP4_REASS_RC_NO_BUF;
784 // reset to reconstruct the mbuf linking
785 first_b->flags &= ~VLIB_BUFFER_EXT_HDR_VALID;
786 if (PREDICT_FALSE (first_b->flags & VLIB_BUFFER_IS_TRACED))
788 ip4_full_reass_add_trace (vm, node, reass, reass->first_bi, FINALIZE, 0,
791 // following code does a hexdump of packet fragments to stdout ...
794 u32 bi = reass->first_bi;
798 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
799 s = format (s, "%u: %U\n", bi, format_hexdump,
800 vlib_buffer_get_current (b), b->current_length);
801 if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
810 printf ("%.*s\n", vec_len (s), s);
817 *bi0 = reass->first_bi;
820 *next0 = IP4_FULL_REASS_NEXT_INPUT;
824 *next0 = reass->next_index;
826 vnet_buffer (first_b)->ip.reass.estimated_mtu = reass->min_fragment_length;
828 *error0 = IP4_ERROR_NONE;
829 ip4_full_reass_free (rm, rt, reass);
831 return IP4_REASS_RC_OK;
834 always_inline ip4_full_reass_rc_t
835 ip4_full_reass_insert_range_in_chain (vlib_main_t * vm,
836 ip4_full_reass_t * reass,
837 u32 prev_range_bi, u32 new_next_bi)
839 vlib_buffer_t *new_next_b = vlib_get_buffer (vm, new_next_bi);
840 vnet_buffer_opaque_t *new_next_vnb = vnet_buffer (new_next_b);
841 if (~0 != prev_range_bi)
843 vlib_buffer_t *prev_b = vlib_get_buffer (vm, prev_range_bi);
844 vnet_buffer_opaque_t *prev_vnb = vnet_buffer (prev_b);
845 new_next_vnb->ip.reass.next_range_bi = prev_vnb->ip.reass.next_range_bi;
846 prev_vnb->ip.reass.next_range_bi = new_next_bi;
850 if (~0 != reass->first_bi)
852 new_next_vnb->ip.reass.next_range_bi = reass->first_bi;
854 reass->first_bi = new_next_bi;
856 vnet_buffer_opaque_t *vnb = vnet_buffer (new_next_b);
857 if (!(vnb->ip.reass.range_first >= vnb->ip.reass.fragment_first) &&
858 !(vnb->ip.reass.range_last > vnb->ip.reass.fragment_first))
860 return IP4_REASS_RC_INTERNAL_ERROR;
862 reass->data_len += ip4_full_reass_buffer_get_data_len (new_next_b);
863 return IP4_REASS_RC_OK;
866 always_inline ip4_full_reass_rc_t
867 ip4_full_reass_remove_range_from_chain (vlib_main_t * vm,
868 vlib_node_runtime_t * node,
869 ip4_full_reass_t * reass,
870 u32 prev_range_bi, u32 discard_bi)
872 vlib_buffer_t *discard_b = vlib_get_buffer (vm, discard_bi);
873 vnet_buffer_opaque_t *discard_vnb = vnet_buffer (discard_b);
874 if (~0 != prev_range_bi)
876 vlib_buffer_t *prev_b = vlib_get_buffer (vm, prev_range_bi);
877 vnet_buffer_opaque_t *prev_vnb = vnet_buffer (prev_b);
878 if (!(prev_vnb->ip.reass.next_range_bi == discard_bi))
880 return IP4_REASS_RC_INTERNAL_ERROR;
882 prev_vnb->ip.reass.next_range_bi = discard_vnb->ip.reass.next_range_bi;
886 reass->first_bi = discard_vnb->ip.reass.next_range_bi;
888 vnet_buffer_opaque_t *vnb = vnet_buffer (discard_b);
889 if (!(vnb->ip.reass.range_first >= vnb->ip.reass.fragment_first) &&
890 !(vnb->ip.reass.range_last > vnb->ip.reass.fragment_first))
892 return IP4_REASS_RC_INTERNAL_ERROR;
894 reass->data_len -= ip4_full_reass_buffer_get_data_len (discard_b);
897 u32 to_be_freed_bi = discard_bi;
898 if (PREDICT_FALSE (discard_b->flags & VLIB_BUFFER_IS_TRACED))
900 ip4_full_reass_add_trace (vm, node, reass, discard_bi, RANGE_DISCARD,
903 if (discard_b->flags & VLIB_BUFFER_NEXT_PRESENT)
905 discard_b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
906 discard_bi = discard_b->next_buffer;
907 discard_b->next_buffer = 0;
908 discard_b = vlib_get_buffer (vm, discard_bi);
909 vlib_buffer_free_one (vm, to_be_freed_bi);
913 discard_b->next_buffer = 0;
914 vlib_buffer_free_one (vm, to_be_freed_bi);
918 return IP4_REASS_RC_OK;
921 always_inline ip4_full_reass_rc_t
922 ip4_full_reass_update (vlib_main_t * vm, vlib_node_runtime_t * node,
923 ip4_full_reass_main_t * rm,
924 ip4_full_reass_per_thread_t * rt,
925 ip4_full_reass_t * reass, u32 * bi0, u32 * next0,
926 u32 * error0, bool is_custom, u32 * handoff_thread_idx)
928 vlib_buffer_t *fb = vlib_get_buffer (vm, *bi0);
929 vnet_buffer_opaque_t *fvnb = vnet_buffer (fb);
932 // store (error_)next_index before it's overwritten
933 reass->next_index = fvnb->ip.reass.next_index;
934 reass->error_next_index = fvnb->ip.reass.error_next_index;
936 ip4_full_reass_rc_t rc = IP4_REASS_RC_OK;
938 ip4_header_t *fip = vlib_buffer_get_current (fb);
939 const u32 fragment_first = ip4_get_fragment_offset_bytes (fip);
940 const u32 fragment_length =
941 clib_net_to_host_u16 (fip->length) - ip4_header_bytes (fip);
942 const u32 fragment_last = fragment_first + fragment_length - 1;
943 fvnb->ip.reass.fragment_first = fragment_first;
944 fvnb->ip.reass.fragment_last = fragment_last;
945 int more_fragments = ip4_get_fragment_more (fip);
946 u32 candidate_range_bi = reass->first_bi;
947 u32 prev_range_bi = ~0;
948 fvnb->ip.reass.range_first = fragment_first;
949 fvnb->ip.reass.range_last = fragment_last;
950 fvnb->ip.reass.next_range_bi = ~0;
953 reass->last_packet_octet = fragment_last;
955 if (~0 == reass->first_bi)
957 // starting a new reassembly
959 ip4_full_reass_insert_range_in_chain (vm, reass, prev_range_bi, *bi0);
960 if (IP4_REASS_RC_OK != rc)
964 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
966 ip4_full_reass_add_trace (vm, node, reass, *bi0, RANGE_NEW, 0, ~0);
969 reass->min_fragment_length = clib_net_to_host_u16 (fip->length);
970 reass->fragments_n = 1;
971 return IP4_REASS_RC_OK;
973 reass->min_fragment_length =
974 clib_min (clib_net_to_host_u16 (fip->length),
975 fvnb->ip.reass.estimated_mtu);
976 while (~0 != candidate_range_bi)
978 vlib_buffer_t *candidate_b = vlib_get_buffer (vm, candidate_range_bi);
979 vnet_buffer_opaque_t *candidate_vnb = vnet_buffer (candidate_b);
980 if (fragment_first > candidate_vnb->ip.reass.range_last)
982 // this fragments starts after candidate range
983 prev_range_bi = candidate_range_bi;
984 candidate_range_bi = candidate_vnb->ip.reass.next_range_bi;
985 if (candidate_vnb->ip.reass.range_last < fragment_last &&
986 ~0 == candidate_range_bi)
988 // special case - this fragment falls beyond all known ranges
989 rc = ip4_full_reass_insert_range_in_chain (vm, reass,
990 prev_range_bi, *bi0);
991 if (IP4_REASS_RC_OK != rc)
1000 if (fragment_last < candidate_vnb->ip.reass.range_first)
1002 // this fragment ends before candidate range without any overlap
1003 rc = ip4_full_reass_insert_range_in_chain (vm, reass, prev_range_bi,
1005 if (IP4_REASS_RC_OK != rc)
1013 if (fragment_first >= candidate_vnb->ip.reass.range_first &&
1014 fragment_last <= candidate_vnb->ip.reass.range_last)
1016 // this fragment is a (sub)part of existing range, ignore it
1017 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
1019 ip4_full_reass_add_trace (vm, node, reass, *bi0,
1020 RANGE_OVERLAP, 0, ~0);
1024 int discard_candidate = 0;
1025 if (fragment_first < candidate_vnb->ip.reass.range_first)
1028 fragment_last - candidate_vnb->ip.reass.range_first + 1;
1029 if (overlap < ip4_full_reass_buffer_get_data_len (candidate_b))
1031 candidate_vnb->ip.reass.range_first += overlap;
1032 if (reass->data_len < overlap)
1034 return IP4_REASS_RC_INTERNAL_ERROR;
1036 reass->data_len -= overlap;
1037 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
1039 ip4_full_reass_add_trace (vm, node, reass,
1041 RANGE_SHRINK, 0, ~0);
1043 rc = ip4_full_reass_insert_range_in_chain (
1044 vm, reass, prev_range_bi, *bi0);
1045 if (IP4_REASS_RC_OK != rc)
1053 discard_candidate = 1;
1056 else if (fragment_last > candidate_vnb->ip.reass.range_last)
1059 candidate_vnb->ip.reass.range_last - fragment_first + 1;
1060 if (overlap < ip4_full_reass_buffer_get_data_len (candidate_b))
1062 fvnb->ip.reass.range_first += overlap;
1063 if (~0 != candidate_vnb->ip.reass.next_range_bi)
1065 prev_range_bi = candidate_range_bi;
1066 candidate_range_bi =
1067 candidate_vnb->ip.reass.next_range_bi;
1072 // special case - last range discarded
1073 rc = ip4_full_reass_insert_range_in_chain (
1074 vm, reass, candidate_range_bi, *bi0);
1075 if (IP4_REASS_RC_OK != rc)
1084 discard_candidate = 1;
1089 discard_candidate = 1;
1091 if (discard_candidate)
1093 u32 next_range_bi = candidate_vnb->ip.reass.next_range_bi;
1094 // discard candidate range, probe next range
1095 rc = ip4_full_reass_remove_range_from_chain (
1096 vm, node, reass, prev_range_bi, candidate_range_bi);
1097 if (IP4_REASS_RC_OK != rc)
1101 if (~0 != next_range_bi)
1103 candidate_range_bi = next_range_bi;
1108 // special case - last range discarded
1109 rc = ip4_full_reass_insert_range_in_chain (
1110 vm, reass, prev_range_bi, *bi0);
1111 if (IP4_REASS_RC_OK != rc)
1121 ++reass->fragments_n;
1124 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
1126 ip4_full_reass_add_trace (vm, node, reass, *bi0, RANGE_NEW, 0, ~0);
1129 if (~0 != reass->last_packet_octet &&
1130 reass->data_len == reass->last_packet_octet + 1)
1132 *handoff_thread_idx = reass->sendout_thread_index;
1134 reass->memory_owner_thread_index != reass->sendout_thread_index;
1136 ip4_full_reass_finalize (vm, node, rm, rt, reass, bi0, next0, error0,
1138 if (IP4_REASS_RC_OK == rc && handoff)
1140 rc = IP4_REASS_RC_HANDOFF;
1148 if (reass->fragments_n > rm->max_reass_len)
1150 rc = IP4_REASS_RC_TOO_MANY_FRAGMENTS;
1155 *next0 = IP4_FULL_REASS_NEXT_DROP;
1156 *error0 = IP4_ERROR_REASS_DUPLICATE_FRAGMENT;
1163 ip4_full_reass_inline (vlib_main_t *vm, vlib_node_runtime_t *node,
1164 vlib_frame_t *frame, ip4_full_reass_node_type_t type,
1167 u32 *from = vlib_frame_vector_args (frame);
1168 u32 n_left_from, n_left_to_next, *to_next, next_index;
1169 ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1170 ip4_full_reass_per_thread_t *rt = &rm->per_thread_data[vm->thread_index];
1171 clib_spinlock_lock (&rt->lock);
1173 n_left_from = frame->n_vectors;
1174 next_index = node->cached_next_index;
1175 while (n_left_from > 0)
1177 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
1179 while (n_left_from > 0 && n_left_to_next > 0)
1184 u32 error0 = IP4_ERROR_NONE;
1187 b0 = vlib_get_buffer (vm, bi0);
1189 ip4_header_t *ip0 = vlib_buffer_get_current (b0);
1190 if (!ip4_get_fragment_more (ip0) && !ip4_get_fragment_offset (ip0))
1192 // this is a whole packet - no fragmentation
1195 next0 = IP4_FULL_REASS_NEXT_INPUT;
1199 next0 = vnet_buffer (b0)->ip.reass.next_index;
1201 ip4_full_reass_add_trace (vm, node, NULL, bi0, PASSTHROUGH, 0,
1203 goto packet_enqueue;
1206 if (is_local && !rm->is_local_reass_enabled)
1208 next0 = IP4_FULL_REASS_NEXT_DROP;
1209 goto packet_enqueue;
1212 const u32 fragment_first = ip4_get_fragment_offset_bytes (ip0);
1213 const u32 fragment_length =
1214 clib_net_to_host_u16 (ip0->length) - ip4_header_bytes (ip0);
1215 const u32 fragment_last = fragment_first + fragment_length - 1;
1217 if (fragment_first > fragment_last ||
1218 fragment_first + fragment_length > UINT16_MAX - 20 ||
1219 (fragment_length < 8 && // 8 is minimum frag length per RFC 791
1220 ip4_get_fragment_more (ip0)))
1222 next0 = IP4_FULL_REASS_NEXT_DROP;
1223 error0 = IP4_ERROR_REASS_MALFORMED_PACKET;
1224 goto packet_enqueue;
1226 ip4_full_reass_kv_t kv;
1230 (u64) vec_elt (ip4_main.fib_index_by_sw_if_index,
1231 vnet_buffer (b0)->sw_if_index[VLIB_RX]) |
1232 (u64) ip0->src_address.as_u32 << 32;
1234 (u64) ip0->dst_address.
1235 as_u32 | (u64) ip0->fragment_id << 32 | (u64) ip0->protocol << 48;
1237 ip4_full_reass_t *reass = ip4_full_reass_find_or_create (
1238 vm, node, rm, rt, &kv, &do_handoff, &n_left_to_next, &to_next);
1242 const u32 fragment_first = ip4_get_fragment_offset_bytes (ip0);
1243 if (0 == fragment_first)
1245 reass->sendout_thread_index = vm->thread_index;
1249 if (PREDICT_FALSE (do_handoff))
1251 next0 = IP4_FULL_REASS_NEXT_HANDOFF;
1252 vnet_buffer (b0)->ip.reass.owner_thread_index =
1253 kv.v.memory_owner_thread_index;
1257 u32 handoff_thread_idx;
1259 switch (ip4_full_reass_update
1260 (vm, node, rm, rt, reass, &bi0, &next0,
1261 &error0, CUSTOM == type, &handoff_thread_idx))
1263 case IP4_REASS_RC_OK:
1264 /* nothing to do here */
1266 case IP4_REASS_RC_HANDOFF:
1267 next0 = IP4_FULL_REASS_NEXT_HANDOFF;
1268 b0 = vlib_get_buffer (vm, bi0);
1269 vnet_buffer (b0)->ip.reass.owner_thread_index =
1272 case IP4_REASS_RC_TOO_MANY_FRAGMENTS:
1273 counter = IP4_ERROR_REASS_FRAGMENT_CHAIN_TOO_LONG;
1275 case IP4_REASS_RC_NO_BUF:
1276 counter = IP4_ERROR_REASS_NO_BUF;
1278 case IP4_REASS_RC_INTERNAL_ERROR:
1279 counter = IP4_ERROR_REASS_INTERNAL_ERROR;
1280 /* Sanitization is needed in internal error cases only, as
1281 * the incoming packet is already dropped in other cases,
1282 * also adding bi0 back to the reassembly list, fixes the
1283 * leaking of buffers during internal errors.
1285 * Also it doesnt make sense to send these buffers custom
1286 * app, these fragments are with internal errors */
1287 sanitize_reass_buffers_add_missing (vm, reass, &bi0);
1288 reass->error_next_index = ~0;
1294 vlib_node_increment_counter (vm, node->node_index, counter,
1296 ip4_full_reass_drop_all (vm, node, reass, &n_left_to_next,
1298 ip4_full_reass_free (rm, rt, reass);
1304 next0 = IP4_FULL_REASS_NEXT_DROP;
1305 error0 = IP4_ERROR_REASS_LIMIT_REACHED;
1315 n_left_to_next -= 1;
1317 /* bi0 might have been updated by reass_finalize, reload */
1318 b0 = vlib_get_buffer (vm, bi0);
1319 if (IP4_ERROR_NONE != error0)
1321 b0->error = node->errors[error0];
1324 if (next0 == IP4_FULL_REASS_NEXT_HANDOFF)
1326 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
1328 ip4_full_reass_add_trace (
1329 vm, node, NULL, bi0, HANDOFF, 0,
1330 vnet_buffer (b0)->ip.reass.owner_thread_index);
1333 else if (FEATURE == type && IP4_ERROR_NONE == error0)
1335 vnet_feature_next (&next0, b0);
1338 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
1339 to_next, n_left_to_next,
1341 IP4_REASS_DEBUG_BUFFER (bi0, enqueue_next);
1349 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1352 clib_spinlock_unlock (&rt->lock);
1353 return frame->n_vectors;
1356 static char *ip4_full_reass_error_strings[] = {
1357 #define _(sym, string) string,
1362 VLIB_NODE_FN (ip4_full_reass_node) (vlib_main_t * vm,
1363 vlib_node_runtime_t * node,
1364 vlib_frame_t * frame)
1366 return ip4_full_reass_inline (vm, node, frame, NORMAL, false /* is_local */);
1369 VLIB_REGISTER_NODE (ip4_full_reass_node) = {
1370 .name = "ip4-full-reassembly",
1371 .vector_size = sizeof (u32),
1372 .format_trace = format_ip4_full_reass_trace,
1373 .n_errors = ARRAY_LEN (ip4_full_reass_error_strings),
1374 .error_strings = ip4_full_reass_error_strings,
1375 .n_next_nodes = IP4_FULL_REASS_N_NEXT,
1378 [IP4_FULL_REASS_NEXT_INPUT] = "ip4-input",
1379 [IP4_FULL_REASS_NEXT_DROP] = "ip4-drop",
1380 [IP4_FULL_REASS_NEXT_HANDOFF] = "ip4-full-reassembly-handoff",
1385 VLIB_NODE_FN (ip4_local_full_reass_node)
1386 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
1388 return ip4_full_reass_inline (vm, node, frame, NORMAL, true /* is_local */);
1391 VLIB_REGISTER_NODE (ip4_local_full_reass_node) = {
1392 .name = "ip4-local-full-reassembly",
1393 .vector_size = sizeof (u32),
1394 .format_trace = format_ip4_full_reass_trace,
1395 .n_errors = ARRAY_LEN (ip4_full_reass_error_strings),
1396 .error_strings = ip4_full_reass_error_strings,
1397 .n_next_nodes = IP4_FULL_REASS_N_NEXT,
1400 [IP4_FULL_REASS_NEXT_INPUT] = "ip4-input",
1401 [IP4_FULL_REASS_NEXT_DROP] = "ip4-drop",
1402 [IP4_FULL_REASS_NEXT_HANDOFF] = "ip4-local-full-reassembly-handoff",
1407 VLIB_NODE_FN (ip4_full_reass_node_feature) (vlib_main_t * vm,
1408 vlib_node_runtime_t * node,
1409 vlib_frame_t * frame)
1411 return ip4_full_reass_inline (vm, node, frame, FEATURE,
1412 false /* is_local */);
1415 VLIB_REGISTER_NODE (ip4_full_reass_node_feature) = {
1416 .name = "ip4-full-reassembly-feature",
1417 .vector_size = sizeof (u32),
1418 .format_trace = format_ip4_full_reass_trace,
1419 .n_errors = ARRAY_LEN (ip4_full_reass_error_strings),
1420 .error_strings = ip4_full_reass_error_strings,
1421 .n_next_nodes = IP4_FULL_REASS_N_NEXT,
1424 [IP4_FULL_REASS_NEXT_INPUT] = "ip4-input",
1425 [IP4_FULL_REASS_NEXT_DROP] = "ip4-drop",
1426 [IP4_FULL_REASS_NEXT_HANDOFF] = "ip4-full-reass-feature-hoff",
1430 VNET_FEATURE_INIT (ip4_full_reass_feature, static) = {
1431 .arc_name = "ip4-unicast",
1432 .node_name = "ip4-full-reassembly-feature",
1433 .runs_before = VNET_FEATURES ("ip4-lookup",
1434 "ipsec4-input-feature"),
1438 VLIB_NODE_FN (ip4_full_reass_node_custom) (vlib_main_t * vm,
1439 vlib_node_runtime_t * node,
1440 vlib_frame_t * frame)
1442 return ip4_full_reass_inline (vm, node, frame, CUSTOM, false /* is_local */);
1445 VLIB_REGISTER_NODE (ip4_full_reass_node_custom) = {
1446 .name = "ip4-full-reassembly-custom",
1447 .vector_size = sizeof (u32),
1448 .format_trace = format_ip4_full_reass_trace,
1449 .n_errors = ARRAY_LEN (ip4_full_reass_error_strings),
1450 .error_strings = ip4_full_reass_error_strings,
1451 .n_next_nodes = IP4_FULL_REASS_N_NEXT,
1454 [IP4_FULL_REASS_NEXT_INPUT] = "ip4-input",
1455 [IP4_FULL_REASS_NEXT_DROP] = "ip4-drop",
1456 [IP4_FULL_REASS_NEXT_HANDOFF] = "ip4-full-reass-custom-hoff",
1460 VNET_FEATURE_INIT (ip4_full_reass_custom, static) = {
1461 .arc_name = "ip4-unicast",
1462 .node_name = "ip4-full-reassembly-feature",
1463 .runs_before = VNET_FEATURES ("ip4-lookup",
1464 "ipsec4-input-feature"),
1469 #ifndef CLIB_MARCH_VARIANT
1471 ip4_full_reass_custom_register_next_node (uword node_index)
1473 return vlib_node_add_next (vlib_get_main (),
1474 ip4_full_reass_node_custom.index, node_index);
1478 ip4_full_reass_get_nbuckets ()
1480 ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1484 /* need more mem with more workers */
1485 nbuckets = (u32) (rm->max_reass_n * (vlib_num_workers () + 1) /
1486 IP4_REASS_HT_LOAD_FACTOR);
1488 for (i = 0; i < 31; i++)
1489 if ((1 << i) >= nbuckets)
1495 #endif /* CLIB_MARCH_VARIANT */
1499 IP4_EVENT_CONFIG_CHANGED = 1,
1500 } ip4_full_reass_event_t;
1505 clib_bihash_16_8_t *new_hash;
1506 } ip4_rehash_cb_ctx;
1508 #ifndef CLIB_MARCH_VARIANT
1510 ip4_rehash_cb (clib_bihash_kv_16_8_t * kv, void *_ctx)
1512 ip4_rehash_cb_ctx *ctx = _ctx;
1513 if (clib_bihash_add_del_16_8 (ctx->new_hash, kv, 1))
1517 return (BIHASH_WALK_CONTINUE);
1521 ip4_full_reass_set_params (u32 timeout_ms, u32 max_reassemblies,
1522 u32 max_reassembly_length,
1523 u32 expire_walk_interval_ms)
1525 ip4_full_reass_main.timeout_ms = timeout_ms;
1526 ip4_full_reass_main.timeout = (f64) timeout_ms / (f64) MSEC_PER_SEC;
1527 ip4_full_reass_main.max_reass_n = max_reassemblies;
1528 ip4_full_reass_main.max_reass_len = max_reassembly_length;
1529 ip4_full_reass_main.expire_walk_interval_ms = expire_walk_interval_ms;
1533 ip4_full_reass_set (u32 timeout_ms, u32 max_reassemblies,
1534 u32 max_reassembly_length, u32 expire_walk_interval_ms)
1536 u32 old_nbuckets = ip4_full_reass_get_nbuckets ();
1537 ip4_full_reass_set_params (timeout_ms, max_reassemblies,
1538 max_reassembly_length, expire_walk_interval_ms);
1539 vlib_process_signal_event (ip4_full_reass_main.vlib_main,
1540 ip4_full_reass_main.ip4_full_reass_expire_node_idx,
1541 IP4_EVENT_CONFIG_CHANGED, 0);
1542 u32 new_nbuckets = ip4_full_reass_get_nbuckets ();
1543 if (ip4_full_reass_main.max_reass_n > 0 && new_nbuckets > old_nbuckets)
1545 clib_bihash_16_8_t new_hash;
1546 clib_memset (&new_hash, 0, sizeof (new_hash));
1547 ip4_rehash_cb_ctx ctx;
1549 ctx.new_hash = &new_hash;
1550 clib_bihash_init_16_8 (&new_hash, "ip4-dr", new_nbuckets,
1551 new_nbuckets * 1024);
1552 clib_bihash_foreach_key_value_pair_16_8 (&ip4_full_reass_main.hash,
1553 ip4_rehash_cb, &ctx);
1556 clib_bihash_free_16_8 (&new_hash);
1561 clib_bihash_free_16_8 (&ip4_full_reass_main.hash);
1562 clib_memcpy_fast (&ip4_full_reass_main.hash, &new_hash,
1563 sizeof (ip4_full_reass_main.hash));
1564 clib_bihash_copied (&ip4_full_reass_main.hash, &new_hash);
1571 ip4_full_reass_get (u32 * timeout_ms, u32 * max_reassemblies,
1572 u32 * max_reassembly_length,
1573 u32 * expire_walk_interval_ms)
1575 *timeout_ms = ip4_full_reass_main.timeout_ms;
1576 *max_reassemblies = ip4_full_reass_main.max_reass_n;
1577 *max_reassembly_length = ip4_full_reass_main.max_reass_len;
1578 *expire_walk_interval_ms = ip4_full_reass_main.expire_walk_interval_ms;
1582 static clib_error_t *
1583 ip4_full_reass_init_function (vlib_main_t * vm)
1585 ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1586 clib_error_t *error = 0;
1592 vec_validate (rm->per_thread_data, vlib_num_workers ());
1593 ip4_full_reass_per_thread_t *rt;
1594 vec_foreach (rt, rm->per_thread_data)
1596 clib_spinlock_init (&rt->lock);
1597 pool_alloc (rt->pool, rm->max_reass_n);
1600 node = vlib_get_node_by_name (vm, (u8 *) "ip4-full-reassembly-expire-walk");
1602 rm->ip4_full_reass_expire_node_idx = node->index;
1604 ip4_full_reass_set_params (IP4_REASS_TIMEOUT_DEFAULT_MS,
1605 IP4_REASS_MAX_REASSEMBLIES_DEFAULT,
1606 IP4_REASS_MAX_REASSEMBLY_LENGTH_DEFAULT,
1607 IP4_REASS_EXPIRE_WALK_INTERVAL_DEFAULT_MS);
1609 nbuckets = ip4_full_reass_get_nbuckets ();
1610 clib_bihash_init_16_8 (&rm->hash, "ip4-dr", nbuckets, nbuckets * 1024);
1612 rm->fq_index = vlib_frame_queue_main_init (ip4_full_reass_node.index, 0);
1613 rm->fq_local_index =
1614 vlib_frame_queue_main_init (ip4_local_full_reass_node.index, 0);
1615 rm->fq_feature_index =
1616 vlib_frame_queue_main_init (ip4_full_reass_node_feature.index, 0);
1617 rm->fq_custom_index =
1618 vlib_frame_queue_main_init (ip4_full_reass_node_custom.index, 0);
1620 rm->feature_use_refcount_per_intf = NULL;
1621 rm->is_local_reass_enabled = 1;
1626 VLIB_INIT_FUNCTION (ip4_full_reass_init_function);
1627 #endif /* CLIB_MARCH_VARIANT */
1630 ip4_full_reass_walk_expired (vlib_main_t *vm, vlib_node_runtime_t *node,
1631 CLIB_UNUSED (vlib_frame_t *f))
1633 ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1634 uword event_type, *event_data = 0;
1638 vlib_process_wait_for_event_or_clock (vm,
1640 rm->expire_walk_interval_ms /
1641 (f64) MSEC_PER_SEC);
1642 event_type = vlib_process_get_events (vm, &event_data);
1647 /* no events => timeout */
1649 case IP4_EVENT_CONFIG_CHANGED:
1650 /* nothing to do here */
1653 clib_warning ("BUG: event type 0x%wx", event_type);
1656 f64 now = vlib_time_now (vm);
1658 ip4_full_reass_t *reass;
1659 int *pool_indexes_to_free = NULL;
1661 uword thread_index = 0;
1663 const uword nthreads = vlib_num_workers () + 1;
1664 u32 n_left_to_next, *to_next;
1666 for (thread_index = 0; thread_index < nthreads; ++thread_index)
1668 ip4_full_reass_per_thread_t *rt =
1669 &rm->per_thread_data[thread_index];
1670 clib_spinlock_lock (&rt->lock);
1672 vec_reset_length (pool_indexes_to_free);
1674 pool_foreach_index (index, rt->pool)
1676 reass = pool_elt_at_index (rt->pool, index);
1677 if (now > reass->last_heard + rm->timeout)
1679 vec_add1 (pool_indexes_to_free, index);
1684 vec_foreach (i, pool_indexes_to_free)
1686 ip4_full_reass_t *reass = pool_elt_at_index (rt->pool, i[0]);
1687 ip4_full_reass_drop_all (vm, node, reass, &n_left_to_next,
1689 ip4_full_reass_free (rm, rt, reass);
1692 clib_spinlock_unlock (&rt->lock);
1695 vec_free (pool_indexes_to_free);
1698 vec_set_len (event_data, 0);
1705 VLIB_REGISTER_NODE (ip4_full_reass_expire_node) = {
1706 .function = ip4_full_reass_walk_expired,
1707 .type = VLIB_NODE_TYPE_PROCESS,
1708 .name = "ip4-full-reassembly-expire-walk",
1709 .format_trace = format_ip4_full_reass_trace,
1710 .n_errors = ARRAY_LEN (ip4_full_reass_error_strings),
1711 .error_strings = ip4_full_reass_error_strings,
1716 format_ip4_full_reass_key (u8 * s, va_list * args)
1718 ip4_full_reass_key_t *key = va_arg (*args, ip4_full_reass_key_t *);
1721 "xx_id: %u, src: %U, dst: %U, frag_id: %u, proto: %u",
1722 key->xx_id, format_ip4_address, &key->src, format_ip4_address,
1723 &key->dst, clib_net_to_host_u16 (key->frag_id), key->proto);
1728 format_ip4_reass (u8 * s, va_list * args)
1730 vlib_main_t *vm = va_arg (*args, vlib_main_t *);
1731 ip4_full_reass_t *reass = va_arg (*args, ip4_full_reass_t *);
1733 s = format (s, "ID: %lu, key: %U\n first_bi: %u, data_len: %u, "
1734 "last_packet_octet: %u, trace_op_counter: %u\n",
1735 reass->id, format_ip4_full_reass_key, &reass->key,
1736 reass->first_bi, reass->data_len,
1737 reass->last_packet_octet, reass->trace_op_counter);
1739 u32 bi = reass->first_bi;
1743 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
1744 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
1747 " #%03u: range: [%u, %u], bi: %u, off: %d, len: %u, "
1748 "fragment[%u, %u]\n", counter, vnb->ip.reass.range_first,
1749 vnb->ip.reass.range_last, bi,
1750 ip4_full_reass_buffer_get_data_offset (b),
1751 ip4_full_reass_buffer_get_data_len (b),
1752 vnb->ip.reass.fragment_first, vnb->ip.reass.fragment_last);
1753 if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
1755 bi = b->next_buffer;
1765 static clib_error_t *
1766 show_ip4_reass (vlib_main_t * vm,
1767 unformat_input_t * input,
1768 CLIB_UNUSED (vlib_cli_command_t * lmd))
1770 ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1772 vlib_cli_output (vm, "---------------------");
1773 vlib_cli_output (vm, "IP4 reassembly status");
1774 vlib_cli_output (vm, "---------------------");
1775 bool details = false;
1776 if (unformat (input, "details"))
1781 u32 sum_reass_n = 0;
1782 ip4_full_reass_t *reass;
1784 const uword nthreads = vlib_num_workers () + 1;
1785 for (thread_index = 0; thread_index < nthreads; ++thread_index)
1787 ip4_full_reass_per_thread_t *rt = &rm->per_thread_data[thread_index];
1788 clib_spinlock_lock (&rt->lock);
1791 pool_foreach (reass, rt->pool) {
1792 vlib_cli_output (vm, "%U", format_ip4_reass, vm, reass);
1795 sum_reass_n += rt->reass_n;
1796 clib_spinlock_unlock (&rt->lock);
1798 vlib_cli_output (vm, "---------------------");
1799 vlib_cli_output (vm, "Current full IP4 reassemblies count: %lu\n",
1800 (long unsigned) sum_reass_n);
1801 vlib_cli_output (vm,
1802 "Maximum configured concurrent full IP4 reassemblies per worker-thread: %lu\n",
1803 (long unsigned) rm->max_reass_n);
1804 vlib_cli_output (vm,
1805 "Maximum configured amount of fragments "
1806 "per full IP4 reassembly: %lu\n",
1807 (long unsigned) rm->max_reass_len);
1808 vlib_cli_output (vm,
1809 "Maximum configured full IP4 reassembly timeout: %lums\n",
1810 (long unsigned) rm->timeout_ms);
1811 vlib_cli_output (vm,
1812 "Maximum configured full IP4 reassembly expire walk interval: %lums\n",
1813 (long unsigned) rm->expire_walk_interval_ms);
1817 VLIB_CLI_COMMAND (show_ip4_full_reass_cmd, static) = {
1818 .path = "show ip4-full-reassembly",
1819 .short_help = "show ip4-full-reassembly [details]",
1820 .function = show_ip4_reass,
1823 #ifndef CLIB_MARCH_VARIANT
1825 ip4_full_reass_enable_disable (u32 sw_if_index, u8 enable_disable)
1827 return vnet_feature_enable_disable ("ip4-unicast",
1828 "ip4-full-reassembly-feature",
1829 sw_if_index, enable_disable, 0, 0);
1831 #endif /* CLIB_MARCH_VARIANT */
1834 #define foreach_ip4_full_reass_handoff_error \
1835 _(CONGESTION_DROP, "congestion drop")
1840 #define _(sym,str) IP4_FULL_REASS_HANDOFF_ERROR_##sym,
1841 foreach_ip4_full_reass_handoff_error
1843 IP4_FULL_REASS_HANDOFF_N_ERROR,
1844 } ip4_full_reass_handoff_error_t;
1846 static char *ip4_full_reass_handoff_error_strings[] = {
1847 #define _(sym,string) string,
1848 foreach_ip4_full_reass_handoff_error
1854 u32 next_worker_index;
1855 } ip4_full_reass_handoff_trace_t;
1858 format_ip4_full_reass_handoff_trace (u8 * s, va_list * args)
1860 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
1861 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
1862 ip4_full_reass_handoff_trace_t *t =
1863 va_arg (*args, ip4_full_reass_handoff_trace_t *);
1866 format (s, "ip4-full-reassembly-handoff: next-worker %d",
1867 t->next_worker_index);
1873 ip4_full_reass_handoff_node_inline (vlib_main_t *vm, vlib_node_runtime_t *node,
1874 vlib_frame_t *frame,
1875 ip4_full_reass_node_type_t type,
1878 ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1880 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
1881 u32 n_enq, n_left_from, *from;
1882 u16 thread_indices[VLIB_FRAME_SIZE], *ti;
1885 from = vlib_frame_vector_args (frame);
1886 n_left_from = frame->n_vectors;
1887 vlib_get_buffers (vm, from, bufs, n_left_from);
1890 ti = thread_indices;
1897 fq_index = rm->fq_local_index;
1901 fq_index = rm->fq_index;
1905 fq_index = rm->fq_feature_index;
1908 fq_index = rm->fq_custom_index;
1911 clib_warning ("Unexpected `type' (%d)!", type);
1914 while (n_left_from > 0)
1916 ti[0] = vnet_buffer (b[0])->ip.reass.owner_thread_index;
1919 ((node->flags & VLIB_NODE_FLAG_TRACE)
1920 && (b[0]->flags & VLIB_BUFFER_IS_TRACED)))
1922 ip4_full_reass_handoff_trace_t *t =
1923 vlib_add_trace (vm, node, b[0], sizeof (*t));
1924 t->next_worker_index = ti[0];
1931 n_enq = vlib_buffer_enqueue_to_thread (vm, node, fq_index, from,
1932 thread_indices, frame->n_vectors, 1);
1934 if (n_enq < frame->n_vectors)
1935 vlib_node_increment_counter (vm, node->node_index,
1936 IP4_FULL_REASS_HANDOFF_ERROR_CONGESTION_DROP,
1937 frame->n_vectors - n_enq);
1938 return frame->n_vectors;
1941 VLIB_NODE_FN (ip4_full_reass_handoff_node) (vlib_main_t * vm,
1942 vlib_node_runtime_t * node,
1943 vlib_frame_t * frame)
1945 return ip4_full_reass_handoff_node_inline (vm, node, frame, NORMAL,
1946 false /* is_local */);
1950 VLIB_REGISTER_NODE (ip4_full_reass_handoff_node) = {
1951 .name = "ip4-full-reassembly-handoff",
1952 .vector_size = sizeof (u32),
1953 .n_errors = ARRAY_LEN(ip4_full_reass_handoff_error_strings),
1954 .error_strings = ip4_full_reass_handoff_error_strings,
1955 .format_trace = format_ip4_full_reass_handoff_trace,
1964 VLIB_NODE_FN (ip4_local_full_reass_handoff_node)
1965 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
1967 return ip4_full_reass_handoff_node_inline (vm, node, frame, NORMAL,
1968 true /* is_local */);
1971 VLIB_REGISTER_NODE (ip4_local_full_reass_handoff_node) = {
1972 .name = "ip4-local-full-reassembly-handoff",
1973 .vector_size = sizeof (u32),
1974 .n_errors = ARRAY_LEN(ip4_full_reass_handoff_error_strings),
1975 .error_strings = ip4_full_reass_handoff_error_strings,
1976 .format_trace = format_ip4_full_reass_handoff_trace,
1985 VLIB_NODE_FN (ip4_full_reass_feature_handoff_node) (vlib_main_t * vm,
1986 vlib_node_runtime_t *
1988 vlib_frame_t * frame)
1990 return ip4_full_reass_handoff_node_inline (vm, node, frame, FEATURE,
1991 false /* is_local */);
1994 VLIB_REGISTER_NODE (ip4_full_reass_feature_handoff_node) = {
1995 .name = "ip4-full-reass-feature-hoff",
1996 .vector_size = sizeof (u32),
1997 .n_errors = ARRAY_LEN(ip4_full_reass_handoff_error_strings),
1998 .error_strings = ip4_full_reass_handoff_error_strings,
1999 .format_trace = format_ip4_full_reass_handoff_trace,
2008 VLIB_NODE_FN (ip4_full_reass_custom_handoff_node) (vlib_main_t * vm,
2009 vlib_node_runtime_t *
2011 vlib_frame_t * frame)
2013 return ip4_full_reass_handoff_node_inline (vm, node, frame, CUSTOM,
2014 false /* is_local */);
2017 VLIB_REGISTER_NODE (ip4_full_reass_custom_handoff_node) = {
2018 .name = "ip4-full-reass-custom-hoff",
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 #ifndef CLIB_MARCH_VARIANT
2033 ip4_full_reass_enable_disable_with_refcnt (u32 sw_if_index, int is_enable)
2035 ip4_full_reass_main_t *rm = &ip4_full_reass_main;
2036 vec_validate (rm->feature_use_refcount_per_intf, sw_if_index);
2039 if (!rm->feature_use_refcount_per_intf[sw_if_index])
2041 ++rm->feature_use_refcount_per_intf[sw_if_index];
2042 return vnet_feature_enable_disable ("ip4-unicast",
2043 "ip4-full-reassembly-feature",
2044 sw_if_index, 1, 0, 0);
2046 ++rm->feature_use_refcount_per_intf[sw_if_index];
2050 --rm->feature_use_refcount_per_intf[sw_if_index];
2051 if (!rm->feature_use_refcount_per_intf[sw_if_index])
2052 return vnet_feature_enable_disable ("ip4-unicast",
2053 "ip4-full-reassembly-feature",
2054 sw_if_index, 0, 0, 0);
2060 ip4_local_full_reass_enable_disable (int enable)
2064 ip4_full_reass_main.is_local_reass_enabled = 1;
2068 ip4_full_reass_main.is_local_reass_enabled = 0;
2073 ip4_local_full_reass_enabled ()
2075 return ip4_full_reass_main.is_local_reass_enabled;
2081 * fd.io coding-style-patch-verification: ON
2084 * eval: (c-set-style "gnu")