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