Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:8 as permitted sender) client-ip=2620:137:e000::3:8;
References: <20230918201832.265108-1-jannh@google.com>
User-agent: mu4e 1.8.13; emacs 28.2
From:   Alistair Popple <apopple@nvidia.com>
To:     Jann Horn <jannh@google.com>
Cc:     Andrew Morton <akpm@linux-foundation.org>,
        Jason Gunthorpe <jgg@ziepe.ca>, linux-kernel@vger.kernel.org,
        linux-mm@kvack.org
Subject: Re: [PATCH] mm: document
 mmu_notifier_invalidate_range_start_nonblock()
Date:   Tue, 19 Sep 2023 10:08:06 +1000
In-reply-to: <20230918201832.265108-1-jannh@google.com>
Message-ID: <87bkdz58jq.fsf@nvdebian.thelocal>
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?iyktlHHnm/Yq3C9PCCBYd+2lpBYb7NLV2702yPAlwwgGZKGiNRHcbCO974ZK?=
 =?us-ascii?Q?5tyUiV3WJkdSCsAVQ+6yUujZ+PfBlQSlthajJ4ToFd+pGMCbRuomwCjZ0jKl?=
 =?us-ascii?Q?+ZU0u4hak20+EzLhXaa5ZWMrDWkU3e7Ifia4YxcM7sEGMmOGR6MQ8OxQlBsK?=
 =?us-ascii?Q?qiOIlcOYCqKFondwlMqdc4cxb76hje3XrEbZnpG7hxqRWfcBTUHUICI8MyDz?=
 =?us-ascii?Q?muGYrWx7NiI7tjhrhxJcOh2YBjtLjYmoiJbptqFiRCaow+z4EBlxUBhEZMJg?=
 =?us-ascii?Q?D6Gt0ZXGTN6HGg8nrRXGSt2njGu1EEhCC4AT4RHBkWAlzWwzfUJBFtHc2KQU?=
 =?us-ascii?Q?hVBNZTuXpcmjNrLTA/hELNaAjfLBpQidobzbMVS4phByTiQMYYckj0o7MUli?=
 =?us-ascii?Q?Gg1oAPvW19HK2oyWLlDuwwn+FJ4PrACKrnQFXZ0SM1JsRpTNloupmUG3VYYC?=
 =?us-ascii?Q?tlnU2XcuTwpq+6ZwI7REskP3TGqfj0TyCKIPJrmMa/nbW44VxQE1AVANaS5D?=
 =?us-ascii?Q?wmqujJCEHKCencLm3TRAkrzhC+xUfIUGSsaOnIL429KEqOJC8rj5iU7dEm08?=
 =?us-ascii?Q?0WSgbdxH52+rA17R5VGmWP49AmtVCRECwzDDbYXPh/713UnOG3fkZlvmQIj2?=
 =?us-ascii?Q?uSAbb3HjYQacpMI/nrpuZPKstQO2jXniDwQlyIz9TnsjSaB3J0Or3+jU/cYy?=
 =?us-ascii?Q?dVtiM4odalmyYIskI3GrL0sKmh1fM86vkbHxWUJTcCCY7oQlwvJ0v0oJ9lQy?=
 =?us-ascii?Q?dmPNY9A2hNGlvNVMKT0u3PNBgbMIsjlZnfn5Ji2tvWve61FVoecZAqzDmgmR?=
 =?us-ascii?Q?ayP8O/fis/pZo+UQu7kdTxs+Ydteky91E4LDpbLj8ZrHET4BdURCH3iVXtXv?=
 =?us-ascii?Q?Favxwydc0YTIp0gU9W+ryaQAuMScM9d023DqmTDUR5rcdfBRvjmW27dAS+Jo?=
 =?us-ascii?Q?AivsKmvTZVvBn/p9qQWQ95Qtlb4KfFntDOH+o6ky0D64Cyfg3jcbDYCk+57v?=
 =?us-ascii?Q?E+FUed19kdyQ7zah1Hy1lsIb238mhRp85JUACR7XvguGghddyZT57tgegP6+?=
 =?us-ascii?Q?vchlBQNANdhWxewcmmv448zd2WWmsK/GPLhD6xtCAk/VTTZdfH57InNo+L6Q?=
 =?us-ascii?Q?hKHbPnqrMfv7SHlmgcuc4h9hu276xnr62pq7lgA5mcG6piRpqV5e1xFL0OQe?=
 =?us-ascii?Q?mmeVni/guDtGVbbct+xlAj+JK30CAZOUgmhbZMK7f2ziXTd4iSbkK7rSJXK3?=
 =?us-ascii?Q?cZmLeFMfB1Aph0ex/3QQwQHl6PKenCG2jO6eyNhHaO0JRYQH2cM85ByUV4Qw?=
 =?us-ascii?Q?54c5ZAkZV/pHhGXoSLrtxow378rlwMZ2jYCMWOo6dkGYkbtWfboZ8iOPvxww?=
 =?us-ascii?Q?Q6sq2UYQPEaB/vvFpPM7MU+vZLBEMy1e6O6JYyOH2n5jj805v6RPzUGKid3h?=
 =?us-ascii?Q?cqlO5UV2QNI2G+0J/Dd576+khIXd/wgKRF0dAEJJrIK1w/QLY1OzGWO/lgab?=
 =?us-ascii?Q?dJ+5+dzyydegL2NPZZlFZj+DkUZcdp/XEtR8QyC4UpYLcti8Yil8iHEA2d0o?=
 =?us-ascii?Q?JUSkmP+U9+XhnYvoY0KK8S8zhA6takOXPRtM/rTu?=
