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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 * interface_format.c: interface formatting
18 * Copyright (c) 2008 Eliot Dresselhaus
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:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
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.
40 #include <vnet/vnet.h>
41 #include <vppinfra/bitmap.h>
42 #include <vnet/l2/l2_input.h>
43 #include <vnet/l2/l2_output.h>
46 format_vnet_sw_interface_flags (u8 * s, va_list * args)
48 u32 flags = va_arg (*args, u32);
50 if (flags & VNET_SW_INTERFACE_FLAG_ERROR)
51 s = format (s, "error");
52 else if (flags & VNET_SW_INTERFACE_FLAG_BOND_SLAVE)
53 s = format (s, "bond-slave");
57 (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ? "up" : "down");
58 if (flags & VNET_SW_INTERFACE_FLAG_PUNT)
59 s = format (s, "/punt");
66 format_vnet_hw_interface_rx_mode (u8 * s, va_list * args)
68 vnet_hw_interface_rx_mode mode = va_arg (*args, vnet_hw_interface_rx_mode);
70 if (mode == VNET_HW_INTERFACE_RX_MODE_POLLING)
71 return format (s, "polling");
73 if (mode == VNET_HW_INTERFACE_RX_MODE_INTERRUPT)
74 return format (s, "interrupt");
76 if (mode == VNET_HW_INTERFACE_RX_MODE_ADAPTIVE)
77 return format (s, "adaptive");
79 return format (s, "unknown");
83 format_vnet_hw_interface_link_speed (u8 * s, va_list * args)
85 u32 link_speed = va_arg (*args, u32);
88 return format (s, "unknown");
90 if (link_speed >= 1000000)
91 return format (s, "%f Gbps", (f64) link_speed / 1000000);
93 if (link_speed >= 1000)
94 return format (s, "%f Mbps", (f64) link_speed / 1000);
96 return format (s, "%u Kbps", link_speed);
101 format_vnet_hw_interface (u8 * s, va_list * args)
103 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
104 vnet_hw_interface_t *hi = va_arg (*args, vnet_hw_interface_t *);
105 vnet_hw_interface_class_t *hw_class;
106 vnet_device_class_t *dev_class;
107 int verbose = va_arg (*args, int);
111 return format (s, "%=32s%=6s%=8s%s", "Name", "Idx", "Link", "Hardware");
113 indent = format_get_indent (s);
115 s = format (s, "%-32v%=6d", hi->name, hi->hw_if_index);
117 if (hi->bond_info == VNET_HW_INTERFACE_BOND_INFO_SLAVE)
118 s = format (s, "%=8s", "slave");
120 s = format (s, "%=8s",
121 hi->flags & VNET_HW_INTERFACE_FLAG_LINK_UP ? "up" : "down");
123 hw_class = vnet_get_hw_interface_class (vnm, hi->hw_class_index);
124 dev_class = vnet_get_device_class (vnm, hi->dev_class_index);
126 if (hi->bond_info && (hi->bond_info != VNET_HW_INTERFACE_BOND_INFO_SLAVE))
129 s = format (s, "Slave-Idx:");
130 clib_bitmap_foreach (hw_idx, hi->bond_info, s =
131 format (s, " %d", hw_idx));
133 else if (dev_class->format_device_name)
134 s = format (s, "%U", dev_class->format_device_name, hi->dev_instance);
136 s = format (s, "%s%d", dev_class->name, hi->dev_instance);
138 s = format (s, "\n%ULink speed: %U", format_white_space, indent + 2,
139 format_vnet_hw_interface_link_speed, hi->link_speed);
143 if (hw_class->format_device)
144 s = format (s, "\n%U%U",
145 format_white_space, indent + 2,
146 hw_class->format_device, hi->hw_if_index, verbose);
149 s = format (s, "\n%U%s",
150 format_white_space, indent + 2, hw_class->name);
151 if (hw_class->format_address && vec_len (hi->hw_address) > 0)
153 format (s, " address %U", hw_class->format_address,
157 if (dev_class->format_device)
158 s = format (s, "\n%U%U",
159 format_white_space, indent + 2,
160 dev_class->format_device, hi->dev_instance, verbose);
167 format_vnet_sw_interface_name (u8 * s, va_list * args)
169 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
170 vnet_sw_interface_t *si = va_arg (*args, vnet_sw_interface_t *);
171 vnet_sw_interface_t *si_sup =
172 vnet_get_sup_sw_interface (vnm, si->sw_if_index);
173 vnet_hw_interface_t *hi_sup;
175 ASSERT (si_sup->type == VNET_SW_INTERFACE_TYPE_HARDWARE);
176 hi_sup = vnet_get_hw_interface (vnm, si_sup->hw_if_index);
178 s = format (s, "%v", hi_sup->name);
180 if (si->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
181 s = format (s, ".%d", si->sub.id);
187 format_vnet_sw_if_index_name (u8 * s, va_list * args)
189 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
190 u32 sw_if_index = va_arg (*args, u32);
191 vnet_sw_interface_t *si;
193 si = vnet_get_sw_interface_or_null (vnm, sw_if_index);
197 return format (s, "DELETED");
199 return format (s, "%U", format_vnet_sw_interface_name, vnm, si);
203 format_vnet_hw_if_index_name (u8 * s, va_list * args)
205 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
206 u32 hw_if_index = va_arg (*args, u32);
207 vnet_hw_interface_t *hi;
209 hi = vnet_get_hw_interface (vnm, hw_if_index);
212 return format (s, "DELETED");
214 return format (s, "%v", hi->name);
218 format_vnet_sw_interface_cntrs (u8 * s, vnet_interface_main_t * im,
219 vnet_sw_interface_t * si)
221 u32 indent, n_printed;
225 indent = format_get_indent (s);
228 n_counters = vec_len (im->combined_sw_if_counters);
230 /* rx, tx counters... */
231 for (j = 0; j < n_counters; j++)
233 vlib_combined_counter_main_t *cm;
234 vlib_counter_t v, vtotal;
238 cm = im->combined_sw_if_counters + j;
239 vlib_get_combined_counter (cm, si->sw_if_index, &v);
240 vtotal.packets += v.packets;
241 vtotal.bytes += v.bytes;
243 /* Only display non-zero counters. */
244 if (vtotal.packets == 0)
248 s = format (s, "\n%U", format_white_space, indent);
253 n = format (n, "%s packets", cm->name);
254 s = format (s, "%-16v%16Ld", n, vtotal.packets);
257 n = format (n, "%s bytes", cm->name);
258 s = format (s, "\n%U%-16v%16Ld",
259 format_white_space, indent, n, vtotal.bytes);
264 vlib_simple_counter_main_t *cm;
267 n_counters = vec_len (im->sw_if_counters);
269 for (j = 0; j < n_counters; j++)
273 cm = im->sw_if_counters + j;
275 v = vlib_get_simple_counter (cm, si->sw_if_index);
278 /* Only display non-zero counters. */
283 s = format (s, "\n%U", format_white_space, indent);
286 s = format (s, "%-16s%16Ld", cm->name, vtotal);
294 format_vnet_sw_interface_mtu (u8 * s, va_list * args)
296 vnet_sw_interface_t *si = va_arg (*args, vnet_sw_interface_t *);
298 return format (s, "%d/%d/%d/%d", si->mtu[VNET_MTU_L3],
299 si->mtu[VNET_MTU_IP4],
300 si->mtu[VNET_MTU_IP6], si->mtu[VNET_MTU_MPLS]);
304 format_vnet_sw_interface (u8 * s, va_list * args)
306 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
307 vnet_sw_interface_t *si = va_arg (*args, vnet_sw_interface_t *);
308 vnet_interface_main_t *im = &vnm->interface_main;
311 return format (s, "%=32s%=5s%=10s%=21s%=16s%=16s",
312 "Name", "Idx", "State", "MTU (L3/IP4/IP6/MPLS)", "Counter",
315 s = format (s, "%-32U%=5d%=10U%=21U",
316 format_vnet_sw_interface_name, vnm, si, si->sw_if_index,
317 format_vnet_sw_interface_flags, si->flags,
318 format_vnet_sw_interface_mtu, si);
320 s = format_vnet_sw_interface_cntrs (s, im, si);
326 format_vnet_sw_interface_name_override (u8 * s, va_list * args)
328 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
329 vnet_sw_interface_t *si = va_arg (*args, vnet_sw_interface_t *);
330 /* caller supplied display name for this interface */
331 u8 *name = va_arg (*args, u8 *);
332 vnet_interface_main_t *im = &vnm->interface_main;
336 return format (s, "%=32s%=5s%=16s%=16s%=16s",
337 "Name", "Idx", "State", "Counter", "Count");
339 s = format (s, "%-32v%=5d%=16U",
340 name, si->sw_if_index,
341 format_vnet_sw_interface_flags, si->flags);
343 s = format_vnet_sw_interface_cntrs (s, im, si);
349 format_vnet_buffer_flags (u8 * s, va_list * args)
351 vlib_buffer_t *buf = va_arg (*args, vlib_buffer_t *);
353 #define _(a,b,c,v) if (buf->flags & VNET_BUFFER_F_##b) s = format (s, "%s ", c);
354 foreach_vnet_buffer_flag;
360 format_vnet_buffer_opaque (u8 * s, va_list * args)
362 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
363 vnet_buffer_opaque_t *o = (vnet_buffer_opaque_t *) b->opaque;
364 vnet_interface_main_t *im = &vnet_get_main ()->interface_main;
365 vnet_buffer_opquae_formatter_t helper_fp;
368 s = format (s, "raw: ");
370 for (i = 0; i < ARRAY_LEN (b->opaque); i++)
371 s = format (s, "%08x ", b->opaque[i]);
376 "sw_if_index[VLIB_RX]: %d, sw_if_index[VLIB_TX]: %d",
377 o->sw_if_index[0], o->sw_if_index[1]);
381 "L2 offset %d, L3 offset %d, L4 offset %d, feature arc index %d",
382 (u32) (o->l2_hdr_offset),
383 (u32) (o->l3_hdr_offset),
384 (u32) (o->l4_hdr_offset), (u32) (o->feature_arc_index));
388 "ip.adj_index[VLIB_RX]: %d, ip.adj_index[VLIB_TX]: %d",
389 (u32) (o->ip.adj_index[0]), (u32) (o->ip.adj_index[1]));
393 "ip.flow_hash: 0x%x, ip.save_protocol: 0x%x, ip.fib_index: %d",
394 o->ip.flow_hash, o->ip.save_protocol, o->ip.fib_index);
398 "ip.save_rewrite_length: %d, ip.rpf_id: %d",
399 o->ip.save_rewrite_length, o->ip.rpf_id);
403 "ip.icmp.type: %d ip.icmp.code: %d, ip.icmp.data: 0x%x",
404 (u32) (o->ip.icmp.type),
405 (u32) (o->ip.icmp.code), o->ip.icmp.data);
409 "ip.reass.next_index: %d, ip.reass.estimated_mtu: %d",
410 o->ip.reass.next_index, (u32) (o->ip.reass.estimated_mtu));
414 "ip.reass.fragment_first: %d ip.reass.fragment_last: %d",
415 (u32) (o->ip.reass.fragment_first),
416 (u32) (o->ip.reass.fragment_last));
420 "ip.reass.range_first: %d ip.reass.range_last: %d",
421 (u32) (o->ip.reass.range_first),
422 (u32) (o->ip.reass.range_last));
426 "ip.reass.next_range_bi: 0x%x, ip.reass.ip6_frag_hdr_offset: %d",
427 o->ip.reass.next_range_bi,
428 (u32) (o->ip.reass.ip6_frag_hdr_offset));
432 "mpls.ttl: %d, mpls.exp: %d, mpls.first: %d, "
433 "mpls.save_rewrite_length: %d, mpls.bier.n_bytes: %d",
434 (u32) (o->mpls.ttl), (u32) (o->mpls.exp), (u32) (o->mpls.first),
435 o->mpls.save_rewrite_length, (u32) (o->mpls.bier.n_bytes));
439 "l2.feature_bitmap: %08x, l2.bd_index: %d, l2.l2_len: %d, "
440 "l2.shg: %d, l2.l2fib_sn: %d, l2.bd_age: %d",
441 o->l2.feature_bitmap, (u32) (o->l2.bd_index),
442 (u32) (o->l2.l2_len), (u32) (o->l2.shg), (u32) (o->l2.l2fib_sn),
443 (u32) (o->l2.bd_age));
447 "l2.feature_bitmap_input: %U, L2.feature_bitmap_output: %U",
448 format_l2_input_features, o->l2.feature_bitmap, 0,
449 format_l2_output_features, o->l2.feature_bitmap, 0);
453 "l2t.next_index: %d, l2t.session_index: %d",
454 (u32) (o->l2t.next_index), o->l2t.session_index);
458 "l2_classify.table_index: %d, l2_classify.opaque_index: %d, "
459 "l2_classify.hash: 0x%llx",
460 o->l2_classify.table_index,
461 o->l2_classify.opaque_index, o->l2_classify.hash);
464 s = format (s, "policer.index: %d", o->policer.index);
467 s = format (s, "ipsec.sad_index: %d", o->ipsec.sad_index);
470 s = format (s, "map.mtu: %d", (u32) (o->map.mtu));
474 "map_t.v6.saddr: 0x%x, map_t.v6.daddr: 0x%x, "
475 "map_t.v6.frag_offset: %d, map_t.v6.l4_offset: %d",
478 (u32) (o->map_t.v6.frag_offset), (u32) (o->map_t.v6.l4_offset));
482 "map_t.v6.l4_protocol: %d, map_t.checksum_offset: %d, "
484 (u32) (o->map_t.v6.l4_protocol),
485 (u32) (o->map_t.checksum_offset), (u32) (o->map_t.mtu));
489 "ip_frag.mtu: %d, ip_frag.next_index: %d, ip_frag.flags: 0x%x",
490 (u32) (o->ip_frag.mtu),
491 (u32) (o->ip_frag.next_index), (u32) (o->ip_frag.flags));
494 s = format (s, "cop.current_config_index: %d", o->cop.current_config_index);
497 s = format (s, "lisp.overlay_afi: %d", (u32) (o->lisp.overlay_afi));
501 (s, "tcp.connection_index: %d, tcp.seq_number: %d, tcp.seq_end: %d, "
502 "tcp.ack_number: %d, tcp.hdr_offset: %d, tcp.data_offset: %d",
503 o->tcp.connection_index,
507 (u32) (o->tcp.hdr_offset), (u32) (o->tcp.data_offset));
511 "tcp.data_len: %d, tcp.flags: 0x%x",
512 (u32) (o->tcp.data_len), (u32) (o->tcp.flags));
515 s = format (s, "snat.flags: 0x%x", o->snat.flags);
518 for (i = 0; i < vec_len (im->buffer_opaque_format_helpers); i++)
520 helper_fp = im->buffer_opaque_format_helpers[i];
521 s = (*helper_fp) (b, s);
528 format_vnet_buffer_opaque2 (u8 * s, va_list * args)
530 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
531 vnet_buffer_opaque2_t *o = (vnet_buffer_opaque2_t *) b->opaque2;
532 vnet_interface_main_t *im = &vnet_get_main ()->interface_main;
533 vnet_buffer_opquae_formatter_t helper_fp;
537 s = format (s, "raw: ");
539 for (i = 0; i < ARRAY_LEN (b->opaque2); i++)
540 s = format (s, "%08x ", b->opaque2[i]);
543 s = format (s, "qos.bits: %x, qos.source: %x",
544 (u32) (o->qos.bits), (u32) (o->qos.source));
546 s = format (s, "loop_counter: %d", o->loop_counter);
549 s = format (s, "gbp.flags: %x, gbp.sclass: %d",
550 (u32) (o->gbp.flags), (u32) (o->gbp.sclass));
553 s = format (s, "pg_replay_timestamp: %llu", (u32) (o->pg_replay_timestamp));
556 for (i = 0; i < vec_len (im->buffer_opaque2_format_helpers); i++)
558 helper_fp = im->buffer_opaque2_format_helpers[i];
559 s = (*helper_fp) (b, s);
566 vnet_register_format_buffer_opaque_helper (vnet_buffer_opquae_formatter_t fp)
568 vnet_interface_main_t *im = &vnet_get_main ()->interface_main;
569 vec_add1 (im->buffer_opaque_format_helpers, fp);
573 vnet_register_format_buffer_opaque2_helper (vnet_buffer_opquae_formatter_t fp)
575 vnet_interface_main_t *im = &vnet_get_main ()->interface_main;
576 vec_add1 (im->buffer_opaque2_format_helpers, fp);
581 unformat_vnet_hw_interface (unformat_input_t * input, va_list * args)
583 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
584 u32 *hw_if_index = va_arg (*args, u32 *);
585 vnet_interface_main_t *im = &vnm->interface_main;
586 vnet_device_class_t *c;
588 /* Try per device class functions first. */
589 vec_foreach (c, im->device_classes)
591 if (c->unformat_device_name
592 && unformat_user (input, c->unformat_device_name, hw_if_index))
596 return unformat_user (input, unformat_hash_vec_string,
597 im->hw_interface_by_name, hw_if_index);
601 unformat_vnet_sw_interface (unformat_input_t * input, va_list * args)
603 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
604 u32 *result = va_arg (*args, u32 *);
605 vnet_hw_interface_t *hi;
606 u32 hw_if_index, id, id_specified;
612 if (unformat (input, "%_%v.%d%_", &if_name, &id)
613 && ((p = hash_get (vnm->interface_main.hw_interface_by_name, if_name))))
619 if (unformat (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
624 hi = vnet_get_hw_interface (vnm, hw_if_index);
627 sw_if_index = hi->sw_if_index;
631 if (!(p = hash_get (hi->sub_interface_sw_if_index_by_id, id)))
635 if (!vnet_sw_interface_is_api_visible (vnm, sw_if_index))
637 *result = sw_if_index;
645 unformat_vnet_sw_interface_flags (unformat_input_t * input, va_list * args)
647 u32 *result = va_arg (*args, u32 *);
650 if (unformat (input, "up"))
651 flags |= VNET_SW_INTERFACE_FLAG_ADMIN_UP;
652 else if (unformat (input, "down"))
653 flags &= ~VNET_SW_INTERFACE_FLAG_ADMIN_UP;
654 else if (unformat (input, "punt"))
655 flags |= VNET_SW_INTERFACE_FLAG_PUNT;
656 else if (unformat (input, "enable"))
657 flags &= ~VNET_SW_INTERFACE_FLAG_PUNT;
666 unformat_vnet_hw_interface_flags (unformat_input_t * input, va_list * args)
668 u32 *result = va_arg (*args, u32 *);
671 if (unformat (input, "up"))
672 flags |= VNET_HW_INTERFACE_FLAG_LINK_UP;
673 else if (unformat (input, "down"))
674 flags &= ~VNET_HW_INTERFACE_FLAG_LINK_UP;
683 * fd.io coding-style-patch-verification: ON
686 * eval: (c-set-style "gnu")