trace: Introduce objtrace trigger to trace the kernel object
Subsystems (3)
v14 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.
v14:
- make documentation more readable and fix literal code block by Bagas Sanjaya
v13:
- remove the 's' type, since the objtrace event doesn't show the value with sign
- change the [3/4] tag with 'selftests/ftrace' instead of 'trace/objtrace'
- add 'Documentation:' tag for [4/4]
v12:
- use the %zu to print the sizeof
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 selftests/ftrace: Add testcases for objtrace
Documentation: trace/objtrace: Add documentation for objtrace
Documentation/trace/events.rst | 87 +++ 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 | 611 ++++++++++++++++++ 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: 408d26e261b089596c0837e71d2fb4a80ea04ef3
Signature · 1 line
2.25.1
PATCH v14 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
PATCH v14 2/4 trace/objtrace: Get the value of the object
In reply to Jeff XieUsing 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 | 187 ++++++++++++++++++++++++++++++++--- kernel/trace/trace_output.c | 6 +- 4 files changed, 181 insertions(+), 19 deletions(-)
kernel/trace/trace.c +1 -1
@@ -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
@@ -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 +174 -13
298 lines not on this page · raw message
kernel/trace/trace_output.c +3 -3
@@ -1561,6 +1561,7 @@ static enum print_line_t trace_object_print(struct trace_iterator *iter, int flatrace_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 flagstrace_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
PATCH v14 3/4 selftests/ftrace: Add testcases for objtrace
In reply to Jeff XieAdd 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
@@ -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
PATCH v14 4/4 Documentation: trace/objtrace: Add documentation for objtrace
In reply to Jeff XieAdd documentation explaining how to use objtrace trigger to get the value of the object.
---
Changelog:
v14:
- make documentation more readable and fix literal code block by Bagas Sanjaya
Documentation/trace/events.rst | 87 ++++++++++++++++++++++++++++++++++ 1 file changed, 87 insertions(+)
Documentation/trace/events.rst +87 -0
@@ -546,6 +546,93 @@ 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, by only need to set the objtrace (a new + trigger), we can get the value of object that is set by kprobe event. + + For example, for the function bio_add_page(): + + .. code-block:: c + + 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 as first parameter (arg1) to + to the function: + + .. code-block:: + + # echo 'p bio_add_page arg1=$arg1' > ./kprobe_events + + Secondly, we can get the value dynamically based on the object: + + .. code-block:: + + 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
Re: [PATCH v14 4/4] Documentation: trace/objtrace: Add documentation for objtrace
Quoted 3 lines · Jeff Xie
Add documentation explaining how to use objtrace trigger to get the value of the object.
Looks OK, thanks!
Signature · 1 line
An old man doll... just what I always wanted! - Clara
Re: [PATCH v14 4/4] Documentation: trace/objtrace: Add documentation for objtrace
In reply to Jeff XieQuoted 53 lines · Jeff Xie
Add documentation explaining how to use objtrace trigger to get the value of the object.
Cc Jonathan Corbet <[email protected]>Cc Bagas Sanjaya <[email protected]>Signed-off-by Jeff Xie <[email protected]>Reviewed-by Masami Hiramatsu (Google) <[email protected]>---
Changelog:
v14:
- make documentation more readable and fix literal code block by Bagas SanjayaDocumentation/trace/events.rst | 87 ++++++++++++++++++++++++++++++++++ 1 file changed, 87 insertions(+)Documentation/trace/events.rst +29
-0@@ -546,6 +546,93 @@ 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, by only need to set the objtrace (a new + trigger), we can get the value of object that is set by kprobe event. + + For example, for the function bio_add_page(): + + .. code-block:: c + + 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 as first parameter (arg1) to + to the function: + + .. code-block:: + + # echo 'p bio_add_page arg1=$arg1' > ./kprobe_events + + Secondly, we can get the value dynamically based on the object: + + .. code-block:: + + find the offset of the bi_size in struct bio:
Documentation/trace/events.rst The following commands are supported: · line 587
Quoted 10 lines
Documentation/trace/events.rst +10
-0+ $ 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
No offense but this documentation is not well written and hard to read.
Admittedly though I am just casually browsing through, so apologies.
So basically, 0x28 is the offset of the u32 within the bio, that you want to track down, as it passes through functions?
The example is good, but I suggest breakdown each of the commands separated by ':' and document those as well.
Cool feature though, I can see myself using it for something (dunno what yet) :)
thanks,
- Joel
Quoted 54 lines
Documentation/trace/events.rst +48
-0+ + # 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
Re: [PATCH v14 4/4] Documentation: trace/objtrace: Add documentation for objtrace
Hi Joel,
Thank you for your review.
Quoted 68 lines · Joel Fernandes
Quoted 53 lines · Jeff Xie
Add documentation explaining how to use objtrace trigger to get the value of the object.
Cc Jonathan Corbet <[email protected]>Cc Bagas Sanjaya <[email protected]>Signed-off-by Jeff Xie <[email protected]>Reviewed-by Masami Hiramatsu (Google) <[email protected]>---
Changelog:
v14:
- make documentation more readable and fix literal code block by Bagas SanjayaDocumentation/trace/events.rst | 87 ++++++++++++++++++++++++++++++++++ 1 file changed, 87 insertions(+)Documentation/trace/events.rst +29
-0@@ -546,6 +546,93 @@ 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, by only need to set the objtrace (a new + trigger), we can get the value of object that is set by kprobe event. + + For example, for the function bio_add_page(): + + .. code-block:: c + + 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 as first parameter (arg1) to + to the function: + + .. code-block:: + + # echo 'p bio_add_page arg1=$arg1' > ./kprobe_events + + Secondly, we can get the value dynamically based on the object: + + .. code-block:: + + find the offset of the bi_size in struct bio:Documentation/trace/events.rst The following commands are supported: · line 587
Quoted 10 lines
Documentation/trace/events.rst +10
-0+ $ 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/triggerNo offense but this documentation is not well written and hard to read.
Quoted 4 lines
Admittedly though I am just casually browsing through, so apologies.
So basically,
0x28is the offset of the u32 within the bio, that you want to track down, as it passes through functions?
Yes, Not only track the bio, but also get a value with an offset of 0x28 relative to the bio.
Quoted 3 lines
The example is good, but I suggest breakdown each of the commands separated by ':' and document those as well.
I don't know how to explain it in more detail, maybe need to be familiar with kprobe event and trigger in advance ;-)
Quoted 1 line
Cool feature though, I can see myself using it for something (dunno what yet) :)
Thank you, hope you have a good experience ;-)
Quoted 61 lines
thanks,
- Joel
Quoted 54 lines
Documentation/trace/events.rst +48
-1+ + # 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 ============================ --2.25.1
Signature · 2 lines
Thanks, JeffXie
Re: [PATCH v14 4/4] Documentation: trace/objtrace: Add documentation for objtrace
Quoted 74 lines · Jeff Xie
Hi Joel,
Thank you for your review.
Quoted 68 lines · Joel Fernandes
Quoted 53 lines · Jeff Xie
Add documentation explaining how to use objtrace trigger to get the value of the object.
Cc Jonathan Corbet <[email protected]>Cc Bagas Sanjaya <[email protected]>Signed-off-by Jeff Xie <[email protected]>Reviewed-by Masami Hiramatsu (Google) <[email protected]>---
Changelog:
v14:
- make documentation more readable and fix literal code block by Bagas SanjayaDocumentation/trace/events.rst | 87 ++++++++++++++++++++++++++++++++++ 1 file changed, 87 insertions(+)Documentation/trace/events.rst +29
-0@@ -546,6 +546,93 @@ 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, by only need to set the objtrace (a new + trigger), we can get the value of object that is set by kprobe event. + + For example, for the function bio_add_page(): + + .. code-block:: c + + 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 as first parameter (arg1) to + to the function: + + .. code-block:: + + # echo 'p bio_add_page arg1=$arg1' > ./kprobe_events + + Secondly, we can get the value dynamically based on the object: + + .. code-block:: + + find the offset of the bi_size in struct bio:Documentation/trace/events.rst The following commands are supported: · line 587
Quoted 10 lines
Documentation/trace/events.rst +10
-0+ $ 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/triggerNo offense but this documentation is not well written and hard to read.
Quoted 7 lines
Quoted 4 lines
Admittedly though I am just casually browsing through, so apologies.
So basically,
0x28is the offset of the u32 within the bio, that you want to track down, as it passes through functions?Yes, Not only track the bio, but also get a value with an offset of
0x28relative to the bio.
Right.
Quoted 6 lines
Quoted 3 lines
The example is good, but I suggest breakdown each of the commands separated by ':' and document those as well.
I don't know how to explain it in more detail, maybe need to be familiar with kprobe event and trigger in advance ;-)
That's not a strong argument IMO.
Shouldn't it be super easy to add the following to the documentation since you already mentioned it in the commit log? Or am I missing something?
Syntax:
objtrace:add:obj[,offset][:type][:count][if <filter>]
Thanks,
- Joel
Re: [PATCH v14 4/4] Documentation: trace/objtrace: Add documentation for objtrace
Hi Joel,
Quoted 93 lines · Joel Fernandes
Quoted 74 lines · Jeff Xie
Hi Joel,
Thank you for your review.
Quoted 68 lines · Joel Fernandes
Quoted 53 lines · Jeff Xie
Add documentation explaining how to use objtrace trigger to get the value of the object.
Cc Jonathan Corbet <[email protected]>Cc Bagas Sanjaya <[email protected]>Signed-off-by Jeff Xie <[email protected]>Reviewed-by Masami Hiramatsu (Google) <[email protected]>---
Changelog:
v14:
- make documentation more readable and fix literal code block by Bagas SanjayaDocumentation/trace/events.rst | 87 ++++++++++++++++++++++++++++++++++ 1 file changed, 87 insertions(+)Documentation/trace/events.rst +29
-0@@ -546,6 +546,93 @@ 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, by only need to set the objtrace (a new + trigger), we can get the value of object that is set by kprobe event. + + For example, for the function bio_add_page(): + + .. code-block:: c + + 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 as first parameter (arg1) to + to the function: + + .. code-block:: + + # echo 'p bio_add_page arg1=$arg1' > ./kprobe_events + + Secondly, we can get the value dynamically based on the object: + + .. code-block:: + + find the offset of the bi_size in struct bio:Documentation/trace/events.rst The following commands are supported: · line 587
Quoted 10 lines
Documentation/trace/events.rst +10
-0+ $ 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/triggerNo offense but this documentation is not well written and hard to read.
Quoted 7 lines
Quoted 4 lines
Admittedly though I am just casually browsing through, so apologies.
So basically,
0x28is the offset of the u32 within the bio, that you want to track down, as it passes through functions?Yes, Not only track the bio, but also get a value with an offset of
0x28relative to the bio.Right.
Quoted 6 lines
Quoted 3 lines
The example is good, but I suggest breakdown each of the commands separated by ':' and document those as well.
I don't know how to explain it in more detail, maybe need to be familiar with kprobe event and trigger in advance ;-)
Quoted 8 lines
That's not a strong argument IMO.
Shouldn't it be super easy to add the following to the documentation since you already mentioned it in the commit log? Or am I missing something?
Syntax:
objtrace:add:obj[,offset][:type][:count][if <filter>]
I'am so sorry, I misunderstood you, I thought it needed to be explained every word like this, e.g.
objtrace:
...
add:
......
Thanks, I will add the above syntax in the next version.
Quoted 3 lines
Thanks,
- Joel
Signature · 2 lines
Thanks, JeffXie
Re: [PATCH v14 4/4] Documentation: trace/objtrace: Add documentation for objtrace
Quoted 109 lines · Jeff Xie
Hi Joel,
Quoted 93 lines · Joel Fernandes
Quoted 74 lines · Jeff Xie
Hi Joel,
Thank you for your review.
Quoted 68 lines · Joel Fernandes
Quoted 53 lines · Jeff Xie
Add documentation explaining how to use objtrace trigger to get the value of the object.
Cc Jonathan Corbet <[email protected]>Cc Bagas Sanjaya <[email protected]>Signed-off-by Jeff Xie <[email protected]>Reviewed-by Masami Hiramatsu (Google) <[email protected]>---
Changelog:
v14:
- make documentation more readable and fix literal code block by Bagas SanjayaDocumentation/trace/events.rst | 87 ++++++++++++++++++++++++++++++++++ 1 file changed, 87 insertions(+)Documentation/trace/events.rst +29
-0@@ -546,6 +546,93 @@ 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, by only need to set the objtrace (a new + trigger), we can get the value of object that is set by kprobe event. + + For example, for the function bio_add_page(): + + .. code-block:: c + + 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 as first parameter (arg1) to + to the function: + + .. code-block:: + + # echo 'p bio_add_page arg1=$arg1' > ./kprobe_events + + Secondly, we can get the value dynamically based on the object: + + .. code-block:: + + find the offset of the bi_size in struct bio:Documentation/trace/events.rst The following commands are supported: · line 587
Quoted 10 lines
Documentation/trace/events.rst +10
-0+ $ 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/triggerNo offense but this documentation is not well written and hard to read.
Quoted 7 lines
Quoted 4 lines
Admittedly though I am just casually browsing through, so apologies.
So basically,
0x28is the offset of the u32 within the bio, that you want to track down, as it passes through functions?Yes, Not only track the bio, but also get a value with an offset of
0x28relative to the bio.Right.
Quoted 6 lines
Quoted 3 lines
The example is good, but I suggest breakdown each of the commands separated by ':' and document those as well.
I don't know how to explain it in more detail, maybe need to be familiar with kprobe event and trigger in advance ;-)
Quoted 8 lines
That's not a strong argument IMO.
Shouldn't it be super easy to add the following to the documentation since you already mentioned it in the commit log? Or am I missing something?
Syntax:
objtrace:add:obj[,offset][:type][:count][if <filter>]I'am so sorry, I misunderstood you, I thought it needed to be explained every word like this, e.g.
objtrace:
Quoted 7 lines
... add: ......
Thanks, I will add the above syntax in the next version.
Yeah no problem, I am also OK with that being a follow-up patch instead of the series if it matches with Steven's review timing better.
Thanks,
- Joel
Hi Steve,
I'm curious if you have any comments on this patchset ;-)
Quoted 175 lines · Jeff Xie
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 functionbio_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_eventsSecondly, we can get the value dynamically based on above object.
find the offset of the
bi_sizein 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.
v14:
- make documentation more readable and fix literal code block by Bagas Sanjayav13:
- remove the 's' type, since the objtrace event doesn't show the value with sign
- change the [3/4] tag with 'selftests/ftrace' instead of 'trace/objtrace'
- add 'Documentation:' tag for [4/4]v12:
- use the %zu to print the sizeofReported-by kernel test robot <[email protected]>Suggested-by Nathan Chancellor <[email protected]>v11:
- remove useless atomic counting methods fornum_traced_obj
- make arrayobjtrace_fetch_typesnull terminated
- addraw_spin_lock_initforobj_data_lockv10:
- support ftrace instances
- usetrace_buffer_lock_reserveinstead oftrace_event_buffer_lock_reserve
- a lot of cleanup work has been done mainly forevent_object_trigger_parsev9:
- 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 functiontrace_object_events_call
- recover the filter when getting the value of the object
- simplify the implementation for the functionget_object_value
- fix the build errorv7:
- use fixed-size array for object pool instead of list structure
- useftrace_test_recursion_trylockfor function trace hook function
- fixtrace_object_refreference count in theinit_trace_object
- invokeexit_trace_objectno matter whetherdata->ops->freeis null in theunregister_object_trigger
- releaseprivate_dataofevent_trigger_datain thetrace_object_trigger_free
- remove [RFC] tagv6:
- change the objtrace trigger syntax.
- add patchset description
- add <tracefs>/READMEv5:
- add testcasts
- add check thefield->size
- add lockless to search object
- describe the object trace more clearly inKconfigv4:
- please ignore the v4 which is the same as v3v3:
- change the objfilter to objtrace
- add a command to the objfilter syntax
- change to get the value of the object
- usetrace_find_event_fieldto find the field instead of using argN
- get data from @rec in the event trigger callback funcitonv2:
- adding a "objfilter" trigger to update objectJeff Xie (4):
trace: Add trace any kernel object
trace/objtrace: Get the value of the object selftests/ftrace: Add testcases for objtrace
Documentation: trace/objtrace: Add documentation for objtraceDocumentation/trace/events.rst | 87 +++ 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 | 611 ++++++++++++++++++ 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
Quoted 4 lines
base-commit:
408d26e261b089596c0837e71d2fb4a80ea04ef3--
2.25.1
Thanks,
JeffXie
Steven Rostedt
maintainerQuoted 3 lines · On Tue, 5 Jul 2022 23:30:46 +0800 Jeff Xie <[email protected]> wrote:
Hi Steve,
I'm curious if you have any comments on this patchset ;-)
Hi Jeff,
I haven't forgotten you. You're still in the queue (which is finally moving forward). I have a few other patch sets ahead of yours that I need to go over. Yes, those patches have been waiting longer :-p
-- Steve
Hi steve,
I would like to ask whether this patch set may be merged into v6.1 ;-) The kernel development is indeed very different from what I originally imagined. I originally thought that objtrace would soon enter the kernel community, but I know
it may take one to two years, or longer or discarded, I have slowly come to accept this reality ;-)
Quoted 15 lines · Steven Rostedt
Quoted 3 lines · On Tue, 5 Jul 2022 23:30:46 +0800 Jeff Xie <[email protected]> wrote:
Hi Steve,
I'm curious if you have any comments on this patchset ;-)
Hi Jeff,
I haven't forgotten you. You're still in the queue (which is finally moving forward). I have a few other patch sets ahead of yours that I need to go over. Yes, those patches have been waiting longer :-p
-- Steve
Signature · 2 lines
Thanks, JeffXie
Steven Rostedt
maintainerQuoted 8 lines · On Thu, 18 Aug 2022 23:05:19 +0800 Jeff Xie <[email protected]> wrote:
Hi steve,
I would like to ask whether this patch set may be merged into v6.1 ;-) The kernel development is indeed very different from what I originally imagined. I originally thought that objtrace would soon enter the kernel community, but I know
it may take one to two years, or longer or discarded, I have slowly come to accept this reality ;-)
As, sorry for the late reviews (trying to get through all the other patches too). I'll see if I can look at it this week.
-- Steve
Quoted 13 lines · Steven Rostedt
Quoted 8 lines · On Thu, 18 Aug 2022 23:05:19 +0800 Jeff Xie <[email protected]> wrote:
Hi steve,
I would like to ask whether this patch set may be merged into v6.1 ;-) The kernel development is indeed very different from what I originally imagined. I originally thought that objtrace would soon enter the kernel community, but I know
it may take one to two years, or longer or discarded, I have slowly come to accept this reality ;-)
Quoted 2 lines
As, sorry for the late reviews (trying to get through all the other patches too). I'll see if I can look at it this week.
Thanks so much.
Signature · 2 lines
Thanks, JeffXie