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_safe (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;
222 int i, j, n_counters;
223 static vnet_main_t **my_vnet_mains;
225 vec_reset_length (my_vnet_mains);
227 indent = format_get_indent (s);
231 vlib_combined_counter_main_t *cm;
232 vlib_counter_t v, vtotal;
235 for (i = 0; i < vec_len (vnet_mains); i++)
238 vec_add1 (my_vnet_mains, vnet_mains[i]);
241 if (vec_len (my_vnet_mains) == 0)
242 vec_add1 (my_vnet_mains, &vnet_main);
244 /* Each vnet_main_t has its own copy of the interface counters */
245 n_counters = vec_len (im->combined_sw_if_counters);
247 /* rx, tx counters... */
248 for (j = 0; j < n_counters; j++)
253 for (i = 0; i < vec_len (my_vnet_mains); i++)
255 im = &my_vnet_mains[i]->interface_main;
256 cm = im->combined_sw_if_counters + j;
257 vlib_get_combined_counter (cm, si->sw_if_index, &v);
258 vtotal.packets += v.packets;
259 vtotal.bytes += v.bytes;
262 /* Only display non-zero counters. */
263 if (vtotal.packets == 0)
267 s = format (s, "\n%U", format_white_space, indent);
272 n = format (n, "%s packets", cm->name);
273 s = format (s, "%-16v%16Ld", n, vtotal.packets);
276 n = format (n, "%s bytes", cm->name);
277 s = format (s, "\n%U%-16v%16Ld",
278 format_white_space, indent, n, vtotal.bytes);
284 vlib_simple_counter_main_t *cm;
287 n_counters = vec_len (im->sw_if_counters);
289 for (j = 0; j < n_counters; j++)
293 for (i = 0; i < vec_len (my_vnet_mains); i++)
295 im = &my_vnet_mains[i]->interface_main;
296 cm = im->sw_if_counters + j;
298 v = vlib_get_simple_counter (cm, si->sw_if_index);
302 /* Only display non-zero counters. */
307 s = format (s, "\n%U", format_white_space, indent);
310 s = format (s, "%-16s%16Ld", cm->name, vtotal);
318 format_vnet_sw_interface_mtu (u8 * s, va_list * args)
320 vnet_sw_interface_t *si = va_arg (*args, vnet_sw_interface_t *);
322 return format (s, "%d/%d/%d/%d", si->mtu[VNET_MTU_L3],
323 si->mtu[VNET_MTU_IP4],
324 si->mtu[VNET_MTU_IP6], si->mtu[VNET_MTU_MPLS]);
328 format_vnet_sw_interface (u8 * s, va_list * args)
330 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
331 vnet_sw_interface_t *si = va_arg (*args, vnet_sw_interface_t *);
332 vnet_interface_main_t *im = &vnm->interface_main;
335 return format (s, "%=32s%=5s%=10s%=21s%=16s%=16s",
336 "Name", "Idx", "State", "MTU (L3/IP4/IP6/MPLS)", "Counter",
339 s = format (s, "%-32U%=5d%=10U%=21U",
340 format_vnet_sw_interface_name, vnm, si, si->sw_if_index,
341 format_vnet_sw_interface_flags, si->flags,
342 format_vnet_sw_interface_mtu, si);
344 s = format_vnet_sw_interface_cntrs (s, im, si);
350 format_vnet_sw_interface_name_override (u8 * s, va_list * args)
352 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
353 vnet_sw_interface_t *si = va_arg (*args, vnet_sw_interface_t *);
354 /* caller supplied display name for this interface */
355 u8 *name = va_arg (*args, u8 *);
356 vnet_interface_main_t *im = &vnm->interface_main;
360 return format (s, "%=32s%=5s%=16s%=16s%=16s",
361 "Name", "Idx", "State", "Counter", "Count");
363 s = format (s, "%-32v%=5d%=16U",
364 name, si->sw_if_index,
365 format_vnet_sw_interface_flags, si->flags);
367 s = format_vnet_sw_interface_cntrs (s, im, si);
373 format_vnet_buffer_flags (u8 * s, va_list * args)
375 vlib_buffer_t *buf = va_arg (*args, vlib_buffer_t *);
377 #define _(a,b,c,v) if (buf->flags & VNET_BUFFER_F_##b) s = format (s, "%s ", c);
378 foreach_vnet_buffer_flag;
384 format_vnet_buffer_opaque (u8 * s, va_list * args)
386 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
387 vnet_buffer_opaque_t *o = (vnet_buffer_opaque_t *) b->opaque;
390 s = format (s, "raw: ");
392 for (i = 0; i < ARRAY_LEN (b->opaque); i++)
393 s = format (s, "%08x ", b->opaque[i]);
398 "sw_if_index[VLIB_RX]: %d, sw_if_index[VLIB_TX]: %d",
399 o->sw_if_index[0], o->sw_if_index[1]);
403 "L2 offset %d, L3 offset %d, L4 offset %d, feature arc index %d",
404 (u32) (o->l2_hdr_offset),
405 (u32) (o->l3_hdr_offset),
406 (u32) (o->l4_hdr_offset), (u32) (o->feature_arc_index));
410 "ip.adj_index[VLIB_RX]: %d, ip.adj_index[VLIB_TX]: %d",
411 (u32) (o->ip.adj_index[0]), (u32) (o->ip.adj_index[1]));
415 "ip.flow_hash: 0x%x, ip.save_protocol: 0x%x, ip.fib_index: %d",
416 o->ip.flow_hash, o->ip.save_protocol, o->ip.fib_index);
420 "ip.save_rewrite_length: %d, ip.rpf_id: %d",
421 o->ip.save_rewrite_length, o->ip.rpf_id);
425 "ip.icmp.type: %d ip.icmp.code: %d, ip.icmp.data: 0x%x",
426 (u32) (o->ip.icmp.type),
427 (u32) (o->ip.icmp.code), o->ip.icmp.data);
431 "ip.reass.next_index: %d, ip.reass.estimated_mtu: %d",
432 o->ip.reass.next_index, (u32) (o->ip.reass.estimated_mtu));
436 "ip.reass.fragment_first: %d ip.reass.fragment_last: %d",
437 (u32) (o->ip.reass.fragment_first),
438 (u32) (o->ip.reass.fragment_last));
442 "ip.reass.range_first: %d ip.reass.range_last: %d",
443 (u32) (o->ip.reass.range_first),
444 (u32) (o->ip.reass.range_last));
448 "ip.reass.next_range_bi: 0x%x, ip.reass.ip6_frag_hdr_offset: %d",
449 o->ip.reass.next_range_bi,
450 (u32) (o->ip.reass.ip6_frag_hdr_offset));
454 "mpls.ttl: %d, mpls.exp: %d, mpls.first: %d, "
455 "mpls.save_rewrite_length: %d, mpls.bier.n_bytes: %d",
456 (u32) (o->mpls.ttl), (u32) (o->mpls.exp), (u32) (o->mpls.first),
457 o->mpls.save_rewrite_length, (u32) (o->mpls.bier.n_bytes));
461 "l2.feature_bitmap: %08x, l2.bd_index: %d, l2.l2_len: %d, "
462 "l2.shg: %d, l2.l2fib_sn: %d, l2.bd_age: %d",
463 o->l2.feature_bitmap, (u32) (o->l2.bd_index),
464 (u32) (o->l2.l2_len), (u32) (o->l2.shg), (u32) (o->l2.l2fib_sn),
465 (u32) (o->l2.bd_age));
469 "l2.feature_bitmap_input: %U, L2.feature_bitmap_output: %U",
470 format_l2_input_features, o->l2.feature_bitmap, 0,
471 format_l2_output_features, o->l2.feature_bitmap, 0);
475 "l2t.next_index: %d, l2t.session_index: %d",
476 (u32) (o->l2t.next_index), o->l2t.session_index);
480 "l2_classify.table_index: %d, l2_classify.opaque_index: %d, "
481 "l2_classify.hash: 0x%llx",
482 o->l2_classify.table_index,
483 o->l2_classify.opaque_index, o->l2_classify.hash);
486 s = format (s, "policer.index: %d", o->policer.index);
490 "ipsec.flags: 0x%x, ipsec.sad_index: %d",
491 o->ipsec.flags, o->ipsec.sad_index);
494 s = format (s, "map.mtu: %d", (u32) (o->map.mtu));
498 "map_t.v6.saddr: 0x%x, map_t.v6.daddr: 0x%x, "
499 "map_t.v6.frag_offset: %d, map_t.v6.l4_offset: %d",
502 (u32) (o->map_t.v6.frag_offset), (u32) (o->map_t.v6.l4_offset));
506 "map_t.v6.l4_protocol: %d, map_t.checksum_offset: %d, "
508 (u32) (o->map_t.v6.l4_protocol),
509 (u32) (o->map_t.checksum_offset), (u32) (o->map_t.mtu));
513 "ip_frag.mtu: %d, ip_frag.next_index: %d, ip_frag.flags: 0x%x",
514 (u32) (o->ip_frag.mtu),
515 (u32) (o->ip_frag.next_index), (u32) (o->ip_frag.flags));
518 s = format (s, "cop.current_config_index: %d", o->cop.current_config_index);
521 s = format (s, "lisp.overlay_afi: %d", (u32) (o->lisp.overlay_afi));
525 (s, "tcp.connection_index: %d, tcp.seq_number: %d, tcp.seq_end: %d, "
526 "tcp.ack_number: %d, tcp.hdr_offset: %d, tcp.data_offset: %d",
527 o->tcp.connection_index,
531 (u32) (o->tcp.hdr_offset), (u32) (o->tcp.data_offset));
535 "tcp.data_len: %d, tcp.flags: 0x%x",
536 (u32) (o->tcp.data_len), (u32) (o->tcp.flags));
540 "sctp.connection_index: %d, sctp.sid: %d, sctp.ssn: %d, "
541 "sctp.tsn: %d, sctp.hdr_offset: %d",
542 o->sctp.connection_index,
545 (u32) (o->sctp.tsn), (u32) (o->sctp.hdr_offset));
549 (s, "sctp.data_offset: %d, sctp.data_len: %d, sctp.subconn_idx: %d, "
551 (u32) (o->sctp.data_offset),
552 (u32) (o->sctp.data_len),
553 (u32) (o->sctp.subconn_idx), (u32) (o->sctp.flags));
556 s = format (s, "snat.flags: 0x%x", o->snat.flags);
562 format_vnet_buffer_opaque2 (u8 * s, va_list * args)
564 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
565 vnet_buffer_opaque2_t *o = (vnet_buffer_opaque2_t *) b->opaque2;
569 s = format (s, "raw: ");
571 for (i = 0; i < ARRAY_LEN (b->opaque2); i++)
572 s = format (s, "%08x ", b->opaque2[i]);
575 s = format (s, "qos.bits: %x, qos.source: %x",
576 (u32) (o->qos.bits), (u32) (o->qos.source));
578 s = format (s, "loop_counter: %d", o->loop_counter);
581 s = format (s, "gbp.flags: %x, gbp.src_epg: %d",
582 (u32) (o->gbp.flags), (u32) (o->gbp.src_epg));
585 s = format (s, "pg_replay_timestamp: %llu", (u32) (o->pg_replay_timestamp));
591 unformat_vnet_hw_interface (unformat_input_t * input, va_list * args)
593 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
594 u32 *hw_if_index = va_arg (*args, u32 *);
595 vnet_interface_main_t *im = &vnm->interface_main;
596 vnet_device_class_t *c;
598 /* Try per device class functions first. */
599 vec_foreach (c, im->device_classes)
601 if (c->unformat_device_name
602 && unformat_user (input, c->unformat_device_name, hw_if_index))
606 return unformat_user (input, unformat_hash_vec_string,
607 im->hw_interface_by_name, hw_if_index);
611 unformat_vnet_sw_interface (unformat_input_t * input, va_list * args)
613 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
614 u32 *result = va_arg (*args, u32 *);
615 vnet_hw_interface_t *hi;
616 u32 hw_if_index, id, id_specified;
622 if (unformat (input, "%_%v.%d%_", &if_name, &id)
623 && ((p = hash_get (vnm->interface_main.hw_interface_by_name, if_name))))
629 if (unformat (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
634 hi = vnet_get_hw_interface (vnm, hw_if_index);
637 sw_if_index = hi->sw_if_index;
641 if (!(p = hash_get (hi->sub_interface_sw_if_index_by_id, id)))
645 if (!vnet_sw_interface_is_api_visible (vnm, sw_if_index))
647 *result = sw_if_index;
655 unformat_vnet_sw_interface_flags (unformat_input_t * input, va_list * args)
657 u32 *result = va_arg (*args, u32 *);
660 if (unformat (input, "up"))
661 flags |= VNET_SW_INTERFACE_FLAG_ADMIN_UP;
662 else if (unformat (input, "down"))
663 flags &= ~VNET_SW_INTERFACE_FLAG_ADMIN_UP;
664 else if (unformat (input, "punt"))
665 flags |= VNET_SW_INTERFACE_FLAG_PUNT;
666 else if (unformat (input, "enable"))
667 flags &= ~VNET_SW_INTERFACE_FLAG_PUNT;
676 unformat_vnet_hw_interface_flags (unformat_input_t * input, va_list * args)
678 u32 *result = va_arg (*args, u32 *);
681 if (unformat (input, "up"))
682 flags |= VNET_HW_INTERFACE_FLAG_LINK_UP;
683 else if (unformat (input, "down"))
684 flags &= ~VNET_HW_INTERFACE_FLAG_LINK_UP;
693 * fd.io coding-style-patch-verification: ON
696 * eval: (c-set-style "gnu")