X-OriginatorOrg: Nvidia.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 8f27ae1e-2e31-4855-d3d4-08dbb8a48eb3
X-MS-Exchange-CrossTenant-AuthSource: BYAPR12MB3176.namprd12.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 19 Sep 2023 00:08:31.2770
 (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: BO+2xzMLMS4Lvo4k6ErkCC2L3NMXs8SlgVNNoKN0lrge6QWMrAVSIUCqjQe3VNPbx9HWP92YvcdR3g4a9XjcWQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BY5PR12MB4212
X-Spam-Status: No, score=-0.9 required=5.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED,
	DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,
	MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=unavailable
	autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on fry.vger.email
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (fry.vger.email [0.0.0.0]); Mon, 18 Sep 2023 17:08:42 -0700 (PDT)


Looks good, thanks.

Reviewed-by: Alistair Popple <apopple@nvidia.com>

Jann Horn <jannh@google.com> writes:

> Document what mmu_notifier_invalidate_range_start_nonblock() is for.
> Also add a __must_check annotation to signal that callers must bail out if
> a notifier vetoes the operation.
>
> Signed-off-by: Jann Horn <jannh@google.com>
> ---
>  include/linux/mmu_notifier.h | 9 ++++++++-
>  1 file changed, 8 insertions(+), 1 deletion(-)
>
> diff --git a/include/linux/mmu_notifier.h b/include/linux/mmu_notifier.h
> index 6e3c857606f1..f349e08a9dfe 100644
> --- a/include/linux/mmu_notifier.h
> +++ b/include/linux/mmu_notifier.h
> @@ -459,7 +459,14 @@ mmu_notifier_invalidate_range_start(struct mmu_notifier_range *range)
>  	lock_map_release(&__mmu_notifier_invalidate_range_start_map);
>  }
>  
> -static inline int
> +/*
> + * This version of mmu_notifier_invalidate_range_start() avoids blocking, but it
> + * can return an error if a notifier can't proceed without blocking, in which
> + * case you're not allowed to modify PTEs in the specified range.
> + *
> + * This is mainly intended for OOM handling.
> + */
> +static inline int __must_check
>  mmu_notifier_invalidate_range_start_nonblock(struct mmu_notifier_range *range)
>  {
>  	int ret = 0;
>
> base-commit: 6704c78e2963a5682b4ac3c0e609d36f2405cf17