commit.c: add repo_get_commit_tree()

pclouds · gitster · commit 301b8c7f405d · 2019-04-16T18:56:51.000+09:00
Remove the implicit dependency on the_repository in this function.
It will be used in sha1-name.c functions when they are updated to take
any 'struct repository'. get_commit_tree() remains as a compat wrapper,
to be slowly replaced later.

Any access to "maybe_tree" field directly will result in _broken_ code
after running through commit.cocci because we can't know what is the
right repository to use.

the_repository would be correct most of the time. But we're relying less
and less on the_repository and that assumption may no longer be
true. The transformation now is more of a poor man replacement for a C++
compiler catching access to private fields.

Signed-off-by: Nguyễn Thái Ngọc Duy &lt;pclouds@gmail.com&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
diff --git a/commit.c b/commit.c
@@ -345,15 +345,16 @@ static inline void set_commit_tree(struct commit *c, struct tree *t)
 	c->maybe_tree = t;
 }
 
-struct tree *get_commit_tree(const struct commit *commit)
+struct tree *repo_get_commit_tree(struct repository *r,
+				  const struct commit *commit)
 {
 	if (commit->maybe_tree || !commit->object.parsed)
 		return commit->maybe_tree;
 
 	if (commit->graph_pos == COMMIT_NOT_FROM_GRAPH)
 		BUG("commit has NULL tree, but was not loaded from commit-graph");
 
-	return get_commit_tree_in_graph(the_repository, commit);
+	return get_commit_tree_in_graph(r, commit);
 }
 
 struct object_id *get_commit_tree_oid(const struct commit *commit)
diff --git a/commit.h b/commit.h
@@ -32,7 +32,7 @@ struct commit {
 
 	/*
 	 * If the commit is loaded from the commit-graph file, then this
-	 * member may be NULL. Only access it through get_commit_tree()
+	 * member may be NULL. Only access it through repo_get_commit_tree()
 	 * or get_commit_tree_oid().
 	 */
 	struct tree *maybe_tree;
@@ -143,7 +143,8 @@ void repo_unuse_commit_buffer(struct repository *r,
  */
 void free_commit_buffer(struct parsed_object_pool *pool, struct commit *);
 
-struct tree *get_commit_tree(const struct commit *);
+struct tree *repo_get_commit_tree(struct repository *, const struct commit *);
+#define get_commit_tree(c) repo_get_commit_tree(the_repository, c)
 struct object_id *get_commit_tree_oid(const struct commit *);
 
 /*
diff --git a/contrib/coccinelle/commit.cocci b/contrib/coccinelle/commit.cocci
@@ -23,12 +23,12 @@ expression s;
 // These excluded functions must access c->maybe_tree direcly.
 // Note that if c->maybe_tree is written somewhere outside of these
 // functions, then the recommended transformation will be bogus with
-// get_commit_tree() on the LHS.
+// repo_get_commit_tree() on the LHS.
 @@
-identifier f !~ "^(get_commit_tree|get_commit_tree_in_graph_one|load_tree_for_commit|set_commit_tree)$";
+identifier f !~ "^(repo_get_commit_tree|get_commit_tree_in_graph_one|load_tree_for_commit|set_commit_tree)$";
 expression c;
 @@
   f(...) {<...
 - c->maybe_tree
-+ get_commit_tree(c)
++ repo_get_commit_tree(specify_the_right_repo_here, c)
   ...>}

Original file line number	Diff line number	Diff line change
`@@ -345,15 +345,16 @@ static inline void set_commit_tree(struct commit c, struct tree t)`
`345`	`345`	`c->maybe_tree = t;`
`346`	`346`	`}`
`347`	`347`
`348`		`-struct tree get_commit_tree(const struct commit commit)`
	`348`	`+struct tree repo_get_commit_tree(struct repository r,`
	`349`	`+ const struct commit *commit)`
`349`	`350`	`{`
`350`	`351`	`if (commit->maybe_tree \|\| !commit->object.parsed)`
`351`	`352`	`return commit->maybe_tree;`
`352`	`353`
`353`	`354`	`if (commit->graph_pos == COMMIT_NOT_FROM_GRAPH)`
`354`	`355`	`BUG("commit has NULL tree, but was not loaded from commit-graph");`
`355`	`356`
`356`		`- return get_commit_tree_in_graph(the_repository, commit);`
	`357`	`+ return get_commit_tree_in_graph(r, commit);`
`357`	`358`	`}`
`358`	`359`
`359`	`360`	`struct object_id get_commit_tree_oid(const struct commit commit)`