License cleanup: add SPDX GPL-2.0 license identifier to files with no license
[linux-2.6-block.git] / kernel / trace / trace_export.c
CommitLineData
b2441318 1// SPDX-License-Identifier: GPL-2.0
770cb243
SR
2/*
3 * trace_export.c - export basic ftrace utilities to user space
4 *
5 * Copyright (C) 2009 Steven Rostedt <srostedt@redhat.com>
6 */
7#include <linux/stringify.h>
8#include <linux/kallsyms.h>
9#include <linux/seq_file.h>
770cb243
SR
10#include <linux/uaccess.h>
11#include <linux/ftrace.h>
12#include <linux/module.h>
13#include <linux/init.h>
770cb243
SR
14
15#include "trace_output.h"
16
4e5292ea
SR
17#undef TRACE_SYSTEM
18#define TRACE_SYSTEM ftrace
da4d0302 19
e59a0bff
JO
20/*
21 * The FTRACE_ENTRY_REG macro allows ftrace entry to define register
22 * function and thus become accesible via perf.
23 */
24#undef FTRACE_ENTRY_REG
02aa3162
JO
25#define FTRACE_ENTRY_REG(name, struct_name, id, tstruct, print, \
26 filter, regfn) \
27 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print), \
28 filter)
e59a0bff 29
4e5292ea
SR
30/* not needed for this file */
31#undef __field_struct
32#define __field_struct(type, item)
da4d0302 33
05ffa2d0
LZ
34#undef __field
35#define __field(type, item) type item;
36
37#undef __field_desc
38#define __field_desc(type, container, item) type item;
39
40#undef __array
41#define __array(type, item, size) type item[size];
42
43#undef __array_desc
44#define __array_desc(type, container, item, size) type item[size];
45
46#undef __dynamic_array
47#define __dynamic_array(type, item) type item[];
48
49#undef F_STRUCT
50#define F_STRUCT(args...) args
51
52#undef F_printk
53#define F_printk(fmt, args...) fmt, args
54
55#undef FTRACE_ENTRY
02aa3162
JO
56#define FTRACE_ENTRY(name, struct_name, id, tstruct, print, filter) \
57struct ____ftrace_##name { \
58 tstruct \
59}; \
60static void __always_unused ____ftrace_check_##name(void) \
61{ \
62 struct ____ftrace_##name *__entry = NULL; \
63 \
64 /* force compile-time check on F_printk() */ \
65 printk(print); \
05ffa2d0
LZ
66}
67
68#undef FTRACE_ENTRY_DUP
02aa3162
JO
69#define FTRACE_ENTRY_DUP(name, struct_name, id, tstruct, print, filter) \
70 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print), \
71 filter)
05ffa2d0
LZ
72
73#include "trace_entries.h"
74
4e5292ea
SR
75#undef __field
76#define __field(type, item) \
77 ret = trace_define_field(event_call, #type, #item, \
78 offsetof(typeof(field), item), \
79 sizeof(field.item), \
02aa3162 80 is_signed_type(type), filter_type); \
4e5292ea
SR
81 if (ret) \
82 return ret;
83
84#undef __field_desc
85#define __field_desc(type, container, item) \
86 ret = trace_define_field(event_call, #type, #item, \
87 offsetof(typeof(field), \
88 container.item), \
89 sizeof(field.container.item), \
02aa3162 90 is_signed_type(type), filter_type); \
4e5292ea
SR
91 if (ret) \
92 return ret;
93
94#undef __array
95#define __array(type, item, len) \
04295780 96 do { \
87291347 97 char *type_str = #type"["__stringify(len)"]"; \
04295780 98 BUILD_BUG_ON(len > MAX_FILTER_STR_VAL); \
87291347 99 ret = trace_define_field(event_call, type_str, #item, \
4e5292ea 100 offsetof(typeof(field), item), \
fb7ae981 101 sizeof(field.item), \
02aa3162 102 is_signed_type(type), filter_type); \
04295780
SR
103 if (ret) \
104 return ret; \
105 } while (0);
4e5292ea
SR
106
107#undef __array_desc
108#define __array_desc(type, container, item, len) \
109 BUILD_BUG_ON(len > MAX_FILTER_STR_VAL); \
110 ret = trace_define_field(event_call, #type "[" #len "]", #item, \
111 offsetof(typeof(field), \
112 container.item), \
fb7ae981 113 sizeof(field.container.item), \
02aa3162 114 is_signed_type(type), filter_type); \
4e5292ea
SR
115 if (ret) \
116 return ret;
117
118#undef __dynamic_array
809826a3
LJ
119#define __dynamic_array(type, item) \
120 ret = trace_define_field(event_call, #type, #item, \
121 offsetof(typeof(field), item), \
02aa3162 122 0, is_signed_type(type), filter_type);\
809826a3
LJ
123 if (ret) \
124 return ret;
4e5292ea
SR
125
126#undef FTRACE_ENTRY
02aa3162 127#define FTRACE_ENTRY(name, struct_name, id, tstruct, print, filter) \
7e4f44b1 128static int __init \
2425bcb9 129ftrace_define_fields_##name(struct trace_event_call *event_call) \
e45f2e2b 130{ \
4e5292ea 131 struct struct_name field; \
e45f2e2b 132 int ret; \
02aa3162 133 int filter_type = filter; \
e45f2e2b 134 \
4e5292ea 135 tstruct; \
e45f2e2b
TZ
136 \
137 return ret; \
138}
139
4e5292ea
SR
140#include "trace_entries.h"
141
509e760c
LJ
142#undef __entry
143#define __entry REC
144
4e5292ea
SR
145#undef __field
146#define __field(type, item)
147
148#undef __field_desc
149#define __field_desc(type, container, item)
150
151#undef __array
152#define __array(type, item, len)
153
154#undef __array_desc
155#define __array_desc(type, container, item, len)
156
157#undef __dynamic_array
158#define __dynamic_array(type, item)
159
509e760c 160#undef F_printk
01de982a 161#define F_printk(fmt, args...) __stringify(fmt) ", " __stringify(args)
509e760c 162
e59a0bff 163#undef FTRACE_ENTRY_REG
02aa3162
JO
164#define FTRACE_ENTRY_REG(call, struct_name, etype, tstruct, print, filter,\
165 regfn) \
770cb243 166 \
2425bcb9 167struct trace_event_class __refdata event_class_ftrace_##call = { \
2e33af02
SR
168 .system = __stringify(TRACE_SYSTEM), \
169 .define_fields = ftrace_define_fields_##call, \
ffb9f995 170 .fields = LIST_HEAD_INIT(event_class_ftrace_##call.fields),\
e59a0bff 171 .reg = regfn, \
2e33af02
SR
172}; \
173 \
2425bcb9 174struct trace_event_call __used event_##call = { \
2e33af02 175 .class = &event_class_ftrace_##call, \
abb43f69
MD
176 { \
177 .name = #call, \
178 }, \
179 .event.type = etype, \
509e760c 180 .print_fmt = print, \
754cb007 181 .flags = TRACE_EVENT_FL_IGNORE_ENABLE, \
e1112b4d 182}; \
2425bcb9 183struct trace_event_call __used \
e4a9ea5e 184__attribute__((section("_ftrace_events"))) *__event_##call = &event_##call;
e1112b4d 185
e59a0bff 186#undef FTRACE_ENTRY
02aa3162 187#define FTRACE_ENTRY(call, struct_name, etype, tstruct, print, filter) \
e59a0bff 188 FTRACE_ENTRY_REG(call, struct_name, etype, \
02aa3162 189 PARAMS(tstruct), PARAMS(print), filter, NULL)
e59a0bff 190
c6650b2e 191bool ftrace_event_is_function(struct trace_event_call *call)
ced39002
JO
192{
193 return call == &event_function;
194}
195
4e5292ea 196#include "trace_entries.h"