From patchwork Fri Mar 12 14:24:31 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andrey Konovalov X-Patchwork-Id: 12134797 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 CDBECC433DB for ; Fri, 12 Mar 2021 14:24:57 +0000 (UTC) Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by mail.kernel.org (Postfix) with ESMTP id 77E2D64FB2 for ; Fri, 12 Mar 2021 14:24:57 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 77E2D64FB2 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 161B18D0362; Fri, 12 Mar 2021 09:24:57 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 0EAE98D0360; Fri, 12 Mar 2021 09:24:57 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id ECFEA8D0361; Fri, 12 Mar 2021 09:24:56 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from forelay.hostedemail.com (smtprelay0216.hostedemail.com [216.40.44.216]) by kanga.kvack.org (Postfix) with ESMTP id CB14D8D0360 for ; Fri, 12 Mar 2021 09:24:56 -0500 (EST) Received: from smtpin08.hostedemail.com (10.5.19.251.rfc1918.com [10.5.19.251]) by forelay05.hostedemail.com (Postfix) with ESMTP id 7FD5C181D7EC4 for ; Fri, 12 Mar 2021 14:24:56 +0000 (UTC) X-FDA: 77911443792.08.1FEAA03 Received: from mail-wm1-f73.google.com (mail-wm1-f73.google.com [209.85.128.73]) by imf26.hostedemail.com (Postfix) with ESMTP id 2A0EC407F8FA for ; Fri, 12 Mar 2021 14:24:53 +0000 (UTC) Received: by mail-wm1-f73.google.com with SMTP id o9so2104754wmq.9 for ; Fri, 12 Mar 2021 06:24:55 -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=AADxbeoNuphnMvdgMWHUkUamhVrmAjoCfQWWs7Kvkug=; b=jCrEWQlY9zh5WxZDht/sPXYdkvCCWmhovQqVcz4wxPAIINp3noeg/Ihbr62XzpFxFx 9TYtNPkjrHs7tvLdJ3y5I9Vrob6rePF0RDb9H9nE4TPYRuvSClb1iifQL88/87f7bIb5 ggwioZgT6VUHk45puUhqCYPW4UDzSrQbxaj0YeCQUghMA9v4C0XLY76L1+lre1JkSqWF nB1rQ1XmQBC3/zjODsXnoVRLrXlsxQiNrqdUZ0hQu2bom5QIj76rhRFPTqzBNPbn/Kpa uzVxicMes2Yq9IIU0ovEugsTH2BRhouJbMjo7aw+hgmXAoxp+pEdOFd8RVeD3RLTJKyu pYdw== 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=AADxbeoNuphnMvdgMWHUkUamhVrmAjoCfQWWs7Kvkug=; b=JDqHhBoleK1IL/Sp1chYPMomoTcCLk6K/v5lyhWct9QjqdiG0RUyKDQJUyQbzmQl0k 13nDVA6MpuYksC+qUk81H5OC0Q/D0b3i/eMG3i3qssyAToFl9diOQxKvdlgJcdUQxkvS cfvzUKXpmjKY5Gmn4Rr5D8n04ziiqRFarzXNpiZwGaOG4jP4qou+8gICHs/aQVll1mQ3 eedmE66mxSX9Cjv8PKCLDTCB6W3rLniciPPVwRSGhnKJLsJ+oHzgq6JucYZf001vfj/c yOr5b21DpQOP61D5Iev7SgG/G5kh7J4dwJpqrjiwJPt+/X7KNNCkO63NSdzZdYy4qbye QPNg== X-Gm-Message-State: AOAM533VJfiTKaDluvhe9aymFhW1M7AaXoey//dCX9n0VdBTnC/LwzEW EU3uzYK8Vq2QK8sf6p2Bl2QJqT9cOBH1Xh11 X-Google-Smtp-Source: ABdhPJyexprf1NyGf3J69SnjE5FHdNd0neUkuvSB9iYVeSIHY/h0QFTzjgPmZ58G1l053wwEm4PTcv2OZl8ePB9E X-Received: from andreyknvl3.muc.corp.google.com ([2a00:79e0:15:13:95a:d8a8:4925:42be]) (user=andreyknvl job=sendgmr) by 2002:a5d:4688:: with SMTP id u8mr14154024wrq.39.1615559094829; Fri, 12 Mar 2021 06:24:54 -0800 (PST) Date: Fri, 12 Mar 2021 15:24:31 +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 v2 08/11] kasan: docs: update HW_TAGS implementation details 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 X-Stat-Signature: hmke3f8iakq8xa34j1iutzh15e6uxiq6 X-Rspamd-Server: rspam01 X-Rspamd-Queue-Id: 2A0EC407F8FA Received-SPF: none (flex--andreyknvl.bounces.google.com>: No applicable sender policy available) receiver=imf26; identity=mailfrom; envelope-from="<3tnlLYAoKCN8BOESFZLOWMHPPHMF.DPNMJOVY-NNLWBDL.PSH@flex--andreyknvl.bounces.google.com>"; helo=mail-wm1-f73.google.com; client-ip=209.85.128.73 X-HE-DKIM-Result: pass/pass X-HE-Tag: 1615559093-222376 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 "Implementation details" section for HW_TAGS KASAN: - Punctuation, readability, and other minor clean-ups. Signed-off-by: Andrey Konovalov Reviewed-by: Marco Elver --- Documentation/dev-tools/kasan.rst | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/Documentation/dev-tools/kasan.rst b/Documentation/dev-tools/kasan.rst index 5873d80cc1fd..2744ae6347c6 100644 --- a/Documentation/dev-tools/kasan.rst +++ b/Documentation/dev-tools/kasan.rst @@ -270,35 +270,35 @@ memory. Hardware tag-based KASAN ~~~~~~~~~~~~~~~~~~~~~~~~ -Hardware tag-based KASAN is similar to the software mode in concept, but uses +Hardware tag-based KASAN is similar to the software mode in concept but uses hardware memory tagging support instead of compiler instrumentation and shadow memory. Hardware tag-based KASAN is currently only implemented for arm64 architecture and based on both arm64 Memory Tagging Extension (MTE) introduced in ARMv8.5 -Instruction Set Architecture, and Top Byte Ignore (TBI). +Instruction Set Architecture and Top Byte Ignore (TBI). Special arm64 instructions are used to assign memory tags for each allocation. Same tags are assigned to pointers to those allocations. On every memory -access, hardware makes sure that tag of the memory that is being accessed is -equal to tag of the pointer that is used to access this memory. In case of a -tag mismatch a fault is generated and a report is printed. +access, hardware makes sure that the tag of the memory that is being accessed is +equal to the tag of the pointer that is used to access this memory. In case of a +tag mismatch, a fault is generated, and a report is printed. Hardware tag-based KASAN uses 0xFF as a match-all pointer tag (accesses through -pointers with 0xFF pointer tag aren't checked). The value 0xFE is currently +pointers with the 0xFF pointer tag are not checked). The value 0xFE is currently reserved to tag freed memory regions. -Hardware tag-based KASAN currently only supports tagging of -kmem_cache_alloc/kmalloc and page_alloc memory. +Hardware tag-based KASAN currently only supports tagging of slab and page_alloc +memory. -If the hardware doesn't support MTE (pre ARMv8.5), hardware tag-based KASAN -won't be enabled. In this case all boot parameters are ignored. +If the hardware does not support MTE (pre ARMv8.5), hardware tag-based KASAN +will not be enabled. In this case, all KASAN boot parameters are ignored. -Note, that enabling CONFIG_KASAN_HW_TAGS always results in in-kernel TBI being -enabled. Even when kasan.mode=off is provided, or when the hardware doesn't +Note that enabling CONFIG_KASAN_HW_TAGS always results in in-kernel TBI being +enabled. Even when ``kasan.mode=off`` is provided or when the hardware does not support MTE (but supports TBI). -Hardware tag-based KASAN only reports the first found bug. After that MTE tag +Hardware tag-based KASAN only reports the first found bug. After that, MTE tag checking gets disabled. Shadow memory