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