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