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  * 4. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  *      @(#)file.h      8.3 (Berkeley) 1/9/95
  30  * $FreeBSD$
  31  */
  32
  33 #ifndef _SYS_FILE_H_
  34 #define _SYS_FILE_H_
  35
  36 #ifndef _KERNEL
  37 #include <sys/types.h> /* XXX */
  38 #include <sys/fcntl.h>
  39 #include <sys/unistd.h>
  40 #else
  41 #include <sys/queue.h>
  42 #include <sys/_lock.h>
  43 #include <sys/_mutex.h>
  44
  45 struct stat;
  46 struct thread;
  47 struct uio;
  48 struct knote;
  49 struct vnode;
  50 struct socket;
  51
  52
  53 #endif /* _KERNEL */
  54
  55 #define DTYPE_VNODE     1       /* file */
  56 #define DTYPE_SOCKET    2       /* communications endpoint */
  57 #define DTYPE_PIPE      3       /* pipe */
  58 #define DTYPE_FIFO      4       /* fifo (named pipe) */
  59 #define DTYPE_KQUEUE    5       /* event queue */
  60 #define DTYPE_CRYPTO    6       /* crypto */
  61 #define DTYPE_MQUEUE    7       /* posix message queue */
  62
  63 #ifdef _KERNEL
  64
  65 struct file;
  66 struct ucred;
  67
  68 typedef int fo_rdwr_t(struct file *fp, struct uio *uio,
  69                     struct ucred *active_cred, int flags,
  70                     struct thread *td);
  71 #define FOF_OFFSET      1       /* Use the offset in uio argument */
  72 typedef int fo_ioctl_t(struct file *fp, u_long com, void *data,
  73                     struct ucred *active_cred, struct thread *td);
  74 typedef int fo_poll_t(struct file *fp, int events,
  75                     struct ucred *active_cred, struct thread *td);
  76 typedef int fo_kqfilter_t(struct file *fp, struct knote *kn);
  77 typedef int fo_stat_t(struct file *fp, struct stat *sb,
  78                     struct ucred *active_cred, struct thread *td);
  79 typedef int fo_close_t(struct file *fp, struct thread *td);
  80 typedef int fo_flags_t;
  81
  82 struct fileops {
  83         fo_rdwr_t       *fo_read;
  84         fo_rdwr_t       *fo_write;
  85         fo_ioctl_t      *fo_ioctl;
  86         fo_poll_t       *fo_poll;
  87         fo_kqfilter_t   *fo_kqfilter;
  88         fo_stat_t       *fo_stat;
  89         fo_close_t      *fo_close;
  90         fo_flags_t      fo_flags;       /* DFLAG_* below */
  91 };
  92
  93 #define DFLAG_PASSABLE  0x01    /* may be passed via unix sockets. */
  94 #define DFLAG_SEEKABLE  0x02    /* seekable / nonsequential */
  95
  96 /*
  97  * Kernel descriptor table.
  98  * One entry for each open kernel vnode and socket.
  99  *
 100  * Below is the list of locks that protects members in struct file.
 101  *
 102  * (fl) filelist_lock
 103  * (f)  f_mtx in struct file
 104  * none not locked
 105  */
 106
 107 struct file {
 108         LIST_ENTRY(file) f_list;/* (fl) list of active files */
 109         short   f_type;         /* descriptor type */
 110         void    *f_data;        /* file descriptor specific data */
 111         u_int   f_flag;         /* see fcntl.h */
 112         struct mtx      *f_mtxp;        /* mutex to protect data */
 113         struct fileops *f_ops;  /* File operations */
 114         struct  ucred *f_cred;  /* credentials associated with descriptor */
 115         int     f_count;        /* (f) reference count */
 116         struct vnode *f_vnode;  /* NULL or applicable vnode */
 117
 118         /* DFLAG_SEEKABLE specific fields */
 119         off_t   f_offset;
 120         short     f_vnread_flags; /*
 121                                    * (f) home grown sleep lock for f_offset
 122                                    * Used only for shared vnode locking in
 123                                    * vnread()
 124                                    */
 125 #define  FOFFSET_LOCKED       0x1
 126 #define  FOFFSET_LOCK_WAITING 0x2
 127         /* DTYPE_SOCKET specific fields */
 128         short   f_gcflag;       /* used by thread doing fd garbage collection */
 129 #define FMARK           0x1     /* mark during gc() */
 130 #define FDEFER          0x2     /* defer for next gc pass */
 131 #define FWAIT           0x4     /* gc is scanning message buffers */
 132         int     f_msgcount;     /* (f) references from message queue */
 133
 134         /* DTYPE_VNODE specific fields */
 135         int     f_seqcount;     /*
 136                                  * count of sequential accesses -- cleared
 137                                  * by most seek operations.
 138                                  */
 139         off_t   f_nextoff;      /*
 140                                  * offset of next expected read or write
 141                                  */
 142         void    *f_label;       /* Place-holder for struct label pointer. */
 143 };
 144
 145 #endif /* _KERNEL */
 146
 147 /*
 148  * Userland version of struct file, for sysctl
 149  */
 150 struct xfile {
 151         size_t  xf_size;        /* size of struct xfile */
 152         pid_t   xf_pid;         /* owning process */
 153         uid_t   xf_uid;         /* effective uid of owning process */
 154         int     xf_fd;          /* descriptor number */
 155         void    *xf_file;       /* address of struct file */
 156         short   xf_type;        /* descriptor type */
 157         int     xf_count;       /* reference count */
 158         int     xf_msgcount;    /* references from message queue */
 159         off_t   xf_offset;      /* file offset */
 160         void    *xf_data;       /* file descriptor specific data */
 161         void    *xf_vnode;      /* vnode pointer */
 162         u_int   xf_flag;        /* flags (see fcntl.h) */
 163 };
 164
 165 #ifdef _KERNEL
 166
 167 #ifdef MALLOC_DECLARE
 168 MALLOC_DECLARE(M_FILE);
 169 #endif
 170
 171 LIST_HEAD(filelist, file);
 172 extern struct filelist filehead; /* (fl) head of list of open files */
 173 extern struct fileops vnops;
 174 extern struct fileops badfileops;
 175 extern struct fileops socketops;
 176 extern int maxfiles;            /* kernel limit on number of open files */
 177 extern int maxfilesperproc;     /* per process limit on number of open files */
 178 extern int openfiles;           /* (fl) actual number of open files */
 179 extern struct sx filelist_lock; /* sx to protect filelist and openfiles */
 180
 181 int fget(struct thread *td, int fd, struct file **fpp);
 182 int fget_read(struct thread *td, int fd, struct file **fpp);
 183 int fget_write(struct thread *td, int fd, struct file **fpp);
 184 int fdrop(struct file *fp, struct thread *td);
 185
 186 /*
 187  * The socket operations are used a couple of places.
 188  * XXX: This is wrong, they should go through the operations vector for
 189  * XXX: sockets instead of going directly for the individual functions. /phk
 190  */
 191 fo_rdwr_t       soo_read;
 192 fo_rdwr_t       soo_write;
 193 fo_ioctl_t      soo_ioctl;
 194 fo_poll_t       soo_poll;
 195 fo_kqfilter_t   soo_kqfilter;
 196 fo_stat_t       soo_stat;
 197 fo_close_t      soo_close;
 198
 199 /* Lock a file. */
 200 #define FILE_LOCK(f)    mtx_lock((f)->f_mtxp)
 201 #define FILE_UNLOCK(f)  mtx_unlock((f)->f_mtxp)
 202 #define FILE_LOCKED(f)  mtx_owned((f)->f_mtxp)
 203 #define FILE_LOCK_ASSERT(f, type) mtx_assert((f)->f_mtxp, (type))
 204
 205 int fgetvp(struct thread *td, int fd, struct vnode **vpp);
 206 int fgetvp_read(struct thread *td, int fd, struct vnode **vpp);
 207 int fgetvp_write(struct thread *td, int fd, struct vnode **vpp);
 208
 209 int fgetsock(struct thread *td, int fd, struct socket **spp, u_int *fflagp);
 210 void fputsock(struct socket *sp);
 211
 212 #define fhold_locked(fp)                                                \
 213         do {                                                            \
 214                 FILE_LOCK_ASSERT(fp, MA_OWNED);                         \
 215                 (fp)->f_count++;                                        \
 216         } while (0)
 217
 218 #define fhold(fp)                                                       \
 219         do {                                                            \
 220                 FILE_LOCK(fp);                                          \
 221                 (fp)->f_count++;                                        \
 222                 FILE_UNLOCK(fp);                                        \
 223         } while (0)
 224
 225 static __inline fo_rdwr_t       fo_read;
 226 static __inline fo_rdwr_t       fo_write;
 227 static __inline fo_ioctl_t      fo_ioctl;
 228 static __inline fo_poll_t       fo_poll;
 229 static __inline fo_kqfilter_t   fo_kqfilter;
 230 static __inline fo_stat_t       fo_stat;
 231 static __inline fo_close_t      fo_close;
 232
 233 static __inline int
 234 fo_read(fp, uio, active_cred, flags, td)
 235         struct file *fp;
 236         struct uio *uio;
 237         struct ucred *active_cred;
 238         int flags;
 239         struct thread *td;
 240 {
 241
 242         return ((*fp->f_ops->fo_read)(fp, uio, active_cred, flags, td));
 243 }
 244
 245 static __inline int
 246 fo_write(fp, uio, active_cred, flags, td)
 247         struct file *fp;
 248         struct uio *uio;
 249         struct ucred *active_cred;
 250         int flags;
 251         struct thread *td;
 252 {
 253
 254         return ((*fp->f_ops->fo_write)(fp, uio, active_cred, flags, td));
 255 }
 256
 257 static __inline int
 258 fo_ioctl(fp, com, data, active_cred, td)
 259         struct file *fp;
 260         u_long com;
 261         void *data;
 262         struct ucred *active_cred;
 263         struct thread *td;
 264 {
 265
 266         return ((*fp->f_ops->fo_ioctl)(fp, com, data, active_cred, td));
 267 }
 268
 269 static __inline int
 270 fo_poll(fp, events, active_cred, td)
 271         struct file *fp;
 272         int events;
 273         struct ucred *active_cred;
 274         struct thread *td;
 275 {
 276
 277         return ((*fp->f_ops->fo_poll)(fp, events, active_cred, td));
 278 }
 279
 280 static __inline int
 281 fo_stat(fp, sb, active_cred, td)
 282         struct file *fp;
 283         struct stat *sb;
 284         struct ucred *active_cred;
 285         struct thread *td;
 286 {
 287
 288         return ((*fp->f_ops->fo_stat)(fp, sb, active_cred, td));
 289 }
 290
 291 static __inline int
 292 fo_close(fp, td)
 293         struct file *fp;
 294         struct thread *td;
 295 {
 296
 297         return ((*fp->f_ops->fo_close)(fp, td));
 298 }
 299
 300 static __inline int
 301 fo_kqfilter(fp, kn)
 302         struct file *fp;
 303         struct knote *kn;
 304 {
 305
 306         return ((*fp->f_ops->fo_kqfilter)(fp, kn));
 307 }
 308
 309 #endif /* _KERNEL */
 310
 311 #endif /* !SYS_FILE_H */