From patchwork Tue Jan 31 21:16:45 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Aleksandr Mikhalitsyn X-Patchwork-Id: 13123466 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 18E43C636CC for ; Tue, 31 Jan 2023 21:16:58 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232082AbjAaVQ5 (ORCPT ); Tue, 31 Jan 2023 16:16:57 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:46210 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231254AbjAaVQ4 (ORCPT ); Tue, 31 Jan 2023 16:16:56 -0500 Received: from smtp-relay-internal-1.canonical.com (smtp-relay-internal-1.canonical.com [185.125.188.123]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id C304D47408 for ; Tue, 31 Jan 2023 13:16:54 -0800 (PST) Received: from mail-ej1-f70.google.com (mail-ej1-f70.google.com [209.85.218.70]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by smtp-relay-internal-1.canonical.com (Postfix) with ESMTPS id 9DF9F3F135 for ; Tue, 31 Jan 2023 21:16:53 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=canonical.com; s=20210705; t=1675199813; bh=GqrHhaRzCa7kIaRLW4sVW+c/yWK7WXlFQ9iSLa0wU+U=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=qSlUT3vrxHYchXbWpdT50cWsC0I71BDhKfxa6vMVRh2vQ8AbIOUmkuRinKE15XX7H ngc61oyNNMCfsg3x0aQYiyMvELCTSNDjecnVXEprT4T6xCyzG5BL35NN5uC6d865mv DtTeTjP/uy1jt9FTdcKrahj5+wpuZpbxWHjo48zaP+oKbhS/DqoYiz9zA5niECtTJY 1GOWk+2qF6PCWsnJyj+moEq+F2HwR3f/vdqp/J7Bu6g1leszvPvOCBIqdzvbS6X9wi z/YpKc9p5vvzXjKR1iufWgRwh8csxOJ4pfeC200UQPRhSP9jg5LVDvaNEV/p2xetTp IL+llJusWjBXg== Received: by mail-ej1-f70.google.com with SMTP id hp2-20020a1709073e0200b0084d47e3fe82so10396530ejc.8 for ; Tue, 31 Jan 2023 13:16:53 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=GqrHhaRzCa7kIaRLW4sVW+c/yWK7WXlFQ9iSLa0wU+U=; b=qVtJDX7PmKVkxeAbHZOr6ECvrC/jLTmM86iMXKp2ukYZDIt6jRuSaBnbCCbMhR6HGl kgtzA12OGJWCJhrqbGve71yPZikcEut4hJ8MGgthU2pnTOUNhFjx2CT/cDR0VUhsk65H EKufEfGg1D05bJ+hAyuWXb8eHzRvR5h9ABAj6mfkhHMpoeOF7o5zhMmH5RyDk9ghzOz4 WHvNoSnktI5fpoa6/VcTri2zDA+5Jkw6L8wLhcj2GwoHpOfkLNgpBx0W7fuqzpngDUGM wfOtx+9aHjT0p1XB5JVBkujEKRJI01VDpD+Ht6bKiQWmPhWekVR+SqYxULzUNGuwBicu Pu4Q== X-Gm-Message-State: AO0yUKUcYcGDfvOrizcKbrHcv1WqfFTy2hNI43yKknTyeIv5MAF/4/// 9Z4w5LWHrc+A97Rsx/C0kA4txwV0/oTGRnvw3YB30yXwOJbW+glCYRDVJymLIio9hzXJdrkqZbC nImF/m7vwkAZy0PtvRoN75BbcvkBUfW/wnjrVPag+htM= X-Received: by 2002:a17:907:c685:b0:871:8297:7576 with SMTP id ue5-20020a170907c68500b0087182977576mr358030ejc.26.1675199813311; Tue, 31 Jan 2023 13:16:53 -0800 (PST) X-Google-Smtp-Source: AK7set8MAVJ2WfoobbMJyhoZIyDEAmIxWkw8Z1rUArwjAM4AwubvstISbTJ6hEalteys5u6A75u4rQ== X-Received: by 2002:a17:907:c685:b0:871:8297:7576 with SMTP id ue5-20020a170907c68500b0087182977576mr358019ejc.26.1675199813123; Tue, 31 Jan 2023 13:16:53 -0800 (PST) Received: from amikhalitsyn.. (ip5f5bf399.dynamic.kabel-deutschland.de. [95.91.243.153]) by smtp.gmail.com with ESMTPSA id w9-20020a170906184900b007c0f217aadbsm8796195eje.24.2023.01.31.13.16.52 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 31 Jan 2023 13:16:52 -0800 (PST) From: Alexander Mikhalitsyn To: corbet@lwn.net Cc: Alexander Mikhalitsyn , Al Viro , linux-fsdevel@vger.kernel.org, linux-doc@vger.kernel.org Subject: [PATCH v3] docs: filesystems: vfs: actualize struct super_operations description Date: Tue, 31 Jan 2023 22:16:45 +0100 Message-Id: <20230131211645.723010-1-aleksandr.mikhalitsyn@canonical.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230131210651.715327-3-aleksandr.mikhalitsyn@canonical.com> References: <20230131210651.715327-3-aleksandr.mikhalitsyn@canonical.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-fsdevel@vger.kernel.org Added/updated descriptions for super_operations: - free_inode method - evict_inode method - freeze_super/thaw_super method - show_{devname,path,stats} procfs-related methods - get_dquots method Cc: Al Viro Cc: linux-fsdevel@vger.kernel.org Cc: linux-doc@vger.kernel.org Signed-off-by: Alexander Mikhalitsyn --- Documentation/filesystems/vfs.rst | 74 ++++++++++++++++++++++++------- 1 file changed, 59 insertions(+), 15 deletions(-) diff --git a/Documentation/filesystems/vfs.rst b/Documentation/filesystems/vfs.rst index 113d70186324..6f820228bf47 100644 --- a/Documentation/filesystems/vfs.rst +++ b/Documentation/filesystems/vfs.rst @@ -245,33 +245,42 @@ struct super_operations ----------------------- This describes how the VFS can manipulate the superblock of your -filesystem. As of kernel 2.6.22, the following members are defined: +filesystem. As of kernel 6.2, the following members are defined: .. code-block:: c struct super_operations { struct inode *(*alloc_inode)(struct super_block *sb); void (*destroy_inode)(struct inode *); + void (*free_inode)(struct inode *); void (*dirty_inode) (struct inode *, int flags); - int (*write_inode) (struct inode *, int); - void (*drop_inode) (struct inode *); - void (*delete_inode) (struct inode *); + int (*write_inode) (struct inode *, struct writeback_control *wbc); + int (*drop_inode) (struct inode *); + void (*evict_inode) (struct inode *); void (*put_super) (struct super_block *); int (*sync_fs)(struct super_block *sb, int wait); + int (*freeze_super) (struct super_block *); int (*freeze_fs) (struct super_block *); + int (*thaw_super) (struct super_block *); int (*unfreeze_fs) (struct super_block *); int (*statfs) (struct dentry *, struct kstatfs *); int (*remount_fs) (struct super_block *, int *, char *); - void (*clear_inode) (struct inode *); void (*umount_begin) (struct super_block *); int (*show_options)(struct seq_file *, struct dentry *); + int (*show_devname)(struct seq_file *, struct dentry *); + int (*show_path)(struct seq_file *, struct dentry *); + int (*show_stats)(struct seq_file *, struct dentry *); ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t); ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t); - int (*nr_cached_objects)(struct super_block *); - void (*free_cached_objects)(struct super_block *, int); + struct dquot **(*get_dquots)(struct inode *); + + long (*nr_cached_objects)(struct super_block *, + struct shrink_control *); + long (*free_cached_objects)(struct super_block *, + struct shrink_control *); }; All methods are called without any locks being held, unless otherwise @@ -292,6 +301,11 @@ or bottom half). ->alloc_inode was defined and simply undoes anything done by ->alloc_inode. +``free_inode`` + this method is called from RCU callback. If you use call_rcu() + in ->destroy_inode to free 'struct inode' memory, then it's + better to release memory in this method. + ``dirty_inode`` this method is called by the VFS when an inode is marked dirty. This is specifically for the inode itself being marked dirty, @@ -319,8 +333,12 @@ or bottom half). practice of using "force_delete" in the put_inode() case, but does not have the races that the "force_delete()" approach had. -``delete_inode`` - called when the VFS wants to delete an inode +``evict_inode`` + called when the VFS wants to evict an inode. Caller does + *not* evict the pagecache or inode-associated metadata buffers; + the method has to use truncate_inode_pages_final() to get rid + of those. Caller makes sure async writeback cannot be running for + the inode while (or after) ->evict_inode() is called. Optional. ``put_super`` called when the VFS wishes to free the superblock @@ -331,14 +349,25 @@ or bottom half). superblock. The second parameter indicates whether the method should wait until the write out has been completed. Optional. +``freeze_super`` + Called instead of ->freeze_fs callback if provided. + Main difference is that ->freeze_super is called without taking + down_write(&sb->s_umount). If filesystem implements it and wants + ->freeze_fs to be called too, then it has to call ->freeze_fs + explicitly from this callback. Optional. + ``freeze_fs`` called when VFS is locking a filesystem and forcing it into a consistent state. This method is currently used by the Logical - Volume Manager (LVM). + Volume Manager (LVM) and ioctl(FIFREEZE). Optional. + +``thaw_super`` + called when VFS is unlocking a filesystem and making it writable + again after ->freeze_super. Optional. ``unfreeze_fs`` called when VFS is unlocking a filesystem and making it writable - again. + again after ->freeze_fs. Optional. ``statfs`` called when the VFS needs to get filesystem statistics. @@ -347,22 +376,37 @@ or bottom half). called when the filesystem is remounted. This is called with the kernel lock held -``clear_inode`` - called then the VFS clears the inode. Optional - ``umount_begin`` called when the VFS is unmounting a filesystem. ``show_options`` - called by the VFS to show mount options for /proc//mounts. + called by the VFS to show mount options for /proc//mounts + and /proc//mountinfo. (see "Mount Options" section) +``show_devname`` + Optional. Called by the VFS to show device name for + /proc//{mounts,mountinfo,mountstats}. If not provided then + '(struct mount).mnt_devname' will be used. + +``show_path`` + Optional. Called by the VFS (for /proc//mountinfo) to show + the mount root dentry path relative to the filesystem root. + +``show_stats`` + Optional. Called by the VFS (for /proc//mountstats) to show + filesystem-specific mount statistics. + ``quota_read`` called by the VFS to read from filesystem quota file. ``quota_write`` called by the VFS to write to filesystem quota file. +``get_dquots`` + called by quota to get 'struct dquot' array for a particular inode. + Optional. + ``nr_cached_objects`` called by the sb cache shrinking function for the filesystem to return the number of freeable cached objects it contains.