From a6007ea55e1dfca12a99a7ce75e4cd54a41f7dfc Mon Sep 17 00:00:00 2001
From: Jeff Hostetler <jeffhostetler@github.com>
Date: Wed, 26 Jun 2024 12:27:41 -0400
Subject: [PATCH] trace2: prefetch value of GIT_TRACE2_DST_DEBUG at startup

Prefetch the value of GIT_TRACE2_DST_DEBUG during startup and before
we try to open any Trace2 destination pathnames.

Normally, Trace2 always silently fails if a destination target
cannot be opened so that it doesn't affect the execution of a
Git command.  The command should run normally, but just not
generate any trace data.  This can make it difficult to debug
a telemetry setup, since the user doesn't know why telemetry
isn't being generated.  If the environment variable
GIT_TRACE2_DST_DEBUG is true, the Trace2 startup will print
a warning message with the `errno` to make debugging easier.

However, on Windows, looking up the env variable resets `errno`
so the warning message always ends with `...tracing: No error`
which is not very helpful.

Prefetch the env variable at startup.  This avoids the need
to update each call-site to capture `errno` in the usual
`saved-errno` variable.

Signed-off-by: Jeff Hostetler <jeffhostetler@github.com>
---
 trace2.c         | 10 ++++++++++
 trace2/tr2_dst.c |  2 +-
 trace2/tr2_dst.h | 12 ++++++++++++
 3 files changed, 23 insertions(+), 1 deletion(-)

diff --git a/trace2.c b/trace2.c
index f894532d05331c..0a4ff698f607ab 100644
--- a/trace2.c
+++ b/trace2.c
@@ -225,6 +225,16 @@ void trace2_initialize_fl(const char *file, int line)
 	if (!tr2_tgt_want_builtins())
 		return;
 	trace2_enabled = 1;
+
+	/*
+	 * getenv() on Windows stomps on `errno` and the code in
+	 * tr2_dst.c verifies that warnings are enabled before
+	 * formatting the warning message (and calling strerror()).
+	 * So prefetch the value from the environment before we need
+	 * it.
+	 */
+	tr2_dst_want_warning();
+
 	if (!git_env_bool("GIT_TRACE2_REDACT", 1))
 		trace2_redact = 0;
 
diff --git a/trace2/tr2_dst.c b/trace2/tr2_dst.c
index 5be892cd5cdefa..61579f24bdbde3 100644
--- a/trace2/tr2_dst.c
+++ b/trace2/tr2_dst.c
@@ -24,7 +24,7 @@
  */
 static int tr2env_max_files = 0;
 
-static int tr2_dst_want_warning(void)
+int tr2_dst_want_warning(void)
 {
 	static int tr2env_dst_debug = -1;
 
diff --git a/trace2/tr2_dst.h b/trace2/tr2_dst.h
index b1a8c144e073ba..4166539eb9e100 100644
--- a/trace2/tr2_dst.h
+++ b/trace2/tr2_dst.h
@@ -35,4 +35,16 @@ int tr2_dst_trace_want(struct tr2_dst *dst);
  */
 void tr2_dst_write_line(struct tr2_dst *dst, struct strbuf *buf_line);
 
+/*
+ * Return true if we want warning messages when trying to open a
+ * destination.
+ *
+ * (Trace2 always silently fails if a target cannot be opened so that
+ * we don't affect the execution of the Git command, but it is helpful
+ * for debugging telemetry configuration if we log warning messages
+ * when trying to open a target. This is controlled by another config
+ * value.)
+ */
+int tr2_dst_want_warning(void);
+
 #endif /* TR2_DST_H */