git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[RFC/PATCH 1/2] bundle: allowing to read from an unseekable fd

From
Junio C Hamano <gitster@pobox.com>
Date
Oct 13, 2011, 22:32 UTC
Message-ID
<7vpqi034l0.fsf@alter.siamese.dyndns.org>

The current code opens a given file with fopen(), reads it until the end of the header and runs ftell(), and reopens the same file with open() and seeks to skip the header. This structure makes it hard to retarget the code to read from input that is not seekable, such as a network socket.

This patch by itself does not reach that goal yet, but I think it is a right step in that direction.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 * It would be nice if we can avoid byte-by-byte reading from the file
   descriptor by over-reading into the strbuf and pass the remainder to
   the caller of read_bundle_header(), but I suspect that it would require
   us to carry the "here is the remainder from the previous read" buffer
   around throughout the transport layer. Parsing of the header wouldn't
   be performance critical compared to the computation cost of actually
   reading the rest of the bundle, hopefully, so...
 bundle.c |   99 ++++++++++++++++++++++++++++++++++++++++----------------------
 1 files changed, 64 insertions(+), 35 deletions(-)
diff --git a/bundle.c b/bundle.c
index f48fd7d..3aa715c 100644
--- a/bundle.c
+++ b/bundle.c
@@ -23,49 +23,78 @@ static void add_to_ref_list(const unsigned char *sha1, const char *name,
 	list->nr++;
 }
 
-/* returns an fd */
+/* Eventually this should go to strbuf.[ch] */
+static int strbuf_readline_fd(struct strbuf *sb, int fd)
+{
+	strbuf_reset(sb);
+
+	while (1) {
+		char ch;
+		ssize_t len = xread(fd, &ch, 1);
+		if (len < 0)
+			return -1;
+		strbuf_addch(sb, ch);
+		if (ch == '\n')
+			break;
+	}
+	return 0;
+}
+
 int read_bundle_header(const char *path, struct bundle_header *header)
 {
-	char buffer[1024];
-	int fd;
-	long fpos;
-	FILE *ffd = fopen(path, "rb");
+	struct strbuf buf = STRBUF_INIT;
+	int fd = open(path, O_RDONLY);
+	int status = 0;
 
-	if (!ffd)
+	if (fd < 0)
 		return error("could not open '%s'", path);
-	if (!fgets(buffer, sizeof(buffer), ffd) ||
-			strcmp(buffer, bundle_signature)) {
-		fclose(ffd);
-		return error("'%s' does not look like a v2 bundle file", path);
+
+	/* The bundle header begins with the signature */
+	if (strbuf_readline_fd(&buf, fd) ||
+	    strcmp(buf.buf, bundle_signature)) {
+		error("'%s' does not look like a v2 bundle file", path);
+		status = -1;
+		goto abort;
 	}
-	while (fgets(buffer, sizeof(buffer), ffd)
-			&& buffer[0] != '\n') {
-		int is_prereq = buffer[0] == '-';
-		int offset = is_prereq ? 1 : 0;
-		int len = strlen(buffer);
+
+	/* The bundle header ends with an empty line */
+	while (!strbuf_readline_fd(&buf, fd) &&
+	       buf.len && buf.buf[0] != '\n') {
 		unsigned char sha1[20];
-		struct ref_list *list = is_prereq ? &header->prerequisites
-			: &header->references;
-		char delim;
-
-		if (len && buffer[len - 1] == '\n')
-			buffer[len - 1] = '\0';
-		if (get_sha1_hex(buffer + offset, sha1)) {
-			warning("unrecognized header: %s", buffer);
-			continue;
+		int is_prereq = 0;
+
+		if (*buf.buf == '-') {
+			is_prereq = 1;
+			strbuf_remove(&buf, 0, 1);
+		}
+		strbuf_rtrim(&buf);
+
+		/*
+		 * Tip lines have object name, SP, and refname.
+		 * Prerequisites have object name that is optionally
+		 * followed by SP and subject line.
+		 */
+		if (get_sha1_hex(buf.buf, sha1) ||
+		    (40 <= buf.len && !isspace(buf.buf[40])) ||
+		    (!is_prereq && buf.len <= 40)) {
+			error("unrecognized header: %s%s (%d)",
+			      (is_prereq ? "-" : ""), buf.buf, (int)buf.len);
+			status = -1;
+			break;
+		} else {
+			if (is_prereq)
+				add_to_ref_list(sha1, "", &header->prerequisites);
+			else
+				add_to_ref_list(sha1, buf.buf + 41, &header->references);
 		}
-		delim = buffer[40 + offset];
-		if (!isspace(delim) && (delim != '\0' || !is_prereq))
-			die ("invalid header: %s", buffer);
-		add_to_ref_list(sha1, isspace(delim) ?
-				buffer + 41 + offset : "", list);
 	}
-	fpos = ftell(ffd);
-	fclose(ffd);
-	fd = open(path, O_RDONLY);
-	if (fd < 0)
-		return error("could not open '%s'", path);
-	lseek(fd, fpos, SEEK_SET);
+
+ abort:
+	if (status) {
+		close(fd);
+		fd = -1;
+	}
+	strbuf_release(&buf);
 	return fd;
 }
 
-- 
1.7.7.289.gd0d4bb
Next: Junio C Hamano
Message 1 of 5 in “bundle: allowing to read from an unseekable fd”
  1. 1/2 bundle: allowing to read from an unseekable fdJunio C Hamano, Oct 13, 2011
  2. 2/2 bundle: add parse_bundle_header() helper functionJunio C Hamano, Oct 13, 2011
  3. Phil HordOct 14, 2011
  4. Junio C HamanoOct 14, 2011
  5. Phil HordOct 14, 2011

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.