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");
55 (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ? "up" : "down");
56 if (flags & VNET_SW_INTERFACE_FLAG_PUNT)
57 s = format (s, "/punt");
64 format_vnet_hw_interface_rx_mode (u8 * s, va_list * args)
66 vnet_hw_interface_rx_mode mode = va_arg (*args, vnet_hw_interface_rx_mode);
68 if (mode == VNET_HW_INTERFACE_RX_MODE_POLLING)
69 return format (s, "polling");
71 if (mode == VNET_HW_INTERFACE_RX_MODE_INTERRUPT)
72 return format (s, "interrupt");
74 if (mode == VNET_HW_INTERFACE_RX_MODE_ADAPTIVE)
75 return format (s, "adaptive");
77 return format (s, "unknown");
81 format_vnet_hw_interface_link_speed (u8 * s, va_list * args)
83 u32 link_speed = va_arg (*args, u32);
86 return format (s, "unknown");
88 if (link_speed >= 1000000)
89 return format (s, "%f Gbps", (f64) link_speed / 1000000);
91 if (link_speed >= 1000)
92 return format (s, "%f Mbps", (f64) link_speed / 1000);
94 return format (s, "%u Kbps", link_speed);
99 format_vnet_hw_interface (u8 * s, va_list * args)
101 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
102 vnet_hw_interface_t *hi = va_arg (*args, vnet_hw_interface_t *);
103 vnet_hw_interface_class_t *hw_class;
104 vnet_device_class_t *dev_class;
105 int verbose = va_arg (*args, int);
109 return format (s, "%=32s%=6s%=8s%s", "Name", "Idx", "Link", "Hardware");
111 indent = format_get_indent (s);
113 s = format (s, "%-32v%=6d", hi->name, hi->hw_if_index);
115 if (hi->bond_info == VNET_HW_INTERFACE_BOND_INFO_SLAVE)
116 s = format (s, "%=8s", "slave");
118 s = format (s, "%=8s",
119 hi->flags & VNET_HW_INTERFACE_FLAG_LINK_UP ? "up" : "down");
121 hw_class = vnet_get_hw_interface_class (vnm, hi->hw_class_index);
122 dev_class = vnet_get_device_class (vnm, hi->dev_class_index);
124 if (hi->bond_info && (hi->bond_info != VNET_HW_INTERFACE_BOND_INFO_SLAVE))
127 s = format (s, "Slave-Idx:");
128 clib_bitmap_foreach (hw_idx, hi->bond_info, s =
129 format (s, " %d", hw_idx));
131 else if (dev_class->format_device_name)
132 s = format (s, "%U", dev_class->format_device_name, hi->dev_instance);
134 s = format (s, "%s%d", dev_class->name, hi->dev_instance);
136 s = format (s, "\n%ULink speed: %U", format_white_space, indent + 2,
137 format_vnet_hw_interface_link_speed, hi->link_speed);
141 if (hw_class->format_device)
142 s = format (s, "\n%U%U",
143 format_white_space, indent + 2,
144 hw_class->format_device, hi->hw_if_index, verbose);
147 s = format (s, "\n%U%s",
148 format_white_space, indent + 2, hw_class->name);
149 if (hw_class->format_address && vec_len (hi->hw_address) > 0)
151 format (s, " address %U", hw_class->format_address,
155 if (dev_class->format_device)
156 s = format (s, "\n%U%U",
157 format_white_space, indent + 2,
158 dev_class->format_device, hi->dev_instance, verbose);
165 format_vnet_sw_interface_name (u8 * s, va_list * args)
167 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
168 vnet_sw_interface_t *si = va_arg (*args, vnet_sw_interface_t *);
169 vnet_sw_interface_t *si_sup =
170 vnet_get_sup_sw_interface (vnm, si->sw_if_index);
171 vnet_hw_interface_t *hi_sup;
173 ASSERT (si_sup->type == VNET_SW_INTERFACE_TYPE_HARDWARE);
174 hi_sup = vnet_get_hw_interface (vnm, si_sup->hw_if_index);
176 s = format (s, "%v", hi_sup->name);
178 if (si->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
179 s = format (s, ".%d", si->sub.id);
185 format_vnet_sw_if_index_name (u8 * s, va_list * args)
187 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
188 u32 sw_if_index = va_arg (*args, u32);
189 vnet_sw_interface_t *si;
191 si = vnet_get_sw_interface_or_null (vnm, sw_if_index);
195 return format (s, "DELETED");
197 return format (s, "%U", format_vnet_sw_interface_name, vnm, si);
201 format_vnet_hw_if_index_name (u8 * s, va_list * args)
203 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
204 u32 hw_if_index = va_arg (*args, u32);
205 vnet_hw_interface_t *hi;
207 hi = vnet_get_hw_interface (vnm, hw_if_index);
210 return format (s, "DELETED");
212 return format (s, "%v", hi->name);
216 format_vnet_sw_interface_cntrs (u8 * s, vnet_interface_main_t * im,
217 vnet_sw_interface_t * si, int json)
219 u32 indent, n_printed;
222 int json_need_comma_nl = 0;
226 * to output a json snippet, stick quotes in lots of places
227 * definitely deserves a one-character variable name.
232 indent = format_get_indent (s);
235 n_counters = vec_len (im->combined_sw_if_counters);
237 /* rx, tx counters... */
238 for (j = 0; j < n_counters; j++)
240 vlib_combined_counter_main_t *cm;
241 vlib_counter_t v, vtotal;
245 cm = im->combined_sw_if_counters + j;
246 vlib_get_combined_counter (cm, si->sw_if_index, &v);
247 vtotal.packets += v.packets;
248 vtotal.bytes += v.bytes;
250 /* Only display non-zero counters. */
251 if (vtotal.packets == 0)
256 if (json_need_comma_nl)
261 s = format (s, "%s%s_packets%s: %s%Ld%s,\n", x, cm->name, x, x,
263 s = format (s, "%s%s_bytes%s: %s%Ld%s", x, cm->name, x, x,
265 json_need_comma_nl = 1;
270 s = format (s, "\n%U", format_white_space, indent);
275 n = format (n, "%s packets", cm->name);
276 s = format (s, "%-16v%16Ld", n, vtotal.packets);
279 n = format (n, "%s bytes", cm->name);
280 s = format (s, "\n%U%-16v%16Ld",
281 format_white_space, indent, n, vtotal.bytes);
286 vlib_simple_counter_main_t *cm;
289 n_counters = vec_len (im->sw_if_counters);
291 for (j = 0; j < n_counters; j++)
295 cm = im->sw_if_counters + j;
297 v = vlib_get_simple_counter (cm, si->sw_if_index);
300 /* Only display non-zero counters. */
306 if (json_need_comma_nl)
311 s = format (s, "%s%s%s: %s%Ld%s", x, cm->name, x, x, vtotal, x);
312 json_need_comma_nl = 1;
318 s = format (s, "\n%U", format_white_space, indent);
321 s = format (s, "%-16s%16Ld", cm->name, vtotal);
329 format_vnet_sw_interface_mtu (u8 * s, va_list * args)
331 vnet_sw_interface_t *si = va_arg (*args, vnet_sw_interface_t *);
333 return format (s, "%d/%d/%d/%d", si->mtu[VNET_MTU_L3],
334 si->mtu[VNET_MTU_IP4],
335 si->mtu[VNET_MTU_IP6], si->mtu[VNET_MTU_MPLS]);
339 format_vnet_sw_interface (u8 * s, va_list * args)
341 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
342 vnet_sw_interface_t *si = va_arg (*args, vnet_sw_interface_t *);
343 vnet_interface_main_t *im = &vnm->interface_main;
346 return format (s, "%=32s%=5s%=10s%=21s%=16s%=16s",
347 "Name", "Idx", "State", "MTU (L3/IP4/IP6/MPLS)", "Counter",
350 s = format (s, "%-32U%=5d%=10U%=21U",
351 format_vnet_sw_interface_name, vnm, si, si->sw_if_index,
352 format_vnet_sw_interface_flags, si->flags,
353 format_vnet_sw_interface_mtu, si);
355 s = format_vnet_sw_interface_cntrs (s, im, si, 0 /* want json */ );
361 format_vnet_sw_interface_name_override (u8 * s, va_list * args)
363 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
364 vnet_sw_interface_t *si = va_arg (*args, vnet_sw_interface_t *);
365 /* caller supplied display name for this interface */
366 u8 *name = va_arg (*args, u8 *);
367 vnet_interface_main_t *im = &vnm->interface_main;
371 return format (s, "%=32s%=5s%=16s%=16s%=16s",
372 "Name", "Idx", "State", "Counter", "Count");
374 s = format (s, "%-32v%=5d%=16U",
375 name, si->sw_if_index,
376 format_vnet_sw_interface_flags, si->flags);
378 s = format_vnet_sw_interface_cntrs (s, im, si, 0 /* want json */ );
384 format_vnet_buffer_flags (u8 * s, va_list * args)
386 vlib_buffer_t *buf = va_arg (*args, vlib_buffer_t *);
388 #define _(a,b,c,v) if (buf->flags & VNET_BUFFER_F_##b) s = format (s, "%s ", c);
389 foreach_vnet_buffer_flag;
395 format_vnet_buffer_opaque (u8 * s, va_list * args)
397 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
398 vnet_buffer_opaque_t *o = (vnet_buffer_opaque_t *) b->opaque;
399 vnet_interface_main_t *im = &vnet_get_main ()->interface_main;
400 vnet_buffer_opquae_formatter_t helper_fp;
403 s = format (s, "raw: ");
405 for (i = 0; i < ARRAY_LEN (b->opaque); i++)
406 s = format (s, "%08x ", b->opaque[i]);
411 "sw_if_index[VLIB_RX]: %d, sw_if_index[VLIB_TX]: %d",
412 o->sw_if_index[0], o->sw_if_index[1]);
416 "L2 offset %d, L3 offset %d, L4 offset %d, feature arc index %d",
417 (u32) (o->l2_hdr_offset),
418 (u32) (o->l3_hdr_offset),
419 (u32) (o->l4_hdr_offset), (u32) (o->feature_arc_index));
423 "ip.adj_index[VLIB_RX]: %d, ip.adj_index[VLIB_TX]: %d",
424 (u32) (o->ip.adj_index[0]), (u32) (o->ip.adj_index[1]));
428 "ip.flow_hash: 0x%x, ip.save_protocol: 0x%x, ip.fib_index: %d",
429 o->ip.flow_hash, o->ip.save_protocol, o->ip.fib_index);
433 "ip.save_rewrite_length: %d, ip.rpf_id: %d",
434 o->ip.save_rewrite_length, o->ip.rpf_id);
438 "ip.icmp.type: %d ip.icmp.code: %d, ip.icmp.data: 0x%x",
439 (u32) (o->ip.icmp.type),
440 (u32) (o->ip.icmp.code), o->ip.icmp.data);
444 "ip.reass.next_index: %d, ip.reass.estimated_mtu: %d",
445 o->ip.reass.next_index, (u32) (o->ip.reass.estimated_mtu));
448 "ip.reass.error_next_index: %d, ip.reass.owner_thread_index: %d",
449 o->ip.reass.error_next_index,
450 (u32) (o->ip.reass.owner_thread_index));
453 "ip.reass.ip_proto: %d, ip.reass.l4_src_port: %d",
454 o->ip.reass.ip_proto, (u32) (o->ip.reass.l4_src_port));
456 s = format (s, "ip.reass.l4_dst_port: %d", o->ip.reass.l4_dst_port);
460 "ip.reass.fragment_first: %d ip.reass.fragment_last: %d",
461 (u32) (o->ip.reass.fragment_first),
462 (u32) (o->ip.reass.fragment_last));
466 "ip.reass.range_first: %d ip.reass.range_last: %d",
467 (u32) (o->ip.reass.range_first),
468 (u32) (o->ip.reass.range_last));
472 "ip.reass.next_range_bi: 0x%x, ip.reass.ip6_frag_hdr_offset: %d",
473 o->ip.reass.next_range_bi,
474 (u32) (o->ip.reass.ip6_frag_hdr_offset));
478 "mpls.ttl: %d, mpls.exp: %d, mpls.first: %d, "
479 "mpls.save_rewrite_length: %d, mpls.bier.n_bytes: %d",
480 (u32) (o->mpls.ttl), (u32) (o->mpls.exp), (u32) (o->mpls.first),
481 o->mpls.save_rewrite_length, (u32) (o->mpls.bier.n_bytes));
483 s = format (s, "mpls.mpls_hdr_length: %d", (u32) (o->mpls.mpls_hdr_length));
487 "l2.feature_bitmap: %08x, l2.bd_index: %d, l2.l2fib_sn %d, "
488 "l2.l2_len: %d, l2.shg: %d, l2.bd_age: %d",
489 (u32) (o->l2.feature_bitmap), (u32) (o->l2.bd_index),
490 (u32) (o->l2.l2fib_sn),
491 (u32) (o->l2.l2_len), (u32) (o->l2.shg), (u32) (o->l2.bd_age));
495 "l2.feature_bitmap_input: %U, L2.feature_bitmap_output: %U",
496 format_l2_input_features, o->l2.feature_bitmap, 0,
497 format_l2_output_features, o->l2.feature_bitmap, 0);
501 "l2t.next_index: %d, l2t.session_index: %d",
502 (u32) (o->l2t.next_index), o->l2t.session_index);
506 "l2_classify.table_index: %d, l2_classify.opaque_index: %d, "
507 "l2_classify.hash: 0x%llx",
508 o->l2_classify.table_index,
509 o->l2_classify.opaque_index, o->l2_classify.hash);
512 s = format (s, "policer.index: %d", o->policer.index);
515 s = format (s, "ipsec.sad_index: %d, ipsec.protect_index",
516 o->ipsec.sad_index, o->ipsec.protect_index);
519 s = format (s, "map.mtu: %d", (u32) (o->map.mtu));
523 "map_t.map_domain_index: %d, map_t.v6.saddr: 0x%x, "
524 "map_t.v6.daddr: 0x%x, map_t.v6.frag_offset: %d, "
525 "map_t.v6.l4_offset: %d, map_t.v6.l4_protocol: %d, "
526 "map.t.checksum_offset: %d",
527 o->map_t.map_domain_index,
530 (u32) (o->map_t.v6.frag_offset), (u32) (o->map_t.v6.l4_offset),
531 (u32) (o->map_t.v6.l4_protocol),
532 (u32) (o->map_t.checksum_offset));
536 "map_t.v6.l4_protocol: %d, map_t.checksum_offset: %d, "
538 (u32) (o->map_t.v6.l4_protocol),
539 (u32) (o->map_t.checksum_offset), (u32) (o->map_t.mtu));
543 "ip_frag.mtu: %d, ip_frag.next_index: %d, ip_frag.flags: 0x%x",
544 (u32) (o->ip_frag.mtu),
545 (u32) (o->ip_frag.next_index), (u32) (o->ip_frag.flags));
548 s = format (s, "cop.current_config_index: %d", o->cop.current_config_index);
551 s = format (s, "lisp.overlay_afi: %d", (u32) (o->lisp.overlay_afi));
556 "tcp.connection_index: %d, tcp.seq_number: %d, tcp.next_node_opaque: %d "
557 "tcp.seq_end: %d, tcp.ack_number: %d, tcp.hdr_offset: %d, "
558 "tcp.data_offset: %d", o->tcp.connection_index, o->tcp.next_node_opaque,
559 o->tcp.seq_number, o->tcp.seq_end, o->tcp.ack_number,
560 (u32) (o->tcp.hdr_offset), (u32) (o->tcp.data_offset));
564 "tcp.data_len: %d, tcp.flags: 0x%x",
565 (u32) (o->tcp.data_len), (u32) (o->tcp.flags));
568 s = format (s, "snat.flags: 0x%x", o->snat.flags);
571 for (i = 0; i < vec_len (im->buffer_opaque_format_helpers); i++)
573 helper_fp = im->buffer_opaque_format_helpers[i];
574 s = (*helper_fp) (b, s);
581 format_vnet_buffer_opaque2 (u8 * s, va_list * args)
583 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
584 vnet_buffer_opaque2_t *o = (vnet_buffer_opaque2_t *) b->opaque2;
585 vnet_interface_main_t *im = &vnet_get_main ()->interface_main;
586 vnet_buffer_opquae_formatter_t helper_fp;
590 s = format (s, "raw: ");
592 for (i = 0; i < ARRAY_LEN (b->opaque2); i++)
593 s = format (s, "%08x ", b->opaque2[i]);
596 s = format (s, "qos.bits: %x, qos.source: %x",
597 (u32) (o->qos.bits), (u32) (o->qos.source));
599 s = format (s, "loop_counter: %d", o->loop_counter);
602 s = format (s, "gbp.flags: %x, gbp.sclass: %d",
603 (u32) (o->gbp.flags), (u32) (o->gbp.sclass));
606 s = format (s, "gso_size: %d, gso_l4_hdr_sz: %d",
607 (u32) (o->gso_size), (u32) (o->gso_l4_hdr_sz));
610 s = format (s, "pg_replay_timestamp: %llu", (u32) (o->pg_replay_timestamp));
613 for (i = 0; i < vec_len (im->buffer_opaque2_format_helpers); i++)
615 helper_fp = im->buffer_opaque2_format_helpers[i];
616 s = (*helper_fp) (b, s);
623 vnet_register_format_buffer_opaque_helper (vnet_buffer_opquae_formatter_t fp)
625 vnet_interface_main_t *im = &vnet_get_main ()->interface_main;
626 vec_add1 (im->buffer_opaque_format_helpers, fp);
630 vnet_register_format_buffer_opaque2_helper (vnet_buffer_opquae_formatter_t fp)
632 vnet_interface_main_t *im = &vnet_get_main ()->interface_main;
633 vec_add1 (im->buffer_opaque2_format_helpers, fp);
638 unformat_vnet_hw_interface (unformat_input_t * input, va_list * args)
640 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
641 u32 *hw_if_index = va_arg (*args, u32 *);
642 vnet_interface_main_t *im = &vnm->interface_main;
643 vnet_device_class_t *c;
645 /* Try per device class functions first. */
646 vec_foreach (c, im->device_classes)
648 if (c->unformat_device_name
649 && unformat_user (input, c->unformat_device_name, hw_if_index))
653 return unformat_user (input, unformat_hash_vec_string,
654 im->hw_interface_by_name, hw_if_index);
658 unformat_vnet_sw_interface (unformat_input_t * input, va_list * args)
660 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
661 u32 *result = va_arg (*args, u32 *);
662 vnet_hw_interface_t *hi;
663 u32 hw_if_index, id, id_specified;
669 if (unformat (input, "%_%v.%d%_", &if_name, &id)
670 && ((p = hash_get (vnm->interface_main.hw_interface_by_name, if_name))))
676 if (unformat (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
681 hi = vnet_get_hw_interface (vnm, hw_if_index);
684 sw_if_index = hi->sw_if_index;
688 if (!(p = hash_get (hi->sub_interface_sw_if_index_by_id, id)))
692 if (!vnet_sw_interface_is_api_visible (vnm, sw_if_index))
694 *result = sw_if_index;
702 unformat_vnet_sw_interface_flags (unformat_input_t * input, va_list * args)
704 u32 *result = va_arg (*args, u32 *);
707 if (unformat (input, "up"))
708 flags |= VNET_SW_INTERFACE_FLAG_ADMIN_UP;
709 else if (unformat (input, "down"))
710 flags &= ~VNET_SW_INTERFACE_FLAG_ADMIN_UP;
711 else if (unformat (input, "punt"))
712 flags |= VNET_SW_INTERFACE_FLAG_PUNT;
713 else if (unformat (input, "enable"))
714 flags &= ~VNET_SW_INTERFACE_FLAG_PUNT;
723 unformat_vnet_hw_interface_flags (unformat_input_t * input, va_list * args)
725 u32 *result = va_arg (*args, u32 *);
728 if (unformat (input, "up"))
729 flags |= VNET_HW_INTERFACE_FLAG_LINK_UP;
730 else if (unformat (input, "down"))
731 flags &= ~VNET_HW_INTERFACE_FLAG_LINK_UP;
740 * fd.io coding-style-patch-verification: ON
743 * eval: (c-set-style "gnu")