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 trace_git_fsync_stats();
218 trace2_collect_process_info(TRACE2_PROCESS_INFO_EXIT
);
220 tr2main_exit_code
= code
;
222 us_now
= getnanotime() / 1000;
223 us_elapsed_absolute
= tr2tls_absolute_elapsed(us_now
);
225 for_each_wanted_builtin (j
, tgt_j
)
226 if (tgt_j
->pfn_exit_fl
)
227 tgt_j
->pfn_exit_fl(file
, line
, us_elapsed_absolute
,
233 void trace2_cmd_error_va_fl(const char *file
, int line
, const char *fmt
,
236 struct tr2_tgt
*tgt_j
;
243 * We expect each target function to treat 'ap' as constant
244 * and use va_copy (because an 'ap' can only be walked once).
246 for_each_wanted_builtin (j
, tgt_j
)
247 if (tgt_j
->pfn_error_va_fl
)
248 tgt_j
->pfn_error_va_fl(file
, line
, fmt
, ap
);
251 void trace2_cmd_path_fl(const char *file
, int line
, const char *pathname
)
253 struct tr2_tgt
*tgt_j
;
259 for_each_wanted_builtin (j
, tgt_j
)
260 if (tgt_j
->pfn_command_path_fl
)
261 tgt_j
->pfn_command_path_fl(file
, line
, pathname
);
264 void trace2_cmd_ancestry_fl(const char *file
, int line
, const char **parent_names
)
266 struct tr2_tgt
*tgt_j
;
272 for_each_wanted_builtin (j
, tgt_j
)
273 if (tgt_j
->pfn_command_ancestry_fl
)
274 tgt_j
->pfn_command_ancestry_fl(file
, line
, parent_names
);
277 void trace2_cmd_name_fl(const char *file
, int line
, const char *name
)
279 struct tr2_tgt
*tgt_j
;
280 const char *hierarchy
;
286 tr2_cmd_name_append_hierarchy(name
);
287 hierarchy
= tr2_cmd_name_get_hierarchy();
289 for_each_wanted_builtin (j
, tgt_j
)
290 if (tgt_j
->pfn_command_name_fl
)
291 tgt_j
->pfn_command_name_fl(file
, line
, name
, hierarchy
);
294 void trace2_cmd_mode_fl(const char *file
, int line
, const char *mode
)
296 struct tr2_tgt
*tgt_j
;
302 for_each_wanted_builtin (j
, tgt_j
)
303 if (tgt_j
->pfn_command_mode_fl
)
304 tgt_j
->pfn_command_mode_fl(file
, line
, mode
);
307 void trace2_cmd_alias_fl(const char *file
, int line
, const char *alias
,
310 struct tr2_tgt
*tgt_j
;
316 for_each_wanted_builtin (j
, tgt_j
)
317 if (tgt_j
->pfn_alias_fl
)
318 tgt_j
->pfn_alias_fl(file
, line
, alias
, argv
);
321 void trace2_cmd_list_config_fl(const char *file
, int line
)
326 tr2_cfg_list_config_fl(file
, line
);
329 void trace2_cmd_list_env_vars_fl(const char *file
, int line
)
334 tr2_list_env_vars_fl(file
, line
);
337 void trace2_cmd_set_config_fl(const char *file
, int line
, const char *key
,
343 tr2_cfg_set_fl(file
, line
, key
, value
);
346 void trace2_child_start_fl(const char *file
, int line
,
347 struct child_process
*cmd
)
349 struct tr2_tgt
*tgt_j
;
352 uint64_t us_elapsed_absolute
;
357 us_now
= getnanotime() / 1000;
358 us_elapsed_absolute
= tr2tls_absolute_elapsed(us_now
);
360 cmd
->trace2_child_id
= tr2tls_locked_increment(&tr2_next_child_id
);
361 cmd
->trace2_child_us_start
= us_now
;
363 for_each_wanted_builtin (j
, tgt_j
)
364 if (tgt_j
->pfn_child_start_fl
)
365 tgt_j
->pfn_child_start_fl(file
, line
,
366 us_elapsed_absolute
, cmd
);
369 void trace2_child_exit_fl(const char *file
, int line
, struct child_process
*cmd
,
372 struct tr2_tgt
*tgt_j
;
375 uint64_t us_elapsed_absolute
;
376 uint64_t us_elapsed_child
;
381 us_now
= getnanotime() / 1000;
382 us_elapsed_absolute
= tr2tls_absolute_elapsed(us_now
);
384 if (cmd
->trace2_child_us_start
)
385 us_elapsed_child
= us_now
- cmd
->trace2_child_us_start
;
387 us_elapsed_child
= 0;
389 for_each_wanted_builtin (j
, tgt_j
)
390 if (tgt_j
->pfn_child_exit_fl
)
391 tgt_j
->pfn_child_exit_fl(file
, line
,
393 cmd
->trace2_child_id
, cmd
->pid
,
398 void trace2_child_ready_fl(const char *file
, int line
,
399 struct child_process
*cmd
,
402 struct tr2_tgt
*tgt_j
;
405 uint64_t us_elapsed_absolute
;
406 uint64_t us_elapsed_child
;
411 us_now
= getnanotime() / 1000;
412 us_elapsed_absolute
= tr2tls_absolute_elapsed(us_now
);
414 if (cmd
->trace2_child_us_start
)
415 us_elapsed_child
= us_now
- cmd
->trace2_child_us_start
;
417 us_elapsed_child
= 0;
419 for_each_wanted_builtin (j
, tgt_j
)
420 if (tgt_j
->pfn_child_ready_fl
)
421 tgt_j
->pfn_child_ready_fl(file
, line
,
423 cmd
->trace2_child_id
,
429 int trace2_exec_fl(const char *file
, int line
, const char *exe
,
432 struct tr2_tgt
*tgt_j
;
436 uint64_t us_elapsed_absolute
;
441 us_now
= getnanotime() / 1000;
442 us_elapsed_absolute
= tr2tls_absolute_elapsed(us_now
);
444 exec_id
= tr2tls_locked_increment(&tr2_next_exec_id
);
446 for_each_wanted_builtin (j
, tgt_j
)
447 if (tgt_j
->pfn_exec_fl
)
448 tgt_j
->pfn_exec_fl(file
, line
, us_elapsed_absolute
,
454 void trace2_exec_result_fl(const char *file
, int line
, int exec_id
, int code
)
456 struct tr2_tgt
*tgt_j
;
459 uint64_t us_elapsed_absolute
;
464 us_now
= getnanotime() / 1000;
465 us_elapsed_absolute
= tr2tls_absolute_elapsed(us_now
);
467 for_each_wanted_builtin (j
, tgt_j
)
468 if (tgt_j
->pfn_exec_result_fl
)
469 tgt_j
->pfn_exec_result_fl(
470 file
, line
, us_elapsed_absolute
, exec_id
, code
);
473 void trace2_thread_start_fl(const char *file
, int line
, const char *thread_name
)
475 struct tr2_tgt
*tgt_j
;
478 uint64_t us_elapsed_absolute
;
483 if (tr2tls_is_main_thread()) {
485 * We should only be called from the new thread's thread-proc,
486 * so this is technically a bug. But in those cases where the
487 * main thread also runs the thread-proc function (or when we
488 * are built with threading disabled), we need to allow it.
490 * Convert this call to a region-enter so the nesting looks
493 trace2_region_enter_printf_fl(file
, line
, NULL
, NULL
, NULL
,
494 "thread-proc on main: %s",
499 us_now
= getnanotime() / 1000;
500 us_elapsed_absolute
= tr2tls_absolute_elapsed(us_now
);
502 tr2tls_create_self(thread_name
, us_now
);
504 for_each_wanted_builtin (j
, tgt_j
)
505 if (tgt_j
->pfn_thread_start_fl
)
506 tgt_j
->pfn_thread_start_fl(file
, line
,
507 us_elapsed_absolute
);
510 void trace2_thread_exit_fl(const char *file
, int line
)
512 struct tr2_tgt
*tgt_j
;
515 uint64_t us_elapsed_absolute
;
516 uint64_t us_elapsed_thread
;
521 if (tr2tls_is_main_thread()) {
523 * We should only be called from the exiting thread's
524 * thread-proc, so this is technically a bug. But in
525 * those cases where the main thread also runs the
526 * thread-proc function (or when we are built with
527 * threading disabled), we need to allow it.
529 * Convert this call to a region-leave so the nesting
532 trace2_region_leave_printf_fl(file
, line
, NULL
, NULL
, NULL
,
533 "thread-proc on main");
537 us_now
= getnanotime() / 1000;
538 us_elapsed_absolute
= tr2tls_absolute_elapsed(us_now
);
541 * Clear any unbalanced regions and then get the relative time
542 * for the outer-most region (which we pushed when the thread
543 * started). This gives us the run time of the thread.
545 tr2tls_pop_unwind_self();
546 us_elapsed_thread
= tr2tls_region_elasped_self(us_now
);
548 for_each_wanted_builtin (j
, tgt_j
)
549 if (tgt_j
->pfn_thread_exit_fl
)
550 tgt_j
->pfn_thread_exit_fl(file
, line
,
557 void trace2_def_param_fl(const char *file
, int line
, const char *param
,
560 struct tr2_tgt
*tgt_j
;
566 for_each_wanted_builtin (j
, tgt_j
)
567 if (tgt_j
->pfn_param_fl
)
568 tgt_j
->pfn_param_fl(file
, line
, param
, value
);
571 void trace2_def_repo_fl(const char *file
, int line
, struct repository
*repo
)
573 struct tr2_tgt
*tgt_j
;
579 if (repo
->trace2_repo_id
)
582 repo
->trace2_repo_id
= tr2tls_locked_increment(&tr2_next_repo_id
);
584 for_each_wanted_builtin (j
, tgt_j
)
585 if (tgt_j
->pfn_repo_fl
)
586 tgt_j
->pfn_repo_fl(file
, line
, repo
);
589 void trace2_region_enter_printf_va_fl(const char *file
, int line
,
590 const char *category
, const char *label
,
591 const struct repository
*repo
,
592 const char *fmt
, va_list ap
)
594 struct tr2_tgt
*tgt_j
;
597 uint64_t us_elapsed_absolute
;
602 us_now
= getnanotime() / 1000;
603 us_elapsed_absolute
= tr2tls_absolute_elapsed(us_now
);
606 * Print the region-enter message at the current nesting
607 * (indentation) level and then push a new level.
609 * We expect each target function to treat 'ap' as constant
612 for_each_wanted_builtin (j
, tgt_j
)
613 if (tgt_j
->pfn_region_enter_printf_va_fl
)
614 tgt_j
->pfn_region_enter_printf_va_fl(
615 file
, line
, us_elapsed_absolute
, category
,
616 label
, repo
, fmt
, ap
);
618 tr2tls_push_self(us_now
);
621 void trace2_region_enter_fl(const char *file
, int line
, const char *category
,
622 const char *label
, const struct repository
*repo
, ...)
626 trace2_region_enter_printf_va_fl(file
, line
, category
, label
, repo
,
632 void trace2_region_enter_printf_fl(const char *file
, int line
,
633 const char *category
, const char *label
,
634 const struct repository
*repo
,
635 const char *fmt
, ...)
640 trace2_region_enter_printf_va_fl(file
, line
, category
, label
, repo
, fmt
,
645 void trace2_region_leave_printf_va_fl(const char *file
, int line
,
646 const char *category
, const char *label
,
647 const struct repository
*repo
,
648 const char *fmt
, va_list ap
)
650 struct tr2_tgt
*tgt_j
;
653 uint64_t us_elapsed_absolute
;
654 uint64_t us_elapsed_region
;
659 us_now
= getnanotime() / 1000;
660 us_elapsed_absolute
= tr2tls_absolute_elapsed(us_now
);
663 * Get the elapsed time in the current region before we
664 * pop it off the stack. Pop the stack. And then print
665 * the perf message at the new (shallower) level so that
666 * it lines up with the corresponding push/enter.
668 us_elapsed_region
= tr2tls_region_elasped_self(us_now
);
673 * We expect each target function to treat 'ap' as constant
676 for_each_wanted_builtin (j
, tgt_j
)
677 if (tgt_j
->pfn_region_leave_printf_va_fl
)
678 tgt_j
->pfn_region_leave_printf_va_fl(
679 file
, line
, us_elapsed_absolute
,
680 us_elapsed_region
, category
, label
, repo
, fmt
,
684 void trace2_region_leave_fl(const char *file
, int line
, const char *category
,
685 const char *label
, const struct repository
*repo
, ...)
689 trace2_region_leave_printf_va_fl(file
, line
, category
, label
, repo
,
694 void trace2_region_leave_printf_fl(const char *file
, int line
,
695 const char *category
, const char *label
,
696 const struct repository
*repo
,
697 const char *fmt
, ...)
702 trace2_region_leave_printf_va_fl(file
, line
, category
, label
, repo
, fmt
,
707 void trace2_data_string_fl(const char *file
, int line
, const char *category
,
708 const struct repository
*repo
, const char *key
,
711 struct tr2_tgt
*tgt_j
;
714 uint64_t us_elapsed_absolute
;
715 uint64_t us_elapsed_region
;
720 us_now
= getnanotime() / 1000;
721 us_elapsed_absolute
= tr2tls_absolute_elapsed(us_now
);
722 us_elapsed_region
= tr2tls_region_elasped_self(us_now
);
724 for_each_wanted_builtin (j
, tgt_j
)
725 if (tgt_j
->pfn_data_fl
)
726 tgt_j
->pfn_data_fl(file
, line
, us_elapsed_absolute
,
727 us_elapsed_region
, category
, repo
,
731 void trace2_data_intmax_fl(const char *file
, int line
, const char *category
,
732 const struct repository
*repo
, const char *key
,
735 struct strbuf buf_string
= STRBUF_INIT
;
740 strbuf_addf(&buf_string
, "%" PRIdMAX
, value
);
741 trace2_data_string_fl(file
, line
, category
, repo
, key
, buf_string
.buf
);
742 strbuf_release(&buf_string
);
745 void trace2_data_json_fl(const char *file
, int line
, const char *category
,
746 const struct repository
*repo
, const char *key
,
747 const struct json_writer
*value
)
749 struct tr2_tgt
*tgt_j
;
752 uint64_t us_elapsed_absolute
;
753 uint64_t us_elapsed_region
;
758 us_now
= getnanotime() / 1000;
759 us_elapsed_absolute
= tr2tls_absolute_elapsed(us_now
);
760 us_elapsed_region
= tr2tls_region_elasped_self(us_now
);
762 for_each_wanted_builtin (j
, tgt_j
)
763 if (tgt_j
->pfn_data_json_fl
)
764 tgt_j
->pfn_data_json_fl(file
, line
, us_elapsed_absolute
,
765 us_elapsed_region
, category
,
769 void trace2_printf_va_fl(const char *file
, int line
, const char *fmt
,
772 struct tr2_tgt
*tgt_j
;
775 uint64_t us_elapsed_absolute
;
780 us_now
= getnanotime() / 1000;
781 us_elapsed_absolute
= tr2tls_absolute_elapsed(us_now
);
784 * We expect each target function to treat 'ap' as constant
787 for_each_wanted_builtin (j
, tgt_j
)
788 if (tgt_j
->pfn_printf_va_fl
)
789 tgt_j
->pfn_printf_va_fl(file
, line
, us_elapsed_absolute
,
793 void trace2_printf_fl(const char *file
, int line
, const char *fmt
, ...)
798 trace2_printf_va_fl(file
, line
, fmt
, ap
);
802 const char *trace2_session_id(void)
804 return tr2_sid_get();