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 Reassembly.
20 * This file contains the source code for IPv4 reassembly.
23 #include <vppinfra/vec.h>
24 #include <vnet/vnet.h>
25 #include <vnet/ip/ip.h>
26 #include <vppinfra/bihash_16_8.h>
27 #include <vnet/ip/ip4_reassembly.h>
29 #define MSEC_PER_SEC 1000
30 #define IP4_REASS_TIMEOUT_DEFAULT_MS 100
31 #define IP4_REASS_EXPIRE_WALK_INTERVAL_DEFAULT_MS 10000 // 10 seconds default
32 #define IP4_REASS_MAX_REASSEMBLIES_DEFAULT 1024
33 #define IP4_REASS_HT_LOAD_FACTOR (0.75)
35 #define IP4_REASS_DEBUG_BUFFERS 0
36 #if IP4_REASS_DEBUG_BUFFERS
37 #define IP4_REASS_DEBUG_BUFFER(bi, what) \
41 printf (#what "buffer %u", _bi); \
42 vlib_buffer_t *_b = vlib_get_buffer (vm, _bi); \
43 while (_b->flags & VLIB_BUFFER_NEXT_PRESENT) \
45 _bi = _b->next_buffer; \
46 printf ("[%u]", _bi); \
47 _b = vlib_get_buffer (vm, _bi); \
54 #define IP4_REASS_DEBUG_BUFFER(...)
60 IP4_REASS_RC_INTERNAL_ERROR,
98 clib_bihash_kv_16_8_t kv;
102 ip4_reass_buffer_get_data_offset (vlib_buffer_t * b)
104 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
105 return vnb->ip.reass.range_first - vnb->ip.reass.fragment_first;
109 ip4_reass_buffer_get_data_len (vlib_buffer_t * b)
111 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
112 return clib_min (vnb->ip.reass.range_last, vnb->ip.reass.fragment_last) -
113 (vnb->ip.reass.fragment_first + ip4_reass_buffer_get_data_offset (b)) + 1;
120 // time when last packet was received
122 // internal id of this reassembly
124 // buffer index of first buffer in this reassembly context
126 // last octet of packet, ~0 until fragment without more_fragments arrives
127 u32 last_packet_octet;
128 // length of data collected so far
130 // trace operation counter
131 u32 trace_op_counter;
132 // next index - used by non-feature node
134 // minimum fragment length for this reassembly - used to estimate MTU
135 u16 min_fragment_length;
144 clib_spinlock_t lock;
145 } ip4_reass_per_thread_t;
152 u32 expire_walk_interval_ms;
156 clib_bihash_16_8_t hash;
158 ip4_reass_per_thread_t *per_thread_data;
161 vlib_main_t *vlib_main;
162 vnet_main_t *vnet_main;
164 // node index of ip4-drop node
166 u32 ip4_reass_expire_node_idx;
168 /** Worker handoff */
170 u32 fq_feature_index;
174 extern ip4_reass_main_t ip4_reass_main;
176 #ifndef CLIB_MARCH_VARIANT
177 ip4_reass_main_t ip4_reass_main;
178 #endif /* CLIB_MARCH_VARIANT */
182 IP4_REASSEMBLY_NEXT_INPUT,
183 IP4_REASSEMBLY_NEXT_DROP,
184 IP4_REASSEMBLY_NEXT_HANDOFF,
185 IP4_REASSEMBLY_N_NEXT,
195 } ip4_reass_trace_operation_e;
205 } ip4_reass_range_trace_t;
209 ip4_reass_trace_operation_e action;
211 ip4_reass_range_trace_t trace_range;
219 extern vlib_node_registration_t ip4_reass_node;
220 extern vlib_node_registration_t ip4_reass_node_feature;
223 ip4_reass_trace_details (vlib_main_t * vm, u32 bi,
224 ip4_reass_range_trace_t * trace)
226 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
227 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
228 trace->range_first = vnb->ip.reass.range_first;
229 trace->range_last = vnb->ip.reass.range_last;
230 trace->data_offset = ip4_reass_buffer_get_data_offset (b);
231 trace->data_len = ip4_reass_buffer_get_data_len (b);
232 trace->range_bi = bi;
236 format_ip4_reass_range_trace (u8 * s, va_list * args)
238 ip4_reass_range_trace_t *trace = va_arg (*args, ip4_reass_range_trace_t *);
239 s = format (s, "range: [%u, %u], off %d, len %u, bi %u", trace->range_first,
240 trace->range_last, trace->data_offset, trace->data_len,
246 format_ip4_reass_trace (u8 * s, va_list * args)
248 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
249 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
250 ip4_reass_trace_t *t = va_arg (*args, ip4_reass_trace_t *);
251 s = format (s, "reass id: %u, op id: %u ", t->reass_id, t->op_id);
252 u32 indent = format_get_indent (s);
253 s = format (s, "first bi: %u, data len: %u, ip/fragment[%u, %u]",
254 t->trace_range.first_bi, t->total_data_len, t->fragment_first,
259 s = format (s, "\n%Ushrink %U by %u", format_white_space, indent,
260 format_ip4_reass_range_trace, &t->trace_range,
264 s = format (s, "\n%Udiscard %U", format_white_space, indent,
265 format_ip4_reass_range_trace, &t->trace_range);
268 s = format (s, "\n%Unew %U", format_white_space, indent,
269 format_ip4_reass_range_trace, &t->trace_range);
272 s = format (s, "\n%Uoverlapping/ignored %U", format_white_space, indent,
273 format_ip4_reass_range_trace, &t->trace_range);
276 s = format (s, "\n%Ufinalize reassembly", format_white_space, indent);
283 ip4_reass_add_trace (vlib_main_t * vm, vlib_node_runtime_t * node,
284 ip4_reass_main_t * rm, ip4_reass_t * reass, u32 bi,
285 ip4_reass_trace_operation_e action, u32 size_diff)
287 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
288 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
289 if (pool_is_free_index (vm->trace_main.trace_buffer_pool, b->trace_index))
291 // this buffer's trace is gone
292 b->flags &= ~VLIB_BUFFER_IS_TRACED;
295 ip4_reass_trace_t *t = vlib_add_trace (vm, node, b, sizeof (t[0]));
296 t->reass_id = reass->id;
298 ip4_reass_trace_details (vm, bi, &t->trace_range);
299 t->size_diff = size_diff;
300 t->op_id = reass->trace_op_counter;
301 ++reass->trace_op_counter;
302 t->fragment_first = vnb->ip.reass.fragment_first;
303 t->fragment_last = vnb->ip.reass.fragment_last;
304 t->trace_range.first_bi = reass->first_bi;
305 t->total_data_len = reass->data_len;
308 s = format (s, "%U", format_ip4_reass_trace, NULL, NULL, t);
309 printf ("%.*s\n", vec_len (s), s);
311 vec_reset_length (s);
317 ip4_reass_free (ip4_reass_main_t * rm, ip4_reass_per_thread_t * rt,
320 clib_bihash_kv_16_8_t kv;
321 kv.key[0] = reass->key.as_u64[0];
322 kv.key[1] = reass->key.as_u64[1];
323 clib_bihash_add_del_16_8 (&rm->hash, &kv, 0);
324 pool_put (rt->pool, reass);
329 ip4_reass_on_timeout (vlib_main_t * vm, ip4_reass_main_t * rm,
332 u32 range_bi = reass->first_bi;
333 vlib_buffer_t *range_b;
334 vnet_buffer_opaque_t *range_vnb;
336 while (~0 != range_bi)
338 range_b = vlib_get_buffer (vm, range_bi);
339 range_vnb = vnet_buffer (range_b);
343 vec_add1 (to_free, bi);
344 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
345 if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
348 b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
355 range_bi = range_vnb->ip.reass.next_range_bi;
357 vlib_buffer_free (vm, to_free, vec_len (to_free));
362 ip4_reass_find_or_create (vlib_main_t * vm, ip4_reass_main_t * rm,
363 ip4_reass_per_thread_t * rt, ip4_reass_kv_t * kv,
366 ip4_reass_t *reass = NULL;
367 f64 now = vlib_time_now (rm->vlib_main);
369 if (!clib_bihash_search_16_8
370 (&rm->hash, (clib_bihash_kv_16_8_t *) kv, (clib_bihash_kv_16_8_t *) kv))
372 if (vm->thread_index != kv->v.thread_index)
377 reass = pool_elt_at_index (rt->pool, kv->v.reass_index);
379 if (now > reass->last_heard + rm->timeout)
381 ip4_reass_on_timeout (vm, rm, reass);
382 ip4_reass_free (rm, rt, reass);
389 reass->last_heard = now;
393 if (rt->reass_n >= rm->max_reass_n)
400 pool_get (rt->pool, reass);
401 clib_memset (reass, 0, sizeof (*reass));
402 reass->id = ((u64) vm->thread_index * 1000000000) + rt->id_counter;
404 reass->first_bi = ~0;
405 reass->last_packet_octet = ~0;
410 reass->key.as_u64[0] = ((clib_bihash_kv_16_8_t *) kv)->key[0];
411 reass->key.as_u64[1] = ((clib_bihash_kv_16_8_t *) kv)->key[1];
412 kv->v.reass_index = (reass - rt->pool);
413 kv->v.thread_index = vm->thread_index;
414 reass->last_heard = now;
416 if (clib_bihash_add_del_16_8 (&rm->hash, (clib_bihash_kv_16_8_t *) kv, 1))
418 ip4_reass_free (rm, rt, reass);
425 always_inline ip4_reass_rc_t
426 ip4_reass_finalize (vlib_main_t * vm, vlib_node_runtime_t * node,
427 ip4_reass_main_t * rm, ip4_reass_per_thread_t * rt,
428 ip4_reass_t * reass, u32 * bi0, u32 * next0, u32 * error0,
431 vlib_buffer_t *first_b = vlib_get_buffer (vm, reass->first_bi);
432 vlib_buffer_t *last_b = NULL;
433 u32 sub_chain_bi = reass->first_bi;
434 u32 total_length = 0;
438 u32 tmp_bi = sub_chain_bi;
439 vlib_buffer_t *tmp = vlib_get_buffer (vm, tmp_bi);
440 ip4_header_t *ip = vlib_buffer_get_current (tmp);
441 vnet_buffer_opaque_t *vnb = vnet_buffer (tmp);
442 if (!(vnb->ip.reass.range_first >= vnb->ip.reass.fragment_first) &&
443 !(vnb->ip.reass.range_last > vnb->ip.reass.fragment_first))
445 return IP4_REASS_RC_INTERNAL_ERROR;
448 u32 data_len = ip4_reass_buffer_get_data_len (tmp);
450 ip4_header_bytes (ip) + ip4_reass_buffer_get_data_offset (tmp);
452 vlib_buffer_length_in_chain (vm, tmp) - trim_front - data_len;
453 if (tmp_bi == reass->first_bi)
455 /* first buffer - keep ip4 header */
456 if (0 != ip4_reass_buffer_get_data_offset (tmp))
458 return IP4_REASS_RC_INTERNAL_ERROR;
461 trim_end = vlib_buffer_length_in_chain (vm, tmp) - data_len -
462 ip4_header_bytes (ip);
463 if (!(vlib_buffer_length_in_chain (vm, tmp) - trim_end > 0))
465 return IP4_REASS_RC_INTERNAL_ERROR;
469 vlib_buffer_length_in_chain (vm, tmp) - trim_front - trim_end;
475 if (trim_front > tmp->current_length)
477 /* drop whole buffer */
478 vlib_buffer_free_one (vm, tmp_bi);
479 trim_front -= tmp->current_length;
480 if (!(tmp->flags & VLIB_BUFFER_NEXT_PRESENT))
482 return IP4_REASS_RC_INTERNAL_ERROR;
484 tmp->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
485 tmp_bi = tmp->next_buffer;
486 tmp = vlib_get_buffer (vm, tmp_bi);
491 vlib_buffer_advance (tmp, trim_front);
499 last_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
500 last_b->next_buffer = tmp_bi;
503 if (keep_data <= tmp->current_length)
505 tmp->current_length = keep_data;
510 keep_data -= tmp->current_length;
511 if (!(tmp->flags & VLIB_BUFFER_NEXT_PRESENT))
513 return IP4_REASS_RC_INTERNAL_ERROR;
516 total_length += tmp->current_length;
520 vlib_buffer_free_one (vm, tmp_bi);
521 if (reass->first_bi == tmp_bi)
523 return IP4_REASS_RC_INTERNAL_ERROR;
526 if (tmp->flags & VLIB_BUFFER_NEXT_PRESENT)
528 tmp_bi = tmp->next_buffer;
529 tmp = vlib_get_buffer (vm, tmp->next_buffer);
537 vnet_buffer (vlib_get_buffer (vm, sub_chain_bi))->ip.
540 while (~0 != sub_chain_bi);
544 return IP4_REASS_RC_INTERNAL_ERROR;
546 last_b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
547 if (total_length < first_b->current_length)
549 return IP4_REASS_RC_INTERNAL_ERROR;
551 total_length -= first_b->current_length;
552 first_b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
553 first_b->total_length_not_including_first_buffer = total_length;
554 ip4_header_t *ip = vlib_buffer_get_current (first_b);
555 ip->flags_and_fragment_offset = 0;
556 ip->length = clib_host_to_net_u16 (first_b->current_length + total_length);
557 ip->checksum = ip4_header_checksum (ip);
558 if (!vlib_buffer_chain_linearize (vm, first_b))
560 return IP4_REASS_RC_NO_BUF;
563 if (PREDICT_FALSE (first_b->flags & VLIB_BUFFER_IS_TRACED))
565 ip4_reass_add_trace (vm, node, rm, reass, reass->first_bi, FINALIZE, 0);
567 // following code does a hexdump of packet fragments to stdout ...
570 u32 bi = reass->first_bi;
574 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
575 s = format (s, "%u: %U\n", bi, format_hexdump,
576 vlib_buffer_get_current (b), b->current_length);
577 if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
586 printf ("%.*s\n", vec_len (s), s);
593 *bi0 = reass->first_bi;
596 *next0 = IP4_REASSEMBLY_NEXT_INPUT;
600 *next0 = reass->next_index;
602 vnet_buffer (first_b)->ip.reass.estimated_mtu = reass->min_fragment_length;
603 *error0 = IP4_ERROR_NONE;
604 ip4_reass_free (rm, rt, reass);
606 return IP4_REASS_RC_OK;
609 always_inline ip4_reass_rc_t
610 ip4_reass_insert_range_in_chain (vlib_main_t * vm,
611 ip4_reass_main_t * rm,
612 ip4_reass_per_thread_t * rt,
614 u32 prev_range_bi, u32 new_next_bi)
616 vlib_buffer_t *new_next_b = vlib_get_buffer (vm, new_next_bi);
617 vnet_buffer_opaque_t *new_next_vnb = vnet_buffer (new_next_b);
618 if (~0 != prev_range_bi)
620 vlib_buffer_t *prev_b = vlib_get_buffer (vm, prev_range_bi);
621 vnet_buffer_opaque_t *prev_vnb = vnet_buffer (prev_b);
622 new_next_vnb->ip.reass.next_range_bi = prev_vnb->ip.reass.next_range_bi;
623 prev_vnb->ip.reass.next_range_bi = new_next_bi;
627 if (~0 != reass->first_bi)
629 new_next_vnb->ip.reass.next_range_bi = reass->first_bi;
631 reass->first_bi = new_next_bi;
633 vnet_buffer_opaque_t *vnb = vnet_buffer (new_next_b);
634 if (!(vnb->ip.reass.range_first >= vnb->ip.reass.fragment_first) &&
635 !(vnb->ip.reass.range_last > vnb->ip.reass.fragment_first))
637 return IP4_REASS_RC_INTERNAL_ERROR;
639 reass->data_len += ip4_reass_buffer_get_data_len (new_next_b);
640 return IP4_REASS_RC_OK;
643 always_inline ip4_reass_rc_t
644 ip4_reass_remove_range_from_chain (vlib_main_t * vm,
645 vlib_node_runtime_t * node,
646 ip4_reass_main_t * rm,
647 ip4_reass_t * reass, u32 prev_range_bi,
650 vlib_buffer_t *discard_b = vlib_get_buffer (vm, discard_bi);
651 vnet_buffer_opaque_t *discard_vnb = vnet_buffer (discard_b);
652 if (~0 != prev_range_bi)
654 vlib_buffer_t *prev_b = vlib_get_buffer (vm, prev_range_bi);
655 vnet_buffer_opaque_t *prev_vnb = vnet_buffer (prev_b);
656 if (!(prev_vnb->ip.reass.next_range_bi == discard_bi))
658 return IP4_REASS_RC_INTERNAL_ERROR;
660 prev_vnb->ip.reass.next_range_bi = discard_vnb->ip.reass.next_range_bi;
664 reass->first_bi = discard_vnb->ip.reass.next_range_bi;
666 vnet_buffer_opaque_t *vnb = vnet_buffer (discard_b);
667 if (!(vnb->ip.reass.range_first >= vnb->ip.reass.fragment_first) &&
668 !(vnb->ip.reass.range_last > vnb->ip.reass.fragment_first))
670 return IP4_REASS_RC_INTERNAL_ERROR;
672 reass->data_len -= ip4_reass_buffer_get_data_len (discard_b);
675 vlib_buffer_free_one (vm, discard_bi);
676 if (PREDICT_FALSE (discard_b->flags & VLIB_BUFFER_IS_TRACED))
678 ip4_reass_add_trace (vm, node, rm, reass, discard_bi, RANGE_DISCARD,
681 if (discard_b->flags & VLIB_BUFFER_NEXT_PRESENT)
683 discard_b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
684 discard_bi = discard_b->next_buffer;
685 discard_b = vlib_get_buffer (vm, discard_bi);
692 return IP4_REASS_RC_OK;
695 always_inline ip4_reass_rc_t
696 ip4_reass_update (vlib_main_t * vm, vlib_node_runtime_t * node,
697 ip4_reass_main_t * rm, ip4_reass_per_thread_t * rt,
698 ip4_reass_t * reass, u32 * bi0, u32 * next0, u32 * error0,
701 ip4_reass_rc_t rc = IP4_REASS_RC_OK;
703 vlib_buffer_t *fb = vlib_get_buffer (vm, *bi0);
704 ip4_header_t *fip = vlib_buffer_get_current (fb);
705 vnet_buffer_opaque_t *fvnb = vnet_buffer (fb);
706 reass->next_index = fvnb->ip.reass.next_index; // store next_index before it's overwritten
707 const u32 fragment_first = ip4_get_fragment_offset_bytes (fip);
708 const u32 fragment_length =
709 clib_net_to_host_u16 (fip->length) - ip4_header_bytes (fip);
710 const u32 fragment_last = fragment_first + fragment_length - 1;
711 fvnb->ip.reass.fragment_first = fragment_first;
712 fvnb->ip.reass.fragment_last = fragment_last;
713 int more_fragments = ip4_get_fragment_more (fip);
714 u32 candidate_range_bi = reass->first_bi;
715 u32 prev_range_bi = ~0;
716 fvnb->ip.reass.range_first = fragment_first;
717 fvnb->ip.reass.range_last = fragment_last;
718 fvnb->ip.reass.next_range_bi = ~0;
721 reass->last_packet_octet = fragment_last;
723 if (~0 == reass->first_bi)
725 // starting a new reassembly
727 ip4_reass_insert_range_in_chain (vm, rm, rt, reass, prev_range_bi,
729 if (IP4_REASS_RC_OK != rc)
733 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
735 ip4_reass_add_trace (vm, node, rm, reass, *bi0, RANGE_NEW, 0);
738 reass->min_fragment_length = clib_net_to_host_u16 (fip->length);
739 return IP4_REASS_RC_OK;
741 reass->min_fragment_length = clib_min (clib_net_to_host_u16 (fip->length),
742 fvnb->ip.reass.estimated_mtu);
743 while (~0 != candidate_range_bi)
745 vlib_buffer_t *candidate_b = vlib_get_buffer (vm, candidate_range_bi);
746 vnet_buffer_opaque_t *candidate_vnb = vnet_buffer (candidate_b);
747 if (fragment_first > candidate_vnb->ip.reass.range_last)
749 // this fragments starts after candidate range
750 prev_range_bi = candidate_range_bi;
751 candidate_range_bi = candidate_vnb->ip.reass.next_range_bi;
752 if (candidate_vnb->ip.reass.range_last < fragment_last &&
753 ~0 == candidate_range_bi)
755 // special case - this fragment falls beyond all known ranges
757 ip4_reass_insert_range_in_chain (vm, rm, rt, reass,
758 prev_range_bi, *bi0);
759 if (IP4_REASS_RC_OK != rc)
768 if (fragment_last < candidate_vnb->ip.reass.range_first)
770 // this fragment ends before candidate range without any overlap
772 ip4_reass_insert_range_in_chain (vm, rm, rt, reass, prev_range_bi,
774 if (IP4_REASS_RC_OK != rc)
782 if (fragment_first >= candidate_vnb->ip.reass.range_first &&
783 fragment_last <= candidate_vnb->ip.reass.range_last)
785 // this fragment is a (sub)part of existing range, ignore it
786 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
788 ip4_reass_add_trace (vm, node, rm, reass, *bi0,
793 int discard_candidate = 0;
794 if (fragment_first < candidate_vnb->ip.reass.range_first)
797 fragment_last - candidate_vnb->ip.reass.range_first + 1;
798 if (overlap < ip4_reass_buffer_get_data_len (candidate_b))
800 candidate_vnb->ip.reass.range_first += overlap;
801 if (reass->data_len < overlap)
803 return IP4_REASS_RC_INTERNAL_ERROR;
805 reass->data_len -= overlap;
806 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
808 ip4_reass_add_trace (vm, node, rm, reass,
809 candidate_range_bi, RANGE_SHRINK,
813 ip4_reass_insert_range_in_chain (vm, rm, rt, reass,
814 prev_range_bi, *bi0);
815 if (IP4_REASS_RC_OK != rc)
823 discard_candidate = 1;
826 else if (fragment_last > candidate_vnb->ip.reass.range_last)
829 candidate_vnb->ip.reass.range_last - fragment_first + 1;
830 if (overlap < ip4_reass_buffer_get_data_len (candidate_b))
832 fvnb->ip.reass.range_first += overlap;
833 if (~0 != candidate_vnb->ip.reass.next_range_bi)
835 prev_range_bi = candidate_range_bi;
837 candidate_vnb->ip.reass.next_range_bi;
842 // special case - last range discarded
844 ip4_reass_insert_range_in_chain (vm, rm, rt, reass,
847 if (IP4_REASS_RC_OK != rc)
856 discard_candidate = 1;
861 discard_candidate = 1;
863 if (discard_candidate)
865 u32 next_range_bi = candidate_vnb->ip.reass.next_range_bi;
866 // discard candidate range, probe next range
868 ip4_reass_remove_range_from_chain (vm, node, rm, reass,
871 if (IP4_REASS_RC_OK != rc)
875 if (~0 != next_range_bi)
877 candidate_range_bi = next_range_bi;
882 // special case - last range discarded
884 ip4_reass_insert_range_in_chain (vm, rm, rt, reass,
885 prev_range_bi, *bi0);
886 if (IP4_REASS_RC_OK != rc)
898 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
900 ip4_reass_add_trace (vm, node, rm, reass, *bi0, RANGE_NEW, 0);
903 if (~0 != reass->last_packet_octet &&
904 reass->data_len == reass->last_packet_octet + 1)
906 return ip4_reass_finalize (vm, node, rm, rt, reass, bi0, next0, error0,
917 *next0 = IP4_REASSEMBLY_NEXT_DROP;
918 *error0 = IP4_ERROR_REASS_DUPLICATE_FRAGMENT;
925 ip4_reassembly_inline (vlib_main_t * vm,
926 vlib_node_runtime_t * node,
927 vlib_frame_t * frame, bool is_feature)
929 u32 *from = vlib_frame_vector_args (frame);
930 u32 n_left_from, n_left_to_next, *to_next, next_index;
931 ip4_reass_main_t *rm = &ip4_reass_main;
932 ip4_reass_per_thread_t *rt = &rm->per_thread_data[vm->thread_index];
933 clib_spinlock_lock (&rt->lock);
935 n_left_from = frame->n_vectors;
936 next_index = node->cached_next_index;
937 while (n_left_from > 0)
939 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
941 while (n_left_from > 0 && n_left_to_next > 0)
946 u32 error0 = IP4_ERROR_NONE;
949 b0 = vlib_get_buffer (vm, bi0);
951 ip4_header_t *ip0 = vlib_buffer_get_current (b0);
952 if (!ip4_get_fragment_more (ip0) && !ip4_get_fragment_offset (ip0))
954 // this is a whole packet - no fragmentation
957 next0 = IP4_REASSEMBLY_NEXT_INPUT;
961 next0 = vnet_buffer (b0)->ip.reass.next_index;
966 const u32 fragment_first = ip4_get_fragment_offset_bytes (ip0);
967 const u32 fragment_length =
968 clib_net_to_host_u16 (ip0->length) - ip4_header_bytes (ip0);
969 const u32 fragment_last = fragment_first + fragment_length - 1;
970 if (fragment_first > fragment_last || fragment_first + fragment_length > UINT16_MAX - 20 || (fragment_length < 8 && ip4_get_fragment_more (ip0))) // 8 is minimum frag length per RFC 791
972 next0 = IP4_REASSEMBLY_NEXT_DROP;
973 error0 = IP4_ERROR_REASS_MALFORMED_PACKET;
981 (u64) vec_elt (ip4_main.fib_index_by_sw_if_index,
982 vnet_buffer (b0)->sw_if_index[VLIB_RX]) |
983 (u64) ip0->src_address.as_u32 << 32;
985 (u64) ip0->dst_address.as_u32 |
986 (u64) ip0->fragment_id << 32 | (u64) ip0->protocol << 48;
989 ip4_reass_find_or_create (vm, rm, rt, &kv, &do_handoff);
991 if (PREDICT_FALSE (do_handoff))
993 next0 = IP4_REASSEMBLY_NEXT_HANDOFF;
995 vnet_buffer (b0)->ip.
996 reass.owner_feature_thread_index =
999 vnet_buffer (b0)->ip.reass.owner_thread_index =
1004 switch (ip4_reass_update
1005 (vm, node, rm, rt, reass, &bi0, &next0,
1006 &error0, is_feature))
1008 case IP4_REASS_RC_OK:
1009 /* nothing to do here */
1011 case IP4_REASS_RC_NO_BUF:
1013 case IP4_REASS_RC_INTERNAL_ERROR:
1014 /* drop everything and start with a clean slate */
1015 ip4_reass_on_timeout (vm, rm, reass);
1016 ip4_reass_free (rm, rt, reass);
1023 next0 = IP4_REASSEMBLY_NEXT_DROP;
1024 error0 = IP4_ERROR_REASS_LIMIT_REACHED;
1028 b0->error = node->errors[error0];
1035 n_left_to_next -= 1;
1036 if (is_feature && IP4_ERROR_NONE == error0)
1038 b0 = vlib_get_buffer (vm, bi0);
1039 vnet_feature_next (&next0, b0);
1041 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
1042 to_next, n_left_to_next,
1044 IP4_REASS_DEBUG_BUFFER (bi0, enqueue_next);
1052 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1055 clib_spinlock_unlock (&rt->lock);
1056 return frame->n_vectors;
1059 static char *ip4_reassembly_error_strings[] = {
1060 #define _(sym, string) string,
1065 VLIB_NODE_FN (ip4_reass_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
1066 vlib_frame_t * frame)
1068 return ip4_reassembly_inline (vm, node, frame, false /* is_feature */ );
1072 VLIB_REGISTER_NODE (ip4_reass_node) = {
1073 .name = "ip4-reassembly",
1074 .vector_size = sizeof (u32),
1075 .format_trace = format_ip4_reass_trace,
1076 .n_errors = ARRAY_LEN (ip4_reassembly_error_strings),
1077 .error_strings = ip4_reassembly_error_strings,
1078 .n_next_nodes = IP4_REASSEMBLY_N_NEXT,
1081 [IP4_REASSEMBLY_NEXT_INPUT] = "ip4-input",
1082 [IP4_REASSEMBLY_NEXT_DROP] = "ip4-drop",
1083 [IP4_REASSEMBLY_NEXT_HANDOFF] = "ip4-reassembly-handoff",
1089 VLIB_NODE_FN (ip4_reass_node_feature) (vlib_main_t * vm,
1090 vlib_node_runtime_t * node,
1091 vlib_frame_t * frame)
1093 return ip4_reassembly_inline (vm, node, frame, true /* is_feature */ );
1097 VLIB_REGISTER_NODE (ip4_reass_node_feature) = {
1098 .name = "ip4-reassembly-feature",
1099 .vector_size = sizeof (u32),
1100 .format_trace = format_ip4_reass_trace,
1101 .n_errors = ARRAY_LEN (ip4_reassembly_error_strings),
1102 .error_strings = ip4_reassembly_error_strings,
1103 .n_next_nodes = IP4_REASSEMBLY_N_NEXT,
1106 [IP4_REASSEMBLY_NEXT_INPUT] = "ip4-input",
1107 [IP4_REASSEMBLY_NEXT_DROP] = "ip4-drop",
1108 [IP4_REASSEMBLY_NEXT_HANDOFF] = "ip4-reass-feature-hoff",
1114 VNET_FEATURE_INIT (ip4_reassembly_feature, static) = {
1115 .arc_name = "ip4-unicast",
1116 .node_name = "ip4-reassembly-feature",
1117 .runs_before = VNET_FEATURES ("ip4-lookup"),
1122 #ifndef CLIB_MARCH_VARIANT
1124 ip4_reass_get_nbuckets ()
1126 ip4_reass_main_t *rm = &ip4_reass_main;
1130 nbuckets = (u32) (rm->max_reass_n / IP4_REASS_HT_LOAD_FACTOR);
1132 for (i = 0; i < 31; i++)
1133 if ((1 << i) >= nbuckets)
1139 #endif /* CLIB_MARCH_VARIANT */
1143 IP4_EVENT_CONFIG_CHANGED = 1,
1144 } ip4_reass_event_t;
1149 clib_bihash_16_8_t *new_hash;
1150 } ip4_rehash_cb_ctx;
1152 #ifndef CLIB_MARCH_VARIANT
1154 ip4_rehash_cb (clib_bihash_kv_16_8_t * kv, void *_ctx)
1156 ip4_rehash_cb_ctx *ctx = _ctx;
1157 if (clib_bihash_add_del_16_8 (ctx->new_hash, kv, 1))
1164 ip4_reass_set_params (u32 timeout_ms, u32 max_reassemblies,
1165 u32 expire_walk_interval_ms)
1167 ip4_reass_main.timeout_ms = timeout_ms;
1168 ip4_reass_main.timeout = (f64) timeout_ms / (f64) MSEC_PER_SEC;
1169 ip4_reass_main.max_reass_n = max_reassemblies;
1170 ip4_reass_main.expire_walk_interval_ms = expire_walk_interval_ms;
1174 ip4_reass_set (u32 timeout_ms, u32 max_reassemblies,
1175 u32 expire_walk_interval_ms)
1177 u32 old_nbuckets = ip4_reass_get_nbuckets ();
1178 ip4_reass_set_params (timeout_ms, max_reassemblies,
1179 expire_walk_interval_ms);
1180 vlib_process_signal_event (ip4_reass_main.vlib_main,
1181 ip4_reass_main.ip4_reass_expire_node_idx,
1182 IP4_EVENT_CONFIG_CHANGED, 0);
1183 u32 new_nbuckets = ip4_reass_get_nbuckets ();
1184 if (ip4_reass_main.max_reass_n > 0 && new_nbuckets > old_nbuckets)
1186 clib_bihash_16_8_t new_hash;
1187 clib_memset (&new_hash, 0, sizeof (new_hash));
1188 ip4_rehash_cb_ctx ctx;
1190 ctx.new_hash = &new_hash;
1191 clib_bihash_init_16_8 (&new_hash, "ip4-reass", new_nbuckets,
1192 new_nbuckets * 1024);
1193 clib_bihash_foreach_key_value_pair_16_8 (&ip4_reass_main.hash,
1194 ip4_rehash_cb, &ctx);
1197 clib_bihash_free_16_8 (&new_hash);
1202 clib_bihash_free_16_8 (&ip4_reass_main.hash);
1203 clib_memcpy_fast (&ip4_reass_main.hash, &new_hash,
1204 sizeof (ip4_reass_main.hash));
1211 ip4_reass_get (u32 * timeout_ms, u32 * max_reassemblies,
1212 u32 * expire_walk_interval_ms)
1214 *timeout_ms = ip4_reass_main.timeout_ms;
1215 *max_reassemblies = ip4_reass_main.max_reass_n;
1216 *expire_walk_interval_ms = ip4_reass_main.expire_walk_interval_ms;
1220 static clib_error_t *
1221 ip4_reass_init_function (vlib_main_t * vm)
1223 ip4_reass_main_t *rm = &ip4_reass_main;
1224 clib_error_t *error = 0;
1229 rm->vnet_main = vnet_get_main ();
1231 vec_validate (rm->per_thread_data, vlib_num_workers ());
1232 ip4_reass_per_thread_t *rt;
1233 vec_foreach (rt, rm->per_thread_data)
1235 clib_spinlock_init (&rt->lock);
1236 pool_alloc (rt->pool, rm->max_reass_n);
1239 node = vlib_get_node_by_name (vm, (u8 *) "ip4-reassembly-expire-walk");
1241 rm->ip4_reass_expire_node_idx = node->index;
1243 ip4_reass_set_params (IP4_REASS_TIMEOUT_DEFAULT_MS,
1244 IP4_REASS_MAX_REASSEMBLIES_DEFAULT,
1245 IP4_REASS_EXPIRE_WALK_INTERVAL_DEFAULT_MS);
1247 nbuckets = ip4_reass_get_nbuckets ();
1248 clib_bihash_init_16_8 (&rm->hash, "ip4-reass", nbuckets, nbuckets * 1024);
1250 node = vlib_get_node_by_name (vm, (u8 *) "ip4-drop");
1252 rm->ip4_drop_idx = node->index;
1254 rm->fq_index = vlib_frame_queue_main_init (ip4_reass_node.index, 0);
1255 rm->fq_feature_index =
1256 vlib_frame_queue_main_init (ip4_reass_node_feature.index, 0);
1262 VLIB_INIT_FUNCTION (ip4_reass_init_function);
1263 #endif /* CLIB_MARCH_VARIANT */
1266 ip4_reass_walk_expired (vlib_main_t * vm,
1267 vlib_node_runtime_t * node, vlib_frame_t * f)
1269 ip4_reass_main_t *rm = &ip4_reass_main;
1270 uword event_type, *event_data = 0;
1274 vlib_process_wait_for_event_or_clock (vm,
1276 rm->expire_walk_interval_ms /
1277 (f64) MSEC_PER_SEC);
1278 event_type = vlib_process_get_events (vm, &event_data);
1282 case ~0: /* no events => timeout */
1283 /* nothing to do here */
1285 case IP4_EVENT_CONFIG_CHANGED:
1288 clib_warning ("BUG: event type 0x%wx", event_type);
1291 f64 now = vlib_time_now (vm);
1294 int *pool_indexes_to_free = NULL;
1296 uword thread_index = 0;
1298 const uword nthreads = vlib_num_workers () + 1;
1299 for (thread_index = 0; thread_index < nthreads; ++thread_index)
1301 ip4_reass_per_thread_t *rt = &rm->per_thread_data[thread_index];
1302 clib_spinlock_lock (&rt->lock);
1304 vec_reset_length (pool_indexes_to_free);
1306 pool_foreach_index (index, rt->pool, ({
1307 reass = pool_elt_at_index (rt->pool, index);
1308 if (now > reass->last_heard + rm->timeout)
1310 vec_add1 (pool_indexes_to_free, index);
1316 vec_foreach (i, pool_indexes_to_free)
1318 ip4_reass_t *reass = pool_elt_at_index (rt->pool, i[0]);
1319 ip4_reass_on_timeout (vm, rm, reass);
1320 ip4_reass_free (rm, rt, reass);
1324 clib_spinlock_unlock (&rt->lock);
1327 vec_free (pool_indexes_to_free);
1330 _vec_len (event_data) = 0;
1338 VLIB_REGISTER_NODE (ip4_reass_expire_node, static) = {
1339 .function = ip4_reass_walk_expired,
1340 .type = VLIB_NODE_TYPE_PROCESS,
1341 .name = "ip4-reassembly-expire-walk",
1342 .format_trace = format_ip4_reass_trace,
1343 .n_errors = ARRAY_LEN (ip4_reassembly_error_strings),
1344 .error_strings = ip4_reassembly_error_strings,
1350 format_ip4_reass_key (u8 * s, va_list * args)
1352 ip4_reass_key_t *key = va_arg (*args, ip4_reass_key_t *);
1353 s = format (s, "xx_id: %u, src: %U, dst: %U, frag_id: %u, proto: %u",
1354 key->xx_id, format_ip4_address, &key->src, format_ip4_address,
1355 &key->dst, clib_net_to_host_u16 (key->frag_id), key->proto);
1360 format_ip4_reass (u8 * s, va_list * args)
1362 vlib_main_t *vm = va_arg (*args, vlib_main_t *);
1363 ip4_reass_t *reass = va_arg (*args, ip4_reass_t *);
1365 s = format (s, "ID: %lu, key: %U\n first_bi: %u, data_len: %u, "
1366 "last_packet_octet: %u, trace_op_counter: %u\n",
1367 reass->id, format_ip4_reass_key, &reass->key, reass->first_bi,
1368 reass->data_len, reass->last_packet_octet,
1369 reass->trace_op_counter);
1370 u32 bi = reass->first_bi;
1374 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
1375 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
1376 s = format (s, " #%03u: range: [%u, %u], bi: %u, off: %d, len: %u, "
1377 "fragment[%u, %u]\n",
1378 counter, vnb->ip.reass.range_first,
1379 vnb->ip.reass.range_last, bi,
1380 ip4_reass_buffer_get_data_offset (b),
1381 ip4_reass_buffer_get_data_len (b),
1382 vnb->ip.reass.fragment_first, vnb->ip.reass.fragment_last);
1383 if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
1385 bi = b->next_buffer;
1395 static clib_error_t *
1396 show_ip4_reass (vlib_main_t * vm,
1397 unformat_input_t * input,
1398 CLIB_UNUSED (vlib_cli_command_t * lmd))
1400 ip4_reass_main_t *rm = &ip4_reass_main;
1402 vlib_cli_output (vm, "---------------------");
1403 vlib_cli_output (vm, "IP4 reassembly status");
1404 vlib_cli_output (vm, "---------------------");
1405 bool details = false;
1406 if (unformat (input, "details"))
1411 u32 sum_reass_n = 0;
1414 const uword nthreads = vlib_num_workers () + 1;
1415 for (thread_index = 0; thread_index < nthreads; ++thread_index)
1417 ip4_reass_per_thread_t *rt = &rm->per_thread_data[thread_index];
1418 clib_spinlock_lock (&rt->lock);
1422 pool_foreach (reass, rt->pool, {
1423 vlib_cli_output (vm, "%U", format_ip4_reass, vm, reass);
1427 sum_reass_n += rt->reass_n;
1428 clib_spinlock_unlock (&rt->lock);
1430 vlib_cli_output (vm, "---------------------");
1431 vlib_cli_output (vm, "Current IP4 reassemblies count: %lu\n",
1432 (long unsigned) sum_reass_n);
1433 vlib_cli_output (vm,
1434 "Maximum configured concurrent IP4 reassemblies per worker-thread: %lu\n",
1435 (long unsigned) rm->max_reass_n);
1440 VLIB_CLI_COMMAND (show_ip4_reassembly_cmd, static) = {
1441 .path = "show ip4-reassembly",
1442 .short_help = "show ip4-reassembly [details]",
1443 .function = show_ip4_reass,
1447 #ifndef CLIB_MARCH_VARIANT
1449 ip4_reass_enable_disable (u32 sw_if_index, u8 enable_disable)
1451 return vnet_feature_enable_disable ("ip4-unicast",
1452 "ip4-reassembly-feature", sw_if_index,
1453 enable_disable, 0, 0);
1455 #endif /* CLIB_MARCH_VARIANT */
1458 #define foreach_ip4_reassembly_handoff_error \
1459 _(CONGESTION_DROP, "congestion drop")
1464 #define _(sym,str) IP4_REASSEMBLY_HANDOFF_ERROR_##sym,
1465 foreach_ip4_reassembly_handoff_error
1467 IP4_REASSEMBLY_HANDOFF_N_ERROR,
1468 } ip4_reassembly_handoff_error_t;
1470 static char *ip4_reassembly_handoff_error_strings[] = {
1471 #define _(sym,string) string,
1472 foreach_ip4_reassembly_handoff_error
1478 u32 next_worker_index;
1479 } ip4_reassembly_handoff_trace_t;
1482 format_ip4_reassembly_handoff_trace (u8 * s, va_list * args)
1484 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
1485 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
1486 ip4_reassembly_handoff_trace_t *t =
1487 va_arg (*args, ip4_reassembly_handoff_trace_t *);
1490 format (s, "ip4-reassembly-handoff: next-worker %d",
1491 t->next_worker_index);
1497 ip4_reassembly_handoff_node_inline (vlib_main_t * vm,
1498 vlib_node_runtime_t * node,
1499 vlib_frame_t * frame, bool is_feature)
1501 ip4_reass_main_t *rm = &ip4_reass_main;
1503 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
1504 u32 n_enq, n_left_from, *from;
1505 u16 thread_indices[VLIB_FRAME_SIZE], *ti;
1508 from = vlib_frame_vector_args (frame);
1509 n_left_from = frame->n_vectors;
1510 vlib_get_buffers (vm, from, bufs, n_left_from);
1513 ti = thread_indices;
1515 fq_index = (is_feature) ? rm->fq_feature_index : rm->fq_index;
1517 while (n_left_from > 0)
1520 (is_feature) ? vnet_buffer (b[0])->ip.
1521 reass.owner_feature_thread_index : vnet_buffer (b[0])->ip.
1522 reass.owner_thread_index;
1525 ((node->flags & VLIB_NODE_FLAG_TRACE)
1526 && (b[0]->flags & VLIB_BUFFER_IS_TRACED)))
1528 ip4_reassembly_handoff_trace_t *t =
1529 vlib_add_trace (vm, node, b[0], sizeof (*t));
1530 t->next_worker_index = ti[0];
1538 vlib_buffer_enqueue_to_thread (vm, fq_index, from, thread_indices,
1539 frame->n_vectors, 1);
1541 if (n_enq < frame->n_vectors)
1542 vlib_node_increment_counter (vm, node->node_index,
1543 IP4_REASSEMBLY_HANDOFF_ERROR_CONGESTION_DROP,
1544 frame->n_vectors - n_enq);
1545 return frame->n_vectors;
1548 VLIB_NODE_FN (ip4_reassembly_handoff_node) (vlib_main_t * vm,
1549 vlib_node_runtime_t * node,
1550 vlib_frame_t * frame)
1552 return ip4_reassembly_handoff_node_inline (vm, node, frame,
1553 false /* is_feature */ );
1558 VLIB_REGISTER_NODE (ip4_reassembly_handoff_node) = {
1559 .name = "ip4-reassembly-handoff",
1560 .vector_size = sizeof (u32),
1561 .n_errors = ARRAY_LEN(ip4_reassembly_handoff_error_strings),
1562 .error_strings = ip4_reassembly_handoff_error_strings,
1563 .format_trace = format_ip4_reassembly_handoff_trace,
1575 VLIB_NODE_FN (ip4_reassembly_feature_handoff_node) (vlib_main_t * vm,
1576 vlib_node_runtime_t *
1578 vlib_frame_t * frame)
1580 return ip4_reassembly_handoff_node_inline (vm, node, frame,
1581 true /* is_feature */ );
1587 VLIB_REGISTER_NODE (ip4_reassembly_feature_handoff_node) = {
1588 .name = "ip4-reass-feature-hoff",
1589 .vector_size = sizeof (u32),
1590 .n_errors = ARRAY_LEN(ip4_reassembly_handoff_error_strings),
1591 .error_strings = ip4_reassembly_handoff_error_strings,
1592 .format_trace = format_ip4_reassembly_handoff_trace,
1603 * fd.io coding-style-patch-verification: ON
1606 * eval: (c-set-style "gnu")