diff mbox series

[5/5] cat-file: use packed_object_info() for --batch-all-objects

Message ID YVy3rPuUal0+9iJs@coredump.intra.peff.net (mailing list archive)
State New, archived
Headers show
Series cat-file replace handling and optimization | expand

Commit Message

Jeff King Oct. 5, 2021, 8:38 p.m. UTC
When "cat-file --batch-all-objects" iterates over each object, it knows
where to find each one. But when we look up details of the object, we
don't use that information at all.

This patch teaches it to use the pack/offset pair when we're iterating
over objects in a pack. This yields a measurable speed improvement
(timings on a fully packed clone of linux.git):

  Benchmark #1: ./git.old cat-file --batch-all-objects --unordered --batch-check="%(objecttype) %(objectname)"
    Time (mean ± σ):      8.128 s ±  0.118 s    [User: 7.968 s, System: 0.156 s]
    Range (min … max):    8.007 s …  8.301 s    10 runs

  Benchmark #2: ./git.new cat-file --batch-all-objects --unordered --batch-check="%(objecttype) %(objectname)"
    Time (mean ± σ):      4.294 s ±  0.064 s    [User: 4.167 s, System: 0.125 s]
    Range (min … max):    4.227 s …  4.457 s    10 runs

  Summary
    './git.new cat-file --batch-all-objects --unordered --batch-check="%(objecttype) %(objectname)"' ran
      1.89 ± 0.04 times faster than './git.old cat-file --batch-all-objects --unordered --batch-check="%(objecttype) %(objectname)"

The implementation is pretty simple: we just call packed_object_info()
instead of oid_object_info_extended() when we can. Most of the changes
are just plumbing the pack/offset pair through the callstack. There is
one subtlety: replace lookups are not handled by packed_object_info().
But since those are disabled for --batch-all-objects, and since we'll
only have pack info when that option is in effect, we don't have to
worry about that.

There are a few limitations to this optimization which we could address
with further work:

 - I didn't bother recording when we found an object loose. Technically
   this could save us doing a fruitless lookup in the pack index. But
   opening and mmap-ing a loose object is so expensive in the first
   place that this doesn't matter much. And if your repository is large
   enough to care about per-object performance, most objects are going
   to be packed anyway.

 - This works only in --unordered mode. For the sorted mode, we'd have
   to record the pack/offset pair as part of our oid-collection. That's
   more code, plus at least 16 extra bytes of heap per object. It would
   probably still be a net win in runtime, but we'd need to measure.

 - For --batch, this still helps us with getting the object metadata,
   but we still do a from-scratch lookup for the object contents. This
   probably doesn't matter that much, because the lookup cost will be
   much smaller relative to the cost of actually unpacking and printing
   the objects.

   For small objects, we could probably swap out read_object_file() for
   using packed_object_info() with a "object_info.contentp" to get the
   contents. But we'd still need to deal with streaming for larger
   objects. A better path forward here is to teach the initial
   oid_object_info_extended() / packed_object_info() calls to retrieve
   the contents of smaller objects while they are already being
   accessed. That would save the extra lookup entirely. But it's a
   non-trivial feature to add to the object_info code, so I left it for
   now.

Signed-off-by: Jeff King <peff@peff.net>
---
I have some patches for the "give me the content in a single call if
it's small" idea, but they need some polishing. It also doesn't produce
as spectacular a speedup as I'd hoped, which is why I threw it on the
back burner. I think it's just because actually dealing with the object
content is so much more expensive than an extra lookup.

 builtin/cat-file.c | 45 +++++++++++++++++++++++++++++++--------------
 1 file changed, 31 insertions(+), 14 deletions(-)

Comments

Junio C Hamano Oct. 7, 2021, 8:56 p.m. UTC | #1
Jeff King <peff@peff.net> writes:

