213724d5cb92649192e8fab06b4b5283a8b0319b
1#include "cache.h"
2#include "config.h"
3#include "run-command.h"
4#include "quote.h"
5#include "version.h"
6#include "trace2/tr2_dst.h"
7#include "trace2/tr2_sysenv.h"
8#include "trace2/tr2_tbuf.h"
9#include "trace2/tr2_tgt.h"
10#include "trace2/tr2_tls.h"
11
12static struct tr2_dst tr2dst_normal = { TR2_SYSENV_NORMAL, 0, 0, 0 };
13
14/*
15 * Use the TR2_SYSENV_NORMAL_BRIEF setting to omit the "<time> <file>:<line>"
16 * fields from each line written to the builtin normal target.
17 *
18 * Unit tests may want to use this to help with testing.
19 */
20static int tr2env_normal_be_brief;
21
22#define TR2FMT_NORMAL_FL_WIDTH (50)
23
24static int fn_init(void)
25{
26 int want = tr2_dst_trace_want(&tr2dst_normal);
27 int want_brief;
28 const char *brief;
29
30 if (!want)
31 return want;
32
33 brief = tr2_sysenv_get(TR2_SYSENV_NORMAL_BRIEF);
34 if (brief && *brief &&
35 ((want_brief = git_parse_maybe_bool(brief)) != -1))
36 tr2env_normal_be_brief = want_brief;
37
38 return want;
39}
40
41static void fn_term(void)
42{
43 tr2_dst_trace_disable(&tr2dst_normal);
44}
45
46static void normal_fmt_prepare(const char *file, int line, struct strbuf *buf)
47{
48 strbuf_setlen(buf, 0);
49
50 if (!tr2env_normal_be_brief) {
51 struct tr2_tbuf tb_now;
52
53 tr2_tbuf_local_time(&tb_now);
54 strbuf_addstr(buf, tb_now.buf);
55 strbuf_addch(buf, ' ');
56
57 if (file && *file)
58 strbuf_addf(buf, "%s:%d ", file, line);
59 while (buf->len < TR2FMT_NORMAL_FL_WIDTH)
60 strbuf_addch(buf, ' ');
61 }
62}
63
64static void normal_io_write_fl(const char *file, int line,
65 const struct strbuf *buf_payload)
66{
67 struct strbuf buf_line = STRBUF_INIT;
68
69 normal_fmt_prepare(file, line, &buf_line);
70 strbuf_addbuf(&buf_line, buf_payload);
71 tr2_dst_write_line(&tr2dst_normal, &buf_line);
72 strbuf_release(&buf_line);
73}
74
75static void fn_version_fl(const char *file, int line)
76{
77 struct strbuf buf_payload = STRBUF_INIT;
78
79 strbuf_addf(&buf_payload, "version %s", git_version_string);
80 normal_io_write_fl(file, line, &buf_payload);
81 strbuf_release(&buf_payload);
82}
83
84static void fn_start_fl(const char *file, int line,
85 uint64_t us_elapsed_absolute, const char **argv)
86{
87 struct strbuf buf_payload = STRBUF_INIT;
88
89 strbuf_addstr(&buf_payload, "start ");
90 sq_quote_argv_pretty(&buf_payload, argv);
91 normal_io_write_fl(file, line, &buf_payload);
92 strbuf_release(&buf_payload);
93}
94
95static void fn_exit_fl(const char *file, int line, uint64_t us_elapsed_absolute,
96 int code)
97{
98 struct strbuf buf_payload = STRBUF_INIT;
99 double elapsed = (double)us_elapsed_absolute / 1000000.0;
100
101 strbuf_addf(&buf_payload, "exit elapsed:%.6f code:%d", elapsed, code);
102 normal_io_write_fl(file, line, &buf_payload);
103 strbuf_release(&buf_payload);
104}
105
106static void fn_signal(uint64_t us_elapsed_absolute, int signo)
107{
108 struct strbuf buf_payload = STRBUF_INIT;
109 double elapsed = (double)us_elapsed_absolute / 1000000.0;
110
111 strbuf_addf(&buf_payload, "signal elapsed:%.6f code:%d", elapsed,
112 signo);
113 normal_io_write_fl(__FILE__, __LINE__, &buf_payload);
114 strbuf_release(&buf_payload);
115}
116
117static void fn_atexit(uint64_t us_elapsed_absolute, int code)
118{
119 struct strbuf buf_payload = STRBUF_INIT;
120 double elapsed = (double)us_elapsed_absolute / 1000000.0;
121
122 strbuf_addf(&buf_payload, "atexit elapsed:%.6f code:%d", elapsed, code);
123 normal_io_write_fl(__FILE__, __LINE__, &buf_payload);
124 strbuf_release(&buf_payload);
125}
126
127static void maybe_append_string_va(struct strbuf *buf, const char *fmt,
128 va_list ap)
129{
130 if (fmt && *fmt) {
131 va_list copy_ap;
132
133 va_copy(copy_ap, ap);
134 strbuf_vaddf(buf, fmt, copy_ap);
135 va_end(copy_ap);
136 return;
137 }
138}
139
140static void fn_error_va_fl(const char *file, int line, const char *fmt,
141 va_list ap)
142{
143 struct strbuf buf_payload = STRBUF_INIT;
144
145 strbuf_addstr(&buf_payload, "error");
146 if (fmt && *fmt) {
147 strbuf_addch(&buf_payload, ' ');
148 maybe_append_string_va(&buf_payload, fmt, ap);
149 }
150 normal_io_write_fl(file, line, &buf_payload);
151 strbuf_release(&buf_payload);
152}
153
154static void fn_command_path_fl(const char *file, int line, const char *pathname)
155{
156 struct strbuf buf_payload = STRBUF_INIT;
157
158 strbuf_addf(&buf_payload, "cmd_path %s", pathname);
159 normal_io_write_fl(file, line, &buf_payload);
160 strbuf_release(&buf_payload);
161}
162
163static void fn_command_name_fl(const char *file, int line, const char *name,
164 const char *hierarchy)
165{
166 struct strbuf buf_payload = STRBUF_INIT;
167
168 strbuf_addf(&buf_payload, "cmd_name %s", name);
169 if (hierarchy && *hierarchy)
170 strbuf_addf(&buf_payload, " (%s)", hierarchy);
171 normal_io_write_fl(file, line, &buf_payload);
172 strbuf_release(&buf_payload);
173}
174
175static void fn_command_mode_fl(const char *file, int line, const char *mode)
176{
177 struct strbuf buf_payload = STRBUF_INIT;
178
179 strbuf_addf(&buf_payload, "cmd_mode %s", mode);
180 normal_io_write_fl(file, line, &buf_payload);
181 strbuf_release(&buf_payload);
182}
183
184static void fn_alias_fl(const char *file, int line, const char *alias,
185 const char **argv)
186{
187 struct strbuf buf_payload = STRBUF_INIT;
188
189 strbuf_addf(&buf_payload, "alias %s ->", alias);
190 sq_quote_argv_pretty(&buf_payload, argv);
191 normal_io_write_fl(file, line, &buf_payload);
192 strbuf_release(&buf_payload);
193}
194
195static void fn_child_start_fl(const char *file, int line,
196 uint64_t us_elapsed_absolute,
197 const struct child_process *cmd)
198{
199 struct strbuf buf_payload = STRBUF_INIT;
200
201 strbuf_addf(&buf_payload, "child_start[%d] ", cmd->trace2_child_id);
202
203 if (cmd->dir) {
204 strbuf_addstr(&buf_payload, " cd");
205 sq_quote_buf_pretty(&buf_payload, cmd->dir);
206 strbuf_addstr(&buf_payload, "; ");
207 }
208
209 /*
210 * TODO if (cmd->env) { Consider dumping changes to environment. }
211 * See trace_add_env() in run-command.c as used by original trace.c
212 */
213
214 if (cmd->git_cmd)
215 strbuf_addstr(&buf_payload, "git");
216 sq_quote_argv_pretty(&buf_payload, cmd->argv);
217
218 normal_io_write_fl(file, line, &buf_payload);
219 strbuf_release(&buf_payload);
220}
221
222static void fn_child_exit_fl(const char *file, int line,
223 uint64_t us_elapsed_absolute, int cid, int pid,
224 int code, uint64_t us_elapsed_child)
225{
226 struct strbuf buf_payload = STRBUF_INIT;
227 double elapsed = (double)us_elapsed_child / 1000000.0;
228
229 strbuf_addf(&buf_payload, "child_exit[%d] pid:%d code:%d elapsed:%.6f",
230 cid, pid, code, elapsed);
231 normal_io_write_fl(file, line, &buf_payload);
232 strbuf_release(&buf_payload);
233}
234
235static void fn_exec_fl(const char *file, int line, uint64_t us_elapsed_absolute,
236 int exec_id, const char *exe, const char **argv)
237{
238 struct strbuf buf_payload = STRBUF_INIT;
239
240 strbuf_addf(&buf_payload, "exec[%d] ", exec_id);
241 if (exe)
242 strbuf_addstr(&buf_payload, exe);
243 sq_quote_argv_pretty(&buf_payload, argv);
244 normal_io_write_fl(file, line, &buf_payload);
245 strbuf_release(&buf_payload);
246}
247
248static void fn_exec_result_fl(const char *file, int line,
249 uint64_t us_elapsed_absolute, int exec_id,
250 int code)
251{
252 struct strbuf buf_payload = STRBUF_INIT;
253
254 strbuf_addf(&buf_payload, "exec_result[%d] code:%d", exec_id, code);
255 if (code > 0)
256 strbuf_addf(&buf_payload, " err:%s", strerror(code));
257 normal_io_write_fl(file, line, &buf_payload);
258 strbuf_release(&buf_payload);
259}
260
261static void fn_param_fl(const char *file, int line, const char *param,
262 const char *value)
263{
264 struct strbuf buf_payload = STRBUF_INIT;
265
266 strbuf_addf(&buf_payload, "def_param %s=%s", param, value);
267 normal_io_write_fl(file, line, &buf_payload);
268 strbuf_release(&buf_payload);
269}
270
271static void fn_repo_fl(const char *file, int line,
272 const struct repository *repo)
273{
274 struct strbuf buf_payload = STRBUF_INIT;
275
276 strbuf_addstr(&buf_payload, "worktree ");
277 sq_quote_buf_pretty(&buf_payload, repo->worktree);
278 normal_io_write_fl(file, line, &buf_payload);
279 strbuf_release(&buf_payload);
280}
281
282static void fn_printf_va_fl(const char *file, int line,
283 uint64_t us_elapsed_absolute, const char *fmt,
284 va_list ap)
285{
286 struct strbuf buf_payload = STRBUF_INIT;
287
288 maybe_append_string_va(&buf_payload, fmt, ap);
289 normal_io_write_fl(file, line, &buf_payload);
290 strbuf_release(&buf_payload);
291}
292
293struct tr2_tgt tr2_tgt_normal = {
294 &tr2dst_normal,
295
296 fn_init,
297 fn_term,
298
299 fn_version_fl,
300 fn_start_fl,
301 fn_exit_fl,
302 fn_signal,
303 fn_atexit,
304 fn_error_va_fl,
305 fn_command_path_fl,
306 fn_command_name_fl,
307 fn_command_mode_fl,
308 fn_alias_fl,
309 fn_child_start_fl,
310 fn_child_exit_fl,
311 NULL, /* thread_start */
312 NULL, /* thread_exit */
313 fn_exec_fl,
314 fn_exec_result_fl,
315 fn_param_fl,
316 fn_repo_fl,
317 NULL, /* region_enter */
318 NULL, /* region_leave */
319 NULL, /* data */
320 NULL, /* data_json */
321 fn_printf_va_fl,
322};