From: Jeff Hostetler <jeffh...@microsoft.com>
Create a filter for traverse_commit_list_worker() to only include
the blobs the would be referenced by a sparse-checkout using the
given specification.
Signed-off-by: Jeff Hostetler <jeffh...@microsoft.com>
---
Makefile | 1 +
list-objects-filter-sparse.c | 241 +++++++++++++++++++++++++++++++++++++++++++
list-objects-filter-sparse.h | 30 ++++++
3 files changed, 272 insertions(+)
create mode 100644 list-objects-filter-sparse.c
create mode 100644 list-objects-filter-sparse.h
diff --git a/Makefile b/Makefile
index 0fdeabb..fc82664 100644
--- a/Makefile
+++ b/Makefile
@@ -810,6 +810,7 @@ LIB_OBJS += list-objects.o
LIB_OBJS += list-objects-filter-blobs-limit.o
LIB_OBJS += list-objects-filter-blobs-none.o
LIB_OBJS += list-objects-filter-map.o
+LIB_OBJS += list-objects-filter-sparse.o
LIB_OBJS += ll-merge.o
LIB_OBJS += lockfile.o
LIB_OBJS += log-tree.o
diff --git a/list-objects-filter-sparse.c b/list-objects-filter-sparse.c
new file mode 100644
index 0000000..386b667
--- /dev/null
+++ b/list-objects-filter-sparse.c
@@ -0,0 +1,241 @@
+#include "cache.h"
+#include "dir.h"
+#include "tag.h"
+#include "commit.h"
+#include "tree.h"
+#include "blob.h"
+#include "diff.h"
+#include "tree-walk.h"
+#include "revision.h"
+#include "list-objects.h"
+#include "list-objects-filter-sparse.h"
+
+#define DEFAULT_MAP_SIZE (16*1024)
+
+/*
+ * A filter driven by a sparse-checkout specification to only
+ * include blobs that a sparse checkout would populate.
+ *
+ * The sparse-checkout spec can be loaded from a blob with the
+ * given OID or from a local pathname. We allow an OID because
+ * the repo may be bare or we may be doing the filtering on the
+ * server.
+ */
+struct frame {
+ int defval;
+ int child_prov_omit : 1;
+};
+
+struct filter_use_sparse_data {
+ struct oidmap *omits;
+ struct exclude_list el;
+
+ size_t nr, alloc;
+ struct frame *array_frame;
+};
+
+static list_objects_filter_result filter_use_sparse(
+ list_objects_filter_type filter_type,
+ struct object *obj,
+ const char *pathname,
+ const char *filename,
+ void *filter_data_)
+{
+ struct filter_use_sparse_data *filter_data = filter_data_;
+ struct list_objects_filter_map_entry *entry_prev = NULL;
+ int val, dtype;
+ struct frame *frame;
+
+ switch (filter_type) {
+ default:
+ die("unkown filter_type");
+ return LOFR_ZERO;
+
+ case LOFT_BEGIN_TREE:
+ assert(obj->type == OBJ_TREE);
+ dtype = DT_DIR;
+ val = is_excluded_from_list(pathname, strlen(pathname),
+ filename, &dtype, &filter_data->el,
+ &the_index);
+ if (val < 0)
+ val = filter_data->array_frame[filter_data->nr].defval;
+
+ ALLOC_GROW(filter_data->array_frame, filter_data->nr + 1,
+ filter_data->alloc);
+ filter_data->nr++;
+ filter_data->array_frame[filter_data->nr].defval = val;
+ filter_data->array_frame[filter_data->nr].child_prov_omit = 0;
+
+ /*
+ * A directory with this tree OID may appear in multiple
+ * places in the tree. (Think of a directory move, with
+ * no other changes.) And with a different pathname, the
+ * is_excluded...() results for this directory and items
+ * contained within it may be different. So we cannot
+ * mark it SEEN (yet), since that will prevent process_tree()
+ * from revisiting this tree object with other pathnames.
+ *
+ * Only SHOW the tree object the first time we visit this
+ * tree object.
+ *
+ * We always show all tree objects. A future optimization
+ * may want to attempt to narrow this.
+ */
+ if (obj->flags & FILTER_REVISIT)
+ return LOFR_ZERO;
+ obj->flags |= FILTER_REVISIT;
+ return LOFR_SHOW;
+
+ case LOFT_END_TREE:
+ assert(obj->type == OBJ_TREE);
+ assert(filter_data->nr > 0);
+
+ frame = &filter_data->array_frame[filter_data->nr];
+ filter_data->nr--;
+
+ /*
+ * Tell our parent directory if any of our children were
+ * provisionally omitted.
+ */
+ filter_data->array_frame[filter_data->nr].child_prov_omit |=
+ frame->child_prov_omit;
+
+ /*
+ * If there are NO provisionally omitted child objects (ALL
child
+ * objects in this folder were INCLUDED), then we can mark the
+ * folder as SEEN (so we will not have to revisit it again).
+ */
+ if (!frame->child_prov_omit)
+ return LOFR_MARK_SEEN;
+ return LOFR_ZERO;
+
+ case LOFT_BLOB:
+ assert(obj->type == OBJ_BLOB);
+ assert((obj->flags & SEEN) == 0);
+
+ frame = &filter_data->array_frame[filter_data->nr];
+
+ /*
+ * If we are keeping a list of the omitted objects
+ * for the caller *AND* we previsously provisionally
+ * omitted this object (because the THEN pathname
+ * is excluded) *AND* it has the same pathname, we
+ * can avoid duplicating the is_excluded lookup
+ * costs and continue provisionally omitting it.
+ */
+ if (filter_data->omits) {
+ entry_prev = oidmap_get(
+ filter_data->omits, &obj->oid);
+ if (entry_prev &&
+ !strcmp(pathname, entry_prev->pathname)) {
+ frame->child_prov_omit = 1;
+ return LOFR_ZERO;
+ }
+ }
+
+ dtype = DT_REG;
+ val = is_excluded_from_list(pathname, strlen(pathname),
+ filename, &dtype, &filter_data->el,
+ &the_index);
+ if (val < 0)
+ val = frame->defval;
+ if (val > 0) {
+ if (entry_prev) {
+ entry_prev = oidmap_remove(filter_data->omits,
+ &obj->oid);
+ free(entry_prev);
+ }
+ return LOFR_MARK_SEEN | LOFR_SHOW;
+ }
+
+ /*
+ * Provisionally omit it. We've already established that
+ * this pathname is not in the sparse-checkout specification
+ * with the CURRENT pathname, so we *WANT* to omit this blob.
+ *
+ * However, a pathname elsewhere in the tree may also
+ * reference this same blob, so we cannot reject it yet.
+ * Leave the LOFR_ bits unset so that if the blob appears
+ * again in the traversal, we will be asked again.
+ *
+ * The pathname that we associate with this omit is just
+ * the first one we saw for this blob. Other instances of
+ * this blob may have other pathnames and that is fine.
+ * We just use it for perf to do the entry_prev lookup
+ * above (because most of the time, the blob will be in
+ * the same place as we walk the commits).
+ */
+ if (filter_data->omits)
+ list_objects_filter_map_insert(filter_data->omits,
+ &obj->oid, pathname,
+ obj->type);
+
+ frame->child_prov_omit = 1;
+ return LOFR_ZERO;
+ }
+}
+
+static void do_sparse(
+ struct filter_use_sparse_data *d,
+ struct rev_info *revs,
+ show_commit_fn show_commit,
+ show_object_fn show_object,
+ list_objects_filter_map_foreach_cb print_omitted_object,
+ void *ctx_data)
+{
+ ALLOC_GROW(d->array_frame, d->nr + 1, d->alloc);
+ d->array_frame[d->nr].defval = 0; /* default to include */
+ d->array_frame[d->nr].child_prov_omit = 0;
+
+ traverse_commit_list_worker(revs, show_commit, show_object, ctx_data,
+ filter_use_sparse, d);
+
+ if (print_omitted_object) {
+ list_objects_filter_map_foreach(d->omits, print_omitted_object,
ctx_data);
+ oidmap_free(d->omits, 1);
+ }
+}
+
+void traverse_commit_list__sparse_oid(
+ struct rev_info *revs,
+ show_commit_fn show_commit,
+ show_object_fn show_object,
+ list_objects_filter_map_foreach_cb print_omitted_object,
+ void *ctx_data,
+ struct object_id *oid)
+{
+ struct filter_use_sparse_data d;
+
+ memset(&d, 0, sizeof(d));
+ if (print_omitted_object) {
+ d.omits = xcalloc(1, sizeof(*d.omits));
+ oidmap_init(d.omits, DEFAULT_MAP_SIZE);
+ }
+ if (add_excludes_from_blob_to_list(oid, NULL, 0, &d.el) < 0)
+ die("could not load filter specification");
+
+ do_sparse(&d, revs, show_commit, show_object, print_omitted_object,
+ ctx_data);
+}
+
+void traverse_commit_list__sparse_path(
+ struct rev_info *revs,
+ show_commit_fn show_commit,
+ show_object_fn show_object,
+ list_objects_filter_map_foreach_cb print_omitted_object,
+ void *ctx_data,
+ const char *path)
+{
+ struct filter_use_sparse_data d;
+
+ memset(&d, 0, sizeof(d));
+ if (print_omitted_object) {
+ d.omits = xcalloc(1, sizeof(*d.omits));
+ oidmap_init(d.omits, DEFAULT_MAP_SIZE);
+ }
+ if (add_excludes_from_file_to_list(path, NULL, 0, &d.el, NULL) < 0)
+ die("could not load filter specification");
+
+ do_sparse(&d, revs, show_commit, show_object, print_omitted_object,
+ ctx_data);
+}
diff --git a/list-objects-filter-sparse.h b/list-objects-filter-sparse.h
new file mode 100644
index 0000000..6c715bf
--- /dev/null
+++ b/list-objects-filter-sparse.h
@@ -0,0 +1,30 @@
+#ifndef LIST_OBJECTS_FILTERS_SPARSE_H
+#define LIST_OBJECTS_FILTERS_SPARSE_H
+
+#include "list-objects-filter-map.h"
+
+/*
+ * A filter driven by a sparse-checkout specification to only
+ * include blobs that a sparse checkout would populate.
+ *
+ * The sparse-checkout spec can be loaded from a blob with the
+ * given OID, a blob with a blob-ish path, or from a local pathname.
+ * We allow an OID because the repo may be bare or we may be doing
+ * the filtering on the server.
+ */
+void traverse_commit_list__sparse_oid(
+ struct rev_info *revs,
+ show_commit_fn show_commit,
+ show_object_fn show_object,
+ list_objects_filter_map_foreach_cb print_omitted_object,
+ void *ctx_data,
+ struct object_id *oid);
+void traverse_commit_list__sparse_path(
+ struct rev_info *revs,
+ show_commit_fn show_commit,
+ show_object_fn show_object,
+ list_objects_filter_map_foreach_cb print_omitted_object,
+ void *ctx_data,
+ const char *path);
+
+#endif /* LIST_OBJECTS_FILTERS_SPARSE_H */
--
2.9.3
