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