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>
44 format_vnet_sw_interface_flags (u8 * s, va_list * args)
46 u32 flags = va_arg (*args, u32);
48 if (flags & VNET_SW_INTERFACE_FLAG_ERROR)
49 s = format (s, "error");
50 else if (flags & VNET_SW_INTERFACE_FLAG_BOND_SLAVE)
51 s = format (s, "bond-slave");
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_safe (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)
219 u32 indent, n_printed;
220 int i, j, n_counters;
221 static vnet_main_t **my_vnet_mains;
223 vec_reset_length (my_vnet_mains);
225 indent = format_get_indent (s);
229 vlib_combined_counter_main_t *cm;
230 vlib_counter_t v, vtotal;
233 for (i = 0; i < vec_len (vnet_mains); i++)
236 vec_add1 (my_vnet_mains, vnet_mains[i]);
239 if (vec_len (my_vnet_mains) == 0)
240 vec_add1 (my_vnet_mains, &vnet_main);
242 /* Each vnet_main_t has its own copy of the interface counters */
243 n_counters = vec_len (im->combined_sw_if_counters);
245 /* rx, tx counters... */
246 for (j = 0; j < n_counters; j++)
251 for (i = 0; i < vec_len (my_vnet_mains); i++)
253 im = &my_vnet_mains[i]->interface_main;
254 cm = im->combined_sw_if_counters + j;
255 vlib_get_combined_counter (cm, si->sw_if_index, &v);
256 vtotal.packets += v.packets;
257 vtotal.bytes += v.bytes;
260 /* Only display non-zero counters. */
261 if (vtotal.packets == 0)
265 s = format (s, "\n%U", format_white_space, indent);
270 n = format (n, "%s packets", cm->name);
271 s = format (s, "%-16v%16Ld", n, vtotal.packets);
274 n = format (n, "%s bytes", cm->name);
275 s = format (s, "\n%U%-16v%16Ld",
276 format_white_space, indent, n, vtotal.bytes);
282 vlib_simple_counter_main_t *cm;
285 n_counters = vec_len (im->sw_if_counters);
287 for (j = 0; j < n_counters; j++)
291 for (i = 0; i < vec_len (my_vnet_mains); i++)
293 im = &my_vnet_mains[i]->interface_main;
294 cm = im->sw_if_counters + j;
296 v = vlib_get_simple_counter (cm, si->sw_if_index);
300 /* Only display non-zero counters. */
305 s = format (s, "\n%U", format_white_space, indent);
308 s = format (s, "%-16s%16Ld", cm->name, vtotal);
316 format_vnet_sw_interface_mtu (u8 * s, va_list * args)
318 vnet_sw_interface_t *si = va_arg (*args, vnet_sw_interface_t *);
320 return format (s, "%d/%d/%d/%d", si->mtu[VNET_MTU_L3],
321 si->mtu[VNET_MTU_IP4],
322 si->mtu[VNET_MTU_IP6], si->mtu[VNET_MTU_MPLS]);
326 format_vnet_sw_interface (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 vnet_interface_main_t *im = &vnm->interface_main;
333 return format (s, "%=32s%=5s%=10s%=21s%=16s%=16s",
334 "Name", "Idx", "State", "MTU (L3/IP4/IP6/MPLS)", "Counter",
337 s = format (s, "%-32U%=5d%=10U%=21U",
338 format_vnet_sw_interface_name, vnm, si, si->sw_if_index,
339 format_vnet_sw_interface_flags, si->flags,
340 format_vnet_sw_interface_mtu, si);
342 s = format_vnet_sw_interface_cntrs (s, im, si);
348 format_vnet_sw_interface_name_override (u8 * s, va_list * args)
350 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
351 vnet_sw_interface_t *si = va_arg (*args, vnet_sw_interface_t *);
352 /* caller supplied display name for this interface */
353 u8 *name = va_arg (*args, u8 *);
354 vnet_interface_main_t *im = &vnm->interface_main;
358 return format (s, "%=32s%=5s%=16s%=16s%=16s",
359 "Name", "Idx", "State", "Counter", "Count");
361 s = format (s, "%-32v%=5d%=16U",
362 name, si->sw_if_index,
363 format_vnet_sw_interface_flags, si->flags);
365 s = format_vnet_sw_interface_cntrs (s, im, si);
371 format_vnet_buffer_flags (u8 * s, va_list * args)
373 vlib_buffer_t *buf = va_arg (*args, vlib_buffer_t *);
375 #define _(a,b,c,v) if (buf->flags & VNET_BUFFER_F_##b) s = format (s, "%s ", c);
376 foreach_vnet_buffer_flag;
382 format_vnet_buffer_opaque (u8 * s, va_list * args)
384 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
385 vnet_buffer_opaque_t *o = (vnet_buffer_opaque_t *) b->opaque;
388 s = format (s, "raw: ");
390 for (i = 0; i < ARRAY_LEN (b->opaque); i++)
391 s = format (s, "%08x ", b->opaque[i]);
396 "sw_if_index[VLIB_RX]: %d, sw_if_index[VLIB_TX]: %d",
397 o->sw_if_index[0], o->sw_if_index[1]);
401 "L2 offset %d, L3 offset %d, L4 offset %d, feature arc index %d",
402 (u32) (o->l2_hdr_offset),
403 (u32) (o->l3_hdr_offset),
404 (u32) (o->l4_hdr_offset), (u32) (o->feature_arc_index));
408 "ip.adj_index[VLIB_RX]: %d, ip.adj_index[VLIB_TX]: %d",
409 (u32) (o->ip.adj_index[0]), (u32) (o->ip.adj_index[1]));
413 "ip.flow_hash: 0x%x, ip.save_protocol: 0x%x, ip.fib_index: %d",
414 o->ip.flow_hash, o->ip.save_protocol, o->ip.fib_index);
418 "ip.save_rewrite_length: %d, ip.rpf_id: %d",
419 o->ip.save_rewrite_length, o->ip.rpf_id);
423 "ip.icmp.type: %d ip.icmp.code: %d, ip.icmp.data: 0x%x",
424 (u32) (o->ip.icmp.type),
425 (u32) (o->ip.icmp.code), o->ip.icmp.data);
429 "ip.reass.next_index: %d, ip.reass.estimated_mtu: %d",
430 o->ip.reass.next_index, (u32) (o->ip.reass.estimated_mtu));
434 "ip.reass.fragment_first: %d ip.reass.fragment_last: %d",
435 (u32) (o->ip.reass.fragment_first),
436 (u32) (o->ip.reass.fragment_last));
440 "ip.reass.range_first: %d ip.reass.range_last: %d",
441 (u32) (o->ip.reass.range_first),
442 (u32) (o->ip.reass.range_last));
446 "ip.reass.next_range_bi: 0x%x, ip.reass.ip6_frag_hdr_offset: %d",
447 o->ip.reass.next_range_bi,
448 (u32) (o->ip.reass.ip6_frag_hdr_offset));
452 "mpls.ttl: %d, mpls.exp: %d, mpls.first: %d, "
453 "mpls.save_rewrite_length: %d, mpls.bier.n_bytes: %d",
454 (u32) (o->mpls.ttl), (u32) (o->mpls.exp), (u32) (o->mpls.first),
455 o->mpls.save_rewrite_length, (u32) (o->mpls.bier.n_bytes));
459 "l2.feature_bitmap: %08x, l2.bd_index: %d, l2.l2_len: %d, "
460 "l2.shg: %d, l2.l2fib_sn: %d, l2.bd_age: %d",
461 o->l2.feature_bitmap, (u32) (o->l2.bd_index),
462 (u32) (o->l2.l2_len), (u32) (o->l2.shg), (u32) (o->l2.l2fib_sn),
463 (u32) (o->l2.bd_age));
467 "l2t.next_index: %d, l2t.session_index: %d",
468 (u32) (o->l2t.next_index), o->l2t.session_index);
472 "l2_classify.table_index: %d, l2_classify.opaque_index: %d, "
473 "l2_classify.hash: 0x%llx",
474 o->l2_classify.table_index,
475 o->l2_classify.opaque_index, o->l2_classify.hash);
478 s = format (s, "policer.index: %d", o->policer.index);
482 "ipsec.flags: 0x%x, ipsec.sad_index: %d",
483 o->ipsec.flags, o->ipsec.sad_index);
486 s = format (s, "map.mtu: %d", (u32) (o->map.mtu));
490 "map_t.v6.saddr: 0x%x, map_t.v6.daddr: 0x%x, "
491 "map_t.v6.frag_offset: %d, map_t.v6.l4_offset: %d",
494 (u32) (o->map_t.v6.frag_offset), (u32) (o->map_t.v6.l4_offset));
498 "map_t.v6.l4_protocol: %d, map_t.checksum_offset: %d, "
500 (u32) (o->map_t.v6.l4_protocol),
501 (u32) (o->map_t.checksum_offset), (u32) (o->map_t.mtu));
505 "ip_frag.mtu: %d, ip_frag.next_index: %d, ip_frag.flags: 0x%x",
506 (u32) (o->ip_frag.mtu),
507 (u32) (o->ip_frag.next_index), (u32) (o->ip_frag.flags));
510 s = format (s, "cop.current_config_index: %d", o->cop.current_config_index);
513 s = format (s, "lisp.overlay_afi: %d", (u32) (o->lisp.overlay_afi));
517 (s, "tcp.connection_index: %d, tcp.seq_number: %d, tcp.seq_end: %d, "
518 "tcp.ack_number: %d, tcp.hdr_offset: %d, tcp.data_offset: %d",
519 o->tcp.connection_index,
523 (u32) (o->tcp.hdr_offset), (u32) (o->tcp.data_offset));
527 "tcp.data_len: %d, tcp.flags: 0x%x",
528 (u32) (o->tcp.data_len), (u32) (o->tcp.flags));
532 "sctp.connection_index: %d, sctp.sid: %d, sctp.ssn: %d, "
533 "sctp.tsn: %d, sctp.hdr_offset: %d",
534 o->sctp.connection_index,
537 (u32) (o->sctp.tsn), (u32) (o->sctp.hdr_offset));
541 (s, "sctp.data_offset: %d, sctp.data_len: %d, sctp.subconn_idx: %d, "
543 (u32) (o->sctp.data_offset),
544 (u32) (o->sctp.data_len),
545 (u32) (o->sctp.subconn_idx), (u32) (o->sctp.flags));
548 s = format (s, "snat.flags: 0x%x", o->snat.flags);
554 format_vnet_buffer_opaque2 (u8 * s, va_list * args)
556 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
557 vnet_buffer_opaque2_t *o = (vnet_buffer_opaque2_t *) b->opaque2;
561 s = format (s, "raw: ");
563 for (i = 0; i < ARRAY_LEN (b->opaque2); i++)
564 s = format (s, "%08x ", b->opaque2[i]);
567 s = format (s, "qos.bits: %x, qos.source: %x",
568 (u32) (o->qos.bits), (u32) (o->qos.source));
570 s = format (s, "loop_counter: %d", o->loop_counter);
573 s = format (s, "gbp.flags: %x, gbp.src_epg: %d",
574 (u32) (o->gbp.flags), (u32) (o->gbp.src_epg));
577 s = format (s, "pg_replay_timestamp: %llu", (u32) (o->pg_replay_timestamp));
583 unformat_vnet_hw_interface (unformat_input_t * input, va_list * args)
585 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
586 u32 *hw_if_index = va_arg (*args, u32 *);
587 vnet_interface_main_t *im = &vnm->interface_main;
588 vnet_device_class_t *c;
590 /* Try per device class functions first. */
591 vec_foreach (c, im->device_classes)
593 if (c->unformat_device_name
594 && unformat_user (input, c->unformat_device_name, hw_if_index))
598 return unformat_user (input, unformat_hash_vec_string,
599 im->hw_interface_by_name, hw_if_index);
603 unformat_vnet_sw_interface (unformat_input_t * input, va_list * args)
605 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
606 u32 *result = va_arg (*args, u32 *);
607 vnet_hw_interface_t *hi;
608 u32 hw_if_index, id, id_specified;
614 if (unformat (input, "%_%v.%d%_", &if_name, &id)
615 && ((p = hash_get (vnm->interface_main.hw_interface_by_name, if_name))))
621 if (unformat (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
626 hi = vnet_get_hw_interface (vnm, hw_if_index);
629 sw_if_index = hi->sw_if_index;
633 if (!(p = hash_get (hi->sub_interface_sw_if_index_by_id, id)))
637 if (!vnet_sw_interface_is_api_visible (vnm, sw_if_index))
639 *result = sw_if_index;
647 unformat_vnet_sw_interface_flags (unformat_input_t * input, va_list * args)
649 u32 *result = va_arg (*args, u32 *);
652 if (unformat (input, "up"))
653 flags |= VNET_SW_INTERFACE_FLAG_ADMIN_UP;
654 else if (unformat (input, "down"))
655 flags &= ~VNET_SW_INTERFACE_FLAG_ADMIN_UP;
656 else if (unformat (input, "punt"))
657 flags |= VNET_SW_INTERFACE_FLAG_PUNT;
658 else if (unformat (input, "enable"))
659 flags &= ~VNET_SW_INTERFACE_FLAG_PUNT;
668 unformat_vnet_hw_interface_flags (unformat_input_t * input, va_list * args)
670 u32 *result = va_arg (*args, u32 *);
673 if (unformat (input, "up"))
674 flags |= VNET_HW_INTERFACE_FLAG_LINK_UP;
675 else if (unformat (input, "down"))
676 flags &= ~VNET_HW_INTERFACE_FLAG_LINK_UP;
685 * fd.io coding-style-patch-verification: ON
688 * eval: (c-set-style "gnu")