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 Shallow Virtual Reassembly.
20 * This file contains the source code for IPv4 Shallow Virtual reassembly.
23 #include <vppinfra/vec.h>
24 #include <vnet/vnet.h>
25 #include <vnet/ip/ip.h>
26 #include <vnet/ip/ip4_to_ip6.h>
27 #include <vppinfra/fifo.h>
28 #include <vppinfra/bihash_16_8.h>
29 #include <vnet/ip/reass/ip4_sv_reass.h>
31 #define MSEC_PER_SEC 1000
32 #define IP4_SV_REASS_TIMEOUT_DEFAULT_MS 100
33 #define IP4_SV_REASS_EXPIRE_WALK_INTERVAL_DEFAULT_MS 10000 // 10 seconds default
34 #define IP4_SV_REASS_MAX_REASSEMBLIES_DEFAULT 1024
35 #define IP4_SV_REASS_MAX_REASSEMBLY_LENGTH_DEFAULT 3
36 #define IP4_SV_REASS_HT_LOAD_FACTOR (0.75)
41 IP4_SV_REASS_RC_TOO_MANY_FRAGMENTS,
42 IP4_SV_REASS_RC_UNSUPP_IP_PROTO,
79 clib_bihash_kv_16_8_t kv;
85 ip4_sv_reass_key_t key;
86 // time when last packet was received
88 // internal id of this reassembly
90 // trace operation counter
92 // minimum fragment length for this reassembly - used to estimate MTU
93 u16 min_fragment_length;
94 // buffer indexes of buffers in this reassembly in chronological order -
95 // including overlaps and duplicate fragments
97 // set to true when this reassembly is completed
101 u8 icmp_type_or_tcp_flags;
116 ip4_sv_reass_t *pool;
119 clib_spinlock_t lock;
124 } ip4_sv_reass_per_thread_t;
131 u32 expire_walk_interval_ms;
132 // maximum number of fragments in one reassembly
134 // maximum number of reassemblies
138 clib_bihash_16_8_t hash;
140 ip4_sv_reass_per_thread_t *per_thread_data;
143 vlib_main_t *vlib_main;
144 vnet_main_t *vnet_main;
146 // node index of ip4-drop node
148 u32 ip4_sv_reass_expire_node_idx;
150 /** Worker handoff */
152 u32 fq_feature_index;
154 // reference count for enabling/disabling feature - per interface
155 u32 *feature_use_refcount_per_intf;
157 // reference count for enabling/disabling feature - per interface
158 u32 *output_feature_use_refcount_per_intf;
160 } ip4_sv_reass_main_t;
162 extern ip4_sv_reass_main_t ip4_sv_reass_main;
164 #ifndef CLIB_MARCH_VARIANT
165 ip4_sv_reass_main_t ip4_sv_reass_main;
166 #endif /* CLIB_MARCH_VARIANT */
170 IP4_SV_REASSEMBLY_NEXT_INPUT,
171 IP4_SV_REASSEMBLY_NEXT_DROP,
172 IP4_SV_REASSEMBLY_NEXT_HANDOFF,
173 IP4_SV_REASSEMBLY_N_NEXT,
174 } ip4_sv_reass_next_t;
178 REASS_FRAGMENT_CACHE,
180 REASS_FRAGMENT_FORWARD,
182 } ip4_sv_reass_trace_operation_e;
186 ip4_sv_reass_trace_operation_e action;
192 } ip4_sv_reass_trace_t;
194 extern vlib_node_registration_t ip4_sv_reass_node;
195 extern vlib_node_registration_t ip4_sv_reass_node_feature;
198 format_ip4_sv_reass_trace (u8 * s, va_list * args)
200 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
201 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
202 ip4_sv_reass_trace_t *t = va_arg (*args, ip4_sv_reass_trace_t *);
203 if (REASS_PASSTHROUGH != t->action)
205 s = format (s, "reass id: %u, op id: %u ", t->reass_id, t->op_id);
209 case REASS_FRAGMENT_CACHE:
210 s = format (s, "[cached]");
214 format (s, "[finish, ip proto=%u, src_port=%u, dst_port=%u]",
215 t->ip_proto, clib_net_to_host_u16 (t->l4_src_port),
216 clib_net_to_host_u16 (t->l4_dst_port));
218 case REASS_FRAGMENT_FORWARD:
220 format (s, "[forward, ip proto=%u, src_port=%u, dst_port=%u]",
221 t->ip_proto, clib_net_to_host_u16 (t->l4_src_port),
222 clib_net_to_host_u16 (t->l4_dst_port));
224 case REASS_PASSTHROUGH:
225 s = format (s, "[not-fragmented]");
232 ip4_sv_reass_add_trace (vlib_main_t * vm, vlib_node_runtime_t * node,
233 ip4_sv_reass_main_t * rm, ip4_sv_reass_t * reass,
234 u32 bi, ip4_sv_reass_trace_operation_e action,
235 u32 ip_proto, u16 l4_src_port, u16 l4_dst_port)
237 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
238 ip4_sv_reass_trace_t *t = vlib_add_trace (vm, node, b, sizeof (t[0]));
241 t->reass_id = reass->id;
242 t->op_id = reass->trace_op_counter;
243 ++reass->trace_op_counter;
246 t->ip_proto = ip_proto;
247 t->l4_src_port = l4_src_port;
248 t->l4_dst_port = l4_dst_port;
251 s = format (s, "%U", format_ip4_sv_reass_trace, NULL, NULL, t);
252 printf ("%.*s\n", vec_len (s), s);
254 vec_reset_length (s);
260 ip4_sv_reass_free (vlib_main_t * vm, ip4_sv_reass_main_t * rm,
261 ip4_sv_reass_per_thread_t * rt, ip4_sv_reass_t * reass)
263 clib_bihash_kv_16_8_t kv;
264 kv.key[0] = reass->key.as_u64[0];
265 kv.key[1] = reass->key.as_u64[1];
266 clib_bihash_add_del_16_8 (&rm->hash, &kv, 0);
267 vlib_buffer_free (vm, reass->cached_buffers,
268 vec_len (reass->cached_buffers));
269 vec_free (reass->cached_buffers);
270 reass->cached_buffers = NULL;
271 if (~0 != reass->lru_prev)
273 ip4_sv_reass_t *lru_prev =
274 pool_elt_at_index (rt->pool, reass->lru_prev);
275 lru_prev->lru_next = reass->lru_next;
277 if (~0 != reass->lru_next)
279 ip4_sv_reass_t *lru_next =
280 pool_elt_at_index (rt->pool, reass->lru_next);
281 lru_next->lru_prev = reass->lru_prev;
283 if (rt->lru_first == reass - rt->pool)
285 rt->lru_first = reass->lru_next;
287 if (rt->lru_last == reass - rt->pool)
289 rt->lru_last = reass->lru_prev;
291 pool_put (rt->pool, reass);
296 ip4_sv_reass_init (ip4_sv_reass_t * reass)
298 reass->cached_buffers = NULL;
299 reass->is_complete = false;
302 always_inline ip4_sv_reass_t *
303 ip4_sv_reass_find_or_create (vlib_main_t * vm, ip4_sv_reass_main_t * rm,
304 ip4_sv_reass_per_thread_t * rt,
305 ip4_sv_reass_kv_t * kv, u8 * do_handoff)
307 ip4_sv_reass_t *reass = NULL;
308 f64 now = vlib_time_now (vm);
310 if (!clib_bihash_search_16_8 (&rm->hash, &kv->kv, &kv->kv))
312 if (vm->thread_index != kv->v.thread_index)
317 reass = pool_elt_at_index (rt->pool, kv->v.reass_index);
319 if (now > reass->last_heard + rm->timeout)
321 ip4_sv_reass_free (vm, rm, rt, reass);
328 reass->last_heard = now;
332 if (rt->reass_n >= rm->max_reass_n && rm->max_reass_n)
334 reass = pool_elt_at_index (rt->pool, rt->lru_last);
335 ip4_sv_reass_free (vm, rm, rt, reass);
338 pool_get (rt->pool, reass);
339 clib_memset (reass, 0, sizeof (*reass));
340 reass->id = ((u64) vm->thread_index * 1000000000) + rt->id_counter;
342 ip4_sv_reass_init (reass);
344 reass->lru_prev = reass->lru_next = ~0;
346 if (~0 != rt->lru_last)
348 ip4_sv_reass_t *lru_last = pool_elt_at_index (rt->pool, rt->lru_last);
349 reass->lru_prev = rt->lru_last;
350 lru_last->lru_next = rt->lru_last = reass - rt->pool;
353 if (~0 == rt->lru_first)
355 rt->lru_first = rt->lru_last = reass - rt->pool;
358 reass->key.as_u64[0] = kv->kv.key[0];
359 reass->key.as_u64[1] = kv->kv.key[1];
360 kv->v.reass_index = (reass - rt->pool);
361 kv->v.thread_index = vm->thread_index;
362 reass->last_heard = now;
364 if (clib_bihash_add_del_16_8 (&rm->hash, &kv->kv, 1))
366 ip4_sv_reass_free (vm, rm, rt, reass);
373 always_inline ip4_sv_reass_rc_t
374 ip4_sv_reass_update (vlib_main_t * vm, vlib_node_runtime_t * node,
375 ip4_sv_reass_main_t * rm, ip4_sv_reass_per_thread_t * rt,
376 ip4_header_t * ip0, ip4_sv_reass_t * reass, u32 bi0)
378 vlib_buffer_t *b0 = vlib_get_buffer (vm, bi0);
379 ip4_sv_reass_rc_t rc = IP4_SV_REASS_RC_OK;
380 const u32 fragment_first = ip4_get_fragment_offset_bytes (ip0);
381 if (0 == fragment_first)
383 reass->ip_proto = ip0->protocol;
384 reass->l4_src_port = ip4_get_port (ip0, 1);
385 reass->l4_dst_port = ip4_get_port (ip0, 0);
386 if (!reass->l4_src_port || !reass->l4_dst_port)
387 return IP4_SV_REASS_RC_UNSUPP_IP_PROTO;
388 if (IP_PROTOCOL_TCP == reass->ip_proto)
390 reass->icmp_type_or_tcp_flags = ((tcp_header_t *) (ip0 + 1))->flags;
391 reass->tcp_ack_number = ((tcp_header_t *) (ip0 + 1))->ack_number;
392 reass->tcp_seq_number = ((tcp_header_t *) (ip0 + 1))->seq_number;
394 else if (IP_PROTOCOL_ICMP == reass->ip_proto)
396 reass->icmp_type_or_tcp_flags =
397 ((icmp46_header_t *) (ip0 + 1))->type;
399 reass->is_complete = true;
400 vlib_buffer_t *b0 = vlib_get_buffer (vm, bi0);
401 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
403 ip4_sv_reass_add_trace (vm, node, rm, reass, bi0, REASS_FINISH,
404 reass->ip_proto, reass->l4_src_port,
408 vec_add1 (reass->cached_buffers, bi0);
409 if (!reass->is_complete)
411 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
413 ip4_sv_reass_add_trace (vm, node, rm, reass, bi0,
414 REASS_FRAGMENT_CACHE, ~0, ~0, ~0);
416 if (vec_len (reass->cached_buffers) > rm->max_reass_len)
418 rc = IP4_SV_REASS_RC_TOO_MANY_FRAGMENTS;
425 ip4_sv_reass_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
426 vlib_frame_t * frame, bool is_feature,
427 bool is_output_feature, bool is_custom)
429 u32 *from = vlib_frame_vector_args (frame);
430 u32 n_left_from, n_left_to_next, *to_next, next_index;
431 ip4_sv_reass_main_t *rm = &ip4_sv_reass_main;
432 ip4_sv_reass_per_thread_t *rt = &rm->per_thread_data[vm->thread_index];
433 clib_spinlock_lock (&rt->lock);
435 n_left_from = frame->n_vectors;
436 next_index = node->cached_next_index;
438 while (n_left_from > 0)
440 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
442 while (n_left_from > 0 && n_left_to_next > 0)
447 u32 error0 = IP4_ERROR_NONE;
450 b0 = vlib_get_buffer (vm, bi0);
453 (ip4_header_t *) u8_ptr_add (vlib_buffer_get_current (b0),
454 (is_output_feature ? 1 : 0) *
456 ip.save_rewrite_length);
457 if (!ip4_get_fragment_more (ip0) && !ip4_get_fragment_offset (ip0))
459 // this is a regular packet - no fragmentation
462 next0 = vnet_buffer (b0)->ip.reass.next_index;
466 next0 = IP4_SV_REASSEMBLY_NEXT_INPUT;
468 vnet_buffer (b0)->ip.reass.is_non_first_fragment = 0;
469 vnet_buffer (b0)->ip.reass.ip_proto = ip0->protocol;
470 if (IP_PROTOCOL_TCP == ip0->protocol)
472 vnet_buffer (b0)->ip.reass.icmp_type_or_tcp_flags =
473 ((tcp_header_t *) (ip0 + 1))->flags;
474 vnet_buffer (b0)->ip.reass.tcp_ack_number =
475 ((tcp_header_t *) (ip0 + 1))->ack_number;
476 vnet_buffer (b0)->ip.reass.tcp_seq_number =
477 ((tcp_header_t *) (ip0 + 1))->seq_number;
479 else if (IP_PROTOCOL_ICMP == ip0->protocol)
481 vnet_buffer (b0)->ip.reass.icmp_type_or_tcp_flags =
482 ((icmp46_header_t *) (ip0 + 1))->type;
484 vnet_buffer (b0)->ip.reass.l4_src_port = ip4_get_port (ip0, 1);
485 vnet_buffer (b0)->ip.reass.l4_dst_port = ip4_get_port (ip0, 0);
486 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
488 ip4_sv_reass_add_trace (vm, node, rm, NULL, bi0,
490 vnet_buffer (b0)->ip.reass.ip_proto,
491 vnet_buffer (b0)->ip.
493 vnet_buffer (b0)->ip.
498 const u32 fragment_first = ip4_get_fragment_offset_bytes (ip0);
499 const u32 fragment_length =
500 clib_net_to_host_u16 (ip0->length) - ip4_header_bytes (ip0);
501 const u32 fragment_last = fragment_first + fragment_length - 1;
502 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
504 next0 = IP4_SV_REASSEMBLY_NEXT_DROP;
505 error0 = IP4_ERROR_REASS_MALFORMED_PACKET;
506 b0->error = node->errors[error0];
509 ip4_sv_reass_kv_t kv;
513 (u64) vec_elt (ip4_main.fib_index_by_sw_if_index,
514 vnet_buffer (b0)->sw_if_index[VLIB_RX]) |
515 (u64) ip0->src_address.as_u32 << 32;
517 (u64) ip0->dst_address.
518 as_u32 | (u64) ip0->fragment_id << 32 | (u64) ip0->protocol << 48;
520 ip4_sv_reass_t *reass =
521 ip4_sv_reass_find_or_create (vm, rm, rt, &kv, &do_handoff);
523 if (PREDICT_FALSE (do_handoff))
525 next0 = IP4_SV_REASSEMBLY_NEXT_HANDOFF;
526 vnet_buffer (b0)->ip.reass.owner_thread_index =
533 next0 = IP4_SV_REASSEMBLY_NEXT_DROP;
534 error0 = IP4_ERROR_REASS_LIMIT_REACHED;
535 b0->error = node->errors[error0];
539 if (reass->is_complete)
543 next0 = vnet_buffer (b0)->ip.reass.next_index;
547 next0 = IP4_SV_REASSEMBLY_NEXT_INPUT;
549 vnet_buffer (b0)->ip.reass.is_non_first_fragment =
551 vnet_buffer (b0)->ip.reass.ip_proto = reass->ip_proto;
552 vnet_buffer (b0)->ip.reass.icmp_type_or_tcp_flags =
553 reass->icmp_type_or_tcp_flags;
554 vnet_buffer (b0)->ip.reass.tcp_ack_number =
555 reass->tcp_ack_number;
556 vnet_buffer (b0)->ip.reass.tcp_seq_number =
557 reass->tcp_seq_number;
558 vnet_buffer (b0)->ip.reass.l4_src_port = reass->l4_src_port;
559 vnet_buffer (b0)->ip.reass.l4_dst_port = reass->l4_dst_port;
560 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
562 ip4_sv_reass_add_trace (vm, node, rm, reass, bi0,
563 REASS_FRAGMENT_FORWARD,
571 ip4_sv_reass_rc_t rc =
572 ip4_sv_reass_update (vm, node, rm, rt, ip0, reass, bi0);
575 case IP4_SV_REASS_RC_OK:
576 /* nothing to do here */
578 case IP4_SV_REASS_RC_TOO_MANY_FRAGMENTS:
579 vlib_node_increment_counter (vm, node->node_index,
580 IP4_ERROR_REASS_FRAGMENT_CHAIN_TOO_LONG,
582 ip4_sv_reass_free (vm, rm, rt, reass);
585 case IP4_SV_REASS_RC_UNSUPP_IP_PROTO:
586 vlib_node_increment_counter (vm, node->node_index,
587 IP4_ERROR_REASS_FRAGMENT_CHAIN_TOO_LONG,
589 ip4_sv_reass_free (vm, rm, rt, reass);
593 if (reass->is_complete)
596 vec_foreach_index (idx, reass->cached_buffers)
598 u32 bi0 = vec_elt (reass->cached_buffers, idx);
599 vlib_buffer_t *b0 = vlib_get_buffer (vm, bi0);
601 (ip4_header_t *) u8_ptr_add (vlib_buffer_get_current (b0),
602 (is_output_feature ? 1 : 0) *
604 ip.save_rewrite_length);
605 u32 next0 = IP4_SV_REASSEMBLY_NEXT_INPUT;
608 vnet_feature_next (&next0, b0);
612 next0 = vnet_buffer (b0)->ip.reass.next_index;
614 if (0 == n_left_to_next)
616 vlib_put_next_frame (vm, node, next_index,
618 vlib_get_next_frame (vm, node, next_index, to_next,
624 vnet_buffer (b0)->ip.reass.is_non_first_fragment =
625 ! !ip4_get_fragment_offset (ip0);
626 vnet_buffer (b0)->ip.reass.ip_proto = reass->ip_proto;
627 vnet_buffer (b0)->ip.reass.icmp_type_or_tcp_flags =
628 reass->icmp_type_or_tcp_flags;
629 vnet_buffer (b0)->ip.reass.tcp_ack_number =
630 reass->tcp_ack_number;
631 vnet_buffer (b0)->ip.reass.tcp_seq_number =
632 reass->tcp_seq_number;
633 vnet_buffer (b0)->ip.reass.l4_src_port = reass->l4_src_port;
634 vnet_buffer (b0)->ip.reass.l4_dst_port = reass->l4_dst_port;
635 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
637 ip4_sv_reass_add_trace (vm, node, rm, reass, bi0,
638 REASS_FRAGMENT_FORWARD,
643 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
644 to_next, n_left_to_next, bi0,
647 _vec_len (reass->cached_buffers) = 0; // buffers are owned by frame now
655 if (is_feature && IP4_ERROR_NONE == error0)
657 b0 = vlib_get_buffer (vm, bi0);
658 vnet_feature_next (&next0, b0);
660 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
661 to_next, n_left_to_next,
669 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
672 clib_spinlock_unlock (&rt->lock);
673 return frame->n_vectors;
676 static char *ip4_sv_reass_error_strings[] = {
677 #define _(sym, string) string,
682 VLIB_NODE_FN (ip4_sv_reass_node) (vlib_main_t * vm,
683 vlib_node_runtime_t * node,
684 vlib_frame_t * frame)
686 return ip4_sv_reass_inline (vm, node, frame, false /* is_feature */ ,
687 false /* is_output_feature */ ,
688 false /* is_custom */ );
692 VLIB_REGISTER_NODE (ip4_sv_reass_node) = {
693 .name = "ip4-sv-reassembly",
694 .vector_size = sizeof (u32),
695 .format_trace = format_ip4_sv_reass_trace,
696 .n_errors = ARRAY_LEN (ip4_sv_reass_error_strings),
697 .error_strings = ip4_sv_reass_error_strings,
698 .n_next_nodes = IP4_SV_REASSEMBLY_N_NEXT,
701 [IP4_SV_REASSEMBLY_NEXT_INPUT] = "ip4-input",
702 [IP4_SV_REASSEMBLY_NEXT_DROP] = "ip4-drop",
703 [IP4_SV_REASSEMBLY_NEXT_HANDOFF] = "ip4-sv-reassembly-handoff",
709 VLIB_NODE_FN (ip4_sv_reass_node_feature) (vlib_main_t * vm,
710 vlib_node_runtime_t * node,
711 vlib_frame_t * frame)
713 return ip4_sv_reass_inline (vm, node, frame, true /* is_feature */ ,
714 false /* is_output_feature */ ,
715 false /* is_custom */ );
719 VLIB_REGISTER_NODE (ip4_sv_reass_node_feature) = {
720 .name = "ip4-sv-reassembly-feature",
721 .vector_size = sizeof (u32),
722 .format_trace = format_ip4_sv_reass_trace,
723 .n_errors = ARRAY_LEN (ip4_sv_reass_error_strings),
724 .error_strings = ip4_sv_reass_error_strings,
725 .n_next_nodes = IP4_SV_REASSEMBLY_N_NEXT,
728 [IP4_SV_REASSEMBLY_NEXT_INPUT] = "ip4-input",
729 [IP4_SV_REASSEMBLY_NEXT_DROP] = "ip4-drop",
730 [IP4_SV_REASSEMBLY_NEXT_HANDOFF] = "ip4-sv-reass-feature-hoff",
736 VNET_FEATURE_INIT (ip4_sv_reass_feature) = {
737 .arc_name = "ip4-unicast",
738 .node_name = "ip4-sv-reassembly-feature",
739 .runs_before = VNET_FEATURES ("ip4-lookup"),
744 VLIB_NODE_FN (ip4_sv_reass_node_output_feature) (vlib_main_t * vm,
745 vlib_node_runtime_t * node,
746 vlib_frame_t * frame)
748 return ip4_sv_reass_inline (vm, node, frame, true /* is_feature */ ,
749 true /* is_output_feature */ ,
750 false /* is_custom */ );
755 VLIB_REGISTER_NODE (ip4_sv_reass_node_output_feature) = {
756 .name = "ip4-sv-reassembly-output-feature",
757 .vector_size = sizeof (u32),
758 .format_trace = format_ip4_sv_reass_trace,
759 .n_errors = ARRAY_LEN (ip4_sv_reass_error_strings),
760 .error_strings = ip4_sv_reass_error_strings,
761 .n_next_nodes = IP4_SV_REASSEMBLY_N_NEXT,
764 [IP4_SV_REASSEMBLY_NEXT_INPUT] = "ip4-input",
765 [IP4_SV_REASSEMBLY_NEXT_DROP] = "ip4-drop",
766 [IP4_SV_REASSEMBLY_NEXT_HANDOFF] = "ip4-sv-reass-feature-hoff",
772 VNET_FEATURE_INIT (ip4_sv_reass_output_feature) = {
773 .arc_name = "ip4-output",
774 .node_name = "ip4-sv-reassembly-output-feature",
781 VLIB_REGISTER_NODE (ip4_sv_reass_custom_node) = {
782 .name = "ip4-sv-reassembly-custom-next",
783 .vector_size = sizeof (u32),
784 .format_trace = format_ip4_sv_reass_trace,
785 .n_errors = ARRAY_LEN (ip4_sv_reass_error_strings),
786 .error_strings = ip4_sv_reass_error_strings,
787 .n_next_nodes = IP4_SV_REASSEMBLY_N_NEXT,
790 [IP4_SV_REASSEMBLY_NEXT_INPUT] = "ip4-input",
791 [IP4_SV_REASSEMBLY_NEXT_DROP] = "ip4-drop",
792 [IP4_SV_REASSEMBLY_NEXT_HANDOFF] = "ip4-sv-reassembly-handoff",
798 VLIB_NODE_FN (ip4_sv_reass_custom_node) (vlib_main_t * vm,
799 vlib_node_runtime_t * node,
800 vlib_frame_t * frame)
802 return ip4_sv_reass_inline (vm, node, frame, false /* is_feature */ ,
803 false /* is_output_feature */ ,
804 true /* is_custom */ );
807 #ifndef CLIB_MARCH_VARIANT
809 ip4_sv_reass_get_nbuckets ()
811 ip4_sv_reass_main_t *rm = &ip4_sv_reass_main;
815 nbuckets = (u32) (rm->max_reass_n / IP4_SV_REASS_HT_LOAD_FACTOR);
817 for (i = 0; i < 31; i++)
818 if ((1 << i) >= nbuckets)
824 #endif /* CLIB_MARCH_VARIANT */
828 IP4_EVENT_CONFIG_CHANGED = 1,
829 } ip4_sv_reass_event_t;
834 clib_bihash_16_8_t *new_hash;
837 #ifndef CLIB_MARCH_VARIANT
839 ip4_rehash_cb (clib_bihash_kv_16_8_t * kv, void *_ctx)
841 ip4_rehash_cb_ctx *ctx = _ctx;
842 if (clib_bihash_add_del_16_8 (ctx->new_hash, kv, 1))
846 return (BIHASH_WALK_CONTINUE);
850 ip4_sv_reass_set_params (u32 timeout_ms, u32 max_reassemblies,
851 u32 max_reassembly_length,
852 u32 expire_walk_interval_ms)
854 ip4_sv_reass_main.timeout_ms = timeout_ms;
855 ip4_sv_reass_main.timeout = (f64) timeout_ms / (f64) MSEC_PER_SEC;
856 ip4_sv_reass_main.max_reass_n = max_reassemblies;
857 ip4_sv_reass_main.max_reass_len = max_reassembly_length;
858 ip4_sv_reass_main.expire_walk_interval_ms = expire_walk_interval_ms;
862 ip4_sv_reass_set (u32 timeout_ms, u32 max_reassemblies,
863 u32 max_reassembly_length, u32 expire_walk_interval_ms)
865 u32 old_nbuckets = ip4_sv_reass_get_nbuckets ();
866 ip4_sv_reass_set_params (timeout_ms, max_reassemblies,
867 max_reassembly_length, expire_walk_interval_ms);
868 vlib_process_signal_event (ip4_sv_reass_main.vlib_main,
869 ip4_sv_reass_main.ip4_sv_reass_expire_node_idx,
870 IP4_EVENT_CONFIG_CHANGED, 0);
871 u32 new_nbuckets = ip4_sv_reass_get_nbuckets ();
872 if (ip4_sv_reass_main.max_reass_n > 0 && new_nbuckets > old_nbuckets)
874 clib_bihash_16_8_t new_hash;
875 clib_memset (&new_hash, 0, sizeof (new_hash));
876 ip4_rehash_cb_ctx ctx;
878 ctx.new_hash = &new_hash;
879 clib_bihash_init_16_8 (&new_hash, "ip4-dr", new_nbuckets,
880 new_nbuckets * 1024);
881 clib_bihash_foreach_key_value_pair_16_8 (&ip4_sv_reass_main.hash,
882 ip4_rehash_cb, &ctx);
885 clib_bihash_free_16_8 (&new_hash);
890 clib_bihash_free_16_8 (&ip4_sv_reass_main.hash);
891 clib_memcpy_fast (&ip4_sv_reass_main.hash, &new_hash,
892 sizeof (ip4_sv_reass_main.hash));
893 clib_bihash_copied (&ip4_sv_reass_main.hash, &new_hash);
900 ip4_sv_reass_get (u32 * timeout_ms, u32 * max_reassemblies,
901 u32 * max_reassembly_length, u32 * expire_walk_interval_ms)
903 *timeout_ms = ip4_sv_reass_main.timeout_ms;
904 *max_reassemblies = ip4_sv_reass_main.max_reass_n;
905 *max_reassembly_length = ip4_sv_reass_main.max_reass_len;
906 *expire_walk_interval_ms = ip4_sv_reass_main.expire_walk_interval_ms;
910 static clib_error_t *
911 ip4_sv_reass_init_function (vlib_main_t * vm)
913 ip4_sv_reass_main_t *rm = &ip4_sv_reass_main;
914 clib_error_t *error = 0;
919 rm->vnet_main = vnet_get_main ();
921 vec_validate (rm->per_thread_data, vlib_num_workers ());
922 ip4_sv_reass_per_thread_t *rt;
923 vec_foreach (rt, rm->per_thread_data)
925 clib_spinlock_init (&rt->lock);
926 pool_alloc (rt->pool, rm->max_reass_n);
927 rt->lru_first = rt->lru_last = ~0;
930 node = vlib_get_node_by_name (vm, (u8 *) "ip4-sv-reassembly-expire-walk");
932 rm->ip4_sv_reass_expire_node_idx = node->index;
934 ip4_sv_reass_set_params (IP4_SV_REASS_TIMEOUT_DEFAULT_MS,
935 IP4_SV_REASS_MAX_REASSEMBLIES_DEFAULT,
936 IP4_SV_REASS_MAX_REASSEMBLY_LENGTH_DEFAULT,
937 IP4_SV_REASS_EXPIRE_WALK_INTERVAL_DEFAULT_MS);
939 nbuckets = ip4_sv_reass_get_nbuckets ();
940 clib_bihash_init_16_8 (&rm->hash, "ip4-dr", nbuckets, nbuckets * 1024);
942 node = vlib_get_node_by_name (vm, (u8 *) "ip4-drop");
944 rm->ip4_drop_idx = node->index;
946 rm->fq_index = vlib_frame_queue_main_init (ip4_sv_reass_node.index, 0);
947 rm->fq_feature_index =
948 vlib_frame_queue_main_init (ip4_sv_reass_node_feature.index, 0);
950 rm->feature_use_refcount_per_intf = NULL;
951 rm->output_feature_use_refcount_per_intf = NULL;
956 VLIB_INIT_FUNCTION (ip4_sv_reass_init_function);
957 #endif /* CLIB_MARCH_VARIANT */
960 ip4_sv_reass_walk_expired (vlib_main_t * vm,
961 vlib_node_runtime_t * node, vlib_frame_t * f)
963 ip4_sv_reass_main_t *rm = &ip4_sv_reass_main;
964 uword event_type, *event_data = 0;
968 vlib_process_wait_for_event_or_clock (vm,
970 rm->expire_walk_interval_ms /
972 event_type = vlib_process_get_events (vm, &event_data);
976 case ~0: /* no events => timeout */
977 /* nothing to do here */
979 case IP4_EVENT_CONFIG_CHANGED:
982 clib_warning ("BUG: event type 0x%wx", event_type);
985 f64 now = vlib_time_now (vm);
987 ip4_sv_reass_t *reass;
988 int *pool_indexes_to_free = NULL;
990 uword thread_index = 0;
992 const uword nthreads = vlib_num_workers () + 1;
993 for (thread_index = 0; thread_index < nthreads; ++thread_index)
995 ip4_sv_reass_per_thread_t *rt = &rm->per_thread_data[thread_index];
996 clib_spinlock_lock (&rt->lock);
998 vec_reset_length (pool_indexes_to_free);
1000 pool_foreach_index (index, rt->pool, ({
1001 reass = pool_elt_at_index (rt->pool, index);
1002 if (now > reass->last_heard + rm->timeout)
1004 vec_add1 (pool_indexes_to_free, index);
1010 vec_foreach (i, pool_indexes_to_free)
1012 ip4_sv_reass_t *reass = pool_elt_at_index (rt->pool, i[0]);
1013 ip4_sv_reass_free (vm, rm, rt, reass);
1017 clib_spinlock_unlock (&rt->lock);
1020 vec_free (pool_indexes_to_free);
1023 _vec_len (event_data) = 0;
1031 VLIB_REGISTER_NODE (ip4_sv_reass_expire_node) = {
1032 .function = ip4_sv_reass_walk_expired,
1033 .type = VLIB_NODE_TYPE_PROCESS,
1034 .name = "ip4-sv-reassembly-expire-walk",
1035 .format_trace = format_ip4_sv_reass_trace,
1036 .n_errors = ARRAY_LEN (ip4_sv_reass_error_strings),
1037 .error_strings = ip4_sv_reass_error_strings,
1043 format_ip4_sv_reass_key (u8 * s, va_list * args)
1045 ip4_sv_reass_key_t *key = va_arg (*args, ip4_sv_reass_key_t *);
1048 "xx_id: %u, src: %U, dst: %U, frag_id: %u, proto: %u",
1049 key->xx_id, format_ip4_address, &key->src, format_ip4_address,
1050 &key->dst, clib_net_to_host_u16 (key->frag_id), key->proto);
1055 format_ip4_sv_reass (u8 * s, va_list * args)
1057 vlib_main_t *vm = va_arg (*args, vlib_main_t *);
1058 ip4_sv_reass_t *reass = va_arg (*args, ip4_sv_reass_t *);
1060 s = format (s, "ID: %lu, key: %U trace_op_counter: %u\n",
1061 reass->id, format_ip4_sv_reass_key, &reass->key,
1062 reass->trace_op_counter);
1067 vec_foreach (bip, reass->cached_buffers)
1072 b = vlib_get_buffer (vm, bi);
1073 s = format (s, " #%03u: bi: %u, ", counter, bi);
1075 bi = b->next_buffer;
1077 while (b->flags & VLIB_BUFFER_NEXT_PRESENT);
1082 static clib_error_t *
1083 show_ip4_reass (vlib_main_t * vm,
1084 unformat_input_t * input,
1085 CLIB_UNUSED (vlib_cli_command_t * lmd))
1087 ip4_sv_reass_main_t *rm = &ip4_sv_reass_main;
1089 vlib_cli_output (vm, "---------------------");
1090 vlib_cli_output (vm, "IP4 reassembly status");
1091 vlib_cli_output (vm, "---------------------");
1092 bool details = false;
1093 if (unformat (input, "details"))
1098 u32 sum_reass_n = 0;
1099 ip4_sv_reass_t *reass;
1101 const uword nthreads = vlib_num_workers () + 1;
1102 for (thread_index = 0; thread_index < nthreads; ++thread_index)
1104 ip4_sv_reass_per_thread_t *rt = &rm->per_thread_data[thread_index];
1105 clib_spinlock_lock (&rt->lock);
1109 pool_foreach (reass, rt->pool, {
1110 vlib_cli_output (vm, "%U", format_ip4_sv_reass, vm, reass);
1114 sum_reass_n += rt->reass_n;
1115 clib_spinlock_unlock (&rt->lock);
1117 vlib_cli_output (vm, "---------------------");
1118 vlib_cli_output (vm, "Current IP4 reassemblies count: %lu\n",
1119 (long unsigned) sum_reass_n);
1120 vlib_cli_output (vm,
1121 "Maximum configured concurrent shallow virtual IP4 reassemblies per worker-thread: %lu\n",
1122 (long unsigned) rm->max_reass_n);
1123 vlib_cli_output (vm,
1124 "Maximum configured shallow virtual IP4 reassembly timeout: %lums\n",
1125 (long unsigned) rm->timeout_ms);
1126 vlib_cli_output (vm,
1127 "Maximum configured shallow virtual IP4 reassembly expire walk interval: %lums\n",
1128 (long unsigned) rm->expire_walk_interval_ms);
1133 VLIB_CLI_COMMAND (show_ip4_sv_reass_cmd, static) = {
1134 .path = "show ip4-sv-reassembly",
1135 .short_help = "show ip4-sv-reassembly [details]",
1136 .function = show_ip4_reass,
1140 #ifndef CLIB_MARCH_VARIANT
1142 ip4_sv_reass_enable_disable (u32 sw_if_index, u8 enable_disable)
1144 return ip4_sv_reass_enable_disable_with_refcnt (sw_if_index,
1147 #endif /* CLIB_MARCH_VARIANT */
1150 #define foreach_ip4_sv_reass_handoff_error \
1151 _(CONGESTION_DROP, "congestion drop")
1156 #define _(sym,str) IP4_SV_REASSEMBLY_HANDOFF_ERROR_##sym,
1157 foreach_ip4_sv_reass_handoff_error
1159 IP4_SV_REASSEMBLY_HANDOFF_N_ERROR,
1160 } ip4_sv_reass_handoff_error_t;
1162 static char *ip4_sv_reass_handoff_error_strings[] = {
1163 #define _(sym,string) string,
1164 foreach_ip4_sv_reass_handoff_error
1170 u32 next_worker_index;
1171 } ip4_sv_reass_handoff_trace_t;
1174 format_ip4_sv_reass_handoff_trace (u8 * s, va_list * args)
1176 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
1177 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
1178 ip4_sv_reass_handoff_trace_t *t =
1179 va_arg (*args, ip4_sv_reass_handoff_trace_t *);
1182 format (s, "ip4-sv-reassembly-handoff: next-worker %d",
1183 t->next_worker_index);
1189 ip4_sv_reass_handoff_node_inline (vlib_main_t * vm,
1190 vlib_node_runtime_t * node,
1191 vlib_frame_t * frame, bool is_feature)
1193 ip4_sv_reass_main_t *rm = &ip4_sv_reass_main;
1195 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
1196 u32 n_enq, n_left_from, *from;
1197 u16 thread_indices[VLIB_FRAME_SIZE], *ti;
1200 from = vlib_frame_vector_args (frame);
1201 n_left_from = frame->n_vectors;
1202 vlib_get_buffers (vm, from, bufs, n_left_from);
1205 ti = thread_indices;
1207 fq_index = (is_feature) ? rm->fq_feature_index : rm->fq_index;
1209 while (n_left_from > 0)
1211 ti[0] = vnet_buffer (b[0])->ip.reass.owner_thread_index;
1214 ((node->flags & VLIB_NODE_FLAG_TRACE)
1215 && (b[0]->flags & VLIB_BUFFER_IS_TRACED)))
1217 ip4_sv_reass_handoff_trace_t *t =
1218 vlib_add_trace (vm, node, b[0], sizeof (*t));
1219 t->next_worker_index = ti[0];
1227 vlib_buffer_enqueue_to_thread (vm, fq_index, from, thread_indices,
1228 frame->n_vectors, 1);
1230 if (n_enq < frame->n_vectors)
1231 vlib_node_increment_counter (vm, node->node_index,
1232 IP4_SV_REASSEMBLY_HANDOFF_ERROR_CONGESTION_DROP,
1233 frame->n_vectors - n_enq);
1234 return frame->n_vectors;
1237 VLIB_NODE_FN (ip4_sv_reass_handoff_node) (vlib_main_t * vm,
1238 vlib_node_runtime_t * node,
1239 vlib_frame_t * frame)
1241 return ip4_sv_reass_handoff_node_inline (vm, node, frame,
1242 false /* is_feature */ );
1247 VLIB_REGISTER_NODE (ip4_sv_reass_handoff_node) = {
1248 .name = "ip4-sv-reassembly-handoff",
1249 .vector_size = sizeof (u32),
1250 .n_errors = ARRAY_LEN(ip4_sv_reass_handoff_error_strings),
1251 .error_strings = ip4_sv_reass_handoff_error_strings,
1252 .format_trace = format_ip4_sv_reass_handoff_trace,
1264 VLIB_NODE_FN (ip4_sv_reass_feature_handoff_node) (vlib_main_t * vm,
1265 vlib_node_runtime_t *
1267 vlib_frame_t * frame)
1269 return ip4_sv_reass_handoff_node_inline (vm, node, frame,
1270 true /* is_feature */ );
1276 VLIB_REGISTER_NODE (ip4_sv_reass_feature_handoff_node) = {
1277 .name = "ip4-sv-reass-feature-hoff",
1278 .vector_size = sizeof (u32),
1279 .n_errors = ARRAY_LEN(ip4_sv_reass_handoff_error_strings),
1280 .error_strings = ip4_sv_reass_handoff_error_strings,
1281 .format_trace = format_ip4_sv_reass_handoff_trace,
1291 #ifndef CLIB_MARCH_VARIANT
1293 ip4_sv_reass_enable_disable_with_refcnt (u32 sw_if_index, int is_enable)
1295 ip4_sv_reass_main_t *rm = &ip4_sv_reass_main;
1296 vec_validate (rm->feature_use_refcount_per_intf, sw_if_index);
1299 if (!rm->feature_use_refcount_per_intf[sw_if_index])
1301 ++rm->feature_use_refcount_per_intf[sw_if_index];
1302 return vnet_feature_enable_disable ("ip4-unicast",
1303 "ip4-sv-reassembly-feature",
1304 sw_if_index, 1, 0, 0);
1306 ++rm->feature_use_refcount_per_intf[sw_if_index];
1310 if (rm->feature_use_refcount_per_intf[sw_if_index])
1311 --rm->feature_use_refcount_per_intf[sw_if_index];
1312 if (!rm->feature_use_refcount_per_intf[sw_if_index])
1313 return vnet_feature_enable_disable ("ip4-unicast",
1314 "ip4-sv-reassembly-feature",
1315 sw_if_index, 0, 0, 0);
1321 ip4_sv_reass_custom_register_next_node (uword node_index)
1323 return vlib_node_add_next (vlib_get_main (), ip4_sv_reass_custom_node.index,
1328 ip4_sv_reass_output_enable_disable_with_refcnt (u32 sw_if_index,
1331 ip4_sv_reass_main_t *rm = &ip4_sv_reass_main;
1332 vec_validate (rm->output_feature_use_refcount_per_intf, sw_if_index);
1335 if (!rm->output_feature_use_refcount_per_intf[sw_if_index])
1337 ++rm->output_feature_use_refcount_per_intf[sw_if_index];
1338 return vnet_feature_enable_disable ("ip4-output",
1339 "ip4-sv-reassembly-output-feature",
1340 sw_if_index, 1, 0, 0);
1342 ++rm->output_feature_use_refcount_per_intf[sw_if_index];
1346 if (rm->output_feature_use_refcount_per_intf[sw_if_index])
1347 --rm->output_feature_use_refcount_per_intf[sw_if_index];
1348 if (!rm->output_feature_use_refcount_per_intf[sw_if_index])
1349 return vnet_feature_enable_disable ("ip4-output",
1350 "ip4-sv-reassembly-output-feature",
1351 sw_if_index, 0, 0, 0);
1358 * fd.io coding-style-patch-verification: ON
1361 * eval: (c-set-style "gnu")