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=-24.8 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_SANE_1,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 21598C433E0 for ; Fri, 12 Mar 2021 15:09:06 +0000 (UTC) Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by mail.kernel.org (Postfix) with ESMTP id BF86964FDC for ; Fri, 12 Mar 2021 15:09:05 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org BF86964FDC 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 618986B006C; Fri, 12 Mar 2021 10:09:05 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 5C71D6B006E; Fri, 12 Mar 2021 10:09:05 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 440906B0072; Fri, 12 Mar 2021 10:09:05 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from forelay.hostedemail.com (smtprelay0140.hostedemail.com [216.40.44.140]) by kanga.kvack.org (Postfix) with ESMTP id 28DE46B006C for ; Fri, 12 Mar 2021 10:09:05 -0500 (EST) Received: from smtpin14.hostedemail.com (10.5.19.251.rfc1918.com [10.5.19.251]) by forelay01.hostedemail.com (Postfix) with ESMTP id E1B99180214FA for ; Fri, 12 Mar 2021 15:09:04 +0000 (UTC) X-FDA: 77911555008.14.555A161 Received: from mail-wm1-f42.google.com (mail-wm1-f42.google.com [209.85.128.42]) by imf18.hostedemail.com (Postfix) with ESMTP id 127B020053D1 for ; Fri, 12 Mar 2021 15:09:03 +0000 (UTC) Received: by mail-wm1-f42.google.com with SMTP id c76-20020a1c9a4f0000b029010c94499aedso16009708wme.0 for ; Fri, 12 Mar 2021 07:09:02 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20161025; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to:user-agent; bh=8MLa7BfE7dVLn4tTMKZ+HSLGOdEizmmjEqt3urdruHo=; b=YXc7cfUGiDH4BrcqeCbErclE5UpFbj0KRoCqW+CdxyNwQfypBnOQ/JXl/BQWZPYMSf 5Ot87rpsNwc67IcIMaUT/2mT5iQ6JifR2oOH4+1U/x2JoNkrhbmVOP0/YaoFweuMp7Xz 9cjsoeb2E5H/+ycRfan42lPk+YhVQV0q9C93ePz3hYTf3vqsa7zhKFLd+0J374z3OvPR q6pRk3yb3Fm5X2u5AfJvSoi8ssYpIoIVql9zeUnzsjQwAIsrhkKfqf6SypfcT5+zh6SL StmOqnQ0w/Qq6RFrjTQcbTOAerPuU/TSLKo2ozPFpgkU0a0XsO0QSJg8Jy9m9AYJukk+ DznQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to:user-agent; bh=8MLa7BfE7dVLn4tTMKZ+HSLGOdEizmmjEqt3urdruHo=; b=rUgdA4tC38miTQPpEt4BbukJqBSEMs6ohmHJUwlHmiSXLq2xmLzsOmvbd8e8EvdZmp oNFw/T9cQtj3MVH0niIu17ARBXGvTJxExSltiVvKJzUCpx3zICwphz2/MjMk2lB002eC L956Alp53c/7zu1pXqjm5yIaKIGQHYx0Wtj9vvEtDZnm3COgtafKl0ZX5FKlmq06U995 DC9qGgAp3U0r/sjbEWAYSnAyg/Wf/9IzT/y7+QefpXmhVH/fQhsRvMYnBEK9PUoS5S97 FPDNs7/b8+EEC/BcUiZzPFjuXI8gFrjGciGqFIDn/8Wt3bWT5nvX8voem5CzAertABwx Md3A== X-Gm-Message-State: AOAM533X7AP8L4r3+s5iCfe7uAAv2ephlQbiWTAnCJjw4OA60sAtIv3H +F7OFxahqbTuenQEV0oxOSrkJg== X-Google-Smtp-Source: ABdhPJzugoYcXn8oExDHUrj07sG0kptHYTO8yEvVKp4/4x1MmKQHsAr23VIN62ownUD9pD+bMeZBnA== X-Received: by 2002:a05:600c:2053:: with SMTP id p19mr13577526wmg.87.1615561741593; Fri, 12 Mar 2021 07:09:01 -0800 (PST) Received: from elver.google.com ([2a00:79e0:15:13:d5de:d45f:f79c:cb62]) by smtp.gmail.com with ESMTPSA id w131sm2402679wmb.8.2021.03.12.07.09.00 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 12 Mar 2021 07:09:00 -0800 (PST) Date: Fri, 12 Mar 2021 16:08:55 +0100 From: Marco Elver To: Andrey Konovalov Cc: Andrew Morton , Alexander Potapenko , Andrey Ryabinin , Dmitry Vyukov , kasan-dev@googlegroups.com, linux-mm@kvack.org, linux-kernel@vger.kernel.org Subject: Re: [PATCH v2 06/11] kasan: docs: update GENERIC implementation details section Message-ID: References: MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: User-Agent: Mutt/2.0.5 (2021-01-21) X-Rspamd-Server: rspam04 X-Rspamd-Queue-Id: 127B020053D1 X-Stat-Signature: sp89ihuzamudxpu1xhcf4x1wqrui4ccn Received-SPF: none (google.com>: No applicable sender policy available) receiver=imf18; identity=mailfrom; envelope-from=""; helo=mail-wm1-f42.google.com; client-ip=209.85.128.42 X-HE-DKIM-Result: pass/pass X-HE-Tag: 1615561743-600517 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: On Fri, Mar 12, 2021 at 03:24PM +0100, Andrey Konovalov wrote: > Update the "Implementation details" section for generic KASAN: > > - Don't mention kmemcheck, it's not present in the kernel anymore. > - Don't mention GCC as the only supported compiler. > - Update kasan_mem_to_shadow() definition to match actual code. > - Punctuation, readability, and other minor clean-ups. > > Signed-off-by: Andrey Konovalov Reviewed-by: Marco Elver > --- > Documentation/dev-tools/kasan.rst | 27 +++++++++++++-------------- > 1 file changed, 13 insertions(+), 14 deletions(-) > > diff --git a/Documentation/dev-tools/kasan.rst b/Documentation/dev-tools/kasan.rst > index 1189be9b4cb5..986410bf269f 100644 > --- a/Documentation/dev-tools/kasan.rst > +++ b/Documentation/dev-tools/kasan.rst > @@ -200,12 +200,11 @@ Implementation details > Generic KASAN > ~~~~~~~~~~~~~ > > -From a high level perspective, KASAN's approach to memory error detection is > -similar to that of kmemcheck: use shadow memory to record whether each byte of > -memory is safe to access, and use compile-time instrumentation to insert checks > -of shadow memory on each memory access. > +Software KASAN modes use shadow memory to record whether each byte of memory is > +safe to access and use compile-time instrumentation to insert shadow memory > +checks before each memory access. > > -Generic KASAN dedicates 1/8th of kernel memory to its shadow memory (e.g. 16TB > +Generic KASAN dedicates 1/8th of kernel memory to its shadow memory (16TB > to cover 128TB on x86_64) and uses direct mapping with a scale and offset to > translate a memory address to its corresponding shadow address. > > @@ -214,23 +213,23 @@ address:: > > static inline void *kasan_mem_to_shadow(const void *addr) > { > - return ((unsigned long)addr >> KASAN_SHADOW_SCALE_SHIFT) > + return (void *)((unsigned long)addr >> KASAN_SHADOW_SCALE_SHIFT) > + KASAN_SHADOW_OFFSET; > } > > where ``KASAN_SHADOW_SCALE_SHIFT = 3``. > > Compile-time instrumentation is used to insert memory access checks. Compiler > -inserts function calls (__asan_load*(addr), __asan_store*(addr)) before each > -memory access of size 1, 2, 4, 8 or 16. These functions check whether memory > -access is valid or not by checking corresponding shadow memory. > +inserts function calls (``__asan_load*(addr)``, ``__asan_store*(addr)``) before > +each memory access of size 1, 2, 4, 8, or 16. These functions check whether > +memory accesses are valid or not by checking corresponding shadow memory. > > -GCC 5.0 has possibility to perform inline instrumentation. Instead of making > -function calls GCC directly inserts the code to check the shadow memory. > -This option significantly enlarges kernel but it gives x1.1-x2 performance > -boost over outline instrumented kernel. > +With inline instrumentation, instead of making function calls, the compiler > +directly inserts the code to check shadow memory. This option significantly > +enlarges the kernel, but it gives an x1.1-x2 performance boost over the > +outline-instrumented kernel. > > -Generic KASAN is the only mode that delays the reuse of freed object via > +Generic KASAN is the only mode that delays the reuse of freed objects via > quarantine (see mm/kasan/quarantine.c for implementation). > > Software tag-based KASAN > -- > 2.31.0.rc2.261.g7f71774620-goog >