From patchwork Sat Nov 9 19:41:07 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Derrick Stolee X-Patchwork-Id: 13869705 Received: from mail-wm1-f52.google.com (mail-wm1-f52.google.com [209.85.128.52]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 1C28F19D08A for ; Sat, 9 Nov 2024 19:41:18 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.52 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731181281; cv=none; b=RDzeY0AlJZuU/wI6Gh2uETaxL1lQ9ZLMQUd63+4gMtGqjipHvWsCKWX5JFarIvJoSc+K8Fyv5lesy+9tS/uNFKR8+d7h+aJf6UJZnYjmyvex3BI/YH5f3bk72tmcVUV/65DGd/U2sXRL0YXrR75RPTe1RRwEI+kTxMDr21fiCPI= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731181281; c=relaxed/simple; bh=mWCDxlnP4EA2cwrSuexeAkVHBa3RaAcqfYITfHPTG08=; h=Message-Id:In-Reply-To:References:From:Date:Subject:Content-Type: MIME-Version:To:Cc; b=Eqn7BHsY3fB6ERUnzCSgZkBH0OyTvAW9tddYxibfCpi0yb0Q6vKeRnB5DOiwKDYTrwTg9IF+jviJKpANmQ3zEbZ+jn4lAdqBmPt7nitzquKnYE7cGsWgfqKgRVre3BzCVnq5VEpO53Thr4bgC7Hyykb50M6fg+zz1fr0T2FSiTs= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=YmImmR5i; arc=none smtp.client-ip=209.85.128.52 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="YmImmR5i" Received: by mail-wm1-f52.google.com with SMTP id 5b1f17b1804b1-43167ff0f91so28540155e9.1 for ; Sat, 09 Nov 2024 11:41:18 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1731181276; x=1731786076; darn=vger.kernel.org; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=RqI0dMIvJko0v5Cd1bI1d5v5tx3+K8n6axocKDPWY+Q=; b=YmImmR5iP2o/cObDJ9YbjI6j7V9xTtG9ANUQE/K8xJkjuLhzfloUV2yEgqZAZI+w6N tZePXnO29l0ig8DBJyVnR00ebl5hBOlPc4NchRGOlFd+66DJodPa1JOUE48lPciLqSR/ G2URLJL1f793oKzcLmI4Nt+rVJ6exPg1Zxrsu/4eMRDQPGYIKqBj/MtoPY1sGhIdJ6FD Dwnoj8QzbCKZh/GvVA/yfLuHaEEHbTt31ai08jchQAqMsr6KmTcH99/NDyM4LPRT39km UW0l9kZ/fYX8C1ySiNiGkztK0iiFfNftEWhEDzPdO2aYQFBSmHSr151SnddH85QPViqk IlEg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1731181276; x=1731786076; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=RqI0dMIvJko0v5Cd1bI1d5v5tx3+K8n6axocKDPWY+Q=; b=VeHJw6g1V8YW5270WKC+J92kHsvNYI0oje4tu01zHqRCTA4oP3HCao6m7OhxhpEeUw vYz9svOKV0P9j+KN/pDCLXo61nj8QrltuTwemnGU4eD8XH6vyw4R6rhwzSSn/AQpn+eM Zsn4ExA/5c55sA07ireYW3wVsjA4ZWhXmaCjcC5VLVhMgG5OHXNzkJQCwZqC93ZlSyr0 hnGwbC73ukC9jsHu9gsoy1ckIzW+UKWMpseyHYRT/yPybAEJWx1Vfyqpc9wH7oOtooQ8 o48BpPhl+khUyNzbtompGYvQ/Gn41NSs8/MFz6dR8jHrSx6hj22kv8OUsxKr68Yn0OLZ ZYYA== X-Gm-Message-State: AOJu0Yx2J//MEMCI8WsVRxPzkysZZAGaeH2dCRzj3a2ziQuFvy1d3NVr heBpsne0GN1rN5ewEuCdEh87LCMgv4VI21L5Z5sbNJDltVSKLl08WtyNHg== X-Google-Smtp-Source: AGHT+IGR6mq47HOr8Ml+8WO27V8XMmU2iYg9dSwnvAc2sD8QxpNmf6HJsfTc/+7YCIcAIGqHy3WcxA== X-Received: by 2002:a05:600c:1909:b0:431:58bc:ad5e with SMTP id 5b1f17b1804b1-432b7522abemr57263625e9.28.1731181275948; Sat, 09 Nov 2024 11:41:15 -0800 (PST) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-432b054b34csm118331825e9.14.2024.11.09.11.41.15 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 09 Nov 2024 11:41:15 -0800 (PST) Message-Id: In-Reply-To: References: Date: Sat, 09 Nov 2024 19:41:07 +0000 Subject: [PATCH v2 1/6] path-walk: introduce an object walk by path Fcc: Sent Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 To: git@vger.kernel.org Cc: gitster@pobox.com, johannes.schindelin@gmx.de, peff@peff.net, ps@pks.im, me@ttaylorr.com, johncai86@gmail.com, newren@gmail.com, christian.couder@gmail.com, kristofferhaugsbakk@fastmail.com, jonathantanmy@google.com, karthik nayak , Derrick Stolee , Derrick Stolee From: Derrick Stolee From: Derrick Stolee In anticipation of a few planned applications, introduce the most basic form of a path-walk API. It currently assumes that there are no UNINTERESTING objects, and does not include any complicated filters. It calls a function pointer on groups of tree and blob objects as grouped by path. This only includes objects the first time they are discovered, so an object that appears at multiple paths will not be included in two batches. These batches are collected in 'struct type_and_oid_list' objects, which store an object type and an oid_array of objects. The data structures are documented in 'struct path_walk_context', but in summary the most important are: * 'paths_to_lists' is a strmap that connects a path to a type_and_oid_list for that path. To avoid conflicts in path names, we make sure that tree paths end in "/" (except the root path with is an empty string) and blob paths do not end in "/". * 'path_stack' is a string list that is added to in an append-only way. This stores the stack of our depth-first search on the heap instead of using recursion. * 'path_stack_pushed' is a strmap that stores path names that were already added to 'path_stack', to avoid repeating paths in the stack. Mostly, this saves us from quadratic lookups from doing unsorted checks into the string_list. The coupling of 'path_stack' and 'path_stack_pushed' is protected by the push_to_stack() method. Call this instead of inserting into these structures directly. The walk_objects_by_path() method initializes these structures and starts walking commits from the given rev_info struct. The commits are used to find the list of root trees which populate the start of our depth-first search. The core of our depth-first search is in a while loop that continues while we have not indicated an early exit and our 'path_stack' still has entries in it. The loop body pops a path off of the stack and "visits" the path via the walk_path() method. The walk_path() method gets the list of OIDs from the 'path_to_lists' strmap and executes the callback method on that list with the given path and type. If the OIDs correspond to tree objects, then iterate over all trees in the list and run add_children() to add the child objects to their own lists, adding new entries to the stack if necessary. In testing, this depth-first search approach was the one that used the least memory while iterating over the object lists. There is still a chance that repositories with too-wide path patterns could cause memory pressure issues. Limiting the stack size could be done in the future by limiting how many objects are being considered in-progress, or by visiting blob paths earlier than trees. There are many future adaptations that could be made, but they are left for future updates when consumers are ready to take advantage of those features. Signed-off-by: Derrick Stolee --- Documentation/technical/api-path-walk.txt | 45 ++++ Makefile | 1 + path-walk.c | 263 ++++++++++++++++++++++ path-walk.h | 43 ++++ 4 files changed, 352 insertions(+) create mode 100644 Documentation/technical/api-path-walk.txt create mode 100644 path-walk.c create mode 100644 path-walk.h diff --git a/Documentation/technical/api-path-walk.txt b/Documentation/technical/api-path-walk.txt new file mode 100644 index 00000000000..c550c77ca30 --- /dev/null +++ b/Documentation/technical/api-path-walk.txt @@ -0,0 +1,45 @@ +Path-Walk API +============= + +The path-walk API is used to walk reachable objects, but to visit objects +in batches based on a common path they appear in, or by type. + +For example, all reachable commits are visited in a group. All tags are +visited in a group. Then, all root trees are visited. At some point, all +blobs reachable via a path `my/dir/to/A` are visited. When there are +multiple paths possible to reach the same object, then only one of those +paths is used to visit the object. + +Basics +------ + +To use the path-walk API, include `path-walk.h` and call +`walk_objects_by_path()` with a customized `path_walk_info` struct. The +struct is used to set all of the options for how the walk should proceed. +Let's dig into the different options and their use. + +`path_fn` and `path_fn_data`:: + The most important option is the `path_fn` option, which is a + function pointer to the callback that can execute logic on the + object IDs for objects grouped by type and path. This function + also receives a `data` value that corresponds to the + `path_fn_data` member, for providing custom data structures to + this callback function. + +`revs`:: + To configure the exact details of the reachable set of objects, + use the `revs` member and initialize it using the revision + machinery in `revision.h`. Initialize `revs` using calls such as + `setup_revisions()` or `parse_revision_opt()`. Do not call + `prepare_revision_walk()`, as that will be called within + `walk_objects_by_path()`. ++ +It is also important that you do not specify the `--objects` flag for the +`revs` struct. The revision walk should only be used to walk commits, and +the objects will be walked in a separate way based on those starting +commits. + +Examples +-------- + +See example usages in future changes. diff --git a/Makefile b/Makefile index 7344a7f7257..d0d8d6888e3 100644 --- a/Makefile +++ b/Makefile @@ -1094,6 +1094,7 @@ LIB_OBJS += parse-options.o LIB_OBJS += patch-delta.o LIB_OBJS += patch-ids.o LIB_OBJS += path.o +LIB_OBJS += path-walk.o LIB_OBJS += pathspec.o LIB_OBJS += pkt-line.o LIB_OBJS += preload-index.o diff --git a/path-walk.c b/path-walk.c new file mode 100644 index 00000000000..24cf04c1e7d --- /dev/null +++ b/path-walk.c @@ -0,0 +1,263 @@ +/* + * path-walk.c: implementation for path-based walks of the object graph. + */ +#include "git-compat-util.h" +#include "path-walk.h" +#include "blob.h" +#include "commit.h" +#include "dir.h" +#include "hashmap.h" +#include "hex.h" +#include "object.h" +#include "oid-array.h" +#include "revision.h" +#include "string-list.h" +#include "strmap.h" +#include "trace2.h" +#include "tree.h" +#include "tree-walk.h" + +struct type_and_oid_list +{ + enum object_type type; + struct oid_array oids; +}; + +#define TYPE_AND_OID_LIST_INIT { \ + .type = OBJ_NONE, \ + .oids = OID_ARRAY_INIT \ +} + +struct path_walk_context { + /** + * Repeats of data in 'struct path_walk_info' for + * access with fewer characters. + */ + struct repository *repo; + struct rev_info *revs; + struct path_walk_info *info; + + /** + * Map a path to a 'struct type_and_oid_list' + * containing the objects discovered at that + * path. + */ + struct strmap paths_to_lists; + + /** + * Store the current list of paths in a stack, to + * facilitate depth-first-search without recursion. + * + * Use path_stack_pushed to indicate whether a path + * was previously added to path_stack. + */ + struct string_list path_stack; + struct strset path_stack_pushed; +}; + +static void push_to_stack(struct path_walk_context *ctx, + const char *path) +{ + if (strset_contains(&ctx->path_stack_pushed, path)) + return; + + strset_add(&ctx->path_stack_pushed, path); + string_list_append(&ctx->path_stack, path); +} + +static int add_children(struct path_walk_context *ctx, + const char *base_path, + struct object_id *oid) +{ + struct tree_desc desc; + struct name_entry entry; + struct strbuf path = STRBUF_INIT; + size_t base_len; + struct tree *tree = lookup_tree(ctx->repo, oid); + + if (!tree) { + error(_("failed to walk children of tree %s: not found"), + oid_to_hex(oid)); + return -1; + } else if (parse_tree_gently(tree, 1)) { + die("bad tree object %s", oid_to_hex(oid)); + } + + strbuf_addstr(&path, base_path); + base_len = path.len; + + parse_tree(tree); + init_tree_desc(&desc, &tree->object.oid, tree->buffer, tree->size); + while (tree_entry(&desc, &entry)) { + struct type_and_oid_list *list; + struct object *o; + /* Not actually true, but we will ignore submodules later. */ + enum object_type type = S_ISDIR(entry.mode) ? OBJ_TREE : OBJ_BLOB; + + /* Skip submodules. */ + if (S_ISGITLINK(entry.mode)) + continue; + + if (type == OBJ_TREE) { + struct tree *child = lookup_tree(ctx->repo, &entry.oid); + o = child ? &child->object : NULL; + } else if (type == OBJ_BLOB) { + struct blob *child = lookup_blob(ctx->repo, &entry.oid); + o = child ? &child->object : NULL; + } else { + /* Wrong type? */ + continue; + } + + if (!o) /* report error?*/ + continue; + + strbuf_setlen(&path, base_len); + strbuf_add(&path, entry.path, entry.pathlen); + + /* + * Trees will end with "/" for concatenation and distinction + * from blobs at the same path. + */ + if (type == OBJ_TREE) + strbuf_addch(&path, '/'); + + if (!(list = strmap_get(&ctx->paths_to_lists, path.buf))) { + CALLOC_ARRAY(list, 1); + list->type = type; + strmap_put(&ctx->paths_to_lists, path.buf, list); + } + push_to_stack(ctx, path.buf); + + /* Skip this object if already seen. */ + if (o->flags & SEEN) + continue; + o->flags |= SEEN; + oid_array_append(&list->oids, &entry.oid); + } + + free_tree_buffer(tree); + strbuf_release(&path); + return 0; +} + +/* + * For each path in paths_to_explore, walk the trees another level + * and add any found blobs to the batch (but only if they exist and + * haven't been added yet). + */ +static int walk_path(struct path_walk_context *ctx, + const char *path) +{ + struct type_and_oid_list *list; + int ret = 0; + + list = strmap_get(&ctx->paths_to_lists, path); + + if (!list->oids.nr) + return 0; + + /* Evaluate function pointer on this data. */ + ret = ctx->info->path_fn(path, &list->oids, list->type, + ctx->info->path_fn_data); + + /* Expand data for children. */ + if (list->type == OBJ_TREE) { + for (size_t i = 0; i < list->oids.nr; i++) { + ret |= add_children(ctx, + path, + &list->oids.oid[i]); + } + } + + oid_array_clear(&list->oids); + strmap_remove(&ctx->paths_to_lists, path, 1); + return ret; +} + +static void clear_strmap(struct strmap *map) +{ + struct hashmap_iter iter; + struct strmap_entry *e; + + hashmap_for_each_entry(&map->map, &iter, e, ent) { + struct type_and_oid_list *list = e->value; + oid_array_clear(&list->oids); + } + strmap_clear(map, 1); + strmap_init(map); +} + +/** + * Given the configuration of 'info', walk the commits based on 'info->revs' and + * call 'info->path_fn' on each discovered path. + * + * Returns nonzero on an error. + */ +int walk_objects_by_path(struct path_walk_info *info) +{ + const char *root_path = ""; + int ret = 0; + size_t commits_nr = 0, paths_nr = 0; + struct commit *c; + struct type_and_oid_list *root_tree_list; + struct path_walk_context ctx = { + .repo = info->revs->repo, + .revs = info->revs, + .info = info, + .path_stack = STRING_LIST_INIT_DUP, + .path_stack_pushed = STRSET_INIT, + .paths_to_lists = STRMAP_INIT + }; + + trace2_region_enter("path-walk", "commit-walk", info->revs->repo); + + /* Insert a single list for the root tree into the paths. */ + CALLOC_ARRAY(root_tree_list, 1); + root_tree_list->type = OBJ_TREE; + strmap_put(&ctx.paths_to_lists, root_path, root_tree_list); + push_to_stack(&ctx, root_path); + + if (prepare_revision_walk(info->revs)) + die(_("failed to setup revision walk")); + + while ((c = get_revision(info->revs))) { + struct object_id *oid = get_commit_tree_oid(c); + struct tree *t; + commits_nr++; + + oid = get_commit_tree_oid(c); + t = lookup_tree(info->revs->repo, oid); + + if (!t) { + warning("could not find tree %s", oid_to_hex(oid)); + continue; + } + + if (t->object.flags & SEEN) + continue; + t->object.flags |= SEEN; + oid_array_append(&root_tree_list->oids, oid); + } + + trace2_data_intmax("path-walk", ctx.repo, "commits", commits_nr); + trace2_region_leave("path-walk", "commit-walk", info->revs->repo); + + trace2_region_enter("path-walk", "path-walk", info->revs->repo); + while (!ret && ctx.path_stack.nr) { + char *path = ctx.path_stack.items[ctx.path_stack.nr - 1].string; + ctx.path_stack.nr--; + paths_nr++; + + ret = walk_path(&ctx, path); + + free(path); + } + trace2_data_intmax("path-walk", ctx.repo, "paths", paths_nr); + trace2_region_leave("path-walk", "path-walk", info->revs->repo); + + clear_strmap(&ctx.paths_to_lists); + strset_clear(&ctx.path_stack_pushed); + string_list_clear(&ctx.path_stack, 0); + return ret; +} diff --git a/path-walk.h b/path-walk.h new file mode 100644 index 00000000000..c9e94a98bc8 --- /dev/null +++ b/path-walk.h @@ -0,0 +1,43 @@ +/* + * path-walk.h : Methods and structures for walking the object graph in batches + * by the paths that can reach those objects. + */ +#include "object.h" /* Required for 'enum object_type'. */ + +struct rev_info; +struct oid_array; + +/** + * The type of a function pointer for the method that is called on a list of + * objects reachable at a given path. + */ +typedef int (*path_fn)(const char *path, + struct oid_array *oids, + enum object_type type, + void *data); + +struct path_walk_info { + /** + * revs provides the definitions for the commit walk, including + * which commits are UNINTERESTING or not. + */ + struct rev_info *revs; + + /** + * The caller wishes to execute custom logic on objects reachable at a + * given path. Every reachable object will be visited exactly once, and + * the first path to see an object wins. This may not be a stable choice. + */ + path_fn path_fn; + void *path_fn_data; +}; + +#define PATH_WALK_INFO_INIT { 0 } + +/** + * Given the configuration of 'info', walk the commits based on 'info->revs' and + * call 'info->path_fn' on each discovered path. + * + * Returns nonzero on an error. + */ +int walk_objects_by_path(struct path_walk_info *info); From patchwork Sat Nov 9 19:41:08 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Derrick Stolee X-Patchwork-Id: 13869706 Received: from mail-wr1-f49.google.com (mail-wr1-f49.google.com [209.85.221.49]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 68E9119F115 for ; Sat, 9 Nov 2024 19:41:19 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.221.49 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731181282; cv=none; b=sQcRFpI7Dd9fgRQEep3XdvCq3HbgF3q4kolrf7/NhtyyYonpq8li7u2wpi1YnER4V0Itbsh8PKDYn+k8M/9qbb3E7FDDhIJy4m0+T5S7N0R5KGg4Ov/lhhbLp/KdCET7/e0gXMckxHiYuTpRKypeFPUMPduVkSTrrTVNAWEMAb4= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731181282; c=relaxed/simple; bh=PMdw0FTFVG2iUoZMyeWr7FZupnaMUztTqBtsfXjAVNQ=; h=Message-Id:In-Reply-To:References:From:Date:Subject:Content-Type: MIME-Version:To:Cc; b=TzKxi5IDQZ/ucU3Pn+OSZ2FGEpzgb/B1OaQu4w5VCKsQthaB0GlKxWNLgjRUGkg/ZOYijjSHIOPKBeqziZjCncvmsVBr5x2P2FZEeOBs4YzhfmdrbFMcubBUTYpSXE3x5iRTXx/W6dUEZfQ65oFDcSU8nNE4iH1hJ1m7lVcvpwk= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=J2YWlOJ4; arc=none smtp.client-ip=209.85.221.49 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="J2YWlOJ4" Received: by mail-wr1-f49.google.com with SMTP id ffacd0b85a97d-37d808ae924so1982268f8f.0 for ; Sat, 09 Nov 2024 11:41:19 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1731181277; x=1731786077; darn=vger.kernel.org; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=/dK2I2TXW5iAu4adBn9RAI0BX8gzXE/7TFrMGsUREmg=; b=J2YWlOJ4Pvrk3jkTGT99L4iC1v1ta+vinQ9NJ7aAnMfTciFBm2qTjCfrWXoVwQzjEV p8efA+2NKhSPdykwYKfAP4WRfB36a9cb1F6+Oo28LboLoi/2jS9x3KOtE8dT6v3/Bmj3 k3Im3461VVltneAcNRVGFzQluKQykuwUSumSbbAIuavLOR9rVBU2W+jdWIB27mRep+jb OukPk8GxNNbs3V1HxQ1vGRctqnXVz0HOvQUiSKx9MZXkK0i56ymWveqCIlf2DNJWO/xh MRfaxkSNZdS88gyLbRbRqpnxmE63KNO9hbV8tEP0zohGtlVIiutqPufI9wVpBss3gkrM 04VQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1731181277; x=1731786077; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=/dK2I2TXW5iAu4adBn9RAI0BX8gzXE/7TFrMGsUREmg=; b=eOdoCYUwT37e0a83XWjpGK3+WuiF/1PUMyBprVq0xg1JXACJymJl6D/Ctt5yec79sU 7+QbhVVLZa4VqK9rrSLUjOPmMFCchjeWX+YhdLdtEKQpoLseJxdTn/YPe3uX93Zgu8MR iyGRuPghMVfKsYx1m5s67vFapFy8smlWAo+bKWy+vpvbIHr1V1V49Fw1YpH9UclVJ3Xl kkcy0se9GKjd/NA3LU7I+/S2p9yO+lGg6T3OwQYYktT9dCg0vrUt4txaBA7Q+3BXRa6/ VBomMcwKz4jDZxhvxn41HSLeY9V4jjVDR7MFHzcYZO0czBq/gHGwSm0f4nUsLjZxVViM OIsQ== X-Gm-Message-State: AOJu0YwMOIX+tDvI1C6gBIFPyChxrbWBD8RSn30E1+IvfShHptGHPRMM ByLUSBztlfOeaoGCMK0GVOePZlnv0bKuqERcfjOZLxVWt2bArlUVWMmfFw== X-Google-Smtp-Source: AGHT+IFUmd2tM7afTxwc+fvetV5d/L8JF/P3ZE2koDaAJIGu9QDdc6jcKMDgbEZ5T/PVFC4IS8r2HQ== X-Received: by 2002:a05:6000:1f8f:b0:37d:52b5:451e with SMTP id ffacd0b85a97d-381f186fc20mr6347171f8f.33.1731181276760; Sat, 09 Nov 2024 11:41:16 -0800 (PST) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-381ed9f8f0asm8723135f8f.79.2024.11.09.11.41.16 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 09 Nov 2024 11:41:16 -0800 (PST) Message-Id: In-Reply-To: References: Date: Sat, 09 Nov 2024 19:41:08 +0000 Subject: [PATCH v2 2/6] test-lib-functions: add test_cmp_sorted Fcc: Sent Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 To: git@vger.kernel.org Cc: gitster@pobox.com, johannes.schindelin@gmx.de, peff@peff.net, ps@pks.im, me@ttaylorr.com, johncai86@gmail.com, newren@gmail.com, christian.couder@gmail.com, kristofferhaugsbakk@fastmail.com, jonathantanmy@google.com, karthik nayak , Derrick Stolee , Derrick Stolee From: Derrick Stolee From: Derrick Stolee This test helper will be helpful to reduce repeated logic in t6601-path-walk.sh, but may be helpful elsewhere, too. Signed-off-by: Derrick Stolee --- t/test-lib-functions.sh | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/t/test-lib-functions.sh b/t/test-lib-functions.sh index fde9bf54fc3..16b70aebd60 100644 --- a/t/test-lib-functions.sh +++ b/t/test-lib-functions.sh @@ -1267,6 +1267,16 @@ test_cmp () { eval "$GIT_TEST_CMP" '"$@"' } +# test_cmp_sorted runs test_cmp on sorted versions of the two +# input files. Uses "$1.sorted" and "$2.sorted" as temp files. + +test_cmp_sorted () { + sort <"$1" >"$1.sorted" && + sort <"$2" >"$2.sorted" && + test_cmp "$1.sorted" "$2.sorted" && + rm "$1.sorted" "$2.sorted" +} + # Check that the given config key has the expected value. # # test_cmp_config [-C ] From patchwork Sat Nov 9 19:41:09 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Derrick Stolee X-Patchwork-Id: 13869707 Received: from mail-wm1-f44.google.com (mail-wm1-f44.google.com [209.85.128.44]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id DECE919F42D for ; Sat, 9 Nov 2024 19:41:20 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.44 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731181282; cv=none; b=X12w3OuzHXy3xpDxwwkIVj9qzrwym1u6Ch/PbWkDg+cj/GXRURSMRPkaUCszLMpF/O2U2BHQQgzQeGShxpTH8/U3XGP0WV0aGdx9HsqBTooE45gdoba+wE3tz3Jw1wnqZ9oJNoCDeRAR4lhr9KboZyRcHH+nzyCIYrlzBRA2cJI= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731181282; c=relaxed/simple; bh=ksri1waB8msAZNJ7PyAU6eXMnMt/53jnzU91S+ZCy/s=; h=Message-Id:In-Reply-To:References:From:Date:Subject:Content-Type: MIME-Version:To:Cc; b=mp4Sx/eB3GfkgZJeOCuycn4dK6Z3TkhnJ/C81hN1hLd1cgIz967onQ5Gf14mVAhBHoXYJRfVvP4yjBXF6ZHU9RTgy8CGDWVbJpE4FXssCzl5KY6gPoN4yIUjDR2vYihj1PGGCXnXupoceyXfJl0DttNqorVAJjghoDekKUfuBC8= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=CIzUVyF/; arc=none smtp.client-ip=209.85.128.44 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="CIzUVyF/" Received: by mail-wm1-f44.google.com with SMTP id 5b1f17b1804b1-4315e62afe0so30706285e9.1 for ; Sat, 09 Nov 2024 11:41:20 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1731181279; x=1731786079; darn=vger.kernel.org; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=hlkg3gPgxdWk/eRaM0IJ1iIi228RquXppMhVxQOldzQ=; b=CIzUVyF/l/QFG/dwNs7+PYPRop+QFKYLfawzVE36YYoYXOVYxp0KUXQ/fJVKQ9aGAs GJh+i+XbYF6DQnV+DXXSnT33h4E4pbTGZut/u4Bc1IkFZFa6naywCFpnXG/MIyV45I/F pIl5CfxVzjihZfsEkT6KRI5JWigVrMkNi7yldO+/dbdYgZMTDqluQTFLM9qbAlm35xaV MN2twI/JBFzj49y4pFCbaD+d6B9l+lki6qnG7ll7Yn8Vpc6yWr/+EZN1REmipsbKYiwG J6OkEdpwFJXV3aC0oZx8vufo3WzzHax5vxybCpg97ddMLcLx0b8q3vZfSdqCKJ+WzEQX B81Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1731181279; x=1731786079; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=hlkg3gPgxdWk/eRaM0IJ1iIi228RquXppMhVxQOldzQ=; b=BKxFz5CQancxm8I8QJRS7JqVfyyKL5oxOtjIU3U2vD8u1O109AHBvAF33xcCpra8u2 rh+hqRNTn0DDnnqJse6B8L9zIzFDaNocffXC+KNs2z1NuZUb7wjkYFOISDbBXvCJtzQy FXTtFdlcM3amW3uCe7tlppHIxOdRGya4ILW0ur2lVDlQFvHRjPdr/43luf2SzHNZkign uV7JTtntWza3p/D/lw+9A+kGaf643PTRslbnJPoLaThK516LfSpA3elzgffrCwsXtaMB E1a6IdK9a3mZ1KTMbmC5sJB7KpCMNpYQdQNo6uPeJlCwDPbMBqW9gx0wjSjPDO58ThrV da2A== X-Gm-Message-State: AOJu0YyyGOEI16jJlTfYjSZb3I91RN8uKbL4s9MsErBWAmoaQjZAii2a ah5DCJuCULvS36gzYPEFIUbj/G+1Mg/ohGAOabbrpQ83wJn8PJAMCdNntA== X-Google-Smtp-Source: AGHT+IHJ/HgqB+IzBGSOuN1EeIT8Tw/PTtCXxrem1GKG0WSpXV/CAOeAW8GlBNCDWRSuqzGe2Th6lQ== X-Received: by 2002:a05:600c:501e:b0:430:52ec:1e2b with SMTP id 5b1f17b1804b1-432b751c1d8mr63745745e9.29.1731181278443; Sat, 09 Nov 2024 11:41:18 -0800 (PST) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-432b05c26e3sm118928125e9.33.2024.11.09.11.41.17 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 09 Nov 2024 11:41:17 -0800 (PST) Message-Id: In-Reply-To: References: Date: Sat, 09 Nov 2024 19:41:09 +0000 Subject: [PATCH v2 3/6] t6601: add helper for testing path-walk API Fcc: Sent Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 To: git@vger.kernel.org Cc: gitster@pobox.com, johannes.schindelin@gmx.de, peff@peff.net, ps@pks.im, me@ttaylorr.com, johncai86@gmail.com, newren@gmail.com, christian.couder@gmail.com, kristofferhaugsbakk@fastmail.com, jonathantanmy@google.com, karthik nayak , Derrick Stolee , Derrick Stolee From: Derrick Stolee From: Derrick Stolee Add some tests based on the current behavior, doing interesting checks for different sets of branches, ranges, and the --boundary option. This sets a baseline for the behavior and we can extend it as new options are introduced. Store and output a 'batch_nr' value so we can demonstrate that the paths are grouped together in a batch and not following some other ordering. This allows us to test the depth-first behavior of the path-walk API. However, we purposefully do not test the order of the objects in the batch, so the output is compared to the expected output through a sort. It is important to mention that the behavior of the API will change soon as we start to handle UNINTERESTING objects differently, but these tests will demonstrate the change in behavior. Signed-off-by: Derrick Stolee --- Documentation/technical/api-path-walk.txt | 3 +- Makefile | 1 + t/helper/test-path-walk.c | 90 ++++++++++++++++ t/helper/test-tool.c | 1 + t/helper/test-tool.h | 1 + t/t6601-path-walk.sh | 120 ++++++++++++++++++++++ 6 files changed, 215 insertions(+), 1 deletion(-) create mode 100644 t/helper/test-path-walk.c create mode 100755 t/t6601-path-walk.sh diff --git a/Documentation/technical/api-path-walk.txt b/Documentation/technical/api-path-walk.txt index c550c77ca30..662162ec70b 100644 --- a/Documentation/technical/api-path-walk.txt +++ b/Documentation/technical/api-path-walk.txt @@ -42,4 +42,5 @@ commits. Examples -------- -See example usages in future changes. +See example usages in: + `t/helper/test-path-walk.c` diff --git a/Makefile b/Makefile index d0d8d6888e3..50413d96492 100644 --- a/Makefile +++ b/Makefile @@ -818,6 +818,7 @@ TEST_BUILTINS_OBJS += test-parse-options.o TEST_BUILTINS_OBJS += test-parse-pathspec-file.o TEST_BUILTINS_OBJS += test-partial-clone.o TEST_BUILTINS_OBJS += test-path-utils.o +TEST_BUILTINS_OBJS += test-path-walk.o TEST_BUILTINS_OBJS += test-pcre2-config.o TEST_BUILTINS_OBJS += test-pkt-line.o TEST_BUILTINS_OBJS += test-proc-receive.o diff --git a/t/helper/test-path-walk.c b/t/helper/test-path-walk.c new file mode 100644 index 00000000000..aa468871079 --- /dev/null +++ b/t/helper/test-path-walk.c @@ -0,0 +1,90 @@ +#define USE_THE_REPOSITORY_VARIABLE + +#include "test-tool.h" +#include "environment.h" +#include "hex.h" +#include "object-name.h" +#include "object.h" +#include "pretty.h" +#include "revision.h" +#include "setup.h" +#include "parse-options.h" +#include "path-walk.h" +#include "oid-array.h" + +static const char * const path_walk_usage[] = { + N_("test-tool path-walk -- "), + NULL +}; + +struct path_walk_test_data { + uintmax_t batch_nr; + uintmax_t tree_nr; + uintmax_t blob_nr; +}; + +static int emit_block(const char *path, struct oid_array *oids, + enum object_type type, void *data) +{ + struct path_walk_test_data *tdata = data; + const char *typestr; + + switch (type) { + case OBJ_TREE: + typestr = "TREE"; + tdata->tree_nr += oids->nr; + break; + + case OBJ_BLOB: + typestr = "BLOB"; + tdata->blob_nr += oids->nr; + break; + + default: + BUG("we do not understand this type"); + } + + for (size_t i = 0; i < oids->nr; i++) + printf("%"PRIuMAX":%s:%s:%s\n", + tdata->batch_nr, typestr, path, + oid_to_hex(&oids->oid[i])); + + tdata->batch_nr++; + return 0; +} + +int cmd__path_walk(int argc, const char **argv) +{ + int res; + struct rev_info revs = REV_INFO_INIT; + struct path_walk_info info = PATH_WALK_INFO_INIT; + struct path_walk_test_data data = { 0 }; + struct option options[] = { + OPT_END(), + }; + + setup_git_directory(); + revs.repo = the_repository; + + argc = parse_options(argc, argv, NULL, + options, path_walk_usage, + PARSE_OPT_KEEP_UNKNOWN_OPT | PARSE_OPT_KEEP_ARGV0); + + if (argc > 1) + setup_revisions(argc, argv, &revs, NULL); + else + usage(path_walk_usage[0]); + + info.revs = &revs; + info.path_fn = emit_block; + info.path_fn_data = &data; + + res = walk_objects_by_path(&info); + + printf("trees:%" PRIuMAX "\n" + "blobs:%" PRIuMAX "\n", + data.tree_nr, data.blob_nr); + + release_revisions(&revs); + return res; +} diff --git a/t/helper/test-tool.c b/t/helper/test-tool.c index 1ebb69a5dc4..43676e7b93a 100644 --- a/t/helper/test-tool.c +++ b/t/helper/test-tool.c @@ -52,6 +52,7 @@ static struct test_cmd cmds[] = { { "parse-subcommand", cmd__parse_subcommand }, { "partial-clone", cmd__partial_clone }, { "path-utils", cmd__path_utils }, + { "path-walk", cmd__path_walk }, { "pcre2-config", cmd__pcre2_config }, { "pkt-line", cmd__pkt_line }, { "proc-receive", cmd__proc_receive }, diff --git a/t/helper/test-tool.h b/t/helper/test-tool.h index 21802ac27da..9cfc5da6e57 100644 --- a/t/helper/test-tool.h +++ b/t/helper/test-tool.h @@ -45,6 +45,7 @@ int cmd__parse_pathspec_file(int argc, const char** argv); int cmd__parse_subcommand(int argc, const char **argv); int cmd__partial_clone(int argc, const char **argv); int cmd__path_utils(int argc, const char **argv); +int cmd__path_walk(int argc, const char **argv); int cmd__pcre2_config(int argc, const char **argv); int cmd__pkt_line(int argc, const char **argv); int cmd__proc_receive(int argc, const char **argv); diff --git a/t/t6601-path-walk.sh b/t/t6601-path-walk.sh new file mode 100755 index 00000000000..a3da55933f4 --- /dev/null +++ b/t/t6601-path-walk.sh @@ -0,0 +1,120 @@ +#!/bin/sh + +TEST_PASSES_SANITIZE_LEAK=true + +test_description='direct path-walk API tests' + +. ./test-lib.sh + +test_expect_success 'setup test repository' ' + git checkout -b base && + + mkdir left && + mkdir right && + echo a >a && + echo b >left/b && + echo c >right/c && + git add . && + git commit -m "first" && + + echo d >right/d && + git add right && + git commit -m "second" && + + echo bb >left/b && + git commit -a -m "third" && + + git checkout -b topic HEAD~1 && + echo cc >right/c && + git commit -a -m "topic" +' + +test_expect_success 'all' ' + test-tool path-walk -- --all >out && + + cat >expect <<-EOF && + 0:TREE::$(git rev-parse topic^{tree}) + 0:TREE::$(git rev-parse base^{tree}) + 0:TREE::$(git rev-parse base~1^{tree}) + 0:TREE::$(git rev-parse base~2^{tree}) + 1:TREE:right/:$(git rev-parse topic:right) + 1:TREE:right/:$(git rev-parse base~1:right) + 1:TREE:right/:$(git rev-parse base~2:right) + 2:BLOB:right/d:$(git rev-parse base~1:right/d) + 3:BLOB:right/c:$(git rev-parse base~2:right/c) + 3:BLOB:right/c:$(git rev-parse topic:right/c) + 4:TREE:left/:$(git rev-parse base:left) + 4:TREE:left/:$(git rev-parse base~2:left) + 5:BLOB:left/b:$(git rev-parse base~2:left/b) + 5:BLOB:left/b:$(git rev-parse base:left/b) + 6:BLOB:a:$(git rev-parse base~2:a) + blobs:6 + trees:9 + EOF + + test_cmp_sorted expect out +' + +test_expect_success 'topic only' ' + test-tool path-walk -- topic >out && + + cat >expect <<-EOF && + 0:TREE::$(git rev-parse topic^{tree}) + 0:TREE::$(git rev-parse base~1^{tree}) + 0:TREE::$(git rev-parse base~2^{tree}) + 1:TREE:right/:$(git rev-parse topic:right) + 1:TREE:right/:$(git rev-parse base~1:right) + 1:TREE:right/:$(git rev-parse base~2:right) + 2:BLOB:right/d:$(git rev-parse base~1:right/d) + 3:BLOB:right/c:$(git rev-parse base~2:right/c) + 3:BLOB:right/c:$(git rev-parse topic:right/c) + 4:TREE:left/:$(git rev-parse base~2:left) + 5:BLOB:left/b:$(git rev-parse base~2:left/b) + 6:BLOB:a:$(git rev-parse base~2:a) + blobs:5 + trees:7 + EOF + + test_cmp_sorted expect out +' + +test_expect_success 'topic, not base' ' + test-tool path-walk -- topic --not base >out && + + cat >expect <<-EOF && + 0:TREE::$(git rev-parse topic^{tree}) + 1:TREE:right/:$(git rev-parse topic:right) + 2:BLOB:right/d:$(git rev-parse topic:right/d) + 3:BLOB:right/c:$(git rev-parse topic:right/c) + 4:TREE:left/:$(git rev-parse topic:left) + 5:BLOB:left/b:$(git rev-parse topic:left/b) + 6:BLOB:a:$(git rev-parse topic:a) + blobs:4 + trees:3 + EOF + + test_cmp_sorted expect out +' + +test_expect_success 'topic, not base, boundary' ' + test-tool path-walk -- --boundary topic --not base >out && + + cat >expect <<-EOF && + 0:TREE::$(git rev-parse topic^{tree}) + 0:TREE::$(git rev-parse base~1^{tree}) + 1:TREE:right/:$(git rev-parse topic:right) + 1:TREE:right/:$(git rev-parse base~1:right) + 2:BLOB:right/d:$(git rev-parse base~1:right/d) + 3:BLOB:right/c:$(git rev-parse base~1:right/c) + 3:BLOB:right/c:$(git rev-parse topic:right/c) + 4:TREE:left/:$(git rev-parse base~1:left) + 5:BLOB:left/b:$(git rev-parse base~1:left/b) + 6:BLOB:a:$(git rev-parse base~1:a) + blobs:5 + trees:5 + EOF + + test_cmp_sorted expect out +' + +test_done From patchwork Sat Nov 9 19:41:10 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Derrick Stolee X-Patchwork-Id: 13869708 Received: from mail-wm1-f49.google.com (mail-wm1-f49.google.com [209.85.128.49]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 780A61A0BDC for ; Sat, 9 Nov 2024 19:41:22 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.49 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731181284; cv=none; b=WlOedsM2rlrWYjIe6Q1bqyklOaZso8jBVKdCbHckOwIOltX76td9d0mk5gZsol8D8jcowjBD36SExU2opmOd3tN61ZispwKdQdM2ie37qrKkt6eVJQ+GDNIgX/0nB0nO79HPV7yl8yw5ObJsxfHUivSRN5v/syeGOywoL+pSr4w= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731181284; c=relaxed/simple; bh=ePLR5Ql+fYCXNWN3Ui+KDe2rO7S3LgcBN+vPVkv2p8g=; h=Message-Id:In-Reply-To:References:From:Date:Subject:Content-Type: MIME-Version:To:Cc; b=qr1k40l6qfuWZQ/xgkDAgFR0+JrtJFQbJMihUHr6Lp/+ExtqfUE0KZ540KrQE3PxMhPGBsufZ069LMgvtuiBwY2IGvTkPl+wu/XCcgHAzRkLBpEMks6pxpgDDTiifsFtVGt7OlKc+9ENkaG2/6ImUCdPmvzspNpE34cHxIyjxxM= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=P5JmnLHs; arc=none smtp.client-ip=209.85.128.49 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="P5JmnLHs" Received: by mail-wm1-f49.google.com with SMTP id 5b1f17b1804b1-43158625112so28840705e9.3 for ; Sat, 09 Nov 2024 11:41:22 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1731181279; x=1731786079; darn=vger.kernel.org; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=C1eJy5XoD6urwVb6CkLe+hSb4FCriQNWyOJPq1Y2PE4=; b=P5JmnLHsZX9OzZcVDcYLTMKTbNXt/Sbp//SMSajM+lkJRetU5SDdwg4Snaki+KQ983 4VH/6/E7kShYNeTPsSl5FEx2doN13A9BJ+aiEtdOG2c/pYdEnI6DlSPQ7HAm67xOJZBk zPYLznT6IIwMyhy6fT5+Xo6tg9s8csh66aO8aEpTQB8TTLlVDgRNOkH9GNX8rHvVfxzy toTpaFqJ5oTFNt0eb9nz/qmGMIskEGa8Nc4JrZLNmrUCGwtTlRi0AzAKjAwnaBlUMLeG Pk3QH//fWcHi4sWzzW+50ic/wT/sxZU8MvMaN3/4RsAvWuoAuM9uhJE8LT0P1VwFqWxt gb4Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1731181279; x=1731786079; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=C1eJy5XoD6urwVb6CkLe+hSb4FCriQNWyOJPq1Y2PE4=; b=qKryq82tcvELcZMALmeuDtHeGQ2cG60IFOHXI1YRNAdYYaBXtYw4pBbpWuhUonyOVT HctJVfU9wqSqxFHtBxUKZMV4u5iEkJ+XXbRJLzduCqOG6pr3x+EawIvZ+AjzcT3e3B13 w+whVXcaoneOrFP8CuNNjdBEIM3CHXm/fC6ChRzffIccYF3keTN08EYUt8MY76hnIb+j Bw4F+Ib/fNmGwh4sGCm95GiFkH1kLMR5VFKiJFAQG0kKvOhav7YQIZ24Z0p8WkBxJvf8 aqOISvkSCoq7gVSQz7LyQBqRjTn1nFpr/6vH/ltNT8DM7YGapvZABFPB5784xO4hR4ss UvWg== X-Gm-Message-State: AOJu0YxasdKzX8qMVYUsKaEfDgDmnwYepL/fVhPna8s05VfdvEDTyJqm M2QZLyp1qFOucaZZiKFLk3E0JpZHgHIGFutCzx3bk544jXigmf4M7tqung== X-Google-Smtp-Source: AGHT+IFVIBQgm8efb3GAGbBfeoF491JUPvzhSUHH9Jk8Wfp+lrO3tc8QJiUfX+X/0g9ARFse3lUAQg== X-Received: by 2002:a05:600c:3ba6:b0:431:542d:2592 with SMTP id 5b1f17b1804b1-432b751d866mr59838385e9.27.1731181279223; Sat, 09 Nov 2024 11:41:19 -0800 (PST) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-432b05673d0sm115080735e9.25.2024.11.09.11.41.18 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 09 Nov 2024 11:41:18 -0800 (PST) Message-Id: <83b746f569df932452d8d102dc29dda0859c4ed2.1731181273.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Sat, 09 Nov 2024 19:41:10 +0000 Subject: [PATCH v2 4/6] path-walk: allow consumer to specify object types Fcc: Sent Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 To: git@vger.kernel.org Cc: gitster@pobox.com, johannes.schindelin@gmx.de, peff@peff.net, ps@pks.im, me@ttaylorr.com, johncai86@gmail.com, newren@gmail.com, christian.couder@gmail.com, kristofferhaugsbakk@fastmail.com, jonathantanmy@google.com, karthik nayak , Derrick Stolee , Derrick Stolee From: Derrick Stolee From: Derrick Stolee We add the ability to filter the object types in the path-walk API so the callback function is called fewer times. This adds the ability to ask for the commits in a list, as well. We re-use the empty string for this set of objects because these are passed directly to the callback function instead of being part of the 'path_stack'. Future changes will add the ability to visit annotated tags. Signed-off-by: Derrick Stolee --- Documentation/technical/api-path-walk.txt | 9 ++ path-walk.c | 33 ++++- path-walk.h | 14 +- t/helper/test-path-walk.c | 18 ++- t/t6601-path-walk.sh | 149 +++++++++++++++------- 5 files changed, 173 insertions(+), 50 deletions(-) diff --git a/Documentation/technical/api-path-walk.txt b/Documentation/technical/api-path-walk.txt index 662162ec70b..dce553b6114 100644 --- a/Documentation/technical/api-path-walk.txt +++ b/Documentation/technical/api-path-walk.txt @@ -39,6 +39,15 @@ It is also important that you do not specify the `--objects` flag for the the objects will be walked in a separate way based on those starting commits. +`commits`, `blobs`, `trees`:: + By default, these members are enabled and signal that the path-walk + API should call the `path_fn` on objects of these types. Specialized + applications could disable some options to make it simpler to walk + the objects or to have fewer calls to `path_fn`. ++ +While it is possible to walk only commits in this way, consumers would be +better off using the revision walk API instead. + Examples -------- diff --git a/path-walk.c b/path-walk.c index 24cf04c1e7d..2ca08402367 100644 --- a/path-walk.c +++ b/path-walk.c @@ -98,6 +98,10 @@ static int add_children(struct path_walk_context *ctx, if (S_ISGITLINK(entry.mode)) continue; + /* If the caller doesn't want blobs, then don't bother. */ + if (!ctx->info->blobs && type == OBJ_BLOB) + continue; + if (type == OBJ_TREE) { struct tree *child = lookup_tree(ctx->repo, &entry.oid); o = child ? &child->object : NULL; @@ -157,9 +161,11 @@ static int walk_path(struct path_walk_context *ctx, if (!list->oids.nr) return 0; - /* Evaluate function pointer on this data. */ - ret = ctx->info->path_fn(path, &list->oids, list->type, - ctx->info->path_fn_data); + /* Evaluate function pointer on this data, if requested. */ + if ((list->type == OBJ_TREE && ctx->info->trees) || + (list->type == OBJ_BLOB && ctx->info->blobs)) + ret = ctx->info->path_fn(path, &list->oids, list->type, + ctx->info->path_fn_data); /* Expand data for children. */ if (list->type == OBJ_TREE) { @@ -201,6 +207,7 @@ int walk_objects_by_path(struct path_walk_info *info) size_t commits_nr = 0, paths_nr = 0; struct commit *c; struct type_and_oid_list *root_tree_list; + struct type_and_oid_list *commit_list; struct path_walk_context ctx = { .repo = info->revs->repo, .revs = info->revs, @@ -212,6 +219,9 @@ int walk_objects_by_path(struct path_walk_info *info) trace2_region_enter("path-walk", "commit-walk", info->revs->repo); + CALLOC_ARRAY(commit_list, 1); + commit_list->type = OBJ_COMMIT; + /* Insert a single list for the root tree into the paths. */ CALLOC_ARRAY(root_tree_list, 1); root_tree_list->type = OBJ_TREE; @@ -222,10 +232,18 @@ int walk_objects_by_path(struct path_walk_info *info) die(_("failed to setup revision walk")); while ((c = get_revision(info->revs))) { - struct object_id *oid = get_commit_tree_oid(c); + struct object_id *oid; struct tree *t; commits_nr++; + if (info->commits) + oid_array_append(&commit_list->oids, + &c->object.oid); + + /* If we only care about commits, then skip trees. */ + if (!info->trees && !info->blobs) + continue; + oid = get_commit_tree_oid(c); t = lookup_tree(info->revs->repo, oid); @@ -243,6 +261,13 @@ int walk_objects_by_path(struct path_walk_info *info) trace2_data_intmax("path-walk", ctx.repo, "commits", commits_nr); trace2_region_leave("path-walk", "commit-walk", info->revs->repo); + /* Track all commits. */ + if (info->commits && commit_list->oids.nr) + ret = info->path_fn("", &commit_list->oids, OBJ_COMMIT, + info->path_fn_data); + oid_array_clear(&commit_list->oids); + free(commit_list); + trace2_region_enter("path-walk", "path-walk", info->revs->repo); while (!ret && ctx.path_stack.nr) { char *path = ctx.path_stack.items[ctx.path_stack.nr - 1].string; diff --git a/path-walk.h b/path-walk.h index c9e94a98bc8..2d2afc29b47 100644 --- a/path-walk.h +++ b/path-walk.h @@ -30,9 +30,21 @@ struct path_walk_info { */ path_fn path_fn; void *path_fn_data; + + /** + * Initialize which object types the path_fn should be called on. This + * could also limit the walk to skip blobs if not set. + */ + int commits; + int trees; + int blobs; }; -#define PATH_WALK_INFO_INIT { 0 } +#define PATH_WALK_INFO_INIT { \ + .blobs = 1, \ + .trees = 1, \ + .commits = 1, \ +} /** * Given the configuration of 'info', walk the commits based on 'info->revs' and diff --git a/t/helper/test-path-walk.c b/t/helper/test-path-walk.c index aa468871079..2b7e6e98d18 100644 --- a/t/helper/test-path-walk.c +++ b/t/helper/test-path-walk.c @@ -19,6 +19,8 @@ static const char * const path_walk_usage[] = { struct path_walk_test_data { uintmax_t batch_nr; + + uintmax_t commit_nr; uintmax_t tree_nr; uintmax_t blob_nr; }; @@ -30,6 +32,11 @@ static int emit_block(const char *path, struct oid_array *oids, const char *typestr; switch (type) { + case OBJ_COMMIT: + typestr = "COMMIT"; + tdata->commit_nr += oids->nr; + break; + case OBJ_TREE: typestr = "TREE"; tdata->tree_nr += oids->nr; @@ -60,6 +67,12 @@ int cmd__path_walk(int argc, const char **argv) struct path_walk_info info = PATH_WALK_INFO_INIT; struct path_walk_test_data data = { 0 }; struct option options[] = { + OPT_BOOL(0, "blobs", &info.blobs, + N_("toggle inclusion of blob objects")), + OPT_BOOL(0, "commits", &info.commits, + N_("toggle inclusion of commit objects")), + OPT_BOOL(0, "trees", &info.trees, + N_("toggle inclusion of tree objects")), OPT_END(), }; @@ -81,9 +94,10 @@ int cmd__path_walk(int argc, const char **argv) res = walk_objects_by_path(&info); - printf("trees:%" PRIuMAX "\n" + printf("commits:%" PRIuMAX "\n" + "trees:%" PRIuMAX "\n" "blobs:%" PRIuMAX "\n", - data.tree_nr, data.blob_nr); + data.commit_nr, data.tree_nr, data.blob_nr); release_revisions(&revs); return res; diff --git a/t/t6601-path-walk.sh b/t/t6601-path-walk.sh index a3da55933f4..dcd3c03a2e8 100755 --- a/t/t6601-path-walk.sh +++ b/t/t6601-path-walk.sh @@ -33,22 +33,27 @@ test_expect_success 'all' ' test-tool path-walk -- --all >out && cat >expect <<-EOF && - 0:TREE::$(git rev-parse topic^{tree}) - 0:TREE::$(git rev-parse base^{tree}) - 0:TREE::$(git rev-parse base~1^{tree}) - 0:TREE::$(git rev-parse base~2^{tree}) - 1:TREE:right/:$(git rev-parse topic:right) - 1:TREE:right/:$(git rev-parse base~1:right) - 1:TREE:right/:$(git rev-parse base~2:right) - 2:BLOB:right/d:$(git rev-parse base~1:right/d) - 3:BLOB:right/c:$(git rev-parse base~2:right/c) - 3:BLOB:right/c:$(git rev-parse topic:right/c) - 4:TREE:left/:$(git rev-parse base:left) - 4:TREE:left/:$(git rev-parse base~2:left) - 5:BLOB:left/b:$(git rev-parse base~2:left/b) - 5:BLOB:left/b:$(git rev-parse base:left/b) - 6:BLOB:a:$(git rev-parse base~2:a) + 0:COMMIT::$(git rev-parse topic) + 0:COMMIT::$(git rev-parse base) + 0:COMMIT::$(git rev-parse base~1) + 0:COMMIT::$(git rev-parse base~2) + 1:TREE::$(git rev-parse topic^{tree}) + 1:TREE::$(git rev-parse base^{tree}) + 1:TREE::$(git rev-parse base~1^{tree}) + 1:TREE::$(git rev-parse base~2^{tree}) + 2:TREE:right/:$(git rev-parse topic:right) + 2:TREE:right/:$(git rev-parse base~1:right) + 2:TREE:right/:$(git rev-parse base~2:right) + 3:BLOB:right/d:$(git rev-parse base~1:right/d) + 4:BLOB:right/c:$(git rev-parse base~2:right/c) + 4:BLOB:right/c:$(git rev-parse topic:right/c) + 5:TREE:left/:$(git rev-parse base:left) + 5:TREE:left/:$(git rev-parse base~2:left) + 6:BLOB:left/b:$(git rev-parse base~2:left/b) + 6:BLOB:left/b:$(git rev-parse base:left/b) + 7:BLOB:a:$(git rev-parse base~2:a) blobs:6 + commits:4 trees:9 EOF @@ -59,19 +64,23 @@ test_expect_success 'topic only' ' test-tool path-walk -- topic >out && cat >expect <<-EOF && - 0:TREE::$(git rev-parse topic^{tree}) - 0:TREE::$(git rev-parse base~1^{tree}) - 0:TREE::$(git rev-parse base~2^{tree}) - 1:TREE:right/:$(git rev-parse topic:right) - 1:TREE:right/:$(git rev-parse base~1:right) - 1:TREE:right/:$(git rev-parse base~2:right) - 2:BLOB:right/d:$(git rev-parse base~1:right/d) - 3:BLOB:right/c:$(git rev-parse base~2:right/c) - 3:BLOB:right/c:$(git rev-parse topic:right/c) - 4:TREE:left/:$(git rev-parse base~2:left) - 5:BLOB:left/b:$(git rev-parse base~2:left/b) - 6:BLOB:a:$(git rev-parse base~2:a) + 0:COMMIT::$(git rev-parse topic) + 0:COMMIT::$(git rev-parse base~1) + 0:COMMIT::$(git rev-parse base~2) + 1:TREE::$(git rev-parse topic^{tree}) + 1:TREE::$(git rev-parse base~1^{tree}) + 1:TREE::$(git rev-parse base~2^{tree}) + 2:TREE:right/:$(git rev-parse topic:right) + 2:TREE:right/:$(git rev-parse base~1:right) + 2:TREE:right/:$(git rev-parse base~2:right) + 3:BLOB:right/d:$(git rev-parse base~1:right/d) + 4:BLOB:right/c:$(git rev-parse base~2:right/c) + 4:BLOB:right/c:$(git rev-parse topic:right/c) + 5:TREE:left/:$(git rev-parse base~2:left) + 6:BLOB:left/b:$(git rev-parse base~2:left/b) + 7:BLOB:a:$(git rev-parse base~2:a) blobs:5 + commits:3 trees:7 EOF @@ -82,15 +91,66 @@ test_expect_success 'topic, not base' ' test-tool path-walk -- topic --not base >out && cat >expect <<-EOF && + 0:COMMIT::$(git rev-parse topic) + 1:TREE::$(git rev-parse topic^{tree}) + 2:TREE:right/:$(git rev-parse topic:right) + 3:BLOB:right/d:$(git rev-parse topic:right/d) + 4:BLOB:right/c:$(git rev-parse topic:right/c) + 5:TREE:left/:$(git rev-parse topic:left) + 6:BLOB:left/b:$(git rev-parse topic:left/b) + 7:BLOB:a:$(git rev-parse topic:a) + blobs:4 + commits:1 + trees:3 + EOF + + test_cmp_sorted expect out +' + +test_expect_success 'topic, not base, only blobs' ' + test-tool path-walk --no-trees --no-commits \ + -- topic --not base >out && + + cat >expect <<-EOF && + commits:0 + trees:0 + 0:BLOB:right/d:$(git rev-parse topic:right/d) + 1:BLOB:right/c:$(git rev-parse topic:right/c) + 2:BLOB:left/b:$(git rev-parse topic:left/b) + 3:BLOB:a:$(git rev-parse topic:a) + blobs:4 + EOF + + test_cmp_sorted expect out +' + +# No, this doesn't make a lot of sense for the path-walk API, +# but it is possible to do. +test_expect_success 'topic, not base, only commits' ' + test-tool path-walk --no-blobs --no-trees \ + -- topic --not base >out && + + cat >expect <<-EOF && + 0:COMMIT::$(git rev-parse topic) + commits:1 + trees:0 + blobs:0 + EOF + + test_cmp_sorted expect out +' + +test_expect_success 'topic, not base, only trees' ' + test-tool path-walk --no-blobs --no-commits \ + -- topic --not base >out && + + cat >expect <<-EOF && + commits:0 0:TREE::$(git rev-parse topic^{tree}) 1:TREE:right/:$(git rev-parse topic:right) - 2:BLOB:right/d:$(git rev-parse topic:right/d) - 3:BLOB:right/c:$(git rev-parse topic:right/c) - 4:TREE:left/:$(git rev-parse topic:left) - 5:BLOB:left/b:$(git rev-parse topic:left/b) - 6:BLOB:a:$(git rev-parse topic:a) - blobs:4 + 2:TREE:left/:$(git rev-parse topic:left) trees:3 + blobs:0 EOF test_cmp_sorted expect out @@ -100,17 +160,20 @@ test_expect_success 'topic, not base, boundary' ' test-tool path-walk -- --boundary topic --not base >out && cat >expect <<-EOF && - 0:TREE::$(git rev-parse topic^{tree}) - 0:TREE::$(git rev-parse base~1^{tree}) - 1:TREE:right/:$(git rev-parse topic:right) - 1:TREE:right/:$(git rev-parse base~1:right) - 2:BLOB:right/d:$(git rev-parse base~1:right/d) - 3:BLOB:right/c:$(git rev-parse base~1:right/c) - 3:BLOB:right/c:$(git rev-parse topic:right/c) - 4:TREE:left/:$(git rev-parse base~1:left) - 5:BLOB:left/b:$(git rev-parse base~1:left/b) - 6:BLOB:a:$(git rev-parse base~1:a) + 0:COMMIT::$(git rev-parse topic) + 0:COMMIT::$(git rev-parse base~1) + 1:TREE::$(git rev-parse topic^{tree}) + 1:TREE::$(git rev-parse base~1^{tree}) + 2:TREE:right/:$(git rev-parse topic:right) + 2:TREE:right/:$(git rev-parse base~1:right) + 3:BLOB:right/d:$(git rev-parse base~1:right/d) + 4:BLOB:right/c:$(git rev-parse base~1:right/c) + 4:BLOB:right/c:$(git rev-parse topic:right/c) + 5:TREE:left/:$(git rev-parse base~1:left) + 6:BLOB:left/b:$(git rev-parse base~1:left/b) + 7:BLOB:a:$(git rev-parse base~1:a) blobs:5 + commits:2 trees:5 EOF From patchwork Sat Nov 9 19:41:11 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Derrick Stolee X-Patchwork-Id: 13869709 Received: from mail-wm1-f44.google.com (mail-wm1-f44.google.com [209.85.128.44]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id AA1D31A0BFA for ; Sat, 9 Nov 2024 19:41:22 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.44 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731181285; cv=none; b=e0vsHvq5DusTmVDfpbeCCRLMSVYxWyM8VCZtCqkmQNpPwCoE9dgiqzxoTdSn/ASEiIGaCgNmnNBZPi+WRpcPIKf8gOKuex8orR0nHlnykTs/qw13aq+sX6H1quPYIL2hK5gKMAGvMqzwY0hajP18DX1YYS023fVpEM4kkov+yYc= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731181285; c=relaxed/simple; bh=cBo6LQnLjMBu6wYkUXSZ7v7LeeOQQCAfgHPaWMvQjpE=; h=Message-Id:In-Reply-To:References:From:Date:Subject:Content-Type: MIME-Version:To:Cc; b=G7+/tca301/SvTwpUKhh5mDJoSTJaIXkk0NB8KFXJanE7U3Mam679eERpVOg3WGxaOYFLKaBwH8iTgRu9gyKIrQ2OQBuMVFfg+BHvloPx/TWXMA0lkq/XLon7EsvRkxqoPJ1wEbjxyNTvdwP275OlxH1qwSOJxOmN8GMDIUM5fs= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=VpC2LbNT; arc=none smtp.client-ip=209.85.128.44 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="VpC2LbNT" Received: by mail-wm1-f44.google.com with SMTP id 5b1f17b1804b1-4315abed18aso28105865e9.2 for ; Sat, 09 Nov 2024 11:41:22 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1731181280; x=1731786080; darn=vger.kernel.org; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=mAOYMZE/i6Tnnwnx6VOYfCVwAyAEBg28V79fWYt3h+Q=; b=VpC2LbNTKkD20gk+TRuFcOi7jyuTQsvcGhrBHmdDEprzMX+YA4RWrjA2XoKWEHymgE dpTPTClYhjjgASDiL8EAPbdGlMaS1Ed1D2WrTPPYg4pHp++UMEcKRti2EPl8n3nEFwlh P5NpBUdXoJuFQZBKsV+LX+TMrGAE57dvzA/gvFTEeyyMMd7twoKFGlq0uOTLap4InwS+ qq9aIZdt79tDOYft0Cpax5BGQxC15J6SPqkvoQrTFYuQsuSaSugD6D/Y2Z2M1wKUhcTL 7VaWspuFfNrQ2g5F6QHWh6zPiSIED4nhPlVxeOiZIL1Z0sYSyowFCSPU+j0oDFBeeg+6 fB5w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1731181280; x=1731786080; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=mAOYMZE/i6Tnnwnx6VOYfCVwAyAEBg28V79fWYt3h+Q=; b=XaG78b0uojF9cvPOj3JbAevCNOycoqtCxNTEGgvAfXVwwNGaXGnke4g8v3sjIo8RFO jutPIXv+4tNYUDSFJZtQobbqbGLRiSZCG9PutPHM+ihMFVdBM6k4r2YZddF298IEe/tv F4i1NDvN9f83s515TQ03XFfpfK7CD+R1MtAeoDJfbco/gO7VDCxEudDlQcMY+2XK9QXd 7CP30FyTd/tOR9mcDGuOz7cNwALXI2yUpH3cIOAdgl/r96tqPtr+HCJMxgsFZf/v5V3L 5j4FAbo4sEjeaXThy0+B3pIUF2UQyLkZFceTGZI29nxQ5eVLZP0uWOdSl7FX1b6bY9TR KkFw== X-Gm-Message-State: AOJu0YywTOtXr5+8LarZi6+Bqla8scW415LHl00OirIvy45sr/7M1H3X FzdZdGJ2s9RTL5tUFbyYQP9MGwrshdsnG1c9iyG+BJemPwlhOJl3OEnotw== X-Google-Smtp-Source: AGHT+IHSaflgwNQT6t0ONKzNEM2+GvPBfwVPR3FtIeSQmk5CI6BCXXggSwgSVG3lNI6EeOvJT+F5JA== X-Received: by 2002:a05:600c:3b9d:b0:431:612f:189b with SMTP id 5b1f17b1804b1-432b7505ae9mr65057435e9.12.1731181280147; Sat, 09 Nov 2024 11:41:20 -0800 (PST) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-381ed9ea7c3sm8690512f8f.80.2024.11.09.11.41.19 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 09 Nov 2024 11:41:19 -0800 (PST) Message-Id: <97765aa04c2fe4a254a93814a6e0de14fa4f9149.1731181273.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Sat, 09 Nov 2024 19:41:11 +0000 Subject: [PATCH v2 5/6] path-walk: visit tags and cached objects Fcc: Sent Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 To: git@vger.kernel.org Cc: gitster@pobox.com, johannes.schindelin@gmx.de, peff@peff.net, ps@pks.im, me@ttaylorr.com, johncai86@gmail.com, newren@gmail.com, christian.couder@gmail.com, kristofferhaugsbakk@fastmail.com, jonathantanmy@google.com, karthik nayak , Derrick Stolee , Derrick Stolee From: Derrick Stolee From: Derrick Stolee The rev_info that is specified for a path-walk traversal may specify visiting tag refs (both lightweight and annotated) and also may specify indexed objects (blobs and trees). Update the path-walk API to walk these objects as well. When walking tags, we need to peel the annotated objects until reaching a non-tag object. If we reach a commit, then we can add it to the pending objects to make sure we visit in the commit walk portion. If we reach a tree, then we will assume that it is a root tree. If we reach a blob, then we have no good path name and so add it to a new list of "tagged blobs". When the rev_info includes the "--indexed-objects" flag, then the pending set includes blobs and trees found in the cache entries and cache-tree. The cache entries are usually blobs, though they could be trees in the case of a sparse index. The cache-tree stores previously-hashed tree objects but these are cleared out when staging objects below those paths. We add tests that demonstrate this. The indexed objects come with a non-NULL 'path' value in the pending item. This allows us to prepopulate the 'path_to_lists' strmap with lists for these paths. The tricky thing about this walk is that we will want to combine the indexed objects walk with the commit walk, especially in the future case of walking objects during a command like 'git repack'. Whenever possible, we want the objects from the index to be grouped with similar objects in history. We don't want to miss any paths that appear only in the index and not in the commit history. Thus, we need to be careful to let the path stack be populated initially with only the root tree path (and possibly tags and tagged blobs) and go through the normal depth-first search. Afterwards, if there are other paths that are remaining in the paths_to_lists strmap, we should then iterate through the stack and visit those objects recursively. Signed-off-by: Derrick Stolee --- Documentation/technical/api-path-walk.txt | 2 +- path-walk.c | 174 +++++++++++++++++++- path-walk.h | 2 + t/helper/test-path-walk.c | 18 ++- t/t6601-path-walk.sh | 186 +++++++++++++++++++--- 5 files changed, 356 insertions(+), 26 deletions(-) diff --git a/Documentation/technical/api-path-walk.txt b/Documentation/technical/api-path-walk.txt index dce553b6114..6022c381b7c 100644 --- a/Documentation/technical/api-path-walk.txt +++ b/Documentation/technical/api-path-walk.txt @@ -39,7 +39,7 @@ It is also important that you do not specify the `--objects` flag for the the objects will be walked in a separate way based on those starting commits. -`commits`, `blobs`, `trees`:: +`commits`, `blobs`, `trees`, `tags`:: By default, these members are enabled and signal that the path-walk API should call the `path_fn` on objects of these types. Specialized applications could disable some options to make it simpler to walk diff --git a/path-walk.c b/path-walk.c index 2ca08402367..a1f539dcd46 100644 --- a/path-walk.c +++ b/path-walk.c @@ -13,10 +13,13 @@ #include "revision.h" #include "string-list.h" #include "strmap.h" +#include "tag.h" #include "trace2.h" #include "tree.h" #include "tree-walk.h" +static const char *root_path = ""; + struct type_and_oid_list { enum object_type type; @@ -158,12 +161,16 @@ static int walk_path(struct path_walk_context *ctx, list = strmap_get(&ctx->paths_to_lists, path); + if (!list) + BUG("provided path '%s' that had no associated list", path); + if (!list->oids.nr) return 0; /* Evaluate function pointer on this data, if requested. */ if ((list->type == OBJ_TREE && ctx->info->trees) || - (list->type == OBJ_BLOB && ctx->info->blobs)) + (list->type == OBJ_BLOB && ctx->info->blobs) || + (list->type == OBJ_TAG && ctx->info->tags)) ret = ctx->info->path_fn(path, &list->oids, list->type, ctx->info->path_fn_data); @@ -194,6 +201,134 @@ static void clear_strmap(struct strmap *map) strmap_init(map); } +static void setup_pending_objects(struct path_walk_info *info, + struct path_walk_context *ctx) +{ + struct type_and_oid_list *tags = NULL; + struct type_and_oid_list *tagged_blobs = NULL; + struct type_and_oid_list *root_tree_list = NULL; + + if (info->tags) + CALLOC_ARRAY(tags, 1); + if (info->blobs) + CALLOC_ARRAY(tagged_blobs, 1); + if (info->trees) + root_tree_list = strmap_get(&ctx->paths_to_lists, root_path); + + /* + * Pending objects include: + * * Commits at branch tips. + * * Annotated tags at tag tips. + * * Any kind of object at lightweight tag tips. + * * Trees and blobs in the index (with an associated path). + */ + for (size_t i = 0; i < info->revs->pending.nr; i++) { + struct object_array_entry *pending = info->revs->pending.objects + i; + struct object *obj = pending->item; + + /* Commits will be picked up by revision walk. */ + if (obj->type == OBJ_COMMIT) + continue; + + /* Navigate annotated tag object chains. */ + while (obj->type == OBJ_TAG) { + struct tag *tag = lookup_tag(info->revs->repo, &obj->oid); + if (!tag) + break; + if (tag->object.flags & SEEN) + break; + tag->object.flags |= SEEN; + + if (tags) + oid_array_append(&tags->oids, &obj->oid); + obj = tag->tagged; + } + + if (obj->type == OBJ_TAG) + continue; + + /* We are now at a non-tag object. */ + if (obj->flags & SEEN) + continue; + obj->flags |= SEEN; + + switch (obj->type) { + case OBJ_TREE: + if (!info->trees) + continue; + if (pending->path) { + struct type_and_oid_list *list; + char *path = *pending->path ? xstrfmt("%s/", pending->path) + : xstrdup(""); + if (!(list = strmap_get(&ctx->paths_to_lists, path))) { + CALLOC_ARRAY(list, 1); + list->type = OBJ_TREE; + strmap_put(&ctx->paths_to_lists, path, list); + } + oid_array_append(&list->oids, &obj->oid); + free(path); + } else { + /* assume a root tree, such as a lightweight tag. */ + oid_array_append(&root_tree_list->oids, &obj->oid); + } + break; + + case OBJ_BLOB: + if (!info->blobs) + continue; + if (pending->path) { + struct type_and_oid_list *list; + char *path = pending->path; + if (!(list = strmap_get(&ctx->paths_to_lists, path))) { + CALLOC_ARRAY(list, 1); + list->type = OBJ_BLOB; + strmap_put(&ctx->paths_to_lists, path, list); + } + oid_array_append(&list->oids, &obj->oid); + } else { + /* assume a root tree, such as a lightweight tag. */ + oid_array_append(&tagged_blobs->oids, &obj->oid); + } + break; + + case OBJ_COMMIT: + /* Make sure it is in the object walk */ + if (obj != pending->item) + add_pending_object(info->revs, obj, ""); + break; + + default: + BUG("should not see any other type here"); + } + } + + /* + * Add tag objects and tagged blobs if they exist. + */ + if (tagged_blobs) { + if (tagged_blobs->oids.nr) { + const char *tagged_blob_path = "/tagged-blobs"; + tagged_blobs->type = OBJ_BLOB; + push_to_stack(ctx, tagged_blob_path); + strmap_put(&ctx->paths_to_lists, tagged_blob_path, tagged_blobs); + } else { + oid_array_clear(&tagged_blobs->oids); + free(tagged_blobs); + } + } + if (tags) { + if (tags->oids.nr) { + const char *tag_path = "/tags"; + tags->type = OBJ_TAG; + push_to_stack(ctx, tag_path); + strmap_put(&ctx->paths_to_lists, tag_path, tags); + } else { + oid_array_clear(&tags->oids); + free(tags); + } + } +} + /** * Given the configuration of 'info', walk the commits based on 'info->revs' and * call 'info->path_fn' on each discovered path. @@ -202,7 +337,6 @@ static void clear_strmap(struct strmap *map) */ int walk_objects_by_path(struct path_walk_info *info) { - const char *root_path = ""; int ret = 0; size_t commits_nr = 0, paths_nr = 0; struct commit *c; @@ -222,15 +356,31 @@ int walk_objects_by_path(struct path_walk_info *info) CALLOC_ARRAY(commit_list, 1); commit_list->type = OBJ_COMMIT; + if (info->tags) + info->revs->tag_objects = 1; + /* Insert a single list for the root tree into the paths. */ CALLOC_ARRAY(root_tree_list, 1); root_tree_list->type = OBJ_TREE; strmap_put(&ctx.paths_to_lists, root_path, root_tree_list); push_to_stack(&ctx, root_path); + /* + * Set these values before preparing the walk to catch + * lightweight tags pointing to non-commits and indexed objects. + */ + info->revs->blob_objects = info->blobs; + info->revs->tree_objects = info->trees; + if (prepare_revision_walk(info->revs)) die(_("failed to setup revision walk")); + info->revs->blob_objects = info->revs->tree_objects = 0; + + trace2_region_enter("path-walk", "pending-walk", info->revs->repo); + setup_pending_objects(info, &ctx); + trace2_region_leave("path-walk", "pending-walk", info->revs->repo); + while ((c = get_revision(info->revs))) { struct object_id *oid; struct tree *t; @@ -278,6 +428,26 @@ int walk_objects_by_path(struct path_walk_info *info) free(path); } + + /* Are there paths remaining? Likely they are from indexed objects. */ + if (!strmap_empty(&ctx.paths_to_lists)) { + struct hashmap_iter iter; + struct strmap_entry *entry; + + strmap_for_each_entry(&ctx.paths_to_lists, &iter, entry) + push_to_stack(&ctx, entry->key); + + while (!ret && ctx.path_stack.nr) { + char *path = ctx.path_stack.items[ctx.path_stack.nr - 1].string; + ctx.path_stack.nr--; + paths_nr++; + + ret = walk_path(&ctx, path); + + free(path); + } + } + trace2_data_intmax("path-walk", ctx.repo, "paths", paths_nr); trace2_region_leave("path-walk", "path-walk", info->revs->repo); diff --git a/path-walk.h b/path-walk.h index 2d2afc29b47..ca839f873e4 100644 --- a/path-walk.h +++ b/path-walk.h @@ -38,12 +38,14 @@ struct path_walk_info { int commits; int trees; int blobs; + int tags; }; #define PATH_WALK_INFO_INIT { \ .blobs = 1, \ .trees = 1, \ .commits = 1, \ + .tags = 1, \ } /** diff --git a/t/helper/test-path-walk.c b/t/helper/test-path-walk.c index 2b7e6e98d18..265bd0b443b 100644 --- a/t/helper/test-path-walk.c +++ b/t/helper/test-path-walk.c @@ -23,6 +23,7 @@ struct path_walk_test_data { uintmax_t commit_nr; uintmax_t tree_nr; uintmax_t blob_nr; + uintmax_t tag_nr; }; static int emit_block(const char *path, struct oid_array *oids, @@ -47,10 +48,20 @@ static int emit_block(const char *path, struct oid_array *oids, tdata->blob_nr += oids->nr; break; + case OBJ_TAG: + typestr = "TAG"; + tdata->tag_nr += oids->nr; + break; + default: BUG("we do not understand this type"); } + /* This should never be output during tests. */ + if (!oids->nr) + printf("%"PRIuMAX":%s:%s:EMPTY\n", + tdata->batch_nr, typestr, path); + for (size_t i = 0; i < oids->nr; i++) printf("%"PRIuMAX":%s:%s:%s\n", tdata->batch_nr, typestr, path, @@ -71,6 +82,8 @@ int cmd__path_walk(int argc, const char **argv) N_("toggle inclusion of blob objects")), OPT_BOOL(0, "commits", &info.commits, N_("toggle inclusion of commit objects")), + OPT_BOOL(0, "tags", &info.tags, + N_("toggle inclusion of tag objects")), OPT_BOOL(0, "trees", &info.trees, N_("toggle inclusion of tree objects")), OPT_END(), @@ -96,8 +109,9 @@ int cmd__path_walk(int argc, const char **argv) printf("commits:%" PRIuMAX "\n" "trees:%" PRIuMAX "\n" - "blobs:%" PRIuMAX "\n", - data.commit_nr, data.tree_nr, data.blob_nr); + "blobs:%" PRIuMAX "\n" + "tags:%" PRIuMAX "\n", + data.commit_nr, data.tree_nr, data.blob_nr, data.tag_nr); release_revisions(&revs); return res; diff --git a/t/t6601-path-walk.sh b/t/t6601-path-walk.sh index dcd3c03a2e8..bf43ab0e22a 100755 --- a/t/t6601-path-walk.sh +++ b/t/t6601-path-walk.sh @@ -9,29 +9,142 @@ test_description='direct path-walk API tests' test_expect_success 'setup test repository' ' git checkout -b base && + # Make some objects that will only be reachable + # via non-commit tags. + mkdir child && + echo file >child/file && + git add child && + git commit -m "will abandon" && + git tag -a -m "tree" tree-tag HEAD^{tree} && + echo file2 >file2 && + git add file2 && + git commit --amend -m "will abandon" && + git tag tree-tag2 HEAD^{tree} && + + echo blob >file && + blob_oid=$(git hash-object -t blob -w --stdin file2 && + blob2_oid=$(git hash-object -t blob -w --stdin a && echo b >left/b && echo c >right/c && git add . && - git commit -m "first" && + git commit --amend -m "first" && + git tag -m "first" first HEAD && echo d >right/d && git add right && git commit -m "second" && + git tag -a -m "second (under)" second.1 HEAD && + git tag -a -m "second (top)" second.2 second.1 && + # Set up file/dir collision in history. + rm a && + mkdir a && + echo a >a/a && echo bb >left/b && - git commit -a -m "third" && + git add a left && + git commit -m "third" && + git tag -a -m "third" third && git checkout -b topic HEAD~1 && echo cc >right/c && - git commit -a -m "topic" + git commit -a -m "topic" && + git tag -a -m "fourth" fourth ' test_expect_success 'all' ' test-tool path-walk -- --all >out && + cat >expect <<-EOF && + 0:COMMIT::$(git rev-parse topic) + 0:COMMIT::$(git rev-parse base) + 0:COMMIT::$(git rev-parse base~1) + 0:COMMIT::$(git rev-parse base~2) + 1:TAG:/tags:$(git rev-parse refs/tags/first) + 1:TAG:/tags:$(git rev-parse refs/tags/second.1) + 1:TAG:/tags:$(git rev-parse refs/tags/second.2) + 1:TAG:/tags:$(git rev-parse refs/tags/third) + 1:TAG:/tags:$(git rev-parse refs/tags/fourth) + 1:TAG:/tags:$(git rev-parse refs/tags/tree-tag) + 1:TAG:/tags:$(git rev-parse refs/tags/blob-tag) + 2:BLOB:/tagged-blobs:$(git rev-parse refs/tags/blob-tag^{}) + 2:BLOB:/tagged-blobs:$(git rev-parse refs/tags/blob-tag2^{}) + 3:TREE::$(git rev-parse topic^{tree}) + 3:TREE::$(git rev-parse base^{tree}) + 3:TREE::$(git rev-parse base~1^{tree}) + 3:TREE::$(git rev-parse base~2^{tree}) + 3:TREE::$(git rev-parse refs/tags/tree-tag^{}) + 3:TREE::$(git rev-parse refs/tags/tree-tag2^{}) + 4:BLOB:a:$(git rev-parse base~2:a) + 5:TREE:right/:$(git rev-parse topic:right) + 5:TREE:right/:$(git rev-parse base~1:right) + 5:TREE:right/:$(git rev-parse base~2:right) + 6:BLOB:right/d:$(git rev-parse base~1:right/d) + 7:BLOB:right/c:$(git rev-parse base~2:right/c) + 7:BLOB:right/c:$(git rev-parse topic:right/c) + 8:TREE:left/:$(git rev-parse base:left) + 8:TREE:left/:$(git rev-parse base~2:left) + 9:BLOB:left/b:$(git rev-parse base~2:left/b) + 9:BLOB:left/b:$(git rev-parse base:left/b) + 10:TREE:a/:$(git rev-parse base:a) + 11:BLOB:file2:$(git rev-parse refs/tags/tree-tag2^{}:file2) + 12:TREE:child/:$(git rev-parse refs/tags/tree-tag:child) + 13:BLOB:child/file:$(git rev-parse refs/tags/tree-tag:child/file) + blobs:10 + commits:4 + tags:7 + trees:13 + EOF + + test_cmp_sorted expect out +' + +test_expect_success 'indexed objects' ' + test_when_finished git reset --hard && + + # stage change into index, adding a blob but + # also invalidating the cache-tree for the root + # and the "left" directory. + echo bogus >left/c && + git add left && + + test-tool path-walk -- --indexed-objects >out && + + cat >expect <<-EOF && + 0:BLOB:a:$(git rev-parse HEAD:a) + 1:BLOB:left/b:$(git rev-parse HEAD:left/b) + 2:BLOB:left/c:$(git rev-parse :left/c) + 3:BLOB:right/c:$(git rev-parse HEAD:right/c) + 4:BLOB:right/d:$(git rev-parse HEAD:right/d) + 5:TREE:right/:$(git rev-parse topic:right) + blobs:5 + commits:0 + tags:0 + trees:1 + EOF + + test_cmp_sorted expect out +' + +test_expect_success 'branches and indexed objects mix well' ' + test_when_finished git reset --hard && + + # stage change into index, adding a blob but + # also invalidating the cache-tree for the root + # and the "right" directory. + echo fake >right/d && + git add right && + + test-tool path-walk -- --indexed-objects --branches >out && + cat >expect <<-EOF && 0:COMMIT::$(git rev-parse topic) 0:COMMIT::$(git rev-parse base) @@ -41,20 +154,23 @@ test_expect_success 'all' ' 1:TREE::$(git rev-parse base^{tree}) 1:TREE::$(git rev-parse base~1^{tree}) 1:TREE::$(git rev-parse base~2^{tree}) - 2:TREE:right/:$(git rev-parse topic:right) - 2:TREE:right/:$(git rev-parse base~1:right) - 2:TREE:right/:$(git rev-parse base~2:right) - 3:BLOB:right/d:$(git rev-parse base~1:right/d) - 4:BLOB:right/c:$(git rev-parse base~2:right/c) - 4:BLOB:right/c:$(git rev-parse topic:right/c) - 5:TREE:left/:$(git rev-parse base:left) - 5:TREE:left/:$(git rev-parse base~2:left) - 6:BLOB:left/b:$(git rev-parse base~2:left/b) - 6:BLOB:left/b:$(git rev-parse base:left/b) - 7:BLOB:a:$(git rev-parse base~2:a) - blobs:6 + 2:BLOB:a:$(git rev-parse base~2:a) + 3:TREE:right/:$(git rev-parse topic:right) + 3:TREE:right/:$(git rev-parse base~1:right) + 3:TREE:right/:$(git rev-parse base~2:right) + 4:BLOB:right/d:$(git rev-parse base~1:right/d) + 4:BLOB:right/d:$(git rev-parse :right/d) + 5:BLOB:right/c:$(git rev-parse base~2:right/c) + 5:BLOB:right/c:$(git rev-parse topic:right/c) + 6:TREE:left/:$(git rev-parse base:left) + 6:TREE:left/:$(git rev-parse base~2:left) + 7:BLOB:left/b:$(git rev-parse base:left/b) + 7:BLOB:left/b:$(git rev-parse base~2:left/b) + 8:TREE:a/:$(git rev-parse refs/tags/third:a) + blobs:7 commits:4 - trees:9 + tags:0 + trees:10 EOF test_cmp_sorted expect out @@ -81,6 +197,7 @@ test_expect_success 'topic only' ' 7:BLOB:a:$(git rev-parse base~2:a) blobs:5 commits:3 + tags:0 trees:7 EOF @@ -101,6 +218,7 @@ test_expect_success 'topic, not base' ' 7:BLOB:a:$(git rev-parse topic:a) blobs:4 commits:1 + tags:0 trees:3 EOF @@ -112,13 +230,14 @@ test_expect_success 'topic, not base, only blobs' ' -- topic --not base >out && cat >expect <<-EOF && - commits:0 - trees:0 0:BLOB:right/d:$(git rev-parse topic:right/d) 1:BLOB:right/c:$(git rev-parse topic:right/c) 2:BLOB:left/b:$(git rev-parse topic:left/b) 3:BLOB:a:$(git rev-parse topic:a) blobs:4 + commits:0 + tags:0 + trees:0 EOF test_cmp_sorted expect out @@ -133,8 +252,9 @@ test_expect_success 'topic, not base, only commits' ' cat >expect <<-EOF && 0:COMMIT::$(git rev-parse topic) commits:1 - trees:0 blobs:0 + tags:0 + trees:0 EOF test_cmp_sorted expect out @@ -145,12 +265,13 @@ test_expect_success 'topic, not base, only trees' ' -- topic --not base >out && cat >expect <<-EOF && - commits:0 0:TREE::$(git rev-parse topic^{tree}) 1:TREE:right/:$(git rev-parse topic:right) 2:TREE:left/:$(git rev-parse topic:left) - trees:3 + commits:0 blobs:0 + tags:0 + trees:3 EOF test_cmp_sorted expect out @@ -174,10 +295,33 @@ test_expect_success 'topic, not base, boundary' ' 7:BLOB:a:$(git rev-parse base~1:a) blobs:5 commits:2 + tags:0 trees:5 EOF test_cmp_sorted expect out ' +test_expect_success 'trees are reported exactly once' ' + test_when_finished "rm -rf unique-trees" && + test_create_repo unique-trees && + ( + cd unique-trees && + mkdir initial && + test_commit initial/file && + + git switch -c move-to-top && + git mv initial/file.t ./ && + test_tick && + git commit -m moved && + + git update-ref refs/heads/other HEAD + ) && + + test-tool -C unique-trees path-walk -- --all >out && + tree=$(git -C unique-trees rev-parse HEAD:) && + grep "$tree" out >out-filtered && + test_line_count = 1 out-filtered +' + test_done From patchwork Sat Nov 9 19:41:12 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Derrick Stolee X-Patchwork-Id: 13869710 Received: from mail-wm1-f47.google.com (mail-wm1-f47.google.com [209.85.128.47]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id B27481A262A for ; Sat, 9 Nov 2024 19:41:24 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.47 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731181286; cv=none; b=f+zFWjTbcjwqj9Tf/lk1kbuVibFObZ+nijwjynlFZsJYMyqDKZABQa1T3JFMkKRORU9hN1pO1As+jfgGfqt5h70VZcVGXy/6kV8wvQ0R72/pF9T2Ir4YSBxF7YsFAyJkcvH/7uA3xS0+XtsK/QE9840xrd+r5ysWMbviNHa1H4A= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731181286; c=relaxed/simple; bh=Ie08kIgiQaGBVuzd23wXE3upY+qBECOiNgI8xKAx6Pc=; h=Message-Id:In-Reply-To:References:From:Date:Subject:Content-Type: MIME-Version:To:Cc; b=cCIgKop67m/Hf59iZWwtm8nW+v5erwCQHezzsx3SO9NYJyWdpNqB6mFlyp+mItz9z/dy2waHDmv74TlfExZ+5n8RpwGHPOIBnQrBlNlif7P0gxQhptvCqWpBJdKrEe63RuZmo4aKfEbhmDBkwXn1/MZCbERVLClZSpOejjDEkTk= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=TbFmBk0A; arc=none smtp.client-ip=209.85.128.47 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="TbFmBk0A" Received: by mail-wm1-f47.google.com with SMTP id 5b1f17b1804b1-4315eeb2601so39811985e9.2 for ; Sat, 09 Nov 2024 11:41:24 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1731181282; x=1731786082; darn=vger.kernel.org; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=tLFT/VSU03/ZBWro0ppu7EqnscWtnVkhTdodi8DvWM8=; b=TbFmBk0AsCjAVCKDElVk5jvHSQrg8v7xQCwrzBSBhIgRq5G6gKmzt/77/aGbwFH3D0 VSFfgDCYbmzIdgcvuPwDdT1mL2QjdFmafnI+YAMl4gdmjFOt6h+oNPGJ5gYEsLDK8u60 HVwATNfAEl5zCHtfdAVP+YamMDXY1vphOEfS5VsrR4i4aIic9UKv8rDMAkKhylOjb6Ti HrNUbDj8lbUXC20cuTBjrx4O/+sHs3nxP1Mqu/EUICvBnGb+kJlqQnCoJZvV5PYmsu6U Bn4JcDB//bYO9Dd+WGH5maFzv6+ziwBsmvz+bz5VYCMl/0mRt4hxUu4zTABSPh4jjqXN CHhA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1731181282; x=1731786082; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=tLFT/VSU03/ZBWro0ppu7EqnscWtnVkhTdodi8DvWM8=; b=msNmWsAsHWphB5nbRLyNVIwzGoj5O3ZVVtpWxyYu3qQiiNGry3rInO+KsrN0sHhVEr x6Mvdpgr9ddyZHLZbL/KMRdjuJfaC3eoUfsf4MAbh6KX2ypEmgZEZH2zKKhhdEy362OS Xpq7VHFffkMzSU0um+aRMFW7P2g6CBi2ZL2O+X4dNSZ3kb/SkgPVknc5BT0Jb7Sht+ja kmvts0d+Z7Gs3Ny4WeN0U9gs6y0jd1ra1jUmrDYoMnFumJlMI65xTOLXqxk273ulRQgi 28K7e1vako+L0VaHfkO65Vqo+2Z8HQScXE/YxEk7Pj4n1+dlXS+bSDqoZL6l0FPSlZ7E rrRA== X-Gm-Message-State: AOJu0Yx1OSln2W7J4JmtX5SYQAaFcPhJ4wzij6PY53XzjfagfPRQ79VK URURWBaIYf3TyIxza55RzYO/z9rWBwU0xTr/FZ6MRPbuz5AdEF+wuAXgaA== X-Google-Smtp-Source: AGHT+IH/1ihuADUiZhfIJw2vQnEa62OIhD29OhkOOwLfuxAona6XkjQkcRtJO/d8/cIf+f+EJ03+mA== X-Received: by 2002:a05:6000:385:b0:37d:4a16:81d7 with SMTP id ffacd0b85a97d-381f1866abfmr7151644f8f.8.1731181281787; Sat, 09 Nov 2024 11:41:21 -0800 (PST) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-381ed97ce1bsm8461567f8f.36.2024.11.09.11.41.20 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 09 Nov 2024 11:41:20 -0800 (PST) Message-Id: In-Reply-To: References: Date: Sat, 09 Nov 2024 19:41:12 +0000 Subject: [PATCH v2 6/6] path-walk: mark trees and blobs as UNINTERESTING Fcc: Sent Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 To: git@vger.kernel.org Cc: gitster@pobox.com, johannes.schindelin@gmx.de, peff@peff.net, ps@pks.im, me@ttaylorr.com, johncai86@gmail.com, newren@gmail.com, christian.couder@gmail.com, kristofferhaugsbakk@fastmail.com, jonathantanmy@google.com, karthik nayak , Derrick Stolee , Derrick Stolee From: Derrick Stolee From: Derrick Stolee When the input rev_info has UNINTERESTING starting points, we want to be sure that the UNINTERESTING flag is passed appropriately through the objects. To match how this is done in places such as 'git pack-objects', we use the mark_edges_uninteresting() method. This method has an option for using the "sparse" walk, which is similar in spirit to the path-walk API's walk. To be sure to keep it independent, add a new 'prune_all_uninteresting' option to the path_walk_info struct. To check how the UNINTERSTING flag is spread through our objects, extend the 'test-tool path-walk' command to output whether or not an object has that flag. This changes our tests significantly, including the removal of some objects that were previously visited due to the incomplete implementation. Signed-off-by: Derrick Stolee --- Documentation/technical/api-path-walk.txt | 8 +++ path-walk.c | 73 +++++++++++++++++++++ path-walk.h | 8 +++ t/helper/test-path-walk.c | 12 +++- t/t6601-path-walk.sh | 79 +++++++++++++++++------ 5 files changed, 158 insertions(+), 22 deletions(-) diff --git a/Documentation/technical/api-path-walk.txt b/Documentation/technical/api-path-walk.txt index 6022c381b7c..7075d0d5ab5 100644 --- a/Documentation/technical/api-path-walk.txt +++ b/Documentation/technical/api-path-walk.txt @@ -48,6 +48,14 @@ commits. While it is possible to walk only commits in this way, consumers would be better off using the revision walk API instead. +`prune_all_uninteresting`:: + By default, all reachable paths are emitted by the path-walk API. + This option allows consumers to declare that they are not + interested in paths where all included objects are marked with the + `UNINTERESTING` flag. This requires using the `boundary` option in + the revision walk so that the walk emits commits marked with the + `UNINTERESTING` flag. + Examples -------- diff --git a/path-walk.c b/path-walk.c index a1f539dcd46..896ec0c4779 100644 --- a/path-walk.c +++ b/path-walk.c @@ -8,6 +8,7 @@ #include "dir.h" #include "hashmap.h" #include "hex.h" +#include "list-objects.h" #include "object.h" #include "oid-array.h" #include "revision.h" @@ -24,6 +25,7 @@ struct type_and_oid_list { enum object_type type; struct oid_array oids; + int maybe_interesting; }; #define TYPE_AND_OID_LIST_INIT { \ @@ -140,6 +142,9 @@ static int add_children(struct path_walk_context *ctx, if (o->flags & SEEN) continue; o->flags |= SEEN; + + if (!(o->flags & UNINTERESTING)) + list->maybe_interesting = 1; oid_array_append(&list->oids, &entry.oid); } @@ -167,6 +172,43 @@ static int walk_path(struct path_walk_context *ctx, if (!list->oids.nr) return 0; + if (ctx->info->prune_all_uninteresting) { + /* + * This is true if all objects were UNINTERESTING + * when added to the list. + */ + if (!list->maybe_interesting) + return 0; + + /* + * But it's still possible that the objects were set + * as UNINTERESTING after being added. Do a quick check. + */ + list->maybe_interesting = 0; + for (size_t i = 0; + !list->maybe_interesting && i < list->oids.nr; + i++) { + if (list->type == OBJ_TREE) { + struct tree *t = lookup_tree(ctx->repo, + &list->oids.oid[i]); + if (t && !(t->object.flags & UNINTERESTING)) + list->maybe_interesting = 1; + } else if (list->type == OBJ_BLOB) { + struct blob *b = lookup_blob(ctx->repo, + &list->oids.oid[i]); + if (b && !(b->object.flags & UNINTERESTING)) + list->maybe_interesting = 1; + } else { + /* Tags are always interesting if visited. */ + list->maybe_interesting = 1; + } + } + + /* We have confirmed that all objects are UNINTERESTING. */ + if (!list->maybe_interesting) + return 0; + } + /* Evaluate function pointer on this data, if requested. */ if ((list->type == OBJ_TREE && ctx->info->trees) || (list->type == OBJ_BLOB && ctx->info->blobs) || @@ -201,6 +243,26 @@ static void clear_strmap(struct strmap *map) strmap_init(map); } +static struct repository *edge_repo; +static struct type_and_oid_list *edge_tree_list; + +static void show_edge(struct commit *commit) +{ + struct tree *t = repo_get_commit_tree(edge_repo, commit); + + if (!t) + return; + + if (commit->object.flags & UNINTERESTING) + t->object.flags |= UNINTERESTING; + + if (t->object.flags & SEEN) + return; + t->object.flags |= SEEN; + + oid_array_append(&edge_tree_list->oids, &t->object.oid); +} + static void setup_pending_objects(struct path_walk_info *info, struct path_walk_context *ctx) { @@ -309,6 +371,7 @@ static void setup_pending_objects(struct path_walk_info *info, if (tagged_blobs->oids.nr) { const char *tagged_blob_path = "/tagged-blobs"; tagged_blobs->type = OBJ_BLOB; + tagged_blobs->maybe_interesting = 1; push_to_stack(ctx, tagged_blob_path); strmap_put(&ctx->paths_to_lists, tagged_blob_path, tagged_blobs); } else { @@ -320,6 +383,7 @@ static void setup_pending_objects(struct path_walk_info *info, if (tags->oids.nr) { const char *tag_path = "/tags"; tags->type = OBJ_TAG; + tags->maybe_interesting = 1; push_to_stack(ctx, tag_path); strmap_put(&ctx->paths_to_lists, tag_path, tags); } else { @@ -362,6 +426,7 @@ int walk_objects_by_path(struct path_walk_info *info) /* Insert a single list for the root tree into the paths. */ CALLOC_ARRAY(root_tree_list, 1); root_tree_list->type = OBJ_TREE; + root_tree_list->maybe_interesting = 1; strmap_put(&ctx.paths_to_lists, root_path, root_tree_list); push_to_stack(&ctx, root_path); @@ -375,6 +440,14 @@ int walk_objects_by_path(struct path_walk_info *info) if (prepare_revision_walk(info->revs)) die(_("failed to setup revision walk")); + /* Walk trees to mark them as UNINTERESTING. */ + edge_repo = info->revs->repo; + edge_tree_list = root_tree_list; + mark_edges_uninteresting(info->revs, show_edge, + info->prune_all_uninteresting); + edge_repo = NULL; + edge_tree_list = NULL; + info->revs->blob_objects = info->revs->tree_objects = 0; trace2_region_enter("path-walk", "pending-walk", info->revs->repo); diff --git a/path-walk.h b/path-walk.h index ca839f873e4..de0db007dc9 100644 --- a/path-walk.h +++ b/path-walk.h @@ -39,6 +39,14 @@ struct path_walk_info { int trees; int blobs; int tags; + + /** + * When 'prune_all_uninteresting' is set and a path has all objects + * marked as UNINTERESTING, then the path-walk will not visit those + * objects. It will not call path_fn on those objects and will not + * walk the children of such trees. + */ + int prune_all_uninteresting; }; #define PATH_WALK_INFO_INIT { \ diff --git a/t/helper/test-path-walk.c b/t/helper/test-path-walk.c index 265bd0b443b..7e791cfaf97 100644 --- a/t/helper/test-path-walk.c +++ b/t/helper/test-path-walk.c @@ -62,10 +62,14 @@ static int emit_block(const char *path, struct oid_array *oids, printf("%"PRIuMAX":%s:%s:EMPTY\n", tdata->batch_nr, typestr, path); - for (size_t i = 0; i < oids->nr; i++) - printf("%"PRIuMAX":%s:%s:%s\n", + for (size_t i = 0; i < oids->nr; i++) { + struct object *o = lookup_unknown_object(the_repository, + &oids->oid[i]); + printf("%"PRIuMAX":%s:%s:%s%s\n", tdata->batch_nr, typestr, path, - oid_to_hex(&oids->oid[i])); + oid_to_hex(&oids->oid[i]), + o->flags & UNINTERESTING ? ":UNINTERESTING" : ""); + } tdata->batch_nr++; return 0; @@ -86,6 +90,8 @@ int cmd__path_walk(int argc, const char **argv) N_("toggle inclusion of tag objects")), OPT_BOOL(0, "trees", &info.trees, N_("toggle inclusion of tree objects")), + OPT_BOOL(0, "prune", &info.prune_all_uninteresting, + N_("toggle pruning of uninteresting paths")), OPT_END(), }; diff --git a/t/t6601-path-walk.sh b/t/t6601-path-walk.sh index bf43ab0e22a..d3c0015319a 100755 --- a/t/t6601-path-walk.sh +++ b/t/t6601-path-walk.sh @@ -211,11 +211,11 @@ test_expect_success 'topic, not base' ' 0:COMMIT::$(git rev-parse topic) 1:TREE::$(git rev-parse topic^{tree}) 2:TREE:right/:$(git rev-parse topic:right) - 3:BLOB:right/d:$(git rev-parse topic:right/d) + 3:BLOB:right/d:$(git rev-parse topic:right/d):UNINTERESTING 4:BLOB:right/c:$(git rev-parse topic:right/c) - 5:TREE:left/:$(git rev-parse topic:left) - 6:BLOB:left/b:$(git rev-parse topic:left/b) - 7:BLOB:a:$(git rev-parse topic:a) + 5:TREE:left/:$(git rev-parse topic:left):UNINTERESTING + 6:BLOB:left/b:$(git rev-parse topic:left/b):UNINTERESTING + 7:BLOB:a:$(git rev-parse topic:a):UNINTERESTING blobs:4 commits:1 tags:0 @@ -225,15 +225,38 @@ test_expect_success 'topic, not base' ' test_cmp_sorted expect out ' +test_expect_success 'fourth, blob-tag2, not base' ' + test-tool path-walk -- fourth blob-tag2 --not base >out && + + cat >expect <<-EOF && + 0:COMMIT::$(git rev-parse topic) + 1:TAG:/tags:$(git rev-parse fourth) + 2:BLOB:/tagged-blobs:$(git rev-parse refs/tags/blob-tag2^{}) + 3:TREE::$(git rev-parse topic^{tree}) + 4:TREE:right/:$(git rev-parse topic:right) + 5:BLOB:right/d:$(git rev-parse base~1:right/d):UNINTERESTING + 6:BLOB:right/c:$(git rev-parse topic:right/c) + 7:TREE:left/:$(git rev-parse base~1:left):UNINTERESTING + 8:BLOB:left/b:$(git rev-parse base~1:left/b):UNINTERESTING + 9:BLOB:a:$(git rev-parse base~1:a):UNINTERESTING + blobs:5 + commits:1 + tags:1 + trees:3 + EOF + + test_cmp_sorted expect out +' + test_expect_success 'topic, not base, only blobs' ' test-tool path-walk --no-trees --no-commits \ -- topic --not base >out && cat >expect <<-EOF && - 0:BLOB:right/d:$(git rev-parse topic:right/d) + 0:BLOB:right/d:$(git rev-parse topic:right/d):UNINTERESTING 1:BLOB:right/c:$(git rev-parse topic:right/c) - 2:BLOB:left/b:$(git rev-parse topic:left/b) - 3:BLOB:a:$(git rev-parse topic:a) + 2:BLOB:left/b:$(git rev-parse topic:left/b):UNINTERESTING + 3:BLOB:a:$(git rev-parse topic:a):UNINTERESTING blobs:4 commits:0 tags:0 @@ -267,7 +290,7 @@ test_expect_success 'topic, not base, only trees' ' cat >expect <<-EOF && 0:TREE::$(git rev-parse topic^{tree}) 1:TREE:right/:$(git rev-parse topic:right) - 2:TREE:left/:$(git rev-parse topic:left) + 2:TREE:left/:$(git rev-parse topic:left):UNINTERESTING commits:0 blobs:0 tags:0 @@ -282,17 +305,17 @@ test_expect_success 'topic, not base, boundary' ' cat >expect <<-EOF && 0:COMMIT::$(git rev-parse topic) - 0:COMMIT::$(git rev-parse base~1) + 0:COMMIT::$(git rev-parse base~1):UNINTERESTING 1:TREE::$(git rev-parse topic^{tree}) - 1:TREE::$(git rev-parse base~1^{tree}) + 1:TREE::$(git rev-parse base~1^{tree}):UNINTERESTING 2:TREE:right/:$(git rev-parse topic:right) - 2:TREE:right/:$(git rev-parse base~1:right) - 3:BLOB:right/d:$(git rev-parse base~1:right/d) - 4:BLOB:right/c:$(git rev-parse base~1:right/c) + 2:TREE:right/:$(git rev-parse base~1:right):UNINTERESTING + 3:BLOB:right/d:$(git rev-parse base~1:right/d):UNINTERESTING + 4:BLOB:right/c:$(git rev-parse base~1:right/c):UNINTERESTING 4:BLOB:right/c:$(git rev-parse topic:right/c) - 5:TREE:left/:$(git rev-parse base~1:left) - 6:BLOB:left/b:$(git rev-parse base~1:left/b) - 7:BLOB:a:$(git rev-parse base~1:a) + 5:TREE:left/:$(git rev-parse base~1:left):UNINTERESTING + 6:BLOB:left/b:$(git rev-parse base~1:left/b):UNINTERESTING + 7:BLOB:a:$(git rev-parse base~1:a):UNINTERESTING blobs:5 commits:2 tags:0 @@ -302,6 +325,27 @@ test_expect_success 'topic, not base, boundary' ' test_cmp_sorted expect out ' +test_expect_success 'topic, not base, boundary with pruning' ' + test-tool path-walk --prune -- --boundary topic --not base >out && + + cat >expect <<-EOF && + 0:COMMIT::$(git rev-parse topic) + 0:COMMIT::$(git rev-parse base~1):UNINTERESTING + 1:TREE::$(git rev-parse topic^{tree}) + 1:TREE::$(git rev-parse base~1^{tree}):UNINTERESTING + 2:TREE:right/:$(git rev-parse topic:right) + 2:TREE:right/:$(git rev-parse base~1:right):UNINTERESTING + 3:BLOB:right/c:$(git rev-parse base~1:right/c):UNINTERESTING + 3:BLOB:right/c:$(git rev-parse topic:right/c) + blobs:2 + commits:2 + tags:0 + trees:4 + EOF + + test_cmp_sorted expect out +' + test_expect_success 'trees are reported exactly once' ' test_when_finished "rm -rf unique-trees" && test_create_repo unique-trees && @@ -309,15 +353,12 @@ test_expect_success 'trees are reported exactly once' ' cd unique-trees && mkdir initial && test_commit initial/file && - git switch -c move-to-top && git mv initial/file.t ./ && test_tick && git commit -m moved && - git update-ref refs/heads/other HEAD ) && - test-tool -C unique-trees path-walk -- --all >out && tree=$(git -C unique-trees rev-parse HEAD:) && grep "$tree" out >out-filtered &&