License cleanup: add SPDX GPL-2.0 license identifier to files with no license
Many source files in the tree are missing licensing information, which
makes it harder for compliance tools to determine the correct license.
By default all files without license information are under the default
license of the kernel, which is GPL version 2.
Update the files which contain no license information with the 'GPL-2.0'
SPDX license identifier. The SPDX identifier is a legally binding
shorthand, which can be used instead of the full boiler plate text.
This patch is based on work done by Thomas Gleixner and Kate Stewart and
Philippe Ombredanne.
How this work was done:
Patches were generated and checked against linux-4.14-rc6 for a subset of
the use cases:
- file had no licensing information it it.
- file was a */uapi/* one with no licensing information in it,
- file was a */uapi/* one with existing licensing information,
Further patches will be generated in subsequent months to fix up cases
where non-standard license headers were used, and references to license
had to be inferred by heuristics based on keywords.
The analysis to determine which SPDX License Identifier to be applied to
a file was done in a spreadsheet of side by side results from of the
output of two independent scanners (ScanCode & Windriver) producing SPDX
tag:value files created by Philippe Ombredanne. Philippe prepared the
base worksheet, and did an initial spot review of a few 1000 files.
The 4.13 kernel was the starting point of the analysis with 60,537 files
assessed. Kate Stewart did a file by file comparison of the scanner
results in the spreadsheet to determine which SPDX license identifier(s)
to be applied to the file. She confirmed any determination that was not
immediately clear with lawyers working with the Linux Foundation.
Criteria used to select files for SPDX license identifier tagging was:
- Files considered eligible had to be source code files.
- Make and config files were included as candidates if they contained >5
lines of source
- File already had some variant of a license header in it (even if <5
lines).
All documentation files were explicitly excluded.
The following heuristics were used to determine which SPDX license
identifiers to apply.
- when both scanners couldn't find any license traces, file was
considered to have no license information in it, and the top level
COPYING file license applied.
For non */uapi/* files that summary was:
SPDX license identifier # files
---------------------------------------------------|-------
GPL-2.0 11139
and resulted in the first patch in this series.
If that file was a */uapi/* path one, it was "GPL-2.0 WITH
Linux-syscall-note" otherwise it was "GPL-2.0". Results of that was:
SPDX license identifier # files
---------------------------------------------------|-------
GPL-2.0 WITH Linux-syscall-note 930
and resulted in the second patch in this series.
- if a file had some form of licensing information in it, and was one
of the */uapi/* ones, it was denoted with the Linux-syscall-note if
any GPL family license was found in the file or had no licensing in
it (per prior point). Results summary:
SPDX license identifier # files
---------------------------------------------------|------
GPL-2.0 WITH Linux-syscall-note 270
GPL-2.0+ WITH Linux-syscall-note 169
((GPL-2.0 WITH Linux-syscall-note) OR BSD-2-Clause) 21
((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause) 17
LGPL-2.1+ WITH Linux-syscall-note 15
GPL-1.0+ WITH Linux-syscall-note 14
((GPL-2.0+ WITH Linux-syscall-note) OR BSD-3-Clause) 5
LGPL-2.0+ WITH Linux-syscall-note 4
LGPL-2.1 WITH Linux-syscall-note 3
((GPL-2.0 WITH Linux-syscall-note) OR MIT) 3
((GPL-2.0 WITH Linux-syscall-note) AND MIT) 1
and that resulted in the third patch in this series.
- when the two scanners agreed on the detected license(s), that became
the concluded license(s).
- when there was disagreement between the two scanners (one detected a
license but the other didn't, or they both detected different
licenses) a manual inspection of the file occurred.
- In most cases a manual inspection of the information in the file
resulted in a clear resolution of the license that should apply (and
which scanner probably needed to revisit its heuristics).
- When it was not immediately clear, the license identifier was
confirmed with lawyers working with the Linux Foundation.
- If there was any question as to the appropriate license identifier,
the file was flagged for further research and to be revisited later
in time.
In total, over 70 hours of logged manual review was done on the
spreadsheet to determine the SPDX license identifiers to apply to the
source files by Kate, Philippe, Thomas and, in some cases, confirmation
by lawyers working with the Linux Foundation.
Kate also obtained a third independent scan of the 4.13 code base from
FOSSology, and compared selected files where the other two scanners
disagreed against that SPDX file, to see if there was new insights. The
Windriver scanner is based on an older version of FOSSology in part, so
they are related.
Thomas did random spot checks in about 500 files from the spreadsheets
for the uapi headers and agreed with SPDX license identifier in the
files he inspected. For the non-uapi files Thomas did random spot checks
in about 15000 files.
In initial set of patches against 4.14-rc6, 3 files were found to have
copy/paste license identifier errors, and have been fixed to reflect the
correct identifier.
Additionally Philippe spent 10 hours this week doing a detailed manual
inspection and review of the 12,461 patched files from the initial patch
version early this week with:
- a full scancode scan run, collecting the matched texts, detected
license ids and scores
- reviewing anything where there was a license detected (about 500+
files) to ensure that the applied SPDX license was correct
- reviewing anything where there was no detection but the patch license
was not GPL-2.0 WITH Linux-syscall-note to ensure that the applied
SPDX license was correct
This produced a worksheet with 20 files needing minor correction. This
worksheet was then exported into 3 different .csv files for the
different types of files to be modified.
These .csv files were then reviewed by Greg. Thomas wrote a script to
parse the csv files and add the proper SPDX tag to the file, in the
format that the file expected. This script was further refined by Greg
based on the output to detect more types of files automatically and to
distinguish between header and source .c files (which need different
comment types.) Finally Greg ran the script using the .csv files to
generate the patches.
Reviewed-by: Kate Stewart <kstewart@linuxfoundation.org>
Reviewed-by: Philippe Ombredanne <pombredanne@nexb.com>
Reviewed-by: Thomas Gleixner <tglx@linutronix.de>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2017-11-01 22:07:57 +08:00
|
|
|
/* SPDX-License-Identifier: GPL-2.0 */
|
2009-04-14 00:25:37 +08:00
|
|
|
/*
|
|
|
|
|
* Stage 1 of the trace events.
|
|
|
|
|
*
|
2015-03-04 05:48:18 +08:00
|
|
|
* Override the macros in the event tracepoint header <trace/events/XXX.h>
|
|
|
|
|
* to include the following:
|
2009-04-14 00:25:37 +08:00
|
|
|
*
|
2015-05-14 03:27:47 +08:00
|
|
|
* struct trace_event_raw_<call> {
|
2009-04-14 00:25:37 +08:00
|
|
|
* struct trace_entry ent;
|
|
|
|
|
* <type> <item>;
|
|
|
|
|
* <type2> <item2>[<len>];
|
|
|
|
|
* [...]
|
|
|
|
|
* };
|
|
|
|
|
*
|
|
|
|
|
* The <type> <item> is created by the __field(type, item) macro or
|
|
|
|
|
* the __array(type2, item2, len) macro.
|
|
|
|
|
* We simply do "type item;", and that will create the fields
|
|
|
|
|
* in the structure.
|
|
|
|
|
*/
|
|
|
|
|
|
2015-04-30 02:36:05 +08:00
|
|
|
#include <linux/trace_events.h>
|
2009-04-14 00:25:37 +08:00
|
|
|
|
2015-04-01 02:37:12 +08:00
|
|
|
#ifndef TRACE_SYSTEM_VAR
|
|
|
|
|
#define TRACE_SYSTEM_VAR TRACE_SYSTEM
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
#define __app__(x, y) str__##x##y
|
|
|
|
|
#define __app(x, y) __app__(x, y)
|
|
|
|
|
|
|
|
|
|
#define TRACE_SYSTEM_STRING __app(TRACE_SYSTEM_VAR,__trace_system_name)
|
|
|
|
|
|
|
|
|
|
#define TRACE_MAKE_SYSTEM_STR() \
|
|
|
|
|
static const char TRACE_SYSTEM_STRING[] = \
|
|
|
|
|
__stringify(TRACE_SYSTEM)
|
|
|
|
|
|
|
|
|
|
TRACE_MAKE_SYSTEM_STR();
|
|
|
|
|
|
tracing: Add TRACE_DEFINE_ENUM() macro to map enums to their values
Several tracepoints use the helper functions __print_symbolic() or
__print_flags() and pass in enums that do the mapping between the
binary data stored and the value to print. This works well for reading
the ASCII trace files, but when the data is read via userspace tools
such as perf and trace-cmd, the conversion of the binary value to a
human string format is lost if an enum is used, as userspace does not
have access to what the ENUM is.
For example, the tracepoint trace_tlb_flush() has:
__print_symbolic(REC->reason,
{ TLB_FLUSH_ON_TASK_SWITCH, "flush on task switch" },
{ TLB_REMOTE_SHOOTDOWN, "remote shootdown" },
{ TLB_LOCAL_SHOOTDOWN, "local shootdown" },
{ TLB_LOCAL_MM_SHOOTDOWN, "local mm shootdown" })
Which maps the enum values to the strings they represent. But perf and
trace-cmd do no know what value TLB_LOCAL_MM_SHOOTDOWN is, and would
not be able to map it.
With TRACE_DEFINE_ENUM(), developers can place these in the event header
files and ftrace will convert the enums to their values:
By adding:
TRACE_DEFINE_ENUM(TLB_FLUSH_ON_TASK_SWITCH);
TRACE_DEFINE_ENUM(TLB_REMOTE_SHOOTDOWN);
TRACE_DEFINE_ENUM(TLB_LOCAL_SHOOTDOWN);
TRACE_DEFINE_ENUM(TLB_LOCAL_MM_SHOOTDOWN);
$ cat /sys/kernel/debug/tracing/events/tlb/tlb_flush/format
[...]
__print_symbolic(REC->reason,
{ 0, "flush on task switch" },
{ 1, "remote shootdown" },
{ 2, "local shootdown" },
{ 3, "local mm shootdown" })
The above is what userspace expects to see, and tools do not need to
be modified to parse them.
Link: http://lkml.kernel.org/r/20150403013802.220157513@goodmis.org
Cc: Guilherme Cox <cox@computer.org>
Cc: Tony Luck <tony.luck@gmail.com>
Cc: Xie XiuQi <xiexiuqi@huawei.com>
Acked-by: Namhyung Kim <namhyung@kernel.org>
Reviewed-by: Masami Hiramatsu <masami.hiramatsu.pt@hitachi.com>
Tested-by: Masami Hiramatsu <masami.hiramatsu.pt@hitachi.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2015-03-25 05:58:09 +08:00
|
|
|
#undef TRACE_DEFINE_ENUM
|
|
|
|
|
#define TRACE_DEFINE_ENUM(a) \
|
2017-06-01 05:56:43 +08:00
|
|
|
static struct trace_eval_map __used __initdata \
|
tracing: Add TRACE_DEFINE_ENUM() macro to map enums to their values
Several tracepoints use the helper functions __print_symbolic() or
__print_flags() and pass in enums that do the mapping between the
binary data stored and the value to print. This works well for reading
the ASCII trace files, but when the data is read via userspace tools
such as perf and trace-cmd, the conversion of the binary value to a
human string format is lost if an enum is used, as userspace does not
have access to what the ENUM is.
For example, the tracepoint trace_tlb_flush() has:
__print_symbolic(REC->reason,
{ TLB_FLUSH_ON_TASK_SWITCH, "flush on task switch" },
{ TLB_REMOTE_SHOOTDOWN, "remote shootdown" },
{ TLB_LOCAL_SHOOTDOWN, "local shootdown" },
{ TLB_LOCAL_MM_SHOOTDOWN, "local mm shootdown" })
Which maps the enum values to the strings they represent. But perf and
trace-cmd do no know what value TLB_LOCAL_MM_SHOOTDOWN is, and would
not be able to map it.
With TRACE_DEFINE_ENUM(), developers can place these in the event header
files and ftrace will convert the enums to their values:
By adding:
TRACE_DEFINE_ENUM(TLB_FLUSH_ON_TASK_SWITCH);
TRACE_DEFINE_ENUM(TLB_REMOTE_SHOOTDOWN);
TRACE_DEFINE_ENUM(TLB_LOCAL_SHOOTDOWN);
TRACE_DEFINE_ENUM(TLB_LOCAL_MM_SHOOTDOWN);
$ cat /sys/kernel/debug/tracing/events/tlb/tlb_flush/format
[...]
__print_symbolic(REC->reason,
{ 0, "flush on task switch" },
{ 1, "remote shootdown" },
{ 2, "local shootdown" },
{ 3, "local mm shootdown" })
The above is what userspace expects to see, and tools do not need to
be modified to parse them.
Link: http://lkml.kernel.org/r/20150403013802.220157513@goodmis.org
Cc: Guilherme Cox <cox@computer.org>
Cc: Tony Luck <tony.luck@gmail.com>
Cc: Xie XiuQi <xiexiuqi@huawei.com>
Acked-by: Namhyung Kim <namhyung@kernel.org>
Reviewed-by: Masami Hiramatsu <masami.hiramatsu.pt@hitachi.com>
Tested-by: Masami Hiramatsu <masami.hiramatsu.pt@hitachi.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2015-03-25 05:58:09 +08:00
|
|
|
__##TRACE_SYSTEM##_##a = \
|
|
|
|
|
{ \
|
|
|
|
|
.system = TRACE_SYSTEM_STRING, \
|
2017-06-01 05:56:43 +08:00
|
|
|
.eval_string = #a, \
|
|
|
|
|
.eval_value = a \
|
tracing: Add TRACE_DEFINE_ENUM() macro to map enums to their values
Several tracepoints use the helper functions __print_symbolic() or
__print_flags() and pass in enums that do the mapping between the
binary data stored and the value to print. This works well for reading
the ASCII trace files, but when the data is read via userspace tools
such as perf and trace-cmd, the conversion of the binary value to a
human string format is lost if an enum is used, as userspace does not
have access to what the ENUM is.
For example, the tracepoint trace_tlb_flush() has:
__print_symbolic(REC->reason,
{ TLB_FLUSH_ON_TASK_SWITCH, "flush on task switch" },
{ TLB_REMOTE_SHOOTDOWN, "remote shootdown" },
{ TLB_LOCAL_SHOOTDOWN, "local shootdown" },
{ TLB_LOCAL_MM_SHOOTDOWN, "local mm shootdown" })
Which maps the enum values to the strings they represent. But perf and
trace-cmd do no know what value TLB_LOCAL_MM_SHOOTDOWN is, and would
not be able to map it.
With TRACE_DEFINE_ENUM(), developers can place these in the event header
files and ftrace will convert the enums to their values:
By adding:
TRACE_DEFINE_ENUM(TLB_FLUSH_ON_TASK_SWITCH);
TRACE_DEFINE_ENUM(TLB_REMOTE_SHOOTDOWN);
TRACE_DEFINE_ENUM(TLB_LOCAL_SHOOTDOWN);
TRACE_DEFINE_ENUM(TLB_LOCAL_MM_SHOOTDOWN);
$ cat /sys/kernel/debug/tracing/events/tlb/tlb_flush/format
[...]
__print_symbolic(REC->reason,
{ 0, "flush on task switch" },
{ 1, "remote shootdown" },
{ 2, "local shootdown" },
{ 3, "local mm shootdown" })
The above is what userspace expects to see, and tools do not need to
be modified to parse them.
Link: http://lkml.kernel.org/r/20150403013802.220157513@goodmis.org
Cc: Guilherme Cox <cox@computer.org>
Cc: Tony Luck <tony.luck@gmail.com>
Cc: Xie XiuQi <xiexiuqi@huawei.com>
Acked-by: Namhyung Kim <namhyung@kernel.org>
Reviewed-by: Masami Hiramatsu <masami.hiramatsu.pt@hitachi.com>
Tested-by: Masami Hiramatsu <masami.hiramatsu.pt@hitachi.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2015-03-25 05:58:09 +08:00
|
|
|
}; \
|
2017-06-01 05:56:43 +08:00
|
|
|
static struct trace_eval_map __used \
|
2020-10-22 10:36:07 +08:00
|
|
|
__section("_ftrace_eval_map") \
|
tracing: Add TRACE_DEFINE_ENUM() macro to map enums to their values
Several tracepoints use the helper functions __print_symbolic() or
__print_flags() and pass in enums that do the mapping between the
binary data stored and the value to print. This works well for reading
the ASCII trace files, but when the data is read via userspace tools
such as perf and trace-cmd, the conversion of the binary value to a
human string format is lost if an enum is used, as userspace does not
have access to what the ENUM is.
For example, the tracepoint trace_tlb_flush() has:
__print_symbolic(REC->reason,
{ TLB_FLUSH_ON_TASK_SWITCH, "flush on task switch" },
{ TLB_REMOTE_SHOOTDOWN, "remote shootdown" },
{ TLB_LOCAL_SHOOTDOWN, "local shootdown" },
{ TLB_LOCAL_MM_SHOOTDOWN, "local mm shootdown" })
Which maps the enum values to the strings they represent. But perf and
trace-cmd do no know what value TLB_LOCAL_MM_SHOOTDOWN is, and would
not be able to map it.
With TRACE_DEFINE_ENUM(), developers can place these in the event header
files and ftrace will convert the enums to their values:
By adding:
TRACE_DEFINE_ENUM(TLB_FLUSH_ON_TASK_SWITCH);
TRACE_DEFINE_ENUM(TLB_REMOTE_SHOOTDOWN);
TRACE_DEFINE_ENUM(TLB_LOCAL_SHOOTDOWN);
TRACE_DEFINE_ENUM(TLB_LOCAL_MM_SHOOTDOWN);
$ cat /sys/kernel/debug/tracing/events/tlb/tlb_flush/format
[...]
__print_symbolic(REC->reason,
{ 0, "flush on task switch" },
{ 1, "remote shootdown" },
{ 2, "local shootdown" },
{ 3, "local mm shootdown" })
The above is what userspace expects to see, and tools do not need to
be modified to parse them.
Link: http://lkml.kernel.org/r/20150403013802.220157513@goodmis.org
Cc: Guilherme Cox <cox@computer.org>
Cc: Tony Luck <tony.luck@gmail.com>
Cc: Xie XiuQi <xiexiuqi@huawei.com>
Acked-by: Namhyung Kim <namhyung@kernel.org>
Reviewed-by: Masami Hiramatsu <masami.hiramatsu.pt@hitachi.com>
Tested-by: Masami Hiramatsu <masami.hiramatsu.pt@hitachi.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2015-03-25 05:58:09 +08:00
|
|
|
*TRACE_SYSTEM##_##a = &__##TRACE_SYSTEM##_##a
|
|
|
|
|
|
2017-06-01 05:56:50 +08:00
|
|
|
#undef TRACE_DEFINE_SIZEOF
|
|
|
|
|
#define TRACE_DEFINE_SIZEOF(a) \
|
|
|
|
|
static struct trace_eval_map __used __initdata \
|
|
|
|
|
__##TRACE_SYSTEM##_##a = \
|
|
|
|
|
{ \
|
|
|
|
|
.system = TRACE_SYSTEM_STRING, \
|
|
|
|
|
.eval_string = "sizeof(" #a ")", \
|
|
|
|
|
.eval_value = sizeof(a) \
|
|
|
|
|
}; \
|
|
|
|
|
static struct trace_eval_map __used \
|
2020-10-22 10:36:07 +08:00
|
|
|
__section("_ftrace_eval_map") \
|
2017-06-01 05:56:50 +08:00
|
|
|
*TRACE_SYSTEM##_##a = &__##TRACE_SYSTEM##_##a
|
|
|
|
|
|
tracing: Create new TRACE_EVENT_TEMPLATE
There are some places in the kernel that define several tracepoints and
they are all identical besides the name. The code to enable, disable and
record is created for every trace point even if most of the code is
identical.
This patch adds TRACE_EVENT_TEMPLATE that lets the developer create
a template TRACE_EVENT and create trace points with DEFINE_EVENT, which
is based off of a given template. Each trace point used by this
will share most of the code, and bring down the size of the kernel
when there are several duplicate events.
Usage is:
TRACE_EVENT_TEMPLATE(name, proto, args, tstruct, assign, print);
Which would be the same as defining a normal TRACE_EVENT.
To create the trace events that the trace points will use:
DEFINE_EVENT(template, name, proto, args) is done. The template
is the name of the TRACE_EVENT_TEMPLATE to use. The name is the
name of the trace point. The parameters proto and args must be the same
as the proto and args of the template. If they are not the same,
then a compile error will result. I tried hard removing this duplication
but the C preprocessor is not powerful enough (or my CPP magic
experience points is not at a high enough level) to not need them.
A lot of trace events are coming in with new XFS development. Most of
the trace points are identical except for the name. The following shows
the advantage of having TRACE_EVENT_TEMPLATE:
$ size fs/xfs/xfs.o.*
text data bss dec hex filename
452114 2788 3520 458422 6feb6 fs/xfs/xfs.o.old
638482 38116 3744 680342 a6196 fs/xfs/xfs.o.template
996954 38116 4480 1039550 fdcbe fs/xfs/xfs.o.trace
xfs.o.old is without any tracepoints.
xfs.o.template uses the new TRACE_EVENT_TEMPLATE.
xfs.o.trace uses the current TRACE_EVENT macros.
Requested-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2009-11-19 09:27:27 +08:00
|
|
|
/*
|
2009-11-26 16:04:55 +08:00
|
|
|
* DECLARE_EVENT_CLASS can be used to add a generic function
|
tracing: Create new TRACE_EVENT_TEMPLATE
There are some places in the kernel that define several tracepoints and
they are all identical besides the name. The code to enable, disable and
record is created for every trace point even if most of the code is
identical.
This patch adds TRACE_EVENT_TEMPLATE that lets the developer create
a template TRACE_EVENT and create trace points with DEFINE_EVENT, which
is based off of a given template. Each trace point used by this
will share most of the code, and bring down the size of the kernel
when there are several duplicate events.
Usage is:
TRACE_EVENT_TEMPLATE(name, proto, args, tstruct, assign, print);
Which would be the same as defining a normal TRACE_EVENT.
To create the trace events that the trace points will use:
DEFINE_EVENT(template, name, proto, args) is done. The template
is the name of the TRACE_EVENT_TEMPLATE to use. The name is the
name of the trace point. The parameters proto and args must be the same
as the proto and args of the template. If they are not the same,
then a compile error will result. I tried hard removing this duplication
but the C preprocessor is not powerful enough (or my CPP magic
experience points is not at a high enough level) to not need them.
A lot of trace events are coming in with new XFS development. Most of
the trace points are identical except for the name. The following shows
the advantage of having TRACE_EVENT_TEMPLATE:
$ size fs/xfs/xfs.o.*
text data bss dec hex filename
452114 2788 3520 458422 6feb6 fs/xfs/xfs.o.old
638482 38116 3744 680342 a6196 fs/xfs/xfs.o.template
996954 38116 4480 1039550 fdcbe fs/xfs/xfs.o.trace
xfs.o.old is without any tracepoints.
xfs.o.template uses the new TRACE_EVENT_TEMPLATE.
xfs.o.trace uses the current TRACE_EVENT macros.
Requested-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2009-11-19 09:27:27 +08:00
|
|
|
* handlers for events. That is, if all events have the same
|
|
|
|
|
* parameters and just have distinct trace points.
|
|
|
|
|
* Each tracepoint can be defined with DEFINE_EVENT and that
|
2009-11-26 16:04:55 +08:00
|
|
|
* will map the DECLARE_EVENT_CLASS to the tracepoint.
|
tracing: Create new TRACE_EVENT_TEMPLATE
There are some places in the kernel that define several tracepoints and
they are all identical besides the name. The code to enable, disable and
record is created for every trace point even if most of the code is
identical.
This patch adds TRACE_EVENT_TEMPLATE that lets the developer create
a template TRACE_EVENT and create trace points with DEFINE_EVENT, which
is based off of a given template. Each trace point used by this
will share most of the code, and bring down the size of the kernel
when there are several duplicate events.
Usage is:
TRACE_EVENT_TEMPLATE(name, proto, args, tstruct, assign, print);
Which would be the same as defining a normal TRACE_EVENT.
To create the trace events that the trace points will use:
DEFINE_EVENT(template, name, proto, args) is done. The template
is the name of the TRACE_EVENT_TEMPLATE to use. The name is the
name of the trace point. The parameters proto and args must be the same
as the proto and args of the template. If they are not the same,
then a compile error will result. I tried hard removing this duplication
but the C preprocessor is not powerful enough (or my CPP magic
experience points is not at a high enough level) to not need them.
A lot of trace events are coming in with new XFS development. Most of
the trace points are identical except for the name. The following shows
the advantage of having TRACE_EVENT_TEMPLATE:
$ size fs/xfs/xfs.o.*
text data bss dec hex filename
452114 2788 3520 458422 6feb6 fs/xfs/xfs.o.old
638482 38116 3744 680342 a6196 fs/xfs/xfs.o.template
996954 38116 4480 1039550 fdcbe fs/xfs/xfs.o.trace
xfs.o.old is without any tracepoints.
xfs.o.template uses the new TRACE_EVENT_TEMPLATE.
xfs.o.trace uses the current TRACE_EVENT macros.
Requested-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2009-11-19 09:27:27 +08:00
|
|
|
*
|
|
|
|
|
* TRACE_EVENT is a one to one mapping between tracepoint and template.
|
|
|
|
|
*/
|
|
|
|
|
#undef TRACE_EVENT
|
|
|
|
|
#define TRACE_EVENT(name, proto, args, tstruct, assign, print) \
|
2009-11-26 16:04:55 +08:00
|
|
|
DECLARE_EVENT_CLASS(name, \
|
tracing: Create new TRACE_EVENT_TEMPLATE
There are some places in the kernel that define several tracepoints and
they are all identical besides the name. The code to enable, disable and
record is created for every trace point even if most of the code is
identical.
This patch adds TRACE_EVENT_TEMPLATE that lets the developer create
a template TRACE_EVENT and create trace points with DEFINE_EVENT, which
is based off of a given template. Each trace point used by this
will share most of the code, and bring down the size of the kernel
when there are several duplicate events.
Usage is:
TRACE_EVENT_TEMPLATE(name, proto, args, tstruct, assign, print);
Which would be the same as defining a normal TRACE_EVENT.
To create the trace events that the trace points will use:
DEFINE_EVENT(template, name, proto, args) is done. The template
is the name of the TRACE_EVENT_TEMPLATE to use. The name is the
name of the trace point. The parameters proto and args must be the same
as the proto and args of the template. If they are not the same,
then a compile error will result. I tried hard removing this duplication
but the C preprocessor is not powerful enough (or my CPP magic
experience points is not at a high enough level) to not need them.
A lot of trace events are coming in with new XFS development. Most of
the trace points are identical except for the name. The following shows
the advantage of having TRACE_EVENT_TEMPLATE:
$ size fs/xfs/xfs.o.*
text data bss dec hex filename
452114 2788 3520 458422 6feb6 fs/xfs/xfs.o.old
638482 38116 3744 680342 a6196 fs/xfs/xfs.o.template
996954 38116 4480 1039550 fdcbe fs/xfs/xfs.o.trace
xfs.o.old is without any tracepoints.
xfs.o.template uses the new TRACE_EVENT_TEMPLATE.
xfs.o.trace uses the current TRACE_EVENT macros.
Requested-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2009-11-19 09:27:27 +08:00
|
|
|
PARAMS(proto), \
|
|
|
|
|
PARAMS(args), \
|
|
|
|
|
PARAMS(tstruct), \
|
|
|
|
|
PARAMS(assign), \
|
|
|
|
|
PARAMS(print)); \
|
|
|
|
|
DEFINE_EVENT(name, name, PARAMS(proto), PARAMS(args));
|
|
|
|
|
|
|
|
|
|
|
tracing/events: introduce __dynamic_array()
__string() is limited:
- it's a char array, but we may want to define array with other types
- a source string should be available, but we may just know the string size
We introduce __dynamic_array() to break those limitations, and __string()
becomes a wrapper of it. As a side effect, now __get_str() can be used
in TP_fast_assign but not only TP_print.
Take XFS for example, we have the string length in the dirent, but the
string itself is not NULL-terminated, so __dynamic_array() can be used:
TRACE_EVENT(xfs_dir2,
TP_PROTO(struct xfs_da_args *args),
TP_ARGS(args),
TP_STRUCT__entry(
__field(int, namelen)
__dynamic_array(char, name, args->namelen + 1)
...
),
TP_fast_assign(
char *name = __get_str(name);
if (args->namelen)
memcpy(name, args->name, args->namelen);
name[args->namelen] = '\0';
__entry->namelen = args->namelen;
),
TP_printk("name %.*s namelen %d",
__entry->namelen ? __get_str(name) : NULL
__entry->namelen)
);
[ Impact: allow defining dynamic size arrays ]
Signed-off-by: Li Zefan <lizf@cn.fujitsu.com>
LKML-Reference: <4A2384D2.3080403@cn.fujitsu.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2009-06-01 15:35:46 +08:00
|
|
|
#undef __field
|
|
|
|
|
#define __field(type, item) type item;
|
|
|
|
|
|
2009-08-07 10:33:22 +08:00
|
|
|
#undef __field_ext
|
|
|
|
|
#define __field_ext(type, item, filter_type) type item;
|
|
|
|
|
|
2014-06-17 20:59:16 +08:00
|
|
|
#undef __field_struct
|
|
|
|
|
#define __field_struct(type, item) type item;
|
|
|
|
|
|
|
|
|
|
#undef __field_struct_ext
|
|
|
|
|
#define __field_struct_ext(type, item, filter_type) type item;
|
|
|
|
|
|
2009-04-14 00:25:37 +08:00
|
|
|
#undef __array
|
|
|
|
|
#define __array(type, item, len) type item[len];
|
|
|
|
|
|
tracing/events: introduce __dynamic_array()
__string() is limited:
- it's a char array, but we may want to define array with other types
- a source string should be available, but we may just know the string size
We introduce __dynamic_array() to break those limitations, and __string()
becomes a wrapper of it. As a side effect, now __get_str() can be used
in TP_fast_assign but not only TP_print.
Take XFS for example, we have the string length in the dirent, but the
string itself is not NULL-terminated, so __dynamic_array() can be used:
TRACE_EVENT(xfs_dir2,
TP_PROTO(struct xfs_da_args *args),
TP_ARGS(args),
TP_STRUCT__entry(
__field(int, namelen)
__dynamic_array(char, name, args->namelen + 1)
...
),
TP_fast_assign(
char *name = __get_str(name);
if (args->namelen)
memcpy(name, args->name, args->namelen);
name[args->namelen] = '\0';
__entry->namelen = args->namelen;
),
TP_printk("name %.*s namelen %d",
__entry->namelen ? __get_str(name) : NULL
__entry->namelen)
);
[ Impact: allow defining dynamic size arrays ]
Signed-off-by: Li Zefan <lizf@cn.fujitsu.com>
LKML-Reference: <4A2384D2.3080403@cn.fujitsu.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2009-06-01 15:35:46 +08:00
|
|
|
#undef __dynamic_array
|
2009-07-16 10:54:02 +08:00
|
|
|
#define __dynamic_array(type, item, len) u32 __data_loc_##item;
|
2009-04-14 00:25:37 +08:00
|
|
|
|
tracing/events: provide string with undefined size support
This patch provides the support for dynamic size strings on
event tracing.
The key concept is to use a structure with an ending char array field of
undefined size and use such ability to allocate the minimal size on the
ring buffer to make one or more string entries fit inside, as opposite
to a fixed length strings with upper bound.
The strings themselves are represented using fields which have an offset
value from the beginning of the entry.
This patch provides three new macros:
__string(item, src)
This one declares a string to the structure inside TP_STRUCT__entry.
You need to provide the name of the string field and the source that will
be copied inside.
This will also add the dynamic size of the string needed for the ring
buffer entry allocation.
A stack allocated structure is used to temporarily store the offset
of each strings, avoiding double calls to strlen() on each event
insertion.
__get_str(field)
This one will give you a pointer to the string you have created. This
is an abstract helper to resolve the absolute address given the field
name which is a relative address from the beginning of the trace_structure.
__assign_str(dst, src)
Use this macro to automatically perform the string copy from src to
dst. src must be a variable to assign and dst is the name of a __string
field.
Example on how to use it:
TRACE_EVENT(my_event,
TP_PROTO(char *src1, char *src2),
TP_ARGS(src1, src2),
TP_STRUCT__entry(
__string(str1, src1)
__string(str2, src2)
),
TP_fast_assign(
__assign_str(str1, src1);
__assign_str(str2, src2);
),
TP_printk("%s %s", __get_str(src1), __get_str(src2))
)
Of course you can mix-up any __field or __array inside this
TRACE_EVENT. The position of the __string or __assign_str
doesn't matter.
Changes in v2:
Address the suggestion of Steven Rostedt: drop the opening_string() macro
and redefine __ending_string() to get the size of the string to be copied
instead of overwritting the whole ring buffer allocation.
Changes in v3:
Address other suggestions of Steven Rostedt and Peter Zijlstra with
some changes: drop the __ending_string and the need to have only one
string field.
Use offsets instead of absolute addresses.
[ Impact: allow more compact memory usage for string tracing ]
Signed-off-by: Frederic Weisbecker <fweisbec@gmail.com>
Cc: Steven Rostedt <rostedt@goodmis.org>
Cc: Li Zefan <lizf@cn.fujitsu.com>
Cc: Peter Zijlstra <a.p.zijlstra@chello.nl>
2009-04-19 10:51:29 +08:00
|
|
|
#undef __string
|
tracing/events: introduce __dynamic_array()
__string() is limited:
- it's a char array, but we may want to define array with other types
- a source string should be available, but we may just know the string size
We introduce __dynamic_array() to break those limitations, and __string()
becomes a wrapper of it. As a side effect, now __get_str() can be used
in TP_fast_assign but not only TP_print.
Take XFS for example, we have the string length in the dirent, but the
string itself is not NULL-terminated, so __dynamic_array() can be used:
TRACE_EVENT(xfs_dir2,
TP_PROTO(struct xfs_da_args *args),
TP_ARGS(args),
TP_STRUCT__entry(
__field(int, namelen)
__dynamic_array(char, name, args->namelen + 1)
...
),
TP_fast_assign(
char *name = __get_str(name);
if (args->namelen)
memcpy(name, args->name, args->namelen);
name[args->namelen] = '\0';
__entry->namelen = args->namelen;
),
TP_printk("name %.*s namelen %d",
__entry->namelen ? __get_str(name) : NULL
__entry->namelen)
);
[ Impact: allow defining dynamic size arrays ]
Signed-off-by: Li Zefan <lizf@cn.fujitsu.com>
LKML-Reference: <4A2384D2.3080403@cn.fujitsu.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2009-06-01 15:35:46 +08:00
|
|
|
#define __string(item, src) __dynamic_array(char, item, -1)
|
tracing/events: provide string with undefined size support
This patch provides the support for dynamic size strings on
event tracing.
The key concept is to use a structure with an ending char array field of
undefined size and use such ability to allocate the minimal size on the
ring buffer to make one or more string entries fit inside, as opposite
to a fixed length strings with upper bound.
The strings themselves are represented using fields which have an offset
value from the beginning of the entry.
This patch provides three new macros:
__string(item, src)
This one declares a string to the structure inside TP_STRUCT__entry.
You need to provide the name of the string field and the source that will
be copied inside.
This will also add the dynamic size of the string needed for the ring
buffer entry allocation.
A stack allocated structure is used to temporarily store the offset
of each strings, avoiding double calls to strlen() on each event
insertion.
__get_str(field)
This one will give you a pointer to the string you have created. This
is an abstract helper to resolve the absolute address given the field
name which is a relative address from the beginning of the trace_structure.
__assign_str(dst, src)
Use this macro to automatically perform the string copy from src to
dst. src must be a variable to assign and dst is the name of a __string
field.
Example on how to use it:
TRACE_EVENT(my_event,
TP_PROTO(char *src1, char *src2),
TP_ARGS(src1, src2),
TP_STRUCT__entry(
__string(str1, src1)
__string(str2, src2)
),
TP_fast_assign(
__assign_str(str1, src1);
__assign_str(str2, src2);
),
TP_printk("%s %s", __get_str(src1), __get_str(src2))
)
Of course you can mix-up any __field or __array inside this
TRACE_EVENT. The position of the __string or __assign_str
doesn't matter.
Changes in v2:
Address the suggestion of Steven Rostedt: drop the opening_string() macro
and redefine __ending_string() to get the size of the string to be copied
instead of overwritting the whole ring buffer allocation.
Changes in v3:
Address other suggestions of Steven Rostedt and Peter Zijlstra with
some changes: drop the __ending_string and the need to have only one
string field.
Use offsets instead of absolute addresses.
[ Impact: allow more compact memory usage for string tracing ]
Signed-off-by: Frederic Weisbecker <fweisbec@gmail.com>
Cc: Steven Rostedt <rostedt@goodmis.org>
Cc: Li Zefan <lizf@cn.fujitsu.com>
Cc: Peter Zijlstra <a.p.zijlstra@chello.nl>
2009-04-19 10:51:29 +08:00
|
|
|
|
2021-07-17 08:55:10 +08:00
|
|
|
#undef __string_len
|
|
|
|
|
#define __string_len(item, src, len) __dynamic_array(char, item, -1)
|
|
|
|
|
|
tracing: Add __bitmask() macro to trace events to cpumasks and other bitmasks
Being able to show a cpumask of events can be useful as some events
may affect only some CPUs. There is no standard way to record the
cpumask and converting it to a string is rather expensive during
the trace as traces happen in hotpaths. It would be better to record
the raw event mask and be able to parse it at print time.
The following macros were added for use with the TRACE_EVENT() macro:
__bitmask()
__assign_bitmask()
__get_bitmask()
To test this, I added this to the sched_migrate_task event, which
looked like this:
TRACE_EVENT(sched_migrate_task,
TP_PROTO(struct task_struct *p, int dest_cpu, const struct cpumask *cpus),
TP_ARGS(p, dest_cpu, cpus),
TP_STRUCT__entry(
__array( char, comm, TASK_COMM_LEN )
__field( pid_t, pid )
__field( int, prio )
__field( int, orig_cpu )
__field( int, dest_cpu )
__bitmask( cpumask, num_possible_cpus() )
),
TP_fast_assign(
memcpy(__entry->comm, p->comm, TASK_COMM_LEN);
__entry->pid = p->pid;
__entry->prio = p->prio;
__entry->orig_cpu = task_cpu(p);
__entry->dest_cpu = dest_cpu;
__assign_bitmask(cpumask, cpumask_bits(cpus), num_possible_cpus());
),
TP_printk("comm=%s pid=%d prio=%d orig_cpu=%d dest_cpu=%d cpumask=%s",
__entry->comm, __entry->pid, __entry->prio,
__entry->orig_cpu, __entry->dest_cpu,
__get_bitmask(cpumask))
);
With the output of:
ksmtuned-3613 [003] d..2 485.220508: sched_migrate_task: comm=ksmtuned pid=3615 prio=120 orig_cpu=3 dest_cpu=2 cpumask=00000000,0000000f
migration/1-13 [001] d..5 485.221202: sched_migrate_task: comm=ksmtuned pid=3614 prio=120 orig_cpu=1 dest_cpu=0 cpumask=00000000,0000000f
awk-3615 [002] d.H5 485.221747: sched_migrate_task: comm=rcu_preempt pid=7 prio=120 orig_cpu=0 dest_cpu=1 cpumask=00000000,000000ff
migration/2-18 [002] d..5 485.222062: sched_migrate_task: comm=ksmtuned pid=3615 prio=120 orig_cpu=2 dest_cpu=3 cpumask=00000000,0000000f
Link: http://lkml.kernel.org/r/1399377998-14870-6-git-send-email-javi.merino@arm.com
Link: http://lkml.kernel.org/r/20140506132238.22e136d1@gandalf.local.home
Suggested-by: Javi Merino <javi.merino@arm.com>
Tested-by: Javi Merino <javi.merino@arm.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2014-05-07 01:10:24 +08:00
|
|
|
#undef __bitmask
|
|
|
|
|
#define __bitmask(item, nr_bits) __dynamic_array(char, item, -1)
|
|
|
|
|
|
2009-04-14 00:25:37 +08:00
|
|
|
#undef TP_STRUCT__entry
|
|
|
|
|
#define TP_STRUCT__entry(args...) args
|
|
|
|
|
|
2009-11-26 16:04:55 +08:00
|
|
|
#undef DECLARE_EVENT_CLASS
|
|
|
|
|
#define DECLARE_EVENT_CLASS(name, proto, args, tstruct, assign, print) \
|
2015-05-14 03:27:47 +08:00
|
|
|
struct trace_event_raw_##name { \
|
tracing: Create new TRACE_EVENT_TEMPLATE
There are some places in the kernel that define several tracepoints and
they are all identical besides the name. The code to enable, disable and
record is created for every trace point even if most of the code is
identical.
This patch adds TRACE_EVENT_TEMPLATE that lets the developer create
a template TRACE_EVENT and create trace points with DEFINE_EVENT, which
is based off of a given template. Each trace point used by this
will share most of the code, and bring down the size of the kernel
when there are several duplicate events.
Usage is:
TRACE_EVENT_TEMPLATE(name, proto, args, tstruct, assign, print);
Which would be the same as defining a normal TRACE_EVENT.
To create the trace events that the trace points will use:
DEFINE_EVENT(template, name, proto, args) is done. The template
is the name of the TRACE_EVENT_TEMPLATE to use. The name is the
name of the trace point. The parameters proto and args must be the same
as the proto and args of the template. If they are not the same,
then a compile error will result. I tried hard removing this duplication
but the C preprocessor is not powerful enough (or my CPP magic
experience points is not at a high enough level) to not need them.
A lot of trace events are coming in with new XFS development. Most of
the trace points are identical except for the name. The following shows
the advantage of having TRACE_EVENT_TEMPLATE:
$ size fs/xfs/xfs.o.*
text data bss dec hex filename
452114 2788 3520 458422 6feb6 fs/xfs/xfs.o.old
638482 38116 3744 680342 a6196 fs/xfs/xfs.o.template
996954 38116 4480 1039550 fdcbe fs/xfs/xfs.o.trace
xfs.o.old is without any tracepoints.
xfs.o.template uses the new TRACE_EVENT_TEMPLATE.
xfs.o.trace uses the current TRACE_EVENT macros.
Requested-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2009-11-19 09:27:27 +08:00
|
|
|
struct trace_entry ent; \
|
|
|
|
|
tstruct \
|
|
|
|
|
char __data[0]; \
|
2010-04-20 22:47:33 +08:00
|
|
|
}; \
|
|
|
|
|
\
|
2015-05-05 23:45:27 +08:00
|
|
|
static struct trace_event_class event_class_##name;
|
2010-04-20 22:47:33 +08:00
|
|
|
|
tracing: Create new TRACE_EVENT_TEMPLATE
There are some places in the kernel that define several tracepoints and
they are all identical besides the name. The code to enable, disable and
record is created for every trace point even if most of the code is
identical.
This patch adds TRACE_EVENT_TEMPLATE that lets the developer create
a template TRACE_EVENT and create trace points with DEFINE_EVENT, which
is based off of a given template. Each trace point used by this
will share most of the code, and bring down the size of the kernel
when there are several duplicate events.
Usage is:
TRACE_EVENT_TEMPLATE(name, proto, args, tstruct, assign, print);
Which would be the same as defining a normal TRACE_EVENT.
To create the trace events that the trace points will use:
DEFINE_EVENT(template, name, proto, args) is done. The template
is the name of the TRACE_EVENT_TEMPLATE to use. The name is the
name of the trace point. The parameters proto and args must be the same
as the proto and args of the template. If they are not the same,
then a compile error will result. I tried hard removing this duplication
but the C preprocessor is not powerful enough (or my CPP magic
experience points is not at a high enough level) to not need them.
A lot of trace events are coming in with new XFS development. Most of
the trace points are identical except for the name. The following shows
the advantage of having TRACE_EVENT_TEMPLATE:
$ size fs/xfs/xfs.o.*
text data bss dec hex filename
452114 2788 3520 458422 6feb6 fs/xfs/xfs.o.old
638482 38116 3744 680342 a6196 fs/xfs/xfs.o.template
996954 38116 4480 1039550 fdcbe fs/xfs/xfs.o.trace
xfs.o.old is without any tracepoints.
xfs.o.template uses the new TRACE_EVENT_TEMPLATE.
xfs.o.trace uses the current TRACE_EVENT macros.
Requested-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2009-11-19 09:27:27 +08:00
|
|
|
#undef DEFINE_EVENT
|
|
|
|
|
#define DEFINE_EVENT(template, name, proto, args) \
|
2015-05-05 23:45:27 +08:00
|
|
|
static struct trace_event_call __used \
|
2010-02-25 02:59:23 +08:00
|
|
|
__attribute__((__aligned__(4))) event_##name
|
2009-04-14 00:25:37 +08:00
|
|
|
|
2013-06-20 23:44:44 +08:00
|
|
|
#undef DEFINE_EVENT_FN
|
|
|
|
|
#define DEFINE_EVENT_FN(template, name, proto, args, reg, unreg) \
|
|
|
|
|
DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
|
|
|
|
|
|
2009-11-19 09:36:26 +08:00
|
|
|
#undef DEFINE_EVENT_PRINT
|
|
|
|
|
#define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
|
|
|
|
|
DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
|
|
|
|
|
|
2009-08-25 05:43:13 +08:00
|
|
|
/* Callbacks are meaningless to ftrace. */
|
|
|
|
|
#undef TRACE_EVENT_FN
|
tracing: Fix double CPP substitution in TRACE_EVENT_FN
TRACE_EVENT_FN relays on TRACE_EVENT by reprocessing its parameters
into the ftrace events CPP macro. This leads to a double substitution
in some cases.
For example, a bad consequence is a format always prefixed by
"%s, %s\n" for every TRACE_EVENT_FN based events.
Eg:
cat /debug/tracing/events/syscalls/sys_enter/format
[...]
print fmt: "%s, %s\n", "\"NR %ld (%lx, %lx, %lx, %lx, %lx, %lx)\"",\
"REC->id, REC->args[0], REC->args[1], REC->args[2], REC->args[3],\
REC->args[4], REC->args[5]"
This creates a failure in post-processing tools such as perf trace or
trace-cmd.
Then drop this double substitution and replace it by a new __cpparg()
macro that relays CPP arguments containing commas.
Signed-off-by: Frederic Weisbecker <fweisbec@gmail.com>
Cc: Josh Stone <jistone@redhat.com>
Cc: Li Zefan <lizf@cn.fujitsu.com>
Cc: Steven Rostedt <srostedt@redhat.com>
Cc: Jason Baron <jbaron@redhat.com>
LKML-Reference: <1251413406-6704-1-git-send-email-fweisbec@gmail.com>
Signed-off-by: Ingo Molnar <mingo@elte.hu>
2009-08-28 06:50:06 +08:00
|
|
|
#define TRACE_EVENT_FN(name, proto, args, tstruct, \
|
|
|
|
|
assign, print, reg, unreg) \
|
2010-07-21 00:41:24 +08:00
|
|
|
TRACE_EVENT(name, PARAMS(proto), PARAMS(args), \
|
|
|
|
|
PARAMS(tstruct), PARAMS(assign), PARAMS(print)) \
|
2015-12-15 04:18:05 +08:00
|
|
|
|
|
|
|
|
#undef TRACE_EVENT_FN_COND
|
|
|
|
|
#define TRACE_EVENT_FN_COND(name, proto, args, cond, tstruct, \
|
|
|
|
|
assign, print, reg, unreg) \
|
|
|
|
|
TRACE_EVENT_CONDITION(name, PARAMS(proto), PARAMS(args), PARAMS(cond), \
|
|
|
|
|
PARAMS(tstruct), PARAMS(assign), PARAMS(print)) \
|
2009-08-25 05:43:13 +08:00
|
|
|
|
2010-11-18 08:46:57 +08:00
|
|
|
#undef TRACE_EVENT_FLAGS
|
|
|
|
|
#define TRACE_EVENT_FLAGS(name, value) \
|
2010-11-18 09:11:42 +08:00
|
|
|
__TRACE_EVENT_FLAGS(name, value)
|
2010-11-18 08:46:57 +08:00
|
|
|
|
2013-11-14 23:23:04 +08:00
|
|
|
#undef TRACE_EVENT_PERF_PERM
|
|
|
|
|
#define TRACE_EVENT_PERF_PERM(name, expr...) \
|
|
|
|
|
__TRACE_EVENT_PERF_PERM(name, expr)
|
|
|
|
|
|
2009-04-14 00:25:37 +08:00
|
|
|
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Stage 2 of the trace events.
|
|
|
|
|
*
|
tracing/events: provide string with undefined size support
This patch provides the support for dynamic size strings on
event tracing.
The key concept is to use a structure with an ending char array field of
undefined size and use such ability to allocate the minimal size on the
ring buffer to make one or more string entries fit inside, as opposite
to a fixed length strings with upper bound.
The strings themselves are represented using fields which have an offset
value from the beginning of the entry.
This patch provides three new macros:
__string(item, src)
This one declares a string to the structure inside TP_STRUCT__entry.
You need to provide the name of the string field and the source that will
be copied inside.
This will also add the dynamic size of the string needed for the ring
buffer entry allocation.
A stack allocated structure is used to temporarily store the offset
of each strings, avoiding double calls to strlen() on each event
insertion.
__get_str(field)
This one will give you a pointer to the string you have created. This
is an abstract helper to resolve the absolute address given the field
name which is a relative address from the beginning of the trace_structure.
__assign_str(dst, src)
Use this macro to automatically perform the string copy from src to
dst. src must be a variable to assign and dst is the name of a __string
field.
Example on how to use it:
TRACE_EVENT(my_event,
TP_PROTO(char *src1, char *src2),
TP_ARGS(src1, src2),
TP_STRUCT__entry(
__string(str1, src1)
__string(str2, src2)
),
TP_fast_assign(
__assign_str(str1, src1);
__assign_str(str2, src2);
),
TP_printk("%s %s", __get_str(src1), __get_str(src2))
)
Of course you can mix-up any __field or __array inside this
TRACE_EVENT. The position of the __string or __assign_str
doesn't matter.
Changes in v2:
Address the suggestion of Steven Rostedt: drop the opening_string() macro
and redefine __ending_string() to get the size of the string to be copied
instead of overwritting the whole ring buffer allocation.
Changes in v3:
Address other suggestions of Steven Rostedt and Peter Zijlstra with
some changes: drop the __ending_string and the need to have only one
string field.
Use offsets instead of absolute addresses.
[ Impact: allow more compact memory usage for string tracing ]
Signed-off-by: Frederic Weisbecker <fweisbec@gmail.com>
Cc: Steven Rostedt <rostedt@goodmis.org>
Cc: Li Zefan <lizf@cn.fujitsu.com>
Cc: Peter Zijlstra <a.p.zijlstra@chello.nl>
2009-04-19 10:51:29 +08:00
|
|
|
* Include the following:
|
|
|
|
|
*
|
2015-05-14 03:33:52 +08:00
|
|
|
* struct trace_event_data_offsets_<call> {
|
2009-07-16 10:54:02 +08:00
|
|
|
* u32 <item1>;
|
|
|
|
|
* u32 <item2>;
|
tracing/events: provide string with undefined size support
This patch provides the support for dynamic size strings on
event tracing.
The key concept is to use a structure with an ending char array field of
undefined size and use such ability to allocate the minimal size on the
ring buffer to make one or more string entries fit inside, as opposite
to a fixed length strings with upper bound.
The strings themselves are represented using fields which have an offset
value from the beginning of the entry.
This patch provides three new macros:
__string(item, src)
This one declares a string to the structure inside TP_STRUCT__entry.
You need to provide the name of the string field and the source that will
be copied inside.
This will also add the dynamic size of the string needed for the ring
buffer entry allocation.
A stack allocated structure is used to temporarily store the offset
of each strings, avoiding double calls to strlen() on each event
insertion.
__get_str(field)
This one will give you a pointer to the string you have created. This
is an abstract helper to resolve the absolute address given the field
name which is a relative address from the beginning of the trace_structure.
__assign_str(dst, src)
Use this macro to automatically perform the string copy from src to
dst. src must be a variable to assign and dst is the name of a __string
field.
Example on how to use it:
TRACE_EVENT(my_event,
TP_PROTO(char *src1, char *src2),
TP_ARGS(src1, src2),
TP_STRUCT__entry(
__string(str1, src1)
__string(str2, src2)
),
TP_fast_assign(
__assign_str(str1, src1);
__assign_str(str2, src2);
),
TP_printk("%s %s", __get_str(src1), __get_str(src2))
)
Of course you can mix-up any __field or __array inside this
TRACE_EVENT. The position of the __string or __assign_str
doesn't matter.
Changes in v2:
Address the suggestion of Steven Rostedt: drop the opening_string() macro
and redefine __ending_string() to get the size of the string to be copied
instead of overwritting the whole ring buffer allocation.
Changes in v3:
Address other suggestions of Steven Rostedt and Peter Zijlstra with
some changes: drop the __ending_string and the need to have only one
string field.
Use offsets instead of absolute addresses.
[ Impact: allow more compact memory usage for string tracing ]
Signed-off-by: Frederic Weisbecker <fweisbec@gmail.com>
Cc: Steven Rostedt <rostedt@goodmis.org>
Cc: Li Zefan <lizf@cn.fujitsu.com>
Cc: Peter Zijlstra <a.p.zijlstra@chello.nl>
2009-04-19 10:51:29 +08:00
|
|
|
* [...]
|
|
|
|
|
* };
|
|
|
|
|
*
|
2009-07-16 10:54:02 +08:00
|
|
|
* The __dynamic_array() macro will create each u32 <item>, this is
|
tracing/events: introduce __dynamic_array()
__string() is limited:
- it's a char array, but we may want to define array with other types
- a source string should be available, but we may just know the string size
We introduce __dynamic_array() to break those limitations, and __string()
becomes a wrapper of it. As a side effect, now __get_str() can be used
in TP_fast_assign but not only TP_print.
Take XFS for example, we have the string length in the dirent, but the
string itself is not NULL-terminated, so __dynamic_array() can be used:
TRACE_EVENT(xfs_dir2,
TP_PROTO(struct xfs_da_args *args),
TP_ARGS(args),
TP_STRUCT__entry(
__field(int, namelen)
__dynamic_array(char, name, args->namelen + 1)
...
),
TP_fast_assign(
char *name = __get_str(name);
if (args->namelen)
memcpy(name, args->name, args->namelen);
name[args->namelen] = '\0';
__entry->namelen = args->namelen;
),
TP_printk("name %.*s namelen %d",
__entry->namelen ? __get_str(name) : NULL
__entry->namelen)
);
[ Impact: allow defining dynamic size arrays ]
Signed-off-by: Li Zefan <lizf@cn.fujitsu.com>
LKML-Reference: <4A2384D2.3080403@cn.fujitsu.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2009-06-01 15:35:46 +08:00
|
|
|
* to keep the offset of each array from the beginning of the event.
|
2009-07-16 10:54:02 +08:00
|
|
|
* The size of an array is also encoded, in the higher 16 bits of <item>.
|
tracing/events: provide string with undefined size support
This patch provides the support for dynamic size strings on
event tracing.
The key concept is to use a structure with an ending char array field of
undefined size and use such ability to allocate the minimal size on the
ring buffer to make one or more string entries fit inside, as opposite
to a fixed length strings with upper bound.
The strings themselves are represented using fields which have an offset
value from the beginning of the entry.
This patch provides three new macros:
__string(item, src)
This one declares a string to the structure inside TP_STRUCT__entry.
You need to provide the name of the string field and the source that will
be copied inside.
This will also add the dynamic size of the string needed for the ring
buffer entry allocation.
A stack allocated structure is used to temporarily store the offset
of each strings, avoiding double calls to strlen() on each event
insertion.
__get_str(field)
This one will give you a pointer to the string you have created. This
is an abstract helper to resolve the absolute address given the field
name which is a relative address from the beginning of the trace_structure.
__assign_str(dst, src)
Use this macro to automatically perform the string copy from src to
dst. src must be a variable to assign and dst is the name of a __string
field.
Example on how to use it:
TRACE_EVENT(my_event,
TP_PROTO(char *src1, char *src2),
TP_ARGS(src1, src2),
TP_STRUCT__entry(
__string(str1, src1)
__string(str2, src2)
),
TP_fast_assign(
__assign_str(str1, src1);
__assign_str(str2, src2);
),
TP_printk("%s %s", __get_str(src1), __get_str(src2))
)
Of course you can mix-up any __field or __array inside this
TRACE_EVENT. The position of the __string or __assign_str
doesn't matter.
Changes in v2:
Address the suggestion of Steven Rostedt: drop the opening_string() macro
and redefine __ending_string() to get the size of the string to be copied
instead of overwritting the whole ring buffer allocation.
Changes in v3:
Address other suggestions of Steven Rostedt and Peter Zijlstra with
some changes: drop the __ending_string and the need to have only one
string field.
Use offsets instead of absolute addresses.
[ Impact: allow more compact memory usage for string tracing ]
Signed-off-by: Frederic Weisbecker <fweisbec@gmail.com>
Cc: Steven Rostedt <rostedt@goodmis.org>
Cc: Li Zefan <lizf@cn.fujitsu.com>
Cc: Peter Zijlstra <a.p.zijlstra@chello.nl>
2009-04-19 10:51:29 +08:00
|
|
|
*/
|
|
|
|
|
|
tracing: Add TRACE_DEFINE_ENUM() macro to map enums to their values
Several tracepoints use the helper functions __print_symbolic() or
__print_flags() and pass in enums that do the mapping between the
binary data stored and the value to print. This works well for reading
the ASCII trace files, but when the data is read via userspace tools
such as perf and trace-cmd, the conversion of the binary value to a
human string format is lost if an enum is used, as userspace does not
have access to what the ENUM is.
For example, the tracepoint trace_tlb_flush() has:
__print_symbolic(REC->reason,
{ TLB_FLUSH_ON_TASK_SWITCH, "flush on task switch" },
{ TLB_REMOTE_SHOOTDOWN, "remote shootdown" },
{ TLB_LOCAL_SHOOTDOWN, "local shootdown" },
{ TLB_LOCAL_MM_SHOOTDOWN, "local mm shootdown" })
Which maps the enum values to the strings they represent. But perf and
trace-cmd do no know what value TLB_LOCAL_MM_SHOOTDOWN is, and would
not be able to map it.
With TRACE_DEFINE_ENUM(), developers can place these in the event header
files and ftrace will convert the enums to their values:
By adding:
TRACE_DEFINE_ENUM(TLB_FLUSH_ON_TASK_SWITCH);
TRACE_DEFINE_ENUM(TLB_REMOTE_SHOOTDOWN);
TRACE_DEFINE_ENUM(TLB_LOCAL_SHOOTDOWN);
TRACE_DEFINE_ENUM(TLB_LOCAL_MM_SHOOTDOWN);
$ cat /sys/kernel/debug/tracing/events/tlb/tlb_flush/format
[...]
__print_symbolic(REC->reason,
{ 0, "flush on task switch" },
{ 1, "remote shootdown" },
{ 2, "local shootdown" },
{ 3, "local mm shootdown" })
The above is what userspace expects to see, and tools do not need to
be modified to parse them.
Link: http://lkml.kernel.org/r/20150403013802.220157513@goodmis.org
Cc: Guilherme Cox <cox@computer.org>
Cc: Tony Luck <tony.luck@gmail.com>
Cc: Xie XiuQi <xiexiuqi@huawei.com>
Acked-by: Namhyung Kim <namhyung@kernel.org>
Reviewed-by: Masami Hiramatsu <masami.hiramatsu.pt@hitachi.com>
Tested-by: Masami Hiramatsu <masami.hiramatsu.pt@hitachi.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2015-03-25 05:58:09 +08:00
|
|
|
#undef TRACE_DEFINE_ENUM
|
|
|
|
|
#define TRACE_DEFINE_ENUM(a)
|
|
|
|
|
|
2017-06-01 05:56:50 +08:00
|
|
|
#undef TRACE_DEFINE_SIZEOF
|
|
|
|
|
#define TRACE_DEFINE_SIZEOF(a)
|
|
|
|
|
|
tracing/events: introduce __dynamic_array()
__string() is limited:
- it's a char array, but we may want to define array with other types
- a source string should be available, but we may just know the string size
We introduce __dynamic_array() to break those limitations, and __string()
becomes a wrapper of it. As a side effect, now __get_str() can be used
in TP_fast_assign but not only TP_print.
Take XFS for example, we have the string length in the dirent, but the
string itself is not NULL-terminated, so __dynamic_array() can be used:
TRACE_EVENT(xfs_dir2,
TP_PROTO(struct xfs_da_args *args),
TP_ARGS(args),
TP_STRUCT__entry(
__field(int, namelen)
__dynamic_array(char, name, args->namelen + 1)
...
),
TP_fast_assign(
char *name = __get_str(name);
if (args->namelen)
memcpy(name, args->name, args->namelen);
name[args->namelen] = '\0';
__entry->namelen = args->namelen;
),
TP_printk("name %.*s namelen %d",
__entry->namelen ? __get_str(name) : NULL
__entry->namelen)
);
[ Impact: allow defining dynamic size arrays ]
Signed-off-by: Li Zefan <lizf@cn.fujitsu.com>
LKML-Reference: <4A2384D2.3080403@cn.fujitsu.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2009-06-01 15:35:46 +08:00
|
|
|
#undef __field
|
2009-08-07 10:33:22 +08:00
|
|
|
#define __field(type, item)
|
|
|
|
|
|
|
|
|
|
#undef __field_ext
|
|
|
|
|
#define __field_ext(type, item, filter_type)
|
tracing/events: introduce __dynamic_array()
__string() is limited:
- it's a char array, but we may want to define array with other types
- a source string should be available, but we may just know the string size
We introduce __dynamic_array() to break those limitations, and __string()
becomes a wrapper of it. As a side effect, now __get_str() can be used
in TP_fast_assign but not only TP_print.
Take XFS for example, we have the string length in the dirent, but the
string itself is not NULL-terminated, so __dynamic_array() can be used:
TRACE_EVENT(xfs_dir2,
TP_PROTO(struct xfs_da_args *args),
TP_ARGS(args),
TP_STRUCT__entry(
__field(int, namelen)
__dynamic_array(char, name, args->namelen + 1)
...
),
TP_fast_assign(
char *name = __get_str(name);
if (args->namelen)
memcpy(name, args->name, args->namelen);
name[args->namelen] = '\0';
__entry->namelen = args->namelen;
),
TP_printk("name %.*s namelen %d",
__entry->namelen ? __get_str(name) : NULL
__entry->namelen)
);
[ Impact: allow defining dynamic size arrays ]
Signed-off-by: Li Zefan <lizf@cn.fujitsu.com>
LKML-Reference: <4A2384D2.3080403@cn.fujitsu.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2009-06-01 15:35:46 +08:00
|
|
|
|
2014-06-17 20:59:16 +08:00
|
|
|
#undef __field_struct
|
|
|
|
|
#define __field_struct(type, item)
|
|
|
|
|
|
|
|
|
|
#undef __field_struct_ext
|
|
|
|
|
#define __field_struct_ext(type, item, filter_type)
|
|
|
|
|
|
tracing/events: provide string with undefined size support
This patch provides the support for dynamic size strings on
event tracing.
The key concept is to use a structure with an ending char array field of
undefined size and use such ability to allocate the minimal size on the
ring buffer to make one or more string entries fit inside, as opposite
to a fixed length strings with upper bound.
The strings themselves are represented using fields which have an offset
value from the beginning of the entry.
This patch provides three new macros:
__string(item, src)
This one declares a string to the structure inside TP_STRUCT__entry.
You need to provide the name of the string field and the source that will
be copied inside.
This will also add the dynamic size of the string needed for the ring
buffer entry allocation.
A stack allocated structure is used to temporarily store the offset
of each strings, avoiding double calls to strlen() on each event
insertion.
__get_str(field)
This one will give you a pointer to the string you have created. This
is an abstract helper to resolve the absolute address given the field
name which is a relative address from the beginning of the trace_structure.
__assign_str(dst, src)
Use this macro to automatically perform the string copy from src to
dst. src must be a variable to assign and dst is the name of a __string
field.
Example on how to use it:
TRACE_EVENT(my_event,
TP_PROTO(char *src1, char *src2),
TP_ARGS(src1, src2),
TP_STRUCT__entry(
__string(str1, src1)
__string(str2, src2)
),
TP_fast_assign(
__assign_str(str1, src1);
__assign_str(str2, src2);
),
TP_printk("%s %s", __get_str(src1), __get_str(src2))
)
Of course you can mix-up any __field or __array inside this
TRACE_EVENT. The position of the __string or __assign_str
doesn't matter.
Changes in v2:
Address the suggestion of Steven Rostedt: drop the opening_string() macro
and redefine __ending_string() to get the size of the string to be copied
instead of overwritting the whole ring buffer allocation.
Changes in v3:
Address other suggestions of Steven Rostedt and Peter Zijlstra with
some changes: drop the __ending_string and the need to have only one
string field.
Use offsets instead of absolute addresses.
[ Impact: allow more compact memory usage for string tracing ]
Signed-off-by: Frederic Weisbecker <fweisbec@gmail.com>
Cc: Steven Rostedt <rostedt@goodmis.org>
Cc: Li Zefan <lizf@cn.fujitsu.com>
Cc: Peter Zijlstra <a.p.zijlstra@chello.nl>
2009-04-19 10:51:29 +08:00
|
|
|
#undef __array
|
|
|
|
|
#define __array(type, item, len)
|
|
|
|
|
|
tracing/events: introduce __dynamic_array()
__string() is limited:
- it's a char array, but we may want to define array with other types
- a source string should be available, but we may just know the string size
We introduce __dynamic_array() to break those limitations, and __string()
becomes a wrapper of it. As a side effect, now __get_str() can be used
in TP_fast_assign but not only TP_print.
Take XFS for example, we have the string length in the dirent, but the
string itself is not NULL-terminated, so __dynamic_array() can be used:
TRACE_EVENT(xfs_dir2,
TP_PROTO(struct xfs_da_args *args),
TP_ARGS(args),
TP_STRUCT__entry(
__field(int, namelen)
__dynamic_array(char, name, args->namelen + 1)
...
),
TP_fast_assign(
char *name = __get_str(name);
if (args->namelen)
memcpy(name, args->name, args->namelen);
name[args->namelen] = '\0';
__entry->namelen = args->namelen;
),
TP_printk("name %.*s namelen %d",
__entry->namelen ? __get_str(name) : NULL
__entry->namelen)
);
[ Impact: allow defining dynamic size arrays ]
Signed-off-by: Li Zefan <lizf@cn.fujitsu.com>
LKML-Reference: <4A2384D2.3080403@cn.fujitsu.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2009-06-01 15:35:46 +08:00
|
|
|
#undef __dynamic_array
|
2009-07-16 10:54:02 +08:00
|
|
|
#define __dynamic_array(type, item, len) u32 item;
|
tracing/events: provide string with undefined size support
This patch provides the support for dynamic size strings on
event tracing.
The key concept is to use a structure with an ending char array field of
undefined size and use such ability to allocate the minimal size on the
ring buffer to make one or more string entries fit inside, as opposite
to a fixed length strings with upper bound.
The strings themselves are represented using fields which have an offset
value from the beginning of the entry.
This patch provides three new macros:
__string(item, src)
This one declares a string to the structure inside TP_STRUCT__entry.
You need to provide the name of the string field and the source that will
be copied inside.
This will also add the dynamic size of the string needed for the ring
buffer entry allocation.
A stack allocated structure is used to temporarily store the offset
of each strings, avoiding double calls to strlen() on each event
insertion.
__get_str(field)
This one will give you a pointer to the string you have created. This
is an abstract helper to resolve the absolute address given the field
name which is a relative address from the beginning of the trace_structure.
__assign_str(dst, src)
Use this macro to automatically perform the string copy from src to
dst. src must be a variable to assign and dst is the name of a __string
field.
Example on how to use it:
TRACE_EVENT(my_event,
TP_PROTO(char *src1, char *src2),
TP_ARGS(src1, src2),
TP_STRUCT__entry(
__string(str1, src1)
__string(str2, src2)
),
TP_fast_assign(
__assign_str(str1, src1);
__assign_str(str2, src2);
),
TP_printk("%s %s", __get_str(src1), __get_str(src2))
)
Of course you can mix-up any __field or __array inside this
TRACE_EVENT. The position of the __string or __assign_str
doesn't matter.
Changes in v2:
Address the suggestion of Steven Rostedt: drop the opening_string() macro
and redefine __ending_string() to get the size of the string to be copied
instead of overwritting the whole ring buffer allocation.
Changes in v3:
Address other suggestions of Steven Rostedt and Peter Zijlstra with
some changes: drop the __ending_string and the need to have only one
string field.
Use offsets instead of absolute addresses.
[ Impact: allow more compact memory usage for string tracing ]
Signed-off-by: Frederic Weisbecker <fweisbec@gmail.com>
Cc: Steven Rostedt <rostedt@goodmis.org>
Cc: Li Zefan <lizf@cn.fujitsu.com>
Cc: Peter Zijlstra <a.p.zijlstra@chello.nl>
2009-04-19 10:51:29 +08:00
|
|
|
|
|
|
|
|
#undef __string
|
tracing/events: introduce __dynamic_array()
__string() is limited:
- it's a char array, but we may want to define array with other types
- a source string should be available, but we may just know the string size
We introduce __dynamic_array() to break those limitations, and __string()
becomes a wrapper of it. As a side effect, now __get_str() can be used
in TP_fast_assign but not only TP_print.
Take XFS for example, we have the string length in the dirent, but the
string itself is not NULL-terminated, so __dynamic_array() can be used:
TRACE_EVENT(xfs_dir2,
TP_PROTO(struct xfs_da_args *args),
TP_ARGS(args),
TP_STRUCT__entry(
__field(int, namelen)
__dynamic_array(char, name, args->namelen + 1)
...
),
TP_fast_assign(
char *name = __get_str(name);
if (args->namelen)
memcpy(name, args->name, args->namelen);
name[args->namelen] = '\0';
__entry->namelen = args->namelen;
),
TP_printk("name %.*s namelen %d",
__entry->namelen ? __get_str(name) : NULL
__entry->namelen)
);
[ Impact: allow defining dynamic size arrays ]
Signed-off-by: Li Zefan <lizf@cn.fujitsu.com>
LKML-Reference: <4A2384D2.3080403@cn.fujitsu.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2009-06-01 15:35:46 +08:00
|
|
|
#define __string(item, src) __dynamic_array(char, item, -1)
|
tracing/events: provide string with undefined size support
This patch provides the support for dynamic size strings on
event tracing.
The key concept is to use a structure with an ending char array field of
undefined size and use such ability to allocate the minimal size on the
ring buffer to make one or more string entries fit inside, as opposite
to a fixed length strings with upper bound.
The strings themselves are represented using fields which have an offset
value from the beginning of the entry.
This patch provides three new macros:
__string(item, src)
This one declares a string to the structure inside TP_STRUCT__entry.
You need to provide the name of the string field and the source that will
be copied inside.
This will also add the dynamic size of the string needed for the ring
buffer entry allocation.
A stack allocated structure is used to temporarily store the offset
of each strings, avoiding double calls to strlen() on each event
insertion.
__get_str(field)
This one will give you a pointer to the string you have created. This
is an abstract helper to resolve the absolute address given the field
name which is a relative address from the beginning of the trace_structure.
__assign_str(dst, src)
Use this macro to automatically perform the string copy from src to
dst. src must be a variable to assign and dst is the name of a __string
field.
Example on how to use it:
TRACE_EVENT(my_event,
TP_PROTO(char *src1, char *src2),
TP_ARGS(src1, src2),
TP_STRUCT__entry(
__string(str1, src1)
__string(str2, src2)
),
TP_fast_assign(
__assign_str(str1, src1);
__assign_str(str2, src2);
),
TP_printk("%s %s", __get_str(src1), __get_str(src2))
)
Of course you can mix-up any __field or __array inside this
TRACE_EVENT. The position of the __string or __assign_str
doesn't matter.
Changes in v2:
Address the suggestion of Steven Rostedt: drop the opening_string() macro
and redefine __ending_string() to get the size of the string to be copied
instead of overwritting the whole ring buffer allocation.
Changes in v3:
Address other suggestions of Steven Rostedt and Peter Zijlstra with
some changes: drop the __ending_string and the need to have only one
string field.
Use offsets instead of absolute addresses.
[ Impact: allow more compact memory usage for string tracing ]
Signed-off-by: Frederic Weisbecker <fweisbec@gmail.com>
Cc: Steven Rostedt <rostedt@goodmis.org>
Cc: Li Zefan <lizf@cn.fujitsu.com>
Cc: Peter Zijlstra <a.p.zijlstra@chello.nl>
2009-04-19 10:51:29 +08:00
|
|
|
|
2021-07-17 08:55:10 +08:00
|
|
|
#undef __string_len
|
|
|
|
|
#define __string_len(item, src, len) __dynamic_array(char, item, -1)
|
|
|
|
|
|
tracing: Add __bitmask() macro to trace events to cpumasks and other bitmasks
Being able to show a cpumask of events can be useful as some events
may affect only some CPUs. There is no standard way to record the
cpumask and converting it to a string is rather expensive during
the trace as traces happen in hotpaths. It would be better to record
the raw event mask and be able to parse it at print time.
The following macros were added for use with the TRACE_EVENT() macro:
__bitmask()
__assign_bitmask()
__get_bitmask()
To test this, I added this to the sched_migrate_task event, which
looked like this:
TRACE_EVENT(sched_migrate_task,
TP_PROTO(struct task_struct *p, int dest_cpu, const struct cpumask *cpus),
TP_ARGS(p, dest_cpu, cpus),
TP_STRUCT__entry(
__array( char, comm, TASK_COMM_LEN )
__field( pid_t, pid )
__field( int, prio )
__field( int, orig_cpu )
__field( int, dest_cpu )
__bitmask( cpumask, num_possible_cpus() )
),
TP_fast_assign(
memcpy(__entry->comm, p->comm, TASK_COMM_LEN);
__entry->pid = p->pid;
__entry->prio = p->prio;
__entry->orig_cpu = task_cpu(p);
__entry->dest_cpu = dest_cpu;
__assign_bitmask(cpumask, cpumask_bits(cpus), num_possible_cpus());
),
TP_printk("comm=%s pid=%d prio=%d orig_cpu=%d dest_cpu=%d cpumask=%s",
__entry->comm, __entry->pid, __entry->prio,
__entry->orig_cpu, __entry->dest_cpu,
__get_bitmask(cpumask))
);
With the output of:
ksmtuned-3613 [003] d..2 485.220508: sched_migrate_task: comm=ksmtuned pid=3615 prio=120 orig_cpu=3 dest_cpu=2 cpumask=00000000,0000000f
migration/1-13 [001] d..5 485.221202: sched_migrate_task: comm=ksmtuned pid=3614 prio=120 orig_cpu=1 dest_cpu=0 cpumask=00000000,0000000f
awk-3615 [002] d.H5 485.221747: sched_migrate_task: comm=rcu_preempt pid=7 prio=120 orig_cpu=0 dest_cpu=1 cpumask=00000000,000000ff
migration/2-18 [002] d..5 485.222062: sched_migrate_task: comm=ksmtuned pid=3615 prio=120 orig_cpu=2 dest_cpu=3 cpumask=00000000,0000000f
Link: http://lkml.kernel.org/r/1399377998-14870-6-git-send-email-javi.merino@arm.com
Link: http://lkml.kernel.org/r/20140506132238.22e136d1@gandalf.local.home
Suggested-by: Javi Merino <javi.merino@arm.com>
Tested-by: Javi Merino <javi.merino@arm.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2014-05-07 01:10:24 +08:00
|
|
|
#undef __bitmask
|
|
|
|
|
#define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item, -1)
|
|
|
|
|
|
2009-11-26 16:04:55 +08:00
|
|
|
#undef DECLARE_EVENT_CLASS
|
|
|
|
|
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
|
2015-05-14 03:33:52 +08:00
|
|
|
struct trace_event_data_offsets_##call { \
|
tracing/events: provide string with undefined size support
This patch provides the support for dynamic size strings on
event tracing.
The key concept is to use a structure with an ending char array field of
undefined size and use such ability to allocate the minimal size on the
ring buffer to make one or more string entries fit inside, as opposite
to a fixed length strings with upper bound.
The strings themselves are represented using fields which have an offset
value from the beginning of the entry.
This patch provides three new macros:
__string(item, src)
This one declares a string to the structure inside TP_STRUCT__entry.
You need to provide the name of the string field and the source that will
be copied inside.
This will also add the dynamic size of the string needed for the ring
buffer entry allocation.
A stack allocated structure is used to temporarily store the offset
of each strings, avoiding double calls to strlen() on each event
insertion.
__get_str(field)
This one will give you a pointer to the string you have created. This
is an abstract helper to resolve the absolute address given the field
name which is a relative address from the beginning of the trace_structure.
__assign_str(dst, src)
Use this macro to automatically perform the string copy from src to
dst. src must be a variable to assign and dst is the name of a __string
field.
Example on how to use it:
TRACE_EVENT(my_event,
TP_PROTO(char *src1, char *src2),
TP_ARGS(src1, src2),
TP_STRUCT__entry(
__string(str1, src1)
__string(str2, src2)
),
TP_fast_assign(
__assign_str(str1, src1);
__assign_str(str2, src2);
),
TP_printk("%s %s", __get_str(src1), __get_str(src2))
)
Of course you can mix-up any __field or __array inside this
TRACE_EVENT. The position of the __string or __assign_str
doesn't matter.
Changes in v2:
Address the suggestion of Steven Rostedt: drop the opening_string() macro
and redefine __ending_string() to get the size of the string to be copied
instead of overwritting the whole ring buffer allocation.
Changes in v3:
Address other suggestions of Steven Rostedt and Peter Zijlstra with
some changes: drop the __ending_string and the need to have only one
string field.
Use offsets instead of absolute addresses.
[ Impact: allow more compact memory usage for string tracing ]
Signed-off-by: Frederic Weisbecker <fweisbec@gmail.com>
Cc: Steven Rostedt <rostedt@goodmis.org>
Cc: Li Zefan <lizf@cn.fujitsu.com>
Cc: Peter Zijlstra <a.p.zijlstra@chello.nl>
2009-04-19 10:51:29 +08:00
|
|
|
tstruct; \
|
|
|
|
|
};
|
|
|
|
|
|
tracing: Create new TRACE_EVENT_TEMPLATE
There are some places in the kernel that define several tracepoints and
they are all identical besides the name. The code to enable, disable and
record is created for every trace point even if most of the code is
identical.
This patch adds TRACE_EVENT_TEMPLATE that lets the developer create
a template TRACE_EVENT and create trace points with DEFINE_EVENT, which
is based off of a given template. Each trace point used by this
will share most of the code, and bring down the size of the kernel
when there are several duplicate events.
Usage is:
TRACE_EVENT_TEMPLATE(name, proto, args, tstruct, assign, print);
Which would be the same as defining a normal TRACE_EVENT.
To create the trace events that the trace points will use:
DEFINE_EVENT(template, name, proto, args) is done. The template
is the name of the TRACE_EVENT_TEMPLATE to use. The name is the
name of the trace point. The parameters proto and args must be the same
as the proto and args of the template. If they are not the same,
then a compile error will result. I tried hard removing this duplication
but the C preprocessor is not powerful enough (or my CPP magic
experience points is not at a high enough level) to not need them.
A lot of trace events are coming in with new XFS development. Most of
the trace points are identical except for the name. The following shows
the advantage of having TRACE_EVENT_TEMPLATE:
$ size fs/xfs/xfs.o.*
text data bss dec hex filename
452114 2788 3520 458422 6feb6 fs/xfs/xfs.o.old
638482 38116 3744 680342 a6196 fs/xfs/xfs.o.template
996954 38116 4480 1039550 fdcbe fs/xfs/xfs.o.trace
xfs.o.old is without any tracepoints.
xfs.o.template uses the new TRACE_EVENT_TEMPLATE.
xfs.o.trace uses the current TRACE_EVENT macros.
Requested-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2009-11-19 09:27:27 +08:00
|
|
|
#undef DEFINE_EVENT
|
|
|
|
|
#define DEFINE_EVENT(template, name, proto, args)
|
|
|
|
|
|
2009-11-19 09:36:26 +08:00
|
|
|
#undef DEFINE_EVENT_PRINT
|
2020-06-12 17:28:43 +08:00
|
|
|
#define DEFINE_EVENT_PRINT(template, name, proto, args, print)
|
2009-11-19 09:36:26 +08:00
|
|
|
|
2010-11-18 08:46:57 +08:00
|
|
|
#undef TRACE_EVENT_FLAGS
|
|
|
|
|
#define TRACE_EVENT_FLAGS(event, flag)
|
|
|
|
|
|
2013-11-14 23:23:04 +08:00
|
|
|
#undef TRACE_EVENT_PERF_PERM
|
|
|
|
|
#define TRACE_EVENT_PERF_PERM(event, expr...)
|
|
|
|
|
|
tracing/events: provide string with undefined size support
This patch provides the support for dynamic size strings on
event tracing.
The key concept is to use a structure with an ending char array field of
undefined size and use such ability to allocate the minimal size on the
ring buffer to make one or more string entries fit inside, as opposite
to a fixed length strings with upper bound.
The strings themselves are represented using fields which have an offset
value from the beginning of the entry.
This patch provides three new macros:
__string(item, src)
This one declares a string to the structure inside TP_STRUCT__entry.
You need to provide the name of the string field and the source that will
be copied inside.
This will also add the dynamic size of the string needed for the ring
buffer entry allocation.
A stack allocated structure is used to temporarily store the offset
of each strings, avoiding double calls to strlen() on each event
insertion.
__get_str(field)
This one will give you a pointer to the string you have created. This
is an abstract helper to resolve the absolute address given the field
name which is a relative address from the beginning of the trace_structure.
__assign_str(dst, src)
Use this macro to automatically perform the string copy from src to
dst. src must be a variable to assign and dst is the name of a __string
field.
Example on how to use it:
TRACE_EVENT(my_event,
TP_PROTO(char *src1, char *src2),
TP_ARGS(src1, src2),
TP_STRUCT__entry(
__string(str1, src1)
__string(str2, src2)
),
TP_fast_assign(
__assign_str(str1, src1);
__assign_str(str2, src2);
),
TP_printk("%s %s", __get_str(src1), __get_str(src2))
)
Of course you can mix-up any __field or __array inside this
TRACE_EVENT. The position of the __string or __assign_str
doesn't matter.
Changes in v2:
Address the suggestion of Steven Rostedt: drop the opening_string() macro
and redefine __ending_string() to get the size of the string to be copied
instead of overwritting the whole ring buffer allocation.
Changes in v3:
Address other suggestions of Steven Rostedt and Peter Zijlstra with
some changes: drop the __ending_string and the need to have only one
string field.
Use offsets instead of absolute addresses.
[ Impact: allow more compact memory usage for string tracing ]
Signed-off-by: Frederic Weisbecker <fweisbec@gmail.com>
Cc: Steven Rostedt <rostedt@goodmis.org>
Cc: Li Zefan <lizf@cn.fujitsu.com>
Cc: Peter Zijlstra <a.p.zijlstra@chello.nl>
2009-04-19 10:51:29 +08:00
|
|
|
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Stage 3 of the trace events.
|
|
|
|
|
*
|
2015-03-04 05:48:18 +08:00
|
|
|
* Override the macros in the event tracepoint header <trace/events/XXX.h>
|
|
|
|
|
* to include the following:
|
2009-04-14 00:25:37 +08:00
|
|
|
*
|
|
|
|
|
* enum print_line_t
|
2015-05-06 02:18:11 +08:00
|
|
|
* trace_raw_output_<call>(struct trace_iterator *iter, int flags)
|
2009-04-14 00:25:37 +08:00
|
|
|
* {
|
|
|
|
|
* struct trace_seq *s = &iter->seq;
|
2015-05-14 03:27:47 +08:00
|
|
|
* struct trace_event_raw_<call> *field; <-- defined in stage 1
|
2010-06-03 18:26:24 +08:00
|
|
|
* struct trace_seq *p = &iter->tmp_seq;
|
2020-10-15 22:55:16 +08:00
|
|
|
*
|
|
|
|
|
* -------(for event)-------
|
|
|
|
|
*
|
|
|
|
|
* struct trace_entry *entry;
|
2009-04-14 00:25:37 +08:00
|
|
|
*
|
|
|
|
|
* entry = iter->ent;
|
|
|
|
|
*
|
2010-04-23 22:38:03 +08:00
|
|
|
* if (entry->type != event_<call>->event.type) {
|
2009-04-14 00:25:37 +08:00
|
|
|
* WARN_ON_ONCE(1);
|
|
|
|
|
* return TRACE_TYPE_UNHANDLED;
|
|
|
|
|
* }
|
|
|
|
|
*
|
|
|
|
|
* field = (typeof(field))entry;
|
|
|
|
|
*
|
2009-06-03 21:52:03 +08:00
|
|
|
* trace_seq_init(p);
|
2020-10-15 22:55:16 +08:00
|
|
|
* return trace_output_call(iter, <call>, <TP_printk> "\n");
|
|
|
|
|
*
|
|
|
|
|
* ------(or, for event class)------
|
|
|
|
|
*
|
|
|
|
|
* int ret;
|
|
|
|
|
*
|
|
|
|
|
* field = (typeof(field))iter->ent;
|
|
|
|
|
*
|
|
|
|
|
* ret = trace_raw_output_prep(iter, trace_event);
|
|
|
|
|
* if (ret != TRACE_TYPE_HANDLED)
|
|
|
|
|
* return ret;
|
|
|
|
|
*
|
|
|
|
|
* trace_event_printf(iter, <TP_printk> "\n");
|
2009-04-14 00:25:37 +08:00
|
|
|
*
|
2020-10-15 22:55:16 +08:00
|
|
|
* return trace_handle_return(s);
|
|
|
|
|
* -------
|
|
|
|
|
* }
|
2009-04-14 00:25:37 +08:00
|
|
|
*
|
|
|
|
|
* This is the method used to print the raw event to the trace
|
|
|
|
|
* output format. Note, this is not needed if the data is read
|
|
|
|
|
* in binary.
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#undef __entry
|
|
|
|
|
#define __entry field
|
|
|
|
|
|
|
|
|
|
#undef TP_printk
|
|
|
|
|
#define TP_printk(fmt, args...) fmt "\n", args
|
|
|
|
|
|
tracing/events: introduce __dynamic_array()
__string() is limited:
- it's a char array, but we may want to define array with other types
- a source string should be available, but we may just know the string size
We introduce __dynamic_array() to break those limitations, and __string()
becomes a wrapper of it. As a side effect, now __get_str() can be used
in TP_fast_assign but not only TP_print.
Take XFS for example, we have the string length in the dirent, but the
string itself is not NULL-terminated, so __dynamic_array() can be used:
TRACE_EVENT(xfs_dir2,
TP_PROTO(struct xfs_da_args *args),
TP_ARGS(args),
TP_STRUCT__entry(
__field(int, namelen)
__dynamic_array(char, name, args->namelen + 1)
...
),
TP_fast_assign(
char *name = __get_str(name);
if (args->namelen)
memcpy(name, args->name, args->namelen);
name[args->namelen] = '\0';
__entry->namelen = args->namelen;
),
TP_printk("name %.*s namelen %d",
__entry->namelen ? __get_str(name) : NULL
__entry->namelen)
);
[ Impact: allow defining dynamic size arrays ]
Signed-off-by: Li Zefan <lizf@cn.fujitsu.com>
LKML-Reference: <4A2384D2.3080403@cn.fujitsu.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2009-06-01 15:35:46 +08:00
|
|
|
#undef __get_dynamic_array
|
|
|
|
|
#define __get_dynamic_array(field) \
|
2009-07-16 10:54:02 +08:00
|
|
|
((void *)__entry + (__entry->__data_loc_##field & 0xffff))
|
tracing/events: introduce __dynamic_array()
__string() is limited:
- it's a char array, but we may want to define array with other types
- a source string should be available, but we may just know the string size
We introduce __dynamic_array() to break those limitations, and __string()
becomes a wrapper of it. As a side effect, now __get_str() can be used
in TP_fast_assign but not only TP_print.
Take XFS for example, we have the string length in the dirent, but the
string itself is not NULL-terminated, so __dynamic_array() can be used:
TRACE_EVENT(xfs_dir2,
TP_PROTO(struct xfs_da_args *args),
TP_ARGS(args),
TP_STRUCT__entry(
__field(int, namelen)
__dynamic_array(char, name, args->namelen + 1)
...
),
TP_fast_assign(
char *name = __get_str(name);
if (args->namelen)
memcpy(name, args->name, args->namelen);
name[args->namelen] = '\0';
__entry->namelen = args->namelen;
),
TP_printk("name %.*s namelen %d",
__entry->namelen ? __get_str(name) : NULL
__entry->namelen)
);
[ Impact: allow defining dynamic size arrays ]
Signed-off-by: Li Zefan <lizf@cn.fujitsu.com>
LKML-Reference: <4A2384D2.3080403@cn.fujitsu.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2009-06-01 15:35:46 +08:00
|
|
|
|
2014-06-05 02:29:33 +08:00
|
|
|
#undef __get_dynamic_array_len
|
|
|
|
|
#define __get_dynamic_array_len(field) \
|
|
|
|
|
((__entry->__data_loc_##field >> 16) & 0xffff)
|
|
|
|
|
|
tracing/events: provide string with undefined size support
This patch provides the support for dynamic size strings on
event tracing.
The key concept is to use a structure with an ending char array field of
undefined size and use such ability to allocate the minimal size on the
ring buffer to make one or more string entries fit inside, as opposite
to a fixed length strings with upper bound.
The strings themselves are represented using fields which have an offset
value from the beginning of the entry.
This patch provides three new macros:
__string(item, src)
This one declares a string to the structure inside TP_STRUCT__entry.
You need to provide the name of the string field and the source that will
be copied inside.
This will also add the dynamic size of the string needed for the ring
buffer entry allocation.
A stack allocated structure is used to temporarily store the offset
of each strings, avoiding double calls to strlen() on each event
insertion.
__get_str(field)
This one will give you a pointer to the string you have created. This
is an abstract helper to resolve the absolute address given the field
name which is a relative address from the beginning of the trace_structure.
__assign_str(dst, src)
Use this macro to automatically perform the string copy from src to
dst. src must be a variable to assign and dst is the name of a __string
field.
Example on how to use it:
TRACE_EVENT(my_event,
TP_PROTO(char *src1, char *src2),
TP_ARGS(src1, src2),
TP_STRUCT__entry(
__string(str1, src1)
__string(str2, src2)
),
TP_fast_assign(
__assign_str(str1, src1);
__assign_str(str2, src2);
),
TP_printk("%s %s", __get_str(src1), __get_str(src2))
)
Of course you can mix-up any __field or __array inside this
TRACE_EVENT. The position of the __string or __assign_str
doesn't matter.
Changes in v2:
Address the suggestion of Steven Rostedt: drop the opening_string() macro
and redefine __ending_string() to get the size of the string to be copied
instead of overwritting the whole ring buffer allocation.
Changes in v3:
Address other suggestions of Steven Rostedt and Peter Zijlstra with
some changes: drop the __ending_string and the need to have only one
string field.
Use offsets instead of absolute addresses.
[ Impact: allow more compact memory usage for string tracing ]
Signed-off-by: Frederic Weisbecker <fweisbec@gmail.com>
Cc: Steven Rostedt <rostedt@goodmis.org>
Cc: Li Zefan <lizf@cn.fujitsu.com>
Cc: Peter Zijlstra <a.p.zijlstra@chello.nl>
2009-04-19 10:51:29 +08:00
|
|
|
#undef __get_str
|
2016-07-02 07:44:34 +08:00
|
|
|
#define __get_str(field) ((char *)__get_dynamic_array(field))
|
tracing/events: provide string with undefined size support
This patch provides the support for dynamic size strings on
event tracing.
The key concept is to use a structure with an ending char array field of
undefined size and use such ability to allocate the minimal size on the
ring buffer to make one or more string entries fit inside, as opposite
to a fixed length strings with upper bound.
The strings themselves are represented using fields which have an offset
value from the beginning of the entry.
This patch provides three new macros:
__string(item, src)
This one declares a string to the structure inside TP_STRUCT__entry.
You need to provide the name of the string field and the source that will
be copied inside.
This will also add the dynamic size of the string needed for the ring
buffer entry allocation.
A stack allocated structure is used to temporarily store the offset
of each strings, avoiding double calls to strlen() on each event
insertion.
__get_str(field)
This one will give you a pointer to the string you have created. This
is an abstract helper to resolve the absolute address given the field
name which is a relative address from the beginning of the trace_structure.
__assign_str(dst, src)
Use this macro to automatically perform the string copy from src to
dst. src must be a variable to assign and dst is the name of a __string
field.
Example on how to use it:
TRACE_EVENT(my_event,
TP_PROTO(char *src1, char *src2),
TP_ARGS(src1, src2),
TP_STRUCT__entry(
__string(str1, src1)
__string(str2, src2)
),
TP_fast_assign(
__assign_str(str1, src1);
__assign_str(str2, src2);
),
TP_printk("%s %s", __get_str(src1), __get_str(src2))
)
Of course you can mix-up any __field or __array inside this
TRACE_EVENT. The position of the __string or __assign_str
doesn't matter.
Changes in v2:
Address the suggestion of Steven Rostedt: drop the opening_string() macro
and redefine __ending_string() to get the size of the string to be copied
instead of overwritting the whole ring buffer allocation.
Changes in v3:
Address other suggestions of Steven Rostedt and Peter Zijlstra with
some changes: drop the __ending_string and the need to have only one
string field.
Use offsets instead of absolute addresses.
[ Impact: allow more compact memory usage for string tracing ]
Signed-off-by: Frederic Weisbecker <fweisbec@gmail.com>
Cc: Steven Rostedt <rostedt@goodmis.org>
Cc: Li Zefan <lizf@cn.fujitsu.com>
Cc: Peter Zijlstra <a.p.zijlstra@chello.nl>
2009-04-19 10:51:29 +08:00
|
|
|
|
tracing: Add __bitmask() macro to trace events to cpumasks and other bitmasks
Being able to show a cpumask of events can be useful as some events
may affect only some CPUs. There is no standard way to record the
cpumask and converting it to a string is rather expensive during
the trace as traces happen in hotpaths. It would be better to record
the raw event mask and be able to parse it at print time.
The following macros were added for use with the TRACE_EVENT() macro:
__bitmask()
__assign_bitmask()
__get_bitmask()
To test this, I added this to the sched_migrate_task event, which
looked like this:
TRACE_EVENT(sched_migrate_task,
TP_PROTO(struct task_struct *p, int dest_cpu, const struct cpumask *cpus),
TP_ARGS(p, dest_cpu, cpus),
TP_STRUCT__entry(
__array( char, comm, TASK_COMM_LEN )
__field( pid_t, pid )
__field( int, prio )
__field( int, orig_cpu )
__field( int, dest_cpu )
__bitmask( cpumask, num_possible_cpus() )
),
TP_fast_assign(
memcpy(__entry->comm, p->comm, TASK_COMM_LEN);
__entry->pid = p->pid;
__entry->prio = p->prio;
__entry->orig_cpu = task_cpu(p);
__entry->dest_cpu = dest_cpu;
__assign_bitmask(cpumask, cpumask_bits(cpus), num_possible_cpus());
),
TP_printk("comm=%s pid=%d prio=%d orig_cpu=%d dest_cpu=%d cpumask=%s",
__entry->comm, __entry->pid, __entry->prio,
__entry->orig_cpu, __entry->dest_cpu,
__get_bitmask(cpumask))
);
With the output of:
ksmtuned-3613 [003] d..2 485.220508: sched_migrate_task: comm=ksmtuned pid=3615 prio=120 orig_cpu=3 dest_cpu=2 cpumask=00000000,0000000f
migration/1-13 [001] d..5 485.221202: sched_migrate_task: comm=ksmtuned pid=3614 prio=120 orig_cpu=1 dest_cpu=0 cpumask=00000000,0000000f
awk-3615 [002] d.H5 485.221747: sched_migrate_task: comm=rcu_preempt pid=7 prio=120 orig_cpu=0 dest_cpu=1 cpumask=00000000,000000ff
migration/2-18 [002] d..5 485.222062: sched_migrate_task: comm=ksmtuned pid=3615 prio=120 orig_cpu=2 dest_cpu=3 cpumask=00000000,0000000f
Link: http://lkml.kernel.org/r/1399377998-14870-6-git-send-email-javi.merino@arm.com
Link: http://lkml.kernel.org/r/20140506132238.22e136d1@gandalf.local.home
Suggested-by: Javi Merino <javi.merino@arm.com>
Tested-by: Javi Merino <javi.merino@arm.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2014-05-07 01:10:24 +08:00
|
|
|
#undef __get_bitmask
|
|
|
|
|
#define __get_bitmask(field) \
|
|
|
|
|
({ \
|
|
|
|
|
void *__bitmask = __get_dynamic_array(field); \
|
|
|
|
|
unsigned int __bitmask_size; \
|
2014-06-05 02:29:33 +08:00
|
|
|
__bitmask_size = __get_dynamic_array_len(field); \
|
2015-05-05 06:12:44 +08:00
|
|
|
trace_print_bitmask_seq(p, __bitmask, __bitmask_size); \
|
tracing: Add __bitmask() macro to trace events to cpumasks and other bitmasks
Being able to show a cpumask of events can be useful as some events
may affect only some CPUs. There is no standard way to record the
cpumask and converting it to a string is rather expensive during
the trace as traces happen in hotpaths. It would be better to record
the raw event mask and be able to parse it at print time.
The following macros were added for use with the TRACE_EVENT() macro:
__bitmask()
__assign_bitmask()
__get_bitmask()
To test this, I added this to the sched_migrate_task event, which
looked like this:
TRACE_EVENT(sched_migrate_task,
TP_PROTO(struct task_struct *p, int dest_cpu, const struct cpumask *cpus),
TP_ARGS(p, dest_cpu, cpus),
TP_STRUCT__entry(
__array( char, comm, TASK_COMM_LEN )
__field( pid_t, pid )
__field( int, prio )
__field( int, orig_cpu )
__field( int, dest_cpu )
__bitmask( cpumask, num_possible_cpus() )
),
TP_fast_assign(
memcpy(__entry->comm, p->comm, TASK_COMM_LEN);
__entry->pid = p->pid;
__entry->prio = p->prio;
__entry->orig_cpu = task_cpu(p);
__entry->dest_cpu = dest_cpu;
__assign_bitmask(cpumask, cpumask_bits(cpus), num_possible_cpus());
),
TP_printk("comm=%s pid=%d prio=%d orig_cpu=%d dest_cpu=%d cpumask=%s",
__entry->comm, __entry->pid, __entry->prio,
__entry->orig_cpu, __entry->dest_cpu,
__get_bitmask(cpumask))
);
With the output of:
ksmtuned-3613 [003] d..2 485.220508: sched_migrate_task: comm=ksmtuned pid=3615 prio=120 orig_cpu=3 dest_cpu=2 cpumask=00000000,0000000f
migration/1-13 [001] d..5 485.221202: sched_migrate_task: comm=ksmtuned pid=3614 prio=120 orig_cpu=1 dest_cpu=0 cpumask=00000000,0000000f
awk-3615 [002] d.H5 485.221747: sched_migrate_task: comm=rcu_preempt pid=7 prio=120 orig_cpu=0 dest_cpu=1 cpumask=00000000,000000ff
migration/2-18 [002] d..5 485.222062: sched_migrate_task: comm=ksmtuned pid=3615 prio=120 orig_cpu=2 dest_cpu=3 cpumask=00000000,0000000f
Link: http://lkml.kernel.org/r/1399377998-14870-6-git-send-email-javi.merino@arm.com
Link: http://lkml.kernel.org/r/20140506132238.22e136d1@gandalf.local.home
Suggested-by: Javi Merino <javi.merino@arm.com>
Tested-by: Javi Merino <javi.merino@arm.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2014-05-07 01:10:24 +08:00
|
|
|
})
|
|
|
|
|
|
2009-05-27 02:25:22 +08:00
|
|
|
#undef __print_flags
|
|
|
|
|
#define __print_flags(flag, delim, flag_array...) \
|
|
|
|
|
({ \
|
2009-09-14 23:18:02 +08:00
|
|
|
static const struct trace_print_flags __flags[] = \
|
2009-05-27 02:25:22 +08:00
|
|
|
{ flag_array, { -1, NULL }}; \
|
2015-05-05 06:12:44 +08:00
|
|
|
trace_print_flags_seq(p, delim, flag, __flags); \
|
2009-05-27 02:25:22 +08:00
|
|
|
})
|
|
|
|
|
|
2009-05-21 07:21:47 +08:00
|
|
|
#undef __print_symbolic
|
|
|
|
|
#define __print_symbolic(value, symbol_array...) \
|
|
|
|
|
({ \
|
|
|
|
|
static const struct trace_print_flags symbols[] = \
|
|
|
|
|
{ symbol_array, { -1, NULL }}; \
|
2015-05-05 06:12:44 +08:00
|
|
|
trace_print_symbols_seq(p, value, symbols); \
|
2009-05-21 07:21:47 +08:00
|
|
|
})
|
|
|
|
|
|
2017-02-23 07:39:47 +08:00
|
|
|
#undef __print_flags_u64
|
2011-04-19 09:35:28 +08:00
|
|
|
#undef __print_symbolic_u64
|
|
|
|
|
#if BITS_PER_LONG == 32
|
2017-02-23 07:39:47 +08:00
|
|
|
#define __print_flags_u64(flag, delim, flag_array...) \
|
|
|
|
|
({ \
|
|
|
|
|
static const struct trace_print_flags_u64 __flags[] = \
|
|
|
|
|
{ flag_array, { -1, NULL } }; \
|
|
|
|
|
trace_print_flags_seq_u64(p, delim, flag, __flags); \
|
|
|
|
|
})
|
|
|
|
|
|
2011-04-19 09:35:28 +08:00
|
|
|
#define __print_symbolic_u64(value, symbol_array...) \
|
|
|
|
|
({ \
|
|
|
|
|
static const struct trace_print_flags_u64 symbols[] = \
|
|
|
|
|
{ symbol_array, { -1, NULL } }; \
|
2015-05-05 06:12:44 +08:00
|
|
|
trace_print_symbols_seq_u64(p, value, symbols); \
|
2011-04-19 09:35:28 +08:00
|
|
|
})
|
|
|
|
|
#else
|
2017-02-23 07:39:47 +08:00
|
|
|
#define __print_flags_u64(flag, delim, flag_array...) \
|
|
|
|
|
__print_flags(flag, delim, flag_array)
|
|
|
|
|
|
2011-04-19 09:35:28 +08:00
|
|
|
#define __print_symbolic_u64(value, symbol_array...) \
|
|
|
|
|
__print_symbolic(value, symbol_array)
|
|
|
|
|
#endif
|
|
|
|
|
|
2010-04-01 19:40:58 +08:00
|
|
|
#undef __print_hex
|
2017-01-25 09:28:16 +08:00
|
|
|
#define __print_hex(buf, buf_len) \
|
2017-02-03 00:09:54 +08:00
|
|
|
trace_print_hex_seq(p, buf, buf_len, false)
|
2017-01-25 09:28:16 +08:00
|
|
|
|
|
|
|
|
#undef __print_hex_str
|
|
|
|
|
#define __print_hex_str(buf, buf_len) \
|
2017-02-03 00:09:54 +08:00
|
|
|
trace_print_hex_seq(p, buf, buf_len, true)
|
2010-04-01 19:40:58 +08:00
|
|
|
|
2015-01-28 20:48:53 +08:00
|
|
|
#undef __print_array
|
|
|
|
|
#define __print_array(array, count, el_size) \
|
|
|
|
|
({ \
|
|
|
|
|
BUILD_BUG_ON(el_size != 1 && el_size != 2 && \
|
|
|
|
|
el_size != 4 && el_size != 8); \
|
2015-05-05 06:12:44 +08:00
|
|
|
trace_print_array_seq(p, array, count, el_size); \
|
2015-01-28 20:48:53 +08:00
|
|
|
})
|
|
|
|
|
|
2019-11-07 20:45:38 +08:00
|
|
|
#undef __print_hex_dump
|
|
|
|
|
#define __print_hex_dump(prefix_str, prefix_type, \
|
|
|
|
|
rowsize, groupsize, buf, len, ascii) \
|
|
|
|
|
trace_print_hex_dump_seq(p, prefix_str, prefix_type, \
|
|
|
|
|
rowsize, groupsize, buf, len, ascii)
|
|
|
|
|
|
trace: Add __print_ns_to_secs() and __print_ns_without_secs() helpers
To have nanosecond output displayed in a more human readable format, its
nicer to convert it to a seconds format (XXX.YYYYYYYYY). The problem is that
to do so, the numbers must be divided by NSEC_PER_SEC, and moded too. But as
these numbers are 64 bit, this can not be done simply with '/' and '%'
operators, but must use do_div() instead.
Instead of performing the expensive do_div() in the hot path of the
tracepoint, it is more efficient to perform it during the output phase. But
passing in do_div() can confuse the parser, and do_div() doesn't work
exactly like a normal C function. It modifies the number in place, and we
don't want to modify the actual values in the ring buffer.
Two helper functions are now created:
__print_ns_to_secs() and __print_ns_without_secs()
They both take a value of nanoseconds, and the former will return that
number divided by NSEC_PER_SEC, and the latter will mod it with NSEC_PER_SEC
giving a way to print a nice human readable format:
__print_fmt("time=%llu.%09u",
__print_ns_to_secs(REC->nsec_val),
__print_ns_without_secs(REC->nsec_val))
Link: https://lkml.kernel.org/r/e503b903045496c4ccde52843e1e318b422f7a56.1624372313.git.bristot@redhat.com
Cc: Phil Auld <pauld@redhat.com>
Cc: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
Cc: Kate Carcia <kcarcia@redhat.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: Alexandre Chartre <alexandre.chartre@oracle.com>
Cc: Clark Willaims <williams@redhat.com>
Cc: John Kacur <jkacur@redhat.com>
Cc: Juri Lelli <juri.lelli@redhat.com>
Cc: Borislav Petkov <bp@alien8.de>
Cc: "H. Peter Anvin" <hpa@zytor.com>
Cc: x86@kernel.org
Cc: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
Signed-off-by: Daniel Bristot de Oliveira <bristot@redhat.com>
Signed-off-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
2021-06-22 22:42:26 +08:00
|
|
|
#undef __print_ns_to_secs
|
|
|
|
|
#define __print_ns_to_secs(value) \
|
|
|
|
|
({ \
|
|
|
|
|
u64 ____val = (u64)(value); \
|
|
|
|
|
do_div(____val, NSEC_PER_SEC); \
|
|
|
|
|
____val; \
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
#undef __print_ns_without_secs
|
|
|
|
|
#define __print_ns_without_secs(value) \
|
|
|
|
|
({ \
|
|
|
|
|
u64 ____val = (u64)(value); \
|
|
|
|
|
(u32) do_div(____val, NSEC_PER_SEC); \
|
|
|
|
|
})
|
|
|
|
|
|
2009-11-26 16:04:55 +08:00
|
|
|
#undef DECLARE_EVENT_CLASS
|
|
|
|
|
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
|
2010-02-16 23:38:47 +08:00
|
|
|
static notrace enum print_line_t \
|
2015-05-06 02:18:11 +08:00
|
|
|
trace_raw_output_##call(struct trace_iterator *iter, int flags, \
|
|
|
|
|
struct trace_event *trace_event) \
|
2009-04-14 00:25:37 +08:00
|
|
|
{ \
|
|
|
|
|
struct trace_seq *s = &iter->seq; \
|
2013-02-21 10:32:38 +08:00
|
|
|
struct trace_seq __maybe_unused *p = &iter->tmp_seq; \
|
2015-05-14 03:27:47 +08:00
|
|
|
struct trace_event_raw_##call *field; \
|
2009-04-14 00:25:37 +08:00
|
|
|
int ret; \
|
|
|
|
|
\
|
2013-02-21 10:32:38 +08:00
|
|
|
field = (typeof(field))iter->ent; \
|
2010-04-23 22:00:22 +08:00
|
|
|
\
|
2015-05-06 02:18:11 +08:00
|
|
|
ret = trace_raw_output_prep(iter, trace_event); \
|
2014-11-15 00:42:06 +08:00
|
|
|
if (ret != TRACE_TYPE_HANDLED) \
|
2013-02-21 10:32:38 +08:00
|
|
|
return ret; \
|
|
|
|
|
\
|
2020-10-15 22:55:07 +08:00
|
|
|
trace_event_printf(iter, print); \
|
2009-04-14 00:25:37 +08:00
|
|
|
\
|
2014-11-12 23:29:54 +08:00
|
|
|
return trace_handle_return(s); \
|
2010-04-23 22:00:22 +08:00
|
|
|
} \
|
2015-05-14 03:35:44 +08:00
|
|
|
static struct trace_event_functions trace_event_type_funcs_##call = { \
|
2015-05-06 02:18:11 +08:00
|
|
|
.trace = trace_raw_output_##call, \
|
2010-04-23 22:00:22 +08:00
|
|
|
};
|
tracing: Create new TRACE_EVENT_TEMPLATE
There are some places in the kernel that define several tracepoints and
they are all identical besides the name. The code to enable, disable and
record is created for every trace point even if most of the code is
identical.
This patch adds TRACE_EVENT_TEMPLATE that lets the developer create
a template TRACE_EVENT and create trace points with DEFINE_EVENT, which
is based off of a given template. Each trace point used by this
will share most of the code, and bring down the size of the kernel
when there are several duplicate events.
Usage is:
TRACE_EVENT_TEMPLATE(name, proto, args, tstruct, assign, print);
Which would be the same as defining a normal TRACE_EVENT.
To create the trace events that the trace points will use:
DEFINE_EVENT(template, name, proto, args) is done. The template
is the name of the TRACE_EVENT_TEMPLATE to use. The name is the
name of the trace point. The parameters proto and args must be the same
as the proto and args of the template. If they are not the same,
then a compile error will result. I tried hard removing this duplication
but the C preprocessor is not powerful enough (or my CPP magic
experience points is not at a high enough level) to not need them.
A lot of trace events are coming in with new XFS development. Most of
the trace points are identical except for the name. The following shows
the advantage of having TRACE_EVENT_TEMPLATE:
$ size fs/xfs/xfs.o.*
text data bss dec hex filename
452114 2788 3520 458422 6feb6 fs/xfs/xfs.o.old
638482 38116 3744 680342 a6196 fs/xfs/xfs.o.template
996954 38116 4480 1039550 fdcbe fs/xfs/xfs.o.trace
xfs.o.old is without any tracepoints.
xfs.o.template uses the new TRACE_EVENT_TEMPLATE.
xfs.o.trace uses the current TRACE_EVENT macros.
Requested-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2009-11-19 09:27:27 +08:00
|
|
|
|
2009-11-19 09:36:26 +08:00
|
|
|
#undef DEFINE_EVENT_PRINT
|
|
|
|
|
#define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
|
2010-02-16 23:38:47 +08:00
|
|
|
static notrace enum print_line_t \
|
2015-05-06 02:18:11 +08:00
|
|
|
trace_raw_output_##call(struct trace_iterator *iter, int flags, \
|
2010-04-23 06:46:14 +08:00
|
|
|
struct trace_event *event) \
|
2009-11-19 09:36:26 +08:00
|
|
|
{ \
|
2015-05-14 03:27:47 +08:00
|
|
|
struct trace_event_raw_##template *field; \
|
2009-11-19 09:36:26 +08:00
|
|
|
struct trace_entry *entry; \
|
2010-06-03 18:26:24 +08:00
|
|
|
struct trace_seq *p = &iter->tmp_seq; \
|
2009-04-14 00:25:37 +08:00
|
|
|
\
|
|
|
|
|
entry = iter->ent; \
|
|
|
|
|
\
|
2010-04-23 22:38:03 +08:00
|
|
|
if (entry->type != event_##call.event.type) { \
|
2009-04-14 00:25:37 +08:00
|
|
|
WARN_ON_ONCE(1); \
|
|
|
|
|
return TRACE_TYPE_UNHANDLED; \
|
|
|
|
|
} \
|
|
|
|
|
\
|
|
|
|
|
field = (typeof(field))entry; \
|
|
|
|
|
\
|
2009-06-03 21:52:03 +08:00
|
|
|
trace_seq_init(p); \
|
2015-05-06 02:18:11 +08:00
|
|
|
return trace_output_call(iter, #call, print); \
|
2010-04-23 22:00:22 +08:00
|
|
|
} \
|
2015-05-14 03:35:44 +08:00
|
|
|
static struct trace_event_functions trace_event_type_funcs_##call = { \
|
2015-05-06 02:18:11 +08:00
|
|
|
.trace = trace_raw_output_##call, \
|
2010-04-23 22:00:22 +08:00
|
|
|
};
|
2009-11-19 09:36:26 +08:00
|
|
|
|
2009-04-14 00:25:37 +08:00
|
|
|
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
|
|
|
|
|
|
2009-08-07 10:33:22 +08:00
|
|
|
#undef __field_ext
|
2019-10-25 04:26:59 +08:00
|
|
|
#define __field_ext(_type, _item, _filter_type) { \
|
|
|
|
|
.type = #_type, .name = #_item, \
|
|
|
|
|
.size = sizeof(_type), .align = __alignof__(_type), \
|
|
|
|
|
.is_signed = is_signed_type(_type), .filter_type = _filter_type },
|
2009-04-14 00:25:37 +08:00
|
|
|
|
2014-06-17 20:59:16 +08:00
|
|
|
#undef __field_struct_ext
|
2019-10-25 04:26:59 +08:00
|
|
|
#define __field_struct_ext(_type, _item, _filter_type) { \
|
|
|
|
|
.type = #_type, .name = #_item, \
|
|
|
|
|
.size = sizeof(_type), .align = __alignof__(_type), \
|
|
|
|
|
0, .filter_type = _filter_type },
|
2014-06-17 20:59:16 +08:00
|
|
|
|
2009-08-07 10:33:22 +08:00
|
|
|
#undef __field
|
|
|
|
|
#define __field(type, item) __field_ext(type, item, FILTER_OTHER)
|
|
|
|
|
|
2014-06-17 20:59:16 +08:00
|
|
|
#undef __field_struct
|
|
|
|
|
#define __field_struct(type, item) __field_struct_ext(type, item, FILTER_OTHER)
|
|
|
|
|
|
2009-04-14 00:25:37 +08:00
|
|
|
#undef __array
|
2019-10-25 04:26:59 +08:00
|
|
|
#define __array(_type, _item, _len) { \
|
|
|
|
|
.type = #_type"["__stringify(_len)"]", .name = #_item, \
|
|
|
|
|
.size = sizeof(_type[_len]), .align = __alignof__(_type), \
|
|
|
|
|
.is_signed = is_signed_type(_type), .filter_type = FILTER_OTHER },
|
2009-04-14 00:25:37 +08:00
|
|
|
|
tracing/events: introduce __dynamic_array()
__string() is limited:
- it's a char array, but we may want to define array with other types
- a source string should be available, but we may just know the string size
We introduce __dynamic_array() to break those limitations, and __string()
becomes a wrapper of it. As a side effect, now __get_str() can be used
in TP_fast_assign but not only TP_print.
Take XFS for example, we have the string length in the dirent, but the
string itself is not NULL-terminated, so __dynamic_array() can be used:
TRACE_EVENT(xfs_dir2,
TP_PROTO(struct xfs_da_args *args),
TP_ARGS(args),
TP_STRUCT__entry(
__field(int, namelen)
__dynamic_array(char, name, args->namelen + 1)
...
),
TP_fast_assign(
char *name = __get_str(name);
if (args->namelen)
memcpy(name, args->name, args->namelen);
name[args->namelen] = '\0';
__entry->namelen = args->namelen;
),
TP_printk("name %.*s namelen %d",
__entry->namelen ? __get_str(name) : NULL
__entry->namelen)
);
[ Impact: allow defining dynamic size arrays ]
Signed-off-by: Li Zefan <lizf@cn.fujitsu.com>
LKML-Reference: <4A2384D2.3080403@cn.fujitsu.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2009-06-01 15:35:46 +08:00
|
|
|
#undef __dynamic_array
|
2019-10-25 04:26:59 +08:00
|
|
|
#define __dynamic_array(_type, _item, _len) { \
|
|
|
|
|
.type = "__data_loc " #_type "[]", .name = #_item, \
|
|
|
|
|
.size = 4, .align = 4, \
|
|
|
|
|
.is_signed = is_signed_type(_type), .filter_type = FILTER_OTHER },
|
tracing/events: introduce __dynamic_array()
__string() is limited:
- it's a char array, but we may want to define array with other types
- a source string should be available, but we may just know the string size
We introduce __dynamic_array() to break those limitations, and __string()
becomes a wrapper of it. As a side effect, now __get_str() can be used
in TP_fast_assign but not only TP_print.
Take XFS for example, we have the string length in the dirent, but the
string itself is not NULL-terminated, so __dynamic_array() can be used:
TRACE_EVENT(xfs_dir2,
TP_PROTO(struct xfs_da_args *args),
TP_ARGS(args),
TP_STRUCT__entry(
__field(int, namelen)
__dynamic_array(char, name, args->namelen + 1)
...
),
TP_fast_assign(
char *name = __get_str(name);
if (args->namelen)
memcpy(name, args->name, args->namelen);
name[args->namelen] = '\0';
__entry->namelen = args->namelen;
),
TP_printk("name %.*s namelen %d",
__entry->namelen ? __get_str(name) : NULL
__entry->namelen)
);
[ Impact: allow defining dynamic size arrays ]
Signed-off-by: Li Zefan <lizf@cn.fujitsu.com>
LKML-Reference: <4A2384D2.3080403@cn.fujitsu.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2009-06-01 15:35:46 +08:00
|
|
|
|
tracing/events: provide string with undefined size support
This patch provides the support for dynamic size strings on
event tracing.
The key concept is to use a structure with an ending char array field of
undefined size and use such ability to allocate the minimal size on the
ring buffer to make one or more string entries fit inside, as opposite
to a fixed length strings with upper bound.
The strings themselves are represented using fields which have an offset
value from the beginning of the entry.
This patch provides three new macros:
__string(item, src)
This one declares a string to the structure inside TP_STRUCT__entry.
You need to provide the name of the string field and the source that will
be copied inside.
This will also add the dynamic size of the string needed for the ring
buffer entry allocation.
A stack allocated structure is used to temporarily store the offset
of each strings, avoiding double calls to strlen() on each event
insertion.
__get_str(field)
This one will give you a pointer to the string you have created. This
is an abstract helper to resolve the absolute address given the field
name which is a relative address from the beginning of the trace_structure.
__assign_str(dst, src)
Use this macro to automatically perform the string copy from src to
dst. src must be a variable to assign and dst is the name of a __string
field.
Example on how to use it:
TRACE_EVENT(my_event,
TP_PROTO(char *src1, char *src2),
TP_ARGS(src1, src2),
TP_STRUCT__entry(
__string(str1, src1)
__string(str2, src2)
),
TP_fast_assign(
__assign_str(str1, src1);
__assign_str(str2, src2);
),
TP_printk("%s %s", __get_str(src1), __get_str(src2))
)
Of course you can mix-up any __field or __array inside this
TRACE_EVENT. The position of the __string or __assign_str
doesn't matter.
Changes in v2:
Address the suggestion of Steven Rostedt: drop the opening_string() macro
and redefine __ending_string() to get the size of the string to be copied
instead of overwritting the whole ring buffer allocation.
Changes in v3:
Address other suggestions of Steven Rostedt and Peter Zijlstra with
some changes: drop the __ending_string and the need to have only one
string field.
Use offsets instead of absolute addresses.
[ Impact: allow more compact memory usage for string tracing ]
Signed-off-by: Frederic Weisbecker <fweisbec@gmail.com>
Cc: Steven Rostedt <rostedt@goodmis.org>
Cc: Li Zefan <lizf@cn.fujitsu.com>
Cc: Peter Zijlstra <a.p.zijlstra@chello.nl>
2009-04-19 10:51:29 +08:00
|
|
|
#undef __string
|
tracing/events: introduce __dynamic_array()
__string() is limited:
- it's a char array, but we may want to define array with other types
- a source string should be available, but we may just know the string size
We introduce __dynamic_array() to break those limitations, and __string()
becomes a wrapper of it. As a side effect, now __get_str() can be used
in TP_fast_assign but not only TP_print.
Take XFS for example, we have the string length in the dirent, but the
string itself is not NULL-terminated, so __dynamic_array() can be used:
TRACE_EVENT(xfs_dir2,
TP_PROTO(struct xfs_da_args *args),
TP_ARGS(args),
TP_STRUCT__entry(
__field(int, namelen)
__dynamic_array(char, name, args->namelen + 1)
...
),
TP_fast_assign(
char *name = __get_str(name);
if (args->namelen)
memcpy(name, args->name, args->namelen);
name[args->namelen] = '\0';
__entry->namelen = args->namelen;
),
TP_printk("name %.*s namelen %d",
__entry->namelen ? __get_str(name) : NULL
__entry->namelen)
);
[ Impact: allow defining dynamic size arrays ]
Signed-off-by: Li Zefan <lizf@cn.fujitsu.com>
LKML-Reference: <4A2384D2.3080403@cn.fujitsu.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2009-06-01 15:35:46 +08:00
|
|
|
#define __string(item, src) __dynamic_array(char, item, -1)
|
tracing/events: provide string with undefined size support
This patch provides the support for dynamic size strings on
event tracing.
The key concept is to use a structure with an ending char array field of
undefined size and use such ability to allocate the minimal size on the
ring buffer to make one or more string entries fit inside, as opposite
to a fixed length strings with upper bound.
The strings themselves are represented using fields which have an offset
value from the beginning of the entry.
This patch provides three new macros:
__string(item, src)
This one declares a string to the structure inside TP_STRUCT__entry.
You need to provide the name of the string field and the source that will
be copied inside.
This will also add the dynamic size of the string needed for the ring
buffer entry allocation.
A stack allocated structure is used to temporarily store the offset
of each strings, avoiding double calls to strlen() on each event
insertion.
__get_str(field)
This one will give you a pointer to the string you have created. This
is an abstract helper to resolve the absolute address given the field
name which is a relative address from the beginning of the trace_structure.
__assign_str(dst, src)
Use this macro to automatically perform the string copy from src to
dst. src must be a variable to assign and dst is the name of a __string
field.
Example on how to use it:
TRACE_EVENT(my_event,
TP_PROTO(char *src1, char *src2),
TP_ARGS(src1, src2),
TP_STRUCT__entry(
__string(str1, src1)
__string(str2, src2)
),
TP_fast_assign(
__assign_str(str1, src1);
__assign_str(str2, src2);
),
TP_printk("%s %s", __get_str(src1), __get_str(src2))
)
Of course you can mix-up any __field or __array inside this
TRACE_EVENT. The position of the __string or __assign_str
doesn't matter.
Changes in v2:
Address the suggestion of Steven Rostedt: drop the opening_string() macro
and redefine __ending_string() to get the size of the string to be copied
instead of overwritting the whole ring buffer allocation.
Changes in v3:
Address other suggestions of Steven Rostedt and Peter Zijlstra with
some changes: drop the __ending_string and the need to have only one
string field.
Use offsets instead of absolute addresses.
[ Impact: allow more compact memory usage for string tracing ]
Signed-off-by: Frederic Weisbecker <fweisbec@gmail.com>
Cc: Steven Rostedt <rostedt@goodmis.org>
Cc: Li Zefan <lizf@cn.fujitsu.com>
Cc: Peter Zijlstra <a.p.zijlstra@chello.nl>
2009-04-19 10:51:29 +08:00
|
|
|
|
2021-07-17 08:55:10 +08:00
|
|
|
#undef __string_len
|
|
|
|
|
#define __string_len(item, src, len) __dynamic_array(char, item, -1)
|
|
|
|
|
|
tracing: Add __bitmask() macro to trace events to cpumasks and other bitmasks
Being able to show a cpumask of events can be useful as some events
may affect only some CPUs. There is no standard way to record the
cpumask and converting it to a string is rather expensive during
the trace as traces happen in hotpaths. It would be better to record
the raw event mask and be able to parse it at print time.
The following macros were added for use with the TRACE_EVENT() macro:
__bitmask()
__assign_bitmask()
__get_bitmask()
To test this, I added this to the sched_migrate_task event, which
looked like this:
TRACE_EVENT(sched_migrate_task,
TP_PROTO(struct task_struct *p, int dest_cpu, const struct cpumask *cpus),
TP_ARGS(p, dest_cpu, cpus),
TP_STRUCT__entry(
__array( char, comm, TASK_COMM_LEN )
__field( pid_t, pid )
__field( int, prio )
__field( int, orig_cpu )
__field( int, dest_cpu )
__bitmask( cpumask, num_possible_cpus() )
),
TP_fast_assign(
memcpy(__entry->comm, p->comm, TASK_COMM_LEN);
__entry->pid = p->pid;
__entry->prio = p->prio;
__entry->orig_cpu = task_cpu(p);
__entry->dest_cpu = dest_cpu;
__assign_bitmask(cpumask, cpumask_bits(cpus), num_possible_cpus());
),
TP_printk("comm=%s pid=%d prio=%d orig_cpu=%d dest_cpu=%d cpumask=%s",
__entry->comm, __entry->pid, __entry->prio,
__entry->orig_cpu, __entry->dest_cpu,
__get_bitmask(cpumask))
);
With the output of:
ksmtuned-3613 [003] d..2 485.220508: sched_migrate_task: comm=ksmtuned pid=3615 prio=120 orig_cpu=3 dest_cpu=2 cpumask=00000000,0000000f
migration/1-13 [001] d..5 485.221202: sched_migrate_task: comm=ksmtuned pid=3614 prio=120 orig_cpu=1 dest_cpu=0 cpumask=00000000,0000000f
awk-3615 [002] d.H5 485.221747: sched_migrate_task: comm=rcu_preempt pid=7 prio=120 orig_cpu=0 dest_cpu=1 cpumask=00000000,000000ff
migration/2-18 [002] d..5 485.222062: sched_migrate_task: comm=ksmtuned pid=3615 prio=120 orig_cpu=2 dest_cpu=3 cpumask=00000000,0000000f
Link: http://lkml.kernel.org/r/1399377998-14870-6-git-send-email-javi.merino@arm.com
Link: http://lkml.kernel.org/r/20140506132238.22e136d1@gandalf.local.home
Suggested-by: Javi Merino <javi.merino@arm.com>
Tested-by: Javi Merino <javi.merino@arm.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2014-05-07 01:10:24 +08:00
|
|
|
#undef __bitmask
|
|
|
|
|
#define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item, -1)
|
|
|
|
|
|
2009-11-26 16:04:55 +08:00
|
|
|
#undef DECLARE_EVENT_CLASS
|
|
|
|
|
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, func, print) \
|
2019-10-25 04:26:59 +08:00
|
|
|
static struct trace_event_fields trace_event_fields_##call[] = { \
|
|
|
|
|
tstruct \
|
|
|
|
|
{} };
|
2009-04-14 00:25:37 +08:00
|
|
|
|
2009-11-19 09:36:26 +08:00
|
|
|
#undef DEFINE_EVENT_PRINT
|
2020-06-12 17:28:43 +08:00
|
|
|
#define DEFINE_EVENT_PRINT(template, name, proto, args, print)
|
2009-11-19 09:36:26 +08:00
|
|
|
|
2009-04-14 00:25:37 +08:00
|
|
|
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
|
|
|
|
|
|
tracing/events: introduce __dynamic_array()
__string() is limited:
- it's a char array, but we may want to define array with other types
- a source string should be available, but we may just know the string size
We introduce __dynamic_array() to break those limitations, and __string()
becomes a wrapper of it. As a side effect, now __get_str() can be used
in TP_fast_assign but not only TP_print.
Take XFS for example, we have the string length in the dirent, but the
string itself is not NULL-terminated, so __dynamic_array() can be used:
TRACE_EVENT(xfs_dir2,
TP_PROTO(struct xfs_da_args *args),
TP_ARGS(args),
TP_STRUCT__entry(
__field(int, namelen)
__dynamic_array(char, name, args->namelen + 1)
...
),
TP_fast_assign(
char *name = __get_str(name);
if (args->namelen)
memcpy(name, args->name, args->namelen);
name[args->namelen] = '\0';
__entry->namelen = args->namelen;
),
TP_printk("name %.*s namelen %d",
__entry->namelen ? __get_str(name) : NULL
__entry->namelen)
);
[ Impact: allow defining dynamic size arrays ]
Signed-off-by: Li Zefan <lizf@cn.fujitsu.com>
LKML-Reference: <4A2384D2.3080403@cn.fujitsu.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2009-06-01 15:35:46 +08:00
|
|
|
/*
|
|
|
|
|
* remember the offset of each array from the beginning of the event.
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#undef __entry
|
|
|
|
|
#define __entry entry
|
|
|
|
|
|
|
|
|
|
#undef __field
|
|
|
|
|
#define __field(type, item)
|
|
|
|
|
|
2009-08-07 10:33:22 +08:00
|
|
|
#undef __field_ext
|
|
|
|
|
#define __field_ext(type, item, filter_type)
|
|
|
|
|
|
2014-06-17 20:59:16 +08:00
|
|
|
#undef __field_struct
|
|
|
|
|
#define __field_struct(type, item)
|
|
|
|
|
|
|
|
|
|
#undef __field_struct_ext
|
|
|
|
|
#define __field_struct_ext(type, item, filter_type)
|
|
|
|
|
|
tracing/events: introduce __dynamic_array()
__string() is limited:
- it's a char array, but we may want to define array with other types
- a source string should be available, but we may just know the string size
We introduce __dynamic_array() to break those limitations, and __string()
becomes a wrapper of it. As a side effect, now __get_str() can be used
in TP_fast_assign but not only TP_print.
Take XFS for example, we have the string length in the dirent, but the
string itself is not NULL-terminated, so __dynamic_array() can be used:
TRACE_EVENT(xfs_dir2,
TP_PROTO(struct xfs_da_args *args),
TP_ARGS(args),
TP_STRUCT__entry(
__field(int, namelen)
__dynamic_array(char, name, args->namelen + 1)
...
),
TP_fast_assign(
char *name = __get_str(name);
if (args->namelen)
memcpy(name, args->name, args->namelen);
name[args->namelen] = '\0';
__entry->namelen = args->namelen;
),
TP_printk("name %.*s namelen %d",
__entry->namelen ? __get_str(name) : NULL
__entry->namelen)
);
[ Impact: allow defining dynamic size arrays ]
Signed-off-by: Li Zefan <lizf@cn.fujitsu.com>
LKML-Reference: <4A2384D2.3080403@cn.fujitsu.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2009-06-01 15:35:46 +08:00
|
|
|
#undef __array
|
|
|
|
|
#define __array(type, item, len)
|
|
|
|
|
|
|
|
|
|
#undef __dynamic_array
|
|
|
|
|
#define __dynamic_array(type, item, len) \
|
2014-03-01 13:32:17 +08:00
|
|
|
__item_length = (len) * sizeof(type); \
|
tracing/events: introduce __dynamic_array()
__string() is limited:
- it's a char array, but we may want to define array with other types
- a source string should be available, but we may just know the string size
We introduce __dynamic_array() to break those limitations, and __string()
becomes a wrapper of it. As a side effect, now __get_str() can be used
in TP_fast_assign but not only TP_print.
Take XFS for example, we have the string length in the dirent, but the
string itself is not NULL-terminated, so __dynamic_array() can be used:
TRACE_EVENT(xfs_dir2,
TP_PROTO(struct xfs_da_args *args),
TP_ARGS(args),
TP_STRUCT__entry(
__field(int, namelen)
__dynamic_array(char, name, args->namelen + 1)
...
),
TP_fast_assign(
char *name = __get_str(name);
if (args->namelen)
memcpy(name, args->name, args->namelen);
name[args->namelen] = '\0';
__entry->namelen = args->namelen;
),
TP_printk("name %.*s namelen %d",
__entry->namelen ? __get_str(name) : NULL
__entry->namelen)
);
[ Impact: allow defining dynamic size arrays ]
Signed-off-by: Li Zefan <lizf@cn.fujitsu.com>
LKML-Reference: <4A2384D2.3080403@cn.fujitsu.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2009-06-01 15:35:46 +08:00
|
|
|
__data_offsets->item = __data_size + \
|
|
|
|
|
offsetof(typeof(*entry), __data); \
|
2014-03-01 13:32:17 +08:00
|
|
|
__data_offsets->item |= __item_length << 16; \
|
|
|
|
|
__data_size += __item_length;
|
tracing/events: introduce __dynamic_array()
__string() is limited:
- it's a char array, but we may want to define array with other types
- a source string should be available, but we may just know the string size
We introduce __dynamic_array() to break those limitations, and __string()
becomes a wrapper of it. As a side effect, now __get_str() can be used
in TP_fast_assign but not only TP_print.
Take XFS for example, we have the string length in the dirent, but the
string itself is not NULL-terminated, so __dynamic_array() can be used:
TRACE_EVENT(xfs_dir2,
TP_PROTO(struct xfs_da_args *args),
TP_ARGS(args),
TP_STRUCT__entry(
__field(int, namelen)
__dynamic_array(char, name, args->namelen + 1)
...
),
TP_fast_assign(
char *name = __get_str(name);
if (args->namelen)
memcpy(name, args->name, args->namelen);
name[args->namelen] = '\0';
__entry->namelen = args->namelen;
),
TP_printk("name %.*s namelen %d",
__entry->namelen ? __get_str(name) : NULL
__entry->namelen)
);
[ Impact: allow defining dynamic size arrays ]
Signed-off-by: Li Zefan <lizf@cn.fujitsu.com>
LKML-Reference: <4A2384D2.3080403@cn.fujitsu.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2009-06-01 15:35:46 +08:00
|
|
|
|
|
|
|
|
#undef __string
|
2013-11-26 22:22:54 +08:00
|
|
|
#define __string(item, src) __dynamic_array(char, item, \
|
|
|
|
|
strlen((src) ? (const char *)(src) : "(null)") + 1)
|
tracing/events: introduce __dynamic_array()
__string() is limited:
- it's a char array, but we may want to define array with other types
- a source string should be available, but we may just know the string size
We introduce __dynamic_array() to break those limitations, and __string()
becomes a wrapper of it. As a side effect, now __get_str() can be used
in TP_fast_assign but not only TP_print.
Take XFS for example, we have the string length in the dirent, but the
string itself is not NULL-terminated, so __dynamic_array() can be used:
TRACE_EVENT(xfs_dir2,
TP_PROTO(struct xfs_da_args *args),
TP_ARGS(args),
TP_STRUCT__entry(
__field(int, namelen)
__dynamic_array(char, name, args->namelen + 1)
...
),
TP_fast_assign(
char *name = __get_str(name);
if (args->namelen)
memcpy(name, args->name, args->namelen);
name[args->namelen] = '\0';
__entry->namelen = args->namelen;
),
TP_printk("name %.*s namelen %d",
__entry->namelen ? __get_str(name) : NULL
__entry->namelen)
);
[ Impact: allow defining dynamic size arrays ]
Signed-off-by: Li Zefan <lizf@cn.fujitsu.com>
LKML-Reference: <4A2384D2.3080403@cn.fujitsu.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2009-06-01 15:35:46 +08:00
|
|
|
|
2021-07-17 08:55:10 +08:00
|
|
|
#undef __string_len
|
|
|
|
|
#define __string_len(item, src, len) __dynamic_array(char, item, (len) + 1)
|
|
|
|
|
|
tracing: Add __bitmask() macro to trace events to cpumasks and other bitmasks
Being able to show a cpumask of events can be useful as some events
may affect only some CPUs. There is no standard way to record the
cpumask and converting it to a string is rather expensive during
the trace as traces happen in hotpaths. It would be better to record
the raw event mask and be able to parse it at print time.
The following macros were added for use with the TRACE_EVENT() macro:
__bitmask()
__assign_bitmask()
__get_bitmask()
To test this, I added this to the sched_migrate_task event, which
looked like this:
TRACE_EVENT(sched_migrate_task,
TP_PROTO(struct task_struct *p, int dest_cpu, const struct cpumask *cpus),
TP_ARGS(p, dest_cpu, cpus),
TP_STRUCT__entry(
__array( char, comm, TASK_COMM_LEN )
__field( pid_t, pid )
__field( int, prio )
__field( int, orig_cpu )
__field( int, dest_cpu )
__bitmask( cpumask, num_possible_cpus() )
),
TP_fast_assign(
memcpy(__entry->comm, p->comm, TASK_COMM_LEN);
__entry->pid = p->pid;
__entry->prio = p->prio;
__entry->orig_cpu = task_cpu(p);
__entry->dest_cpu = dest_cpu;
__assign_bitmask(cpumask, cpumask_bits(cpus), num_possible_cpus());
),
TP_printk("comm=%s pid=%d prio=%d orig_cpu=%d dest_cpu=%d cpumask=%s",
__entry->comm, __entry->pid, __entry->prio,
__entry->orig_cpu, __entry->dest_cpu,
__get_bitmask(cpumask))
);
With the output of:
ksmtuned-3613 [003] d..2 485.220508: sched_migrate_task: comm=ksmtuned pid=3615 prio=120 orig_cpu=3 dest_cpu=2 cpumask=00000000,0000000f
migration/1-13 [001] d..5 485.221202: sched_migrate_task: comm=ksmtuned pid=3614 prio=120 orig_cpu=1 dest_cpu=0 cpumask=00000000,0000000f
awk-3615 [002] d.H5 485.221747: sched_migrate_task: comm=rcu_preempt pid=7 prio=120 orig_cpu=0 dest_cpu=1 cpumask=00000000,000000ff
migration/2-18 [002] d..5 485.222062: sched_migrate_task: comm=ksmtuned pid=3615 prio=120 orig_cpu=2 dest_cpu=3 cpumask=00000000,0000000f
Link: http://lkml.kernel.org/r/1399377998-14870-6-git-send-email-javi.merino@arm.com
Link: http://lkml.kernel.org/r/20140506132238.22e136d1@gandalf.local.home
Suggested-by: Javi Merino <javi.merino@arm.com>
Tested-by: Javi Merino <javi.merino@arm.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2014-05-07 01:10:24 +08:00
|
|
|
/*
|
|
|
|
|
* __bitmask_size_in_bytes_raw is the number of bytes needed to hold
|
|
|
|
|
* num_possible_cpus().
|
|
|
|
|
*/
|
|
|
|
|
#define __bitmask_size_in_bytes_raw(nr_bits) \
|
|
|
|
|
(((nr_bits) + 7) / 8)
|
|
|
|
|
|
|
|
|
|
#define __bitmask_size_in_longs(nr_bits) \
|
|
|
|
|
((__bitmask_size_in_bytes_raw(nr_bits) + \
|
|
|
|
|
((BITS_PER_LONG / 8) - 1)) / (BITS_PER_LONG / 8))
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* __bitmask_size_in_bytes is the number of bytes needed to hold
|
|
|
|
|
* num_possible_cpus() padded out to the nearest long. This is what
|
|
|
|
|
* is saved in the buffer, just to be consistent.
|
|
|
|
|
*/
|
|
|
|
|
#define __bitmask_size_in_bytes(nr_bits) \
|
|
|
|
|
(__bitmask_size_in_longs(nr_bits) * (BITS_PER_LONG / 8))
|
|
|
|
|
|
|
|
|
|
#undef __bitmask
|
|
|
|
|
#define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item, \
|
|
|
|
|
__bitmask_size_in_longs(nr_bits))
|
|
|
|
|
|
2009-11-26 16:04:55 +08:00
|
|
|
#undef DECLARE_EVENT_CLASS
|
|
|
|
|
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
|
2015-05-14 03:40:23 +08:00
|
|
|
static inline notrace int trace_event_get_offsets_##call( \
|
2015-05-14 03:33:52 +08:00
|
|
|
struct trace_event_data_offsets_##call *__data_offsets, proto) \
|
tracing/events: introduce __dynamic_array()
__string() is limited:
- it's a char array, but we may want to define array with other types
- a source string should be available, but we may just know the string size
We introduce __dynamic_array() to break those limitations, and __string()
becomes a wrapper of it. As a side effect, now __get_str() can be used
in TP_fast_assign but not only TP_print.
Take XFS for example, we have the string length in the dirent, but the
string itself is not NULL-terminated, so __dynamic_array() can be used:
TRACE_EVENT(xfs_dir2,
TP_PROTO(struct xfs_da_args *args),
TP_ARGS(args),
TP_STRUCT__entry(
__field(int, namelen)
__dynamic_array(char, name, args->namelen + 1)
...
),
TP_fast_assign(
char *name = __get_str(name);
if (args->namelen)
memcpy(name, args->name, args->namelen);
name[args->namelen] = '\0';
__entry->namelen = args->namelen;
),
TP_printk("name %.*s namelen %d",
__entry->namelen ? __get_str(name) : NULL
__entry->namelen)
);
[ Impact: allow defining dynamic size arrays ]
Signed-off-by: Li Zefan <lizf@cn.fujitsu.com>
LKML-Reference: <4A2384D2.3080403@cn.fujitsu.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2009-06-01 15:35:46 +08:00
|
|
|
{ \
|
|
|
|
|
int __data_size = 0; \
|
2014-03-01 13:32:17 +08:00
|
|
|
int __maybe_unused __item_length; \
|
2015-05-14 03:27:47 +08:00
|
|
|
struct trace_event_raw_##call __maybe_unused *entry; \
|
tracing/events: introduce __dynamic_array()
__string() is limited:
- it's a char array, but we may want to define array with other types
- a source string should be available, but we may just know the string size
We introduce __dynamic_array() to break those limitations, and __string()
becomes a wrapper of it. As a side effect, now __get_str() can be used
in TP_fast_assign but not only TP_print.
Take XFS for example, we have the string length in the dirent, but the
string itself is not NULL-terminated, so __dynamic_array() can be used:
TRACE_EVENT(xfs_dir2,
TP_PROTO(struct xfs_da_args *args),
TP_ARGS(args),
TP_STRUCT__entry(
__field(int, namelen)
__dynamic_array(char, name, args->namelen + 1)
...
),
TP_fast_assign(
char *name = __get_str(name);
if (args->namelen)
memcpy(name, args->name, args->namelen);
name[args->namelen] = '\0';
__entry->namelen = args->namelen;
),
TP_printk("name %.*s namelen %d",
__entry->namelen ? __get_str(name) : NULL
__entry->namelen)
);
[ Impact: allow defining dynamic size arrays ]
Signed-off-by: Li Zefan <lizf@cn.fujitsu.com>
LKML-Reference: <4A2384D2.3080403@cn.fujitsu.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2009-06-01 15:35:46 +08:00
|
|
|
\
|
|
|
|
|
tstruct; \
|
|
|
|
|
\
|
|
|
|
|
return __data_size; \
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
|
|
|
|
|
|
2015-09-23 21:26:27 +08:00
|
|
|
/*
|
|
|
|
|
* Stage 4 of the trace events.
|
|
|
|
|
*
|
2015-03-04 05:48:18 +08:00
|
|
|
* Override the macros in the event tracepoint header <trace/events/XXX.h>
|
|
|
|
|
* to include the following:
|
2015-09-23 21:26:27 +08:00
|
|
|
*
|
|
|
|
|
* For those macros defined with TRACE_EVENT:
|
|
|
|
|
*
|
|
|
|
|
* static struct trace_event_call event_<call>;
|
|
|
|
|
*
|
|
|
|
|
* static void trace_event_raw_event_<call>(void *__data, proto)
|
|
|
|
|
* {
|
|
|
|
|
* struct trace_event_file *trace_file = __data;
|
|
|
|
|
* struct trace_event_call *event_call = trace_file->event_call;
|
|
|
|
|
* struct trace_event_data_offsets_<call> __maybe_unused __data_offsets;
|
|
|
|
|
* unsigned long eflags = trace_file->flags;
|
|
|
|
|
* enum event_trigger_type __tt = ETT_NONE;
|
|
|
|
|
* struct ring_buffer_event *event;
|
|
|
|
|
* struct trace_event_raw_<call> *entry; <-- defined in stage 1
|
2019-12-14 02:58:57 +08:00
|
|
|
* struct trace_buffer *buffer;
|
2015-09-23 21:26:27 +08:00
|
|
|
* unsigned long irq_flags;
|
|
|
|
|
* int __data_size;
|
|
|
|
|
* int pc;
|
|
|
|
|
*
|
|
|
|
|
* if (!(eflags & EVENT_FILE_FL_TRIGGER_COND)) {
|
|
|
|
|
* if (eflags & EVENT_FILE_FL_TRIGGER_MODE)
|
|
|
|
|
* event_triggers_call(trace_file, NULL);
|
|
|
|
|
* if (eflags & EVENT_FILE_FL_SOFT_DISABLED)
|
|
|
|
|
* return;
|
|
|
|
|
* }
|
|
|
|
|
*
|
|
|
|
|
* local_save_flags(irq_flags);
|
|
|
|
|
* pc = preempt_count();
|
|
|
|
|
*
|
|
|
|
|
* __data_size = trace_event_get_offsets_<call>(&__data_offsets, args);
|
|
|
|
|
*
|
|
|
|
|
* event = trace_event_buffer_lock_reserve(&buffer, trace_file,
|
|
|
|
|
* event_<call>->event.type,
|
|
|
|
|
* sizeof(*entry) + __data_size,
|
|
|
|
|
* irq_flags, pc);
|
|
|
|
|
* if (!event)
|
|
|
|
|
* return;
|
|
|
|
|
* entry = ring_buffer_event_data(event);
|
|
|
|
|
*
|
|
|
|
|
* { <assign>; } <-- Here we assign the entries by the __field and
|
|
|
|
|
* __array macros.
|
|
|
|
|
*
|
|
|
|
|
* if (eflags & EVENT_FILE_FL_TRIGGER_COND)
|
|
|
|
|
* __tt = event_triggers_call(trace_file, entry);
|
|
|
|
|
*
|
|
|
|
|
* if (test_bit(EVENT_FILE_FL_SOFT_DISABLED_BIT,
|
|
|
|
|
* &trace_file->flags))
|
|
|
|
|
* ring_buffer_discard_commit(buffer, event);
|
|
|
|
|
* else if (!filter_check_discard(trace_file, entry, buffer, event))
|
|
|
|
|
* trace_buffer_unlock_commit(buffer, event, irq_flags, pc);
|
|
|
|
|
*
|
|
|
|
|
* if (__tt)
|
|
|
|
|
* event_triggers_post_call(trace_file, __tt);
|
|
|
|
|
* }
|
|
|
|
|
*
|
|
|
|
|
* static struct trace_event ftrace_event_type_<call> = {
|
|
|
|
|
* .trace = trace_raw_output_<call>, <-- stage 2
|
|
|
|
|
* };
|
|
|
|
|
*
|
|
|
|
|
* static char print_fmt_<call>[] = <TP_printk>;
|
|
|
|
|
*
|
|
|
|
|
* static struct trace_event_class __used event_class_<template> = {
|
|
|
|
|
* .system = "<system>",
|
2019-10-25 04:26:59 +08:00
|
|
|
* .fields_array = trace_event_fields_<call>,
|
2015-09-23 21:26:27 +08:00
|
|
|
* .fields = LIST_HEAD_INIT(event_class_##call.fields),
|
|
|
|
|
* .raw_init = trace_event_raw_init,
|
|
|
|
|
* .probe = trace_event_raw_event_##call,
|
|
|
|
|
* .reg = trace_event_reg,
|
|
|
|
|
* };
|
|
|
|
|
*
|
|
|
|
|
* static struct trace_event_call event_<call> = {
|
|
|
|
|
* .class = event_class_<template>,
|
|
|
|
|
* {
|
|
|
|
|
* .tp = &__tracepoint_<call>,
|
|
|
|
|
* },
|
|
|
|
|
* .event = &ftrace_event_type_<call>,
|
|
|
|
|
* .print_fmt = print_fmt_<call>,
|
|
|
|
|
* .flags = TRACE_EVENT_FL_TRACEPOINT,
|
|
|
|
|
* };
|
|
|
|
|
* // its only safe to use pointers when doing linker tricks to
|
|
|
|
|
* // create an array.
|
|
|
|
|
* static struct trace_event_call __used
|
2020-10-22 10:36:07 +08:00
|
|
|
* __section("_ftrace_events") *__event_<call> = &event_<call>;
|
2015-09-23 21:26:27 +08:00
|
|
|
*
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifdef CONFIG_PERF_EVENTS
|
|
|
|
|
|
|
|
|
|
#define _TRACE_PERF_PROTO(call, proto) \
|
|
|
|
|
static notrace void \
|
|
|
|
|
perf_trace_##call(void *__data, proto);
|
|
|
|
|
|
|
|
|
|
#define _TRACE_PERF_INIT(call) \
|
|
|
|
|
.perf_probe = perf_trace_##call,
|
|
|
|
|
|
|
|
|
|
#else
|
|
|
|
|
#define _TRACE_PERF_PROTO(call, proto)
|
|
|
|
|
#define _TRACE_PERF_INIT(call)
|
|
|
|
|
#endif /* CONFIG_PERF_EVENTS */
|
|
|
|
|
|
|
|
|
|
#undef __entry
|
|
|
|
|
#define __entry entry
|
|
|
|
|
|
|
|
|
|
#undef __field
|
|
|
|
|
#define __field(type, item)
|
|
|
|
|
|
|
|
|
|
#undef __field_struct
|
|
|
|
|
#define __field_struct(type, item)
|
|
|
|
|
|
|
|
|
|
#undef __array
|
|
|
|
|
#define __array(type, item, len)
|
|
|
|
|
|
|
|
|
|
#undef __dynamic_array
|
|
|
|
|
#define __dynamic_array(type, item, len) \
|
|
|
|
|
__entry->__data_loc_##item = __data_offsets.item;
|
|
|
|
|
|
|
|
|
|
#undef __string
|
|
|
|
|
#define __string(item, src) __dynamic_array(char, item, -1)
|
|
|
|
|
|
2021-07-17 08:55:10 +08:00
|
|
|
#undef __string_len
|
|
|
|
|
#define __string_len(item, src, len) __dynamic_array(char, item, -1)
|
|
|
|
|
|
2015-09-23 21:26:27 +08:00
|
|
|
#undef __assign_str
|
|
|
|
|
#define __assign_str(dst, src) \
|
|
|
|
|
strcpy(__get_str(dst), (src) ? (const char *)(src) : "(null)");
|
|
|
|
|
|
2021-07-17 08:55:10 +08:00
|
|
|
#undef __assign_str_len
|
|
|
|
|
#define __assign_str_len(dst, src, len) \
|
|
|
|
|
do { \
|
|
|
|
|
memcpy(__get_str(dst), (src), (len)); \
|
|
|
|
|
__get_str(dst)[len] = '\0'; \
|
|
|
|
|
} while(0)
|
|
|
|
|
|
2015-09-23 21:26:27 +08:00
|
|
|
#undef __bitmask
|
|
|
|
|
#define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item, -1)
|
|
|
|
|
|
|
|
|
|
#undef __get_bitmask
|
|
|
|
|
#define __get_bitmask(field) (char *)__get_dynamic_array(field)
|
|
|
|
|
|
|
|
|
|
#undef __assign_bitmask
|
|
|
|
|
#define __assign_bitmask(dst, src, nr_bits) \
|
|
|
|
|
memcpy(__get_bitmask(dst), (src), __bitmask_size_in_bytes(nr_bits))
|
|
|
|
|
|
|
|
|
|
#undef TP_fast_assign
|
|
|
|
|
#define TP_fast_assign(args...) args
|
|
|
|
|
|
|
|
|
|
#undef __perf_count
|
|
|
|
|
#define __perf_count(c) (c)
|
|
|
|
|
|
|
|
|
|
#undef __perf_task
|
|
|
|
|
#define __perf_task(t) (t)
|
|
|
|
|
|
|
|
|
|
#undef DECLARE_EVENT_CLASS
|
|
|
|
|
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
|
|
|
|
|
\
|
|
|
|
|
static notrace void \
|
|
|
|
|
trace_event_raw_event_##call(void *__data, proto) \
|
|
|
|
|
{ \
|
|
|
|
|
struct trace_event_file *trace_file = __data; \
|
|
|
|
|
struct trace_event_data_offsets_##call __maybe_unused __data_offsets;\
|
|
|
|
|
struct trace_event_buffer fbuffer; \
|
|
|
|
|
struct trace_event_raw_##call *entry; \
|
|
|
|
|
int __data_size; \
|
|
|
|
|
\
|
|
|
|
|
if (trace_trigger_soft_disabled(trace_file)) \
|
|
|
|
|
return; \
|
|
|
|
|
\
|
|
|
|
|
__data_size = trace_event_get_offsets_##call(&__data_offsets, args); \
|
|
|
|
|
\
|
|
|
|
|
entry = trace_event_buffer_reserve(&fbuffer, trace_file, \
|
|
|
|
|
sizeof(*entry) + __data_size); \
|
|
|
|
|
\
|
|
|
|
|
if (!entry) \
|
|
|
|
|
return; \
|
|
|
|
|
\
|
|
|
|
|
tstruct \
|
|
|
|
|
\
|
|
|
|
|
{ assign; } \
|
|
|
|
|
\
|
|
|
|
|
trace_event_buffer_commit(&fbuffer); \
|
|
|
|
|
}
|
|
|
|
|
/*
|
|
|
|
|
* The ftrace_test_probe is compiled out, it is only here as a build time check
|
|
|
|
|
* to make sure that if the tracepoint handling changes, the ftrace probe will
|
|
|
|
|
* fail to compile unless it too is updated.
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#undef DEFINE_EVENT
|
|
|
|
|
#define DEFINE_EVENT(template, call, proto, args) \
|
|
|
|
|
static inline void ftrace_test_probe_##call(void) \
|
|
|
|
|
{ \
|
|
|
|
|
check_trace_callback_type_##call(trace_event_raw_event_##template); \
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
|
|
|
|
|
|
|
|
|
|
#undef __entry
|
|
|
|
|
#define __entry REC
|
|
|
|
|
|
|
|
|
|
#undef __print_flags
|
|
|
|
|
#undef __print_symbolic
|
|
|
|
|
#undef __print_hex
|
2017-01-25 09:28:16 +08:00
|
|
|
#undef __print_hex_str
|
2015-09-23 21:26:27 +08:00
|
|
|
#undef __get_dynamic_array
|
|
|
|
|
#undef __get_dynamic_array_len
|
|
|
|
|
#undef __get_str
|
|
|
|
|
#undef __get_bitmask
|
|
|
|
|
#undef __print_array
|
2019-11-26 18:06:31 +08:00
|
|
|
#undef __print_hex_dump
|
2015-09-23 21:26:27 +08:00
|
|
|
|
trace: Add __print_ns_to_secs() and __print_ns_without_secs() helpers
To have nanosecond output displayed in a more human readable format, its
nicer to convert it to a seconds format (XXX.YYYYYYYYY). The problem is that
to do so, the numbers must be divided by NSEC_PER_SEC, and moded too. But as
these numbers are 64 bit, this can not be done simply with '/' and '%'
operators, but must use do_div() instead.
Instead of performing the expensive do_div() in the hot path of the
tracepoint, it is more efficient to perform it during the output phase. But
passing in do_div() can confuse the parser, and do_div() doesn't work
exactly like a normal C function. It modifies the number in place, and we
don't want to modify the actual values in the ring buffer.
Two helper functions are now created:
__print_ns_to_secs() and __print_ns_without_secs()
They both take a value of nanoseconds, and the former will return that
number divided by NSEC_PER_SEC, and the latter will mod it with NSEC_PER_SEC
giving a way to print a nice human readable format:
__print_fmt("time=%llu.%09u",
__print_ns_to_secs(REC->nsec_val),
__print_ns_without_secs(REC->nsec_val))
Link: https://lkml.kernel.org/r/e503b903045496c4ccde52843e1e318b422f7a56.1624372313.git.bristot@redhat.com
Cc: Phil Auld <pauld@redhat.com>
Cc: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
Cc: Kate Carcia <kcarcia@redhat.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: Alexandre Chartre <alexandre.chartre@oracle.com>
Cc: Clark Willaims <williams@redhat.com>
Cc: John Kacur <jkacur@redhat.com>
Cc: Juri Lelli <juri.lelli@redhat.com>
Cc: Borislav Petkov <bp@alien8.de>
Cc: "H. Peter Anvin" <hpa@zytor.com>
Cc: x86@kernel.org
Cc: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
Signed-off-by: Daniel Bristot de Oliveira <bristot@redhat.com>
Signed-off-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
2021-06-22 22:42:26 +08:00
|
|
|
/*
|
|
|
|
|
* The below is not executed in the kernel. It is only what is
|
|
|
|
|
* displayed in the print format for userspace to parse.
|
|
|
|
|
*/
|
|
|
|
|
#undef __print_ns_to_secs
|
|
|
|
|
#define __print_ns_to_secs(val) (val) / 1000000000UL
|
|
|
|
|
|
|
|
|
|
#undef __print_ns_without_secs
|
|
|
|
|
#define __print_ns_without_secs(val) (val) % 1000000000UL
|
|
|
|
|
|
2015-09-23 21:26:27 +08:00
|
|
|
#undef TP_printk
|
|
|
|
|
#define TP_printk(fmt, args...) "\"" fmt "\", " __stringify(args)
|
|
|
|
|
|
|
|
|
|
#undef DECLARE_EVENT_CLASS
|
|
|
|
|
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
|
|
|
|
|
_TRACE_PERF_PROTO(call, PARAMS(proto)); \
|
|
|
|
|
static char print_fmt_##call[] = print; \
|
|
|
|
|
static struct trace_event_class __used __refdata event_class_##call = { \
|
|
|
|
|
.system = TRACE_SYSTEM_STRING, \
|
2019-10-25 04:26:59 +08:00
|
|
|
.fields_array = trace_event_fields_##call, \
|
2015-09-23 21:26:27 +08:00
|
|
|
.fields = LIST_HEAD_INIT(event_class_##call.fields),\
|
|
|
|
|
.raw_init = trace_event_raw_init, \
|
|
|
|
|
.probe = trace_event_raw_event_##call, \
|
|
|
|
|
.reg = trace_event_reg, \
|
|
|
|
|
_TRACE_PERF_INIT(call) \
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
#undef DEFINE_EVENT
|
|
|
|
|
#define DEFINE_EVENT(template, call, proto, args) \
|
|
|
|
|
\
|
|
|
|
|
static struct trace_event_call __used event_##call = { \
|
|
|
|
|
.class = &event_class_##template, \
|
|
|
|
|
{ \
|
|
|
|
|
.tp = &__tracepoint_##call, \
|
|
|
|
|
}, \
|
|
|
|
|
.event.funcs = &trace_event_type_funcs_##template, \
|
|
|
|
|
.print_fmt = print_fmt_##template, \
|
|
|
|
|
.flags = TRACE_EVENT_FL_TRACEPOINT, \
|
|
|
|
|
}; \
|
|
|
|
|
static struct trace_event_call __used \
|
2020-10-22 10:36:07 +08:00
|
|
|
__section("_ftrace_events") *__event_##call = &event_##call
|
2015-09-23 21:26:27 +08:00
|
|
|
|
|
|
|
|
#undef DEFINE_EVENT_PRINT
|
|
|
|
|
#define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
|
|
|
|
|
\
|
|
|
|
|
static char print_fmt_##call[] = print; \
|
|
|
|
|
\
|
|
|
|
|
static struct trace_event_call __used event_##call = { \
|
|
|
|
|
.class = &event_class_##template, \
|
|
|
|
|
{ \
|
|
|
|
|
.tp = &__tracepoint_##call, \
|
|
|
|
|
}, \
|
|
|
|
|
.event.funcs = &trace_event_type_funcs_##call, \
|
|
|
|
|
.print_fmt = print_fmt_##call, \
|
|
|
|
|
.flags = TRACE_EVENT_FL_TRACEPOINT, \
|
|
|
|
|
}; \
|
|
|
|
|
static struct trace_event_call __used \
|
2020-10-22 10:36:07 +08:00
|
|
|
__section("_ftrace_events") *__event_##call = &event_##call
|
2015-09-23 21:26:27 +08:00
|
|
|
|
|
|
|
|
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
|