3 #include "json-writer.h"
5 #include "run-command.h"
7 #include "thread-utils.h"
9 #include "trace2/tr2_cfg.h"
10 #include "trace2/tr2_cmd_name.h"
11 #include "trace2/tr2_dst.h"
12 #include "trace2/tr2_sid.h"
13 #include "trace2/tr2_sysenv.h"
14 #include "trace2/tr2_tgt.h"
15 #include "trace2/tr2_tls.h"
17 static int trace2_enabled;
19 static int tr2_next_child_id; /* modify under lock */
20 static int tr2_next_exec_id; /* modify under lock */
21 static int tr2_next_repo_id = 1; /* modify under lock. zero is reserved */
24 * A table of the builtin TRACE2 targets. Each of these may be independently
25 * enabled or disabled. Each TRACE2 API method will try to write an event to
26 * *each* of the enabled targets.
28 /* clang-format off */
29 static struct tr2_tgt *tr2_tgt_builtins[] =
38 /* clang-format off */
39 #define for_each_builtin(j, tgt_j) \
40 for (j = 0, tgt_j = tr2_tgt_builtins[j]; \
42 j++, tgt_j = tr2_tgt_builtins[j])
45 /* clang-format off */
46 #define for_each_wanted_builtin(j, tgt_j) \
47 for_each_builtin(j, tgt_j) \
48 if (tr2_dst_trace_want(tgt_j->pdst))
52 * Force (rather than lazily) initialize any of the requested
53 * builtin TRACE2 targets at startup (and before we've seen an
54 * actual TRACE2 event call) so we can see if we need to setup
55 * the TR2 and TLS machinery.
57 * Return the number of builtin targets enabled.
59 static int tr2_tgt_want_builtins(void)
61 struct tr2_tgt *tgt_j;
65 for_each_builtin (j, tgt_j)
66 if (tgt_j->pfn_init())
73 * Properly terminate each builtin target. Give each target
74 * a chance to write a summary event and/or flush if necessary
75 * and then close the fd.
77 static void tr2_tgt_disable_builtins(void)
79 struct tr2_tgt *tgt_j;
82 for_each_builtin (j, tgt_j)
86 static int tr2main_exit_code;
89 * Our atexit routine should run after everything has finished.
91 * Note that events generated here might not actually appear if
92 * we are writing to fd 1 or 2 and our atexit routine runs after
93 * the pager's atexit routine (since it closes them to shutdown
96 static void tr2main_atexit_handler(void)
98 struct tr2_tgt *tgt_j;
101 uint64_t us_elapsed_absolute;
103 us_now = getnanotime() / 1000;
104 us_elapsed_absolute = tr2tls_absolute_elapsed(us_now);
107 * Clear any unbalanced regions so that our atexit message
108 * does not appear nested. This improves the appearance of
109 * the trace output if someone calls die(), for example.
111 tr2tls_pop_unwind_self();
113 for_each_wanted_builtin (j, tgt_j)
114 if (tgt_j->pfn_atexit)
115 tgt_j->pfn_atexit(us_elapsed_absolute,
118 tr2_tgt_disable_builtins();
122 tr2_cmd_name_release();
123 tr2_cfg_free_patterns();
124 tr2_cfg_free_env_vars();
125 tr2_sysenv_release();
130 static void tr2main_signal_handler(int signo)
132 struct tr2_tgt *tgt_j;
135 uint64_t us_elapsed_absolute;
137 us_now = getnanotime() / 1000;
138 us_elapsed_absolute = tr2tls_absolute_elapsed(us_now);
140 for_each_wanted_builtin (j, tgt_j)
141 if (tgt_j->pfn_signal)
142 tgt_j->pfn_signal(us_elapsed_absolute, signo);
148 void trace2_initialize_clock(void)
150 tr2tls_start_process_clock();
153 void trace2_initialize_fl(const char *file, int line)
155 struct tr2_tgt *tgt_j;
163 if (!tr2_tgt_want_builtins())
169 atexit(tr2main_atexit_handler);
170 sigchain_push(SIGPIPE, tr2main_signal_handler);
174 * Emit 'version' message on each active builtin target.
176 for_each_wanted_builtin (j, tgt_j)
177 if (tgt_j->pfn_version_fl)
178 tgt_j->pfn_version_fl(file, line);
181 int trace2_is_enabled(void)
183 return trace2_enabled;
186 void trace2_cmd_start_fl(const char *file, int line, const char **argv)
188 struct tr2_tgt *tgt_j;
191 uint64_t us_elapsed_absolute;
196 us_now = getnanotime() / 1000;
197 us_elapsed_absolute = tr2tls_absolute_elapsed(us_now);
199 for_each_wanted_builtin (j, tgt_j)
200 if (tgt_j->pfn_start_fl)
201 tgt_j->pfn_start_fl(file, line, us_elapsed_absolute,
205 int trace2_cmd_exit_fl(const char *file, int line, int code)
207 struct tr2_tgt *tgt_j;
210 uint64_t us_elapsed_absolute;
217 trace2_collect_process_info(TRACE2_PROCESS_INFO_EXIT);
219 tr2main_exit_code = code;
221 us_now = getnanotime() / 1000;
222 us_elapsed_absolute = tr2tls_absolute_elapsed(us_now);
224 for_each_wanted_builtin (j, tgt_j)
225 if (tgt_j->pfn_exit_fl)
226 tgt_j->pfn_exit_fl(file, line, us_elapsed_absolute,
232 void trace2_cmd_error_va_fl(const char *file, int line, const char *fmt,
235 struct tr2_tgt *tgt_j;
242 * We expect each target function to treat 'ap' as constant
243 * and use va_copy (because an 'ap' can only be walked once).
245 for_each_wanted_builtin (j, tgt_j)
246 if (tgt_j->pfn_error_va_fl)
247 tgt_j->pfn_error_va_fl(file, line, fmt, ap);
250 void trace2_cmd_path_fl(const char *file, int line, const char *pathname)
252 struct tr2_tgt *tgt_j;
258 for_each_wanted_builtin (j, tgt_j)
259 if (tgt_j->pfn_command_path_fl)
260 tgt_j->pfn_command_path_fl(file, line, pathname);
263 void trace2_cmd_name_fl(const char *file, int line, const char *name)
265 struct tr2_tgt *tgt_j;
266 const char *hierarchy;
272 tr2_cmd_name_append_hierarchy(name);
273 hierarchy = tr2_cmd_name_get_hierarchy();
275 for_each_wanted_builtin (j, tgt_j)
276 if (tgt_j->pfn_command_name_fl)
277 tgt_j->pfn_command_name_fl(file, line, name, hierarchy);
280 void trace2_cmd_mode_fl(const char *file, int line, const char *mode)
282 struct tr2_tgt *tgt_j;
288 for_each_wanted_builtin (j, tgt_j)
289 if (tgt_j->pfn_command_mode_fl)
290 tgt_j->pfn_command_mode_fl(file, line, mode);
293 void trace2_cmd_alias_fl(const char *file, int line, const char *alias,
296 struct tr2_tgt *tgt_j;
302 for_each_wanted_builtin (j, tgt_j)
303 if (tgt_j->pfn_alias_fl)
304 tgt_j->pfn_alias_fl(file, line, alias, argv);
307 void trace2_cmd_list_config_fl(const char *file, int line)
312 tr2_cfg_list_config_fl(file, line);
315 void trace2_cmd_list_env_vars_fl(const char *file, int line)
320 tr2_list_env_vars_fl(file, line);
323 void trace2_cmd_set_config_fl(const char *file, int line, const char *key,
329 tr2_cfg_set_fl(file, line, key, value);
332 void trace2_child_start_fl(const char *file, int line,
333 struct child_process *cmd)
335 struct tr2_tgt *tgt_j;
338 uint64_t us_elapsed_absolute;
343 us_now = getnanotime() / 1000;
344 us_elapsed_absolute = tr2tls_absolute_elapsed(us_now);
346 cmd->trace2_child_id = tr2tls_locked_increment(&tr2_next_child_id);
347 cmd->trace2_child_us_start = us_now;
349 for_each_wanted_builtin (j, tgt_j)
350 if (tgt_j->pfn_child_start_fl)
351 tgt_j->pfn_child_start_fl(file, line,
352 us_elapsed_absolute, cmd);
355 void trace2_child_exit_fl(const char *file, int line, struct child_process *cmd,
358 struct tr2_tgt *tgt_j;
361 uint64_t us_elapsed_absolute;
362 uint64_t us_elapsed_child;
367 us_now = getnanotime() / 1000;
368 us_elapsed_absolute = tr2tls_absolute_elapsed(us_now);
370 if (cmd->trace2_child_us_start)
371 us_elapsed_child = us_now - cmd->trace2_child_us_start;
373 us_elapsed_child = 0;
375 for_each_wanted_builtin (j, tgt_j)
376 if (tgt_j->pfn_child_exit_fl)
377 tgt_j->pfn_child_exit_fl(file, line,
379 cmd->trace2_child_id, cmd->pid,
384 int trace2_exec_fl(const char *file, int line, const char *exe,
387 struct tr2_tgt *tgt_j;
391 uint64_t us_elapsed_absolute;
396 us_now = getnanotime() / 1000;
397 us_elapsed_absolute = tr2tls_absolute_elapsed(us_now);
399 exec_id = tr2tls_locked_increment(&tr2_next_exec_id);
401 for_each_wanted_builtin (j, tgt_j)
402 if (tgt_j->pfn_exec_fl)
403 tgt_j->pfn_exec_fl(file, line, us_elapsed_absolute,
409 void trace2_exec_result_fl(const char *file, int line, int exec_id, int code)
411 struct tr2_tgt *tgt_j;
414 uint64_t us_elapsed_absolute;
419 us_now = getnanotime() / 1000;
420 us_elapsed_absolute = tr2tls_absolute_elapsed(us_now);
422 for_each_wanted_builtin (j, tgt_j)
423 if (tgt_j->pfn_exec_result_fl)
424 tgt_j->pfn_exec_result_fl(
425 file, line, us_elapsed_absolute, exec_id, code);
428 void trace2_thread_start_fl(const char *file, int line, const char *thread_name)
430 struct tr2_tgt *tgt_j;
433 uint64_t us_elapsed_absolute;
438 if (tr2tls_is_main_thread()) {
440 * We should only be called from the new thread's thread-proc,
441 * so this is technically a bug. But in those cases where the
442 * main thread also runs the thread-proc function (or when we
443 * are built with threading disabled), we need to allow it.
445 * Convert this call to a region-enter so the nesting looks
448 trace2_region_enter_printf_fl(file, line, NULL, NULL, NULL,
449 "thread-proc on main: %s",
454 us_now = getnanotime() / 1000;
455 us_elapsed_absolute = tr2tls_absolute_elapsed(us_now);
457 tr2tls_create_self(thread_name, us_now);
459 for_each_wanted_builtin (j, tgt_j)
460 if (tgt_j->pfn_thread_start_fl)
461 tgt_j->pfn_thread_start_fl(file, line,
462 us_elapsed_absolute);
465 void trace2_thread_exit_fl(const char *file, int line)
467 struct tr2_tgt *tgt_j;
470 uint64_t us_elapsed_absolute;
471 uint64_t us_elapsed_thread;
476 if (tr2tls_is_main_thread()) {
478 * We should only be called from the exiting thread's
479 * thread-proc, so this is technically a bug. But in
480 * those cases where the main thread also runs the
481 * thread-proc function (or when we are built with
482 * threading disabled), we need to allow it.
484 * Convert this call to a region-leave so the nesting
487 trace2_region_leave_printf_fl(file, line, NULL, NULL, NULL,
488 "thread-proc on main");
492 us_now = getnanotime() / 1000;
493 us_elapsed_absolute = tr2tls_absolute_elapsed(us_now);
496 * Clear any unbalanced regions and then get the relative time
497 * for the outer-most region (which we pushed when the thread
498 * started). This gives us the run time of the thread.
500 tr2tls_pop_unwind_self();
501 us_elapsed_thread = tr2tls_region_elasped_self(us_now);
503 for_each_wanted_builtin (j, tgt_j)
504 if (tgt_j->pfn_thread_exit_fl)
505 tgt_j->pfn_thread_exit_fl(file, line,
512 void trace2_def_param_fl(const char *file, int line, const char *param,
515 struct tr2_tgt *tgt_j;
521 for_each_wanted_builtin (j, tgt_j)
522 if (tgt_j->pfn_param_fl)
523 tgt_j->pfn_param_fl(file, line, param, value);
526 void trace2_def_repo_fl(const char *file, int line, struct repository *repo)
528 struct tr2_tgt *tgt_j;
534 if (repo->trace2_repo_id)
537 repo->trace2_repo_id = tr2tls_locked_increment(&tr2_next_repo_id);
539 for_each_wanted_builtin (j, tgt_j)
540 if (tgt_j->pfn_repo_fl)
541 tgt_j->pfn_repo_fl(file, line, repo);
544 void trace2_region_enter_printf_va_fl(const char *file, int line,
545 const char *category, const char *label,
546 const struct repository *repo,
547 const char *fmt, va_list ap)
549 struct tr2_tgt *tgt_j;
552 uint64_t us_elapsed_absolute;
557 us_now = getnanotime() / 1000;
558 us_elapsed_absolute = tr2tls_absolute_elapsed(us_now);
561 * Print the region-enter message at the current nesting
562 * (indentation) level and then push a new level.
564 * We expect each target function to treat 'ap' as constant
567 for_each_wanted_builtin (j, tgt_j)
568 if (tgt_j->pfn_region_enter_printf_va_fl)
569 tgt_j->pfn_region_enter_printf_va_fl(
570 file, line, us_elapsed_absolute, category,
571 label, repo, fmt, ap);
573 tr2tls_push_self(us_now);
576 void trace2_region_enter_fl(const char *file, int line, const char *category,
577 const char *label, const struct repository *repo, ...)
581 trace2_region_enter_printf_va_fl(file, line, category, label, repo,
587 void trace2_region_enter_printf_fl(const char *file, int line,
588 const char *category, const char *label,
589 const struct repository *repo,
590 const char *fmt, ...)
595 trace2_region_enter_printf_va_fl(file, line, category, label, repo, fmt,
600 #ifndef HAVE_VARIADIC_MACROS
601 void trace2_region_enter_printf(const char *category, const char *label,
602 const struct repository *repo, const char *fmt,
608 trace2_region_enter_printf_va_fl(NULL, 0, category, label, repo, fmt,
614 void trace2_region_leave_printf_va_fl(const char *file, int line,
615 const char *category, const char *label,
616 const struct repository *repo,
617 const char *fmt, va_list ap)
619 struct tr2_tgt *tgt_j;
622 uint64_t us_elapsed_absolute;
623 uint64_t us_elapsed_region;
628 us_now = getnanotime() / 1000;
629 us_elapsed_absolute = tr2tls_absolute_elapsed(us_now);
632 * Get the elapsed time in the current region before we
633 * pop it off the stack. Pop the stack. And then print
634 * the perf message at the new (shallower) level so that
635 * it lines up with the corresponding push/enter.
637 us_elapsed_region = tr2tls_region_elasped_self(us_now);
642 * We expect each target function to treat 'ap' as constant
645 for_each_wanted_builtin (j, tgt_j)
646 if (tgt_j->pfn_region_leave_printf_va_fl)
647 tgt_j->pfn_region_leave_printf_va_fl(
648 file, line, us_elapsed_absolute,
649 us_elapsed_region, category, label, repo, fmt,
653 void trace2_region_leave_fl(const char *file, int line, const char *category,
654 const char *label, const struct repository *repo, ...)
658 trace2_region_leave_printf_va_fl(file, line, category, label, repo,
663 void trace2_region_leave_printf_fl(const char *file, int line,
664 const char *category, const char *label,
665 const struct repository *repo,
666 const char *fmt, ...)
671 trace2_region_leave_printf_va_fl(file, line, category, label, repo, fmt,
676 #ifndef HAVE_VARIADIC_MACROS
677 void trace2_region_leave_printf(const char *category, const char *label,
678 const struct repository *repo, const char *fmt,
684 trace2_region_leave_printf_va_fl(NULL, 0, category, label, repo, fmt,
690 void trace2_data_string_fl(const char *file, int line, const char *category,
691 const struct repository *repo, const char *key,
694 struct tr2_tgt *tgt_j;
697 uint64_t us_elapsed_absolute;
698 uint64_t us_elapsed_region;
703 us_now = getnanotime() / 1000;
704 us_elapsed_absolute = tr2tls_absolute_elapsed(us_now);
705 us_elapsed_region = tr2tls_region_elasped_self(us_now);
707 for_each_wanted_builtin (j, tgt_j)
708 if (tgt_j->pfn_data_fl)
709 tgt_j->pfn_data_fl(file, line, us_elapsed_absolute,
710 us_elapsed_region, category, repo,
714 void trace2_data_intmax_fl(const char *file, int line, const char *category,
715 const struct repository *repo, const char *key,
718 struct strbuf buf_string = STRBUF_INIT;
723 strbuf_addf(&buf_string, "%" PRIdMAX, value);
724 trace2_data_string_fl(file, line, category, repo, key, buf_string.buf);
725 strbuf_release(&buf_string);
728 void trace2_data_json_fl(const char *file, int line, const char *category,
729 const struct repository *repo, const char *key,
730 const struct json_writer *value)
732 struct tr2_tgt *tgt_j;
735 uint64_t us_elapsed_absolute;
736 uint64_t us_elapsed_region;
741 us_now = getnanotime() / 1000;
742 us_elapsed_absolute = tr2tls_absolute_elapsed(us_now);
743 us_elapsed_region = tr2tls_region_elasped_self(us_now);
745 for_each_wanted_builtin (j, tgt_j)
746 if (tgt_j->pfn_data_json_fl)
747 tgt_j->pfn_data_json_fl(file, line, us_elapsed_absolute,
748 us_elapsed_region, category,
752 void trace2_printf_va_fl(const char *file, int line, const char *fmt,
755 struct tr2_tgt *tgt_j;
758 uint64_t us_elapsed_absolute;
763 us_now = getnanotime() / 1000;
764 us_elapsed_absolute = tr2tls_absolute_elapsed(us_now);
767 * We expect each target function to treat 'ap' as constant
770 for_each_wanted_builtin (j, tgt_j)
771 if (tgt_j->pfn_printf_va_fl)
772 tgt_j->pfn_printf_va_fl(file, line, us_elapsed_absolute,
776 void trace2_printf_fl(const char *file, int line, const char *fmt, ...)
781 trace2_printf_va_fl(file, line, fmt, ap);
785 #ifndef HAVE_VARIADIC_MACROS
786 void trace2_printf(const char *fmt, ...)
791 trace2_printf_va_fl(NULL, 0, fmt, ap);