sys/ofed/include/linux/file.h

   1 /*-
   2  * Copyright (c) 2010 Isilon Systems, Inc.
   3  * Copyright (c) 2010 iX Systems, Inc.
   4  * Copyright (c) 2010 Panasas, Inc.
   5  * Copyright (c) 2013-2015 Mellanox Technologies, Ltd.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice unmodified, this list of conditions, and the following
  13  *    disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29 #ifndef _LINUX_FILE_H_
  30 #define _LINUX_FILE_H_
  31
  32 #include <sys/param.h>
  33 #include <sys/file.h>
  34 #include <sys/filedesc.h>
  35 #include <sys/refcount.h>
  36 #include <sys/proc.h>
  37
  38 #include <linux/fs.h>
  39
  40 struct linux_file;
  41
  42 #undef file
  43
  44 extern struct fileops linuxfileops;
  45
  46 static inline struct linux_file *
  47 linux_fget(unsigned int fd)
  48 {
  49         struct file *file;
  50
  51         if (fget_unlocked(curthread->td_proc->p_fd, fd, NULL, 0, &file,
  52             NULL) != 0) {
  53                 return (NULL);
  54         }
  55         return (struct linux_file *)file->f_data;
  56 }
  57
  58 static inline void
  59 fput(struct linux_file *filp)
  60 {
  61         if (filp->_file == NULL) {
  62                 kfree(filp);
  63                 return;
  64         }
  65         if (refcount_release(&filp->_file->f_count)) {
  66                 _fdrop(filp->_file, curthread);
  67                 kfree(filp);
  68         }
  69 }
  70
  71 static inline void
  72 put_unused_fd(unsigned int fd)
  73 {
  74         struct file *file;
  75
  76         if (fget_unlocked(curthread->td_proc->p_fd, fd, NULL, 0, &file,
  77             NULL) != 0) {
  78                 return;
  79         }
  80         /*
  81          * NOTE: We should only get here when the "fd" has not been
  82          * installed, so no need to free the associated Linux file
  83          * structure.
  84          */
  85         fdclose(curthread->td_proc->p_fd, file, fd, curthread);
  86
  87         /* drop extra reference */
  88         fdrop(file, curthread);
  89 }
  90
  91 static inline void
  92 fd_install(unsigned int fd, struct linux_file *filp)
  93 {
  94         struct file *file;
  95
  96         if (fget_unlocked(curthread->td_proc->p_fd, fd, NULL, 0, &file,
  97             NULL) != 0) {
  98                 filp->_file = NULL;
  99         } else {
 100                 filp->_file = file;
 101                 finit(file, filp->f_mode, DTYPE_DEV, filp, &linuxfileops);
 102         }
 103
 104         /* drop the extra reference */
 105         fput(filp);
 106 }
 107
 108 static inline int
 109 get_unused_fd(void)
 110 {
 111         struct file *file;
 112         int error;
 113         int fd;
 114
 115         error = falloc(curthread, &file, &fd, 0);
 116         if (error)
 117                 return -error;
 118         /* drop the extra reference */
 119         fdrop(file, curthread);
 120         return fd;
 121 }
 122
 123 static inline int
 124 get_unused_fd_flags(int flags)
 125 {
 126         struct file *file;
 127         int error;
 128         int fd;
 129
 130         error = falloc(curthread, &file, &fd, flags);
 131         if (error)
 132                 return -error;
 133         /* drop the extra reference */
 134         fdrop(file, curthread);
 135         return fd;
 136 }
 137
 138 static inline struct linux_file *
 139 alloc_file(int mode, const struct file_operations *fops)
 140 {
 141         struct linux_file *filp;
 142
 143         filp = kzalloc(sizeof(*filp), GFP_KERNEL);
 144         if (filp == NULL)
 145                 return (NULL);
 146         filp->f_op = fops;
 147         filp->f_mode = mode;
 148
 149         return filp;
 150 }
 151
 152 struct fd {
 153         struct linux_file *linux_file;
 154 };
 155
 156 static inline void fdput(struct fd fd)
 157 {
 158         fput(fd.linux_file);
 159 }
 160
 161 static inline struct fd fdget(unsigned int fd)
 162 {
 163         struct linux_file *f = linux_fget(fd);
 164         return (struct fd){f};
 165 }
 166
 167 #define file    linux_file
 168 #define fget    linux_fget
 169
 170 #endif  /* _LINUX_FILE_H_ */