Skip to contentSkip to conversation

trace: Introduce objtrace trigger to trace the kernel object

PATCH Superseded Jeff Xie 3 participants 10 messages Jun 2, 2022 – Jun 4, 2022

Subsystems (3)

v11 of 15 Superseded Latest is v15 →

lore
Share & tools
lore

Jeff Xie

author
#0 lore raw

v11 cover trace: Introduce objtrace trigger to trace the kernel object

Introduce a method based on function tracer to trace any object and get the value of the object dynamically. the object can be obtained from the dynamic event (kprobe_event/uprobe_event) or the static event(tracepoint).

Usage:
When using the kprobe event, only need to set the objtrace(a new trigger), we can get the value of the object. The object is from the setting of the kprobe event.

For example:
For the function bio_add_page():

int bio_add_page(struct bio *bio, struct page *page,
unsigned int len, unsigned int offset)

Firstly, we can set the base of the object, thus the first string "arg1" stands for the value of the first parameter of this function bio_add_gage(),

# echo 'p bio_add_page arg1=$arg1' > ./kprobe_events

Secondly, we can get the value dynamically based on above object.

find the offset of the bi_size in struct bio:

$ gdb vmlinux
(gdb) p &(((struct bio *)0)->bi_iter.bi_size)
$1 = (unsigned int *) 0x28
# echo 'objtrace:add:arg1,0x28:u32:1 if comm == "cat"' > ./events/kprobes/ \
	p_bio_add_page_0/trigger
# cd /sys/kernel/debug/tracing/
# echo 'p bio_add_page arg1=$arg1' > ./kprobe_events
# echo 'objtrace:add:arg1,0x28:u32:1 if comm == "cat"' > ./events/kprobes/p_bio_add_page_0/trigger
# du -sh /test.txt
12.0K   /test.txt
# cat  /test.txt > /dev/null
# cat ./trace
# tracer: nop
#
# entries-in-buffer/entries-written: 128/128   #P:4
#
#                                _-----=> irqs-off/BH-disabled
#                               / _----=> need-resched
#                              | / _---=> hardirq/softirq
#                              || / _--=> preempt-depth
#                              ||| / _-=> migrate-disable
#                              |||| /     delay
#           TASK-PID     CPU#  |||||  TIMESTAMP  FUNCTION
#              | |         |   |||||     |         |
             cat-117     [002] ...1.     1.602243: __bio_try_merge_page <-bio_add_page object:0xffff88811bee4000 value:0x0
             cat-117     [002] ...1.     1.602244: __bio_add_page <-bio_add_page object:0xffff88811bee4000 value:0x0
             cat-117     [002] ...2.     1.602244: bio_add_page <-ext4_mpage_readpages object:0xffff88811bee4000 value:0x1000
             cat-117     [002] ...1.     1.602245: __bio_try_merge_page <-bio_add_page object:0xffff88811bee4000 value:0x1000
             cat-117     [002] ...1.     1.602245: __bio_add_page <-bio_add_page object:0xffff88811bee4000 value:0x1000
             cat-117     [002] ...2.     1.602245: bio_add_page <-ext4_mpage_readpages object:0xffff88811bee4000 value:0x2000
             cat-117     [002] ...1.     1.602245: __bio_try_merge_page <-bio_add_page object:0xffff88811bee4000 value:0x2000
             cat-117     [002] ...1.     1.602245: __bio_add_page <-bio_add_page object:0xffff88811bee4000 value:0x2000
             cat-117     [002] ...1.     1.602245: submit_bio <-ext4_mpage_readpages object:0xffff88811bee4000 value:0x3000
             cat-117     [002] ...1.     1.602245: submit_bio_noacct <-ext4_mpage_readpages object:0xffff88811bee4000 value:0x3000
             cat-117     [002] ...1.     1.602246: __submit_bio <-submit_bio_noacct object:0xffff88811bee4000 value:0x3000
             cat-117     [002] ...1.     1.602246: submit_bio_checks <-__submit_bio object:0xffff88811bee4000 value:0x3000
             cat-117     [002] ...1.     1.602246: __cond_resched <-submit_bio_checks object:0xffff88811bee4000 value:0x3000
             cat-117     [002] ...1.     1.602246: should_fail_bio <-submit_bio_checks object:0xffff88811bee4000 value:0x3000
             cat-117     [002] ...1.     1.602246: blk_mq_submit_bio <-submit_bio_noacct object:0xffff88811bee4000 value:0x3000
             cat-117     [002] ...1.     1.602246: blk_attempt_plug_merge <-blk_mq_submit_bio object:0xffff88811bee4000 value:0x3000
             cat-117     [002] ...1.     1.602246: blk_mq_sched_bio_merge <-blk_mq_submit_bio object:0xffff88811bee4000 value:0x3000
             cat-117     [002] ...1.     1.602247: __rcu_read_lock <-blk_mq_submit_bio object:0xffff88811bee4000 value:0x3000
             cat-117     [002] ...1.     1.602247: __rcu_read_unlock <-blk_mq_submit_bio object:0xffff88811bee4000 value:0x3000
             cat-117     [002] ...1.     1.602247: __blk_mq_alloc_requests <-blk_mq_submit_bio object:0xffff88811bee4000 value:0x3000
          <idle>-0       [002] d..3.     1.602298: bio_endio <-blk_update_request object:0xffff88811bee4000 value:0x0
          <idle>-0       [002] d..3.     1.602298: mpage_end_io <-blk_update_request object:0xffff88811bee4000 value:0x0
          <idle>-0       [002] d..3.     1.602298: __read_end_io <-blk_update_request object:0xffff88811bee4000 value:0x0
          <idle>-0       [002] d..3.     1.602300: bio_put <-blk_update_request object:0xffff88811bee4000 value:0x0
          <idle>-0       [002] d..3.     1.602300: bio_free <-blk_update_request object:0xffff88811bee4000 value:0x0
          <idle>-0       [002] d..3.     1.602300: mempool_free <-blk_update_request object:0xffff88811bee4000 value:0x0
          <idle>-0       [002] d..3.     1.602300: mempool_free_slab <-blk_update_request object:0xffff88811bee4000 value:0x0
          <idle>-0       [002] d..3.     1.602300: kmem_cache_free <-blk_update_request object:0xffff88811bee4000 value:0x0
	  ...

Almost all changelogs were suggested by Masami([email protected]) and steve([email protected]), thank you all so much.

v11:
- remove useless atomic counting methods for num_traced_obj
- make array objtrace_fetch_types null terminated
- add raw_spin_lock_init for obj_data_lock

v10:
- support ftrace instances
- use trace_buffer_lock_reserve instead of trace_event_buffer_lock_reserve
- a lot of cleanup work has been done mainly for event_object_trigger_parse

v9:
- fix objtrace trigger output was incomplete
- fix the objtrace trigger was removed when using the existed parameter on event.
- add testcase for the second fix above.

v8:
- revert to use per-cpu recursion for the function trace_object_events_call
- recover the filter when getting the value of the object
- simplify the implementation for the function get_object_value
- fix the build error

v7:
- use fixed-size array for object pool instead of list structure
- use ftrace_test_recursion_trylock for function trace hook function
- fix trace_object_ref reference count in the init_trace_object
- invoke exit_trace_object no matter whether data->ops->free is null in the unregister_object_trigger
- release private_data of event_trigger_data in the trace_object_trigger_free
- remove [RFC] tag

v6:
- change the objtrace trigger syntax.
- add patchset description
- add <tracefs>/README

v5:
- add testcasts
- add check the field->size
- add lockless to search object
- describe the object trace more clearly in Kconfig

v4:
- please ignore the v4 which is the same as v3

