From patchwork Sat Jan 23 00:44:45 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: KP Singh X-Patchwork-Id: 12041029 X-Patchwork-Delegate: bpf@iogearbox.net 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=-19.2 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,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 7D847C433E9 for ; Sat, 23 Jan 2021 00:45:49 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 5DD00235DD for ; Sat, 23 Jan 2021 00:45:49 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726007AbhAWApg (ORCPT ); Fri, 22 Jan 2021 19:45:36 -0500 Received: from mail.kernel.org ([198.145.29.99]:53296 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726147AbhAWApc (ORCPT ); Fri, 22 Jan 2021 19:45:32 -0500 Received: by mail.kernel.org (Postfix) with ESMTPSA id E91AF23B6B; Sat, 23 Jan 2021 00:44:50 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1611362692; bh=uchHNpd6lA5CRVAMUZZVF0ENVwZfUFgo18//cWQ8Wh8=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=ChsqSzO00sI1YI5o81J2wm5DXnsv4aLeUNPAHNZflPhmWDGwpY2RcRvRgraSxaUak osQAd1C95M4Kj5l4NWh9+2c5awle3pwq1gJICk5cuDXYFM4AMdnZWr9h5pjb/CG+8v OiRy3ivZmG+dDbRb3BRn2fw2sXklKHzFQCPP4vZTqs55GtPDNuPJpdZIPNQ8mG+2xt KduTivj72OJW/Zx4/yfRm72H7f248QVRj5EuQ8rdPQz39jltlQ6HT3Rby2RKDQPkdt Hm3JutM1qX3MY+MoADwwM3waxEqd5YMD7HpXjzS5oJ3DYP3UMuwF/o35jeTdCdhvx2 YU3jLmMrvSUdA== From: KP Singh To: bpf@vger.kernel.org Cc: Alexei Starovoitov , Daniel Borkmann , Andrii Nakryiko , Florent Revest , Brendan Jackman Subject: [PATCH bpf-next v2 2/2] bpf/selftests: Add a short note about run_in_vm.sh in README.rst Date: Sat, 23 Jan 2021 00:44:45 +0000 Message-Id: <20210123004445.299149-3-kpsingh@kernel.org> X-Mailer: git-send-email 2.30.0.280.ga3ce27912f-goog In-Reply-To: <20210123004445.299149-1-kpsingh@kernel.org> References: <20210123004445.299149-1-kpsingh@kernel.org> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: bpf@vger.kernel.org X-Patchwork-Delegate: bpf@iogearbox.net Add a short note to make contributors aware of the existence of the script. The documentation does not intentionally document all the options of the script to avoid mentioning it in two places (it's available in the usage / help message of the script). Signed-off-by: KP Singh Acked-by: Yonghong Song --- tools/testing/selftests/bpf/README.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/tools/testing/selftests/bpf/README.rst b/tools/testing/selftests/bpf/README.rst index ca064180d4d0..a0dac65b6b01 100644 --- a/tools/testing/selftests/bpf/README.rst +++ b/tools/testing/selftests/bpf/README.rst @@ -6,6 +6,29 @@ General instructions on running selftests can be found in __ /Documentation/bpf/bpf_devel_QA.rst#q-how-to-run-bpf-selftests +========================= +Running Selftests in a VM +========================= + +It's now possible to run the selftests using ``tools/testing/selftests/bpf/run_in_vm.sh``. +The script tries to ensure that the tests are run with the same environment as they +would be run post-submit in the CI used by the Maintainers. + +This script downloads a suitable Kconfig and VM userspace image from the system used by +the CI. It builds the kernel (without overwriting your existing Kconfig), recompiles the +bpf selftests, runs them (by default ``tools/testing/selftests/bpf/test_progs``) and +saves the resulting output (by default in ``~/.bpf_selftests``). + +For more information on about using the script, run: + +.. code-block:: console + + $ tools/testing/selftests/bpf/run_in_vm.sh -h + +.. note:: The script does not yet update pahole and LLVM, so these will still need to be + manually updated. + +.. note:: The script currently only supports x86_64. Additional information about selftest failures are documented here.