LXR linux/include/linux/file.h

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