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