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=-26.3 required=3.0 tests=BAYES_00,DKIMWL_WL_MED, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_CR_TRAILER,INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS, USER_AGENT_GIT,USER_IN_DEF_DKIM_WL autolearn=unavailable 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 9E3A2C433E9 for ; Thu, 11 Mar 2021 21:38:09 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 68E7A64F93 for ; Thu, 11 Mar 2021 21:38:09 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231174AbhCKVhj (ORCPT ); Thu, 11 Mar 2021 16:37:39 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:38990 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229809AbhCKVhe (ORCPT ); Thu, 11 Mar 2021 16:37:34 -0500 Received: from mail-wm1-x349.google.com (mail-wm1-x349.google.com [IPv6:2a00:1450:4864:20::349]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 8D046C061574 for ; Thu, 11 Mar 2021 13:37:33 -0800 (PST) Received: by mail-wm1-x349.google.com with SMTP id 73so4568644wma.3 for ; Thu, 11 Mar 2021 13:37:33 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20161025; h=date:in-reply-to:message-id:mime-version:references:subject:from:to :cc; bh=DMCAKfggtb6XfOnfwXa7RpunfAY3u5vebHv4cftZQZg=; b=lAknWDT57GMBZODmPOA3/KuMa4ZkSrhXnTUgJ6a06+kB7RCuX7vEyP/HYTI2iFEHYr tRYwSAWB4gOUKYIkZjpFVMAxvyQHnGrFeRjhb2MUfkjqEoOoTTLxwgPOTVpqGk1L/5Wb Z+7W3Rg/ud0G75onwXNeU+rNZVbJh5RlKsUt/zwT16LQ8Vsek1D4dmkjrjZuUlL9lRPz kl9IYW3uS5g89A3Yjomce78lVVpH/iqzycard8tq6M45iR4xktsUyqy2UfGCLNETFG7U x1HeQsm29MO4UDAzqzb+RkgfN4C5w/00mhJXSZ26HFHLWwiN2cadZx02FIWTmOg8y9Ym A21A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:in-reply-to:message-id:mime-version :references:subject:from:to:cc; bh=DMCAKfggtb6XfOnfwXa7RpunfAY3u5vebHv4cftZQZg=; b=J5EA7mmxGsg1Gz1FW+v0fhixbOyOPV7zTiP/IlKptLKTAtMPiOgGyUk3oPOYs97yTU gbbXDj5qHkQvUwaq0557FQEgGK1Yc2zwlCJGqE/E0o7Pd/bHe8kGjBxnZs8rJ9alTuwv S5HGWSKUoYFdbLMpsPAXf2BDHej3tzBYetmA4kvS5PMIqSGHyCqbfXe4F7NWhceIQgnb EcnT/fofmH6vxDZsiHE+lNJY/7taG/KDMYOA4d7Yu/NK9LGodFYJ9iqaQZqmfwzZpK4V nEAr8fDux6kbG0pXe5+UDksaAoXO8J3Zm5VY8bWwsUlYBjV0tKd1Gt1kE0igJt6lAhXk 9puw== X-Gm-Message-State: AOAM531CMCKgoxnVcycZ2n6BrF7C8DEFJbtN1KriVjo41aqELcVrs1vM 1TUoIphpvEJfJlmZTA5caRyECK91IV9dDzwP X-Google-Smtp-Source: ABdhPJyWd3HUCuSoQo0Mxee3WuZNPsz7ZPqsHHWGnOpmKuhO+0BOfpBqFvna4ZwLsNDHoBx5JOpGD8EZcQoaaFD9 X-Received: from andreyknvl3.muc.corp.google.com ([2a00:79e0:15:13:95a:d8a8:4925:42be]) (user=andreyknvl job=sendgmr) by 2002:a05:600c:35cd:: with SMTP id r13mr10155047wmq.186.1615498652153; Thu, 11 Mar 2021 13:37:32 -0800 (PST) Date: Thu, 11 Mar 2021 22:37:15 +0100 In-Reply-To: Message-Id: Mime-Version: 1.0 References: X-Mailer: git-send-email 2.31.0.rc2.261.g7f71774620-goog Subject: [PATCH 03/11] kasan: docs: update usage section From: Andrey Konovalov To: Andrew Morton , Alexander Potapenko , Marco Elver Cc: Andrey Ryabinin , Dmitry Vyukov , kasan-dev@googlegroups.com, linux-mm@kvack.org, linux-kernel@vger.kernel.org, Andrey Konovalov Content-Type: text/plain; charset="UTF-8" Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Update the "Usage" section in KASAN documentation: - Add inline code snippet markers. - Reword the part about stack traces for clarity. - Other minor clean-ups. Signed-off-by: Andrey Konovalov --- Documentation/dev-tools/kasan.rst | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/Documentation/dev-tools/kasan.rst b/Documentation/dev-tools/kasan.rst index 343a683d0520..f21c0cbebcb3 100644 --- a/Documentation/dev-tools/kasan.rst +++ b/Documentation/dev-tools/kasan.rst @@ -41,22 +41,21 @@ and riscv architectures, and tag-based KASAN modes are supported only for arm64. Usage ----- -To enable KASAN configure kernel with:: +To enable KASAN, configure the kernel with:: - CONFIG_KASAN = y + CONFIG_KASAN=y -and choose between CONFIG_KASAN_GENERIC (to enable generic KASAN), -CONFIG_KASAN_SW_TAGS (to enable software tag-based KASAN), and -CONFIG_KASAN_HW_TAGS (to enable hardware tag-based KASAN). +and choose between ``CONFIG_KASAN_GENERIC`` (to enable generic KASAN), +``CONFIG_KASAN_SW_TAGS`` (to enable software tag-based KASAN), and +``CONFIG_KASAN_HW_TAGS`` (to enable hardware tag-based KASAN). -For software modes, you also need to choose between CONFIG_KASAN_OUTLINE and -CONFIG_KASAN_INLINE. Outline and inline are compiler instrumentation types. -The former produces smaller binary while the latter is 1.1 - 2 times faster. +For software modes, also choose between ``CONFIG_KASAN_OUTLINE`` and +``CONFIG_KASAN_INLINE``. Outline and inline are compiler instrumentation types. +The former produces a smaller binary while the latter is 1.1-2 times faster. -For better error reports that include stack traces, enable CONFIG_STACKTRACE. - -To augment reports with last allocation and freeing stack of the physical page, -it is recommended to enable also CONFIG_PAGE_OWNER and boot with page_owner=on. +To include alloc and free stack traces of affected slab objects into reports, +enable ``CONFIG_STACKTRACE``. To include alloc and free stack traces of affected +physical pages, enable ``CONFIG_PAGE_OWNER`` and boot with ``page_owner=on``. Error reports ~~~~~~~~~~~~~ -- 2.31.0.rc2.261.g7f71774620-goog