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