f6e9e367af5e06976c9598b0e7b35f2a513f2f08
[vpp.git] / src / vnet / ip / reass / ip4_full_reass.c
1 /*
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:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15
16 /**
17  * @file
18  * @brief IPv4 Full Reassembly.
19  *
20  * This file contains the source code for IPv4 full reassembly.
21  */
22
23 #include <vppinfra/vec.h>
24 #include <vnet/vnet.h>
25 #include <vnet/ip/ip.h>
26 #include <vppinfra/fifo.h>
27 #include <vppinfra/bihash_16_8.h>
28 #include <vnet/ip/reass/ip4_full_reass.h>
29 #include <stddef.h>
30
31 #define MSEC_PER_SEC 1000
32 #define IP4_REASS_TIMEOUT_DEFAULT_MS 200
33
34 /* As there are only 1024 reass context per thread, either the DDOS attacks
35  * or fractions of real timeouts, would consume these contexts quickly and
36  * running out context space and unable to perform reassembly */
37 #define IP4_REASS_EXPIRE_WALK_INTERVAL_DEFAULT_MS 50 // 50 ms default
38 #define IP4_REASS_MAX_REASSEMBLIES_DEFAULT 1024
39 #define IP4_REASS_MAX_REASSEMBLY_LENGTH_DEFAULT   3
40 #define IP4_REASS_HT_LOAD_FACTOR (0.75)
41
42 #define IP4_REASS_DEBUG_BUFFERS 0
43 #if IP4_REASS_DEBUG_BUFFERS
44 #define IP4_REASS_DEBUG_BUFFER(bi, what)             \
45   do                                                 \
46     {                                                \
47       u32 _bi = bi;                                  \
48       printf (#what "buffer %u", _bi);               \
49       vlib_buffer_t *_b = vlib_get_buffer (vm, _bi); \
50       while (_b->flags & VLIB_BUFFER_NEXT_PRESENT)   \
51         {                                            \
52           _bi = _b->next_buffer;                     \
53           printf ("[%u]", _bi);                      \
54           _b = vlib_get_buffer (vm, _bi);            \
55         }                                            \
56       printf ("\n");                                 \
57       fflush (stdout);                               \
58     }                                                \
59   while (0)
60 #else
61 #define IP4_REASS_DEBUG_BUFFER(...)
62 #endif
63
64 typedef enum
65 {
66   IP4_REASS_RC_OK,
67   IP4_REASS_RC_TOO_MANY_FRAGMENTS,
68   IP4_REASS_RC_INTERNAL_ERROR,
69   IP4_REASS_RC_NO_BUF,
70   IP4_REASS_RC_HANDOFF,
71 } ip4_full_reass_rc_t;
72
73 typedef struct
74 {
75   union
76   {
77     struct
78     {
79       u32 xx_id;
80       ip4_address_t src;
81       ip4_address_t dst;
82       u16 frag_id;
83       u8 proto;
84       u8 unused;
85     };
86     u64 as_u64[2];
87   };
88 } ip4_full_reass_key_t;
89
90 typedef union
91 {
92   struct
93   {
94     u32 reass_index;
95     u32 memory_owner_thread_index;
96   };
97   u64 as_u64;
98 } ip4_full_reass_val_t;
99
100 typedef union
101 {
102   struct
103   {
104     ip4_full_reass_key_t k;
105     ip4_full_reass_val_t v;
106   };
107   clib_bihash_kv_16_8_t kv;
108 } ip4_full_reass_kv_t;
109
110 always_inline u32
111 ip4_full_reass_buffer_get_data_offset (vlib_buffer_t * b)
112 {
113   vnet_buffer_opaque_t *vnb = vnet_buffer (b);
114   return vnb->ip.reass.range_first - vnb->ip.reass.fragment_first;
115 }
116
117 always_inline u16
118 ip4_full_reass_buffer_get_data_len (vlib_buffer_t * b)
119 {
120   vnet_buffer_opaque_t *vnb = vnet_buffer (b);
121   return clib_min (vnb->ip.reass.range_last, vnb->ip.reass.fragment_last) -
122     (vnb->ip.reass.fragment_first +
123      ip4_full_reass_buffer_get_data_offset (b)) + 1;
124 }
125
126 typedef struct
127 {
128   // hash table key
129   ip4_full_reass_key_t key;
130   // time when last packet was received
131   f64 last_heard;
132   // internal id of this reassembly
133   u64 id;
134   // buffer index of first buffer in this reassembly context
135   u32 first_bi;
136   // last octet of packet, ~0 until fragment without more_fragments arrives
137   u32 last_packet_octet;
138   // length of data collected so far
139   u32 data_len;
140   // trace operation counter
141   u32 trace_op_counter;
142   // next index - used by non-feature node
143   u32 next_index;
144   // error next index - used by custom apps (~0 if not used)
145   u32 error_next_index;
146   // minimum fragment length for this reassembly - used to estimate MTU
147   u16 min_fragment_length;
148   // number of fragments in this reassembly
149   u32 fragments_n;
150   // thread owning memory for this context (whose pool contains this ctx)
151   u32 memory_owner_thread_index;
152   // thread which received fragment with offset 0 and which sends out the
153   // completed reassembly
154   u32 sendout_thread_index;
155 } ip4_full_reass_t;
156
157 typedef struct
158 {
159   ip4_full_reass_t *pool;
160   u32 reass_n;
161   u32 id_counter;
162   // for pacing the main thread timeouts
163   u32 last_id;
164   clib_spinlock_t lock;
165 } ip4_full_reass_per_thread_t;
166
167 typedef struct
168 {
169   // IPv4 config
170   u32 timeout_ms;
171   f64 timeout;
172   u32 expire_walk_interval_ms;
173   // maximum number of fragments in one reassembly
174   u32 max_reass_len;
175   // maximum number of reassemblies
176   u32 max_reass_n;
177
178   // IPv4 runtime
179   clib_bihash_16_8_t hash;
180   // per-thread data
181   ip4_full_reass_per_thread_t *per_thread_data;
182
183   // convenience
184   vlib_main_t *vlib_main;
185
186   u32 ip4_full_reass_expire_node_idx;
187
188   /** Worker handoff */
189   u32 fq_index;
190   u32 fq_local_index;
191   u32 fq_feature_index;
192   u32 fq_custom_index;
193
194   // reference count for enabling/disabling feature - per interface
195   u32 *feature_use_refcount_per_intf;
196
197   // whether local fragmented packets are reassembled or not
198   int is_local_reass_enabled;
199 } ip4_full_reass_main_t;
200
201 extern ip4_full_reass_main_t ip4_full_reass_main;
202
203 #ifndef CLIB_MARCH_VARIANT
204 ip4_full_reass_main_t ip4_full_reass_main;
205 #endif /* CLIB_MARCH_VARIANT */
206
207 typedef enum
208 {
209   IP4_FULL_REASS_NEXT_INPUT,
210   IP4_FULL_REASS_NEXT_DROP,
211   IP4_FULL_REASS_NEXT_HANDOFF,
212   IP4_FULL_REASS_N_NEXT,
213 } ip4_full_reass_next_t;
214
215 typedef enum
216 {
217   NORMAL,
218   FEATURE,
219   CUSTOM
220 } ip4_full_reass_node_type_t;
221
222 typedef enum
223 {
224   RANGE_NEW,
225   RANGE_SHRINK,
226   RANGE_DISCARD,
227   RANGE_OVERLAP,
228   FINALIZE,
229   HANDOFF,
230   PASSTHROUGH,
231 } ip4_full_reass_trace_operation_e;
232
233 typedef struct
234 {
235   u16 range_first;
236   u16 range_last;
237   u32 range_bi;
238   i32 data_offset;
239   u32 data_len;
240   u32 first_bi;
241 } ip4_full_reass_range_trace_t;
242
243 typedef struct
244 {
245   ip4_full_reass_trace_operation_e action;
246   u32 reass_id;
247   ip4_full_reass_range_trace_t trace_range;
248   u32 size_diff;
249   u32 op_id;
250   u32 thread_id;
251   u32 thread_id_to;
252   u32 fragment_first;
253   u32 fragment_last;
254   u32 total_data_len;
255   bool is_after_handoff;
256   ip4_header_t ip4_header;
257 } ip4_full_reass_trace_t;
258
259 extern vlib_node_registration_t ip4_full_reass_node;
260 extern vlib_node_registration_t ip4_full_reass_node_feature;
261 extern vlib_node_registration_t ip4_full_reass_node_custom;
262
263 static void
264 ip4_full_reass_trace_details (vlib_main_t * vm, u32 bi,
265                               ip4_full_reass_range_trace_t * trace)
266 {
267   vlib_buffer_t *b = vlib_get_buffer (vm, bi);
268   vnet_buffer_opaque_t *vnb = vnet_buffer (b);
269   trace->range_first = vnb->ip.reass.range_first;
270   trace->range_last = vnb->ip.reass.range_last;
271   trace->data_offset = ip4_full_reass_buffer_get_data_offset (b);
272   trace->data_len = ip4_full_reass_buffer_get_data_len (b);
273   trace->range_bi = bi;
274 }
275
276 static u8 *
277 format_ip4_full_reass_range_trace (u8 * s, va_list * args)
278 {
279   ip4_full_reass_range_trace_t *trace =
280     va_arg (*args, ip4_full_reass_range_trace_t *);
281   s =
282     format (s, "range: [%u, %u], off %d, len %u, bi %u", trace->range_first,
283             trace->range_last, trace->data_offset, trace->data_len,
284             trace->range_bi);
285   return s;
286 }
287
288 static u8 *
289 format_ip4_full_reass_trace (u8 * s, va_list * args)
290 {
291   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
292   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
293   ip4_full_reass_trace_t *t = va_arg (*args, ip4_full_reass_trace_t *);
294   u32 indent = 0;
295   if (~0 != t->reass_id)
296     {
297       if (t->is_after_handoff)
298         {
299           s =
300             format (s, "%U\n", format_ip4_header, &t->ip4_header,
301                     sizeof (t->ip4_header));
302           indent = 2;
303         }
304       s =
305         format (s, "%Ureass id: %u, op id: %u, ", format_white_space, indent,
306                 t->reass_id, t->op_id);
307       indent = format_get_indent (s);
308       s =
309         format (s,
310                 "first bi: %u, data len: %u, ip/fragment[%u, %u]",
311                 t->trace_range.first_bi, t->total_data_len, t->fragment_first,
312                 t->fragment_last);
313     }
314   switch (t->action)
315     {
316     case RANGE_SHRINK:
317       s = format (s, "\n%Ushrink %U by %u", format_white_space, indent,
318                   format_ip4_full_reass_range_trace, &t->trace_range,
319                   t->size_diff);
320       break;
321     case RANGE_DISCARD:
322       s = format (s, "\n%Udiscard %U", format_white_space, indent,
323                   format_ip4_full_reass_range_trace, &t->trace_range);
324       break;
325     case RANGE_NEW:
326       s = format (s, "\n%Unew %U", format_white_space, indent,
327                   format_ip4_full_reass_range_trace, &t->trace_range);
328       break;
329     case RANGE_OVERLAP:
330       s = format (s, "\n%Uoverlapping/ignored %U", format_white_space, indent,
331                   format_ip4_full_reass_range_trace, &t->trace_range);
332       break;
333     case FINALIZE:
334       s = format (s, "\n%Ufinalize reassembly", format_white_space, indent);
335       break;
336     case HANDOFF:
337       s =
338         format (s, "handoff from thread #%u to thread #%u", t->thread_id,
339                 t->thread_id_to);
340       break;
341     case PASSTHROUGH:
342       s = format (s, "passthrough - not a fragment");
343       break;
344     }
345   return s;
346 }
347
348 static void
349 ip4_full_reass_add_trace (vlib_main_t * vm, vlib_node_runtime_t * node,
350                           ip4_full_reass_t * reass, u32 bi,
351                           ip4_full_reass_trace_operation_e action,
352                           u32 size_diff, u32 thread_id_to)
353 {
354   vlib_buffer_t *b = vlib_get_buffer (vm, bi);
355   vnet_buffer_opaque_t *vnb = vnet_buffer (b);
356   if (pool_is_free_index
357       (vm->trace_main.trace_buffer_pool, vlib_buffer_get_trace_index (b)))
358     {
359       // this buffer's trace is gone
360       b->flags &= ~VLIB_BUFFER_IS_TRACED;
361       return;
362     }
363   bool is_after_handoff = false;
364   if (vlib_buffer_get_trace_thread (b) != vm->thread_index)
365     {
366       is_after_handoff = true;
367     }
368   ip4_full_reass_trace_t *t = vlib_add_trace (vm, node, b, sizeof (t[0]));
369   t->is_after_handoff = is_after_handoff;
370   if (t->is_after_handoff)
371     {
372       clib_memcpy (&t->ip4_header, vlib_buffer_get_current (b),
373                    clib_min (sizeof (t->ip4_header), b->current_length));
374     }
375   if (reass)
376     {
377       t->reass_id = reass->id;
378       t->op_id = reass->trace_op_counter;
379       t->trace_range.first_bi = reass->first_bi;
380       t->total_data_len = reass->data_len;
381       ++reass->trace_op_counter;
382     }
383   else
384     {
385       t->reass_id = ~0;
386       t->op_id = 0;
387       t->trace_range.first_bi = 0;
388       t->total_data_len = 0;
389     }
390   t->action = action;
391   ip4_full_reass_trace_details (vm, bi, &t->trace_range);
392   t->size_diff = size_diff;
393   t->thread_id = vm->thread_index;
394   t->thread_id_to = thread_id_to;
395   t->fragment_first = vnb->ip.reass.fragment_first;
396   t->fragment_last = vnb->ip.reass.fragment_last;
397 #if 0
398   static u8 *s = NULL;
399   s = format (s, "%U", format_ip4_full_reass_trace, NULL, NULL, t);
400   printf ("%.*s\n", vec_len (s), s);
401   fflush (stdout);
402   vec_reset_length (s);
403 #endif
404 }
405
406 always_inline void
407 ip4_full_reass_free_ctx (ip4_full_reass_per_thread_t * rt,
408                          ip4_full_reass_t * reass)
409 {
410   pool_put (rt->pool, reass);
411   --rt->reass_n;
412 }
413
414 always_inline void
415 ip4_full_reass_free (ip4_full_reass_main_t * rm,
416                      ip4_full_reass_per_thread_t * rt,
417                      ip4_full_reass_t * reass)
418 {
419   clib_bihash_kv_16_8_t kv;
420   kv.key[0] = reass->key.as_u64[0];
421   kv.key[1] = reass->key.as_u64[1];
422   clib_bihash_add_del_16_8 (&rm->hash, &kv, 0);
423   return ip4_full_reass_free_ctx (rt, reass);
424 }
425
426 /* n_left_to_next, and to_next are taken as input params, as this function
427  * could be called from a graphnode, where its managing local copy of these
428  * variables, and ignoring those and still trying to enqueue the buffers
429  * with local variables would cause either buffer leak or corruption */
430 always_inline void
431 ip4_full_reass_drop_all (vlib_main_t *vm, vlib_node_runtime_t *node,
432                          ip4_full_reass_t *reass, u32 *n_left_to_next,
433                          u32 **to_next)
434 {
435   u32 range_bi = reass->first_bi;
436   vlib_buffer_t *range_b;
437   vnet_buffer_opaque_t *range_vnb;
438   u32 *to_free = NULL;
439
440   while (~0 != range_bi)
441     {
442       range_b = vlib_get_buffer (vm, range_bi);
443       range_vnb = vnet_buffer (range_b);
444
445       if (~0 != range_bi)
446         {
447           vec_add1 (to_free, range_bi);
448         }
449
450       range_bi = range_vnb->ip.reass.next_range_bi;
451     }
452
453   /* send to next_error_index */
454   if (~0 != reass->error_next_index &&
455       reass->error_next_index < node->n_next_nodes)
456     {
457       u32 next_index;
458
459       next_index = reass->error_next_index;
460       u32 bi = ~0;
461
462       /* record number of packets sent to custom app */
463       vlib_node_increment_counter (vm, node->node_index,
464                                    IP4_ERROR_REASS_TO_CUSTOM_APP,
465                                    vec_len (to_free));
466
467       while (vec_len (to_free) > 0)
468         {
469           vlib_get_next_frame (vm, node, next_index, *to_next,
470                                (*n_left_to_next));
471
472           while (vec_len (to_free) > 0 && (*n_left_to_next) > 0)
473             {
474               bi = vec_pop (to_free);
475
476               if (~0 != bi)
477                 {
478                   vlib_buffer_t *b = vlib_get_buffer (vm, bi);
479                   if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
480                     {
481                       ip4_full_reass_add_trace (vm, node, reass, bi,
482                                                 RANGE_DISCARD, 0, ~0);
483                     }
484                   *to_next[0] = bi;
485                   (*to_next) += 1;
486                   (*n_left_to_next) -= 1;
487                 }
488             }
489           vlib_put_next_frame (vm, node, next_index, (*n_left_to_next));
490         }
491     }
492   else
493     {
494       vlib_buffer_free (vm, to_free, vec_len (to_free));
495     }
496   vec_free (to_free);
497 }
498
499 always_inline void
500 sanitize_reass_buffers_add_missing (vlib_main_t *vm, ip4_full_reass_t *reass,
501                                     u32 *bi0)
502 {
503   u32 range_bi = reass->first_bi;
504   vlib_buffer_t *range_b;
505   vnet_buffer_opaque_t *range_vnb;
506
507   while (~0 != range_bi)
508     {
509       range_b = vlib_get_buffer (vm, range_bi);
510       range_vnb = vnet_buffer (range_b);
511       u32 bi = range_bi;
512       if (~0 != bi)
513         {
514           if (bi == *bi0)
515             *bi0 = ~0;
516           if (range_b->flags & VLIB_BUFFER_NEXT_PRESENT)
517             {
518               u32 _bi = bi;
519               vlib_buffer_t *_b = vlib_get_buffer (vm, _bi);
520               while (_b->flags & VLIB_BUFFER_NEXT_PRESENT)
521                 {
522                   if (_b->next_buffer != range_vnb->ip.reass.next_range_bi)
523                     {
524                       _bi = _b->next_buffer;
525                       _b = vlib_get_buffer (vm, _bi);
526                     }
527                   else
528                     {
529                       _b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
530                       break;
531                     }
532                 }
533             }
534           range_bi = range_vnb->ip.reass.next_range_bi;
535         }
536     }
537   if (*bi0 != ~0)
538     {
539       vlib_buffer_t *fb = vlib_get_buffer (vm, *bi0);
540       vnet_buffer_opaque_t *fvnb = vnet_buffer (fb);
541       if (~0 != reass->first_bi)
542         {
543           fvnb->ip.reass.next_range_bi = reass->first_bi;
544           reass->first_bi = *bi0;
545         }
546       else
547         {
548           reass->first_bi = *bi0;
549           fvnb->ip.reass.next_range_bi = ~0;
550         }
551       *bi0 = ~0;
552     }
553 }
554
555 always_inline void
556 ip4_full_reass_init (ip4_full_reass_t * reass)
557 {
558   reass->first_bi = ~0;
559   reass->last_packet_octet = ~0;
560   reass->data_len = 0;
561   reass->next_index = ~0;
562   reass->error_next_index = ~0;
563 }
564
565 always_inline ip4_full_reass_t *
566 ip4_full_reass_find_or_create (vlib_main_t *vm, vlib_node_runtime_t *node,
567                                ip4_full_reass_main_t *rm,
568                                ip4_full_reass_per_thread_t *rt,
569                                ip4_full_reass_kv_t *kv, u8 *do_handoff,
570                                u32 *n_left_to_next, u32 **to_next)
571 {
572   ip4_full_reass_t *reass;
573   f64 now;
574
575 again:
576
577   reass = NULL;
578   now = vlib_time_now (vm);
579   if (!clib_bihash_search_16_8 (&rm->hash, &kv->kv, &kv->kv))
580     {
581       if (vm->thread_index != kv->v.memory_owner_thread_index)
582         {
583           *do_handoff = 1;
584           return NULL;
585         }
586       reass =
587         pool_elt_at_index (rm->per_thread_data
588                            [kv->v.memory_owner_thread_index].pool,
589                            kv->v.reass_index);
590
591       if (now > reass->last_heard + rm->timeout)
592         {
593           vlib_node_increment_counter (vm, node->node_index,
594                                        IP4_ERROR_REASS_TIMEOUT, 1);
595           ip4_full_reass_drop_all (vm, node, reass, n_left_to_next, to_next);
596           ip4_full_reass_free (rm, rt, reass);
597           reass = NULL;
598         }
599     }
600
601   if (reass)
602     {
603       reass->last_heard = now;
604       return reass;
605     }
606
607   if (rt->reass_n >= rm->max_reass_n)
608     {
609       reass = NULL;
610       return reass;
611     }
612   else
613     {
614       pool_get (rt->pool, reass);
615       clib_memset (reass, 0, sizeof (*reass));
616       reass->id = ((u64) vm->thread_index * 1000000000) + rt->id_counter;
617       reass->memory_owner_thread_index = vm->thread_index;
618       ++rt->id_counter;
619       ip4_full_reass_init (reass);
620       ++rt->reass_n;
621     }
622
623   reass->key.as_u64[0] = kv->kv.key[0];
624   reass->key.as_u64[1] = kv->kv.key[1];
625   kv->v.reass_index = (reass - rt->pool);
626   kv->v.memory_owner_thread_index = vm->thread_index;
627   reass->last_heard = now;
628
629   int rv = clib_bihash_add_del_16_8 (&rm->hash, &kv->kv, 2);
630   if (rv)
631     {
632       ip4_full_reass_free_ctx (rt, reass);
633       reass = NULL;
634       // if other worker created a context already work with the other copy
635       if (-2 == rv)
636         goto again;
637     }
638
639   return reass;
640 }
641
642 always_inline ip4_full_reass_rc_t
643 ip4_full_reass_finalize (vlib_main_t * vm, vlib_node_runtime_t * node,
644                          ip4_full_reass_main_t * rm,
645                          ip4_full_reass_per_thread_t * rt,
646                          ip4_full_reass_t * reass, u32 * bi0,
647                          u32 * next0, u32 * error0, bool is_custom)
648 {
649   vlib_buffer_t *first_b = vlib_get_buffer (vm, reass->first_bi);
650   vlib_buffer_t *last_b = NULL;
651   u32 sub_chain_bi = reass->first_bi;
652   u32 total_length = 0;
653   u32 buf_cnt = 0;
654   do
655     {
656       u32 tmp_bi = sub_chain_bi;
657       vlib_buffer_t *tmp = vlib_get_buffer (vm, tmp_bi);
658       ip4_header_t *ip = vlib_buffer_get_current (tmp);
659       vnet_buffer_opaque_t *vnb = vnet_buffer (tmp);
660       if (!(vnb->ip.reass.range_first >= vnb->ip.reass.fragment_first) &&
661           !(vnb->ip.reass.range_last > vnb->ip.reass.fragment_first))
662         {
663           return IP4_REASS_RC_INTERNAL_ERROR;
664         }
665
666       u32 data_len = ip4_full_reass_buffer_get_data_len (tmp);
667       u32 trim_front =
668         ip4_header_bytes (ip) + ip4_full_reass_buffer_get_data_offset (tmp);
669       u32 trim_end =
670         vlib_buffer_length_in_chain (vm, tmp) - trim_front - data_len;
671       if (tmp_bi == reass->first_bi)
672         {
673           /* first buffer - keep ip4 header */
674           if (0 != ip4_full_reass_buffer_get_data_offset (tmp))
675             {
676               return IP4_REASS_RC_INTERNAL_ERROR;
677             }
678           trim_front = 0;
679           trim_end = vlib_buffer_length_in_chain (vm, tmp) - data_len -
680             ip4_header_bytes (ip);
681           if (!(vlib_buffer_length_in_chain (vm, tmp) - trim_end > 0))
682             {
683               return IP4_REASS_RC_INTERNAL_ERROR;
684             }
685         }
686       u32 keep_data =
687         vlib_buffer_length_in_chain (vm, tmp) - trim_front - trim_end;
688       while (1)
689         {
690           ++buf_cnt;
691           if (trim_front)
692             {
693               if (trim_front > tmp->current_length)
694                 {
695                   /* drop whole buffer */
696                   u32 to_be_freed_bi = tmp_bi;
697                   trim_front -= tmp->current_length;
698                   if (!(tmp->flags & VLIB_BUFFER_NEXT_PRESENT))
699                     {
700                       return IP4_REASS_RC_INTERNAL_ERROR;
701                     }
702                   tmp->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
703                   tmp_bi = tmp->next_buffer;
704                   tmp->next_buffer = 0;
705                   tmp = vlib_get_buffer (vm, tmp_bi);
706                   vlib_buffer_free_one (vm, to_be_freed_bi);
707                   continue;
708                 }
709               else
710                 {
711                   vlib_buffer_advance (tmp, trim_front);
712                   trim_front = 0;
713                 }
714             }
715           if (keep_data)
716             {
717               if (last_b)
718                 {
719                   last_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
720                   last_b->next_buffer = tmp_bi;
721                 }
722               last_b = tmp;
723               if (keep_data <= tmp->current_length)
724                 {
725                   tmp->current_length = keep_data;
726                   keep_data = 0;
727                 }
728               else
729                 {
730                   keep_data -= tmp->current_length;
731                   if (!(tmp->flags & VLIB_BUFFER_NEXT_PRESENT))
732                     {
733                       return IP4_REASS_RC_INTERNAL_ERROR;
734                     }
735                 }
736               total_length += tmp->current_length;
737               if (tmp->flags & VLIB_BUFFER_NEXT_PRESENT)
738                 {
739                   tmp_bi = tmp->next_buffer;
740                   tmp = vlib_get_buffer (vm, tmp->next_buffer);
741                 }
742               else
743                 {
744                   break;
745                 }
746             }
747           else
748             {
749               u32 to_be_freed_bi = tmp_bi;
750               if (reass->first_bi == tmp_bi)
751                 {
752                   return IP4_REASS_RC_INTERNAL_ERROR;
753                 }
754               if (tmp->flags & VLIB_BUFFER_NEXT_PRESENT)
755                 {
756                   tmp->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
757                   tmp_bi = tmp->next_buffer;
758                   tmp->next_buffer = 0;
759                   tmp = vlib_get_buffer (vm, tmp_bi);
760                   vlib_buffer_free_one (vm, to_be_freed_bi);
761                 }
762               else
763                 {
764                   tmp->next_buffer = 0;
765                   vlib_buffer_free_one (vm, to_be_freed_bi);
766                   break;
767                 }
768             }
769         }
770       sub_chain_bi =
771         vnet_buffer (vlib_get_buffer (vm, sub_chain_bi))->ip.
772         reass.next_range_bi;
773     }
774   while (~0 != sub_chain_bi);
775
776   if (!last_b)
777     {
778       return IP4_REASS_RC_INTERNAL_ERROR;
779     }
780   last_b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
781
782   if (total_length < first_b->current_length)
783     {
784       return IP4_REASS_RC_INTERNAL_ERROR;
785     }
786   total_length -= first_b->current_length;
787   first_b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
788   first_b->total_length_not_including_first_buffer = total_length;
789   ip4_header_t *ip = vlib_buffer_get_current (first_b);
790   ip->flags_and_fragment_offset = 0;
791   ip->length = clib_host_to_net_u16 (first_b->current_length + total_length);
792   ip->checksum = ip4_header_checksum (ip);
793   if (!vlib_buffer_chain_linearize (vm, first_b))
794     {
795       return IP4_REASS_RC_NO_BUF;
796     }
797   // reset to reconstruct the mbuf linking
798   first_b->flags &= ~VLIB_BUFFER_EXT_HDR_VALID;
799   if (PREDICT_FALSE (first_b->flags & VLIB_BUFFER_IS_TRACED))
800     {
801       ip4_full_reass_add_trace (vm, node, reass, reass->first_bi, FINALIZE, 0,
802                                 ~0);
803 #if 0
804       // following code does a hexdump of packet fragments to stdout ...
805       do
806         {
807           u32 bi = reass->first_bi;
808           u8 *s = NULL;
809           while (~0 != bi)
810             {
811               vlib_buffer_t *b = vlib_get_buffer (vm, bi);
812               s = format (s, "%u: %U\n", bi, format_hexdump,
813                           vlib_buffer_get_current (b), b->current_length);
814               if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
815                 {
816                   bi = b->next_buffer;
817                 }
818               else
819                 {
820                   break;
821                 }
822             }
823           printf ("%.*s\n", vec_len (s), s);
824           fflush (stdout);
825           vec_free (s);
826         }
827       while (0);
828 #endif
829     }
830   *bi0 = reass->first_bi;
831   if (!is_custom)
832     {
833       *next0 = IP4_FULL_REASS_NEXT_INPUT;
834     }
835   else
836     {
837       *next0 = reass->next_index;
838     }
839   vnet_buffer (first_b)->ip.reass.estimated_mtu = reass->min_fragment_length;
840
841   /* Keep track of number of successfully reassembled packets and number of
842    * fragments reassembled */
843   vlib_node_increment_counter (vm, node->node_index, IP4_ERROR_REASS_SUCCESS,
844                                1);
845
846   vlib_node_increment_counter (vm, node->node_index,
847                                IP4_ERROR_REASS_FRAGMENTS_REASSEMBLED,
848                                reass->fragments_n);
849
850   *error0 = IP4_ERROR_NONE;
851   ip4_full_reass_free (rm, rt, reass);
852   reass = NULL;
853   return IP4_REASS_RC_OK;
854 }
855
856 always_inline ip4_full_reass_rc_t
857 ip4_full_reass_insert_range_in_chain (vlib_main_t * vm,
858                                       ip4_full_reass_t * reass,
859                                       u32 prev_range_bi, u32 new_next_bi)
860 {
861   vlib_buffer_t *new_next_b = vlib_get_buffer (vm, new_next_bi);
862   vnet_buffer_opaque_t *new_next_vnb = vnet_buffer (new_next_b);
863   if (~0 != prev_range_bi)
864     {
865       vlib_buffer_t *prev_b = vlib_get_buffer (vm, prev_range_bi);
866       vnet_buffer_opaque_t *prev_vnb = vnet_buffer (prev_b);
867       new_next_vnb->ip.reass.next_range_bi = prev_vnb->ip.reass.next_range_bi;
868       prev_vnb->ip.reass.next_range_bi = new_next_bi;
869     }
870   else
871     {
872       if (~0 != reass->first_bi)
873         {
874           new_next_vnb->ip.reass.next_range_bi = reass->first_bi;
875         }
876       reass->first_bi = new_next_bi;
877     }
878   vnet_buffer_opaque_t *vnb = vnet_buffer (new_next_b);
879   if (!(vnb->ip.reass.range_first >= vnb->ip.reass.fragment_first) &&
880       !(vnb->ip.reass.range_last > vnb->ip.reass.fragment_first))
881     {
882       return IP4_REASS_RC_INTERNAL_ERROR;
883     }
884   reass->data_len += ip4_full_reass_buffer_get_data_len (new_next_b);
885   return IP4_REASS_RC_OK;
886 }
887
888 always_inline ip4_full_reass_rc_t
889 ip4_full_reass_remove_range_from_chain (vlib_main_t * vm,
890                                         vlib_node_runtime_t * node,
891                                         ip4_full_reass_t * reass,
892                                         u32 prev_range_bi, u32 discard_bi)
893 {
894   vlib_buffer_t *discard_b = vlib_get_buffer (vm, discard_bi);
895   vnet_buffer_opaque_t *discard_vnb = vnet_buffer (discard_b);
896   if (~0 != prev_range_bi)
897     {
898       vlib_buffer_t *prev_b = vlib_get_buffer (vm, prev_range_bi);
899       vnet_buffer_opaque_t *prev_vnb = vnet_buffer (prev_b);
900       if (!(prev_vnb->ip.reass.next_range_bi == discard_bi))
901         {
902           return IP4_REASS_RC_INTERNAL_ERROR;
903         }
904       prev_vnb->ip.reass.next_range_bi = discard_vnb->ip.reass.next_range_bi;
905     }
906   else
907     {
908       reass->first_bi = discard_vnb->ip.reass.next_range_bi;
909     }
910   vnet_buffer_opaque_t *vnb = vnet_buffer (discard_b);
911   if (!(vnb->ip.reass.range_first >= vnb->ip.reass.fragment_first) &&
912       !(vnb->ip.reass.range_last > vnb->ip.reass.fragment_first))
913     {
914       return IP4_REASS_RC_INTERNAL_ERROR;
915     }
916   reass->data_len -= ip4_full_reass_buffer_get_data_len (discard_b);
917   while (1)
918     {
919       u32 to_be_freed_bi = discard_bi;
920       if (PREDICT_FALSE (discard_b->flags & VLIB_BUFFER_IS_TRACED))
921         {
922           ip4_full_reass_add_trace (vm, node, reass, discard_bi, RANGE_DISCARD,
923                                     0, ~0);
924         }
925       if (discard_b->flags & VLIB_BUFFER_NEXT_PRESENT)
926         {
927           discard_b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
928           discard_bi = discard_b->next_buffer;
929           discard_b->next_buffer = 0;
930           discard_b = vlib_get_buffer (vm, discard_bi);
931           vlib_buffer_free_one (vm, to_be_freed_bi);
932         }
933       else
934         {
935           discard_b->next_buffer = 0;
936           vlib_buffer_free_one (vm, to_be_freed_bi);
937           break;
938         }
939     }
940   return IP4_REASS_RC_OK;
941 }
942
943 always_inline ip4_full_reass_rc_t
944 ip4_full_reass_update (vlib_main_t * vm, vlib_node_runtime_t * node,
945                        ip4_full_reass_main_t * rm,
946                        ip4_full_reass_per_thread_t * rt,
947                        ip4_full_reass_t * reass, u32 * bi0, u32 * next0,
948                        u32 * error0, bool is_custom, u32 * handoff_thread_idx)
949 {
950   vlib_buffer_t *fb = vlib_get_buffer (vm, *bi0);
951   vnet_buffer_opaque_t *fvnb = vnet_buffer (fb);
952   if (is_custom)
953     {
954       // store (error_)next_index before it's overwritten
955       reass->next_index = fvnb->ip.reass.next_index;
956       reass->error_next_index = fvnb->ip.reass.error_next_index;
957     }
958   ip4_full_reass_rc_t rc = IP4_REASS_RC_OK;
959   int consumed = 0;
960   ip4_header_t *fip = vlib_buffer_get_current (fb);
961   const u32 fragment_first = ip4_get_fragment_offset_bytes (fip);
962   const u32 fragment_length =
963     clib_net_to_host_u16 (fip->length) - ip4_header_bytes (fip);
964   const u32 fragment_last = fragment_first + fragment_length - 1;
965   fvnb->ip.reass.fragment_first = fragment_first;
966   fvnb->ip.reass.fragment_last = fragment_last;
967   int more_fragments = ip4_get_fragment_more (fip);
968   u32 candidate_range_bi = reass->first_bi;
969   u32 prev_range_bi = ~0;
970   fvnb->ip.reass.range_first = fragment_first;
971   fvnb->ip.reass.range_last = fragment_last;
972   fvnb->ip.reass.next_range_bi = ~0;
973   if (!more_fragments)
974     {
975       reass->last_packet_octet = fragment_last;
976     }
977   if (~0 == reass->first_bi)
978     {
979       // starting a new reassembly
980       rc =
981         ip4_full_reass_insert_range_in_chain (vm, reass, prev_range_bi, *bi0);
982       if (IP4_REASS_RC_OK != rc)
983         {
984           return rc;
985         }
986       if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
987         {
988           ip4_full_reass_add_trace (vm, node, reass, *bi0, RANGE_NEW, 0, ~0);
989         }
990       *bi0 = ~0;
991       reass->min_fragment_length = clib_net_to_host_u16 (fip->length);
992       reass->fragments_n = 1;
993       return IP4_REASS_RC_OK;
994     }
995   reass->min_fragment_length =
996     clib_min (clib_net_to_host_u16 (fip->length),
997               fvnb->ip.reass.estimated_mtu);
998   while (~0 != candidate_range_bi)
999     {
1000       vlib_buffer_t *candidate_b = vlib_get_buffer (vm, candidate_range_bi);
1001       vnet_buffer_opaque_t *candidate_vnb = vnet_buffer (candidate_b);
1002       if (fragment_first > candidate_vnb->ip.reass.range_last)
1003         {
1004           // this fragments starts after candidate range
1005           prev_range_bi = candidate_range_bi;
1006           candidate_range_bi = candidate_vnb->ip.reass.next_range_bi;
1007           if (candidate_vnb->ip.reass.range_last < fragment_last &&
1008               ~0 == candidate_range_bi)
1009             {
1010               // special case - this fragment falls beyond all known ranges
1011               rc = ip4_full_reass_insert_range_in_chain (vm, reass,
1012                                                          prev_range_bi, *bi0);
1013               if (IP4_REASS_RC_OK != rc)
1014                 {
1015                   return rc;
1016                 }
1017               consumed = 1;
1018               break;
1019             }
1020           continue;
1021         }
1022       if (fragment_last < candidate_vnb->ip.reass.range_first)
1023         {
1024           // this fragment ends before candidate range without any overlap
1025           rc = ip4_full_reass_insert_range_in_chain (vm, reass, prev_range_bi,
1026                                                      *bi0);
1027           if (IP4_REASS_RC_OK != rc)
1028             {
1029               return rc;
1030             }
1031           consumed = 1;
1032         }
1033       else
1034         {
1035           if (fragment_first >= candidate_vnb->ip.reass.range_first &&
1036               fragment_last <= candidate_vnb->ip.reass.range_last)
1037             {
1038               // this fragment is a (sub)part of existing range, ignore it
1039               if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
1040                 {
1041                   ip4_full_reass_add_trace (vm, node, reass, *bi0,
1042                                             RANGE_OVERLAP, 0, ~0);
1043                 }
1044               break;
1045             }
1046           int discard_candidate = 0;
1047           if (fragment_first < candidate_vnb->ip.reass.range_first)
1048             {
1049               u32 overlap =
1050                 fragment_last - candidate_vnb->ip.reass.range_first + 1;
1051               if (overlap < ip4_full_reass_buffer_get_data_len (candidate_b))
1052                 {
1053                   candidate_vnb->ip.reass.range_first += overlap;
1054                   if (reass->data_len < overlap)
1055                     {
1056                       return IP4_REASS_RC_INTERNAL_ERROR;
1057                     }
1058                   reass->data_len -= overlap;
1059                   if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
1060                     {
1061                       ip4_full_reass_add_trace (vm, node, reass,
1062                                                 candidate_range_bi,
1063                                                 RANGE_SHRINK, 0, ~0);
1064                     }
1065                   rc = ip4_full_reass_insert_range_in_chain (
1066                     vm, reass, prev_range_bi, *bi0);
1067                   if (IP4_REASS_RC_OK != rc)
1068                     {
1069                       return rc;
1070                     }
1071                   consumed = 1;
1072                 }
1073               else
1074                 {
1075                   discard_candidate = 1;
1076                 }
1077             }
1078           else if (fragment_last > candidate_vnb->ip.reass.range_last)
1079             {
1080               u32 overlap =
1081                 candidate_vnb->ip.reass.range_last - fragment_first + 1;
1082               if (overlap < ip4_full_reass_buffer_get_data_len (candidate_b))
1083                 {
1084                   fvnb->ip.reass.range_first += overlap;
1085                   if (~0 != candidate_vnb->ip.reass.next_range_bi)
1086                     {
1087                       prev_range_bi = candidate_range_bi;
1088                       candidate_range_bi =
1089                         candidate_vnb->ip.reass.next_range_bi;
1090                       continue;
1091                     }
1092                   else
1093                     {
1094                       // special case - last range discarded
1095                       rc = ip4_full_reass_insert_range_in_chain (
1096                         vm, reass, candidate_range_bi, *bi0);
1097                       if (IP4_REASS_RC_OK != rc)
1098                         {
1099                           return rc;
1100                         }
1101                       consumed = 1;
1102                     }
1103                 }
1104               else
1105                 {
1106                   discard_candidate = 1;
1107                 }
1108             }
1109           else
1110             {
1111               discard_candidate = 1;
1112             }
1113           if (discard_candidate)
1114             {
1115               u32 next_range_bi = candidate_vnb->ip.reass.next_range_bi;
1116               // discard candidate range, probe next range
1117               rc = ip4_full_reass_remove_range_from_chain (
1118                 vm, node, reass, prev_range_bi, candidate_range_bi);
1119               if (IP4_REASS_RC_OK != rc)
1120                 {
1121                   return rc;
1122                 }
1123               if (~0 != next_range_bi)
1124                 {
1125                   candidate_range_bi = next_range_bi;
1126                   continue;
1127                 }
1128               else
1129                 {
1130                   // special case - last range discarded
1131                   rc = ip4_full_reass_insert_range_in_chain (
1132                     vm, reass, prev_range_bi, *bi0);
1133                   if (IP4_REASS_RC_OK != rc)
1134                     {
1135                       return rc;
1136                     }
1137                   consumed = 1;
1138                 }
1139             }
1140         }
1141       break;
1142     }
1143   ++reass->fragments_n;
1144   if (consumed)
1145     {
1146       if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
1147         {
1148           ip4_full_reass_add_trace (vm, node, reass, *bi0, RANGE_NEW, 0, ~0);
1149         }
1150     }
1151   if (~0 != reass->last_packet_octet &&
1152       reass->data_len == reass->last_packet_octet + 1)
1153     {
1154       *handoff_thread_idx = reass->sendout_thread_index;
1155       int handoff =
1156         reass->memory_owner_thread_index != reass->sendout_thread_index;
1157       rc =
1158         ip4_full_reass_finalize (vm, node, rm, rt, reass, bi0, next0, error0,
1159                                  is_custom);
1160       if (IP4_REASS_RC_OK == rc && handoff)
1161         {
1162           rc = IP4_REASS_RC_HANDOFF;
1163         }
1164     }
1165   else
1166     {
1167       if (consumed)
1168         {
1169           *bi0 = ~0;
1170           if (reass->fragments_n > rm->max_reass_len)
1171             {
1172               rc = IP4_REASS_RC_TOO_MANY_FRAGMENTS;
1173             }
1174         }
1175       else
1176         {
1177           *next0 = IP4_FULL_REASS_NEXT_DROP;
1178           *error0 = IP4_ERROR_REASS_DUPLICATE_FRAGMENT;
1179         }
1180     }
1181   return rc;
1182 }
1183
1184 always_inline uword
1185 ip4_full_reass_inline (vlib_main_t *vm, vlib_node_runtime_t *node,
1186                        vlib_frame_t *frame, ip4_full_reass_node_type_t type,
1187                        bool is_local)
1188 {
1189   u32 *from = vlib_frame_vector_args (frame);
1190   u32 n_left_from, n_left_to_next, *to_next, next_index;
1191   ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1192   ip4_full_reass_per_thread_t *rt = &rm->per_thread_data[vm->thread_index];
1193   clib_spinlock_lock (&rt->lock);
1194
1195   n_left_from = frame->n_vectors;
1196   next_index = node->cached_next_index;
1197   while (n_left_from > 0)
1198     {
1199       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
1200
1201       while (n_left_from > 0 && n_left_to_next > 0)
1202         {
1203           u32 bi0;
1204           vlib_buffer_t *b0;
1205           u32 next0;
1206           u32 error0 = IP4_ERROR_NONE;
1207
1208           bi0 = from[0];
1209           b0 = vlib_get_buffer (vm, bi0);
1210
1211           ip4_header_t *ip0 = vlib_buffer_get_current (b0);
1212           if (!ip4_get_fragment_more (ip0) && !ip4_get_fragment_offset (ip0))
1213             {
1214               // this is a whole packet - no fragmentation
1215               if (CUSTOM != type)
1216                 {
1217                   next0 = IP4_FULL_REASS_NEXT_INPUT;
1218                 }
1219               else
1220                 {
1221                   next0 = vnet_buffer (b0)->ip.reass.next_index;
1222                 }
1223               ip4_full_reass_add_trace (vm, node, NULL, bi0, PASSTHROUGH, 0,
1224                                         ~0);
1225               goto packet_enqueue;
1226             }
1227
1228           if (is_local && !rm->is_local_reass_enabled)
1229             {
1230               next0 = IP4_FULL_REASS_NEXT_DROP;
1231               goto packet_enqueue;
1232             }
1233
1234           const u32 fragment_first = ip4_get_fragment_offset_bytes (ip0);
1235           const u32 fragment_length =
1236             clib_net_to_host_u16 (ip0->length) - ip4_header_bytes (ip0);
1237           const u32 fragment_last = fragment_first + fragment_length - 1;
1238
1239           /* Keep track of received fragments */
1240           vlib_node_increment_counter (vm, node->node_index,
1241                                        IP4_ERROR_REASS_FRAGMENTS_RCVD, 1);
1242
1243           if (fragment_first > fragment_last ||
1244               fragment_first + fragment_length > UINT16_MAX - 20 ||
1245               (fragment_length < 8 && // 8 is minimum frag length per RFC 791
1246                ip4_get_fragment_more (ip0)))
1247             {
1248               next0 = IP4_FULL_REASS_NEXT_DROP;
1249               error0 = IP4_ERROR_REASS_MALFORMED_PACKET;
1250               goto packet_enqueue;
1251             }
1252           ip4_full_reass_kv_t kv;
1253           u8 do_handoff = 0;
1254
1255           kv.k.as_u64[0] =
1256             (u64) vec_elt (ip4_main.fib_index_by_sw_if_index,
1257                            vnet_buffer (b0)->sw_if_index[VLIB_RX]) |
1258             (u64) ip0->src_address.as_u32 << 32;
1259           kv.k.as_u64[1] =
1260             (u64) ip0->dst_address.
1261             as_u32 | (u64) ip0->fragment_id << 32 | (u64) ip0->protocol << 48;
1262
1263           ip4_full_reass_t *reass = ip4_full_reass_find_or_create (
1264             vm, node, rm, rt, &kv, &do_handoff, &n_left_to_next, &to_next);
1265
1266           if (reass)
1267             {
1268               const u32 fragment_first = ip4_get_fragment_offset_bytes (ip0);
1269               if (0 == fragment_first)
1270                 {
1271                   reass->sendout_thread_index = vm->thread_index;
1272                 }
1273             }
1274
1275           if (PREDICT_FALSE (do_handoff))
1276             {
1277               next0 = IP4_FULL_REASS_NEXT_HANDOFF;
1278               vnet_buffer (b0)->ip.reass.owner_thread_index =
1279                 kv.v.memory_owner_thread_index;
1280             }
1281           else if (reass)
1282             {
1283               u32 handoff_thread_idx;
1284               u32 counter = ~0;
1285               switch (ip4_full_reass_update
1286                       (vm, node, rm, rt, reass, &bi0, &next0,
1287                        &error0, CUSTOM == type, &handoff_thread_idx))
1288                 {
1289                 case IP4_REASS_RC_OK:
1290                   /* nothing to do here */
1291                   break;
1292                 case IP4_REASS_RC_HANDOFF:
1293                   next0 = IP4_FULL_REASS_NEXT_HANDOFF;
1294                   b0 = vlib_get_buffer (vm, bi0);
1295                   vnet_buffer (b0)->ip.reass.owner_thread_index =
1296                     handoff_thread_idx;
1297                   break;
1298                 case IP4_REASS_RC_TOO_MANY_FRAGMENTS:
1299                   counter = IP4_ERROR_REASS_FRAGMENT_CHAIN_TOO_LONG;
1300                   break;
1301                 case IP4_REASS_RC_NO_BUF:
1302                   counter = IP4_ERROR_REASS_NO_BUF;
1303                   break;
1304                 case IP4_REASS_RC_INTERNAL_ERROR:
1305                   counter = IP4_ERROR_REASS_INTERNAL_ERROR;
1306                   /* Sanitization is needed in internal error cases only, as
1307                    * the incoming packet is already dropped in other cases,
1308                    * also adding bi0 back to the reassembly list, fixes the
1309                    * leaking of buffers during internal errors.
1310                    *
1311                    * Also it doesnt make sense to send these buffers custom
1312                    * app, these fragments are with internal errors */
1313                   sanitize_reass_buffers_add_missing (vm, reass, &bi0);
1314                   reass->error_next_index = ~0;
1315                   break;
1316                 }
1317
1318               if (~0 != counter)
1319                 {
1320                   vlib_node_increment_counter (vm, node->node_index, counter,
1321                                                1);
1322                   ip4_full_reass_drop_all (vm, node, reass, &n_left_to_next,
1323                                            &to_next);
1324                   ip4_full_reass_free (rm, rt, reass);
1325                   goto next_packet;
1326                 }
1327             }
1328           else
1329             {
1330               next0 = IP4_FULL_REASS_NEXT_DROP;
1331               error0 = IP4_ERROR_REASS_LIMIT_REACHED;
1332             }
1333
1334
1335         packet_enqueue:
1336
1337           if (bi0 != ~0)
1338             {
1339               to_next[0] = bi0;
1340               to_next += 1;
1341               n_left_to_next -= 1;
1342
1343               /* bi0 might have been updated by reass_finalize, reload */
1344               b0 = vlib_get_buffer (vm, bi0);
1345               if (IP4_ERROR_NONE != error0)
1346                 {
1347                   b0->error = node->errors[error0];
1348                 }
1349
1350               if (next0 == IP4_FULL_REASS_NEXT_HANDOFF)
1351                 {
1352                   if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
1353                     {
1354                       ip4_full_reass_add_trace (
1355                         vm, node, NULL, bi0, HANDOFF, 0,
1356                         vnet_buffer (b0)->ip.reass.owner_thread_index);
1357                     }
1358                 }
1359               else if (FEATURE == type && IP4_ERROR_NONE == error0)
1360                 {
1361                   vnet_feature_next (&next0, b0);
1362                 }
1363
1364               /* Increment the counter to-custom-app also as this fragment is
1365                * also going to application */
1366               if (CUSTOM == type)
1367                 {
1368                   vlib_node_increment_counter (
1369                     vm, node->node_index, IP4_ERROR_REASS_TO_CUSTOM_APP, 1);
1370                 }
1371
1372               vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
1373                                                to_next, n_left_to_next,
1374                                                bi0, next0);
1375               IP4_REASS_DEBUG_BUFFER (bi0, enqueue_next);
1376             }
1377
1378         next_packet:
1379           from += 1;
1380           n_left_from -= 1;
1381         }
1382
1383       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1384     }
1385
1386   clib_spinlock_unlock (&rt->lock);
1387   return frame->n_vectors;
1388 }
1389
1390 static char *ip4_full_reass_error_strings[] = {
1391 #define _(sym, string) string,
1392   foreach_ip4_error
1393 #undef _
1394 };
1395
1396 VLIB_NODE_FN (ip4_full_reass_node) (vlib_main_t * vm,
1397                                     vlib_node_runtime_t * node,
1398                                     vlib_frame_t * frame)
1399 {
1400   return ip4_full_reass_inline (vm, node, frame, NORMAL, false /* is_local */);
1401 }
1402
1403 VLIB_REGISTER_NODE (ip4_full_reass_node) = {
1404     .name = "ip4-full-reassembly",
1405     .vector_size = sizeof (u32),
1406     .format_trace = format_ip4_full_reass_trace,
1407     .n_errors = ARRAY_LEN (ip4_full_reass_error_strings),
1408     .error_strings = ip4_full_reass_error_strings,
1409     .n_next_nodes = IP4_FULL_REASS_N_NEXT,
1410     .next_nodes =
1411         {
1412                 [IP4_FULL_REASS_NEXT_INPUT] = "ip4-input",
1413                 [IP4_FULL_REASS_NEXT_DROP] = "ip4-drop",
1414                 [IP4_FULL_REASS_NEXT_HANDOFF] = "ip4-full-reassembly-handoff",
1415
1416         },
1417 };
1418
1419 VLIB_NODE_FN (ip4_local_full_reass_node)
1420 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
1421 {
1422   return ip4_full_reass_inline (vm, node, frame, NORMAL, true /* is_local */);
1423 }
1424
1425 VLIB_REGISTER_NODE (ip4_local_full_reass_node) = {
1426     .name = "ip4-local-full-reassembly",
1427     .vector_size = sizeof (u32),
1428     .format_trace = format_ip4_full_reass_trace,
1429     .n_errors = ARRAY_LEN (ip4_full_reass_error_strings),
1430     .error_strings = ip4_full_reass_error_strings,
1431     .n_next_nodes = IP4_FULL_REASS_N_NEXT,
1432     .next_nodes =
1433         {
1434                 [IP4_FULL_REASS_NEXT_INPUT] = "ip4-input",
1435                 [IP4_FULL_REASS_NEXT_DROP] = "ip4-drop",
1436                 [IP4_FULL_REASS_NEXT_HANDOFF] = "ip4-local-full-reassembly-handoff",
1437
1438         },
1439 };
1440
1441 VLIB_NODE_FN (ip4_full_reass_node_feature) (vlib_main_t * vm,
1442                                             vlib_node_runtime_t * node,
1443                                             vlib_frame_t * frame)
1444 {
1445   return ip4_full_reass_inline (vm, node, frame, FEATURE,
1446                                 false /* is_local */);
1447 }
1448
1449 VLIB_REGISTER_NODE (ip4_full_reass_node_feature) = {
1450     .name = "ip4-full-reassembly-feature",
1451     .vector_size = sizeof (u32),
1452     .format_trace = format_ip4_full_reass_trace,
1453     .n_errors = ARRAY_LEN (ip4_full_reass_error_strings),
1454     .error_strings = ip4_full_reass_error_strings,
1455     .n_next_nodes = IP4_FULL_REASS_N_NEXT,
1456     .next_nodes =
1457         {
1458                 [IP4_FULL_REASS_NEXT_INPUT] = "ip4-input",
1459                 [IP4_FULL_REASS_NEXT_DROP] = "ip4-drop",
1460                 [IP4_FULL_REASS_NEXT_HANDOFF] = "ip4-full-reass-feature-hoff",
1461         },
1462 };
1463
1464 VNET_FEATURE_INIT (ip4_full_reass_feature, static) = {
1465     .arc_name = "ip4-unicast",
1466     .node_name = "ip4-full-reassembly-feature",
1467     .runs_before = VNET_FEATURES ("ip4-lookup",
1468                                   "ipsec4-input-feature"),
1469     .runs_after = 0,
1470 };
1471
1472 VLIB_NODE_FN (ip4_full_reass_node_custom) (vlib_main_t * vm,
1473                                            vlib_node_runtime_t * node,
1474                                            vlib_frame_t * frame)
1475 {
1476   return ip4_full_reass_inline (vm, node, frame, CUSTOM, false /* is_local */);
1477 }
1478
1479 VLIB_REGISTER_NODE (ip4_full_reass_node_custom) = {
1480     .name = "ip4-full-reassembly-custom",
1481     .vector_size = sizeof (u32),
1482     .format_trace = format_ip4_full_reass_trace,
1483     .n_errors = ARRAY_LEN (ip4_full_reass_error_strings),
1484     .error_strings = ip4_full_reass_error_strings,
1485     .n_next_nodes = IP4_FULL_REASS_N_NEXT,
1486     .next_nodes =
1487         {
1488                 [IP4_FULL_REASS_NEXT_INPUT] = "ip4-input",
1489                 [IP4_FULL_REASS_NEXT_DROP] = "ip4-drop",
1490                 [IP4_FULL_REASS_NEXT_HANDOFF] = "ip4-full-reass-custom-hoff",
1491         },
1492 };
1493
1494 VNET_FEATURE_INIT (ip4_full_reass_custom, static) = {
1495     .arc_name = "ip4-unicast",
1496     .node_name = "ip4-full-reassembly-feature",
1497     .runs_before = VNET_FEATURES ("ip4-lookup",
1498                                   "ipsec4-input-feature"),
1499     .runs_after = 0,
1500 };
1501
1502
1503 #ifndef CLIB_MARCH_VARIANT
1504 uword
1505 ip4_full_reass_custom_register_next_node (uword node_index)
1506 {
1507   return vlib_node_add_next (vlib_get_main (),
1508                              ip4_full_reass_node_custom.index, node_index);
1509 }
1510
1511 always_inline u32
1512 ip4_full_reass_get_nbuckets ()
1513 {
1514   ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1515   u32 nbuckets;
1516   u8 i;
1517
1518   /* need more mem with more workers */
1519   nbuckets = (u32) (rm->max_reass_n * (vlib_num_workers () + 1) /
1520                     IP4_REASS_HT_LOAD_FACTOR);
1521
1522   for (i = 0; i < 31; i++)
1523     if ((1 << i) >= nbuckets)
1524       break;
1525   nbuckets = 1 << i;
1526
1527   return nbuckets;
1528 }
1529 #endif /* CLIB_MARCH_VARIANT */
1530
1531 typedef enum
1532 {
1533   IP4_EVENT_CONFIG_CHANGED = 1,
1534 } ip4_full_reass_event_t;
1535
1536 typedef struct
1537 {
1538   int failure;
1539   clib_bihash_16_8_t *new_hash;
1540 } ip4_rehash_cb_ctx;
1541
1542 #ifndef CLIB_MARCH_VARIANT
1543 static int
1544 ip4_rehash_cb (clib_bihash_kv_16_8_t * kv, void *_ctx)
1545 {
1546   ip4_rehash_cb_ctx *ctx = _ctx;
1547   if (clib_bihash_add_del_16_8 (ctx->new_hash, kv, 1))
1548     {
1549       ctx->failure = 1;
1550     }
1551   return (BIHASH_WALK_CONTINUE);
1552 }
1553
1554 static void
1555 ip4_full_reass_set_params (u32 timeout_ms, u32 max_reassemblies,
1556                            u32 max_reassembly_length,
1557                            u32 expire_walk_interval_ms)
1558 {
1559   ip4_full_reass_main.timeout_ms = timeout_ms;
1560   ip4_full_reass_main.timeout = (f64) timeout_ms / (f64) MSEC_PER_SEC;
1561   ip4_full_reass_main.max_reass_n = max_reassemblies;
1562   ip4_full_reass_main.max_reass_len = max_reassembly_length;
1563   ip4_full_reass_main.expire_walk_interval_ms = expire_walk_interval_ms;
1564 }
1565
1566 vnet_api_error_t
1567 ip4_full_reass_set (u32 timeout_ms, u32 max_reassemblies,
1568                     u32 max_reassembly_length, u32 expire_walk_interval_ms)
1569 {
1570   u32 old_nbuckets = ip4_full_reass_get_nbuckets ();
1571   ip4_full_reass_set_params (timeout_ms, max_reassemblies,
1572                              max_reassembly_length, expire_walk_interval_ms);
1573   vlib_process_signal_event (ip4_full_reass_main.vlib_main,
1574                              ip4_full_reass_main.ip4_full_reass_expire_node_idx,
1575                              IP4_EVENT_CONFIG_CHANGED, 0);
1576   u32 new_nbuckets = ip4_full_reass_get_nbuckets ();
1577   if (ip4_full_reass_main.max_reass_n > 0 && new_nbuckets > old_nbuckets)
1578     {
1579       clib_bihash_16_8_t new_hash;
1580       clib_memset (&new_hash, 0, sizeof (new_hash));
1581       ip4_rehash_cb_ctx ctx;
1582       ctx.failure = 0;
1583       ctx.new_hash = &new_hash;
1584       clib_bihash_init_16_8 (&new_hash, "ip4-dr", new_nbuckets,
1585                              new_nbuckets * 1024);
1586       clib_bihash_foreach_key_value_pair_16_8 (&ip4_full_reass_main.hash,
1587                                                ip4_rehash_cb, &ctx);
1588       if (ctx.failure)
1589         {
1590           clib_bihash_free_16_8 (&new_hash);
1591           return -1;
1592         }
1593       else
1594         {
1595           clib_bihash_free_16_8 (&ip4_full_reass_main.hash);
1596           clib_memcpy_fast (&ip4_full_reass_main.hash, &new_hash,
1597                             sizeof (ip4_full_reass_main.hash));
1598           clib_bihash_copied (&ip4_full_reass_main.hash, &new_hash);
1599         }
1600     }
1601   return 0;
1602 }
1603
1604 vnet_api_error_t
1605 ip4_full_reass_get (u32 * timeout_ms, u32 * max_reassemblies,
1606                     u32 * max_reassembly_length,
1607                     u32 * expire_walk_interval_ms)
1608 {
1609   *timeout_ms = ip4_full_reass_main.timeout_ms;
1610   *max_reassemblies = ip4_full_reass_main.max_reass_n;
1611   *max_reassembly_length = ip4_full_reass_main.max_reass_len;
1612   *expire_walk_interval_ms = ip4_full_reass_main.expire_walk_interval_ms;
1613   return 0;
1614 }
1615
1616 static clib_error_t *
1617 ip4_full_reass_init_function (vlib_main_t * vm)
1618 {
1619   ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1620   clib_error_t *error = 0;
1621   u32 nbuckets;
1622   vlib_node_t *node;
1623
1624   rm->vlib_main = vm;
1625
1626   vec_validate (rm->per_thread_data, vlib_num_workers ());
1627   ip4_full_reass_per_thread_t *rt;
1628   vec_foreach (rt, rm->per_thread_data)
1629   {
1630     clib_spinlock_init (&rt->lock);
1631     pool_alloc (rt->pool, rm->max_reass_n);
1632   }
1633
1634   node = vlib_get_node_by_name (vm, (u8 *) "ip4-full-reassembly-expire-walk");
1635   ASSERT (node);
1636   rm->ip4_full_reass_expire_node_idx = node->index;
1637
1638   ip4_full_reass_set_params (IP4_REASS_TIMEOUT_DEFAULT_MS,
1639                              IP4_REASS_MAX_REASSEMBLIES_DEFAULT,
1640                              IP4_REASS_MAX_REASSEMBLY_LENGTH_DEFAULT,
1641                              IP4_REASS_EXPIRE_WALK_INTERVAL_DEFAULT_MS);
1642
1643   nbuckets = ip4_full_reass_get_nbuckets ();
1644   clib_bihash_init_16_8 (&rm->hash, "ip4-dr", nbuckets, nbuckets * 1024);
1645
1646   rm->fq_index = vlib_frame_queue_main_init (ip4_full_reass_node.index, 0);
1647   rm->fq_local_index =
1648     vlib_frame_queue_main_init (ip4_local_full_reass_node.index, 0);
1649   rm->fq_feature_index =
1650     vlib_frame_queue_main_init (ip4_full_reass_node_feature.index, 0);
1651   rm->fq_custom_index =
1652     vlib_frame_queue_main_init (ip4_full_reass_node_custom.index, 0);
1653
1654   rm->feature_use_refcount_per_intf = NULL;
1655   rm->is_local_reass_enabled = 1;
1656
1657   return error;
1658 }
1659
1660 VLIB_INIT_FUNCTION (ip4_full_reass_init_function);
1661 #endif /* CLIB_MARCH_VARIANT */
1662
1663 static uword
1664 ip4_full_reass_walk_expired (vlib_main_t *vm, vlib_node_runtime_t *node,
1665                              CLIB_UNUSED (vlib_frame_t *f))
1666 {
1667   ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1668   uword event_type, *event_data = 0;
1669
1670   while (true)
1671     {
1672       vlib_process_wait_for_event_or_clock (vm,
1673                                             (f64)
1674                                             rm->expire_walk_interval_ms /
1675                                             (f64) MSEC_PER_SEC);
1676       event_type = vlib_process_get_events (vm, &event_data);
1677
1678       switch (event_type)
1679         {
1680         case ~0:
1681           /* no events => timeout */
1682           /* fallthrough */
1683         case IP4_EVENT_CONFIG_CHANGED:
1684           /* nothing to do here */
1685           break;
1686         default:
1687           clib_warning ("BUG: event type 0x%wx", event_type);
1688           break;
1689         }
1690       f64 now = vlib_time_now (vm);
1691
1692       ip4_full_reass_t *reass;
1693       int *pool_indexes_to_free = NULL;
1694
1695       uword thread_index = 0;
1696       int index;
1697       const uword nthreads = vlib_num_workers () + 1;
1698       u32 n_left_to_next, *to_next;
1699
1700       for (thread_index = 0; thread_index < nthreads; ++thread_index)
1701         {
1702           ip4_full_reass_per_thread_t *rt =
1703             &rm->per_thread_data[thread_index];
1704           clib_spinlock_lock (&rt->lock);
1705
1706           vec_reset_length (pool_indexes_to_free);
1707
1708           /* Pace the number of timeouts handled per thread,to avoid barrier
1709            * sync issues in real world scenarios */
1710
1711           u32 beg = rt->last_id;
1712           /* to ensure we walk at least once per sec per context */
1713           u32 end =
1714             beg + (IP4_REASS_MAX_REASSEMBLIES_DEFAULT *
1715                      IP4_REASS_EXPIRE_WALK_INTERVAL_DEFAULT_MS / MSEC_PER_SEC +
1716                    1);
1717           if (end > vec_len (rt->pool))
1718             {
1719               end = vec_len (rt->pool);
1720               rt->last_id = 0;
1721             }
1722           else
1723             {
1724               rt->last_id = end;
1725             }
1726
1727           pool_foreach_stepping_index (index, beg, end, rt->pool)
1728           {
1729             reass = pool_elt_at_index (rt->pool, index);
1730             if (now > reass->last_heard + rm->timeout)
1731               {
1732                 vec_add1 (pool_indexes_to_free, index);
1733               }
1734           }
1735
1736           if (vec_len (pool_indexes_to_free))
1737             vlib_node_increment_counter (vm, node->node_index,
1738                                          IP4_ERROR_REASS_TIMEOUT,
1739                                          vec_len (pool_indexes_to_free));
1740           int *i;
1741           vec_foreach (i, pool_indexes_to_free)
1742           {
1743             ip4_full_reass_t *reass = pool_elt_at_index (rt->pool, i[0]);
1744             ip4_full_reass_drop_all (vm, node, reass, &n_left_to_next,
1745                                      &to_next);
1746             ip4_full_reass_free (rm, rt, reass);
1747           }
1748
1749           clib_spinlock_unlock (&rt->lock);
1750         }
1751
1752       vec_free (pool_indexes_to_free);
1753       if (event_data)
1754         {
1755           vec_set_len (event_data, 0);
1756         }
1757     }
1758
1759   return 0;
1760 }
1761
1762 VLIB_REGISTER_NODE (ip4_full_reass_expire_node) = {
1763     .function = ip4_full_reass_walk_expired,
1764     .type = VLIB_NODE_TYPE_PROCESS,
1765     .name = "ip4-full-reassembly-expire-walk",
1766     .format_trace = format_ip4_full_reass_trace,
1767     .n_errors = ARRAY_LEN (ip4_full_reass_error_strings),
1768     .error_strings = ip4_full_reass_error_strings,
1769
1770 };
1771
1772 static u8 *
1773 format_ip4_full_reass_key (u8 * s, va_list * args)
1774 {
1775   ip4_full_reass_key_t *key = va_arg (*args, ip4_full_reass_key_t *);
1776   s =
1777     format (s,
1778             "xx_id: %u, src: %U, dst: %U, frag_id: %u, proto: %u",
1779             key->xx_id, format_ip4_address, &key->src, format_ip4_address,
1780             &key->dst, clib_net_to_host_u16 (key->frag_id), key->proto);
1781   return s;
1782 }
1783
1784 static u8 *
1785 format_ip4_reass (u8 * s, va_list * args)
1786 {
1787   vlib_main_t *vm = va_arg (*args, vlib_main_t *);
1788   ip4_full_reass_t *reass = va_arg (*args, ip4_full_reass_t *);
1789
1790   s = format (s, "ID: %lu, key: %U\n  first_bi: %u, data_len: %u, "
1791               "last_packet_octet: %u, trace_op_counter: %u\n",
1792               reass->id, format_ip4_full_reass_key, &reass->key,
1793               reass->first_bi, reass->data_len,
1794               reass->last_packet_octet, reass->trace_op_counter);
1795
1796   u32 bi = reass->first_bi;
1797   u32 counter = 0;
1798   while (~0 != bi)
1799     {
1800       vlib_buffer_t *b = vlib_get_buffer (vm, bi);
1801       vnet_buffer_opaque_t *vnb = vnet_buffer (b);
1802       s =
1803         format (s,
1804                 "  #%03u: range: [%u, %u], bi: %u, off: %d, len: %u, "
1805                 "fragment[%u, %u]\n", counter, vnb->ip.reass.range_first,
1806                 vnb->ip.reass.range_last, bi,
1807                 ip4_full_reass_buffer_get_data_offset (b),
1808                 ip4_full_reass_buffer_get_data_len (b),
1809                 vnb->ip.reass.fragment_first, vnb->ip.reass.fragment_last);
1810       if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
1811         {
1812           bi = b->next_buffer;
1813         }
1814       else
1815         {
1816           bi = ~0;
1817         }
1818     }
1819   return s;
1820 }
1821
1822 static clib_error_t *
1823 show_ip4_reass (vlib_main_t * vm,
1824                 unformat_input_t * input,
1825                 CLIB_UNUSED (vlib_cli_command_t * lmd))
1826 {
1827   ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1828
1829   vlib_cli_output (vm, "---------------------");
1830   vlib_cli_output (vm, "IP4 reassembly status");
1831   vlib_cli_output (vm, "---------------------");
1832   bool details = false;
1833   if (unformat (input, "details"))
1834     {
1835       details = true;
1836     }
1837
1838   u32 sum_reass_n = 0;
1839   ip4_full_reass_t *reass;
1840   uword thread_index;
1841   const uword nthreads = vlib_num_workers () + 1;
1842   for (thread_index = 0; thread_index < nthreads; ++thread_index)
1843     {
1844       ip4_full_reass_per_thread_t *rt = &rm->per_thread_data[thread_index];
1845       clib_spinlock_lock (&rt->lock);
1846       if (details)
1847         {
1848           pool_foreach (reass, rt->pool) {
1849             vlib_cli_output (vm, "%U", format_ip4_reass, vm, reass);
1850           }
1851         }
1852       sum_reass_n += rt->reass_n;
1853       clib_spinlock_unlock (&rt->lock);
1854     }
1855   vlib_cli_output (vm, "---------------------");
1856   vlib_cli_output (vm, "Current full IP4 reassemblies count: %lu\n",
1857                    (long unsigned) sum_reass_n);
1858   vlib_cli_output (vm,
1859                    "Maximum configured concurrent full IP4 reassemblies per worker-thread: %lu\n",
1860                    (long unsigned) rm->max_reass_n);
1861   vlib_cli_output (vm,
1862                    "Maximum configured amount of fragments "
1863                    "per full IP4 reassembly: %lu\n",
1864                    (long unsigned) rm->max_reass_len);
1865   vlib_cli_output (vm,
1866                    "Maximum configured full IP4 reassembly timeout: %lums\n",
1867                    (long unsigned) rm->timeout_ms);
1868   vlib_cli_output (vm,
1869                    "Maximum configured full IP4 reassembly expire walk interval: %lums\n",
1870                    (long unsigned) rm->expire_walk_interval_ms);
1871   return 0;
1872 }
1873
1874 VLIB_CLI_COMMAND (show_ip4_full_reass_cmd, static) = {
1875     .path = "show ip4-full-reassembly",
1876     .short_help = "show ip4-full-reassembly [details]",
1877     .function = show_ip4_reass,
1878 };
1879
1880 #ifndef CLIB_MARCH_VARIANT
1881 vnet_api_error_t
1882 ip4_full_reass_enable_disable (u32 sw_if_index, u8 enable_disable)
1883 {
1884   return vnet_feature_enable_disable ("ip4-unicast",
1885                                       "ip4-full-reassembly-feature",
1886                                       sw_if_index, enable_disable, 0, 0);
1887 }
1888 #endif /* CLIB_MARCH_VARIANT */
1889
1890
1891 #define foreach_ip4_full_reass_handoff_error                       \
1892 _(CONGESTION_DROP, "congestion drop")
1893
1894
1895 typedef enum
1896 {
1897 #define _(sym,str) IP4_FULL_REASS_HANDOFF_ERROR_##sym,
1898   foreach_ip4_full_reass_handoff_error
1899 #undef _
1900     IP4_FULL_REASS_HANDOFF_N_ERROR,
1901 } ip4_full_reass_handoff_error_t;
1902
1903 static char *ip4_full_reass_handoff_error_strings[] = {
1904 #define _(sym,string) string,
1905   foreach_ip4_full_reass_handoff_error
1906 #undef _
1907 };
1908
1909 typedef struct
1910 {
1911   u32 next_worker_index;
1912 } ip4_full_reass_handoff_trace_t;
1913
1914 static u8 *
1915 format_ip4_full_reass_handoff_trace (u8 * s, va_list * args)
1916 {
1917   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
1918   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
1919   ip4_full_reass_handoff_trace_t *t =
1920     va_arg (*args, ip4_full_reass_handoff_trace_t *);
1921
1922   s =
1923     format (s, "ip4-full-reassembly-handoff: next-worker %d",
1924             t->next_worker_index);
1925
1926   return s;
1927 }
1928
1929 always_inline uword
1930 ip4_full_reass_handoff_node_inline (vlib_main_t *vm, vlib_node_runtime_t *node,
1931                                     vlib_frame_t *frame,
1932                                     ip4_full_reass_node_type_t type,
1933                                     bool is_local)
1934 {
1935   ip4_full_reass_main_t *rm = &ip4_full_reass_main;
1936
1937   vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
1938   u32 n_enq, n_left_from, *from;
1939   u16 thread_indices[VLIB_FRAME_SIZE], *ti;
1940   u32 fq_index;
1941
1942   from = vlib_frame_vector_args (frame);
1943   n_left_from = frame->n_vectors;
1944   vlib_get_buffers (vm, from, bufs, n_left_from);
1945
1946   b = bufs;
1947   ti = thread_indices;
1948
1949   switch (type)
1950     {
1951     case NORMAL:
1952       if (is_local)
1953         {
1954           fq_index = rm->fq_local_index;
1955         }
1956       else
1957         {
1958           fq_index = rm->fq_index;
1959         }
1960       break;
1961     case FEATURE:
1962       fq_index = rm->fq_feature_index;
1963       break;
1964     case CUSTOM:
1965       fq_index = rm->fq_custom_index;
1966       break;
1967     default:
1968       clib_warning ("Unexpected `type' (%d)!", type);
1969     }
1970
1971   while (n_left_from > 0)
1972     {
1973       ti[0] = vnet_buffer (b[0])->ip.reass.owner_thread_index;
1974
1975       if (PREDICT_FALSE
1976           ((node->flags & VLIB_NODE_FLAG_TRACE)
1977            && (b[0]->flags & VLIB_BUFFER_IS_TRACED)))
1978         {
1979           ip4_full_reass_handoff_trace_t *t =
1980             vlib_add_trace (vm, node, b[0], sizeof (*t));
1981           t->next_worker_index = ti[0];
1982         }
1983
1984       n_left_from -= 1;
1985       ti += 1;
1986       b += 1;
1987     }
1988   n_enq = vlib_buffer_enqueue_to_thread (vm, node, fq_index, from,
1989                                          thread_indices, frame->n_vectors, 1);
1990
1991   if (n_enq < frame->n_vectors)
1992     vlib_node_increment_counter (vm, node->node_index,
1993                                  IP4_FULL_REASS_HANDOFF_ERROR_CONGESTION_DROP,
1994                                  frame->n_vectors - n_enq);
1995   return frame->n_vectors;
1996 }
1997
1998 VLIB_NODE_FN (ip4_full_reass_handoff_node) (vlib_main_t * vm,
1999                                             vlib_node_runtime_t * node,
2000                                             vlib_frame_t * frame)
2001 {
2002   return ip4_full_reass_handoff_node_inline (vm, node, frame, NORMAL,
2003                                              false /* is_local */);
2004 }
2005
2006
2007 VLIB_REGISTER_NODE (ip4_full_reass_handoff_node) = {
2008   .name = "ip4-full-reassembly-handoff",
2009   .vector_size = sizeof (u32),
2010   .n_errors = ARRAY_LEN(ip4_full_reass_handoff_error_strings),
2011   .error_strings = ip4_full_reass_handoff_error_strings,
2012   .format_trace = format_ip4_full_reass_handoff_trace,
2013
2014   .n_next_nodes = 1,
2015
2016   .next_nodes = {
2017     [0] = "error-drop",
2018   },
2019 };
2020
2021 VLIB_NODE_FN (ip4_local_full_reass_handoff_node)
2022 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
2023 {
2024   return ip4_full_reass_handoff_node_inline (vm, node, frame, NORMAL,
2025                                              true /* is_local */);
2026 }
2027
2028 VLIB_REGISTER_NODE (ip4_local_full_reass_handoff_node) = {
2029   .name = "ip4-local-full-reassembly-handoff",
2030   .vector_size = sizeof (u32),
2031   .n_errors = ARRAY_LEN(ip4_full_reass_handoff_error_strings),
2032   .error_strings = ip4_full_reass_handoff_error_strings,
2033   .format_trace = format_ip4_full_reass_handoff_trace,
2034
2035   .n_next_nodes = 1,
2036
2037   .next_nodes = {
2038     [0] = "error-drop",
2039   },
2040 };
2041
2042 VLIB_NODE_FN (ip4_full_reass_feature_handoff_node) (vlib_main_t * vm,
2043                                                     vlib_node_runtime_t *
2044                                                     node,
2045                                                     vlib_frame_t * frame)
2046 {
2047   return ip4_full_reass_handoff_node_inline (vm, node, frame, FEATURE,
2048                                              false /* is_local */);
2049 }
2050
2051 VLIB_REGISTER_NODE (ip4_full_reass_feature_handoff_node) = {
2052   .name = "ip4-full-reass-feature-hoff",
2053   .vector_size = sizeof (u32),
2054   .n_errors = ARRAY_LEN(ip4_full_reass_handoff_error_strings),
2055   .error_strings = ip4_full_reass_handoff_error_strings,
2056   .format_trace = format_ip4_full_reass_handoff_trace,
2057
2058   .n_next_nodes = 1,
2059
2060   .next_nodes = {
2061     [0] = "error-drop",
2062   },
2063 };
2064
2065 VLIB_NODE_FN (ip4_full_reass_custom_handoff_node) (vlib_main_t * vm,
2066                                                     vlib_node_runtime_t *
2067                                                     node,
2068                                                     vlib_frame_t * frame)
2069 {
2070   return ip4_full_reass_handoff_node_inline (vm, node, frame, CUSTOM,
2071                                              false /* is_local */);
2072 }
2073
2074 VLIB_REGISTER_NODE (ip4_full_reass_custom_handoff_node) = {
2075   .name = "ip4-full-reass-custom-hoff",
2076   .vector_size = sizeof (u32),
2077   .n_errors = ARRAY_LEN(ip4_full_reass_handoff_error_strings),
2078   .error_strings = ip4_full_reass_handoff_error_strings,
2079   .format_trace = format_ip4_full_reass_handoff_trace,
2080
2081   .n_next_nodes = 1,
2082
2083   .next_nodes = {
2084     [0] = "error-drop",
2085   },
2086 };
2087
2088 #ifndef CLIB_MARCH_VARIANT
2089 int
2090 ip4_full_reass_enable_disable_with_refcnt (u32 sw_if_index, int is_enable)
2091 {
2092   ip4_full_reass_main_t *rm = &ip4_full_reass_main;
2093   vec_validate (rm->feature_use_refcount_per_intf, sw_if_index);
2094   if (is_enable)
2095     {
2096       if (!rm->feature_use_refcount_per_intf[sw_if_index])
2097         {
2098           ++rm->feature_use_refcount_per_intf[sw_if_index];
2099           return vnet_feature_enable_disable ("ip4-unicast",
2100                                               "ip4-full-reassembly-feature",
2101                                               sw_if_index, 1, 0, 0);
2102         }
2103       ++rm->feature_use_refcount_per_intf[sw_if_index];
2104     }
2105   else
2106     {
2107       --rm->feature_use_refcount_per_intf[sw_if_index];
2108       if (!rm->feature_use_refcount_per_intf[sw_if_index])
2109         return vnet_feature_enable_disable ("ip4-unicast",
2110                                             "ip4-full-reassembly-feature",
2111                                             sw_if_index, 0, 0, 0);
2112     }
2113   return -1;
2114 }
2115
2116 void
2117 ip4_local_full_reass_enable_disable (int enable)
2118 {
2119   if (enable)
2120     {
2121       ip4_full_reass_main.is_local_reass_enabled = 1;
2122     }
2123   else
2124     {
2125       ip4_full_reass_main.is_local_reass_enabled = 0;
2126     }
2127 }
2128
2129 int
2130 ip4_local_full_reass_enabled ()
2131 {
2132   return ip4_full_reass_main.is_local_reass_enabled;
2133 }
2134
2135 #endif
2136
2137 /*
2138  * fd.io coding-style-patch-verification: ON
2139  *
2140  * Local Variables:
2141  * eval: (c-set-style "gnu")
2142  * End:
2143  */