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