From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from [87.239.111.99] (localhost [127.0.0.1]) by dev.tarantool.org (Postfix) with ESMTP id 78752D87C80; Mon, 11 Nov 2024 16:04:54 +0300 (MSK) DKIM-Filter: OpenDKIM Filter v2.11.0 dev.tarantool.org 78752D87C80 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=tarantool.org; s=dev; t=1731330294; bh=DjwEav/VeWJlb7tjT/RF6pP4QrPRnYwE/DvB02NE88s=; h=To:Date:In-Reply-To:References:Subject:List-Id:List-Unsubscribe: List-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:Cc: From; b=Lv0IR7CP4LtnvE4MQUrpOe6sB729oUQbVYTldN4tQ1BkcVDna1/VLZ/3C72zCvYqn NeQY+eJxzQiTGmhmU5IzE/sxc/gKpfMmzhhnDkBpH3kEArfyiqPNFui96FAIsxbvuj Vulf+44pxWRlZTaHe7ISE7v4TkpaBpn+YInIy4rE= Received: from mail-lj1-f182.google.com (mail-lj1-f182.google.com [209.85.208.182]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by dev.tarantool.org (Postfix) with ESMTPS id C1B93D87C80 for ; Mon, 11 Nov 2024 16:04:53 +0300 (MSK) DKIM-Filter: OpenDKIM Filter v2.11.0 dev.tarantool.org C1B93D87C80 Received: by mail-lj1-f182.google.com with SMTP id 38308e7fff4ca-2fb3110b964so35807861fa.1 for ; Mon, 11 Nov 2024 05:04:53 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1731330292; x=1731935092; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=mAuYaHJ6xQWNEf1CzPW6g3GzywrX/LWcqmQatYN/dvs=; b=CzOuC6yVa6bKJbvMGpPiN5fCpyVB6FJ4QQFk6G1FJ82EJbQ1D/FbQvZ/QSFQMHJZdK UWkE4p9uR3Y80G7pKp88tTtoH3WRYbiY1SLeowPGT41Pnig0jk1ygg/mbLfy1We6wp+2 RwUEMIwYsYBuBtKBBmikp+/5jrAHKCg0pmgUpeklwpsN38ObjyR4Hn3uF02O6DbU+ogZ Wcz6yZBVV4BXeiIbL/qUYVs9FBbw+M++MF1+Pi4Iya1jp8pV/EdNmC0s25+E7nEltyXd bvsouGpnvL2ggiD7ZU7/eS08YfAZtrCuui5p5lsmTuY8hQPGx4JEokTEHBNi5nsbCSQB fT1A== X-Gm-Message-State: AOJu0Yw+xSl/gvq6/wb60x/RQwWPyrmWirURQGHduGMuXETXZOsYaOyl B3wKuhnI8dwnYIDW274h6oG46zU8NvL1VrM71647USqwcHQDLW72HqrdGfWMSck= X-Google-Smtp-Source: AGHT+IFkcFsOlYmWto9F9iMlMRlQgqnFiprkh4bBnq1HO3qIq9yRmmfc+oduQ0OQWcUbAll7s5EuEg== X-Received: by 2002:a2e:bea8:0:b0:2fa:d84a:bd8f with SMTP id 38308e7fff4ca-2ff2028a865mr45213891fa.30.1731330292042; Mon, 11 Nov 2024 05:04:52 -0800 (PST) Received: from mandesero.. ([94.25.60.236]) by smtp.gmail.com with ESMTPSA id 38308e7fff4ca-2ff178eeb5esm16678721fa.29.2024.11.11.05.04.51 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 11 Nov 2024 05:04:51 -0800 (PST) To: tarantool-patches@dev.tarantool.org Date: Mon, 11 Nov 2024 13:04:50 +0000 Message-Id: <20241111130450.8311-1-mandesero@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <8cf43811-f0bc-4acf-b4b2-d197cf28a87e@tarantool.org> References: <8cf43811-f0bc-4acf-b4b2-d197cf28a87e@tarantool.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [Tarantool-patches] [PATCH v3 luajit 2/2] ci: add Valgrind testing workflow X-BeenThere: tarantool-patches@dev.tarantool.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: Tarantool development patches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , From: mandesero--- via Tarantool-patches Reply-To: mandesero@gmail.com Cc: mandesero@gmail.com Errors-To: tarantool-patches-bounces@dev.tarantool.org Sender: "Tarantool-patches" From: Maksim Tiushev Hi, Sergey! Thanks for the review! I updated the commit message, see below. > > + CMAKEFLAGS: -DCMAKE_BUILD_TYPE=Debug -DLUA_USE_ASSERT=ON -DLUA_USE_APICHECK=ON > This config doesn't have VALGRIND_OPTIONS, is it intentional? Yes, according to the previous patch, `VALGRIND_OPTIONS` is an environment variable and must be set before building. It is not a CMake option. It is setted in the `configure` step in this workflow. > > + - BUILDTYPE: Release > > + CMAKEFLAGS: -DCMAKE_BUILD_TYPE=RelWithDebInfo > Why JOB_POSTFIX is empty here? `JOB_POSTFIX` describes Valgrind options, not the build type or CMake options. --------------------------------------------------------------- This patch adds CI testing with Valgrind in three scenarios: - Full checks enabled. - No leak checks, with memory fill set to `--malloc-fill=0x00` and `--free-fill=0x00`. - No leak checks, with memory fill set to `--malloc-fill=0xFF` and `--free-fill=0xFF`. The use of `0x00` and `0xFF` for memory fill helps to detect dirty reads. `0x00` mimics zero-initialized memory, which can mask some uninitialized memory usage. `0xFF` fills memory with a non-zero values to make such errors easier to spot. Closes #3705 --- .github/actions/setup-valgrind/README.md | 12 +++ .github/actions/setup-valgrind/action.yml | 12 +++ .github/workflows/valgrind-testing.yaml | 99 +++++++++++++++++++++++ 3 files changed, 123 insertions(+) create mode 100644 .github/actions/setup-valgrind/README.md create mode 100644 .github/actions/setup-valgrind/action.yml create mode 100644 .github/workflows/valgrind-testing.yaml diff --git a/.github/actions/setup-valgrind/README.md b/.github/actions/setup-valgrind/README.md new file mode 100644 index 00000000..e7d66a3a --- /dev/null +++ b/.github/actions/setup-valgrind/README.md @@ -0,0 +1,12 @@ +# Setup environment for Valgrind on Linux + +Action setups the environment on Linux runners (install requirements, setup the +workflow environment, etc) for testing with Valgrind. + +## How to use Github Action from Github workflow + +Add the following code to the running steps before LuaJIT configuration: +``` +- uses: ./.github/actions/setup-valgrind + if: ${{ matrix.OS == 'Linux' }} +``` \ No newline at end of file diff --git a/.github/actions/setup-valgrind/action.yml b/.github/actions/setup-valgrind/action.yml new file mode 100644 index 00000000..5c11fdaa --- /dev/null +++ b/.github/actions/setup-valgrind/action.yml @@ -0,0 +1,12 @@ +name: Setup CI environment with Valgrind on Linux +description: Extend setup-linux with Valgrind installation + +runs: + using: composite + steps: + - name: Setup CI environment (Linux) + uses: ./.github/actions/setup-linux + - name: Install Valgrind + run: | + apt -y install valgrind + shell: bash diff --git a/.github/workflows/valgrind-testing.yaml b/.github/workflows/valgrind-testing.yaml new file mode 100644 index 00000000..44056fcd --- /dev/null +++ b/.github/workflows/valgrind-testing.yaml @@ -0,0 +1,99 @@ +name: Valgrind testing + +on: + push: + branches-ignore: + - '**-notest' + - 'upstream-**' + tags-ignore: + - '**' + +concurrency: + # An update of a developer branch cancels the previously + # scheduled workflow run for this branch. However, the default + # branch, and long-term branch (tarantool/release/2.11, + # tarantool/release/2.10, etc) workflow runs are never canceled. + # + # We use a trick here: define the concurrency group as 'workflow + # run ID' + # 'workflow run attempt' because it is a unique + # combination for any run. So it effectively discards grouping. + # + # XXX: we cannot use `github.sha` as a unique identifier because + # pushing a tag may cancel a run that works on a branch push + # event. + group: ${{ startsWith(github.ref, 'refs/heads/tarantool/') + && format('{0}-{1}', github.run_id, github.run_attempt) + || format('{0}-{1}', github.workflow, github.ref) }} + cancel-in-progress: true + +jobs: + test-valgrind: + strategy: + fail-fast: false + matrix: + # XXX: Let's start with only Linux/x86_64 + # We don't test on Linux/ARM64 because the address returned by the + # system allocator may exceed 47 bits. As a result, we are unable to + # allocate memory for `lua_State`. Therefore, testing on this platform + # is currently disabled. + BUILDTYPE: [Debug, Release] + VALGRIND_SCENARIO: [full, malloc-free-fill-0x00, malloc-free-fill-0xff] + include: + - BUILDTYPE: Debug + CMAKEFLAGS: -DCMAKE_BUILD_TYPE=Debug -DLUA_USE_ASSERT=ON -DLUA_USE_APICHECK=ON + - BUILDTYPE: Release + CMAKEFLAGS: -DCMAKE_BUILD_TYPE=RelWithDebInfo + - VALGRIND_SCENARIO: full + VALGRIND_OPTIONS: --leak-check=full --show-leak-kinds=all --track-origins=yes --verbose + JOB_POSTFIX: "leak-check: full" + # The use of `0x00` and `0xFF` for memory fill helps to detect dirty + # reads. `0x00` mimics zero-initialized memory, which can mask some + # uninitialized memory usage. `0xFF` fills memory with a non-zero + # values to make such errors easier to spot. + - VALGRIND_SCENARIO: malloc-free-fill-0x00 + VALGRIND_OPTIONS: --leak-check=no --malloc-fill=0x00 --free-fill=0x00 + JOB_POSTFIX: "malloc/free-fill: 0x00" + - VALGRIND_SCENARIO: malloc-free-fill-0xff + VALGRIND_OPTIONS: --leak-check=no --malloc-fill=0xff --free-fill=0xff + JOB_POSTFIX: "malloc/free-fill: 0xff" + runs-on: [self-hosted, regular, Linux, x86_64] + name: > + LuaJIT with Valgrind (Linux/x86_64) + ${{ matrix.BUILDTYPE }} + CC: gcc + GC64:ON SYSMALLOC:ON + ${{ matrix.JOB_POSTFIX }} + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + submodules: recursive + - name: setup Linux for Valgrind + uses: ./.github/actions/setup-valgrind + - name: configure + # XXX: LuaJIT configuration requires a couple of tweaks: + # LUAJIT_USE_SYSMALLOC=ON: Unfortunately, internal LuaJIT + # memory allocator is not instrumented yet, so to find + # any memory errors it's better to build LuaJIT with + # system provided memory allocator (i.e. run CMake + # configuration phase with -DLUAJIT_USE_SYSMALLOC=ON). + # For more info, see root CMakeLists.txt. + # LUAJIT_ENABLE_GC64=ON: LUAJIT_USE_SYSMALLOC cannot be + # enabled on x64 without GC64, since realloc usually + # doesn't return addresses in the right address range. + # For more info, see root CMakeLists.txt. + env: + VALGRIND_OPTIONS: ${{ matrix.VALGRIND_OPTIONS }} + run: > + cmake -S . -B ${{ env.BUILDDIR }} + -G Ninja + ${{ matrix.CMAKEFLAGS }} + -DLUAJIT_USE_VALGRIND=ON + -DLUAJIT_ENABLE_GC64=ON + -DLUAJIT_USE_SYSMALLOC=ON + - name: build + run: cmake --build . --parallel + working-directory: ${{ env.BUILDDIR }} + - name: test + run: cmake --build . --parallel --target LuaJIT-test + working-directory: ${{ env.BUILDDIR }} -- 2.34.1