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_thread_start_fl(const char *file, int line,
387 uint64_t us_elapsed_absolute)
389 const char *event_name = "thread_start";
390 struct json_writer jw = JSON_WRITER_INIT;
392 jw_object_begin(&jw, 0);
393 event_fmt_prepare(event_name, file, line, NULL, &jw);
396 tr2_dst_write_line(&tr2dst_event, &jw.json);
400 static void fn_thread_exit_fl(const char *file, int line,
401 uint64_t us_elapsed_absolute,
402 uint64_t us_elapsed_thread)
404 const char *event_name = "thread_exit";
405 struct json_writer jw = JSON_WRITER_INIT;
406 double t_rel = (double)us_elapsed_thread / 1000000.0;
408 jw_object_begin(&jw, 0);
409 event_fmt_prepare(event_name, file, line, NULL, &jw);
410 jw_object_double(&jw, "t_rel", 6, t_rel);
413 tr2_dst_write_line(&tr2dst_event, &jw.json);
417 static void fn_exec_fl(const char *file, int line, uint64_t us_elapsed_absolute,
418 int exec_id, const char *exe, const char **argv)
420 const char *event_name = "exec";
421 struct json_writer jw = JSON_WRITER_INIT;
423 jw_object_begin(&jw, 0);
424 event_fmt_prepare(event_name, file, line, NULL, &jw);
425 jw_object_intmax(&jw, "exec_id", exec_id);
427 jw_object_string(&jw, "exe", exe);
428 jw_object_inline_begin_array(&jw, "argv");
429 jw_array_argv(&jw, argv);
433 tr2_dst_write_line(&tr2dst_event, &jw.json);
437 static void fn_exec_result_fl(const char *file, int line,
438 uint64_t us_elapsed_absolute, int exec_id,
441 const char *event_name = "exec_result";
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);
447 jw_object_intmax(&jw, "code", code);
450 tr2_dst_write_line(&tr2dst_event, &jw.json);
454 static void fn_param_fl(const char *file, int line, const char *param,
457 const char *event_name = "def_param";
458 struct json_writer jw = JSON_WRITER_INIT;
460 jw_object_begin(&jw, 0);
461 event_fmt_prepare(event_name, file, line, NULL, &jw);
462 jw_object_string(&jw, "param", param);
463 jw_object_string(&jw, "value", value);
466 tr2_dst_write_line(&tr2dst_event, &jw.json);
470 static void fn_repo_fl(const char *file, int line,
471 const struct repository *repo)
473 const char *event_name = "def_repo";
474 struct json_writer jw = JSON_WRITER_INIT;
476 jw_object_begin(&jw, 0);
477 event_fmt_prepare(event_name, file, line, repo, &jw);
478 jw_object_string(&jw, "worktree", repo->worktree);
481 tr2_dst_write_line(&tr2dst_event, &jw.json);
485 static void fn_region_enter_printf_va_fl(const char *file, int line,
486 uint64_t us_elapsed_absolute,
487 const char *category,
489 const struct repository *repo,
490 const char *fmt, va_list ap)
492 const char *event_name = "region_enter";
493 struct tr2tls_thread_ctx *ctx = tr2tls_get_self();
494 if (ctx->nr_open_regions <= tr2env_event_max_nesting_levels) {
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_intmax(&jw, "nesting", ctx->nr_open_regions);
501 jw_object_string(&jw, "category", category);
503 jw_object_string(&jw, "label", label);
504 maybe_add_string_va(&jw, "msg", fmt, ap);
507 tr2_dst_write_line(&tr2dst_event, &jw.json);
512 static void fn_region_leave_printf_va_fl(
513 const char *file, int line, uint64_t us_elapsed_absolute,
514 uint64_t us_elapsed_region, const char *category, const char *label,
515 const struct repository *repo, const char *fmt, va_list ap)
517 const char *event_name = "region_leave";
518 struct tr2tls_thread_ctx *ctx = tr2tls_get_self();
519 if (ctx->nr_open_regions <= tr2env_event_max_nesting_levels) {
520 struct json_writer jw = JSON_WRITER_INIT;
521 double t_rel = (double)us_elapsed_region / 1000000.0;
523 jw_object_begin(&jw, 0);
524 event_fmt_prepare(event_name, file, line, repo, &jw);
525 jw_object_double(&jw, "t_rel", 6, t_rel);
526 jw_object_intmax(&jw, "nesting", ctx->nr_open_regions);
528 jw_object_string(&jw, "category", category);
530 jw_object_string(&jw, "label", label);
531 maybe_add_string_va(&jw, "msg", fmt, ap);
534 tr2_dst_write_line(&tr2dst_event, &jw.json);
539 static void fn_data_fl(const char *file, int line, uint64_t us_elapsed_absolute,
540 uint64_t us_elapsed_region, const char *category,
541 const struct repository *repo, const char *key,
544 const char *event_name = "data";
545 struct tr2tls_thread_ctx *ctx = tr2tls_get_self();
546 if (ctx->nr_open_regions <= tr2env_event_max_nesting_levels) {
547 struct json_writer jw = JSON_WRITER_INIT;
548 double t_abs = (double)us_elapsed_absolute / 1000000.0;
549 double t_rel = (double)us_elapsed_region / 1000000.0;
551 jw_object_begin(&jw, 0);
552 event_fmt_prepare(event_name, file, line, repo, &jw);
553 jw_object_double(&jw, "t_abs", 6, t_abs);
554 jw_object_double(&jw, "t_rel", 6, t_rel);
555 jw_object_intmax(&jw, "nesting", ctx->nr_open_regions);
556 jw_object_string(&jw, "category", category);
557 jw_object_string(&jw, "key", key);
558 jw_object_string(&jw, "value", value);
561 tr2_dst_write_line(&tr2dst_event, &jw.json);
566 static void fn_data_json_fl(const char *file, int line,
567 uint64_t us_elapsed_absolute,
568 uint64_t us_elapsed_region, const char *category,
569 const struct repository *repo, const char *key,
570 const struct json_writer *value)
572 const char *event_name = "data_json";
573 struct tr2tls_thread_ctx *ctx = tr2tls_get_self();
574 if (ctx->nr_open_regions <= tr2env_event_max_nesting_levels) {
575 struct json_writer jw = JSON_WRITER_INIT;
576 double t_abs = (double)us_elapsed_absolute / 1000000.0;
577 double t_rel = (double)us_elapsed_region / 1000000.0;
579 jw_object_begin(&jw, 0);
580 event_fmt_prepare(event_name, file, line, repo, &jw);
581 jw_object_double(&jw, "t_abs", 6, t_abs);
582 jw_object_double(&jw, "t_rel", 6, t_rel);
583 jw_object_intmax(&jw, "nesting", ctx->nr_open_regions);
584 jw_object_string(&jw, "category", category);
585 jw_object_string(&jw, "key", key);
586 jw_object_sub_jw(&jw, "value", value);
589 tr2_dst_write_line(&tr2dst_event, &jw.json);
594 struct tr2_tgt tr2_tgt_event = {
607 fn_command_ancestry_fl,
619 fn_region_enter_printf_va_fl,
620 fn_region_leave_printf_va_fl,