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.6 required=3.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT 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 CE472C433DB for ; Mon, 29 Mar 2021 22:18:46 +0000 (UTC) Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by mail.kernel.org (Postfix) with ESMTP id 6FDF96193A for ; Mon, 29 Mar 2021 22:18:46 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 6FDF96193A 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 116786B0080; Mon, 29 Mar 2021 18:18:46 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 0EC726B0081; Mon, 29 Mar 2021 18:18:46 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id EA8486B0082; Mon, 29 Mar 2021 18:18:45 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from forelay.hostedemail.com (smtprelay0250.hostedemail.com [216.40.44.250]) by kanga.kvack.org (Postfix) with ESMTP id C7FDD6B0080 for ; Mon, 29 Mar 2021 18:18:45 -0400 (EDT) Received: from smtpin14.hostedemail.com (10.5.19.251.rfc1918.com [10.5.19.251]) by forelay02.hostedemail.com (Postfix) with ESMTP id 92E525DF8 for ; Mon, 29 Mar 2021 22:18:45 +0000 (UTC) X-FDA: 77974327410.14.7F037B2 Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by imf19.hostedemail.com (Postfix) with ESMTP id DB74E90009E9 for ; Mon, 29 Mar 2021 22:18:37 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1617056324; 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: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=J8n2ApTDe4gB8TGr/cPQrTmoB7FExgwYwSEYb/uNSiE=; b=DJnByHkZP4vpE2Uhw9RXWoqu4xQLezeqZ/N2me7Mdr9JyUdYLQyhSVfYG7ZlpKb4yOqhPS BaU3IY7BmuybeMCUkI2UiNqZDp0WVPYxi2CYAFjtdTzwRhZh3B5PA5SBy56VngEyNWHcif GpmkFUCFaFwbn1YcpLdmIwbJ/1urKVo= Received: from mail-qv1-f70.google.com (mail-qv1-f70.google.com [209.85.219.70]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-324-vwyj7htsP8G5Ebnvl_U8SQ-1; Mon, 29 Mar 2021 18:18:41 -0400 X-MC-Unique: vwyj7htsP8G5Ebnvl_U8SQ-1 Received: by mail-qv1-f70.google.com with SMTP id im11so1859698qvb.23 for ; Mon, 29 Mar 2021 15:18:41 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=J8n2ApTDe4gB8TGr/cPQrTmoB7FExgwYwSEYb/uNSiE=; b=ZAJwVVq3DxzgMW3tsxZ4p2N/Xb56eIaImEZDzBC3CyQ3HfHSSx1jWbEGuQ9mGxZgrK +UrqW13s7bVYpP3m5dQPyiYhmA3M5iwP2TDm2Ai6/U49abT5Tp/ZusI545LVvUgJPXUv vgzA4Jb8Fs1dcT8lqKTLFcjFQMS/jd5IJ2kR8ENZvNlfH8h4tBbb3lS7SX15/8gsaFx6 i+zWKzwyLvBYFxmmMToNPHbZDJ3I5Ew055YZtiEgSaO1zxS8v7qRy/pnzElacrM9+cS3 HQMs4vb5bSGG55Fq3cuH7NOQI4dBxDIo774cE/F+xMW0ZHqCEG9vfcj+uVp/6pyqv/vQ X+oQ== X-Gm-Message-State: AOAM531YJSQN62aTRw8Skk7r63UPDtGBFN3uhkQG/9QS3xCtCi0A7nE9 d8WjZKjNMoIqCtKbrlc8K9oVtb1vZsgP+btlUG/mzIjBvQQKGgmy5QadamT1br/9Tu9SphAAQbU zYsd7N+Dm/R/jC5z4KpIiDBjsW9dxjY/4hxVmPFEZlXf1ViU2gPn8mnoMbsDa X-Received: by 2002:ac8:4799:: with SMTP id k25mr5954526qtq.319.1617056320316; Mon, 29 Mar 2021 15:18:40 -0700 (PDT) X-Google-Smtp-Source: ABdhPJwztqkKCBAG6T0YCTO9V8zgePeS6nRzmN4PNtkFsE/9Q52+4/GwupowUDWrZDz2NcJ6FZxcoQ== X-Received: by 2002:ac8:4799:: with SMTP id k25mr5954493qtq.319.1617056319943; Mon, 29 Mar 2021 15:18:39 -0700 (PDT) Received: from xz-x1.redhat.com (bras-base-toroon474qw-grc-82-174-91-135-175.dsl.bell.ca. [174.91.135.175]) by smtp.gmail.com with ESMTPSA id i17sm12255215qtr.33.2021.03.29.15.18.37 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 29 Mar 2021 15:18:39 -0700 (PDT) From: Peter Xu To: linux-mm@kvack.org, linux-kernel@vger.kernel.org, linux-man@vger.kernel.org Cc: Axel Rasmussen , peterx@redhat.com, Nadav Amit , Mike Rapoport , Alejandro Colomar , Andrea Arcangeli , Michael Kerrisk , Andrew Morton Subject: [PATCH v5 2/4] userfaultfd.2: Add write-protect mode Date: Mon, 29 Mar 2021 18:18:31 -0400 Message-Id: <20210329221833.517923-3-peterx@redhat.com> X-Mailer: git-send-email 2.26.2 In-Reply-To: <20210329221833.517923-1-peterx@redhat.com> References: <20210329221833.517923-1-peterx@redhat.com> MIME-Version: 1.0 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="US-ASCII" X-Stat-Signature: wnwqg4zyhm6gm6dytu1g9prud9rqgjis X-Rspamd-Server: rspam04 X-Rspamd-Queue-Id: DB74E90009E9 Received-SPF: none (redhat.com>: No applicable sender policy available) receiver=imf19; identity=mailfrom; envelope-from=""; helo=us-smtp-delivery-124.mimecast.com; client-ip=170.10.133.124 X-HE-DKIM-Result: pass/pass X-HE-Tag: 1617056317-175104 Content-Transfer-Encoding: quoted-printable 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: Write-protect mode is supported starting from Linux 5.7. Acked-by: Mike Rapoport Signed-off-by: Peter Xu --- man2/userfaultfd.2 | 108 +++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 104 insertions(+), 4 deletions(-) diff --git a/man2/userfaultfd.2 b/man2/userfaultfd.2 index 5c41e4816..474294c3d 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 accessed. +The faulted thread will be stopped from execution until the page fault i= s +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. +The faulted thread will be stopped from execution +until the userspace write-unprotect 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 f= aulting thread ID information into the fault message. One needs to enable this feature explicitly using the @@ -107,7 +133,7 @@ the process that monitors userfaultfd and handles pag= e faults needs to be aware of the changes in the virtual memory layout of the faulting process to avoid memory corruption. .PP -Starting from Linux 4.11, +Since Linux 4.11, userfaultfd can also notify the fault-handling threads about changes in the virtual memory layout of the faulting process. In addition, if the faulting process invokes @@ -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 +Since Linux 5.7, userfaultfd is able to do +synchronous page dirty tracking using the new write-protect register mod= e. +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 pag= e and +kick the faulted thread to continue. +For more information, please refer to "Userfaultfd write-protect mode" s= ection. .SS Userfaultfd operation After the userfaultfd object is created with .BR userfaultfd (), @@ -179,7 +216,7 @@ or .BR ioctl (2) operations to resolve the page fault. .PP -Starting from Linux 4.14, if the application sets the +Since Linux 4.14, if the application sets the .B UFFD_FEATURE_SIGBUS feature bit using the .B UFFDIO_API @@ -219,6 +256,65 @@ 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 initi= ate 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 mode= s. +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 mess= age +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 th= e 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 bit +.BR UFFD_PAGEFAULT_FLAG_WP . +.PP +To resolve a write-protection page fault, the user should initiate anoth= er +.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 +460,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. .RE .TP .I pagefault.feat.pid --=20 2.26.2