From patchwork Tue Sep 11 22:34:46 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Omar Sandoval X-Patchwork-Id: 10596443 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 2B7E915E2 for ; Tue, 11 Sep 2018 22:35:36 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 1BF2A29DEB for ; Tue, 11 Sep 2018 22:35:36 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 10A7A29DEA; Tue, 11 Sep 2018 22:35:36 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-7.9 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI autolearn=unavailable version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 9891F29DEB for ; Tue, 11 Sep 2018 22:35:35 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727762AbeILDgn (ORCPT ); Tue, 11 Sep 2018 23:36:43 -0400 Received: from mail-pf1-f193.google.com ([209.85.210.193]:34175 "EHLO mail-pf1-f193.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727047AbeILDgn (ORCPT ); Tue, 11 Sep 2018 23:36:43 -0400 Received: by mail-pf1-f193.google.com with SMTP id k19-v6so12941832pfi.1 for ; Tue, 11 Sep 2018 15:35:16 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=osandov-com.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=XfhD1s+oXIFOuIlVNDkhy1zo7dmofYMPh5tHBE+eOHA=; b=nVkLNSX9fRLZ1hzsn8SLpu3zAva7jVS84VE+Xq03vzGZJq+c4Y0ic9FobvTbOiV/e4 Pxa3nv5CkePSM2AbZllqQzDNtu9tYlY+h7Ztvoqpk8QclgjWIZTKU6hbgqSL25IivY3l uJNMvpd+gg7Ihja1NERjPErMoADVgMMO4/QHyeQ84V22HPXF3R+6VDF7Pa6QtT4XbShF JIivYZpM/HqX3XKY4tVx/bslIjMv5lrsvp7SWuqq+1RgeGN7567iq0bFQai+pZpktuUz r7dyOGMnRiYCNaHEH1VWT6rFLHR50UntCnhy3B0WcBw0M7zMb+iTeTc/oX2jREJJsCNb 18dA== 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; bh=XfhD1s+oXIFOuIlVNDkhy1zo7dmofYMPh5tHBE+eOHA=; b=EELRw27pd6OtAeiFMXKlK36DctECUMiKN38NxdL452930AeY38nPw9GBi7BrTHHTCf ndUIUI+YNh/D1FK9KletIHz3Fef0VKVgGlr70CeWQH7IrXM13zm5Oy9xIyAAK4DjcaW1 dy9GAJ9Xco2QKvIGGsphy/C3vbMYRmXV4QqyAq+OeygJL3SYOohx6JhOjRVQBSz3saRp JpuZdt/ecYMPpfXcNfC3/Yd2AWKim7oBWv7mCQxbl8ZMwUQpxl63OYSwXZmmIU5xy5b7 t8NEpJifkoomT8EwishOxtFNZOAEadsFA/n7db1KGkiNE1ua5xQsjzOyoT6zURDYv1Xt KMDw== X-Gm-Message-State: APzg51DUh/glyfhqGrFnhsCBVv654L/9GJrr80qN2Qc5k7RI96RVG8yW 9pn4deloA+GN/j8AyXJULTy5DP4EfSA= X-Google-Smtp-Source: ANB0VdZaPliu05bWLgw/zF77UuAbpoGICYqiLQFjGGnZY02Tf3QOvFVXd9u1vMeHQhaFVsQ8Z+JWXw== X-Received: by 2002:a63:706:: with SMTP id 6-v6mr29990412pgh.137.1536705315598; Tue, 11 Sep 2018 15:35:15 -0700 (PDT) Received: from vader.thefacebook.com ([2620:10d:c090:200::7:13b4]) by smtp.gmail.com with ESMTPSA id 186-v6sm18710176pgg.56.2018.09.11.15.35.14 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 11 Sep 2018 15:35:14 -0700 (PDT) From: Omar Sandoval To: linux-btrfs@vger.kernel.org Cc: kernel-team@fb.com, linux-mm@kvack.org Subject: [PATCH v7 3/6] vfs: update swap_{,de}activate documentation Date: Tue, 11 Sep 2018 15:34:46 -0700 Message-Id: X-Mailer: git-send-email 2.18.0 In-Reply-To: References: Sender: linux-btrfs-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-btrfs@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP From: Omar Sandoval The documentation for these functions is wrong in several ways: - swap_activate() is called with the inode locked - swap_activate() takes a swap_info_struct * and a sector_t * - swap_activate() can also return a positive number of extents it added itself - swap_deactivate() does not return anything Reviewed-by: Nikolay Borisov Signed-off-by: Omar Sandoval --- Documentation/filesystems/Locking | 17 +++++++---------- Documentation/filesystems/vfs.txt | 12 ++++++++---- 2 files changed, 15 insertions(+), 14 deletions(-) diff --git a/Documentation/filesystems/Locking b/Documentation/filesystems/Locking index efea228ccd8a..b970c8c2ee22 100644 --- a/Documentation/filesystems/Locking +++ b/Documentation/filesystems/Locking @@ -210,8 +210,9 @@ prototypes: int (*launder_page)(struct page *); int (*is_partially_uptodate)(struct page *, unsigned long, unsigned long); int (*error_remove_page)(struct address_space *, struct page *); - int (*swap_activate)(struct file *); - int (*swap_deactivate)(struct file *); + int (*swap_activate)(struct swap_info_struct *, struct file *, + sector_t *); + void (*swap_deactivate)(struct file *); locking rules: All except set_page_dirty and freepage may block @@ -235,8 +236,8 @@ putback_page: yes launder_page: yes is_partially_uptodate: yes error_remove_page: yes -swap_activate: no -swap_deactivate: no +swap_activate: yes +swap_deactivate: no ->write_begin(), ->write_end() and ->readpage() may be called from the request handler (/dev/loop). @@ -333,14 +334,10 @@ cleaned, or an error value if not. Note that in order to prevent the page getting mapped back in and redirtied, it needs to be kept locked across the entire operation. - ->swap_activate will be called with a non-zero argument on -files backing (non block device backed) swapfiles. A return value -of zero indicates success, in which case this file can be used for -backing swapspace. The swapspace operations will be proxied to the -address space operations. + ->swap_activate is called from sys_swapon() with the inode locked. ->swap_deactivate() will be called in the sys_swapoff() -path after ->swap_activate() returned success. +path after ->swap_activate() returned success. The inode is not locked. ----------------------- file_lock_operations ------------------------------ prototypes: diff --git a/Documentation/filesystems/vfs.txt b/Documentation/filesystems/vfs.txt index 4b2084d0f1fb..40d6d6d4b76b 100644 --- a/Documentation/filesystems/vfs.txt +++ b/Documentation/filesystems/vfs.txt @@ -652,8 +652,9 @@ struct address_space_operations { unsigned long); void (*is_dirty_writeback) (struct page *, bool *, bool *); int (*error_remove_page) (struct mapping *mapping, struct page *page); - int (*swap_activate)(struct file *); - int (*swap_deactivate)(struct file *); + int (*swap_activate)(struct swap_info_struct *, struct file *, + sector_t *); + void (*swap_deactivate)(struct file *); }; writepage: called by the VM to write a dirty page to backing store. @@ -830,8 +831,11 @@ struct address_space_operations { swap_activate: Called when swapon is used on a file to allocate space if necessary and pin the block lookup information in - memory. A return value of zero indicates success, - in which case this file can be used to back swapspace. + memory. If this returns zero, the swap system will call the address + space operations ->readpage() and ->direct_IO(). Alternatively, this + may call add_swap_extent() and return the number of extents added, in + which case the swap system will use the provided blocks directly + instead of going through the filesystem. swap_deactivate: Called during swapoff on files where swap_activate was successful.