tracing: Error if a trace event has an array for a __field()
authorSteven Rostedt (Google) <rostedt@goodmis.org>
Fri, 10 Mar 2023 03:13:02 +0000 (22:13 -0500)
committerSteven Rostedt (Google) <rostedt@goodmis.org>
Mon, 3 Apr 2023 15:52:51 +0000 (11:52 -0400)
commitf82e7ca019dfad3b006fd3b772f7ac569672db55
tree858887d7719130d0cb782b30328c9b18ebd3359e
parentd3cba7f02cd82118c32651c73374d8a5a459d9a6
tracing: Error if a trace event has an array for a __field()

A __field() in the TRACE_EVENT() macro is used to set up the fields of the
trace event data. It is for single storage units (word, char, int,
pointer, etc) and not for complex structures or arrays. Unfortunately,
there's nothing preventing the build from accepting:

    __field(int, arr[5]);

from building. It will turn into a array value. This use to work fine, as
the offset and size use to be determined by the macro using the field name,
but things have changed and the offset and size are now determined by the
type. So the above would only be size 4, and the next field will be
located 4 bytes from it (instead of 20).

The proper way to declare static arrays is to use the __array() macro.

Instead of __field(int, arr[5]) it should be __array(int, arr, 5).

Add some macro tricks to the building of a trace event from the
TRACE_EVENT() macro such that __field(int, arr[5]) will fail to build. A
comment by the failure will explain why the build failed.

Link: https://lore.kernel.org/lkml/20230306122549.236561-1-douglas.raillard@arm.com/
Link: https://lore.kernel.org/linux-trace-kernel/20230309221302.642e82d9@gandalf.local.home
Reported-by: Douglas RAILLARD <douglas.raillard@arm.com>
Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
Acked-by: Masami Hiramatsu (Google) <mhiramat@kernel.org>
include/trace/stages/stage5_get_offsets.h