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

[PATCH v5 5/6] transport: add client support for object-info

From
Calvin Wan <calvinwan@google.com>
Date
Jul 28, 2022, 23:02 UTC
Message-ID
<20220728230210.2952731-6-calvinwan@google.com>
In-Reply-To
<20220502170904.2770649-1-calvinwan@google.com>

Sometimes it is useful to get information about an object without having to download it completely. The server logic has already been implemented as “a2ba162cda (object-info: support for retrieving object info, 2021-04-20)”. This patch adds client functions to communicate with the server.

The client currently supports requesting a list of object ids with features 'size' and 'type' from a v2 server. If a server does not advertise either of the requested features, then the client falls back to making the request through 'fetch'.

Signed-off-by: Calvin Wan <calvinwan@google.com>
Helped-by: Jonathan Tan <jonathantanmy@google.com>
---
 fetch-pack.c       |  28 ++++++++++++
 fetch-pack.h       |  10 +++++
 transport-helper.c |   7 ++-
 transport.c        | 110 +++++++++++++++++++++++++++++++++++++++++++--
 transport.h        |  11 +++++
 5 files changed, 161 insertions(+), 5 deletions(-)
diff --git a/fetch-pack.c b/fetch-pack.c
index 8c862b017e..d373aed775 100644
--- a/fetch-pack.c
+++ b/fetch-pack.c
@@ -1293,6 +1293,31 @@ static void write_command_and_capabilities(struct strbuf *req_buf,
 	packet_buf_delim(req_buf);
 }
 
