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=-17.3 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,NICE_REPLY_A,SPF_HELO_NONE,SPF_PASS, USER_AGENT_SANE_1 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 5CC7EC2B9F7 for ; Wed, 26 May 2021 06:08:13 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 33BCD613D6 for ; Wed, 26 May 2021 06:08:13 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230419AbhEZGJn (ORCPT ); Wed, 26 May 2021 02:09:43 -0400 Received: from [43.250.32.171] ([43.250.32.171]:36157 "EHLO email.cn" rhost-flags-FAIL-FAIL-OK-FAIL) by vger.kernel.org with ESMTP id S229520AbhEZGJm (ORCPT ); Wed, 26 May 2021 02:09:42 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=email.cn; s=dkim; h=To:From:Date; bh=sUClwE3DLBodRJhcY5V9D/45cQw+W29lnq/61 NprIlI=; b=H3DHQ5HGQZ9OW4A8C0QQLPCz2qO6D+0V9FtGNxfnTWwW+xA9KQf8n Tr92DBs1tLPc89ing/qTpMK9dowiB7eLaisR09GI4w4qr78PGZjOYIgqkc7H5JIt kjSduxHT7ZS9m4GMP0sRr+czpFL9emw6hIqTI4ztrfosNc9iMNl3AM= Received: from [0.0.0.0] (unknown [113.204.183.194]) by v_coremail2-frontend-1 (Coremail) with SMTP id LCKnCgCXXkHB5a1g_iA_AA--.16783S2; Wed, 26 May 2021 14:08:01 +0800 (CST) Subject: Re: [PATCH v2 2/3] docs/zh_CN: create new translations for zh_CN/dev-tools/testing-overview To: "Wu X.C." Cc: alexs@kernel.org, corbet@lwn.net, maskray@google.com, bernard@vivo.com, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org References: <20210523140332.GA1097@bobwxc.top> From: Hu Haowen Message-ID: Date: Wed, 26 May 2021 14:08:01 +0800 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.8.1 MIME-Version: 1.0 In-Reply-To: <20210523140332.GA1097@bobwxc.top> Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 8bit Content-Language: en-US X-CM-TRANSID: LCKnCgCXXkHB5a1g_iA_AA--.16783S2 X-Coremail-Antispam: 1UD129KBjvJXoW3Gr17KFWUJw17CF47uw1xXwb_yoWftrW5pF WvgF97KF4UZryUA348K3WUXF1akF97uF43tF18ta4Sqrn5AFZakrZFgFyqg34fWry8ZF98 Za1FgFyUuw1jyFDanT9S1TB71UUUUUUqnTZGkaVYY2UrUUUUjbIjqfuFe4nvWSU5nxnvy2 9KBjDU0xBIdaVrnRJUUUyj1xkIjI8I6I8E6xAIw20EY4v20xvaj40_JrC_JFWl8cAvFVAK 0II2c7xJM28CjxkF64kEwVA0rcxSw2x7M28EF7xvwVC0I7IYx2IY67AKxVW8JVW5JwA2z4 x0Y4vE2Ix0cI8IcVCY1x0267AKxVW8JVWxJwA2z4x0Y4vEx4A2jsIE14v26rxl6s0DM28E F7xvwVC2z280aVCY1x0267AKxVW8Jr0_Cr1UM2AIxVAIcxkEcVAq07x20xvEncxIr21l5I 8CrVACY4xI64kE6c02F40Ex7xfMcIj6x8ErcxFaVAv8VWxJr1UJwAm72CE4IkC6x0Yz7v_ Jr0_Gr1lF7xvr2IY64vIr41lF7I21c0EjII2zVCS5cI20VAGYxC7Mxk0xIA0c2IEe2xFo4 CEbIxvr21l42xK82IYc2Ij64vIr41l42xK82IY6x8ErcxFaVAv8VWxJr1UJwCFx2IqxVCF s4IE7xkEbVWUJVW8JwC20s026c02F40E14v26r1j6r18MI8I3I0E7480Y4vE14v26r106r 1rMI8E67AF67kF1VAFwI0_JF0_Jw1lIxkGc2Ij64vIr41lIxAIcVC0I7IYx2IY67AKxVWU JVWUCwCI42IY6xIIjxv20xvEc7CjxVAFwI0_Jr0_Gr1lIxAIcVCF04k26cxKx2IYs7xG6r 1j6r1xMIIF0xvEx4A2jsIE14v26r1j6r4UMIIF0xvEx4A2jsIEc7CjxVAFwI0_Jr0_GrUv cSsGvfC2KfnxnUUI43ZEXa7VU0mhF7UUUUU== X-Originating-IP: [113.204.183.194] X-CM-SenderInfo: hvufh21hv6vzxdlohubq/ Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org 在 2021/5/23 下午10:03, Wu X.C. 写道: >> Create new translations for dev-tools/testing-overview.rst and link it >> to dev-tools/index.rst with TODOList modifications. >> >> Signed-off-by: Hu Haowen >> --- >> .../translations/zh_CN/dev-tools/index.rst | 2 + >> .../zh_CN/dev-tools/testing-overview.rst | 99 +++++++++++++++++++ >> 2 files changed, 101 insertions(+) >> create mode 100644 Documentation/translations/zh_CN/dev-tools/testing-overview.rst >> >> diff --git a/Documentation/translations/zh_CN/dev-tools/index.rst b/Documentation/translations/zh_CN/dev-tools/index.rst >> index 7ba02fc392a6..b6b6d3b09acc 100644 >> --- a/Documentation/translations/zh_CN/dev-tools/index.rst >> +++ b/Documentation/translations/zh_CN/dev-tools/index.rst >> @@ -22,6 +22,7 @@ Documentation/dev-tools/testing-overview.rst >> :maxdepth: 2 >> >> gcov >> + testing-overview >> >> Todolist: >> >> @@ -32,6 +33,7 @@ Todolist: >> - ubsan >> - kmemleak >> - kcsan >> + - kfence >> - gdb-kernel-debugging >> - kgdb >> - kselftest >> diff --git a/Documentation/translations/zh_CN/dev-tools/testing-overview.rst b/Documentation/translations/zh_CN/dev-tools/testing-overview.rst >> new file mode 100644 >> index 000000000000..6e2046ac53ff >> --- /dev/null >> +++ b/Documentation/translations/zh_CN/dev-tools/testing-overview.rst >> @@ -0,0 +1,12 @@ >> +.. SPDX-License-Identifier: GPL-2.0 >> + >> +.. include:: ../disclaimer-zh_CN.rst >> + >> +:Original: Documentation/dev-tools/testing-overview.rst >> +:Translator: 胡皓文 Hu Haowen >> + >> +============ >> +内核测试指南 >> +============ >> + >> +有许多不同的工具可以用于测试Linux内核，因此知道什么时候使用它们可能 > s/知道/了解/ > >> +很困难。该文档提供了它们之间区别的一个粗略概览，并阐释了它们怎样糅 > maybe > 本文档粗略概述了它们之间的区别 > > 是怎样 > >> +合在一起的。 >> + >> +编写和运行测试 >> +============== >> + >> +大多数内核测试都是用kselftest或KUnit框架之一编写的。它们都让运行测试 >> >> 都提供了让运行测试更简单的的基础设施， >> >> +更加简化，并为编写新测试提供帮助。 >> + >> +如果你想验证内核的行为——尤其是内核的特定部分——那你就要使用kUnit或 >> +kselftest。 >> + >> +KUnit和kselftest的区别 >> +---------------------- >> + >> +KUnit（Documentation/zh_CN/dev-tools/kunit/index.rst）是用于“白箱”测 > Seems we don't have this translation yet, so plese use the link point to En version. > So as followed paths. How do I add a link to the English version? Should I mark this section in a comment here or directly explain in the document? >> +试的一个完整的内核内部系统：因为测试代码是内核的一部分，所以它能够访 >> +问用户空间不能访问到的内部结构和功能。 >> + >> +因此，KUnit测试最好不要写得太小，也不要有内核中本身包含的部分，以便 > seems a translation mistake? > > against small, self-contained parts of the Kernel > 最好针对内核中较小的、自包含的部分， > >> +能够独立地测试。‘单元’测试的概念亦是如此。 > ‘’ -> “” would be better > >> + >> +比如，一个KUnit测试可能测试一个单独的内核功能（甚至通过一个函数测试 >> +一个单一的代码路径），而不是整个地测试一个特性。 > missed a sentence > , such as an error handling case > >> + >> +这也使得KUnit测试构建和运行非常地快，从而能够作为开发流程的一部分被 > 的测试构建和运行非常快 > >> +频繁地运行。 >> + >> +有关更详细的介绍，请参阅KUnit测试代码风格指南 >> +Documentation/translations/zh_CN/dev-tools/kunit/style.rst > ^path > >> + >> +kselftest（Documentation/translations/zh_CN/dev-tools/kselftest.rst）， > ^path > >> +另一方面，大量地在用户空间被实现，并且测试通常是用户空间的脚本或程序。 > 相对来说，大量用于用户空间，并且通常测试用户空间的脚本或程序。 > >> + >> +这使得编写复杂的测试，或者需要操作更多全局系统状态的测试更加容易（诸 >> +如生成进程之类）。然而，从kselftest直接调用内核函数是不行的。这也就 >> +意味着只有通过某种方式（如系统调用、驱动设备、文件系统等）导出到了用 >> +户空间的内核功能才能使用kselftest来测试。为此，有些测试包含了一个伴 >> +生的内核模块用于导出更多的信息和功能。不过，对于基本上或者完全在内核 >> +中运行的测试，KUnit可能是更佳工具。 >> + > missed a paragraph > > kselftest is therefore suited well to tests of whole features, as these will > expose an interface to userspace, which can be tested, but not implementation > details. This aligns well with 'system' or 'end-to-end' testing. > > >> +比如，一个新的系统调用应该伴随有新的kselftest测试。 >> + >> +代码覆盖率工具 >> +============== >> + >> +Linux内核支持不同代码之间的覆盖率测量工具。这能被用来验证一个测试是 > 支持两种不同的代码覆盖率测试工具。 > > 它们可以用来验证一项测试执行的确切函数或代码行。 > >> +执行的特定的函数或者特定行的代码。这有助于决定内核被测试了多少，或 >> +用来查找合适的测试中没有覆盖到的极端情况。 >> + >> +:doc:`gcov` 是GCC的覆盖率测试工具，能用于获取内核的全局或每个模块的 >> +覆盖率。与KCOV不同的是，这个工具不记录每个任务的覆盖率。覆盖率数据可 >> +以通过debugfs读取，并通过常规的gcov工具进行解释。 >> + >> +:doc:`kcov` 是能够构建在内核之中，用于在每个任务的层面捕捉覆盖率的一 >> +个功能。因此，对于代码执行位置信息的其它情况，它是非常有用的，比如在 > 因此，它对于模糊测试和关于代码执行期间信息的其它情况非常有用。 > >> +一个单一系统调用里使用它就很有用。 >> + >> +动态分析工具 >> +============ >> + >> +内核也支持许多动态分析工具，用以检测正在运行的内核中出现的多种类型的 >> +问题。这些工具尤其用于不同类型的漏洞，比如非法内存访问，诸如数据竞争 > 这些工具通常每个去寻找一类不同的缺陷，比如非法内存访问，数据竞争等并发问题， > 或整型溢出等其他未定义行为。 > >> +的并发问题，或者整型溢出的其它未定义的行为。 >> + >> +一些工具如下： > 如下所示 > >> + >> +* kmemleak检测可能的内存泄漏。参阅 >> + Documentation/dev-tools/kmemleak.rst >> +* KASAN检测非法内存访问，如数组越界和释放内存后再使用的错误。参阅 > 释放后重用（UAF） > >> + Documentation/dev-tools/kasan.rst >> +* UBSAN检测C标准中未定义的行为，如整型溢出。参阅 >> + Documentation/dev-tools/ubsan.rst >> +* KCSAN检测数据竞争。参阅 Documentation/dev-tools/kcsan.rst >> +* KFENCE是一个低开销的内存问题检测器，比KASAN更快而能被用于批量构建。 > 而 -> 且 > >> + 参阅 Documentation/dev-tools/kfence.rst >> +* lockdep是一个锁定正确性检测器。参阅 >> + Documentation/locking/lockdep-design.rst >> +* 除此以外，在内核中还有一些其它的调试工具，大多数能在 >> + lib/Kconfig.debug 中找到。 >> + >> +这些工具倾向于对内核进行整体测试，并且不像kselftest和KUnit一样“传递”。 >> +它们能与kselftest和KUnit结合起来，通过激活这些工具在一个内核上运行测 >> +试：之后你就能确保这些错误在测试过程中都不会发生了。 > 它们可以通过在启用这些工具时运行内核测试以与kselftest或KUnit结合起来： > >> + >> +一些工具与KUnit和kselftest集成，并且当问题被检测时测试会自动失败。 > 并且在检测到问题时会自动打断测试。 > >> + >> -- >> 2.25.1 > And please re-arrange your patches in appropriate thread and remember to change > version each time when you send them, or may let Corbet confused. Other places have already fixed, waiting for a solution for the problem above. Btw, I'm a bit busy these days, sorry for my late reply. Thx, Hu Haowen > Thanks, > Wu X.C. >