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