+void send_object_info_request(int fd_out, struct object_info_args *args)
+{
+	struct strbuf req_buf = STRBUF_INIT;
+	size_t i;
+
+	write_command_and_capabilities(&req_buf, args->server_options, "object-info");
+
+	if (unsorted_string_list_has_string(args->object_info_options, "size"))
+		packet_buf_write(&req_buf, "size");
+
+	if (unsorted_string_list_has_string(args->object_info_options, "type"))
+		packet_buf_write(&req_buf, "type");
+
+	if (args->oids) {
+		for (i = 0; i < args->oids->nr; i++)
+			packet_buf_write(&req_buf, "oid %s", oid_to_hex(&args->oids->oid[i]));
+	}
+
+	packet_buf_flush(&req_buf);
+	if (write_in_full(fd_out, req_buf.buf, req_buf.len) < 0)
+		die_errno(_("unable to write request to remote"));
+
+	strbuf_release(&req_buf);
+}
+
 static int send_fetch_request(struct fetch_negotiator *negotiator, int fd_out,
 			      struct fetch_pack_args *args,
 			      const struct ref *wants, struct oidset *common,
@@ -1634,6 +1659,9 @@ static struct ref *do_fetch_pack_v2(struct fetch_pack_args *args,
 	if (args->depth > 0 || args->deepen_since || args->deepen_not)
 		args->deepen = 1;
 
+	if (args->object_info)
+		state = FETCH_SEND_REQUEST;
+
 	while (state != FETCH_DONE) {
 		switch (state) {
 		case FETCH_CHECK_LOCAL:
diff --git a/fetch-pack.h b/fetch-pack.h
index 8c7752fc82..11c513f748 100644
--- a/fetch-pack.h
+++ b/fetch-pack.h
@@ -17,6 +17,7 @@ struct fetch_pack_args {
 	const struct string_list *deepen_not;
 	struct list_objects_filter_options filter_options;
 	const struct string_list *server_options;
+	struct object_info **object_info_data;
 
 	/*
 	 * If not NULL, during packfile negotiation, fetch-pack will send "have"
@@ -43,6 +44,7 @@ struct fetch_pack_args {
 	unsigned reject_shallow_remote:1;
 	unsigned deepen:1;
 	unsigned refetch:1;
+	unsigned object_info:1;
 
 	/*
 	 * Indicate that the remote of this request is a promisor remote. The
@@ -69,6 +71,12 @@ struct fetch_pack_args {
 	unsigned connectivity_checked:1;
 };
 
+struct object_info_args {
+	struct string_list *object_info_options;
+	const struct string_list *server_options;
+	struct oid_array *oids;
+};
+
 /*
  * sought represents remote references that should be updated from.
  * On return, the names that were found on the remote will have been
@@ -102,4 +110,6 @@ void negotiate_using_fetch(const struct oid_array *negotiation_tips,
  */
 int report_unmatched_refs(struct ref **sought, int nr_sought);
 
+void send_object_info_request(int fd_out, struct object_info_args *args);
+
 #endif
diff --git a/transport-helper.c b/transport-helper.c
index 322c722478..48a6680200 100644
--- a/transport-helper.c
+++ b/transport-helper.c
@@ -686,13 +686,16 @@ static int fetch_refs(struct transport *transport,
 
 	/*
 	 * If we reach here, then the server, the client, and/or the transport
-	 * helper does not support protocol v2. --negotiate-only requires
-	 * protocol v2.
+	 * helper does not support protocol v2. --negotiate-only and --object-info
+	 * require protocol v2.
 	 */
 	if (data->transport_options.acked_commits) {
 		warning(_("--negotiate-only requires protocol v2"));
 		return -1;
 	}
+	if (transport->smart_options->object_info) {
+		die(_("--object-info requires protocol v2"));
+	}
 
 	if (!data->get_refs_list_called)
 		get_refs_list_using_list(transport, 0);
diff --git a/transport.c b/transport.c
index 52db7a3cb0..2d503e2fbd 100644
--- a/transport.c
+++ b/transport.c
@@ -353,6 +353,80 @@ static struct ref *handshake(struct transport *transport, int for_push,
 	return refs;
 }
 
+static int fetch_object_info(struct transport *transport, struct object_info **object_info_data)
+{
+	size_t i;
+	int size_index = -1;
+	struct git_transport_data *data = transport->data;
+	struct object_info_args args;
+	struct packet_reader reader;
+
+	memset(&args, 0, sizeof(args));
+	args.server_options = transport->server_options;
+	args.object_info_options = transport->smart_options->object_info_options;
+	args.oids = transport->smart_options->object_info_oids;
+
+	connect_setup(transport, 0);
+	packet_reader_init(&reader, data->fd[0], NULL, 0,
+			PACKET_READ_CHOMP_NEWLINE |
+			PACKET_READ_GENTLE_ON_EOF |
+			PACKET_READ_DIE_ON_ERR_PACKET);
+	data->version = discover_version(&reader);
+
+	transport->hash_algo = reader.hash_algo;
+
+	switch (data->version) {
+	case protocol_v2:
+		if (!server_supports_v2("object-info", 0))
+			return -1;
+		if (unsorted_string_list_has_string(args.object_info_options, "size")
+				&& !server_supports_feature("object-info", "size", 0)) {
+			return -1;
+		}
+		if (unsorted_string_list_has_string(args.object_info_options, "type")
+				&& !server_supports_feature("object-info", "type", 0)) {
+			return -1;
+		}
+		send_object_info_request(data->fd[1], &args);
+		break;
+	case protocol_v1:
+	case protocol_v0:
+		die(_("wrong protocol version. expected v2"));
+	case protocol_unknown_version:
+		BUG("unknown protocol version");
+	}
+
+	for (i = 0; i < args.object_info_options->nr; i++) {
+		if (packet_reader_read(&reader) != PACKET_READ_NORMAL) {
+			check_stateless_delimiter(transport->stateless_rpc, &reader, "stateless delimiter expected");
+			return -1;
+		}
+		if (unsorted_string_list_has_string(args.object_info_options, reader.line)) {
+			if (!strcmp(reader.line, "size"))
+				size_index = i;
+			continue;
+		}
+		return -1;
+	}
+
+	i = 0;
+	while (packet_reader_read(&reader) == PACKET_READ_NORMAL && i < args.oids->nr) {
+		struct string_list object_info_values = STRING_LIST_INIT_DUP;
+
+		string_list_split(&object_info_values, reader.line, ' ', -1);
+		if (0 <= size_index) {
+			if (!strcmp(object_info_values.items[1 + size_index].string, ""))
+				die("object-info: not our ref %s",
+					object_info_values.items[0].string);
+			*(*object_info_data)[i].sizep = strtoul(object_info_values.items[1 + size_index].string, NULL, 10);
+		}
+		i++;
+	}
+	check_stateless_delimiter(transport->stateless_rpc, &reader, "stateless delimiter expected");
+
+	return 0;
+}
+
 static struct ref *get_refs_via_connect(struct transport *transport, int for_push,
 					struct transport_ls_refs_options *options)
 {
@@ -363,10 +437,12 @@ static int fetch_refs_via_pack(struct transport *transport,
 			       int nr_heads, struct ref **to_fetch)
 {
 	int ret = 0;
+	size_t i;
 	struct git_transport_data *data = transport->data;
 	struct ref *refs = NULL;
 	struct fetch_pack_args args;
 	struct ref *refs_tmp = NULL;
+	struct ref *object_info_refs = xcalloc(1, sizeof (struct ref));
 
 	memset(&args, 0, sizeof(args));
 	args.uploadpack = data->options.uploadpack;
@@ -392,8 +468,25 @@ static int fetch_refs_via_pack(struct transport *transport,
 	args.server_options = transport->server_options;
 	args.negotiation_tips = data->options.negotiation_tips;
 	args.reject_shallow_remote = transport->smart_options->reject_shallow;
-
-	if (!data->got_remote_heads) {
+	args.object_info = transport->smart_options->object_info;
+
+	if (transport->smart_options && transport->smart_options->object_info) {
+		struct ref *ref = object_info_refs;
+
+		if (!fetch_object_info(transport, data->options.object_info_data))
+			goto cleanup;
+		args.object_info_data = data->options.object_info_data;
+		args.quiet = 1;
+		args.no_progress = 1;
+		for (i = 0; i < transport->smart_options->object_info_oids->nr; i++) {
+			struct ref *temp_ref = xcalloc(1, sizeof (struct ref));
+			temp_ref->old_oid = *(transport->smart_options->object_info_oids->oid + i);
+			temp_ref->exact_oid = 1;
+			ref->next = temp_ref;
+			ref = ref->next;
+		}
+		transport->remote_refs = object_info_refs->next;
+	} else if (!data->got_remote_heads) {
 		int i;
 		int must_list_refs = 0;
 		for (i = 0; i < nr_heads; i++) {
@@ -433,12 +526,22 @@ static int fetch_refs_via_pack(struct transport *transport,
 			  to_fetch, nr_heads, &data->shallow,
 			  &transport->pack_lockfiles, data->version);
 
+	if (args.object_info) {
+		struct ref *ref_cpy_reader = object_info_refs->next;
+		int i = 0;
+		while (ref_cpy_reader) {
+			oid_object_info_extended(the_repository, &ref_cpy_reader->old_oid, &(*args.object_info_data)[i], OBJECT_INFO_LOOKUP_REPLACE);
+			ref_cpy_reader = ref_cpy_reader->next;
+			i++;
+		}
+	}
+
 	data->got_remote_heads = 0;
 	data->options.self_contained_and_connected =
 		args.self_contained_and_connected;
 	data->options.connectivity_checked = args.connectivity_checked;
 
-	if (!refs)
+	if (refs == NULL && !args.object_info)
 		ret = -1;
 	if (report_unmatched_refs(to_fetch, nr_heads))
 		ret = -1;
@@ -453,6 +556,7 @@ static int fetch_refs_via_pack(struct transport *transport,
 
 	free_refs(refs_tmp);
 	free_refs(refs);
+	free_refs(object_info_refs);
 	return ret;
 }
 
diff --git a/transport.h b/transport.h
index b5bf7b3e70..5512fdb140 100644
--- a/transport.h
+++ b/transport.h
@@ -6,6 +6,7 @@
 #include "remote.h"
 #include "list-objects-filter-options.h"
 #include "string-list.h"
+#include "object-store.h"
 
 struct git_transport_options {
 	unsigned thin : 1;
@@ -31,6 +32,12 @@ struct git_transport_options {
 	 */
 	unsigned connectivity_checked:1;
 
+	/*
+	 * Transport will attempt to pull only object-info. Fallbacks
+	 * to pulling entire object if object-info is not supported
+	 */
+	unsigned object_info : 1;
+
 	int depth;
 	const char *deepen_since;
 	const struct string_list *deepen_not;
@@ -54,6 +61,10 @@ struct git_transport_options {
 	 * common commits to this oidset instead of fetching any packfiles.
 	 */
 	struct oidset *acked_commits;
+
+	struct oid_array *object_info_oids;
+	struct object_info **object_info_data;
+	struct string_list *object_info_options;
 };
 
 enum transport_family {
-- 
2.37.1.455.g008518b4e5-goog
Previous: Calvin WanNext: Junio C Hamano
Message 83 of 103 in “fetch —object-info-format: client option for object-info”
  1. fetch —object-info-format: client option for object-infoCalvin Wan, Feb 8, 2022
  2. fetch —object-info-format: client option for object-infoCalvin Wan, Feb 8, 2022
  3. Philip OakleyFeb 9, 2022
  4. Calvin WanFeb 10, 2022
  5. Jonathan TanFeb 9, 2022
  6. Calvin WanFeb 10, 2022
  7. 0/3 object-info: add option for retrieving object infoCalvin Wan, Mar 28, 2022
  8. 1/3 fetch-pack: refactor packet writing and fetch optionsCalvin Wan, Mar 28, 2022
  9. Junio C HamanoMar 29, 2022
  10. Taylor BlauMar 29, 2022
  11. Jonathan TanMar 30, 2022
  12. 2/3 transfer.advertiseObjectInfo: add object-info configCalvin Wan, Mar 28, 2022
  13. Junio C HamanoMar 29, 2022
  14. Calvin WanMar 29, 2022
  15. Taylor BlauMar 29, 2022
  16. 3/3 object-info: add option for retrieving object infoCalvin Wan, Mar 28, 2022
  17. Junio C HamanoMar 29, 2022
  18. Junio C HamanoMar 29, 2022
  19. Junio C HamanoMar 30, 2022
  20. Calvin WanMar 30, 2022
  21. Jonathan TanMar 30, 2022
  22. Junio C HamanoMar 30, 2022
  23. Taylor BlauMar 29, 2022
  24. Calvin WanMar 30, 2022
  25. John CaiMar 30, 2022
  26. Calvin WanMar 31, 2022
  27. Junio C HamanoApr 1, 2022
  28. Jonathan TanMar 30, 2022
  29. Josh SteadmonMar 30, 2022
  30. Calvin WanMar 30, 2022
  31. Junio C HamanoMar 29, 2022
  32. Calvin WanMar 29, 2022
  33. Junio C HamanoMar 31, 2022
  34. 0/8 cat-file: add --batch-command remote-object-info commandCalvin Wan, May 2, 2022
  35. 1/8 fetch-pack: refactor packet writingCalvin Wan, May 2, 2022
  36. 3/8 object-store: add function to free object_info contentsCalvin Wan, May 2, 2022
  37. Junio C HamanoMay 2, 2022
  38. Junio C HamanoMay 4, 2022
  39. Junio C HamanoMay 5, 2022
  40. Calvin WanMay 5, 2022
  41. Junio C HamanoMay 5, 2022
  42. 4/8 object-info: send attribute packet regardless of object idsCalvin Wan, May 2, 2022
  43. Junio C HamanoMay 3, 2022
  44. Calvin WanMay 3, 2022
  45. Jonathan TanMay 3, 2022
  46. 2/8 fetch-pack: move fetch default settingsCalvin Wan, May 2, 2022
  47. Junio C HamanoMay 2, 2022
  48. Jonathan TanMay 3, 2022
  49. Calvin WanMay 5, 2022
  50. 5/8 transport: add client side capability to request object-infoCalvin Wan, May 2, 2022
  51. Junio C HamanoMay 3, 2022
  52. Calvin WanMay 3, 2022
  53. Junio C HamanoMay 4, 2022
  54. Jonathan TanMay 3, 2022
  55. Junio C HamanoMay 4, 2022
  56. 7/8 cat-file: move parse_cmd and DEFAULT_FORMAT upCalvin Wan, May 2, 2022
  57. 6/8 transport: add object-info fallback to fetchCalvin Wan, May 2, 2022
  58. Jonathan TanMay 3, 2022
  59. 8/8 cat-file: add --batch-command remote-object-info commandCalvin Wan, May 2, 2022
  60. Jonathan TanMay 4, 2022
  61. Calvin WanMay 5, 2022
  62. Junio C HamanoMay 5, 2022
  63. Junio C HamanoMay 5, 2022
  64. Calvin WanMay 5, 2022
  65. ZheNing HuJul 31, 2022
  66. Calvin WanAug 8, 2022
  67. 0/6 cat-file: add --batch-command remote-object-info commandCalvin Wan, Jul 28, 2022
  68. Junio C HamanoJul 28, 2022
  69. Junio C HamanoJul 29, 2022
  70. Phillip WoodJul 31, 2022
  71. Calvin WanAug 4, 2022
  72. Junio C HamanoSep 30, 2022
  73. 1/6 fetch-pack: refactor packet writingCalvin Wan, Jul 28, 2022
  74. 2/6 fetch-pack: move fetch initializationCalvin Wan, Jul 28, 2022
  75. 3/6 protocol-caps: initialization bug fixCalvin Wan, Jul 28, 2022
  76. Junio C HamanoJul 29, 2022
  77. 4/6 serve: advertise object-info featureCalvin Wan, Jul 28, 2022
  78. Junio C HamanoJul 29, 2022
  79. Calvin WanAug 1, 2022
  80. Ævar Arnfjörð BjarmasonAug 1, 2022
  81. Junio C HamanoAug 1, 2022
  82. Calvin WanAug 1, 2022
  83. 5/6 transport: add client support for object-infoCalvin Wan, Jul 28, 2022
  84. Junio C HamanoJul 29, 2022
  85. Calvin WanAug 4, 2022
  86. Phillip WoodAug 1, 2022
  87. Calvin WanAug 4, 2022
  88. Phillip WoodAug 8, 2022
  89. Phillip WoodAug 1, 2022
  90. Phillip WoodAug 8, 2022
  91. 6/6 cat-file: add remote-object-info to batch-commandCalvin Wan, Jul 28, 2022
  92. Ævar Arnfjörð BjarmasonJul 29, 2022
  93. ZheNing HuAug 7, 2022
  94. Calvin WanAug 8, 2022
  95. Ævar Arnfjörð BjarmasonAug 11, 2022
  96. Junio C HamanoJul 29, 2022
  97. Calvin WanAug 8, 2022
  98. Ævar Arnfjörð BjarmasonSep 28, 2022
  99. ZheNing HuJul 31, 2022
  100. Calvin WanAug 8, 2022
  101. Junio C HamanoAug 13, 2022
  102. John CaiFeb 9, 2022
  103. Calvin WanFeb 10, 2022

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.