blob: 2f6f059d739c37efb025fb9f2443049c639eba5a [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_FS_H
2#define _LINUX_FS_H
3
Linus Torvalds1da177e2005-04-16 15:20:36 -07004#include <linux/linkage.h>
5#include <linux/wait.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006#include <linux/kdev_t.h>
7#include <linux/dcache.h>
Al Viro3f8206d2008-07-26 03:46:43 -04008#include <linux/path.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#include <linux/stat.h>
10#include <linux/cache.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#include <linux/list.h>
Dave Chinnerbc3b14c2013-08-28 10:17:58 +100012#include <linux/list_lru.h>
Oleg Nesterov4f5e65a2013-07-08 14:24:16 -070013#include <linux/llist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/radix-tree.h>
Michel Lespinasse6b2dbba2012-10-08 16:31:25 -070015#include <linux/rbtree.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/init.h>
Al Viro914e2632006-10-18 13:55:46 -040017#include <linux/pid.h>
Paul Gortmaker187f1882011-11-23 20:12:59 -050018#include <linux/bug.h>
Jes Sorensen1b1dcc12006-01-09 15:59:24 -080019#include <linux/mutex.h>
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080020#include <linux/rwsem.h>
Satyam Sharma3bd858a2007-07-17 15:00:08 +053021#include <linux/capability.h>
Matthew Wilcox6188e102008-04-18 22:21:05 -040022#include <linux/semaphore.h>
Mark Fashehc4b929b2008-10-08 19:44:18 -040023#include <linux/fiemap.h>
Nick Pigginceb5bdc2011-01-07 17:50:05 +110024#include <linux/rculist_bl.h>
Al Viro07b8ce12011-06-20 10:52:57 -040025#include <linux/atomic.h>
Konstantin Khlebnikov83aeead2011-12-08 14:33:54 -080026#include <linux/shrinker.h>
Stephen Rothwellc1aab022012-01-24 11:41:32 +110027#include <linux/migrate_mode.h>
Eric W. Biederman92361632012-02-08 07:07:50 -080028#include <linux/uidgid.h>
Jan Kara5accdf82012-06-12 16:20:34 +020029#include <linux/lockdep.h>
Jens Axboec2b1ad82012-09-27 09:35:03 +020030#include <linux/percpu-rwsem.h>
David Howells08cce05c2012-10-13 10:45:06 +010031#include <linux/blk_types.h>
Oleg Nesterov853b39a2015-07-22 20:21:13 +020032#include <linux/workqueue.h>
Oleg Nesterov8129ed22015-08-11 17:05:04 +020033#include <linux/percpu-rwsem.h>
Al Virofceef392015-12-29 15:58:39 -050034#include <linux/delayed_call.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include <asm/byteorder.h>
David Howells607ca462012-10-13 10:46:48 +010037#include <uapi/linux/fs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
Christoph Hellwigb83ae6d2015-01-14 10:42:37 +010039struct backing_dev_info;
Tejun Heo52ebea72015-05-22 17:13:37 -040040struct bdi_writeback;
Christoph Hellwiga5694252007-07-17 04:04:28 -070041struct export_operations;
Christoph Hellwiga885c8c2006-01-08 01:02:50 -080042struct hd_geometry;
Linus Torvalds1da177e2005-04-16 15:20:36 -070043struct iovec;
Christoph Hellwig92198f72005-06-23 22:00:59 -070044struct kiocb;
Alexey Dobriyan57cc7212011-01-10 08:18:25 +020045struct kobject;
Linus Torvalds1da177e2005-04-16 15:20:36 -070046struct pipe_inode_info;
47struct poll_table_struct;
48struct kstatfs;
49struct vm_area_struct;
50struct vfsmount;
David Howells745ca242008-11-14 10:39:22 +110051struct cred;
Mel Gormana509bc12012-07-31 16:44:57 -070052struct swap_info_struct;
Cyrill Gorcunov55985dd2012-12-17 16:04:55 -080053struct seq_file;
Christoph Hellwig7b7a8662013-09-04 15:04:39 +020054struct workqueue_struct;
Al Viro3b93f912014-02-11 21:34:08 -050055struct iov_iter;
Jaegeuk Kim0b81d072015-05-15 16:26:10 -070056struct fscrypt_info;
57struct fscrypt_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -070058
Denis Cheng74bf17c2007-10-16 23:26:30 -070059extern void __init inode_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070060extern void __init inode_init_early(void);
Mel Gorman4248b0d2015-08-06 15:46:20 -070061extern void __init files_init(void);
62extern void __init files_maxfiles_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
Jan Engelhardtdded4f42008-12-01 14:34:50 -080064extern struct files_stat_struct files_stat;
Eric Dumazet518de9b2010-10-26 14:22:44 -070065extern unsigned long get_max_files(void);
Alexey Dobriyan9b80a182016-09-02 00:38:52 +030066extern unsigned int sysctl_nr_open;
Jan Engelhardtdded4f42008-12-01 14:34:50 -080067extern struct inodes_stat_t inodes_stat;
68extern int leases_enable, lease_break_time;
Kees Cook800179c2012-07-25 17:29:07 -070069extern int sysctl_protected_symlinks;
70extern int sysctl_protected_hardlinks;
Jan Engelhardtdded4f42008-12-01 14:34:50 -080071
Linus Torvalds1da177e2005-04-16 15:20:36 -070072struct buffer_head;
73typedef int (get_block_t)(struct inode *inode, sector_t iblock,
74 struct buffer_head *bh_result, int create);
Christoph Hellwig187372a2016-02-08 14:40:51 +110075typedef int (dio_iodone_t)(struct kiocb *iocb, loff_t offset,
Christoph Hellwig7b7a8662013-09-04 15:04:39 +020076 ssize_t bytes, void *private);
Linus Torvalds1da177e2005-04-16 15:20:36 -070077
David Howellsbbc10962012-10-15 16:40:35 +010078#define MAY_EXEC 0x00000001
79#define MAY_WRITE 0x00000002
80#define MAY_READ 0x00000004
81#define MAY_APPEND 0x00000008
82#define MAY_ACCESS 0x00000010
83#define MAY_OPEN 0x00000020
84#define MAY_CHDIR 0x00000040
85/* called from RCU mode, don't block */
86#define MAY_NOT_BLOCK 0x00000080
87
88/*
89 * flags in file.f_mode. Note that FMODE_READ and FMODE_WRITE must correspond
90 * to O_WRONLY and O_RDWR via the strange trick in __dentry_open()
91 */
92
93/* file is open for reading */
94#define FMODE_READ ((__force fmode_t)0x1)
95/* file is open for writing */
96#define FMODE_WRITE ((__force fmode_t)0x2)
97/* file is seekable */
98#define FMODE_LSEEK ((__force fmode_t)0x4)
99/* file can be accessed using pread */
100#define FMODE_PREAD ((__force fmode_t)0x8)
101/* file can be accessed using pwrite */
102#define FMODE_PWRITE ((__force fmode_t)0x10)
103/* File is opened for execution with sys_execve / sys_uselib */
104#define FMODE_EXEC ((__force fmode_t)0x20)
105/* File is opened with O_NDELAY (only set for block devices) */
106#define FMODE_NDELAY ((__force fmode_t)0x40)
107/* File is opened with O_EXCL (only set for block devices) */
108#define FMODE_EXCL ((__force fmode_t)0x80)
109/* File is opened using open(.., 3, ..) and is writeable only for ioctls
110 (specialy hack for floppy.c) */
111#define FMODE_WRITE_IOCTL ((__force fmode_t)0x100)
112/* 32bit hashes as llseek() offset (for directories) */
113#define FMODE_32BITHASH ((__force fmode_t)0x200)
114/* 64bit hashes as llseek() offset (for directories) */
115#define FMODE_64BITHASH ((__force fmode_t)0x400)
116
117/*
118 * Don't update ctime and mtime.
119 *
120 * Currently a special hack for the XFS open_by_handle ioctl, but we'll
121 * hopefully graduate it to a proper O_CMTIME flag supported by open(2) soon.
122 */
123#define FMODE_NOCMTIME ((__force fmode_t)0x800)
124
125/* Expect random access pattern */
126#define FMODE_RANDOM ((__force fmode_t)0x1000)
127
128/* File is huge (eg. /dev/kmem): treat loff_t as unsigned */
129#define FMODE_UNSIGNED_OFFSET ((__force fmode_t)0x2000)
130
131/* File is opened with O_PATH; almost nothing can be done with it */
132#define FMODE_PATH ((__force fmode_t)0x4000)
133
Linus Torvalds9c225f22014-03-03 09:36:58 -0800134/* File needs atomic accesses to f_pos */
135#define FMODE_ATOMIC_POS ((__force fmode_t)0x8000)
Al Viro83f936c2014-03-14 12:02:47 -0400136/* Write access to underlying fs */
137#define FMODE_WRITER ((__force fmode_t)0x10000)
Al Viro7f7f25e2014-02-11 17:49:24 -0500138/* Has read method(s) */
139#define FMODE_CAN_READ ((__force fmode_t)0x20000)
140/* Has write method(s) */
141#define FMODE_CAN_WRITE ((__force fmode_t)0x40000)
Linus Torvalds9c225f22014-03-03 09:36:58 -0800142
David Howellsbbc10962012-10-15 16:40:35 +0100143/* File was opened by fanotify and shouldn't generate fanotify events */
David Drysdale75069f22015-01-08 14:32:29 -0800144#define FMODE_NONOTIFY ((__force fmode_t)0x4000000)
David Howellsbbc10962012-10-15 16:40:35 +0100145
146/*
147 * Flag for rw_copy_check_uvector and compat_rw_copy_check_uvector
148 * that indicates that they should check the contents of the iovec are
149 * valid, but not check the memory that the iovec elements
150 * points too.
151 */
152#define CHECK_IOVEC_ONLY -1
153
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154/*
Mike Christie4e1b2d522016-06-05 14:32:22 -0500155 * The below are the various read and write flags that we support. Some of
David Howells08cce05c2012-10-13 10:45:06 +0100156 * them include behavioral modifiers that send information down to the
Mike Christie4e1b2d522016-06-05 14:32:22 -0500157 * block layer and IO scheduler. They should be used along with a req_op.
158 * Terminology:
David Howells08cce05c2012-10-13 10:45:06 +0100159 *
160 * The block layer uses device plugging to defer IO a little bit, in
161 * the hope that we will see more IO very shortly. This increases
162 * coalescing of adjacent IO and thus reduces the number of IOs we
163 * have to send to the device. It also allows for better queuing,
164 * if the IO isn't mergeable. If the caller is going to be waiting
165 * for the IO, then he must ensure that the device is unplugged so
166 * that the IO is dispatched to the driver.
167 *
168 * All IO is handled async in Linux. This is fine for background
169 * writes, but for reads or writes that someone waits for completion
170 * on, we want to notify the block layer and IO scheduler so that they
171 * know about it. That allows them to make better scheduling
172 * decisions. So when the below references 'sync' and 'async', it
173 * is referencing this priority hint.
174 *
175 * With that in mind, the available types are:
176 *
177 * READ A normal read operation. Device will be plugged.
178 * READ_SYNC A synchronous read. Device is not plugged, caller can
179 * immediately wait on this read without caring about
180 * unplugging.
David Howells08cce05c2012-10-13 10:45:06 +0100181 * WRITE A normal async write. Device will be plugged.
182 * WRITE_SYNC Synchronous write. Identical to WRITE, but passes down
183 * the hint that someone will be waiting on this IO
184 * shortly. The write equivalent of READ_SYNC.
185 * WRITE_ODIRECT Special case write for O_DIRECT only.
186 * WRITE_FLUSH Like WRITE_SYNC but with preceding cache flush.
187 * WRITE_FUA Like WRITE_SYNC but data is guaranteed to be on
188 * non-volatile media on completion.
189 * WRITE_FLUSH_FUA Combination of WRITE_FLUSH and FUA. The IO is preceded
190 * by a cache flush and data is guaranteed to be on
191 * non-volatile media on completion.
192 *
193 */
Mike Christie4e1b2d522016-06-05 14:32:22 -0500194#define RW_MASK REQ_OP_WRITE
David Howells08cce05c2012-10-13 10:45:06 +0100195
Mike Christie4e1b2d522016-06-05 14:32:22 -0500196#define READ REQ_OP_READ
Christoph Hellwig70246282016-07-19 11:28:41 +0200197#define WRITE REQ_OP_WRITE
David Howells08cce05c2012-10-13 10:45:06 +0100198
Mike Christie4e1b2d522016-06-05 14:32:22 -0500199#define READ_SYNC REQ_SYNC
200#define WRITE_SYNC (REQ_SYNC | REQ_NOIDLE)
201#define WRITE_ODIRECT REQ_SYNC
Mike Christie28a8f0d2016-06-05 14:32:25 -0500202#define WRITE_FLUSH (REQ_SYNC | REQ_NOIDLE | REQ_PREFLUSH)
Mike Christie4e1b2d522016-06-05 14:32:22 -0500203#define WRITE_FUA (REQ_SYNC | REQ_NOIDLE | REQ_FUA)
Mike Christie28a8f0d2016-06-05 14:32:25 -0500204#define WRITE_FLUSH_FUA (REQ_SYNC | REQ_NOIDLE | REQ_PREFLUSH | REQ_FUA)
David Howells08cce05c2012-10-13 10:45:06 +0100205
206/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 * Attribute flags. These should be or-ed together to figure out what
208 * has been changed!
209 */
Miklos Szeredi9767d742008-07-01 15:01:26 +0200210#define ATTR_MODE (1 << 0)
211#define ATTR_UID (1 << 1)
212#define ATTR_GID (1 << 2)
213#define ATTR_SIZE (1 << 3)
214#define ATTR_ATIME (1 << 4)
215#define ATTR_MTIME (1 << 5)
216#define ATTR_CTIME (1 << 6)
217#define ATTR_ATIME_SET (1 << 7)
218#define ATTR_MTIME_SET (1 << 8)
219#define ATTR_FORCE (1 << 9) /* Not a change, but a change it */
220#define ATTR_ATTR_FLAG (1 << 10)
221#define ATTR_KILL_SUID (1 << 11)
222#define ATTR_KILL_SGID (1 << 12)
223#define ATTR_FILE (1 << 13)
224#define ATTR_KILL_PRIV (1 << 14)
225#define ATTR_OPEN (1 << 15) /* Truncating from open(O_TRUNC) */
226#define ATTR_TIMES_SET (1 << 16)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227
228/*
Miklos Szeredi787fb6b2014-10-24 00:14:36 +0200229 * Whiteout is represented by a char device. The following constants define the
230 * mode and device number to use.
231 */
232#define WHITEOUT_MODE 0
233#define WHITEOUT_DEV 0
234
235/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 * This is the Inode Attributes structure, used for notify_change(). It
237 * uses the above definitions as flags, to know which values have changed.
238 * Also, in this manner, a Filesystem can look at only the values it cares
239 * about. Basically, these are the attributes that the VFS layer can
240 * request to change from the FS layer.
241 *
242 * Derek Atkins <warlord@MIT.EDU> 94-10-20
243 */
244struct iattr {
245 unsigned int ia_valid;
246 umode_t ia_mode;
Eric W. Biederman92361632012-02-08 07:07:50 -0800247 kuid_t ia_uid;
248 kgid_t ia_gid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 loff_t ia_size;
250 struct timespec ia_atime;
251 struct timespec ia_mtime;
252 struct timespec ia_ctime;
Miklos Szeredicc4e69d2005-11-07 00:59:49 -0800253
254 /*
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300255 * Not an attribute, but an auxiliary info for filesystems wanting to
Miklos Szeredicc4e69d2005-11-07 00:59:49 -0800256 * implement an ftruncate() like method. NOTE: filesystem should
257 * check for (ia_valid & ATTR_FILE), and not for (ia_file != NULL).
258 */
259 struct file *ia_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260};
261
262/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 * Includes for diskquotas.
264 */
265#include <linux/quota.h>
266
Miklos Szeredi69c433e2014-10-24 00:14:39 +0200267/*
268 * Maximum number of layers of fs stack. Needs to be limited to
269 * prevent kernel stack overflow
270 */
271#define FILESYSTEM_MAX_STACK_DEPTH 2
272
Zach Brown994fc28c2005-12-15 14:28:17 -0800273/**
274 * enum positive_aop_returns - aop return codes with specific semantics
275 *
276 * @AOP_WRITEPAGE_ACTIVATE: Informs the caller that page writeback has
277 * completed, that the page is still locked, and
278 * should be considered active. The VM uses this hint
279 * to return the page to the active list -- it won't
280 * be a candidate for writeback again in the near
281 * future. Other callers must be careful to unlock
282 * the page if they get this return. Returned by
283 * writepage();
284 *
285 * @AOP_TRUNCATED_PAGE: The AOP method that was handed a locked page has
286 * unlocked it and the page might have been truncated.
287 * The caller should back up to acquiring a new page and
288 * trying again. The aop will be taking reasonable
289 * precautions not to livelock. If the caller held a page
290 * reference, it should drop it before retrying. Returned
Nick Piggin55144762007-10-16 01:25:26 -0700291 * by readpage().
Zach Brown994fc28c2005-12-15 14:28:17 -0800292 *
293 * address_space_operation functions return these large constants to indicate
294 * special semantics to the caller. These are much larger than the bytes in a
295 * page to allow for functions that return the number of bytes operated on in a
296 * given page.
297 */
298
299enum positive_aop_returns {
300 AOP_WRITEPAGE_ACTIVATE = 0x80000,
301 AOP_TRUNCATED_PAGE = 0x80001,
302};
303
Nick Pigginafddba42007-10-16 01:25:01 -0700304#define AOP_FLAG_UNINTERRUPTIBLE 0x0001 /* will not do a short write */
Nick Piggin89e10782007-10-16 01:25:07 -0700305#define AOP_FLAG_CONT_EXPAND 0x0002 /* called from cont_expand */
Nick Piggin54566b22009-01-04 12:00:53 -0800306#define AOP_FLAG_NOFS 0x0004 /* used by filesystem to direct
307 * helper code (eg buffer layer)
308 * to clear GFP_FS from alloc */
Nick Pigginafddba42007-10-16 01:25:01 -0700309
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310/*
311 * oh the beauties of C type declarations.
312 */
313struct page;
314struct address_space;
315struct writeback_control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800317#define IOCB_EVENTFD (1 << 0)
Al Viro2ba48ce2015-04-09 13:52:01 -0400318#define IOCB_APPEND (1 << 1)
319#define IOCB_DIRECT (1 << 2)
Christoph Hellwig97be7eb2016-03-03 16:04:01 +0100320#define IOCB_HIPRI (1 << 3)
Christoph Hellwigdde0c2e2016-04-07 08:52:00 -0700321#define IOCB_DSYNC (1 << 4)
322#define IOCB_SYNC (1 << 5)
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800323
324struct kiocb {
325 struct file *ki_filp;
326 loff_t ki_pos;
327 void (*ki_complete)(struct kiocb *iocb, long ret, long ret2);
328 void *private;
329 int ki_flags;
330};
331
332static inline bool is_sync_kiocb(struct kiocb *kiocb)
333{
334 return kiocb->ki_complete == NULL;
335}
336
Al Viro2ba48ce2015-04-09 13:52:01 -0400337static inline int iocb_flags(struct file *file);
338
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800339static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
340{
341 *kiocb = (struct kiocb) {
342 .ki_filp = filp,
Al Viro2ba48ce2015-04-09 13:52:01 -0400343 .ki_flags = iocb_flags(filp),
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800344 };
345}
346
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -0700347/*
348 * "descriptor" for what we're up to with a read.
349 * This allows us to use the same read code yet
350 * have multiple different users of the data that
351 * we read from a file.
352 *
353 * The simplest case just copies the data to user
354 * mode.
355 */
356typedef struct {
357 size_t written;
358 size_t count;
359 union {
360 char __user *buf;
361 void *data;
362 } arg;
363 int error;
364} read_descriptor_t;
365
366typedef int (*read_actor_t)(read_descriptor_t *, struct page *,
367 unsigned long, unsigned long);
Nick Piggin2f718ff2007-10-16 01:24:59 -0700368
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369struct address_space_operations {
370 int (*writepage)(struct page *page, struct writeback_control *wbc);
371 int (*readpage)(struct file *, struct page *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372
373 /* Write back some dirty pages from this mapping. */
374 int (*writepages)(struct address_space *, struct writeback_control *);
375
Andrew Morton4741c9f2006-03-24 03:18:11 -0800376 /* Set a page dirty. Return true if this dirtied it */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 int (*set_page_dirty)(struct page *page);
378
379 int (*readpages)(struct file *filp, struct address_space *mapping,
380 struct list_head *pages, unsigned nr_pages);
381
Nick Pigginafddba42007-10-16 01:25:01 -0700382 int (*write_begin)(struct file *, struct address_space *mapping,
383 loff_t pos, unsigned len, unsigned flags,
384 struct page **pagep, void **fsdata);
385 int (*write_end)(struct file *, struct address_space *mapping,
386 loff_t pos, unsigned len, unsigned copied,
387 struct page *page, void *fsdata);
388
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389 /* Unfortunately this kludge is needed for FIBMAP. Don't use it */
390 sector_t (*bmap)(struct address_space *, sector_t);
Lukas Czernerd47992f2013-05-21 23:17:23 -0400391 void (*invalidatepage) (struct page *, unsigned int, unsigned int);
Al Viro27496a82005-10-21 03:20:48 -0400392 int (*releasepage) (struct page *, gfp_t);
Linus Torvalds6072d132010-12-01 13:35:19 -0500393 void (*freepage)(struct page *);
Christoph Hellwigc8b8e322016-04-07 08:51:58 -0700394 ssize_t (*direct_IO)(struct kiocb *, struct iov_iter *iter);
Mel Gormanb969c4ab2012-01-12 17:19:34 -0800395 /*
Tang Chenef277c72013-07-08 16:00:21 -0700396 * migrate the contents of a page to the specified target. If
397 * migrate_mode is MIGRATE_ASYNC, it must not block.
Mel Gormanb969c4ab2012-01-12 17:19:34 -0800398 */
Christoph Lameter2d1db3b2006-06-23 02:03:33 -0700399 int (*migratepage) (struct address_space *,
Mel Gormana6bc32b2012-01-12 17:19:43 -0800400 struct page *, struct page *, enum migrate_mode);
Minchan Kimbda807d2016-07-26 15:23:05 -0700401 bool (*isolate_page)(struct page *, isolate_mode_t);
402 void (*putback_page)(struct page *);
Trond Myklebuste3db7692007-01-10 23:15:39 -0800403 int (*launder_page) (struct page *);
Al Viroc186afb42014-02-02 21:16:54 -0500404 int (*is_partially_uptodate) (struct page *, unsigned long,
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -0700405 unsigned long);
Mel Gormanb4597222013-07-03 15:02:05 -0700406 void (*is_dirty_writeback) (struct page *, bool *, bool *);
Andi Kleen25718732009-09-16 11:50:13 +0200407 int (*error_remove_page)(struct address_space *, struct page *);
Mel Gorman62c230b2012-07-31 16:44:55 -0700408
409 /* swapfile support */
Mel Gormana509bc12012-07-31 16:44:57 -0700410 int (*swap_activate)(struct swap_info_struct *sis, struct file *file,
411 sector_t *span);
412 void (*swap_deactivate)(struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413};
414
Jens Axboe7dcda1c2011-04-05 23:51:48 +0200415extern const struct address_space_operations empty_aops;
416
Nick Pigginafddba42007-10-16 01:25:01 -0700417/*
418 * pagecache_write_begin/pagecache_write_end must be used by general code
419 * to write into the pagecache.
420 */
421int pagecache_write_begin(struct file *, struct address_space *mapping,
422 loff_t pos, unsigned len, unsigned flags,
423 struct page **pagep, void **fsdata);
424
425int pagecache_write_end(struct file *, struct address_space *mapping,
426 loff_t pos, unsigned len, unsigned copied,
427 struct page *page, void *fsdata);
428
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429struct address_space {
430 struct inode *host; /* owner: inode, block_device */
431 struct radix_tree_root page_tree; /* radix tree of all pages */
Nick Piggin19fd6232008-07-25 19:45:32 -0700432 spinlock_t tree_lock; /* and lock protecting it */
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700433 atomic_t i_mmap_writable;/* count VM_SHARED mappings */
Michel Lespinasse6b2dbba2012-10-08 16:31:25 -0700434 struct rb_root i_mmap; /* tree of private and shared mappings */
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800435 struct rw_semaphore i_mmap_rwsem; /* protect tree, count, list */
Jan Kara08142572011-06-27 16:18:10 -0700436 /* Protected by tree_lock together with the radix tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 unsigned long nrpages; /* number of total pages */
Ross Zwislerf9fe48b2016-01-22 15:10:40 -0800438 /* number of shadow or DAX exceptional entries */
439 unsigned long nrexceptional;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 pgoff_t writeback_index;/* writeback starts here */
Christoph Hellwigf5e54d62006-06-28 04:26:44 -0700441 const struct address_space_operations *a_ops; /* methods */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 unsigned long flags; /* error bits/gfp mask */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 spinlock_t private_lock; /* for use by the address_space */
444 struct list_head private_list; /* ditto */
Rafael Aquini252aa6f2012-12-11 16:02:35 -0800445 void *private_data; /* ditto */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446} __attribute__((aligned(sizeof(long))));
447 /*
448 * On most architectures that alignment is already the case; but
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300449 * must be enforced here for CRIS, to let the least significant bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 * of struct page's "mapping" pointer be used for PAGE_MAPPING_ANON.
451 */
Andi Kleen87192a22012-01-12 17:20:34 -0800452struct request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453
454struct block_device {
455 dev_t bd_dev; /* not a kdev_t - it's a search key */
Richard Kennedyf3ccfcd2011-03-22 16:33:56 -0700456 int bd_openers;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 struct inode * bd_inode; /* will die */
Theodore Ts'o87d8fe12009-01-03 09:47:09 -0500458 struct super_block * bd_super;
Arjan van de Venc039e312006-03-23 03:00:28 -0800459 struct mutex bd_mutex; /* open/close mutex */
Tejun Heo6b4517a2010-04-07 18:53:59 +0900460 void * bd_claiming;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 void * bd_holder;
462 int bd_holders;
Tejun Heo77ea8872010-12-08 20:57:37 +0100463 bool bd_write_holder;
Jun'ichi Nomura641dc632006-03-27 01:17:57 -0800464#ifdef CONFIG_SYSFS
Tejun Heo49731ba2011-01-14 18:43:57 +0100465 struct list_head bd_holder_disks;
Jun'ichi Nomura641dc632006-03-27 01:17:57 -0800466#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 struct block_device * bd_contains;
468 unsigned bd_block_size;
469 struct hd_struct * bd_part;
470 /* number of times partitions within this device have been opened. */
471 unsigned bd_part_count;
472 int bd_invalidated;
473 struct gendisk * bd_disk;
Andi Kleen87192a22012-01-12 17:20:34 -0800474 struct request_queue * bd_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475 struct list_head bd_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 /*
477 * Private data. You must have bd_claim'ed the block_device
478 * to use this. NOTE: bd_claim allows an owner to claim
479 * the same device multiple times, the owner must take special
480 * care to not mess up bd_private for that case.
481 */
482 unsigned long bd_private;
Takashi Satofcccf502009-01-09 16:40:59 -0800483
484 /* The counter of freeze processes */
485 int bd_fsfreeze_count;
486 /* Mutex for freeze */
487 struct mutex bd_fsfreeze_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488};
489
490/*
491 * Radix-tree tags, for tagging dirty and writeback pages within the pagecache
492 * radix trees
493 */
494#define PAGECACHE_TAG_DIRTY 0
495#define PAGECACHE_TAG_WRITEBACK 1
Jan Karaf446daae2010-08-09 17:19:12 -0700496#define PAGECACHE_TAG_TOWRITE 2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497
498int mapping_tagged(struct address_space *mapping, int tag);
499
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800500static inline void i_mmap_lock_write(struct address_space *mapping)
501{
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800502 down_write(&mapping->i_mmap_rwsem);
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800503}
504
505static inline void i_mmap_unlock_write(struct address_space *mapping)
506{
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800507 up_write(&mapping->i_mmap_rwsem);
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800508}
509
Davidlohr Bueso3dec0ba2014-12-12 16:54:27 -0800510static inline void i_mmap_lock_read(struct address_space *mapping)
511{
512 down_read(&mapping->i_mmap_rwsem);
513}
514
515static inline void i_mmap_unlock_read(struct address_space *mapping)
516{
517 up_read(&mapping->i_mmap_rwsem);
518}
519
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520/*
521 * Might pages of this file be mapped into userspace?
522 */
523static inline int mapping_mapped(struct address_space *mapping)
524{
Kirill A. Shutemov27ba0642015-02-10 14:09:59 -0800525 return !RB_EMPTY_ROOT(&mapping->i_mmap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526}
527
528/*
529 * Might pages of this file have been modified in userspace?
530 * Note that i_mmap_writable counts all VM_SHARED vmas: do_mmap_pgoff
531 * marks vma as VM_SHARED if it is shared, and the file was opened for
532 * writing i.e. vma may be mprotected writable even if now readonly.
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700533 *
534 * If i_mmap_writable is negative, no new writable mappings are allowed. You
535 * can only deny writable mappings, if none exists right now.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 */
537static inline int mapping_writably_mapped(struct address_space *mapping)
538{
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700539 return atomic_read(&mapping->i_mmap_writable) > 0;
540}
541
542static inline int mapping_map_writable(struct address_space *mapping)
543{
544 return atomic_inc_unless_negative(&mapping->i_mmap_writable) ?
545 0 : -EPERM;
546}
547
548static inline void mapping_unmap_writable(struct address_space *mapping)
549{
550 atomic_dec(&mapping->i_mmap_writable);
551}
552
553static inline int mapping_deny_writable(struct address_space *mapping)
554{
555 return atomic_dec_unless_positive(&mapping->i_mmap_writable) ?
556 0 : -EBUSY;
557}
558
559static inline void mapping_allow_writable(struct address_space *mapping)
560{
561 atomic_inc(&mapping->i_mmap_writable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562}
563
564/*
565 * Use sequence counter to get consistent i_size on 32-bit processors.
566 */
567#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
568#include <linux/seqlock.h>
569#define __NEED_I_SIZE_ORDERED
570#define i_size_ordered_init(inode) seqcount_init(&inode->i_size_seqcount)
571#else
572#define i_size_ordered_init(inode) do { } while (0)
573#endif
574
Al Virof19d4a82009-06-08 19:50:45 -0400575struct posix_acl;
576#define ACL_NOT_CACHED ((void *)(-1))
Miklos Szeredi2a3a2a32016-09-01 11:11:59 +0200577#define ACL_DONT_CACHE ((void *)(-3))
Al Virof19d4a82009-06-08 19:50:45 -0400578
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100579static inline struct posix_acl *
580uncached_acl_sentinel(struct task_struct *task)
581{
582 return (void *)task + 1;
583}
584
585static inline bool
586is_uncached_acl(struct posix_acl *acl)
587{
588 return (long)acl & 1;
589}
590
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700591#define IOP_FASTPERM 0x0001
592#define IOP_LOOKUP 0x0002
593#define IOP_NOFOLLOW 0x0004
594
595/*
596 * Keep mostly read-only and often accessed (especially for
597 * the RCU path lookup and 'stat' data) fields at the beginning
598 * of the 'struct inode'
599 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600struct inode {
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100601 umode_t i_mode;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700602 unsigned short i_opflags;
Eric W. Biederman92361632012-02-08 07:07:50 -0800603 kuid_t i_uid;
604 kgid_t i_gid;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700605 unsigned int i_flags;
606
607#ifdef CONFIG_FS_POSIX_ACL
608 struct posix_acl *i_acl;
609 struct posix_acl *i_default_acl;
610#endif
611
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100612 const struct inode_operations *i_op;
613 struct super_block *i_sb;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700614 struct address_space *i_mapping;
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100615
Linus Torvalds13e12d12011-06-08 15:18:19 -0700616#ifdef CONFIG_SECURITY
617 void *i_security;
618#endif
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100619
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700620 /* Stat data, not accessed from path walking */
621 unsigned long i_ino;
Miklos Szeredia78ef702011-10-28 14:13:30 +0200622 /*
623 * Filesystems may only read i_nlink directly. They shall use the
624 * following functions for modification:
625 *
626 * (set|clear|inc|drop)_nlink
627 * inode_(inc|dec)_link_count
628 */
629 union {
630 const unsigned int i_nlink;
631 unsigned int __i_nlink;
632 };
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700633 dev_t i_rdev;
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700634 loff_t i_size;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700635 struct timespec i_atime;
636 struct timespec i_mtime;
637 struct timespec i_ctime;
Theodore Ts'o6cdbb0e2011-10-29 08:24:18 -0400638 spinlock_t i_lock; /* i_blocks, i_bytes, maybe i_size */
639 unsigned short i_bytes;
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700640 unsigned int i_blkbits;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700641 blkcnt_t i_blocks;
642
643#ifdef __NEED_I_SIZE_ORDERED
644 seqcount_t i_size_seqcount;
645#endif
646
647 /* Misc */
648 unsigned long i_state;
Al Viro9902af72016-04-15 15:08:36 -0400649 struct rw_semaphore i_rwsem;
Linus Torvalds13e12d12011-06-08 15:18:19 -0700650
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100651 unsigned long dirtied_when; /* jiffies of first dirtying */
Theodore Ts'oa2f48702015-03-17 12:23:19 -0400652 unsigned long dirtied_time_when;
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100653
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 struct hlist_node i_hash;
Dave Chinnerc7f54082015-03-04 14:07:22 -0500655 struct list_head i_io_list; /* backing dev IO list */
Tejun Heo52ebea72015-05-22 17:13:37 -0400656#ifdef CONFIG_CGROUP_WRITEBACK
657 struct bdi_writeback *i_wb; /* the associated cgroup wb */
Tejun Heo2a814902015-05-28 14:50:51 -0400658
659 /* foreign inode detection, see wbc_detach_inode() */
660 int i_wb_frn_winner;
661 u16 i_wb_frn_avg_time;
662 u16 i_wb_frn_history;
Tejun Heo52ebea72015-05-22 17:13:37 -0400663#endif
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100664 struct list_head i_lru; /* inode LRU list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665 struct list_head i_sb_list;
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700666 struct list_head i_wb_list; /* backing dev writeback list */
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100667 union {
Al Virob3d9b7a2012-06-09 13:51:19 -0400668 struct hlist_head i_dentry;
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100669 struct rcu_head i_rcu;
670 };
Jean Noel Cordenner7a224222008-01-28 23:58:27 -0500671 u64 i_version;
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700672 atomic_t i_count;
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -0400673 atomic_t i_dio_count;
Theodore Ts'o6cdbb0e2011-10-29 08:24:18 -0400674 atomic_t i_writecount;
Mimi Zohard984ea62013-12-11 15:20:54 -0500675#ifdef CONFIG_IMA
676 atomic_t i_readcount; /* struct files open RO */
677#endif
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800678 const struct file_operations *i_fop; /* former ->i_op->default_file_ops */
Jeff Layton4a075e32015-01-16 15:05:54 -0500679 struct file_lock_context *i_flctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 struct address_space i_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 struct list_head i_devices;
Theodore Ts'o4c154162006-09-27 01:50:47 -0700682 union {
683 struct pipe_inode_info *i_pipe;
Theodore Ts'oeaf796e2006-09-27 01:50:48 -0700684 struct block_device *i_bdev;
Theodore Ts'o577c4eb2006-09-27 01:50:49 -0700685 struct cdev *i_cdev;
Al Viro61ba64f2015-05-02 09:54:06 -0400686 char *i_link;
Al Viro84e710d2016-04-15 00:58:55 -0400687 unsigned i_dir_seq;
Theodore Ts'o4c154162006-09-27 01:50:47 -0700688 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689
690 __u32 i_generation;
691
Eric Paris3be25f42009-05-21 17:01:26 -0400692#ifdef CONFIG_FSNOTIFY
693 __u32 i_fsnotify_mask; /* all events this inode cares about */
Eric Parise61ce862009-12-17 21:24:24 -0500694 struct hlist_head i_fsnotify_marks;
Robert Love0eeca282005-07-12 17:06:03 -0400695#endif
696
Jaegeuk Kim0b81d072015-05-15 16:26:10 -0700697#if IS_ENABLED(CONFIG_FS_ENCRYPTION)
698 struct fscrypt_info *i_crypt_info;
699#endif
700
Theodore Ts'o8e18e292006-09-27 01:50:46 -0700701 void *i_private; /* fs or device private pointer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702};
703
Al Viro1d3382cb2010-10-23 15:19:20 -0400704static inline int inode_unhashed(struct inode *inode)
705{
706 return hlist_unhashed(&inode->i_hash);
707}
708
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709/*
Ingo Molnarf2eace22006-07-03 00:25:05 -0700710 * inode->i_mutex nesting subclasses for the lock validator:
711 *
712 * 0: the object of the current VFS operation
713 * 1: parent
714 * 2: child/target
J. Bruce Fields40bd22c2012-04-18 15:21:34 -0400715 * 3: xattr
716 * 4: second non-directory
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100717 * 5: second parent (when locking independent directories in rename)
718 *
719 * I_MUTEX_NONDIR2 is for certain operations (such as rename) which lock two
J. Bruce Fields40bd22c2012-04-18 15:21:34 -0400720 * non-directories at once.
Ingo Molnarf2eace22006-07-03 00:25:05 -0700721 *
722 * The locking order between these classes is
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100723 * parent[2] -> child -> grandchild -> normal -> xattr -> second non-directory
Ingo Molnarf2eace22006-07-03 00:25:05 -0700724 */
725enum inode_i_mutex_lock_class
726{
727 I_MUTEX_NORMAL,
728 I_MUTEX_PARENT,
729 I_MUTEX_CHILD,
Ingo Molnar4df46242006-08-27 01:23:56 -0700730 I_MUTEX_XATTR,
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100731 I_MUTEX_NONDIR2,
732 I_MUTEX_PARENT2,
Ingo Molnarf2eace22006-07-03 00:25:05 -0700733};
734
Al Viro59551022016-01-22 15:40:57 -0500735static inline void inode_lock(struct inode *inode)
736{
Al Viro9902af72016-04-15 15:08:36 -0400737 down_write(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500738}
739
740static inline void inode_unlock(struct inode *inode)
741{
Al Viro9902af72016-04-15 15:08:36 -0400742 up_write(&inode->i_rwsem);
743}
744
745static inline void inode_lock_shared(struct inode *inode)
746{
747 down_read(&inode->i_rwsem);
748}
749
750static inline void inode_unlock_shared(struct inode *inode)
751{
752 up_read(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500753}
754
755static inline int inode_trylock(struct inode *inode)
756{
Al Viro9902af72016-04-15 15:08:36 -0400757 return down_write_trylock(&inode->i_rwsem);
758}
759
760static inline int inode_trylock_shared(struct inode *inode)
761{
762 return down_read_trylock(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500763}
764
765static inline int inode_is_locked(struct inode *inode)
766{
Al Viro9902af72016-04-15 15:08:36 -0400767 return rwsem_is_locked(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500768}
769
770static inline void inode_lock_nested(struct inode *inode, unsigned subclass)
771{
Al Viro9902af72016-04-15 15:08:36 -0400772 down_write_nested(&inode->i_rwsem, subclass);
Al Viro59551022016-01-22 15:40:57 -0500773}
774
J. Bruce Fields375e2892012-04-18 15:16:33 -0400775void lock_two_nondirectories(struct inode *, struct inode*);
776void unlock_two_nondirectories(struct inode *, struct inode*);
777
Ingo Molnarf2eace22006-07-03 00:25:05 -0700778/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 * NOTE: in a 32bit arch with a preemptable kernel and
780 * an UP compile the i_size_read/write must be atomic
781 * with respect to the local cpu (unlike with preempt disabled),
782 * but they don't need to be atomic with respect to other cpus like in
783 * true SMP (so they need either to either locally disable irq around
784 * the read or for example on x86 they can be still implemented as a
785 * cmpxchg8b without the need of the lock prefix). For SMP compiles
786 * and 64bit archs it makes no difference if preempt is enabled or not.
787 */
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800788static inline loff_t i_size_read(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789{
790#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
791 loff_t i_size;
792 unsigned int seq;
793
794 do {
795 seq = read_seqcount_begin(&inode->i_size_seqcount);
796 i_size = inode->i_size;
797 } while (read_seqcount_retry(&inode->i_size_seqcount, seq));
798 return i_size;
799#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
800 loff_t i_size;
801
802 preempt_disable();
803 i_size = inode->i_size;
804 preempt_enable();
805 return i_size;
806#else
807 return inode->i_size;
808#endif
809}
810
Miklos Szeredi7762f5a2006-10-17 00:10:07 -0700811/*
812 * NOTE: unlike i_size_read(), i_size_write() does need locking around it
813 * (normally i_mutex), otherwise on 32bit/SMP an update of i_size_seqcount
814 * can be lost, resulting in subsequent i_size_read() calls spinning forever.
815 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816static inline void i_size_write(struct inode *inode, loff_t i_size)
817{
818#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
Fan Du74e3d1e2013-04-30 15:27:27 -0700819 preempt_disable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 write_seqcount_begin(&inode->i_size_seqcount);
821 inode->i_size = i_size;
822 write_seqcount_end(&inode->i_size_seqcount);
Fan Du74e3d1e2013-04-30 15:27:27 -0700823 preempt_enable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
825 preempt_disable();
826 inode->i_size = i_size;
827 preempt_enable();
828#else
829 inode->i_size = i_size;
830#endif
831}
832
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800833static inline unsigned iminor(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834{
835 return MINOR(inode->i_rdev);
836}
837
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800838static inline unsigned imajor(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839{
840 return MAJOR(inode->i_rdev);
841}
842
843extern struct block_device *I_BDEV(struct inode *inode);
844
845struct fown_struct {
846 rwlock_t lock; /* protects pid, uid, euid fields */
Eric W. Biederman609d7fa2006-10-02 02:17:15 -0700847 struct pid *pid; /* pid or -pgrp where SIGIO should be sent */
848 enum pid_type pid_type; /* Kind of process group SIGIO should be sent to */
Eric W. Biederman92361632012-02-08 07:07:50 -0800849 kuid_t uid, euid; /* uid/euid of process setting the owner */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 int signum; /* posix.1b rt signal to be delivered on IO */
851};
852
853/*
854 * Track a single file's readahead state
855 */
856struct file_ra_state {
Fengguang Wu937085a2007-10-16 01:24:31 -0700857 pgoff_t start; /* where readahead started */
858 unsigned int size; /* # of readahead pages */
859 unsigned int async_size; /* do asynchronous readahead when
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700860 there are only # of pages ahead */
Fengguang Wu5ce11102007-07-19 01:47:59 -0700861
Fengguang Wu937085a2007-10-16 01:24:31 -0700862 unsigned int ra_pages; /* Maximum readahead window */
Wu Fengguang1ebf26a2009-06-16 15:31:19 -0700863 unsigned int mmap_miss; /* Cache miss stat for mmap accesses */
Fengguang Wuf4e6b492007-10-16 01:24:33 -0700864 loff_t prev_pos; /* Cache last read() position */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866
Fengguang Wu5ce11102007-07-19 01:47:59 -0700867/*
Fengguang Wu5ce11102007-07-19 01:47:59 -0700868 * Check if @index falls in the readahead windows.
869 */
870static inline int ra_has_index(struct file_ra_state *ra, pgoff_t index)
871{
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700872 return (index >= ra->start &&
873 index < ra->start + ra->size);
Fengguang Wu5ce11102007-07-19 01:47:59 -0700874}
875
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876struct file {
Eric Dumazet2f512012005-10-30 15:02:16 -0800877 union {
Oleg Nesterov4f5e65a2013-07-08 14:24:16 -0700878 struct llist_node fu_llist;
Eric Dumazet2f512012005-10-30 15:02:16 -0800879 struct rcu_head fu_rcuhead;
880 } f_u;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800881 struct path f_path;
Al Virodd379782013-03-01 19:48:30 -0500882 struct inode *f_inode; /* cached value */
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800883 const struct file_operations *f_op;
Andi Kleenef3d0fd2011-09-15 16:06:48 -0700884
885 /*
Linus Torvalds9c225f22014-03-03 09:36:58 -0800886 * Protects f_ep_links, f_flags.
Andi Kleenef3d0fd2011-09-15 16:06:48 -0700887 * Must not be taken from IRQ context.
888 */
889 spinlock_t f_lock;
Al Viro516e0cc2008-07-26 00:39:17 -0400890 atomic_long_t f_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891 unsigned int f_flags;
Al Viroaeb5d722008-09-02 15:28:45 -0400892 fmode_t f_mode;
Linus Torvalds9c225f22014-03-03 09:36:58 -0800893 struct mutex f_pos_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894 loff_t f_pos;
895 struct fown_struct f_owner;
David Howellsd76b0d92008-11-14 10:39:25 +1100896 const struct cred *f_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897 struct file_ra_state f_ra;
898
Mathieu Desnoyers2b47c362007-10-16 23:27:21 -0700899 u64 f_version;
Alexey Dobriyan50462062006-09-29 02:00:01 -0700900#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 void *f_security;
Alexey Dobriyan50462062006-09-29 02:00:01 -0700902#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 /* needed for tty driver, and maybe others */
904 void *private_data;
905
906#ifdef CONFIG_EPOLL
907 /* Used by fs/eventpoll.c to link all the hooks to this file */
908 struct list_head f_ep_links;
Jason Baron28d82dc2012-01-12 17:17:43 -0800909 struct list_head f_tfile_llink;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910#endif /* #ifdef CONFIG_EPOLL */
911 struct address_space *f_mapping;
Al Virobd2a31d2014-03-04 14:54:22 -0500912} __attribute__((aligned(4))); /* lest something weird decides that 2 is OK */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913
Aneesh Kumar K.V990d6c22011-01-29 18:43:26 +0530914struct file_handle {
915 __u32 handle_bytes;
916 int handle_type;
917 /* file identifier */
918 unsigned char f_handle[0];
919};
920
Al Virocb0942b2012-08-27 14:48:26 -0400921static inline struct file *get_file(struct file *f)
922{
923 atomic_long_inc(&f->f_count);
924 return f;
925}
Konstantin Khlebnikov90f31d02015-04-16 12:47:56 -0700926#define get_file_rcu(x) atomic_long_inc_not_zero(&(x)->f_count)
Al Virod7065da2010-05-26 15:13:55 -0400927#define fput_atomic(x) atomic_long_add_unless(&(x)->f_count, -1, 1)
Al Viro516e0cc2008-07-26 00:39:17 -0400928#define file_count(x) atomic_long_read(&(x)->f_count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929
930#define MAX_NON_LFS ((1UL<<31) - 1)
931
932/* Page cache limit. The filesystems should put that into their s_maxbytes
933 limits, otherwise bad things can happen in VM. */
934#if BITS_PER_LONG==32
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300935#define MAX_LFS_FILESIZE (((loff_t)PAGE_SIZE << (BITS_PER_LONG-1))-1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936#elif BITS_PER_LONG==64
Al Viro614c3212012-10-10 01:06:20 -0400937#define MAX_LFS_FILESIZE ((loff_t)0x7fffffffffffffffLL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938#endif
939
940#define FL_POSIX 1
941#define FL_FLOCK 2
J. Bruce Fields617588d2011-07-01 15:18:34 -0400942#define FL_DELEG 4 /* NFSv4 delegation */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943#define FL_ACCESS 8 /* not trying to lock, just looking */
Trond Myklebustf475ae92006-06-29 16:38:32 -0400944#define FL_EXISTS 16 /* when unlocking, test for existence */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945#define FL_LEASE 32 /* lease held on this file */
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -0700946#define FL_CLOSE 64 /* unlock on close */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947#define FL_SLEEP 128 /* A blocking lock */
J. Bruce Fields778fc542011-07-26 18:25:49 -0400948#define FL_DOWNGRADE_PENDING 256 /* Lease is being downgraded */
949#define FL_UNLOCK_PENDING 512 /* Lease is being broken */
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400950#define FL_OFDLCK 1024 /* lock is "owned" by struct file */
Christoph Hellwig11afe9f2015-01-21 19:17:03 +0100951#define FL_LAYOUT 2048 /* outstanding pNFS layout */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952
953/*
Miklos Szeredibde74e42008-07-25 01:48:57 -0700954 * Special return value from posix_lock_file() and vfs_lock_file() for
955 * asynchronous locking.
956 */
957#define FILE_LOCK_DEFERRED 1
958
Jeff Layton7ca76312014-09-01 19:04:48 -0400959/* legacy typedef, should eventually be removed */
Christoph Hellwig17fa3882014-07-13 17:00:37 +0200960typedef void *fl_owner_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961
Jeff Laytona7231a92015-01-16 15:05:56 -0500962struct file_lock;
963
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964struct file_lock_operations {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965 void (*fl_copy_lock)(struct file_lock *, struct file_lock *);
966 void (*fl_release_private)(struct file_lock *);
967};
968
969struct lock_manager_operations {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400970 int (*lm_compare_owner)(struct file_lock *, struct file_lock *);
Jeff Layton3999e492013-06-21 08:58:19 -0400971 unsigned long (*lm_owner_key)(struct file_lock *);
Jeff Laytoncae80b32015-04-03 09:04:04 -0400972 fl_owner_t (*lm_get_owner)(fl_owner_t);
973 void (*lm_put_owner)(fl_owner_t);
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400974 void (*lm_notify)(struct file_lock *); /* unblock callback */
Joe Perchesd0449b92014-08-22 10:18:42 -0400975 int (*lm_grant)(struct file_lock *, int);
Jeff Layton4d01b7f2014-09-01 15:06:54 -0400976 bool (*lm_break)(struct file_lock *);
Jeff Layton7448cc32015-01-16 15:05:57 -0500977 int (*lm_change)(struct file_lock *, int, struct list_head *);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -0400978 void (*lm_setup)(struct file_lock *, void **);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979};
980
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -0400981struct lock_manager {
982 struct list_head list;
J. Bruce Fieldsc87fb4a2015-08-06 12:47:02 -0400983 /*
984 * NFSv4 and up also want opens blocked during the grace period;
985 * NLM doesn't care:
986 */
987 bool block_opens;
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -0400988};
989
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +0400990struct net;
991void locks_start_grace(struct net *, struct lock_manager *);
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -0400992void locks_end_grace(struct lock_manager *);
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +0400993int locks_in_grace(struct net *);
J. Bruce Fieldsc87fb4a2015-08-06 12:47:02 -0400994int opens_in_grace(struct net *);
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -0400995
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996/* that will die - we need it for nfs_lock_info */
997#include <linux/nfs_fs_i.h>
998
Jeff Layton1cb36012013-06-21 08:58:12 -0400999/*
1000 * struct file_lock represents a generic "file lock". It's used to represent
1001 * POSIX byte range locks, BSD (flock) locks, and leases. It's important to
1002 * note that the same struct is used to represent both a request for a lock and
1003 * the lock itself, but the same object is never used for both.
1004 *
1005 * FIXME: should we create a separate "struct lock_request" to help distinguish
1006 * these two uses?
1007 *
Jeff Layton8116bf42015-01-21 20:44:01 -05001008 * The varous i_flctx lists are ordered by:
Jeff Layton1cb36012013-06-21 08:58:12 -04001009 *
Jeff Layton8116bf42015-01-21 20:44:01 -05001010 * 1) lock owner
1011 * 2) lock range start
1012 * 3) lock range end
Jeff Layton1cb36012013-06-21 08:58:12 -04001013 *
1014 * Obviously, the last two criteria only matter for POSIX locks.
1015 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016struct file_lock {
1017 struct file_lock *fl_next; /* singly linked list for this inode */
Jeff Layton6dee60f2015-01-16 15:05:54 -05001018 struct list_head fl_list; /* link into file_lock_context */
Jeff Layton139ca042013-06-21 08:58:17 -04001019 struct hlist_node fl_link; /* node in global lists */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020 struct list_head fl_block; /* circular list of blocked processes */
1021 fl_owner_t fl_owner;
J. Bruce Fields710b7212011-07-26 16:28:29 -04001022 unsigned int fl_flags;
Richard Kennedyafc12462008-07-11 17:20:49 -07001023 unsigned char fl_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024 unsigned int fl_pid;
Jeff Layton7012b022013-06-21 08:58:22 -04001025 int fl_link_cpu; /* what cpu's list is this on? */
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00001026 struct pid *fl_nspid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027 wait_queue_head_t fl_wait;
1028 struct file *fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029 loff_t fl_start;
1030 loff_t fl_end;
1031
1032 struct fasync_struct * fl_fasync; /* for lease break notifications */
J. Bruce Fields778fc542011-07-26 18:25:49 -04001033 /* for lease breaks: */
1034 unsigned long fl_break_time;
1035 unsigned long fl_downgrade_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036
Alexey Dobriyan6aed6282009-09-21 17:01:11 -07001037 const struct file_lock_operations *fl_ops; /* Callbacks for filesystems */
Alexey Dobriyan7b021962009-09-21 17:01:12 -07001038 const struct lock_manager_operations *fl_lmops; /* Callbacks for lockmanagers */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039 union {
1040 struct nfs_lock_info nfs_fl;
Trond Myklebust8d0a8a92005-06-22 17:16:32 +00001041 struct nfs4_lock_info nfs4_fl;
David Howellse8d6c552007-07-15 23:40:12 -07001042 struct {
1043 struct list_head link; /* link in AFS vnode's pending_locks list */
1044 int state; /* state of grant or error if -ve */
1045 } afs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046 } fl_u;
1047};
1048
Jeff Layton4a075e32015-01-16 15:05:54 -05001049struct file_lock_context {
Jeff Layton6109c852015-01-16 15:05:57 -05001050 spinlock_t flc_lock;
Jeff Layton4a075e32015-01-16 15:05:54 -05001051 struct list_head flc_flock;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001052 struct list_head flc_posix;
Jeff Layton8634b512015-01-16 15:05:55 -05001053 struct list_head flc_lease;
Jeff Layton4a075e32015-01-16 15:05:54 -05001054};
1055
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056/* The following constant reflects the upper bound of the file/locking space */
1057#ifndef OFFSET_MAX
1058#define INT_LIMIT(x) (~((x)1 << (sizeof(x)*8 - 1)))
1059#define OFFSET_MAX INT_LIMIT(loff_t)
1060#define OFFT_OFFSET_MAX INT_LIMIT(off_t)
1061#endif
1062
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063#include <linux/fcntl.h>
1064
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001065extern void send_sigio(struct fown_struct *fown, int fd, int band);
1066
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001067#ifdef CONFIG_FILE_LOCKING
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001068extern int fcntl_getlk(struct file *, unsigned int, struct flock __user *);
Peter Staubachc2936212005-07-27 11:45:09 -07001069extern int fcntl_setlk(unsigned int, struct file *, unsigned int,
1070 struct flock __user *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071
1072#if BITS_PER_LONG == 32
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001073extern int fcntl_getlk64(struct file *, unsigned int, struct flock64 __user *);
Peter Staubachc2936212005-07-27 11:45:09 -07001074extern int fcntl_setlk64(unsigned int, struct file *, unsigned int,
1075 struct flock64 __user *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076#endif
1077
Linus Torvalds1da177e2005-04-16 15:20:36 -07001078extern int fcntl_setlease(unsigned int fd, struct file *filp, long arg);
1079extern int fcntl_getlease(struct file *filp);
1080
1081/* fs/locks.c */
Jeff Laytonf27a0fe2016-01-07 15:08:51 -05001082void locks_free_lock_context(struct inode *inode);
J. Bruce Fields05fa3132010-10-30 17:31:15 -04001083void locks_free_lock(struct file_lock *fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084extern void locks_init_lock(struct file_lock *);
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001085extern struct file_lock * locks_alloc_lock(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086extern void locks_copy_lock(struct file_lock *, struct file_lock *);
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001087extern void locks_copy_conflock(struct file_lock *, struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088extern void locks_remove_posix(struct file *, fl_owner_t);
Jeff Layton78ed8a12014-02-03 12:13:08 -05001089extern void locks_remove_file(struct file *);
Felix Blyakhera9e61e22009-03-31 15:12:56 -05001090extern void locks_release_private(struct file_lock *);
J. Bruce Fields6d34ac12007-05-11 16:09:32 -04001091extern void posix_test_lock(struct file *, struct file_lock *);
Marc Eshel150b3932007-01-18 16:15:35 -05001092extern int posix_lock_file(struct file *, struct file_lock *, struct file_lock *);
Jeff Laytonf891a292013-06-21 08:58:09 -04001093extern int posix_unblock_lock(struct file_lock *);
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001094extern int vfs_test_lock(struct file *, struct file_lock *);
Marc Eshel150b3932007-01-18 16:15:35 -05001095extern int vfs_lock_file(struct file *, unsigned int, struct file_lock *, struct file_lock *);
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05001096extern int vfs_cancel_lock(struct file *filp, struct file_lock *fl);
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001097extern int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001098extern int __break_lease(struct inode *inode, unsigned int flags, unsigned int type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099extern void lease_get_mtime(struct inode *, struct timespec *time);
Jeff Laytone6f5c782014-08-22 10:40:25 -04001100extern int generic_setlease(struct file *, long, struct file_lock **, void **priv);
1101extern int vfs_setlease(struct file *, long, struct file_lock **, void **);
Jeff Layton7448cc32015-01-16 15:05:57 -05001102extern int lease_modify(struct file_lock *, int, struct list_head *);
Andrey Vagin6c8c9032015-04-16 12:49:38 -07001103struct files_struct;
1104extern void show_fd_locks(struct seq_file *f,
1105 struct file *filp, struct files_struct *files);
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001106#else /* !CONFIG_FILE_LOCKING */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001107static inline int fcntl_getlk(struct file *file, unsigned int cmd,
1108 struct flock __user *user)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001109{
1110 return -EINVAL;
1111}
1112
1113static inline int fcntl_setlk(unsigned int fd, struct file *file,
1114 unsigned int cmd, struct flock __user *user)
1115{
1116 return -EACCES;
1117}
1118
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001119#if BITS_PER_LONG == 32
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001120static inline int fcntl_getlk64(struct file *file, unsigned int cmd,
1121 struct flock64 __user *user)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001122{
1123 return -EINVAL;
1124}
1125
1126static inline int fcntl_setlk64(unsigned int fd, struct file *file,
1127 unsigned int cmd, struct flock64 __user *user)
1128{
1129 return -EACCES;
1130}
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001131#endif
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001132static inline int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1133{
Jeff Layton1b2b32d2014-09-24 08:38:44 -04001134 return -EINVAL;
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001135}
1136
1137static inline int fcntl_getlease(struct file *filp)
1138{
Jeff Layton1b2b32d2014-09-24 08:38:44 -04001139 return F_UNLCK;
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001140}
1141
Jeff Layton4a075e32015-01-16 15:05:54 -05001142static inline void
Jeff Laytonf27a0fe2016-01-07 15:08:51 -05001143locks_free_lock_context(struct inode *inode)
Jeff Layton4a075e32015-01-16 15:05:54 -05001144{
1145}
1146
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001147static inline void locks_init_lock(struct file_lock *fl)
1148{
1149 return;
1150}
1151
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001152static inline void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001153{
1154 return;
1155}
1156
1157static inline void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
1158{
1159 return;
1160}
1161
1162static inline void locks_remove_posix(struct file *filp, fl_owner_t owner)
1163{
1164 return;
1165}
1166
Jeff Layton78ed8a12014-02-03 12:13:08 -05001167static inline void locks_remove_file(struct file *filp)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001168{
1169 return;
1170}
1171
1172static inline void posix_test_lock(struct file *filp, struct file_lock *fl)
1173{
1174 return;
1175}
1176
1177static inline int posix_lock_file(struct file *filp, struct file_lock *fl,
1178 struct file_lock *conflock)
1179{
1180 return -ENOLCK;
1181}
1182
Jeff Laytonf891a292013-06-21 08:58:09 -04001183static inline int posix_unblock_lock(struct file_lock *waiter)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001184{
1185 return -ENOENT;
1186}
1187
1188static inline int vfs_test_lock(struct file *filp, struct file_lock *fl)
1189{
1190 return 0;
1191}
1192
1193static inline int vfs_lock_file(struct file *filp, unsigned int cmd,
1194 struct file_lock *fl, struct file_lock *conf)
1195{
1196 return -ENOLCK;
1197}
1198
1199static inline int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
1200{
1201 return 0;
1202}
1203
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001204static inline int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
1205{
1206 return -ENOLCK;
1207}
1208
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001209static inline int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001210{
1211 return 0;
1212}
1213
1214static inline void lease_get_mtime(struct inode *inode, struct timespec *time)
1215{
1216 return;
1217}
1218
1219static inline int generic_setlease(struct file *filp, long arg,
Jeff Laytone6f5c782014-08-22 10:40:25 -04001220 struct file_lock **flp, void **priv)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001221{
1222 return -EINVAL;
1223}
1224
1225static inline int vfs_setlease(struct file *filp, long arg,
Jeff Laytone6f5c782014-08-22 10:40:25 -04001226 struct file_lock **lease, void **priv)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001227{
1228 return -EINVAL;
1229}
1230
Jeff Layton7448cc32015-01-16 15:05:57 -05001231static inline int lease_modify(struct file_lock *fl, int arg,
Jeff Laytonc45198e2014-09-01 07:12:07 -04001232 struct list_head *dispose)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001233{
1234 return -EINVAL;
1235}
Andrey Vagin6c8c9032015-04-16 12:49:38 -07001236
1237struct files_struct;
1238static inline void show_fd_locks(struct seq_file *f,
1239 struct file *filp, struct files_struct *files) {}
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001240#endif /* !CONFIG_FILE_LOCKING */
1241
Jeff Laytonee296d72015-07-11 06:43:03 -04001242static inline struct inode *file_inode(const struct file *f)
1243{
1244 return f->f_inode;
1245}
1246
Miklos Szeredid101a122016-03-26 16:14:37 -04001247static inline struct dentry *file_dentry(const struct file *file)
1248{
Miklos Szeredi2d902672016-06-30 08:53:27 +02001249 return d_real(file->f_path.dentry, file_inode(file), 0);
Miklos Szeredid101a122016-03-26 16:14:37 -04001250}
1251
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001252static inline int locks_lock_file_wait(struct file *filp, struct file_lock *fl)
1253{
1254 return locks_lock_inode_wait(file_inode(filp), fl);
1255}
1256
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257struct fasync_struct {
Eric Dumazet989a2972010-04-14 09:55:35 +00001258 spinlock_t fa_lock;
1259 int magic;
1260 int fa_fd;
1261 struct fasync_struct *fa_next; /* singly linked list */
1262 struct file *fa_file;
1263 struct rcu_head fa_rcu;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264};
1265
1266#define FASYNC_MAGIC 0x4601
1267
1268/* SMP safe fasync helpers: */
1269extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001270extern struct fasync_struct *fasync_insert_entry(int, struct file *, struct fasync_struct **, struct fasync_struct *);
1271extern int fasync_remove_entry(struct file *, struct fasync_struct **);
1272extern struct fasync_struct *fasync_alloc(void);
1273extern void fasync_free(struct fasync_struct *);
1274
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275/* can be called from interrupts */
1276extern void kill_fasync(struct fasync_struct **, int, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277
Jeff Laytone0b93ed2014-08-22 11:27:32 -04001278extern void __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
1279extern void f_setown(struct file *filp, unsigned long arg, int force);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280extern void f_delown(struct file *filp);
Eric W. Biederman609d7fa2006-10-02 02:17:15 -07001281extern pid_t f_getown(struct file *filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282extern int send_sigurg(struct fown_struct *fown);
1283
Jan Kara5accdf82012-06-12 16:20:34 +02001284struct mm_struct;
1285
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286/*
1287 * Umount options
1288 */
1289
1290#define MNT_FORCE 0x00000001 /* Attempt to forcibily umount */
1291#define MNT_DETACH 0x00000002 /* Just detach from the tree */
1292#define MNT_EXPIRE 0x00000004 /* Mark for expiry */
Miklos Szeredidb1f05b2010-02-10 12:15:53 +01001293#define UMOUNT_NOFOLLOW 0x00000008 /* Don't follow symlink on umount */
1294#define UMOUNT_UNUSED 0x80000000 /* Flag guaranteed to be unused */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295
Tejun Heo46b15ca2015-06-16 18:48:31 -04001296/* sb->s_iflags */
1297#define SB_I_CGROUPWB 0x00000001 /* cgroup-aware writeback enabled */
Eric W. Biederman90f85722015-06-29 14:42:03 -05001298#define SB_I_NOEXEC 0x00000002 /* Ignore executables on this fs */
Eric W. Biedermana2982cc2016-06-09 15:34:02 -05001299#define SB_I_NODEV 0x00000004 /* Ignore devices on this fs */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300
Eric W. Biederman8654df42016-06-09 16:06:06 -05001301/* sb->s_iflags to limit user namespace mounts */
1302#define SB_I_USERNS_VISIBLE 0x00000010 /* fstype already mounted */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303
Jan Kara5accdf82012-06-12 16:20:34 +02001304/* Possible states of 'frozen' field */
1305enum {
1306 SB_UNFROZEN = 0, /* FS is unfrozen */
1307 SB_FREEZE_WRITE = 1, /* Writes, dir ops, ioctls frozen */
Jan Kara5accdf82012-06-12 16:20:34 +02001308 SB_FREEZE_PAGEFAULT = 2, /* Page faults stopped as well */
1309 SB_FREEZE_FS = 3, /* For internal FS use (e.g. to stop
1310 * internal threads if needed) */
1311 SB_FREEZE_COMPLETE = 4, /* ->freeze_fs finished successfully */
1312};
1313
1314#define SB_FREEZE_LEVELS (SB_FREEZE_COMPLETE - 1)
1315
1316struct sb_writers {
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001317 int frozen; /* Is sb frozen? */
1318 wait_queue_head_t wait_unfrozen; /* for get_super_thawed() */
1319 struct percpu_rw_semaphore rw_sem[SB_FREEZE_LEVELS];
Jan Kara5accdf82012-06-12 16:20:34 +02001320};
1321
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322struct super_block {
1323 struct list_head s_list; /* Keep this first */
1324 dev_t s_dev; /* search index; _not_ kdev_t */
Richard Kennedy270ba5f2010-01-26 14:12:43 +00001325 unsigned char s_blocksize_bits;
1326 unsigned long s_blocksize;
Jeff Layton42cb56a2009-09-18 13:05:53 -07001327 loff_t s_maxbytes; /* Max file size */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328 struct file_system_type *s_type;
Josef 'Jeff' Sipekee9b6d62007-02-12 00:55:41 -08001329 const struct super_operations *s_op;
Alexey Dobriyan61e225d2009-09-21 17:01:08 -07001330 const struct dquot_operations *dq_op;
Alexey Dobriyan0d54b212009-09-21 17:01:09 -07001331 const struct quotactl_ops *s_qcop;
Christoph Hellwig39655162007-10-21 16:42:17 -07001332 const struct export_operations *s_export_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 unsigned long s_flags;
Tejun Heo46b15ca2015-06-16 18:48:31 -04001334 unsigned long s_iflags; /* internal SB_I_* flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335 unsigned long s_magic;
1336 struct dentry *s_root;
1337 struct rw_semaphore s_umount;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 int s_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339 atomic_t s_active;
Alexey Dobriyan50462062006-09-29 02:00:01 -07001340#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341 void *s_security;
Alexey Dobriyan50462062006-09-29 02:00:01 -07001342#endif
Stephen Hemmingerbb435452010-05-13 17:53:14 -07001343 const struct xattr_handler **s_xattr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344
Jaegeuk Kim0b81d072015-05-15 16:26:10 -07001345 const struct fscrypt_operations *s_cop;
1346
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001347 struct hlist_bl_head s_anon; /* anonymous dentries for (nfs) exporting */
Miklos Szeredi39f7c4d2011-11-21 12:11:30 +01001348 struct list_head s_mounts; /* list of mounts; _not_ for fs use */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349 struct block_device *s_bdev;
Jens Axboe32a88aa2009-09-16 15:02:33 +02001350 struct backing_dev_info *s_bdi;
David Howellsacaebfd2007-05-10 22:51:50 -07001351 struct mtd_info *s_mtd;
Al Viroa5166162011-12-12 22:53:00 -05001352 struct hlist_node s_instances;
Jan Kara2c5f6482014-09-30 10:43:09 +02001353 unsigned int s_quota_types; /* Bitmask of supported quota types */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354 struct quota_info s_dquot; /* Diskquota specific options */
1355
Jan Kara5accdf82012-06-12 16:20:34 +02001356 struct sb_writers s_writers;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357
1358 char s_id[32]; /* Informational name */
Linus Torvalds0bba0162011-04-12 15:21:04 -07001359 u8 s_uuid[16]; /* UUID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360
1361 void *s_fs_info; /* Filesystem private info */
Al Viro8de52772012-02-06 12:45:27 -05001362 unsigned int s_max_links;
Al Viro30c40d22008-02-22 19:50:45 -05001363 fmode_t s_mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364
Richard Kennedy270ba5f2010-01-26 14:12:43 +00001365 /* Granularity of c/m/atime in ns.
1366 Cannot be worse than a second */
1367 u32 s_time_gran;
1368
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 /*
1370 * The next field is for VFS *only*. No filesystems have any business
1371 * even looking at it. You had been warned.
1372 */
Arjan van de Vena11f3a02006-03-23 03:00:33 -08001373 struct mutex s_vfs_rename_mutex; /* Kludge */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374
Miklos Szeredi79c0b2d2007-05-08 00:25:43 -07001375 /*
1376 * Filesystem subtype. If non-empty the filesystem type field
1377 * in /proc/mounts will be "type.subtype"
1378 */
1379 char *s_subtype;
Miklos Szeredib3b304a2008-02-08 04:21:35 -08001380
1381 /*
1382 * Saved mount options for lazy filesystems using
1383 * generic_show_options()
1384 */
Arnd Bergmann4d2deb42010-02-24 20:01:56 +01001385 char __rcu *s_options;
Al Viroc8aebb02010-12-18 10:22:30 -05001386 const struct dentry_operations *s_d_op; /* default d_op for dentries */
Dan Magenheimer9fdfdcf2011-05-26 10:01:19 -06001387
1388 /*
1389 * Saved pool identifier for cleancache (-1 means none)
1390 */
1391 int cleancache_poolid;
Dave Chinnerb0d40c92011-07-08 14:14:42 +10001392
1393 struct shrinker s_shrink; /* per-sb shrinker handle */
Miklos Szeredi4ed5e82f2011-11-21 12:11:31 +01001394
Miklos Szeredi7ada4db2011-11-21 12:11:32 +01001395 /* Number of inodes with nlink == 0 but still referenced */
1396 atomic_long_t s_remove_count;
1397
Miklos Szeredi4ed5e82f2011-11-21 12:11:31 +01001398 /* Being remounted read-only */
1399 int s_readonly_remount;
Christoph Hellwig7b7a8662013-09-04 15:04:39 +02001400
1401 /* AIO completions deferred from interrupt context */
1402 struct workqueue_struct *s_dio_done_wq;
Al Viro215752f2014-08-07 06:23:41 -04001403 struct hlist_head s_pins;
Dave Chinnerf6041562013-08-28 10:18:00 +10001404
1405 /*
Eric W. Biederman6e4eab52016-05-24 09:29:01 -05001406 * Owning user namespace and default context in which to
1407 * interpret filesystem uids, gids, quotas, device nodes,
1408 * xattrs and security labels.
1409 */
1410 struct user_namespace *s_user_ns;
1411
1412 /*
Dave Chinnerf6041562013-08-28 10:18:00 +10001413 * Keep the lru lists last in the structure so they always sit on their
1414 * own individual cachelines.
1415 */
1416 struct list_lru s_dentry_lru ____cacheline_aligned_in_smp;
1417 struct list_lru s_inode_lru ____cacheline_aligned_in_smp;
Al Viroe2fec7c2013-10-04 17:06:56 -04001418 struct rcu_head rcu;
Oleg Nesterov853b39a2015-07-22 20:21:13 +02001419 struct work_struct destroy_work;
Miklos Szeredi69c433e2014-10-24 00:14:39 +02001420
Dave Chinnere97fedb2015-03-04 13:40:00 -05001421 struct mutex s_sync_lock; /* sync serialisation lock */
Miklos Szeredi69c433e2014-10-24 00:14:39 +02001422
1423 /*
1424 * Indicates how deep in a filesystem stack this SB is
1425 */
1426 int s_stack_depth;
Dave Chinner74278da2015-03-04 12:37:22 -05001427
1428 /* s_inode_list_lock protects s_inodes */
1429 spinlock_t s_inode_list_lock ____cacheline_aligned_in_smp;
1430 struct list_head s_inodes; /* all inodes */
Dave Chinner6c60d2b2016-07-26 15:21:50 -07001431
1432 spinlock_t s_inode_wblist_lock;
1433 struct list_head s_inodes_wb; /* writeback inodes */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434};
1435
Seth Forshee81754352014-12-11 10:15:45 -06001436/* Helper functions so that in most cases filesystems will
1437 * not need to deal directly with kuid_t and kgid_t and can
1438 * instead deal with the raw numeric values that are stored
1439 * in the filesystem.
1440 */
1441static inline uid_t i_uid_read(const struct inode *inode)
1442{
1443 return from_kuid(inode->i_sb->s_user_ns, inode->i_uid);
1444}
1445
1446static inline gid_t i_gid_read(const struct inode *inode)
1447{
1448 return from_kgid(inode->i_sb->s_user_ns, inode->i_gid);
1449}
1450
1451static inline void i_uid_write(struct inode *inode, uid_t uid)
1452{
1453 inode->i_uid = make_kuid(inode->i_sb->s_user_ns, uid);
1454}
1455
1456static inline void i_gid_write(struct inode *inode, gid_t gid)
1457{
1458 inode->i_gid = make_kgid(inode->i_sb->s_user_ns, gid);
1459}
1460
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461extern struct timespec current_fs_time(struct super_block *sb);
1462
1463/*
1464 * Snapshotting support.
1465 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466
Jan Kara5accdf82012-06-12 16:20:34 +02001467void __sb_end_write(struct super_block *sb, int level);
1468int __sb_start_write(struct super_block *sb, int level, bool wait);
1469
Oleg Nesterovbee91822015-07-19 23:48:20 +02001470#define __sb_writers_acquired(sb, lev) \
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001471 percpu_rwsem_acquire(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
Oleg Nesterovbee91822015-07-19 23:48:20 +02001472#define __sb_writers_release(sb, lev) \
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001473 percpu_rwsem_release(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
Oleg Nesterovbee91822015-07-19 23:48:20 +02001474
Jan Kara5accdf82012-06-12 16:20:34 +02001475/**
1476 * sb_end_write - drop write access to a superblock
1477 * @sb: the super we wrote to
1478 *
1479 * Decrement number of writers to the filesystem. Wake up possible waiters
1480 * wanting to freeze the filesystem.
1481 */
1482static inline void sb_end_write(struct super_block *sb)
1483{
1484 __sb_end_write(sb, SB_FREEZE_WRITE);
1485}
1486
1487/**
1488 * sb_end_pagefault - drop write access to a superblock from a page fault
1489 * @sb: the super we wrote to
1490 *
1491 * Decrement number of processes handling write page fault to the filesystem.
1492 * Wake up possible waiters wanting to freeze the filesystem.
1493 */
1494static inline void sb_end_pagefault(struct super_block *sb)
1495{
1496 __sb_end_write(sb, SB_FREEZE_PAGEFAULT);
1497}
1498
1499/**
1500 * sb_end_intwrite - drop write access to a superblock for internal fs purposes
1501 * @sb: the super we wrote to
1502 *
1503 * Decrement fs-internal number of writers to the filesystem. Wake up possible
1504 * waiters wanting to freeze the filesystem.
1505 */
1506static inline void sb_end_intwrite(struct super_block *sb)
1507{
1508 __sb_end_write(sb, SB_FREEZE_FS);
1509}
1510
1511/**
1512 * sb_start_write - get write access to a superblock
1513 * @sb: the super we write to
1514 *
1515 * When a process wants to write data or metadata to a file system (i.e. dirty
1516 * a page or an inode), it should embed the operation in a sb_start_write() -
1517 * sb_end_write() pair to get exclusion against file system freezing. This
1518 * function increments number of writers preventing freezing. If the file
1519 * system is already frozen, the function waits until the file system is
1520 * thawed.
1521 *
1522 * Since freeze protection behaves as a lock, users have to preserve
1523 * ordering of freeze protection and other filesystem locks. Generally,
1524 * freeze protection should be the outermost lock. In particular, we have:
1525 *
1526 * sb_start_write
1527 * -> i_mutex (write path, truncate, directory ops, ...)
1528 * -> s_umount (freeze_super, thaw_super)
1529 */
1530static inline void sb_start_write(struct super_block *sb)
1531{
1532 __sb_start_write(sb, SB_FREEZE_WRITE, true);
1533}
1534
1535static inline int sb_start_write_trylock(struct super_block *sb)
1536{
1537 return __sb_start_write(sb, SB_FREEZE_WRITE, false);
1538}
1539
1540/**
1541 * sb_start_pagefault - get write access to a superblock from a page fault
1542 * @sb: the super we write to
1543 *
1544 * When a process starts handling write page fault, it should embed the
1545 * operation into sb_start_pagefault() - sb_end_pagefault() pair to get
1546 * exclusion against file system freezing. This is needed since the page fault
1547 * is going to dirty a page. This function increments number of running page
1548 * faults preventing freezing. If the file system is already frozen, the
1549 * function waits until the file system is thawed.
1550 *
1551 * Since page fault freeze protection behaves as a lock, users have to preserve
1552 * ordering of freeze protection and other filesystem locks. It is advised to
1553 * put sb_start_pagefault() close to mmap_sem in lock ordering. Page fault
1554 * handling code implies lock dependency:
1555 *
1556 * mmap_sem
1557 * -> sb_start_pagefault
1558 */
1559static inline void sb_start_pagefault(struct super_block *sb)
1560{
1561 __sb_start_write(sb, SB_FREEZE_PAGEFAULT, true);
1562}
1563
1564/*
1565 * sb_start_intwrite - get write access to a superblock for internal fs purposes
1566 * @sb: the super we write to
1567 *
1568 * This is the third level of protection against filesystem freezing. It is
1569 * free for use by a filesystem. The only requirement is that it must rank
1570 * below sb_start_pagefault.
1571 *
1572 * For example filesystem can call sb_start_intwrite() when starting a
1573 * transaction which somewhat eases handling of freezing for internal sources
1574 * of filesystem changes (internal fs threads, discarding preallocation on file
1575 * close, etc.).
1576 */
1577static inline void sb_start_intwrite(struct super_block *sb)
1578{
1579 __sb_start_write(sb, SB_FREEZE_FS, true);
1580}
1581
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582
Serge E. Hallyn2e149672011-03-23 16:43:26 -07001583extern bool inode_owner_or_capable(const struct inode *inode);
Satyam Sharma3bd858a2007-07-17 15:00:08 +05301584
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585/*
1586 * VFS helper functions..
1587 */
Al Viro312b63f2012-06-10 18:09:36 -04001588extern int vfs_create(struct inode *, struct dentry *, umode_t, bool);
Al Viro18bb1db2011-07-26 01:41:39 -04001589extern int vfs_mkdir(struct inode *, struct dentry *, umode_t);
Al Viro1a67aaf2011-07-26 01:52:52 -04001590extern int vfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
Miklos Szeredidb2e7472008-06-24 16:50:16 +02001591extern int vfs_symlink(struct inode *, struct dentry *, const char *);
J. Bruce Fields146a8592011-09-20 17:14:31 -04001592extern int vfs_link(struct dentry *, struct inode *, struct dentry *, struct inode **);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593extern int vfs_rmdir(struct inode *, struct dentry *);
J. Bruce Fieldsb21996e2011-09-20 09:14:34 -04001594extern int vfs_unlink(struct inode *, struct dentry *, struct inode **);
Miklos Szeredi520c8b12014-04-01 17:08:42 +02001595extern int vfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *, struct inode **, unsigned int);
Miklos Szeredi787fb6b2014-10-24 00:14:36 +02001596extern int vfs_whiteout(struct inode *, struct dentry *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597
1598/*
Christoph Hellwig8c744fb2005-11-08 21:35:04 -08001599 * VFS file helper functions.
1600 */
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03001601extern void inode_init_owner(struct inode *inode, const struct inode *dir,
Al Viro62bb1092011-07-24 23:20:18 -04001602 umode_t mode);
Eric W. Biedermana2982cc2016-06-09 15:34:02 -05001603extern bool may_open_dev(const struct path *path);
Christoph Hellwig8c744fb2005-11-08 21:35:04 -08001604/*
Mark Fashehc4b929b2008-10-08 19:44:18 -04001605 * VFS FS_IOC_FIEMAP helper definitions.
1606 */
1607struct fiemap_extent_info {
1608 unsigned int fi_flags; /* Flags as passed from user */
1609 unsigned int fi_extents_mapped; /* Number of mapped extents */
1610 unsigned int fi_extents_max; /* Size of fiemap_extent array */
Namhyung Kimecf56322011-01-16 23:28:17 +09001611 struct fiemap_extent __user *fi_extents_start; /* Start of
1612 fiemap_extent array */
Mark Fashehc4b929b2008-10-08 19:44:18 -04001613};
1614int fiemap_fill_next_extent(struct fiemap_extent_info *info, u64 logical,
1615 u64 phys, u64 len, u32 flags);
1616int fiemap_check_flags(struct fiemap_extent_info *fieinfo, u32 fs_flags);
1617
1618/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619 * File types
1620 *
1621 * NOTE! These match bits 12..15 of stat.st_mode
1622 * (ie "(i_mode >> 12) & 15").
1623 */
1624#define DT_UNKNOWN 0
1625#define DT_FIFO 1
1626#define DT_CHR 2
1627#define DT_DIR 4
1628#define DT_BLK 6
1629#define DT_REG 8
1630#define DT_LNK 10
1631#define DT_SOCK 12
1632#define DT_WHT 14
1633
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634/*
1635 * This is the "filldir" function type, used by readdir() to let
1636 * the kernel specify what kind of dirent layout it wants to have.
1637 * This allows the kernel to read directories into kernel space or
1638 * to have different dirent layouts depending on the binary type.
1639 */
Miklos Szerediac7576f2014-10-30 17:37:34 +01001640struct dir_context;
1641typedef int (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64,
1642 unsigned);
1643
Al Viro5c0ba4e2013-05-15 13:52:59 -04001644struct dir_context {
Al Viroac6614b2013-05-22 22:22:04 -04001645 const filldir_t actor;
Al Virobb6f6192013-05-15 18:49:12 -04001646 loff_t pos;
Al Viro5c0ba4e2013-05-15 13:52:59 -04001647};
Al Virobb6f6192013-05-15 18:49:12 -04001648
Al Viro08f85852007-10-08 13:26:20 -04001649struct block_device_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651/* These macros are for out of kernel modules to test that
1652 * the kernel supports the unlocked_ioctl and compat_ioctl
1653 * fields in struct file_operations. */
1654#define HAVE_COMPAT_IOCTL 1
1655#define HAVE_UNLOCKED_IOCTL 1
1656
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01001657/*
1658 * These flags let !MMU mmap() govern direct device mapping vs immediate
1659 * copying more easily for MAP_PRIVATE, especially for ROM filesystems.
1660 *
1661 * NOMMU_MAP_COPY: Copy can be mapped (MAP_PRIVATE)
1662 * NOMMU_MAP_DIRECT: Can be mapped directly (MAP_SHARED)
1663 * NOMMU_MAP_READ: Can be mapped for reading
1664 * NOMMU_MAP_WRITE: Can be mapped for writing
1665 * NOMMU_MAP_EXEC: Can be mapped for execution
1666 */
1667#define NOMMU_MAP_COPY 0x00000001
1668#define NOMMU_MAP_DIRECT 0x00000008
1669#define NOMMU_MAP_READ VM_MAYREAD
1670#define NOMMU_MAP_WRITE VM_MAYWRITE
1671#define NOMMU_MAP_EXEC VM_MAYEXEC
1672
1673#define NOMMU_VMFLAGS \
1674 (NOMMU_MAP_READ | NOMMU_MAP_WRITE | NOMMU_MAP_EXEC)
1675
1676
Al Viro293bc982014-02-11 18:37:41 -05001677struct iov_iter;
1678
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679struct file_operations {
1680 struct module *owner;
1681 loff_t (*llseek) (struct file *, loff_t, int);
1682 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
Al Viro293bc982014-02-11 18:37:41 -05001684 ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
1685 ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
Al Virobb6f6192013-05-15 18:49:12 -04001686 int (*iterate) (struct file *, struct dir_context *);
Al Viro61922692016-04-20 23:08:32 -04001687 int (*iterate_shared) (struct file *, struct dir_context *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688 unsigned int (*poll) (struct file *, struct poll_table_struct *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
1690 long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
1691 int (*mmap) (struct file *, struct vm_area_struct *);
1692 int (*open) (struct inode *, struct file *);
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07001693 int (*flush) (struct file *, fl_owner_t id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001694 int (*release) (struct inode *, struct file *);
Josef Bacik02c24a82011-07-16 20:44:56 -04001695 int (*fsync) (struct file *, loff_t, loff_t, int datasync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696 int (*aio_fsync) (struct kiocb *, int datasync);
1697 int (*fasync) (int, struct file *, int);
1698 int (*lock) (struct file *, int, struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699 ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
1700 unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
1701 int (*check_flags)(int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702 int (*flock) (struct file *, int, struct file_lock *);
Jens Axboecbb7e572006-04-11 14:57:50 +02001703 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int);
1704 ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int);
Jeff Laytone6f5c782014-08-22 10:40:25 -04001705 int (*setlease)(struct file *, long, struct file_lock **, void **);
Christoph Hellwig2fe17c12011-01-14 13:07:43 +01001706 long (*fallocate)(struct file *file, int mode, loff_t offset,
1707 loff_t len);
Joe Perchesa3816ab2014-09-29 16:08:25 -07001708 void (*show_fdinfo)(struct seq_file *m, struct file *f);
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01001709#ifndef CONFIG_MMU
1710 unsigned (*mmap_capabilities)(struct file *);
1711#endif
Christoph Hellwig04b38d62015-12-03 12:59:50 +01001712 ssize_t (*copy_file_range)(struct file *, loff_t, struct file *,
1713 loff_t, size_t, unsigned int);
1714 int (*clone_file_range)(struct file *, loff_t, struct file *, loff_t,
1715 u64);
Darrick J. Wong54dbc152015-12-19 00:55:59 -08001716 ssize_t (*dedupe_file_range)(struct file *, u64, u64, struct file *,
1717 u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001718};
1719
1720struct inode_operations {
Al Viro00cd8dd2012-06-10 17:13:09 -04001721 struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
Al Virofceef392015-12-29 15:58:39 -05001722 const char * (*get_link) (struct dentry *, struct inode *, struct delayed_call *);
Al Viro10556cb22011-06-20 19:28:19 -04001723 int (*permission) (struct inode *, int);
Christoph Hellwig4e34e712011-07-23 17:37:31 +02001724 struct posix_acl * (*get_acl)(struct inode *, int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001725
1726 int (*readlink) (struct dentry *, char __user *,int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001727
Al Viroebfc3b42012-06-10 18:05:36 -04001728 int (*create) (struct inode *,struct dentry *, umode_t, bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001729 int (*link) (struct dentry *,struct inode *,struct dentry *);
1730 int (*unlink) (struct inode *,struct dentry *);
1731 int (*symlink) (struct inode *,struct dentry *,const char *);
Al Viro18bb1db2011-07-26 01:41:39 -04001732 int (*mkdir) (struct inode *,struct dentry *,umode_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733 int (*rmdir) (struct inode *,struct dentry *);
Al Viro1a67aaf2011-07-26 01:52:52 -04001734 int (*mknod) (struct inode *,struct dentry *,umode_t,dev_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001735 int (*rename) (struct inode *, struct dentry *,
1736 struct inode *, struct dentry *);
Miklos Szeredi520c8b12014-04-01 17:08:42 +02001737 int (*rename2) (struct inode *, struct dentry *,
1738 struct inode *, struct dentry *, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739 int (*setattr) (struct dentry *, struct iattr *);
1740 int (*getattr) (struct vfsmount *mnt, struct dentry *, struct kstat *);
Al Viro3767e252016-05-27 11:06:05 -04001741 int (*setxattr) (struct dentry *, struct inode *,
1742 const char *, const void *, size_t, int);
Al Viroce23e642016-04-11 00:48:00 -04001743 ssize_t (*getxattr) (struct dentry *, struct inode *,
1744 const char *, void *, size_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745 ssize_t (*listxattr) (struct dentry *, char *, size_t);
1746 int (*removexattr) (struct dentry *, const char *);
Mark Fashehc4b929b2008-10-08 19:44:18 -04001747 int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
1748 u64 len);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001749 int (*update_time)(struct inode *, struct timespec *, int);
Al Virod9585272012-06-22 12:39:14 +04001750 int (*atomic_open)(struct inode *, struct dentry *,
Al Viro30d90492012-06-22 12:40:19 +04001751 struct file *, unsigned open_flag,
Al Virod9585272012-06-22 12:39:14 +04001752 umode_t create_mode, int *opened);
Al Viro60545d02013-06-07 01:20:27 -04001753 int (*tmpfile) (struct inode *, struct dentry *, umode_t);
Christoph Hellwig893d46e2013-12-20 05:16:39 -08001754 int (*set_acl)(struct inode *, struct posix_acl *, int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001755} ____cacheline_aligned;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001757ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvector,
Christopher Yeohfcf63402011-10-31 17:06:39 -07001758 unsigned long nr_segs, unsigned long fast_segs,
1759 struct iovec *fast_pointer,
Christopher Yeohac34ebb2012-05-31 16:26:42 -07001760 struct iovec **ret_pointer);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001761
Dmitry Kasatkin6fb50322014-11-05 17:01:17 +02001762extern ssize_t __vfs_read(struct file *, char __user *, size_t, loff_t *);
Al Viro493c84c2015-04-03 15:06:43 -04001763extern ssize_t __vfs_write(struct file *, const char __user *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
1765extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
1766extern ssize_t vfs_readv(struct file *, const struct iovec __user *,
Christoph Hellwig793b80e2016-03-03 16:03:58 +01001767 unsigned long, loff_t *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768extern ssize_t vfs_writev(struct file *, const struct iovec __user *,
Christoph Hellwig793b80e2016-03-03 16:03:58 +01001769 unsigned long, loff_t *, int);
Zach Brown29732932015-11-10 16:53:30 -05001770extern ssize_t vfs_copy_file_range(struct file *, loff_t , struct file *,
1771 loff_t, size_t, unsigned int);
Christoph Hellwig04b38d62015-12-03 12:59:50 +01001772extern int vfs_clone_file_range(struct file *file_in, loff_t pos_in,
1773 struct file *file_out, loff_t pos_out, u64 len);
Darrick J. Wong54dbc152015-12-19 00:55:59 -08001774extern int vfs_dedupe_file_range(struct file *file,
1775 struct file_dedupe_range *same);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777struct super_operations {
1778 struct inode *(*alloc_inode)(struct super_block *sb);
1779 void (*destroy_inode)(struct inode *);
1780
Christoph Hellwigaa385722011-05-27 06:53:02 -04001781 void (*dirty_inode) (struct inode *, int flags);
Christoph Hellwiga9185b42010-03-05 09:21:37 +01001782 int (*write_inode) (struct inode *, struct writeback_control *wbc);
Al Viro45321ac2010-06-07 13:43:19 -04001783 int (*drop_inode) (struct inode *);
Al Virobe7ce412010-06-04 19:40:39 -04001784 void (*evict_inode) (struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785 void (*put_super) (struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786 int (*sync_fs)(struct super_block *sb, int wait);
Benjamin Marzinski48b6bca2014-11-13 20:42:03 -06001787 int (*freeze_super) (struct super_block *);
Takashi Satoc4be0c12009-01-09 16:40:58 -08001788 int (*freeze_fs) (struct super_block *);
Benjamin Marzinski48b6bca2014-11-13 20:42:03 -06001789 int (*thaw_super) (struct super_block *);
Takashi Satoc4be0c12009-01-09 16:40:58 -08001790 int (*unfreeze_fs) (struct super_block *);
David Howells726c3342006-06-23 02:02:58 -07001791 int (*statfs) (struct dentry *, struct kstatfs *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792 int (*remount_fs) (struct super_block *, int *, char *);
Al Viro42faad92008-04-24 07:21:56 -04001793 void (*umount_begin) (struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794
Al Viro34c80b12011-12-08 21:32:45 -05001795 int (*show_options)(struct seq_file *, struct dentry *);
Al Virod861c632011-12-08 21:32:45 -05001796 int (*show_devname)(struct seq_file *, struct dentry *);
Al Viroa6322de2011-12-08 21:37:57 -05001797 int (*show_path)(struct seq_file *, struct dentry *);
Al Viro64132372011-12-08 20:51:13 -05001798 int (*show_stats)(struct seq_file *, struct dentry *);
Alexey Dobriyan0e51a722006-09-29 01:59:56 -07001799#ifdef CONFIG_QUOTA
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800 ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
1801 ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
Jan Kara2d0fa462014-09-25 16:36:14 +02001802 struct dquot **(*get_dquots)(struct inode *);
Alexey Dobriyan0e51a722006-09-29 01:59:56 -07001803#endif
Theodore Ts'o87d8fe12009-01-03 09:47:09 -05001804 int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
Vladimir Davydov4101b622015-02-12 14:58:51 -08001805 long (*nr_cached_objects)(struct super_block *,
1806 struct shrink_control *);
1807 long (*free_cached_objects)(struct super_block *,
1808 struct shrink_control *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809};
1810
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001811/*
David Howellsbbc10962012-10-15 16:40:35 +01001812 * Inode flags - they have no relation to superblock flags now
1813 */
1814#define S_SYNC 1 /* Writes are synced at once */
1815#define S_NOATIME 2 /* Do not update access times */
1816#define S_APPEND 4 /* Append-only file */
1817#define S_IMMUTABLE 8 /* Immutable file */
1818#define S_DEAD 16 /* removed, but still open directory */
1819#define S_NOQUOTA 32 /* Inode is not counted to quota */
1820#define S_DIRSYNC 64 /* Directory modifications are synchronous */
1821#define S_NOCMTIME 128 /* Do not update file c/mtime */
1822#define S_SWAPFILE 256 /* Do not truncate: swapon got its bmaps */
1823#define S_PRIVATE 512 /* Inode is fs-internal */
1824#define S_IMA 1024 /* Inode has an associated IMA struct */
1825#define S_AUTOMOUNT 2048 /* Automount/referral quasi-directory */
1826#define S_NOSEC 4096 /* no suid or xattr security attributes */
Matthew Wilcox6cd176a2015-02-16 15:59:25 -08001827#ifdef CONFIG_FS_DAX
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08001828#define S_DAX 8192 /* Direct Access, avoiding the page cache */
1829#else
1830#define S_DAX 0 /* Make all the DAX code disappear */
1831#endif
David Howellsbbc10962012-10-15 16:40:35 +01001832
1833/*
1834 * Note that nosuid etc flags are inode-specific: setting some file-system
1835 * flags just means all the inodes inherit those flags by default. It might be
1836 * possible to override it selectively if you really wanted to with some
1837 * ioctl() that is not currently implemented.
1838 *
1839 * Exception: MS_RDONLY is always applied to the entire file system.
1840 *
1841 * Unfortunately, it is possible to change a filesystems flags with it mounted
1842 * with files in use. This means that all of the inodes will not have their
1843 * i_flags updated. Hence, i_flags no longer inherit the superblock mount
1844 * flags, so these have to be checked separately. -- rmk@arm.uk.linux.org
1845 */
1846#define __IS_FLG(inode, flg) ((inode)->i_sb->s_flags & (flg))
1847
1848#define IS_RDONLY(inode) ((inode)->i_sb->s_flags & MS_RDONLY)
1849#define IS_SYNC(inode) (__IS_FLG(inode, MS_SYNCHRONOUS) || \
1850 ((inode)->i_flags & S_SYNC))
1851#define IS_DIRSYNC(inode) (__IS_FLG(inode, MS_SYNCHRONOUS|MS_DIRSYNC) || \
1852 ((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
1853#define IS_MANDLOCK(inode) __IS_FLG(inode, MS_MANDLOCK)
1854#define IS_NOATIME(inode) __IS_FLG(inode, MS_RDONLY|MS_NOATIME)
1855#define IS_I_VERSION(inode) __IS_FLG(inode, MS_I_VERSION)
1856
1857#define IS_NOQUOTA(inode) ((inode)->i_flags & S_NOQUOTA)
1858#define IS_APPEND(inode) ((inode)->i_flags & S_APPEND)
1859#define IS_IMMUTABLE(inode) ((inode)->i_flags & S_IMMUTABLE)
1860#define IS_POSIXACL(inode) __IS_FLG(inode, MS_POSIXACL)
1861
1862#define IS_DEADDIR(inode) ((inode)->i_flags & S_DEAD)
1863#define IS_NOCMTIME(inode) ((inode)->i_flags & S_NOCMTIME)
1864#define IS_SWAPFILE(inode) ((inode)->i_flags & S_SWAPFILE)
1865#define IS_PRIVATE(inode) ((inode)->i_flags & S_PRIVATE)
1866#define IS_IMA(inode) ((inode)->i_flags & S_IMA)
1867#define IS_AUTOMOUNT(inode) ((inode)->i_flags & S_AUTOMOUNT)
1868#define IS_NOSEC(inode) ((inode)->i_flags & S_NOSEC)
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08001869#define IS_DAX(inode) ((inode)->i_flags & S_DAX)
David Howellsbbc10962012-10-15 16:40:35 +01001870
Miklos Szeredi787fb6b2014-10-24 00:14:36 +02001871#define IS_WHITEOUT(inode) (S_ISCHR(inode->i_mode) && \
1872 (inode)->i_rdev == WHITEOUT_DEV)
1873
Eric W. Biederman0bd23d092016-06-29 14:54:46 -05001874static inline bool HAS_UNMAPPED_ID(struct inode *inode)
1875{
1876 return !uid_valid(inode->i_uid) || !gid_valid(inode->i_gid);
1877}
1878
David Howellsbbc10962012-10-15 16:40:35 +01001879/*
Dave Chinner250df6e2011-03-22 22:23:36 +11001880 * Inode state bits. Protected by inode->i_lock
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001881 *
1882 * Three bits determine the dirty state of the inode, I_DIRTY_SYNC,
1883 * I_DIRTY_DATASYNC and I_DIRTY_PAGES.
1884 *
1885 * Four bits define the lifetime of an inode. Initially, inodes are I_NEW,
1886 * until that flag is cleared. I_WILL_FREE, I_FREEING and I_CLEAR are set at
1887 * various stages of removing an inode.
1888 *
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001889 * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001890 *
Joern Engele7ca2d42008-02-06 01:36:59 -08001891 * I_DIRTY_SYNC Inode is dirty, but doesn't have to be written on
1892 * fdatasync(). i_atime is the usual cause.
Jan Kara000cb482008-02-14 19:31:32 -08001893 * I_DIRTY_DATASYNC Data-related inode changes pending. We keep track of
1894 * these changes separately from I_DIRTY_SYNC so that we
1895 * don't have to write inode on fdatasync() when only
1896 * mtime has changed in it.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001897 * I_DIRTY_PAGES Inode has dirty pages. Inode itself may be clean.
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001898 * I_NEW Serves as both a mutex and completion notification.
1899 * New inodes set I_NEW. If two processes both create
1900 * the same inode, one of them will release its inode and
1901 * wait for I_NEW to be released before returning.
1902 * Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can
1903 * also cause waiting on I_NEW, without I_NEW actually
1904 * being set. find_inode() uses this to prevent returning
1905 * nearly-dead inodes.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001906 * I_WILL_FREE Must be set when calling write_inode_now() if i_count
1907 * is zero. I_FREEING must be set when I_WILL_FREE is
1908 * cleared.
1909 * I_FREEING Set when inode is about to be freed but still has dirty
1910 * pages or buffers attached or the inode itself is still
1911 * dirty.
Jan Karadbd57682012-05-03 14:48:02 +02001912 * I_CLEAR Added by clear_inode(). In this state the inode is
1913 * clean and can be destroyed. Inode keeps I_FREEING.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001914 *
1915 * Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are
1916 * prohibited for many purposes. iget() must wait for
1917 * the inode to be completely released, then create it
1918 * anew. Other functions will just ignore such inodes,
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001919 * if appropriate. I_NEW is used for waiting.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001920 *
Jan Kara169ebd92012-05-03 14:48:03 +02001921 * I_SYNC Writeback of inode is running. The bit is set during
1922 * data writeback, and cleared with a wakeup on the bit
1923 * address once it is done. The bit is also used to pin
1924 * the inode in memory for flusher thread.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001925 *
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -04001926 * I_REFERENCED Marks the inode as recently references on the LRU list.
1927 *
1928 * I_DIO_WAKEUP Never set. Only used as a key for wait_on_bit().
1929 *
Tejun Heo682aa8e2015-05-28 14:50:53 -04001930 * I_WB_SWITCH Cgroup bdi_writeback switching in progress. Used to
1931 * synchronize competing switching instances and to tell
1932 * wb stat updates to grab mapping->tree_lock. See
1933 * inode_switch_wb_work_fn() for details.
1934 *
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001935 * Q: What is the difference between I_WILL_FREE and I_FREEING?
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001936 */
Nick Piggin9e38d862010-10-23 06:55:17 -04001937#define I_DIRTY_SYNC (1 << 0)
1938#define I_DIRTY_DATASYNC (1 << 1)
1939#define I_DIRTY_PAGES (1 << 2)
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001940#define __I_NEW 3
1941#define I_NEW (1 << __I_NEW)
Nick Piggin9e38d862010-10-23 06:55:17 -04001942#define I_WILL_FREE (1 << 4)
1943#define I_FREEING (1 << 5)
1944#define I_CLEAR (1 << 6)
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001945#define __I_SYNC 7
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001946#define I_SYNC (1 << __I_SYNC)
Nick Piggin9e38d862010-10-23 06:55:17 -04001947#define I_REFERENCED (1 << 8)
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -04001948#define __I_DIO_WAKEUP 9
Eric Sandeenac74d8d2015-04-16 15:04:56 -05001949#define I_DIO_WAKEUP (1 << __I_DIO_WAKEUP)
Al Virof4e0c302013-06-11 08:34:36 +04001950#define I_LINKABLE (1 << 10)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001951#define I_DIRTY_TIME (1 << 11)
1952#define __I_DIRTY_TIME_EXPIRED 12
1953#define I_DIRTY_TIME_EXPIRED (1 << __I_DIRTY_TIME_EXPIRED)
Tejun Heo682aa8e2015-05-28 14:50:53 -04001954#define I_WB_SWITCH (1 << 13)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955
1956#define I_DIRTY (I_DIRTY_SYNC | I_DIRTY_DATASYNC | I_DIRTY_PAGES)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001957#define I_DIRTY_ALL (I_DIRTY | I_DIRTY_TIME)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001958
1959extern void __mark_inode_dirty(struct inode *, int);
1960static inline void mark_inode_dirty(struct inode *inode)
1961{
1962 __mark_inode_dirty(inode, I_DIRTY);
1963}
1964
1965static inline void mark_inode_dirty_sync(struct inode *inode)
1966{
1967 __mark_inode_dirty(inode, I_DIRTY_SYNC);
1968}
1969
Miklos Szeredi7ada4db2011-11-21 12:11:32 +01001970extern void inc_nlink(struct inode *inode);
1971extern void drop_nlink(struct inode *inode);
1972extern void clear_nlink(struct inode *inode);
1973extern void set_nlink(struct inode *inode, unsigned int nlink);
Dave Hansend8c76e62006-09-30 23:29:04 -07001974
1975static inline void inode_inc_link_count(struct inode *inode)
1976{
1977 inc_nlink(inode);
Alexey Dobriyan66d21732006-03-23 03:00:51 -08001978 mark_inode_dirty(inode);
1979}
1980
Dave Hansen9a53c3a2006-09-30 23:29:03 -07001981static inline void inode_dec_link_count(struct inode *inode)
1982{
1983 drop_nlink(inode);
Alexey Dobriyan66d21732006-03-23 03:00:51 -08001984 mark_inode_dirty(inode);
1985}
1986
Jean Noel Cordenner25ec56b2008-01-28 23:58:27 -05001987/**
1988 * inode_inc_iversion - increments i_version
1989 * @inode: inode that need to be updated
1990 *
1991 * Every time the inode is modified, the i_version field will be incremented.
1992 * The filesystem has to be mounted with i_version flag
1993 */
1994
1995static inline void inode_inc_iversion(struct inode *inode)
1996{
1997 spin_lock(&inode->i_lock);
1998 inode->i_version++;
1999 spin_unlock(&inode->i_lock);
2000}
2001
Josef Bacikc3b2da32012-03-26 09:59:21 -04002002enum file_time_flags {
2003 S_ATIME = 1,
2004 S_MTIME = 2,
2005 S_CTIME = 4,
2006 S_VERSION = 8,
2007};
2008
NeilBrown8fa9dd22015-03-23 13:37:40 +11002009extern bool atime_needs_update(const struct path *, struct inode *);
Al Virobadcf2b2013-07-16 18:15:46 +04002010extern void touch_atime(const struct path *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002011static inline void file_accessed(struct file *file)
2012{
2013 if (!(file->f_flags & O_NOATIME))
Al Viro68ac1232012-03-15 08:21:57 -04002014 touch_atime(&file->f_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015}
2016
2017int sync_inode(struct inode *inode, struct writeback_control *wbc);
Christoph Hellwigc37650162010-10-06 10:48:20 +02002018int sync_inode_metadata(struct inode *inode, int wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019
Linus Torvalds1da177e2005-04-16 15:20:36 -07002020struct file_system_type {
2021 const char *name;
2022 int fs_flags;
David Howellsbbc10962012-10-15 16:40:35 +01002023#define FS_REQUIRES_DEV 1
2024#define FS_BINARY_MOUNTDATA 2
2025#define FS_HAS_SUBTYPE 4
Eric W. Biederman0c55cfc2012-07-26 21:42:03 -07002026#define FS_USERNS_MOUNT 8 /* Can be mounted by userns root */
David Howellsbbc10962012-10-15 16:40:35 +01002027#define FS_RENAME_DOES_D_MOVE 32768 /* FS will handle d_move() during rename() internally. */
Al Viroc96e41e2010-07-25 00:17:56 +04002028 struct dentry *(*mount) (struct file_system_type *, int,
2029 const char *, void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002030 void (*kill_sb) (struct super_block *);
2031 struct module *owner;
2032 struct file_system_type * next;
Al Viroa5166162011-12-12 22:53:00 -05002033 struct hlist_head fs_supers;
Peter Zijlstrad475fd42007-10-15 14:51:31 +02002034
Ingo Molnarcf516242006-07-03 00:25:27 -07002035 struct lock_class_key s_lock_key;
Arjan van de Ven897c6ff2006-07-03 00:25:28 -07002036 struct lock_class_key s_umount_key;
Roland Dreier51ee0492010-04-27 14:23:57 -07002037 struct lock_class_key s_vfs_rename_key;
Jan Kara5accdf82012-06-12 16:20:34 +02002038 struct lock_class_key s_writers_key[SB_FREEZE_LEVELS];
Peter Zijlstrad475fd42007-10-15 14:51:31 +02002039
2040 struct lock_class_key i_lock_key;
2041 struct lock_class_key i_mutex_key;
Peter Zijlstra14358e62007-10-14 01:38:33 +02002042 struct lock_class_key i_mutex_dir_key;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043};
2044
Eric W. Biederman7f78e032013-03-02 19:39:14 -08002045#define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME)
2046
Eric W. Biedermand91ee872016-05-23 14:51:59 -05002047extern struct dentry *mount_ns(struct file_system_type *fs_type,
2048 int flags, void *data, void *ns, struct user_namespace *user_ns,
2049 int (*fill_super)(struct super_block *, void *, int));
Al Viro152a0832010-07-25 00:46:55 +04002050extern struct dentry *mount_bdev(struct file_system_type *fs_type,
2051 int flags, const char *dev_name, void *data,
2052 int (*fill_super)(struct super_block *, void *, int));
Al Virofc14f2f2010-07-25 01:48:30 +04002053extern struct dentry *mount_single(struct file_system_type *fs_type,
2054 int flags, void *data,
2055 int (*fill_super)(struct super_block *, void *, int));
Al Viro3c26ff62010-07-25 11:46:36 +04002056extern struct dentry *mount_nodev(struct file_system_type *fs_type,
2057 int flags, void *data,
2058 int (*fill_super)(struct super_block *, void *, int));
Al Viroea441d12011-11-16 21:43:59 -05002059extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060void generic_shutdown_super(struct super_block *sb);
2061void kill_block_super(struct super_block *sb);
2062void kill_anon_super(struct super_block *sb);
2063void kill_litter_super(struct super_block *sb);
2064void deactivate_super(struct super_block *sb);
Al Viro74dbbdd2009-05-06 01:07:50 -04002065void deactivate_locked_super(struct super_block *sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002066int set_anon_super(struct super_block *s, void *data);
Al Viro0ee5dc62011-07-07 15:44:25 -04002067int get_anon_bdev(dev_t *);
2068void free_anon_bdev(dev_t);
Eric W. Biederman6e4eab52016-05-24 09:29:01 -05002069struct super_block *sget_userns(struct file_system_type *type,
2070 int (*test)(struct super_block *,void *),
2071 int (*set)(struct super_block *,void *),
2072 int flags, struct user_namespace *user_ns,
2073 void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074struct super_block *sget(struct file_system_type *type,
2075 int (*test)(struct super_block *,void *),
2076 int (*set)(struct super_block *,void *),
David Howells9249e172012-06-25 12:55:37 +01002077 int flags, void *data);
Al Viro51139ad2010-07-25 23:47:46 +04002078extern struct dentry *mount_pseudo(struct file_system_type *, char *,
Al Viroc74a1cb2011-01-12 16:59:34 -05002079 const struct super_operations *ops,
2080 const struct dentry_operations *dops,
2081 unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002082
2083/* Alas, no aliases. Too much hassle with bringing module.h everywhere */
2084#define fops_get(fops) \
2085 (((fops) && try_module_get((fops)->owner) ? (fops) : NULL))
2086#define fops_put(fops) \
2087 do { if (fops) module_put((fops)->owner); } while(0)
Al Viroe84f9e52013-09-22 14:17:15 -04002088/*
2089 * This one is to be used *ONLY* from ->open() instances.
2090 * fops must be non-NULL, pinned down *and* module dependencies
2091 * should be sufficient to pin the caller down as well.
2092 */
2093#define replace_fops(f, fops) \
2094 do { \
2095 struct file *__file = (f); \
2096 fops_put(__file->f_op); \
2097 BUG_ON(!(__file->f_op = (fops))); \
2098 } while(0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099
2100extern int register_filesystem(struct file_system_type *);
2101extern int unregister_filesystem(struct file_system_type *);
Pavel Emelyanov8bf97252007-10-18 23:40:02 -07002102extern struct vfsmount *kern_mount_data(struct file_system_type *, void *data);
2103#define kern_mount(type) kern_mount_data(type, NULL)
Tim Chen423e0ab2011-07-19 09:32:38 -07002104extern void kern_unmount(struct vfsmount *mnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105extern int may_umount_tree(struct vfsmount *);
2106extern int may_umount(struct vfsmount *);
Seunghun Lee5e6123f2014-09-14 22:15:10 +09002107extern long do_mount(const char *, const char __user *,
2108 const char *, unsigned long, void *);
Al Viro589ff872009-04-18 03:28:19 -04002109extern struct vfsmount *collect_mounts(struct path *);
Al Viro8aec0802007-06-07 12:20:32 -04002110extern void drop_collected_mounts(struct vfsmount *);
Al Viro1f707132010-01-30 22:51:25 -05002111extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
2112 struct vfsmount *);
Christoph Hellwigebabe9a2010-07-07 18:53:11 +02002113extern int vfs_statfs(struct path *, struct kstatfs *);
Al Viroc8b91ac2011-03-12 10:41:39 -05002114extern int user_statfs(const char __user *, struct kstatfs *);
2115extern int fd_statfs(int, struct kstatfs *);
Al Virocf31e702012-01-02 22:28:36 -05002116extern int vfs_ustat(dev_t, struct kstatfs *);
Josef Bacik18e9e512010-03-23 10:34:56 -04002117extern int freeze_super(struct super_block *super);
2118extern int thaw_super(struct super_block *super);
Al Viro02125a82011-12-05 08:43:34 -05002119extern bool our_mnt(struct vfsmount *mnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120
Al Viroce3b0f82009-03-29 19:08:22 -04002121extern int current_umask(void);
2122
J. Bruce Fields5a146962012-08-28 07:50:40 -07002123extern void ihold(struct inode * inode);
2124extern void iput(struct inode *);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05002125extern int generic_update_time(struct inode *, struct timespec *, int);
J. Bruce Fields5a146962012-08-28 07:50:40 -07002126
Miklos Szeredif87fd4c2006-01-16 22:14:23 -08002127/* /sys/fs */
Greg Kroah-Hartman00d26662007-10-29 14:17:23 -06002128extern struct kobject *fs_kobj;
Miklos Szeredif87fd4c2006-01-16 22:14:23 -08002129
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002130#define MAX_RW_COUNT (INT_MAX & PAGE_MASK)
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002131
Jeff Layton9e8925b2015-11-16 09:49:34 -05002132#ifdef CONFIG_MANDATORY_FILE_LOCKING
Jeff Laytond7a06982014-03-10 09:54:15 -04002133extern int locks_mandatory_locked(struct file *);
Christoph Hellwigacc15572015-12-03 12:59:49 +01002134extern int locks_mandatory_area(struct inode *, struct file *, loff_t, loff_t, unsigned char);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135
2136/*
2137 * Candidates for mandatory locking have the setgid bit set
2138 * but no group execute bit - an otherwise meaningless combination.
2139 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002140
2141static inline int __mandatory_lock(struct inode *ino)
2142{
2143 return (ino->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID;
2144}
2145
2146/*
2147 * ... and these candidates should be on MS_MANDLOCK mounted fs,
2148 * otherwise these will be advisory locks
2149 */
2150
2151static inline int mandatory_lock(struct inode *ino)
2152{
2153 return IS_MANDLOCK(ino) && __mandatory_lock(ino);
2154}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155
Jeff Laytond7a06982014-03-10 09:54:15 -04002156static inline int locks_verify_locked(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157{
Jeff Laytond7a06982014-03-10 09:54:15 -04002158 if (mandatory_lock(file_inode(file)))
2159 return locks_mandatory_locked(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160 return 0;
2161}
2162
Linus Torvalds1da177e2005-04-16 15:20:36 -07002163static inline int locks_verify_truncate(struct inode *inode,
Christoph Hellwigacc15572015-12-03 12:59:49 +01002164 struct file *f,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165 loff_t size)
2166{
Christoph Hellwigacc15572015-12-03 12:59:49 +01002167 if (!inode->i_flctx || !mandatory_lock(inode))
2168 return 0;
2169
2170 if (size < inode->i_size) {
2171 return locks_mandatory_area(inode, f, size, inode->i_size - 1,
2172 F_WRLCK);
2173 } else {
2174 return locks_mandatory_area(inode, f, inode->i_size, size - 1,
2175 F_WRLCK);
2176 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177}
2178
Jeff Layton9e8925b2015-11-16 09:49:34 -05002179#else /* !CONFIG_MANDATORY_FILE_LOCKING */
2180
2181static inline int locks_mandatory_locked(struct file *file)
2182{
2183 return 0;
2184}
2185
Linus Torvaldsfce205e2016-01-12 16:30:34 -08002186static inline int locks_mandatory_area(struct inode *inode, struct file *filp,
2187 loff_t start, loff_t end, unsigned char type)
Jeff Layton9e8925b2015-11-16 09:49:34 -05002188{
2189 return 0;
2190}
2191
2192static inline int __mandatory_lock(struct inode *inode)
2193{
2194 return 0;
2195}
2196
2197static inline int mandatory_lock(struct inode *inode)
2198{
2199 return 0;
2200}
2201
2202static inline int locks_verify_locked(struct file *file)
2203{
2204 return 0;
2205}
2206
2207static inline int locks_verify_truncate(struct inode *inode, struct file *filp,
2208 size_t size)
2209{
2210 return 0;
2211}
2212
2213#endif /* CONFIG_MANDATORY_FILE_LOCKING */
2214
2215
2216#ifdef CONFIG_FILE_LOCKING
Linus Torvalds1da177e2005-04-16 15:20:36 -07002217static inline int break_lease(struct inode *inode, unsigned int mode)
2218{
Jeff Layton24cbe782014-02-03 12:13:06 -05002219 /*
2220 * Since this check is lockless, we must ensure that any refcounts
Jeff Layton8116bf42015-01-21 20:44:01 -05002221 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2222 * could end up racing with tasks trying to set a new lease on this
2223 * file.
Jeff Layton24cbe782014-02-03 12:13:06 -05002224 */
2225 smp_mb();
Jeff Layton8634b512015-01-16 15:05:55 -05002226 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002227 return __break_lease(inode, mode, FL_LEASE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002228 return 0;
2229}
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002230
2231static inline int break_deleg(struct inode *inode, unsigned int mode)
2232{
Jeff Layton962bd402014-06-10 12:24:40 -04002233 /*
2234 * Since this check is lockless, we must ensure that any refcounts
Jeff Layton8116bf42015-01-21 20:44:01 -05002235 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2236 * could end up racing with tasks trying to set a new lease on this
2237 * file.
Jeff Layton962bd402014-06-10 12:24:40 -04002238 */
2239 smp_mb();
Jeff Layton8634b512015-01-16 15:05:55 -05002240 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002241 return __break_lease(inode, mode, FL_DELEG);
2242 return 0;
2243}
2244
J. Bruce Fields5a146962012-08-28 07:50:40 -07002245static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2246{
2247 int ret;
2248
2249 ret = break_deleg(inode, O_WRONLY|O_NONBLOCK);
2250 if (ret == -EWOULDBLOCK && delegated_inode) {
2251 *delegated_inode = inode;
2252 ihold(inode);
2253 }
2254 return ret;
2255}
2256
2257static inline int break_deleg_wait(struct inode **delegated_inode)
2258{
2259 int ret;
2260
2261 ret = break_deleg(*delegated_inode, O_WRONLY);
2262 iput(*delegated_inode);
2263 *delegated_inode = NULL;
2264 return ret;
2265}
2266
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01002267static inline int break_layout(struct inode *inode, bool wait)
2268{
2269 smp_mb();
2270 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2271 return __break_lease(inode,
2272 wait ? O_WRONLY : O_WRONLY | O_NONBLOCK,
2273 FL_LAYOUT);
2274 return 0;
2275}
2276
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002277#else /* !CONFIG_FILE_LOCKING */
Steven Whitehouseaf5df562009-01-20 10:29:46 +00002278static inline int break_lease(struct inode *inode, unsigned int mode)
2279{
2280 return 0;
2281}
2282
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002283static inline int break_deleg(struct inode *inode, unsigned int mode)
2284{
2285 return 0;
2286}
J. Bruce Fields5a146962012-08-28 07:50:40 -07002287
2288static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2289{
2290 return 0;
2291}
2292
2293static inline int break_deleg_wait(struct inode **delegated_inode)
2294{
2295 BUG();
2296 return 0;
2297}
2298
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01002299static inline int break_layout(struct inode *inode, bool wait)
2300{
2301 return 0;
2302}
2303
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002304#endif /* CONFIG_FILE_LOCKING */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002305
2306/* fs/open.c */
Jeff Laytonadb5c242012-10-10 16:43:13 -04002307struct audit_names;
Jeff Layton91a27b22012-10-10 15:25:28 -04002308struct filename {
Jeff Laytonadb5c242012-10-10 16:43:13 -04002309 const char *name; /* pointer to actual string */
2310 const __user char *uptr; /* original userland pointer */
2311 struct audit_names *aname;
Paul Moore55422d02015-01-22 00:00:23 -05002312 int refcnt;
Al Virofd2f7cb2015-02-22 20:07:13 -05002313 const char iname[];
Jeff Layton91a27b22012-10-10 15:25:28 -04002314};
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315
Al Viro7df818b2016-03-25 14:24:09 -04002316extern long vfs_truncate(const struct path *, loff_t);
NeilBrown4a301312006-01-08 01:02:39 -08002317extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
2318 struct file *filp);
Anna Schumaker72c72bd2014-11-07 14:44:25 -05002319extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
Ankit Jain3e63cbb2009-06-19 14:28:07 -04002320 loff_t len);
Jason Uhlenkott8e8a1402007-10-20 03:16:18 +02002321extern long do_sys_open(int dfd, const char __user *filename, int flags,
Al Viroa218d0f2011-11-21 14:59:34 -05002322 umode_t mode);
Jeff Layton669abf42012-10-10 16:43:10 -04002323extern struct file *file_open_name(struct filename *, int, umode_t);
Al Viroa218d0f2011-11-21 14:59:34 -05002324extern struct file *filp_open(const char *, int, umode_t);
Al Viro73d049a2011-03-11 12:08:24 -05002325extern struct file *file_open_root(struct dentry *, struct vfsmount *,
Jann Horn378c6522016-03-22 14:25:36 -07002326 const char *, int, umode_t);
Al Viro765927b2012-06-26 21:58:53 +04002327extern struct file * dentry_open(const struct path *, int, const struct cred *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002328extern int filp_close(struct file *, fl_owner_t id);
Jeff Layton91a27b22012-10-10 15:25:28 -04002329
David Drysdale51f39a12014-12-12 16:57:29 -08002330extern struct filename *getname_flags(const char __user *, int, int *);
Jeff Layton91a27b22012-10-10 15:25:28 -04002331extern struct filename *getname(const char __user *);
Linus Torvaldsc4ad8f92014-02-05 12:54:53 -08002332extern struct filename *getname_kernel(const char *);
Paul Moore55422d02015-01-22 00:00:23 -05002333extern void putname(struct filename *name);
Jeff Layton91a27b22012-10-10 15:25:28 -04002334
Al Viro47237682012-06-10 05:01:45 -04002335enum {
2336 FILE_CREATED = 1,
2337 FILE_OPENED = 2
2338};
Al Viro30d90492012-06-22 12:40:19 +04002339extern int finish_open(struct file *file, struct dentry *dentry,
2340 int (*open)(struct inode *, struct file *),
2341 int *opened);
Al Viroe45198a2012-06-10 06:48:09 -04002342extern int finish_no_open(struct file *file, struct dentry *dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002343
Ankit Jain3e63cbb2009-06-19 14:28:07 -04002344/* fs/ioctl.c */
2345
2346extern int ioctl_preallocate(struct file *filp, void __user *argp);
2347
Linus Torvalds1da177e2005-04-16 15:20:36 -07002348/* fs/dcache.c */
2349extern void __init vfs_caches_init_early(void);
Mel Gorman4248b0d2015-08-06 15:46:20 -07002350extern void __init vfs_caches_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002351
Christoph Lameterb86c0892006-12-06 20:32:57 -08002352extern struct kmem_cache *names_cachep;
2353
Jeff Laytona608ca22012-10-10 15:25:26 -04002354#define __getname() kmem_cache_alloc(names_cachep, GFP_KERNEL)
Vegard Nossum3446a8a2009-05-16 11:22:14 +02002355#define __putname(name) kmem_cache_free(names_cachep, (void *)(name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002356
David Howells93614012006-09-30 20:45:40 +02002357#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002358extern int register_blkdev(unsigned int, const char *);
Akinobu Mitaf4480242007-07-17 04:03:47 -07002359extern void unregister_blkdev(unsigned int, const char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002360extern struct block_device *bdget(dev_t);
Alan Jenkinsdddac6a2009-07-29 21:07:55 +02002361extern struct block_device *bdgrab(struct block_device *bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002362extern void bd_set_size(struct block_device *, loff_t size);
2363extern void bd_forget(struct inode *inode);
2364extern void bdput(struct block_device *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002365extern void invalidate_bdev(struct block_device *);
Jan Kara5c0d6b62012-07-03 16:45:31 +02002366extern void iterate_bdevs(void (*)(struct block_device *, void *), void *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002367extern int sync_blockdev(struct block_device *bdev);
Al Viroff01bb42011-09-16 02:31:11 -04002368extern void kill_bdev(struct block_device *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002369extern struct super_block *freeze_bdev(struct block_device *);
Eric Sandeenc2d75432009-03-31 15:23:46 -07002370extern void emergency_thaw_all(void);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002371extern int thaw_bdev(struct block_device *bdev, struct super_block *sb);
2372extern int fsync_bdev(struct block_device *);
Tejun Heoa212b102015-05-22 17:13:33 -04002373
2374extern struct super_block *blockdev_superblock;
2375
2376static inline bool sb_is_blkdev_sb(struct super_block *sb)
2377{
2378 return sb == blockdev_superblock;
2379}
David Howells93614012006-09-30 20:45:40 +02002380#else
2381static inline void bd_forget(struct inode *inode) {}
Al Viro47e44912009-04-01 07:07:16 -04002382static inline int sync_blockdev(struct block_device *bdev) { return 0; }
Al Viroff01bb42011-09-16 02:31:11 -04002383static inline void kill_bdev(struct block_device *bdev) {}
Al Viro47e44912009-04-01 07:07:16 -04002384static inline void invalidate_bdev(struct block_device *bdev) {}
2385
2386static inline struct super_block *freeze_bdev(struct block_device *sb)
2387{
2388 return NULL;
2389}
2390
2391static inline int thaw_bdev(struct block_device *bdev, struct super_block *sb)
2392{
2393 return 0;
2394}
Jan Kara5c0d6b62012-07-03 16:45:31 +02002395
2396static inline void iterate_bdevs(void (*f)(struct block_device *, void *), void *arg)
2397{
2398}
Jan Karaa8855992013-07-09 22:36:45 +08002399
Yaowei Bai3e004ee2015-11-17 14:40:09 +08002400static inline bool sb_is_blkdev_sb(struct super_block *sb)
Jan Karaa8855992013-07-09 22:36:45 +08002401{
Yaowei Bai3e004ee2015-11-17 14:40:09 +08002402 return false;
Jan Karaa8855992013-07-09 22:36:45 +08002403}
David Howells93614012006-09-30 20:45:40 +02002404#endif
Jan Kara60b06802009-04-27 16:43:53 +02002405extern int sync_filesystem(struct super_block *);
David Howells93614012006-09-30 20:45:40 +02002406extern const struct file_operations def_blk_fops;
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08002407extern const struct file_operations def_chr_fops;
David Howells93614012006-09-30 20:45:40 +02002408#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002409extern int ioctl_by_bdev(struct block_device *, unsigned, unsigned long);
Al Viro56b26ad2008-09-19 03:17:36 -04002410extern int blkdev_ioctl(struct block_device *, fmode_t, unsigned, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002411extern long compat_blkdev_ioctl(struct file *, unsigned, unsigned long);
Tejun Heoe525fd82010-11-13 11:55:17 +01002412extern int blkdev_get(struct block_device *bdev, fmode_t mode, void *holder);
Tejun Heod4d77622010-11-13 11:55:18 +01002413extern struct block_device *blkdev_get_by_path(const char *path, fmode_t mode,
2414 void *holder);
2415extern struct block_device *blkdev_get_by_dev(dev_t dev, fmode_t mode,
2416 void *holder);
Al Viro4385bab2013-05-05 22:11:03 -04002417extern void blkdev_put(struct block_device *bdev, fmode_t mode);
Jarod Wilsonbe324172015-05-06 12:26:22 +08002418extern int __blkdev_reread_part(struct block_device *bdev);
2419extern int blkdev_reread_part(struct block_device *bdev);
2420
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002421#ifdef CONFIG_SYSFS
Tejun Heoe09b4572010-11-13 11:55:17 +01002422extern int bd_link_disk_holder(struct block_device *bdev, struct gendisk *disk);
Tejun Heo49731ba2011-01-14 18:43:57 +01002423extern void bd_unlink_disk_holder(struct block_device *bdev,
2424 struct gendisk *disk);
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002425#else
Tejun Heoe09b4572010-11-13 11:55:17 +01002426static inline int bd_link_disk_holder(struct block_device *bdev,
2427 struct gendisk *disk)
2428{
2429 return 0;
2430}
Tejun Heo49731ba2011-01-14 18:43:57 +01002431static inline void bd_unlink_disk_holder(struct block_device *bdev,
2432 struct gendisk *disk)
2433{
2434}
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002435#endif
David Howells93614012006-09-30 20:45:40 +02002436#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002437
2438/* fs/char_dev.c */
Joe Korty68eef3b2006-03-31 02:30:32 -08002439#define CHRDEV_MAJOR_HASH_SIZE 255
Linus Walleij49db08c2016-02-19 15:36:07 +01002440/* Marks the bottom of the first segment of free char majors */
2441#define CHRDEV_MAJOR_DYN_END 234
Linus Torvalds1da177e2005-04-16 15:20:36 -07002442extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
2443extern int register_chrdev_region(dev_t, unsigned, const char *);
Tejun Heo1905b1b2009-08-06 18:13:23 +09002444extern int __register_chrdev(unsigned int major, unsigned int baseminor,
2445 unsigned int count, const char *name,
2446 const struct file_operations *fops);
2447extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
2448 unsigned int count, const char *name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002449extern void unregister_chrdev_region(dev_t, unsigned);
Joe Korty68eef3b2006-03-31 02:30:32 -08002450extern void chrdev_show(struct seq_file *,off_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002451
Tejun Heo1905b1b2009-08-06 18:13:23 +09002452static inline int register_chrdev(unsigned int major, const char *name,
2453 const struct file_operations *fops)
2454{
2455 return __register_chrdev(major, 0, 256, name, fops);
2456}
2457
2458static inline void unregister_chrdev(unsigned int major, const char *name)
2459{
2460 __unregister_chrdev(major, 0, 256, name);
2461}
2462
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463/* fs/block_dev.c */
2464#define BDEVNAME_SIZE 32 /* Largest string for a blockdev identifier */
Tejun Heo1f014292008-08-25 19:47:23 +09002465#define BDEVT_SIZE 10 /* Largest string for MAJ:MIN for blkdev */
David Howells93614012006-09-30 20:45:40 +02002466
2467#ifdef CONFIG_BLOCK
2468#define BLKDEV_MAJOR_HASH_SIZE 255
Linus Torvalds1da177e2005-04-16 15:20:36 -07002469extern const char *__bdevname(dev_t, char *buffer);
2470extern const char *bdevname(struct block_device *bdev, char *buffer);
2471extern struct block_device *lookup_bdev(const char *);
Joe Korty68eef3b2006-03-31 02:30:32 -08002472extern void blkdev_show(struct seq_file *,off_t);
Al Viro30c40d22008-02-22 19:50:45 -05002473
David Howells93614012006-09-30 20:45:40 +02002474#else
2475#define BLKDEV_MAJOR_HASH_SIZE 0
2476#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002477
2478extern void init_special_inode(struct inode *, umode_t, dev_t);
2479
2480/* Invalid inode operations -- fs/bad_inode.c */
2481extern void make_bad_inode(struct inode *);
Yaowei Bai0e3ef1f2015-11-19 21:00:11 +08002482extern bool is_bad_inode(struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002483
Jens Axboec11f0c02016-08-05 08:11:04 -06002484#ifdef CONFIG_BLOCK
Mike Christie4e1b2d522016-06-05 14:32:22 -05002485static inline bool op_is_write(unsigned int op)
Mike Christief2150822016-06-05 14:31:42 -05002486{
Mike Christie4e1b2d522016-06-05 14:32:22 -05002487 return op == REQ_OP_READ ? false : true;
Mike Christief2150822016-06-05 14:31:42 -05002488}
2489
2490/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002491 * return data direction, READ or WRITE
2492 */
Mike Christief2150822016-06-05 14:31:42 -05002493static inline int bio_data_dir(struct bio *bio)
2494{
Mike Christie4e1b2d522016-06-05 14:32:22 -05002495 return op_is_write(bio_op(bio)) ? WRITE : READ;
Mike Christief2150822016-06-05 14:31:42 -05002496}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002497
Andrew Pattersonc3279d12008-09-04 14:27:25 -06002498extern void check_disk_size_change(struct gendisk *disk,
2499 struct block_device *bdev);
Andrew Patterson0c002c22008-09-04 14:27:20 -06002500extern int revalidate_disk(struct gendisk *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002501extern int check_disk_change(struct block_device *);
NeilBrown93b270f2011-02-24 17:25:47 +11002502extern int __invalidate_device(struct block_device *, bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002503extern int invalidate_partition(struct gendisk *, int);
David Howells93614012006-09-30 20:45:40 +02002504#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002505unsigned long invalidate_mapping_pages(struct address_space *mapping,
2506 pgoff_t start, pgoff_t end);
Anton Altaparmakov54bc4852007-02-10 01:45:38 -08002507
Linus Torvalds1da177e2005-04-16 15:20:36 -07002508static inline void invalidate_remote_inode(struct inode *inode)
2509{
2510 if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
2511 S_ISLNK(inode->i_mode))
Andrew Mortonfc0ecff2007-02-10 01:45:39 -08002512 invalidate_mapping_pages(inode->i_mapping, 0, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002513}
2514extern int invalidate_inode_pages2(struct address_space *mapping);
2515extern int invalidate_inode_pages2_range(struct address_space *mapping,
2516 pgoff_t start, pgoff_t end);
2517extern int write_inode_now(struct inode *, int);
2518extern int filemap_fdatawrite(struct address_space *);
2519extern int filemap_flush(struct address_space *);
2520extern int filemap_fdatawait(struct address_space *);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -08002521extern void filemap_fdatawait_keep_errors(struct address_space *);
Jan Karad3bccb6f2009-08-17 19:30:27 +02002522extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
2523 loff_t lend);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002524extern int filemap_write_and_wait(struct address_space *mapping);
2525extern int filemap_write_and_wait_range(struct address_space *mapping,
2526 loff_t lstart, loff_t lend);
Andrew Mortonebcf28e2006-03-24 03:18:04 -08002527extern int __filemap_fdatawrite_range(struct address_space *mapping,
2528 loff_t start, loff_t end, int sync_mode);
Jan Karaf4c0a0f2008-07-11 19:27:31 -04002529extern int filemap_fdatawrite_range(struct address_space *mapping,
2530 loff_t start, loff_t end);
Miklos Szeredid72d9e22016-07-29 14:10:57 +02002531extern int filemap_check_errors(struct address_space *mapping);
Andrew Mortonebcf28e2006-03-24 03:18:04 -08002532
Christoph Hellwig8018ab02010-03-22 17:32:25 +01002533extern int vfs_fsync_range(struct file *file, loff_t start, loff_t end,
2534 int datasync);
2535extern int vfs_fsync(struct file *file, int datasync);
Christoph Hellwige2592212016-04-07 08:52:01 -07002536
2537/*
2538 * Sync the bytes written if this was a synchronous write. Expect ki_pos
2539 * to already be updated for the write, and will return either the amount
2540 * of bytes passed in, or an error if syncing the file failed.
2541 */
2542static inline ssize_t generic_write_sync(struct kiocb *iocb, ssize_t count)
Al Virod311d792014-02-09 15:18:09 -05002543{
Christoph Hellwige2592212016-04-07 08:52:01 -07002544 if (iocb->ki_flags & IOCB_DSYNC) {
2545 int ret = vfs_fsync_range(iocb->ki_filp,
2546 iocb->ki_pos - count, iocb->ki_pos - 1,
2547 (iocb->ki_flags & IOCB_SYNC) ? 0 : 1);
2548 if (ret)
2549 return ret;
2550 }
2551
2552 return count;
Al Virod311d792014-02-09 15:18:09 -05002553}
Christoph Hellwige2592212016-04-07 08:52:01 -07002554
Linus Torvalds1da177e2005-04-16 15:20:36 -07002555extern void emergency_sync(void);
2556extern void emergency_remount(void);
David Howells93614012006-09-30 20:45:40 +02002557#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002558extern sector_t bmap(struct inode *, sector_t);
David Howells93614012006-09-30 20:45:40 +02002559#endif
J. Bruce Fields27ac0ff2011-09-20 17:19:26 -04002560extern int notify_change(struct dentry *, struct iattr *, struct inode **);
Al Virof419a2e2008-07-22 00:07:17 -04002561extern int inode_permission(struct inode *, int);
Miklos Szeredibd5d0852014-10-24 00:14:35 +02002562extern int __inode_permission(struct inode *, int);
Al Viro2830ba72011-06-20 19:16:29 -04002563extern int generic_permission(struct inode *, int);
Miklos Szeredicbdf35b2014-10-24 00:14:36 +02002564extern int __check_sticky(struct inode *dir, struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002565
Miklos Szeredif696a362008-07-31 13:41:58 +02002566static inline bool execute_ok(struct inode *inode)
2567{
2568 return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
2569}
2570
Al Viro8d71db42013-03-19 21:01:03 -04002571static inline void file_start_write(struct file *file)
2572{
2573 if (!S_ISREG(file_inode(file)->i_mode))
2574 return;
2575 __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, true);
2576}
2577
Jan Kara5ae98f12013-05-04 00:11:23 +02002578static inline bool file_start_write_trylock(struct file *file)
2579{
2580 if (!S_ISREG(file_inode(file)->i_mode))
2581 return true;
2582 return __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, false);
2583}
2584
Al Viro8d71db42013-03-19 21:01:03 -04002585static inline void file_end_write(struct file *file)
2586{
2587 if (!S_ISREG(file_inode(file)->i_mode))
2588 return;
2589 __sb_end_write(file_inode(file)->i_sb, SB_FREEZE_WRITE);
2590}
2591
Al Viro07b8ce12011-06-20 10:52:57 -04002592/*
2593 * get_write_access() gets write permission for a file.
2594 * put_write_access() releases this write permission.
2595 * This is used for regular files.
2596 * We cannot support write (and maybe mmap read-write shared) accesses and
2597 * MAP_DENYWRITE mmappings simultaneously. The i_writecount field of an inode
2598 * can have the following values:
2599 * 0: no writers, no VM_DENYWRITE mappings
2600 * < 0: (-i_writecount) vm_area_structs with VM_DENYWRITE set exist
2601 * > 0: (i_writecount) users are writing to the file.
2602 *
2603 * Normally we operate on that counter with atomic_{inc,dec} and it's safe
2604 * except for the cases where we don't hold i_writecount yet. Then we need to
2605 * use {get,deny}_write_access() - these functions check the sign and refuse
2606 * to do the change if sign is wrong.
2607 */
2608static inline int get_write_access(struct inode *inode)
2609{
2610 return atomic_inc_unless_negative(&inode->i_writecount) ? 0 : -ETXTBSY;
2611}
2612static inline int deny_write_access(struct file *file)
2613{
Al Viro496ad9a2013-01-23 17:07:38 -05002614 struct inode *inode = file_inode(file);
Al Viro07b8ce12011-06-20 10:52:57 -04002615 return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
2616}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002617static inline void put_write_access(struct inode * inode)
2618{
2619 atomic_dec(&inode->i_writecount);
2620}
2621static inline void allow_write_access(struct file *file)
2622{
2623 if (file)
Al Viro496ad9a2013-01-23 17:07:38 -05002624 atomic_inc(&file_inode(file)->i_writecount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002625}
David Howellsf1fe29b2013-09-27 11:20:03 +01002626static inline bool inode_is_open_for_write(const struct inode *inode)
2627{
2628 return atomic_read(&inode->i_writecount) > 0;
2629}
2630
Mimi Zohara5c96eb2010-11-02 10:11:37 -04002631#ifdef CONFIG_IMA
2632static inline void i_readcount_dec(struct inode *inode)
2633{
2634 BUG_ON(!atomic_read(&inode->i_readcount));
2635 atomic_dec(&inode->i_readcount);
2636}
2637static inline void i_readcount_inc(struct inode *inode)
2638{
2639 atomic_inc(&inode->i_readcount);
2640}
2641#else
2642static inline void i_readcount_dec(struct inode *inode)
2643{
2644 return;
2645}
2646static inline void i_readcount_inc(struct inode *inode)
2647{
2648 return;
2649}
2650#endif
Ulrich Dreppered8cae82008-07-23 21:29:30 -07002651extern int do_pipe_flags(int *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002652
Mimi Zohar1284ab52016-04-20 15:46:27 -07002653#define __kernel_read_file_id(id) \
2654 id(UNKNOWN, unknown) \
2655 id(FIRMWARE, firmware) \
Stephen Boyda098ecd2016-08-02 14:04:28 -07002656 id(FIRMWARE_PREALLOC_BUFFER, firmware) \
Mimi Zohar1284ab52016-04-20 15:46:27 -07002657 id(MODULE, kernel-module) \
2658 id(KEXEC_IMAGE, kexec-image) \
2659 id(KEXEC_INITRAMFS, kexec-initramfs) \
2660 id(POLICY, security-policy) \
2661 id(MAX_ID, )
2662
2663#define __fid_enumify(ENUM, dummy) READING_ ## ENUM,
2664#define __fid_stringify(dummy, str) #str,
2665
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05002666enum kernel_read_file_id {
Mimi Zohar1284ab52016-04-20 15:46:27 -07002667 __kernel_read_file_id(__fid_enumify)
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05002668};
2669
Mimi Zohar1284ab52016-04-20 15:46:27 -07002670static const char * const kernel_read_file_str[] = {
2671 __kernel_read_file_id(__fid_stringify)
2672};
2673
Kees Cookda20dfe2016-04-21 12:53:29 -07002674static inline const char *kernel_read_file_id_str(enum kernel_read_file_id id)
Mimi Zohar1284ab52016-04-20 15:46:27 -07002675{
2676 if (id < 0 || id >= READING_MAX_ID)
2677 return kernel_read_file_str[READING_UNKNOWN];
2678
2679 return kernel_read_file_str[id];
2680}
2681
Mimi Zohar6777d772009-08-21 14:32:48 -04002682extern int kernel_read(struct file *, loff_t, char *, unsigned long);
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05002683extern int kernel_read_file(struct file *, void **, loff_t *, loff_t,
2684 enum kernel_read_file_id);
Mimi Zohar09596b92015-11-19 12:39:22 -05002685extern int kernel_read_file_from_path(char *, void **, loff_t *, loff_t,
2686 enum kernel_read_file_id);
Mimi Zoharb844f0e2016-02-01 08:36:21 -05002687extern int kernel_read_file_from_fd(int, void **, loff_t *, loff_t,
2688 enum kernel_read_file_id);
Al Viro7bb307e2013-02-23 14:51:48 -05002689extern ssize_t kernel_write(struct file *, const char *, size_t, loff_t);
Al Viroed447242014-04-19 14:37:20 -04002690extern ssize_t __kernel_write(struct file *, const char *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002691extern struct file * open_exec(const char *);
2692
2693/* fs/dcache.c -- generic fs support functions */
Yaowei Baia6e57872015-11-17 14:40:11 +08002694extern bool is_subdir(struct dentry *, struct dentry *);
Yaowei Bai25ab4c92015-11-17 14:40:10 +08002695extern bool path_is_under(struct path *, struct path *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002696
Miklos Szeredi9bf39ab2015-06-19 10:29:13 +02002697extern char *file_path(struct file *, char *, int);
2698
Linus Torvalds1da177e2005-04-16 15:20:36 -07002699#include <linux/err.h>
2700
2701/* needed for stackable file system support */
Andrew Morton965c8e52012-12-17 15:59:39 -08002702extern loff_t default_llseek(struct file *file, loff_t offset, int whence);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002703
Andrew Morton965c8e52012-12-17 15:59:39 -08002704extern loff_t vfs_llseek(struct file *file, loff_t offset, int whence);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002705
Christoph Hellwig54e34622009-08-07 14:38:25 -03002706extern int inode_init_always(struct super_block *, struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002707extern void inode_init_once(struct inode *);
Miklos Szeredi2aa15892011-02-23 13:49:47 +01002708extern void address_space_init_once(struct address_space *mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002709extern struct inode * igrab(struct inode *);
2710extern ino_t iunique(struct super_block *, ino_t);
2711extern int inode_needs_sync(struct inode *inode);
Al Viro45321ac2010-06-07 13:43:19 -04002712extern int generic_delete_inode(struct inode *inode);
Al Viro9bcb4b72012-02-12 19:43:17 -05002713static inline int generic_drop_inode(struct inode *inode)
2714{
2715 return !inode->i_nlink || inode_unhashed(inode);
2716}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002717
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07002718extern struct inode *ilookup5_nowait(struct super_block *sb,
2719 unsigned long hashval, int (*test)(struct inode *, void *),
2720 void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002721extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
2722 int (*test)(struct inode *, void *), void *data);
2723extern struct inode *ilookup(struct super_block *sb, unsigned long ino);
2724
2725extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *);
2726extern struct inode * iget_locked(struct super_block *, unsigned long);
Theodore Ts'ofe032c42015-02-02 00:37:01 -05002727extern struct inode *find_inode_nowait(struct super_block *,
2728 unsigned long,
2729 int (*match)(struct inode *,
2730 unsigned long, void *),
2731 void *data);
Al Viro261bca82008-12-30 01:48:21 -05002732extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
2733extern int insert_inode_locked(struct inode *);
Josh Boyere096d0c2011-08-25 07:48:12 -04002734#ifdef CONFIG_DEBUG_LOCK_ALLOC
2735extern void lockdep_annotate_inode_mutex_key(struct inode *inode);
2736#else
2737static inline void lockdep_annotate_inode_mutex_key(struct inode *inode) { };
2738#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002739extern void unlock_new_inode(struct inode *);
Christoph Hellwig85fe4022010-10-23 11:19:54 -04002740extern unsigned int get_next_ino(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002741
Linus Torvalds1da177e2005-04-16 15:20:36 -07002742extern void __iget(struct inode * inode);
David Howellsb46980f2008-02-07 00:15:27 -08002743extern void iget_failed(struct inode *);
Jan Karadbd57682012-05-03 14:48:02 +02002744extern void clear_inode(struct inode *);
Christoph Hellwig2e00c972009-08-07 14:38:29 -03002745extern void __destroy_inode(struct inode *);
Eric Dumazeta209dfc2011-07-26 11:36:34 +02002746extern struct inode *new_inode_pseudo(struct super_block *sb);
2747extern struct inode *new_inode(struct super_block *sb);
Nick Pigginff0c7d12011-01-07 17:49:50 +11002748extern void free_inode_nonrcu(struct inode *inode);
Jens Axboe01de85e2006-10-17 19:50:36 +02002749extern int should_remove_suid(struct dentry *);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02002750extern int file_remove_privs(struct file *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002751
2752extern void __insert_inode_hash(struct inode *, unsigned long hashval);
Christoph Hellwig646ec462010-10-23 07:15:32 -04002753static inline void insert_inode_hash(struct inode *inode)
2754{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002755 __insert_inode_hash(inode, inode->i_ino);
2756}
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +02002757
2758extern void __remove_inode_hash(struct inode *);
2759static inline void remove_inode_hash(struct inode *inode)
2760{
Josef Bacikcbedaac2015-03-12 08:19:11 -04002761 if (!inode_unhashed(inode) && !hlist_fake(&inode->i_hash))
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +02002762 __remove_inode_hash(inode);
2763}
2764
Christoph Hellwig646ec462010-10-23 07:15:32 -04002765extern void inode_sb_list_add(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002766
David Howells93614012006-09-30 20:45:40 +02002767#ifdef CONFIG_BLOCK
Mike Christie4e49ea42016-06-05 14:31:41 -05002768extern blk_qc_t submit_bio(struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002769extern int bdev_read_only(struct block_device *);
David Howells93614012006-09-30 20:45:40 +02002770#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002771extern int set_blocksize(struct block_device *, int);
2772extern int sb_set_blocksize(struct super_block *, int);
2773extern int sb_min_blocksize(struct super_block *, int);
2774
2775extern int generic_file_mmap(struct file *, struct vm_area_struct *);
2776extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
Al Viro3309dd02015-04-09 12:55:47 -04002777extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *);
Al Viroed978a82014-03-05 22:53:04 -05002778extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
Al Viro81742022014-04-03 03:17:43 -04002779extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
Al Viro81742022014-04-03 03:17:43 -04002780extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07002781extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *);
Al Viro3b93f912014-02-11 21:34:08 -05002782extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t);
Andrew Morton88e6fae2006-04-11 13:59:36 +02002783
Christoph Hellwigdbe4e192015-01-25 21:11:59 +01002784ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos);
2785ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos);
2786
Christoph Hellwigeef99382009-08-20 17:43:41 +02002787/* fs/block_dev.c */
David Jefferyb2de5252014-09-29 10:21:10 -04002788extern ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to);
Al Viro1456c0a2014-04-03 03:21:50 -04002789extern ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from);
Josef Bacik02c24a82011-07-16 20:44:56 -04002790extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
2791 int datasync);
Al Viroff01bb42011-09-16 02:31:11 -04002792extern void block_sync_page(struct page *page);
Christoph Hellwigeef99382009-08-20 17:43:41 +02002793
Andrew Morton88e6fae2006-04-11 13:59:36 +02002794/* fs/splice.c */
Jens Axboecbb7e572006-04-11 14:57:50 +02002795extern ssize_t generic_file_splice_read(struct file *, loff_t *,
Andrew Morton88e6fae2006-04-11 13:59:36 +02002796 struct pipe_inode_info *, size_t, unsigned int);
Miklos Szeredi68181732009-05-07 15:37:36 +02002797extern ssize_t default_file_splice_read(struct file *, loff_t *,
2798 struct pipe_inode_info *, size_t, unsigned int);
Al Viro8d020762014-04-05 04:27:08 -04002799extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
Jens Axboecbb7e572006-04-11 14:57:50 +02002800 struct file *, loff_t *, size_t, unsigned int);
Andrew Morton88e6fae2006-04-11 13:59:36 +02002801extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
Jens Axboecbb7e572006-04-11 14:57:50 +02002802 struct file *out, loff_t *, size_t len, unsigned int flags);
Miklos Szeredi1c118592014-10-24 00:14:35 +02002803extern long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
2804 loff_t *opos, size_t len, unsigned int flags);
2805
Andrew Morton88e6fae2006-04-11 13:59:36 +02002806
Linus Torvalds1da177e2005-04-16 15:20:36 -07002807extern void
2808file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
Andrew Morton965c8e52012-12-17 15:59:39 -08002809extern loff_t noop_llseek(struct file *file, loff_t offset, int whence);
2810extern loff_t no_llseek(struct file *file, loff_t offset, int whence);
Jie Liu46a1c2c2013-06-25 12:02:13 +08002811extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
Andrew Morton965c8e52012-12-17 15:59:39 -08002812extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
Andi Kleen57604952011-09-15 16:06:50 -07002813extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
Andrew Morton965c8e52012-12-17 15:59:39 -08002814 int whence, loff_t maxsize, loff_t eof);
Al Viro1bf9d142013-06-16 20:27:42 +04002815extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
2816 int whence, loff_t size);
Al Virob25472f2015-12-05 22:04:48 -05002817extern loff_t no_seek_end_llseek_size(struct file *, loff_t, int, loff_t);
2818extern loff_t no_seek_end_llseek(struct file *, loff_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002819extern int generic_file_open(struct inode * inode, struct file * filp);
2820extern int nonseekable_open(struct inode * inode, struct file * filp);
2821
David Howells93614012006-09-30 20:45:40 +02002822#ifdef CONFIG_BLOCK
Mike Christie8a4c1e42016-06-05 14:31:50 -05002823typedef void (dio_submit_t)(struct bio *bio, struct inode *inode,
Josef Bacikfacd07b2010-05-23 11:00:55 -04002824 loff_t file_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002825
2826enum {
Christoph Hellwig1e431f52009-11-03 16:44:53 +01002827 /* need locking between buffered and direct access */
2828 DIO_LOCKING = 0x01,
2829
2830 /* filesystem does not support filling holes */
2831 DIO_SKIP_HOLES = 0x02,
Christoph Hellwig60392572014-02-10 10:27:11 +11002832
2833 /* filesystem can handle aio writes beyond i_size */
2834 DIO_ASYNC_EXTEND = 0x04,
Jens Axboefe0f07d2015-04-15 17:05:48 -06002835
2836 /* inode/fs/bdev does not need truncate protection */
2837 DIO_SKIP_DIO_COUNT = 0x08,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002838};
2839
Christoph Hellwigeafdc7d2010-06-04 11:29:53 +02002840void dio_end_io(struct bio *bio, int error);
npiggin@suse.de7bb46a62010-05-27 01:05:33 +10002841
Omar Sandoval17f8c842015-03-16 04:33:50 -07002842ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode,
2843 struct block_device *bdev, struct iov_iter *iter,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07002844 get_block_t get_block,
Omar Sandoval17f8c842015-03-16 04:33:50 -07002845 dio_iodone_t end_io, dio_submit_t submit_io,
2846 int flags);
Christoph Hellwigeafdc7d2010-06-04 11:29:53 +02002847
Omar Sandoval17f8c842015-03-16 04:33:50 -07002848static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
2849 struct inode *inode,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07002850 struct iov_iter *iter,
Omar Sandoval17f8c842015-03-16 04:33:50 -07002851 get_block_t get_block)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002852{
Omar Sandoval17f8c842015-03-16 04:33:50 -07002853 return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07002854 get_block, NULL, NULL, DIO_LOCKING | DIO_SKIP_HOLES);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002855}
David Howells93614012006-09-30 20:45:40 +02002856#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002857
Trond Myklebust1d59d612012-05-31 12:22:33 -04002858void inode_dio_wait(struct inode *inode);
Jens Axboefe0f07d2015-04-15 17:05:48 -06002859
2860/*
2861 * inode_dio_begin - signal start of a direct I/O requests
2862 * @inode: inode the direct I/O happens on
2863 *
2864 * This is called once we've finished processing a direct I/O request,
2865 * and is used to wake up callers waiting for direct I/O to be quiesced.
2866 */
2867static inline void inode_dio_begin(struct inode *inode)
2868{
2869 atomic_inc(&inode->i_dio_count);
2870}
2871
2872/*
2873 * inode_dio_end - signal finish of a direct I/O requests
2874 * @inode: inode the direct I/O happens on
2875 *
2876 * This is called once we've finished processing a direct I/O request,
2877 * and is used to wake up callers waiting for direct I/O to be quiesced.
2878 */
2879static inline void inode_dio_end(struct inode *inode)
2880{
2881 if (atomic_dec_and_test(&inode->i_dio_count))
2882 wake_up_bit(&inode->i_state, __I_DIO_WAKEUP);
2883}
Trond Myklebust1d59d612012-05-31 12:22:33 -04002884
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002885extern void inode_set_flags(struct inode *inode, unsigned int flags,
2886 unsigned int mask);
2887
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08002888extern const struct file_operations generic_ro_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002889
2890#define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))
2891
Al Viro5d826c82014-03-14 13:42:45 -04002892extern int readlink_copy(char __user *, int, const char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002893extern int page_readlink(struct dentry *, char __user *, int);
Al Virofceef392015-12-29 15:58:39 -05002894extern const char *page_get_link(struct dentry *, struct inode *,
2895 struct delayed_call *);
2896extern void page_put_link(void *);
Kirill Korotaev0adb25d2006-03-11 03:27:13 -08002897extern int __page_symlink(struct inode *inode, const char *symname, int len,
Nick Piggin54566b22009-01-04 12:00:53 -08002898 int nofs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002899extern int page_symlink(struct inode *inode, const char *symname, int len);
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08002900extern const struct inode_operations page_symlink_inode_operations;
Al Virofceef392015-12-29 15:58:39 -05002901extern void kfree_link(void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002902extern int generic_readlink(struct dentry *, char __user *, int);
2903extern void generic_fillattr(struct inode *, struct kstat *);
J. Bruce Fieldsb7a6ec52013-10-02 17:01:18 -04002904int vfs_getattr_nosec(struct path *path, struct kstat *stat);
Al Viro3dadecc2013-01-24 02:18:08 -05002905extern int vfs_getattr(struct path *, struct kstat *);
Dmitry Monakhovb4627072009-12-14 15:21:12 +03002906void __inode_add_bytes(struct inode *inode, loff_t bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002907void inode_add_bytes(struct inode *inode, loff_t bytes);
Jan Kara1c8924e2013-08-17 09:32:32 -04002908void __inode_sub_bytes(struct inode *inode, loff_t bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002909void inode_sub_bytes(struct inode *inode, loff_t bytes);
2910loff_t inode_get_bytes(struct inode *inode);
2911void inode_set_bytes(struct inode *inode, loff_t bytes);
Al Virofceef392015-12-29 15:58:39 -05002912const char *simple_get_link(struct dentry *, struct inode *,
2913 struct delayed_call *);
Al Viro61ba64f2015-05-02 09:54:06 -04002914extern const struct inode_operations simple_symlink_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002915
Al Viro5c0ba4e2013-05-15 13:52:59 -04002916extern int iterate_dir(struct file *, struct dir_context *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002917
David Howellsc7887322010-08-11 11:26:22 +01002918extern int vfs_stat(const char __user *, struct kstat *);
2919extern int vfs_lstat(const char __user *, struct kstat *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002920extern int vfs_fstat(unsigned int, struct kstat *);
David Howellsc7887322010-08-11 11:26:22 +01002921extern int vfs_fstatat(int , const char __user *, struct kstat *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002922
Steven Whitehousee9079cc2008-10-14 14:43:29 +01002923extern int __generic_block_fiemap(struct inode *inode,
Josef Bacik3a3076f2010-04-23 12:17:17 -04002924 struct fiemap_extent_info *fieinfo,
2925 loff_t start, loff_t len,
2926 get_block_t *get_block);
Josef Bacik68c9d702008-10-03 17:32:43 -04002927extern int generic_block_fiemap(struct inode *inode,
2928 struct fiemap_extent_info *fieinfo, u64 start,
2929 u64 len, get_block_t *get_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002930
Miklos Szeredic18479f2007-10-18 23:39:11 -07002931extern void get_filesystem(struct file_system_type *fs);
2932extern void put_filesystem(struct file_system_type *fs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002933extern struct file_system_type *get_fs_type(const char *name);
2934extern struct super_block *get_super(struct block_device *);
Jan Kara6b6dc832012-02-10 11:03:00 +01002935extern struct super_block *get_super_thawed(struct block_device *);
Christoph Hellwig45042302009-08-03 23:28:35 +02002936extern struct super_block *get_active_super(struct block_device *bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002937extern void drop_super(struct super_block *sb);
Al Viro01a05b32010-03-23 06:06:58 -04002938extern void iterate_supers(void (*)(struct super_block *, void *), void *);
Al Viro43e15cd2011-06-03 20:16:57 -04002939extern void iterate_supers_type(struct file_system_type *,
2940 void (*)(struct super_block *, void *), void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002941
2942extern int dcache_dir_open(struct inode *, struct file *);
2943extern int dcache_dir_close(struct inode *, struct file *);
2944extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
Al Viro5f99f4e2013-05-15 20:23:06 -04002945extern int dcache_readdir(struct file *, struct dir_context *);
npiggin@suse.de7bb46a62010-05-27 01:05:33 +10002946extern int simple_setattr(struct dentry *, struct iattr *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002947extern int simple_getattr(struct vfsmount *, struct dentry *, struct kstat *);
David Howells726c3342006-06-23 02:02:58 -07002948extern int simple_statfs(struct dentry *, struct kstatfs *);
Stephen Boyd20955e82012-04-05 14:25:09 -07002949extern int simple_open(struct inode *inode, struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002950extern int simple_link(struct dentry *, struct inode *, struct dentry *);
2951extern int simple_unlink(struct inode *, struct dentry *);
2952extern int simple_rmdir(struct inode *, struct dentry *);
2953extern int simple_rename(struct inode *, struct dentry *, struct inode *, struct dentry *);
Josef Bacik02c24a82011-07-16 20:44:56 -04002954extern int noop_fsync(struct file *, loff_t, loff_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002955extern int simple_empty(struct dentry *);
2956extern int simple_readpage(struct file *file, struct page *page);
Nick Pigginafddba42007-10-16 01:25:01 -07002957extern int simple_write_begin(struct file *file, struct address_space *mapping,
2958 loff_t pos, unsigned len, unsigned flags,
2959 struct page **pagep, void **fsdata);
2960extern int simple_write_end(struct file *file, struct address_space *mapping,
2961 loff_t pos, unsigned len, unsigned copied,
2962 struct page *page, void *fsdata);
Al Virob26d4cd2013-10-25 18:47:37 -04002963extern int always_delete_dentry(const struct dentry *);
Al Viro69878432013-10-02 22:35:11 -04002964extern struct inode *alloc_anon_inode(struct super_block *);
Jeff Laytone6f5c782014-08-22 10:40:25 -04002965extern int simple_nosetlease(struct file *, long, struct file_lock **, void **);
Al Virob26d4cd2013-10-25 18:47:37 -04002966extern const struct dentry_operations simple_dentry_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002967
Al Viro00cd8dd2012-06-10 17:13:09 -04002968extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002969extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08002970extern const struct file_operations simple_dir_operations;
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08002971extern const struct inode_operations simple_dir_inode_operations;
Eric W. Biedermanfbabfd02015-05-09 15:54:49 -05002972extern void make_empty_dir_inode(struct inode *inode);
2973extern bool is_empty_dir_inode(struct inode *inode);
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08002974struct tree_descr { char *name; const struct file_operations *ops; int mode; };
Linus Torvalds1da177e2005-04-16 15:20:36 -07002975struct dentry *d_alloc_name(struct dentry *, const char *);
Roberto Sassu7d683a02010-06-03 11:58:28 +02002976extern int simple_fill_super(struct super_block *, unsigned long, struct tree_descr *);
Trond Myklebust1f5ce9e2006-06-09 09:34:16 -04002977extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002978extern void simple_release_fs(struct vfsmount **mount, int *count);
2979
Akinobu Mita93b07112008-06-05 22:46:21 -07002980extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
2981 loff_t *ppos, const void *from, size_t available);
Jiri Slaby6a727b42010-05-01 23:51:22 +02002982extern ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
2983 const void __user *from, size_t count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002984
Fabian Frederickac13a822014-06-04 16:06:27 -07002985extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
Josef Bacik02c24a82011-07-16 20:44:56 -04002986extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
Al Virod5aacad2009-06-07 14:56:44 -04002987
Patrick J. LoPresti30ca22c2010-07-22 15:03:41 -07002988extern int generic_check_addressable(unsigned, u64);
2989
Christoph Lametere965f962006-02-01 03:05:41 -08002990#ifdef CONFIG_MIGRATION
Christoph Lameter2d1db3b2006-06-23 02:03:33 -07002991extern int buffer_migrate_page(struct address_space *,
Mel Gormana6bc32b2012-01-12 17:19:43 -08002992 struct page *, struct page *,
2993 enum migrate_mode);
Christoph Lametere965f962006-02-01 03:05:41 -08002994#else
2995#define buffer_migrate_page NULL
2996#endif
2997
npiggin@suse.de25d9e2d2009-08-21 02:35:05 +10002998extern int inode_change_ok(const struct inode *, struct iattr *);
2999extern int inode_newsize_ok(const struct inode *, loff_t offset);
Christoph Hellwig6a1a90a2010-06-04 11:30:00 +02003000extern void setattr_copy(struct inode *inode, const struct iattr *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003001
Josef Bacikc3b2da32012-03-26 09:59:21 -04003002extern int file_update_time(struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003003
Al Viro34c80b12011-12-08 21:32:45 -05003004extern int generic_show_options(struct seq_file *m, struct dentry *root);
Miklos Szeredib3b304a2008-02-08 04:21:35 -08003005extern void save_mount_options(struct super_block *sb, char *options);
Al Viro2a32ceb2009-05-08 16:05:57 -04003006extern void replace_mount_options(struct super_block *sb, char *options);
Miklos Szeredib3b304a2008-02-08 04:21:35 -08003007
Matthew Wilcoxd475c632015-02-16 15:58:56 -08003008static inline bool io_is_direct(struct file *filp)
3009{
Dan Williams65f87ee2016-01-25 17:23:18 -08003010 return (filp->f_flags & O_DIRECT) || IS_DAX(filp->f_mapping->host);
Matthew Wilcoxd475c632015-02-16 15:58:56 -08003011}
3012
Al Viro2ba48ce2015-04-09 13:52:01 -04003013static inline int iocb_flags(struct file *file)
3014{
3015 int res = 0;
3016 if (file->f_flags & O_APPEND)
3017 res |= IOCB_APPEND;
3018 if (io_is_direct(file))
3019 res |= IOCB_DIRECT;
Christoph Hellwigdde0c2e2016-04-07 08:52:00 -07003020 if ((file->f_flags & O_DSYNC) || IS_SYNC(file->f_mapping->host))
3021 res |= IOCB_DSYNC;
3022 if (file->f_flags & __O_SYNC)
3023 res |= IOCB_SYNC;
Al Viro2ba48ce2015-04-09 13:52:01 -04003024 return res;
3025}
3026
Linus Torvalds1da177e2005-04-16 15:20:36 -07003027static inline ino_t parent_ino(struct dentry *dentry)
3028{
3029 ino_t res;
3030
Nick Pigginb5c84bf2011-01-07 17:49:38 +11003031 /*
3032 * Don't strictly need d_lock here? If the parent ino could change
3033 * then surely we'd have a deeper race in the caller?
3034 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003035 spin_lock(&dentry->d_lock);
3036 res = dentry->d_parent->d_inode->i_ino;
3037 spin_unlock(&dentry->d_lock);
3038 return res;
3039}
3040
Linus Torvalds1da177e2005-04-16 15:20:36 -07003041/* Transaction based IO helpers */
3042
3043/*
3044 * An argresp is stored in an allocated page and holds the
3045 * size of the argument or response, along with its content
3046 */
3047struct simple_transaction_argresp {
3048 ssize_t size;
3049 char data[0];
3050};
3051
3052#define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))
3053
3054char *simple_transaction_get(struct file *file, const char __user *buf,
3055 size_t size);
3056ssize_t simple_transaction_read(struct file *file, char __user *buf,
3057 size_t size, loff_t *pos);
3058int simple_transaction_release(struct inode *inode, struct file *file);
3059
Ingo Molnar76791ab2009-03-25 16:48:35 +01003060void simple_transaction_set(struct file *file, size_t n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003061
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003062/*
3063 * simple attribute files
3064 *
3065 * These attributes behave similar to those in sysfs:
3066 *
3067 * Writing to an attribute immediately sets a value, an open file can be
3068 * written to multiple times.
3069 *
3070 * Reading from an attribute creates a buffer from the value that might get
3071 * read with multiple read calls. When the attribute has been read
3072 * completely, no further read calls are possible until the file is opened
3073 * again.
3074 *
3075 * All attributes contain a text representation of a numeric value
3076 * that are accessed with the get() and set() functions.
3077 */
3078#define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt) \
3079static int __fops ## _open(struct inode *inode, struct file *file) \
3080{ \
3081 __simple_attr_check_format(__fmt, 0ull); \
3082 return simple_attr_open(inode, file, __get, __set, __fmt); \
3083} \
Alexey Dobriyan828c0952009-10-01 15:43:56 -07003084static const struct file_operations __fops = { \
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003085 .owner = THIS_MODULE, \
3086 .open = __fops ## _open, \
Christoph Hellwig74bedc42008-02-08 04:20:28 -08003087 .release = simple_attr_release, \
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003088 .read = simple_attr_read, \
3089 .write = simple_attr_write, \
Arnd Bergmann1ec55842010-08-15 21:50:52 +02003090 .llseek = generic_file_llseek, \
Joe Perches68be3022014-08-06 16:08:45 -07003091}
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003092
Joe Perchesb9075fa2011-10-31 17:11:33 -07003093static inline __printf(1, 2)
3094void __simple_attr_check_format(const char *fmt, ...)
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003095{
3096 /* don't do anything, just let the compiler check the arguments; */
3097}
3098
3099int simple_attr_open(struct inode *inode, struct file *file,
Christoph Hellwig8b88b092008-02-08 04:20:26 -08003100 int (*get)(void *, u64 *), int (*set)(void *, u64),
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003101 const char *fmt);
Christoph Hellwig74bedc42008-02-08 04:20:28 -08003102int simple_attr_release(struct inode *inode, struct file *file);
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003103ssize_t simple_attr_read(struct file *file, char __user *buf,
3104 size_t len, loff_t *ppos);
3105ssize_t simple_attr_write(struct file *file, const char __user *buf,
3106 size_t len, loff_t *ppos);
3107
Alexey Dobriyan4be28542007-10-16 23:26:21 -07003108struct ctl_table;
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07003109int proc_nr_files(struct ctl_table *table, int write,
Adrian Bunk62239ac2007-07-17 04:03:45 -07003110 void __user *buffer, size_t *lenp, loff_t *ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04003111int proc_nr_dentry(struct ctl_table *table, int write,
3112 void __user *buffer, size_t *lenp, loff_t *ppos);
Dave Chinnercffbc8a2010-10-23 05:03:02 -04003113int proc_nr_inodes(struct ctl_table *table, int write,
3114 void __user *buffer, size_t *lenp, loff_t *ppos);
Tetsuo Handa38e23c92009-04-09 20:17:52 +09003115int __init get_filesystem_list(char *buf);
Adrian Bunk62239ac2007-07-17 04:03:45 -07003116
Namhyung Kim3cd90ea2011-02-01 15:52:46 -08003117#define __FMODE_EXEC ((__force int) FMODE_EXEC)
Namhyung Kim1a44bc82011-02-01 15:52:46 -08003118#define __FMODE_NONOTIFY ((__force int) FMODE_NONOTIFY)
3119
Al Viro6d125522009-12-24 06:58:56 -05003120#define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE])
Eric Parisecf081d2009-12-17 21:24:25 -05003121#define OPEN_FMODE(flag) ((__force fmode_t)(((flag + 1) & O_ACCMODE) | \
Namhyung Kim1a44bc82011-02-01 15:52:46 -08003122 (flag & __FMODE_NONOTIFY)))
Al Viro53009902009-12-19 10:15:07 -05003123
Yaowei Baid37177b2015-11-19 21:00:12 +08003124static inline bool is_sxid(umode_t mode)
Andi Kleen69b45732011-05-28 08:25:51 -07003125{
3126 return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
3127}
3128
Miklos Szeredicbdf35b2014-10-24 00:14:36 +02003129static inline int check_sticky(struct inode *dir, struct inode *inode)
3130{
3131 if (!(dir->i_mode & S_ISVTX))
3132 return 0;
3133
3134 return __check_sticky(dir, inode);
3135}
3136
Andi Kleen69b45732011-05-28 08:25:51 -07003137static inline void inode_has_no_xattr(struct inode *inode)
3138{
Al Viro9e1f1de2011-06-03 18:24:58 -04003139 if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & MS_NOSEC))
Andi Kleen69b45732011-05-28 08:25:51 -07003140 inode->i_flags |= S_NOSEC;
3141}
3142
Al Viroa7400222014-10-21 15:20:42 -04003143static inline bool is_root_inode(struct inode *inode)
3144{
3145 return inode == inode->i_sb->s_root->d_inode;
3146}
3147
Al Viro5f99f4e2013-05-15 20:23:06 -04003148static inline bool dir_emit(struct dir_context *ctx,
3149 const char *name, int namelen,
3150 u64 ino, unsigned type)
3151{
3152 return ctx->actor(ctx, name, namelen, ctx->pos, ino, type) == 0;
3153}
3154static inline bool dir_emit_dot(struct file *file, struct dir_context *ctx)
3155{
3156 return ctx->actor(ctx, ".", 1, ctx->pos,
3157 file->f_path.dentry->d_inode->i_ino, DT_DIR) == 0;
3158}
3159static inline bool dir_emit_dotdot(struct file *file, struct dir_context *ctx)
3160{
3161 return ctx->actor(ctx, "..", 2, ctx->pos,
3162 parent_ino(file->f_path.dentry), DT_DIR) == 0;
3163}
3164static inline bool dir_emit_dots(struct file *file, struct dir_context *ctx)
3165{
3166 if (ctx->pos == 0) {
3167 if (!dir_emit_dot(file, ctx))
3168 return false;
3169 ctx->pos = 1;
3170 }
3171 if (ctx->pos == 1) {
3172 if (!dir_emit_dotdot(file, ctx))
3173 return false;
3174 ctx->pos = 2;
3175 }
3176 return true;
3177}
Al Viro5ded75e2013-05-15 21:02:48 -04003178static inline bool dir_relax(struct inode *inode)
3179{
Al Viro59551022016-01-22 15:40:57 -05003180 inode_unlock(inode);
3181 inode_lock(inode);
Al Viro5ded75e2013-05-15 21:02:48 -04003182 return !IS_DEADDIR(inode);
3183}
Al Viro5f99f4e2013-05-15 20:23:06 -04003184
Al Viroae053272016-05-12 20:36:01 -04003185static inline bool dir_relax_shared(struct inode *inode)
3186{
3187 inode_unlock_shared(inode);
3188 inode_lock_shared(inode);
3189 return !IS_DEADDIR(inode);
3190}
3191
Eric W. Biederman90f85722015-06-29 14:42:03 -05003192extern bool path_noexec(const struct path *path);
Al Viro21fc61c2015-11-17 01:07:57 -05003193extern void inode_nohighmem(struct inode *inode);
Eric W. Biederman90f85722015-06-29 14:42:03 -05003194
Linus Torvalds1da177e2005-04-16 15:20:36 -07003195#endif /* _LINUX_FS_H */