include/linux/file.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Wrapper functions for accessing the file_struct fd array.
   4  */
   5
   6 #ifndef __LINUX_FILE_H
   7 #define __LINUX_FILE_H
   8
   9 #include <linux/compiler.h>
  10 #include <linux/types.h>
  11 #include <linux/posix_types.h>
  12
  13 struct file;
  14
  15 extern void fput(struct file *);
  16
  17 struct file_operations;
  18 struct vfsmount;
  19 struct dentry;
  20 struct inode;
  21 struct path;
  22 extern struct file *alloc_file_pseudo(struct inode *, struct vfsmount *,
  23         const char *, int flags, const struct file_operations *);
  24 extern struct file *alloc_file_clone(struct file *, int flags,
  25         const struct file_operations *);
  26
  27 static inline void fput_light(struct file *file, int fput_needed)
  28 {
  29         if (fput_needed)
  30                 fput(file);
  31 }
  32
  33 struct fd {
  34         struct file *file;
  35         unsigned int flags;
  36 };
  37 #define FDPUT_FPUT       1
  38 #define FDPUT_POS_UNLOCK 2
  39
  40 static inline void fdput(struct fd fd)
  41 {
  42         if (fd.flags & FDPUT_FPUT)
  43                 fput(fd.file);
  44 }
  45
  46 extern struct file *fget(unsigned int fd);
  47 extern struct file *fget_raw(unsigned int fd);
  48 extern unsigned long __fdget(unsigned int fd);
  49 extern unsigned long __fdget_raw(unsigned int fd);
  50 extern unsigned long __fdget_pos(unsigned int fd);
  51 extern void __f_unlock_pos(struct file *);
  52
  53 static inline struct fd __to_fd(unsigned long v)
  54 {
  55         return (struct fd){(struct file *)(v & ~3),v & 3};
  56 }
  57
  58 static inline struct fd fdget(unsigned int fd)
  59 {
  60         return __to_fd(__fdget(fd));
  61 }
  62
  63 static inline struct fd fdget_raw(unsigned int fd)
  64 {
  65         return __to_fd(__fdget_raw(fd));
  66 }
  67
  68 static inline struct fd fdget_pos(int fd)
  69 {
  70         return __to_fd(__fdget_pos(fd));
  71 }
  72
  73 static inline void fdput_pos(struct fd f)
  74 {
  75         if (f.flags & FDPUT_POS_UNLOCK)
  76                 __f_unlock_pos(f.file);
  77         fdput(f);
  78 }
  79
  80 extern int f_dupfd(unsigned int from, struct file *file, unsigned flags);
  81 extern int replace_fd(unsigned fd, struct file *file, unsigned flags);
  82 extern void set_close_on_exec(unsigned int fd, int flag);
  83 extern bool get_close_on_exec(unsigned int fd);
  84 extern int get_unused_fd_flags(unsigned flags);
  85 extern void put_unused_fd(unsigned int fd);
  86
  87 extern void fd_install(unsigned int fd, struct file *file);
  88
  89 extern void flush_delayed_fput(void);
  90 extern void __fput_sync(struct file *);
  91
  92 #endif /* __LINUX_FILE_H */