From patchwork Tue Jan 31 21:06:50 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Aleksandr Mikhalitsyn X-Patchwork-Id: 13123461 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 404FEC38142 for ; Tue, 31 Jan 2023 21:07:11 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231958AbjAaVHK (ORCPT ); Tue, 31 Jan 2023 16:07:10 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39462 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229876AbjAaVHJ (ORCPT ); Tue, 31 Jan 2023 16:07:09 -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 F13B62D71 for ; Tue, 31 Jan 2023 13:07:07 -0800 (PST) Received: from mail-ej1-f71.google.com (mail-ej1-f71.google.com [209.85.218.71]) (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 DA17E3F18C for ; Tue, 31 Jan 2023 21:07:06 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=canonical.com; s=20210705; t=1675199226; bh=vxTJcLnUl2iJvt/ei3alGqSMjASKsv3g66JrV0OgMpo=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=TzBsXInT0hzzkTGuypfGXAUJG/wm5PZv2eKpF+LPobEWq5UAlN08zT2V+0py5vD0f SFjocqAN//ur+FOzTgbTITum8u/IbmOAXCC2UcsnLlu5G4+vHdWrbp800udsyzn0KP KklZ+xUneGSsQ9zekT3JR/UipuMMBcfMNCIl/ekJvXgpl5tFjf89FBWE/nVo1Ba4ti zKzinwk6SjBwnZtQdDgsQh8gt7n0Row86m9k2y4P5+p+DdItu6pTS5Eu832xJNlBzG Ga38ZYxKim2cwBTLTcxVxtZPXvvz4Av1NwN7Rju8x9lMnoXdnuWQLUGWet6iUDFuLp H8Nwtc1qYKRIA== Received: by mail-ej1-f71.google.com with SMTP id ae2-20020a17090725c200b0088d91fe7ec5so168538ejc.1 for ; Tue, 31 Jan 2023 13:07:06 -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=vxTJcLnUl2iJvt/ei3alGqSMjASKsv3g66JrV0OgMpo=; b=DjChnVAIvbiHeZHjQVFT7EKlqQBgfLWLQIvF/dIlkDg8N1myKMLB7mbsfiJtIZSPrv +GMev3Wf94hPp/ZgvGIMBuIBayBy3X7vb+L5ay6lyJ8Gypv0970Zw5Xm1qYi6tdBK0ql q4/0lEWR59C+nzlFLzAqjCLHfUT7AOnWPrP3DmaRBtoJoxST71YZvgXzZac5+XyQ8biD hzekDq4XySDHl4oGz0/KmPG68Moa8tCNzmXONrZRNLHmbSDx/06niCmWd/iT+aiFYK11 a5/M/JbGZv3csn5n5wIohSggulfwlaigwnHmowcXuffVnZRBZxNQ4sNZzE9ssCGt5qAw r3NQ== X-Gm-Message-State: AO0yUKW57HUU8+hHB8ytAsI8tSIPQNycJ4ndxDzsMXVbgesqoeh7c4rL 1PqRSjbosxLemmxGh2k0DVF7KcWM8sNwQje6Cmq7F94UOux1T4rSlvaQt7renSqfxjM0dlTuPvr eHnhtotfbhhlTTzSjFpSaGnUxT94qaNiRT9MJp8udl0I= X-Received: by 2002:a50:ce54:0:b0:4a0:e039:e911 with SMTP id k20-20020a50ce54000000b004a0e039e911mr22586874edj.12.1675199226542; Tue, 31 Jan 2023 13:07:06 -0800 (PST) X-Google-Smtp-Source: AK7set/ngHjrMHGUa+vjq5MtKRDI725l3woF78dnXrwnaUOYpAIGaHtBTNv/Ehj3nxgbIh8yLpaVIg== X-Received: by 2002:a50:ce54:0:b0:4a0:e039:e911 with SMTP id k20-20020a50ce54000000b004a0e039e911mr22586865edj.12.1675199226359; Tue, 31 Jan 2023 13:07:06 -0800 (PST) Received: from amikhalitsyn.. (ip5f5bf399.dynamic.kabel-deutschland.de. [95.91.243.153]) by smtp.gmail.com with ESMTPSA id ja3-20020a170907988300b008818d9e0bfesm6231172ejc.117.2023.01.31.13.07.05 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 31 Jan 2023 13:07:06 -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 v2 1/2] docs: filesystems: vfs: actualize struct file_system_type description Date: Tue, 31 Jan 2023 22:06:50 +0100 Message-Id: <20230131210651.715327-2-aleksandr.mikhalitsyn@canonical.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230131210651.715327-1-aleksandr.mikhalitsyn@canonical.com> References: <20230131210651.715327-1-aleksandr.mikhalitsyn@canonical.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-fsdevel@vger.kernel.org Added descriptions for: - fscontext API ('init_fs_context' method, 'parameters' field) - 'fs_supers' field Cc: Al Viro Cc: linux-fsdevel@vger.kernel.org Cc: linux-doc@vger.kernel.org Signed-off-by: Alexander Mikhalitsyn --- Documentation/filesystems/vfs.rst | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/Documentation/filesystems/vfs.rst b/Documentation/filesystems/vfs.rst index 2c15e7053113..113d70186324 100644 --- a/Documentation/filesystems/vfs.rst +++ b/Documentation/filesystems/vfs.rst @@ -107,7 +107,7 @@ file /proc/filesystems. struct file_system_type ----------------------- -This describes the filesystem. As of kernel 2.6.39, the following +This describes the filesystem. As of kernel 6.2, the following members are defined: .. code-block:: c @@ -115,14 +115,24 @@ members are defined: struct file_system_type { const char *name; int fs_flags; + int (*init_fs_context)(struct fs_context *); + const struct fs_parameter_spec *parameters; struct dentry *(*mount) (struct file_system_type *, int, - const char *, void *); + const char *, void *); void (*kill_sb) (struct super_block *); struct module *owner; struct file_system_type * next; - struct list_head fs_supers; + struct hlist_head fs_supers; + struct lock_class_key s_lock_key; struct lock_class_key s_umount_key; + struct lock_class_key s_vfs_rename_key; + struct lock_class_key s_writers_key[SB_FREEZE_LEVELS]; + + struct lock_class_key i_lock_key; + struct lock_class_key i_mutex_key; + struct lock_class_key invalidate_lock_key; + struct lock_class_key i_mutex_dir_key; }; ``name`` @@ -132,6 +142,15 @@ members are defined: ``fs_flags`` various flags (i.e. FS_REQUIRES_DEV, FS_NO_DCACHE, etc.) +``init_fs_context`` + Initializes 'struct fs_context' ->ops and ->fs_private fields with + filesystem-specific data. + +``parameters`` + Pointer to the array of filesystem parameters descriptors + 'struct fs_parameter_spec'. + More info in Documentation/filesystems/mount_api.rst. + ``mount`` the method to call when a new instance of this filesystem should be mounted @@ -148,7 +167,11 @@ members are defined: ``next`` for internal VFS use: you should initialize this to NULL - s_lock_key, s_umount_key: lockdep-specific +``fs_supers`` + for internal VFS use: hlist of filesystem instances (superblocks) + + s_lock_key, s_umount_key, s_vfs_rename_key, s_writers_key, + i_lock_key, i_mutex_key, invalidate_lock_key, i_mutex_dir_key: lockdep-specific The mount() method has the following arguments: From patchwork Tue Jan 31 21:06:51 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Aleksandr Mikhalitsyn X-Patchwork-Id: 13123462 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 99095C38142 for ; Tue, 31 Jan 2023 21:07:16 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231962AbjAaVHP (ORCPT ); Tue, 31 Jan 2023 16:07:15 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39540 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231970AbjAaVHO (ORCPT ); Tue, 31 Jan 2023 16:07:14 -0500 Received: from smtp-relay-internal-0.canonical.com (smtp-relay-internal-0.canonical.com [185.125.188.122]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 6077B42DC1 for ; Tue, 31 Jan 2023 13:07:11 -0800 (PST) Received: from mail-ed1-f70.google.com (mail-ed1-f70.google.com [209.85.208.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-0.canonical.com (Postfix) with ESMTPS id CDDCA3F194 for ; Tue, 31 Jan 2023 21:07:09 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=canonical.com; s=20210705; t=1675199229; bh=MFn8bFpqbuyFI5dWrYZUOJJmaMpPQso5Tw3JzLNN9oE=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=S1iK219Itkc2ALC6LCCf+ucL8QuCVE5ZpElmuhGSGO7Kg+F0ZhnrpPoB9j3nxoSiq mfc4qkSAFTWPE2dw/W4nifzNk1lcBde1hpeO6EeorBymwcdmtwObh6bVXlhyzM76f2 8sYHo1f2OvqmSlcmQitH+z7p/gFLEG5HEfKlL5SxjK5WCZzii8bmJTPZVY7nr28/QW hGq4krcDet1fkAHvkol1yEGdMFA/YO+r8zy7oj5XGg8yTUhkuAe5LxT/Ru6ednE1ud AL1QtUfttFuc03laQvaJVmXnTDpOJ9fYJb2Q3aMQt3m31xSCt8zE9MM5ZbLkAoKC7z O1XkRIzlbCm9g== Received: by mail-ed1-f70.google.com with SMTP id w3-20020a056402268300b00487e0d9b53fso11470069edd.10 for ; Tue, 31 Jan 2023 13:07:09 -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=MFn8bFpqbuyFI5dWrYZUOJJmaMpPQso5Tw3JzLNN9oE=; b=ngkDPatEwQQvHHO5qefV22lzYsNrb7aldPgUcpi+ObjON6dI5wTr2lKtj0qaPVl0kB 9v/k3sKFZP46Et96YRjjjtziaLLMUAUBxyG3aw7ngT/zZmYO+xh3nZSGJRWmLm0jt4fG iRpVJiGWEtdSMhEUhWZ2y/Z6iy4ylGU71VEwd+axpOJJcHV2VZ5MH36ldKQcvyc1cAvp GuC8IIu9nqZynWvr1Rbn71esaf4CD8TQWdtYrPxttT+TJbDOnj6Eg6qsRH1y5gewXMWv X3bFl96+R0Jb0bobqSrSc/FEy7C54wmAUSU3GpmjpMGnZWUGeINvi4pss9hbgx14tgH3 3R+w== X-Gm-Message-State: AO0yUKVUUl6OM+3IzH1ASj48c16y+qyBvmUPd/WrNMrsF/4hXoL/XWzY uV2OfpbHZtgcq0okM7CHua/1vX2EzipzKjq+tIEwdVkbCSYPprVPJUIwSEcdUAAOW0ULN+7+0jL Ctpe7IUZczvgqOwF85hnL/YnWymekpA0d01YsZ0B8FFc= X-Received: by 2002:a17:907:a408:b0:878:51a6:ff51 with SMTP id sg8-20020a170907a40800b0087851a6ff51mr30159194ejc.67.1675199229608; Tue, 31 Jan 2023 13:07:09 -0800 (PST) X-Google-Smtp-Source: AK7set/HDFs1OxXG5EoDqnbi9fgwPVrJHBcyWIRjar7lopDqhG9xTAbrL9ij6tNhmx+qMm+fXt/miQ== X-Received: by 2002:a17:907:a408:b0:878:51a6:ff51 with SMTP id sg8-20020a170907a40800b0087851a6ff51mr30159184ejc.67.1675199229433; Tue, 31 Jan 2023 13:07:09 -0800 (PST) Received: from amikhalitsyn.. (ip5f5bf399.dynamic.kabel-deutschland.de. [95.91.243.153]) by smtp.gmail.com with ESMTPSA id ja3-20020a170907988300b008818d9e0bfesm6231172ejc.117.2023.01.31.13.07.08 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 31 Jan 2023 13:07:09 -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 v2 2/2] docs: filesystems: vfs: actualize struct super_operations description Date: Tue, 31 Jan 2023 22:06:51 +0100 Message-Id: <20230131210651.715327-3-aleksandr.mikhalitsyn@canonical.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230131210651.715327-1-aleksandr.mikhalitsyn@canonical.com> References: <20230131210651.715327-1-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..e906867e3e83 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.1, 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.