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_DEAFULT 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);
115 // time when last packet was received
117 // internal id of this reassembly
119 // buffer index of first buffer in this reassembly context
121 // last octet of packet, ~0 until fragment without more_fragments arrives
122 u32 last_packet_octet;
123 // length of data collected so far
125 // trace operation counter
126 u32 trace_op_counter;
134 u32 expire_walk_interval_ms;
139 clib_bihash_24_8_t hash;
145 vlib_main_t *vlib_main;
146 vnet_main_t *vnet_main;
148 // node index of ip4-drop node
150 u32 ip4_reass_expire_node_idx;
154 ip4_reass_main_t ip4_reass_main;
158 IP4_REASSEMBLY_NEXT_INPUT,
159 IP4_REASSEMBLY_NEXT_DROP,
160 IP4_REASSEMBLY_N_NEXT,
170 } ip4_reass_trace_operation_e;
180 } ip4_reass_range_trace_t;
184 ip4_reass_trace_operation_e action;
187 ip4_reass_range_trace_t trace_range;
196 ip4_reass_trace_details (vlib_main_t * vm, u32 bi,
197 ip4_reass_range_trace_t * trace)
199 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
200 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
201 trace->range_first = vnb->ip.reass.range_first;
202 trace->range_last = vnb->ip.reass.range_last;
203 trace->data_offset = ip4_reass_buffer_get_data_offset_no_check (b);
204 trace->data_len = ip4_reass_buffer_get_data_len_no_check (b);
205 trace->range_bi = bi;
209 format_ip4_reass_range_trace (u8 * s, va_list * args)
211 ip4_reass_range_trace_t *trace = va_arg (*args, ip4_reass_range_trace_t *);
212 s = format (s, "range: [%u, %u], off %d, len %u, bi %u", trace->range_first,
213 trace->range_last, trace->data_offset, trace->data_len,
219 format_ip4_reass_trace (u8 * s, va_list * args)
221 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
222 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
223 ip4_reass_trace_t *t = va_arg (*args, ip4_reass_trace_t *);
224 s = format (s, "reass id: %u, op id: %u ", t->reass_id, t->op_id);
225 u32 indent = format_get_indent (s);
226 s = format (s, "first bi: %u, data len: %u, ip/fragment[%u, %u]",
227 t->trace_range.first_bi, t->total_data_len, t->fragment_first,
232 s = format (s, "\n%Ushrink %U by %u", format_white_space, indent,
233 format_ip4_reass_range_trace, &t->trace_range,
237 s = format (s, "\n%Udiscard %U", format_white_space, indent,
238 format_ip4_reass_range_trace, &t->trace_range);
241 s = format (s, "\n%Unew %U", format_white_space, indent,
242 format_ip4_reass_range_trace, &t->trace_range);
245 s = format (s, "\n%Uoverlapping/ignored %U", format_white_space, indent,
246 format_ip4_reass_range_trace, &t->trace_range);
249 s = format (s, "\n%Ufinalize reassembly", format_white_space, indent);
256 ip4_reass_add_trace (vlib_main_t * vm, vlib_node_runtime_t * node,
257 ip4_reass_main_t * rm, ip4_reass_t * reass, u32 bi,
258 ip4_reass_trace_operation_e action, u32 size_diff)
260 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
261 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
262 ip4_reass_trace_t *t = vlib_add_trace (vm, node, b, sizeof (t[0]));
263 t->pool_index = reass - rm->pool;
264 t->reass_id = reass->id;
266 ip4_reass_trace_details (vm, bi, &t->trace_range);
267 t->size_diff = size_diff;
268 t->op_id = reass->trace_op_counter;
269 ++reass->trace_op_counter;
270 t->fragment_first = vnb->ip.reass.fragment_first;
271 t->fragment_last = vnb->ip.reass.fragment_last;
272 t->trace_range.first_bi = reass->first_bi;
273 t->total_data_len = reass->data_len;
276 s = format (s, "%U", format_ip4_reass_trace, NULL, NULL, t);
277 printf ("%.*s\n", vec_len (s), s);
279 vec_reset_length (s);
284 ip4_reass_free (ip4_reass_main_t * rm, ip4_reass_t * reass)
286 clib_bihash_kv_24_8_t kv;
287 kv.key[0] = reass->key.as_u64[0];
288 kv.key[1] = reass->key.as_u64[1];
289 kv.key[2] = reass->key.as_u64[2];
290 clib_bihash_add_del_24_8 (&rm->hash, &kv, 0);
291 pool_put (rm->pool, reass);
296 ip4_reass_on_timeout (vlib_main_t * vm, ip4_reass_main_t * rm,
297 ip4_reass_t * reass, u32 ** vec_drop_timeout)
299 u32 range_bi = reass->first_bi;
300 vlib_buffer_t *range_b;
301 vnet_buffer_opaque_t *range_vnb;
302 while (~0 != range_bi)
304 range_b = vlib_get_buffer (vm, range_bi);
305 range_vnb = vnet_buffer (range_b);
309 vec_add1 (*vec_drop_timeout, bi);
310 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
311 if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
314 b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
321 range_bi = range_vnb->ip.reass.next_range_bi;
326 ip4_reass_find_or_create (vlib_main_t * vm, ip4_reass_main_t * rm,
327 ip4_reass_key_t * k, u32 ** vec_drop_timeout)
329 ip4_reass_t *reass = NULL;
330 f64 now = vlib_time_now (rm->vlib_main);
331 clib_bihash_kv_24_8_t kv, value;
332 kv.key[0] = k->as_u64[0];
333 kv.key[1] = k->as_u64[1];
334 kv.key[2] = k->as_u64[2];
336 if (!clib_bihash_search_24_8 (&rm->hash, &kv, &value))
338 reass = pool_elt_at_index (rm->pool, value.value);
339 if (now > reass->last_heard + rm->timeout)
341 ip4_reass_on_timeout (vm, rm, reass, vec_drop_timeout);
342 ip4_reass_free (rm, reass);
349 reass->last_heard = now;
353 if (rm->reass_n >= rm->max_reass_n)
360 pool_get (rm->pool, reass);
361 memset (reass, 0, sizeof (*reass));
362 reass->id = rm->id_counter;
364 reass->first_bi = ~0;
365 reass->last_packet_octet = ~0;
370 reass->key.as_u64[0] = kv.key[0] = k->as_u64[0];
371 reass->key.as_u64[1] = kv.key[1] = k->as_u64[1];
372 reass->key.as_u64[2] = kv.key[2] = k->as_u64[2];
373 kv.value = reass - rm->pool;
374 reass->last_heard = now;
376 if (clib_bihash_add_del_24_8 (&rm->hash, &kv, 1))
378 ip4_reass_free (rm, reass);
386 ip4_reass_finalize (vlib_main_t * vm, vlib_node_runtime_t * node,
387 ip4_reass_main_t * rm, ip4_reass_t * reass, u32 * bi0,
388 u32 * next0, vlib_error_t * error0, u32 next_input,
389 u32 ** vec_drop_compress, u32 ** vec_drop_overlap)
391 ASSERT (~0 != reass->first_bi);
392 vlib_buffer_t *first_b = vlib_get_buffer (vm, reass->first_bi);
393 vlib_buffer_t *last_b = NULL;
394 u32 sub_chain_bi = reass->first_bi;
395 u32 total_length = 0;
400 u32 tmp_bi = sub_chain_bi;
401 vlib_buffer_t *tmp = vlib_get_buffer (vm, tmp_bi);
402 ip4_header_t *ip = vlib_buffer_get_current (tmp);
403 u32 data_len = ip4_reass_buffer_get_data_len (tmp);
405 ip4_header_bytes (ip) + ip4_reass_buffer_get_data_offset (tmp);
407 vlib_buffer_length_in_chain (vm, tmp) - trim_front - data_len;
408 if (tmp_bi == reass->first_bi)
410 /* first buffer - keep ip4 header */
411 ASSERT (0 == ip4_reass_buffer_get_data_offset (tmp));
413 trim_end = vlib_buffer_length_in_chain (vm, tmp) - data_len -
414 ip4_header_bytes (ip);
415 ASSERT (vlib_buffer_length_in_chain (vm, tmp) - trim_end > 0);
418 vlib_buffer_length_in_chain (vm, tmp) - trim_front - trim_end;
424 if (trim_front > tmp->current_length)
426 /* drop whole buffer */
427 vec_add1 (*vec_drop_compress, tmp_bi);
429 trim_front -= tmp->current_length;
430 ASSERT (tmp->flags & VLIB_BUFFER_NEXT_PRESENT);
431 tmp->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
432 tmp_bi = tmp->next_buffer;
433 tmp = vlib_get_buffer (vm, tmp_bi);
438 vlib_buffer_advance (tmp, trim_front);
446 last_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
447 last_b->next_buffer = tmp_bi;
450 if (keep_data <= tmp->current_length)
452 tmp->current_length = keep_data;
457 keep_data -= tmp->current_length;
458 ASSERT (tmp->flags & VLIB_BUFFER_NEXT_PRESENT);
460 total_length += tmp->current_length;
464 vec_add1 (*vec_drop_overlap, tmp_bi);
465 ASSERT (reass->first_bi != tmp_bi);
468 if (tmp->flags & VLIB_BUFFER_NEXT_PRESENT)
470 tmp_bi = tmp->next_buffer;
471 tmp = vlib_get_buffer (vm, tmp->next_buffer);
479 vnet_buffer (vlib_get_buffer (vm, sub_chain_bi))->ip.
482 while (~0 != sub_chain_bi);
483 last_b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
484 ASSERT (rm->buffers_n >= (buf_cnt - dropped_cnt));
485 rm->buffers_n -= buf_cnt - dropped_cnt;
486 ASSERT (total_length >= first_b->current_length);
487 total_length -= first_b->current_length;
488 first_b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
489 first_b->total_length_not_including_first_buffer = total_length;
490 ip4_header_t *ip = vlib_buffer_get_current (first_b);
491 ip->flags_and_fragment_offset = 0;
492 ip->length = clib_host_to_net_u16 (first_b->current_length + total_length);
493 ip->checksum = ip4_header_checksum (ip);
494 vlib_buffer_chain_compress (vm, first_b, vec_drop_compress);
495 if (PREDICT_FALSE (first_b->flags & VLIB_BUFFER_IS_TRACED))
497 ip4_reass_add_trace (vm, node, rm, reass, reass->first_bi, FINALIZE, 0);
499 // following code does a hexdump of packet fragments to stdout ...
502 u32 bi = reass->first_bi;
506 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
507 s = format (s, "%u: %U\n", bi, format_hexdump,
508 vlib_buffer_get_current (b), b->current_length);
509 if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
518 printf ("%.*s\n", vec_len (s), s);
525 *bi0 = reass->first_bi;
527 *error0 = IP4_ERROR_NONE;
528 ip4_reass_free (rm, reass);
533 ip4_reass_get_buffer_chain_length (vlib_main_t * vm, vlib_buffer_t * b)
539 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_NEXT_PRESENT))
541 b = vlib_get_buffer (vm, b->next_buffer);
552 ip4_reass_insert_range_in_chain (vlib_main_t * vm,
553 ip4_reass_main_t * rm,
555 u32 prev_range_bi, u32 new_next_bi)
558 vlib_buffer_t *new_next_b = vlib_get_buffer (vm, new_next_bi);
559 vnet_buffer_opaque_t *new_next_vnb = vnet_buffer (new_next_b);
560 if (~0 != prev_range_bi)
562 vlib_buffer_t *prev_b = vlib_get_buffer (vm, prev_range_bi);
563 vnet_buffer_opaque_t *prev_vnb = vnet_buffer (prev_b);
564 new_next_vnb->ip.reass.next_range_bi = prev_vnb->ip.reass.next_range_bi;
565 prev_vnb->ip.reass.next_range_bi = new_next_bi;
569 if (~0 != reass->first_bi)
571 new_next_vnb->ip.reass.next_range_bi = reass->first_bi;
573 reass->first_bi = new_next_bi;
575 reass->data_len += ip4_reass_buffer_get_data_len (new_next_b);
576 rm->buffers_n += ip4_reass_get_buffer_chain_length (vm, new_next_b);
580 ip4_reass_remove_range_from_chain (vlib_main_t * vm,
581 vlib_node_runtime_t * node,
582 ip4_reass_main_t * rm,
583 u32 ** vec_drop_overlap,
584 ip4_reass_t * reass, u32 prev_range_bi,
587 vlib_buffer_t *discard_b = vlib_get_buffer (vm, discard_bi);
588 vnet_buffer_opaque_t *discard_vnb = vnet_buffer (discard_b);
589 if (~0 != prev_range_bi)
591 vlib_buffer_t *prev_b = vlib_get_buffer (vm, prev_range_bi);
592 vnet_buffer_opaque_t *prev_vnb = vnet_buffer (prev_b);
593 ASSERT (prev_vnb->ip.reass.next_range_bi == discard_bi);
594 prev_vnb->ip.reass.next_range_bi = discard_vnb->ip.reass.next_range_bi;
598 reass->first_bi = discard_vnb->ip.reass.next_range_bi;
600 reass->data_len -= ip4_reass_buffer_get_data_len (discard_b);
603 vec_add1 (*vec_drop_overlap, discard_bi);
604 if (PREDICT_FALSE (discard_b->flags & VLIB_BUFFER_IS_TRACED))
606 ip4_reass_add_trace (vm, node, rm, reass, discard_bi, RANGE_DISCARD,
609 if (discard_b->flags & VLIB_BUFFER_NEXT_PRESENT)
611 discard_b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
612 discard_bi = discard_b->next_buffer;
613 discard_b = vlib_get_buffer (vm, discard_bi);
623 ip4_reass_update (vlib_main_t * vm, vlib_node_runtime_t * node,
624 ip4_reass_main_t * rm, ip4_reass_t * reass, u32 * bi0,
625 u32 * next0, vlib_error_t * error0,
626 u32 ** vec_drop_overlap, u32 ** vec_drop_compress,
627 u32 next_input, u32 next_drop)
630 vlib_buffer_t *fb = vlib_get_buffer (vm, *bi0);
631 ip4_header_t *fip = vlib_buffer_get_current (fb);
632 ASSERT (fb->current_length >= sizeof (*fip));
633 vnet_buffer_opaque_t *fvnb = vnet_buffer (fb);
634 u32 fragment_first = fvnb->ip.reass.fragment_first =
635 ip4_get_fragment_offset_bytes (fip);
636 u32 fragment_length =
637 clib_net_to_host_u16 (fip->length) - ip4_header_bytes (fip);
638 u32 fragment_last = fvnb->ip.reass.fragment_last =
639 fragment_first + fragment_length - 1;
640 int more_fragments = ip4_get_fragment_more (fip);
641 u32 candidate_range_bi = reass->first_bi;
642 u32 prev_range_bi = ~0;
643 fvnb->ip.reass.range_first = fragment_first;
644 fvnb->ip.reass.range_last = fragment_last;
645 fvnb->ip.reass.next_range_bi = ~0;
648 reass->last_packet_octet = fragment_last;
650 if (~0 == reass->first_bi)
652 // starting a new reassembly
653 ip4_reass_insert_range_in_chain (vm, rm, reass, prev_range_bi, *bi0);
654 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
656 ip4_reass_add_trace (vm, node, rm, reass, *bi0, RANGE_NEW, 0);
659 fvnb->ip.reass.estimated_mtu = clib_net_to_host_u16 (fip->length);
662 fvnb->ip.reass.estimated_mtu = clib_min (clib_net_to_host_u16 (fip->length),
663 fvnb->ip.reass.estimated_mtu);
664 while (~0 != candidate_range_bi)
666 vlib_buffer_t *candidate_b = vlib_get_buffer (vm, candidate_range_bi);
667 vnet_buffer_opaque_t *candidate_vnb = vnet_buffer (candidate_b);
668 if (fragment_first > candidate_vnb->ip.reass.range_last)
670 // this fragments starts after candidate range
671 prev_range_bi = candidate_range_bi;
672 candidate_range_bi = candidate_vnb->ip.reass.next_range_bi;
673 if (candidate_vnb->ip.reass.range_last < fragment_last &&
674 ~0 == candidate_range_bi)
676 // special case - this fragment falls beyond all known ranges
677 ip4_reass_insert_range_in_chain (vm, rm, reass, prev_range_bi,
684 if (fragment_last < candidate_vnb->ip.reass.range_first)
686 // this fragment ends before candidate range without any overlap
687 ip4_reass_insert_range_in_chain (vm, rm, reass, prev_range_bi,
693 if (fragment_first >= candidate_vnb->ip.reass.range_first &&
694 fragment_last <= candidate_vnb->ip.reass.range_last)
696 // this fragment is a (sub)part of existing range, ignore it
697 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
699 ip4_reass_add_trace (vm, node, rm, reass, *bi0,
704 int discard_candidate = 0;
705 if (fragment_first < candidate_vnb->ip.reass.range_first)
708 fragment_last - candidate_vnb->ip.reass.range_first + 1;
709 if (overlap < ip4_reass_buffer_get_data_len (candidate_b))
711 candidate_vnb->ip.reass.range_first += overlap;
712 ASSERT (reass->data_len >= overlap);
713 reass->data_len -= overlap;
714 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
716 ip4_reass_add_trace (vm, node, rm, reass,
717 candidate_range_bi, RANGE_SHRINK,
720 ip4_reass_insert_range_in_chain (vm, rm, reass,
721 prev_range_bi, *bi0);
726 discard_candidate = 1;
729 else if (fragment_last > candidate_vnb->ip.reass.range_last)
732 candidate_vnb->ip.reass.range_last - fragment_first + 1;
733 if (overlap < ip4_reass_buffer_get_data_len (candidate_b))
735 fvnb->ip.reass.range_first += overlap;
736 if (~0 != candidate_vnb->ip.reass.next_range_bi)
738 prev_range_bi = candidate_range_bi;
740 candidate_vnb->ip.reass.next_range_bi;
745 // special case - last range discarded
746 ip4_reass_insert_range_in_chain (vm, rm, reass,
754 discard_candidate = 1;
759 discard_candidate = 1;
761 if (discard_candidate)
763 u32 next_range_bi = candidate_vnb->ip.reass.next_range_bi;
764 // discard candidate range, probe next range
765 ip4_reass_remove_range_from_chain (vm, node, rm,
766 vec_drop_overlap, reass,
769 if (~0 != next_range_bi)
771 candidate_range_bi = next_range_bi;
776 // special case - last range discarded
777 ip4_reass_insert_range_in_chain (vm, rm, reass,
778 prev_range_bi, *bi0);
787 if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
789 ip4_reass_add_trace (vm, node, rm, reass, *bi0, RANGE_NEW, 0);
792 if (~0 != reass->last_packet_octet &&
793 reass->data_len == reass->last_packet_octet + 1)
795 ip4_reass_finalize (vm, node, rm, reass, bi0, next0, error0, next_input,
796 vec_drop_compress, vec_drop_overlap);
807 *error0 = IP4_ERROR_REASS_DUPLICATE_FRAGMENT;
813 ip4_reassembly (vlib_main_t * vm, vlib_node_runtime_t * node,
814 vlib_frame_t * frame)
816 u32 *from = vlib_frame_vector_args (frame);
817 u32 n_left_from, n_left_to_next, *to_next, next_index;
818 ip4_reass_main_t *rm = &ip4_reass_main;
820 n_left_from = frame->n_vectors;
821 next_index = node->cached_next_index;
822 static u32 *vec_drop_timeout = NULL; // indexes of buffers which timed out
823 static u32 *vec_drop_overlap = NULL; // indexes of buffers which were discarded due to overlap
824 static u32 *vec_drop_compress = NULL; // indexes of buffers dicarded due to buffer compression
825 while (n_left_from > 0 || vec_len (vec_drop_timeout) > 0 ||
826 vec_len (vec_drop_overlap) > 0)
828 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
830 while (vec_len (vec_drop_timeout) > 0 && n_left_to_next > 0)
832 u32 bi = vec_pop (vec_drop_timeout);
833 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
834 b->error = node->errors[IP4_ERROR_REASS_TIMEOUT];
838 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
840 IP4_REASSEMBLY_NEXT_DROP);
841 IP4_REASS_DEBUG_BUFFER (bi, enqueue_drop_timeout);
842 ASSERT (rm->buffers_n > 0);
846 while (vec_len (vec_drop_overlap) > 0 && n_left_to_next > 0)
848 u32 bi = vec_pop (vec_drop_overlap);
849 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
850 b->error = node->errors[IP4_ERROR_REASS_DUPLICATE_FRAGMENT];
854 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
856 IP4_REASSEMBLY_NEXT_DROP);
857 IP4_REASS_DEBUG_BUFFER (bi, enqueue_drop_duplicate_fragment);
858 ASSERT (rm->buffers_n > 0);
862 while (vec_len (vec_drop_compress) > 0 && n_left_to_next > 0)
864 u32 bi = vec_pop (vec_drop_compress);
865 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
866 b->error = node->errors[IP4_ERROR_NONE];
870 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
872 IP4_REASSEMBLY_NEXT_DROP);
873 IP4_REASS_DEBUG_BUFFER (bi, enqueue_drop_compress);
874 ASSERT (rm->buffers_n > 0);
878 while (n_left_from > 0 && n_left_to_next > 0)
882 u32 next0; //, error0;
885 b0 = vlib_get_buffer (vm, bi0);
887 ip4_header_t *ip0 = vlib_buffer_get_current (b0);
889 k.src.as_u32 = ip0->src_address.as_u32;
890 k.dst.as_u32 = ip0->dst_address.as_u32;
891 k.xx_id = vnet_buffer (b0)->sw_if_index[VLIB_RX];
892 k.frag_id = ip0->fragment_id;
893 k.proto = ip0->protocol;
896 ip4_reass_find_or_create (vm, rm, &k, &vec_drop_timeout);
898 u32 error0 = IP4_ERROR_NONE;
901 ip4_reass_update (vm, node, rm, reass, &bi0, &next0, &error0,
902 &vec_drop_overlap, &vec_drop_compress,
903 IP4_REASSEMBLY_NEXT_INPUT,
904 IP4_REASSEMBLY_NEXT_DROP);
908 next0 = IP4_REASSEMBLY_NEXT_DROP;
909 error0 = IP4_ERROR_REASS_LIMIT_REACHED;
912 b0->error = node->errors[error0];
919 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
920 n_left_to_next, bi0, next0);
921 IP4_REASS_DEBUG_BUFFER (bi0, enqueue_next);
928 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
931 return frame->n_vectors;
934 static char *ip4_reassembly_error_strings[] = {
935 #define _(sym, string) string,
941 VLIB_REGISTER_NODE (ip4_reass_node, static) = {
942 .function = ip4_reassembly,
943 .name = "ip4-reassembly",
944 .vector_size = sizeof (u32),
945 .format_trace = format_ip4_reass_trace,
946 .n_errors = ARRAY_LEN (ip4_reassembly_error_strings),
947 .error_strings = ip4_reassembly_error_strings,
948 .n_next_nodes = IP4_REASSEMBLY_N_NEXT,
951 [IP4_REASSEMBLY_NEXT_INPUT] = "ip4-input",
952 [IP4_REASSEMBLY_NEXT_DROP] = "ip4-drop",
957 VLIB_NODE_FUNCTION_MULTIARCH (ip4_reass_node, ip4_reassembly)
958 static u32 ip4_reass_get_nbuckets ()
960 ip4_reass_main_t *rm = &ip4_reass_main;
964 nbuckets = (u32) (rm->max_reass_n / IP4_REASS_HT_LOAD_FACTOR);
966 for (i = 0; i < 31; i++)
967 if ((1 << i) >= nbuckets)
976 IP4_EVENT_CONFIG_CHANGED = 1,
982 clib_bihash_24_8_t *new_hash;
986 ip4_rehash_cb (clib_bihash_kv_24_8_t * kv, void *_ctx)
988 ip4_rehash_cb_ctx *ctx = _ctx;
989 if (clib_bihash_add_del_24_8 (ctx->new_hash, kv, 1))
996 ip4_reass_set (u32 timeout_ms, u32 max_reassemblies,
997 u32 expire_walk_interval_ms)
999 u32 old_nbuckets = ip4_reass_get_nbuckets ();
1000 ip4_reass_main.timeout_ms = timeout_ms;
1001 ip4_reass_main.timeout = (f64) timeout_ms / (f64) MSEC_PER_SEC;
1002 ip4_reass_main.max_reass_n = max_reassemblies;
1003 ip4_reass_main.expire_walk_interval_ms = expire_walk_interval_ms;
1005 vlib_process_signal_event (ip4_reass_main.vlib_main,
1006 ip4_reass_main.ip4_reass_expire_node_idx,
1007 IP4_EVENT_CONFIG_CHANGED, 0);
1008 u32 new_nbuckets = ip4_reass_get_nbuckets ();
1009 if (ip4_reass_main.max_reass_n > 0 && new_nbuckets > 1 &&
1010 new_nbuckets != old_nbuckets)
1012 clib_bihash_24_8_t new_hash;
1013 memset (&new_hash, 0, sizeof (new_hash));
1014 ip4_rehash_cb_ctx ctx;
1016 ctx.new_hash = &new_hash;
1017 clib_bihash_init_24_8 (&new_hash, "ip4-reass", new_nbuckets,
1018 new_nbuckets * 1024);
1019 clib_bihash_foreach_key_value_pair_24_8 (&ip4_reass_main.hash,
1020 ip4_rehash_cb, &ctx);
1023 clib_bihash_free_24_8 (&new_hash);
1028 clib_bihash_free_24_8 (&ip4_reass_main.hash);
1029 clib_memcpy (&ip4_reass_main.hash, &new_hash,
1030 sizeof (ip4_reass_main.hash));
1037 ip4_reass_get (u32 * timeout_ms, u32 * max_reassemblies,
1038 u32 * expire_walk_interval_ms)
1040 *timeout_ms = ip4_reass_main.timeout_ms;
1041 *max_reassemblies = ip4_reass_main.max_reass_n;
1042 *expire_walk_interval_ms = ip4_reass_main.expire_walk_interval_ms;
1047 ip4_reass_init_function (vlib_main_t * vm)
1049 ip4_reass_main_t *rm = &ip4_reass_main;
1050 clib_error_t *error = 0;
1055 rm->vnet_main = vnet_get_main ();
1058 pool_alloc (rm->pool, rm->max_reass_n);
1060 node = vlib_get_node_by_name (vm, (u8 *) "ip4-reassembly-expire-walk");
1062 rm->ip4_reass_expire_node_idx = node->index;
1064 ip4_reass_set (IP4_REASS_TIMEOUT_DEFAULT_MS,
1065 IP4_REASS_MAX_REASSEMBLIES_DEAFULT,
1066 IP4_REASS_EXPIRE_WALK_INTERVAL_DEFAULT_MS);
1068 nbuckets = ip4_reass_get_nbuckets ();
1069 clib_bihash_init_24_8 (&rm->hash, "ip4-reass", nbuckets, nbuckets * 1024);
1071 node = vlib_get_node_by_name (vm, (u8 *) "ip4-drop");
1073 rm->ip4_drop_idx = node->index;
1077 VLIB_INIT_FUNCTION (ip4_reass_init_function);
1080 ip4_reass_walk_expired (vlib_main_t * vm,
1081 vlib_node_runtime_t * node, vlib_frame_t * f)
1083 ip4_reass_main_t *rm = &ip4_reass_main;
1084 uword event_type, *event_data = 0;
1088 vlib_process_wait_for_event_or_clock (vm,
1089 (f64) rm->expire_walk_interval_ms
1090 / (f64) MSEC_PER_SEC);
1091 event_type = vlib_process_get_events (vm, &event_data);
1095 case ~0: /* no events => timeout */
1096 /* nothing to do here */
1098 case IP4_EVENT_CONFIG_CHANGED:
1101 clib_warning ("BUG: event type 0x%wx", event_type);
1104 f64 now = vlib_time_now (vm);
1107 u32 *vec_drop_timeout = NULL;
1108 int *pool_indexes_to_free = NULL;
1112 pool_foreach_index (index, rm->pool, ({
1113 reass = pool_elt_at_index (rm->pool, index);
1114 if (now > reass->last_heard + rm->timeout)
1116 vec_add1 (pool_indexes_to_free, index);
1122 vec_foreach (i, pool_indexes_to_free)
1124 ip4_reass_t *reass = pool_elt_at_index (rm->pool, i[0]);
1125 ip4_reass_on_timeout (vm, rm, reass, &vec_drop_timeout);
1126 ip4_reass_free (rm, reass);
1130 while (vec_len (vec_drop_timeout) > 0)
1132 vlib_frame_t *f = vlib_get_frame_to_node (vm, rm->ip4_drop_idx);
1133 u32 *to_next = vlib_frame_vector_args (f);
1134 u32 n_left_to_next = VLIB_FRAME_SIZE - f->n_vectors;
1136 while (vec_len (vec_drop_timeout) > 0 && n_left_to_next > 0)
1138 u32 bi = vec_pop (vec_drop_timeout);
1139 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
1140 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
1142 if (pool_is_free_index (vm->trace_main.trace_buffer_pool,
1145 /* the trace is gone, don't trace this buffer anymore */
1146 b->flags &= ~VLIB_BUFFER_IS_TRACED;
1153 b->error = node->errors[IP4_ERROR_REASS_TIMEOUT];
1157 n_left_to_next -= 1;
1158 IP4_REASS_DEBUG_BUFFER (bi, enqueue_drop_timeout_walk);
1159 ASSERT (rm->buffers_n > 0);
1162 if (PREDICT_FALSE (n_trace > 0))
1164 f->flags |= VLIB_FRAME_TRACE;
1166 vlib_put_frame_to_node (vm, rm->ip4_drop_idx, f);
1169 vec_free (pool_indexes_to_free);
1170 vec_free (vec_drop_timeout);
1173 _vec_len (event_data) = 0;
1180 static vlib_node_registration_t ip4_reass_expire_node;
1183 VLIB_REGISTER_NODE (ip4_reass_expire_node, static) = {
1184 .function = ip4_reass_walk_expired,
1185 .type = VLIB_NODE_TYPE_PROCESS,
1186 .name = "ip4-reassembly-expire-walk",
1187 .format_trace = format_ip4_reass_trace,
1188 .n_errors = ARRAY_LEN (ip4_reassembly_error_strings),
1189 .error_strings = ip4_reassembly_error_strings,
1195 format_ip4_reass_key (u8 * s, va_list * args)
1197 ip4_reass_key_t *key = va_arg (*args, ip4_reass_key_t *);
1198 s = format (s, "xx_id: %u, src: %U, dst: %U, frag_id: %u, proto: %u",
1199 key->xx_id, format_ip4_address, &key->src, format_ip4_address,
1200 &key->dst, clib_net_to_host_u16 (key->frag_id), key->proto);
1205 format_ip4_reass (u8 * s, va_list * args)
1207 vlib_main_t *vm = va_arg (*args, vlib_main_t *);
1208 ip4_reass_t *reass = va_arg (*args, ip4_reass_t *);
1210 s = format (s, "ID: %u, key: %U\n first_bi: %u, data_len: %u, "
1211 "last_packet_octet: %u, trace_op_counter: %u\n",
1212 reass->id, format_ip4_reass_key, &reass->key, reass->first_bi,
1213 reass->data_len, reass->last_packet_octet,
1214 reass->trace_op_counter);
1215 u32 bi = reass->first_bi;
1219 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
1220 vnet_buffer_opaque_t *vnb = vnet_buffer (b);
1221 s = format (s, " #%03u: range: [%u, %u], bi: %u, off: %d, len: %u, "
1222 "fragment[%u, %u]\n",
1223 counter, vnb->ip.reass.range_first,
1224 vnb->ip.reass.range_last, bi,
1225 ip4_reass_buffer_get_data_offset_no_check (b),
1226 ip4_reass_buffer_get_data_len_no_check (b),
1227 vnb->ip.reass.fragment_first, vnb->ip.reass.fragment_last);
1228 if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
1230 bi = b->next_buffer;
1240 static clib_error_t *
1241 show_ip4_reass (vlib_main_t * vm, unformat_input_t * input,
1242 CLIB_UNUSED (vlib_cli_command_t * lmd))
1244 ip4_reass_main_t *rm = &ip4_reass_main;
1246 vlib_cli_output (vm, "---------------------");
1247 vlib_cli_output (vm, "IP4 reassembly status");
1248 vlib_cli_output (vm, "---------------------");
1249 if (unformat (input, "details"))
1253 pool_foreach (reass, rm->pool, {
1254 vlib_cli_output (vm, "%U", format_ip4_reass, vm, reass);
1258 vlib_cli_output (vm, "---------------------");
1259 vlib_cli_output (vm, "Current IP4 reassemblies count: %lu\n", rm->reass_n);
1260 vlib_cli_output (vm,
1261 "Maximum configured concurrent IP4 reassemblies: %lu\n",
1262 (long unsigned) rm->max_reass_n);
1263 vlib_cli_output (vm, "Buffers in use: %lu\n",
1264 (long unsigned) rm->buffers_n);
1269 VLIB_CLI_COMMAND (show_ip4_reassembly_cmd, static) = {
1270 .path = "show ip4-reassembly",
1271 .short_help = "show ip4-reassembly [details]",
1272 .function = show_ip4_reass,
1277 * fd.io coding-style-patch-verification: ON
1280 * eval: (c-set-style "gnu")