FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
gdb_funcs.c
Go to the documentation of this file.
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  * @file
17  * @brief Host utility functions
18  */
19 #include <vppinfra/format.h>
20 #include <vlib/vlib.h>
21 
22 #include <vlib/threads.h>
23 #include <vnet/vnet.h>
24 #include <vppinfra/format.h>
25 
26 /**
27  * @brief GDB callable function: vl - Return vector length of vector
28  *
29  * @param *p - void - address of vector
30  *
31  * @return length - u32
32  *
33  */
34 u32
35 vl (void *p)
36 {
37  return vec_len (p);
38 }
39 
40 /**
41  * @brief GDB callable function: pe - call pool_elts - number of elements in a pool
42  *
43  * @param *v - void - address of pool
44  *
45  * @return number - uword
46  *
47  */
48 uword
49 pe (void *v)
50 {
51  return (pool_elts (v));
52 }
53 
54 /**
55  * @brief GDB callable function: pifi - call pool_is_free_index - is passed index free?
56  *
57  * @param *p - void - address of pool
58  * @param *index - u32
59  *
60  * @return 0|1 - int
61  *
62  */
63 int
64 pifi (void *p, u32 index)
65 {
66  return pool_is_free_index (p, index);
67 }
68 
69 /**
70  * @brief GDB callable function: debug_hex_bytes - return formatted hex string
71  *
72  * @param *s - u8
73  * @param n - u32 - number of bytes to format
74  *
75  */
76 void
78 {
79  fformat (stderr, "%U\n", format_hex_bytes, s, n);
80 }
81 
82 /**
83  * @brief GDB callable function: vlib_dump_frame_ownership
84  *
85  */
86 void
88 {
90  vlib_node_main_t *nm = &vm->node_main;
91  vlib_node_runtime_t *this_node_runtime;
93  u32 first_nf_index;
94  u32 index;
95 
96  vec_foreach (this_node_runtime, nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
97  {
98  first_nf_index = this_node_runtime->next_frame_index;
99 
100  for (index = first_nf_index; index < first_nf_index +
101  this_node_runtime->n_next_nodes; index++)
102  {
103  vlib_node_runtime_t *owned_runtime;
104  nf = vec_elt_at_index (vm->node_main.next_frames, index);
105  if (nf->flags & VLIB_FRAME_OWNER)
106  {
107  owned_runtime = vec_elt_at_index (nm->nodes_by_type[0],
108  nf->node_runtime_index);
109  fformat (stderr,
110  "%s next index %d owns enqueue rights to %s\n",
111  nm->nodes[this_node_runtime->node_index]->name,
112  index - first_nf_index,
113  nm->nodes[owned_runtime->node_index]->name);
114  fformat (stderr, " nf index %d nf->frame_index %d\n",
115  nf - vm->node_main.next_frames, nf->frame_index);
116  }
117  }
118  }
119 }
120 
121 /**
122  * @brief GDB callable function: vlib_runtime_index_to_node_name
123  *
124  * Takes node index and will return the node name.
125  *
126  * @param index - u32
127  */
128 void
130 {
132  vlib_node_main_t *nm = &vm->node_main;
133 
134  if (index > vec_len (nm->nodes))
135  {
136  fformat (stderr, "%d out of range, max %d\n", vec_len (nm->nodes));
137  return;
138  }
139 
140  fformat (stderr, "node runtime index %d name %s\n", index,
141  nm->nodes[index]->name);
142 }
143 
144 void
145 gdb_show_errors (int verbose)
146 {
148  unformat_input_t input;
150 
151  if (verbose == 0)
152  unformat_init_string (&input, "verbose 0", 9);
153  else if (verbose == 1)
154  unformat_init_string (&input, "verbose 1", 9);
155  else
156  {
157  fformat (stderr, "verbose not 0 or 1\n");
158  return;
159  }
160 
161  vlib_cli_show_errors.function (vm, &input, 0 /* cmd */ );
162  unformat_free (&input);
163 }
164 
165 void
166 gdb_show_session (int verbose)
167 {
169  unformat_input_t input;
171 
172  if (verbose == 0)
173  unformat_init_string (&input, "verbose 0", 9);
174  else if (verbose == 1)
175  unformat_init_string (&input, "verbose 1", 9);
176  else if (verbose == 2)
177  unformat_init_string (&input, "verbose 2", 9);
178  else
179  {
180  fformat (stderr, "verbose not 0 - 2\n");
181  return;
182  }
183 
184  vlib_cli_show_session_command.function (vm, &input, 0 /* cmd */ );
185  unformat_free (&input);
186 }
187 
188 /**
189  * @brief GDB callable function: show_gdb_command_fn - show gdb
190  *
191  * Shows list of functions for VPP available in GDB
192  *
193  * @return error - clib_error_t
194  */
195 static clib_error_t *
197  unformat_input_t * input, vlib_cli_command_t * cmd)
198 {
199  vlib_cli_output (vm, "vl(p) returns vec_len(p)");
200  vlib_cli_output (vm, "vb(b) returns vnet_buffer(b) [opaque]");
201  vlib_cli_output (vm, "vb2(b) returns vnet_buffer2(b) [opaque2]");
202  vlib_cli_output (vm, "pe(p) returns pool_elts(p)");
203  vlib_cli_output (vm, "pifi(p, i) returns pool_is_free_index(p, i)");
204  vlib_cli_output (vm, "gdb_show_errors(0|1) dumps error counters");
205  vlib_cli_output (vm, "gdb_show_session dumps session counters");
206  vlib_cli_output (vm, "debug_hex_bytes (ptr, n_bytes) dumps n_bytes in hex");
207  vlib_cli_output (vm, "vlib_dump_frame_ownership() does what it says");
208  vlib_cli_output (vm, "vlib_runtime_index_to_node_name (index) prints NN");
209 
210  return 0;
211 }
212 
213 /* *INDENT-OFF* */
214 VLIB_CLI_COMMAND (show_gdb_funcs_command, static) = {
215  .path = "show gdb",
216  .short_help = "Describe functions which can be called from gdb",
217  .function = show_gdb_command_fn,
218 };
219 /* *INDENT-ON* */
220 
222 vb (void *vb_arg)
223 {
224  vlib_buffer_t *b = (vlib_buffer_t *) vb_arg;
226 
227  rv = vnet_buffer (b);
228 
229  return rv;
230 }
231 
233 vb2 (void *vb_arg)
234 {
235  vlib_buffer_t *b = (vlib_buffer_t *) vb_arg;
237 
238  rv = vnet_buffer2 (b);
239 
240  return rv;
241 }
242 
243 
244 /* Cafeteria plan, maybe you don't want these functions */
245 clib_error_t *
247 {
248  return 0;
249 }
250 
252 
253 /*
254  * fd.io coding-style-patch-verification: ON
255  *
256  * Local Variables:
257  * eval: (c-set-style "gnu")
258  * End:
259  */
void vlib_runtime_index_to_node_name(u32 index)
GDB callable function: vlib_runtime_index_to_node_name.
Definition: gdb_funcs.c:129
u32 next_frame_index
Start of next frames for this node.
Definition: node.h:434
#define vnet_buffer2(b)
Definition: buffer.h:344
#define VLIB_FRAME_OWNER
Definition: node.h:367
void vlib_dump_frame_ownership(void)
GDB callable function: vlib_dump_frame_ownership.
Definition: gdb_funcs.c:87
vnet_buffer_opaque_t * vb(void *vb_arg)
Definition: gdb_funcs.c:222
void gdb_show_session(int verbose)
Definition: gdb_funcs.c:166
void debug_hex_bytes(u8 *s, u32 n)
GDB callable function: debug_hex_bytes - return formatted hex string.
Definition: gdb_funcs.c:77
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:111
vlib_node_t ** nodes
Definition: node.h:640
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
u8 * format_hex_bytes(u8 *s, va_list *va)
Definition: std-formats.c:84
vlib_node_runtime_t * nodes_by_type[VLIB_N_NODE_TYPE]
Definition: node.h:650
void unformat_init_string(unformat_input_t *input, char *string, int string_len)
Definition: unformat.c:1023
vlib_cli_command_t vlib_cli_show_errors
(constructor) VLIB_CLI_COMMAND (vlib_cli_show_errors)
Definition: error.c:283
u32 frame_index
Definition: node.h:353
vlib_cli_command_function_t * function
Definition: cli.h:102
vlib_cli_command_t vlib_cli_show_session_command
(constructor) VLIB_CLI_COMMAND (vlib_cli_show_session_command)
Definition: session_cli.c:302
static clib_error_t * show_gdb_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
GDB callable function: show_gdb_command_fn - show gdb.
Definition: gdb_funcs.c:196
#define v
Definition: acl.c:341
struct _unformat_input_t unformat_input_t
u32 node_index
Node index.
Definition: node.h:437
word fformat(FILE *f, char *fmt,...)
Definition: format.c:453
u8 * name
Definition: node.h:221
vlib_main_t * vm
Definition: buffer.c:283
#define pool_is_free_index(P, I)
Use free bitmap to query whether given index is free.
Definition: pool.h:268
vnet_buffer_opaque2_t * vb2(void *vb_arg)
Definition: gdb_funcs.c:233
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:154
clib_error_t * gdb_func_init(vlib_main_t *vm)
Definition: gdb_funcs.c:246
unsigned int u32
Definition: types.h:88
int pifi(void *p, u32 index)
GDB callable function: pifi - call pool_is_free_index - is passed index free?
Definition: gdb_funcs.c:64
uword pe(void *v)
GDB callable function: pe - call pool_elts - number of elements in a pool.
Definition: gdb_funcs.c:49
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
u64 uword
Definition: types.h:112
u32 vl(void *p)
GDB callable function: vl - Return vector length of vector.
Definition: gdb_funcs.c:35
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
unsigned char u8
Definition: types.h:56
vlib_node_main_t node_main
Definition: main.h:129
vlib_next_frame_t * next_frames
Definition: node.h:663
static void unformat_free(unformat_input_t *i)
Definition: format.h:161
#define vnet_buffer(b)
Definition: buffer.h:326
#define vec_foreach(var, vec)
Vector iterator.
u32 node_runtime_index
Definition: node.h:356
void vlib_cli_output(vlib_main_t *vm, char *fmt,...)
Definition: cli.c:680
void gdb_show_errors(int verbose)
Definition: gdb_funcs.c:145
static uword pool_elts(void *v)
Number of active elements in a pool.
Definition: pool.h:128