sys/sys/file.h

   1 /*
   2  * Copyright (c) 1982, 1986, 1989, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  *      @(#)file.h      8.3 (Berkeley) 1/9/95
  34  * $FreeBSD$
  35  */
  36
  37 #ifndef _SYS_FILE_H_
  38 #define _SYS_FILE_H_
  39
  40 #ifndef _KERNEL
  41 #include <sys/fcntl.h>
  42 #include <sys/unistd.h>
  43 #endif
  44
  45 #ifdef _KERNEL
  46 #include <sys/types.h>
  47 #include <sys/queue.h>
  48 #include <sys/_lock.h>
  49 #include <sys/_mutex.h>
  50 #include <sys/sx.h>
  51
  52 struct stat;
  53 struct thread;
  54 struct uio;
  55 struct knote;
  56 struct vnode;
  57 struct socket;
  58
  59 /*
  60  * Kernel descriptor table.
  61  * One entry for each open kernel vnode and socket.
  62  *
  63  * Below is the list of locks that protects members in struct file.
  64  *
  65  * (fl) filelist_lock
  66  * (f)  f_mtx in struct file
  67  * none not locked
  68  */
  69 struct file {
  70         LIST_ENTRY(file) f_list;/* (fl) list of active files */
  71         short   f_gcflag;       /* used by thread doing fd garbage collection */
  72 #define DTYPE_VNODE     1       /* file */
  73 #define DTYPE_SOCKET    2       /* communications endpoint */
  74 #define DTYPE_PIPE      3       /* pipe */
  75 #define DTYPE_FIFO      4       /* fifo (named pipe) */
  76 #define DTYPE_KQUEUE    5       /* event queue */
  77         short   f_type;         /* descriptor type */
  78         int     f_count;        /* (f) reference count */
  79         int     f_msgcount;     /* (f) references from message queue */
  80         struct  ucred *f_cred;  /* credentials associated with descriptor */
  81         struct fileops {
  82                 int     (*fo_read)      __P((struct file *fp, struct uio *uio,
  83                                             struct ucred *cred, int flags,
  84                                             struct thread *td));
  85                 int     (*fo_write)     __P((struct file *fp, struct uio *uio,
  86                                             struct ucred *cred, int flags,
  87                                             struct thread *td));
  88 #define FOF_OFFSET      1
  89                 int     (*fo_ioctl)     __P((struct file *fp, u_long com,
  90                                             caddr_t data, struct thread *td));
  91                 int     (*fo_poll)      __P((struct file *fp, int events,
  92                                             struct ucred *cred, struct thread *td));
  93                 int     (*fo_kqfilter)  __P((struct file *fp,
  94                                             struct knote *kn));
  95                 int     (*fo_stat)      __P((struct file *fp, struct stat *sb,
  96                                             struct thread *td));
  97                 int     (*fo_close)     __P((struct file *fp, struct thread *td));
  98         } *f_ops;
  99         int     f_seqcount;     /*
 100                                  * count of sequential accesses -- cleared
 101                                  * by most seek operations.
 102                                  */
 103         off_t   f_nextoff;      /*
 104                                  * offset of next expected read or write
 105                                  */
 106         off_t   f_offset;
 107         caddr_t f_data;         /* vnode or socket */
 108         u_int   f_flag;         /* see fcntl.h */
 109         struct mtx      *f_mtxp;        /* mutex to protect data */
 110 };
 111
 112 #ifdef MALLOC_DECLARE
 113 MALLOC_DECLARE(M_FILE);
 114 #endif
 115
 116 LIST_HEAD(filelist, file);
 117 extern struct filelist filehead; /* (fl) head of list of open files */
 118 extern struct fileops vnops;
 119 extern struct fileops badfileops;
 120 extern int maxfiles;            /* kernel limit on number of open files */
 121 extern int maxfilesperproc;     /* per process limit on number of open files */
 122 extern int nfiles;              /* (fl) actual number of open files */
 123 extern struct sx filelist_lock; /* sx to protect filelist and nfiles */
 124
 125 int fget __P((struct thread *td, int fd, struct file **fpp));
 126 int fget_read __P((struct thread *td, int fd, struct file **fpp));
 127 int fget_write __P((struct thread *td, int fd, struct file **fpp));
 128 int fdrop __P((struct file *fp, struct thread *td));
 129 int fdrop_locked __P((struct file *fp, struct thread *td));
 130
 131 /* Lock a file. */
 132 #define FILE_LOCK(f)    mtx_lock((f)->f_mtxp)
 133 #define FILE_UNLOCK(f)  mtx_unlock((f)->f_mtxp)
 134 #define FILE_LOCKED(f)  mtx_owned((f)->f_mtxp)
 135 #define FILE_LOCK_ASSERT(f, type) mtx_assert((f)->f_mtxp, (type))
 136
 137 int fgetvp __P((struct thread *td, int fd, struct vnode **vpp));
 138 int fgetvp_read __P((struct thread *td, int fd, struct vnode **vpp));
 139 int fgetvp_write __P((struct thread *td, int fd, struct vnode **vpp));
 140
 141 int fgetsock __P((struct thread *td, int fd, struct socket **spp, u_int *fflagp));
 142 void fputsock __P((struct socket *sp));
 143
 144 #define fhold_locked(fp)                                                \
 145         do {                                                            \
 146                 FILE_LOCK_ASSERT(fp, MA_OWNED);                         \
 147                 (fp)->f_count++;                                        \
 148         } while (0)
 149
 150 #define fhold(fp)                                                       \
 151         do {                                                            \
 152                 FILE_LOCK(fp);                                          \
 153                 fhold_locked(fp);                                       \
 154                 FILE_UNLOCK(fp);                                        \
 155         } while (0)
 156
 157 static __inline int fo_read __P((struct file *fp, struct uio *uio,
 158     struct ucred *cred, int flags, struct thread *td));
 159 static __inline int fo_write __P((struct file *fp, struct uio *uio,
 160     struct ucred *cred, int flags, struct thread *td));
 161 static __inline int fo_ioctl __P((struct file *fp, u_long com, caddr_t data,
 162     struct thread *td));
 163 static __inline int fo_poll __P((struct file *fp, int events,
 164     struct ucred *cred, struct thread *td));
 165 static __inline int fo_stat __P((struct file *fp, struct stat *sb,
 166     struct thread *td));
 167 static __inline int fo_close __P((struct file *fp, struct thread *td));
 168 static __inline int fo_kqfilter __P((struct file *fp, struct knote *kn));
 169 struct proc;
 170
 171 static __inline int
 172 fo_read(fp, uio, cred, flags, td)
 173         struct file *fp;
 174         struct uio *uio;
 175         struct ucred *cred;
 176         struct thread *td;
 177         int flags;
 178 {
 179
 180         return ((*fp->f_ops->fo_read)(fp, uio, cred, flags, td));
 181 }
 182
 183 static __inline int
 184 fo_write(fp, uio, cred, flags, td)
 185         struct file *fp;
 186         struct uio *uio;
 187         struct ucred *cred;
 188         struct thread *td;
 189         int flags;
 190 {
 191         return ((*fp->f_ops->fo_write)(fp, uio, cred, flags, td));
 192 }
 193
 194 static __inline int
 195 fo_ioctl(fp, com, data, td)
 196         struct file *fp;
 197         u_long com;
 198         caddr_t data;
 199         struct thread *td;
 200 {
 201         return ((*fp->f_ops->fo_ioctl)(fp, com, data, td));
 202 }
 203
 204 static __inline int
 205 fo_poll(fp, events, cred, td)
 206         struct file *fp;
 207         int events;
 208         struct ucred *cred;
 209         struct thread *td;
 210 {
 211         /* select(2) and poll(2) hold file descriptors. */
 212         return ((*fp->f_ops->fo_poll)(fp, events, cred, td));
 213 }
 214
 215 static __inline int
 216 fo_stat(fp, sb, td)
 217         struct file *fp;
 218         struct stat *sb;
 219         struct thread *td;
 220 {
 221         return ((*fp->f_ops->fo_stat)(fp, sb, td));
 222 }
 223
 224 static __inline int
 225 fo_close(fp, td)
 226         struct file *fp;
 227         struct thread *td;
 228 {
 229
 230         return ((*fp->f_ops->fo_close)(fp, td));
 231 }
 232
 233 static __inline int
 234 fo_kqfilter(fp, kn)
 235         struct file *fp;
 236         struct knote *kn;
 237 {
 238
 239         return ((*fp->f_ops->fo_kqfilter)(fp, kn));
 240 }
 241
 242 #endif /* _KERNEL */
 243
 244 #endif /* !SYS_FILE_H */