blob: 9bf7a32f29328abaaea59d1234bc46e9f7c50b96 [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>
Nick Pigginceb5bdc2011-01-07 17:50:05 +110027#include <linux/rculist_bl.h>
Al Viro07b8ce12011-06-20 10:52:57 -040028#include <linux/atomic.h>
Konstantin Khlebnikov83aeead2011-12-08 14:33:54 -080029#include <linux/shrinker.h>
Stephen Rothwellc1aab022012-01-24 11:41:32 +110030#include <linux/migrate_mode.h>
Eric W. Biederman92361632012-02-08 07:07:50 -080031#include <linux/uidgid.h>
Jan Kara5accdf82012-06-12 16:20:34 +020032#include <linux/lockdep.h>
Jens Axboec2b1ad82012-09-27 09:35:03 +020033#include <linux/percpu-rwsem.h>
Oleg Nesterov853b39a2015-07-22 20:21:13 +020034#include <linux/workqueue.h>
Al Virofceef392015-12-29 15:58:39 -050035#include <linux/delayed_call.h>
Christoph Hellwig85787092017-05-10 15:06:33 +020036#include <linux/uuid.h>
Jeff Layton5660e132017-07-06 07:02:25 -040037#include <linux/errseq.h>
Adam Manzanaresd9a08a92018-05-22 10:52:19 -070038#include <linux/ioprio.h>
Phillip Potterbbe7449e2019-01-21 00:54:27 +000039#include <linux/fs_types.h>
Rasmus Villemoesf1fffbd2019-03-07 16:27:07 -080040#include <linux/build_bug.h>
41#include <linux/stddef.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
Linus Torvalds1da177e2005-04-16 15:20:36 -070043#include <asm/byteorder.h>
David Howells607ca462012-10-13 10:46:48 +010044#include <uapi/linux/fs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
Christoph Hellwigb83ae6d2015-01-14 10:42:37 +010046struct backing_dev_info;
Tejun Heo52ebea72015-05-22 17:13:37 -040047struct bdi_writeback;
Christoph Hellwig2f8b5442016-11-01 07:40:13 -060048struct bio;
Christoph Hellwiga5694252007-07-17 04:04:28 -070049struct export_operations;
Christoph Hellwig10c5db22020-05-23 09:30:11 +020050struct fiemap_extent_info;
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;
Eric Biggers5585f2a2019-07-22 09:26:21 -070067struct fsverity_info;
68struct fsverity_operations;
Al Virof3a09c92018-12-23 18:55:56 -050069struct fs_context;
Al Virod7167b12019-09-07 07:23:15 -040070struct fs_parameter_spec;
Linus Torvalds1da177e2005-04-16 15:20:36 -070071
Denis Cheng74bf17c2007-10-16 23:26:30 -070072extern void __init inode_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070073extern void __init inode_init_early(void);
Mel Gorman4248b0d2015-08-06 15:46:20 -070074extern void __init files_init(void);
75extern void __init files_maxfiles_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
Jan Engelhardtdded4f42008-12-01 14:34:50 -080077extern struct files_stat_struct files_stat;
Eric Dumazet518de9b2010-10-26 14:22:44 -070078extern unsigned long get_max_files(void);
Alexey Dobriyan9b80a182016-09-02 00:38:52 +030079extern unsigned int sysctl_nr_open;
Jan Engelhardtdded4f42008-12-01 14:34:50 -080080extern struct inodes_stat_t inodes_stat;
81extern int leases_enable, lease_break_time;
Kees Cook800179c2012-07-25 17:29:07 -070082extern int sysctl_protected_symlinks;
83extern int sysctl_protected_hardlinks;
Salvatore Mesoraca30aba662018-08-23 17:00:35 -070084extern int sysctl_protected_fifos;
85extern int sysctl_protected_regular;
Jan Engelhardtdded4f42008-12-01 14:34:50 -080086
Christoph Hellwigddef7ed22017-07-06 18:58:37 +020087typedef __kernel_rwf_t rwf_t;
88
Linus Torvalds1da177e2005-04-16 15:20:36 -070089struct buffer_head;
90typedef int (get_block_t)(struct inode *inode, sector_t iblock,
91 struct buffer_head *bh_result, int create);
Christoph Hellwig187372a2016-02-08 14:40:51 +110092typedef int (dio_iodone_t)(struct kiocb *iocb, loff_t offset,
Christoph Hellwig7b7a8662013-09-04 15:04:39 +020093 ssize_t bytes, void *private);
Linus Torvalds1da177e2005-04-16 15:20:36 -070094
David Howellsbbc10962012-10-15 16:40:35 +010095#define MAY_EXEC 0x00000001
96#define MAY_WRITE 0x00000002
97#define MAY_READ 0x00000004
98#define MAY_APPEND 0x00000008
99#define MAY_ACCESS 0x00000010
100#define MAY_OPEN 0x00000020
101#define MAY_CHDIR 0x00000040
102/* called from RCU mode, don't block */
103#define MAY_NOT_BLOCK 0x00000080
104
105/*
106 * flags in file.f_mode. Note that FMODE_READ and FMODE_WRITE must correspond
Li Qiang75abe322018-05-17 19:01:03 -0700107 * to O_WRONLY and O_RDWR via the strange trick in do_dentry_open()
David Howellsbbc10962012-10-15 16:40:35 +0100108 */
109
110/* file is open for reading */
111#define FMODE_READ ((__force fmode_t)0x1)
112/* file is open for writing */
113#define FMODE_WRITE ((__force fmode_t)0x2)
114/* file is seekable */
115#define FMODE_LSEEK ((__force fmode_t)0x4)
116/* file can be accessed using pread */
117#define FMODE_PREAD ((__force fmode_t)0x8)
118/* file can be accessed using pwrite */
119#define FMODE_PWRITE ((__force fmode_t)0x10)
120/* File is opened for execution with sys_execve / sys_uselib */
121#define FMODE_EXEC ((__force fmode_t)0x20)
122/* File is opened with O_NDELAY (only set for block devices) */
123#define FMODE_NDELAY ((__force fmode_t)0x40)
124/* File is opened with O_EXCL (only set for block devices) */
125#define FMODE_EXCL ((__force fmode_t)0x80)
126/* File is opened using open(.., 3, ..) and is writeable only for ioctls
127 (specialy hack for floppy.c) */
128#define FMODE_WRITE_IOCTL ((__force fmode_t)0x100)
129/* 32bit hashes as llseek() offset (for directories) */
130#define FMODE_32BITHASH ((__force fmode_t)0x200)
131/* 64bit hashes as llseek() offset (for directories) */
132#define FMODE_64BITHASH ((__force fmode_t)0x400)
133
134/*
135 * Don't update ctime and mtime.
136 *
137 * Currently a special hack for the XFS open_by_handle ioctl, but we'll
138 * hopefully graduate it to a proper O_CMTIME flag supported by open(2) soon.
139 */
140#define FMODE_NOCMTIME ((__force fmode_t)0x800)
141
142/* Expect random access pattern */
143#define FMODE_RANDOM ((__force fmode_t)0x1000)
144
145/* File is huge (eg. /dev/kmem): treat loff_t as unsigned */
146#define FMODE_UNSIGNED_OFFSET ((__force fmode_t)0x2000)
147
148/* File is opened with O_PATH; almost nothing can be done with it */
149#define FMODE_PATH ((__force fmode_t)0x4000)
150
Linus Torvalds2be7d342019-11-26 11:34:06 -0800151/* File needs atomic accesses to f_pos */
152#define FMODE_ATOMIC_POS ((__force fmode_t)0x8000)
Al Viro83f936c2014-03-14 12:02:47 -0400153/* Write access to underlying fs */
154#define FMODE_WRITER ((__force fmode_t)0x10000)
Al Viro7f7f25e2014-02-11 17:49:24 -0500155/* Has read method(s) */
156#define FMODE_CAN_READ ((__force fmode_t)0x20000)
157/* Has write method(s) */
158#define FMODE_CAN_WRITE ((__force fmode_t)0x40000)
Linus Torvalds9c225f22014-03-03 09:36:58 -0800159
Al Virof5d11402018-07-09 02:35:08 -0400160#define FMODE_OPENED ((__force fmode_t)0x80000)
Al Viro73a09dd2018-06-08 13:22:02 -0400161#define FMODE_CREATED ((__force fmode_t)0x100000)
Al Virof5d11402018-07-09 02:35:08 -0400162
Kirill Smelkov10dce8a2019-03-26 22:20:43 +0000163/* File is stream-like */
164#define FMODE_STREAM ((__force fmode_t)0x200000)
165
David Howellsbbc10962012-10-15 16:40:35 +0100166/* File was opened by fanotify and shouldn't generate fanotify events */
David Drysdale75069f22015-01-08 14:32:29 -0800167#define FMODE_NONOTIFY ((__force fmode_t)0x4000000)
David Howellsbbc10962012-10-15 16:40:35 +0100168
Christoph Hellwig91f99432017-08-29 16:13:20 +0200169/* File is capable of returning -EAGAIN if I/O will block */
Al Viroa07b2002018-11-05 17:40:30 +0000170#define FMODE_NOWAIT ((__force fmode_t)0x8000000)
171
172/* File represents mount that needs unmounting */
173#define FMODE_NEED_UNMOUNT ((__force fmode_t)0x10000000)
Goldwyn Rodriguesb745faf2017-06-20 07:05:43 -0500174
Miklos Szeredid3b10842018-07-18 15:44:40 +0200175/* File does not contribute to nr_files count */
Al Viroa07b2002018-11-05 17:40:30 +0000176#define FMODE_NOACCOUNT ((__force fmode_t)0x20000000)
Miklos Szeredid3b10842018-07-18 15:44:40 +0200177
David Howellsbbc10962012-10-15 16:40:35 +0100178/*
179 * Flag for rw_copy_check_uvector and compat_rw_copy_check_uvector
180 * that indicates that they should check the contents of the iovec are
181 * valid, but not check the memory that the iovec elements
182 * points too.
183 */
184#define CHECK_IOVEC_ONLY -1
185
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186/*
187 * Attribute flags. These should be or-ed together to figure out what
188 * has been changed!
189 */
Miklos Szeredi9767d742008-07-01 15:01:26 +0200190#define ATTR_MODE (1 << 0)
191#define ATTR_UID (1 << 1)
192#define ATTR_GID (1 << 2)
193#define ATTR_SIZE (1 << 3)
194#define ATTR_ATIME (1 << 4)
195#define ATTR_MTIME (1 << 5)
196#define ATTR_CTIME (1 << 6)
197#define ATTR_ATIME_SET (1 << 7)
198#define ATTR_MTIME_SET (1 << 8)
199#define ATTR_FORCE (1 << 9) /* Not a change, but a change it */
Miklos Szeredi9767d742008-07-01 15:01:26 +0200200#define ATTR_KILL_SUID (1 << 11)
201#define ATTR_KILL_SGID (1 << 12)
202#define ATTR_FILE (1 << 13)
203#define ATTR_KILL_PRIV (1 << 14)
204#define ATTR_OPEN (1 << 15) /* Truncating from open(O_TRUNC) */
205#define ATTR_TIMES_SET (1 << 16)
Miklos Szeredif2b20f62016-09-16 12:44:20 +0200206#define ATTR_TOUCH (1 << 17)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207
208/*
Miklos Szeredi787fb6b2014-10-24 00:14:36 +0200209 * Whiteout is represented by a char device. The following constants define the
210 * mode and device number to use.
211 */
212#define WHITEOUT_MODE 0
213#define WHITEOUT_DEV 0
214
215/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 * This is the Inode Attributes structure, used for notify_change(). It
217 * uses the above definitions as flags, to know which values have changed.
218 * Also, in this manner, a Filesystem can look at only the values it cares
219 * about. Basically, these are the attributes that the VFS layer can
220 * request to change from the FS layer.
221 *
222 * Derek Atkins <warlord@MIT.EDU> 94-10-20
223 */
224struct iattr {
225 unsigned int ia_valid;
226 umode_t ia_mode;
Eric W. Biederman92361632012-02-08 07:07:50 -0800227 kuid_t ia_uid;
228 kgid_t ia_gid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 loff_t ia_size;
Deepa Dinamani95582b02018-05-08 19:36:02 -0700230 struct timespec64 ia_atime;
231 struct timespec64 ia_mtime;
232 struct timespec64 ia_ctime;
Miklos Szeredicc4e69d2005-11-07 00:59:49 -0800233
234 /*
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300235 * Not an attribute, but an auxiliary info for filesystems wanting to
Miklos Szeredicc4e69d2005-11-07 00:59:49 -0800236 * implement an ftruncate() like method. NOTE: filesystem should
237 * check for (ia_valid & ATTR_FILE), and not for (ia_file != NULL).
238 */
239 struct file *ia_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240};
241
242/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243 * Includes for diskquotas.
244 */
245#include <linux/quota.h>
246
Miklos Szeredi69c433e2014-10-24 00:14:39 +0200247/*
248 * Maximum number of layers of fs stack. Needs to be limited to
249 * prevent kernel stack overflow
250 */
251#define FILESYSTEM_MAX_STACK_DEPTH 2
252
Zach Brown994fc28c2005-12-15 14:28:17 -0800253/**
254 * enum positive_aop_returns - aop return codes with specific semantics
255 *
256 * @AOP_WRITEPAGE_ACTIVATE: Informs the caller that page writeback has
257 * completed, that the page is still locked, and
258 * should be considered active. The VM uses this hint
259 * to return the page to the active list -- it won't
260 * be a candidate for writeback again in the near
261 * future. Other callers must be careful to unlock
262 * the page if they get this return. Returned by
263 * writepage();
264 *
265 * @AOP_TRUNCATED_PAGE: The AOP method that was handed a locked page has
266 * unlocked it and the page might have been truncated.
267 * The caller should back up to acquiring a new page and
268 * trying again. The aop will be taking reasonable
269 * precautions not to livelock. If the caller held a page
270 * reference, it should drop it before retrying. Returned
Nick Piggin55144762007-10-16 01:25:26 -0700271 * by readpage().
Zach Brown994fc28c2005-12-15 14:28:17 -0800272 *
273 * address_space_operation functions return these large constants to indicate
274 * special semantics to the caller. These are much larger than the bytes in a
275 * page to allow for functions that return the number of bytes operated on in a
276 * given page.
277 */
278
279enum positive_aop_returns {
280 AOP_WRITEPAGE_ACTIVATE = 0x80000,
281 AOP_TRUNCATED_PAGE = 0x80001,
282};
283
Tetsuo Handac718a972017-05-08 15:58:59 -0700284#define AOP_FLAG_CONT_EXPAND 0x0001 /* called from cont_expand */
285#define AOP_FLAG_NOFS 0x0002 /* used by filesystem to direct
Nick Piggin54566b22009-01-04 12:00:53 -0800286 * helper code (eg buffer layer)
287 * to clear GFP_FS from alloc */
Nick Pigginafddba42007-10-16 01:25:01 -0700288
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289/*
290 * oh the beauties of C type declarations.
291 */
292struct page;
293struct address_space;
294struct writeback_control;
Matthew Wilcox (Oracle)8151b4c2020-06-01 21:46:44 -0700295struct readahead_control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296
Jens Axboec75b1d92017-06-27 11:47:04 -0600297/*
298 * Write life time hint values.
Amir Goldstein69448862018-07-05 09:25:43 +0300299 * Stored in struct inode as u8.
Jens Axboec75b1d92017-06-27 11:47:04 -0600300 */
301enum rw_hint {
302 WRITE_LIFE_NOT_SET = 0,
303 WRITE_LIFE_NONE = RWH_WRITE_LIFE_NONE,
304 WRITE_LIFE_SHORT = RWH_WRITE_LIFE_SHORT,
305 WRITE_LIFE_MEDIUM = RWH_WRITE_LIFE_MEDIUM,
306 WRITE_LIFE_LONG = RWH_WRITE_LIFE_LONG,
307 WRITE_LIFE_EXTREME = RWH_WRITE_LIFE_EXTREME,
308};
309
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800310#define IOCB_EVENTFD (1 << 0)
Al Viro2ba48ce2015-04-09 13:52:01 -0400311#define IOCB_APPEND (1 << 1)
312#define IOCB_DIRECT (1 << 2)
Christoph Hellwig97be7eb2016-03-03 16:04:01 +0100313#define IOCB_HIPRI (1 << 3)
Christoph Hellwigdde0c2e2016-04-07 08:52:00 -0700314#define IOCB_DSYNC (1 << 4)
315#define IOCB_SYNC (1 << 5)
Jan Kara70fe2f42016-10-30 11:42:04 -0500316#define IOCB_WRITE (1 << 6)
Goldwyn Rodriguesb745faf2017-06-20 07:05:43 -0500317#define IOCB_NOWAIT (1 << 7)
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800318
319struct kiocb {
320 struct file *ki_filp;
Linus Torvalds84c4e1f82019-03-03 14:23:33 -0800321
322 /* The 'ki_filp' pointer is shared in a union for aio */
323 randomized_struct_fields_start
324
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800325 loff_t ki_pos;
326 void (*ki_complete)(struct kiocb *iocb, long ret, long ret2);
327 void *private;
328 int ki_flags;
Adam Manzanaresfc287242018-05-22 10:52:18 -0700329 u16 ki_hint;
Adam Manzanaresd9a08a92018-05-22 10:52:19 -0700330 u16 ki_ioprio; /* See linux/ioprio.h */
Christoph Hellwigfb7e1602018-11-22 16:37:38 +0100331 unsigned int ki_cookie; /* for ->iopoll */
Linus Torvalds84c4e1f82019-03-03 14:23:33 -0800332
333 randomized_struct_fields_end
334};
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800335
336static inline bool is_sync_kiocb(struct kiocb *kiocb)
337{
338 return kiocb->ki_complete == NULL;
339}
340
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -0700341/*
342 * "descriptor" for what we're up to with a read.
343 * This allows us to use the same read code yet
344 * have multiple different users of the data that
345 * we read from a file.
346 *
347 * The simplest case just copies the data to user
348 * mode.
349 */
350typedef struct {
351 size_t written;
352 size_t count;
353 union {
354 char __user *buf;
355 void *data;
356 } arg;
357 int error;
358} read_descriptor_t;
359
360typedef int (*read_actor_t)(read_descriptor_t *, struct page *,
361 unsigned long, unsigned long);
Nick Piggin2f718ff2007-10-16 01:24:59 -0700362
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363struct address_space_operations {
364 int (*writepage)(struct page *page, struct writeback_control *wbc);
365 int (*readpage)(struct file *, struct page *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366
367 /* Write back some dirty pages from this mapping. */
368 int (*writepages)(struct address_space *, struct writeback_control *);
369
Andrew Morton4741c9f2006-03-24 03:18:11 -0800370 /* Set a page dirty. Return true if this dirtied it */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 int (*set_page_dirty)(struct page *page);
372
Jens Axboe74c81642018-08-17 15:45:36 -0700373 /*
374 * Reads in the requested pages. Unlike ->readpage(), this is
375 * PURELY used for read-ahead!.
376 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 int (*readpages)(struct file *filp, struct address_space *mapping,
378 struct list_head *pages, unsigned nr_pages);
Matthew Wilcox (Oracle)8151b4c2020-06-01 21:46:44 -0700379 void (*readahead)(struct readahead_control *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380
Nick Pigginafddba42007-10-16 01:25:01 -0700381 int (*write_begin)(struct file *, struct address_space *mapping,
382 loff_t pos, unsigned len, unsigned flags,
383 struct page **pagep, void **fsdata);
384 int (*write_end)(struct file *, struct address_space *mapping,
385 loff_t pos, unsigned len, unsigned copied,
386 struct page *page, void *fsdata);
387
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 /* Unfortunately this kludge is needed for FIBMAP. Don't use it */
389 sector_t (*bmap)(struct address_space *, sector_t);
Lukas Czernerd47992f2013-05-21 23:17:23 -0400390 void (*invalidatepage) (struct page *, unsigned int, unsigned int);
Al Viro27496a82005-10-21 03:20:48 -0400391 int (*releasepage) (struct page *, gfp_t);
Linus Torvalds6072d132010-12-01 13:35:19 -0500392 void (*freepage)(struct page *);
Christoph Hellwigc8b8e322016-04-07 08:51:58 -0700393 ssize_t (*direct_IO)(struct kiocb *, struct iov_iter *iter);
Mel Gormanb969c4ab2012-01-12 17:19:34 -0800394 /*
Tang Chenef277c72013-07-08 16:00:21 -0700395 * migrate the contents of a page to the specified target. If
396 * migrate_mode is MIGRATE_ASYNC, it must not block.
Mel Gormanb969c4ab2012-01-12 17:19:34 -0800397 */
Christoph Lameter2d1db3b2006-06-23 02:03:33 -0700398 int (*migratepage) (struct address_space *,
Mel Gormana6bc32b2012-01-12 17:19:43 -0800399 struct page *, struct page *, enum migrate_mode);
Minchan Kimbda807d2016-07-26 15:23:05 -0700400 bool (*isolate_page)(struct page *, isolate_mode_t);
401 void (*putback_page)(struct page *);
Trond Myklebuste3db7692007-01-10 23:15:39 -0800402 int (*launder_page) (struct page *);
Al Viroc186afb42014-02-02 21:16:54 -0500403 int (*is_partially_uptodate) (struct page *, unsigned long,
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -0700404 unsigned long);
Mel Gormanb4597222013-07-03 15:02:05 -0700405 void (*is_dirty_writeback) (struct page *, bool *, bool *);
Andi Kleen25718732009-09-16 11:50:13 +0200406 int (*error_remove_page)(struct address_space *, struct page *);
Mel Gorman62c230b2012-07-31 16:44:55 -0700407
408 /* swapfile support */
Mel Gormana509bc12012-07-31 16:44:57 -0700409 int (*swap_activate)(struct swap_info_struct *sis, struct file *file,
410 sector_t *span);
411 void (*swap_deactivate)(struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412};
413
Jens Axboe7dcda1c2011-04-05 23:51:48 +0200414extern const struct address_space_operations empty_aops;
415
Nick Pigginafddba42007-10-16 01:25:01 -0700416/*
417 * pagecache_write_begin/pagecache_write_end must be used by general code
418 * to write into the pagecache.
419 */
420int pagecache_write_begin(struct file *, struct address_space *mapping,
421 loff_t pos, unsigned len, unsigned flags,
422 struct page **pagep, void **fsdata);
423
424int pagecache_write_end(struct file *, struct address_space *mapping,
425 loff_t pos, unsigned len, unsigned copied,
426 struct page *page, void *fsdata);
427
Matthew Wilcoxeb797a82018-03-05 22:46:03 -0500428/**
429 * struct address_space - Contents of a cacheable, mappable object.
430 * @host: Owner, either the inode or the block_device.
431 * @i_pages: Cached pages.
432 * @gfp_mask: Memory allocation flags to use for allocating pages.
433 * @i_mmap_writable: Number of VM_SHARED mappings.
Song Liu09d91cd2019-09-23 15:38:03 -0700434 * @nr_thps: Number of THPs in the pagecache (non-shmem only).
Matthew Wilcoxeb797a82018-03-05 22:46:03 -0500435 * @i_mmap: Tree of private and shared mappings.
436 * @i_mmap_rwsem: Protects @i_mmap and @i_mmap_writable.
437 * @nrpages: Number of page entries, protected by the i_pages lock.
438 * @nrexceptional: Shadow or DAX entries, protected by the i_pages lock.
439 * @writeback_index: Writeback starts here.
440 * @a_ops: Methods.
441 * @flags: Error bits and flags (AS_*).
442 * @wb_err: The most recent error which has occurred.
443 * @private_lock: For use by the owner of the address_space.
444 * @private_list: For use by the owner of the address_space.
445 * @private_data: For use by the owner of the address_space.
446 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447struct address_space {
Matthew Wilcoxeb797a82018-03-05 22:46:03 -0500448 struct inode *host;
449 struct xarray i_pages;
450 gfp_t gfp_mask;
451 atomic_t i_mmap_writable;
Song Liu09d91cd2019-09-23 15:38:03 -0700452#ifdef CONFIG_READ_ONLY_THP_FOR_FS
453 /* number of thp, only for non-shmem files */
454 atomic_t nr_thps;
455#endif
Matthew Wilcoxeb797a82018-03-05 22:46:03 -0500456 struct rb_root_cached i_mmap;
457 struct rw_semaphore i_mmap_rwsem;
458 unsigned long nrpages;
Ross Zwislerf9fe48b2016-01-22 15:10:40 -0800459 unsigned long nrexceptional;
Matthew Wilcoxeb797a82018-03-05 22:46:03 -0500460 pgoff_t writeback_index;
461 const struct address_space_operations *a_ops;
462 unsigned long flags;
Jeff Layton5660e132017-07-06 07:02:25 -0400463 errseq_t wb_err;
Matthew Wilcoxeb797a82018-03-05 22:46:03 -0500464 spinlock_t private_lock;
465 struct list_head private_list;
466 void *private_data;
Kees Cook3859a272016-10-28 01:22:25 -0700467} __attribute__((aligned(sizeof(long)))) __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 /*
469 * On most architectures that alignment is already the case; but
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300470 * must be enforced here for CRIS, to let the least significant bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 * of struct page's "mapping" pointer be used for PAGE_MAPPING_ANON.
472 */
Andi Kleen87192a22012-01-12 17:20:34 -0800473struct request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474
475struct block_device {
476 dev_t bd_dev; /* not a kdev_t - it's a search key */
Richard Kennedyf3ccfcd2011-03-22 16:33:56 -0700477 int bd_openers;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478 struct inode * bd_inode; /* will die */
Theodore Ts'o87d8fe12009-01-03 09:47:09 -0500479 struct super_block * bd_super;
Arjan van de Venc039e312006-03-23 03:00:28 -0800480 struct mutex bd_mutex; /* open/close mutex */
Tejun Heo6b4517a2010-04-07 18:53:59 +0900481 void * bd_claiming;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 void * bd_holder;
483 int bd_holders;
Tejun Heo77ea8872010-12-08 20:57:37 +0100484 bool bd_write_holder;
Jun'ichi Nomura641dc632006-03-27 01:17:57 -0800485#ifdef CONFIG_SYSFS
Tejun Heo49731ba2011-01-14 18:43:57 +0100486 struct list_head bd_holder_disks;
Jun'ichi Nomura641dc632006-03-27 01:17:57 -0800487#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 struct block_device * bd_contains;
489 unsigned bd_block_size;
Christoph Hellwigc2ee0702017-08-23 19:10:31 +0200490 u8 bd_partno;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 struct hd_struct * bd_part;
492 /* number of times partitions within this device have been opened. */
493 unsigned bd_part_count;
494 int bd_invalidated;
495 struct gendisk * bd_disk;
Andi Kleen87192a22012-01-12 17:20:34 -0800496 struct request_queue * bd_queue;
Jan Karab1d2dc562017-02-02 15:56:52 +0100497 struct backing_dev_info *bd_bdi;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 struct list_head bd_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 /*
500 * Private data. You must have bd_claim'ed the block_device
501 * to use this. NOTE: bd_claim allows an owner to claim
502 * the same device multiple times, the owner must take special
503 * care to not mess up bd_private for that case.
504 */
505 unsigned long bd_private;
Takashi Satofcccf502009-01-09 16:40:59 -0800506
507 /* The counter of freeze processes */
508 int bd_fsfreeze_count;
509 /* Mutex for freeze */
510 struct mutex bd_fsfreeze_mutex;
Kees Cook3859a272016-10-28 01:22:25 -0700511} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512
Matthew Wilcoxff9c7452017-11-22 11:41:23 -0500513/* XArray tags, for tagging dirty and writeback pages in the pagecache. */
514#define PAGECACHE_TAG_DIRTY XA_MARK_0
515#define PAGECACHE_TAG_WRITEBACK XA_MARK_1
516#define PAGECACHE_TAG_TOWRITE XA_MARK_2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517
Matthew Wilcoxff9c7452017-11-22 11:41:23 -0500518/*
519 * Returns true if any of the pages in the mapping are marked with the tag.
520 */
521static inline bool mapping_tagged(struct address_space *mapping, xa_mark_t tag)
522{
523 return xa_marked(&mapping->i_pages, tag);
524}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800526static inline void i_mmap_lock_write(struct address_space *mapping)
527{
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800528 down_write(&mapping->i_mmap_rwsem);
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800529}
530
Mike Kravetzc0d03812020-04-01 21:11:05 -0700531static inline int i_mmap_trylock_write(struct address_space *mapping)
532{
533 return down_write_trylock(&mapping->i_mmap_rwsem);
534}
535
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800536static inline void i_mmap_unlock_write(struct address_space *mapping)
537{
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800538 up_write(&mapping->i_mmap_rwsem);
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800539}
540
Davidlohr Bueso3dec0ba2014-12-12 16:54:27 -0800541static inline void i_mmap_lock_read(struct address_space *mapping)
542{
543 down_read(&mapping->i_mmap_rwsem);
544}
545
546static inline void i_mmap_unlock_read(struct address_space *mapping)
547{
548 up_read(&mapping->i_mmap_rwsem);
549}
550
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551/*
552 * Might pages of this file be mapped into userspace?
553 */
554static inline int mapping_mapped(struct address_space *mapping)
555{
Davidlohr Buesof808c132017-09-08 16:15:08 -0700556 return !RB_EMPTY_ROOT(&mapping->i_mmap.rb_root);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557}
558
559/*
560 * Might pages of this file have been modified in userspace?
561 * Note that i_mmap_writable counts all VM_SHARED vmas: do_mmap_pgoff
562 * marks vma as VM_SHARED if it is shared, and the file was opened for
563 * writing i.e. vma may be mprotected writable even if now readonly.
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700564 *
565 * If i_mmap_writable is negative, no new writable mappings are allowed. You
566 * can only deny writable mappings, if none exists right now.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 */
568static inline int mapping_writably_mapped(struct address_space *mapping)
569{
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700570 return atomic_read(&mapping->i_mmap_writable) > 0;
571}
572
573static inline int mapping_map_writable(struct address_space *mapping)
574{
575 return atomic_inc_unless_negative(&mapping->i_mmap_writable) ?
576 0 : -EPERM;
577}
578
579static inline void mapping_unmap_writable(struct address_space *mapping)
580{
581 atomic_dec(&mapping->i_mmap_writable);
582}
583
584static inline int mapping_deny_writable(struct address_space *mapping)
585{
586 return atomic_dec_unless_positive(&mapping->i_mmap_writable) ?
587 0 : -EBUSY;
588}
589
590static inline void mapping_allow_writable(struct address_space *mapping)
591{
592 atomic_inc(&mapping->i_mmap_writable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593}
594
595/*
596 * Use sequence counter to get consistent i_size on 32-bit processors.
597 */
598#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
599#include <linux/seqlock.h>
600#define __NEED_I_SIZE_ORDERED
601#define i_size_ordered_init(inode) seqcount_init(&inode->i_size_seqcount)
602#else
603#define i_size_ordered_init(inode) do { } while (0)
604#endif
605
Al Virof19d4a82009-06-08 19:50:45 -0400606struct posix_acl;
607#define ACL_NOT_CACHED ((void *)(-1))
Miklos Szeredi2a3a2a32016-09-01 11:11:59 +0200608#define ACL_DONT_CACHE ((void *)(-3))
Al Virof19d4a82009-06-08 19:50:45 -0400609
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100610static inline struct posix_acl *
611uncached_acl_sentinel(struct task_struct *task)
612{
613 return (void *)task + 1;
614}
615
616static inline bool
617is_uncached_acl(struct posix_acl *acl)
618{
619 return (long)acl & 1;
620}
621
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700622#define IOP_FASTPERM 0x0001
623#define IOP_LOOKUP 0x0002
624#define IOP_NOFOLLOW 0x0004
Andreas Gruenbacherd0a5b992016-09-29 17:48:39 +0200625#define IOP_XATTR 0x0008
Miklos Szeredi76fca902016-12-09 16:45:04 +0100626#define IOP_DEFAULT_READLINK 0x0010
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700627
Jan Kara9dd813c2017-03-14 12:31:02 +0100628struct fsnotify_mark_connector;
629
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700630/*
631 * Keep mostly read-only and often accessed (especially for
632 * the RCU path lookup and 'stat' data) fields at the beginning
633 * of the 'struct inode'
634 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635struct inode {
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100636 umode_t i_mode;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700637 unsigned short i_opflags;
Eric W. Biederman92361632012-02-08 07:07:50 -0800638 kuid_t i_uid;
639 kgid_t i_gid;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700640 unsigned int i_flags;
641
642#ifdef CONFIG_FS_POSIX_ACL
643 struct posix_acl *i_acl;
644 struct posix_acl *i_default_acl;
645#endif
646
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100647 const struct inode_operations *i_op;
648 struct super_block *i_sb;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700649 struct address_space *i_mapping;
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100650
Linus Torvalds13e12d12011-06-08 15:18:19 -0700651#ifdef CONFIG_SECURITY
652 void *i_security;
653#endif
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100654
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700655 /* Stat data, not accessed from path walking */
656 unsigned long i_ino;
Miklos Szeredia78ef702011-10-28 14:13:30 +0200657 /*
658 * Filesystems may only read i_nlink directly. They shall use the
659 * following functions for modification:
660 *
661 * (set|clear|inc|drop)_nlink
662 * inode_(inc|dec)_link_count
663 */
664 union {
665 const unsigned int i_nlink;
666 unsigned int __i_nlink;
667 };
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700668 dev_t i_rdev;
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700669 loff_t i_size;
Deepa Dinamani95582b02018-05-08 19:36:02 -0700670 struct timespec64 i_atime;
671 struct timespec64 i_mtime;
672 struct timespec64 i_ctime;
Theodore Ts'o6cdbb0e2011-10-29 08:24:18 -0400673 spinlock_t i_lock; /* i_blocks, i_bytes, maybe i_size */
674 unsigned short i_bytes;
Amir Goldstein69448862018-07-05 09:25:43 +0300675 u8 i_blkbits;
676 u8 i_write_hint;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700677 blkcnt_t i_blocks;
678
679#ifdef __NEED_I_SIZE_ORDERED
680 seqcount_t i_size_seqcount;
681#endif
682
683 /* Misc */
684 unsigned long i_state;
Al Viro9902af72016-04-15 15:08:36 -0400685 struct rw_semaphore i_rwsem;
Linus Torvalds13e12d12011-06-08 15:18:19 -0700686
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100687 unsigned long dirtied_when; /* jiffies of first dirtying */
Theodore Ts'oa2f48702015-03-17 12:23:19 -0400688 unsigned long dirtied_time_when;
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100689
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690 struct hlist_node i_hash;
Dave Chinnerc7f54082015-03-04 14:07:22 -0500691 struct list_head i_io_list; /* backing dev IO list */
Tejun Heo52ebea72015-05-22 17:13:37 -0400692#ifdef CONFIG_CGROUP_WRITEBACK
693 struct bdi_writeback *i_wb; /* the associated cgroup wb */
Tejun Heo2a814902015-05-28 14:50:51 -0400694
695 /* foreign inode detection, see wbc_detach_inode() */
696 int i_wb_frn_winner;
697 u16 i_wb_frn_avg_time;
698 u16 i_wb_frn_history;
Tejun Heo52ebea72015-05-22 17:13:37 -0400699#endif
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100700 struct list_head i_lru; /* inode LRU list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 struct list_head i_sb_list;
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700702 struct list_head i_wb_list; /* backing dev writeback list */
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100703 union {
Al Virob3d9b7a2012-06-09 13:51:19 -0400704 struct hlist_head i_dentry;
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100705 struct rcu_head i_rcu;
706 };
Jeff Laytonf02a9ad2017-12-21 07:45:44 -0500707 atomic64_t i_version;
Peter Zijlstra8019ad12020-03-04 11:28:31 +0100708 atomic64_t i_sequence; /* see futex */
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700709 atomic_t i_count;
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -0400710 atomic_t i_dio_count;
Theodore Ts'o6cdbb0e2011-10-29 08:24:18 -0400711 atomic_t i_writecount;
Amir Goldstein387e3742019-06-07 17:24:38 +0300712#if defined(CONFIG_IMA) || defined(CONFIG_FILE_LOCKING)
Mimi Zohard984ea62013-12-11 15:20:54 -0500713 atomic_t i_readcount; /* struct files open RO */
714#endif
Al Virofdb0da82019-04-10 14:43:44 -0400715 union {
716 const struct file_operations *i_fop; /* former ->i_op->default_file_ops */
717 void (*free_inode)(struct inode *);
718 };
Jeff Layton4a075e32015-01-16 15:05:54 -0500719 struct file_lock_context *i_flctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 struct address_space i_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721 struct list_head i_devices;
Theodore Ts'o4c154162006-09-27 01:50:47 -0700722 union {
723 struct pipe_inode_info *i_pipe;
Theodore Ts'oeaf796e2006-09-27 01:50:48 -0700724 struct block_device *i_bdev;
Theodore Ts'o577c4eb2006-09-27 01:50:49 -0700725 struct cdev *i_cdev;
Al Viro61ba64f2015-05-02 09:54:06 -0400726 char *i_link;
Al Viro84e710d2016-04-15 00:58:55 -0400727 unsigned i_dir_seq;
Theodore Ts'o4c154162006-09-27 01:50:47 -0700728 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729
730 __u32 i_generation;
731
Eric Paris3be25f42009-05-21 17:01:26 -0400732#ifdef CONFIG_FSNOTIFY
733 __u32 i_fsnotify_mask; /* all events this inode cares about */
Jan Kara08991e82017-02-01 09:21:58 +0100734 struct fsnotify_mark_connector __rcu *i_fsnotify_marks;
Robert Love0eeca282005-07-12 17:06:03 -0400735#endif
736
Chandan Rajendra643fa962018-12-12 15:20:12 +0530737#ifdef CONFIG_FS_ENCRYPTION
Jaegeuk Kim0b81d072015-05-15 16:26:10 -0700738 struct fscrypt_info *i_crypt_info;
739#endif
740
Eric Biggers5585f2a2019-07-22 09:26:21 -0700741#ifdef CONFIG_FS_VERITY
742 struct fsverity_info *i_verity_info;
743#endif
744
Theodore Ts'o8e18e292006-09-27 01:50:46 -0700745 void *i_private; /* fs or device private pointer */
Kees Cook3859a272016-10-28 01:22:25 -0700746} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747
Deepa Dinamani50e17c002018-01-21 18:04:25 -0800748struct timespec64 timestamp_truncate(struct timespec64 t, struct inode *inode);
749
Fabian Frederick93407472017-02-27 14:28:32 -0800750static inline unsigned int i_blocksize(const struct inode *node)
751{
752 return (1 << node->i_blkbits);
753}
754
Al Viro1d3382cb2010-10-23 15:19:20 -0400755static inline int inode_unhashed(struct inode *inode)
756{
757 return hlist_unhashed(&inode->i_hash);
758}
759
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760/*
Al Viro5bef9152018-06-29 19:36:57 -0400761 * __mark_inode_dirty expects inodes to be hashed. Since we don't
762 * want special inodes in the fileset inode space, we make them
763 * appear hashed, but do not put on any lists. hlist_del()
764 * will work fine and require no locking.
765 */
766static inline void inode_fake_hash(struct inode *inode)
767{
768 hlist_add_fake(&inode->i_hash);
769}
770
771/*
Ingo Molnarf2eace22006-07-03 00:25:05 -0700772 * inode->i_mutex nesting subclasses for the lock validator:
773 *
774 * 0: the object of the current VFS operation
775 * 1: parent
776 * 2: child/target
J. Bruce Fields40bd22c2012-04-18 15:21:34 -0400777 * 3: xattr
778 * 4: second non-directory
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100779 * 5: second parent (when locking independent directories in rename)
780 *
781 * I_MUTEX_NONDIR2 is for certain operations (such as rename) which lock two
J. Bruce Fields40bd22c2012-04-18 15:21:34 -0400782 * non-directories at once.
Ingo Molnarf2eace22006-07-03 00:25:05 -0700783 *
784 * The locking order between these classes is
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100785 * parent[2] -> child -> grandchild -> normal -> xattr -> second non-directory
Ingo Molnarf2eace22006-07-03 00:25:05 -0700786 */
787enum inode_i_mutex_lock_class
788{
789 I_MUTEX_NORMAL,
790 I_MUTEX_PARENT,
791 I_MUTEX_CHILD,
Ingo Molnar4df46242006-08-27 01:23:56 -0700792 I_MUTEX_XATTR,
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100793 I_MUTEX_NONDIR2,
794 I_MUTEX_PARENT2,
Ingo Molnarf2eace22006-07-03 00:25:05 -0700795};
796
Al Viro59551022016-01-22 15:40:57 -0500797static inline void inode_lock(struct inode *inode)
798{
Al Viro9902af72016-04-15 15:08:36 -0400799 down_write(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500800}
801
802static inline void inode_unlock(struct inode *inode)
803{
Al Viro9902af72016-04-15 15:08:36 -0400804 up_write(&inode->i_rwsem);
805}
806
807static inline void inode_lock_shared(struct inode *inode)
808{
809 down_read(&inode->i_rwsem);
810}
811
812static inline void inode_unlock_shared(struct inode *inode)
813{
814 up_read(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500815}
816
817static inline int inode_trylock(struct inode *inode)
818{
Al Viro9902af72016-04-15 15:08:36 -0400819 return down_write_trylock(&inode->i_rwsem);
820}
821
822static inline int inode_trylock_shared(struct inode *inode)
823{
824 return down_read_trylock(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500825}
826
827static inline int inode_is_locked(struct inode *inode)
828{
Al Viro9902af72016-04-15 15:08:36 -0400829 return rwsem_is_locked(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500830}
831
832static inline void inode_lock_nested(struct inode *inode, unsigned subclass)
833{
Al Viro9902af72016-04-15 15:08:36 -0400834 down_write_nested(&inode->i_rwsem, subclass);
Al Viro59551022016-01-22 15:40:57 -0500835}
836
Darrick J. Wong01c2e132018-01-18 14:07:53 -0800837static inline void inode_lock_shared_nested(struct inode *inode, unsigned subclass)
838{
839 down_read_nested(&inode->i_rwsem, subclass);
840}
841
J. Bruce Fields375e2892012-04-18 15:16:33 -0400842void lock_two_nondirectories(struct inode *, struct inode*);
843void unlock_two_nondirectories(struct inode *, struct inode*);
844
Ingo Molnarf2eace22006-07-03 00:25:05 -0700845/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 * NOTE: in a 32bit arch with a preemptable kernel and
847 * an UP compile the i_size_read/write must be atomic
848 * with respect to the local cpu (unlike with preempt disabled),
849 * but they don't need to be atomic with respect to other cpus like in
850 * true SMP (so they need either to either locally disable irq around
851 * the read or for example on x86 they can be still implemented as a
852 * cmpxchg8b without the need of the lock prefix). For SMP compiles
853 * and 64bit archs it makes no difference if preempt is enabled or not.
854 */
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800855static inline loff_t i_size_read(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856{
857#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
858 loff_t i_size;
859 unsigned int seq;
860
861 do {
862 seq = read_seqcount_begin(&inode->i_size_seqcount);
863 i_size = inode->i_size;
864 } while (read_seqcount_retry(&inode->i_size_seqcount, seq));
865 return i_size;
Thomas Gleixner24963962019-10-15 21:18:10 +0200866#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPTION)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 loff_t i_size;
868
869 preempt_disable();
870 i_size = inode->i_size;
871 preempt_enable();
872 return i_size;
873#else
874 return inode->i_size;
875#endif
876}
877
Miklos Szeredi7762f5a2006-10-17 00:10:07 -0700878/*
879 * NOTE: unlike i_size_read(), i_size_write() does need locking around it
880 * (normally i_mutex), otherwise on 32bit/SMP an update of i_size_seqcount
881 * can be lost, resulting in subsequent i_size_read() calls spinning forever.
882 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883static inline void i_size_write(struct inode *inode, loff_t i_size)
884{
885#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
Fan Du74e3d1e2013-04-30 15:27:27 -0700886 preempt_disable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887 write_seqcount_begin(&inode->i_size_seqcount);
888 inode->i_size = i_size;
889 write_seqcount_end(&inode->i_size_seqcount);
Fan Du74e3d1e2013-04-30 15:27:27 -0700890 preempt_enable();
Thomas Gleixner24963962019-10-15 21:18:10 +0200891#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPTION)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892 preempt_disable();
893 inode->i_size = i_size;
894 preempt_enable();
895#else
896 inode->i_size = i_size;
897#endif
898}
899
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800900static inline unsigned iminor(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901{
902 return MINOR(inode->i_rdev);
903}
904
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800905static inline unsigned imajor(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906{
907 return MAJOR(inode->i_rdev);
908}
909
910extern struct block_device *I_BDEV(struct inode *inode);
911
912struct fown_struct {
913 rwlock_t lock; /* protects pid, uid, euid fields */
Eric W. Biederman609d7fa2006-10-02 02:17:15 -0700914 struct pid *pid; /* pid or -pgrp where SIGIO should be sent */
915 enum pid_type pid_type; /* Kind of process group SIGIO should be sent to */
Eric W. Biederman92361632012-02-08 07:07:50 -0800916 kuid_t uid, euid; /* uid/euid of process setting the owner */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 int signum; /* posix.1b rt signal to be delivered on IO */
918};
919
920/*
921 * Track a single file's readahead state
922 */
923struct file_ra_state {
Fengguang Wu937085a2007-10-16 01:24:31 -0700924 pgoff_t start; /* where readahead started */
925 unsigned int size; /* # of readahead pages */
926 unsigned int async_size; /* do asynchronous readahead when
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700927 there are only # of pages ahead */
Fengguang Wu5ce11102007-07-19 01:47:59 -0700928
Fengguang Wu937085a2007-10-16 01:24:31 -0700929 unsigned int ra_pages; /* Maximum readahead window */
Wu Fengguang1ebf26a2009-06-16 15:31:19 -0700930 unsigned int mmap_miss; /* Cache miss stat for mmap accesses */
Fengguang Wuf4e6b492007-10-16 01:24:33 -0700931 loff_t prev_pos; /* Cache last read() position */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933
Fengguang Wu5ce11102007-07-19 01:47:59 -0700934/*
Fengguang Wu5ce11102007-07-19 01:47:59 -0700935 * Check if @index falls in the readahead windows.
936 */
937static inline int ra_has_index(struct file_ra_state *ra, pgoff_t index)
938{
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700939 return (index >= ra->start &&
940 index < ra->start + ra->size);
Fengguang Wu5ce11102007-07-19 01:47:59 -0700941}
942
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943struct file {
Eric Dumazet2f512012005-10-30 15:02:16 -0800944 union {
Oleg Nesterov4f5e65a2013-07-08 14:24:16 -0700945 struct llist_node fu_llist;
Eric Dumazet2f512012005-10-30 15:02:16 -0800946 struct rcu_head fu_rcuhead;
947 } f_u;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800948 struct path f_path;
Al Virodd379782013-03-01 19:48:30 -0500949 struct inode *f_inode; /* cached value */
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800950 const struct file_operations *f_op;
Andi Kleenef3d0fd2011-09-15 16:06:48 -0700951
952 /*
Linus Torvalds9c225f22014-03-03 09:36:58 -0800953 * Protects f_ep_links, f_flags.
Andi Kleenef3d0fd2011-09-15 16:06:48 -0700954 * Must not be taken from IRQ context.
955 */
956 spinlock_t f_lock;
Jens Axboec75b1d92017-06-27 11:47:04 -0600957 enum rw_hint f_write_hint;
Al Viro516e0cc2008-07-26 00:39:17 -0400958 atomic_long_t f_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 unsigned int f_flags;
Al Viroaeb5d722008-09-02 15:28:45 -0400960 fmode_t f_mode;
Linus Torvalds9c225f22014-03-03 09:36:58 -0800961 struct mutex f_pos_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 loff_t f_pos;
963 struct fown_struct f_owner;
David Howellsd76b0d92008-11-14 10:39:25 +1100964 const struct cred *f_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965 struct file_ra_state f_ra;
966
Mathieu Desnoyers2b47c362007-10-16 23:27:21 -0700967 u64 f_version;
Alexey Dobriyan50462062006-09-29 02:00:01 -0700968#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 void *f_security;
Alexey Dobriyan50462062006-09-29 02:00:01 -0700970#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971 /* needed for tty driver, and maybe others */
972 void *private_data;
973
974#ifdef CONFIG_EPOLL
975 /* Used by fs/eventpoll.c to link all the hooks to this file */
976 struct list_head f_ep_links;
Jason Baron28d82dc2012-01-12 17:17:43 -0800977 struct list_head f_tfile_llink;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978#endif /* #ifdef CONFIG_EPOLL */
979 struct address_space *f_mapping;
Jeff Layton5660e132017-07-06 07:02:25 -0400980 errseq_t f_wb_err;
Jeff Layton735e4ae2020-06-01 21:45:36 -0700981 errseq_t f_sb_err; /* for syncfs */
Kees Cook3859a272016-10-28 01:22:25 -0700982} __randomize_layout
983 __attribute__((aligned(4))); /* lest something weird decides that 2 is OK */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984
Aneesh Kumar K.V990d6c22011-01-29 18:43:26 +0530985struct file_handle {
986 __u32 handle_bytes;
987 int handle_type;
988 /* file identifier */
Linus Torvalds9d829732020-05-04 09:16:37 -0700989 unsigned char f_handle[];
Aneesh Kumar K.V990d6c22011-01-29 18:43:26 +0530990};
991
Al Virocb0942b2012-08-27 14:48:26 -0400992static inline struct file *get_file(struct file *f)
993{
994 atomic_long_inc(&f->f_count);
995 return f;
996}
Jens Axboe091141a2018-11-21 10:32:39 -0700997#define get_file_rcu_many(x, cnt) \
998 atomic_long_add_unless(&(x)->f_count, (cnt), 0)
999#define get_file_rcu(x) get_file_rcu_many((x), 1)
Al Viro516e0cc2008-07-26 00:39:17 -04001000#define file_count(x) atomic_long_read(&(x)->f_count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001
1002#define MAX_NON_LFS ((1UL<<31) - 1)
1003
1004/* Page cache limit. The filesystems should put that into their s_maxbytes
1005 limits, otherwise bad things can happen in VM. */
1006#if BITS_PER_LONG==32
Linus Torvalds0cc3b0e2017-08-27 12:12:25 -07001007#define MAX_LFS_FILESIZE ((loff_t)ULONG_MAX << PAGE_SHIFT)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008#elif BITS_PER_LONG==64
Linus Torvalds0cc3b0e2017-08-27 12:12:25 -07001009#define MAX_LFS_FILESIZE ((loff_t)LLONG_MAX)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010#endif
1011
1012#define FL_POSIX 1
1013#define FL_FLOCK 2
J. Bruce Fields617588d2011-07-01 15:18:34 -04001014#define FL_DELEG 4 /* NFSv4 delegation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015#define FL_ACCESS 8 /* not trying to lock, just looking */
Trond Myklebustf475ae92006-06-29 16:38:32 -04001016#define FL_EXISTS 16 /* when unlocking, test for existence */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017#define FL_LEASE 32 /* lease held on this file */
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07001018#define FL_CLOSE 64 /* unlock on close */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019#define FL_SLEEP 128 /* A blocking lock */
J. Bruce Fields778fc542011-07-26 18:25:49 -04001020#define FL_DOWNGRADE_PENDING 256 /* Lease is being downgraded */
1021#define FL_UNLOCK_PENDING 512 /* Lease is being broken */
Jeff Laytoncff2fce2014-04-22 08:24:32 -04001022#define FL_OFDLCK 1024 /* lock is "owned" by struct file */
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001023#define FL_LAYOUT 2048 /* outstanding pNFS layout */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024
Benjamin Coddington50f21122017-04-11 12:50:09 -04001025#define FL_CLOSE_POSIX (FL_POSIX | FL_CLOSE)
1026
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027/*
Miklos Szeredibde74e42008-07-25 01:48:57 -07001028 * Special return value from posix_lock_file() and vfs_lock_file() for
1029 * asynchronous locking.
1030 */
1031#define FILE_LOCK_DEFERRED 1
1032
Jeff Layton7ca76312014-09-01 19:04:48 -04001033/* legacy typedef, should eventually be removed */
Christoph Hellwig17fa3882014-07-13 17:00:37 +02001034typedef void *fl_owner_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035
Jeff Laytona7231a92015-01-16 15:05:56 -05001036struct file_lock;
1037
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038struct file_lock_operations {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039 void (*fl_copy_lock)(struct file_lock *, struct file_lock *);
1040 void (*fl_release_private)(struct file_lock *);
1041};
1042
1043struct lock_manager_operations {
Jeff Laytoncae80b32015-04-03 09:04:04 -04001044 fl_owner_t (*lm_get_owner)(fl_owner_t);
1045 void (*lm_put_owner)(fl_owner_t);
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001046 void (*lm_notify)(struct file_lock *); /* unblock callback */
Joe Perchesd0449b92014-08-22 10:18:42 -04001047 int (*lm_grant)(struct file_lock *, int);
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001048 bool (*lm_break)(struct file_lock *);
Jeff Layton7448cc32015-01-16 15:05:57 -05001049 int (*lm_change)(struct file_lock *, int, struct list_head *);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001050 void (*lm_setup)(struct file_lock *, void **);
J. Bruce Fields28df3d12017-07-28 16:35:15 -04001051 bool (*lm_breaker_owns_lease)(struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052};
1053
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -04001054struct lock_manager {
1055 struct list_head list;
J. Bruce Fieldsc87fb4a2015-08-06 12:47:02 -04001056 /*
1057 * NFSv4 and up also want opens blocked during the grace period;
1058 * NLM doesn't care:
1059 */
1060 bool block_opens;
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -04001061};
1062
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +04001063struct net;
1064void locks_start_grace(struct net *, struct lock_manager *);
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -04001065void locks_end_grace(struct lock_manager *);
Corentin Labbe003278e2017-09-26 09:14:07 +02001066bool locks_in_grace(struct net *);
1067bool opens_in_grace(struct net *);
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -04001068
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069/* that will die - we need it for nfs_lock_info */
1070#include <linux/nfs_fs_i.h>
1071
Jeff Layton1cb36012013-06-21 08:58:12 -04001072/*
1073 * struct file_lock represents a generic "file lock". It's used to represent
1074 * POSIX byte range locks, BSD (flock) locks, and leases. It's important to
1075 * note that the same struct is used to represent both a request for a lock and
1076 * the lock itself, but the same object is never used for both.
1077 *
1078 * FIXME: should we create a separate "struct lock_request" to help distinguish
1079 * these two uses?
1080 *
Jeff Layton8116bf42015-01-21 20:44:01 -05001081 * The varous i_flctx lists are ordered by:
Jeff Layton1cb36012013-06-21 08:58:12 -04001082 *
Jeff Layton8116bf42015-01-21 20:44:01 -05001083 * 1) lock owner
1084 * 2) lock range start
1085 * 3) lock range end
Jeff Layton1cb36012013-06-21 08:58:12 -04001086 *
1087 * Obviously, the last two criteria only matter for POSIX locks.
1088 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089struct file_lock {
NeilBrownada5c1d2018-11-30 10:04:08 +11001090 struct file_lock *fl_blocker; /* The lock, that is blocking us */
Jeff Layton6dee60f2015-01-16 15:05:54 -05001091 struct list_head fl_list; /* link into file_lock_context */
Jeff Layton139ca042013-06-21 08:58:17 -04001092 struct hlist_node fl_link; /* node in global lists */
NeilBrownada5c1d2018-11-30 10:04:08 +11001093 struct list_head fl_blocked_requests; /* list of requests with
1094 * ->fl_blocker pointing here
1095 */
1096 struct list_head fl_blocked_member; /* node in
1097 * ->fl_blocker->fl_blocked_requests
1098 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099 fl_owner_t fl_owner;
J. Bruce Fields710b7212011-07-26 16:28:29 -04001100 unsigned int fl_flags;
Richard Kennedyafc12462008-07-11 17:20:49 -07001101 unsigned char fl_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102 unsigned int fl_pid;
Jeff Layton7012b022013-06-21 08:58:22 -04001103 int fl_link_cpu; /* what cpu's list is this on? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104 wait_queue_head_t fl_wait;
1105 struct file *fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001106 loff_t fl_start;
1107 loff_t fl_end;
1108
1109 struct fasync_struct * fl_fasync; /* for lease break notifications */
J. Bruce Fields778fc542011-07-26 18:25:49 -04001110 /* for lease breaks: */
1111 unsigned long fl_break_time;
1112 unsigned long fl_downgrade_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113
Alexey Dobriyan6aed6282009-09-21 17:01:11 -07001114 const struct file_lock_operations *fl_ops; /* Callbacks for filesystems */
Alexey Dobriyan7b021962009-09-21 17:01:12 -07001115 const struct lock_manager_operations *fl_lmops; /* Callbacks for lockmanagers */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116 union {
1117 struct nfs_lock_info nfs_fl;
Trond Myklebust8d0a8a92005-06-22 17:16:32 +00001118 struct nfs4_lock_info nfs4_fl;
David Howellse8d6c552007-07-15 23:40:12 -07001119 struct {
1120 struct list_head link; /* link in AFS vnode's pending_locks list */
1121 int state; /* state of grant or error if -ve */
David Howellsd4696602019-04-25 14:26:50 +01001122 unsigned int debug_id;
David Howellse8d6c552007-07-15 23:40:12 -07001123 } afs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124 } fl_u;
Kees Cook3859a272016-10-28 01:22:25 -07001125} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126
Jeff Layton4a075e32015-01-16 15:05:54 -05001127struct file_lock_context {
Jeff Layton6109c852015-01-16 15:05:57 -05001128 spinlock_t flc_lock;
Jeff Layton4a075e32015-01-16 15:05:54 -05001129 struct list_head flc_flock;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001130 struct list_head flc_posix;
Jeff Layton8634b512015-01-16 15:05:55 -05001131 struct list_head flc_lease;
Jeff Layton4a075e32015-01-16 15:05:54 -05001132};
1133
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134/* The following constant reflects the upper bound of the file/locking space */
1135#ifndef OFFSET_MAX
1136#define INT_LIMIT(x) (~((x)1 << (sizeof(x)*8 - 1)))
1137#define OFFSET_MAX INT_LIMIT(loff_t)
1138#define OFFT_OFFSET_MAX INT_LIMIT(off_t)
1139#endif
1140
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001141extern void send_sigio(struct fown_struct *fown, int fd, int band);
1142
Miklos Szeredide2a4a52018-07-18 15:44:43 +02001143#define locks_inode(f) file_inode(f)
Miklos Szeredic568d682016-09-16 12:44:20 +02001144
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001145#ifdef CONFIG_FILE_LOCKING
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04001146extern int fcntl_getlk(struct file *, unsigned int, struct flock *);
Peter Staubachc2936212005-07-27 11:45:09 -07001147extern int fcntl_setlk(unsigned int, struct file *, unsigned int,
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04001148 struct flock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149
1150#if BITS_PER_LONG == 32
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04001151extern int fcntl_getlk64(struct file *, unsigned int, struct flock64 *);
Peter Staubachc2936212005-07-27 11:45:09 -07001152extern int fcntl_setlk64(unsigned int, struct file *, unsigned int,
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04001153 struct flock64 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154#endif
1155
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156extern int fcntl_setlease(unsigned int fd, struct file *filp, long arg);
1157extern int fcntl_getlease(struct file *filp);
1158
1159/* fs/locks.c */
Jeff Laytonf27a0fe2016-01-07 15:08:51 -05001160void locks_free_lock_context(struct inode *inode);
J. Bruce Fields05fa3132010-10-30 17:31:15 -04001161void locks_free_lock(struct file_lock *fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162extern void locks_init_lock(struct file_lock *);
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001163extern struct file_lock * locks_alloc_lock(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164extern void locks_copy_lock(struct file_lock *, struct file_lock *);
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001165extern void locks_copy_conflock(struct file_lock *, struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166extern void locks_remove_posix(struct file *, fl_owner_t);
Jeff Layton78ed8a12014-02-03 12:13:08 -05001167extern void locks_remove_file(struct file *);
Felix Blyakhera9e61e22009-03-31 15:12:56 -05001168extern void locks_release_private(struct file_lock *);
J. Bruce Fields6d34ac12007-05-11 16:09:32 -04001169extern void posix_test_lock(struct file *, struct file_lock *);
Marc Eshel150b3932007-01-18 16:15:35 -05001170extern int posix_lock_file(struct file *, struct file_lock *, struct file_lock *);
NeilBrowncb03f942018-11-30 10:04:08 +11001171extern int locks_delete_block(struct file_lock *);
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001172extern int vfs_test_lock(struct file *, struct file_lock *);
Marc Eshel150b3932007-01-18 16:15:35 -05001173extern int vfs_lock_file(struct file *, unsigned int, struct file_lock *, struct file_lock *);
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05001174extern int vfs_cancel_lock(struct file *filp, struct file_lock *fl);
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001175extern int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001176extern int __break_lease(struct inode *inode, unsigned int flags, unsigned int type);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001177extern void lease_get_mtime(struct inode *, struct timespec64 *time);
Jeff Laytone6f5c782014-08-22 10:40:25 -04001178extern int generic_setlease(struct file *, long, struct file_lock **, void **priv);
1179extern int vfs_setlease(struct file *, long, struct file_lock **, void **);
Jeff Layton7448cc32015-01-16 15:05:57 -05001180extern int lease_modify(struct file_lock *, int, struct list_head *);
Jeff Layton18f66222019-08-18 14:18:45 -04001181
1182struct notifier_block;
1183extern int lease_register_notifier(struct notifier_block *);
1184extern void lease_unregister_notifier(struct notifier_block *);
1185
Andrey Vagin6c8c9032015-04-16 12:49:38 -07001186struct files_struct;
1187extern void show_fd_locks(struct seq_file *f,
1188 struct file *filp, struct files_struct *files);
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001189#else /* !CONFIG_FILE_LOCKING */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001190static inline int fcntl_getlk(struct file *file, unsigned int cmd,
1191 struct flock __user *user)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001192{
1193 return -EINVAL;
1194}
1195
1196static inline int fcntl_setlk(unsigned int fd, struct file *file,
1197 unsigned int cmd, struct flock __user *user)
1198{
1199 return -EACCES;
1200}
1201
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001202#if BITS_PER_LONG == 32
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001203static inline int fcntl_getlk64(struct file *file, unsigned int cmd,
1204 struct flock64 __user *user)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001205{
1206 return -EINVAL;
1207}
1208
1209static inline int fcntl_setlk64(unsigned int fd, struct file *file,
1210 unsigned int cmd, struct flock64 __user *user)
1211{
1212 return -EACCES;
1213}
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001214#endif
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001215static inline int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1216{
Jeff Layton1b2b32d2014-09-24 08:38:44 -04001217 return -EINVAL;
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001218}
1219
1220static inline int fcntl_getlease(struct file *filp)
1221{
Jeff Layton1b2b32d2014-09-24 08:38:44 -04001222 return F_UNLCK;
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001223}
1224
Jeff Layton4a075e32015-01-16 15:05:54 -05001225static inline void
Jeff Laytonf27a0fe2016-01-07 15:08:51 -05001226locks_free_lock_context(struct inode *inode)
Jeff Layton4a075e32015-01-16 15:05:54 -05001227{
1228}
1229
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001230static inline void locks_init_lock(struct file_lock *fl)
1231{
1232 return;
1233}
1234
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001235static inline void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001236{
1237 return;
1238}
1239
1240static inline void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
1241{
1242 return;
1243}
1244
1245static inline void locks_remove_posix(struct file *filp, fl_owner_t owner)
1246{
1247 return;
1248}
1249
Jeff Layton78ed8a12014-02-03 12:13:08 -05001250static inline void locks_remove_file(struct file *filp)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001251{
1252 return;
1253}
1254
1255static inline void posix_test_lock(struct file *filp, struct file_lock *fl)
1256{
1257 return;
1258}
1259
1260static inline int posix_lock_file(struct file *filp, struct file_lock *fl,
1261 struct file_lock *conflock)
1262{
1263 return -ENOLCK;
1264}
1265
NeilBrowncb03f942018-11-30 10:04:08 +11001266static inline int locks_delete_block(struct file_lock *waiter)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001267{
1268 return -ENOENT;
1269}
1270
1271static inline int vfs_test_lock(struct file *filp, struct file_lock *fl)
1272{
1273 return 0;
1274}
1275
1276static inline int vfs_lock_file(struct file *filp, unsigned int cmd,
1277 struct file_lock *fl, struct file_lock *conf)
1278{
1279 return -ENOLCK;
1280}
1281
1282static inline int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
1283{
1284 return 0;
1285}
1286
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001287static inline int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
1288{
1289 return -ENOLCK;
1290}
1291
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001292static inline int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001293{
1294 return 0;
1295}
1296
Deepa Dinamani95582b02018-05-08 19:36:02 -07001297static inline void lease_get_mtime(struct inode *inode,
1298 struct timespec64 *time)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001299{
1300 return;
1301}
1302
1303static inline int generic_setlease(struct file *filp, long arg,
Jeff Laytone6f5c782014-08-22 10:40:25 -04001304 struct file_lock **flp, void **priv)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001305{
1306 return -EINVAL;
1307}
1308
1309static inline int vfs_setlease(struct file *filp, long arg,
Jeff Laytone6f5c782014-08-22 10:40:25 -04001310 struct file_lock **lease, void **priv)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001311{
1312 return -EINVAL;
1313}
1314
Jeff Layton7448cc32015-01-16 15:05:57 -05001315static inline int lease_modify(struct file_lock *fl, int arg,
Jeff Laytonc45198e2014-09-01 07:12:07 -04001316 struct list_head *dispose)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001317{
1318 return -EINVAL;
1319}
Andrey Vagin6c8c9032015-04-16 12:49:38 -07001320
1321struct files_struct;
1322static inline void show_fd_locks(struct seq_file *f,
1323 struct file *filp, struct files_struct *files) {}
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001324#endif /* !CONFIG_FILE_LOCKING */
1325
Jeff Laytonee296d72015-07-11 06:43:03 -04001326static inline struct inode *file_inode(const struct file *f)
1327{
1328 return f->f_inode;
1329}
1330
Miklos Szeredid101a122016-03-26 16:14:37 -04001331static inline struct dentry *file_dentry(const struct file *file)
1332{
Miklos Szeredifb160432018-07-18 15:44:44 +02001333 return d_real(file->f_path.dentry, file_inode(file));
Miklos Szeredid101a122016-03-26 16:14:37 -04001334}
1335
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001336static inline int locks_lock_file_wait(struct file *filp, struct file_lock *fl)
1337{
Miklos Szeredic568d682016-09-16 12:44:20 +02001338 return locks_lock_inode_wait(locks_inode(filp), fl);
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001339}
1340
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341struct fasync_struct {
Kirill Tkhai7a107c02018-04-05 14:58:06 +03001342 rwlock_t fa_lock;
Eric Dumazet989a2972010-04-14 09:55:35 +00001343 int magic;
1344 int fa_fd;
1345 struct fasync_struct *fa_next; /* singly linked list */
1346 struct file *fa_file;
1347 struct rcu_head fa_rcu;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348};
1349
1350#define FASYNC_MAGIC 0x4601
1351
1352/* SMP safe fasync helpers: */
1353extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001354extern struct fasync_struct *fasync_insert_entry(int, struct file *, struct fasync_struct **, struct fasync_struct *);
1355extern int fasync_remove_entry(struct file *, struct fasync_struct **);
1356extern struct fasync_struct *fasync_alloc(void);
1357extern void fasync_free(struct fasync_struct *);
1358
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359/* can be called from interrupts */
1360extern void kill_fasync(struct fasync_struct **, int, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361
Jeff Laytone0b93ed2014-08-22 11:27:32 -04001362extern void __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
Jiri Slaby393cc3f2017-06-13 13:35:50 +02001363extern int f_setown(struct file *filp, unsigned long arg, int force);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364extern void f_delown(struct file *filp);
Eric W. Biederman609d7fa2006-10-02 02:17:15 -07001365extern pid_t f_getown(struct file *filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366extern int send_sigurg(struct fown_struct *fown);
1367
1368/*
David Howellse462ec52017-07-17 08:45:35 +01001369 * sb->s_flags. Note that these mirror the equivalent MS_* flags where
1370 * represented in both.
1371 */
1372#define SB_RDONLY 1 /* Mount read-only */
1373#define SB_NOSUID 2 /* Ignore suid and sgid bits */
1374#define SB_NODEV 4 /* Disallow access to device special files */
1375#define SB_NOEXEC 8 /* Disallow program execution */
1376#define SB_SYNCHRONOUS 16 /* Writes are synced at once */
1377#define SB_MANDLOCK 64 /* Allow mandatory locks on an FS */
1378#define SB_DIRSYNC 128 /* Directory modifications are synchronous */
1379#define SB_NOATIME 1024 /* Do not update access times. */
1380#define SB_NODIRATIME 2048 /* Do not update directory access times */
1381#define SB_SILENT 32768
1382#define SB_POSIXACL (1<<16) /* VFS does not apply the umask */
1383#define SB_KERNMOUNT (1<<22) /* this is a kern_mount call */
1384#define SB_I_VERSION (1<<23) /* Update inode I_version field */
1385#define SB_LAZYTIME (1<<25) /* Update the on-disk [acm]times lazily */
1386
1387/* These sb flags are internal to the kernel */
1388#define SB_SUBMOUNT (1<<26)
David Howells8d0347f2018-11-04 09:28:36 -05001389#define SB_FORCE (1<<27)
David Howellse462ec52017-07-17 08:45:35 +01001390#define SB_NOSEC (1<<28)
1391#define SB_BORN (1<<29)
1392#define SB_ACTIVE (1<<30)
1393#define SB_NOUSER (1<<31)
1394
1395/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396 * Umount options
1397 */
1398
1399#define MNT_FORCE 0x00000001 /* Attempt to forcibily umount */
1400#define MNT_DETACH 0x00000002 /* Just detach from the tree */
1401#define MNT_EXPIRE 0x00000004 /* Mark for expiry */
Miklos Szeredidb1f05b2010-02-10 12:15:53 +01001402#define UMOUNT_NOFOLLOW 0x00000008 /* Don't follow symlink on umount */
1403#define UMOUNT_UNUSED 0x80000000 /* Flag guaranteed to be unused */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404
Tejun Heo46b15ca2015-06-16 18:48:31 -04001405/* sb->s_iflags */
1406#define SB_I_CGROUPWB 0x00000001 /* cgroup-aware writeback enabled */
Eric W. Biederman90f85722015-06-29 14:42:03 -05001407#define SB_I_NOEXEC 0x00000002 /* Ignore executables on this fs */
Eric W. Biedermana2982cc2016-06-09 15:34:02 -05001408#define SB_I_NODEV 0x00000004 /* Ignore devices on this fs */
Eric W. Biederman95dd7752018-03-14 18:20:29 -05001409#define SB_I_MULTIROOT 0x00000008 /* Multiple roots to the dentry tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410
Eric W. Biederman8654df42016-06-09 16:06:06 -05001411/* sb->s_iflags to limit user namespace mounts */
1412#define SB_I_USERNS_VISIBLE 0x00000010 /* fstype already mounted */
Mimi Zohar57b56ac2018-02-21 11:33:37 -05001413#define SB_I_IMA_UNVERIFIABLE_SIGNATURE 0x00000020
1414#define SB_I_UNTRUSTED_MOUNTER 0x00000040
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415
Konstantin Khlebnikov32b1924b22020-04-09 11:29:47 +03001416#define SB_I_SKIP_SYNC 0x00000100 /* Skip superblock at global sync */
1417
Jan Kara5accdf82012-06-12 16:20:34 +02001418/* Possible states of 'frozen' field */
1419enum {
1420 SB_UNFROZEN = 0, /* FS is unfrozen */
1421 SB_FREEZE_WRITE = 1, /* Writes, dir ops, ioctls frozen */
Jan Kara5accdf82012-06-12 16:20:34 +02001422 SB_FREEZE_PAGEFAULT = 2, /* Page faults stopped as well */
1423 SB_FREEZE_FS = 3, /* For internal FS use (e.g. to stop
1424 * internal threads if needed) */
1425 SB_FREEZE_COMPLETE = 4, /* ->freeze_fs finished successfully */
1426};
1427
1428#define SB_FREEZE_LEVELS (SB_FREEZE_COMPLETE - 1)
1429
1430struct sb_writers {
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001431 int frozen; /* Is sb frozen? */
1432 wait_queue_head_t wait_unfrozen; /* for get_super_thawed() */
1433 struct percpu_rw_semaphore rw_sem[SB_FREEZE_LEVELS];
Jan Kara5accdf82012-06-12 16:20:34 +02001434};
1435
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436struct super_block {
1437 struct list_head s_list; /* Keep this first */
1438 dev_t s_dev; /* search index; _not_ kdev_t */
Richard Kennedy270ba5f2010-01-26 14:12:43 +00001439 unsigned char s_blocksize_bits;
1440 unsigned long s_blocksize;
Jeff Layton42cb56a2009-09-18 13:05:53 -07001441 loff_t s_maxbytes; /* Max file size */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442 struct file_system_type *s_type;
Josef 'Jeff' Sipekee9b6d62007-02-12 00:55:41 -08001443 const struct super_operations *s_op;
Alexey Dobriyan61e225d2009-09-21 17:01:08 -07001444 const struct dquot_operations *dq_op;
Alexey Dobriyan0d54b212009-09-21 17:01:09 -07001445 const struct quotactl_ops *s_qcop;
Christoph Hellwig39655162007-10-21 16:42:17 -07001446 const struct export_operations *s_export_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447 unsigned long s_flags;
Tejun Heo46b15ca2015-06-16 18:48:31 -04001448 unsigned long s_iflags; /* internal SB_I_* flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001449 unsigned long s_magic;
1450 struct dentry *s_root;
1451 struct rw_semaphore s_umount;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452 int s_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453 atomic_t s_active;
Alexey Dobriyan50462062006-09-29 02:00:01 -07001454#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455 void *s_security;
Alexey Dobriyan50462062006-09-29 02:00:01 -07001456#endif
Stephen Hemmingerbb435452010-05-13 17:53:14 -07001457 const struct xattr_handler **s_xattr;
Chandan Rajendra643fa962018-12-12 15:20:12 +05301458#ifdef CONFIG_FS_ENCRYPTION
Jaegeuk Kim0b81d072015-05-15 16:26:10 -07001459 const struct fscrypt_operations *s_cop;
Eric Biggers22d94f42019-08-04 19:35:46 -07001460 struct key *s_master_keys; /* master crypto keys in use */
Eric Biggersbbbc3fb2018-04-30 15:51:35 -07001461#endif
Eric Biggers5585f2a2019-07-22 09:26:21 -07001462#ifdef CONFIG_FS_VERITY
1463 const struct fsverity_operations *s_vop;
1464#endif
NeilBrownf1ee6162017-12-21 09:45:40 +11001465 struct hlist_bl_head s_roots; /* alternate root dentries for NFS */
Miklos Szeredi39f7c4d2011-11-21 12:11:30 +01001466 struct list_head s_mounts; /* list of mounts; _not_ for fs use */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467 struct block_device *s_bdev;
Jens Axboe32a88aa2009-09-16 15:02:33 +02001468 struct backing_dev_info *s_bdi;
David Howellsacaebfd2007-05-10 22:51:50 -07001469 struct mtd_info *s_mtd;
Al Viroa5166162011-12-12 22:53:00 -05001470 struct hlist_node s_instances;
Jan Kara2c5f6482014-09-30 10:43:09 +02001471 unsigned int s_quota_types; /* Bitmask of supported quota types */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472 struct quota_info s_dquot; /* Diskquota specific options */
1473
Jan Kara5accdf82012-06-12 16:20:34 +02001474 struct sb_writers s_writers;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475
Amir Goldstein99c228a2018-10-18 14:22:55 +03001476 /*
1477 * Keep s_fs_info, s_time_gran, s_fsnotify_mask, and
1478 * s_fsnotify_marks together for cache efficiency. They are frequently
1479 * accessed and rarely modified.
1480 */
1481 void *s_fs_info; /* Filesystem private info */
1482
1483 /* Granularity of c/m/atime in ns (cannot be worse than a second) */
1484 u32 s_time_gran;
Deepa Dinamani188d20bc2018-01-21 18:04:23 -08001485 /* Time limits for c/m/atime in seconds */
1486 time64_t s_time_min;
1487 time64_t s_time_max;
Amir Goldstein99c228a2018-10-18 14:22:55 +03001488#ifdef CONFIG_FSNOTIFY
1489 __u32 s_fsnotify_mask;
1490 struct fsnotify_mark_connector __rcu *s_fsnotify_marks;
1491#endif
1492
Christoph Hellwig85787092017-05-10 15:06:33 +02001493 char s_id[32]; /* Informational name */
1494 uuid_t s_uuid; /* UUID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495
Al Viro8de52772012-02-06 12:45:27 -05001496 unsigned int s_max_links;
Al Viro30c40d22008-02-22 19:50:45 -05001497 fmode_t s_mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498
1499 /*
1500 * The next field is for VFS *only*. No filesystems have any business
1501 * even looking at it. You had been warned.
1502 */
Arjan van de Vena11f3a02006-03-23 03:00:33 -08001503 struct mutex s_vfs_rename_mutex; /* Kludge */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504
Miklos Szeredi79c0b2d2007-05-08 00:25:43 -07001505 /*
1506 * Filesystem subtype. If non-empty the filesystem type field
1507 * in /proc/mounts will be "type.subtype"
1508 */
Al Viroa0c9a8b2018-11-04 07:18:51 -05001509 const char *s_subtype;
Miklos Szeredib3b304a2008-02-08 04:21:35 -08001510
Al Viroc8aebb02010-12-18 10:22:30 -05001511 const struct dentry_operations *s_d_op; /* default d_op for dentries */
Dan Magenheimer9fdfdcf2011-05-26 10:01:19 -06001512
1513 /*
1514 * Saved pool identifier for cleancache (-1 means none)
1515 */
1516 int cleancache_poolid;
Dave Chinnerb0d40c92011-07-08 14:14:42 +10001517
1518 struct shrinker s_shrink; /* per-sb shrinker handle */
Miklos Szeredi4ed5e82f2011-11-21 12:11:31 +01001519
Miklos Szeredi7ada4db2011-11-21 12:11:32 +01001520 /* Number of inodes with nlink == 0 but still referenced */
1521 atomic_long_t s_remove_count;
1522
Jan Kara721fb6f2018-10-17 13:07:05 +02001523 /* Pending fsnotify inode refs */
1524 atomic_long_t s_fsnotify_inode_refs;
1525
Miklos Szeredi4ed5e82f2011-11-21 12:11:31 +01001526 /* Being remounted read-only */
1527 int s_readonly_remount;
Christoph Hellwig7b7a8662013-09-04 15:04:39 +02001528
Jeff Layton735e4ae2020-06-01 21:45:36 -07001529 /* per-sb errseq_t for reporting writeback errors via syncfs */
1530 errseq_t s_wb_err;
1531
Christoph Hellwig7b7a8662013-09-04 15:04:39 +02001532 /* AIO completions deferred from interrupt context */
1533 struct workqueue_struct *s_dio_done_wq;
Al Viro215752f2014-08-07 06:23:41 -04001534 struct hlist_head s_pins;
Dave Chinnerf6041562013-08-28 10:18:00 +10001535
1536 /*
Eric W. Biederman6e4eab52016-05-24 09:29:01 -05001537 * Owning user namespace and default context in which to
1538 * interpret filesystem uids, gids, quotas, device nodes,
1539 * xattrs and security labels.
1540 */
1541 struct user_namespace *s_user_ns;
1542
1543 /*
Waiman Long7d10f702019-01-30 13:52:37 -05001544 * The list_lru structure is essentially just a pointer to a table
1545 * of per-node lru lists, each of which has its own spinlock.
1546 * There is no need to put them into separate cachelines.
Dave Chinnerf6041562013-08-28 10:18:00 +10001547 */
Waiman Long7d10f702019-01-30 13:52:37 -05001548 struct list_lru s_dentry_lru;
1549 struct list_lru s_inode_lru;
Al Viroe2fec7c2013-10-04 17:06:56 -04001550 struct rcu_head rcu;
Oleg Nesterov853b39a2015-07-22 20:21:13 +02001551 struct work_struct destroy_work;
Miklos Szeredi69c433e2014-10-24 00:14:39 +02001552
Dave Chinnere97fedb2015-03-04 13:40:00 -05001553 struct mutex s_sync_lock; /* sync serialisation lock */
Miklos Szeredi69c433e2014-10-24 00:14:39 +02001554
1555 /*
1556 * Indicates how deep in a filesystem stack this SB is
1557 */
1558 int s_stack_depth;
Dave Chinner74278da2015-03-04 12:37:22 -05001559
1560 /* s_inode_list_lock protects s_inodes */
1561 spinlock_t s_inode_list_lock ____cacheline_aligned_in_smp;
1562 struct list_head s_inodes; /* all inodes */
Dave Chinner6c60d2b2016-07-26 15:21:50 -07001563
1564 spinlock_t s_inode_wblist_lock;
1565 struct list_head s_inodes_wb; /* writeback inodes */
Kees Cook3859a272016-10-28 01:22:25 -07001566} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567
Seth Forshee81754352014-12-11 10:15:45 -06001568/* Helper functions so that in most cases filesystems will
1569 * not need to deal directly with kuid_t and kgid_t and can
1570 * instead deal with the raw numeric values that are stored
1571 * in the filesystem.
1572 */
1573static inline uid_t i_uid_read(const struct inode *inode)
1574{
1575 return from_kuid(inode->i_sb->s_user_ns, inode->i_uid);
1576}
1577
1578static inline gid_t i_gid_read(const struct inode *inode)
1579{
1580 return from_kgid(inode->i_sb->s_user_ns, inode->i_gid);
1581}
1582
1583static inline void i_uid_write(struct inode *inode, uid_t uid)
1584{
1585 inode->i_uid = make_kuid(inode->i_sb->s_user_ns, uid);
1586}
1587
1588static inline void i_gid_write(struct inode *inode, gid_t gid)
1589{
1590 inode->i_gid = make_kgid(inode->i_sb->s_user_ns, gid);
1591}
1592
Deepa Dinamani95582b02018-05-08 19:36:02 -07001593extern struct timespec64 current_time(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594
1595/*
1596 * Snapshotting support.
1597 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598
Jan Kara5accdf82012-06-12 16:20:34 +02001599void __sb_end_write(struct super_block *sb, int level);
1600int __sb_start_write(struct super_block *sb, int level, bool wait);
1601
Oleg Nesterovbee91822015-07-19 23:48:20 +02001602#define __sb_writers_acquired(sb, lev) \
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001603 percpu_rwsem_acquire(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
Oleg Nesterovbee91822015-07-19 23:48:20 +02001604#define __sb_writers_release(sb, lev) \
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001605 percpu_rwsem_release(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
Oleg Nesterovbee91822015-07-19 23:48:20 +02001606
Jan Kara5accdf82012-06-12 16:20:34 +02001607/**
1608 * sb_end_write - drop write access to a superblock
1609 * @sb: the super we wrote to
1610 *
1611 * Decrement number of writers to the filesystem. Wake up possible waiters
1612 * wanting to freeze the filesystem.
1613 */
1614static inline void sb_end_write(struct super_block *sb)
1615{
1616 __sb_end_write(sb, SB_FREEZE_WRITE);
1617}
1618
1619/**
1620 * sb_end_pagefault - drop write access to a superblock from a page fault
1621 * @sb: the super we wrote to
1622 *
1623 * Decrement number of processes handling write page fault to the filesystem.
1624 * Wake up possible waiters wanting to freeze the filesystem.
1625 */
1626static inline void sb_end_pagefault(struct super_block *sb)
1627{
1628 __sb_end_write(sb, SB_FREEZE_PAGEFAULT);
1629}
1630
1631/**
1632 * sb_end_intwrite - drop write access to a superblock for internal fs purposes
1633 * @sb: the super we wrote to
1634 *
1635 * Decrement fs-internal number of writers to the filesystem. Wake up possible
1636 * waiters wanting to freeze the filesystem.
1637 */
1638static inline void sb_end_intwrite(struct super_block *sb)
1639{
1640 __sb_end_write(sb, SB_FREEZE_FS);
1641}
1642
1643/**
1644 * sb_start_write - get write access to a superblock
1645 * @sb: the super we write to
1646 *
1647 * When a process wants to write data or metadata to a file system (i.e. dirty
1648 * a page or an inode), it should embed the operation in a sb_start_write() -
1649 * sb_end_write() pair to get exclusion against file system freezing. This
1650 * function increments number of writers preventing freezing. If the file
1651 * system is already frozen, the function waits until the file system is
1652 * thawed.
1653 *
1654 * Since freeze protection behaves as a lock, users have to preserve
1655 * ordering of freeze protection and other filesystem locks. Generally,
1656 * freeze protection should be the outermost lock. In particular, we have:
1657 *
1658 * sb_start_write
1659 * -> i_mutex (write path, truncate, directory ops, ...)
1660 * -> s_umount (freeze_super, thaw_super)
1661 */
1662static inline void sb_start_write(struct super_block *sb)
1663{
1664 __sb_start_write(sb, SB_FREEZE_WRITE, true);
1665}
1666
1667static inline int sb_start_write_trylock(struct super_block *sb)
1668{
1669 return __sb_start_write(sb, SB_FREEZE_WRITE, false);
1670}
1671
1672/**
1673 * sb_start_pagefault - get write access to a superblock from a page fault
1674 * @sb: the super we write to
1675 *
1676 * When a process starts handling write page fault, it should embed the
1677 * operation into sb_start_pagefault() - sb_end_pagefault() pair to get
1678 * exclusion against file system freezing. This is needed since the page fault
1679 * is going to dirty a page. This function increments number of running page
1680 * faults preventing freezing. If the file system is already frozen, the
1681 * function waits until the file system is thawed.
1682 *
1683 * Since page fault freeze protection behaves as a lock, users have to preserve
1684 * ordering of freeze protection and other filesystem locks. It is advised to
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001685 * put sb_start_pagefault() close to mmap_lock in lock ordering. Page fault
Jan Kara5accdf82012-06-12 16:20:34 +02001686 * handling code implies lock dependency:
1687 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001688 * mmap_lock
Jan Kara5accdf82012-06-12 16:20:34 +02001689 * -> sb_start_pagefault
1690 */
1691static inline void sb_start_pagefault(struct super_block *sb)
1692{
1693 __sb_start_write(sb, SB_FREEZE_PAGEFAULT, true);
1694}
1695
1696/*
1697 * sb_start_intwrite - get write access to a superblock for internal fs purposes
1698 * @sb: the super we write to
1699 *
1700 * This is the third level of protection against filesystem freezing. It is
1701 * free for use by a filesystem. The only requirement is that it must rank
1702 * below sb_start_pagefault.
1703 *
1704 * For example filesystem can call sb_start_intwrite() when starting a
1705 * transaction which somewhat eases handling of freezing for internal sources
1706 * of filesystem changes (internal fs threads, discarding preallocation on file
1707 * close, etc.).
1708 */
1709static inline void sb_start_intwrite(struct super_block *sb)
1710{
1711 __sb_start_write(sb, SB_FREEZE_FS, true);
1712}
1713
Amir Goldstein0c8e3fe2018-05-13 22:40:30 -04001714static inline int sb_start_intwrite_trylock(struct super_block *sb)
1715{
1716 return __sb_start_write(sb, SB_FREEZE_FS, false);
1717}
1718
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719
Serge E. Hallyn2e149672011-03-23 16:43:26 -07001720extern bool inode_owner_or_capable(const struct inode *inode);
Satyam Sharma3bd858a2007-07-17 15:00:08 +05301721
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722/*
1723 * VFS helper functions..
1724 */
Al Viro312b63f2012-06-10 18:09:36 -04001725extern int vfs_create(struct inode *, struct dentry *, umode_t, bool);
Al Viro18bb1db2011-07-26 01:41:39 -04001726extern int vfs_mkdir(struct inode *, struct dentry *, umode_t);
Al Viro1a67aaf2011-07-26 01:52:52 -04001727extern int vfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
Miklos Szeredidb2e7472008-06-24 16:50:16 +02001728extern int vfs_symlink(struct inode *, struct dentry *, const char *);
J. Bruce Fields146a8592011-09-20 17:14:31 -04001729extern int vfs_link(struct dentry *, struct inode *, struct dentry *, struct inode **);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001730extern int vfs_rmdir(struct inode *, struct dentry *);
J. Bruce Fieldsb21996e2011-09-20 09:14:34 -04001731extern int vfs_unlink(struct inode *, struct dentry *, struct inode **);
Miklos Szeredi520c8b12014-04-01 17:08:42 +02001732extern int vfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *, struct inode **, unsigned int);
Miklos Szeredia3c751a2020-05-14 16:44:23 +02001733
1734static inline int vfs_whiteout(struct inode *dir, struct dentry *dentry)
1735{
1736 return vfs_mknod(dir, dentry, S_IFCHR | WHITEOUT_MODE, WHITEOUT_DEV);
1737}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738
Amir Goldsteinaf7bd4d2017-01-17 06:34:52 +02001739extern struct dentry *vfs_tmpfile(struct dentry *dentry, umode_t mode,
1740 int open_flag);
1741
Al Viro8e6c8482017-12-01 17:12:45 -05001742int vfs_mkobj(struct dentry *, umode_t,
1743 int (*f)(struct dentry *, umode_t, void *),
1744 void *);
1745
Miklos Szeredi9df67022018-07-18 15:44:40 +02001746extern long vfs_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
1747
Arnd Bergmann2952db02018-09-11 16:55:03 +02001748#ifdef CONFIG_COMPAT
1749extern long compat_ptr_ioctl(struct file *file, unsigned int cmd,
1750 unsigned long arg);
1751#else
1752#define compat_ptr_ioctl NULL
1753#endif
1754
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755/*
Christoph Hellwig8c744fb2005-11-08 21:35:04 -08001756 * VFS file helper functions.
1757 */
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03001758extern void inode_init_owner(struct inode *inode, const struct inode *dir,
Al Viro62bb1092011-07-24 23:20:18 -04001759 umode_t mode);
Eric W. Biedermana2982cc2016-06-09 15:34:02 -05001760extern bool may_open_dev(const struct path *path);
Mark Fashehc4b929b2008-10-08 19:44:18 -04001761
1762/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763 * This is the "filldir" function type, used by readdir() to let
1764 * the kernel specify what kind of dirent layout it wants to have.
1765 * This allows the kernel to read directories into kernel space or
1766 * to have different dirent layouts depending on the binary type.
1767 */
Miklos Szerediac7576f2014-10-30 17:37:34 +01001768struct dir_context;
1769typedef int (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64,
1770 unsigned);
1771
Al Viro5c0ba4e2013-05-15 13:52:59 -04001772struct dir_context {
David Howellsa09acf42018-04-09 21:12:30 +01001773 filldir_t actor;
Al Virobb6f6192013-05-15 18:49:12 -04001774 loff_t pos;
Al Viro5c0ba4e2013-05-15 13:52:59 -04001775};
Al Virobb6f6192013-05-15 18:49:12 -04001776
Al Viro08f85852007-10-08 13:26:20 -04001777struct block_device_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779/* These macros are for out of kernel modules to test that
1780 * the kernel supports the unlocked_ioctl and compat_ioctl
1781 * fields in struct file_operations. */
1782#define HAVE_COMPAT_IOCTL 1
1783#define HAVE_UNLOCKED_IOCTL 1
1784
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01001785/*
1786 * These flags let !MMU mmap() govern direct device mapping vs immediate
1787 * copying more easily for MAP_PRIVATE, especially for ROM filesystems.
1788 *
1789 * NOMMU_MAP_COPY: Copy can be mapped (MAP_PRIVATE)
1790 * NOMMU_MAP_DIRECT: Can be mapped directly (MAP_SHARED)
1791 * NOMMU_MAP_READ: Can be mapped for reading
1792 * NOMMU_MAP_WRITE: Can be mapped for writing
1793 * NOMMU_MAP_EXEC: Can be mapped for execution
1794 */
1795#define NOMMU_MAP_COPY 0x00000001
1796#define NOMMU_MAP_DIRECT 0x00000008
1797#define NOMMU_MAP_READ VM_MAYREAD
1798#define NOMMU_MAP_WRITE VM_MAYWRITE
1799#define NOMMU_MAP_EXEC VM_MAYEXEC
1800
1801#define NOMMU_VMFLAGS \
1802 (NOMMU_MAP_READ | NOMMU_MAP_WRITE | NOMMU_MAP_EXEC)
1803
Darrick J. Wong2e5dfc92018-10-30 10:41:21 +11001804/*
1805 * These flags control the behavior of the remap_file_range function pointer.
1806 * If it is called with len == 0 that means "remap to end of source file".
Mauro Carvalho Chehab5c437fa2019-06-07 15:54:35 -03001807 * See Documentation/filesystems/vfs.rst for more details about this call.
Darrick J. Wong2e5dfc92018-10-30 10:41:21 +11001808 *
1809 * REMAP_FILE_DEDUP: only remap if contents identical (i.e. deduplicate)
Darrick J. Wongeca36542018-10-30 10:42:10 +11001810 * REMAP_FILE_CAN_SHORTEN: caller can handle a shortened request
Darrick J. Wong2e5dfc92018-10-30 10:41:21 +11001811 */
1812#define REMAP_FILE_DEDUP (1 << 0)
Darrick J. Wongeca36542018-10-30 10:42:10 +11001813#define REMAP_FILE_CAN_SHORTEN (1 << 1)
Darrick J. Wong2e5dfc92018-10-30 10:41:21 +11001814
1815/*
1816 * These flags signal that the caller is ok with altering various aspects of
1817 * the behavior of the remap operation. The changes must be made by the
1818 * implementation; the vfs remap helper functions can take advantage of them.
1819 * Flags in this category exist to preserve the quirky behavior of the hoisted
1820 * btrfs clone/dedupe ioctls.
Darrick J. Wong2e5dfc92018-10-30 10:41:21 +11001821 */
Darrick J. Wongeca36542018-10-30 10:42:10 +11001822#define REMAP_FILE_ADVISORY (REMAP_FILE_CAN_SHORTEN)
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01001823
Al Viro293bc982014-02-11 18:37:41 -05001824struct iov_iter;
1825
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826struct file_operations {
1827 struct module *owner;
1828 loff_t (*llseek) (struct file *, loff_t, int);
1829 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
Al Viro293bc982014-02-11 18:37:41 -05001831 ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
1832 ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
Christoph Hellwigfb7e1602018-11-22 16:37:38 +01001833 int (*iopoll)(struct kiocb *kiocb, bool spin);
Al Virobb6f6192013-05-15 18:49:12 -04001834 int (*iterate) (struct file *, struct dir_context *);
Al Viro61922692016-04-20 23:08:32 -04001835 int (*iterate_shared) (struct file *, struct dir_context *);
Al Viroa3f86832017-07-02 22:22:01 -04001836 __poll_t (*poll) (struct file *, struct poll_table_struct *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001837 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
1838 long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
1839 int (*mmap) (struct file *, struct vm_area_struct *);
Dan Williams1c972592017-11-01 16:36:30 +01001840 unsigned long mmap_supported_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841 int (*open) (struct inode *, struct file *);
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07001842 int (*flush) (struct file *, fl_owner_t id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843 int (*release) (struct inode *, struct file *);
Josef Bacik02c24a82011-07-16 20:44:56 -04001844 int (*fsync) (struct file *, loff_t, loff_t, int datasync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845 int (*fasync) (int, struct file *, int);
1846 int (*lock) (struct file *, int, struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847 ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
1848 unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
1849 int (*check_flags)(int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001850 int (*flock) (struct file *, int, struct file_lock *);
Jens Axboecbb7e572006-04-11 14:57:50 +02001851 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int);
1852 ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int);
Jeff Laytone6f5c782014-08-22 10:40:25 -04001853 int (*setlease)(struct file *, long, struct file_lock **, void **);
Christoph Hellwig2fe17c12011-01-14 13:07:43 +01001854 long (*fallocate)(struct file *file, int mode, loff_t offset,
1855 loff_t len);
Joe Perchesa3816ab2014-09-29 16:08:25 -07001856 void (*show_fdinfo)(struct seq_file *m, struct file *f);
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01001857#ifndef CONFIG_MMU
1858 unsigned (*mmap_capabilities)(struct file *);
1859#endif
Christoph Hellwig04b38d62015-12-03 12:59:50 +01001860 ssize_t (*copy_file_range)(struct file *, loff_t, struct file *,
1861 loff_t, size_t, unsigned int);
Darrick J. Wong42ec3d42018-10-30 10:41:49 +11001862 loff_t (*remap_file_range)(struct file *file_in, loff_t pos_in,
1863 struct file *file_out, loff_t pos_out,
1864 loff_t len, unsigned int remap_flags);
Amir Goldstein45cd0fa2018-08-27 15:56:02 +03001865 int (*fadvise)(struct file *, loff_t, loff_t, int);
Kees Cook3859a272016-10-28 01:22:25 -07001866} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001867
1868struct inode_operations {
Al Viro00cd8dd2012-06-10 17:13:09 -04001869 struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
Al Virofceef392015-12-29 15:58:39 -05001870 const char * (*get_link) (struct dentry *, struct inode *, struct delayed_call *);
Al Viro10556cb22011-06-20 19:28:19 -04001871 int (*permission) (struct inode *, int);
Christoph Hellwig4e34e712011-07-23 17:37:31 +02001872 struct posix_acl * (*get_acl)(struct inode *, int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001873
1874 int (*readlink) (struct dentry *, char __user *,int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001875
Al Viroebfc3b42012-06-10 18:05:36 -04001876 int (*create) (struct inode *,struct dentry *, umode_t, bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877 int (*link) (struct dentry *,struct inode *,struct dentry *);
1878 int (*unlink) (struct inode *,struct dentry *);
1879 int (*symlink) (struct inode *,struct dentry *,const char *);
Al Viro18bb1db2011-07-26 01:41:39 -04001880 int (*mkdir) (struct inode *,struct dentry *,umode_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001881 int (*rmdir) (struct inode *,struct dentry *);
Al Viro1a67aaf2011-07-26 01:52:52 -04001882 int (*mknod) (struct inode *,struct dentry *,umode_t,dev_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001883 int (*rename) (struct inode *, struct dentry *,
Miklos Szeredi520c8b12014-04-01 17:08:42 +02001884 struct inode *, struct dentry *, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885 int (*setattr) (struct dentry *, struct iattr *);
David Howellsa528d352017-01-31 16:46:22 +00001886 int (*getattr) (const struct path *, struct kstat *, u32, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001887 ssize_t (*listxattr) (struct dentry *, char *, size_t);
Mark Fashehc4b929b2008-10-08 19:44:18 -04001888 int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
1889 u64 len);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001890 int (*update_time)(struct inode *, struct timespec64 *, int);
Al Virod9585272012-06-22 12:39:14 +04001891 int (*atomic_open)(struct inode *, struct dentry *,
Al Viro30d90492012-06-22 12:40:19 +04001892 struct file *, unsigned open_flag,
Al Viro44907d72018-06-08 13:32:02 -04001893 umode_t create_mode);
Al Viro60545d02013-06-07 01:20:27 -04001894 int (*tmpfile) (struct inode *, struct dentry *, umode_t);
Christoph Hellwig893d46e2013-12-20 05:16:39 -08001895 int (*set_acl)(struct inode *, struct posix_acl *, int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001896} ____cacheline_aligned;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001897
Miklos Szeredibb7462b2017-02-20 16:51:23 +01001898static inline ssize_t call_read_iter(struct file *file, struct kiocb *kio,
1899 struct iov_iter *iter)
1900{
1901 return file->f_op->read_iter(kio, iter);
1902}
1903
1904static inline ssize_t call_write_iter(struct file *file, struct kiocb *kio,
1905 struct iov_iter *iter)
1906{
1907 return file->f_op->write_iter(kio, iter);
1908}
1909
Miklos Szeredif74ac012017-02-20 16:51:23 +01001910static inline int call_mmap(struct file *file, struct vm_area_struct *vma)
1911{
1912 return file->f_op->mmap(file, vma);
1913}
1914
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001915ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvector,
Christopher Yeohfcf63402011-10-31 17:06:39 -07001916 unsigned long nr_segs, unsigned long fast_segs,
1917 struct iovec *fast_pointer,
Christopher Yeohac34ebb2012-05-31 16:26:42 -07001918 struct iovec **ret_pointer);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001919
Dmitry Kasatkin6fb50322014-11-05 17:01:17 +02001920extern ssize_t __vfs_read(struct file *, char __user *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
1922extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
1923extern ssize_t vfs_readv(struct file *, const struct iovec __user *,
Christoph Hellwigddef7ed22017-07-06 18:58:37 +02001924 unsigned long, loff_t *, rwf_t);
Zach Brown29732932015-11-10 16:53:30 -05001925extern ssize_t vfs_copy_file_range(struct file *, loff_t , struct file *,
1926 loff_t, size_t, unsigned int);
Dave Chinnerf16acc92019-06-05 08:04:47 -07001927extern ssize_t generic_copy_file_range(struct file *file_in, loff_t pos_in,
1928 struct file *file_out, loff_t pos_out,
1929 size_t len, unsigned int flags);
Darrick J. Wonga83ab012018-10-30 10:41:08 +11001930extern int generic_remap_file_range_prep(struct file *file_in, loff_t pos_in,
1931 struct file *file_out, loff_t pos_out,
Darrick J. Wong42ec3d42018-10-30 10:41:49 +11001932 loff_t *count,
1933 unsigned int remap_flags);
1934extern loff_t do_clone_file_range(struct file *file_in, loff_t pos_in,
1935 struct file *file_out, loff_t pos_out,
Darrick J. Wong452ce652018-10-30 10:41:56 +11001936 loff_t len, unsigned int remap_flags);
Darrick J. Wong42ec3d42018-10-30 10:41:49 +11001937extern loff_t vfs_clone_file_range(struct file *file_in, loff_t pos_in,
1938 struct file *file_out, loff_t pos_out,
Darrick J. Wong452ce652018-10-30 10:41:56 +11001939 loff_t len, unsigned int remap_flags);
Darrick J. Wong54dbc152015-12-19 00:55:59 -08001940extern int vfs_dedupe_file_range(struct file *file,
1941 struct file_dedupe_range *same);
Darrick J. Wong42ec3d42018-10-30 10:41:49 +11001942extern loff_t vfs_dedupe_file_range_one(struct file *src_file, loff_t src_pos,
1943 struct file *dst_file, loff_t dst_pos,
Darrick J. Wongdf365832018-10-30 10:42:03 +11001944 loff_t len, unsigned int remap_flags);
Miklos Szeredif1825362018-07-18 15:44:40 +02001945
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947struct super_operations {
1948 struct inode *(*alloc_inode)(struct super_block *sb);
1949 void (*destroy_inode)(struct inode *);
Al Virofdb0da82019-04-10 14:43:44 -04001950 void (*free_inode)(struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001951
Christoph Hellwigaa385722011-05-27 06:53:02 -04001952 void (*dirty_inode) (struct inode *, int flags);
Christoph Hellwiga9185b42010-03-05 09:21:37 +01001953 int (*write_inode) (struct inode *, struct writeback_control *wbc);
Al Viro45321ac2010-06-07 13:43:19 -04001954 int (*drop_inode) (struct inode *);
Al Virobe7ce412010-06-04 19:40:39 -04001955 void (*evict_inode) (struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956 void (*put_super) (struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957 int (*sync_fs)(struct super_block *sb, int wait);
Benjamin Marzinski48b6bca2014-11-13 20:42:03 -06001958 int (*freeze_super) (struct super_block *);
Takashi Satoc4be0c12009-01-09 16:40:58 -08001959 int (*freeze_fs) (struct super_block *);
Benjamin Marzinski48b6bca2014-11-13 20:42:03 -06001960 int (*thaw_super) (struct super_block *);
Takashi Satoc4be0c12009-01-09 16:40:58 -08001961 int (*unfreeze_fs) (struct super_block *);
David Howells726c3342006-06-23 02:02:58 -07001962 int (*statfs) (struct dentry *, struct kstatfs *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001963 int (*remount_fs) (struct super_block *, int *, char *);
Al Viro42faad92008-04-24 07:21:56 -04001964 void (*umount_begin) (struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001965
Al Viro34c80b12011-12-08 21:32:45 -05001966 int (*show_options)(struct seq_file *, struct dentry *);
Al Virod861c632011-12-08 21:32:45 -05001967 int (*show_devname)(struct seq_file *, struct dentry *);
Al Viroa6322de2011-12-08 21:37:57 -05001968 int (*show_path)(struct seq_file *, struct dentry *);
Al Viro64132372011-12-08 20:51:13 -05001969 int (*show_stats)(struct seq_file *, struct dentry *);
Alexey Dobriyan0e51a722006-09-29 01:59:56 -07001970#ifdef CONFIG_QUOTA
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971 ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
1972 ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
Jan Kara2d0fa462014-09-25 16:36:14 +02001973 struct dquot **(*get_dquots)(struct inode *);
Alexey Dobriyan0e51a722006-09-29 01:59:56 -07001974#endif
Theodore Ts'o87d8fe12009-01-03 09:47:09 -05001975 int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
Vladimir Davydov4101b622015-02-12 14:58:51 -08001976 long (*nr_cached_objects)(struct super_block *,
1977 struct shrink_control *);
1978 long (*free_cached_objects)(struct super_block *,
1979 struct shrink_control *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980};
1981
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001982/*
David Howellsbbc10962012-10-15 16:40:35 +01001983 * Inode flags - they have no relation to superblock flags now
1984 */
Eric Biggers6414e9b2020-07-12 20:09:52 -07001985#define S_SYNC (1 << 0) /* Writes are synced at once */
1986#define S_NOATIME (1 << 1) /* Do not update access times */
1987#define S_APPEND (1 << 2) /* Append-only file */
1988#define S_IMMUTABLE (1 << 3) /* Immutable file */
1989#define S_DEAD (1 << 4) /* removed, but still open directory */
1990#define S_NOQUOTA (1 << 5) /* Inode is not counted to quota */
1991#define S_DIRSYNC (1 << 6) /* Directory modifications are synchronous */
1992#define S_NOCMTIME (1 << 7) /* Do not update file c/mtime */
1993#define S_SWAPFILE (1 << 8) /* Do not truncate: swapon got its bmaps */
1994#define S_PRIVATE (1 << 9) /* Inode is fs-internal */
1995#define S_IMA (1 << 10) /* Inode has an associated IMA struct */
1996#define S_AUTOMOUNT (1 << 11) /* Automount/referral quasi-directory */
1997#define S_NOSEC (1 << 12) /* no suid or xattr security attributes */
Matthew Wilcox6cd176a2015-02-16 15:59:25 -08001998#ifdef CONFIG_FS_DAX
Eric Biggers6414e9b2020-07-12 20:09:52 -07001999#define S_DAX (1 << 13) /* Direct Access, avoiding the page cache */
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002000#else
Eric Biggers6414e9b2020-07-12 20:09:52 -07002001#define S_DAX 0 /* Make all the DAX code disappear */
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002002#endif
Eric Biggers6414e9b2020-07-12 20:09:52 -07002003#define S_ENCRYPTED (1 << 14) /* Encrypted file (using fs/crypto/) */
2004#define S_CASEFOLD (1 << 15) /* Casefolded file */
2005#define S_VERITY (1 << 16) /* Verity file (using fs/verity/) */
David Howellsbbc10962012-10-15 16:40:35 +01002006
2007/*
2008 * Note that nosuid etc flags are inode-specific: setting some file-system
2009 * flags just means all the inodes inherit those flags by default. It might be
2010 * possible to override it selectively if you really wanted to with some
2011 * ioctl() that is not currently implemented.
2012 *
David Howellse462ec52017-07-17 08:45:35 +01002013 * Exception: SB_RDONLY is always applied to the entire file system.
David Howellsbbc10962012-10-15 16:40:35 +01002014 *
2015 * Unfortunately, it is possible to change a filesystems flags with it mounted
2016 * with files in use. This means that all of the inodes will not have their
2017 * i_flags updated. Hence, i_flags no longer inherit the superblock mount
2018 * flags, so these have to be checked separately. -- rmk@arm.uk.linux.org
2019 */
2020#define __IS_FLG(inode, flg) ((inode)->i_sb->s_flags & (flg))
2021
Linus Torvalds1751e8a2017-11-27 13:05:09 -08002022static inline bool sb_rdonly(const struct super_block *sb) { return sb->s_flags & SB_RDONLY; }
David Howells94e92e72017-07-17 08:45:34 +01002023#define IS_RDONLY(inode) sb_rdonly((inode)->i_sb)
David Howellse462ec52017-07-17 08:45:35 +01002024#define IS_SYNC(inode) (__IS_FLG(inode, SB_SYNCHRONOUS) || \
David Howellsbbc10962012-10-15 16:40:35 +01002025 ((inode)->i_flags & S_SYNC))
David Howellse462ec52017-07-17 08:45:35 +01002026#define IS_DIRSYNC(inode) (__IS_FLG(inode, SB_SYNCHRONOUS|SB_DIRSYNC) || \
David Howellsbbc10962012-10-15 16:40:35 +01002027 ((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
David Howellse462ec52017-07-17 08:45:35 +01002028#define IS_MANDLOCK(inode) __IS_FLG(inode, SB_MANDLOCK)
2029#define IS_NOATIME(inode) __IS_FLG(inode, SB_RDONLY|SB_NOATIME)
2030#define IS_I_VERSION(inode) __IS_FLG(inode, SB_I_VERSION)
David Howellsbbc10962012-10-15 16:40:35 +01002031
2032#define IS_NOQUOTA(inode) ((inode)->i_flags & S_NOQUOTA)
2033#define IS_APPEND(inode) ((inode)->i_flags & S_APPEND)
2034#define IS_IMMUTABLE(inode) ((inode)->i_flags & S_IMMUTABLE)
David Howellse462ec52017-07-17 08:45:35 +01002035#define IS_POSIXACL(inode) __IS_FLG(inode, SB_POSIXACL)
David Howellsbbc10962012-10-15 16:40:35 +01002036
2037#define IS_DEADDIR(inode) ((inode)->i_flags & S_DEAD)
2038#define IS_NOCMTIME(inode) ((inode)->i_flags & S_NOCMTIME)
2039#define IS_SWAPFILE(inode) ((inode)->i_flags & S_SWAPFILE)
2040#define IS_PRIVATE(inode) ((inode)->i_flags & S_PRIVATE)
2041#define IS_IMA(inode) ((inode)->i_flags & S_IMA)
2042#define IS_AUTOMOUNT(inode) ((inode)->i_flags & S_AUTOMOUNT)
2043#define IS_NOSEC(inode) ((inode)->i_flags & S_NOSEC)
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002044#define IS_DAX(inode) ((inode)->i_flags & S_DAX)
Eric Biggers2ee6a572017-10-09 12:15:35 -07002045#define IS_ENCRYPTED(inode) ((inode)->i_flags & S_ENCRYPTED)
Gabriel Krisman Bertazib886ee32019-04-25 14:12:08 -04002046#define IS_CASEFOLDED(inode) ((inode)->i_flags & S_CASEFOLD)
Eric Biggers5585f2a2019-07-22 09:26:21 -07002047#define IS_VERITY(inode) ((inode)->i_flags & S_VERITY)
David Howellsbbc10962012-10-15 16:40:35 +01002048
Miklos Szeredi787fb6b2014-10-24 00:14:36 +02002049#define IS_WHITEOUT(inode) (S_ISCHR(inode->i_mode) && \
2050 (inode)->i_rdev == WHITEOUT_DEV)
2051
Eric W. Biederman0bd23d092016-06-29 14:54:46 -05002052static inline bool HAS_UNMAPPED_ID(struct inode *inode)
2053{
2054 return !uid_valid(inode->i_uid) || !gid_valid(inode->i_gid);
2055}
2056
Jens Axboec75b1d92017-06-27 11:47:04 -06002057static inline enum rw_hint file_write_hint(struct file *file)
2058{
2059 if (file->f_write_hint != WRITE_LIFE_NOT_SET)
2060 return file->f_write_hint;
2061
2062 return file_inode(file)->i_write_hint;
2063}
2064
2065static inline int iocb_flags(struct file *file);
2066
Adam Manzanaresfc287242018-05-22 10:52:18 -07002067static inline u16 ki_hint_validate(enum rw_hint hint)
2068{
2069 typeof(((struct kiocb *)0)->ki_hint) max_hint = -1;
2070
2071 if (hint <= max_hint)
2072 return hint;
2073 return 0;
2074}
2075
Jens Axboec75b1d92017-06-27 11:47:04 -06002076static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
2077{
2078 *kiocb = (struct kiocb) {
2079 .ki_filp = filp,
2080 .ki_flags = iocb_flags(filp),
Adam Manzanaresfc287242018-05-22 10:52:18 -07002081 .ki_hint = ki_hint_validate(file_write_hint(filp)),
Damien Le Moal20578bd2018-11-20 10:52:38 +09002082 .ki_ioprio = get_current_ioprio(),
Jens Axboec75b1d92017-06-27 11:47:04 -06002083 };
2084}
2085
Jiufei Xue5dcdc432019-11-20 17:45:25 +08002086static inline void kiocb_clone(struct kiocb *kiocb, struct kiocb *kiocb_src,
2087 struct file *filp)
2088{
2089 *kiocb = (struct kiocb) {
2090 .ki_filp = filp,
2091 .ki_flags = kiocb_src->ki_flags,
2092 .ki_hint = kiocb_src->ki_hint,
2093 .ki_ioprio = kiocb_src->ki_ioprio,
2094 .ki_pos = kiocb_src->ki_pos,
2095 };
2096}
2097
David Howellsbbc10962012-10-15 16:40:35 +01002098/*
Dave Chinner250df6e2011-03-22 22:23:36 +11002099 * Inode state bits. Protected by inode->i_lock
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002100 *
2101 * Three bits determine the dirty state of the inode, I_DIRTY_SYNC,
2102 * I_DIRTY_DATASYNC and I_DIRTY_PAGES.
2103 *
2104 * Four bits define the lifetime of an inode. Initially, inodes are I_NEW,
2105 * until that flag is cleared. I_WILL_FREE, I_FREEING and I_CLEAR are set at
2106 * various stages of removing an inode.
2107 *
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002108 * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002109 *
Joern Engele7ca2d42008-02-06 01:36:59 -08002110 * I_DIRTY_SYNC Inode is dirty, but doesn't have to be written on
2111 * fdatasync(). i_atime is the usual cause.
Jan Kara000cb482008-02-14 19:31:32 -08002112 * I_DIRTY_DATASYNC Data-related inode changes pending. We keep track of
2113 * these changes separately from I_DIRTY_SYNC so that we
2114 * don't have to write inode on fdatasync() when only
2115 * mtime has changed in it.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002116 * I_DIRTY_PAGES Inode has dirty pages. Inode itself may be clean.
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002117 * I_NEW Serves as both a mutex and completion notification.
2118 * New inodes set I_NEW. If two processes both create
2119 * the same inode, one of them will release its inode and
2120 * wait for I_NEW to be released before returning.
2121 * Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can
2122 * also cause waiting on I_NEW, without I_NEW actually
2123 * being set. find_inode() uses this to prevent returning
2124 * nearly-dead inodes.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002125 * I_WILL_FREE Must be set when calling write_inode_now() if i_count
2126 * is zero. I_FREEING must be set when I_WILL_FREE is
2127 * cleared.
2128 * I_FREEING Set when inode is about to be freed but still has dirty
2129 * pages or buffers attached or the inode itself is still
2130 * dirty.
Jan Karadbd57682012-05-03 14:48:02 +02002131 * I_CLEAR Added by clear_inode(). In this state the inode is
2132 * clean and can be destroyed. Inode keeps I_FREEING.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002133 *
2134 * Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are
2135 * prohibited for many purposes. iget() must wait for
2136 * the inode to be completely released, then create it
2137 * anew. Other functions will just ignore such inodes,
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002138 * if appropriate. I_NEW is used for waiting.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002139 *
Jan Kara169ebd92012-05-03 14:48:03 +02002140 * I_SYNC Writeback of inode is running. The bit is set during
2141 * data writeback, and cleared with a wakeup on the bit
2142 * address once it is done. The bit is also used to pin
2143 * the inode in memory for flusher thread.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002144 *
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -04002145 * I_REFERENCED Marks the inode as recently references on the LRU list.
2146 *
2147 * I_DIO_WAKEUP Never set. Only used as a key for wait_on_bit().
2148 *
Tejun Heo682aa8e2015-05-28 14:50:53 -04002149 * I_WB_SWITCH Cgroup bdi_writeback switching in progress. Used to
2150 * synchronize competing switching instances and to tell
Matthew Wilcoxb93b0162018-04-10 16:36:56 -07002151 * wb stat updates to grab the i_pages lock. See
Greg Thelena9519de2019-03-05 15:50:03 -08002152 * inode_switch_wbs_work_fn() for details.
Tejun Heo682aa8e2015-05-28 14:50:53 -04002153 *
Amir Goldsteinad0af712017-06-21 15:28:32 +03002154 * I_OVL_INUSE Used by overlayfs to get exclusive ownership on upper
2155 * and work dirs among overlayfs mounts.
2156 *
Al Viroc2b6d622018-06-28 15:53:17 -04002157 * I_CREATING New object's inode in the middle of setting up.
2158 *
Ira Weinydae2f8e2020-04-30 07:41:37 -07002159 * I_DONTCACHE Evict inode as soon as it is not used anymore.
2160 *
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002161 * Q: What is the difference between I_WILL_FREE and I_FREEING?
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002162 */
Nick Piggin9e38d862010-10-23 06:55:17 -04002163#define I_DIRTY_SYNC (1 << 0)
2164#define I_DIRTY_DATASYNC (1 << 1)
2165#define I_DIRTY_PAGES (1 << 2)
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002166#define __I_NEW 3
2167#define I_NEW (1 << __I_NEW)
Nick Piggin9e38d862010-10-23 06:55:17 -04002168#define I_WILL_FREE (1 << 4)
2169#define I_FREEING (1 << 5)
2170#define I_CLEAR (1 << 6)
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002171#define __I_SYNC 7
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002172#define I_SYNC (1 << __I_SYNC)
Nick Piggin9e38d862010-10-23 06:55:17 -04002173#define I_REFERENCED (1 << 8)
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -04002174#define __I_DIO_WAKEUP 9
Eric Sandeenac74d8d2015-04-16 15:04:56 -05002175#define I_DIO_WAKEUP (1 << __I_DIO_WAKEUP)
Al Virof4e0c302013-06-11 08:34:36 +04002176#define I_LINKABLE (1 << 10)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05002177#define I_DIRTY_TIME (1 << 11)
2178#define __I_DIRTY_TIME_EXPIRED 12
2179#define I_DIRTY_TIME_EXPIRED (1 << __I_DIRTY_TIME_EXPIRED)
Tejun Heo682aa8e2015-05-28 14:50:53 -04002180#define I_WB_SWITCH (1 << 13)
Al Viroc2b6d622018-06-28 15:53:17 -04002181#define I_OVL_INUSE (1 << 14)
2182#define I_CREATING (1 << 15)
Ira Weinydae2f8e2020-04-30 07:41:37 -07002183#define I_DONTCACHE (1 << 16)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184
Christoph Hellwig0e11f642018-02-21 07:54:49 -08002185#define I_DIRTY_INODE (I_DIRTY_SYNC | I_DIRTY_DATASYNC)
2186#define I_DIRTY (I_DIRTY_INODE | I_DIRTY_PAGES)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05002187#define I_DIRTY_ALL (I_DIRTY | I_DIRTY_TIME)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002188
2189extern void __mark_inode_dirty(struct inode *, int);
2190static inline void mark_inode_dirty(struct inode *inode)
2191{
2192 __mark_inode_dirty(inode, I_DIRTY);
2193}
2194
2195static inline void mark_inode_dirty_sync(struct inode *inode)
2196{
2197 __mark_inode_dirty(inode, I_DIRTY_SYNC);
2198}
2199
Miklos Szeredi7ada4db2011-11-21 12:11:32 +01002200extern void inc_nlink(struct inode *inode);
2201extern void drop_nlink(struct inode *inode);
2202extern void clear_nlink(struct inode *inode);
2203extern void set_nlink(struct inode *inode, unsigned int nlink);
Dave Hansend8c76e62006-09-30 23:29:04 -07002204
2205static inline void inode_inc_link_count(struct inode *inode)
2206{
2207 inc_nlink(inode);
Alexey Dobriyan66d21732006-03-23 03:00:51 -08002208 mark_inode_dirty(inode);
2209}
2210
Dave Hansen9a53c3a2006-09-30 23:29:03 -07002211static inline void inode_dec_link_count(struct inode *inode)
2212{
2213 drop_nlink(inode);
Alexey Dobriyan66d21732006-03-23 03:00:51 -08002214 mark_inode_dirty(inode);
2215}
2216
Josef Bacikc3b2da32012-03-26 09:59:21 -04002217enum file_time_flags {
2218 S_ATIME = 1,
2219 S_MTIME = 2,
2220 S_CTIME = 4,
2221 S_VERSION = 8,
2222};
2223
Miklos Szeredic6718542018-07-18 15:44:43 +02002224extern bool atime_needs_update(const struct path *, struct inode *);
Al Virobadcf2b2013-07-16 18:15:46 +04002225extern void touch_atime(const struct path *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002226static inline void file_accessed(struct file *file)
2227{
2228 if (!(file->f_flags & O_NOATIME))
Al Viro68ac1232012-03-15 08:21:57 -04002229 touch_atime(&file->f_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002230}
2231
Amir Goldsteine38f7f52019-06-05 08:04:49 -07002232extern int file_modified(struct file *file);
2233
Linus Torvalds1da177e2005-04-16 15:20:36 -07002234int sync_inode(struct inode *inode, struct writeback_control *wbc);
Christoph Hellwigc37650162010-10-06 10:48:20 +02002235int sync_inode_metadata(struct inode *inode, int wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002236
Linus Torvalds1da177e2005-04-16 15:20:36 -07002237struct file_system_type {
2238 const char *name;
2239 int fs_flags;
David Howellsbbc10962012-10-15 16:40:35 +01002240#define FS_REQUIRES_DEV 1
2241#define FS_BINARY_MOUNTDATA 2
2242#define FS_HAS_SUBTYPE 4
Eric W. Biederman0c55cfc2012-07-26 21:42:03 -07002243#define FS_USERNS_MOUNT 8 /* Can be mounted by userns root */
Jan Kara0b3b0942019-05-15 16:28:34 +02002244#define FS_DISALLOW_NOTIFY_PERM 16 /* Disable fanotify permission events */
David Howellsbbc10962012-10-15 16:40:35 +01002245#define FS_RENAME_DOES_D_MOVE 32768 /* FS will handle d_move() during rename() internally. */
Al Virof3a09c92018-12-23 18:55:56 -05002246 int (*init_fs_context)(struct fs_context *);
Al Virod7167b12019-09-07 07:23:15 -04002247 const struct fs_parameter_spec *parameters;
Al Viroc96e41e2010-07-25 00:17:56 +04002248 struct dentry *(*mount) (struct file_system_type *, int,
2249 const char *, void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250 void (*kill_sb) (struct super_block *);
2251 struct module *owner;
2252 struct file_system_type * next;
Al Viroa5166162011-12-12 22:53:00 -05002253 struct hlist_head fs_supers;
Peter Zijlstrad475fd42007-10-15 14:51:31 +02002254
Ingo Molnarcf516242006-07-03 00:25:27 -07002255 struct lock_class_key s_lock_key;
Arjan van de Ven897c6ff2006-07-03 00:25:28 -07002256 struct lock_class_key s_umount_key;
Roland Dreier51ee0492010-04-27 14:23:57 -07002257 struct lock_class_key s_vfs_rename_key;
Jan Kara5accdf82012-06-12 16:20:34 +02002258 struct lock_class_key s_writers_key[SB_FREEZE_LEVELS];
Peter Zijlstrad475fd42007-10-15 14:51:31 +02002259
2260 struct lock_class_key i_lock_key;
2261 struct lock_class_key i_mutex_key;
Peter Zijlstra14358e62007-10-14 01:38:33 +02002262 struct lock_class_key i_mutex_dir_key;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263};
2264
Eric W. Biederman7f78e032013-03-02 19:39:14 -08002265#define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME)
2266
Al Virof175f302017-10-15 00:38:00 -04002267#ifdef CONFIG_BLOCK
Al Viro152a0832010-07-25 00:46:55 +04002268extern struct dentry *mount_bdev(struct file_system_type *fs_type,
2269 int flags, const char *dev_name, void *data,
2270 int (*fill_super)(struct super_block *, void *, int));
Al Virof175f302017-10-15 00:38:00 -04002271#else
2272static inline struct dentry *mount_bdev(struct file_system_type *fs_type,
2273 int flags, const char *dev_name, void *data,
2274 int (*fill_super)(struct super_block *, void *, int))
2275{
2276 return ERR_PTR(-ENODEV);
2277}
2278#endif
Al Virofc14f2f2010-07-25 01:48:30 +04002279extern struct dentry *mount_single(struct file_system_type *fs_type,
2280 int flags, void *data,
2281 int (*fill_super)(struct super_block *, void *, int));
Al Viro3c26ff62010-07-25 11:46:36 +04002282extern struct dentry *mount_nodev(struct file_system_type *fs_type,
2283 int flags, void *data,
2284 int (*fill_super)(struct super_block *, void *, int));
Al Viroea441d12011-11-16 21:43:59 -05002285extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002286void generic_shutdown_super(struct super_block *sb);
Al Virof175f302017-10-15 00:38:00 -04002287#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002288void kill_block_super(struct super_block *sb);
Al Virof175f302017-10-15 00:38:00 -04002289#else
2290static inline void kill_block_super(struct super_block *sb)
2291{
2292 BUG();
2293}
2294#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002295void kill_anon_super(struct super_block *sb);
2296void kill_litter_super(struct super_block *sb);
2297void deactivate_super(struct super_block *sb);
Al Viro74dbbdd2009-05-06 01:07:50 -04002298void deactivate_locked_super(struct super_block *sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002299int set_anon_super(struct super_block *s, void *data);
Al Virocb50b342018-12-23 17:25:47 -05002300int set_anon_super_fc(struct super_block *s, struct fs_context *fc);
Al Viro0ee5dc62011-07-07 15:44:25 -04002301int get_anon_bdev(dev_t *);
2302void free_anon_bdev(dev_t);
Al Virocb50b342018-12-23 17:25:47 -05002303struct super_block *sget_fc(struct fs_context *fc,
2304 int (*test)(struct super_block *, struct fs_context *),
2305 int (*set)(struct super_block *, struct fs_context *));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306struct super_block *sget(struct file_system_type *type,
2307 int (*test)(struct super_block *,void *),
2308 int (*set)(struct super_block *,void *),
David Howells9249e172012-06-25 12:55:37 +01002309 int flags, void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002310
2311/* Alas, no aliases. Too much hassle with bringing module.h everywhere */
2312#define fops_get(fops) \
2313 (((fops) && try_module_get((fops)->owner) ? (fops) : NULL))
2314#define fops_put(fops) \
2315 do { if (fops) module_put((fops)->owner); } while(0)
Al Viroe84f9e52013-09-22 14:17:15 -04002316/*
2317 * This one is to be used *ONLY* from ->open() instances.
2318 * fops must be non-NULL, pinned down *and* module dependencies
2319 * should be sufficient to pin the caller down as well.
2320 */
2321#define replace_fops(f, fops) \
2322 do { \
2323 struct file *__file = (f); \
2324 fops_put(__file->f_op); \
2325 BUG_ON(!(__file->f_op = (fops))); \
2326 } while(0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002327
2328extern int register_filesystem(struct file_system_type *);
2329extern int unregister_filesystem(struct file_system_type *);
David Howellsd911b452018-11-01 23:07:26 +00002330extern struct vfsmount *kern_mount(struct file_system_type *);
Tim Chen423e0ab2011-07-19 09:32:38 -07002331extern void kern_unmount(struct vfsmount *mnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002332extern int may_umount_tree(struct vfsmount *);
2333extern int may_umount(struct vfsmount *);
Seunghun Lee5e6123f2014-09-14 22:15:10 +09002334extern long do_mount(const char *, const char __user *,
2335 const char *, unsigned long, void *);
Al Viroca71cf72016-11-20 19:45:28 -05002336extern struct vfsmount *collect_mounts(const struct path *);
Al Viro8aec0802007-06-07 12:20:32 -04002337extern void drop_collected_mounts(struct vfsmount *);
Al Viro1f707132010-01-30 22:51:25 -05002338extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
2339 struct vfsmount *);
Al Virof0bb5aa2016-11-20 20:27:12 -05002340extern int vfs_statfs(const struct path *, struct kstatfs *);
Al Viroc8b91ac2011-03-12 10:41:39 -05002341extern int user_statfs(const char __user *, struct kstatfs *);
2342extern int fd_statfs(int, struct kstatfs *);
Josef Bacik18e9e512010-03-23 10:34:56 -04002343extern int freeze_super(struct super_block *super);
2344extern int thaw_super(struct super_block *super);
Al Viro02125a82011-12-05 08:43:34 -05002345extern bool our_mnt(struct vfsmount *mnt);
Jan Karafca39342017-04-12 12:24:28 +02002346extern __printf(2, 3)
2347int super_setup_bdi_name(struct super_block *sb, char *fmt, ...);
2348extern int super_setup_bdi(struct super_block *sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349
Al Viroce3b0f82009-03-29 19:08:22 -04002350extern int current_umask(void);
2351
J. Bruce Fields5a146962012-08-28 07:50:40 -07002352extern void ihold(struct inode * inode);
2353extern void iput(struct inode *);
Deepa Dinamani95582b02018-05-08 19:36:02 -07002354extern int generic_update_time(struct inode *, struct timespec64 *, int);
J. Bruce Fields5a146962012-08-28 07:50:40 -07002355
Miklos Szeredif87fd4c2006-01-16 22:14:23 -08002356/* /sys/fs */
Greg Kroah-Hartman00d26662007-10-29 14:17:23 -06002357extern struct kobject *fs_kobj;
Miklos Szeredif87fd4c2006-01-16 22:14:23 -08002358
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002359#define MAX_RW_COUNT (INT_MAX & PAGE_MASK)
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002360
Jeff Layton9e8925b2015-11-16 09:49:34 -05002361#ifdef CONFIG_MANDATORY_FILE_LOCKING
Jeff Laytond7a06982014-03-10 09:54:15 -04002362extern int locks_mandatory_locked(struct file *);
Christoph Hellwigacc15572015-12-03 12:59:49 +01002363extern int locks_mandatory_area(struct inode *, struct file *, loff_t, loff_t, unsigned char);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002364
2365/*
2366 * Candidates for mandatory locking have the setgid bit set
2367 * but no group execute bit - an otherwise meaningless combination.
2368 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002369
2370static inline int __mandatory_lock(struct inode *ino)
2371{
2372 return (ino->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID;
2373}
2374
2375/*
David Howellse462ec52017-07-17 08:45:35 +01002376 * ... and these candidates should be on SB_MANDLOCK mounted fs,
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002377 * otherwise these will be advisory locks
2378 */
2379
2380static inline int mandatory_lock(struct inode *ino)
2381{
2382 return IS_MANDLOCK(ino) && __mandatory_lock(ino);
2383}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002384
Jeff Laytond7a06982014-03-10 09:54:15 -04002385static inline int locks_verify_locked(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002386{
Miklos Szeredic568d682016-09-16 12:44:20 +02002387 if (mandatory_lock(locks_inode(file)))
Jeff Laytond7a06982014-03-10 09:54:15 -04002388 return locks_mandatory_locked(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002389 return 0;
2390}
2391
Linus Torvalds1da177e2005-04-16 15:20:36 -07002392static inline int locks_verify_truncate(struct inode *inode,
Christoph Hellwigacc15572015-12-03 12:59:49 +01002393 struct file *f,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002394 loff_t size)
2395{
Christoph Hellwigacc15572015-12-03 12:59:49 +01002396 if (!inode->i_flctx || !mandatory_lock(inode))
2397 return 0;
2398
2399 if (size < inode->i_size) {
2400 return locks_mandatory_area(inode, f, size, inode->i_size - 1,
2401 F_WRLCK);
2402 } else {
2403 return locks_mandatory_area(inode, f, inode->i_size, size - 1,
2404 F_WRLCK);
2405 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002406}
2407
Jeff Layton9e8925b2015-11-16 09:49:34 -05002408#else /* !CONFIG_MANDATORY_FILE_LOCKING */
2409
2410static inline int locks_mandatory_locked(struct file *file)
2411{
2412 return 0;
2413}
2414
Linus Torvaldsfce205e2016-01-12 16:30:34 -08002415static inline int locks_mandatory_area(struct inode *inode, struct file *filp,
2416 loff_t start, loff_t end, unsigned char type)
Jeff Layton9e8925b2015-11-16 09:49:34 -05002417{
2418 return 0;
2419}
2420
2421static inline int __mandatory_lock(struct inode *inode)
2422{
2423 return 0;
2424}
2425
2426static inline int mandatory_lock(struct inode *inode)
2427{
2428 return 0;
2429}
2430
2431static inline int locks_verify_locked(struct file *file)
2432{
2433 return 0;
2434}
2435
2436static inline int locks_verify_truncate(struct inode *inode, struct file *filp,
2437 size_t size)
2438{
2439 return 0;
2440}
2441
2442#endif /* CONFIG_MANDATORY_FILE_LOCKING */
2443
2444
2445#ifdef CONFIG_FILE_LOCKING
Linus Torvalds1da177e2005-04-16 15:20:36 -07002446static inline int break_lease(struct inode *inode, unsigned int mode)
2447{
Jeff Layton24cbe782014-02-03 12:13:06 -05002448 /*
2449 * Since this check is lockless, we must ensure that any refcounts
Jeff Layton8116bf42015-01-21 20:44:01 -05002450 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2451 * could end up racing with tasks trying to set a new lease on this
2452 * file.
Jeff Layton24cbe782014-02-03 12:13:06 -05002453 */
2454 smp_mb();
Jeff Layton8634b512015-01-16 15:05:55 -05002455 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002456 return __break_lease(inode, mode, FL_LEASE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002457 return 0;
2458}
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002459
2460static inline int break_deleg(struct inode *inode, unsigned int mode)
2461{
Jeff Layton962bd402014-06-10 12:24:40 -04002462 /*
2463 * Since this check is lockless, we must ensure that any refcounts
Jeff Layton8116bf42015-01-21 20:44:01 -05002464 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2465 * could end up racing with tasks trying to set a new lease on this
2466 * file.
Jeff Layton962bd402014-06-10 12:24:40 -04002467 */
2468 smp_mb();
Jeff Layton8634b512015-01-16 15:05:55 -05002469 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002470 return __break_lease(inode, mode, FL_DELEG);
2471 return 0;
2472}
2473
J. Bruce Fields5a146962012-08-28 07:50:40 -07002474static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2475{
2476 int ret;
2477
2478 ret = break_deleg(inode, O_WRONLY|O_NONBLOCK);
2479 if (ret == -EWOULDBLOCK && delegated_inode) {
2480 *delegated_inode = inode;
2481 ihold(inode);
2482 }
2483 return ret;
2484}
2485
2486static inline int break_deleg_wait(struct inode **delegated_inode)
2487{
2488 int ret;
2489
2490 ret = break_deleg(*delegated_inode, O_WRONLY);
2491 iput(*delegated_inode);
2492 *delegated_inode = NULL;
2493 return ret;
2494}
2495
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01002496static inline int break_layout(struct inode *inode, bool wait)
2497{
2498 smp_mb();
2499 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2500 return __break_lease(inode,
2501 wait ? O_WRONLY : O_WRONLY | O_NONBLOCK,
2502 FL_LAYOUT);
2503 return 0;
2504}
2505
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002506#else /* !CONFIG_FILE_LOCKING */
Steven Whitehouseaf5df562009-01-20 10:29:46 +00002507static inline int break_lease(struct inode *inode, unsigned int mode)
2508{
2509 return 0;
2510}
2511
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002512static inline int break_deleg(struct inode *inode, unsigned int mode)
2513{
2514 return 0;
2515}
J. Bruce Fields5a146962012-08-28 07:50:40 -07002516
2517static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2518{
2519 return 0;
2520}
2521
2522static inline int break_deleg_wait(struct inode **delegated_inode)
2523{
2524 BUG();
2525 return 0;
2526}
2527
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01002528static inline int break_layout(struct inode *inode, bool wait)
2529{
2530 return 0;
2531}
2532
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002533#endif /* CONFIG_FILE_LOCKING */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002534
2535/* fs/open.c */
Jeff Laytonadb5c242012-10-10 16:43:13 -04002536struct audit_names;
Jeff Layton91a27b22012-10-10 15:25:28 -04002537struct filename {
Jeff Laytonadb5c242012-10-10 16:43:13 -04002538 const char *name; /* pointer to actual string */
2539 const __user char *uptr; /* original userland pointer */
Paul Moore55422d02015-01-22 00:00:23 -05002540 int refcnt;
Rasmus Villemoes1c9498432018-03-01 00:19:21 +01002541 struct audit_names *aname;
Al Virofd2f7cb2015-02-22 20:07:13 -05002542 const char iname[];
Jeff Layton91a27b22012-10-10 15:25:28 -04002543};
Rasmus Villemoesf1fffbd2019-03-07 16:27:07 -08002544static_assert(offsetof(struct filename, iname) % sizeof(long) == 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002545
Al Viro7df818b2016-03-25 14:24:09 -04002546extern long vfs_truncate(const struct path *, loff_t);
NeilBrown4a301312006-01-08 01:02:39 -08002547extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
2548 struct file *filp);
Anna Schumaker72c72bd2014-11-07 14:44:25 -05002549extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
Ankit Jain3e63cbb2009-06-19 14:28:07 -04002550 loff_t len);
Jason Uhlenkott8e8a1402007-10-20 03:16:18 +02002551extern long do_sys_open(int dfd, const char __user *filename, int flags,
Al Viroa218d0f2011-11-21 14:59:34 -05002552 umode_t mode);
Jeff Layton669abf42012-10-10 16:43:10 -04002553extern struct file *file_open_name(struct filename *, int, umode_t);
Al Viroa218d0f2011-11-21 14:59:34 -05002554extern struct file *filp_open(const char *, int, umode_t);
Al Viro73d049a2011-03-11 12:08:24 -05002555extern struct file *file_open_root(struct dentry *, struct vfsmount *,
Jann Horn378c6522016-03-22 14:25:36 -07002556 const char *, int, umode_t);
Al Viro765927b2012-06-26 21:58:53 +04002557extern struct file * dentry_open(const struct path *, int, const struct cred *);
Al Viro2abc77a2018-07-12 11:18:42 -04002558extern struct file * open_with_fake_path(const struct path *, int,
2559 struct inode*, const struct cred *);
Al Viro19f391e2018-06-08 11:19:32 -04002560static inline struct file *file_clone_open(struct file *file)
2561{
2562 return dentry_open(&file->f_path, file->f_flags, file->f_cred);
2563}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002564extern int filp_close(struct file *, fl_owner_t id);
Jeff Layton91a27b22012-10-10 15:25:28 -04002565
David Drysdale51f39a12014-12-12 16:57:29 -08002566extern struct filename *getname_flags(const char __user *, int, int *);
Jeff Layton91a27b22012-10-10 15:25:28 -04002567extern struct filename *getname(const char __user *);
Linus Torvaldsc4ad8f92014-02-05 12:54:53 -08002568extern struct filename *getname_kernel(const char *);
Paul Moore55422d02015-01-22 00:00:23 -05002569extern void putname(struct filename *name);
Jeff Layton91a27b22012-10-10 15:25:28 -04002570
Al Viro30d90492012-06-22 12:40:19 +04002571extern int finish_open(struct file *file, struct dentry *dentry,
Al Virobe12af32018-06-08 11:44:56 -04002572 int (*open)(struct inode *, struct file *));
Al Viroe45198a2012-06-10 06:48:09 -04002573extern int finish_no_open(struct file *file, struct dentry *dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002574
2575/* fs/dcache.c */
2576extern void __init vfs_caches_init_early(void);
Mel Gorman4248b0d2015-08-06 15:46:20 -07002577extern void __init vfs_caches_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002578
Christoph Lameterb86c0892006-12-06 20:32:57 -08002579extern struct kmem_cache *names_cachep;
2580
Jeff Laytona608ca22012-10-10 15:25:26 -04002581#define __getname() kmem_cache_alloc(names_cachep, GFP_KERNEL)
Vegard Nossum3446a8a2009-05-16 11:22:14 +02002582#define __putname(name) kmem_cache_free(names_cachep, (void *)(name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002583
David Howells93614012006-09-30 20:45:40 +02002584#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002585extern int register_blkdev(unsigned int, const char *);
Akinobu Mitaf4480242007-07-17 04:03:47 -07002586extern void unregister_blkdev(unsigned int, const char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002587extern struct block_device *bdget(dev_t);
Alan Jenkinsdddac6a2009-07-29 21:07:55 +02002588extern struct block_device *bdgrab(struct block_device *bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002589extern void bd_set_size(struct block_device *, loff_t size);
2590extern void bd_forget(struct inode *inode);
2591extern void bdput(struct block_device *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002592extern void invalidate_bdev(struct block_device *);
Jan Kara5c0d6b62012-07-03 16:45:31 +02002593extern void iterate_bdevs(void (*)(struct block_device *, void *), void *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002594extern int sync_blockdev(struct block_device *bdev);
Al Viroff01bb42011-09-16 02:31:11 -04002595extern void kill_bdev(struct block_device *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002596extern struct super_block *freeze_bdev(struct block_device *);
Eric Sandeenc2d75432009-03-31 15:23:46 -07002597extern void emergency_thaw_all(void);
Mateusz Guzik08fdc8a2017-10-03 18:17:41 +02002598extern void emergency_thaw_bdev(struct super_block *sb);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002599extern int thaw_bdev(struct block_device *bdev, struct super_block *sb);
2600extern int fsync_bdev(struct block_device *);
Tejun Heoa212b102015-05-22 17:13:33 -04002601
2602extern struct super_block *blockdev_superblock;
2603
2604static inline bool sb_is_blkdev_sb(struct super_block *sb)
2605{
2606 return sb == blockdev_superblock;
2607}
David Howells93614012006-09-30 20:45:40 +02002608#else
2609static inline void bd_forget(struct inode *inode) {}
Al Viro47e44912009-04-01 07:07:16 -04002610static inline int sync_blockdev(struct block_device *bdev) { return 0; }
Al Viroff01bb42011-09-16 02:31:11 -04002611static inline void kill_bdev(struct block_device *bdev) {}
Al Viro47e44912009-04-01 07:07:16 -04002612static inline void invalidate_bdev(struct block_device *bdev) {}
2613
2614static inline struct super_block *freeze_bdev(struct block_device *sb)
2615{
2616 return NULL;
2617}
2618
2619static inline int thaw_bdev(struct block_device *bdev, struct super_block *sb)
2620{
2621 return 0;
2622}
Jan Kara5c0d6b62012-07-03 16:45:31 +02002623
Mateusz Guzik08fdc8a2017-10-03 18:17:41 +02002624static inline int emergency_thaw_bdev(struct super_block *sb)
2625{
2626 return 0;
2627}
2628
Jan Kara5c0d6b62012-07-03 16:45:31 +02002629static inline void iterate_bdevs(void (*f)(struct block_device *, void *), void *arg)
2630{
2631}
Jan Karaa8855992013-07-09 22:36:45 +08002632
Yaowei Bai3e004ee2015-11-17 14:40:09 +08002633static inline bool sb_is_blkdev_sb(struct super_block *sb)
Jan Karaa8855992013-07-09 22:36:45 +08002634{
Yaowei Bai3e004ee2015-11-17 14:40:09 +08002635 return false;
Jan Karaa8855992013-07-09 22:36:45 +08002636}
David Howells93614012006-09-30 20:45:40 +02002637#endif
Jan Kara60b06802009-04-27 16:43:53 +02002638extern int sync_filesystem(struct super_block *);
David Howells93614012006-09-30 20:45:40 +02002639extern const struct file_operations def_blk_fops;
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08002640extern const struct file_operations def_chr_fops;
David Howells93614012006-09-30 20:45:40 +02002641#ifdef CONFIG_BLOCK
Al Viro56b26ad2008-09-19 03:17:36 -04002642extern int blkdev_ioctl(struct block_device *, fmode_t, unsigned, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002643extern long compat_blkdev_ioctl(struct file *, unsigned, unsigned long);
Tejun Heoe525fd82010-11-13 11:55:17 +01002644extern int blkdev_get(struct block_device *bdev, fmode_t mode, void *holder);
Tejun Heod4d77622010-11-13 11:55:18 +01002645extern struct block_device *blkdev_get_by_path(const char *path, fmode_t mode,
2646 void *holder);
2647extern struct block_device *blkdev_get_by_dev(dev_t dev, fmode_t mode,
2648 void *holder);
Jan Kara89e524c02019-07-30 13:10:14 +02002649extern struct block_device *bd_start_claiming(struct block_device *bdev,
2650 void *holder);
2651extern void bd_finish_claiming(struct block_device *bdev,
2652 struct block_device *whole, void *holder);
2653extern void bd_abort_claiming(struct block_device *bdev,
2654 struct block_device *whole, void *holder);
Al Viro4385bab2013-05-05 22:11:03 -04002655extern void blkdev_put(struct block_device *bdev, fmode_t mode);
Jarod Wilsonbe324172015-05-06 12:26:22 +08002656
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002657#ifdef CONFIG_SYSFS
Tejun Heoe09b4572010-11-13 11:55:17 +01002658extern int bd_link_disk_holder(struct block_device *bdev, struct gendisk *disk);
Tejun Heo49731ba2011-01-14 18:43:57 +01002659extern void bd_unlink_disk_holder(struct block_device *bdev,
2660 struct gendisk *disk);
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002661#else
Tejun Heoe09b4572010-11-13 11:55:17 +01002662static inline int bd_link_disk_holder(struct block_device *bdev,
2663 struct gendisk *disk)
2664{
2665 return 0;
2666}
Tejun Heo49731ba2011-01-14 18:43:57 +01002667static inline void bd_unlink_disk_holder(struct block_device *bdev,
2668 struct gendisk *disk)
2669{
2670}
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002671#endif
David Howells93614012006-09-30 20:45:40 +02002672#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002673
2674/* fs/char_dev.c */
Logan Gunthorpe8a932f72017-06-15 14:05:21 -06002675#define CHRDEV_MAJOR_MAX 512
Linus Walleij49db08c2016-02-19 15:36:07 +01002676/* Marks the bottom of the first segment of free char majors */
2677#define CHRDEV_MAJOR_DYN_END 234
Logan Gunthorpea5d31a32017-06-15 14:05:20 -06002678/* Marks the top and bottom of the second segment of free char majors */
2679#define CHRDEV_MAJOR_DYN_EXT_START 511
2680#define CHRDEV_MAJOR_DYN_EXT_END 384
2681
Linus Torvalds1da177e2005-04-16 15:20:36 -07002682extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
2683extern int register_chrdev_region(dev_t, unsigned, const char *);
Tejun Heo1905b1b2009-08-06 18:13:23 +09002684extern int __register_chrdev(unsigned int major, unsigned int baseminor,
2685 unsigned int count, const char *name,
2686 const struct file_operations *fops);
2687extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
2688 unsigned int count, const char *name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002689extern void unregister_chrdev_region(dev_t, unsigned);
Joe Korty68eef3b2006-03-31 02:30:32 -08002690extern void chrdev_show(struct seq_file *,off_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002691
Tejun Heo1905b1b2009-08-06 18:13:23 +09002692static inline int register_chrdev(unsigned int major, const char *name,
2693 const struct file_operations *fops)
2694{
2695 return __register_chrdev(major, 0, 256, name, fops);
2696}
2697
2698static inline void unregister_chrdev(unsigned int major, const char *name)
2699{
2700 __unregister_chrdev(major, 0, 256, name);
2701}
2702
Linus Torvalds1da177e2005-04-16 15:20:36 -07002703/* fs/block_dev.c */
2704#define BDEVNAME_SIZE 32 /* Largest string for a blockdev identifier */
Tejun Heo1f014292008-08-25 19:47:23 +09002705#define BDEVT_SIZE 10 /* Largest string for MAJ:MIN for blkdev */
David Howells93614012006-09-30 20:45:40 +02002706
2707#ifdef CONFIG_BLOCK
Logan Gunthorpe133d55c2017-06-16 17:48:21 -06002708#define BLKDEV_MAJOR_MAX 512
Linus Torvalds1da177e2005-04-16 15:20:36 -07002709extern const char *bdevname(struct block_device *bdev, char *buffer);
2710extern struct block_device *lookup_bdev(const char *);
Joe Korty68eef3b2006-03-31 02:30:32 -08002711extern void blkdev_show(struct seq_file *,off_t);
Al Viro30c40d22008-02-22 19:50:45 -05002712
David Howells93614012006-09-30 20:45:40 +02002713#else
Logan Gunthorpe133d55c2017-06-16 17:48:21 -06002714#define BLKDEV_MAJOR_MAX 0
David Howells93614012006-09-30 20:45:40 +02002715#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002716
2717extern void init_special_inode(struct inode *, umode_t, dev_t);
2718
2719/* Invalid inode operations -- fs/bad_inode.c */
2720extern void make_bad_inode(struct inode *);
Yaowei Bai0e3ef1f2015-11-19 21:00:11 +08002721extern bool is_bad_inode(struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002722
Jens Axboec11f0c02016-08-05 08:11:04 -06002723#ifdef CONFIG_BLOCK
Andrew Patterson0c002c22008-09-04 14:27:20 -06002724extern int revalidate_disk(struct gendisk *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002725extern int check_disk_change(struct block_device *);
NeilBrown93b270f2011-02-24 17:25:47 +11002726extern int __invalidate_device(struct block_device *, bool);
David Howells93614012006-09-30 20:45:40 +02002727#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002728unsigned long invalidate_mapping_pages(struct address_space *mapping,
2729 pgoff_t start, pgoff_t end);
Anton Altaparmakov54bc4852007-02-10 01:45:38 -08002730
Linus Torvalds1da177e2005-04-16 15:20:36 -07002731static inline void invalidate_remote_inode(struct inode *inode)
2732{
2733 if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
2734 S_ISLNK(inode->i_mode))
Andrew Mortonfc0ecff2007-02-10 01:45:39 -08002735 invalidate_mapping_pages(inode->i_mapping, 0, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002736}
2737extern int invalidate_inode_pages2(struct address_space *mapping);
2738extern int invalidate_inode_pages2_range(struct address_space *mapping,
2739 pgoff_t start, pgoff_t end);
2740extern int write_inode_now(struct inode *, int);
2741extern int filemap_fdatawrite(struct address_space *);
2742extern int filemap_flush(struct address_space *);
Jeff Layton76341ca2017-07-06 07:02:22 -04002743extern int filemap_fdatawait_keep_errors(struct address_space *mapping);
Jan Karad3bccb6f2009-08-17 19:30:27 +02002744extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
2745 loff_t lend);
Ross Zwisleraa0bfcd2019-06-20 17:05:37 -04002746extern int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
2747 loff_t start_byte, loff_t end_byte);
Jeff Laytonffb959b2017-07-31 10:29:38 -04002748
2749static inline int filemap_fdatawait(struct address_space *mapping)
2750{
2751 return filemap_fdatawait_range(mapping, 0, LLONG_MAX);
2752}
2753
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -05002754extern bool filemap_range_has_page(struct address_space *, loff_t lstart,
2755 loff_t lend);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002756extern int filemap_write_and_wait_range(struct address_space *mapping,
2757 loff_t lstart, loff_t lend);
Andrew Mortonebcf28e2006-03-24 03:18:04 -08002758extern int __filemap_fdatawrite_range(struct address_space *mapping,
2759 loff_t start, loff_t end, int sync_mode);
Jan Karaf4c0a0f2008-07-11 19:27:31 -04002760extern int filemap_fdatawrite_range(struct address_space *mapping,
2761 loff_t start, loff_t end);
Miklos Szeredid72d9e22016-07-29 14:10:57 +02002762extern int filemap_check_errors(struct address_space *mapping);
Jeff Layton5660e132017-07-06 07:02:25 -04002763extern void __filemap_set_wb_err(struct address_space *mapping, int err);
Jeff Laytona823e452017-07-28 07:24:43 -04002764
Ira Weinyddf8f372020-01-30 22:12:07 -08002765static inline int filemap_write_and_wait(struct address_space *mapping)
2766{
2767 return filemap_write_and_wait_range(mapping, 0, LLONG_MAX);
2768}
2769
Jeff Laytona823e452017-07-28 07:24:43 -04002770extern int __must_check file_fdatawait_range(struct file *file, loff_t lstart,
2771 loff_t lend);
Jeff Layton5660e132017-07-06 07:02:25 -04002772extern int __must_check file_check_and_advance_wb_err(struct file *file);
2773extern int __must_check file_write_and_wait_range(struct file *file,
2774 loff_t start, loff_t end);
2775
Jeff Laytona823e452017-07-28 07:24:43 -04002776static inline int file_write_and_wait(struct file *file)
2777{
2778 return file_write_and_wait_range(file, 0, LLONG_MAX);
2779}
2780
Jeff Layton5660e132017-07-06 07:02:25 -04002781/**
2782 * filemap_set_wb_err - set a writeback error on an address_space
2783 * @mapping: mapping in which to set writeback error
2784 * @err: error to be set in mapping
2785 *
2786 * When writeback fails in some way, we must record that error so that
2787 * userspace can be informed when fsync and the like are called. We endeavor
2788 * to report errors on any file that was open at the time of the error. Some
2789 * internal callers also need to know when writeback errors have occurred.
2790 *
2791 * When a writeback error occurs, most filesystems will want to call
2792 * filemap_set_wb_err to record the error in the mapping so that it will be
2793 * automatically reported whenever fsync is called on the file.
Jeff Layton5660e132017-07-06 07:02:25 -04002794 */
2795static inline void filemap_set_wb_err(struct address_space *mapping, int err)
2796{
2797 /* Fastpath for common case of no error */
2798 if (unlikely(err))
2799 __filemap_set_wb_err(mapping, err);
2800}
2801
2802/**
2803 * filemap_check_wb_error - has an error occurred since the mark was sampled?
2804 * @mapping: mapping to check for writeback errors
2805 * @since: previously-sampled errseq_t
2806 *
2807 * Grab the errseq_t value from the mapping, and see if it has changed "since"
2808 * the given value was sampled.
2809 *
2810 * If it has then report the latest error set, otherwise return 0.
2811 */
2812static inline int filemap_check_wb_err(struct address_space *mapping,
2813 errseq_t since)
2814{
2815 return errseq_check(&mapping->wb_err, since);
2816}
2817
2818/**
2819 * filemap_sample_wb_err - sample the current errseq_t to test for later errors
2820 * @mapping: mapping to be sampled
2821 *
2822 * Writeback errors are always reported relative to a particular sample point
2823 * in the past. This function provides those sample points.
2824 */
2825static inline errseq_t filemap_sample_wb_err(struct address_space *mapping)
2826{
2827 return errseq_sample(&mapping->wb_err);
2828}
2829
Jeff Layton735e4ae2020-06-01 21:45:36 -07002830/**
2831 * file_sample_sb_err - sample the current errseq_t to test for later errors
2832 * @mapping: mapping to be sampled
2833 *
2834 * Grab the most current superblock-level errseq_t value for the given
2835 * struct file.
2836 */
2837static inline errseq_t file_sample_sb_err(struct file *file)
2838{
2839 return errseq_sample(&file->f_path.dentry->d_sb->s_wb_err);
2840}
2841
Song Liu09d91cd2019-09-23 15:38:03 -07002842static inline int filemap_nr_thps(struct address_space *mapping)
2843{
2844#ifdef CONFIG_READ_ONLY_THP_FOR_FS
2845 return atomic_read(&mapping->nr_thps);
2846#else
2847 return 0;
2848#endif
2849}
2850
2851static inline void filemap_nr_thps_inc(struct address_space *mapping)
2852{
2853#ifdef CONFIG_READ_ONLY_THP_FOR_FS
2854 atomic_inc(&mapping->nr_thps);
2855#else
2856 WARN_ON_ONCE(1);
2857#endif
2858}
2859
2860static inline void filemap_nr_thps_dec(struct address_space *mapping)
2861{
2862#ifdef CONFIG_READ_ONLY_THP_FOR_FS
2863 atomic_dec(&mapping->nr_thps);
2864#else
2865 WARN_ON_ONCE(1);
2866#endif
2867}
2868
Christoph Hellwig8018ab02010-03-22 17:32:25 +01002869extern int vfs_fsync_range(struct file *file, loff_t start, loff_t end,
2870 int datasync);
2871extern int vfs_fsync(struct file *file, int datasync);
Christoph Hellwige2592212016-04-07 08:52:01 -07002872
Jens Axboe22f96b32019-04-09 14:51:48 -06002873extern int sync_file_range(struct file *file, loff_t offset, loff_t nbytes,
2874 unsigned int flags);
2875
Christoph Hellwige2592212016-04-07 08:52:01 -07002876/*
2877 * Sync the bytes written if this was a synchronous write. Expect ki_pos
2878 * to already be updated for the write, and will return either the amount
2879 * of bytes passed in, or an error if syncing the file failed.
2880 */
2881static inline ssize_t generic_write_sync(struct kiocb *iocb, ssize_t count)
Al Virod311d792014-02-09 15:18:09 -05002882{
Christoph Hellwige2592212016-04-07 08:52:01 -07002883 if (iocb->ki_flags & IOCB_DSYNC) {
2884 int ret = vfs_fsync_range(iocb->ki_filp,
2885 iocb->ki_pos - count, iocb->ki_pos - 1,
2886 (iocb->ki_flags & IOCB_SYNC) ? 0 : 1);
2887 if (ret)
2888 return ret;
2889 }
2890
2891 return count;
Al Virod311d792014-02-09 15:18:09 -05002892}
Christoph Hellwige2592212016-04-07 08:52:01 -07002893
Linus Torvalds1da177e2005-04-16 15:20:36 -07002894extern void emergency_sync(void);
2895extern void emergency_remount(void);
Carlos Maiolino30460e12020-01-09 14:30:41 +01002896
David Howells93614012006-09-30 20:45:40 +02002897#ifdef CONFIG_BLOCK
Carlos Maiolino30460e12020-01-09 14:30:41 +01002898extern int bmap(struct inode *inode, sector_t *block);
2899#else
2900static inline int bmap(struct inode *inode, sector_t *block)
2901{
2902 return -EINVAL;
2903}
David Howells93614012006-09-30 20:45:40 +02002904#endif
Carlos Maiolino30460e12020-01-09 14:30:41 +01002905
J. Bruce Fields27ac0ff2011-09-20 17:19:26 -04002906extern int notify_change(struct dentry *, struct iattr *, struct inode **);
Al Virof419a2e2008-07-22 00:07:17 -04002907extern int inode_permission(struct inode *, int);
Al Viro2830ba72011-06-20 19:16:29 -04002908extern int generic_permission(struct inode *, int);
Miklos Szeredicbdf35b2014-10-24 00:14:36 +02002909extern int __check_sticky(struct inode *dir, struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002910
Miklos Szeredif696a362008-07-31 13:41:58 +02002911static inline bool execute_ok(struct inode *inode)
2912{
2913 return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
2914}
2915
Al Viro8d71db42013-03-19 21:01:03 -04002916static inline void file_start_write(struct file *file)
2917{
2918 if (!S_ISREG(file_inode(file)->i_mode))
2919 return;
2920 __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, true);
2921}
2922
Jan Kara5ae98f12013-05-04 00:11:23 +02002923static inline bool file_start_write_trylock(struct file *file)
2924{
2925 if (!S_ISREG(file_inode(file)->i_mode))
2926 return true;
2927 return __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, false);
2928}
2929
Al Viro8d71db42013-03-19 21:01:03 -04002930static inline void file_end_write(struct file *file)
2931{
2932 if (!S_ISREG(file_inode(file)->i_mode))
2933 return;
2934 __sb_end_write(file_inode(file)->i_sb, SB_FREEZE_WRITE);
2935}
2936
Al Viro07b8ce12011-06-20 10:52:57 -04002937/*
2938 * get_write_access() gets write permission for a file.
2939 * put_write_access() releases this write permission.
2940 * This is used for regular files.
2941 * We cannot support write (and maybe mmap read-write shared) accesses and
2942 * MAP_DENYWRITE mmappings simultaneously. The i_writecount field of an inode
2943 * can have the following values:
2944 * 0: no writers, no VM_DENYWRITE mappings
2945 * < 0: (-i_writecount) vm_area_structs with VM_DENYWRITE set exist
2946 * > 0: (i_writecount) users are writing to the file.
2947 *
2948 * Normally we operate on that counter with atomic_{inc,dec} and it's safe
2949 * except for the cases where we don't hold i_writecount yet. Then we need to
2950 * use {get,deny}_write_access() - these functions check the sign and refuse
2951 * to do the change if sign is wrong.
2952 */
2953static inline int get_write_access(struct inode *inode)
2954{
2955 return atomic_inc_unless_negative(&inode->i_writecount) ? 0 : -ETXTBSY;
2956}
2957static inline int deny_write_access(struct file *file)
2958{
Al Viro496ad9a2013-01-23 17:07:38 -05002959 struct inode *inode = file_inode(file);
Al Viro07b8ce12011-06-20 10:52:57 -04002960 return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
2961}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002962static inline void put_write_access(struct inode * inode)
2963{
2964 atomic_dec(&inode->i_writecount);
2965}
2966static inline void allow_write_access(struct file *file)
2967{
2968 if (file)
Al Viro496ad9a2013-01-23 17:07:38 -05002969 atomic_inc(&file_inode(file)->i_writecount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002970}
David Howellsf1fe29b2013-09-27 11:20:03 +01002971static inline bool inode_is_open_for_write(const struct inode *inode)
2972{
2973 return atomic_read(&inode->i_writecount) > 0;
2974}
2975
Amir Goldstein387e3742019-06-07 17:24:38 +03002976#if defined(CONFIG_IMA) || defined(CONFIG_FILE_LOCKING)
Mimi Zohara5c96eb2010-11-02 10:11:37 -04002977static inline void i_readcount_dec(struct inode *inode)
2978{
2979 BUG_ON(!atomic_read(&inode->i_readcount));
2980 atomic_dec(&inode->i_readcount);
2981}
2982static inline void i_readcount_inc(struct inode *inode)
2983{
2984 atomic_inc(&inode->i_readcount);
2985}
2986#else
2987static inline void i_readcount_dec(struct inode *inode)
2988{
2989 return;
2990}
2991static inline void i_readcount_inc(struct inode *inode)
2992{
2993 return;
2994}
2995#endif
Ulrich Dreppered8cae82008-07-23 21:29:30 -07002996extern int do_pipe_flags(int *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002997
Mimi Zohar1284ab52016-04-20 15:46:27 -07002998#define __kernel_read_file_id(id) \
2999 id(UNKNOWN, unknown) \
3000 id(FIRMWARE, firmware) \
Stephen Boyda098ecd2016-08-02 14:04:28 -07003001 id(FIRMWARE_PREALLOC_BUFFER, firmware) \
Hans de Goedee4c2c0f2020-01-15 17:35:48 +01003002 id(FIRMWARE_EFI_EMBEDDED, firmware) \
Mimi Zohar1284ab52016-04-20 15:46:27 -07003003 id(MODULE, kernel-module) \
3004 id(KEXEC_IMAGE, kexec-image) \
3005 id(KEXEC_INITRAMFS, kexec-initramfs) \
3006 id(POLICY, security-policy) \
Christoph Hellwiga7d3d032017-09-10 09:49:45 +02003007 id(X509_CERTIFICATE, x509-certificate) \
Mimi Zohar1284ab52016-04-20 15:46:27 -07003008 id(MAX_ID, )
3009
3010#define __fid_enumify(ENUM, dummy) READING_ ## ENUM,
3011#define __fid_stringify(dummy, str) #str,
3012
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05003013enum kernel_read_file_id {
Mimi Zohar1284ab52016-04-20 15:46:27 -07003014 __kernel_read_file_id(__fid_enumify)
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05003015};
3016
Mimi Zohar1284ab52016-04-20 15:46:27 -07003017static const char * const kernel_read_file_str[] = {
3018 __kernel_read_file_id(__fid_stringify)
3019};
3020
Kees Cookda20dfe2016-04-21 12:53:29 -07003021static inline const char *kernel_read_file_id_str(enum kernel_read_file_id id)
Mimi Zohar1284ab52016-04-20 15:46:27 -07003022{
Arnd Bergmanncbfd0c12017-03-09 16:16:57 -08003023 if ((unsigned)id >= READING_MAX_ID)
Mimi Zohar1284ab52016-04-20 15:46:27 -07003024 return kernel_read_file_str[READING_UNKNOWN];
3025
3026 return kernel_read_file_str[id];
3027}
3028
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05003029extern int kernel_read_file(struct file *, void **, loff_t *, loff_t,
3030 enum kernel_read_file_id);
Mimi Zohar711aab12017-09-12 22:45:33 -04003031extern int kernel_read_file_from_path(const char *, void **, loff_t *, loff_t,
Mimi Zohar09596b92015-11-19 12:39:22 -05003032 enum kernel_read_file_id);
Topi Miettinen901cff72020-01-23 14:58:38 +02003033extern int kernel_read_file_from_path_initns(const char *, void **, loff_t *, loff_t,
3034 enum kernel_read_file_id);
Mimi Zoharb844f0e2016-02-01 08:36:21 -05003035extern int kernel_read_file_from_fd(int, void **, loff_t *, loff_t,
3036 enum kernel_read_file_id);
Christoph Hellwigbdd1d2d2017-09-01 17:39:13 +02003037extern ssize_t kernel_read(struct file *, void *, size_t, loff_t *);
Christoph Hellwige13ec932017-09-01 17:39:14 +02003038extern ssize_t kernel_write(struct file *, const void *, size_t, loff_t *);
Christoph Hellwig73e18f72017-09-01 17:39:15 +02003039extern ssize_t __kernel_write(struct file *, const void *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003040extern struct file * open_exec(const char *);
3041
3042/* fs/dcache.c -- generic fs support functions */
Yaowei Baia6e57872015-11-17 14:40:11 +08003043extern bool is_subdir(struct dentry *, struct dentry *);
Mickaël Salaün640eb7e2016-11-14 22:14:35 +01003044extern bool path_is_under(const struct path *, const struct path *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003045
Miklos Szeredi9bf39ab2015-06-19 10:29:13 +02003046extern char *file_path(struct file *, char *, int);
3047
Linus Torvalds1da177e2005-04-16 15:20:36 -07003048#include <linux/err.h>
3049
3050/* needed for stackable file system support */
Andrew Morton965c8e52012-12-17 15:59:39 -08003051extern loff_t default_llseek(struct file *file, loff_t offset, int whence);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003052
Andrew Morton965c8e52012-12-17 15:59:39 -08003053extern loff_t vfs_llseek(struct file *file, loff_t offset, int whence);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003054
Christoph Hellwig54e34622009-08-07 14:38:25 -03003055extern int inode_init_always(struct super_block *, struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003056extern void inode_init_once(struct inode *);
Miklos Szeredi2aa15892011-02-23 13:49:47 +01003057extern void address_space_init_once(struct address_space *mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003058extern struct inode * igrab(struct inode *);
3059extern ino_t iunique(struct super_block *, ino_t);
3060extern int inode_needs_sync(struct inode *inode);
Al Viro45321ac2010-06-07 13:43:19 -04003061extern int generic_delete_inode(struct inode *inode);
Al Viro9bcb4b72012-02-12 19:43:17 -05003062static inline int generic_drop_inode(struct inode *inode)
3063{
Ira Weinydae2f8e2020-04-30 07:41:37 -07003064 return !inode->i_nlink || inode_unhashed(inode) ||
3065 (inode->i_state & I_DONTCACHE);
Al Viro9bcb4b72012-02-12 19:43:17 -05003066}
Ira Weiny2c567af2020-04-30 07:41:37 -07003067extern void d_mark_dontcache(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003068
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07003069extern struct inode *ilookup5_nowait(struct super_block *sb,
3070 unsigned long hashval, int (*test)(struct inode *, void *),
3071 void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003072extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
3073 int (*test)(struct inode *, void *), void *data);
3074extern struct inode *ilookup(struct super_block *sb, unsigned long ino);
3075
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02003076extern struct inode *inode_insert5(struct inode *inode, unsigned long hashval,
3077 int (*test)(struct inode *, void *),
3078 int (*set)(struct inode *, void *),
3079 void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003080extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *);
3081extern struct inode * iget_locked(struct super_block *, unsigned long);
Theodore Ts'ofe032c42015-02-02 00:37:01 -05003082extern struct inode *find_inode_nowait(struct super_block *,
3083 unsigned long,
3084 int (*match)(struct inode *,
3085 unsigned long, void *),
3086 void *data);
David Howells3f19b2a2017-12-01 11:40:16 +00003087extern struct inode *find_inode_rcu(struct super_block *, unsigned long,
3088 int (*)(struct inode *, void *), void *);
3089extern struct inode *find_inode_by_ino_rcu(struct super_block *, unsigned long);
Al Viro261bca82008-12-30 01:48:21 -05003090extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
3091extern int insert_inode_locked(struct inode *);
Josh Boyere096d0c2011-08-25 07:48:12 -04003092#ifdef CONFIG_DEBUG_LOCK_ALLOC
3093extern void lockdep_annotate_inode_mutex_key(struct inode *inode);
3094#else
3095static inline void lockdep_annotate_inode_mutex_key(struct inode *inode) { };
3096#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07003097extern void unlock_new_inode(struct inode *);
Al Viroc2b6d622018-06-28 15:53:17 -04003098extern void discard_new_inode(struct inode *);
Christoph Hellwig85fe4022010-10-23 11:19:54 -04003099extern unsigned int get_next_ino(void);
Darrick J. Wong799ea9e2017-08-18 18:08:25 -07003100extern void evict_inodes(struct super_block *sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003101
Linus Torvalds1da177e2005-04-16 15:20:36 -07003102extern void __iget(struct inode * inode);
David Howellsb46980f2008-02-07 00:15:27 -08003103extern void iget_failed(struct inode *);
Jan Karadbd57682012-05-03 14:48:02 +02003104extern void clear_inode(struct inode *);
Christoph Hellwig2e00c972009-08-07 14:38:29 -03003105extern void __destroy_inode(struct inode *);
Eric Dumazeta209dfc2011-07-26 11:36:34 +02003106extern struct inode *new_inode_pseudo(struct super_block *sb);
3107extern struct inode *new_inode(struct super_block *sb);
Nick Pigginff0c7d12011-01-07 17:49:50 +11003108extern void free_inode_nonrcu(struct inode *inode);
Jens Axboe01de85e2006-10-17 19:50:36 +02003109extern int should_remove_suid(struct dentry *);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02003110extern int file_remove_privs(struct file *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003111
3112extern void __insert_inode_hash(struct inode *, unsigned long hashval);
Christoph Hellwig646ec462010-10-23 07:15:32 -04003113static inline void insert_inode_hash(struct inode *inode)
3114{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003115 __insert_inode_hash(inode, inode->i_ino);
3116}
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +02003117
3118extern void __remove_inode_hash(struct inode *);
3119static inline void remove_inode_hash(struct inode *inode)
3120{
Josef Bacikcbedaac2015-03-12 08:19:11 -04003121 if (!inode_unhashed(inode) && !hlist_fake(&inode->i_hash))
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +02003122 __remove_inode_hash(inode);
3123}
3124
Christoph Hellwig646ec462010-10-23 07:15:32 -04003125extern void inode_sb_list_add(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003126
David Howells93614012006-09-30 20:45:40 +02003127#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07003128extern int bdev_read_only(struct block_device *);
David Howells93614012006-09-30 20:45:40 +02003129#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07003130extern int set_blocksize(struct block_device *, int);
3131extern int sb_set_blocksize(struct super_block *, int);
3132extern int sb_min_blocksize(struct super_block *, int);
3133
3134extern int generic_file_mmap(struct file *, struct vm_area_struct *);
3135extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
Al Viro3309dd02015-04-09 12:55:47 -04003136extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *);
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003137extern int generic_remap_checks(struct file *file_in, loff_t pos_in,
3138 struct file *file_out, loff_t pos_out,
Darrick J. Wong42ec3d42018-10-30 10:41:49 +11003139 loff_t *count, unsigned int remap_flags);
Amir Goldsteina3171352019-06-05 08:04:48 -07003140extern int generic_file_rw_checks(struct file *file_in, struct file *file_out);
Amir Goldstein96e6e8f2019-06-05 08:04:49 -07003141extern int generic_copy_file_checks(struct file *file_in, loff_t pos_in,
3142 struct file *file_out, loff_t pos_out,
3143 size_t *count, unsigned int flags);
Goldwyn Rodriguesd85dc2e2019-08-30 12:09:24 -05003144extern ssize_t generic_file_buffered_read(struct kiocb *iocb,
3145 struct iov_iter *to, ssize_t already_read);
Al Viroed978a82014-03-05 22:53:04 -05003146extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
Al Viro81742022014-04-03 03:17:43 -04003147extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
Al Viro81742022014-04-03 03:17:43 -04003148extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003149extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *);
Al Viro3b93f912014-02-11 21:34:08 -05003150extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t);
Andrew Morton88e6fae2006-04-11 13:59:36 +02003151
Christoph Hellwig18e97102017-05-27 11:16:51 +03003152ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos,
Christoph Hellwigddef7ed22017-07-06 18:58:37 +02003153 rwf_t flags);
Christoph Hellwigabbb65892017-05-27 11:16:52 +03003154ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos,
Christoph Hellwigddef7ed22017-07-06 18:58:37 +02003155 rwf_t flags);
Jiufei Xue5dcdc432019-11-20 17:45:25 +08003156ssize_t vfs_iocb_iter_read(struct file *file, struct kiocb *iocb,
3157 struct iov_iter *iter);
3158ssize_t vfs_iocb_iter_write(struct file *file, struct kiocb *iocb,
3159 struct iov_iter *iter);
Christoph Hellwigdbe4e192015-01-25 21:11:59 +01003160
Christoph Hellwigeef99382009-08-20 17:43:41 +02003161/* fs/block_dev.c */
David Jefferyb2de5252014-09-29 10:21:10 -04003162extern ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to);
Al Viro1456c0a2014-04-03 03:21:50 -04003163extern ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from);
Josef Bacik02c24a82011-07-16 20:44:56 -04003164extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
3165 int datasync);
Al Viroff01bb42011-09-16 02:31:11 -04003166extern void block_sync_page(struct page *page);
Christoph Hellwigeef99382009-08-20 17:43:41 +02003167
Andrew Morton88e6fae2006-04-11 13:59:36 +02003168/* fs/splice.c */
Jens Axboecbb7e572006-04-11 14:57:50 +02003169extern ssize_t generic_file_splice_read(struct file *, loff_t *,
Andrew Morton88e6fae2006-04-11 13:59:36 +02003170 struct pipe_inode_info *, size_t, unsigned int);
Al Viro8d020762014-04-05 04:27:08 -04003171extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
Jens Axboecbb7e572006-04-11 14:57:50 +02003172 struct file *, loff_t *, size_t, unsigned int);
Andrew Morton88e6fae2006-04-11 13:59:36 +02003173extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
Jens Axboecbb7e572006-04-11 14:57:50 +02003174 struct file *out, loff_t *, size_t len, unsigned int flags);
Miklos Szeredi1c118592014-10-24 00:14:35 +02003175extern long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
3176 loff_t *opos, size_t len, unsigned int flags);
3177
Andrew Morton88e6fae2006-04-11 13:59:36 +02003178
Linus Torvalds1da177e2005-04-16 15:20:36 -07003179extern void
3180file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
Andrew Morton965c8e52012-12-17 15:59:39 -08003181extern loff_t noop_llseek(struct file *file, loff_t offset, int whence);
3182extern loff_t no_llseek(struct file *file, loff_t offset, int whence);
Jie Liu46a1c2c2013-06-25 12:02:13 +08003183extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
Andrew Morton965c8e52012-12-17 15:59:39 -08003184extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
Andi Kleen57604952011-09-15 16:06:50 -07003185extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
Andrew Morton965c8e52012-12-17 15:59:39 -08003186 int whence, loff_t maxsize, loff_t eof);
Al Viro1bf9d142013-06-16 20:27:42 +04003187extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
3188 int whence, loff_t size);
Al Virob25472f2015-12-05 22:04:48 -05003189extern loff_t no_seek_end_llseek_size(struct file *, loff_t, int, loff_t);
3190extern loff_t no_seek_end_llseek(struct file *, loff_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003191extern int generic_file_open(struct inode * inode, struct file * filp);
3192extern int nonseekable_open(struct inode * inode, struct file * filp);
Kirill Smelkov10dce8a2019-03-26 22:20:43 +00003193extern int stream_open(struct inode * inode, struct file * filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003194
David Howells93614012006-09-30 20:45:40 +02003195#ifdef CONFIG_BLOCK
Mike Christie8a4c1e42016-06-05 14:31:50 -05003196typedef void (dio_submit_t)(struct bio *bio, struct inode *inode,
Josef Bacikfacd07b2010-05-23 11:00:55 -04003197 loff_t file_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003198
3199enum {
Christoph Hellwig1e431f52009-11-03 16:44:53 +01003200 /* need locking between buffered and direct access */
3201 DIO_LOCKING = 0x01,
3202
3203 /* filesystem does not support filling holes */
3204 DIO_SKIP_HOLES = 0x02,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003205};
3206
David Sterbaf1084bc2020-06-09 19:22:47 +02003207void dio_end_io(struct bio *bio);
3208
Omar Sandoval17f8c842015-03-16 04:33:50 -07003209ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode,
3210 struct block_device *bdev, struct iov_iter *iter,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07003211 get_block_t get_block,
Omar Sandoval17f8c842015-03-16 04:33:50 -07003212 dio_iodone_t end_io, dio_submit_t submit_io,
3213 int flags);
Christoph Hellwigeafdc7d2010-06-04 11:29:53 +02003214
Omar Sandoval17f8c842015-03-16 04:33:50 -07003215static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
3216 struct inode *inode,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07003217 struct iov_iter *iter,
Omar Sandoval17f8c842015-03-16 04:33:50 -07003218 get_block_t get_block)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003219{
Omar Sandoval17f8c842015-03-16 04:33:50 -07003220 return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07003221 get_block, NULL, NULL, DIO_LOCKING | DIO_SKIP_HOLES);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003222}
David Howells93614012006-09-30 20:45:40 +02003223#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07003224
Trond Myklebust1d59d612012-05-31 12:22:33 -04003225void inode_dio_wait(struct inode *inode);
Jens Axboefe0f07d2015-04-15 17:05:48 -06003226
3227/*
3228 * inode_dio_begin - signal start of a direct I/O requests
3229 * @inode: inode the direct I/O happens on
3230 *
3231 * This is called once we've finished processing a direct I/O request,
3232 * and is used to wake up callers waiting for direct I/O to be quiesced.
3233 */
3234static inline void inode_dio_begin(struct inode *inode)
3235{
3236 atomic_inc(&inode->i_dio_count);
3237}
3238
3239/*
3240 * inode_dio_end - signal finish of a direct I/O requests
3241 * @inode: inode the direct I/O happens on
3242 *
3243 * This is called once we've finished processing a direct I/O request,
3244 * and is used to wake up callers waiting for direct I/O to be quiesced.
3245 */
3246static inline void inode_dio_end(struct inode *inode)
3247{
3248 if (atomic_dec_and_test(&inode->i_dio_count))
3249 wake_up_bit(&inode->i_state, __I_DIO_WAKEUP);
3250}
Trond Myklebust1d59d612012-05-31 12:22:33 -04003251
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003252/*
3253 * Warn about a page cache invalidation failure diring a direct I/O write.
3254 */
3255void dio_warn_stale_pagecache(struct file *filp);
3256
Theodore Ts'o5f16f322014-03-24 14:43:12 -04003257extern void inode_set_flags(struct inode *inode, unsigned int flags,
3258 unsigned int mask);
3259
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08003260extern const struct file_operations generic_ro_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003261
3262#define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))
3263
Al Viro5d826c82014-03-14 13:42:45 -04003264extern int readlink_copy(char __user *, int, const char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003265extern int page_readlink(struct dentry *, char __user *, int);
Al Virofceef392015-12-29 15:58:39 -05003266extern const char *page_get_link(struct dentry *, struct inode *,
3267 struct delayed_call *);
3268extern void page_put_link(void *);
Kirill Korotaev0adb25d2006-03-11 03:27:13 -08003269extern int __page_symlink(struct inode *inode, const char *symname, int len,
Nick Piggin54566b22009-01-04 12:00:53 -08003270 int nofs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003271extern int page_symlink(struct inode *inode, const char *symname, int len);
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08003272extern const struct inode_operations page_symlink_inode_operations;
Al Virofceef392015-12-29 15:58:39 -05003273extern void kfree_link(void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003274extern void generic_fillattr(struct inode *, struct kstat *);
David Howellsa528d352017-01-31 16:46:22 +00003275extern int vfs_getattr_nosec(const struct path *, struct kstat *, u32, unsigned int);
3276extern int vfs_getattr(const struct path *, struct kstat *, u32, unsigned int);
Dmitry Monakhovb4627072009-12-14 15:21:12 +03003277void __inode_add_bytes(struct inode *inode, loff_t bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003278void inode_add_bytes(struct inode *inode, loff_t bytes);
Jan Kara1c8924e2013-08-17 09:32:32 -04003279void __inode_sub_bytes(struct inode *inode, loff_t bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003280void inode_sub_bytes(struct inode *inode, loff_t bytes);
Jan Karaf4a8116a2017-08-08 09:54:36 +02003281static inline loff_t __inode_get_bytes(struct inode *inode)
3282{
3283 return (((loff_t)inode->i_blocks) << 9) + inode->i_bytes;
3284}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003285loff_t inode_get_bytes(struct inode *inode);
3286void inode_set_bytes(struct inode *inode, loff_t bytes);
Al Virofceef392015-12-29 15:58:39 -05003287const char *simple_get_link(struct dentry *, struct inode *,
3288 struct delayed_call *);
Al Viro61ba64f2015-05-02 09:54:06 -04003289extern const struct inode_operations simple_symlink_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003290
Al Viro5c0ba4e2013-05-15 13:52:59 -04003291extern int iterate_dir(struct file *, struct dir_context *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003292
David Howellsa528d352017-01-31 16:46:22 +00003293extern int vfs_statx(int, const char __user *, int, struct kstat *, u32);
3294extern int vfs_statx_fd(unsigned int, struct kstat *, u32, unsigned int);
3295
3296static inline int vfs_stat(const char __user *filename, struct kstat *stat)
3297{
David Howellsdeccf492017-05-04 23:30:16 +01003298 return vfs_statx(AT_FDCWD, filename, AT_NO_AUTOMOUNT,
3299 stat, STATX_BASIC_STATS);
David Howellsa528d352017-01-31 16:46:22 +00003300}
3301static inline int vfs_lstat(const char __user *name, struct kstat *stat)
3302{
David Howellsdeccf492017-05-04 23:30:16 +01003303 return vfs_statx(AT_FDCWD, name, AT_SYMLINK_NOFOLLOW | AT_NO_AUTOMOUNT,
David Howellsa528d352017-01-31 16:46:22 +00003304 stat, STATX_BASIC_STATS);
3305}
3306static inline int vfs_fstatat(int dfd, const char __user *filename,
3307 struct kstat *stat, int flags)
3308{
Ian Kent5d38f042017-11-29 16:11:26 -08003309 return vfs_statx(dfd, filename, flags | AT_NO_AUTOMOUNT,
3310 stat, STATX_BASIC_STATS);
David Howellsa528d352017-01-31 16:46:22 +00003311}
3312static inline int vfs_fstat(int fd, struct kstat *stat)
3313{
3314 return vfs_statx_fd(fd, stat, STATX_BASIC_STATS, 0);
3315}
3316
3317
Miklos Szeredid60874c2016-10-04 14:40:45 +02003318extern const char *vfs_get_link(struct dentry *, struct delayed_call *);
Miklos Szeredifd4a0edf2016-12-09 16:45:04 +01003319extern int vfs_readlink(struct dentry *, char __user *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003320
David Howellsee416bc2017-07-04 17:25:16 +01003321extern struct file_system_type *get_filesystem(struct file_system_type *fs);
Miklos Szeredic18479f2007-10-18 23:39:11 -07003322extern void put_filesystem(struct file_system_type *fs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003323extern struct file_system_type *get_fs_type(const char *name);
3324extern struct super_block *get_super(struct block_device *);
Jan Kara6b6dc832012-02-10 11:03:00 +01003325extern struct super_block *get_super_thawed(struct block_device *);
Jan Karaba6379f2016-11-23 12:53:00 +01003326extern struct super_block *get_super_exclusive_thawed(struct block_device *bdev);
Christoph Hellwig45042302009-08-03 23:28:35 +02003327extern struct super_block *get_active_super(struct block_device *bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003328extern void drop_super(struct super_block *sb);
Jan Karaba6379f2016-11-23 12:53:00 +01003329extern void drop_super_exclusive(struct super_block *sb);
Al Viro01a05b32010-03-23 06:06:58 -04003330extern void iterate_supers(void (*)(struct super_block *, void *), void *);
Al Viro43e15cd2011-06-03 20:16:57 -04003331extern void iterate_supers_type(struct file_system_type *,
3332 void (*)(struct super_block *, void *), void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003333
3334extern int dcache_dir_open(struct inode *, struct file *);
3335extern int dcache_dir_close(struct inode *, struct file *);
3336extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
Al Viro5f99f4e2013-05-15 20:23:06 -04003337extern int dcache_readdir(struct file *, struct dir_context *);
npiggin@suse.de7bb46a62010-05-27 01:05:33 +10003338extern int simple_setattr(struct dentry *, struct iattr *);
David Howellsa528d352017-01-31 16:46:22 +00003339extern int simple_getattr(const struct path *, struct kstat *, u32, unsigned int);
David Howells726c3342006-06-23 02:02:58 -07003340extern int simple_statfs(struct dentry *, struct kstatfs *);
Stephen Boyd20955e82012-04-05 14:25:09 -07003341extern int simple_open(struct inode *inode, struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003342extern int simple_link(struct dentry *, struct inode *, struct dentry *);
3343extern int simple_unlink(struct inode *, struct dentry *);
3344extern int simple_rmdir(struct inode *, struct dentry *);
Miklos Szeredie0e0be82016-09-27 11:03:57 +02003345extern int simple_rename(struct inode *, struct dentry *,
3346 struct inode *, struct dentry *, unsigned int);
Al Viroa3d1e7e2019-11-18 09:43:10 -05003347extern void simple_recursive_removal(struct dentry *,
3348 void (*callback)(struct dentry *));
Josef Bacik02c24a82011-07-16 20:44:56 -04003349extern int noop_fsync(struct file *, loff_t, loff_t, int);
Dan Williamsf44c7762018-03-07 15:26:44 -08003350extern int noop_set_page_dirty(struct page *page);
3351extern void noop_invalidatepage(struct page *page, unsigned int offset,
3352 unsigned int length);
3353extern ssize_t noop_direct_IO(struct kiocb *iocb, struct iov_iter *iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003354extern int simple_empty(struct dentry *);
3355extern int simple_readpage(struct file *file, struct page *page);
Nick Pigginafddba42007-10-16 01:25:01 -07003356extern int simple_write_begin(struct file *file, struct address_space *mapping,
3357 loff_t pos, unsigned len, unsigned flags,
3358 struct page **pagep, void **fsdata);
3359extern int simple_write_end(struct file *file, struct address_space *mapping,
3360 loff_t pos, unsigned len, unsigned copied,
3361 struct page *page, void *fsdata);
Al Virob26d4cd2013-10-25 18:47:37 -04003362extern int always_delete_dentry(const struct dentry *);
Al Viro69878432013-10-02 22:35:11 -04003363extern struct inode *alloc_anon_inode(struct super_block *);
Jeff Laytone6f5c782014-08-22 10:40:25 -04003364extern int simple_nosetlease(struct file *, long, struct file_lock **, void **);
Al Virob26d4cd2013-10-25 18:47:37 -04003365extern const struct dentry_operations simple_dentry_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003366
Al Viro00cd8dd2012-06-10 17:13:09 -04003367extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003368extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08003369extern const struct file_operations simple_dir_operations;
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08003370extern const struct inode_operations simple_dir_inode_operations;
Eric W. Biedermanfbabfd02015-05-09 15:54:49 -05003371extern void make_empty_dir_inode(struct inode *inode);
3372extern bool is_empty_dir_inode(struct inode *inode);
Eric Biggerscda37122017-03-25 21:15:37 -07003373struct tree_descr { const char *name; const struct file_operations *ops; int mode; };
Linus Torvalds1da177e2005-04-16 15:20:36 -07003374struct dentry *d_alloc_name(struct dentry *, const char *);
Eric Biggerscda37122017-03-25 21:15:37 -07003375extern int simple_fill_super(struct super_block *, unsigned long,
3376 const struct tree_descr *);
Trond Myklebust1f5ce9e2006-06-09 09:34:16 -04003377extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003378extern void simple_release_fs(struct vfsmount **mount, int *count);
3379
Akinobu Mita93b07112008-06-05 22:46:21 -07003380extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
3381 loff_t *ppos, const void *from, size_t available);
Jiri Slaby6a727b42010-05-01 23:51:22 +02003382extern ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
3383 const void __user *from, size_t count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003384
Fabian Frederickac13a822014-06-04 16:06:27 -07003385extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
Josef Bacik02c24a82011-07-16 20:44:56 -04003386extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
Al Virod5aacad2009-06-07 14:56:44 -04003387
Patrick J. LoPresti30ca22c2010-07-22 15:03:41 -07003388extern int generic_check_addressable(unsigned, u64);
3389
Christoph Lametere965f962006-02-01 03:05:41 -08003390#ifdef CONFIG_MIGRATION
Christoph Lameter2d1db3b2006-06-23 02:03:33 -07003391extern int buffer_migrate_page(struct address_space *,
Mel Gormana6bc32b2012-01-12 17:19:43 -08003392 struct page *, struct page *,
3393 enum migrate_mode);
Jan Kara89cb0882018-12-28 00:39:12 -08003394extern int buffer_migrate_page_norefs(struct address_space *,
3395 struct page *, struct page *,
3396 enum migrate_mode);
Christoph Lametere965f962006-02-01 03:05:41 -08003397#else
3398#define buffer_migrate_page NULL
Jan Kara89cb0882018-12-28 00:39:12 -08003399#define buffer_migrate_page_norefs NULL
Christoph Lametere965f962006-02-01 03:05:41 -08003400#endif
3401
Jan Kara31051c82016-05-26 16:55:18 +02003402extern int setattr_prepare(struct dentry *, struct iattr *);
npiggin@suse.de25d9e2d2009-08-21 02:35:05 +10003403extern int inode_newsize_ok(const struct inode *, loff_t offset);
Christoph Hellwig6a1a90a2010-06-04 11:30:00 +02003404extern void setattr_copy(struct inode *inode, const struct iattr *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003405
Josef Bacikc3b2da32012-03-26 09:59:21 -04003406extern int file_update_time(struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003407
Thomas Hellstrom (VMware)f05a3842020-03-24 18:46:48 +01003408static inline bool vma_is_dax(const struct vm_area_struct *vma)
Dan Williamsbaabda22017-07-10 15:48:25 -07003409{
3410 return vma->vm_file && IS_DAX(vma->vm_file->f_mapping->host);
3411}
3412
Dan Williams2bb6d282017-11-29 16:10:35 -08003413static inline bool vma_is_fsdax(struct vm_area_struct *vma)
3414{
3415 struct inode *inode;
3416
3417 if (!vma->vm_file)
3418 return false;
3419 if (!vma_is_dax(vma))
3420 return false;
3421 inode = file_inode(vma->vm_file);
Dan Williams230f5a82018-02-21 17:08:01 -08003422 if (S_ISCHR(inode->i_mode))
Dan Williams2bb6d282017-11-29 16:10:35 -08003423 return false; /* device-dax */
3424 return true;
3425}
3426
Al Viro2ba48ce2015-04-09 13:52:01 -04003427static inline int iocb_flags(struct file *file)
3428{
3429 int res = 0;
3430 if (file->f_flags & O_APPEND)
3431 res |= IOCB_APPEND;
Ira Weinyefbe3c22020-04-30 07:41:33 -07003432 if (file->f_flags & O_DIRECT)
Al Viro2ba48ce2015-04-09 13:52:01 -04003433 res |= IOCB_DIRECT;
Christoph Hellwigdde0c2e2016-04-07 08:52:00 -07003434 if ((file->f_flags & O_DSYNC) || IS_SYNC(file->f_mapping->host))
3435 res |= IOCB_DSYNC;
3436 if (file->f_flags & __O_SYNC)
3437 res |= IOCB_SYNC;
Al Viro2ba48ce2015-04-09 13:52:01 -04003438 return res;
3439}
3440
Christoph Hellwigddef7ed22017-07-06 18:58:37 +02003441static inline int kiocb_set_rw_flags(struct kiocb *ki, rwf_t flags)
Goldwyn Rodriguesfdd2f5b2017-06-20 07:05:40 -05003442{
3443 if (unlikely(flags & ~RWF_SUPPORTED))
3444 return -EOPNOTSUPP;
3445
Goldwyn Rodriguesb745faf2017-06-20 07:05:43 -05003446 if (flags & RWF_NOWAIT) {
Christoph Hellwig91f99432017-08-29 16:13:20 +02003447 if (!(ki->ki_filp->f_mode & FMODE_NOWAIT))
Goldwyn Rodriguesb745faf2017-06-20 07:05:43 -05003448 return -EOPNOTSUPP;
3449 ki->ki_flags |= IOCB_NOWAIT;
3450 }
Goldwyn Rodriguesfdd2f5b2017-06-20 07:05:40 -05003451 if (flags & RWF_HIPRI)
3452 ki->ki_flags |= IOCB_HIPRI;
3453 if (flags & RWF_DSYNC)
3454 ki->ki_flags |= IOCB_DSYNC;
3455 if (flags & RWF_SYNC)
3456 ki->ki_flags |= (IOCB_DSYNC | IOCB_SYNC);
Jürg Billetere1fc7422017-09-29 14:07:17 +02003457 if (flags & RWF_APPEND)
3458 ki->ki_flags |= IOCB_APPEND;
Goldwyn Rodriguesfdd2f5b2017-06-20 07:05:40 -05003459 return 0;
3460}
3461
Linus Torvalds1da177e2005-04-16 15:20:36 -07003462static inline ino_t parent_ino(struct dentry *dentry)
3463{
3464 ino_t res;
3465
Nick Pigginb5c84bf2011-01-07 17:49:38 +11003466 /*
3467 * Don't strictly need d_lock here? If the parent ino could change
3468 * then surely we'd have a deeper race in the caller?
3469 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003470 spin_lock(&dentry->d_lock);
3471 res = dentry->d_parent->d_inode->i_ino;
3472 spin_unlock(&dentry->d_lock);
3473 return res;
3474}
3475
Linus Torvalds1da177e2005-04-16 15:20:36 -07003476/* Transaction based IO helpers */
3477
3478/*
3479 * An argresp is stored in an allocated page and holds the
3480 * size of the argument or response, along with its content
3481 */
3482struct simple_transaction_argresp {
3483 ssize_t size;
3484 char data[0];
3485};
3486
3487#define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))
3488
3489char *simple_transaction_get(struct file *file, const char __user *buf,
3490 size_t size);
3491ssize_t simple_transaction_read(struct file *file, char __user *buf,
3492 size_t size, loff_t *pos);
3493int simple_transaction_release(struct inode *inode, struct file *file);
3494
Ingo Molnar76791ab2009-03-25 16:48:35 +01003495void simple_transaction_set(struct file *file, size_t n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003496
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003497/*
3498 * simple attribute files
3499 *
3500 * These attributes behave similar to those in sysfs:
3501 *
3502 * Writing to an attribute immediately sets a value, an open file can be
3503 * written to multiple times.
3504 *
3505 * Reading from an attribute creates a buffer from the value that might get
3506 * read with multiple read calls. When the attribute has been read
3507 * completely, no further read calls are possible until the file is opened
3508 * again.
3509 *
3510 * All attributes contain a text representation of a numeric value
3511 * that are accessed with the get() and set() functions.
3512 */
3513#define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt) \
3514static int __fops ## _open(struct inode *inode, struct file *file) \
3515{ \
3516 __simple_attr_check_format(__fmt, 0ull); \
3517 return simple_attr_open(inode, file, __get, __set, __fmt); \
3518} \
Alexey Dobriyan828c0952009-10-01 15:43:56 -07003519static const struct file_operations __fops = { \
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003520 .owner = THIS_MODULE, \
3521 .open = __fops ## _open, \
Christoph Hellwig74bedc42008-02-08 04:20:28 -08003522 .release = simple_attr_release, \
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003523 .read = simple_attr_read, \
3524 .write = simple_attr_write, \
Arnd Bergmann1ec55842010-08-15 21:50:52 +02003525 .llseek = generic_file_llseek, \
Joe Perches68be3022014-08-06 16:08:45 -07003526}
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003527
Joe Perchesb9075fa2011-10-31 17:11:33 -07003528static inline __printf(1, 2)
3529void __simple_attr_check_format(const char *fmt, ...)
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003530{
3531 /* don't do anything, just let the compiler check the arguments; */
3532}
3533
3534int simple_attr_open(struct inode *inode, struct file *file,
Christoph Hellwig8b88b092008-02-08 04:20:26 -08003535 int (*get)(void *, u64 *), int (*set)(void *, u64),
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003536 const char *fmt);
Christoph Hellwig74bedc42008-02-08 04:20:28 -08003537int simple_attr_release(struct inode *inode, struct file *file);
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003538ssize_t simple_attr_read(struct file *file, char __user *buf,
3539 size_t len, loff_t *ppos);
3540ssize_t simple_attr_write(struct file *file, const char __user *buf,
3541 size_t len, loff_t *ppos);
3542
Alexey Dobriyan4be28542007-10-16 23:26:21 -07003543struct ctl_table;
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07003544int proc_nr_files(struct ctl_table *table, int write,
Christoph Hellwig32927392020-04-24 08:43:38 +02003545 void *buffer, size_t *lenp, loff_t *ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04003546int proc_nr_dentry(struct ctl_table *table, int write,
Christoph Hellwig32927392020-04-24 08:43:38 +02003547 void *buffer, size_t *lenp, loff_t *ppos);
Dave Chinnercffbc8a2010-10-23 05:03:02 -04003548int proc_nr_inodes(struct ctl_table *table, int write,
Christoph Hellwig32927392020-04-24 08:43:38 +02003549 void *buffer, size_t *lenp, loff_t *ppos);
Tetsuo Handa38e23c92009-04-09 20:17:52 +09003550int __init get_filesystem_list(char *buf);
Adrian Bunk62239ac2007-07-17 04:03:45 -07003551
Namhyung Kim3cd90ea2011-02-01 15:52:46 -08003552#define __FMODE_EXEC ((__force int) FMODE_EXEC)
Namhyung Kim1a44bc82011-02-01 15:52:46 -08003553#define __FMODE_NONOTIFY ((__force int) FMODE_NONOTIFY)
3554
Al Viro6d125522009-12-24 06:58:56 -05003555#define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE])
Eric Parisecf081d2009-12-17 21:24:25 -05003556#define OPEN_FMODE(flag) ((__force fmode_t)(((flag + 1) & O_ACCMODE) | \
Namhyung Kim1a44bc82011-02-01 15:52:46 -08003557 (flag & __FMODE_NONOTIFY)))
Al Viro53009902009-12-19 10:15:07 -05003558
Yaowei Baid37177b2015-11-19 21:00:12 +08003559static inline bool is_sxid(umode_t mode)
Andi Kleen69b45732011-05-28 08:25:51 -07003560{
3561 return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
3562}
3563
Miklos Szeredicbdf35b2014-10-24 00:14:36 +02003564static inline int check_sticky(struct inode *dir, struct inode *inode)
3565{
3566 if (!(dir->i_mode & S_ISVTX))
3567 return 0;
3568
3569 return __check_sticky(dir, inode);
3570}
3571
Andi Kleen69b45732011-05-28 08:25:51 -07003572static inline void inode_has_no_xattr(struct inode *inode)
3573{
David Howellse462ec52017-07-17 08:45:35 +01003574 if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & SB_NOSEC))
Andi Kleen69b45732011-05-28 08:25:51 -07003575 inode->i_flags |= S_NOSEC;
3576}
3577
Al Viroa7400222014-10-21 15:20:42 -04003578static inline bool is_root_inode(struct inode *inode)
3579{
3580 return inode == inode->i_sb->s_root->d_inode;
3581}
3582
Al Viro5f99f4e2013-05-15 20:23:06 -04003583static inline bool dir_emit(struct dir_context *ctx,
3584 const char *name, int namelen,
3585 u64 ino, unsigned type)
3586{
3587 return ctx->actor(ctx, name, namelen, ctx->pos, ino, type) == 0;
3588}
3589static inline bool dir_emit_dot(struct file *file, struct dir_context *ctx)
3590{
3591 return ctx->actor(ctx, ".", 1, ctx->pos,
3592 file->f_path.dentry->d_inode->i_ino, DT_DIR) == 0;
3593}
3594static inline bool dir_emit_dotdot(struct file *file, struct dir_context *ctx)
3595{
3596 return ctx->actor(ctx, "..", 2, ctx->pos,
3597 parent_ino(file->f_path.dentry), DT_DIR) == 0;
3598}
3599static inline bool dir_emit_dots(struct file *file, struct dir_context *ctx)
3600{
3601 if (ctx->pos == 0) {
3602 if (!dir_emit_dot(file, ctx))
3603 return false;
3604 ctx->pos = 1;
3605 }
3606 if (ctx->pos == 1) {
3607 if (!dir_emit_dotdot(file, ctx))
3608 return false;
3609 ctx->pos = 2;
3610 }
3611 return true;
3612}
Al Viro5ded75e2013-05-15 21:02:48 -04003613static inline bool dir_relax(struct inode *inode)
3614{
Al Viro59551022016-01-22 15:40:57 -05003615 inode_unlock(inode);
3616 inode_lock(inode);
Al Viro5ded75e2013-05-15 21:02:48 -04003617 return !IS_DEADDIR(inode);
3618}
Al Viro5f99f4e2013-05-15 20:23:06 -04003619
Al Viroae053272016-05-12 20:36:01 -04003620static inline bool dir_relax_shared(struct inode *inode)
3621{
3622 inode_unlock_shared(inode);
3623 inode_lock_shared(inode);
3624 return !IS_DEADDIR(inode);
3625}
3626
Eric W. Biederman90f85722015-06-29 14:42:03 -05003627extern bool path_noexec(const struct path *path);
Al Viro21fc61c2015-11-17 01:07:57 -05003628extern void inode_nohighmem(struct inode *inode);
Eric W. Biederman90f85722015-06-29 14:42:03 -05003629
Amir Goldstein45cd0fa2018-08-27 15:56:02 +03003630/* mm/fadvise.c */
3631extern int vfs_fadvise(struct file *file, loff_t offset, loff_t len,
3632 int advice);
Jan Karacf1ea052019-08-29 09:04:11 -07003633extern int generic_fadvise(struct file *file, loff_t offset, loff_t len,
3634 int advice);
Amir Goldstein45cd0fa2018-08-27 15:56:02 +03003635
Jens Axboe2b188cc2019-01-07 10:46:33 -07003636#if defined(CONFIG_IO_URING)
3637extern struct sock *io_uring_get_socket(struct file *file);
3638#else
3639static inline struct sock *io_uring_get_socket(struct file *file)
3640{
3641 return NULL;
3642}
3643#endif
3644
Darrick J. Wong5aca2842019-07-01 08:25:34 -07003645int vfs_ioc_setflags_prepare(struct inode *inode, unsigned int oldflags,
3646 unsigned int flags);
3647
Darrick J. Wong7b0e4922019-07-01 08:25:35 -07003648int vfs_ioc_fssetxattr_check(struct inode *inode, const struct fsxattr *old_fa,
3649 struct fsxattr *fa);
3650
3651static inline void simple_fill_fsxattr(struct fsxattr *fa, __u32 xflags)
3652{
3653 memset(fa, 0, sizeof(*fa));
3654 fa->fsx_xflags = xflags;
3655}
3656
Darrick J. Wongdc617f22019-08-20 07:55:16 -07003657/*
3658 * Flush file data before changing attributes. Caller must hold any locks
3659 * required to prevent further writes to this file until we're done setting
3660 * flags.
3661 */
3662static inline int inode_drain_writes(struct inode *inode)
3663{
3664 inode_dio_wait(inode);
3665 return filemap_write_and_wait(inode->i_mapping);
3666}
3667
Linus Torvalds1da177e2005-04-16 15:20:36 -07003668#endif /* _LINUX_FS_H */