v3:
- change the objfilter to objtrace
- add a command to the objfilter syntax
- change to get the value of the object
- use trace_find_event_field to find the field instead of using argN
- get data from @rec in the event trigger callback funciton

v2:
- adding a "objfilter" trigger to update object

Jeff Xie (4):
trace: Add trace any kernel object
trace/objtrace: Get the value of the object
trace/objtrace: Add testcases for objtrace
trace/objtrace: Add documentation for objtrace

 Documentation/trace/events.rst                |  83 +++
 include/linux/trace_events.h                  |   1 +
 kernel/trace/Kconfig                          |  10 +
 kernel/trace/Makefile                         |   1 +
 kernel/trace/trace.c                          |  11 +
 kernel/trace/trace.h                          |  21 +
 kernel/trace/trace_entries.h                  |  18 +
 kernel/trace/trace_events_trigger.c           |   5 +-
 kernel/trace/trace_object.c                   | 615 ++++++++++++++++++
 kernel/trace/trace_output.c                   |  40 ++
 .../ftrace/test.d/trigger/trigger-objtrace.tc |  41 ++
 11 files changed, 844 insertions(+), 2 deletions(-)
 create mode 100644 kernel/trace/trace_object.c
 create mode 100644 tools/testing/selftests/ftrace/test.d/trigger/trigger-objtrace.tc

base-commit: b39181f7c6907dc66ff937b74758671fa6ba430c

Signature · 1 line
2.25.1
author
#1 lore raw

PATCH v11 1/4 trace: Add trace any kernel object

Introduce objtrace trigger to get the call flow by tracing any kernel object in the function parameter.

The objtrace trigger makes a list of the target object address from the given event parameter, and records all kernel function calls which has the object address in its parameter.

Syntax:
objtrace:add:obj[:count][if <filter>]

Usage:

	# echo 'p bio_add_page arg1=$arg1' > kprobe_events
	# cd events/kprobes/p_bio_add_page_0
	# echo 'objtrace:add:arg1:1 if comm == "cat"' > ./trigger
	# cat /test.txt
---
 include/linux/trace_events.h        |   1 +
 kernel/trace/Kconfig                |  10 +
 kernel/trace/Makefile               |   1 +
 kernel/trace/trace.c                |  11 +
 kernel/trace/trace.h                |  21 ++
 kernel/trace/trace_entries.h        |  17 ++
 kernel/trace/trace_events_trigger.c |   5 +-
 kernel/trace/trace_object.c         | 450 ++++++++++++++++++++++++++++
 kernel/trace/trace_output.c         |  40 +++
 9 files changed, 554 insertions(+), 2 deletions(-)
 create mode 100644 kernel/trace/trace_object.c
include/linux/trace_events.h +1 -0
index e6e95a9f07a5..f3645166b724 100644
@@ -693,6 +693,7 @@ enum event_trigger_type {
 	ETT_EVENT_HIST		= (1 << 4),
 	ETT_HIST_ENABLE		= (1 << 5),
 	ETT_EVENT_EPROBE	= (1 << 6),
+	ETT_TRACE_OBJECT	= (1 << 7),
 };
 
 extern int filter_match_preds(struct event_filter *filter, void *rec);
kernel/trace/Kconfig +10 -0
index 2c43e327a619..30c34d43dc3f 100644
@@ -276,6 +276,16 @@ config FUNCTION_PROFILER
 
 	  If in doubt, say N.
 
+config TRACE_OBJECT
+	bool "Trace kernel object in function parameter"
+	depends on FUNCTION_TRACER
+	depends on HAVE_FUNCTION_ARG_ACCESS_API
+	select TRACING
+	default y
+	help
+	 You can trace the kernel object in the kernel function parameter.
+	 The kernel object is dynamically specified via event trigger.
+
 config STACK_TRACER
 	bool "Trace max stack"
 	depends on HAVE_FUNCTION_TRACER
kernel/trace/Makefile +1 -0
index 0d261774d6f3..90ecc3c6c9d5 100644
@@ -71,6 +71,7 @@ obj-$(CONFIG_FUNCTION_GRAPH_TRACER) += trace_functions_graph.o
 obj-$(CONFIG_TRACE_BRANCH_PROFILING) += trace_branch.o
 obj-$(CONFIG_BLK_DEV_IO_TRACE) += blktrace.o
 obj-$(CONFIG_FUNCTION_GRAPH_TRACER) += fgraph.o
+obj-$(CONFIG_TRACE_OBJECT) += trace_object.o
 ifeq ($(CONFIG_BLOCK),y)
 obj-$(CONFIG_EVENT_TRACING) += blktrace.o
 endif
kernel/trace/trace.c +11 -0
index f400800bc910..7074ad8bc1a0 100644
@@ -5627,6 +5627,9 @@ static const char readme_msg[] =
 	"\t            enable_hist:<system>:<event>\n"
 	"\t            disable_hist:<system>:<event>\n"
 #endif
+#ifdef CONFIG_TRACE_OBJECT
+	"\t            objtrace:add:obj[:count][if <filter>]\n"
+#endif
 #ifdef CONFIG_STACKTRACE
 	"\t\t    stacktrace\n"
 #endif
@@ -9272,6 +9275,9 @@ static struct trace_array *trace_array_create(const char *name)
 	if (ftrace_allocate_ftrace_ops(tr) < 0)
 		goto out_free_tr;
 
+	if (allocate_objtrace_data(tr) < 0)
+		goto out_free_tr;
+
 	ftrace_init_trace_array(tr);
 
 	init_trace_flags_index(tr);
@@ -9291,6 +9297,7 @@ static struct trace_array *trace_array_create(const char *name)
 
  out_free_tr:
 	ftrace_free_ftrace_ops(tr);
+	free_objtrace_data(tr);
 	free_trace_buffers(tr);
 	free_cpumask_var(tr->tracing_cpumask);
 	kfree(tr->name);
@@ -9384,6 +9391,7 @@ static int __remove_instance(struct trace_array *tr)
 	event_trace_del_tracer(tr);
 	ftrace_clear_pids(tr);
 	ftrace_destroy_function_files(tr);
+	free_objtrace_data(tr);
 	tracefs_remove(tr->dir);
 	free_percpu(tr->last_func_repeats);
 	free_trace_buffers(tr);
@@ -10118,6 +10126,9 @@ __init static int tracer_alloc_buffers(void)
 		goto out_free_savedcmd;
 	}
 
+	if (allocate_objtrace_data(&global_trace))
+		goto out_free_savedcmd;
+
 	if (global_trace.buffer_disabled)
 		tracing_off();
 
kernel/trace/trace.h +21 -0
index ff816fb41e48..18220b659555 100644
@@ -54,6 +54,7 @@ enum trace_type {
 	TRACE_TIMERLAT,
 	TRACE_RAW_DATA,
 	TRACE_FUNC_REPEATS,
+	TRACE_OBJECT,
 
 	__TRACE_LAST_TYPE,
 };
@@ -363,6 +364,9 @@ struct trace_array {
 	cpumask_var_t		tracing_cpumask; /* only trace on set CPUs */
 	int			ref;
 	int			trace_ref;
+#ifdef CONFIG_TRACE_OBJECT
+	struct objtrace_data	*obj_data;
+#endif
 #ifdef CONFIG_FUNCTION_TRACER
 	struct ftrace_ops	*ops;
 	struct trace_pid_list	__rcu *function_pids;
@@ -471,6 +475,7 @@ extern void __ftrace_bad_type(void);
 			  TRACE_GRAPH_RET);		\
 		IF_ASSIGN(var, ent, struct func_repeats_entry,		\
 			  TRACE_FUNC_REPEATS);				\
