RE: [PATCH v3 03/12] object-file API: add a format_object_header() function

[Jiang Xin <worldhello.net@gmail.com>]

From: Jiang Xin <zhiyou.jx@alibaba-inc.com>

On Sat, Feb 5, 2022 Ævar Arnfjörð Bjarmason wrote:

> diff --git a/builtin/fast-import.c b/builtin/fast-import.c
> index 2b2e28bad79..123df7d9a53 100644
> --- a/builtin/fast-import.c
> +++ b/builtin/fast-import.c
> @@ -937,8 +937,8 @@ static int store_object(
>  	git_hash_ctx c;
>  	git_zstream s;
>  
> -	hdrlen = xsnprintf((char *)hdr, sizeof(hdr), "%s %lu",
> -			   type_name(type), (unsigned long)dat->len) + 1;
> +	hdrlen = format_object_header((char *)hdr, sizeof(hdr), type,
> +				      dat->len);

Type casting can be avoid if we use "void *" as the first parameter of
"format_object_header", and do type casting inside the helper function.

> diff --git a/object-file.c b/object-file.c
> index eeb6814780a..3fcd46cf9ed 100644
> --- a/object-file.c
> +++ b/object-file.c
> @@ -1049,6 +1049,23 @@ void *xmmap(void *start, size_t length,
>  	return ret;
>  }
>  
> +static int format_object_header_literally(char *str, size_t size,
> +					  const char *type, size_t objsize)
> +{
> +	return xsnprintf(str, size, "%s %"PRIuMAX, type, (uintmax_t)objsize) + 1;
> +}
> +
> +int format_object_header(char *str, size_t size, enum object_type type,
> +			 size_t objsize)
> +{
> +	const char *name = type_name(type);
> +
> +	if (!name)
> +		BUG("could not get a type name for 'enum object_type' value %d", type);
> +

The return value of `type_name(type)` has not been checked for the original
implement, how about write a online inline-function in a header file like this:

	static inline int format_object_header(void *str, size_t size,
					       const char *type_name,
					       size_t objsize)
	{
		return xsnprintf((char *)str, size, "%s %"PRIuMAX, type_name,
				 (uintmax_t)objsize) + 1;
	}
 
> +	return format_object_header_literally(str, size, name, objsize);
> +}


--- >8 ---
From: Jiang Xin <zhiyou.jx@alibaba-inc.com>
Date: Thu, 17 Feb 2022 11:35:27 +0800
Subject: [PATCH] fixup! object-file API: add a format_object_header() function

Signed-off-by: Jiang Xin <zhiyou.jx@alibaba-inc.com>
---
 builtin/fast-import.c |  4 ++--
 builtin/index-pack.c  |  3 ++-
 bulk-checkin.c        |  4 ++--
 http-push.c           |  2 +-
 object-file.c         | 23 +++--------------------
 object-store.h        |  9 +++++++--
 6 files changed, 17 insertions(+), 28 deletions(-)

diff --git a/builtin/fast-import.c b/builtin/fast-import.c
index 123df7d9a5..f5ec40fc1b 100644
--- a/builtin/fast-import.c
+++ b/builtin/fast-import.c
@@ -937,7 +937,7 @@ static int store_object(
 	git_hash_ctx c;
 	git_zstream s;
 
-	hdrlen = format_object_header((char *)hdr, sizeof(hdr), type,
+	hdrlen = format_object_header(hdr, sizeof(hdr), type_name(type),
 				      dat->len);
 	the_hash_algo->init_fn(&c);
 	the_hash_algo->update_fn(&c, hdr, hdrlen);
@@ -1091,7 +1091,7 @@ static void stream_blob(uintmax_t len, struct object_id *oidout, uintmax_t mark)
 	hashfile_checkpoint(pack_file, &checkpoint);
 	offset = checkpoint.offset;
 
-	hdrlen = format_object_header((char *)out_buf, out_sz, OBJ_BLOB, len);
+	hdrlen = format_object_header(out_buf, out_sz, "blob", len);
 
 	the_hash_algo->init_fn(&c);
 	the_hash_algo->update_fn(&c, out_buf, hdrlen);
diff --git a/builtin/index-pack.c b/builtin/index-pack.c
index 01574378ce..a37533333e 100644
--- a/builtin/index-pack.c
+++ b/builtin/index-pack.c
@@ -449,7 +449,8 @@ static void *unpack_entry_data(off_t offset, unsigned long size,
 	int hdrlen;
 
 	if (!is_delta_type(type)) {
-		hdrlen = format_object_header(hdr, sizeof(hdr), type, size);
+		hdrlen = format_object_header(hdr, sizeof(hdr), type_name(type),
+					      size);
 		the_hash_algo->init_fn(&c);
 		the_hash_algo->update_fn(&c, hdr, hdrlen);
 	} else
diff --git a/bulk-checkin.c b/bulk-checkin.c
index 85b3ebaf97..58fb59990d 100644
--- a/bulk-checkin.c
+++ b/bulk-checkin.c
@@ -220,8 +220,8 @@ static int deflate_to_pack(struct bulk_checkin_state *state,
 	if (seekback == (off_t) -1)
 		return error("cannot find the current offset");
 
-	header_len = format_object_header((char *)obuf, sizeof(obuf),
-					  type, size);
+	header_len = format_object_header(obuf, sizeof(obuf), type_name(type),
+					  size);
 	the_hash_algo->init_fn(&ctx);
 	the_hash_algo->update_fn(&ctx, obuf, header_len);
 
diff --git a/http-push.c b/http-push.c
index f0c044dcf7..eb2b46b2fc 100644
--- a/http-push.c
+++ b/http-push.c
@@ -363,7 +363,7 @@ static void start_put(struct transfer_request *request)
 	git_zstream stream;
 
 	unpacked = read_object_file(&request->obj->oid, &type, &len);
-	hdrlen = format_object_header(hdr, sizeof(hdr), type, len);
+	hdrlen = format_object_header(hdr, sizeof(hdr), type_name(type), len);
 
 	/* Set it up */
 	git_deflate_init(&stream, zlib_compression_level);
diff --git a/object-file.c b/object-file.c
index 3fcd46cf9e..f396e78909 100644
--- a/object-file.c
+++ b/object-file.c
@@ -1049,23 +1049,6 @@ void *xmmap(void *start, size_t length,
 	return ret;
 }
 
-static int format_object_header_literally(char *str, size_t size,
-					  const char *type, size_t objsize)
-{
-	return xsnprintf(str, size, "%s %"PRIuMAX, type, (uintmax_t)objsize) + 1;
-}
-
-int format_object_header(char *str, size_t size, enum object_type type,
-			 size_t objsize)
-{
-	const char *name = type_name(type);
-
-	if (!name)
-		BUG("could not get a type name for 'enum object_type' value %d", type);
-
-	return format_object_header_literally(str, size, name, objsize);
-}
-
 /*
  * With an in-core object data in "map", rehash it to make sure the
  * object name actually matches "oid" to detect object corruption.
@@ -1094,7 +1077,7 @@ int check_object_signature(struct repository *r, const struct object_id *oid,
 		return -1;
 
 	/* Generate the header */
-	hdrlen = format_object_header(hdr, sizeof(hdr), obj_type, size);
+	hdrlen = format_object_header(hdr, sizeof(hdr), type_name(obj_type), size);
 
 	/* Sha1.. */
 	r->hash_algo->init_fn(&c);
@@ -1794,7 +1777,7 @@ static void write_object_file_prepare(const struct git_hash_algo *algo,
 	git_hash_ctx c;
 
 	/* Generate the header */
-	*hdrlen = format_object_header_literally(hdr, *hdrlen, type, len);
+	*hdrlen = format_object_header(hdr, *hdrlen, type, len);
 
 	/* Sha1.. */
 	algo->init_fn(&c);
@@ -2068,7 +2051,7 @@ int force_object_loose(const struct object_id *oid, time_t mtime)
 	buf = read_object(the_repository, oid, &type, &len);
 	if (!buf)
 		return error(_("cannot read object for %s"), oid_to_hex(oid));
-	hdrlen = format_object_header(hdr, sizeof(hdr), type, len);
+	hdrlen = format_object_header(hdr, sizeof(hdr), type_name(type), len);
 	ret = write_loose_object(oid, hdr, hdrlen, buf, len, mtime, 0);
 	free(buf);
 
diff --git a/object-store.h b/object-store.h
index 8b4413d0ce..33b5add7ab 100644
--- a/object-store.h
+++ b/object-store.h
@@ -336,8 +336,13 @@ int has_loose_object_nonlocal(const struct object_id *);
  * writes the initial "<type> <obj-len>" part of the loose object
  * header. It returns the size that snprintf() returns + 1.
  */
-int format_object_header(char *str, size_t size, enum object_type type,
-			 size_t objsize);
+static inline int format_object_header(void *str, size_t size,
+				       const char *type_name,
+				       size_t objsize)
+{
+	return xsnprintf((char *)str, size, "%s %"PRIuMAX, type_name,
+			 (uintmax_t)objsize) + 1;
+}
 
 void assert_oid_type(const struct object_id *oid, enum object_type expect);
 
-- 
2.35.0.rc2