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=-14.3 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,NICE_REPLY_A,SPF_HELO_NONE,SPF_PASS,USER_AGENT_SANE_1 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 1BCE0C433C1 for ; Fri, 19 Mar 2021 22:25:36 +0000 (UTC) Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by mail.kernel.org (Postfix) with ESMTP id 42AB361978 for ; Fri, 19 Mar 2021 22:25:35 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 42AB361978 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=gmail.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=owner-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix) id 8C7E66B006E; Fri, 19 Mar 2021 18:25:34 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 89F986B0070; Fri, 19 Mar 2021 18:25:34 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 740136B0071; Fri, 19 Mar 2021 18:25:34 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from forelay.hostedemail.com (smtprelay0035.hostedemail.com [216.40.44.35]) by kanga.kvack.org (Postfix) with ESMTP id 523456B006E for ; Fri, 19 Mar 2021 18:25:34 -0400 (EDT) Received: from smtpin22.hostedemail.com (10.5.19.251.rfc1918.com [10.5.19.251]) by forelay01.hostedemail.com (Postfix) with ESMTP id 191D118244EDE for ; Fri, 19 Mar 2021 22:25:34 +0000 (UTC) X-FDA: 77938056546.22.BA07381 Received: from mail-wm1-f48.google.com (mail-wm1-f48.google.com [209.85.128.48]) by imf01.hostedemail.com (Postfix) with ESMTP id 9AE615001526 for ; Fri, 19 Mar 2021 22:25:32 +0000 (UTC) Received: by mail-wm1-f48.google.com with SMTP id a132-20020a1c668a0000b029010f141fe7c2so5828432wmc.0 for ; Fri, 19 Mar 2021 15:25:33 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=subject:to:cc:references:from:message-id:date:user-agent :mime-version:in-reply-to:content-language:content-transfer-encoding; bh=0qJ0F+Ko5F17OCQ9a8TQBdPdWsAoef7x4iebSXWjHz4=; b=C7uO0ez3RF444hrIrM9Iv2072ivubOU3jSVQq4FnQiRqph94jp1+01AFHPyslDQK4z FwHTnegiI9Epb5P3F0+1/o51XHrZ6tZ7Z2phTZkNztJddgiAwR8wqukC9VJuwlJdNtpf aoKINvSkuG87/UoMXaR/NmpHz0tuXK0OXFT6xZxzjSlgy5rWU/wVsnF34PrEtkGyAAJb isjCNS2qoGg0Dc+KcaJ57Ou9VkDINw2p/JQ+21Y+AkA8sXeAVw9Du5WadIQ1fBAn1Kea AlSbUq0shiwS8IeM2Bm/sZXMOxwafBP7qyXFdiThNBFmdwakoPIE1Zn2CxxB55PWLJiL 0DcQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:subject:to:cc:references:from:message-id:date :user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=0qJ0F+Ko5F17OCQ9a8TQBdPdWsAoef7x4iebSXWjHz4=; b=WiP/kK83g/xD5t8aGPJna1SX/RUu+xyd3ydRvp3DHEmonfp+/RXuPLRumw58G9MPy2 lM60QS/k3LDaiwGmrcdgvkKvV0kG25O3yqAu8hPM9m9LfRrdAlAb+QcjTr7gbuRda6oi XolR7WNhrSMzr5brbH0XJ75HcElD9I5VA36SHGLUTcaVrY5BtjN/xZrFS79DBRtyVHYz WXiMLyNTVTdMv5/aXqVr8duwbXr5Zs1O5IVMBcxYvxp9r/LgzBloEp2M4lfjtjuLJn8s ySir1Ov8EcMK4y1tkeAJXKdEoy9fqND/H+hciaG+BO2sRDbr7qUJf85m2MDxQPELAQYL o0WQ== X-Gm-Message-State: AOAM530vu9+xEfCiSwlZ9BE07PC/Z13XN1Pj19bSmr/z2rVPfe+ZzBgW NhX5EexG50yqLCOs4wXcQzY= X-Google-Smtp-Source: ABdhPJwzP1ce+0dIeV/2+ib339ExEqc3pFRBnhNYzsVL1+ucoQURn/m2yADVSNoBDyWYQFZnba4coA== X-Received: by 2002:a7b:c5c8:: with SMTP id n8mr5432346wmk.63.1616192732337; Fri, 19 Mar 2021 15:25:32 -0700 (PDT) Received: from [192.168.0.160] ([170.253.36.171]) by smtp.gmail.com with ESMTPSA id v3sm7767424wmj.25.2021.03.19.15.25.31 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Fri, 19 Mar 2021 15:25:31 -0700 (PDT) Subject: Re: [PATCH v3 2/4] userfaultfd.2: Add write-protect mode To: Peter Xu , linux-man@vger.kernel.org Cc: Andrea Arcangeli , Michael Kerrisk , Axel Rasmussen , linux-kernel@vger.kernel.org, Linux MM Mailing List , Andrew Morton , Nadav Amit , Mike Rapoport References: <20210310222300.200054-1-peterx@redhat.com> <20210310222300.200054-3-peterx@redhat.com> From: "Alejandro Colomar (man-pages)" Message-ID: <75a4cec1-dc64-1c85-19eb-655c1d4209fc@gmail.com> Date: Fri, 19 Mar 2021 23:25:30 +0100 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.7.1 MIME-Version: 1.0 In-Reply-To: <20210310222300.200054-3-peterx@redhat.com> Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit X-Rspamd-Server: rspam03 X-Rspamd-Queue-Id: 9AE615001526 X-Stat-Signature: gzj7ykgumi9wcs6k5kdi8x4oqaq38k36 Received-SPF: none (gmail.com>: No applicable sender policy available) receiver=imf01; identity=mailfrom; envelope-from=""; helo=mail-wm1-f48.google.com; client-ip=209.85.128.48 X-HE-DKIM-Result: pass/pass X-HE-Tag: 1616192732-754615 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: Hi Peter, Please, see a few minor comments below. Thanks, Alex On 3/10/21 11:22 PM, Peter Xu wrote: > Write-protect mode is supported starting from Linux 5.7. > > Signed-off-by: Peter Xu > --- > man2/userfaultfd.2 | 103 ++++++++++++++++++++++++++++++++++++++++++++- > 1 file changed, 101 insertions(+), 2 deletions(-) > > diff --git a/man2/userfaultfd.2 b/man2/userfaultfd.2 > index 555e37409..d1f9aad24 100644 > --- a/man2/userfaultfd.2 > +++ b/man2/userfaultfd.2 > @@ -78,6 +78,32 @@ all memory ranges that were registered with the object are unregistered > and unread events are flushed. > .\" > .PP > +Userfaultfd supports two modes of registration: > +.TP > +.BR UFFDIO_REGISTER_MODE_MISSING " (since 4.10)" > +When registered with > +.B UFFDIO_REGISTER_MODE_MISSING > +mode, the userspace will receive a page fault message when a missing page is SC (see below) > +accessed. > +The faulted thread will be stopped from execution until the page fault is > +resolved from the userspace by either an > +.B UFFDIO_COPY > +or an > +.B UFFDIO_ZEROPAGE > +ioctl. > +.TP > +.BR UFFDIO_REGISTER_MODE_WP " (since 5.7)" > +When registered with > +.B UFFDIO_REGISTER_MODE_WP > +mode, the userspace will receive a page fault message when a write-protected > +page is written. Prefer breaking sentences at subordinate clauses rather than at random points: [ mode, the userspace will receive a page fault message when a write-protected page is written. ] There are other similar cases around the patch, marked with SC. > +The faulted thread will be stopped from execution until the userspace SC > +un-write-protect the page using an> +.B UFFDIO_WRITEPROTECT > +ioctl. > +.PP > +Multiple modes can be enabled at the same time for the same memory range. > +.PP > Since Linux 4.14, userfaultfd page fault message can selectively embed faulting > thread ID information into the fault message. > One needs to enable this feature explicitly using the > @@ -144,6 +170,17 @@ single threaded non-cooperative userfaultfd manager implementations. > .\" and limitations remaining in 4.11 > .\" Maybe it's worth adding a dedicated sub-section... > .\" > +.PP > +Starting from Linux 5.7, userfaultfd is able to do synchronous page dirty SC > +tracking using the new write-protection register mode. > +One should check against the feature bit > +.B UFFD_FEATURE_PAGEFAULT_FLAG_WP > +before using this feature. > +Similar to the original userfaultfd missing mode, the write-protect mode will > +generate an userfaultfd message when the protected page is written. > +The user needs to resolve the page fault by unprotecting the faulted page and > +kick the faulted thread to continue. > +For more information, please refer to "Userfaultfd write-protect mode" section. > .SS Userfaultfd operation > After the userfaultfd object is created with > .BR userfaultfd (), > @@ -219,6 +256,64 @@ userfaultfd can be used only with anonymous private memory mappings. > Since Linux 4.11, > userfaultfd can be also used with hugetlbfs and shared memory mappings. > .\" > +.SS Userfaultfd write-protect mode (since 5.7) > +Since Linux 5.7, userfaultfd supports write-protect mode. > +The user needs to first check availability of this feature using > +.B UFFDIO_API > +ioctl against the feature bit > +.B UFFD_FEATURE_PAGEFAULT_FLAG_WP > +before using this feature. > +.PP > +To register with userfaultfd write-protect mode, the user needs to initiate the > +.B UFFDIO_REGISTER > +ioctl with mode > +.B UFFDIO_REGISTER_MODE_WP > +set. > +Note that it's legal to monitor the same memory range with multiple modes. > +For example, the user can do > +.B UFFDIO_REGISTER > +with the mode set to > +.BR "UFFDIO_REGISTER_MODE_MISSING | UFFDIO_REGISTER_MODE_WP" . > +When there is only > +.B UFFDIO_REGISTER_MODE_WP > +registered, the userspace will > +.I not > +receive any message when a missing page is written. > +Instead, the userspace will only receive a write-protect page fault message > +when an existing but write-protected page got written. > +.PP > +After the > +.B UFFDIO_REGISTER > +ioctl completed with > +.B UFFDIO_REGISTER_MODE_WP > +mode set, the user can write-protect any existing memory within the range using SC (break at the comma better) > +the ioctl > +.B UFFDIO_WRITEPROTECT > +where > +.I uffdio_writeprotect.mode > +should be set to > +.BR UFFDIO_WRITEPROTECT_MODE_WP . > +.PP > +When a write-protect event happens, the userspace will receive a page fault SC (break at the comma better) > +message whose > +.I uffd_msg.pagefault.flags > +will be with > +.B UFFD_PAGEFAULT_FLAG_WP > +flag set. Note: since only writes can trigger such kind of fault, Break at the point above too. > +write-protect messages will always be with > +.B UFFD_PAGEFAULT_FLAG_WRITE > +bit set too along with bit > +.BR UFFD_PAGEFAULT_FLAG_WP . > +.PP > +To resolve a write-protection page fault, the user should initiate another > +.B UFFDIO_WRITEPROTECT > +ioctl, whose > +.I uffd_msg.pagefault.flags > +should have the flag > +.B UFFDIO_WRITEPROTECT_MODE_WP > +cleared upon the faulted page or range. > +.PP > +Write-protect mode only supports private anonymous memory. > .SS Reading from the userfaultfd structure > Each > .BR read (2) > @@ -364,8 +459,12 @@ flag (see > .BR ioctl_userfaultfd (2)) > and this flag is set, this a write fault; > otherwise it is a read fault. > -.\" > -.\" UFFD_PAGEFAULT_FLAG_WP is not yet supported. > +.TP > +.B UFFD_PAGEFAULT_FLAG_WP > +If the address is in a range that was registered with the > +.B UFFDIO_REGISTER_MODE_WP > +flag, when this bit is set it means it's a write-protect fault. Otherwise it's > +a page missing fault. Break at the point. > .RE > .TP > .I pagefault.feat.pid > -- Alejandro Colomar Linux man-pages comaintainer; https://www.kernel.org/doc/man-pages/ http://www.alejandro-colomar.es/