From: Junio C Hamano <gitster@pobox.com>
To: "Johannes Schindelin via GitGitGadget" <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, "Jeff King" <peff@peff.net>,
"SZEDER Gábor" <szeder.dev@gmail.com>,
"Alexandr Miloslavskiy" <alexandr.miloslavskiy@syntevo.com>,
"Johannes Schindelin" <johannes.schindelin@gmx.de>
Subject: Re: [PATCH v3 1/1] vreportf(): avoid relying on stdio buffering
Date: Wed, 30 Oct 2019 11:01:57 +0900 [thread overview]
Message-ID: <xmqqo8xz3sa2.fsf@gitster-ct.c.googlers.com> (raw)
In-Reply-To: <fce0894ee46f737322551b51edf5cd2a53413a50.1572379280.git.gitgitgadget@gmail.com> (Johannes Schindelin via GitGitGadget's message of "Tue, 29 Oct 2019 20:01:20 +0000")
"Johannes Schindelin via GitGitGadget" <gitgitgadget@gmail.com>
writes:
> Subject: Re: [PATCH v3 1/1] vreportf(): avoid relying on stdio buffering
perfect ;-)
> Let's avoid this predicament altogether by rendering the entire message,
> including the prefix and the trailing newline, into the buffer we
> already have (and which is still fixed size) and then write it out via
> `write_in_full()`.
>
> We still clip the message to at most 4095 characters.
Good.
> Also please note that we `fflush(stderr)` here to help when running in a
> Git Bash on Windows: in this case, `stderr` is not actually truly
> unbuffered, and needs the extra help.
I do not think you have to single out Windows in this case; if we
are writing directly to file descriptor #2, as long as there have
been something written by the process to the standard error stream
before our caller called us, we must flush it to make sure what
we are going to write out will come after, no matter what platform
we are on.
The process may have written to the standard error stream and
there may be something left in the buffer kept in the stdio
layer. Call fflush(stderr) before writing the message we
prepare in this function.
or something along that line would be sufficient.
> diff --git a/usage.c b/usage.c
> index 2fdb20086b..471efb2de9 100644
> --- a/usage.c
> +++ b/usage.c
> @@ -9,14 +9,21 @@
> void vreportf(const char *prefix, const char *err, va_list params)
> {
> char msg[4096];
> - char *p;
> + size_t off = strlcpy(msg, prefix, sizeof(msg));
> + char *p, *pend = msg + sizeof(msg);
>
> - vsnprintf(msg, sizeof(msg), err, params);
> - for (p = msg; *p; p++) {
> + p = off < pend - msg ? msg + off : pend - 1;
> + if (vsnprintf(p, pend - p, err, params) < 0)
> + *p = '\0'; /* vsnprintf() failed, clip at prefix */
> +
> + for (; p != pend - 1 && *p; p++) {
It may make the result much simpler to start with something like:
size_t prefix_len = strlen(prefix);
if (sizeof(msg) <= prefix_len) {
fprintf(stderr, "BUG!!! too long a prefix '%s'\n", prefix);
abort();
}
memcpy(msg, prefix, prefix_len);
p = msg + prefix_len;
as we agreed that we won't have prefix that will fill or overflow
msg[] based on your earlier reading of the callers like BUG-fl.
That way, we probably may be able to even lose the pend pointer and
arithmetic around it.
> if (iscntrl(*p) && *p != '\t' && *p != '\n')
> *p = '?';
> }
Thanks. With this flow it is crystal clear that the prefix is shown
as-is, while the payload is sanitized.
> - fprintf(stderr, "%s%s\n", prefix, msg);
> +
> + *(p++) = '\n'; /* we no longer need a NUL */
> + fflush(stderr);
> + write_in_full(2, msg, p - msg);
> }
>
> static NORETURN void usage_builtin(const char *err, va_list params)
next prev parent reply other threads:[~2019-10-30 2:02 UTC|newest]
Thread overview: 34+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-10-28 15:00 [PATCH 0/1] Fix t5516 flakiness in Visual Studio builds Johannes Schindelin via GitGitGadget
2019-10-28 15:00 ` [PATCH 1/1] vreportf(): avoid buffered write in favor of unbuffered one Johannes Schindelin via GitGitGadget
2019-10-29 3:18 ` Junio C Hamano
2019-10-29 12:30 ` Johannes Schindelin
2019-10-29 13:49 ` Jeff King
2019-10-29 14:13 ` Johannes Schindelin
2019-10-29 14:32 ` Jeff King
2019-10-29 20:09 ` Johannes Schindelin
2019-10-30 1:43 ` Junio C Hamano
2019-10-29 16:44 ` Junio C Hamano
2019-10-29 10:38 ` SZEDER Gábor
2019-10-29 12:38 ` Johannes Schindelin
2019-10-29 13:52 ` Jeff King
2019-10-29 14:18 ` Johannes Schindelin
2019-10-29 13:37 ` [PATCH v2 0/1] Fix t5516 flakiness in Visual Studio builds Johannes Schindelin via GitGitGadget
2019-10-29 13:37 ` [PATCH v2 1/1] vreportf(): avoid relying on stdio buffering Johannes Schindelin via GitGitGadget
2019-10-29 14:21 ` Alexandr Miloslavskiy
2019-10-29 19:57 ` Johannes Schindelin
2019-10-29 20:09 ` Jeff King
2019-10-29 20:24 ` Alexandr Miloslavskiy
2019-10-29 20:11 ` Alexandr Miloslavskiy
2019-10-29 20:01 ` [PATCH v3 0/1] Fix t5516 flakiness in Visual Studio builds Johannes Schindelin via GitGitGadget
2019-10-29 20:01 ` [PATCH v3 1/1] vreportf(): avoid relying on stdio buffering Johannes Schindelin via GitGitGadget
2019-10-29 20:32 ` Jeff King
2019-10-30 8:54 ` Johannes Schindelin
2019-10-31 6:24 ` Jeff King
2019-10-31 10:26 ` Johannes Schindelin
2019-10-31 15:48 ` Jeff King
2019-11-01 18:41 ` Johannes Schindelin
2019-10-30 2:01 ` Junio C Hamano [this message]
2019-10-30 9:13 ` Johannes Schindelin
2019-10-30 10:44 ` [PATCH v4 0/1] Fix t5516 flakiness in Visual Studio builds Johannes Schindelin via GitGitGadget
2019-10-30 10:44 ` [PATCH v4 1/1] vreportf(): avoid relying on stdio buffering Johannes Schindelin via GitGitGadget
2019-11-02 4:05 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqo8xz3sa2.fsf@gitster-ct.c.googlers.com \
--to=gitster@pobox.com \
--cc=alexandr.miloslavskiy@syntevo.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=johannes.schindelin@gmx.de \
--cc=peff@peff.net \
--cc=szeder.dev@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).