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

Commit 50354a8a authored by Li Zefan's avatar Li Zefan Committed by Steven Rostedt
Browse files

tracing: Update comments 



Make some comments consistent with the code.

Signed-off-by: default avatarLi Zefan <lizf@cn.fujitsu.com>
LKML-Reference: <4BA97FD0.7090202@cn.fujitsu.com>
Signed-off-by: default avatarSteven Rostedt <rostedt@goodmis.org>
parent 4bdde044

include/trace/ftrace.h

+19 −14
Original line number Diff line number Diff line
@@ -154,8 +154,10 @@ 
 *

 *	field = (typeof(field))entry;

 *

 *	p = get_cpu_var(ftrace_event_seq);

 *	p = &get_cpu_var(ftrace_event_seq);

 *	trace_seq_init(p);

 *	ret = trace_seq_printf(s, "%s: ", <call>);

 *	if (ret)

 *		ret = trace_seq_printf(s, <TP_printk> "\n");

 *	put_cpu();

 *	if (!ret)
@@ -450,38 +452,38 @@ perf_trace_disable_##name(struct ftrace_event_call *unused) \ 
 *

 * static void ftrace_raw_event_<call>(proto)

 * {

 *	struct ftrace_data_offsets_<call> __maybe_unused __data_offsets;

 *	struct ring_buffer_event *event;

 *	struct ftrace_raw_<call> *entry; <-- defined in stage 1

 *	struct ring_buffer *buffer;

 *	unsigned long irq_flags;

 *	int __data_size;

 *	int pc;

 *

 *	local_save_flags(irq_flags);

 *	pc = preempt_count();

 *

 *	__data_size = ftrace_get_offsets_<call>(&__data_offsets, args);

 *

 *	event = trace_current_buffer_lock_reserve(&buffer,

 *				  event_<call>.id,

 *				  sizeof(struct ftrace_raw_<call>),

 *				  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

 *	{ <assign>; }  <-- Here we assign the entries by the __field and

 *			   __array macros.

 *

 *	trace_current_buffer_unlock_commit(buffer, event, irq_flags, pc);

 *	if (!filter_current_check_discard(buffer, event_call, entry, event))

 *		trace_current_buffer_unlock_commit(buffer,

 *						   event, irq_flags, pc);

 * }

 *

 * static int ftrace_raw_reg_event_<call>(struct ftrace_event_call *unused)

 * {

 *	int ret;

 *

 *	ret = register_trace_<call>(ftrace_raw_event_<call>);

 *	if (!ret)

 *		pr_info("event trace: Could not activate trace point "

 *			"probe to <call>");

 *	return ret;

 *	return register_trace_<call>(ftrace_raw_event_<call>);

 * }

 *

 * static void ftrace_unreg_event_<call>(struct ftrace_event_call *unused)
@@ -493,6 +495,8 @@ perf_trace_disable_##name(struct ftrace_event_call *unused) \ 
 *	.trace			= ftrace_raw_output_<call>, <-- stage 2

 * };

 *

 * static const char print_fmt_<call>[] = <TP_printk>;

 *

 * static struct ftrace_event_call __used

 * __attribute__((__aligned__(4)))

 * __attribute__((section("_ftrace_events"))) event_<call> = {
@@ -501,6 +505,8 @@ perf_trace_disable_##name(struct ftrace_event_call *unused) \ 
 *	.raw_init		= trace_event_raw_init,

 *	.regfunc		= ftrace_reg_event_<call>,

 *	.unregfunc		= ftrace_unreg_event_<call>,

 *	.print_fmt		= print_fmt_<call>,

 *	.define_fields		= ftrace_define_fields_<call>,

 * }

 *

 */
@@ -569,7 +575,6 @@ ftrace_raw_event_id_##call(struct ftrace_event_call *event_call, \ 
		return;							\

	entry	= ring_buffer_event_data(event);			\

									\

									\

	tstruct								\

									\

	{ assign; }							\