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