FD.io VPP  v21.01.1
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: pvh - Return vector header of vector
42  *
43  * @param *p - void - address of vector
44  *
45  * @return vh - vec_header_t, the vector header
46  *
47  */
49 pvh (void *p)
50 {
51  return _vec_find (p);
52 }
53 
54 
55 /**
56  * @brief GDB callable function: pe - call pool_elts - number of elements in a pool
57  *
58  * @param *v - void - address of pool
59  *
60  * @return number - uword
61  *
62  */
63 uword
64 pe (void *v)
65 {
66  return (pool_elts (v));
67 }
68 
69 /**
70  * @brief GDB callable function: ph - call pool_header - get pool header.
71  *
72  * @param *p - void - address of pool
73  *
74  * @return pool_header_t
75  *
76  */
78 ph (void *p)
79 {
80  return pool_header (p);
81 }
82 
83 /**
84  * @brief GDB callable function: pifi - call pool_is_free_index - is passed index free?
85  *
86  * @param *p - void - address of pool
87  * @param *index - u32
88  *
89  * @return 0|1 - int
90  *
91  */
92 int
93 pifi (void *p, u32 index)
94 {
95  return pool_is_free_index (p, index);
96 }
97 
98 /**
99  * @brief GDB callable function: debug_hex_bytes - return formatted hex string
100  *
101  * @param *s - u8
102  * @param n - u32 - number of bytes to format
103  *
104  */
105 void
107 {
108  fformat (stderr, "%U\n", format_hex_bytes, s, n);
109 }
110 
111 /**
112  * @brief GDB callable function: vlib_dump_frame_ownership
113  *
114  */
115 void
117 {
119  vlib_node_main_t *nm = &vm->node_main;
120  vlib_node_runtime_t *this_node_runtime;
121  vlib_next_frame_t *nf;
122  u32 first_nf_index;
123  u32 index;
124 
125  vec_foreach (this_node_runtime, nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
126  {
127  first_nf_index = this_node_runtime->next_frame_index;
128 
129  for (index = first_nf_index; index < first_nf_index +
130  this_node_runtime->n_next_nodes; index++)
131  {
132  vlib_node_runtime_t *owned_runtime;
133  nf = vec_elt_at_index (vm->node_main.next_frames, index);
134  if (nf->flags & VLIB_FRAME_OWNER)
135  {
136  owned_runtime = vec_elt_at_index (nm->nodes_by_type[0],
137  nf->node_runtime_index);
138  fformat (stderr,
139  "%s next index %d owns enqueue rights to %s\n",
140  nm->nodes[this_node_runtime->node_index]->name,
141  index - first_nf_index,
142  nm->nodes[owned_runtime->node_index]->name);
143  fformat (stderr, " nf index %d nf->frame %p\n",
144  nf - vm->node_main.next_frames, nf->frame);
145  }
146  }
147  }
148 }
149 
150 /**
151  * @brief GDB callable function: vlib_runtime_index_to_node_name
152  *
153  * Takes node index and will return the node name.
154  *
155  * @param index - u32
156  */
157 void
159 {
161  vlib_node_main_t *nm = &vm->node_main;
162 
163  if (index >= vec_len (nm->nodes))
164  {
165  fformat (stderr, "%d out of range, max %d\n", vec_len (nm->nodes));
166  return;
167  }
168 
169  fformat (stderr, "node runtime index %d name %s\n", index,
170  nm->nodes[index]->name);
171 }
172 
173 void
174 gdb_show_errors (int verbose)
175 {
177  unformat_input_t input;
179 
180  if (verbose == 0)
181  unformat_init_string (&input, "verbose 0", 9);
182  else if (verbose == 1)
183  unformat_init_string (&input, "verbose 1", 9);
184  else
185  {
186  fformat (stderr, "verbose not 0 or 1\n");
187  return;
188  }
189 
190  vlib_cli_show_errors.function (vm, &input, 0 /* cmd */ );
191  unformat_free (&input);
192 }
193 
194 void
195 gdb_show_session (int verbose)
196 {
198  unformat_input_t input;
200 
201  if (verbose == 0)
202  unformat_init_string (&input, "verbose 0", 9);
203  else if (verbose == 1)
204  unformat_init_string (&input, "verbose 1", 9);
205  else if (verbose == 2)
206  unformat_init_string (&input, "verbose 2", 9);
207  else
208  {
209  fformat (stderr, "verbose not 0 - 2\n");
210  return;
211  }
212 
213  vlib_cli_show_session_command.function (vm, &input, 0 /* cmd */ );
214  unformat_free (&input);
215 }
216 
217 static int
218 trace_cmp (void *a1, void *a2)
219 {
220  vlib_trace_header_t **t1 = a1;
221  vlib_trace_header_t **t2 = a2;
222  i64 dt = t1[0]->time - t2[0]->time;
223  return dt < 0 ? -1 : (dt > 0 ? +1 : 0);
224 }
225 
226 void
228 {
229  vlib_trace_main_t *tm;
230  vlib_trace_header_t **h, **traces;
231  u32 i, index = 0;
232  char *fmt;
233  u8 *s = 0;
234  u32 max;
235 
236  /* By default display only this many traces. */
237  max = 50;
238 
239  /* Get active traces from pool. */
240 
241  /* *INDENT-OFF* */
243  ({
244  fmt = "------------------- Start of thread %d %s -------------------\n";
245  s = format (s, fmt, index, vlib_worker_threads[index].name);
246 
247  tm = &this_vlib_main->trace_main;
248 
249  trace_apply_filter(this_vlib_main);
250 
251  traces = 0;
253  {
254  vec_add1 (traces, h[0]);
255  }
256 
257  if (vec_len (traces) == 0)
258  {
259  s = format (s, "No packets in trace buffer\n");
260  goto done;
261  }
262 
263  /* Sort them by increasing time. */
265 
266  for (i = 0; i < vec_len (traces); i++)
267  {
268  if (i == max)
269  {
270  fformat (stderr, "Limiting display to %d packets."
271  " To display more specify max.", max);
272  goto done;
273  }
274 
275  s = format (s, "Packet %d\n%U\n\n", i + 1,
276  format_vlib_trace, vlib_mains[0], traces[i]);
277  }
278 
279  done:
280  vec_free (traces);
281 
282  index++;
283  }));
284  /* *INDENT-ON* */
285 
286  fformat (stderr, "%v", s);
287  vec_free (s);
288 }
289 
290 /**
291  * @brief GDB callable function: show_gdb_command_fn - show gdb
292  *
293  * Shows list of functions for VPP available in GDB
294  *
295  * @return error - clib_error_t
296  */
297 static clib_error_t *
299  unformat_input_t * input, vlib_cli_command_t * cmd)
300 {
301  vlib_cli_output (vm, "vl(p) returns vec_len(p)");
302  vlib_cli_output (vm, "vb(b) returns vnet_buffer(b) [opaque]");
303  vlib_cli_output (vm, "vb2(b) returns vnet_buffer2(b) [opaque2]");
304  vlib_cli_output (vm, "vbi(b) returns b index");
305  vlib_cli_output (vm,
306  "vgb(bi) returns vlib_get_buffer(vlib_get_main(), bi)");
307  vlib_cli_output (vm, "pe(p) returns pool_elts(p)");
308  vlib_cli_output (vm, "ph(p) returns pool_header(p)");
309  vlib_cli_output (vm, "pifi(p, i) returns pool_is_free_index(p, i)");
310  vlib_cli_output (vm, "gdb_show_errors(0|1) dumps error counters");
311  vlib_cli_output (vm, "gdb_show_session dumps session counters");
312  vlib_cli_output (vm, "gdb_show_traces() dumps buffer traces");
313  vlib_cli_output (vm, "gdb_validate_buffer(b) check vlib_buffer b sanity");
314  vlib_cli_output (vm, "debug_hex_bytes (ptr, n_bytes) dumps n_bytes in hex");
315  vlib_cli_output (vm, "vlib_dump_frame_ownership() does what it says");
316  vlib_cli_output (vm, "vlib_runtime_index_to_node_name (index) prints NN");
317 
318  return 0;
319 }
320 
321 /* *INDENT-OFF* */
322 VLIB_CLI_COMMAND (show_gdb_funcs_command, static) = {
323  .path = "show gdb",
324  .short_help = "Describe functions which can be called from gdb",
325  .function = show_gdb_command_fn,
326 };
327 /* *INDENT-ON* */
328 
330 vgb (u32 bi)
331 {
332  return vlib_get_buffer (vlib_get_main (), bi);
333 }
334 
336 vb (void *vb_arg)
337 {
338  vlib_buffer_t *b = (vlib_buffer_t *) vb_arg;
340 
341  rv = vnet_buffer (b);
342 
343  return rv;
344 }
345 
347 vb2 (void *vb_arg)
348 {
349  vlib_buffer_t *b = (vlib_buffer_t *) vb_arg;
351 
352  rv = vnet_buffer2 (b);
353 
354  return rv;
355 }
356 
357 u32
359 {
362  u32 bi = pointer_to_uword (b) - bm->buffer_mem_start;
364  return bi;
365 }
366 
367 int
369 {
371  u32 bi = vbi (b);
372  u8 *s =
374  if (s)
375  {
376  fformat (stderr, "gdb_validate_buffer(): %v", s);
377  return -1;
378  }
379  fformat (stderr, "gdb_validate_buffer(): no error found\n");
380  return 0;
381 }
382 
383 /* Cafeteria plan, maybe you don't want these functions */
384 clib_error_t *
386 {
387  return 0;
388 }
389 
391 
392 /*
393  * fd.io coding-style-patch-verification: ON
394  *
395  * Local Variables:
396  * eval: (c-set-style "gnu")
397  * End:
398  */
void vlib_runtime_index_to_node_name(u32 index)
GDB callable function: vlib_runtime_index_to_node_name.
Definition: gdb_funcs.c:158
u32 next_frame_index
Start of next frames for this node.
Definition: node.h:485
#define vnet_buffer2(b)
Definition: buffer.h:481
#define pool_foreach(VAR, POOL)
Iterate through pool.
Definition: pool.h:527
#define CLIB_LOG2_CACHE_LINE_BYTES
Definition: cache.h:50
u32 vbi(vlib_buffer_t *b)
Definition: gdb_funcs.c:358
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:592
vlib_buffer_main_t * buffer_main
Definition: main.h:182
vlib_main_t * vm
Definition: in2out_ed.c:1580
void vlib_dump_frame_ownership(void)
GDB callable function: vlib_dump_frame_ownership.
Definition: gdb_funcs.c:116
void gdb_show_traces()
Definition: gdb_funcs.c:227
vlib_main_t ** vlib_mains
Definition: buffer.c:332
unsigned char u8
Definition: types.h:56
vlib_buffer_t * vgb(u32 bi)
Definition: gdb_funcs.c:330
vnet_buffer_opaque_t * vb(void *vb_arg)
Definition: gdb_funcs.c:336
__clib_export word fformat(FILE *f, char *fmt,...)
Definition: format.c:462
void gdb_show_session(int verbose)
Definition: gdb_funcs.c:195
vlib_trace_header_t ** trace_buffer_pool
Definition: trace.h:86
void debug_hex_bytes(u8 *s, u32 n)
GDB callable function: debug_hex_bytes - return formatted hex string.
Definition: gdb_funcs.c:106
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:173
vlib_node_t ** nodes
Definition: node.h:680
description fragment has unexpected format
Definition: map.api:433
#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
const cJSON *const b
Definition: cJSON.h:255
unsigned int u32
Definition: types.h:88
vlib_node_runtime_t * nodes_by_type[VLIB_N_NODE_TYPE]
Definition: node.h:690
pool_header_t * ph(void *p)
GDB callable function: ph - call pool_header - get pool header.
Definition: gdb_funcs.c:78
void unformat_init_string(unformat_input_t *input, char *string, int string_len)
Definition: unformat.c:1029
static pool_header_t * pool_header(void *v)
Get pool header from user pool pointer.
Definition: pool.h:76
vlib_worker_thread_t * vlib_worker_threads
Definition: threads.c:34
vlib_cli_command_t vlib_cli_show_errors
(constructor) VLIB_CLI_COMMAND (vlib_cli_show_errors)
Definition: error.c:316
vlib_cli_command_function_t * function
Definition: cli.h:102
format_function_t format_vlib_trace
Definition: trace.h:114
vlib_cli_command_t vlib_cli_show_session_command
(constructor) VLIB_CLI_COMMAND (vlib_cli_show_session_command)
Definition: session_cli.c:666
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:298
struct _unformat_input_t unformat_input_t
signed long i64
Definition: types.h:78
vec_header_t h
Definition: buffer.c:322
u32 node_index
Node index.
Definition: node.h:488
#define foreach_vlib_main(body)
Definition: threads.h:242
int cJSON_bool fmt
Definition: cJSON.h:160
vec_header_t * pvh(void *p)
GDB callable function: pvh - Return vector header of vector.
Definition: gdb_funcs.c:49
u8 * name
Definition: node.h:264
sll srl srl sll sra u16x4 i
Definition: vector_sse42.h:317
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:380
#define pool_is_free_index(P, I)
Use free bitmap to query whether given index is free.
Definition: pool.h:298
vnet_buffer_opaque2_t * vb2(void *vb_arg)
Definition: gdb_funcs.c:347
string name[64]
Definition: ip.api:44
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:158
clib_error_t * gdb_func_init(vlib_main_t *vm)
Definition: gdb_funcs.c:385
void vlib_cli_output(vlib_main_t *vm, char *fmt,...)
Definition: cli.c:696
int gdb_validate_buffer(vlib_buffer_t *b)
Definition: gdb_funcs.c:368
vlib_frame_t * frame
Definition: node.h:406
int pifi(void *p, u32 index)
GDB callable function: pifi - call pool_is_free_index - is passed index free?
Definition: gdb_funcs.c:93
vector header structure
Definition: vec_bootstrap.h:55
uword pe(void *v)
GDB callable function: pe - call pool_elts - number of elements in a pool.
Definition: gdb_funcs.c:64
static uword pointer_to_uword(const void *p)
Definition: types.h:131
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
#define VLIB_FRAME_OWNER
Definition: node.h:423
u32 vl(void *p)
GDB callable function: vl - Return vector length of vector.
Definition: gdb_funcs.c:35
static int trace_cmp(void *a1, void *a2)
Definition: gdb_funcs.c:218
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
vlib_node_main_t node_main
Definition: main.h:188
VLIB buffer representation.
Definition: buffer.h:102
u64 uword
Definition: types.h:112
vlib_next_frame_t * next_frames
Definition: node.h:705
#define vec_sort_with_function(vec, f)
Sort a vector using the supplied element comparison function.
Definition: vec.h:1055
static void unformat_free(unformat_input_t *i)
Definition: format.h:162
uword buffer_mem_start
Definition: buffer.h:456
u8 * vlib_validate_buffers(vlib_main_t *vm, u32 *buffers, uword next_buffer_stride, uword n_buffers, vlib_buffer_known_state_t known_state, uword follow_buffer_next)
Definition: buffer.c:261
u32 index
Definition: flow_types.api:221
#define vnet_buffer(b)
Definition: buffer.h:417
#define vec_foreach(var, vec)
Vector iterator.
u32 node_runtime_index
Definition: node.h:409
static vlib_buffer_t * vlib_get_buffer(vlib_main_t *vm, u32 buffer_index)
Translate buffer index into buffer pointer.
Definition: buffer_funcs.h:85
void trace_apply_filter(vlib_main_t *vm)
Definition: trace.c:242
void gdb_show_errors(int verbose)
Definition: gdb_funcs.c:174
static uword pool_elts(void *v)
Number of active elements in a pool.
Definition: pool.h:127