Add ability to override the interface name.
[vpp.git] / vnet / vnet / interface_format.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_format.c: interface formatting
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
42 u8 * format_vnet_sw_interface_flags (u8 * s, va_list * args)
43 {
44   u32 flags = va_arg (*args, u32);
45
46   s = format (s, "%s", (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ? "up" : "down");
47   if (flags & VNET_SW_INTERFACE_FLAG_PUNT)
48     s = format (s, "/punt");
49
50   return s;
51 }
52
53 u8 * format_vnet_hw_interface (u8 * s, va_list * args)
54 {
55   vnet_main_t * vnm = va_arg (*args, vnet_main_t *);
56   vnet_hw_interface_t * hi = va_arg (*args, vnet_hw_interface_t *);
57   vnet_hw_interface_class_t * hw_class;
58   vnet_device_class_t * dev_class;
59   int verbose = va_arg (*args, int);
60   uword indent;
61
62   if (! hi)
63     return format (s, "%=32s%=6s%=8s%s",
64                    "Name", "Idx", "Link", "Hardware");
65
66   indent = format_get_indent (s);
67
68   s = format (s, "%-32v%=6d%=8s",
69               hi->name, hi->hw_if_index,
70               hi->flags & VNET_HW_INTERFACE_FLAG_LINK_UP ? "up" : "down");
71
72   hw_class = vnet_get_hw_interface_class (vnm, hi->hw_class_index);
73   dev_class = vnet_get_device_class (vnm, hi->dev_class_index);
74
75   if (dev_class->format_device_name)  
76     s = format (s, "%U", dev_class->format_device_name, hi->dev_instance);
77   else
78     s = format (s, "%s%d", dev_class->name, hi->dev_instance);
79
80   if (verbose)
81     {
82       if (hw_class->format_device)
83         s = format (s, "\n%U%U",
84                     format_white_space, indent + 2,
85                     hw_class->format_device, hi->hw_if_index, verbose);
86       else
87         {
88           s = format (s, "\n%U%s",
89                       format_white_space, indent + 2,
90                       hw_class->name);
91           if (hw_class->format_address && vec_len (hi->hw_address) > 0)
92             s = format (s, " address %U", hw_class->format_address, hi->hw_address);
93         }
94
95       if (dev_class->format_device)
96         s = format (s, "\n%U%U",
97                     format_white_space, indent + 2,
98                     dev_class->format_device, hi->dev_instance, verbose);
99     }
100
101   return s;
102 }
103
104 u8 * format_vnet_sw_interface_name (u8 * s, va_list * args)
105 {
106   vnet_main_t * vnm = va_arg (*args, vnet_main_t *);
107   vnet_sw_interface_t * si = va_arg (*args, vnet_sw_interface_t *);
108   vnet_sw_interface_t * si_sup = vnet_get_sup_sw_interface (vnm, si->sw_if_index);
109   vnet_hw_interface_t * hi_sup;
110
111   ASSERT (si_sup->type == VNET_SW_INTERFACE_TYPE_HARDWARE);
112   hi_sup = vnet_get_hw_interface (vnm, si_sup->hw_if_index);
113
114   s = format (s, "%v", hi_sup->name);
115
116   if (si->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
117     s = format (s, ".%d", si->sub.id);
118
119   return s;
120 }
121
122 u8 * format_vnet_sw_if_index_name (u8 * s, va_list * args)
123 {
124   vnet_main_t * vnm = va_arg (*args, vnet_main_t *);
125   u32 sw_if_index = va_arg (*args, u32);
126   return format (s, "%U",
127                  format_vnet_sw_interface_name, vnm,
128                  vnet_get_sw_interface (vnm, sw_if_index));
129 }
130
131 u8 * format_vnet_sw_interface_cntrs (u8 * s, vnet_interface_main_t * im,
132                                      vnet_sw_interface_t * si)
133 {
134   uword indent, n_printed;
135   int i, j, n_counters;
136   static vnet_main_t ** my_vnet_mains;
137
138   vec_reset_length (my_vnet_mains);
139
140   indent = format_get_indent (s);
141   n_printed = 0;
142
143   {
144     vlib_combined_counter_main_t * cm;
145     vlib_counter_t v, vtotal;
146     u8 * n = 0;
147
148     for (i = 0; i < vec_len (vnet_mains); i++)
149       {
150         if (vnet_mains[i])
151           vec_add1 (my_vnet_mains, vnet_mains[i]);
152       }
153
154     if (vec_len(my_vnet_mains) == 0)
155         vec_add1 (my_vnet_mains, &vnet_main);
156
157     /* Each vnet_main_t has its own copy of the interface counters */
158     n_counters = vec_len (im->combined_sw_if_counters);
159
160     /* rx, tx counters... */
161     for (j = 0; j < n_counters; j++)
162       {
163         vtotal.packets = 0;
164         vtotal.bytes = 0;
165
166         for (i = 0; i < vec_len(my_vnet_mains); i++)
167           {
168             im = &my_vnet_mains[i]->interface_main;
169             cm = im->combined_sw_if_counters + j;
170             vlib_get_combined_counter (cm, si->sw_if_index, &v);
171             vtotal.packets += v.packets;
172             vtotal.bytes += v.bytes;
173           }
174
175         /* Only display non-zero counters. */
176         if (vtotal.packets == 0)
177           continue;
178
179         if (n_printed > 0)
180           s = format (s, "\n%U", format_white_space, indent);
181         n_printed += 2;
182
183         if (n)
184           _vec_len (n) = 0;
185         n = format (n, "%s packets", cm->name);
186         s = format (s, "%-16v%16Ld", n, vtotal.packets);
187
188         _vec_len (n) = 0;
189         n = format (n, "%s bytes", cm->name);
190         s = format (s, "\n%U%-16v%16Ld",
191                     format_white_space, indent,
192                     n, vtotal.bytes);
193       }
194     vec_free (n);
195   }
196
197   {
198     vlib_simple_counter_main_t * cm;
199     u64 v, vtotal ;
200
201     n_counters = vec_len (im->sw_if_counters);
202
203     for (j = 0; j < n_counters; j++)
204       {
205         vtotal = 0;
206
207         for (i = 0; i < vec_len(my_vnet_mains); i++)
208           {
209             im = &my_vnet_mains[i]->interface_main;
210             cm = im->sw_if_counters + j;
211
212             v = vlib_get_simple_counter (cm, si->sw_if_index);
213             vtotal += v;
214           }
215
216         /* Only display non-zero counters. */
217         if (vtotal == 0)
218           continue;
219
220         if (n_printed > 0)
221           s = format (s, "\n%U", format_white_space, indent);
222         n_printed += 1;
223
224         s = format (s, "%-16s%16Ld", cm->name, vtotal);
225       }
226   }
227
228   return s;
229 }
230
231 u8 * format_vnet_sw_interface (u8 * s, va_list * args)
232 {
233   vnet_main_t * vnm = va_arg (*args, vnet_main_t *);
234   vnet_sw_interface_t * si = va_arg (*args, vnet_sw_interface_t *);
235   vnet_interface_main_t * im = &vnm->interface_main;
236
237   if (! si)
238     return format (s, "%=32s%=5s%=16s%=16s%=16s",
239                    "Name", "Idx", "State", "Counter", "Count");
240
241   s = format (s, "%-32U%=5d%=16U",
242               format_vnet_sw_interface_name, vnm, si, si->sw_if_index,
243               format_vnet_sw_interface_flags, si->flags);
244
245   s = format_vnet_sw_interface_cntrs(s, im, si);
246
247   return s;
248 }
249
250 u8 * format_vnet_sw_interface_name_override (u8 * s, va_list * args)
251 {
252   vnet_main_t * vnm = va_arg (*args, vnet_main_t *);
253   vnet_sw_interface_t * si = va_arg (*args, vnet_sw_interface_t *);
254   /* caller supplied display name for this interface */
255   u8* name = va_arg (*args, u8*);
256   vnet_interface_main_t * im = &vnm->interface_main;
257
258
259   if (! si)
260     return format (s, "%=32s%=5s%=16s%=16s%=16s",
261                    "Name", "Idx", "State", "Counter", "Count");
262
263   s = format (s, "%-32v%=5d%=16U",
264               name, si->sw_if_index,
265               format_vnet_sw_interface_flags, si->flags);
266
267   s = format_vnet_sw_interface_cntrs(s, im, si);
268
269   return s;
270 }
271
272 uword unformat_vnet_hw_interface (unformat_input_t * input, va_list * args)
273 {
274   vnet_main_t * vnm = va_arg (*args, vnet_main_t *);
275   u32 * hw_if_index = va_arg (*args, u32 *);
276   vnet_interface_main_t * im = &vnm->interface_main;
277   vnet_device_class_t * c;
278
279   /* Try per device class functions first. */
280   vec_foreach (c, im->device_classes)
281     {
282       if (c->unformat_device_name
283           && unformat_user (input, c->unformat_device_name, hw_if_index))
284       return 1;
285     }
286
287   return unformat_user (input, unformat_hash_vec_string,
288                         im->hw_interface_by_name, hw_if_index);
289 }
290
291 uword unformat_vnet_sw_interface (unformat_input_t * input, va_list * args)
292 {
293   vnet_main_t * vnm = va_arg (*args, vnet_main_t *);
294   u32 * result = va_arg (*args, u32 *);
295   vnet_hw_interface_t * hi;
296   u32 hw_if_index, id, id_specified;
297   u8 * if_name = 0;
298   uword * p, error = 0;
299
300   id = ~0;
301   if (unformat (input, "%_%v.%d%_", &if_name, &id)
302       && ((p = hash_get (vnm->interface_main.hw_interface_by_name, if_name))))
303     {
304       hw_if_index = p[0];
305       id_specified = 1;
306     }
307   else if (unformat (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
308     id_specified = 0;
309   else
310     goto done;
311
312   hi = vnet_get_hw_interface (vnm, hw_if_index);
313   if (! id_specified)
314     {
315       *result = hi->sw_if_index;
316     }
317   else
318     {
319       if (! (p = hash_get (hi->sub_interface_sw_if_index_by_id, id)))
320         return 0;
321       *result = p[0];
322     }
323   error = 1;
324  done:
325   vec_free (if_name);
326   return error;
327 }
328
329 uword unformat_vnet_sw_interface_flags (unformat_input_t * input, va_list * args)
330 {
331   u32 * result = va_arg (*args, u32 *);
332   u32 flags = 0;
333
334   if (unformat (input, "up"))
335     flags |= VNET_SW_INTERFACE_FLAG_ADMIN_UP;
336   else if (unformat (input, "down"))
337     flags &= ~VNET_SW_INTERFACE_FLAG_ADMIN_UP;
338   else if (unformat (input, "punt"))
339     flags |= VNET_SW_INTERFACE_FLAG_PUNT;
340   else if (unformat (input, "enable"))
341     flags &= ~VNET_SW_INTERFACE_FLAG_PUNT;
342   else
343     return 0;
344
345   *result = flags;
346   return 1;
347 }
348
349 uword unformat_vnet_hw_interface_flags (unformat_input_t * input, va_list * args)
350 {
351   u32 * result = va_arg (*args, u32 *);
352   u32 flags = 0;
353
354   if (unformat (input, "up"))
355     flags |= VNET_HW_INTERFACE_FLAG_LINK_UP;
356   else if (unformat (input, "down"))
357     flags &= ~VNET_HW_INTERFACE_FLAG_LINK_UP;
358   else
359     return 0;
360
361   *result = flags;
362   return 1;
363 }
364