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