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