Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Alistair Popple <apopple@nvidia.com>
To:     Andrew Morton <akpm@linux-foundation.org>, will@kernel.org,
        catalin.marinas@arm.com
Cc:     linux-mm@kvack.org, linux-kernel@vger.kernel.org,
        robin.murphy@arm.com, nicolinc@nvidia.com,
        linux-arm-kernel@lists.infradead.org, kvm@vger.kernel.org,
        jgg@nvidia.com, John Hubbard <jhubbard@nvidia.com>,
        zhi.wang.linux@gmail.com, Sean Christopherson <seanjc@google.com>,
        Alistair Popple <apopple@nvidia.com>
Subject: [PATCH 1/2] mmu_notifiers: Restore documentation for .invalidate_range()
Date:   Wed, 24 May 2023 11:47:28 +1000
Message-Id: <3cece716fc09724793aa832e755abfc9d70a8bb3.1684892404.git-series.apopple@nvidia.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?Tl4A7wJneCaa4i0pkAyAA72UG0+OEGzvuvwm7SCqnucodfDKxvb2dZtkehKg?=
 =?us-ascii?Q?rfG9FetBUZtIy1iq9CtkK8TpSTbS9YgonJIcAEQzi5WK56K62thkYhPCc0gX?=
 =?us-ascii?Q?6FJw3ScThBxBXi1o1tOe+GCoIXLOflvfw8ToKWwj9QTGpFf7qwjRRwj5Z2kF?=
 =?us-ascii?Q?ysZutmYp2GavjPmkAG0R+yl4KwPMdRTBIRDfMzAwZjtqEYyXxQy58nizg3oC?=
 =?us-ascii?Q?ng0SyUQNFuFgbtWXRVyH+OLT4EyP5OYCmRDe3hEBmjfGm7N7EZ6L6TBtbWwA?=
 =?us-ascii?Q?OEB19/BnpyhX4cB9KcS/izYbavohOXnesdHazj5polC7s5sT+GCPpQANy17C?=
 =?us-ascii?Q?70vulZy2qgwGcWIimTa1r7U+D6bwtHItMxcXtCAN0ged0q/GQH5n65K5zyfG?=
 =?us-ascii?Q?/NLvB6MCeKujg0R6opF2UvwRfzS6bzqQdxWpHT3K6etb4ei5UKuGukZESWRV?=
 =?us-ascii?Q?++ac6kA0umy7nAJH78z+h3O0KYdz7XffUliDuUYukGZzXDvLKiCSi0l/cl6+?=
 =?us-ascii?Q?2aT3txhxtU7sn1JBAeOUIidF+Rkb9n+cKbtAZSzG3Z1N81axUE8tzBjO4FzU?=
 =?us-ascii?Q?IM5MtJN4yKCu8qXRTeWGx7sH7VKFWNLexfk45kPORLf3qbbydna63FaR9FSj?=
 =?us-ascii?Q?oRMVfAusgVeXcFgVGVQdwhBW6kGvkPbFYg7LjP9YWfu9aEhJDTAw5FFhtvZ4?=
 =?us-ascii?Q?A+qKFbKQ7haBy3X7XZ4rkd+++lyiuKZuQ82CIELpY+dx7lFoqOxgHlvoVvv7?=
 =?us-ascii?Q?cB4F9ERTnA59qPeyt/gEsXzGtut6+qg4jLTwYbD2+HxJyl6g2xjtCvJ9rkCN?=
 =?us-ascii?Q?fmwjhBS5wJtG4/T99DO6HHln1K/45tv5MLX90kmJpNHO6/Tywh5Gc/gWlKNI?=
 =?us-ascii?Q?z6qzxM8+zo1m0vtChm5UakqoowempNSOe//w4MeDmNU/yy5kvt9nLC90yalE?=
 =?us-ascii?Q?wzkTrjWhRDPsst5APCWZmBpHTG+t7aRCGVxUyrhvwVzMxu4gLRhl+0s283Pw?=
 =?us-ascii?Q?6vs/ZzQoSmJDoBCrbVMtwhnRDrSEisHFypqpuEVZSVzUwNTi3JexY81D9PUl?=
 =?us-ascii?Q?3IizYE1083evc9fivyLzZwo71Ysgo2ACztur8wXFrfv4sJDf3WEkS7xsCg1B?=
 =?us-ascii?Q?W3FVNJOSIfw9+iSmpKnuYx+BGwreYY8gB0/OPNmo7DmhOYonHMGR7/+bsEWo?=
 =?us-ascii?Q?CKHshVw9FeEwRI4MfrKfvSgjwSUTGOMrkHydJH1LgOFDyrZaE7dFa6sLVfQw?=
 =?us-ascii?Q?vuuKn4lKgxsZyOE4GmlbGEwEFFCFrZm3V0CVommIGC3zyYEroV1156QZg+xM?=
 =?us-ascii?Q?arsrWovLAI/zhYwUmfvGsSpAszDIOBLWoBv5B/huPV7FViZICHvOwXg4wJT9?=
 =?us-ascii?Q?Nur+duMaXwyKiQlAZ+8Miv0fYavh22zQEll1i3qdeCFGsFNtE/nNpR1rR6eN?=
 =?us-ascii?Q?6HIheVAPU92GDmER2gVeLlHXoN0pt4HAqxE0mU4NXP6LNtSkQ9QhlgXzMpUT?=
 =?us-ascii?Q?vLQi2Av0oXZIefkSQuqrdD8xvXQgWgmZ8AnpHrzNDiGW4QJXlLBje31a1hxu?=
 =?us-ascii?Q?8OiDzirVSIUqjOHYU0Pm662N4Tk98j6LHYlZ7aQy?=
