Received-SPF: pass (google.com: domain of linux-kernel+bounces-67563-linux.lists.archive=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99;
From: Juntong Deng <juntong.deng@outlook.com>
To: ryabinin.a.a@gmail.com,
	glider@google.com,
	andreyknvl@gmail.com,
	dvyukov@google.com,
	vincenzo.frascino@arm.com,
	corbet@lwn.net
Cc: kasan-dev@googlegroups.com,
	linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: [PATCH v2] kasan: Add documentation for CONFIG_KASAN_EXTRA_INFO
Date: Thu, 15 Feb 2024 19:17:23 +0000
Message-ID:
 <AM6PR03MB5848C52B871DA67455F0B2F2994D2@AM6PR03MB5848.eurprd03.prod.outlook.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-MessageSentRepresentingType: 1
X-MS-PublicTrafficType: Email
X-MS-TrafficTypeDiagnostic: AM6PR03MB5848:EE_|AS8PR03MB7064:EE_
X-MS-Office365-Filtering-Correlation-Id: b05df645-6d42-4c76-dd4e-08dc2e5ad044
X-MS-Exchange-SLBlob-MailProps:
	AlkLxVwsndmQJIsjirGokQVJ/lfvIDvZhrdTXLfBIxJFaJ+fkGENmPRMB/mYs8cowYRFp059SXgeymq7Ik6IUT4lbkOPrdRgOSqODAdpsDcWKhe5Fh5aRCPhY/icX48ePMLqki3vSrRuyH28r1mO0e/4SPzYJQL5TJt8vwxUnGg1oczeL6R8RkO7JjY2OODFEFtCJQO+m6eVl0sg6nf/gUBiYReETGebCEvJHQA1khRmIXSIFFq6qxPhsDU0oWhMAbFkLwa6c4X45YZRDSWALQfysRUlUZ306c1qSVaPslyz2u8YVJlH2C8oqXkXgKiPj3UgwwoZW0T8/k2SsqVNpF6vRXNRthgXcB4IR8AteQO7/jBqHFkSHf9ozfyD24RmeFBhOxMc7QWC3oGoiEFMiusHnuuEzGaEix9EsC08GMoaCZnWO9IAVOahWYqZ5jCBjEieBx9wwa7AlGl3a1F5ura5+l1JcA0csW3A3xXY5v7tNwXNlnw32+bJm5tvnuQh45brPfIOuRrsWgmNbPiEtUIrarDvAxte4NaegSHyysyywIz8WiqCPkmBFSXBy89Yw6zA8dJxTJFHOgj/a9zD17gdJkORm7HhrF+NVe9eJ+dtPfPvJU2zv8fHPI3l+61CNzrbIAjvQ6RdFq3qiLUQLubNDKfM+rqmfnjGYOr7ngl8CxSz0/F2v4eECIa6e19TCljpkYVDubSi+GM0Q3XNoiu5yTpRHdenj1ybn7RMMJ31ftccoDleDY04O+++YE2ofmgLG+r5US3NM87J+brTKCTT7QlAplEB
X-Microsoft-Antispam: BCL:0;
X-Microsoft-Antispam-Message-Info:
	YlTMErR6FDS9R1TOkNZ05GXB5XPOMaA/aDbNITeg+lqN1FnXf/HolqilEcUmoGedWhmbWYVNUI+yH83t8qaBXI/9x7frtGPuRqr6pp4Ppx/yCSRgMSBqWupGXV9ygQ89rlM+fcNqvhVFnKSXm0xB3sxcEfmT4yy9ufV/jYz+is2SyAVO8O75xoQOdjG4eMRJpq+SffaRIGRfMcCuqgYQMp9WWDuTp2yc2k0aza0sOE3WN8Oy+coTDCZ5RNd36EqMNft8eGXjpRiO2M7i6597WfgT31unf1HUbDeUoE1fe0pavvkTNsVvhDRl5F/czGcEYtWTDJFor4viOat67UtdqIBdRLXnT7fTEes8xAzZj9Bz4PFPO+4pE0UZavxmwLZBOfKxj1etyVqaNkAH45XuSs3DsdqfsEQ3tfgId9jmcFfeh7KQ5hNyboOTpQnPxZyY9sqf+IvNoEuCd7wvl+9QXh+PVgJ29boPTTyfzXcTD5PJVdYG68RtvAc8BPrYWoDSOsGFZD3PLknbZVcY4MJq0Qb2npLnFIIwI81Rpo8waX2VnS//lGa38GRkq0/WKf6v
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?us-ascii?Q?9OzFaSswNo9G2D9txM7B7QtFuiUyLmwpsarR9TUcZ5sWYm4k0c8E4Ei9rd9S?=
 =?us-ascii?Q?nImPZ6P8zyKMykAG82p6NUnVmXfYhLzjElaU4swMWXkvCi8Pqpi9H5zJiqCJ?=
 =?us-ascii?Q?kAEU8pHQewJAsYWGf23YM9muhjt4DybOkrNSlev3WhUlR7YtnxV3yZ+JHI4B?=
 =?us-ascii?Q?XkQevuTjSz8zlvYw37Y518rAc345YrhLdn6si+W2atzRPPFSdcl0EqnEwqm5?=
 =?us-ascii?Q?JLs5QL1s27YoQvxDVGGvcj69Z4a2luZwmbXAcohAulmBtphQF881geD76VfD?=
 =?us-ascii?Q?Jqan/qQIuyOgRwvHboi03QddzQIt9eaC8t38eVTcaRZqZlPB1VgfDiKQrkoI?=
 =?us-ascii?Q?GEGrvV/E8XtKms+9gf12hf+6Z6wtma50m1fYJUZ7yjT++aVmuV/YQ1KAeG3A?=
 =?us-ascii?Q?s2AxAoX08OpQTn8K1WZmdKEIh6qVI0RT7oAfeS60iCGkcoLSOMoGPfbcza28?=
 =?us-ascii?Q?FK7HPI2W3oJqMnNYFHpFD/BUv/yUGTyFUz0UI+2p7NtOuSff8aH/I80OD9Ja?=
 =?us-ascii?Q?5GmEJLITPj3/wKnrrV3lylQ8mP089Ty0fVCBlLhrl83FXg/bP5egvyStYVkU?=
 =?us-ascii?Q?/SevW3p3hGA8Lf3Ew5eZU+nBu5i/JGIDmXtYGTbb3mjKbNvqezZyUQvwT4Z/?=
 =?us-ascii?Q?+fomMAiG+2pBfEJTZHw6D/bgnQHvK/AqB6RgCMgT6T+vLAGhHrEEfObmy+Px?=
 =?us-ascii?Q?yiw3q4uVMp0Uo9DcK4dpyrJSfGZO9Ztyedpovi/NSYtt7xUyRG+MiaDGKwa5?=
 =?us-ascii?Q?N6MQk+3n8tW2hyCrzcOdswZQWoexkPZ6Vh7KRG1WY8//jQMD6IydITBKsbCi?=
 =?us-ascii?Q?wYY24wcfalMZiIEplYD/WRcBQyqHefGvpOtAO9hSlet6qdAbo8zHAcnLlds7?=
 =?us-ascii?Q?FxmQ51YHqiMbbitH3ZRcLSOG2yy6TBEhUC6tfyvjjjN+spckjgbT2N4EJShL?=
 =?us-ascii?Q?fHw7yicnfBBkuZy/51/mPs7e7vE8VPbTqCEzplMOrZanxGs2FNs430Brmy3U?=
 =?us-ascii?Q?KJuURtKXNLSnmOgeQqUl5vD4eQEdA0AuMChjaipcO+qFXcwCOQ04IWRTCfHb?=
 =?us-ascii?Q?cblMck3Z3dPwAojTFXaIaSsc3GbF+RTQR9kQJc54hMJxq+9pERofF5PYXf2w?=
 =?us-ascii?Q?/1wqCaCaI9yMHqxajTiNSh2g0iXX0F5MTQrzhFbYVzrqvXRe1dGAPzEomtt9?=
 =?us-ascii?Q?FWygJWoM1+NRXu90FoasO9m4R/R9bpSyCs9MsXuuCZnsvGgW7CwJwgGCgZwA?=
 =?us-ascii?Q?DDmiEQl2X9o2qp96r2ko?=
X-OriginatorOrg: outlook.com
X-MS-Exchange-CrossTenant-Network-Message-Id: b05df645-6d42-4c76-dd4e-08dc2e5ad044
X-MS-Exchange-CrossTenant-AuthSource: AM6PR03MB5848.eurprd03.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 15 Feb 2024 19:17:55.8135
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 84df9e7f-e9f6-40af-b435-aaaaaaaaaaaa
X-MS-Exchange-CrossTenant-RMS-PersistedConsumerOrg:
	00000000-0000-0000-0000-000000000000
X-MS-Exchange-Transport-CrossTenantHeadersStamped: AS8PR03MB7064

This patch adds CONFIG_KASAN_EXTRA_INFO introduction information to
KASAN documentation.

Signed-off-by: Juntong Deng <juntong.deng@outlook.com>
---
V1 -> V2: Fix run-on sentence.

 Documentation/dev-tools/kasan.rst | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/Documentation/dev-tools/kasan.rst b/Documentation/dev-tools/kasan.rst
index a5a6dbe9029f..d7de44f5339d 100644
--- a/Documentation/dev-tools/kasan.rst
+++ b/Documentation/dev-tools/kasan.rst
@@ -277,6 +277,27 @@ traces point to places in code that interacted with the object but that are not
 directly present in the bad access stack trace. Currently, this includes
 call_rcu() and workqueue queuing.
 
+CONFIG_KASAN_EXTRA_INFO
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Enabling CONFIG_KASAN_EXTRA_INFO allows KASAN to record and report more
+information. The extra information currently supported is the CPU number and
+timestamp at allocation and free. More information can help find the cause of
+the bug and correlate the error with other system events, at the cost of using
+extra memory to record more information (more cost details in the help text of
+CONFIG_KASAN_EXTRA_INFO).
+
+Here is the report with CONFIG_KASAN_EXTRA_INFO enabled (only the
+different parts are shown)::
+
+    ==================================================================
+    ...
+    Allocated by task 134 on cpu 5 at 229.133855s:
+    ...
+    Freed by task 136 on cpu 3 at 230.199335s:
+    ...
+    ==================================================================
+
 Implementation details
 ----------------------
 
-- 
2.39.2