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