commit.c: add repo_get_commit_tree()

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 <pclouds@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Nguyễn Thái Ngọc Duy committed Apr 16, 2019 at 16:33 UTC 301b8c7f405d3cd4f32b14bd336ac8c0400d9382
3 files changed +9 -7
commit.c
+3 -2
@@ -345,7 +345,8 @@ static inline void set_commit_tree(struct commit *c, struct tree *t)
345 c->maybe_tree = t;
346 }
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)
350 {
351 if (commit->maybe_tree || !commit->object.parsed)
352 return commit->maybe_tree;
@@ -353,7 +354,7 @@ struct tree *get_commit_tree(const struct commit *commit)
354 if (commit->graph_pos == COMMIT_NOT_FROM_GRAPH)
355 BUG("commit has NULL tree, but was not loaded from commit-graph");
356
356 - return get_commit_tree_in_graph(the_repository, commit);
357 + return get_commit_tree_in_graph(r, commit);
358 }
359
360 struct object_id *get_commit_tree_oid(const struct commit *commit)
commit.h
+3 -2
@@ -32,7 +32,7 @@ struct commit {
32
33 /*
34 * If the commit is loaded from the commit-graph file, then this
35 - * member may be NULL. Only access it through get_commit_tree()
35 + * member may be NULL. Only access it through repo_get_commit_tree()
36 * or get_commit_tree_oid().
37 */
38 struct tree *maybe_tree;
@@ -143,7 +143,8 @@ void repo_unuse_commit_buffer(struct repository *r,
143 */
144 void free_commit_buffer(struct parsed_object_pool *pool, struct commit *);
145
146 -struct tree *get_commit_tree(const struct commit *);
146 +struct tree *repo_get_commit_tree(struct repository *, const struct commit *);
147 +#define get_commit_tree(c) repo_get_commit_tree(the_repository, c)
148 struct object_id *get_commit_tree_oid(const struct commit *);
149
150 /*
contrib/coccinelle/commit.cocci
+3 -3
@@ -23,12 +23,12 @@ expression s;
23 // These excluded functions must access c->maybe_tree direcly.
24 // Note that if c->maybe_tree is written somewhere outside of these
25 // functions, then the recommended transformation will be bogus with
26 -// get_commit_tree() on the LHS.
26 +// repo_get_commit_tree() on the LHS.
27 @@
28 -identifier f !~ "^(get_commit_tree|get_commit_tree_in_graph_one|load_tree_for_commit|set_commit_tree)$";
28 +identifier f !~ "^(repo_get_commit_tree|get_commit_tree_in_graph_one|load_tree_for_commit|set_commit_tree)$";
29 expression c;
30 @@
31 f(...) {<...
32 - c->maybe_tree
33 -+ get_commit_tree(c)
33 ++ repo_get_commit_tree(specify_the_right_repo_here, c)
34 ...>}