summaryrefslogtreecommitdiff
path: root/pkt-line.c
diff options
context:
space:
mode:
authorJeff King <peff@peff.net>2011-02-24 09:30:19 -0500
committerJunio C Hamano <gitster@pobox.com>2011-03-08 12:12:04 -0800
commitbbc30f996380eacd71ca061675d5d0c5f21c45d2 (patch)
treef4a2531496b943eb6339cffd71a251df3a83d6a7 /pkt-line.c
parent94b3b3746456949d834ec7bf454da3db4eb439cf (diff)
downloadgit-bbc30f996380eacd71ca061675d5d0c5f21c45d2.tar.gz
add packet tracing debug code
This shows a trace of all packets coming in or out of a given program. This can help with debugging object negotiation or other protocol issues. To keep the code changes simple, we operate at the lowest level, meaning we don't necessarily understand what's in the packets. The one exception is a packet starting with "PACK", which causes us to skip that packet and turn off tracing (since the gigantic pack data will not be interesting to read, at least not in the trace format). We show both written and read packets. In the local case, this may mean you will see packets twice (written by the sender and read by the receiver). However, for cases where the other end is remote, this allows you to see the full conversation. Packet tracing can be enabled with GIT_TRACE_PACKET=<foo>, where <foo> takes the same arguments as GIT_TRACE. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'pkt-line.c')
-rw-r--r--pkt-line.c55
1 files changed, 54 insertions, 1 deletions
diff --git a/pkt-line.c b/pkt-line.c
index 295ba2b16c..cd1bd26413 100644
--- a/pkt-line.c
+++ b/pkt-line.c
@@ -1,6 +1,51 @@
#include "cache.h"
#include "pkt-line.h"
+const char *packet_trace_prefix = "git";
+static const char trace_key[] = "GIT_TRACE_PACKET";
+
+void packet_trace_identity(const char *prog)
+{
+ packet_trace_prefix = xstrdup(prog);
+}
+
+static void packet_trace(const char *buf, unsigned int len, int write)
+{
+ int i;
+ struct strbuf out;
+
+ if (!trace_want(trace_key))
+ return;
+
+ /* +32 is just a guess for header + quoting */
+ strbuf_init(&out, len+32);
+
+ strbuf_addf(&out, "packet: %12s%c ",
+ packet_trace_prefix, write ? '>' : '<');
+
+ if ((len >= 4 && !prefixcmp(buf, "PACK")) ||
+ (len >= 5 && !prefixcmp(buf+1, "PACK"))) {
+ strbuf_addstr(&out, "PACK ...");
+ unsetenv(trace_key);
+ }
+ else {
+ /* XXX we should really handle printable utf8 */
+ for (i = 0; i < len; i++) {
+ /* suppress newlines */
+ if (buf[i] == '\n')
+ continue;
+ if (buf[i] >= 0x20 && buf[i] <= 0x7e)
+ strbuf_addch(&out, buf[i]);
+ else
+ strbuf_addf(&out, "\\%o", buf[i]);
+ }
+ }
+
+ strbuf_addch(&out, '\n');
+ trace_strbuf(trace_key, &out);
+ strbuf_release(&out);
+}
+
/*
* Write a packetized stream, where each line is preceded by
* its length (including the header) as a 4-byte hex number.
@@ -39,11 +84,13 @@ ssize_t safe_write(int fd, const void *buf, ssize_t n)
*/
void packet_flush(int fd)
{
+ packet_trace("0000", 4, 1);
safe_write(fd, "0000", 4);
}
void packet_buf_flush(struct strbuf *buf)
{
+ packet_trace("0000", 4, 1);
strbuf_add(buf, "0000", 4);
}
@@ -62,6 +109,7 @@ static unsigned format_packet(const char *fmt, va_list args)
buffer[1] = hex(n >> 8);
buffer[2] = hex(n >> 4);
buffer[3] = hex(n);
+ packet_trace(buffer+4, n-4, 1);
return n;
}
@@ -130,13 +178,16 @@ int packet_read_line(int fd, char *buffer, unsigned size)
len = packet_length(linelen);
if (len < 0)
die("protocol error: bad line length character: %.4s", linelen);
- if (!len)
+ if (!len) {
+ packet_trace("0000", 4, 0);
return 0;
+ }
len -= 4;
if (len >= size)
die("protocol error: bad line length %d", len);
safe_read(fd, buffer, len);
buffer[len] = 0;
+ packet_trace(buffer, len, 0);
return len;
}
@@ -153,6 +204,7 @@ int packet_get_line(struct strbuf *out,
if (!len) {
*src_buf += 4;
*src_len -= 4;
+ packet_trace("0000", 4, 0);
return 0;
}
if (*src_len < len)
@@ -165,5 +217,6 @@ int packet_get_line(struct strbuf *out,
strbuf_add(out, *src_buf, len);
*src_buf += len;
*src_len -= len;
+ packet_trace(out->buf, out->len, 0);
return len;
}