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 extern void fput_many(struct file *, unsigned int);
  17
  18 struct file_operations;
  19 struct vfsmount;
  20 struct dentry;
  21 struct path;
  22 extern struct file *alloc_file(const struct path *, fmode_t mode,
  23         const struct file_operations *fop);
  24
  25 static inline void fput_light(struct file *file, int fput_needed)
  26 {
  27         if (fput_needed)
  28                 fput(file);
  29 }
  30
  31 struct fd {
  32         struct file *file;
  33         unsigned int flags;
  34 };
  35 #define FDPUT_FPUT       1
  36 #define FDPUT_POS_UNLOCK 2
  37
  38 static inline void fdput(struct fd fd)
  39 {
  40         if (fd.flags & FDPUT_FPUT)
  41                 fput(fd.file);
  42 }
  43
  44 extern struct file *fget(unsigned int fd);
  45 extern struct file *fget_many(unsigned int fd, unsigned int refs);
  46 extern struct file *fget_raw(unsigned int fd);
  47 extern unsigned long __fdget(unsigned int fd);
  48 extern unsigned long __fdget_raw(unsigned int fd);
  49 extern unsigned long __fdget_pos(unsigned int fd);
  50 extern void __f_unlock_pos(struct file *);
  51
  52 static inline struct fd __to_fd(unsigned long v)
  53 {
  54         return (struct fd){(struct file *)(v & ~3),v & 3};
  55 }
  56
  57 static inline struct fd fdget(unsigned int fd)
  58 {
  59         return __to_fd(__fdget(fd));
  60 }
  61
  62 static inline struct fd fdget_raw(unsigned int fd)
  63 {
  64         return __to_fd(__fdget_raw(fd));
  65 }
  66
  67 static inline struct fd fdget_pos(int fd)
  68 {
  69         return __to_fd(__fdget_pos(fd));
  70 }
  71
  72 static inline void fdput_pos(struct fd f)
  73 {
  74         if (f.flags & FDPUT_POS_UNLOCK)
  75                 __f_unlock_pos(f.file);
  76         fdput(f);
  77 }
  78
  79 extern int f_dupfd(unsigned int from, struct file *file, unsigned flags);
  80 extern int replace_fd(unsigned fd, struct file *file, unsigned flags);
  81 extern void set_close_on_exec(unsigned int fd, int flag);
  82 extern bool get_close_on_exec(unsigned int fd);
  83 extern void put_filp(struct file *);
  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 */