-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
bootconfig/tracing/ktest: Add ktest examples of testing bootconfig
bootconfig is a new feature that appends scripts onto the initrd, and the kernel executes the scripts as an extended kernel command line. Need to add tests to test that the happened. To test the bootconfig properly, the initrd needs to be updated and the kernel rebooted. ktest is the perfect solution to perform these tests. Add a example bootconfig.conf in the tools/testing/ktest/examples/include and example bootconfig scripts in tools/testing/ktest/examples/bootconfig and also include verifier scripts that ktest will install on the target and run to make sure that the bootconfig options in the scripts took place after the target rebooted with the new initrd update. Link: https://lkml.kernel.org/r/20210618112647.6a81dec5@oasis.local.home Reviewed-by: Masami Hiramatsu <mhiramat@kernel.org> Signed-off-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
- Loading branch information
Steven Rostedt (VMware)
committed
Jun 24, 2021
1 parent
2db7ab6
commit 171ec34
Showing
9 changed files
with
385 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| ftrace.event { | ||
| task.task_newtask { | ||
| filter = "pid < 128" | ||
| enable | ||
| } | ||
| kprobes.vfs_read { | ||
| probes = "vfs_read $arg1 $arg2" | ||
| filter = "common_pid < 200" | ||
| enable | ||
| } | ||
| synthetic.initcall_latency { | ||
| fields = "unsigned long func", "u64 lat" | ||
| actions = "hist:keys=func.sym,lat:vals=lat:sort=lat" | ||
| } | ||
| initcall.initcall_start { | ||
| actions = "hist:keys=func:ts0=common_timestamp.usecs" | ||
| } | ||
| initcall.initcall_finish { | ||
| actions = "hist:keys=func:lat=common_timestamp.usecs-$ts0:onmatch(initcall.initcall_start).initcall_latency(func,$lat)" | ||
| } | ||
| } | ||
|
|
||
| ftrace.instance { | ||
| foo { | ||
| tracer = "function" | ||
| ftrace.filters = "user_*" | ||
| cpumask = 1 | ||
| options = nosym-addr | ||
| buffer_size = 512KB | ||
| trace_clock = mono | ||
| event.signal.signal_deliver.actions=snapshot | ||
| } | ||
| bar { | ||
| tracer = "function" | ||
| ftrace.filters = "kernel_*" | ||
| cpumask = 2 | ||
| trace_clock = x86-tsc | ||
| } | ||
| } | ||
|
|
||
| ftrace.alloc_snapshot | ||
|
|
||
| kernel { | ||
| trace_options = sym-addr | ||
| trace_event = "initcall:*" | ||
| trace_buf_size = 1M | ||
| ftrace = function | ||
| ftrace_filter = "vfs*" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| CONFIG_CMDLINE="bootconfig" |
15 changes: 15 additions & 0 deletions
15
tools/testing/ktest/examples/bootconfigs/functiongraph.bconf
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| ftrace { | ||
| tracing_on = 0 # off by default | ||
| tracer = function_graph | ||
| event.kprobes { | ||
| start_event { | ||
| probes = "pci_proc_init" | ||
| actions = "traceon" | ||
| } | ||
| end_event { | ||
| probes = "pci_proc_init%return" | ||
| actions = "traceoff" | ||
| } | ||
| } | ||
| } | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| ftrace { | ||
| tracer = function_graph; | ||
| options = event-fork, sym-addr, stacktrace; | ||
| buffer_size = 1M; | ||
| alloc_snapshot; | ||
| trace_clock = global; | ||
| events = "task:task_newtask", "initcall:*"; | ||
| event.sched.sched_process_exec { | ||
| filter = "pid < 128"; | ||
| } | ||
| instance.bar { | ||
| event.kprobes { | ||
| myevent { | ||
| probes = "vfs_read $arg2 $arg3"; | ||
| } | ||
| myevent2 { | ||
| probes = "vfs_write $arg2 +0($arg2):ustring $arg3"; | ||
| } | ||
| myevent3 { | ||
| probes = "initrd_load"; | ||
| } | ||
| enable | ||
| } | ||
| } | ||
| instance.foo { | ||
| tracer = function; | ||
| tracing_on = false; | ||
| }; | ||
| } | ||
| kernel { | ||
| ftrace_dump_on_oops = "orig_cpu" | ||
| traceoff_on_warning | ||
| } |
84 changes: 84 additions & 0 deletions
84
tools/testing/ktest/examples/bootconfigs/verify-boottrace.sh
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| #!/bin/sh | ||
|
|
||
| cd /sys/kernel/tracing | ||
|
|
||
| compare_file() { | ||
| file="$1" | ||
| val="$2" | ||
| content=`cat $file` | ||
| if [ "$content" != "$val" ]; then | ||
| echo "FAILED: $file has '$content', expected '$val'" | ||
| exit 1 | ||
| fi | ||
| } | ||
|
|
||
| compare_file_partial() { | ||
| file="$1" | ||
| val="$2" | ||
| content=`cat $file | sed -ne "/^$val/p"` | ||
| if [ -z "$content" ]; then | ||
| echo "FAILED: $file does not contain '$val'" | ||
| cat $file | ||
| exit 1 | ||
| fi | ||
| } | ||
|
|
||
| file_contains() { | ||
| file=$1 | ||
| val="$2" | ||
|
|
||
| if ! grep -q "$val" $file ; then | ||
| echo "FAILED: $file does not contain $val" | ||
| cat $file | ||
| exit 1 | ||
| fi | ||
| } | ||
|
|
||
| compare_mask() { | ||
| file=$1 | ||
| val="$2" | ||
|
|
||
| content=`cat $file | sed -ne "/^[0 ]*$val/p"` | ||
| if [ -z "$content" ]; then | ||
| echo "FAILED: $file does not have mask '$val'" | ||
| cat $file | ||
| exit 1 | ||
| fi | ||
| } | ||
|
|
||
| compare_file "events/task/task_newtask/filter" "pid < 128" | ||
| compare_file "events/task/task_newtask/enable" "1" | ||
|
|
||
| compare_file "events/kprobes/vfs_read/filter" "common_pid < 200" | ||
| compare_file "events/kprobes/vfs_read/enable" "1" | ||
|
|
||
| compare_file_partial "events/synthetic/initcall_latency/trigger" "hist:keys=func.sym,lat:vals=hitcount,lat:sort=lat" | ||
| compare_file_partial "events/synthetic/initcall_latency/enable" "0" | ||
|
|
||
| compare_file_partial "events/initcall/initcall_start/trigger" "hist:keys=func:vals=hitcount:ts0=common_timestamp.usecs" | ||
| compare_file_partial "events/initcall/initcall_start/enable" "1" | ||
|
|
||
| compare_file_partial "events/initcall/initcall_finish/trigger" 'hist:keys=func:vals=hitcount:lat=common_timestamp.usecs-\$ts0:sort=hitcount:size=2048:clock=global:onmatch(initcall.initcall_start).initcall_latency(func,\$lat)' | ||
| compare_file_partial "events/initcall/initcall_finish/enable" "1" | ||
|
|
||
| compare_file "instances/foo/current_tracer" "function" | ||
| file_contains "instances/foo/set_ftrace_filter" "^user" | ||
| compare_file "instances/foo/buffer_size_kb" "512" | ||
| compare_mask "instances/foo/tracing_cpumask" "1" | ||
| compare_file "instances/foo/options/sym-addr" "0" | ||
| file_contains "instances/foo/trace_clock" '\[mono\]' | ||
| compare_file_partial "instances/foo/events/signal/signal_deliver/trigger" "snapshot" | ||
|
|
||
| compare_file "instances/bar/current_tracer" "function" | ||
| file_contains "instances/bar/set_ftrace_filter" "^kernel" | ||
| compare_mask "instances/bar/tracing_cpumask" "2" | ||
| file_contains "instances/bar/trace_clock" '\[x86-tsc\]' | ||
|
|
||
| file_contains "snapshot" "Snapshot is allocated" | ||
| compare_file "options/sym-addr" "1" | ||
| compare_file "events/initcall/enable" "1" | ||
| compare_file "buffer_size_kb" "1027" | ||
| compare_file "current_tracer" "function" | ||
| file_contains "set_ftrace_filter" '^vfs' | ||
|
|
||
| exit 0 |
61 changes: 61 additions & 0 deletions
61
tools/testing/ktest/examples/bootconfigs/verify-functiongraph.sh
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| #!/bin/sh | ||
|
|
||
| cd /sys/kernel/tracing | ||
|
|
||
| compare_file() { | ||
| file="$1" | ||
| val="$2" | ||
| content=`cat $file` | ||
| if [ "$content" != "$val" ]; then | ||
| echo "FAILED: $file has '$content', expected '$val'" | ||
| exit 1 | ||
| fi | ||
| } | ||
|
|
||
| compare_file_partial() { | ||
| file="$1" | ||
| val="$2" | ||
| content=`cat $file | sed -ne "/^$val/p"` | ||
| if [ -z "$content" ]; then | ||
| echo "FAILED: $file does not contain '$val'" | ||
| cat $file | ||
| exit 1 | ||
| fi | ||
| } | ||
|
|
||
| file_contains() { | ||
| file=$1 | ||
| val="$2" | ||
|
|
||
| if ! grep -q "$val" $file ; then | ||
| echo "FAILED: $file does not contain $val" | ||
| cat $file | ||
| exit 1 | ||
| fi | ||
| } | ||
|
|
||
| compare_mask() { | ||
| file=$1 | ||
| val="$2" | ||
|
|
||
| content=`cat $file | sed -ne "/^[0 ]*$val/p"` | ||
| if [ -z "$content" ]; then | ||
| echo "FAILED: $file does not have mask '$val'" | ||
| cat $file | ||
| exit 1 | ||
| fi | ||
| } | ||
|
|
||
|
|
||
| compare_file "tracing_on" "0" | ||
| compare_file "current_tracer" "function_graph" | ||
|
|
||
| compare_file_partial "events/kprobes/start_event/enable" "1" | ||
| compare_file_partial "events/kprobes/start_event/trigger" "traceon" | ||
| file_contains "kprobe_events" 'start_event.*pci_proc_init' | ||
|
|
||
| compare_file_partial "events/kprobes/end_event/enable" "1" | ||
| compare_file_partial "events/kprobes/end_event/trigger" "traceoff" | ||
| file_contains "kprobe_events" '^r.*end_event.*pci_proc_init' | ||
|
|
||
| exit 0 |
72 changes: 72 additions & 0 deletions
72
tools/testing/ktest/examples/bootconfigs/verify-tracing.sh
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| #!/bin/sh | ||
|
|
||
| cd /sys/kernel/tracing | ||
|
|
||
| compare_file() { | ||
| file="$1" | ||
| val="$2" | ||
| content=`cat $file` | ||
| if [ "$content" != "$val" ]; then | ||
| echo "FAILED: $file has '$content', expected '$val'" | ||
| exit 1 | ||
| fi | ||
| } | ||
|
|
||
| compare_file_partial() { | ||
| file="$1" | ||
| val="$2" | ||
| content=`cat $file | sed -ne "/^$val/p"` | ||
| if [ -z "$content" ]; then | ||
| echo "FAILED: $file does not contain '$val'" | ||
| cat $file | ||
| exit 1 | ||
| fi | ||
| } | ||
|
|
||
| file_contains() { | ||
| file=$1 | ||
| val="$2" | ||
|
|
||
| if ! grep -q "$val" $file ; then | ||
| echo "FAILED: $file does not contain $val" | ||
| cat $file | ||
| exit 1 | ||
| fi | ||
| } | ||
|
|
||
| compare_mask() { | ||
| file=$1 | ||
| val="$2" | ||
|
|
||
| content=`cat $file | sed -ne "/^[0 ]*$val/p"` | ||
| if [ -z "$content" ]; then | ||
| echo "FAILED: $file does not have mask '$val'" | ||
| cat $file | ||
| exit 1 | ||
| fi | ||
| } | ||
|
|
||
| compare_file "current_tracer" "function_graph" | ||
| compare_file "options/event-fork" "1" | ||
| compare_file "options/sym-addr" "1" | ||
| compare_file "options/stacktrace" "1" | ||
| compare_file "buffer_size_kb" "1024" | ||
| file_contains "snapshot" "Snapshot is allocated" | ||
| file_contains "trace_clock" '\[global\]' | ||
|
|
||
| compare_file "events/initcall/enable" "1" | ||
| compare_file "events/task/task_newtask/enable" "1" | ||
| compare_file "events/sched/sched_process_exec/filter" "pid < 128" | ||
| compare_file "events/kprobes/enable" "1" | ||
|
|
||
| compare_file "instances/bar/events/kprobes/myevent/enable" "1" | ||
| compare_file "instances/bar/events/kprobes/myevent2/enable" "1" | ||
| compare_file "instances/bar/events/kprobes/myevent3/enable" "1" | ||
|
|
||
| compare_file "instances/foo/current_tracer" "function" | ||
| compare_file "instances/foo/tracing_on" "0" | ||
|
|
||
| compare_file "/proc/sys/kernel/ftrace_dump_on_oops" "2" | ||
| compare_file "/proc/sys/kernel/traceoff_on_warning" "1" | ||
|
|
||
| exit 0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| # bootconfig.conf | ||
| # | ||
| # Tests to test some bootconfig scripts | ||
|
|
||
| # List where on the target machine the initrd is used | ||
| INITRD := /boot/initramfs-test.img | ||
|
|
||
| # Install bootconfig on the target machine and define the path here. | ||
| BOOTCONFIG := /usr/bin/bootconfig | ||
|
|
||
| # Currenty we just build the .config in the BUILD_DIR | ||
| BUILD_TYPE := oldconfig | ||
|
|
||
| # Helper macro to run bootconfig on the target | ||
| # SSH is defined in include/defaults.conf | ||
| ADD_BOOTCONFIG := ${SSH} "${BOOTCONFIG} -d ${INITRD} && ${BOOTCONFIG} -a /tmp/${BOOTCONFIG_FILE} ${INITRD}" | ||
|
|
||
| # This copies a bootconfig script to the target and then will | ||
| # add it to the initrd. SSH_USER is defined in include/defaults.conf | ||
| # and MACHINE is defined in the example configs. | ||
| BOOTCONFIG_TEST_PREP = scp ${BOOTCONFIG_PATH}${BOOTCONFIG_FILE} ${SSH_USER}@${MACHINE}:/tmp && ${ADD_BOOTCONFIG} | ||
|
|
||
| # When a test is complete, remove the bootconfig from the initrd. | ||
| CLEAR_BOOTCONFIG := ${SSH} "${BOOTCONFIG} -d ${INITRD}" | ||
|
|
||
| # Run a verifier on the target after it had booted, to make sure that the | ||
| # bootconfig script did what it was expected to do | ||
| DO_TEST = scp ${BOOTCONFIG_PATH}${BOOTCONFIG_VERIFY} ${SSH_USER}@${MACHINE}:/tmp && ${SSH} /tmp/${BOOTCONFIG_VERIFY} | ||
|
|
||
| # Comment this out to not run the boot configs | ||
| RUN_BOOTCONFIG := 1 | ||
|
|
||
| TEST_START IF DEFINED RUN_BOOTCONFIG | ||
| TEST_TYPE = test | ||
| TEST_NAME = bootconfig boottrace | ||
| # Just testing the bootconfig on initrd, no need to build the kernel | ||
| BUILD_TYPE = nobuild | ||
| BOOTCONFIG_FILE = boottrace.bconf | ||
| BOOTCONFIG_VERIFY = verify-boottrace.sh | ||
| ADD_CONFIG = ${ADD_CONFIG} ${BOOTCONFIG_PATH}/config-bootconfig | ||
| PRE_TEST = ${BOOTCONFIG_TEST_PREP} | ||
| PRE_TEST_DIE = 1 | ||
| TEST = ${DO_TEST} | ||
| POST_TEST = ${CLEAR_BOOTCONFIG} | ||
|
|
||
| TEST_START IF DEFINED RUN_BOOTCONFIG | ||
| TEST_TYPE = test | ||
| TEST_NAME = bootconfig function graph | ||
| BUILD_TYPE = nobuild | ||
| BOOTCONFIG_FILE = functiongraph.bconf | ||
| BOOTCONFIG_VERIFY = verify-functiongraph.sh | ||
| ADD_CONFIG = ${ADD_CONFIG} ${BOOTCONFIG_PATH}/config-bootconfig | ||
| PRE_TEST = ${BOOTCONFIG_TEST_PREP} | ||
| PRE_TEST_DIE = 1 | ||
| TEST = ${DO_TEST} | ||
| POST_TEST = ${CLEAR_BOOTCONFIG} | ||
|
|
||
| TEST_START IF DEFINED RUN_BOOTCONFIG | ||
| TEST_TYPE = test | ||
| TEST_NAME = bootconfig tracing | ||
| BUILD_TYPE = nobuild | ||
| BOOTCONFIG_FILE = tracing.bconf | ||
| BOOTCONFIG_VERIFY = verify-tracing.sh | ||
| ADD_CONFIG = ${ADD_CONFIG} ${BOOTCONFIG_PATH}/config-bootconfig | ||
| PRE_TEST = ${BOOTCONFIG_TEST_PREP} | ||
| PRE_TEST_DIE = 1 | ||
| TEST = ${DO_TEST} | ||
| POST_TEST = ${CLEAR_BOOTCONFIG} | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters