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=-16.0 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_CR_TRAILER,INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS 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 8AD3BC433DB for ; Wed, 10 Mar 2021 21:46:45 +0000 (UTC) Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by mail.kernel.org (Postfix) with ESMTP id E7ECC64FC4 for ; Wed, 10 Mar 2021 21:46:44 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org E7ECC64FC4 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=redhat.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=owner-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix) id 645218D0215; Wed, 10 Mar 2021 16:46:44 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 61BF38D01ED; Wed, 10 Mar 2021 16:46:44 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 46F448D0215; Wed, 10 Mar 2021 16:46:44 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from forelay.hostedemail.com (smtprelay0165.hostedemail.com [216.40.44.165]) by kanga.kvack.org (Postfix) with ESMTP id 2684F8D01ED for ; Wed, 10 Mar 2021 16:46:44 -0500 (EST) Received: from smtpin23.hostedemail.com (10.5.19.251.rfc1918.com [10.5.19.251]) by forelay05.hostedemail.com (Postfix) with ESMTP id B3698181AF5C3 for ; Wed, 10 Mar 2021 21:46:43 +0000 (UTC) X-FDA: 77905299486.23.394AE82 Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [216.205.24.124]) by imf05.hostedemail.com (Postfix) with ESMTP id 94409E00010F for ; Wed, 10 Mar 2021 21:46:42 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1615412802; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=/4BAvAYb0p56VURUt0aneYd5tRaSp4726siIe8mGwLs=; b=hrbdYuYlAfjS1NRSbqxSDM9De1BOFaVEiyq0w6OvfgTuz7h0qjKh/RSw9s1+YK7s0vV+w7 9cvDWVvPwm7gbFpZSU002ORLf2hBOoRxJ7sCuh9OM/Y5vnLN0g2SIkr80e8qlwlaSCmVwo oFLQtDgNiXq8JINUqPyLnXpuTPRQe7U= Received: from mail-qt1-f199.google.com (mail-qt1-f199.google.com [209.85.160.199]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-157-0sE8jYGcOj2n8Tg1IAulcg-1; Wed, 10 Mar 2021 16:46:40 -0500 X-MC-Unique: 0sE8jYGcOj2n8Tg1IAulcg-1 Received: by mail-qt1-f199.google.com with SMTP id 16so14035088qtw.1 for ; Wed, 10 Mar 2021 13:46:40 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to; bh=/4BAvAYb0p56VURUt0aneYd5tRaSp4726siIe8mGwLs=; b=PjbyBCNyQ3p/BeVSszTCpV0Ro4+yvBS4nFpOvwNRsB1NjJdD8tIr5qJTcVBpoqXA8o 8f+J2OAay8H2l9xehst3MVmknCkDdjJJAns2e2ZNljwpV2aQ+dv41+Kxasa8xIRYsBvF D8BTZcDCsYqzbhcMFhUDijFdQijh6zx0hXWLdYRSG5dJPOm1cLLYm5S+cwLOYDOiZlJg dZENcglhHAbpqLZl7DhXP0SuF9QyIblN0mfZoYms8AzzBeKclf0mfgVFmGCoOz7zmMLa 1/LEwafiN1SytdfpsG5kpyHKF6oH37qL9jTU+fQ2GYxnAuXYiA/S38uCZ7qzDtOMUfba IOEQ== X-Gm-Message-State: AOAM531g40jgrnnvy3wXApqyeigkSrTXg0Pa1ifbl6Fjle/owdG7PJuO h0laR+qTXebPTvBI9fFDf1Iqif+8Nmje/7zE6g874MS6GOOsCoNWwthjoQgHg3b9Vf8A1BLw0NI fBnqKdVtU/DY= X-Received: by 2002:a05:6214:194f:: with SMTP id q15mr5148361qvk.46.1615412800324; Wed, 10 Mar 2021 13:46:40 -0800 (PST) X-Google-Smtp-Source: ABdhPJzNyEKmeMSTe/8AHX91In05+hEnDecNNNxFfngMdnwhuXY0MXGy87XhxBOkq6T5f0r9VUyHQA== X-Received: by 2002:a05:6214:194f:: with SMTP id q15mr5148336qvk.46.1615412799955; Wed, 10 Mar 2021 13:46:39 -0800 (PST) Received: from xz-x1 ([142.126.89.138]) by smtp.gmail.com with ESMTPSA id a14sm384686qtw.80.2021.03.10.13.46.38 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 10 Mar 2021 13:46:39 -0800 (PST) Date: Wed, 10 Mar 2021 16:46:38 -0500 From: Peter Xu To: "Alejandro Colomar (man-pages)" Cc: linux-man@vger.kernel.org, Nadav Amit , Andrea Arcangeli , linux-kernel@vger.kernel.org, Michael Kerrisk , Mike Rapoport , Axel Rasmussen , Andrew Morton , Linux MM Mailing List Subject: Re: [PATCH v2 2/4] userfaultfd.2: Add write-protect mode Message-ID: <20210310214638.GA194839@xz-x1> References: <20210304163140.543171-1-peterx@redhat.com> <20210304163140.543171-3-peterx@redhat.com> MIME-Version: 1.0 In-Reply-To: Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=peterx@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset=utf-8 Content-Disposition: inline X-Stat-Signature: doah6c1xaskxwot7pimie6d8eq7drzad X-Rspamd-Server: rspam05 X-Rspamd-Queue-Id: 94409E00010F Received-SPF: none (redhat.com>: No applicable sender policy available) receiver=imf05; identity=mailfrom; envelope-from=""; helo=us-smtp-delivery-124.mimecast.com; client-ip=216.205.24.124 X-HE-DKIM-Result: pass/pass X-HE-Tag: 1615412802-592108 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: On Wed, Mar 10, 2021 at 08:16:24PM +0100, Alejandro Colomar (man-pages) wrote: > Hi Peter, > > Please see a few comments below. > > Thanks, > > Alex > > On 3/4/21 5:31 PM, Peter Xu wrote: > > Write-protect mode is supported starting from Linux 5.7. > > > > Signed-off-by: Peter Xu > > --- > > man2/userfaultfd.2 | 98 +++++++++++++++++++++++++++++++++++++++++++++- > > 1 file changed, 96 insertions(+), 2 deletions(-) > > > > diff --git a/man2/userfaultfd.2 b/man2/userfaultfd.2 > > index 0cd426a8a..426307bcf 100644 > > --- a/man2/userfaultfd.2 > > +++ b/man2/userfaultfd.2 > > @@ -78,6 +78,30 @@ all memory ranges that were registered with the object are unregistered > > and unread events are flushed. > > .\" > > .PP > > +Currently, userfaultfd supports two modes of registration: > > "Currently" > > Than word is quite unstable and unprecise. > I think it would be better to use an absolute reference, such as "Since > Linux x.y, ...". I decided to remove the "Currently" and put the "(since x.y)" into each mode: diff --git a/man2/userfaultfd.2 b/man2/userfaultfd.2 index 426307bcf..1132f52a3 100644 --- a/man2/userfaultfd.2 +++ b/man2/userfaultfd.2 @@ -78,9 +78,9 @@ all memory ranges that were registered with the object are unregistered and unread events are flushed. .\" .PP -Currently, userfaultfd supports two modes of registration: +Userfaultfd supports two modes of registration: .TP -.B UFFDIO_REGISTER_MODE_MISSING +.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 @@ -91,7 +91,7 @@ or an .B UFFDIO_ZEROPAGE ioctl. .TP -.B UFFDIO_REGISTER_MODE_WP +.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 > > > +.TP > > +.B UFFDIO_REGISTER_MODE_MISSING > > +When registered with > > +.B UFFDIO_REGISTER_MODE_MISSING > > +mode, the userspace will receive a page fault message when a missing page is > > +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 > > +.B UFFDIO_REGISTER_MODE_WP > > +When registered with > > +.B UFFDIO_REGISTER_MODE_WP > > +mode, the userspace will receive a page fault message when a write-protected > > +page is written. The faulted thread will be stopped from execution until the > > Please, use "semantic newlines". > > $ man 7 man-pages |sed -n '/semantic newlines/,/^$/p' > Use semantic newlines > In the source of a manual page, new sentences should be > started on new lines, and long sentences should split into > lines at clause breaks (commas, semicolons, colons, and so > on). This convention, sometimes known as "semantic new- > lines", makes it easier to see the effect of patches, which > often operate at the level of individual sentences or sen- > tence clauses. Will do. > > > > > +userspace 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 +168,16 @@ 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 > > +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 read the "Userfaultfd write-protect mode" section below. > > .SS Userfaultfd operation > > After the userfaultfd object is created with > > .BR userfaultfd (), > > @@ -219,6 +253,62 @@ 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 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 > > +.BR UFFD_FEATURE_PAGEFAULT_FLAG_WP . > > +.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 . > > Please use quotes when possible: > > .BR "asdasd asdsadf dfgsdfg dsf" . Fixed. > > > +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 > > +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 > > +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, > > +write-protect messages will always be with > > +.B UFFD_PAGEFAULT_FLAG_WRITE > > +bit set too along with > > +.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 > > +.BR UFFDIO_WRITEPROTECT_MODE_WP > > .B Fixed. Thanks, -- Peter Xu