From patchwork Fri Sep 8 21:31:48 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Rae Moar X-Patchwork-Id: 13377826 X-Patchwork-Delegate: brendanhiggins@google.com 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 84A0BEEB573 for ; Fri, 8 Sep 2023 21:32:09 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1343546AbjIHVcL (ORCPT ); Fri, 8 Sep 2023 17:32:11 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:51100 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232091AbjIHVcL (ORCPT ); Fri, 8 Sep 2023 17:32:11 -0400 Received: from mail-yb1-xb49.google.com (mail-yb1-xb49.google.com [IPv6:2607:f8b0:4864:20::b49]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id BC4EB1FE5 for ; Fri, 8 Sep 2023 14:32:06 -0700 (PDT) Received: by mail-yb1-xb49.google.com with SMTP id 3f1490d57ef6-d7e81a07ea3so2536913276.2 for ; Fri, 08 Sep 2023 14:32:06 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20221208; t=1694208726; x=1694813526; darn=vger.kernel.org; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=WrSybFetHPfn0OxZQ180UMQcEGO5bVxxCcuiMkmcKr8=; b=S2Jj/pzkU8oCOk/hz+Y71QRYsp6C+ebfO4NY+tZZdl1CJFKorcMp8xonSlPRU1XYRd egZxU58iPzmoA/dAgNglOdxMQLXSXwQFuMvLzCBhaYjT5M+i5Dq9fLgd8KblOj1xvMKy paw7+n3mXP6qbtsjgEkuSDhEBQoRaUhqPAWhPDZmfhkzKIm0neF1RGu2MQH/ZBOuClRJ fTvkhNbWlMoy+QIbHhdKn98CL8UfCveSRDXMy9UAHAut8aXeNMKPapDs2TYCA3Kt4v9S uK/w4VuHBY19ruYNqFFI2iT/QsBcMJ7TBL5/dLF5ZVfoRB0Pf2m8w/CqG+07fWx3xza5 y8Hw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1694208726; x=1694813526; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=WrSybFetHPfn0OxZQ180UMQcEGO5bVxxCcuiMkmcKr8=; b=FkDgEhLMexzEpAMduV+OpAOzt9dWAtPXu5YyyorwSDuWgvuhfvxBElCb0Mze3RfpXZ 4pdRM0c4pvwPGHnjZ3yA7b32thSA2M0QjRoASuZadGaYC6/ZBOlGZmmlJ0ZaNW0Z1Nw0 9/AjsUKACgm88X9pSl4veJkLSa4FOzVre2/pZYXoye8dbsCBSDWB+9P6GsFvxDmZCNWv ZH4zvB7vEnHQpAKv6N6u29vY4YbWS0P9cJ+xUtNPOxU7w3Ny3p3b4k3wAE4XszixbUYu NOSBy7neeGz+G1913HMWrFLzCZkW56hKVuDjgG0DQ4SfXhwG/z4jD/Xk7jxG2dvIdLea ra7g== X-Gm-Message-State: AOJu0YxnhemRqpsae2r+8gT1cnOCh32lUQJJ24W9+iTgWzJnBJ3jYj3i D9gHBPQEsE2wb4j6I0KtNxmAIdtbZw== X-Google-Smtp-Source: AGHT+IHG7fQnlP8xDXo7SMz8La6WUcW4q4a4Z3CTA2AhPgnjq1WxXweSG3cbdfplTYuhvZxDVIArjC7iTQ== X-Received: from rmoar-specialist.c.googlers.com ([fda3:e722:ac3:cc00:2b:7d90:c0a8:45d3]) (user=rmoar job=sendgmr) by 2002:a25:2749:0:b0:d46:45a1:b775 with SMTP id n70-20020a252749000000b00d4645a1b775mr72079ybn.3.1694208726055; Fri, 08 Sep 2023 14:32:06 -0700 (PDT) Date: Fri, 8 Sep 2023 21:31:48 +0000 In-Reply-To: <20230908213148.3610108-1-rmoar@google.com> Mime-Version: 1.0 References: <20230908213148.3610108-1-rmoar@google.com> X-Mailer: git-send-email 2.42.0.283.g2d96d420d3-goog Message-ID: <20230908213148.3610108-2-rmoar@google.com> Subject: [PATCH v2 2/2] Documentation: Add debugfs docs with run after boot From: Rae Moar To: shuah@kernel.org, davidgow@google.com, dlatypov@google.com, brendan.higgins@linux.dev, sadiyakazi@google.com Cc: linux-kselftest@vger.kernel.org, kunit-dev@googlegroups.com, linux-kernel@vger.kernel.org, Rae Moar Precedence: bulk List-ID: X-Mailing-List: linux-kselftest@vger.kernel.org Expand the documentation on the KUnit debugfs filesystem on the run_manual.rst page. Add section describing how to access results using debugfs. Add section describing how to run tests after boot using debugfs. Signed-off-by: Rae Moar Co-developed-by: Sadiya Kazi Signed-off-by: Sadiya Kazi --- Documentation/dev-tools/kunit/run_manual.rst | 45 ++++++++++++++++++-- 1 file changed, 41 insertions(+), 4 deletions(-) diff --git a/Documentation/dev-tools/kunit/run_manual.rst b/Documentation/dev-tools/kunit/run_manual.rst index e7b46421f247..613385c5ba5b 100644 --- a/Documentation/dev-tools/kunit/run_manual.rst +++ b/Documentation/dev-tools/kunit/run_manual.rst @@ -49,9 +49,46 @@ loaded. The results will appear in TAP format in ``dmesg``. +debugfs +======= + +``debugfs`` is a file system that enables user interaction with the files to +make kernel information available to user space. A user can interact with +the debugfs filesystem using a variety of file operations, such as open, +read, and write. + +By default, only the root user has access to the debugfs directory. + +If ``CONFIG_KUNIT_DEBUGFS`` is enabled, you can use KUnit debugfs +filesystem to perform the following actions. + +Retrieve Test Results +===================== + +You can use debugfs to retrieve KUnit test results. The test results are +accessible from the debugfs filesystem in the following read-only file: + +.. code-block :: bash + + /sys/kernel/debug/kunit//results + +The test results are available in KTAP format. + +Run Tests After Kernel Has Booted +================================= + +You can use the debugfs filesystem to trigger built-in tests to run after +boot. To run the test suite, you can use the following command to write to +the ``/sys/kernel/debug/kunit//run`` file: + +.. code-block :: bash + + echo "any string" > /sys/kernel/debugfs/kunit//run + +As a result, the test suite runs and the results are printed to the kernel +log. + .. note :: - If ``CONFIG_KUNIT_DEBUGFS`` is enabled, KUnit test results will - be accessible from the ``debugfs`` filesystem (if mounted). - They will be in ``/sys/kernel/debug/kunit//results``, in - TAP format. + The contents written to the debugfs file + ``/sys/kernel/debug/kunit//run`` are not saved.