blob: 42d246a9422835993c57017efda293cd02e24f0d [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
Jens Axboec2a25ec2020-05-22 09:12:51 -0600178/* File supports async buffered reads */
179#define FMODE_BUF_RASYNC ((__force fmode_t)0x40000000)
180
David Howellsbbc10962012-10-15 16:40:35 +0100181/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 * Attribute flags. These should be or-ed together to figure out what
183 * has been changed!
184 */
Miklos Szeredi9767d742008-07-01 15:01:26 +0200185#define ATTR_MODE (1 << 0)
186#define ATTR_UID (1 << 1)
187#define ATTR_GID (1 << 2)
188#define ATTR_SIZE (1 << 3)
189#define ATTR_ATIME (1 << 4)
190#define ATTR_MTIME (1 << 5)
191#define ATTR_CTIME (1 << 6)
192#define ATTR_ATIME_SET (1 << 7)
193#define ATTR_MTIME_SET (1 << 8)
194#define ATTR_FORCE (1 << 9) /* Not a change, but a change it */
Miklos Szeredi9767d742008-07-01 15:01:26 +0200195#define ATTR_KILL_SUID (1 << 11)
196#define ATTR_KILL_SGID (1 << 12)
197#define ATTR_FILE (1 << 13)
198#define ATTR_KILL_PRIV (1 << 14)
199#define ATTR_OPEN (1 << 15) /* Truncating from open(O_TRUNC) */
200#define ATTR_TIMES_SET (1 << 16)
Miklos Szeredif2b20f62016-09-16 12:44:20 +0200201#define ATTR_TOUCH (1 << 17)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202
203/*
Miklos Szeredi787fb6b2014-10-24 00:14:36 +0200204 * Whiteout is represented by a char device. The following constants define the
205 * mode and device number to use.
206 */
207#define WHITEOUT_MODE 0
208#define WHITEOUT_DEV 0
209
210/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 * This is the Inode Attributes structure, used for notify_change(). It
212 * uses the above definitions as flags, to know which values have changed.
213 * Also, in this manner, a Filesystem can look at only the values it cares
214 * about. Basically, these are the attributes that the VFS layer can
215 * request to change from the FS layer.
216 *
217 * Derek Atkins <warlord@MIT.EDU> 94-10-20
218 */
219struct iattr {
220 unsigned int ia_valid;
221 umode_t ia_mode;
Eric W. Biederman92361632012-02-08 07:07:50 -0800222 kuid_t ia_uid;
223 kgid_t ia_gid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 loff_t ia_size;
Deepa Dinamani95582b02018-05-08 19:36:02 -0700225 struct timespec64 ia_atime;
226 struct timespec64 ia_mtime;
227 struct timespec64 ia_ctime;
Miklos Szeredicc4e69d2005-11-07 00:59:49 -0800228
229 /*
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300230 * Not an attribute, but an auxiliary info for filesystems wanting to
Miklos Szeredicc4e69d2005-11-07 00:59:49 -0800231 * implement an ftruncate() like method. NOTE: filesystem should
232 * check for (ia_valid & ATTR_FILE), and not for (ia_file != NULL).
233 */
234 struct file *ia_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235};
236
237/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 * Includes for diskquotas.
239 */
240#include <linux/quota.h>
241
Miklos Szeredi69c433e2014-10-24 00:14:39 +0200242/*
243 * Maximum number of layers of fs stack. Needs to be limited to
244 * prevent kernel stack overflow
245 */
246#define FILESYSTEM_MAX_STACK_DEPTH 2
247
Zach Brown994fc28c2005-12-15 14:28:17 -0800248/**
249 * enum positive_aop_returns - aop return codes with specific semantics
250 *
251 * @AOP_WRITEPAGE_ACTIVATE: Informs the caller that page writeback has
252 * completed, that the page is still locked, and
253 * should be considered active. The VM uses this hint
254 * to return the page to the active list -- it won't
255 * be a candidate for writeback again in the near
256 * future. Other callers must be careful to unlock
257 * the page if they get this return. Returned by
258 * writepage();
259 *
260 * @AOP_TRUNCATED_PAGE: The AOP method that was handed a locked page has
261 * unlocked it and the page might have been truncated.
262 * The caller should back up to acquiring a new page and
263 * trying again. The aop will be taking reasonable
264 * precautions not to livelock. If the caller held a page
265 * reference, it should drop it before retrying. Returned
Nick Piggin55144762007-10-16 01:25:26 -0700266 * by readpage().
Zach Brown994fc28c2005-12-15 14:28:17 -0800267 *
268 * address_space_operation functions return these large constants to indicate
269 * special semantics to the caller. These are much larger than the bytes in a
270 * page to allow for functions that return the number of bytes operated on in a
271 * given page.
272 */
273
274enum positive_aop_returns {
275 AOP_WRITEPAGE_ACTIVATE = 0x80000,
276 AOP_TRUNCATED_PAGE = 0x80001,
277};
278
Tetsuo Handac718a972017-05-08 15:58:59 -0700279#define AOP_FLAG_CONT_EXPAND 0x0001 /* called from cont_expand */
280#define AOP_FLAG_NOFS 0x0002 /* used by filesystem to direct
Nick Piggin54566b22009-01-04 12:00:53 -0800281 * helper code (eg buffer layer)
282 * to clear GFP_FS from alloc */
Nick Pigginafddba42007-10-16 01:25:01 -0700283
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284/*
285 * oh the beauties of C type declarations.
286 */
287struct page;
288struct address_space;
289struct writeback_control;
Matthew Wilcox (Oracle)8151b4c2020-06-01 21:46:44 -0700290struct readahead_control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
Jens Axboec75b1d92017-06-27 11:47:04 -0600292/*
293 * Write life time hint values.
Amir Goldstein69448862018-07-05 09:25:43 +0300294 * Stored in struct inode as u8.
Jens Axboec75b1d92017-06-27 11:47:04 -0600295 */
296enum rw_hint {
297 WRITE_LIFE_NOT_SET = 0,
298 WRITE_LIFE_NONE = RWH_WRITE_LIFE_NONE,
299 WRITE_LIFE_SHORT = RWH_WRITE_LIFE_SHORT,
300 WRITE_LIFE_MEDIUM = RWH_WRITE_LIFE_MEDIUM,
301 WRITE_LIFE_LONG = RWH_WRITE_LIFE_LONG,
302 WRITE_LIFE_EXTREME = RWH_WRITE_LIFE_EXTREME,
303};
304
Jens Axboece71bfe2020-08-31 12:08:10 -0600305/* Match RWF_* bits to IOCB bits */
306#define IOCB_HIPRI (__force int) RWF_HIPRI
307#define IOCB_DSYNC (__force int) RWF_DSYNC
308#define IOCB_SYNC (__force int) RWF_SYNC
309#define IOCB_NOWAIT (__force int) RWF_NOWAIT
310#define IOCB_APPEND (__force int) RWF_APPEND
311
312/* non-RWF related bits - start at 16 */
313#define IOCB_EVENTFD (1 << 16)
314#define IOCB_DIRECT (1 << 17)
315#define IOCB_WRITE (1 << 18)
Jens Axboedd3e6d52020-05-22 09:12:09 -0600316/* iocb->ki_waitq is valid */
Jens Axboece71bfe2020-08-31 12:08:10 -0600317#define IOCB_WAITQ (1 << 19)
318#define IOCB_NOIO (1 << 20)
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800319
320struct kiocb {
321 struct file *ki_filp;
Linus Torvalds84c4e1f82019-03-03 14:23:33 -0800322
323 /* The 'ki_filp' pointer is shared in a union for aio */
324 randomized_struct_fields_start
325
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800326 loff_t ki_pos;
327 void (*ki_complete)(struct kiocb *iocb, long ret, long ret2);
328 void *private;
329 int ki_flags;
Adam Manzanaresfc287242018-05-22 10:52:18 -0700330 u16 ki_hint;
Adam Manzanaresd9a08a92018-05-22 10:52:19 -0700331 u16 ki_ioprio; /* See linux/ioprio.h */
Jens Axboedd3e6d52020-05-22 09:12:09 -0600332 union {
333 unsigned int ki_cookie; /* for ->iopoll */
334 struct wait_page_queue *ki_waitq; /* for async buffered IO */
335 };
Linus Torvalds84c4e1f82019-03-03 14:23:33 -0800336
337 randomized_struct_fields_end
338};
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800339
340static inline bool is_sync_kiocb(struct kiocb *kiocb)
341{
342 return kiocb->ki_complete == NULL;
343}
344
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -0700345/*
346 * "descriptor" for what we're up to with a read.
347 * This allows us to use the same read code yet
348 * have multiple different users of the data that
349 * we read from a file.
350 *
351 * The simplest case just copies the data to user
352 * mode.
353 */
354typedef struct {
355 size_t written;
356 size_t count;
357 union {
358 char __user *buf;
359 void *data;
360 } arg;
361 int error;
362} read_descriptor_t;
363
364typedef int (*read_actor_t)(read_descriptor_t *, struct page *,
365 unsigned long, unsigned long);
Nick Piggin2f718ff2007-10-16 01:24:59 -0700366
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367struct address_space_operations {
368 int (*writepage)(struct page *page, struct writeback_control *wbc);
369 int (*readpage)(struct file *, struct page *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370
371 /* Write back some dirty pages from this mapping. */
372 int (*writepages)(struct address_space *, struct writeback_control *);
373
Andrew Morton4741c9f2006-03-24 03:18:11 -0800374 /* Set a page dirty. Return true if this dirtied it */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375 int (*set_page_dirty)(struct page *page);
376
Jens Axboe74c81642018-08-17 15:45:36 -0700377 /*
378 * Reads in the requested pages. Unlike ->readpage(), this is
379 * PURELY used for read-ahead!.
380 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 int (*readpages)(struct file *filp, struct address_space *mapping,
382 struct list_head *pages, unsigned nr_pages);
Matthew Wilcox (Oracle)8151b4c2020-06-01 21:46:44 -0700383 void (*readahead)(struct readahead_control *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384
Nick Pigginafddba42007-10-16 01:25:01 -0700385 int (*write_begin)(struct file *, struct address_space *mapping,
386 loff_t pos, unsigned len, unsigned flags,
387 struct page **pagep, void **fsdata);
388 int (*write_end)(struct file *, struct address_space *mapping,
389 loff_t pos, unsigned len, unsigned copied,
390 struct page *page, void *fsdata);
391
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 /* Unfortunately this kludge is needed for FIBMAP. Don't use it */
393 sector_t (*bmap)(struct address_space *, sector_t);
Lukas Czernerd47992f2013-05-21 23:17:23 -0400394 void (*invalidatepage) (struct page *, unsigned int, unsigned int);
Al Viro27496a82005-10-21 03:20:48 -0400395 int (*releasepage) (struct page *, gfp_t);
Linus Torvalds6072d132010-12-01 13:35:19 -0500396 void (*freepage)(struct page *);
Christoph Hellwigc8b8e322016-04-07 08:51:58 -0700397 ssize_t (*direct_IO)(struct kiocb *, struct iov_iter *iter);
Mel Gormanb969c4ab2012-01-12 17:19:34 -0800398 /*
Tang Chenef277c72013-07-08 16:00:21 -0700399 * migrate the contents of a page to the specified target. If
400 * migrate_mode is MIGRATE_ASYNC, it must not block.
Mel Gormanb969c4ab2012-01-12 17:19:34 -0800401 */
Christoph Lameter2d1db3b2006-06-23 02:03:33 -0700402 int (*migratepage) (struct address_space *,
Mel Gormana6bc32b2012-01-12 17:19:43 -0800403 struct page *, struct page *, enum migrate_mode);
Minchan Kimbda807d2016-07-26 15:23:05 -0700404 bool (*isolate_page)(struct page *, isolate_mode_t);
405 void (*putback_page)(struct page *);
Trond Myklebuste3db7692007-01-10 23:15:39 -0800406 int (*launder_page) (struct page *);
Al Viroc186afb42014-02-02 21:16:54 -0500407 int (*is_partially_uptodate) (struct page *, unsigned long,
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -0700408 unsigned long);
Mel Gormanb4597222013-07-03 15:02:05 -0700409 void (*is_dirty_writeback) (struct page *, bool *, bool *);
Andi Kleen25718732009-09-16 11:50:13 +0200410 int (*error_remove_page)(struct address_space *, struct page *);
Mel Gorman62c230b2012-07-31 16:44:55 -0700411
412 /* swapfile support */
Mel Gormana509bc12012-07-31 16:44:57 -0700413 int (*swap_activate)(struct swap_info_struct *sis, struct file *file,
414 sector_t *span);
415 void (*swap_deactivate)(struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416};
417
Jens Axboe7dcda1c2011-04-05 23:51:48 +0200418extern const struct address_space_operations empty_aops;
419
Nick Pigginafddba42007-10-16 01:25:01 -0700420/*
421 * pagecache_write_begin/pagecache_write_end must be used by general code
422 * to write into the pagecache.
423 */
424int pagecache_write_begin(struct file *, struct address_space *mapping,
425 loff_t pos, unsigned len, unsigned flags,
426 struct page **pagep, void **fsdata);
427
428int pagecache_write_end(struct file *, struct address_space *mapping,
429 loff_t pos, unsigned len, unsigned copied,
430 struct page *page, void *fsdata);
431
Matthew Wilcoxeb797a82018-03-05 22:46:03 -0500432/**
433 * struct address_space - Contents of a cacheable, mappable object.
434 * @host: Owner, either the inode or the block_device.
435 * @i_pages: Cached pages.
436 * @gfp_mask: Memory allocation flags to use for allocating pages.
437 * @i_mmap_writable: Number of VM_SHARED mappings.
Song Liu09d91cd2019-09-23 15:38:03 -0700438 * @nr_thps: Number of THPs in the pagecache (non-shmem only).
Matthew Wilcoxeb797a82018-03-05 22:46:03 -0500439 * @i_mmap: Tree of private and shared mappings.
440 * @i_mmap_rwsem: Protects @i_mmap and @i_mmap_writable.
441 * @nrpages: Number of page entries, protected by the i_pages lock.
442 * @nrexceptional: Shadow or DAX entries, protected by the i_pages lock.
443 * @writeback_index: Writeback starts here.
444 * @a_ops: Methods.
445 * @flags: Error bits and flags (AS_*).
446 * @wb_err: The most recent error which has occurred.
447 * @private_lock: For use by the owner of the address_space.
448 * @private_list: For use by the owner of the address_space.
449 * @private_data: For use by the owner of the address_space.
450 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451struct address_space {
Matthew Wilcoxeb797a82018-03-05 22:46:03 -0500452 struct inode *host;
453 struct xarray i_pages;
454 gfp_t gfp_mask;
455 atomic_t i_mmap_writable;
Song Liu09d91cd2019-09-23 15:38:03 -0700456#ifdef CONFIG_READ_ONLY_THP_FOR_FS
457 /* number of thp, only for non-shmem files */
458 atomic_t nr_thps;
459#endif
Matthew Wilcoxeb797a82018-03-05 22:46:03 -0500460 struct rb_root_cached i_mmap;
461 struct rw_semaphore i_mmap_rwsem;
462 unsigned long nrpages;
Ross Zwislerf9fe48b2016-01-22 15:10:40 -0800463 unsigned long nrexceptional;
Matthew Wilcoxeb797a82018-03-05 22:46:03 -0500464 pgoff_t writeback_index;
465 const struct address_space_operations *a_ops;
466 unsigned long flags;
Jeff Layton5660e132017-07-06 07:02:25 -0400467 errseq_t wb_err;
Matthew Wilcoxeb797a82018-03-05 22:46:03 -0500468 spinlock_t private_lock;
469 struct list_head private_list;
470 void *private_data;
Kees Cook3859a272016-10-28 01:22:25 -0700471} __attribute__((aligned(sizeof(long)))) __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 /*
473 * On most architectures that alignment is already the case; but
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300474 * must be enforced here for CRIS, to let the least significant bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475 * of struct page's "mapping" pointer be used for PAGE_MAPPING_ANON.
476 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477
Matthew Wilcoxff9c7452017-11-22 11:41:23 -0500478/* XArray tags, for tagging dirty and writeback pages in the pagecache. */
479#define PAGECACHE_TAG_DIRTY XA_MARK_0
480#define PAGECACHE_TAG_WRITEBACK XA_MARK_1
481#define PAGECACHE_TAG_TOWRITE XA_MARK_2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482
Matthew Wilcoxff9c7452017-11-22 11:41:23 -0500483/*
484 * Returns true if any of the pages in the mapping are marked with the tag.
485 */
486static inline bool mapping_tagged(struct address_space *mapping, xa_mark_t tag)
487{
488 return xa_marked(&mapping->i_pages, tag);
489}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800491static inline void i_mmap_lock_write(struct address_space *mapping)
492{
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800493 down_write(&mapping->i_mmap_rwsem);
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800494}
495
Mike Kravetzc0d03812020-04-01 21:11:05 -0700496static inline int i_mmap_trylock_write(struct address_space *mapping)
497{
498 return down_write_trylock(&mapping->i_mmap_rwsem);
499}
500
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800501static inline void i_mmap_unlock_write(struct address_space *mapping)
502{
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800503 up_write(&mapping->i_mmap_rwsem);
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800504}
505
Davidlohr Bueso3dec0ba2014-12-12 16:54:27 -0800506static inline void i_mmap_lock_read(struct address_space *mapping)
507{
508 down_read(&mapping->i_mmap_rwsem);
509}
510
511static inline void i_mmap_unlock_read(struct address_space *mapping)
512{
513 up_read(&mapping->i_mmap_rwsem);
514}
515
Mike Kravetz34ae2042020-08-11 18:31:38 -0700516static inline void i_mmap_assert_locked(struct address_space *mapping)
517{
518 lockdep_assert_held(&mapping->i_mmap_rwsem);
519}
520
521static inline void i_mmap_assert_write_locked(struct address_space *mapping)
522{
523 lockdep_assert_held_write(&mapping->i_mmap_rwsem);
524}
525
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526/*
527 * Might pages of this file be mapped into userspace?
528 */
529static inline int mapping_mapped(struct address_space *mapping)
530{
Davidlohr Buesof808c132017-09-08 16:15:08 -0700531 return !RB_EMPTY_ROOT(&mapping->i_mmap.rb_root);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532}
533
534/*
535 * Might pages of this file have been modified in userspace?
Peter Collingbourne45e55302020-08-06 23:23:37 -0700536 * Note that i_mmap_writable counts all VM_SHARED vmas: do_mmap
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 * marks vma as VM_SHARED if it is shared, and the file was opened for
538 * writing i.e. vma may be mprotected writable even if now readonly.
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700539 *
540 * If i_mmap_writable is negative, no new writable mappings are allowed. You
541 * can only deny writable mappings, if none exists right now.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 */
543static inline int mapping_writably_mapped(struct address_space *mapping)
544{
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700545 return atomic_read(&mapping->i_mmap_writable) > 0;
546}
547
548static inline int mapping_map_writable(struct address_space *mapping)
549{
550 return atomic_inc_unless_negative(&mapping->i_mmap_writable) ?
551 0 : -EPERM;
552}
553
554static inline void mapping_unmap_writable(struct address_space *mapping)
555{
556 atomic_dec(&mapping->i_mmap_writable);
557}
558
559static inline int mapping_deny_writable(struct address_space *mapping)
560{
561 return atomic_dec_unless_positive(&mapping->i_mmap_writable) ?
562 0 : -EBUSY;
563}
564
565static inline void mapping_allow_writable(struct address_space *mapping)
566{
567 atomic_inc(&mapping->i_mmap_writable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568}
569
570/*
571 * Use sequence counter to get consistent i_size on 32-bit processors.
572 */
573#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
574#include <linux/seqlock.h>
575#define __NEED_I_SIZE_ORDERED
576#define i_size_ordered_init(inode) seqcount_init(&inode->i_size_seqcount)
577#else
578#define i_size_ordered_init(inode) do { } while (0)
579#endif
580
Al Virof19d4a82009-06-08 19:50:45 -0400581struct posix_acl;
582#define ACL_NOT_CACHED ((void *)(-1))
Miklos Szeredi2a3a2a32016-09-01 11:11:59 +0200583#define ACL_DONT_CACHE ((void *)(-3))
Al Virof19d4a82009-06-08 19:50:45 -0400584
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100585static inline struct posix_acl *
586uncached_acl_sentinel(struct task_struct *task)
587{
588 return (void *)task + 1;
589}
590
591static inline bool
592is_uncached_acl(struct posix_acl *acl)
593{
594 return (long)acl & 1;
595}
596
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700597#define IOP_FASTPERM 0x0001
598#define IOP_LOOKUP 0x0002
599#define IOP_NOFOLLOW 0x0004
Andreas Gruenbacherd0a5b992016-09-29 17:48:39 +0200600#define IOP_XATTR 0x0008
Miklos Szeredi76fca902016-12-09 16:45:04 +0100601#define IOP_DEFAULT_READLINK 0x0010
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700602
Jan Kara9dd813c2017-03-14 12:31:02 +0100603struct fsnotify_mark_connector;
604
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700605/*
606 * Keep mostly read-only and often accessed (especially for
607 * the RCU path lookup and 'stat' data) fields at the beginning
608 * of the 'struct inode'
609 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610struct inode {
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100611 umode_t i_mode;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700612 unsigned short i_opflags;
Eric W. Biederman92361632012-02-08 07:07:50 -0800613 kuid_t i_uid;
614 kgid_t i_gid;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700615 unsigned int i_flags;
616
617#ifdef CONFIG_FS_POSIX_ACL
618 struct posix_acl *i_acl;
619 struct posix_acl *i_default_acl;
620#endif
621
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100622 const struct inode_operations *i_op;
623 struct super_block *i_sb;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700624 struct address_space *i_mapping;
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100625
Linus Torvalds13e12d12011-06-08 15:18:19 -0700626#ifdef CONFIG_SECURITY
627 void *i_security;
628#endif
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100629
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700630 /* Stat data, not accessed from path walking */
631 unsigned long i_ino;
Miklos Szeredia78ef702011-10-28 14:13:30 +0200632 /*
633 * Filesystems may only read i_nlink directly. They shall use the
634 * following functions for modification:
635 *
636 * (set|clear|inc|drop)_nlink
637 * inode_(inc|dec)_link_count
638 */
639 union {
640 const unsigned int i_nlink;
641 unsigned int __i_nlink;
642 };
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700643 dev_t i_rdev;
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700644 loff_t i_size;
Deepa Dinamani95582b02018-05-08 19:36:02 -0700645 struct timespec64 i_atime;
646 struct timespec64 i_mtime;
647 struct timespec64 i_ctime;
Theodore Ts'o6cdbb0e2011-10-29 08:24:18 -0400648 spinlock_t i_lock; /* i_blocks, i_bytes, maybe i_size */
649 unsigned short i_bytes;
Amir Goldstein69448862018-07-05 09:25:43 +0300650 u8 i_blkbits;
651 u8 i_write_hint;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700652 blkcnt_t i_blocks;
653
654#ifdef __NEED_I_SIZE_ORDERED
655 seqcount_t i_size_seqcount;
656#endif
657
658 /* Misc */
659 unsigned long i_state;
Al Viro9902af72016-04-15 15:08:36 -0400660 struct rw_semaphore i_rwsem;
Linus Torvalds13e12d12011-06-08 15:18:19 -0700661
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100662 unsigned long dirtied_when; /* jiffies of first dirtying */
Theodore Ts'oa2f48702015-03-17 12:23:19 -0400663 unsigned long dirtied_time_when;
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100664
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665 struct hlist_node i_hash;
Dave Chinnerc7f54082015-03-04 14:07:22 -0500666 struct list_head i_io_list; /* backing dev IO list */
Tejun Heo52ebea72015-05-22 17:13:37 -0400667#ifdef CONFIG_CGROUP_WRITEBACK
668 struct bdi_writeback *i_wb; /* the associated cgroup wb */
Tejun Heo2a814902015-05-28 14:50:51 -0400669
670 /* foreign inode detection, see wbc_detach_inode() */
671 int i_wb_frn_winner;
672 u16 i_wb_frn_avg_time;
673 u16 i_wb_frn_history;
Tejun Heo52ebea72015-05-22 17:13:37 -0400674#endif
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100675 struct list_head i_lru; /* inode LRU list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 struct list_head i_sb_list;
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700677 struct list_head i_wb_list; /* backing dev writeback list */
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100678 union {
Al Virob3d9b7a2012-06-09 13:51:19 -0400679 struct hlist_head i_dentry;
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100680 struct rcu_head i_rcu;
681 };
Jeff Laytonf02a9ad2017-12-21 07:45:44 -0500682 atomic64_t i_version;
Peter Zijlstra8019ad12020-03-04 11:28:31 +0100683 atomic64_t i_sequence; /* see futex */
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700684 atomic_t i_count;
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -0400685 atomic_t i_dio_count;
Theodore Ts'o6cdbb0e2011-10-29 08:24:18 -0400686 atomic_t i_writecount;
Amir Goldstein387e3742019-06-07 17:24:38 +0300687#if defined(CONFIG_IMA) || defined(CONFIG_FILE_LOCKING)
Mimi Zohard984ea62013-12-11 15:20:54 -0500688 atomic_t i_readcount; /* struct files open RO */
689#endif
Al Virofdb0da82019-04-10 14:43:44 -0400690 union {
691 const struct file_operations *i_fop; /* former ->i_op->default_file_ops */
692 void (*free_inode)(struct inode *);
693 };
Jeff Layton4a075e32015-01-16 15:05:54 -0500694 struct file_lock_context *i_flctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 struct address_space i_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 struct list_head i_devices;
Theodore Ts'o4c154162006-09-27 01:50:47 -0700697 union {
698 struct pipe_inode_info *i_pipe;
Theodore Ts'oeaf796e2006-09-27 01:50:48 -0700699 struct block_device *i_bdev;
Theodore Ts'o577c4eb2006-09-27 01:50:49 -0700700 struct cdev *i_cdev;
Al Viro61ba64f2015-05-02 09:54:06 -0400701 char *i_link;
Al Viro84e710d2016-04-15 00:58:55 -0400702 unsigned i_dir_seq;
Theodore Ts'o4c154162006-09-27 01:50:47 -0700703 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704
705 __u32 i_generation;
706
Eric Paris3be25f42009-05-21 17:01:26 -0400707#ifdef CONFIG_FSNOTIFY
708 __u32 i_fsnotify_mask; /* all events this inode cares about */
Jan Kara08991e82017-02-01 09:21:58 +0100709 struct fsnotify_mark_connector __rcu *i_fsnotify_marks;
Robert Love0eeca282005-07-12 17:06:03 -0400710#endif
711
Chandan Rajendra643fa962018-12-12 15:20:12 +0530712#ifdef CONFIG_FS_ENCRYPTION
Jaegeuk Kim0b81d072015-05-15 16:26:10 -0700713 struct fscrypt_info *i_crypt_info;
714#endif
715
Eric Biggers5585f2a2019-07-22 09:26:21 -0700716#ifdef CONFIG_FS_VERITY
717 struct fsverity_info *i_verity_info;
718#endif
719
Theodore Ts'o8e18e292006-09-27 01:50:46 -0700720 void *i_private; /* fs or device private pointer */
Kees Cook3859a272016-10-28 01:22:25 -0700721} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722
Deepa Dinamani50e17c002018-01-21 18:04:25 -0800723struct timespec64 timestamp_truncate(struct timespec64 t, struct inode *inode);
724
Fabian Frederick93407472017-02-27 14:28:32 -0800725static inline unsigned int i_blocksize(const struct inode *node)
726{
727 return (1 << node->i_blkbits);
728}
729
Al Viro1d3382cb2010-10-23 15:19:20 -0400730static inline int inode_unhashed(struct inode *inode)
731{
732 return hlist_unhashed(&inode->i_hash);
733}
734
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735/*
Al Viro5bef9152018-06-29 19:36:57 -0400736 * __mark_inode_dirty expects inodes to be hashed. Since we don't
737 * want special inodes in the fileset inode space, we make them
738 * appear hashed, but do not put on any lists. hlist_del()
739 * will work fine and require no locking.
740 */
741static inline void inode_fake_hash(struct inode *inode)
742{
743 hlist_add_fake(&inode->i_hash);
744}
745
746/*
Ingo Molnarf2eace22006-07-03 00:25:05 -0700747 * inode->i_mutex nesting subclasses for the lock validator:
748 *
749 * 0: the object of the current VFS operation
750 * 1: parent
751 * 2: child/target
J. Bruce Fields40bd22c2012-04-18 15:21:34 -0400752 * 3: xattr
753 * 4: second non-directory
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100754 * 5: second parent (when locking independent directories in rename)
755 *
756 * I_MUTEX_NONDIR2 is for certain operations (such as rename) which lock two
J. Bruce Fields40bd22c2012-04-18 15:21:34 -0400757 * non-directories at once.
Ingo Molnarf2eace22006-07-03 00:25:05 -0700758 *
759 * The locking order between these classes is
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100760 * parent[2] -> child -> grandchild -> normal -> xattr -> second non-directory
Ingo Molnarf2eace22006-07-03 00:25:05 -0700761 */
762enum inode_i_mutex_lock_class
763{
764 I_MUTEX_NORMAL,
765 I_MUTEX_PARENT,
766 I_MUTEX_CHILD,
Ingo Molnar4df46242006-08-27 01:23:56 -0700767 I_MUTEX_XATTR,
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100768 I_MUTEX_NONDIR2,
769 I_MUTEX_PARENT2,
Ingo Molnarf2eace22006-07-03 00:25:05 -0700770};
771
Al Viro59551022016-01-22 15:40:57 -0500772static inline void inode_lock(struct inode *inode)
773{
Al Viro9902af72016-04-15 15:08:36 -0400774 down_write(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500775}
776
777static inline void inode_unlock(struct inode *inode)
778{
Al Viro9902af72016-04-15 15:08:36 -0400779 up_write(&inode->i_rwsem);
780}
781
782static inline void inode_lock_shared(struct inode *inode)
783{
784 down_read(&inode->i_rwsem);
785}
786
787static inline void inode_unlock_shared(struct inode *inode)
788{
789 up_read(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500790}
791
792static inline int inode_trylock(struct inode *inode)
793{
Al Viro9902af72016-04-15 15:08:36 -0400794 return down_write_trylock(&inode->i_rwsem);
795}
796
797static inline int inode_trylock_shared(struct inode *inode)
798{
799 return down_read_trylock(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500800}
801
802static inline int inode_is_locked(struct inode *inode)
803{
Al Viro9902af72016-04-15 15:08:36 -0400804 return rwsem_is_locked(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500805}
806
807static inline void inode_lock_nested(struct inode *inode, unsigned subclass)
808{
Al Viro9902af72016-04-15 15:08:36 -0400809 down_write_nested(&inode->i_rwsem, subclass);
Al Viro59551022016-01-22 15:40:57 -0500810}
811
Darrick J. Wong01c2e132018-01-18 14:07:53 -0800812static inline void inode_lock_shared_nested(struct inode *inode, unsigned subclass)
813{
814 down_read_nested(&inode->i_rwsem, subclass);
815}
816
J. Bruce Fields375e2892012-04-18 15:16:33 -0400817void lock_two_nondirectories(struct inode *, struct inode*);
818void unlock_two_nondirectories(struct inode *, struct inode*);
819
Ingo Molnarf2eace22006-07-03 00:25:05 -0700820/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 * NOTE: in a 32bit arch with a preemptable kernel and
822 * an UP compile the i_size_read/write must be atomic
823 * with respect to the local cpu (unlike with preempt disabled),
824 * but they don't need to be atomic with respect to other cpus like in
825 * true SMP (so they need either to either locally disable irq around
826 * the read or for example on x86 they can be still implemented as a
827 * cmpxchg8b without the need of the lock prefix). For SMP compiles
828 * and 64bit archs it makes no difference if preempt is enabled or not.
829 */
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800830static inline loff_t i_size_read(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831{
832#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
833 loff_t i_size;
834 unsigned int seq;
835
836 do {
837 seq = read_seqcount_begin(&inode->i_size_seqcount);
838 i_size = inode->i_size;
839 } while (read_seqcount_retry(&inode->i_size_seqcount, seq));
840 return i_size;
Thomas Gleixner24963962019-10-15 21:18:10 +0200841#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPTION)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842 loff_t i_size;
843
844 preempt_disable();
845 i_size = inode->i_size;
846 preempt_enable();
847 return i_size;
848#else
849 return inode->i_size;
850#endif
851}
852
Miklos Szeredi7762f5a2006-10-17 00:10:07 -0700853/*
854 * NOTE: unlike i_size_read(), i_size_write() does need locking around it
855 * (normally i_mutex), otherwise on 32bit/SMP an update of i_size_seqcount
856 * can be lost, resulting in subsequent i_size_read() calls spinning forever.
857 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858static inline void i_size_write(struct inode *inode, loff_t i_size)
859{
860#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
Fan Du74e3d1e2013-04-30 15:27:27 -0700861 preempt_disable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 write_seqcount_begin(&inode->i_size_seqcount);
863 inode->i_size = i_size;
864 write_seqcount_end(&inode->i_size_seqcount);
Fan Du74e3d1e2013-04-30 15:27:27 -0700865 preempt_enable();
Thomas Gleixner24963962019-10-15 21:18:10 +0200866#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPTION)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 preempt_disable();
868 inode->i_size = i_size;
869 preempt_enable();
870#else
871 inode->i_size = i_size;
872#endif
873}
874
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800875static inline unsigned iminor(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876{
877 return MINOR(inode->i_rdev);
878}
879
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800880static inline unsigned imajor(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881{
882 return MAJOR(inode->i_rdev);
883}
884
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885struct fown_struct {
886 rwlock_t lock; /* protects pid, uid, euid fields */
Eric W. Biederman609d7fa2006-10-02 02:17:15 -0700887 struct pid *pid; /* pid or -pgrp where SIGIO should be sent */
888 enum pid_type pid_type; /* Kind of process group SIGIO should be sent to */
Eric W. Biederman92361632012-02-08 07:07:50 -0800889 kuid_t uid, euid; /* uid/euid of process setting the owner */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890 int signum; /* posix.1b rt signal to be delivered on IO */
891};
892
893/*
894 * Track a single file's readahead state
895 */
896struct file_ra_state {
Fengguang Wu937085a2007-10-16 01:24:31 -0700897 pgoff_t start; /* where readahead started */
898 unsigned int size; /* # of readahead pages */
899 unsigned int async_size; /* do asynchronous readahead when
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700900 there are only # of pages ahead */
Fengguang Wu5ce11102007-07-19 01:47:59 -0700901
Fengguang Wu937085a2007-10-16 01:24:31 -0700902 unsigned int ra_pages; /* Maximum readahead window */
Wu Fengguang1ebf26a2009-06-16 15:31:19 -0700903 unsigned int mmap_miss; /* Cache miss stat for mmap accesses */
Fengguang Wuf4e6b492007-10-16 01:24:33 -0700904 loff_t prev_pos; /* Cache last read() position */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906
Fengguang Wu5ce11102007-07-19 01:47:59 -0700907/*
Fengguang Wu5ce11102007-07-19 01:47:59 -0700908 * Check if @index falls in the readahead windows.
909 */
910static inline int ra_has_index(struct file_ra_state *ra, pgoff_t index)
911{
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700912 return (index >= ra->start &&
913 index < ra->start + ra->size);
Fengguang Wu5ce11102007-07-19 01:47:59 -0700914}
915
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916struct file {
Eric Dumazet2f512012005-10-30 15:02:16 -0800917 union {
Oleg Nesterov4f5e65a2013-07-08 14:24:16 -0700918 struct llist_node fu_llist;
Eric Dumazet2f512012005-10-30 15:02:16 -0800919 struct rcu_head fu_rcuhead;
920 } f_u;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800921 struct path f_path;
Al Virodd379782013-03-01 19:48:30 -0500922 struct inode *f_inode; /* cached value */
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800923 const struct file_operations *f_op;
Andi Kleenef3d0fd2011-09-15 16:06:48 -0700924
925 /*
Linus Torvalds9c225f22014-03-03 09:36:58 -0800926 * Protects f_ep_links, f_flags.
Andi Kleenef3d0fd2011-09-15 16:06:48 -0700927 * Must not be taken from IRQ context.
928 */
929 spinlock_t f_lock;
Jens Axboec75b1d92017-06-27 11:47:04 -0600930 enum rw_hint f_write_hint;
Al Viro516e0cc2008-07-26 00:39:17 -0400931 atomic_long_t f_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932 unsigned int f_flags;
Al Viroaeb5d722008-09-02 15:28:45 -0400933 fmode_t f_mode;
Linus Torvalds9c225f22014-03-03 09:36:58 -0800934 struct mutex f_pos_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935 loff_t f_pos;
936 struct fown_struct f_owner;
David Howellsd76b0d92008-11-14 10:39:25 +1100937 const struct cred *f_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938 struct file_ra_state f_ra;
939
Mathieu Desnoyers2b47c362007-10-16 23:27:21 -0700940 u64 f_version;
Alexey Dobriyan50462062006-09-29 02:00:01 -0700941#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942 void *f_security;
Alexey Dobriyan50462062006-09-29 02:00:01 -0700943#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944 /* needed for tty driver, and maybe others */
945 void *private_data;
946
947#ifdef CONFIG_EPOLL
948 /* Used by fs/eventpoll.c to link all the hooks to this file */
949 struct list_head f_ep_links;
Jason Baron28d82dc2012-01-12 17:17:43 -0800950 struct list_head f_tfile_llink;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951#endif /* #ifdef CONFIG_EPOLL */
952 struct address_space *f_mapping;
Jeff Layton5660e132017-07-06 07:02:25 -0400953 errseq_t f_wb_err;
Jeff Layton735e4ae2020-06-01 21:45:36 -0700954 errseq_t f_sb_err; /* for syncfs */
Kees Cook3859a272016-10-28 01:22:25 -0700955} __randomize_layout
956 __attribute__((aligned(4))); /* lest something weird decides that 2 is OK */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957
Aneesh Kumar K.V990d6c22011-01-29 18:43:26 +0530958struct file_handle {
959 __u32 handle_bytes;
960 int handle_type;
961 /* file identifier */
Linus Torvalds9d829732020-05-04 09:16:37 -0700962 unsigned char f_handle[];
Aneesh Kumar K.V990d6c22011-01-29 18:43:26 +0530963};
964
Al Virocb0942b2012-08-27 14:48:26 -0400965static inline struct file *get_file(struct file *f)
966{
967 atomic_long_inc(&f->f_count);
968 return f;
969}
Jens Axboe091141a2018-11-21 10:32:39 -0700970#define get_file_rcu_many(x, cnt) \
971 atomic_long_add_unless(&(x)->f_count, (cnt), 0)
972#define get_file_rcu(x) get_file_rcu_many((x), 1)
Al Viro516e0cc2008-07-26 00:39:17 -0400973#define file_count(x) atomic_long_read(&(x)->f_count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974
975#define MAX_NON_LFS ((1UL<<31) - 1)
976
977/* Page cache limit. The filesystems should put that into their s_maxbytes
978 limits, otherwise bad things can happen in VM. */
979#if BITS_PER_LONG==32
Linus Torvalds0cc3b0e2017-08-27 12:12:25 -0700980#define MAX_LFS_FILESIZE ((loff_t)ULONG_MAX << PAGE_SHIFT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981#elif BITS_PER_LONG==64
Linus Torvalds0cc3b0e2017-08-27 12:12:25 -0700982#define MAX_LFS_FILESIZE ((loff_t)LLONG_MAX)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983#endif
984
985#define FL_POSIX 1
986#define FL_FLOCK 2
J. Bruce Fields617588d2011-07-01 15:18:34 -0400987#define FL_DELEG 4 /* NFSv4 delegation */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988#define FL_ACCESS 8 /* not trying to lock, just looking */
Trond Myklebustf475ae92006-06-29 16:38:32 -0400989#define FL_EXISTS 16 /* when unlocking, test for existence */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990#define FL_LEASE 32 /* lease held on this file */
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -0700991#define FL_CLOSE 64 /* unlock on close */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992#define FL_SLEEP 128 /* A blocking lock */
J. Bruce Fields778fc542011-07-26 18:25:49 -0400993#define FL_DOWNGRADE_PENDING 256 /* Lease is being downgraded */
994#define FL_UNLOCK_PENDING 512 /* Lease is being broken */
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400995#define FL_OFDLCK 1024 /* lock is "owned" by struct file */
Christoph Hellwig11afe9f2015-01-21 19:17:03 +0100996#define FL_LAYOUT 2048 /* outstanding pNFS layout */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997
Benjamin Coddington50f21122017-04-11 12:50:09 -0400998#define FL_CLOSE_POSIX (FL_POSIX | FL_CLOSE)
999
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000/*
Miklos Szeredibde74e42008-07-25 01:48:57 -07001001 * Special return value from posix_lock_file() and vfs_lock_file() for
1002 * asynchronous locking.
1003 */
1004#define FILE_LOCK_DEFERRED 1
1005
Jeff Layton7ca76312014-09-01 19:04:48 -04001006/* legacy typedef, should eventually be removed */
Christoph Hellwig17fa3882014-07-13 17:00:37 +02001007typedef void *fl_owner_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008
Jeff Laytona7231a92015-01-16 15:05:56 -05001009struct file_lock;
1010
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011struct file_lock_operations {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012 void (*fl_copy_lock)(struct file_lock *, struct file_lock *);
1013 void (*fl_release_private)(struct file_lock *);
1014};
1015
1016struct lock_manager_operations {
Jeff Laytoncae80b32015-04-03 09:04:04 -04001017 fl_owner_t (*lm_get_owner)(fl_owner_t);
1018 void (*lm_put_owner)(fl_owner_t);
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001019 void (*lm_notify)(struct file_lock *); /* unblock callback */
Joe Perchesd0449b92014-08-22 10:18:42 -04001020 int (*lm_grant)(struct file_lock *, int);
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001021 bool (*lm_break)(struct file_lock *);
Jeff Layton7448cc32015-01-16 15:05:57 -05001022 int (*lm_change)(struct file_lock *, int, struct list_head *);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001023 void (*lm_setup)(struct file_lock *, void **);
J. Bruce Fields28df3d12017-07-28 16:35:15 -04001024 bool (*lm_breaker_owns_lease)(struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025};
1026
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -04001027struct lock_manager {
1028 struct list_head list;
J. Bruce Fieldsc87fb4a2015-08-06 12:47:02 -04001029 /*
1030 * NFSv4 and up also want opens blocked during the grace period;
1031 * NLM doesn't care:
1032 */
1033 bool block_opens;
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -04001034};
1035
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +04001036struct net;
1037void locks_start_grace(struct net *, struct lock_manager *);
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -04001038void locks_end_grace(struct lock_manager *);
Corentin Labbe003278e2017-09-26 09:14:07 +02001039bool locks_in_grace(struct net *);
1040bool opens_in_grace(struct net *);
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -04001041
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042/* that will die - we need it for nfs_lock_info */
1043#include <linux/nfs_fs_i.h>
1044
Jeff Layton1cb36012013-06-21 08:58:12 -04001045/*
1046 * struct file_lock represents a generic "file lock". It's used to represent
1047 * POSIX byte range locks, BSD (flock) locks, and leases. It's important to
1048 * note that the same struct is used to represent both a request for a lock and
1049 * the lock itself, but the same object is never used for both.
1050 *
1051 * FIXME: should we create a separate "struct lock_request" to help distinguish
1052 * these two uses?
1053 *
Jeff Layton8116bf42015-01-21 20:44:01 -05001054 * The varous i_flctx lists are ordered by:
Jeff Layton1cb36012013-06-21 08:58:12 -04001055 *
Jeff Layton8116bf42015-01-21 20:44:01 -05001056 * 1) lock owner
1057 * 2) lock range start
1058 * 3) lock range end
Jeff Layton1cb36012013-06-21 08:58:12 -04001059 *
1060 * Obviously, the last two criteria only matter for POSIX locks.
1061 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062struct file_lock {
NeilBrownada5c1d2018-11-30 10:04:08 +11001063 struct file_lock *fl_blocker; /* The lock, that is blocking us */
Jeff Layton6dee60f2015-01-16 15:05:54 -05001064 struct list_head fl_list; /* link into file_lock_context */
Jeff Layton139ca042013-06-21 08:58:17 -04001065 struct hlist_node fl_link; /* node in global lists */
NeilBrownada5c1d2018-11-30 10:04:08 +11001066 struct list_head fl_blocked_requests; /* list of requests with
1067 * ->fl_blocker pointing here
1068 */
1069 struct list_head fl_blocked_member; /* node in
1070 * ->fl_blocker->fl_blocked_requests
1071 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 fl_owner_t fl_owner;
J. Bruce Fields710b7212011-07-26 16:28:29 -04001073 unsigned int fl_flags;
Richard Kennedyafc12462008-07-11 17:20:49 -07001074 unsigned char fl_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075 unsigned int fl_pid;
Jeff Layton7012b022013-06-21 08:58:22 -04001076 int fl_link_cpu; /* what cpu's list is this on? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077 wait_queue_head_t fl_wait;
1078 struct file *fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079 loff_t fl_start;
1080 loff_t fl_end;
1081
1082 struct fasync_struct * fl_fasync; /* for lease break notifications */
J. Bruce Fields778fc542011-07-26 18:25:49 -04001083 /* for lease breaks: */
1084 unsigned long fl_break_time;
1085 unsigned long fl_downgrade_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086
Alexey Dobriyan6aed6282009-09-21 17:01:11 -07001087 const struct file_lock_operations *fl_ops; /* Callbacks for filesystems */
Alexey Dobriyan7b021962009-09-21 17:01:12 -07001088 const struct lock_manager_operations *fl_lmops; /* Callbacks for lockmanagers */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089 union {
1090 struct nfs_lock_info nfs_fl;
Trond Myklebust8d0a8a92005-06-22 17:16:32 +00001091 struct nfs4_lock_info nfs4_fl;
David Howellse8d6c552007-07-15 23:40:12 -07001092 struct {
1093 struct list_head link; /* link in AFS vnode's pending_locks list */
1094 int state; /* state of grant or error if -ve */
David Howellsd4696602019-04-25 14:26:50 +01001095 unsigned int debug_id;
David Howellse8d6c552007-07-15 23:40:12 -07001096 } afs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 } fl_u;
Kees Cook3859a272016-10-28 01:22:25 -07001098} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099
Jeff Layton4a075e32015-01-16 15:05:54 -05001100struct file_lock_context {
Jeff Layton6109c852015-01-16 15:05:57 -05001101 spinlock_t flc_lock;
Jeff Layton4a075e32015-01-16 15:05:54 -05001102 struct list_head flc_flock;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001103 struct list_head flc_posix;
Jeff Layton8634b512015-01-16 15:05:55 -05001104 struct list_head flc_lease;
Jeff Layton4a075e32015-01-16 15:05:54 -05001105};
1106
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107/* The following constant reflects the upper bound of the file/locking space */
1108#ifndef OFFSET_MAX
1109#define INT_LIMIT(x) (~((x)1 << (sizeof(x)*8 - 1)))
1110#define OFFSET_MAX INT_LIMIT(loff_t)
1111#define OFFT_OFFSET_MAX INT_LIMIT(off_t)
1112#endif
1113
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001114extern void send_sigio(struct fown_struct *fown, int fd, int band);
1115
Miklos Szeredide2a4a52018-07-18 15:44:43 +02001116#define locks_inode(f) file_inode(f)
Miklos Szeredic568d682016-09-16 12:44:20 +02001117
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001118#ifdef CONFIG_FILE_LOCKING
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04001119extern int fcntl_getlk(struct file *, unsigned int, struct flock *);
Peter Staubachc2936212005-07-27 11:45:09 -07001120extern int fcntl_setlk(unsigned int, struct file *, unsigned int,
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04001121 struct flock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122
1123#if BITS_PER_LONG == 32
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04001124extern int fcntl_getlk64(struct file *, unsigned int, struct flock64 *);
Peter Staubachc2936212005-07-27 11:45:09 -07001125extern int fcntl_setlk64(unsigned int, struct file *, unsigned int,
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04001126 struct flock64 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127#endif
1128
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129extern int fcntl_setlease(unsigned int fd, struct file *filp, long arg);
1130extern int fcntl_getlease(struct file *filp);
1131
1132/* fs/locks.c */
Jeff Laytonf27a0fe2016-01-07 15:08:51 -05001133void locks_free_lock_context(struct inode *inode);
J. Bruce Fields05fa3132010-10-30 17:31:15 -04001134void locks_free_lock(struct file_lock *fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135extern void locks_init_lock(struct file_lock *);
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001136extern struct file_lock * locks_alloc_lock(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137extern void locks_copy_lock(struct file_lock *, struct file_lock *);
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001138extern void locks_copy_conflock(struct file_lock *, struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139extern void locks_remove_posix(struct file *, fl_owner_t);
Jeff Layton78ed8a12014-02-03 12:13:08 -05001140extern void locks_remove_file(struct file *);
Felix Blyakhera9e61e22009-03-31 15:12:56 -05001141extern void locks_release_private(struct file_lock *);
J. Bruce Fields6d34ac12007-05-11 16:09:32 -04001142extern void posix_test_lock(struct file *, struct file_lock *);
Marc Eshel150b3932007-01-18 16:15:35 -05001143extern int posix_lock_file(struct file *, struct file_lock *, struct file_lock *);
NeilBrowncb03f942018-11-30 10:04:08 +11001144extern int locks_delete_block(struct file_lock *);
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001145extern int vfs_test_lock(struct file *, struct file_lock *);
Marc Eshel150b3932007-01-18 16:15:35 -05001146extern int vfs_lock_file(struct file *, unsigned int, struct file_lock *, struct file_lock *);
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05001147extern int vfs_cancel_lock(struct file *filp, struct file_lock *fl);
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001148extern int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001149extern int __break_lease(struct inode *inode, unsigned int flags, unsigned int type);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001150extern void lease_get_mtime(struct inode *, struct timespec64 *time);
Jeff Laytone6f5c782014-08-22 10:40:25 -04001151extern int generic_setlease(struct file *, long, struct file_lock **, void **priv);
1152extern int vfs_setlease(struct file *, long, struct file_lock **, void **);
Jeff Layton7448cc32015-01-16 15:05:57 -05001153extern int lease_modify(struct file_lock *, int, struct list_head *);
Jeff Layton18f66222019-08-18 14:18:45 -04001154
1155struct notifier_block;
1156extern int lease_register_notifier(struct notifier_block *);
1157extern void lease_unregister_notifier(struct notifier_block *);
1158
Andrey Vagin6c8c9032015-04-16 12:49:38 -07001159struct files_struct;
1160extern void show_fd_locks(struct seq_file *f,
1161 struct file *filp, struct files_struct *files);
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001162#else /* !CONFIG_FILE_LOCKING */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001163static inline int fcntl_getlk(struct file *file, unsigned int cmd,
1164 struct flock __user *user)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001165{
1166 return -EINVAL;
1167}
1168
1169static inline int fcntl_setlk(unsigned int fd, struct file *file,
1170 unsigned int cmd, struct flock __user *user)
1171{
1172 return -EACCES;
1173}
1174
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001175#if BITS_PER_LONG == 32
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001176static inline int fcntl_getlk64(struct file *file, unsigned int cmd,
1177 struct flock64 __user *user)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001178{
1179 return -EINVAL;
1180}
1181
1182static inline int fcntl_setlk64(unsigned int fd, struct file *file,
1183 unsigned int cmd, struct flock64 __user *user)
1184{
1185 return -EACCES;
1186}
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001187#endif
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001188static inline int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1189{
Jeff Layton1b2b32d2014-09-24 08:38:44 -04001190 return -EINVAL;
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001191}
1192
1193static inline int fcntl_getlease(struct file *filp)
1194{
Jeff Layton1b2b32d2014-09-24 08:38:44 -04001195 return F_UNLCK;
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001196}
1197
Jeff Layton4a075e32015-01-16 15:05:54 -05001198static inline void
Jeff Laytonf27a0fe2016-01-07 15:08:51 -05001199locks_free_lock_context(struct inode *inode)
Jeff Layton4a075e32015-01-16 15:05:54 -05001200{
1201}
1202
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001203static inline void locks_init_lock(struct file_lock *fl)
1204{
1205 return;
1206}
1207
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001208static inline void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001209{
1210 return;
1211}
1212
1213static inline void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
1214{
1215 return;
1216}
1217
1218static inline void locks_remove_posix(struct file *filp, fl_owner_t owner)
1219{
1220 return;
1221}
1222
Jeff Layton78ed8a12014-02-03 12:13:08 -05001223static inline void locks_remove_file(struct file *filp)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001224{
1225 return;
1226}
1227
1228static inline void posix_test_lock(struct file *filp, struct file_lock *fl)
1229{
1230 return;
1231}
1232
1233static inline int posix_lock_file(struct file *filp, struct file_lock *fl,
1234 struct file_lock *conflock)
1235{
1236 return -ENOLCK;
1237}
1238
NeilBrowncb03f942018-11-30 10:04:08 +11001239static inline int locks_delete_block(struct file_lock *waiter)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001240{
1241 return -ENOENT;
1242}
1243
1244static inline int vfs_test_lock(struct file *filp, struct file_lock *fl)
1245{
1246 return 0;
1247}
1248
1249static inline int vfs_lock_file(struct file *filp, unsigned int cmd,
1250 struct file_lock *fl, struct file_lock *conf)
1251{
1252 return -ENOLCK;
1253}
1254
1255static inline int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
1256{
1257 return 0;
1258}
1259
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001260static inline int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
1261{
1262 return -ENOLCK;
1263}
1264
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001265static inline int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001266{
1267 return 0;
1268}
1269
Deepa Dinamani95582b02018-05-08 19:36:02 -07001270static inline void lease_get_mtime(struct inode *inode,
1271 struct timespec64 *time)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001272{
1273 return;
1274}
1275
1276static inline int generic_setlease(struct file *filp, long arg,
Jeff Laytone6f5c782014-08-22 10:40:25 -04001277 struct file_lock **flp, void **priv)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001278{
1279 return -EINVAL;
1280}
1281
1282static inline int vfs_setlease(struct file *filp, long arg,
Jeff Laytone6f5c782014-08-22 10:40:25 -04001283 struct file_lock **lease, void **priv)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001284{
1285 return -EINVAL;
1286}
1287
Jeff Layton7448cc32015-01-16 15:05:57 -05001288static inline int lease_modify(struct file_lock *fl, int arg,
Jeff Laytonc45198e2014-09-01 07:12:07 -04001289 struct list_head *dispose)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001290{
1291 return -EINVAL;
1292}
Andrey Vagin6c8c9032015-04-16 12:49:38 -07001293
1294struct files_struct;
1295static inline void show_fd_locks(struct seq_file *f,
1296 struct file *filp, struct files_struct *files) {}
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001297#endif /* !CONFIG_FILE_LOCKING */
1298
Jeff Laytonee296d72015-07-11 06:43:03 -04001299static inline struct inode *file_inode(const struct file *f)
1300{
1301 return f->f_inode;
1302}
1303
Miklos Szeredid101a122016-03-26 16:14:37 -04001304static inline struct dentry *file_dentry(const struct file *file)
1305{
Miklos Szeredifb160432018-07-18 15:44:44 +02001306 return d_real(file->f_path.dentry, file_inode(file));
Miklos Szeredid101a122016-03-26 16:14:37 -04001307}
1308
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001309static inline int locks_lock_file_wait(struct file *filp, struct file_lock *fl)
1310{
Miklos Szeredic568d682016-09-16 12:44:20 +02001311 return locks_lock_inode_wait(locks_inode(filp), fl);
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001312}
1313
Linus Torvalds1da177e2005-04-16 15:20:36 -07001314struct fasync_struct {
Kirill Tkhai7a107c02018-04-05 14:58:06 +03001315 rwlock_t fa_lock;
Eric Dumazet989a2972010-04-14 09:55:35 +00001316 int magic;
1317 int fa_fd;
1318 struct fasync_struct *fa_next; /* singly linked list */
1319 struct file *fa_file;
1320 struct rcu_head fa_rcu;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321};
1322
1323#define FASYNC_MAGIC 0x4601
1324
1325/* SMP safe fasync helpers: */
1326extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001327extern struct fasync_struct *fasync_insert_entry(int, struct file *, struct fasync_struct **, struct fasync_struct *);
1328extern int fasync_remove_entry(struct file *, struct fasync_struct **);
1329extern struct fasync_struct *fasync_alloc(void);
1330extern void fasync_free(struct fasync_struct *);
1331
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332/* can be called from interrupts */
1333extern void kill_fasync(struct fasync_struct **, int, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334
Jeff Laytone0b93ed2014-08-22 11:27:32 -04001335extern void __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
Jiri Slaby393cc3f2017-06-13 13:35:50 +02001336extern int f_setown(struct file *filp, unsigned long arg, int force);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337extern void f_delown(struct file *filp);
Eric W. Biederman609d7fa2006-10-02 02:17:15 -07001338extern pid_t f_getown(struct file *filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339extern int send_sigurg(struct fown_struct *fown);
1340
1341/*
David Howellse462ec52017-07-17 08:45:35 +01001342 * sb->s_flags. Note that these mirror the equivalent MS_* flags where
1343 * represented in both.
1344 */
1345#define SB_RDONLY 1 /* Mount read-only */
1346#define SB_NOSUID 2 /* Ignore suid and sgid bits */
1347#define SB_NODEV 4 /* Disallow access to device special files */
1348#define SB_NOEXEC 8 /* Disallow program execution */
1349#define SB_SYNCHRONOUS 16 /* Writes are synced at once */
1350#define SB_MANDLOCK 64 /* Allow mandatory locks on an FS */
1351#define SB_DIRSYNC 128 /* Directory modifications are synchronous */
1352#define SB_NOATIME 1024 /* Do not update access times. */
1353#define SB_NODIRATIME 2048 /* Do not update directory access times */
1354#define SB_SILENT 32768
1355#define SB_POSIXACL (1<<16) /* VFS does not apply the umask */
Satya Tangirala457e7a12020-07-02 01:56:04 +00001356#define SB_INLINECRYPT (1<<17) /* Use blk-crypto for encrypted files */
David Howellse462ec52017-07-17 08:45:35 +01001357#define SB_KERNMOUNT (1<<22) /* this is a kern_mount call */
1358#define SB_I_VERSION (1<<23) /* Update inode I_version field */
1359#define SB_LAZYTIME (1<<25) /* Update the on-disk [acm]times lazily */
1360
1361/* These sb flags are internal to the kernel */
1362#define SB_SUBMOUNT (1<<26)
David Howells8d0347f2018-11-04 09:28:36 -05001363#define SB_FORCE (1<<27)
David Howellse462ec52017-07-17 08:45:35 +01001364#define SB_NOSEC (1<<28)
1365#define SB_BORN (1<<29)
1366#define SB_ACTIVE (1<<30)
1367#define SB_NOUSER (1<<31)
1368
Daniel Rosenbergc8438432020-07-08 02:12:35 -07001369/* These flags relate to encoding and casefolding */
1370#define SB_ENC_STRICT_MODE_FL (1 << 0)
1371
1372#define sb_has_strict_encoding(sb) \
1373 (sb->s_encoding_flags & SB_ENC_STRICT_MODE_FL)
1374
David Howellse462ec52017-07-17 08:45:35 +01001375/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376 * Umount options
1377 */
1378
1379#define MNT_FORCE 0x00000001 /* Attempt to forcibily umount */
1380#define MNT_DETACH 0x00000002 /* Just detach from the tree */
1381#define MNT_EXPIRE 0x00000004 /* Mark for expiry */
Miklos Szeredidb1f05b2010-02-10 12:15:53 +01001382#define UMOUNT_NOFOLLOW 0x00000008 /* Don't follow symlink on umount */
1383#define UMOUNT_UNUSED 0x80000000 /* Flag guaranteed to be unused */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384
Tejun Heo46b15ca2015-06-16 18:48:31 -04001385/* sb->s_iflags */
1386#define SB_I_CGROUPWB 0x00000001 /* cgroup-aware writeback enabled */
Eric W. Biederman90f85722015-06-29 14:42:03 -05001387#define SB_I_NOEXEC 0x00000002 /* Ignore executables on this fs */
Eric W. Biedermana2982cc2016-06-09 15:34:02 -05001388#define SB_I_NODEV 0x00000004 /* Ignore devices on this fs */
Christoph Hellwig1cb039f2020-09-24 08:51:38 +02001389#define SB_I_STABLE_WRITES 0x00000008 /* don't modify blks until WB is done */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390
Eric W. Biederman8654df42016-06-09 16:06:06 -05001391/* sb->s_iflags to limit user namespace mounts */
1392#define SB_I_USERNS_VISIBLE 0x00000010 /* fstype already mounted */
Mimi Zohar57b56ac2018-02-21 11:33:37 -05001393#define SB_I_IMA_UNVERIFIABLE_SIGNATURE 0x00000020
1394#define SB_I_UNTRUSTED_MOUNTER 0x00000040
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395
Konstantin Khlebnikov32b1924b22020-04-09 11:29:47 +03001396#define SB_I_SKIP_SYNC 0x00000100 /* Skip superblock at global sync */
1397
Jan Kara5accdf82012-06-12 16:20:34 +02001398/* Possible states of 'frozen' field */
1399enum {
1400 SB_UNFROZEN = 0, /* FS is unfrozen */
1401 SB_FREEZE_WRITE = 1, /* Writes, dir ops, ioctls frozen */
Jan Kara5accdf82012-06-12 16:20:34 +02001402 SB_FREEZE_PAGEFAULT = 2, /* Page faults stopped as well */
1403 SB_FREEZE_FS = 3, /* For internal FS use (e.g. to stop
1404 * internal threads if needed) */
1405 SB_FREEZE_COMPLETE = 4, /* ->freeze_fs finished successfully */
1406};
1407
1408#define SB_FREEZE_LEVELS (SB_FREEZE_COMPLETE - 1)
1409
1410struct sb_writers {
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001411 int frozen; /* Is sb frozen? */
1412 wait_queue_head_t wait_unfrozen; /* for get_super_thawed() */
1413 struct percpu_rw_semaphore rw_sem[SB_FREEZE_LEVELS];
Jan Kara5accdf82012-06-12 16:20:34 +02001414};
1415
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416struct super_block {
1417 struct list_head s_list; /* Keep this first */
1418 dev_t s_dev; /* search index; _not_ kdev_t */
Richard Kennedy270ba5f2010-01-26 14:12:43 +00001419 unsigned char s_blocksize_bits;
1420 unsigned long s_blocksize;
Jeff Layton42cb56a2009-09-18 13:05:53 -07001421 loff_t s_maxbytes; /* Max file size */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 struct file_system_type *s_type;
Josef 'Jeff' Sipekee9b6d62007-02-12 00:55:41 -08001423 const struct super_operations *s_op;
Alexey Dobriyan61e225d2009-09-21 17:01:08 -07001424 const struct dquot_operations *dq_op;
Alexey Dobriyan0d54b212009-09-21 17:01:09 -07001425 const struct quotactl_ops *s_qcop;
Christoph Hellwig39655162007-10-21 16:42:17 -07001426 const struct export_operations *s_export_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427 unsigned long s_flags;
Tejun Heo46b15ca2015-06-16 18:48:31 -04001428 unsigned long s_iflags; /* internal SB_I_* flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429 unsigned long s_magic;
1430 struct dentry *s_root;
1431 struct rw_semaphore s_umount;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432 int s_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433 atomic_t s_active;
Alexey Dobriyan50462062006-09-29 02:00:01 -07001434#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435 void *s_security;
Alexey Dobriyan50462062006-09-29 02:00:01 -07001436#endif
Stephen Hemmingerbb435452010-05-13 17:53:14 -07001437 const struct xattr_handler **s_xattr;
Chandan Rajendra643fa962018-12-12 15:20:12 +05301438#ifdef CONFIG_FS_ENCRYPTION
Jaegeuk Kim0b81d072015-05-15 16:26:10 -07001439 const struct fscrypt_operations *s_cop;
Eric Biggers22d94f42019-08-04 19:35:46 -07001440 struct key *s_master_keys; /* master crypto keys in use */
Eric Biggersbbbc3fb2018-04-30 15:51:35 -07001441#endif
Eric Biggers5585f2a2019-07-22 09:26:21 -07001442#ifdef CONFIG_FS_VERITY
1443 const struct fsverity_operations *s_vop;
1444#endif
Daniel Rosenbergc8438432020-07-08 02:12:35 -07001445#ifdef CONFIG_UNICODE
1446 struct unicode_map *s_encoding;
1447 __u16 s_encoding_flags;
1448#endif
NeilBrownf1ee6162017-12-21 09:45:40 +11001449 struct hlist_bl_head s_roots; /* alternate root dentries for NFS */
Miklos Szeredi39f7c4d2011-11-21 12:11:30 +01001450 struct list_head s_mounts; /* list of mounts; _not_ for fs use */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451 struct block_device *s_bdev;
Jens Axboe32a88aa2009-09-16 15:02:33 +02001452 struct backing_dev_info *s_bdi;
David Howellsacaebfd2007-05-10 22:51:50 -07001453 struct mtd_info *s_mtd;
Al Viroa5166162011-12-12 22:53:00 -05001454 struct hlist_node s_instances;
Jan Kara2c5f6482014-09-30 10:43:09 +02001455 unsigned int s_quota_types; /* Bitmask of supported quota types */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456 struct quota_info s_dquot; /* Diskquota specific options */
1457
Jan Kara5accdf82012-06-12 16:20:34 +02001458 struct sb_writers s_writers;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001459
Amir Goldstein99c228a2018-10-18 14:22:55 +03001460 /*
1461 * Keep s_fs_info, s_time_gran, s_fsnotify_mask, and
1462 * s_fsnotify_marks together for cache efficiency. They are frequently
1463 * accessed and rarely modified.
1464 */
1465 void *s_fs_info; /* Filesystem private info */
1466
1467 /* Granularity of c/m/atime in ns (cannot be worse than a second) */
1468 u32 s_time_gran;
Deepa Dinamani188d20bc2018-01-21 18:04:23 -08001469 /* Time limits for c/m/atime in seconds */
1470 time64_t s_time_min;
1471 time64_t s_time_max;
Amir Goldstein99c228a2018-10-18 14:22:55 +03001472#ifdef CONFIG_FSNOTIFY
1473 __u32 s_fsnotify_mask;
1474 struct fsnotify_mark_connector __rcu *s_fsnotify_marks;
1475#endif
1476
Christoph Hellwig85787092017-05-10 15:06:33 +02001477 char s_id[32]; /* Informational name */
1478 uuid_t s_uuid; /* UUID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479
Al Viro8de52772012-02-06 12:45:27 -05001480 unsigned int s_max_links;
Al Viro30c40d22008-02-22 19:50:45 -05001481 fmode_t s_mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482
1483 /*
1484 * The next field is for VFS *only*. No filesystems have any business
1485 * even looking at it. You had been warned.
1486 */
Arjan van de Vena11f3a02006-03-23 03:00:33 -08001487 struct mutex s_vfs_rename_mutex; /* Kludge */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488
Miklos Szeredi79c0b2d2007-05-08 00:25:43 -07001489 /*
1490 * Filesystem subtype. If non-empty the filesystem type field
1491 * in /proc/mounts will be "type.subtype"
1492 */
Al Viroa0c9a8b2018-11-04 07:18:51 -05001493 const char *s_subtype;
Miklos Szeredib3b304a2008-02-08 04:21:35 -08001494
Al Viroc8aebb02010-12-18 10:22:30 -05001495 const struct dentry_operations *s_d_op; /* default d_op for dentries */
Dan Magenheimer9fdfdcf2011-05-26 10:01:19 -06001496
1497 /*
1498 * Saved pool identifier for cleancache (-1 means none)
1499 */
1500 int cleancache_poolid;
Dave Chinnerb0d40c92011-07-08 14:14:42 +10001501
1502 struct shrinker s_shrink; /* per-sb shrinker handle */
Miklos Szeredi4ed5e82f2011-11-21 12:11:31 +01001503
Miklos Szeredi7ada4db2011-11-21 12:11:32 +01001504 /* Number of inodes with nlink == 0 but still referenced */
1505 atomic_long_t s_remove_count;
1506
Jan Kara721fb6f2018-10-17 13:07:05 +02001507 /* Pending fsnotify inode refs */
1508 atomic_long_t s_fsnotify_inode_refs;
1509
Miklos Szeredi4ed5e82f2011-11-21 12:11:31 +01001510 /* Being remounted read-only */
1511 int s_readonly_remount;
Christoph Hellwig7b7a8662013-09-04 15:04:39 +02001512
Jeff Layton735e4ae2020-06-01 21:45:36 -07001513 /* per-sb errseq_t for reporting writeback errors via syncfs */
1514 errseq_t s_wb_err;
1515
Christoph Hellwig7b7a8662013-09-04 15:04:39 +02001516 /* AIO completions deferred from interrupt context */
1517 struct workqueue_struct *s_dio_done_wq;
Al Viro215752f2014-08-07 06:23:41 -04001518 struct hlist_head s_pins;
Dave Chinnerf6041562013-08-28 10:18:00 +10001519
1520 /*
Eric W. Biederman6e4eab52016-05-24 09:29:01 -05001521 * Owning user namespace and default context in which to
1522 * interpret filesystem uids, gids, quotas, device nodes,
1523 * xattrs and security labels.
1524 */
1525 struct user_namespace *s_user_ns;
1526
1527 /*
Waiman Long7d10f702019-01-30 13:52:37 -05001528 * The list_lru structure is essentially just a pointer to a table
1529 * of per-node lru lists, each of which has its own spinlock.
1530 * There is no need to put them into separate cachelines.
Dave Chinnerf6041562013-08-28 10:18:00 +10001531 */
Waiman Long7d10f702019-01-30 13:52:37 -05001532 struct list_lru s_dentry_lru;
1533 struct list_lru s_inode_lru;
Al Viroe2fec7c2013-10-04 17:06:56 -04001534 struct rcu_head rcu;
Oleg Nesterov853b39a2015-07-22 20:21:13 +02001535 struct work_struct destroy_work;
Miklos Szeredi69c433e2014-10-24 00:14:39 +02001536
Dave Chinnere97fedb2015-03-04 13:40:00 -05001537 struct mutex s_sync_lock; /* sync serialisation lock */
Miklos Szeredi69c433e2014-10-24 00:14:39 +02001538
1539 /*
1540 * Indicates how deep in a filesystem stack this SB is
1541 */
1542 int s_stack_depth;
Dave Chinner74278da2015-03-04 12:37:22 -05001543
1544 /* s_inode_list_lock protects s_inodes */
1545 spinlock_t s_inode_list_lock ____cacheline_aligned_in_smp;
1546 struct list_head s_inodes; /* all inodes */
Dave Chinner6c60d2b2016-07-26 15:21:50 -07001547
1548 spinlock_t s_inode_wblist_lock;
1549 struct list_head s_inodes_wb; /* writeback inodes */
Kees Cook3859a272016-10-28 01:22:25 -07001550} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551
Seth Forshee81754352014-12-11 10:15:45 -06001552/* Helper functions so that in most cases filesystems will
1553 * not need to deal directly with kuid_t and kgid_t and can
1554 * instead deal with the raw numeric values that are stored
1555 * in the filesystem.
1556 */
1557static inline uid_t i_uid_read(const struct inode *inode)
1558{
1559 return from_kuid(inode->i_sb->s_user_ns, inode->i_uid);
1560}
1561
1562static inline gid_t i_gid_read(const struct inode *inode)
1563{
1564 return from_kgid(inode->i_sb->s_user_ns, inode->i_gid);
1565}
1566
1567static inline void i_uid_write(struct inode *inode, uid_t uid)
1568{
1569 inode->i_uid = make_kuid(inode->i_sb->s_user_ns, uid);
1570}
1571
1572static inline void i_gid_write(struct inode *inode, gid_t gid)
1573{
1574 inode->i_gid = make_kgid(inode->i_sb->s_user_ns, gid);
1575}
1576
Deepa Dinamani95582b02018-05-08 19:36:02 -07001577extern struct timespec64 current_time(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578
1579/*
1580 * Snapshotting support.
1581 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582
Darrick J. Wong9b852342020-11-10 16:50:21 -08001583/*
1584 * These are internal functions, please use sb_start_{write,pagefault,intwrite}
1585 * instead.
1586 */
1587static inline void __sb_end_write(struct super_block *sb, int level)
1588{
1589 percpu_up_read(sb->s_writers.rw_sem + level-1);
1590}
1591
1592static inline void __sb_start_write(struct super_block *sb, int level)
1593{
1594 percpu_down_read(sb->s_writers.rw_sem + level - 1);
1595}
1596
1597static inline bool __sb_start_write_trylock(struct super_block *sb, int level)
1598{
1599 return percpu_down_read_trylock(sb->s_writers.rw_sem + level - 1);
1600}
Jan Kara5accdf82012-06-12 16:20:34 +02001601
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{
Darrick J. Wong8a3c84b2020-11-10 16:50:21 -08001664 __sb_start_write(sb, SB_FREEZE_WRITE);
Jan Kara5accdf82012-06-12 16:20:34 +02001665}
1666
Darrick J. Wong8a3c84b2020-11-10 16:50:21 -08001667static inline bool sb_start_write_trylock(struct super_block *sb)
Jan Kara5accdf82012-06-12 16:20:34 +02001668{
Darrick J. Wong8a3c84b2020-11-10 16:50:21 -08001669 return __sb_start_write_trylock(sb, SB_FREEZE_WRITE);
Jan Kara5accdf82012-06-12 16:20:34 +02001670}
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{
Darrick J. Wong8a3c84b2020-11-10 16:50:21 -08001693 __sb_start_write(sb, SB_FREEZE_PAGEFAULT);
Jan Kara5accdf82012-06-12 16:20:34 +02001694}
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{
Darrick J. Wong8a3c84b2020-11-10 16:50:21 -08001711 __sb_start_write(sb, SB_FREEZE_FS);
Jan Kara5accdf82012-06-12 16:20:34 +02001712}
1713
Darrick J. Wong8a3c84b2020-11-10 16:50:21 -08001714static inline bool sb_start_intwrite_trylock(struct super_block *sb)
Amir Goldstein0c8e3fe2018-05-13 22:40:30 -04001715{
Darrick J. Wong8a3c84b2020-11-10 16:50:21 -08001716 return __sb_start_write_trylock(sb, SB_FREEZE_FS);
Amir Goldstein0c8e3fe2018-05-13 22:40:30 -04001717}
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
Christoph Hellwigc04011f2020-07-14 08:47:43 +02001746int vfs_fchown(struct file *file, uid_t user, gid_t group);
Christoph Hellwig9e96c8c2020-07-14 08:55:05 +02001747int vfs_fchmod(struct file *file, umode_t mode);
Christoph Hellwigfd5ad302020-07-15 08:19:55 +02001748int vfs_utimes(const struct path *path, struct timespec64 *times);
Christoph Hellwigc04011f2020-07-14 08:47:43 +02001749
Miklos Szeredi9df67022018-07-18 15:44:40 +02001750extern long vfs_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
1751
Arnd Bergmann2952db02018-09-11 16:55:03 +02001752#ifdef CONFIG_COMPAT
1753extern long compat_ptr_ioctl(struct file *file, unsigned int cmd,
1754 unsigned long arg);
1755#else
1756#define compat_ptr_ioctl NULL
1757#endif
1758
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759/*
Christoph Hellwig8c744fb2005-11-08 21:35:04 -08001760 * VFS file helper functions.
1761 */
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03001762extern void inode_init_owner(struct inode *inode, const struct inode *dir,
Al Viro62bb1092011-07-24 23:20:18 -04001763 umode_t mode);
Eric W. Biedermana2982cc2016-06-09 15:34:02 -05001764extern bool may_open_dev(const struct path *path);
Mark Fashehc4b929b2008-10-08 19:44:18 -04001765
1766/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767 * This is the "filldir" function type, used by readdir() to let
1768 * the kernel specify what kind of dirent layout it wants to have.
1769 * This allows the kernel to read directories into kernel space or
1770 * to have different dirent layouts depending on the binary type.
1771 */
Miklos Szerediac7576f2014-10-30 17:37:34 +01001772struct dir_context;
1773typedef int (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64,
1774 unsigned);
1775
Al Viro5c0ba4e2013-05-15 13:52:59 -04001776struct dir_context {
David Howellsa09acf42018-04-09 21:12:30 +01001777 filldir_t actor;
Al Virobb6f6192013-05-15 18:49:12 -04001778 loff_t pos;
Al Viro5c0ba4e2013-05-15 13:52:59 -04001779};
Al Virobb6f6192013-05-15 18:49:12 -04001780
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01001781/*
1782 * These flags let !MMU mmap() govern direct device mapping vs immediate
1783 * copying more easily for MAP_PRIVATE, especially for ROM filesystems.
1784 *
1785 * NOMMU_MAP_COPY: Copy can be mapped (MAP_PRIVATE)
1786 * NOMMU_MAP_DIRECT: Can be mapped directly (MAP_SHARED)
1787 * NOMMU_MAP_READ: Can be mapped for reading
1788 * NOMMU_MAP_WRITE: Can be mapped for writing
1789 * NOMMU_MAP_EXEC: Can be mapped for execution
1790 */
1791#define NOMMU_MAP_COPY 0x00000001
1792#define NOMMU_MAP_DIRECT 0x00000008
1793#define NOMMU_MAP_READ VM_MAYREAD
1794#define NOMMU_MAP_WRITE VM_MAYWRITE
1795#define NOMMU_MAP_EXEC VM_MAYEXEC
1796
1797#define NOMMU_VMFLAGS \
1798 (NOMMU_MAP_READ | NOMMU_MAP_WRITE | NOMMU_MAP_EXEC)
1799
Darrick J. Wong2e5dfc92018-10-30 10:41:21 +11001800/*
1801 * These flags control the behavior of the remap_file_range function pointer.
1802 * If it is called with len == 0 that means "remap to end of source file".
Mauro Carvalho Chehab5c437fa2019-06-07 15:54:35 -03001803 * See Documentation/filesystems/vfs.rst for more details about this call.
Darrick J. Wong2e5dfc92018-10-30 10:41:21 +11001804 *
1805 * REMAP_FILE_DEDUP: only remap if contents identical (i.e. deduplicate)
Darrick J. Wongeca36542018-10-30 10:42:10 +11001806 * REMAP_FILE_CAN_SHORTEN: caller can handle a shortened request
Darrick J. Wong2e5dfc92018-10-30 10:41:21 +11001807 */
1808#define REMAP_FILE_DEDUP (1 << 0)
Darrick J. Wongeca36542018-10-30 10:42:10 +11001809#define REMAP_FILE_CAN_SHORTEN (1 << 1)
Darrick J. Wong2e5dfc92018-10-30 10:41:21 +11001810
1811/*
1812 * These flags signal that the caller is ok with altering various aspects of
1813 * the behavior of the remap operation. The changes must be made by the
1814 * implementation; the vfs remap helper functions can take advantage of them.
1815 * Flags in this category exist to preserve the quirky behavior of the hoisted
1816 * btrfs clone/dedupe ioctls.
Darrick J. Wong2e5dfc92018-10-30 10:41:21 +11001817 */
Darrick J. Wongeca36542018-10-30 10:42:10 +11001818#define REMAP_FILE_ADVISORY (REMAP_FILE_CAN_SHORTEN)
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01001819
Al Viro293bc982014-02-11 18:37:41 -05001820struct iov_iter;
1821
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822struct file_operations {
1823 struct module *owner;
1824 loff_t (*llseek) (struct file *, loff_t, int);
1825 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
Al Viro293bc982014-02-11 18:37:41 -05001827 ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
1828 ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
Christoph Hellwigfb7e1602018-11-22 16:37:38 +01001829 int (*iopoll)(struct kiocb *kiocb, bool spin);
Al Virobb6f6192013-05-15 18:49:12 -04001830 int (*iterate) (struct file *, struct dir_context *);
Al Viro61922692016-04-20 23:08:32 -04001831 int (*iterate_shared) (struct file *, struct dir_context *);
Al Viroa3f86832017-07-02 22:22:01 -04001832 __poll_t (*poll) (struct file *, struct poll_table_struct *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001833 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
1834 long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
1835 int (*mmap) (struct file *, struct vm_area_struct *);
Dan Williams1c972592017-11-01 16:36:30 +01001836 unsigned long mmap_supported_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001837 int (*open) (struct inode *, struct file *);
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07001838 int (*flush) (struct file *, fl_owner_t id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001839 int (*release) (struct inode *, struct file *);
Josef Bacik02c24a82011-07-16 20:44:56 -04001840 int (*fsync) (struct file *, loff_t, loff_t, int datasync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841 int (*fasync) (int, struct file *, int);
1842 int (*lock) (struct file *, int, struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843 ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
1844 unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
1845 int (*check_flags)(int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001846 int (*flock) (struct file *, int, struct file_lock *);
Jens Axboecbb7e572006-04-11 14:57:50 +02001847 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int);
1848 ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int);
Jeff Laytone6f5c782014-08-22 10:40:25 -04001849 int (*setlease)(struct file *, long, struct file_lock **, void **);
Christoph Hellwig2fe17c12011-01-14 13:07:43 +01001850 long (*fallocate)(struct file *file, int mode, loff_t offset,
1851 loff_t len);
Joe Perchesa3816ab2014-09-29 16:08:25 -07001852 void (*show_fdinfo)(struct seq_file *m, struct file *f);
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01001853#ifndef CONFIG_MMU
1854 unsigned (*mmap_capabilities)(struct file *);
1855#endif
Christoph Hellwig04b38d62015-12-03 12:59:50 +01001856 ssize_t (*copy_file_range)(struct file *, loff_t, struct file *,
1857 loff_t, size_t, unsigned int);
Darrick J. Wong42ec3d42018-10-30 10:41:49 +11001858 loff_t (*remap_file_range)(struct file *file_in, loff_t pos_in,
1859 struct file *file_out, loff_t pos_out,
1860 loff_t len, unsigned int remap_flags);
Amir Goldstein45cd0fa2018-08-27 15:56:02 +03001861 int (*fadvise)(struct file *, loff_t, loff_t, int);
Kees Cook3859a272016-10-28 01:22:25 -07001862} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863
1864struct inode_operations {
Al Viro00cd8dd2012-06-10 17:13:09 -04001865 struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
Al Virofceef392015-12-29 15:58:39 -05001866 const char * (*get_link) (struct dentry *, struct inode *, struct delayed_call *);
Al Viro10556cb22011-06-20 19:28:19 -04001867 int (*permission) (struct inode *, int);
Christoph Hellwig4e34e712011-07-23 17:37:31 +02001868 struct posix_acl * (*get_acl)(struct inode *, int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001869
1870 int (*readlink) (struct dentry *, char __user *,int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001871
Al Viroebfc3b42012-06-10 18:05:36 -04001872 int (*create) (struct inode *,struct dentry *, umode_t, bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001873 int (*link) (struct dentry *,struct inode *,struct dentry *);
1874 int (*unlink) (struct inode *,struct dentry *);
1875 int (*symlink) (struct inode *,struct dentry *,const char *);
Al Viro18bb1db2011-07-26 01:41:39 -04001876 int (*mkdir) (struct inode *,struct dentry *,umode_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877 int (*rmdir) (struct inode *,struct dentry *);
Al Viro1a67aaf2011-07-26 01:52:52 -04001878 int (*mknod) (struct inode *,struct dentry *,umode_t,dev_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879 int (*rename) (struct inode *, struct dentry *,
Miklos Szeredi520c8b12014-04-01 17:08:42 +02001880 struct inode *, struct dentry *, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001881 int (*setattr) (struct dentry *, struct iattr *);
David Howellsa528d352017-01-31 16:46:22 +00001882 int (*getattr) (const struct path *, struct kstat *, u32, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001883 ssize_t (*listxattr) (struct dentry *, char *, size_t);
Mark Fashehc4b929b2008-10-08 19:44:18 -04001884 int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
1885 u64 len);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001886 int (*update_time)(struct inode *, struct timespec64 *, int);
Al Virod9585272012-06-22 12:39:14 +04001887 int (*atomic_open)(struct inode *, struct dentry *,
Al Viro30d90492012-06-22 12:40:19 +04001888 struct file *, unsigned open_flag,
Al Viro44907d72018-06-08 13:32:02 -04001889 umode_t create_mode);
Al Viro60545d02013-06-07 01:20:27 -04001890 int (*tmpfile) (struct inode *, struct dentry *, umode_t);
Christoph Hellwig893d46e2013-12-20 05:16:39 -08001891 int (*set_acl)(struct inode *, struct posix_acl *, int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001892} ____cacheline_aligned;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893
Miklos Szeredibb7462b2017-02-20 16:51:23 +01001894static inline ssize_t call_read_iter(struct file *file, struct kiocb *kio,
1895 struct iov_iter *iter)
1896{
1897 return file->f_op->read_iter(kio, iter);
1898}
1899
1900static inline ssize_t call_write_iter(struct file *file, struct kiocb *kio,
1901 struct iov_iter *iter)
1902{
1903 return file->f_op->write_iter(kio, iter);
1904}
1905
Miklos Szeredif74ac012017-02-20 16:51:23 +01001906static inline int call_mmap(struct file *file, struct vm_area_struct *vma)
1907{
1908 return file->f_op->mmap(file, vma);
1909}
1910
Linus Torvalds1da177e2005-04-16 15:20:36 -07001911extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
1912extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
Zach Brown29732932015-11-10 16:53:30 -05001913extern ssize_t vfs_copy_file_range(struct file *, loff_t , struct file *,
1914 loff_t, size_t, unsigned int);
Dave Chinnerf16acc92019-06-05 08:04:47 -07001915extern ssize_t generic_copy_file_range(struct file *file_in, loff_t pos_in,
1916 struct file *file_out, loff_t pos_out,
1917 size_t len, unsigned int flags);
Darrick J. Wonga83ab012018-10-30 10:41:08 +11001918extern int generic_remap_file_range_prep(struct file *file_in, loff_t pos_in,
1919 struct file *file_out, loff_t pos_out,
Darrick J. Wong42ec3d42018-10-30 10:41:49 +11001920 loff_t *count,
1921 unsigned int remap_flags);
1922extern loff_t do_clone_file_range(struct file *file_in, loff_t pos_in,
1923 struct file *file_out, loff_t pos_out,
Darrick J. Wong452ce652018-10-30 10:41:56 +11001924 loff_t len, unsigned int remap_flags);
Darrick J. Wong42ec3d42018-10-30 10:41:49 +11001925extern loff_t vfs_clone_file_range(struct file *file_in, loff_t pos_in,
1926 struct file *file_out, loff_t pos_out,
Darrick J. Wong452ce652018-10-30 10:41:56 +11001927 loff_t len, unsigned int remap_flags);
Darrick J. Wong54dbc152015-12-19 00:55:59 -08001928extern int vfs_dedupe_file_range(struct file *file,
1929 struct file_dedupe_range *same);
Darrick J. Wong42ec3d42018-10-30 10:41:49 +11001930extern loff_t vfs_dedupe_file_range_one(struct file *src_file, loff_t src_pos,
1931 struct file *dst_file, loff_t dst_pos,
Darrick J. Wongdf365832018-10-30 10:42:03 +11001932 loff_t len, unsigned int remap_flags);
Miklos Szeredif1825362018-07-18 15:44:40 +02001933
Linus Torvalds1da177e2005-04-16 15:20:36 -07001934
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935struct super_operations {
1936 struct inode *(*alloc_inode)(struct super_block *sb);
1937 void (*destroy_inode)(struct inode *);
Al Virofdb0da82019-04-10 14:43:44 -04001938 void (*free_inode)(struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939
Christoph Hellwigaa385722011-05-27 06:53:02 -04001940 void (*dirty_inode) (struct inode *, int flags);
Christoph Hellwiga9185b42010-03-05 09:21:37 +01001941 int (*write_inode) (struct inode *, struct writeback_control *wbc);
Al Viro45321ac2010-06-07 13:43:19 -04001942 int (*drop_inode) (struct inode *);
Al Virobe7ce412010-06-04 19:40:39 -04001943 void (*evict_inode) (struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944 void (*put_super) (struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001945 int (*sync_fs)(struct super_block *sb, int wait);
Benjamin Marzinski48b6bca2014-11-13 20:42:03 -06001946 int (*freeze_super) (struct super_block *);
Takashi Satoc4be0c12009-01-09 16:40:58 -08001947 int (*freeze_fs) (struct super_block *);
Benjamin Marzinski48b6bca2014-11-13 20:42:03 -06001948 int (*thaw_super) (struct super_block *);
Takashi Satoc4be0c12009-01-09 16:40:58 -08001949 int (*unfreeze_fs) (struct super_block *);
David Howells726c3342006-06-23 02:02:58 -07001950 int (*statfs) (struct dentry *, struct kstatfs *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001951 int (*remount_fs) (struct super_block *, int *, char *);
Al Viro42faad92008-04-24 07:21:56 -04001952 void (*umount_begin) (struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953
Al Viro34c80b12011-12-08 21:32:45 -05001954 int (*show_options)(struct seq_file *, struct dentry *);
Al Virod861c632011-12-08 21:32:45 -05001955 int (*show_devname)(struct seq_file *, struct dentry *);
Al Viroa6322de2011-12-08 21:37:57 -05001956 int (*show_path)(struct seq_file *, struct dentry *);
Al Viro64132372011-12-08 20:51:13 -05001957 int (*show_stats)(struct seq_file *, struct dentry *);
Alexey Dobriyan0e51a722006-09-29 01:59:56 -07001958#ifdef CONFIG_QUOTA
Linus Torvalds1da177e2005-04-16 15:20:36 -07001959 ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
1960 ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
Jan Kara2d0fa462014-09-25 16:36:14 +02001961 struct dquot **(*get_dquots)(struct inode *);
Alexey Dobriyan0e51a722006-09-29 01:59:56 -07001962#endif
Theodore Ts'o87d8fe12009-01-03 09:47:09 -05001963 int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
Vladimir Davydov4101b622015-02-12 14:58:51 -08001964 long (*nr_cached_objects)(struct super_block *,
1965 struct shrink_control *);
1966 long (*free_cached_objects)(struct super_block *,
1967 struct shrink_control *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001968};
1969
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001970/*
David Howellsbbc10962012-10-15 16:40:35 +01001971 * Inode flags - they have no relation to superblock flags now
1972 */
Eric Biggers6414e9b2020-07-12 20:09:52 -07001973#define S_SYNC (1 << 0) /* Writes are synced at once */
1974#define S_NOATIME (1 << 1) /* Do not update access times */
1975#define S_APPEND (1 << 2) /* Append-only file */
1976#define S_IMMUTABLE (1 << 3) /* Immutable file */
1977#define S_DEAD (1 << 4) /* removed, but still open directory */
1978#define S_NOQUOTA (1 << 5) /* Inode is not counted to quota */
1979#define S_DIRSYNC (1 << 6) /* Directory modifications are synchronous */
1980#define S_NOCMTIME (1 << 7) /* Do not update file c/mtime */
1981#define S_SWAPFILE (1 << 8) /* Do not truncate: swapon got its bmaps */
1982#define S_PRIVATE (1 << 9) /* Inode is fs-internal */
1983#define S_IMA (1 << 10) /* Inode has an associated IMA struct */
1984#define S_AUTOMOUNT (1 << 11) /* Automount/referral quasi-directory */
1985#define S_NOSEC (1 << 12) /* no suid or xattr security attributes */
Matthew Wilcox6cd176a2015-02-16 15:59:25 -08001986#ifdef CONFIG_FS_DAX
Eric Biggers6414e9b2020-07-12 20:09:52 -07001987#define S_DAX (1 << 13) /* Direct Access, avoiding the page cache */
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08001988#else
Eric Biggers6414e9b2020-07-12 20:09:52 -07001989#define S_DAX 0 /* Make all the DAX code disappear */
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08001990#endif
Eric Biggers6414e9b2020-07-12 20:09:52 -07001991#define S_ENCRYPTED (1 << 14) /* Encrypted file (using fs/crypto/) */
1992#define S_CASEFOLD (1 << 15) /* Casefolded file */
1993#define S_VERITY (1 << 16) /* Verity file (using fs/verity/) */
David Howellsbbc10962012-10-15 16:40:35 +01001994
1995/*
1996 * Note that nosuid etc flags are inode-specific: setting some file-system
1997 * flags just means all the inodes inherit those flags by default. It might be
1998 * possible to override it selectively if you really wanted to with some
1999 * ioctl() that is not currently implemented.
2000 *
David Howellse462ec52017-07-17 08:45:35 +01002001 * Exception: SB_RDONLY is always applied to the entire file system.
David Howellsbbc10962012-10-15 16:40:35 +01002002 *
2003 * Unfortunately, it is possible to change a filesystems flags with it mounted
2004 * with files in use. This means that all of the inodes will not have their
2005 * i_flags updated. Hence, i_flags no longer inherit the superblock mount
2006 * flags, so these have to be checked separately. -- rmk@arm.uk.linux.org
2007 */
2008#define __IS_FLG(inode, flg) ((inode)->i_sb->s_flags & (flg))
2009
Linus Torvalds1751e8a2017-11-27 13:05:09 -08002010static inline bool sb_rdonly(const struct super_block *sb) { return sb->s_flags & SB_RDONLY; }
David Howells94e92e72017-07-17 08:45:34 +01002011#define IS_RDONLY(inode) sb_rdonly((inode)->i_sb)
David Howellse462ec52017-07-17 08:45:35 +01002012#define IS_SYNC(inode) (__IS_FLG(inode, SB_SYNCHRONOUS) || \
David Howellsbbc10962012-10-15 16:40:35 +01002013 ((inode)->i_flags & S_SYNC))
David Howellse462ec52017-07-17 08:45:35 +01002014#define IS_DIRSYNC(inode) (__IS_FLG(inode, SB_SYNCHRONOUS|SB_DIRSYNC) || \
David Howellsbbc10962012-10-15 16:40:35 +01002015 ((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
David Howellse462ec52017-07-17 08:45:35 +01002016#define IS_MANDLOCK(inode) __IS_FLG(inode, SB_MANDLOCK)
2017#define IS_NOATIME(inode) __IS_FLG(inode, SB_RDONLY|SB_NOATIME)
2018#define IS_I_VERSION(inode) __IS_FLG(inode, SB_I_VERSION)
David Howellsbbc10962012-10-15 16:40:35 +01002019
2020#define IS_NOQUOTA(inode) ((inode)->i_flags & S_NOQUOTA)
2021#define IS_APPEND(inode) ((inode)->i_flags & S_APPEND)
2022#define IS_IMMUTABLE(inode) ((inode)->i_flags & S_IMMUTABLE)
David Howellse462ec52017-07-17 08:45:35 +01002023#define IS_POSIXACL(inode) __IS_FLG(inode, SB_POSIXACL)
David Howellsbbc10962012-10-15 16:40:35 +01002024
2025#define IS_DEADDIR(inode) ((inode)->i_flags & S_DEAD)
2026#define IS_NOCMTIME(inode) ((inode)->i_flags & S_NOCMTIME)
2027#define IS_SWAPFILE(inode) ((inode)->i_flags & S_SWAPFILE)
2028#define IS_PRIVATE(inode) ((inode)->i_flags & S_PRIVATE)
2029#define IS_IMA(inode) ((inode)->i_flags & S_IMA)
2030#define IS_AUTOMOUNT(inode) ((inode)->i_flags & S_AUTOMOUNT)
2031#define IS_NOSEC(inode) ((inode)->i_flags & S_NOSEC)
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002032#define IS_DAX(inode) ((inode)->i_flags & S_DAX)
Eric Biggers2ee6a572017-10-09 12:15:35 -07002033#define IS_ENCRYPTED(inode) ((inode)->i_flags & S_ENCRYPTED)
Gabriel Krisman Bertazib886ee32019-04-25 14:12:08 -04002034#define IS_CASEFOLDED(inode) ((inode)->i_flags & S_CASEFOLD)
Eric Biggers5585f2a2019-07-22 09:26:21 -07002035#define IS_VERITY(inode) ((inode)->i_flags & S_VERITY)
David Howellsbbc10962012-10-15 16:40:35 +01002036
Miklos Szeredi787fb6b2014-10-24 00:14:36 +02002037#define IS_WHITEOUT(inode) (S_ISCHR(inode->i_mode) && \
2038 (inode)->i_rdev == WHITEOUT_DEV)
2039
Eric W. Biederman0bd23d092016-06-29 14:54:46 -05002040static inline bool HAS_UNMAPPED_ID(struct inode *inode)
2041{
2042 return !uid_valid(inode->i_uid) || !gid_valid(inode->i_gid);
2043}
2044
Jens Axboec75b1d92017-06-27 11:47:04 -06002045static inline enum rw_hint file_write_hint(struct file *file)
2046{
2047 if (file->f_write_hint != WRITE_LIFE_NOT_SET)
2048 return file->f_write_hint;
2049
2050 return file_inode(file)->i_write_hint;
2051}
2052
2053static inline int iocb_flags(struct file *file);
2054
Adam Manzanaresfc287242018-05-22 10:52:18 -07002055static inline u16 ki_hint_validate(enum rw_hint hint)
2056{
2057 typeof(((struct kiocb *)0)->ki_hint) max_hint = -1;
2058
2059 if (hint <= max_hint)
2060 return hint;
2061 return 0;
2062}
2063
Jens Axboec75b1d92017-06-27 11:47:04 -06002064static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
2065{
2066 *kiocb = (struct kiocb) {
2067 .ki_filp = filp,
2068 .ki_flags = iocb_flags(filp),
Adam Manzanaresfc287242018-05-22 10:52:18 -07002069 .ki_hint = ki_hint_validate(file_write_hint(filp)),
Damien Le Moal20578bd2018-11-20 10:52:38 +09002070 .ki_ioprio = get_current_ioprio(),
Jens Axboec75b1d92017-06-27 11:47:04 -06002071 };
2072}
2073
Jiufei Xue5dcdc432019-11-20 17:45:25 +08002074static inline void kiocb_clone(struct kiocb *kiocb, struct kiocb *kiocb_src,
2075 struct file *filp)
2076{
2077 *kiocb = (struct kiocb) {
2078 .ki_filp = filp,
2079 .ki_flags = kiocb_src->ki_flags,
2080 .ki_hint = kiocb_src->ki_hint,
2081 .ki_ioprio = kiocb_src->ki_ioprio,
2082 .ki_pos = kiocb_src->ki_pos,
2083 };
2084}
2085
David Howellsbbc10962012-10-15 16:40:35 +01002086/*
Dave Chinner250df6e2011-03-22 22:23:36 +11002087 * Inode state bits. Protected by inode->i_lock
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002088 *
2089 * Three bits determine the dirty state of the inode, I_DIRTY_SYNC,
2090 * I_DIRTY_DATASYNC and I_DIRTY_PAGES.
2091 *
2092 * Four bits define the lifetime of an inode. Initially, inodes are I_NEW,
2093 * until that flag is cleared. I_WILL_FREE, I_FREEING and I_CLEAR are set at
2094 * various stages of removing an inode.
2095 *
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002096 * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002097 *
Joern Engele7ca2d42008-02-06 01:36:59 -08002098 * I_DIRTY_SYNC Inode is dirty, but doesn't have to be written on
2099 * fdatasync(). i_atime is the usual cause.
Jan Kara000cb482008-02-14 19:31:32 -08002100 * I_DIRTY_DATASYNC Data-related inode changes pending. We keep track of
2101 * these changes separately from I_DIRTY_SYNC so that we
2102 * don't have to write inode on fdatasync() when only
2103 * mtime has changed in it.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002104 * I_DIRTY_PAGES Inode has dirty pages. Inode itself may be clean.
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002105 * I_NEW Serves as both a mutex and completion notification.
2106 * New inodes set I_NEW. If two processes both create
2107 * the same inode, one of them will release its inode and
2108 * wait for I_NEW to be released before returning.
2109 * Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can
2110 * also cause waiting on I_NEW, without I_NEW actually
2111 * being set. find_inode() uses this to prevent returning
2112 * nearly-dead inodes.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002113 * I_WILL_FREE Must be set when calling write_inode_now() if i_count
2114 * is zero. I_FREEING must be set when I_WILL_FREE is
2115 * cleared.
2116 * I_FREEING Set when inode is about to be freed but still has dirty
2117 * pages or buffers attached or the inode itself is still
2118 * dirty.
Jan Karadbd57682012-05-03 14:48:02 +02002119 * I_CLEAR Added by clear_inode(). In this state the inode is
2120 * clean and can be destroyed. Inode keeps I_FREEING.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002121 *
2122 * Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are
2123 * prohibited for many purposes. iget() must wait for
2124 * the inode to be completely released, then create it
2125 * anew. Other functions will just ignore such inodes,
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002126 * if appropriate. I_NEW is used for waiting.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002127 *
Jan Kara169ebd92012-05-03 14:48:03 +02002128 * I_SYNC Writeback of inode is running. The bit is set during
2129 * data writeback, and cleared with a wakeup on the bit
2130 * address once it is done. The bit is also used to pin
2131 * the inode in memory for flusher thread.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002132 *
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -04002133 * I_REFERENCED Marks the inode as recently references on the LRU list.
2134 *
2135 * I_DIO_WAKEUP Never set. Only used as a key for wait_on_bit().
2136 *
Tejun Heo682aa8e2015-05-28 14:50:53 -04002137 * I_WB_SWITCH Cgroup bdi_writeback switching in progress. Used to
2138 * synchronize competing switching instances and to tell
Matthew Wilcoxb93b0162018-04-10 16:36:56 -07002139 * wb stat updates to grab the i_pages lock. See
Greg Thelena9519de2019-03-05 15:50:03 -08002140 * inode_switch_wbs_work_fn() for details.
Tejun Heo682aa8e2015-05-28 14:50:53 -04002141 *
Amir Goldsteinad0af712017-06-21 15:28:32 +03002142 * I_OVL_INUSE Used by overlayfs to get exclusive ownership on upper
2143 * and work dirs among overlayfs mounts.
2144 *
Al Viroc2b6d622018-06-28 15:53:17 -04002145 * I_CREATING New object's inode in the middle of setting up.
2146 *
Ira Weinydae2f8e2020-04-30 07:41:37 -07002147 * I_DONTCACHE Evict inode as soon as it is not used anymore.
2148 *
Jan Kara5afced32020-05-29 15:05:22 +02002149 * I_SYNC_QUEUED Inode is queued in b_io or b_more_io writeback lists.
2150 * Used to detect that mark_inode_dirty() should not move
2151 * inode between dirty lists.
2152 *
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002153 * Q: What is the difference between I_WILL_FREE and I_FREEING?
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002154 */
Nick Piggin9e38d862010-10-23 06:55:17 -04002155#define I_DIRTY_SYNC (1 << 0)
2156#define I_DIRTY_DATASYNC (1 << 1)
2157#define I_DIRTY_PAGES (1 << 2)
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002158#define __I_NEW 3
2159#define I_NEW (1 << __I_NEW)
Nick Piggin9e38d862010-10-23 06:55:17 -04002160#define I_WILL_FREE (1 << 4)
2161#define I_FREEING (1 << 5)
2162#define I_CLEAR (1 << 6)
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002163#define __I_SYNC 7
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002164#define I_SYNC (1 << __I_SYNC)
Nick Piggin9e38d862010-10-23 06:55:17 -04002165#define I_REFERENCED (1 << 8)
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -04002166#define __I_DIO_WAKEUP 9
Eric Sandeenac74d8d2015-04-16 15:04:56 -05002167#define I_DIO_WAKEUP (1 << __I_DIO_WAKEUP)
Al Virof4e0c302013-06-11 08:34:36 +04002168#define I_LINKABLE (1 << 10)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05002169#define I_DIRTY_TIME (1 << 11)
Tejun Heo682aa8e2015-05-28 14:50:53 -04002170#define I_WB_SWITCH (1 << 13)
Al Viroc2b6d622018-06-28 15:53:17 -04002171#define I_OVL_INUSE (1 << 14)
2172#define I_CREATING (1 << 15)
Ira Weinydae2f8e2020-04-30 07:41:37 -07002173#define I_DONTCACHE (1 << 16)
Jan Kara5afced32020-05-29 15:05:22 +02002174#define I_SYNC_QUEUED (1 << 17)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175
Christoph Hellwig0e11f642018-02-21 07:54:49 -08002176#define I_DIRTY_INODE (I_DIRTY_SYNC | I_DIRTY_DATASYNC)
2177#define I_DIRTY (I_DIRTY_INODE | I_DIRTY_PAGES)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05002178#define I_DIRTY_ALL (I_DIRTY | I_DIRTY_TIME)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179
2180extern void __mark_inode_dirty(struct inode *, int);
2181static inline void mark_inode_dirty(struct inode *inode)
2182{
2183 __mark_inode_dirty(inode, I_DIRTY);
2184}
2185
2186static inline void mark_inode_dirty_sync(struct inode *inode)
2187{
2188 __mark_inode_dirty(inode, I_DIRTY_SYNC);
2189}
2190
Miklos Szeredi7ada4db2011-11-21 12:11:32 +01002191extern void inc_nlink(struct inode *inode);
2192extern void drop_nlink(struct inode *inode);
2193extern void clear_nlink(struct inode *inode);
2194extern void set_nlink(struct inode *inode, unsigned int nlink);
Dave Hansend8c76e62006-09-30 23:29:04 -07002195
2196static inline void inode_inc_link_count(struct inode *inode)
2197{
2198 inc_nlink(inode);
Alexey Dobriyan66d21732006-03-23 03:00:51 -08002199 mark_inode_dirty(inode);
2200}
2201
Dave Hansen9a53c3a2006-09-30 23:29:03 -07002202static inline void inode_dec_link_count(struct inode *inode)
2203{
2204 drop_nlink(inode);
Alexey Dobriyan66d21732006-03-23 03:00:51 -08002205 mark_inode_dirty(inode);
2206}
2207
Josef Bacikc3b2da32012-03-26 09:59:21 -04002208enum file_time_flags {
2209 S_ATIME = 1,
2210 S_MTIME = 2,
2211 S_CTIME = 4,
2212 S_VERSION = 8,
2213};
2214
Miklos Szeredic6718542018-07-18 15:44:43 +02002215extern bool atime_needs_update(const struct path *, struct inode *);
Al Virobadcf2b2013-07-16 18:15:46 +04002216extern void touch_atime(const struct path *);
Josef Bacik9febc9d2021-10-14 13:11:00 -04002217int inode_update_time(struct inode *inode, struct timespec64 *time, int flags);
2218
Linus Torvalds1da177e2005-04-16 15:20:36 -07002219static inline void file_accessed(struct file *file)
2220{
2221 if (!(file->f_flags & O_NOATIME))
Al Viro68ac1232012-03-15 08:21:57 -04002222 touch_atime(&file->f_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223}
2224
Amir Goldsteine38f7f52019-06-05 08:04:49 -07002225extern int file_modified(struct file *file);
2226
Linus Torvalds1da177e2005-04-16 15:20:36 -07002227int sync_inode(struct inode *inode, struct writeback_control *wbc);
Christoph Hellwigc37650162010-10-06 10:48:20 +02002228int sync_inode_metadata(struct inode *inode, int wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002229
Linus Torvalds1da177e2005-04-16 15:20:36 -07002230struct file_system_type {
2231 const char *name;
2232 int fs_flags;
David Howellsbbc10962012-10-15 16:40:35 +01002233#define FS_REQUIRES_DEV 1
2234#define FS_BINARY_MOUNTDATA 2
2235#define FS_HAS_SUBTYPE 4
Eric W. Biederman0c55cfc2012-07-26 21:42:03 -07002236#define FS_USERNS_MOUNT 8 /* Can be mounted by userns root */
Jan Kara0b3b0942019-05-15 16:28:34 +02002237#define FS_DISALLOW_NOTIFY_PERM 16 /* Disable fanotify permission events */
Matthew Wilcox (Oracle)01c70262020-10-15 20:06:00 -07002238#define FS_THP_SUPPORT 8192 /* Remove once all fs converted */
David Howellsbbc10962012-10-15 16:40:35 +01002239#define FS_RENAME_DOES_D_MOVE 32768 /* FS will handle d_move() during rename() internally. */
Al Virof3a09c92018-12-23 18:55:56 -05002240 int (*init_fs_context)(struct fs_context *);
Al Virod7167b12019-09-07 07:23:15 -04002241 const struct fs_parameter_spec *parameters;
Al Viroc96e41e2010-07-25 00:17:56 +04002242 struct dentry *(*mount) (struct file_system_type *, int,
2243 const char *, void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002244 void (*kill_sb) (struct super_block *);
2245 struct module *owner;
2246 struct file_system_type * next;
Al Viroa5166162011-12-12 22:53:00 -05002247 struct hlist_head fs_supers;
Peter Zijlstrad475fd42007-10-15 14:51:31 +02002248
Ingo Molnarcf516242006-07-03 00:25:27 -07002249 struct lock_class_key s_lock_key;
Arjan van de Ven897c6ff2006-07-03 00:25:28 -07002250 struct lock_class_key s_umount_key;
Roland Dreier51ee0492010-04-27 14:23:57 -07002251 struct lock_class_key s_vfs_rename_key;
Jan Kara5accdf82012-06-12 16:20:34 +02002252 struct lock_class_key s_writers_key[SB_FREEZE_LEVELS];
Peter Zijlstrad475fd42007-10-15 14:51:31 +02002253
2254 struct lock_class_key i_lock_key;
2255 struct lock_class_key i_mutex_key;
Peter Zijlstra14358e62007-10-14 01:38:33 +02002256 struct lock_class_key i_mutex_dir_key;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002257};
2258
Eric W. Biederman7f78e032013-03-02 19:39:14 -08002259#define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME)
2260
Al Viro152a0832010-07-25 00:46:55 +04002261extern struct dentry *mount_bdev(struct file_system_type *fs_type,
2262 int flags, const char *dev_name, void *data,
2263 int (*fill_super)(struct super_block *, void *, int));
Al Virofc14f2f2010-07-25 01:48:30 +04002264extern struct dentry *mount_single(struct file_system_type *fs_type,
2265 int flags, void *data,
2266 int (*fill_super)(struct super_block *, void *, int));
Al Viro3c26ff62010-07-25 11:46:36 +04002267extern struct dentry *mount_nodev(struct file_system_type *fs_type,
2268 int flags, void *data,
2269 int (*fill_super)(struct super_block *, void *, int));
Al Viroea441d12011-11-16 21:43:59 -05002270extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002271void generic_shutdown_super(struct super_block *sb);
2272void kill_block_super(struct super_block *sb);
2273void kill_anon_super(struct super_block *sb);
2274void kill_litter_super(struct super_block *sb);
2275void deactivate_super(struct super_block *sb);
Al Viro74dbbdd2009-05-06 01:07:50 -04002276void deactivate_locked_super(struct super_block *sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277int set_anon_super(struct super_block *s, void *data);
Al Virocb50b342018-12-23 17:25:47 -05002278int set_anon_super_fc(struct super_block *s, struct fs_context *fc);
Al Viro0ee5dc62011-07-07 15:44:25 -04002279int get_anon_bdev(dev_t *);
2280void free_anon_bdev(dev_t);
Al Virocb50b342018-12-23 17:25:47 -05002281struct super_block *sget_fc(struct fs_context *fc,
2282 int (*test)(struct super_block *, struct fs_context *),
2283 int (*set)(struct super_block *, struct fs_context *));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002284struct super_block *sget(struct file_system_type *type,
2285 int (*test)(struct super_block *,void *),
2286 int (*set)(struct super_block *,void *),
David Howells9249e172012-06-25 12:55:37 +01002287 int flags, void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002288
2289/* Alas, no aliases. Too much hassle with bringing module.h everywhere */
2290#define fops_get(fops) \
2291 (((fops) && try_module_get((fops)->owner) ? (fops) : NULL))
2292#define fops_put(fops) \
2293 do { if (fops) module_put((fops)->owner); } while(0)
Al Viroe84f9e52013-09-22 14:17:15 -04002294/*
2295 * This one is to be used *ONLY* from ->open() instances.
2296 * fops must be non-NULL, pinned down *and* module dependencies
2297 * should be sufficient to pin the caller down as well.
2298 */
2299#define replace_fops(f, fops) \
2300 do { \
2301 struct file *__file = (f); \
2302 fops_put(__file->f_op); \
2303 BUG_ON(!(__file->f_op = (fops))); \
2304 } while(0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002305
2306extern int register_filesystem(struct file_system_type *);
2307extern int unregister_filesystem(struct file_system_type *);
David Howellsd911b452018-11-01 23:07:26 +00002308extern struct vfsmount *kern_mount(struct file_system_type *);
Tim Chen423e0ab2011-07-19 09:32:38 -07002309extern void kern_unmount(struct vfsmount *mnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002310extern int may_umount_tree(struct vfsmount *);
2311extern int may_umount(struct vfsmount *);
Seunghun Lee5e6123f2014-09-14 22:15:10 +09002312extern long do_mount(const char *, const char __user *,
2313 const char *, unsigned long, void *);
Al Viroca71cf72016-11-20 19:45:28 -05002314extern struct vfsmount *collect_mounts(const struct path *);
Al Viro8aec0802007-06-07 12:20:32 -04002315extern void drop_collected_mounts(struct vfsmount *);
Al Viro1f707132010-01-30 22:51:25 -05002316extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
2317 struct vfsmount *);
Al Virof0bb5aa2016-11-20 20:27:12 -05002318extern int vfs_statfs(const struct path *, struct kstatfs *);
Al Viroc8b91ac2011-03-12 10:41:39 -05002319extern int user_statfs(const char __user *, struct kstatfs *);
2320extern int fd_statfs(int, struct kstatfs *);
Josef Bacik18e9e512010-03-23 10:34:56 -04002321extern int freeze_super(struct super_block *super);
2322extern int thaw_super(struct super_block *super);
Al Viro02125a82011-12-05 08:43:34 -05002323extern bool our_mnt(struct vfsmount *mnt);
Jan Karafca39342017-04-12 12:24:28 +02002324extern __printf(2, 3)
2325int super_setup_bdi_name(struct super_block *sb, char *fmt, ...);
2326extern int super_setup_bdi(struct super_block *sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002327
Al Viroce3b0f82009-03-29 19:08:22 -04002328extern int current_umask(void);
2329
J. Bruce Fields5a146962012-08-28 07:50:40 -07002330extern void ihold(struct inode * inode);
2331extern void iput(struct inode *);
Deepa Dinamani95582b02018-05-08 19:36:02 -07002332extern int generic_update_time(struct inode *, struct timespec64 *, int);
J. Bruce Fields5a146962012-08-28 07:50:40 -07002333
Miklos Szeredif87fd4c2006-01-16 22:14:23 -08002334/* /sys/fs */
Greg Kroah-Hartman00d26662007-10-29 14:17:23 -06002335extern struct kobject *fs_kobj;
Miklos Szeredif87fd4c2006-01-16 22:14:23 -08002336
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002337#define MAX_RW_COUNT (INT_MAX & PAGE_MASK)
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002338
Jeff Layton9e8925b2015-11-16 09:49:34 -05002339#ifdef CONFIG_MANDATORY_FILE_LOCKING
Jeff Laytond7a06982014-03-10 09:54:15 -04002340extern int locks_mandatory_locked(struct file *);
Christoph Hellwigacc15572015-12-03 12:59:49 +01002341extern int locks_mandatory_area(struct inode *, struct file *, loff_t, loff_t, unsigned char);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002342
2343/*
2344 * Candidates for mandatory locking have the setgid bit set
2345 * but no group execute bit - an otherwise meaningless combination.
2346 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002347
2348static inline int __mandatory_lock(struct inode *ino)
2349{
2350 return (ino->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID;
2351}
2352
2353/*
David Howellse462ec52017-07-17 08:45:35 +01002354 * ... and these candidates should be on SB_MANDLOCK mounted fs,
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002355 * otherwise these will be advisory locks
2356 */
2357
2358static inline int mandatory_lock(struct inode *ino)
2359{
2360 return IS_MANDLOCK(ino) && __mandatory_lock(ino);
2361}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002362
Jeff Laytond7a06982014-03-10 09:54:15 -04002363static inline int locks_verify_locked(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002364{
Miklos Szeredic568d682016-09-16 12:44:20 +02002365 if (mandatory_lock(locks_inode(file)))
Jeff Laytond7a06982014-03-10 09:54:15 -04002366 return locks_mandatory_locked(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002367 return 0;
2368}
2369
Linus Torvalds1da177e2005-04-16 15:20:36 -07002370static inline int locks_verify_truncate(struct inode *inode,
Christoph Hellwigacc15572015-12-03 12:59:49 +01002371 struct file *f,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002372 loff_t size)
2373{
Christoph Hellwigacc15572015-12-03 12:59:49 +01002374 if (!inode->i_flctx || !mandatory_lock(inode))
2375 return 0;
2376
2377 if (size < inode->i_size) {
2378 return locks_mandatory_area(inode, f, size, inode->i_size - 1,
2379 F_WRLCK);
2380 } else {
2381 return locks_mandatory_area(inode, f, inode->i_size, size - 1,
2382 F_WRLCK);
2383 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002384}
2385
Jeff Layton9e8925b2015-11-16 09:49:34 -05002386#else /* !CONFIG_MANDATORY_FILE_LOCKING */
2387
2388static inline int locks_mandatory_locked(struct file *file)
2389{
2390 return 0;
2391}
2392
Linus Torvaldsfce205e2016-01-12 16:30:34 -08002393static inline int locks_mandatory_area(struct inode *inode, struct file *filp,
2394 loff_t start, loff_t end, unsigned char type)
Jeff Layton9e8925b2015-11-16 09:49:34 -05002395{
2396 return 0;
2397}
2398
2399static inline int __mandatory_lock(struct inode *inode)
2400{
2401 return 0;
2402}
2403
2404static inline int mandatory_lock(struct inode *inode)
2405{
2406 return 0;
2407}
2408
2409static inline int locks_verify_locked(struct file *file)
2410{
2411 return 0;
2412}
2413
2414static inline int locks_verify_truncate(struct inode *inode, struct file *filp,
2415 size_t size)
2416{
2417 return 0;
2418}
2419
2420#endif /* CONFIG_MANDATORY_FILE_LOCKING */
2421
2422
2423#ifdef CONFIG_FILE_LOCKING
Linus Torvalds1da177e2005-04-16 15:20:36 -07002424static inline int break_lease(struct inode *inode, unsigned int mode)
2425{
Jeff Layton24cbe782014-02-03 12:13:06 -05002426 /*
2427 * Since this check is lockless, we must ensure that any refcounts
Jeff Layton8116bf42015-01-21 20:44:01 -05002428 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2429 * could end up racing with tasks trying to set a new lease on this
2430 * file.
Jeff Layton24cbe782014-02-03 12:13:06 -05002431 */
2432 smp_mb();
Jeff Layton8634b512015-01-16 15:05:55 -05002433 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002434 return __break_lease(inode, mode, FL_LEASE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002435 return 0;
2436}
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002437
2438static inline int break_deleg(struct inode *inode, unsigned int mode)
2439{
Jeff Layton962bd402014-06-10 12:24:40 -04002440 /*
2441 * Since this check is lockless, we must ensure that any refcounts
Jeff Layton8116bf42015-01-21 20:44:01 -05002442 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2443 * could end up racing with tasks trying to set a new lease on this
2444 * file.
Jeff Layton962bd402014-06-10 12:24:40 -04002445 */
2446 smp_mb();
Jeff Layton8634b512015-01-16 15:05:55 -05002447 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002448 return __break_lease(inode, mode, FL_DELEG);
2449 return 0;
2450}
2451
J. Bruce Fields5a146962012-08-28 07:50:40 -07002452static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2453{
2454 int ret;
2455
2456 ret = break_deleg(inode, O_WRONLY|O_NONBLOCK);
2457 if (ret == -EWOULDBLOCK && delegated_inode) {
2458 *delegated_inode = inode;
2459 ihold(inode);
2460 }
2461 return ret;
2462}
2463
2464static inline int break_deleg_wait(struct inode **delegated_inode)
2465{
2466 int ret;
2467
2468 ret = break_deleg(*delegated_inode, O_WRONLY);
2469 iput(*delegated_inode);
2470 *delegated_inode = NULL;
2471 return ret;
2472}
2473
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01002474static inline int break_layout(struct inode *inode, bool wait)
2475{
2476 smp_mb();
2477 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2478 return __break_lease(inode,
2479 wait ? O_WRONLY : O_WRONLY | O_NONBLOCK,
2480 FL_LAYOUT);
2481 return 0;
2482}
2483
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002484#else /* !CONFIG_FILE_LOCKING */
Steven Whitehouseaf5df562009-01-20 10:29:46 +00002485static inline int break_lease(struct inode *inode, unsigned int mode)
2486{
2487 return 0;
2488}
2489
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002490static inline int break_deleg(struct inode *inode, unsigned int mode)
2491{
2492 return 0;
2493}
J. Bruce Fields5a146962012-08-28 07:50:40 -07002494
2495static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2496{
2497 return 0;
2498}
2499
2500static inline int break_deleg_wait(struct inode **delegated_inode)
2501{
2502 BUG();
2503 return 0;
2504}
2505
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01002506static inline int break_layout(struct inode *inode, bool wait)
2507{
2508 return 0;
2509}
2510
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002511#endif /* CONFIG_FILE_LOCKING */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002512
2513/* fs/open.c */
Jeff Laytonadb5c242012-10-10 16:43:13 -04002514struct audit_names;
Jeff Layton91a27b22012-10-10 15:25:28 -04002515struct filename {
Jeff Laytonadb5c242012-10-10 16:43:13 -04002516 const char *name; /* pointer to actual string */
2517 const __user char *uptr; /* original userland pointer */
Paul Moore55422d02015-01-22 00:00:23 -05002518 int refcnt;
Rasmus Villemoes1c9498432018-03-01 00:19:21 +01002519 struct audit_names *aname;
Al Virofd2f7cb2015-02-22 20:07:13 -05002520 const char iname[];
Jeff Layton91a27b22012-10-10 15:25:28 -04002521};
Rasmus Villemoesf1fffbd2019-03-07 16:27:07 -08002522static_assert(offsetof(struct filename, iname) % sizeof(long) == 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002523
Al Viro7df818b2016-03-25 14:24:09 -04002524extern long vfs_truncate(const struct path *, loff_t);
NeilBrown4a301312006-01-08 01:02:39 -08002525extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
2526 struct file *filp);
Anna Schumaker72c72bd2014-11-07 14:44:25 -05002527extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
Ankit Jain3e63cbb2009-06-19 14:28:07 -04002528 loff_t len);
Jason Uhlenkott8e8a1402007-10-20 03:16:18 +02002529extern long do_sys_open(int dfd, const char __user *filename, int flags,
Al Viroa218d0f2011-11-21 14:59:34 -05002530 umode_t mode);
Jeff Layton669abf42012-10-10 16:43:10 -04002531extern struct file *file_open_name(struct filename *, int, umode_t);
Al Viroa218d0f2011-11-21 14:59:34 -05002532extern struct file *filp_open(const char *, int, umode_t);
Al Viro73d049a2011-03-11 12:08:24 -05002533extern struct file *file_open_root(struct dentry *, struct vfsmount *,
Jann Horn378c6522016-03-22 14:25:36 -07002534 const char *, int, umode_t);
Al Viro765927b2012-06-26 21:58:53 +04002535extern struct file * dentry_open(const struct path *, int, const struct cred *);
Al Viro2abc77a2018-07-12 11:18:42 -04002536extern struct file * open_with_fake_path(const struct path *, int,
2537 struct inode*, const struct cred *);
Al Viro19f391e2018-06-08 11:19:32 -04002538static inline struct file *file_clone_open(struct file *file)
2539{
2540 return dentry_open(&file->f_path, file->f_flags, file->f_cred);
2541}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002542extern int filp_close(struct file *, fl_owner_t id);
Jeff Layton91a27b22012-10-10 15:25:28 -04002543
David Drysdale51f39a12014-12-12 16:57:29 -08002544extern struct filename *getname_flags(const char __user *, int, int *);
Jeff Layton91a27b22012-10-10 15:25:28 -04002545extern struct filename *getname(const char __user *);
Linus Torvaldsc4ad8f92014-02-05 12:54:53 -08002546extern struct filename *getname_kernel(const char *);
Paul Moore55422d02015-01-22 00:00:23 -05002547extern void putname(struct filename *name);
Jeff Layton91a27b22012-10-10 15:25:28 -04002548
Al Viro30d90492012-06-22 12:40:19 +04002549extern int finish_open(struct file *file, struct dentry *dentry,
Al Virobe12af32018-06-08 11:44:56 -04002550 int (*open)(struct inode *, struct file *));
Al Viroe45198a2012-06-10 06:48:09 -04002551extern int finish_no_open(struct file *file, struct dentry *dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002552
2553/* fs/dcache.c */
2554extern void __init vfs_caches_init_early(void);
Mel Gorman4248b0d2015-08-06 15:46:20 -07002555extern void __init vfs_caches_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002556
Christoph Lameterb86c0892006-12-06 20:32:57 -08002557extern struct kmem_cache *names_cachep;
2558
Jeff Laytona608ca22012-10-10 15:25:26 -04002559#define __getname() kmem_cache_alloc(names_cachep, GFP_KERNEL)
Vegard Nossum3446a8a2009-05-16 11:22:14 +02002560#define __putname(name) kmem_cache_free(names_cachep, (void *)(name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002561
Tejun Heoa212b102015-05-22 17:13:33 -04002562extern struct super_block *blockdev_superblock;
Tejun Heoa212b102015-05-22 17:13:33 -04002563static inline bool sb_is_blkdev_sb(struct super_block *sb)
2564{
Christoph Hellwigdd0dca22020-06-20 09:16:40 +02002565 return IS_ENABLED(CONFIG_BLOCK) && sb == blockdev_superblock;
Al Viro47e44912009-04-01 07:07:16 -04002566}
2567
Christoph Hellwigb818f092020-06-20 09:16:35 +02002568void emergency_thaw_all(void);
Jan Kara60b06802009-04-27 16:43:53 +02002569extern int sync_filesystem(struct super_block *);
David Howells93614012006-09-30 20:45:40 +02002570extern const struct file_operations def_blk_fops;
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08002571extern const struct file_operations def_chr_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002572
2573/* fs/char_dev.c */
Logan Gunthorpe8a932f72017-06-15 14:05:21 -06002574#define CHRDEV_MAJOR_MAX 512
Linus Walleij49db08c2016-02-19 15:36:07 +01002575/* Marks the bottom of the first segment of free char majors */
2576#define CHRDEV_MAJOR_DYN_END 234
Logan Gunthorpea5d31a32017-06-15 14:05:20 -06002577/* Marks the top and bottom of the second segment of free char majors */
2578#define CHRDEV_MAJOR_DYN_EXT_START 511
2579#define CHRDEV_MAJOR_DYN_EXT_END 384
2580
Linus Torvalds1da177e2005-04-16 15:20:36 -07002581extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
2582extern int register_chrdev_region(dev_t, unsigned, const char *);
Tejun Heo1905b1b2009-08-06 18:13:23 +09002583extern int __register_chrdev(unsigned int major, unsigned int baseminor,
2584 unsigned int count, const char *name,
2585 const struct file_operations *fops);
2586extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
2587 unsigned int count, const char *name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002588extern void unregister_chrdev_region(dev_t, unsigned);
Joe Korty68eef3b2006-03-31 02:30:32 -08002589extern void chrdev_show(struct seq_file *,off_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002590
Tejun Heo1905b1b2009-08-06 18:13:23 +09002591static inline int register_chrdev(unsigned int major, const char *name,
2592 const struct file_operations *fops)
2593{
2594 return __register_chrdev(major, 0, 256, name, fops);
2595}
2596
2597static inline void unregister_chrdev(unsigned int major, const char *name)
2598{
2599 __unregister_chrdev(major, 0, 256, name);
2600}
2601
Linus Torvalds1da177e2005-04-16 15:20:36 -07002602extern void init_special_inode(struct inode *, umode_t, dev_t);
2603
2604/* Invalid inode operations -- fs/bad_inode.c */
2605extern void make_bad_inode(struct inode *);
Yaowei Bai0e3ef1f2015-11-19 21:00:11 +08002606extern bool is_bad_inode(struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002607
Linus Torvalds1da177e2005-04-16 15:20:36 -07002608unsigned long invalidate_mapping_pages(struct address_space *mapping,
2609 pgoff_t start, pgoff_t end);
Anton Altaparmakov54bc4852007-02-10 01:45:38 -08002610
Yafang Shaoeb1d7a62020-10-13 16:51:47 -07002611void invalidate_mapping_pagevec(struct address_space *mapping,
2612 pgoff_t start, pgoff_t end,
2613 unsigned long *nr_pagevec);
2614
Linus Torvalds1da177e2005-04-16 15:20:36 -07002615static inline void invalidate_remote_inode(struct inode *inode)
2616{
2617 if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
2618 S_ISLNK(inode->i_mode))
Andrew Mortonfc0ecff2007-02-10 01:45:39 -08002619 invalidate_mapping_pages(inode->i_mapping, 0, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002620}
2621extern int invalidate_inode_pages2(struct address_space *mapping);
2622extern int invalidate_inode_pages2_range(struct address_space *mapping,
2623 pgoff_t start, pgoff_t end);
2624extern int write_inode_now(struct inode *, int);
2625extern int filemap_fdatawrite(struct address_space *);
2626extern int filemap_flush(struct address_space *);
Jeff Layton76341ca2017-07-06 07:02:22 -04002627extern int filemap_fdatawait_keep_errors(struct address_space *mapping);
Jan Karad3bccb6f2009-08-17 19:30:27 +02002628extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
2629 loff_t lend);
Ross Zwisleraa0bfcd2019-06-20 17:05:37 -04002630extern int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
2631 loff_t start_byte, loff_t end_byte);
Jeff Laytonffb959b2017-07-31 10:29:38 -04002632
2633static inline int filemap_fdatawait(struct address_space *mapping)
2634{
2635 return filemap_fdatawait_range(mapping, 0, LLONG_MAX);
2636}
2637
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -05002638extern bool filemap_range_has_page(struct address_space *, loff_t lstart,
2639 loff_t lend);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002640extern int filemap_write_and_wait_range(struct address_space *mapping,
2641 loff_t lstart, loff_t lend);
Andrew Mortonebcf28e2006-03-24 03:18:04 -08002642extern int __filemap_fdatawrite_range(struct address_space *mapping,
2643 loff_t start, loff_t end, int sync_mode);
Jan Karaf4c0a0f2008-07-11 19:27:31 -04002644extern int filemap_fdatawrite_range(struct address_space *mapping,
2645 loff_t start, loff_t end);
Miklos Szeredid72d9e22016-07-29 14:10:57 +02002646extern int filemap_check_errors(struct address_space *mapping);
Jeff Layton5660e132017-07-06 07:02:25 -04002647extern void __filemap_set_wb_err(struct address_space *mapping, int err);
Jeff Laytona823e452017-07-28 07:24:43 -04002648
Ira Weinyddf8f372020-01-30 22:12:07 -08002649static inline int filemap_write_and_wait(struct address_space *mapping)
2650{
2651 return filemap_write_and_wait_range(mapping, 0, LLONG_MAX);
2652}
2653
Jeff Laytona823e452017-07-28 07:24:43 -04002654extern int __must_check file_fdatawait_range(struct file *file, loff_t lstart,
2655 loff_t lend);
Jeff Layton5660e132017-07-06 07:02:25 -04002656extern int __must_check file_check_and_advance_wb_err(struct file *file);
2657extern int __must_check file_write_and_wait_range(struct file *file,
2658 loff_t start, loff_t end);
2659
Jeff Laytona823e452017-07-28 07:24:43 -04002660static inline int file_write_and_wait(struct file *file)
2661{
2662 return file_write_and_wait_range(file, 0, LLONG_MAX);
2663}
2664
Jeff Layton5660e132017-07-06 07:02:25 -04002665/**
2666 * filemap_set_wb_err - set a writeback error on an address_space
2667 * @mapping: mapping in which to set writeback error
2668 * @err: error to be set in mapping
2669 *
2670 * When writeback fails in some way, we must record that error so that
2671 * userspace can be informed when fsync and the like are called. We endeavor
2672 * to report errors on any file that was open at the time of the error. Some
2673 * internal callers also need to know when writeback errors have occurred.
2674 *
2675 * When a writeback error occurs, most filesystems will want to call
2676 * filemap_set_wb_err to record the error in the mapping so that it will be
2677 * automatically reported whenever fsync is called on the file.
Jeff Layton5660e132017-07-06 07:02:25 -04002678 */
2679static inline void filemap_set_wb_err(struct address_space *mapping, int err)
2680{
2681 /* Fastpath for common case of no error */
2682 if (unlikely(err))
2683 __filemap_set_wb_err(mapping, err);
2684}
2685
2686/**
Andreas Gruenbacherc9dff082020-07-09 14:49:30 +02002687 * filemap_check_wb_err - has an error occurred since the mark was sampled?
Jeff Layton5660e132017-07-06 07:02:25 -04002688 * @mapping: mapping to check for writeback errors
2689 * @since: previously-sampled errseq_t
2690 *
2691 * Grab the errseq_t value from the mapping, and see if it has changed "since"
2692 * the given value was sampled.
2693 *
2694 * If it has then report the latest error set, otherwise return 0.
2695 */
2696static inline int filemap_check_wb_err(struct address_space *mapping,
2697 errseq_t since)
2698{
2699 return errseq_check(&mapping->wb_err, since);
2700}
2701
2702/**
2703 * filemap_sample_wb_err - sample the current errseq_t to test for later errors
2704 * @mapping: mapping to be sampled
2705 *
2706 * Writeback errors are always reported relative to a particular sample point
2707 * in the past. This function provides those sample points.
2708 */
2709static inline errseq_t filemap_sample_wb_err(struct address_space *mapping)
2710{
2711 return errseq_sample(&mapping->wb_err);
2712}
2713
Jeff Layton735e4ae2020-06-01 21:45:36 -07002714/**
2715 * file_sample_sb_err - sample the current errseq_t to test for later errors
Mauro Carvalho Chehab21b9cb32020-06-23 09:09:03 +02002716 * @file: file pointer to be sampled
Jeff Layton735e4ae2020-06-01 21:45:36 -07002717 *
2718 * Grab the most current superblock-level errseq_t value for the given
2719 * struct file.
2720 */
2721static inline errseq_t file_sample_sb_err(struct file *file)
2722{
2723 return errseq_sample(&file->f_path.dentry->d_sb->s_wb_err);
2724}
2725
Christoph Hellwig8018ab02010-03-22 17:32:25 +01002726extern int vfs_fsync_range(struct file *file, loff_t start, loff_t end,
2727 int datasync);
2728extern int vfs_fsync(struct file *file, int datasync);
Christoph Hellwige2592212016-04-07 08:52:01 -07002729
Jens Axboe22f96b32019-04-09 14:51:48 -06002730extern int sync_file_range(struct file *file, loff_t offset, loff_t nbytes,
2731 unsigned int flags);
2732
Christoph Hellwige2592212016-04-07 08:52:01 -07002733/*
2734 * Sync the bytes written if this was a synchronous write. Expect ki_pos
2735 * to already be updated for the write, and will return either the amount
2736 * of bytes passed in, or an error if syncing the file failed.
2737 */
2738static inline ssize_t generic_write_sync(struct kiocb *iocb, ssize_t count)
Al Virod311d792014-02-09 15:18:09 -05002739{
Christoph Hellwige2592212016-04-07 08:52:01 -07002740 if (iocb->ki_flags & IOCB_DSYNC) {
2741 int ret = vfs_fsync_range(iocb->ki_filp,
2742 iocb->ki_pos - count, iocb->ki_pos - 1,
2743 (iocb->ki_flags & IOCB_SYNC) ? 0 : 1);
2744 if (ret)
2745 return ret;
2746 }
2747
2748 return count;
Al Virod311d792014-02-09 15:18:09 -05002749}
Christoph Hellwige2592212016-04-07 08:52:01 -07002750
Linus Torvalds1da177e2005-04-16 15:20:36 -07002751extern void emergency_sync(void);
2752extern void emergency_remount(void);
Carlos Maiolino30460e12020-01-09 14:30:41 +01002753
David Howells93614012006-09-30 20:45:40 +02002754#ifdef CONFIG_BLOCK
Carlos Maiolino30460e12020-01-09 14:30:41 +01002755extern int bmap(struct inode *inode, sector_t *block);
2756#else
2757static inline int bmap(struct inode *inode, sector_t *block)
2758{
2759 return -EINVAL;
2760}
David Howells93614012006-09-30 20:45:40 +02002761#endif
Carlos Maiolino30460e12020-01-09 14:30:41 +01002762
J. Bruce Fields27ac0ff2011-09-20 17:19:26 -04002763extern int notify_change(struct dentry *, struct iattr *, struct inode **);
Al Virof419a2e2008-07-22 00:07:17 -04002764extern int inode_permission(struct inode *, int);
Al Viro2830ba72011-06-20 19:16:29 -04002765extern int generic_permission(struct inode *, int);
Miklos Szeredicbdf35b2014-10-24 00:14:36 +02002766extern int __check_sticky(struct inode *dir, struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002767
Miklos Szeredif696a362008-07-31 13:41:58 +02002768static inline bool execute_ok(struct inode *inode)
2769{
2770 return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
2771}
2772
Al Viro40ba4332021-03-01 20:37:10 -05002773static inline bool inode_wrong_type(const struct inode *inode, umode_t mode)
2774{
2775 return (inode->i_mode ^ mode) & S_IFMT;
2776}
2777
Al Viro8d71db42013-03-19 21:01:03 -04002778static inline void file_start_write(struct file *file)
2779{
2780 if (!S_ISREG(file_inode(file)->i_mode))
2781 return;
Darrick J. Wong8a3c84b2020-11-10 16:50:21 -08002782 sb_start_write(file_inode(file)->i_sb);
Al Viro8d71db42013-03-19 21:01:03 -04002783}
2784
Jan Kara5ae98f12013-05-04 00:11:23 +02002785static inline bool file_start_write_trylock(struct file *file)
2786{
2787 if (!S_ISREG(file_inode(file)->i_mode))
2788 return true;
Darrick J. Wong8a3c84b2020-11-10 16:50:21 -08002789 return sb_start_write_trylock(file_inode(file)->i_sb);
Jan Kara5ae98f12013-05-04 00:11:23 +02002790}
2791
Al Viro8d71db42013-03-19 21:01:03 -04002792static inline void file_end_write(struct file *file)
2793{
2794 if (!S_ISREG(file_inode(file)->i_mode))
2795 return;
2796 __sb_end_write(file_inode(file)->i_sb, SB_FREEZE_WRITE);
2797}
2798
Al Viro07b8ce12011-06-20 10:52:57 -04002799/*
2800 * get_write_access() gets write permission for a file.
2801 * put_write_access() releases this write permission.
2802 * This is used for regular files.
2803 * We cannot support write (and maybe mmap read-write shared) accesses and
2804 * MAP_DENYWRITE mmappings simultaneously. The i_writecount field of an inode
2805 * can have the following values:
2806 * 0: no writers, no VM_DENYWRITE mappings
2807 * < 0: (-i_writecount) vm_area_structs with VM_DENYWRITE set exist
2808 * > 0: (i_writecount) users are writing to the file.
2809 *
2810 * Normally we operate on that counter with atomic_{inc,dec} and it's safe
2811 * except for the cases where we don't hold i_writecount yet. Then we need to
2812 * use {get,deny}_write_access() - these functions check the sign and refuse
2813 * to do the change if sign is wrong.
2814 */
2815static inline int get_write_access(struct inode *inode)
2816{
2817 return atomic_inc_unless_negative(&inode->i_writecount) ? 0 : -ETXTBSY;
2818}
2819static inline int deny_write_access(struct file *file)
2820{
Al Viro496ad9a2013-01-23 17:07:38 -05002821 struct inode *inode = file_inode(file);
Al Viro07b8ce12011-06-20 10:52:57 -04002822 return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
2823}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002824static inline void put_write_access(struct inode * inode)
2825{
2826 atomic_dec(&inode->i_writecount);
2827}
2828static inline void allow_write_access(struct file *file)
2829{
2830 if (file)
Al Viro496ad9a2013-01-23 17:07:38 -05002831 atomic_inc(&file_inode(file)->i_writecount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002832}
David Howellsf1fe29b2013-09-27 11:20:03 +01002833static inline bool inode_is_open_for_write(const struct inode *inode)
2834{
2835 return atomic_read(&inode->i_writecount) > 0;
2836}
2837
Amir Goldstein387e3742019-06-07 17:24:38 +03002838#if defined(CONFIG_IMA) || defined(CONFIG_FILE_LOCKING)
Mimi Zohara5c96eb2010-11-02 10:11:37 -04002839static inline void i_readcount_dec(struct inode *inode)
2840{
2841 BUG_ON(!atomic_read(&inode->i_readcount));
2842 atomic_dec(&inode->i_readcount);
2843}
2844static inline void i_readcount_inc(struct inode *inode)
2845{
2846 atomic_inc(&inode->i_readcount);
2847}
2848#else
2849static inline void i_readcount_dec(struct inode *inode)
2850{
2851 return;
2852}
2853static inline void i_readcount_inc(struct inode *inode)
2854{
2855 return;
2856}
2857#endif
Ulrich Dreppered8cae82008-07-23 21:29:30 -07002858extern int do_pipe_flags(int *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002859
Christoph Hellwigbdd1d2d2017-09-01 17:39:13 +02002860extern ssize_t kernel_read(struct file *, void *, size_t, loff_t *);
Christoph Hellwig61a707c2020-05-08 08:54:16 +02002861ssize_t __kernel_read(struct file *file, void *buf, size_t count, loff_t *pos);
Christoph Hellwige13ec932017-09-01 17:39:14 +02002862extern ssize_t kernel_write(struct file *, const void *, size_t, loff_t *);
Christoph Hellwig73e18f72017-09-01 17:39:15 +02002863extern ssize_t __kernel_write(struct file *, const void *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002864extern struct file * open_exec(const char *);
2865
2866/* fs/dcache.c -- generic fs support functions */
Yaowei Baia6e57872015-11-17 14:40:11 +08002867extern bool is_subdir(struct dentry *, struct dentry *);
Mickaël Salaün640eb7e2016-11-14 22:14:35 +01002868extern bool path_is_under(const struct path *, const struct path *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002869
Miklos Szeredi9bf39ab2015-06-19 10:29:13 +02002870extern char *file_path(struct file *, char *, int);
2871
Linus Torvalds1da177e2005-04-16 15:20:36 -07002872#include <linux/err.h>
2873
2874/* needed for stackable file system support */
Andrew Morton965c8e52012-12-17 15:59:39 -08002875extern loff_t default_llseek(struct file *file, loff_t offset, int whence);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002876
Andrew Morton965c8e52012-12-17 15:59:39 -08002877extern loff_t vfs_llseek(struct file *file, loff_t offset, int whence);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002878
Christoph Hellwig54e34622009-08-07 14:38:25 -03002879extern int inode_init_always(struct super_block *, struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002880extern void inode_init_once(struct inode *);
Miklos Szeredi2aa15892011-02-23 13:49:47 +01002881extern void address_space_init_once(struct address_space *mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002882extern struct inode * igrab(struct inode *);
2883extern ino_t iunique(struct super_block *, ino_t);
2884extern int inode_needs_sync(struct inode *inode);
Al Viro45321ac2010-06-07 13:43:19 -04002885extern int generic_delete_inode(struct inode *inode);
Al Viro9bcb4b72012-02-12 19:43:17 -05002886static inline int generic_drop_inode(struct inode *inode)
2887{
Hao Li9f5ab032020-12-08 10:08:43 +08002888 return !inode->i_nlink || inode_unhashed(inode);
Al Viro9bcb4b72012-02-12 19:43:17 -05002889}
Ira Weiny2c567af2020-04-30 07:41:37 -07002890extern void d_mark_dontcache(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002891
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07002892extern struct inode *ilookup5_nowait(struct super_block *sb,
2893 unsigned long hashval, int (*test)(struct inode *, void *),
2894 void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002895extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
2896 int (*test)(struct inode *, void *), void *data);
2897extern struct inode *ilookup(struct super_block *sb, unsigned long ino);
2898
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02002899extern struct inode *inode_insert5(struct inode *inode, unsigned long hashval,
2900 int (*test)(struct inode *, void *),
2901 int (*set)(struct inode *, void *),
2902 void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002903extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *);
2904extern struct inode * iget_locked(struct super_block *, unsigned long);
Theodore Ts'ofe032c42015-02-02 00:37:01 -05002905extern struct inode *find_inode_nowait(struct super_block *,
2906 unsigned long,
2907 int (*match)(struct inode *,
2908 unsigned long, void *),
2909 void *data);
David Howells3f19b2a2017-12-01 11:40:16 +00002910extern struct inode *find_inode_rcu(struct super_block *, unsigned long,
2911 int (*)(struct inode *, void *), void *);
2912extern struct inode *find_inode_by_ino_rcu(struct super_block *, unsigned long);
Al Viro261bca82008-12-30 01:48:21 -05002913extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
2914extern int insert_inode_locked(struct inode *);
Josh Boyere096d0c2011-08-25 07:48:12 -04002915#ifdef CONFIG_DEBUG_LOCK_ALLOC
2916extern void lockdep_annotate_inode_mutex_key(struct inode *inode);
2917#else
2918static inline void lockdep_annotate_inode_mutex_key(struct inode *inode) { };
2919#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002920extern void unlock_new_inode(struct inode *);
Al Viroc2b6d622018-06-28 15:53:17 -04002921extern void discard_new_inode(struct inode *);
Christoph Hellwig85fe4022010-10-23 11:19:54 -04002922extern unsigned int get_next_ino(void);
Darrick J. Wong799ea9e2017-08-18 18:08:25 -07002923extern void evict_inodes(struct super_block *sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002924
Chris Downe809d5f2020-08-06 23:20:20 -07002925/*
2926 * Userspace may rely on the the inode number being non-zero. For example, glibc
2927 * simply ignores files with zero i_ino in unlink() and other places.
2928 *
2929 * As an additional complication, if userspace was compiled with
2930 * _FILE_OFFSET_BITS=32 on a 64-bit kernel we'll only end up reading out the
2931 * lower 32 bits, so we need to check that those aren't zero explicitly. With
2932 * _FILE_OFFSET_BITS=64, this may cause some harmless false-negatives, but
2933 * better safe than sorry.
2934 */
2935static inline bool is_zero_ino(ino_t ino)
2936{
2937 return (u32)ino == 0;
2938}
2939
Linus Torvalds1da177e2005-04-16 15:20:36 -07002940extern void __iget(struct inode * inode);
David Howellsb46980f2008-02-07 00:15:27 -08002941extern void iget_failed(struct inode *);
Jan Karadbd57682012-05-03 14:48:02 +02002942extern void clear_inode(struct inode *);
Christoph Hellwig2e00c972009-08-07 14:38:29 -03002943extern void __destroy_inode(struct inode *);
Eric Dumazeta209dfc2011-07-26 11:36:34 +02002944extern struct inode *new_inode_pseudo(struct super_block *sb);
2945extern struct inode *new_inode(struct super_block *sb);
Nick Pigginff0c7d12011-01-07 17:49:50 +11002946extern void free_inode_nonrcu(struct inode *inode);
Jens Axboe01de85e2006-10-17 19:50:36 +02002947extern int should_remove_suid(struct dentry *);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02002948extern int file_remove_privs(struct file *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002949
2950extern void __insert_inode_hash(struct inode *, unsigned long hashval);
Christoph Hellwig646ec462010-10-23 07:15:32 -04002951static inline void insert_inode_hash(struct inode *inode)
2952{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002953 __insert_inode_hash(inode, inode->i_ino);
2954}
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +02002955
2956extern void __remove_inode_hash(struct inode *);
2957static inline void remove_inode_hash(struct inode *inode)
2958{
Josef Bacikcbedaac2015-03-12 08:19:11 -04002959 if (!inode_unhashed(inode) && !hlist_fake(&inode->i_hash))
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +02002960 __remove_inode_hash(inode);
2961}
2962
Christoph Hellwig646ec462010-10-23 07:15:32 -04002963extern void inode_sb_list_add(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002964
Linus Torvalds1da177e2005-04-16 15:20:36 -07002965extern int sb_set_blocksize(struct super_block *, int);
2966extern int sb_min_blocksize(struct super_block *, int);
2967
2968extern int generic_file_mmap(struct file *, struct vm_area_struct *);
2969extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
Al Viro3309dd02015-04-09 12:55:47 -04002970extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *);
Darrick J. Wong02e83f42020-10-14 16:47:08 -07002971extern int generic_write_check_limits(struct file *file, loff_t pos,
2972 loff_t *count);
Amir Goldsteina3171352019-06-05 08:04:48 -07002973extern int generic_file_rw_checks(struct file *file_in, struct file *file_out);
Goldwyn Rodriguesd85dc2e2019-08-30 12:09:24 -05002974extern ssize_t generic_file_buffered_read(struct kiocb *iocb,
2975 struct iov_iter *to, ssize_t already_read);
Al Viroed978a82014-03-05 22:53:04 -05002976extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
Al Viro81742022014-04-03 03:17:43 -04002977extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
Al Viro81742022014-04-03 03:17:43 -04002978extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07002979extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *);
Al Viro3b93f912014-02-11 21:34:08 -05002980extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t);
Andrew Morton88e6fae2006-04-11 13:59:36 +02002981
Christoph Hellwig18e97102017-05-27 11:16:51 +03002982ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos,
Christoph Hellwigddef7ed22017-07-06 18:58:37 +02002983 rwf_t flags);
Christoph Hellwigabbb65892017-05-27 11:16:52 +03002984ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos,
Christoph Hellwigddef7ed22017-07-06 18:58:37 +02002985 rwf_t flags);
Jiufei Xue5dcdc432019-11-20 17:45:25 +08002986ssize_t vfs_iocb_iter_read(struct file *file, struct kiocb *iocb,
2987 struct iov_iter *iter);
2988ssize_t vfs_iocb_iter_write(struct file *file, struct kiocb *iocb,
2989 struct iov_iter *iter);
Christoph Hellwigdbe4e192015-01-25 21:11:59 +01002990
Christoph Hellwigeef99382009-08-20 17:43:41 +02002991/* fs/block_dev.c */
David Jefferyb2de5252014-09-29 10:21:10 -04002992extern ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to);
Al Viro1456c0a2014-04-03 03:21:50 -04002993extern ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from);
Josef Bacik02c24a82011-07-16 20:44:56 -04002994extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
2995 int datasync);
Al Viroff01bb42011-09-16 02:31:11 -04002996extern void block_sync_page(struct page *page);
Christoph Hellwigeef99382009-08-20 17:43:41 +02002997
Andrew Morton88e6fae2006-04-11 13:59:36 +02002998/* fs/splice.c */
Jens Axboecbb7e572006-04-11 14:57:50 +02002999extern ssize_t generic_file_splice_read(struct file *, loff_t *,
Andrew Morton88e6fae2006-04-11 13:59:36 +02003000 struct pipe_inode_info *, size_t, unsigned int);
Al Viro8d020762014-04-05 04:27:08 -04003001extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
Jens Axboecbb7e572006-04-11 14:57:50 +02003002 struct file *, loff_t *, size_t, unsigned int);
Andrew Morton88e6fae2006-04-11 13:59:36 +02003003extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
Jens Axboecbb7e572006-04-11 14:57:50 +02003004 struct file *out, loff_t *, size_t len, unsigned int flags);
Miklos Szeredi1c118592014-10-24 00:14:35 +02003005extern long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
3006 loff_t *opos, size_t len, unsigned int flags);
3007
Andrew Morton88e6fae2006-04-11 13:59:36 +02003008
Linus Torvalds1da177e2005-04-16 15:20:36 -07003009extern void
3010file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
Andrew Morton965c8e52012-12-17 15:59:39 -08003011extern loff_t noop_llseek(struct file *file, loff_t offset, int whence);
3012extern loff_t no_llseek(struct file *file, loff_t offset, int whence);
Jie Liu46a1c2c2013-06-25 12:02:13 +08003013extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
Andrew Morton965c8e52012-12-17 15:59:39 -08003014extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
Andi Kleen57604952011-09-15 16:06:50 -07003015extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
Andrew Morton965c8e52012-12-17 15:59:39 -08003016 int whence, loff_t maxsize, loff_t eof);
Al Viro1bf9d142013-06-16 20:27:42 +04003017extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
3018 int whence, loff_t size);
Al Virob25472f2015-12-05 22:04:48 -05003019extern loff_t no_seek_end_llseek_size(struct file *, loff_t, int, loff_t);
3020extern loff_t no_seek_end_llseek(struct file *, loff_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003021extern int generic_file_open(struct inode * inode, struct file * filp);
3022extern int nonseekable_open(struct inode * inode, struct file * filp);
Kirill Smelkov10dce8a2019-03-26 22:20:43 +00003023extern int stream_open(struct inode * inode, struct file * filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003024
David Howells93614012006-09-30 20:45:40 +02003025#ifdef CONFIG_BLOCK
Mike Christie8a4c1e42016-06-05 14:31:50 -05003026typedef void (dio_submit_t)(struct bio *bio, struct inode *inode,
Josef Bacikfacd07b2010-05-23 11:00:55 -04003027 loff_t file_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003028
3029enum {
Christoph Hellwig1e431f52009-11-03 16:44:53 +01003030 /* need locking between buffered and direct access */
3031 DIO_LOCKING = 0x01,
3032
3033 /* filesystem does not support filling holes */
3034 DIO_SKIP_HOLES = 0x02,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003035};
3036
Omar Sandoval17f8c842015-03-16 04:33:50 -07003037ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode,
3038 struct block_device *bdev, struct iov_iter *iter,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07003039 get_block_t get_block,
Omar Sandoval17f8c842015-03-16 04:33:50 -07003040 dio_iodone_t end_io, dio_submit_t submit_io,
3041 int flags);
Christoph Hellwigeafdc7d2010-06-04 11:29:53 +02003042
Omar Sandoval17f8c842015-03-16 04:33:50 -07003043static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
3044 struct inode *inode,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07003045 struct iov_iter *iter,
Omar Sandoval17f8c842015-03-16 04:33:50 -07003046 get_block_t get_block)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003047{
Omar Sandoval17f8c842015-03-16 04:33:50 -07003048 return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07003049 get_block, NULL, NULL, DIO_LOCKING | DIO_SKIP_HOLES);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003050}
David Howells93614012006-09-30 20:45:40 +02003051#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07003052
Trond Myklebust1d59d612012-05-31 12:22:33 -04003053void inode_dio_wait(struct inode *inode);
Jens Axboefe0f07d2015-04-15 17:05:48 -06003054
3055/*
3056 * inode_dio_begin - signal start of a direct I/O requests
3057 * @inode: inode the direct I/O happens on
3058 *
3059 * This is called once we've finished processing a direct I/O request,
3060 * and is used to wake up callers waiting for direct I/O to be quiesced.
3061 */
3062static inline void inode_dio_begin(struct inode *inode)
3063{
3064 atomic_inc(&inode->i_dio_count);
3065}
3066
3067/*
3068 * inode_dio_end - signal finish of a direct I/O requests
3069 * @inode: inode the direct I/O happens on
3070 *
3071 * This is called once we've finished processing a direct I/O request,
3072 * and is used to wake up callers waiting for direct I/O to be quiesced.
3073 */
3074static inline void inode_dio_end(struct inode *inode)
3075{
3076 if (atomic_dec_and_test(&inode->i_dio_count))
3077 wake_up_bit(&inode->i_state, __I_DIO_WAKEUP);
3078}
Trond Myklebust1d59d612012-05-31 12:22:33 -04003079
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003080/*
3081 * Warn about a page cache invalidation failure diring a direct I/O write.
3082 */
3083void dio_warn_stale_pagecache(struct file *filp);
3084
Theodore Ts'o5f16f322014-03-24 14:43:12 -04003085extern void inode_set_flags(struct inode *inode, unsigned int flags,
3086 unsigned int mask);
3087
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08003088extern const struct file_operations generic_ro_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003089
3090#define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))
3091
Al Viro5d826c82014-03-14 13:42:45 -04003092extern int readlink_copy(char __user *, int, const char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003093extern int page_readlink(struct dentry *, char __user *, int);
Al Virofceef392015-12-29 15:58:39 -05003094extern const char *page_get_link(struct dentry *, struct inode *,
3095 struct delayed_call *);
3096extern void page_put_link(void *);
Kirill Korotaev0adb25d2006-03-11 03:27:13 -08003097extern int __page_symlink(struct inode *inode, const char *symname, int len,
Nick Piggin54566b22009-01-04 12:00:53 -08003098 int nofs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003099extern int page_symlink(struct inode *inode, const char *symname, int len);
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08003100extern const struct inode_operations page_symlink_inode_operations;
Al Virofceef392015-12-29 15:58:39 -05003101extern void kfree_link(void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003102extern void generic_fillattr(struct inode *, struct kstat *);
David Howellsa528d352017-01-31 16:46:22 +00003103extern int vfs_getattr_nosec(const struct path *, struct kstat *, u32, unsigned int);
3104extern int vfs_getattr(const struct path *, struct kstat *, u32, unsigned int);
Dmitry Monakhovb4627072009-12-14 15:21:12 +03003105void __inode_add_bytes(struct inode *inode, loff_t bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003106void inode_add_bytes(struct inode *inode, loff_t bytes);
Jan Kara1c8924e2013-08-17 09:32:32 -04003107void __inode_sub_bytes(struct inode *inode, loff_t bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003108void inode_sub_bytes(struct inode *inode, loff_t bytes);
Jan Karaf4a8116a2017-08-08 09:54:36 +02003109static inline loff_t __inode_get_bytes(struct inode *inode)
3110{
3111 return (((loff_t)inode->i_blocks) << 9) + inode->i_bytes;
3112}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003113loff_t inode_get_bytes(struct inode *inode);
3114void inode_set_bytes(struct inode *inode, loff_t bytes);
Al Virofceef392015-12-29 15:58:39 -05003115const char *simple_get_link(struct dentry *, struct inode *,
3116 struct delayed_call *);
Al Viro61ba64f2015-05-02 09:54:06 -04003117extern const struct inode_operations simple_symlink_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003118
Al Viro5c0ba4e2013-05-15 13:52:59 -04003119extern int iterate_dir(struct file *, struct dir_context *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003120
Christoph Hellwig09f1bde2020-09-26 09:03:59 +02003121int vfs_fstatat(int dfd, const char __user *filename, struct kstat *stat,
3122 int flags);
Christoph Hellwigda9aa5d2020-09-26 09:03:57 +02003123int vfs_fstat(int fd, struct kstat *stat);
David Howellsa528d352017-01-31 16:46:22 +00003124
3125static inline int vfs_stat(const char __user *filename, struct kstat *stat)
3126{
Christoph Hellwig0b2c6692020-09-26 09:03:58 +02003127 return vfs_fstatat(AT_FDCWD, filename, stat, 0);
David Howellsa528d352017-01-31 16:46:22 +00003128}
3129static inline int vfs_lstat(const char __user *name, struct kstat *stat)
3130{
Christoph Hellwig0b2c6692020-09-26 09:03:58 +02003131 return vfs_fstatat(AT_FDCWD, name, stat, AT_SYMLINK_NOFOLLOW);
David Howellsa528d352017-01-31 16:46:22 +00003132}
David Howellsa528d352017-01-31 16:46:22 +00003133
Miklos Szeredid60874c2016-10-04 14:40:45 +02003134extern const char *vfs_get_link(struct dentry *, struct delayed_call *);
Miklos Szeredifd4a0edf2016-12-09 16:45:04 +01003135extern int vfs_readlink(struct dentry *, char __user *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003136
David Howellsee416bc2017-07-04 17:25:16 +01003137extern struct file_system_type *get_filesystem(struct file_system_type *fs);
Miklos Szeredic18479f2007-10-18 23:39:11 -07003138extern void put_filesystem(struct file_system_type *fs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003139extern struct file_system_type *get_fs_type(const char *name);
3140extern struct super_block *get_super(struct block_device *);
Jan Kara6b6dc832012-02-10 11:03:00 +01003141extern struct super_block *get_super_thawed(struct block_device *);
Jan Karaba6379f2016-11-23 12:53:00 +01003142extern struct super_block *get_super_exclusive_thawed(struct block_device *bdev);
Christoph Hellwig45042302009-08-03 23:28:35 +02003143extern struct super_block *get_active_super(struct block_device *bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003144extern void drop_super(struct super_block *sb);
Jan Karaba6379f2016-11-23 12:53:00 +01003145extern void drop_super_exclusive(struct super_block *sb);
Al Viro01a05b32010-03-23 06:06:58 -04003146extern void iterate_supers(void (*)(struct super_block *, void *), void *);
Al Viro43e15cd2011-06-03 20:16:57 -04003147extern void iterate_supers_type(struct file_system_type *,
3148 void (*)(struct super_block *, void *), void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003149
3150extern int dcache_dir_open(struct inode *, struct file *);
3151extern int dcache_dir_close(struct inode *, struct file *);
3152extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
Al Viro5f99f4e2013-05-15 20:23:06 -04003153extern int dcache_readdir(struct file *, struct dir_context *);
npiggin@suse.de7bb46a62010-05-27 01:05:33 +10003154extern int simple_setattr(struct dentry *, struct iattr *);
David Howellsa528d352017-01-31 16:46:22 +00003155extern int simple_getattr(const struct path *, struct kstat *, u32, unsigned int);
David Howells726c3342006-06-23 02:02:58 -07003156extern int simple_statfs(struct dentry *, struct kstatfs *);
Stephen Boyd20955e82012-04-05 14:25:09 -07003157extern int simple_open(struct inode *inode, struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003158extern int simple_link(struct dentry *, struct inode *, struct dentry *);
3159extern int simple_unlink(struct inode *, struct dentry *);
3160extern int simple_rmdir(struct inode *, struct dentry *);
Miklos Szeredie0e0be82016-09-27 11:03:57 +02003161extern int simple_rename(struct inode *, struct dentry *,
3162 struct inode *, struct dentry *, unsigned int);
Al Viroa3d1e7e2019-11-18 09:43:10 -05003163extern void simple_recursive_removal(struct dentry *,
3164 void (*callback)(struct dentry *));
Josef Bacik02c24a82011-07-16 20:44:56 -04003165extern int noop_fsync(struct file *, loff_t, loff_t, int);
Dan Williamsf44c7762018-03-07 15:26:44 -08003166extern int noop_set_page_dirty(struct page *page);
3167extern void noop_invalidatepage(struct page *page, unsigned int offset,
3168 unsigned int length);
3169extern ssize_t noop_direct_IO(struct kiocb *iocb, struct iov_iter *iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003170extern int simple_empty(struct dentry *);
3171extern int simple_readpage(struct file *file, struct page *page);
Nick Pigginafddba42007-10-16 01:25:01 -07003172extern int simple_write_begin(struct file *file, struct address_space *mapping,
3173 loff_t pos, unsigned len, unsigned flags,
3174 struct page **pagep, void **fsdata);
3175extern int simple_write_end(struct file *file, struct address_space *mapping,
3176 loff_t pos, unsigned len, unsigned copied,
3177 struct page *page, void *fsdata);
Al Virob26d4cd2013-10-25 18:47:37 -04003178extern int always_delete_dentry(const struct dentry *);
Al Viro69878432013-10-02 22:35:11 -04003179extern struct inode *alloc_anon_inode(struct super_block *);
Jeff Laytone6f5c782014-08-22 10:40:25 -04003180extern int simple_nosetlease(struct file *, long, struct file_lock **, void **);
Al Virob26d4cd2013-10-25 18:47:37 -04003181extern const struct dentry_operations simple_dentry_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003182
Al Viro00cd8dd2012-06-10 17:13:09 -04003183extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003184extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08003185extern const struct file_operations simple_dir_operations;
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08003186extern const struct inode_operations simple_dir_inode_operations;
Eric W. Biedermanfbabfd02015-05-09 15:54:49 -05003187extern void make_empty_dir_inode(struct inode *inode);
3188extern bool is_empty_dir_inode(struct inode *inode);
Eric Biggerscda37122017-03-25 21:15:37 -07003189struct tree_descr { const char *name; const struct file_operations *ops; int mode; };
Linus Torvalds1da177e2005-04-16 15:20:36 -07003190struct dentry *d_alloc_name(struct dentry *, const char *);
Eric Biggerscda37122017-03-25 21:15:37 -07003191extern int simple_fill_super(struct super_block *, unsigned long,
3192 const struct tree_descr *);
Trond Myklebust1f5ce9e2006-06-09 09:34:16 -04003193extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003194extern void simple_release_fs(struct vfsmount **mount, int *count);
3195
Akinobu Mita93b07112008-06-05 22:46:21 -07003196extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
3197 loff_t *ppos, const void *from, size_t available);
Jiri Slaby6a727b42010-05-01 23:51:22 +02003198extern ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
3199 const void __user *from, size_t count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003200
Fabian Frederickac13a822014-06-04 16:06:27 -07003201extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
Josef Bacik02c24a82011-07-16 20:44:56 -04003202extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
Al Virod5aacad2009-06-07 14:56:44 -04003203
Patrick J. LoPresti30ca22c2010-07-22 15:03:41 -07003204extern int generic_check_addressable(unsigned, u64);
3205
Daniel Rosenbergc8438432020-07-08 02:12:35 -07003206#ifdef CONFIG_UNICODE
3207extern int generic_ci_d_hash(const struct dentry *dentry, struct qstr *str);
3208extern int generic_ci_d_compare(const struct dentry *dentry, unsigned int len,
3209 const char *str, const struct qstr *name);
3210#endif
3211
Christoph Lametere965f962006-02-01 03:05:41 -08003212#ifdef CONFIG_MIGRATION
Christoph Lameter2d1db3b2006-06-23 02:03:33 -07003213extern int buffer_migrate_page(struct address_space *,
Mel Gormana6bc32b2012-01-12 17:19:43 -08003214 struct page *, struct page *,
3215 enum migrate_mode);
Jan Kara89cb0882018-12-28 00:39:12 -08003216extern int buffer_migrate_page_norefs(struct address_space *,
3217 struct page *, struct page *,
3218 enum migrate_mode);
Christoph Lametere965f962006-02-01 03:05:41 -08003219#else
3220#define buffer_migrate_page NULL
Jan Kara89cb0882018-12-28 00:39:12 -08003221#define buffer_migrate_page_norefs NULL
Christoph Lametere965f962006-02-01 03:05:41 -08003222#endif
3223
Jan Kara31051c82016-05-26 16:55:18 +02003224extern int setattr_prepare(struct dentry *, struct iattr *);
npiggin@suse.de25d9e2d2009-08-21 02:35:05 +10003225extern int inode_newsize_ok(const struct inode *, loff_t offset);
Christoph Hellwig6a1a90a2010-06-04 11:30:00 +02003226extern void setattr_copy(struct inode *inode, const struct iattr *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003227
Josef Bacikc3b2da32012-03-26 09:59:21 -04003228extern int file_update_time(struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003229
Thomas Hellstrom (VMware)f05a3842020-03-24 18:46:48 +01003230static inline bool vma_is_dax(const struct vm_area_struct *vma)
Dan Williamsbaabda22017-07-10 15:48:25 -07003231{
3232 return vma->vm_file && IS_DAX(vma->vm_file->f_mapping->host);
3233}
3234
Dan Williams2bb6d282017-11-29 16:10:35 -08003235static inline bool vma_is_fsdax(struct vm_area_struct *vma)
3236{
3237 struct inode *inode;
3238
3239 if (!vma->vm_file)
3240 return false;
3241 if (!vma_is_dax(vma))
3242 return false;
3243 inode = file_inode(vma->vm_file);
Dan Williams230f5a82018-02-21 17:08:01 -08003244 if (S_ISCHR(inode->i_mode))
Dan Williams2bb6d282017-11-29 16:10:35 -08003245 return false; /* device-dax */
3246 return true;
3247}
3248
Al Viro2ba48ce2015-04-09 13:52:01 -04003249static inline int iocb_flags(struct file *file)
3250{
3251 int res = 0;
3252 if (file->f_flags & O_APPEND)
3253 res |= IOCB_APPEND;
Ira Weinyefbe3c22020-04-30 07:41:33 -07003254 if (file->f_flags & O_DIRECT)
Al Viro2ba48ce2015-04-09 13:52:01 -04003255 res |= IOCB_DIRECT;
Christoph Hellwigdde0c2e2016-04-07 08:52:00 -07003256 if ((file->f_flags & O_DSYNC) || IS_SYNC(file->f_mapping->host))
3257 res |= IOCB_DSYNC;
3258 if (file->f_flags & __O_SYNC)
3259 res |= IOCB_SYNC;
Al Viro2ba48ce2015-04-09 13:52:01 -04003260 return res;
3261}
3262
Christoph Hellwigddef7ed22017-07-06 18:58:37 +02003263static inline int kiocb_set_rw_flags(struct kiocb *ki, rwf_t flags)
Goldwyn Rodriguesfdd2f5b2017-06-20 07:05:40 -05003264{
Pavel Begunkov1752f0a2020-08-01 13:36:33 +03003265 int kiocb_flags = 0;
3266
Jens Axboece71bfe2020-08-31 12:08:10 -06003267 /* make sure there's no overlap between RWF and private IOCB flags */
3268 BUILD_BUG_ON((__force int) RWF_SUPPORTED & IOCB_EVENTFD);
3269
Pavel Begunkov1752f0a2020-08-01 13:36:33 +03003270 if (!flags)
3271 return 0;
Goldwyn Rodriguesfdd2f5b2017-06-20 07:05:40 -05003272 if (unlikely(flags & ~RWF_SUPPORTED))
3273 return -EOPNOTSUPP;
3274
Goldwyn Rodriguesb745faf2017-06-20 07:05:43 -05003275 if (flags & RWF_NOWAIT) {
Christoph Hellwig91f99432017-08-29 16:13:20 +02003276 if (!(ki->ki_filp->f_mode & FMODE_NOWAIT))
Goldwyn Rodriguesb745faf2017-06-20 07:05:43 -05003277 return -EOPNOTSUPP;
Jens Axboece71bfe2020-08-31 12:08:10 -06003278 kiocb_flags |= IOCB_NOIO;
Goldwyn Rodriguesb745faf2017-06-20 07:05:43 -05003279 }
Jens Axboece71bfe2020-08-31 12:08:10 -06003280 kiocb_flags |= (__force int) (flags & RWF_SUPPORTED);
Goldwyn Rodriguesfdd2f5b2017-06-20 07:05:40 -05003281 if (flags & RWF_SYNC)
Jens Axboece71bfe2020-08-31 12:08:10 -06003282 kiocb_flags |= IOCB_DSYNC;
Pavel Begunkov1752f0a2020-08-01 13:36:33 +03003283
3284 ki->ki_flags |= kiocb_flags;
Goldwyn Rodriguesfdd2f5b2017-06-20 07:05:40 -05003285 return 0;
3286}
3287
Linus Torvalds1da177e2005-04-16 15:20:36 -07003288static inline ino_t parent_ino(struct dentry *dentry)
3289{
3290 ino_t res;
3291
Nick Pigginb5c84bf2011-01-07 17:49:38 +11003292 /*
3293 * Don't strictly need d_lock here? If the parent ino could change
3294 * then surely we'd have a deeper race in the caller?
3295 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003296 spin_lock(&dentry->d_lock);
3297 res = dentry->d_parent->d_inode->i_ino;
3298 spin_unlock(&dentry->d_lock);
3299 return res;
3300}
3301
Linus Torvalds1da177e2005-04-16 15:20:36 -07003302/* Transaction based IO helpers */
3303
3304/*
3305 * An argresp is stored in an allocated page and holds the
3306 * size of the argument or response, along with its content
3307 */
3308struct simple_transaction_argresp {
3309 ssize_t size;
Gustavo A. R. Silva5e01fdf2020-08-31 08:25:42 -05003310 char data[];
Linus Torvalds1da177e2005-04-16 15:20:36 -07003311};
3312
3313#define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))
3314
3315char *simple_transaction_get(struct file *file, const char __user *buf,
3316 size_t size);
3317ssize_t simple_transaction_read(struct file *file, char __user *buf,
3318 size_t size, loff_t *pos);
3319int simple_transaction_release(struct inode *inode, struct file *file);
3320
Ingo Molnar76791ab2009-03-25 16:48:35 +01003321void simple_transaction_set(struct file *file, size_t n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003322
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003323/*
3324 * simple attribute files
3325 *
3326 * These attributes behave similar to those in sysfs:
3327 *
3328 * Writing to an attribute immediately sets a value, an open file can be
3329 * written to multiple times.
3330 *
3331 * Reading from an attribute creates a buffer from the value that might get
3332 * read with multiple read calls. When the attribute has been read
3333 * completely, no further read calls are possible until the file is opened
3334 * again.
3335 *
3336 * All attributes contain a text representation of a numeric value
3337 * that are accessed with the get() and set() functions.
3338 */
3339#define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt) \
3340static int __fops ## _open(struct inode *inode, struct file *file) \
3341{ \
3342 __simple_attr_check_format(__fmt, 0ull); \
3343 return simple_attr_open(inode, file, __get, __set, __fmt); \
3344} \
Alexey Dobriyan828c0952009-10-01 15:43:56 -07003345static const struct file_operations __fops = { \
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003346 .owner = THIS_MODULE, \
3347 .open = __fops ## _open, \
Christoph Hellwig74bedc42008-02-08 04:20:28 -08003348 .release = simple_attr_release, \
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003349 .read = simple_attr_read, \
3350 .write = simple_attr_write, \
Arnd Bergmann1ec55842010-08-15 21:50:52 +02003351 .llseek = generic_file_llseek, \
Joe Perches68be3022014-08-06 16:08:45 -07003352}
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003353
Joe Perchesb9075fa2011-10-31 17:11:33 -07003354static inline __printf(1, 2)
3355void __simple_attr_check_format(const char *fmt, ...)
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003356{
3357 /* don't do anything, just let the compiler check the arguments; */
3358}
3359
3360int simple_attr_open(struct inode *inode, struct file *file,
Christoph Hellwig8b88b092008-02-08 04:20:26 -08003361 int (*get)(void *, u64 *), int (*set)(void *, u64),
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003362 const char *fmt);
Christoph Hellwig74bedc42008-02-08 04:20:28 -08003363int simple_attr_release(struct inode *inode, struct file *file);
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003364ssize_t simple_attr_read(struct file *file, char __user *buf,
3365 size_t len, loff_t *ppos);
3366ssize_t simple_attr_write(struct file *file, const char __user *buf,
3367 size_t len, loff_t *ppos);
3368
Alexey Dobriyan4be28542007-10-16 23:26:21 -07003369struct ctl_table;
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07003370int proc_nr_files(struct ctl_table *table, int write,
Christoph Hellwig32927392020-04-24 08:43:38 +02003371 void *buffer, size_t *lenp, loff_t *ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04003372int proc_nr_dentry(struct ctl_table *table, int write,
Christoph Hellwig32927392020-04-24 08:43:38 +02003373 void *buffer, size_t *lenp, loff_t *ppos);
Dave Chinnercffbc8a2010-10-23 05:03:02 -04003374int proc_nr_inodes(struct ctl_table *table, int write,
Christoph Hellwig32927392020-04-24 08:43:38 +02003375 void *buffer, size_t *lenp, loff_t *ppos);
Tetsuo Handa38e23c92009-04-09 20:17:52 +09003376int __init get_filesystem_list(char *buf);
Adrian Bunk62239ac2007-07-17 04:03:45 -07003377
Namhyung Kim3cd90ea2011-02-01 15:52:46 -08003378#define __FMODE_EXEC ((__force int) FMODE_EXEC)
Namhyung Kim1a44bc82011-02-01 15:52:46 -08003379#define __FMODE_NONOTIFY ((__force int) FMODE_NONOTIFY)
3380
Al Viro6d125522009-12-24 06:58:56 -05003381#define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE])
Eric Parisecf081d2009-12-17 21:24:25 -05003382#define OPEN_FMODE(flag) ((__force fmode_t)(((flag + 1) & O_ACCMODE) | \
Namhyung Kim1a44bc82011-02-01 15:52:46 -08003383 (flag & __FMODE_NONOTIFY)))
Al Viro53009902009-12-19 10:15:07 -05003384
Yaowei Baid37177b2015-11-19 21:00:12 +08003385static inline bool is_sxid(umode_t mode)
Andi Kleen69b45732011-05-28 08:25:51 -07003386{
3387 return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
3388}
3389
Miklos Szeredicbdf35b2014-10-24 00:14:36 +02003390static inline int check_sticky(struct inode *dir, struct inode *inode)
3391{
3392 if (!(dir->i_mode & S_ISVTX))
3393 return 0;
3394
3395 return __check_sticky(dir, inode);
3396}
3397
Andi Kleen69b45732011-05-28 08:25:51 -07003398static inline void inode_has_no_xattr(struct inode *inode)
3399{
David Howellse462ec52017-07-17 08:45:35 +01003400 if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & SB_NOSEC))
Andi Kleen69b45732011-05-28 08:25:51 -07003401 inode->i_flags |= S_NOSEC;
3402}
3403
Al Viroa7400222014-10-21 15:20:42 -04003404static inline bool is_root_inode(struct inode *inode)
3405{
3406 return inode == inode->i_sb->s_root->d_inode;
3407}
3408
Al Viro5f99f4e2013-05-15 20:23:06 -04003409static inline bool dir_emit(struct dir_context *ctx,
3410 const char *name, int namelen,
3411 u64 ino, unsigned type)
3412{
3413 return ctx->actor(ctx, name, namelen, ctx->pos, ino, type) == 0;
3414}
3415static inline bool dir_emit_dot(struct file *file, struct dir_context *ctx)
3416{
3417 return ctx->actor(ctx, ".", 1, ctx->pos,
3418 file->f_path.dentry->d_inode->i_ino, DT_DIR) == 0;
3419}
3420static inline bool dir_emit_dotdot(struct file *file, struct dir_context *ctx)
3421{
3422 return ctx->actor(ctx, "..", 2, ctx->pos,
3423 parent_ino(file->f_path.dentry), DT_DIR) == 0;
3424}
3425static inline bool dir_emit_dots(struct file *file, struct dir_context *ctx)
3426{
3427 if (ctx->pos == 0) {
3428 if (!dir_emit_dot(file, ctx))
3429 return false;
3430 ctx->pos = 1;
3431 }
3432 if (ctx->pos == 1) {
3433 if (!dir_emit_dotdot(file, ctx))
3434 return false;
3435 ctx->pos = 2;
3436 }
3437 return true;
3438}
Al Viro5ded75e2013-05-15 21:02:48 -04003439static inline bool dir_relax(struct inode *inode)
3440{
Al Viro59551022016-01-22 15:40:57 -05003441 inode_unlock(inode);
3442 inode_lock(inode);
Al Viro5ded75e2013-05-15 21:02:48 -04003443 return !IS_DEADDIR(inode);
3444}
Al Viro5f99f4e2013-05-15 20:23:06 -04003445
Al Viroae053272016-05-12 20:36:01 -04003446static inline bool dir_relax_shared(struct inode *inode)
3447{
3448 inode_unlock_shared(inode);
3449 inode_lock_shared(inode);
3450 return !IS_DEADDIR(inode);
3451}
3452
Eric W. Biederman90f85722015-06-29 14:42:03 -05003453extern bool path_noexec(const struct path *path);
Al Viro21fc61c2015-11-17 01:07:57 -05003454extern void inode_nohighmem(struct inode *inode);
Eric W. Biederman90f85722015-06-29 14:42:03 -05003455
Amir Goldstein45cd0fa2018-08-27 15:56:02 +03003456/* mm/fadvise.c */
3457extern int vfs_fadvise(struct file *file, loff_t offset, loff_t len,
3458 int advice);
Jan Karacf1ea052019-08-29 09:04:11 -07003459extern int generic_fadvise(struct file *file, loff_t offset, loff_t len,
3460 int advice);
Amir Goldstein45cd0fa2018-08-27 15:56:02 +03003461
Darrick J. Wong5aca2842019-07-01 08:25:34 -07003462int vfs_ioc_setflags_prepare(struct inode *inode, unsigned int oldflags,
3463 unsigned int flags);
3464
Darrick J. Wong7b0e4922019-07-01 08:25:35 -07003465int vfs_ioc_fssetxattr_check(struct inode *inode, const struct fsxattr *old_fa,
3466 struct fsxattr *fa);
3467
3468static inline void simple_fill_fsxattr(struct fsxattr *fa, __u32 xflags)
3469{
3470 memset(fa, 0, sizeof(*fa));
3471 fa->fsx_xflags = xflags;
3472}
3473
Darrick J. Wongdc617f22019-08-20 07:55:16 -07003474/*
3475 * Flush file data before changing attributes. Caller must hold any locks
3476 * required to prevent further writes to this file until we're done setting
3477 * flags.
3478 */
3479static inline int inode_drain_writes(struct inode *inode)
3480{
3481 inode_dio_wait(inode);
3482 return filemap_write_and_wait(inode->i_mapping);
3483}
3484
Linus Torvalds1da177e2005-04-16 15:20:36 -07003485#endif /* _LINUX_FS_H */