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/refcount.h>
  43 #include <sys/_lock.h>
  44 #include <sys/_mutex.h>
  45
  46 struct stat;
  47 struct thread;
  48 struct uio;
  49 struct knote;
  50 struct vnode;
  51 struct socket;
  52
  53
  54 #endif /* _KERNEL */
  55
  56 #define DTYPE_VNODE     1       /* file */
  57 #define DTYPE_SOCKET    2       /* communications endpoint */
  58 #define DTYPE_PIPE      3       /* pipe */
  59 #define DTYPE_FIFO      4       /* fifo (named pipe) */
  60 #define DTYPE_KQUEUE    5       /* event queue */
  61 #define DTYPE_CRYPTO    6       /* crypto */
  62 #define DTYPE_MQUEUE    7       /* posix message queue */
  63 #define DTYPE_SHM       8       /* swap-backed shared memory */
  64 #define DTYPE_SEM       9       /* posix semaphore */
  65 #define DTYPE_PTS       10      /* pseudo teletype master device */
  66
  67 #ifdef _KERNEL
  68
  69 struct file;
  70 struct ucred;
  71
  72 typedef int fo_rdwr_t(struct file *fp, struct uio *uio,
  73                     struct ucred *active_cred, int flags,
  74                     struct thread *td);
  75 #define FOF_OFFSET      1       /* Use the offset in uio argument */
  76 typedef int fo_truncate_t(struct file *fp, off_t length,
  77                     struct ucred *active_cred, struct thread *td);
  78 typedef int fo_ioctl_t(struct file *fp, u_long com, void *data,
  79                     struct ucred *active_cred, struct thread *td);
  80 typedef int fo_poll_t(struct file *fp, int events,
  81                     struct ucred *active_cred, struct thread *td);
  82 typedef int fo_kqfilter_t(struct file *fp, struct knote *kn);
  83 typedef int fo_stat_t(struct file *fp, struct stat *sb,
  84                     struct ucred *active_cred, struct thread *td);
  85 typedef int fo_close_t(struct file *fp, struct thread *td);
  86 typedef int fo_flags_t;
  87
  88 struct fileops {
  89         fo_rdwr_t       *fo_read;
  90         fo_rdwr_t       *fo_write;
  91         fo_truncate_t   *fo_truncate;
  92         fo_ioctl_t      *fo_ioctl;
  93         fo_poll_t       *fo_poll;
  94         fo_kqfilter_t   *fo_kqfilter;
  95         fo_stat_t       *fo_stat;
  96         fo_close_t      *fo_close;
  97         fo_flags_t      fo_flags;       /* DFLAG_* below */
  98 };
  99
 100 #define DFLAG_PASSABLE  0x01    /* may be passed via unix sockets. */
 101 #define DFLAG_SEEKABLE  0x02    /* seekable / nonsequential */
 102 #endif /* _KERNEL */
 103
 104 #if defined(_KERNEL) || defined(_WANT_FILE)
 105 /*
 106  * Kernel descriptor table.
 107  * One entry for each open kernel vnode and socket.
 108  *
 109  * Below is the list of locks that protects members in struct file.
 110  *
 111  * (f) protected with mtx_lock(mtx_pool_find(fp))
 112  * (d) cdevpriv_mtx
 113  * none not locked
 114  */
 115
 116 struct fadvise_info {
 117         int             fa_advice;      /* (f) FADV_* type. */
 118         off_t           fa_start;       /* (f) Region start. */
 119         off_t           fa_end;         /* (f) Region end. */
 120 };
 121
 122 struct file {
 123         void            *f_data;        /* file descriptor specific data */
 124         struct fileops  *f_ops;         /* File operations */
 125         struct ucred    *f_cred;        /* associated credentials. */
 126         struct vnode    *f_vnode;       /* NULL or applicable vnode */
 127         short           f_type;         /* descriptor type */
 128         short           f_vnread_flags; /* (f) Sleep lock for f_offset */
 129         volatile u_int  f_flag;         /* see fcntl.h */
 130         volatile u_int  f_count;        /* reference count */
 131         /*
 132          *  DTYPE_VNODE specific fields.
 133          */
 134         int             f_seqcount;     /* Count of sequential accesses. */
 135         off_t           f_nextoff;      /* next expected read/write offset. */
 136         union {
 137                 struct cdev_privdata *fvn_cdevpriv;
 138                                         /* (d) Private data for the cdev. */
 139                 struct fadvise_info *fvn_advice;
 140         } f_vnun;
 141         /*
 142          *  DFLAG_SEEKABLE specific fields
 143          */
 144         off_t           f_offset;
 145         /*
 146          * Mandatory Access control information.
 147          */
 148         void            *f_label;       /* Place-holder for MAC label. */
 149 };
 150
 151 #define f_cdevpriv      f_vnun.fvn_cdevpriv
 152 #define f_advice        f_vnun.fvn_advice
 153
 154 #define FOFFSET_LOCKED       0x1
 155 #define FOFFSET_LOCK_WAITING 0x2
 156
 157 #endif /* _KERNEL || _WANT_FILE */
 158
 159 /*
 160  * Userland version of struct file, for sysctl
 161  */
 162 struct xfile {
 163         size_t  xf_size;        /* size of struct xfile */
 164         pid_t   xf_pid;         /* owning process */
 165         uid_t   xf_uid;         /* effective uid of owning process */
 166         int     xf_fd;          /* descriptor number */
 167         void    *xf_file;       /* address of struct file */
 168         short   xf_type;        /* descriptor type */
 169         int     xf_count;       /* reference count */
 170         int     xf_msgcount;    /* references from message queue */
 171         off_t   xf_offset;      /* file offset */
 172         void    *xf_data;       /* file descriptor specific data */
 173         void    *xf_vnode;      /* vnode pointer */
 174         u_int   xf_flag;        /* flags (see fcntl.h) */
 175 };
 176
 177 #ifdef _KERNEL
 178
 179 #ifdef MALLOC_DECLARE
 180 MALLOC_DECLARE(M_FILE);
 181 #endif
 182
 183 extern struct fileops vnops;
 184 extern struct fileops badfileops;
 185 extern struct fileops socketops;
 186 extern int maxfiles;            /* kernel limit on number of open files */
 187 extern int maxfilesperproc;     /* per process limit on number of open files */
 188 extern volatile int openfiles;  /* actual number of open files */
 189
 190 int fget(struct thread *td, int fd, struct file **fpp);
 191 int fget_read(struct thread *td, int fd, struct file **fpp);
 192 int fget_write(struct thread *td, int fd, struct file **fpp);
 193 int _fdrop(struct file *fp, struct thread *td);
 194
 195 /*
 196  * The socket operations are used a couple of places.
 197  * XXX: This is wrong, they should go through the operations vector for
 198  * XXX: sockets instead of going directly for the individual functions. /phk
 199  */
 200 fo_rdwr_t       soo_read;
 201 fo_rdwr_t       soo_write;
 202 fo_truncate_t   soo_truncate;
 203 fo_ioctl_t      soo_ioctl;
 204 fo_poll_t       soo_poll;
 205 fo_kqfilter_t   soo_kqfilter;
 206 fo_stat_t       soo_stat;
 207 fo_close_t      soo_close;
 208
 209 void finit(struct file *, u_int, short, void *, struct fileops *);
 210 int fgetvp(struct thread *td, int fd, struct vnode **vpp);
 211 int fgetvp_read(struct thread *td, int fd, struct vnode **vpp);
 212 int fgetvp_write(struct thread *td, int fd, struct vnode **vpp);
 213
 214 int fgetsock(struct thread *td, int fd, struct socket **spp, u_int *fflagp);
 215 void fputsock(struct socket *sp);
 216
 217 #define fhold(fp)                                                       \
 218         (refcount_acquire(&(fp)->f_count))
 219 #define fdrop(fp, td)                                                   \
 220         (refcount_release(&(fp)->f_count) ? _fdrop((fp), (td)) : 0)
 221
 222 static __inline fo_rdwr_t       fo_read;
 223 static __inline fo_rdwr_t       fo_write;
 224 static __inline fo_truncate_t   fo_truncate;
 225 static __inline fo_ioctl_t      fo_ioctl;
 226 static __inline fo_poll_t       fo_poll;
 227 static __inline fo_kqfilter_t   fo_kqfilter;
 228 static __inline fo_stat_t       fo_stat;
 229 static __inline fo_close_t      fo_close;
 230
 231 static __inline int
 232 fo_read(fp, uio, active_cred, flags, td)
 233         struct file *fp;
 234         struct uio *uio;
 235         struct ucred *active_cred;
 236         int flags;
 237         struct thread *td;
 238 {
 239
 240         return ((*fp->f_ops->fo_read)(fp, uio, active_cred, flags, td));
 241 }
 242
 243 static __inline int
 244 fo_write(fp, uio, active_cred, flags, td)
 245         struct file *fp;
 246         struct uio *uio;
 247         struct ucred *active_cred;
 248         int flags;
 249         struct thread *td;
 250 {
 251
 252         return ((*fp->f_ops->fo_write)(fp, uio, active_cred, flags, td));
 253 }
 254
 255 static __inline int
 256 fo_truncate(fp, length, active_cred, td)
 257         struct file *fp;
 258         off_t length;
 259         struct ucred *active_cred;
 260         struct thread *td;
 261 {
 262
 263         return ((*fp->f_ops->fo_truncate)(fp, length, active_cred, td));
 264 }
 265
 266 static __inline int
 267 fo_ioctl(fp, com, data, active_cred, td)
 268         struct file *fp;
 269         u_long com;
 270         void *data;
 271         struct ucred *active_cred;
 272         struct thread *td;
 273 {
 274
 275         return ((*fp->f_ops->fo_ioctl)(fp, com, data, active_cred, td));
 276 }
 277
 278 static __inline int
 279 fo_poll(fp, events, active_cred, td)
 280         struct file *fp;
 281         int events;
 282         struct ucred *active_cred;
 283         struct thread *td;
 284 {
 285
 286         return ((*fp->f_ops->fo_poll)(fp, events, active_cred, td));
 287 }
 288
 289 static __inline int
 290 fo_stat(fp, sb, active_cred, td)
 291         struct file *fp;
 292         struct stat *sb;
 293         struct ucred *active_cred;
 294         struct thread *td;
 295 {
 296
 297         return ((*fp->f_ops->fo_stat)(fp, sb, active_cred, td));
 298 }
 299
 300 static __inline int
 301 fo_close(fp, td)
 302         struct file *fp;
 303         struct thread *td;
 304 {
 305
 306         return ((*fp->f_ops->fo_close)(fp, td));
 307 }
 308
 309 static __inline int
 310 fo_kqfilter(fp, kn)
 311         struct file *fp;
 312         struct knote *kn;
 313 {
 314
 315         return ((*fp->f_ops->fo_kqfilter)(fp, kn));
 316 }
 317
 318 #endif /* _KERNEL */
 319
 320 #endif /* !SYS_FILE_H */