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