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 * trace.h: VLIB trace buffer.
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 #ifndef included_vlib_trace_h
41 #define included_vlib_trace_h
43 #include <vppinfra/pool.h>
47 /* CPU time stamp trace was made. */
50 /* Node which generated this trace. */
53 /* Number of data words in this trace. */
56 /* Trace data follows. */
58 } vlib_trace_header_t;
62 /* Current number of traces in buffer. */
65 /* Max. number of traces to be added to buffer. */
69 /* Callback type for post-processing the vlib trace buffer */
71 struct vlib_trace_main_t;
72 typedef void (vlib_trace_buffer_callback_t) (struct vlib_main_t *,
73 struct vlib_trace_main_t *);
75 /* Callback type for alternate handling of vlib_add_trace internals */
76 struct vlib_node_runtime_t;
78 typedef void *(vlib_add_trace_callback_t) (struct vlib_main_t *,
79 struct vlib_node_runtime_t * r,
80 struct vlib_buffer_t * b,
83 typedef int (vlib_is_packet_traced_fn_t) (vlib_buffer_t *b,
84 u32 classify_table_index, int func);
85 typedef struct vlib_trace_filter_function_registration
88 const char *description;
90 vlib_is_packet_traced_fn_t *function;
91 struct vlib_trace_filter_function_registration *next;
92 } vlib_trace_filter_function_registration_t;
96 /* Pool of trace buffers. */
97 vlib_trace_header_t **trace_buffer_pool;
99 u32 last_main_loop_count;
100 u32 filter_node_index;
102 #define FILTER_FLAG_NONE 0
103 #define FILTER_FLAG_INCLUDE 1
104 #define FILTER_FLAG_EXCLUDE 2
105 #define FILTER_FLAG_POST_MORTEM 3
108 /* set on trace add, cleared on clear trace */
111 /* Per node trace counts. */
112 vlib_trace_node_t *nodes;
117 /* a callback to enable customized consumption of the trace buffer content */
118 vlib_trace_buffer_callback_t *trace_buffer_callback;
120 /* a callback to enable customized addition of a new trace */
121 vlib_add_trace_callback_t *add_trace_callback;
123 vlib_is_packet_traced_fn_t *current_trace_filter_function;
127 format_function_t format_vlib_trace;
130 vlib_trace_filter_function_registration_t *trace_filter_registration;
131 } vlib_trace_filter_main_t;
133 extern vlib_trace_filter_main_t vlib_trace_filter_main;
134 #define VLIB_REGISTER_TRACE_FILTER_FUNCTION(x, ...) \
135 __VA_ARGS__ vlib_trace_filter_function_registration_t \
136 __vlib_trace_filter_function_##x; \
137 static void __clib_constructor \
138 __vlib_trace_filter_function_registration_##x (void) \
140 vlib_trace_filter_main_t *tfm = &vlib_trace_filter_main; \
141 __vlib_trace_filter_function_##x.next = tfm->trace_filter_registration; \
142 tfm->trace_filter_registration = &__vlib_trace_filter_function_##x; \
144 __VA_ARGS__ vlib_trace_filter_function_registration_t \
145 __vlib_trace_filter_function_##x
147 vlib_is_packet_traced_fn_t *
148 vlib_is_packet_traced_function_from_name (const char *name);
149 vlib_is_packet_traced_fn_t *vlib_is_packet_traced_default_function ();
150 void trace_apply_filter (struct vlib_main_t *vm);
151 int trace_time_cmp (void *a1, void *a2);
152 void vlib_trace_stop_and_clear (void);
153 int vlib_enable_disable_pkt_trace_filter (int enable) __attribute__ ((weak));
154 void trace_update_capture_options (u32 add, u32 node_index,
155 u32 filter, u8 verbose);
156 void trace_filter_set (u32 node_index, u32 flag, u32 count);
157 void clear_trace_buffer (void);
158 void vlib_set_trace_filter_function (vlib_is_packet_traced_fn_t *x);
159 uword unformat_vlib_trace_filter_function (unformat_input_t *input,
162 #endif /* included_vlib_trace_h */
165 * fd.io coding-style-patch-verification: ON
168 * eval: (c-set-style "gnu")