[thirdparty/git.git] / pkt-line.c

#include "cache.h"
#include "pkt-line.h"
#include "run-command.h"

char packet_buffer[LARGE_PACKET_MAX];
static const char *packet_trace_prefix = "git";
static struct trace_key trace_packet = TRACE_KEY_INIT(PACKET);
static struct trace_key trace_pack = TRACE_KEY_INIT(PACKFILE);

void packet_trace_identity(const char *prog)
{
	packet_trace_prefix = xstrdup(prog);
}

static const char *get_trace_prefix(void)
{
	return in_async() ? "sideband" : packet_trace_prefix;
}

static int packet_trace_pack(const char *buf, unsigned int len, int sideband)
{
	if (!sideband) {
		trace_verbatim(&trace_pack, buf, len);
		return 1;
	} else if (len && *buf == '\1') {
		trace_verbatim(&trace_pack, buf + 1, len - 1);
		return 1;
	} else {
		/* it's another non-pack sideband */
		return 0;
	}
}

static void packet_trace(const char *buf, unsigned int len, int write)
{
	int i;
	struct strbuf out;
	static int in_pack, sideband;

	if (!trace_want(&trace_packet) && !trace_want(&trace_pack))
		return;

	if (in_pack) {
		if (packet_trace_pack(buf, len, sideband))
			return;
	} else if (starts_with(buf, "PACK") || starts_with(buf, "\1PACK")) {
		in_pack = 1;
		sideband = *buf == '\1';
		packet_trace_pack(buf, len, sideband);

		/*
		 * Make a note in the human-readable trace that the pack data
		 * started.
		 */
		buf = "PACK ...";
		len = strlen(buf);
	}

	if (!trace_want(&trace_packet))
		return;

	/* +32 is just a guess for header + quoting */
	strbuf_init(&out, len+32);

	strbuf_addf(&out, "packet: %12s%c ",
		    get_trace_prefix(), write ? '>' : '<');

	/* 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_packet, &out);
	strbuf_release(&out);
}

/*
 * If we buffered things up above (we don't, but we should),
 * we'd flush it here
 */
void packet_flush(int fd)
{
	packet_trace("0000", 4, 1);
	if (write_in_full(fd, "0000", 4) < 0)
		die_errno(_("unable to write flush packet"));
}

void packet_delim(int fd)
{
	packet_trace("0001", 4, 1);
	if (write_in_full(fd, "0001", 4) < 0)
		die_errno(_("unable to write delim packet"));
}

void packet_response_end(int fd)
{
	packet_trace("0002", 4, 1);
	if (write_in_full(fd, "0002", 4) < 0)
		die_errno(_("unable to write response end packet"));
}

int packet_flush_gently(int fd)
{
	packet_trace("0000", 4, 1);
	if (write_in_full(fd, "0000", 4) < 0)
		return error(_("flush packet write failed"));
	return 0;
}

void packet_buf_flush(struct strbuf *buf)
{
	packet_trace("0000", 4, 1);
	strbuf_add(buf, "0000", 4);
}

void packet_buf_delim(struct strbuf *buf)
{
	packet_trace("0001", 4, 1);
	strbuf_add(buf, "0001", 4);
}

void set_packet_header(char *buf, int size)
{
	static char hexchar[] = "0123456789abcdef";

	#define hex(a) (hexchar[(a) & 15])
	buf[0] = hex(size >> 12);
	buf[1] = hex(size >> 8);
	buf[2] = hex(size >> 4);
	buf[3] = hex(size);
	#undef hex
}

static void format_packet(struct strbuf *out, const char *prefix,
			  const char *fmt, va_list args)
{
	size_t orig_len, n;

	orig_len = out->len;
	strbuf_addstr(out, "0000");
	strbuf_addstr(out, prefix);
	strbuf_vaddf(out, fmt, args);
	n = out->len - orig_len;

	if (n > LARGE_PACKET_MAX)
		die(_("protocol error: impossibly long line"));

	set_packet_header(&out->buf[orig_len], n);
	packet_trace(out->buf + orig_len + 4, n - 4, 1);
}

static int packet_write_fmt_1(int fd, int gently, const char *prefix,
			      const char *fmt, va_list args)
{
	static struct strbuf buf = STRBUF_INIT;

	strbuf_reset(&buf);
	format_packet(&buf, prefix, fmt, args);
	if (write_in_full(fd, buf.buf, buf.len) < 0) {
		if (!gently) {
			check_pipe(errno);
			die_errno(_("packet write with format failed"));
		}
		return error(_("packet write with format failed"));
	}

	return 0;
}

void packet_write_fmt(int fd, const char *fmt, ...)
{
	va_list args;

	va_start(args, fmt);
	packet_write_fmt_1(fd, 0, "", fmt, args);
	va_end(args);
}

int packet_write_fmt_gently(int fd, const char *fmt, ...)
{
	int status;
	va_list args;

	va_start(args, fmt);
	status = packet_write_fmt_1(fd, 1, "", fmt, args);
	va_end(args);
	return status;
}

static int do_packet_write(const int fd_out, const char *buf, size_t size,
			   struct strbuf *err)
{
	char header[4];
	size_t packet_size;

	if (size > LARGE_PACKET_DATA_MAX) {
		strbuf_addstr(err, _("packet write failed - data exceeds max packet size"));
		return -1;
	}

	packet_trace(buf, size, 1);
	packet_size = size + 4;

	set_packet_header(header, packet_size);

	/*
	 * Write the header and the buffer in 2 parts so that we do
	 * not need to allocate a buffer or rely on a static buffer.
	 * This also avoids putting a large buffer on the stack which
	 * might have multi-threading issues.
	 */

	if (write_in_full(fd_out, header, 4) < 0 ||
	    write_in_full(fd_out, buf, size) < 0) {
		strbuf_addf(err, _("packet write failed: %s"), strerror(errno));
		return -1;
	}
	return 0;
}

static int packet_write_gently(const int fd_out, const char *buf, size_t size)
{
	struct strbuf err = STRBUF_INIT;
	if (do_packet_write(fd_out, buf, size, &err)) {
		error("%s", err.buf);
		strbuf_release(&err);
		return -1;
	}
	return 0;
}

void packet_write(int fd_out, const char *buf, size_t size)
{
	struct strbuf err = STRBUF_INIT;
	if (do_packet_write(fd_out, buf, size, &err))
		die("%s", err.buf);
}

void packet_fwrite(FILE *f, const char *buf, size_t size)
{
	size_t packet_size;
	char header[4];

	if (size > LARGE_PACKET_DATA_MAX)
		die(_("packet write failed - data exceeds max packet size"));

	packet_trace(buf, size, 1);
	packet_size = size + 4;

	set_packet_header(header, packet_size);
	fwrite_or_die(f, header, 4);
	fwrite_or_die(f, buf, size);
}

void packet_fwrite_fmt(FILE *fh, const char *fmt, ...)
{
       static struct strbuf buf = STRBUF_INIT;
       va_list args;

       strbuf_reset(&buf);

       va_start(args, fmt);
       format_packet(&buf, "", fmt, args);
       va_end(args);

       fwrite_or_die(fh, buf.buf, buf.len);
}

void packet_fflush(FILE *f)
{
	packet_trace("0000", 4, 1);
	fwrite_or_die(f, "0000", 4);
	fflush_or_die(f);
}

void packet_buf_write(struct strbuf *buf, const char *fmt, ...)
{
	va_list args;

	va_start(args, fmt);
	format_packet(buf, "", fmt, args);
	va_end(args);
}

int write_packetized_from_fd_no_flush(int fd_in, int fd_out)
{
	char *buf = xmalloc(LARGE_PACKET_DATA_MAX);
	int err = 0;
	ssize_t bytes_to_write;

	while (!err) {
		bytes_to_write = xread(fd_in, buf, LARGE_PACKET_DATA_MAX);
		if (bytes_to_write < 0) {
			free(buf);
			return COPY_READ_ERROR;
		}
		if (bytes_to_write == 0)
			break;
		err = packet_write_gently(fd_out, buf, bytes_to_write);
	}
	free(buf);
	return err;
}

int write_packetized_from_buf_no_flush(const char *src_in, size_t len, int fd_out)
{
	int err = 0;
	size_t bytes_written = 0;
	size_t bytes_to_write;

	while (!err) {
		if ((len - bytes_written) > LARGE_PACKET_DATA_MAX)
			bytes_to_write = LARGE_PACKET_DATA_MAX;
		else
			bytes_to_write = len - bytes_written;
		if (bytes_to_write == 0)
			break;
		err = packet_write_gently(fd_out, src_in + bytes_written, bytes_to_write);
		bytes_written += bytes_to_write;
	}
	return err;
}

static int get_packet_data(int fd, char **src_buf, size_t *src_size,
			   void *dst, unsigned size, int options)
{
	ssize_t ret;

	if (fd >= 0 && src_buf && *src_buf)
		BUG("multiple sources given to packet_read");

	/* Read up to "size" bytes from our source, whatever it is. */
	if (src_buf && *src_buf) {
		ret = size < *src_size ? size : *src_size;
		memcpy(dst, *src_buf, ret);
		*src_buf += ret;
		*src_size -= ret;
	} else {
		ret = read_in_full(fd, dst, size);
		if (ret < 0) {
			if (options & PACKET_READ_GENTLE_ON_READ_ERROR)
				return error_errno(_("read error"));
			die_errno(_("read error"));
		}
	}

	/* And complain if we didn't get enough bytes to satisfy the read. */
	if (ret != size) {
		if (options & PACKET_READ_GENTLE_ON_EOF)
			return -1;

		if (options & PACKET_READ_GENTLE_ON_READ_ERROR)
			return error(_("the remote end hung up unexpectedly"));
		die(_("the remote end hung up unexpectedly"));
	}

	return ret;
}

int packet_length(const char lenbuf_hex[4])
{
	int val = hex2chr(lenbuf_hex);
	return (val < 0) ? val : (val << 8) | hex2chr(lenbuf_hex + 2);
}

static char *find_packfile_uri_path(const char *buffer)
{
	const char *URI_MARK = "://";
	char *path;
	int len;

	/* First char is sideband mark */
	buffer += 1;

	len = strspn(buffer, "0123456789abcdefABCDEF");
	/* size of SHA1 and SHA256 hash */
	if (!(len == 40 || len == 64) || buffer[len] != ' ')
		return NULL; /* required "<hash>SP" not seen */

	path = strstr(buffer + len + 1, URI_MARK);
	if (!path)
		return NULL;

	path = strchr(path + strlen(URI_MARK), '/');
	if (!path || !*(path + 1))
		return NULL;

	/* position after '/' */
	return ++path;
}

enum packet_read_status packet_read_with_status(int fd, char **src_buffer,
						size_t *src_len, char *buffer,
						unsigned size, int *pktlen,
						int options)
{
	int len;
	char linelen[4];
	char *uri_path_start;

	if (get_packet_data(fd, src_buffer, src_len, linelen, 4, options) < 0) {
		*pktlen = -1;
		return PACKET_READ_EOF;
	}

	len = packet_length(linelen);

	if (len < 0) {
		if (options & PACKET_READ_GENTLE_ON_READ_ERROR)
			return error(_("protocol error: bad line length "
				       "character: %.4s"), linelen);
		die(_("protocol error: bad line length character: %.4s"), linelen);
	} else if (!len) {
		packet_trace("0000", 4, 0);
		*pktlen = 0;
		return PACKET_READ_FLUSH;
	} else if (len == 1) {
		packet_trace("0001", 4, 0);
		*pktlen = 0;
		return PACKET_READ_DELIM;
	} else if (len == 2) {
		packet_trace("0002", 4, 0);
		*pktlen = 0;
		return PACKET_READ_RESPONSE_END;
	} else if (len < 4) {
		if (options & PACKET_READ_GENTLE_ON_READ_ERROR)
			return error(_("protocol error: bad line length %d"),
				     len);
		die(_("protocol error: bad line length %d"), len);
	}

	len -= 4;
	if ((unsigned)len >= size) {
		if (options & PACKET_READ_GENTLE_ON_READ_ERROR)
			return error(_("protocol error: bad line length %d"),
				     len);
		die(_("protocol error: bad line length %d"), len);
	}

	if (get_packet_data(fd, src_buffer, src_len, buffer, len, options) < 0) {
		*pktlen = -1;
		return PACKET_READ_EOF;
	}

	if ((options & PACKET_READ_CHOMP_NEWLINE) &&
	    len && buffer[len-1] == '\n')
		len--;

	buffer[len] = 0;
	if (options & PACKET_READ_REDACT_URI_PATH &&
	    (uri_path_start = find_packfile_uri_path(buffer))) {
		const char *redacted = "<redacted>";
		struct strbuf tracebuf = STRBUF_INIT;
		strbuf_insert(&tracebuf, 0, buffer, len);
		strbuf_splice(&tracebuf, uri_path_start - buffer,
			      strlen(uri_path_start), redacted, strlen(redacted));
		packet_trace(tracebuf.buf, tracebuf.len, 0);
		strbuf_release(&tracebuf);
	} else {
		packet_trace(buffer, len, 0);
	}

	if ((options & PACKET_READ_DIE_ON_ERR_PACKET) &&
	    starts_with(buffer, "ERR "))
		die(_("remote error: %s"), buffer + 4);

	*pktlen = len;
	return PACKET_READ_NORMAL;
}

int packet_read(int fd, char *buffer, unsigned size, int options)
{
	int pktlen = -1;

	packet_read_with_status(fd, NULL, NULL, buffer, size, &pktlen,
				options);

	return pktlen;
}

char *packet_read_line(int fd, int *dst_len)
{
	int len = packet_read(fd, packet_buffer, sizeof(packet_buffer),
			      PACKET_READ_CHOMP_NEWLINE);
	if (dst_len)
		*dst_len = len;
	return (len > 0) ? packet_buffer : NULL;
}

int packet_read_line_gently(int fd, int *dst_len, char **dst_line)
{
	int len = packet_read(fd, packet_buffer, sizeof(packet_buffer),
			      PACKET_READ_CHOMP_NEWLINE|PACKET_READ_GENTLE_ON_EOF);
	if (dst_len)
		*dst_len = len;
	if (dst_line)
		*dst_line = (len > 0) ? packet_buffer : NULL;
	return len;
}

ssize_t read_packetized_to_strbuf(int fd_in, struct strbuf *sb_out, int options)
{
	int packet_len;

	size_t orig_len = sb_out->len;
	size_t orig_alloc = sb_out->alloc;

	for (;;) {
		strbuf_grow(sb_out, LARGE_PACKET_DATA_MAX);
		packet_len = packet_read(fd_in,
			/* strbuf_grow() above always allocates one extra byte to
			 * store a '\0' at the end of the string. packet_read()
			 * writes a '\0' extra byte at the end, too. Let it know
			 * that there is already room for the extra byte.
			 */
			sb_out->buf + sb_out->len, LARGE_PACKET_DATA_MAX+1,
			options);
		if (packet_len <= 0)
			break;
		sb_out->len += packet_len;
	}

	if (packet_len < 0) {
		if (orig_alloc == 0)
			strbuf_release(sb_out);
		else
			strbuf_setlen(sb_out, orig_len);
		return packet_len;
	}
	return sb_out->len - orig_len;
}

int recv_sideband(const char *me, int in_stream, int out)
{
	char buf[LARGE_PACKET_MAX + 1];
	int len;
	struct strbuf scratch = STRBUF_INIT;
	enum sideband_type sideband_type;

	while (1) {
		int status = packet_read_with_status(in_stream, NULL, NULL,
						     buf, LARGE_PACKET_MAX,
						     &len,
						     PACKET_READ_GENTLE_ON_EOF);
		if (!demultiplex_sideband(me, status, buf, len, 0, &scratch,
					  &sideband_type))
			continue;
		switch (sideband_type) {
		case SIDEBAND_PRIMARY:
			write_or_die(out, buf + 1, len - 1);
			break;
		default: /* errors: message already written */
			if (scratch.len > 0)
				BUG("unhandled incomplete sideband: '%s'",
				    scratch.buf);
			return sideband_type;
		}
	}
}

/* Packet Reader Functions */
void packet_reader_init(struct packet_reader *reader, int fd,
			char *src_buffer, size_t src_len,
			int options)
{
	memset(reader, 0, sizeof(*reader));

	reader->fd = fd;
	reader->src_buffer = src_buffer;
	reader->src_len = src_len;
	reader->buffer = packet_buffer;
	reader->buffer_size = sizeof(packet_buffer);
	reader->options = options;
	reader->me = "git";
	reader->hash_algo = &hash_algos[GIT_HASH_SHA1];
}

enum packet_read_status packet_reader_read(struct packet_reader *reader)
{
	struct strbuf scratch = STRBUF_INIT;

	if (reader->line_peeked) {
		reader->line_peeked = 0;
		return reader->status;
	}

	/*
	 * Consume all progress packets until a primary payload packet is
	 * received
	 */
	while (1) {
		enum sideband_type sideband_type;
		reader->status = packet_read_with_status(reader->fd,
							 &reader->src_buffer,
							 &reader->src_len,
							 reader->buffer,
							 reader->buffer_size,
							 &reader->pktlen,
							 reader->options);
		if (!reader->use_sideband)
			break;
		if (demultiplex_sideband(reader->me, reader->status,
					 reader->buffer, reader->pktlen, 1,
					 &scratch, &sideband_type))
			break;
	}

	if (reader->status == PACKET_READ_NORMAL)
		/* Skip the sideband designator if sideband is used */
		reader->line = reader->use_sideband ?
			reader->buffer + 1 : reader->buffer;
	else
		reader->line = NULL;

	return reader->status;
}

enum packet_read_status packet_reader_peek(struct packet_reader *reader)
{
	/* Only allow peeking a single line */
	if (reader->line_peeked)
		return reader->status;

	/* Peek a line by reading it and setting peeked flag */
	packet_reader_read(reader);
	reader->line_peeked = 1;
	return reader->status;
}

void packet_writer_init(struct packet_writer *writer, int dest_fd)
{
	writer->dest_fd = dest_fd;
	writer->use_sideband = 0;
}

void packet_writer_write(struct packet_writer *writer, const char *fmt, ...)
{
	va_list args;

	va_start(args, fmt);
	packet_write_fmt_1(writer->dest_fd, 0,
			   writer->use_sideband ? "\001" : "", fmt, args);
	va_end(args);
}

void packet_writer_error(struct packet_writer *writer, const char *fmt, ...)
{
	va_list args;

	va_start(args, fmt);
	packet_write_fmt_1(writer->dest_fd, 0,
			   writer->use_sideband ? "\003" : "ERR ", fmt, args);
	va_end(args);
}

void packet_writer_delim(struct packet_writer *writer)
{
	packet_delim(writer->dest_fd);
}

void packet_writer_flush(struct packet_writer *writer)
{
	packet_flush(writer->dest_fd);
}
Commit	Line	Data
f3a3214e LT	1	#include "cache.h"
f3a3214e LT	2	#include "pkt-line.h"
fd89433d	3	#include "run-command.h"
f3a3214e	4
74543a04	5	char packet_buffer[LARGE_PACKET_MAX];
1e4cd68c	6	static const char *packet_trace_prefix = "git";
6aa30857	7	static struct trace_key trace_packet = TRACE_KEY_INIT(PACKET);
32359838	8	static struct trace_key trace_pack = TRACE_KEY_INIT(PACKFILE);
bbc30f99 JK	9
	10	void packet_trace_identity(const char *prog)
	11	{
	12	packet_trace_prefix = xstrdup(prog);
	13	}
	14
fd89433d JK	15	static const char *get_trace_prefix(void)
	16	{
	17	return in_async() ? "sideband" : packet_trace_prefix;
	18	}
	19
32359838 JK	20	static int packet_trace_pack(const char *buf, unsigned int len, int sideband)
	21	{
	22	if (!sideband) {
	23	trace_verbatim(&trace_pack, buf, len);
	24	return 1;
	25	} else if (len && *buf == '\1') {
	26	trace_verbatim(&trace_pack, buf + 1, len - 1);
	27	return 1;
	28	} else {
	29	/* it's another non-pack sideband */
	30	return 0;
	31	}
	32	}
	33
bbc30f99 JK	34	static void packet_trace(const char *buf, unsigned int len, int write)
	35	{
	36	int i;
	37	struct strbuf out;
32359838 JK	38	static int in_pack, sideband;
	39
	40	if (!trace_want(&trace_packet) && !trace_want(&trace_pack))
	41	return;
	42
	43	if (in_pack) {
	44	if (packet_trace_pack(buf, len, sideband))
	45	return;
	46	} else if (starts_with(buf, "PACK") \|\| starts_with(buf, "\1PACK")) {
	47	in_pack = 1;
	48	sideband = *buf == '\1';
	49	packet_trace_pack(buf, len, sideband);
	50
	51	/*
	52	* Make a note in the human-readable trace that the pack data
	53	* started.
	54	*/
	55	buf = "PACK ...";
	56	len = strlen(buf);
	57	}
bbc30f99	58
6aa30857	59	if (!trace_want(&trace_packet))
bbc30f99 JK	60	return;
	61
	62	/* +32 is just a guess for header + quoting */
	63	strbuf_init(&out, len+32);
	64
	65	strbuf_addf(&out, "packet: %12s%c ",
fd89433d	66	get_trace_prefix(), write ? '>' : '<');
bbc30f99	67
32359838 JK	68	/* XXX we should really handle printable utf8 */
	69	for (i = 0; i < len; i++) {
	70	/* suppress newlines */
	71	if (buf[i] == '\n')
	72	continue;
	73	if (buf[i] >= 0x20 && buf[i] <= 0x7e)
	74	strbuf_addch(&out, buf[i]);
	75	else
	76	strbuf_addf(&out, "\\%o", buf[i]);
bbc30f99 JK	77	}
	78
	79	strbuf_addch(&out, '\n');
6aa30857	80	trace_strbuf(&trace_packet, &out);
bbc30f99 JK	81	strbuf_release(&out);
	82	}
	83
f3a3214e LT	84	/*
	85	* If we buffered things up above (we don't, but we should),
	86	* we'd flush it here
	87	*/
	88	void packet_flush(int fd)
	89	{
bbc30f99	90	packet_trace("0000", 4, 1);
37c80012 JK	91	if (write_in_full(fd, "0000", 4) < 0)
37c80012 JK	92	die_errno(_("unable to write flush packet"));
f3a3214e LT	93	}
f3a3214e LT	94
a4cfd41c BW	95	void packet_delim(int fd)
	96	{
	97	packet_trace("0001", 4, 1);
37c80012 JK	98	if (write_in_full(fd, "0001", 4) < 0)
37c80012 JK	99	die_errno(_("unable to write delim packet"));
a4cfd41c BW	100	}
a4cfd41c BW	101
0181b600 DL	102	void packet_response_end(int fd)
	103	{
	104	packet_trace("0002", 4, 1);
	105	if (write_in_full(fd, "0002", 4) < 0)
8232a0ff	106	die_errno(_("unable to write response end packet"));
0181b600 DL	107	}
0181b600 DL	108
038ce90f LS	109	int packet_flush_gently(int fd)
	110	{
	111	packet_trace("0000", 4, 1);
4c95e3dd	112	if (write_in_full(fd, "0000", 4) < 0)
c60d7697	113	return error(_("flush packet write failed"));
4c95e3dd	114	return 0;
038ce90f LS	115	}
038ce90f LS	116
f5615d24 SP	117	void packet_buf_flush(struct strbuf *buf)
f5615d24 SP	118	{
bbc30f99	119	packet_trace("0000", 4, 1);
f5615d24 SP	120	strbuf_add(buf, "0000", 4);
	121	}
	122
a4cfd41c BW	123	void packet_buf_delim(struct strbuf *buf)
	124	{
	125	packet_trace("0001", 4, 1);
	126	strbuf_add(buf, "0001", 4);
	127	}
	128
56bea280	129	void set_packet_header(char *buf, int size)
f3a3214e	130	{
f3a3214e	131	static char hexchar[] = "0123456789abcdef";
2f60bdd1 LS	132
	133	#define hex(a) (hexchar[(a) & 15])
	134	buf[0] = hex(size >> 12);
	135	buf[1] = hex(size >> 8);
	136	buf[2] = hex(size >> 4);
	137	buf[3] = hex(size);
	138	#undef hex
	139	}
	140
bc2e795c JT	141	static void format_packet(struct strbuf out, const char prefix,
bc2e795c JT	142	const char *fmt, va_list args)
2f60bdd1	143	{
8e9faf27	144	size_t orig_len, n;
f3a3214e	145
8e9faf27 JK	146	orig_len = out->len;
8e9faf27 JK	147	strbuf_addstr(out, "0000");
bc2e795c	148	strbuf_addstr(out, prefix);
8e9faf27 JK	149	strbuf_vaddf(out, fmt, args);
	150	n = out->len - orig_len;
	151
	152	if (n > LARGE_PACKET_MAX)
c60d7697	153	die(_("protocol error: impossibly long line"));
8e9faf27	154
2f60bdd1	155	set_packet_header(&out->buf[orig_len], n);
8e9faf27	156	packet_trace(out->buf + orig_len + 4, n - 4, 1);
f5615d24 SP	157	}
f5615d24 SP	158
bc2e795c	159	static int packet_write_fmt_1(int fd, int gently, const char *prefix,
70428d1a LS	160	const char *fmt, va_list args)
70428d1a LS	161	{
150efef1	162	static struct strbuf buf = STRBUF_INIT;
70428d1a	163
150efef1	164	strbuf_reset(&buf);
bc2e795c	165	format_packet(&buf, prefix, fmt, args);
4c95e3dd JK	166	if (write_in_full(fd, buf.buf, buf.len) < 0) {
	167	if (!gently) {
	168	check_pipe(errno);
c60d7697	169	die_errno(_("packet write with format failed"));
4c95e3dd	170	}
c60d7697	171	return error(_("packet write with format failed"));
70428d1a	172	}
4c95e3dd JK	173
4c95e3dd JK	174	return 0;
70428d1a LS	175	}
70428d1a LS	176
81c634e9	177	void packet_write_fmt(int fd, const char *fmt, ...)
f5615d24 SP	178	{
f5615d24 SP	179	va_list args;
f5615d24 SP	180
f5615d24 SP	181	va_start(args, fmt);
bc2e795c	182	packet_write_fmt_1(fd, 0, "", fmt, args);
70428d1a LS	183	va_end(args);
	184	}
	185
	186	int packet_write_fmt_gently(int fd, const char *fmt, ...)
	187	{
	188	int status;
	189	va_list args;
	190
	191	va_start(args, fmt);
bc2e795c	192	status = packet_write_fmt_1(fd, 1, "", fmt, args);
f5615d24	193	va_end(args);
70428d1a	194	return status;
f3a3214e LT	195	}
f3a3214e LT	196
332ec963 MT	197	static int do_packet_write(const int fd_out, const char *buf, size_t size,
332ec963 MT	198	struct strbuf *err)
edfb780c	199	{
7455e05e	200	char header[4];
edfb780c LS	201	size_t packet_size;
edfb780c LS	202
332ec963 MT	203	if (size > LARGE_PACKET_DATA_MAX) {
	204	strbuf_addstr(err, _("packet write failed - data exceeds max packet size"));
	205	return -1;
	206	}
edfb780c LS	207
	208	packet_trace(buf, size, 1);
	209	packet_size = size + 4;
7455e05e JH	210
	211	set_packet_header(header, packet_size);
	212
	213	/*
	214	* Write the header and the buffer in 2 parts so that we do
	215	* not need to allocate a buffer or rely on a static buffer.
	216	* This also avoids putting a large buffer on the stack which
	217	* might have multi-threading issues.
	218	*/
	219
	220	if (write_in_full(fd_out, header, 4) < 0 \|\|
332ec963 MT	221	write_in_full(fd_out, buf, size) < 0) {
	222	strbuf_addf(err, _("packet write failed: %s"), strerror(errno));
	223	return -1;
	224	}
	225	return 0;
	226	}
	227
	228	static int packet_write_gently(const int fd_out, const char *buf, size_t size)
	229	{
	230	struct strbuf err = STRBUF_INIT;
	231	if (do_packet_write(fd_out, buf, size, &err)) {
	232	error("%s", err.buf);
	233	strbuf_release(&err);
	234	return -1;
	235	}
4c95e3dd	236	return 0;
edfb780c LS	237	}
edfb780c LS	238
5d2124b3 BW	239	void packet_write(int fd_out, const char *buf, size_t size)
5d2124b3 BW	240	{
332ec963 MT	241	struct strbuf err = STRBUF_INIT;
	242	if (do_packet_write(fd_out, buf, size, &err))
	243	die("%s", err.buf);
5d2124b3 BW	244	}
5d2124b3 BW	245
96328398 JV	246	void packet_fwrite(FILE f, const char buf, size_t size)
	247	{
	248	size_t packet_size;
	249	char header[4];
	250
	251	if (size > LARGE_PACKET_DATA_MAX)
	252	die(_("packet write failed - data exceeds max packet size"));
	253
	254	packet_trace(buf, size, 1);
	255	packet_size = size + 4;
	256
	257	set_packet_header(header, packet_size);
	258	fwrite_or_die(f, header, 4);
	259	fwrite_or_die(f, buf, size);
	260	}
	261
	262	void packet_fwrite_fmt(FILE fh, const char fmt, ...)
	263	{
	264	static struct strbuf buf = STRBUF_INIT;
	265	va_list args;
	266
	267	strbuf_reset(&buf);
	268
	269	va_start(args, fmt);
	270	format_packet(&buf, "", fmt, args);
	271	va_end(args);
	272
	273	fwrite_or_die(fh, buf.buf, buf.len);
	274	}
	275
	276	void packet_fflush(FILE *f)
	277	{
	278	packet_trace("0000", 4, 1);
	279	fwrite_or_die(f, "0000", 4);
	280	fflush_or_die(f);
	281	}
	282
f5615d24 SP	283	void packet_buf_write(struct strbuf buf, const char fmt, ...)
	284	{
	285	va_list args;
f5615d24 SP	286
f5615d24 SP	287	va_start(args, fmt);
bc2e795c	288	format_packet(buf, "", fmt, args);
f5615d24	289	va_end(args);
f5615d24 SP	290	}
f5615d24 SP	291
3a63c6a4	292	int write_packetized_from_fd_no_flush(int fd_in, int fd_out)
bb643d8b	293	{
7455e05e	294	char *buf = xmalloc(LARGE_PACKET_DATA_MAX);
bb643d8b LS	295	int err = 0;
	296	ssize_t bytes_to_write;
	297
	298	while (!err) {
7455e05e JH	299	bytes_to_write = xread(fd_in, buf, LARGE_PACKET_DATA_MAX);
	300	if (bytes_to_write < 0) {
	301	free(buf);
bb643d8b	302	return COPY_READ_ERROR;
7455e05e	303	}
bb643d8b LS	304	if (bytes_to_write == 0)
	305	break;
	306	err = packet_write_gently(fd_out, buf, bytes_to_write);
	307	}
7455e05e	308	free(buf);
bb643d8b LS	309	return err;
	310	}
	311
3a63c6a4	312	int write_packetized_from_buf_no_flush(const char *src_in, size_t len, int fd_out)
bb643d8b LS	313	{
	314	int err = 0;
	315	size_t bytes_written = 0;
	316	size_t bytes_to_write;
	317
	318	while (!err) {
	319	if ((len - bytes_written) > LARGE_PACKET_DATA_MAX)
	320	bytes_to_write = LARGE_PACKET_DATA_MAX;
	321	else
	322	bytes_to_write = len - bytes_written;
	323	if (bytes_to_write == 0)
	324	break;
	325	err = packet_write_gently(fd_out, src_in + bytes_written, bytes_to_write);
	326	bytes_written += bytes_to_write;
	327	}
bb643d8b LS	328	return err;
	329	}
	330
4981fe75 JK	331	static int get_packet_data(int fd, char *src_buf, size_t src_size,
4981fe75 JK	332	void *dst, unsigned size, int options)
f3a3214e	333	{
4981fe75 JK	334	ssize_t ret;
	335
	336	if (fd >= 0 && src_buf && *src_buf)
033abf97	337	BUG("multiple sources given to packet_read");
4981fe75 JK	338
	339	/* Read up to "size" bytes from our source, whatever it is. */
	340	if (src_buf && *src_buf) {
	341	ret = size < src_size ? size : src_size;
	342	memcpy(dst, *src_buf, ret);
	343	*src_buf += ret;
	344	*src_size -= ret;
	345	} else {
	346	ret = read_in_full(fd, dst, size);
c4ba5793 JS	347	if (ret < 0) {
	348	if (options & PACKET_READ_GENTLE_ON_READ_ERROR)
	349	return error_errno(_("read error"));
c60d7697	350	die_errno(_("read error"));
c4ba5793	351	}
4981fe75 JK	352	}
	353
	354	/* And complain if we didn't get enough bytes to satisfy the read. */
61d36330	355	if (ret != size) {
03809429	356	if (options & PACKET_READ_GENTLE_ON_EOF)
46284dd1 HV	357	return -1;
46284dd1 HV	358
c4ba5793 JS	359	if (options & PACKET_READ_GENTLE_ON_READ_ERROR)
c4ba5793 JS	360	return error(_("the remote end hung up unexpectedly"));
c60d7697	361	die(_("the remote end hung up unexpectedly"));
46284dd1 HV	362	}
	363
	364	return ret;
f3a3214e LT	365	}
f3a3214e LT	366
101736a1	367	int packet_length(const char lenbuf_hex[4])
f3a3214e	368	{
101736a1 DL	369	int val = hex2chr(lenbuf_hex);
101736a1 DL	370	return (val < 0) ? val : (val << 8) \| hex2chr(lenbuf_hex + 2);
f5615d24 SP	371	}
f5615d24 SP	372
88e9b1e3 IF	373	static char find_packfile_uri_path(const char buffer)
	374	{
	375	const char *URI_MARK = "://";
	376	char *path;
	377	int len;
	378
	379	/* First char is sideband mark */
	380	buffer += 1;
	381
	382	len = strspn(buffer, "0123456789abcdefABCDEF");
	383	/* size of SHA1 and SHA256 hash */
	384	if (!(len == 40 \|\| len == 64) \|\| buffer[len] != ' ')
	385	return NULL; /* required "<hash>SP" not seen */
	386
	387	path = strstr(buffer + len + 1, URI_MARK);
	388	if (!path)
	389	return NULL;
	390
	391	path = strchr(path + strlen(URI_MARK), '/');
	392	if (!path \|\| !*(path + 1))
	393	return NULL;
	394
	395	/* position after '/' */
	396	return ++path;
	397	}
	398
2153d478 BW	399	enum packet_read_status packet_read_with_status(int fd, char **src_buffer,
	400	size_t src_len, char buffer,
	401	unsigned size, int *pktlen,
	402	int options)
f5615d24	403	{
2153d478	404	int len;
f5615d24	405	char linelen[4];
88e9b1e3	406	char *uri_path_start;
f5615d24	407
2153d478 BW	408	if (get_packet_data(fd, src_buffer, src_len, linelen, 4, options) < 0) {
	409	*pktlen = -1;
	410	return PACKET_READ_EOF;
	411	}
	412
f5615d24	413	len = packet_length(linelen);
2153d478 BW	414
2153d478 BW	415	if (len < 0) {
c4ba5793 JS	416	if (options & PACKET_READ_GENTLE_ON_READ_ERROR)
	417	return error(_("protocol error: bad line length "
	418	"character: %.4s"), linelen);
c60d7697	419	die(_("protocol error: bad line length character: %.4s"), linelen);
2153d478	420	} else if (!len) {
bbc30f99	421	packet_trace("0000", 4, 0);
2153d478 BW	422	*pktlen = 0;
2153d478 BW	423	return PACKET_READ_FLUSH;
a4cfd41c BW	424	} else if (len == 1) {
	425	packet_trace("0001", 4, 0);
	426	*pktlen = 0;
	427	return PACKET_READ_DELIM;
0181b600 DL	428	} else if (len == 2) {
	429	packet_trace("0002", 4, 0);
	430	*pktlen = 0;
	431	return PACKET_READ_RESPONSE_END;
2153d478	432	} else if (len < 4) {
c4ba5793 JS	433	if (options & PACKET_READ_GENTLE_ON_READ_ERROR)
	434	return error(_("protocol error: bad line length %d"),
	435	len);
c60d7697	436	die(_("protocol error: bad line length %d"), len);
bbc30f99	437	}
2153d478	438
f3a3214e	439	len -= 4;
c4ba5793 JS	440	if ((unsigned)len >= size) {
	441	if (options & PACKET_READ_GENTLE_ON_READ_ERROR)
	442	return error(_("protocol error: bad line length %d"),
	443	len);
c60d7697	444	die(_("protocol error: bad line length %d"), len);
c4ba5793	445	}
2153d478 BW	446
	447	if (get_packet_data(fd, src_buffer, src_len, buffer, len, options) < 0) {
	448	*pktlen = -1;
	449	return PACKET_READ_EOF;
	450	}
819b929d JK	451
	452	if ((options & PACKET_READ_CHOMP_NEWLINE) &&
	453	len && buffer[len-1] == '\n')
	454	len--;
	455
f3a3214e	456	buffer[len] = 0;
88e9b1e3 IF	457	if (options & PACKET_READ_REDACT_URI_PATH &&
	458	(uri_path_start = find_packfile_uri_path(buffer))) {
	459	const char *redacted = "<redacted>";
	460	struct strbuf tracebuf = STRBUF_INIT;
	461	strbuf_insert(&tracebuf, 0, buffer, len);
	462	strbuf_splice(&tracebuf, uri_path_start - buffer,
	463	strlen(uri_path_start), redacted, strlen(redacted));
	464	packet_trace(tracebuf.buf, tracebuf.len, 0);
	465	strbuf_release(&tracebuf);
	466	} else {
	467	packet_trace(buffer, len, 0);
	468	}
533ddba4 JK	469
	470	if ((options & PACKET_READ_DIE_ON_ERR_PACKET) &&
	471	starts_with(buffer, "ERR "))
	472	die(_("remote error: %s"), buffer + 4);
	473
2153d478 BW	474	*pktlen = len;
	475	return PACKET_READ_NORMAL;
	476	}
	477
ec9a37d6	478	int packet_read(int fd, char *buffer, unsigned size, int options)
2153d478 BW	479	{
	480	int pktlen = -1;
	481
ec9a37d6 ÆAB	482	packet_read_with_status(fd, NULL, NULL, buffer, size, &pktlen,
ec9a37d6 ÆAB	483	options);
2153d478 BW	484
2153d478 BW	485	return pktlen;
f3a3214e	486	}
f5615d24	487
ec9a37d6	488	char packet_read_line(int fd, int dst_len)
46284dd1	489	{
ec9a37d6	490	int len = packet_read(fd, packet_buffer, sizeof(packet_buffer),
74543a04	491	PACKET_READ_CHOMP_NEWLINE);
4981fe75 JK	492	if (dst_len)
4981fe75 JK	493	*dst_len = len;
974b50c5	494	return (len > 0) ? packet_buffer : NULL;
46284dd1 HV	495	}
46284dd1 HV	496
825b9226 BP	497	int packet_read_line_gently(int fd, int dst_len, char *dst_line)
825b9226 BP	498	{
ec9a37d6	499	int len = packet_read(fd, packet_buffer, sizeof(packet_buffer),
825b9226 BP	500	PACKET_READ_CHOMP_NEWLINE\|PACKET_READ_GENTLE_ON_EOF);
	501	if (dst_len)
	502	*dst_len = len;
	503	if (dst_line)
	504	*dst_line = (len > 0) ? packet_buffer : NULL;
	505	return len;
	506	}
	507
8c2efa5d	508	ssize_t read_packetized_to_strbuf(int fd_in, struct strbuf *sb_out, int options)
bb643d8b LS	509	{
	510	int packet_len;
	511
	512	size_t orig_len = sb_out->len;
	513	size_t orig_alloc = sb_out->alloc;
	514
	515	for (;;) {
	516	strbuf_grow(sb_out, LARGE_PACKET_DATA_MAX);
ec9a37d6	517	packet_len = packet_read(fd_in,
bb643d8b LS	518	/* strbuf_grow() above always allocates one extra byte to
	519	* store a '\0' at the end of the string. packet_read()
	520	* writes a '\0' extra byte at the end, too. Let it know
	521	* that there is already room for the extra byte.
	522	*/
	523	sb_out->buf + sb_out->len, LARGE_PACKET_DATA_MAX+1,
8c2efa5d	524	options);
bb643d8b LS	525	if (packet_len <= 0)
	526	break;
	527	sb_out->len += packet_len;
	528	}
	529
	530	if (packet_len < 0) {
	531	if (orig_alloc == 0)
	532	strbuf_release(sb_out);
	533	else
	534	strbuf_setlen(sb_out, orig_len);
	535	return packet_len;
	536	}
	537	return sb_out->len - orig_len;
	538	}
77dabc14	539
fbd76cd4 JT	540	int recv_sideband(const char *me, int in_stream, int out)
	541	{
	542	char buf[LARGE_PACKET_MAX + 1];
	543	int len;
	544	struct strbuf scratch = STRBUF_INIT;
	545	enum sideband_type sideband_type;
	546
	547	while (1) {
af22a63c JK	548	int status = packet_read_with_status(in_stream, NULL, NULL,
	549	buf, LARGE_PACKET_MAX,
	550	&len,
	551	PACKET_READ_GENTLE_ON_EOF);
	552	if (!demultiplex_sideband(me, status, buf, len, 0, &scratch,
fbd76cd4 JT	553	&sideband_type))
	554	continue;
	555	switch (sideband_type) {
	556	case SIDEBAND_PRIMARY:
	557	write_or_die(out, buf + 1, len - 1);
	558	break;
	559	default: /* errors: message already written */
8e86cf65 JS	560	if (scratch.len > 0)
	561	BUG("unhandled incomplete sideband: '%s'",
	562	scratch.buf);
fbd76cd4 JT	563	return sideband_type;
	564	}
	565	}
	566	}
	567
77dabc14 BW	568	/* Packet Reader Functions */
	569	void packet_reader_init(struct packet_reader *reader, int fd,
	570	char *src_buffer, size_t src_len,
	571	int options)
	572	{
	573	memset(reader, 0, sizeof(*reader));
	574
	575	reader->fd = fd;
	576	reader->src_buffer = src_buffer;
	577	reader->src_len = src_len;
	578	reader->buffer = packet_buffer;
	579	reader->buffer_size = sizeof(packet_buffer);
	580	reader->options = options;
0bbc0bc5	581	reader->me = "git";
9a9f0d3f	582	reader->hash_algo = &hash_algos[GIT_HASH_SHA1];
77dabc14 BW	583	}
	584
	585	enum packet_read_status packet_reader_read(struct packet_reader *reader)
	586	{
0bbc0bc5 JT	587	struct strbuf scratch = STRBUF_INIT;
0bbc0bc5 JT	588
77dabc14 BW	589	if (reader->line_peeked) {
	590	reader->line_peeked = 0;
	591	return reader->status;
	592	}
	593
0bbc0bc5 JT	594	/*
	595	* Consume all progress packets until a primary payload packet is
	596	* received
	597	*/
	598	while (1) {
	599	enum sideband_type sideband_type;
	600	reader->status = packet_read_with_status(reader->fd,
	601	&reader->src_buffer,
	602	&reader->src_len,
	603	reader->buffer,
	604	reader->buffer_size,
	605	&reader->pktlen,
	606	reader->options);
	607	if (!reader->use_sideband)
	608	break;
af22a63c JK	609	if (demultiplex_sideband(reader->me, reader->status,
	610	reader->buffer, reader->pktlen, 1,
	611	&scratch, &sideband_type))
0bbc0bc5 JT	612	break;
0bbc0bc5 JT	613	}
77dabc14 BW	614
77dabc14 BW	615	if (reader->status == PACKET_READ_NORMAL)
0bbc0bc5 JT	616	/* Skip the sideband designator if sideband is used */
	617	reader->line = reader->use_sideband ?
	618	reader->buffer + 1 : reader->buffer;
77dabc14 BW	619	else
	620	reader->line = NULL;
	621
	622	return reader->status;
	623	}
	624
	625	enum packet_read_status packet_reader_peek(struct packet_reader *reader)
	626	{
	627	/* Only allow peeking a single line */
	628	if (reader->line_peeked)
	629	return reader->status;
	630
	631	/* Peek a line by reading it and setting peeked flag */
	632	packet_reader_read(reader);
	633	reader->line_peeked = 1;
	634	return reader->status;
	635	}
bc2e795c JT	636
	637	void packet_writer_init(struct packet_writer *writer, int dest_fd)
	638	{
	639	writer->dest_fd = dest_fd;
0bbc0bc5	640	writer->use_sideband = 0;
bc2e795c JT	641	}
	642
	643	void packet_writer_write(struct packet_writer writer, const char fmt, ...)
	644	{
	645	va_list args;
	646
	647	va_start(args, fmt);
0bbc0bc5 JT	648	packet_write_fmt_1(writer->dest_fd, 0,
0bbc0bc5 JT	649	writer->use_sideband ? "\001" : "", fmt, args);
bc2e795c JT	650	va_end(args);
	651	}
	652
	653	void packet_writer_error(struct packet_writer writer, const char fmt, ...)
	654	{
	655	va_list args;
	656
	657	va_start(args, fmt);
0bbc0bc5 JT	658	packet_write_fmt_1(writer->dest_fd, 0,
0bbc0bc5 JT	659	writer->use_sideband ? "\003" : "ERR ", fmt, args);
bc2e795c JT	660	va_end(args);
	661	}
	662
	663	void packet_writer_delim(struct packet_writer *writer)
	664	{
	665	packet_delim(writer->dest_fd);
	666	}
	667
	668	void packet_writer_flush(struct packet_writer *writer)
	669	{
	670	packet_flush(writer->dest_fd);
	671	}