vlib: refactor node function variants
[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 u32
558 vnet_create_sw_interface_no_callbacks (vnet_main_t * vnm,
559                                        vnet_sw_interface_t * template)
560 {
561   vnet_interface_main_t *im = &vnm->interface_main;
562   vnet_sw_interface_t *sw;
563   u32 sw_if_index;
564
565   pool_get (im->sw_interfaces, sw);
566   sw_if_index = sw - im->sw_interfaces;
567
568   sw[0] = template[0];
569
570   sw->flags = 0;
571   sw->sw_if_index = sw_if_index;
572   if (sw->type == VNET_SW_INTERFACE_TYPE_HARDWARE)
573     sw->sup_sw_if_index = sw->sw_if_index;
574
575   /* Allocate counters for this interface. */
576   {
577     u32 i;
578
579     vnet_interface_counter_lock (im);
580
581     for (i = 0; i < vec_len (im->sw_if_counters); i++)
582       {
583         vlib_validate_simple_counter (&im->sw_if_counters[i], sw_if_index);
584         vlib_zero_simple_counter (&im->sw_if_counters[i], sw_if_index);
585       }
586
587     for (i = 0; i < vec_len (im->combined_sw_if_counters); i++)
588       {
589         vlib_validate_combined_counter (&im->combined_sw_if_counters[i],
590                                         sw_if_index);
591         vlib_zero_combined_counter (&im->combined_sw_if_counters[i],
592                                     sw_if_index);
593       }
594
595     vnet_interface_counter_unlock (im);
596   }
597
598   return sw_if_index;
599 }
600
601 clib_error_t *
602 vnet_create_sw_interface (vnet_main_t * vnm, vnet_sw_interface_t * template,
603                           u32 * sw_if_index)
604 {
605   vnet_interface_main_t *im = &vnm->interface_main;
606   clib_error_t *error;
607   vnet_hw_interface_t *hi;
608   vnet_device_class_t *dev_class;
609
610   if (template->sub.eth.flags.two_tags == 1
611       && template->sub.eth.flags.exact_match == 1
612       && (template->sub.eth.flags.inner_vlan_id_any == 1
613           || template->sub.eth.flags.outer_vlan_id_any == 1))
614     {
615       char *str = "inner-dot1q any exact-match is unsupported";
616       error = clib_error_return (0, str);
617       log_err ("create_sw_interface: %s", str);
618       return error;
619     }
620
621   hi = vnet_get_sup_hw_interface (vnm, template->sup_sw_if_index);
622   dev_class = vnet_get_device_class (vnm, hi->dev_class_index);
623
624   if (template->type == VNET_SW_INTERFACE_TYPE_SUB &&
625       dev_class->subif_add_del_function)
626     {
627       error = dev_class->subif_add_del_function (vnm, hi->hw_if_index,
628                                                  (struct vnet_sw_interface_t
629                                                   *) template, 1);
630       if (error)
631         return error;
632     }
633
634   *sw_if_index = vnet_create_sw_interface_no_callbacks (vnm, template);
635   error = vnet_sw_interface_set_flags_helper
636     (vnm, *sw_if_index, template->flags,
637      VNET_INTERFACE_SET_FLAGS_HELPER_IS_CREATE);
638
639   if (error)
640     {
641       /* undo the work done by vnet_create_sw_interface_no_callbacks() */
642       log_err ("create_sw_interface: set flags failed\n  %U",
643                format_clib_error, error);
644       vnet_sw_interface_t *sw =
645         pool_elt_at_index (im->sw_interfaces, *sw_if_index);
646       pool_put (im->sw_interfaces, sw);
647     }
648   else
649     {
650       vnet_sw_interface_t *sw =
651         pool_elt_at_index (im->sw_interfaces, *sw_if_index);
652       log_debug ("create_sw_interface: interface %U (sw_if_index %u) created",
653                  format_vnet_sw_interface_name, vnm, sw, *sw_if_index);
654     }
655
656   return error;
657 }
658
659 void
660 vnet_delete_sw_interface (vnet_main_t * vnm, u32 sw_if_index)
661 {
662   vnet_interface_main_t *im = &vnm->interface_main;
663   vnet_sw_interface_t *sw =
664     pool_elt_at_index (im->sw_interfaces, sw_if_index);
665
666   log_debug ("delete_sw_interface: sw_if_index %u, name '%U'",
667              sw_if_index, format_vnet_sw_if_index_name, vnm, sw_if_index);
668
669   /* Check if the interface has config and is removed from L2 BD or XConnect */
670   vnet_clear_sw_interface_tag (vnm, sw_if_index);
671
672   /* Bring down interface in case it is up. */
673   if (sw->flags != 0)
674     vnet_sw_interface_set_flags (vnm, sw_if_index, /* flags */ 0);
675
676   call_sw_interface_add_del_callbacks (vnm, sw_if_index, /* is_create */ 0);
677
678   pool_put (im->sw_interfaces, sw);
679 }
680
681 static clib_error_t *
682 call_sw_interface_mtu_change_callbacks (vnet_main_t * vnm, u32 sw_if_index)
683 {
684   return call_elf_section_interface_callbacks
685     (vnm, sw_if_index, 0, vnm->sw_interface_mtu_change_functions);
686 }
687
688 void
689 vnet_sw_interface_set_mtu (vnet_main_t * vnm, u32 sw_if_index, u32 mtu)
690 {
691   vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
692
693   if (si->mtu[VNET_MTU_L3] != mtu)
694     {
695       si->mtu[VNET_MTU_L3] = mtu;
696       log_debug ("set_mtu: interface %U, new mtu %u",
697                  format_vnet_sw_if_index_name, vnm, sw_if_index, mtu);
698
699       call_sw_interface_mtu_change_callbacks (vnm, sw_if_index);
700     }
701 }
702
703 void
704 vnet_sw_interface_set_protocol_mtu (vnet_main_t * vnm, u32 sw_if_index,
705                                     u32 mtu[])
706 {
707   vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
708   bool changed = false;
709   int i;
710
711   for (i = 0; i < VNET_N_MTU; i++)
712     {
713       if (si->mtu[i] != mtu[i])
714         {
715           si->mtu[i] = mtu[i];
716           changed = true;
717         }
718     }
719   /* Notify interested parties */
720   if (changed)
721     {
722       log_debug ("set_protocol_mtu: interface %U l3 %u ip4 %u ip6 %u mpls %u",
723                  format_vnet_sw_if_index_name, vnm, sw_if_index,
724                  mtu[VNET_MTU_L3], mtu[VNET_MTU_IP4], mtu[VNET_MTU_IP6],
725                  mtu[VNET_MTU_MPLS]);
726       call_sw_interface_mtu_change_callbacks (vnm, sw_if_index);
727     }
728 }
729
730 void
731 vnet_sw_interface_ip_directed_broadcast (vnet_main_t * vnm,
732                                          u32 sw_if_index, u8 enable)
733 {
734   vnet_sw_interface_t *si;
735
736   si = vnet_get_sw_interface (vnm, sw_if_index);
737
738   if (enable)
739     si->flags |= VNET_SW_INTERFACE_FLAG_DIRECTED_BCAST;
740   else
741     si->flags &= ~VNET_SW_INTERFACE_FLAG_DIRECTED_BCAST;
742
743   ip4_directed_broadcast (sw_if_index, enable);
744 }
745
746 /*
747  * Reflect a change in hardware MTU on protocol MTUs
748  */
749 static walk_rc_t
750 sw_interface_walk_callback (vnet_main_t * vnm, u32 sw_if_index, void *ctx)
751 {
752   u32 *link_mtu = ctx;
753   vnet_sw_interface_set_mtu (vnm, sw_if_index, *link_mtu);
754   return WALK_CONTINUE;
755 }
756
757 void
758 vnet_hw_interface_set_mtu (vnet_main_t * vnm, u32 hw_if_index, u32 mtu)
759 {
760   vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
761
762   if (hi->max_packet_bytes != mtu)
763     {
764       hi->max_packet_bytes = mtu;
765       ethernet_set_flags (vnm, hw_if_index, ETHERNET_INTERFACE_FLAG_MTU);
766       vnet_hw_interface_walk_sw (vnm, hw_if_index, sw_interface_walk_callback,
767                                  &mtu);
768     }
769 }
770
771 static void
772 setup_tx_node (vlib_main_t * vm,
773                u32 node_index, vnet_device_class_t * dev_class)
774 {
775   vlib_node_t *n = vlib_get_node (vm, node_index);
776
777   n->format_trace = dev_class->format_tx_trace;
778
779   /// XXX: Update this to use counter structure
780   vlib_register_errors (vm, node_index,
781                         dev_class->tx_function_n_errors,
782                         dev_class->tx_function_error_strings, 0);
783 }
784
785 static void
786 setup_output_node (vlib_main_t * vm,
787                    u32 node_index, vnet_hw_interface_class_t * hw_class)
788 {
789   vlib_node_t *n = vlib_get_node (vm, node_index);
790   n->format_buffer = hw_class->format_header;
791   n->unformat_buffer = hw_class->unformat_header;
792 }
793
794 /* Register an interface instance. */
795 u32
796 vnet_register_interface (vnet_main_t * vnm,
797                          u32 dev_class_index,
798                          u32 dev_instance,
799                          u32 hw_class_index, u32 hw_instance)
800 {
801   vnet_interface_main_t *im = &vnm->interface_main;
802   vnet_hw_interface_t *hw;
803   vnet_device_class_t *dev_class =
804     vnet_get_device_class (vnm, dev_class_index);
805   vnet_hw_interface_class_t *hw_class =
806     vnet_get_hw_interface_class (vnm, hw_class_index);
807   vlib_main_t *vm = vnm->vlib_main;
808   vnet_feature_config_main_t *fcm;
809   vnet_config_main_t *cm;
810   u32 hw_index, i;
811   char *tx_node_name = NULL, *output_node_name = NULL;
812   vlib_node_t *if_out_node =
813     vlib_get_node (vm, vnet_interface_output_node.index);
814
815   pool_get (im->hw_interfaces, hw);
816   clib_memset (hw, 0, sizeof (*hw));
817   hw->trace_classify_table_index = ~0;
818
819   hw_index = hw - im->hw_interfaces;
820   hw->hw_if_index = hw_index;
821   hw->default_rx_mode = VNET_HW_IF_RX_MODE_POLLING;
822
823   if (dev_class->format_device_name)
824     hw->name = format (0, "%U", dev_class->format_device_name, dev_instance);
825   else if (hw_class->format_interface_name)
826     hw->name = format (0, "%U", hw_class->format_interface_name,
827                        dev_instance);
828   else
829     hw->name = format (0, "%s%x", hw_class->name, dev_instance);
830
831   if (!im->hw_interface_by_name)
832     im->hw_interface_by_name = hash_create_vec ( /* size */ 0,
833                                                 sizeof (hw->name[0]),
834                                                 sizeof (uword));
835
836   hash_set_mem (im->hw_interface_by_name, hw->name, hw_index);
837
838   /* Make hardware interface point to software interface. */
839   {
840     vnet_sw_interface_t sw = {
841       .type = VNET_SW_INTERFACE_TYPE_HARDWARE,
842       .flood_class = VNET_FLOOD_CLASS_NORMAL,
843       .hw_if_index = hw_index
844     };
845     hw->sw_if_index = vnet_create_sw_interface_no_callbacks (vnm, &sw);
846   }
847
848   hw->dev_class_index = dev_class_index;
849   hw->dev_instance = dev_instance;
850   hw->hw_class_index = hw_class_index;
851   hw->hw_instance = hw_instance;
852
853   hw->max_rate_bits_per_sec = 0;
854   hw->min_packet_bytes = 0;
855   vnet_sw_interface_set_mtu (vnm, hw->sw_if_index, 0);
856
857   if (dev_class->tx_function == 0 && dev_class->tx_fn_registrations == 0)
858     goto no_output_nodes;       /* No output/tx nodes to create */
859
860   tx_node_name = (char *) format (0, "%v-tx", hw->name);
861   output_node_name = (char *) format (0, "%v-output", hw->name);
862
863   /* If we have previously deleted interface nodes, re-use them. */
864   if (vec_len (im->deleted_hw_interface_nodes) > 0)
865     {
866       vnet_hw_interface_nodes_t *hn;
867       vlib_node_t *node;
868       vlib_node_runtime_t *nrt;
869
870       hn = vec_end (im->deleted_hw_interface_nodes) - 1;
871
872       hw->tx_node_index = hn->tx_node_index;
873       hw->output_node_index = hn->output_node_index;
874
875       vlib_node_rename (vm, hw->tx_node_index, "%v", tx_node_name);
876       vlib_node_rename (vm, hw->output_node_index, "%v", output_node_name);
877
878       /* *INDENT-OFF* */
879       foreach_vlib_main ({
880         vnet_interface_output_runtime_t *rt;
881
882         rt = vlib_node_get_runtime_data (this_vlib_main, hw->output_node_index);
883         ASSERT (rt->is_deleted == 1);
884         rt->is_deleted = 0;
885         rt->hw_if_index = hw_index;
886         rt->sw_if_index = hw->sw_if_index;
887         rt->dev_instance = hw->dev_instance;
888
889         rt = vlib_node_get_runtime_data (this_vlib_main, hw->tx_node_index);
890         rt->hw_if_index = hw_index;
891         rt->sw_if_index = hw->sw_if_index;
892         rt->dev_instance = hw->dev_instance;
893       });
894       /* *INDENT-ON* */
895
896       /* The new class may differ from the old one.
897        * Functions have to be updated. */
898       node = vlib_get_node (vm, hw->output_node_index);
899       node->format_trace = format_vnet_interface_output_trace;
900       node->node_fn_registrations = if_out_node->node_fn_registrations;
901       node->function = if_out_node->function;
902
903       /* *INDENT-OFF* */
904       foreach_vlib_main ({
905         nrt = vlib_node_get_runtime (this_vlib_main, hw->output_node_index);
906         nrt->function = node->function;
907         vlib_node_runtime_perf_counter (this_vlib_main, nrt, 0, 0, 0,
908                                         VLIB_NODE_RUNTIME_PERF_RESET);
909       });
910       /* *INDENT-ON* */
911
912       node = vlib_get_node (vm, hw->tx_node_index);
913       if (dev_class->tx_fn_registrations)
914         {
915           node->node_fn_registrations = dev_class->tx_fn_registrations;
916           node->function = vlib_node_get_preferred_node_fn_variant (
917             vm, dev_class->tx_fn_registrations);
918         }
919       else
920         node->function = dev_class->tx_function;
921       node->format_trace = dev_class->format_tx_trace;
922       /* *INDENT-OFF* */
923       foreach_vlib_main ({
924         nrt = vlib_node_get_runtime (this_vlib_main, hw->tx_node_index);
925         nrt->function = node->function;
926         vlib_node_runtime_perf_counter (this_vlib_main, nrt, 0, 0, 0,
927                                         VLIB_NODE_RUNTIME_PERF_RESET);
928       });
929       /* *INDENT-ON* */
930
931       _vec_len (im->deleted_hw_interface_nodes) -= 1;
932     }
933   else
934     {
935       vlib_node_registration_t r;
936       vnet_interface_output_runtime_t rt = {
937         .hw_if_index = hw_index,
938         .sw_if_index = hw->sw_if_index,
939         .dev_instance = hw->dev_instance,
940         .is_deleted = 0,
941       };
942
943       clib_memset (&r, 0, sizeof (r));
944       r.type = VLIB_NODE_TYPE_INTERNAL;
945       r.runtime_data = &rt;
946       r.runtime_data_bytes = sizeof (rt);
947       r.scalar_size = 0;
948       r.vector_size = sizeof (u32);
949
950       r.flags = VLIB_NODE_FLAG_IS_OUTPUT;
951       r.name = tx_node_name;
952       if (dev_class->tx_fn_registrations)
953         {
954           r.function = 0;
955           r.node_fn_registrations = dev_class->tx_fn_registrations;
956         }
957       else
958         r.function = dev_class->tx_function;
959
960       hw->tx_node_index = vlib_register_node (vm, &r);
961
962       vlib_node_add_named_next_with_slot (vm, hw->tx_node_index,
963                                           "error-drop",
964                                           VNET_INTERFACE_TX_NEXT_DROP);
965
966       r.flags = 0;
967       r.name = output_node_name;
968       r.format_trace = format_vnet_interface_output_trace;
969       if (if_out_node->node_fn_registrations)
970         {
971           r.function = 0;
972           r.node_fn_registrations = if_out_node->node_fn_registrations;
973         }
974       else
975         r.function = if_out_node->function;
976
977       {
978         static char *e[] = {
979           "interface is down",
980           "interface is deleted",
981           "no buffers to segment GSO",
982         };
983
984         r.n_errors = ARRAY_LEN (e);
985         r.error_strings = e;
986       }
987       hw->output_node_index = vlib_register_node (vm, &r);
988
989       vlib_node_add_named_next_with_slot (vm, hw->output_node_index,
990                                           "error-drop",
991                                           VNET_INTERFACE_OUTPUT_NEXT_DROP);
992       vlib_node_add_next_with_slot (vm, hw->output_node_index,
993                                     hw->tx_node_index,
994                                     VNET_INTERFACE_OUTPUT_NEXT_TX);
995
996       /* add interface to the list of "output-interface" feature arc start nodes
997          and clone nexts from 1st interface if it exists */
998       fcm = vnet_feature_get_config_main (im->output_feature_arc_index);
999       cm = &fcm->config_main;
1000       i = vec_len (cm->start_node_indices);
1001       vec_validate (cm->start_node_indices, i);
1002       cm->start_node_indices[i] = hw->output_node_index;
1003       if (hw_index)
1004         {
1005           /* copy nexts from 1st interface */
1006           vnet_hw_interface_t *first_hw;
1007           vlib_node_t *first_node;
1008
1009           first_hw = vnet_get_hw_interface (vnm, /* hw_if_index */ 0);
1010           first_node = vlib_get_node (vm, first_hw->output_node_index);
1011
1012           /* 1st 2 nexts are already added above */
1013           for (i = 2; i < vec_len (first_node->next_nodes); i++)
1014             vlib_node_add_next_with_slot (vm, hw->output_node_index,
1015                                           first_node->next_nodes[i], i);
1016         }
1017     }
1018
1019   setup_output_node (vm, hw->output_node_index, hw_class);
1020   setup_tx_node (vm, hw->tx_node_index, dev_class);
1021
1022 no_output_nodes:
1023   /* Call all up/down callbacks with zero flags when interface is created. */
1024   vnet_sw_interface_set_flags_helper (vnm, hw->sw_if_index, /* flags */ 0,
1025                                       VNET_INTERFACE_SET_FLAGS_HELPER_IS_CREATE);
1026   vnet_hw_interface_set_flags_helper (vnm, hw_index, /* flags */ 0,
1027                                       VNET_INTERFACE_SET_FLAGS_HELPER_IS_CREATE);
1028   vec_free (tx_node_name);
1029   vec_free (output_node_name);
1030
1031   return hw_index;
1032 }
1033
1034 void
1035 vnet_delete_hw_interface (vnet_main_t * vnm, u32 hw_if_index)
1036 {
1037   vnet_interface_main_t *im = &vnm->interface_main;
1038   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
1039   vlib_main_t *vm = vnm->vlib_main;
1040   vnet_device_class_t *dev_class = vnet_get_device_class (vnm,
1041                                                           hw->dev_class_index);
1042   /* If it is up, mark it down. */
1043   if (hw->flags != 0)
1044     vnet_hw_interface_set_flags (vnm, hw_if_index, /* flags */ 0);
1045
1046   /* Call delete callbacks. */
1047   call_hw_interface_add_del_callbacks (vnm, hw_if_index, /* is_create */ 0);
1048
1049   /* delete rx queues */
1050   vnet_hw_if_unregister_all_rx_queues (vnm, hw_if_index);
1051   vnet_hw_if_update_runtime_data (vnm, hw_if_index);
1052
1053   /* Delete any sub-interfaces. */
1054   {
1055     u32 id, sw_if_index;
1056     /* *INDENT-OFF* */
1057     hash_foreach (id, sw_if_index, hw->sub_interface_sw_if_index_by_id,
1058     ({
1059       vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
1060       u64 sup_and_sub_key =
1061         ((u64) (si->sup_sw_if_index) << 32) | (u64) si->sub.id;
1062       hash_unset_mem_free (&im->sw_if_index_by_sup_and_sub, &sup_and_sub_key);
1063       vnet_delete_sw_interface (vnm, sw_if_index);
1064     }));
1065     hash_free (hw->sub_interface_sw_if_index_by_id);
1066     /* *INDENT-ON* */
1067   }
1068
1069   /* Delete software interface corresponding to hardware interface. */
1070   vnet_delete_sw_interface (vnm, hw->sw_if_index);
1071
1072   if (dev_class->tx_function)
1073     {
1074       /* Put output/tx nodes into recycle pool */
1075       vnet_hw_interface_nodes_t *dn;
1076
1077       /* *INDENT-OFF* */
1078       foreach_vlib_main
1079         ({
1080           vnet_interface_output_runtime_t *rt =
1081             vlib_node_get_runtime_data (this_vlib_main, hw->output_node_index);
1082
1083           /* Mark node runtime as deleted so output node (if called)
1084            * will drop packets. */
1085           rt->is_deleted = 1;
1086         });
1087       /* *INDENT-ON* */
1088
1089       vlib_node_rename (vm, hw->output_node_index,
1090                         "interface-%d-output-deleted", hw_if_index);
1091       vlib_node_rename (vm, hw->tx_node_index, "interface-%d-tx-deleted",
1092                         hw_if_index);
1093       vec_add2 (im->deleted_hw_interface_nodes, dn, 1);
1094       dn->tx_node_index = hw->tx_node_index;
1095       dn->output_node_index = hw->output_node_index;
1096     }
1097
1098   hash_unset_mem (im->hw_interface_by_name, hw->name);
1099   vec_free (hw->name);
1100   vec_free (hw->hw_address);
1101   vec_free (hw->input_node_thread_index_by_queue);
1102   vec_free (hw->rx_queue_indices);
1103   pool_put (im->hw_interfaces, hw);
1104 }
1105
1106 void
1107 vnet_hw_interface_walk_sw (vnet_main_t * vnm,
1108                            u32 hw_if_index,
1109                            vnet_hw_sw_interface_walk_t fn, void *ctx)
1110 {
1111   vnet_hw_interface_t *hi;
1112   u32 id, sw_if_index;
1113
1114   hi = vnet_get_hw_interface (vnm, hw_if_index);
1115   /* the super first, then the sub interfaces */
1116   if (WALK_STOP == fn (vnm, hi->sw_if_index, ctx))
1117     return;
1118
1119   /* *INDENT-OFF* */
1120   hash_foreach (id, sw_if_index,
1121                 hi->sub_interface_sw_if_index_by_id,
1122   ({
1123     if (WALK_STOP == fn (vnm, sw_if_index, ctx))
1124       break;
1125   }));
1126   /* *INDENT-ON* */
1127 }
1128
1129 void
1130 vnet_hw_interface_walk (vnet_main_t * vnm,
1131                         vnet_hw_interface_walk_t fn, void *ctx)
1132 {
1133   vnet_interface_main_t *im;
1134   vnet_hw_interface_t *hi;
1135
1136   im = &vnm->interface_main;
1137
1138   /* *INDENT-OFF* */
1139   pool_foreach (hi, im->hw_interfaces)
1140    {
1141     if (WALK_STOP == fn(vnm, hi->hw_if_index, ctx))
1142       break;
1143   }
1144   /* *INDENT-ON* */
1145 }
1146
1147 void
1148 vnet_sw_interface_walk (vnet_main_t * vnm,
1149                         vnet_sw_interface_walk_t fn, void *ctx)
1150 {
1151   vnet_interface_main_t *im;
1152   vnet_sw_interface_t *si;
1153
1154   im = &vnm->interface_main;
1155
1156   /* *INDENT-OFF* */
1157   pool_foreach (si, im->sw_interfaces)
1158   {
1159     if (WALK_STOP == fn (vnm, si, ctx))
1160       break;
1161   }
1162   /* *INDENT-ON* */
1163 }
1164
1165 void
1166 vnet_hw_interface_init_for_class (vnet_main_t * vnm, u32 hw_if_index,
1167                                   u32 hw_class_index, u32 hw_instance)
1168 {
1169   vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
1170   vnet_hw_interface_class_t *hc =
1171     vnet_get_hw_interface_class (vnm, hw_class_index);
1172
1173   hi->hw_class_index = hw_class_index;
1174   hi->hw_instance = hw_instance;
1175   setup_output_node (vnm->vlib_main, hi->output_node_index, hc);
1176 }
1177
1178 static clib_error_t *
1179 vnet_hw_interface_set_class_helper (vnet_main_t * vnm, u32 hw_if_index,
1180                                     u32 hw_class_index, u32 redistribute)
1181 {
1182   vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
1183   vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, hi->sw_if_index);
1184   vnet_hw_interface_class_t *old_class =
1185     vnet_get_hw_interface_class (vnm, hi->hw_class_index);
1186   vnet_hw_interface_class_t *new_class =
1187     vnet_get_hw_interface_class (vnm, hw_class_index);
1188   vnet_device_class_t *dev_class =
1189     vnet_get_device_class (vnm, hi->dev_class_index);
1190   clib_error_t *error = 0;
1191
1192   /* New class equals old class?  Nothing to do. */
1193   if (hi->hw_class_index == hw_class_index)
1194     return 0;
1195
1196   /* No need (and incorrect since admin up flag may be set) to do error checking when
1197      receiving unserialize message. */
1198   if (redistribute)
1199     {
1200       if (si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
1201         return clib_error_return (0,
1202                                   "%v must be admin down to change class from %s to %s",
1203                                   hi->name, old_class->name, new_class->name);
1204
1205       /* Make sure interface supports given class. */
1206       if ((new_class->is_valid_class_for_interface
1207            && !new_class->is_valid_class_for_interface (vnm, hw_if_index,
1208                                                         hw_class_index))
1209           || (dev_class->is_valid_class_for_interface
1210               && !dev_class->is_valid_class_for_interface (vnm, hw_if_index,
1211                                                            hw_class_index)))
1212         return clib_error_return (0,
1213                                   "%v class cannot be changed from %s to %s",
1214                                   hi->name, old_class->name, new_class->name);
1215
1216     }
1217
1218   if (old_class->hw_class_change)
1219     old_class->hw_class_change (vnm, hw_if_index, old_class->index,
1220                                 new_class->index);
1221
1222   vnet_hw_interface_init_for_class (vnm, hw_if_index, new_class->index,
1223                                     /* instance */ ~0);
1224
1225   if (new_class->hw_class_change)
1226     new_class->hw_class_change (vnm, hw_if_index, old_class->index,
1227                                 new_class->index);
1228
1229   if (dev_class->hw_class_change)
1230     dev_class->hw_class_change (vnm, hw_if_index, new_class->index);
1231
1232   return error;
1233 }
1234
1235 clib_error_t *
1236 vnet_hw_interface_set_class (vnet_main_t * vnm, u32 hw_if_index,
1237                              u32 hw_class_index)
1238 {
1239   return vnet_hw_interface_set_class_helper (vnm, hw_if_index, hw_class_index,
1240                                              /* redistribute */ 1);
1241 }
1242
1243 static int
1244 vnet_hw_interface_rx_redirect_to_node_helper (vnet_main_t * vnm,
1245                                               u32 hw_if_index,
1246                                               u32 node_index,
1247                                               u32 redistribute)
1248 {
1249   vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
1250   vnet_device_class_t *dev_class = vnet_get_device_class
1251     (vnm, hi->dev_class_index);
1252
1253   if (dev_class->rx_redirect_to_node)
1254     {
1255       dev_class->rx_redirect_to_node (vnm, hw_if_index, node_index);
1256       return 0;
1257     }
1258
1259   return VNET_API_ERROR_UNIMPLEMENTED;
1260 }
1261
1262 int
1263 vnet_hw_interface_rx_redirect_to_node (vnet_main_t * vnm, u32 hw_if_index,
1264                                        u32 node_index)
1265 {
1266   return vnet_hw_interface_rx_redirect_to_node_helper (vnm, hw_if_index,
1267                                                        node_index,
1268                                                        1 /* redistribute */ );
1269 }
1270
1271 word
1272 vnet_sw_interface_compare (vnet_main_t * vnm,
1273                            uword sw_if_index0, uword sw_if_index1)
1274 {
1275   vnet_sw_interface_t *sup0 = vnet_get_sup_sw_interface (vnm, sw_if_index0);
1276   vnet_sw_interface_t *sup1 = vnet_get_sup_sw_interface (vnm, sw_if_index1);
1277   vnet_hw_interface_t *h0 = vnet_get_hw_interface (vnm, sup0->hw_if_index);
1278   vnet_hw_interface_t *h1 = vnet_get_hw_interface (vnm, sup1->hw_if_index);
1279
1280   if (h0 != h1)
1281     return vec_cmp (h0->name, h1->name);
1282   return (word) h0->hw_instance - (word) h1->hw_instance;
1283 }
1284
1285 word
1286 vnet_hw_interface_compare (vnet_main_t * vnm,
1287                            uword hw_if_index0, uword hw_if_index1)
1288 {
1289   vnet_hw_interface_t *h0 = vnet_get_hw_interface (vnm, hw_if_index0);
1290   vnet_hw_interface_t *h1 = vnet_get_hw_interface (vnm, hw_if_index1);
1291
1292   if (h0 != h1)
1293     return vec_cmp (h0->name, h1->name);
1294   return (word) h0->hw_instance - (word) h1->hw_instance;
1295 }
1296
1297 int
1298 vnet_sw_interface_is_p2p (vnet_main_t * vnm, u32 sw_if_index)
1299 {
1300   vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
1301   if ((si->type == VNET_SW_INTERFACE_TYPE_P2P) ||
1302       (si->type == VNET_SW_INTERFACE_TYPE_PIPE))
1303     return 1;
1304
1305   vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
1306   vnet_hw_interface_class_t *hc =
1307     vnet_get_hw_interface_class (vnm, hw->hw_class_index);
1308
1309   return (hc->flags & VNET_HW_INTERFACE_CLASS_FLAG_P2P);
1310 }
1311
1312 int
1313 vnet_sw_interface_is_nbma (vnet_main_t * vnm, u32 sw_if_index)
1314 {
1315   vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
1316   vnet_hw_interface_class_t *hc =
1317     vnet_get_hw_interface_class (vnm, hw->hw_class_index);
1318
1319   return (hc->flags & VNET_HW_INTERFACE_CLASS_FLAG_NBMA);
1320 }
1321
1322 clib_error_t *
1323 vnet_interface_init (vlib_main_t * vm)
1324 {
1325   vnet_main_t *vnm = vnet_get_main ();
1326   vnet_interface_main_t *im = &vnm->interface_main;
1327   vlib_buffer_t *b = 0;
1328   vnet_buffer_opaque_t *o = 0;
1329   clib_error_t *error;
1330
1331   /*
1332    * Keep people from shooting themselves in the foot.
1333    */
1334   if (sizeof (b->opaque) != sizeof (vnet_buffer_opaque_t))
1335     {
1336 #define _(a) if (sizeof(o->a) > sizeof (o->unused))                     \
1337       clib_warning                                                      \
1338         ("FATAL: size of opaque union subtype %s is %d (max %d)",       \
1339          #a, sizeof(o->a), sizeof (o->unused));
1340       foreach_buffer_opaque_union_subtype;
1341 #undef _
1342
1343       return clib_error_return
1344         (0, "FATAL: size of vlib buffer opaque %d, size of vnet opaque %d",
1345          sizeof (b->opaque), sizeof (vnet_buffer_opaque_t));
1346     }
1347
1348   clib_spinlock_init (&im->sw_if_counter_lock);
1349   clib_spinlock_lock (&im->sw_if_counter_lock); /* should be no need */
1350
1351   vec_validate (im->sw_if_counters, VNET_N_SIMPLE_INTERFACE_COUNTER - 1);
1352 #define _(E,n,p)                                                        \
1353   im->sw_if_counters[VNET_INTERFACE_COUNTER_##E].name = #n;             \
1354   im->sw_if_counters[VNET_INTERFACE_COUNTER_##E].stat_segment_name = "/" #p "/" #n;
1355   foreach_simple_interface_counter_name
1356 #undef _
1357     vec_validate (im->combined_sw_if_counters,
1358                   VNET_N_COMBINED_INTERFACE_COUNTER - 1);
1359 #define _(E,n,p)                                                        \
1360   im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_##E].name = #n;    \
1361   im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_##E].stat_segment_name = "/" #p "/" #n;
1362   foreach_combined_interface_counter_name
1363 #undef _
1364     clib_spinlock_unlock (&im->sw_if_counter_lock);
1365
1366   im->device_class_by_name = hash_create_string ( /* size */ 0,
1367                                                  sizeof (uword));
1368   {
1369     vnet_device_class_t *c;
1370
1371     c = vnm->device_class_registrations;
1372
1373     while (c)
1374       {
1375         c->index = vec_len (im->device_classes);
1376         hash_set_mem (im->device_class_by_name, c->name, c->index);
1377
1378         /* to avoid confusion, please remove ".tx_function" statement
1379           from VNET_DEVICE_CLASS() if using function candidates */
1380         ASSERT (c->tx_fn_registrations == 0 || c->tx_function == 0);
1381
1382         if (c->tx_fn_registrations)
1383           c->tx_function = vlib_node_get_preferred_node_fn_variant (
1384             vm, c->tx_fn_registrations);
1385
1386         vec_add1 (im->device_classes, c[0]);
1387         c = c->next_class_registration;
1388       }
1389   }
1390
1391   im->hw_interface_class_by_name = hash_create_string ( /* size */ 0,
1392                                                        sizeof (uword));
1393
1394   im->rxq_index_by_hw_if_index_and_queue_id =
1395     hash_create_mem (0, sizeof (u64), sizeof (u32));
1396   im->sw_if_index_by_sup_and_sub = hash_create_mem (0, sizeof (u64),
1397                                                     sizeof (uword));
1398   {
1399     vnet_hw_interface_class_t *c;
1400
1401     c = vnm->hw_interface_class_registrations;
1402
1403     while (c)
1404       {
1405         c->index = vec_len (im->hw_interface_classes);
1406         hash_set_mem (im->hw_interface_class_by_name, c->name, c->index);
1407
1408         if (NULL == c->build_rewrite)
1409           c->build_rewrite = default_build_rewrite;
1410         if (NULL == c->update_adjacency)
1411           c->update_adjacency = default_update_adjacency;
1412
1413         vec_add1 (im->hw_interface_classes, c[0]);
1414         c = c->next_class_registration;
1415       }
1416   }
1417
1418   /* init per-thread data */
1419   vec_validate_aligned (im->per_thread_data, vlib_num_workers (),
1420                         CLIB_CACHE_LINE_BYTES);
1421
1422   if ((error = vlib_call_init_function (vm, vnet_interface_cli_init)))
1423     return error;
1424
1425   vnm->interface_tag_by_sw_if_index = hash_create (0, sizeof (uword));
1426
1427 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
1428   if ((error = vlib_call_init_function (vm, trajectory_trace_init)))
1429     return error;
1430 #endif
1431
1432   return 0;
1433 }
1434
1435 VLIB_INIT_FUNCTION (vnet_interface_init);
1436
1437 /* Kludge to renumber interface names [only!] */
1438 int
1439 vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance)
1440 {
1441   int rv;
1442   vnet_main_t *vnm = vnet_get_main ();
1443   vnet_interface_main_t *im = &vnm->interface_main;
1444   vnet_hw_interface_t *hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
1445
1446   vnet_device_class_t *dev_class = vnet_get_device_class
1447     (vnm, hi->dev_class_index);
1448
1449   if (dev_class->name_renumber == 0 || dev_class->format_device_name == 0)
1450     return VNET_API_ERROR_UNIMPLEMENTED;
1451
1452   rv = dev_class->name_renumber (hi, new_show_dev_instance);
1453
1454   if (rv)
1455     return rv;
1456
1457   hash_unset_mem (im->hw_interface_by_name, hi->name);
1458   vec_free (hi->name);
1459   /* Use the mapping we set up to call it Ishmael */
1460   hi->name = format (0, "%U", dev_class->format_device_name,
1461                      hi->dev_instance);
1462
1463   hash_set_mem (im->hw_interface_by_name, hi->name, hi->hw_if_index);
1464   return rv;
1465 }
1466
1467 clib_error_t *
1468 vnet_rename_interface (vnet_main_t * vnm, u32 hw_if_index, char *new_name)
1469 {
1470   vnet_interface_main_t *im = &vnm->interface_main;
1471   vlib_main_t *vm = vnm->vlib_main;
1472   vnet_hw_interface_t *hw;
1473   u8 *old_name;
1474   clib_error_t *error = 0;
1475
1476   hw = vnet_get_hw_interface (vnm, hw_if_index);
1477   if (!hw)
1478     {
1479       return clib_error_return (0,
1480                                 "unable to find hw interface for index %u",
1481                                 hw_if_index);
1482     }
1483
1484   old_name = hw->name;
1485
1486   /* set new hw->name */
1487   hw->name = format (0, "%s", new_name);
1488
1489   /* remove the old name to hw_if_index mapping and install the new one */
1490   hash_unset_mem (im->hw_interface_by_name, old_name);
1491   hash_set_mem (im->hw_interface_by_name, hw->name, hw_if_index);
1492
1493   /* rename tx/output nodes */
1494   vlib_node_rename (vm, hw->tx_node_index, "%v-tx", hw->name);
1495   vlib_node_rename (vm, hw->output_node_index, "%v-output", hw->name);
1496
1497   /* free the old name vector */
1498   vec_free (old_name);
1499
1500   return error;
1501 }
1502
1503 clib_error_t *
1504 vnet_hw_interface_add_del_mac_address (vnet_main_t * vnm,
1505                                        u32 hw_if_index,
1506                                        const u8 * mac_address, u8 is_add)
1507 {
1508   clib_error_t *error = 0;
1509   vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
1510
1511   vnet_device_class_t *dev_class =
1512     vnet_get_device_class (vnm, hi->dev_class_index);
1513
1514   if (!hi->hw_address)
1515     {
1516       error =
1517         clib_error_return
1518         (0, "Secondary MAC Addresses not supported for interface index %u",
1519          hw_if_index);
1520       goto done;
1521     }
1522
1523   if (dev_class->mac_addr_add_del_function)
1524     error = dev_class->mac_addr_add_del_function (hi, mac_address, is_add);
1525
1526   if (!error)
1527     {
1528       vnet_hw_interface_class_t *hw_class;
1529
1530       hw_class = vnet_get_hw_interface_class (vnm, hi->hw_class_index);
1531
1532       if (NULL != hw_class->mac_addr_add_del_function)
1533         error = hw_class->mac_addr_add_del_function (hi, mac_address, is_add);
1534     }
1535
1536   /* If no errors, add to the list of secondary MACs on the ethernet intf */
1537   if (!error)
1538     ethernet_interface_add_del_address (&ethernet_main, hw_if_index,
1539                                         mac_address, is_add);
1540
1541 done:
1542   if (error)
1543     log_err ("hw_add_del_mac_address: %U", format_clib_error, error);
1544   return error;
1545 }
1546
1547 static clib_error_t *
1548 vnet_hw_interface_change_mac_address_helper (vnet_main_t * vnm,
1549                                              u32 hw_if_index,
1550                                              const u8 * mac_address)
1551 {
1552   clib_error_t *error = 0;
1553   vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
1554
1555   if (hi->hw_address)
1556     {
1557       u8 *old_address = vec_dup (hi->hw_address);
1558       vnet_device_class_t *dev_class =
1559         vnet_get_device_class (vnm, hi->dev_class_index);
1560       if (dev_class->mac_addr_change_function)
1561         {
1562           error =
1563             dev_class->mac_addr_change_function (hi, old_address,
1564                                                  mac_address);
1565         }
1566       if (!error)
1567         {
1568           vnet_hw_interface_class_t *hw_class;
1569
1570           hw_class = vnet_get_hw_interface_class (vnm, hi->hw_class_index);
1571
1572           if (NULL != hw_class->mac_addr_change_function)
1573             hw_class->mac_addr_change_function (hi, old_address, mac_address);
1574         }
1575       else
1576         {
1577           error =
1578             clib_error_return (0,
1579                                "MAC Address Change is not supported on this interface");
1580         }
1581       vec_free (old_address);
1582     }
1583   else
1584     {
1585       error =
1586         clib_error_return (0,
1587                            "mac address change is not supported for interface index %u",
1588                            hw_if_index);
1589     }
1590   return error;
1591 }
1592
1593 clib_error_t *
1594 vnet_hw_interface_change_mac_address (vnet_main_t * vnm, u32 hw_if_index,
1595                                       const u8 * mac_address)
1596 {
1597   return vnet_hw_interface_change_mac_address_helper
1598     (vnm, hw_if_index, mac_address);
1599 }
1600
1601 /* update the unnumbered state of an interface*/
1602 void
1603 vnet_sw_interface_update_unnumbered (u32 unnumbered_sw_if_index,
1604                                      u32 ip_sw_if_index, u8 enable)
1605 {
1606   vnet_main_t *vnm = vnet_get_main ();
1607   vnet_sw_interface_t *si;
1608   u32 was_unnum;
1609
1610   si = vnet_get_sw_interface (vnm, unnumbered_sw_if_index);
1611   was_unnum = (si->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED);
1612
1613   if (enable)
1614     {
1615       si->flags |= VNET_SW_INTERFACE_FLAG_UNNUMBERED;
1616       si->unnumbered_sw_if_index = ip_sw_if_index;
1617
1618       ip4_main.lookup_main.if_address_pool_index_by_sw_if_index
1619         [unnumbered_sw_if_index] =
1620         ip4_main.
1621         lookup_main.if_address_pool_index_by_sw_if_index[ip_sw_if_index];
1622       ip6_main.
1623         lookup_main.if_address_pool_index_by_sw_if_index
1624         [unnumbered_sw_if_index] =
1625         ip6_main.
1626         lookup_main.if_address_pool_index_by_sw_if_index[ip_sw_if_index];
1627     }
1628   else
1629     {
1630       si->flags &= ~(VNET_SW_INTERFACE_FLAG_UNNUMBERED);
1631       si->unnumbered_sw_if_index = (u32) ~ 0;
1632
1633       ip4_main.lookup_main.if_address_pool_index_by_sw_if_index
1634         [unnumbered_sw_if_index] = ~0;
1635       ip6_main.lookup_main.if_address_pool_index_by_sw_if_index
1636         [unnumbered_sw_if_index] = ~0;
1637     }
1638
1639   if (was_unnum != (si->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED))
1640     {
1641       ip4_sw_interface_enable_disable (unnumbered_sw_if_index, enable);
1642       ip6_sw_interface_enable_disable (unnumbered_sw_if_index, enable);
1643     }
1644 }
1645
1646 vnet_l3_packet_type_t
1647 vnet_link_to_l3_proto (vnet_link_t link)
1648 {
1649   switch (link)
1650     {
1651     case VNET_LINK_IP4:
1652       return (VNET_L3_PACKET_TYPE_IP4);
1653     case VNET_LINK_IP6:
1654       return (VNET_L3_PACKET_TYPE_IP6);
1655     case VNET_LINK_MPLS:
1656       return (VNET_L3_PACKET_TYPE_MPLS);
1657     case VNET_LINK_ARP:
1658       return (VNET_L3_PACKET_TYPE_ARP);
1659     case VNET_LINK_ETHERNET:
1660     case VNET_LINK_NSH:
1661       ASSERT (0);
1662       break;
1663     }
1664   ASSERT (0);
1665   return (0);
1666 }
1667
1668 vnet_mtu_t
1669 vnet_link_to_mtu (vnet_link_t link)
1670 {
1671   switch (link)
1672     {
1673     case VNET_LINK_IP4:
1674       return (VNET_MTU_IP4);
1675     case VNET_LINK_IP6:
1676       return (VNET_MTU_IP6);
1677     case VNET_LINK_MPLS:
1678       return (VNET_MTU_MPLS);
1679     default:
1680       return (VNET_MTU_L3);
1681     }
1682 }
1683
1684 u8 *
1685 default_build_rewrite (vnet_main_t * vnm,
1686                        u32 sw_if_index,
1687                        vnet_link_t link_type, const void *dst_address)
1688 {
1689   return (NULL);
1690 }
1691
1692 void
1693 default_update_adjacency (vnet_main_t * vnm, u32 sw_if_index, u32 ai)
1694 {
1695   ip_adjacency_t *adj;
1696
1697   adj = adj_get (ai);
1698
1699   switch (adj->lookup_next_index)
1700     {
1701     case IP_LOOKUP_NEXT_GLEAN:
1702       adj_glean_update_rewrite (ai);
1703       break;
1704     case IP_LOOKUP_NEXT_ARP:
1705     case IP_LOOKUP_NEXT_BCAST:
1706       /*
1707        * default rewrite in neighbour adj
1708        */
1709       adj_nbr_update_rewrite
1710         (ai,
1711          ADJ_NBR_REWRITE_FLAG_COMPLETE,
1712          vnet_build_rewrite_for_sw_interface (vnm,
1713                                               sw_if_index,
1714                                               adj_get_link_type (ai), NULL));
1715       break;
1716     case IP_LOOKUP_NEXT_MCAST:
1717       /*
1718        * mcast traffic also uses default rewrite string with no mcast
1719        * switch time updates.
1720        */
1721       adj_mcast_update_rewrite
1722         (ai,
1723          vnet_build_rewrite_for_sw_interface (vnm,
1724                                               sw_if_index,
1725                                               adj_get_link_type (ai),
1726                                               NULL), 0);
1727       break;
1728     case IP_LOOKUP_NEXT_DROP:
1729     case IP_LOOKUP_NEXT_PUNT:
1730     case IP_LOOKUP_NEXT_LOCAL:
1731     case IP_LOOKUP_NEXT_REWRITE:
1732     case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
1733     case IP_LOOKUP_NEXT_MIDCHAIN:
1734     case IP_LOOKUP_NEXT_ICMP_ERROR:
1735     case IP_LOOKUP_N_NEXT:
1736       ASSERT (0);
1737       break;
1738     }
1739 }
1740
1741 clib_error_t *
1742 vnet_hw_interface_set_rss_queues (vnet_main_t * vnm,
1743                                   vnet_hw_interface_t * hi,
1744                                   clib_bitmap_t * bitmap)
1745 {
1746   clib_error_t *error = 0;
1747   vnet_device_class_t *dev_class =
1748     vnet_get_device_class (vnm, hi->dev_class_index);
1749
1750   if (dev_class->set_rss_queues_function)
1751     {
1752       if (clib_bitmap_count_set_bits (bitmap) == 0)
1753         {
1754           error = clib_error_return (0,
1755                                      "must assign at least one valid rss queue");
1756           goto done;
1757         }
1758
1759       error = dev_class->set_rss_queues_function (vnm, hi, bitmap);
1760     }
1761   else
1762     {
1763       error = clib_error_return (0,
1764                                  "setting rss queues is not supported on this interface");
1765     }
1766
1767   if (!error)
1768     {
1769       clib_bitmap_free (hi->rss_queues);
1770       hi->rss_queues = clib_bitmap_dup (bitmap);
1771     }
1772
1773 done:
1774   if (error)
1775     log_err ("hw_set_rss_queues: %U", format_clib_error, error);
1776   return error;
1777 }
1778
1779 int collect_detailed_interface_stats_flag = 0;
1780
1781 void
1782 collect_detailed_interface_stats_flag_set (void)
1783 {
1784   collect_detailed_interface_stats_flag = 1;
1785 }
1786
1787 void
1788 collect_detailed_interface_stats_flag_clear (void)
1789 {
1790   collect_detailed_interface_stats_flag = 0;
1791 }
1792
1793 static clib_error_t *
1794 collect_detailed_interface_stats_cli (vlib_main_t * vm,
1795                                       unformat_input_t * input,
1796                                       vlib_cli_command_t * cmd)
1797 {
1798   unformat_input_t _line_input, *line_input = &_line_input;
1799   clib_error_t *error = NULL;
1800
1801   /* Get a line of input. */
1802   if (!unformat_user (input, unformat_line_input, line_input))
1803     return clib_error_return (0, "expected enable | disable");
1804
1805   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1806     {
1807       if (unformat (line_input, "enable") || unformat (line_input, "on"))
1808         collect_detailed_interface_stats_flag_set ();
1809       else if (unformat (line_input, "disable")
1810                || unformat (line_input, "off"))
1811         collect_detailed_interface_stats_flag_clear ();
1812       else
1813         {
1814           error = clib_error_return (0, "unknown input `%U'",
1815                                      format_unformat_error, line_input);
1816           goto done;
1817         }
1818     }
1819
1820 done:
1821   unformat_free (line_input);
1822   return error;
1823 }
1824
1825 /* *INDENT-OFF* */
1826 VLIB_CLI_COMMAND (collect_detailed_interface_stats_command, static) = {
1827   .path = "interface collect detailed-stats",
1828   .short_help = "interface collect detailed-stats <enable|disable>",
1829   .function = collect_detailed_interface_stats_cli,
1830 };
1831 /* *INDENT-ON* */
1832
1833 /*
1834  * fd.io coding-style-patch-verification: ON
1835  *
1836  * Local Variables:
1837  * eval: (c-set-style "gnu")
1838  * End:
1839  */