aboutsummaryrefslogtreecommitdiffstats
path: root/src/vlib/trace.h
blob: f83a6d11e51fc7609d366e269e7562ba46ca2d31 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
/*
 * Copyright (c) 2015 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/*
 * trace.h: VLIB trace buffer.
 *
 * Copyright (c) 2008 Eliot Dresselhaus
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef included_vlib_trace_h
#define included_vlib_trace_h

#include <vppinfra/pool.h>

typedef struct
{
  /* CPU time stamp trace was made. */
  u64 time;

  /* Node which generated this trace. */
  u32 node_index;

  /* Number of data words in this trace. */
  u32 n_data;

  /* Trace data follows. */
  u8 data[0];
} vlib_trace_header_t;

typedef struct
{
  /* Current number of traces in buffer. */
  u32 count;

  /* Max. number of traces to be added to buffer. */
  u32 limit;
} vlib_trace_node_t;

/* Callback type for post-processing the vlib trace buffer */
struct vlib_main_t;
struct vlib_trace_main_t;
typedef void (vlib_trace_buffer_callback_t) (struct vlib_main_t *,
					     struct vlib_trace_main_t *);

/* Callback type for alternate handling of vlib_add_trace internals */
struct vlib_node_runtime_t;
struct vlib_buffer_t;
typedef void *(vlib_add_trace_callback_t) (struct vlib_main_t *,
					   struct vlib_node_runtime_t * r,
					   struct vlib_buffer_t * b,
					   u32 n_data_bytes);

typedef struct
{
  /* Pool of trace buffers. */
  vlib_trace_header_t **trace_buffer_pool;

  u32 last_main_loop_count;
  u32 filter_node_index;
  u32 filter_flag;
#define FILTER_FLAG_NONE    0
#define FILTER_FLAG_INCLUDE 1
#define FILTER_FLAG_EXCLUDE 2
  u32 filter_count;

  /* set on trace add, cleared on clear trace */
  u32 trace_enable;

  /* Per node trace counts. */
  vlib_trace_node_t *nodes;

  /* verbosity */
  int verbose;

  /* a callback to enable customized consumption of the trace buffer content */
  vlib_trace_buffer_callback_t *trace_buffer_callback;

  /* a callback to enable customized addition of a new trace */
  vlib_add_trace_callback_t *add_trace_callback;

} vlib_trace_main_t;

format_function_t format_vlib_trace;

#endif /* included_vlib_trace_h */

/*
 * fd.io coding-style-patch-verification: ON
 *
 * Local Variables:
 * eval: (c-set-style "gnu")
 * End:
 */
s="p">(val)) for (key, val) in api_args.items()) self.logger.debug("API: %s (%s)" % (api_name, _args), extra={'color': RED}) def after_api(self, api_name, api_args): """ Function called after API call @param api_name: name of the API @param api_args: tuple containing the API arguments """ pass def before_cli(self, cli): """ Function called before CLI call Emit a debug message describing the CLI @param cli: CLI string """ self.logger.debug("CLI: %s" % (cli), extra={'color': RED}) def after_cli(self, cli): """ Function called after CLI call """ pass class VppDiedError(Exception): pass class PollHook(Hook): """ Hook which checks if the vpp subprocess is alive """ def __init__(self, test): super(PollHook, self).__init__(test) def on_crash(self, core_path): self.logger.error("Core file present, debug with: gdb %s %s", self.test.vpp_bin, core_path) check_core_path(self.logger, core_path) self.logger.error("Running `file %s':", core_path) try: info = check_output(["file", core_path]) self.logger.error(info) except CalledProcessError as e: self.logger.error( "Subprocess returned with error running `file' utility on " "core-file, " "rc=%s", e.returncode) except OSError as e: self.logger.error( "Subprocess returned OS error running `file' utility on " "core-file, " "oserror=(%s) %s", e.errno, e.strerror) except Exception as e: self.logger.error( "Subprocess returned unanticipated error running `file' " "utility on core-file, " "%s", e) def poll_vpp(self): """ Poll the vpp status and throw an exception if it's not running :raises VppDiedError: exception if VPP is not running anymore """ if self.test.vpp_dead: # already dead, nothing to do return self.test.vpp.poll() if self.test.vpp.returncode is not None: signaldict = dict( (k, v) for v, k in reversed(sorted(signal.__dict__.items())) if v.startswith('SIG') and not v.startswith('SIG_')) if self.test.vpp.returncode in signaldict: s = signaldict[abs(self.test.vpp.returncode)] else: s = "unknown" msg = "VPP subprocess died unexpectedly with returncode %d [%s]." \ % (self.test.vpp.returncode, s) self.logger.critical(msg) core_path = get_core_path(self.test.tempdir) if os.path.isfile(core_path): self.on_crash(core_path) self.test.vpp_dead = True raise VppDiedError(msg) def before_api(self, api_name, api_args): """ Check if VPP died before executing an API :param api_name: name of the API :param api_args: tuple containing the API arguments :raises VppDiedError: exception if VPP is not running anymore """ super(PollHook, self).before_api(api_name, api_args) self.poll_vpp() def before_cli(self, cli): """ Check if VPP died before executing a CLI :param cli: CLI string :raises Exception: exception if VPP is not running anymore """ super(PollHook, self).before_cli(cli) self.poll_vpp() class StepHook(PollHook): """ Hook which requires user to press ENTER before doing any API/CLI """ def __init__(self, test): self.skip_stack = None self.skip_num = None self.skip_count = 0 super(StepHook, self).__init__(test) def skip(self): if self.skip_stack is None: return False stack = traceback.extract_stack() counter = 0 skip = True for e in stack: if counter > self.skip_num: break if e[0] != self.skip_stack[counter][0]: skip = False if e[1] != self.skip_stack[counter][1]: skip = False counter += 1 if skip: self.skip_count += 1 return True else: print("%d API/CLI calls skipped in specified stack " "frame" % self.skip_count) self.skip_count = 0 self.skip_stack = None self.skip_num = None return False def user_input(self): print('number\tfunction\tfile\tcode') counter = 0 stack = traceback.extract_stack() for e in stack: print('%02d.\t%s\t%s:%d\t[%s]' % (counter, e[2], e[0], e[1], e[3])) counter += 1 print(single_line_delim) print("You may enter a number of stack frame chosen from above") print("Calls in/below that stack frame will be not be stepped anymore") print(single_line_delim) while True: print("Enter your choice, if any, and press ENTER to continue " "running the testcase...") choice = sys.stdin.readline().rstrip('\r\n') if choice == "": choice = None try: if choice is not None: num = int(choice) except ValueError: print("Invalid input") continue if choice is not None and (num < 0 or num >= len(stack)): print("Invalid choice") continue break if choice is not None: self.skip_stack = stack self.skip_num = num def before_cli(self, cli): """ Wait for ENTER before executing CLI """ if self.skip(): print("Skip pause before executing CLI: %s" % cli) else: print(double_line_delim) print("Test paused before executing CLI: %s" % cli) print(single_line_delim) self.user_input() super(StepHook, self).before_cli(cli) def before_api(self, api_name, api_args): """ Wait for ENTER before executing API """ if self.skip(): print("Skip pause before executing API: %s (%s)" % (api_name, api_args)) else: print(double_line_delim) print("Test paused before executing API: %s (%s)" % (api_name, api_args)) print(single_line_delim) self.user_input() super(StepHook, self).before_api(api_name, api_args)