bug_fl(): correctly initialize trace2 va_list

The code added 0cc05b044f (usage.c: add a non-fatal bug() function to go
with BUG(), 2022-06-02) sets up two va_list variables: one to output to
stderr, and one to trace2. But the order of initialization is wrong:

  va_list ap, cp;
  va_copy(cp, ap);
  va_start(ap, fmt);

We copy the contents of "ap" into "cp" before it is initialized, meaning
it is full of garbage. The two should be swapped.

However, there's another bug, noticed by Johannes Schindelin: we forget
to call va_end() for the copy. So instead of just fixing the copy's
initialization, let's do two separate start/end pairs. This is allowed
by the standard, and we don't need to use copy here since we have access
to the original varargs. Matching the pairs with the calls makes it more
obvious that everything is being done correctly.

Note that we do call bug_fl() in the tests, but it didn't trigger this
problem because our format string doesn't have any placeholders. So even
though we were passing a garbage va_list through the stack, nobody ever
needed to look at it. We can easily adjust one of the trace2 tests to
trigger this, both for bug() and for BUG(). The latter isn't broken, but
it's nice to exercise both a bit more. Without the fix in this patch
(but with the test change), the bug() case causes a segfault.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/t/helper/test-trace2.c b/t/helper/test-trace2.c
index 180c7f53f3178e0e157fb5cc036c4cd164683aa2..a714130ece77c334c982b8a9520d7fb1b9fa6a3d 100644 (file)
--- a/t/helper/test-trace2.c
+++ b/t/helper/test-trace2.c
@@ -224,8 +224,8 @@ static int ut_009bug_BUG(int argc, const char **argv)
 
 static int ut_010bug_BUG(int argc, const char **argv)
 {
-       bug("a bug message");
-       BUG("a BUG message");
+       bug("a %s message", "bug");
+       BUG("a %s message", "BUG");
 }
 
 /*

diff --git a/usage.c b/usage.c
index 79900d0287f41c1b6d14dcf6c40bf4c84887be99..56e29d6cd6a7c6276d888f2fed0b553d9637005a 100644 (file)
--- a/usage.c
+++ b/usage.c
@@ -334,15 +334,17 @@ NORETURN void BUG_fl(const char *file, int line, const char *fmt, ...)
 int bug_called_must_BUG;
 void bug_fl(const char *file, int line, const char *fmt, ...)
 {
-       va_list ap, cp;
+       va_list ap;
 
        bug_called_must_BUG = 1;
 
-       va_copy(cp, ap);
        va_start(ap, fmt);
        BUG_vfl_common(file, line, fmt, ap);
        va_end(ap);
-       trace2_cmd_error_va(fmt, cp);
+
+       va_start(ap, fmt);
+       trace2_cmd_error_va(fmt, ap);
+       va_end(ap);
 }
 
 #ifdef SUPPRESS_ANNOTATED_LEAKS