blob: 357079c4e3d5f275794dadc71477b9470e11559d [file] [log] [blame]
Ed Warnickecb9cada2015-12-08 15:45:58 -07001/*
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 * trace_funcs.h: VLIB trace buffer.
17 *
18 * Copyright (c) 2008 Eliot Dresselhaus
19 *
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:
27 *
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
30 *
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.
38 */
39
40#ifndef included_vlib_trace_funcs_h
41#define included_vlib_trace_funcs_h
42
Dave Barach11fb09e2020-08-06 12:10:09 -040043extern u8 *vnet_trace_placeholder;
Dave Barachf8b85862018-08-17 18:29:07 -040044
Ed Warnickecb9cada2015-12-08 15:45:58 -070045always_inline void
46vlib_validate_trace (vlib_trace_main_t * tm, vlib_buffer_t * b)
47{
Dave Baracha638c182019-06-21 18:24:07 -040048 ASSERT (!pool_is_free_index (tm->trace_buffer_pool,
49 vlib_buffer_get_trace_index (b)));
Ed Warnickecb9cada2015-12-08 15:45:58 -070050}
51
Benoît Ganne9a3973e2020-10-02 19:36:57 +020052int vlib_add_handoff_trace (vlib_main_t * vm, vlib_buffer_t * b);
Dave Baracha638c182019-06-21 18:24:07 -040053
Ed Warnickecb9cada2015-12-08 15:45:58 -070054always_inline void *
Dave Barach0a67b482020-06-08 11:17:19 -040055vlib_add_trace_inline (vlib_main_t * vm,
56 vlib_node_runtime_t * r, vlib_buffer_t * b,
57 u32 n_data_bytes)
Ed Warnickecb9cada2015-12-08 15:45:58 -070058{
Dave Barach9b8ffd92016-07-08 08:13:45 -040059 vlib_trace_main_t *tm = &vm->trace_main;
60 vlib_trace_header_t *h;
Ed Warnickecb9cada2015-12-08 15:45:58 -070061 u32 n_data_words;
62
Dave Barach11fb09e2020-08-06 12:10:09 -040063 ASSERT (vnet_trace_placeholder);
Dave Barachf8b85862018-08-17 18:29:07 -040064
Dave Barach87d24db2019-12-04 17:19:12 -050065 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_IS_TRACED) == 0))
Dave Barach11fb09e2020-08-06 12:10:09 -040066 return vnet_trace_placeholder;
Dave Barach87d24db2019-12-04 17:19:12 -050067
Gary Boon4681e072019-05-03 13:30:14 -040068 if (PREDICT_FALSE (tm->add_trace_callback != 0))
69 {
70 return tm->add_trace_callback ((struct vlib_main_t *) vm,
71 (struct vlib_node_runtime_t *) r,
72 (struct vlib_buffer_t *) b,
73 n_data_bytes);
74 }
75 else if (PREDICT_FALSE (tm->trace_enable == 0))
Dave Barachf8b85862018-08-17 18:29:07 -040076 {
Dave Barach11fb09e2020-08-06 12:10:09 -040077 ASSERT (vec_len (vnet_trace_placeholder) >= n_data_bytes + sizeof (*h));
78 return vnet_trace_placeholder;
Dave Barachf8b85862018-08-17 18:29:07 -040079 }
80
Dave Baracha638c182019-06-21 18:24:07 -040081 /* Are we trying to trace a handoff case? */
82 if (PREDICT_FALSE (vlib_buffer_get_trace_thread (b) != vm->thread_index))
Benoît Ganne9a3973e2020-10-02 19:36:57 +020083 if (PREDICT_FALSE (!vlib_add_handoff_trace (vm, b)))
84 return vnet_trace_placeholder;
Dave Baracha638c182019-06-21 18:24:07 -040085
Ed Warnickecb9cada2015-12-08 15:45:58 -070086 vlib_validate_trace (tm, b);
87
88 n_data_bytes = round_pow2 (n_data_bytes, sizeof (h[0]));
89 n_data_words = n_data_bytes / sizeof (h[0]);
Dave Baracha638c182019-06-21 18:24:07 -040090 vec_add2_aligned (tm->trace_buffer_pool[vlib_buffer_get_trace_index (b)], h,
Dave Barach9b8ffd92016-07-08 08:13:45 -040091 1 + n_data_words, sizeof (h[0]));
Ed Warnickecb9cada2015-12-08 15:45:58 -070092
93 h->time = vm->cpu_time_last_node_dispatch;
94 h->n_data = n_data_words;
95 h->node_index = r->node_index;
96
97 return h->data;
98}
Dave Barach9b8ffd92016-07-08 08:13:45 -040099
Dave Barach0a67b482020-06-08 11:17:19 -0400100/* Non-inline (typical use-case) version of the above */
101void *vlib_add_trace (vlib_main_t * vm,
102 vlib_node_runtime_t * r, vlib_buffer_t * b,
103 u32 n_data_bytes);
104
Ed Warnickecb9cada2015-12-08 15:45:58 -0700105always_inline vlib_trace_header_t *
106vlib_trace_header_next (vlib_trace_header_t * h)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400107{
108 return h + 1 + h->n_data;
109}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700110
111always_inline void
112vlib_free_trace (vlib_main_t * vm, vlib_buffer_t * b)
113{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400114 vlib_trace_main_t *tm = &vm->trace_main;
Dave Baracha638c182019-06-21 18:24:07 -0400115 u32 trace_index = vlib_buffer_get_trace_index (b);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700116 vlib_validate_trace (tm, b);
Dave Baracha638c182019-06-21 18:24:07 -0400117 _vec_len (tm->trace_buffer_pool[trace_index]) = 0;
118 pool_put_index (tm->trace_buffer_pool, trace_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700119}
120
121always_inline void
122vlib_trace_next_frame (vlib_main_t * vm,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400123 vlib_node_runtime_t * r, u32 next_index)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700124{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400125 vlib_next_frame_t *nf;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700126 nf = vlib_node_runtime_get_next_frame (vm, r, next_index);
127 nf->flags |= VLIB_FRAME_TRACE;
128}
129
Bud Grise0bcc9d52016-02-02 14:23:29 -0500130void trace_apply_filter (vlib_main_t * vm);
Dave Barach87d24db2019-12-04 17:19:12 -0500131int vnet_is_packet_traced (vlib_buffer_t * b,
132 u32 classify_table_index, int func);
133
Bud Grise0bcc9d52016-02-02 14:23:29 -0500134
Benoît Ganne9a3973e2020-10-02 19:36:57 +0200135/*
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
139 * match the filter.
140 */
141always_inline __clib_warn_unused_result int
Ed Warnickecb9cada2015-12-08 15:45:58 -0700142vlib_trace_buffer (vlib_main_t * vm,
143 vlib_node_runtime_t * r,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400144 u32 next_index, vlib_buffer_t * b, int follow_chain)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700145{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400146 vlib_trace_main_t *tm = &vm->trace_main;
147 vlib_trace_header_t **h;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700148
Dave Barachf8b85862018-08-17 18:29:07 -0400149 if (PREDICT_FALSE (tm->trace_enable == 0))
Benoît Ganne9a3973e2020-10-02 19:36:57 +0200150 return 0;
Dave Barachf8b85862018-08-17 18:29:07 -0400151
Dave Barach87d24db2019-12-04 17:19:12 -0500152 /* Classifier filter in use? */
153 if (PREDICT_FALSE (vlib_global_main.trace_filter.trace_filter_enable))
154 {
155 /* See if we're supposed to trace this packet... */
156 if (vnet_is_packet_traced
Jon Loeliger5c1e48c2020-10-15 14:41:36 -0400157 (b, vlib_global_main.trace_filter.classify_table_index,
Dave Barach87d24db2019-12-04 17:19:12 -0500158 0 /* full classify */ ) != 1)
Benoît Ganne9a3973e2020-10-02 19:36:57 +0200159 return 0;
Dave Barach87d24db2019-12-04 17:19:12 -0500160 }
161
Bud Grise0bcc9d52016-02-02 14:23:29 -0500162 /*
163 * Apply filter to existing traces to keep number of allocated traces low.
164 * Performed each time around the main loop.
165 */
166 if (tm->last_main_loop_count != vm->main_loop_count)
167 {
168 tm->last_main_loop_count = vm->main_loop_count;
169 trace_apply_filter (vm);
Gary Boon4681e072019-05-03 13:30:14 -0400170
171 if (tm->trace_buffer_callback)
172 (tm->trace_buffer_callback) ((struct vlib_main_t *) vm,
173 (struct vlib_trace_main_t *) tm);
Bud Grise0bcc9d52016-02-02 14:23:29 -0500174 }
175
Neale Ranns6b03ab72019-07-30 07:14:25 -0700176 vlib_trace_next_frame (vm, r, next_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700177
178 pool_get (tm->trace_buffer_pool, h);
179
Dave Barach9b8ffd92016-07-08 08:13:45 -0400180 do
181 {
182 b->flags |= VLIB_BUFFER_IS_TRACED;
Dave Baracha638c182019-06-21 18:24:07 -0400183 b->trace_handle = vlib_buffer_make_trace_handle
184 (vm->thread_index, h - tm->trace_buffer_pool);
Dave Barach9b8ffd92016-07-08 08:13:45 -0400185 }
186 while (follow_chain && (b = vlib_get_next_buffer (vm, b)));
Benoît Ganne9a3973e2020-10-02 19:36:57 +0200187
188 return 1;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700189}
190
191always_inline void
Dave Barach9b8ffd92016-07-08 08:13:45 -0400192vlib_buffer_copy_trace_flag (vlib_main_t * vm, vlib_buffer_t * b,
193 u32 bi_target)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700194{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400195 vlib_buffer_t *b_target = vlib_get_buffer (vm, bi_target);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700196 b_target->flags |= b->flags & VLIB_BUFFER_IS_TRACED;
Dave Baracha638c182019-06-21 18:24:07 -0400197 b_target->trace_handle = b->trace_handle;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700198}
199
200always_inline u32
201vlib_get_trace_count (vlib_main_t * vm, vlib_node_runtime_t * rt)
202{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400203 vlib_trace_main_t *tm = &vm->trace_main;
204 vlib_trace_node_t *tn;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700205
206 if (rt->node_index >= vec_len (tm->nodes))
207 return 0;
208 tn = tm->nodes + rt->node_index;
Dave Barach27d978c2020-11-03 09:59:06 -0500209 ASSERT (tn->count <= tn->limit);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700210
Dave Barach27d978c2020-11-03 09:59:06 -0500211 return tn->limit - tn->count;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700212}
213
214always_inline void
Dave Barach9b8ffd92016-07-08 08:13:45 -0400215vlib_set_trace_count (vlib_main_t * vm, vlib_node_runtime_t * rt, u32 count)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700216{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400217 vlib_trace_main_t *tm = &vm->trace_main;
218 vlib_trace_node_t *tn = vec_elt_at_index (tm->nodes, rt->node_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700219
220 ASSERT (count <= tn->limit);
221 tn->count = tn->limit - count;
222}
223
224/* Helper function for nodes which only trace buffer data. */
225void
226vlib_trace_frame_buffers_only (vlib_main_t * vm,
227 vlib_node_runtime_t * node,
228 u32 * buffers,
229 uword n_buffers,
230 uword next_buffer_stride,
231 uword n_buffer_data_bytes_in_trace);
232
233#endif /* included_vlib_trace_funcs_h */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400234
235/*
236 * fd.io coding-style-patch-verification: ON
237 *
238 * Local Variables:
239 * eval: (c-set-style "gnu")
240 * End:
241 */