fs/internal.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /* fs/ internal definitions
   3  *
   4  * Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
   5  * Written by David Howells (dhowells@redhat.com)
   6  */
   7
   8 struct super_block;
   9 struct file_system_type;
  10 struct iomap;
  11 struct iomap_ops;
  12 struct linux_binprm;
  13 struct path;
  14 struct mount;
  15 struct shrink_control;
  16 struct fs_context;
  17 struct pipe_inode_info;
  18 struct iov_iter;
  19 struct mnt_idmap;
  20
  21 /*
  22  * block/bdev.c
  23  */
  24 #ifdef CONFIG_BLOCK
  25 extern void __init bdev_cache_init(void);
  26
  27 void emergency_thaw_bdev(struct super_block *sb);
  28 #else
  29 static inline void bdev_cache_init(void)
  30 {
  31 }
  32 static inline int emergency_thaw_bdev(struct super_block *sb)
  33 {
  34         return 0;
  35 }
  36 #endif /* CONFIG_BLOCK */
  37
  38 /*
  39  * buffer.c
  40  */
  41 int __block_write_begin_int(struct folio *folio, loff_t pos, unsigned len,
  42                 get_block_t *get_block, const struct iomap *iomap);
  43
  44 /*
  45  * char_dev.c
  46  */
  47 extern void __init chrdev_init(void);
  48
  49 /*
  50  * fs_context.c
  51  */
  52 extern const struct fs_context_operations legacy_fs_context_ops;
  53 extern int parse_monolithic_mount_data(struct fs_context *, void *);
  54 extern void vfs_clean_context(struct fs_context *fc);
  55 extern int finish_clean_context(struct fs_context *fc);
  56
  57 /*
  58  * namei.c
  59  */
  60 extern int filename_lookup(int dfd, struct filename *name, unsigned flags,
  61                            struct path *path, struct path *root);
  62 int do_rmdir(int dfd, struct filename *name);
  63 int do_unlinkat(int dfd, struct filename *name);
  64 int may_linkat(struct mnt_idmap *idmap, const struct path *link);
  65 int do_renameat2(int olddfd, struct filename *oldname, int newdfd,
  66                  struct filename *newname, unsigned int flags);
  67 int do_mkdirat(int dfd, struct filename *name, umode_t mode);
  68 int do_symlinkat(struct filename *from, int newdfd, struct filename *to);
  69 int do_linkat(int olddfd, struct filename *old, int newdfd,
  70                         struct filename *new, int flags);
  71
  72 /*
  73  * namespace.c
  74  */
  75 extern struct vfsmount *lookup_mnt(const struct path *);
  76 extern int finish_automount(struct vfsmount *, const struct path *);
  77
  78 extern int sb_prepare_remount_readonly(struct super_block *);
  79
  80 extern void __init mnt_init(void);
  81
  82 extern int __mnt_want_write_file(struct file *);
  83 extern void __mnt_drop_write_file(struct file *);
  84
  85 extern void dissolve_on_fput(struct vfsmount *);
  86 extern bool may_mount(void);
  87
  88 int path_mount(const char *dev_name, struct path *path,
  89                 const char *type_page, unsigned long flags, void *data_page);
  90 int path_umount(struct path *path, int flags);
  91
  92 /*
  93  * fs_struct.c
  94  */
  95 extern void chroot_fs_refs(const struct path *, const struct path *);
  96
  97 /*
  98  * file_table.c
  99  */
 100 extern struct file *alloc_empty_file(int, const struct cred *);
 101 extern struct file *alloc_empty_file_noaccount(int, const struct cred *);
 102
 103 static inline void put_file_access(struct file *file)
 104 {
 105         if ((file->f_mode & (FMODE_READ | FMODE_WRITE)) == FMODE_READ) {
 106                 i_readcount_dec(file->f_inode);
 107         } else if (file->f_mode & FMODE_WRITER) {
 108                 put_write_access(file->f_inode);
 109                 __mnt_drop_write(file->f_path.mnt);
 110         }
 111 }
 112
 113 /*
 114  * super.c
 115  */
 116 extern int reconfigure_super(struct fs_context *);
 117 extern bool trylock_super(struct super_block *sb);
 118 struct super_block *user_get_super(dev_t, bool excl);
 119 void put_super(struct super_block *sb);
 120 extern bool mount_capable(struct fs_context *);
 121 int sb_init_dio_done_wq(struct super_block *sb);
 122
 123 /*
 124  * Prepare superblock for changing its read-only state (i.e., either remount
 125  * read-write superblock read-only or vice versa). After this function returns
 126  * mnt_is_readonly() will return true for any mount of the superblock if its
 127  * caller is able to observe any changes done by the remount. This holds until
 128  * sb_end_ro_state_change() is called.
 129  */
 130 static inline void sb_start_ro_state_change(struct super_block *sb)
 131 {
 132         WRITE_ONCE(sb->s_readonly_remount, 1);
 133         /*
 134          * For RO->RW transition, the barrier pairs with the barrier in
 135          * mnt_is_readonly() making sure if mnt_is_readonly() sees SB_RDONLY
 136          * cleared, it will see s_readonly_remount set.
 137          * For RW->RO transition, the barrier pairs with the barrier in
 138          * __mnt_want_write() before the mnt_is_readonly() check. The barrier
 139          * makes sure if __mnt_want_write() sees MNT_WRITE_HOLD already
 140          * cleared, it will see s_readonly_remount set.
 141          */
 142         smp_wmb();
 143 }
 144
 145 /*
 146  * Ends section changing read-only state of the superblock. After this function
 147  * returns if mnt_is_readonly() returns false, the caller will be able to
 148  * observe all the changes remount did to the superblock.
 149  */
 150 static inline void sb_end_ro_state_change(struct super_block *sb)
 151 {
 152         /*
 153          * This barrier provides release semantics that pairs with
 154          * the smp_rmb() acquire semantics in mnt_is_readonly().
 155          * This barrier pair ensure that when mnt_is_readonly() sees
 156          * 0 for sb->s_readonly_remount, it will also see all the
 157          * preceding flag changes that were made during the RO state
 158          * change.
 159          */
 160         smp_wmb();
 161         WRITE_ONCE(sb->s_readonly_remount, 0);
 162 }
 163
 164 /*
 165  * open.c
 166  */
 167 struct open_flags {
 168         int open_flag;
 169         umode_t mode;
 170         int acc_mode;
 171         int intent;
 172         int lookup_flags;
 173 };
 174 extern struct file *do_filp_open(int dfd, struct filename *pathname,
 175                 const struct open_flags *op);
 176 extern struct file *do_file_open_root(const struct path *,
 177                 const char *, const struct open_flags *);
 178 extern struct open_how build_open_how(int flags, umode_t mode);
 179 extern int build_open_flags(const struct open_how *how, struct open_flags *op);
 180 extern struct file *__close_fd_get_file(unsigned int fd);
 181
 182 long do_sys_ftruncate(unsigned int fd, loff_t length, int small);
 183 int chmod_common(const struct path *path, umode_t mode);
 184 int do_fchownat(int dfd, const char __user *filename, uid_t user, gid_t group,
 185                 int flag);
 186 int chown_common(const struct path *path, uid_t user, gid_t group);
 187 extern int vfs_open(const struct path *, struct file *);
 188
 189 /*
 190  * inode.c
 191  */
 192 extern long prune_icache_sb(struct super_block *sb, struct shrink_control *sc);
 193 int dentry_needs_remove_privs(struct mnt_idmap *, struct dentry *dentry);
 194 bool in_group_or_capable(struct mnt_idmap *idmap,
 195                          const struct inode *inode, vfsgid_t vfsgid);
 196
 197 /*
 198  * fs-writeback.c
 199  */
 200 extern long get_nr_dirty_inodes(void);
 201 extern int invalidate_inodes(struct super_block *, bool);
 202
 203 /*
 204  * dcache.c
 205  */
 206 extern int d_set_mounted(struct dentry *dentry);
 207 extern long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc);
 208 extern struct dentry *d_alloc_cursor(struct dentry *);
 209 extern struct dentry * d_alloc_pseudo(struct super_block *, const struct qstr *);
 210 extern char *simple_dname(struct dentry *, char *, int);
 211 extern void dput_to_list(struct dentry *, struct list_head *);
 212 extern void shrink_dentry_list(struct list_head *);
 213
 214 /*
 215  * pipe.c
 216  */
 217 extern const struct file_operations pipefifo_fops;
 218
 219 /*
 220  * fs_pin.c
 221  */
 222 extern void group_pin_kill(struct hlist_head *p);
 223 extern void mnt_pin_kill(struct mount *m);
 224
 225 /*
 226  * fs/nsfs.c
 227  */
 228 extern const struct dentry_operations ns_dentry_operations;
 229
 230 /*
 231  * fs/stat.c:
 232  */
 233
 234 int getname_statx_lookup_flags(int flags);
 235 int do_statx(int dfd, struct filename *filename, unsigned int flags,
 236              unsigned int mask, struct statx __user *buffer);
 237
 238 /*
 239  * fs/splice.c:
 240  */
 241 long splice_file_to_pipe(struct file *in,
 242                          struct pipe_inode_info *opipe,
 243                          loff_t *offset,
 244                          size_t len, unsigned int flags);
 245
 246 /*
 247  * fs/xattr.c:
 248  */
 249 struct xattr_name {
 250         char name[XATTR_NAME_MAX + 1];
 251 };
 252
 253 struct xattr_ctx {
 254         /* Value of attribute */
 255         union {
 256                 const void __user *cvalue;
 257                 void __user *value;
 258         };
 259         void *kvalue;
 260         size_t size;
 261         /* Attribute name */
 262         struct xattr_name *kname;
 263         unsigned int flags;
 264 };
 265
 266
 267 ssize_t do_getxattr(struct mnt_idmap *idmap,
 268                     struct dentry *d,
 269                     struct xattr_ctx *ctx);
 270
 271 int setxattr_copy(const char __user *name, struct xattr_ctx *ctx);
 272 int do_setxattr(struct mnt_idmap *idmap, struct dentry *dentry,
 273                 struct xattr_ctx *ctx);
 274 int may_write_xattr(struct mnt_idmap *idmap, struct inode *inode);
 275
 276 #ifdef CONFIG_FS_POSIX_ACL
 277 int do_set_acl(struct mnt_idmap *idmap, struct dentry *dentry,
 278                const char *acl_name, const void *kvalue, size_t size);
 279 ssize_t do_get_acl(struct mnt_idmap *idmap, struct dentry *dentry,
 280                    const char *acl_name, void *kvalue, size_t size);
 281 #else
 282 static inline int do_set_acl(struct mnt_idmap *idmap,
 283                              struct dentry *dentry, const char *acl_name,
 284                              const void *kvalue, size_t size)
 285 {
 286         return -EOPNOTSUPP;
 287 }
 288 static inline ssize_t do_get_acl(struct mnt_idmap *idmap,
 289                                  struct dentry *dentry, const char *acl_name,
 290                                  void *kvalue, size_t size)
 291 {
 292         return -EOPNOTSUPP;
 293 }
 294 #endif
 295
 296 ssize_t __kernel_write_iter(struct file *file, struct iov_iter *from, loff_t *pos);
 297
 298 /*
 299  * fs/attr.c
 300  */
 301 struct mnt_idmap *alloc_mnt_idmap(struct user_namespace *mnt_userns);
 302 struct mnt_idmap *mnt_idmap_get(struct mnt_idmap *idmap);
 303 void mnt_idmap_put(struct mnt_idmap *idmap);