Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
vreportf: avoid intermediate buffer
When we call "die(fmt, args...)", we end up in vreportf with
two pieces of information:

  1. The prefix "fatal: "

  2. The original fmt and va_list of args.

We format item (2) into a temporary buffer, and then fprintf
the prefix and the temporary buffer, along with a newline.
This has the unfortunate side effect of truncating any error
messages that are longer than 4096 bytes.

Instead, let's use separate calls for the prefix and
newline, letting us hand the item (2) directly to vfprintf.
This is essentially undoing d048a96 (print
warning/error/fatal messages in one shot, 2007-11-09), which
tried to have the whole output end up in a single `write`
call.

But we can address this instead by explicitly requesting
line-buffering for the output handle, and by making sure
that the buffer is empty before we start (so that outputting
the prefix does not cause a flush due to hitting the buffer
limit).

We may still break the output into two writes if the content
is larger than our buffer, but there's not much we can do
there; depending on the stdio implementation, that might
have happened even with a single fprintf call.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Jeff King authored and Junio C Hamano committed Aug 11, 2015
1 parent 3b331e9 commit f4c3edc
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions usage.c
Expand Up @@ -7,13 +7,21 @@
#include "cache.h"

static FILE *error_handle;
static int tweaked_error_buffering;

void vreportf(const char *prefix, const char *err, va_list params)
{
char msg[4096];
FILE *fh = error_handle ? error_handle : stderr;
vsnprintf(msg, sizeof(msg), err, params);
fprintf(fh, "%s%s\n", prefix, msg);

fflush(fh);
if (!tweaked_error_buffering) {
setvbuf(fh, NULL, _IOLBF, 0);
tweaked_error_buffering = 1;
}

fputs(prefix, fh);
vfprintf(fh, err, params);
fputc('\n', fh);
}

static NORETURN void usage_builtin(const char *err, va_list params)
Expand Down Expand Up @@ -70,6 +78,7 @@ void set_die_is_recursing_routine(int (*routine)(void))
void set_error_handle(FILE *fh)
{
error_handle = fh;
tweaked_error_buffering = 0;
}

void NORETURN usagef(const char *err, ...)
Expand Down

0 comments on commit f4c3edc

Please sign in to comment.