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