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 (rm->vlib_main);
310 if (!clib_bihash_search_16_8
311 (&rm->hash, (clib_bihash_kv_16_8_t *) kv, (clib_bihash_kv_16_8_t *) kv))
313 if (vm->thread_index != kv->v.thread_index)
318 reass = pool_elt_at_index (rt->pool, kv->v.reass_index);
320 if (now > reass->last_heard + rm->timeout)
322 ip4_sv_reass_free (vm, rm, rt, reass);
329 reass->last_heard = now;
333 if (rt->reass_n >= rm->max_reass_n && rm->max_reass_n)
335 reass = pool_elt_at_index (rt->pool, rt->lru_last);
336 ip4_sv_reass_free (vm, rm, rt, reass);
339 pool_get (rt->pool, reass);
340 clib_memset (reass, 0, sizeof (*reass));
341 reass->id = ((u64) vm->thread_index * 1000000000) + rt->id_counter;
343 ip4_sv_reass_init (reass);
345 reass->lru_prev = reass->lru_next = ~0;
347 if (~0 != rt->lru_last)
349 ip4_sv_reass_t *lru_last = pool_elt_at_index (rt->pool, rt->lru_last);
350 reass->lru_prev = rt->lru_last;
351 lru_last->lru_next = rt->lru_last = reass - rt->pool;
354 if (~0 == rt->lru_first)
356 rt->lru_first = rt->lru_last = reass - rt->pool;
359 reass->key.as_u64[0] = ((clib_bihash_kv_16_8_t *) kv)->key[0];
360 reass->key.as_u64[1] = ((clib_bihash_kv_16_8_t *) kv)->key[1];
361 kv->v.reass_index = (reass - rt->pool);
362 kv->v.thread_index = vm->thread_index;
363 reass->last_heard = now;
365 if (clib_bihash_add_del_16_8 (&rm->hash, (clib_bihash_kv_16_8_t *) kv, 1))
367 ip4_sv_reass_free (vm, rm, rt, reass);
374 always_inline ip4_sv_reass_rc_t
375 ip4_sv_reass_update (vlib_main_t * vm, vlib_node_runtime_t * node,
376 ip4_sv_reass_main_t * rm, ip4_sv_reass_per_thread_t * rt,
377 ip4_header_t * ip0, ip4_sv_reass_t * reass, u32 bi0)
379 vlib_buffer_t *b0 = vlib_get_buffer (vm, bi0);
380 ip4_sv_reass_rc_t rc = IP4_SV_REASS_RC_OK;
381 const u32 fragment_first = ip4_get_fragment_offset_bytes (ip0);
382 if (0 == fragment_first)
384 reass->ip_proto = ip0->protocol;
385 reass->l4_src_port = ip4_get_port (ip0, 1);
386 reass->l4_dst_port = ip4_get_port (ip0, 0);
387 if (!reass->l4_src_port || !reass->l4_dst_port)
388 return IP4_SV_REASS_RC_UNSUPP_IP_PROTO;
389 if (IP_PROTOCOL_TCP == reass->ip_proto)
391 reass->icmp_type_or_tcp_flags = ((tcp_header_t *) (ip0 + 1))->flags;
392 reass->tcp_ack_number = ((tcp_header_t *) (ip0 + 1))->ack_number;
393 reass->tcp_seq_number = ((tcp_header_t *) (ip0 + 1))->seq_number;
395 else if (IP_PROTOCOL_ICMP == reass->ip_proto)
397 reass->icmp_type_or_tcp_flags =
398 ((icmp46_header_t *) (ip0 + 1))->type;
400 reass->is_complete = true;
401 vlib_buffer_t *b0 = vlib_get_buffer (vm, bi0);
402 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
404 ip4_sv_reass_add_trace (vm, node, rm, reass, bi0, REASS_FINISH,
405 reass->ip_proto, reass->l4_src_port,
409 vec_add1 (reass->cached_buffers, bi0);
410 if (!reass->is_complete)
412 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
414 ip4_sv_reass_add_trace (vm, node, rm, reass, bi0,
415 REASS_FRAGMENT_CACHE, ~0, ~0, ~0);
417 if (vec_len (reass->cached_buffers) > rm->max_reass_len)
419 rc = IP4_SV_REASS_RC_TOO_MANY_FRAGMENTS;
426 ip4_sv_reass_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
427 vlib_frame_t * frame, bool is_feature,
428 bool is_output_feature, bool is_custom)
430 u32 *from = vlib_frame_vector_args (frame);
431 u32 n_left_from, n_left_to_next, *to_next, next_index;
432 ip4_sv_reass_main_t *rm = &ip4_sv_reass_main;
433 ip4_sv_reass_per_thread_t *rt = &rm->per_thread_data[vm->thread_index];
434 clib_spinlock_lock (&rt->lock);
436 n_left_from = frame->n_vectors;
437 next_index = node->cached_next_index;
439 while (n_left_from > 0)
441 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
443 while (n_left_from > 0 && n_left_to_next > 0)
448 u32 error0 = IP4_ERROR_NONE;
451 b0 = vlib_get_buffer (vm, bi0);
454 (ip4_header_t *) u8_ptr_add (vlib_buffer_get_current (b0),
457 ip.save_rewrite_length);
458 if (!ip4_get_fragment_more (ip0) && !ip4_get_fragment_offset (ip0))
460 // this is a regular packet - no fragmentation
463 next0 = vnet_buffer (b0)->ip.reass.next_index;
467 next0 = IP4_SV_REASSEMBLY_NEXT_INPUT;
469 vnet_buffer (b0)->ip.reass.is_non_first_fragment = 0;
470 vnet_buffer (b0)->ip.reass.ip_proto = ip0->protocol;
471 if (IP_PROTOCOL_TCP == ip0->protocol)
473 vnet_buffer (b0)->ip.reass.icmp_type_or_tcp_flags =
474 ((tcp_header_t *) (ip0 + 1))->flags;
475 vnet_buffer (b0)->ip.reass.tcp_ack_number =
476 ((tcp_header_t *) (ip0 + 1))->ack_number;
477 vnet_buffer (b0)->ip.reass.tcp_seq_number =
478 ((tcp_header_t *) (ip0 + 1))->seq_number;
480 else if (IP_PROTOCOL_ICMP == ip0->protocol)
482 vnet_buffer (b0)->ip.reass.icmp_type_or_tcp_flags =
483 ((icmp46_header_t *) (ip0 + 1))->type;
485 vnet_buffer (b0)->ip.reass.l4_src_port = ip4_get_port (ip0, 1);
486 vnet_buffer (b0)->ip.reass.l4_dst_port = ip4_get_port (ip0, 0);
487 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
489 ip4_sv_reass_add_trace (vm, node, rm, NULL, bi0,
491 vnet_buffer (b0)->ip.reass.ip_proto,
492 vnet_buffer (b0)->ip.
494 vnet_buffer (b0)->ip.
499 const u32 fragment_first = ip4_get_fragment_offset_bytes (ip0);
500 const u32 fragment_length =
501 clib_net_to_host_u16 (ip0->length) - ip4_header_bytes (ip0);
502 const u32 fragment_last = fragment_first + fragment_length - 1;
503 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
505 next0 = IP4_SV_REASSEMBLY_NEXT_DROP;
506 error0 = IP4_ERROR_REASS_MALFORMED_PACKET;
507 b0->error = node->errors[error0];
510 ip4_sv_reass_kv_t kv;
514 (u64) vec_elt (ip4_main.fib_index_by_sw_if_index,
515 vnet_buffer (b0)->sw_if_index[VLIB_RX]) |
516 (u64) ip0->src_address.as_u32 << 32;
518 (u64) ip0->dst_address.
519 as_u32 | (u64) ip0->fragment_id << 32 | (u64) ip0->protocol << 48;
521 ip4_sv_reass_t *reass =
522 ip4_sv_reass_find_or_create (vm, rm, rt, &kv, &do_handoff);
524 if (PREDICT_FALSE (do_handoff))
526 next0 = IP4_SV_REASSEMBLY_NEXT_HANDOFF;
527 vnet_buffer (b0)->ip.reass.owner_thread_index =
534 next0 = IP4_SV_REASSEMBLY_NEXT_DROP;
535 error0 = IP4_ERROR_REASS_LIMIT_REACHED;
536 b0->error = node->errors[error0];
540 if (reass->is_complete)
544 next0 = vnet_buffer (b0)->ip.reass.next_index;
548 next0 = IP4_SV_REASSEMBLY_NEXT_INPUT;
550 vnet_buffer (b0)->ip.reass.is_non_first_fragment =
552 vnet_buffer (b0)->ip.reass.ip_proto = reass->ip_proto;
553 vnet_buffer (b0)->ip.reass.icmp_type_or_tcp_flags =
554 reass->icmp_type_or_tcp_flags;
555 vnet_buffer (b0)->ip.reass.tcp_ack_number =
556 reass->tcp_ack_number;
557 vnet_buffer (b0)->ip.reass.tcp_seq_number =
558 reass->tcp_seq_number;
559 vnet_buffer (b0)->ip.reass.l4_src_port = reass->l4_src_port;
560 vnet_buffer (b0)->ip.reass.l4_dst_port = reass->l4_dst_port;
561 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
563 ip4_sv_reass_add_trace (vm, node, rm, reass, bi0,
564 REASS_FRAGMENT_FORWARD,
572 ip4_sv_reass_rc_t rc =
573 ip4_sv_reass_update (vm, node, rm, rt, ip0, reass, bi0);
576 case IP4_SV_REASS_RC_OK:
577 /* nothing to do here */
579 case IP4_SV_REASS_RC_TOO_MANY_FRAGMENTS:
580 vlib_node_increment_counter (vm, node->node_index,
581 IP4_ERROR_REASS_FRAGMENT_CHAIN_TOO_LONG,
583 ip4_sv_reass_free (vm, rm, rt, reass);
586 case IP4_SV_REASS_RC_UNSUPP_IP_PROTO:
587 vlib_node_increment_counter (vm, node->node_index,
588 IP4_ERROR_REASS_FRAGMENT_CHAIN_TOO_LONG,
590 ip4_sv_reass_free (vm, rm, rt, reass);
594 if (reass->is_complete)
597 vec_foreach_index (idx, reass->cached_buffers)
599 u32 bi0 = vec_elt (reass->cached_buffers, idx);
600 vlib_buffer_t *b0 = vlib_get_buffer (vm, bi0);
601 u32 next0 = IP4_SV_REASSEMBLY_NEXT_INPUT;
604 vnet_feature_next (&next0, b0);
608 next0 = vnet_buffer (b0)->ip.reass.next_index;
610 if (0 == n_left_to_next)
612 vlib_put_next_frame (vm, node, next_index,
614 vlib_get_next_frame (vm, node, next_index, to_next,
620 vnet_buffer (b0)->ip.reass.is_non_first_fragment =
621 ! !ip4_get_fragment_offset (vlib_buffer_get_current (b0));
622 vnet_buffer (b0)->ip.reass.ip_proto = reass->ip_proto;
623 vnet_buffer (b0)->ip.reass.icmp_type_or_tcp_flags =
624 reass->icmp_type_or_tcp_flags;
625 vnet_buffer (b0)->ip.reass.tcp_ack_number =
626 reass->tcp_ack_number;
627 vnet_buffer (b0)->ip.reass.tcp_seq_number =
628 reass->tcp_seq_number;
629 vnet_buffer (b0)->ip.reass.l4_src_port = reass->l4_src_port;
630 vnet_buffer (b0)->ip.reass.l4_dst_port = reass->l4_dst_port;
631 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
633 ip4_sv_reass_add_trace (vm, node, rm, reass, bi0,
634 REASS_FRAGMENT_FORWARD,
639 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
640 to_next, n_left_to_next, bi0,
643 _vec_len (reass->cached_buffers) = 0; // buffers are owned by frame now
651 if (is_feature && IP4_ERROR_NONE == error0)
653 b0 = vlib_get_buffer (vm, bi0);
654 vnet_feature_next (&next0, b0);
656 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
657 to_next, n_left_to_next,
665 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
668 clib_spinlock_unlock (&rt->lock);
669 return frame->n_vectors;
672 static char *ip4_sv_reass_error_strings[] = {
673 #define _(sym, string) string,
678 VLIB_NODE_FN (ip4_sv_reass_node) (vlib_main_t * vm,
679 vlib_node_runtime_t * node,
680 vlib_frame_t * frame)
682 return ip4_sv_reass_inline (vm, node, frame, false /* is_feature */ ,
683 false /* is_output_feature */ ,
684 false /* is_custom */ );
688 VLIB_REGISTER_NODE (ip4_sv_reass_node) = {
689 .name = "ip4-sv-reassembly",
690 .vector_size = sizeof (u32),
691 .format_trace = format_ip4_sv_reass_trace,
692 .n_errors = ARRAY_LEN (ip4_sv_reass_error_strings),
693 .error_strings = ip4_sv_reass_error_strings,
694 .n_next_nodes = IP4_SV_REASSEMBLY_N_NEXT,
697 [IP4_SV_REASSEMBLY_NEXT_INPUT] = "ip4-input",
698 [IP4_SV_REASSEMBLY_NEXT_DROP] = "ip4-drop",
699 [IP4_SV_REASSEMBLY_NEXT_HANDOFF] = "ip4-sv-reassembly-handoff",
705 VLIB_NODE_FN (ip4_sv_reass_node_feature) (vlib_main_t * vm,
706 vlib_node_runtime_t * node,
707 vlib_frame_t * frame)
709 return ip4_sv_reass_inline (vm, node, frame, true /* is_feature */ ,
710 false /* is_output_feature */ ,
711 false /* is_custom */ );
715 VLIB_REGISTER_NODE (ip4_sv_reass_node_feature) = {
716 .name = "ip4-sv-reassembly-feature",
717 .vector_size = sizeof (u32),
718 .format_trace = format_ip4_sv_reass_trace,
719 .n_errors = ARRAY_LEN (ip4_sv_reass_error_strings),
720 .error_strings = ip4_sv_reass_error_strings,
721 .n_next_nodes = IP4_SV_REASSEMBLY_N_NEXT,
724 [IP4_SV_REASSEMBLY_NEXT_INPUT] = "ip4-input",
725 [IP4_SV_REASSEMBLY_NEXT_DROP] = "ip4-drop",
726 [IP4_SV_REASSEMBLY_NEXT_HANDOFF] = "ip4-sv-reass-feature-hoff",
732 VNET_FEATURE_INIT (ip4_sv_reass_feature) = {
733 .arc_name = "ip4-unicast",
734 .node_name = "ip4-sv-reassembly-feature",
735 .runs_before = VNET_FEATURES ("ip4-lookup"),
740 VLIB_NODE_FN (ip4_sv_reass_node_output_feature) (vlib_main_t * vm,
741 vlib_node_runtime_t * node,
742 vlib_frame_t * frame)
744 return ip4_sv_reass_inline (vm, node, frame, true /* is_feature */ ,
745 true /* is_output_feature */ ,
746 false /* is_custom */ );
751 VLIB_REGISTER_NODE (ip4_sv_reass_node_output_feature) = {
752 .name = "ip4-sv-reassembly-output-feature",
753 .vector_size = sizeof (u32),
754 .format_trace = format_ip4_sv_reass_trace,
755 .n_errors = ARRAY_LEN (ip4_sv_reass_error_strings),
756 .error_strings = ip4_sv_reass_error_strings,
757 .n_next_nodes = IP4_SV_REASSEMBLY_N_NEXT,
760 [IP4_SV_REASSEMBLY_NEXT_INPUT] = "ip4-input",
761 [IP4_SV_REASSEMBLY_NEXT_DROP] = "ip4-drop",
762 [IP4_SV_REASSEMBLY_NEXT_HANDOFF] = "ip4-sv-reass-feature-hoff",
768 VNET_FEATURE_INIT (ip4_sv_reass_output_feature) = {
769 .arc_name = "ip4-output",
770 .node_name = "ip4-sv-reassembly-output-feature",
777 VLIB_REGISTER_NODE (ip4_sv_reass_custom_node) = {
778 .name = "ip4-sv-reassembly-custom-next",
779 .vector_size = sizeof (u32),
780 .format_trace = format_ip4_sv_reass_trace,
781 .n_errors = ARRAY_LEN (ip4_sv_reass_error_strings),
782 .error_strings = ip4_sv_reass_error_strings,
783 .n_next_nodes = IP4_SV_REASSEMBLY_N_NEXT,
786 [IP4_SV_REASSEMBLY_NEXT_INPUT] = "ip4-input",
787 [IP4_SV_REASSEMBLY_NEXT_DROP] = "ip4-drop",
788 [IP4_SV_REASSEMBLY_NEXT_HANDOFF] = "ip4-sv-reassembly-handoff",
794 VLIB_NODE_FN (ip4_sv_reass_custom_node) (vlib_main_t * vm,
795 vlib_node_runtime_t * node,
796 vlib_frame_t * frame)
798 return ip4_sv_reass_inline (vm, node, frame, false /* is_feature */ ,
799 false /* is_output_feature */ ,
800 true /* is_custom */ );
803 #ifndef CLIB_MARCH_VARIANT
805 ip4_sv_reass_get_nbuckets ()
807 ip4_sv_reass_main_t *rm = &ip4_sv_reass_main;
811 nbuckets = (u32) (rm->max_reass_n / IP4_SV_REASS_HT_LOAD_FACTOR);
813 for (i = 0; i < 31; i++)
814 if ((1 << i) >= nbuckets)
820 #endif /* CLIB_MARCH_VARIANT */
824 IP4_EVENT_CONFIG_CHANGED = 1,
825 } ip4_sv_reass_event_t;
830 clib_bihash_16_8_t *new_hash;
833 #ifndef CLIB_MARCH_VARIANT
835 ip4_rehash_cb (clib_bihash_kv_16_8_t * kv, void *_ctx)
837 ip4_rehash_cb_ctx *ctx = _ctx;
838 if (clib_bihash_add_del_16_8 (ctx->new_hash, kv, 1))
842 return (BIHASH_WALK_CONTINUE);
846 ip4_sv_reass_set_params (u32 timeout_ms, u32 max_reassemblies,
847 u32 max_reassembly_length,
848 u32 expire_walk_interval_ms)
850 ip4_sv_reass_main.timeout_ms = timeout_ms;
851 ip4_sv_reass_main.timeout = (f64) timeout_ms / (f64) MSEC_PER_SEC;
852 ip4_sv_reass_main.max_reass_n = max_reassemblies;
853 ip4_sv_reass_main.max_reass_len = max_reassembly_length;
854 ip4_sv_reass_main.expire_walk_interval_ms = expire_walk_interval_ms;
858 ip4_sv_reass_set (u32 timeout_ms, u32 max_reassemblies,
859 u32 max_reassembly_length, u32 expire_walk_interval_ms)
861 u32 old_nbuckets = ip4_sv_reass_get_nbuckets ();
862 ip4_sv_reass_set_params (timeout_ms, max_reassemblies,
863 max_reassembly_length, expire_walk_interval_ms);
864 vlib_process_signal_event (ip4_sv_reass_main.vlib_main,
865 ip4_sv_reass_main.ip4_sv_reass_expire_node_idx,
866 IP4_EVENT_CONFIG_CHANGED, 0);
867 u32 new_nbuckets = ip4_sv_reass_get_nbuckets ();
868 if (ip4_sv_reass_main.max_reass_n > 0 && new_nbuckets > old_nbuckets)
870 clib_bihash_16_8_t new_hash;
871 clib_memset (&new_hash, 0, sizeof (new_hash));
872 ip4_rehash_cb_ctx ctx;
874 ctx.new_hash = &new_hash;
875 clib_bihash_init_16_8 (&new_hash, "ip4-dr", new_nbuckets,
876 new_nbuckets * 1024);
877 clib_bihash_foreach_key_value_pair_16_8 (&ip4_sv_reass_main.hash,
878 ip4_rehash_cb, &ctx);
881 clib_bihash_free_16_8 (&new_hash);
886 clib_bihash_free_16_8 (&ip4_sv_reass_main.hash);
887 clib_memcpy_fast (&ip4_sv_reass_main.hash, &new_hash,
888 sizeof (ip4_sv_reass_main.hash));
889 clib_bihash_copied (&ip4_sv_reass_main.hash, &new_hash);
896 ip4_sv_reass_get (u32 * timeout_ms, u32 * max_reassemblies,
897 u32 * max_reassembly_length, u32 * expire_walk_interval_ms)
899 *timeout_ms = ip4_sv_reass_main.timeout_ms;
900 *max_reassemblies = ip4_sv_reass_main.max_reass_n;
901 *max_reassembly_length = ip4_sv_reass_main.max_reass_len;
902 *expire_walk_interval_ms = ip4_sv_reass_main.expire_walk_interval_ms;
906 static clib_error_t *
907 ip4_sv_reass_init_function (vlib_main_t * vm)
909 ip4_sv_reass_main_t *rm = &ip4_sv_reass_main;
910 clib_error_t *error = 0;
915 rm->vnet_main = vnet_get_main ();
917 vec_validate (rm->per_thread_data, vlib_num_workers ());
918 ip4_sv_reass_per_thread_t *rt;
919 vec_foreach (rt, rm->per_thread_data)
921 clib_spinlock_init (&rt->lock);
922 pool_alloc (rt->pool, rm->max_reass_n);
923 rt->lru_first = rt->lru_last = ~0;
926 node = vlib_get_node_by_name (vm, (u8 *) "ip4-sv-reassembly-expire-walk");
928 rm->ip4_sv_reass_expire_node_idx = node->index;
930 ip4_sv_reass_set_params (IP4_SV_REASS_TIMEOUT_DEFAULT_MS,
931 IP4_SV_REASS_MAX_REASSEMBLIES_DEFAULT,
932 IP4_SV_REASS_MAX_REASSEMBLY_LENGTH_DEFAULT,
933 IP4_SV_REASS_EXPIRE_WALK_INTERVAL_DEFAULT_MS);
935 nbuckets = ip4_sv_reass_get_nbuckets ();
936 clib_bihash_init_16_8 (&rm->hash, "ip4-dr", nbuckets, nbuckets * 1024);
938 node = vlib_get_node_by_name (vm, (u8 *) "ip4-drop");
940 rm->ip4_drop_idx = node->index;
942 rm->fq_index = vlib_frame_queue_main_init (ip4_sv_reass_node.index, 0);
943 rm->fq_feature_index =
944 vlib_frame_queue_main_init (ip4_sv_reass_node_feature.index, 0);
946 rm->feature_use_refcount_per_intf = NULL;
947 rm->output_feature_use_refcount_per_intf = NULL;
952 VLIB_INIT_FUNCTION (ip4_sv_reass_init_function);
953 #endif /* CLIB_MARCH_VARIANT */
956 ip4_sv_reass_walk_expired (vlib_main_t * vm,
957 vlib_node_runtime_t * node, vlib_frame_t * f)
959 ip4_sv_reass_main_t *rm = &ip4_sv_reass_main;
960 uword event_type, *event_data = 0;
964 vlib_process_wait_for_event_or_clock (vm,
966 rm->expire_walk_interval_ms /
968 event_type = vlib_process_get_events (vm, &event_data);
972 case ~0: /* no events => timeout */
973 /* nothing to do here */
975 case IP4_EVENT_CONFIG_CHANGED:
978 clib_warning ("BUG: event type 0x%wx", event_type);
981 f64 now = vlib_time_now (vm);
983 ip4_sv_reass_t *reass;
984 int *pool_indexes_to_free = NULL;
986 uword thread_index = 0;
988 const uword nthreads = vlib_num_workers () + 1;
989 for (thread_index = 0; thread_index < nthreads; ++thread_index)
991 ip4_sv_reass_per_thread_t *rt = &rm->per_thread_data[thread_index];
992 clib_spinlock_lock (&rt->lock);
994 vec_reset_length (pool_indexes_to_free);
996 pool_foreach_index (index, rt->pool, ({
997 reass = pool_elt_at_index (rt->pool, index);
998 if (now > reass->last_heard + rm->timeout)
1000 vec_add1 (pool_indexes_to_free, index);
1006 vec_foreach (i, pool_indexes_to_free)
1008 ip4_sv_reass_t *reass = pool_elt_at_index (rt->pool, i[0]);
1009 ip4_sv_reass_free (vm, rm, rt, reass);
1013 clib_spinlock_unlock (&rt->lock);
1016 vec_free (pool_indexes_to_free);
1019 _vec_len (event_data) = 0;
1027 VLIB_REGISTER_NODE (ip4_sv_reass_expire_node) = {
1028 .function = ip4_sv_reass_walk_expired,
1029 .type = VLIB_NODE_TYPE_PROCESS,
1030 .name = "ip4-sv-reassembly-expire-walk",
1031 .format_trace = format_ip4_sv_reass_trace,
1032 .n_errors = ARRAY_LEN (ip4_sv_reass_error_strings),
1033 .error_strings = ip4_sv_reass_error_strings,
1039 format_ip4_sv_reass_key (u8 * s, va_list * args)
1041 ip4_sv_reass_key_t *key = va_arg (*args, ip4_sv_reass_key_t *);
1044 "xx_id: %u, src: %U, dst: %U, frag_id: %u, proto: %u",
1045 key->xx_id, format_ip4_address, &key->src, format_ip4_address,
1046 &key->dst, clib_net_to_host_u16 (key->frag_id), key->proto);
1051 format_ip4_sv_reass (u8 * s, va_list * args)
1053 vlib_main_t *vm = va_arg (*args, vlib_main_t *);
1054 ip4_sv_reass_t *reass = va_arg (*args, ip4_sv_reass_t *);
1056 s = format (s, "ID: %lu, key: %U trace_op_counter: %u\n",
1057 reass->id, format_ip4_sv_reass_key, &reass->key,
1058 reass->trace_op_counter);
1063 vec_foreach (bip, reass->cached_buffers)
1068 b = vlib_get_buffer (vm, bi);
1069 s = format (s, " #%03u: bi: %u, ", counter, bi);
1071 bi = b->next_buffer;
1073 while (b->flags & VLIB_BUFFER_NEXT_PRESENT);
1078 static clib_error_t *
1079 show_ip4_reass (vlib_main_t * vm,
1080 unformat_input_t * input,
1081 CLIB_UNUSED (vlib_cli_command_t * lmd))
1083 ip4_sv_reass_main_t *rm = &ip4_sv_reass_main;
1085 vlib_cli_output (vm, "---------------------");
1086 vlib_cli_output (vm, "IP4 reassembly status");
1087 vlib_cli_output (vm, "---------------------");
1088 bool details = false;
1089 if (unformat (input, "details"))
1094 u32 sum_reass_n = 0;
1095 ip4_sv_reass_t *reass;
1097 const uword nthreads = vlib_num_workers () + 1;
1098 for (thread_index = 0; thread_index < nthreads; ++thread_index)
1100 ip4_sv_reass_per_thread_t *rt = &rm->per_thread_data[thread_index];
1101 clib_spinlock_lock (&rt->lock);
1105 pool_foreach (reass, rt->pool, {
1106 vlib_cli_output (vm, "%U", format_ip4_sv_reass, vm, reass);
1110 sum_reass_n += rt->reass_n;
1111 clib_spinlock_unlock (&rt->lock);
1113 vlib_cli_output (vm, "---------------------");
1114 vlib_cli_output (vm, "Current IP4 reassemblies count: %lu\n",
1115 (long unsigned) sum_reass_n);
1116 vlib_cli_output (vm,
1117 "Maximum configured concurrent shallow virtual IP4 reassemblies per worker-thread: %lu\n",
1118 (long unsigned) rm->max_reass_n);
1119 vlib_cli_output (vm,
1120 "Maximum configured shallow virtual IP4 reassembly timeout: %lums\n",
1121 (long unsigned) rm->timeout_ms);
1122 vlib_cli_output (vm,
1123 "Maximum configured shallow virtual IP4 reassembly expire walk interval: %lums\n",
1124 (long unsigned) rm->expire_walk_interval_ms);
1129 VLIB_CLI_COMMAND (show_ip4_sv_reass_cmd, static) = {
1130 .path = "show ip4-sv-reassembly",
1131 .short_help = "show ip4-sv-reassembly [details]",
1132 .function = show_ip4_reass,
1136 #ifndef CLIB_MARCH_VARIANT
1138 ip4_sv_reass_enable_disable (u32 sw_if_index, u8 enable_disable)
1140 return ip4_sv_reass_enable_disable_with_refcnt (sw_if_index,
1143 #endif /* CLIB_MARCH_VARIANT */
1146 #define foreach_ip4_sv_reass_handoff_error \
1147 _(CONGESTION_DROP, "congestion drop")
1152 #define _(sym,str) IP4_SV_REASSEMBLY_HANDOFF_ERROR_##sym,
1153 foreach_ip4_sv_reass_handoff_error
1155 IP4_SV_REASSEMBLY_HANDOFF_N_ERROR,
1156 } ip4_sv_reass_handoff_error_t;
1158 static char *ip4_sv_reass_handoff_error_strings[] = {
1159 #define _(sym,string) string,
1160 foreach_ip4_sv_reass_handoff_error
1166 u32 next_worker_index;
1167 } ip4_sv_reass_handoff_trace_t;
1170 format_ip4_sv_reass_handoff_trace (u8 * s, va_list * args)
1172 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
1173 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
1174 ip4_sv_reass_handoff_trace_t *t =
1175 va_arg (*args, ip4_sv_reass_handoff_trace_t *);
1178 format (s, "ip4-sv-reassembly-handoff: next-worker %d",
1179 t->next_worker_index);
1185 ip4_sv_reass_handoff_node_inline (vlib_main_t * vm,
1186 vlib_node_runtime_t * node,
1187 vlib_frame_t * frame, bool is_feature)
1189 ip4_sv_reass_main_t *rm = &ip4_sv_reass_main;
1191 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
1192 u32 n_enq, n_left_from, *from;
1193 u16 thread_indices[VLIB_FRAME_SIZE], *ti;
1196 from = vlib_frame_vector_args (frame);
1197 n_left_from = frame->n_vectors;
1198 vlib_get_buffers (vm, from, bufs, n_left_from);
1201 ti = thread_indices;
1203 fq_index = (is_feature) ? rm->fq_feature_index : rm->fq_index;
1205 while (n_left_from > 0)
1207 ti[0] = vnet_buffer (b[0])->ip.reass.owner_thread_index;
1210 ((node->flags & VLIB_NODE_FLAG_TRACE)
1211 && (b[0]->flags & VLIB_BUFFER_IS_TRACED)))
1213 ip4_sv_reass_handoff_trace_t *t =
1214 vlib_add_trace (vm, node, b[0], sizeof (*t));
1215 t->next_worker_index = ti[0];
1223 vlib_buffer_enqueue_to_thread (vm, fq_index, from, thread_indices,
1224 frame->n_vectors, 1);
1226 if (n_enq < frame->n_vectors)
1227 vlib_node_increment_counter (vm, node->node_index,
1228 IP4_SV_REASSEMBLY_HANDOFF_ERROR_CONGESTION_DROP,
1229 frame->n_vectors - n_enq);
1230 return frame->n_vectors;
1233 VLIB_NODE_FN (ip4_sv_reass_handoff_node) (vlib_main_t * vm,
1234 vlib_node_runtime_t * node,
1235 vlib_frame_t * frame)
1237 return ip4_sv_reass_handoff_node_inline (vm, node, frame,
1238 false /* is_feature */ );
1243 VLIB_REGISTER_NODE (ip4_sv_reass_handoff_node) = {
1244 .name = "ip4-sv-reassembly-handoff",
1245 .vector_size = sizeof (u32),
1246 .n_errors = ARRAY_LEN(ip4_sv_reass_handoff_error_strings),
1247 .error_strings = ip4_sv_reass_handoff_error_strings,
1248 .format_trace = format_ip4_sv_reass_handoff_trace,
1260 VLIB_NODE_FN (ip4_sv_reass_feature_handoff_node) (vlib_main_t * vm,
1261 vlib_node_runtime_t *
1263 vlib_frame_t * frame)
1265 return ip4_sv_reass_handoff_node_inline (vm, node, frame,
1266 true /* is_feature */ );
1272 VLIB_REGISTER_NODE (ip4_sv_reass_feature_handoff_node) = {
1273 .name = "ip4-sv-reass-feature-hoff",
1274 .vector_size = sizeof (u32),
1275 .n_errors = ARRAY_LEN(ip4_sv_reass_handoff_error_strings),
1276 .error_strings = ip4_sv_reass_handoff_error_strings,
1277 .format_trace = format_ip4_sv_reass_handoff_trace,
1287 #ifndef CLIB_MARCH_VARIANT
1289 ip4_sv_reass_enable_disable_with_refcnt (u32 sw_if_index, int is_enable)
1291 ip4_sv_reass_main_t *rm = &ip4_sv_reass_main;
1292 vec_validate (rm->feature_use_refcount_per_intf, sw_if_index);
1295 if (!rm->feature_use_refcount_per_intf[sw_if_index])
1297 ++rm->feature_use_refcount_per_intf[sw_if_index];
1298 return vnet_feature_enable_disable ("ip4-unicast",
1299 "ip4-sv-reassembly-feature",
1300 sw_if_index, 1, 0, 0);
1302 ++rm->feature_use_refcount_per_intf[sw_if_index];
1306 if (rm->feature_use_refcount_per_intf[sw_if_index])
1307 --rm->feature_use_refcount_per_intf[sw_if_index];
1308 if (!rm->feature_use_refcount_per_intf[sw_if_index])
1309 return vnet_feature_enable_disable ("ip4-unicast",
1310 "ip4-sv-reassembly-feature",
1311 sw_if_index, 0, 0, 0);
1317 ip4_sv_reass_custom_register_next_node (uword node_index)
1319 return vlib_node_add_next (vlib_get_main (), ip4_sv_reass_custom_node.index,
1324 ip4_sv_reass_output_enable_disable_with_refcnt (u32 sw_if_index,
1327 ip4_sv_reass_main_t *rm = &ip4_sv_reass_main;
1328 vec_validate (rm->output_feature_use_refcount_per_intf, sw_if_index);
1331 if (!rm->output_feature_use_refcount_per_intf[sw_if_index])
1333 ++rm->output_feature_use_refcount_per_intf[sw_if_index];
1334 return vnet_feature_enable_disable ("ip4-output",
1335 "ip4-sv-reassembly-output-feature",
1336 sw_if_index, 1, 0, 0);
1338 ++rm->output_feature_use_refcount_per_intf[sw_if_index];
1342 if (rm->output_feature_use_refcount_per_intf[sw_if_index])
1343 --rm->output_feature_use_refcount_per_intf[sw_if_index];
1344 if (!rm->output_feature_use_refcount_per_intf[sw_if_index])
1345 return vnet_feature_enable_disable ("ip4-output",
1346 "ip4-sv-reassembly-output-feature",
1347 sw_if_index, 0, 0, 0);
1354 * fd.io coding-style-patch-verification: ON
1357 * eval: (c-set-style "gnu")