blob: 2c5e33a5b2af4af5934597b082452858d7717f28 [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
5#include <linux/linkage.h>
6#include <linux/wait.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07007#include <linux/kdev_t.h>
8#include <linux/dcache.h>
Al Viro3f8206d2008-07-26 03:46:43 -04009#include <linux/path.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070010#include <linux/stat.h>
11#include <linux/cache.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/list.h>
Dave Chinnerbc3b14c2013-08-28 10:17:58 +100013#include <linux/list_lru.h>
Oleg Nesterov4f5e65a2013-07-08 14:24:16 -070014#include <linux/llist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/radix-tree.h>
Michel Lespinasse6b2dbba2012-10-08 16:31:25 -070016#include <linux/rbtree.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/init.h>
Al Viro914e2632006-10-18 13:55:46 -040018#include <linux/pid.h>
Paul Gortmaker187f1882011-11-23 20:12:59 -050019#include <linux/bug.h>
Jes Sorensen1b1dcc12006-01-09 15:59:24 -080020#include <linux/mutex.h>
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080021#include <linux/rwsem.h>
Satyam Sharma3bd858a2007-07-17 15:00:08 +053022#include <linux/capability.h>
Matthew Wilcox6188e102008-04-18 22:21:05 -040023#include <linux/semaphore.h>
Mark Fashehc4b929b2008-10-08 19:44:18 -040024#include <linux/fiemap.h>
Nick Pigginceb5bdc2011-01-07 17:50:05 +110025#include <linux/rculist_bl.h>
Al Viro07b8ce12011-06-20 10:52:57 -040026#include <linux/atomic.h>
Konstantin Khlebnikov83aeead2011-12-08 14:33:54 -080027#include <linux/shrinker.h>
Stephen Rothwellc1aab022012-01-24 11:41:32 +110028#include <linux/migrate_mode.h>
Eric W. Biederman92361632012-02-08 07:07:50 -080029#include <linux/uidgid.h>
Jan Kara5accdf82012-06-12 16:20:34 +020030#include <linux/lockdep.h>
Jens Axboec2b1ad82012-09-27 09:35:03 +020031#include <linux/percpu-rwsem.h>
David Howells08cce05c2012-10-13 10:45:06 +010032#include <linux/blk_types.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#include <asm/byteorder.h>
David Howells607ca462012-10-13 10:46:48 +010035#include <uapi/linux/fs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036
Christoph Hellwigb83ae6d2015-01-14 10:42:37 +010037struct backing_dev_info;
Tejun Heo52ebea72015-05-22 17:13:37 -040038struct bdi_writeback;
Christoph Hellwiga5694252007-07-17 04:04:28 -070039struct export_operations;
Christoph Hellwiga885c8c2006-01-08 01:02:50 -080040struct hd_geometry;
Linus Torvalds1da177e2005-04-16 15:20:36 -070041struct iovec;
42struct nameidata;
Christoph Hellwig92198f72005-06-23 22:00:59 -070043struct kiocb;
Alexey Dobriyan57cc7212011-01-10 08:18:25 +020044struct kobject;
Linus Torvalds1da177e2005-04-16 15:20:36 -070045struct pipe_inode_info;
46struct poll_table_struct;
47struct kstatfs;
48struct vm_area_struct;
49struct vfsmount;
David Howells745ca242008-11-14 10:39:22 +110050struct cred;
Mel Gormana509bc12012-07-31 16:44:57 -070051struct swap_info_struct;
Cyrill Gorcunov55985dd2012-12-17 16:04:55 -080052struct seq_file;
Christoph Hellwig7b7a8662013-09-04 15:04:39 +020053struct workqueue_struct;
Al Viro3b93f912014-02-11 21:34:08 -050054struct iov_iter;
Matthew Wilcoxf7ca90b2015-02-16 15:59:02 -080055struct vm_fault;
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
Denis Cheng74bf17c2007-10-16 23:26:30 -070057extern void __init inode_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070058extern void __init inode_init_early(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070059extern void __init files_init(unsigned long);
60
Jan Engelhardtdded4f42008-12-01 14:34:50 -080061extern struct files_stat_struct files_stat;
Eric Dumazet518de9b2010-10-26 14:22:44 -070062extern unsigned long get_max_files(void);
Jan Engelhardtdded4f42008-12-01 14:34:50 -080063extern int sysctl_nr_open;
64extern struct inodes_stat_t inodes_stat;
65extern int leases_enable, lease_break_time;
Kees Cook800179c2012-07-25 17:29:07 -070066extern int sysctl_protected_symlinks;
67extern int sysctl_protected_hardlinks;
Jan Engelhardtdded4f42008-12-01 14:34:50 -080068
Linus Torvalds1da177e2005-04-16 15:20:36 -070069struct buffer_head;
70typedef int (get_block_t)(struct inode *inode, sector_t iblock,
71 struct buffer_head *bh_result, int create);
Christoph Hellwig92198f72005-06-23 22:00:59 -070072typedef void (dio_iodone_t)(struct kiocb *iocb, loff_t offset,
Christoph Hellwig7b7a8662013-09-04 15:04:39 +020073 ssize_t bytes, void *private);
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
David Howellsbbc10962012-10-15 16:40:35 +010075#define MAY_EXEC 0x00000001
76#define MAY_WRITE 0x00000002
77#define MAY_READ 0x00000004
78#define MAY_APPEND 0x00000008
79#define MAY_ACCESS 0x00000010
80#define MAY_OPEN 0x00000020
81#define MAY_CHDIR 0x00000040
82/* called from RCU mode, don't block */
83#define MAY_NOT_BLOCK 0x00000080
84
85/*
86 * flags in file.f_mode. Note that FMODE_READ and FMODE_WRITE must correspond
87 * to O_WRONLY and O_RDWR via the strange trick in __dentry_open()
88 */
89
90/* file is open for reading */
91#define FMODE_READ ((__force fmode_t)0x1)
92/* file is open for writing */
93#define FMODE_WRITE ((__force fmode_t)0x2)
94/* file is seekable */
95#define FMODE_LSEEK ((__force fmode_t)0x4)
96/* file can be accessed using pread */
97#define FMODE_PREAD ((__force fmode_t)0x8)
98/* file can be accessed using pwrite */
99#define FMODE_PWRITE ((__force fmode_t)0x10)
100/* File is opened for execution with sys_execve / sys_uselib */
101#define FMODE_EXEC ((__force fmode_t)0x20)
102/* File is opened with O_NDELAY (only set for block devices) */
103#define FMODE_NDELAY ((__force fmode_t)0x40)
104/* File is opened with O_EXCL (only set for block devices) */
105#define FMODE_EXCL ((__force fmode_t)0x80)
106/* File is opened using open(.., 3, ..) and is writeable only for ioctls
107 (specialy hack for floppy.c) */
108#define FMODE_WRITE_IOCTL ((__force fmode_t)0x100)
109/* 32bit hashes as llseek() offset (for directories) */
110#define FMODE_32BITHASH ((__force fmode_t)0x200)
111/* 64bit hashes as llseek() offset (for directories) */
112#define FMODE_64BITHASH ((__force fmode_t)0x400)
113
114/*
115 * Don't update ctime and mtime.
116 *
117 * Currently a special hack for the XFS open_by_handle ioctl, but we'll
118 * hopefully graduate it to a proper O_CMTIME flag supported by open(2) soon.
119 */
120#define FMODE_NOCMTIME ((__force fmode_t)0x800)
121
122/* Expect random access pattern */
123#define FMODE_RANDOM ((__force fmode_t)0x1000)
124
125/* File is huge (eg. /dev/kmem): treat loff_t as unsigned */
126#define FMODE_UNSIGNED_OFFSET ((__force fmode_t)0x2000)
127
128/* File is opened with O_PATH; almost nothing can be done with it */
129#define FMODE_PATH ((__force fmode_t)0x4000)
130
Linus Torvalds9c225f22014-03-03 09:36:58 -0800131/* File needs atomic accesses to f_pos */
132#define FMODE_ATOMIC_POS ((__force fmode_t)0x8000)
Al Viro83f936c2014-03-14 12:02:47 -0400133/* Write access to underlying fs */
134#define FMODE_WRITER ((__force fmode_t)0x10000)
Al Viro7f7f25e2014-02-11 17:49:24 -0500135/* Has read method(s) */
136#define FMODE_CAN_READ ((__force fmode_t)0x20000)
137/* Has write method(s) */
138#define FMODE_CAN_WRITE ((__force fmode_t)0x40000)
Linus Torvalds9c225f22014-03-03 09:36:58 -0800139
David Howellsbbc10962012-10-15 16:40:35 +0100140/* File was opened by fanotify and shouldn't generate fanotify events */
David Drysdale75069f22015-01-08 14:32:29 -0800141#define FMODE_NONOTIFY ((__force fmode_t)0x4000000)
David Howellsbbc10962012-10-15 16:40:35 +0100142
143/*
144 * Flag for rw_copy_check_uvector and compat_rw_copy_check_uvector
145 * that indicates that they should check the contents of the iovec are
146 * valid, but not check the memory that the iovec elements
147 * points too.
148 */
149#define CHECK_IOVEC_ONLY -1
150
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151/*
David Howells08cce05c2012-10-13 10:45:06 +0100152 * The below are the various read and write types that we support. Some of
153 * them include behavioral modifiers that send information down to the
154 * block layer and IO scheduler. Terminology:
155 *
156 * The block layer uses device plugging to defer IO a little bit, in
157 * the hope that we will see more IO very shortly. This increases
158 * coalescing of adjacent IO and thus reduces the number of IOs we
159 * have to send to the device. It also allows for better queuing,
160 * if the IO isn't mergeable. If the caller is going to be waiting
161 * for the IO, then he must ensure that the device is unplugged so
162 * that the IO is dispatched to the driver.
163 *
164 * All IO is handled async in Linux. This is fine for background
165 * writes, but for reads or writes that someone waits for completion
166 * on, we want to notify the block layer and IO scheduler so that they
167 * know about it. That allows them to make better scheduling
168 * decisions. So when the below references 'sync' and 'async', it
169 * is referencing this priority hint.
170 *
171 * With that in mind, the available types are:
172 *
173 * READ A normal read operation. Device will be plugged.
174 * READ_SYNC A synchronous read. Device is not plugged, caller can
175 * immediately wait on this read without caring about
176 * unplugging.
177 * READA Used for read-ahead operations. Lower priority, and the
178 * block layer could (in theory) choose to ignore this
179 * request if it runs into resource problems.
180 * WRITE A normal async write. Device will be plugged.
181 * WRITE_SYNC Synchronous write. Identical to WRITE, but passes down
182 * the hint that someone will be waiting on this IO
183 * shortly. The write equivalent of READ_SYNC.
184 * WRITE_ODIRECT Special case write for O_DIRECT only.
185 * WRITE_FLUSH Like WRITE_SYNC but with preceding cache flush.
186 * WRITE_FUA Like WRITE_SYNC but data is guaranteed to be on
187 * non-volatile media on completion.
188 * WRITE_FLUSH_FUA Combination of WRITE_FLUSH and FUA. The IO is preceded
189 * by a cache flush and data is guaranteed to be on
190 * non-volatile media on completion.
191 *
192 */
193#define RW_MASK REQ_WRITE
194#define RWA_MASK REQ_RAHEAD
195
196#define READ 0
197#define WRITE RW_MASK
198#define READA RWA_MASK
David Howells08cce05c2012-10-13 10:45:06 +0100199
200#define READ_SYNC (READ | REQ_SYNC)
201#define WRITE_SYNC (WRITE | REQ_SYNC | REQ_NOIDLE)
202#define WRITE_ODIRECT (WRITE | REQ_SYNC)
203#define WRITE_FLUSH (WRITE | REQ_SYNC | REQ_NOIDLE | REQ_FLUSH)
204#define WRITE_FUA (WRITE | REQ_SYNC | REQ_NOIDLE | REQ_FUA)
205#define WRITE_FLUSH_FUA (WRITE | REQ_SYNC | REQ_NOIDLE | REQ_FLUSH | REQ_FUA)
206
207/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 * Attribute flags. These should be or-ed together to figure out what
209 * has been changed!
210 */
Miklos Szeredi9767d742008-07-01 15:01:26 +0200211#define ATTR_MODE (1 << 0)
212#define ATTR_UID (1 << 1)
213#define ATTR_GID (1 << 2)
214#define ATTR_SIZE (1 << 3)
215#define ATTR_ATIME (1 << 4)
216#define ATTR_MTIME (1 << 5)
217#define ATTR_CTIME (1 << 6)
218#define ATTR_ATIME_SET (1 << 7)
219#define ATTR_MTIME_SET (1 << 8)
220#define ATTR_FORCE (1 << 9) /* Not a change, but a change it */
221#define ATTR_ATTR_FLAG (1 << 10)
222#define ATTR_KILL_SUID (1 << 11)
223#define ATTR_KILL_SGID (1 << 12)
224#define ATTR_FILE (1 << 13)
225#define ATTR_KILL_PRIV (1 << 14)
226#define ATTR_OPEN (1 << 15) /* Truncating from open(O_TRUNC) */
227#define ATTR_TIMES_SET (1 << 16)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
229/*
Miklos Szeredi787fb6b2014-10-24 00:14:36 +0200230 * Whiteout is represented by a char device. The following constants define the
231 * mode and device number to use.
232 */
233#define WHITEOUT_MODE 0
234#define WHITEOUT_DEV 0
235
236/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 * This is the Inode Attributes structure, used for notify_change(). It
238 * uses the above definitions as flags, to know which values have changed.
239 * Also, in this manner, a Filesystem can look at only the values it cares
240 * about. Basically, these are the attributes that the VFS layer can
241 * request to change from the FS layer.
242 *
243 * Derek Atkins <warlord@MIT.EDU> 94-10-20
244 */
245struct iattr {
246 unsigned int ia_valid;
247 umode_t ia_mode;
Eric W. Biederman92361632012-02-08 07:07:50 -0800248 kuid_t ia_uid;
249 kgid_t ia_gid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 loff_t ia_size;
251 struct timespec ia_atime;
252 struct timespec ia_mtime;
253 struct timespec ia_ctime;
Miklos Szeredicc4e69d2005-11-07 00:59:49 -0800254
255 /*
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300256 * Not an attribute, but an auxiliary info for filesystems wanting to
Miklos Szeredicc4e69d2005-11-07 00:59:49 -0800257 * implement an ftruncate() like method. NOTE: filesystem should
258 * check for (ia_valid & ATTR_FILE), and not for (ia_file != NULL).
259 */
260 struct file *ia_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261};
262
263/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 * Includes for diskquotas.
265 */
266#include <linux/quota.h>
267
Miklos Szeredi69c433e2014-10-24 00:14:39 +0200268/*
269 * Maximum number of layers of fs stack. Needs to be limited to
270 * prevent kernel stack overflow
271 */
272#define FILESYSTEM_MAX_STACK_DEPTH 2
273
Zach Brown994fc28c2005-12-15 14:28:17 -0800274/**
275 * enum positive_aop_returns - aop return codes with specific semantics
276 *
277 * @AOP_WRITEPAGE_ACTIVATE: Informs the caller that page writeback has
278 * completed, that the page is still locked, and
279 * should be considered active. The VM uses this hint
280 * to return the page to the active list -- it won't
281 * be a candidate for writeback again in the near
282 * future. Other callers must be careful to unlock
283 * the page if they get this return. Returned by
284 * writepage();
285 *
286 * @AOP_TRUNCATED_PAGE: The AOP method that was handed a locked page has
287 * unlocked it and the page might have been truncated.
288 * The caller should back up to acquiring a new page and
289 * trying again. The aop will be taking reasonable
290 * precautions not to livelock. If the caller held a page
291 * reference, it should drop it before retrying. Returned
Nick Piggin55144762007-10-16 01:25:26 -0700292 * by readpage().
Zach Brown994fc28c2005-12-15 14:28:17 -0800293 *
294 * address_space_operation functions return these large constants to indicate
295 * special semantics to the caller. These are much larger than the bytes in a
296 * page to allow for functions that return the number of bytes operated on in a
297 * given page.
298 */
299
300enum positive_aop_returns {
301 AOP_WRITEPAGE_ACTIVATE = 0x80000,
302 AOP_TRUNCATED_PAGE = 0x80001,
303};
304
Nick Pigginafddba42007-10-16 01:25:01 -0700305#define AOP_FLAG_UNINTERRUPTIBLE 0x0001 /* will not do a short write */
Nick Piggin89e10782007-10-16 01:25:07 -0700306#define AOP_FLAG_CONT_EXPAND 0x0002 /* called from cont_expand */
Nick Piggin54566b22009-01-04 12:00:53 -0800307#define AOP_FLAG_NOFS 0x0004 /* used by filesystem to direct
308 * helper code (eg buffer layer)
309 * to clear GFP_FS from alloc */
Nick Pigginafddba42007-10-16 01:25:01 -0700310
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311/*
312 * oh the beauties of C type declarations.
313 */
314struct page;
315struct address_space;
316struct writeback_control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800318#define IOCB_EVENTFD (1 << 0)
Al Viro2ba48ce2015-04-09 13:52:01 -0400319#define IOCB_APPEND (1 << 1)
320#define IOCB_DIRECT (1 << 2)
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800321
322struct kiocb {
323 struct file *ki_filp;
324 loff_t ki_pos;
325 void (*ki_complete)(struct kiocb *iocb, long ret, long ret2);
326 void *private;
327 int ki_flags;
328};
329
330static inline bool is_sync_kiocb(struct kiocb *kiocb)
331{
332 return kiocb->ki_complete == NULL;
333}
334
Al Viro2ba48ce2015-04-09 13:52:01 -0400335static inline int iocb_flags(struct file *file);
336
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800337static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
338{
339 *kiocb = (struct kiocb) {
340 .ki_filp = filp,
Al Viro2ba48ce2015-04-09 13:52:01 -0400341 .ki_flags = iocb_flags(filp),
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800342 };
343}
344
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -0700345/*
346 * "descriptor" for what we're up to with a read.
347 * This allows us to use the same read code yet
348 * have multiple different users of the data that
349 * we read from a file.
350 *
351 * The simplest case just copies the data to user
352 * mode.
353 */
354typedef struct {
355 size_t written;
356 size_t count;
357 union {
358 char __user *buf;
359 void *data;
360 } arg;
361 int error;
362} read_descriptor_t;
363
364typedef int (*read_actor_t)(read_descriptor_t *, struct page *,
365 unsigned long, unsigned long);
Nick Piggin2f718ff2007-10-16 01:24:59 -0700366
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367struct address_space_operations {
368 int (*writepage)(struct page *page, struct writeback_control *wbc);
369 int (*readpage)(struct file *, struct page *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370
371 /* Write back some dirty pages from this mapping. */
372 int (*writepages)(struct address_space *, struct writeback_control *);
373
Andrew Morton4741c9f2006-03-24 03:18:11 -0800374 /* Set a page dirty. Return true if this dirtied it */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375 int (*set_page_dirty)(struct page *page);
376
377 int (*readpages)(struct file *filp, struct address_space *mapping,
378 struct list_head *pages, unsigned nr_pages);
379
Nick Pigginafddba42007-10-16 01:25:01 -0700380 int (*write_begin)(struct file *, struct address_space *mapping,
381 loff_t pos, unsigned len, unsigned flags,
382 struct page **pagep, void **fsdata);
383 int (*write_end)(struct file *, struct address_space *mapping,
384 loff_t pos, unsigned len, unsigned copied,
385 struct page *page, void *fsdata);
386
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 /* Unfortunately this kludge is needed for FIBMAP. Don't use it */
388 sector_t (*bmap)(struct address_space *, sector_t);
Lukas Czernerd47992f2013-05-21 23:17:23 -0400389 void (*invalidatepage) (struct page *, unsigned int, unsigned int);
Al Viro27496a82005-10-21 03:20:48 -0400390 int (*releasepage) (struct page *, gfp_t);
Linus Torvalds6072d132010-12-01 13:35:19 -0500391 void (*freepage)(struct page *);
Omar Sandoval22c61862015-03-16 04:33:53 -0700392 ssize_t (*direct_IO)(struct kiocb *, struct iov_iter *iter, loff_t offset);
Mel Gormanb969c4ab2012-01-12 17:19:34 -0800393 /*
Tang Chenef277c72013-07-08 16:00:21 -0700394 * migrate the contents of a page to the specified target. If
395 * migrate_mode is MIGRATE_ASYNC, it must not block.
Mel Gormanb969c4ab2012-01-12 17:19:34 -0800396 */
Christoph Lameter2d1db3b2006-06-23 02:03:33 -0700397 int (*migratepage) (struct address_space *,
Mel Gormana6bc32b2012-01-12 17:19:43 -0800398 struct page *, struct page *, enum migrate_mode);
Trond Myklebuste3db7692007-01-10 23:15:39 -0800399 int (*launder_page) (struct page *);
Al Viroc186afb42014-02-02 21:16:54 -0500400 int (*is_partially_uptodate) (struct page *, unsigned long,
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -0700401 unsigned long);
Mel Gormanb4597222013-07-03 15:02:05 -0700402 void (*is_dirty_writeback) (struct page *, bool *, bool *);
Andi Kleen25718732009-09-16 11:50:13 +0200403 int (*error_remove_page)(struct address_space *, struct page *);
Mel Gorman62c230b2012-07-31 16:44:55 -0700404
405 /* swapfile support */
Mel Gormana509bc12012-07-31 16:44:57 -0700406 int (*swap_activate)(struct swap_info_struct *sis, struct file *file,
407 sector_t *span);
408 void (*swap_deactivate)(struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409};
410
Jens Axboe7dcda1c2011-04-05 23:51:48 +0200411extern const struct address_space_operations empty_aops;
412
Nick Pigginafddba42007-10-16 01:25:01 -0700413/*
414 * pagecache_write_begin/pagecache_write_end must be used by general code
415 * to write into the pagecache.
416 */
417int pagecache_write_begin(struct file *, struct address_space *mapping,
418 loff_t pos, unsigned len, unsigned flags,
419 struct page **pagep, void **fsdata);
420
421int pagecache_write_end(struct file *, struct address_space *mapping,
422 loff_t pos, unsigned len, unsigned copied,
423 struct page *page, void *fsdata);
424
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425struct address_space {
426 struct inode *host; /* owner: inode, block_device */
427 struct radix_tree_root page_tree; /* radix tree of all pages */
Nick Piggin19fd6232008-07-25 19:45:32 -0700428 spinlock_t tree_lock; /* and lock protecting it */
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700429 atomic_t i_mmap_writable;/* count VM_SHARED mappings */
Michel Lespinasse6b2dbba2012-10-08 16:31:25 -0700430 struct rb_root i_mmap; /* tree of private and shared mappings */
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800431 struct rw_semaphore i_mmap_rwsem; /* protect tree, count, list */
Jan Kara08142572011-06-27 16:18:10 -0700432 /* Protected by tree_lock together with the radix tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 unsigned long nrpages; /* number of total pages */
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700434 unsigned long nrshadows; /* number of shadow entries */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 pgoff_t writeback_index;/* writeback starts here */
Christoph Hellwigf5e54d62006-06-28 04:26:44 -0700436 const struct address_space_operations *a_ops; /* methods */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 unsigned long flags; /* error bits/gfp mask */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 spinlock_t private_lock; /* for use by the address_space */
439 struct list_head private_list; /* ditto */
Rafael Aquini252aa6f2012-12-11 16:02:35 -0800440 void *private_data; /* ditto */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441} __attribute__((aligned(sizeof(long))));
442 /*
443 * On most architectures that alignment is already the case; but
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300444 * must be enforced here for CRIS, to let the least significant bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 * of struct page's "mapping" pointer be used for PAGE_MAPPING_ANON.
446 */
Andi Kleen87192a22012-01-12 17:20:34 -0800447struct request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448
449struct block_device {
450 dev_t bd_dev; /* not a kdev_t - it's a search key */
Richard Kennedyf3ccfcd2011-03-22 16:33:56 -0700451 int bd_openers;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 struct inode * bd_inode; /* will die */
Theodore Ts'o87d8fe12009-01-03 09:47:09 -0500453 struct super_block * bd_super;
Arjan van de Venc039e312006-03-23 03:00:28 -0800454 struct mutex bd_mutex; /* open/close mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 struct list_head bd_inodes;
Tejun Heo6b4517a2010-04-07 18:53:59 +0900456 void * bd_claiming;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 void * bd_holder;
458 int bd_holders;
Tejun Heo77ea8872010-12-08 20:57:37 +0100459 bool bd_write_holder;
Jun'ichi Nomura641dc632006-03-27 01:17:57 -0800460#ifdef CONFIG_SYSFS
Tejun Heo49731ba2011-01-14 18:43:57 +0100461 struct list_head bd_holder_disks;
Jun'ichi Nomura641dc632006-03-27 01:17:57 -0800462#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 struct block_device * bd_contains;
464 unsigned bd_block_size;
465 struct hd_struct * bd_part;
466 /* number of times partitions within this device have been opened. */
467 unsigned bd_part_count;
468 int bd_invalidated;
469 struct gendisk * bd_disk;
Andi Kleen87192a22012-01-12 17:20:34 -0800470 struct request_queue * bd_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 struct list_head bd_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 /*
473 * Private data. You must have bd_claim'ed the block_device
474 * to use this. NOTE: bd_claim allows an owner to claim
475 * the same device multiple times, the owner must take special
476 * care to not mess up bd_private for that case.
477 */
478 unsigned long bd_private;
Takashi Satofcccf502009-01-09 16:40:59 -0800479
480 /* The counter of freeze processes */
481 int bd_fsfreeze_count;
482 /* Mutex for freeze */
483 struct mutex bd_fsfreeze_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484};
485
486/*
487 * Radix-tree tags, for tagging dirty and writeback pages within the pagecache
488 * radix trees
489 */
490#define PAGECACHE_TAG_DIRTY 0
491#define PAGECACHE_TAG_WRITEBACK 1
Jan Karaf446daae2010-08-09 17:19:12 -0700492#define PAGECACHE_TAG_TOWRITE 2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493
494int mapping_tagged(struct address_space *mapping, int tag);
495
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800496static inline void i_mmap_lock_write(struct address_space *mapping)
497{
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800498 down_write(&mapping->i_mmap_rwsem);
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800499}
500
501static inline void i_mmap_unlock_write(struct address_space *mapping)
502{
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800503 up_write(&mapping->i_mmap_rwsem);
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800504}
505
Davidlohr Bueso3dec0ba2014-12-12 16:54:27 -0800506static inline void i_mmap_lock_read(struct address_space *mapping)
507{
508 down_read(&mapping->i_mmap_rwsem);
509}
510
511static inline void i_mmap_unlock_read(struct address_space *mapping)
512{
513 up_read(&mapping->i_mmap_rwsem);
514}
515
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516/*
517 * Might pages of this file be mapped into userspace?
518 */
519static inline int mapping_mapped(struct address_space *mapping)
520{
Kirill A. Shutemov27ba0642015-02-10 14:09:59 -0800521 return !RB_EMPTY_ROOT(&mapping->i_mmap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522}
523
524/*
525 * Might pages of this file have been modified in userspace?
526 * Note that i_mmap_writable counts all VM_SHARED vmas: do_mmap_pgoff
527 * marks vma as VM_SHARED if it is shared, and the file was opened for
528 * writing i.e. vma may be mprotected writable even if now readonly.
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700529 *
530 * If i_mmap_writable is negative, no new writable mappings are allowed. You
531 * can only deny writable mappings, if none exists right now.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 */
533static inline int mapping_writably_mapped(struct address_space *mapping)
534{
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700535 return atomic_read(&mapping->i_mmap_writable) > 0;
536}
537
538static inline int mapping_map_writable(struct address_space *mapping)
539{
540 return atomic_inc_unless_negative(&mapping->i_mmap_writable) ?
541 0 : -EPERM;
542}
543
544static inline void mapping_unmap_writable(struct address_space *mapping)
545{
546 atomic_dec(&mapping->i_mmap_writable);
547}
548
549static inline int mapping_deny_writable(struct address_space *mapping)
550{
551 return atomic_dec_unless_positive(&mapping->i_mmap_writable) ?
552 0 : -EBUSY;
553}
554
555static inline void mapping_allow_writable(struct address_space *mapping)
556{
557 atomic_inc(&mapping->i_mmap_writable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558}
559
560/*
561 * Use sequence counter to get consistent i_size on 32-bit processors.
562 */
563#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
564#include <linux/seqlock.h>
565#define __NEED_I_SIZE_ORDERED
566#define i_size_ordered_init(inode) seqcount_init(&inode->i_size_seqcount)
567#else
568#define i_size_ordered_init(inode) do { } while (0)
569#endif
570
Al Virof19d4a82009-06-08 19:50:45 -0400571struct posix_acl;
572#define ACL_NOT_CACHED ((void *)(-1))
573
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700574#define IOP_FASTPERM 0x0001
575#define IOP_LOOKUP 0x0002
576#define IOP_NOFOLLOW 0x0004
577
578/*
579 * Keep mostly read-only and often accessed (especially for
580 * the RCU path lookup and 'stat' data) fields at the beginning
581 * of the 'struct inode'
582 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583struct inode {
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100584 umode_t i_mode;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700585 unsigned short i_opflags;
Eric W. Biederman92361632012-02-08 07:07:50 -0800586 kuid_t i_uid;
587 kgid_t i_gid;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700588 unsigned int i_flags;
589
590#ifdef CONFIG_FS_POSIX_ACL
591 struct posix_acl *i_acl;
592 struct posix_acl *i_default_acl;
593#endif
594
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100595 const struct inode_operations *i_op;
596 struct super_block *i_sb;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700597 struct address_space *i_mapping;
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100598
Linus Torvalds13e12d12011-06-08 15:18:19 -0700599#ifdef CONFIG_SECURITY
600 void *i_security;
601#endif
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100602
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700603 /* Stat data, not accessed from path walking */
604 unsigned long i_ino;
Miklos Szeredia78ef702011-10-28 14:13:30 +0200605 /*
606 * Filesystems may only read i_nlink directly. They shall use the
607 * following functions for modification:
608 *
609 * (set|clear|inc|drop)_nlink
610 * inode_(inc|dec)_link_count
611 */
612 union {
613 const unsigned int i_nlink;
614 unsigned int __i_nlink;
615 };
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700616 dev_t i_rdev;
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700617 loff_t i_size;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700618 struct timespec i_atime;
619 struct timespec i_mtime;
620 struct timespec i_ctime;
Theodore Ts'o6cdbb0e2011-10-29 08:24:18 -0400621 spinlock_t i_lock; /* i_blocks, i_bytes, maybe i_size */
622 unsigned short i_bytes;
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700623 unsigned int i_blkbits;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700624 blkcnt_t i_blocks;
625
626#ifdef __NEED_I_SIZE_ORDERED
627 seqcount_t i_size_seqcount;
628#endif
629
630 /* Misc */
631 unsigned long i_state;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700632 struct mutex i_mutex;
Linus Torvalds13e12d12011-06-08 15:18:19 -0700633
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100634 unsigned long dirtied_when; /* jiffies of first dirtying */
Theodore Ts'oa2f48702015-03-17 12:23:19 -0400635 unsigned long dirtied_time_when;
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100636
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637 struct hlist_node i_hash;
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100638 struct list_head i_wb_list; /* backing dev IO list */
Tejun Heo52ebea72015-05-22 17:13:37 -0400639#ifdef CONFIG_CGROUP_WRITEBACK
640 struct bdi_writeback *i_wb; /* the associated cgroup wb */
Tejun Heo2a814902015-05-28 14:50:51 -0400641
642 /* foreign inode detection, see wbc_detach_inode() */
643 int i_wb_frn_winner;
644 u16 i_wb_frn_avg_time;
645 u16 i_wb_frn_history;
Tejun Heo52ebea72015-05-22 17:13:37 -0400646#endif
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100647 struct list_head i_lru; /* inode LRU list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 struct list_head i_sb_list;
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100649 union {
Al Virob3d9b7a2012-06-09 13:51:19 -0400650 struct hlist_head i_dentry;
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100651 struct rcu_head i_rcu;
652 };
Jean Noel Cordenner7a224222008-01-28 23:58:27 -0500653 u64 i_version;
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700654 atomic_t i_count;
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -0400655 atomic_t i_dio_count;
Theodore Ts'o6cdbb0e2011-10-29 08:24:18 -0400656 atomic_t i_writecount;
Mimi Zohard984ea62013-12-11 15:20:54 -0500657#ifdef CONFIG_IMA
658 atomic_t i_readcount; /* struct files open RO */
659#endif
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800660 const struct file_operations *i_fop; /* former ->i_op->default_file_ops */
Jeff Layton4a075e32015-01-16 15:05:54 -0500661 struct file_lock_context *i_flctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 struct address_space i_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 struct list_head i_devices;
Theodore Ts'o4c154162006-09-27 01:50:47 -0700664 union {
665 struct pipe_inode_info *i_pipe;
Theodore Ts'oeaf796e2006-09-27 01:50:48 -0700666 struct block_device *i_bdev;
Theodore Ts'o577c4eb2006-09-27 01:50:49 -0700667 struct cdev *i_cdev;
Theodore Ts'o4c154162006-09-27 01:50:47 -0700668 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669
670 __u32 i_generation;
671
Eric Paris3be25f42009-05-21 17:01:26 -0400672#ifdef CONFIG_FSNOTIFY
673 __u32 i_fsnotify_mask; /* all events this inode cares about */
Eric Parise61ce862009-12-17 21:24:24 -0500674 struct hlist_head i_fsnotify_marks;
Robert Love0eeca282005-07-12 17:06:03 -0400675#endif
676
Theodore Ts'o8e18e292006-09-27 01:50:46 -0700677 void *i_private; /* fs or device private pointer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678};
679
Al Viro1d3382cb2010-10-23 15:19:20 -0400680static inline int inode_unhashed(struct inode *inode)
681{
682 return hlist_unhashed(&inode->i_hash);
683}
684
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685/*
Ingo Molnarf2eace22006-07-03 00:25:05 -0700686 * inode->i_mutex nesting subclasses for the lock validator:
687 *
688 * 0: the object of the current VFS operation
689 * 1: parent
690 * 2: child/target
J. Bruce Fields40bd22c2012-04-18 15:21:34 -0400691 * 3: xattr
692 * 4: second non-directory
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100693 * 5: second parent (when locking independent directories in rename)
694 *
695 * I_MUTEX_NONDIR2 is for certain operations (such as rename) which lock two
J. Bruce Fields40bd22c2012-04-18 15:21:34 -0400696 * non-directories at once.
Ingo Molnarf2eace22006-07-03 00:25:05 -0700697 *
698 * The locking order between these classes is
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100699 * parent[2] -> child -> grandchild -> normal -> xattr -> second non-directory
Ingo Molnarf2eace22006-07-03 00:25:05 -0700700 */
701enum inode_i_mutex_lock_class
702{
703 I_MUTEX_NORMAL,
704 I_MUTEX_PARENT,
705 I_MUTEX_CHILD,
Ingo Molnar4df46242006-08-27 01:23:56 -0700706 I_MUTEX_XATTR,
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100707 I_MUTEX_NONDIR2,
708 I_MUTEX_PARENT2,
Ingo Molnarf2eace22006-07-03 00:25:05 -0700709};
710
J. Bruce Fields375e2892012-04-18 15:16:33 -0400711void lock_two_nondirectories(struct inode *, struct inode*);
712void unlock_two_nondirectories(struct inode *, struct inode*);
713
Ingo Molnarf2eace22006-07-03 00:25:05 -0700714/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715 * NOTE: in a 32bit arch with a preemptable kernel and
716 * an UP compile the i_size_read/write must be atomic
717 * with respect to the local cpu (unlike with preempt disabled),
718 * but they don't need to be atomic with respect to other cpus like in
719 * true SMP (so they need either to either locally disable irq around
720 * the read or for example on x86 they can be still implemented as a
721 * cmpxchg8b without the need of the lock prefix). For SMP compiles
722 * and 64bit archs it makes no difference if preempt is enabled or not.
723 */
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800724static inline loff_t i_size_read(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725{
726#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
727 loff_t i_size;
728 unsigned int seq;
729
730 do {
731 seq = read_seqcount_begin(&inode->i_size_seqcount);
732 i_size = inode->i_size;
733 } while (read_seqcount_retry(&inode->i_size_seqcount, seq));
734 return i_size;
735#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
736 loff_t i_size;
737
738 preempt_disable();
739 i_size = inode->i_size;
740 preempt_enable();
741 return i_size;
742#else
743 return inode->i_size;
744#endif
745}
746
Miklos Szeredi7762f5a2006-10-17 00:10:07 -0700747/*
748 * NOTE: unlike i_size_read(), i_size_write() does need locking around it
749 * (normally i_mutex), otherwise on 32bit/SMP an update of i_size_seqcount
750 * can be lost, resulting in subsequent i_size_read() calls spinning forever.
751 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752static inline void i_size_write(struct inode *inode, loff_t i_size)
753{
754#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
Fan Du74e3d1e2013-04-30 15:27:27 -0700755 preempt_disable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 write_seqcount_begin(&inode->i_size_seqcount);
757 inode->i_size = i_size;
758 write_seqcount_end(&inode->i_size_seqcount);
Fan Du74e3d1e2013-04-30 15:27:27 -0700759 preempt_enable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
761 preempt_disable();
762 inode->i_size = i_size;
763 preempt_enable();
764#else
765 inode->i_size = i_size;
766#endif
767}
768
Eric W. Biederman92361632012-02-08 07:07:50 -0800769/* Helper functions so that in most cases filesystems will
770 * not need to deal directly with kuid_t and kgid_t and can
771 * instead deal with the raw numeric values that are stored
772 * in the filesystem.
773 */
774static inline uid_t i_uid_read(const struct inode *inode)
775{
776 return from_kuid(&init_user_ns, inode->i_uid);
777}
778
779static inline gid_t i_gid_read(const struct inode *inode)
780{
781 return from_kgid(&init_user_ns, inode->i_gid);
782}
783
784static inline void i_uid_write(struct inode *inode, uid_t uid)
785{
786 inode->i_uid = make_kuid(&init_user_ns, uid);
787}
788
789static inline void i_gid_write(struct inode *inode, gid_t gid)
790{
791 inode->i_gid = make_kgid(&init_user_ns, gid);
792}
793
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800794static inline unsigned iminor(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795{
796 return MINOR(inode->i_rdev);
797}
798
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800799static inline unsigned imajor(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800{
801 return MAJOR(inode->i_rdev);
802}
803
804extern struct block_device *I_BDEV(struct inode *inode);
805
806struct fown_struct {
807 rwlock_t lock; /* protects pid, uid, euid fields */
Eric W. Biederman609d7fa2006-10-02 02:17:15 -0700808 struct pid *pid; /* pid or -pgrp where SIGIO should be sent */
809 enum pid_type pid_type; /* Kind of process group SIGIO should be sent to */
Eric W. Biederman92361632012-02-08 07:07:50 -0800810 kuid_t uid, euid; /* uid/euid of process setting the owner */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 int signum; /* posix.1b rt signal to be delivered on IO */
812};
813
814/*
815 * Track a single file's readahead state
816 */
817struct file_ra_state {
Fengguang Wu937085a2007-10-16 01:24:31 -0700818 pgoff_t start; /* where readahead started */
819 unsigned int size; /* # of readahead pages */
820 unsigned int async_size; /* do asynchronous readahead when
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700821 there are only # of pages ahead */
Fengguang Wu5ce11102007-07-19 01:47:59 -0700822
Fengguang Wu937085a2007-10-16 01:24:31 -0700823 unsigned int ra_pages; /* Maximum readahead window */
Wu Fengguang1ebf26a2009-06-16 15:31:19 -0700824 unsigned int mmap_miss; /* Cache miss stat for mmap accesses */
Fengguang Wuf4e6b492007-10-16 01:24:33 -0700825 loff_t prev_pos; /* Cache last read() position */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827
Fengguang Wu5ce11102007-07-19 01:47:59 -0700828/*
Fengguang Wu5ce11102007-07-19 01:47:59 -0700829 * Check if @index falls in the readahead windows.
830 */
831static inline int ra_has_index(struct file_ra_state *ra, pgoff_t index)
832{
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700833 return (index >= ra->start &&
834 index < ra->start + ra->size);
Fengguang Wu5ce11102007-07-19 01:47:59 -0700835}
836
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837struct file {
Eric Dumazet2f512012005-10-30 15:02:16 -0800838 union {
Oleg Nesterov4f5e65a2013-07-08 14:24:16 -0700839 struct llist_node fu_llist;
Eric Dumazet2f512012005-10-30 15:02:16 -0800840 struct rcu_head fu_rcuhead;
841 } f_u;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800842 struct path f_path;
Al Virodd379782013-03-01 19:48:30 -0500843 struct inode *f_inode; /* cached value */
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800844 const struct file_operations *f_op;
Andi Kleenef3d0fd2011-09-15 16:06:48 -0700845
846 /*
Linus Torvalds9c225f22014-03-03 09:36:58 -0800847 * Protects f_ep_links, f_flags.
Andi Kleenef3d0fd2011-09-15 16:06:48 -0700848 * Must not be taken from IRQ context.
849 */
850 spinlock_t f_lock;
Al Viro516e0cc2008-07-26 00:39:17 -0400851 atomic_long_t f_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852 unsigned int f_flags;
Al Viroaeb5d722008-09-02 15:28:45 -0400853 fmode_t f_mode;
Linus Torvalds9c225f22014-03-03 09:36:58 -0800854 struct mutex f_pos_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855 loff_t f_pos;
856 struct fown_struct f_owner;
David Howellsd76b0d92008-11-14 10:39:25 +1100857 const struct cred *f_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 struct file_ra_state f_ra;
859
Mathieu Desnoyers2b47c362007-10-16 23:27:21 -0700860 u64 f_version;
Alexey Dobriyan50462062006-09-29 02:00:01 -0700861#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 void *f_security;
Alexey Dobriyan50462062006-09-29 02:00:01 -0700863#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 /* needed for tty driver, and maybe others */
865 void *private_data;
866
867#ifdef CONFIG_EPOLL
868 /* Used by fs/eventpoll.c to link all the hooks to this file */
869 struct list_head f_ep_links;
Jason Baron28d82dc2012-01-12 17:17:43 -0800870 struct list_head f_tfile_llink;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871#endif /* #ifdef CONFIG_EPOLL */
872 struct address_space *f_mapping;
Al Virobd2a31d2014-03-04 14:54:22 -0500873} __attribute__((aligned(4))); /* lest something weird decides that 2 is OK */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874
Aneesh Kumar K.V990d6c22011-01-29 18:43:26 +0530875struct file_handle {
876 __u32 handle_bytes;
877 int handle_type;
878 /* file identifier */
879 unsigned char f_handle[0];
880};
881
Al Virocb0942b2012-08-27 14:48:26 -0400882static inline struct file *get_file(struct file *f)
883{
884 atomic_long_inc(&f->f_count);
885 return f;
886}
Konstantin Khlebnikov90f31d02015-04-16 12:47:56 -0700887#define get_file_rcu(x) atomic_long_inc_not_zero(&(x)->f_count)
Al Virod7065da2010-05-26 15:13:55 -0400888#define fput_atomic(x) atomic_long_add_unless(&(x)->f_count, -1, 1)
Al Viro516e0cc2008-07-26 00:39:17 -0400889#define file_count(x) atomic_long_read(&(x)->f_count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890
891#define MAX_NON_LFS ((1UL<<31) - 1)
892
893/* Page cache limit. The filesystems should put that into their s_maxbytes
894 limits, otherwise bad things can happen in VM. */
895#if BITS_PER_LONG==32
Chuck Lever2bd2c192012-09-24 14:51:48 -0400896#define MAX_LFS_FILESIZE (((loff_t)PAGE_CACHE_SIZE << (BITS_PER_LONG-1))-1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897#elif BITS_PER_LONG==64
Al Viro614c3212012-10-10 01:06:20 -0400898#define MAX_LFS_FILESIZE ((loff_t)0x7fffffffffffffffLL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899#endif
900
901#define FL_POSIX 1
902#define FL_FLOCK 2
J. Bruce Fields617588d2011-07-01 15:18:34 -0400903#define FL_DELEG 4 /* NFSv4 delegation */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904#define FL_ACCESS 8 /* not trying to lock, just looking */
Trond Myklebustf475ae92006-06-29 16:38:32 -0400905#define FL_EXISTS 16 /* when unlocking, test for existence */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906#define FL_LEASE 32 /* lease held on this file */
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -0700907#define FL_CLOSE 64 /* unlock on close */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908#define FL_SLEEP 128 /* A blocking lock */
J. Bruce Fields778fc542011-07-26 18:25:49 -0400909#define FL_DOWNGRADE_PENDING 256 /* Lease is being downgraded */
910#define FL_UNLOCK_PENDING 512 /* Lease is being broken */
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400911#define FL_OFDLCK 1024 /* lock is "owned" by struct file */
Christoph Hellwig11afe9f2015-01-21 19:17:03 +0100912#define FL_LAYOUT 2048 /* outstanding pNFS layout */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913
914/*
Miklos Szeredibde74e42008-07-25 01:48:57 -0700915 * Special return value from posix_lock_file() and vfs_lock_file() for
916 * asynchronous locking.
917 */
918#define FILE_LOCK_DEFERRED 1
919
Jeff Layton7ca76312014-09-01 19:04:48 -0400920/* legacy typedef, should eventually be removed */
Christoph Hellwig17fa3882014-07-13 17:00:37 +0200921typedef void *fl_owner_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922
Jeff Laytona7231a92015-01-16 15:05:56 -0500923struct file_lock;
924
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925struct file_lock_operations {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926 void (*fl_copy_lock)(struct file_lock *, struct file_lock *);
927 void (*fl_release_private)(struct file_lock *);
928};
929
930struct lock_manager_operations {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400931 int (*lm_compare_owner)(struct file_lock *, struct file_lock *);
Jeff Layton3999e492013-06-21 08:58:19 -0400932 unsigned long (*lm_owner_key)(struct file_lock *);
Jeff Laytoncae80b32015-04-03 09:04:04 -0400933 fl_owner_t (*lm_get_owner)(fl_owner_t);
934 void (*lm_put_owner)(fl_owner_t);
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400935 void (*lm_notify)(struct file_lock *); /* unblock callback */
Joe Perchesd0449b92014-08-22 10:18:42 -0400936 int (*lm_grant)(struct file_lock *, int);
Jeff Layton4d01b7f2014-09-01 15:06:54 -0400937 bool (*lm_break)(struct file_lock *);
Jeff Layton7448cc32015-01-16 15:05:57 -0500938 int (*lm_change)(struct file_lock *, int, struct list_head *);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -0400939 void (*lm_setup)(struct file_lock *, void **);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940};
941
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -0400942struct lock_manager {
943 struct list_head list;
944};
945
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +0400946struct net;
947void locks_start_grace(struct net *, struct lock_manager *);
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -0400948void locks_end_grace(struct lock_manager *);
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +0400949int locks_in_grace(struct net *);
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -0400950
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951/* that will die - we need it for nfs_lock_info */
952#include <linux/nfs_fs_i.h>
953
Jeff Layton1cb36012013-06-21 08:58:12 -0400954/*
955 * struct file_lock represents a generic "file lock". It's used to represent
956 * POSIX byte range locks, BSD (flock) locks, and leases. It's important to
957 * note that the same struct is used to represent both a request for a lock and
958 * the lock itself, but the same object is never used for both.
959 *
960 * FIXME: should we create a separate "struct lock_request" to help distinguish
961 * these two uses?
962 *
Jeff Layton8116bf42015-01-21 20:44:01 -0500963 * The varous i_flctx lists are ordered by:
Jeff Layton1cb36012013-06-21 08:58:12 -0400964 *
Jeff Layton8116bf42015-01-21 20:44:01 -0500965 * 1) lock owner
966 * 2) lock range start
967 * 3) lock range end
Jeff Layton1cb36012013-06-21 08:58:12 -0400968 *
969 * Obviously, the last two criteria only matter for POSIX locks.
970 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971struct file_lock {
972 struct file_lock *fl_next; /* singly linked list for this inode */
Jeff Layton6dee60f2015-01-16 15:05:54 -0500973 struct list_head fl_list; /* link into file_lock_context */
Jeff Layton139ca042013-06-21 08:58:17 -0400974 struct hlist_node fl_link; /* node in global lists */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975 struct list_head fl_block; /* circular list of blocked processes */
976 fl_owner_t fl_owner;
J. Bruce Fields710b7212011-07-26 16:28:29 -0400977 unsigned int fl_flags;
Richard Kennedyafc12462008-07-11 17:20:49 -0700978 unsigned char fl_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979 unsigned int fl_pid;
Jeff Layton7012b022013-06-21 08:58:22 -0400980 int fl_link_cpu; /* what cpu's list is this on? */
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000981 struct pid *fl_nspid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982 wait_queue_head_t fl_wait;
983 struct file *fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 loff_t fl_start;
985 loff_t fl_end;
986
987 struct fasync_struct * fl_fasync; /* for lease break notifications */
J. Bruce Fields778fc542011-07-26 18:25:49 -0400988 /* for lease breaks: */
989 unsigned long fl_break_time;
990 unsigned long fl_downgrade_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991
Alexey Dobriyan6aed6282009-09-21 17:01:11 -0700992 const struct file_lock_operations *fl_ops; /* Callbacks for filesystems */
Alexey Dobriyan7b021962009-09-21 17:01:12 -0700993 const struct lock_manager_operations *fl_lmops; /* Callbacks for lockmanagers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994 union {
995 struct nfs_lock_info nfs_fl;
Trond Myklebust8d0a8a92005-06-22 17:16:32 +0000996 struct nfs4_lock_info nfs4_fl;
David Howellse8d6c552007-07-15 23:40:12 -0700997 struct {
998 struct list_head link; /* link in AFS vnode's pending_locks list */
999 int state; /* state of grant or error if -ve */
1000 } afs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001 } fl_u;
1002};
1003
Jeff Layton4a075e32015-01-16 15:05:54 -05001004struct file_lock_context {
Jeff Layton6109c852015-01-16 15:05:57 -05001005 spinlock_t flc_lock;
Jeff Layton4a075e32015-01-16 15:05:54 -05001006 struct list_head flc_flock;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001007 struct list_head flc_posix;
Jeff Layton8634b512015-01-16 15:05:55 -05001008 struct list_head flc_lease;
Jeff Layton4a075e32015-01-16 15:05:54 -05001009};
1010
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011/* The following constant reflects the upper bound of the file/locking space */
1012#ifndef OFFSET_MAX
1013#define INT_LIMIT(x) (~((x)1 << (sizeof(x)*8 - 1)))
1014#define OFFSET_MAX INT_LIMIT(loff_t)
1015#define OFFT_OFFSET_MAX INT_LIMIT(off_t)
1016#endif
1017
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018#include <linux/fcntl.h>
1019
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001020extern void send_sigio(struct fown_struct *fown, int fd, int band);
1021
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001022#ifdef CONFIG_FILE_LOCKING
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001023extern int fcntl_getlk(struct file *, unsigned int, struct flock __user *);
Peter Staubachc2936212005-07-27 11:45:09 -07001024extern int fcntl_setlk(unsigned int, struct file *, unsigned int,
1025 struct flock __user *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026
1027#if BITS_PER_LONG == 32
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001028extern int fcntl_getlk64(struct file *, unsigned int, struct flock64 __user *);
Peter Staubachc2936212005-07-27 11:45:09 -07001029extern int fcntl_setlk64(unsigned int, struct file *, unsigned int,
1030 struct flock64 __user *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031#endif
1032
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033extern int fcntl_setlease(unsigned int fd, struct file *filp, long arg);
1034extern int fcntl_getlease(struct file *filp);
1035
1036/* fs/locks.c */
Jeff Layton4a075e32015-01-16 15:05:54 -05001037void locks_free_lock_context(struct file_lock_context *ctx);
J. Bruce Fields05fa3132010-10-30 17:31:15 -04001038void locks_free_lock(struct file_lock *fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039extern void locks_init_lock(struct file_lock *);
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001040extern struct file_lock * locks_alloc_lock(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041extern void locks_copy_lock(struct file_lock *, struct file_lock *);
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001042extern void locks_copy_conflock(struct file_lock *, struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043extern void locks_remove_posix(struct file *, fl_owner_t);
Jeff Layton78ed8a12014-02-03 12:13:08 -05001044extern void locks_remove_file(struct file *);
Felix Blyakhera9e61e22009-03-31 15:12:56 -05001045extern void locks_release_private(struct file_lock *);
J. Bruce Fields6d34ac12007-05-11 16:09:32 -04001046extern void posix_test_lock(struct file *, struct file_lock *);
Marc Eshel150b3932007-01-18 16:15:35 -05001047extern int posix_lock_file(struct file *, struct file_lock *, struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048extern int posix_lock_file_wait(struct file *, struct file_lock *);
Jeff Laytonf891a292013-06-21 08:58:09 -04001049extern int posix_unblock_lock(struct file_lock *);
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001050extern int vfs_test_lock(struct file *, struct file_lock *);
Marc Eshel150b3932007-01-18 16:15:35 -05001051extern int vfs_lock_file(struct file *, unsigned int, struct file_lock *, struct file_lock *);
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05001052extern int vfs_cancel_lock(struct file *filp, struct file_lock *fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053extern int flock_lock_file_wait(struct file *filp, struct file_lock *fl);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001054extern int __break_lease(struct inode *inode, unsigned int flags, unsigned int type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055extern void lease_get_mtime(struct inode *, struct timespec *time);
Jeff Laytone6f5c782014-08-22 10:40:25 -04001056extern int generic_setlease(struct file *, long, struct file_lock **, void **priv);
1057extern int vfs_setlease(struct file *, long, struct file_lock **, void **);
Jeff Layton7448cc32015-01-16 15:05:57 -05001058extern int lease_modify(struct file_lock *, int, struct list_head *);
Andrey Vagin6c8c9032015-04-16 12:49:38 -07001059struct files_struct;
1060extern void show_fd_locks(struct seq_file *f,
1061 struct file *filp, struct files_struct *files);
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001062#else /* !CONFIG_FILE_LOCKING */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001063static inline int fcntl_getlk(struct file *file, unsigned int cmd,
1064 struct flock __user *user)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001065{
1066 return -EINVAL;
1067}
1068
1069static inline int fcntl_setlk(unsigned int fd, struct file *file,
1070 unsigned int cmd, struct flock __user *user)
1071{
1072 return -EACCES;
1073}
1074
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001075#if BITS_PER_LONG == 32
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001076static inline int fcntl_getlk64(struct file *file, unsigned int cmd,
1077 struct flock64 __user *user)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001078{
1079 return -EINVAL;
1080}
1081
1082static inline int fcntl_setlk64(unsigned int fd, struct file *file,
1083 unsigned int cmd, struct flock64 __user *user)
1084{
1085 return -EACCES;
1086}
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001087#endif
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001088static inline int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1089{
Jeff Layton1b2b32d2014-09-24 08:38:44 -04001090 return -EINVAL;
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001091}
1092
1093static inline int fcntl_getlease(struct file *filp)
1094{
Jeff Layton1b2b32d2014-09-24 08:38:44 -04001095 return F_UNLCK;
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001096}
1097
Jeff Layton4a075e32015-01-16 15:05:54 -05001098static inline void
1099locks_free_lock_context(struct file_lock_context *ctx)
1100{
1101}
1102
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001103static inline void locks_init_lock(struct file_lock *fl)
1104{
1105 return;
1106}
1107
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001108static inline void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001109{
1110 return;
1111}
1112
1113static inline void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
1114{
1115 return;
1116}
1117
1118static inline void locks_remove_posix(struct file *filp, fl_owner_t owner)
1119{
1120 return;
1121}
1122
Jeff Layton78ed8a12014-02-03 12:13:08 -05001123static inline void locks_remove_file(struct file *filp)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001124{
1125 return;
1126}
1127
1128static inline void posix_test_lock(struct file *filp, struct file_lock *fl)
1129{
1130 return;
1131}
1132
1133static inline int posix_lock_file(struct file *filp, struct file_lock *fl,
1134 struct file_lock *conflock)
1135{
1136 return -ENOLCK;
1137}
1138
1139static inline int posix_lock_file_wait(struct file *filp, struct file_lock *fl)
1140{
1141 return -ENOLCK;
1142}
1143
Jeff Laytonf891a292013-06-21 08:58:09 -04001144static inline int posix_unblock_lock(struct file_lock *waiter)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001145{
1146 return -ENOENT;
1147}
1148
1149static inline int vfs_test_lock(struct file *filp, struct file_lock *fl)
1150{
1151 return 0;
1152}
1153
1154static inline int vfs_lock_file(struct file *filp, unsigned int cmd,
1155 struct file_lock *fl, struct file_lock *conf)
1156{
1157 return -ENOLCK;
1158}
1159
1160static inline int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
1161{
1162 return 0;
1163}
1164
1165static inline int flock_lock_file_wait(struct file *filp,
1166 struct file_lock *request)
1167{
1168 return -ENOLCK;
1169}
1170
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001171static inline int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001172{
1173 return 0;
1174}
1175
1176static inline void lease_get_mtime(struct inode *inode, struct timespec *time)
1177{
1178 return;
1179}
1180
1181static inline int generic_setlease(struct file *filp, long arg,
Jeff Laytone6f5c782014-08-22 10:40:25 -04001182 struct file_lock **flp, void **priv)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001183{
1184 return -EINVAL;
1185}
1186
1187static inline int vfs_setlease(struct file *filp, long arg,
Jeff Laytone6f5c782014-08-22 10:40:25 -04001188 struct file_lock **lease, void **priv)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001189{
1190 return -EINVAL;
1191}
1192
Jeff Layton7448cc32015-01-16 15:05:57 -05001193static inline int lease_modify(struct file_lock *fl, int arg,
Jeff Laytonc45198e2014-09-01 07:12:07 -04001194 struct list_head *dispose)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001195{
1196 return -EINVAL;
1197}
Andrey Vagin6c8c9032015-04-16 12:49:38 -07001198
1199struct files_struct;
1200static inline void show_fd_locks(struct seq_file *f,
1201 struct file *filp, struct files_struct *files) {}
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001202#endif /* !CONFIG_FILE_LOCKING */
1203
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204
1205struct fasync_struct {
Eric Dumazet989a2972010-04-14 09:55:35 +00001206 spinlock_t fa_lock;
1207 int magic;
1208 int fa_fd;
1209 struct fasync_struct *fa_next; /* singly linked list */
1210 struct file *fa_file;
1211 struct rcu_head fa_rcu;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212};
1213
1214#define FASYNC_MAGIC 0x4601
1215
1216/* SMP safe fasync helpers: */
1217extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001218extern struct fasync_struct *fasync_insert_entry(int, struct file *, struct fasync_struct **, struct fasync_struct *);
1219extern int fasync_remove_entry(struct file *, struct fasync_struct **);
1220extern struct fasync_struct *fasync_alloc(void);
1221extern void fasync_free(struct fasync_struct *);
1222
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223/* can be called from interrupts */
1224extern void kill_fasync(struct fasync_struct **, int, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225
Jeff Laytone0b93ed2014-08-22 11:27:32 -04001226extern void __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
1227extern void f_setown(struct file *filp, unsigned long arg, int force);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228extern void f_delown(struct file *filp);
Eric W. Biederman609d7fa2006-10-02 02:17:15 -07001229extern pid_t f_getown(struct file *filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230extern int send_sigurg(struct fown_struct *fown);
1231
Jan Kara5accdf82012-06-12 16:20:34 +02001232struct mm_struct;
1233
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234/*
1235 * Umount options
1236 */
1237
1238#define MNT_FORCE 0x00000001 /* Attempt to forcibily umount */
1239#define MNT_DETACH 0x00000002 /* Just detach from the tree */
1240#define MNT_EXPIRE 0x00000004 /* Mark for expiry */
Miklos Szeredidb1f05b2010-02-10 12:15:53 +01001241#define UMOUNT_NOFOLLOW 0x00000008 /* Don't follow symlink on umount */
1242#define UMOUNT_UNUSED 0x80000000 /* Flag guaranteed to be unused */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243
Tejun Heo46b15ca2015-06-16 18:48:31 -04001244/* sb->s_iflags */
1245#define SB_I_CGROUPWB 0x00000001 /* cgroup-aware writeback enabled */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246
Jan Kara5accdf82012-06-12 16:20:34 +02001247/* Possible states of 'frozen' field */
1248enum {
1249 SB_UNFROZEN = 0, /* FS is unfrozen */
1250 SB_FREEZE_WRITE = 1, /* Writes, dir ops, ioctls frozen */
Jan Kara5accdf82012-06-12 16:20:34 +02001251 SB_FREEZE_PAGEFAULT = 2, /* Page faults stopped as well */
1252 SB_FREEZE_FS = 3, /* For internal FS use (e.g. to stop
1253 * internal threads if needed) */
1254 SB_FREEZE_COMPLETE = 4, /* ->freeze_fs finished successfully */
1255};
1256
1257#define SB_FREEZE_LEVELS (SB_FREEZE_COMPLETE - 1)
1258
1259struct sb_writers {
1260 /* Counters for counting writers at each level */
1261 struct percpu_counter counter[SB_FREEZE_LEVELS];
1262 wait_queue_head_t wait; /* queue for waiting for
1263 writers / faults to finish */
1264 int frozen; /* Is sb frozen? */
1265 wait_queue_head_t wait_unfrozen; /* queue for waiting for
1266 sb to be thawed */
1267#ifdef CONFIG_DEBUG_LOCK_ALLOC
1268 struct lockdep_map lock_map[SB_FREEZE_LEVELS];
1269#endif
1270};
1271
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272struct super_block {
1273 struct list_head s_list; /* Keep this first */
1274 dev_t s_dev; /* search index; _not_ kdev_t */
Richard Kennedy270ba5f2010-01-26 14:12:43 +00001275 unsigned char s_blocksize_bits;
1276 unsigned long s_blocksize;
Jeff Layton42cb56a2009-09-18 13:05:53 -07001277 loff_t s_maxbytes; /* Max file size */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278 struct file_system_type *s_type;
Josef 'Jeff' Sipekee9b6d62007-02-12 00:55:41 -08001279 const struct super_operations *s_op;
Alexey Dobriyan61e225d2009-09-21 17:01:08 -07001280 const struct dquot_operations *dq_op;
Alexey Dobriyan0d54b212009-09-21 17:01:09 -07001281 const struct quotactl_ops *s_qcop;
Christoph Hellwig39655162007-10-21 16:42:17 -07001282 const struct export_operations *s_export_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283 unsigned long s_flags;
Tejun Heo46b15ca2015-06-16 18:48:31 -04001284 unsigned long s_iflags; /* internal SB_I_* flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285 unsigned long s_magic;
1286 struct dentry *s_root;
1287 struct rw_semaphore s_umount;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288 int s_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289 atomic_t s_active;
Alexey Dobriyan50462062006-09-29 02:00:01 -07001290#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 void *s_security;
Alexey Dobriyan50462062006-09-29 02:00:01 -07001292#endif
Stephen Hemmingerbb435452010-05-13 17:53:14 -07001293 const struct xattr_handler **s_xattr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294
1295 struct list_head s_inodes; /* all inodes */
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001296 struct hlist_bl_head s_anon; /* anonymous dentries for (nfs) exporting */
Miklos Szeredi39f7c4d2011-11-21 12:11:30 +01001297 struct list_head s_mounts; /* list of mounts; _not_ for fs use */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298 struct block_device *s_bdev;
Jens Axboe32a88aa2009-09-16 15:02:33 +02001299 struct backing_dev_info *s_bdi;
David Howellsacaebfd2007-05-10 22:51:50 -07001300 struct mtd_info *s_mtd;
Al Viroa5166162011-12-12 22:53:00 -05001301 struct hlist_node s_instances;
Jan Kara2c5f6482014-09-30 10:43:09 +02001302 unsigned int s_quota_types; /* Bitmask of supported quota types */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303 struct quota_info s_dquot; /* Diskquota specific options */
1304
Jan Kara5accdf82012-06-12 16:20:34 +02001305 struct sb_writers s_writers;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306
1307 char s_id[32]; /* Informational name */
Linus Torvalds0bba0162011-04-12 15:21:04 -07001308 u8 s_uuid[16]; /* UUID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309
1310 void *s_fs_info; /* Filesystem private info */
Al Viro8de52772012-02-06 12:45:27 -05001311 unsigned int s_max_links;
Al Viro30c40d22008-02-22 19:50:45 -05001312 fmode_t s_mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313
Richard Kennedy270ba5f2010-01-26 14:12:43 +00001314 /* Granularity of c/m/atime in ns.
1315 Cannot be worse than a second */
1316 u32 s_time_gran;
1317
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318 /*
1319 * The next field is for VFS *only*. No filesystems have any business
1320 * even looking at it. You had been warned.
1321 */
Arjan van de Vena11f3a02006-03-23 03:00:33 -08001322 struct mutex s_vfs_rename_mutex; /* Kludge */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323
Miklos Szeredi79c0b2d2007-05-08 00:25:43 -07001324 /*
1325 * Filesystem subtype. If non-empty the filesystem type field
1326 * in /proc/mounts will be "type.subtype"
1327 */
1328 char *s_subtype;
Miklos Szeredib3b304a2008-02-08 04:21:35 -08001329
1330 /*
1331 * Saved mount options for lazy filesystems using
1332 * generic_show_options()
1333 */
Arnd Bergmann4d2deb42010-02-24 20:01:56 +01001334 char __rcu *s_options;
Al Viroc8aebb02010-12-18 10:22:30 -05001335 const struct dentry_operations *s_d_op; /* default d_op for dentries */
Dan Magenheimer9fdfdcf2011-05-26 10:01:19 -06001336
1337 /*
1338 * Saved pool identifier for cleancache (-1 means none)
1339 */
1340 int cleancache_poolid;
Dave Chinnerb0d40c92011-07-08 14:14:42 +10001341
1342 struct shrinker s_shrink; /* per-sb shrinker handle */
Miklos Szeredi4ed5e82f2011-11-21 12:11:31 +01001343
Miklos Szeredi7ada4db2011-11-21 12:11:32 +01001344 /* Number of inodes with nlink == 0 but still referenced */
1345 atomic_long_t s_remove_count;
1346
Miklos Szeredi4ed5e82f2011-11-21 12:11:31 +01001347 /* Being remounted read-only */
1348 int s_readonly_remount;
Christoph Hellwig7b7a8662013-09-04 15:04:39 +02001349
1350 /* AIO completions deferred from interrupt context */
1351 struct workqueue_struct *s_dio_done_wq;
Al Viro215752f2014-08-07 06:23:41 -04001352 struct hlist_head s_pins;
Dave Chinnerf6041562013-08-28 10:18:00 +10001353
1354 /*
1355 * Keep the lru lists last in the structure so they always sit on their
1356 * own individual cachelines.
1357 */
1358 struct list_lru s_dentry_lru ____cacheline_aligned_in_smp;
1359 struct list_lru s_inode_lru ____cacheline_aligned_in_smp;
Al Viroe2fec7c2013-10-04 17:06:56 -04001360 struct rcu_head rcu;
Miklos Szeredi69c433e2014-10-24 00:14:39 +02001361
1362 /*
1363 * Indicates how deep in a filesystem stack this SB is
1364 */
1365 int s_stack_depth;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366};
1367
1368extern struct timespec current_fs_time(struct super_block *sb);
1369
1370/*
1371 * Snapshotting support.
1372 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373
Jan Kara5accdf82012-06-12 16:20:34 +02001374void __sb_end_write(struct super_block *sb, int level);
1375int __sb_start_write(struct super_block *sb, int level, bool wait);
1376
1377/**
1378 * sb_end_write - drop write access to a superblock
1379 * @sb: the super we wrote to
1380 *
1381 * Decrement number of writers to the filesystem. Wake up possible waiters
1382 * wanting to freeze the filesystem.
1383 */
1384static inline void sb_end_write(struct super_block *sb)
1385{
1386 __sb_end_write(sb, SB_FREEZE_WRITE);
1387}
1388
1389/**
1390 * sb_end_pagefault - drop write access to a superblock from a page fault
1391 * @sb: the super we wrote to
1392 *
1393 * Decrement number of processes handling write page fault to the filesystem.
1394 * Wake up possible waiters wanting to freeze the filesystem.
1395 */
1396static inline void sb_end_pagefault(struct super_block *sb)
1397{
1398 __sb_end_write(sb, SB_FREEZE_PAGEFAULT);
1399}
1400
1401/**
1402 * sb_end_intwrite - drop write access to a superblock for internal fs purposes
1403 * @sb: the super we wrote to
1404 *
1405 * Decrement fs-internal number of writers to the filesystem. Wake up possible
1406 * waiters wanting to freeze the filesystem.
1407 */
1408static inline void sb_end_intwrite(struct super_block *sb)
1409{
1410 __sb_end_write(sb, SB_FREEZE_FS);
1411}
1412
1413/**
1414 * sb_start_write - get write access to a superblock
1415 * @sb: the super we write to
1416 *
1417 * When a process wants to write data or metadata to a file system (i.e. dirty
1418 * a page or an inode), it should embed the operation in a sb_start_write() -
1419 * sb_end_write() pair to get exclusion against file system freezing. This
1420 * function increments number of writers preventing freezing. If the file
1421 * system is already frozen, the function waits until the file system is
1422 * thawed.
1423 *
1424 * Since freeze protection behaves as a lock, users have to preserve
1425 * ordering of freeze protection and other filesystem locks. Generally,
1426 * freeze protection should be the outermost lock. In particular, we have:
1427 *
1428 * sb_start_write
1429 * -> i_mutex (write path, truncate, directory ops, ...)
1430 * -> s_umount (freeze_super, thaw_super)
1431 */
1432static inline void sb_start_write(struct super_block *sb)
1433{
1434 __sb_start_write(sb, SB_FREEZE_WRITE, true);
1435}
1436
1437static inline int sb_start_write_trylock(struct super_block *sb)
1438{
1439 return __sb_start_write(sb, SB_FREEZE_WRITE, false);
1440}
1441
1442/**
1443 * sb_start_pagefault - get write access to a superblock from a page fault
1444 * @sb: the super we write to
1445 *
1446 * When a process starts handling write page fault, it should embed the
1447 * operation into sb_start_pagefault() - sb_end_pagefault() pair to get
1448 * exclusion against file system freezing. This is needed since the page fault
1449 * is going to dirty a page. This function increments number of running page
1450 * faults preventing freezing. If the file system is already frozen, the
1451 * function waits until the file system is thawed.
1452 *
1453 * Since page fault freeze protection behaves as a lock, users have to preserve
1454 * ordering of freeze protection and other filesystem locks. It is advised to
1455 * put sb_start_pagefault() close to mmap_sem in lock ordering. Page fault
1456 * handling code implies lock dependency:
1457 *
1458 * mmap_sem
1459 * -> sb_start_pagefault
1460 */
1461static inline void sb_start_pagefault(struct super_block *sb)
1462{
1463 __sb_start_write(sb, SB_FREEZE_PAGEFAULT, true);
1464}
1465
1466/*
1467 * sb_start_intwrite - get write access to a superblock for internal fs purposes
1468 * @sb: the super we write to
1469 *
1470 * This is the third level of protection against filesystem freezing. It is
1471 * free for use by a filesystem. The only requirement is that it must rank
1472 * below sb_start_pagefault.
1473 *
1474 * For example filesystem can call sb_start_intwrite() when starting a
1475 * transaction which somewhat eases handling of freezing for internal sources
1476 * of filesystem changes (internal fs threads, discarding preallocation on file
1477 * close, etc.).
1478 */
1479static inline void sb_start_intwrite(struct super_block *sb)
1480{
1481 __sb_start_write(sb, SB_FREEZE_FS, true);
1482}
1483
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484
Serge E. Hallyn2e149672011-03-23 16:43:26 -07001485extern bool inode_owner_or_capable(const struct inode *inode);
Satyam Sharma3bd858a2007-07-17 15:00:08 +05301486
Linus Torvalds1da177e2005-04-16 15:20:36 -07001487/*
1488 * VFS helper functions..
1489 */
Al Viro312b63f2012-06-10 18:09:36 -04001490extern int vfs_create(struct inode *, struct dentry *, umode_t, bool);
Al Viro18bb1db2011-07-26 01:41:39 -04001491extern int vfs_mkdir(struct inode *, struct dentry *, umode_t);
Al Viro1a67aaf2011-07-26 01:52:52 -04001492extern int vfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
Miklos Szeredidb2e7472008-06-24 16:50:16 +02001493extern int vfs_symlink(struct inode *, struct dentry *, const char *);
J. Bruce Fields146a8592011-09-20 17:14:31 -04001494extern int vfs_link(struct dentry *, struct inode *, struct dentry *, struct inode **);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495extern int vfs_rmdir(struct inode *, struct dentry *);
J. Bruce Fieldsb21996e2011-09-20 09:14:34 -04001496extern int vfs_unlink(struct inode *, struct dentry *, struct inode **);
Miklos Szeredi520c8b12014-04-01 17:08:42 +02001497extern int vfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *, struct inode **, unsigned int);
Miklos Szeredi787fb6b2014-10-24 00:14:36 +02001498extern int vfs_whiteout(struct inode *, struct dentry *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499
1500/*
1501 * VFS dentry helper functions.
1502 */
1503extern void dentry_unhash(struct dentry *dentry);
1504
1505/*
Christoph Hellwig8c744fb2005-11-08 21:35:04 -08001506 * VFS file helper functions.
1507 */
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03001508extern void inode_init_owner(struct inode *inode, const struct inode *dir,
Al Viro62bb1092011-07-24 23:20:18 -04001509 umode_t mode);
Christoph Hellwig8c744fb2005-11-08 21:35:04 -08001510/*
Mark Fashehc4b929b2008-10-08 19:44:18 -04001511 * VFS FS_IOC_FIEMAP helper definitions.
1512 */
1513struct fiemap_extent_info {
1514 unsigned int fi_flags; /* Flags as passed from user */
1515 unsigned int fi_extents_mapped; /* Number of mapped extents */
1516 unsigned int fi_extents_max; /* Size of fiemap_extent array */
Namhyung Kimecf56322011-01-16 23:28:17 +09001517 struct fiemap_extent __user *fi_extents_start; /* Start of
1518 fiemap_extent array */
Mark Fashehc4b929b2008-10-08 19:44:18 -04001519};
1520int fiemap_fill_next_extent(struct fiemap_extent_info *info, u64 logical,
1521 u64 phys, u64 len, u32 flags);
1522int fiemap_check_flags(struct fiemap_extent_info *fieinfo, u32 fs_flags);
1523
1524/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525 * File types
1526 *
1527 * NOTE! These match bits 12..15 of stat.st_mode
1528 * (ie "(i_mode >> 12) & 15").
1529 */
1530#define DT_UNKNOWN 0
1531#define DT_FIFO 1
1532#define DT_CHR 2
1533#define DT_DIR 4
1534#define DT_BLK 6
1535#define DT_REG 8
1536#define DT_LNK 10
1537#define DT_SOCK 12
1538#define DT_WHT 14
1539
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540/*
1541 * This is the "filldir" function type, used by readdir() to let
1542 * the kernel specify what kind of dirent layout it wants to have.
1543 * This allows the kernel to read directories into kernel space or
1544 * to have different dirent layouts depending on the binary type.
1545 */
Miklos Szerediac7576f2014-10-30 17:37:34 +01001546struct dir_context;
1547typedef int (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64,
1548 unsigned);
1549
Al Viro5c0ba4e2013-05-15 13:52:59 -04001550struct dir_context {
Al Viroac6614b2013-05-22 22:22:04 -04001551 const filldir_t actor;
Al Virobb6f6192013-05-15 18:49:12 -04001552 loff_t pos;
Al Viro5c0ba4e2013-05-15 13:52:59 -04001553};
Al Virobb6f6192013-05-15 18:49:12 -04001554
Al Viro08f85852007-10-08 13:26:20 -04001555struct block_device_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557/* These macros are for out of kernel modules to test that
1558 * the kernel supports the unlocked_ioctl and compat_ioctl
1559 * fields in struct file_operations. */
1560#define HAVE_COMPAT_IOCTL 1
1561#define HAVE_UNLOCKED_IOCTL 1
1562
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01001563/*
1564 * These flags let !MMU mmap() govern direct device mapping vs immediate
1565 * copying more easily for MAP_PRIVATE, especially for ROM filesystems.
1566 *
1567 * NOMMU_MAP_COPY: Copy can be mapped (MAP_PRIVATE)
1568 * NOMMU_MAP_DIRECT: Can be mapped directly (MAP_SHARED)
1569 * NOMMU_MAP_READ: Can be mapped for reading
1570 * NOMMU_MAP_WRITE: Can be mapped for writing
1571 * NOMMU_MAP_EXEC: Can be mapped for execution
1572 */
1573#define NOMMU_MAP_COPY 0x00000001
1574#define NOMMU_MAP_DIRECT 0x00000008
1575#define NOMMU_MAP_READ VM_MAYREAD
1576#define NOMMU_MAP_WRITE VM_MAYWRITE
1577#define NOMMU_MAP_EXEC VM_MAYEXEC
1578
1579#define NOMMU_VMFLAGS \
1580 (NOMMU_MAP_READ | NOMMU_MAP_WRITE | NOMMU_MAP_EXEC)
1581
1582
Al Viro293bc982014-02-11 18:37:41 -05001583struct iov_iter;
1584
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585struct file_operations {
1586 struct module *owner;
1587 loff_t (*llseek) (struct file *, loff_t, int);
1588 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
Al Viro293bc982014-02-11 18:37:41 -05001590 ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
1591 ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
Al Virobb6f6192013-05-15 18:49:12 -04001592 int (*iterate) (struct file *, struct dir_context *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593 unsigned int (*poll) (struct file *, struct poll_table_struct *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
1595 long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
1596 int (*mmap) (struct file *, struct vm_area_struct *);
Al Virob2edffd2015-04-06 17:48:54 -04001597 int (*mremap)(struct file *, struct vm_area_struct *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598 int (*open) (struct inode *, struct file *);
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07001599 int (*flush) (struct file *, fl_owner_t id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600 int (*release) (struct inode *, struct file *);
Josef Bacik02c24a82011-07-16 20:44:56 -04001601 int (*fsync) (struct file *, loff_t, loff_t, int datasync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602 int (*aio_fsync) (struct kiocb *, int datasync);
1603 int (*fasync) (int, struct file *, int);
1604 int (*lock) (struct file *, int, struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605 ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
1606 unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
1607 int (*check_flags)(int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608 int (*flock) (struct file *, int, struct file_lock *);
Jens Axboecbb7e572006-04-11 14:57:50 +02001609 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int);
1610 ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int);
Jeff Laytone6f5c782014-08-22 10:40:25 -04001611 int (*setlease)(struct file *, long, struct file_lock **, void **);
Christoph Hellwig2fe17c12011-01-14 13:07:43 +01001612 long (*fallocate)(struct file *file, int mode, loff_t offset,
1613 loff_t len);
Joe Perchesa3816ab2014-09-29 16:08:25 -07001614 void (*show_fdinfo)(struct seq_file *m, struct file *f);
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01001615#ifndef CONFIG_MMU
1616 unsigned (*mmap_capabilities)(struct file *);
1617#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618};
1619
1620struct inode_operations {
Al Viro00cd8dd2012-06-10 17:13:09 -04001621 struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001622 void * (*follow_link) (struct dentry *, struct nameidata *);
Al Viro10556cb22011-06-20 19:28:19 -04001623 int (*permission) (struct inode *, int);
Christoph Hellwig4e34e712011-07-23 17:37:31 +02001624 struct posix_acl * (*get_acl)(struct inode *, int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001625
1626 int (*readlink) (struct dentry *, char __user *,int);
1627 void (*put_link) (struct dentry *, struct nameidata *, void *);
1628
Al Viroebfc3b42012-06-10 18:05:36 -04001629 int (*create) (struct inode *,struct dentry *, umode_t, bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630 int (*link) (struct dentry *,struct inode *,struct dentry *);
1631 int (*unlink) (struct inode *,struct dentry *);
1632 int (*symlink) (struct inode *,struct dentry *,const char *);
Al Viro18bb1db2011-07-26 01:41:39 -04001633 int (*mkdir) (struct inode *,struct dentry *,umode_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634 int (*rmdir) (struct inode *,struct dentry *);
Al Viro1a67aaf2011-07-26 01:52:52 -04001635 int (*mknod) (struct inode *,struct dentry *,umode_t,dev_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636 int (*rename) (struct inode *, struct dentry *,
1637 struct inode *, struct dentry *);
Miklos Szeredi520c8b12014-04-01 17:08:42 +02001638 int (*rename2) (struct inode *, struct dentry *,
1639 struct inode *, struct dentry *, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640 int (*setattr) (struct dentry *, struct iattr *);
1641 int (*getattr) (struct vfsmount *mnt, struct dentry *, struct kstat *);
1642 int (*setxattr) (struct dentry *, const char *,const void *,size_t,int);
1643 ssize_t (*getxattr) (struct dentry *, const char *, void *, size_t);
1644 ssize_t (*listxattr) (struct dentry *, char *, size_t);
1645 int (*removexattr) (struct dentry *, const char *);
Mark Fashehc4b929b2008-10-08 19:44:18 -04001646 int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
1647 u64 len);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001648 int (*update_time)(struct inode *, struct timespec *, int);
Al Virod9585272012-06-22 12:39:14 +04001649 int (*atomic_open)(struct inode *, struct dentry *,
Al Viro30d90492012-06-22 12:40:19 +04001650 struct file *, unsigned open_flag,
Al Virod9585272012-06-22 12:39:14 +04001651 umode_t create_mode, int *opened);
Al Viro60545d02013-06-07 01:20:27 -04001652 int (*tmpfile) (struct inode *, struct dentry *, umode_t);
Christoph Hellwig893d46e2013-12-20 05:16:39 -08001653 int (*set_acl)(struct inode *, struct posix_acl *, int);
Miklos Szeredi4aa7c632014-10-24 00:14:35 +02001654
1655 /* WARNING: probably going away soon, do not use! */
1656 int (*dentry_open)(struct dentry *, struct file *, const struct cred *);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001657} ____cacheline_aligned;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001659ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvector,
Christopher Yeohfcf63402011-10-31 17:06:39 -07001660 unsigned long nr_segs, unsigned long fast_segs,
1661 struct iovec *fast_pointer,
Christopher Yeohac34ebb2012-05-31 16:26:42 -07001662 struct iovec **ret_pointer);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001663
Dmitry Kasatkin6fb50322014-11-05 17:01:17 +02001664extern ssize_t __vfs_read(struct file *, char __user *, size_t, loff_t *);
Al Viro493c84c2015-04-03 15:06:43 -04001665extern ssize_t __vfs_write(struct file *, const char __user *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
1667extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
1668extern ssize_t vfs_readv(struct file *, const struct iovec __user *,
1669 unsigned long, loff_t *);
1670extern ssize_t vfs_writev(struct file *, const struct iovec __user *,
1671 unsigned long, loff_t *);
1672
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673struct super_operations {
1674 struct inode *(*alloc_inode)(struct super_block *sb);
1675 void (*destroy_inode)(struct inode *);
1676
Christoph Hellwigaa385722011-05-27 06:53:02 -04001677 void (*dirty_inode) (struct inode *, int flags);
Christoph Hellwiga9185b42010-03-05 09:21:37 +01001678 int (*write_inode) (struct inode *, struct writeback_control *wbc);
Al Viro45321ac2010-06-07 13:43:19 -04001679 int (*drop_inode) (struct inode *);
Al Virobe7ce412010-06-04 19:40:39 -04001680 void (*evict_inode) (struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681 void (*put_super) (struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682 int (*sync_fs)(struct super_block *sb, int wait);
Benjamin Marzinski48b6bca2014-11-13 20:42:03 -06001683 int (*freeze_super) (struct super_block *);
Takashi Satoc4be0c12009-01-09 16:40:58 -08001684 int (*freeze_fs) (struct super_block *);
Benjamin Marzinski48b6bca2014-11-13 20:42:03 -06001685 int (*thaw_super) (struct super_block *);
Takashi Satoc4be0c12009-01-09 16:40:58 -08001686 int (*unfreeze_fs) (struct super_block *);
David Howells726c3342006-06-23 02:02:58 -07001687 int (*statfs) (struct dentry *, struct kstatfs *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688 int (*remount_fs) (struct super_block *, int *, char *);
Al Viro42faad92008-04-24 07:21:56 -04001689 void (*umount_begin) (struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690
Al Viro34c80b12011-12-08 21:32:45 -05001691 int (*show_options)(struct seq_file *, struct dentry *);
Al Virod861c632011-12-08 21:32:45 -05001692 int (*show_devname)(struct seq_file *, struct dentry *);
Al Viroa6322de2011-12-08 21:37:57 -05001693 int (*show_path)(struct seq_file *, struct dentry *);
Al Viro64132372011-12-08 20:51:13 -05001694 int (*show_stats)(struct seq_file *, struct dentry *);
Alexey Dobriyan0e51a722006-09-29 01:59:56 -07001695#ifdef CONFIG_QUOTA
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696 ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
1697 ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
Jan Kara2d0fa462014-09-25 16:36:14 +02001698 struct dquot **(*get_dquots)(struct inode *);
Alexey Dobriyan0e51a722006-09-29 01:59:56 -07001699#endif
Theodore Ts'o87d8fe12009-01-03 09:47:09 -05001700 int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
Vladimir Davydov4101b622015-02-12 14:58:51 -08001701 long (*nr_cached_objects)(struct super_block *,
1702 struct shrink_control *);
1703 long (*free_cached_objects)(struct super_block *,
1704 struct shrink_control *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705};
1706
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001707/*
David Howellsbbc10962012-10-15 16:40:35 +01001708 * Inode flags - they have no relation to superblock flags now
1709 */
1710#define S_SYNC 1 /* Writes are synced at once */
1711#define S_NOATIME 2 /* Do not update access times */
1712#define S_APPEND 4 /* Append-only file */
1713#define S_IMMUTABLE 8 /* Immutable file */
1714#define S_DEAD 16 /* removed, but still open directory */
1715#define S_NOQUOTA 32 /* Inode is not counted to quota */
1716#define S_DIRSYNC 64 /* Directory modifications are synchronous */
1717#define S_NOCMTIME 128 /* Do not update file c/mtime */
1718#define S_SWAPFILE 256 /* Do not truncate: swapon got its bmaps */
1719#define S_PRIVATE 512 /* Inode is fs-internal */
1720#define S_IMA 1024 /* Inode has an associated IMA struct */
1721#define S_AUTOMOUNT 2048 /* Automount/referral quasi-directory */
1722#define S_NOSEC 4096 /* no suid or xattr security attributes */
Matthew Wilcox6cd176a2015-02-16 15:59:25 -08001723#ifdef CONFIG_FS_DAX
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08001724#define S_DAX 8192 /* Direct Access, avoiding the page cache */
1725#else
1726#define S_DAX 0 /* Make all the DAX code disappear */
1727#endif
David Howellsbbc10962012-10-15 16:40:35 +01001728
1729/*
1730 * Note that nosuid etc flags are inode-specific: setting some file-system
1731 * flags just means all the inodes inherit those flags by default. It might be
1732 * possible to override it selectively if you really wanted to with some
1733 * ioctl() that is not currently implemented.
1734 *
1735 * Exception: MS_RDONLY is always applied to the entire file system.
1736 *
1737 * Unfortunately, it is possible to change a filesystems flags with it mounted
1738 * with files in use. This means that all of the inodes will not have their
1739 * i_flags updated. Hence, i_flags no longer inherit the superblock mount
1740 * flags, so these have to be checked separately. -- rmk@arm.uk.linux.org
1741 */
1742#define __IS_FLG(inode, flg) ((inode)->i_sb->s_flags & (flg))
1743
1744#define IS_RDONLY(inode) ((inode)->i_sb->s_flags & MS_RDONLY)
1745#define IS_SYNC(inode) (__IS_FLG(inode, MS_SYNCHRONOUS) || \
1746 ((inode)->i_flags & S_SYNC))
1747#define IS_DIRSYNC(inode) (__IS_FLG(inode, MS_SYNCHRONOUS|MS_DIRSYNC) || \
1748 ((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
1749#define IS_MANDLOCK(inode) __IS_FLG(inode, MS_MANDLOCK)
1750#define IS_NOATIME(inode) __IS_FLG(inode, MS_RDONLY|MS_NOATIME)
1751#define IS_I_VERSION(inode) __IS_FLG(inode, MS_I_VERSION)
1752
1753#define IS_NOQUOTA(inode) ((inode)->i_flags & S_NOQUOTA)
1754#define IS_APPEND(inode) ((inode)->i_flags & S_APPEND)
1755#define IS_IMMUTABLE(inode) ((inode)->i_flags & S_IMMUTABLE)
1756#define IS_POSIXACL(inode) __IS_FLG(inode, MS_POSIXACL)
1757
1758#define IS_DEADDIR(inode) ((inode)->i_flags & S_DEAD)
1759#define IS_NOCMTIME(inode) ((inode)->i_flags & S_NOCMTIME)
1760#define IS_SWAPFILE(inode) ((inode)->i_flags & S_SWAPFILE)
1761#define IS_PRIVATE(inode) ((inode)->i_flags & S_PRIVATE)
1762#define IS_IMA(inode) ((inode)->i_flags & S_IMA)
1763#define IS_AUTOMOUNT(inode) ((inode)->i_flags & S_AUTOMOUNT)
1764#define IS_NOSEC(inode) ((inode)->i_flags & S_NOSEC)
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08001765#define IS_DAX(inode) ((inode)->i_flags & S_DAX)
David Howellsbbc10962012-10-15 16:40:35 +01001766
Miklos Szeredi787fb6b2014-10-24 00:14:36 +02001767#define IS_WHITEOUT(inode) (S_ISCHR(inode->i_mode) && \
1768 (inode)->i_rdev == WHITEOUT_DEV)
1769
David Howellsbbc10962012-10-15 16:40:35 +01001770/*
Dave Chinner250df6e2011-03-22 22:23:36 +11001771 * Inode state bits. Protected by inode->i_lock
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001772 *
1773 * Three bits determine the dirty state of the inode, I_DIRTY_SYNC,
1774 * I_DIRTY_DATASYNC and I_DIRTY_PAGES.
1775 *
1776 * Four bits define the lifetime of an inode. Initially, inodes are I_NEW,
1777 * until that flag is cleared. I_WILL_FREE, I_FREEING and I_CLEAR are set at
1778 * various stages of removing an inode.
1779 *
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001780 * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001781 *
Joern Engele7ca2d42008-02-06 01:36:59 -08001782 * I_DIRTY_SYNC Inode is dirty, but doesn't have to be written on
1783 * fdatasync(). i_atime is the usual cause.
Jan Kara000cb482008-02-14 19:31:32 -08001784 * I_DIRTY_DATASYNC Data-related inode changes pending. We keep track of
1785 * these changes separately from I_DIRTY_SYNC so that we
1786 * don't have to write inode on fdatasync() when only
1787 * mtime has changed in it.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001788 * I_DIRTY_PAGES Inode has dirty pages. Inode itself may be clean.
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001789 * I_NEW Serves as both a mutex and completion notification.
1790 * New inodes set I_NEW. If two processes both create
1791 * the same inode, one of them will release its inode and
1792 * wait for I_NEW to be released before returning.
1793 * Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can
1794 * also cause waiting on I_NEW, without I_NEW actually
1795 * being set. find_inode() uses this to prevent returning
1796 * nearly-dead inodes.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001797 * I_WILL_FREE Must be set when calling write_inode_now() if i_count
1798 * is zero. I_FREEING must be set when I_WILL_FREE is
1799 * cleared.
1800 * I_FREEING Set when inode is about to be freed but still has dirty
1801 * pages or buffers attached or the inode itself is still
1802 * dirty.
Jan Karadbd57682012-05-03 14:48:02 +02001803 * I_CLEAR Added by clear_inode(). In this state the inode is
1804 * clean and can be destroyed. Inode keeps I_FREEING.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001805 *
1806 * Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are
1807 * prohibited for many purposes. iget() must wait for
1808 * the inode to be completely released, then create it
1809 * anew. Other functions will just ignore such inodes,
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001810 * if appropriate. I_NEW is used for waiting.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001811 *
Jan Kara169ebd92012-05-03 14:48:03 +02001812 * I_SYNC Writeback of inode is running. The bit is set during
1813 * data writeback, and cleared with a wakeup on the bit
1814 * address once it is done. The bit is also used to pin
1815 * the inode in memory for flusher thread.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001816 *
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -04001817 * I_REFERENCED Marks the inode as recently references on the LRU list.
1818 *
1819 * I_DIO_WAKEUP Never set. Only used as a key for wait_on_bit().
1820 *
Tejun Heo682aa8e2015-05-28 14:50:53 -04001821 * I_WB_SWITCH Cgroup bdi_writeback switching in progress. Used to
1822 * synchronize competing switching instances and to tell
1823 * wb stat updates to grab mapping->tree_lock. See
1824 * inode_switch_wb_work_fn() for details.
1825 *
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001826 * Q: What is the difference between I_WILL_FREE and I_FREEING?
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001827 */
Nick Piggin9e38d862010-10-23 06:55:17 -04001828#define I_DIRTY_SYNC (1 << 0)
1829#define I_DIRTY_DATASYNC (1 << 1)
1830#define I_DIRTY_PAGES (1 << 2)
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001831#define __I_NEW 3
1832#define I_NEW (1 << __I_NEW)
Nick Piggin9e38d862010-10-23 06:55:17 -04001833#define I_WILL_FREE (1 << 4)
1834#define I_FREEING (1 << 5)
1835#define I_CLEAR (1 << 6)
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001836#define __I_SYNC 7
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001837#define I_SYNC (1 << __I_SYNC)
Nick Piggin9e38d862010-10-23 06:55:17 -04001838#define I_REFERENCED (1 << 8)
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -04001839#define __I_DIO_WAKEUP 9
Eric Sandeenac74d8d2015-04-16 15:04:56 -05001840#define I_DIO_WAKEUP (1 << __I_DIO_WAKEUP)
Al Virof4e0c302013-06-11 08:34:36 +04001841#define I_LINKABLE (1 << 10)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001842#define I_DIRTY_TIME (1 << 11)
1843#define __I_DIRTY_TIME_EXPIRED 12
1844#define I_DIRTY_TIME_EXPIRED (1 << __I_DIRTY_TIME_EXPIRED)
Tejun Heo682aa8e2015-05-28 14:50:53 -04001845#define I_WB_SWITCH (1 << 13)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001846
1847#define I_DIRTY (I_DIRTY_SYNC | I_DIRTY_DATASYNC | I_DIRTY_PAGES)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001848#define I_DIRTY_ALL (I_DIRTY | I_DIRTY_TIME)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001849
1850extern void __mark_inode_dirty(struct inode *, int);
1851static inline void mark_inode_dirty(struct inode *inode)
1852{
1853 __mark_inode_dirty(inode, I_DIRTY);
1854}
1855
1856static inline void mark_inode_dirty_sync(struct inode *inode)
1857{
1858 __mark_inode_dirty(inode, I_DIRTY_SYNC);
1859}
1860
Miklos Szeredi7ada4db2011-11-21 12:11:32 +01001861extern void inc_nlink(struct inode *inode);
1862extern void drop_nlink(struct inode *inode);
1863extern void clear_nlink(struct inode *inode);
1864extern void set_nlink(struct inode *inode, unsigned int nlink);
Dave Hansend8c76e62006-09-30 23:29:04 -07001865
1866static inline void inode_inc_link_count(struct inode *inode)
1867{
1868 inc_nlink(inode);
Alexey Dobriyan66d21732006-03-23 03:00:51 -08001869 mark_inode_dirty(inode);
1870}
1871
Dave Hansen9a53c3a2006-09-30 23:29:03 -07001872static inline void inode_dec_link_count(struct inode *inode)
1873{
1874 drop_nlink(inode);
Alexey Dobriyan66d21732006-03-23 03:00:51 -08001875 mark_inode_dirty(inode);
1876}
1877
Jean Noel Cordenner25ec56b2008-01-28 23:58:27 -05001878/**
1879 * inode_inc_iversion - increments i_version
1880 * @inode: inode that need to be updated
1881 *
1882 * Every time the inode is modified, the i_version field will be incremented.
1883 * The filesystem has to be mounted with i_version flag
1884 */
1885
1886static inline void inode_inc_iversion(struct inode *inode)
1887{
1888 spin_lock(&inode->i_lock);
1889 inode->i_version++;
1890 spin_unlock(&inode->i_lock);
1891}
1892
Josef Bacikc3b2da32012-03-26 09:59:21 -04001893enum file_time_flags {
1894 S_ATIME = 1,
1895 S_MTIME = 2,
1896 S_CTIME = 4,
1897 S_VERSION = 8,
1898};
1899
Al Virobadcf2b2013-07-16 18:15:46 +04001900extern void touch_atime(const struct path *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001901static inline void file_accessed(struct file *file)
1902{
1903 if (!(file->f_flags & O_NOATIME))
Al Viro68ac1232012-03-15 08:21:57 -04001904 touch_atime(&file->f_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905}
1906
1907int sync_inode(struct inode *inode, struct writeback_control *wbc);
Christoph Hellwigc37650162010-10-06 10:48:20 +02001908int sync_inode_metadata(struct inode *inode, int wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909
Linus Torvalds1da177e2005-04-16 15:20:36 -07001910struct file_system_type {
1911 const char *name;
1912 int fs_flags;
David Howellsbbc10962012-10-15 16:40:35 +01001913#define FS_REQUIRES_DEV 1
1914#define FS_BINARY_MOUNTDATA 2
1915#define FS_HAS_SUBTYPE 4
Eric W. Biederman0c55cfc2012-07-26 21:42:03 -07001916#define FS_USERNS_MOUNT 8 /* Can be mounted by userns root */
1917#define FS_USERNS_DEV_MOUNT 16 /* A userns mount does not imply MNT_NODEV */
David Howellsbbc10962012-10-15 16:40:35 +01001918#define FS_RENAME_DOES_D_MOVE 32768 /* FS will handle d_move() during rename() internally. */
Al Viroc96e41e2010-07-25 00:17:56 +04001919 struct dentry *(*mount) (struct file_system_type *, int,
1920 const char *, void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921 void (*kill_sb) (struct super_block *);
1922 struct module *owner;
1923 struct file_system_type * next;
Al Viroa5166162011-12-12 22:53:00 -05001924 struct hlist_head fs_supers;
Peter Zijlstrad475fd42007-10-15 14:51:31 +02001925
Ingo Molnarcf516242006-07-03 00:25:27 -07001926 struct lock_class_key s_lock_key;
Arjan van de Ven897c6ff2006-07-03 00:25:28 -07001927 struct lock_class_key s_umount_key;
Roland Dreier51ee0492010-04-27 14:23:57 -07001928 struct lock_class_key s_vfs_rename_key;
Jan Kara5accdf82012-06-12 16:20:34 +02001929 struct lock_class_key s_writers_key[SB_FREEZE_LEVELS];
Peter Zijlstrad475fd42007-10-15 14:51:31 +02001930
1931 struct lock_class_key i_lock_key;
1932 struct lock_class_key i_mutex_key;
Peter Zijlstra14358e62007-10-14 01:38:33 +02001933 struct lock_class_key i_mutex_dir_key;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001934};
1935
Eric W. Biederman7f78e032013-03-02 19:39:14 -08001936#define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME)
1937
Al Viroceefda62010-07-26 13:16:50 +04001938extern struct dentry *mount_ns(struct file_system_type *fs_type, int flags,
1939 void *data, int (*fill_super)(struct super_block *, void *, int));
Al Viro152a0832010-07-25 00:46:55 +04001940extern struct dentry *mount_bdev(struct file_system_type *fs_type,
1941 int flags, const char *dev_name, void *data,
1942 int (*fill_super)(struct super_block *, void *, int));
Al Virofc14f2f2010-07-25 01:48:30 +04001943extern struct dentry *mount_single(struct file_system_type *fs_type,
1944 int flags, void *data,
1945 int (*fill_super)(struct super_block *, void *, int));
Al Viro3c26ff62010-07-25 11:46:36 +04001946extern struct dentry *mount_nodev(struct file_system_type *fs_type,
1947 int flags, void *data,
1948 int (*fill_super)(struct super_block *, void *, int));
Al Viroea441d12011-11-16 21:43:59 -05001949extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950void generic_shutdown_super(struct super_block *sb);
1951void kill_block_super(struct super_block *sb);
1952void kill_anon_super(struct super_block *sb);
1953void kill_litter_super(struct super_block *sb);
1954void deactivate_super(struct super_block *sb);
Al Viro74dbbdd2009-05-06 01:07:50 -04001955void deactivate_locked_super(struct super_block *sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956int set_anon_super(struct super_block *s, void *data);
Al Viro0ee5dc62011-07-07 15:44:25 -04001957int get_anon_bdev(dev_t *);
1958void free_anon_bdev(dev_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001959struct super_block *sget(struct file_system_type *type,
1960 int (*test)(struct super_block *,void *),
1961 int (*set)(struct super_block *,void *),
David Howells9249e172012-06-25 12:55:37 +01001962 int flags, void *data);
Al Viro51139ad2010-07-25 23:47:46 +04001963extern struct dentry *mount_pseudo(struct file_system_type *, char *,
Al Viroc74a1cb2011-01-12 16:59:34 -05001964 const struct super_operations *ops,
1965 const struct dentry_operations *dops,
1966 unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967
1968/* Alas, no aliases. Too much hassle with bringing module.h everywhere */
1969#define fops_get(fops) \
1970 (((fops) && try_module_get((fops)->owner) ? (fops) : NULL))
1971#define fops_put(fops) \
1972 do { if (fops) module_put((fops)->owner); } while(0)
Al Viroe84f9e52013-09-22 14:17:15 -04001973/*
1974 * This one is to be used *ONLY* from ->open() instances.
1975 * fops must be non-NULL, pinned down *and* module dependencies
1976 * should be sufficient to pin the caller down as well.
1977 */
1978#define replace_fops(f, fops) \
1979 do { \
1980 struct file *__file = (f); \
1981 fops_put(__file->f_op); \
1982 BUG_ON(!(__file->f_op = (fops))); \
1983 } while(0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984
1985extern int register_filesystem(struct file_system_type *);
1986extern int unregister_filesystem(struct file_system_type *);
Pavel Emelyanov8bf97252007-10-18 23:40:02 -07001987extern struct vfsmount *kern_mount_data(struct file_system_type *, void *data);
1988#define kern_mount(type) kern_mount_data(type, NULL)
Tim Chen423e0ab2011-07-19 09:32:38 -07001989extern void kern_unmount(struct vfsmount *mnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001990extern int may_umount_tree(struct vfsmount *);
1991extern int may_umount(struct vfsmount *);
Seunghun Lee5e6123f2014-09-14 22:15:10 +09001992extern long do_mount(const char *, const char __user *,
1993 const char *, unsigned long, void *);
Al Viro589ff872009-04-18 03:28:19 -04001994extern struct vfsmount *collect_mounts(struct path *);
Al Viro8aec0802007-06-07 12:20:32 -04001995extern void drop_collected_mounts(struct vfsmount *);
Al Viro1f707132010-01-30 22:51:25 -05001996extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
1997 struct vfsmount *);
Christoph Hellwigebabe9a2010-07-07 18:53:11 +02001998extern int vfs_statfs(struct path *, struct kstatfs *);
Al Viroc8b91ac2011-03-12 10:41:39 -05001999extern int user_statfs(const char __user *, struct kstatfs *);
2000extern int fd_statfs(int, struct kstatfs *);
Al Virocf31e702012-01-02 22:28:36 -05002001extern int vfs_ustat(dev_t, struct kstatfs *);
Josef Bacik18e9e512010-03-23 10:34:56 -04002002extern int freeze_super(struct super_block *super);
2003extern int thaw_super(struct super_block *super);
Al Viro02125a82011-12-05 08:43:34 -05002004extern bool our_mnt(struct vfsmount *mnt);
Eric W. Biedermane51db732013-03-30 19:57:41 -07002005extern bool fs_fully_visible(struct file_system_type *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006
Al Viroce3b0f82009-03-29 19:08:22 -04002007extern int current_umask(void);
2008
J. Bruce Fields5a146962012-08-28 07:50:40 -07002009extern void ihold(struct inode * inode);
2010extern void iput(struct inode *);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05002011extern int generic_update_time(struct inode *, struct timespec *, int);
J. Bruce Fields5a146962012-08-28 07:50:40 -07002012
Al Viro1fa97e82014-05-07 20:47:49 -04002013static inline struct inode *file_inode(const struct file *f)
Jeff Laytond7a06982014-03-10 09:54:15 -04002014{
2015 return f->f_inode;
2016}
2017
Miklos Szeredif87fd4c2006-01-16 22:14:23 -08002018/* /sys/fs */
Greg Kroah-Hartman00d26662007-10-29 14:17:23 -06002019extern struct kobject *fs_kobj;
Miklos Szeredif87fd4c2006-01-16 22:14:23 -08002020
Linus Torvalds435f49a2010-10-29 10:36:49 -07002021#define MAX_RW_COUNT (INT_MAX & PAGE_CACHE_MASK)
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002022
Linus Torvalds1da177e2005-04-16 15:20:36 -07002023#define FLOCK_VERIFY_READ 1
2024#define FLOCK_VERIFY_WRITE 2
2025
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002026#ifdef CONFIG_FILE_LOCKING
Jeff Laytond7a06982014-03-10 09:54:15 -04002027extern int locks_mandatory_locked(struct file *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002028extern int locks_mandatory_area(int, struct inode *, struct file *, loff_t, size_t);
2029
2030/*
2031 * Candidates for mandatory locking have the setgid bit set
2032 * but no group execute bit - an otherwise meaningless combination.
2033 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002034
2035static inline int __mandatory_lock(struct inode *ino)
2036{
2037 return (ino->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID;
2038}
2039
2040/*
2041 * ... and these candidates should be on MS_MANDLOCK mounted fs,
2042 * otherwise these will be advisory locks
2043 */
2044
2045static inline int mandatory_lock(struct inode *ino)
2046{
2047 return IS_MANDLOCK(ino) && __mandatory_lock(ino);
2048}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049
Jeff Laytond7a06982014-03-10 09:54:15 -04002050static inline int locks_verify_locked(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051{
Jeff Laytond7a06982014-03-10 09:54:15 -04002052 if (mandatory_lock(file_inode(file)))
2053 return locks_mandatory_locked(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054 return 0;
2055}
2056
Linus Torvalds1da177e2005-04-16 15:20:36 -07002057static inline int locks_verify_truncate(struct inode *inode,
2058 struct file *filp,
2059 loff_t size)
2060{
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05002061 if (inode->i_flctx && mandatory_lock(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002062 return locks_mandatory_area(
2063 FLOCK_VERIFY_WRITE, inode, filp,
2064 size < inode->i_size ? size : inode->i_size,
2065 (size < inode->i_size ? inode->i_size - size
2066 : size - inode->i_size)
2067 );
2068 return 0;
2069}
2070
2071static inline int break_lease(struct inode *inode, unsigned int mode)
2072{
Jeff Layton24cbe782014-02-03 12:13:06 -05002073 /*
2074 * Since this check is lockless, we must ensure that any refcounts
Jeff Layton8116bf42015-01-21 20:44:01 -05002075 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2076 * could end up racing with tasks trying to set a new lease on this
2077 * file.
Jeff Layton24cbe782014-02-03 12:13:06 -05002078 */
2079 smp_mb();
Jeff Layton8634b512015-01-16 15:05:55 -05002080 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002081 return __break_lease(inode, mode, FL_LEASE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002082 return 0;
2083}
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002084
2085static inline int break_deleg(struct inode *inode, unsigned int mode)
2086{
Jeff Layton962bd402014-06-10 12:24:40 -04002087 /*
2088 * Since this check is lockless, we must ensure that any refcounts
Jeff Layton8116bf42015-01-21 20:44:01 -05002089 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2090 * could end up racing with tasks trying to set a new lease on this
2091 * file.
Jeff Layton962bd402014-06-10 12:24:40 -04002092 */
2093 smp_mb();
Jeff Layton8634b512015-01-16 15:05:55 -05002094 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002095 return __break_lease(inode, mode, FL_DELEG);
2096 return 0;
2097}
2098
J. Bruce Fields5a146962012-08-28 07:50:40 -07002099static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2100{
2101 int ret;
2102
2103 ret = break_deleg(inode, O_WRONLY|O_NONBLOCK);
2104 if (ret == -EWOULDBLOCK && delegated_inode) {
2105 *delegated_inode = inode;
2106 ihold(inode);
2107 }
2108 return ret;
2109}
2110
2111static inline int break_deleg_wait(struct inode **delegated_inode)
2112{
2113 int ret;
2114
2115 ret = break_deleg(*delegated_inode, O_WRONLY);
2116 iput(*delegated_inode);
2117 *delegated_inode = NULL;
2118 return ret;
2119}
2120
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01002121static inline int break_layout(struct inode *inode, bool wait)
2122{
2123 smp_mb();
2124 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2125 return __break_lease(inode,
2126 wait ? O_WRONLY : O_WRONLY | O_NONBLOCK,
2127 FL_LAYOUT);
2128 return 0;
2129}
2130
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002131#else /* !CONFIG_FILE_LOCKING */
Jeff Laytond7a06982014-03-10 09:54:15 -04002132static inline int locks_mandatory_locked(struct file *file)
Steven Whitehouseaf5df562009-01-20 10:29:46 +00002133{
2134 return 0;
2135}
2136
2137static inline int locks_mandatory_area(int rw, struct inode *inode,
2138 struct file *filp, loff_t offset,
2139 size_t count)
2140{
2141 return 0;
2142}
2143
2144static inline int __mandatory_lock(struct inode *inode)
2145{
2146 return 0;
2147}
2148
2149static inline int mandatory_lock(struct inode *inode)
2150{
2151 return 0;
2152}
2153
Jeff Laytond7a06982014-03-10 09:54:15 -04002154static inline int locks_verify_locked(struct file *file)
Steven Whitehouseaf5df562009-01-20 10:29:46 +00002155{
2156 return 0;
2157}
2158
2159static inline int locks_verify_truncate(struct inode *inode, struct file *filp,
2160 size_t size)
2161{
2162 return 0;
2163}
2164
2165static inline int break_lease(struct inode *inode, unsigned int mode)
2166{
2167 return 0;
2168}
2169
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002170static inline int break_deleg(struct inode *inode, unsigned int mode)
2171{
2172 return 0;
2173}
J. Bruce Fields5a146962012-08-28 07:50:40 -07002174
2175static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2176{
2177 return 0;
2178}
2179
2180static inline int break_deleg_wait(struct inode **delegated_inode)
2181{
2182 BUG();
2183 return 0;
2184}
2185
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01002186static inline int break_layout(struct inode *inode, bool wait)
2187{
2188 return 0;
2189}
2190
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002191#endif /* CONFIG_FILE_LOCKING */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192
2193/* fs/open.c */
Jeff Laytonadb5c242012-10-10 16:43:13 -04002194struct audit_names;
Jeff Layton91a27b22012-10-10 15:25:28 -04002195struct filename {
Jeff Laytonadb5c242012-10-10 16:43:13 -04002196 const char *name; /* pointer to actual string */
2197 const __user char *uptr; /* original userland pointer */
2198 struct audit_names *aname;
Paul Moore55422d02015-01-22 00:00:23 -05002199 int refcnt;
Al Virofd2f7cb2015-02-22 20:07:13 -05002200 const char iname[];
Jeff Layton91a27b22012-10-10 15:25:28 -04002201};
Linus Torvalds1da177e2005-04-16 15:20:36 -07002202
David Howellsa02de962012-12-20 21:52:36 +00002203extern long vfs_truncate(struct path *, loff_t);
NeilBrown4a301312006-01-08 01:02:39 -08002204extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
2205 struct file *filp);
Anna Schumaker72c72bd2014-11-07 14:44:25 -05002206extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
Ankit Jain3e63cbb2009-06-19 14:28:07 -04002207 loff_t len);
Jason Uhlenkott8e8a1402007-10-20 03:16:18 +02002208extern long do_sys_open(int dfd, const char __user *filename, int flags,
Al Viroa218d0f2011-11-21 14:59:34 -05002209 umode_t mode);
Jeff Layton669abf42012-10-10 16:43:10 -04002210extern struct file *file_open_name(struct filename *, int, umode_t);
Al Viroa218d0f2011-11-21 14:59:34 -05002211extern struct file *filp_open(const char *, int, umode_t);
Al Viro73d049a2011-03-11 12:08:24 -05002212extern struct file *file_open_root(struct dentry *, struct vfsmount *,
2213 const char *, int);
Miklos Szeredi4aa7c632014-10-24 00:14:35 +02002214extern int vfs_open(const struct path *, struct file *, const struct cred *);
Al Viro765927b2012-06-26 21:58:53 +04002215extern struct file * dentry_open(const struct path *, int, const struct cred *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216extern int filp_close(struct file *, fl_owner_t id);
Jeff Layton91a27b22012-10-10 15:25:28 -04002217
David Drysdale51f39a12014-12-12 16:57:29 -08002218extern struct filename *getname_flags(const char __user *, int, int *);
Jeff Layton91a27b22012-10-10 15:25:28 -04002219extern struct filename *getname(const char __user *);
Linus Torvaldsc4ad8f92014-02-05 12:54:53 -08002220extern struct filename *getname_kernel(const char *);
Paul Moore55422d02015-01-22 00:00:23 -05002221extern void putname(struct filename *name);
Jeff Layton91a27b22012-10-10 15:25:28 -04002222
Al Viro47237682012-06-10 05:01:45 -04002223enum {
2224 FILE_CREATED = 1,
2225 FILE_OPENED = 2
2226};
Al Viro30d90492012-06-22 12:40:19 +04002227extern int finish_open(struct file *file, struct dentry *dentry,
2228 int (*open)(struct inode *, struct file *),
2229 int *opened);
Al Viroe45198a2012-06-10 06:48:09 -04002230extern int finish_no_open(struct file *file, struct dentry *dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002231
Ankit Jain3e63cbb2009-06-19 14:28:07 -04002232/* fs/ioctl.c */
2233
2234extern int ioctl_preallocate(struct file *filp, void __user *argp);
2235
Linus Torvalds1da177e2005-04-16 15:20:36 -07002236/* fs/dcache.c */
2237extern void __init vfs_caches_init_early(void);
2238extern void __init vfs_caches_init(unsigned long);
2239
Christoph Lameterb86c0892006-12-06 20:32:57 -08002240extern struct kmem_cache *names_cachep;
2241
Jeff Laytona608ca22012-10-10 15:25:26 -04002242#define __getname() kmem_cache_alloc(names_cachep, GFP_KERNEL)
Vegard Nossum3446a8a2009-05-16 11:22:14 +02002243#define __putname(name) kmem_cache_free(names_cachep, (void *)(name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002244
David Howells93614012006-09-30 20:45:40 +02002245#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002246extern int register_blkdev(unsigned int, const char *);
Akinobu Mitaf4480242007-07-17 04:03:47 -07002247extern void unregister_blkdev(unsigned int, const char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248extern struct block_device *bdget(dev_t);
Alan Jenkinsdddac6a2009-07-29 21:07:55 +02002249extern struct block_device *bdgrab(struct block_device *bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250extern void bd_set_size(struct block_device *, loff_t size);
2251extern void bd_forget(struct inode *inode);
2252extern void bdput(struct block_device *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002253extern void invalidate_bdev(struct block_device *);
Jan Kara5c0d6b62012-07-03 16:45:31 +02002254extern void iterate_bdevs(void (*)(struct block_device *, void *), void *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002255extern int sync_blockdev(struct block_device *bdev);
Al Viroff01bb42011-09-16 02:31:11 -04002256extern void kill_bdev(struct block_device *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002257extern struct super_block *freeze_bdev(struct block_device *);
Eric Sandeenc2d75432009-03-31 15:23:46 -07002258extern void emergency_thaw_all(void);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002259extern int thaw_bdev(struct block_device *bdev, struct super_block *sb);
2260extern int fsync_bdev(struct block_device *);
Tejun Heoa212b102015-05-22 17:13:33 -04002261
2262extern struct super_block *blockdev_superblock;
2263
2264static inline bool sb_is_blkdev_sb(struct super_block *sb)
2265{
2266 return sb == blockdev_superblock;
2267}
David Howells93614012006-09-30 20:45:40 +02002268#else
2269static inline void bd_forget(struct inode *inode) {}
Al Viro47e44912009-04-01 07:07:16 -04002270static inline int sync_blockdev(struct block_device *bdev) { return 0; }
Al Viroff01bb42011-09-16 02:31:11 -04002271static inline void kill_bdev(struct block_device *bdev) {}
Al Viro47e44912009-04-01 07:07:16 -04002272static inline void invalidate_bdev(struct block_device *bdev) {}
2273
2274static inline struct super_block *freeze_bdev(struct block_device *sb)
2275{
2276 return NULL;
2277}
2278
2279static inline int thaw_bdev(struct block_device *bdev, struct super_block *sb)
2280{
2281 return 0;
2282}
Jan Kara5c0d6b62012-07-03 16:45:31 +02002283
2284static inline void iterate_bdevs(void (*f)(struct block_device *, void *), void *arg)
2285{
2286}
Jan Karaa8855992013-07-09 22:36:45 +08002287
2288static inline int sb_is_blkdev_sb(struct super_block *sb)
2289{
2290 return 0;
2291}
David Howells93614012006-09-30 20:45:40 +02002292#endif
Jan Kara60b06802009-04-27 16:43:53 +02002293extern int sync_filesystem(struct super_block *);
David Howells93614012006-09-30 20:45:40 +02002294extern const struct file_operations def_blk_fops;
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08002295extern const struct file_operations def_chr_fops;
David Howells93614012006-09-30 20:45:40 +02002296#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002297extern int ioctl_by_bdev(struct block_device *, unsigned, unsigned long);
Al Viro56b26ad2008-09-19 03:17:36 -04002298extern int blkdev_ioctl(struct block_device *, fmode_t, unsigned, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002299extern long compat_blkdev_ioctl(struct file *, unsigned, unsigned long);
Tejun Heoe525fd82010-11-13 11:55:17 +01002300extern int blkdev_get(struct block_device *bdev, fmode_t mode, void *holder);
Tejun Heod4d77622010-11-13 11:55:18 +01002301extern struct block_device *blkdev_get_by_path(const char *path, fmode_t mode,
2302 void *holder);
2303extern struct block_device *blkdev_get_by_dev(dev_t dev, fmode_t mode,
2304 void *holder);
Al Viro4385bab2013-05-05 22:11:03 -04002305extern void blkdev_put(struct block_device *bdev, fmode_t mode);
Jarod Wilsonbe324172015-05-06 12:26:22 +08002306extern int __blkdev_reread_part(struct block_device *bdev);
2307extern int blkdev_reread_part(struct block_device *bdev);
2308
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002309#ifdef CONFIG_SYSFS
Tejun Heoe09b4572010-11-13 11:55:17 +01002310extern int bd_link_disk_holder(struct block_device *bdev, struct gendisk *disk);
Tejun Heo49731ba2011-01-14 18:43:57 +01002311extern void bd_unlink_disk_holder(struct block_device *bdev,
2312 struct gendisk *disk);
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002313#else
Tejun Heoe09b4572010-11-13 11:55:17 +01002314static inline int bd_link_disk_holder(struct block_device *bdev,
2315 struct gendisk *disk)
2316{
2317 return 0;
2318}
Tejun Heo49731ba2011-01-14 18:43:57 +01002319static inline void bd_unlink_disk_holder(struct block_device *bdev,
2320 struct gendisk *disk)
2321{
2322}
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002323#endif
David Howells93614012006-09-30 20:45:40 +02002324#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002325
2326/* fs/char_dev.c */
Joe Korty68eef3b2006-03-31 02:30:32 -08002327#define CHRDEV_MAJOR_HASH_SIZE 255
Linus Torvalds1da177e2005-04-16 15:20:36 -07002328extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
2329extern int register_chrdev_region(dev_t, unsigned, const char *);
Tejun Heo1905b1b2009-08-06 18:13:23 +09002330extern int __register_chrdev(unsigned int major, unsigned int baseminor,
2331 unsigned int count, const char *name,
2332 const struct file_operations *fops);
2333extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
2334 unsigned int count, const char *name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002335extern void unregister_chrdev_region(dev_t, unsigned);
Joe Korty68eef3b2006-03-31 02:30:32 -08002336extern void chrdev_show(struct seq_file *,off_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337
Tejun Heo1905b1b2009-08-06 18:13:23 +09002338static inline int register_chrdev(unsigned int major, const char *name,
2339 const struct file_operations *fops)
2340{
2341 return __register_chrdev(major, 0, 256, name, fops);
2342}
2343
2344static inline void unregister_chrdev(unsigned int major, const char *name)
2345{
2346 __unregister_chrdev(major, 0, 256, name);
2347}
2348
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349/* fs/block_dev.c */
2350#define BDEVNAME_SIZE 32 /* Largest string for a blockdev identifier */
Tejun Heo1f014292008-08-25 19:47:23 +09002351#define BDEVT_SIZE 10 /* Largest string for MAJ:MIN for blkdev */
David Howells93614012006-09-30 20:45:40 +02002352
2353#ifdef CONFIG_BLOCK
2354#define BLKDEV_MAJOR_HASH_SIZE 255
Linus Torvalds1da177e2005-04-16 15:20:36 -07002355extern const char *__bdevname(dev_t, char *buffer);
2356extern const char *bdevname(struct block_device *bdev, char *buffer);
2357extern struct block_device *lookup_bdev(const char *);
Joe Korty68eef3b2006-03-31 02:30:32 -08002358extern void blkdev_show(struct seq_file *,off_t);
Al Viro30c40d22008-02-22 19:50:45 -05002359
David Howells93614012006-09-30 20:45:40 +02002360#else
2361#define BLKDEV_MAJOR_HASH_SIZE 0
2362#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002363
2364extern void init_special_inode(struct inode *, umode_t, dev_t);
2365
2366/* Invalid inode operations -- fs/bad_inode.c */
2367extern void make_bad_inode(struct inode *);
2368extern int is_bad_inode(struct inode *);
2369
David Howells93614012006-09-30 20:45:40 +02002370#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002371/*
2372 * return READ, READA, or WRITE
2373 */
2374#define bio_rw(bio) ((bio)->bi_rw & (RW_MASK | RWA_MASK))
2375
2376/*
2377 * return data direction, READ or WRITE
2378 */
2379#define bio_data_dir(bio) ((bio)->bi_rw & 1)
2380
Andrew Pattersonc3279d12008-09-04 14:27:25 -06002381extern void check_disk_size_change(struct gendisk *disk,
2382 struct block_device *bdev);
Andrew Patterson0c002c22008-09-04 14:27:20 -06002383extern int revalidate_disk(struct gendisk *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002384extern int check_disk_change(struct block_device *);
NeilBrown93b270f2011-02-24 17:25:47 +11002385extern int __invalidate_device(struct block_device *, bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002386extern int invalidate_partition(struct gendisk *, int);
David Howells93614012006-09-30 20:45:40 +02002387#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002388unsigned long invalidate_mapping_pages(struct address_space *mapping,
2389 pgoff_t start, pgoff_t end);
Anton Altaparmakov54bc4852007-02-10 01:45:38 -08002390
Linus Torvalds1da177e2005-04-16 15:20:36 -07002391static inline void invalidate_remote_inode(struct inode *inode)
2392{
2393 if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
2394 S_ISLNK(inode->i_mode))
Andrew Mortonfc0ecff2007-02-10 01:45:39 -08002395 invalidate_mapping_pages(inode->i_mapping, 0, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002396}
2397extern int invalidate_inode_pages2(struct address_space *mapping);
2398extern int invalidate_inode_pages2_range(struct address_space *mapping,
2399 pgoff_t start, pgoff_t end);
2400extern int write_inode_now(struct inode *, int);
2401extern int filemap_fdatawrite(struct address_space *);
2402extern int filemap_flush(struct address_space *);
2403extern int filemap_fdatawait(struct address_space *);
Jan Karad3bccb6f2009-08-17 19:30:27 +02002404extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
2405 loff_t lend);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002406extern int filemap_write_and_wait(struct address_space *mapping);
2407extern int filemap_write_and_wait_range(struct address_space *mapping,
2408 loff_t lstart, loff_t lend);
Andrew Mortonebcf28e2006-03-24 03:18:04 -08002409extern int __filemap_fdatawrite_range(struct address_space *mapping,
2410 loff_t start, loff_t end, int sync_mode);
Jan Karaf4c0a0f2008-07-11 19:27:31 -04002411extern int filemap_fdatawrite_range(struct address_space *mapping,
2412 loff_t start, loff_t end);
Andrew Mortonebcf28e2006-03-24 03:18:04 -08002413
Christoph Hellwig8018ab02010-03-22 17:32:25 +01002414extern int vfs_fsync_range(struct file *file, loff_t start, loff_t end,
2415 int datasync);
2416extern int vfs_fsync(struct file *file, int datasync);
Al Virod311d792014-02-09 15:18:09 -05002417static inline int generic_write_sync(struct file *file, loff_t pos, loff_t count)
2418{
2419 if (!(file->f_flags & O_DSYNC) && !IS_SYNC(file->f_mapping->host))
2420 return 0;
2421 return vfs_fsync_range(file, pos, pos + count - 1,
2422 (file->f_flags & __O_SYNC) ? 0 : 1);
2423}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002424extern void emergency_sync(void);
2425extern void emergency_remount(void);
David Howells93614012006-09-30 20:45:40 +02002426#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002427extern sector_t bmap(struct inode *, sector_t);
David Howells93614012006-09-30 20:45:40 +02002428#endif
J. Bruce Fields27ac0ff2011-09-20 17:19:26 -04002429extern int notify_change(struct dentry *, struct iattr *, struct inode **);
Al Virof419a2e2008-07-22 00:07:17 -04002430extern int inode_permission(struct inode *, int);
Miklos Szeredibd5d0852014-10-24 00:14:35 +02002431extern int __inode_permission(struct inode *, int);
Al Viro2830ba72011-06-20 19:16:29 -04002432extern int generic_permission(struct inode *, int);
Miklos Szeredicbdf35b2014-10-24 00:14:36 +02002433extern int __check_sticky(struct inode *dir, struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002434
Miklos Szeredif696a362008-07-31 13:41:58 +02002435static inline bool execute_ok(struct inode *inode)
2436{
2437 return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
2438}
2439
Al Viro8d71db42013-03-19 21:01:03 -04002440static inline void file_start_write(struct file *file)
2441{
2442 if (!S_ISREG(file_inode(file)->i_mode))
2443 return;
2444 __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, true);
2445}
2446
Jan Kara5ae98f12013-05-04 00:11:23 +02002447static inline bool file_start_write_trylock(struct file *file)
2448{
2449 if (!S_ISREG(file_inode(file)->i_mode))
2450 return true;
2451 return __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, false);
2452}
2453
Al Viro8d71db42013-03-19 21:01:03 -04002454static inline void file_end_write(struct file *file)
2455{
2456 if (!S_ISREG(file_inode(file)->i_mode))
2457 return;
2458 __sb_end_write(file_inode(file)->i_sb, SB_FREEZE_WRITE);
2459}
2460
Al Viro07b8ce12011-06-20 10:52:57 -04002461/*
2462 * get_write_access() gets write permission for a file.
2463 * put_write_access() releases this write permission.
2464 * This is used for regular files.
2465 * We cannot support write (and maybe mmap read-write shared) accesses and
2466 * MAP_DENYWRITE mmappings simultaneously. The i_writecount field of an inode
2467 * can have the following values:
2468 * 0: no writers, no VM_DENYWRITE mappings
2469 * < 0: (-i_writecount) vm_area_structs with VM_DENYWRITE set exist
2470 * > 0: (i_writecount) users are writing to the file.
2471 *
2472 * Normally we operate on that counter with atomic_{inc,dec} and it's safe
2473 * except for the cases where we don't hold i_writecount yet. Then we need to
2474 * use {get,deny}_write_access() - these functions check the sign and refuse
2475 * to do the change if sign is wrong.
2476 */
2477static inline int get_write_access(struct inode *inode)
2478{
2479 return atomic_inc_unless_negative(&inode->i_writecount) ? 0 : -ETXTBSY;
2480}
2481static inline int deny_write_access(struct file *file)
2482{
Al Viro496ad9a2013-01-23 17:07:38 -05002483 struct inode *inode = file_inode(file);
Al Viro07b8ce12011-06-20 10:52:57 -04002484 return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
2485}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002486static inline void put_write_access(struct inode * inode)
2487{
2488 atomic_dec(&inode->i_writecount);
2489}
2490static inline void allow_write_access(struct file *file)
2491{
2492 if (file)
Al Viro496ad9a2013-01-23 17:07:38 -05002493 atomic_inc(&file_inode(file)->i_writecount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002494}
David Howellsf1fe29b2013-09-27 11:20:03 +01002495static inline bool inode_is_open_for_write(const struct inode *inode)
2496{
2497 return atomic_read(&inode->i_writecount) > 0;
2498}
2499
Mimi Zohara5c96eb2010-11-02 10:11:37 -04002500#ifdef CONFIG_IMA
2501static inline void i_readcount_dec(struct inode *inode)
2502{
2503 BUG_ON(!atomic_read(&inode->i_readcount));
2504 atomic_dec(&inode->i_readcount);
2505}
2506static inline void i_readcount_inc(struct inode *inode)
2507{
2508 atomic_inc(&inode->i_readcount);
2509}
2510#else
2511static inline void i_readcount_dec(struct inode *inode)
2512{
2513 return;
2514}
2515static inline void i_readcount_inc(struct inode *inode)
2516{
2517 return;
2518}
2519#endif
Ulrich Dreppered8cae82008-07-23 21:29:30 -07002520extern int do_pipe_flags(int *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002521
Mimi Zohar6777d772009-08-21 14:32:48 -04002522extern int kernel_read(struct file *, loff_t, char *, unsigned long);
Al Viro7bb307e2013-02-23 14:51:48 -05002523extern ssize_t kernel_write(struct file *, const char *, size_t, loff_t);
Al Viroed447242014-04-19 14:37:20 -04002524extern ssize_t __kernel_write(struct file *, const char *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002525extern struct file * open_exec(const char *);
2526
2527/* fs/dcache.c -- generic fs support functions */
2528extern int is_subdir(struct dentry *, struct dentry *);
Al Viro2096f752010-01-30 13:16:21 -05002529extern int path_is_under(struct path *, struct path *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002530
2531#include <linux/err.h>
2532
2533/* needed for stackable file system support */
Andrew Morton965c8e52012-12-17 15:59:39 -08002534extern loff_t default_llseek(struct file *file, loff_t offset, int whence);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002535
Andrew Morton965c8e52012-12-17 15:59:39 -08002536extern loff_t vfs_llseek(struct file *file, loff_t offset, int whence);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002537
Christoph Hellwig54e34622009-08-07 14:38:25 -03002538extern int inode_init_always(struct super_block *, struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002539extern void inode_init_once(struct inode *);
Miklos Szeredi2aa15892011-02-23 13:49:47 +01002540extern void address_space_init_once(struct address_space *mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002541extern struct inode * igrab(struct inode *);
2542extern ino_t iunique(struct super_block *, ino_t);
2543extern int inode_needs_sync(struct inode *inode);
Al Viro45321ac2010-06-07 13:43:19 -04002544extern int generic_delete_inode(struct inode *inode);
Al Viro9bcb4b72012-02-12 19:43:17 -05002545static inline int generic_drop_inode(struct inode *inode)
2546{
2547 return !inode->i_nlink || inode_unhashed(inode);
2548}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002549
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07002550extern struct inode *ilookup5_nowait(struct super_block *sb,
2551 unsigned long hashval, int (*test)(struct inode *, void *),
2552 void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002553extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
2554 int (*test)(struct inode *, void *), void *data);
2555extern struct inode *ilookup(struct super_block *sb, unsigned long ino);
2556
2557extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *);
2558extern struct inode * iget_locked(struct super_block *, unsigned long);
Theodore Ts'ofe032c42015-02-02 00:37:01 -05002559extern struct inode *find_inode_nowait(struct super_block *,
2560 unsigned long,
2561 int (*match)(struct inode *,
2562 unsigned long, void *),
2563 void *data);
Al Viro261bca82008-12-30 01:48:21 -05002564extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
2565extern int insert_inode_locked(struct inode *);
Josh Boyere096d0c2011-08-25 07:48:12 -04002566#ifdef CONFIG_DEBUG_LOCK_ALLOC
2567extern void lockdep_annotate_inode_mutex_key(struct inode *inode);
2568#else
2569static inline void lockdep_annotate_inode_mutex_key(struct inode *inode) { };
2570#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002571extern void unlock_new_inode(struct inode *);
Christoph Hellwig85fe4022010-10-23 11:19:54 -04002572extern unsigned int get_next_ino(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002573
Linus Torvalds1da177e2005-04-16 15:20:36 -07002574extern void __iget(struct inode * inode);
David Howellsb46980f2008-02-07 00:15:27 -08002575extern void iget_failed(struct inode *);
Jan Karadbd57682012-05-03 14:48:02 +02002576extern void clear_inode(struct inode *);
Christoph Hellwig2e00c972009-08-07 14:38:29 -03002577extern void __destroy_inode(struct inode *);
Eric Dumazeta209dfc2011-07-26 11:36:34 +02002578extern struct inode *new_inode_pseudo(struct super_block *sb);
2579extern struct inode *new_inode(struct super_block *sb);
Nick Pigginff0c7d12011-01-07 17:49:50 +11002580extern void free_inode_nonrcu(struct inode *inode);
Jens Axboe01de85e2006-10-17 19:50:36 +02002581extern int should_remove_suid(struct dentry *);
Miklos Szeredi2f1936b2008-06-24 16:50:14 +02002582extern int file_remove_suid(struct file *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002583
2584extern void __insert_inode_hash(struct inode *, unsigned long hashval);
Christoph Hellwig646ec462010-10-23 07:15:32 -04002585static inline void insert_inode_hash(struct inode *inode)
2586{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002587 __insert_inode_hash(inode, inode->i_ino);
2588}
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +02002589
2590extern void __remove_inode_hash(struct inode *);
2591static inline void remove_inode_hash(struct inode *inode)
2592{
2593 if (!inode_unhashed(inode))
2594 __remove_inode_hash(inode);
2595}
2596
Christoph Hellwig646ec462010-10-23 07:15:32 -04002597extern void inode_sb_list_add(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002598
David Howells93614012006-09-30 20:45:40 +02002599#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002600extern void submit_bio(int, struct bio *);
2601extern int bdev_read_only(struct block_device *);
David Howells93614012006-09-30 20:45:40 +02002602#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002603extern int set_blocksize(struct block_device *, int);
2604extern int sb_set_blocksize(struct super_block *, int);
2605extern int sb_min_blocksize(struct super_block *, int);
2606
2607extern int generic_file_mmap(struct file *, struct vm_area_struct *);
2608extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
Al Viro3309dd02015-04-09 12:55:47 -04002609extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *);
Al Viroed978a82014-03-05 22:53:04 -05002610extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
Al Viro81742022014-04-03 03:17:43 -04002611extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
Al Viro81742022014-04-03 03:17:43 -04002612extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
Al Viro0c949332014-03-22 06:51:37 -04002613extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *, loff_t);
Al Viro3b93f912014-02-11 21:34:08 -05002614extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t);
Andrew Morton88e6fae2006-04-11 13:59:36 +02002615
Christoph Hellwigdbe4e192015-01-25 21:11:59 +01002616ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos);
2617ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos);
2618
Christoph Hellwigeef99382009-08-20 17:43:41 +02002619/* fs/block_dev.c */
David Jefferyb2de5252014-09-29 10:21:10 -04002620extern ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to);
Al Viro1456c0a2014-04-03 03:21:50 -04002621extern ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from);
Josef Bacik02c24a82011-07-16 20:44:56 -04002622extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
2623 int datasync);
Al Viroff01bb42011-09-16 02:31:11 -04002624extern void block_sync_page(struct page *page);
Christoph Hellwigeef99382009-08-20 17:43:41 +02002625
Andrew Morton88e6fae2006-04-11 13:59:36 +02002626/* fs/splice.c */
Jens Axboecbb7e572006-04-11 14:57:50 +02002627extern ssize_t generic_file_splice_read(struct file *, loff_t *,
Andrew Morton88e6fae2006-04-11 13:59:36 +02002628 struct pipe_inode_info *, size_t, unsigned int);
Miklos Szeredi68181732009-05-07 15:37:36 +02002629extern ssize_t default_file_splice_read(struct file *, loff_t *,
2630 struct pipe_inode_info *, size_t, unsigned int);
Al Viro8d020762014-04-05 04:27:08 -04002631extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
Jens Axboecbb7e572006-04-11 14:57:50 +02002632 struct file *, loff_t *, size_t, unsigned int);
Andrew Morton88e6fae2006-04-11 13:59:36 +02002633extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
Jens Axboecbb7e572006-04-11 14:57:50 +02002634 struct file *out, loff_t *, size_t len, unsigned int flags);
Miklos Szeredi1c118592014-10-24 00:14:35 +02002635extern long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
2636 loff_t *opos, size_t len, unsigned int flags);
2637
Andrew Morton88e6fae2006-04-11 13:59:36 +02002638
Linus Torvalds1da177e2005-04-16 15:20:36 -07002639extern void
2640file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
Andrew Morton965c8e52012-12-17 15:59:39 -08002641extern loff_t noop_llseek(struct file *file, loff_t offset, int whence);
2642extern loff_t no_llseek(struct file *file, loff_t offset, int whence);
Jie Liu46a1c2c2013-06-25 12:02:13 +08002643extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
Andrew Morton965c8e52012-12-17 15:59:39 -08002644extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
Andi Kleen57604952011-09-15 16:06:50 -07002645extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
Andrew Morton965c8e52012-12-17 15:59:39 -08002646 int whence, loff_t maxsize, loff_t eof);
Al Viro1bf9d142013-06-16 20:27:42 +04002647extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
2648 int whence, loff_t size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002649extern int generic_file_open(struct inode * inode, struct file * filp);
2650extern int nonseekable_open(struct inode * inode, struct file * filp);
2651
Omar Sandovala95cd632015-03-16 04:33:51 -07002652ssize_t dax_do_io(struct kiocb *, struct inode *, struct iov_iter *, loff_t,
2653 get_block_t, dio_iodone_t, int flags);
Matthew Wilcox289c6ae2015-02-16 15:58:59 -08002654int dax_clear_blocks(struct inode *, sector_t block, long size);
Matthew Wilcox25726bc2015-02-16 15:59:35 -08002655int dax_zero_page_range(struct inode *, loff_t from, unsigned len, get_block_t);
Matthew Wilcox4c0ccfe2015-02-16 15:59:06 -08002656int dax_truncate_page(struct inode *, loff_t from, get_block_t);
Matthew Wilcoxf7ca90b2015-02-16 15:59:02 -08002657int dax_fault(struct vm_area_struct *, struct vm_fault *, get_block_t);
Boaz Harrosh0e3b2102015-04-15 16:15:14 -07002658int dax_pfn_mkwrite(struct vm_area_struct *, struct vm_fault *);
Matthew Wilcoxf7ca90b2015-02-16 15:59:02 -08002659#define dax_mkwrite(vma, vmf, gb) dax_fault(vma, vmf, gb)
Matthew Wilcoxd475c632015-02-16 15:58:56 -08002660
David Howells93614012006-09-30 20:45:40 +02002661#ifdef CONFIG_BLOCK
Josef Bacikfacd07b2010-05-23 11:00:55 -04002662typedef void (dio_submit_t)(int rw, struct bio *bio, struct inode *inode,
2663 loff_t file_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002664
2665enum {
Christoph Hellwig1e431f52009-11-03 16:44:53 +01002666 /* need locking between buffered and direct access */
2667 DIO_LOCKING = 0x01,
2668
2669 /* filesystem does not support filling holes */
2670 DIO_SKIP_HOLES = 0x02,
Christoph Hellwig60392572014-02-10 10:27:11 +11002671
2672 /* filesystem can handle aio writes beyond i_size */
2673 DIO_ASYNC_EXTEND = 0x04,
Jens Axboefe0f07d2015-04-15 17:05:48 -06002674
2675 /* inode/fs/bdev does not need truncate protection */
2676 DIO_SKIP_DIO_COUNT = 0x08,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002677};
2678
Christoph Hellwigeafdc7d2010-06-04 11:29:53 +02002679void dio_end_io(struct bio *bio, int error);
npiggin@suse.de7bb46a62010-05-27 01:05:33 +10002680
Omar Sandoval17f8c842015-03-16 04:33:50 -07002681ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode,
2682 struct block_device *bdev, struct iov_iter *iter,
2683 loff_t offset, get_block_t get_block,
2684 dio_iodone_t end_io, dio_submit_t submit_io,
2685 int flags);
Christoph Hellwigeafdc7d2010-06-04 11:29:53 +02002686
Omar Sandoval17f8c842015-03-16 04:33:50 -07002687static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
2688 struct inode *inode,
2689 struct iov_iter *iter, loff_t offset,
2690 get_block_t get_block)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002691{
Omar Sandoval17f8c842015-03-16 04:33:50 -07002692 return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter,
Al Viro31b14032014-03-05 01:33:16 -05002693 offset, get_block, NULL, NULL,
Christoph Hellwig1e431f52009-11-03 16:44:53 +01002694 DIO_LOCKING | DIO_SKIP_HOLES);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002695}
David Howells93614012006-09-30 20:45:40 +02002696#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002697
Trond Myklebust1d59d612012-05-31 12:22:33 -04002698void inode_dio_wait(struct inode *inode);
Jens Axboefe0f07d2015-04-15 17:05:48 -06002699
2700/*
2701 * inode_dio_begin - signal start of a direct I/O requests
2702 * @inode: inode the direct I/O happens on
2703 *
2704 * This is called once we've finished processing a direct I/O request,
2705 * and is used to wake up callers waiting for direct I/O to be quiesced.
2706 */
2707static inline void inode_dio_begin(struct inode *inode)
2708{
2709 atomic_inc(&inode->i_dio_count);
2710}
2711
2712/*
2713 * inode_dio_end - signal finish of a direct I/O requests
2714 * @inode: inode the direct I/O happens on
2715 *
2716 * This is called once we've finished processing a direct I/O request,
2717 * and is used to wake up callers waiting for direct I/O to be quiesced.
2718 */
2719static inline void inode_dio_end(struct inode *inode)
2720{
2721 if (atomic_dec_and_test(&inode->i_dio_count))
2722 wake_up_bit(&inode->i_state, __I_DIO_WAKEUP);
2723}
Trond Myklebust1d59d612012-05-31 12:22:33 -04002724
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002725extern void inode_set_flags(struct inode *inode, unsigned int flags,
2726 unsigned int mask);
2727
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08002728extern const struct file_operations generic_ro_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002729
2730#define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))
2731
Al Viro5d826c82014-03-14 13:42:45 -04002732extern int readlink_copy(char __user *, int, const char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002733extern int page_readlink(struct dentry *, char __user *, int);
Linus Torvaldscc314ee2005-08-19 18:02:56 -07002734extern void *page_follow_link_light(struct dentry *, struct nameidata *);
2735extern void page_put_link(struct dentry *, struct nameidata *, void *);
Kirill Korotaev0adb25d2006-03-11 03:27:13 -08002736extern int __page_symlink(struct inode *inode, const char *symname, int len,
Nick Piggin54566b22009-01-04 12:00:53 -08002737 int nofs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002738extern int page_symlink(struct inode *inode, const char *symname, int len);
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08002739extern const struct inode_operations page_symlink_inode_operations;
Al Viro87dc8002013-09-16 10:30:04 -04002740extern void kfree_put_link(struct dentry *, struct nameidata *, void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002741extern int generic_readlink(struct dentry *, char __user *, int);
2742extern void generic_fillattr(struct inode *, struct kstat *);
J. Bruce Fieldsb7a6ec52013-10-02 17:01:18 -04002743int vfs_getattr_nosec(struct path *path, struct kstat *stat);
Al Viro3dadecc2013-01-24 02:18:08 -05002744extern int vfs_getattr(struct path *, struct kstat *);
Dmitry Monakhovb4627072009-12-14 15:21:12 +03002745void __inode_add_bytes(struct inode *inode, loff_t bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002746void inode_add_bytes(struct inode *inode, loff_t bytes);
Jan Kara1c8924e2013-08-17 09:32:32 -04002747void __inode_sub_bytes(struct inode *inode, loff_t bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002748void inode_sub_bytes(struct inode *inode, loff_t bytes);
2749loff_t inode_get_bytes(struct inode *inode);
2750void inode_set_bytes(struct inode *inode, loff_t bytes);
2751
Al Viro5c0ba4e2013-05-15 13:52:59 -04002752extern int iterate_dir(struct file *, struct dir_context *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002753
David Howellsc7887322010-08-11 11:26:22 +01002754extern int vfs_stat(const char __user *, struct kstat *);
2755extern int vfs_lstat(const char __user *, struct kstat *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002756extern int vfs_fstat(unsigned int, struct kstat *);
David Howellsc7887322010-08-11 11:26:22 +01002757extern int vfs_fstatat(int , const char __user *, struct kstat *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002758
Erez Zadokdeb21db2008-02-07 00:13:25 -08002759extern int do_vfs_ioctl(struct file *filp, unsigned int fd, unsigned int cmd,
2760 unsigned long arg);
Steven Whitehousee9079cc2008-10-14 14:43:29 +01002761extern int __generic_block_fiemap(struct inode *inode,
Josef Bacik3a3076f2010-04-23 12:17:17 -04002762 struct fiemap_extent_info *fieinfo,
2763 loff_t start, loff_t len,
2764 get_block_t *get_block);
Josef Bacik68c9d702008-10-03 17:32:43 -04002765extern int generic_block_fiemap(struct inode *inode,
2766 struct fiemap_extent_info *fieinfo, u64 start,
2767 u64 len, get_block_t *get_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002768
Miklos Szeredic18479f2007-10-18 23:39:11 -07002769extern void get_filesystem(struct file_system_type *fs);
2770extern void put_filesystem(struct file_system_type *fs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002771extern struct file_system_type *get_fs_type(const char *name);
2772extern struct super_block *get_super(struct block_device *);
Jan Kara6b6dc832012-02-10 11:03:00 +01002773extern struct super_block *get_super_thawed(struct block_device *);
Christoph Hellwig45042302009-08-03 23:28:35 +02002774extern struct super_block *get_active_super(struct block_device *bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002775extern void drop_super(struct super_block *sb);
Al Viro01a05b32010-03-23 06:06:58 -04002776extern void iterate_supers(void (*)(struct super_block *, void *), void *);
Al Viro43e15cd2011-06-03 20:16:57 -04002777extern void iterate_supers_type(struct file_system_type *,
2778 void (*)(struct super_block *, void *), void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002779
2780extern int dcache_dir_open(struct inode *, struct file *);
2781extern int dcache_dir_close(struct inode *, struct file *);
2782extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
Al Viro5f99f4e2013-05-15 20:23:06 -04002783extern int dcache_readdir(struct file *, struct dir_context *);
npiggin@suse.de7bb46a62010-05-27 01:05:33 +10002784extern int simple_setattr(struct dentry *, struct iattr *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002785extern int simple_getattr(struct vfsmount *, struct dentry *, struct kstat *);
David Howells726c3342006-06-23 02:02:58 -07002786extern int simple_statfs(struct dentry *, struct kstatfs *);
Stephen Boyd20955e82012-04-05 14:25:09 -07002787extern int simple_open(struct inode *inode, struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002788extern int simple_link(struct dentry *, struct inode *, struct dentry *);
2789extern int simple_unlink(struct inode *, struct dentry *);
2790extern int simple_rmdir(struct inode *, struct dentry *);
2791extern int simple_rename(struct inode *, struct dentry *, struct inode *, struct dentry *);
Josef Bacik02c24a82011-07-16 20:44:56 -04002792extern int noop_fsync(struct file *, loff_t, loff_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002793extern int simple_empty(struct dentry *);
2794extern int simple_readpage(struct file *file, struct page *page);
Nick Pigginafddba42007-10-16 01:25:01 -07002795extern int simple_write_begin(struct file *file, struct address_space *mapping,
2796 loff_t pos, unsigned len, unsigned flags,
2797 struct page **pagep, void **fsdata);
2798extern int simple_write_end(struct file *file, struct address_space *mapping,
2799 loff_t pos, unsigned len, unsigned copied,
2800 struct page *page, void *fsdata);
Al Virob26d4cd2013-10-25 18:47:37 -04002801extern int always_delete_dentry(const struct dentry *);
Al Viro69878432013-10-02 22:35:11 -04002802extern struct inode *alloc_anon_inode(struct super_block *);
Jeff Laytone6f5c782014-08-22 10:40:25 -04002803extern int simple_nosetlease(struct file *, long, struct file_lock **, void **);
Al Virob26d4cd2013-10-25 18:47:37 -04002804extern const struct dentry_operations simple_dentry_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002805
Al Viro00cd8dd2012-06-10 17:13:09 -04002806extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002807extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08002808extern const struct file_operations simple_dir_operations;
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08002809extern const struct inode_operations simple_dir_inode_operations;
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08002810struct tree_descr { char *name; const struct file_operations *ops; int mode; };
Linus Torvalds1da177e2005-04-16 15:20:36 -07002811struct dentry *d_alloc_name(struct dentry *, const char *);
Roberto Sassu7d683a02010-06-03 11:58:28 +02002812extern int simple_fill_super(struct super_block *, unsigned long, struct tree_descr *);
Trond Myklebust1f5ce9e2006-06-09 09:34:16 -04002813extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002814extern void simple_release_fs(struct vfsmount **mount, int *count);
2815
Akinobu Mita93b07112008-06-05 22:46:21 -07002816extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
2817 loff_t *ppos, const void *from, size_t available);
Jiri Slaby6a727b42010-05-01 23:51:22 +02002818extern ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
2819 const void __user *from, size_t count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002820
Fabian Frederickac13a822014-06-04 16:06:27 -07002821extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
Josef Bacik02c24a82011-07-16 20:44:56 -04002822extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
Al Virod5aacad2009-06-07 14:56:44 -04002823
Patrick J. LoPresti30ca22c2010-07-22 15:03:41 -07002824extern int generic_check_addressable(unsigned, u64);
2825
Christoph Lametere965f962006-02-01 03:05:41 -08002826#ifdef CONFIG_MIGRATION
Christoph Lameter2d1db3b2006-06-23 02:03:33 -07002827extern int buffer_migrate_page(struct address_space *,
Mel Gormana6bc32b2012-01-12 17:19:43 -08002828 struct page *, struct page *,
2829 enum migrate_mode);
Christoph Lametere965f962006-02-01 03:05:41 -08002830#else
2831#define buffer_migrate_page NULL
2832#endif
2833
npiggin@suse.de25d9e2d2009-08-21 02:35:05 +10002834extern int inode_change_ok(const struct inode *, struct iattr *);
2835extern int inode_newsize_ok(const struct inode *, loff_t offset);
Christoph Hellwig6a1a90a2010-06-04 11:30:00 +02002836extern void setattr_copy(struct inode *inode, const struct iattr *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002837
Josef Bacikc3b2da32012-03-26 09:59:21 -04002838extern int file_update_time(struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002839
Al Viro34c80b12011-12-08 21:32:45 -05002840extern int generic_show_options(struct seq_file *m, struct dentry *root);
Miklos Szeredib3b304a2008-02-08 04:21:35 -08002841extern void save_mount_options(struct super_block *sb, char *options);
Al Viro2a32ceb2009-05-08 16:05:57 -04002842extern void replace_mount_options(struct super_block *sb, char *options);
Miklos Szeredib3b304a2008-02-08 04:21:35 -08002843
Matthew Wilcoxd475c632015-02-16 15:58:56 -08002844static inline bool io_is_direct(struct file *filp)
2845{
2846 return (filp->f_flags & O_DIRECT) || IS_DAX(file_inode(filp));
2847}
2848
Al Viro2ba48ce2015-04-09 13:52:01 -04002849static inline int iocb_flags(struct file *file)
2850{
2851 int res = 0;
2852 if (file->f_flags & O_APPEND)
2853 res |= IOCB_APPEND;
2854 if (io_is_direct(file))
2855 res |= IOCB_DIRECT;
2856 return res;
2857}
2858
Linus Torvalds1da177e2005-04-16 15:20:36 -07002859static inline ino_t parent_ino(struct dentry *dentry)
2860{
2861 ino_t res;
2862
Nick Pigginb5c84bf2011-01-07 17:49:38 +11002863 /*
2864 * Don't strictly need d_lock here? If the parent ino could change
2865 * then surely we'd have a deeper race in the caller?
2866 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002867 spin_lock(&dentry->d_lock);
2868 res = dentry->d_parent->d_inode->i_ino;
2869 spin_unlock(&dentry->d_lock);
2870 return res;
2871}
2872
Linus Torvalds1da177e2005-04-16 15:20:36 -07002873/* Transaction based IO helpers */
2874
2875/*
2876 * An argresp is stored in an allocated page and holds the
2877 * size of the argument or response, along with its content
2878 */
2879struct simple_transaction_argresp {
2880 ssize_t size;
2881 char data[0];
2882};
2883
2884#define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))
2885
2886char *simple_transaction_get(struct file *file, const char __user *buf,
2887 size_t size);
2888ssize_t simple_transaction_read(struct file *file, char __user *buf,
2889 size_t size, loff_t *pos);
2890int simple_transaction_release(struct inode *inode, struct file *file);
2891
Ingo Molnar76791ab2009-03-25 16:48:35 +01002892void simple_transaction_set(struct file *file, size_t n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002893
Arnd Bergmannacaefc22005-05-18 14:40:59 +02002894/*
2895 * simple attribute files
2896 *
2897 * These attributes behave similar to those in sysfs:
2898 *
2899 * Writing to an attribute immediately sets a value, an open file can be
2900 * written to multiple times.
2901 *
2902 * Reading from an attribute creates a buffer from the value that might get
2903 * read with multiple read calls. When the attribute has been read
2904 * completely, no further read calls are possible until the file is opened
2905 * again.
2906 *
2907 * All attributes contain a text representation of a numeric value
2908 * that are accessed with the get() and set() functions.
2909 */
2910#define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt) \
2911static int __fops ## _open(struct inode *inode, struct file *file) \
2912{ \
2913 __simple_attr_check_format(__fmt, 0ull); \
2914 return simple_attr_open(inode, file, __get, __set, __fmt); \
2915} \
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002916static const struct file_operations __fops = { \
Arnd Bergmannacaefc22005-05-18 14:40:59 +02002917 .owner = THIS_MODULE, \
2918 .open = __fops ## _open, \
Christoph Hellwig74bedc42008-02-08 04:20:28 -08002919 .release = simple_attr_release, \
Arnd Bergmannacaefc22005-05-18 14:40:59 +02002920 .read = simple_attr_read, \
2921 .write = simple_attr_write, \
Arnd Bergmann1ec55842010-08-15 21:50:52 +02002922 .llseek = generic_file_llseek, \
Joe Perches68be3022014-08-06 16:08:45 -07002923}
Arnd Bergmannacaefc22005-05-18 14:40:59 +02002924
Joe Perchesb9075fa2011-10-31 17:11:33 -07002925static inline __printf(1, 2)
2926void __simple_attr_check_format(const char *fmt, ...)
Arnd Bergmannacaefc22005-05-18 14:40:59 +02002927{
2928 /* don't do anything, just let the compiler check the arguments; */
2929}
2930
2931int simple_attr_open(struct inode *inode, struct file *file,
Christoph Hellwig8b88b092008-02-08 04:20:26 -08002932 int (*get)(void *, u64 *), int (*set)(void *, u64),
Arnd Bergmannacaefc22005-05-18 14:40:59 +02002933 const char *fmt);
Christoph Hellwig74bedc42008-02-08 04:20:28 -08002934int simple_attr_release(struct inode *inode, struct file *file);
Arnd Bergmannacaefc22005-05-18 14:40:59 +02002935ssize_t simple_attr_read(struct file *file, char __user *buf,
2936 size_t len, loff_t *ppos);
2937ssize_t simple_attr_write(struct file *file, const char __user *buf,
2938 size_t len, loff_t *ppos);
2939
Alexey Dobriyan4be28542007-10-16 23:26:21 -07002940struct ctl_table;
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07002941int proc_nr_files(struct ctl_table *table, int write,
Adrian Bunk62239ac2007-07-17 04:03:45 -07002942 void __user *buffer, size_t *lenp, loff_t *ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04002943int proc_nr_dentry(struct ctl_table *table, int write,
2944 void __user *buffer, size_t *lenp, loff_t *ppos);
Dave Chinnercffbc8a2010-10-23 05:03:02 -04002945int proc_nr_inodes(struct ctl_table *table, int write,
2946 void __user *buffer, size_t *lenp, loff_t *ppos);
Tetsuo Handa38e23c92009-04-09 20:17:52 +09002947int __init get_filesystem_list(char *buf);
Adrian Bunk62239ac2007-07-17 04:03:45 -07002948
Namhyung Kim3cd90ea2011-02-01 15:52:46 -08002949#define __FMODE_EXEC ((__force int) FMODE_EXEC)
Namhyung Kim1a44bc82011-02-01 15:52:46 -08002950#define __FMODE_NONOTIFY ((__force int) FMODE_NONOTIFY)
2951
Al Viro6d125522009-12-24 06:58:56 -05002952#define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE])
Eric Parisecf081d2009-12-17 21:24:25 -05002953#define OPEN_FMODE(flag) ((__force fmode_t)(((flag + 1) & O_ACCMODE) | \
Namhyung Kim1a44bc82011-02-01 15:52:46 -08002954 (flag & __FMODE_NONOTIFY)))
Al Viro53009902009-12-19 10:15:07 -05002955
Al Viro8d334ac2011-07-24 23:21:59 -04002956static inline int is_sxid(umode_t mode)
Andi Kleen69b45732011-05-28 08:25:51 -07002957{
2958 return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
2959}
2960
Miklos Szeredicbdf35b2014-10-24 00:14:36 +02002961static inline int check_sticky(struct inode *dir, struct inode *inode)
2962{
2963 if (!(dir->i_mode & S_ISVTX))
2964 return 0;
2965
2966 return __check_sticky(dir, inode);
2967}
2968
Andi Kleen69b45732011-05-28 08:25:51 -07002969static inline void inode_has_no_xattr(struct inode *inode)
2970{
Al Viro9e1f1de2011-06-03 18:24:58 -04002971 if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & MS_NOSEC))
Andi Kleen69b45732011-05-28 08:25:51 -07002972 inode->i_flags |= S_NOSEC;
2973}
2974
Al Viroa7400222014-10-21 15:20:42 -04002975static inline bool is_root_inode(struct inode *inode)
2976{
2977 return inode == inode->i_sb->s_root->d_inode;
2978}
2979
Al Viro5f99f4e2013-05-15 20:23:06 -04002980static inline bool dir_emit(struct dir_context *ctx,
2981 const char *name, int namelen,
2982 u64 ino, unsigned type)
2983{
2984 return ctx->actor(ctx, name, namelen, ctx->pos, ino, type) == 0;
2985}
2986static inline bool dir_emit_dot(struct file *file, struct dir_context *ctx)
2987{
2988 return ctx->actor(ctx, ".", 1, ctx->pos,
2989 file->f_path.dentry->d_inode->i_ino, DT_DIR) == 0;
2990}
2991static inline bool dir_emit_dotdot(struct file *file, struct dir_context *ctx)
2992{
2993 return ctx->actor(ctx, "..", 2, ctx->pos,
2994 parent_ino(file->f_path.dentry), DT_DIR) == 0;
2995}
2996static inline bool dir_emit_dots(struct file *file, struct dir_context *ctx)
2997{
2998 if (ctx->pos == 0) {
2999 if (!dir_emit_dot(file, ctx))
3000 return false;
3001 ctx->pos = 1;
3002 }
3003 if (ctx->pos == 1) {
3004 if (!dir_emit_dotdot(file, ctx))
3005 return false;
3006 ctx->pos = 2;
3007 }
3008 return true;
3009}
Al Viro5ded75e2013-05-15 21:02:48 -04003010static inline bool dir_relax(struct inode *inode)
3011{
3012 mutex_unlock(&inode->i_mutex);
3013 mutex_lock(&inode->i_mutex);
3014 return !IS_DEADDIR(inode);
3015}
Al Viro5f99f4e2013-05-15 20:23:06 -04003016
Linus Torvalds1da177e2005-04-16 15:20:36 -07003017#endif /* _LINUX_FS_H */