{fetch,upload}-pack: sideband v2 fetch response
[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(&entry, base, 0,
118                                                        &ctx->revs->diffopt.pathspec);
119                         if (match == all_entries_not_interesting)
120                                 break;
121                         if (match == entry_not_interesting)
122                                 continue;
123                 }
124
125                 if (S_ISDIR(entry.mode)) {
126                         struct tree *t = lookup_tree(ctx->revs->repo, entry.oid);
127                         t->object.flags |= NOT_USER_GIVEN;
128                         process_tree(ctx, t, base, entry.path);
129                 }
130                 else if (S_ISGITLINK(entry.mode))
131                         process_gitlink(ctx, entry.oid->hash,
132                                         base, entry.path);
133                 else {
134                         struct blob *b = lookup_blob(ctx->revs->repo, entry.oid);
135                         b->object.flags |= NOT_USER_GIVEN;
136                         process_blob(ctx, b, base, entry.path);
137                 }
138         }
139 }
140
141 static void process_tree(struct traversal_context *ctx,
142                          struct tree *tree,
143                          struct strbuf *base,
144                          const char *name)
145 {
146         struct object *obj = &tree->object;
147         struct rev_info *revs = ctx->revs;
148         int baselen = base->len;
149         enum list_objects_filter_result r = LOFR_MARK_SEEN | LOFR_DO_SHOW;
150         int failed_parse;
151
152         if (!revs->tree_objects)
153                 return;
154         if (!obj)
155                 die("bad tree object");
156         if (obj->flags & (UNINTERESTING | SEEN))
157                 return;
158
159         failed_parse = parse_tree_gently(tree, 1);
160         if (failed_parse) {
161                 if (revs->ignore_missing_links)
162                         return;
163
164                 /*
165                  * Pre-filter known-missing tree objects when explicitly
166                  * requested.  This may cause the actual filter to report
167                  * an incomplete list of missing objects.
168                  */
169                 if (revs->exclude_promisor_objects &&
170                     is_promisor_object(&obj->oid))
171                         return;
172
173                 if (!revs->do_not_die_on_missing_tree)
174                         die("bad tree object %s", oid_to_hex(&obj->oid));
175         }
176
177         strbuf_addstr(base, name);
178         if ((obj->flags & NOT_USER_GIVEN) && ctx->filter_fn)
179                 r = ctx->filter_fn(ctx->revs->repo,
180                                    LOFS_BEGIN_TREE, obj,
181                                    base->buf, &base->buf[baselen],
182                                    ctx->filter_data);
183         if (r & LOFR_MARK_SEEN)
184                 obj->flags |= SEEN;
185         if (r & LOFR_DO_SHOW)
186                 ctx->show_object(obj, base->buf, ctx->show_data);
187         if (base->len)
188                 strbuf_addch(base, '/');
189
190         if (r & LOFR_SKIP_TREE)
191                 trace_printf("Skipping contents of tree %s...\n", base->buf);
192         else if (!failed_parse)
193                 process_tree_contents(ctx, tree, base);
194
195         if ((obj->flags & NOT_USER_GIVEN) && ctx->filter_fn) {
196                 r = ctx->filter_fn(ctx->revs->repo,
197                                    LOFS_END_TREE, obj,
198                                    base->buf, &base->buf[baselen],
199                                    ctx->filter_data);
200                 if (r & LOFR_MARK_SEEN)
201                         obj->flags |= SEEN;
202                 if (r & LOFR_DO_SHOW)
203                         ctx->show_object(obj, base->buf, ctx->show_data);
204         }
205
206         strbuf_setlen(base, baselen);
207         free_tree_buffer(tree);
208 }
209
210 static void mark_edge_parents_uninteresting(struct commit *commit,
211                                             struct rev_info *revs,
212                                             show_edge_fn show_edge)
213 {
214         struct commit_list *parents;
215
216         for (parents = commit->parents; parents; parents = parents->next) {
217                 struct commit *parent = parents->item;
218                 if (!(parent->object.flags & UNINTERESTING))
219                         continue;
220                 mark_tree_uninteresting(revs->repo, get_commit_tree(parent));
221                 if (revs->edge_hint && !(parent->object.flags & SHOWN)) {
222                         parent->object.flags |= SHOWN;
223                         show_edge(parent);
224                 }
225         }
226 }
227
228 void mark_edges_uninteresting(struct rev_info *revs, show_edge_fn show_edge)
229 {
230         struct commit_list *list;
231         int i;
232
233         for (list = revs->commits; list; list = list->next) {
234                 struct commit *commit = list->item;
235
236                 if (commit->object.flags & UNINTERESTING) {
237                         mark_tree_uninteresting(revs->repo,
238                                                 get_commit_tree(commit));
239                         if (revs->edge_hint_aggressive && !(commit->object.flags & SHOWN)) {
240                                 commit->object.flags |= SHOWN;
241                                 show_edge(commit);
242                         }
243                         continue;
244                 }
245                 mark_edge_parents_uninteresting(commit, revs, show_edge);
246         }
247         if (revs->edge_hint_aggressive) {
248                 for (i = 0; i < revs->cmdline.nr; i++) {
249                         struct object *obj = revs->cmdline.rev[i].item;
250                         struct commit *commit = (struct commit *)obj;
251                         if (obj->type != OBJ_COMMIT || !(obj->flags & UNINTERESTING))
252                                 continue;
253                         mark_tree_uninteresting(revs->repo,
254                                                 get_commit_tree(commit));
255                         if (!(obj->flags & SHOWN)) {
256                                 obj->flags |= SHOWN;
257                                 show_edge(commit);
258                         }
259                 }
260         }
261 }
262
263 static void add_pending_tree(struct rev_info *revs, struct tree *tree)
264 {
265         add_pending_object(revs, &tree->object, "");
266 }
267
268 static void traverse_trees_and_blobs(struct traversal_context *ctx,
269                                      struct strbuf *base)
270 {
271         int i;
272
273         assert(base->len == 0);
274
275         for (i = 0; i < ctx->revs->pending.nr; i++) {
276                 struct object_array_entry *pending = ctx->revs->pending.objects + i;
277                 struct object *obj = pending->item;
278                 const char *name = pending->name;
279                 const char *path = pending->path;
280                 if (obj->flags & (UNINTERESTING | SEEN))
281                         continue;
282                 if (obj->type == OBJ_TAG) {
283                         obj->flags |= SEEN;
284                         ctx->show_object(obj, name, ctx->show_data);
285                         continue;
286                 }
287                 if (!path)
288                         path = "";
289                 if (obj->type == OBJ_TREE) {
290                         process_tree(ctx, (struct tree *)obj, base, path);
291                         continue;
292                 }
293                 if (obj->type == OBJ_BLOB) {
294                         process_blob(ctx, (struct blob *)obj, base, path);
295                         continue;
296                 }
297                 die("unknown pending object %s (%s)",
298                     oid_to_hex(&obj->oid), name);
299         }
300         object_array_clear(&ctx->revs->pending);
301 }
302
303 static void do_traverse(struct traversal_context *ctx)
304 {
305         struct commit *commit;
306         struct strbuf csp; /* callee's scratch pad */
307         strbuf_init(&csp, PATH_MAX);
308
309         while ((commit = get_revision(ctx->revs)) != NULL) {
310                 /*
311                  * an uninteresting boundary commit may not have its tree
312                  * parsed yet, but we are not going to show them anyway
313                  */
314                 if (get_commit_tree(commit)) {
315                         struct tree *tree = get_commit_tree(commit);
316                         tree->object.flags |= NOT_USER_GIVEN;
317                         add_pending_tree(ctx->revs, tree);
318                 }
319                 ctx->show_commit(commit, ctx->show_data);
320
321                 if (ctx->revs->tree_blobs_in_commit_order)
322                         /*
323                          * NEEDSWORK: Adding the tree and then flushing it here
324                          * needs a reallocation for each commit. Can we pass the
325                          * tree directory without allocation churn?
326                          */
327                         traverse_trees_and_blobs(ctx, &csp);
328         }
329         traverse_trees_and_blobs(ctx, &csp);
330         strbuf_release(&csp);
331 }
332
333 void traverse_commit_list(struct rev_info *revs,
334                           show_commit_fn show_commit,
335                           show_object_fn show_object,
336                           void *show_data)
337 {
338         struct traversal_context ctx;
339         ctx.revs = revs;
340         ctx.show_commit = show_commit;
341         ctx.show_object = show_object;
342         ctx.show_data = show_data;
343         ctx.filter_fn = NULL;
344         ctx.filter_data = NULL;
345         do_traverse(&ctx);
346 }
347
348 void traverse_commit_list_filtered(
349         struct list_objects_filter_options *filter_options,
350         struct rev_info *revs,
351         show_commit_fn show_commit,
352         show_object_fn show_object,
353         void *show_data,
354         struct oidset *omitted)
355 {
356         struct traversal_context ctx;
357         filter_free_fn filter_free_fn = NULL;
358
359         ctx.revs = revs;
360         ctx.show_object = show_object;
361         ctx.show_commit = show_commit;
362         ctx.show_data = show_data;
363         ctx.filter_fn = NULL;
364
365         ctx.filter_data = list_objects_filter__init(omitted, filter_options,
366                                                     &ctx.filter_fn, &filter_free_fn);
367         do_traverse(&ctx);
368         if (ctx.filter_data && filter_free_fn)
369                 filter_free_fn(ctx.filter_data);
370 }