X-OriginatorOrg: Nvidia.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 296ad4dd-298e-4f03-37cd-08db5bf8dd9c
X-MS-Exchange-CrossTenant-AuthSource: MN2PR12MB3181.namprd12.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 24 May 2023 01:47:43.3322
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 43083d15-7273-40c1-b7db-39efd9ccc17a
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: o8nzlMl1N86IZpbrrpOE23VRaBtxSTgVMaTXhzqKgky2yc/PjvPLZPmIznMHUzOSmTQ3/JiAcmcxMvDwkw90uQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY8PR12MB7492
X-Spam-Status: No, score=-1.1 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,
        DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FORGED_SPF_HELO,
        RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_NONE,
        T_SCC_BODY_TEXT_LINE,URIBL_BLOCKED autolearn=no autolearn_force=no
        version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

The .invalidate_range() callback is called by
mmu_notifier_invalidate_range() which is often called while holding
the ptl spin-lock. Therefore any implementations of this callback must
not sleep. This was originally documented when the call back was added
in commit 0f0a327fa12c ("mmu_notifier: add the callback for
mmu_notifier_invalidate_range()") but appears to have been
inadvertently removed by commit 5ff7091f5a2c ("mm, mmu_notifier:
annotate mmu notifiers with blockable invalidate callbacks").

Restore the comment to make it clear that .invalidate_range()
callbacks may not sleep.

Signed-off-by: Alistair Popple <apopple@nvidia.com>
---
 include/linux/mmu_notifier.h | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/include/linux/mmu_notifier.h b/include/linux/mmu_notifier.h
index 64a3e05..447d757 100644
--- a/include/linux/mmu_notifier.h
+++ b/include/linux/mmu_notifier.h
@@ -200,6 +200,9 @@ struct mmu_notifier_ops {
 	 * external TLB range needs to be flushed. For more in depth
 	 * discussion on this see Documentation/mm/mmu_notifier.rst
 	 *
+	 * The invalidate_range() function is called under the ptl
+	 * spin-lock and not allowed to sleep.
+	 *
 	 * Note that this function might be called with just a sub-range
 	 * of what was passed to invalidate_range_start()/end(), if
 	 * called between those functions.

base-commit: 44c026a73be8038f03dbdeef028b642880cf1511
-- 
git-series 0.9.1