memif: add severity to counters
[vpp.git] / src / vnet / interface.c
1 /*
2  * Copyright (c) 2015 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  * interface.c: VNET interfaces/sub-interfaces
17  *
18  * Copyright (c) 2008 Eliot Dresselhaus
19  *
20  * Permission is hereby granted, free of charge, to any person obtaining
21  * a copy of this software and associated documentation files (the
22  * "Software"), to deal in the Software without restriction, including
23  * without limitation the rights to use, copy, modify, merge, publish,
24  * distribute, sublicense, and/or sell copies of the Software, and to
25  * permit persons to whom the Software is furnished to do so, subject to
26  * the following conditions:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
31  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32  *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33  *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34  *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35  *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36  *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37  *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38  */
39
40 #include <vnet/vnet.h>
41 #include <vnet/plugin/plugin.h>
42 #include <vnet/adj/adj.h>
43 #include <vnet/adj/adj_mcast.h>
44 #include <vnet/ip/ip.h>
45 #include <vnet/interface/rx_queue_funcs.h>
46
47 /* *INDENT-OFF* */
48 VLIB_REGISTER_LOG_CLASS (if_default_log, static) = {
49   .class_name = "interface",
50 };
51 /* *INDENT-ON* */
52
53 #define log_debug(fmt,...) vlib_log_debug(if_default_log.class, fmt, __VA_ARGS__)
54 #define log_err(fmt,...) vlib_log_err(if_default_log.class, fmt, __VA_ARGS__)
55
56 typedef enum vnet_interface_helper_flags_t_
57 {
58   VNET_INTERFACE_SET_FLAGS_HELPER_IS_CREATE = (1 << 0),
59   VNET_INTERFACE_SET_FLAGS_HELPER_WANT_REDISTRIBUTE = (1 << 1),
60 } vnet_interface_helper_flags_t;
61
62 static clib_error_t *vnet_hw_interface_set_flags_helper (vnet_main_t * vnm,
63                                                          u32 hw_if_index,
64                                                          vnet_hw_interface_flags_t
65                                                          flags,
66                                                          vnet_interface_helper_flags_t
67                                                          helper_flags);
68
69 static clib_error_t *vnet_sw_interface_set_flags_helper (vnet_main_t * vnm,
70                                                          u32 sw_if_index,
71                                                          vnet_sw_interface_flags_t
72                                                          flags,
73                                                          vnet_interface_helper_flags_t
74                                                          helper_flags);
75
76 static clib_error_t *vnet_hw_interface_set_class_helper (vnet_main_t * vnm,
77                                                          u32 hw_if_index,
78                                                          u32 hw_class_index,
79                                                          u32 redistribute);
80
81 typedef struct
82 {
83   /* Either sw or hw interface index. */
84   u32 sw_hw_if_index;
85
86   /* Flags. */
87   u32 flags;
88 } vnet_sw_hw_interface_state_t;
89
90 static void
91 serialize_vec_vnet_sw_hw_interface_state (serialize_main_t * m, va_list * va)
92 {
93   vnet_sw_hw_interface_state_t *s =
94     va_arg (*va, vnet_sw_hw_interface_state_t *);
95   u32 n = va_arg (*va, u32);
96   u32 i;
97   for (i = 0; i < n; i++)
98     {
99       serialize_integer (m, s[i].sw_hw_if_index,
100                          sizeof (s[i].sw_hw_if_index));
101       serialize_integer (m, s[i].flags, sizeof (s[i].flags));
102     }
103 }
104
105 static void
106 unserialize_vec_vnet_sw_hw_interface_state (serialize_main_t * m,
107                                             va_list * va)
108 {
109   vnet_sw_hw_interface_state_t *s =
110     va_arg (*va, vnet_sw_hw_interface_state_t *);
111   u32 n = va_arg (*va, u32);
112   u32 i;
113   for (i = 0; i < n; i++)
114     {
115       unserialize_integer (m, &s[i].sw_hw_if_index,
116                            sizeof (s[i].sw_hw_if_index));
117       unserialize_integer (m, &s[i].flags, sizeof (s[i].flags));
118     }
119 }
120
121 static vnet_sw_interface_flags_t
122 vnet_hw_interface_flags_to_sw (vnet_hw_interface_flags_t hwf)
123 {
124   vnet_sw_interface_flags_t swf = VNET_SW_INTERFACE_FLAG_NONE;
125
126   if (hwf & VNET_HW_INTERFACE_FLAG_LINK_UP)
127     swf |= VNET_SW_INTERFACE_FLAG_ADMIN_UP;
128
129   return (swf);
130 }
131
132 void
133 serialize_vnet_interface_state (serialize_main_t * m, va_list * va)
134 {
135   vnet_main_t *vnm = va_arg (*va, vnet_main_t *);
136   vnet_sw_hw_interface_state_t *sts = 0, *st;
137   vnet_sw_interface_t *sif;
138   vnet_hw_interface_t *hif;
139   vnet_interface_main_t *im = &vnm->interface_main;
140
141   /* Serialize hardware interface classes since they may have changed.
142      Must do this before sending up/down flags. */
143   /* *INDENT-OFF* */
144   pool_foreach (hif, im->hw_interfaces)  {
145     vnet_hw_interface_class_t * hw_class = vnet_get_hw_interface_class (vnm, hif->hw_class_index);
146     serialize_cstring (m, hw_class->name);
147   }
148   /* *INDENT-ON* */
149
150   /* Send sw/hw interface state when non-zero. */
151   /* *INDENT-OFF* */
152   pool_foreach (sif, im->sw_interfaces)  {
153     if (sif->flags != 0)
154       {
155         vec_add2 (sts, st, 1);
156         st->sw_hw_if_index = sif->sw_if_index;
157         st->flags = sif->flags;
158       }
159   }
160   /* *INDENT-ON* */
161
162   vec_serialize (m, sts, serialize_vec_vnet_sw_hw_interface_state);
163
164   if (sts)
165     _vec_len (sts) = 0;
166
167   /* *INDENT-OFF* */
168   pool_foreach (hif, im->hw_interfaces)  {
169     if (hif->flags != 0)
170       {
171         vec_add2 (sts, st, 1);
172         st->sw_hw_if_index = hif->hw_if_index;
173         st->flags = vnet_hw_interface_flags_to_sw(hif->flags);
174       }
175   }
176   /* *INDENT-ON* */
177
178   vec_serialize (m, sts, serialize_vec_vnet_sw_hw_interface_state);
179
180   vec_free (sts);
181 }
182
183 static vnet_hw_interface_flags_t
184 vnet_sw_interface_flags_to_hw (vnet_sw_interface_flags_t swf)
185 {
186   vnet_hw_interface_flags_t hwf = VNET_HW_INTERFACE_FLAG_NONE;
187
188   if (swf & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
189     hwf |= VNET_HW_INTERFACE_FLAG_LINK_UP;
190
191   return (hwf);
192 }
193
194 void
195 unserialize_vnet_interface_state (serialize_main_t * m, va_list * va)
196 {
197   vnet_main_t *vnm = va_arg (*va, vnet_main_t *);
198   vnet_sw_hw_interface_state_t *sts = 0, *st;
199
200   /* First set interface hardware class. */
201   {
202     vnet_interface_main_t *im = &vnm->interface_main;
203     vnet_hw_interface_t *hif;
204     char *class_name;
205     uword *p;
206     clib_error_t *error;
207
208     /* *INDENT-OFF* */
209     pool_foreach (hif, im->hw_interfaces)  {
210       unserialize_cstring (m, &class_name);
211       p = hash_get_mem (im->hw_interface_class_by_name, class_name);
212       if (p)
213         {
214           error = vnet_hw_interface_set_class_helper
215             (vnm, hif->hw_if_index, p[0], /* redistribute */ 0);
216         }
217       else
218         error = clib_error_return (0, "hw class %s AWOL?", class_name);
219
220       if (error)
221         clib_error_report (error);
222       vec_free (class_name);
223     }
224     /* *INDENT-ON* */
225   }
226
227   vec_unserialize (m, &sts, unserialize_vec_vnet_sw_hw_interface_state);
228   vec_foreach (st, sts)
229     vnet_sw_interface_set_flags_helper (vnm, st->sw_hw_if_index, st->flags,
230                                         /* no distribute */ 0);
231   vec_free (sts);
232
233   vec_unserialize (m, &sts, unserialize_vec_vnet_sw_hw_interface_state);
234   vec_foreach (st, sts)
235   {
236     vnet_hw_interface_set_flags_helper
237       (vnm, st->sw_hw_if_index, vnet_sw_interface_flags_to_hw (st->flags),
238        /* no distribute */ 0);
239   }
240   vec_free (sts);
241 }
242
243 static clib_error_t *
244 call_elf_section_interface_callbacks (vnet_main_t * vnm, u32 if_index,
245                                       u32 flags,
246                                       _vnet_interface_function_list_elt_t **
247                                       elts)
248 {
249   _vnet_interface_function_list_elt_t *elt;
250   vnet_interface_function_priority_t prio;
251   clib_error_t *error = 0;
252
253   for (prio = VNET_ITF_FUNC_PRIORITY_LOW;
254        prio <= VNET_ITF_FUNC_PRIORITY_HIGH; prio++)
255     {
256       elt = elts[prio];
257
258       while (elt)
259         {
260           error = elt->fp (vnm, if_index, flags);
261           if (error)
262             return error;
263           elt = elt->next_interface_function;
264         }
265     }
266   return error;
267 }
268
269 static clib_error_t *
270 call_hw_interface_add_del_callbacks (vnet_main_t * vnm, u32 hw_if_index,
271                                      u32 is_create)
272 {
273   vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
274   vnet_hw_interface_class_t *hw_class =
275     vnet_get_hw_interface_class (vnm, hi->hw_class_index);
276   vnet_device_class_t *dev_class =
277     vnet_get_device_class (vnm, hi->dev_class_index);
278   clib_error_t *error = 0;
279
280   if (hw_class->interface_add_del_function
281       && (error =
282           hw_class->interface_add_del_function (vnm, hw_if_index, is_create)))
283     return error;
284
285   if (dev_class->interface_add_del_function
286       && (error =
287           dev_class->interface_add_del_function (vnm, hw_if_index,
288                                                  is_create)))
289     return error;
290
291   error = call_elf_section_interface_callbacks
292     (vnm, hw_if_index, is_create, vnm->hw_interface_add_del_functions);
293
294   return error;
295 }
296
297 static clib_error_t *
298 call_sw_interface_add_del_callbacks (vnet_main_t * vnm, u32 sw_if_index,
299                                      u32 is_create)
300 {
301   return call_elf_section_interface_callbacks
302     (vnm, sw_if_index, is_create, vnm->sw_interface_add_del_functions);
303 }
304
305 static clib_error_t *
306 vnet_hw_interface_set_flags_helper (vnet_main_t * vnm, u32 hw_if_index,
307                                     vnet_hw_interface_flags_t flags,
308                                     vnet_interface_helper_flags_t
309                                     helper_flags)
310 {
311   vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
312   vnet_hw_interface_class_t *hw_class =
313     vnet_get_hw_interface_class (vnm, hi->hw_class_index);
314   u32 mask;
315   clib_error_t *error = 0;
316   u32 is_create =
317     (helper_flags & VNET_INTERFACE_SET_FLAGS_HELPER_IS_CREATE) != 0;
318
319   mask =
320     (VNET_HW_INTERFACE_FLAG_LINK_UP | VNET_HW_INTERFACE_FLAG_DUPLEX_MASK);
321   flags &= mask;
322
323   /* Call hardware interface add/del callbacks. */
324   if (is_create)
325     call_hw_interface_add_del_callbacks (vnm, hw_if_index, is_create);
326
327   /* Already in the desired state? */
328   if (!is_create && (hi->flags & mask) == flags)
329     goto done;
330
331   if ((hi->flags & VNET_HW_INTERFACE_FLAG_LINK_UP) !=
332       (flags & VNET_HW_INTERFACE_FLAG_LINK_UP))
333     {
334       /* Do hardware class (e.g. ethernet). */
335       if (hw_class->link_up_down_function
336           && (error = hw_class->link_up_down_function (vnm, hw_if_index,
337                                                        flags)))
338         goto done;
339
340       error = call_elf_section_interface_callbacks
341         (vnm, hw_if_index, flags, vnm->hw_interface_link_up_down_functions);
342
343       if (error)
344         goto done;
345     }
346
347   hi->flags &= ~mask;
348   hi->flags |= flags;
349
350 done:
351   if (error)
352     log_err ("hw_set_flags_helper: %U", format_clib_error, error);
353   return error;
354 }
355
356 static clib_error_t *
357 vnet_sw_interface_set_flags_helper (vnet_main_t * vnm, u32 sw_if_index,
358                                     vnet_sw_interface_flags_t flags,
359                                     vnet_interface_helper_flags_t
360                                     helper_flags)
361 {
362   vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
363   u32 mask;
364   clib_error_t *error = 0;
365   u32 is_create =
366     (helper_flags & VNET_INTERFACE_SET_FLAGS_HELPER_IS_CREATE) != 0;
367   u32 old_flags;
368
369   mask = VNET_SW_INTERFACE_FLAG_ADMIN_UP | VNET_SW_INTERFACE_FLAG_PUNT;
370   flags &= mask;
371
372   if (is_create)
373     {
374       error =
375         call_sw_interface_add_del_callbacks (vnm, sw_if_index, is_create);
376       if (error)
377         goto done;
378
379       if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
380         {
381           /* Notify everyone when the interface is created as admin up */
382           error = call_elf_section_interface_callbacks (vnm, sw_if_index,
383                                                         flags,
384                                                         vnm->
385                                                         sw_interface_admin_up_down_functions);
386           if (error)
387             goto done;
388         }
389     }
390   else
391     {
392       vnet_sw_interface_t *si_sup = si;
393
394       /* Check that super interface is in correct state. */
395       if (si->type == VNET_SW_INTERFACE_TYPE_SUB)
396         {
397           si_sup = vnet_get_sw_interface (vnm, si->sup_sw_if_index);
398
399           /* Check to see if we're bringing down the soft interface and if it's parent is up */
400           if ((flags != (si_sup->flags & mask)) &&
401               (!((flags == 0)
402                  && ((si_sup->flags & mask) ==
403                      VNET_SW_INTERFACE_FLAG_ADMIN_UP))))
404             {
405               error = clib_error_return (0, "super-interface %U must be %U",
406                                          format_vnet_sw_interface_name, vnm,
407                                          si_sup,
408                                          format_vnet_sw_interface_flags,
409                                          flags);
410               goto done;
411             }
412         }
413
414       /* Already in the desired state? */
415       if ((si->flags & mask) == flags)
416         goto done;
417
418       /* Sub-interfaces of hardware interfaces that do no redistribute,
419          do not redistribute themselves. */
420       if (si_sup->type == VNET_SW_INTERFACE_TYPE_HARDWARE)
421         {
422           vnet_hw_interface_t *hi =
423             vnet_get_hw_interface (vnm, si_sup->hw_if_index);
424           vnet_device_class_t *dev_class =
425             vnet_get_device_class (vnm, hi->dev_class_index);
426           if (!dev_class->redistribute)
427             helper_flags &=
428               ~VNET_INTERFACE_SET_FLAGS_HELPER_WANT_REDISTRIBUTE;
429         }
430
431       /* set the flags now before invoking the registered clients
432        * so that the state they query is consistent with the state here notified */
433       old_flags = si->flags;
434       si->flags &= ~mask;
435       si->flags |= flags;
436       if ((flags | old_flags) & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
437         error = call_elf_section_interface_callbacks
438           (vnm, sw_if_index, flags,
439            vnm->sw_interface_admin_up_down_functions);
440
441       if (error)
442         {
443           /* restore flags on error */
444           si->flags = old_flags;
445           goto done;
446         }
447
448       if (si->type == VNET_SW_INTERFACE_TYPE_HARDWARE)
449         {
450           vnet_hw_interface_t *hi =
451             vnet_get_hw_interface (vnm, si->hw_if_index);
452           vnet_hw_interface_class_t *hw_class =
453             vnet_get_hw_interface_class (vnm, hi->hw_class_index);
454           vnet_device_class_t *dev_class =
455             vnet_get_device_class (vnm, hi->dev_class_index);
456
457           if ((flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) &&
458               (si->flags & VNET_SW_INTERFACE_FLAG_ERROR))
459             {
460               error = clib_error_return (0, "Interface in the error state");
461               goto done;
462             }
463
464           /* save the si admin up flag */
465           old_flags = si->flags;
466
467           /* update si admin up flag in advance if we are going admin down */
468           if (!(flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP))
469             si->flags &= ~VNET_SW_INTERFACE_FLAG_ADMIN_UP;
470
471           if (dev_class->admin_up_down_function
472               && (error = dev_class->admin_up_down_function (vnm,
473                                                              si->hw_if_index,
474                                                              flags)))
475             {
476               /* restore si admin up flag to it's original state on errors */
477               si->flags = old_flags;
478               goto done;
479             }
480
481           if (hw_class->admin_up_down_function
482               && (error = hw_class->admin_up_down_function (vnm,
483                                                             si->hw_if_index,
484                                                             flags)))
485             {
486               /* restore si admin up flag to it's original state on errors */
487               si->flags = old_flags;
488               goto done;
489             }
490
491           /* Admin down implies link down. */
492           if (!(flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
493               && (hi->flags & VNET_HW_INTERFACE_FLAG_LINK_UP))
494             vnet_hw_interface_set_flags_helper (vnm, si->hw_if_index,
495                                                 hi->flags &
496                                                 ~VNET_HW_INTERFACE_FLAG_LINK_UP,
497                                                 helper_flags);
498           vnet_hw_if_update_runtime_data (vnm, si->hw_if_index);
499         }
500     }
501
502   si->flags &= ~mask;
503   si->flags |= flags;
504
505 done:
506   if (error)
507     log_err ("sw_set_flags_helper: %U", format_clib_error, error);
508   return error;
509 }
510
511 clib_error_t *
512 vnet_hw_interface_set_flags (vnet_main_t * vnm, u32 hw_if_index,
513                              vnet_hw_interface_flags_t flags)
514 {
515   log_debug ("hw_set_flags: hw_if_index %u flags 0x%x", hw_if_index, flags);
516   return vnet_hw_interface_set_flags_helper
517     (vnm, hw_if_index, flags,
518      VNET_INTERFACE_SET_FLAGS_HELPER_WANT_REDISTRIBUTE);
519 }
520
521 clib_error_t *
522 vnet_sw_interface_set_flags (vnet_main_t * vnm, u32 sw_if_index,
523                              vnet_sw_interface_flags_t flags)
524 {
525   log_debug ("sw_set_flags: sw_if_index %u flags 0x%x", sw_if_index, flags);
526   return vnet_sw_interface_set_flags_helper
527     (vnm, sw_if_index, flags,
528      VNET_INTERFACE_SET_FLAGS_HELPER_WANT_REDISTRIBUTE);
529 }
530
531 void
532 vnet_sw_interface_admin_up (vnet_main_t * vnm, u32 sw_if_index)
533 {
534   u32 flags = vnet_sw_interface_get_flags (vnm, sw_if_index);
535   log_debug ("sw_admin_up: sw_if_index %u", sw_if_index);
536
537   if (!(flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP))
538     {
539       flags |= VNET_SW_INTERFACE_FLAG_ADMIN_UP;
540       vnet_sw_interface_set_flags (vnm, sw_if_index, flags);
541     }
542 }
543
544 void
545 vnet_sw_interface_admin_down (vnet_main_t * vnm, u32 sw_if_index)
546 {
547   u32 flags = vnet_sw_interface_get_flags (vnm, sw_if_index);
548   log_debug ("sw_admin_down: sw_if_index %u", sw_if_index);
549
550   if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
551     {
552       flags &= ~(VNET_SW_INTERFACE_FLAG_ADMIN_UP);
553       vnet_sw_interface_set_flags (vnm, sw_if_index, flags);
554     }
555 }
556
557 static void
558 vnet_if_update_lookup_tables (vnet_main_t *vnm, u32 sw_if_index)
559 {
560   vnet_interface_main_t *im = &vnm->interface_main;
561   vnet_hw_interface_t *hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
562
563   vec_validate_init_empty (im->hw_if_index_by_sw_if_index, sw_if_index, ~0);
564   vec_validate_init_empty (im->if_out_arc_end_next_index_by_sw_if_index,
565                            sw_if_index, ~0);
566
567   im->hw_if_index_by_sw_if_index[sw_if_index] = hi->hw_if_index;
568   im->if_out_arc_end_next_index_by_sw_if_index[sw_if_index] =
569     hi->if_out_arc_end_node_next_index;
570 }
571
572 static u32
573 vnet_create_sw_interface_no_callbacks (vnet_main_t * vnm,
574                                        vnet_sw_interface_t * template)
575 {
576   vnet_interface_main_t *im = &vnm->interface_main;
577   vnet_sw_interface_t *sw;
578   u32 sw_if_index;
579
580   pool_get (im->sw_interfaces, sw);
581   sw_if_index = sw - im->sw_interfaces;
582
583   sw[0] = template[0];
584
585   sw->flags = 0;
586   sw->sw_if_index = sw_if_index;
587   if (sw->type == VNET_SW_INTERFACE_TYPE_HARDWARE)
588     sw->sup_sw_if_index = sw->sw_if_index;
589
590   /* Allocate counters for this interface. */
591   {
592     u32 i;
593
594     vnet_interface_counter_lock (im);
595
596     for (i = 0; i < vec_len (im->sw_if_counters); i++)
597       {
598         vlib_validate_simple_counter (&im->sw_if_counters[i], sw_if_index);
599         vlib_zero_simple_counter (&im->sw_if_counters[i], sw_if_index);
600       }
601
602     for (i = 0; i < vec_len (im->combined_sw_if_counters); i++)
603       {
604         vlib_validate_combined_counter (&im->combined_sw_if_counters[i],
605                                         sw_if_index);
606         vlib_zero_combined_counter (&im->combined_sw_if_counters[i],
607                                     sw_if_index);
608       }
609
610     vnet_interface_counter_unlock (im);
611   }
612
613   vnet_if_update_lookup_tables (vnm, sw_if_index);
614   return sw_if_index;
615 }
616
617 clib_error_t *
618 vnet_create_sw_interface (vnet_main_t * vnm, vnet_sw_interface_t * template,
619                           u32 * sw_if_index)
620 {
621   vnet_interface_main_t *im = &vnm->interface_main;
622   clib_error_t *error;
623   vnet_hw_interface_t *hi;
624   vnet_device_class_t *dev_class;
625
626   if (template->sub.eth.flags.two_tags == 1
627       && template->sub.eth.flags.exact_match == 1
628       && (template->sub.eth.flags.inner_vlan_id_any == 1
629           || template->sub.eth.flags.outer_vlan_id_any == 1))
630     {
631       char *str = "inner-dot1q any exact-match is unsupported";
632       error = clib_error_return (0, str);
633       log_err ("create_sw_interface: %s", str);
634       return error;
635     }
636
637   hi = vnet_get_sup_hw_interface (vnm, template->sup_sw_if_index);
638   dev_class = vnet_get_device_class (vnm, hi->dev_class_index);
639
640   if (template->type == VNET_SW_INTERFACE_TYPE_SUB &&
641       dev_class->subif_add_del_function)
642     {
643       error = dev_class->subif_add_del_function (vnm, hi->hw_if_index,
644                                                  (struct vnet_sw_interface_t
645                                                   *) template, 1);
646       if (error)
647         return error;
648     }
649
650   *sw_if_index = vnet_create_sw_interface_no_callbacks (vnm, template);
651   error = vnet_sw_interface_set_flags_helper
652     (vnm, *sw_if_index, template->flags,
653      VNET_INTERFACE_SET_FLAGS_HELPER_IS_CREATE);
654
655   if (error)
656     {
657       /* undo the work done by vnet_create_sw_interface_no_callbacks() */
658       log_err ("create_sw_interface: set flags failed\n  %U",
659                format_clib_error, error);
660       vnet_sw_interface_t *sw =
661         pool_elt_at_index (im->sw_interfaces, *sw_if_index);
662       pool_put (im->sw_interfaces, sw);
663     }
664   else
665     {
666       vnet_sw_interface_t *sw =
667         pool_elt_at_index (im->sw_interfaces, *sw_if_index);
668       log_debug ("create_sw_interface: interface %U (sw_if_index %u) created",
669                  format_vnet_sw_interface_name, vnm, sw, *sw_if_index);
670     }
671
672   return error;
673 }
674
675 void
676 vnet_delete_sw_interface (vnet_main_t * vnm, u32 sw_if_index)
677 {
678   vnet_interface_main_t *im = &vnm->interface_main;
679   vnet_sw_interface_t *sw =
680     pool_elt_at_index (im->sw_interfaces, sw_if_index);
681
682   log_debug ("delete_sw_interface: sw_if_index %u, name '%U'",
683              sw_if_index, format_vnet_sw_if_index_name, vnm, sw_if_index);
684
685   /* Check if the interface has config and is removed from L2 BD or XConnect */
686   vnet_clear_sw_interface_tag (vnm, sw_if_index);
687
688   /* Bring down interface in case it is up. */
689   if (sw->flags != 0)
690     vnet_sw_interface_set_flags (vnm, sw_if_index, /* flags */ 0);
691
692   call_sw_interface_add_del_callbacks (vnm, sw_if_index, /* is_create */ 0);
693
694   pool_put (im->sw_interfaces, sw);
695 }
696
697 static clib_error_t *
698 call_sw_interface_mtu_change_callbacks (vnet_main_t * vnm, u32 sw_if_index)
699 {
700   return call_elf_section_interface_callbacks
701     (vnm, sw_if_index, 0, vnm->sw_interface_mtu_change_functions);
702 }
703
704 void
705 vnet_sw_interface_set_mtu (vnet_main_t * vnm, u32 sw_if_index, u32 mtu)
706 {
707   vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
708
709   if (si->mtu[VNET_MTU_L3] != mtu)
710     {
711       si->mtu[VNET_MTU_L3] = mtu;
712       log_debug ("set_mtu: interface %U, new mtu %u",
713                  format_vnet_sw_if_index_name, vnm, sw_if_index, mtu);
714
715       call_sw_interface_mtu_change_callbacks (vnm, sw_if_index);
716     }
717 }
718
719 void
720 vnet_sw_interface_set_protocol_mtu (vnet_main_t * vnm, u32 sw_if_index,
721                                     u32 mtu[])
722 {
723   vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
724   bool changed = false;
725   int i;
726
727   for (i = 0; i < VNET_N_MTU; i++)
728     {
729       if (si->mtu[i] != mtu[i])
730         {
731           si->mtu[i] = mtu[i];
732           changed = true;
733         }
734     }
735   /* Notify interested parties */
736   if (changed)
737     {
738       log_debug ("set_protocol_mtu: interface %U l3 %u ip4 %u ip6 %u mpls %u",
739                  format_vnet_sw_if_index_name, vnm, sw_if_index,
740                  mtu[VNET_MTU_L3], mtu[VNET_MTU_IP4], mtu[VNET_MTU_IP6],
741                  mtu[VNET_MTU_MPLS]);
742       call_sw_interface_mtu_change_callbacks (vnm, sw_if_index);
743     }
744 }
745
746 void
747 vnet_sw_interface_ip_directed_broadcast (vnet_main_t * vnm,
748                                          u32 sw_if_index, u8 enable)
749 {
750   vnet_sw_interface_t *si;
751
752   si = vnet_get_sw_interface (vnm, sw_if_index);
753
754   if (enable)
755     si->flags |= VNET_SW_INTERFACE_FLAG_DIRECTED_BCAST;
756   else
757     si->flags &= ~VNET_SW_INTERFACE_FLAG_DIRECTED_BCAST;
758
759   ip4_directed_broadcast (sw_if_index, enable);
760 }
761
762 /*
763  * Reflect a change in hardware MTU on protocol MTUs
764  */
765 static walk_rc_t
766 sw_interface_walk_callback (vnet_main_t * vnm, u32 sw_if_index, void *ctx)
767 {
768   u32 *link_mtu = ctx;
769   vnet_sw_interface_set_mtu (vnm, sw_if_index, *link_mtu);
770   return WALK_CONTINUE;
771 }
772
773 void
774 vnet_hw_interface_set_mtu (vnet_main_t * vnm, u32 hw_if_index, u32 mtu)
775 {
776   vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
777
778   if (hi->max_packet_bytes != mtu)
779     {
780       hi->max_packet_bytes = mtu;
781       ethernet_set_flags (vnm, hw_if_index, ETHERNET_INTERFACE_FLAG_MTU);
782       vnet_hw_interface_walk_sw (vnm, hw_if_index, sw_interface_walk_callback,
783                                  &mtu);
784     }
785 }
786
787 static void
788 setup_tx_node (vlib_main_t * vm,
789                u32 node_index, vnet_device_class_t * dev_class)
790 {
791   vlib_node_t *n = vlib_get_node (vm, node_index);
792
793   n->format_trace = dev_class->format_tx_trace;
794
795   vlib_register_errors (vm, node_index, dev_class->tx_function_n_errors,
796                         dev_class->tx_function_error_strings,
797                         dev_class->tx_function_error_counters);
798 }
799
800 static void
801 setup_output_node (vlib_main_t * vm,
802                    u32 node_index, vnet_hw_interface_class_t * hw_class)
803 {
804   vlib_node_t *n = vlib_get_node (vm, node_index);
805   n->format_buffer = hw_class->format_header;
806   n->unformat_buffer = hw_class->unformat_header;
807 }
808
809 /* Register an interface instance. */
810 u32
811 vnet_register_interface (vnet_main_t * vnm,
812                          u32 dev_class_index,
813                          u32 dev_instance,
814                          u32 hw_class_index, u32 hw_instance)
815 {
816   vnet_interface_main_t *im = &vnm->interface_main;
817   vnet_hw_interface_t *hw;
818   vnet_device_class_t *dev_class =
819     vnet_get_device_class (vnm, dev_class_index);
820   vnet_hw_interface_class_t *hw_class =
821     vnet_get_hw_interface_class (vnm, hw_class_index);
822   vlib_main_t *vm = vnm->vlib_main;
823   vnet_feature_config_main_t *fcm;
824   vnet_config_main_t *cm;
825   u32 hw_index, i;
826   char *tx_node_name = NULL, *output_node_name = NULL;
827   vlib_node_t *if_out_node =
828     vlib_get_node (vm, vnet_interface_output_node.index);
829
830   pool_get (im->hw_interfaces, hw);
831   clib_memset (hw, 0, sizeof (*hw));
832   hw->trace_classify_table_index = ~0;
833
834   hw_index = hw - im->hw_interfaces;
835   hw->hw_if_index = hw_index;
836   hw->default_rx_mode = VNET_HW_IF_RX_MODE_POLLING;
837
838   if (dev_class->format_device_name)
839     hw->name = format (0, "%U", dev_class->format_device_name, dev_instance);
840   else if (hw_class->format_interface_name)
841     hw->name = format (0, "%U", hw_class->format_interface_name,
842                        dev_instance);
843   else
844     hw->name = format (0, "%s%x", hw_class->name, dev_instance);
845
846   if (!im->hw_interface_by_name)
847     im->hw_interface_by_name = hash_create_vec ( /* size */ 0,
848                                                 sizeof (hw->name[0]),
849                                                 sizeof (uword));
850
851   hash_set_mem (im->hw_interface_by_name, hw->name, hw_index);
852
853   /* Make hardware interface point to software interface. */
854   {
855     vnet_sw_interface_t sw = {
856       .type = VNET_SW_INTERFACE_TYPE_HARDWARE,
857       .flood_class = VNET_FLOOD_CLASS_NORMAL,
858       .hw_if_index = hw_index
859     };
860     hw->sw_if_index = vnet_create_sw_interface_no_callbacks (vnm, &sw);
861   }
862
863   hw->dev_class_index = dev_class_index;
864   hw->dev_instance = dev_instance;
865   hw->hw_class_index = hw_class_index;
866   hw->hw_instance = hw_instance;
867
868   hw->max_rate_bits_per_sec = 0;
869   hw->min_packet_bytes = 0;
870   vnet_sw_interface_set_mtu (vnm, hw->sw_if_index, 0);
871
872   if (dev_class->tx_function == 0 && dev_class->tx_fn_registrations == 0)
873     goto no_output_nodes;       /* No output/tx nodes to create */
874
875   tx_node_name = (char *) format (0, "%v-tx", hw->name);
876   output_node_name = (char *) format (0, "%v-output", hw->name);
877
878   /* If we have previously deleted interface nodes, re-use them. */
879   if (vec_len (im->deleted_hw_interface_nodes) > 0)
880     {
881       vnet_hw_interface_nodes_t *hn;
882       vlib_node_t *node;
883       vlib_node_runtime_t *nrt;
884
885       hn = vec_end (im->deleted_hw_interface_nodes) - 1;
886
887       hw->tx_node_index = hn->tx_node_index;
888       hw->output_node_index = hn->output_node_index;
889
890       vlib_node_rename (vm, hw->tx_node_index, "%v", tx_node_name);
891       vlib_node_rename (vm, hw->output_node_index, "%v", output_node_name);
892
893       foreach_vlib_main ()
894         {
895           vnet_interface_output_runtime_t *rt;
896
897           rt =
898             vlib_node_get_runtime_data (this_vlib_main, hw->output_node_index);
899           ASSERT (rt->is_deleted == 1);
900           rt->is_deleted = 0;
901           rt->hw_if_index = hw_index;
902           rt->sw_if_index = hw->sw_if_index;
903           rt->dev_instance = hw->dev_instance;
904
905           rt = vlib_node_get_runtime_data (this_vlib_main, hw->tx_node_index);
906           rt->hw_if_index = hw_index;
907           rt->sw_if_index = hw->sw_if_index;
908           rt->dev_instance = hw->dev_instance;
909         }
910
911       /* The new class may differ from the old one.
912        * Functions have to be updated. */
913       node = vlib_get_node (vm, hw->output_node_index);
914       node->format_trace = format_vnet_interface_output_trace;
915       node->node_fn_registrations = if_out_node->node_fn_registrations;
916       node->function = if_out_node->function;
917
918       foreach_vlib_main ()
919         {
920           nrt = vlib_node_get_runtime (this_vlib_main, hw->output_node_index);
921           nrt->function = node->function;
922           vlib_node_runtime_perf_counter (this_vlib_main, nrt, 0, 0, 0,
923                                           VLIB_NODE_RUNTIME_PERF_RESET);
924         }
925
926       node = vlib_get_node (vm, hw->tx_node_index);
927       if (dev_class->tx_fn_registrations)
928         {
929           node->node_fn_registrations = dev_class->tx_fn_registrations;
930           node->function = vlib_node_get_preferred_node_fn_variant (
931             vm, dev_class->tx_fn_registrations);
932         }
933       else
934         node->function = dev_class->tx_function;
935       node->format_trace = dev_class->format_tx_trace;
936
937       foreach_vlib_main ()
938         {
939           nrt = vlib_node_get_runtime (this_vlib_main, hw->tx_node_index);
940           nrt->function = node->function;
941           vlib_node_runtime_perf_counter (this_vlib_main, nrt, 0, 0, 0,
942                                           VLIB_NODE_RUNTIME_PERF_RESET);
943         }
944
945       _vec_len (im->deleted_hw_interface_nodes) -= 1;
946     }
947   else
948     {
949       vlib_node_registration_t r;
950       vnet_interface_output_runtime_t rt = {
951         .hw_if_index = hw_index,
952         .sw_if_index = hw->sw_if_index,
953         .dev_instance = hw->dev_instance,
954         .is_deleted = 0,
955       };
956
957       clib_memset (&r, 0, sizeof (r));
958       r.type = VLIB_NODE_TYPE_INTERNAL;
959       r.runtime_data = &rt;
960       r.runtime_data_bytes = sizeof (rt);
961       r.scalar_size = 0;
962       r.vector_size = sizeof (u32);
963
964       r.flags = VLIB_NODE_FLAG_IS_OUTPUT;
965       r.name = tx_node_name;
966       if (dev_class->tx_fn_registrations)
967         {
968           r.function = 0;
969           r.node_fn_registrations = dev_class->tx_fn_registrations;
970         }
971       else
972         r.function = dev_class->tx_function;
973
974       hw->tx_node_index = vlib_register_node (vm, &r);
975
976       vlib_node_add_named_next_with_slot (vm, hw->tx_node_index,
977                                           "error-drop",
978                                           VNET_INTERFACE_TX_NEXT_DROP);
979
980       r.flags = 0;
981       r.name = output_node_name;
982       r.format_trace = format_vnet_interface_output_trace;
983       if (if_out_node->node_fn_registrations)
984         {
985           r.function = 0;
986           r.node_fn_registrations = if_out_node->node_fn_registrations;
987         }
988       else
989         r.function = if_out_node->function;
990
991       {
992         static char *e[] = {
993           "interface is down",
994           "interface is deleted",
995           "no buffers to segment GSO",
996         };
997
998         r.n_errors = ARRAY_LEN (e);
999         r.error_strings = e;
1000       }
1001       hw->output_node_index = vlib_register_node (vm, &r);
1002
1003       vlib_node_add_named_next_with_slot (vm, hw->output_node_index,
1004                                           "error-drop",
1005                                           VNET_INTERFACE_OUTPUT_NEXT_DROP);
1006       vlib_node_add_next_with_slot (vm, hw->output_node_index,
1007                                     hw->tx_node_index,
1008                                     VNET_INTERFACE_OUTPUT_NEXT_TX);
1009       /* add interface to the list of "output-interface" feature arc start nodes
1010          and clone nexts from 1st interface if it exists */
1011       fcm = vnet_feature_get_config_main (im->output_feature_arc_index);
1012       cm = &fcm->config_main;
1013       i = vec_len (cm->start_node_indices);
1014       vec_validate (cm->start_node_indices, i);
1015       cm->start_node_indices[i] = hw->output_node_index;
1016       if (hw_index)
1017         {
1018           /* copy nexts from 1st interface */
1019           vnet_hw_interface_t *first_hw;
1020           vlib_node_t *first_node;
1021
1022           first_hw = vnet_get_hw_interface (vnm, /* hw_if_index */ 0);
1023           first_node = vlib_get_node (vm, first_hw->output_node_index);
1024
1025           /* 1st 2 nexts are already added above */
1026           for (i = 2; i < vec_len (first_node->next_nodes); i++)
1027             vlib_node_add_next_with_slot (vm, hw->output_node_index,
1028                                           first_node->next_nodes[i], i);
1029         }
1030     }
1031
1032   hw->if_out_arc_end_node_next_index = vlib_node_add_next (
1033     vm, vnet_interface_output_arc_end_node.index, hw->tx_node_index);
1034   vnet_if_update_lookup_tables (vnm, hw->sw_if_index);
1035   setup_output_node (vm, hw->output_node_index, hw_class);
1036   setup_tx_node (vm, hw->tx_node_index, dev_class);
1037
1038 no_output_nodes:
1039   /* Call all up/down callbacks with zero flags when interface is created. */
1040   vnet_sw_interface_set_flags_helper (vnm, hw->sw_if_index, /* flags */ 0,
1041                                       VNET_INTERFACE_SET_FLAGS_HELPER_IS_CREATE);
1042   vnet_hw_interface_set_flags_helper (vnm, hw_index, /* flags */ 0,
1043                                       VNET_INTERFACE_SET_FLAGS_HELPER_IS_CREATE);
1044   vec_free (tx_node_name);
1045   vec_free (output_node_name);
1046
1047   return hw_index;
1048 }
1049
1050 void
1051 vnet_delete_hw_interface (vnet_main_t * vnm, u32 hw_if_index)
1052 {
1053   vnet_interface_main_t *im = &vnm->interface_main;
1054   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
1055   vlib_main_t *vm = vnm->vlib_main;
1056   vnet_device_class_t *dev_class = vnet_get_device_class (vnm,
1057                                                           hw->dev_class_index);
1058   /* If it is up, mark it down. */
1059   if (hw->flags != 0)
1060     vnet_hw_interface_set_flags (vnm, hw_if_index, /* flags */ 0);
1061
1062   /* Call delete callbacks. */
1063   call_hw_interface_add_del_callbacks (vnm, hw_if_index, /* is_create */ 0);
1064
1065   /* delete rx queues */
1066   vnet_hw_if_unregister_all_rx_queues (vnm, hw_if_index);
1067   vnet_hw_if_update_runtime_data (vnm, hw_if_index);
1068
1069   /* Delete any sub-interfaces. */
1070   {
1071     u32 id, sw_if_index;
1072     /* *INDENT-OFF* */
1073     hash_foreach (id, sw_if_index, hw->sub_interface_sw_if_index_by_id,
1074     ({
1075       vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
1076       u64 sup_and_sub_key =
1077         ((u64) (si->sup_sw_if_index) << 32) | (u64) si->sub.id;
1078       hash_unset_mem_free (&im->sw_if_index_by_sup_and_sub, &sup_and_sub_key);
1079       vnet_delete_sw_interface (vnm, sw_if_index);
1080     }));
1081     hash_free (hw->sub_interface_sw_if_index_by_id);
1082     /* *INDENT-ON* */
1083   }
1084
1085   /* Delete software interface corresponding to hardware interface. */
1086   vnet_delete_sw_interface (vnm, hw->sw_if_index);
1087
1088   if (dev_class->tx_function)
1089     {
1090       /* Put output/tx nodes into recycle pool */
1091       vnet_hw_interface_nodes_t *dn;
1092
1093       foreach_vlib_main ()
1094         {
1095           vnet_interface_output_runtime_t *rt =
1096             vlib_node_get_runtime_data (this_vlib_main, hw->output_node_index);
1097
1098           /* Mark node runtime as deleted so output node (if called)
1099            * will drop packets. */
1100           rt->is_deleted = 1;
1101         }
1102
1103       vlib_node_rename (vm, hw->output_node_index,
1104                         "interface-%d-output-deleted", hw_if_index);
1105       vlib_node_rename (vm, hw->tx_node_index, "interface-%d-tx-deleted",
1106                         hw_if_index);
1107       vec_add2 (im->deleted_hw_interface_nodes, dn, 1);
1108       dn->tx_node_index = hw->tx_node_index;
1109       dn->output_node_index = hw->output_node_index;
1110     }
1111
1112   hash_unset_mem (im->hw_interface_by_name, hw->name);
1113   vec_free (hw->name);
1114   vec_free (hw->hw_address);
1115   vec_free (hw->input_node_thread_index_by_queue);
1116   vec_free (hw->rx_queue_indices);
1117   pool_put (im->hw_interfaces, hw);
1118 }
1119
1120 void
1121 vnet_hw_interface_walk_sw (vnet_main_t * vnm,
1122                            u32 hw_if_index,
1123                            vnet_hw_sw_interface_walk_t fn, void *ctx)
1124 {
1125   vnet_hw_interface_t *hi;
1126   u32 id, sw_if_index;
1127
1128   hi = vnet_get_hw_interface (vnm, hw_if_index);
1129   /* the super first, then the sub interfaces */
1130   if (WALK_STOP == fn (vnm, hi->sw_if_index, ctx))
1131     return;
1132
1133   /* *INDENT-OFF* */
1134   hash_foreach (id, sw_if_index,
1135                 hi->sub_interface_sw_if_index_by_id,
1136   ({
1137     if (WALK_STOP == fn (vnm, sw_if_index, ctx))
1138       break;
1139   }));
1140   /* *INDENT-ON* */
1141 }
1142
1143 void
1144 vnet_hw_interface_walk (vnet_main_t * vnm,
1145                         vnet_hw_interface_walk_t fn, void *ctx)
1146 {
1147   vnet_interface_main_t *im;
1148   vnet_hw_interface_t *hi;
1149
1150   im = &vnm->interface_main;
1151
1152   /* *INDENT-OFF* */
1153   pool_foreach (hi, im->hw_interfaces)
1154    {
1155     if (WALK_STOP == fn(vnm, hi->hw_if_index, ctx))
1156       break;
1157   }
1158   /* *INDENT-ON* */
1159 }
1160
1161 void
1162 vnet_sw_interface_walk (vnet_main_t * vnm,
1163                         vnet_sw_interface_walk_t fn, void *ctx)
1164 {
1165   vnet_interface_main_t *im;
1166   vnet_sw_interface_t *si;
1167
1168   im = &vnm->interface_main;
1169
1170   /* *INDENT-OFF* */
1171   pool_foreach (si, im->sw_interfaces)
1172   {
1173     if (WALK_STOP == fn (vnm, si, ctx))
1174       break;
1175   }
1176   /* *INDENT-ON* */
1177 }
1178
1179 void
1180 vnet_hw_interface_init_for_class (vnet_main_t * vnm, u32 hw_if_index,
1181                                   u32 hw_class_index, u32 hw_instance)
1182 {
1183   vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
1184   vnet_hw_interface_class_t *hc =
1185     vnet_get_hw_interface_class (vnm, hw_class_index);
1186
1187   hi->hw_class_index = hw_class_index;
1188   hi->hw_instance = hw_instance;
1189   setup_output_node (vnm->vlib_main, hi->output_node_index, hc);
1190 }
1191
1192 static clib_error_t *
1193 vnet_hw_interface_set_class_helper (vnet_main_t * vnm, u32 hw_if_index,
1194                                     u32 hw_class_index, u32 redistribute)
1195 {
1196   vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
1197   vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, hi->sw_if_index);
1198   vnet_hw_interface_class_t *old_class =
1199     vnet_get_hw_interface_class (vnm, hi->hw_class_index);
1200   vnet_hw_interface_class_t *new_class =
1201     vnet_get_hw_interface_class (vnm, hw_class_index);
1202   vnet_device_class_t *dev_class =
1203     vnet_get_device_class (vnm, hi->dev_class_index);
1204   clib_error_t *error = 0;
1205
1206   /* New class equals old class?  Nothing to do. */
1207   if (hi->hw_class_index == hw_class_index)
1208     return 0;
1209
1210   /* No need (and incorrect since admin up flag may be set) to do error checking when
1211      receiving unserialize message. */
1212   if (redistribute)
1213     {
1214       if (si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
1215         return clib_error_return (0,
1216                                   "%v must be admin down to change class from %s to %s",
1217                                   hi->name, old_class->name, new_class->name);
1218
1219       /* Make sure interface supports given class. */
1220       if ((new_class->is_valid_class_for_interface
1221            && !new_class->is_valid_class_for_interface (vnm, hw_if_index,
1222                                                         hw_class_index))
1223           || (dev_class->is_valid_class_for_interface
1224               && !dev_class->is_valid_class_for_interface (vnm, hw_if_index,
1225                                                            hw_class_index)))
1226         return clib_error_return (0,
1227                                   "%v class cannot be changed from %s to %s",
1228                                   hi->name, old_class->name, new_class->name);
1229
1230     }
1231
1232   if (old_class->hw_class_change)
1233     old_class->hw_class_change (vnm, hw_if_index, old_class->index,
1234                                 new_class->index);
1235
1236   vnet_hw_interface_init_for_class (vnm, hw_if_index, new_class->index,
1237                                     /* instance */ ~0);
1238
1239   if (new_class->hw_class_change)
1240     new_class->hw_class_change (vnm, hw_if_index, old_class->index,
1241                                 new_class->index);
1242
1243   if (dev_class->hw_class_change)
1244     dev_class->hw_class_change (vnm, hw_if_index, new_class->index);
1245
1246   return error;
1247 }
1248
1249 clib_error_t *
1250 vnet_hw_interface_set_class (vnet_main_t * vnm, u32 hw_if_index,
1251                              u32 hw_class_index)
1252 {
1253   return vnet_hw_interface_set_class_helper (vnm, hw_if_index, hw_class_index,
1254                                              /* redistribute */ 1);
1255 }
1256
1257 static int
1258 vnet_hw_interface_rx_redirect_to_node_helper (vnet_main_t * vnm,
1259                                               u32 hw_if_index,
1260                                               u32 node_index,
1261                                               u32 redistribute)
1262 {
1263   vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
1264   vnet_device_class_t *dev_class = vnet_get_device_class
1265     (vnm, hi->dev_class_index);
1266
1267   if (dev_class->rx_redirect_to_node)
1268     {
1269       dev_class->rx_redirect_to_node (vnm, hw_if_index, node_index);
1270       return 0;
1271     }
1272
1273   return VNET_API_ERROR_UNIMPLEMENTED;
1274 }
1275
1276 int
1277 vnet_hw_interface_rx_redirect_to_node (vnet_main_t * vnm, u32 hw_if_index,
1278                                        u32 node_index)
1279 {
1280   return vnet_hw_interface_rx_redirect_to_node_helper (vnm, hw_if_index,
1281                                                        node_index,
1282                                                        1 /* redistribute */ );
1283 }
1284
1285 word
1286 vnet_sw_interface_compare (vnet_main_t * vnm,
1287                            uword sw_if_index0, uword sw_if_index1)
1288 {
1289   vnet_sw_interface_t *sup0 = vnet_get_sup_sw_interface (vnm, sw_if_index0);
1290   vnet_sw_interface_t *sup1 = vnet_get_sup_sw_interface (vnm, sw_if_index1);
1291   vnet_hw_interface_t *h0 = vnet_get_hw_interface (vnm, sup0->hw_if_index);
1292   vnet_hw_interface_t *h1 = vnet_get_hw_interface (vnm, sup1->hw_if_index);
1293
1294   if (h0 != h1)
1295     return vec_cmp (h0->name, h1->name);
1296   return (word) h0->hw_instance - (word) h1->hw_instance;
1297 }
1298
1299 word
1300 vnet_hw_interface_compare (vnet_main_t * vnm,
1301                            uword hw_if_index0, uword hw_if_index1)
1302 {
1303   vnet_hw_interface_t *h0 = vnet_get_hw_interface (vnm, hw_if_index0);
1304   vnet_hw_interface_t *h1 = vnet_get_hw_interface (vnm, hw_if_index1);
1305
1306   if (h0 != h1)
1307     return vec_cmp (h0->name, h1->name);
1308   return (word) h0->hw_instance - (word) h1->hw_instance;
1309 }
1310
1311 int
1312 vnet_sw_interface_is_p2p (vnet_main_t * vnm, u32 sw_if_index)
1313 {
1314   vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
1315   if ((si->type == VNET_SW_INTERFACE_TYPE_P2P) ||
1316       (si->type == VNET_SW_INTERFACE_TYPE_PIPE))
1317     return 1;
1318
1319   vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
1320   vnet_hw_interface_class_t *hc =
1321     vnet_get_hw_interface_class (vnm, hw->hw_class_index);
1322
1323   return (hc->flags & VNET_HW_INTERFACE_CLASS_FLAG_P2P);
1324 }
1325
1326 int
1327 vnet_sw_interface_is_nbma (vnet_main_t * vnm, u32 sw_if_index)
1328 {
1329   vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
1330   vnet_hw_interface_class_t *hc =
1331     vnet_get_hw_interface_class (vnm, hw->hw_class_index);
1332
1333   return (hc->flags & VNET_HW_INTERFACE_CLASS_FLAG_NBMA);
1334 }
1335
1336 clib_error_t *
1337 vnet_interface_init (vlib_main_t * vm)
1338 {
1339   vnet_main_t *vnm = vnet_get_main ();
1340   vnet_interface_main_t *im = &vnm->interface_main;
1341   vlib_buffer_t *b = 0;
1342   vnet_buffer_opaque_t *o = 0;
1343   clib_error_t *error;
1344
1345   /*
1346    * Keep people from shooting themselves in the foot.
1347    */
1348   if (sizeof (b->opaque) != sizeof (vnet_buffer_opaque_t))
1349     {
1350 #define _(a) if (sizeof(o->a) > sizeof (o->unused))                     \
1351       clib_warning                                                      \
1352         ("FATAL: size of opaque union subtype %s is %d (max %d)",       \
1353          #a, sizeof(o->a), sizeof (o->unused));
1354       foreach_buffer_opaque_union_subtype;
1355 #undef _
1356
1357       return clib_error_return
1358         (0, "FATAL: size of vlib buffer opaque %d, size of vnet opaque %d",
1359          sizeof (b->opaque), sizeof (vnet_buffer_opaque_t));
1360     }
1361
1362   clib_spinlock_init (&im->sw_if_counter_lock);
1363   clib_spinlock_lock (&im->sw_if_counter_lock); /* should be no need */
1364
1365   vec_validate (im->sw_if_counters, VNET_N_SIMPLE_INTERFACE_COUNTER - 1);
1366 #define _(E,n,p)                                                        \
1367   im->sw_if_counters[VNET_INTERFACE_COUNTER_##E].name = #n;             \
1368   im->sw_if_counters[VNET_INTERFACE_COUNTER_##E].stat_segment_name = "/" #p "/" #n;
1369   foreach_simple_interface_counter_name
1370 #undef _
1371     vec_validate (im->combined_sw_if_counters,
1372                   VNET_N_COMBINED_INTERFACE_COUNTER - 1);
1373 #define _(E,n,p)                                                        \
1374   im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_##E].name = #n;    \
1375   im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_##E].stat_segment_name = "/" #p "/" #n;
1376   foreach_combined_interface_counter_name
1377 #undef _
1378     clib_spinlock_unlock (&im->sw_if_counter_lock);
1379
1380   im->device_class_by_name = hash_create_string ( /* size */ 0,
1381                                                  sizeof (uword));
1382   {
1383     vnet_device_class_t *c;
1384
1385     c = vnm->device_class_registrations;
1386
1387     while (c)
1388       {
1389         c->index = vec_len (im->device_classes);
1390         hash_set_mem (im->device_class_by_name, c->name, c->index);
1391
1392         /* to avoid confusion, please remove ".tx_function" statement
1393           from VNET_DEVICE_CLASS() if using function candidates */
1394         ASSERT (c->tx_fn_registrations == 0 || c->tx_function == 0);
1395
1396         if (c->tx_fn_registrations)
1397           c->tx_function = vlib_node_get_preferred_node_fn_variant (
1398             vm, c->tx_fn_registrations);
1399
1400         vec_add1 (im->device_classes, c[0]);
1401         c = c->next_class_registration;
1402       }
1403   }
1404
1405   im->hw_interface_class_by_name = hash_create_string ( /* size */ 0,
1406                                                        sizeof (uword));
1407
1408   im->rxq_index_by_hw_if_index_and_queue_id =
1409     hash_create_mem (0, sizeof (u64), sizeof (u32));
1410   im->sw_if_index_by_sup_and_sub = hash_create_mem (0, sizeof (u64),
1411                                                     sizeof (uword));
1412   {
1413     vnet_hw_interface_class_t *c;
1414
1415     c = vnm->hw_interface_class_registrations;
1416
1417     while (c)
1418       {
1419         c->index = vec_len (im->hw_interface_classes);
1420         hash_set_mem (im->hw_interface_class_by_name, c->name, c->index);
1421
1422         if (NULL == c->build_rewrite)
1423           c->build_rewrite = default_build_rewrite;
1424         if (NULL == c->update_adjacency)
1425           c->update_adjacency = default_update_adjacency;
1426
1427         vec_add1 (im->hw_interface_classes, c[0]);
1428         c = c->next_class_registration;
1429       }
1430   }
1431
1432   /* init per-thread data */
1433   vec_validate_aligned (im->per_thread_data, vlib_num_workers (),
1434                         CLIB_CACHE_LINE_BYTES);
1435
1436   if ((error = vlib_call_init_function (vm, vnet_interface_cli_init)))
1437     return error;
1438
1439   vnm->interface_tag_by_sw_if_index = hash_create (0, sizeof (uword));
1440
1441   return 0;
1442 }
1443
1444 VLIB_INIT_FUNCTION (vnet_interface_init);
1445
1446 /* Kludge to renumber interface names [only!] */
1447 int
1448 vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance)
1449 {
1450   int rv;
1451   vnet_main_t *vnm = vnet_get_main ();
1452   vnet_interface_main_t *im = &vnm->interface_main;
1453   vnet_hw_interface_t *hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
1454
1455   vnet_device_class_t *dev_class = vnet_get_device_class
1456     (vnm, hi->dev_class_index);
1457
1458   if (dev_class->name_renumber == 0 || dev_class->format_device_name == 0)
1459     return VNET_API_ERROR_UNIMPLEMENTED;
1460
1461   rv = dev_class->name_renumber (hi, new_show_dev_instance);
1462
1463   if (rv)
1464     return rv;
1465
1466   hash_unset_mem (im->hw_interface_by_name, hi->name);
1467   vec_free (hi->name);
1468   /* Use the mapping we set up to call it Ishmael */
1469   hi->name = format (0, "%U", dev_class->format_device_name,
1470                      hi->dev_instance);
1471
1472   hash_set_mem (im->hw_interface_by_name, hi->name, hi->hw_if_index);
1473   return rv;
1474 }
1475
1476 clib_error_t *
1477 vnet_rename_interface (vnet_main_t * vnm, u32 hw_if_index, char *new_name)
1478 {
1479   vnet_interface_main_t *im = &vnm->interface_main;
1480   vlib_main_t *vm = vnm->vlib_main;
1481   vnet_hw_interface_t *hw;
1482   u8 *old_name;
1483   clib_error_t *error = 0;
1484
1485   hw = vnet_get_hw_interface (vnm, hw_if_index);
1486   if (!hw)
1487     {
1488       return clib_error_return (0,
1489                                 "unable to find hw interface for index %u",
1490                                 hw_if_index);
1491     }
1492
1493   old_name = hw->name;
1494
1495   /* set new hw->name */
1496   hw->name = format (0, "%s", new_name);
1497
1498   /* remove the old name to hw_if_index mapping and install the new one */
1499   hash_unset_mem (im->hw_interface_by_name, old_name);
1500   hash_set_mem (im->hw_interface_by_name, hw->name, hw_if_index);
1501
1502   /* rename tx/output nodes */
1503   vlib_node_rename (vm, hw->tx_node_index, "%v-tx", hw->name);
1504   vlib_node_rename (vm, hw->output_node_index, "%v-output", hw->name);
1505
1506   /* free the old name vector */
1507   vec_free (old_name);
1508
1509   return error;
1510 }
1511
1512 clib_error_t *
1513 vnet_hw_interface_add_del_mac_address (vnet_main_t * vnm,
1514                                        u32 hw_if_index,
1515                                        const u8 * mac_address, u8 is_add)
1516 {
1517   clib_error_t *error = 0;
1518   vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
1519
1520   vnet_device_class_t *dev_class =
1521     vnet_get_device_class (vnm, hi->dev_class_index);
1522
1523   if (!hi->hw_address)
1524     {
1525       error =
1526         clib_error_return
1527         (0, "Secondary MAC Addresses not supported for interface index %u",
1528          hw_if_index);
1529       goto done;
1530     }
1531
1532   if (dev_class->mac_addr_add_del_function)
1533     error = dev_class->mac_addr_add_del_function (hi, mac_address, is_add);
1534
1535   if (!error)
1536     {
1537       vnet_hw_interface_class_t *hw_class;
1538
1539       hw_class = vnet_get_hw_interface_class (vnm, hi->hw_class_index);
1540
1541       if (NULL != hw_class->mac_addr_add_del_function)
1542         error = hw_class->mac_addr_add_del_function (hi, mac_address, is_add);
1543     }
1544
1545   /* If no errors, add to the list of secondary MACs on the ethernet intf */
1546   if (!error)
1547     ethernet_interface_add_del_address (&ethernet_main, hw_if_index,
1548                                         mac_address, is_add);
1549
1550 done:
1551   if (error)
1552     log_err ("hw_add_del_mac_address: %U", format_clib_error, error);
1553   return error;
1554 }
1555
1556 static clib_error_t *
1557 vnet_hw_interface_change_mac_address_helper (vnet_main_t * vnm,
1558                                              u32 hw_if_index,
1559                                              const u8 * mac_address)
1560 {
1561   clib_error_t *error = 0;
1562   vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
1563
1564   if (hi->hw_address)
1565     {
1566       u8 *old_address = vec_dup (hi->hw_address);
1567       vnet_device_class_t *dev_class =
1568         vnet_get_device_class (vnm, hi->dev_class_index);
1569       if (dev_class->mac_addr_change_function)
1570         {
1571           error =
1572             dev_class->mac_addr_change_function (hi, old_address,
1573                                                  mac_address);
1574         }
1575       if (!error)
1576         {
1577           vnet_hw_interface_class_t *hw_class;
1578
1579           hw_class = vnet_get_hw_interface_class (vnm, hi->hw_class_index);
1580
1581           if (NULL != hw_class->mac_addr_change_function)
1582             hw_class->mac_addr_change_function (hi, old_address, mac_address);
1583         }
1584       else
1585         {
1586           error =
1587             clib_error_return (0,
1588                                "MAC Address Change is not supported on this interface");
1589         }
1590       vec_free (old_address);
1591     }
1592   else
1593     {
1594       error =
1595         clib_error_return (0,
1596                            "mac address change is not supported for interface index %u",
1597                            hw_if_index);
1598     }
1599   return error;
1600 }
1601
1602 clib_error_t *
1603 vnet_hw_interface_change_mac_address (vnet_main_t * vnm, u32 hw_if_index,
1604                                       const u8 * mac_address)
1605 {
1606   return vnet_hw_interface_change_mac_address_helper
1607     (vnm, hw_if_index, mac_address);
1608 }
1609
1610 /* update the unnumbered state of an interface*/
1611 void
1612 vnet_sw_interface_update_unnumbered (u32 unnumbered_sw_if_index,
1613                                      u32 ip_sw_if_index, u8 enable)
1614 {
1615   vnet_main_t *vnm = vnet_get_main ();
1616   vnet_sw_interface_t *si;
1617   u32 was_unnum;
1618
1619   si = vnet_get_sw_interface (vnm, unnumbered_sw_if_index);
1620   was_unnum = (si->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED);
1621
1622   if (enable)
1623     {
1624       si->flags |= VNET_SW_INTERFACE_FLAG_UNNUMBERED;
1625       si->unnumbered_sw_if_index = ip_sw_if_index;
1626
1627       ip4_main.lookup_main.if_address_pool_index_by_sw_if_index
1628         [unnumbered_sw_if_index] =
1629         ip4_main.
1630         lookup_main.if_address_pool_index_by_sw_if_index[ip_sw_if_index];
1631       ip6_main.
1632         lookup_main.if_address_pool_index_by_sw_if_index
1633         [unnumbered_sw_if_index] =
1634         ip6_main.
1635         lookup_main.if_address_pool_index_by_sw_if_index[ip_sw_if_index];
1636     }
1637   else
1638     {
1639       si->flags &= ~(VNET_SW_INTERFACE_FLAG_UNNUMBERED);
1640       si->unnumbered_sw_if_index = (u32) ~ 0;
1641
1642       ip4_main.lookup_main.if_address_pool_index_by_sw_if_index
1643         [unnumbered_sw_if_index] = ~0;
1644       ip6_main.lookup_main.if_address_pool_index_by_sw_if_index
1645         [unnumbered_sw_if_index] = ~0;
1646     }
1647
1648   if (was_unnum != (si->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED))
1649     {
1650       ip4_sw_interface_enable_disable (unnumbered_sw_if_index, enable);
1651       ip6_sw_interface_enable_disable (unnumbered_sw_if_index, enable);
1652     }
1653 }
1654
1655 vnet_l3_packet_type_t
1656 vnet_link_to_l3_proto (vnet_link_t link)
1657 {
1658   switch (link)
1659     {
1660     case VNET_LINK_IP4:
1661       return (VNET_L3_PACKET_TYPE_IP4);
1662     case VNET_LINK_IP6:
1663       return (VNET_L3_PACKET_TYPE_IP6);
1664     case VNET_LINK_MPLS:
1665       return (VNET_L3_PACKET_TYPE_MPLS);
1666     case VNET_LINK_ARP:
1667       return (VNET_L3_PACKET_TYPE_ARP);
1668     case VNET_LINK_ETHERNET:
1669     case VNET_LINK_NSH:
1670       ASSERT (0);
1671       break;
1672     }
1673   ASSERT (0);
1674   return (0);
1675 }
1676
1677 vnet_mtu_t
1678 vnet_link_to_mtu (vnet_link_t link)
1679 {
1680   switch (link)
1681     {
1682     case VNET_LINK_IP4:
1683       return (VNET_MTU_IP4);
1684     case VNET_LINK_IP6:
1685       return (VNET_MTU_IP6);
1686     case VNET_LINK_MPLS:
1687       return (VNET_MTU_MPLS);
1688     default:
1689       return (VNET_MTU_L3);
1690     }
1691 }
1692
1693 u8 *
1694 default_build_rewrite (vnet_main_t * vnm,
1695                        u32 sw_if_index,
1696                        vnet_link_t link_type, const void *dst_address)
1697 {
1698   return (NULL);
1699 }
1700
1701 void
1702 default_update_adjacency (vnet_main_t * vnm, u32 sw_if_index, u32 ai)
1703 {
1704   ip_adjacency_t *adj;
1705
1706   adj = adj_get (ai);
1707
1708   switch (adj->lookup_next_index)
1709     {
1710     case IP_LOOKUP_NEXT_GLEAN:
1711       adj_glean_update_rewrite (ai);
1712       break;
1713     case IP_LOOKUP_NEXT_ARP:
1714     case IP_LOOKUP_NEXT_BCAST:
1715       /*
1716        * default rewrite in neighbour adj
1717        */
1718       adj_nbr_update_rewrite
1719         (ai,
1720          ADJ_NBR_REWRITE_FLAG_COMPLETE,
1721          vnet_build_rewrite_for_sw_interface (vnm,
1722                                               sw_if_index,
1723                                               adj_get_link_type (ai), NULL));
1724       break;
1725     case IP_LOOKUP_NEXT_MCAST:
1726       /*
1727        * mcast traffic also uses default rewrite string with no mcast
1728        * switch time updates.
1729        */
1730       adj_mcast_update_rewrite
1731         (ai,
1732          vnet_build_rewrite_for_sw_interface (vnm,
1733                                               sw_if_index,
1734                                               adj_get_link_type (ai),
1735                                               NULL), 0);
1736       break;
1737     case IP_LOOKUP_NEXT_DROP:
1738     case IP_LOOKUP_NEXT_PUNT:
1739     case IP_LOOKUP_NEXT_LOCAL:
1740     case IP_LOOKUP_NEXT_REWRITE:
1741     case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
1742     case IP_LOOKUP_NEXT_MIDCHAIN:
1743     case IP_LOOKUP_NEXT_ICMP_ERROR:
1744     case IP_LOOKUP_N_NEXT:
1745       ASSERT (0);
1746       break;
1747     }
1748 }
1749
1750 clib_error_t *
1751 vnet_hw_interface_set_rss_queues (vnet_main_t * vnm,
1752                                   vnet_hw_interface_t * hi,
1753                                   clib_bitmap_t * bitmap)
1754 {
1755   clib_error_t *error = 0;
1756   vnet_device_class_t *dev_class =
1757     vnet_get_device_class (vnm, hi->dev_class_index);
1758
1759   if (dev_class->set_rss_queues_function)
1760     {
1761       if (clib_bitmap_count_set_bits (bitmap) == 0)
1762         {
1763           error = clib_error_return (0,
1764                                      "must assign at least one valid rss queue");
1765           goto done;
1766         }
1767
1768       error = dev_class->set_rss_queues_function (vnm, hi, bitmap);
1769     }
1770   else
1771     {
1772       error = clib_error_return (0,
1773                                  "setting rss queues is not supported on this interface");
1774     }
1775
1776   if (!error)
1777     {
1778       clib_bitmap_free (hi->rss_queues);
1779       hi->rss_queues = clib_bitmap_dup (bitmap);
1780     }
1781
1782 done:
1783   if (error)
1784     log_err ("hw_set_rss_queues: %U", format_clib_error, error);
1785   return error;
1786 }
1787
1788 int collect_detailed_interface_stats_flag = 0;
1789
1790 void
1791 collect_detailed_interface_stats_flag_set (void)
1792 {
1793   collect_detailed_interface_stats_flag = 1;
1794 }
1795
1796 void
1797 collect_detailed_interface_stats_flag_clear (void)
1798 {
1799   collect_detailed_interface_stats_flag = 0;
1800 }
1801
1802 static clib_error_t *
1803 collect_detailed_interface_stats_cli (vlib_main_t * vm,
1804                                       unformat_input_t * input,
1805                                       vlib_cli_command_t * cmd)
1806 {
1807   unformat_input_t _line_input, *line_input = &_line_input;
1808   clib_error_t *error = NULL;
1809
1810   /* Get a line of input. */
1811   if (!unformat_user (input, unformat_line_input, line_input))
1812     return clib_error_return (0, "expected enable | disable");
1813
1814   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1815     {
1816       if (unformat (line_input, "enable") || unformat (line_input, "on"))
1817         collect_detailed_interface_stats_flag_set ();
1818       else if (unformat (line_input, "disable")
1819                || unformat (line_input, "off"))
1820         collect_detailed_interface_stats_flag_clear ();
1821       else
1822         {
1823           error = clib_error_return (0, "unknown input `%U'",
1824                                      format_unformat_error, line_input);
1825           goto done;
1826         }
1827     }
1828
1829 done:
1830   unformat_free (line_input);
1831   return error;
1832 }
1833
1834 /* *INDENT-OFF* */
1835 VLIB_CLI_COMMAND (collect_detailed_interface_stats_command, static) = {
1836   .path = "interface collect detailed-stats",
1837   .short_help = "interface collect detailed-stats <enable|disable>",
1838   .function = collect_detailed_interface_stats_cli,
1839 };
1840 /* *INDENT-ON* */
1841
1842 /*
1843  * fd.io coding-style-patch-verification: ON
1844  *
1845  * Local Variables:
1846  * eval: (c-set-style "gnu")
1847  * End:
1848  */