tracing/probe: add a char type to print the character value of traced arguments
Subsystems (2)
PATCH v2 1/1 tracing/probe: add a char type to print the character value of traced arguments
There are scenes that we want to show the character value of traced arguments other than a decimal or hexadecimal or string value for debug convinience. Add a new type named 'char' to do it.
For example:
echo 'p:myprobe xxxx +0($arg1):char' > kprobe_events
echo 'p:myprobe xxxx +0($arg1):char[2]' > kprobe_events
---
Changes in v2:
- fix build warnings reported by kernel test robot
- modify commit log
--- Documentation/trace/kprobetrace.rst | 3 ++- kernel/trace/trace_probe.c | 2 ++ kernel/trace/trace_probe.h | 1 + 3 files changed, 5 insertions(+), 1 deletion(-)
Documentation/trace/kprobetrace.rst +2 -1
@@ -58,7 +58,7 @@ Synopsis of kprobe_events NAME=FETCHARG : Set NAME as the argument name of FETCHARG. FETCHARG:TYPE : Set TYPE as the type of FETCHARG. Currently, basic types (u8/u16/u32/u64/s8/s16/s32/s64), hexadecimal types - (x8/x16/x32/x64), "string", "ustring" and bitfield + (x8/x16/x32/x64), "char", "string", "ustring" and bitfield are supported. (\*1) only for the probe on function entry (offs == 0).
@@ -80,6 +80,7 @@ E.g. 'x16[4]' means an array of x16 (2bytes hex) with 4 elements. Note that the array can be applied to memory type fetchargs, you can not apply it to registers/stack-entries etc. (for example, '$stack1:x8[8]' is wrong, but '+8($stack):x8[8]' is OK.) +Char type can be used to show the character value of traced arguments. String type is a special type, which fetches a "null-terminated" string from kernel space. This means it will fail and store NULL if the string container has been paged out. "ustring" type is an alternative of string for user-space.
kernel/trace/trace_probe.c +2 -0
@@ -50,6 +50,7 @@ DEFINE_BASIC_PRINT_TYPE_FUNC(x8, u8, "0x%x") DEFINE_BASIC_PRINT_TYPE_FUNC(x16, u16, "0x%x") DEFINE_BASIC_PRINT_TYPE_FUNC(x32, u32, "0x%x") DEFINE_BASIC_PRINT_TYPE_FUNC(x64, u64, "0x%Lx") +DEFINE_BASIC_PRINT_TYPE_FUNC(char, u8, "%c")int PRINT_TYPE_FUNC_NAME (symbol )(struct trace_seq *s,void *data,void *ent) {
@@ -93,6 +94,7 @@ static const struct fetch_type probe_fetch_types[] = {ASSIGN_FETCH_TYPE_ALIAS (x16, u16, u16,0 ),ASSIGN_FETCH_TYPE_ALIAS (x32, u32, u32,0 ),ASSIGN_FETCH_TYPE_ALIAS (x64, u64, u64,0 ), +ASSIGN_FETCH_TYPE_ALIAS (char, u8, u8,0 ),ASSIGN_FETCH_TYPE_ALIAS (symbol,ADDR_FETCH_TYPE ,ADDR_FETCH_TYPE ,0 ),ASSIGN_FETCH_TYPE_END
kernel/trace/trace_probe.h +1 -0
@@ -164,6 +164,7 @@ DECLARE_BASIC_PRINT_TYPE_FUNC(x16);DECLARE_BASIC_PRINT_TYPE_FUNC (x32);DECLARE_BASIC_PRINT_TYPE_FUNC (x64); +DECLARE_BASIC_PRINT_TYPE_FUNC (char);DECLARE_BASIC_PRINT_TYPE_FUNC (string);DECLARE_BASIC_PRINT_TYPE_FUNC (symbol);
Signature · 1 line
2.25.1
Quoted 9 lines · On Tue, 13 Dec 2022 18:52:18 -0800 Donglin Peng <[email protected]> wrote:
There are scenes that we want to show the character value of traced arguments other than a decimal or hexadecimal or string value for debug convinience. Add a new type named 'char' to do it.
For example:
echo 'p:myprobe xxxx +0($arg1):char' >
kprobe_eventsecho 'p:myprobe xxxx +0($arg1):char[2]' >
kprobe_events
This looks good to me. Thanks!
Quoted 69 lines
Signed-off-by Donglin Peng <[email protected]>Reported-by kernel test robot <[email protected]>---
Changes in v2:
- fix build warnings reported by kernel test robot
- modify commit log--- Documentation/trace/kprobetrace.rst | 3 ++- kernel/trace/trace_probe.c | 2 ++ kernel/trace/trace_probe.h | 1 + 3 files changed, 5 insertions(+), 1 deletion(-)Documentation/trace/kprobetrace.rst +2
-1@@ -58,7 +58,7 @@ Synopsis of kprobe_events NAME=FETCHARG : Set NAME as the argument name of FETCHARG. FETCHARG:TYPE : Set TYPE as the type of FETCHARG. Currently, basic types (u8/u16/u32/u64/s8/s16/s32/s64), hexadecimal types - (x8/x16/x32/x64), "string", "ustring" and bitfield + (x8/x16/x32/x64), "char", "string", "ustring" and bitfield are supported. (\*1) only for the probe on function entry (offs == 0).@@ -80,6 +80,7 @@ E.g. 'x16[4]' means an array of x16 (2bytes hex) with 4 elements. Note that the array can be applied to memory type fetchargs, you can not apply it to registers/stack-entries etc. (for example, '$stack1:x8[8]' is wrong, but '+8($stack):x8[8]' is OK.) +Char type can be used to show the character value of traced arguments. String type is a special type, which fetches a "null-terminated" string from kernel space. This means it will fail and store NULL if the string container has been paged out. "ustring" type is an alternative of string for user-space.kernel/trace/trace_probe.c +2
-0@@ -50,6 +50,7 @@ DEFINE_BASIC_PRINT_TYPE_FUNC(x8, u8, "0x%x") DEFINE_BASIC_PRINT_TYPE_FUNC(x16, u16, "0x%x") DEFINE_BASIC_PRINT_TYPE_FUNC(x32, u32, "0x%x") DEFINE_BASIC_PRINT_TYPE_FUNC(x64, u64, "0x%Lx") +DEFINE_BASIC_PRINT_TYPE_FUNC(char, u8, "%c")int PRINT_TYPE_FUNC_NAME (symbol )(struct trace_seq *s,void *data,void *ent) {@@ -93,6 +94,7 @@ static const struct fetch_type probe_fetch_types[] = {ASSIGN_FETCH_TYPE_ALIAS (x16, u16, u16,0 ),ASSIGN_FETCH_TYPE_ALIAS (x32, u32, u32,0 ),ASSIGN_FETCH_TYPE_ALIAS (x64, u64, u64,0 ), +ASSIGN_FETCH_TYPE_ALIAS (char, u8, u8,0 ),ASSIGN_FETCH_TYPE_ALIAS (symbol,ADDR_FETCH_TYPE ,ADDR_FETCH_TYPE ,0 ),ASSIGN_FETCH_TYPE_END kernel/trace/trace_probe.h +1
-0@@ -164,6 +164,7 @@ DECLARE_BASIC_PRINT_TYPE_FUNC(x16);DECLARE_BASIC_PRINT_TYPE_FUNC (x32);DECLARE_BASIC_PRINT_TYPE_FUNC (x64); +DECLARE_BASIC_PRINT_TYPE_FUNC (char);DECLARE_BASIC_PRINT_TYPE_FUNC (string);DECLARE_BASIC_PRINT_TYPE_FUNC (symbol);Signature · 1 line
2.25.1
Signature · 1 line
Masami Hiramatsu (Google) <[email protected]>