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