trace2 / tr2_tgt_normal.con commit doc: fix repeated words (24966cd)
   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        if (fmt && *fmt) {
 140                strbuf_addstr(buf, fmt);
 141                return;
 142        }
 143}
 144
 145static void fn_error_va_fl(const char *file, int line, const char *fmt,
 146                           va_list ap)
 147{
 148        struct strbuf buf_payload = STRBUF_INIT;
 149
 150        strbuf_addstr(&buf_payload, "error ");
 151        maybe_append_string_va(&buf_payload, fmt, ap);
 152        normal_io_write_fl(file, line, &buf_payload);
 153        strbuf_release(&buf_payload);
 154}
 155
 156static void fn_command_path_fl(const char *file, int line, const char *pathname)
 157{
 158        struct strbuf buf_payload = STRBUF_INIT;
 159
 160        strbuf_addf(&buf_payload, "cmd_path %s", pathname);
 161        normal_io_write_fl(file, line, &buf_payload);
 162        strbuf_release(&buf_payload);
 163}
 164
 165static void fn_command_name_fl(const char *file, int line, const char *name,
 166                               const char *hierarchy)
 167{
 168        struct strbuf buf_payload = STRBUF_INIT;
 169
 170        strbuf_addf(&buf_payload, "cmd_name %s", name);
 171        if (hierarchy && *hierarchy)
 172                strbuf_addf(&buf_payload, " (%s)", hierarchy);
 173        normal_io_write_fl(file, line, &buf_payload);
 174        strbuf_release(&buf_payload);
 175}
 176
 177static void fn_command_mode_fl(const char *file, int line, const char *mode)
 178{
 179        struct strbuf buf_payload = STRBUF_INIT;
 180
 181        strbuf_addf(&buf_payload, "cmd_mode %s", mode);
 182        normal_io_write_fl(file, line, &buf_payload);
 183        strbuf_release(&buf_payload);
 184}
 185
 186static void fn_alias_fl(const char *file, int line, const char *alias,
 187                        const char **argv)
 188{
 189        struct strbuf buf_payload = STRBUF_INIT;
 190
 191        strbuf_addf(&buf_payload, "alias %s ->", alias);
 192        sq_quote_argv_pretty(&buf_payload, argv);
 193        normal_io_write_fl(file, line, &buf_payload);
 194        strbuf_release(&buf_payload);
 195}
 196
 197static void fn_child_start_fl(const char *file, int line,
 198                              uint64_t us_elapsed_absolute,
 199                              const struct child_process *cmd)
 200{
 201        struct strbuf buf_payload = STRBUF_INIT;
 202
 203        strbuf_addf(&buf_payload, "child_start[%d] ", cmd->trace2_child_id);
 204
 205        if (cmd->dir) {
 206                strbuf_addstr(&buf_payload, " cd");
 207                sq_quote_buf_pretty(&buf_payload, cmd->dir);
 208                strbuf_addstr(&buf_payload, "; ");
 209        }
 210
 211        /*
 212         * TODO if (cmd->env) { Consider dumping changes to environment. }
 213         * See trace_add_env() in run-command.c as used by original trace.c
 214         */
 215
 216        if (cmd->git_cmd)
 217                strbuf_addstr(&buf_payload, "git");
 218        sq_quote_argv_pretty(&buf_payload, cmd->argv);
 219
 220        normal_io_write_fl(file, line, &buf_payload);
 221        strbuf_release(&buf_payload);
 222}
 223
 224static void fn_child_exit_fl(const char *file, int line,
 225                             uint64_t us_elapsed_absolute, int cid, int pid,
 226                             int code, uint64_t us_elapsed_child)
 227{
 228        struct strbuf buf_payload = STRBUF_INIT;
 229        double elapsed = (double)us_elapsed_child / 1000000.0;
 230
 231        strbuf_addf(&buf_payload, "child_exit[%d] pid:%d code:%d elapsed:%.6f",
 232                    cid, pid, code, elapsed);
 233        normal_io_write_fl(file, line, &buf_payload);
 234        strbuf_release(&buf_payload);
 235}
 236
 237static void fn_exec_fl(const char *file, int line, uint64_t us_elapsed_absolute,
 238                       int exec_id, const char *exe, const char **argv)
 239{
 240        struct strbuf buf_payload = STRBUF_INIT;
 241
 242        strbuf_addf(&buf_payload, "exec[%d] ", exec_id);
 243        if (exe)
 244                strbuf_addstr(&buf_payload, exe);
 245        sq_quote_argv_pretty(&buf_payload, argv);
 246        normal_io_write_fl(file, line, &buf_payload);
 247        strbuf_release(&buf_payload);
 248}
 249
 250static void fn_exec_result_fl(const char *file, int line,
 251                              uint64_t us_elapsed_absolute, int exec_id,
 252                              int code)
 253{
 254        struct strbuf buf_payload = STRBUF_INIT;
 255
 256        strbuf_addf(&buf_payload, "exec_result[%d] code:%d", exec_id, code);
 257        if (code > 0)
 258                strbuf_addf(&buf_payload, " err:%s", strerror(code));
 259        normal_io_write_fl(file, line, &buf_payload);
 260        strbuf_release(&buf_payload);
 261}
 262
 263static void fn_param_fl(const char *file, int line, const char *param,
 264                        const char *value)
 265{
 266        struct strbuf buf_payload = STRBUF_INIT;
 267
 268        strbuf_addf(&buf_payload, "def_param %s=%s", param, value);
 269        normal_io_write_fl(file, line, &buf_payload);
 270        strbuf_release(&buf_payload);
 271}
 272
 273static void fn_repo_fl(const char *file, int line,
 274                       const struct repository *repo)
 275{
 276        struct strbuf buf_payload = STRBUF_INIT;
 277
 278        strbuf_addstr(&buf_payload, "worktree ");
 279        sq_quote_buf_pretty(&buf_payload, repo->worktree);
 280        normal_io_write_fl(file, line, &buf_payload);
 281        strbuf_release(&buf_payload);
 282}
 283
 284static void fn_printf_va_fl(const char *file, int line,
 285                            uint64_t us_elapsed_absolute, const char *fmt,
 286                            va_list ap)
 287{
 288        struct strbuf buf_payload = STRBUF_INIT;
 289
 290        maybe_append_string_va(&buf_payload, fmt, ap);
 291        normal_io_write_fl(file, line, &buf_payload);
 292        strbuf_release(&buf_payload);
 293}
 294
 295struct tr2_tgt tr2_tgt_normal = {
 296        &tr2dst_normal,
 297
 298        fn_init,
 299        fn_term,
 300
 301        fn_version_fl,
 302        fn_start_fl,
 303        fn_exit_fl,
 304        fn_signal,
 305        fn_atexit,
 306        fn_error_va_fl,
 307        fn_command_path_fl,
 308        fn_command_name_fl,
 309        fn_command_mode_fl,
 310        fn_alias_fl,
 311        fn_child_start_fl,
 312        fn_child_exit_fl,
 313        NULL, /* thread_start */
 314        NULL, /* thread_exit */
 315        fn_exec_fl,
 316        fn_exec_result_fl,
 317        fn_param_fl,
 318        fn_repo_fl,
 319        NULL, /* region_enter */
 320        NULL, /* region_leave */
 321        NULL, /* data */
 322        NULL, /* data_json */
 323        fn_printf_va_fl,
 324};