Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 2f2c99db authored by Steven Rostedt's avatar Steven Rostedt Committed by Ingo Molnar
Browse files

ftrace: ftrace_printk doc moved 



Based on Randy Dunlap's suggestion, the ftrace_printk kernel-doc belongs
with the ftrace_printk macro that should be used. Not with the
__ftrace_printk internal function.

Signed-off-by: default avatarSteven Rostedt <srostedt@redhat.com>
Acked-by: default avatarRandy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: default avatarIngo Molnar <mingo@elte.hu>
parent dd0e545f

include/linux/ftrace.h

+18 −1
Original line number Diff line number Diff line
@@ -157,7 +157,24 @@ static inline void __ftrace_enabled_restore(int enabled) 
#ifdef CONFIG_TRACING

extern void

ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3);

# define ftrace_printk(x...) __ftrace_printk(_THIS_IP_, x)



/**

 * ftrace_printk - printf formatting in the ftrace buffer

 * @fmt: the printf format for printing

 *

 * Note: __ftrace_printk is an internal function for ftrace_printk and

 *       the @ip is passed in via the ftrace_printk macro.

 *

 * This function allows a kernel developer to debug fast path sections

 * that printk is not appropriate for. By scattering in various

 * printk like tracing in the code, a developer can quickly see

 * where problems are occurring.

 *

 * This is intended as a debugging tool for the developer only.

 * Please refrain from leaving ftrace_printks scattered around in

 * your code.

 */

# define ftrace_printk(fmt...) __ftrace_printk(_THIS_IP_, fmt)

extern int

__ftrace_printk(unsigned long ip, const char *fmt, ...)

	__attribute__ ((format (printf, 2, 3)));

kernel/trace/trace.c

+0 −16
Original line number Diff line number Diff line
@@ -3075,22 +3075,6 @@ static __init void tracer_init_debugfs(void) 
	(sizeof(struct trace_field) - offsetof(struct trace_field, print.buf))

#define TRACE_CONT_BUF_SIZE sizeof(struct trace_field)



/**

 * ftrace_printk - printf formatting in the ftrace buffer

 * @fmt - the printf format for printing.

 *

 * Note: __ftrace_printk is an internal function for ftrace_printk and

 *       the @ip is passed in via the ftrace_printk macro.

 *

 * This function allows a kernel developer to debug fast path sections

 * that printk is not appropriate for. By scattering in various

 * printk like tracing in the code, a developer can quickly see

 * where problems are occurring.

 *

 * This is intended as a debugging tool for the developer only.

 * Please reframe from leaving ftrace_printks scattered around in

 * your code.

 */

int __ftrace_printk(unsigned long ip, const char *fmt, ...)

{

	struct trace_array *tr = &global_trace;