1 #include "git-compat-util.h"
3 #include "json-writer.h"
5 #include "repository.h"
6 #include "run-command.h"
8 #include "thread-utils.h"
12 #include "trace2/tr2_cfg.h"
13 #include "trace2/tr2_cmd_name.h"
14 #include "trace2/tr2_ctr.h"
15 #include "trace2/tr2_dst.h"
16 #include "trace2/tr2_sid.h"
17 #include "trace2/tr2_sysenv.h"
18 #include "trace2/tr2_tgt.h"
19 #include "trace2/tr2_tls.h"
20 #include "trace2/tr2_tmr.h"
22 static int trace2_enabled
;
24 static int tr2_next_child_id
; /* modify under lock */
25 static int tr2_next_exec_id
; /* modify under lock */
26 static int tr2_next_repo_id
= 1; /* modify under lock. zero is reserved */
29 * A table of the builtin TRACE2 targets. Each of these may be independently
30 * enabled or disabled. Each TRACE2 API method will try to write an event to
31 * *each* of the enabled targets.
33 /* clang-format off */
34 static struct tr2_tgt
*tr2_tgt_builtins
[] =
43 /* clang-format off */
44 #define for_each_builtin(j, tgt_j) \
45 for (j = 0, tgt_j = tr2_tgt_builtins[j]; \
47 j++, tgt_j = tr2_tgt_builtins[j])
50 /* clang-format off */
51 #define for_each_wanted_builtin(j, tgt_j) \
52 for_each_builtin(j, tgt_j) \
53 if (tr2_dst_trace_want(tgt_j->pdst))
57 * Force (rather than lazily) initialize any of the requested
58 * builtin TRACE2 targets at startup (and before we've seen an
59 * actual TRACE2 event call) so we can see if we need to setup
60 * private data structures and thread-local storage.
62 * Return the number of builtin targets enabled.
64 static int tr2_tgt_want_builtins(void)
66 struct tr2_tgt
*tgt_j
;
70 for_each_builtin (j
, tgt_j
)
71 if (tgt_j
->pfn_init())
78 * Properly terminate each builtin target. Give each target
79 * a chance to write a summary event and/or flush if necessary
80 * and then close the fd.
82 static void tr2_tgt_disable_builtins(void)
84 struct tr2_tgt
*tgt_j
;
87 for_each_builtin (j
, tgt_j
)
92 * The signature of this function must match the pfn_timer
93 * method in the targets. (Think of this is an apply operation
94 * across the set of active targets.)
96 static void tr2_tgt_emit_a_timer(const struct tr2_timer_metadata
*meta
,
97 const struct tr2_timer
*timer
,
100 struct tr2_tgt
*tgt_j
;
103 for_each_wanted_builtin (j
, tgt_j
)
104 if (tgt_j
->pfn_timer
)
105 tgt_j
->pfn_timer(meta
, timer
, is_final_data
);
109 * The signature of this function must match the pfn_counter
110 * method in the targets.
112 static void tr2_tgt_emit_a_counter(const struct tr2_counter_metadata
*meta
,
113 const struct tr2_counter
*counter
,
116 struct tr2_tgt
*tgt_j
;
119 for_each_wanted_builtin (j
, tgt_j
)
120 if (tgt_j
->pfn_counter
)
121 tgt_j
->pfn_counter(meta
, counter
, is_final_data
);
124 static int tr2main_exit_code
;
127 * Our atexit routine should run after everything has finished.
129 * Note that events generated here might not actually appear if
130 * we are writing to fd 1 or 2 and our atexit routine runs after
131 * the pager's atexit routine (since it closes them to shutdown
134 static void tr2main_atexit_handler(void)
136 struct tr2_tgt
*tgt_j
;
139 uint64_t us_elapsed_absolute
;
141 us_now
= getnanotime() / 1000;
142 us_elapsed_absolute
= tr2tls_absolute_elapsed(us_now
);
145 * Clear any unbalanced regions so that our atexit message
146 * does not appear nested. This improves the appearance of
147 * the trace output if someone calls die(), for example.
149 tr2tls_pop_unwind_self();
152 * Some timers want per-thread details. If the main thread
153 * used one of those timers, emit the details now (before
154 * we emit the aggregate timer values).
156 * Likewise for counters.
158 tr2_emit_per_thread_timers(tr2_tgt_emit_a_timer
);
159 tr2_emit_per_thread_counters(tr2_tgt_emit_a_counter
);
162 * Add stopwatch timer and counter data for the main thread to
163 * the final totals. And then emit the final values.
165 * Technically, we shouldn't need to hold the lock to update
166 * and output the final_timer_block and final_counter_block
167 * (since all other threads should be dead by now), but it
168 * doesn't hurt anything.
171 tr2_update_final_timers();
172 tr2_update_final_counters();
173 tr2_emit_final_timers(tr2_tgt_emit_a_timer
);
174 tr2_emit_final_counters(tr2_tgt_emit_a_counter
);
177 for_each_wanted_builtin (j
, tgt_j
)
178 if (tgt_j
->pfn_atexit
)
179 tgt_j
->pfn_atexit(us_elapsed_absolute
,
182 tr2_tgt_disable_builtins();
186 tr2_cmd_name_release();
187 tr2_cfg_free_patterns();
188 tr2_cfg_free_env_vars();
189 tr2_sysenv_release();
194 static void tr2main_signal_handler(int signo
)
196 struct tr2_tgt
*tgt_j
;
199 uint64_t us_elapsed_absolute
;
201 us_now
= getnanotime() / 1000;
202 us_elapsed_absolute
= tr2tls_absolute_elapsed(us_now
);
204 for_each_wanted_builtin (j
, tgt_j
)
205 if (tgt_j
->pfn_signal
)
206 tgt_j
->pfn_signal(us_elapsed_absolute
, signo
);
212 void trace2_initialize_clock(void)
214 tr2tls_start_process_clock();
217 void trace2_initialize_fl(const char *file
, int line
)
219 struct tr2_tgt
*tgt_j
;
227 if (!tr2_tgt_want_builtins())
233 atexit(tr2main_atexit_handler
);
234 sigchain_push(SIGPIPE
, tr2main_signal_handler
);
238 * Emit 'version' message on each active builtin target.
240 for_each_wanted_builtin (j
, tgt_j
)
241 if (tgt_j
->pfn_version_fl
)
242 tgt_j
->pfn_version_fl(file
, line
);
245 int trace2_is_enabled(void)
247 return trace2_enabled
;
250 void trace2_cmd_start_fl(const char *file
, int line
, const char **argv
)
252 struct tr2_tgt
*tgt_j
;
255 uint64_t us_elapsed_absolute
;
260 us_now
= getnanotime() / 1000;
261 us_elapsed_absolute
= tr2tls_absolute_elapsed(us_now
);
263 for_each_wanted_builtin (j
, tgt_j
)
264 if (tgt_j
->pfn_start_fl
)
265 tgt_j
->pfn_start_fl(file
, line
, us_elapsed_absolute
,
269 void trace2_cmd_exit_fl(const char *file
, int line
, int code
)
271 struct tr2_tgt
*tgt_j
;
274 uint64_t us_elapsed_absolute
;
279 trace_git_fsync_stats();
280 trace2_collect_process_info(TRACE2_PROCESS_INFO_EXIT
);
282 tr2main_exit_code
= code
;
284 us_now
= getnanotime() / 1000;
285 us_elapsed_absolute
= tr2tls_absolute_elapsed(us_now
);
287 for_each_wanted_builtin (j
, tgt_j
)
288 if (tgt_j
->pfn_exit_fl
)
289 tgt_j
->pfn_exit_fl(file
, line
, us_elapsed_absolute
,
293 void trace2_cmd_error_va_fl(const char *file
, int line
, const char *fmt
,
296 struct tr2_tgt
*tgt_j
;
303 * We expect each target function to treat 'ap' as constant
304 * and use va_copy (because an 'ap' can only be walked once).
306 for_each_wanted_builtin (j
, tgt_j
)
307 if (tgt_j
->pfn_error_va_fl
)
308 tgt_j
->pfn_error_va_fl(file
, line
, fmt
, ap
);
311 void trace2_cmd_path_fl(const char *file
, int line
, const char *pathname
)
313 struct tr2_tgt
*tgt_j
;
319 for_each_wanted_builtin (j
, tgt_j
)
320 if (tgt_j
->pfn_command_path_fl
)
321 tgt_j
->pfn_command_path_fl(file
, line
, pathname
);
324 void trace2_cmd_ancestry_fl(const char *file
, int line
, const char **parent_names
)
326 struct tr2_tgt
*tgt_j
;
332 for_each_wanted_builtin (j
, tgt_j
)
333 if (tgt_j
->pfn_command_ancestry_fl
)
334 tgt_j
->pfn_command_ancestry_fl(file
, line
, parent_names
);
337 void trace2_cmd_name_fl(const char *file
, int line
, const char *name
)
339 struct tr2_tgt
*tgt_j
;
340 const char *hierarchy
;
346 tr2_cmd_name_append_hierarchy(name
);
347 hierarchy
= tr2_cmd_name_get_hierarchy();
349 for_each_wanted_builtin (j
, tgt_j
)
350 if (tgt_j
->pfn_command_name_fl
)
351 tgt_j
->pfn_command_name_fl(file
, line
, name
, hierarchy
);
354 void trace2_cmd_mode_fl(const char *file
, int line
, const char *mode
)
356 struct tr2_tgt
*tgt_j
;
362 for_each_wanted_builtin (j
, tgt_j
)
363 if (tgt_j
->pfn_command_mode_fl
)
364 tgt_j
->pfn_command_mode_fl(file
, line
, mode
);
367 void trace2_cmd_alias_fl(const char *file
, int line
, const char *alias
,
370 struct tr2_tgt
*tgt_j
;
376 for_each_wanted_builtin (j
, tgt_j
)
377 if (tgt_j
->pfn_alias_fl
)
378 tgt_j
->pfn_alias_fl(file
, line
, alias
, argv
);
381 void trace2_cmd_list_config_fl(const char *file
, int line
)
386 tr2_cfg_list_config_fl(file
, line
);
389 void trace2_cmd_list_env_vars_fl(const char *file
, int line
)
394 tr2_list_env_vars_fl(file
, line
);
397 void trace2_cmd_set_config_fl(const char *file
, int line
, const char *key
,
403 tr2_cfg_set_fl(file
, line
, key
, value
);
406 void trace2_child_start_fl(const char *file
, int line
,
407 struct child_process
*cmd
)
409 struct tr2_tgt
*tgt_j
;
412 uint64_t us_elapsed_absolute
;
417 us_now
= getnanotime() / 1000;
418 us_elapsed_absolute
= tr2tls_absolute_elapsed(us_now
);
420 cmd
->trace2_child_id
= tr2tls_locked_increment(&tr2_next_child_id
);
421 cmd
->trace2_child_us_start
= us_now
;
423 for_each_wanted_builtin (j
, tgt_j
)
424 if (tgt_j
->pfn_child_start_fl
)
425 tgt_j
->pfn_child_start_fl(file
, line
,
426 us_elapsed_absolute
, cmd
);
429 void trace2_child_exit_fl(const char *file
, int line
, struct child_process
*cmd
,
432 struct tr2_tgt
*tgt_j
;
435 uint64_t us_elapsed_absolute
;
436 uint64_t us_elapsed_child
;
441 us_now
= getnanotime() / 1000;
442 us_elapsed_absolute
= tr2tls_absolute_elapsed(us_now
);
444 if (cmd
->trace2_child_us_start
)
445 us_elapsed_child
= us_now
- cmd
->trace2_child_us_start
;
447 us_elapsed_child
= 0;
449 for_each_wanted_builtin (j
, tgt_j
)
450 if (tgt_j
->pfn_child_exit_fl
)
451 tgt_j
->pfn_child_exit_fl(file
, line
,
453 cmd
->trace2_child_id
, cmd
->pid
,
458 void trace2_child_ready_fl(const char *file
, int line
,
459 struct child_process
*cmd
,
462 struct tr2_tgt
*tgt_j
;
465 uint64_t us_elapsed_absolute
;
466 uint64_t us_elapsed_child
;
471 us_now
= getnanotime() / 1000;
472 us_elapsed_absolute
= tr2tls_absolute_elapsed(us_now
);
474 if (cmd
->trace2_child_us_start
)
475 us_elapsed_child
= us_now
- cmd
->trace2_child_us_start
;
477 us_elapsed_child
= 0;
479 for_each_wanted_builtin (j
, tgt_j
)
480 if (tgt_j
->pfn_child_ready_fl
)
481 tgt_j
->pfn_child_ready_fl(file
, line
,
483 cmd
->trace2_child_id
,
489 int trace2_exec_fl(const char *file
, int line
, const char *exe
,
492 struct tr2_tgt
*tgt_j
;
496 uint64_t us_elapsed_absolute
;
501 us_now
= getnanotime() / 1000;
502 us_elapsed_absolute
= tr2tls_absolute_elapsed(us_now
);
504 exec_id
= tr2tls_locked_increment(&tr2_next_exec_id
);
506 for_each_wanted_builtin (j
, tgt_j
)
507 if (tgt_j
->pfn_exec_fl
)
508 tgt_j
->pfn_exec_fl(file
, line
, us_elapsed_absolute
,
514 void trace2_exec_result_fl(const char *file
, int line
, int exec_id
, int code
)
516 struct tr2_tgt
*tgt_j
;
519 uint64_t us_elapsed_absolute
;
524 us_now
= getnanotime() / 1000;
525 us_elapsed_absolute
= tr2tls_absolute_elapsed(us_now
);
527 for_each_wanted_builtin (j
, tgt_j
)
528 if (tgt_j
->pfn_exec_result_fl
)
529 tgt_j
->pfn_exec_result_fl(
530 file
, line
, us_elapsed_absolute
, exec_id
, code
);
533 void trace2_thread_start_fl(const char *file
, int line
, const char *thread_base_name
)
535 struct tr2_tgt
*tgt_j
;
538 uint64_t us_elapsed_absolute
;
543 if (tr2tls_is_main_thread()) {
545 * We should only be called from the new thread's thread-proc,
546 * so this is technically a bug. But in those cases where the
547 * main thread also runs the thread-proc function (or when we
548 * are built with threading disabled), we need to allow it.
550 * Convert this call to a region-enter so the nesting looks
553 trace2_region_enter_printf_fl(file
, line
, NULL
, NULL
, NULL
,
554 "thread-proc on main: %s",
559 us_now
= getnanotime() / 1000;
560 us_elapsed_absolute
= tr2tls_absolute_elapsed(us_now
);
562 tr2tls_create_self(thread_base_name
, us_now
);
564 for_each_wanted_builtin (j
, tgt_j
)
565 if (tgt_j
->pfn_thread_start_fl
)
566 tgt_j
->pfn_thread_start_fl(file
, line
,
567 us_elapsed_absolute
);
570 void trace2_thread_exit_fl(const char *file
, int line
)
572 struct tr2_tgt
*tgt_j
;
575 uint64_t us_elapsed_absolute
;
576 uint64_t us_elapsed_thread
;
581 if (tr2tls_is_main_thread()) {
583 * We should only be called from the exiting thread's
584 * thread-proc, so this is technically a bug. But in
585 * those cases where the main thread also runs the
586 * thread-proc function (or when we are built with
587 * threading disabled), we need to allow it.
589 * Convert this call to a region-leave so the nesting
592 trace2_region_leave_printf_fl(file
, line
, NULL
, NULL
, NULL
,
593 "thread-proc on main");
597 us_now
= getnanotime() / 1000;
598 us_elapsed_absolute
= tr2tls_absolute_elapsed(us_now
);
601 * Clear any unbalanced regions and then get the relative time
602 * for the outer-most region (which we pushed when the thread
603 * started). This gives us the run time of the thread.
605 tr2tls_pop_unwind_self();
606 us_elapsed_thread
= tr2tls_region_elasped_self(us_now
);
609 * Some timers want per-thread details. If this thread used
610 * one of those timers, emit the details now.
612 * Likewise for counters.
614 tr2_emit_per_thread_timers(tr2_tgt_emit_a_timer
);
615 tr2_emit_per_thread_counters(tr2_tgt_emit_a_counter
);
618 * Add stopwatch timer and counter data from the current
619 * (non-main) thread to the final totals. (We'll accumulate
620 * data for the main thread later during "atexit".)
623 tr2_update_final_timers();
624 tr2_update_final_counters();
627 for_each_wanted_builtin (j
, tgt_j
)
628 if (tgt_j
->pfn_thread_exit_fl
)
629 tgt_j
->pfn_thread_exit_fl(file
, line
,
636 void trace2_def_param_fl(const char *file
, int line
, const char *param
,
637 const char *value
, const struct key_value_info
*kvi
)
639 struct tr2_tgt
*tgt_j
;
645 for_each_wanted_builtin (j
, tgt_j
)
646 if (tgt_j
->pfn_param_fl
)
647 tgt_j
->pfn_param_fl(file
, line
, param
, value
, kvi
);
650 void trace2_def_repo_fl(const char *file
, int line
, struct repository
*repo
)
652 struct tr2_tgt
*tgt_j
;
658 if (repo
->trace2_repo_id
)
661 repo
->trace2_repo_id
= tr2tls_locked_increment(&tr2_next_repo_id
);
663 for_each_wanted_builtin (j
, tgt_j
)
664 if (tgt_j
->pfn_repo_fl
)
665 tgt_j
->pfn_repo_fl(file
, line
, repo
);
668 void trace2_region_enter_printf_va_fl(const char *file
, int line
,
669 const char *category
, const char *label
,
670 const struct repository
*repo
,
671 const char *fmt
, va_list ap
)
673 struct tr2_tgt
*tgt_j
;
676 uint64_t us_elapsed_absolute
;
681 us_now
= getnanotime() / 1000;
682 us_elapsed_absolute
= tr2tls_absolute_elapsed(us_now
);
685 * Print the region-enter message at the current nesting
686 * (indentation) level and then push a new level.
688 * We expect each target function to treat 'ap' as constant
691 for_each_wanted_builtin (j
, tgt_j
)
692 if (tgt_j
->pfn_region_enter_printf_va_fl
)
693 tgt_j
->pfn_region_enter_printf_va_fl(
694 file
, line
, us_elapsed_absolute
, category
,
695 label
, repo
, fmt
, ap
);
697 tr2tls_push_self(us_now
);
700 void trace2_region_enter_fl(const char *file
, int line
, const char *category
,
701 const char *label
, const struct repository
*repo
, ...)
705 trace2_region_enter_printf_va_fl(file
, line
, category
, label
, repo
,
711 void trace2_region_enter_printf_fl(const char *file
, int line
,
712 const char *category
, const char *label
,
713 const struct repository
*repo
,
714 const char *fmt
, ...)
719 trace2_region_enter_printf_va_fl(file
, line
, category
, label
, repo
, fmt
,
724 void trace2_region_leave_printf_va_fl(const char *file
, int line
,
725 const char *category
, const char *label
,
726 const struct repository
*repo
,
727 const char *fmt
, va_list ap
)
729 struct tr2_tgt
*tgt_j
;
732 uint64_t us_elapsed_absolute
;
733 uint64_t us_elapsed_region
;
738 us_now
= getnanotime() / 1000;
739 us_elapsed_absolute
= tr2tls_absolute_elapsed(us_now
);
742 * Get the elapsed time in the current region before we
743 * pop it off the stack. Pop the stack. And then print
744 * the perf message at the new (shallower) level so that
745 * it lines up with the corresponding push/enter.
747 us_elapsed_region
= tr2tls_region_elasped_self(us_now
);
752 * We expect each target function to treat 'ap' as constant
755 for_each_wanted_builtin (j
, tgt_j
)
756 if (tgt_j
->pfn_region_leave_printf_va_fl
)
757 tgt_j
->pfn_region_leave_printf_va_fl(
758 file
, line
, us_elapsed_absolute
,
759 us_elapsed_region
, category
, label
, repo
, fmt
,
763 void trace2_region_leave_fl(const char *file
, int line
, const char *category
,
764 const char *label
, const struct repository
*repo
, ...)
768 trace2_region_leave_printf_va_fl(file
, line
, category
, label
, repo
,
773 void trace2_region_leave_printf_fl(const char *file
, int line
,
774 const char *category
, const char *label
,
775 const struct repository
*repo
,
776 const char *fmt
, ...)
781 trace2_region_leave_printf_va_fl(file
, line
, category
, label
, repo
, fmt
,
786 void trace2_data_string_fl(const char *file
, int line
, const char *category
,
787 const struct repository
*repo
, const char *key
,
790 struct tr2_tgt
*tgt_j
;
793 uint64_t us_elapsed_absolute
;
794 uint64_t us_elapsed_region
;
799 us_now
= getnanotime() / 1000;
800 us_elapsed_absolute
= tr2tls_absolute_elapsed(us_now
);
801 us_elapsed_region
= tr2tls_region_elasped_self(us_now
);
803 for_each_wanted_builtin (j
, tgt_j
)
804 if (tgt_j
->pfn_data_fl
)
805 tgt_j
->pfn_data_fl(file
, line
, us_elapsed_absolute
,
806 us_elapsed_region
, category
, repo
,
810 void trace2_data_intmax_fl(const char *file
, int line
, const char *category
,
811 const struct repository
*repo
, const char *key
,
814 struct strbuf buf_string
= STRBUF_INIT
;
819 strbuf_addf(&buf_string
, "%" PRIdMAX
, value
);
820 trace2_data_string_fl(file
, line
, category
, repo
, key
, buf_string
.buf
);
821 strbuf_release(&buf_string
);
824 void trace2_data_json_fl(const char *file
, int line
, const char *category
,
825 const struct repository
*repo
, const char *key
,
826 const struct json_writer
*value
)
828 struct tr2_tgt
*tgt_j
;
831 uint64_t us_elapsed_absolute
;
832 uint64_t us_elapsed_region
;
837 us_now
= getnanotime() / 1000;
838 us_elapsed_absolute
= tr2tls_absolute_elapsed(us_now
);
839 us_elapsed_region
= tr2tls_region_elasped_self(us_now
);
841 for_each_wanted_builtin (j
, tgt_j
)
842 if (tgt_j
->pfn_data_json_fl
)
843 tgt_j
->pfn_data_json_fl(file
, line
, us_elapsed_absolute
,
844 us_elapsed_region
, category
,
848 void trace2_printf_va_fl(const char *file
, int line
, const char *fmt
,
851 struct tr2_tgt
*tgt_j
;
854 uint64_t us_elapsed_absolute
;
859 us_now
= getnanotime() / 1000;
860 us_elapsed_absolute
= tr2tls_absolute_elapsed(us_now
);
863 * We expect each target function to treat 'ap' as constant
866 for_each_wanted_builtin (j
, tgt_j
)
867 if (tgt_j
->pfn_printf_va_fl
)
868 tgt_j
->pfn_printf_va_fl(file
, line
, us_elapsed_absolute
,
872 void trace2_printf_fl(const char *file
, int line
, const char *fmt
, ...)
877 trace2_printf_va_fl(file
, line
, fmt
, ap
);
881 void trace2_timer_start(enum trace2_timer_id tid
)
886 if (tid
< 0 || tid
>= TRACE2_NUMBER_OF_TIMERS
)
887 BUG("trace2_timer_start: invalid timer id: %d", tid
);
889 tr2_start_timer(tid
);
892 void trace2_timer_stop(enum trace2_timer_id tid
)
897 if (tid
< 0 || tid
>= TRACE2_NUMBER_OF_TIMERS
)
898 BUG("trace2_timer_stop: invalid timer id: %d", tid
);
903 void trace2_counter_add(enum trace2_counter_id cid
, uint64_t value
)
908 if (cid
< 0 || cid
>= TRACE2_NUMBER_OF_COUNTERS
)
909 BUG("trace2_counter_add: invalid counter id: %d", cid
);
911 tr2_counter_increment(cid
, value
);
914 const char *trace2_session_id(void)
916 return tr2_sid_get();