+		IF_ASSIGN(var, ent, struct trace_object_entry, TRACE_OBJECT);\
 		__ftrace_bad_type();					\
 	} while (0)
 
@@ -1536,6 +1541,16 @@ static inline int register_trigger_hist_cmd(void) { return 0; }
 static inline int register_trigger_hist_enable_disable_cmds(void) { return 0; }
 #endif
 
+#ifdef CONFIG_TRACE_OBJECT
+extern int register_trigger_object_cmd(void);
+extern int allocate_objtrace_data(struct trace_array *tr);
+extern void free_objtrace_data(struct trace_array *tr);
+#else
+static inline int register_trigger_object_cmd(void) { return 0; }
+static inline int allocate_objtrace_data(struct trace_array *tr) { return 0; }
+static inline void free_objtrace_data(struct trace_array *tr) { };
+#endif
+
 extern int register_trigger_cmds(void);
 extern void clear_event_triggers(struct trace_array *tr);
 
@@ -1611,6 +1626,12 @@ extern bool event_trigger_check_remove(const char *glob);
 extern bool event_trigger_empty_param(const char *param);
 extern int event_trigger_separate_filter(char *param_and_filter, char **param,
 					 char **filter, bool param_required);
+extern int register_trigger(char *glob,
+			struct event_trigger_data *data,
+			struct trace_event_file *file);
+extern void unregister_trigger(char *glob,
+			struct event_trigger_data *test,
+			struct trace_event_file *file);
 extern struct event_trigger_data *
 event_trigger_alloc(struct event_command *cmd_ops,
 		    char *cmd,
kernel/trace/trace_entries.h +17 -0
index cd41e863b51c..bb120d9498a9 100644
@@ -401,3 +401,20 @@ FTRACE_ENTRY(timerlat, timerlat_entry,
 		 __entry->context,
 		 __entry->timer_latency)
 );
+
+/*
+ * trace object entry:
+ */
+FTRACE_ENTRY(object, trace_object_entry,
+
+	TRACE_OBJECT,
+
+	F_STRUCT(
+		__field(	unsigned long,		ip		)
+		__field(	unsigned long,		parent_ip	)
+		__field(	unsigned long,		object		)
+	),
+
+	F_printk(" %ps <-- %ps object:%lx\n",
+		 (void *)__entry->ip, (void *)__entry->parent_ip, __entry->object)
+);
kernel/trace/trace_events_trigger.c +3 -2
index cb866c3141af..8bad4eb3b997 100644
@@ -560,7 +560,7 @@ void update_cond_flag(struct trace_event_file *file)
  *
  * Return: 0 on success, errno otherwise
  */
