]> git.ipfire.org Git - thirdparty/kernel/linux.git/blame - include/linux/fs.h
mm/memblock.c: remove redundant assignment to variable max_addr
[thirdparty/kernel/linux.git] / include / linux / fs.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
1da177e4
LT
2#ifndef _LINUX_FS_H
3#define _LINUX_FS_H
4
1da177e4 5#include <linux/linkage.h>
5dd43ce2 6#include <linux/wait_bit.h>
1da177e4
LT
7#include <linux/kdev_t.h>
8#include <linux/dcache.h>
3f8206d4 9#include <linux/path.h>
1da177e4
LT
10#include <linux/stat.h>
11#include <linux/cache.h>
1da177e4 12#include <linux/list.h>
bc3b14cb 13#include <linux/list_lru.h>
4f5e65a1 14#include <linux/llist.h>
1da177e4 15#include <linux/radix-tree.h>
b93b0163 16#include <linux/xarray.h>
6b2dbba8 17#include <linux/rbtree.h>
1da177e4 18#include <linux/init.h>
914e2637 19#include <linux/pid.h>
187f1882 20#include <linux/bug.h>
1b1dcc1b 21#include <linux/mutex.h>
c8c06efa 22#include <linux/rwsem.h>
baabda26 23#include <linux/mm_types.h>
3bd858ab 24#include <linux/capability.h>
6188e10d 25#include <linux/semaphore.h>
c75b1d94 26#include <linux/fcntl.h>
c4b929b8 27#include <linux/fiemap.h>
ceb5bdc2 28#include <linux/rculist_bl.h>
07b8ce1e 29#include <linux/atomic.h>
83aeeada 30#include <linux/shrinker.h>
c1aab02d 31#include <linux/migrate_mode.h>
92361636 32#include <linux/uidgid.h>
5accdf82 33#include <linux/lockdep.h>
c2b1ad80 34#include <linux/percpu-rwsem.h>
853b39a7 35#include <linux/workqueue.h>
fceef393 36#include <linux/delayed_call.h>
85787090 37#include <linux/uuid.h>
5660e13d 38#include <linux/errseq.h>
d9a08a9e 39#include <linux/ioprio.h>
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;
d7167b14 70struct fs_parameter_spec;
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
2be7d348
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
DR
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
DR
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;
8019ad13 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;
2496396f 859#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPTION)
1da177e4
LT
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();
2496396f 884#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPTION)
1da177e4
LT
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
e0b93edd 1353extern void __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
393cc3f5 1354extern int f_setown(struct file *filp, unsigned long arg, int force);
1da177e4 1355extern void f_delown(struct file *filp);
609d7fa9 1356extern pid_t f_getown(struct file *filp);
1da177e4
LT
1357extern int send_sigurg(struct fown_struct *fown);
1358
e462ec50
DH
1359/*
1360 * sb->s_flags. Note that these mirror the equivalent MS_* flags where
1361 * represented in both.
1362 */
1363#define SB_RDONLY 1 /* Mount read-only */
1364#define SB_NOSUID 2 /* Ignore suid and sgid bits */
1365#define SB_NODEV 4 /* Disallow access to device special files */
1366#define SB_NOEXEC 8 /* Disallow program execution */
1367#define SB_SYNCHRONOUS 16 /* Writes are synced at once */
1368#define SB_MANDLOCK 64 /* Allow mandatory locks on an FS */
1369#define SB_DIRSYNC 128 /* Directory modifications are synchronous */
1370#define SB_NOATIME 1024 /* Do not update access times. */
1371#define SB_NODIRATIME 2048 /* Do not update directory access times */
1372#define SB_SILENT 32768
1373#define SB_POSIXACL (1<<16) /* VFS does not apply the umask */
1374#define SB_KERNMOUNT (1<<22) /* this is a kern_mount call */
1375#define SB_I_VERSION (1<<23) /* Update inode I_version field */
1376#define SB_LAZYTIME (1<<25) /* Update the on-disk [acm]times lazily */
1377
1378/* These sb flags are internal to the kernel */
1379#define SB_SUBMOUNT (1<<26)
8d0347f6 1380#define SB_FORCE (1<<27)
e462ec50
DH
1381#define SB_NOSEC (1<<28)
1382#define SB_BORN (1<<29)
1383#define SB_ACTIVE (1<<30)
1384#define SB_NOUSER (1<<31)
1385
1da177e4
LT
1386/*
1387 * Umount options
1388 */
1389
1390#define MNT_FORCE 0x00000001 /* Attempt to forcibily umount */
1391#define MNT_DETACH 0x00000002 /* Just detach from the tree */
1392#define MNT_EXPIRE 0x00000004 /* Mark for expiry */
db1f05bb
MS
1393#define UMOUNT_NOFOLLOW 0x00000008 /* Don't follow symlink on umount */
1394#define UMOUNT_UNUSED 0x80000000 /* Flag guaranteed to be unused */
1da177e4 1395
46b15caa
TH
1396/* sb->s_iflags */
1397#define SB_I_CGROUPWB 0x00000001 /* cgroup-aware writeback enabled */
90f8572b 1398#define SB_I_NOEXEC 0x00000002 /* Ignore executables on this fs */
a2982cc9 1399#define SB_I_NODEV 0x00000004 /* Ignore devices on this fs */
95dd7758 1400#define SB_I_MULTIROOT 0x00000008 /* Multiple roots to the dentry tree */
1da177e4 1401
8654df4e
EB
1402/* sb->s_iflags to limit user namespace mounts */
1403#define SB_I_USERNS_VISIBLE 0x00000010 /* fstype already mounted */
57b56ac6
MZ
1404#define SB_I_IMA_UNVERIFIABLE_SIGNATURE 0x00000020
1405#define SB_I_UNTRUSTED_MOUNTER 0x00000040
1da177e4 1406
5accdf82
JK
1407/* Possible states of 'frozen' field */
1408enum {
1409 SB_UNFROZEN = 0, /* FS is unfrozen */
1410 SB_FREEZE_WRITE = 1, /* Writes, dir ops, ioctls frozen */
5accdf82
JK
1411 SB_FREEZE_PAGEFAULT = 2, /* Page faults stopped as well */
1412 SB_FREEZE_FS = 3, /* For internal FS use (e.g. to stop
1413 * internal threads if needed) */
1414 SB_FREEZE_COMPLETE = 4, /* ->freeze_fs finished successfully */
1415};
1416
1417#define SB_FREEZE_LEVELS (SB_FREEZE_COMPLETE - 1)
1418
1419struct sb_writers {
8129ed29
ON
1420 int frozen; /* Is sb frozen? */
1421 wait_queue_head_t wait_unfrozen; /* for get_super_thawed() */
1422 struct percpu_rw_semaphore rw_sem[SB_FREEZE_LEVELS];
5accdf82
JK
1423};
1424
1da177e4
LT
1425struct super_block {
1426 struct list_head s_list; /* Keep this first */
1427 dev_t s_dev; /* search index; _not_ kdev_t */
270ba5f7
RK
1428 unsigned char s_blocksize_bits;
1429 unsigned long s_blocksize;
42cb56ae 1430 loff_t s_maxbytes; /* Max file size */
1da177e4 1431 struct file_system_type *s_type;
ee9b6d61 1432 const struct super_operations *s_op;
61e225dc 1433 const struct dquot_operations *dq_op;
0d54b217 1434 const struct quotactl_ops *s_qcop;
39655164 1435 const struct export_operations *s_export_op;
1da177e4 1436 unsigned long s_flags;
46b15caa 1437 unsigned long s_iflags; /* internal SB_I_* flags */
1da177e4
LT
1438 unsigned long s_magic;
1439 struct dentry *s_root;
1440 struct rw_semaphore s_umount;
1da177e4 1441 int s_count;
1da177e4 1442 atomic_t s_active;
50462062 1443#ifdef CONFIG_SECURITY
1da177e4 1444 void *s_security;
50462062 1445#endif
bb435453 1446 const struct xattr_handler **s_xattr;
643fa961 1447#ifdef CONFIG_FS_ENCRYPTION
0b81d077 1448 const struct fscrypt_operations *s_cop;
22d94f49 1449 struct key *s_master_keys; /* master crypto keys in use */
5585f2af
EB
1450#endif
1451#ifdef CONFIG_FS_VERITY
1452 const struct fsverity_operations *s_vop;
bbbc3fb6 1453#endif
f1ee6162 1454 struct hlist_bl_head s_roots; /* alternate root dentries for NFS */
39f7c4db 1455 struct list_head s_mounts; /* list of mounts; _not_ for fs use */
1da177e4 1456 struct block_device *s_bdev;
32a88aa1 1457 struct backing_dev_info *s_bdi;
acaebfd8 1458 struct mtd_info *s_mtd;
a5166169 1459 struct hlist_node s_instances;
2c5f648a 1460 unsigned int s_quota_types; /* Bitmask of supported quota types */
1da177e4
LT
1461 struct quota_info s_dquot; /* Diskquota specific options */
1462
5accdf82 1463 struct sb_writers s_writers;
1da177e4 1464
99c228a9
AG
1465 /*
1466 * Keep s_fs_info, s_time_gran, s_fsnotify_mask, and
1467 * s_fsnotify_marks together for cache efficiency. They are frequently
1468 * accessed and rarely modified.
1469 */
1470 void *s_fs_info; /* Filesystem private info */
1471
1472 /* Granularity of c/m/atime in ns (cannot be worse than a second) */
1473 u32 s_time_gran;
188d20bc
DD
1474 /* Time limits for c/m/atime in seconds */
1475 time64_t s_time_min;
1476 time64_t s_time_max;
99c228a9
AG
1477#ifdef CONFIG_FSNOTIFY
1478 __u32 s_fsnotify_mask;
1479 struct fsnotify_mark_connector __rcu *s_fsnotify_marks;
1480#endif
1481
85787090
CH
1482 char s_id[32]; /* Informational name */
1483 uuid_t s_uuid; /* UUID */
1da177e4 1484
8de52778 1485 unsigned int s_max_links;
30c40d2c 1486 fmode_t s_mode;
1da177e4
LT
1487
1488 /*
1489 * The next field is for VFS *only*. No filesystems have any business
1490 * even looking at it. You had been warned.
1491 */
a11f3a05 1492 struct mutex s_vfs_rename_mutex; /* Kludge */
1da177e4 1493
79c0b2df
MS
1494 /*
1495 * Filesystem subtype. If non-empty the filesystem type field
1496 * in /proc/mounts will be "type.subtype"
1497 */
a0c9a8b8 1498 const char *s_subtype;
b3b304a2 1499
c8aebb0c 1500 const struct dentry_operations *s_d_op; /* default d_op for dentries */
9fdfdcf1
DM
1501
1502 /*
1503 * Saved pool identifier for cleancache (-1 means none)
1504 */
1505 int cleancache_poolid;
b0d40c92
DC
1506
1507 struct shrinker s_shrink; /* per-sb shrinker handle */
4ed5e82f 1508
7ada4db8
MS
1509 /* Number of inodes with nlink == 0 but still referenced */
1510 atomic_long_t s_remove_count;
1511
721fb6fb
JK
1512 /* Pending fsnotify inode refs */
1513 atomic_long_t s_fsnotify_inode_refs;
1514
4ed5e82f
MS
1515 /* Being remounted read-only */
1516 int s_readonly_remount;
7b7a8665
CH
1517
1518 /* AIO completions deferred from interrupt context */
1519 struct workqueue_struct *s_dio_done_wq;
215752fc 1520 struct hlist_head s_pins;
f6041567 1521
6e4eab57
EB
1522 /*
1523 * Owning user namespace and default context in which to
1524 * interpret filesystem uids, gids, quotas, device nodes,
1525 * xattrs and security labels.
1526 */
1527 struct user_namespace *s_user_ns;
1528
f6041567 1529 /*
7d10f70f
WL
1530 * The list_lru structure is essentially just a pointer to a table
1531 * of per-node lru lists, each of which has its own spinlock.
1532 * There is no need to put them into separate cachelines.
f6041567 1533 */
7d10f70f
WL
1534 struct list_lru s_dentry_lru;
1535 struct list_lru s_inode_lru;
e2fec7c3 1536 struct rcu_head rcu;
853b39a7 1537 struct work_struct destroy_work;
69c433ed 1538
e97fedb9 1539 struct mutex s_sync_lock; /* sync serialisation lock */
69c433ed
MS
1540
1541 /*
1542 * Indicates how deep in a filesystem stack this SB is
1543 */
1544 int s_stack_depth;
74278da9
DC
1545
1546 /* s_inode_list_lock protects s_inodes */
1547 spinlock_t s_inode_list_lock ____cacheline_aligned_in_smp;
1548 struct list_head s_inodes; /* all inodes */
6c60d2b5
DC
1549
1550 spinlock_t s_inode_wblist_lock;
1551 struct list_head s_inodes_wb; /* writeback inodes */
3859a271 1552} __randomize_layout;
1da177e4 1553
81754357
SF
1554/* Helper functions so that in most cases filesystems will
1555 * not need to deal directly with kuid_t and kgid_t and can
1556 * instead deal with the raw numeric values that are stored
1557 * in the filesystem.
1558 */
1559static inline uid_t i_uid_read(const struct inode *inode)
1560{
1561 return from_kuid(inode->i_sb->s_user_ns, inode->i_uid);
1562}
1563
1564static inline gid_t i_gid_read(const struct inode *inode)
1565{
1566 return from_kgid(inode->i_sb->s_user_ns, inode->i_gid);
1567}
1568
1569static inline void i_uid_write(struct inode *inode, uid_t uid)
1570{
1571 inode->i_uid = make_kuid(inode->i_sb->s_user_ns, uid);
1572}
1573
1574static inline void i_gid_write(struct inode *inode, gid_t gid)
1575{
1576 inode->i_gid = make_kgid(inode->i_sb->s_user_ns, gid);
1577}
1578
95582b00 1579extern struct timespec64 current_time(struct inode *inode);
1da177e4
LT
1580
1581/*
1582 * Snapshotting support.
1583 */
1da177e4 1584
5accdf82
JK
1585void __sb_end_write(struct super_block *sb, int level);
1586int __sb_start_write(struct super_block *sb, int level, bool wait);
1587
bee9182d 1588#define __sb_writers_acquired(sb, lev) \
8129ed29 1589 percpu_rwsem_acquire(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
bee9182d 1590#define __sb_writers_release(sb, lev) \
8129ed29 1591 percpu_rwsem_release(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
bee9182d 1592
5accdf82
JK
1593/**
1594 * sb_end_write - drop write access to a superblock
1595 * @sb: the super we wrote to
1596 *
1597 * Decrement number of writers to the filesystem. Wake up possible waiters
1598 * wanting to freeze the filesystem.
1599 */
1600static inline void sb_end_write(struct super_block *sb)
1601{
1602 __sb_end_write(sb, SB_FREEZE_WRITE);
1603}
1604
1605/**
1606 * sb_end_pagefault - drop write access to a superblock from a page fault
1607 * @sb: the super we wrote to
1608 *
1609 * Decrement number of processes handling write page fault to the filesystem.
1610 * Wake up possible waiters wanting to freeze the filesystem.
1611 */
1612static inline void sb_end_pagefault(struct super_block *sb)
1613{
1614 __sb_end_write(sb, SB_FREEZE_PAGEFAULT);
1615}
1616
1617/**
1618 * sb_end_intwrite - drop write access to a superblock for internal fs purposes
1619 * @sb: the super we wrote to
1620 *
1621 * Decrement fs-internal number of writers to the filesystem. Wake up possible
1622 * waiters wanting to freeze the filesystem.
1623 */
1624static inline void sb_end_intwrite(struct super_block *sb)
1625{
1626 __sb_end_write(sb, SB_FREEZE_FS);
1627}
1628
1629/**
1630 * sb_start_write - get write access to a superblock
1631 * @sb: the super we write to
1632 *
1633 * When a process wants to write data or metadata to a file system (i.e. dirty
1634 * a page or an inode), it should embed the operation in a sb_start_write() -
1635 * sb_end_write() pair to get exclusion against file system freezing. This
1636 * function increments number of writers preventing freezing. If the file
1637 * system is already frozen, the function waits until the file system is
1638 * thawed.
1639 *
1640 * Since freeze protection behaves as a lock, users have to preserve
1641 * ordering of freeze protection and other filesystem locks. Generally,
1642 * freeze protection should be the outermost lock. In particular, we have:
1643 *
1644 * sb_start_write
1645 * -> i_mutex (write path, truncate, directory ops, ...)
1646 * -> s_umount (freeze_super, thaw_super)
1647 */
1648static inline void sb_start_write(struct super_block *sb)
1649{
1650 __sb_start_write(sb, SB_FREEZE_WRITE, true);
1651}
1652
1653static inline int sb_start_write_trylock(struct super_block *sb)
1654{
1655 return __sb_start_write(sb, SB_FREEZE_WRITE, false);
1656}
1657
1658/**
1659 * sb_start_pagefault - get write access to a superblock from a page fault
1660 * @sb: the super we write to
1661 *
1662 * When a process starts handling write page fault, it should embed the
1663 * operation into sb_start_pagefault() - sb_end_pagefault() pair to get
1664 * exclusion against file system freezing. This is needed since the page fault
1665 * is going to dirty a page. This function increments number of running page
1666 * faults preventing freezing. If the file system is already frozen, the
1667 * function waits until the file system is thawed.
1668 *
1669 * Since page fault freeze protection behaves as a lock, users have to preserve
1670 * ordering of freeze protection and other filesystem locks. It is advised to
1671 * put sb_start_pagefault() close to mmap_sem in lock ordering. Page fault
1672 * handling code implies lock dependency:
1673 *
1674 * mmap_sem
1675 * -> sb_start_pagefault
1676 */
1677static inline void sb_start_pagefault(struct super_block *sb)
1678{
1679 __sb_start_write(sb, SB_FREEZE_PAGEFAULT, true);
1680}
1681
1682/*
1683 * sb_start_intwrite - get write access to a superblock for internal fs purposes
1684 * @sb: the super we write to
1685 *
1686 * This is the third level of protection against filesystem freezing. It is
1687 * free for use by a filesystem. The only requirement is that it must rank
1688 * below sb_start_pagefault.
1689 *
1690 * For example filesystem can call sb_start_intwrite() when starting a
1691 * transaction which somewhat eases handling of freezing for internal sources
1692 * of filesystem changes (internal fs threads, discarding preallocation on file
1693 * close, etc.).
1694 */
1695static inline void sb_start_intwrite(struct super_block *sb)
1696{
1697 __sb_start_write(sb, SB_FREEZE_FS, true);
1698}
1da177e4 1699
0c8e3fe3
AG
1700static inline int sb_start_intwrite_trylock(struct super_block *sb)
1701{
1702 return __sb_start_write(sb, SB_FREEZE_FS, false);
1703}
1704
1da177e4 1705
2e149670 1706extern bool inode_owner_or_capable(const struct inode *inode);
3bd858ab 1707
1da177e4
LT
1708/*
1709 * VFS helper functions..
1710 */
312b63fb 1711extern int vfs_create(struct inode *, struct dentry *, umode_t, bool);
18bb1db3 1712extern int vfs_mkdir(struct inode *, struct dentry *, umode_t);
1a67aafb 1713extern int vfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
db2e747b 1714extern int vfs_symlink(struct inode *, struct dentry *, const char *);
146a8595 1715extern int vfs_link(struct dentry *, struct inode *, struct dentry *, struct inode **);
1da177e4 1716extern int vfs_rmdir(struct inode *, struct dentry *);
b21996e3 1717extern int vfs_unlink(struct inode *, struct dentry *, struct inode **);
520c8b16 1718extern int vfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *, struct inode **, unsigned int);
787fb6bc 1719extern int vfs_whiteout(struct inode *, struct dentry *);
1da177e4 1720
af7bd4dc
AG
1721extern struct dentry *vfs_tmpfile(struct dentry *dentry, umode_t mode,
1722 int open_flag);
1723
8e6c848e
AV
1724int vfs_mkobj(struct dentry *, umode_t,
1725 int (*f)(struct dentry *, umode_t, void *),
1726 void *);
1727
9df6702a
MS
1728extern long vfs_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
1729
2952db0f
AB
1730#ifdef CONFIG_COMPAT
1731extern long compat_ptr_ioctl(struct file *file, unsigned int cmd,
1732 unsigned long arg);
1733#else
1734#define compat_ptr_ioctl NULL
1735#endif
1736
8c744fb8
CH
1737/*
1738 * VFS file helper functions.
1739 */
a1bd120d 1740extern void inode_init_owner(struct inode *inode, const struct inode *dir,
62bb1091 1741 umode_t mode);
a2982cc9 1742extern bool may_open_dev(const struct path *path);
c4b929b8
MF
1743/*
1744 * VFS FS_IOC_FIEMAP helper definitions.
1745 */
1746struct fiemap_extent_info {
1747 unsigned int fi_flags; /* Flags as passed from user */
1748 unsigned int fi_extents_mapped; /* Number of mapped extents */
1749 unsigned int fi_extents_max; /* Size of fiemap_extent array */
ecf5632d
NK
1750 struct fiemap_extent __user *fi_extents_start; /* Start of
1751 fiemap_extent array */
c4b929b8
MF
1752};
1753int fiemap_fill_next_extent(struct fiemap_extent_info *info, u64 logical,
1754 u64 phys, u64 len, u32 flags);
1755int fiemap_check_flags(struct fiemap_extent_info *fieinfo, u32 fs_flags);
1756
1da177e4
LT
1757/*
1758 * This is the "filldir" function type, used by readdir() to let
1759 * the kernel specify what kind of dirent layout it wants to have.
1760 * This allows the kernel to read directories into kernel space or
1761 * to have different dirent layouts depending on the binary type.
1762 */
ac7576f4
MS
1763struct dir_context;
1764typedef int (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64,
1765 unsigned);
1766
5c0ba4e0 1767struct dir_context {
a09acf4b 1768 filldir_t actor;
bb6f619b 1769 loff_t pos;
5c0ba4e0 1770};
bb6f619b 1771
08f85851 1772struct block_device_operations;
1da177e4 1773
1da177e4
LT
1774/* These macros are for out of kernel modules to test that
1775 * the kernel supports the unlocked_ioctl and compat_ioctl
1776 * fields in struct file_operations. */
1777#define HAVE_COMPAT_IOCTL 1
1778#define HAVE_UNLOCKED_IOCTL 1
1779
b4caecd4
CH
1780/*
1781 * These flags let !MMU mmap() govern direct device mapping vs immediate
1782 * copying more easily for MAP_PRIVATE, especially for ROM filesystems.
1783 *
1784 * NOMMU_MAP_COPY: Copy can be mapped (MAP_PRIVATE)
1785 * NOMMU_MAP_DIRECT: Can be mapped directly (MAP_SHARED)
1786 * NOMMU_MAP_READ: Can be mapped for reading
1787 * NOMMU_MAP_WRITE: Can be mapped for writing
1788 * NOMMU_MAP_EXEC: Can be mapped for execution
1789 */
1790#define NOMMU_MAP_COPY 0x00000001
1791#define NOMMU_MAP_DIRECT 0x00000008
1792#define NOMMU_MAP_READ VM_MAYREAD
1793#define NOMMU_MAP_WRITE VM_MAYWRITE
1794#define NOMMU_MAP_EXEC VM_MAYEXEC
1795
1796#define NOMMU_VMFLAGS \
1797 (NOMMU_MAP_READ | NOMMU_MAP_WRITE | NOMMU_MAP_EXEC)
1798
2e5dfc99
DW
1799/*
1800 * These flags control the behavior of the remap_file_range function pointer.
1801 * If it is called with len == 0 that means "remap to end of source file".
5c437fa2 1802 * See Documentation/filesystems/vfs.rst for more details about this call.
2e5dfc99
DW
1803 *
1804 * REMAP_FILE_DEDUP: only remap if contents identical (i.e. deduplicate)
eca3654e 1805 * REMAP_FILE_CAN_SHORTEN: caller can handle a shortened request
2e5dfc99
DW
1806 */
1807#define REMAP_FILE_DEDUP (1 << 0)
eca3654e 1808#define REMAP_FILE_CAN_SHORTEN (1 << 1)
2e5dfc99
DW
1809
1810/*
1811 * These flags signal that the caller is ok with altering various aspects of
1812 * the behavior of the remap operation. The changes must be made by the
1813 * implementation; the vfs remap helper functions can take advantage of them.
1814 * Flags in this category exist to preserve the quirky behavior of the hoisted
1815 * btrfs clone/dedupe ioctls.
2e5dfc99 1816 */
eca3654e 1817#define REMAP_FILE_ADVISORY (REMAP_FILE_CAN_SHORTEN)
b4caecd4 1818
293bc982
AV
1819struct iov_iter;
1820
1da177e4
LT
1821struct file_operations {
1822 struct module *owner;
1823 loff_t (*llseek) (struct file *, loff_t, int);
1824 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
1da177e4 1825 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
293bc982
AV
1826 ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
1827 ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
fb7e1600 1828 int (*iopoll)(struct kiocb *kiocb, bool spin);
bb6f619b 1829 int (*iterate) (struct file *, struct dir_context *);
61922694 1830 int (*iterate_shared) (struct file *, struct dir_context *);
a3f8683b 1831 __poll_t (*poll) (struct file *, struct poll_table_struct *);
1da177e4
LT
1832 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
1833 long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
1834 int (*mmap) (struct file *, struct vm_area_struct *);
1c972597 1835 unsigned long mmap_supported_flags;
1da177e4 1836 int (*open) (struct inode *, struct file *);
75e1fcc0 1837 int (*flush) (struct file *, fl_owner_t id);
1da177e4 1838 int (*release) (struct inode *, struct file *);
02c24a82 1839 int (*fsync) (struct file *, loff_t, loff_t, int datasync);
1da177e4
LT
1840 int (*fasync) (int, struct file *, int);
1841 int (*lock) (struct file *, int, struct file_lock *);
1da177e4
LT
1842 ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
1843 unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
1844 int (*check_flags)(int);
1da177e4 1845 int (*flock) (struct file *, int, struct file_lock *);
cbb7e577
JA
1846 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int);
1847 ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int);
e6f5c789 1848 int (*setlease)(struct file *, long, struct file_lock **, void **);
2fe17c10
CH
1849 long (*fallocate)(struct file *file, int mode, loff_t offset,
1850 loff_t len);
a3816ab0 1851 void (*show_fdinfo)(struct seq_file *m, struct file *f);
b4caecd4
CH
1852#ifndef CONFIG_MMU
1853 unsigned (*mmap_capabilities)(struct file *);
1854#endif
04b38d60
CH
1855 ssize_t (*copy_file_range)(struct file *, loff_t, struct file *,
1856 loff_t, size_t, unsigned int);
42ec3d4c
DW
1857 loff_t (*remap_file_range)(struct file *file_in, loff_t pos_in,
1858 struct file *file_out, loff_t pos_out,
1859 loff_t len, unsigned int remap_flags);
45cd0faa 1860 int (*fadvise)(struct file *, loff_t, loff_t, int);
3859a271 1861} __randomize_layout;
1da177e4
LT
1862
1863struct inode_operations {
00cd8dd3 1864 struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
fceef393 1865 const char * (*get_link) (struct dentry *, struct inode *, struct delayed_call *);
10556cb2 1866 int (*permission) (struct inode *, int);
4e34e719 1867 struct posix_acl * (*get_acl)(struct inode *, int);
44a7d7a8
NP
1868
1869 int (*readlink) (struct dentry *, char __user *,int);
44a7d7a8 1870
ebfc3b49 1871 int (*create) (struct inode *,struct dentry *, umode_t, bool);
1da177e4
LT
1872 int (*link) (struct dentry *,struct inode *,struct dentry *);
1873 int (*unlink) (struct inode *,struct dentry *);
1874 int (*symlink) (struct inode *,struct dentry *,const char *);
18bb1db3 1875 int (*mkdir) (struct inode *,struct dentry *,umode_t);
1da177e4 1876 int (*rmdir) (struct inode *,struct dentry *);
1a67aafb 1877 int (*mknod) (struct inode *,struct dentry *,umode_t,dev_t);
1da177e4 1878 int (*rename) (struct inode *, struct dentry *,
520c8b16 1879 struct inode *, struct dentry *, unsigned int);
1da177e4 1880 int (*setattr) (struct dentry *, struct iattr *);
a528d35e 1881 int (*getattr) (const struct path *, struct kstat *, u32, unsigned int);
1da177e4 1882 ssize_t (*listxattr) (struct dentry *, char *, size_t);
c4b929b8
MF
1883 int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
1884 u64 len);
95582b00 1885 int (*update_time)(struct inode *, struct timespec64 *, int);
d9585277 1886 int (*atomic_open)(struct inode *, struct dentry *,
30d90494 1887 struct file *, unsigned open_flag,
44907d79 1888 umode_t create_mode);
60545d0d 1889 int (*tmpfile) (struct inode *, struct dentry *, umode_t);
893d46e4 1890 int (*set_acl)(struct inode *, struct posix_acl *, int);
44a7d7a8 1891} ____cacheline_aligned;
1da177e4 1892
bb7462b6
MS
1893static inline ssize_t call_read_iter(struct file *file, struct kiocb *kio,
1894 struct iov_iter *iter)
1895{
1896 return file->f_op->read_iter(kio, iter);
1897}
1898
1899static inline ssize_t call_write_iter(struct file *file, struct kiocb *kio,
1900 struct iov_iter *iter)
1901{
1902 return file->f_op->write_iter(kio, iter);
1903}
1904
f74ac015
MS
1905static inline int call_mmap(struct file *file, struct vm_area_struct *vma)
1906{
1907 return file->f_op->mmap(file, vma);
1908}
1909
eed4e51f 1910ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvector,
fcf63409
CY
1911 unsigned long nr_segs, unsigned long fast_segs,
1912 struct iovec *fast_pointer,
ac34ebb3 1913 struct iovec **ret_pointer);
eed4e51f 1914
6fb5032e 1915extern ssize_t __vfs_read(struct file *, char __user *, size_t, loff_t *);
1da177e4
LT
1916extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
1917extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
1918extern ssize_t vfs_readv(struct file *, const struct iovec __user *,
ddef7ed2 1919 unsigned long, loff_t *, rwf_t);
29732938
ZB
1920extern ssize_t vfs_copy_file_range(struct file *, loff_t , struct file *,
1921 loff_t, size_t, unsigned int);
f16acc9d
DC
1922extern ssize_t generic_copy_file_range(struct file *file_in, loff_t pos_in,
1923 struct file *file_out, loff_t pos_out,
1924 size_t len, unsigned int flags);
a83ab01a
DW
1925extern int generic_remap_file_range_prep(struct file *file_in, loff_t pos_in,
1926 struct file *file_out, loff_t pos_out,
42ec3d4c
DW
1927 loff_t *count,
1928 unsigned int remap_flags);
1929extern loff_t do_clone_file_range(struct file *file_in, loff_t pos_in,
1930 struct file *file_out, loff_t pos_out,
452ce659 1931 loff_t len, unsigned int remap_flags);
42ec3d4c
DW
1932extern loff_t vfs_clone_file_range(struct file *file_in, loff_t pos_in,
1933 struct file *file_out, loff_t pos_out,
452ce659 1934 loff_t len, unsigned int remap_flags);
54dbc151
DW
1935extern int vfs_dedupe_file_range(struct file *file,
1936 struct file_dedupe_range *same);
42ec3d4c
DW
1937extern loff_t vfs_dedupe_file_range_one(struct file *src_file, loff_t src_pos,
1938 struct file *dst_file, loff_t dst_pos,
df365836 1939 loff_t len, unsigned int remap_flags);
f1825366 1940
1da177e4 1941
1da177e4
LT
1942struct super_operations {
1943 struct inode *(*alloc_inode)(struct super_block *sb);
1944 void (*destroy_inode)(struct inode *);
fdb0da89 1945 void (*free_inode)(struct inode *);
1da177e4 1946
aa385729 1947 void (*dirty_inode) (struct inode *, int flags);
a9185b41 1948 int (*write_inode) (struct inode *, struct writeback_control *wbc);
45321ac5 1949 int (*drop_inode) (struct inode *);
be7ce416 1950 void (*evict_inode) (struct inode *);
1da177e4 1951 void (*put_super) (struct super_block *);
1da177e4 1952 int (*sync_fs)(struct super_block *sb, int wait);
48b6bca6 1953 int (*freeze_super) (struct super_block *);
c4be0c1d 1954 int (*freeze_fs) (struct super_block *);
48b6bca6 1955 int (*thaw_super) (struct super_block *);
c4be0c1d 1956 int (*unfreeze_fs) (struct super_block *);
726c3342 1957 int (*statfs) (struct dentry *, struct kstatfs *);
1da177e4 1958 int (*remount_fs) (struct super_block *, int *, char *);
42faad99 1959 void (*umount_begin) (struct super_block *);
1da177e4 1960
34c80b1d 1961 int (*show_options)(struct seq_file *, struct dentry *);
d861c630 1962 int (*show_devname)(struct seq_file *, struct dentry *);
a6322de6 1963 int (*show_path)(struct seq_file *, struct dentry *);
64132379 1964 int (*show_stats)(struct seq_file *, struct dentry *);
0e51a720 1965#ifdef CONFIG_QUOTA
1da177e4
LT
1966 ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
1967 ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
2d0fa467 1968 struct dquot **(*get_dquots)(struct inode *);
0e51a720 1969#endif
87d8fe1e 1970 int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
4101b624
VD
1971 long (*nr_cached_objects)(struct super_block *,
1972 struct shrink_control *);
1973 long (*free_cached_objects)(struct super_block *,
1974 struct shrink_control *);
1da177e4
LT
1975};
1976
bbc1096a
DH
1977/*
1978 * Inode flags - they have no relation to superblock flags now
1979 */
1980#define S_SYNC 1 /* Writes are synced at once */
1981#define S_NOATIME 2 /* Do not update access times */
1982#define S_APPEND 4 /* Append-only file */
1983#define S_IMMUTABLE 8 /* Immutable file */
1984#define S_DEAD 16 /* removed, but still open directory */
1985#define S_NOQUOTA 32 /* Inode is not counted to quota */
1986#define S_DIRSYNC 64 /* Directory modifications are synchronous */
1987#define S_NOCMTIME 128 /* Do not update file c/mtime */
1988#define S_SWAPFILE 256 /* Do not truncate: swapon got its bmaps */
1989#define S_PRIVATE 512 /* Inode is fs-internal */
1990#define S_IMA 1024 /* Inode has an associated IMA struct */
1991#define S_AUTOMOUNT 2048 /* Automount/referral quasi-directory */
1992#define S_NOSEC 4096 /* no suid or xattr security attributes */
6cd176a5 1993#ifdef CONFIG_FS_DAX
fbbbad4b
MW
1994#define S_DAX 8192 /* Direct Access, avoiding the page cache */
1995#else
1996#define S_DAX 0 /* Make all the DAX code disappear */
1997#endif
2ee6a576 1998#define S_ENCRYPTED 16384 /* Encrypted file (using fs/crypto/) */
b886ee3e 1999#define S_CASEFOLD 32768 /* Casefolded file */
5585f2af 2000#define S_VERITY 65536 /* Verity file (using fs/verity/) */
bbc1096a
DH
2001
2002/*
2003 * Note that nosuid etc flags are inode-specific: setting some file-system
2004 * flags just means all the inodes inherit those flags by default. It might be
2005 * possible to override it selectively if you really wanted to with some
2006 * ioctl() that is not currently implemented.
2007 *
e462ec50 2008 * Exception: SB_RDONLY is always applied to the entire file system.
bbc1096a
DH
2009 *
2010 * Unfortunately, it is possible to change a filesystems flags with it mounted
2011 * with files in use. This means that all of the inodes will not have their
2012 * i_flags updated. Hence, i_flags no longer inherit the superblock mount
2013 * flags, so these have to be checked separately. -- rmk@arm.uk.linux.org
2014 */
2015#define __IS_FLG(inode, flg) ((inode)->i_sb->s_flags & (flg))
2016
1751e8a6 2017static inline bool sb_rdonly(const struct super_block *sb) { return sb->s_flags & SB_RDONLY; }
94e92e7a 2018#define IS_RDONLY(inode) sb_rdonly((inode)->i_sb)
e462ec50 2019#define IS_SYNC(inode) (__IS_FLG(inode, SB_SYNCHRONOUS) || \
bbc1096a 2020 ((inode)->i_flags & S_SYNC))
e462ec50 2021#define IS_DIRSYNC(inode) (__IS_FLG(inode, SB_SYNCHRONOUS|SB_DIRSYNC) || \
bbc1096a 2022 ((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
e462ec50
DH
2023#define IS_MANDLOCK(inode) __IS_FLG(inode, SB_MANDLOCK)
2024#define IS_NOATIME(inode) __IS_FLG(inode, SB_RDONLY|SB_NOATIME)
2025#define IS_I_VERSION(inode) __IS_FLG(inode, SB_I_VERSION)
bbc1096a
DH
2026
2027#define IS_NOQUOTA(inode) ((inode)->i_flags & S_NOQUOTA)
2028#define IS_APPEND(inode) ((inode)->i_flags & S_APPEND)
2029#define IS_IMMUTABLE(inode) ((inode)->i_flags & S_IMMUTABLE)
e462ec50 2030#define IS_POSIXACL(inode) __IS_FLG(inode, SB_POSIXACL)
bbc1096a
DH
2031
2032#define IS_DEADDIR(inode) ((inode)->i_flags & S_DEAD)
2033#define IS_NOCMTIME(inode) ((inode)->i_flags & S_NOCMTIME)
2034#define IS_SWAPFILE(inode) ((inode)->i_flags & S_SWAPFILE)
2035#define IS_PRIVATE(inode) ((inode)->i_flags & S_PRIVATE)
2036#define IS_IMA(inode) ((inode)->i_flags & S_IMA)
2037#define IS_AUTOMOUNT(inode) ((inode)->i_flags & S_AUTOMOUNT)
2038#define IS_NOSEC(inode) ((inode)->i_flags & S_NOSEC)
fbbbad4b 2039#define IS_DAX(inode) ((inode)->i_flags & S_DAX)
2ee6a576 2040#define IS_ENCRYPTED(inode) ((inode)->i_flags & S_ENCRYPTED)
b886ee3e 2041#define IS_CASEFOLDED(inode) ((inode)->i_flags & S_CASEFOLD)
5585f2af 2042#define IS_VERITY(inode) ((inode)->i_flags & S_VERITY)
bbc1096a 2043
787fb6bc
MS
2044#define IS_WHITEOUT(inode) (S_ISCHR(inode->i_mode) && \
2045 (inode)->i_rdev == WHITEOUT_DEV)
2046
0bd23d09
EB
2047static inline bool HAS_UNMAPPED_ID(struct inode *inode)
2048{
2049 return !uid_valid(inode->i_uid) || !gid_valid(inode->i_gid);
2050}
2051
c75b1d94
JA
2052static inline enum rw_hint file_write_hint(struct file *file)
2053{
2054 if (file->f_write_hint != WRITE_LIFE_NOT_SET)
2055 return file->f_write_hint;
2056
2057 return file_inode(file)->i_write_hint;
2058}
2059
2060static inline int iocb_flags(struct file *file);
2061
fc28724d
AM
2062static inline u16 ki_hint_validate(enum rw_hint hint)
2063{
2064 typeof(((struct kiocb *)0)->ki_hint) max_hint = -1;
2065
2066 if (hint <= max_hint)
2067 return hint;
2068 return 0;
2069}
2070
c75b1d94
JA
2071static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
2072{
2073 *kiocb = (struct kiocb) {
2074 .ki_filp = filp,
2075 .ki_flags = iocb_flags(filp),
fc28724d 2076 .ki_hint = ki_hint_validate(file_write_hint(filp)),
20578bdf 2077 .ki_ioprio = get_current_ioprio(),
c75b1d94
JA
2078 };
2079}
2080
5dcdc43e
JX
2081static inline void kiocb_clone(struct kiocb *kiocb, struct kiocb *kiocb_src,
2082 struct file *filp)
2083{
2084 *kiocb = (struct kiocb) {
2085 .ki_filp = filp,
2086 .ki_flags = kiocb_src->ki_flags,
2087 .ki_hint = kiocb_src->ki_hint,
2088 .ki_ioprio = kiocb_src->ki_ioprio,
2089 .ki_pos = kiocb_src->ki_pos,
2090 };
2091}
2092
1c0eeaf5 2093/*
250df6ed 2094 * Inode state bits. Protected by inode->i_lock
1c0eeaf5
JE
2095 *
2096 * Three bits determine the dirty state of the inode, I_DIRTY_SYNC,
2097 * I_DIRTY_DATASYNC and I_DIRTY_PAGES.
2098 *
2099 * Four bits define the lifetime of an inode. Initially, inodes are I_NEW,
2100 * until that flag is cleared. I_WILL_FREE, I_FREEING and I_CLEAR are set at
2101 * various stages of removing an inode.
2102 *
eaff8079 2103 * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
1c0eeaf5 2104 *
e7ca2d41
JE
2105 * I_DIRTY_SYNC Inode is dirty, but doesn't have to be written on
2106 * fdatasync(). i_atime is the usual cause.
000cb48e
JK
2107 * I_DIRTY_DATASYNC Data-related inode changes pending. We keep track of
2108 * these changes separately from I_DIRTY_SYNC so that we
2109 * don't have to write inode on fdatasync() when only
2110 * mtime has changed in it.
1c0eeaf5 2111 * I_DIRTY_PAGES Inode has dirty pages. Inode itself may be clean.
eaff8079
CH
2112 * I_NEW Serves as both a mutex and completion notification.
2113 * New inodes set I_NEW. If two processes both create
2114 * the same inode, one of them will release its inode and
2115 * wait for I_NEW to be released before returning.
2116 * Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can
2117 * also cause waiting on I_NEW, without I_NEW actually
2118 * being set. find_inode() uses this to prevent returning
2119 * nearly-dead inodes.
1c0eeaf5
JE
2120 * I_WILL_FREE Must be set when calling write_inode_now() if i_count
2121 * is zero. I_FREEING must be set when I_WILL_FREE is
2122 * cleared.
2123 * I_FREEING Set when inode is about to be freed but still has dirty
2124 * pages or buffers attached or the inode itself is still
2125 * dirty.
dbd5768f
JK
2126 * I_CLEAR Added by clear_inode(). In this state the inode is
2127 * clean and can be destroyed. Inode keeps I_FREEING.
1c0eeaf5
JE
2128 *
2129 * Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are
2130 * prohibited for many purposes. iget() must wait for
2131 * the inode to be completely released, then create it
2132 * anew. Other functions will just ignore such inodes,
eaff8079 2133 * if appropriate. I_NEW is used for waiting.
1c0eeaf5 2134 *
169ebd90
JK
2135 * I_SYNC Writeback of inode is running. The bit is set during
2136 * data writeback, and cleared with a wakeup on the bit
2137 * address once it is done. The bit is also used to pin
2138 * the inode in memory for flusher thread.
1c0eeaf5 2139 *
bd5fe6c5
CH
2140 * I_REFERENCED Marks the inode as recently references on the LRU list.
2141 *
2142 * I_DIO_WAKEUP Never set. Only used as a key for wait_on_bit().
2143 *
682aa8e1
TH
2144 * I_WB_SWITCH Cgroup bdi_writeback switching in progress. Used to
2145 * synchronize competing switching instances and to tell
b93b0163 2146 * wb stat updates to grab the i_pages lock. See
a9519def 2147 * inode_switch_wbs_work_fn() for details.
682aa8e1 2148 *
ad0af710
AG
2149 * I_OVL_INUSE Used by overlayfs to get exclusive ownership on upper
2150 * and work dirs among overlayfs mounts.
2151 *
c2b6d621
AV
2152 * I_CREATING New object's inode in the middle of setting up.
2153 *
1c0eeaf5 2154 * Q: What is the difference between I_WILL_FREE and I_FREEING?
1c0eeaf5 2155 */
9e38d86f
NP
2156#define I_DIRTY_SYNC (1 << 0)
2157#define I_DIRTY_DATASYNC (1 << 1)
2158#define I_DIRTY_PAGES (1 << 2)
eaff8079
CH
2159#define __I_NEW 3
2160#define I_NEW (1 << __I_NEW)
9e38d86f
NP
2161#define I_WILL_FREE (1 << 4)
2162#define I_FREEING (1 << 5)
2163#define I_CLEAR (1 << 6)
eaff8079 2164#define __I_SYNC 7
1c0eeaf5 2165#define I_SYNC (1 << __I_SYNC)
9e38d86f 2166#define I_REFERENCED (1 << 8)
bd5fe6c5 2167#define __I_DIO_WAKEUP 9
ac74d8d6 2168#define I_DIO_WAKEUP (1 << __I_DIO_WAKEUP)
f4e0c30c 2169#define I_LINKABLE (1 << 10)
0ae45f63
TT
2170#define I_DIRTY_TIME (1 << 11)
2171#define __I_DIRTY_TIME_EXPIRED 12
2172#define I_DIRTY_TIME_EXPIRED (1 << __I_DIRTY_TIME_EXPIRED)
682aa8e1 2173#define I_WB_SWITCH (1 << 13)
c2b6d621
AV
2174#define I_OVL_INUSE (1 << 14)
2175#define I_CREATING (1 << 15)
1da177e4 2176
0e11f644
CH
2177#define I_DIRTY_INODE (I_DIRTY_SYNC | I_DIRTY_DATASYNC)
2178#define I_DIRTY (I_DIRTY_INODE | I_DIRTY_PAGES)
0ae45f63 2179#define I_DIRTY_ALL (I_DIRTY | I_DIRTY_TIME)
1da177e4
LT
2180
2181extern void __mark_inode_dirty(struct inode *, int);
2182static inline void mark_inode_dirty(struct inode *inode)
2183{
2184 __mark_inode_dirty(inode, I_DIRTY);
2185}
2186
2187static inline void mark_inode_dirty_sync(struct inode *inode)
2188{
2189 __mark_inode_dirty(inode, I_DIRTY_SYNC);
2190}
2191
7ada4db8
MS
2192extern void inc_nlink(struct inode *inode);
2193extern void drop_nlink(struct inode *inode);
2194extern void clear_nlink(struct inode *inode);
2195extern void set_nlink(struct inode *inode, unsigned int nlink);
d8c76e6f
DH
2196
2197static inline void inode_inc_link_count(struct inode *inode)
2198{
2199 inc_nlink(inode);
66d21730
AD
2200 mark_inode_dirty(inode);
2201}
2202
9a53c3a7
DH
2203static inline void inode_dec_link_count(struct inode *inode)
2204{
2205 drop_nlink(inode);
66d21730
AD
2206 mark_inode_dirty(inode);
2207}
2208
c3b2da31
JB
2209enum file_time_flags {
2210 S_ATIME = 1,
2211 S_MTIME = 2,
2212 S_CTIME = 4,
2213 S_VERSION = 8,
2214};
2215
c6718543 2216extern bool atime_needs_update(const struct path *, struct inode *);
badcf2b7 2217extern void touch_atime(const struct path *);
1da177e4
LT
2218static inline void file_accessed(struct file *file)
2219{
2220 if (!(file->f_flags & O_NOATIME))
68ac1234 2221 touch_atime(&file->f_path);
1da177e4
LT
2222}
2223
e38f7f53
AG
2224extern int file_modified(struct file *file);
2225
1da177e4 2226int sync_inode(struct inode *inode, struct writeback_control *wbc);
c3765016 2227int sync_inode_metadata(struct inode *inode, int wait);
1da177e4 2228
1da177e4
LT
2229struct file_system_type {
2230 const char *name;
2231 int fs_flags;
bbc1096a
DH
2232#define FS_REQUIRES_DEV 1
2233#define FS_BINARY_MOUNTDATA 2
2234#define FS_HAS_SUBTYPE 4
0c55cfc4 2235#define FS_USERNS_MOUNT 8 /* Can be mounted by userns root */
0b3b094a 2236#define FS_DISALLOW_NOTIFY_PERM 16 /* Disable fanotify permission events */
bbc1096a 2237#define FS_RENAME_DOES_D_MOVE 32768 /* FS will handle d_move() during rename() internally. */
f3a09c92 2238 int (*init_fs_context)(struct fs_context *);
d7167b14 2239 const struct fs_parameter_spec *parameters;
c96e41e9
AV
2240 struct dentry *(*mount) (struct file_system_type *, int,
2241 const char *, void *);
1da177e4
LT
2242 void (*kill_sb) (struct super_block *);
2243 struct module *owner;
2244 struct file_system_type * next;
a5166169 2245 struct hlist_head fs_supers;
d475fd42 2246
cf516249 2247 struct lock_class_key s_lock_key;
897c6ff9 2248 struct lock_class_key s_umount_key;
51ee049e 2249 struct lock_class_key s_vfs_rename_key;
5accdf82 2250 struct lock_class_key s_writers_key[SB_FREEZE_LEVELS];
d475fd42
PZ
2251
2252 struct lock_class_key i_lock_key;
2253 struct lock_class_key i_mutex_key;
14358e6d 2254 struct lock_class_key i_mutex_dir_key;
1da177e4
LT
2255};
2256
7f78e035
EB
2257#define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME)
2258
f175f307 2259#ifdef CONFIG_BLOCK
152a0836
AV
2260extern struct dentry *mount_bdev(struct file_system_type *fs_type,
2261 int flags, const char *dev_name, void *data,
2262 int (*fill_super)(struct super_block *, void *, int));
f175f307
AV
2263#else
2264static inline struct dentry *mount_bdev(struct file_system_type *fs_type,
2265 int flags, const char *dev_name, void *data,
2266 int (*fill_super)(struct super_block *, void *, int))
2267{
2268 return ERR_PTR(-ENODEV);
2269}
2270#endif
fc14f2fe
AV
2271extern struct dentry *mount_single(struct file_system_type *fs_type,
2272 int flags, void *data,
2273 int (*fill_super)(struct super_block *, void *, int));
3c26ff6e
AV
2274extern struct dentry *mount_nodev(struct file_system_type *fs_type,
2275 int flags, void *data,
2276 int (*fill_super)(struct super_block *, void *, int));
ea441d11 2277extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
1da177e4 2278void generic_shutdown_super(struct super_block *sb);
f175f307 2279#ifdef CONFIG_BLOCK
1da177e4 2280void kill_block_super(struct super_block *sb);
f175f307
AV
2281#else
2282static inline void kill_block_super(struct super_block *sb)
2283{
2284 BUG();
2285}
2286#endif
1da177e4
LT
2287void kill_anon_super(struct super_block *sb);
2288void kill_litter_super(struct super_block *sb);
2289void deactivate_super(struct super_block *sb);
74dbbdd7 2290void deactivate_locked_super(struct super_block *sb);
1da177e4 2291int set_anon_super(struct super_block *s, void *data);
cb50b348 2292int set_anon_super_fc(struct super_block *s, struct fs_context *fc);
0ee5dc67
AV
2293int get_anon_bdev(dev_t *);
2294void free_anon_bdev(dev_t);
cb50b348
AV
2295struct super_block *sget_fc(struct fs_context *fc,
2296 int (*test)(struct super_block *, struct fs_context *),
2297 int (*set)(struct super_block *, struct fs_context *));
1da177e4
LT
2298struct super_block *sget(struct file_system_type *type,
2299 int (*test)(struct super_block *,void *),
2300 int (*set)(struct super_block *,void *),
9249e17f 2301 int flags, void *data);
1da177e4
LT
2302
2303/* Alas, no aliases. Too much hassle with bringing module.h everywhere */
2304#define fops_get(fops) \
2305 (((fops) && try_module_get((fops)->owner) ? (fops) : NULL))
2306#define fops_put(fops) \
2307 do { if (fops) module_put((fops)->owner); } while(0)
e84f9e57
AV
2308/*
2309 * This one is to be used *ONLY* from ->open() instances.
2310 * fops must be non-NULL, pinned down *and* module dependencies
2311 * should be sufficient to pin the caller down as well.
2312 */
2313#define replace_fops(f, fops) \
2314 do { \
2315 struct file *__file = (f); \
2316 fops_put(__file->f_op); \
2317 BUG_ON(!(__file->f_op = (fops))); \
2318 } while(0)
1da177e4
LT
2319
2320extern int register_filesystem(struct file_system_type *);
2321extern int unregister_filesystem(struct file_system_type *);
d911b458 2322extern struct vfsmount *kern_mount(struct file_system_type *);
423e0ab0 2323extern void kern_unmount(struct vfsmount *mnt);
1da177e4
LT
2324extern int may_umount_tree(struct vfsmount *);
2325extern int may_umount(struct vfsmount *);
5e6123f3
SL
2326extern long do_mount(const char *, const char __user *,
2327 const char *, unsigned long, void *);
ca71cf71 2328extern struct vfsmount *collect_mounts(const struct path *);
8aec0809 2329extern void drop_collected_mounts(struct vfsmount *);
1f707137
AV
2330extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
2331 struct vfsmount *);
f0bb5aaf 2332extern int vfs_statfs(const struct path *, struct kstatfs *);
c8b91acc
AV
2333extern int user_statfs(const char __user *, struct kstatfs *);
2334extern int fd_statfs(int, struct kstatfs *);
18e9e510
JB
2335extern int freeze_super(struct super_block *super);
2336extern int thaw_super(struct super_block *super);
02125a82 2337extern bool our_mnt(struct vfsmount *mnt);
fca39346
JK
2338extern __printf(2, 3)
2339int super_setup_bdi_name(struct super_block *sb, char *fmt, ...);
2340extern int super_setup_bdi(struct super_block *sb);
1da177e4 2341
ce3b0f8d
AV
2342extern int current_umask(void);
2343
5a14696c
BF
2344extern void ihold(struct inode * inode);
2345extern void iput(struct inode *);
95582b00 2346extern int generic_update_time(struct inode *, struct timespec64 *, int);
5a14696c 2347
f87fd4c2 2348/* /sys/fs */
00d26666 2349extern struct kobject *fs_kobj;
f87fd4c2 2350
09cbfeaf 2351#define MAX_RW_COUNT (INT_MAX & PAGE_MASK)
bfcd17a6 2352
9e8925b6 2353#ifdef CONFIG_MANDATORY_FILE_LOCKING
d7a06983 2354extern int locks_mandatory_locked(struct file *);
acc15575 2355extern int locks_mandatory_area(struct inode *, struct file *, loff_t, loff_t, unsigned char);
1da177e4
LT
2356
2357/*
2358 * Candidates for mandatory locking have the setgid bit set
2359 * but no group execute bit - an otherwise meaningless combination.
2360 */
a16877ca
PE
2361
2362static inline int __mandatory_lock(struct inode *ino)
2363{
2364 return (ino->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID;
2365}
2366
2367/*
e462ec50 2368 * ... and these candidates should be on SB_MANDLOCK mounted fs,
a16877ca
PE
2369 * otherwise these will be advisory locks
2370 */
2371
2372static inline int mandatory_lock(struct inode *ino)
2373{
2374 return IS_MANDLOCK(ino) && __mandatory_lock(ino);
2375}
1da177e4 2376
d7a06983 2377static inline int locks_verify_locked(struct file *file)
1da177e4 2378{
c568d683 2379 if (mandatory_lock(locks_inode(file)))
d7a06983 2380 return locks_mandatory_locked(file);
1da177e4
LT
2381 return 0;
2382}
2383
1da177e4 2384static inline int locks_verify_truncate(struct inode *inode,
acc15575 2385 struct file *f,
1da177e4
LT
2386 loff_t size)
2387{
acc15575
CH
2388 if (!inode->i_flctx || !mandatory_lock(inode))
2389 return 0;
2390
2391 if (size < inode->i_size) {
2392 return locks_mandatory_area(inode, f, size, inode->i_size - 1,
2393 F_WRLCK);
2394 } else {
2395 return locks_mandatory_area(inode, f, inode->i_size, size - 1,
2396 F_WRLCK);
2397 }
1da177e4
LT
2398}
2399
9e8925b6
JL
2400#else /* !CONFIG_MANDATORY_FILE_LOCKING */
2401
2402static inline int locks_mandatory_locked(struct file *file)
2403{
2404 return 0;
2405}
2406
fce205e9
LT
2407static inline int locks_mandatory_area(struct inode *inode, struct file *filp,
2408 loff_t start, loff_t end, unsigned char type)
9e8925b6
JL
2409{
2410 return 0;
2411}
2412
2413static inline int __mandatory_lock(struct inode *inode)
2414{
2415 return 0;
2416}
2417
2418static inline int mandatory_lock(struct inode *inode)
2419{
2420 return 0;
2421}
2422
2423static inline int locks_verify_locked(struct file *file)
2424{
2425 return 0;
2426}
2427
2428static inline int locks_verify_truncate(struct inode *inode, struct file *filp,
2429 size_t size)
2430{
2431 return 0;
2432}
2433
2434#endif /* CONFIG_MANDATORY_FILE_LOCKING */
2435
2436
2437#ifdef CONFIG_FILE_LOCKING
1da177e4
LT
2438static inline int break_lease(struct inode *inode, unsigned int mode)
2439{
24cbe784
JL
2440 /*
2441 * Since this check is lockless, we must ensure that any refcounts
8116bf4c
JL
2442 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2443 * could end up racing with tasks trying to set a new lease on this
2444 * file.
24cbe784
JL
2445 */
2446 smp_mb();
8634b51f 2447 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
df4e8d2c 2448 return __break_lease(inode, mode, FL_LEASE);
1da177e4
LT
2449 return 0;
2450}
df4e8d2c
BF
2451
2452static inline int break_deleg(struct inode *inode, unsigned int mode)
2453{
962bd40b
JL
2454 /*
2455 * Since this check is lockless, we must ensure that any refcounts
8116bf4c
JL
2456 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2457 * could end up racing with tasks trying to set a new lease on this
2458 * file.
962bd40b
JL
2459 */
2460 smp_mb();
8634b51f 2461 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
df4e8d2c 2462 return __break_lease(inode, mode, FL_DELEG);
1da177e4
LT
2463 return 0;
2464}
df4e8d2c 2465
5a14696c
BF
2466static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2467{
2468 int ret;
2469
2470 ret = break_deleg(inode, O_WRONLY|O_NONBLOCK);
2471 if (ret == -EWOULDBLOCK && delegated_inode) {
2472 *delegated_inode = inode;
2473 ihold(inode);
2474 }
2475 return ret;
2476}
2477
2478static inline int break_deleg_wait(struct inode **delegated_inode)
2479{
2480 int ret;
2481
2482 ret = break_deleg(*delegated_inode, O_WRONLY);
2483 iput(*delegated_inode);
2484 *delegated_inode = NULL;
2485 return ret;
2486}
2487
11afe9f7
CH
2488static inline int break_layout(struct inode *inode, bool wait)
2489{
2490 smp_mb();
2491 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2492 return __break_lease(inode,
2493 wait ? O_WRONLY : O_WRONLY | O_NONBLOCK,
2494 FL_LAYOUT);
2495 return 0;
2496}
2497
bfcd17a6 2498#else /* !CONFIG_FILE_LOCKING */
af5df566
SW
2499static inline int break_lease(struct inode *inode, unsigned int mode)
2500{
2501 return 0;
2502}
2503
df4e8d2c
BF
2504static inline int break_deleg(struct inode *inode, unsigned int mode)
2505{
2506 return 0;
2507}
5a14696c
BF
2508
2509static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2510{
2511 return 0;
2512}
2513
2514static inline int break_deleg_wait(struct inode **delegated_inode)
2515{
2516 BUG();
2517 return 0;
2518}
2519
11afe9f7
CH
2520static inline int break_layout(struct inode *inode, bool wait)
2521{
2522 return 0;
2523}
2524
bfcd17a6 2525#endif /* CONFIG_FILE_LOCKING */
1da177e4
LT
2526
2527/* fs/open.c */
adb5c247 2528struct audit_names;
91a27b2a 2529struct filename {
adb5c247
JL
2530 const char *name; /* pointer to actual string */
2531 const __user char *uptr; /* original userland pointer */
55422d0b 2532 int refcnt;
1c949843 2533 struct audit_names *aname;
fd2f7cb5 2534 const char iname[];
91a27b2a 2535};
f1fffbd4 2536static_assert(offsetof(struct filename, iname) % sizeof(long) == 0);
1da177e4 2537
7df818b2 2538extern long vfs_truncate(const struct path *, loff_t);
4a30131e
N
2539extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
2540 struct file *filp);
72c72bdf 2541extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
3e63cbb1 2542 loff_t len);
8e8a1407 2543extern long do_sys_open(int dfd, const char __user *filename, int flags,
a218d0fd 2544 umode_t mode);
669abf4e 2545extern struct file *file_open_name(struct filename *, int, umode_t);
a218d0fd 2546extern struct file *filp_open(const char *, int, umode_t);
73d049a4 2547extern struct file *file_open_root(struct dentry *, struct vfsmount *,
378c6520 2548 const char *, int, umode_t);
765927b2 2549extern struct file * dentry_open(const struct path *, int, const struct cred *);
2abc77af
AV
2550extern struct file * open_with_fake_path(const struct path *, int,
2551 struct inode*, const struct cred *);
19f391eb
AV
2552static inline struct file *file_clone_open(struct file *file)
2553{
2554 return dentry_open(&file->f_path, file->f_flags, file->f_cred);
2555}
1da177e4 2556extern int filp_close(struct file *, fl_owner_t id);
91a27b2a 2557
51f39a1f 2558extern struct filename *getname_flags(const char __user *, int, int *);
91a27b2a 2559extern struct filename *getname(const char __user *);
c4ad8f98 2560extern struct filename *getname_kernel(const char *);
55422d0b 2561extern void putname(struct filename *name);
91a27b2a 2562
30d90494 2563extern int finish_open(struct file *file, struct dentry *dentry,
be12af3e 2564 int (*open)(struct inode *, struct file *));
e45198a6 2565extern int finish_no_open(struct file *file, struct dentry *dentry);
1da177e4
LT
2566
2567/* fs/dcache.c */
2568extern void __init vfs_caches_init_early(void);
4248b0da 2569extern void __init vfs_caches_init(void);
1da177e4 2570
b86c089b
CL
2571extern struct kmem_cache *names_cachep;
2572
a608ca21 2573#define __getname() kmem_cache_alloc(names_cachep, GFP_KERNEL)
3446a8aa 2574#define __putname(name) kmem_cache_free(names_cachep, (void *)(name))
1da177e4 2575
9361401e 2576#ifdef CONFIG_BLOCK
1da177e4 2577extern int register_blkdev(unsigned int, const char *);
f4480240 2578extern void unregister_blkdev(unsigned int, const char *);
f44f1ab5 2579extern void bdev_unhash_inode(dev_t dev);
1da177e4 2580extern struct block_device *bdget(dev_t);
dddac6a7 2581extern struct block_device *bdgrab(struct block_device *bdev);
1da177e4
LT
2582extern void bd_set_size(struct block_device *, loff_t size);
2583extern void bd_forget(struct inode *inode);
2584extern void bdput(struct block_device *);
585d3bc0 2585extern void invalidate_bdev(struct block_device *);
5c0d6b60 2586extern void iterate_bdevs(void (*)(struct block_device *, void *), void *);
585d3bc0 2587extern int sync_blockdev(struct block_device *bdev);
ff01bb48 2588extern void kill_bdev(struct block_device *);
585d3bc0 2589extern struct super_block *freeze_bdev(struct block_device *);
c2d75438 2590extern void emergency_thaw_all(void);
08fdc8a0 2591extern void emergency_thaw_bdev(struct super_block *sb);
585d3bc0
NP
2592extern int thaw_bdev(struct block_device *bdev, struct super_block *sb);
2593extern int fsync_bdev(struct block_device *);
a212b105
TH
2594
2595extern struct super_block *blockdev_superblock;
2596
2597static inline bool sb_is_blkdev_sb(struct super_block *sb)
2598{
2599 return sb == blockdev_superblock;
2600}
9361401e
DH
2601#else
2602static inline void bd_forget(struct inode *inode) {}
47e4491b 2603static inline int sync_blockdev(struct block_device *bdev) { return 0; }
ff01bb48 2604static inline void kill_bdev(struct block_device *bdev) {}
47e4491b
AV
2605static inline void invalidate_bdev(struct block_device *bdev) {}
2606
2607static inline struct super_block *freeze_bdev(struct block_device *sb)
2608{
2609 return NULL;
2610}
2611
2612static inline int thaw_bdev(struct block_device *bdev, struct super_block *sb)
2613{
2614 return 0;
2615}
5c0d6b60 2616
08fdc8a0
MG
2617static inline int emergency_thaw_bdev(struct super_block *sb)
2618{
2619 return 0;
2620}
2621
5c0d6b60
JK
2622static inline void iterate_bdevs(void (*f)(struct block_device *, void *), void *arg)
2623{
2624}
a8855990 2625
3e004eea 2626static inline bool sb_is_blkdev_sb(struct super_block *sb)
a8855990 2627{
3e004eea 2628 return false;
a8855990 2629}
9361401e 2630#endif
60b0680f 2631extern int sync_filesystem(struct super_block *);
9361401e 2632extern const struct file_operations def_blk_fops;
4b6f5d20 2633extern const struct file_operations def_chr_fops;
9361401e 2634#ifdef CONFIG_BLOCK
1da177e4 2635extern int ioctl_by_bdev(struct block_device *, unsigned, unsigned long);
56b26add 2636extern int blkdev_ioctl(struct block_device *, fmode_t, unsigned, unsigned long);
1da177e4 2637extern long compat_blkdev_ioctl(struct file *, unsigned, unsigned long);
e525fd89 2638extern int blkdev_get(struct block_device *bdev, fmode_t mode, void *holder);
d4d77629
TH
2639extern struct block_device *blkdev_get_by_path(const char *path, fmode_t mode,
2640 void *holder);
2641extern struct block_device *blkdev_get_by_dev(dev_t dev, fmode_t mode,
2642 void *holder);
89e524c0
JK
2643extern struct block_device *bd_start_claiming(struct block_device *bdev,
2644 void *holder);
2645extern void bd_finish_claiming(struct block_device *bdev,
2646 struct block_device *whole, void *holder);
2647extern void bd_abort_claiming(struct block_device *bdev,
2648 struct block_device *whole, void *holder);
4385bab1 2649extern void blkdev_put(struct block_device *bdev, fmode_t mode);
be324177 2650
641dc636 2651#ifdef CONFIG_SYSFS
e09b457b 2652extern int bd_link_disk_holder(struct block_device *bdev, struct gendisk *disk);
49731baa
TH
2653extern void bd_unlink_disk_holder(struct block_device *bdev,
2654 struct gendisk *disk);
641dc636 2655#else
e09b457b
TH
2656static inline int bd_link_disk_holder(struct block_device *bdev,
2657 struct gendisk *disk)
2658{
2659 return 0;
2660}
49731baa
TH
2661static inline void bd_unlink_disk_holder(struct block_device *bdev,
2662 struct gendisk *disk)
2663{
2664}
641dc636 2665#endif
9361401e 2666#endif
1da177e4
LT
2667
2668/* fs/char_dev.c */
8a932f73 2669#define CHRDEV_MAJOR_MAX 512
49db08c3
LW
2670/* Marks the bottom of the first segment of free char majors */
2671#define CHRDEV_MAJOR_DYN_END 234
a5d31a3f
LG
2672/* Marks the top and bottom of the second segment of free char majors */
2673#define CHRDEV_MAJOR_DYN_EXT_START 511
2674#define CHRDEV_MAJOR_DYN_EXT_END 384
2675
1da177e4
LT
2676extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
2677extern int register_chrdev_region(dev_t, unsigned, const char *);
1905b1bf
TH
2678extern int __register_chrdev(unsigned int major, unsigned int baseminor,
2679 unsigned int count, const char *name,
2680 const struct file_operations *fops);
2681extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
2682 unsigned int count, const char *name);
1da177e4 2683extern void unregister_chrdev_region(dev_t, unsigned);
68eef3b4 2684extern void chrdev_show(struct seq_file *,off_t);
1da177e4 2685
1905b1bf
TH
2686static inline int register_chrdev(unsigned int major, const char *name,
2687 const struct file_operations *fops)
2688{
2689 return __register_chrdev(major, 0, 256, name, fops);
2690}
2691
2692static inline void unregister_chrdev(unsigned int major, const char *name)
2693{
2694 __unregister_chrdev(major, 0, 256, name);
2695}
2696
1da177e4
LT
2697/* fs/block_dev.c */
2698#define BDEVNAME_SIZE 32 /* Largest string for a blockdev identifier */
1f014290 2699#define BDEVT_SIZE 10 /* Largest string for MAJ:MIN for blkdev */
9361401e
DH
2700
2701#ifdef CONFIG_BLOCK
133d55cd 2702#define BLKDEV_MAJOR_MAX 512
1da177e4
LT
2703extern const char *bdevname(struct block_device *bdev, char *buffer);
2704extern struct block_device *lookup_bdev(const char *);
68eef3b4 2705extern void blkdev_show(struct seq_file *,off_t);
30c40d2c 2706
9361401e 2707#else
133d55cd 2708#define BLKDEV_MAJOR_MAX 0
9361401e 2709#endif
1da177e4
LT
2710
2711extern void init_special_inode(struct inode *, umode_t, dev_t);
2712
2713/* Invalid inode operations -- fs/bad_inode.c */
2714extern void make_bad_inode(struct inode *);
0e3ef1fe 2715extern bool is_bad_inode(struct inode *);
1da177e4 2716
c11f0c0b 2717#ifdef CONFIG_BLOCK
0c002c2f 2718extern int revalidate_disk(struct gendisk *);
1da177e4 2719extern int check_disk_change(struct block_device *);
93b270f7 2720extern int __invalidate_device(struct block_device *, bool);
1da177e4 2721extern int invalidate_partition(struct gendisk *, int);
9361401e 2722#endif
1da177e4
LT
2723unsigned long invalidate_mapping_pages(struct address_space *mapping,
2724 pgoff_t start, pgoff_t end);
54bc4855 2725
1da177e4
LT
2726static inline void invalidate_remote_inode(struct inode *inode)
2727{
2728 if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
2729 S_ISLNK(inode->i_mode))
fc0ecff6 2730 invalidate_mapping_pages(inode->i_mapping, 0, -1);
1da177e4
LT
2731}
2732extern int invalidate_inode_pages2(struct address_space *mapping);
2733extern int invalidate_inode_pages2_range(struct address_space *mapping,
2734 pgoff_t start, pgoff_t end);
2735extern int write_inode_now(struct inode *, int);
2736extern int filemap_fdatawrite(struct address_space *);
2737extern int filemap_flush(struct address_space *);
76341cab 2738extern int filemap_fdatawait_keep_errors(struct address_space *mapping);
d3bccb6f
JK
2739extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
2740 loff_t lend);
aa0bfcd9
RZ
2741extern int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
2742 loff_t start_byte, loff_t end_byte);
ffb959bb
JL
2743
2744static inline int filemap_fdatawait(struct address_space *mapping)
2745{
2746 return filemap_fdatawait_range(mapping, 0, LLONG_MAX);
2747}
2748
7fc9e472
GR
2749extern bool filemap_range_has_page(struct address_space *, loff_t lstart,
2750 loff_t lend);
1da177e4
LT
2751extern int filemap_write_and_wait_range(struct address_space *mapping,
2752 loff_t lstart, loff_t lend);
ebcf28e1
AM
2753extern int __filemap_fdatawrite_range(struct address_space *mapping,
2754 loff_t start, loff_t end, int sync_mode);
f4c0a0fd
JK
2755extern int filemap_fdatawrite_range(struct address_space *mapping,
2756 loff_t start, loff_t end);
d72d9e2a 2757extern int filemap_check_errors(struct address_space *mapping);
5660e13d 2758extern void __filemap_set_wb_err(struct address_space *mapping, int err);
a823e458 2759
ddf8f376
IW
2760static inline int filemap_write_and_wait(struct address_space *mapping)
2761{
2762 return filemap_write_and_wait_range(mapping, 0, LLONG_MAX);
2763}
2764
a823e458
JL
2765extern int __must_check file_fdatawait_range(struct file *file, loff_t lstart,
2766 loff_t lend);
5660e13d
JL
2767extern int __must_check file_check_and_advance_wb_err(struct file *file);
2768extern int __must_check file_write_and_wait_range(struct file *file,
2769 loff_t start, loff_t end);
2770
a823e458
JL
2771static inline int file_write_and_wait(struct file *file)
2772{
2773 return file_write_and_wait_range(file, 0, LLONG_MAX);
2774}
2775
5660e13d
JL
2776/**
2777 * filemap_set_wb_err - set a writeback error on an address_space
2778 * @mapping: mapping in which to set writeback error
2779 * @err: error to be set in mapping
2780 *
2781 * When writeback fails in some way, we must record that error so that
2782 * userspace can be informed when fsync and the like are called. We endeavor
2783 * to report errors on any file that was open at the time of the error. Some
2784 * internal callers also need to know when writeback errors have occurred.
2785 *
2786 * When a writeback error occurs, most filesystems will want to call
2787 * filemap_set_wb_err to record the error in the mapping so that it will be
2788 * automatically reported whenever fsync is called on the file.
5660e13d
JL
2789 */
2790static inline void filemap_set_wb_err(struct address_space *mapping, int err)
2791{
2792 /* Fastpath for common case of no error */
2793 if (unlikely(err))
2794 __filemap_set_wb_err(mapping, err);
2795}
2796
2797/**
2798 * filemap_check_wb_error - has an error occurred since the mark was sampled?
2799 * @mapping: mapping to check for writeback errors
2800 * @since: previously-sampled errseq_t
2801 *
2802 * Grab the errseq_t value from the mapping, and see if it has changed "since"
2803 * the given value was sampled.
2804 *
2805 * If it has then report the latest error set, otherwise return 0.
2806 */
2807static inline int filemap_check_wb_err(struct address_space *mapping,
2808 errseq_t since)
2809{
2810 return errseq_check(&mapping->wb_err, since);
2811}
2812
2813/**
2814 * filemap_sample_wb_err - sample the current errseq_t to test for later errors
2815 * @mapping: mapping to be sampled
2816 *
2817 * Writeback errors are always reported relative to a particular sample point
2818 * in the past. This function provides those sample points.
2819 */
2820static inline errseq_t filemap_sample_wb_err(struct address_space *mapping)
2821{
2822 return errseq_sample(&mapping->wb_err);
2823}
2824
09d91cda
SL
2825static inline int filemap_nr_thps(struct address_space *mapping)
2826{
2827#ifdef CONFIG_READ_ONLY_THP_FOR_FS
2828 return atomic_read(&mapping->nr_thps);
2829#else
2830 return 0;
2831#endif
2832}
2833
2834static inline void filemap_nr_thps_inc(struct address_space *mapping)
2835{
2836#ifdef CONFIG_READ_ONLY_THP_FOR_FS
2837 atomic_inc(&mapping->nr_thps);
2838#else
2839 WARN_ON_ONCE(1);
2840#endif
2841}
2842
2843static inline void filemap_nr_thps_dec(struct address_space *mapping)
2844{
2845#ifdef CONFIG_READ_ONLY_THP_FOR_FS
2846 atomic_dec(&mapping->nr_thps);
2847#else
2848 WARN_ON_ONCE(1);
2849#endif
2850}
2851
8018ab05
CH
2852extern int vfs_fsync_range(struct file *file, loff_t start, loff_t end,
2853 int datasync);
2854extern int vfs_fsync(struct file *file, int datasync);
e2592217 2855
22f96b38
JA
2856extern int sync_file_range(struct file *file, loff_t offset, loff_t nbytes,
2857 unsigned int flags);
2858
e2592217
CH
2859/*
2860 * Sync the bytes written if this was a synchronous write. Expect ki_pos
2861 * to already be updated for the write, and will return either the amount
2862 * of bytes passed in, or an error if syncing the file failed.
2863 */
2864static inline ssize_t generic_write_sync(struct kiocb *iocb, ssize_t count)
2865{
2866 if (iocb->ki_flags & IOCB_DSYNC) {
2867 int ret = vfs_fsync_range(iocb->ki_filp,
2868 iocb->ki_pos - count, iocb->ki_pos - 1,
2869 (iocb->ki_flags & IOCB_SYNC) ? 0 : 1);
2870 if (ret)
2871 return ret;
2872 }
2873
2874 return count;
d311d79d 2875}
e2592217 2876
1da177e4
LT
2877extern void emergency_sync(void);
2878extern void emergency_remount(void);
30460e1e 2879
9361401e 2880#ifdef CONFIG_BLOCK
30460e1e
CM
2881extern int bmap(struct inode *inode, sector_t *block);
2882#else
2883static inline int bmap(struct inode *inode, sector_t *block)
2884{
2885 return -EINVAL;
2886}
9361401e 2887#endif
30460e1e 2888
27ac0ffe 2889extern int notify_change(struct dentry *, struct iattr *, struct inode **);
f419a2e3 2890extern int inode_permission(struct inode *, int);
2830ba7f 2891extern int generic_permission(struct inode *, int);
cbdf35bc 2892extern int __check_sticky(struct inode *dir, struct inode *inode);
1da177e4 2893
f696a365
MS
2894static inline bool execute_ok(struct inode *inode)
2895{
2896 return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
2897}
2898
8d71db4f
AV
2899static inline void file_start_write(struct file *file)
2900{
2901 if (!S_ISREG(file_inode(file)->i_mode))
2902 return;
2903 __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, true);
2904}
2905
5ae98f15
JK
2906static inline bool file_start_write_trylock(struct file *file)
2907{
2908 if (!S_ISREG(file_inode(file)->i_mode))
2909 return true;
2910 return __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, false);
2911}
2912
8d71db4f
AV
2913static inline void file_end_write(struct file *file)
2914{
2915 if (!S_ISREG(file_inode(file)->i_mode))
2916 return;
2917 __sb_end_write(file_inode(file)->i_sb, SB_FREEZE_WRITE);
2918}
bfe219d3 2919
07b8ce1e
AV
2920/*
2921 * get_write_access() gets write permission for a file.
2922 * put_write_access() releases this write permission.
2923 * This is used for regular files.
2924 * We cannot support write (and maybe mmap read-write shared) accesses and
2925 * MAP_DENYWRITE mmappings simultaneously. The i_writecount field of an inode
2926 * can have the following values:
2927 * 0: no writers, no VM_DENYWRITE mappings
2928 * < 0: (-i_writecount) vm_area_structs with VM_DENYWRITE set exist
2929 * > 0: (i_writecount) users are writing to the file.
2930 *
2931 * Normally we operate on that counter with atomic_{inc,dec} and it's safe
2932 * except for the cases where we don't hold i_writecount yet. Then we need to
2933 * use {get,deny}_write_access() - these functions check the sign and refuse
2934 * to do the change if sign is wrong.
2935 */
2936static inline int get_write_access(struct inode *inode)
2937{
2938 return atomic_inc_unless_negative(&inode->i_writecount) ? 0 : -ETXTBSY;
2939}
2940static inline int deny_write_access(struct file *file)
2941{
496ad9aa 2942 struct inode *inode = file_inode(file);
07b8ce1e
AV
2943 return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
2944}
1da177e4
LT
2945static inline void put_write_access(struct inode * inode)
2946{
2947 atomic_dec(&inode->i_writecount);
2948}
2949static inline void allow_write_access(struct file *file)
2950{
2951 if (file)
496ad9aa 2952 atomic_inc(&file_inode(file)->i_writecount);
1da177e4 2953}
f1fe29b4
DH
2954static inline bool inode_is_open_for_write(const struct inode *inode)
2955{
2956 return atomic_read(&inode->i_writecount) > 0;
2957}
2958
387e3746 2959#if defined(CONFIG_IMA) || defined(CONFIG_FILE_LOCKING)
a5c96ebf
MZ
2960static inline void i_readcount_dec(struct inode *inode)
2961{
2962 BUG_ON(!atomic_read(&inode->i_readcount));
2963 atomic_dec(&inode->i_readcount);
2964}
2965static inline void i_readcount_inc(struct inode *inode)
2966{
2967 atomic_inc(&inode->i_readcount);
2968}
2969#else
2970static inline void i_readcount_dec(struct inode *inode)
2971{
2972 return;
2973}
2974static inline void i_readcount_inc(struct inode *inode)
2975{
2976 return;
2977}
2978#endif
ed8cae8b 2979extern int do_pipe_flags(int *, int);
1da177e4 2980
1284ab5b
MZ
2981#define __kernel_read_file_id(id) \
2982 id(UNKNOWN, unknown) \
2983 id(FIRMWARE, firmware) \
a098ecd2 2984 id(FIRMWARE_PREALLOC_BUFFER, firmware) \
e4c2c0ff 2985 id(FIRMWARE_EFI_EMBEDDED, firmware) \
1284ab5b
MZ
2986 id(MODULE, kernel-module) \
2987 id(KEXEC_IMAGE, kexec-image) \
2988 id(KEXEC_INITRAMFS, kexec-initramfs) \
2989 id(POLICY, security-policy) \
a7d3d039 2990 id(X509_CERTIFICATE, x509-certificate) \
1284ab5b
MZ
2991 id(MAX_ID, )
2992
2993#define __fid_enumify(ENUM, dummy) READING_ ## ENUM,
2994#define __fid_stringify(dummy, str) #str,
2995
bc8ca5b9 2996enum kernel_read_file_id {
1284ab5b
MZ
2997 __kernel_read_file_id(__fid_enumify)
2998};
2999
3000static const char * const kernel_read_file_str[] = {
3001 __kernel_read_file_id(__fid_stringify)
bc8ca5b9
MZ
3002};
3003
da20dfe6 3004static inline const char *kernel_read_file_id_str(enum kernel_read_file_id id)
1284ab5b 3005{
cbfd0c10 3006 if ((unsigned)id >= READING_MAX_ID)
1284ab5b
MZ
3007 return kernel_read_file_str[READING_UNKNOWN];
3008
3009 return kernel_read_file_str[id];
3010}
3011
bc8ca5b9
MZ
3012extern int kernel_read_file(struct file *, void **, loff_t *, loff_t,
3013 enum kernel_read_file_id);
711aab1d 3014extern int kernel_read_file_from_path(const char *, void **, loff_t *, loff_t,
09596b94 3015 enum kernel_read_file_id);
901cff7c
TM
3016extern int kernel_read_file_from_path_initns(const char *, void **, loff_t *, loff_t,
3017 enum kernel_read_file_id);
b844f0ec
MZ
3018extern int kernel_read_file_from_fd(int, void **, loff_t *, loff_t,
3019 enum kernel_read_file_id);
bdd1d2d3 3020extern ssize_t kernel_read(struct file *, void *, size_t, loff_t *);
e13ec939 3021extern ssize_t kernel_write(struct file *, const void *, size_t, loff_t *);
73e18f7c 3022extern ssize_t __kernel_write(struct file *, const void *, size_t, loff_t *);
1da177e4
LT
3023extern struct file * open_exec(const char *);
3024
3025/* fs/dcache.c -- generic fs support functions */
a6e5787f 3026extern bool is_subdir(struct dentry *, struct dentry *);
640eb7e7 3027extern bool path_is_under(const struct path *, const struct path *);
1da177e4 3028
9bf39ab2
MS
3029extern char *file_path(struct file *, char *, int);
3030
1da177e4
LT
3031#include <linux/err.h>
3032
3033/* needed for stackable file system support */
965c8e59 3034extern loff_t default_llseek(struct file *file, loff_t offset, int whence);
1da177e4 3035
965c8e59 3036extern loff_t vfs_llseek(struct file *file, loff_t offset, int whence);
1da177e4 3037
54e34621 3038extern int inode_init_always(struct super_block *, struct inode *);
1da177e4 3039extern void inode_init_once(struct inode *);
2aa15890 3040extern void address_space_init_once(struct address_space *mapping);
1da177e4
LT
3041extern struct inode * igrab(struct inode *);
3042extern ino_t iunique(struct super_block *, ino_t);
3043extern int inode_needs_sync(struct inode *inode);
45321ac5 3044extern int generic_delete_inode(struct inode *inode);
9bcb4b73
AV
3045static inline int generic_drop_inode(struct inode *inode)
3046{
3047 return !inode->i_nlink || inode_unhashed(inode);
3048}
1da177e4 3049
88bd5121
AA
3050extern struct inode *ilookup5_nowait(struct super_block *sb,
3051 unsigned long hashval, int (*test)(struct inode *, void *),
3052 void *data);
1da177e4
LT
3053extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
3054 int (*test)(struct inode *, void *), void *data);
3055extern struct inode *ilookup(struct super_block *sb, unsigned long ino);
3056
80ea09a0
MS
3057extern struct inode *inode_insert5(struct inode *inode, unsigned long hashval,
3058 int (*test)(struct inode *, void *),
3059 int (*set)(struct inode *, void *),
3060 void *data);
1da177e4
LT
3061extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *);
3062extern struct inode * iget_locked(struct super_block *, unsigned long);
fe032c42
TT
3063extern struct inode *find_inode_nowait(struct super_block *,
3064 unsigned long,
3065 int (*match)(struct inode *,
3066 unsigned long, void *),
3067 void *data);
261bca86
AV
3068extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
3069extern int insert_inode_locked(struct inode *);
e096d0c7
JB
3070#ifdef CONFIG_DEBUG_LOCK_ALLOC
3071extern void lockdep_annotate_inode_mutex_key(struct inode *inode);
3072#else
3073static inline void lockdep_annotate_inode_mutex_key(struct inode *inode) { };
3074#endif
1da177e4 3075extern void unlock_new_inode(struct inode *);
c2b6d621 3076extern void discard_new_inode(struct inode *);
85fe4025 3077extern unsigned int get_next_ino(void);
799ea9e9 3078extern void evict_inodes(struct super_block *sb);
1da177e4 3079
1da177e4 3080extern void __iget(struct inode * inode);
b46980fe 3081extern void iget_failed(struct inode *);
dbd5768f 3082extern void clear_inode(struct inode *);
2e00c97e 3083extern void __destroy_inode(struct inode *);
a209dfc7
ED
3084extern struct inode *new_inode_pseudo(struct super_block *sb);
3085extern struct inode *new_inode(struct super_block *sb);
ff0c7d15 3086extern void free_inode_nonrcu(struct inode *inode);
01de85e0 3087extern int should_remove_suid(struct dentry *);
5fa8e0a1 3088extern int file_remove_privs(struct file *);
1da177e4
LT
3089
3090extern void __insert_inode_hash(struct inode *, unsigned long hashval);
646ec461
CH
3091static inline void insert_inode_hash(struct inode *inode)
3092{
1da177e4
LT
3093 __insert_inode_hash(inode, inode->i_ino);
3094}
f2ee7abf
ED
3095
3096extern void __remove_inode_hash(struct inode *);
3097static inline void remove_inode_hash(struct inode *inode)
3098{
cbedaac6 3099 if (!inode_unhashed(inode) && !hlist_fake(&inode->i_hash))
f2ee7abf
ED
3100 __remove_inode_hash(inode);
3101}
3102
646ec461 3103extern void inode_sb_list_add(struct inode *inode);
1da177e4 3104
9361401e 3105#ifdef CONFIG_BLOCK
1da177e4 3106extern int bdev_read_only(struct block_device *);
9361401e 3107#endif
1da177e4
LT
3108extern int set_blocksize(struct block_device *, int);
3109extern int sb_set_blocksize(struct super_block *, int);
3110extern int sb_min_blocksize(struct super_block *, int);
3111
3112extern int generic_file_mmap(struct file *, struct vm_area_struct *);
3113extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
3309dd04 3114extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *);
1383a7ed
DW
3115extern int generic_remap_checks(struct file *file_in, loff_t pos_in,
3116 struct file *file_out, loff_t pos_out,
42ec3d4c 3117 loff_t *count, unsigned int remap_flags);
a3171351 3118extern int generic_file_rw_checks(struct file *file_in, struct file *file_out);
96e6e8f4
AG
3119extern int generic_copy_file_checks(struct file *file_in, loff_t pos_in,
3120 struct file *file_out, loff_t pos_out,
3121 size_t *count, unsigned int flags);
ed978a81 3122extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
8174202b 3123extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
8174202b 3124extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
1af5bb49 3125extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *);
3b93f911 3126extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t);
88e6faef 3127
18e9710e 3128ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos,
ddef7ed2 3129 rwf_t flags);
abbb6589 3130ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos,
ddef7ed2 3131 rwf_t flags);
5dcdc43e
JX
3132ssize_t vfs_iocb_iter_read(struct file *file, struct kiocb *iocb,
3133 struct iov_iter *iter);
3134ssize_t vfs_iocb_iter_write(struct file *file, struct kiocb *iocb,
3135 struct iov_iter *iter);
dbe4e192 3136
eef99380 3137/* fs/block_dev.c */
b2de525f 3138extern ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to);
1456c0a8 3139extern ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from);
02c24a82
JB
3140extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
3141 int datasync);
ff01bb48 3142extern void block_sync_page(struct page *page);
eef99380 3143
88e6faef 3144/* fs/splice.c */
cbb7e577 3145extern ssize_t generic_file_splice_read(struct file *, loff_t *,
88e6faef 3146 struct pipe_inode_info *, size_t, unsigned int);
8d020765 3147extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
cbb7e577 3148 struct file *, loff_t *, size_t, unsigned int);
88e6faef 3149extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
cbb7e577 3150 struct file *out, loff_t *, size_t len, unsigned int flags);
1c118596
MS
3151extern long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
3152 loff_t *opos, size_t len, unsigned int flags);
3153
88e6faef 3154
1da177e4
LT
3155extern void
3156file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
965c8e59
AM
3157extern loff_t noop_llseek(struct file *file, loff_t offset, int whence);
3158extern loff_t no_llseek(struct file *file, loff_t offset, int whence);
46a1c2c7 3159extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
965c8e59 3160extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
5760495a 3161extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
965c8e59 3162 int whence, loff_t maxsize, loff_t eof);
1bf9d14d
AV
3163extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
3164 int whence, loff_t size);
b25472f9
AV
3165extern loff_t no_seek_end_llseek_size(struct file *, loff_t, int, loff_t);
3166extern loff_t no_seek_end_llseek(struct file *, loff_t, int);
1da177e4
LT
3167extern int generic_file_open(struct inode * inode, struct file * filp);
3168extern int nonseekable_open(struct inode * inode, struct file * filp);
10dce8af 3169extern int stream_open(struct inode * inode, struct file * filp);
1da177e4 3170
9361401e 3171#ifdef CONFIG_BLOCK
8a4c1e42 3172typedef void (dio_submit_t)(struct bio *bio, struct inode *inode,
facd07b0 3173 loff_t file_offset);
1da177e4
LT
3174
3175enum {
1e431f5c
CH
3176 /* need locking between buffered and direct access */
3177 DIO_LOCKING = 0x01,
3178
3179 /* filesystem does not support filling holes */
3180 DIO_SKIP_HOLES = 0x02,
1da177e4
LT
3181};
3182
4055351c 3183void dio_end_io(struct bio *bio);
eafdc7d1 3184
17f8c842
OS
3185ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode,
3186 struct block_device *bdev, struct iov_iter *iter,
c8b8e32d 3187 get_block_t get_block,
17f8c842
OS
3188 dio_iodone_t end_io, dio_submit_t submit_io,
3189 int flags);
7bb46a67 3190
17f8c842
OS
3191static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
3192 struct inode *inode,
c8b8e32d 3193 struct iov_iter *iter,
17f8c842 3194 get_block_t get_block)
1da177e4 3195{
17f8c842 3196 return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter,
c8b8e32d 3197 get_block, NULL, NULL, DIO_LOCKING | DIO_SKIP_HOLES);
1da177e4 3198}
9361401e 3199#endif
1da177e4 3200
1d59d61f 3201void inode_dio_wait(struct inode *inode);
fe0f07d0
JA
3202
3203/*
3204 * inode_dio_begin - signal start of a direct I/O requests
3205 * @inode: inode the direct I/O happens on
3206 *
3207 * This is called once we've finished processing a direct I/O request,
3208 * and is used to wake up callers waiting for direct I/O to be quiesced.
3209 */
3210static inline void inode_dio_begin(struct inode *inode)
3211{
3212 atomic_inc(&inode->i_dio_count);
3213}
3214
3215/*
3216 * inode_dio_end - signal finish of a direct I/O requests
3217 * @inode: inode the direct I/O happens on
3218 *
3219 * This is called once we've finished processing a direct I/O request,
3220 * and is used to wake up callers waiting for direct I/O to be quiesced.
3221 */
3222static inline void inode_dio_end(struct inode *inode)
3223{
3224 if (atomic_dec_and_test(&inode->i_dio_count))
3225 wake_up_bit(&inode->i_state, __I_DIO_WAKEUP);
3226}
1d59d61f 3227
a92853b6
KK
3228/*
3229 * Warn about a page cache invalidation failure diring a direct I/O write.
3230 */
3231void dio_warn_stale_pagecache(struct file *filp);
3232
5f16f322
TT
3233extern void inode_set_flags(struct inode *inode, unsigned int flags,
3234 unsigned int mask);
3235
4b6f5d20 3236extern const struct file_operations generic_ro_fops;
1da177e4
LT
3237
3238#define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))
3239
5d826c84 3240extern int readlink_copy(char __user *, int, const char *);
1da177e4 3241extern int page_readlink(struct dentry *, char __user *, int);
fceef393
AV
3242extern const char *page_get_link(struct dentry *, struct inode *,
3243 struct delayed_call *);
3244extern void page_put_link(void *);
0adb25d2 3245extern int __page_symlink(struct inode *inode, const char *symname, int len,
54566b2c 3246 int nofs);
1da177e4 3247extern int page_symlink(struct inode *inode, const char *symname, int len);
c5ef1c42 3248extern const struct inode_operations page_symlink_inode_operations;
fceef393 3249extern void kfree_link(void *);
1da177e4 3250extern void generic_fillattr(struct inode *, struct kstat *);
a528d35e
DH
3251extern int vfs_getattr_nosec(const struct path *, struct kstat *, u32, unsigned int);
3252extern int vfs_getattr(const struct path *, struct kstat *, u32, unsigned int);
b462707e 3253void __inode_add_bytes(struct inode *inode, loff_t bytes);
1da177e4 3254void inode_add_bytes(struct inode *inode, loff_t bytes);
1c8924eb 3255void __inode_sub_bytes(struct inode *inode, loff_t bytes);
1da177e4 3256void inode_sub_bytes(struct inode *inode, loff_t bytes);
f4a8116a
JK
3257static inline loff_t __inode_get_bytes(struct inode *inode)
3258{
3259 return (((loff_t)inode->i_blocks) << 9) + inode->i_bytes;
3260}
1da177e4
LT
3261loff_t inode_get_bytes(struct inode *inode);
3262void inode_set_bytes(struct inode *inode, loff_t bytes);
fceef393
AV
3263const char *simple_get_link(struct dentry *, struct inode *,
3264 struct delayed_call *);
61ba64fc 3265extern const struct inode_operations simple_symlink_inode_operations;
1da177e4 3266
5c0ba4e0 3267extern int iterate_dir(struct file *, struct dir_context *);
1da177e4 3268
a528d35e
DH
3269extern int vfs_statx(int, const char __user *, int, struct kstat *, u32);
3270extern int vfs_statx_fd(unsigned int, struct kstat *, u32, unsigned int);
3271
3272static inline int vfs_stat(const char __user *filename, struct kstat *stat)
3273{
deccf497
DH
3274 return vfs_statx(AT_FDCWD, filename, AT_NO_AUTOMOUNT,
3275 stat, STATX_BASIC_STATS);
a528d35e
DH
3276}
3277static inline int vfs_lstat(const char __user *name, struct kstat *stat)
3278{
deccf497 3279 return vfs_statx(AT_FDCWD, name, AT_SYMLINK_NOFOLLOW | AT_NO_AUTOMOUNT,
a528d35e
DH
3280 stat, STATX_BASIC_STATS);
3281}
3282static inline int vfs_fstatat(int dfd, const char __user *filename,
3283 struct kstat *stat, int flags)
3284{
5d38f049
IK
3285 return vfs_statx(dfd, filename, flags | AT_NO_AUTOMOUNT,
3286 stat, STATX_BASIC_STATS);
a528d35e
DH
3287}
3288static inline int vfs_fstat(int fd, struct kstat *stat)
3289{
3290 return vfs_statx_fd(fd, stat, STATX_BASIC_STATS, 0);
3291}
3292
3293
d60874cd 3294extern const char *vfs_get_link(struct dentry *, struct delayed_call *);
fd4a0edf 3295extern int vfs_readlink(struct dentry *, char __user *, int);
1da177e4 3296
e9079cce 3297extern int __generic_block_fiemap(struct inode *inode,
3a3076f4
JB
3298 struct fiemap_extent_info *fieinfo,
3299 loff_t start, loff_t len,
3300 get_block_t *get_block);
68c9d702
JB
3301extern int generic_block_fiemap(struct inode *inode,
3302 struct fiemap_extent_info *fieinfo, u64 start,
3303 u64 len, get_block_t *get_block);
1da177e4 3304
ee416bcd 3305extern struct file_system_type *get_filesystem(struct file_system_type *fs);
c18479fe 3306extern void put_filesystem(struct file_system_type *fs);
1da177e4
LT
3307extern struct file_system_type *get_fs_type(const char *name);
3308extern struct super_block *get_super(struct block_device *);
6b6dc836 3309extern struct super_block *get_super_thawed(struct block_device *);
ba6379f7 3310extern struct super_block *get_super_exclusive_thawed(struct block_device *bdev);
4504230a 3311extern struct super_block *get_active_super(struct block_device *bdev);
1da177e4 3312extern void drop_super(struct super_block *sb);
ba6379f7 3313extern void drop_super_exclusive(struct super_block *sb);
01a05b33 3314extern void iterate_supers(void (*)(struct super_block *, void *), void *);
43e15cdb
AV
3315extern void iterate_supers_type(struct file_system_type *,
3316 void (*)(struct super_block *, void *), void *);
1da177e4
LT
3317
3318extern int dcache_dir_open(struct inode *, struct file *);
3319extern int dcache_dir_close(struct inode *, struct file *);
3320extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
5f99f4e7 3321extern int dcache_readdir(struct file *, struct dir_context *);
7bb46a67 3322extern int simple_setattr(struct dentry *, struct iattr *);
a528d35e 3323extern int simple_getattr(const struct path *, struct kstat *, u32, unsigned int);
726c3342 3324extern int simple_statfs(struct dentry *, struct kstatfs *);
20955e89 3325extern int simple_open(struct inode *inode, struct file *file);
1da177e4
LT
3326extern int simple_link(struct dentry *, struct inode *, struct dentry *);
3327extern int simple_unlink(struct inode *, struct dentry *);
3328extern int simple_rmdir(struct inode *, struct dentry *);
e0e0be8a
MS
3329extern int simple_rename(struct inode *, struct dentry *,
3330 struct inode *, struct dentry *, unsigned int);
a3d1e7eb
AV
3331extern void simple_recursive_removal(struct dentry *,
3332 void (*callback)(struct dentry *));
02c24a82 3333extern int noop_fsync(struct file *, loff_t, loff_t, int);
f44c7763
DW
3334extern int noop_set_page_dirty(struct page *page);
3335extern void noop_invalidatepage(struct page *page, unsigned int offset,
3336 unsigned int length);
3337extern ssize_t noop_direct_IO(struct kiocb *iocb, struct iov_iter *iter);
1da177e4
LT
3338extern int simple_empty(struct dentry *);
3339extern int simple_readpage(struct file *file, struct page *page);
afddba49
NP
3340extern int simple_write_begin(struct file *file, struct address_space *mapping,
3341 loff_t pos, unsigned len, unsigned flags,
3342 struct page **pagep, void **fsdata);
3343extern int simple_write_end(struct file *file, struct address_space *mapping,
3344 loff_t pos, unsigned len, unsigned copied,
3345 struct page *page, void *fsdata);
b26d4cd3 3346extern int always_delete_dentry(const struct dentry *);
6987843f 3347extern struct inode *alloc_anon_inode(struct super_block *);
e6f5c789 3348extern int simple_nosetlease(struct file *, long, struct file_lock **, void **);
b26d4cd3 3349extern const struct dentry_operations simple_dentry_operations;
1da177e4 3350
00cd8dd3 3351extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
1da177e4 3352extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
4b6f5d20 3353extern const struct file_operations simple_dir_operations;
c5ef1c42 3354extern const struct inode_operations simple_dir_inode_operations;
fbabfd0f
EB
3355extern void make_empty_dir_inode(struct inode *inode);
3356extern bool is_empty_dir_inode(struct inode *inode);
cda37124 3357struct tree_descr { const char *name; const struct file_operations *ops; int mode; };
1da177e4 3358struct dentry *d_alloc_name(struct dentry *, const char *);
cda37124
EB
3359extern int simple_fill_super(struct super_block *, unsigned long,
3360 const struct tree_descr *);
1f5ce9e9 3361extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
1da177e4
LT
3362extern void simple_release_fs(struct vfsmount **mount, int *count);
3363
93b07113
AM
3364extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
3365 loff_t *ppos, const void *from, size_t available);
6a727b43
JS
3366extern ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
3367 const void __user *from, size_t count);
1da177e4 3368
ac13a829 3369extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
02c24a82 3370extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
d5aacad5 3371
30ca22c7
PL
3372extern int generic_check_addressable(unsigned, u64);
3373
e965f963 3374#ifdef CONFIG_MIGRATION
2d1db3b1 3375extern int buffer_migrate_page(struct address_space *,
a6bc32b8
MG
3376 struct page *, struct page *,
3377 enum migrate_mode);
89cb0888
JK
3378extern int buffer_migrate_page_norefs(struct address_space *,
3379 struct page *, struct page *,
3380 enum migrate_mode);
e965f963
CL
3381#else
3382#define buffer_migrate_page NULL
89cb0888 3383#define buffer_migrate_page_norefs NULL
e965f963
CL
3384#endif
3385
31051c85 3386extern int setattr_prepare(struct dentry *, struct iattr *);
25d9e2d1 3387extern int inode_newsize_ok(const struct inode *, loff_t offset);
6a1a90ad 3388extern void setattr_copy(struct inode *inode, const struct iattr *attr);
1da177e4 3389
c3b2da31 3390extern int file_update_time(struct file *file);
1da177e4 3391
d475c634
MW
3392static inline bool io_is_direct(struct file *filp)
3393{
65f87ee7 3394 return (filp->f_flags & O_DIRECT) || IS_DAX(filp->f_mapping->host);
d475c634
MW
3395}
3396
baabda26
DW
3397static inline bool vma_is_dax(struct vm_area_struct *vma)
3398{
3399 return vma->vm_file && IS_DAX(vma->vm_file->f_mapping->host);
3400}
3401
2bb6d283
DW
3402static inline bool vma_is_fsdax(struct vm_area_struct *vma)
3403{
3404 struct inode *inode;
3405
3406 if (!vma->vm_file)
3407 return false;
3408 if (!vma_is_dax(vma))
3409 return false;
3410 inode = file_inode(vma->vm_file);
230f5a89 3411 if (S_ISCHR(inode->i_mode))
2bb6d283
DW
3412 return false; /* device-dax */
3413 return true;
3414}
3415
2ba48ce5
AV
3416static inline int iocb_flags(struct file *file)
3417{
3418 int res = 0;
3419 if (file->f_flags & O_APPEND)
3420 res |= IOCB_APPEND;
3421 if (io_is_direct(file))
3422 res |= IOCB_DIRECT;
dde0c2e7
CH
3423 if ((file->f_flags & O_DSYNC) || IS_SYNC(file->f_mapping->host))
3424 res |= IOCB_DSYNC;
3425 if (file->f_flags & __O_SYNC)
3426 res |= IOCB_SYNC;
2ba48ce5
AV
3427 return res;
3428}
3429
ddef7ed2 3430static inline int kiocb_set_rw_flags(struct kiocb *ki, rwf_t flags)
fdd2f5b7
GR
3431{
3432 if (unlikely(flags & ~RWF_SUPPORTED))
3433 return -EOPNOTSUPP;
3434
b745fafa 3435 if (flags & RWF_NOWAIT) {
91f9943e 3436 if (!(ki->ki_filp->f_mode & FMODE_NOWAIT))
b745fafa
GR
3437 return -EOPNOTSUPP;
3438 ki->ki_flags |= IOCB_NOWAIT;
3439 }
fdd2f5b7
GR
3440 if (flags & RWF_HIPRI)
3441 ki->ki_flags |= IOCB_HIPRI;
3442 if (flags & RWF_DSYNC)
3443 ki->ki_flags |= IOCB_DSYNC;
3444 if (flags & RWF_SYNC)
3445 ki->ki_flags |= (IOCB_DSYNC | IOCB_SYNC);
e1fc742e
JB
3446 if (flags & RWF_APPEND)
3447 ki->ki_flags |= IOCB_APPEND;
fdd2f5b7
GR
3448 return 0;
3449}
3450
1da177e4
LT
3451static inline ino_t parent_ino(struct dentry *dentry)
3452{
3453 ino_t res;
3454
b5c84bf6
NP
3455 /*
3456 * Don't strictly need d_lock here? If the parent ino could change
3457 * then surely we'd have a deeper race in the caller?
3458 */
1da177e4
LT
3459 spin_lock(&dentry->d_lock);
3460 res = dentry->d_parent->d_inode->i_ino;
3461 spin_unlock(&dentry->d_lock);
3462 return res;
3463}
3464
1da177e4
LT
3465/* Transaction based IO helpers */
3466
3467/*
3468 * An argresp is stored in an allocated page and holds the
3469 * size of the argument or response, along with its content
3470 */
3471struct simple_transaction_argresp {
3472 ssize_t size;
3473 char data[0];
3474};
3475
3476#define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))
3477
3478char *simple_transaction_get(struct file *file, const char __user *buf,
3479 size_t size);
3480ssize_t simple_transaction_read(struct file *file, char __user *buf,
3481 size_t size, loff_t *pos);
3482int simple_transaction_release(struct inode *inode, struct file *file);
3483
76791ab2 3484void simple_transaction_set(struct file *file, size_t n);
1da177e4 3485
acaefc25
AB
3486/*
3487 * simple attribute files
3488 *
3489 * These attributes behave similar to those in sysfs:
3490 *
3491 * Writing to an attribute immediately sets a value, an open file can be
3492 * written to multiple times.
3493 *
3494 * Reading from an attribute creates a buffer from the value that might get
3495 * read with multiple read calls. When the attribute has been read
3496 * completely, no further read calls are possible until the file is opened
3497 * again.
3498 *
3499 * All attributes contain a text representation of a numeric value
3500 * that are accessed with the get() and set() functions.
3501 */
3502#define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt) \
3503static int __fops ## _open(struct inode *inode, struct file *file) \
3504{ \
3505 __simple_attr_check_format(__fmt, 0ull); \
3506 return simple_attr_open(inode, file, __get, __set, __fmt); \
3507} \
828c0950 3508static const struct file_operations __fops = { \
acaefc25
AB
3509 .owner = THIS_MODULE, \
3510 .open = __fops ## _open, \
74bedc4d 3511 .release = simple_attr_release, \
acaefc25
AB
3512 .read = simple_attr_read, \
3513 .write = simple_attr_write, \
1ec5584e 3514 .llseek = generic_file_llseek, \
68be3029 3515}
acaefc25 3516
b9075fa9
JP
3517static inline __printf(1, 2)
3518void __simple_attr_check_format(const char *fmt, ...)
acaefc25
AB
3519{
3520 /* don't do anything, just let the compiler check the arguments; */
3521}
3522
3523int simple_attr_open(struct inode *inode, struct file *file,
8b88b099 3524 int (*get)(void *, u64 *), int (*set)(void *, u64),
acaefc25 3525 const char *fmt);
74bedc4d 3526int simple_attr_release(struct inode *inode, struct file *file);
acaefc25
AB
3527ssize_t simple_attr_read(struct file *file, char __user *buf,
3528 size_t len, loff_t *ppos);
3529ssize_t simple_attr_write(struct file *file, const char __user *buf,
3530 size_t len, loff_t *ppos);
3531
4be28540 3532struct ctl_table;
8d65af78 3533int proc_nr_files(struct ctl_table *table, int write,
62239ac2 3534 void __user *buffer, size_t *lenp, loff_t *ppos);
312d3ca8
CH
3535int proc_nr_dentry(struct ctl_table *table, int write,
3536 void __user *buffer, size_t *lenp, loff_t *ppos);
cffbc8aa
DC
3537int proc_nr_inodes(struct ctl_table *table, int write,
3538 void __user *buffer, size_t *lenp, loff_t *ppos);
38e23c95 3539int __init get_filesystem_list(char *buf);
62239ac2 3540
3cd90ea4 3541#define __FMODE_EXEC ((__force int) FMODE_EXEC)
1a44bc8c
NK
3542#define __FMODE_NONOTIFY ((__force int) FMODE_NONOTIFY)
3543
6d125529 3544#define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE])
ecf081d1 3545#define OPEN_FMODE(flag) ((__force fmode_t)(((flag + 1) & O_ACCMODE) | \
1a44bc8c 3546 (flag & __FMODE_NONOTIFY)))
5300990c 3547
d37177ba 3548static inline bool is_sxid(umode_t mode)
69b45732
AK
3549{
3550 return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
3551}
3552
cbdf35bc
MS
3553static inline int check_sticky(struct inode *dir, struct inode *inode)
3554{
3555 if (!(dir->i_mode & S_ISVTX))
3556 return 0;
3557
3558 return __check_sticky(dir, inode);
3559}
3560
69b45732
AK
3561static inline void inode_has_no_xattr(struct inode *inode)
3562{
e462ec50 3563 if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & SB_NOSEC))
69b45732
AK
3564 inode->i_flags |= S_NOSEC;
3565}
3566
a7400222
AV
3567static inline bool is_root_inode(struct inode *inode)
3568{
3569 return inode == inode->i_sb->s_root->d_inode;
3570}
3571
5f99f4e7
AV
3572static inline bool dir_emit(struct dir_context *ctx,
3573 const char *name, int namelen,
3574 u64 ino, unsigned type)
3575{
3576 return ctx->actor(ctx, name, namelen, ctx->pos, ino, type) == 0;
3577}
3578static inline bool dir_emit_dot(struct file *file, struct dir_context *ctx)
3579{
3580 return ctx->actor(ctx, ".", 1, ctx->pos,
3581 file->f_path.dentry->d_inode->i_ino, DT_DIR) == 0;
3582}
3583static inline bool dir_emit_dotdot(struct file *file, struct dir_context *ctx)
3584{
3585 return ctx->actor(ctx, "..", 2, ctx->pos,
3586 parent_ino(file->f_path.dentry), DT_DIR) == 0;
3587}
3588static inline bool dir_emit_dots(struct file *file, struct dir_context *ctx)
3589{
3590 if (ctx->pos == 0) {
3591 if (!dir_emit_dot(file, ctx))
3592 return false;
3593 ctx->pos = 1;
3594 }
3595 if (ctx->pos == 1) {
3596 if (!dir_emit_dotdot(file, ctx))
3597 return false;
3598 ctx->pos = 2;
3599 }
3600 return true;
3601}
5ded75ec
AV
3602static inline bool dir_relax(struct inode *inode)
3603{
5955102c
AV
3604 inode_unlock(inode);
3605 inode_lock(inode);
5ded75ec
AV
3606 return !IS_DEADDIR(inode);
3607}
5f99f4e7 3608
ae05327a
AV
3609static inline bool dir_relax_shared(struct inode *inode)
3610{
3611 inode_unlock_shared(inode);
3612 inode_lock_shared(inode);
3613 return !IS_DEADDIR(inode);
3614}
3615
90f8572b 3616extern bool path_noexec(const struct path *path);
21fc61c7 3617extern void inode_nohighmem(struct inode *inode);
90f8572b 3618
45cd0faa
AG
3619/* mm/fadvise.c */
3620extern int vfs_fadvise(struct file *file, loff_t offset, loff_t len,
3621 int advice);
cf1ea059
JK
3622extern int generic_fadvise(struct file *file, loff_t offset, loff_t len,
3623 int advice);
45cd0faa 3624
2b188cc1
JA
3625#if defined(CONFIG_IO_URING)
3626extern struct sock *io_uring_get_socket(struct file *file);
3627#else
3628static inline struct sock *io_uring_get_socket(struct file *file)
3629{
3630 return NULL;
3631}
3632#endif
3633
5aca2842
DW
3634int vfs_ioc_setflags_prepare(struct inode *inode, unsigned int oldflags,
3635 unsigned int flags);
3636
7b0e492e
DW
3637int vfs_ioc_fssetxattr_check(struct inode *inode, const struct fsxattr *old_fa,
3638 struct fsxattr *fa);
3639
3640static inline void simple_fill_fsxattr(struct fsxattr *fa, __u32 xflags)
3641{
3642 memset(fa, 0, sizeof(*fa));
3643 fa->fsx_xflags = xflags;
3644}
3645
dc617f29
DW
3646/*
3647 * Flush file data before changing attributes. Caller must hold any locks
3648 * required to prevent further writes to this file until we're done setting
3649 * flags.
3650 */
3651static inline int inode_drain_writes(struct inode *inode)
3652{
3653 inode_dio_wait(inode);
3654 return filemap_write_and_wait(inode->i_mapping);
3655}
3656
1da177e4 3657#endif /* _LINUX_FS_H */