ftrace: selftests: Add full glob matching and update ftracetest
Subsystems (4)
Masami Hiramatsu
maintainerv2 cover ftrace: selftests: Add full glob matching and update ftracetest
Hi,
Here is the 2nd version of the series of patches to add full glob matching support in ftrace and update ftracetest to test the glob matching and hexadecimal types.
Previous version is here:
https://lkml.org/lkml/2016/10/19/7
I've update ftracetest to initialize ftrace before each testcase accordning to Steve's comment. In this series I've added a patch which makes git to ignore the directory for test results.
[1/6] Add full glob matching support on ftrace's
function filter and event filter expression.
[2/6] Initialize ftrace before running each testcase. [3/6] Hide logs direcotry from git.
[4/6] Introduce temporary directory for test cases,
which is used for storing temporary test data.
[5/6] Add a testcase for function-name glob matching [6/6] Add a testcase for types of event arguments
Thanks,
---
Masami Hiramatsu (6):
ftrace: Support full glob matching
selftests: ftrace: Initialize ftrace before each test
selftests: ftrace: Hide ftracetest logs from git
selftests: ftrace: Introduce TMPDIR for temporary files
selftests: ftrace: Add a testcase for function filter glob match
selftests: ftrace: Add a testcase for types of kprobe event
Documentation/trace/events.txt | 9 +--- Documentation/trace/ftrace.txt | 9 +--- kernel/trace/Kconfig | 2 + kernel/trace/ftrace.c | 4 ++ kernel/trace/trace.c | 2 - kernel/trace/trace.h | 2 + kernel/trace/trace_events_filter.c | 17 +++++++ tools/testing/selftests/ftrace/.gitignore | 1 tools/testing/selftests/ftrace/ftracetest | 4 +- .../ftrace/test.d/ftrace/func-filter-glob.tc | 49 ++++++++++++++++++++ tools/testing/selftests/ftrace/test.d/functions | 25 ++++++++++ .../ftrace/test.d/kprobe/kprobe_args_type.tc | 37 +++++++++++++++ 12 files changed, 146 insertions(+), 15 deletions(-) create mode 100644 tools/testing/selftests/ftrace/.gitignore create mode 100644 tools/testing/selftests/ftrace/test.d/ftrace/func-filter-glob.tc create mode 100644 tools/testing/selftests/ftrace/test.d/kprobe/kprobe_args_type.tc
--
Masami Hiramatsu (Linaro Ltd.) <[email protected]>
Masami Hiramatsu
maintainerPATCH v2 1/6 ftrace: Support full glob matching
Use glob_match() to support flexible glob wildcards (*,?) and character classes ([) for ftrace.
Since the full glob matching is slower than the current partial matching routines(*pat, pat*, *pat*), this leaves those routines and just add MATCH_GLOB for complex glob expression.
e.g.
----
[root@localhost tracing]# echo 'sched*group' > set_ftrace_filter [root@localhost tracing]# cat set_ftrace_filter sched_free_groupsched_change_groupsched_create_groupsched_online_groupsched_destroy_groupsched_offline_group
[root@localhost tracing]# echo '[Ss]y[Ss]_*' > set_ftrace_filter [root@localhost tracing]# head set_ftrace_filter sys_arch_prctlsys_rt_sigreturnsys_iopermSyS_ioplsys_modify_ldtSyS_mmapSyS_set_thread_areaSyS_get_thread_areaSyS_set_tid_addresssys_fork
----
--- Documentation/trace/events.txt | 9 +++------ Documentation/trace/ftrace.txt | 9 +++------ kernel/trace/Kconfig | 2 ++ kernel/trace/ftrace.c | 4 ++++ kernel/trace/trace.c | 2 +- kernel/trace/trace.h | 2 ++ kernel/trace/trace_events_filter.c | 17 ++++++++++++++++- 7 files changed, 31 insertions(+), 14 deletions(-)
Documentation/trace/events.txt +3 -6
@@ -189,16 +189,13 @@ And for string fields they are: ==, !=, ~ -The glob (~) only accepts a wild card character (*) at the start and or -end of the string. For example: +The glob (~) accepts a wild card character (*,?) and character classes +([). For example: prev_comm ~ "*sh" prev_comm ~ "sh*" prev_comm ~ "*sh*" - -But does not allow for it to be within the string: - - prev_comm ~ "ba*sh" <-- is invalid + prev_comm ~ "ba*sh" 5.2 Setting filters -------------------
Documentation/trace/ftrace.txt +3 -6
@@ -2218,16 +2218,13 @@ hrtimer_interrupt sys_nanosleep -Perhaps this is not enough. The filters also allow simple wild -cards. Only the following are currently available +Perhaps this is not enough. The filters also allow glob(7) matching. <match>* - will match functions that begin with <match> *<match> - will match functions that end with <match> *<match>* - will match functions that have <match> in it - -These are the only wild cards which are supported. - - <match>*<match> will not work. + <match1>*<match2> - will match functions that begin with + <match1> and end with <match2> Note: It is better to use quotes to enclose the wild cards, otherwise the shell may expand the parameters into names
kernel/trace/Kconfig +2 -0
@@ -70,6 +70,7 @@ config FTRACE_NMI_ENTER config EVENT_TRACING select CONTEXT_SWITCH_TRACER + select GLOB bool config CONTEXT_SWITCH_TRACER
@@ -133,6 +134,7 @@ config FUNCTION_TRACER select KALLSYMS select GENERIC_TRACER select CONTEXT_SWITCH_TRACER + select GLOB help Enable the kernel to trace every kernel function. This is done by using a compiler feature to insert a small, 5-byte No-Operation
kernel/trace/ftrace.c +4 -0
@@ -3499,6 +3499,10 @@ static int ftrace_match(char *str, struct ftrace_glob *g) memcmp(str + slen - g->len, g->search, g->len) == 0) matched =1 ;break ; +case MATCH_GLOB : +if (glob_match (g->search, str)) + matched =1 ; +break ; }return matched;
kernel/trace/trace.c +1 -1
@@ -4065,7 +4065,7 @@ static const char readme_msg[] ="\n available_filter_functions - list of functions that can be filtered on\n" " set_ftrace_filter\t- echo function name in here to only trace these\n" "\t\t\t functions\n" -"\t accepts: func_full_name, *func_end, func_begin*, *func_middle*\n" +"\t accepts: func_full_name or glob-matching-pattern\n" "\t modules: Can select a group via module\n" "\t Format: :mod:<module-name>\n" "\t example: echo :mod:ext3 > set_ftrace_filter\n"
kernel/trace/trace.h +2 -0
@@ -15,6 +15,7 @@#include <linux/trace_events.h> #include <linux/compiler.h> #include <linux/trace_seq.h> +#include <linux/glob.h> #ifdef CONFIG_FTRACE_SYSCALLS #include <asm/unistd.h> /* For NR_SYSCALLS */
@@ -1257,6 +1258,7 @@ enum regex_type {MATCH_FRONT_ONLY ,MATCH_MIDDLE_ONLY ,MATCH_END_ONLY , + MATCH_GLOB, }; struct regex {
kernel/trace/trace_events_filter.c +16 -1
@@ -344,6 +344,12 @@ static int regex_match_end(char *str, struct regex *r, int len)return 0 ; } +static int regex_match_glob (char *str,struct regex *r,int len__maybe_unused ) +{ +if (glob_match (r->pattern, str)) +return 1 ; +return 0 ; +}/** * filter_parse_regex - parse a basic regex * @buff: the raw regex
@@ -380,14 +386,20 @@ enum regex_type filter_parse_regex(char *buff, int len, char **search, int *not)if (!i) { *search = buff +1 ; type =MATCH_END_ONLY ; - }else { + }else if (i == len -1 ) {if (type ==MATCH_END_ONLY ) type =MATCH_MIDDLE_ONLY ;else type =MATCH_FRONT_ONLY ; buff[i] =0 ;break ; + }else {/* pattern continues, use full glob */ + type =MATCH_GLOB ; +break ; } + }else if (strchr ("[?\\" , buff[i])) { + type =MATCH_GLOB ; +break ; } }
@@ -420,6 +432,9 @@ static void filter_build_regex(struct filter_pred *pred)case MATCH_END_ONLY : r->match = regex_match_end;break ; +case MATCH_GLOB : + r->match = regex_match_glob; +break ; } pred->not ^= not;
Masami Hiramatsu
maintainerPATCH v2 2/6 selftests: ftrace: Initialize ftrace before each test
In reply to Masami HiramatsuReset ftrace to initial state before running each test. This fixes some test cases to enable tracing before starting trace test. This can avoid false-positive failure when previous testcase fails while disabling tracing.
--- tools/testing/selftests/ftrace/ftracetest | 2 +- tools/testing/selftests/ftrace/test.d/functions | 25 +++++++++++++++++++++++ 2 files changed, 26 insertions(+), 1 deletion(-)
tools/testing/selftests/ftrace/ftracetest +1 -1
@@ -228,7 +228,7 @@ trap 'SIG_RESULT=$XFAIL' $SIG_XFAIL __run_test() { # testfile # setup PID and PPID, $$ is not updated. - (cd $TRACING_DIR; read PID _ < /proc/self/stat ; set -e; set -x; . $1) + (cd $TRACING_DIR; read PID _ < /proc/self/stat; set -e; set -x; initialize_ftrace; . $1) [ $? -ne 0 ] && kill -s $SIG_FAIL $SIG_PID }
tools/testing/selftests/ftrace/test.d/functions +25 -0
@@ -23,3 +23,28 @@ reset_trigger() { # reset all current setting triggers done } +reset_events_filter() { # reset all current setting filters + grep -v ^none events/*/*/filter | + while read line; do + echo 0 > `echo $line | cut -f1 -d:` + done +} + +disable_events() { + echo 0 > events/enable +} + +initialize_ftrace() { # Reset ftrace to initial-state +# As the initial state, ftrace will be set to nop tracer, +# no events, no triggers, no filters, no function filters, +# no probes, and tracing on. + disable_tracing + reset_tracer + reset_trigger + reset_events_filter + disable_events + echo | tee set_ftrace_* set_graph_* stack_trace_filter set_event_pid + echo > kprobe_events + echo > uprobe_events + enable_tracing +}
Steven Rostedt
maintainerRe: [PATCH -tip v2 2/6] selftests: ftrace: Initialize ftrace before each test
Quoted 44 lines · On Sun, 30 Oct 2016 15:54:10 +0900 Masami Hiramatsu <[email protected]> wrote:
Reset ftrace to initial state before running each test. This fixes some test cases to enable tracing before starting trace test. This can avoid false-positive failure when previous testcase fails while disabling tracing.
Signed-off-by Masami Hiramatsu <[email protected]>Suggested-by Steven Rostedt <[email protected]>--- tools/testing/selftests/ftrace/ftracetest | 2 +- tools/testing/selftests/ftrace/test.d/functions | 25 +++++++++++++++++++++++ 2 files changed, 26 insertions(+), 1 deletion(-)tools/testing/selftests/ftrace/ftracetest +1
-1@@ -228,7 +228,7 @@ trap 'SIG_RESULT=$XFAIL' $SIG_XFAIL __run_test() { # testfile # setup PID and PPID, $$ is not updated. - (cd $TRACING_DIR; read PID _ < /proc/self/stat ; set -e; set -x; . $1) + (cd $TRACING_DIR; read PID _ < /proc/self/stat; set -e; set -x; initialize_ftrace; . $1) [ $? -ne 0 ] && kill -s $SIG_FAIL $SIG_PID }tools/testing/selftests/ftrace/test.d/functions +11
-0@@ -23,3 +23,28 @@ reset_trigger() { # reset all current setting triggers done } +reset_events_filter() { # reset all current setting filters + grep -v ^none events/*/*/filter | + while read line; do + echo 0 > `echo $line | cut -f1 -d:` + done +} + +disable_events() { + echo 0 > events/enable +} +
tools/testing/selftests/ftrace/test.d/functions reset_trigger() { # reset all current setting triggers · line 46
Quoted 10 lines
tools/testing/selftests/ftrace/test.d/functions +10
-0+initialize_ftrace() { # Reset ftrace to initial-state +# As the initial state, ftrace will be set to nop tracer, +# no events, no triggers, no filters, no function filters, +# no probes, and tracing on. + disable_tracing + reset_tracer + reset_trigger + reset_events_filter + disable_events + echo | tee set_ftrace_* set_graph_* stack_trace_filter set_event_pid
I just disabled function graph tracing, and this causes every test to fail.
tee: set_graph_*: Permission denied
-- Steve
Quoted 4 lines
tools/testing/selftests/ftrace/test.d/functions +4
-0+ echo > kprobe_events + echo > uprobe_events + enable_tracing +}
Masami Hiramatsu
maintainerRe: [PATCH -tip v2 2/6] selftests: ftrace: Initialize ftrace before each test
Quoted 61 lines · On Mon, 14 Nov 2016 13:12:00 -0500 Steven Rostedt <[email protected]> wrote:
Quoted 44 lines · On Sun, 30 Oct 2016 15:54:10 +0900 Masami Hiramatsu <[email protected]> wrote:
Reset ftrace to initial state before running each test. This fixes some test cases to enable tracing before starting trace test. This can avoid false-positive failure when previous testcase fails while disabling tracing.
Signed-off-by Masami Hiramatsu <[email protected]>Suggested-by Steven Rostedt <[email protected]>--- tools/testing/selftests/ftrace/ftracetest | 2 +- tools/testing/selftests/ftrace/test.d/functions | 25 +++++++++++++++++++++++ 2 files changed, 26 insertions(+), 1 deletion(-)tools/testing/selftests/ftrace/ftracetest +1
-1@@ -228,7 +228,7 @@ trap 'SIG_RESULT=$XFAIL' $SIG_XFAIL __run_test() { # testfile # setup PID and PPID, $$ is not updated. - (cd $TRACING_DIR; read PID _ < /proc/self/stat ; set -e; set -x; . $1) + (cd $TRACING_DIR; read PID _ < /proc/self/stat; set -e; set -x; initialize_ftrace; . $1) [ $? -ne 0 ] && kill -s $SIG_FAIL $SIG_PID }tools/testing/selftests/ftrace/test.d/functions +11
-0@@ -23,3 +23,28 @@ reset_trigger() { # reset all current setting triggers done } +reset_events_filter() { # reset all current setting filters + grep -v ^none events/*/*/filter | + while read line; do + echo 0 > `echo $line | cut -f1 -d:` + done +} + +disable_events() { + echo 0 > events/enable +} +tools/testing/selftests/ftrace/test.d/functions reset_trigger() { # reset all current setting triggers · line 46
Quoted 10 lines
tools/testing/selftests/ftrace/test.d/functions +10
-0+initialize_ftrace() { # Reset ftrace to initial-state +# As the initial state, ftrace will be set to nop tracer, +# no events, no triggers, no filters, no function filters, +# no probes, and tracing on. + disable_tracing + reset_tracer + reset_trigger + reset_events_filter + disable_events + echo | tee set_ftrace_* set_graph_* stack_trace_filter set_event_pidI just disabled function graph tracing, and this causes every test to fail.
Quoted 1 line
tee: set_graph_*: Permission denied
Oops, right. OK, I'll fix that.
Thanks!
Quoted 8 lines
-- Steve
Quoted 4 lines
tools/testing/selftests/ftrace/test.d/functions +4
-0+ echo > kprobe_events + echo > uprobe_events + enable_tracing +}
Signature · 1 line
Masami Hiramatsu <[email protected]>
Masami Hiramatsu
maintainerPATCH v2 3/6 selftests: ftrace: Hide ftracetest logs from git
In reply to Masami HiramatsuHide ftracetest result log directory from git.
--- tools/testing/selftests/ftrace/.gitignore | 1 + 1 file changed, 1 insertion(+) create mode 100644 tools/testing/selftests/ftrace/.gitignore
tools/testing/selftests/ftrace/.gitignore new file +1 -0
@@ -0,0 +1 @@ +logs
Masami Hiramatsu
maintainerPATCH v2 4/6 selftests: ftrace: Introduce TMPDIR for temporary files
In reply to Masami HiramatsuIntroduce TMPDIR variable which is removed after each test is done, so that the test script can put their temporary files in that.
--- tools/testing/selftests/ftrace/ftracetest | 2 ++ 1 file changed, 2 insertions(+)
tools/testing/selftests/ftrace/ftracetest +2 -0
@@ -236,6 +236,7 @@ __run_test() { # testfile run_test() { # testfile local testname=`basename $1` local testlog=`mktemp $LOG_DIR/${testname}-log.XXXXXX` + export TMPDIR=`mktemp -d /tmp/ftracetest-dir.XXXXXX` testcase $1 echo "execute: "$1 > $testlog SIG_RESULT=0
@@ -252,6 +253,7 @@ run_test() { # testfile catlog $testlog TOTAL_RESULT=1 fi + rm -rf $TMPDIR } # load in the helper functions
Masami Hiramatsu
maintainerPATCH v2 5/6 selftests: ftrace: Add a testcase for function filter glob match
In reply to Masami HiramatsuAdd function filter glob matching test case. This checks whether the kernel supports glob matching (front match, end match, middle match, side match, character class and '?').
Here is the test result.
-----
./ftracetest test.d/ftrace/func-filter-glob.tc
=== Ftrace unit tests ===
[1] ftrace - function glob filters [PASS]
# of passed: 1 # of failed: 0 # of unresolved: 0 # of untested: 0 # of unsupported: 0 # of xfailed: 0 # of undefined(test bug): 0 -----
--- .../ftrace/test.d/ftrace/func-filter-glob.tc | 49 ++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 tools/testing/selftests/ftrace/test.d/ftrace/func-filter-glob.tc
tools/testing/selftests/ftrace/test.d/ftrace/func-filter-glob.tc new file +49 -0
@@ -0,0 +1,49 @@ +#!/bin/sh +# description: ftrace - function glob filters + +# Make sure that function glob matching filter works. + +if ! grep -q function available_tracers; then + echo "no function tracer configured" + exit_unsupported +fi + +disable_tracing +clear_trace + +# filter by ?, schedule is always good +if ! echo "sch?dule" > set_ftrace_filter; then + # test for powerpc 64 + if ! echo ".sch?dule" > set_ftrace_filter; then + fail "can not enable schedule filter" + fi + cat set_ftrace_filter | grep '^.schedule$' +else + cat set_ftrace_filter | grep '^schedule$' +fi + +ftrace_filter_check() { # glob grep + echo "$1" > set_ftrace_filter + cut -f1 -d" " set_ftrace_filter > $TMPDIR/actual + cut -f1 -d" " available_filter_functions | grep "$2" > $TMPDIR/expected + DIFF=`diff $TMPDIR/actual $TMPDIR/expected` + test -z "$DIFF" +} + +# filter by *, front match +ftrace_filter_check '*schedule' '^.*schedule$' + +# filter by *, middle match +ftrace_filter_check '*schedule*' '^.*schedule.*$' + +# filter by *, end match +ftrace_filter_check 'schedule*' '^schedule.*$' + +# filter by *, both side match +ftrace_filter_check 'sch*ule' '^sch.*ule$' + +# filter by char class. +ftrace_filter_check '[Ss]y[Ss]_*' '^[Ss]y[Ss]_.*$' + +echo > set_ftrace_filter +enable_tracing
Masami Hiramatsu
maintainerPATCH v2 6/6 selftests: ftrace: Add a testcase for types of kprobe event
In reply to Masami HiramatsuAdd a testcase for types of kprobe event. This checks kprobe event can accept and correctly expressed the arguments typed as s32, u32, x32 and bitfield.
Here is the test result.
-----
# ./ftracetest test.d/kprobe/kprobe_args_type.tc === Ftrace unit tests === [1] Kprobes event arguments with types [PASS]
# of passed: 1 # of failed: 0 # of unresolved: 0 # of untested: 0 # of unsupported: 0 # of xfailed: 0 # of undefined(test bug): 0 -----
--- .../ftrace/test.d/kprobe/kprobe_args_type.tc | 37 ++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 tools/testing/selftests/ftrace/test.d/kprobe/kprobe_args_type.tc
tools/testing/selftests/ftrace/test.d/kprobe/kprobe_args_type.tc new file +37 -0
@@ -0,0 +1,37 @@ +#!/bin/sh +# description: Kprobes event arguments with types + +[ -f kprobe_events ] || exit_unsupported # this is configurable + +grep "x8/16/32/64" README > /dev/null || exit_unsupported # version issue + +echo 0 > events/enable +echo > kprobe_events +enable_tracing + +echo 'p:testprobe _do_fork $stack0:s32 $stack0:u32 $stack0:x32 $stack0:b8@4/32' > kprobe_events +grep testprobe kprobe_events +test -d events/kprobes/testprobe + +echo 1 > events/kprobes/testprobe/enable +( echo "forked") +echo 0 > events/kprobes/testprobe/enable +ARGS=`tail -n 1 trace | sed -e 's/.* arg1=\(.*\) arg2=\(.*\) arg3=\(.*\) arg4=\(.*\)/\1 \2 \3 \4/'` + +check_types() { + X1=`printf "%x" $1 | tail -c 8` + X2=`printf "%x" $2` + X3=`printf "%x" $3` + test $X1 = $X2 + test $X2 = $X3 + test 0x$X3 = $3 + + B4=`printf "%x" $4` + B3=`echo -n $X3 | tail -c 3 | head -c 2` + test $B3 = $B4 +} +check_types $ARGS + +echo "-:testprobe" >> kprobe_events +clear_trace +test -d events/kprobes/testprobe && exit 1 || exit 0
Masami Hiramatsu
maintainerPing?
Quoted 55 lines · On Sun, 30 Oct 2016 15:53:49 +0900 Masami Hiramatsu <[email protected]> wrote:
Hi,
Here is the 2nd version of the series of patches to add full glob matching support in ftrace and update ftracetest to test the glob matching and hexadecimal types.
Previous version is here:
https://lkml.org/lkml/2016/10/19/7I've update ftracetest to initialize ftrace before each testcase accordning to Steve's comment. In this series I've added a patch which makes git to ignore the directory for test results.
[1/6] Add full glob matching support on ftrace's
function filter and event filter expression.
[2/6] Initialize ftrace before running each testcase. [3/6] Hide logs direcotry from git.
[4/6] Introduce temporary directory for test cases,
which is used for storing temporary test data.
[5/6] Add a testcase for function-name glob matching [6/6] Add a testcase for types of event argumentsThanks,
---Masami Hiramatsu (6):
ftrace: Support full glob matching
selftests: ftrace: Initialize ftrace before each test
selftests: ftrace: Hide ftracetest logs from git
selftests: ftrace: Introduce TMPDIR for temporary files
selftests: ftrace: Add a testcase for function filter glob match
selftests: ftrace: Add a testcase for types of kprobe eventDocumentation/trace/events.txt | 9 +--- Documentation/trace/ftrace.txt | 9 +--- kernel/trace/Kconfig | 2 + kernel/trace/ftrace.c | 4 ++ kernel/trace/trace.c | 2 - kernel/trace/trace.h | 2 + kernel/trace/trace_events_filter.c | 17 +++++++ tools/testing/selftests/ftrace/.gitignore | 1 tools/testing/selftests/ftrace/ftracetest | 4 +- .../ftrace/test.d/ftrace/func-filter-glob.tc | 49 ++++++++++++++++++++ tools/testing/selftests/ftrace/test.d/functions | 25 ++++++++++ .../ftrace/test.d/kprobe/kprobe_args_type.tc | 37 +++++++++++++++ 12 files changed, 146 insertions(+), 15 deletions(-) create mode 100644 tools/testing/selftests/ftrace/.gitignore create mode 100644 tools/testing/selftests/ftrace/test.d/ftrace/func-filter-glob.tc create mode 100644 tools/testing/selftests/ftrace/test.d/kprobe/kprobe_args_type.tc--
Masami Hiramatsu (Linaro Ltd.) <[email protected]>
Signature · 1 line
Masami Hiramatsu <[email protected]>