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,
82 ip4_reass_buffer_get_data_offset (vlib_buffer_t * b)
84 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
85 return vnb->ip.reass.range_first - vnb->ip.reass.fragment_first;
89 ip4_reass_buffer_get_data_len (vlib_buffer_t * b)
91 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
92 return clib_min (vnb->ip.reass.range_last, vnb->ip.reass.fragment_last) -
93 (vnb->ip.reass.fragment_first + ip4_reass_buffer_get_data_offset (b)) + 1;
100 // time when last packet was received
102 // internal id of this reassembly
104 // buffer index of first buffer in this reassembly context
106 // last octet of packet, ~0 until fragment without more_fragments arrives
107 u32 last_packet_octet;
108 // length of data collected so far
110 // trace operation counter
111 u32 trace_op_counter;
112 // next index - used by non-feature node
114 // minimum fragment length for this reassembly - used to estimate MTU
115 u16 min_fragment_length;
123 clib_spinlock_t lock;
124 } ip4_reass_per_thread_t;
131 u32 expire_walk_interval_ms;
135 clib_bihash_16_8_t hash;
137 ip4_reass_per_thread_t *per_thread_data;
140 vlib_main_t *vlib_main;
141 vnet_main_t *vnet_main;
143 // node index of ip4-drop node
145 u32 ip4_reass_expire_node_idx;
148 ip4_reass_main_t ip4_reass_main;
152 IP4_REASSEMBLY_NEXT_INPUT,
153 IP4_REASSEMBLY_NEXT_DROP,
154 IP4_REASSEMBLY_N_NEXT,
164 } ip4_reass_trace_operation_e;
174 } ip4_reass_range_trace_t;
178 ip4_reass_trace_operation_e action;
180 ip4_reass_range_trace_t trace_range;
189 ip4_reass_trace_details (vlib_main_t * vm, u32 bi,
190 ip4_reass_range_trace_t * trace)
192 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
193 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
194 trace->range_first = vnb->ip.reass.range_first;
195 trace->range_last = vnb->ip.reass.range_last;
196 trace->data_offset = ip4_reass_buffer_get_data_offset (b);
197 trace->data_len = ip4_reass_buffer_get_data_len (b);
198 trace->range_bi = bi;
202 format_ip4_reass_range_trace (u8 * s, va_list * args)
204 ip4_reass_range_trace_t *trace = va_arg (*args, ip4_reass_range_trace_t *);
205 s = format (s, "range: [%u, %u], off %d, len %u, bi %u", trace->range_first,
206 trace->range_last, trace->data_offset, trace->data_len,
212 format_ip4_reass_trace (u8 * s, va_list * args)
214 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
215 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
216 ip4_reass_trace_t *t = va_arg (*args, ip4_reass_trace_t *);
217 s = format (s, "reass id: %u, op id: %u ", t->reass_id, t->op_id);
218 u32 indent = format_get_indent (s);
219 s = format (s, "first bi: %u, data len: %u, ip/fragment[%u, %u]",
220 t->trace_range.first_bi, t->total_data_len, t->fragment_first,
225 s = format (s, "\n%Ushrink %U by %u", format_white_space, indent,
226 format_ip4_reass_range_trace, &t->trace_range,
230 s = format (s, "\n%Udiscard %U", format_white_space, indent,
231 format_ip4_reass_range_trace, &t->trace_range);
234 s = format (s, "\n%Unew %U", format_white_space, indent,
235 format_ip4_reass_range_trace, &t->trace_range);
238 s = format (s, "\n%Uoverlapping/ignored %U", format_white_space, indent,
239 format_ip4_reass_range_trace, &t->trace_range);
242 s = format (s, "\n%Ufinalize reassembly", format_white_space, indent);
249 ip4_reass_add_trace (vlib_main_t * vm, vlib_node_runtime_t * node,
250 ip4_reass_main_t * rm, ip4_reass_t * reass, u32 bi,
251 ip4_reass_trace_operation_e action, u32 size_diff)
253 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
254 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
255 if (pool_is_free_index (vm->trace_main.trace_buffer_pool, b->trace_index))
257 // this buffer's trace is gone
258 b->flags &= ~VLIB_BUFFER_IS_TRACED;
261 ip4_reass_trace_t *t = vlib_add_trace (vm, node, b, sizeof (t[0]));
262 t->reass_id = reass->id;
264 ip4_reass_trace_details (vm, bi, &t->trace_range);
265 t->size_diff = size_diff;
266 t->op_id = reass->trace_op_counter;
267 ++reass->trace_op_counter;
268 t->fragment_first = vnb->ip.reass.fragment_first;
269 t->fragment_last = vnb->ip.reass.fragment_last;
270 t->trace_range.first_bi = reass->first_bi;
271 t->total_data_len = reass->data_len;
274 s = format (s, "%U", format_ip4_reass_trace, NULL, NULL, t);
275 printf ("%.*s\n", vec_len (s), s);
277 vec_reset_length (s);
282 ip4_reass_free (ip4_reass_main_t * rm, ip4_reass_per_thread_t * rt,
285 clib_bihash_kv_16_8_t kv;
286 kv.key[0] = reass->key.as_u64[0];
287 kv.key[1] = reass->key.as_u64[1];
288 clib_bihash_add_del_16_8 (&rm->hash, &kv, 0);
289 pool_put (rt->pool, reass);
294 ip4_reass_on_timeout (vlib_main_t * vm, ip4_reass_main_t * rm,
297 u32 range_bi = reass->first_bi;
298 vlib_buffer_t *range_b;
299 vnet_buffer_opaque_t *range_vnb;
301 while (~0 != range_bi)
303 range_b = vlib_get_buffer (vm, range_bi);
304 range_vnb = vnet_buffer (range_b);
308 vec_add1 (to_free, bi);
309 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
310 if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
313 b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
320 range_bi = range_vnb->ip.reass.next_range_bi;
322 vlib_buffer_free (vm, to_free, vec_len (to_free));
327 ip4_reass_find_or_create (vlib_main_t * vm, ip4_reass_main_t * rm,
328 ip4_reass_per_thread_t * rt, ip4_reass_key_t * k)
330 ip4_reass_t *reass = NULL;
331 f64 now = vlib_time_now (rm->vlib_main);
332 clib_bihash_kv_16_8_t kv, value;
333 kv.key[0] = k->as_u64[0];
334 kv.key[1] = k->as_u64[1];
336 if (!clib_bihash_search_16_8 (&rm->hash, &kv, &value))
338 reass = pool_elt_at_index (rt->pool, value.value);
339 if (now > reass->last_heard + rm->timeout)
341 ip4_reass_on_timeout (vm, rm, reass);
342 ip4_reass_free (rm, rt, reass);
349 reass->last_heard = now;
353 if (rt->reass_n >= rm->max_reass_n)
360 pool_get (rt->pool, reass);
361 clib_memset (reass, 0, sizeof (*reass));
363 ((u64) os_get_thread_index () * 1000000000) + rt->id_counter;
365 reass->first_bi = ~0;
366 reass->last_packet_octet = ~0;
371 reass->key.as_u64[0] = kv.key[0] = k->as_u64[0];
372 reass->key.as_u64[1] = kv.key[1] = k->as_u64[1];
373 kv.value = reass - rt->pool;
374 reass->last_heard = now;
376 if (clib_bihash_add_del_16_8 (&rm->hash, &kv, 1))
378 ip4_reass_free (rm, rt, reass);
385 always_inline ip4_reass_rc_t
386 ip4_reass_finalize (vlib_main_t * vm, vlib_node_runtime_t * node,
387 ip4_reass_main_t * rm, ip4_reass_per_thread_t * rt,
388 ip4_reass_t * reass, u32 * bi0, u32 * next0, u32 * error0,
391 vlib_buffer_t *first_b = vlib_get_buffer (vm, reass->first_bi);
392 vlib_buffer_t *last_b = NULL;
393 u32 sub_chain_bi = reass->first_bi;
394 u32 total_length = 0;
398 u32 tmp_bi = sub_chain_bi;
399 vlib_buffer_t *tmp = vlib_get_buffer (vm, tmp_bi);
400 ip4_header_t *ip = vlib_buffer_get_current (tmp);
401 vnet_buffer_opaque_t *vnb = vnet_buffer (tmp);
402 if (!(vnb->ip.reass.range_first >= vnb->ip.reass.fragment_first) &&
403 !(vnb->ip.reass.range_last > vnb->ip.reass.fragment_first))
405 return IP4_REASS_RC_INTERNAL_ERROR;
408 u32 data_len = ip4_reass_buffer_get_data_len (tmp);
410 ip4_header_bytes (ip) + ip4_reass_buffer_get_data_offset (tmp);
412 vlib_buffer_length_in_chain (vm, tmp) - trim_front - data_len;
413 if (tmp_bi == reass->first_bi)
415 /* first buffer - keep ip4 header */
416 if (0 != ip4_reass_buffer_get_data_offset (tmp))
418 return IP4_REASS_RC_INTERNAL_ERROR;
421 trim_end = vlib_buffer_length_in_chain (vm, tmp) - data_len -
422 ip4_header_bytes (ip);
423 if (!(vlib_buffer_length_in_chain (vm, tmp) - trim_end > 0))
425 return IP4_REASS_RC_INTERNAL_ERROR;
429 vlib_buffer_length_in_chain (vm, tmp) - trim_front - trim_end;
435 if (trim_front > tmp->current_length)
437 /* drop whole buffer */
438 vlib_buffer_free_one (vm, tmp_bi);
439 trim_front -= tmp->current_length;
440 if (!(tmp->flags & VLIB_BUFFER_NEXT_PRESENT))
442 return IP4_REASS_RC_INTERNAL_ERROR;
444 tmp->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
445 tmp_bi = tmp->next_buffer;
446 tmp = vlib_get_buffer (vm, tmp_bi);
451 vlib_buffer_advance (tmp, trim_front);
459 last_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
460 last_b->next_buffer = tmp_bi;
463 if (keep_data <= tmp->current_length)
465 tmp->current_length = keep_data;
470 keep_data -= tmp->current_length;
471 if (!(tmp->flags & VLIB_BUFFER_NEXT_PRESENT))
473 return IP4_REASS_RC_INTERNAL_ERROR;
476 total_length += tmp->current_length;
480 vlib_buffer_free_one (vm, tmp_bi);
481 if (reass->first_bi == tmp_bi)
483 return IP4_REASS_RC_INTERNAL_ERROR;
486 if (tmp->flags & VLIB_BUFFER_NEXT_PRESENT)
488 tmp_bi = tmp->next_buffer;
489 tmp = vlib_get_buffer (vm, tmp->next_buffer);
497 vnet_buffer (vlib_get_buffer (vm, sub_chain_bi))->ip.
500 while (~0 != sub_chain_bi);
504 return IP4_REASS_RC_INTERNAL_ERROR;
506 last_b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
507 if (total_length < first_b->current_length)
509 return IP4_REASS_RC_INTERNAL_ERROR;
511 total_length -= first_b->current_length;
512 first_b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
513 first_b->total_length_not_including_first_buffer = total_length;
514 ip4_header_t *ip = vlib_buffer_get_current (first_b);
515 ip->flags_and_fragment_offset = 0;
516 ip->length = clib_host_to_net_u16 (first_b->current_length + total_length);
517 ip->checksum = ip4_header_checksum (ip);
518 if (!vlib_buffer_chain_linearize (vm, first_b))
520 return IP4_REASS_RC_NO_BUF;
523 if (PREDICT_FALSE (first_b->flags & VLIB_BUFFER_IS_TRACED))
525 ip4_reass_add_trace (vm, node, rm, reass, reass->first_bi, FINALIZE, 0);
527 // following code does a hexdump of packet fragments to stdout ...
530 u32 bi = reass->first_bi;
534 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
535 s = format (s, "%u: %U\n", bi, format_hexdump,
536 vlib_buffer_get_current (b), b->current_length);
537 if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
546 printf ("%.*s\n", vec_len (s), s);
553 *bi0 = reass->first_bi;
556 *next0 = IP4_REASSEMBLY_NEXT_INPUT;
560 *next0 = reass->next_index;
562 vnet_buffer (first_b)->ip.reass.estimated_mtu = reass->min_fragment_length;
563 *error0 = IP4_ERROR_NONE;
564 ip4_reass_free (rm, rt, reass);
566 return IP4_REASS_RC_OK;
569 always_inline ip4_reass_rc_t
570 ip4_reass_insert_range_in_chain (vlib_main_t * vm,
571 ip4_reass_main_t * rm,
572 ip4_reass_per_thread_t * rt,
574 u32 prev_range_bi, u32 new_next_bi)
576 vlib_buffer_t *new_next_b = vlib_get_buffer (vm, new_next_bi);
577 vnet_buffer_opaque_t *new_next_vnb = vnet_buffer (new_next_b);
578 if (~0 != prev_range_bi)
580 vlib_buffer_t *prev_b = vlib_get_buffer (vm, prev_range_bi);
581 vnet_buffer_opaque_t *prev_vnb = vnet_buffer (prev_b);
582 new_next_vnb->ip.reass.next_range_bi = prev_vnb->ip.reass.next_range_bi;
583 prev_vnb->ip.reass.next_range_bi = new_next_bi;
587 if (~0 != reass->first_bi)
589 new_next_vnb->ip.reass.next_range_bi = reass->first_bi;
591 reass->first_bi = new_next_bi;
593 vnet_buffer_opaque_t *vnb = vnet_buffer (new_next_b);
594 if (!(vnb->ip.reass.range_first >= vnb->ip.reass.fragment_first) &&
595 !(vnb->ip.reass.range_last > vnb->ip.reass.fragment_first))
597 return IP4_REASS_RC_INTERNAL_ERROR;
599 reass->data_len += ip4_reass_buffer_get_data_len (new_next_b);
600 return IP4_REASS_RC_OK;
603 always_inline ip4_reass_rc_t
604 ip4_reass_remove_range_from_chain (vlib_main_t * vm,
605 vlib_node_runtime_t * node,
606 ip4_reass_main_t * rm,
607 ip4_reass_t * reass, u32 prev_range_bi,
610 vlib_buffer_t *discard_b = vlib_get_buffer (vm, discard_bi);
611 vnet_buffer_opaque_t *discard_vnb = vnet_buffer (discard_b);
612 if (~0 != prev_range_bi)
614 vlib_buffer_t *prev_b = vlib_get_buffer (vm, prev_range_bi);
615 vnet_buffer_opaque_t *prev_vnb = vnet_buffer (prev_b);
616 if (!(prev_vnb->ip.reass.next_range_bi == discard_bi))
618 return IP4_REASS_RC_INTERNAL_ERROR;
620 prev_vnb->ip.reass.next_range_bi = discard_vnb->ip.reass.next_range_bi;
624 reass->first_bi = discard_vnb->ip.reass.next_range_bi;
626 vnet_buffer_opaque_t *vnb = vnet_buffer (discard_b);
627 if (!(vnb->ip.reass.range_first >= vnb->ip.reass.fragment_first) &&
628 !(vnb->ip.reass.range_last > vnb->ip.reass.fragment_first))
630 return IP4_REASS_RC_INTERNAL_ERROR;
632 reass->data_len -= ip4_reass_buffer_get_data_len (discard_b);
635 vlib_buffer_free_one (vm, discard_bi);
636 if (PREDICT_FALSE (discard_b->flags & VLIB_BUFFER_IS_TRACED))
638 ip4_reass_add_trace (vm, node, rm, reass, discard_bi, RANGE_DISCARD,
641 if (discard_b->flags & VLIB_BUFFER_NEXT_PRESENT)
643 discard_b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
644 discard_bi = discard_b->next_buffer;
645 discard_b = vlib_get_buffer (vm, discard_bi);
652 return IP4_REASS_RC_OK;
655 always_inline ip4_reass_rc_t
656 ip4_reass_update (vlib_main_t * vm, vlib_node_runtime_t * node,
657 ip4_reass_main_t * rm, ip4_reass_per_thread_t * rt,
658 ip4_reass_t * reass, u32 * bi0, u32 * next0, u32 * error0,
661 ip4_reass_rc_t rc = IP4_REASS_RC_OK;
663 vlib_buffer_t *fb = vlib_get_buffer (vm, *bi0);
664 ip4_header_t *fip = vlib_buffer_get_current (fb);
665 vnet_buffer_opaque_t *fvnb = vnet_buffer (fb);
666 reass->next_index = fvnb->ip.reass.next_index; // store next_index before it's overwritten
667 const u32 fragment_first = ip4_get_fragment_offset_bytes (fip);
668 const u32 fragment_length =
669 clib_net_to_host_u16 (fip->length) - ip4_header_bytes (fip);
670 const u32 fragment_last = fragment_first + fragment_length - 1;
671 fvnb->ip.reass.fragment_first = fragment_first;
672 fvnb->ip.reass.fragment_last = fragment_last;
673 int more_fragments = ip4_get_fragment_more (fip);
674 u32 candidate_range_bi = reass->first_bi;
675 u32 prev_range_bi = ~0;
676 fvnb->ip.reass.range_first = fragment_first;
677 fvnb->ip.reass.range_last = fragment_last;
678 fvnb->ip.reass.next_range_bi = ~0;
681 reass->last_packet_octet = fragment_last;
683 if (~0 == reass->first_bi)
685 // starting a new reassembly
687 ip4_reass_insert_range_in_chain (vm, rm, rt, reass, prev_range_bi,
689 if (IP4_REASS_RC_OK != rc)
693 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
695 ip4_reass_add_trace (vm, node, rm, reass, *bi0, RANGE_NEW, 0);
698 reass->min_fragment_length = clib_net_to_host_u16 (fip->length);
699 return IP4_REASS_RC_OK;
701 reass->min_fragment_length = clib_min (clib_net_to_host_u16 (fip->length),
702 fvnb->ip.reass.estimated_mtu);
703 while (~0 != candidate_range_bi)
705 vlib_buffer_t *candidate_b = vlib_get_buffer (vm, candidate_range_bi);
706 vnet_buffer_opaque_t *candidate_vnb = vnet_buffer (candidate_b);
707 if (fragment_first > candidate_vnb->ip.reass.range_last)
709 // this fragments starts after candidate range
710 prev_range_bi = candidate_range_bi;
711 candidate_range_bi = candidate_vnb->ip.reass.next_range_bi;
712 if (candidate_vnb->ip.reass.range_last < fragment_last &&
713 ~0 == candidate_range_bi)
715 // special case - this fragment falls beyond all known ranges
717 ip4_reass_insert_range_in_chain (vm, rm, rt, reass,
718 prev_range_bi, *bi0);
719 if (IP4_REASS_RC_OK != rc)
728 if (fragment_last < candidate_vnb->ip.reass.range_first)
730 // this fragment ends before candidate range without any overlap
732 ip4_reass_insert_range_in_chain (vm, rm, rt, reass, prev_range_bi,
734 if (IP4_REASS_RC_OK != rc)
742 if (fragment_first >= candidate_vnb->ip.reass.range_first &&
743 fragment_last <= candidate_vnb->ip.reass.range_last)
745 // this fragment is a (sub)part of existing range, ignore it
746 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
748 ip4_reass_add_trace (vm, node, rm, reass, *bi0,
753 int discard_candidate = 0;
754 if (fragment_first < candidate_vnb->ip.reass.range_first)
757 fragment_last - candidate_vnb->ip.reass.range_first + 1;
758 if (overlap < ip4_reass_buffer_get_data_len (candidate_b))
760 candidate_vnb->ip.reass.range_first += overlap;
761 if (reass->data_len < overlap)
763 return IP4_REASS_RC_INTERNAL_ERROR;
765 reass->data_len -= overlap;
766 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
768 ip4_reass_add_trace (vm, node, rm, reass,
769 candidate_range_bi, RANGE_SHRINK,
773 ip4_reass_insert_range_in_chain (vm, rm, rt, reass,
774 prev_range_bi, *bi0);
775 if (IP4_REASS_RC_OK != rc)
783 discard_candidate = 1;
786 else if (fragment_last > candidate_vnb->ip.reass.range_last)
789 candidate_vnb->ip.reass.range_last - fragment_first + 1;
790 if (overlap < ip4_reass_buffer_get_data_len (candidate_b))
792 fvnb->ip.reass.range_first += overlap;
793 if (~0 != candidate_vnb->ip.reass.next_range_bi)
795 prev_range_bi = candidate_range_bi;
797 candidate_vnb->ip.reass.next_range_bi;
802 // special case - last range discarded
804 ip4_reass_insert_range_in_chain (vm, rm, rt, reass,
807 if (IP4_REASS_RC_OK != rc)
816 discard_candidate = 1;
821 discard_candidate = 1;
823 if (discard_candidate)
825 u32 next_range_bi = candidate_vnb->ip.reass.next_range_bi;
826 // discard candidate range, probe next range
828 ip4_reass_remove_range_from_chain (vm, node, rm, reass,
831 if (IP4_REASS_RC_OK != rc)
835 if (~0 != next_range_bi)
837 candidate_range_bi = next_range_bi;
842 // special case - last range discarded
844 ip4_reass_insert_range_in_chain (vm, rm, rt, reass,
845 prev_range_bi, *bi0);
846 if (IP4_REASS_RC_OK != rc)
858 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
860 ip4_reass_add_trace (vm, node, rm, reass, *bi0, RANGE_NEW, 0);
863 if (~0 != reass->last_packet_octet &&
864 reass->data_len == reass->last_packet_octet + 1)
866 return ip4_reass_finalize (vm, node, rm, rt, reass, bi0, next0, error0,
877 *next0 = IP4_REASSEMBLY_NEXT_DROP;
878 *error0 = IP4_ERROR_REASS_DUPLICATE_FRAGMENT;
885 ip4_reassembly_inline (vlib_main_t * vm,
886 vlib_node_runtime_t * node,
887 vlib_frame_t * frame, bool is_feature)
889 u32 *from = vlib_frame_vector_args (frame);
890 u32 n_left_from, n_left_to_next, *to_next, next_index;
891 ip4_reass_main_t *rm = &ip4_reass_main;
892 ip4_reass_per_thread_t *rt = &rm->per_thread_data[os_get_thread_index ()];
893 clib_spinlock_lock (&rt->lock);
895 n_left_from = frame->n_vectors;
896 next_index = node->cached_next_index;
897 while (n_left_from > 0)
899 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
901 while (n_left_from > 0 && n_left_to_next > 0)
906 u32 error0 = IP4_ERROR_NONE;
909 b0 = vlib_get_buffer (vm, bi0);
911 ip4_header_t *ip0 = vlib_buffer_get_current (b0);
912 if (!ip4_get_fragment_more (ip0) && !ip4_get_fragment_offset (ip0))
914 // this is a whole packet - no fragmentation
917 next0 = IP4_REASSEMBLY_NEXT_INPUT;
921 next0 = vnet_buffer (b0)->ip.reass.next_index;
926 const u32 fragment_first = ip4_get_fragment_offset_bytes (ip0);
927 const u32 fragment_length =
928 clib_net_to_host_u16 (ip0->length) - ip4_header_bytes (ip0);
929 const u32 fragment_last = fragment_first + fragment_length - 1;
930 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
932 next0 = IP4_REASSEMBLY_NEXT_DROP;
933 error0 = IP4_ERROR_REASS_MALFORMED_PACKET;
939 (u64) vnet_buffer (b0)->sw_if_index[VLIB_RX] |
940 (u64) ip0->src_address.as_u32 << 32;
942 (u64) ip0->dst_address.as_u32 |
943 (u64) ip0->fragment_id << 32 | (u64) ip0->protocol << 48;
946 ip4_reass_find_or_create (vm, rm, rt, &k);
950 switch (ip4_reass_update
951 (vm, node, rm, rt, reass, &bi0, &next0, &error0,
954 case IP4_REASS_RC_OK:
955 /* nothing to do here */
957 case IP4_REASS_RC_NO_BUF:
959 case IP4_REASS_RC_INTERNAL_ERROR:
960 /* drop everything and start with a clean slate */
961 ip4_reass_on_timeout (vm, rm, reass);
962 ip4_reass_free (rm, rt, reass);
969 next0 = IP4_REASSEMBLY_NEXT_DROP;
970 error0 = IP4_ERROR_REASS_LIMIT_REACHED;
974 b0->error = node->errors[error0];
982 if (is_feature && IP4_ERROR_NONE == error0)
984 b0 = vlib_get_buffer (vm, bi0);
985 vnet_feature_next (&next0, b0);
987 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
988 n_left_to_next, bi0, next0);
989 IP4_REASS_DEBUG_BUFFER (bi0, enqueue_next);
997 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1000 clib_spinlock_unlock (&rt->lock);
1001 return frame->n_vectors;
1004 static char *ip4_reassembly_error_strings[] = {
1005 #define _(sym, string) string,
1011 ip4_reassembly (vlib_main_t * vm, vlib_node_runtime_t * node,
1012 vlib_frame_t * frame)
1014 return ip4_reassembly_inline (vm, node, frame, false /* is_feature */ );
1018 VLIB_REGISTER_NODE (ip4_reass_node, static) = {
1019 .function = ip4_reassembly,
1020 .name = "ip4-reassembly",
1021 .vector_size = sizeof (u32),
1022 .format_trace = format_ip4_reass_trace,
1023 .n_errors = ARRAY_LEN (ip4_reassembly_error_strings),
1024 .error_strings = ip4_reassembly_error_strings,
1025 .n_next_nodes = IP4_REASSEMBLY_N_NEXT,
1028 [IP4_REASSEMBLY_NEXT_INPUT] = "ip4-input",
1029 [IP4_REASSEMBLY_NEXT_DROP] = "ip4-drop",
1034 VLIB_NODE_FUNCTION_MULTIARCH (ip4_reass_node, ip4_reassembly);
1037 ip4_reassembly_feature (vlib_main_t * vm,
1038 vlib_node_runtime_t * node, vlib_frame_t * frame)
1040 return ip4_reassembly_inline (vm, node, frame, true /* is_feature */ );
1044 VLIB_REGISTER_NODE (ip4_reass_node_feature, static) = {
1045 .function = ip4_reassembly_feature,
1046 .name = "ip4-reassembly-feature",
1047 .vector_size = sizeof (u32),
1048 .format_trace = format_ip4_reass_trace,
1049 .n_errors = ARRAY_LEN (ip4_reassembly_error_strings),
1050 .error_strings = ip4_reassembly_error_strings,
1051 .n_next_nodes = IP4_REASSEMBLY_N_NEXT,
1054 [IP4_REASSEMBLY_NEXT_INPUT] = "ip4-input",
1055 [IP4_REASSEMBLY_NEXT_DROP] = "ip4-drop",
1060 VLIB_NODE_FUNCTION_MULTIARCH (ip4_reass_node_feature, ip4_reassembly_feature);
1063 VNET_FEATURE_INIT (ip4_reassembly_feature, static) = {
1064 .arc_name = "ip4-unicast",
1065 .node_name = "ip4-reassembly-feature",
1066 .runs_before = VNET_FEATURES ("ip4-lookup"),
1072 ip4_reass_get_nbuckets ()
1074 ip4_reass_main_t *rm = &ip4_reass_main;
1078 nbuckets = (u32) (rm->max_reass_n / IP4_REASS_HT_LOAD_FACTOR);
1080 for (i = 0; i < 31; i++)
1081 if ((1 << i) >= nbuckets)
1090 IP4_EVENT_CONFIG_CHANGED = 1,
1091 } ip4_reass_event_t;
1096 clib_bihash_16_8_t *new_hash;
1097 } ip4_rehash_cb_ctx;
1100 ip4_rehash_cb (clib_bihash_kv_16_8_t * kv, void *_ctx)
1102 ip4_rehash_cb_ctx *ctx = _ctx;
1103 if (clib_bihash_add_del_16_8 (ctx->new_hash, kv, 1))
1110 ip4_reass_set_params (u32 timeout_ms, u32 max_reassemblies,
1111 u32 expire_walk_interval_ms)
1113 ip4_reass_main.timeout_ms = timeout_ms;
1114 ip4_reass_main.timeout = (f64) timeout_ms / (f64) MSEC_PER_SEC;
1115 ip4_reass_main.max_reass_n = max_reassemblies;
1116 ip4_reass_main.expire_walk_interval_ms = expire_walk_interval_ms;
1120 ip4_reass_set (u32 timeout_ms, u32 max_reassemblies,
1121 u32 expire_walk_interval_ms)
1123 u32 old_nbuckets = ip4_reass_get_nbuckets ();
1124 ip4_reass_set_params (timeout_ms, max_reassemblies,
1125 expire_walk_interval_ms);
1126 vlib_process_signal_event (ip4_reass_main.vlib_main,
1127 ip4_reass_main.ip4_reass_expire_node_idx,
1128 IP4_EVENT_CONFIG_CHANGED, 0);
1129 u32 new_nbuckets = ip4_reass_get_nbuckets ();
1130 if (ip4_reass_main.max_reass_n > 0 && new_nbuckets > old_nbuckets)
1132 clib_bihash_16_8_t new_hash;
1133 clib_memset (&new_hash, 0, sizeof (new_hash));
1134 ip4_rehash_cb_ctx ctx;
1136 ctx.new_hash = &new_hash;
1137 clib_bihash_init_16_8 (&new_hash, "ip4-reass", new_nbuckets,
1138 new_nbuckets * 1024);
1139 clib_bihash_foreach_key_value_pair_16_8 (&ip4_reass_main.hash,
1140 ip4_rehash_cb, &ctx);
1143 clib_bihash_free_16_8 (&new_hash);
1148 clib_bihash_free_16_8 (&ip4_reass_main.hash);
1149 clib_memcpy_fast (&ip4_reass_main.hash, &new_hash,
1150 sizeof (ip4_reass_main.hash));
1157 ip4_reass_get (u32 * timeout_ms, u32 * max_reassemblies,
1158 u32 * expire_walk_interval_ms)
1160 *timeout_ms = ip4_reass_main.timeout_ms;
1161 *max_reassemblies = ip4_reass_main.max_reass_n;
1162 *expire_walk_interval_ms = ip4_reass_main.expire_walk_interval_ms;
1166 static clib_error_t *
1167 ip4_reass_init_function (vlib_main_t * vm)
1169 ip4_reass_main_t *rm = &ip4_reass_main;
1170 clib_error_t *error = 0;
1175 rm->vnet_main = vnet_get_main ();
1177 vec_validate (rm->per_thread_data, vlib_num_workers ());
1178 ip4_reass_per_thread_t *rt;
1179 vec_foreach (rt, rm->per_thread_data)
1181 clib_spinlock_init (&rt->lock);
1182 pool_alloc (rt->pool, rm->max_reass_n);
1185 node = vlib_get_node_by_name (vm, (u8 *) "ip4-reassembly-expire-walk");
1187 rm->ip4_reass_expire_node_idx = node->index;
1189 ip4_reass_set_params (IP4_REASS_TIMEOUT_DEFAULT_MS,
1190 IP4_REASS_MAX_REASSEMBLIES_DEFAULT,
1191 IP4_REASS_EXPIRE_WALK_INTERVAL_DEFAULT_MS);
1193 nbuckets = ip4_reass_get_nbuckets ();
1194 clib_bihash_init_16_8 (&rm->hash, "ip4-reass", nbuckets, nbuckets * 1024);
1196 node = vlib_get_node_by_name (vm, (u8 *) "ip4-drop");
1198 rm->ip4_drop_idx = node->index;
1203 VLIB_INIT_FUNCTION (ip4_reass_init_function);
1206 ip4_reass_walk_expired (vlib_main_t * vm,
1207 vlib_node_runtime_t * node, vlib_frame_t * f)
1209 ip4_reass_main_t *rm = &ip4_reass_main;
1210 uword event_type, *event_data = 0;
1214 vlib_process_wait_for_event_or_clock (vm,
1215 (f64) rm->expire_walk_interval_ms
1216 / (f64) MSEC_PER_SEC);
1217 event_type = vlib_process_get_events (vm, &event_data);
1221 case ~0: /* no events => timeout */
1222 /* nothing to do here */
1224 case IP4_EVENT_CONFIG_CHANGED:
1227 clib_warning ("BUG: event type 0x%wx", event_type);
1230 f64 now = vlib_time_now (vm);
1233 int *pool_indexes_to_free = NULL;
1235 uword thread_index = 0;
1237 const uword nthreads = vlib_num_workers () + 1;
1238 for (thread_index = 0; thread_index < nthreads; ++thread_index)
1240 ip4_reass_per_thread_t *rt = &rm->per_thread_data[thread_index];
1241 clib_spinlock_lock (&rt->lock);
1243 vec_reset_length (pool_indexes_to_free);
1245 pool_foreach_index (index, rt->pool, ({
1246 reass = pool_elt_at_index (rt->pool, index);
1247 if (now > reass->last_heard + rm->timeout)
1249 vec_add1 (pool_indexes_to_free, index);
1255 vec_foreach (i, pool_indexes_to_free)
1257 ip4_reass_t *reass = pool_elt_at_index (rt->pool, i[0]);
1258 ip4_reass_on_timeout (vm, rm, reass);
1259 ip4_reass_free (rm, rt, reass);
1263 clib_spinlock_unlock (&rt->lock);
1266 vec_free (pool_indexes_to_free);
1269 _vec_len (event_data) = 0;
1277 VLIB_REGISTER_NODE (ip4_reass_expire_node, static) = {
1278 .function = ip4_reass_walk_expired,
1279 .type = VLIB_NODE_TYPE_PROCESS,
1280 .name = "ip4-reassembly-expire-walk",
1281 .format_trace = format_ip4_reass_trace,
1282 .n_errors = ARRAY_LEN (ip4_reassembly_error_strings),
1283 .error_strings = ip4_reassembly_error_strings,
1289 format_ip4_reass_key (u8 * s, va_list * args)
1291 ip4_reass_key_t *key = va_arg (*args, ip4_reass_key_t *);
1292 s = format (s, "xx_id: %u, src: %U, dst: %U, frag_id: %u, proto: %u",
1293 key->xx_id, format_ip4_address, &key->src, format_ip4_address,
1294 &key->dst, clib_net_to_host_u16 (key->frag_id), key->proto);
1299 format_ip4_reass (u8 * s, va_list * args)
1301 vlib_main_t *vm = va_arg (*args, vlib_main_t *);
1302 ip4_reass_t *reass = va_arg (*args, ip4_reass_t *);
1304 s = format (s, "ID: %lu, key: %U\n first_bi: %u, data_len: %u, "
1305 "last_packet_octet: %u, trace_op_counter: %u\n",
1306 reass->id, format_ip4_reass_key, &reass->key, reass->first_bi,
1307 reass->data_len, reass->last_packet_octet,
1308 reass->trace_op_counter);
1309 u32 bi = reass->first_bi;
1313 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
1314 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
1315 s = format (s, " #%03u: range: [%u, %u], bi: %u, off: %d, len: %u, "
1316 "fragment[%u, %u]\n",
1317 counter, vnb->ip.reass.range_first,
1318 vnb->ip.reass.range_last, bi,
1319 ip4_reass_buffer_get_data_offset (b),
1320 ip4_reass_buffer_get_data_len (b),
1321 vnb->ip.reass.fragment_first, vnb->ip.reass.fragment_last);
1322 if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
1324 bi = b->next_buffer;
1334 static clib_error_t *
1335 show_ip4_reass (vlib_main_t * vm, unformat_input_t * input,
1336 CLIB_UNUSED (vlib_cli_command_t * lmd))
1338 ip4_reass_main_t *rm = &ip4_reass_main;
1340 vlib_cli_output (vm, "---------------------");
1341 vlib_cli_output (vm, "IP4 reassembly status");
1342 vlib_cli_output (vm, "---------------------");
1343 bool details = false;
1344 if (unformat (input, "details"))
1349 u32 sum_reass_n = 0;
1352 const uword nthreads = vlib_num_workers () + 1;
1353 for (thread_index = 0; thread_index < nthreads; ++thread_index)
1355 ip4_reass_per_thread_t *rt = &rm->per_thread_data[thread_index];
1356 clib_spinlock_lock (&rt->lock);
1360 pool_foreach (reass, rt->pool, {
1361 vlib_cli_output (vm, "%U", format_ip4_reass, vm, reass);
1365 sum_reass_n += rt->reass_n;
1366 clib_spinlock_unlock (&rt->lock);
1368 vlib_cli_output (vm, "---------------------");
1369 vlib_cli_output (vm, "Current IP4 reassemblies count: %lu\n",
1370 (long unsigned) sum_reass_n);
1371 vlib_cli_output (vm,
1372 "Maximum configured concurrent IP4 reassemblies per worker-thread: %lu\n",
1373 (long unsigned) rm->max_reass_n);
1378 VLIB_CLI_COMMAND (show_ip4_reassembly_cmd, static) = {
1379 .path = "show ip4-reassembly",
1380 .short_help = "show ip4-reassembly [details]",
1381 .function = show_ip4_reass,
1386 ip4_reass_enable_disable (u32 sw_if_index, u8 enable_disable)
1388 return vnet_feature_enable_disable ("ip4-unicast", "ip4-reassembly-feature",
1389 sw_if_index, enable_disable, 0, 0);
1393 * fd.io coding-style-patch-verification: ON
1396 * eval: (c-set-style "gnu")