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