tools/bootconfig: Add a script to generate ftrace shell-command from bootconfig
[linux-2.6-microblaze.git] / tools / bootconfig / scripts / bconf2ftrace.sh
1 #!/bin/sh
2 # SPDX-License-Identifier: GPL-2.0-only
3
4 usage() {
5         echo "Ftrace boottime trace test tool"
6         echo "Usage: $0 [--apply] [--debug] BOOTCONFIG-FILE"
7         echo "    --apply: Test actual apply to tracefs (need sudo)"
8         exit 1
9 }
10
11 [ $# -eq 0 ] && usage
12
13 BCONF=
14 DEBUG=
15 APPLY=
16 while [ x"$1" != x ]; do
17         case "$1" in
18         "--debug")
19                 DEBUG=$1;;
20         "--apply")
21                 APPLY=$1;;
22         *)
23                 [ ! -f $1 ] && usage
24                 BCONF=$1;;
25         esac
26         shift 1
27 done
28
29 if [ x"$APPLY" != x ]; then
30         if [ `id -u` -ne 0 ]; then
31                 echo "This must be run by root user. Try sudo." 1>&2
32                 exec sudo $0 $DEBUG $APPLY $BCONF
33         fi
34 fi
35
36 run_cmd() { # command
37         echo "$*"
38         if [ x"$APPLY" != x ]; then # apply command
39                 eval $*
40         fi
41 }
42
43 if [ x"$DEBUG" != x ]; then
44         set -x
45 fi
46
47 TRACEFS=`grep -m 1 -w tracefs /proc/mounts | cut -f 2 -d " "`
48 if [ -z "$TRACEFS" ]; then
49         if ! grep -wq debugfs /proc/mounts; then
50                 echo "Error: No tracefs/debugfs was mounted." 1>&2
51                 exit 1
52         fi
53         TRACEFS=`grep -m 1 -w debugfs /proc/mounts | cut -f 2 -d " "`/tracing
54         if [ ! -d $TRACEFS ]; then
55                 echo "Error: ftrace is not enabled on this kernel." 1>&2
56                 exit 1
57         fi
58 fi
59
60 . `dirname $0`/xbc.sh
61
62 ######## main #########
63 set -e
64
65 xbc_init $BCONF
66
67 set_value_of() { # key file
68         if xbc_has_key $1; then
69                 val=`xbc_get_val $1 1`
70                 run_cmd "echo '$val' >> $2"
71         fi
72 }
73
74 set_array_of() { # key file
75         if xbc_has_key $1; then
76                 xbc_get_val $1 | while read line; do
77                         run_cmd "echo '$line' >> $2"
78                 done
79         fi
80 }
81
82 compose_synth() { # event_name branch
83         echo -n "$1 "
84         xbc_get_val $2 | while read field; do echo -n "$field; "; done
85 }
86
87 setup_event() { # prefix group event [instance]
88         branch=$1.$2.$3
89         if [ "$4" ]; then
90                 eventdir="$TRACEFS/instances/$4/events/$2/$3"
91         else
92                 eventdir="$TRACEFS/events/$2/$3"
93         fi
94         case $2 in
95         kprobes)
96                 xbc_get_val ${branch}.probes | while read line; do
97                         run_cmd "echo 'p:kprobes/$3 $line' >> $TRACEFS/kprobe_events"
98                 done
99                 ;;
100         synthetic)
101                 run_cmd "echo '`compose_synth $3 ${branch}.fields`' >> $TRACEFS/synthetic_events"
102                 ;;
103         esac
104
105         set_value_of ${branch}.filter ${eventdir}/filter
106         set_array_of ${branch}.actions ${eventdir}/trigger
107
108         if xbc_has_key ${branch}.enable; then
109                 run_cmd "echo 1 > ${eventdir}/enable"
110         fi
111 }
112
113 setup_events() { # prefix("ftrace" or "ftrace.instance.INSTANCE") [instance]
114         prefix="${1}.event"
115         if xbc_has_branch ${1}.event; then
116                 for grpev in `xbc_subkeys ${1}.event 2`; do
117                         setup_event $prefix ${grpev%.*} ${grpev#*.} $2
118                 done
119         fi
120 }
121
122 size2kb() { # size[KB|MB]
123         case $1 in
124         *KB)
125                 echo ${1%KB};;
126         *MB)
127                 expr ${1%MB} \* 1024;;
128         *)
129                 expr $1 / 1024 ;;
130         esac
131 }
132
133 setup_instance() { # [instance]
134         if [ "$1" ]; then
135                 instance="ftrace.instance.${1}"
136                 instancedir=$TRACEFS/instances/$1
137         else
138                 instance="ftrace"
139                 instancedir=$TRACEFS
140         fi
141
142         set_array_of ${instance}.options ${instancedir}/trace_options
143         set_value_of ${instance}.trace_clock ${instancedir}/trace_clock
144         set_value_of ${instance}.cpumask ${instancedir}/tracing_cpumask
145         set_value_of ${instance}.tracer ${instancedir}/current_tracer
146         set_array_of ${instance}.ftrace.filters \
147                 ${instancedir}/set_ftrace_filter
148         set_array_of ${instance}.ftrace.notrace \
149                 ${instancedir}/set_ftrace_notrace
150
151         if xbc_has_key ${instance}.alloc_snapshot; then
152                 run_cmd "echo 1 > ${instancedir}/snapshot"
153         fi
154
155         if xbc_has_key ${instance}.buffer_size; then
156                 size=`xbc_get_val ${instance}.buffer_size 1`
157                 size=`eval size2kb $size`
158                 run_cmd "echo $size >> ${instancedir}/buffer_size_kb"
159         fi
160
161         setup_events ${instance} $1
162         set_array_of ${instance}.events ${instancedir}/set_event
163 }
164
165 # ftrace global configs (kernel.*)
166 if xbc_has_key "kernel.dump_on_oops"; then
167         dump_mode=`xbc_get_val "kernel.dump_on_oops" 1`
168         [ "$dump_mode" ] && dump_mode=`eval echo $dump_mode` || dump_mode=1
169         run_cmd "echo \"$dump_mode\" > /proc/sys/kernel/ftrace_dump_on_oops"
170 fi
171
172 set_value_of kernel.fgraph_max_depth $TRACEFS/max_graph_depth
173 set_array_of kernel.fgraph_filters $TRACEFS/set_graph_function
174 set_array_of kernel.fgraph_notraces $TRACEFS/set_graph_notrace
175
176 # Per-instance/per-event configs
177 if ! xbc_has_branch "ftrace" ; then
178         exit 0
179 fi
180
181 setup_instance # root instance
182
183 if xbc_has_branch "ftrace.instance"; then
184         for i in `xbc_subkeys "ftrace.instance" 1`; do
185                 run_cmd "mkdir -p $TRACEFS/instances/$i"
186                 setup_instance $i
187         done
188 fi
189