-static int register_trigger(char *glob,
+int register_trigger(char *glob,
 			    struct event_trigger_data *data,
 			    struct trace_event_file *file)
 {
@@ -605,7 +605,7 @@ static int register_trigger(char *glob,
  * Usually used directly as the @unreg method in event command
  * implementations.
  */
-static void unregister_trigger(char *glob,
+void unregister_trigger(char *glob,
 			       struct event_trigger_data *test,
 			       struct trace_event_file *file)
 {
@@ -1976,6 +1976,7 @@ __init int register_trigger_cmds(void)
 	register_trigger_enable_disable_cmds();
 	register_trigger_hist_enable_disable_cmds();
 	register_trigger_hist_cmd();
+	register_trigger_object_cmd();
 
 	return 0;
 }
kernel/trace/trace_object.c new file +450 -0

450 lines not on this page · raw message

kernel/trace/trace_output.c +40 -0
index 67f47ea27921..34ff7b4dc521 100644
@@ -1551,6 +1551,45 @@ static struct trace_event trace_func_repeats_event = {
 	.funcs		= &trace_func_repeats_funcs,
 };
 
+/* TRACE_OBJECT */
+static enum print_line_t trace_object_print(struct trace_iterator *iter, int flags,
+					struct trace_event *event)
+{
+	struct trace_object_entry *field;
+	struct trace_seq *s = &iter->seq;
+
+	trace_assign_type(field, iter->ent);
+	print_fn_trace(s, field->ip, field->parent_ip, flags);
+	trace_seq_printf(s, " object:0x%lx", field->object);
+	trace_seq_putc(s, '\n');
+
+	return trace_handle_return(s);
+}
+
+static enum print_line_t trace_object_raw(struct trace_iterator *iter, int flags,
+				      struct trace_event *event)
+{
+	struct trace_object_entry *field;
+
+	trace_assign_type(field, iter->ent);
+
+	trace_seq_printf(&iter->seq, "%lx %lx\n",
+			 field->ip,
+			 field->parent_ip);
+
+	return trace_handle_return(&iter->seq);
+}
+
+static struct trace_event_functions trace_object_funcs = {
+	.trace		= trace_object_print,
+	.raw		= trace_object_raw,
+};
+
+static struct trace_event trace_object_event = {
+	.type		= TRACE_OBJECT,
+	.funcs		= &trace_object_funcs,
+};
+
 static struct trace_event *events[] __initdata = {
 	&trace_fn_event,
 	&trace_ctx_event,
@@ -1565,6 +1604,7 @@ static struct trace_event *events[] __initdata = {
 	&trace_timerlat_event,
 	&trace_raw_data_event,
 	&trace_func_repeats_event,
+	&trace_object_event,
 	NULL
 };
 
Signature · 1 line
2.25.1
#2 lore raw

Re: [PATCH v11 1/4] trace: Add trace any kernel object

Thank you for the patch! Perhaps something to improve:

Hi Jeff,

Thank you for the patch! Perhaps something to improve:

[auto build test WARNING on b39181f7c6907dc66ff937b74758671fa6ba430c]

url:    https://github.com/intel-lab-lkp/linux/commits/Jeff-Xie/trace-Introduce-objtrace-trigger-to-trace-the-kernel-object/20220603-004723
base:   b39181f7c6907dc66ff937b74758671fa6ba430c
config: i386-randconfig-a013 (https://download.01.org/0day-ci/archive/20220603/[email protected]/config)
compiler: clang version 15.0.0 (https://github.com/llvm/llvm-project b364c76683f8ef241025a9556300778c07b590c2)

reproduce (this is a W=1 build):
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross
chmod +x ~/bin/make.cross
# https://github.com/intel-lab-lkp/linux/commit/765253f020469f94856aedc5a3fe5444e1e8f4e8
git remote add linux-review https://github.com/intel-lab-lkp/linux
git fetch --no-tags linux-review Jeff-Xie/trace-Introduce-objtrace-trigger-to-trace-the-kernel-object/20220603-004723 git checkout 765253f020469f94856aedc5a3fe5444e1e8f4e8
# save the config file
mkdir build_dir && cp config build_dir/.config
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=clang make.cross W=1 O=build_dir ARCH=i386 SHELL=/bin/bash drivers/gpu/drm/qxl/ kernel/trace/

If you fix the issue, kindly add following tag where applicable

All warnings (new ones prefixed by >>):

>> kernel/trace/trace_object.c:336:61: warning: format specifies type 'long' but the argument has type 'unsigned int' [-Wformat]
                   pr_err("the size of the %s should be:%ld\n", field->name, sizeof(void *));
                                                        ~~~                  ^~~~~~~~~~~~~~
                                                        %u
   include/linux/printk.h:489:33: note: expanded from macro 'pr_err'
           printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
                                  ~~~     ^~~~~~~~~~~
   include/linux/printk.h:446:60: note: expanded from macro 'printk'
   #define printk(fmt, ...) printk_index_wrap(_printk, fmt, ##__VA_ARGS__)
                                                       ~~~    ^~~~~~~~~~~
   include/linux/printk.h:418:19: note: expanded from macro 'printk_index_wrap'
                   _p_func(_fmt, ##__VA_ARGS__);                           \
                           ~~~~    ^~~~~~~~~~~

1 warning generated.

vim +336 kernel/trace/trace_object.c

297
298 static int
299 event_object_trigger_parse(struct event_command *cmd_ops,
300 struct trace_event_file *file,
301 char *glob, char *cmd, char *param_and_filter)
302 {
303 struct event_trigger_data *trigger_data;
304 struct objtrace_trigger_data *obj_data;
305 struct ftrace_event_field *field;
306 char *objtrace_cmd, *arg;
307 char *param, *filter;
308 int ret;
309 bool remove;
310
311 remove = event_trigger_check_remove(glob);
312
313 /*
314 * separate the param and the filter:
315 * objtrace:add:OBJ[:COUNT] [if filter]
316 */
317 ret = event_trigger_separate_filter(param_and_filter, &param, &filter, true);
318 if (ret)
319 return ret;
320
321 objtrace_cmd = strsep(&param, ":");
322 if (!objtrace_cmd || strcmp(objtrace_cmd, OBJTRACE_CMD_ADD)) {
323 pr_err("error objtrace command\n");
324 return -EINVAL;
325 }
326
327 arg = strsep(&param, ":");
328 if (!arg)
329 return -EINVAL;
330
331 field = trace_find_event_field(file->event_call, arg);
332 if (!field)
333 return -EINVAL;
334
335 if (field->size != sizeof(void *)) {

 > 336			pr_err("the size of the %s should be:%ld\n", field->name, sizeof(void *));

337 return -EINVAL;
338 }
339
340 if (remove && !field_exist(file, cmd_ops, field->name))
341 return -ENOENT;
342
343 obj_data = kzalloc(sizeof(*obj_data), GFP_KERNEL);
344 if (!obj_data)
345 return -ENOMEM;
346
347 obj_data->field = field;
348 obj_data->tr = file->tr;
349 snprintf(obj_data->objtrace_cmd, OBJTRACE_CMD_LEN, objtrace_cmd);
350
351 trigger_data = event_trigger_alloc(cmd_ops, cmd, param, obj_data);
352 if (!trigger_data) {
353 kfree(obj_data);
354 return -ENOMEM;
355 }
356 if (remove) {
357 event_trigger_unregister(cmd_ops, file, glob+1, trigger_data);
358 kfree(obj_data);
359 kfree(trigger_data);
360 return 0;
361 }
362
363 ret = event_trigger_parse_num(param, trigger_data);
364 if (ret)
365 goto out_free;
366
367 ret = event_trigger_set_filter(cmd_ops, file, filter, trigger_data);
368 if (ret < 0)
369 goto out_free;
370
371 ret = event_trigger_register(cmd_ops, file, glob, trigger_data);
372 if (ret)
373 goto out_free;
374
375 return ret;
376
377 out_free:
378 event_trigger_reset_filter(cmd_ops, trigger_data);
379 kfree(obj_data);
380 kfree(trigger_data);
381 return ret;
382 }
383

Signature · 2 lines
0-DAY CI Kernel Test Service
https://01.org/lkp
author
#3 lore raw

Re: [PATCH v11 1/4] trace: Add trace any kernel object

Hi lkp,

Quoted 23 lines · kernel test robot

Hi Jeff,

Thank you for the patch! Perhaps something to improve:

[auto build test WARNING on b39181f7c6907dc66ff937b74758671fa6ba430c]

url:    https://github.com/intel-lab-lkp/linux/commits/Jeff-Xie/trace-Introduce-objtrace-trigger-to-trace-the-kernel-object/20220603-004723
base:   b39181f7c6907dc66ff937b74758671fa6ba430c
config: i386-randconfig-a013 (https://download.01.org/0day-ci/archive/20220603/202206030515.4lqqkb3W-lkp(a)intel.com/config)
compiler: clang version 15.0.0 (https://github.com/llvm/llvm-project b364c76683f8ef241025a9556300778c07b590c2)

reproduce (this is a W=1 build):
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross
chmod +x ~/bin/make.cross
# https://github.com/intel-lab-lkp/linux/commit/765253f020469f94856aedc5a3fe5444e1e8f4e8
git remote add linux-review https://github.com/intel-lab-lkp/linux
git fetch --no-tags linux-review Jeff-Xie/trace-Introduce-objtrace-trigger-to-trace-the-kernel-object/20220603-004723 git checkout 765253f020469f94856aedc5a3fe5444e1e8f4e8
# save the config file
mkdir build_dir && cp config build_dir/.config
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=clang make.cross W=1 O=build_dir ARCH=i386 SHELL=/bin/bash drivers/gpu/drm/qxl/ kernel/trace/

If you fix the issue, kindly add following tag where applicable

Quoted 8 lines

All warnings (new ones prefixed by >>):

Quoted 1 line
Quoted 1 line

kernel/trace/trace_object.c:336:61: warning: format specifies type 'long' but the argument has type 'unsigned int' [-Wformat]

                   pr_err("the size of the %s should be:%ld\n", field->name, sizeof(void *));
                                                        ~~~                  ^~~~~~~~~~~~~~
                                                        %u

I will double check it ,the sizeof(void *) on x86_64 is type ‘long unsigned int’.

Quoted 102 lines
   include/linux/printk.h:489:33: note: expanded from macro 'pr_err'
           printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
                                  ~~~     ^~~~~~~~~~~
   include/linux/printk.h:446:60: note: expanded from macro 'printk'
   #define printk(fmt, ...) printk_index_wrap(_printk, fmt, ##__VA_ARGS__)
                                                       ~~~    ^~~~~~~~~~~
   include/linux/printk.h:418:19: note: expanded from macro 'printk_index_wrap'
                   _p_func(_fmt, ##__VA_ARGS__);                           \
                           ~~~~    ^~~~~~~~~~~
   1 warning generated.

vim +336 kernel/trace/trace_object.c

   297
   298  static int
   299  event_object_trigger_parse(struct event_command *cmd_ops,
   300                         struct trace_event_file *file,
   301                         char *glob, char *cmd, char *param_and_filter)
   302  {
   303          struct event_trigger_data *trigger_data;
   304          struct objtrace_trigger_data *obj_data;
   305          struct ftrace_event_field *field;
   306          char *objtrace_cmd, *arg;
   307          char *param, *filter;
   308          int ret;
   309          bool remove;
   310
   311          remove = event_trigger_check_remove(glob);
   312
   313          /*
   314           * separate the param and the filter:
   315           * objtrace:add:OBJ[:COUNT] [if filter]
   316           */
   317          ret = event_trigger_separate_filter(param_and_filter, &param, &filter, true);
   318          if (ret)
   319                  return ret;
   320
   321          objtrace_cmd = strsep(&param, ":");
   322          if (!objtrace_cmd || strcmp(objtrace_cmd, OBJTRACE_CMD_ADD)) {
   323                  pr_err("error objtrace command\n");
   324                  return -EINVAL;
   325          }
   326
   327          arg = strsep(&param, ":");
   328          if (!arg)
   329                  return -EINVAL;
   330
   331          field = trace_find_event_field(file->event_call, arg);
   332          if (!field)
   333                  return -EINVAL;
   334
   335          if (field->size != sizeof(void *)) {
Quoted 1 line

336 pr_err("the size of the %s should be:%ld\n", field->name, sizeof(void *));

   337                  return -EINVAL;
   338          }
   339
   340          if (remove && !field_exist(file, cmd_ops, field->name))
   341                  return -ENOENT;
   342
   343          obj_data = kzalloc(sizeof(*obj_data), GFP_KERNEL);
   344          if (!obj_data)
   345                  return -ENOMEM;
   346
   347          obj_data->field = field;
   348          obj_data->tr = file->tr;
   349          snprintf(obj_data->objtrace_cmd, OBJTRACE_CMD_LEN, objtrace_cmd);
   350
   351          trigger_data = event_trigger_alloc(cmd_ops, cmd, param, obj_data);
   352          if (!trigger_data) {
   353                  kfree(obj_data);
   354                  return -ENOMEM;
   355          }
   356          if (remove) {
   357                  event_trigger_unregister(cmd_ops, file, glob+1, trigger_data);
   358                  kfree(obj_data);
   359                  kfree(trigger_data);
   360                  return 0;
   361          }
   362
   363          ret = event_trigger_parse_num(param, trigger_data);
   364          if (ret)
   365                  goto out_free;
   366
   367          ret = event_trigger_set_filter(cmd_ops, file, filter, trigger_data);
   368          if (ret < 0)
   369                  goto out_free;
   370
   371          ret = event_trigger_register(cmd_ops, file, glob, trigger_data);
   372          if (ret)
   373                  goto out_free;
   374
   375          return ret;
   376
   377   out_free:
   378          event_trigger_reset_filter(cmd_ops, trigger_data);
   379          kfree(obj_data);
   380          kfree(trigger_data);
   381          return ret;
   382  }
   383
Quoted 3 lines

--
0-DAY CI Kernel Test Service
https://01.org/lkp

Thanks,
JeffXie

#4 lore raw

Re: [PATCH v11 1/4] trace: Add trace any kernel object

Quoted 30 lines · Jeff Xie

Hi lkp,

Quoted 27 lines · kernel test robot

Hi Jeff,

Thank you for the patch! Perhaps something to improve:

[auto build test WARNING on b39181f7c6907dc66ff937b74758671fa6ba430c]

url:    https://github.com/intel-lab-lkp/linux/commits/Jeff-Xie/trace-Introduce-objtrace-trigger-to-trace-the-kernel-object/20220603-004723
base:   b39181f7c6907dc66ff937b74758671fa6ba430c
config: i386-randconfig-a013 (https://download.01.org/0day-ci/archive/20220603/202206030515.4lqqkb3W-lkp(a)intel.com/config)
compiler: clang version 15.0.0 (https://github.com/llvm/llvm-project b364c76683f8ef241025a9556300778c07b590c2)

reproduce (this is a W=1 build):
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross
chmod +x ~/bin/make.cross
# https://github.com/intel-lab-lkp/linux/commit/765253f020469f94856aedc5a3fe5444e1e8f4e8
git remote add linux-review https://github.com/intel-lab-lkp/linux
git fetch --no-tags linux-review Jeff-Xie/trace-Introduce-objtrace-trigger-to-trace-the-kernel-object/20220603-004723 git checkout 765253f020469f94856aedc5a3fe5444e1e8f4e8
# save the config file
mkdir build_dir && cp config build_dir/.config
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=clang make.cross W=1 O=build_dir ARCH=i386 SHELL=/bin/bash drivers/gpu/drm/qxl/ kernel/trace/

If you fix the issue, kindly add following tag where applicable

All warnings (new ones prefixed by >>):

Quoted 7 lines
Quoted 4 lines
Quoted 1 line
Quoted 1 line

kernel/trace/trace_object.c:336:61: warning: format specifies type 'long' but the argument has type 'unsigned int' [-Wformat]

                   pr_err("the size of the %s should be:%ld\n", field->name, sizeof(void *));
                                                        ~~~                  ^~~~~~~~~~~~~~
                                                        %u

I will double check it ,the sizeof(void *) on x86_64 is type ‘long unsigned int’.

Per Documentation/core-api/printk-formats.rst, sizeof returns size_t, which should use the %zu specifier.

Cheers,
Nathan

Quoted 109 lines
Quoted 102 lines
   include/linux/printk.h:489:33: note: expanded from macro 'pr_err'
           printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
                                  ~~~     ^~~~~~~~~~~
   include/linux/printk.h:446:60: note: expanded from macro 'printk'
   #define printk(fmt, ...) printk_index_wrap(_printk, fmt, ##__VA_ARGS__)
                                                       ~~~    ^~~~~~~~~~~
   include/linux/printk.h:418:19: note: expanded from macro 'printk_index_wrap'
                   _p_func(_fmt, ##__VA_ARGS__);                           \
                           ~~~~    ^~~~~~~~~~~
   1 warning generated.

vim +336 kernel/trace/trace_object.c

   297
   298  static int
   299  event_object_trigger_parse(struct event_command *cmd_ops,
   300                         struct trace_event_file *file,
   301                         char *glob, char *cmd, char *param_and_filter)
   302  {
   303          struct event_trigger_data *trigger_data;
   304          struct objtrace_trigger_data *obj_data;
   305          struct ftrace_event_field *field;
   306          char *objtrace_cmd, *arg;
   307          char *param, *filter;
   308          int ret;
   309          bool remove;
   310
   311          remove = event_trigger_check_remove(glob);
   312
   313          /*
   314           * separate the param and the filter:
   315           * objtrace:add:OBJ[:COUNT] [if filter]
   316           */
   317          ret = event_trigger_separate_filter(param_and_filter, &param, &filter, true);
   318          if (ret)
   319                  return ret;
   320
   321          objtrace_cmd = strsep(&param, ":");
   322          if (!objtrace_cmd || strcmp(objtrace_cmd, OBJTRACE_CMD_ADD)) {
   323                  pr_err("error objtrace command\n");
   324                  return -EINVAL;
   325          }
   326
   327          arg = strsep(&param, ":");
   328          if (!arg)
   329                  return -EINVAL;
   330
   331          field = trace_find_event_field(file->event_call, arg);
   332          if (!field)
   333                  return -EINVAL;
   334
   335          if (field->size != sizeof(void *)) {
Quoted 1 line

336 pr_err("the size of the %s should be:%ld\n", field->name, sizeof(void *));

   337                  return -EINVAL;
   338          }
   339
   340          if (remove && !field_exist(file, cmd_ops, field->name))
   341                  return -ENOENT;
   342
   343          obj_data = kzalloc(sizeof(*obj_data), GFP_KERNEL);
   344          if (!obj_data)
   345                  return -ENOMEM;
   346
   347          obj_data->field = field;
   348          obj_data->tr = file->tr;
   349          snprintf(obj_data->objtrace_cmd, OBJTRACE_CMD_LEN, objtrace_cmd);
   350
   351          trigger_data = event_trigger_alloc(cmd_ops, cmd, param, obj_data);
   352          if (!trigger_data) {
   353                  kfree(obj_data);
   354                  return -ENOMEM;
   355          }
   356          if (remove) {
   357                  event_trigger_unregister(cmd_ops, file, glob+1, trigger_data);
   358                  kfree(obj_data);
   359                  kfree(trigger_data);
   360                  return 0;
   361          }
   362
   363          ret = event_trigger_parse_num(param, trigger_data);
   364          if (ret)
   365                  goto out_free;
   366
   367          ret = event_trigger_set_filter(cmd_ops, file, filter, trigger_data);
   368          if (ret < 0)
   369                  goto out_free;
   370
   371          ret = event_trigger_register(cmd_ops, file, glob, trigger_data);
   372          if (ret)
   373                  goto out_free;
   374
   375          return ret;
   376
   377   out_free:
   378          event_trigger_reset_filter(cmd_ops, trigger_data);
   379          kfree(obj_data);
   380          kfree(trigger_data);
   381          return ret;
   382  }
   383
Quoted 3 lines

--
0-DAY CI Kernel Test Service
https://01.org/lkp

Thanks,
JeffXie

author
#5 lore raw

Re: [PATCH v11 1/4] trace: Add trace any kernel object

Hi Nathan,

Quoted 37 lines · Nathan Chancellor
Quoted 35 lines · Jeff Xie

Hi lkp,

Quoted 31 lines · kernel test robot

Hi Jeff,

Thank you for the patch! Perhaps something to improve:

[auto build test WARNING on b39181f7c6907dc66ff937b74758671fa6ba430c]

url:    https://github.com/intel-lab-lkp/linux/commits/Jeff-Xie/trace-Introduce-objtrace-trigger-to-trace-the-kernel-object/20220603-004723
base:   b39181f7c6907dc66ff937b74758671fa6ba430c
config: i386-randconfig-a013 (https://download.01.org/0day-ci/archive/20220603/202206030515.4lqqkb3W-lkp(a)intel.com/config)
compiler: clang version 15.0.0 (https://github.com/llvm/llvm-project b364c76683f8ef241025a9556300778c07b590c2)

reproduce (this is a W=1 build):
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross
chmod +x ~/bin/make.cross
# https://github.com/intel-lab-lkp/linux/commit/765253f020469f94856aedc5a3fe5444e1e8f4e8
git remote add linux-review https://github.com/intel-lab-lkp/linux
git fetch --no-tags linux-review Jeff-Xie/trace-Introduce-objtrace-trigger-to-trace-the-kernel-object/20220603-004723 git checkout 765253f020469f94856aedc5a3fe5444e1e8f4e8
# save the config file
mkdir build_dir && cp config build_dir/.config
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=clang make.cross W=1 O=build_dir ARCH=i386 SHELL=/bin/bash drivers/gpu/drm/qxl/ kernel/trace/

If you fix the issue, kindly add following tag where applicable

All warnings (new ones prefixed by >>):

Quoted 1 line
Quoted 1 line

kernel/trace/trace_object.c:336:61: warning: format specifies type 'long' but the argument has type 'unsigned int' [-Wformat]

                   pr_err("the size of the %s should be:%ld\n", field->name, sizeof(void *));
                                                        ~~~                  ^~~~~~~~~~~~~~
                                                        %u
Quoted 5 lines
Quoted 2 lines

I will double check it ,the sizeof(void *) on x86_64 is type ‘long unsigned int’.

Per Documentation/core-api/printk-formats.rst, sizeof returns size_t, which should use the %zu specifier.

This is great, Thank you for your reminder ;-)

Quoted 112 lines

Cheers,
Nathan

Quoted 109 lines
Quoted 102 lines
   include/linux/printk.h:489:33: note: expanded from macro 'pr_err'
           printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
                                  ~~~     ^~~~~~~~~~~
   include/linux/printk.h:446:60: note: expanded from macro 'printk'
   #define printk(fmt, ...) printk_index_wrap(_printk, fmt, ##__VA_ARGS__)
                                                       ~~~    ^~~~~~~~~~~
   include/linux/printk.h:418:19: note: expanded from macro 'printk_index_wrap'
                   _p_func(_fmt, ##__VA_ARGS__);                           \
                           ~~~~    ^~~~~~~~~~~
   1 warning generated.

vim +336 kernel/trace/trace_object.c

   297
   298  static int
   299  event_object_trigger_parse(struct event_command *cmd_ops,
   300                         struct trace_event_file *file,
   301                         char *glob, char *cmd, char *param_and_filter)
   302  {
   303          struct event_trigger_data *trigger_data;
   304          struct objtrace_trigger_data *obj_data;
   305          struct ftrace_event_field *field;
   306          char *objtrace_cmd, *arg;
   307          char *param, *filter;
   308          int ret;
   309          bool remove;
   310
   311          remove = event_trigger_check_remove(glob);
   312
   313          /*
   314           * separate the param and the filter:
   315           * objtrace:add:OBJ[:COUNT] [if filter]
   316           */
   317          ret = event_trigger_separate_filter(param_and_filter, &param, &filter, true);
   318          if (ret)
   319                  return ret;
   320
   321          objtrace_cmd = strsep(&param, ":");
   322          if (!objtrace_cmd || strcmp(objtrace_cmd, OBJTRACE_CMD_ADD)) {
   323                  pr_err("error objtrace command\n");
   324                  return -EINVAL;
   325          }
   326
   327          arg = strsep(&param, ":");
   328          if (!arg)
   329                  return -EINVAL;
   330
   331          field = trace_find_event_field(file->event_call, arg);
   332          if (!field)
   333                  return -EINVAL;
   334
   335          if (field->size != sizeof(void *)) {
Quoted 1 line

336 pr_err("the size of the %s should be:%ld\n", field->name, sizeof(void *));

   337                  return -EINVAL;
   338          }
   339
   340          if (remove && !field_exist(file, cmd_ops, field->name))
   341                  return -ENOENT;
   342
   343          obj_data = kzalloc(sizeof(*obj_data), GFP_KERNEL);
   344          if (!obj_data)
   345                  return -ENOMEM;
   346
   347          obj_data->field = field;
   348          obj_data->tr = file->tr;
   349          snprintf(obj_data->objtrace_cmd, OBJTRACE_CMD_LEN, objtrace_cmd);
   350
   351          trigger_data = event_trigger_alloc(cmd_ops, cmd, param, obj_data);
   352          if (!trigger_data) {
   353                  kfree(obj_data);
   354                  return -ENOMEM;
   355          }
   356          if (remove) {
   357                  event_trigger_unregister(cmd_ops, file, glob+1, trigger_data);
   358                  kfree(obj_data);
   359                  kfree(trigger_data);
   360                  return 0;
   361          }
   362
   363          ret = event_trigger_parse_num(param, trigger_data);
   364          if (ret)
   365                  goto out_free;
   366
   367          ret = event_trigger_set_filter(cmd_ops, file, filter, trigger_data);
   368          if (ret < 0)
   369                  goto out_free;
   370
   371          ret = event_trigger_register(cmd_ops, file, glob, trigger_data);
   372          if (ret)
   373                  goto out_free;
   374
   375          return ret;
   376
   377   out_free:
   378          event_trigger_reset_filter(cmd_ops, trigger_data);
   379          kfree(obj_data);
   380          kfree(trigger_data);
   381          return ret;
   382  }
   383
Quoted 3 lines

--
0-DAY CI Kernel Test Service
https://01.org/lkp

Thanks,
JeffXie

Thanks,
JeffXie

#6 lore raw

Re: [PATCH v11 1/4] trace: Add trace any kernel object

In reply to Jeff Xie
Thank you for the patch! Perhaps something to improve:

Hi Jeff,

Thank you for the patch! Perhaps something to improve:

[auto build test WARNING on b39181f7c6907dc66ff937b74758671fa6ba430c]

url:    https://github.com/intel-lab-lkp/linux/commits/Jeff-Xie/trace-Introduce-objtrace-trigger-to-trace-the-kernel-object/20220603-004723
base:   b39181f7c6907dc66ff937b74758671fa6ba430c
config: i386-randconfig-a001 (https://download.01.org/0day-ci/archive/20220603/[email protected]/config)
compiler: gcc-11 (Debian 11.3.0-1) 11.3.0
reproduce (this is a W=1 build):
        # https://github.com/intel-lab-lkp/linux/commit/765253f020469f94856aedc5a3fe5444e1e8f4e8
        git remote add linux-review https://github.com/intel-lab-lkp/linux
        git fetch --no-tags linux-review Jeff-Xie/trace-Introduce-objtrace-trigger-to-trace-the-kernel-object/20220603-004723
        git checkout 765253f020469f94856aedc5a3fe5444e1e8f4e8
        # save the config file
        mkdir build_dir && cp config build_dir/.config
        make W=1 O=build_dir ARCH=i386 SHELL=/bin/bash

If you fix the issue, kindly add following tag where applicable

All warnings (new ones prefixed by >>):

In file included from include/linux/kernel.h:29,

                    from arch/x86/include/asm/percpu.h:27,
                    from arch/x86/include/asm/preempt.h:6,
                    from include/linux/preempt.h:78,
                    from include/linux/spinlock.h:55,
                    from include/linux/wait.h:9,
                    from include/linux/wait_bit.h:8,
                    from include/linux/fs.h:6,
                    from include/linux/seq_buf.h:5,
                    from include/linux/trace_seq.h:5,
                    from kernel/trace/trace_output.h:5,
                    from kernel/trace/trace_object.c:9:
   kernel/trace/trace_object.c: In function 'event_object_trigger_parse':
>> include/linux/kern_levels.h:5:25: warning: format '%ld' expects argument of type 'long int', but argument 3 has type 'unsigned int' [-Wformat=]
       5 | #define KERN_SOH        "\001"          /* ASCII Start Of Header */
         |                         ^~~~~~
   include/linux/printk.h:418:25: note: in definition of macro 'printk_index_wrap'
     418 |                 _p_func(_fmt, ##__VA_ARGS__);                           \
         |                         ^~~~
   include/linux/printk.h:489:9: note: in expansion of macro 'printk'
     489 |         printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
         |         ^~~~~~
   include/linux/kern_levels.h:11:25: note: in expansion of macro 'KERN_SOH'
      11 | #define KERN_ERR        KERN_SOH "3"    /* error conditions */
         |                         ^~~~~~~~
   include/linux/printk.h:489:16: note: in expansion of macro 'KERN_ERR'
     489 |         printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
         |                ^~~~~~~~
   kernel/trace/trace_object.c:336:17: note: in expansion of macro 'pr_err'
     336 |                 pr_err("the size of the %s should be:%ld\n", field->name, sizeof(void *));
         |                 ^~~~~~

vim +5 include/linux/kern_levels.h

314ba3520e513a Joe Perches 2012-07-30 4
04d2c8c83d0e3a Joe Perches 2012-07-30 @5 #define KERN_SOH "\001" /* ASCII Start Of Header */
04d2c8c83d0e3a Joe Perches 2012-07-30 6 #define KERN_SOH_ASCII '\001'
04d2c8c83d0e3a Joe Perches 2012-07-30 7

Signature · 2 lines
0-DAY CI Kernel Test Service
https://01.org/lkp
author
#7 lore raw

PATCH v11 2/4 trace/objtrace: Get the value of the object

In reply to Jeff Xie

Using objtrace trigger to get the value of the object which from the kernel function parameter.

Syntax:

	objtrace:add:obj[,offset][:type][:count][if <filter>]

Usage:

	# echo 'p bio_add_page arg1=$arg1' > ./kprobe_events
	# gdb vmlinux
	(gdb) p &(((struct bio *)0)->bi_iter.bi_size)
	$1 = (unsigned int *) 0x28
	# echo 'objtrace:add:arg1,0x28:u32:1 if comm == "cat"' > ./events/kprobes/ \
		 p_bio_add_page_0/trigger
	# cat /test.txt
---
 kernel/trace/trace.c         |   2 +-
 kernel/trace/trace_entries.h |   5 +-
 kernel/trace/trace_object.c  | 191 ++++++++++++++++++++++++++++++++---
 kernel/trace/trace_output.c  |   6 +-
 4 files changed, 185 insertions(+), 19 deletions(-)
kernel/trace/trace.c +1 -1
index 7074ad8bc1a0..37f5cbfa5347 100644
@@ -5628,7 +5628,7 @@ static const char readme_msg[] =
 	"\t            disable_hist:<system>:<event>\n"
 #endif
 #ifdef CONFIG_TRACE_OBJECT
-	"\t            objtrace:add:obj[:count][if <filter>]\n"
+	"\t            objtrace:add:obj[,offset][:type][:count][if <filter>]\n"
 #endif
 #ifdef CONFIG_STACKTRACE
 	"\t\t    stacktrace\n"
kernel/trace/trace_entries.h +3 -2
index bb120d9498a9..2407c45a568c 100644
@@ -413,8 +413,9 @@ FTRACE_ENTRY(object, trace_object_entry,
 		__field(	unsigned long,		ip		)
 		__field(	unsigned long,		parent_ip	)
 		__field(	unsigned long,		object		)
+		__field(	unsigned long,		value		)
 	),
 
-	F_printk(" %ps <-- %ps object:%lx\n",
-		 (void *)__entry->ip, (void *)__entry->parent_ip, __entry->object)
+	F_printk(" %ps <-- %ps object:%lx value:%lx\n", (void *)__entry->ip,
+	       (void *)__entry->parent_ip, __entry->object, __entry->value)
 );
kernel/trace/trace_object.c +178 -13

302 lines not on this page · raw message

kernel/trace/trace_output.c +3 -3
index 34ff7b4dc521..a45871b52dcc 100644
@@ -1561,6 +1561,7 @@ static enum print_line_t trace_object_print(struct trace_iterator *iter, int fla
 	trace_assign_type(field, iter->ent);
 	print_fn_trace(s, field->ip, field->parent_ip, flags);
 	trace_seq_printf(s, " object:0x%lx", field->object);
+	trace_seq_printf(s, " value:0x%lx", field->value);
 	trace_seq_putc(s, '\n');
 
 	return trace_handle_return(s);
@@ -1573,9 +1574,8 @@ static enum print_line_t trace_object_raw(struct trace_iterator *iter, int flags
 
 	trace_assign_type(field, iter->ent);
 
-	trace_seq_printf(&iter->seq, "%lx %lx\n",
-			 field->ip,
-			 field->parent_ip);
+	trace_seq_printf(&iter->seq, "%lx %lx %lx %lx\n", field->ip,
+			field->parent_ip, field->object, field->value);
 
 	return trace_handle_return(&iter->seq);
 }
Signature · 1 line
2.25.1
author
#8 lore raw

PATCH v11 3/4 trace/objtrace: Add testcases for objtrace

In reply to Jeff Xie

Add a series of testcases to illustrate correct and incorrect usage of objtrace trigger.

---
 .../ftrace/test.d/trigger/trigger-objtrace.tc | 41 +++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 tools/testing/selftests/ftrace/test.d/trigger/trigger-objtrace.tc
tools/testing/selftests/ftrace/test.d/trigger/trigger-objtrace.tc new file +41 -0
new file mode 100644
index 000000000000..d894442b6a30
@@ -0,0 +1,41 @@
+#!/bin/sh
+# SPDX-License-Identifier: GPL-2.0
+# description: event trigger - test objtrace-trigger
+# requires: kprobe_events "objtrace":README
+
+fail() { #msg
+    echo $1
+    exit_fail
+}
+
+echo 'p bio_add_page arg1=$arg1 arg2=$arg2' > kprobe_events
+
+FEATURE=`grep objtrace events/kprobes/p_bio_add_page_0/trigger`
+if [ -z "$FEATURE" ]; then
+    echo "objtrace trigger is not supported"
+    exit_unsupported
+fi
+
+echo "Test objtrace trigger"
+echo 'objtrace:add:arg1,0x28:u32:1 if comm == "cat"' > \
+	events/kprobes/p_bio_add_page_0/trigger
+if [ -z $? ]; then
+	fail "objtrace trigger syntax error"
+fi
+
+echo "Test objtrace semantic errors"
+
+# Being lack of objtrace command
+! echo 'objtrace:arg1,0x28:u32:1' > events/kprobes/p_bio_add_page_0/trigger
+# Bad parameter name
+! echo 'objtrace:add:argx:u32:1' > events/kprobes/p_bio_add_page_0/trigger
+# The parameter existed on event
+! echo 'objtrace:add:arg2:u32:1' > events/kprobes/p_bio_add_page_0/trigger
+
+echo "reset objtrace trigger"
+
+echo '!objtrace:add:arg1,0x28:u32' > \
+	events/kprobes/p_bio_add_page_0/trigger
+echo '-:p_bio_add_page_0' >> ./kprobe_events
+
+exit 0
Signature · 1 line
2.25.1
author
#9 lore raw

PATCH v11 4/4 trace/objtrace: Add documentation for objtrace

In reply to Jeff Xie

Added documentation explaining how to use objtrace trigger to get the value of the object.

---
 Documentation/trace/events.rst | 83 ++++++++++++++++++++++++++++++++++
 1 file changed, 83 insertions(+)
Documentation/trace/events.rst +83 -0
index c47f381d0c00..0dc475160133 100644
@@ -546,6 +546,89 @@ The following commands are supported:
 
   See Documentation/trace/histogram.rst for details and examples.
 
+- objtrace
+
+  This command provides a way to get the value of any object, The object
+  can be obtained from the dynamic event(kprobe_event/uprobe_event) or the
+  static event(tracepoint).
+
+  Usage:
+  When using the kprobe event, only need to set the objtrace(a new trigger),
+  we can get the value of the object. The object is from the setting of the
+  kprobe event.
+
+  For example:
+  For the function bio_add_page():
+
+  int bio_add_page(struct bio *bio, struct page *page,
+	unsigned int len, unsigned int offset)
+
+  Firstly, we can set the base of the object, thus the first string "arg1"
+  stands for the value of the first parameter of this function bio_add_gage(),
+
+  # echo 'p bio_add_page arg1=$arg1' > ./kprobe_events
+
+  Secondly, we can get the value dynamically based on above object.
+
+  find the offset of the bi_size in struct bio:
+  $ gdb vmlinux
+  (gdb) p &(((struct bio *)0)->bi_iter.bi_size)
+  $1 = (unsigned int *) 0x28
+
+  # echo 'objtrace:add:arg1,0x28:u32:1 if comm == "cat"' > ./events/kprobes/ \
+	p_bio_add_page_0/trigger
+
+  # cd /sys/kernel/debug/tracing/
+  # echo 'p bio_add_page arg1=$arg1' > ./kprobe_events
+  # echo 'objtrace:add:arg1,0x28:u32:1 if comm == "cat"' > ./events/kprobes/p_bio_add_page_0/trigger
+
+  # du -sh /test.txt
+  12.0K   /test.txt
+
+  # cat  /test.txt > /dev/null
+  # cat ./trace
+  # tracer: nop
+  #
+  # entries-in-buffer/entries-written: 128/128   #P:4
+  #
+  #                                _-----=> irqs-off/BH-disabled
+  #                               / _----=> need-resched
+  #                              | / _---=> hardirq/softirq
+  #                              || / _--=> preempt-depth
+  #                              ||| / _-=> migrate-disable
+  #                              |||| /     delay
+  #           TASK-PID     CPU#  |||||  TIMESTAMP  FUNCTION
+  #              | |         |   |||||     |         |
+               cat-117     [002] ...1.     1.602243: __bio_try_merge_page <-bio_add_page object:0xffff88811bee4000 value:0x0
+               cat-117     [002] ...1.     1.602244: __bio_add_page <-bio_add_page object:0xffff88811bee4000 value:0x0
+               cat-117     [002] ...2.     1.602244: bio_add_page <-ext4_mpage_readpages object:0xffff88811bee4000 value:0x1000
+               cat-117     [002] ...1.     1.602245: __bio_try_merge_page <-bio_add_page object:0xffff88811bee4000 value:0x1000
+               cat-117     [002] ...1.     1.602245: __bio_add_page <-bio_add_page object:0xffff88811bee4000 value:0x1000
+               cat-117     [002] ...2.     1.602245: bio_add_page <-ext4_mpage_readpages object:0xffff88811bee4000 value:0x2000
+               cat-117     [002] ...1.     1.602245: __bio_try_merge_page <-bio_add_page object:0xffff88811bee4000 value:0x2000
+               cat-117     [002] ...1.     1.602245: __bio_add_page <-bio_add_page object:0xffff88811bee4000 value:0x2000
+               cat-117     [002] ...1.     1.602245: submit_bio <-ext4_mpage_readpages object:0xffff88811bee4000 value:0x3000
+               cat-117     [002] ...1.     1.602245: submit_bio_noacct <-ext4_mpage_readpages object:0xffff88811bee4000 value:0x3000
+               cat-117     [002] ...1.     1.602246: __submit_bio <-submit_bio_noacct object:0xffff88811bee4000 value:0x3000
+               cat-117     [002] ...1.     1.602246: submit_bio_checks <-__submit_bio object:0xffff88811bee4000 value:0x3000
+               cat-117     [002] ...1.     1.602246: __cond_resched <-submit_bio_checks object:0xffff88811bee4000 value:0x3000
+               cat-117     [002] ...1.     1.602246: should_fail_bio <-submit_bio_checks object:0xffff88811bee4000 value:0x3000
+               cat-117     [002] ...1.     1.602246: blk_mq_submit_bio <-submit_bio_noacct object:0xffff88811bee4000 value:0x3000
+               cat-117     [002] ...1.     1.602246: blk_attempt_plug_merge <-blk_mq_submit_bio object:0xffff88811bee4000 value:0x3000
+               cat-117     [002] ...1.     1.602246: blk_mq_sched_bio_merge <-blk_mq_submit_bio object:0xffff88811bee4000 value:0x3000
+               cat-117     [002] ...1.     1.602247: __rcu_read_lock <-blk_mq_submit_bio object:0xffff88811bee4000 value:0x3000
+               cat-117     [002] ...1.     1.602247: __rcu_read_unlock <-blk_mq_submit_bio object:0xffff88811bee4000 value:0x3000
+               cat-117     [002] ...1.     1.602247: __blk_mq_alloc_requests <-blk_mq_submit_bio object:0xffff88811bee4000 value:0x3000
+            <idle>-0       [002] d..3.     1.602298: bio_endio <-blk_update_request object:0xffff88811bee4000 value:0x0
+            <idle>-0       [002] d..3.     1.602298: mpage_end_io <-blk_update_request object:0xffff88811bee4000 value:0x0
+            <idle>-0       [002] d..3.     1.602298: __read_end_io <-blk_update_request object:0xffff88811bee4000 value:0x0
+            <idle>-0       [002] d..3.     1.602300: bio_put <-blk_update_request object:0xffff88811bee4000 value:0x0
+            <idle>-0       [002] d..3.     1.602300: bio_free <-blk_update_request object:0xffff88811bee4000 value:0x0
+            <idle>-0       [002] d..3.     1.602300: mempool_free <-blk_update_request object:0xffff88811bee4000 value:0x0
+            <idle>-0       [002] d..3.     1.602300: mempool_free_slab <-blk_update_request object:0xffff88811bee4000 value:0x0
+            <idle>-0       [002] d..3.     1.602300: kmem_cache_free <-blk_update_request object:0xffff88811bee4000 value:0x0
+             ...
+
 7. In-kernel trace event API
 ============================
 
Signature · 1 line
2.25.1