xref: /linux/tools/testing/selftests/ftrace/README (revision 6e68e6c5e4b67a02aaa406da6124ea5cae7d5e10)
1*6e68e6c5SMasami HiramatsuLinux Ftrace Testcases
2*6e68e6c5SMasami Hiramatsu
3*6e68e6c5SMasami HiramatsuThis is a collection of testcases for ftrace tracing feature in the Linux
4*6e68e6c5SMasami Hiramatsukernel. Since ftrace exports interfaces via the debugfs, we just need
5*6e68e6c5SMasami Hiramatsushell scripts for testing. Feel free to add new test cases.
6*6e68e6c5SMasami Hiramatsu
7*6e68e6c5SMasami HiramatsuRunning the ftrace testcases
8*6e68e6c5SMasami Hiramatsu============================
9*6e68e6c5SMasami Hiramatsu
10*6e68e6c5SMasami HiramatsuAt first, you need to be the root user to run this script.
11*6e68e6c5SMasami HiramatsuTo run all testcases:
12*6e68e6c5SMasami Hiramatsu
13*6e68e6c5SMasami Hiramatsu  $ sudo ./ftracetest
14*6e68e6c5SMasami Hiramatsu
15*6e68e6c5SMasami HiramatsuTo run specific testcases:
16*6e68e6c5SMasami Hiramatsu
17*6e68e6c5SMasami Hiramatsu  # ./ftracetest test.d/basic3.tc
18*6e68e6c5SMasami Hiramatsu
19*6e68e6c5SMasami HiramatsuOr you can also run testcases under given directory:
20*6e68e6c5SMasami Hiramatsu
21*6e68e6c5SMasami Hiramatsu  # ./ftracetest test.d/kprobe/
22*6e68e6c5SMasami Hiramatsu
23*6e68e6c5SMasami HiramatsuContributing new testcases
24*6e68e6c5SMasami Hiramatsu==========================
25*6e68e6c5SMasami Hiramatsu
26*6e68e6c5SMasami HiramatsuCopy test.d/template to your testcase (whose filename must have *.tc
27*6e68e6c5SMasami Hiramatsuextension) and rewrite the test description line.
28*6e68e6c5SMasami Hiramatsu
29*6e68e6c5SMasami Hiramatsu * The working directory of the script is <debugfs>/tracing/.
30*6e68e6c5SMasami Hiramatsu
31*6e68e6c5SMasami Hiramatsu * Take care with side effects as the tests are run with root privilege.
32*6e68e6c5SMasami Hiramatsu
33*6e68e6c5SMasami Hiramatsu * The tests should not run for a long period of time (more than 1 min.)
34*6e68e6c5SMasami Hiramatsu   These are to be unit tests.
35*6e68e6c5SMasami Hiramatsu
36*6e68e6c5SMasami Hiramatsu * You can add a directory for your testcases under test.d/ if needed.
37*6e68e6c5SMasami Hiramatsu
38*6e68e6c5SMasami Hiramatsu * The test cases should run on dash (busybox shell) for testing on
39*6e68e6c5SMasami Hiramatsu   minimal cross-build environments.
40*6e68e6c5SMasami Hiramatsu
41*6e68e6c5SMasami HiramatsuTODO
42*6e68e6c5SMasami Hiramatsu====
43*6e68e6c5SMasami Hiramatsu
44*6e68e6c5SMasami Hiramatsu * Fancy colored output :)
45*6e68e6c5SMasami Hiramatsu
46