From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id AC121C07E9C for ; Wed, 14 Jul 2021 17:24:05 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 8FB0D613C3 for ; Wed, 14 Jul 2021 17:24:05 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S238844AbhGNR04 (ORCPT ); Wed, 14 Jul 2021 13:26:56 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:45120 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S237956AbhGNR0z (ORCPT ); Wed, 14 Jul 2021 13:26:55 -0400 Received: from mail-wr1-x435.google.com (mail-wr1-x435.google.com [IPv6:2a00:1450:4864:20::435]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 10411C061760 for ; Wed, 14 Jul 2021 10:24:03 -0700 (PDT) Received: by mail-wr1-x435.google.com with SMTP id k4so4159348wrc.8 for ; Wed, 14 Jul 2021 10:24:02 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=wDEYwpC7L20UMoA/d8ufPq3KGReEptPhuSSLPWrnoSA=; b=Oj0YHXzAjyHMWaYVPLwYCtKJTCjko6jqrNwg2z/EB3z2lFM7P0vBy4kNNiezdkyfz0 k+JWQXFHLHcZjYHG4tQuVIbmVBDLuSvdW/93d2+gkncx+KxPSWjMQPKdaiR/FByMbOFs bcRgxN83OQoYnzN7hFoGUJOiIvTi+LXtQmB8ACVzxs3c1PifdtRDA9FxVNqk2UZmAPwV lxyRPs035Pve1oukkC92Io+F62NxTVJ6EX/QQKEqJPWiIQU+6AdqTLzSrR8IRedWty8R Qr5MKSlTNKTPQCQQeBpHGLlAHCAC/FjXaYSeEG/4JgN463ILbfrKE/2xavRmdyA89LNw pVDw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=wDEYwpC7L20UMoA/d8ufPq3KGReEptPhuSSLPWrnoSA=; b=Qe1qdxKjO/iLrjLl2n9VMv0PQnIg/RqwxhPGQ/0oqGD/dx/vA10iTfoIM3IYiKyMhz tsRHUxnFJlEimXt7tBWi5n5Ird5jNJVO1UOuT+O+ZT1rDHHVSyw3tHUW6Bm9LqQfssve MJj8wcoUm0NkdoqhzxgM1Wy6Zw0cG2hjCqZXd026XnmLNEcAxJxCFkP9OKSKfMTzEsI4 WNkORhhcntAGRgTuSU+wcRVjHB/Y1VnQvg72Vz3E0EmsIEeH3XCgJB5YPyif0Vbllh57 I4vUM2wVqJ4s8zfwrTscuM+0RUnDE8HL67d7iWX05f4eziUTPsk/lDTN/+5T+O1hDpnV CN7A== X-Gm-Message-State: AOAM532u03HiNbQIkb1AOQW+Ym/AZMlNhpM5osJV55DFUf0qiB9xx1rJ wZbw7XaiF4JElqY+c99rApsXjvtlQ5ejlnTy X-Google-Smtp-Source: ABdhPJxSqALrg2tiRntKog/+9BNwVbN3WNL2GkGVEN0itvJ9Dl5449FrfwNjTsdtAzhB36QXtVoLIg== X-Received: by 2002:a5d:6c6e:: with SMTP id r14mr14729289wrz.242.1626283441381; Wed, 14 Jul 2021 10:24:01 -0700 (PDT) Received: from vm.nix.is (vm.nix.is. [2a01:4f8:120:2468::2]) by smtp.gmail.com with ESMTPSA id f5sm3823795wrg.67.2021.07.14.10.24.00 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 14 Jul 2021 10:24:00 -0700 (PDT) From: =?UTF-8?q?=C3=86var=20Arnfj=C3=B6r=C3=B0=20Bjarmason?= To: git@vger.kernel.org Cc: Junio C Hamano , Jeff King , Andrzej Hunt , =?UTF-8?q?L=C3=A9na=C3=AFc=20Huard?= , Derrick Stolee , Felipe Contreras , =?UTF-8?q?SZEDER=20G=C3=A1bor?= , =?UTF-8?q?=C4=90o=C3=A0n=20Tr=E1=BA=A7n=20C=C3=B4ng=20Danh?= , Eric Sunshine , =?UTF-8?q?=C3=86var=20Arnfj=C3=B6r=C3=B0=20Bjarmason?= Subject: [PATCH v2 1/4] tests: add a test mode for SANITIZE=leak, run it in CI Date: Wed, 14 Jul 2021 19:23:51 +0200 Message-Id: X-Mailer: git-send-email 2.32.0.853.g5a570c9bf9 In-Reply-To: References: MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org While git can be compiled with SANITIZE=leak there has been no corresponding GIT_TEST_* mode for it, i.e. memory leaks have been fixed as one-offs without structured regression testing. This change add such a mode, we now have new linux-{clang,gcc}-sanitize-leak CI targets, these targets run the same tests as linux-{clang,gcc}, except that almost all of them are skipped. There is a whitelist of some tests that are OK in test-lib.sh, and individual tests can be opted-in by setting GIT_TEST_SANITIZE_LEAK=true before sourcing test-lib.sh. Within those individual test can be skipped with the "!SANITIZE_LEAK" prerequisite. See the updated t/README for more details. I'm using the GIT_TEST_SANITIZE_LEAK=true and !SANITIZE_LEAK pattern in a couple of tests whose memory leaks I'll fix in subsequent commits. I'm not being aggressive about opting in tests, it's not all tests that currently pass under SANITIZE=leak, just a small number of known-good tests. We can add more later as we fix leaks and grow more confident in this test mode. See the recent discussion at [1] about the lack of this sort of test mode, and 0e5bba53af (add UNLEAK annotation for reducing leak false positives, 2017-09-08) for the initial addition of SANITIZE=leak. See also 09595ab381 (Merge branch 'jk/leak-checkers', 2017-09-19), 7782066f67 (Merge branch 'jk/apache-lsan', 2019-05-19) and the recent 936e58851a (Merge branch 'ah/plugleaks', 2021-05-07) for some of the past history of "one-off" SANITIZE=leak (and more) fixes. When calling maybe_skip_all_sanitize_leak matching against "$TEST_NAME" instead of "$this_test" as other "match_pattern_list()" users do is intentional. I'd like to match things like "t13*config*" in subsequent commits. This part of the API isn't public, so we can freely change it in the future. 1. https://lore.kernel.org/git/87czsv2idy.fsf@evledraar.gmail.com/ Signed-off-by: Ævar Arnfjörð Bjarmason --- .github/workflows/main.yml | 6 ++++ Makefile | 5 ++++ ci/install-dependencies.sh | 4 +-- ci/lib.sh | 18 ++++++++---- ci/run-build-and-tests.sh | 4 +-- t/README | 16 ++++++++++ t/t5701-git-serve.sh | 2 +- t/test-lib.sh | 60 ++++++++++++++++++++++++++++++++++++++ 8 files changed, 105 insertions(+), 10 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 73856bafc9..752fe187f9 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -297,6 +297,12 @@ jobs: - jobname: linux-gcc-default cc: gcc pool: ubuntu-latest + - jobname: linux-clang-sanitize-leak + cc: clang + pool: ubuntu-latest + - jobname: linux-gcc-sanitize-leak + cc: gcc + pool: ubuntu-latest env: CC: ${{matrix.vector.cc}} jobname: ${{matrix.vector.jobname}} diff --git a/Makefile b/Makefile index 502e0c9a81..d4cad5136f 100644 --- a/Makefile +++ b/Makefile @@ -1216,6 +1216,9 @@ PTHREAD_CFLAGS = SPARSE_FLAGS ?= SP_EXTRA_FLAGS = -Wno-universal-initializer +# For informing GIT-BUILD-OPTIONS of the SANITIZE=leak target +SANITIZE_LEAK = + # For the 'coccicheck' target; setting SPATCH_BATCH_SIZE higher will # usually result in less CPU usage at the cost of higher peak memory. # Setting it to 0 will feed all files in a single spatch invocation. @@ -1260,6 +1263,7 @@ BASIC_CFLAGS += -DSHA1DC_FORCE_ALIGNED_ACCESS endif ifneq ($(filter leak,$(SANITIZERS)),) BASIC_CFLAGS += -DSUPPRESS_ANNOTATED_LEAKS +SANITIZE_LEAK = YesCompiledWithIt endif ifneq ($(filter address,$(SANITIZERS)),) NO_REGEX = NeededForASAN @@ -2793,6 +2797,7 @@ GIT-BUILD-OPTIONS: FORCE @echo NO_UNIX_SOCKETS=\''$(subst ','\'',$(subst ','\'',$(NO_UNIX_SOCKETS)))'\' >>$@+ @echo PAGER_ENV=\''$(subst ','\'',$(subst ','\'',$(PAGER_ENV)))'\' >>$@+ @echo DC_SHA1=\''$(subst ','\'',$(subst ','\'',$(DC_SHA1)))'\' >>$@+ + @echo SANITIZE_LEAK=\''$(subst ','\'',$(subst ','\'',$(SANITIZE_LEAK)))'\' >>$@+ @echo X=\'$(X)\' >>$@+ ifdef TEST_OUTPUT_DIRECTORY @echo TEST_OUTPUT_DIRECTORY=\''$(subst ','\'',$(subst ','\'',$(TEST_OUTPUT_DIRECTORY)))'\' >>$@+ diff --git a/ci/install-dependencies.sh b/ci/install-dependencies.sh index 67852d0d37..8ac72d7246 100755 --- a/ci/install-dependencies.sh +++ b/ci/install-dependencies.sh @@ -12,13 +12,13 @@ UBUNTU_COMMON_PKGS="make libssl-dev libcurl4-openssl-dev libexpat-dev libemail-valid-perl libio-socket-ssl-perl libnet-smtp-ssl-perl" case "$jobname" in -linux-clang|linux-gcc) +linux-clang|linux-gcc|linux-clang-sanitize-leak|linux-gcc-sanitize-leak) sudo apt-add-repository -y "ppa:ubuntu-toolchain-r/test" sudo apt-get -q update sudo apt-get -q -y install language-pack-is libsvn-perl apache2 \ $UBUNTU_COMMON_PKGS case "$jobname" in - linux-gcc) + linux-gcc|linux-gcc-sanitize-leak) sudo apt-get -q -y install gcc-8 ;; esac diff --git a/ci/lib.sh b/ci/lib.sh index 476c3f369f..bb02b5abf4 100755 --- a/ci/lib.sh +++ b/ci/lib.sh @@ -183,14 +183,16 @@ export GIT_TEST_CLONE_2GB=true export SKIP_DASHED_BUILT_INS=YesPlease case "$jobname" in -linux-clang|linux-gcc) - if [ "$jobname" = linux-gcc ] - then +linux-clang|linux-gcc|linux-clang-sanitize-leak|linux-gcc-sanitize-leak) + case "$jobname" in + linux-gcc|linux-gcc-sanitize-leak) export CC=gcc-8 MAKEFLAGS="$MAKEFLAGS PYTHON_PATH=/usr/bin/python3" - else + ;; + *) MAKEFLAGS="$MAKEFLAGS PYTHON_PATH=/usr/bin/python2" - fi + ;; + esac export GIT_TEST_HTTPD=true @@ -233,4 +235,10 @@ linux-musl) ;; esac +case "$jobname" in +linux-clang-sanitize-leak|linux-gcc-sanitize-leak) + export SANITIZE=leak + ;; +esac + MAKEFLAGS="$MAKEFLAGS CC=${CC:-cc}" diff --git a/ci/run-build-and-tests.sh b/ci/run-build-and-tests.sh index 3ce81ffee9..5fe047b5c6 100755 --- a/ci/run-build-and-tests.sh +++ b/ci/run-build-and-tests.sh @@ -12,7 +12,7 @@ esac make case "$jobname" in -linux-gcc) +linux-gcc|linux-gcc-sanitize-leak) export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main make test export GIT_TEST_SPLIT_INDEX=yes @@ -29,7 +29,7 @@ linux-gcc) export GIT_TEST_CHECKOUT_WORKERS=2 make test ;; -linux-clang) +linux-clang|linux-clang-sanitize-leak) export GIT_TEST_DEFAULT_HASH=sha1 make test export GIT_TEST_DEFAULT_HASH=sha256 diff --git a/t/README b/t/README index 1a2072b2c8..303d0be817 100644 --- a/t/README +++ b/t/README @@ -448,6 +448,22 @@ GIT_TEST_CHECKOUT_WORKERS= overrides the 'checkout.workers' setting to and 'checkout.thresholdForParallelism' to 0, forcing the execution of the parallel-checkout code. +GIT_TEST_SANITIZE_LEAK= will force the tests to run when git +is compiled with SANITIZE=leak (we pick it up via +../GIT-BUILD-OPTIONS). + +By default all tests are skipped when compiled with SANITIZE=leak, and +individual test scripts opt themselves in to leak testing by setting +GIT_TEST_SANITIZE_LEAK=true before sourcing test-lib.sh. Within those +tests use the SANITIZE_LEAK prerequisite to skip individiual tests +(i.e. test_expect_success !SANITIZE_LEAK [...]). + +So the GIT_TEST_SANITIZE_LEAK setting is different in behavior from +both other GIT_TEST_*=[true|false] settings, but more useful given how +SANITIZE=leak works & the state of the test suite. Manually setting +GIT_TEST_SANITIZE_LEAK=true is only useful during development when +finding and fixing memory leaks. + Naming Tests ------------ diff --git a/t/t5701-git-serve.sh b/t/t5701-git-serve.sh index 930721f053..d58efb0aa9 100755 --- a/t/t5701-git-serve.sh +++ b/t/t5701-git-serve.sh @@ -243,7 +243,7 @@ test_expect_success 'unexpected lines are not allowed in fetch request' ' # Test the basics of object-info # -test_expect_success 'basics of object-info' ' +test_expect_success !SANITIZE_LEAK 'basics of object-info' ' test-tool pkt-line pack >in <<-EOF && command=object-info object-format=$(test_oid algo) diff --git a/t/test-lib.sh b/t/test-lib.sh index 7036f83b33..9201510e16 100644 --- a/t/test-lib.sh +++ b/t/test-lib.sh @@ -1353,6 +1353,40 @@ then exit 1 fi +# SANITIZE=leak test mode +sanitize_leak_true= +add_sanitize_leak_true () { + sanitize_leak_true="$sanitize_leak_true$1 " +} + +sanitize_leak_false= +add_sanitize_leak_false () { + sanitize_leak_false="$sanitize_leak_false$1 " +} + +sanitize_leak_opt_in_msg="opt-in with GIT_TEST_SANITIZE_LEAK=true" +maybe_skip_all_sanitize_leak () { + # Whitelist patterns + add_sanitize_leak_true 't000*' + add_sanitize_leak_true 't001*' + add_sanitize_leak_true 't006*' + + # Blacklist patterns (overrides whitelist) + add_sanitize_leak_false 't000[469]*' + add_sanitize_leak_false 't001[2459]*' + add_sanitize_leak_false 't006[0248]*' + + if match_pattern_list "$1" "$sanitize_leak_false" + then + skip_all="test $this_test on SANITIZE=leak blacklist, $sanitize_leak_opt_in_msg" + test_done + elif match_pattern_list "$1" "$sanitize_leak_true" + then + return 0 + fi + return 1 +} + # Are we running this test at all? remove_trash= this_test=${0##*/} @@ -1364,6 +1398,31 @@ then test_done fi +# Aggressively skip non-whitelisted tests when compiled with +# SANITIZE=leak +if test -n "$SANITIZE_LEAK" +then + if test -z "$GIT_TEST_SANITIZE_LEAK" && + maybe_skip_all_sanitize_leak "$TEST_NAME" + then + say_color info >&3 "test $this_test on SANITIZE=leak whitelist" + GIT_TEST_SANITIZE_LEAK=true + fi + + # We need to see it in "git env--helper" (via + # test_bool_env) + export GIT_TEST_SANITIZE_LEAK + + if ! test_bool_env GIT_TEST_SANITIZE_LEAK false + then + skip_all="skip all tests in $this_test under SANITIZE=leak, $sanitize_leak_opt_in_msg" + test_done + fi +elif test_bool_env GIT_TEST_SANITIZE_LEAK false +then + error "GIT_TEST_SANITIZE_LEAK=true has no effect except when compiled with SANITIZE=leak" +fi + # Last-minute variable setup HOME="$TRASH_DIRECTORY" GNUPGHOME="$HOME/gnupg-home-not-used" @@ -1516,6 +1575,7 @@ test -z "$NO_PYTHON" && test_set_prereq PYTHON test -n "$USE_LIBPCRE2" && test_set_prereq PCRE test -n "$USE_LIBPCRE2" && test_set_prereq LIBPCRE2 test -z "$NO_GETTEXT" && test_set_prereq GETTEXT +test -n "$SANITIZE_LEAK" && test_set_prereq SANITIZE_LEAK if test -z "$GIT_TEST_CHECK_CACHE_TREE" then -- 2.32.0.853.g5a570c9bf9