am/cherry-pick/rebase/revert: document --rerere-autoupdate
[git] / list-objects.c
1 #include "cache.h"
2 #include "tag.h"
3 #include "commit.h"
4 #include "tree.h"
5 #include "blob.h"
6 #include "diff.h"
7 #include "tree-walk.h"
8 #include "revision.h"
9 #include "list-objects.h"
10 #include "list-objects-filter.h"
11 #include "list-objects-filter-options.h"
12 #include "packfile.h"
13 #include "object-store.h"
14 #include "trace.h"
15
16 struct traversal_context {
17         struct rev_info *revs;
18         show_object_fn show_object;
19         show_commit_fn show_commit;
20         void *show_data;
21         filter_object_fn filter_fn;
22         void *filter_data;
23 };
24
25 static void process_blob(struct traversal_context *ctx,
26                          struct blob *blob,
27                          struct strbuf *path,
28                          const char *name)
29 {
30         struct object *obj = &blob->object;
31         size_t pathlen;
32         enum list_objects_filter_result r = LOFR_MARK_SEEN | LOFR_DO_SHOW;
33
34         if (!ctx->revs->blob_objects)
35                 return;
36         if (!obj)
37                 die("bad blob object");
38         if (obj->flags & (UNINTERESTING | SEEN))
39                 return;
40
41         /*
42          * Pre-filter known-missing objects when explicitly requested.
43          * Otherwise, a missing object error message may be reported
44          * later (depending on other filtering criteria).
45          *
46          * Note that this "--exclude-promisor-objects" pre-filtering
47          * may cause the actual filter to report an incomplete list
48          * of missing objects.
49          */
50         if (ctx->revs->exclude_promisor_objects &&
51             !has_object_file(&obj->oid) &&
52             is_promisor_object(&obj->oid))
53                 return;
54
55         pathlen = path->len;
56         strbuf_addstr(path, name);
57         if ((obj->flags & NOT_USER_GIVEN) && ctx->filter_fn)
58                 r = ctx->filter_fn(ctx->revs->repo,
59                                    LOFS_BLOB, obj,
60                                    path->buf, &path->buf[pathlen],
61                                    ctx->filter_data);
62         if (r & LOFR_MARK_SEEN)
63                 obj->flags |= SEEN;
64         if (r & LOFR_DO_SHOW)
65                 ctx->show_object(obj, path->buf, ctx->show_data);
66         strbuf_setlen(path, pathlen);
67 }
68
69 /*
70  * Processing a gitlink entry currently does nothing, since
71  * we do not recurse into the subproject.
72  *
73  * We *could* eventually add a flag that actually does that,
74  * which would involve:
75  *  - is the subproject actually checked out?
76  *  - if so, see if the subproject has already been added
77  *    to the alternates list, and add it if not.
78  *  - process the commit (or tag) the gitlink points to
79  *    recursively.
80  *
81  * However, it's unclear whether there is really ever any
82  * reason to see superprojects and subprojects as such a
83  * "unified" object pool (potentially resulting in a totally
84  * humongous pack - avoiding which was the whole point of
85  * having gitlinks in the first place!).
86  *
87  * So for now, there is just a note that we *could* follow
88  * the link, and how to do it. Whether it necessarily makes
89  * any sense what-so-ever to ever do that is another issue.
90  */
91 static void process_gitlink(struct traversal_context *ctx,
92                             const unsigned char *sha1,
93                             struct strbuf *path,
94                             const char *name)
95 {
96         /* Nothing to do */
97 }
98
99 static void process_tree(struct traversal_context *ctx,
100                          struct tree *tree,
101                          struct strbuf *base,
102                          const char *name);
103
104 static void process_tree_contents(struct traversal_context *ctx,
105                                   struct tree *tree,
106                                   struct strbuf *base)
107 {
108         struct tree_desc desc;
109         struct name_entry entry;
110         enum interesting match = ctx->revs->diffopt.pathspec.nr == 0 ?
111                 all_entries_interesting : entry_not_interesting;
112
113         init_tree_desc(&desc, tree->buffer, tree->size);
114
115         while (tree_entry(&desc, &entry)) {
116                 if (match != all_entries_interesting) {
117                         match = tree_entry_interesting(ctx->revs->repo->index,
118                                                        &entry, base, 0,
119                                                        &ctx->revs->diffopt.pathspec);
120                         if (match == all_entries_not_interesting)
121                                 break;
122                         if (match == entry_not_interesting)
123                                 continue;
124                 }
125
126                 if (S_ISDIR(entry.mode)) {
127                         struct tree *t = lookup_tree(ctx->revs->repo, &entry.oid);
128                         t->object.flags |= NOT_USER_GIVEN;
129                         process_tree(ctx, t, base, entry.path);
130                 }
131                 else if (S_ISGITLINK(entry.mode))
132                         process_gitlink(ctx, entry.oid.hash,
133                                         base, entry.path);
134                 else {
135                         struct blob *b = lookup_blob(ctx->revs->repo, &entry.oid);
136                         b->object.flags |= NOT_USER_GIVEN;
137                         process_blob(ctx, b, base, entry.path);
138                 }
139         }
140 }
141
142 static void process_tree(struct traversal_context *ctx,
143                          struct tree *tree,
144                          struct strbuf *base,
145                          const char *name)
146 {
147         struct object *obj = &tree->object;
148         struct rev_info *revs = ctx->revs;
149         int baselen = base->len;
150         enum list_objects_filter_result r = LOFR_MARK_SEEN | LOFR_DO_SHOW;
151         int failed_parse;
152
153         if (!revs->tree_objects)
154                 return;
155         if (!obj)
156                 die("bad tree object");
157         if (obj->flags & (UNINTERESTING | SEEN))
158                 return;
159
160         failed_parse = parse_tree_gently(tree, 1);
161         if (failed_parse) {
162                 if (revs->ignore_missing_links)
163                         return;
164
165                 /*
166                  * Pre-filter known-missing tree objects when explicitly
167                  * requested.  This may cause the actual filter to report
168                  * an incomplete list of missing objects.
169                  */
170                 if (revs->exclude_promisor_objects &&
171                     is_promisor_object(&obj->oid))
172                         return;
173
174                 if (!revs->do_not_die_on_missing_tree)
175                         die("bad tree object %s", oid_to_hex(&obj->oid));
176         }
177
178         strbuf_addstr(base, name);
179         if ((obj->flags & NOT_USER_GIVEN) && ctx->filter_fn)
180                 r = ctx->filter_fn(ctx->revs->repo,
181                                    LOFS_BEGIN_TREE, obj,
182                                    base->buf, &base->buf[baselen],
183                                    ctx->filter_data);
184         if (r & LOFR_MARK_SEEN)
185                 obj->flags |= SEEN;
186         if (r & LOFR_DO_SHOW)
187                 ctx->show_object(obj, base->buf, ctx->show_data);
188         if (base->len)
189                 strbuf_addch(base, '/');
190
191         if (r & LOFR_SKIP_TREE)
192                 trace_printf("Skipping contents of tree %s...\n", base->buf);
193         else if (!failed_parse)
194                 process_tree_contents(ctx, tree, base);
195
196         if ((obj->flags & NOT_USER_GIVEN) && ctx->filter_fn) {
197                 r = ctx->filter_fn(ctx->revs->repo,
198                                    LOFS_END_TREE, obj,
199                                    base->buf, &base->buf[baselen],
200                                    ctx->filter_data);
201                 if (r & LOFR_MARK_SEEN)
202                         obj->flags |= SEEN;
203                 if (r & LOFR_DO_SHOW)
204                         ctx->show_object(obj, base->buf, ctx->show_data);
205         }
206
207         strbuf_setlen(base, baselen);
208         free_tree_buffer(tree);
209 }
210
211 static void mark_edge_parents_uninteresting(struct commit *commit,
212                                             struct rev_info *revs,
213                                             show_edge_fn show_edge)
214 {
215         struct commit_list *parents;
216
217         for (parents = commit->parents; parents; parents = parents->next) {
218                 struct commit *parent = parents->item;
219                 if (!(parent->object.flags & UNINTERESTING))
220                         continue;
221                 mark_tree_uninteresting(revs->repo, get_commit_tree(parent));
222                 if (revs->edge_hint && !(parent->object.flags & SHOWN)) {
223                         parent->object.flags |= SHOWN;
224                         show_edge(parent);
225                 }
226         }
227 }
228
229 static void add_edge_parents(struct commit *commit,
230                              struct rev_info *revs,
231                              show_edge_fn show_edge,
232                              struct oidset *set)
233 {
234         struct commit_list *parents;
235
236         for (parents = commit->parents; parents; parents = parents->next) {
237                 struct commit *parent = parents->item;
238                 struct tree *tree = get_commit_tree(parent);
239
240                 if (!tree)
241                         continue;
242
243                 oidset_insert(set, &tree->object.oid);
244
245                 if (!(parent->object.flags & UNINTERESTING))
246                         continue;
247                 tree->object.flags |= UNINTERESTING;
248
249                 if (revs->edge_hint && !(parent->object.flags & SHOWN)) {
250                         parent->object.flags |= SHOWN;
251                         show_edge(parent);
252                 }
253         }
254 }
255
256 void mark_edges_uninteresting(struct rev_info *revs,
257                               show_edge_fn show_edge,
258                               int sparse)
259 {
260         struct commit_list *list;
261         int i;
262
263         if (sparse) {
264                 struct oidset set;
265                 oidset_init(&set, 16);
266
267                 for (list = revs->commits; list; list = list->next) {
268                         struct commit *commit = list->item;
269                         struct tree *tree = get_commit_tree(commit);
270
271                         if (commit->object.flags & UNINTERESTING)
272                                 tree->object.flags |= UNINTERESTING;
273
274                         oidset_insert(&set, &tree->object.oid);
275                         add_edge_parents(commit, revs, show_edge, &set);
276                 }
277
278                 mark_trees_uninteresting_sparse(revs->repo, &set);
279                 oidset_clear(&set);
280         } else {
281                 for (list = revs->commits; list; list = list->next) {
282                         struct commit *commit = list->item;
283                         if (commit->object.flags & UNINTERESTING) {
284                                 mark_tree_uninteresting(revs->repo,
285                                                         get_commit_tree(commit));
286                                 if (revs->edge_hint_aggressive && !(commit->object.flags & SHOWN)) {
287                                         commit->object.flags |= SHOWN;
288                                         show_edge(commit);
289                                 }
290                                 continue;
291                         }
292                         mark_edge_parents_uninteresting(commit, revs, show_edge);
293                 }
294         }
295
296         if (revs->edge_hint_aggressive) {
297                 for (i = 0; i < revs->cmdline.nr; i++) {
298                         struct object *obj = revs->cmdline.rev[i].item;
299                         struct commit *commit = (struct commit *)obj;
300                         if (obj->type != OBJ_COMMIT || !(obj->flags & UNINTERESTING))
301                                 continue;
302                         mark_tree_uninteresting(revs->repo,
303                                                 get_commit_tree(commit));
304                         if (!(obj->flags & SHOWN)) {
305                                 obj->flags |= SHOWN;
306                                 show_edge(commit);
307                         }
308                 }
309         }
310 }
311
312 static void add_pending_tree(struct rev_info *revs, struct tree *tree)
313 {
314         add_pending_object(revs, &tree->object, "");
315 }
316
317 static void traverse_trees_and_blobs(struct traversal_context *ctx,
318                                      struct strbuf *base)
319 {
320         int i;
321
322         assert(base->len == 0);
323
324         for (i = 0; i < ctx->revs->pending.nr; i++) {
325                 struct object_array_entry *pending = ctx->revs->pending.objects + i;
326                 struct object *obj = pending->item;
327                 const char *name = pending->name;
328                 const char *path = pending->path;
329                 if (obj->flags & (UNINTERESTING | SEEN))
330                         continue;
331                 if (obj->type == OBJ_TAG) {
332                         obj->flags |= SEEN;
333                         ctx->show_object(obj, name, ctx->show_data);
334                         continue;
335                 }
336                 if (!path)
337                         path = "";
338                 if (obj->type == OBJ_TREE) {
339                         process_tree(ctx, (struct tree *)obj, base, path);
340                         continue;
341                 }
342                 if (obj->type == OBJ_BLOB) {
343                         process_blob(ctx, (struct blob *)obj, base, path);
344                         continue;
345                 }
346                 die("unknown pending object %s (%s)",
347                     oid_to_hex(&obj->oid), name);
348         }
349         object_array_clear(&ctx->revs->pending);
350 }
351
352 static void do_traverse(struct traversal_context *ctx)
353 {
354         struct commit *commit;
355         struct strbuf csp; /* callee's scratch pad */
356         strbuf_init(&csp, PATH_MAX);
357
358         while ((commit = get_revision(ctx->revs)) != NULL) {
359                 /*
360                  * an uninteresting boundary commit may not have its tree
361                  * parsed yet, but we are not going to show them anyway
362                  */
363                 if (get_commit_tree(commit)) {
364                         struct tree *tree = get_commit_tree(commit);
365                         tree->object.flags |= NOT_USER_GIVEN;
366                         add_pending_tree(ctx->revs, tree);
367                 }
368                 ctx->show_commit(commit, ctx->show_data);
369
370                 if (ctx->revs->tree_blobs_in_commit_order)
371                         /*
372                          * NEEDSWORK: Adding the tree and then flushing it here
373                          * needs a reallocation for each commit. Can we pass the
374                          * tree directory without allocation churn?
375                          */
376                         traverse_trees_and_blobs(ctx, &csp);
377         }
378         traverse_trees_and_blobs(ctx, &csp);
379         strbuf_release(&csp);
380 }
381
382 void traverse_commit_list(struct rev_info *revs,
383                           show_commit_fn show_commit,
384                           show_object_fn show_object,
385                           void *show_data)
386 {
387         struct traversal_context ctx;
388         ctx.revs = revs;
389         ctx.show_commit = show_commit;
390         ctx.show_object = show_object;
391         ctx.show_data = show_data;
392         ctx.filter_fn = NULL;
393         ctx.filter_data = NULL;
394         do_traverse(&ctx);
395 }
396
397 void traverse_commit_list_filtered(
398         struct list_objects_filter_options *filter_options,
399         struct rev_info *revs,
400         show_commit_fn show_commit,
401         show_object_fn show_object,
402         void *show_data,
403         struct oidset *omitted)
404 {
405         struct traversal_context ctx;
406         filter_free_fn filter_free_fn = NULL;
407
408         ctx.revs = revs;
409         ctx.show_object = show_object;
410         ctx.show_commit = show_commit;
411         ctx.show_data = show_data;
412         ctx.filter_fn = NULL;
413
414         ctx.filter_data = list_objects_filter__init(omitted, filter_options,
415                                                     &ctx.filter_fn, &filter_free_fn);
416         do_traverse(&ctx);
417         if (ctx.filter_data && filter_free_fn)
418                 filter_free_fn(ctx.filter_data);
419 }