From: Lukas Fleischer <lfleischer@lfos.de>
To: git@vger.kernel.org
Cc: Nicolas Pitre <nico@fluxnic.net>,
Johannes Schindelin <Johannes.Schindelin@gmx.de>,
Junio C Hamano <gitster@pobox.com>, Jeff King <peff@peff.net>
Subject: [PATCH v4] Refactor recv_sideband()
Date: Tue, 28 Jun 2016 06:35:26 +0200 [thread overview]
Message-ID: <20160628043526.19403-1-lfleischer@lfos.de> (raw)
In-Reply-To: <20160613195224.13398-1-lfleischer@lfos.de>
Before this patch, we used character buffer manipulations to split
messages from the sideband at line breaks and insert "remote: " at the
beginning of each line, using the packet size to determine the end of a
message. However, since it is safe to assume that diagnostic messages
from the sideband never contain NUL characters, we can also
NUL-terminate the buffer, use strpbrk() for splitting lines and use
format strings to insert the prefix.
A strbuf is used for accumulating the output which is then printed using
a single fprintf() call with a single conversion specifier per line,
such that the atomicity of the output is preserved. See 9ac13ec (atomic
write for sideband remote messages, 2006-10-11) for details.
Helped-by: Jeff King <peff@peff.net>
Helped-by: Junio C Hamano <gitster@pobox.com>
Helped-by: Nicolas Pitre <nico@fluxnic.net>
Signed-off-by: Lukas Fleischer <lfleischer@lfos.de>
---
Changes since v3:
* The new code always frees the strbuf used for the output.
* Switched back to fprintf() to support ANSI codes under Windows.
* Added a comment on the tradeoff between atomicity and Windows support.
sideband.c | 125 ++++++++++++++++++++++++++-----------------------------------
1 file changed, 54 insertions(+), 71 deletions(-)
diff --git a/sideband.c b/sideband.c
index fde8adc..835d77d 100644
--- a/sideband.c
+++ b/sideband.c
@@ -13,111 +13,94 @@
* the remote died unexpectedly. A flush() concludes the stream.
*/
-#define PREFIX "remote:"
+#define PREFIX "remote: "
#define ANSI_SUFFIX "\033[K"
#define DUMB_SUFFIX " "
-#define FIX_SIZE 10 /* large enough for any of the above */
-
int recv_sideband(const char *me, int in_stream, int out)
{
- unsigned pf = strlen(PREFIX);
- unsigned sf;
- char buf[LARGE_PACKET_MAX + 2*FIX_SIZE];
- char *suffix, *term;
- int skip_pf = 0;
+ const char *term, *suffix;
+ char buf[LARGE_PACKET_MAX + 1];
+ struct strbuf outbuf = STRBUF_INIT;
+ const char *b, *brk;
+ int retval = 0;
- memcpy(buf, PREFIX, pf);
+ strbuf_addf(&outbuf, "%s", PREFIX);
term = getenv("TERM");
if (isatty(2) && term && strcmp(term, "dumb"))
suffix = ANSI_SUFFIX;
else
suffix = DUMB_SUFFIX;
- sf = strlen(suffix);
- while (1) {
+ while (retval == 0) {
int band, len;
- len = packet_read(in_stream, NULL, NULL, buf + pf, LARGE_PACKET_MAX, 0);
+ len = packet_read(in_stream, NULL, NULL, buf, LARGE_PACKET_MAX, 0);
if (len == 0)
break;
if (len < 1) {
fprintf(stderr, "%s: protocol error: no band designator\n", me);
- return SIDEBAND_PROTOCOL_ERROR;
+ retval = SIDEBAND_PROTOCOL_ERROR;
+ break;
}
- band = buf[pf] & 0xff;
+ band = buf[0] & 0xff;
+ buf[len] = '\0';
len--;
switch (band) {
case 3:
- buf[pf] = ' ';
- buf[pf+1+len] = '\0';
- fprintf(stderr, "%s\n", buf);
- return SIDEBAND_REMOTE_ERROR;
+ fprintf(stderr, "%s%s\n", PREFIX, buf + 1);
+ retval = SIDEBAND_REMOTE_ERROR;
+ break;
case 2:
- buf[pf] = ' ';
- do {
- char *b = buf;
- int brk = 0;
-
- /*
- * If the last buffer didn't end with a line
- * break then we should not print a prefix
- * this time around.
- */
- if (skip_pf) {
- b += pf+1;
- } else {
- len += pf+1;
- brk += pf+1;
- }
+ b = buf + 1;
- /* Look for a line break. */
- for (;;) {
- brk++;
- if (brk > len) {
- brk = 0;
- break;
- }
- if (b[brk-1] == '\n' ||
- b[brk-1] == '\r')
- break;
- }
+ /*
+ * Append a suffix to each nonempty line to clear the
+ * end of the screen line.
+ *
+ * The output is accumulated in a buffer and each line
+ * is printed to stderr using fprintf() with a single
+ * conversion specifier. This is a "best effort"
+ * approach to supporting both inter-process atomicity
+ * (single conversion specifiers are likely to end up
+ * in single atomic write() system calls) and the ANSI
+ * control code emulation under Windows.
+ */
+ while ((brk = strpbrk(b, "\n\r"))) {
+ int linelen = brk - b;
- /*
- * Let's insert a suffix to clear the end
- * of the screen line if a line break was
- * found. Also, if we don't skip the
- * prefix, then a non-empty string must be
- * present too.
- */
- if (brk > (skip_pf ? 0 : (pf+1 + 1))) {
- char save[FIX_SIZE];
- memcpy(save, b + brk, sf);
- b[brk + sf - 1] = b[brk - 1];
- memcpy(b + brk - 1, suffix, sf);
- fprintf(stderr, "%.*s", brk + sf, b);
- memcpy(b + brk, save, sf);
- len -= brk;
+ if (linelen > 0) {
+ strbuf_addf(&outbuf, "%.*s%s%c",
+ linelen, b, suffix, *brk);
} else {
- int l = brk ? brk : len;
- fprintf(stderr, "%.*s", l, b);
- len -= l;
+ strbuf_addf(&outbuf, "%c", *brk);
}
+ fprintf(stderr, "%.*s", (int)outbuf.len,
+ outbuf.buf);
+ strbuf_reset(&outbuf);
+ strbuf_addf(&outbuf, "%s", PREFIX);
+
+ b = brk + 1;
+ }
- skip_pf = !brk;
- memmove(buf + pf+1, b + brk, len);
- } while (len);
- continue;
+ if (*b)
+ strbuf_addf(&outbuf, "%s", b);
+ break;
case 1:
- write_or_die(out, buf + pf+1, len);
- continue;
+ write_or_die(out, buf + 1, len);
+ break;
default:
fprintf(stderr, "%s: protocol error: bad band #%d\n",
me, band);
- return SIDEBAND_PROTOCOL_ERROR;
+ retval = SIDEBAND_PROTOCOL_ERROR;
+ break;
}
}
- return 0;
+
+ if (outbuf.len > 0)
+ fprintf(stderr, "%.*s", (int)outbuf.len, outbuf.buf);
+ strbuf_release(&outbuf);
+ return retval;
}
/*
--
2.9.0
next prev parent reply other threads:[~2016-06-28 4:35 UTC|newest]
Thread overview: 60+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-06-13 19:52 [PATCH] Refactor recv_sideband() Lukas Fleischer
2016-06-13 21:07 ` Nicolas Pitre
2016-06-14 13:44 ` Johannes Schindelin
2016-06-14 15:04 ` Nicolas Pitre
2016-06-14 15:30 ` Johannes Schindelin
[not found] ` <Cq7rbYgOpb0CVCq7sbGmpL@videotron.ca>
2016-06-14 16:43 ` Nicolas Pitre
2016-06-14 17:09 ` Nicolas Pitre
[not found] ` <CsLdb3qLMBok7CsLebwX38@videotron.ca>
2016-06-14 17:55 ` Nicolas Pitre
2016-06-14 18:11 ` Junio C Hamano
2016-06-14 19:11 ` Lukas Fleischer
2016-06-14 19:16 ` Junio C Hamano
[not found] ` <Ct7VbfLfTHEALCt7Wbh8Xs@videotron.ca>
2016-06-14 20:10 ` Nicolas Pitre
2016-06-14 21:00 ` [PATCH v2] " Lukas Fleischer
2016-06-14 21:11 ` Lukas Fleischer
2016-06-14 21:25 ` Junio C Hamano
2016-06-15 3:44 ` Jeff King
[not found] ` <146597489449.32143.1327156804178869158@s-8d3a2dc3.on.site.uni-stuttgart.de>
2016-06-19 10:48 ` Lukas Fleischer
2016-06-24 15:31 ` Jeff King
2016-06-24 17:45 ` Johannes Schindelin
2016-06-24 18:14 ` Jeff King
2016-06-24 18:32 ` Junio C Hamano
2016-06-27 10:58 ` Lukas Fleischer
2016-06-27 15:54 ` Junio C Hamano
2016-06-27 16:16 ` Jeff King
2016-06-27 17:50 ` Junio C Hamano
2016-06-27 20:34 ` Lukas Fleischer
2016-06-27 20:47 ` Nicolas Pitre
2016-06-28 4:01 ` Lukas Fleischer
2016-06-28 5:20 ` Junio C Hamano
2016-06-28 10:04 ` Johannes Schindelin
2016-06-28 10:05 ` Johannes Schindelin
2016-06-28 15:13 ` Junio C Hamano
2016-06-28 16:21 ` Johannes Schindelin
2016-06-24 20:07 ` Dennis Kaarsemaker
2016-06-22 5:29 ` [PATCH v3] " Lukas Fleischer
2016-06-22 15:02 ` Nicolas Pitre
2016-06-22 22:47 ` Nicolas Pitre
2016-06-23 17:35 ` Lukas Fleischer
2016-06-23 18:59 ` Nicolas Pitre
2016-06-28 4:35 ` Lukas Fleischer [this message]
2016-06-28 16:57 ` [PATCH v4] " Junio C Hamano
2016-06-28 17:24 ` Junio C Hamano
2016-06-28 17:46 ` Nicolas Pitre
2016-06-28 18:13 ` Junio C Hamano
2016-06-28 18:28 ` Nicolas Pitre
2016-06-28 19:51 ` Junio C Hamano
2016-06-28 20:36 ` Nicolas Pitre
2016-06-28 21:09 ` Junio C Hamano
2016-06-28 21:44 ` Nicolas Pitre
2016-06-28 22:33 ` Junio C Hamano
2016-06-28 22:47 ` Junio C Hamano
2016-06-29 3:00 ` Junio C Hamano
2016-06-29 3:41 ` Nicolas Pitre
2016-06-29 2:02 ` Nicolas Pitre
2016-06-29 16:40 ` Junio C Hamano
2016-06-30 6:16 ` Lukas Fleischer
2016-07-01 20:01 ` Junio C Hamano
2016-07-05 20:35 ` Nicolas Pitre
2016-07-06 21:11 ` Junio C Hamano
2016-07-07 0:56 ` Nicolas Pitre
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20160628043526.19403-1-lfleischer@lfos.de \
--to=lfleischer@lfos.de \
--cc=Johannes.Schindelin@gmx.de \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=nico@fluxnic.net \
--cc=peff@peff.net \
/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.
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 NNTP newsgroup(s).