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