vlib: refactor checksum offload support
[vpp.git] / src / 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 #include <vppinfra/bitmap.h>
42 #include <vnet/l2/l2_input.h>
43 #include <vnet/l2/l2_output.h>
44 #include <vnet/l2/l2_vtr.h>
45 #include <vnet/interface/rx_queue_funcs.h>
46
47 u8 *
48 format_vtr (u8 * s, va_list * args)
49 {
50   u32 vtr_op = va_arg (*args, u32);
51   u32 dot1q = va_arg (*args, u32);
52   u32 tag1 = va_arg (*args, u32);
53   u32 tag2 = va_arg (*args, u32);
54   switch (vtr_op)
55     {
56     case L2_VTR_DISABLED:
57       return format (s, "none");
58     case L2_VTR_PUSH_1:
59       return format (s, "push-1 %s %d", dot1q ? "dot1q" : "dot1ad", tag1);
60     case L2_VTR_PUSH_2:
61       return format (s, "push-2 %s %d %d", dot1q ? "dot1q" : "dot1ad", tag1,
62                      tag2);
63     case L2_VTR_POP_1:
64       return format (s, "pop-1");
65     case L2_VTR_POP_2:
66       return format (s, "pop-2");
67     case L2_VTR_TRANSLATE_1_1:
68       return format (s, "trans-1-1 %s %d", dot1q ? "dot1q" : "dot1ad", tag1);
69     case L2_VTR_TRANSLATE_1_2:
70       return format (s, "trans-1-2 %s %d %d", dot1q ? "dot1q" : "dot1ad",
71                      tag1, tag2);
72     case L2_VTR_TRANSLATE_2_1:
73       return format (s, "trans-2-1 %s %d", dot1q ? "dot1q" : "dot1ad", tag1);
74     case L2_VTR_TRANSLATE_2_2:
75       return format (s, "trans-2-2 %s %d %d", dot1q ? "dot1q" : "dot1ad",
76                      tag1, tag2);
77     default:
78       return format (s, "none");
79     }
80 }
81
82 u8 *
83 format_vnet_sw_interface_flags (u8 * s, va_list * args)
84 {
85   u32 flags = va_arg (*args, u32);
86
87   if (flags & VNET_SW_INTERFACE_FLAG_ERROR)
88     s = format (s, "error");
89   else
90     {
91       s = format (s, "%s",
92                   (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ? "up" : "down");
93       if (flags & VNET_SW_INTERFACE_FLAG_PUNT)
94         s = format (s, "/punt");
95     }
96
97   return s;
98 }
99
100 u8 *
101 format_vnet_hw_if_rx_mode (u8 * s, va_list * args)
102 {
103   vnet_hw_if_rx_mode mode = va_arg (*args, vnet_hw_if_rx_mode);
104
105   if (mode == VNET_HW_IF_RX_MODE_POLLING)
106     return format (s, "polling");
107
108   if (mode == VNET_HW_IF_RX_MODE_INTERRUPT)
109     return format (s, "interrupt");
110
111   if (mode == VNET_HW_IF_RX_MODE_ADAPTIVE)
112     return format (s, "adaptive");
113
114   return format (s, "unknown");
115 }
116
117 u8 *
118 format_vnet_hw_interface_link_speed (u8 * s, va_list * args)
119 {
120   u32 link_speed = va_arg (*args, u32);
121
122   if (link_speed == 0)
123     return format (s, "unknown");
124
125   if (link_speed >= 1000000)
126     return format (s, "%f Gbps", (f64) link_speed / 1000000);
127
128   if (link_speed >= 1000)
129     return format (s, "%f Mbps", (f64) link_speed / 1000);
130
131   return format (s, "%u Kbps", link_speed);
132 }
133
134 u8 *
135 format_vnet_hw_interface_rss_queues (u8 * s, va_list * args)
136 {
137   clib_bitmap_t *bitmap = va_arg (*args, clib_bitmap_t *);
138   int i;
139
140   if (bitmap == NULL)
141     return s;
142
143   if (bitmap)
144     {
145     /* *INDENT-OFF* */
146     clib_bitmap_foreach (i, bitmap)  {
147       s = format (s, "%u ", i);
148     }
149     /* *INDENT-ON* */
150     }
151
152   return s;
153 }
154
155 u8 *
156 format_vnet_hw_interface (u8 * s, va_list * args)
157 {
158   vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
159   vnet_hw_interface_t *hi = va_arg (*args, vnet_hw_interface_t *);
160   vnet_hw_interface_class_t *hw_class;
161   vnet_device_class_t *dev_class;
162   int verbose = va_arg (*args, int);
163   u32 indent;
164
165   if (!hi)
166     return format (s, "%=32s%=6s%=8s%s", "Name", "Idx", "Link", "Hardware");
167
168   indent = format_get_indent (s);
169
170   s = format (s, "%-32v%=6d", hi->name, hi->hw_if_index);
171
172   if (hi->bond_info == VNET_HW_INTERFACE_BOND_INFO_SLAVE)
173     s = format (s, "%=8s", "slave");
174   else
175     s = format (s, "%=8s",
176                 hi->flags & VNET_HW_INTERFACE_FLAG_LINK_UP ? "up" : "down");
177
178   hw_class = vnet_get_hw_interface_class (vnm, hi->hw_class_index);
179   dev_class = vnet_get_device_class (vnm, hi->dev_class_index);
180
181   if (hi->bond_info && (hi->bond_info != VNET_HW_INTERFACE_BOND_INFO_SLAVE))
182     {
183       int hw_idx;
184       s = format (s, "Slave-Idx:");
185       clib_bitmap_foreach (hw_idx, hi->bond_info)
186         s = format (s, " %d", hw_idx);
187     }
188   else if (dev_class->format_device_name)
189     s = format (s, "%U", dev_class->format_device_name, hi->dev_instance);
190   else
191     s = format (s, "%s%d", dev_class->name, hi->dev_instance);
192
193   s = format (s, "\n%ULink speed: %U", format_white_space, indent + 2,
194               format_vnet_hw_interface_link_speed, hi->link_speed);
195
196   if (vec_len (hi->rx_queue_indices))
197     {
198       s = format (s, "\n%URX Queues:", format_white_space, indent + 2);
199       s = format (s, "\n%U%-6s%-15s%-10s", format_white_space, indent + 4,
200                   "queue", "thread", "mode");
201       for (int i = 0; i < vec_len (hi->rx_queue_indices); i++)
202         {
203           vnet_hw_if_rx_queue_t *rxq;
204           rxq = vnet_hw_if_get_rx_queue (vnm, hi->rx_queue_indices[i]);
205           s = format (s, "\n%U%-6u%-15U%-10U", format_white_space, indent + 4,
206                       rxq->queue_id, format_vlib_thread_name_and_index,
207                       rxq->thread_index, format_vnet_hw_if_rx_mode, rxq->mode);
208         }
209     }
210
211   if (hi->rss_queues)
212     {
213       s = format (s, "\n%URSS queues: %U", format_white_space, indent + 2,
214                   format_vnet_hw_interface_rss_queues, hi->rss_queues);
215     }
216
217   if (verbose)
218     {
219       if (hw_class->format_device)
220         s = format (s, "\n%U%U",
221                     format_white_space, indent + 2,
222                     hw_class->format_device, hi->hw_if_index, verbose);
223       else
224         {
225           s = format (s, "\n%U%s",
226                       format_white_space, indent + 2, hw_class->name);
227           if (hw_class->format_address && vec_len (hi->hw_address) > 0)
228             s =
229               format (s, " address %U", hw_class->format_address,
230                       hi->hw_address);
231         }
232
233       if (dev_class->format_device)
234         s = format (s, "\n%U%U",
235                     format_white_space, indent + 2,
236                     dev_class->format_device, hi->dev_instance, verbose);
237     }
238
239   return s;
240 }
241
242 u8 *
243 format_vnet_sw_interface_name (u8 * s, va_list * args)
244 {
245   vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
246   vnet_sw_interface_t *si = va_arg (*args, vnet_sw_interface_t *);
247   vnet_sw_interface_t *si_sup =
248     vnet_get_sup_sw_interface (vnm, si->sw_if_index);
249   vnet_hw_interface_t *hi_sup;
250
251   ASSERT (si_sup->type == VNET_SW_INTERFACE_TYPE_HARDWARE);
252   hi_sup = vnet_get_hw_interface (vnm, si_sup->hw_if_index);
253
254   s = format (s, "%v", hi_sup->name);
255
256   if (si->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
257     s = format (s, ".%d", si->sub.id);
258
259   return s;
260 }
261
262 u8 *
263 format_vnet_sw_if_index_name (u8 * s, va_list * args)
264 {
265   vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
266   u32 sw_if_index = va_arg (*args, u32);
267   vnet_sw_interface_t *si;
268
269   si = vnet_get_sw_interface_or_null (vnm, sw_if_index);
270
271   if (NULL == si)
272     {
273       return format (s, "DELETED");
274     }
275   return format (s, "%U", format_vnet_sw_interface_name, vnm, si);
276 }
277
278 u8 *
279 format_vnet_hw_if_index_name (u8 * s, va_list * args)
280 {
281   vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
282   u32 hw_if_index = va_arg (*args, u32);
283   vnet_hw_interface_t *hi;
284
285   hi = vnet_get_hw_interface (vnm, hw_if_index);
286
287   if (hi == 0)
288     return format (s, "DELETED");
289
290   return format (s, "%v", hi->name);
291 }
292
293 u8 *
294 format_vnet_sw_interface_cntrs (u8 * s, vnet_interface_main_t * im,
295                                 vnet_sw_interface_t * si, int json)
296 {
297   u32 indent, n_printed;
298   int j, n_counters;
299   char *x = "";
300   int json_need_comma_nl = 0;
301   u8 *n = 0;
302
303   /*
304    * to output a json snippet, stick quotes in lots of places
305    * definitely deserves a one-character variable name.
306    */
307   if (json)
308     x = "\"";
309
310   indent = format_get_indent (s);
311   n_printed = 0;
312
313   n_counters = vec_len (im->combined_sw_if_counters);
314
315   /* rx, tx counters... */
316   for (j = 0; j < n_counters; j++)
317     {
318       vlib_combined_counter_main_t *cm;
319       vlib_counter_t v, vtotal;
320       vtotal.packets = 0;
321       vtotal.bytes = 0;
322
323       cm = im->combined_sw_if_counters + j;
324       vlib_get_combined_counter (cm, si->sw_if_index, &v);
325       vtotal.packets += v.packets;
326       vtotal.bytes += v.bytes;
327
328       /* Only display non-zero counters. */
329       if (vtotal.packets == 0)
330         continue;
331
332       if (json)
333         {
334           if (json_need_comma_nl)
335             {
336               vec_add1 (s, ',');
337               vec_add1 (s, '\n');
338             }
339           s = format (s, "%s%s_packets%s: %s%Ld%s,\n", x, cm->name, x, x,
340                       vtotal.packets, x);
341           s = format (s, "%s%s_bytes%s: %s%Ld%s", x, cm->name, x, x,
342                       vtotal.bytes, x);
343           json_need_comma_nl = 1;
344           continue;
345         }
346
347       if (n_printed > 0)
348         s = format (s, "\n%U", format_white_space, indent);
349       n_printed += 2;
350
351       if (n)
352         _vec_len (n) = 0;
353       n = format (n, "%s packets", cm->name);
354       s = format (s, "%-16v%16Ld", n, vtotal.packets);
355
356       _vec_len (n) = 0;
357       n = format (n, "%s bytes", cm->name);
358       s = format (s, "\n%U%-16v%16Ld",
359                   format_white_space, indent, n, vtotal.bytes);
360     }
361   vec_free (n);
362
363   {
364     vlib_simple_counter_main_t *cm;
365     u64 v, vtotal;
366
367     n_counters = vec_len (im->sw_if_counters);
368
369     for (j = 0; j < n_counters; j++)
370       {
371         vtotal = 0;
372
373         cm = im->sw_if_counters + j;
374
375         v = vlib_get_simple_counter (cm, si->sw_if_index);
376         vtotal += v;
377
378         /* Only display non-zero counters. */
379         if (vtotal == 0)
380           continue;
381
382         if (json)
383           {
384             if (json_need_comma_nl)
385               {
386                 vec_add1 (s, ',');
387                 vec_add1 (s, '\n');
388               }
389             s = format (s, "%s%s%s: %s%Ld%s", x, cm->name, x, x, vtotal, x);
390             json_need_comma_nl = 1;
391             continue;
392           }
393
394
395         if (n_printed > 0)
396           s = format (s, "\n%U", format_white_space, indent);
397         n_printed += 1;
398
399         s = format (s, "%-16s%16Ld", cm->name, vtotal);
400       }
401   }
402
403   return s;
404 }
405
406 static u8 *
407 format_vnet_sw_interface_mtu (u8 * s, va_list * args)
408 {
409   vnet_sw_interface_t *si = va_arg (*args, vnet_sw_interface_t *);
410
411   return format (s, "%d/%d/%d/%d", si->mtu[VNET_MTU_L3],
412                  si->mtu[VNET_MTU_IP4],
413                  si->mtu[VNET_MTU_IP6], si->mtu[VNET_MTU_MPLS]);
414 }
415
416 u8 *
417 format_vnet_sw_interface (u8 * s, va_list * args)
418 {
419   vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
420   vnet_sw_interface_t *si = va_arg (*args, vnet_sw_interface_t *);
421   vnet_interface_main_t *im = &vnm->interface_main;
422
423   if (!si)
424     return format (s, "%=32s%=5s%=10s%=21s%=16s%=16s",
425                    "Name", "Idx", "State", "MTU (L3/IP4/IP6/MPLS)", "Counter",
426                    "Count");
427
428   s = format (s, "%-32U%=5d%=10U%=21U",
429               format_vnet_sw_interface_name, vnm, si, si->sw_if_index,
430               format_vnet_sw_interface_flags, si->flags,
431               format_vnet_sw_interface_mtu, si);
432
433   s = format_vnet_sw_interface_cntrs (s, im, si, 0 /* want json */ );
434
435   return s;
436 }
437
438 u8 *
439 format_vnet_sw_interface_name_override (u8 * s, va_list * args)
440 {
441   vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
442   vnet_sw_interface_t *si = va_arg (*args, vnet_sw_interface_t *);
443   /* caller supplied display name for this interface */
444   u8 *name = va_arg (*args, u8 *);
445   vnet_interface_main_t *im = &vnm->interface_main;
446
447
448   if (!si)
449     return format (s, "%=32s%=5s%=16s%=16s%=16s",
450                    "Name", "Idx", "State", "Counter", "Count");
451
452   s = format (s, "%-32v%=5d%=16U",
453               name, si->sw_if_index,
454               format_vnet_sw_interface_flags, si->flags);
455
456   s = format_vnet_sw_interface_cntrs (s, im, si, 0 /* want json */ );
457
458   return s;
459 }
460
461 u8 *
462 format_vnet_buffer_flags (u8 * s, va_list * args)
463 {
464   vlib_buffer_t *buf = va_arg (*args, vlib_buffer_t *);
465
466 #define _(a,b,c,v) if (buf->flags & VNET_BUFFER_F_##b) s = format (s, "%s ", c);
467   foreach_vnet_buffer_flag;
468 #undef _
469   return s;
470 }
471
472 u8 *
473 format_vnet_buffer_opaque (u8 * s, va_list * args)
474 {
475   vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
476   vnet_buffer_opaque_t *o = (vnet_buffer_opaque_t *) b->opaque;
477   vnet_interface_main_t *im = &vnet_get_main ()->interface_main;
478   vnet_buffer_opquae_formatter_t helper_fp;
479   int i;
480
481   s = format (s, "raw: ");
482
483   for (i = 0; i < ARRAY_LEN (b->opaque); i++)
484     s = format (s, "%08x ", b->opaque[i]);
485
486   vec_add1 (s, '\n');
487
488   s = format (s,
489               "sw_if_index[VLIB_RX]: %d, sw_if_index[VLIB_TX]: %d",
490               o->sw_if_index[0], o->sw_if_index[1]);
491   vec_add1 (s, '\n');
492
493   s = format (s,
494               "L2 offset %d, L3 offset %d, L4 offset %d, feature arc index %d",
495               (u32) (o->l2_hdr_offset),
496               (u32) (o->l3_hdr_offset),
497               (u32) (o->l4_hdr_offset), (u32) (o->feature_arc_index));
498   vec_add1 (s, '\n');
499
500   s = format (s,
501               "ip.adj_index[VLIB_RX]: %d, ip.adj_index[VLIB_TX]: %d",
502               (u32) (o->ip.adj_index[0]), (u32) (o->ip.adj_index[1]));
503   vec_add1 (s, '\n');
504
505   s = format (s,
506               "ip.flow_hash: 0x%x, ip.save_protocol: 0x%x, ip.fib_index: %d",
507               o->ip.flow_hash, o->ip.save_protocol, o->ip.fib_index);
508   vec_add1 (s, '\n');
509
510   s = format (s,
511               "ip.save_rewrite_length: %d, ip.rpf_id: %d",
512               o->ip.save_rewrite_length, o->ip.rpf_id);
513   vec_add1 (s, '\n');
514
515   s = format (s,
516               "ip.icmp.type: %d ip.icmp.code: %d, ip.icmp.data: 0x%x",
517               (u32) (o->ip.icmp.type),
518               (u32) (o->ip.icmp.code), o->ip.icmp.data);
519   vec_add1 (s, '\n');
520
521   s = format (s,
522               "ip.reass.next_index: %d, ip.reass.estimated_mtu: %d",
523               o->ip.reass.next_index, (u32) (o->ip.reass.estimated_mtu));
524   vec_add1 (s, '\n');
525   s = format (s,
526               "ip.reass.error_next_index: %d, ip.reass.owner_thread_index: %d",
527               o->ip.reass.error_next_index,
528               (u32) (o->ip.reass.owner_thread_index));
529   vec_add1 (s, '\n');
530   s = format (s,
531               "ip.reass.ip_proto: %d, ip.reass.l4_src_port: %d",
532               o->ip.reass.ip_proto, (u32) (o->ip.reass.l4_src_port));
533   vec_add1 (s, '\n');
534   s = format (s, "ip.reass.l4_dst_port: %d", o->ip.reass.l4_dst_port);
535   vec_add1 (s, '\n');
536
537   s = format (s,
538               "ip.reass.fragment_first: %d ip.reass.fragment_last: %d",
539               (u32) (o->ip.reass.fragment_first),
540               (u32) (o->ip.reass.fragment_last));
541   vec_add1 (s, '\n');
542
543   s = format (s,
544               "ip.reass.range_first: %d ip.reass.range_last: %d",
545               (u32) (o->ip.reass.range_first),
546               (u32) (o->ip.reass.range_last));
547   vec_add1 (s, '\n');
548
549   s = format (s,
550               "ip.reass.next_range_bi: 0x%x, ip.reass.ip6_frag_hdr_offset: %d",
551               o->ip.reass.next_range_bi,
552               (u32) (o->ip.reass.ip6_frag_hdr_offset));
553   vec_add1 (s, '\n');
554
555   s = format (s,
556               "mpls.ttl: %d, mpls.exp: %d, mpls.first: %d, "
557               "mpls.save_rewrite_length: %d, mpls.bier.n_bytes: %d",
558               (u32) (o->mpls.ttl), (u32) (o->mpls.exp), (u32) (o->mpls.first),
559               o->mpls.save_rewrite_length, (u32) (o->mpls.bier.n_bytes));
560   vec_add1 (s, '\n');
561   s = format (s, "mpls.mpls_hdr_length: %d", (u32) (o->mpls.mpls_hdr_length));
562   vec_add1 (s, '\n');
563
564   s = format (s,
565               "l2.feature_bitmap: %08x, l2.bd_index: %d, l2.l2fib_sn %d, "
566               "l2.l2_len: %d, l2.shg: %d, l2.bd_age: %d",
567               (u32) (o->l2.feature_bitmap), (u32) (o->l2.bd_index),
568               (u32) (o->l2.l2fib_sn),
569               (u32) (o->l2.l2_len), (u32) (o->l2.shg), (u32) (o->l2.bd_age));
570   vec_add1 (s, '\n');
571
572   s = format (s,
573               "l2.feature_bitmap_input: %U, L2.feature_bitmap_output: %U",
574               format_l2_input_feature_bitmap, o->l2.feature_bitmap, 0,
575               format_l2_output_features, o->l2.feature_bitmap, 0);
576   vec_add1 (s, '\n');
577
578   s = format (s,
579               "l2t.next_index: %d, l2t.session_index: %d",
580               (u32) (o->l2t.next_index), o->l2t.session_index);
581   vec_add1 (s, '\n');
582
583   s = format (s,
584               "l2_classify.table_index: %d, l2_classify.opaque_index: %d, "
585               "l2_classify.hash: 0x%llx",
586               o->l2_classify.table_index,
587               o->l2_classify.opaque_index, o->l2_classify.hash);
588   vec_add1 (s, '\n');
589
590   s = format (s, "policer.index: %d", o->policer.index);
591   vec_add1 (s, '\n');
592
593   s = format (s, "ipsec.sad_index: %d, ipsec.protect_index",
594               o->ipsec.sad_index, o->ipsec.protect_index);
595   vec_add1 (s, '\n');
596
597   s = format (s, "map.mtu: %d", (u32) (o->map.mtu));
598   vec_add1 (s, '\n');
599
600   s = format (s,
601               "map_t.map_domain_index: %d, map_t.v6.saddr: 0x%x, "
602               "map_t.v6.daddr: 0x%x, map_t.v6.frag_offset: %d, "
603               "map_t.v6.l4_offset: %d, map_t.v6.l4_protocol: %d, "
604               "map.t.checksum_offset: %d",
605               o->map_t.map_domain_index,
606               o->map_t.v6.saddr,
607               o->map_t.v6.daddr,
608               (u32) (o->map_t.v6.frag_offset), (u32) (o->map_t.v6.l4_offset),
609               (u32) (o->map_t.v6.l4_protocol),
610               (u32) (o->map_t.checksum_offset));
611   vec_add1 (s, '\n');
612
613   s = format (s,
614               "map_t.v6.l4_protocol: %d, map_t.checksum_offset: %d, "
615               "map_t.mtu: %d",
616               (u32) (o->map_t.v6.l4_protocol),
617               (u32) (o->map_t.checksum_offset), (u32) (o->map_t.mtu));
618   vec_add1 (s, '\n');
619
620   s = format (s,
621               "ip_frag.mtu: %d, ip_frag.next_index: %d, ip_frag.flags: 0x%x",
622               (u32) (o->ip_frag.mtu),
623               (u32) (o->ip_frag.next_index), (u32) (o->ip_frag.flags));
624   vec_add1 (s, '\n');
625
626   s = format (s, "cop.current_config_index: %d", o->cop.current_config_index);
627   vec_add1 (s, '\n');
628
629   s = format (s, "lisp.overlay_afi: %d", (u32) (o->lisp.overlay_afi));
630   vec_add1 (s, '\n');
631
632   s = format
633     (s,
634      "tcp.connection_index: %d, tcp.seq_number: %d, tcp.next_node_opaque: %d "
635      "tcp.seq_end: %d, tcp.ack_number: %d, tcp.hdr_offset: %d, "
636      "tcp.data_offset: %d", o->tcp.connection_index, o->tcp.next_node_opaque,
637      o->tcp.seq_number, o->tcp.seq_end, o->tcp.ack_number,
638      (u32) (o->tcp.hdr_offset), (u32) (o->tcp.data_offset));
639   vec_add1 (s, '\n');
640
641   s = format (s,
642               "tcp.data_len: %d, tcp.flags: 0x%x",
643               (u32) (o->tcp.data_len), (u32) (o->tcp.flags));
644   vec_add1 (s, '\n');
645
646   s = format (s, "snat.flags: 0x%x", o->snat.flags);
647   vec_add1 (s, '\n');
648
649   for (i = 0; i < vec_len (im->buffer_opaque_format_helpers); i++)
650     {
651       helper_fp = im->buffer_opaque_format_helpers[i];
652       s = (*helper_fp) (b, s);
653     }
654
655   return s;
656 }
657
658 u8 *
659 format_vnet_buffer_opaque2 (u8 * s, va_list * args)
660 {
661   vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
662   vnet_buffer_opaque2_t *o = (vnet_buffer_opaque2_t *) b->opaque2;
663   vnet_interface_main_t *im = &vnet_get_main ()->interface_main;
664   vnet_buffer_opquae_formatter_t helper_fp;
665
666   int i;
667
668   s = format (s, "raw: ");
669
670   for (i = 0; i < ARRAY_LEN (b->opaque2); i++)
671     s = format (s, "%08x ", b->opaque2[i]);
672   vec_add1 (s, '\n');
673
674   s = format (s, "qos.bits: %x, qos.source: %x",
675               (u32) (o->qos.bits), (u32) (o->qos.source));
676   vec_add1 (s, '\n');
677   s = format (s, "loop_counter: %d", o->loop_counter);
678   vec_add1 (s, '\n');
679
680   s = format (s, "gbp.flags: %x, gbp.sclass: %d",
681               (u32) (o->gbp.flags), (u32) (o->gbp.sclass));
682   vec_add1 (s, '\n');
683
684   s = format (s, "gso_size: %d, gso_l4_hdr_sz: %d",
685               (u32) (o->gso_size), (u32) (o->gso_l4_hdr_sz));
686   vec_add1 (s, '\n');
687
688   s = format (s, "pg_replay_timestamp: %llu", (u32) (o->pg_replay_timestamp));
689   vec_add1 (s, '\n');
690
691   for (i = 0; i < vec_len (im->buffer_opaque2_format_helpers); i++)
692     {
693       helper_fp = im->buffer_opaque2_format_helpers[i];
694       s = (*helper_fp) (b, s);
695     }
696
697   return s;
698 }
699
700 void
701 vnet_register_format_buffer_opaque_helper (vnet_buffer_opquae_formatter_t fp)
702 {
703   vnet_interface_main_t *im = &vnet_get_main ()->interface_main;
704   vec_add1 (im->buffer_opaque_format_helpers, fp);
705 }
706
707 void
708 vnet_register_format_buffer_opaque2_helper (vnet_buffer_opquae_formatter_t fp)
709 {
710   vnet_interface_main_t *im = &vnet_get_main ()->interface_main;
711   vec_add1 (im->buffer_opaque2_format_helpers, fp);
712 }
713
714
715 uword
716 unformat_vnet_buffer_flags (unformat_input_t * input, va_list * args)
717 {
718   u32 *flagp = va_arg (*args, u32 *);
719   int rv = 0;
720   u32 flags = 0;
721
722   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
723     {
724       /* Red herring, there is no such buffer flag */
725       if (unformat (input, "avail10"))
726         return 0;
727 #define _(bit,enum,str,verbose)                                 \
728       else if (unformat (input, str))                           \
729         {                                                       \
730           flags |= (1 << LOG2_VLIB_BUFFER_FLAG_USER(bit));      \
731           rv = 1;                                               \
732         }
733       foreach_vnet_buffer_flag
734 #undef _
735         else
736         break;
737     }
738   if (rv)
739     *flagp = flags;
740   return rv;
741 }
742
743 uword
744 unformat_vnet_buffer_offload_flags (unformat_input_t *input, va_list *args)
745 {
746   u32 *flagp = va_arg (*args, u32 *);
747   int rv = 0;
748   u32 oflags = 0;
749
750   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
751     {
752       if (0)
753         ;
754 #define _(bit, enum, str, verbose)                                            \
755   else if (unformat (input, str))                                             \
756   {                                                                           \
757     oflags |= (1 << bit);                                                     \
758     rv = 1;                                                                   \
759   }
760       foreach_vnet_buffer_offload_flag
761 #undef _
762         else break;
763     }
764   if (rv)
765     *flagp = oflags;
766   return rv;
767 }
768
769 uword
770 unformat_vnet_hw_interface (unformat_input_t * input, va_list * args)
771 {
772   vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
773   u32 *hw_if_index = va_arg (*args, u32 *);
774   vnet_interface_main_t *im = &vnm->interface_main;
775   vnet_device_class_t *c;
776
777   /* Try per device class functions first. */
778   vec_foreach (c, im->device_classes)
779   {
780     if (c->unformat_device_name
781         && unformat_user (input, c->unformat_device_name, hw_if_index))
782       return 1;
783   }
784
785   return unformat_user (input, unformat_hash_vec_string,
786                         im->hw_interface_by_name, hw_if_index);
787 }
788
789 uword
790 unformat_vnet_sw_interface (unformat_input_t * input, va_list * args)
791 {
792   vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
793   u32 *result = va_arg (*args, u32 *);
794   vnet_hw_interface_t *hi;
795   u32 hw_if_index, id, id_specified;
796   u32 sw_if_index;
797   u8 *if_name = 0;
798   uword *p, error = 0;
799
800   id = ~0;
801   if (unformat (input, "%_%v.%d%_", &if_name, &id)
802       && ((p = hash_get (vnm->interface_main.hw_interface_by_name, if_name))))
803     {
804       hw_if_index = p[0];
805       id_specified = 1;
806     }
807   else
808     if (unformat (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
809     id_specified = 0;
810   else
811     goto done;
812
813   hi = vnet_get_hw_interface (vnm, hw_if_index);
814   if (!id_specified)
815     {
816       sw_if_index = hi->sw_if_index;
817     }
818   else
819     {
820       if (!(p = hash_get (hi->sub_interface_sw_if_index_by_id, id)))
821         goto done;
822       sw_if_index = p[0];
823     }
824   if (!vnet_sw_interface_is_api_visible (vnm, sw_if_index))
825     goto done;
826   *result = sw_if_index;
827   error = 1;
828 done:
829   vec_free (if_name);
830   return error;
831 }
832
833 uword
834 unformat_vnet_sw_interface_flags (unformat_input_t * input, va_list * args)
835 {
836   u32 *result = va_arg (*args, u32 *);
837   u32 flags = 0;
838
839   if (unformat (input, "up"))
840     flags |= VNET_SW_INTERFACE_FLAG_ADMIN_UP;
841   else if (unformat (input, "down"))
842     flags &= ~VNET_SW_INTERFACE_FLAG_ADMIN_UP;
843   else if (unformat (input, "punt"))
844     flags |= VNET_SW_INTERFACE_FLAG_PUNT;
845   else if (unformat (input, "enable"))
846     flags &= ~VNET_SW_INTERFACE_FLAG_PUNT;
847   else
848     return 0;
849
850   *result = flags;
851   return 1;
852 }
853
854 uword
855 unformat_vnet_hw_interface_flags (unformat_input_t * input, va_list * args)
856 {
857   u32 *result = va_arg (*args, u32 *);
858   u32 flags = 0;
859
860   if (unformat (input, "up"))
861     flags |= VNET_HW_INTERFACE_FLAG_LINK_UP;
862   else if (unformat (input, "down"))
863     flags &= ~VNET_HW_INTERFACE_FLAG_LINK_UP;
864   else
865     return 0;
866
867   *result = flags;
868   return 1;
869 }
870
871 /*
872  * fd.io coding-style-patch-verification: ON
873  *
874  * Local Variables:
875  * eval: (c-set-style "gnu")
876  * End:
877  */