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_24_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(...)
57 static vlib_node_registration_t ip4_reass_node;
65 // align by making this 4 octets even though its a 2 octets field
69 // align by making this 4 octets even though its a 2 octets field
71 // align by making this 4 octets even though its a 1 octet field
80 ip4_reass_buffer_get_data_offset_no_check (vlib_buffer_t * b)
82 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
83 return vnb->ip.reass.range_first - vnb->ip.reass.fragment_first;
87 ip4_reass_buffer_get_data_offset (vlib_buffer_t * b)
89 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
90 ASSERT (vnb->ip.reass.range_first >= vnb->ip.reass.fragment_first);
91 return ip4_reass_buffer_get_data_offset_no_check (b);
95 ip4_reass_buffer_get_data_len_no_check (vlib_buffer_t * b)
97 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
98 return clib_min (vnb->ip.reass.range_last, vnb->ip.reass.fragment_last) -
99 (vnb->ip.reass.fragment_first + ip4_reass_buffer_get_data_offset (b)) + 1;
103 ip4_reass_buffer_get_data_len (vlib_buffer_t * b)
105 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
106 ASSERT (vnb->ip.reass.range_last > vnb->ip.reass.fragment_first);
107 return ip4_reass_buffer_get_data_len_no_check (b);
114 // time when last packet was received
116 // internal id of this reassembly
118 // buffer index of first buffer in this reassembly context
120 // last octet of packet, ~0 until fragment without more_fragments arrives
121 u32 last_packet_octet;
122 // length of data collected so far
124 // trace operation counter
125 u32 trace_op_counter;
126 // next index - used by non-feature node
128 // minimum fragment length for this reassembly - used to estimate MTU
129 u16 min_fragment_length;
138 clib_spinlock_t lock;
139 } ip4_reass_per_thread_t;
146 u32 expire_walk_interval_ms;
150 clib_bihash_24_8_t hash;
152 ip4_reass_per_thread_t *per_thread_data;
155 vlib_main_t *vlib_main;
156 vnet_main_t *vnet_main;
158 // node index of ip4-drop node
160 u32 ip4_reass_expire_node_idx;
163 ip4_reass_main_t ip4_reass_main;
167 IP4_REASSEMBLY_NEXT_INPUT,
168 IP4_REASSEMBLY_NEXT_DROP,
169 IP4_REASSEMBLY_N_NEXT,
179 } ip4_reass_trace_operation_e;
189 } ip4_reass_range_trace_t;
193 ip4_reass_trace_operation_e action;
195 ip4_reass_range_trace_t trace_range;
204 ip4_reass_trace_details (vlib_main_t * vm, u32 bi,
205 ip4_reass_range_trace_t * trace)
207 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
208 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
209 trace->range_first = vnb->ip.reass.range_first;
210 trace->range_last = vnb->ip.reass.range_last;
211 trace->data_offset = ip4_reass_buffer_get_data_offset_no_check (b);
212 trace->data_len = ip4_reass_buffer_get_data_len_no_check (b);
213 trace->range_bi = bi;
217 format_ip4_reass_range_trace (u8 * s, va_list * args)
219 ip4_reass_range_trace_t *trace = va_arg (*args, ip4_reass_range_trace_t *);
220 s = format (s, "range: [%u, %u], off %d, len %u, bi %u", trace->range_first,
221 trace->range_last, trace->data_offset, trace->data_len,
227 format_ip4_reass_trace (u8 * s, va_list * args)
229 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
230 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
231 ip4_reass_trace_t *t = va_arg (*args, ip4_reass_trace_t *);
232 s = format (s, "reass id: %u, op id: %u ", t->reass_id, t->op_id);
233 u32 indent = format_get_indent (s);
234 s = format (s, "first bi: %u, data len: %u, ip/fragment[%u, %u]",
235 t->trace_range.first_bi, t->total_data_len, t->fragment_first,
240 s = format (s, "\n%Ushrink %U by %u", format_white_space, indent,
241 format_ip4_reass_range_trace, &t->trace_range,
245 s = format (s, "\n%Udiscard %U", format_white_space, indent,
246 format_ip4_reass_range_trace, &t->trace_range);
249 s = format (s, "\n%Unew %U", format_white_space, indent,
250 format_ip4_reass_range_trace, &t->trace_range);
253 s = format (s, "\n%Uoverlapping/ignored %U", format_white_space, indent,
254 format_ip4_reass_range_trace, &t->trace_range);
257 s = format (s, "\n%Ufinalize reassembly", format_white_space, indent);
264 ip4_reass_add_trace (vlib_main_t * vm, vlib_node_runtime_t * node,
265 ip4_reass_main_t * rm, ip4_reass_t * reass, u32 bi,
266 ip4_reass_trace_operation_e action, u32 size_diff)
268 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
269 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
270 if (pool_is_free_index (vm->trace_main.trace_buffer_pool, b->trace_index))
272 // this buffer's trace is gone
273 b->flags &= ~VLIB_BUFFER_IS_TRACED;
276 ip4_reass_trace_t *t = vlib_add_trace (vm, node, b, sizeof (t[0]));
277 t->reass_id = reass->id;
279 ip4_reass_trace_details (vm, bi, &t->trace_range);
280 t->size_diff = size_diff;
281 t->op_id = reass->trace_op_counter;
282 ++reass->trace_op_counter;
283 t->fragment_first = vnb->ip.reass.fragment_first;
284 t->fragment_last = vnb->ip.reass.fragment_last;
285 t->trace_range.first_bi = reass->first_bi;
286 t->total_data_len = reass->data_len;
289 s = format (s, "%U", format_ip4_reass_trace, NULL, NULL, t);
290 printf ("%.*s\n", vec_len (s), s);
292 vec_reset_length (s);
297 ip4_reass_free (ip4_reass_main_t * rm, ip4_reass_per_thread_t * rt,
300 clib_bihash_kv_24_8_t kv;
301 kv.key[0] = reass->key.as_u64[0];
302 kv.key[1] = reass->key.as_u64[1];
303 kv.key[2] = reass->key.as_u64[2];
304 clib_bihash_add_del_24_8 (&rm->hash, &kv, 0);
305 pool_put (rt->pool, reass);
310 ip4_reass_on_timeout (vlib_main_t * vm, ip4_reass_main_t * rm,
311 ip4_reass_t * reass, u32 ** vec_drop_timeout)
313 u32 range_bi = reass->first_bi;
314 vlib_buffer_t *range_b;
315 vnet_buffer_opaque_t *range_vnb;
316 while (~0 != range_bi)
318 range_b = vlib_get_buffer (vm, range_bi);
319 range_vnb = vnet_buffer (range_b);
323 vec_add1 (*vec_drop_timeout, bi);
324 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
325 if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
328 b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
335 range_bi = range_vnb->ip.reass.next_range_bi;
340 ip4_reass_find_or_create (vlib_main_t * vm, ip4_reass_main_t * rm,
341 ip4_reass_per_thread_t * rt,
342 ip4_reass_key_t * k, u32 ** vec_drop_timeout)
344 ip4_reass_t *reass = NULL;
345 f64 now = vlib_time_now (rm->vlib_main);
346 clib_bihash_kv_24_8_t kv, value;
347 kv.key[0] = k->as_u64[0];
348 kv.key[1] = k->as_u64[1];
349 kv.key[2] = k->as_u64[2];
351 if (!clib_bihash_search_24_8 (&rm->hash, &kv, &value))
353 reass = pool_elt_at_index (rt->pool, value.value);
354 if (now > reass->last_heard + rm->timeout)
356 ip4_reass_on_timeout (vm, rm, reass, vec_drop_timeout);
357 ip4_reass_free (rm, rt, reass);
364 reass->last_heard = now;
368 if (rt->reass_n >= rm->max_reass_n)
375 pool_get (rt->pool, reass);
376 memset (reass, 0, sizeof (*reass));
378 ((u64) os_get_thread_index () * 1000000000) + rt->id_counter;
380 reass->first_bi = ~0;
381 reass->last_packet_octet = ~0;
386 reass->key.as_u64[0] = kv.key[0] = k->as_u64[0];
387 reass->key.as_u64[1] = kv.key[1] = k->as_u64[1];
388 reass->key.as_u64[2] = kv.key[2] = k->as_u64[2];
389 kv.value = reass - rt->pool;
390 reass->last_heard = now;
392 if (clib_bihash_add_del_24_8 (&rm->hash, &kv, 1))
394 ip4_reass_free (rm, rt, reass);
402 ip4_reass_finalize (vlib_main_t * vm, vlib_node_runtime_t * node,
403 ip4_reass_main_t * rm, ip4_reass_per_thread_t * rt,
404 ip4_reass_t * reass, u32 * bi0, u32 * next0,
405 u32 * error0, u32 ** vec_drop_compress,
406 u32 ** vec_drop_overlap, bool is_feature)
408 ASSERT (~0 != reass->first_bi);
409 vlib_buffer_t *first_b = vlib_get_buffer (vm, reass->first_bi);
410 vlib_buffer_t *last_b = NULL;
411 u32 sub_chain_bi = reass->first_bi;
412 u32 total_length = 0;
417 u32 tmp_bi = sub_chain_bi;
418 vlib_buffer_t *tmp = vlib_get_buffer (vm, tmp_bi);
419 ip4_header_t *ip = vlib_buffer_get_current (tmp);
420 u32 data_len = ip4_reass_buffer_get_data_len (tmp);
422 ip4_header_bytes (ip) + ip4_reass_buffer_get_data_offset (tmp);
424 vlib_buffer_length_in_chain (vm, tmp) - trim_front - data_len;
425 if (tmp_bi == reass->first_bi)
427 /* first buffer - keep ip4 header */
428 ASSERT (0 == ip4_reass_buffer_get_data_offset (tmp));
430 trim_end = vlib_buffer_length_in_chain (vm, tmp) - data_len -
431 ip4_header_bytes (ip);
432 ASSERT (vlib_buffer_length_in_chain (vm, tmp) - trim_end > 0);
435 vlib_buffer_length_in_chain (vm, tmp) - trim_front - trim_end;
441 if (trim_front > tmp->current_length)
443 /* drop whole buffer */
444 vec_add1 (*vec_drop_compress, tmp_bi);
446 trim_front -= tmp->current_length;
447 ASSERT (tmp->flags & VLIB_BUFFER_NEXT_PRESENT);
448 tmp->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
449 tmp_bi = tmp->next_buffer;
450 tmp = vlib_get_buffer (vm, tmp_bi);
455 vlib_buffer_advance (tmp, trim_front);
463 last_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
464 last_b->next_buffer = tmp_bi;
467 if (keep_data <= tmp->current_length)
469 tmp->current_length = keep_data;
474 keep_data -= tmp->current_length;
475 ASSERT (tmp->flags & VLIB_BUFFER_NEXT_PRESENT);
477 total_length += tmp->current_length;
481 vec_add1 (*vec_drop_overlap, tmp_bi);
482 ASSERT (reass->first_bi != tmp_bi);
485 if (tmp->flags & VLIB_BUFFER_NEXT_PRESENT)
487 tmp_bi = tmp->next_buffer;
488 tmp = vlib_get_buffer (vm, tmp->next_buffer);
496 vnet_buffer (vlib_get_buffer (vm, sub_chain_bi))->ip.
499 while (~0 != sub_chain_bi);
501 ASSERT (last_b != NULL);
502 last_b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
503 ASSERT (rt->buffers_n >= (buf_cnt - dropped_cnt));
504 rt->buffers_n -= buf_cnt - dropped_cnt;
505 ASSERT (total_length >= first_b->current_length);
506 total_length -= first_b->current_length;
507 first_b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
508 first_b->total_length_not_including_first_buffer = total_length;
509 ip4_header_t *ip = vlib_buffer_get_current (first_b);
510 ip->flags_and_fragment_offset = 0;
511 ip->length = clib_host_to_net_u16 (first_b->current_length + total_length);
512 ip->checksum = ip4_header_checksum (ip);
513 vlib_buffer_chain_compress (vm, first_b, vec_drop_compress);
514 if (PREDICT_FALSE (first_b->flags & VLIB_BUFFER_IS_TRACED))
516 ip4_reass_add_trace (vm, node, rm, reass, reass->first_bi, FINALIZE, 0);
518 // following code does a hexdump of packet fragments to stdout ...
521 u32 bi = reass->first_bi;
525 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
526 s = format (s, "%u: %U\n", bi, format_hexdump,
527 vlib_buffer_get_current (b), b->current_length);
528 if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
537 printf ("%.*s\n", vec_len (s), s);
544 *bi0 = reass->first_bi;
547 *next0 = IP4_REASSEMBLY_NEXT_INPUT;
551 *next0 = reass->next_index;
553 vnet_buffer (first_b)->ip.reass.estimated_mtu = reass->min_fragment_length;
554 *error0 = IP4_ERROR_NONE;
555 ip4_reass_free (rm, rt, reass);
560 ip4_reass_get_buffer_chain_length (vlib_main_t * vm, vlib_buffer_t * b)
566 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_NEXT_PRESENT))
568 b = vlib_get_buffer (vm, b->next_buffer);
579 ip4_reass_insert_range_in_chain (vlib_main_t * vm,
580 ip4_reass_main_t * rm,
581 ip4_reass_per_thread_t * rt,
583 u32 prev_range_bi, u32 new_next_bi)
586 vlib_buffer_t *new_next_b = vlib_get_buffer (vm, new_next_bi);
587 vnet_buffer_opaque_t *new_next_vnb = vnet_buffer (new_next_b);
588 if (~0 != prev_range_bi)
590 vlib_buffer_t *prev_b = vlib_get_buffer (vm, prev_range_bi);
591 vnet_buffer_opaque_t *prev_vnb = vnet_buffer (prev_b);
592 new_next_vnb->ip.reass.next_range_bi = prev_vnb->ip.reass.next_range_bi;
593 prev_vnb->ip.reass.next_range_bi = new_next_bi;
597 if (~0 != reass->first_bi)
599 new_next_vnb->ip.reass.next_range_bi = reass->first_bi;
601 reass->first_bi = new_next_bi;
603 reass->data_len += ip4_reass_buffer_get_data_len (new_next_b);
604 rt->buffers_n += ip4_reass_get_buffer_chain_length (vm, new_next_b);
608 ip4_reass_remove_range_from_chain (vlib_main_t * vm,
609 vlib_node_runtime_t * node,
610 ip4_reass_main_t * rm,
611 u32 ** vec_drop_overlap,
612 ip4_reass_t * reass, u32 prev_range_bi,
615 vlib_buffer_t *discard_b = vlib_get_buffer (vm, discard_bi);
616 vnet_buffer_opaque_t *discard_vnb = vnet_buffer (discard_b);
617 if (~0 != prev_range_bi)
619 vlib_buffer_t *prev_b = vlib_get_buffer (vm, prev_range_bi);
620 vnet_buffer_opaque_t *prev_vnb = vnet_buffer (prev_b);
621 ASSERT (prev_vnb->ip.reass.next_range_bi == discard_bi);
622 prev_vnb->ip.reass.next_range_bi = discard_vnb->ip.reass.next_range_bi;
626 reass->first_bi = discard_vnb->ip.reass.next_range_bi;
628 reass->data_len -= ip4_reass_buffer_get_data_len (discard_b);
631 vec_add1 (*vec_drop_overlap, discard_bi);
632 if (PREDICT_FALSE (discard_b->flags & VLIB_BUFFER_IS_TRACED))
634 ip4_reass_add_trace (vm, node, rm, reass, discard_bi, RANGE_DISCARD,
637 if (discard_b->flags & VLIB_BUFFER_NEXT_PRESENT)
639 discard_b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
640 discard_bi = discard_b->next_buffer;
641 discard_b = vlib_get_buffer (vm, discard_bi);
651 ip4_reass_update (vlib_main_t * vm, vlib_node_runtime_t * node,
652 ip4_reass_main_t * rm, ip4_reass_per_thread_t * rt,
653 ip4_reass_t * reass, u32 * bi0, u32 * next0,
654 u32 * error0, u32 ** vec_drop_overlap,
655 u32 ** vec_drop_compress, bool is_feature)
658 vlib_buffer_t *fb = vlib_get_buffer (vm, *bi0);
659 ip4_header_t *fip = vlib_buffer_get_current (fb);
660 ASSERT (fb->current_length >= sizeof (*fip));
661 vnet_buffer_opaque_t *fvnb = vnet_buffer (fb);
662 u32 fragment_first = fvnb->ip.reass.fragment_first =
663 ip4_get_fragment_offset_bytes (fip);
664 u32 fragment_length =
665 clib_net_to_host_u16 (fip->length) - ip4_header_bytes (fip);
666 u32 fragment_last = fvnb->ip.reass.fragment_last =
667 fragment_first + fragment_length - 1;
668 int more_fragments = ip4_get_fragment_more (fip);
669 u32 candidate_range_bi = reass->first_bi;
670 u32 prev_range_bi = ~0;
671 reass->next_index = fvnb->ip.reass.next_index; // store next_index before it's overwritten
672 fvnb->ip.reass.range_first = fragment_first;
673 fvnb->ip.reass.range_last = fragment_last;
674 fvnb->ip.reass.next_range_bi = ~0;
677 reass->last_packet_octet = fragment_last;
679 if (~0 == reass->first_bi)
681 // starting a new reassembly
682 ip4_reass_insert_range_in_chain (vm, rm, rt, reass, prev_range_bi,
684 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
686 ip4_reass_add_trace (vm, node, rm, reass, *bi0, RANGE_NEW, 0);
689 reass->min_fragment_length = clib_net_to_host_u16 (fip->length);
692 reass->min_fragment_length = clib_min (clib_net_to_host_u16 (fip->length),
693 fvnb->ip.reass.estimated_mtu);
694 while (~0 != candidate_range_bi)
696 vlib_buffer_t *candidate_b = vlib_get_buffer (vm, candidate_range_bi);
697 vnet_buffer_opaque_t *candidate_vnb = vnet_buffer (candidate_b);
698 if (fragment_first > candidate_vnb->ip.reass.range_last)
700 // this fragments starts after candidate range
701 prev_range_bi = candidate_range_bi;
702 candidate_range_bi = candidate_vnb->ip.reass.next_range_bi;
703 if (candidate_vnb->ip.reass.range_last < fragment_last &&
704 ~0 == candidate_range_bi)
706 // special case - this fragment falls beyond all known ranges
707 ip4_reass_insert_range_in_chain (vm, rm, rt, reass,
708 prev_range_bi, *bi0);
714 if (fragment_last < candidate_vnb->ip.reass.range_first)
716 // this fragment ends before candidate range without any overlap
717 ip4_reass_insert_range_in_chain (vm, rm, rt, reass, prev_range_bi,
723 if (fragment_first >= candidate_vnb->ip.reass.range_first &&
724 fragment_last <= candidate_vnb->ip.reass.range_last)
726 // this fragment is a (sub)part of existing range, ignore it
727 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
729 ip4_reass_add_trace (vm, node, rm, reass, *bi0,
734 int discard_candidate = 0;
735 if (fragment_first < candidate_vnb->ip.reass.range_first)
738 fragment_last - candidate_vnb->ip.reass.range_first + 1;
739 if (overlap < ip4_reass_buffer_get_data_len (candidate_b))
741 candidate_vnb->ip.reass.range_first += overlap;
742 ASSERT (reass->data_len >= overlap);
743 reass->data_len -= overlap;
744 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
746 ip4_reass_add_trace (vm, node, rm, reass,
747 candidate_range_bi, RANGE_SHRINK,
750 ip4_reass_insert_range_in_chain (vm, rm, rt, reass,
751 prev_range_bi, *bi0);
756 discard_candidate = 1;
759 else if (fragment_last > candidate_vnb->ip.reass.range_last)
762 candidate_vnb->ip.reass.range_last - fragment_first + 1;
763 if (overlap < ip4_reass_buffer_get_data_len (candidate_b))
765 fvnb->ip.reass.range_first += overlap;
766 if (~0 != candidate_vnb->ip.reass.next_range_bi)
768 prev_range_bi = candidate_range_bi;
770 candidate_vnb->ip.reass.next_range_bi;
775 // special case - last range discarded
776 ip4_reass_insert_range_in_chain (vm, rm, rt, reass,
784 discard_candidate = 1;
789 discard_candidate = 1;
791 if (discard_candidate)
793 u32 next_range_bi = candidate_vnb->ip.reass.next_range_bi;
794 // discard candidate range, probe next range
795 ip4_reass_remove_range_from_chain (vm, node, rm,
796 vec_drop_overlap, reass,
799 if (~0 != next_range_bi)
801 candidate_range_bi = next_range_bi;
806 // special case - last range discarded
807 ip4_reass_insert_range_in_chain (vm, rm, rt, reass,
808 prev_range_bi, *bi0);
817 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
819 ip4_reass_add_trace (vm, node, rm, reass, *bi0, RANGE_NEW, 0);
822 if (~0 != reass->last_packet_octet &&
823 reass->data_len == reass->last_packet_octet + 1)
825 ip4_reass_finalize (vm, node, rm, rt, reass, bi0, next0, error0,
826 vec_drop_compress, vec_drop_overlap, is_feature);
836 *next0 = IP4_REASSEMBLY_NEXT_DROP;
837 *error0 = IP4_ERROR_REASS_DUPLICATE_FRAGMENT;
843 ip4_reassembly_inline (vlib_main_t * vm,
844 vlib_node_runtime_t * node,
845 vlib_frame_t * frame, bool is_feature)
847 u32 *from = vlib_frame_vector_args (frame);
848 u32 n_left_from, n_left_to_next, *to_next, next_index;
849 ip4_reass_main_t *rm = &ip4_reass_main;
850 ip4_reass_per_thread_t *rt = &rm->per_thread_data[os_get_thread_index ()];
851 clib_spinlock_lock (&rt->lock);
853 n_left_from = frame->n_vectors;
854 next_index = node->cached_next_index;
855 static u32 *vec_drop_timeout = NULL; // indexes of buffers which timed out
856 static u32 *vec_drop_overlap = NULL; // indexes of buffers which were discarded due to overlap
857 static u32 *vec_drop_compress = NULL; // indexes of buffers dicarded due to buffer compression
858 while (n_left_from > 0 || vec_len (vec_drop_timeout) > 0 ||
859 vec_len (vec_drop_overlap) > 0 || vec_len (vec_drop_compress) > 0)
861 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
863 while (vec_len (vec_drop_timeout) > 0 && n_left_to_next > 0)
865 u32 bi = vec_pop (vec_drop_timeout);
866 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
867 b->error = node->errors[IP4_ERROR_REASS_TIMEOUT];
871 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
873 IP4_REASSEMBLY_NEXT_DROP);
874 IP4_REASS_DEBUG_BUFFER (bi, enqueue_drop_timeout);
875 ASSERT (rt->buffers_n > 0);
879 while (vec_len (vec_drop_overlap) > 0 && n_left_to_next > 0)
881 u32 bi = vec_pop (vec_drop_overlap);
882 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
883 b->error = node->errors[IP4_ERROR_REASS_DUPLICATE_FRAGMENT];
887 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
889 IP4_REASSEMBLY_NEXT_DROP);
890 IP4_REASS_DEBUG_BUFFER (bi, enqueue_drop_duplicate_fragment);
891 ASSERT (rt->buffers_n > 0);
895 while (vec_len (vec_drop_compress) > 0 && n_left_to_next > 0)
897 u32 bi = vec_pop (vec_drop_compress);
898 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
899 b->error = node->errors[IP4_ERROR_NONE];
903 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
905 IP4_REASSEMBLY_NEXT_DROP);
906 IP4_REASS_DEBUG_BUFFER (bi, enqueue_drop_compress);
907 ASSERT (rt->buffers_n > 0);
911 while (n_left_from > 0 && n_left_to_next > 0)
916 u32 error0 = IP4_ERROR_NONE;
919 b0 = vlib_get_buffer (vm, bi0);
921 ip4_header_t *ip0 = vlib_buffer_get_current (b0);
922 if (!ip4_get_fragment_more (ip0) && !ip4_get_fragment_offset (ip0))
924 // this is a whole packet - no fragmentation
927 next0 = IP4_REASSEMBLY_NEXT_INPUT;
931 next0 = vnet_buffer (b0)->ip.reass.next_index;
937 k.src.as_u32 = ip0->src_address.as_u32;
938 k.dst.as_u32 = ip0->dst_address.as_u32;
939 k.xx_id = vnet_buffer (b0)->sw_if_index[VLIB_RX];
940 k.frag_id = ip0->fragment_id;
941 k.proto = ip0->protocol;
944 ip4_reass_find_or_create (vm, rm, rt, &k, &vec_drop_timeout);
948 ip4_reass_update (vm, node, rm, rt, reass, &bi0, &next0,
949 &error0, &vec_drop_overlap,
950 &vec_drop_compress, is_feature);
954 next0 = IP4_REASSEMBLY_NEXT_DROP;
955 error0 = IP4_ERROR_REASS_LIMIT_REACHED;
958 b0->error = node->errors[error0];
966 if (is_feature && IP4_ERROR_NONE == error0)
968 vnet_feature_next (vnet_buffer (b0)->sw_if_index[VLIB_RX],
971 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
972 n_left_to_next, bi0, next0);
973 IP4_REASS_DEBUG_BUFFER (bi0, enqueue_next);
980 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
983 clib_spinlock_unlock (&rt->lock);
984 return frame->n_vectors;
987 static char *ip4_reassembly_error_strings[] = {
988 #define _(sym, string) string,
994 ip4_reassembly (vlib_main_t * vm, vlib_node_runtime_t * node,
995 vlib_frame_t * frame)
997 return ip4_reassembly_inline (vm, node, frame, false /* is_feature */ );
1001 VLIB_REGISTER_NODE (ip4_reass_node, static) = {
1002 .function = ip4_reassembly,
1003 .name = "ip4-reassembly",
1004 .vector_size = sizeof (u32),
1005 .format_trace = format_ip4_reass_trace,
1006 .n_errors = ARRAY_LEN (ip4_reassembly_error_strings),
1007 .error_strings = ip4_reassembly_error_strings,
1008 .n_next_nodes = IP4_REASSEMBLY_N_NEXT,
1011 [IP4_REASSEMBLY_NEXT_INPUT] = "ip4-input",
1012 [IP4_REASSEMBLY_NEXT_DROP] = "ip4-drop",
1017 VLIB_NODE_FUNCTION_MULTIARCH (ip4_reass_node, ip4_reassembly);
1020 ip4_reassembly_feature (vlib_main_t * vm,
1021 vlib_node_runtime_t * node, vlib_frame_t * frame)
1023 return ip4_reassembly_inline (vm, node, frame, true /* is_feature */ );
1027 VLIB_REGISTER_NODE (ip4_reass_node_feature, static) = {
1028 .function = ip4_reassembly_feature,
1029 .name = "ip4-reassembly-feature",
1030 .vector_size = sizeof (u32),
1031 .format_trace = format_ip4_reass_trace,
1032 .n_errors = ARRAY_LEN (ip4_reassembly_error_strings),
1033 .error_strings = ip4_reassembly_error_strings,
1034 .n_next_nodes = IP4_REASSEMBLY_N_NEXT,
1037 [IP4_REASSEMBLY_NEXT_INPUT] = "ip4-input",
1038 [IP4_REASSEMBLY_NEXT_DROP] = "ip4-drop",
1043 VLIB_NODE_FUNCTION_MULTIARCH (ip4_reass_node_feature, ip4_reassembly_feature);
1046 VNET_FEATURE_INIT (ip4_reassembly_feature, static) = {
1047 .arc_name = "ip4-unicast",
1048 .node_name = "ip4-reassembly-feature",
1049 .runs_before = VNET_FEATURES ("ip4-lookup"),
1055 ip4_reass_get_nbuckets ()
1057 ip4_reass_main_t *rm = &ip4_reass_main;
1061 nbuckets = (u32) (rm->max_reass_n / IP4_REASS_HT_LOAD_FACTOR);
1063 for (i = 0; i < 31; i++)
1064 if ((1 << i) >= nbuckets)
1073 IP4_EVENT_CONFIG_CHANGED = 1,
1074 } ip4_reass_event_t;
1079 clib_bihash_24_8_t *new_hash;
1080 } ip4_rehash_cb_ctx;
1083 ip4_rehash_cb (clib_bihash_kv_24_8_t * kv, void *_ctx)
1085 ip4_rehash_cb_ctx *ctx = _ctx;
1086 if (clib_bihash_add_del_24_8 (ctx->new_hash, kv, 1))
1093 ip4_reass_set_params (u32 timeout_ms, u32 max_reassemblies,
1094 u32 expire_walk_interval_ms)
1096 ip4_reass_main.timeout_ms = timeout_ms;
1097 ip4_reass_main.timeout = (f64) timeout_ms / (f64) MSEC_PER_SEC;
1098 ip4_reass_main.max_reass_n = max_reassemblies;
1099 ip4_reass_main.expire_walk_interval_ms = expire_walk_interval_ms;
1103 ip4_reass_set (u32 timeout_ms, u32 max_reassemblies,
1104 u32 expire_walk_interval_ms)
1106 u32 old_nbuckets = ip4_reass_get_nbuckets ();
1107 ip4_reass_set_params (timeout_ms, max_reassemblies,
1108 expire_walk_interval_ms);
1109 vlib_process_signal_event (ip4_reass_main.vlib_main,
1110 ip4_reass_main.ip4_reass_expire_node_idx,
1111 IP4_EVENT_CONFIG_CHANGED, 0);
1112 u32 new_nbuckets = ip4_reass_get_nbuckets ();
1113 if (ip4_reass_main.max_reass_n > 0 && new_nbuckets > old_nbuckets)
1115 clib_bihash_24_8_t new_hash;
1116 memset (&new_hash, 0, sizeof (new_hash));
1117 ip4_rehash_cb_ctx ctx;
1119 ctx.new_hash = &new_hash;
1120 clib_bihash_init_24_8 (&new_hash, "ip4-reass", new_nbuckets,
1121 new_nbuckets * 1024);
1122 clib_bihash_foreach_key_value_pair_24_8 (&ip4_reass_main.hash,
1123 ip4_rehash_cb, &ctx);
1126 clib_bihash_free_24_8 (&new_hash);
1131 clib_bihash_free_24_8 (&ip4_reass_main.hash);
1132 clib_memcpy (&ip4_reass_main.hash, &new_hash,
1133 sizeof (ip4_reass_main.hash));
1140 ip4_reass_get (u32 * timeout_ms, u32 * max_reassemblies,
1141 u32 * expire_walk_interval_ms)
1143 *timeout_ms = ip4_reass_main.timeout_ms;
1144 *max_reassemblies = ip4_reass_main.max_reass_n;
1145 *expire_walk_interval_ms = ip4_reass_main.expire_walk_interval_ms;
1149 static clib_error_t *
1150 ip4_reass_init_function (vlib_main_t * vm)
1152 ip4_reass_main_t *rm = &ip4_reass_main;
1153 clib_error_t *error = 0;
1158 rm->vnet_main = vnet_get_main ();
1160 vec_validate (rm->per_thread_data, vlib_num_workers () + 1);
1161 ip4_reass_per_thread_t *rt;
1162 vec_foreach (rt, rm->per_thread_data)
1164 clib_spinlock_init (&rt->lock);
1165 pool_alloc (rt->pool, rm->max_reass_n);
1168 node = vlib_get_node_by_name (vm, (u8 *) "ip4-reassembly-expire-walk");
1170 rm->ip4_reass_expire_node_idx = node->index;
1172 ip4_reass_set_params (IP4_REASS_TIMEOUT_DEFAULT_MS,
1173 IP4_REASS_MAX_REASSEMBLIES_DEFAULT,
1174 IP4_REASS_EXPIRE_WALK_INTERVAL_DEFAULT_MS);
1176 nbuckets = ip4_reass_get_nbuckets ();
1177 clib_bihash_init_24_8 (&rm->hash, "ip4-reass", nbuckets, nbuckets * 1024);
1179 node = vlib_get_node_by_name (vm, (u8 *) "ip4-drop");
1181 rm->ip4_drop_idx = node->index;
1186 VLIB_INIT_FUNCTION (ip4_reass_init_function);
1189 ip4_reass_walk_expired (vlib_main_t * vm,
1190 vlib_node_runtime_t * node, vlib_frame_t * f)
1192 ip4_reass_main_t *rm = &ip4_reass_main;
1193 uword event_type, *event_data = 0;
1197 vlib_process_wait_for_event_or_clock (vm,
1198 (f64) rm->expire_walk_interval_ms
1199 / (f64) MSEC_PER_SEC);
1200 event_type = vlib_process_get_events (vm, &event_data);
1204 case ~0: /* no events => timeout */
1205 /* nothing to do here */
1207 case IP4_EVENT_CONFIG_CHANGED:
1210 clib_warning ("BUG: event type 0x%wx", event_type);
1213 f64 now = vlib_time_now (vm);
1216 u32 *vec_drop_timeout = NULL;
1217 int *pool_indexes_to_free = NULL;
1219 uword thread_index = 0;
1221 const uword nthreads = os_get_nthreads ();
1222 for (thread_index = 0; thread_index < nthreads; ++thread_index)
1224 ip4_reass_per_thread_t *rt = &rm->per_thread_data[thread_index];
1225 clib_spinlock_lock (&rt->lock);
1227 vec_reset_length (pool_indexes_to_free);
1229 pool_foreach_index (index, rt->pool, ({
1230 reass = pool_elt_at_index (rt->pool, index);
1231 if (now > reass->last_heard + rm->timeout)
1233 vec_add1 (pool_indexes_to_free, index);
1239 vec_foreach (i, pool_indexes_to_free)
1241 ip4_reass_t *reass = pool_elt_at_index (rt->pool, i[0]);
1242 u32 before = vec_len (vec_drop_timeout);
1243 vlib_buffer_t *b = vlib_get_buffer (vm, reass->first_bi);
1244 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
1246 if (pool_is_free_index (vm->trace_main.trace_buffer_pool,
1249 /* the trace is gone, don't trace this buffer anymore */
1250 b->flags &= ~VLIB_BUFFER_IS_TRACED;
1253 ip4_reass_on_timeout (vm, rm, reass, &vec_drop_timeout);
1254 u32 after = vec_len (vec_drop_timeout);
1255 ASSERT (rt->buffers_n >= (after - before));
1256 rt->buffers_n -= (after - before);
1257 ip4_reass_free (rm, rt, reass);
1261 clib_spinlock_unlock (&rt->lock);
1264 while (vec_len (vec_drop_timeout) > 0)
1266 vlib_frame_t *f = vlib_get_frame_to_node (vm, rm->ip4_drop_idx);
1267 u32 *to_next = vlib_frame_vector_args (f);
1268 u32 n_left_to_next = VLIB_FRAME_SIZE - f->n_vectors;
1269 int trace_frame = 0;
1270 while (vec_len (vec_drop_timeout) > 0 && n_left_to_next > 0)
1272 u32 bi = vec_pop (vec_drop_timeout);
1273 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
1274 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
1276 if (pool_is_free_index (vm->trace_main.trace_buffer_pool,
1279 /* the trace is gone, don't trace this buffer anymore */
1280 b->flags &= ~VLIB_BUFFER_IS_TRACED;
1287 b->error = node->errors[IP4_ERROR_REASS_TIMEOUT];
1291 n_left_to_next -= 1;
1292 IP4_REASS_DEBUG_BUFFER (bi, enqueue_drop_timeout_walk);
1294 f->flags |= (trace_frame * VLIB_FRAME_TRACE);
1295 vlib_put_frame_to_node (vm, rm->ip4_drop_idx, f);
1298 vec_free (pool_indexes_to_free);
1299 vec_free (vec_drop_timeout);
1302 _vec_len (event_data) = 0;
1309 static vlib_node_registration_t ip4_reass_expire_node;
1312 VLIB_REGISTER_NODE (ip4_reass_expire_node, static) = {
1313 .function = ip4_reass_walk_expired,
1314 .type = VLIB_NODE_TYPE_PROCESS,
1315 .name = "ip4-reassembly-expire-walk",
1316 .format_trace = format_ip4_reass_trace,
1317 .n_errors = ARRAY_LEN (ip4_reassembly_error_strings),
1318 .error_strings = ip4_reassembly_error_strings,
1324 format_ip4_reass_key (u8 * s, va_list * args)
1326 ip4_reass_key_t *key = va_arg (*args, ip4_reass_key_t *);
1327 s = format (s, "xx_id: %u, src: %U, dst: %U, frag_id: %u, proto: %u",
1328 key->xx_id, format_ip4_address, &key->src, format_ip4_address,
1329 &key->dst, clib_net_to_host_u16 (key->frag_id), key->proto);
1334 format_ip4_reass (u8 * s, va_list * args)
1336 vlib_main_t *vm = va_arg (*args, vlib_main_t *);
1337 ip4_reass_t *reass = va_arg (*args, ip4_reass_t *);
1339 s = format (s, "ID: %lu, key: %U\n first_bi: %u, data_len: %u, "
1340 "last_packet_octet: %u, trace_op_counter: %u\n",
1341 reass->id, format_ip4_reass_key, &reass->key, reass->first_bi,
1342 reass->data_len, reass->last_packet_octet,
1343 reass->trace_op_counter);
1344 u32 bi = reass->first_bi;
1348 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
1349 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
1350 s = format (s, " #%03u: range: [%u, %u], bi: %u, off: %d, len: %u, "
1351 "fragment[%u, %u]\n",
1352 counter, vnb->ip.reass.range_first,
1353 vnb->ip.reass.range_last, bi,
1354 ip4_reass_buffer_get_data_offset_no_check (b),
1355 ip4_reass_buffer_get_data_len_no_check (b),
1356 vnb->ip.reass.fragment_first, vnb->ip.reass.fragment_last);
1357 if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
1359 bi = b->next_buffer;
1369 static clib_error_t *
1370 show_ip4_reass (vlib_main_t * vm, unformat_input_t * input,
1371 CLIB_UNUSED (vlib_cli_command_t * lmd))
1373 ip4_reass_main_t *rm = &ip4_reass_main;
1375 vlib_cli_output (vm, "---------------------");
1376 vlib_cli_output (vm, "IP4 reassembly status");
1377 vlib_cli_output (vm, "---------------------");
1378 bool details = false;
1379 if (unformat (input, "details"))
1384 u32 sum_reass_n = 0;
1385 u64 sum_buffers_n = 0;
1388 const uword nthreads = os_get_nthreads ();
1389 for (thread_index = 0; thread_index < nthreads; ++thread_index)
1391 ip4_reass_per_thread_t *rt = &rm->per_thread_data[thread_index];
1392 clib_spinlock_lock (&rt->lock);
1396 pool_foreach (reass, rt->pool, {
1397 vlib_cli_output (vm, "%U", format_ip4_reass, vm, reass);
1401 sum_reass_n += rt->reass_n;
1402 sum_buffers_n += rt->buffers_n;
1403 clib_spinlock_unlock (&rt->lock);
1405 vlib_cli_output (vm, "---------------------");
1406 vlib_cli_output (vm, "Current IP4 reassemblies count: %lu\n",
1407 (long unsigned) sum_reass_n);
1408 vlib_cli_output (vm,
1409 "Maximum configured concurrent IP4 reassemblies per worker-thread: %lu\n",
1410 (long unsigned) rm->max_reass_n);
1411 vlib_cli_output (vm, "Buffers in use: %lu\n",
1412 (long unsigned) sum_buffers_n);
1417 VLIB_CLI_COMMAND (show_ip4_reassembly_cmd, static) = {
1418 .path = "show ip4-reassembly",
1419 .short_help = "show ip4-reassembly [details]",
1420 .function = show_ip4_reass,
1425 ip4_reass_enable_disable (u32 sw_if_index, u8 enable_disable)
1427 return vnet_feature_enable_disable ("ip4-unicast", "ip4-reassembly-feature",
1428 sw_if_index, enable_disable, 0, 0);
1432 * fd.io coding-style-patch-verification: ON
1435 * eval: (c-set-style "gnu")