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
44 vlib_validate_trace (vlib_trace_main_t * tm, vlib_buffer_t * b)
47 * this assert seems right, but goes off constantly.
48 * disabling it appears to make the pain go away
50 ASSERT (1 || b->flags & VLIB_BUFFER_IS_TRACED);
51 ASSERT (!pool_is_free_index (tm->trace_buffer_pool, b->trace_index));
55 vlib_add_trace (vlib_main_t * vm,
56 vlib_node_runtime_t * r, vlib_buffer_t * b, u32 n_data_bytes)
58 vlib_trace_main_t *tm = &vm->trace_main;
59 vlib_trace_header_t *h;
62 vlib_validate_trace (tm, b);
64 n_data_bytes = round_pow2 (n_data_bytes, sizeof (h[0]));
65 n_data_words = n_data_bytes / sizeof (h[0]);
66 vec_add2_aligned (tm->trace_buffer_pool[b->trace_index], h,
67 1 + n_data_words, sizeof (h[0]));
69 h->time = vm->cpu_time_last_node_dispatch;
70 h->n_data = n_data_words;
71 h->node_index = r->node_index;
76 always_inline vlib_trace_header_t *
77 vlib_trace_header_next (vlib_trace_header_t * h)
79 return h + 1 + h->n_data;
83 vlib_free_trace (vlib_main_t * vm, vlib_buffer_t * b)
85 vlib_trace_main_t *tm = &vm->trace_main;
86 vlib_validate_trace (tm, b);
87 _vec_len (tm->trace_buffer_pool[b->trace_index]) = 0;
88 pool_put_index (tm->trace_buffer_pool, b->trace_index);
92 vlib_trace_next_frame (vlib_main_t * vm,
93 vlib_node_runtime_t * r, u32 next_index)
95 vlib_next_frame_t *nf;
96 nf = vlib_node_runtime_get_next_frame (vm, r, next_index);
97 nf->flags |= VLIB_FRAME_TRACE;
100 void trace_apply_filter (vlib_main_t * vm);
102 /* Mark buffer as traced and allocate trace buffer. */
104 vlib_trace_buffer (vlib_main_t * vm,
105 vlib_node_runtime_t * r,
106 u32 next_index, vlib_buffer_t * b, int follow_chain)
108 vlib_trace_main_t *tm = &vm->trace_main;
109 vlib_trace_header_t **h;
112 * Apply filter to existing traces to keep number of allocated traces low.
113 * Performed each time around the main loop.
115 if (tm->last_main_loop_count != vm->main_loop_count)
117 tm->last_main_loop_count = vm->main_loop_count;
118 trace_apply_filter (vm);
121 vlib_trace_next_frame (vm, r, next_index);
123 pool_get (tm->trace_buffer_pool, h);
127 b->flags |= VLIB_BUFFER_IS_TRACED;
128 b->trace_index = h - tm->trace_buffer_pool;
130 while (follow_chain && (b = vlib_get_next_buffer (vm, b)));
134 vlib_buffer_copy_trace_flag (vlib_main_t * vm, vlib_buffer_t * b,
137 vlib_buffer_t *b_target = vlib_get_buffer (vm, bi_target);
138 b_target->flags |= b->flags & VLIB_BUFFER_IS_TRACED;
139 b_target->trace_index = b->trace_index;
143 vlib_get_trace_count (vlib_main_t * vm, vlib_node_runtime_t * rt)
145 vlib_trace_main_t *tm = &vm->trace_main;
146 vlib_trace_node_t *tn;
149 if (rt->node_index >= vec_len (tm->nodes))
151 tn = tm->nodes + rt->node_index;
152 n = tn->limit - tn->count;
159 vlib_set_trace_count (vlib_main_t * vm, vlib_node_runtime_t * rt, u32 count)
161 vlib_trace_main_t *tm = &vm->trace_main;
162 vlib_trace_node_t *tn = vec_elt_at_index (tm->nodes, rt->node_index);
164 ASSERT (count <= tn->limit);
165 tn->count = tn->limit - count;
168 /* Helper function for nodes which only trace buffer data. */
170 vlib_trace_frame_buffers_only (vlib_main_t * vm,
171 vlib_node_runtime_t * node,
174 uword next_buffer_stride,
175 uword n_buffer_data_bytes_in_trace);
177 #endif /* included_vlib_trace_funcs_h */
180 * fd.io coding-style-patch-verification: ON
183 * eval: (c-set-style "gnu")