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