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