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_funcs.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_funcs_h
41 #define included_vlib_trace_funcs_h
43 extern u8 *vnet_trace_placeholder;
46 vlib_validate_trace (vlib_trace_main_t * tm, vlib_buffer_t * b)
48 ASSERT (!pool_is_free_index (tm->trace_buffer_pool,
49 vlib_buffer_get_trace_index (b)));
52 int vlib_add_handoff_trace (vlib_main_t * vm, vlib_buffer_t * b);
55 vlib_add_trace_inline (vlib_main_t * vm,
56 vlib_node_runtime_t * r, vlib_buffer_t * b,
59 vlib_trace_main_t *tm = &vm->trace_main;
60 vlib_trace_header_t *h;
63 ASSERT (vnet_trace_placeholder);
65 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_IS_TRACED) == 0))
66 return vnet_trace_placeholder;
68 if (PREDICT_FALSE (tm->add_trace_callback != 0))
70 return tm->add_trace_callback ((struct vlib_main_t *) vm,
71 (struct vlib_node_runtime_t *) r,
72 (struct vlib_buffer_t *) b,
75 else if (PREDICT_FALSE (tm->trace_enable == 0))
77 ASSERT (vec_len (vnet_trace_placeholder) >= n_data_bytes + sizeof (*h));
78 return vnet_trace_placeholder;
81 /* Are we trying to trace a handoff case? */
82 if (PREDICT_FALSE (vlib_buffer_get_trace_thread (b) != vm->thread_index))
83 if (PREDICT_FALSE (!vlib_add_handoff_trace (vm, b)))
84 return vnet_trace_placeholder;
86 vlib_validate_trace (tm, b);
88 n_data_bytes = round_pow2 (n_data_bytes, sizeof (h[0]));
89 n_data_words = n_data_bytes / sizeof (h[0]);
90 vec_add2_aligned (tm->trace_buffer_pool[vlib_buffer_get_trace_index (b)], h,
91 1 + n_data_words, sizeof (h[0]));
93 h->time = vm->cpu_time_last_node_dispatch;
94 h->n_data = n_data_words;
95 h->node_index = r->node_index;
100 /* Non-inline (typical use-case) version of the above */
101 void *vlib_add_trace (vlib_main_t * vm,
102 vlib_node_runtime_t * r, vlib_buffer_t * b,
105 always_inline vlib_trace_header_t *
106 vlib_trace_header_next (vlib_trace_header_t * h)
108 return h + 1 + h->n_data;
112 vlib_free_trace (vlib_main_t * vm, vlib_buffer_t * b)
114 vlib_trace_main_t *tm = &vm->trace_main;
115 u32 trace_index = vlib_buffer_get_trace_index (b);
116 vlib_validate_trace (tm, b);
117 _vec_len (tm->trace_buffer_pool[trace_index]) = 0;
118 pool_put_index (tm->trace_buffer_pool, trace_index);
122 vlib_trace_next_frame (vlib_main_t * vm,
123 vlib_node_runtime_t * r, u32 next_index)
125 vlib_next_frame_t *nf;
126 nf = vlib_node_runtime_get_next_frame (vm, r, next_index);
127 nf->flags |= VLIB_FRAME_TRACE;
130 void trace_apply_filter (vlib_main_t * vm);
131 int vnet_is_packet_traced (vlib_buffer_t * b,
132 u32 classify_table_index, int func);
136 * Mark buffer as traced and allocate trace buffer.
137 * return 1 if the buffer is successfully traced, 0 if not
138 * A buffer might not be traced if tracing is off or if the packet did not
141 always_inline __clib_warn_unused_result int
142 vlib_trace_buffer (vlib_main_t * vm,
143 vlib_node_runtime_t * r,
144 u32 next_index, vlib_buffer_t * b, int follow_chain)
146 vlib_trace_main_t *tm = &vm->trace_main;
147 vlib_trace_header_t **h;
149 if (PREDICT_FALSE (tm->trace_enable == 0))
152 /* Classifier filter in use? */
153 if (PREDICT_FALSE (vlib_global_main.trace_filter.trace_filter_enable))
155 /* See if we're supposed to trace this packet... */
156 if (vnet_is_packet_traced
157 (b, vlib_global_main.trace_filter.trace_classify_table_index,
158 0 /* full classify */ ) != 1)
163 * Apply filter to existing traces to keep number of allocated traces low.
164 * Performed each time around the main loop.
166 if (tm->last_main_loop_count != vm->main_loop_count)
168 tm->last_main_loop_count = vm->main_loop_count;
169 trace_apply_filter (vm);
171 if (tm->trace_buffer_callback)
172 (tm->trace_buffer_callback) ((struct vlib_main_t *) vm,
173 (struct vlib_trace_main_t *) tm);
176 vlib_trace_next_frame (vm, r, next_index);
178 pool_get (tm->trace_buffer_pool, h);
182 b->flags |= VLIB_BUFFER_IS_TRACED;
183 b->trace_handle = vlib_buffer_make_trace_handle
184 (vm->thread_index, h - tm->trace_buffer_pool);
186 while (follow_chain && (b = vlib_get_next_buffer (vm, b)));
192 vlib_buffer_copy_trace_flag (vlib_main_t * vm, vlib_buffer_t * b,
195 vlib_buffer_t *b_target = vlib_get_buffer (vm, bi_target);
196 b_target->flags |= b->flags & VLIB_BUFFER_IS_TRACED;
197 b_target->trace_handle = b->trace_handle;
201 vlib_get_trace_count (vlib_main_t * vm, vlib_node_runtime_t * rt)
203 vlib_trace_main_t *tm = &vm->trace_main;
204 vlib_trace_node_t *tn;
206 if (rt->node_index >= vec_len (tm->nodes))
208 tn = tm->nodes + rt->node_index;
209 ASSERT (tn->count <= tn->limit);
211 return tn->limit - tn->count;
215 vlib_set_trace_count (vlib_main_t * vm, vlib_node_runtime_t * rt, u32 count)
217 vlib_trace_main_t *tm = &vm->trace_main;
218 vlib_trace_node_t *tn = vec_elt_at_index (tm->nodes, rt->node_index);
220 ASSERT (count <= tn->limit);
221 tn->count = tn->limit - count;
224 /* Helper function for nodes which only trace buffer data. */
226 vlib_trace_frame_buffers_only (vlib_main_t * vm,
227 vlib_node_runtime_t * node,
230 uword next_buffer_stride,
231 uword n_buffer_data_bytes_in_trace);
233 #endif /* included_vlib_trace_funcs_h */
236 * fd.io coding-style-patch-verification: ON
239 * eval: (c-set-style "gnu")