Merge branch 'ja/doc-synopsis-markup'
[git/gitster.git] / t / t0211-trace2-perf.sh
blobdddc130560ba6150fc5f5eac36c65ff76a2d31a1
1 #!/bin/sh
3 test_description='test trace2 facility (perf target)'
5 TEST_PASSES_SANITIZE_LEAK=false
6 . ./test-lib.sh
8 # Turn off any inherited trace2 settings for this test.
9 sane_unset GIT_TRACE2 GIT_TRACE2_PERF GIT_TRACE2_EVENT
10 sane_unset GIT_TRACE2_PERF_BRIEF
11 sane_unset GIT_TRACE2_CONFIG_PARAMS
13 # Add t/helper directory to PATH so that we can use a relative
14 # path to run nested instances of test-tool.exe (see 004child).
15 # This helps with HEREDOC comparisons later.
16 TTDIR="$GIT_BUILD_DIR/t/helper/" && export TTDIR
17 PATH="$TTDIR:$PATH" && export PATH
19 # Warning: use of 'test_cmp' may run test-tool.exe and/or git.exe
20 # Warning: to do the actual diff/comparison, so the HEREDOCs here
21 # Warning: only cover our actual calls to test-tool and/or git.
22 # Warning: So you may see extra lines in artifact files when
23 # Warning: interactively debugging.
25 V=$(git version | sed -e 's/^git version //') && export V
27 # There are multiple trace2 targets: normal, perf, and event.
28 # Trace2 events will/can be written to each active target (subject
29 # to whatever filtering that target decides to do).
30 # Test each target independently.
32 # Defer setting GIT_TRACE2_PERF until the actual command we want to
33 # test because hidden git and test-tool commands in the test
34 # harness can contaminate our output.
36 # Enable "brief" feature which turns off the prefix:
37 # "<clock> <file>:<line> | <nr_parents> | "
38 GIT_TRACE2_PERF_BRIEF=1 && export GIT_TRACE2_PERF_BRIEF
40 # Repeat some of the t0210 tests using the perf target stream instead of
41 # the normal stream.
43 # Tokens here of the form _FIELD_ have been replaced in the observed output.
45 # Verb 001return
47 # Implicit return from cmd_<verb> function propagates <code>.
49 test_expect_success 'perf stream, return code 0' '
50 test_when_finished "rm trace.perf actual expect" &&
51 GIT_TRACE2_PERF="$(pwd)/trace.perf" test-tool trace2 001return 0 &&
52 perl "$TEST_DIRECTORY/t0211/scrub_perf.perl" <trace.perf >actual &&
53 cat >expect <<-EOF &&
54 d0|main|version|||||$V
55 d0|main|start||_T_ABS_|||_EXE_ trace2 001return 0
56 d0|main|cmd_name|||||trace2 (trace2)
57 d0|main|exit||_T_ABS_|||code:0
58 d0|main|atexit||_T_ABS_|||code:0
59 EOF
60 test_cmp expect actual
63 test_expect_success 'perf stream, return code 1' '
64 test_when_finished "rm trace.perf actual expect" &&
65 test_must_fail env GIT_TRACE2_PERF="$(pwd)/trace.perf" test-tool trace2 001return 1 &&
66 perl "$TEST_DIRECTORY/t0211/scrub_perf.perl" <trace.perf >actual &&
67 cat >expect <<-EOF &&
68 d0|main|version|||||$V
69 d0|main|start||_T_ABS_|||_EXE_ trace2 001return 1
70 d0|main|cmd_name|||||trace2 (trace2)
71 d0|main|exit||_T_ABS_|||code:1
72 d0|main|atexit||_T_ABS_|||code:1
73 EOF
74 test_cmp expect actual
77 # Verb 003error
79 # To the above, add multiple 'error <msg>' events
81 test_expect_success 'perf stream, error event' '
82 test_when_finished "rm trace.perf actual expect" &&
83 GIT_TRACE2_PERF="$(pwd)/trace.perf" test-tool trace2 003error "hello world" "this is a test" &&
84 perl "$TEST_DIRECTORY/t0211/scrub_perf.perl" <trace.perf >actual &&
85 cat >expect <<-EOF &&
86 d0|main|version|||||$V
87 d0|main|start||_T_ABS_|||_EXE_ trace2 003error '\''hello world'\'' '\''this is a test'\''
88 d0|main|cmd_name|||||trace2 (trace2)
89 d0|main|error|||||hello world
90 d0|main|error|||||this is a test
91 d0|main|exit||_T_ABS_|||code:0
92 d0|main|atexit||_T_ABS_|||code:0
93 EOF
94 test_cmp expect actual
97 # Verb 004child
99 # Test nested spawning of child processes.
101 # Conceptually, this looks like:
102 # P1: TT trace2 004child
103 # P2: |--- TT trace2 004child
104 # P3: |--- TT trace2 001return 0
106 # Which should generate events:
107 # P1: version
108 # P1: start
109 # P1: cmd_name
110 # P1: child_start
111 # P2: version
112 # P2: start
113 # P2: cmd_name
114 # P2: child_start
115 # P3: version
116 # P3: start
117 # P3: cmd_name
118 # P3: exit
119 # P3: atexit
120 # P2: child_exit
121 # P2: exit
122 # P2: atexit
123 # P1: child_exit
124 # P1: exit
125 # P1: atexit
127 test_expect_success 'perf stream, child processes' '
128 test_when_finished "rm trace.perf actual expect" &&
129 GIT_TRACE2_PERF="$(pwd)/trace.perf" test-tool trace2 004child test-tool trace2 004child test-tool trace2 001return 0 &&
130 perl "$TEST_DIRECTORY/t0211/scrub_perf.perl" <trace.perf >actual &&
131 cat >expect <<-EOF &&
132 d0|main|version|||||$V
133 d0|main|start||_T_ABS_|||_EXE_ trace2 004child test-tool trace2 004child test-tool trace2 001return 0
134 d0|main|cmd_name|||||trace2 (trace2)
135 d0|main|child_start||_T_ABS_|||[ch0] class:? argv:[test-tool trace2 004child test-tool trace2 001return 0]
136 d1|main|version|||||$V
137 d1|main|start||_T_ABS_|||_EXE_ trace2 004child test-tool trace2 001return 0
138 d1|main|cmd_name|||||trace2 (trace2/trace2)
139 d1|main|child_start||_T_ABS_|||[ch0] class:? argv:[test-tool trace2 001return 0]
140 d2|main|version|||||$V
141 d2|main|start||_T_ABS_|||_EXE_ trace2 001return 0
142 d2|main|cmd_name|||||trace2 (trace2/trace2/trace2)
143 d2|main|exit||_T_ABS_|||code:0
144 d2|main|atexit||_T_ABS_|||code:0
145 d1|main|child_exit||_T_ABS_|_T_REL_||[ch0] pid:_PID_ code:0
146 d1|main|exit||_T_ABS_|||code:0
147 d1|main|atexit||_T_ABS_|||code:0
148 d0|main|child_exit||_T_ABS_|_T_REL_||[ch0] pid:_PID_ code:0
149 d0|main|exit||_T_ABS_|||code:0
150 d0|main|atexit||_T_ABS_|||code:0
152 test_cmp expect actual
155 sane_unset GIT_TRACE2_PERF_BRIEF
157 # Now test without environment variables and get all Trace2 settings
158 # from the global config.
160 test_expect_success 'using global config, perf stream, return code 0' '
161 test_when_finished "rm trace.perf actual expect" &&
162 test_config_global trace2.perfBrief 1 &&
163 test_config_global trace2.perfTarget "$(pwd)/trace.perf" &&
164 test-tool trace2 001return 0 &&
165 perl "$TEST_DIRECTORY/t0211/scrub_perf.perl" <trace.perf >actual &&
166 cat >expect <<-EOF &&
167 d0|main|version|||||$V
168 d0|main|start||_T_ABS_|||_EXE_ trace2 001return 0
169 d0|main|cmd_name|||||trace2 (trace2)
170 d0|main|exit||_T_ABS_|||code:0
171 d0|main|atexit||_T_ABS_|||code:0
173 test_cmp expect actual
176 # Exercise the stopwatch timers in a loop and confirm that we have
177 # as many start/stop intervals as expected. We cannot really test the
178 # actual (total, min, max) timer values, so we have to assume that they
179 # are good, but we can verify the interval count.
181 # The timer "test/test1" should only emit a global summary "timer" event.
182 # The timer "test/test2" should emit per-thread "th_timer" events and a
183 # global summary "timer" event.
185 have_timer_event () {
186 thread=$1 event=$2 category=$3 name=$4 intervals=$5 file=$6 &&
188 pattern="d0|${thread}|${event}||||${category}|name:${name} intervals:${intervals}" &&
190 grep "${pattern}" ${file}
193 test_expect_success 'stopwatch timer test/test1' '
194 test_when_finished "rm trace.perf actual" &&
195 test_config_global trace2.perfBrief 1 &&
196 test_config_global trace2.perfTarget "$(pwd)/trace.perf" &&
198 # Use the timer "test1" 5 times from "main".
199 test-tool trace2 100timer 5 10 &&
201 perl "$TEST_DIRECTORY/t0211/scrub_perf.perl" <trace.perf >actual &&
203 have_timer_event "main" "timer" "test" "test1" 5 actual
206 test_expect_success PTHREADS 'stopwatch timer test/test2' '
207 test_when_finished "rm trace.perf actual" &&
208 test_config_global trace2.perfBrief 1 &&
209 test_config_global trace2.perfTarget "$(pwd)/trace.perf" &&
211 # Use the timer "test2" 5 times each in 3 threads.
212 test-tool trace2 101timer 5 10 3 &&
214 perl "$TEST_DIRECTORY/t0211/scrub_perf.perl" <trace.perf >actual &&
216 # So we should have 3 per-thread events of 5 each.
217 have_timer_event "th01:ut_101" "th_timer" "test" "test2" 5 actual &&
218 have_timer_event "th02:ut_101" "th_timer" "test" "test2" 5 actual &&
219 have_timer_event "th03:ut_101" "th_timer" "test" "test2" 5 actual &&
221 # And we should have 15 total uses.
222 have_timer_event "main" "timer" "test" "test2" 15 actual
225 # Exercise the global counters and confirm that we get the expected values.
227 # The counter "test/test1" should only emit a global summary "counter" event.
228 # The counter "test/test2" could emit per-thread "th_counter" events and a
229 # global summary "counter" event.
231 have_counter_event () {
232 thread=$1 event=$2 category=$3 name=$4 value=$5 file=$6 &&
234 pattern="d0|${thread}|${event}||||${category}|name:${name} value:${value}" &&
236 grep "${pattern}" ${file}
239 test_expect_success 'global counter test/test1' '
240 test_when_finished "rm trace.perf actual" &&
241 test_config_global trace2.perfBrief 1 &&
242 test_config_global trace2.perfTarget "$(pwd)/trace.perf" &&
244 # Use the counter "test1" and add n integers.
245 test-tool trace2 200counter 1 2 3 4 5 &&
247 perl "$TEST_DIRECTORY/t0211/scrub_perf.perl" <trace.perf >actual &&
249 have_counter_event "main" "counter" "test" "test1" 15 actual
252 test_expect_success PTHREADS 'global counter test/test2' '
253 test_when_finished "rm trace.perf actual" &&
254 test_config_global trace2.perfBrief 1 &&
255 test_config_global trace2.perfTarget "$(pwd)/trace.perf" &&
257 # Add 2 integers to the counter "test2" in each of 3 threads.
258 test-tool trace2 201counter 7 13 3 &&
260 perl "$TEST_DIRECTORY/t0211/scrub_perf.perl" <trace.perf >actual &&
262 # So we should have 3 per-thread events of 5 each.
263 have_counter_event "th01:ut_201" "th_counter" "test" "test2" 20 actual &&
264 have_counter_event "th02:ut_201" "th_counter" "test" "test2" 20 actual &&
265 have_counter_event "th03:ut_201" "th_counter" "test" "test2" 20 actual &&
267 # And we should have a single event with the total across all threads.
268 have_counter_event "main" "counter" "test" "test2" 60 actual
271 test_expect_success 'unsafe URLs are redacted by default' '
272 test_when_finished \
273 "rm -r actual trace.perf unredacted.perf clone clone2" &&
275 test_config_global \
276 "url.$(pwd).insteadOf" https://user:pwd@example.com/ &&
277 test_config_global trace2.configParams "core.*,remote.*.url" &&
279 GIT_TRACE2_PERF="$(pwd)/trace.perf" \
280 git clone https://user:pwd@example.com/ clone &&
281 ! grep user:pwd trace.perf &&
283 GIT_TRACE2_REDACT=0 GIT_TRACE2_PERF="$(pwd)/unredacted.perf" \
284 git clone https://user:pwd@example.com/ clone2 &&
285 perl "$TEST_DIRECTORY/t0211/scrub_perf.perl" <unredacted.perf >actual &&
286 grep "d0|main|start|.* clone https://user:pwd@example.com" actual &&
287 grep "d0|main|def_param|.*|remote.origin.url:https://user:pwd@example.com" actual
290 # Confirm that the requested command produces a "cmd_name" and a
291 # set of "def_param" events.
293 try_simple () {
294 test_when_finished "rm prop.perf actual" &&
296 cmd=$1 &&
297 cmd_name=$2 &&
299 test_config_global "trace2.configParams" "cfg.prop.*" &&
300 test_config_global "trace2.envvars" "ENV_PROP_FOO,ENV_PROP_BAR" &&
302 test_config_global "cfg.prop.foo" "red" &&
304 ENV_PROP_FOO=blue \
305 GIT_TRACE2_PERF="$(pwd)/prop.perf" \
306 $cmd &&
307 perl "$TEST_DIRECTORY/t0211/scrub_perf.perl" <prop.perf >actual &&
308 grep "d0|main|cmd_name|.*|$cmd_name" actual &&
309 grep "d0|main|def_param|.*|cfg.prop.foo:red" actual &&
310 grep "d0|main|def_param|.*|ENV_PROP_FOO:blue" actual
313 # Representative mainstream builtin Git command dispatched
314 # in run_builtin() in git.c
316 test_expect_success 'expect def_params for normal builtin command' '
317 try_simple "git version" "version"
320 # Representative query command dispatched in handle_options()
321 # in git.c
323 test_expect_success 'expect def_params for query command' '
324 try_simple "git --man-path" "_query_"
327 # remote-curl.c does not use the builtin setup in git.c, so confirm
328 # that executables built from remote-curl.c emit def_params.
330 # Also tests the dashed-command handling where "git foo" silently
331 # spawns "git-foo". Make sure that both commands should emit
332 # def_params.
334 # Pass bogus arguments to remote-https and allow the command to fail
335 # because we don't actually have a remote to fetch from. We just want
336 # to see the run-dashed code run an executable built from
337 # remote-curl.c rather than git.c. Confirm that we get def_param
338 # events from both layers.
340 test_expect_success LIBCURL \
341 'expect def_params for remote-curl and _run_dashed_' '
342 test_when_finished "rm prop.perf actual" &&
344 test_config_global "trace2.configParams" "cfg.prop.*" &&
345 test_config_global "trace2.envvars" "ENV_PROP_FOO,ENV_PROP_BAR" &&
347 test_config_global "cfg.prop.foo" "red" &&
349 test_might_fail env \
350 ENV_PROP_FOO=blue \
351 GIT_TRACE2_PERF="$(pwd)/prop.perf" \
352 git remote-http x y &&
354 perl "$TEST_DIRECTORY/t0211/scrub_perf.perl" <prop.perf >actual &&
356 grep "d0|main|cmd_name|.*|_run_dashed_" actual &&
357 grep "d0|main|def_param|.*|cfg.prop.foo:red" actual &&
358 grep "d0|main|def_param|.*|ENV_PROP_FOO:blue" actual &&
360 grep "d1|main|cmd_name|.*|remote-curl" actual &&
361 grep "d1|main|def_param|.*|cfg.prop.foo:red" actual &&
362 grep "d1|main|def_param|.*|ENV_PROP_FOO:blue" actual
365 # Similarly, `git-http-fetch` is not built from git.c so do a
366 # trivial fetch so that the main git.c run-dashed code spawns
367 # an executable built from http-fetch.c. Confirm that we get
368 # def_param events from both layers.
370 test_expect_success LIBCURL \
371 'expect def_params for http-fetch and _run_dashed_' '
372 test_when_finished "rm prop.perf actual" &&
374 test_config_global "trace2.configParams" "cfg.prop.*" &&
375 test_config_global "trace2.envvars" "ENV_PROP_FOO,ENV_PROP_BAR" &&
377 test_config_global "cfg.prop.foo" "red" &&
379 test_might_fail env \
380 ENV_PROP_FOO=blue \
381 GIT_TRACE2_PERF="$(pwd)/prop.perf" \
382 git http-fetch --stdin file:/// <<-EOF &&
385 perl "$TEST_DIRECTORY/t0211/scrub_perf.perl" <prop.perf >actual &&
387 grep "d0|main|cmd_name|.*|_run_dashed_" actual &&
388 grep "d0|main|def_param|.*|cfg.prop.foo:red" actual &&
389 grep "d0|main|def_param|.*|ENV_PROP_FOO:blue" actual &&
391 grep "d1|main|cmd_name|.*|http-fetch" actual &&
392 grep "d1|main|def_param|.*|cfg.prop.foo:red" actual &&
393 grep "d1|main|def_param|.*|ENV_PROP_FOO:blue" actual
396 # Historically, alias expansion explicitly emitted the def_param
397 # events (independent of whether the command was a builtin, a Git
398 # command or arbitrary shell command) so that it wasn't dependent
399 # upon the unpeeling of the alias. Let's make sure that we preserve
400 # the net effect.
402 test_expect_success 'expect def_params during git alias expansion' '
403 test_when_finished "rm prop.perf actual" &&
405 test_config_global "trace2.configParams" "cfg.prop.*" &&
406 test_config_global "trace2.envvars" "ENV_PROP_FOO,ENV_PROP_BAR" &&
408 test_config_global "cfg.prop.foo" "red" &&
410 test_config_global "alias.xxx" "version" &&
412 ENV_PROP_FOO=blue \
413 GIT_TRACE2_PERF="$(pwd)/prop.perf" \
414 git xxx &&
416 perl "$TEST_DIRECTORY/t0211/scrub_perf.perl" <prop.perf >actual &&
418 # "git xxx" is first mapped to "git-xxx" and the child will fail.
419 grep "d0|main|cmd_name|.*|_run_dashed_ (_run_dashed_)" actual &&
421 # We unpeel that and substitute "version" into "xxx" (giving
422 # "git version") and update the cmd_name event.
423 grep "d0|main|cmd_name|.*|_run_git_alias_ (_run_dashed_/_run_git_alias_)" actual &&
425 # These def_param events could be associated with either of the
426 # above cmd_name events. It does not matter.
427 grep "d0|main|def_param|.*|cfg.prop.foo:red" actual &&
428 grep "d0|main|def_param|.*|ENV_PROP_FOO:blue" actual &&
430 # The "git version" child sees a different cmd_name hierarchy.
431 # Also test the def_param (only for completeness).
432 grep "d1|main|cmd_name|.*|version (_run_dashed_/_run_git_alias_/version)" actual &&
433 grep "d1|main|def_param|.*|cfg.prop.foo:red" actual &&
434 grep "d1|main|def_param|.*|ENV_PROP_FOO:blue" actual
437 test_expect_success 'expect def_params during shell alias expansion' '
438 test_when_finished "rm prop.perf actual" &&
440 test_config_global "trace2.configParams" "cfg.prop.*" &&
441 test_config_global "trace2.envvars" "ENV_PROP_FOO,ENV_PROP_BAR" &&
443 test_config_global "cfg.prop.foo" "red" &&
445 test_config_global "alias.xxx" "!git version" &&
447 ENV_PROP_FOO=blue \
448 GIT_TRACE2_PERF="$(pwd)/prop.perf" \
449 git xxx &&
451 perl "$TEST_DIRECTORY/t0211/scrub_perf.perl" <prop.perf >actual &&
453 # "git xxx" is first mapped to "git-xxx" and the child will fail.
454 grep "d0|main|cmd_name|.*|_run_dashed_ (_run_dashed_)" actual &&
456 # We unpeel that and substitute "git version" for "git xxx" (as a
457 # shell command. Another cmd_name event is emitted as we unpeel.
458 grep "d0|main|cmd_name|.*|_run_shell_alias_ (_run_dashed_/_run_shell_alias_)" actual &&
460 # These def_param events could be associated with either of the
461 # above cmd_name events. It does not matter.
462 grep "d0|main|def_param|.*|cfg.prop.foo:red" actual &&
463 grep "d0|main|def_param|.*|ENV_PROP_FOO:blue" actual &&
465 # We get the following only because we used a git command for the
466 # shell command. In general, it could have been a shell script and
467 # we would see nothing.
469 # The child knows the cmd_name hierarchy so it includes it.
470 grep "d1|main|cmd_name|.*|version (_run_dashed_/_run_shell_alias_/version)" actual &&
471 grep "d1|main|def_param|.*|cfg.prop.foo:red" actual &&
472 grep "d1|main|def_param|.*|ENV_PROP_FOO:blue" actual
475 test_expect_success 'expect def_params during nested git alias expansion' '
476 test_when_finished "rm prop.perf actual" &&
478 test_config_global "trace2.configParams" "cfg.prop.*" &&
479 test_config_global "trace2.envvars" "ENV_PROP_FOO,ENV_PROP_BAR" &&
481 test_config_global "cfg.prop.foo" "red" &&
483 test_config_global "alias.xxx" "yyy" &&
484 test_config_global "alias.yyy" "version" &&
486 ENV_PROP_FOO=blue \
487 GIT_TRACE2_PERF="$(pwd)/prop.perf" \
488 git xxx &&
490 perl "$TEST_DIRECTORY/t0211/scrub_perf.perl" <prop.perf >actual &&
492 # "git xxx" is first mapped to "git-xxx" and try to spawn "git-xxx"
493 # and the child will fail.
494 grep "d0|main|cmd_name|.*|_run_dashed_ (_run_dashed_)" actual &&
495 grep "d0|main|child_start|.*|.* class:dashed argv:\[git-xxx\]" actual &&
497 # We unpeel that and substitute "yyy" into "xxx" (giving "git yyy")
498 # and spawn "git-yyy" and the child will fail.
499 grep "d0|main|alias|.*|alias:xxx argv:\[yyy\]" actual &&
500 grep "d0|main|cmd_name|.*|_run_dashed_ (_run_dashed_/_run_dashed_)" actual &&
501 grep "d0|main|child_start|.*|.* class:dashed argv:\[git-yyy\]" actual &&
503 # We unpeel that and substitute "version" into "xxx" (giving
504 # "git version") and update the cmd_name event.
505 grep "d0|main|alias|.*|alias:yyy argv:\[version\]" actual &&
506 grep "d0|main|cmd_name|.*|_run_git_alias_ (_run_dashed_/_run_dashed_/_run_git_alias_)" actual &&
508 # These def_param events could be associated with any of the
509 # above cmd_name events. It does not matter.
510 grep "d0|main|def_param|.*|cfg.prop.foo:red" actual >actual.matches &&
511 grep "d0|main|def_param|.*|ENV_PROP_FOO:blue" actual &&
513 # However, we do not want them repeated each time we unpeel.
514 test_line_count = 1 actual.matches &&
516 # The "git version" child sees a different cmd_name hierarchy.
517 # Also test the def_param (only for completeness).
518 grep "d1|main|cmd_name|.*|version (_run_dashed_/_run_dashed_/_run_git_alias_/version)" actual &&
519 grep "d1|main|def_param|.*|cfg.prop.foo:red" actual &&
520 grep "d1|main|def_param|.*|ENV_PROP_FOO:blue" actual
523 test_done