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=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 339E4C433E0 for ; Fri, 12 Mar 2021 14:24:45 +0000 (UTC) Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by mail.kernel.org (Postfix) with ESMTP id CE9E864FC3 for ; Fri, 12 Mar 2021 14:24:44 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org CE9E864FC3 Authentication-Results: mail.kernel.org; dmarc=fail (p=reject dis=none) header.from=google.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=owner-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix) id 708118D035D; Fri, 12 Mar 2021 09:24:44 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 6E2AA8D0346; Fri, 12 Mar 2021 09:24:44 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 4E2848D035D; Fri, 12 Mar 2021 09:24:44 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from forelay.hostedemail.com (smtprelay0227.hostedemail.com [216.40.44.227]) by kanga.kvack.org (Postfix) with ESMTP id 2D6A08D0346 for ; Fri, 12 Mar 2021 09:24:44 -0500 (EST) Received: from smtpin07.hostedemail.com (10.5.19.251.rfc1918.com [10.5.19.251]) by forelay02.hostedemail.com (Postfix) with ESMTP id D16D083F8 for ; Fri, 12 Mar 2021 14:24:43 +0000 (UTC) X-FDA: 77911443246.07.EFBE5A3 Received: from mail-qv1-f74.google.com (mail-qv1-f74.google.com [209.85.219.74]) by imf25.hostedemail.com (Postfix) with ESMTP id 8C1596000111 for ; Fri, 12 Mar 2021 14:24:41 +0000 (UTC) Received: by mail-qv1-f74.google.com with SMTP id i1so17662848qvu.12 for ; Fri, 12 Mar 2021 06:24:43 -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=UIn9R6iWNTpuninm8yzAqfvqLsQ1Z3TszvORzjzD33U=; b=BfEhzme8NfucFms3TKi7BojlgEWJYM76BAeBCWDV2onmk63nYw8AWfe/XU1X7ifiQ7 5uRMoXe9Ikc/W7RI035b0qscpd8roWNpxeMSEllp4YO1FTC2sFGr0BNbtY3+TufVBmt/ URK7CrQbV13rwXPEi+EwDf+xXnFlQJ0hVrt51LE+sMH9dZK/nUoXS+mbn2uf68Km+Yoo HU/UnO6E+lqMkw2TTcN1WKvT7fpLpVUGpg+S1m6SkcMuU3agedBTSxKNxBQIWlL4VTBi m8230PNbLFrfbIk4DV3yRw4fPuYGAAuXZbdB09lBg8+JNxKYV75kfWkwLZyOu24KMBIj n+Mg== 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=UIn9R6iWNTpuninm8yzAqfvqLsQ1Z3TszvORzjzD33U=; b=pjH/JWB58LIztrEPIO/IyV4clEho/RVWTwfw/w36vi4PGe9GvwFYOML/b/cmKy7NDB odSqRtQEBMXUzb4p0olhEiS7xRNkAH0fnyERsZz5e0niZefbrQpvO42A3LyMhs0MD7uu jwddTsKvwK6uG4yW5WVfhl7kvgPp7NUh63/qW5SQYVohskXyHrrYWFhocm0/4PdmFdRZ sE+D7pCq4MZlqgY3oNPN4Z7IN5F4jsE0Y8ZyBzSiCDYt7YlOC1H/O8VjoJFU1C8O3o3l 0Gs61S4T1sBVVaecY98r/4lCvX8Q6c/x7NxZP+CJXURNuPk33pIGLXlmZdMsJsjyE8Uh 9wbg== X-Gm-Message-State: AOAM533fuP4S50hwk7N9H8tenA19sd/cBuRy/RShUaDE/sP46XgnYUq9 Nk6IUxzNZUrvZ8yat0TGK5e9LyqCoqURpWZC X-Google-Smtp-Source: ABdhPJxhhQrSrGA1QsOqnoYKLh4lvDwtbCsjqjKI4lZ1uccEccLCH1TKhzag8wYYWyL8wB6MDNjfjq9i8g2TZq7N X-Received: from andreyknvl3.muc.corp.google.com ([2a00:79e0:15:13:95a:d8a8:4925:42be]) (user=andreyknvl job=sendgmr) by 2002:a0c:aa45:: with SMTP id e5mr1897790qvb.44.1615559082706; Fri, 12 Mar 2021 06:24:42 -0800 (PST) Date: Fri, 12 Mar 2021 15:24:26 +0100 In-Reply-To: Message-Id: <48427809cd4b8b5d6bc00926cbe87e2b5081df17.1615559068.git.andreyknvl@google.com> Mime-Version: 1.0 References: X-Mailer: git-send-email 2.31.0.rc2.261.g7f71774620-goog Subject: [PATCH v2 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" X-Rspamd-Server: rspam04 X-Rspamd-Queue-Id: 8C1596000111 X-Stat-Signature: fygd6dcti6mh3qtqo8um6k48drcbiyio Received-SPF: none (flex--andreyknvl.bounces.google.com>: No applicable sender policy available) receiver=imf25; identity=mailfrom; envelope-from="<3qnlLYAoKCNMzC2G3N9CKA5DD5A3.1DBA7CJM-BB9Kz19.DG5@flex--andreyknvl.bounces.google.com>"; helo=mail-qv1-f74.google.com; client-ip=209.85.219.74 X-HE-DKIM-Result: pass/pass X-HE-Tag: 1615559081-566667 X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: 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 2f2697b290d5..46f4e9680805 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