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         off_t           fa_prevstart;   /* (f) Previous NOREUSE start. */
 121         off_t           fa_prevend;     /* (f) Previous NOREUSE end. */
 122 };
 123
 124 struct file {
 125         void            *f_data;        /* file descriptor specific data */
 126         struct fileops  *f_ops;         /* File operations */
 127         struct ucred    *f_cred;        /* associated credentials. */
 128         struct vnode    *f_vnode;       /* NULL or applicable vnode */
 129         short           f_type;         /* descriptor type */
 130         short           f_vnread_flags; /* (f) Sleep lock for f_offset */
 131         volatile u_int  f_flag;         /* see fcntl.h */
 132         volatile u_int  f_count;        /* reference count */
 133         /*
 134          *  DTYPE_VNODE specific fields.
 135          */
 136         int             f_seqcount;     /* Count of sequential accesses. */
 137         off_t           f_nextoff;      /* next expected read/write offset. */
 138         union {
 139                 struct cdev_privdata *fvn_cdevpriv;
 140                                         /* (d) Private data for the cdev. */
 141                 struct fadvise_info *fvn_advice;
 142         } f_vnun;
 143         /*
 144          *  DFLAG_SEEKABLE specific fields
 145          */
 146         off_t           f_offset;
 147         /*
 148          * Mandatory Access control information.
 149          */
 150         void            *f_label;       /* Place-holder for MAC label. */
 151 };
 152
 153 #define f_cdevpriv      f_vnun.fvn_cdevpriv
 154 #define f_advice        f_vnun.fvn_advice
 155
 156 #define FOFFSET_LOCKED       0x1
 157 #define FOFFSET_LOCK_WAITING 0x2
 158
 159 #endif /* _KERNEL || _WANT_FILE */
 160
 161 /*
 162  * Userland version of struct file, for sysctl
 163  */
 164 struct xfile {
 165         size_t  xf_size;        /* size of struct xfile */
 166         pid_t   xf_pid;         /* owning process */
 167         uid_t   xf_uid;         /* effective uid of owning process */
 168         int     xf_fd;          /* descriptor number */
 169         void    *xf_file;       /* address of struct file */
 170         short   xf_type;        /* descriptor type */
 171         int     xf_count;       /* reference count */
 172         int     xf_msgcount;    /* references from message queue */
 173         off_t   xf_offset;      /* file offset */
 174         void    *xf_data;       /* file descriptor specific data */
 175         void    *xf_vnode;      /* vnode pointer */
 176         u_int   xf_flag;        /* flags (see fcntl.h) */
 177 };
 178
 179 #ifdef _KERNEL
 180
 181 #ifdef MALLOC_DECLARE
 182 MALLOC_DECLARE(M_FILE);
 183 #endif
 184
 185 extern struct fileops vnops;
 186 extern struct fileops badfileops;
 187 extern struct fileops socketops;
 188 extern int maxfiles;            /* kernel limit on number of open files */
 189 extern int maxfilesperproc;     /* per process limit on number of open files */
 190 extern volatile int openfiles;  /* actual number of open files */
 191
 192 int fget(struct thread *td, int fd, struct file **fpp);
 193 int fget_read(struct thread *td, int fd, struct file **fpp);
 194 int fget_write(struct thread *td, int fd, struct file **fpp);
 195 int _fdrop(struct file *fp, struct thread *td);
 196
 197 /*
 198  * The socket operations are used a couple of places.
 199  * XXX: This is wrong, they should go through the operations vector for
 200  * XXX: sockets instead of going directly for the individual functions. /phk
 201  */
 202 fo_rdwr_t       soo_read;
 203 fo_rdwr_t       soo_write;
 204 fo_truncate_t   soo_truncate;
 205 fo_ioctl_t      soo_ioctl;
 206 fo_poll_t       soo_poll;
 207 fo_kqfilter_t   soo_kqfilter;
 208 fo_stat_t       soo_stat;
 209 fo_close_t      soo_close;
 210
 211 void finit(struct file *, u_int, short, void *, struct fileops *);
 212 int fgetvp(struct thread *td, int fd, struct vnode **vpp);
 213 int fgetvp_read(struct thread *td, int fd, struct vnode **vpp);
 214 int fgetvp_write(struct thread *td, int fd, struct vnode **vpp);
 215
 216 int fgetsock(struct thread *td, int fd, struct socket **spp, u_int *fflagp);
 217 void fputsock(struct socket *sp);
 218
 219 #define fhold(fp)                                                       \
 220         (refcount_acquire(&(fp)->f_count))
 221 #define fdrop(fp, td)                                                   \
 222         (refcount_release(&(fp)->f_count) ? _fdrop((fp), (td)) : 0)
 223
 224 static __inline fo_rdwr_t       fo_read;
 225 static __inline fo_rdwr_t       fo_write;
 226 static __inline fo_truncate_t   fo_truncate;
 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_truncate(fp, length, active_cred, td)
 259         struct file *fp;
 260         off_t length;
 261         struct ucred *active_cred;
 262         struct thread *td;
 263 {
 264
 265         return ((*fp->f_ops->fo_truncate)(fp, length, active_cred, td));
 266 }
 267
 268 static __inline int
 269 fo_ioctl(fp, com, data, active_cred, td)
 270         struct file *fp;
 271         u_long com;
 272         void *data;
 273         struct ucred *active_cred;
 274         struct thread *td;
 275 {
 276
 277         return ((*fp->f_ops->fo_ioctl)(fp, com, data, active_cred, td));
 278 }
 279
 280 static __inline int
 281 fo_poll(fp, events, active_cred, td)
 282         struct file *fp;
 283         int events;
 284         struct ucred *active_cred;
 285         struct thread *td;
 286 {
 287
 288         return ((*fp->f_ops->fo_poll)(fp, events, active_cred, td));
 289 }
 290
 291 static __inline int
 292 fo_stat(fp, sb, active_cred, td)
 293         struct file *fp;
 294         struct stat *sb;
 295         struct ucred *active_cred;
 296         struct thread *td;
 297 {
 298
 299         return ((*fp->f_ops->fo_stat)(fp, sb, active_cred, td));
 300 }
 301
 302 static __inline int
 303 fo_close(fp, td)
 304         struct file *fp;
 305         struct thread *td;
 306 {
 307
 308         return ((*fp->f_ops->fo_close)(fp, td));
 309 }
 310
 311 static __inline int
 312 fo_kqfilter(fp, kn)
 313         struct file *fp;
 314         struct knote *kn;
 315 {
 316
 317         return ((*fp->f_ops->fo_kqfilter)(fp, kn));
 318 }
 319
 320 #endif /* _KERNEL */
 321
 322 #endif /* !SYS_FILE_H */