parse_config_key(): return subsection len as size_t

peff · gitster · commit f5914f4b6bcd · 2020-04-10T14:44:29.000-07:00
We return the length to a subset of a string using an "int *"
out-parameter. This is fine most of the time, as we'd expect config keys
to be relatively short, but it could behave oddly if we had a gigantic
config key. A more appropriate type is size_t.

Let's switch over, which lets our callers use size_t as appropriate
(they are bound by our type because they must pass the out-parameter as
a pointer). This is mostly just a cleanup to make it clear this code
handles long strings correctly. In practice, our config parser already
chokes on long key names (because of a similar int/size_t mixup!).

When doing an int/size_t conversion, we have to be careful that nobody
was trying to assign a negative value to the variable. I manually
confirmed that for each case here. They tend to just feed the result to
xmemdupz() or similar; in a few cases I adjusted the parameter types for
helper functions to make sure the size_t is preserved.

Signed-off-by: Jeff King &lt;peff@peff.net&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
diff --git a/archive-tar.c b/archive-tar.c
@@ -364,7 +364,7 @@ static struct archiver **tar_filters;
 static int nr_tar_filters;
 static int alloc_tar_filters;
 
-static struct archiver *find_tar_filter(const char *name, int len)
+static struct archiver *find_tar_filter(const char *name, size_t len)
 {
 	int i;
 	for (i = 0; i < nr_tar_filters; i++) {
@@ -380,7 +380,7 @@ static int tar_filter_config(const char *var, const char *value, void *data)
 	struct archiver *ar;
 	const char *name;
 	const char *type;
-	int namelen;
+	size_t namelen;
 
 	if (parse_config_key(var, "tar", &name, &namelen, &type) < 0 || !name)
 		return 0;
diff --git a/builtin/help.c b/builtin/help.c
@@ -242,7 +242,7 @@ static int add_man_viewer_cmd(const char *name,
 static int add_man_viewer_info(const char *var, const char *value)
 {
 	const char *name, *subkey;
-	int namelen;
+	size_t namelen;
 
 	if (parse_config_key(var, "man", &name, &namelen, &subkey) < 0 || !name)
 		return 0;
diff --git a/builtin/reflog.c b/builtin/reflog.c
@@ -459,7 +459,7 @@ static struct reflog_expire_cfg *find_cfg_ent(const char *pattern, size_t len)
 static int reflog_expire_config(const char *var, const char *value, void *cb)
 {
 	const char *pattern, *key;
-	int pattern_len;
+	size_t pattern_len;
 	timestamp_t expire;
 	int slot;
 	struct reflog_expire_cfg *ent;
diff --git a/config.c b/config.c
@@ -309,7 +309,7 @@ int git_config_include(const char *var, const char *value, void *data)
 {
 	struct config_include_data *inc = data;
 	const char *cond, *key;
-	int cond_len;
+	size_t cond_len;
 	int ret;
 
 	/*
@@ -3238,7 +3238,7 @@ int config_error_nonbool(const char *var)
 
 int parse_config_key(const char *var,
 		     const char *section,
-		     const char **subsection, int *subsection_len,
+		     const char **subsection, size_t *subsection_len,
 		     const char **key)
 {
 	const char *dot;
diff --git a/config.h b/config.h
@@ -359,7 +359,7 @@ int git_config_include(const char *name, const char *value, void *data);
  */
 int parse_config_key(const char *var,
 		     const char *section,
-		     const char **subsection, int *subsection_len,
+		     const char **subsection, size_t *subsection_len,
 		     const char **key);
 
 /**
diff --git a/convert.c b/convert.c
@@ -1018,7 +1018,7 @@ static int apply_filter(const char *path, const char *src, size_t len,
 static int read_convert_config(const char *var, const char *value, void *cb)
 {
 	const char *key, *name;
-	int namelen;
+	size_t namelen;
 	struct convert_driver *drv;
 
 	/*
diff --git a/fsck.c b/fsck.c
@@ -920,7 +920,7 @@ static int fsck_gitmodules_fn(const char *var, const char *value, void *vdata)
 {
 	struct fsck_gitmodules_data *data = vdata;
 	const char *subsection, *key;
-	int subsection_len;
+	size_t subsection_len;
 	char *name;
 
 	if (parse_config_key(var, "submodule", &subsection, &subsection_len, &key) < 0 ||
diff --git a/ll-merge.c b/ll-merge.c
@@ -247,7 +247,7 @@ static int read_merge_config(const char *var, const char *value, void *cb)
 {
 	struct ll_merge_driver *fn;
 	const char *key, *name;
-	int namelen;
+	size_t namelen;
 
 	if (!strcmp(var, "merge.default"))
 		return git_config_string(&default_ll_merge, var, value);
diff --git a/promisor-remote.c b/promisor-remote.c
@@ -101,7 +101,7 @@ static void promisor_remote_move_to_tail(struct promisor_remote *r,
 static int promisor_remote_config(const char *var, const char *value, void *data)
 {
 	const char *name;
-	int namelen;
+	size_t namelen;
 	const char *subkey;
 
 	if (!strcmp(var, "core.partialclonefilter"))
diff --git a/remote.c b/remote.c
@@ -305,7 +305,7 @@ static void read_branches_file(struct remote *remote)
 static int handle_config(const char *key, const char *value, void *cb)
 {
 	const char *name;
-	int namelen;
+	size_t namelen;
 	const char *subkey;
 	struct remote *remote;
 	struct branch *branch;
diff --git a/submodule-config.c b/submodule-config.c
@@ -225,7 +225,8 @@ static int name_and_item_from_var(const char *var, struct strbuf *name,
 				  struct strbuf *item)
 {
 	const char *subsection, *key;
-	int subsection_len, parse;
+	size_t subsection_len;
+	int parse;
 	parse = parse_config_key(var, "submodule", &subsection,
 			&subsection_len, &key);
 	if (parse < 0 || !subsection)
diff --git a/userdiff.c b/userdiff.c
@@ -222,7 +222,7 @@ static struct userdiff_driver driver_false = {
 	{ NULL, 0 }
 };
 
-static struct userdiff_driver *userdiff_find_by_namelen(const char *k, int len)
+static struct userdiff_driver *userdiff_find_by_namelen(const char *k, size_t len)
 {
 	int i;
 	for (i = 0; i < ndrivers; i++) {
@@ -266,7 +266,7 @@ int userdiff_config(const char *k, const char *v)
 {
 	struct userdiff_driver *drv;
 	const char *name, *type;
-	int namelen;
+	size_t namelen;
 
 	if (parse_config_key(k, "diff", &name, &namelen, &type) || !name)
 		return 0;

Original file line number	Diff line number	Diff line change
`@@ -242,7 +242,7 @@ static int add_man_viewer_cmd(const char *name,`
`242`	`242`	`static int add_man_viewer_info(const char var, const char value)`
`243`	`243`	`{`
`244`	`244`	`const char name, subkey;`
`245`		`- int namelen;`
	`245`	`+ size_t namelen;`
`246`	`246`
`247`	`247`	`if (parse_config_key(var, "man", &name, &namelen, &subkey) < 0 \|\| !name)`
`248`	`248`	`return 0;`
Original file line number	Diff line number	Diff line change
`@@ -459,7 +459,7 @@ static struct reflog_expire_cfg find_cfg_ent(const char pattern, size_t len)`
`459`	`459`	`static int reflog_expire_config(const char var, const char value, void *cb)`
`460`	`460`	`{`
`461`	`461`	`const char pattern, key;`
`462`		`- int pattern_len;`
	`462`	`+ size_t pattern_len;`
`463`	`463`	`timestamp_t expire;`
`464`	`464`	`int slot;`
`465`	`465`	`struct reflog_expire_cfg *ent;`
Original file line number	Diff line number	Diff line change
`@@ -1018,7 +1018,7 @@ static int apply_filter(const char path, const char src, size_t len,`
`1018`	`1018`	`static int read_convert_config(const char var, const char value, void *cb)`
`1019`	`1019`	`{`
`1020`	`1020`	`const char key, name;`
`1021`		`- int namelen;`
	`1021`	`+ size_t namelen;`
`1022`	`1022`	`struct convert_driver *drv;`
`1023`	`1023`
`1024`	`1024`	`/*`
Original file line number	Diff line number	Diff line change
`@@ -920,7 +920,7 @@ static int fsck_gitmodules_fn(const char var, const char value, void *vdata)`
`920`	`920`	`{`
`921`	`921`	`struct fsck_gitmodules_data *data = vdata;`
`922`	`922`	`const char subsection, key;`
`923`		`- int subsection_len;`
	`923`	`+ size_t subsection_len;`
`924`	`924`	`char *name;`
`925`	`925`
`926`	`926`	`if (parse_config_key(var, "submodule", &subsection, &subsection_len, &key) < 0 \|\|`
Original file line number	Diff line number	Diff line change
`@@ -247,7 +247,7 @@ static int read_merge_config(const char var, const char value, void *cb)`
`247`	`247`	`{`
`248`	`248`	`struct ll_merge_driver *fn;`
`249`	`249`	`const char key, name;`
`250`		`- int namelen;`
	`250`	`+ size_t namelen;`
`251`	`251`
`252`	`252`	`if (!strcmp(var, "merge.default"))`
`253`	`253`	`return git_config_string(&default_ll_merge, var, value);`
Original file line number	Diff line number	Diff line change
`@@ -101,7 +101,7 @@ static void promisor_remote_move_to_tail(struct promisor_remote *r,`
`101`	`101`	`static int promisor_remote_config(const char var, const char value, void *data)`
`102`	`102`	`{`
`103`	`103`	`const char *name;`
`104`		`- int namelen;`
	`104`	`+ size_t namelen;`
`105`	`105`	`const char *subkey;`
`106`	`106`
`107`	`107`	`if (!strcmp(var, "core.partialclonefilter"))`
Original file line number	Diff line number	Diff line change
`@@ -305,7 +305,7 @@ static void read_branches_file(struct remote *remote)`
`305`	`305`	`static int handle_config(const char key, const char value, void *cb)`
`306`	`306`	`{`
`307`	`307`	`const char *name;`
`308`		`- int namelen;`
	`308`	`+ size_t namelen;`
`309`	`309`	`const char *subkey;`
`310`	`310`	`struct remote *remote;`
`311`	`311`	`struct branch *branch;`