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 #include <vm/vm.h>
  46
  47 struct filedesc;
  48 struct stat;
  49 struct thread;
  50 struct uio;
  51 struct knote;
  52 struct vnode;
  53 struct socket;
  54
  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 #define DTYPE_CRYPTO    6       /* crypto */
  64 #define DTYPE_MQUEUE    7       /* posix message queue */
  65 #define DTYPE_SHM       8       /* swap-backed shared memory */
  66 #define DTYPE_SEM       9       /* posix semaphore */
  67 #define DTYPE_PTS       10      /* pseudo teletype master device */
  68 #define DTYPE_DEV       11      /* Device specific fd type */
  69 #define DTYPE_PROCDESC  12      /* process descriptor */
  70 #define DTYPE_LINUXEFD  13      /* emulation eventfd type */
  71
  72 #ifdef _KERNEL
  73
  74 struct file;
  75 struct filecaps;
  76 struct kinfo_file;
  77 struct ucred;
  78
  79 #define FOF_OFFSET      0x01    /* Use the offset in uio argument */
  80 #define FOF_NOLOCK      0x02    /* Do not take FOFFSET_LOCK */
  81 #define FOF_NEXTOFF     0x04    /* Also update f_nextoff */
  82 #define FOF_NOUPDATE    0x10    /* Do not update f_offset */
  83 off_t foffset_lock(struct file *fp, int flags);
  84 void foffset_lock_uio(struct file *fp, struct uio *uio, int flags);
  85 void foffset_unlock(struct file *fp, off_t val, int flags);
  86 void foffset_unlock_uio(struct file *fp, struct uio *uio, int flags);
  87
  88 static inline off_t
  89 foffset_get(struct file *fp)
  90 {
  91
  92         return (foffset_lock(fp, FOF_NOLOCK));
  93 }
  94
  95 typedef int fo_rdwr_t(struct file *fp, struct uio *uio,
  96                     struct ucred *active_cred, int flags,
  97                     struct thread *td);
  98 typedef int fo_truncate_t(struct file *fp, off_t length,
  99                     struct ucred *active_cred, struct thread *td);
 100 typedef int fo_ioctl_t(struct file *fp, u_long com, void *data,
 101                     struct ucred *active_cred, struct thread *td);
 102 typedef int fo_poll_t(struct file *fp, int events,
 103                     struct ucred *active_cred, struct thread *td);
 104 typedef int fo_kqfilter_t(struct file *fp, struct knote *kn);
 105 typedef int fo_stat_t(struct file *fp, struct stat *sb,
 106                     struct ucred *active_cred, struct thread *td);
 107 typedef int fo_close_t(struct file *fp, struct thread *td);
 108 typedef int fo_chmod_t(struct file *fp, mode_t mode,
 109                     struct ucred *active_cred, struct thread *td);
 110 typedef int fo_chown_t(struct file *fp, uid_t uid, gid_t gid,
 111                     struct ucred *active_cred, struct thread *td);
 112 typedef int fo_sendfile_t(struct file *fp, int sockfd, struct uio *hdr_uio,
 113                     struct uio *trl_uio, off_t offset, size_t nbytes,
 114                     off_t *sent, int flags, int kflags, struct thread *td);
 115 typedef int fo_seek_t(struct file *fp, off_t offset, int whence,
 116                     struct thread *td);
 117 typedef int fo_fill_kinfo_t(struct file *fp, struct kinfo_file *kif,
 118                     struct filedesc *fdp);
 119 typedef int fo_mmap_t(struct file *fp, vm_map_t map, vm_offset_t *addr,
 120                     vm_size_t size, vm_prot_t prot, vm_prot_t cap_maxprot,
 121                     int flags, vm_ooffset_t foff, struct thread *td);
 122 typedef int fo_flags_t;
 123
 124 struct fileops {
 125         fo_rdwr_t       *fo_read;
 126         fo_rdwr_t       *fo_write;
 127         fo_truncate_t   *fo_truncate;
 128         fo_ioctl_t      *fo_ioctl;
 129         fo_poll_t       *fo_poll;
 130         fo_kqfilter_t   *fo_kqfilter;
 131         fo_stat_t       *fo_stat;
 132         fo_close_t      *fo_close;
 133         fo_chmod_t      *fo_chmod;
 134         fo_chown_t      *fo_chown;
 135         fo_sendfile_t   *fo_sendfile;
 136         fo_seek_t       *fo_seek;
 137         fo_fill_kinfo_t *fo_fill_kinfo;
 138         fo_mmap_t       *fo_mmap;
 139         fo_flags_t      fo_flags;       /* DFLAG_* below */
 140 };
 141
 142 #define DFLAG_PASSABLE  0x01    /* may be passed via unix sockets. */
 143 #define DFLAG_SEEKABLE  0x02    /* seekable / nonsequential */
 144 #endif /* _KERNEL */
 145
 146 #if defined(_KERNEL) || defined(_WANT_FILE)
 147 /*
 148  * Kernel descriptor table.
 149  * One entry for each open kernel vnode and socket.
 150  *
 151  * Below is the list of locks that protects members in struct file.
 152  *
 153  * (a) f_vnode lock required (shared allows both reads and writes)
 154  * (f) protected with mtx_lock(mtx_pool_find(fp))
 155  * (d) cdevpriv_mtx
 156  * none not locked
 157  */
 158
 159 struct fadvise_info {
 160         int             fa_advice;      /* (f) FADV_* type. */
 161         off_t           fa_start;       /* (f) Region start. */
 162         off_t           fa_end;         /* (f) Region end. */
 163 };
 164
 165 struct file {
 166         void            *f_data;        /* file descriptor specific data */
 167         struct fileops  *f_ops;         /* File operations */
 168         struct ucred    *f_cred;        /* associated credentials. */
 169         struct vnode    *f_vnode;       /* NULL or applicable vnode */
 170         short           f_type;         /* descriptor type */
 171         short           f_vnread_flags; /* (f) Sleep lock for f_offset */
 172         volatile u_int  f_flag;         /* see fcntl.h */
 173         volatile u_int  f_count;        /* reference count */
 174         /*
 175          *  DTYPE_VNODE specific fields.
 176          */
 177         int             f_seqcount;     /* (a) Count of sequential accesses. */
 178         off_t           f_nextoff;      /* next expected read/write offset. */
 179         union {
 180                 struct cdev_privdata *fvn_cdevpriv;
 181                                         /* (d) Private data for the cdev. */
 182                 struct fadvise_info *fvn_advice;
 183         } f_vnun;
 184         /*
 185          *  DFLAG_SEEKABLE specific fields
 186          */
 187         off_t           f_offset;
 188         /*
 189          * Mandatory Access control information.
 190          */
 191         void            *f_label;       /* Place-holder for MAC label. */
 192 };
 193
 194 #define f_cdevpriv      f_vnun.fvn_cdevpriv
 195 #define f_advice        f_vnun.fvn_advice
 196
 197 #define FOFFSET_LOCKED       0x1
 198 #define FOFFSET_LOCK_WAITING 0x2
 199 #define FDEVFS_VNODE         0x4
 200
 201 #endif /* _KERNEL || _WANT_FILE */
 202
 203 /*
 204  * Userland version of struct file, for sysctl
 205  */
 206 struct xfile {
 207         size_t  xf_size;        /* size of struct xfile */
 208         pid_t   xf_pid;         /* owning process */
 209         uid_t   xf_uid;         /* effective uid of owning process */
 210         int     xf_fd;          /* descriptor number */
 211         void    *xf_file;       /* address of struct file */
 212         short   xf_type;        /* descriptor type */
 213         int     xf_count;       /* reference count */
 214         int     xf_msgcount;    /* references from message queue */
 215         off_t   xf_offset;      /* file offset */
 216         void    *xf_data;       /* file descriptor specific data */
 217         void    *xf_vnode;      /* vnode pointer */
 218         u_int   xf_flag;        /* flags (see fcntl.h) */
 219 };
 220
 221 #ifdef _KERNEL
 222
 223 extern struct fileops vnops;
 224 extern struct fileops badfileops;
 225 extern struct fileops socketops;
 226 extern int maxfiles;            /* kernel limit on number of open files */
 227 extern int maxfilesperproc;     /* per process limit on number of open files */
 228 extern volatile int openfiles;  /* actual number of open files */
 229
 230 int fget(struct thread *td, int fd, cap_rights_t *rightsp, struct file **fpp);
 231 int fget_mmap(struct thread *td, int fd, cap_rights_t *rightsp,
 232     u_char *maxprotp, struct file **fpp);
 233 int fget_read(struct thread *td, int fd, cap_rights_t *rightsp,
 234     struct file **fpp);
 235 int fget_write(struct thread *td, int fd, cap_rights_t *rightsp,
 236     struct file **fpp);
 237 int fget_fcntl(struct thread *td, int fd, cap_rights_t *rightsp,
 238     int needfcntl, struct file **fpp);
 239 int _fdrop(struct file *fp, struct thread *td);
 240
 241 fo_rdwr_t       invfo_rdwr;
 242 fo_truncate_t   invfo_truncate;
 243 fo_ioctl_t      invfo_ioctl;
 244 fo_poll_t       invfo_poll;
 245 fo_kqfilter_t   invfo_kqfilter;
 246 fo_chmod_t      invfo_chmod;
 247 fo_chown_t      invfo_chown;
 248 fo_sendfile_t   invfo_sendfile;
 249
 250 fo_sendfile_t   vn_sendfile;
 251 fo_seek_t       vn_seek;
 252 fo_fill_kinfo_t vn_fill_kinfo;
 253 int vn_fill_kinfo_vnode(struct vnode *vp, struct kinfo_file *kif);
 254
 255 void finit(struct file *, u_int, short, void *, struct fileops *);
 256 int fgetvp(struct thread *td, int fd, cap_rights_t *rightsp,
 257     struct vnode **vpp);
 258 int fgetvp_exec(struct thread *td, int fd, cap_rights_t *rightsp,
 259     struct vnode **vpp);
 260 int fgetvp_rights(struct thread *td, int fd, cap_rights_t *needrightsp,
 261     struct filecaps *havecaps, struct vnode **vpp);
 262 int fgetvp_read(struct thread *td, int fd, cap_rights_t *rightsp,
 263     struct vnode **vpp);
 264 int fgetvp_write(struct thread *td, int fd, cap_rights_t *rightsp,
 265     struct vnode **vpp);
 266
 267 int fgetsock(struct thread *td, int fd, cap_rights_t *rightsp,
 268     struct socket **spp, u_int *fflagp);
 269 void fputsock(struct socket *sp);
 270
 271 static __inline int
 272 _fnoop(void)
 273 {
 274
 275         return (0);
 276 }
 277
 278 #define fhold(fp)                                                       \
 279         (refcount_acquire(&(fp)->f_count))
 280 #define fdrop(fp, td)                                                   \
 281         (refcount_release(&(fp)->f_count) ? _fdrop((fp), (td)) : _fnoop())
 282
 283 static __inline fo_rdwr_t       fo_read;
 284 static __inline fo_rdwr_t       fo_write;
 285 static __inline fo_truncate_t   fo_truncate;
 286 static __inline fo_ioctl_t      fo_ioctl;
 287 static __inline fo_poll_t       fo_poll;
 288 static __inline fo_kqfilter_t   fo_kqfilter;
 289 static __inline fo_stat_t       fo_stat;
 290 static __inline fo_close_t      fo_close;
 291 static __inline fo_chmod_t      fo_chmod;
 292 static __inline fo_chown_t      fo_chown;
 293 static __inline fo_sendfile_t   fo_sendfile;
 294
 295 static __inline int
 296 fo_read(struct file *fp, struct uio *uio, struct ucred *active_cred,
 297     int flags, struct thread *td)
 298 {
 299
 300         return ((*fp->f_ops->fo_read)(fp, uio, active_cred, flags, td));
 301 }
 302
 303 static __inline int
 304 fo_write(struct file *fp, struct uio *uio, struct ucred *active_cred,
 305     int flags, struct thread *td)
 306 {
 307
 308         return ((*fp->f_ops->fo_write)(fp, uio, active_cred, flags, td));
 309 }
 310
 311 static __inline int
 312 fo_truncate(struct file *fp, off_t length, struct ucred *active_cred,
 313     struct thread *td)
 314 {
 315
 316         return ((*fp->f_ops->fo_truncate)(fp, length, active_cred, td));
 317 }
 318
 319 static __inline int
 320 fo_ioctl(struct file *fp, u_long com, void *data, struct ucred *active_cred,
 321     struct thread *td)
 322 {
 323
 324         return ((*fp->f_ops->fo_ioctl)(fp, com, data, active_cred, td));
 325 }
 326
 327 static __inline int
 328 fo_poll(struct file *fp, int events, struct ucred *active_cred,
 329     struct thread *td)
 330 {
 331
 332         return ((*fp->f_ops->fo_poll)(fp, events, active_cred, td));
 333 }
 334
 335 static __inline int
 336 fo_stat(struct file *fp, struct stat *sb, struct ucred *active_cred,
 337     struct thread *td)
 338 {
 339
 340         return ((*fp->f_ops->fo_stat)(fp, sb, active_cred, td));
 341 }
 342
 343 static __inline int
 344 fo_close(struct file *fp, struct thread *td)
 345 {
 346
 347         return ((*fp->f_ops->fo_close)(fp, td));
 348 }
 349
 350 static __inline int
 351 fo_kqfilter(struct file *fp, struct knote *kn)
 352 {
 353
 354         return ((*fp->f_ops->fo_kqfilter)(fp, kn));
 355 }
 356
 357 static __inline int
 358 fo_chmod(struct file *fp, mode_t mode, struct ucred *active_cred,
 359     struct thread *td)
 360 {
 361
 362         return ((*fp->f_ops->fo_chmod)(fp, mode, active_cred, td));
 363 }
 364
 365 static __inline int
 366 fo_chown(struct file *fp, uid_t uid, gid_t gid, struct ucred *active_cred,
 367     struct thread *td)
 368 {
 369
 370         return ((*fp->f_ops->fo_chown)(fp, uid, gid, active_cred, td));
 371 }
 372
 373 static __inline int
 374 fo_sendfile(struct file *fp, int sockfd, struct uio *hdr_uio,
 375     struct uio *trl_uio, off_t offset, size_t nbytes, off_t *sent, int flags,
 376     int kflags, struct thread *td)
 377 {
 378
 379         return ((*fp->f_ops->fo_sendfile)(fp, sockfd, hdr_uio, trl_uio, offset,
 380             nbytes, sent, flags, kflags, td));
 381 }
 382
 383 static __inline int
 384 fo_seek(struct file *fp, off_t offset, int whence, struct thread *td)
 385 {
 386
 387         return ((*fp->f_ops->fo_seek)(fp, offset, whence, td));
 388 }
 389
 390 static __inline int
 391 fo_fill_kinfo(struct file *fp, struct kinfo_file *kif, struct filedesc *fdp)
 392 {
 393
 394         return ((*fp->f_ops->fo_fill_kinfo)(fp, kif, fdp));
 395 }
 396
 397 static __inline int
 398 fo_mmap(struct file *fp, vm_map_t map, vm_offset_t *addr, vm_size_t size,
 399     vm_prot_t prot, vm_prot_t cap_maxprot, int flags, vm_ooffset_t foff,
 400     struct thread *td)
 401 {
 402
 403         if (fp->f_ops->fo_mmap == NULL)
 404                 return (ENODEV);
 405         return ((*fp->f_ops->fo_mmap)(fp, map, addr, size, prot, cap_maxprot,
 406             flags, foff, td));
 407 }
 408
 409 #endif /* _KERNEL */
 410
 411 #endif /* !SYS_FILE_H */