blob: 997a530ff4e9d038d1e705c582833f8f6817a436 [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001/* SPDX-License-Identifier: GPL-2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002#ifndef _LINUX_FS_H
3#define _LINUX_FS_H
4
Linus Torvalds1da177e2005-04-16 15:20:36 -07005#include <linux/linkage.h>
Ingo Molnar5dd43ce2017-06-20 12:19:09 +02006#include <linux/wait_bit.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07007#include <linux/kdev_t.h>
8#include <linux/dcache.h>
Al Viro3f8206d2008-07-26 03:46:43 -04009#include <linux/path.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070010#include <linux/stat.h>
11#include <linux/cache.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/list.h>
Dave Chinnerbc3b14c2013-08-28 10:17:58 +100013#include <linux/list_lru.h>
Oleg Nesterov4f5e65a2013-07-08 14:24:16 -070014#include <linux/llist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/radix-tree.h>
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070016#include <linux/xarray.h>
Michel Lespinasse6b2dbba2012-10-08 16:31:25 -070017#include <linux/rbtree.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <linux/init.h>
Al Viro914e2632006-10-18 13:55:46 -040019#include <linux/pid.h>
Paul Gortmaker187f1882011-11-23 20:12:59 -050020#include <linux/bug.h>
Jes Sorensen1b1dcc12006-01-09 15:59:24 -080021#include <linux/mutex.h>
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080022#include <linux/rwsem.h>
Dan Williamsbaabda22017-07-10 15:48:25 -070023#include <linux/mm_types.h>
Satyam Sharma3bd858a2007-07-17 15:00:08 +053024#include <linux/capability.h>
Matthew Wilcox6188e102008-04-18 22:21:05 -040025#include <linux/semaphore.h>
Jens Axboec75b1d92017-06-27 11:47:04 -060026#include <linux/fcntl.h>
Mark Fashehc4b929b2008-10-08 19:44:18 -040027#include <linux/fiemap.h>
Nick Pigginceb5bdc2011-01-07 17:50:05 +110028#include <linux/rculist_bl.h>
Al Viro07b8ce12011-06-20 10:52:57 -040029#include <linux/atomic.h>
Konstantin Khlebnikov83aeead2011-12-08 14:33:54 -080030#include <linux/shrinker.h>
Stephen Rothwellc1aab022012-01-24 11:41:32 +110031#include <linux/migrate_mode.h>
Eric W. Biederman92361632012-02-08 07:07:50 -080032#include <linux/uidgid.h>
Jan Kara5accdf82012-06-12 16:20:34 +020033#include <linux/lockdep.h>
Jens Axboec2b1ad82012-09-27 09:35:03 +020034#include <linux/percpu-rwsem.h>
Oleg Nesterov853b39a2015-07-22 20:21:13 +020035#include <linux/workqueue.h>
Al Virofceef392015-12-29 15:58:39 -050036#include <linux/delayed_call.h>
Christoph Hellwig85787092017-05-10 15:06:33 +020037#include <linux/uuid.h>
Jeff Layton5660e132017-07-06 07:02:25 -040038#include <linux/errseq.h>
Adam Manzanaresd9a08a92018-05-22 10:52:19 -070039#include <linux/ioprio.h>
Phillip Potterbbe7449e2019-01-21 00:54:27 +000040#include <linux/fs_types.h>
Rasmus Villemoesf1fffbd2019-03-07 16:27:07 -080041#include <linux/build_bug.h>
42#include <linux/stddef.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#include <asm/byteorder.h>
David Howells607ca462012-10-13 10:46:48 +010045#include <uapi/linux/fs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
Christoph Hellwigb83ae6d2015-01-14 10:42:37 +010047struct backing_dev_info;
Tejun Heo52ebea72015-05-22 17:13:37 -040048struct bdi_writeback;
Christoph Hellwig2f8b5442016-11-01 07:40:13 -060049struct bio;
Christoph Hellwiga5694252007-07-17 04:04:28 -070050struct export_operations;
Christoph Hellwiga885c8c2006-01-08 01:02:50 -080051struct hd_geometry;
Linus Torvalds1da177e2005-04-16 15:20:36 -070052struct iovec;
Christoph Hellwig92198f72005-06-23 22:00:59 -070053struct kiocb;
Alexey Dobriyan57cc7212011-01-10 08:18:25 +020054struct kobject;
Linus Torvalds1da177e2005-04-16 15:20:36 -070055struct pipe_inode_info;
56struct poll_table_struct;
57struct kstatfs;
58struct vm_area_struct;
59struct vfsmount;
David Howells745ca242008-11-14 10:39:22 +110060struct cred;
Mel Gormana509bc12012-07-31 16:44:57 -070061struct swap_info_struct;
Cyrill Gorcunov55985dd2012-12-17 16:04:55 -080062struct seq_file;
Christoph Hellwig7b7a8662013-09-04 15:04:39 +020063struct workqueue_struct;
Al Viro3b93f912014-02-11 21:34:08 -050064struct iov_iter;
Jaegeuk Kim0b81d072015-05-15 16:26:10 -070065struct fscrypt_info;
66struct fscrypt_operations;
Al Virof3a09c92018-12-23 18:55:56 -050067struct fs_context;
David Howells3e1aeb02018-11-01 23:07:25 +000068struct fs_parameter_description;
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
Denis Cheng74bf17c2007-10-16 23:26:30 -070070extern void __init inode_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070071extern void __init inode_init_early(void);
Mel Gorman4248b0d2015-08-06 15:46:20 -070072extern void __init files_init(void);
73extern void __init files_maxfiles_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
Jan Engelhardtdded4f42008-12-01 14:34:50 -080075extern struct files_stat_struct files_stat;
Eric Dumazet518de9b2010-10-26 14:22:44 -070076extern unsigned long get_max_files(void);
Alexey Dobriyan9b80a182016-09-02 00:38:52 +030077extern unsigned int sysctl_nr_open;
Jan Engelhardtdded4f42008-12-01 14:34:50 -080078extern struct inodes_stat_t inodes_stat;
79extern int leases_enable, lease_break_time;
Kees Cook800179c2012-07-25 17:29:07 -070080extern int sysctl_protected_symlinks;
81extern int sysctl_protected_hardlinks;
Salvatore Mesoraca30aba662018-08-23 17:00:35 -070082extern int sysctl_protected_fifos;
83extern int sysctl_protected_regular;
Jan Engelhardtdded4f42008-12-01 14:34:50 -080084
Christoph Hellwigddef7ed22017-07-06 18:58:37 +020085typedef __kernel_rwf_t rwf_t;
86
Linus Torvalds1da177e2005-04-16 15:20:36 -070087struct buffer_head;
88typedef int (get_block_t)(struct inode *inode, sector_t iblock,
89 struct buffer_head *bh_result, int create);
Christoph Hellwig187372a2016-02-08 14:40:51 +110090typedef int (dio_iodone_t)(struct kiocb *iocb, loff_t offset,
Christoph Hellwig7b7a8662013-09-04 15:04:39 +020091 ssize_t bytes, void *private);
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
David Howellsbbc10962012-10-15 16:40:35 +010093#define MAY_EXEC 0x00000001
94#define MAY_WRITE 0x00000002
95#define MAY_READ 0x00000004
96#define MAY_APPEND 0x00000008
97#define MAY_ACCESS 0x00000010
98#define MAY_OPEN 0x00000020
99#define MAY_CHDIR 0x00000040
100/* called from RCU mode, don't block */
101#define MAY_NOT_BLOCK 0x00000080
102
103/*
104 * flags in file.f_mode. Note that FMODE_READ and FMODE_WRITE must correspond
Li Qiang75abe322018-05-17 19:01:03 -0700105 * to O_WRONLY and O_RDWR via the strange trick in do_dentry_open()
David Howellsbbc10962012-10-15 16:40:35 +0100106 */
107
108/* file is open for reading */
109#define FMODE_READ ((__force fmode_t)0x1)
110/* file is open for writing */
111#define FMODE_WRITE ((__force fmode_t)0x2)
112/* file is seekable */
113#define FMODE_LSEEK ((__force fmode_t)0x4)
114/* file can be accessed using pread */
115#define FMODE_PREAD ((__force fmode_t)0x8)
116/* file can be accessed using pwrite */
117#define FMODE_PWRITE ((__force fmode_t)0x10)
118/* File is opened for execution with sys_execve / sys_uselib */
119#define FMODE_EXEC ((__force fmode_t)0x20)
120/* File is opened with O_NDELAY (only set for block devices) */
121#define FMODE_NDELAY ((__force fmode_t)0x40)
122/* File is opened with O_EXCL (only set for block devices) */
123#define FMODE_EXCL ((__force fmode_t)0x80)
124/* File is opened using open(.., 3, ..) and is writeable only for ioctls
125 (specialy hack for floppy.c) */
126#define FMODE_WRITE_IOCTL ((__force fmode_t)0x100)
127/* 32bit hashes as llseek() offset (for directories) */
128#define FMODE_32BITHASH ((__force fmode_t)0x200)
129/* 64bit hashes as llseek() offset (for directories) */
130#define FMODE_64BITHASH ((__force fmode_t)0x400)
131
132/*
133 * Don't update ctime and mtime.
134 *
135 * Currently a special hack for the XFS open_by_handle ioctl, but we'll
136 * hopefully graduate it to a proper O_CMTIME flag supported by open(2) soon.
137 */
138#define FMODE_NOCMTIME ((__force fmode_t)0x800)
139
140/* Expect random access pattern */
141#define FMODE_RANDOM ((__force fmode_t)0x1000)
142
143/* File is huge (eg. /dev/kmem): treat loff_t as unsigned */
144#define FMODE_UNSIGNED_OFFSET ((__force fmode_t)0x2000)
145
146/* File is opened with O_PATH; almost nothing can be done with it */
147#define FMODE_PATH ((__force fmode_t)0x4000)
148
Linus Torvalds9c225f22014-03-03 09:36:58 -0800149/* File needs atomic accesses to f_pos */
150#define FMODE_ATOMIC_POS ((__force fmode_t)0x8000)
Al Viro83f936c2014-03-14 12:02:47 -0400151/* Write access to underlying fs */
152#define FMODE_WRITER ((__force fmode_t)0x10000)
Al Viro7f7f25e2014-02-11 17:49:24 -0500153/* Has read method(s) */
154#define FMODE_CAN_READ ((__force fmode_t)0x20000)
155/* Has write method(s) */
156#define FMODE_CAN_WRITE ((__force fmode_t)0x40000)
Linus Torvalds9c225f22014-03-03 09:36:58 -0800157
Al Virof5d11402018-07-09 02:35:08 -0400158#define FMODE_OPENED ((__force fmode_t)0x80000)
Al Viro73a09dd2018-06-08 13:22:02 -0400159#define FMODE_CREATED ((__force fmode_t)0x100000)
Al Virof5d11402018-07-09 02:35:08 -0400160
Kirill Smelkov10dce8a2019-03-26 22:20:43 +0000161/* File is stream-like */
162#define FMODE_STREAM ((__force fmode_t)0x200000)
163
David Howellsbbc10962012-10-15 16:40:35 +0100164/* File was opened by fanotify and shouldn't generate fanotify events */
David Drysdale75069f22015-01-08 14:32:29 -0800165#define FMODE_NONOTIFY ((__force fmode_t)0x4000000)
David Howellsbbc10962012-10-15 16:40:35 +0100166
Christoph Hellwig91f99432017-08-29 16:13:20 +0200167/* File is capable of returning -EAGAIN if I/O will block */
Al Viroa07b2002018-11-05 17:40:30 +0000168#define FMODE_NOWAIT ((__force fmode_t)0x8000000)
169
170/* File represents mount that needs unmounting */
171#define FMODE_NEED_UNMOUNT ((__force fmode_t)0x10000000)
Goldwyn Rodriguesb745faf2017-06-20 07:05:43 -0500172
Miklos Szeredid3b10842018-07-18 15:44:40 +0200173/* File does not contribute to nr_files count */
Al Viroa07b2002018-11-05 17:40:30 +0000174#define FMODE_NOACCOUNT ((__force fmode_t)0x20000000)
Miklos Szeredid3b10842018-07-18 15:44:40 +0200175
David Howellsbbc10962012-10-15 16:40:35 +0100176/*
177 * Flag for rw_copy_check_uvector and compat_rw_copy_check_uvector
178 * that indicates that they should check the contents of the iovec are
179 * valid, but not check the memory that the iovec elements
180 * points too.
181 */
182#define CHECK_IOVEC_ONLY -1
183
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184/*
185 * Attribute flags. These should be or-ed together to figure out what
186 * has been changed!
187 */
Miklos Szeredi9767d742008-07-01 15:01:26 +0200188#define ATTR_MODE (1 << 0)
189#define ATTR_UID (1 << 1)
190#define ATTR_GID (1 << 2)
191#define ATTR_SIZE (1 << 3)
192#define ATTR_ATIME (1 << 4)
193#define ATTR_MTIME (1 << 5)
194#define ATTR_CTIME (1 << 6)
195#define ATTR_ATIME_SET (1 << 7)
196#define ATTR_MTIME_SET (1 << 8)
197#define ATTR_FORCE (1 << 9) /* Not a change, but a change it */
Miklos Szeredi9767d742008-07-01 15:01:26 +0200198#define ATTR_KILL_SUID (1 << 11)
199#define ATTR_KILL_SGID (1 << 12)
200#define ATTR_FILE (1 << 13)
201#define ATTR_KILL_PRIV (1 << 14)
202#define ATTR_OPEN (1 << 15) /* Truncating from open(O_TRUNC) */
203#define ATTR_TIMES_SET (1 << 16)
Miklos Szeredif2b20f62016-09-16 12:44:20 +0200204#define ATTR_TOUCH (1 << 17)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
206/*
Miklos Szeredi787fb6b2014-10-24 00:14:36 +0200207 * Whiteout is represented by a char device. The following constants define the
208 * mode and device number to use.
209 */
210#define WHITEOUT_MODE 0
211#define WHITEOUT_DEV 0
212
213/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 * This is the Inode Attributes structure, used for notify_change(). It
215 * uses the above definitions as flags, to know which values have changed.
216 * Also, in this manner, a Filesystem can look at only the values it cares
217 * about. Basically, these are the attributes that the VFS layer can
218 * request to change from the FS layer.
219 *
220 * Derek Atkins <warlord@MIT.EDU> 94-10-20
221 */
222struct iattr {
223 unsigned int ia_valid;
224 umode_t ia_mode;
Eric W. Biederman92361632012-02-08 07:07:50 -0800225 kuid_t ia_uid;
226 kgid_t ia_gid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 loff_t ia_size;
Deepa Dinamani95582b02018-05-08 19:36:02 -0700228 struct timespec64 ia_atime;
229 struct timespec64 ia_mtime;
230 struct timespec64 ia_ctime;
Miklos Szeredicc4e69d2005-11-07 00:59:49 -0800231
232 /*
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300233 * Not an attribute, but an auxiliary info for filesystems wanting to
Miklos Szeredicc4e69d2005-11-07 00:59:49 -0800234 * implement an ftruncate() like method. NOTE: filesystem should
235 * check for (ia_valid & ATTR_FILE), and not for (ia_file != NULL).
236 */
237 struct file *ia_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238};
239
240/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 * Includes for diskquotas.
242 */
243#include <linux/quota.h>
244
Miklos Szeredi69c433e2014-10-24 00:14:39 +0200245/*
246 * Maximum number of layers of fs stack. Needs to be limited to
247 * prevent kernel stack overflow
248 */
249#define FILESYSTEM_MAX_STACK_DEPTH 2
250
Zach Brown994fc28c2005-12-15 14:28:17 -0800251/**
252 * enum positive_aop_returns - aop return codes with specific semantics
253 *
254 * @AOP_WRITEPAGE_ACTIVATE: Informs the caller that page writeback has
255 * completed, that the page is still locked, and
256 * should be considered active. The VM uses this hint
257 * to return the page to the active list -- it won't
258 * be a candidate for writeback again in the near
259 * future. Other callers must be careful to unlock
260 * the page if they get this return. Returned by
261 * writepage();
262 *
263 * @AOP_TRUNCATED_PAGE: The AOP method that was handed a locked page has
264 * unlocked it and the page might have been truncated.
265 * The caller should back up to acquiring a new page and
266 * trying again. The aop will be taking reasonable
267 * precautions not to livelock. If the caller held a page
268 * reference, it should drop it before retrying. Returned
Nick Piggin55144762007-10-16 01:25:26 -0700269 * by readpage().
Zach Brown994fc28c2005-12-15 14:28:17 -0800270 *
271 * address_space_operation functions return these large constants to indicate
272 * special semantics to the caller. These are much larger than the bytes in a
273 * page to allow for functions that return the number of bytes operated on in a
274 * given page.
275 */
276
277enum positive_aop_returns {
278 AOP_WRITEPAGE_ACTIVATE = 0x80000,
279 AOP_TRUNCATED_PAGE = 0x80001,
280};
281
Tetsuo Handac718a972017-05-08 15:58:59 -0700282#define AOP_FLAG_CONT_EXPAND 0x0001 /* called from cont_expand */
283#define AOP_FLAG_NOFS 0x0002 /* used by filesystem to direct
Nick Piggin54566b22009-01-04 12:00:53 -0800284 * helper code (eg buffer layer)
285 * to clear GFP_FS from alloc */
Nick Pigginafddba42007-10-16 01:25:01 -0700286
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287/*
288 * oh the beauties of C type declarations.
289 */
290struct page;
291struct address_space;
292struct writeback_control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293
Jens Axboec75b1d92017-06-27 11:47:04 -0600294/*
295 * Write life time hint values.
Amir Goldstein69448862018-07-05 09:25:43 +0300296 * Stored in struct inode as u8.
Jens Axboec75b1d92017-06-27 11:47:04 -0600297 */
298enum rw_hint {
299 WRITE_LIFE_NOT_SET = 0,
300 WRITE_LIFE_NONE = RWH_WRITE_LIFE_NONE,
301 WRITE_LIFE_SHORT = RWH_WRITE_LIFE_SHORT,
302 WRITE_LIFE_MEDIUM = RWH_WRITE_LIFE_MEDIUM,
303 WRITE_LIFE_LONG = RWH_WRITE_LIFE_LONG,
304 WRITE_LIFE_EXTREME = RWH_WRITE_LIFE_EXTREME,
305};
306
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800307#define IOCB_EVENTFD (1 << 0)
Al Viro2ba48ce2015-04-09 13:52:01 -0400308#define IOCB_APPEND (1 << 1)
309#define IOCB_DIRECT (1 << 2)
Christoph Hellwig97be7eb2016-03-03 16:04:01 +0100310#define IOCB_HIPRI (1 << 3)
Christoph Hellwigdde0c2e2016-04-07 08:52:00 -0700311#define IOCB_DSYNC (1 << 4)
312#define IOCB_SYNC (1 << 5)
Jan Kara70fe2f42016-10-30 11:42:04 -0500313#define IOCB_WRITE (1 << 6)
Goldwyn Rodriguesb745faf2017-06-20 07:05:43 -0500314#define IOCB_NOWAIT (1 << 7)
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800315
316struct kiocb {
317 struct file *ki_filp;
Linus Torvalds84c4e1f82019-03-03 14:23:33 -0800318
319 /* The 'ki_filp' pointer is shared in a union for aio */
320 randomized_struct_fields_start
321
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800322 loff_t ki_pos;
323 void (*ki_complete)(struct kiocb *iocb, long ret, long ret2);
324 void *private;
325 int ki_flags;
Adam Manzanaresfc287242018-05-22 10:52:18 -0700326 u16 ki_hint;
Adam Manzanaresd9a08a92018-05-22 10:52:19 -0700327 u16 ki_ioprio; /* See linux/ioprio.h */
Christoph Hellwigfb7e1602018-11-22 16:37:38 +0100328 unsigned int ki_cookie; /* for ->iopoll */
Linus Torvalds84c4e1f82019-03-03 14:23:33 -0800329
330 randomized_struct_fields_end
331};
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800332
333static inline bool is_sync_kiocb(struct kiocb *kiocb)
334{
335 return kiocb->ki_complete == NULL;
336}
337
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -0700338/*
339 * "descriptor" for what we're up to with a read.
340 * This allows us to use the same read code yet
341 * have multiple different users of the data that
342 * we read from a file.
343 *
344 * The simplest case just copies the data to user
345 * mode.
346 */
347typedef struct {
348 size_t written;
349 size_t count;
350 union {
351 char __user *buf;
352 void *data;
353 } arg;
354 int error;
355} read_descriptor_t;
356
357typedef int (*read_actor_t)(read_descriptor_t *, struct page *,
358 unsigned long, unsigned long);
Nick Piggin2f718ff2007-10-16 01:24:59 -0700359
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360struct address_space_operations {
361 int (*writepage)(struct page *page, struct writeback_control *wbc);
362 int (*readpage)(struct file *, struct page *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363
364 /* Write back some dirty pages from this mapping. */
365 int (*writepages)(struct address_space *, struct writeback_control *);
366
Andrew Morton4741c9f2006-03-24 03:18:11 -0800367 /* Set a page dirty. Return true if this dirtied it */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368 int (*set_page_dirty)(struct page *page);
369
Jens Axboe74c81642018-08-17 15:45:36 -0700370 /*
371 * Reads in the requested pages. Unlike ->readpage(), this is
372 * PURELY used for read-ahead!.
373 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 int (*readpages)(struct file *filp, struct address_space *mapping,
375 struct list_head *pages, unsigned nr_pages);
376
Nick Pigginafddba42007-10-16 01:25:01 -0700377 int (*write_begin)(struct file *, struct address_space *mapping,
378 loff_t pos, unsigned len, unsigned flags,
379 struct page **pagep, void **fsdata);
380 int (*write_end)(struct file *, struct address_space *mapping,
381 loff_t pos, unsigned len, unsigned copied,
382 struct page *page, void *fsdata);
383
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 /* Unfortunately this kludge is needed for FIBMAP. Don't use it */
385 sector_t (*bmap)(struct address_space *, sector_t);
Lukas Czernerd47992f2013-05-21 23:17:23 -0400386 void (*invalidatepage) (struct page *, unsigned int, unsigned int);
Al Viro27496a82005-10-21 03:20:48 -0400387 int (*releasepage) (struct page *, gfp_t);
Linus Torvalds6072d132010-12-01 13:35:19 -0500388 void (*freepage)(struct page *);
Christoph Hellwigc8b8e322016-04-07 08:51:58 -0700389 ssize_t (*direct_IO)(struct kiocb *, struct iov_iter *iter);
Mel Gormanb969c4a2012-01-12 17:19:34 -0800390 /*
Tang Chenef277c72013-07-08 16:00:21 -0700391 * migrate the contents of a page to the specified target. If
392 * migrate_mode is MIGRATE_ASYNC, it must not block.
Mel Gormanb969c4a2012-01-12 17:19:34 -0800393 */
Christoph Lameter2d1db3b2006-06-23 02:03:33 -0700394 int (*migratepage) (struct address_space *,
Mel Gormana6bc32b2012-01-12 17:19:43 -0800395 struct page *, struct page *, enum migrate_mode);
Minchan Kimbda807d2016-07-26 15:23:05 -0700396 bool (*isolate_page)(struct page *, isolate_mode_t);
397 void (*putback_page)(struct page *);
Trond Myklebuste3db7692007-01-10 23:15:39 -0800398 int (*launder_page) (struct page *);
Al Viroc186afb42014-02-02 21:16:54 -0500399 int (*is_partially_uptodate) (struct page *, unsigned long,
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -0700400 unsigned long);
Mel Gormanb4597222013-07-03 15:02:05 -0700401 void (*is_dirty_writeback) (struct page *, bool *, bool *);
Andi Kleen25718732009-09-16 11:50:13 +0200402 int (*error_remove_page)(struct address_space *, struct page *);
Mel Gorman62c230b2012-07-31 16:44:55 -0700403
404 /* swapfile support */
Mel Gormana509bc12012-07-31 16:44:57 -0700405 int (*swap_activate)(struct swap_info_struct *sis, struct file *file,
406 sector_t *span);
407 void (*swap_deactivate)(struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408};
409
Jens Axboe7dcda1c2011-04-05 23:51:48 +0200410extern const struct address_space_operations empty_aops;
411
Nick Pigginafddba42007-10-16 01:25:01 -0700412/*
413 * pagecache_write_begin/pagecache_write_end must be used by general code
414 * to write into the pagecache.
415 */
416int pagecache_write_begin(struct file *, struct address_space *mapping,
417 loff_t pos, unsigned len, unsigned flags,
418 struct page **pagep, void **fsdata);
419
420int pagecache_write_end(struct file *, struct address_space *mapping,
421 loff_t pos, unsigned len, unsigned copied,
422 struct page *page, void *fsdata);
423
Matthew Wilcoxeb797a82018-03-05 22:46:03 -0500424/**
425 * struct address_space - Contents of a cacheable, mappable object.
426 * @host: Owner, either the inode or the block_device.
427 * @i_pages: Cached pages.
428 * @gfp_mask: Memory allocation flags to use for allocating pages.
429 * @i_mmap_writable: Number of VM_SHARED mappings.
430 * @i_mmap: Tree of private and shared mappings.
431 * @i_mmap_rwsem: Protects @i_mmap and @i_mmap_writable.
432 * @nrpages: Number of page entries, protected by the i_pages lock.
433 * @nrexceptional: Shadow or DAX entries, protected by the i_pages lock.
434 * @writeback_index: Writeback starts here.
435 * @a_ops: Methods.
436 * @flags: Error bits and flags (AS_*).
437 * @wb_err: The most recent error which has occurred.
438 * @private_lock: For use by the owner of the address_space.
439 * @private_list: For use by the owner of the address_space.
440 * @private_data: For use by the owner of the address_space.
441 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442struct address_space {
Matthew Wilcoxeb797a82018-03-05 22:46:03 -0500443 struct inode *host;
444 struct xarray i_pages;
445 gfp_t gfp_mask;
446 atomic_t i_mmap_writable;
447 struct rb_root_cached i_mmap;
448 struct rw_semaphore i_mmap_rwsem;
449 unsigned long nrpages;
Ross Zwislerf9fe48b2016-01-22 15:10:40 -0800450 unsigned long nrexceptional;
Matthew Wilcoxeb797a82018-03-05 22:46:03 -0500451 pgoff_t writeback_index;
452 const struct address_space_operations *a_ops;
453 unsigned long flags;
Jeff Layton5660e132017-07-06 07:02:25 -0400454 errseq_t wb_err;
Matthew Wilcoxeb797a82018-03-05 22:46:03 -0500455 spinlock_t private_lock;
456 struct list_head private_list;
457 void *private_data;
Kees Cook3859a272016-10-28 01:22:25 -0700458} __attribute__((aligned(sizeof(long)))) __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 /*
460 * On most architectures that alignment is already the case; but
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300461 * must be enforced here for CRIS, to let the least significant bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 * of struct page's "mapping" pointer be used for PAGE_MAPPING_ANON.
463 */
Andi Kleen87192a22012-01-12 17:20:34 -0800464struct request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465
466struct block_device {
467 dev_t bd_dev; /* not a kdev_t - it's a search key */
Richard Kennedyf3ccfcd2011-03-22 16:33:56 -0700468 int bd_openers;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 struct inode * bd_inode; /* will die */
Theodore Ts'o87d8fe12009-01-03 09:47:09 -0500470 struct super_block * bd_super;
Arjan van de Venc039e312006-03-23 03:00:28 -0800471 struct mutex bd_mutex; /* open/close mutex */
Tejun Heo6b4517a2010-04-07 18:53:59 +0900472 void * bd_claiming;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 void * bd_holder;
474 int bd_holders;
Tejun Heo77ea8872010-12-08 20:57:37 +0100475 bool bd_write_holder;
Jun'ichi Nomura641dc632006-03-27 01:17:57 -0800476#ifdef CONFIG_SYSFS
Tejun Heo49731ba2011-01-14 18:43:57 +0100477 struct list_head bd_holder_disks;
Jun'ichi Nomura641dc632006-03-27 01:17:57 -0800478#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 struct block_device * bd_contains;
480 unsigned bd_block_size;
Christoph Hellwigc2ee0702017-08-23 19:10:31 +0200481 u8 bd_partno;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 struct hd_struct * bd_part;
483 /* number of times partitions within this device have been opened. */
484 unsigned bd_part_count;
485 int bd_invalidated;
486 struct gendisk * bd_disk;
Andi Kleen87192a22012-01-12 17:20:34 -0800487 struct request_queue * bd_queue;
Jan Karab1d2dc562017-02-02 15:56:52 +0100488 struct backing_dev_info *bd_bdi;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 struct list_head bd_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 /*
491 * Private data. You must have bd_claim'ed the block_device
492 * to use this. NOTE: bd_claim allows an owner to claim
493 * the same device multiple times, the owner must take special
494 * care to not mess up bd_private for that case.
495 */
496 unsigned long bd_private;
Takashi Satofcccf502009-01-09 16:40:59 -0800497
498 /* The counter of freeze processes */
499 int bd_fsfreeze_count;
500 /* Mutex for freeze */
501 struct mutex bd_fsfreeze_mutex;
Kees Cook3859a272016-10-28 01:22:25 -0700502} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503
Matthew Wilcoxff9c7452017-11-22 11:41:23 -0500504/* XArray tags, for tagging dirty and writeback pages in the pagecache. */
505#define PAGECACHE_TAG_DIRTY XA_MARK_0
506#define PAGECACHE_TAG_WRITEBACK XA_MARK_1
507#define PAGECACHE_TAG_TOWRITE XA_MARK_2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508
Matthew Wilcoxff9c7452017-11-22 11:41:23 -0500509/*
510 * Returns true if any of the pages in the mapping are marked with the tag.
511 */
512static inline bool mapping_tagged(struct address_space *mapping, xa_mark_t tag)
513{
514 return xa_marked(&mapping->i_pages, tag);
515}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800517static inline void i_mmap_lock_write(struct address_space *mapping)
518{
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800519 down_write(&mapping->i_mmap_rwsem);
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800520}
521
522static inline void i_mmap_unlock_write(struct address_space *mapping)
523{
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800524 up_write(&mapping->i_mmap_rwsem);
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800525}
526
Davidlohr Bueso3dec0ba2014-12-12 16:54:27 -0800527static inline void i_mmap_lock_read(struct address_space *mapping)
528{
529 down_read(&mapping->i_mmap_rwsem);
530}
531
532static inline void i_mmap_unlock_read(struct address_space *mapping)
533{
534 up_read(&mapping->i_mmap_rwsem);
535}
536
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537/*
538 * Might pages of this file be mapped into userspace?
539 */
540static inline int mapping_mapped(struct address_space *mapping)
541{
Davidlohr Buesof808c132017-09-08 16:15:08 -0700542 return !RB_EMPTY_ROOT(&mapping->i_mmap.rb_root);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543}
544
545/*
546 * Might pages of this file have been modified in userspace?
547 * Note that i_mmap_writable counts all VM_SHARED vmas: do_mmap_pgoff
548 * marks vma as VM_SHARED if it is shared, and the file was opened for
549 * writing i.e. vma may be mprotected writable even if now readonly.
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700550 *
551 * If i_mmap_writable is negative, no new writable mappings are allowed. You
552 * can only deny writable mappings, if none exists right now.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 */
554static inline int mapping_writably_mapped(struct address_space *mapping)
555{
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700556 return atomic_read(&mapping->i_mmap_writable) > 0;
557}
558
559static inline int mapping_map_writable(struct address_space *mapping)
560{
561 return atomic_inc_unless_negative(&mapping->i_mmap_writable) ?
562 0 : -EPERM;
563}
564
565static inline void mapping_unmap_writable(struct address_space *mapping)
566{
567 atomic_dec(&mapping->i_mmap_writable);
568}
569
570static inline int mapping_deny_writable(struct address_space *mapping)
571{
572 return atomic_dec_unless_positive(&mapping->i_mmap_writable) ?
573 0 : -EBUSY;
574}
575
576static inline void mapping_allow_writable(struct address_space *mapping)
577{
578 atomic_inc(&mapping->i_mmap_writable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579}
580
581/*
582 * Use sequence counter to get consistent i_size on 32-bit processors.
583 */
584#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
585#include <linux/seqlock.h>
586#define __NEED_I_SIZE_ORDERED
587#define i_size_ordered_init(inode) seqcount_init(&inode->i_size_seqcount)
588#else
589#define i_size_ordered_init(inode) do { } while (0)
590#endif
591
Al Virof19d4a82009-06-08 19:50:45 -0400592struct posix_acl;
593#define ACL_NOT_CACHED ((void *)(-1))
Miklos Szeredi2a3a2a32016-09-01 11:11:59 +0200594#define ACL_DONT_CACHE ((void *)(-3))
Al Virof19d4a82009-06-08 19:50:45 -0400595
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100596static inline struct posix_acl *
597uncached_acl_sentinel(struct task_struct *task)
598{
599 return (void *)task + 1;
600}
601
602static inline bool
603is_uncached_acl(struct posix_acl *acl)
604{
605 return (long)acl & 1;
606}
607
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700608#define IOP_FASTPERM 0x0001
609#define IOP_LOOKUP 0x0002
610#define IOP_NOFOLLOW 0x0004
Andreas Gruenbacherd0a5b992016-09-29 17:48:39 +0200611#define IOP_XATTR 0x0008
Miklos Szeredi76fca902016-12-09 16:45:04 +0100612#define IOP_DEFAULT_READLINK 0x0010
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700613
Jan Kara9dd813c2017-03-14 12:31:02 +0100614struct fsnotify_mark_connector;
615
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700616/*
617 * Keep mostly read-only and often accessed (especially for
618 * the RCU path lookup and 'stat' data) fields at the beginning
619 * of the 'struct inode'
620 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621struct inode {
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100622 umode_t i_mode;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700623 unsigned short i_opflags;
Eric W. Biederman92361632012-02-08 07:07:50 -0800624 kuid_t i_uid;
625 kgid_t i_gid;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700626 unsigned int i_flags;
627
628#ifdef CONFIG_FS_POSIX_ACL
629 struct posix_acl *i_acl;
630 struct posix_acl *i_default_acl;
631#endif
632
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100633 const struct inode_operations *i_op;
634 struct super_block *i_sb;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700635 struct address_space *i_mapping;
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100636
Linus Torvalds13e12d12011-06-08 15:18:19 -0700637#ifdef CONFIG_SECURITY
638 void *i_security;
639#endif
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100640
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700641 /* Stat data, not accessed from path walking */
642 unsigned long i_ino;
Miklos Szeredia78ef702011-10-28 14:13:30 +0200643 /*
644 * Filesystems may only read i_nlink directly. They shall use the
645 * following functions for modification:
646 *
647 * (set|clear|inc|drop)_nlink
648 * inode_(inc|dec)_link_count
649 */
650 union {
651 const unsigned int i_nlink;
652 unsigned int __i_nlink;
653 };
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700654 dev_t i_rdev;
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700655 loff_t i_size;
Deepa Dinamani95582b02018-05-08 19:36:02 -0700656 struct timespec64 i_atime;
657 struct timespec64 i_mtime;
658 struct timespec64 i_ctime;
Theodore Ts'o6cdbb0e2011-10-29 08:24:18 -0400659 spinlock_t i_lock; /* i_blocks, i_bytes, maybe i_size */
660 unsigned short i_bytes;
Amir Goldstein69448862018-07-05 09:25:43 +0300661 u8 i_blkbits;
662 u8 i_write_hint;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700663 blkcnt_t i_blocks;
664
665#ifdef __NEED_I_SIZE_ORDERED
666 seqcount_t i_size_seqcount;
667#endif
668
669 /* Misc */
670 unsigned long i_state;
Al Viro9902af72016-04-15 15:08:36 -0400671 struct rw_semaphore i_rwsem;
Linus Torvalds13e12d12011-06-08 15:18:19 -0700672
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100673 unsigned long dirtied_when; /* jiffies of first dirtying */
Theodore Ts'oa2f48702015-03-17 12:23:19 -0400674 unsigned long dirtied_time_when;
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100675
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 struct hlist_node i_hash;
Dave Chinnerc7f54082015-03-04 14:07:22 -0500677 struct list_head i_io_list; /* backing dev IO list */
Tejun Heo52ebea72015-05-22 17:13:37 -0400678#ifdef CONFIG_CGROUP_WRITEBACK
679 struct bdi_writeback *i_wb; /* the associated cgroup wb */
Tejun Heo2a814902015-05-28 14:50:51 -0400680
681 /* foreign inode detection, see wbc_detach_inode() */
682 int i_wb_frn_winner;
683 u16 i_wb_frn_avg_time;
684 u16 i_wb_frn_history;
Tejun Heo52ebea72015-05-22 17:13:37 -0400685#endif
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100686 struct list_head i_lru; /* inode LRU list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 struct list_head i_sb_list;
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700688 struct list_head i_wb_list; /* backing dev writeback list */
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100689 union {
Al Virob3d9b7a2012-06-09 13:51:19 -0400690 struct hlist_head i_dentry;
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100691 struct rcu_head i_rcu;
692 };
Jeff Laytonf02a9ad2017-12-21 07:45:44 -0500693 atomic64_t i_version;
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700694 atomic_t i_count;
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -0400695 atomic_t i_dio_count;
Theodore Ts'o6cdbb0e2011-10-29 08:24:18 -0400696 atomic_t i_writecount;
Amir Goldstein387e3742019-06-07 17:24:38 +0300697#if defined(CONFIG_IMA) || defined(CONFIG_FILE_LOCKING)
Mimi Zohard984ea62013-12-11 15:20:54 -0500698 atomic_t i_readcount; /* struct files open RO */
699#endif
Al Virofdb0da82019-04-10 14:43:44 -0400700 union {
701 const struct file_operations *i_fop; /* former ->i_op->default_file_ops */
702 void (*free_inode)(struct inode *);
703 };
Jeff Layton4a075e32015-01-16 15:05:54 -0500704 struct file_lock_context *i_flctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 struct address_space i_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706 struct list_head i_devices;
Theodore Ts'o4c154162006-09-27 01:50:47 -0700707 union {
708 struct pipe_inode_info *i_pipe;
Theodore Ts'oeaf796e2006-09-27 01:50:48 -0700709 struct block_device *i_bdev;
Theodore Ts'o577c4eb2006-09-27 01:50:49 -0700710 struct cdev *i_cdev;
Al Viro61ba64f2015-05-02 09:54:06 -0400711 char *i_link;
Al Viro84e710d2016-04-15 00:58:55 -0400712 unsigned i_dir_seq;
Theodore Ts'o4c154162006-09-27 01:50:47 -0700713 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714
715 __u32 i_generation;
716
Eric Paris3be25f42009-05-21 17:01:26 -0400717#ifdef CONFIG_FSNOTIFY
718 __u32 i_fsnotify_mask; /* all events this inode cares about */
Jan Kara08991e82017-02-01 09:21:58 +0100719 struct fsnotify_mark_connector __rcu *i_fsnotify_marks;
Robert Love0eeca282005-07-12 17:06:03 -0400720#endif
721
Chandan Rajendra643fa962018-12-12 15:20:12 +0530722#ifdef CONFIG_FS_ENCRYPTION
Jaegeuk Kim0b81d072015-05-15 16:26:10 -0700723 struct fscrypt_info *i_crypt_info;
724#endif
725
Theodore Ts'o8e18e292006-09-27 01:50:46 -0700726 void *i_private; /* fs or device private pointer */
Kees Cook3859a272016-10-28 01:22:25 -0700727} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728
Fabian Frederick93407472017-02-27 14:28:32 -0800729static inline unsigned int i_blocksize(const struct inode *node)
730{
731 return (1 << node->i_blkbits);
732}
733
Al Viro1d3382cb2010-10-23 15:19:20 -0400734static inline int inode_unhashed(struct inode *inode)
735{
736 return hlist_unhashed(&inode->i_hash);
737}
738
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739/*
Al Viro5bef9152018-06-29 19:36:57 -0400740 * __mark_inode_dirty expects inodes to be hashed. Since we don't
741 * want special inodes in the fileset inode space, we make them
742 * appear hashed, but do not put on any lists. hlist_del()
743 * will work fine and require no locking.
744 */
745static inline void inode_fake_hash(struct inode *inode)
746{
747 hlist_add_fake(&inode->i_hash);
748}
749
750/*
Ingo Molnarf2eace22006-07-03 00:25:05 -0700751 * inode->i_mutex nesting subclasses for the lock validator:
752 *
753 * 0: the object of the current VFS operation
754 * 1: parent
755 * 2: child/target
J. Bruce Fields40bd22c2012-04-18 15:21:34 -0400756 * 3: xattr
757 * 4: second non-directory
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100758 * 5: second parent (when locking independent directories in rename)
759 *
760 * I_MUTEX_NONDIR2 is for certain operations (such as rename) which lock two
J. Bruce Fields40bd22c2012-04-18 15:21:34 -0400761 * non-directories at once.
Ingo Molnarf2eace22006-07-03 00:25:05 -0700762 *
763 * The locking order between these classes is
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100764 * parent[2] -> child -> grandchild -> normal -> xattr -> second non-directory
Ingo Molnarf2eace22006-07-03 00:25:05 -0700765 */
766enum inode_i_mutex_lock_class
767{
768 I_MUTEX_NORMAL,
769 I_MUTEX_PARENT,
770 I_MUTEX_CHILD,
Ingo Molnar4df46242006-08-27 01:23:56 -0700771 I_MUTEX_XATTR,
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100772 I_MUTEX_NONDIR2,
773 I_MUTEX_PARENT2,
Ingo Molnarf2eace22006-07-03 00:25:05 -0700774};
775
Al Viro59551022016-01-22 15:40:57 -0500776static inline void inode_lock(struct inode *inode)
777{
Al Viro9902af72016-04-15 15:08:36 -0400778 down_write(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500779}
780
781static inline void inode_unlock(struct inode *inode)
782{
Al Viro9902af72016-04-15 15:08:36 -0400783 up_write(&inode->i_rwsem);
784}
785
786static inline void inode_lock_shared(struct inode *inode)
787{
788 down_read(&inode->i_rwsem);
789}
790
791static inline void inode_unlock_shared(struct inode *inode)
792{
793 up_read(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500794}
795
796static inline int inode_trylock(struct inode *inode)
797{
Al Viro9902af72016-04-15 15:08:36 -0400798 return down_write_trylock(&inode->i_rwsem);
799}
800
801static inline int inode_trylock_shared(struct inode *inode)
802{
803 return down_read_trylock(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500804}
805
806static inline int inode_is_locked(struct inode *inode)
807{
Al Viro9902af72016-04-15 15:08:36 -0400808 return rwsem_is_locked(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500809}
810
811static inline void inode_lock_nested(struct inode *inode, unsigned subclass)
812{
Al Viro9902af72016-04-15 15:08:36 -0400813 down_write_nested(&inode->i_rwsem, subclass);
Al Viro59551022016-01-22 15:40:57 -0500814}
815
Darrick J. Wong01c2e132018-01-18 14:07:53 -0800816static inline void inode_lock_shared_nested(struct inode *inode, unsigned subclass)
817{
818 down_read_nested(&inode->i_rwsem, subclass);
819}
820
J. Bruce Fields375e2892012-04-18 15:16:33 -0400821void lock_two_nondirectories(struct inode *, struct inode*);
822void unlock_two_nondirectories(struct inode *, struct inode*);
823
Ingo Molnarf2eace22006-07-03 00:25:05 -0700824/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 * NOTE: in a 32bit arch with a preemptable kernel and
826 * an UP compile the i_size_read/write must be atomic
827 * with respect to the local cpu (unlike with preempt disabled),
828 * but they don't need to be atomic with respect to other cpus like in
829 * true SMP (so they need either to either locally disable irq around
830 * the read or for example on x86 they can be still implemented as a
831 * cmpxchg8b without the need of the lock prefix). For SMP compiles
832 * and 64bit archs it makes no difference if preempt is enabled or not.
833 */
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800834static inline loff_t i_size_read(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835{
836#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
837 loff_t i_size;
838 unsigned int seq;
839
840 do {
841 seq = read_seqcount_begin(&inode->i_size_seqcount);
842 i_size = inode->i_size;
843 } while (read_seqcount_retry(&inode->i_size_seqcount, seq));
844 return i_size;
845#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
846 loff_t i_size;
847
848 preempt_disable();
849 i_size = inode->i_size;
850 preempt_enable();
851 return i_size;
852#else
853 return inode->i_size;
854#endif
855}
856
Miklos Szeredi7762f5a2006-10-17 00:10:07 -0700857/*
858 * NOTE: unlike i_size_read(), i_size_write() does need locking around it
859 * (normally i_mutex), otherwise on 32bit/SMP an update of i_size_seqcount
860 * can be lost, resulting in subsequent i_size_read() calls spinning forever.
861 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862static inline void i_size_write(struct inode *inode, loff_t i_size)
863{
864#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
Fan Du74e3d1e2013-04-30 15:27:27 -0700865 preempt_disable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866 write_seqcount_begin(&inode->i_size_seqcount);
867 inode->i_size = i_size;
868 write_seqcount_end(&inode->i_size_seqcount);
Fan Du74e3d1e2013-04-30 15:27:27 -0700869 preempt_enable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
871 preempt_disable();
872 inode->i_size = i_size;
873 preempt_enable();
874#else
875 inode->i_size = i_size;
876#endif
877}
878
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800879static inline unsigned iminor(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880{
881 return MINOR(inode->i_rdev);
882}
883
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800884static inline unsigned imajor(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885{
886 return MAJOR(inode->i_rdev);
887}
888
889extern struct block_device *I_BDEV(struct inode *inode);
890
891struct fown_struct {
892 rwlock_t lock; /* protects pid, uid, euid fields */
Eric W. Biederman609d7fa2006-10-02 02:17:15 -0700893 struct pid *pid; /* pid or -pgrp where SIGIO should be sent */
894 enum pid_type pid_type; /* Kind of process group SIGIO should be sent to */
Eric W. Biederman92361632012-02-08 07:07:50 -0800895 kuid_t uid, euid; /* uid/euid of process setting the owner */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896 int signum; /* posix.1b rt signal to be delivered on IO */
897};
898
899/*
900 * Track a single file's readahead state
901 */
902struct file_ra_state {
Fengguang Wu937085a2007-10-16 01:24:31 -0700903 pgoff_t start; /* where readahead started */
904 unsigned int size; /* # of readahead pages */
905 unsigned int async_size; /* do asynchronous readahead when
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700906 there are only # of pages ahead */
Fengguang Wu5ce11102007-07-19 01:47:59 -0700907
Fengguang Wu937085a2007-10-16 01:24:31 -0700908 unsigned int ra_pages; /* Maximum readahead window */
Wu Fengguang1ebf26a2009-06-16 15:31:19 -0700909 unsigned int mmap_miss; /* Cache miss stat for mmap accesses */
Fengguang Wuf4e6b492007-10-16 01:24:33 -0700910 loff_t prev_pos; /* Cache last read() position */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912
Fengguang Wu5ce11102007-07-19 01:47:59 -0700913/*
Fengguang Wu5ce11102007-07-19 01:47:59 -0700914 * Check if @index falls in the readahead windows.
915 */
916static inline int ra_has_index(struct file_ra_state *ra, pgoff_t index)
917{
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700918 return (index >= ra->start &&
919 index < ra->start + ra->size);
Fengguang Wu5ce11102007-07-19 01:47:59 -0700920}
921
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922struct file {
Eric Dumazet2f512012005-10-30 15:02:16 -0800923 union {
Oleg Nesterov4f5e65a2013-07-08 14:24:16 -0700924 struct llist_node fu_llist;
Eric Dumazet2f512012005-10-30 15:02:16 -0800925 struct rcu_head fu_rcuhead;
926 } f_u;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800927 struct path f_path;
Al Virodd379782013-03-01 19:48:30 -0500928 struct inode *f_inode; /* cached value */
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800929 const struct file_operations *f_op;
Andi Kleenef3d0fd2011-09-15 16:06:48 -0700930
931 /*
Linus Torvalds9c225f22014-03-03 09:36:58 -0800932 * Protects f_ep_links, f_flags.
Andi Kleenef3d0fd2011-09-15 16:06:48 -0700933 * Must not be taken from IRQ context.
934 */
935 spinlock_t f_lock;
Jens Axboec75b1d92017-06-27 11:47:04 -0600936 enum rw_hint f_write_hint;
Al Viro516e0cc2008-07-26 00:39:17 -0400937 atomic_long_t f_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938 unsigned int f_flags;
Al Viroaeb5d722008-09-02 15:28:45 -0400939 fmode_t f_mode;
Linus Torvalds9c225f22014-03-03 09:36:58 -0800940 struct mutex f_pos_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941 loff_t f_pos;
942 struct fown_struct f_owner;
David Howellsd76b0d92008-11-14 10:39:25 +1100943 const struct cred *f_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944 struct file_ra_state f_ra;
945
Mathieu Desnoyers2b47c362007-10-16 23:27:21 -0700946 u64 f_version;
Alexey Dobriyan50462062006-09-29 02:00:01 -0700947#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948 void *f_security;
Alexey Dobriyan50462062006-09-29 02:00:01 -0700949#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950 /* needed for tty driver, and maybe others */
951 void *private_data;
952
953#ifdef CONFIG_EPOLL
954 /* Used by fs/eventpoll.c to link all the hooks to this file */
955 struct list_head f_ep_links;
Jason Baron28d82dc2012-01-12 17:17:43 -0800956 struct list_head f_tfile_llink;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957#endif /* #ifdef CONFIG_EPOLL */
958 struct address_space *f_mapping;
Jeff Layton5660e132017-07-06 07:02:25 -0400959 errseq_t f_wb_err;
Kees Cook3859a272016-10-28 01:22:25 -0700960} __randomize_layout
961 __attribute__((aligned(4))); /* lest something weird decides that 2 is OK */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962
Aneesh Kumar K.V990d6c22011-01-29 18:43:26 +0530963struct file_handle {
964 __u32 handle_bytes;
965 int handle_type;
966 /* file identifier */
967 unsigned char f_handle[0];
968};
969
Al Virocb0942b2012-08-27 14:48:26 -0400970static inline struct file *get_file(struct file *f)
971{
972 atomic_long_inc(&f->f_count);
973 return f;
974}
Jens Axboe091141a2018-11-21 10:32:39 -0700975#define get_file_rcu_many(x, cnt) \
976 atomic_long_add_unless(&(x)->f_count, (cnt), 0)
977#define get_file_rcu(x) get_file_rcu_many((x), 1)
Al Viro516e0cc2008-07-26 00:39:17 -0400978#define file_count(x) atomic_long_read(&(x)->f_count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979
980#define MAX_NON_LFS ((1UL<<31) - 1)
981
982/* Page cache limit. The filesystems should put that into their s_maxbytes
983 limits, otherwise bad things can happen in VM. */
984#if BITS_PER_LONG==32
Linus Torvalds0cc3b0e2017-08-27 12:12:25 -0700985#define MAX_LFS_FILESIZE ((loff_t)ULONG_MAX << PAGE_SHIFT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986#elif BITS_PER_LONG==64
Linus Torvalds0cc3b0e2017-08-27 12:12:25 -0700987#define MAX_LFS_FILESIZE ((loff_t)LLONG_MAX)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988#endif
989
990#define FL_POSIX 1
991#define FL_FLOCK 2
J. Bruce Fields617588d2011-07-01 15:18:34 -0400992#define FL_DELEG 4 /* NFSv4 delegation */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993#define FL_ACCESS 8 /* not trying to lock, just looking */
Trond Myklebustf475ae92006-06-29 16:38:32 -0400994#define FL_EXISTS 16 /* when unlocking, test for existence */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995#define FL_LEASE 32 /* lease held on this file */
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -0700996#define FL_CLOSE 64 /* unlock on close */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997#define FL_SLEEP 128 /* A blocking lock */
J. Bruce Fields778fc542011-07-26 18:25:49 -0400998#define FL_DOWNGRADE_PENDING 256 /* Lease is being downgraded */
999#define FL_UNLOCK_PENDING 512 /* Lease is being broken */
Jeff Laytoncff2fce2014-04-22 08:24:32 -04001000#define FL_OFDLCK 1024 /* lock is "owned" by struct file */
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001001#define FL_LAYOUT 2048 /* outstanding pNFS layout */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002
Benjamin Coddington50f21122017-04-11 12:50:09 -04001003#define FL_CLOSE_POSIX (FL_POSIX | FL_CLOSE)
1004
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005/*
Miklos Szeredibde74e42008-07-25 01:48:57 -07001006 * Special return value from posix_lock_file() and vfs_lock_file() for
1007 * asynchronous locking.
1008 */
1009#define FILE_LOCK_DEFERRED 1
1010
Jeff Layton7ca76312014-09-01 19:04:48 -04001011/* legacy typedef, should eventually be removed */
Christoph Hellwig17fa3882014-07-13 17:00:37 +02001012typedef void *fl_owner_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013
Jeff Laytona7231a92015-01-16 15:05:56 -05001014struct file_lock;
1015
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016struct file_lock_operations {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017 void (*fl_copy_lock)(struct file_lock *, struct file_lock *);
1018 void (*fl_release_private)(struct file_lock *);
1019};
1020
1021struct lock_manager_operations {
Jeff Laytoncae80b32015-04-03 09:04:04 -04001022 fl_owner_t (*lm_get_owner)(fl_owner_t);
1023 void (*lm_put_owner)(fl_owner_t);
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001024 void (*lm_notify)(struct file_lock *); /* unblock callback */
Joe Perchesd0449b92014-08-22 10:18:42 -04001025 int (*lm_grant)(struct file_lock *, int);
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001026 bool (*lm_break)(struct file_lock *);
Jeff Layton7448cc32015-01-16 15:05:57 -05001027 int (*lm_change)(struct file_lock *, int, struct list_head *);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001028 void (*lm_setup)(struct file_lock *, void **);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029};
1030
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -04001031struct lock_manager {
1032 struct list_head list;
J. Bruce Fieldsc87fb4a2015-08-06 12:47:02 -04001033 /*
1034 * NFSv4 and up also want opens blocked during the grace period;
1035 * NLM doesn't care:
1036 */
1037 bool block_opens;
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -04001038};
1039
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +04001040struct net;
1041void locks_start_grace(struct net *, struct lock_manager *);
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -04001042void locks_end_grace(struct lock_manager *);
Corentin Labbe003278e2017-09-26 09:14:07 +02001043bool locks_in_grace(struct net *);
1044bool opens_in_grace(struct net *);
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -04001045
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046/* that will die - we need it for nfs_lock_info */
1047#include <linux/nfs_fs_i.h>
1048
Jeff Layton1cb36012013-06-21 08:58:12 -04001049/*
1050 * struct file_lock represents a generic "file lock". It's used to represent
1051 * POSIX byte range locks, BSD (flock) locks, and leases. It's important to
1052 * note that the same struct is used to represent both a request for a lock and
1053 * the lock itself, but the same object is never used for both.
1054 *
1055 * FIXME: should we create a separate "struct lock_request" to help distinguish
1056 * these two uses?
1057 *
Jeff Layton8116bf42015-01-21 20:44:01 -05001058 * The varous i_flctx lists are ordered by:
Jeff Layton1cb36012013-06-21 08:58:12 -04001059 *
Jeff Layton8116bf42015-01-21 20:44:01 -05001060 * 1) lock owner
1061 * 2) lock range start
1062 * 3) lock range end
Jeff Layton1cb36012013-06-21 08:58:12 -04001063 *
1064 * Obviously, the last two criteria only matter for POSIX locks.
1065 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066struct file_lock {
NeilBrownada5c1d2018-11-30 10:04:08 +11001067 struct file_lock *fl_blocker; /* The lock, that is blocking us */
Jeff Layton6dee60f2015-01-16 15:05:54 -05001068 struct list_head fl_list; /* link into file_lock_context */
Jeff Layton139ca042013-06-21 08:58:17 -04001069 struct hlist_node fl_link; /* node in global lists */
NeilBrownada5c1d2018-11-30 10:04:08 +11001070 struct list_head fl_blocked_requests; /* list of requests with
1071 * ->fl_blocker pointing here
1072 */
1073 struct list_head fl_blocked_member; /* node in
1074 * ->fl_blocker->fl_blocked_requests
1075 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076 fl_owner_t fl_owner;
J. Bruce Fields710b7212011-07-26 16:28:29 -04001077 unsigned int fl_flags;
Richard Kennedyafc12462008-07-11 17:20:49 -07001078 unsigned char fl_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079 unsigned int fl_pid;
Jeff Layton7012b022013-06-21 08:58:22 -04001080 int fl_link_cpu; /* what cpu's list is this on? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081 wait_queue_head_t fl_wait;
1082 struct file *fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083 loff_t fl_start;
1084 loff_t fl_end;
1085
1086 struct fasync_struct * fl_fasync; /* for lease break notifications */
J. Bruce Fields778fc542011-07-26 18:25:49 -04001087 /* for lease breaks: */
1088 unsigned long fl_break_time;
1089 unsigned long fl_downgrade_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090
Alexey Dobriyan6aed6282009-09-21 17:01:11 -07001091 const struct file_lock_operations *fl_ops; /* Callbacks for filesystems */
Alexey Dobriyan7b021962009-09-21 17:01:12 -07001092 const struct lock_manager_operations *fl_lmops; /* Callbacks for lockmanagers */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093 union {
1094 struct nfs_lock_info nfs_fl;
Trond Myklebust8d0a8a92005-06-22 17:16:32 +00001095 struct nfs4_lock_info nfs4_fl;
David Howellse8d6c552007-07-15 23:40:12 -07001096 struct {
1097 struct list_head link; /* link in AFS vnode's pending_locks list */
1098 int state; /* state of grant or error if -ve */
David Howellsd4696602019-04-25 14:26:50 +01001099 unsigned int debug_id;
David Howellse8d6c552007-07-15 23:40:12 -07001100 } afs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101 } fl_u;
Kees Cook3859a272016-10-28 01:22:25 -07001102} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103
Jeff Layton4a075e32015-01-16 15:05:54 -05001104struct file_lock_context {
Jeff Layton6109c852015-01-16 15:05:57 -05001105 spinlock_t flc_lock;
Jeff Layton4a075e32015-01-16 15:05:54 -05001106 struct list_head flc_flock;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001107 struct list_head flc_posix;
Jeff Layton8634b512015-01-16 15:05:55 -05001108 struct list_head flc_lease;
Jeff Layton4a075e32015-01-16 15:05:54 -05001109};
1110
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111/* The following constant reflects the upper bound of the file/locking space */
1112#ifndef OFFSET_MAX
1113#define INT_LIMIT(x) (~((x)1 << (sizeof(x)*8 - 1)))
1114#define OFFSET_MAX INT_LIMIT(loff_t)
1115#define OFFT_OFFSET_MAX INT_LIMIT(off_t)
1116#endif
1117
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001118extern void send_sigio(struct fown_struct *fown, int fd, int band);
1119
Miklos Szeredide2a4a52018-07-18 15:44:43 +02001120#define locks_inode(f) file_inode(f)
Miklos Szeredic568d682016-09-16 12:44:20 +02001121
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001122#ifdef CONFIG_FILE_LOCKING
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04001123extern int fcntl_getlk(struct file *, unsigned int, struct flock *);
Peter Staubachc2936212005-07-27 11:45:09 -07001124extern int fcntl_setlk(unsigned int, struct file *, unsigned int,
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04001125 struct flock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126
1127#if BITS_PER_LONG == 32
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04001128extern int fcntl_getlk64(struct file *, unsigned int, struct flock64 *);
Peter Staubachc2936212005-07-27 11:45:09 -07001129extern int fcntl_setlk64(unsigned int, struct file *, unsigned int,
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04001130 struct flock64 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001131#endif
1132
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133extern int fcntl_setlease(unsigned int fd, struct file *filp, long arg);
1134extern int fcntl_getlease(struct file *filp);
1135
1136/* fs/locks.c */
Jeff Laytonf27a0fe2016-01-07 15:08:51 -05001137void locks_free_lock_context(struct inode *inode);
J. Bruce Fields05fa3132010-10-30 17:31:15 -04001138void locks_free_lock(struct file_lock *fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139extern void locks_init_lock(struct file_lock *);
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001140extern struct file_lock * locks_alloc_lock(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141extern void locks_copy_lock(struct file_lock *, struct file_lock *);
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001142extern void locks_copy_conflock(struct file_lock *, struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143extern void locks_remove_posix(struct file *, fl_owner_t);
Jeff Layton78ed8a12014-02-03 12:13:08 -05001144extern void locks_remove_file(struct file *);
Felix Blyakhera9e61e22009-03-31 15:12:56 -05001145extern void locks_release_private(struct file_lock *);
J. Bruce Fields6d34ac12007-05-11 16:09:32 -04001146extern void posix_test_lock(struct file *, struct file_lock *);
Marc Eshel150b3932007-01-18 16:15:35 -05001147extern int posix_lock_file(struct file *, struct file_lock *, struct file_lock *);
NeilBrowncb03f942018-11-30 10:04:08 +11001148extern int locks_delete_block(struct file_lock *);
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001149extern int vfs_test_lock(struct file *, struct file_lock *);
Marc Eshel150b3932007-01-18 16:15:35 -05001150extern int vfs_lock_file(struct file *, unsigned int, struct file_lock *, struct file_lock *);
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05001151extern int vfs_cancel_lock(struct file *filp, struct file_lock *fl);
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001152extern int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001153extern int __break_lease(struct inode *inode, unsigned int flags, unsigned int type);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001154extern void lease_get_mtime(struct inode *, struct timespec64 *time);
Jeff Laytone6f5c782014-08-22 10:40:25 -04001155extern int generic_setlease(struct file *, long, struct file_lock **, void **priv);
1156extern int vfs_setlease(struct file *, long, struct file_lock **, void **);
Jeff Layton7448cc32015-01-16 15:05:57 -05001157extern int lease_modify(struct file_lock *, int, struct list_head *);
Andrey Vagin6c8c9032015-04-16 12:49:38 -07001158struct files_struct;
1159extern void show_fd_locks(struct seq_file *f,
1160 struct file *filp, struct files_struct *files);
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001161#else /* !CONFIG_FILE_LOCKING */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001162static inline int fcntl_getlk(struct file *file, unsigned int cmd,
1163 struct flock __user *user)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001164{
1165 return -EINVAL;
1166}
1167
1168static inline int fcntl_setlk(unsigned int fd, struct file *file,
1169 unsigned int cmd, struct flock __user *user)
1170{
1171 return -EACCES;
1172}
1173
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001174#if BITS_PER_LONG == 32
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001175static inline int fcntl_getlk64(struct file *file, unsigned int cmd,
1176 struct flock64 __user *user)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001177{
1178 return -EINVAL;
1179}
1180
1181static inline int fcntl_setlk64(unsigned int fd, struct file *file,
1182 unsigned int cmd, struct flock64 __user *user)
1183{
1184 return -EACCES;
1185}
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001186#endif
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001187static inline int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1188{
Jeff Layton1b2b32d2014-09-24 08:38:44 -04001189 return -EINVAL;
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001190}
1191
1192static inline int fcntl_getlease(struct file *filp)
1193{
Jeff Layton1b2b32d2014-09-24 08:38:44 -04001194 return F_UNLCK;
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001195}
1196
Jeff Layton4a075e32015-01-16 15:05:54 -05001197static inline void
Jeff Laytonf27a0fe2016-01-07 15:08:51 -05001198locks_free_lock_context(struct inode *inode)
Jeff Layton4a075e32015-01-16 15:05:54 -05001199{
1200}
1201
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001202static inline void locks_init_lock(struct file_lock *fl)
1203{
1204 return;
1205}
1206
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001207static inline void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001208{
1209 return;
1210}
1211
1212static inline void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
1213{
1214 return;
1215}
1216
1217static inline void locks_remove_posix(struct file *filp, fl_owner_t owner)
1218{
1219 return;
1220}
1221
Jeff Layton78ed8a12014-02-03 12:13:08 -05001222static inline void locks_remove_file(struct file *filp)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001223{
1224 return;
1225}
1226
1227static inline void posix_test_lock(struct file *filp, struct file_lock *fl)
1228{
1229 return;
1230}
1231
1232static inline int posix_lock_file(struct file *filp, struct file_lock *fl,
1233 struct file_lock *conflock)
1234{
1235 return -ENOLCK;
1236}
1237
NeilBrowncb03f942018-11-30 10:04:08 +11001238static inline int locks_delete_block(struct file_lock *waiter)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001239{
1240 return -ENOENT;
1241}
1242
1243static inline int vfs_test_lock(struct file *filp, struct file_lock *fl)
1244{
1245 return 0;
1246}
1247
1248static inline int vfs_lock_file(struct file *filp, unsigned int cmd,
1249 struct file_lock *fl, struct file_lock *conf)
1250{
1251 return -ENOLCK;
1252}
1253
1254static inline int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
1255{
1256 return 0;
1257}
1258
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001259static inline int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
1260{
1261 return -ENOLCK;
1262}
1263
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001264static inline int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001265{
1266 return 0;
1267}
1268
Deepa Dinamani95582b02018-05-08 19:36:02 -07001269static inline void lease_get_mtime(struct inode *inode,
1270 struct timespec64 *time)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001271{
1272 return;
1273}
1274
1275static inline int generic_setlease(struct file *filp, long arg,
Jeff Laytone6f5c782014-08-22 10:40:25 -04001276 struct file_lock **flp, void **priv)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001277{
1278 return -EINVAL;
1279}
1280
1281static inline int vfs_setlease(struct file *filp, long arg,
Jeff Laytone6f5c782014-08-22 10:40:25 -04001282 struct file_lock **lease, void **priv)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001283{
1284 return -EINVAL;
1285}
1286
Jeff Layton7448cc32015-01-16 15:05:57 -05001287static inline int lease_modify(struct file_lock *fl, int arg,
Jeff Laytonc45198e2014-09-01 07:12:07 -04001288 struct list_head *dispose)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001289{
1290 return -EINVAL;
1291}
Andrey Vagin6c8c9032015-04-16 12:49:38 -07001292
1293struct files_struct;
1294static inline void show_fd_locks(struct seq_file *f,
1295 struct file *filp, struct files_struct *files) {}
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001296#endif /* !CONFIG_FILE_LOCKING */
1297
Jeff Laytonee296d72015-07-11 06:43:03 -04001298static inline struct inode *file_inode(const struct file *f)
1299{
1300 return f->f_inode;
1301}
1302
Miklos Szeredid101a122016-03-26 16:14:37 -04001303static inline struct dentry *file_dentry(const struct file *file)
1304{
Miklos Szeredifb160432018-07-18 15:44:44 +02001305 return d_real(file->f_path.dentry, file_inode(file));
Miklos Szeredid101a122016-03-26 16:14:37 -04001306}
1307
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001308static inline int locks_lock_file_wait(struct file *filp, struct file_lock *fl)
1309{
Miklos Szeredic568d682016-09-16 12:44:20 +02001310 return locks_lock_inode_wait(locks_inode(filp), fl);
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001311}
1312
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313struct fasync_struct {
Kirill Tkhai7a107c02018-04-05 14:58:06 +03001314 rwlock_t fa_lock;
Eric Dumazet989a2972010-04-14 09:55:35 +00001315 int magic;
1316 int fa_fd;
1317 struct fasync_struct *fa_next; /* singly linked list */
1318 struct file *fa_file;
1319 struct rcu_head fa_rcu;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320};
1321
1322#define FASYNC_MAGIC 0x4601
1323
1324/* SMP safe fasync helpers: */
1325extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001326extern struct fasync_struct *fasync_insert_entry(int, struct file *, struct fasync_struct **, struct fasync_struct *);
1327extern int fasync_remove_entry(struct file *, struct fasync_struct **);
1328extern struct fasync_struct *fasync_alloc(void);
1329extern void fasync_free(struct fasync_struct *);
1330
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331/* can be called from interrupts */
1332extern void kill_fasync(struct fasync_struct **, int, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333
Jeff Laytone0b93ed2014-08-22 11:27:32 -04001334extern void __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
Jiri Slaby393cc3f2017-06-13 13:35:50 +02001335extern int f_setown(struct file *filp, unsigned long arg, int force);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336extern void f_delown(struct file *filp);
Eric W. Biederman609d7fa2006-10-02 02:17:15 -07001337extern pid_t f_getown(struct file *filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338extern int send_sigurg(struct fown_struct *fown);
1339
1340/*
David Howellse462ec52017-07-17 08:45:35 +01001341 * sb->s_flags. Note that these mirror the equivalent MS_* flags where
1342 * represented in both.
1343 */
1344#define SB_RDONLY 1 /* Mount read-only */
1345#define SB_NOSUID 2 /* Ignore suid and sgid bits */
1346#define SB_NODEV 4 /* Disallow access to device special files */
1347#define SB_NOEXEC 8 /* Disallow program execution */
1348#define SB_SYNCHRONOUS 16 /* Writes are synced at once */
1349#define SB_MANDLOCK 64 /* Allow mandatory locks on an FS */
1350#define SB_DIRSYNC 128 /* Directory modifications are synchronous */
1351#define SB_NOATIME 1024 /* Do not update access times. */
1352#define SB_NODIRATIME 2048 /* Do not update directory access times */
1353#define SB_SILENT 32768
1354#define SB_POSIXACL (1<<16) /* VFS does not apply the umask */
1355#define SB_KERNMOUNT (1<<22) /* this is a kern_mount call */
1356#define SB_I_VERSION (1<<23) /* Update inode I_version field */
1357#define SB_LAZYTIME (1<<25) /* Update the on-disk [acm]times lazily */
1358
1359/* These sb flags are internal to the kernel */
1360#define SB_SUBMOUNT (1<<26)
David Howells8d0347f2018-11-04 09:28:36 -05001361#define SB_FORCE (1<<27)
David Howellse462ec52017-07-17 08:45:35 +01001362#define SB_NOSEC (1<<28)
1363#define SB_BORN (1<<29)
1364#define SB_ACTIVE (1<<30)
1365#define SB_NOUSER (1<<31)
1366
1367/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368 * Umount options
1369 */
1370
1371#define MNT_FORCE 0x00000001 /* Attempt to forcibily umount */
1372#define MNT_DETACH 0x00000002 /* Just detach from the tree */
1373#define MNT_EXPIRE 0x00000004 /* Mark for expiry */
Miklos Szeredidb1f05b2010-02-10 12:15:53 +01001374#define UMOUNT_NOFOLLOW 0x00000008 /* Don't follow symlink on umount */
1375#define UMOUNT_UNUSED 0x80000000 /* Flag guaranteed to be unused */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376
Tejun Heo46b15ca2015-06-16 18:48:31 -04001377/* sb->s_iflags */
1378#define SB_I_CGROUPWB 0x00000001 /* cgroup-aware writeback enabled */
Eric W. Biederman90f85722015-06-29 14:42:03 -05001379#define SB_I_NOEXEC 0x00000002 /* Ignore executables on this fs */
Eric W. Biedermana2982cc2016-06-09 15:34:02 -05001380#define SB_I_NODEV 0x00000004 /* Ignore devices on this fs */
Eric W. Biederman95dd7752018-03-14 18:20:29 -05001381#define SB_I_MULTIROOT 0x00000008 /* Multiple roots to the dentry tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382
Eric W. Biederman8654df42016-06-09 16:06:06 -05001383/* sb->s_iflags to limit user namespace mounts */
1384#define SB_I_USERNS_VISIBLE 0x00000010 /* fstype already mounted */
Mimi Zohar57b56ac2018-02-21 11:33:37 -05001385#define SB_I_IMA_UNVERIFIABLE_SIGNATURE 0x00000020
1386#define SB_I_UNTRUSTED_MOUNTER 0x00000040
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387
Jan Kara5accdf82012-06-12 16:20:34 +02001388/* Possible states of 'frozen' field */
1389enum {
1390 SB_UNFROZEN = 0, /* FS is unfrozen */
1391 SB_FREEZE_WRITE = 1, /* Writes, dir ops, ioctls frozen */
Jan Kara5accdf82012-06-12 16:20:34 +02001392 SB_FREEZE_PAGEFAULT = 2, /* Page faults stopped as well */
1393 SB_FREEZE_FS = 3, /* For internal FS use (e.g. to stop
1394 * internal threads if needed) */
1395 SB_FREEZE_COMPLETE = 4, /* ->freeze_fs finished successfully */
1396};
1397
1398#define SB_FREEZE_LEVELS (SB_FREEZE_COMPLETE - 1)
1399
1400struct sb_writers {
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001401 int frozen; /* Is sb frozen? */
1402 wait_queue_head_t wait_unfrozen; /* for get_super_thawed() */
1403 struct percpu_rw_semaphore rw_sem[SB_FREEZE_LEVELS];
Jan Kara5accdf82012-06-12 16:20:34 +02001404};
1405
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406struct super_block {
1407 struct list_head s_list; /* Keep this first */
1408 dev_t s_dev; /* search index; _not_ kdev_t */
Richard Kennedy270ba5f2010-01-26 14:12:43 +00001409 unsigned char s_blocksize_bits;
1410 unsigned long s_blocksize;
Jeff Layton42cb56a2009-09-18 13:05:53 -07001411 loff_t s_maxbytes; /* Max file size */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412 struct file_system_type *s_type;
Josef 'Jeff' Sipekee9b6d62007-02-12 00:55:41 -08001413 const struct super_operations *s_op;
Alexey Dobriyan61e225d2009-09-21 17:01:08 -07001414 const struct dquot_operations *dq_op;
Alexey Dobriyan0d54b212009-09-21 17:01:09 -07001415 const struct quotactl_ops *s_qcop;
Christoph Hellwig39655162007-10-21 16:42:17 -07001416 const struct export_operations *s_export_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417 unsigned long s_flags;
Tejun Heo46b15ca2015-06-16 18:48:31 -04001418 unsigned long s_iflags; /* internal SB_I_* flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419 unsigned long s_magic;
1420 struct dentry *s_root;
1421 struct rw_semaphore s_umount;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 int s_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423 atomic_t s_active;
Alexey Dobriyan50462062006-09-29 02:00:01 -07001424#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425 void *s_security;
Alexey Dobriyan50462062006-09-29 02:00:01 -07001426#endif
Stephen Hemmingerbb435452010-05-13 17:53:14 -07001427 const struct xattr_handler **s_xattr;
Chandan Rajendra643fa962018-12-12 15:20:12 +05301428#ifdef CONFIG_FS_ENCRYPTION
Jaegeuk Kim0b81d072015-05-15 16:26:10 -07001429 const struct fscrypt_operations *s_cop;
Eric Biggersbbbc3fb2018-04-30 15:51:35 -07001430#endif
NeilBrownf1ee6162017-12-21 09:45:40 +11001431 struct hlist_bl_head s_roots; /* alternate root dentries for NFS */
Miklos Szeredi39f7c4d2011-11-21 12:11:30 +01001432 struct list_head s_mounts; /* list of mounts; _not_ for fs use */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433 struct block_device *s_bdev;
Jens Axboe32a88aa2009-09-16 15:02:33 +02001434 struct backing_dev_info *s_bdi;
David Howellsacaebfd2007-05-10 22:51:50 -07001435 struct mtd_info *s_mtd;
Al Viroa5166162011-12-12 22:53:00 -05001436 struct hlist_node s_instances;
Jan Kara2c5f6482014-09-30 10:43:09 +02001437 unsigned int s_quota_types; /* Bitmask of supported quota types */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438 struct quota_info s_dquot; /* Diskquota specific options */
1439
Jan Kara5accdf82012-06-12 16:20:34 +02001440 struct sb_writers s_writers;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441
Amir Goldstein99c228a2018-10-18 14:22:55 +03001442 /*
1443 * Keep s_fs_info, s_time_gran, s_fsnotify_mask, and
1444 * s_fsnotify_marks together for cache efficiency. They are frequently
1445 * accessed and rarely modified.
1446 */
1447 void *s_fs_info; /* Filesystem private info */
1448
1449 /* Granularity of c/m/atime in ns (cannot be worse than a second) */
1450 u32 s_time_gran;
1451#ifdef CONFIG_FSNOTIFY
1452 __u32 s_fsnotify_mask;
1453 struct fsnotify_mark_connector __rcu *s_fsnotify_marks;
1454#endif
1455
Christoph Hellwig85787092017-05-10 15:06:33 +02001456 char s_id[32]; /* Informational name */
1457 uuid_t s_uuid; /* UUID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458
Al Viro8de52772012-02-06 12:45:27 -05001459 unsigned int s_max_links;
Al Viro30c40d22008-02-22 19:50:45 -05001460 fmode_t s_mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461
1462 /*
1463 * The next field is for VFS *only*. No filesystems have any business
1464 * even looking at it. You had been warned.
1465 */
Arjan van de Vena11f3a02006-03-23 03:00:33 -08001466 struct mutex s_vfs_rename_mutex; /* Kludge */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467
Miklos Szeredi79c0b2d2007-05-08 00:25:43 -07001468 /*
1469 * Filesystem subtype. If non-empty the filesystem type field
1470 * in /proc/mounts will be "type.subtype"
1471 */
Al Viroa0c9a8b2018-11-04 07:18:51 -05001472 const char *s_subtype;
Miklos Szeredib3b304a2008-02-08 04:21:35 -08001473
Al Viroc8aebb02010-12-18 10:22:30 -05001474 const struct dentry_operations *s_d_op; /* default d_op for dentries */
Dan Magenheimer9fdfdcf2011-05-26 10:01:19 -06001475
1476 /*
1477 * Saved pool identifier for cleancache (-1 means none)
1478 */
1479 int cleancache_poolid;
Dave Chinnerb0d40c92011-07-08 14:14:42 +10001480
1481 struct shrinker s_shrink; /* per-sb shrinker handle */
Miklos Szeredi4ed5e82f2011-11-21 12:11:31 +01001482
Miklos Szeredi7ada4db2011-11-21 12:11:32 +01001483 /* Number of inodes with nlink == 0 but still referenced */
1484 atomic_long_t s_remove_count;
1485
Jan Kara721fb6f2018-10-17 13:07:05 +02001486 /* Pending fsnotify inode refs */
1487 atomic_long_t s_fsnotify_inode_refs;
1488
Miklos Szeredi4ed5e82f2011-11-21 12:11:31 +01001489 /* Being remounted read-only */
1490 int s_readonly_remount;
Christoph Hellwig7b7a8662013-09-04 15:04:39 +02001491
1492 /* AIO completions deferred from interrupt context */
1493 struct workqueue_struct *s_dio_done_wq;
Al Viro215752f2014-08-07 06:23:41 -04001494 struct hlist_head s_pins;
Dave Chinnerf6041562013-08-28 10:18:00 +10001495
1496 /*
Eric W. Biederman6e4eab52016-05-24 09:29:01 -05001497 * Owning user namespace and default context in which to
1498 * interpret filesystem uids, gids, quotas, device nodes,
1499 * xattrs and security labels.
1500 */
1501 struct user_namespace *s_user_ns;
1502
1503 /*
Waiman Long7d10f702019-01-30 13:52:37 -05001504 * The list_lru structure is essentially just a pointer to a table
1505 * of per-node lru lists, each of which has its own spinlock.
1506 * There is no need to put them into separate cachelines.
Dave Chinnerf6041562013-08-28 10:18:00 +10001507 */
Waiman Long7d10f702019-01-30 13:52:37 -05001508 struct list_lru s_dentry_lru;
1509 struct list_lru s_inode_lru;
Al Viroe2fec7c2013-10-04 17:06:56 -04001510 struct rcu_head rcu;
Oleg Nesterov853b39a2015-07-22 20:21:13 +02001511 struct work_struct destroy_work;
Miklos Szeredi69c433e2014-10-24 00:14:39 +02001512
Dave Chinnere97fedb2015-03-04 13:40:00 -05001513 struct mutex s_sync_lock; /* sync serialisation lock */
Miklos Szeredi69c433e2014-10-24 00:14:39 +02001514
1515 /*
1516 * Indicates how deep in a filesystem stack this SB is
1517 */
1518 int s_stack_depth;
Dave Chinner74278da2015-03-04 12:37:22 -05001519
1520 /* s_inode_list_lock protects s_inodes */
1521 spinlock_t s_inode_list_lock ____cacheline_aligned_in_smp;
1522 struct list_head s_inodes; /* all inodes */
Dave Chinner6c60d2b2016-07-26 15:21:50 -07001523
1524 spinlock_t s_inode_wblist_lock;
1525 struct list_head s_inodes_wb; /* writeback inodes */
Kees Cook3859a272016-10-28 01:22:25 -07001526} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527
Seth Forshee81754352014-12-11 10:15:45 -06001528/* Helper functions so that in most cases filesystems will
1529 * not need to deal directly with kuid_t and kgid_t and can
1530 * instead deal with the raw numeric values that are stored
1531 * in the filesystem.
1532 */
1533static inline uid_t i_uid_read(const struct inode *inode)
1534{
1535 return from_kuid(inode->i_sb->s_user_ns, inode->i_uid);
1536}
1537
1538static inline gid_t i_gid_read(const struct inode *inode)
1539{
1540 return from_kgid(inode->i_sb->s_user_ns, inode->i_gid);
1541}
1542
1543static inline void i_uid_write(struct inode *inode, uid_t uid)
1544{
1545 inode->i_uid = make_kuid(inode->i_sb->s_user_ns, uid);
1546}
1547
1548static inline void i_gid_write(struct inode *inode, gid_t gid)
1549{
1550 inode->i_gid = make_kgid(inode->i_sb->s_user_ns, gid);
1551}
1552
Deepa Dinamani8efd6892018-04-22 20:18:46 -07001553extern struct timespec64 timespec64_trunc(struct timespec64 t, unsigned gran);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001554extern struct timespec64 current_time(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555
1556/*
1557 * Snapshotting support.
1558 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559
Jan Kara5accdf82012-06-12 16:20:34 +02001560void __sb_end_write(struct super_block *sb, int level);
1561int __sb_start_write(struct super_block *sb, int level, bool wait);
1562
Oleg Nesterovbee91822015-07-19 23:48:20 +02001563#define __sb_writers_acquired(sb, lev) \
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001564 percpu_rwsem_acquire(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
Oleg Nesterovbee91822015-07-19 23:48:20 +02001565#define __sb_writers_release(sb, lev) \
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001566 percpu_rwsem_release(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
Oleg Nesterovbee91822015-07-19 23:48:20 +02001567
Jan Kara5accdf82012-06-12 16:20:34 +02001568/**
1569 * sb_end_write - drop write access to a superblock
1570 * @sb: the super we wrote to
1571 *
1572 * Decrement number of writers to the filesystem. Wake up possible waiters
1573 * wanting to freeze the filesystem.
1574 */
1575static inline void sb_end_write(struct super_block *sb)
1576{
1577 __sb_end_write(sb, SB_FREEZE_WRITE);
1578}
1579
1580/**
1581 * sb_end_pagefault - drop write access to a superblock from a page fault
1582 * @sb: the super we wrote to
1583 *
1584 * Decrement number of processes handling write page fault to the filesystem.
1585 * Wake up possible waiters wanting to freeze the filesystem.
1586 */
1587static inline void sb_end_pagefault(struct super_block *sb)
1588{
1589 __sb_end_write(sb, SB_FREEZE_PAGEFAULT);
1590}
1591
1592/**
1593 * sb_end_intwrite - drop write access to a superblock for internal fs purposes
1594 * @sb: the super we wrote to
1595 *
1596 * Decrement fs-internal number of writers to the filesystem. Wake up possible
1597 * waiters wanting to freeze the filesystem.
1598 */
1599static inline void sb_end_intwrite(struct super_block *sb)
1600{
1601 __sb_end_write(sb, SB_FREEZE_FS);
1602}
1603
1604/**
1605 * sb_start_write - get write access to a superblock
1606 * @sb: the super we write to
1607 *
1608 * When a process wants to write data or metadata to a file system (i.e. dirty
1609 * a page or an inode), it should embed the operation in a sb_start_write() -
1610 * sb_end_write() pair to get exclusion against file system freezing. This
1611 * function increments number of writers preventing freezing. If the file
1612 * system is already frozen, the function waits until the file system is
1613 * thawed.
1614 *
1615 * Since freeze protection behaves as a lock, users have to preserve
1616 * ordering of freeze protection and other filesystem locks. Generally,
1617 * freeze protection should be the outermost lock. In particular, we have:
1618 *
1619 * sb_start_write
1620 * -> i_mutex (write path, truncate, directory ops, ...)
1621 * -> s_umount (freeze_super, thaw_super)
1622 */
1623static inline void sb_start_write(struct super_block *sb)
1624{
1625 __sb_start_write(sb, SB_FREEZE_WRITE, true);
1626}
1627
1628static inline int sb_start_write_trylock(struct super_block *sb)
1629{
1630 return __sb_start_write(sb, SB_FREEZE_WRITE, false);
1631}
1632
1633/**
1634 * sb_start_pagefault - get write access to a superblock from a page fault
1635 * @sb: the super we write to
1636 *
1637 * When a process starts handling write page fault, it should embed the
1638 * operation into sb_start_pagefault() - sb_end_pagefault() pair to get
1639 * exclusion against file system freezing. This is needed since the page fault
1640 * is going to dirty a page. This function increments number of running page
1641 * faults preventing freezing. If the file system is already frozen, the
1642 * function waits until the file system is thawed.
1643 *
1644 * Since page fault freeze protection behaves as a lock, users have to preserve
1645 * ordering of freeze protection and other filesystem locks. It is advised to
1646 * put sb_start_pagefault() close to mmap_sem in lock ordering. Page fault
1647 * handling code implies lock dependency:
1648 *
1649 * mmap_sem
1650 * -> sb_start_pagefault
1651 */
1652static inline void sb_start_pagefault(struct super_block *sb)
1653{
1654 __sb_start_write(sb, SB_FREEZE_PAGEFAULT, true);
1655}
1656
1657/*
1658 * sb_start_intwrite - get write access to a superblock for internal fs purposes
1659 * @sb: the super we write to
1660 *
1661 * This is the third level of protection against filesystem freezing. It is
1662 * free for use by a filesystem. The only requirement is that it must rank
1663 * below sb_start_pagefault.
1664 *
1665 * For example filesystem can call sb_start_intwrite() when starting a
1666 * transaction which somewhat eases handling of freezing for internal sources
1667 * of filesystem changes (internal fs threads, discarding preallocation on file
1668 * close, etc.).
1669 */
1670static inline void sb_start_intwrite(struct super_block *sb)
1671{
1672 __sb_start_write(sb, SB_FREEZE_FS, true);
1673}
1674
Amir Goldstein0c8e3fe2018-05-13 22:40:30 -04001675static inline int sb_start_intwrite_trylock(struct super_block *sb)
1676{
1677 return __sb_start_write(sb, SB_FREEZE_FS, false);
1678}
1679
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680
Serge E. Hallyn2e149672011-03-23 16:43:26 -07001681extern bool inode_owner_or_capable(const struct inode *inode);
Satyam Sharma3bd858a2007-07-17 15:00:08 +05301682
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683/*
1684 * VFS helper functions..
1685 */
Al Viro312b63f2012-06-10 18:09:36 -04001686extern int vfs_create(struct inode *, struct dentry *, umode_t, bool);
Al Viro18bb1db2011-07-26 01:41:39 -04001687extern int vfs_mkdir(struct inode *, struct dentry *, umode_t);
Al Viro1a67aaf2011-07-26 01:52:52 -04001688extern int vfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
Miklos Szeredidb2e7472008-06-24 16:50:16 +02001689extern int vfs_symlink(struct inode *, struct dentry *, const char *);
J. Bruce Fields146a8592011-09-20 17:14:31 -04001690extern int vfs_link(struct dentry *, struct inode *, struct dentry *, struct inode **);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691extern int vfs_rmdir(struct inode *, struct dentry *);
J. Bruce Fieldsb21996e2011-09-20 09:14:34 -04001692extern int vfs_unlink(struct inode *, struct dentry *, struct inode **);
Miklos Szeredi520c8b12014-04-01 17:08:42 +02001693extern int vfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *, struct inode **, unsigned int);
Miklos Szeredi787fb6b2014-10-24 00:14:36 +02001694extern int vfs_whiteout(struct inode *, struct dentry *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695
Amir Goldsteinaf7bd4d2017-01-17 06:34:52 +02001696extern struct dentry *vfs_tmpfile(struct dentry *dentry, umode_t mode,
1697 int open_flag);
1698
Al Viro8e6c8482017-12-01 17:12:45 -05001699int vfs_mkobj(struct dentry *, umode_t,
1700 int (*f)(struct dentry *, umode_t, void *),
1701 void *);
1702
Miklos Szeredi9df67022018-07-18 15:44:40 +02001703extern long vfs_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
1704
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705/*
Christoph Hellwig8c744fb2005-11-08 21:35:04 -08001706 * VFS file helper functions.
1707 */
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03001708extern void inode_init_owner(struct inode *inode, const struct inode *dir,
Al Viro62bb1092011-07-24 23:20:18 -04001709 umode_t mode);
Eric W. Biedermana2982cc2016-06-09 15:34:02 -05001710extern bool may_open_dev(const struct path *path);
Christoph Hellwig8c744fb2005-11-08 21:35:04 -08001711/*
Mark Fashehc4b929b2008-10-08 19:44:18 -04001712 * VFS FS_IOC_FIEMAP helper definitions.
1713 */
1714struct fiemap_extent_info {
1715 unsigned int fi_flags; /* Flags as passed from user */
1716 unsigned int fi_extents_mapped; /* Number of mapped extents */
1717 unsigned int fi_extents_max; /* Size of fiemap_extent array */
Namhyung Kimecf56322011-01-16 23:28:17 +09001718 struct fiemap_extent __user *fi_extents_start; /* Start of
1719 fiemap_extent array */
Mark Fashehc4b929b2008-10-08 19:44:18 -04001720};
1721int fiemap_fill_next_extent(struct fiemap_extent_info *info, u64 logical,
1722 u64 phys, u64 len, u32 flags);
1723int fiemap_check_flags(struct fiemap_extent_info *fieinfo, u32 fs_flags);
1724
1725/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001726 * This is the "filldir" function type, used by readdir() to let
1727 * the kernel specify what kind of dirent layout it wants to have.
1728 * This allows the kernel to read directories into kernel space or
1729 * to have different dirent layouts depending on the binary type.
1730 */
Miklos Szerediac7576f2014-10-30 17:37:34 +01001731struct dir_context;
1732typedef int (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64,
1733 unsigned);
1734
Al Viro5c0ba4e2013-05-15 13:52:59 -04001735struct dir_context {
David Howellsa09acf42018-04-09 21:12:30 +01001736 filldir_t actor;
Al Virobb6f6192013-05-15 18:49:12 -04001737 loff_t pos;
Al Viro5c0ba4e2013-05-15 13:52:59 -04001738};
Al Virobb6f6192013-05-15 18:49:12 -04001739
Al Viro08f85852007-10-08 13:26:20 -04001740struct block_device_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741
Linus Torvalds1da177e2005-04-16 15:20:36 -07001742/* These macros are for out of kernel modules to test that
1743 * the kernel supports the unlocked_ioctl and compat_ioctl
1744 * fields in struct file_operations. */
1745#define HAVE_COMPAT_IOCTL 1
1746#define HAVE_UNLOCKED_IOCTL 1
1747
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01001748/*
1749 * These flags let !MMU mmap() govern direct device mapping vs immediate
1750 * copying more easily for MAP_PRIVATE, especially for ROM filesystems.
1751 *
1752 * NOMMU_MAP_COPY: Copy can be mapped (MAP_PRIVATE)
1753 * NOMMU_MAP_DIRECT: Can be mapped directly (MAP_SHARED)
1754 * NOMMU_MAP_READ: Can be mapped for reading
1755 * NOMMU_MAP_WRITE: Can be mapped for writing
1756 * NOMMU_MAP_EXEC: Can be mapped for execution
1757 */
1758#define NOMMU_MAP_COPY 0x00000001
1759#define NOMMU_MAP_DIRECT 0x00000008
1760#define NOMMU_MAP_READ VM_MAYREAD
1761#define NOMMU_MAP_WRITE VM_MAYWRITE
1762#define NOMMU_MAP_EXEC VM_MAYEXEC
1763
1764#define NOMMU_VMFLAGS \
1765 (NOMMU_MAP_READ | NOMMU_MAP_WRITE | NOMMU_MAP_EXEC)
1766
Darrick J. Wong2e5dfc92018-10-30 10:41:21 +11001767/*
1768 * These flags control the behavior of the remap_file_range function pointer.
1769 * If it is called with len == 0 that means "remap to end of source file".
Mauro Carvalho Chehab5c437fa2019-06-07 15:54:35 -03001770 * See Documentation/filesystems/vfs.rst for more details about this call.
Darrick J. Wong2e5dfc92018-10-30 10:41:21 +11001771 *
1772 * REMAP_FILE_DEDUP: only remap if contents identical (i.e. deduplicate)
Darrick J. Wongeca36542018-10-30 10:42:10 +11001773 * REMAP_FILE_CAN_SHORTEN: caller can handle a shortened request
Darrick J. Wong2e5dfc92018-10-30 10:41:21 +11001774 */
1775#define REMAP_FILE_DEDUP (1 << 0)
Darrick J. Wongeca36542018-10-30 10:42:10 +11001776#define REMAP_FILE_CAN_SHORTEN (1 << 1)
Darrick J. Wong2e5dfc92018-10-30 10:41:21 +11001777
1778/*
1779 * These flags signal that the caller is ok with altering various aspects of
1780 * the behavior of the remap operation. The changes must be made by the
1781 * implementation; the vfs remap helper functions can take advantage of them.
1782 * Flags in this category exist to preserve the quirky behavior of the hoisted
1783 * btrfs clone/dedupe ioctls.
Darrick J. Wong2e5dfc92018-10-30 10:41:21 +11001784 */
Darrick J. Wongeca36542018-10-30 10:42:10 +11001785#define REMAP_FILE_ADVISORY (REMAP_FILE_CAN_SHORTEN)
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01001786
Al Viro293bc982014-02-11 18:37:41 -05001787struct iov_iter;
1788
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789struct file_operations {
1790 struct module *owner;
1791 loff_t (*llseek) (struct file *, loff_t, int);
1792 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
Al Viro293bc982014-02-11 18:37:41 -05001794 ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
1795 ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
Christoph Hellwigfb7e1602018-11-22 16:37:38 +01001796 int (*iopoll)(struct kiocb *kiocb, bool spin);
Al Virobb6f6192013-05-15 18:49:12 -04001797 int (*iterate) (struct file *, struct dir_context *);
Al Viro61922692016-04-20 23:08:32 -04001798 int (*iterate_shared) (struct file *, struct dir_context *);
Al Viroa3f86832017-07-02 22:22:01 -04001799 __poll_t (*poll) (struct file *, struct poll_table_struct *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
1801 long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
1802 int (*mmap) (struct file *, struct vm_area_struct *);
Dan Williams1c972592017-11-01 16:36:30 +01001803 unsigned long mmap_supported_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804 int (*open) (struct inode *, struct file *);
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07001805 int (*flush) (struct file *, fl_owner_t id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806 int (*release) (struct inode *, struct file *);
Josef Bacik02c24a82011-07-16 20:44:56 -04001807 int (*fsync) (struct file *, loff_t, loff_t, int datasync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808 int (*fasync) (int, struct file *, int);
1809 int (*lock) (struct file *, int, struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810 ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
1811 unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
1812 int (*check_flags)(int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813 int (*flock) (struct file *, int, struct file_lock *);
Jens Axboecbb7e572006-04-11 14:57:50 +02001814 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int);
1815 ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int);
Jeff Laytone6f5c782014-08-22 10:40:25 -04001816 int (*setlease)(struct file *, long, struct file_lock **, void **);
Christoph Hellwig2fe17c12011-01-14 13:07:43 +01001817 long (*fallocate)(struct file *file, int mode, loff_t offset,
1818 loff_t len);
Joe Perchesa3816ab2014-09-29 16:08:25 -07001819 void (*show_fdinfo)(struct seq_file *m, struct file *f);
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01001820#ifndef CONFIG_MMU
1821 unsigned (*mmap_capabilities)(struct file *);
1822#endif
Christoph Hellwig04b38d62015-12-03 12:59:50 +01001823 ssize_t (*copy_file_range)(struct file *, loff_t, struct file *,
1824 loff_t, size_t, unsigned int);
Darrick J. Wong42ec3d42018-10-30 10:41:49 +11001825 loff_t (*remap_file_range)(struct file *file_in, loff_t pos_in,
1826 struct file *file_out, loff_t pos_out,
1827 loff_t len, unsigned int remap_flags);
Amir Goldstein45cd0fa2018-08-27 15:56:02 +03001828 int (*fadvise)(struct file *, loff_t, loff_t, int);
Kees Cook3859a272016-10-28 01:22:25 -07001829} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830
1831struct inode_operations {
Al Viro00cd8dd2012-06-10 17:13:09 -04001832 struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
Al Virofceef392015-12-29 15:58:39 -05001833 const char * (*get_link) (struct dentry *, struct inode *, struct delayed_call *);
Al Viro10556cb2011-06-20 19:28:19 -04001834 int (*permission) (struct inode *, int);
Christoph Hellwig4e34e712011-07-23 17:37:31 +02001835 struct posix_acl * (*get_acl)(struct inode *, int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001836
1837 int (*readlink) (struct dentry *, char __user *,int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001838
Al Viroebfc3b42012-06-10 18:05:36 -04001839 int (*create) (struct inode *,struct dentry *, umode_t, bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840 int (*link) (struct dentry *,struct inode *,struct dentry *);
1841 int (*unlink) (struct inode *,struct dentry *);
1842 int (*symlink) (struct inode *,struct dentry *,const char *);
Al Viro18bb1db2011-07-26 01:41:39 -04001843 int (*mkdir) (struct inode *,struct dentry *,umode_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844 int (*rmdir) (struct inode *,struct dentry *);
Al Viro1a67aaf2011-07-26 01:52:52 -04001845 int (*mknod) (struct inode *,struct dentry *,umode_t,dev_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001846 int (*rename) (struct inode *, struct dentry *,
Miklos Szeredi520c8b12014-04-01 17:08:42 +02001847 struct inode *, struct dentry *, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001848 int (*setattr) (struct dentry *, struct iattr *);
David Howellsa528d352017-01-31 16:46:22 +00001849 int (*getattr) (const struct path *, struct kstat *, u32, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001850 ssize_t (*listxattr) (struct dentry *, char *, size_t);
Mark Fashehc4b929b2008-10-08 19:44:18 -04001851 int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
1852 u64 len);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001853 int (*update_time)(struct inode *, struct timespec64 *, int);
Al Virod9585272012-06-22 12:39:14 +04001854 int (*atomic_open)(struct inode *, struct dentry *,
Al Viro30d90492012-06-22 12:40:19 +04001855 struct file *, unsigned open_flag,
Al Viro44907d72018-06-08 13:32:02 -04001856 umode_t create_mode);
Al Viro60545d02013-06-07 01:20:27 -04001857 int (*tmpfile) (struct inode *, struct dentry *, umode_t);
Christoph Hellwig893d46e2013-12-20 05:16:39 -08001858 int (*set_acl)(struct inode *, struct posix_acl *, int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001859} ____cacheline_aligned;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001860
Miklos Szeredibb7462b2017-02-20 16:51:23 +01001861static inline ssize_t call_read_iter(struct file *file, struct kiocb *kio,
1862 struct iov_iter *iter)
1863{
1864 return file->f_op->read_iter(kio, iter);
1865}
1866
1867static inline ssize_t call_write_iter(struct file *file, struct kiocb *kio,
1868 struct iov_iter *iter)
1869{
1870 return file->f_op->write_iter(kio, iter);
1871}
1872
Miklos Szeredif74ac012017-02-20 16:51:23 +01001873static inline int call_mmap(struct file *file, struct vm_area_struct *vma)
1874{
1875 return file->f_op->mmap(file, vma);
1876}
1877
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001878ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvector,
Christopher Yeohfcf63402011-10-31 17:06:39 -07001879 unsigned long nr_segs, unsigned long fast_segs,
1880 struct iovec *fast_pointer,
Christopher Yeohac34ebb2012-05-31 16:26:42 -07001881 struct iovec **ret_pointer);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001882
Dmitry Kasatkin6fb50322014-11-05 17:01:17 +02001883extern ssize_t __vfs_read(struct file *, char __user *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001884extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
1885extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
1886extern ssize_t vfs_readv(struct file *, const struct iovec __user *,
Christoph Hellwigddef7ed22017-07-06 18:58:37 +02001887 unsigned long, loff_t *, rwf_t);
Zach Brown29732932015-11-10 16:53:30 -05001888extern ssize_t vfs_copy_file_range(struct file *, loff_t , struct file *,
1889 loff_t, size_t, unsigned int);
Dave Chinnerf16acc92019-06-05 08:04:47 -07001890extern ssize_t generic_copy_file_range(struct file *file_in, loff_t pos_in,
1891 struct file *file_out, loff_t pos_out,
1892 size_t len, unsigned int flags);
Darrick J. Wonga83ab012018-10-30 10:41:08 +11001893extern int generic_remap_file_range_prep(struct file *file_in, loff_t pos_in,
1894 struct file *file_out, loff_t pos_out,
Darrick J. Wong42ec3d42018-10-30 10:41:49 +11001895 loff_t *count,
1896 unsigned int remap_flags);
1897extern loff_t do_clone_file_range(struct file *file_in, loff_t pos_in,
1898 struct file *file_out, loff_t pos_out,
Darrick J. Wong452ce652018-10-30 10:41:56 +11001899 loff_t len, unsigned int remap_flags);
Darrick J. Wong42ec3d42018-10-30 10:41:49 +11001900extern loff_t vfs_clone_file_range(struct file *file_in, loff_t pos_in,
1901 struct file *file_out, loff_t pos_out,
Darrick J. Wong452ce652018-10-30 10:41:56 +11001902 loff_t len, unsigned int remap_flags);
Darrick J. Wong54dbc152015-12-19 00:55:59 -08001903extern int vfs_dedupe_file_range(struct file *file,
1904 struct file_dedupe_range *same);
Darrick J. Wong42ec3d42018-10-30 10:41:49 +11001905extern loff_t vfs_dedupe_file_range_one(struct file *src_file, loff_t src_pos,
1906 struct file *dst_file, loff_t dst_pos,
Darrick J. Wongdf365832018-10-30 10:42:03 +11001907 loff_t len, unsigned int remap_flags);
Miklos Szeredif1825362018-07-18 15:44:40 +02001908
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909
Linus Torvalds1da177e2005-04-16 15:20:36 -07001910struct super_operations {
1911 struct inode *(*alloc_inode)(struct super_block *sb);
1912 void (*destroy_inode)(struct inode *);
Al Virofdb0da82019-04-10 14:43:44 -04001913 void (*free_inode)(struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001914
Christoph Hellwigaa385722011-05-27 06:53:02 -04001915 void (*dirty_inode) (struct inode *, int flags);
Christoph Hellwiga9185b42010-03-05 09:21:37 +01001916 int (*write_inode) (struct inode *, struct writeback_control *wbc);
Al Viro45321ac2010-06-07 13:43:19 -04001917 int (*drop_inode) (struct inode *);
Al Virobe7ce412010-06-04 19:40:39 -04001918 void (*evict_inode) (struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919 void (*put_super) (struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001920 int (*sync_fs)(struct super_block *sb, int wait);
Benjamin Marzinski48b6bca2014-11-13 20:42:03 -06001921 int (*freeze_super) (struct super_block *);
Takashi Satoc4be0c12009-01-09 16:40:58 -08001922 int (*freeze_fs) (struct super_block *);
Benjamin Marzinski48b6bca2014-11-13 20:42:03 -06001923 int (*thaw_super) (struct super_block *);
Takashi Satoc4be0c12009-01-09 16:40:58 -08001924 int (*unfreeze_fs) (struct super_block *);
David Howells726c3342006-06-23 02:02:58 -07001925 int (*statfs) (struct dentry *, struct kstatfs *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926 int (*remount_fs) (struct super_block *, int *, char *);
Al Viro42faad92008-04-24 07:21:56 -04001927 void (*umount_begin) (struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928
Al Viro34c80b12011-12-08 21:32:45 -05001929 int (*show_options)(struct seq_file *, struct dentry *);
Al Virod861c632011-12-08 21:32:45 -05001930 int (*show_devname)(struct seq_file *, struct dentry *);
Al Viroa6322de2011-12-08 21:37:57 -05001931 int (*show_path)(struct seq_file *, struct dentry *);
Al Viro64132372011-12-08 20:51:13 -05001932 int (*show_stats)(struct seq_file *, struct dentry *);
Alexey Dobriyan0e51a722006-09-29 01:59:56 -07001933#ifdef CONFIG_QUOTA
Linus Torvalds1da177e2005-04-16 15:20:36 -07001934 ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
1935 ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
Jan Kara2d0fa462014-09-25 16:36:14 +02001936 struct dquot **(*get_dquots)(struct inode *);
Alexey Dobriyan0e51a722006-09-29 01:59:56 -07001937#endif
Theodore Ts'o87d8fe12009-01-03 09:47:09 -05001938 int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
Vladimir Davydov4101b622015-02-12 14:58:51 -08001939 long (*nr_cached_objects)(struct super_block *,
1940 struct shrink_control *);
1941 long (*free_cached_objects)(struct super_block *,
1942 struct shrink_control *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001943};
1944
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001945/*
David Howellsbbc10962012-10-15 16:40:35 +01001946 * Inode flags - they have no relation to superblock flags now
1947 */
1948#define S_SYNC 1 /* Writes are synced at once */
1949#define S_NOATIME 2 /* Do not update access times */
1950#define S_APPEND 4 /* Append-only file */
1951#define S_IMMUTABLE 8 /* Immutable file */
1952#define S_DEAD 16 /* removed, but still open directory */
1953#define S_NOQUOTA 32 /* Inode is not counted to quota */
1954#define S_DIRSYNC 64 /* Directory modifications are synchronous */
1955#define S_NOCMTIME 128 /* Do not update file c/mtime */
1956#define S_SWAPFILE 256 /* Do not truncate: swapon got its bmaps */
1957#define S_PRIVATE 512 /* Inode is fs-internal */
1958#define S_IMA 1024 /* Inode has an associated IMA struct */
1959#define S_AUTOMOUNT 2048 /* Automount/referral quasi-directory */
1960#define S_NOSEC 4096 /* no suid or xattr security attributes */
Matthew Wilcox6cd176a2015-02-16 15:59:25 -08001961#ifdef CONFIG_FS_DAX
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08001962#define S_DAX 8192 /* Direct Access, avoiding the page cache */
1963#else
1964#define S_DAX 0 /* Make all the DAX code disappear */
1965#endif
Eric Biggers2ee6a572017-10-09 12:15:35 -07001966#define S_ENCRYPTED 16384 /* Encrypted file (using fs/crypto/) */
Gabriel Krisman Bertazib886ee32019-04-25 14:12:08 -04001967#define S_CASEFOLD 32768 /* Casefolded file */
David Howellsbbc10962012-10-15 16:40:35 +01001968
1969/*
1970 * Note that nosuid etc flags are inode-specific: setting some file-system
1971 * flags just means all the inodes inherit those flags by default. It might be
1972 * possible to override it selectively if you really wanted to with some
1973 * ioctl() that is not currently implemented.
1974 *
David Howellse462ec52017-07-17 08:45:35 +01001975 * Exception: SB_RDONLY is always applied to the entire file system.
David Howellsbbc10962012-10-15 16:40:35 +01001976 *
1977 * Unfortunately, it is possible to change a filesystems flags with it mounted
1978 * with files in use. This means that all of the inodes will not have their
1979 * i_flags updated. Hence, i_flags no longer inherit the superblock mount
1980 * flags, so these have to be checked separately. -- rmk@arm.uk.linux.org
1981 */
1982#define __IS_FLG(inode, flg) ((inode)->i_sb->s_flags & (flg))
1983
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001984static inline bool sb_rdonly(const struct super_block *sb) { return sb->s_flags & SB_RDONLY; }
David Howells94e92e72017-07-17 08:45:34 +01001985#define IS_RDONLY(inode) sb_rdonly((inode)->i_sb)
David Howellse462ec52017-07-17 08:45:35 +01001986#define IS_SYNC(inode) (__IS_FLG(inode, SB_SYNCHRONOUS) || \
David Howellsbbc10962012-10-15 16:40:35 +01001987 ((inode)->i_flags & S_SYNC))
David Howellse462ec52017-07-17 08:45:35 +01001988#define IS_DIRSYNC(inode) (__IS_FLG(inode, SB_SYNCHRONOUS|SB_DIRSYNC) || \
David Howellsbbc10962012-10-15 16:40:35 +01001989 ((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
David Howellse462ec52017-07-17 08:45:35 +01001990#define IS_MANDLOCK(inode) __IS_FLG(inode, SB_MANDLOCK)
1991#define IS_NOATIME(inode) __IS_FLG(inode, SB_RDONLY|SB_NOATIME)
1992#define IS_I_VERSION(inode) __IS_FLG(inode, SB_I_VERSION)
David Howellsbbc10962012-10-15 16:40:35 +01001993
1994#define IS_NOQUOTA(inode) ((inode)->i_flags & S_NOQUOTA)
1995#define IS_APPEND(inode) ((inode)->i_flags & S_APPEND)
1996#define IS_IMMUTABLE(inode) ((inode)->i_flags & S_IMMUTABLE)
David Howellse462ec52017-07-17 08:45:35 +01001997#define IS_POSIXACL(inode) __IS_FLG(inode, SB_POSIXACL)
David Howellsbbc10962012-10-15 16:40:35 +01001998
1999#define IS_DEADDIR(inode) ((inode)->i_flags & S_DEAD)
2000#define IS_NOCMTIME(inode) ((inode)->i_flags & S_NOCMTIME)
2001#define IS_SWAPFILE(inode) ((inode)->i_flags & S_SWAPFILE)
2002#define IS_PRIVATE(inode) ((inode)->i_flags & S_PRIVATE)
2003#define IS_IMA(inode) ((inode)->i_flags & S_IMA)
2004#define IS_AUTOMOUNT(inode) ((inode)->i_flags & S_AUTOMOUNT)
2005#define IS_NOSEC(inode) ((inode)->i_flags & S_NOSEC)
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002006#define IS_DAX(inode) ((inode)->i_flags & S_DAX)
Eric Biggers2ee6a572017-10-09 12:15:35 -07002007#define IS_ENCRYPTED(inode) ((inode)->i_flags & S_ENCRYPTED)
Gabriel Krisman Bertazib886ee32019-04-25 14:12:08 -04002008#define IS_CASEFOLDED(inode) ((inode)->i_flags & S_CASEFOLD)
David Howellsbbc10962012-10-15 16:40:35 +01002009
Miklos Szeredi787fb6b2014-10-24 00:14:36 +02002010#define IS_WHITEOUT(inode) (S_ISCHR(inode->i_mode) && \
2011 (inode)->i_rdev == WHITEOUT_DEV)
2012
Eric W. Biederman0bd23d092016-06-29 14:54:46 -05002013static inline bool HAS_UNMAPPED_ID(struct inode *inode)
2014{
2015 return !uid_valid(inode->i_uid) || !gid_valid(inode->i_gid);
2016}
2017
Jens Axboec75b1d92017-06-27 11:47:04 -06002018static inline enum rw_hint file_write_hint(struct file *file)
2019{
2020 if (file->f_write_hint != WRITE_LIFE_NOT_SET)
2021 return file->f_write_hint;
2022
2023 return file_inode(file)->i_write_hint;
2024}
2025
2026static inline int iocb_flags(struct file *file);
2027
Adam Manzanaresfc287242018-05-22 10:52:18 -07002028static inline u16 ki_hint_validate(enum rw_hint hint)
2029{
2030 typeof(((struct kiocb *)0)->ki_hint) max_hint = -1;
2031
2032 if (hint <= max_hint)
2033 return hint;
2034 return 0;
2035}
2036
Jens Axboec75b1d92017-06-27 11:47:04 -06002037static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
2038{
2039 *kiocb = (struct kiocb) {
2040 .ki_filp = filp,
2041 .ki_flags = iocb_flags(filp),
Adam Manzanaresfc287242018-05-22 10:52:18 -07002042 .ki_hint = ki_hint_validate(file_write_hint(filp)),
Damien Le Moal20578bd2018-11-20 10:52:38 +09002043 .ki_ioprio = get_current_ioprio(),
Jens Axboec75b1d92017-06-27 11:47:04 -06002044 };
2045}
2046
David Howellsbbc10962012-10-15 16:40:35 +01002047/*
Dave Chinner250df6e2011-03-22 22:23:36 +11002048 * Inode state bits. Protected by inode->i_lock
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002049 *
2050 * Three bits determine the dirty state of the inode, I_DIRTY_SYNC,
2051 * I_DIRTY_DATASYNC and I_DIRTY_PAGES.
2052 *
2053 * Four bits define the lifetime of an inode. Initially, inodes are I_NEW,
2054 * until that flag is cleared. I_WILL_FREE, I_FREEING and I_CLEAR are set at
2055 * various stages of removing an inode.
2056 *
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002057 * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002058 *
Joern Engele7ca2d42008-02-06 01:36:59 -08002059 * I_DIRTY_SYNC Inode is dirty, but doesn't have to be written on
2060 * fdatasync(). i_atime is the usual cause.
Jan Kara000cb482008-02-14 19:31:32 -08002061 * I_DIRTY_DATASYNC Data-related inode changes pending. We keep track of
2062 * these changes separately from I_DIRTY_SYNC so that we
2063 * don't have to write inode on fdatasync() when only
2064 * mtime has changed in it.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002065 * I_DIRTY_PAGES Inode has dirty pages. Inode itself may be clean.
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002066 * I_NEW Serves as both a mutex and completion notification.
2067 * New inodes set I_NEW. If two processes both create
2068 * the same inode, one of them will release its inode and
2069 * wait for I_NEW to be released before returning.
2070 * Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can
2071 * also cause waiting on I_NEW, without I_NEW actually
2072 * being set. find_inode() uses this to prevent returning
2073 * nearly-dead inodes.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002074 * I_WILL_FREE Must be set when calling write_inode_now() if i_count
2075 * is zero. I_FREEING must be set when I_WILL_FREE is
2076 * cleared.
2077 * I_FREEING Set when inode is about to be freed but still has dirty
2078 * pages or buffers attached or the inode itself is still
2079 * dirty.
Jan Karadbd57682012-05-03 14:48:02 +02002080 * I_CLEAR Added by clear_inode(). In this state the inode is
2081 * clean and can be destroyed. Inode keeps I_FREEING.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002082 *
2083 * Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are
2084 * prohibited for many purposes. iget() must wait for
2085 * the inode to be completely released, then create it
2086 * anew. Other functions will just ignore such inodes,
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002087 * if appropriate. I_NEW is used for waiting.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002088 *
Jan Kara169ebd92012-05-03 14:48:03 +02002089 * I_SYNC Writeback of inode is running. The bit is set during
2090 * data writeback, and cleared with a wakeup on the bit
2091 * address once it is done. The bit is also used to pin
2092 * the inode in memory for flusher thread.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002093 *
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -04002094 * I_REFERENCED Marks the inode as recently references on the LRU list.
2095 *
2096 * I_DIO_WAKEUP Never set. Only used as a key for wait_on_bit().
2097 *
Tejun Heo682aa8e2015-05-28 14:50:53 -04002098 * I_WB_SWITCH Cgroup bdi_writeback switching in progress. Used to
2099 * synchronize competing switching instances and to tell
Matthew Wilcoxb93b0162018-04-10 16:36:56 -07002100 * wb stat updates to grab the i_pages lock. See
Greg Thelena9519de2019-03-05 15:50:03 -08002101 * inode_switch_wbs_work_fn() for details.
Tejun Heo682aa8e2015-05-28 14:50:53 -04002102 *
Amir Goldsteinad0af712017-06-21 15:28:32 +03002103 * I_OVL_INUSE Used by overlayfs to get exclusive ownership on upper
2104 * and work dirs among overlayfs mounts.
2105 *
Al Viroc2b6d622018-06-28 15:53:17 -04002106 * I_CREATING New object's inode in the middle of setting up.
2107 *
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002108 * Q: What is the difference between I_WILL_FREE and I_FREEING?
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002109 */
Nick Piggin9e38d862010-10-23 06:55:17 -04002110#define I_DIRTY_SYNC (1 << 0)
2111#define I_DIRTY_DATASYNC (1 << 1)
2112#define I_DIRTY_PAGES (1 << 2)
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002113#define __I_NEW 3
2114#define I_NEW (1 << __I_NEW)
Nick Piggin9e38d862010-10-23 06:55:17 -04002115#define I_WILL_FREE (1 << 4)
2116#define I_FREEING (1 << 5)
2117#define I_CLEAR (1 << 6)
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002118#define __I_SYNC 7
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002119#define I_SYNC (1 << __I_SYNC)
Nick Piggin9e38d862010-10-23 06:55:17 -04002120#define I_REFERENCED (1 << 8)
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -04002121#define __I_DIO_WAKEUP 9
Eric Sandeenac74d8d2015-04-16 15:04:56 -05002122#define I_DIO_WAKEUP (1 << __I_DIO_WAKEUP)
Al Virof4e0c302013-06-11 08:34:36 +04002123#define I_LINKABLE (1 << 10)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05002124#define I_DIRTY_TIME (1 << 11)
2125#define __I_DIRTY_TIME_EXPIRED 12
2126#define I_DIRTY_TIME_EXPIRED (1 << __I_DIRTY_TIME_EXPIRED)
Tejun Heo682aa8e2015-05-28 14:50:53 -04002127#define I_WB_SWITCH (1 << 13)
Al Viroc2b6d622018-06-28 15:53:17 -04002128#define I_OVL_INUSE (1 << 14)
2129#define I_CREATING (1 << 15)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130
Christoph Hellwig0e11f642018-02-21 07:54:49 -08002131#define I_DIRTY_INODE (I_DIRTY_SYNC | I_DIRTY_DATASYNC)
2132#define I_DIRTY (I_DIRTY_INODE | I_DIRTY_PAGES)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05002133#define I_DIRTY_ALL (I_DIRTY | I_DIRTY_TIME)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002134
2135extern void __mark_inode_dirty(struct inode *, int);
2136static inline void mark_inode_dirty(struct inode *inode)
2137{
2138 __mark_inode_dirty(inode, I_DIRTY);
2139}
2140
2141static inline void mark_inode_dirty_sync(struct inode *inode)
2142{
2143 __mark_inode_dirty(inode, I_DIRTY_SYNC);
2144}
2145
Miklos Szeredi7ada4db2011-11-21 12:11:32 +01002146extern void inc_nlink(struct inode *inode);
2147extern void drop_nlink(struct inode *inode);
2148extern void clear_nlink(struct inode *inode);
2149extern void set_nlink(struct inode *inode, unsigned int nlink);
Dave Hansend8c76e62006-09-30 23:29:04 -07002150
2151static inline void inode_inc_link_count(struct inode *inode)
2152{
2153 inc_nlink(inode);
Alexey Dobriyan66d21732006-03-23 03:00:51 -08002154 mark_inode_dirty(inode);
2155}
2156
Dave Hansen9a53c3a2006-09-30 23:29:03 -07002157static inline void inode_dec_link_count(struct inode *inode)
2158{
2159 drop_nlink(inode);
Alexey Dobriyan66d21732006-03-23 03:00:51 -08002160 mark_inode_dirty(inode);
2161}
2162
Josef Bacikc3b2da32012-03-26 09:59:21 -04002163enum file_time_flags {
2164 S_ATIME = 1,
2165 S_MTIME = 2,
2166 S_CTIME = 4,
2167 S_VERSION = 8,
2168};
2169
Miklos Szeredic6718542018-07-18 15:44:43 +02002170extern bool atime_needs_update(const struct path *, struct inode *);
Al Virobadcf2b2013-07-16 18:15:46 +04002171extern void touch_atime(const struct path *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172static inline void file_accessed(struct file *file)
2173{
2174 if (!(file->f_flags & O_NOATIME))
Al Viro68ac1232012-03-15 08:21:57 -04002175 touch_atime(&file->f_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002176}
2177
Amir Goldsteine38f7f52019-06-05 08:04:49 -07002178extern int file_modified(struct file *file);
2179
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180int sync_inode(struct inode *inode, struct writeback_control *wbc);
Christoph Hellwigc37650162010-10-06 10:48:20 +02002181int sync_inode_metadata(struct inode *inode, int wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182
Linus Torvalds1da177e2005-04-16 15:20:36 -07002183struct file_system_type {
2184 const char *name;
2185 int fs_flags;
David Howellsbbc10962012-10-15 16:40:35 +01002186#define FS_REQUIRES_DEV 1
2187#define FS_BINARY_MOUNTDATA 2
2188#define FS_HAS_SUBTYPE 4
Eric W. Biederman0c55cfc2012-07-26 21:42:03 -07002189#define FS_USERNS_MOUNT 8 /* Can be mounted by userns root */
Jan Kara0b3b0942019-05-15 16:28:34 +02002190#define FS_DISALLOW_NOTIFY_PERM 16 /* Disable fanotify permission events */
David Howellsbbc10962012-10-15 16:40:35 +01002191#define FS_RENAME_DOES_D_MOVE 32768 /* FS will handle d_move() during rename() internally. */
Al Virof3a09c92018-12-23 18:55:56 -05002192 int (*init_fs_context)(struct fs_context *);
David Howells3e1aeb02018-11-01 23:07:25 +00002193 const struct fs_parameter_description *parameters;
Al Viroc96e41e2010-07-25 00:17:56 +04002194 struct dentry *(*mount) (struct file_system_type *, int,
2195 const char *, void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002196 void (*kill_sb) (struct super_block *);
2197 struct module *owner;
2198 struct file_system_type * next;
Al Viroa5166162011-12-12 22:53:00 -05002199 struct hlist_head fs_supers;
Peter Zijlstrad475fd42007-10-15 14:51:31 +02002200
Ingo Molnarcf516242006-07-03 00:25:27 -07002201 struct lock_class_key s_lock_key;
Arjan van de Ven897c6ff2006-07-03 00:25:28 -07002202 struct lock_class_key s_umount_key;
Roland Dreier51ee0492010-04-27 14:23:57 -07002203 struct lock_class_key s_vfs_rename_key;
Jan Kara5accdf82012-06-12 16:20:34 +02002204 struct lock_class_key s_writers_key[SB_FREEZE_LEVELS];
Peter Zijlstrad475fd42007-10-15 14:51:31 +02002205
2206 struct lock_class_key i_lock_key;
2207 struct lock_class_key i_mutex_key;
Peter Zijlstra14358e62007-10-14 01:38:33 +02002208 struct lock_class_key i_mutex_dir_key;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002209};
2210
Eric W. Biederman7f78e032013-03-02 19:39:14 -08002211#define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME)
2212
Al Virof175f302017-10-15 00:38:00 -04002213#ifdef CONFIG_BLOCK
Al Viro152a0832010-07-25 00:46:55 +04002214extern struct dentry *mount_bdev(struct file_system_type *fs_type,
2215 int flags, const char *dev_name, void *data,
2216 int (*fill_super)(struct super_block *, void *, int));
Al Virof175f302017-10-15 00:38:00 -04002217#else
2218static inline struct dentry *mount_bdev(struct file_system_type *fs_type,
2219 int flags, const char *dev_name, void *data,
2220 int (*fill_super)(struct super_block *, void *, int))
2221{
2222 return ERR_PTR(-ENODEV);
2223}
2224#endif
Al Virofc14f2f2010-07-25 01:48:30 +04002225extern struct dentry *mount_single(struct file_system_type *fs_type,
2226 int flags, void *data,
2227 int (*fill_super)(struct super_block *, void *, int));
Al Viro3c26ff62010-07-25 11:46:36 +04002228extern struct dentry *mount_nodev(struct file_system_type *fs_type,
2229 int flags, void *data,
2230 int (*fill_super)(struct super_block *, void *, int));
Al Viroea441d12011-11-16 21:43:59 -05002231extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232void generic_shutdown_super(struct super_block *sb);
Al Virof175f302017-10-15 00:38:00 -04002233#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002234void kill_block_super(struct super_block *sb);
Al Virof175f302017-10-15 00:38:00 -04002235#else
2236static inline void kill_block_super(struct super_block *sb)
2237{
2238 BUG();
2239}
2240#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002241void kill_anon_super(struct super_block *sb);
2242void kill_litter_super(struct super_block *sb);
2243void deactivate_super(struct super_block *sb);
Al Viro74dbbdd2009-05-06 01:07:50 -04002244void deactivate_locked_super(struct super_block *sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245int set_anon_super(struct super_block *s, void *data);
Al Virocb50b342018-12-23 17:25:47 -05002246int set_anon_super_fc(struct super_block *s, struct fs_context *fc);
Al Viro0ee5dc62011-07-07 15:44:25 -04002247int get_anon_bdev(dev_t *);
2248void free_anon_bdev(dev_t);
Al Virocb50b342018-12-23 17:25:47 -05002249struct super_block *sget_fc(struct fs_context *fc,
2250 int (*test)(struct super_block *, struct fs_context *),
2251 int (*set)(struct super_block *, struct fs_context *));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002252struct super_block *sget(struct file_system_type *type,
2253 int (*test)(struct super_block *,void *),
2254 int (*set)(struct super_block *,void *),
David Howells9249e172012-06-25 12:55:37 +01002255 int flags, void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256
2257/* Alas, no aliases. Too much hassle with bringing module.h everywhere */
2258#define fops_get(fops) \
2259 (((fops) && try_module_get((fops)->owner) ? (fops) : NULL))
2260#define fops_put(fops) \
2261 do { if (fops) module_put((fops)->owner); } while(0)
Al Viroe84f9e52013-09-22 14:17:15 -04002262/*
2263 * This one is to be used *ONLY* from ->open() instances.
2264 * fops must be non-NULL, pinned down *and* module dependencies
2265 * should be sufficient to pin the caller down as well.
2266 */
2267#define replace_fops(f, fops) \
2268 do { \
2269 struct file *__file = (f); \
2270 fops_put(__file->f_op); \
2271 BUG_ON(!(__file->f_op = (fops))); \
2272 } while(0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002273
2274extern int register_filesystem(struct file_system_type *);
2275extern int unregister_filesystem(struct file_system_type *);
David Howellsd911b452018-11-01 23:07:26 +00002276extern struct vfsmount *kern_mount(struct file_system_type *);
Tim Chen423e0ab2011-07-19 09:32:38 -07002277extern void kern_unmount(struct vfsmount *mnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278extern int may_umount_tree(struct vfsmount *);
2279extern int may_umount(struct vfsmount *);
Seunghun Lee5e6123f2014-09-14 22:15:10 +09002280extern long do_mount(const char *, const char __user *,
2281 const char *, unsigned long, void *);
Al Viroca71cf72016-11-20 19:45:28 -05002282extern struct vfsmount *collect_mounts(const struct path *);
Al Viro8aec0802007-06-07 12:20:32 -04002283extern void drop_collected_mounts(struct vfsmount *);
Al Viro1f707132010-01-30 22:51:25 -05002284extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
2285 struct vfsmount *);
Al Virof0bb5aa2016-11-20 20:27:12 -05002286extern int vfs_statfs(const struct path *, struct kstatfs *);
Al Viroc8b91ac2011-03-12 10:41:39 -05002287extern int user_statfs(const char __user *, struct kstatfs *);
2288extern int fd_statfs(int, struct kstatfs *);
Josef Bacik18e9e512010-03-23 10:34:56 -04002289extern int freeze_super(struct super_block *super);
2290extern int thaw_super(struct super_block *super);
Al Viro02125a82011-12-05 08:43:34 -05002291extern bool our_mnt(struct vfsmount *mnt);
Jan Karafca39342017-04-12 12:24:28 +02002292extern __printf(2, 3)
2293int super_setup_bdi_name(struct super_block *sb, char *fmt, ...);
2294extern int super_setup_bdi(struct super_block *sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002295
Al Viroce3b0f82009-03-29 19:08:22 -04002296extern int current_umask(void);
2297
J. Bruce Fields5a146962012-08-28 07:50:40 -07002298extern void ihold(struct inode * inode);
2299extern void iput(struct inode *);
Deepa Dinamani95582b02018-05-08 19:36:02 -07002300extern int generic_update_time(struct inode *, struct timespec64 *, int);
J. Bruce Fields5a146962012-08-28 07:50:40 -07002301
Miklos Szeredif87fd4c2006-01-16 22:14:23 -08002302/* /sys/fs */
Greg Kroah-Hartman00d26662007-10-29 14:17:23 -06002303extern struct kobject *fs_kobj;
Miklos Szeredif87fd4c2006-01-16 22:14:23 -08002304
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002305#define MAX_RW_COUNT (INT_MAX & PAGE_MASK)
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002306
Jeff Layton9e8925b2015-11-16 09:49:34 -05002307#ifdef CONFIG_MANDATORY_FILE_LOCKING
Jeff Laytond7a06982014-03-10 09:54:15 -04002308extern int locks_mandatory_locked(struct file *);
Christoph Hellwigacc15572015-12-03 12:59:49 +01002309extern int locks_mandatory_area(struct inode *, struct file *, loff_t, loff_t, unsigned char);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002310
2311/*
2312 * Candidates for mandatory locking have the setgid bit set
2313 * but no group execute bit - an otherwise meaningless combination.
2314 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002315
2316static inline int __mandatory_lock(struct inode *ino)
2317{
2318 return (ino->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID;
2319}
2320
2321/*
David Howellse462ec52017-07-17 08:45:35 +01002322 * ... and these candidates should be on SB_MANDLOCK mounted fs,
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002323 * otherwise these will be advisory locks
2324 */
2325
2326static inline int mandatory_lock(struct inode *ino)
2327{
2328 return IS_MANDLOCK(ino) && __mandatory_lock(ino);
2329}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002330
Jeff Laytond7a06982014-03-10 09:54:15 -04002331static inline int locks_verify_locked(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002332{
Miklos Szeredic568d682016-09-16 12:44:20 +02002333 if (mandatory_lock(locks_inode(file)))
Jeff Laytond7a06982014-03-10 09:54:15 -04002334 return locks_mandatory_locked(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002335 return 0;
2336}
2337
Linus Torvalds1da177e2005-04-16 15:20:36 -07002338static inline int locks_verify_truncate(struct inode *inode,
Christoph Hellwigacc15572015-12-03 12:59:49 +01002339 struct file *f,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002340 loff_t size)
2341{
Christoph Hellwigacc15572015-12-03 12:59:49 +01002342 if (!inode->i_flctx || !mandatory_lock(inode))
2343 return 0;
2344
2345 if (size < inode->i_size) {
2346 return locks_mandatory_area(inode, f, size, inode->i_size - 1,
2347 F_WRLCK);
2348 } else {
2349 return locks_mandatory_area(inode, f, inode->i_size, size - 1,
2350 F_WRLCK);
2351 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002352}
2353
Jeff Layton9e8925b2015-11-16 09:49:34 -05002354#else /* !CONFIG_MANDATORY_FILE_LOCKING */
2355
2356static inline int locks_mandatory_locked(struct file *file)
2357{
2358 return 0;
2359}
2360
Linus Torvaldsfce205e2016-01-12 16:30:34 -08002361static inline int locks_mandatory_area(struct inode *inode, struct file *filp,
2362 loff_t start, loff_t end, unsigned char type)
Jeff Layton9e8925b2015-11-16 09:49:34 -05002363{
2364 return 0;
2365}
2366
2367static inline int __mandatory_lock(struct inode *inode)
2368{
2369 return 0;
2370}
2371
2372static inline int mandatory_lock(struct inode *inode)
2373{
2374 return 0;
2375}
2376
2377static inline int locks_verify_locked(struct file *file)
2378{
2379 return 0;
2380}
2381
2382static inline int locks_verify_truncate(struct inode *inode, struct file *filp,
2383 size_t size)
2384{
2385 return 0;
2386}
2387
2388#endif /* CONFIG_MANDATORY_FILE_LOCKING */
2389
2390
2391#ifdef CONFIG_FILE_LOCKING
Linus Torvalds1da177e2005-04-16 15:20:36 -07002392static inline int break_lease(struct inode *inode, unsigned int mode)
2393{
Jeff Layton24cbe782014-02-03 12:13:06 -05002394 /*
2395 * Since this check is lockless, we must ensure that any refcounts
Jeff Layton8116bf42015-01-21 20:44:01 -05002396 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2397 * could end up racing with tasks trying to set a new lease on this
2398 * file.
Jeff Layton24cbe782014-02-03 12:13:06 -05002399 */
2400 smp_mb();
Jeff Layton8634b512015-01-16 15:05:55 -05002401 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002402 return __break_lease(inode, mode, FL_LEASE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002403 return 0;
2404}
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002405
2406static inline int break_deleg(struct inode *inode, unsigned int mode)
2407{
Jeff Layton962bd402014-06-10 12:24:40 -04002408 /*
2409 * Since this check is lockless, we must ensure that any refcounts
Jeff Layton8116bf42015-01-21 20:44:01 -05002410 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2411 * could end up racing with tasks trying to set a new lease on this
2412 * file.
Jeff Layton962bd402014-06-10 12:24:40 -04002413 */
2414 smp_mb();
Jeff Layton8634b512015-01-16 15:05:55 -05002415 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002416 return __break_lease(inode, mode, FL_DELEG);
2417 return 0;
2418}
2419
J. Bruce Fields5a146962012-08-28 07:50:40 -07002420static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2421{
2422 int ret;
2423
2424 ret = break_deleg(inode, O_WRONLY|O_NONBLOCK);
2425 if (ret == -EWOULDBLOCK && delegated_inode) {
2426 *delegated_inode = inode;
2427 ihold(inode);
2428 }
2429 return ret;
2430}
2431
2432static inline int break_deleg_wait(struct inode **delegated_inode)
2433{
2434 int ret;
2435
2436 ret = break_deleg(*delegated_inode, O_WRONLY);
2437 iput(*delegated_inode);
2438 *delegated_inode = NULL;
2439 return ret;
2440}
2441
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01002442static inline int break_layout(struct inode *inode, bool wait)
2443{
2444 smp_mb();
2445 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2446 return __break_lease(inode,
2447 wait ? O_WRONLY : O_WRONLY | O_NONBLOCK,
2448 FL_LAYOUT);
2449 return 0;
2450}
2451
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002452#else /* !CONFIG_FILE_LOCKING */
Steven Whitehouseaf5df562009-01-20 10:29:46 +00002453static inline int break_lease(struct inode *inode, unsigned int mode)
2454{
2455 return 0;
2456}
2457
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002458static inline int break_deleg(struct inode *inode, unsigned int mode)
2459{
2460 return 0;
2461}
J. Bruce Fields5a146962012-08-28 07:50:40 -07002462
2463static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2464{
2465 return 0;
2466}
2467
2468static inline int break_deleg_wait(struct inode **delegated_inode)
2469{
2470 BUG();
2471 return 0;
2472}
2473
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01002474static inline int break_layout(struct inode *inode, bool wait)
2475{
2476 return 0;
2477}
2478
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002479#endif /* CONFIG_FILE_LOCKING */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002480
2481/* fs/open.c */
Jeff Laytonadb5c242012-10-10 16:43:13 -04002482struct audit_names;
Jeff Layton91a27b22012-10-10 15:25:28 -04002483struct filename {
Jeff Laytonadb5c242012-10-10 16:43:13 -04002484 const char *name; /* pointer to actual string */
2485 const __user char *uptr; /* original userland pointer */
Paul Moore55422d02015-01-22 00:00:23 -05002486 int refcnt;
Rasmus Villemoes1c9498432018-03-01 00:19:21 +01002487 struct audit_names *aname;
Al Virofd2f7cb2015-02-22 20:07:13 -05002488 const char iname[];
Jeff Layton91a27b22012-10-10 15:25:28 -04002489};
Rasmus Villemoesf1fffbd2019-03-07 16:27:07 -08002490static_assert(offsetof(struct filename, iname) % sizeof(long) == 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002491
Al Viro7df818b2016-03-25 14:24:09 -04002492extern long vfs_truncate(const struct path *, loff_t);
NeilBrown4a301312006-01-08 01:02:39 -08002493extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
2494 struct file *filp);
Anna Schumaker72c72bd2014-11-07 14:44:25 -05002495extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
Ankit Jain3e63cbb2009-06-19 14:28:07 -04002496 loff_t len);
Jason Uhlenkott8e8a1402007-10-20 03:16:18 +02002497extern long do_sys_open(int dfd, const char __user *filename, int flags,
Al Viroa218d0f2011-11-21 14:59:34 -05002498 umode_t mode);
Jeff Layton669abf42012-10-10 16:43:10 -04002499extern struct file *file_open_name(struct filename *, int, umode_t);
Al Viroa218d0f2011-11-21 14:59:34 -05002500extern struct file *filp_open(const char *, int, umode_t);
Al Viro73d049a2011-03-11 12:08:24 -05002501extern struct file *file_open_root(struct dentry *, struct vfsmount *,
Jann Horn378c6522016-03-22 14:25:36 -07002502 const char *, int, umode_t);
Al Viro765927b2012-06-26 21:58:53 +04002503extern struct file * dentry_open(const struct path *, int, const struct cred *);
Al Viro2abc77a2018-07-12 11:18:42 -04002504extern struct file * open_with_fake_path(const struct path *, int,
2505 struct inode*, const struct cred *);
Al Viro19f391e2018-06-08 11:19:32 -04002506static inline struct file *file_clone_open(struct file *file)
2507{
2508 return dentry_open(&file->f_path, file->f_flags, file->f_cred);
2509}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002510extern int filp_close(struct file *, fl_owner_t id);
Jeff Layton91a27b22012-10-10 15:25:28 -04002511
David Drysdale51f39a12014-12-12 16:57:29 -08002512extern struct filename *getname_flags(const char __user *, int, int *);
Jeff Layton91a27b22012-10-10 15:25:28 -04002513extern struct filename *getname(const char __user *);
Linus Torvaldsc4ad8f92014-02-05 12:54:53 -08002514extern struct filename *getname_kernel(const char *);
Paul Moore55422d02015-01-22 00:00:23 -05002515extern void putname(struct filename *name);
Jeff Layton91a27b22012-10-10 15:25:28 -04002516
Al Viro30d90492012-06-22 12:40:19 +04002517extern int finish_open(struct file *file, struct dentry *dentry,
Al Virobe12af32018-06-08 11:44:56 -04002518 int (*open)(struct inode *, struct file *));
Al Viroe45198a2012-06-10 06:48:09 -04002519extern int finish_no_open(struct file *file, struct dentry *dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002520
Ankit Jain3e63cbb2009-06-19 14:28:07 -04002521/* fs/ioctl.c */
2522
2523extern int ioctl_preallocate(struct file *filp, void __user *argp);
2524
Linus Torvalds1da177e2005-04-16 15:20:36 -07002525/* fs/dcache.c */
2526extern void __init vfs_caches_init_early(void);
Mel Gorman4248b0d2015-08-06 15:46:20 -07002527extern void __init vfs_caches_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002528
Christoph Lameterb86c0892006-12-06 20:32:57 -08002529extern struct kmem_cache *names_cachep;
2530
Jeff Laytona608ca22012-10-10 15:25:26 -04002531#define __getname() kmem_cache_alloc(names_cachep, GFP_KERNEL)
Vegard Nossum3446a8a2009-05-16 11:22:14 +02002532#define __putname(name) kmem_cache_free(names_cachep, (void *)(name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002533
David Howells93614012006-09-30 20:45:40 +02002534#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002535extern int register_blkdev(unsigned int, const char *);
Akinobu Mitaf4480242007-07-17 04:03:47 -07002536extern void unregister_blkdev(unsigned int, const char *);
Jan Karaf44f1ab2017-02-02 15:56:49 +01002537extern void bdev_unhash_inode(dev_t dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002538extern struct block_device *bdget(dev_t);
Alan Jenkinsdddac6a2009-07-29 21:07:55 +02002539extern struct block_device *bdgrab(struct block_device *bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002540extern void bd_set_size(struct block_device *, loff_t size);
2541extern void bd_forget(struct inode *inode);
2542extern void bdput(struct block_device *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002543extern void invalidate_bdev(struct block_device *);
Jan Kara5c0d6b62012-07-03 16:45:31 +02002544extern void iterate_bdevs(void (*)(struct block_device *, void *), void *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002545extern int sync_blockdev(struct block_device *bdev);
Al Viroff01bb42011-09-16 02:31:11 -04002546extern void kill_bdev(struct block_device *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002547extern struct super_block *freeze_bdev(struct block_device *);
Eric Sandeenc2d75432009-03-31 15:23:46 -07002548extern void emergency_thaw_all(void);
Mateusz Guzik08fdc8a2017-10-03 18:17:41 +02002549extern void emergency_thaw_bdev(struct super_block *sb);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002550extern int thaw_bdev(struct block_device *bdev, struct super_block *sb);
2551extern int fsync_bdev(struct block_device *);
Tejun Heoa212b102015-05-22 17:13:33 -04002552
2553extern struct super_block *blockdev_superblock;
2554
2555static inline bool sb_is_blkdev_sb(struct super_block *sb)
2556{
2557 return sb == blockdev_superblock;
2558}
David Howells93614012006-09-30 20:45:40 +02002559#else
2560static inline void bd_forget(struct inode *inode) {}
Al Viro47e44912009-04-01 07:07:16 -04002561static inline int sync_blockdev(struct block_device *bdev) { return 0; }
Al Viroff01bb42011-09-16 02:31:11 -04002562static inline void kill_bdev(struct block_device *bdev) {}
Al Viro47e44912009-04-01 07:07:16 -04002563static inline void invalidate_bdev(struct block_device *bdev) {}
2564
2565static inline struct super_block *freeze_bdev(struct block_device *sb)
2566{
2567 return NULL;
2568}
2569
2570static inline int thaw_bdev(struct block_device *bdev, struct super_block *sb)
2571{
2572 return 0;
2573}
Jan Kara5c0d6b62012-07-03 16:45:31 +02002574
Mateusz Guzik08fdc8a2017-10-03 18:17:41 +02002575static inline int emergency_thaw_bdev(struct super_block *sb)
2576{
2577 return 0;
2578}
2579
Jan Kara5c0d6b62012-07-03 16:45:31 +02002580static inline void iterate_bdevs(void (*f)(struct block_device *, void *), void *arg)
2581{
2582}
Jan Karaa8855992013-07-09 22:36:45 +08002583
Yaowei Bai3e004ee2015-11-17 14:40:09 +08002584static inline bool sb_is_blkdev_sb(struct super_block *sb)
Jan Karaa8855992013-07-09 22:36:45 +08002585{
Yaowei Bai3e004ee2015-11-17 14:40:09 +08002586 return false;
Jan Karaa8855992013-07-09 22:36:45 +08002587}
David Howells93614012006-09-30 20:45:40 +02002588#endif
Jan Kara60b06802009-04-27 16:43:53 +02002589extern int sync_filesystem(struct super_block *);
David Howells93614012006-09-30 20:45:40 +02002590extern const struct file_operations def_blk_fops;
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08002591extern const struct file_operations def_chr_fops;
David Howells93614012006-09-30 20:45:40 +02002592#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002593extern int ioctl_by_bdev(struct block_device *, unsigned, unsigned long);
Al Viro56b26ad2008-09-19 03:17:36 -04002594extern int blkdev_ioctl(struct block_device *, fmode_t, unsigned, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002595extern long compat_blkdev_ioctl(struct file *, unsigned, unsigned long);
Tejun Heoe525fd82010-11-13 11:55:17 +01002596extern int blkdev_get(struct block_device *bdev, fmode_t mode, void *holder);
Tejun Heod4d77622010-11-13 11:55:18 +01002597extern struct block_device *blkdev_get_by_path(const char *path, fmode_t mode,
2598 void *holder);
2599extern struct block_device *blkdev_get_by_dev(dev_t dev, fmode_t mode,
2600 void *holder);
Jan Kara89e524c02019-07-30 13:10:14 +02002601extern struct block_device *bd_start_claiming(struct block_device *bdev,
2602 void *holder);
2603extern void bd_finish_claiming(struct block_device *bdev,
2604 struct block_device *whole, void *holder);
2605extern void bd_abort_claiming(struct block_device *bdev,
2606 struct block_device *whole, void *holder);
Al Viro4385bab2013-05-05 22:11:03 -04002607extern void blkdev_put(struct block_device *bdev, fmode_t mode);
Jarod Wilsonbe324172015-05-06 12:26:22 +08002608extern int __blkdev_reread_part(struct block_device *bdev);
2609extern int blkdev_reread_part(struct block_device *bdev);
2610
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002611#ifdef CONFIG_SYSFS
Tejun Heoe09b4572010-11-13 11:55:17 +01002612extern int bd_link_disk_holder(struct block_device *bdev, struct gendisk *disk);
Tejun Heo49731ba2011-01-14 18:43:57 +01002613extern void bd_unlink_disk_holder(struct block_device *bdev,
2614 struct gendisk *disk);
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002615#else
Tejun Heoe09b4572010-11-13 11:55:17 +01002616static inline int bd_link_disk_holder(struct block_device *bdev,
2617 struct gendisk *disk)
2618{
2619 return 0;
2620}
Tejun Heo49731ba2011-01-14 18:43:57 +01002621static inline void bd_unlink_disk_holder(struct block_device *bdev,
2622 struct gendisk *disk)
2623{
2624}
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002625#endif
David Howells93614012006-09-30 20:45:40 +02002626#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002627
2628/* fs/char_dev.c */
Logan Gunthorpe8a932f72017-06-15 14:05:21 -06002629#define CHRDEV_MAJOR_MAX 512
Linus Walleij49db08c2016-02-19 15:36:07 +01002630/* Marks the bottom of the first segment of free char majors */
2631#define CHRDEV_MAJOR_DYN_END 234
Logan Gunthorpea5d31a32017-06-15 14:05:20 -06002632/* Marks the top and bottom of the second segment of free char majors */
2633#define CHRDEV_MAJOR_DYN_EXT_START 511
2634#define CHRDEV_MAJOR_DYN_EXT_END 384
2635
Linus Torvalds1da177e2005-04-16 15:20:36 -07002636extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
2637extern int register_chrdev_region(dev_t, unsigned, const char *);
Tejun Heo1905b1b2009-08-06 18:13:23 +09002638extern int __register_chrdev(unsigned int major, unsigned int baseminor,
2639 unsigned int count, const char *name,
2640 const struct file_operations *fops);
2641extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
2642 unsigned int count, const char *name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002643extern void unregister_chrdev_region(dev_t, unsigned);
Joe Korty68eef3b2006-03-31 02:30:32 -08002644extern void chrdev_show(struct seq_file *,off_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002645
Tejun Heo1905b1b2009-08-06 18:13:23 +09002646static inline int register_chrdev(unsigned int major, const char *name,
2647 const struct file_operations *fops)
2648{
2649 return __register_chrdev(major, 0, 256, name, fops);
2650}
2651
2652static inline void unregister_chrdev(unsigned int major, const char *name)
2653{
2654 __unregister_chrdev(major, 0, 256, name);
2655}
2656
Linus Torvalds1da177e2005-04-16 15:20:36 -07002657/* fs/block_dev.c */
2658#define BDEVNAME_SIZE 32 /* Largest string for a blockdev identifier */
Tejun Heo1f014292008-08-25 19:47:23 +09002659#define BDEVT_SIZE 10 /* Largest string for MAJ:MIN for blkdev */
David Howells93614012006-09-30 20:45:40 +02002660
2661#ifdef CONFIG_BLOCK
Logan Gunthorpe133d55c2017-06-16 17:48:21 -06002662#define BLKDEV_MAJOR_MAX 512
Linus Torvalds1da177e2005-04-16 15:20:36 -07002663extern const char *__bdevname(dev_t, char *buffer);
2664extern const char *bdevname(struct block_device *bdev, char *buffer);
2665extern struct block_device *lookup_bdev(const char *);
Joe Korty68eef3b2006-03-31 02:30:32 -08002666extern void blkdev_show(struct seq_file *,off_t);
Al Viro30c40d22008-02-22 19:50:45 -05002667
David Howells93614012006-09-30 20:45:40 +02002668#else
Logan Gunthorpe133d55c2017-06-16 17:48:21 -06002669#define BLKDEV_MAJOR_MAX 0
David Howells93614012006-09-30 20:45:40 +02002670#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002671
2672extern void init_special_inode(struct inode *, umode_t, dev_t);
2673
2674/* Invalid inode operations -- fs/bad_inode.c */
2675extern void make_bad_inode(struct inode *);
Yaowei Bai0e3ef1f2015-11-19 21:00:11 +08002676extern bool is_bad_inode(struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002677
Jens Axboec11f0c02016-08-05 08:11:04 -06002678#ifdef CONFIG_BLOCK
Andrew Pattersonc3279d12008-09-04 14:27:25 -06002679extern void check_disk_size_change(struct gendisk *disk,
Christoph Hellwig5afb7832018-05-29 16:42:59 +02002680 struct block_device *bdev, bool verbose);
Andrew Patterson0c002c22008-09-04 14:27:20 -06002681extern int revalidate_disk(struct gendisk *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002682extern int check_disk_change(struct block_device *);
NeilBrown93b270f2011-02-24 17:25:47 +11002683extern int __invalidate_device(struct block_device *, bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002684extern int invalidate_partition(struct gendisk *, int);
David Howells93614012006-09-30 20:45:40 +02002685#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002686unsigned long invalidate_mapping_pages(struct address_space *mapping,
2687 pgoff_t start, pgoff_t end);
Anton Altaparmakov54bc4852007-02-10 01:45:38 -08002688
Linus Torvalds1da177e2005-04-16 15:20:36 -07002689static inline void invalidate_remote_inode(struct inode *inode)
2690{
2691 if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
2692 S_ISLNK(inode->i_mode))
Andrew Mortonfc0ecff2007-02-10 01:45:39 -08002693 invalidate_mapping_pages(inode->i_mapping, 0, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002694}
2695extern int invalidate_inode_pages2(struct address_space *mapping);
2696extern int invalidate_inode_pages2_range(struct address_space *mapping,
2697 pgoff_t start, pgoff_t end);
2698extern int write_inode_now(struct inode *, int);
2699extern int filemap_fdatawrite(struct address_space *);
2700extern int filemap_flush(struct address_space *);
Jeff Layton76341ca2017-07-06 07:02:22 -04002701extern int filemap_fdatawait_keep_errors(struct address_space *mapping);
Jan Karad3bccb6f2009-08-17 19:30:27 +02002702extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
2703 loff_t lend);
Ross Zwisleraa0bfcd2019-06-20 17:05:37 -04002704extern int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
2705 loff_t start_byte, loff_t end_byte);
Jeff Laytonffb959b2017-07-31 10:29:38 -04002706
2707static inline int filemap_fdatawait(struct address_space *mapping)
2708{
2709 return filemap_fdatawait_range(mapping, 0, LLONG_MAX);
2710}
2711
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -05002712extern bool filemap_range_has_page(struct address_space *, loff_t lstart,
2713 loff_t lend);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002714extern int filemap_write_and_wait(struct address_space *mapping);
2715extern int filemap_write_and_wait_range(struct address_space *mapping,
2716 loff_t lstart, loff_t lend);
Andrew Mortonebcf28e2006-03-24 03:18:04 -08002717extern int __filemap_fdatawrite_range(struct address_space *mapping,
2718 loff_t start, loff_t end, int sync_mode);
Jan Karaf4c0a0f2008-07-11 19:27:31 -04002719extern int filemap_fdatawrite_range(struct address_space *mapping,
2720 loff_t start, loff_t end);
Miklos Szeredid72d9e22016-07-29 14:10:57 +02002721extern int filemap_check_errors(struct address_space *mapping);
Jeff Layton5660e132017-07-06 07:02:25 -04002722extern void __filemap_set_wb_err(struct address_space *mapping, int err);
Jeff Laytona823e452017-07-28 07:24:43 -04002723
2724extern int __must_check file_fdatawait_range(struct file *file, loff_t lstart,
2725 loff_t lend);
Jeff Layton5660e132017-07-06 07:02:25 -04002726extern int __must_check file_check_and_advance_wb_err(struct file *file);
2727extern int __must_check file_write_and_wait_range(struct file *file,
2728 loff_t start, loff_t end);
2729
Jeff Laytona823e452017-07-28 07:24:43 -04002730static inline int file_write_and_wait(struct file *file)
2731{
2732 return file_write_and_wait_range(file, 0, LLONG_MAX);
2733}
2734
Jeff Layton5660e132017-07-06 07:02:25 -04002735/**
2736 * filemap_set_wb_err - set a writeback error on an address_space
2737 * @mapping: mapping in which to set writeback error
2738 * @err: error to be set in mapping
2739 *
2740 * When writeback fails in some way, we must record that error so that
2741 * userspace can be informed when fsync and the like are called. We endeavor
2742 * to report errors on any file that was open at the time of the error. Some
2743 * internal callers also need to know when writeback errors have occurred.
2744 *
2745 * When a writeback error occurs, most filesystems will want to call
2746 * filemap_set_wb_err to record the error in the mapping so that it will be
2747 * automatically reported whenever fsync is called on the file.
Jeff Layton5660e132017-07-06 07:02:25 -04002748 */
2749static inline void filemap_set_wb_err(struct address_space *mapping, int err)
2750{
2751 /* Fastpath for common case of no error */
2752 if (unlikely(err))
2753 __filemap_set_wb_err(mapping, err);
2754}
2755
2756/**
2757 * filemap_check_wb_error - has an error occurred since the mark was sampled?
2758 * @mapping: mapping to check for writeback errors
2759 * @since: previously-sampled errseq_t
2760 *
2761 * Grab the errseq_t value from the mapping, and see if it has changed "since"
2762 * the given value was sampled.
2763 *
2764 * If it has then report the latest error set, otherwise return 0.
2765 */
2766static inline int filemap_check_wb_err(struct address_space *mapping,
2767 errseq_t since)
2768{
2769 return errseq_check(&mapping->wb_err, since);
2770}
2771
2772/**
2773 * filemap_sample_wb_err - sample the current errseq_t to test for later errors
2774 * @mapping: mapping to be sampled
2775 *
2776 * Writeback errors are always reported relative to a particular sample point
2777 * in the past. This function provides those sample points.
2778 */
2779static inline errseq_t filemap_sample_wb_err(struct address_space *mapping)
2780{
2781 return errseq_sample(&mapping->wb_err);
2782}
2783
Christoph Hellwig8018ab02010-03-22 17:32:25 +01002784extern int vfs_fsync_range(struct file *file, loff_t start, loff_t end,
2785 int datasync);
2786extern int vfs_fsync(struct file *file, int datasync);
Christoph Hellwige2592212016-04-07 08:52:01 -07002787
Jens Axboe22f96b32019-04-09 14:51:48 -06002788extern int sync_file_range(struct file *file, loff_t offset, loff_t nbytes,
2789 unsigned int flags);
2790
Christoph Hellwige2592212016-04-07 08:52:01 -07002791/*
2792 * Sync the bytes written if this was a synchronous write. Expect ki_pos
2793 * to already be updated for the write, and will return either the amount
2794 * of bytes passed in, or an error if syncing the file failed.
2795 */
2796static inline ssize_t generic_write_sync(struct kiocb *iocb, ssize_t count)
Al Virod311d792014-02-09 15:18:09 -05002797{
Christoph Hellwige2592212016-04-07 08:52:01 -07002798 if (iocb->ki_flags & IOCB_DSYNC) {
2799 int ret = vfs_fsync_range(iocb->ki_filp,
2800 iocb->ki_pos - count, iocb->ki_pos - 1,
2801 (iocb->ki_flags & IOCB_SYNC) ? 0 : 1);
2802 if (ret)
2803 return ret;
2804 }
2805
2806 return count;
Al Virod311d792014-02-09 15:18:09 -05002807}
Christoph Hellwige2592212016-04-07 08:52:01 -07002808
Linus Torvalds1da177e2005-04-16 15:20:36 -07002809extern void emergency_sync(void);
2810extern void emergency_remount(void);
David Howells93614012006-09-30 20:45:40 +02002811#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002812extern sector_t bmap(struct inode *, sector_t);
David Howells93614012006-09-30 20:45:40 +02002813#endif
J. Bruce Fields27ac0ff2011-09-20 17:19:26 -04002814extern int notify_change(struct dentry *, struct iattr *, struct inode **);
Al Virof419a2e2008-07-22 00:07:17 -04002815extern int inode_permission(struct inode *, int);
Al Viro2830ba72011-06-20 19:16:29 -04002816extern int generic_permission(struct inode *, int);
Miklos Szeredicbdf35b2014-10-24 00:14:36 +02002817extern int __check_sticky(struct inode *dir, struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002818
Miklos Szeredif696a362008-07-31 13:41:58 +02002819static inline bool execute_ok(struct inode *inode)
2820{
2821 return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
2822}
2823
Al Viro8d71db42013-03-19 21:01:03 -04002824static inline void file_start_write(struct file *file)
2825{
2826 if (!S_ISREG(file_inode(file)->i_mode))
2827 return;
2828 __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, true);
2829}
2830
Jan Kara5ae98f12013-05-04 00:11:23 +02002831static inline bool file_start_write_trylock(struct file *file)
2832{
2833 if (!S_ISREG(file_inode(file)->i_mode))
2834 return true;
2835 return __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, false);
2836}
2837
Al Viro8d71db42013-03-19 21:01:03 -04002838static inline void file_end_write(struct file *file)
2839{
2840 if (!S_ISREG(file_inode(file)->i_mode))
2841 return;
2842 __sb_end_write(file_inode(file)->i_sb, SB_FREEZE_WRITE);
2843}
2844
Al Viro07b8ce12011-06-20 10:52:57 -04002845/*
2846 * get_write_access() gets write permission for a file.
2847 * put_write_access() releases this write permission.
2848 * This is used for regular files.
2849 * We cannot support write (and maybe mmap read-write shared) accesses and
2850 * MAP_DENYWRITE mmappings simultaneously. The i_writecount field of an inode
2851 * can have the following values:
2852 * 0: no writers, no VM_DENYWRITE mappings
2853 * < 0: (-i_writecount) vm_area_structs with VM_DENYWRITE set exist
2854 * > 0: (i_writecount) users are writing to the file.
2855 *
2856 * Normally we operate on that counter with atomic_{inc,dec} and it's safe
2857 * except for the cases where we don't hold i_writecount yet. Then we need to
2858 * use {get,deny}_write_access() - these functions check the sign and refuse
2859 * to do the change if sign is wrong.
2860 */
2861static inline int get_write_access(struct inode *inode)
2862{
2863 return atomic_inc_unless_negative(&inode->i_writecount) ? 0 : -ETXTBSY;
2864}
2865static inline int deny_write_access(struct file *file)
2866{
Al Viro496ad9a2013-01-23 17:07:38 -05002867 struct inode *inode = file_inode(file);
Al Viro07b8ce12011-06-20 10:52:57 -04002868 return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
2869}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002870static inline void put_write_access(struct inode * inode)
2871{
2872 atomic_dec(&inode->i_writecount);
2873}
2874static inline void allow_write_access(struct file *file)
2875{
2876 if (file)
Al Viro496ad9a2013-01-23 17:07:38 -05002877 atomic_inc(&file_inode(file)->i_writecount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002878}
David Howellsf1fe29b2013-09-27 11:20:03 +01002879static inline bool inode_is_open_for_write(const struct inode *inode)
2880{
2881 return atomic_read(&inode->i_writecount) > 0;
2882}
2883
Amir Goldstein387e3742019-06-07 17:24:38 +03002884#if defined(CONFIG_IMA) || defined(CONFIG_FILE_LOCKING)
Mimi Zohara5c96eb2010-11-02 10:11:37 -04002885static inline void i_readcount_dec(struct inode *inode)
2886{
2887 BUG_ON(!atomic_read(&inode->i_readcount));
2888 atomic_dec(&inode->i_readcount);
2889}
2890static inline void i_readcount_inc(struct inode *inode)
2891{
2892 atomic_inc(&inode->i_readcount);
2893}
2894#else
2895static inline void i_readcount_dec(struct inode *inode)
2896{
2897 return;
2898}
2899static inline void i_readcount_inc(struct inode *inode)
2900{
2901 return;
2902}
2903#endif
Ulrich Dreppered8cae82008-07-23 21:29:30 -07002904extern int do_pipe_flags(int *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002905
Mimi Zohar1284ab52016-04-20 15:46:27 -07002906#define __kernel_read_file_id(id) \
2907 id(UNKNOWN, unknown) \
2908 id(FIRMWARE, firmware) \
Stephen Boyda098ecd2016-08-02 14:04:28 -07002909 id(FIRMWARE_PREALLOC_BUFFER, firmware) \
Mimi Zohar1284ab52016-04-20 15:46:27 -07002910 id(MODULE, kernel-module) \
2911 id(KEXEC_IMAGE, kexec-image) \
2912 id(KEXEC_INITRAMFS, kexec-initramfs) \
2913 id(POLICY, security-policy) \
Christoph Hellwiga7d3d032017-09-10 09:49:45 +02002914 id(X509_CERTIFICATE, x509-certificate) \
Mimi Zohar1284ab52016-04-20 15:46:27 -07002915 id(MAX_ID, )
2916
2917#define __fid_enumify(ENUM, dummy) READING_ ## ENUM,
2918#define __fid_stringify(dummy, str) #str,
2919
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05002920enum kernel_read_file_id {
Mimi Zohar1284ab52016-04-20 15:46:27 -07002921 __kernel_read_file_id(__fid_enumify)
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05002922};
2923
Mimi Zohar1284ab52016-04-20 15:46:27 -07002924static const char * const kernel_read_file_str[] = {
2925 __kernel_read_file_id(__fid_stringify)
2926};
2927
Kees Cookda20dfe2016-04-21 12:53:29 -07002928static inline const char *kernel_read_file_id_str(enum kernel_read_file_id id)
Mimi Zohar1284ab52016-04-20 15:46:27 -07002929{
Arnd Bergmanncbfd0c12017-03-09 16:16:57 -08002930 if ((unsigned)id >= READING_MAX_ID)
Mimi Zohar1284ab52016-04-20 15:46:27 -07002931 return kernel_read_file_str[READING_UNKNOWN];
2932
2933 return kernel_read_file_str[id];
2934}
2935
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05002936extern int kernel_read_file(struct file *, void **, loff_t *, loff_t,
2937 enum kernel_read_file_id);
Mimi Zohar711aab12017-09-12 22:45:33 -04002938extern int kernel_read_file_from_path(const char *, void **, loff_t *, loff_t,
Mimi Zohar09596b92015-11-19 12:39:22 -05002939 enum kernel_read_file_id);
Mimi Zoharb844f0e2016-02-01 08:36:21 -05002940extern int kernel_read_file_from_fd(int, void **, loff_t *, loff_t,
2941 enum kernel_read_file_id);
Christoph Hellwigbdd1d2d2017-09-01 17:39:13 +02002942extern ssize_t kernel_read(struct file *, void *, size_t, loff_t *);
Christoph Hellwige13ec932017-09-01 17:39:14 +02002943extern ssize_t kernel_write(struct file *, const void *, size_t, loff_t *);
Christoph Hellwig73e18f72017-09-01 17:39:15 +02002944extern ssize_t __kernel_write(struct file *, const void *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002945extern struct file * open_exec(const char *);
2946
2947/* fs/dcache.c -- generic fs support functions */
Yaowei Baia6e57872015-11-17 14:40:11 +08002948extern bool is_subdir(struct dentry *, struct dentry *);
Mickaël Salaün640eb7e2016-11-14 22:14:35 +01002949extern bool path_is_under(const struct path *, const struct path *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002950
Miklos Szeredi9bf39ab2015-06-19 10:29:13 +02002951extern char *file_path(struct file *, char *, int);
2952
Linus Torvalds1da177e2005-04-16 15:20:36 -07002953#include <linux/err.h>
2954
2955/* needed for stackable file system support */
Andrew Morton965c8e52012-12-17 15:59:39 -08002956extern loff_t default_llseek(struct file *file, loff_t offset, int whence);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002957
Andrew Morton965c8e52012-12-17 15:59:39 -08002958extern loff_t vfs_llseek(struct file *file, loff_t offset, int whence);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002959
Christoph Hellwig54e34622009-08-07 14:38:25 -03002960extern int inode_init_always(struct super_block *, struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002961extern void inode_init_once(struct inode *);
Miklos Szeredi2aa15892011-02-23 13:49:47 +01002962extern void address_space_init_once(struct address_space *mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002963extern struct inode * igrab(struct inode *);
2964extern ino_t iunique(struct super_block *, ino_t);
2965extern int inode_needs_sync(struct inode *inode);
Al Viro45321ac2010-06-07 13:43:19 -04002966extern int generic_delete_inode(struct inode *inode);
Al Viro9bcb4b72012-02-12 19:43:17 -05002967static inline int generic_drop_inode(struct inode *inode)
2968{
2969 return !inode->i_nlink || inode_unhashed(inode);
2970}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002971
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07002972extern struct inode *ilookup5_nowait(struct super_block *sb,
2973 unsigned long hashval, int (*test)(struct inode *, void *),
2974 void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002975extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
2976 int (*test)(struct inode *, void *), void *data);
2977extern struct inode *ilookup(struct super_block *sb, unsigned long ino);
2978
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02002979extern struct inode *inode_insert5(struct inode *inode, unsigned long hashval,
2980 int (*test)(struct inode *, void *),
2981 int (*set)(struct inode *, void *),
2982 void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002983extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *);
2984extern struct inode * iget_locked(struct super_block *, unsigned long);
Theodore Ts'ofe032c42015-02-02 00:37:01 -05002985extern struct inode *find_inode_nowait(struct super_block *,
2986 unsigned long,
2987 int (*match)(struct inode *,
2988 unsigned long, void *),
2989 void *data);
Al Viro261bca82008-12-30 01:48:21 -05002990extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
2991extern int insert_inode_locked(struct inode *);
Josh Boyere096d0c2011-08-25 07:48:12 -04002992#ifdef CONFIG_DEBUG_LOCK_ALLOC
2993extern void lockdep_annotate_inode_mutex_key(struct inode *inode);
2994#else
2995static inline void lockdep_annotate_inode_mutex_key(struct inode *inode) { };
2996#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002997extern void unlock_new_inode(struct inode *);
Al Viroc2b6d622018-06-28 15:53:17 -04002998extern void discard_new_inode(struct inode *);
Christoph Hellwig85fe4022010-10-23 11:19:54 -04002999extern unsigned int get_next_ino(void);
Darrick J. Wong799ea9e2017-08-18 18:08:25 -07003000extern void evict_inodes(struct super_block *sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003001
Linus Torvalds1da177e2005-04-16 15:20:36 -07003002extern void __iget(struct inode * inode);
David Howellsb46980f2008-02-07 00:15:27 -08003003extern void iget_failed(struct inode *);
Jan Karadbd57682012-05-03 14:48:02 +02003004extern void clear_inode(struct inode *);
Christoph Hellwig2e00c972009-08-07 14:38:29 -03003005extern void __destroy_inode(struct inode *);
Eric Dumazeta209dfc2011-07-26 11:36:34 +02003006extern struct inode *new_inode_pseudo(struct super_block *sb);
3007extern struct inode *new_inode(struct super_block *sb);
Nick Pigginff0c7d12011-01-07 17:49:50 +11003008extern void free_inode_nonrcu(struct inode *inode);
Jens Axboe01de85e2006-10-17 19:50:36 +02003009extern int should_remove_suid(struct dentry *);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02003010extern int file_remove_privs(struct file *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003011
3012extern void __insert_inode_hash(struct inode *, unsigned long hashval);
Christoph Hellwig646ec462010-10-23 07:15:32 -04003013static inline void insert_inode_hash(struct inode *inode)
3014{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003015 __insert_inode_hash(inode, inode->i_ino);
3016}
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +02003017
3018extern void __remove_inode_hash(struct inode *);
3019static inline void remove_inode_hash(struct inode *inode)
3020{
Josef Bacikcbedaac2015-03-12 08:19:11 -04003021 if (!inode_unhashed(inode) && !hlist_fake(&inode->i_hash))
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +02003022 __remove_inode_hash(inode);
3023}
3024
Christoph Hellwig646ec462010-10-23 07:15:32 -04003025extern void inode_sb_list_add(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003026
David Howells93614012006-09-30 20:45:40 +02003027#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07003028extern int bdev_read_only(struct block_device *);
David Howells93614012006-09-30 20:45:40 +02003029#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07003030extern int set_blocksize(struct block_device *, int);
3031extern int sb_set_blocksize(struct super_block *, int);
3032extern int sb_min_blocksize(struct super_block *, int);
3033
3034extern int generic_file_mmap(struct file *, struct vm_area_struct *);
3035extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
Al Viro3309dd02015-04-09 12:55:47 -04003036extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *);
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003037extern int generic_remap_checks(struct file *file_in, loff_t pos_in,
3038 struct file *file_out, loff_t pos_out,
Darrick J. Wong42ec3d42018-10-30 10:41:49 +11003039 loff_t *count, unsigned int remap_flags);
Amir Goldsteina3171352019-06-05 08:04:48 -07003040extern int generic_file_rw_checks(struct file *file_in, struct file *file_out);
Amir Goldstein96e6e8f2019-06-05 08:04:49 -07003041extern int generic_copy_file_checks(struct file *file_in, loff_t pos_in,
3042 struct file *file_out, loff_t pos_out,
3043 size_t *count, unsigned int flags);
Al Viroed978a82014-03-05 22:53:04 -05003044extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
Al Viro81742022014-04-03 03:17:43 -04003045extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
Al Viro81742022014-04-03 03:17:43 -04003046extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003047extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *);
Al Viro3b93f912014-02-11 21:34:08 -05003048extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t);
Andrew Morton88e6fae2006-04-11 13:59:36 +02003049
Christoph Hellwig18e97102017-05-27 11:16:51 +03003050ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos,
Christoph Hellwigddef7ed22017-07-06 18:58:37 +02003051 rwf_t flags);
Christoph Hellwigabbb65892017-05-27 11:16:52 +03003052ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos,
Christoph Hellwigddef7ed22017-07-06 18:58:37 +02003053 rwf_t flags);
Christoph Hellwigdbe4e192015-01-25 21:11:59 +01003054
Christoph Hellwigeef99382009-08-20 17:43:41 +02003055/* fs/block_dev.c */
David Jefferyb2de5252014-09-29 10:21:10 -04003056extern ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to);
Al Viro1456c0a2014-04-03 03:21:50 -04003057extern ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from);
Josef Bacik02c24a82011-07-16 20:44:56 -04003058extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
3059 int datasync);
Al Viroff01bb42011-09-16 02:31:11 -04003060extern void block_sync_page(struct page *page);
Christoph Hellwigeef99382009-08-20 17:43:41 +02003061
Andrew Morton88e6fae2006-04-11 13:59:36 +02003062/* fs/splice.c */
Jens Axboecbb7e572006-04-11 14:57:50 +02003063extern ssize_t generic_file_splice_read(struct file *, loff_t *,
Andrew Morton88e6fae2006-04-11 13:59:36 +02003064 struct pipe_inode_info *, size_t, unsigned int);
Al Viro8d020762014-04-05 04:27:08 -04003065extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
Jens Axboecbb7e572006-04-11 14:57:50 +02003066 struct file *, loff_t *, size_t, unsigned int);
Andrew Morton88e6fae2006-04-11 13:59:36 +02003067extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
Jens Axboecbb7e572006-04-11 14:57:50 +02003068 struct file *out, loff_t *, size_t len, unsigned int flags);
Miklos Szeredi1c118592014-10-24 00:14:35 +02003069extern long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
3070 loff_t *opos, size_t len, unsigned int flags);
3071
Andrew Morton88e6fae2006-04-11 13:59:36 +02003072
Linus Torvalds1da177e2005-04-16 15:20:36 -07003073extern void
3074file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
Andrew Morton965c8e52012-12-17 15:59:39 -08003075extern loff_t noop_llseek(struct file *file, loff_t offset, int whence);
3076extern loff_t no_llseek(struct file *file, loff_t offset, int whence);
Jie Liu46a1c2c2013-06-25 12:02:13 +08003077extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
Andrew Morton965c8e52012-12-17 15:59:39 -08003078extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
Andi Kleen57604952011-09-15 16:06:50 -07003079extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
Andrew Morton965c8e52012-12-17 15:59:39 -08003080 int whence, loff_t maxsize, loff_t eof);
Al Viro1bf9d142013-06-16 20:27:42 +04003081extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
3082 int whence, loff_t size);
Al Virob25472f2015-12-05 22:04:48 -05003083extern loff_t no_seek_end_llseek_size(struct file *, loff_t, int, loff_t);
3084extern loff_t no_seek_end_llseek(struct file *, loff_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003085extern int generic_file_open(struct inode * inode, struct file * filp);
3086extern int nonseekable_open(struct inode * inode, struct file * filp);
Kirill Smelkov10dce8a2019-03-26 22:20:43 +00003087extern int stream_open(struct inode * inode, struct file * filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003088
David Howells93614012006-09-30 20:45:40 +02003089#ifdef CONFIG_BLOCK
Mike Christie8a4c1e42016-06-05 14:31:50 -05003090typedef void (dio_submit_t)(struct bio *bio, struct inode *inode,
Josef Bacikfacd07b2010-05-23 11:00:55 -04003091 loff_t file_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003092
3093enum {
Christoph Hellwig1e431f52009-11-03 16:44:53 +01003094 /* need locking between buffered and direct access */
3095 DIO_LOCKING = 0x01,
3096
3097 /* filesystem does not support filling holes */
3098 DIO_SKIP_HOLES = 0x02,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003099};
3100
Christoph Hellwig40553512017-06-03 09:37:58 +02003101void dio_end_io(struct bio *bio);
Darrick J. Wong5a9d9292018-01-08 10:41:39 -08003102void dio_warn_stale_pagecache(struct file *filp);
npiggin@suse.de7bb46a62010-05-27 01:05:33 +10003103
Omar Sandoval17f8c842015-03-16 04:33:50 -07003104ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode,
3105 struct block_device *bdev, struct iov_iter *iter,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07003106 get_block_t get_block,
Omar Sandoval17f8c842015-03-16 04:33:50 -07003107 dio_iodone_t end_io, dio_submit_t submit_io,
3108 int flags);
Christoph Hellwigeafdc7d2010-06-04 11:29:53 +02003109
Omar Sandoval17f8c842015-03-16 04:33:50 -07003110static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
3111 struct inode *inode,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07003112 struct iov_iter *iter,
Omar Sandoval17f8c842015-03-16 04:33:50 -07003113 get_block_t get_block)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003114{
Omar Sandoval17f8c842015-03-16 04:33:50 -07003115 return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07003116 get_block, NULL, NULL, DIO_LOCKING | DIO_SKIP_HOLES);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003117}
David Howells93614012006-09-30 20:45:40 +02003118#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07003119
Trond Myklebust1d59d612012-05-31 12:22:33 -04003120void inode_dio_wait(struct inode *inode);
Jens Axboefe0f07d2015-04-15 17:05:48 -06003121
3122/*
3123 * inode_dio_begin - signal start of a direct I/O requests
3124 * @inode: inode the direct I/O happens on
3125 *
3126 * This is called once we've finished processing a direct I/O request,
3127 * and is used to wake up callers waiting for direct I/O to be quiesced.
3128 */
3129static inline void inode_dio_begin(struct inode *inode)
3130{
3131 atomic_inc(&inode->i_dio_count);
3132}
3133
3134/*
3135 * inode_dio_end - signal finish of a direct I/O requests
3136 * @inode: inode the direct I/O happens on
3137 *
3138 * This is called once we've finished processing a direct I/O request,
3139 * and is used to wake up callers waiting for direct I/O to be quiesced.
3140 */
3141static inline void inode_dio_end(struct inode *inode)
3142{
3143 if (atomic_dec_and_test(&inode->i_dio_count))
3144 wake_up_bit(&inode->i_state, __I_DIO_WAKEUP);
3145}
Trond Myklebust1d59d612012-05-31 12:22:33 -04003146
Theodore Ts'o5f16f322014-03-24 14:43:12 -04003147extern void inode_set_flags(struct inode *inode, unsigned int flags,
3148 unsigned int mask);
3149
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08003150extern const struct file_operations generic_ro_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003151
3152#define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))
3153
Al Viro5d826c82014-03-14 13:42:45 -04003154extern int readlink_copy(char __user *, int, const char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003155extern int page_readlink(struct dentry *, char __user *, int);
Al Virofceef392015-12-29 15:58:39 -05003156extern const char *page_get_link(struct dentry *, struct inode *,
3157 struct delayed_call *);
3158extern void page_put_link(void *);
Kirill Korotaev0adb25d2006-03-11 03:27:13 -08003159extern int __page_symlink(struct inode *inode, const char *symname, int len,
Nick Piggin54566b22009-01-04 12:00:53 -08003160 int nofs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003161extern int page_symlink(struct inode *inode, const char *symname, int len);
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08003162extern const struct inode_operations page_symlink_inode_operations;
Al Virofceef392015-12-29 15:58:39 -05003163extern void kfree_link(void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003164extern void generic_fillattr(struct inode *, struct kstat *);
David Howellsa528d352017-01-31 16:46:22 +00003165extern int vfs_getattr_nosec(const struct path *, struct kstat *, u32, unsigned int);
3166extern int vfs_getattr(const struct path *, struct kstat *, u32, unsigned int);
Dmitry Monakhovb4627072009-12-14 15:21:12 +03003167void __inode_add_bytes(struct inode *inode, loff_t bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003168void inode_add_bytes(struct inode *inode, loff_t bytes);
Jan Kara1c8924e2013-08-17 09:32:32 -04003169void __inode_sub_bytes(struct inode *inode, loff_t bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003170void inode_sub_bytes(struct inode *inode, loff_t bytes);
Jan Karaf4a8116a2017-08-08 09:54:36 +02003171static inline loff_t __inode_get_bytes(struct inode *inode)
3172{
3173 return (((loff_t)inode->i_blocks) << 9) + inode->i_bytes;
3174}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003175loff_t inode_get_bytes(struct inode *inode);
3176void inode_set_bytes(struct inode *inode, loff_t bytes);
Al Virofceef392015-12-29 15:58:39 -05003177const char *simple_get_link(struct dentry *, struct inode *,
3178 struct delayed_call *);
Al Viro61ba64f2015-05-02 09:54:06 -04003179extern const struct inode_operations simple_symlink_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003180
Al Viro5c0ba4e2013-05-15 13:52:59 -04003181extern int iterate_dir(struct file *, struct dir_context *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003182
David Howellsa528d352017-01-31 16:46:22 +00003183extern int vfs_statx(int, const char __user *, int, struct kstat *, u32);
3184extern int vfs_statx_fd(unsigned int, struct kstat *, u32, unsigned int);
3185
3186static inline int vfs_stat(const char __user *filename, struct kstat *stat)
3187{
David Howellsdeccf492017-05-04 23:30:16 +01003188 return vfs_statx(AT_FDCWD, filename, AT_NO_AUTOMOUNT,
3189 stat, STATX_BASIC_STATS);
David Howellsa528d352017-01-31 16:46:22 +00003190}
3191static inline int vfs_lstat(const char __user *name, struct kstat *stat)
3192{
David Howellsdeccf492017-05-04 23:30:16 +01003193 return vfs_statx(AT_FDCWD, name, AT_SYMLINK_NOFOLLOW | AT_NO_AUTOMOUNT,
David Howellsa528d352017-01-31 16:46:22 +00003194 stat, STATX_BASIC_STATS);
3195}
3196static inline int vfs_fstatat(int dfd, const char __user *filename,
3197 struct kstat *stat, int flags)
3198{
Ian Kent5d38f042017-11-29 16:11:26 -08003199 return vfs_statx(dfd, filename, flags | AT_NO_AUTOMOUNT,
3200 stat, STATX_BASIC_STATS);
David Howellsa528d352017-01-31 16:46:22 +00003201}
3202static inline int vfs_fstat(int fd, struct kstat *stat)
3203{
3204 return vfs_statx_fd(fd, stat, STATX_BASIC_STATS, 0);
3205}
3206
3207
Miklos Szeredid60874c2016-10-04 14:40:45 +02003208extern const char *vfs_get_link(struct dentry *, struct delayed_call *);
Miklos Szeredifd4a0ed2016-12-09 16:45:04 +01003209extern int vfs_readlink(struct dentry *, char __user *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003210
Steven Whitehousee9079cc2008-10-14 14:43:29 +01003211extern int __generic_block_fiemap(struct inode *inode,
Josef Bacik3a3076f2010-04-23 12:17:17 -04003212 struct fiemap_extent_info *fieinfo,
3213 loff_t start, loff_t len,
3214 get_block_t *get_block);
Josef Bacik68c9d702008-10-03 17:32:43 -04003215extern int generic_block_fiemap(struct inode *inode,
3216 struct fiemap_extent_info *fieinfo, u64 start,
3217 u64 len, get_block_t *get_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003218
David Howellsee416bc2017-07-04 17:25:16 +01003219extern struct file_system_type *get_filesystem(struct file_system_type *fs);
Miklos Szeredic18479f2007-10-18 23:39:11 -07003220extern void put_filesystem(struct file_system_type *fs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003221extern struct file_system_type *get_fs_type(const char *name);
3222extern struct super_block *get_super(struct block_device *);
Jan Kara6b6dc832012-02-10 11:03:00 +01003223extern struct super_block *get_super_thawed(struct block_device *);
Jan Karaba6379f2016-11-23 12:53:00 +01003224extern struct super_block *get_super_exclusive_thawed(struct block_device *bdev);
Christoph Hellwig45042302009-08-03 23:28:35 +02003225extern struct super_block *get_active_super(struct block_device *bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003226extern void drop_super(struct super_block *sb);
Jan Karaba6379f2016-11-23 12:53:00 +01003227extern void drop_super_exclusive(struct super_block *sb);
Al Viro01a05b32010-03-23 06:06:58 -04003228extern void iterate_supers(void (*)(struct super_block *, void *), void *);
Al Viro43e15cd2011-06-03 20:16:57 -04003229extern void iterate_supers_type(struct file_system_type *,
3230 void (*)(struct super_block *, void *), void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003231
3232extern int dcache_dir_open(struct inode *, struct file *);
3233extern int dcache_dir_close(struct inode *, struct file *);
3234extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
Al Viro5f99f4e2013-05-15 20:23:06 -04003235extern int dcache_readdir(struct file *, struct dir_context *);
npiggin@suse.de7bb46a62010-05-27 01:05:33 +10003236extern int simple_setattr(struct dentry *, struct iattr *);
David Howellsa528d352017-01-31 16:46:22 +00003237extern int simple_getattr(const struct path *, struct kstat *, u32, unsigned int);
David Howells726c3342006-06-23 02:02:58 -07003238extern int simple_statfs(struct dentry *, struct kstatfs *);
Stephen Boyd20955e82012-04-05 14:25:09 -07003239extern int simple_open(struct inode *inode, struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003240extern int simple_link(struct dentry *, struct inode *, struct dentry *);
3241extern int simple_unlink(struct inode *, struct dentry *);
3242extern int simple_rmdir(struct inode *, struct dentry *);
Miklos Szeredie0e0be82016-09-27 11:03:57 +02003243extern int simple_rename(struct inode *, struct dentry *,
3244 struct inode *, struct dentry *, unsigned int);
Josef Bacik02c24a82011-07-16 20:44:56 -04003245extern int noop_fsync(struct file *, loff_t, loff_t, int);
Dan Williamsf44c7762018-03-07 15:26:44 -08003246extern int noop_set_page_dirty(struct page *page);
3247extern void noop_invalidatepage(struct page *page, unsigned int offset,
3248 unsigned int length);
3249extern ssize_t noop_direct_IO(struct kiocb *iocb, struct iov_iter *iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003250extern int simple_empty(struct dentry *);
3251extern int simple_readpage(struct file *file, struct page *page);
Nick Pigginafddba42007-10-16 01:25:01 -07003252extern int simple_write_begin(struct file *file, struct address_space *mapping,
3253 loff_t pos, unsigned len, unsigned flags,
3254 struct page **pagep, void **fsdata);
3255extern int simple_write_end(struct file *file, struct address_space *mapping,
3256 loff_t pos, unsigned len, unsigned copied,
3257 struct page *page, void *fsdata);
Al Virob26d4cd2013-10-25 18:47:37 -04003258extern int always_delete_dentry(const struct dentry *);
Al Viro69878432013-10-02 22:35:11 -04003259extern struct inode *alloc_anon_inode(struct super_block *);
Jeff Laytone6f5c782014-08-22 10:40:25 -04003260extern int simple_nosetlease(struct file *, long, struct file_lock **, void **);
Al Virob26d4cd2013-10-25 18:47:37 -04003261extern const struct dentry_operations simple_dentry_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003262
Al Viro00cd8dd2012-06-10 17:13:09 -04003263extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003264extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08003265extern const struct file_operations simple_dir_operations;
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08003266extern const struct inode_operations simple_dir_inode_operations;
Eric W. Biedermanfbabfd02015-05-09 15:54:49 -05003267extern void make_empty_dir_inode(struct inode *inode);
3268extern bool is_empty_dir_inode(struct inode *inode);
Eric Biggerscda37122017-03-25 21:15:37 -07003269struct tree_descr { const char *name; const struct file_operations *ops; int mode; };
Linus Torvalds1da177e2005-04-16 15:20:36 -07003270struct dentry *d_alloc_name(struct dentry *, const char *);
Eric Biggerscda37122017-03-25 21:15:37 -07003271extern int simple_fill_super(struct super_block *, unsigned long,
3272 const struct tree_descr *);
Trond Myklebust1f5ce9e2006-06-09 09:34:16 -04003273extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003274extern void simple_release_fs(struct vfsmount **mount, int *count);
3275
Akinobu Mita93b07112008-06-05 22:46:21 -07003276extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
3277 loff_t *ppos, const void *from, size_t available);
Jiri Slaby6a727b42010-05-01 23:51:22 +02003278extern ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
3279 const void __user *from, size_t count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003280
Fabian Frederickac13a822014-06-04 16:06:27 -07003281extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
Josef Bacik02c24a82011-07-16 20:44:56 -04003282extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
Al Virod5aacad2009-06-07 14:56:44 -04003283
Patrick J. LoPresti30ca22c2010-07-22 15:03:41 -07003284extern int generic_check_addressable(unsigned, u64);
3285
Christoph Lametere965f962006-02-01 03:05:41 -08003286#ifdef CONFIG_MIGRATION
Christoph Lameter2d1db3b2006-06-23 02:03:33 -07003287extern int buffer_migrate_page(struct address_space *,
Mel Gormana6bc32b2012-01-12 17:19:43 -08003288 struct page *, struct page *,
3289 enum migrate_mode);
Jan Kara89cb0882018-12-28 00:39:12 -08003290extern int buffer_migrate_page_norefs(struct address_space *,
3291 struct page *, struct page *,
3292 enum migrate_mode);
Christoph Lametere965f962006-02-01 03:05:41 -08003293#else
3294#define buffer_migrate_page NULL
Jan Kara89cb0882018-12-28 00:39:12 -08003295#define buffer_migrate_page_norefs NULL
Christoph Lametere965f962006-02-01 03:05:41 -08003296#endif
3297
Jan Kara31051c82016-05-26 16:55:18 +02003298extern int setattr_prepare(struct dentry *, struct iattr *);
npiggin@suse.de25d9e2d2009-08-21 02:35:05 +10003299extern int inode_newsize_ok(const struct inode *, loff_t offset);
Christoph Hellwig6a1a90a2010-06-04 11:30:00 +02003300extern void setattr_copy(struct inode *inode, const struct iattr *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003301
Josef Bacikc3b2da32012-03-26 09:59:21 -04003302extern int file_update_time(struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003303
Matthew Wilcoxd475c632015-02-16 15:58:56 -08003304static inline bool io_is_direct(struct file *filp)
3305{
Dan Williams65f87ee2016-01-25 17:23:18 -08003306 return (filp->f_flags & O_DIRECT) || IS_DAX(filp->f_mapping->host);
Matthew Wilcoxd475c632015-02-16 15:58:56 -08003307}
3308
Dan Williamsbaabda22017-07-10 15:48:25 -07003309static inline bool vma_is_dax(struct vm_area_struct *vma)
3310{
3311 return vma->vm_file && IS_DAX(vma->vm_file->f_mapping->host);
3312}
3313
Dan Williams2bb6d282017-11-29 16:10:35 -08003314static inline bool vma_is_fsdax(struct vm_area_struct *vma)
3315{
3316 struct inode *inode;
3317
3318 if (!vma->vm_file)
3319 return false;
3320 if (!vma_is_dax(vma))
3321 return false;
3322 inode = file_inode(vma->vm_file);
Dan Williams230f5a82018-02-21 17:08:01 -08003323 if (S_ISCHR(inode->i_mode))
Dan Williams2bb6d282017-11-29 16:10:35 -08003324 return false; /* device-dax */
3325 return true;
3326}
3327
Al Viro2ba48ce2015-04-09 13:52:01 -04003328static inline int iocb_flags(struct file *file)
3329{
3330 int res = 0;
3331 if (file->f_flags & O_APPEND)
3332 res |= IOCB_APPEND;
3333 if (io_is_direct(file))
3334 res |= IOCB_DIRECT;
Christoph Hellwigdde0c2e2016-04-07 08:52:00 -07003335 if ((file->f_flags & O_DSYNC) || IS_SYNC(file->f_mapping->host))
3336 res |= IOCB_DSYNC;
3337 if (file->f_flags & __O_SYNC)
3338 res |= IOCB_SYNC;
Al Viro2ba48ce2015-04-09 13:52:01 -04003339 return res;
3340}
3341
Christoph Hellwigddef7ed22017-07-06 18:58:37 +02003342static inline int kiocb_set_rw_flags(struct kiocb *ki, rwf_t flags)
Goldwyn Rodriguesfdd2f5b2017-06-20 07:05:40 -05003343{
3344 if (unlikely(flags & ~RWF_SUPPORTED))
3345 return -EOPNOTSUPP;
3346
Goldwyn Rodriguesb745faf2017-06-20 07:05:43 -05003347 if (flags & RWF_NOWAIT) {
Christoph Hellwig91f99432017-08-29 16:13:20 +02003348 if (!(ki->ki_filp->f_mode & FMODE_NOWAIT))
Goldwyn Rodriguesb745faf2017-06-20 07:05:43 -05003349 return -EOPNOTSUPP;
3350 ki->ki_flags |= IOCB_NOWAIT;
3351 }
Goldwyn Rodriguesfdd2f5b2017-06-20 07:05:40 -05003352 if (flags & RWF_HIPRI)
3353 ki->ki_flags |= IOCB_HIPRI;
3354 if (flags & RWF_DSYNC)
3355 ki->ki_flags |= IOCB_DSYNC;
3356 if (flags & RWF_SYNC)
3357 ki->ki_flags |= (IOCB_DSYNC | IOCB_SYNC);
Jürg Billetere1fc7422017-09-29 14:07:17 +02003358 if (flags & RWF_APPEND)
3359 ki->ki_flags |= IOCB_APPEND;
Goldwyn Rodriguesfdd2f5b2017-06-20 07:05:40 -05003360 return 0;
3361}
3362
Linus Torvalds1da177e2005-04-16 15:20:36 -07003363static inline ino_t parent_ino(struct dentry *dentry)
3364{
3365 ino_t res;
3366
Nick Pigginb5c84bf2011-01-07 17:49:38 +11003367 /*
3368 * Don't strictly need d_lock here? If the parent ino could change
3369 * then surely we'd have a deeper race in the caller?
3370 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003371 spin_lock(&dentry->d_lock);
3372 res = dentry->d_parent->d_inode->i_ino;
3373 spin_unlock(&dentry->d_lock);
3374 return res;
3375}
3376
Linus Torvalds1da177e2005-04-16 15:20:36 -07003377/* Transaction based IO helpers */
3378
3379/*
3380 * An argresp is stored in an allocated page and holds the
3381 * size of the argument or response, along with its content
3382 */
3383struct simple_transaction_argresp {
3384 ssize_t size;
3385 char data[0];
3386};
3387
3388#define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))
3389
3390char *simple_transaction_get(struct file *file, const char __user *buf,
3391 size_t size);
3392ssize_t simple_transaction_read(struct file *file, char __user *buf,
3393 size_t size, loff_t *pos);
3394int simple_transaction_release(struct inode *inode, struct file *file);
3395
Ingo Molnar76791ab2009-03-25 16:48:35 +01003396void simple_transaction_set(struct file *file, size_t n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003397
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003398/*
3399 * simple attribute files
3400 *
3401 * These attributes behave similar to those in sysfs:
3402 *
3403 * Writing to an attribute immediately sets a value, an open file can be
3404 * written to multiple times.
3405 *
3406 * Reading from an attribute creates a buffer from the value that might get
3407 * read with multiple read calls. When the attribute has been read
3408 * completely, no further read calls are possible until the file is opened
3409 * again.
3410 *
3411 * All attributes contain a text representation of a numeric value
3412 * that are accessed with the get() and set() functions.
3413 */
3414#define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt) \
3415static int __fops ## _open(struct inode *inode, struct file *file) \
3416{ \
3417 __simple_attr_check_format(__fmt, 0ull); \
3418 return simple_attr_open(inode, file, __get, __set, __fmt); \
3419} \
Alexey Dobriyan828c0952009-10-01 15:43:56 -07003420static const struct file_operations __fops = { \
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003421 .owner = THIS_MODULE, \
3422 .open = __fops ## _open, \
Christoph Hellwig74bedc42008-02-08 04:20:28 -08003423 .release = simple_attr_release, \
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003424 .read = simple_attr_read, \
3425 .write = simple_attr_write, \
Arnd Bergmann1ec55842010-08-15 21:50:52 +02003426 .llseek = generic_file_llseek, \
Joe Perches68be3022014-08-06 16:08:45 -07003427}
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003428
Joe Perchesb9075fa2011-10-31 17:11:33 -07003429static inline __printf(1, 2)
3430void __simple_attr_check_format(const char *fmt, ...)
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003431{
3432 /* don't do anything, just let the compiler check the arguments; */
3433}
3434
3435int simple_attr_open(struct inode *inode, struct file *file,
Christoph Hellwig8b88b092008-02-08 04:20:26 -08003436 int (*get)(void *, u64 *), int (*set)(void *, u64),
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003437 const char *fmt);
Christoph Hellwig74bedc42008-02-08 04:20:28 -08003438int simple_attr_release(struct inode *inode, struct file *file);
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003439ssize_t simple_attr_read(struct file *file, char __user *buf,
3440 size_t len, loff_t *ppos);
3441ssize_t simple_attr_write(struct file *file, const char __user *buf,
3442 size_t len, loff_t *ppos);
3443
Alexey Dobriyan4be28542007-10-16 23:26:21 -07003444struct ctl_table;
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07003445int proc_nr_files(struct ctl_table *table, int write,
Adrian Bunk62239ac2007-07-17 04:03:45 -07003446 void __user *buffer, size_t *lenp, loff_t *ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04003447int proc_nr_dentry(struct ctl_table *table, int write,
3448 void __user *buffer, size_t *lenp, loff_t *ppos);
Dave Chinnercffbc8a2010-10-23 05:03:02 -04003449int proc_nr_inodes(struct ctl_table *table, int write,
3450 void __user *buffer, size_t *lenp, loff_t *ppos);
Tetsuo Handa38e23c92009-04-09 20:17:52 +09003451int __init get_filesystem_list(char *buf);
Adrian Bunk62239ac2007-07-17 04:03:45 -07003452
Namhyung Kim3cd90ea2011-02-01 15:52:46 -08003453#define __FMODE_EXEC ((__force int) FMODE_EXEC)
Namhyung Kim1a44bc82011-02-01 15:52:46 -08003454#define __FMODE_NONOTIFY ((__force int) FMODE_NONOTIFY)
3455
Al Viro6d125522009-12-24 06:58:56 -05003456#define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE])
Eric Parisecf081d2009-12-17 21:24:25 -05003457#define OPEN_FMODE(flag) ((__force fmode_t)(((flag + 1) & O_ACCMODE) | \
Namhyung Kim1a44bc82011-02-01 15:52:46 -08003458 (flag & __FMODE_NONOTIFY)))
Al Viro53009902009-12-19 10:15:07 -05003459
Yaowei Baid37177b2015-11-19 21:00:12 +08003460static inline bool is_sxid(umode_t mode)
Andi Kleen69b45732011-05-28 08:25:51 -07003461{
3462 return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
3463}
3464
Miklos Szeredicbdf35b2014-10-24 00:14:36 +02003465static inline int check_sticky(struct inode *dir, struct inode *inode)
3466{
3467 if (!(dir->i_mode & S_ISVTX))
3468 return 0;
3469
3470 return __check_sticky(dir, inode);
3471}
3472
Andi Kleen69b45732011-05-28 08:25:51 -07003473static inline void inode_has_no_xattr(struct inode *inode)
3474{
David Howellse462ec52017-07-17 08:45:35 +01003475 if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & SB_NOSEC))
Andi Kleen69b45732011-05-28 08:25:51 -07003476 inode->i_flags |= S_NOSEC;
3477}
3478
Al Viroa7400222014-10-21 15:20:42 -04003479static inline bool is_root_inode(struct inode *inode)
3480{
3481 return inode == inode->i_sb->s_root->d_inode;
3482}
3483
Al Viro5f99f4e2013-05-15 20:23:06 -04003484static inline bool dir_emit(struct dir_context *ctx,
3485 const char *name, int namelen,
3486 u64 ino, unsigned type)
3487{
3488 return ctx->actor(ctx, name, namelen, ctx->pos, ino, type) == 0;
3489}
3490static inline bool dir_emit_dot(struct file *file, struct dir_context *ctx)
3491{
3492 return ctx->actor(ctx, ".", 1, ctx->pos,
3493 file->f_path.dentry->d_inode->i_ino, DT_DIR) == 0;
3494}
3495static inline bool dir_emit_dotdot(struct file *file, struct dir_context *ctx)
3496{
3497 return ctx->actor(ctx, "..", 2, ctx->pos,
3498 parent_ino(file->f_path.dentry), DT_DIR) == 0;
3499}
3500static inline bool dir_emit_dots(struct file *file, struct dir_context *ctx)
3501{
3502 if (ctx->pos == 0) {
3503 if (!dir_emit_dot(file, ctx))
3504 return false;
3505 ctx->pos = 1;
3506 }
3507 if (ctx->pos == 1) {
3508 if (!dir_emit_dotdot(file, ctx))
3509 return false;
3510 ctx->pos = 2;
3511 }
3512 return true;
3513}
Al Viro5ded75e2013-05-15 21:02:48 -04003514static inline bool dir_relax(struct inode *inode)
3515{
Al Viro59551022016-01-22 15:40:57 -05003516 inode_unlock(inode);
3517 inode_lock(inode);
Al Viro5ded75e2013-05-15 21:02:48 -04003518 return !IS_DEADDIR(inode);
3519}
Al Viro5f99f4e2013-05-15 20:23:06 -04003520
Al Viroae053272016-05-12 20:36:01 -04003521static inline bool dir_relax_shared(struct inode *inode)
3522{
3523 inode_unlock_shared(inode);
3524 inode_lock_shared(inode);
3525 return !IS_DEADDIR(inode);
3526}
3527
Eric W. Biederman90f85722015-06-29 14:42:03 -05003528extern bool path_noexec(const struct path *path);
Al Viro21fc61c2015-11-17 01:07:57 -05003529extern void inode_nohighmem(struct inode *inode);
Eric W. Biederman90f85722015-06-29 14:42:03 -05003530
Amir Goldstein45cd0fa2018-08-27 15:56:02 +03003531/* mm/fadvise.c */
3532extern int vfs_fadvise(struct file *file, loff_t offset, loff_t len,
3533 int advice);
3534
Jens Axboe2b188cc2019-01-07 10:46:33 -07003535#if defined(CONFIG_IO_URING)
3536extern struct sock *io_uring_get_socket(struct file *file);
3537#else
3538static inline struct sock *io_uring_get_socket(struct file *file)
3539{
3540 return NULL;
3541}
3542#endif
3543
Darrick J. Wong5aca2842019-07-01 08:25:34 -07003544int vfs_ioc_setflags_prepare(struct inode *inode, unsigned int oldflags,
3545 unsigned int flags);
3546
Darrick J. Wong7b0e4922019-07-01 08:25:35 -07003547int vfs_ioc_fssetxattr_check(struct inode *inode, const struct fsxattr *old_fa,
3548 struct fsxattr *fa);
3549
3550static inline void simple_fill_fsxattr(struct fsxattr *fa, __u32 xflags)
3551{
3552 memset(fa, 0, sizeof(*fa));
3553 fa->fsx_xflags = xflags;
3554}
3555
Linus Torvalds1da177e2005-04-16 15:20:36 -07003556#endif /* _LINUX_FS_H */