> diff --git a/builtin/cat-file.c b/builtin/cat-file.c
> index b533935d5c..219ff5628d 100644
> --- a/builtin/cat-file.c
> +++ b/builtin/cat-file.c
> @@ -358,15 +358,26 @@ static void print_object_or_die(struct batch_options *opt, struct expand_data *d

The two new parameters might deserve a comment in front of the
function as to the calling convention (namely, offset can be any
garbage when the caller signals "unknown" with pack==NULL). 

>  static void batch_object_write(const char *obj_name,
>  			       struct strbuf *scratch,
>  			       struct batch_options *opt,
> -			       struct expand_data *data)
> +			       struct expand_data *data,
> +			       struct packed_git *pack,
> +			       off_t offset)
>  {
> -	if (!data->skip_object_info &&
> -	    oid_object_info_extended(the_repository, &data->oid, &data->info,
> -				     OBJECT_INFO_LOOKUP_REPLACE) < 0) {
> -		printf("%s missing\n",
> -		       obj_name ? obj_name : oid_to_hex(&data->oid));
> -		fflush(stdout);
> -		return;
> +	if (!data->skip_object_info) {
> +		int ret;
> +
> +		if (pack)
> +			ret = packed_object_info(the_repository, pack, offset,
> +						 &data->info);
> +		else
> +			ret = oid_object_info_extended(the_repository,
> +						       &data->oid, &data->info,
> +						       OBJECT_INFO_LOOKUP_REPLACE);
> +		if (ret < 0) {
> +			printf("%s missing\n",
> +			       obj_name ? obj_name : oid_to_hex(&data->oid));
> +			fflush(stdout);
> +			return;
> +		}
>  	}

The implementation is quite straight-forward.

> @@ -463,31 +475,36 @@ static int collect_packed_object(const struct object_id *oid,
>  	return 0;
>  }
>  
> -static int batch_unordered_object(const struct object_id *oid, void *vdata)
> +static int batch_unordered_object(const struct object_id *oid,
> +				  struct packed_git *pack, off_t offset,
> +				  void *vdata)
>  {
>  	struct object_cb_data *data = vdata;
>  
>  	if (oidset_insert(data->seen, oid))
>  		return 0;
>  
>  	oidcpy(&data->expand->oid, oid);
> -	batch_object_write(NULL, data->scratch, data->opt, data->expand);
> +	batch_object_write(NULL, data->scratch, data->opt, data->expand,
> +			   pack, offset);
>  	return 0;
>  }
> ...
>  static int batch_unordered_packed(const struct object_id *oid,
>  				  struct packed_git *pack,
>  				  uint32_t pos,
>  				  void *data)
>  {
> -	return batch_unordered_object(oid, data);
> +	return batch_unordered_object(oid, pack,
> +				      nth_packed_object_offset(pack, pos),
> +				      data);
>  }

We used to discard a good piece of info (i.e.  which pack we found
the object in), but we can make good use of it.

Nice.
Jeff King Oct. 8, 2021, 2:35 a.m. UTC | #2
On Thu, Oct 07, 2021 at 01:56:26PM -0700, Junio C Hamano wrote:

> Jeff King <peff@peff.net> writes:
> 
> > diff --git a/builtin/cat-file.c b/builtin/cat-file.c
> > index b533935d5c..219ff5628d 100644
> > --- a/builtin/cat-file.c
> > +++ b/builtin/cat-file.c
> > @@ -358,15 +358,26 @@ static void print_object_or_die(struct batch_options *opt, struct expand_data *d
> 
> The two new parameters might deserve a comment in front of the
> function as to the calling convention (namely, offset can be any
> garbage when the caller signals "unknown" with pack==NULL).

Yes, though I'd hope everyone would just pass NULL/0. :)

I wasn't too worried about it as this is a static-local function, but
perhaps it's worth squashing the patch below into the final patch.

The "we may also look at the oid" thing is perhaps a bit subtle. It
happens because we may still print %(objectname), of course, but also
the current code will use read_object_file(oid) when printing the actual
contents.

-Peff

---
diff --git a/builtin/cat-file.c b/builtin/cat-file.c
index 219ff5628d..86fc03242b 100644
--- a/builtin/cat-file.c
+++ b/builtin/cat-file.c
@@ -355,6 +355,11 @@ static void print_object_or_die(struct batch_options *opt, struct expand_data *d
 	}
 }
 
+/*
+ * If "pack" is non-NULL, then "offset" is the byte offset within the pack from
+ * which the object may be accessed (though note that we may also rely on
+ * data->oid, too). If "pack" is NULL, then offset is ignored.
+ */
 static void batch_object_write(const char *obj_name,
 			       struct strbuf *scratch,
 			       struct batch_options *opt,
diff mbox series

Patch

diff --git a/builtin/cat-file.c b/builtin/cat-file.c
index b533935d5c..219ff5628d 100644
--- a/builtin/cat-file.c
+++ b/builtin/cat-file.c
@@ -358,15 +358,26 @@  static void print_object_or_die(struct batch_options *opt, struct expand_data *d
 static void batch_object_write(const char *obj_name,
 			       struct strbuf *scratch,
 			       struct batch_options *opt,
-			       struct expand_data *data)
+			       struct expand_data *data,
+			       struct packed_git *pack,
+			       off_t offset)
 {
-	if (!data->skip_object_info &&
-	    oid_object_info_extended(the_repository, &data->oid, &data->info,
-				     OBJECT_INFO_LOOKUP_REPLACE) < 0) {
-		printf("%s missing\n",
-		       obj_name ? obj_name : oid_to_hex(&data->oid));
-		fflush(stdout);
-		return;
+	if (!data->skip_object_info) {
+		int ret;
+
+		if (pack)
+			ret = packed_object_info(the_repository, pack, offset,
+						 &data->info);
+		else
+			ret = oid_object_info_extended(the_repository,
+						       &data->oid, &data->info,
+						       OBJECT_INFO_LOOKUP_REPLACE);
+		if (ret < 0) {
+			printf("%s missing\n",
+			       obj_name ? obj_name : oid_to_hex(&data->oid));
+			fflush(stdout);
+			return;
+		}
 	}
 
 	strbuf_reset(scratch);
@@ -428,7 +439,7 @@  static void batch_one_object(const char *obj_name,
 		return;
 	}
 
-	batch_object_write(obj_name, scratch, opt, data);
+	batch_object_write(obj_name, scratch, opt, data, NULL, 0);
 }
 
 struct object_cb_data {
@@ -442,7 +453,8 @@  static int batch_object_cb(const struct object_id *oid, void *vdata)
 {
 	struct object_cb_data *data = vdata;
 	oidcpy(&data->expand->oid, oid);
-	batch_object_write(NULL, data->scratch, data->opt, data->expand);
+	batch_object_write(NULL, data->scratch, data->opt, data->expand,
+			   NULL, 0);
 	return 0;
 }
 
@@ -463,31 +475,36 @@  static int collect_packed_object(const struct object_id *oid,
 	return 0;
 }
 
-static int batch_unordered_object(const struct object_id *oid, void *vdata)
+static int batch_unordered_object(const struct object_id *oid,
+				  struct packed_git *pack, off_t offset,
+				  void *vdata)
 {
 	struct object_cb_data *data = vdata;
 
 	if (oidset_insert(data->seen, oid))
 		return 0;
 
 	oidcpy(&data->expand->oid, oid);
-	batch_object_write(NULL, data->scratch, data->opt, data->expand);
+	batch_object_write(NULL, data->scratch, data->opt, data->expand,
+			   pack, offset);
 	return 0;
 }
 
 static int batch_unordered_loose(const struct object_id *oid,
 				 const char *path,
 				 void *data)
 {
-	return batch_unordered_object(oid, data);
+	return batch_unordered_object(oid, NULL, 0, data);
 }
 
 static int batch_unordered_packed(const struct object_id *oid,
 				  struct packed_git *pack,
 				  uint32_t pos,
 				  void *data)
 {
-	return batch_unordered_object(oid, data);
+	return batch_unordered_object(oid, pack,
+				      nth_packed_object_offset(pack, pos),
+				      data);
 }
 
 static int batch_objects(struct batch_options *opt)