trace2 / tr2_tgt_normal.con commit general improvements (43abf13)
   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_append_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_append_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        strbuf_addch(&buf_payload, ' ');
 215        if (cmd->git_cmd)
 216                strbuf_addstr(&buf_payload, "git ");
 217        sq_append_quote_argv_pretty(&buf_payload, cmd->argv);
 218
 219        normal_io_write_fl(file, line, &buf_payload);
 220        strbuf_release(&buf_payload);
 221}
 222
 223static void fn_child_exit_fl(const char *file, int line,
 224                             uint64_t us_elapsed_absolute, int cid, int pid,
 225                             int code, uint64_t us_elapsed_child)
 226{
 227        struct strbuf buf_payload = STRBUF_INIT;
 228        double elapsed = (double)us_elapsed_child / 1000000.0;
 229
 230        strbuf_addf(&buf_payload, "child_exit[%d] pid:%d code:%d elapsed:%.6f",
 231                    cid, pid, code, elapsed);
 232        normal_io_write_fl(file, line, &buf_payload);
 233        strbuf_release(&buf_payload);
 234}
 235
 236static void fn_exec_fl(const char *file, int line, uint64_t us_elapsed_absolute,
 237                       int exec_id, const char *exe, const char **argv)
 238{
 239        struct strbuf buf_payload = STRBUF_INIT;
 240
 241        strbuf_addf(&buf_payload, "exec[%d] ", exec_id);
 242        if (exe) {
 243                strbuf_addstr(&buf_payload, exe);
 244                strbuf_addch(&buf_payload, ' ');
 245        }
 246        sq_append_quote_argv_pretty(&buf_payload, argv);
 247        normal_io_write_fl(file, line, &buf_payload);
 248        strbuf_release(&buf_payload);
 249}
 250
 251static void fn_exec_result_fl(const char *file, int line,
 252                              uint64_t us_elapsed_absolute, int exec_id,
 253                              int code)
 254{
 255        struct strbuf buf_payload = STRBUF_INIT;
 256
 257        strbuf_addf(&buf_payload, "exec_result[%d] code:%d", exec_id, code);
 258        if (code > 0)
 259                strbuf_addf(&buf_payload, " err:%s", strerror(code));
 260        normal_io_write_fl(file, line, &buf_payload);
 261        strbuf_release(&buf_payload);
 262}
 263
 264static void fn_param_fl(const char *file, int line, const char *param,
 265                        const char *value)
 266{
 267        struct strbuf buf_payload = STRBUF_INIT;
 268
 269        strbuf_addf(&buf_payload, "def_param %s=%s", param, value);
 270        normal_io_write_fl(file, line, &buf_payload);
 271        strbuf_release(&buf_payload);
 272}
 273
 274static void fn_repo_fl(const char *file, int line,
 275                       const struct repository *repo)
 276{
 277        struct strbuf buf_payload = STRBUF_INIT;
 278
 279        strbuf_addstr(&buf_payload, "worktree ");
 280        sq_quote_buf_pretty(&buf_payload, repo->worktree);
 281        normal_io_write_fl(file, line, &buf_payload);
 282        strbuf_release(&buf_payload);
 283}
 284
 285static void fn_printf_va_fl(const char *file, int line,
 286                            uint64_t us_elapsed_absolute, const char *fmt,
 287                            va_list ap)
 288{
 289        struct strbuf buf_payload = STRBUF_INIT;
 290
 291        maybe_append_string_va(&buf_payload, fmt, ap);
 292        normal_io_write_fl(file, line, &buf_payload);
 293        strbuf_release(&buf_payload);
 294}
 295
 296struct tr2_tgt tr2_tgt_normal = {
 297        &tr2dst_normal,
 298
 299        fn_init,
 300        fn_term,
 301
 302        fn_version_fl,
 303        fn_start_fl,
 304        fn_exit_fl,
 305        fn_signal,
 306        fn_atexit,
 307        fn_error_va_fl,
 308        fn_command_path_fl,
 309        fn_command_name_fl,
 310        fn_command_mode_fl,
 311        fn_alias_fl,
 312        fn_child_start_fl,
 313        fn_child_exit_fl,
 314        NULL, /* thread_start */
 315        NULL, /* thread_exit */
 316        fn_exec_fl,
 317        fn_exec_result_fl,
 318        fn_param_fl,
 319        fn_repo_fl,
 320        NULL, /* region_enter */
 321        NULL, /* region_leave */
 322        NULL, /* data */
 323        NULL, /* data_json */
 324        fn_printf_va_fl,
 325};