xref: /openbmc/linux/kernel/trace/trace_export.c (revision 01de982a)
1770cb243SSteven Rostedt /*
2770cb243SSteven Rostedt  * trace_export.c - export basic ftrace utilities to user space
3770cb243SSteven Rostedt  *
4770cb243SSteven Rostedt  * Copyright (C) 2009 Steven Rostedt <srostedt@redhat.com>
5770cb243SSteven Rostedt  */
6770cb243SSteven Rostedt #include <linux/stringify.h>
7770cb243SSteven Rostedt #include <linux/kallsyms.h>
8770cb243SSteven Rostedt #include <linux/seq_file.h>
9770cb243SSteven Rostedt #include <linux/debugfs.h>
10770cb243SSteven Rostedt #include <linux/uaccess.h>
11770cb243SSteven Rostedt #include <linux/ftrace.h>
12770cb243SSteven Rostedt #include <linux/module.h>
13770cb243SSteven Rostedt #include <linux/init.h>
14770cb243SSteven Rostedt #include <linux/fs.h>
15770cb243SSteven Rostedt 
16770cb243SSteven Rostedt #include "trace_output.h"
17770cb243SSteven Rostedt 
184e5292eaSSteven Rostedt #undef TRACE_SYSTEM
194e5292eaSSteven Rostedt #define TRACE_SYSTEM	ftrace
20da4d0302SSteven Rostedt 
214e5292eaSSteven Rostedt /* not needed for this file */
224e5292eaSSteven Rostedt #undef __field_struct
234e5292eaSSteven Rostedt #define __field_struct(type, item)
24da4d0302SSteven Rostedt 
254e5292eaSSteven Rostedt #undef __field
2605ffa2d0SLi Zefan #define __field(type, item)				type item;
2705ffa2d0SLi Zefan 
2805ffa2d0SLi Zefan #undef __field_desc
2905ffa2d0SLi Zefan #define __field_desc(type, container, item)		type item;
3005ffa2d0SLi Zefan 
3105ffa2d0SLi Zefan #undef __array
3205ffa2d0SLi Zefan #define __array(type, item, size)			type item[size];
3305ffa2d0SLi Zefan 
3405ffa2d0SLi Zefan #undef __array_desc
3505ffa2d0SLi Zefan #define __array_desc(type, container, item, size)	type item[size];
3605ffa2d0SLi Zefan 
3705ffa2d0SLi Zefan #undef __dynamic_array
3805ffa2d0SLi Zefan #define __dynamic_array(type, item)			type item[];
3905ffa2d0SLi Zefan 
4005ffa2d0SLi Zefan #undef F_STRUCT
4105ffa2d0SLi Zefan #define F_STRUCT(args...)				args
4205ffa2d0SLi Zefan 
4305ffa2d0SLi Zefan #undef F_printk
4405ffa2d0SLi Zefan #define F_printk(fmt, args...) fmt, args
4505ffa2d0SLi Zefan 
4605ffa2d0SLi Zefan #undef FTRACE_ENTRY
4705ffa2d0SLi Zefan #define FTRACE_ENTRY(name, struct_name, id, tstruct, print)	\
4805ffa2d0SLi Zefan struct ____ftrace_##name {					\
4905ffa2d0SLi Zefan 	tstruct							\
5005ffa2d0SLi Zefan };								\
515e9b3972SLi Zefan static void __always_unused ____ftrace_check_##name(void)	\
5205ffa2d0SLi Zefan {								\
5305ffa2d0SLi Zefan 	struct ____ftrace_##name *__entry = NULL;		\
5405ffa2d0SLi Zefan 								\
555e9b3972SLi Zefan 	/* force compile-time check on F_printk() */		\
5605ffa2d0SLi Zefan 	printk(print);						\
5705ffa2d0SLi Zefan }
5805ffa2d0SLi Zefan 
5905ffa2d0SLi Zefan #undef FTRACE_ENTRY_DUP
6005ffa2d0SLi Zefan #define FTRACE_ENTRY_DUP(name, struct_name, id, tstruct, print)	\
6105ffa2d0SLi Zefan 	FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print))
6205ffa2d0SLi Zefan 
6305ffa2d0SLi Zefan #include "trace_entries.h"
6405ffa2d0SLi Zefan 
654e5292eaSSteven Rostedt #undef __field
664e5292eaSSteven Rostedt #define __field(type, item)						\
674e5292eaSSteven Rostedt 	ret = trace_define_field(event_call, #type, #item,		\
684e5292eaSSteven Rostedt 				 offsetof(typeof(field), item),		\
694e5292eaSSteven Rostedt 				 sizeof(field.item),			\
704e5292eaSSteven Rostedt 				 is_signed_type(type), FILTER_OTHER);	\
714e5292eaSSteven Rostedt 	if (ret)							\
724e5292eaSSteven Rostedt 		return ret;
734e5292eaSSteven Rostedt 
744e5292eaSSteven Rostedt #undef __field_desc
754e5292eaSSteven Rostedt #define __field_desc(type, container, item)	\
764e5292eaSSteven Rostedt 	ret = trace_define_field(event_call, #type, #item,		\
774e5292eaSSteven Rostedt 				 offsetof(typeof(field),		\
784e5292eaSSteven Rostedt 					  container.item),		\
794e5292eaSSteven Rostedt 				 sizeof(field.container.item),		\
804e5292eaSSteven Rostedt 				 is_signed_type(type), FILTER_OTHER);	\
814e5292eaSSteven Rostedt 	if (ret)							\
824e5292eaSSteven Rostedt 		return ret;
834e5292eaSSteven Rostedt 
844e5292eaSSteven Rostedt #undef __array
854e5292eaSSteven Rostedt #define __array(type, item, len)					\
8604295780SSteven Rostedt 	do {								\
874e5292eaSSteven Rostedt 		BUILD_BUG_ON(len > MAX_FILTER_STR_VAL);			\
8804295780SSteven Rostedt 		mutex_lock(&event_storage_mutex);			\
8904295780SSteven Rostedt 		snprintf(event_storage, sizeof(event_storage),		\
9004295780SSteven Rostedt 			 "%s[%d]", #type, len);				\
9104295780SSteven Rostedt 		ret = trace_define_field(event_call, event_storage, #item, \
924e5292eaSSteven Rostedt 				 offsetof(typeof(field), item),		\
93fb7ae981SLai Jiangshan 				 sizeof(field.item),			\
94fb7ae981SLai Jiangshan 				 is_signed_type(type), FILTER_OTHER);	\
9504295780SSteven Rostedt 		mutex_unlock(&event_storage_mutex);			\
964e5292eaSSteven Rostedt 		if (ret)						\
9704295780SSteven Rostedt 			return ret;					\
9804295780SSteven Rostedt 	} while (0);
994e5292eaSSteven Rostedt 
1004e5292eaSSteven Rostedt #undef __array_desc
1014e5292eaSSteven Rostedt #define __array_desc(type, container, item, len)			\
1024e5292eaSSteven Rostedt 	BUILD_BUG_ON(len > MAX_FILTER_STR_VAL);				\
1034e5292eaSSteven Rostedt 	ret = trace_define_field(event_call, #type "[" #len "]", #item,	\
1044e5292eaSSteven Rostedt 				 offsetof(typeof(field),		\
1054e5292eaSSteven Rostedt 					  container.item),		\
106fb7ae981SLai Jiangshan 				 sizeof(field.container.item),		\
107fb7ae981SLai Jiangshan 				 is_signed_type(type), FILTER_OTHER);	\
1084e5292eaSSteven Rostedt 	if (ret)							\
1094e5292eaSSteven Rostedt 		return ret;
1104e5292eaSSteven Rostedt 
1114e5292eaSSteven Rostedt #undef __dynamic_array
112809826a3SLai Jiangshan #define __dynamic_array(type, item)					\
113809826a3SLai Jiangshan 	ret = trace_define_field(event_call, #type, #item,		\
114809826a3SLai Jiangshan 				 offsetof(typeof(field), item),		\
115809826a3SLai Jiangshan 				 0, is_signed_type(type), FILTER_OTHER);\
116809826a3SLai Jiangshan 	if (ret)							\
117809826a3SLai Jiangshan 		return ret;
1184e5292eaSSteven Rostedt 
1194e5292eaSSteven Rostedt #undef FTRACE_ENTRY
1204e5292eaSSteven Rostedt #define FTRACE_ENTRY(name, struct_name, id, tstruct, print)		\
1214e5292eaSSteven Rostedt int									\
1224e5292eaSSteven Rostedt ftrace_define_fields_##name(struct ftrace_event_call *event_call)	\
123e45f2e2bSTom Zanussi {									\
1244e5292eaSSteven Rostedt 	struct struct_name field;					\
125e45f2e2bSTom Zanussi 	int ret;							\
126e45f2e2bSTom Zanussi 									\
1274e5292eaSSteven Rostedt 	tstruct;							\
128e45f2e2bSTom Zanussi 									\
129e45f2e2bSTom Zanussi 	return ret;							\
130e45f2e2bSTom Zanussi }
131e45f2e2bSTom Zanussi 
1324e5292eaSSteven Rostedt #include "trace_entries.h"
1334e5292eaSSteven Rostedt 
134509e760cSLai Jiangshan #undef __entry
135509e760cSLai Jiangshan #define __entry REC
136509e760cSLai Jiangshan 
1374e5292eaSSteven Rostedt #undef __field
1384e5292eaSSteven Rostedt #define __field(type, item)
1394e5292eaSSteven Rostedt 
1404e5292eaSSteven Rostedt #undef __field_desc
1414e5292eaSSteven Rostedt #define __field_desc(type, container, item)
1424e5292eaSSteven Rostedt 
1434e5292eaSSteven Rostedt #undef __array
1444e5292eaSSteven Rostedt #define __array(type, item, len)
1454e5292eaSSteven Rostedt 
1464e5292eaSSteven Rostedt #undef __array_desc
1474e5292eaSSteven Rostedt #define __array_desc(type, container, item, len)
1484e5292eaSSteven Rostedt 
1494e5292eaSSteven Rostedt #undef __dynamic_array
1504e5292eaSSteven Rostedt #define __dynamic_array(type, item)
1514e5292eaSSteven Rostedt 
152509e760cSLai Jiangshan #undef F_printk
15301de982aSWolfgang Mauerer #define F_printk(fmt, args...) __stringify(fmt) ", "  __stringify(args)
154509e760cSLai Jiangshan 
1554e5292eaSSteven Rostedt #undef FTRACE_ENTRY
15632c0edaeSSteven Rostedt #define FTRACE_ENTRY(call, struct_name, etype, tstruct, print)		\
157770cb243SSteven Rostedt 									\
1582e33af02SSteven Rostedt struct ftrace_event_class event_class_ftrace_##call = {			\
1592e33af02SSteven Rostedt 	.system			= __stringify(TRACE_SYSTEM),		\
1602e33af02SSteven Rostedt 	.define_fields		= ftrace_define_fields_##call,		\
161ffb9f995SLi Zefan 	.fields			= LIST_HEAD_INIT(event_class_ftrace_##call.fields),\
1622e33af02SSteven Rostedt };									\
1632e33af02SSteven Rostedt 									\
164e4a9ea5eSSteven Rostedt struct ftrace_event_call __used event_##call = {			\
165770cb243SSteven Rostedt 	.name			= #call,				\
16632c0edaeSSteven Rostedt 	.event.type		= etype,				\
1672e33af02SSteven Rostedt 	.class			= &event_class_ftrace_##call,		\
168509e760cSLai Jiangshan 	.print_fmt		= print,				\
169e1112b4dSTom Zanussi };									\
170e4a9ea5eSSteven Rostedt struct ftrace_event_call __used						\
171e4a9ea5eSSteven Rostedt __attribute__((section("_ftrace_events"))) *__event_##call = &event_##call;
172e1112b4dSTom Zanussi 
1734e5292eaSSteven Rostedt #include "trace_entries.h"
174