2019-02-22 22:25:01 +00:00
|
|
|
#ifndef TR2_TGT_H
|
|
|
|
#define TR2_TGT_H
|
|
|
|
|
|
|
|
struct child_process;
|
|
|
|
struct repository;
|
|
|
|
struct json_writer;
|
2022-10-24 13:41:06 +00:00
|
|
|
struct tr2_timer_metadata;
|
|
|
|
struct tr2_timer;
|
2022-10-24 13:41:07 +00:00
|
|
|
struct tr2_counter_metadata;
|
|
|
|
struct tr2_counter;
|
2022-10-24 13:41:06 +00:00
|
|
|
|
|
|
|
#define NS_TO_SEC(ns) ((double)(ns) / 1.0e9)
|
2019-02-22 22:25:01 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Function prototypes for a TRACE2 "target" vtable.
|
|
|
|
*/
|
|
|
|
|
|
|
|
typedef int(tr2_tgt_init_t)(void);
|
|
|
|
typedef void(tr2_tgt_term_t)(void);
|
|
|
|
|
|
|
|
typedef void(tr2_tgt_evt_version_fl_t)(const char *file, int line);
|
|
|
|
|
|
|
|
typedef void(tr2_tgt_evt_start_fl_t)(const char *file, int line,
|
2019-04-15 20:39:44 +00:00
|
|
|
uint64_t us_elapsed_absolute,
|
2019-02-22 22:25:01 +00:00
|
|
|
const char **argv);
|
|
|
|
typedef void(tr2_tgt_evt_exit_fl_t)(const char *file, int line,
|
|
|
|
uint64_t us_elapsed_absolute, int code);
|
|
|
|
typedef void(tr2_tgt_evt_signal_t)(uint64_t us_elapsed_absolute, int signo);
|
|
|
|
typedef void(tr2_tgt_evt_atexit_t)(uint64_t us_elapsed_absolute, int code);
|
|
|
|
|
|
|
|
typedef void(tr2_tgt_evt_error_va_fl_t)(const char *file, int line,
|
|
|
|
const char *fmt, va_list ap);
|
|
|
|
|
|
|
|
typedef void(tr2_tgt_evt_command_path_fl_t)(const char *file, int line,
|
|
|
|
const char *command_path);
|
tr2: log parent process name
It can be useful to tell who invoked Git - was it invoked manually by a
user via CLI or script? By an IDE? In some cases - like 'repo' tool -
we can influence the source code and set the GIT_TRACE2_PARENT_SID
environment variable from the caller process. In 'repo''s case, that
parent SID is manipulated to include the string "repo", which means we
can positively identify when Git was invoked by 'repo' tool. However,
identifying parents that way requires both that we know which tools
invoke Git and that we have the ability to modify the source code of
those tools. It cannot scale to keep up with the various IDEs and
wrappers which use Git, most of which we don't know about. Learning
which tools and wrappers invoke Git, and how, would give us insight to
decide where to improve Git's usability and performance.
Unfortunately, there's no cross-platform reliable way to gather the name
of the parent process. If procfs is present, we can use that; otherwise
we will need to discover the name another way. However, the process ID
should be sufficient to look up the process name on most platforms, so
that code may be shareable.
Git for Windows gathers similar information and logs it as a "data_json"
event. However, since "data_json" has a variable format, it is difficult
to parse effectively in some languages; instead, let's pursue a
dedicated "cmd_ancestry" event to record information about the ancestry
of the current process and a consistent, parseable way.
Git for Windows also gathers information about more than one generation
of parent. In Linux further ancestry info can be gathered with procfs,
but it's unwieldy to do so. In the interest of later moving Git for
Windows ancestry logging to the 'cmd_ancestry' event, and in the
interest of later adding more ancestry to the Linux implementation - or
of adding this functionality to other platforms which have an easier
time walking the process tree - let's make 'cmd_ancestry' accept an
array of parentage.
Signed-off-by: Emily Shaffer <emilyshaffer@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-07-22 01:27:07 +00:00
|
|
|
typedef void(tr2_tgt_evt_command_ancestry_fl_t)(const char *file, int line,
|
|
|
|
const char **parent_names);
|
2019-02-22 22:25:01 +00:00
|
|
|
typedef void(tr2_tgt_evt_command_name_fl_t)(const char *file, int line,
|
|
|
|
const char *name,
|
|
|
|
const char *hierarchy);
|
|
|
|
typedef void(tr2_tgt_evt_command_mode_fl_t)(const char *file, int line,
|
|
|
|
const char *mode);
|
|
|
|
|
|
|
|
typedef void(tr2_tgt_evt_alias_fl_t)(const char *file, int line,
|
|
|
|
const char *alias, const char **argv);
|
|
|
|
|
|
|
|
typedef void(tr2_tgt_evt_child_start_fl_t)(const char *file, int line,
|
|
|
|
uint64_t us_elapsed_absolute,
|
|
|
|
const struct child_process *cmd);
|
|
|
|
typedef void(tr2_tgt_evt_child_exit_fl_t)(const char *file, int line,
|
|
|
|
uint64_t us_elapsed_absolute, int cid,
|
|
|
|
int pid, int code,
|
|
|
|
uint64_t us_elapsed_child);
|
2021-09-20 15:36:12 +00:00
|
|
|
typedef void(tr2_tgt_evt_child_ready_fl_t)(const char *file, int line,
|
|
|
|
uint64_t us_elapsed_absolute,
|
|
|
|
int cid, int pid, const char *ready,
|
|
|
|
uint64_t us_elapsed_child);
|
2019-02-22 22:25:01 +00:00
|
|
|
|
|
|
|
typedef void(tr2_tgt_evt_thread_start_fl_t)(const char *file, int line,
|
|
|
|
uint64_t us_elapsed_absolute);
|
|
|
|
typedef void(tr2_tgt_evt_thread_exit_fl_t)(const char *file, int line,
|
|
|
|
uint64_t us_elapsed_absolute,
|
|
|
|
uint64_t us_elapsed_thread);
|
|
|
|
|
|
|
|
typedef void(tr2_tgt_evt_exec_fl_t)(const char *file, int line,
|
|
|
|
uint64_t us_elapsed_absolute, int exec_id,
|
|
|
|
const char *exe, const char **argv);
|
|
|
|
typedef void(tr2_tgt_evt_exec_result_fl_t)(const char *file, int line,
|
|
|
|
uint64_t us_elapsed_absolute,
|
|
|
|
int exec_id, int code);
|
|
|
|
|
2023-06-28 19:26:26 +00:00
|
|
|
struct key_value_info;
|
2019-02-22 22:25:01 +00:00
|
|
|
typedef void(tr2_tgt_evt_param_fl_t)(const char *file, int line,
|
2023-06-28 19:26:26 +00:00
|
|
|
const char *param, const char *value,
|
|
|
|
const struct key_value_info *kvi);
|
2019-02-22 22:25:01 +00:00
|
|
|
|
|
|
|
typedef void(tr2_tgt_evt_repo_fl_t)(const char *file, int line,
|
|
|
|
const struct repository *repo);
|
|
|
|
|
|
|
|
typedef void(tr2_tgt_evt_region_enter_printf_va_fl_t)(
|
|
|
|
const char *file, int line, uint64_t us_elapsed_absolute,
|
|
|
|
const char *category, const char *label, const struct repository *repo,
|
|
|
|
const char *fmt, va_list ap);
|
|
|
|
typedef void(tr2_tgt_evt_region_leave_printf_va_fl_t)(
|
|
|
|
const char *file, int line, uint64_t us_elapsed_absolute,
|
|
|
|
uint64_t us_elapsed_region, const char *category, const char *label,
|
|
|
|
const struct repository *repo, const char *fmt, va_list ap);
|
|
|
|
|
|
|
|
typedef void(tr2_tgt_evt_data_fl_t)(const char *file, int line,
|
|
|
|
uint64_t us_elapsed_absolute,
|
|
|
|
uint64_t us_elapsed_region,
|
|
|
|
const char *category,
|
|
|
|
const struct repository *repo,
|
|
|
|
const char *key, const char *value);
|
|
|
|
typedef void(tr2_tgt_evt_data_json_fl_t)(const char *file, int line,
|
|
|
|
uint64_t us_elapsed_absolute,
|
|
|
|
uint64_t us_elapsed_region,
|
|
|
|
const char *category,
|
|
|
|
const struct repository *repo,
|
|
|
|
const char *key,
|
|
|
|
const struct json_writer *value);
|
|
|
|
|
|
|
|
typedef void(tr2_tgt_evt_printf_va_fl_t)(const char *file, int line,
|
|
|
|
uint64_t us_elapsed_absolute,
|
|
|
|
const char *fmt, va_list ap);
|
|
|
|
|
2022-10-24 13:41:06 +00:00
|
|
|
typedef void(tr2_tgt_evt_timer_t)(const struct tr2_timer_metadata *meta,
|
|
|
|
const struct tr2_timer *timer,
|
|
|
|
int is_final_data);
|
|
|
|
|
2022-10-24 13:41:07 +00:00
|
|
|
typedef void(tr2_tgt_evt_counter_t)(const struct tr2_counter_metadata *meta,
|
|
|
|
const struct tr2_counter *counter,
|
|
|
|
int is_final_data);
|
|
|
|
|
2019-02-22 22:25:01 +00:00
|
|
|
/*
|
|
|
|
* "vtable" for a TRACE2 target. Use NULL if a target does not want
|
|
|
|
* to emit that message.
|
|
|
|
*/
|
|
|
|
/* clang-format off */
|
|
|
|
struct tr2_tgt {
|
|
|
|
struct tr2_dst *pdst;
|
|
|
|
|
|
|
|
tr2_tgt_init_t *pfn_init;
|
|
|
|
tr2_tgt_term_t *pfn_term;
|
|
|
|
|
|
|
|
tr2_tgt_evt_version_fl_t *pfn_version_fl;
|
|
|
|
tr2_tgt_evt_start_fl_t *pfn_start_fl;
|
|
|
|
tr2_tgt_evt_exit_fl_t *pfn_exit_fl;
|
|
|
|
tr2_tgt_evt_signal_t *pfn_signal;
|
|
|
|
tr2_tgt_evt_atexit_t *pfn_atexit;
|
|
|
|
tr2_tgt_evt_error_va_fl_t *pfn_error_va_fl;
|
|
|
|
tr2_tgt_evt_command_path_fl_t *pfn_command_path_fl;
|
tr2: log parent process name
It can be useful to tell who invoked Git - was it invoked manually by a
user via CLI or script? By an IDE? In some cases - like 'repo' tool -
we can influence the source code and set the GIT_TRACE2_PARENT_SID
environment variable from the caller process. In 'repo''s case, that
parent SID is manipulated to include the string "repo", which means we
can positively identify when Git was invoked by 'repo' tool. However,
identifying parents that way requires both that we know which tools
invoke Git and that we have the ability to modify the source code of
those tools. It cannot scale to keep up with the various IDEs and
wrappers which use Git, most of which we don't know about. Learning
which tools and wrappers invoke Git, and how, would give us insight to
decide where to improve Git's usability and performance.
Unfortunately, there's no cross-platform reliable way to gather the name
of the parent process. If procfs is present, we can use that; otherwise
we will need to discover the name another way. However, the process ID
should be sufficient to look up the process name on most platforms, so
that code may be shareable.
Git for Windows gathers similar information and logs it as a "data_json"
event. However, since "data_json" has a variable format, it is difficult
to parse effectively in some languages; instead, let's pursue a
dedicated "cmd_ancestry" event to record information about the ancestry
of the current process and a consistent, parseable way.
Git for Windows also gathers information about more than one generation
of parent. In Linux further ancestry info can be gathered with procfs,
but it's unwieldy to do so. In the interest of later moving Git for
Windows ancestry logging to the 'cmd_ancestry' event, and in the
interest of later adding more ancestry to the Linux implementation - or
of adding this functionality to other platforms which have an easier
time walking the process tree - let's make 'cmd_ancestry' accept an
array of parentage.
Signed-off-by: Emily Shaffer <emilyshaffer@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-07-22 01:27:07 +00:00
|
|
|
tr2_tgt_evt_command_ancestry_fl_t *pfn_command_ancestry_fl;
|
2019-02-22 22:25:01 +00:00
|
|
|
tr2_tgt_evt_command_name_fl_t *pfn_command_name_fl;
|
|
|
|
tr2_tgt_evt_command_mode_fl_t *pfn_command_mode_fl;
|
|
|
|
tr2_tgt_evt_alias_fl_t *pfn_alias_fl;
|
|
|
|
tr2_tgt_evt_child_start_fl_t *pfn_child_start_fl;
|
|
|
|
tr2_tgt_evt_child_exit_fl_t *pfn_child_exit_fl;
|
2021-09-20 15:36:12 +00:00
|
|
|
tr2_tgt_evt_child_ready_fl_t *pfn_child_ready_fl;
|
2019-02-22 22:25:01 +00:00
|
|
|
tr2_tgt_evt_thread_start_fl_t *pfn_thread_start_fl;
|
|
|
|
tr2_tgt_evt_thread_exit_fl_t *pfn_thread_exit_fl;
|
|
|
|
tr2_tgt_evt_exec_fl_t *pfn_exec_fl;
|
|
|
|
tr2_tgt_evt_exec_result_fl_t *pfn_exec_result_fl;
|
|
|
|
tr2_tgt_evt_param_fl_t *pfn_param_fl;
|
|
|
|
tr2_tgt_evt_repo_fl_t *pfn_repo_fl;
|
|
|
|
tr2_tgt_evt_region_enter_printf_va_fl_t *pfn_region_enter_printf_va_fl;
|
|
|
|
tr2_tgt_evt_region_leave_printf_va_fl_t *pfn_region_leave_printf_va_fl;
|
|
|
|
tr2_tgt_evt_data_fl_t *pfn_data_fl;
|
|
|
|
tr2_tgt_evt_data_json_fl_t *pfn_data_json_fl;
|
|
|
|
tr2_tgt_evt_printf_va_fl_t *pfn_printf_va_fl;
|
2022-10-24 13:41:06 +00:00
|
|
|
tr2_tgt_evt_timer_t *pfn_timer;
|
2022-10-24 13:41:07 +00:00
|
|
|
tr2_tgt_evt_counter_t *pfn_counter;
|
2019-02-22 22:25:01 +00:00
|
|
|
};
|
|
|
|
/* clang-format on */
|
|
|
|
|
|
|
|
extern struct tr2_tgt tr2_tgt_event;
|
|
|
|
extern struct tr2_tgt tr2_tgt_normal;
|
|
|
|
extern struct tr2_tgt tr2_tgt_perf;
|
|
|
|
|
|
|
|
#endif /* TR2_TGT_H */
|