Merge tag 'tty-4.2-rc4' of git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/tty
[linux-2.6-block.git] / include / linux / fs.h
CommitLineData
1da177e4
LT
1#ifndef _LINUX_FS_H
2#define _LINUX_FS_H
3
1da177e4
LT
4
5#include <linux/linkage.h>
6#include <linux/wait.h>
1da177e4
LT
7#include <linux/kdev_t.h>
8#include <linux/dcache.h>
3f8206d4 9#include <linux/path.h>
1da177e4
LT
10#include <linux/stat.h>
11#include <linux/cache.h>
1da177e4 12#include <linux/list.h>
bc3b14cb 13#include <linux/list_lru.h>
4f5e65a1 14#include <linux/llist.h>
1da177e4 15#include <linux/radix-tree.h>
6b2dbba8 16#include <linux/rbtree.h>
1da177e4 17#include <linux/init.h>
914e2637 18#include <linux/pid.h>
187f1882 19#include <linux/bug.h>
1b1dcc1b 20#include <linux/mutex.h>
c8c06efa 21#include <linux/rwsem.h>
3bd858ab 22#include <linux/capability.h>
6188e10d 23#include <linux/semaphore.h>
c4b929b8 24#include <linux/fiemap.h>
ceb5bdc2 25#include <linux/rculist_bl.h>
07b8ce1e 26#include <linux/atomic.h>
83aeeada 27#include <linux/shrinker.h>
c1aab02d 28#include <linux/migrate_mode.h>
92361636 29#include <linux/uidgid.h>
5accdf82 30#include <linux/lockdep.h>
c2b1ad80 31#include <linux/percpu-rwsem.h>
08cce05c 32#include <linux/blk_types.h>
1da177e4 33
1da177e4 34#include <asm/byteorder.h>
607ca46e 35#include <uapi/linux/fs.h>
1da177e4 36
b83ae6d4 37struct backing_dev_info;
52ebea74 38struct bdi_writeback;
a5694255 39struct export_operations;
a885c8c4 40struct hd_geometry;
1da177e4 41struct iovec;
92198f7e 42struct kiocb;
57cc7215 43struct kobject;
1da177e4
LT
44struct pipe_inode_info;
45struct poll_table_struct;
46struct kstatfs;
47struct vm_area_struct;
48struct vfsmount;
745ca247 49struct cred;
a509bc1a 50struct swap_info_struct;
55985dd7 51struct seq_file;
7b7a8665 52struct workqueue_struct;
3b93f911 53struct iov_iter;
f7ca90b1 54struct vm_fault;
1da177e4 55
74bf17cf 56extern void __init inode_init(void);
1da177e4 57extern void __init inode_init_early(void);
1da177e4
LT
58extern void __init files_init(unsigned long);
59
dded4f4d 60extern struct files_stat_struct files_stat;
518de9b3 61extern unsigned long get_max_files(void);
dded4f4d
JE
62extern int sysctl_nr_open;
63extern struct inodes_stat_t inodes_stat;
64extern int leases_enable, lease_break_time;
800179c9
KC
65extern int sysctl_protected_symlinks;
66extern int sysctl_protected_hardlinks;
dded4f4d 67
1da177e4
LT
68struct buffer_head;
69typedef int (get_block_t)(struct inode *inode, sector_t iblock,
70 struct buffer_head *bh_result, int create);
92198f7e 71typedef void (dio_iodone_t)(struct kiocb *iocb, loff_t offset,
7b7a8665 72 ssize_t bytes, void *private);
e842f290 73typedef void (dax_iodone_t)(struct buffer_head *bh_map, int uptodate);
1da177e4 74
bbc1096a
DH
75#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
9c225f26
LT
131/* File needs atomic accesses to f_pos */
132#define FMODE_ATOMIC_POS ((__force fmode_t)0x8000)
83f936c7
AV
133/* Write access to underlying fs */
134#define FMODE_WRITER ((__force fmode_t)0x10000)
7f7f25e8
AV
135/* 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)
9c225f26 139
bbc1096a 140/* File was opened by fanotify and shouldn't generate fanotify events */
75069f2b 141#define FMODE_NONOTIFY ((__force fmode_t)0x4000000)
bbc1096a
DH
142
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
08cce05c
DH
151/*
152 * 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
08cce05c
DH
199
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
1da177e4
LT
207/*
208 * Attribute flags. These should be or-ed together to figure out what
209 * has been changed!
210 */
9767d749
MS
211#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)
1da177e4 228
787fb6bc
MS
229/*
230 * 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
1da177e4
LT
236/*
237 * 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;
92361636
EB
248 kuid_t ia_uid;
249 kgid_t ia_gid;
1da177e4
LT
250 loff_t ia_size;
251 struct timespec ia_atime;
252 struct timespec ia_mtime;
253 struct timespec ia_ctime;
cc4e69de
MS
254
255 /*
25985edc 256 * Not an attribute, but an auxiliary info for filesystems wanting to
cc4e69de
MS
257 * 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;
1da177e4
LT
261};
262
1da177e4
LT
263/*
264 * Includes for diskquotas.
265 */
266#include <linux/quota.h>
267
69c433ed
MS
268/*
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
994fc28c
ZB
274/**
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
55144768 292 * by readpage().
994fc28c
ZB
293 *
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
afddba49 305#define AOP_FLAG_UNINTERRUPTIBLE 0x0001 /* will not do a short write */
89e10787 306#define AOP_FLAG_CONT_EXPAND 0x0002 /* called from cont_expand */
54566b2c
NP
307#define AOP_FLAG_NOFS 0x0004 /* used by filesystem to direct
308 * helper code (eg buffer layer)
309 * to clear GFP_FS from alloc */
afddba49 310
1da177e4
LT
311/*
312 * oh the beauties of C type declarations.
313 */
314struct page;
315struct address_space;
316struct writeback_control;
1da177e4 317
e2e40f2c 318#define IOCB_EVENTFD (1 << 0)
2ba48ce5
AV
319#define IOCB_APPEND (1 << 1)
320#define IOCB_DIRECT (1 << 2)
e2e40f2c
CH
321
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
2ba48ce5
AV
335static inline int iocb_flags(struct file *file);
336
e2e40f2c
CH
337static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
338{
339 *kiocb = (struct kiocb) {
340 .ki_filp = filp,
2ba48ce5 341 .ki_flags = iocb_flags(filp),
e2e40f2c
CH
342 };
343}
344
8ab22b9a
HH
345/*
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);
2f718ffc 366
1da177e4
LT
367struct address_space_operations {
368 int (*writepage)(struct page *page, struct writeback_control *wbc);
369 int (*readpage)(struct file *, struct page *);
1da177e4
LT
370
371 /* Write back some dirty pages from this mapping. */
372 int (*writepages)(struct address_space *, struct writeback_control *);
373
4741c9fd 374 /* Set a page dirty. Return true if this dirtied it */
1da177e4
LT
375 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
afddba49
NP
380 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
1da177e4
LT
387 /* Unfortunately this kludge is needed for FIBMAP. Don't use it */
388 sector_t (*bmap)(struct address_space *, sector_t);
d47992f8 389 void (*invalidatepage) (struct page *, unsigned int, unsigned int);
27496a8c 390 int (*releasepage) (struct page *, gfp_t);
6072d13c 391 void (*freepage)(struct page *);
22c6186e 392 ssize_t (*direct_IO)(struct kiocb *, struct iov_iter *iter, loff_t offset);
b969c4ab 393 /*
ef277c73
TC
394 * migrate the contents of a page to the specified target. If
395 * migrate_mode is MIGRATE_ASYNC, it must not block.
b969c4ab 396 */
2d1db3b1 397 int (*migratepage) (struct address_space *,
a6bc32b8 398 struct page *, struct page *, enum migrate_mode);
e3db7691 399 int (*launder_page) (struct page *);
c186afb4 400 int (*is_partially_uptodate) (struct page *, unsigned long,
8ab22b9a 401 unsigned long);
b4597226 402 void (*is_dirty_writeback) (struct page *, bool *, bool *);
25718736 403 int (*error_remove_page)(struct address_space *, struct page *);
62c230bc
MG
404
405 /* swapfile support */
a509bc1a
MG
406 int (*swap_activate)(struct swap_info_struct *sis, struct file *file,
407 sector_t *span);
408 void (*swap_deactivate)(struct file *file);
1da177e4
LT
409};
410
7dcda1c9
JA
411extern const struct address_space_operations empty_aops;
412
afddba49
NP
413/*
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
1da177e4
LT
425struct address_space {
426 struct inode *host; /* owner: inode, block_device */
427 struct radix_tree_root page_tree; /* radix tree of all pages */
19fd6231 428 spinlock_t tree_lock; /* and lock protecting it */
4bb5f5d9 429 atomic_t i_mmap_writable;/* count VM_SHARED mappings */
6b2dbba8 430 struct rb_root i_mmap; /* tree of private and shared mappings */
c8c06efa 431 struct rw_semaphore i_mmap_rwsem; /* protect tree, count, list */
08142579 432 /* Protected by tree_lock together with the radix tree */
1da177e4 433 unsigned long nrpages; /* number of total pages */
91b0abe3 434 unsigned long nrshadows; /* number of shadow entries */
1da177e4 435 pgoff_t writeback_index;/* writeback starts here */
f5e54d6e 436 const struct address_space_operations *a_ops; /* methods */
1da177e4 437 unsigned long flags; /* error bits/gfp mask */
1da177e4
LT
438 spinlock_t private_lock; /* for use by the address_space */
439 struct list_head private_list; /* ditto */
252aa6f5 440 void *private_data; /* ditto */
1da177e4
LT
441} __attribute__((aligned(sizeof(long))));
442 /*
443 * On most architectures that alignment is already the case; but
25985edc 444 * must be enforced here for CRIS, to let the least significant bit
1da177e4
LT
445 * of struct page's "mapping" pointer be used for PAGE_MAPPING_ANON.
446 */
87192a2a 447struct request_queue;
1da177e4
LT
448
449struct block_device {
450 dev_t bd_dev; /* not a kdev_t - it's a search key */
f3ccfcda 451 int bd_openers;
1da177e4 452 struct inode * bd_inode; /* will die */
87d8fe1e 453 struct super_block * bd_super;
c039e313 454 struct mutex bd_mutex; /* open/close mutex */
1da177e4 455 struct list_head bd_inodes;
6b4517a7 456 void * bd_claiming;
1da177e4
LT
457 void * bd_holder;
458 int bd_holders;
77ea887e 459 bool bd_write_holder;
641dc636 460#ifdef CONFIG_SYSFS
49731baa 461 struct list_head bd_holder_disks;
641dc636 462#endif
1da177e4
LT
463 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;
87192a2a 470 struct request_queue * bd_queue;
1da177e4 471 struct list_head bd_list;
1da177e4
LT
472 /*
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;
fcccf502
TS
479
480 /* The counter of freeze processes */
481 int bd_fsfreeze_count;
482 /* Mutex for freeze */
483 struct mutex bd_fsfreeze_mutex;
1da177e4
LT
484};
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
f446daae 492#define PAGECACHE_TAG_TOWRITE 2
1da177e4
LT
493
494int mapping_tagged(struct address_space *mapping, int tag);
495
8b28f621
DB
496static inline void i_mmap_lock_write(struct address_space *mapping)
497{
c8c06efa 498 down_write(&mapping->i_mmap_rwsem);
8b28f621
DB
499}
500
501static inline void i_mmap_unlock_write(struct address_space *mapping)
502{
c8c06efa 503 up_write(&mapping->i_mmap_rwsem);
8b28f621
DB
504}
505
3dec0ba0
DB
506static 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
1da177e4
LT
516/*
517 * Might pages of this file be mapped into userspace?
518 */
519static inline int mapping_mapped(struct address_space *mapping)
520{
27ba0644 521 return !RB_EMPTY_ROOT(&mapping->i_mmap);
1da177e4
LT
522}
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.
4bb5f5d9
DH
529 *
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.
1da177e4
LT
532 */
533static inline int mapping_writably_mapped(struct address_space *mapping)
534{
4bb5f5d9
DH
535 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);
1da177e4
LT
558}
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
f19d4a8f
AV
571struct posix_acl;
572#define ACL_NOT_CACHED ((void *)(-1))
573
3ddcd056
LT
574#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 */
1da177e4 583struct inode {
44a7d7a8 584 umode_t i_mode;
3ddcd056 585 unsigned short i_opflags;
92361636
EB
586 kuid_t i_uid;
587 kgid_t i_gid;
3ddcd056
LT
588 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
44a7d7a8
NP
595 const struct inode_operations *i_op;
596 struct super_block *i_sb;
3ddcd056 597 struct address_space *i_mapping;
44a7d7a8 598
13e12d14
LT
599#ifdef CONFIG_SECURITY
600 void *i_security;
601#endif
44a7d7a8 602
3ddcd056
LT
603 /* Stat data, not accessed from path walking */
604 unsigned long i_ino;
a78ef704
MS
605 /*
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 };
3ddcd056 616 dev_t i_rdev;
2f9d3df8 617 loff_t i_size;
3ddcd056
LT
618 struct timespec i_atime;
619 struct timespec i_mtime;
620 struct timespec i_ctime;
6cdbb0ef
TT
621 spinlock_t i_lock; /* i_blocks, i_bytes, maybe i_size */
622 unsigned short i_bytes;
2f9d3df8 623 unsigned int i_blkbits;
3ddcd056
LT
624 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;
3ddcd056 632 struct mutex i_mutex;
13e12d14 633
44a7d7a8 634 unsigned long dirtied_when; /* jiffies of first dirtying */
a2f48706 635 unsigned long dirtied_time_when;
44a7d7a8 636
1da177e4 637 struct hlist_node i_hash;
7ccf19a8 638 struct list_head i_wb_list; /* backing dev IO list */
52ebea74
TH
639#ifdef CONFIG_CGROUP_WRITEBACK
640 struct bdi_writeback *i_wb; /* the associated cgroup wb */
2a814908
TH
641
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;
52ebea74 646#endif
7ccf19a8 647 struct list_head i_lru; /* inode LRU list */
1da177e4 648 struct list_head i_sb_list;
fa0d7e3d 649 union {
b3d9b7a3 650 struct hlist_head i_dentry;
fa0d7e3d
NP
651 struct rcu_head i_rcu;
652 };
7a224228 653 u64 i_version;
2f9d3df8 654 atomic_t i_count;
bd5fe6c5 655 atomic_t i_dio_count;
6cdbb0ef 656 atomic_t i_writecount;
d984ea60
MZ
657#ifdef CONFIG_IMA
658 atomic_t i_readcount; /* struct files open RO */
659#endif
99ac48f5 660 const struct file_operations *i_fop; /* former ->i_op->default_file_ops */
4a075e39 661 struct file_lock_context *i_flctx;
1da177e4 662 struct address_space i_data;
1da177e4 663 struct list_head i_devices;
4c154168
TT
664 union {
665 struct pipe_inode_info *i_pipe;
eaf796e7 666 struct block_device *i_bdev;
577c4eb0 667 struct cdev *i_cdev;
61ba64fc 668 char *i_link;
4c154168 669 };
1da177e4
LT
670
671 __u32 i_generation;
672
3be25f49
EP
673#ifdef CONFIG_FSNOTIFY
674 __u32 i_fsnotify_mask; /* all events this inode cares about */
e61ce867 675 struct hlist_head i_fsnotify_marks;
0eeca283
RL
676#endif
677
8e18e294 678 void *i_private; /* fs or device private pointer */
1da177e4
LT
679};
680
1d3382cb
AV
681static inline int inode_unhashed(struct inode *inode)
682{
683 return hlist_unhashed(&inode->i_hash);
684}
685
f2eace23
IM
686/*
687 * inode->i_mutex nesting subclasses for the lock validator:
688 *
689 * 0: the object of the current VFS operation
690 * 1: parent
691 * 2: child/target
40bd22c9
BF
692 * 3: xattr
693 * 4: second non-directory
d1b72cc6
MS
694 * 5: second parent (when locking independent directories in rename)
695 *
696 * I_MUTEX_NONDIR2 is for certain operations (such as rename) which lock two
40bd22c9 697 * non-directories at once.
f2eace23
IM
698 *
699 * The locking order between these classes is
d1b72cc6 700 * parent[2] -> child -> grandchild -> normal -> xattr -> second non-directory
f2eace23
IM
701 */
702enum inode_i_mutex_lock_class
703{
704 I_MUTEX_NORMAL,
705 I_MUTEX_PARENT,
706 I_MUTEX_CHILD,
4df46240 707 I_MUTEX_XATTR,
d1b72cc6
MS
708 I_MUTEX_NONDIR2,
709 I_MUTEX_PARENT2,
f2eace23
IM
710};
711
375e289e
BF
712void lock_two_nondirectories(struct inode *, struct inode*);
713void unlock_two_nondirectories(struct inode *, struct inode*);
714
1da177e4
LT
715/*
716 * NOTE: in a 32bit arch with a preemptable kernel and
717 * an UP compile the i_size_read/write must be atomic
718 * with respect to the local cpu (unlike with preempt disabled),
719 * but they don't need to be atomic with respect to other cpus like in
720 * true SMP (so they need either to either locally disable irq around
721 * the read or for example on x86 they can be still implemented as a
722 * cmpxchg8b without the need of the lock prefix). For SMP compiles
723 * and 64bit archs it makes no difference if preempt is enabled or not.
724 */
48ed214d 725static inline loff_t i_size_read(const struct inode *inode)
1da177e4
LT
726{
727#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
728 loff_t i_size;
729 unsigned int seq;
730
731 do {
732 seq = read_seqcount_begin(&inode->i_size_seqcount);
733 i_size = inode->i_size;
734 } while (read_seqcount_retry(&inode->i_size_seqcount, seq));
735 return i_size;
736#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
737 loff_t i_size;
738
739 preempt_disable();
740 i_size = inode->i_size;
741 preempt_enable();
742 return i_size;
743#else
744 return inode->i_size;
745#endif
746}
747
7762f5a0
MS
748/*
749 * NOTE: unlike i_size_read(), i_size_write() does need locking around it
750 * (normally i_mutex), otherwise on 32bit/SMP an update of i_size_seqcount
751 * can be lost, resulting in subsequent i_size_read() calls spinning forever.
752 */
1da177e4
LT
753static inline void i_size_write(struct inode *inode, loff_t i_size)
754{
755#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
74e3d1e1 756 preempt_disable();
1da177e4
LT
757 write_seqcount_begin(&inode->i_size_seqcount);
758 inode->i_size = i_size;
759 write_seqcount_end(&inode->i_size_seqcount);
74e3d1e1 760 preempt_enable();
1da177e4
LT
761#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
762 preempt_disable();
763 inode->i_size = i_size;
764 preempt_enable();
765#else
766 inode->i_size = i_size;
767#endif
768}
769
92361636
EB
770/* Helper functions so that in most cases filesystems will
771 * not need to deal directly with kuid_t and kgid_t and can
772 * instead deal with the raw numeric values that are stored
773 * in the filesystem.
774 */
775static inline uid_t i_uid_read(const struct inode *inode)
776{
777 return from_kuid(&init_user_ns, inode->i_uid);
778}
779
780static inline gid_t i_gid_read(const struct inode *inode)
781{
782 return from_kgid(&init_user_ns, inode->i_gid);
783}
784
785static inline void i_uid_write(struct inode *inode, uid_t uid)
786{
787 inode->i_uid = make_kuid(&init_user_ns, uid);
788}
789
790static inline void i_gid_write(struct inode *inode, gid_t gid)
791{
792 inode->i_gid = make_kgid(&init_user_ns, gid);
793}
794
48ed214d 795static inline unsigned iminor(const struct inode *inode)
1da177e4
LT
796{
797 return MINOR(inode->i_rdev);
798}
799
48ed214d 800static inline unsigned imajor(const struct inode *inode)
1da177e4
LT
801{
802 return MAJOR(inode->i_rdev);
803}
804
805extern struct block_device *I_BDEV(struct inode *inode);
806
807struct fown_struct {
808 rwlock_t lock; /* protects pid, uid, euid fields */
609d7fa9
EB
809 struct pid *pid; /* pid or -pgrp where SIGIO should be sent */
810 enum pid_type pid_type; /* Kind of process group SIGIO should be sent to */
92361636 811 kuid_t uid, euid; /* uid/euid of process setting the owner */
1da177e4
LT
812 int signum; /* posix.1b rt signal to be delivered on IO */
813};
814
815/*
816 * Track a single file's readahead state
817 */
818struct file_ra_state {
937085aa
FW
819 pgoff_t start; /* where readahead started */
820 unsigned int size; /* # of readahead pages */
821 unsigned int async_size; /* do asynchronous readahead when
f9acc8c7 822 there are only # of pages ahead */
5ce1110b 823
937085aa 824 unsigned int ra_pages; /* Maximum readahead window */
1ebf26a9 825 unsigned int mmap_miss; /* Cache miss stat for mmap accesses */
f4e6b498 826 loff_t prev_pos; /* Cache last read() position */
1da177e4 827};
1da177e4 828
5ce1110b
FW
829/*
830 * Check if @index falls in the readahead windows.
831 */
832static inline int ra_has_index(struct file_ra_state *ra, pgoff_t index)
833{
f9acc8c7
FW
834 return (index >= ra->start &&
835 index < ra->start + ra->size);
5ce1110b
FW
836}
837
1da177e4 838struct file {
2f512016 839 union {
4f5e65a1 840 struct llist_node fu_llist;
2f512016
ED
841 struct rcu_head fu_rcuhead;
842 } f_u;
0f7fc9e4 843 struct path f_path;
dd37978c 844 struct inode *f_inode; /* cached value */
99ac48f5 845 const struct file_operations *f_op;
ef3d0fd2
AK
846
847 /*
9c225f26 848 * Protects f_ep_links, f_flags.
ef3d0fd2
AK
849 * Must not be taken from IRQ context.
850 */
851 spinlock_t f_lock;
516e0cc5 852 atomic_long_t f_count;
1da177e4 853 unsigned int f_flags;
aeb5d727 854 fmode_t f_mode;
9c225f26 855 struct mutex f_pos_lock;
1da177e4
LT
856 loff_t f_pos;
857 struct fown_struct f_owner;
d76b0d9b 858 const struct cred *f_cred;
1da177e4
LT
859 struct file_ra_state f_ra;
860
2b47c361 861 u64 f_version;
50462062 862#ifdef CONFIG_SECURITY
1da177e4 863 void *f_security;
50462062 864#endif
1da177e4
LT
865 /* needed for tty driver, and maybe others */
866 void *private_data;
867
868#ifdef CONFIG_EPOLL
869 /* Used by fs/eventpoll.c to link all the hooks to this file */
870 struct list_head f_ep_links;
28d82dc1 871 struct list_head f_tfile_llink;
1da177e4
LT
872#endif /* #ifdef CONFIG_EPOLL */
873 struct address_space *f_mapping;
bd2a31d5 874} __attribute__((aligned(4))); /* lest something weird decides that 2 is OK */
1da177e4 875
990d6c2d
AK
876struct file_handle {
877 __u32 handle_bytes;
878 int handle_type;
879 /* file identifier */
880 unsigned char f_handle[0];
881};
882
cb0942b8
AV
883static inline struct file *get_file(struct file *f)
884{
885 atomic_long_inc(&f->f_count);
886 return f;
887}
90f31d0e 888#define get_file_rcu(x) atomic_long_inc_not_zero(&(x)->f_count)
d7065da0 889#define fput_atomic(x) atomic_long_add_unless(&(x)->f_count, -1, 1)
516e0cc5 890#define file_count(x) atomic_long_read(&(x)->f_count)
1da177e4
LT
891
892#define MAX_NON_LFS ((1UL<<31) - 1)
893
894/* Page cache limit. The filesystems should put that into their s_maxbytes
895 limits, otherwise bad things can happen in VM. */
896#if BITS_PER_LONG==32
2bd2c194 897#define MAX_LFS_FILESIZE (((loff_t)PAGE_CACHE_SIZE << (BITS_PER_LONG-1))-1)
1da177e4 898#elif BITS_PER_LONG==64
614c321f 899#define MAX_LFS_FILESIZE ((loff_t)0x7fffffffffffffffLL)
1da177e4
LT
900#endif
901
902#define FL_POSIX 1
903#define FL_FLOCK 2
617588d5 904#define FL_DELEG 4 /* NFSv4 delegation */
1da177e4 905#define FL_ACCESS 8 /* not trying to lock, just looking */
f475ae95 906#define FL_EXISTS 16 /* when unlocking, test for existence */
1da177e4 907#define FL_LEASE 32 /* lease held on this file */
75e1fcc0 908#define FL_CLOSE 64 /* unlock on close */
1da177e4 909#define FL_SLEEP 128 /* A blocking lock */
778fc546
BF
910#define FL_DOWNGRADE_PENDING 256 /* Lease is being downgraded */
911#define FL_UNLOCK_PENDING 512 /* Lease is being broken */
cff2fce5 912#define FL_OFDLCK 1024 /* lock is "owned" by struct file */
11afe9f7 913#define FL_LAYOUT 2048 /* outstanding pNFS layout */
1da177e4 914
bde74e4b
MS
915/*
916 * Special return value from posix_lock_file() and vfs_lock_file() for
917 * asynchronous locking.
918 */
919#define FILE_LOCK_DEFERRED 1
920
7ca76311 921/* legacy typedef, should eventually be removed */
17fa388d 922typedef void *fl_owner_t;
1da177e4 923
a7231a97
JL
924struct file_lock;
925
1da177e4 926struct file_lock_operations {
1da177e4
LT
927 void (*fl_copy_lock)(struct file_lock *, struct file_lock *);
928 void (*fl_release_private)(struct file_lock *);
929};
930
931struct lock_manager_operations {
8fb47a4f 932 int (*lm_compare_owner)(struct file_lock *, struct file_lock *);
3999e493 933 unsigned long (*lm_owner_key)(struct file_lock *);
cae80b30
JL
934 fl_owner_t (*lm_get_owner)(fl_owner_t);
935 void (*lm_put_owner)(fl_owner_t);
8fb47a4f 936 void (*lm_notify)(struct file_lock *); /* unblock callback */
d0449b90 937 int (*lm_grant)(struct file_lock *, int);
4d01b7f5 938 bool (*lm_break)(struct file_lock *);
7448cc37 939 int (*lm_change)(struct file_lock *, int, struct list_head *);
1c7dd2ff 940 void (*lm_setup)(struct file_lock *, void **);
1da177e4
LT
941};
942
af558e33
BF
943struct lock_manager {
944 struct list_head list;
945};
946
5ccb0066
SK
947struct net;
948void locks_start_grace(struct net *, struct lock_manager *);
af558e33 949void locks_end_grace(struct lock_manager *);
5ccb0066 950int locks_in_grace(struct net *);
af558e33 951
1da177e4
LT
952/* that will die - we need it for nfs_lock_info */
953#include <linux/nfs_fs_i.h>
954
1cb36012
JL
955/*
956 * struct file_lock represents a generic "file lock". It's used to represent
957 * POSIX byte range locks, BSD (flock) locks, and leases. It's important to
958 * note that the same struct is used to represent both a request for a lock and
959 * the lock itself, but the same object is never used for both.
960 *
961 * FIXME: should we create a separate "struct lock_request" to help distinguish
962 * these two uses?
963 *
8116bf4c 964 * The varous i_flctx lists are ordered by:
1cb36012 965 *
8116bf4c
JL
966 * 1) lock owner
967 * 2) lock range start
968 * 3) lock range end
1cb36012
JL
969 *
970 * Obviously, the last two criteria only matter for POSIX locks.
971 */
1da177e4
LT
972struct file_lock {
973 struct file_lock *fl_next; /* singly linked list for this inode */
6dee60f6 974 struct list_head fl_list; /* link into file_lock_context */
139ca04e 975 struct hlist_node fl_link; /* node in global lists */
1da177e4
LT
976 struct list_head fl_block; /* circular list of blocked processes */
977 fl_owner_t fl_owner;
710b7216 978 unsigned int fl_flags;
afc1246f 979 unsigned char fl_type;
1da177e4 980 unsigned int fl_pid;
7012b02a 981 int fl_link_cpu; /* what cpu's list is this on? */
ab1f1611 982 struct pid *fl_nspid;
1da177e4
LT
983 wait_queue_head_t fl_wait;
984 struct file *fl_file;
1da177e4
LT
985 loff_t fl_start;
986 loff_t fl_end;
987
988 struct fasync_struct * fl_fasync; /* for lease break notifications */
778fc546
BF
989 /* for lease breaks: */
990 unsigned long fl_break_time;
991 unsigned long fl_downgrade_time;
1da177e4 992
6aed6285 993 const struct file_lock_operations *fl_ops; /* Callbacks for filesystems */
7b021967 994 const struct lock_manager_operations *fl_lmops; /* Callbacks for lockmanagers */
1da177e4
LT
995 union {
996 struct nfs_lock_info nfs_fl;
8d0a8a9d 997 struct nfs4_lock_info nfs4_fl;
e8d6c554
DH
998 struct {
999 struct list_head link; /* link in AFS vnode's pending_locks list */
1000 int state; /* state of grant or error if -ve */
1001 } afs;
1da177e4
LT
1002 } fl_u;
1003};
1004
4a075e39 1005struct file_lock_context {
6109c850 1006 spinlock_t flc_lock;
4a075e39 1007 struct list_head flc_flock;
bd61e0a9 1008 struct list_head flc_posix;
8634b51f 1009 struct list_head flc_lease;
4a075e39
JL
1010};
1011
1da177e4
LT
1012/* The following constant reflects the upper bound of the file/locking space */
1013#ifndef OFFSET_MAX
1014#define INT_LIMIT(x) (~((x)1 << (sizeof(x)*8 - 1)))
1015#define OFFSET_MAX INT_LIMIT(loff_t)
1016#define OFFT_OFFSET_MAX INT_LIMIT(off_t)
1017#endif
1018
1da177e4
LT
1019#include <linux/fcntl.h>
1020
bfcd17a6
TP
1021extern void send_sigio(struct fown_struct *fown, int fd, int band);
1022
bfcd17a6 1023#ifdef CONFIG_FILE_LOCKING
c1e62b8f 1024extern int fcntl_getlk(struct file *, unsigned int, struct flock __user *);
c293621b
PS
1025extern int fcntl_setlk(unsigned int, struct file *, unsigned int,
1026 struct flock __user *);
1da177e4
LT
1027
1028#if BITS_PER_LONG == 32
c1e62b8f 1029extern int fcntl_getlk64(struct file *, unsigned int, struct flock64 __user *);
c293621b
PS
1030extern int fcntl_setlk64(unsigned int, struct file *, unsigned int,
1031 struct flock64 __user *);
1da177e4
LT
1032#endif
1033
1da177e4
LT
1034extern int fcntl_setlease(unsigned int fd, struct file *filp, long arg);
1035extern int fcntl_getlease(struct file *filp);
1036
1037/* fs/locks.c */
4a075e39 1038void locks_free_lock_context(struct file_lock_context *ctx);
05fa3135 1039void locks_free_lock(struct file_lock *fl);
1da177e4 1040extern void locks_init_lock(struct file_lock *);
c5b1f0d9 1041extern struct file_lock * locks_alloc_lock(void);
1da177e4 1042extern void locks_copy_lock(struct file_lock *, struct file_lock *);
3fe0fff1 1043extern void locks_copy_conflock(struct file_lock *, struct file_lock *);
1da177e4 1044extern void locks_remove_posix(struct file *, fl_owner_t);
78ed8a13 1045extern void locks_remove_file(struct file *);
a9e61e25 1046extern void locks_release_private(struct file_lock *);
6d34ac19 1047extern void posix_test_lock(struct file *, struct file_lock *);
150b3934 1048extern int posix_lock_file(struct file *, struct file_lock *, struct file_lock *);
29d01b22 1049extern int posix_lock_inode_wait(struct inode *, struct file_lock *);
f891a29f 1050extern int posix_unblock_lock(struct file_lock *);
3ee17abd 1051extern int vfs_test_lock(struct file *, struct file_lock *);
150b3934 1052extern int vfs_lock_file(struct file *, unsigned int, struct file_lock *, struct file_lock *);
9b9d2ab4 1053extern int vfs_cancel_lock(struct file *filp, struct file_lock *fl);
29d01b22 1054extern int flock_lock_inode_wait(struct inode *inode, struct file_lock *fl);
df4e8d2c 1055extern int __break_lease(struct inode *inode, unsigned int flags, unsigned int type);
1da177e4 1056extern void lease_get_mtime(struct inode *, struct timespec *time);
e6f5c789
JL
1057extern int generic_setlease(struct file *, long, struct file_lock **, void **priv);
1058extern int vfs_setlease(struct file *, long, struct file_lock **, void **);
7448cc37 1059extern int lease_modify(struct file_lock *, int, struct list_head *);
6c8c9031
AV
1060struct files_struct;
1061extern void show_fd_locks(struct seq_file *f,
1062 struct file *filp, struct files_struct *files);
bfcd17a6 1063#else /* !CONFIG_FILE_LOCKING */
c1e62b8f
JL
1064static inline int fcntl_getlk(struct file *file, unsigned int cmd,
1065 struct flock __user *user)
c2aca5e5
SW
1066{
1067 return -EINVAL;
1068}
1069
1070static inline int fcntl_setlk(unsigned int fd, struct file *file,
1071 unsigned int cmd, struct flock __user *user)
1072{
1073 return -EACCES;
1074}
1075
bfcd17a6 1076#if BITS_PER_LONG == 32
c1e62b8f
JL
1077static inline int fcntl_getlk64(struct file *file, unsigned int cmd,
1078 struct flock64 __user *user)
c2aca5e5
SW
1079{
1080 return -EINVAL;
1081}
1082
1083static inline int fcntl_setlk64(unsigned int fd, struct file *file,
1084 unsigned int cmd, struct flock64 __user *user)
1085{
1086 return -EACCES;
1087}
bfcd17a6 1088#endif
c2aca5e5
SW
1089static inline int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1090{
1b2b32dc 1091 return -EINVAL;
c2aca5e5
SW
1092}
1093
1094static inline int fcntl_getlease(struct file *filp)
1095{
1b2b32dc 1096 return F_UNLCK;
c2aca5e5
SW
1097}
1098
4a075e39
JL
1099static inline void
1100locks_free_lock_context(struct file_lock_context *ctx)
1101{
1102}
1103
c2aca5e5
SW
1104static inline void locks_init_lock(struct file_lock *fl)
1105{
1106 return;
1107}
1108
3fe0fff1 1109static inline void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
c2aca5e5
SW
1110{
1111 return;
1112}
1113
1114static inline void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
1115{
1116 return;
1117}
1118
1119static inline void locks_remove_posix(struct file *filp, fl_owner_t owner)
1120{
1121 return;
1122}
1123
78ed8a13 1124static inline void locks_remove_file(struct file *filp)
c2aca5e5
SW
1125{
1126 return;
1127}
1128
1129static inline void posix_test_lock(struct file *filp, struct file_lock *fl)
1130{
1131 return;
1132}
1133
1134static inline int posix_lock_file(struct file *filp, struct file_lock *fl,
1135 struct file_lock *conflock)
1136{
1137 return -ENOLCK;
1138}
1139
29d01b22
JL
1140static inline int posix_lock_inode_wait(struct inode *inode,
1141 struct file_lock *fl)
1142{
1143 return -ENOLCK;
1144}
1145
f891a29f 1146static inline int posix_unblock_lock(struct file_lock *waiter)
c2aca5e5
SW
1147{
1148 return -ENOENT;
1149}
1150
1151static inline int vfs_test_lock(struct file *filp, struct file_lock *fl)
1152{
1153 return 0;
1154}
1155
1156static inline int vfs_lock_file(struct file *filp, unsigned int cmd,
1157 struct file_lock *fl, struct file_lock *conf)
1158{
1159 return -ENOLCK;
1160}
1161
1162static inline int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
1163{
1164 return 0;
1165}
1166
29d01b22
JL
1167static inline int flock_lock_inode_wait(struct inode *inode,
1168 struct file_lock *request)
1169{
1170 return -ENOLCK;
1171}
1172
df4e8d2c 1173static inline int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
c2aca5e5
SW
1174{
1175 return 0;
1176}
1177
1178static inline void lease_get_mtime(struct inode *inode, struct timespec *time)
1179{
1180 return;
1181}
1182
1183static inline int generic_setlease(struct file *filp, long arg,
e6f5c789 1184 struct file_lock **flp, void **priv)
c2aca5e5
SW
1185{
1186 return -EINVAL;
1187}
1188
1189static inline int vfs_setlease(struct file *filp, long arg,
e6f5c789 1190 struct file_lock **lease, void **priv)
c2aca5e5
SW
1191{
1192 return -EINVAL;
1193}
1194
7448cc37 1195static inline int lease_modify(struct file_lock *fl, int arg,
c45198ed 1196 struct list_head *dispose)
c2aca5e5
SW
1197{
1198 return -EINVAL;
1199}
6c8c9031
AV
1200
1201struct files_struct;
1202static inline void show_fd_locks(struct seq_file *f,
1203 struct file *filp, struct files_struct *files) {}
bfcd17a6
TP
1204#endif /* !CONFIG_FILE_LOCKING */
1205
ee296d7c
JL
1206static inline struct inode *file_inode(const struct file *f)
1207{
1208 return f->f_inode;
1209}
1210
1211static inline int posix_lock_file_wait(struct file *filp, struct file_lock *fl)
1212{
1213 return posix_lock_inode_wait(file_inode(filp), fl);
1214}
1215
1216static inline int flock_lock_file_wait(struct file *filp, struct file_lock *fl)
1217{
1218 return flock_lock_inode_wait(file_inode(filp), fl);
1219}
1da177e4
LT
1220
1221struct fasync_struct {
989a2979
ED
1222 spinlock_t fa_lock;
1223 int magic;
1224 int fa_fd;
1225 struct fasync_struct *fa_next; /* singly linked list */
1226 struct file *fa_file;
1227 struct rcu_head fa_rcu;
1da177e4
LT
1228};
1229
1230#define FASYNC_MAGIC 0x4601
1231
1232/* SMP safe fasync helpers: */
1233extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
f7347ce4
LT
1234extern struct fasync_struct *fasync_insert_entry(int, struct file *, struct fasync_struct **, struct fasync_struct *);
1235extern int fasync_remove_entry(struct file *, struct fasync_struct **);
1236extern struct fasync_struct *fasync_alloc(void);
1237extern void fasync_free(struct fasync_struct *);
1238
1da177e4
LT
1239/* can be called from interrupts */
1240extern void kill_fasync(struct fasync_struct **, int, int);
1da177e4 1241
e0b93edd
JL
1242extern void __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
1243extern void f_setown(struct file *filp, unsigned long arg, int force);
1da177e4 1244extern void f_delown(struct file *filp);
609d7fa9 1245extern pid_t f_getown(struct file *filp);
1da177e4
LT
1246extern int send_sigurg(struct fown_struct *fown);
1247
5accdf82
JK
1248struct mm_struct;
1249
1da177e4
LT
1250/*
1251 * Umount options
1252 */
1253
1254#define MNT_FORCE 0x00000001 /* Attempt to forcibily umount */
1255#define MNT_DETACH 0x00000002 /* Just detach from the tree */
1256#define MNT_EXPIRE 0x00000004 /* Mark for expiry */
db1f05bb
MS
1257#define UMOUNT_NOFOLLOW 0x00000008 /* Don't follow symlink on umount */
1258#define UMOUNT_UNUSED 0x80000000 /* Flag guaranteed to be unused */
1da177e4 1259
46b15caa
TH
1260/* sb->s_iflags */
1261#define SB_I_CGROUPWB 0x00000001 /* cgroup-aware writeback enabled */
1da177e4 1262
5accdf82
JK
1263/* Possible states of 'frozen' field */
1264enum {
1265 SB_UNFROZEN = 0, /* FS is unfrozen */
1266 SB_FREEZE_WRITE = 1, /* Writes, dir ops, ioctls frozen */
5accdf82
JK
1267 SB_FREEZE_PAGEFAULT = 2, /* Page faults stopped as well */
1268 SB_FREEZE_FS = 3, /* For internal FS use (e.g. to stop
1269 * internal threads if needed) */
1270 SB_FREEZE_COMPLETE = 4, /* ->freeze_fs finished successfully */
1271};
1272
1273#define SB_FREEZE_LEVELS (SB_FREEZE_COMPLETE - 1)
1274
1275struct sb_writers {
1276 /* Counters for counting writers at each level */
1277 struct percpu_counter counter[SB_FREEZE_LEVELS];
1278 wait_queue_head_t wait; /* queue for waiting for
1279 writers / faults to finish */
1280 int frozen; /* Is sb frozen? */
1281 wait_queue_head_t wait_unfrozen; /* queue for waiting for
1282 sb to be thawed */
1283#ifdef CONFIG_DEBUG_LOCK_ALLOC
1284 struct lockdep_map lock_map[SB_FREEZE_LEVELS];
1285#endif
1286};
1287
1da177e4
LT
1288struct super_block {
1289 struct list_head s_list; /* Keep this first */
1290 dev_t s_dev; /* search index; _not_ kdev_t */
270ba5f7
RK
1291 unsigned char s_blocksize_bits;
1292 unsigned long s_blocksize;
42cb56ae 1293 loff_t s_maxbytes; /* Max file size */
1da177e4 1294 struct file_system_type *s_type;
ee9b6d61 1295 const struct super_operations *s_op;
61e225dc 1296 const struct dquot_operations *dq_op;
0d54b217 1297 const struct quotactl_ops *s_qcop;
39655164 1298 const struct export_operations *s_export_op;
1da177e4 1299 unsigned long s_flags;
46b15caa 1300 unsigned long s_iflags; /* internal SB_I_* flags */
1da177e4
LT
1301 unsigned long s_magic;
1302 struct dentry *s_root;
1303 struct rw_semaphore s_umount;
1da177e4 1304 int s_count;
1da177e4 1305 atomic_t s_active;
50462062 1306#ifdef CONFIG_SECURITY
1da177e4 1307 void *s_security;
50462062 1308#endif
bb435453 1309 const struct xattr_handler **s_xattr;
1da177e4
LT
1310
1311 struct list_head s_inodes; /* all inodes */
ceb5bdc2 1312 struct hlist_bl_head s_anon; /* anonymous dentries for (nfs) exporting */
39f7c4db 1313 struct list_head s_mounts; /* list of mounts; _not_ for fs use */
1da177e4 1314 struct block_device *s_bdev;
32a88aa1 1315 struct backing_dev_info *s_bdi;
acaebfd8 1316 struct mtd_info *s_mtd;
a5166169 1317 struct hlist_node s_instances;
2c5f648a 1318 unsigned int s_quota_types; /* Bitmask of supported quota types */
1da177e4
LT
1319 struct quota_info s_dquot; /* Diskquota specific options */
1320
5accdf82 1321 struct sb_writers s_writers;
1da177e4
LT
1322
1323 char s_id[32]; /* Informational name */
0bba0169 1324 u8 s_uuid[16]; /* UUID */
1da177e4
LT
1325
1326 void *s_fs_info; /* Filesystem private info */
8de52778 1327 unsigned int s_max_links;
30c40d2c 1328 fmode_t s_mode;
1da177e4 1329
270ba5f7
RK
1330 /* Granularity of c/m/atime in ns.
1331 Cannot be worse than a second */
1332 u32 s_time_gran;
1333
1da177e4
LT
1334 /*
1335 * The next field is for VFS *only*. No filesystems have any business
1336 * even looking at it. You had been warned.
1337 */
a11f3a05 1338 struct mutex s_vfs_rename_mutex; /* Kludge */
1da177e4 1339
79c0b2df
MS
1340 /*
1341 * Filesystem subtype. If non-empty the filesystem type field
1342 * in /proc/mounts will be "type.subtype"
1343 */
1344 char *s_subtype;
b3b304a2
MS
1345
1346 /*
1347 * Saved mount options for lazy filesystems using
1348 * generic_show_options()
1349 */
4d2deb40 1350 char __rcu *s_options;
c8aebb0c 1351 const struct dentry_operations *s_d_op; /* default d_op for dentries */
9fdfdcf1
DM
1352
1353 /*
1354 * Saved pool identifier for cleancache (-1 means none)
1355 */
1356 int cleancache_poolid;
b0d40c92
DC
1357
1358 struct shrinker s_shrink; /* per-sb shrinker handle */
4ed5e82f 1359
7ada4db8
MS
1360 /* Number of inodes with nlink == 0 but still referenced */
1361 atomic_long_t s_remove_count;
1362
4ed5e82f
MS
1363 /* Being remounted read-only */
1364 int s_readonly_remount;
7b7a8665
CH
1365
1366 /* AIO completions deferred from interrupt context */
1367 struct workqueue_struct *s_dio_done_wq;
215752fc 1368 struct hlist_head s_pins;
f6041567
DC
1369
1370 /*
1371 * Keep the lru lists last in the structure so they always sit on their
1372 * own individual cachelines.
1373 */
1374 struct list_lru s_dentry_lru ____cacheline_aligned_in_smp;
1375 struct list_lru s_inode_lru ____cacheline_aligned_in_smp;
e2fec7c3 1376 struct rcu_head rcu;
69c433ed
MS
1377
1378 /*
1379 * Indicates how deep in a filesystem stack this SB is
1380 */
1381 int s_stack_depth;
1da177e4
LT
1382};
1383
1384extern struct timespec current_fs_time(struct super_block *sb);
1385
1386/*
1387 * Snapshotting support.
1388 */
1da177e4 1389
5accdf82
JK
1390void __sb_end_write(struct super_block *sb, int level);
1391int __sb_start_write(struct super_block *sb, int level, bool wait);
1392
1393/**
1394 * sb_end_write - drop write access to a superblock
1395 * @sb: the super we wrote to
1396 *
1397 * Decrement number of writers to the filesystem. Wake up possible waiters
1398 * wanting to freeze the filesystem.
1399 */
1400static inline void sb_end_write(struct super_block *sb)
1401{
1402 __sb_end_write(sb, SB_FREEZE_WRITE);
1403}
1404
1405/**
1406 * sb_end_pagefault - drop write access to a superblock from a page fault
1407 * @sb: the super we wrote to
1408 *
1409 * Decrement number of processes handling write page fault to the filesystem.
1410 * Wake up possible waiters wanting to freeze the filesystem.
1411 */
1412static inline void sb_end_pagefault(struct super_block *sb)
1413{
1414 __sb_end_write(sb, SB_FREEZE_PAGEFAULT);
1415}
1416
1417/**
1418 * sb_end_intwrite - drop write access to a superblock for internal fs purposes
1419 * @sb: the super we wrote to
1420 *
1421 * Decrement fs-internal number of writers to the filesystem. Wake up possible
1422 * waiters wanting to freeze the filesystem.
1423 */
1424static inline void sb_end_intwrite(struct super_block *sb)
1425{
1426 __sb_end_write(sb, SB_FREEZE_FS);
1427}
1428
1429/**
1430 * sb_start_write - get write access to a superblock
1431 * @sb: the super we write to
1432 *
1433 * When a process wants to write data or metadata to a file system (i.e. dirty
1434 * a page or an inode), it should embed the operation in a sb_start_write() -
1435 * sb_end_write() pair to get exclusion against file system freezing. This
1436 * function increments number of writers preventing freezing. If the file
1437 * system is already frozen, the function waits until the file system is
1438 * thawed.
1439 *
1440 * Since freeze protection behaves as a lock, users have to preserve
1441 * ordering of freeze protection and other filesystem locks. Generally,
1442 * freeze protection should be the outermost lock. In particular, we have:
1443 *
1444 * sb_start_write
1445 * -> i_mutex (write path, truncate, directory ops, ...)
1446 * -> s_umount (freeze_super, thaw_super)
1447 */
1448static inline void sb_start_write(struct super_block *sb)
1449{
1450 __sb_start_write(sb, SB_FREEZE_WRITE, true);
1451}
1452
1453static inline int sb_start_write_trylock(struct super_block *sb)
1454{
1455 return __sb_start_write(sb, SB_FREEZE_WRITE, false);
1456}
1457
1458/**
1459 * sb_start_pagefault - get write access to a superblock from a page fault
1460 * @sb: the super we write to
1461 *
1462 * When a process starts handling write page fault, it should embed the
1463 * operation into sb_start_pagefault() - sb_end_pagefault() pair to get
1464 * exclusion against file system freezing. This is needed since the page fault
1465 * is going to dirty a page. This function increments number of running page
1466 * faults preventing freezing. If the file system is already frozen, the
1467 * function waits until the file system is thawed.
1468 *
1469 * Since page fault freeze protection behaves as a lock, users have to preserve
1470 * ordering of freeze protection and other filesystem locks. It is advised to
1471 * put sb_start_pagefault() close to mmap_sem in lock ordering. Page fault
1472 * handling code implies lock dependency:
1473 *
1474 * mmap_sem
1475 * -> sb_start_pagefault
1476 */
1477static inline void sb_start_pagefault(struct super_block *sb)
1478{
1479 __sb_start_write(sb, SB_FREEZE_PAGEFAULT, true);
1480}
1481
1482/*
1483 * sb_start_intwrite - get write access to a superblock for internal fs purposes
1484 * @sb: the super we write to
1485 *
1486 * This is the third level of protection against filesystem freezing. It is
1487 * free for use by a filesystem. The only requirement is that it must rank
1488 * below sb_start_pagefault.
1489 *
1490 * For example filesystem can call sb_start_intwrite() when starting a
1491 * transaction which somewhat eases handling of freezing for internal sources
1492 * of filesystem changes (internal fs threads, discarding preallocation on file
1493 * close, etc.).
1494 */
1495static inline void sb_start_intwrite(struct super_block *sb)
1496{
1497 __sb_start_write(sb, SB_FREEZE_FS, true);
1498}
1da177e4 1499
1da177e4 1500
2e149670 1501extern bool inode_owner_or_capable(const struct inode *inode);
3bd858ab 1502
1da177e4
LT
1503/*
1504 * VFS helper functions..
1505 */
312b63fb 1506extern int vfs_create(struct inode *, struct dentry *, umode_t, bool);
18bb1db3 1507extern int vfs_mkdir(struct inode *, struct dentry *, umode_t);
1a67aafb 1508extern int vfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
db2e747b 1509extern int vfs_symlink(struct inode *, struct dentry *, const char *);
146a8595 1510extern int vfs_link(struct dentry *, struct inode *, struct dentry *, struct inode **);
1da177e4 1511extern int vfs_rmdir(struct inode *, struct dentry *);
b21996e3 1512extern int vfs_unlink(struct inode *, struct dentry *, struct inode **);
520c8b16 1513extern int vfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *, struct inode **, unsigned int);
787fb6bc 1514extern int vfs_whiteout(struct inode *, struct dentry *);
1da177e4
LT
1515
1516/*
1517 * VFS dentry helper functions.
1518 */
1519extern void dentry_unhash(struct dentry *dentry);
1520
8c744fb8
CH
1521/*
1522 * VFS file helper functions.
1523 */
a1bd120d 1524extern void inode_init_owner(struct inode *inode, const struct inode *dir,
62bb1091 1525 umode_t mode);
c4b929b8
MF
1526/*
1527 * VFS FS_IOC_FIEMAP helper definitions.
1528 */
1529struct fiemap_extent_info {
1530 unsigned int fi_flags; /* Flags as passed from user */
1531 unsigned int fi_extents_mapped; /* Number of mapped extents */
1532 unsigned int fi_extents_max; /* Size of fiemap_extent array */
ecf5632d
NK
1533 struct fiemap_extent __user *fi_extents_start; /* Start of
1534 fiemap_extent array */
c4b929b8
MF
1535};
1536int fiemap_fill_next_extent(struct fiemap_extent_info *info, u64 logical,
1537 u64 phys, u64 len, u32 flags);
1538int fiemap_check_flags(struct fiemap_extent_info *fieinfo, u32 fs_flags);
1539
1da177e4
LT
1540/*
1541 * File types
1542 *
1543 * NOTE! These match bits 12..15 of stat.st_mode
1544 * (ie "(i_mode >> 12) & 15").
1545 */
1546#define DT_UNKNOWN 0
1547#define DT_FIFO 1
1548#define DT_CHR 2
1549#define DT_DIR 4
1550#define DT_BLK 6
1551#define DT_REG 8
1552#define DT_LNK 10
1553#define DT_SOCK 12
1554#define DT_WHT 14
1555
1da177e4
LT
1556/*
1557 * This is the "filldir" function type, used by readdir() to let
1558 * the kernel specify what kind of dirent layout it wants to have.
1559 * This allows the kernel to read directories into kernel space or
1560 * to have different dirent layouts depending on the binary type.
1561 */
ac7576f4
MS
1562struct dir_context;
1563typedef int (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64,
1564 unsigned);
1565
5c0ba4e0 1566struct dir_context {
ac6614b7 1567 const filldir_t actor;
bb6f619b 1568 loff_t pos;
5c0ba4e0 1569};
bb6f619b 1570
08f85851 1571struct block_device_operations;
1da177e4 1572
1da177e4
LT
1573/* These macros are for out of kernel modules to test that
1574 * the kernel supports the unlocked_ioctl and compat_ioctl
1575 * fields in struct file_operations. */
1576#define HAVE_COMPAT_IOCTL 1
1577#define HAVE_UNLOCKED_IOCTL 1
1578
b4caecd4
CH
1579/*
1580 * These flags let !MMU mmap() govern direct device mapping vs immediate
1581 * copying more easily for MAP_PRIVATE, especially for ROM filesystems.
1582 *
1583 * NOMMU_MAP_COPY: Copy can be mapped (MAP_PRIVATE)
1584 * NOMMU_MAP_DIRECT: Can be mapped directly (MAP_SHARED)
1585 * NOMMU_MAP_READ: Can be mapped for reading
1586 * NOMMU_MAP_WRITE: Can be mapped for writing
1587 * NOMMU_MAP_EXEC: Can be mapped for execution
1588 */
1589#define NOMMU_MAP_COPY 0x00000001
1590#define NOMMU_MAP_DIRECT 0x00000008
1591#define NOMMU_MAP_READ VM_MAYREAD
1592#define NOMMU_MAP_WRITE VM_MAYWRITE
1593#define NOMMU_MAP_EXEC VM_MAYEXEC
1594
1595#define NOMMU_VMFLAGS \
1596 (NOMMU_MAP_READ | NOMMU_MAP_WRITE | NOMMU_MAP_EXEC)
1597
1598
293bc982
AV
1599struct iov_iter;
1600
1da177e4
LT
1601struct file_operations {
1602 struct module *owner;
1603 loff_t (*llseek) (struct file *, loff_t, int);
1604 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
1da177e4 1605 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
293bc982
AV
1606 ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
1607 ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
bb6f619b 1608 int (*iterate) (struct file *, struct dir_context *);
1da177e4 1609 unsigned int (*poll) (struct file *, struct poll_table_struct *);
1da177e4
LT
1610 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
1611 long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
1612 int (*mmap) (struct file *, struct vm_area_struct *);
b2edffdd 1613 int (*mremap)(struct file *, struct vm_area_struct *);
1da177e4 1614 int (*open) (struct inode *, struct file *);
75e1fcc0 1615 int (*flush) (struct file *, fl_owner_t id);
1da177e4 1616 int (*release) (struct inode *, struct file *);
02c24a82 1617 int (*fsync) (struct file *, loff_t, loff_t, int datasync);
1da177e4
LT
1618 int (*aio_fsync) (struct kiocb *, int datasync);
1619 int (*fasync) (int, struct file *, int);
1620 int (*lock) (struct file *, int, struct file_lock *);
1da177e4
LT
1621 ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
1622 unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
1623 int (*check_flags)(int);
1da177e4 1624 int (*flock) (struct file *, int, struct file_lock *);
cbb7e577
JA
1625 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int);
1626 ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int);
e6f5c789 1627 int (*setlease)(struct file *, long, struct file_lock **, void **);
2fe17c10
CH
1628 long (*fallocate)(struct file *file, int mode, loff_t offset,
1629 loff_t len);
a3816ab0 1630 void (*show_fdinfo)(struct seq_file *m, struct file *f);
b4caecd4
CH
1631#ifndef CONFIG_MMU
1632 unsigned (*mmap_capabilities)(struct file *);
1633#endif
1da177e4
LT
1634};
1635
1636struct inode_operations {
00cd8dd3 1637 struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
6e77137b 1638 const char * (*follow_link) (struct dentry *, void **);
10556cb2 1639 int (*permission) (struct inode *, int);
4e34e719 1640 struct posix_acl * (*get_acl)(struct inode *, int);
44a7d7a8
NP
1641
1642 int (*readlink) (struct dentry *, char __user *,int);
5f2c4179 1643 void (*put_link) (struct inode *, void *);
44a7d7a8 1644
ebfc3b49 1645 int (*create) (struct inode *,struct dentry *, umode_t, bool);
1da177e4
LT
1646 int (*link) (struct dentry *,struct inode *,struct dentry *);
1647 int (*unlink) (struct inode *,struct dentry *);
1648 int (*symlink) (struct inode *,struct dentry *,const char *);
18bb1db3 1649 int (*mkdir) (struct inode *,struct dentry *,umode_t);
1da177e4 1650 int (*rmdir) (struct inode *,struct dentry *);
1a67aafb 1651 int (*mknod) (struct inode *,struct dentry *,umode_t,dev_t);
1da177e4
LT
1652 int (*rename) (struct inode *, struct dentry *,
1653 struct inode *, struct dentry *);
520c8b16
MS
1654 int (*rename2) (struct inode *, struct dentry *,
1655 struct inode *, struct dentry *, unsigned int);
1da177e4
LT
1656 int (*setattr) (struct dentry *, struct iattr *);
1657 int (*getattr) (struct vfsmount *mnt, struct dentry *, struct kstat *);
1658 int (*setxattr) (struct dentry *, const char *,const void *,size_t,int);
1659 ssize_t (*getxattr) (struct dentry *, const char *, void *, size_t);
1660 ssize_t (*listxattr) (struct dentry *, char *, size_t);
1661 int (*removexattr) (struct dentry *, const char *);
c4b929b8
MF
1662 int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
1663 u64 len);
c3b2da31 1664 int (*update_time)(struct inode *, struct timespec *, int);
d9585277 1665 int (*atomic_open)(struct inode *, struct dentry *,
30d90494 1666 struct file *, unsigned open_flag,
d9585277 1667 umode_t create_mode, int *opened);
60545d0d 1668 int (*tmpfile) (struct inode *, struct dentry *, umode_t);
893d46e4 1669 int (*set_acl)(struct inode *, struct posix_acl *, int);
4aa7c634
MS
1670
1671 /* WARNING: probably going away soon, do not use! */
44a7d7a8 1672} ____cacheline_aligned;
1da177e4 1673
eed4e51f 1674ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvector,
fcf63409
CY
1675 unsigned long nr_segs, unsigned long fast_segs,
1676 struct iovec *fast_pointer,
ac34ebb3 1677 struct iovec **ret_pointer);
eed4e51f 1678
6fb5032e 1679extern ssize_t __vfs_read(struct file *, char __user *, size_t, loff_t *);
493c84c0 1680extern ssize_t __vfs_write(struct file *, const char __user *, size_t, loff_t *);
1da177e4
LT
1681extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
1682extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
1683extern ssize_t vfs_readv(struct file *, const struct iovec __user *,
1684 unsigned long, loff_t *);
1685extern ssize_t vfs_writev(struct file *, const struct iovec __user *,
1686 unsigned long, loff_t *);
1687
1da177e4
LT
1688struct super_operations {
1689 struct inode *(*alloc_inode)(struct super_block *sb);
1690 void (*destroy_inode)(struct inode *);
1691
aa385729 1692 void (*dirty_inode) (struct inode *, int flags);
a9185b41 1693 int (*write_inode) (struct inode *, struct writeback_control *wbc);
45321ac5 1694 int (*drop_inode) (struct inode *);
be7ce416 1695 void (*evict_inode) (struct inode *);
1da177e4 1696 void (*put_super) (struct super_block *);
1da177e4 1697 int (*sync_fs)(struct super_block *sb, int wait);
48b6bca6 1698 int (*freeze_super) (struct super_block *);
c4be0c1d 1699 int (*freeze_fs) (struct super_block *);
48b6bca6 1700 int (*thaw_super) (struct super_block *);
c4be0c1d 1701 int (*unfreeze_fs) (struct super_block *);
726c3342 1702 int (*statfs) (struct dentry *, struct kstatfs *);
1da177e4 1703 int (*remount_fs) (struct super_block *, int *, char *);
42faad99 1704 void (*umount_begin) (struct super_block *);
1da177e4 1705
34c80b1d 1706 int (*show_options)(struct seq_file *, struct dentry *);
d861c630 1707 int (*show_devname)(struct seq_file *, struct dentry *);
a6322de6 1708 int (*show_path)(struct seq_file *, struct dentry *);
64132379 1709 int (*show_stats)(struct seq_file *, struct dentry *);
0e51a720 1710#ifdef CONFIG_QUOTA
1da177e4
LT
1711 ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
1712 ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
2d0fa467 1713 struct dquot **(*get_dquots)(struct inode *);
0e51a720 1714#endif
87d8fe1e 1715 int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
4101b624
VD
1716 long (*nr_cached_objects)(struct super_block *,
1717 struct shrink_control *);
1718 long (*free_cached_objects)(struct super_block *,
1719 struct shrink_control *);
1da177e4
LT
1720};
1721
bbc1096a
DH
1722/*
1723 * Inode flags - they have no relation to superblock flags now
1724 */
1725#define S_SYNC 1 /* Writes are synced at once */
1726#define S_NOATIME 2 /* Do not update access times */
1727#define S_APPEND 4 /* Append-only file */
1728#define S_IMMUTABLE 8 /* Immutable file */
1729#define S_DEAD 16 /* removed, but still open directory */
1730#define S_NOQUOTA 32 /* Inode is not counted to quota */
1731#define S_DIRSYNC 64 /* Directory modifications are synchronous */
1732#define S_NOCMTIME 128 /* Do not update file c/mtime */
1733#define S_SWAPFILE 256 /* Do not truncate: swapon got its bmaps */
1734#define S_PRIVATE 512 /* Inode is fs-internal */
1735#define S_IMA 1024 /* Inode has an associated IMA struct */
1736#define S_AUTOMOUNT 2048 /* Automount/referral quasi-directory */
1737#define S_NOSEC 4096 /* no suid or xattr security attributes */
6cd176a5 1738#ifdef CONFIG_FS_DAX
fbbbad4b
MW
1739#define S_DAX 8192 /* Direct Access, avoiding the page cache */
1740#else
1741#define S_DAX 0 /* Make all the DAX code disappear */
1742#endif
bbc1096a
DH
1743
1744/*
1745 * Note that nosuid etc flags are inode-specific: setting some file-system
1746 * flags just means all the inodes inherit those flags by default. It might be
1747 * possible to override it selectively if you really wanted to with some
1748 * ioctl() that is not currently implemented.
1749 *
1750 * Exception: MS_RDONLY is always applied to the entire file system.
1751 *
1752 * Unfortunately, it is possible to change a filesystems flags with it mounted
1753 * with files in use. This means that all of the inodes will not have their
1754 * i_flags updated. Hence, i_flags no longer inherit the superblock mount
1755 * flags, so these have to be checked separately. -- rmk@arm.uk.linux.org
1756 */
1757#define __IS_FLG(inode, flg) ((inode)->i_sb->s_flags & (flg))
1758
1759#define IS_RDONLY(inode) ((inode)->i_sb->s_flags & MS_RDONLY)
1760#define IS_SYNC(inode) (__IS_FLG(inode, MS_SYNCHRONOUS) || \
1761 ((inode)->i_flags & S_SYNC))
1762#define IS_DIRSYNC(inode) (__IS_FLG(inode, MS_SYNCHRONOUS|MS_DIRSYNC) || \
1763 ((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
1764#define IS_MANDLOCK(inode) __IS_FLG(inode, MS_MANDLOCK)
1765#define IS_NOATIME(inode) __IS_FLG(inode, MS_RDONLY|MS_NOATIME)
1766#define IS_I_VERSION(inode) __IS_FLG(inode, MS_I_VERSION)
1767
1768#define IS_NOQUOTA(inode) ((inode)->i_flags & S_NOQUOTA)
1769#define IS_APPEND(inode) ((inode)->i_flags & S_APPEND)
1770#define IS_IMMUTABLE(inode) ((inode)->i_flags & S_IMMUTABLE)
1771#define IS_POSIXACL(inode) __IS_FLG(inode, MS_POSIXACL)
1772
1773#define IS_DEADDIR(inode) ((inode)->i_flags & S_DEAD)
1774#define IS_NOCMTIME(inode) ((inode)->i_flags & S_NOCMTIME)
1775#define IS_SWAPFILE(inode) ((inode)->i_flags & S_SWAPFILE)
1776#define IS_PRIVATE(inode) ((inode)->i_flags & S_PRIVATE)
1777#define IS_IMA(inode) ((inode)->i_flags & S_IMA)
1778#define IS_AUTOMOUNT(inode) ((inode)->i_flags & S_AUTOMOUNT)
1779#define IS_NOSEC(inode) ((inode)->i_flags & S_NOSEC)
fbbbad4b 1780#define IS_DAX(inode) ((inode)->i_flags & S_DAX)
bbc1096a 1781
787fb6bc
MS
1782#define IS_WHITEOUT(inode) (S_ISCHR(inode->i_mode) && \
1783 (inode)->i_rdev == WHITEOUT_DEV)
1784
1c0eeaf5 1785/*
250df6ed 1786 * Inode state bits. Protected by inode->i_lock
1c0eeaf5
JE
1787 *
1788 * Three bits determine the dirty state of the inode, I_DIRTY_SYNC,
1789 * I_DIRTY_DATASYNC and I_DIRTY_PAGES.
1790 *
1791 * Four bits define the lifetime of an inode. Initially, inodes are I_NEW,
1792 * until that flag is cleared. I_WILL_FREE, I_FREEING and I_CLEAR are set at
1793 * various stages of removing an inode.
1794 *
eaff8079 1795 * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
1c0eeaf5 1796 *
e7ca2d41
JE
1797 * I_DIRTY_SYNC Inode is dirty, but doesn't have to be written on
1798 * fdatasync(). i_atime is the usual cause.
000cb48e
JK
1799 * I_DIRTY_DATASYNC Data-related inode changes pending. We keep track of
1800 * these changes separately from I_DIRTY_SYNC so that we
1801 * don't have to write inode on fdatasync() when only
1802 * mtime has changed in it.
1c0eeaf5 1803 * I_DIRTY_PAGES Inode has dirty pages. Inode itself may be clean.
eaff8079
CH
1804 * I_NEW Serves as both a mutex and completion notification.
1805 * New inodes set I_NEW. If two processes both create
1806 * the same inode, one of them will release its inode and
1807 * wait for I_NEW to be released before returning.
1808 * Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can
1809 * also cause waiting on I_NEW, without I_NEW actually
1810 * being set. find_inode() uses this to prevent returning
1811 * nearly-dead inodes.
1c0eeaf5
JE
1812 * I_WILL_FREE Must be set when calling write_inode_now() if i_count
1813 * is zero. I_FREEING must be set when I_WILL_FREE is
1814 * cleared.
1815 * I_FREEING Set when inode is about to be freed but still has dirty
1816 * pages or buffers attached or the inode itself is still
1817 * dirty.
dbd5768f
JK
1818 * I_CLEAR Added by clear_inode(). In this state the inode is
1819 * clean and can be destroyed. Inode keeps I_FREEING.
1c0eeaf5
JE
1820 *
1821 * Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are
1822 * prohibited for many purposes. iget() must wait for
1823 * the inode to be completely released, then create it
1824 * anew. Other functions will just ignore such inodes,
eaff8079 1825 * if appropriate. I_NEW is used for waiting.
1c0eeaf5 1826 *
169ebd90
JK
1827 * I_SYNC Writeback of inode is running. The bit is set during
1828 * data writeback, and cleared with a wakeup on the bit
1829 * address once it is done. The bit is also used to pin
1830 * the inode in memory for flusher thread.
1c0eeaf5 1831 *
bd5fe6c5
CH
1832 * I_REFERENCED Marks the inode as recently references on the LRU list.
1833 *
1834 * I_DIO_WAKEUP Never set. Only used as a key for wait_on_bit().
1835 *
682aa8e1
TH
1836 * I_WB_SWITCH Cgroup bdi_writeback switching in progress. Used to
1837 * synchronize competing switching instances and to tell
1838 * wb stat updates to grab mapping->tree_lock. See
1839 * inode_switch_wb_work_fn() for details.
1840 *
1c0eeaf5 1841 * Q: What is the difference between I_WILL_FREE and I_FREEING?
1c0eeaf5 1842 */
9e38d86f
NP
1843#define I_DIRTY_SYNC (1 << 0)
1844#define I_DIRTY_DATASYNC (1 << 1)
1845#define I_DIRTY_PAGES (1 << 2)
eaff8079
CH
1846#define __I_NEW 3
1847#define I_NEW (1 << __I_NEW)
9e38d86f
NP
1848#define I_WILL_FREE (1 << 4)
1849#define I_FREEING (1 << 5)
1850#define I_CLEAR (1 << 6)
eaff8079 1851#define __I_SYNC 7
1c0eeaf5 1852#define I_SYNC (1 << __I_SYNC)
9e38d86f 1853#define I_REFERENCED (1 << 8)
bd5fe6c5 1854#define __I_DIO_WAKEUP 9
ac74d8d6 1855#define I_DIO_WAKEUP (1 << __I_DIO_WAKEUP)
f4e0c30c 1856#define I_LINKABLE (1 << 10)
0ae45f63
TT
1857#define I_DIRTY_TIME (1 << 11)
1858#define __I_DIRTY_TIME_EXPIRED 12
1859#define I_DIRTY_TIME_EXPIRED (1 << __I_DIRTY_TIME_EXPIRED)
682aa8e1 1860#define I_WB_SWITCH (1 << 13)
1da177e4
LT
1861
1862#define I_DIRTY (I_DIRTY_SYNC | I_DIRTY_DATASYNC | I_DIRTY_PAGES)
0ae45f63 1863#define I_DIRTY_ALL (I_DIRTY | I_DIRTY_TIME)
1da177e4
LT
1864
1865extern void __mark_inode_dirty(struct inode *, int);
1866static inline void mark_inode_dirty(struct inode *inode)
1867{
1868 __mark_inode_dirty(inode, I_DIRTY);
1869}
1870
1871static inline void mark_inode_dirty_sync(struct inode *inode)
1872{
1873 __mark_inode_dirty(inode, I_DIRTY_SYNC);
1874}
1875
7ada4db8
MS
1876extern void inc_nlink(struct inode *inode);
1877extern void drop_nlink(struct inode *inode);
1878extern void clear_nlink(struct inode *inode);
1879extern void set_nlink(struct inode *inode, unsigned int nlink);
d8c76e6f
DH
1880
1881static inline void inode_inc_link_count(struct inode *inode)
1882{
1883 inc_nlink(inode);
66d21730
AD
1884 mark_inode_dirty(inode);
1885}
1886
9a53c3a7
DH
1887static inline void inode_dec_link_count(struct inode *inode)
1888{
1889 drop_nlink(inode);
66d21730
AD
1890 mark_inode_dirty(inode);
1891}
1892
25ec56b5
JNC
1893/**
1894 * inode_inc_iversion - increments i_version
1895 * @inode: inode that need to be updated
1896 *
1897 * Every time the inode is modified, the i_version field will be incremented.
1898 * The filesystem has to be mounted with i_version flag
1899 */
1900
1901static inline void inode_inc_iversion(struct inode *inode)
1902{
1903 spin_lock(&inode->i_lock);
1904 inode->i_version++;
1905 spin_unlock(&inode->i_lock);
1906}
1907
c3b2da31
JB
1908enum file_time_flags {
1909 S_ATIME = 1,
1910 S_MTIME = 2,
1911 S_CTIME = 4,
1912 S_VERSION = 8,
1913};
1914
8fa9dd24 1915extern bool atime_needs_update(const struct path *, struct inode *);
badcf2b7 1916extern void touch_atime(const struct path *);
1da177e4
LT
1917static inline void file_accessed(struct file *file)
1918{
1919 if (!(file->f_flags & O_NOATIME))
68ac1234 1920 touch_atime(&file->f_path);
1da177e4
LT
1921}
1922
1923int sync_inode(struct inode *inode, struct writeback_control *wbc);
c3765016 1924int sync_inode_metadata(struct inode *inode, int wait);
1da177e4 1925
1da177e4
LT
1926struct file_system_type {
1927 const char *name;
1928 int fs_flags;
bbc1096a
DH
1929#define FS_REQUIRES_DEV 1
1930#define FS_BINARY_MOUNTDATA 2
1931#define FS_HAS_SUBTYPE 4
0c55cfc4
EB
1932#define FS_USERNS_MOUNT 8 /* Can be mounted by userns root */
1933#define FS_USERNS_DEV_MOUNT 16 /* A userns mount does not imply MNT_NODEV */
1b852bce 1934#define FS_USERNS_VISIBLE 32 /* FS must already be visible */
bbc1096a 1935#define FS_RENAME_DOES_D_MOVE 32768 /* FS will handle d_move() during rename() internally. */
c96e41e9
AV
1936 struct dentry *(*mount) (struct file_system_type *, int,
1937 const char *, void *);
1da177e4
LT
1938 void (*kill_sb) (struct super_block *);
1939 struct module *owner;
1940 struct file_system_type * next;
a5166169 1941 struct hlist_head fs_supers;
d475fd42 1942
cf516249 1943 struct lock_class_key s_lock_key;
897c6ff9 1944 struct lock_class_key s_umount_key;
51ee049e 1945 struct lock_class_key s_vfs_rename_key;
5accdf82 1946 struct lock_class_key s_writers_key[SB_FREEZE_LEVELS];
d475fd42
PZ
1947
1948 struct lock_class_key i_lock_key;
1949 struct lock_class_key i_mutex_key;
14358e6d 1950 struct lock_class_key i_mutex_dir_key;
1da177e4
LT
1951};
1952
7f78e035
EB
1953#define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME)
1954
ceefda69
AV
1955extern struct dentry *mount_ns(struct file_system_type *fs_type, int flags,
1956 void *data, int (*fill_super)(struct super_block *, void *, int));
152a0836
AV
1957extern struct dentry *mount_bdev(struct file_system_type *fs_type,
1958 int flags, const char *dev_name, void *data,
1959 int (*fill_super)(struct super_block *, void *, int));
fc14f2fe
AV
1960extern struct dentry *mount_single(struct file_system_type *fs_type,
1961 int flags, void *data,
1962 int (*fill_super)(struct super_block *, void *, int));
3c26ff6e
AV
1963extern struct dentry *mount_nodev(struct file_system_type *fs_type,
1964 int flags, void *data,
1965 int (*fill_super)(struct super_block *, void *, int));
ea441d11 1966extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
1da177e4
LT
1967void generic_shutdown_super(struct super_block *sb);
1968void kill_block_super(struct super_block *sb);
1969void kill_anon_super(struct super_block *sb);
1970void kill_litter_super(struct super_block *sb);
1971void deactivate_super(struct super_block *sb);
74dbbdd7 1972void deactivate_locked_super(struct super_block *sb);
1da177e4 1973int set_anon_super(struct super_block *s, void *data);
0ee5dc67
AV
1974int get_anon_bdev(dev_t *);
1975void free_anon_bdev(dev_t);
1da177e4
LT
1976struct super_block *sget(struct file_system_type *type,
1977 int (*test)(struct super_block *,void *),
1978 int (*set)(struct super_block *,void *),
9249e17f 1979 int flags, void *data);
51139ada 1980extern struct dentry *mount_pseudo(struct file_system_type *, char *,
c74a1cbb
AV
1981 const struct super_operations *ops,
1982 const struct dentry_operations *dops,
1983 unsigned long);
1da177e4
LT
1984
1985/* Alas, no aliases. Too much hassle with bringing module.h everywhere */
1986#define fops_get(fops) \
1987 (((fops) && try_module_get((fops)->owner) ? (fops) : NULL))
1988#define fops_put(fops) \
1989 do { if (fops) module_put((fops)->owner); } while(0)
e84f9e57
AV
1990/*
1991 * This one is to be used *ONLY* from ->open() instances.
1992 * fops must be non-NULL, pinned down *and* module dependencies
1993 * should be sufficient to pin the caller down as well.
1994 */
1995#define replace_fops(f, fops) \
1996 do { \
1997 struct file *__file = (f); \
1998 fops_put(__file->f_op); \
1999 BUG_ON(!(__file->f_op = (fops))); \
2000 } while(0)
1da177e4
LT
2001
2002extern int register_filesystem(struct file_system_type *);
2003extern int unregister_filesystem(struct file_system_type *);
8bf9725c
PE
2004extern struct vfsmount *kern_mount_data(struct file_system_type *, void *data);
2005#define kern_mount(type) kern_mount_data(type, NULL)
423e0ab0 2006extern void kern_unmount(struct vfsmount *mnt);
1da177e4
LT
2007extern int may_umount_tree(struct vfsmount *);
2008extern int may_umount(struct vfsmount *);
5e6123f3
SL
2009extern long do_mount(const char *, const char __user *,
2010 const char *, unsigned long, void *);
589ff870 2011extern struct vfsmount *collect_mounts(struct path *);
8aec0809 2012extern void drop_collected_mounts(struct vfsmount *);
1f707137
AV
2013extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
2014 struct vfsmount *);
ebabe9a9 2015extern int vfs_statfs(struct path *, struct kstatfs *);
c8b91acc
AV
2016extern int user_statfs(const char __user *, struct kstatfs *);
2017extern int fd_statfs(int, struct kstatfs *);
cf31e70d 2018extern int vfs_ustat(dev_t, struct kstatfs *);
18e9e510
JB
2019extern int freeze_super(struct super_block *super);
2020extern int thaw_super(struct super_block *super);
02125a82 2021extern bool our_mnt(struct vfsmount *mnt);
1da177e4 2022
ce3b0f8d
AV
2023extern int current_umask(void);
2024
5a14696c
BF
2025extern void ihold(struct inode * inode);
2026extern void iput(struct inode *);
0ae45f63 2027extern int generic_update_time(struct inode *, struct timespec *, int);
5a14696c 2028
f87fd4c2 2029/* /sys/fs */
00d26666 2030extern struct kobject *fs_kobj;
f87fd4c2 2031
435f49a5 2032#define MAX_RW_COUNT (INT_MAX & PAGE_CACHE_MASK)
bfcd17a6 2033
1da177e4
LT
2034#define FLOCK_VERIFY_READ 1
2035#define FLOCK_VERIFY_WRITE 2
2036
bfcd17a6 2037#ifdef CONFIG_FILE_LOCKING
d7a06983 2038extern int locks_mandatory_locked(struct file *);
1da177e4
LT
2039extern int locks_mandatory_area(int, struct inode *, struct file *, loff_t, size_t);
2040
2041/*
2042 * Candidates for mandatory locking have the setgid bit set
2043 * but no group execute bit - an otherwise meaningless combination.
2044 */
a16877ca
PE
2045
2046static inline int __mandatory_lock(struct inode *ino)
2047{
2048 return (ino->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID;
2049}
2050
2051/*
2052 * ... and these candidates should be on MS_MANDLOCK mounted fs,
2053 * otherwise these will be advisory locks
2054 */
2055
2056static inline int mandatory_lock(struct inode *ino)
2057{
2058 return IS_MANDLOCK(ino) && __mandatory_lock(ino);
2059}
1da177e4 2060
d7a06983 2061static inline int locks_verify_locked(struct file *file)
1da177e4 2062{
d7a06983
JL
2063 if (mandatory_lock(file_inode(file)))
2064 return locks_mandatory_locked(file);
1da177e4
LT
2065 return 0;
2066}
2067
1da177e4
LT
2068static inline int locks_verify_truncate(struct inode *inode,
2069 struct file *filp,
2070 loff_t size)
2071{
bd61e0a9 2072 if (inode->i_flctx && mandatory_lock(inode))
1da177e4
LT
2073 return locks_mandatory_area(
2074 FLOCK_VERIFY_WRITE, inode, filp,
2075 size < inode->i_size ? size : inode->i_size,
2076 (size < inode->i_size ? inode->i_size - size
2077 : size - inode->i_size)
2078 );
2079 return 0;
2080}
2081
2082static inline int break_lease(struct inode *inode, unsigned int mode)
2083{
24cbe784
JL
2084 /*
2085 * Since this check is lockless, we must ensure that any refcounts
8116bf4c
JL
2086 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2087 * could end up racing with tasks trying to set a new lease on this
2088 * file.
24cbe784
JL
2089 */
2090 smp_mb();
8634b51f 2091 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
df4e8d2c 2092 return __break_lease(inode, mode, FL_LEASE);
1da177e4
LT
2093 return 0;
2094}
df4e8d2c
BF
2095
2096static inline int break_deleg(struct inode *inode, unsigned int mode)
2097{
962bd40b
JL
2098 /*
2099 * Since this check is lockless, we must ensure that any refcounts
8116bf4c
JL
2100 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2101 * could end up racing with tasks trying to set a new lease on this
2102 * file.
962bd40b
JL
2103 */
2104 smp_mb();
8634b51f 2105 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
df4e8d2c 2106 return __break_lease(inode, mode, FL_DELEG);
1da177e4
LT
2107 return 0;
2108}
df4e8d2c 2109
5a14696c
BF
2110static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2111{
2112 int ret;
2113
2114 ret = break_deleg(inode, O_WRONLY|O_NONBLOCK);
2115 if (ret == -EWOULDBLOCK && delegated_inode) {
2116 *delegated_inode = inode;
2117 ihold(inode);
2118 }
2119 return ret;
2120}
2121
2122static inline int break_deleg_wait(struct inode **delegated_inode)
2123{
2124 int ret;
2125
2126 ret = break_deleg(*delegated_inode, O_WRONLY);
2127 iput(*delegated_inode);
2128 *delegated_inode = NULL;
2129 return ret;
2130}
2131
11afe9f7
CH
2132static inline int break_layout(struct inode *inode, bool wait)
2133{
2134 smp_mb();
2135 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2136 return __break_lease(inode,
2137 wait ? O_WRONLY : O_WRONLY | O_NONBLOCK,
2138 FL_LAYOUT);
2139 return 0;
2140}
2141
bfcd17a6 2142#else /* !CONFIG_FILE_LOCKING */
d7a06983 2143static inline int locks_mandatory_locked(struct file *file)
af5df566
SW
2144{
2145 return 0;
2146}
2147
2148static inline int locks_mandatory_area(int rw, struct inode *inode,
2149 struct file *filp, loff_t offset,
2150 size_t count)
2151{
2152 return 0;
2153}
2154
2155static inline int __mandatory_lock(struct inode *inode)
2156{
2157 return 0;
2158}
2159
2160static inline int mandatory_lock(struct inode *inode)
2161{
2162 return 0;
2163}
2164
d7a06983 2165static inline int locks_verify_locked(struct file *file)
af5df566
SW
2166{
2167 return 0;
2168}
2169
2170static inline int locks_verify_truncate(struct inode *inode, struct file *filp,
2171 size_t size)
2172{
2173 return 0;
2174}
2175
2176static inline int break_lease(struct inode *inode, unsigned int mode)
2177{
2178 return 0;
2179}
2180
df4e8d2c
BF
2181static inline int break_deleg(struct inode *inode, unsigned int mode)
2182{
2183 return 0;
2184}
5a14696c
BF
2185
2186static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2187{
2188 return 0;
2189}
2190
2191static inline int break_deleg_wait(struct inode **delegated_inode)
2192{
2193 BUG();
2194 return 0;
2195}
2196
11afe9f7
CH
2197static inline int break_layout(struct inode *inode, bool wait)
2198{
2199 return 0;
2200}
2201
bfcd17a6 2202#endif /* CONFIG_FILE_LOCKING */
1da177e4
LT
2203
2204/* fs/open.c */
adb5c247 2205struct audit_names;
91a27b2a 2206struct filename {
adb5c247
JL
2207 const char *name; /* pointer to actual string */
2208 const __user char *uptr; /* original userland pointer */
2209 struct audit_names *aname;
55422d0b 2210 int refcnt;
fd2f7cb5 2211 const char iname[];
91a27b2a 2212};
1da177e4 2213
a02de960 2214extern long vfs_truncate(struct path *, loff_t);
4a30131e
N
2215extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
2216 struct file *filp);
72c72bdf 2217extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
3e63cbb1 2218 loff_t len);
8e8a1407 2219extern long do_sys_open(int dfd, const char __user *filename, int flags,
a218d0fd 2220 umode_t mode);
669abf4e 2221extern struct file *file_open_name(struct filename *, int, umode_t);
a218d0fd 2222extern struct file *filp_open(const char *, int, umode_t);
73d049a4
AV
2223extern struct file *file_open_root(struct dentry *, struct vfsmount *,
2224 const char *, int);
765927b2 2225extern struct file * dentry_open(const struct path *, int, const struct cred *);
1da177e4 2226extern int filp_close(struct file *, fl_owner_t id);
91a27b2a 2227
51f39a1f 2228extern struct filename *getname_flags(const char __user *, int, int *);
91a27b2a 2229extern struct filename *getname(const char __user *);
c4ad8f98 2230extern struct filename *getname_kernel(const char *);
55422d0b 2231extern void putname(struct filename *name);
91a27b2a 2232
47237687
AV
2233enum {
2234 FILE_CREATED = 1,
2235 FILE_OPENED = 2
2236};
30d90494
AV
2237extern int finish_open(struct file *file, struct dentry *dentry,
2238 int (*open)(struct inode *, struct file *),
2239 int *opened);
e45198a6 2240extern int finish_no_open(struct file *file, struct dentry *dentry);
1da177e4 2241
3e63cbb1
AJ
2242/* fs/ioctl.c */
2243
2244extern int ioctl_preallocate(struct file *filp, void __user *argp);
2245
1da177e4
LT
2246/* fs/dcache.c */
2247extern void __init vfs_caches_init_early(void);
2248extern void __init vfs_caches_init(unsigned long);
2249
b86c089b
CL
2250extern struct kmem_cache *names_cachep;
2251
a608ca21 2252#define __getname() kmem_cache_alloc(names_cachep, GFP_KERNEL)
3446a8aa 2253#define __putname(name) kmem_cache_free(names_cachep, (void *)(name))
1da177e4 2254
9361401e 2255#ifdef CONFIG_BLOCK
1da177e4 2256extern int register_blkdev(unsigned int, const char *);
f4480240 2257extern void unregister_blkdev(unsigned int, const char *);
1da177e4 2258extern struct block_device *bdget(dev_t);
dddac6a7 2259extern struct block_device *bdgrab(struct block_device *bdev);
1da177e4
LT
2260extern void bd_set_size(struct block_device *, loff_t size);
2261extern void bd_forget(struct inode *inode);
2262extern void bdput(struct block_device *);
585d3bc0 2263extern void invalidate_bdev(struct block_device *);
5c0d6b60 2264extern void iterate_bdevs(void (*)(struct block_device *, void *), void *);
585d3bc0 2265extern int sync_blockdev(struct block_device *bdev);
ff01bb48 2266extern void kill_bdev(struct block_device *);
585d3bc0 2267extern struct super_block *freeze_bdev(struct block_device *);
c2d75438 2268extern void emergency_thaw_all(void);
585d3bc0
NP
2269extern int thaw_bdev(struct block_device *bdev, struct super_block *sb);
2270extern int fsync_bdev(struct block_device *);
a212b105
TH
2271
2272extern struct super_block *blockdev_superblock;
2273
2274static inline bool sb_is_blkdev_sb(struct super_block *sb)
2275{
2276 return sb == blockdev_superblock;
2277}
9361401e
DH
2278#else
2279static inline void bd_forget(struct inode *inode) {}
47e4491b 2280static inline int sync_blockdev(struct block_device *bdev) { return 0; }
ff01bb48 2281static inline void kill_bdev(struct block_device *bdev) {}
47e4491b
AV
2282static inline void invalidate_bdev(struct block_device *bdev) {}
2283
2284static inline struct super_block *freeze_bdev(struct block_device *sb)
2285{
2286 return NULL;
2287}
2288
2289static inline int thaw_bdev(struct block_device *bdev, struct super_block *sb)
2290{
2291 return 0;
2292}
5c0d6b60
JK
2293
2294static inline void iterate_bdevs(void (*f)(struct block_device *, void *), void *arg)
2295{
2296}
a8855990
JK
2297
2298static inline int sb_is_blkdev_sb(struct super_block *sb)
2299{
2300 return 0;
2301}
9361401e 2302#endif
60b0680f 2303extern int sync_filesystem(struct super_block *);
9361401e 2304extern const struct file_operations def_blk_fops;
4b6f5d20 2305extern const struct file_operations def_chr_fops;
9361401e 2306#ifdef CONFIG_BLOCK
1da177e4 2307extern int ioctl_by_bdev(struct block_device *, unsigned, unsigned long);
56b26add 2308extern int blkdev_ioctl(struct block_device *, fmode_t, unsigned, unsigned long);
1da177e4 2309extern long compat_blkdev_ioctl(struct file *, unsigned, unsigned long);
e525fd89 2310extern int blkdev_get(struct block_device *bdev, fmode_t mode, void *holder);
d4d77629
TH
2311extern struct block_device *blkdev_get_by_path(const char *path, fmode_t mode,
2312 void *holder);
2313extern struct block_device *blkdev_get_by_dev(dev_t dev, fmode_t mode,
2314 void *holder);
4385bab1 2315extern void blkdev_put(struct block_device *bdev, fmode_t mode);
be324177
JW
2316extern int __blkdev_reread_part(struct block_device *bdev);
2317extern int blkdev_reread_part(struct block_device *bdev);
2318
641dc636 2319#ifdef CONFIG_SYSFS
e09b457b 2320extern int bd_link_disk_holder(struct block_device *bdev, struct gendisk *disk);
49731baa
TH
2321extern void bd_unlink_disk_holder(struct block_device *bdev,
2322 struct gendisk *disk);
641dc636 2323#else
e09b457b
TH
2324static inline int bd_link_disk_holder(struct block_device *bdev,
2325 struct gendisk *disk)
2326{
2327 return 0;
2328}
49731baa
TH
2329static inline void bd_unlink_disk_holder(struct block_device *bdev,
2330 struct gendisk *disk)
2331{
2332}
641dc636 2333#endif
9361401e 2334#endif
1da177e4
LT
2335
2336/* fs/char_dev.c */
68eef3b4 2337#define CHRDEV_MAJOR_HASH_SIZE 255
1da177e4
LT
2338extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
2339extern int register_chrdev_region(dev_t, unsigned, const char *);
1905b1bf
TH
2340extern int __register_chrdev(unsigned int major, unsigned int baseminor,
2341 unsigned int count, const char *name,
2342 const struct file_operations *fops);
2343extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
2344 unsigned int count, const char *name);
1da177e4 2345extern void unregister_chrdev_region(dev_t, unsigned);
68eef3b4 2346extern void chrdev_show(struct seq_file *,off_t);
1da177e4 2347
1905b1bf
TH
2348static inline int register_chrdev(unsigned int major, const char *name,
2349 const struct file_operations *fops)
2350{
2351 return __register_chrdev(major, 0, 256, name, fops);
2352}
2353
2354static inline void unregister_chrdev(unsigned int major, const char *name)
2355{
2356 __unregister_chrdev(major, 0, 256, name);
2357}
2358
1da177e4
LT
2359/* fs/block_dev.c */
2360#define BDEVNAME_SIZE 32 /* Largest string for a blockdev identifier */
1f014290 2361#define BDEVT_SIZE 10 /* Largest string for MAJ:MIN for blkdev */
9361401e
DH
2362
2363#ifdef CONFIG_BLOCK
2364#define BLKDEV_MAJOR_HASH_SIZE 255
1da177e4
LT
2365extern const char *__bdevname(dev_t, char *buffer);
2366extern const char *bdevname(struct block_device *bdev, char *buffer);
2367extern struct block_device *lookup_bdev(const char *);
68eef3b4 2368extern void blkdev_show(struct seq_file *,off_t);
30c40d2c 2369
9361401e
DH
2370#else
2371#define BLKDEV_MAJOR_HASH_SIZE 0
2372#endif
1da177e4
LT
2373
2374extern void init_special_inode(struct inode *, umode_t, dev_t);
2375
2376/* Invalid inode operations -- fs/bad_inode.c */
2377extern void make_bad_inode(struct inode *);
2378extern int is_bad_inode(struct inode *);
2379
9361401e 2380#ifdef CONFIG_BLOCK
1da177e4
LT
2381/*
2382 * return READ, READA, or WRITE
2383 */
2384#define bio_rw(bio) ((bio)->bi_rw & (RW_MASK | RWA_MASK))
2385
2386/*
2387 * return data direction, READ or WRITE
2388 */
2389#define bio_data_dir(bio) ((bio)->bi_rw & 1)
2390
c3279d14
AP
2391extern void check_disk_size_change(struct gendisk *disk,
2392 struct block_device *bdev);
0c002c2f 2393extern int revalidate_disk(struct gendisk *);
1da177e4 2394extern int check_disk_change(struct block_device *);
93b270f7 2395extern int __invalidate_device(struct block_device *, bool);
1da177e4 2396extern int invalidate_partition(struct gendisk *, int);
9361401e 2397#endif
1da177e4
LT
2398unsigned long invalidate_mapping_pages(struct address_space *mapping,
2399 pgoff_t start, pgoff_t end);
54bc4855 2400
1da177e4
LT
2401static inline void invalidate_remote_inode(struct inode *inode)
2402{
2403 if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
2404 S_ISLNK(inode->i_mode))
fc0ecff6 2405 invalidate_mapping_pages(inode->i_mapping, 0, -1);
1da177e4
LT
2406}
2407extern int invalidate_inode_pages2(struct address_space *mapping);
2408extern int invalidate_inode_pages2_range(struct address_space *mapping,
2409 pgoff_t start, pgoff_t end);
2410extern int write_inode_now(struct inode *, int);
2411extern int filemap_fdatawrite(struct address_space *);
2412extern int filemap_flush(struct address_space *);
2413extern int filemap_fdatawait(struct address_space *);
d3bccb6f
JK
2414extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
2415 loff_t lend);
1da177e4
LT
2416extern int filemap_write_and_wait(struct address_space *mapping);
2417extern int filemap_write_and_wait_range(struct address_space *mapping,
2418 loff_t lstart, loff_t lend);
ebcf28e1
AM
2419extern int __filemap_fdatawrite_range(struct address_space *mapping,
2420 loff_t start, loff_t end, int sync_mode);
f4c0a0fd
JK
2421extern int filemap_fdatawrite_range(struct address_space *mapping,
2422 loff_t start, loff_t end);
ebcf28e1 2423
8018ab05
CH
2424extern int vfs_fsync_range(struct file *file, loff_t start, loff_t end,
2425 int datasync);
2426extern int vfs_fsync(struct file *file, int datasync);
d311d79d
AV
2427static inline int generic_write_sync(struct file *file, loff_t pos, loff_t count)
2428{
2429 if (!(file->f_flags & O_DSYNC) && !IS_SYNC(file->f_mapping->host))
2430 return 0;
2431 return vfs_fsync_range(file, pos, pos + count - 1,
2432 (file->f_flags & __O_SYNC) ? 0 : 1);
2433}
1da177e4
LT
2434extern void emergency_sync(void);
2435extern void emergency_remount(void);
9361401e 2436#ifdef CONFIG_BLOCK
1da177e4 2437extern sector_t bmap(struct inode *, sector_t);
9361401e 2438#endif
27ac0ffe 2439extern int notify_change(struct dentry *, struct iattr *, struct inode **);
f419a2e3 2440extern int inode_permission(struct inode *, int);
bd5d0856 2441extern int __inode_permission(struct inode *, int);
2830ba7f 2442extern int generic_permission(struct inode *, int);
cbdf35bc 2443extern int __check_sticky(struct inode *dir, struct inode *inode);
1da177e4 2444
f696a365
MS
2445static inline bool execute_ok(struct inode *inode)
2446{
2447 return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
2448}
2449
8d71db4f
AV
2450static inline void file_start_write(struct file *file)
2451{
2452 if (!S_ISREG(file_inode(file)->i_mode))
2453 return;
2454 __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, true);
2455}
2456
5ae98f15
JK
2457static inline bool file_start_write_trylock(struct file *file)
2458{
2459 if (!S_ISREG(file_inode(file)->i_mode))
2460 return true;
2461 return __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, false);
2462}
2463
8d71db4f
AV
2464static inline void file_end_write(struct file *file)
2465{
2466 if (!S_ISREG(file_inode(file)->i_mode))
2467 return;
2468 __sb_end_write(file_inode(file)->i_sb, SB_FREEZE_WRITE);
2469}
2470
07b8ce1e
AV
2471/*
2472 * get_write_access() gets write permission for a file.
2473 * put_write_access() releases this write permission.
2474 * This is used for regular files.
2475 * We cannot support write (and maybe mmap read-write shared) accesses and
2476 * MAP_DENYWRITE mmappings simultaneously. The i_writecount field of an inode
2477 * can have the following values:
2478 * 0: no writers, no VM_DENYWRITE mappings
2479 * < 0: (-i_writecount) vm_area_structs with VM_DENYWRITE set exist
2480 * > 0: (i_writecount) users are writing to the file.
2481 *
2482 * Normally we operate on that counter with atomic_{inc,dec} and it's safe
2483 * except for the cases where we don't hold i_writecount yet. Then we need to
2484 * use {get,deny}_write_access() - these functions check the sign and refuse
2485 * to do the change if sign is wrong.
2486 */
2487static inline int get_write_access(struct inode *inode)
2488{
2489 return atomic_inc_unless_negative(&inode->i_writecount) ? 0 : -ETXTBSY;
2490}
2491static inline int deny_write_access(struct file *file)
2492{
496ad9aa 2493 struct inode *inode = file_inode(file);
07b8ce1e
AV
2494 return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
2495}
1da177e4
LT
2496static inline void put_write_access(struct inode * inode)
2497{
2498 atomic_dec(&inode->i_writecount);
2499}
2500static inline void allow_write_access(struct file *file)
2501{
2502 if (file)
496ad9aa 2503 atomic_inc(&file_inode(file)->i_writecount);
1da177e4 2504}
f1fe29b4
DH
2505static inline bool inode_is_open_for_write(const struct inode *inode)
2506{
2507 return atomic_read(&inode->i_writecount) > 0;
2508}
2509
a5c96ebf
MZ
2510#ifdef CONFIG_IMA
2511static inline void i_readcount_dec(struct inode *inode)
2512{
2513 BUG_ON(!atomic_read(&inode->i_readcount));
2514 atomic_dec(&inode->i_readcount);
2515}
2516static inline void i_readcount_inc(struct inode *inode)
2517{
2518 atomic_inc(&inode->i_readcount);
2519}
2520#else
2521static inline void i_readcount_dec(struct inode *inode)
2522{
2523 return;
2524}
2525static inline void i_readcount_inc(struct inode *inode)
2526{
2527 return;
2528}
2529#endif
ed8cae8b 2530extern int do_pipe_flags(int *, int);
1da177e4 2531
6777d773 2532extern int kernel_read(struct file *, loff_t, char *, unsigned long);
7bb307e8 2533extern ssize_t kernel_write(struct file *, const char *, size_t, loff_t);
ed44724b 2534extern ssize_t __kernel_write(struct file *, const char *, size_t, loff_t *);
1da177e4
LT
2535extern struct file * open_exec(const char *);
2536
2537/* fs/dcache.c -- generic fs support functions */
2538extern int is_subdir(struct dentry *, struct dentry *);
2096f759 2539extern int path_is_under(struct path *, struct path *);
1da177e4 2540
9bf39ab2
MS
2541extern char *file_path(struct file *, char *, int);
2542
1da177e4
LT
2543#include <linux/err.h>
2544
2545/* needed for stackable file system support */
965c8e59 2546extern loff_t default_llseek(struct file *file, loff_t offset, int whence);
1da177e4 2547
965c8e59 2548extern loff_t vfs_llseek(struct file *file, loff_t offset, int whence);
1da177e4 2549
54e34621 2550extern int inode_init_always(struct super_block *, struct inode *);
1da177e4 2551extern void inode_init_once(struct inode *);
2aa15890 2552extern void address_space_init_once(struct address_space *mapping);
1da177e4
LT
2553extern struct inode * igrab(struct inode *);
2554extern ino_t iunique(struct super_block *, ino_t);
2555extern int inode_needs_sync(struct inode *inode);
45321ac5 2556extern int generic_delete_inode(struct inode *inode);
9bcb4b73
AV
2557static inline int generic_drop_inode(struct inode *inode)
2558{
2559 return !inode->i_nlink || inode_unhashed(inode);
2560}
1da177e4 2561
88bd5121
AA
2562extern struct inode *ilookup5_nowait(struct super_block *sb,
2563 unsigned long hashval, int (*test)(struct inode *, void *),
2564 void *data);
1da177e4
LT
2565extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
2566 int (*test)(struct inode *, void *), void *data);
2567extern struct inode *ilookup(struct super_block *sb, unsigned long ino);
2568
2569extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *);
2570extern struct inode * iget_locked(struct super_block *, unsigned long);
fe032c42
TT
2571extern struct inode *find_inode_nowait(struct super_block *,
2572 unsigned long,
2573 int (*match)(struct inode *,
2574 unsigned long, void *),
2575 void *data);
261bca86
AV
2576extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
2577extern int insert_inode_locked(struct inode *);
e096d0c7
JB
2578#ifdef CONFIG_DEBUG_LOCK_ALLOC
2579extern void lockdep_annotate_inode_mutex_key(struct inode *inode);
2580#else
2581static inline void lockdep_annotate_inode_mutex_key(struct inode *inode) { };
2582#endif
1da177e4 2583extern void unlock_new_inode(struct inode *);
85fe4025 2584extern unsigned int get_next_ino(void);
1da177e4 2585
1da177e4 2586extern void __iget(struct inode * inode);
b46980fe 2587extern void iget_failed(struct inode *);
dbd5768f 2588extern void clear_inode(struct inode *);
2e00c97e 2589extern void __destroy_inode(struct inode *);
a209dfc7
ED
2590extern struct inode *new_inode_pseudo(struct super_block *sb);
2591extern struct inode *new_inode(struct super_block *sb);
ff0c7d15 2592extern void free_inode_nonrcu(struct inode *inode);
01de85e0 2593extern int should_remove_suid(struct dentry *);
5fa8e0a1 2594extern int file_remove_privs(struct file *);
45f147a1
JK
2595extern int dentry_needs_remove_privs(struct dentry *dentry);
2596static inline int file_needs_remove_privs(struct file *file)
2597{
2598 return dentry_needs_remove_privs(file->f_path.dentry);
2599}
1da177e4
LT
2600
2601extern void __insert_inode_hash(struct inode *, unsigned long hashval);
646ec461
CH
2602static inline void insert_inode_hash(struct inode *inode)
2603{
1da177e4
LT
2604 __insert_inode_hash(inode, inode->i_ino);
2605}
f2ee7abf
ED
2606
2607extern void __remove_inode_hash(struct inode *);
2608static inline void remove_inode_hash(struct inode *inode)
2609{
2610 if (!inode_unhashed(inode))
2611 __remove_inode_hash(inode);
2612}
2613
646ec461 2614extern void inode_sb_list_add(struct inode *inode);
1da177e4 2615
9361401e 2616#ifdef CONFIG_BLOCK
1da177e4
LT
2617extern void submit_bio(int, struct bio *);
2618extern int bdev_read_only(struct block_device *);
9361401e 2619#endif
1da177e4
LT
2620extern int set_blocksize(struct block_device *, int);
2621extern int sb_set_blocksize(struct super_block *, int);
2622extern int sb_min_blocksize(struct super_block *, int);
2623
2624extern int generic_file_mmap(struct file *, struct vm_area_struct *);
2625extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
3309dd04 2626extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *);
ed978a81 2627extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
8174202b 2628extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
8174202b 2629extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
0c949334 2630extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *, loff_t);
3b93f911 2631extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t);
88e6faef 2632
dbe4e192
CH
2633ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos);
2634ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos);
2635
eef99380 2636/* fs/block_dev.c */
b2de525f 2637extern ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to);
1456c0a8 2638extern ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from);
02c24a82
JB
2639extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
2640 int datasync);
ff01bb48 2641extern void block_sync_page(struct page *page);
eef99380 2642
88e6faef 2643/* fs/splice.c */
cbb7e577 2644extern ssize_t generic_file_splice_read(struct file *, loff_t *,
88e6faef 2645 struct pipe_inode_info *, size_t, unsigned int);
6818173b
MS
2646extern ssize_t default_file_splice_read(struct file *, loff_t *,
2647 struct pipe_inode_info *, size_t, unsigned int);
8d020765 2648extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
cbb7e577 2649 struct file *, loff_t *, size_t, unsigned int);
88e6faef 2650extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
cbb7e577 2651 struct file *out, loff_t *, size_t len, unsigned int flags);
1c118596
MS
2652extern long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
2653 loff_t *opos, size_t len, unsigned int flags);
2654
88e6faef 2655
1da177e4
LT
2656extern void
2657file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
965c8e59
AM
2658extern loff_t noop_llseek(struct file *file, loff_t offset, int whence);
2659extern loff_t no_llseek(struct file *file, loff_t offset, int whence);
46a1c2c7 2660extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
965c8e59 2661extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
5760495a 2662extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
965c8e59 2663 int whence, loff_t maxsize, loff_t eof);
1bf9d14d
AV
2664extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
2665 int whence, loff_t size);
1da177e4
LT
2666extern int generic_file_open(struct inode * inode, struct file * filp);
2667extern int nonseekable_open(struct inode * inode, struct file * filp);
2668
a95cd631
OS
2669ssize_t dax_do_io(struct kiocb *, struct inode *, struct iov_iter *, loff_t,
2670 get_block_t, dio_iodone_t, int flags);
289c6aed 2671int dax_clear_blocks(struct inode *, sector_t block, long size);
25726bc1 2672int dax_zero_page_range(struct inode *, loff_t from, unsigned len, get_block_t);
4c0ccfef 2673int dax_truncate_page(struct inode *, loff_t from, get_block_t);
e842f290
DC
2674int dax_fault(struct vm_area_struct *, struct vm_fault *, get_block_t,
2675 dax_iodone_t);
ce5c5d55
DC
2676int __dax_fault(struct vm_area_struct *, struct vm_fault *, get_block_t,
2677 dax_iodone_t);
0e3b210c 2678int dax_pfn_mkwrite(struct vm_area_struct *, struct vm_fault *);
ce5c5d55
DC
2679#define dax_mkwrite(vma, vmf, gb, iod) dax_fault(vma, vmf, gb, iod)
2680#define __dax_mkwrite(vma, vmf, gb, iod) __dax_fault(vma, vmf, gb, iod)
d475c634 2681
9361401e 2682#ifdef CONFIG_BLOCK
facd07b0
JB
2683typedef void (dio_submit_t)(int rw, struct bio *bio, struct inode *inode,
2684 loff_t file_offset);
1da177e4
LT
2685
2686enum {
1e431f5c
CH
2687 /* need locking between buffered and direct access */
2688 DIO_LOCKING = 0x01,
2689
2690 /* filesystem does not support filling holes */
2691 DIO_SKIP_HOLES = 0x02,
60392573
CH
2692
2693 /* filesystem can handle aio writes beyond i_size */
2694 DIO_ASYNC_EXTEND = 0x04,
fe0f07d0
JA
2695
2696 /* inode/fs/bdev does not need truncate protection */
2697 DIO_SKIP_DIO_COUNT = 0x08,
1da177e4
LT
2698};
2699
eafdc7d1
CH
2700void dio_end_io(struct bio *bio, int error);
2701
17f8c842
OS
2702ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode,
2703 struct block_device *bdev, struct iov_iter *iter,
2704 loff_t offset, get_block_t get_block,
2705 dio_iodone_t end_io, dio_submit_t submit_io,
2706 int flags);
7bb46a67 2707
17f8c842
OS
2708static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
2709 struct inode *inode,
2710 struct iov_iter *iter, loff_t offset,
2711 get_block_t get_block)
1da177e4 2712{
17f8c842 2713 return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter,
31b14039 2714 offset, get_block, NULL, NULL,
1e431f5c 2715 DIO_LOCKING | DIO_SKIP_HOLES);
1da177e4 2716}
9361401e 2717#endif
1da177e4 2718
1d59d61f 2719void inode_dio_wait(struct inode *inode);
fe0f07d0
JA
2720
2721/*
2722 * inode_dio_begin - signal start of a direct I/O requests
2723 * @inode: inode the direct I/O happens on
2724 *
2725 * This is called once we've finished processing a direct I/O request,
2726 * and is used to wake up callers waiting for direct I/O to be quiesced.
2727 */
2728static inline void inode_dio_begin(struct inode *inode)
2729{
2730 atomic_inc(&inode->i_dio_count);
2731}
2732
2733/*
2734 * inode_dio_end - signal finish of a direct I/O requests
2735 * @inode: inode the direct I/O happens on
2736 *
2737 * This is called once we've finished processing a direct I/O request,
2738 * and is used to wake up callers waiting for direct I/O to be quiesced.
2739 */
2740static inline void inode_dio_end(struct inode *inode)
2741{
2742 if (atomic_dec_and_test(&inode->i_dio_count))
2743 wake_up_bit(&inode->i_state, __I_DIO_WAKEUP);
2744}
1d59d61f 2745
5f16f322
TT
2746extern void inode_set_flags(struct inode *inode, unsigned int flags,
2747 unsigned int mask);
2748
4b6f5d20 2749extern const struct file_operations generic_ro_fops;
1da177e4
LT
2750
2751#define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))
2752
5d826c84 2753extern int readlink_copy(char __user *, int, const char *);
1da177e4 2754extern int page_readlink(struct dentry *, char __user *, int);
6e77137b 2755extern const char *page_follow_link_light(struct dentry *, void **);
5f2c4179 2756extern void page_put_link(struct inode *, void *);
0adb25d2 2757extern int __page_symlink(struct inode *inode, const char *symname, int len,
54566b2c 2758 int nofs);
1da177e4 2759extern int page_symlink(struct inode *inode, const char *symname, int len);
c5ef1c42 2760extern const struct inode_operations page_symlink_inode_operations;
5f2c4179 2761extern void kfree_put_link(struct inode *, void *);
ecc087ff 2762extern void free_page_put_link(struct inode *, void *);
1da177e4
LT
2763extern int generic_readlink(struct dentry *, char __user *, int);
2764extern void generic_fillattr(struct inode *, struct kstat *);
b7a6ec52 2765int vfs_getattr_nosec(struct path *path, struct kstat *stat);
3dadecce 2766extern int vfs_getattr(struct path *, struct kstat *);
b462707e 2767void __inode_add_bytes(struct inode *inode, loff_t bytes);
1da177e4 2768void inode_add_bytes(struct inode *inode, loff_t bytes);
1c8924eb 2769void __inode_sub_bytes(struct inode *inode, loff_t bytes);
1da177e4
LT
2770void inode_sub_bytes(struct inode *inode, loff_t bytes);
2771loff_t inode_get_bytes(struct inode *inode);
2772void inode_set_bytes(struct inode *inode, loff_t bytes);
6e77137b 2773const char *simple_follow_link(struct dentry *, void **);
61ba64fc 2774extern const struct inode_operations simple_symlink_inode_operations;
1da177e4 2775
5c0ba4e0 2776extern int iterate_dir(struct file *, struct dir_context *);
1da177e4 2777
c7887325
DH
2778extern int vfs_stat(const char __user *, struct kstat *);
2779extern int vfs_lstat(const char __user *, struct kstat *);
1da177e4 2780extern int vfs_fstat(unsigned int, struct kstat *);
c7887325 2781extern int vfs_fstatat(int , const char __user *, struct kstat *, int);
1da177e4 2782
deb21db7
EZ
2783extern int do_vfs_ioctl(struct file *filp, unsigned int fd, unsigned int cmd,
2784 unsigned long arg);
e9079cce 2785extern int __generic_block_fiemap(struct inode *inode,
3a3076f4
JB
2786 struct fiemap_extent_info *fieinfo,
2787 loff_t start, loff_t len,
2788 get_block_t *get_block);
68c9d702
JB
2789extern int generic_block_fiemap(struct inode *inode,
2790 struct fiemap_extent_info *fieinfo, u64 start,
2791 u64 len, get_block_t *get_block);
1da177e4 2792
c18479fe
MS
2793extern void get_filesystem(struct file_system_type *fs);
2794extern void put_filesystem(struct file_system_type *fs);
1da177e4
LT
2795extern struct file_system_type *get_fs_type(const char *name);
2796extern struct super_block *get_super(struct block_device *);
6b6dc836 2797extern struct super_block *get_super_thawed(struct block_device *);
4504230a 2798extern struct super_block *get_active_super(struct block_device *bdev);
1da177e4 2799extern void drop_super(struct super_block *sb);
01a05b33 2800extern void iterate_supers(void (*)(struct super_block *, void *), void *);
43e15cdb
AV
2801extern void iterate_supers_type(struct file_system_type *,
2802 void (*)(struct super_block *, void *), void *);
1da177e4
LT
2803
2804extern int dcache_dir_open(struct inode *, struct file *);
2805extern int dcache_dir_close(struct inode *, struct file *);
2806extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
5f99f4e7 2807extern int dcache_readdir(struct file *, struct dir_context *);
7bb46a67 2808extern int simple_setattr(struct dentry *, struct iattr *);
1da177e4 2809extern int simple_getattr(struct vfsmount *, struct dentry *, struct kstat *);
726c3342 2810extern int simple_statfs(struct dentry *, struct kstatfs *);
20955e89 2811extern int simple_open(struct inode *inode, struct file *file);
1da177e4
LT
2812extern int simple_link(struct dentry *, struct inode *, struct dentry *);
2813extern int simple_unlink(struct inode *, struct dentry *);
2814extern int simple_rmdir(struct inode *, struct dentry *);
2815extern int simple_rename(struct inode *, struct dentry *, struct inode *, struct dentry *);
02c24a82 2816extern int noop_fsync(struct file *, loff_t, loff_t, int);
1da177e4
LT
2817extern int simple_empty(struct dentry *);
2818extern int simple_readpage(struct file *file, struct page *page);
afddba49
NP
2819extern int simple_write_begin(struct file *file, struct address_space *mapping,
2820 loff_t pos, unsigned len, unsigned flags,
2821 struct page **pagep, void **fsdata);
2822extern int simple_write_end(struct file *file, struct address_space *mapping,
2823 loff_t pos, unsigned len, unsigned copied,
2824 struct page *page, void *fsdata);
b26d4cd3 2825extern int always_delete_dentry(const struct dentry *);
6987843f 2826extern struct inode *alloc_anon_inode(struct super_block *);
e6f5c789 2827extern int simple_nosetlease(struct file *, long, struct file_lock **, void **);
b26d4cd3 2828extern const struct dentry_operations simple_dentry_operations;
1da177e4 2829
00cd8dd3 2830extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
1da177e4 2831extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
4b6f5d20 2832extern const struct file_operations simple_dir_operations;
c5ef1c42 2833extern const struct inode_operations simple_dir_inode_operations;
fbabfd0f
EB
2834extern void make_empty_dir_inode(struct inode *inode);
2835extern bool is_empty_dir_inode(struct inode *inode);
4b6f5d20 2836struct tree_descr { char *name; const struct file_operations *ops; int mode; };
1da177e4 2837struct dentry *d_alloc_name(struct dentry *, const char *);
7d683a09 2838extern int simple_fill_super(struct super_block *, unsigned long, struct tree_descr *);
1f5ce9e9 2839extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
1da177e4
LT
2840extern void simple_release_fs(struct vfsmount **mount, int *count);
2841
93b07113
AM
2842extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
2843 loff_t *ppos, const void *from, size_t available);
6a727b43
JS
2844extern ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
2845 const void __user *from, size_t count);
1da177e4 2846
ac13a829 2847extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
02c24a82 2848extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
d5aacad5 2849
30ca22c7
PL
2850extern int generic_check_addressable(unsigned, u64);
2851
e965f963 2852#ifdef CONFIG_MIGRATION
2d1db3b1 2853extern int buffer_migrate_page(struct address_space *,
a6bc32b8
MG
2854 struct page *, struct page *,
2855 enum migrate_mode);
e965f963
CL
2856#else
2857#define buffer_migrate_page NULL
2858#endif
2859
25d9e2d1 2860extern int inode_change_ok(const struct inode *, struct iattr *);
2861extern int inode_newsize_ok(const struct inode *, loff_t offset);
6a1a90ad 2862extern void setattr_copy(struct inode *inode, const struct iattr *attr);
1da177e4 2863
c3b2da31 2864extern int file_update_time(struct file *file);
1da177e4 2865
34c80b1d 2866extern int generic_show_options(struct seq_file *m, struct dentry *root);
b3b304a2 2867extern void save_mount_options(struct super_block *sb, char *options);
2a32cebd 2868extern void replace_mount_options(struct super_block *sb, char *options);
b3b304a2 2869
d475c634
MW
2870static inline bool io_is_direct(struct file *filp)
2871{
2872 return (filp->f_flags & O_DIRECT) || IS_DAX(file_inode(filp));
2873}
2874
2ba48ce5
AV
2875static inline int iocb_flags(struct file *file)
2876{
2877 int res = 0;
2878 if (file->f_flags & O_APPEND)
2879 res |= IOCB_APPEND;
2880 if (io_is_direct(file))
2881 res |= IOCB_DIRECT;
2882 return res;
2883}
2884
1da177e4
LT
2885static inline ino_t parent_ino(struct dentry *dentry)
2886{
2887 ino_t res;
2888
b5c84bf6
NP
2889 /*
2890 * Don't strictly need d_lock here? If the parent ino could change
2891 * then surely we'd have a deeper race in the caller?
2892 */
1da177e4
LT
2893 spin_lock(&dentry->d_lock);
2894 res = dentry->d_parent->d_inode->i_ino;
2895 spin_unlock(&dentry->d_lock);
2896 return res;
2897}
2898
1da177e4
LT
2899/* Transaction based IO helpers */
2900
2901/*
2902 * An argresp is stored in an allocated page and holds the
2903 * size of the argument or response, along with its content
2904 */
2905struct simple_transaction_argresp {
2906 ssize_t size;
2907 char data[0];
2908};
2909
2910#define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))
2911
2912char *simple_transaction_get(struct file *file, const char __user *buf,
2913 size_t size);
2914ssize_t simple_transaction_read(struct file *file, char __user *buf,
2915 size_t size, loff_t *pos);
2916int simple_transaction_release(struct inode *inode, struct file *file);
2917
76791ab2 2918void simple_transaction_set(struct file *file, size_t n);
1da177e4 2919
acaefc25
AB
2920/*
2921 * simple attribute files
2922 *
2923 * These attributes behave similar to those in sysfs:
2924 *
2925 * Writing to an attribute immediately sets a value, an open file can be
2926 * written to multiple times.
2927 *
2928 * Reading from an attribute creates a buffer from the value that might get
2929 * read with multiple read calls. When the attribute has been read
2930 * completely, no further read calls are possible until the file is opened
2931 * again.
2932 *
2933 * All attributes contain a text representation of a numeric value
2934 * that are accessed with the get() and set() functions.
2935 */
2936#define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt) \
2937static int __fops ## _open(struct inode *inode, struct file *file) \
2938{ \
2939 __simple_attr_check_format(__fmt, 0ull); \
2940 return simple_attr_open(inode, file, __get, __set, __fmt); \
2941} \
828c0950 2942static const struct file_operations __fops = { \
acaefc25
AB
2943 .owner = THIS_MODULE, \
2944 .open = __fops ## _open, \
74bedc4d 2945 .release = simple_attr_release, \
acaefc25
AB
2946 .read = simple_attr_read, \
2947 .write = simple_attr_write, \
1ec5584e 2948 .llseek = generic_file_llseek, \
68be3029 2949}
acaefc25 2950
b9075fa9
JP
2951static inline __printf(1, 2)
2952void __simple_attr_check_format(const char *fmt, ...)
acaefc25
AB
2953{
2954 /* don't do anything, just let the compiler check the arguments; */
2955}
2956
2957int simple_attr_open(struct inode *inode, struct file *file,
8b88b099 2958 int (*get)(void *, u64 *), int (*set)(void *, u64),
acaefc25 2959 const char *fmt);
74bedc4d 2960int simple_attr_release(struct inode *inode, struct file *file);
acaefc25
AB
2961ssize_t simple_attr_read(struct file *file, char __user *buf,
2962 size_t len, loff_t *ppos);
2963ssize_t simple_attr_write(struct file *file, const char __user *buf,
2964 size_t len, loff_t *ppos);
2965
4be28540 2966struct ctl_table;
8d65af78 2967int proc_nr_files(struct ctl_table *table, int write,
62239ac2 2968 void __user *buffer, size_t *lenp, loff_t *ppos);
312d3ca8
CH
2969int proc_nr_dentry(struct ctl_table *table, int write,
2970 void __user *buffer, size_t *lenp, loff_t *ppos);
cffbc8aa
DC
2971int proc_nr_inodes(struct ctl_table *table, int write,
2972 void __user *buffer, size_t *lenp, loff_t *ppos);
38e23c95 2973int __init get_filesystem_list(char *buf);
62239ac2 2974
3cd90ea4 2975#define __FMODE_EXEC ((__force int) FMODE_EXEC)
1a44bc8c
NK
2976#define __FMODE_NONOTIFY ((__force int) FMODE_NONOTIFY)
2977
6d125529 2978#define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE])
ecf081d1 2979#define OPEN_FMODE(flag) ((__force fmode_t)(((flag + 1) & O_ACCMODE) | \
1a44bc8c 2980 (flag & __FMODE_NONOTIFY)))
5300990c 2981
8d334acd 2982static inline int is_sxid(umode_t mode)
69b45732
AK
2983{
2984 return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
2985}
2986
cbdf35bc
MS
2987static inline int check_sticky(struct inode *dir, struct inode *inode)
2988{
2989 if (!(dir->i_mode & S_ISVTX))
2990 return 0;
2991
2992 return __check_sticky(dir, inode);
2993}
2994
69b45732
AK
2995static inline void inode_has_no_xattr(struct inode *inode)
2996{
9e1f1de0 2997 if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & MS_NOSEC))
69b45732
AK
2998 inode->i_flags |= S_NOSEC;
2999}
3000
a7400222
AV
3001static inline bool is_root_inode(struct inode *inode)
3002{
3003 return inode == inode->i_sb->s_root->d_inode;
3004}
3005
5f99f4e7
AV
3006static inline bool dir_emit(struct dir_context *ctx,
3007 const char *name, int namelen,
3008 u64 ino, unsigned type)
3009{
3010 return ctx->actor(ctx, name, namelen, ctx->pos, ino, type) == 0;
3011}
3012static inline bool dir_emit_dot(struct file *file, struct dir_context *ctx)
3013{
3014 return ctx->actor(ctx, ".", 1, ctx->pos,
3015 file->f_path.dentry->d_inode->i_ino, DT_DIR) == 0;
3016}
3017static inline bool dir_emit_dotdot(struct file *file, struct dir_context *ctx)
3018{
3019 return ctx->actor(ctx, "..", 2, ctx->pos,
3020 parent_ino(file->f_path.dentry), DT_DIR) == 0;
3021}
3022static inline bool dir_emit_dots(struct file *file, struct dir_context *ctx)
3023{
3024 if (ctx->pos == 0) {
3025 if (!dir_emit_dot(file, ctx))
3026 return false;
3027 ctx->pos = 1;
3028 }
3029 if (ctx->pos == 1) {
3030 if (!dir_emit_dotdot(file, ctx))
3031 return false;
3032 ctx->pos = 2;
3033 }
3034 return true;
3035}
5ded75ec
AV
3036static inline bool dir_relax(struct inode *inode)
3037{
3038 mutex_unlock(&inode->i_mutex);
3039 mutex_lock(&inode->i_mutex);
3040 return !IS_DEADDIR(inode);
3041}
5f99f4e7 3042
1da177e4 3043#endif /* _LINUX_FS_H */