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