2 * mdata.c - Buffer metadata change tracker
4 * Copyright (c) 2019 Cisco and/or its affiliates.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
18 #include <vnet/vnet.h>
19 #include <vnet/plugin/plugin.h>
20 #include <mdata/mdata.h>
22 #include <vlibapi/api.h>
23 #include <vlibmemory/api.h>
24 #include <vppinfra/callback_data.h>
25 #include <vpp/app/version.h>
28 #include <mdata/mdata.api_enum.h>
29 #include <mdata/mdata.api_types.h>
31 #define REPLY_MSG_ID_BASE mmp->msg_id_base
32 #include <vlibapi/api_helper_macros.h>
34 mdata_main_t mdata_main;
37 * buffer metadata change tracker
40 static mdata_t mdata_none;
42 /** Metadata tracking callback
43 before_or_after: 0 => before, 1=> after
46 mdata_trace_callback (vlib_node_runtime_perf_callback_data_t * data,
47 vlib_node_runtime_perf_callback_args_t * args)
50 mdata_main_t *mm = &mdata_main;
51 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
54 mdata_t *before, *modifies;
56 vlib_main_t *vm = args->vm;
57 vlib_frame_t *frame = args->frame;
58 vlib_node_runtime_t *node = args->node;
60 if (PREDICT_FALSE (args->call_type == VLIB_NODE_RUNTIME_PERF_RESET))
63 /* Input nodes don't have frames, etc. */
67 n_left_from = frame->n_vectors;
72 from = vlib_frame_vector_args (frame);
74 vlib_get_buffers (vm, from, bufs, n_left_from);
77 if (args->call_type == VLIB_NODE_RUNTIME_PERF_AFTER)
80 /* Resize the per-thread "before" vector to cover the current frame */
81 vec_reset_length (mm->before_per_thread[vm->thread_index]);
82 vec_validate (mm->before_per_thread[vm->thread_index], n_left_from - 1);
83 before = mm->before_per_thread[vm->thread_index];
84 before->node_index = ~0;
86 /* Before we call the dispatch fn, copy metadata. */
87 while (n_left_from > 0)
89 clib_memcpy_fast (before->mdata, b[0], sizeof (before->mdata));
98 /* Recover the metadata copy we saved a moment ago */
99 before = mm->before_per_thread[vm->thread_index];
101 /* We'd better have the same number of buffers... */
102 ASSERT (n_left_from == vec_len (before));
103 ASSERT (node->node_index);
105 clib_spinlock_lock_if_init (&mm->modify_lock);
108 * Resize the per-node accumulator vector as needed
109 * Paint the "no data" patter across any nodes we haven't seen yet
111 vec_validate_init_empty (mm->modifies, node->node_index, mdata_none);
112 modifies = vec_elt_at_index (mm->modifies, node->node_index);
113 modifies->node_index = node->node_index;
114 before = mm->before_per_thread[vm->thread_index];
117 while (n_left_from > 0)
121 /* Compare metadata before and after node dispatch fn */
122 for (i = 0; i < ARRAY_LEN (before->mdata); i++)
124 /* Mark mdata octet changed */
125 if (before->mdata[i] != after[i])
126 modifies->mdata[i] = 0xff;
134 clib_spinlock_unlock_if_init (&mm->modify_lock);
138 mdata_enable_disable (mdata_main_t * mmp, int enable_disable)
141 vlib_thread_main_t *thread_main = vlib_get_thread_main ();
144 if (mmp->modify_lock == 0 && thread_main->n_vlib_mains > 1)
145 clib_spinlock_init (&mmp->modify_lock);
147 if (vec_len (mmp->before_per_thread) == 0)
149 mdata_none.node_index = ~0;
150 vec_validate (mmp->before_per_thread, vlib_get_n_threads () - 1);
153 /* Reset the per-node accumulator, see vec_validate_init_empty above */
154 vec_reset_length (mmp->modifies);
156 for (i = 0; i < vlib_get_n_threads (); i++)
158 vlib_main_t *ovm = vlib_get_main_by_index (i);
162 clib_callback_data_enable_disable (
163 &ovm->vlib_node_runtime_perf_callbacks, mdata_trace_callback,
170 static clib_error_t *
171 mdata_enable_disable_command_fn (vlib_main_t * vm,
172 unformat_input_t * input,
173 vlib_cli_command_t * cmd)
175 mdata_main_t *mmp = &mdata_main;
176 int enable_disable = 1;
180 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
182 if (unformat (input, "disable") || unformat (input, "off"))
184 if (unformat (input, "enable") || unformat (input, "on"))
190 rv = mdata_enable_disable (mmp, enable_disable);
198 return clib_error_return (0, "mdata_enable_disable returned %d", rv);
204 * This command enables or disables buffer metadata change tracking
207 * To enable buffer metadata change tracking:
208 *@cliexstart{buffer metadata tracking on}
212 *@cliexstart{buffer metadata tracking off}
218 VLIB_CLI_COMMAND (mdata_enable_disable_command, static) =
220 .path = "buffer metadata tracking",
221 .short_help = "buffer metadata tracking [on][off]",
222 .function = mdata_enable_disable_command_fn,
226 /* API message handler */
227 static void vl_api_mdata_enable_disable_t_handler
228 (vl_api_mdata_enable_disable_t * mp)
230 vl_api_mdata_enable_disable_reply_t *rmp;
231 mdata_main_t *mmp = &mdata_main;
234 rv = mdata_enable_disable (mmp, (int) (mp->enable_disable));
236 REPLY_MACRO (VL_API_MDATA_ENABLE_DISABLE_REPLY);
239 /* API definitions */
240 #include <mdata/mdata.api.c>
242 static clib_error_t *
243 mdata_init (vlib_main_t * vm)
245 mdata_main_t *mmp = &mdata_main;
246 clib_error_t *error = 0;
249 mmp->vnet_main = vnet_get_main ();
251 /* Add our API messages to the global name_crc hash table */
252 mmp->msg_id_base = setup_message_id_table ();
257 VLIB_INIT_FUNCTION (mdata_init);
260 VLIB_PLUGIN_REGISTER () =
262 .version = VPP_BUILD_VER,
263 .description = "Buffer metadata change tracker."
268 #define foreach_primary_metadata_field \
274 _(buffer_pool_index) \
277 _(current_config_index) \
280 #define foreach_opaque_metadata_field \
286 _(feature_arc_index) \
290 _(ip.save_protocol) \
295 _(ip.reass.next_index) \
296 _(ip.reass.error_next_index) \
297 _(ip.reass.owner_thread_index) \
298 _(ip.reass.ip_proto) \
299 _(ip.reass.l4_src_port) \
300 _(ip.reass.l4_dst_port) \
301 _(ip.reass.estimated_mtu) \
302 _(ip.reass.fragment_first) \
303 _(ip.reass.fragment_last) \
304 _(ip.reass.range_first) \
305 _(ip.reass.range_last) \
306 _(ip.reass.next_range_bi) \
307 _(ip.reass.ip6_frag_hdr_offset) \
311 _(mpls.save_rewrite_length) \
312 _(mpls.mpls_hdr_length) \
313 _(mpls.bier.n_bytes) \
314 _(l2.feature_bitmap) \
321 _(l2t.session_index) \
322 _(l2_classify.table_index) \
323 _(l2_classify.opaque_index) \
324 _(l2_classify.hash) \
327 _(ipsec.protect_index) \
329 _(map_t.map_domain_index) \
332 _(map_t.v6.frag_offset) \
333 _(map_t.v6.l4_offset) \
334 _(map_t.v6.l4_protocol) \
335 _(map_t.checksum_offset) \
338 _(ip_frag.next_index) \
340 _(cop.current_config_index) \
341 _(lisp.overlay_afi) \
342 _(tcp.connection_index) \
344 _(tcp.next_node_opaque) \
353 #define foreach_opaque2_metadata_field \
361 _(pg_replay_timestamp)
364 format_buffer_metadata_changes (u8 * s, va_list * args)
366 mdata_main_t *mm = va_arg (*args, mdata_main_t *);
367 int verbose = va_arg (*args, int);
370 vnet_buffer_opaque_t *o;
371 vnet_buffer_opaque2_t *o2;
376 clib_spinlock_lock_if_init (&mm->modify_lock);
378 for (i = 0; i < vec_len (mm->modifies); i++)
380 modifies = vec_elt_at_index (mm->modifies, i);
381 node = vlib_get_node (mm->vlib_main, i);
383 /* No data for this node? */
384 if (modifies->node_index == ~0)
387 s = format (s, "\n%v: no data\n", node->name);
391 /* We visited the node, but it may not have changed any metadata... */
392 for (j = 0; j < ARRAY_LEN (modifies->mdata); j++)
394 if (modifies->mdata[j])
397 s = format (s, "\n%v: no metadata changes\n", node->name);
401 /* Fields which the node modifies will be non-zero */
402 b = (vlib_buffer_t *) (modifies->mdata);
404 /* Dump primary metadata changes */
405 s = format (s, "\n%v: ", node->name);
408 #define _(n) if (b->n) {s = format (s, "%s ", #n); printed = 1;}
409 foreach_primary_metadata_field;
413 s = format (s, "no vlib_buffer_t metadata changes");
418 * Dump opaque union changes.
419 * Hopefully this will give folks a clue about opaque
420 * union data conflicts. That's the point of the exercise...
424 s = format (s, " vnet_buffer_t: ");
426 #define _(n) if (o->n) {s = format (s, "%s ", #n); printed = 1;}
427 foreach_opaque_metadata_field;
431 s = format (s, "no changes");
435 o2 = vnet_buffer2 (b);
437 s = format (s, " vnet_buffer2_t: ");
439 #define _(n) if (o2->n) {s = format (s, "%s ", #n); printed = 1;}
440 foreach_opaque2_metadata_field;
443 s = format (s, "no changes");
449 clib_spinlock_unlock_if_init (&mm->modify_lock);
454 static clib_error_t *
455 show_metadata_command_fn (vlib_main_t * vm,
456 unformat_input_t * input, vlib_cli_command_t * cmd)
460 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
462 if (unformat (input, "verbose %=", &verbose, 1))
468 vlib_cli_output (vm, "%U", format_buffer_metadata_changes, &mdata_main,
474 * This command displays buffer metadata change information
476 * How to display buffer metadata change information
477 *@cliexstart{show buffer metadata}
478 * ethernet-input: current_data current_length flags error
479 * vnet_buffer_t: l2_hdr_offset l3_hdr_offset
480 * vnet_buffer2_t: no changes
485 VLIB_CLI_COMMAND (show_metadata_command, static) =
487 .path = "show buffer metadata",
488 .short_help = "show buffer metadata",
489 .function = show_metadata_command_fn,
494 * fd.io coding-style-patch-verification: ON
497 * eval: (c-set-style "gnu")