reassembly: feature/concurrency
[vpp.git] / src / vnet / ip / ip6_reassembly.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 IPv6 Reassembly.
19  *
20  * This file contains the source code for IPv6 reassembly.
21  */
22
23 #include <vppinfra/vec.h>
24 #include <vnet/vnet.h>
25 #include <vnet/ip/ip.h>
26 #include <vppinfra/bihash_48_8.h>
27 #include <vnet/ip/ip6_reassembly.h>
28
29 #define MSEC_PER_SEC 1000
30 #define IP6_REASS_TIMEOUT_DEFAULT_MS 100
31 #define IP6_REASS_EXPIRE_WALK_INTERVAL_DEFAULT_MS 10000 // 10 seconds default
32 #define IP6_REASS_MAX_REASSEMBLIES_DEFAULT 1024
33 #define IP6_REASS_HT_LOAD_FACTOR (0.75)
34
35 static vlib_node_registration_t ip6_reass_node;
36
37 typedef struct
38 {
39   union
40   {
41     struct
42     {
43       ip6_address_t src;
44       ip6_address_t dst;
45       // align by making this 4 octets even though its a 2 octets field
46       u32 xx_id;
47       // align by making this 4 octets even though its a 2 octets field
48       u32 frag_id;
49       // align by making this 4 octets even though its a 1 octet field
50       u32 proto;
51       u32 unused;
52     };
53     u64 as_u64[6];
54   };
55 } ip6_reass_key_t;
56
57 always_inline u32
58 ip6_reass_buffer_get_data_offset_no_check (vlib_buffer_t * b)
59 {
60   vnet_buffer_opaque_t *vnb = vnet_buffer (b);
61   return vnb->ip.reass.range_first - vnb->ip.reass.fragment_first;
62 }
63
64 always_inline u32
65 ip6_reass_buffer_get_data_offset (vlib_buffer_t * b)
66 {
67   vnet_buffer_opaque_t *vnb = vnet_buffer (b);
68   ASSERT (vnb->ip.reass.range_first >= vnb->ip.reass.fragment_first);
69   return ip6_reass_buffer_get_data_offset_no_check (b);
70 }
71
72 always_inline u16
73 ip6_reass_buffer_get_data_len_no_check (vlib_buffer_t * b)
74 {
75   vnet_buffer_opaque_t *vnb = vnet_buffer (b);
76   return clib_min (vnb->ip.reass.range_last, vnb->ip.reass.fragment_last) -
77     (vnb->ip.reass.fragment_first + ip6_reass_buffer_get_data_offset (b)) + 1;
78 }
79
80 always_inline u16
81 ip6_reass_buffer_get_data_len (vlib_buffer_t * b)
82 {
83   vnet_buffer_opaque_t *vnb = vnet_buffer (b);
84   ASSERT (vnb->ip.reass.range_last > vnb->ip.reass.fragment_first);
85   return ip6_reass_buffer_get_data_len_no_check (b);
86 }
87
88 typedef struct
89 {
90   // hash table key
91   ip6_reass_key_t key;
92   // time when last packet was received
93   f64 last_heard;
94   // internal id of this reassembly
95   u64 id;
96   // buffer index of first buffer in this reassembly context
97   u32 first_bi;
98   // last octet of packet, ~0 until fragment without more_fragments arrives
99   u32 last_packet_octet;
100   // length of data collected so far
101   u32 data_len;
102   // trace operation counter
103   u32 trace_op_counter;
104   // next index - used by non-feature node
105   u8 next_index;
106   // minimum fragment length for this reassembly - used to estimate MTU
107   u16 min_fragment_length;
108 } ip6_reass_t;
109
110 typedef struct
111 {
112   ip6_reass_t *pool;
113   u32 reass_n;
114   u32 buffers_n;
115   u32 id_counter;
116   clib_spinlock_t lock;
117 } ip6_reass_per_thread_t;
118
119 typedef struct
120 {
121   // IPv6 config
122   u32 timeout_ms;
123   f64 timeout;
124   u32 expire_walk_interval_ms;
125   u32 max_reass_n;
126
127   // IPv6 runtime
128   clib_bihash_48_8_t hash;
129
130   // per-thread data
131   ip6_reass_per_thread_t *per_thread_data;
132
133   // convenience
134   vlib_main_t *vlib_main;
135   vnet_main_t *vnet_main;
136
137   // node index of ip6-drop node
138   u32 ip6_drop_idx;
139   u32 ip6_icmp_error_idx;
140   u32 ip6_reass_expire_node_idx;
141
142 } ip6_reass_main_t;
143
144 ip6_reass_main_t ip6_reass_main;
145
146 typedef enum
147 {
148   IP6_REASSEMBLY_NEXT_INPUT,
149   IP6_REASSEMBLY_NEXT_DROP,
150   IP6_REASSEMBLY_NEXT_ICMP_ERROR,
151   IP6_REASSEMBLY_N_NEXT,
152 } ip6_reass_next_t;
153
154 typedef enum
155 {
156   RANGE_NEW,
157   RANGE_OVERLAP,
158   ICMP_ERROR_RT_EXCEEDED,
159   ICMP_ERROR_FL_TOO_BIG,
160   ICMP_ERROR_FL_NOT_MULT_8,
161   FINALIZE,
162 } ip6_reass_trace_operation_e;
163
164 typedef struct
165 {
166   u16 range_first;
167   u16 range_last;
168   u32 range_bi;
169   i32 data_offset;
170   u32 data_len;
171   u32 first_bi;
172 } ip6_reass_range_trace_t;
173
174 typedef struct
175 {
176   ip6_reass_trace_operation_e action;
177   u32 reass_id;
178   ip6_reass_range_trace_t trace_range;
179   u32 size_diff;
180   u32 op_id;
181   u32 fragment_first;
182   u32 fragment_last;
183   u32 total_data_len;
184 } ip6_reass_trace_t;
185
186 static void
187 ip6_reass_trace_details (vlib_main_t * vm, u32 bi,
188                          ip6_reass_range_trace_t * trace)
189 {
190   vlib_buffer_t *b = vlib_get_buffer (vm, bi);
191   vnet_buffer_opaque_t *vnb = vnet_buffer (b);
192   trace->range_first = vnb->ip.reass.range_first;
193   trace->range_last = vnb->ip.reass.range_last;
194   trace->data_offset = ip6_reass_buffer_get_data_offset_no_check (b);
195   trace->data_len = ip6_reass_buffer_get_data_len_no_check (b);
196   trace->range_bi = bi;
197 }
198
199 static u8 *
200 format_ip6_reass_range_trace (u8 * s, va_list * args)
201 {
202   ip6_reass_range_trace_t *trace = va_arg (*args, ip6_reass_range_trace_t *);
203   s = format (s, "range: [%u, %u], off %d, len %u, bi %u", trace->range_first,
204               trace->range_last, trace->data_offset, trace->data_len,
205               trace->range_bi);
206   return s;
207 }
208
209 static u8 *
210 format_ip6_reass_trace (u8 * s, va_list * args)
211 {
212   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
213   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
214   ip6_reass_trace_t *t = va_arg (*args, ip6_reass_trace_t *);
215   s = format (s, "reass id: %u, op id: %u ", t->reass_id, t->op_id);
216   u32 indent = format_get_indent (s);
217   s = format (s, "first bi: %u, data len: %u, ip/fragment[%u, %u]",
218               t->trace_range.first_bi, t->total_data_len, t->fragment_first,
219               t->fragment_last);
220   switch (t->action)
221     {
222     case RANGE_NEW:
223       s = format (s, "\n%Unew %U", format_white_space, indent,
224                   format_ip6_reass_range_trace, &t->trace_range);
225       break;
226     case RANGE_OVERLAP:
227       s = format (s, "\n%Uoverlap %U", format_white_space, indent,
228                   format_ip6_reass_range_trace, &t->trace_range);
229       break;
230     case ICMP_ERROR_FL_TOO_BIG:
231       s = format (s, "\n%Uicmp-error - frag_len > 65535 %U",
232                   format_white_space, indent, format_ip6_reass_range_trace,
233                   &t->trace_range);
234       break;
235     case ICMP_ERROR_FL_NOT_MULT_8:
236       s = format (s, "\n%Uicmp-error - frag_len mod 8 != 0 %U",
237                   format_white_space, indent, format_ip6_reass_range_trace,
238                   &t->trace_range);
239       break;
240     case ICMP_ERROR_RT_EXCEEDED:
241       s = format (s, "\n%Uicmp-error - reassembly time exceeded",
242                   format_white_space, indent);
243       break;
244     case FINALIZE:
245       s = format (s, "\n%Ufinalize reassembly", format_white_space, indent);
246       break;
247     }
248   return s;
249 }
250
251 static void
252 ip6_reass_add_trace (vlib_main_t * vm, vlib_node_runtime_t * node,
253                      ip6_reass_main_t * rm, ip6_reass_t * reass,
254                      u32 bi, ip6_reass_trace_operation_e action,
255                      u32 size_diff)
256 {
257   vlib_buffer_t *b = vlib_get_buffer (vm, bi);
258   vnet_buffer_opaque_t *vnb = vnet_buffer (b);
259   if (pool_is_free_index (vm->trace_main.trace_buffer_pool, b->trace_index))
260     {
261       // this buffer's trace is gone
262       b->flags &= ~VLIB_BUFFER_IS_TRACED;
263       return;
264     }
265   ip6_reass_trace_t *t = vlib_add_trace (vm, node, b, sizeof (t[0]));
266   t->reass_id = reass->id;
267   t->action = action;
268   ip6_reass_trace_details (vm, bi, &t->trace_range);
269   t->size_diff = size_diff;
270   t->op_id = reass->trace_op_counter;
271   ++reass->trace_op_counter;
272   t->fragment_first = vnb->ip.reass.fragment_first;
273   t->fragment_last = vnb->ip.reass.fragment_last;
274   t->trace_range.first_bi = reass->first_bi;
275   t->total_data_len = reass->data_len;
276 #if 0
277   static u8 *s = NULL;
278   s = format (s, "%U", format_ip6_reass_trace, NULL, NULL, t);
279   printf ("%.*s\n", vec_len (s), s);
280   fflush (stdout);
281   vec_reset_length (s);
282 #endif
283 }
284
285 always_inline void
286 ip6_reass_free (ip6_reass_main_t * rm, ip6_reass_per_thread_t * rt,
287                 ip6_reass_t * reass)
288 {
289   clib_bihash_kv_48_8_t kv;
290   kv.key[0] = reass->key.as_u64[0];
291   kv.key[1] = reass->key.as_u64[1];
292   kv.key[2] = reass->key.as_u64[2];
293   kv.key[3] = reass->key.as_u64[3];
294   kv.key[4] = reass->key.as_u64[4];
295   kv.key[5] = reass->key.as_u64[5];
296   clib_bihash_add_del_48_8 (&rm->hash, &kv, 0);
297   pool_put (rt->pool, reass);
298   --rt->reass_n;
299 }
300
301 always_inline void
302 ip6_reass_drop_all (vlib_main_t * vm, ip6_reass_main_t * rm,
303                     ip6_reass_t * reass, u32 ** vec_drop_bi)
304 {
305   u32 range_bi = reass->first_bi;
306   vlib_buffer_t *range_b;
307   vnet_buffer_opaque_t *range_vnb;
308   while (~0 != range_bi)
309     {
310       range_b = vlib_get_buffer (vm, range_bi);
311       range_vnb = vnet_buffer (range_b);
312       u32 bi = range_bi;
313       while (~0 != bi)
314         {
315           vec_add1 (*vec_drop_bi, bi);
316           vlib_buffer_t *b = vlib_get_buffer (vm, bi);
317           if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
318             {
319               bi = b->next_buffer;
320               b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
321             }
322           else
323             {
324               bi = ~0;
325             }
326         }
327       range_bi = range_vnb->ip.reass.next_range_bi;
328     }
329 }
330
331 always_inline void
332 ip6_reass_on_timeout (vlib_main_t * vm, vlib_node_runtime_t * node,
333                       ip6_reass_main_t * rm, ip6_reass_t * reass,
334                       u32 * icmp_bi, u32 ** vec_timeout)
335 {
336   if (~0 == reass->first_bi)
337     {
338       return;
339     }
340   vlib_buffer_t *b = vlib_get_buffer (vm, reass->first_bi);
341   if (0 == vnet_buffer (b)->ip.reass.fragment_first)
342     {
343       *icmp_bi = reass->first_bi;
344       if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
345         {
346           ip6_reass_add_trace (vm, node, rm, reass, reass->first_bi,
347                                ICMP_ERROR_RT_EXCEEDED, 0);
348         }
349       // fragment with offset zero received - send icmp message back
350       if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
351         {
352           // separate first buffer from chain and steer it towards icmp node
353           b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
354           reass->first_bi = b->next_buffer;
355         }
356       else
357         {
358           reass->first_bi = vnet_buffer (b)->ip.reass.next_range_bi;
359         }
360       icmp6_error_set_vnet_buffer (b, ICMP6_time_exceeded,
361                                    ICMP6_time_exceeded_fragment_reassembly_time_exceeded,
362                                    0);
363     }
364   ip6_reass_drop_all (vm, rm, reass, vec_timeout);
365 }
366
367 always_inline ip6_reass_t *
368 ip6_reass_find_or_create (vlib_main_t * vm, vlib_node_runtime_t * node,
369                           ip6_reass_main_t * rm, ip6_reass_per_thread_t * rt,
370                           ip6_reass_key_t * k, u32 * icmp_bi,
371                           u32 ** vec_timeout)
372 {
373   ip6_reass_t *reass = NULL;
374   f64 now = vlib_time_now (rm->vlib_main);
375   clib_bihash_kv_48_8_t kv, value;
376   kv.key[0] = k->as_u64[0];
377   kv.key[1] = k->as_u64[1];
378   kv.key[2] = k->as_u64[2];
379   kv.key[3] = k->as_u64[3];
380   kv.key[4] = k->as_u64[4];
381   kv.key[5] = k->as_u64[5];
382
383   if (!clib_bihash_search_48_8 (&rm->hash, &kv, &value))
384     {
385       reass = pool_elt_at_index (rt->pool, value.value);
386       if (now > reass->last_heard + rm->timeout)
387         {
388           ip6_reass_on_timeout (vm, node, rm, reass, icmp_bi, vec_timeout);
389           ip6_reass_free (rm, rt, reass);
390           reass = NULL;
391         }
392     }
393
394   if (reass)
395     {
396       reass->last_heard = now;
397       return reass;
398     }
399
400   if (rt->reass_n >= rm->max_reass_n)
401     {
402       reass = NULL;
403       return reass;
404     }
405   else
406     {
407       pool_get (rt->pool, reass);
408       memset (reass, 0, sizeof (*reass));
409       reass->id =
410         ((u64) os_get_thread_index () * 1000000000) + rt->id_counter;
411       ++rt->id_counter;
412       reass->first_bi = ~0;
413       reass->last_packet_octet = ~0;
414       reass->data_len = 0;
415       ++rt->reass_n;
416     }
417
418   reass->key.as_u64[0] = kv.key[0] = k->as_u64[0];
419   reass->key.as_u64[1] = kv.key[1] = k->as_u64[1];
420   reass->key.as_u64[2] = kv.key[2] = k->as_u64[2];
421   reass->key.as_u64[3] = kv.key[3] = k->as_u64[3];
422   reass->key.as_u64[4] = kv.key[4] = k->as_u64[4];
423   reass->key.as_u64[5] = kv.key[5] = k->as_u64[5];
424   kv.value = reass - rt->pool;
425   reass->last_heard = now;
426
427   if (clib_bihash_add_del_48_8 (&rm->hash, &kv, 1))
428     {
429       ip6_reass_free (rm, rt, reass);
430       reass = NULL;
431     }
432
433   return reass;
434 }
435
436 always_inline void
437 ip6_reass_finalize (vlib_main_t * vm, vlib_node_runtime_t * node,
438                     ip6_reass_main_t * rm, ip6_reass_per_thread_t * rt,
439                     ip6_reass_t * reass, u32 * bi0, u32 * next0,
440                     vlib_error_t * error0, u32 ** vec_drop_compress,
441                     bool is_feature)
442 {
443   ASSERT (~0 != reass->first_bi);
444   *bi0 = reass->first_bi;
445   *error0 = IP6_ERROR_NONE;
446   ip6_frag_hdr_t *frag_hdr;
447   vlib_buffer_t *last_b = NULL;
448   u32 sub_chain_bi = reass->first_bi;
449   u32 total_length = 0;
450   u32 buf_cnt = 0;
451   u32 dropped_cnt = 0;
452   do
453     {
454       u32 tmp_bi = sub_chain_bi;
455       vlib_buffer_t *tmp = vlib_get_buffer (vm, tmp_bi);
456       u32 data_len = ip6_reass_buffer_get_data_len (tmp);
457       u32 trim_front = vnet_buffer (tmp)->ip.reass.ip6_frag_hdr_offset +
458         sizeof (*frag_hdr) + ip6_reass_buffer_get_data_offset (tmp);
459       u32 trim_end =
460         vlib_buffer_length_in_chain (vm, tmp) - trim_front - data_len;
461       if (tmp_bi == reass->first_bi)
462         {
463           /* first buffer - keep ip6 header */
464           ASSERT (0 == ip6_reass_buffer_get_data_offset (tmp));
465           trim_front = 0;
466           trim_end = vlib_buffer_length_in_chain (vm, tmp) - data_len -
467             (vnet_buffer (tmp)->ip.reass.ip6_frag_hdr_offset +
468              sizeof (*frag_hdr));
469           ASSERT (vlib_buffer_length_in_chain (vm, tmp) - trim_end > 0);
470         }
471       u32 keep_data =
472         vlib_buffer_length_in_chain (vm, tmp) - trim_front - trim_end;
473       while (1)
474         {
475           ++buf_cnt;
476           if (trim_front)
477             {
478               if (trim_front > tmp->current_length)
479                 {
480                   /* drop whole buffer */
481                   vec_add1 (*vec_drop_compress, tmp_bi);
482                   ++dropped_cnt;
483                   trim_front -= tmp->current_length;
484                   ASSERT (tmp->flags & VLIB_BUFFER_NEXT_PRESENT);
485                   tmp->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
486                   tmp_bi = tmp->next_buffer;
487                   tmp = vlib_get_buffer (vm, tmp_bi);
488                   continue;
489                 }
490               else
491                 {
492                   vlib_buffer_advance (tmp, trim_front);
493                   trim_front = 0;
494                 }
495             }
496           if (keep_data)
497             {
498               if (last_b)
499                 {
500                   last_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
501                   last_b->next_buffer = tmp_bi;
502                 }
503               last_b = tmp;
504               if (keep_data <= tmp->current_length)
505                 {
506                   tmp->current_length = keep_data;
507                   keep_data = 0;
508                 }
509               else
510                 {
511                   keep_data -= tmp->current_length;
512                   ASSERT (tmp->flags & VLIB_BUFFER_NEXT_PRESENT);
513                 }
514               total_length += tmp->current_length;
515             }
516           else
517             {
518               vec_add1 (*vec_drop_compress, tmp_bi);
519               ASSERT (reass->first_bi != tmp_bi);
520               ++dropped_cnt;
521             }
522           if (tmp->flags & VLIB_BUFFER_NEXT_PRESENT)
523             {
524               tmp_bi = tmp->next_buffer;
525               tmp = vlib_get_buffer (vm, tmp->next_buffer);
526             }
527           else
528             {
529               break;
530             }
531         }
532       sub_chain_bi =
533         vnet_buffer (vlib_get_buffer (vm, sub_chain_bi))->ip.
534         reass.next_range_bi;
535     }
536   while (~0 != sub_chain_bi);
537   last_b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
538   vlib_buffer_t *first_b = vlib_get_buffer (vm, reass->first_bi);
539   ASSERT (total_length >= first_b->current_length);
540   total_length -= first_b->current_length;
541   first_b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
542   first_b->total_length_not_including_first_buffer = total_length;
543   // drop fragment header
544   vnet_buffer_opaque_t *first_b_vnb = vnet_buffer (first_b);
545   ip6_header_t *ip = vlib_buffer_get_current (first_b);
546   u16 ip6_frag_hdr_offset = first_b_vnb->ip.reass.ip6_frag_hdr_offset;
547   ip6_ext_header_t *prev_hdr;
548   ip6_ext_header_find_t (ip, prev_hdr, frag_hdr,
549                          IP_PROTOCOL_IPV6_FRAGMENTATION);
550   if (prev_hdr)
551     {
552       prev_hdr->next_hdr = frag_hdr->next_hdr;
553     }
554   else
555     {
556       ip->protocol = frag_hdr->next_hdr;
557     }
558   ASSERT ((u8 *) frag_hdr - (u8 *) ip == ip6_frag_hdr_offset);
559   memmove (frag_hdr, (u8 *) frag_hdr + sizeof (*frag_hdr),
560            first_b->current_length - ip6_frag_hdr_offset -
561            sizeof (ip6_frag_hdr_t));
562   first_b->current_length -= sizeof (*frag_hdr);
563   ip->payload_length =
564     clib_host_to_net_u16 (total_length + first_b->current_length -
565                           sizeof (*ip));
566   vlib_buffer_chain_compress (vm, first_b, vec_drop_compress);
567   if (PREDICT_FALSE (first_b->flags & VLIB_BUFFER_IS_TRACED))
568     {
569       ip6_reass_add_trace (vm, node, rm, reass, reass->first_bi, FINALIZE, 0);
570 #if 0
571       // following code does a hexdump of packet fragments to stdout ...
572       do
573         {
574           u32 bi = reass->first_bi;
575           u8 *s = NULL;
576           while (~0 != bi)
577             {
578               vlib_buffer_t *b = vlib_get_buffer (vm, bi);
579               s = format (s, "%u: %U\n", bi, format_hexdump,
580                           vlib_buffer_get_current (b), b->current_length);
581               if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
582                 {
583                   bi = b->next_buffer;
584                 }
585               else
586                 {
587                   break;
588                 }
589             }
590           printf ("%.*s\n", vec_len (s), s);
591           fflush (stdout);
592           vec_free (s);
593         }
594       while (0);
595 #endif
596     }
597   if (is_feature)
598     {
599       *next0 = IP6_REASSEMBLY_NEXT_INPUT;
600     }
601   else
602     {
603       *next0 = reass->next_index;
604     }
605   vnet_buffer (first_b)->ip.reass.estimated_mtu = reass->min_fragment_length;
606   ip6_reass_free (rm, rt, reass);
607   reass = NULL;
608 }
609
610 always_inline u32
611 ip6_reass_get_buffer_chain_length (vlib_main_t * vm, vlib_buffer_t * b)
612 {
613   u32 len = 0;
614   while (b)
615     {
616       ++len;
617       if (PREDICT_FALSE (b->flags & VLIB_BUFFER_NEXT_PRESENT))
618         {
619           b = vlib_get_buffer (vm, b->next_buffer);
620         }
621       else
622         {
623           break;
624         }
625     }
626   return len;
627 }
628
629 always_inline void
630 ip6_reass_insert_range_in_chain (vlib_main_t * vm, ip6_reass_main_t * rm,
631                                  ip6_reass_per_thread_t * rt,
632                                  ip6_reass_t * reass, u32 prev_range_bi,
633                                  u32 new_next_bi)
634 {
635
636   vlib_buffer_t *new_next_b = vlib_get_buffer (vm, new_next_bi);
637   vnet_buffer_opaque_t *new_next_vnb = vnet_buffer (new_next_b);
638   if (~0 != prev_range_bi)
639     {
640       vlib_buffer_t *prev_b = vlib_get_buffer (vm, prev_range_bi);
641       vnet_buffer_opaque_t *prev_vnb = vnet_buffer (prev_b);
642       new_next_vnb->ip.reass.next_range_bi = prev_vnb->ip.reass.next_range_bi;
643       prev_vnb->ip.reass.next_range_bi = new_next_bi;
644     }
645   else
646     {
647       if (~0 != reass->first_bi)
648         {
649           new_next_vnb->ip.reass.next_range_bi = reass->first_bi;
650         }
651       reass->first_bi = new_next_bi;
652     }
653   reass->data_len += ip6_reass_buffer_get_data_len (new_next_b);
654   rt->buffers_n += ip6_reass_get_buffer_chain_length (vm, new_next_b);
655 }
656
657 always_inline void
658 ip6_reass_update (vlib_main_t * vm, vlib_node_runtime_t * node,
659                   ip6_reass_main_t * rm, ip6_reass_per_thread_t * rt,
660                   ip6_reass_t * reass, u32 * bi0, u32 * next0,
661                   vlib_error_t * error0, ip6_frag_hdr_t * frag_hdr,
662                   u32 ** vec_drop_overlap, u32 ** vec_drop_compress,
663                   bool is_feature)
664 {
665   int consumed = 0;
666   vlib_buffer_t *fb = vlib_get_buffer (vm, *bi0);
667   vnet_buffer_opaque_t *fvnb = vnet_buffer (fb);
668   fvnb->ip.reass.ip6_frag_hdr_offset =
669     (u8 *) frag_hdr - (u8 *) vlib_buffer_get_current (fb);
670   ip6_header_t *fip = vlib_buffer_get_current (fb);
671   ASSERT (fb->current_length > sizeof (*fip));
672   ASSERT (fvnb->ip.reass.ip6_frag_hdr_offset > 0 &&
673           fvnb->ip.reass.ip6_frag_hdr_offset < fb->current_length);
674   u32 fragment_first = fvnb->ip.reass.fragment_first =
675     ip6_frag_hdr_offset_bytes (frag_hdr);
676   u32 fragment_length =
677     vlib_buffer_length_in_chain (vm, fb) -
678     (fvnb->ip.reass.ip6_frag_hdr_offset + sizeof (*frag_hdr));
679   u32 fragment_last = fvnb->ip.reass.fragment_last =
680     fragment_first + fragment_length - 1;
681   int more_fragments = ip6_frag_hdr_more (frag_hdr);
682   u32 candidate_range_bi = reass->first_bi;
683   u32 prev_range_bi = ~0;
684   fvnb->ip.reass.range_first = fragment_first;
685   fvnb->ip.reass.range_last = fragment_last;
686   fvnb->ip.reass.next_range_bi = ~0;
687   if (!more_fragments)
688     {
689       reass->last_packet_octet = fragment_last;
690     }
691   if (~0 == reass->first_bi)
692     {
693       // starting a new reassembly
694       ip6_reass_insert_range_in_chain (vm, rm, rt, reass, prev_range_bi,
695                                        *bi0);
696       if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
697         {
698           ip6_reass_add_trace (vm, node, rm, reass, *bi0, RANGE_NEW, 0);
699         }
700       reass->min_fragment_length = clib_net_to_host_u16 (fip->payload_length);
701       *bi0 = ~0;
702       return;
703     }
704   reass->min_fragment_length =
705     clib_min (clib_net_to_host_u16 (fip->payload_length),
706               fvnb->ip.reass.estimated_mtu);
707   while (~0 != candidate_range_bi)
708     {
709       vlib_buffer_t *candidate_b = vlib_get_buffer (vm, candidate_range_bi);
710       vnet_buffer_opaque_t *candidate_vnb = vnet_buffer (candidate_b);
711       if (fragment_first > candidate_vnb->ip.reass.range_last)
712         {
713           // this fragments starts after candidate range
714           prev_range_bi = candidate_range_bi;
715           candidate_range_bi = candidate_vnb->ip.reass.next_range_bi;
716           if (candidate_vnb->ip.reass.range_last < fragment_last &&
717               ~0 == candidate_range_bi)
718             {
719               // special case - this fragment falls beyond all known ranges
720               ip6_reass_insert_range_in_chain (vm, rm, rt, reass,
721                                                prev_range_bi, *bi0);
722               consumed = 1;
723               break;
724             }
725           continue;
726         }
727       if (fragment_last < candidate_vnb->ip.reass.range_first)
728         {
729           // this fragment ends before candidate range without any overlap
730           ip6_reass_insert_range_in_chain (vm, rm, rt, reass, prev_range_bi,
731                                            *bi0);
732           consumed = 1;
733         }
734       else if (fragment_first == candidate_vnb->ip.reass.range_first &&
735                fragment_last == candidate_vnb->ip.reass.range_last)
736         {
737           // duplicate fragment - ignore
738         }
739       else
740         {
741           // overlapping fragment - not allowed by RFC 8200
742           ip6_reass_drop_all (vm, rm, reass, vec_drop_overlap);
743           ip6_reass_free (rm, rt, reass);
744           if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
745             {
746               ip6_reass_add_trace (vm, node, rm, reass, *bi0, RANGE_OVERLAP,
747                                    0);
748             }
749           *next0 = IP6_REASSEMBLY_NEXT_DROP;
750           *error0 = IP6_ERROR_REASS_OVERLAPPING_FRAGMENT;
751         }
752       break;
753     }
754   if (consumed)
755     {
756       if (PREDICT_FALSE (fb->flags & VLIB_BUFFER_IS_TRACED))
757         {
758           ip6_reass_add_trace (vm, node, rm, reass, *bi0, RANGE_NEW, 0);
759         }
760     }
761   if (~0 != reass->last_packet_octet &&
762       reass->data_len == reass->last_packet_octet + 1)
763     {
764       ip6_reass_finalize (vm, node, rm, rt, reass, bi0, next0, error0,
765                           vec_drop_compress, is_feature);
766     }
767   else
768     {
769       if (consumed)
770         {
771           *bi0 = ~0;
772         }
773       else
774         {
775           *next0 = IP6_REASSEMBLY_NEXT_DROP;
776           ;
777           *error0 = IP6_ERROR_REASS_DUPLICATE_FRAGMENT;
778         }
779     }
780 }
781
782 always_inline bool
783 ip6_reass_verify_upper_layer_present (vlib_node_runtime_t * node,
784                                       vlib_buffer_t * b,
785                                       ip6_frag_hdr_t * frag_hdr)
786 {
787   ip6_ext_header_t *tmp = (ip6_ext_header_t *) frag_hdr;
788   while (ip6_ext_hdr (tmp->next_hdr))
789     {
790       tmp = ip6_ext_next_header (tmp);
791     }
792   if (IP_PROTOCOL_IP6_NONXT == tmp->next_hdr)
793     {
794       icmp6_error_set_vnet_buffer (b, ICMP6_parameter_problem,
795                                    ICMP6_parameter_problem_first_fragment_has_incomplete_header_chain,
796                                    0);
797       b->error = node->errors[IP6_ERROR_REASS_MISSING_UPPER];
798
799       return false;
800     }
801   return true;
802 }
803
804 always_inline bool
805 ip6_reass_verify_fragment_multiple_8 (vlib_main_t * vm,
806                                       vlib_node_runtime_t * node,
807                                       vlib_buffer_t * b,
808                                       ip6_frag_hdr_t * frag_hdr)
809 {
810   vnet_buffer_opaque_t *vnb = vnet_buffer (b);
811   ip6_header_t *ip = vlib_buffer_get_current (b);
812   int more_fragments = ip6_frag_hdr_more (frag_hdr);
813   u32 fragment_length =
814     vlib_buffer_length_in_chain (vm, b) -
815     (vnb->ip.reass.ip6_frag_hdr_offset + sizeof (*frag_hdr));
816   if (more_fragments && 0 != fragment_length % 8)
817     {
818       icmp6_error_set_vnet_buffer (b, ICMP6_parameter_problem,
819                                    ICMP6_parameter_problem_erroneous_header_field,
820                                    (u8 *) & ip->payload_length - (u8 *) ip);
821       return false;
822     }
823   return true;
824 }
825
826 always_inline bool
827 ip6_reass_verify_packet_size_lt_64k (vlib_main_t * vm,
828                                      vlib_node_runtime_t * node,
829                                      vlib_buffer_t * b,
830                                      ip6_frag_hdr_t * frag_hdr)
831 {
832   vnet_buffer_opaque_t *vnb = vnet_buffer (b);
833   u32 fragment_first = ip6_frag_hdr_offset_bytes (frag_hdr);
834   u32 fragment_length =
835     vlib_buffer_length_in_chain (vm, b) -
836     (vnb->ip.reass.ip6_frag_hdr_offset + sizeof (*frag_hdr));
837   if (fragment_first + fragment_length > 65535)
838     {
839       ip6_header_t *ip0 = vlib_buffer_get_current (b);
840       icmp6_error_set_vnet_buffer (b, ICMP6_parameter_problem,
841                                    ICMP6_parameter_problem_erroneous_header_field,
842                                    (u8 *) & frag_hdr->fragment_offset_and_more
843                                    - (u8 *) ip0);
844       return false;
845     }
846   return true;
847 }
848
849 always_inline uword
850 ip6_reassembly_inline (vlib_main_t * vm,
851                        vlib_node_runtime_t * node,
852                        vlib_frame_t * frame, bool is_feature)
853 {
854   u32 *from = vlib_frame_vector_args (frame);
855   u32 n_left_from, n_left_to_next, *to_next, next_index;
856   ip6_reass_main_t *rm = &ip6_reass_main;
857   ip6_reass_per_thread_t *rt = &rm->per_thread_data[os_get_thread_index ()];
858   clib_spinlock_lock (&rt->lock);
859
860   n_left_from = frame->n_vectors;
861   next_index = node->cached_next_index;
862   static u32 *vec_timeout = NULL;       // indexes of buffers which timed out
863   static u32 *vec_drop_overlap = NULL;  // indexes of buffers dropped due to overlap
864   static u32 *vec_drop_compress = NULL; // indexes of buffers dropped due to buffer compression
865   while (n_left_from > 0 || vec_len (vec_timeout) > 0 ||
866          vec_len (vec_drop_overlap) > 0 || vec_len (vec_drop_compress) > 0)
867     {
868       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
869
870       while (vec_len (vec_timeout) > 0 && n_left_to_next > 0)
871         {
872           u32 bi = vec_pop (vec_timeout);
873           vlib_buffer_t *b = vlib_get_buffer (vm, bi);
874           b->error = node->errors[IP6_ERROR_REASS_TIMEOUT];
875           to_next[0] = bi;
876           to_next += 1;
877           n_left_to_next -= 1;
878           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
879                                            n_left_to_next, bi,
880                                            IP6_REASSEMBLY_NEXT_DROP);
881           ASSERT (rt->buffers_n > 0);
882           --rt->buffers_n;
883         }
884
885       while (vec_len (vec_drop_overlap) > 0 && n_left_to_next > 0)
886         {
887           u32 bi = vec_pop (vec_drop_overlap);
888           vlib_buffer_t *b = vlib_get_buffer (vm, bi);
889           b->error = node->errors[IP6_ERROR_REASS_OVERLAPPING_FRAGMENT];
890           to_next[0] = bi;
891           to_next += 1;
892           n_left_to_next -= 1;
893           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
894                                            n_left_to_next, bi,
895                                            IP6_REASSEMBLY_NEXT_DROP);
896           ASSERT (rt->buffers_n > 0);
897           --rt->buffers_n;
898         }
899
900       while (vec_len (vec_drop_compress) > 0 && n_left_to_next > 0)
901         {
902           u32 bi = vec_pop (vec_drop_compress);
903           vlib_buffer_t *b = vlib_get_buffer (vm, bi);
904           b->error = node->errors[IP6_ERROR_NONE];
905           to_next[0] = bi;
906           to_next += 1;
907           n_left_to_next -= 1;
908           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
909                                            n_left_to_next, bi,
910                                            IP6_REASSEMBLY_NEXT_DROP);
911           ASSERT (rt->buffers_n > 0);
912           --rt->buffers_n;
913         }
914
915       while (n_left_from > 0 && n_left_to_next > 0)
916         {
917           u32 bi0;
918           vlib_buffer_t *b0;
919           u32 next0;
920           u32 error0 = IP6_ERROR_NONE;
921           u32 icmp_bi = ~0;
922
923           bi0 = from[0];
924           b0 = vlib_get_buffer (vm, bi0);
925
926           ip6_header_t *ip0 = vlib_buffer_get_current (b0);
927           ip6_frag_hdr_t *frag_hdr;
928           ip6_ext_header_t *prev_hdr;
929           ip6_ext_header_find_t (ip0, prev_hdr, frag_hdr,
930                                  IP_PROTOCOL_IPV6_FRAGMENTATION);
931           if (!frag_hdr)
932             {
933               // this is a regular packet - no fragmentation
934               next0 = IP6_REASSEMBLY_NEXT_INPUT;
935               goto skip_reass;
936             }
937           if (0 == ip6_frag_hdr_offset (frag_hdr))
938             {
939               // first fragment - verify upper-layer is present
940               if (!ip6_reass_verify_upper_layer_present (node, b0, frag_hdr))
941                 {
942                   next0 = IP6_REASSEMBLY_NEXT_ICMP_ERROR;
943                   goto skip_reass;
944                 }
945             }
946           if (!ip6_reass_verify_fragment_multiple_8 (vm, node, b0, frag_hdr)
947               || !ip6_reass_verify_packet_size_lt_64k (vm, node, b0,
948                                                        frag_hdr))
949             {
950               next0 = IP6_REASSEMBLY_NEXT_ICMP_ERROR;
951               goto skip_reass;
952             }
953           vnet_buffer (b0)->ip.reass.ip6_frag_hdr_offset =
954             (u8 *) frag_hdr - (u8 *) ip0;
955
956           ip6_reass_key_t k;
957           k.src.as_u64[0] = ip0->src_address.as_u64[0];
958           k.src.as_u64[1] = ip0->src_address.as_u64[1];
959           k.dst.as_u64[0] = ip0->dst_address.as_u64[0];
960           k.dst.as_u64[1] = ip0->dst_address.as_u64[1];
961           k.xx_id = vnet_buffer (b0)->sw_if_index[VLIB_RX];
962           k.frag_id = frag_hdr->identification;
963           k.proto = ip0->protocol;
964           k.unused = 0;
965           ip6_reass_t *reass =
966             ip6_reass_find_or_create (vm, node, rm, rt, &k, &icmp_bi,
967                                       &vec_timeout);
968
969           if (reass)
970             {
971               ip6_reass_update (vm, node, rm, rt, reass, &bi0, &next0,
972                                 &error0, frag_hdr, &vec_drop_overlap,
973                                 &vec_drop_compress, is_feature);
974             }
975           else
976             {
977               next0 = IP6_REASSEMBLY_NEXT_DROP;
978               error0 = IP6_ERROR_REASS_LIMIT_REACHED;
979             }
980
981           b0->error = node->errors[error0];
982
983           if (~0 != bi0)
984             {
985             skip_reass:
986               to_next[0] = bi0;
987               to_next += 1;
988               n_left_to_next -= 1;
989               if (is_feature && IP6_ERROR_NONE == error0)
990                 {
991                   vnet_feature_next (vnet_buffer (b0)->sw_if_index[VLIB_RX],
992                                      &next0, b0);
993                 }
994               vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
995                                                n_left_to_next, bi0, next0);
996             }
997
998           if (~0 != icmp_bi)
999             {
1000               next0 = IP6_REASSEMBLY_NEXT_ICMP_ERROR;
1001               to_next[0] = icmp_bi;
1002               to_next += 1;
1003               n_left_to_next -= 1;
1004               vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
1005                                                n_left_to_next, icmp_bi,
1006                                                next0);
1007             }
1008           from += 1;
1009           n_left_from -= 1;
1010         }
1011
1012       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1013     }
1014
1015   clib_spinlock_unlock (&rt->lock);
1016   return frame->n_vectors;
1017 }
1018
1019 static char *ip6_reassembly_error_strings[] = {
1020 #define _(sym, string) string,
1021   foreach_ip6_error
1022 #undef _
1023 };
1024
1025 always_inline uword
1026 ip6_reassembly (vlib_main_t * vm, vlib_node_runtime_t * node,
1027                 vlib_frame_t * frame)
1028 {
1029   return ip6_reassembly_inline (vm, node, frame, false /* is_feature */ );
1030 }
1031
1032 /* *INDENT-OFF* */
1033 VLIB_REGISTER_NODE (ip6_reass_node, static) = {
1034     .function = ip6_reassembly,
1035     .name = "ip6-reassembly",
1036     .vector_size = sizeof (u32),
1037     .format_trace = format_ip6_reass_trace,
1038     .n_errors = ARRAY_LEN (ip6_reassembly_error_strings),
1039     .error_strings = ip6_reassembly_error_strings,
1040     .n_next_nodes = IP6_REASSEMBLY_N_NEXT,
1041     .next_nodes =
1042         {
1043                 [IP6_REASSEMBLY_NEXT_INPUT] = "ip6-input",
1044                 [IP6_REASSEMBLY_NEXT_DROP] = "ip6-drop",
1045                 [IP6_REASSEMBLY_NEXT_ICMP_ERROR] = "ip6-icmp-error",
1046         },
1047 };
1048 /* *INDENT-ON* */
1049
1050 VLIB_NODE_FUNCTION_MULTIARCH (ip6_reass_node, ip6_reassembly);
1051
1052 always_inline uword
1053 ip6_reassembly_feature (vlib_main_t * vm,
1054                         vlib_node_runtime_t * node, vlib_frame_t * frame)
1055 {
1056   return ip6_reassembly_inline (vm, node, frame, true /* is_feature */ );
1057 }
1058
1059 /* *INDENT-OFF* */
1060 VLIB_REGISTER_NODE (ip6_reass_node_feature, static) = {
1061     .function = ip6_reassembly_feature,
1062     .name = "ip6-reassembly-feature",
1063     .vector_size = sizeof (u32),
1064     .format_trace = format_ip6_reass_trace,
1065     .n_errors = ARRAY_LEN (ip6_reassembly_error_strings),
1066     .error_strings = ip6_reassembly_error_strings,
1067     .n_next_nodes = IP6_REASSEMBLY_N_NEXT,
1068     .next_nodes =
1069         {
1070                 [IP6_REASSEMBLY_NEXT_INPUT] = "ip6-input",
1071                 [IP6_REASSEMBLY_NEXT_DROP] = "ip6-drop",
1072                 [IP6_REASSEMBLY_NEXT_ICMP_ERROR] = "ip6-icmp-error",
1073         },
1074 };
1075 /* *INDENT-ON* */
1076
1077 VLIB_NODE_FUNCTION_MULTIARCH (ip6_reass_node_feature, ip6_reassembly_feature);
1078
1079 /* *INDENT-OFF* */
1080 VNET_FEATURE_INIT (ip6_reassembly_feature, static) = {
1081     .arc_name = "ip6-unicast",
1082     .node_name = "ip6-reassembly-feature",
1083     .runs_before = VNET_FEATURES ("ip6-lookup"),
1084     .runs_after = 0,
1085 };
1086 /* *INDENT-ON* */
1087
1088 static u32
1089 ip6_reass_get_nbuckets ()
1090 {
1091   ip6_reass_main_t *rm = &ip6_reass_main;
1092   u32 nbuckets;
1093   u8 i;
1094
1095   nbuckets = (u32) (rm->max_reass_n / IP6_REASS_HT_LOAD_FACTOR);
1096
1097   for (i = 0; i < 31; i++)
1098     if ((1 << i) >= nbuckets)
1099       break;
1100   nbuckets = 1 << i;
1101
1102   return nbuckets;
1103 }
1104
1105 typedef enum
1106 {
1107   IP6_EVENT_CONFIG_CHANGED = 1,
1108 } ip6_reass_event_t;
1109
1110 typedef struct
1111 {
1112   int failure;
1113   clib_bihash_48_8_t *new_hash;
1114 } ip6_rehash_cb_ctx;
1115
1116 static void
1117 ip6_rehash_cb (clib_bihash_kv_48_8_t * kv, void *_ctx)
1118 {
1119   ip6_rehash_cb_ctx *ctx = _ctx;
1120   if (clib_bihash_add_del_48_8 (ctx->new_hash, kv, 1))
1121     {
1122       ctx->failure = 1;
1123     }
1124 }
1125
1126 static void
1127 ip6_reass_set_params (u32 timeout_ms, u32 max_reassemblies,
1128                       u32 expire_walk_interval_ms)
1129 {
1130   ip6_reass_main.timeout_ms = timeout_ms;
1131   ip6_reass_main.timeout = (f64) timeout_ms / (f64) MSEC_PER_SEC;
1132   ip6_reass_main.max_reass_n = max_reassemblies;
1133   ip6_reass_main.expire_walk_interval_ms = expire_walk_interval_ms;
1134 }
1135
1136 vnet_api_error_t
1137 ip6_reass_set (u32 timeout_ms, u32 max_reassemblies,
1138                u32 expire_walk_interval_ms)
1139 {
1140   u32 old_nbuckets = ip6_reass_get_nbuckets ();
1141   ip6_reass_set_params (timeout_ms, max_reassemblies,
1142                         expire_walk_interval_ms);
1143   vlib_process_signal_event (ip6_reass_main.vlib_main,
1144                              ip6_reass_main.ip6_reass_expire_node_idx,
1145                              IP6_EVENT_CONFIG_CHANGED, 0);
1146   u32 new_nbuckets = ip6_reass_get_nbuckets ();
1147   if (ip6_reass_main.max_reass_n > 0 && new_nbuckets > 1 &&
1148       new_nbuckets != old_nbuckets)
1149     {
1150       clib_bihash_48_8_t new_hash;
1151       memset (&new_hash, 0, sizeof (new_hash));
1152       ip6_rehash_cb_ctx ctx;
1153       ctx.failure = 0;
1154       ctx.new_hash = &new_hash;
1155       clib_bihash_init_48_8 (&new_hash, "ip6-reass", new_nbuckets,
1156                              new_nbuckets * 1024);
1157       clib_bihash_foreach_key_value_pair_48_8 (&ip6_reass_main.hash,
1158                                                ip6_rehash_cb, &ctx);
1159       if (ctx.failure)
1160         {
1161           clib_bihash_free_48_8 (&new_hash);
1162           return -1;
1163         }
1164       else
1165         {
1166           clib_bihash_free_48_8 (&ip6_reass_main.hash);
1167           clib_memcpy (&ip6_reass_main.hash, &new_hash,
1168                        sizeof (ip6_reass_main.hash));
1169         }
1170     }
1171   return 0;
1172 }
1173
1174 vnet_api_error_t
1175 ip6_reass_get (u32 * timeout_ms, u32 * max_reassemblies,
1176                u32 * expire_walk_interval_ms)
1177 {
1178   *timeout_ms = ip6_reass_main.timeout_ms;
1179   *max_reassemblies = ip6_reass_main.max_reass_n;
1180   *expire_walk_interval_ms = ip6_reass_main.expire_walk_interval_ms;
1181   return 0;
1182 }
1183
1184 static clib_error_t *
1185 ip6_reass_init_function (vlib_main_t * vm)
1186 {
1187   ip6_reass_main_t *rm = &ip6_reass_main;
1188   clib_error_t *error = 0;
1189   u32 nbuckets;
1190   vlib_node_t *node;
1191
1192   rm->vlib_main = vm;
1193   rm->vnet_main = vnet_get_main ();
1194
1195   vec_validate (rm->per_thread_data, vlib_num_workers () + 1);
1196   ip6_reass_per_thread_t *rt;
1197   vec_foreach (rt, rm->per_thread_data)
1198   {
1199     clib_spinlock_init (&rt->lock);
1200     pool_alloc (rt->pool, rm->max_reass_n);
1201   }
1202
1203   node = vlib_get_node_by_name (vm, (u8 *) "ip6-reassembly-expire-walk");
1204   ASSERT (node);
1205   rm->ip6_reass_expire_node_idx = node->index;
1206
1207   nbuckets = ip6_reass_get_nbuckets ();
1208   clib_bihash_init_48_8 (&rm->hash, "ip6-reass", nbuckets, nbuckets * 1024);
1209
1210   node = vlib_get_node_by_name (vm, (u8 *) "ip6-drop");
1211   ASSERT (node);
1212   rm->ip6_drop_idx = node->index;
1213   node = vlib_get_node_by_name (vm, (u8 *) "ip6-icmp-error");
1214   ASSERT (node);
1215   rm->ip6_icmp_error_idx = node->index;
1216
1217   if ((error = vlib_call_init_function (vm, ip_main_init)))
1218     return error;
1219   ip6_register_protocol (IP_PROTOCOL_IPV6_FRAGMENTATION,
1220                          ip6_reass_node.index);
1221
1222   ip6_reass_set_params (IP6_REASS_TIMEOUT_DEFAULT_MS,
1223                         IP6_REASS_MAX_REASSEMBLIES_DEFAULT,
1224                         IP6_REASS_EXPIRE_WALK_INTERVAL_DEFAULT_MS);
1225
1226   return error;
1227 }
1228
1229 VLIB_INIT_FUNCTION (ip6_reass_init_function);
1230
1231 static uword
1232 ip6_reass_walk_expired (vlib_main_t * vm,
1233                         vlib_node_runtime_t * node, vlib_frame_t * f)
1234 {
1235   ip6_reass_main_t *rm = &ip6_reass_main;
1236   uword event_type, *event_data = 0;
1237
1238   while (true)
1239     {
1240       vlib_process_wait_for_event_or_clock (vm,
1241                                             (f64) rm->expire_walk_interval_ms
1242                                             / (f64) MSEC_PER_SEC);
1243       event_type = vlib_process_get_events (vm, &event_data);
1244
1245       switch (event_type)
1246         {
1247         case ~0:                /* no events => timeout */
1248           /* nothing to do here */
1249           break;
1250         case IP6_EVENT_CONFIG_CHANGED:
1251           break;
1252         default:
1253           clib_warning ("BUG: event type 0x%wx", event_type);
1254           break;
1255         }
1256       f64 now = vlib_time_now (vm);
1257
1258       ip6_reass_t *reass;
1259       u32 *vec_timeout = NULL;
1260       int *pool_indexes_to_free = NULL;
1261
1262       uword thread_index = 0;
1263       int index;
1264       const uword nthreads = os_get_nthreads ();
1265       u32 *vec_icmp_bi = NULL;
1266       for (thread_index = 0; thread_index < nthreads; ++thread_index)
1267         {
1268           ip6_reass_per_thread_t *rt = &rm->per_thread_data[thread_index];
1269           clib_spinlock_lock (&rt->lock);
1270
1271           vec_reset_length (pool_indexes_to_free);
1272           /* *INDENT-OFF* */
1273           pool_foreach_index (index, rt->pool, ({
1274                                 reass = pool_elt_at_index (rt->pool, index);
1275                                 if (now > reass->last_heard + rm->timeout)
1276                                   {
1277                                     vec_add1 (pool_indexes_to_free, index);
1278                                   }
1279                               }));
1280           /* *INDENT-ON* */
1281           int *i;
1282           /* *INDENT-OFF* */
1283           vec_foreach (i, pool_indexes_to_free)
1284           {
1285             ip6_reass_t *reass = pool_elt_at_index (rt->pool, i[0]);
1286             u32 icmp_bi = ~0;
1287             u32 before = vec_len (vec_timeout);
1288             vlib_buffer_t *b = vlib_get_buffer (vm, reass->first_bi);
1289             if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
1290               {
1291                 if (pool_is_free_index (vm->trace_main.trace_buffer_pool,
1292                                         b->trace_index))
1293                   {
1294                     /* the trace is gone, don't trace this buffer anymore */
1295                     b->flags &= ~VLIB_BUFFER_IS_TRACED;
1296                   }
1297               }
1298             ip6_reass_on_timeout (vm, node, rm, reass, &icmp_bi, &vec_timeout);
1299             u32 after = vec_len (vec_timeout);
1300             ASSERT (rt->buffers_n >= (after - before));
1301             rt->buffers_n -= (after - before);
1302             if (~0 != icmp_bi)
1303               {
1304                 vec_add1 (vec_icmp_bi, icmp_bi);
1305                 ASSERT (rt->buffers_n > 0);
1306                 --rt->buffers_n;
1307               }
1308             ip6_reass_free (rm, rt, reass);
1309           }
1310           /* *INDENT-ON* */
1311
1312           clib_spinlock_unlock (&rt->lock);
1313         }
1314
1315       while (vec_len (vec_timeout) > 0)
1316         {
1317           vlib_frame_t *f = vlib_get_frame_to_node (vm, rm->ip6_drop_idx);
1318           u32 *to_next = vlib_frame_vector_args (f);
1319           u32 n_left_to_next = VLIB_FRAME_SIZE - f->n_vectors;
1320           int trace_frame = 0;
1321           while (vec_len (vec_timeout) > 0 && n_left_to_next > 0)
1322             {
1323               u32 bi = vec_pop (vec_timeout);
1324               vlib_buffer_t *b = vlib_get_buffer (vm, bi);
1325               if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
1326                 {
1327                   if (pool_is_free_index (vm->trace_main.trace_buffer_pool,
1328                                           b->trace_index))
1329                     {
1330                       /* the trace is gone, don't trace this buffer anymore */
1331                       b->flags &= ~VLIB_BUFFER_IS_TRACED;
1332                     }
1333                   else
1334                     {
1335                       trace_frame = 1;
1336                     }
1337                 }
1338               b->error = node->errors[IP6_ERROR_REASS_TIMEOUT];
1339               to_next[0] = bi;
1340               ++f->n_vectors;
1341               to_next += 1;
1342               n_left_to_next -= 1;
1343             }
1344           f->flags |= (trace_frame * VLIB_FRAME_TRACE);
1345           vlib_put_frame_to_node (vm, rm->ip6_drop_idx, f);
1346         }
1347
1348       while (vec_len (vec_icmp_bi) > 0)
1349         {
1350           vlib_frame_t *f =
1351             vlib_get_frame_to_node (vm, rm->ip6_icmp_error_idx);
1352           u32 *to_next = vlib_frame_vector_args (f);
1353           u32 n_left_to_next = VLIB_FRAME_SIZE - f->n_vectors;
1354           int trace_frame = 0;
1355           while (vec_len (vec_icmp_bi) > 0 && n_left_to_next > 0)
1356             {
1357               u32 bi = vec_pop (vec_icmp_bi);
1358               vlib_buffer_t *b = vlib_get_buffer (vm, bi);
1359               if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
1360                 {
1361                   if (pool_is_free_index (vm->trace_main.trace_buffer_pool,
1362                                           b->trace_index))
1363                     {
1364                       /* the trace is gone, don't trace this buffer anymore */
1365                       b->flags &= ~VLIB_BUFFER_IS_TRACED;
1366                     }
1367                   else
1368                     {
1369                       trace_frame = 1;
1370                     }
1371                 }
1372               b->error = node->errors[IP6_ERROR_REASS_TIMEOUT];
1373               to_next[0] = bi;
1374               ++f->n_vectors;
1375               to_next += 1;
1376               n_left_to_next -= 1;
1377             }
1378           f->flags |= (trace_frame * VLIB_FRAME_TRACE);
1379           vlib_put_frame_to_node (vm, rm->ip6_icmp_error_idx, f);
1380         }
1381
1382       vec_free (pool_indexes_to_free);
1383       vec_free (vec_timeout);
1384       vec_free (vec_icmp_bi);
1385       if (event_data)
1386         {
1387           _vec_len (event_data) = 0;
1388         }
1389     }
1390
1391   return 0;
1392 }
1393
1394 static vlib_node_registration_t ip6_reass_expire_node;
1395
1396 /* *INDENT-OFF* */
1397 VLIB_REGISTER_NODE (ip6_reass_expire_node, static) = {
1398     .function = ip6_reass_walk_expired,
1399     .format_trace = format_ip6_reass_trace,
1400     .type = VLIB_NODE_TYPE_PROCESS,
1401     .name = "ip6-reassembly-expire-walk",
1402
1403     .n_errors = ARRAY_LEN (ip6_reassembly_error_strings),
1404     .error_strings = ip6_reassembly_error_strings,
1405
1406 };
1407 /* *INDENT-ON* */
1408
1409 static u8 *
1410 format_ip6_reass_key (u8 * s, va_list * args)
1411 {
1412   ip6_reass_key_t *key = va_arg (*args, ip6_reass_key_t *);
1413   s = format (s, "xx_id: %u, src: %U, dst: %U, frag_id: %u, proto: %u",
1414               key->xx_id, format_ip6_address, &key->src, format_ip6_address,
1415               &key->dst, clib_net_to_host_u16 (key->frag_id), key->proto);
1416   return s;
1417 }
1418
1419 static u8 *
1420 format_ip6_reass (u8 * s, va_list * args)
1421 {
1422   vlib_main_t *vm = va_arg (*args, vlib_main_t *);
1423   ip6_reass_t *reass = va_arg (*args, ip6_reass_t *);
1424
1425   s = format (s, "ID: %lu, key: %U\n  first_bi: %u, data_len: %u, "
1426               "last_packet_octet: %u, trace_op_counter: %u\n",
1427               reass->id, format_ip6_reass_key, &reass->key, reass->first_bi,
1428               reass->data_len, reass->last_packet_octet,
1429               reass->trace_op_counter);
1430   u32 bi = reass->first_bi;
1431   u32 counter = 0;
1432   while (~0 != bi)
1433     {
1434       vlib_buffer_t *b = vlib_get_buffer (vm, bi);
1435       vnet_buffer_opaque_t *vnb = vnet_buffer (b);
1436       s = format (s, "  #%03u: range: [%u, %u], bi: %u, off: %d, len: %u, "
1437                   "fragment[%u, %u]\n",
1438                   counter, vnb->ip.reass.range_first,
1439                   vnb->ip.reass.range_last, bi,
1440                   ip6_reass_buffer_get_data_offset_no_check (b),
1441                   ip6_reass_buffer_get_data_len_no_check (b),
1442                   vnb->ip.reass.fragment_first, vnb->ip.reass.fragment_last);
1443       if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
1444         {
1445           bi = b->next_buffer;
1446         }
1447       else
1448         {
1449           bi = ~0;
1450         }
1451     }
1452   return s;
1453 }
1454
1455 static clib_error_t *
1456 show_ip6_reass (vlib_main_t * vm, unformat_input_t * input,
1457                 CLIB_UNUSED (vlib_cli_command_t * lmd))
1458 {
1459   ip6_reass_main_t *rm = &ip6_reass_main;
1460
1461   vlib_cli_output (vm, "---------------------");
1462   vlib_cli_output (vm, "IP6 reassembly status");
1463   vlib_cli_output (vm, "---------------------");
1464   bool details = false;
1465   if (unformat (input, "details"))
1466     {
1467       details = true;
1468     }
1469
1470   u32 sum_reass_n = 0;
1471   u64 sum_buffers_n = 0;
1472   ip6_reass_t *reass;
1473   uword thread_index;
1474   const uword nthreads = os_get_nthreads ();
1475   for (thread_index = 0; thread_index < nthreads; ++thread_index)
1476     {
1477       ip6_reass_per_thread_t *rt = &rm->per_thread_data[thread_index];
1478       clib_spinlock_lock (&rt->lock);
1479       if (details)
1480         {
1481           /* *INDENT-OFF* */
1482           pool_foreach (reass, rt->pool, {
1483             vlib_cli_output (vm, "%U", format_ip6_reass, vm, reass);
1484           });
1485           /* *INDENT-ON* */
1486         }
1487       sum_reass_n += rt->reass_n;
1488       sum_buffers_n += rt->buffers_n;
1489       clib_spinlock_unlock (&rt->lock);
1490     }
1491   vlib_cli_output (vm, "---------------------");
1492   vlib_cli_output (vm, "Current IP6 reassemblies count: %lu\n",
1493                    (long unsigned) sum_reass_n);
1494   vlib_cli_output (vm, "Maximum configured concurrent IP6 reassemblies per "
1495                    "worker-thread: %lu\n", (long unsigned) rm->max_reass_n);
1496   vlib_cli_output (vm, "Buffers in use: %lu\n",
1497                    (long unsigned) sum_buffers_n);
1498   return 0;
1499 }
1500
1501 /* *INDENT-OFF* */
1502 VLIB_CLI_COMMAND (show_ip6_reassembly_cmd, static) = {
1503     .path = "show ip6-reassembly",
1504     .short_help = "show ip6-reassembly [details]",
1505     .function = show_ip6_reass,
1506 };
1507 /* *INDENT-ON* */
1508
1509 vnet_api_error_t
1510 ip6_reass_enable_disable (u32 sw_if_index, u8 enable_disable)
1511 {
1512   return vnet_feature_enable_disable ("ip6-unicast", "ip6-reassembly-feature",
1513                                       sw_if_index, enable_disable, 0, 0);
1514 }
1515
1516 /*
1517  * fd.io coding-style-patch-verification: ON
1518  *
1519  * Local Variables:
1520  * eval: (c-set-style "gnu")
1521  * End:
1522  */