3 #include "json-writer.h"
4 #include "run-command.h"
6 #include "trace2/tr2_dst.h"
7 #include "trace2/tr2_tbuf.h"
8 #include "trace2/tr2_sid.h"
9 #include "trace2/tr2_sysenv.h"
10 #include "trace2/tr2_tgt.h"
11 #include "trace2/tr2_tls.h"
13 static struct tr2_dst tr2dst_event
= { TR2_SYSENV_EVENT
, 0, 0, 0, 0 };
16 * The version number of the JSON data generated by the EVENT target in this
17 * source file. The version should be incremented if new event types are added,
18 * if existing fields are removed, or if there are significant changes in
19 * interpretation of existing events or fields. Smaller changes, such as adding
20 * a new field to an existing event, do not require an increment to the EVENT
23 #define TR2_EVENT_VERSION "2"
26 * Region nesting limit for messages written to the event target.
28 * The "region_enter" and "region_leave" messages (especially recursive
29 * messages such as those produced while diving the worktree or index)
30 * are primarily intended for the performance target during debugging.
32 * Some of the outer-most messages, however, may be of interest to the
33 * event target. Use the TR2_SYSENV_EVENT_NESTING setting to increase
34 * region details in the event target.
36 static int tr2env_event_max_nesting_levels
= 2;
39 * Use the TR2_SYSENV_EVENT_BRIEF to omit the <time>, <file>, and
40 * <line> fields from most events.
42 static int tr2env_event_be_brief
;
44 static int fn_init(void)
46 int want
= tr2_dst_trace_want(&tr2dst_event
);
55 nesting
= tr2_sysenv_get(TR2_SYSENV_EVENT_NESTING
);
56 if (nesting
&& *nesting
&& ((max_nesting
= atoi(nesting
)) > 0))
57 tr2env_event_max_nesting_levels
= max_nesting
;
59 brief
= tr2_sysenv_get(TR2_SYSENV_EVENT_BRIEF
);
60 if (brief
&& *brief
&&
61 ((want_brief
= git_parse_maybe_bool(brief
)) != -1))
62 tr2env_event_be_brief
= want_brief
;
67 static void fn_term(void)
69 tr2_dst_trace_disable(&tr2dst_event
);
73 * Append common key-value pairs to the currently open JSON object.
74 * "event:"<event_name>"
76 * "thread":"<thread_name>"
79 * "line":<line_number>
82 static void event_fmt_prepare(const char *event_name
, const char *file
,
83 int line
, const struct repository
*repo
,
84 struct json_writer
*jw
)
86 struct tr2tls_thread_ctx
*ctx
= tr2tls_get_self();
87 struct tr2_tbuf tb_now
;
89 jw_object_string(jw
, "event", event_name
);
90 jw_object_string(jw
, "sid", tr2_sid_get());
91 jw_object_string(jw
, "thread", ctx
->thread_name
.buf
);
94 * In brief mode, only emit <time> on these 2 event types.
96 if (!tr2env_event_be_brief
|| !strcmp(event_name
, "version") ||
97 !strcmp(event_name
, "atexit")) {
98 tr2_tbuf_utc_datetime_extended(&tb_now
);
99 jw_object_string(jw
, "time", tb_now
.buf
);
102 if (!tr2env_event_be_brief
&& file
&& *file
) {
103 jw_object_string(jw
, "file", file
);
104 jw_object_intmax(jw
, "line", line
);
108 jw_object_intmax(jw
, "repo", repo
->trace2_repo_id
);
111 static void fn_too_many_files_fl(const char *file
, int line
)
113 const char *event_name
= "too_many_files";
114 struct json_writer jw
= JSON_WRITER_INIT
;
116 jw_object_begin(&jw
, 0);
117 event_fmt_prepare(event_name
, file
, line
, NULL
, &jw
);
120 tr2_dst_write_line(&tr2dst_event
, &jw
.json
);
124 static void fn_version_fl(const char *file
, int line
)
126 const char *event_name
= "version";
127 struct json_writer jw
= JSON_WRITER_INIT
;
129 jw_object_begin(&jw
, 0);
130 event_fmt_prepare(event_name
, file
, line
, NULL
, &jw
);
131 jw_object_string(&jw
, "evt", TR2_EVENT_VERSION
);
132 jw_object_string(&jw
, "exe", git_version_string
);
135 tr2_dst_write_line(&tr2dst_event
, &jw
.json
);
138 if (tr2dst_event
.too_many_files
)
139 fn_too_many_files_fl(file
, line
);
142 static void fn_start_fl(const char *file
, int line
,
143 uint64_t us_elapsed_absolute
, const char **argv
)
145 const char *event_name
= "start";
146 struct json_writer jw
= JSON_WRITER_INIT
;
147 double t_abs
= (double)us_elapsed_absolute
/ 1000000.0;
149 jw_object_begin(&jw
, 0);
150 event_fmt_prepare(event_name
, file
, line
, NULL
, &jw
);
151 jw_object_double(&jw
, "t_abs", 6, t_abs
);
152 jw_object_inline_begin_array(&jw
, "argv");
153 jw_array_argv(&jw
, argv
);
157 tr2_dst_write_line(&tr2dst_event
, &jw
.json
);
161 static void fn_exit_fl(const char *file
, int line
, uint64_t us_elapsed_absolute
,
164 const char *event_name
= "exit";
165 struct json_writer jw
= JSON_WRITER_INIT
;
166 double t_abs
= (double)us_elapsed_absolute
/ 1000000.0;
168 jw_object_begin(&jw
, 0);
169 event_fmt_prepare(event_name
, file
, line
, NULL
, &jw
);
170 jw_object_double(&jw
, "t_abs", 6, t_abs
);
171 jw_object_intmax(&jw
, "code", code
);
174 tr2_dst_write_line(&tr2dst_event
, &jw
.json
);
178 static void fn_signal(uint64_t us_elapsed_absolute
, int signo
)
180 const char *event_name
= "signal";
181 struct json_writer jw
= JSON_WRITER_INIT
;
182 double t_abs
= (double)us_elapsed_absolute
/ 1000000.0;
184 jw_object_begin(&jw
, 0);
185 event_fmt_prepare(event_name
, __FILE__
, __LINE__
, NULL
, &jw
);
186 jw_object_double(&jw
, "t_abs", 6, t_abs
);
187 jw_object_intmax(&jw
, "signo", signo
);
190 tr2_dst_write_line(&tr2dst_event
, &jw
.json
);
194 static void fn_atexit(uint64_t us_elapsed_absolute
, int code
)
196 const char *event_name
= "atexit";
197 struct json_writer jw
= JSON_WRITER_INIT
;
198 double t_abs
= (double)us_elapsed_absolute
/ 1000000.0;
200 jw_object_begin(&jw
, 0);
201 event_fmt_prepare(event_name
, __FILE__
, __LINE__
, NULL
, &jw
);
202 jw_object_double(&jw
, "t_abs", 6, t_abs
);
203 jw_object_intmax(&jw
, "code", code
);
206 tr2_dst_write_line(&tr2dst_event
, &jw
.json
);
210 static void maybe_add_string_va(struct json_writer
*jw
, const char *field_name
,
211 const char *fmt
, va_list ap
)
215 struct strbuf buf
= STRBUF_INIT
;
217 va_copy(copy_ap
, ap
);
218 strbuf_vaddf(&buf
, fmt
, copy_ap
);
221 jw_object_string(jw
, field_name
, buf
.buf
);
222 strbuf_release(&buf
);
227 static void fn_error_va_fl(const char *file
, int line
, const char *fmt
,
230 const char *event_name
= "error";
231 struct json_writer jw
= JSON_WRITER_INIT
;
233 jw_object_begin(&jw
, 0);
234 event_fmt_prepare(event_name
, file
, line
, NULL
, &jw
);
235 maybe_add_string_va(&jw
, "msg", fmt
, ap
);
237 * Also emit the format string as a field in case
238 * post-processors want to aggregate common error
239 * messages by type without argument fields (such
240 * as pathnames or branch names) cluttering it up.
243 jw_object_string(&jw
, "fmt", fmt
);
246 tr2_dst_write_line(&tr2dst_event
, &jw
.json
);
250 static void fn_command_path_fl(const char *file
, int line
, const char *pathname
)
252 const char *event_name
= "cmd_path";
253 struct json_writer jw
= JSON_WRITER_INIT
;
255 jw_object_begin(&jw
, 0);
256 event_fmt_prepare(event_name
, file
, line
, NULL
, &jw
);
257 jw_object_string(&jw
, "path", pathname
);
260 tr2_dst_write_line(&tr2dst_event
, &jw
.json
);
264 static void fn_command_ancestry_fl(const char *file
, int line
, const char **parent_names
)
266 const char *event_name
= "cmd_ancestry";
267 const char *parent_name
= NULL
;
268 struct json_writer jw
= JSON_WRITER_INIT
;
270 jw_object_begin(&jw
, 0);
271 event_fmt_prepare(event_name
, file
, line
, NULL
, &jw
);
272 jw_object_inline_begin_array(&jw
, "ancestry");
274 while ((parent_name
= *parent_names
++))
275 jw_array_string(&jw
, parent_name
);
277 jw_end(&jw
); /* 'ancestry' array */
278 jw_end(&jw
); /* event object */
280 tr2_dst_write_line(&tr2dst_event
, &jw
.json
);
284 static void fn_command_name_fl(const char *file
, int line
, const char *name
,
285 const char *hierarchy
)
287 const char *event_name
= "cmd_name";
288 struct json_writer jw
= JSON_WRITER_INIT
;
290 jw_object_begin(&jw
, 0);
291 event_fmt_prepare(event_name
, file
, line
, NULL
, &jw
);
292 jw_object_string(&jw
, "name", name
);
293 if (hierarchy
&& *hierarchy
)
294 jw_object_string(&jw
, "hierarchy", hierarchy
);
297 tr2_dst_write_line(&tr2dst_event
, &jw
.json
);
301 static void fn_command_mode_fl(const char *file
, int line
, const char *mode
)
303 const char *event_name
= "cmd_mode";
304 struct json_writer jw
= JSON_WRITER_INIT
;
306 jw_object_begin(&jw
, 0);
307 event_fmt_prepare(event_name
, file
, line
, NULL
, &jw
);
308 jw_object_string(&jw
, "name", mode
);
311 tr2_dst_write_line(&tr2dst_event
, &jw
.json
);
315 static void fn_alias_fl(const char *file
, int line
, const char *alias
,
318 const char *event_name
= "alias";
319 struct json_writer jw
= JSON_WRITER_INIT
;
321 jw_object_begin(&jw
, 0);
322 event_fmt_prepare(event_name
, file
, line
, NULL
, &jw
);
323 jw_object_string(&jw
, "alias", alias
);
324 jw_object_inline_begin_array(&jw
, "argv");
325 jw_array_argv(&jw
, argv
);
329 tr2_dst_write_line(&tr2dst_event
, &jw
.json
);
333 static void fn_child_start_fl(const char *file
, int line
,
334 uint64_t us_elapsed_absolute
,
335 const struct child_process
*cmd
)
337 const char *event_name
= "child_start";
338 struct json_writer jw
= JSON_WRITER_INIT
;
340 jw_object_begin(&jw
, 0);
341 event_fmt_prepare(event_name
, file
, line
, NULL
, &jw
);
342 jw_object_intmax(&jw
, "child_id", cmd
->trace2_child_id
);
343 if (cmd
->trace2_hook_name
) {
344 jw_object_string(&jw
, "child_class", "hook");
345 jw_object_string(&jw
, "hook_name", cmd
->trace2_hook_name
);
347 const char *child_class
=
348 cmd
->trace2_child_class
? cmd
->trace2_child_class
: "?";
349 jw_object_string(&jw
, "child_class", child_class
);
352 jw_object_string(&jw
, "cd", cmd
->dir
);
353 jw_object_bool(&jw
, "use_shell", cmd
->use_shell
);
354 jw_object_inline_begin_array(&jw
, "argv");
356 jw_array_string(&jw
, "git");
357 jw_array_argv(&jw
, cmd
->argv
);
361 tr2_dst_write_line(&tr2dst_event
, &jw
.json
);
365 static void fn_child_exit_fl(const char *file
, int line
,
366 uint64_t us_elapsed_absolute
, int cid
, int pid
,
367 int code
, uint64_t us_elapsed_child
)
369 const char *event_name
= "child_exit";
370 struct json_writer jw
= JSON_WRITER_INIT
;
371 double t_rel
= (double)us_elapsed_child
/ 1000000.0;
373 jw_object_begin(&jw
, 0);
374 event_fmt_prepare(event_name
, file
, line
, NULL
, &jw
);
375 jw_object_intmax(&jw
, "child_id", cid
);
376 jw_object_intmax(&jw
, "pid", pid
);
377 jw_object_intmax(&jw
, "code", code
);
378 jw_object_double(&jw
, "t_rel", 6, t_rel
);
381 tr2_dst_write_line(&tr2dst_event
, &jw
.json
);
386 static void fn_child_ready_fl(const char *file
, int line
,
387 uint64_t us_elapsed_absolute
, int cid
, int pid
,
388 const char *ready
, uint64_t us_elapsed_child
)
390 const char *event_name
= "child_ready";
391 struct json_writer jw
= JSON_WRITER_INIT
;
392 double t_rel
= (double)us_elapsed_child
/ 1000000.0;
394 jw_object_begin(&jw
, 0);
395 event_fmt_prepare(event_name
, file
, line
, NULL
, &jw
);
396 jw_object_intmax(&jw
, "child_id", cid
);
397 jw_object_intmax(&jw
, "pid", pid
);
398 jw_object_string(&jw
, "ready", ready
);
399 jw_object_double(&jw
, "t_rel", 6, t_rel
);
402 tr2_dst_write_line(&tr2dst_event
, &jw
.json
);
407 static void fn_thread_start_fl(const char *file
, int line
,
408 uint64_t us_elapsed_absolute
)
410 const char *event_name
= "thread_start";
411 struct json_writer jw
= JSON_WRITER_INIT
;
413 jw_object_begin(&jw
, 0);
414 event_fmt_prepare(event_name
, file
, line
, NULL
, &jw
);
417 tr2_dst_write_line(&tr2dst_event
, &jw
.json
);
421 static void fn_thread_exit_fl(const char *file
, int line
,
422 uint64_t us_elapsed_absolute
,
423 uint64_t us_elapsed_thread
)
425 const char *event_name
= "thread_exit";
426 struct json_writer jw
= JSON_WRITER_INIT
;
427 double t_rel
= (double)us_elapsed_thread
/ 1000000.0;
429 jw_object_begin(&jw
, 0);
430 event_fmt_prepare(event_name
, file
, line
, NULL
, &jw
);
431 jw_object_double(&jw
, "t_rel", 6, t_rel
);
434 tr2_dst_write_line(&tr2dst_event
, &jw
.json
);
438 static void fn_exec_fl(const char *file
, int line
, uint64_t us_elapsed_absolute
,
439 int exec_id
, const char *exe
, const char **argv
)
441 const char *event_name
= "exec";
442 struct json_writer jw
= JSON_WRITER_INIT
;
444 jw_object_begin(&jw
, 0);
445 event_fmt_prepare(event_name
, file
, line
, NULL
, &jw
);
446 jw_object_intmax(&jw
, "exec_id", exec_id
);
448 jw_object_string(&jw
, "exe", exe
);
449 jw_object_inline_begin_array(&jw
, "argv");
450 jw_array_argv(&jw
, argv
);
454 tr2_dst_write_line(&tr2dst_event
, &jw
.json
);
458 static void fn_exec_result_fl(const char *file
, int line
,
459 uint64_t us_elapsed_absolute
, int exec_id
,
462 const char *event_name
= "exec_result";
463 struct json_writer jw
= JSON_WRITER_INIT
;
465 jw_object_begin(&jw
, 0);
466 event_fmt_prepare(event_name
, file
, line
, NULL
, &jw
);
467 jw_object_intmax(&jw
, "exec_id", exec_id
);
468 jw_object_intmax(&jw
, "code", code
);
471 tr2_dst_write_line(&tr2dst_event
, &jw
.json
);
475 static void fn_param_fl(const char *file
, int line
, const char *param
,
478 const char *event_name
= "def_param";
479 struct json_writer jw
= JSON_WRITER_INIT
;
481 jw_object_begin(&jw
, 0);
482 event_fmt_prepare(event_name
, file
, line
, NULL
, &jw
);
483 jw_object_string(&jw
, "param", param
);
484 jw_object_string(&jw
, "value", value
);
487 tr2_dst_write_line(&tr2dst_event
, &jw
.json
);
491 static void fn_repo_fl(const char *file
, int line
,
492 const struct repository
*repo
)
494 const char *event_name
= "def_repo";
495 struct json_writer jw
= JSON_WRITER_INIT
;
497 jw_object_begin(&jw
, 0);
498 event_fmt_prepare(event_name
, file
, line
, repo
, &jw
);
499 jw_object_string(&jw
, "worktree", repo
->worktree
);
502 tr2_dst_write_line(&tr2dst_event
, &jw
.json
);
506 static void fn_region_enter_printf_va_fl(const char *file
, int line
,
507 uint64_t us_elapsed_absolute
,
508 const char *category
,
510 const struct repository
*repo
,
511 const char *fmt
, va_list ap
)
513 const char *event_name
= "region_enter";
514 struct tr2tls_thread_ctx
*ctx
= tr2tls_get_self();
515 if (ctx
->nr_open_regions
<= tr2env_event_max_nesting_levels
) {
516 struct json_writer jw
= JSON_WRITER_INIT
;
518 jw_object_begin(&jw
, 0);
519 event_fmt_prepare(event_name
, file
, line
, repo
, &jw
);
520 jw_object_intmax(&jw
, "nesting", ctx
->nr_open_regions
);
522 jw_object_string(&jw
, "category", category
);
524 jw_object_string(&jw
, "label", label
);
525 maybe_add_string_va(&jw
, "msg", fmt
, ap
);
528 tr2_dst_write_line(&tr2dst_event
, &jw
.json
);
533 static void fn_region_leave_printf_va_fl(
534 const char *file
, int line
, uint64_t us_elapsed_absolute
,
535 uint64_t us_elapsed_region
, const char *category
, const char *label
,
536 const struct repository
*repo
, const char *fmt
, va_list ap
)
538 const char *event_name
= "region_leave";
539 struct tr2tls_thread_ctx
*ctx
= tr2tls_get_self();
540 if (ctx
->nr_open_regions
<= tr2env_event_max_nesting_levels
) {
541 struct json_writer jw
= JSON_WRITER_INIT
;
542 double t_rel
= (double)us_elapsed_region
/ 1000000.0;
544 jw_object_begin(&jw
, 0);
545 event_fmt_prepare(event_name
, file
, line
, repo
, &jw
);
546 jw_object_double(&jw
, "t_rel", 6, t_rel
);
547 jw_object_intmax(&jw
, "nesting", ctx
->nr_open_regions
);
549 jw_object_string(&jw
, "category", category
);
551 jw_object_string(&jw
, "label", label
);
552 maybe_add_string_va(&jw
, "msg", fmt
, ap
);
555 tr2_dst_write_line(&tr2dst_event
, &jw
.json
);
560 static void fn_data_fl(const char *file
, int line
, uint64_t us_elapsed_absolute
,
561 uint64_t us_elapsed_region
, const char *category
,
562 const struct repository
*repo
, const char *key
,
565 const char *event_name
= "data";
566 struct tr2tls_thread_ctx
*ctx
= tr2tls_get_self();
567 if (ctx
->nr_open_regions
<= tr2env_event_max_nesting_levels
) {
568 struct json_writer jw
= JSON_WRITER_INIT
;
569 double t_abs
= (double)us_elapsed_absolute
/ 1000000.0;
570 double t_rel
= (double)us_elapsed_region
/ 1000000.0;
572 jw_object_begin(&jw
, 0);
573 event_fmt_prepare(event_name
, file
, line
, repo
, &jw
);
574 jw_object_double(&jw
, "t_abs", 6, t_abs
);
575 jw_object_double(&jw
, "t_rel", 6, t_rel
);
576 jw_object_intmax(&jw
, "nesting", ctx
->nr_open_regions
);
577 jw_object_string(&jw
, "category", category
);
578 jw_object_string(&jw
, "key", key
);
579 jw_object_string(&jw
, "value", value
);
582 tr2_dst_write_line(&tr2dst_event
, &jw
.json
);
587 static void fn_data_json_fl(const char *file
, int line
,
588 uint64_t us_elapsed_absolute
,
589 uint64_t us_elapsed_region
, const char *category
,
590 const struct repository
*repo
, const char *key
,
591 const struct json_writer
*value
)
593 const char *event_name
= "data_json";
594 struct tr2tls_thread_ctx
*ctx
= tr2tls_get_self();
595 if (ctx
->nr_open_regions
<= tr2env_event_max_nesting_levels
) {
596 struct json_writer jw
= JSON_WRITER_INIT
;
597 double t_abs
= (double)us_elapsed_absolute
/ 1000000.0;
598 double t_rel
= (double)us_elapsed_region
/ 1000000.0;
600 jw_object_begin(&jw
, 0);
601 event_fmt_prepare(event_name
, file
, line
, repo
, &jw
);
602 jw_object_double(&jw
, "t_abs", 6, t_abs
);
603 jw_object_double(&jw
, "t_rel", 6, t_rel
);
604 jw_object_intmax(&jw
, "nesting", ctx
->nr_open_regions
);
605 jw_object_string(&jw
, "category", category
);
606 jw_object_string(&jw
, "key", key
);
607 jw_object_sub_jw(&jw
, "value", value
);
610 tr2_dst_write_line(&tr2dst_event
, &jw
.json
);
615 struct tr2_tgt tr2_tgt_event
= {
628 fn_command_ancestry_fl
,
641 fn_region_enter_printf_va_fl
,
642 fn_region_leave_printf_va_fl
,