From patchwork Wed Feb 16 00:53:27 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: John Cai X-Patchwork-Id: 12747766 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 5BF4AC433F5 for ; Wed, 16 Feb 2022 00:53:37 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S245176AbiBPAxq (ORCPT ); Tue, 15 Feb 2022 19:53:46 -0500 Received: from mxb-00190b01.gslb.pphosted.com ([23.128.96.19]:33980 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S236240AbiBPAxp (ORCPT ); Tue, 15 Feb 2022 19:53:45 -0500 Received: from mail-wr1-x42c.google.com (mail-wr1-x42c.google.com [IPv6:2a00:1450:4864:20::42c]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id C49D1C7D4F for ; Tue, 15 Feb 2022 16:53:33 -0800 (PST) Received: by mail-wr1-x42c.google.com with SMTP id q7so749237wrc.13 for ; Tue, 15 Feb 2022 16:53:33 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=message-id:in-reply-to:references:from:date:subject:fcc :content-transfer-encoding:mime-version:to:cc; bh=SNpIy/07GQZSBrZ5H2sk7/nd388dliKlQOi7EWsbFEw=; b=JnMBN6oaP5Y7ECnetei3gASVaTigmcPdil4sM+KFvgxWfpS86lmsBGfjA0ojpQOiES /YSiTFnPki03VJczMtmMbxrAxeDwbHGKvrHFBgkoc5YHy86HzT3hXKJyxtRsVUPoLF5T rb83ONaN7k43VWPPJFv2jmkydgbKG07Qh+ovH5AFAOB8fEf+dnfx8b7ctVsjHVxOaQWv x0rgc/Ix3C6A+4X5DmAGyf9ZfrsJK/PygQnMN14FbtvzB+rNTf4V/AuCdxgFxbe7/4fd GuP5QIf+9B1weq+W68M1oYMBTmcpH9Vmhjwir45i/r6/gA6givkSuJc85Tu870CwX9jr rhRw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:fcc:content-transfer-encoding:mime-version:to:cc; bh=SNpIy/07GQZSBrZ5H2sk7/nd388dliKlQOi7EWsbFEw=; b=mhRSJg/Ywvs2QAAAEUvGUjfYBy0+cW96vwD3EmnVmA2ZIQb/RB1Y7ozQU9vc1f5q6l +G8PoCaNTIptW7sVEH3zGBcEgF/2Eu/qWlY6HZavPR+/ZXnYjkD5zWlZD2o+wFFjUmH/ X3OwWuRZRkUR01Lw4V9xUc3jHR9b3E7p2fS7FrP4pMRbsMkHxgw3rUiCEkqvuw4TuoXH rh/pt+Rc9PpgznYvYa3bGBJ3X8t7VWT2mXpvfKUvPVXaZ1hJ8B0LCwJvgFcF3zeD5URH qQKTVsBfs2C3//8+m1e7WxgMOBY3VF6URZ1iL8WuRC8Vc96HP1gD5huNYMuqptMPpQq5 Tgog== X-Gm-Message-State: AOAM533hE3ffKd9V1HP5oEI3eC06H9TXUH8dToyoTnrec5Vi34Mb+SNB W0fWUSyfCf8wuM0MnKWrgp7I5aKnrO4= X-Google-Smtp-Source: ABdhPJzgF8uESX6RocpMOGAXjojpePN1nh0KogX1Ygcec2+n88morwQUGxSNFK7rxOe/HBGoIKDtNg== X-Received: by 2002:a5d:64c8:0:b0:1d9:1020:1b45 with SMTP id f8-20020a5d64c8000000b001d910201b45mr341912wri.393.1644972812085; Tue, 15 Feb 2022 16:53:32 -0800 (PST) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id p8sm27930522wro.106.2022.02.15.16.53.31 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 15 Feb 2022 16:53:31 -0800 (PST) Message-Id: In-Reply-To: References: Date: Wed, 16 Feb 2022 00:53:27 +0000 Subject: [PATCH v7 1/4] cat-file: rename cmdmode to transform_mode Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: me@ttaylorr.com, phillip.wood123@gmail.com, avarab@gmail.com, e@80x24.org, bagasdotme@gmail.com, gitster@pobox.com, Eric Sunshine , Jonathan Tan , Christian Couder , John Cai , John Cai Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: John Cai From: John Cai In the next patch, we will add an enum on the batch_options struct that indicates which type of batch operation will be used: --batch, --batch-check and the soon to be --batch-command that will read commands from stdin. --batch-command mode might get confused with the cmdmode flag. There is value in renaming cmdmode in any case. cmdmode refers to how the result output of the blob will be transformed, either according to --filter or --textconv. So transform_mode is a more descriptive name for the flag. Rename cmdmode to transform_mode in cat-file.c Signed-off-by: John Cai --- builtin/cat-file.c | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/builtin/cat-file.c b/builtin/cat-file.c index 7b3f42950ec..5f015e71096 100644 --- a/builtin/cat-file.c +++ b/builtin/cat-file.c @@ -24,7 +24,7 @@ struct batch_options { int buffer_output; int all_objects; int unordered; - int cmdmode; /* may be 'w' or 'c' for --filters or --textconv */ + int transform_mode; /* may be 'w' or 'c' for --filters or --textconv */ const char *format; }; @@ -302,19 +302,19 @@ static void print_object_or_die(struct batch_options *opt, struct expand_data *d if (data->type == OBJ_BLOB) { if (opt->buffer_output) fflush(stdout); - if (opt->cmdmode) { + if (opt->transform_mode) { char *contents; unsigned long size; if (!data->rest) die("missing path for '%s'", oid_to_hex(oid)); - if (opt->cmdmode == 'w') { + if (opt->transform_mode == 'w') { if (filter_object(data->rest, 0100644, oid, &contents, &size)) die("could not convert '%s' %s", oid_to_hex(oid), data->rest); - } else if (opt->cmdmode == 'c') { + } else if (opt->transform_mode == 'c') { enum object_type type; if (!textconv_object(the_repository, data->rest, 0100644, oid, @@ -326,7 +326,7 @@ static void print_object_or_die(struct batch_options *opt, struct expand_data *d die("could not convert '%s' %s", oid_to_hex(oid), data->rest); } else - BUG("invalid cmdmode: %c", opt->cmdmode); + BUG("invalid transform_mode: %c", opt->transform_mode); batch_write(opt, contents, size); free(contents); } else { @@ -529,7 +529,7 @@ static int batch_objects(struct batch_options *opt) strbuf_expand(&output, opt->format, expand_format, &data); data.mark_query = 0; strbuf_release(&output); - if (opt->cmdmode) + if (opt->transform_mode) data.split_on_whitespace = 1; /* @@ -742,7 +742,7 @@ int cmd_cat_file(int argc, const char **argv, const char *prefix) /* Return early if we're in batch mode? */ if (batch.enabled) { if (opt_cw) - batch.cmdmode = opt; + batch.transform_mode = opt; else if (opt && opt != 'b') usage_msg_optf(_("'-%c' is incompatible with batch mode"), usage, options, opt); From patchwork Wed Feb 16 00:53:28 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: John Cai X-Patchwork-Id: 12747768 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 0FD41C433FE for ; Wed, 16 Feb 2022 00:53:41 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S245184AbiBPAxu (ORCPT ); Tue, 15 Feb 2022 19:53:50 -0500 Received: from mxb-00190b01.gslb.pphosted.com ([23.128.96.19]:34050 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S236426AbiBPAxq (ORCPT ); Tue, 15 Feb 2022 19:53:46 -0500 Received: from mail-wr1-x431.google.com (mail-wr1-x431.google.com [IPv6:2a00:1450:4864:20::431]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 93075C7D5B for ; Tue, 15 Feb 2022 16:53:34 -0800 (PST) Received: by mail-wr1-x431.google.com with SMTP id o24so821720wro.3 for ; Tue, 15 Feb 2022 16:53:34 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=message-id:in-reply-to:references:from:date:subject:fcc :content-transfer-encoding:mime-version:to:cc; bh=ielkz8QHotBtE/FrvWE7acgciQk61gjydC4noInf6m0=; b=kQFTl2S0bimWNt2jTNg9zquLwLJIcHTXTOvKwpKc7wBSJEIz25ImelXO46bh6ZItTq wE+i3yAMSi6Nrf6YnGvsueaXR3FpXU47wdYBnMCYeKzY8UgE4WXlW6EUU+kA84ByKKSn B5M5NhJay8MjjJ4QdD/h5DhgJZoe2vvCY7NipZMg4feEUlslOvbcFZqBqrRfP9m489Z6 +d3WXbJOXE4CApk++ko/oThJCd7PGmomxVGQ7ScaJctiTlHmAyzhMtRB2l6Buc//NMLH +GQQpcEaIhIelVHSUgaRYW4W/Ah5DWZXNKlBu1N2MeQE/WCgS5WSGyjjPTJ0Sv2iCE0q CiMA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:fcc:content-transfer-encoding:mime-version:to:cc; bh=ielkz8QHotBtE/FrvWE7acgciQk61gjydC4noInf6m0=; b=JlmZ4kMNTC7Te78wigud4HUfp4cHb0LNCOdlWiezuiksXj1ePU4LKvZfIxea0M8jq4 pHbCPQDVJvU+ktt5xYjVE8M3ohtcHKuSeAe2spuZkfGPpF9Mxx3rL4VWt/v7hJd8e9u5 5Rm5/UA1pN0AMxG7xfe6wdB14ULyU6gPNlPw2LsejAMl4dorUgkJESIhTHE7Xc6A8qtu +DxUvE9cmfouZzNBHqAPHe63xF5VAI2vY0L/z1Wcil/9Sj40t/0oeH1i6R38IlbsMaP/ 3J6b3qjxiTTIyUCLRLmeOOpaVwsJY1UxgsaytBllhAArKHorn2A2wxaNBBdu5lFJhlgf 3E4A== X-Gm-Message-State: AOAM5305Nxwe6CcVJ33BN3alMy/V2jFV3a9KnUD59EcWF5JJYxxLRSE0 E74+KsOCkY9kPcIPqmZQksZWlpR+Bws= X-Google-Smtp-Source: ABdhPJzKt5r0XdO6qARLv4fLZYf02CtvuBQZDg08Th4hEtotv1eNjp+89MaizLQ5L5WaQScCCI+ITw== X-Received: by 2002:adf:f38b:0:b0:1e6:2961:99b2 with SMTP id m11-20020adff38b000000b001e6296199b2mr364673wro.700.1644972813038; Tue, 15 Feb 2022 16:53:33 -0800 (PST) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id y10sm16151500wmi.47.2022.02.15.16.53.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 15 Feb 2022 16:53:32 -0800 (PST) Message-Id: <1a038097bfc1e0e7dc7737e4fb664e8f79a2da50.1644972810.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Wed, 16 Feb 2022 00:53:28 +0000 Subject: [PATCH v7 2/4] cat-file: introduce batch_mode enum to replace print_contents Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: me@ttaylorr.com, phillip.wood123@gmail.com, avarab@gmail.com, e@80x24.org, bagasdotme@gmail.com, gitster@pobox.com, Eric Sunshine , Jonathan Tan , Christian Couder , John Cai , John Cai Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: John Cai From: John Cai A future patch introduces a new --batch-command flag. Including --batch and --batch-check, we will have a total of three batch modes. print_contents is the only boolean on the batch_options sturct used to distinguish between the different modes. This makes the code harder to read. To reduce potential confusion, replace print_contents with an enum to help readability and clarity. Helped-by: Junio C Hamano Signed-off-by: John Cai --- builtin/cat-file.c | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/builtin/cat-file.c b/builtin/cat-file.c index 5f015e71096..5e38af82af1 100644 --- a/builtin/cat-file.c +++ b/builtin/cat-file.c @@ -17,10 +17,15 @@ #include "object-store.h" #include "promisor-remote.h" +enum batch_mode { + BATCH_MODE_CONTENTS, + BATCH_MODE_INFO, +}; + struct batch_options { int enabled; int follow_symlinks; - int print_contents; + enum batch_mode batch_mode; int buffer_output; int all_objects; int unordered; @@ -386,7 +391,7 @@ static void batch_object_write(const char *obj_name, strbuf_addch(scratch, '\n'); batch_write(opt, scratch->buf, scratch->len); - if (opt->print_contents) { + if (opt->batch_mode == BATCH_MODE_CONTENTS) { print_object_or_die(opt, data); batch_write(opt, "\n", 1); } @@ -536,7 +541,7 @@ static int batch_objects(struct batch_options *opt) * If we are printing out the object, then always fill in the type, * since we will want to decide whether or not to stream. */ - if (opt->print_contents) + if (opt->batch_mode == BATCH_MODE_CONTENTS) data.info.typep = &data.type; if (opt->all_objects) { @@ -635,7 +640,14 @@ static int batch_option_callback(const struct option *opt, } bo->enabled = 1; - bo->print_contents = !strcmp(opt->long_name, "batch"); + + if (!strcmp(opt->long_name, "batch")) + bo->batch_mode = BATCH_MODE_CONTENTS; + else if (!strcmp(opt->long_name, "batch-check")) + bo->batch_mode = BATCH_MODE_INFO; + else + BUG("%s given to batch-option-callback", opt->long_name); + bo->format = arg; return 0; From patchwork Wed Feb 16 00:53:29 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: John Cai X-Patchwork-Id: 12747769 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 2FDE8C433F5 for ; Wed, 16 Feb 2022 00:53:44 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S245187AbiBPAxw (ORCPT ); Tue, 15 Feb 2022 19:53:52 -0500 Received: from mxb-00190b01.gslb.pphosted.com ([23.128.96.19]:34062 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S245154AbiBPAxq (ORCPT ); Tue, 15 Feb 2022 19:53:46 -0500 Received: from mail-wm1-x334.google.com (mail-wm1-x334.google.com [IPv6:2a00:1450:4864:20::334]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 48B16C7E65 for ; Tue, 15 Feb 2022 16:53:35 -0800 (PST) Received: by mail-wm1-x334.google.com with SMTP id k41so290556wms.0 for ; Tue, 15 Feb 2022 16:53:35 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=message-id:in-reply-to:references:from:date:subject:fcc :content-transfer-encoding:mime-version:to:cc; bh=UC9fF+KP+NxF+UpJJq9w730NXczpWlLCADgKQQkkAMM=; b=GiWoeH2mS7t2V3HD8F5l2FNNjArh5+dmM0wIQ0J3Tvn+VQ2l2guReJ7edRA0YV/gD5 +e+uMc7QmNLlouZq3BEBXA3vfyxe8uSp0y6JvT7eAXbCS7BaGzw8I8YWYylZRXbjRdbX MsGn7b/iw2JS5mMfNuH1yUlZjJbDFiWSSLb6vHaR6v1jSnP7habFPGXDA3P3uaGdsuNC ah38+vhFlBNXc83f6drfYtimhNB8Nvb8Luwu8HLru/HwhNchgbUgkMqN9vyJvbuN1TJy zlXxyWCfkKNvcsug+zju0S/BA+C1nOF9HE1jrqLw9KD7hYwNQkJiFmyruIEa75RvjDoV qNAw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:fcc:content-transfer-encoding:mime-version:to:cc; bh=UC9fF+KP+NxF+UpJJq9w730NXczpWlLCADgKQQkkAMM=; b=jf/phmAKWX7ViJNI9aElspDXHmjDXAnalcunJNffGLK1ajq188TZd0H1SkBkzZ8pe2 e8by2HIbkJqSX/bPlrLBBealyDTZq2RMHjrkUBwtMJm5EwQXVRpghs45HQ7fFm/Ty/IW Q6CPLe86OBlGBaGhnipd/Y4n/47e/2AvWKzLekukGDmAKepW8xLDBuNsE50ZcrVnb3f+ fuWGC6kYH1hAKGW3DyWEkw3Tv1EQTYMf0i8C4d9I3RMvUSWWlVTE0cWs5tw4Kr5HPbEu KQQqrmHkZICsYc07LiyrcGHn28Br0So9gmN4VFG22aTRa0KUL4be99YrtXXCKxNEzVTG mh3g== X-Gm-Message-State: AOAM532VrbuonqemaYSV8AjMMJqV8huqd0Itfn0gyzyljWwJ9EOsyx2O i7L792xkgo4Cvx7yy//vSG6GdZ8T7rY= X-Google-Smtp-Source: ABdhPJx680pmVGz0+y/K6nFKIdr99ihQGSLe62iVLOoxVQPBfOi1rcRT+/ghU3SLpFpEw6xJtcGO7g== X-Received: by 2002:a1c:7906:0:b0:37d:25c9:1c2a with SMTP id l6-20020a1c7906000000b0037d25c91c2amr5102865wme.112.1644972813744; Tue, 15 Feb 2022 16:53:33 -0800 (PST) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id p15sm19630939wma.27.2022.02.15.16.53.33 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 15 Feb 2022 16:53:33 -0800 (PST) Message-Id: <486ee84781679d587f137b9c24fb5377e4b138d8.1644972810.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Wed, 16 Feb 2022 00:53:29 +0000 Subject: [PATCH v7 3/4] cat-file: add remove_timestamp helper Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: me@ttaylorr.com, phillip.wood123@gmail.com, avarab@gmail.com, e@80x24.org, bagasdotme@gmail.com, gitster@pobox.com, Eric Sunshine , Jonathan Tan , Christian Couder , John Cai , John Cai Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: John Cai From: John Cai maybe_remove_timestamp() takes arguments, but it would be useful to have a function that reads from stdin and strips the timestamp. This would allow tests to pipe data into a function to remove timestamps, and wouldn't have to always assign a variable. This is especially helpful when the data is multiple lines. Keep maybe_remove_timestamp() the same, but add a remove_timestamp helper that reads from stdin. The tests in the next patch will make use of this. Signed-off-by: John Cai --- t/t1006-cat-file.sh | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/t/t1006-cat-file.sh b/t/t1006-cat-file.sh index 145eee11df9..2d52851dadc 100755 --- a/t/t1006-cat-file.sh +++ b/t/t1006-cat-file.sh @@ -105,13 +105,18 @@ strlen () { } maybe_remove_timestamp () { - if test -z "$2"; then - echo_without_newline "$1" - else - echo_without_newline "$(printf '%s\n' "$1" | sed -e 's/ [0-9][0-9]* [-+][0-9][0-9][0-9][0-9]$//')" - fi + if test -z "$2"; then + echo_without_newline "$1" + else + echo_without_newline "$(printf '%s\n' "$1" | remove_timestamp)" + fi } +remove_timestamp () { + sed -e 's/ [0-9][0-9]* [-+][0-9][0-9][0-9][0-9]$//' +} + + run_tests () { type=$1 sha1=$2 From patchwork Wed Feb 16 00:53:30 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: John Cai X-Patchwork-Id: 12747770 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 600CCC433F5 for ; Wed, 16 Feb 2022 00:53:50 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S245186AbiBPAx7 (ORCPT ); Tue, 15 Feb 2022 19:53:59 -0500 Received: from mxb-00190b01.gslb.pphosted.com ([23.128.96.19]:34278 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S245181AbiBPAxs (ORCPT ); Tue, 15 Feb 2022 19:53:48 -0500 Received: from mail-wr1-x434.google.com (mail-wr1-x434.google.com [IPv6:2a00:1450:4864:20::434]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 66139C7EB6 for ; Tue, 15 Feb 2022 16:53:36 -0800 (PST) Received: by mail-wr1-x434.google.com with SMTP id f3so633431wrh.7 for ; Tue, 15 Feb 2022 16:53:36 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=message-id:in-reply-to:references:from:date:subject:mime-version :content-transfer-encoding:fcc:to:cc; bh=9Vw9ds1NzISAf+JpueU92s4xMB6M+OCcFARo1CyWDWY=; b=I1l3DTP40j0Uxqm4YiLJ/7eiqNNawbt6bp4o1OkkLHno4qYcgP2nGrzkWWTh0SLtdL q3pXmbNgFnnbeBP1SZZ5mkKmLVVjOXETquHWc4tm3ufhBT65e7vufxeXbzxiuX06ric7 NfOmRUDFMBUwqxK0XxTUFug6bzUTxegYqtF7RN6EDfmz72WlH0G2lDIjfJb8XO9/6mNT VkCkMUoTYq/NFFdnNx/iWsIPOwtpw90AgGJT6Qx5RumzxOZ+l06mkuCQaDBMCOiukFcd sRKTpnPCCXiQ4Expnx06V4StGyM7SO3WZfkLmHexWBPKmeuC4TkQskc2b2yRI/OLRC08 IqGA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:mime-version:content-transfer-encoding:fcc:to:cc; bh=9Vw9ds1NzISAf+JpueU92s4xMB6M+OCcFARo1CyWDWY=; b=rrfqohdG5gbei0u+VBKnNPrGCGOZ6iB44cual+v500srygA7I2DdbNdeMQpDuivqmO mmQFCipx/wLu6lXAlWkXv6Bpsrprn15ZTQT6UDOXjXFnXazrffOPiF3O+71iG+oR7kf8 iyvDscfn2NpxBRVqQmDR5iaGFyvLyABMV7U/cp/NG8ZZRYWANAzmomlXc/bws8edaXBA EDhsGWevpio8KKIFB6wuan4Ni91liBGQIz1XtkAnhcltdZU1dG3hyuwKiBrBZuq3rZ/T M9rPGqhFx5VOjy0JBwcGS3W08S6Jge/5C3nkEHDOr/CnJdBf8B3Tnf+yjeiloql7Cy/f hMMg== X-Gm-Message-State: AOAM533OfLYAL8r16lOtj7NGtKj667CGH/8G7J7n4fGYkUe86Beszabl gxNL1w8+0jZm66I3Az4bhayW4+13CEY= X-Google-Smtp-Source: ABdhPJw+PxUApr4Scd74bWcIzOrjpoesd0fhJKgGLEs8i/OiMCEFyQosi4OJ3TZVJL8wbfpB4pHyzg== X-Received: by 2002:adf:ec90:0:b0:1e4:ae98:3635 with SMTP id z16-20020adfec90000000b001e4ae983635mr350721wrn.95.1644972814776; Tue, 15 Feb 2022 16:53:34 -0800 (PST) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id h17sm16066990wmm.15.2022.02.15.16.53.33 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 15 Feb 2022 16:53:34 -0800 (PST) Message-Id: In-Reply-To: References: Date: Wed, 16 Feb 2022 00:53:30 +0000 Subject: [PATCH v7 4/4] cat-file: add --batch-command mode MIME-Version: 1.0 Fcc: Sent To: git@vger.kernel.org Cc: me@ttaylorr.com, phillip.wood123@gmail.com, avarab@gmail.com, e@80x24.org, bagasdotme@gmail.com, gitster@pobox.com, Eric Sunshine , Jonathan Tan , Christian Couder , John Cai , John Cai Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: John Cai From: John Cai Add a new flag --batch-command that accepts commands and arguments from stdin, similar to git-update-ref --stdin. At GitLab, we use a pair of long running cat-file processes when accessing object content. One for iterating over object metadata with --batch-check, and the other to grab object contents with --batch. However, if we had --batch-command, we wouldn't need to keep both processes around, and instead just have one --batch-command process where we can flip between getting object info, and getting object contents. Since we have a pair of cat-file processes per repository, this means we can get rid of roughly half of long lived git cat-file processes. Given there are many repositories being accessed at any given time, this can lead to huge savings. git cat-file --batch-command will enter an interactive command mode whereby the user can enter in commands and their arguments that get queued in memory: [arg1] [arg2] LF [arg1] [arg2] LF When --buffer mode is used, commands will be queued in memory until a flush command is issued that execute them: flush LF The reason for a flush command is that when a consumer process (A) talks to a git cat-file process (B) and interactively writes to and reads from it in --buffer mode, (A) needs to be able to control when the buffer is flushed to stdout. Currently, from (A)'s perspective, the only way is to either 1. kill (B)'s process 2. send an invalid object to stdin. 1. is not ideal from a performance perspective as it will require spawning a new cat-file process each time, and 2. is hacky and not a good long term solution. With this mechanism of queueing up commands and letting (A) issue a flush command, process (A) can control when the buffer is flushed and can guarantee it will receive all of the output when in --buffer mode. --batch-command also will not allow (B) to flush to stdout until a flush is received. This patch adds the basic structure for adding command which can be extended in the future to add more commands. It also adds the following two commands (on top of the flush command): contents LF info LF The contents command takes an argument and prints out the object contents. The info command takes an argument and prints out the object metadata. These can be used in the following way with --buffer: info LF contents LF contents LF info LF flush LF info LF flush LF When used without --buffer: info LF contents LF contents LF info LF info LF Helped-by: Ævar Arnfjörð Bjarmason Signed-off-by: John Cai --- Documentation/git-cat-file.txt | 42 +++++++++- builtin/cat-file.c | 136 ++++++++++++++++++++++++++++++++- t/README | 3 + t/t1006-cat-file.sh | 107 +++++++++++++++++++++++++- 4 files changed, 282 insertions(+), 6 deletions(-) diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt index bef76f4dd06..70c5b4f12d1 100644 --- a/Documentation/git-cat-file.txt +++ b/Documentation/git-cat-file.txt @@ -96,6 +96,33 @@ OPTIONS need to specify the path, separated by whitespace. See the section `BATCH OUTPUT` below for details. +--batch-command:: +--batch-command=:: + Enter a command mode that reads commands and arguments from stdin. May + only be combined with `--buffer`, `--textconv` or `--filters`. In the + case of `--textconv` or `--filters`, the input lines also need to specify + the path, separated by whitespace. See the section `BATCH OUTPUT` below + for details. ++ +`--batch-command` recognizes the following commands: ++ +-- +contents :: + Print object contents for object reference ``. This corresponds to + the output of `--batch`. + +info :: + Print object info for object reference ``. This corresponds to the + output of `--batch-check`. + +flush:: + Used with `--buffer` to execute all preceding commands that were issued + since the beginning or since the last flush was issued. When `--buffer` + is used, no output will come until a `flush` is issued. When `--buffer` + is not used, commands are flushed each time without issuing `flush`. +-- ++ + --batch-all-objects:: Instead of reading a list of objects on stdin, perform the requested batch operation on all objects in the repository and @@ -110,7 +137,7 @@ OPTIONS that a process can interactively read and write from `cat-file`. With this option, the output uses normal stdio buffering; this is much more efficient when invoking - `--batch-check` on a large number of objects. + `--batch-check` or `--batch-command` on a large number of objects. --unordered:: When `--batch-all-objects` is in use, visit objects in an @@ -202,6 +229,13 @@ from stdin, one per line, and print information about them. By default, the whole line is considered as an object, as if it were fed to linkgit:git-rev-parse[1]. +When `--batch-command` is given, `cat-file` will read commands from stdin, +one per line, and print information based on the command given. With +`--batch-command`, the `info` command followed by an object will print +information about the object the same way `--batch-check` would, and the +`contents` command followed by an object prints contents in the same way +`--batch` would. + You can specify the information shown for each object by using a custom ``. The `` is copied literally to stdout for each object, with placeholders of the form `%(atom)` expanded, followed by a @@ -237,9 +271,9 @@ newline. The available atoms are: If no format is specified, the default format is `%(objectname) %(objecttype) %(objectsize)`. -If `--batch` is specified, the object information is followed by the -object contents (consisting of `%(objectsize)` bytes), followed by a -newline. +If `--batch` is specified, or if `--batch-command` is used with the `contents` +command, the object information is followed by the object contents (consisting +of `%(objectsize)` bytes), followed by a newline. For example, `--batch` without a custom format would produce: diff --git a/builtin/cat-file.c b/builtin/cat-file.c index 5e38af82af1..5dd876c5b09 100644 --- a/builtin/cat-file.c +++ b/builtin/cat-file.c @@ -20,6 +20,7 @@ enum batch_mode { BATCH_MODE_CONTENTS, BATCH_MODE_INFO, + BATCH_MODE_QUEUE_AND_DISPATCH, }; struct batch_options { @@ -513,6 +514,128 @@ static int batch_unordered_packed(const struct object_id *oid, data); } +typedef void (*parse_cmd_fn_t)(struct batch_options *, const char *, + struct strbuf *, struct expand_data *); + +struct queued_cmd { + parse_cmd_fn_t fn; + char *line; +}; + +static void parse_cmd_contents(struct batch_options *opt, + const char *line, + struct strbuf *output, + struct expand_data *data) +{ + opt->batch_mode = BATCH_MODE_CONTENTS; + batch_one_object(line, output, opt, data); +} + +static void parse_cmd_info(struct batch_options *opt, + const char *line, + struct strbuf *output, + struct expand_data *data) +{ + opt->batch_mode = BATCH_MODE_INFO; + batch_one_object(line, output, opt, data); +} + +static void dispatch_calls(struct batch_options *opt, + struct strbuf *output, + struct expand_data *data, + struct queued_cmd *cmd, + size_t *nr) +{ + int i; + + if (!opt->buffer_output) + die(_("flush is only for --buffer mode")); + + for (i = 0; i < *nr; i++) { + cmd[i].fn(opt, cmd[i].line, output, data); + free(cmd[i].line); + } + + *nr = 0; + fflush(stdout); +} + +static const struct parse_cmd { + const char *prefix; + parse_cmd_fn_t fn; + unsigned takes_args; +} commands[] = { + { "contents", parse_cmd_contents, 1}, + { "info", parse_cmd_info, 1}, + { "flush", NULL, 0}, +}; + +static void batch_objects_command(struct batch_options *opt, + struct strbuf *output, + struct expand_data *data) +{ + struct strbuf input = STRBUF_INIT; + struct queued_cmd *queued_cmd = NULL; + size_t alloc = 0, nr = 0; + + while (!strbuf_getline(&input, stdin)) { + int i; + const struct parse_cmd *cmd = NULL; + const char *p = NULL, *cmd_end; + struct queued_cmd call = {0}; + + if (!input.len) + die(_("empty command in input")); + if (isspace(*input.buf)) + die(_("whitespace before command: '%s'"), input.buf); + + for (i = 0; i < ARRAY_SIZE(commands); i++) { + if (!skip_prefix(input.buf, commands[i].prefix, &cmd_end)) + continue; + + cmd = &commands[i]; + if (cmd->takes_args) { + if (*cmd_end != ' ') + die(_("%s requires arguments"), + commands[i].prefix); + + p = cmd_end + 1; + } else if (*cmd_end) { + die(_("%s takes no arguments"), + commands[i].prefix); + } + + break; + } + + if (!cmd) + die(_("unknown command: '%s'"), input.buf); + + if (!strcmp(cmd->prefix, "flush")) { + dispatch_calls(opt, output, data, queued_cmd, &nr); + continue; + } + + if (!opt->buffer_output) { + cmd->fn(opt, p, output, data); + continue; + } + + ALLOC_GROW(queued_cmd, nr + 1, alloc); + call.fn = cmd->fn; + call.line = xstrdup_or_null(p); + queued_cmd[nr++] = call; + } + + if (opt->buffer_output && + nr && + !git_env_bool("GIT_TEST_CAT_FILE_NO_FLUSH_ON_EXIT", 0)) + dispatch_calls(opt, output, data, queued_cmd, &nr); + + free(queued_cmd); + strbuf_release(&input); +} + static int batch_objects(struct batch_options *opt) { struct strbuf input = STRBUF_INIT; @@ -595,6 +718,10 @@ static int batch_objects(struct batch_options *opt) save_warning = warn_on_object_refname_ambiguity; warn_on_object_refname_ambiguity = 0; + if (opt->batch_mode == BATCH_MODE_QUEUE_AND_DISPATCH) { + batch_objects_command(opt, &output, &data); + goto cleanup; + } while (strbuf_getline(&input, stdin) != EOF) { if (data.split_on_whitespace) { /* @@ -613,6 +740,7 @@ static int batch_objects(struct batch_options *opt) batch_one_object(input.buf, &output, opt, &data); } + cleanup: strbuf_release(&input); strbuf_release(&output); warn_on_object_refname_ambiguity = save_warning; @@ -645,6 +773,8 @@ static int batch_option_callback(const struct option *opt, bo->batch_mode = BATCH_MODE_CONTENTS; else if (!strcmp(opt->long_name, "batch-check")) bo->batch_mode = BATCH_MODE_INFO; + else if (!strcmp(opt->long_name, "batch-command")) + bo->batch_mode = BATCH_MODE_QUEUE_AND_DISPATCH; else BUG("%s given to batch-option-callback", opt->long_name); @@ -666,7 +796,7 @@ int cmd_cat_file(int argc, const char **argv, const char *prefix) N_("git cat-file "), N_("git cat-file (-e | -p) "), N_("git cat-file (-t | -s) [--allow-unknown-type] "), - N_("git cat-file (--batch | --batch-check) [--batch-all-objects]\n" + N_("git cat-file (--batch | --batch-check | --batch-command) [--batch-all-objects]\n" " [--buffer] [--follow-symlinks] [--unordered]\n" " [--textconv | --filters]"), N_("git cat-file (--textconv | --filters)\n" @@ -695,6 +825,10 @@ int cmd_cat_file(int argc, const char **argv, const char *prefix) N_("like --batch, but don't emit "), PARSE_OPT_OPTARG | PARSE_OPT_NONEG, batch_option_callback), + OPT_CALLBACK_F(0, "batch-command", &batch, N_("format"), + N_("read commands from stdin"), + PARSE_OPT_OPTARG | PARSE_OPT_NONEG, + batch_option_callback), OPT_CMDMODE(0, "batch-all-objects", &opt, N_("with --batch[-check]: ignores stdin, batches all known objects"), 'b'), /* Batch-specific options */ diff --git a/t/README b/t/README index f48e0542cdc..bcd813b0c59 100644 --- a/t/README +++ b/t/README @@ -472,6 +472,9 @@ a test and then fails then the whole test run will abort. This can help to make sure the expected tests are executed and not silently skipped when their dependency breaks or is simply not present in a new environment. +GIT_TEST_CAT_FILE_NO_FLUSH_ON_EXIT=, when true will prevent cat-file +--batch-command from flushing to output on exit. + Naming Tests ------------ diff --git a/t/t1006-cat-file.sh b/t/t1006-cat-file.sh index 2d52851dadc..74f0e36b69e 100755 --- a/t/t1006-cat-file.sh +++ b/t/t1006-cat-file.sh @@ -182,6 +182,24 @@ $content" test_cmp expect actual ' + for opt in --buffer --no-buffer + do + test -z "$content" || + test_expect_success "--batch-command $opt output of $type content is correct" ' + maybe_remove_timestamp "$batch_output" $no_ts >expect && + maybe_remove_timestamp "$(test_write_lines "contents $sha1" \ + | git cat-file --batch-command $opt)" $no_ts >actual && + test_cmp expect actual + ' + + test_expect_success "--batch-command $opt output of $type info is correct" ' + echo "$sha1 $type $size" >expect && + test_write_lines "info $sha1" \ + | git cat-file --batch-command $opt >actual && + test_cmp expect actual + ' + done + test_expect_success "custom --batch-check format" ' echo "$type $sha1" >expect && echo $sha1 | git cat-file --batch-check="%(objecttype) %(objectname)" >actual && @@ -229,6 +247,22 @@ test_expect_success "setup" ' run_tests 'blob' $hello_sha1 $hello_size "$hello_content" "$hello_content" +test_expect_success '--batch-command --buffer with flush for blob info' ' + echo "$hello_sha1 blob $hello_size" >expect && + test_write_lines "info $hello_sha1" "flush" | \ + GIT_TEST_CAT_FILE_NO_FLUSH_ON_EXIT=1 \ + git cat-file --batch-command --buffer >actual && + test_cmp expect actual +' + +test_expect_success '--batch-command --buffer without flush for blob info' ' + touch output && + test_write_lines "info $hello_sha1" | \ + GIT_TEST_CAT_FILE_NO_FLUSH_ON_EXIT=1 \ + git cat-file --batch-command --buffer >>output && + test_must_be_empty output +' + test_expect_success '--batch-check without %(rest) considers whole line' ' echo "$hello_sha1 blob $hello_size" >expect && git update-index --add --cacheinfo 100644 $hello_sha1 "white space" && @@ -272,7 +306,7 @@ test_expect_success \ "Reach a blob from a tag pointing to it" \ "test '$hello_content' = \"\$(git cat-file blob $tag_sha1)\"" -for batch in batch batch-check +for batch in batch batch-check batch-command do for opt in t s e p do @@ -378,6 +412,42 @@ test_expect_success "--batch-check with multiple sha1s gives correct format" ' "$(echo_without_newline "$batch_check_input" | git cat-file --batch-check)" ' +test_expect_success '--batch-command with multiple info calls gives correct format' ' + cat >expect <<-EOF && + $hello_sha1 blob $hello_size + $tree_sha1 tree $tree_size + $commit_sha1 commit $commit_size + $tag_sha1 tag $tag_size + deadbeef missing + EOF + + test_write_lines "info $hello_sha1"\ + "info $tree_sha1"\ + "info $commit_sha1"\ + "info $tag_sha1"\ + "info deadbeef" | git cat-file --batch-command --buffer >actual && + test_cmp expect actual +' + +test_expect_success '--batch-command with multiple command calls gives correct format' ' + remove_timestamp >expect <<-EOF && + $hello_sha1 blob $hello_size + $hello_content + $commit_sha1 commit $commit_size + $commit_content + $tag_sha1 tag $tag_size + $tag_content + deadbeef missing + EOF + + test_write_lines "contents $hello_sha1"\ + "contents $commit_sha1"\ + "contents $tag_sha1"\ + "contents deadbeef"\ + "flush" | git cat-file --batch-command --buffer | remove_timestamp >actual && + test_cmp expect actual +' + test_expect_success 'setup blobs which are likely to delta' ' test-tool genrandom foo 10240 >foo && { cat foo && echo plus; } >foo-plus && @@ -968,5 +1038,40 @@ test_expect_success 'cat-file --batch-all-objects --batch-check ignores replace' echo "$orig commit $orig_size" >expect && test_cmp expect actual ' +test_expect_success 'batch-command empty command' ' + echo "" >cmd && + test_expect_code 128 git cat-file --batch-command err && + grep "^fatal:.*empty command in input.*" err +' + +test_expect_success 'batch-command whitespace before command' ' + echo " info deadbeef" >cmd && + test_expect_code 128 git cat-file --batch-command err && + grep "^fatal:.*whitespace before command.*" err +' + +test_expect_success 'batch-command unknown command' ' + echo unknown_command >cmd && + test_expect_code 128 git cat-file --batch-command err && + grep "^fatal:.*unknown command.*" err +' + +test_expect_success 'batch-command missing arguments' ' + echo "info" >cmd && + test_expect_code 128 git cat-file --batch-command err && + grep "^fatal:.*info requires arguments.*" err +' + +test_expect_success 'batch-command flush with arguments' ' + echo "flush arg" >cmd && + test_expect_code 128 git cat-file --batch-command --buffer err && + grep "^fatal:.*flush takes no arguments.*" err +' + +test_expect_success 'batch-command flush without --buffer' ' + echo "flush" >cmd && + test_expect_code 128 git cat-file --batch-command err && + grep "^fatal:.*flush is only for --buffer mode.*" err +' test_done