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/queue.h>
  47 #include <sys/_lock.h>
  48 #include <sys/_mutex.h>
  49
  50 struct stat;
  51 struct thread;
  52 struct uio;
  53 struct knote;
  54 struct vnode;
  55 struct socket;
  56
  57 /*
  58  * Kernel descriptor table.
  59  * One entry for each open kernel vnode and socket.
  60  *
  61  * Below is the list of locks that protects members in struct file.
  62  *
  63  * (fl) filelist_lock
  64  * (f)  f_mtx in struct file
  65  * none not locked
  66  */
  67 struct file {
  68         LIST_ENTRY(file) f_list;/* (fl) list of active files */
  69         short   f_gcflag;       /* used by thread doing fd garbage collection */
  70 #define DTYPE_VNODE     1       /* file */
  71 #define DTYPE_SOCKET    2       /* communications endpoint */
  72 #define DTYPE_PIPE      3       /* pipe */
  73 #define DTYPE_FIFO      4       /* fifo (named pipe) */
  74 #define DTYPE_KQUEUE    5       /* event queue */
  75         short   f_type;         /* descriptor type */
  76         int     f_count;        /* (f) reference count */
  77         int     f_msgcount;     /* (f) references from message queue */
  78         struct  ucred *f_cred;  /* credentials associated with descriptor */
  79         struct fileops {
  80                 int     (*fo_read)(struct file *fp, struct uio *uio,
  81                             struct ucred *cred, int flags, struct thread *td);
  82                 int     (*fo_write)(struct file *fp, struct uio *uio,
  83                             struct ucred *cred, int flags, struct thread *td);
  84 #define FOF_OFFSET      1
  85                 int     (*fo_ioctl)(struct file *fp, u_long com, caddr_t data,
  86                             struct thread *td);
  87                 int     (*fo_poll)(struct file *fp, int events,
  88                             struct ucred *cred, struct thread *td);
  89                 int     (*fo_kqfilter)(struct file *fp, struct knote *kn);
  90                 int     (*fo_stat)(struct file *fp, struct stat *sb,
  91                             struct thread *td);
  92                 int     (*fo_close)(struct file *fp, struct thread *td);
  93         } *f_ops;
  94         int     f_seqcount;     /*
  95                                  * count of sequential accesses -- cleared
  96                                  * by most seek operations.
  97                                  */
  98         off_t   f_nextoff;      /*
  99                                  * offset of next expected read or write
 100                                  */
 101         off_t   f_offset;
 102         caddr_t f_data;         /* vnode or socket */
 103         u_int   f_flag;         /* see fcntl.h */
 104         struct mtx      *f_mtxp;        /* mutex to protect data */
 105 };
 106
 107 #ifdef MALLOC_DECLARE
 108 MALLOC_DECLARE(M_FILE);
 109 #endif
 110
 111 LIST_HEAD(filelist, file);
 112 extern struct filelist filehead; /* (fl) head of list of open files */
 113 extern struct fileops vnops;
 114 extern struct fileops badfileops;
 115 extern int maxfiles;            /* kernel limit on number of open files */
 116 extern int maxfilesperproc;     /* per process limit on number of open files */
 117 extern int nfiles;              /* (fl) actual number of open files */
 118 extern struct sx filelist_lock; /* sx to protect filelist and nfiles */
 119
 120 int fget(struct thread *td, int fd, struct file **fpp);
 121 int fget_read(struct thread *td, int fd, struct file **fpp);
 122 int fget_write(struct thread *td, int fd, struct file **fpp);
 123 int fdrop(struct file *fp, struct thread *td);
 124 int fdrop_locked(struct file *fp, struct thread *td);
 125
 126 /* Lock a file. */
 127 #define FILE_LOCK(f)    mtx_lock((f)->f_mtxp)
 128 #define FILE_UNLOCK(f)  mtx_unlock((f)->f_mtxp)
 129 #define FILE_LOCKED(f)  mtx_owned((f)->f_mtxp)
 130 #define FILE_LOCK_ASSERT(f, type) mtx_assert((f)->f_mtxp, (type))
 131
 132 int fgetvp(struct thread *td, int fd, struct vnode **vpp);
 133 int fgetvp_read(struct thread *td, int fd, struct vnode **vpp);
 134 int fgetvp_write(struct thread *td, int fd, struct vnode **vpp);
 135
 136 int fgetsock(struct thread *td, int fd, struct socket **spp, u_int *fflagp);
 137 void fputsock(struct socket *sp);
 138
 139 #define fhold_locked(fp)                                                \
 140         do {                                                            \
 141                 FILE_LOCK_ASSERT(fp, MA_OWNED);                         \
 142                 (fp)->f_count++;                                        \
 143         } while (0)
 144
 145 #define fhold(fp)                                                       \
 146         do {                                                            \
 147                 FILE_LOCK(fp);                                          \
 148                 fhold_locked(fp);                                       \
 149                 FILE_UNLOCK(fp);                                        \
 150         } while (0)
 151
 152 static __inline int fo_read(struct file *fp, struct uio *uio,
 153     struct ucred *cred, int flags, struct thread *td);
 154 static __inline int fo_write(struct file *fp, struct uio *uio,
 155     struct ucred *cred, int flags, struct thread *td);
 156 static __inline int fo_ioctl(struct file *fp, u_long com, caddr_t data,
 157     struct thread *td);
 158 static __inline int fo_poll(struct file *fp, int events,
 159     struct ucred *cred, struct thread *td);
 160 static __inline int fo_stat(struct file *fp, struct stat *sb,
 161     struct thread *td);
 162 static __inline int fo_close(struct file *fp, struct thread *td);
 163 static __inline int fo_kqfilter(struct file *fp, struct knote *kn);
 164 struct proc;
 165
 166 static __inline int
 167 fo_read(fp, uio, cred, flags, td)
 168         struct file *fp;
 169         struct uio *uio;
 170         struct ucred *cred;
 171         struct thread *td;
 172         int flags;
 173 {
 174
 175         return ((*fp->f_ops->fo_read)(fp, uio, cred, flags, td));
 176 }
 177
 178 static __inline int
 179 fo_write(fp, uio, cred, flags, td)
 180         struct file *fp;
 181         struct uio *uio;
 182         struct ucred *cred;
 183         struct thread *td;
 184         int flags;
 185 {
 186         return ((*fp->f_ops->fo_write)(fp, uio, cred, flags, td));
 187 }
 188
 189 static __inline int
 190 fo_ioctl(fp, com, data, td)
 191         struct file *fp;
 192         u_long com;
 193         caddr_t data;
 194         struct thread *td;
 195 {
 196         return ((*fp->f_ops->fo_ioctl)(fp, com, data, td));
 197 }
 198
 199 static __inline int
 200 fo_poll(fp, events, cred, td)
 201         struct file *fp;
 202         int events;
 203         struct ucred *cred;
 204         struct thread *td;
 205 {
 206         /* select(2) and poll(2) hold file descriptors. */
 207         return ((*fp->f_ops->fo_poll)(fp, events, cred, td));
 208 }
 209
 210 static __inline int
 211 fo_stat(fp, sb, td)
 212         struct file *fp;
 213         struct stat *sb;
 214         struct thread *td;
 215 {
 216         return ((*fp->f_ops->fo_stat)(fp, sb, td));
 217 }
 218
 219 static __inline int
 220 fo_close(fp, td)
 221         struct file *fp;
 222         struct thread *td;
 223 {
 224
 225         return ((*fp->f_ops->fo_close)(fp, td));
 226 }
 227
 228 static __inline int
 229 fo_kqfilter(fp, kn)
 230         struct file *fp;
 231         struct knote *kn;
 232 {
 233
 234         return ((*fp->f_ops->fo_kqfilter)(fp, kn));
 235 }
 236
 237 #endif /* _KERNEL */
 238
 239 #endif /* !SYS_FILE_H */