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 filedesc;
  47 struct stat;
  48 struct thread;
  49 struct uio;
  50 struct knote;
  51 struct vnode;
  52 struct socket;
  53
  54
  55 #endif /* _KERNEL */
  56
  57 #define DTYPE_VNODE     1       /* file */
  58 #define DTYPE_SOCKET    2       /* communications endpoint */
  59 #define DTYPE_PIPE      3       /* pipe */
  60 #define DTYPE_FIFO      4       /* fifo (named pipe) */
  61 #define DTYPE_KQUEUE    5       /* event queue */
  62 #define DTYPE_CRYPTO    6       /* crypto */
  63 #define DTYPE_MQUEUE    7       /* posix message queue */
  64 #define DTYPE_SHM       8       /* swap-backed shared memory */
  65 #define DTYPE_SEM       9       /* posix semaphore */
  66 #define DTYPE_PTS       10      /* pseudo teletype master device */
  67 #define DTYPE_DEV       11      /* Device specific fd type */
  68 #define DTYPE_PROCDESC  12      /* process descriptor */
  69
  70 #ifdef _KERNEL
  71
  72 struct file;
  73 struct filecaps;
  74 struct kinfo_file;
  75 struct ucred;
  76
  77 #define FOF_OFFSET      0x01    /* Use the offset in uio argument */
  78 #define FOF_NOLOCK      0x02    /* Do not take FOFFSET_LOCK */
  79 #define FOF_NEXTOFF     0x04    /* Also update f_nextoff */
  80 #define FOF_NOUPDATE    0x10    /* Do not update f_offset */
  81 off_t foffset_lock(struct file *fp, int flags);
  82 void foffset_lock_uio(struct file *fp, struct uio *uio, int flags);
  83 void foffset_unlock(struct file *fp, off_t val, int flags);
  84 void foffset_unlock_uio(struct file *fp, struct uio *uio, int flags);
  85
  86 static inline off_t
  87 foffset_get(struct file *fp)
  88 {
  89
  90         return (foffset_lock(fp, FOF_NOLOCK));
  91 }
  92
  93 /* XXX pollution? */
  94 struct sendfile_sync;
  95
  96 typedef int fo_rdwr_t(struct file *fp, struct uio *uio,
  97                     struct ucred *active_cred, int flags,
  98                     struct thread *td);
  99 typedef int fo_truncate_t(struct file *fp, off_t length,
 100                     struct ucred *active_cred, struct thread *td);
 101 typedef int fo_ioctl_t(struct file *fp, u_long com, void *data,
 102                     struct ucred *active_cred, struct thread *td);
 103 typedef int fo_poll_t(struct file *fp, int events,
 104                     struct ucred *active_cred, struct thread *td);
 105 typedef int fo_kqfilter_t(struct file *fp, struct knote *kn);
 106 typedef int fo_stat_t(struct file *fp, struct stat *sb,
 107                     struct ucred *active_cred, struct thread *td);
 108 typedef int fo_close_t(struct file *fp, struct thread *td);
 109 typedef int fo_chmod_t(struct file *fp, mode_t mode,
 110                     struct ucred *active_cred, struct thread *td);
 111 typedef int fo_chown_t(struct file *fp, uid_t uid, gid_t gid,
 112                     struct ucred *active_cred, struct thread *td);
 113 typedef int fo_sendfile_t(struct file *fp, int sockfd, struct uio *hdr_uio,
 114                     struct uio *trl_uio, off_t offset, size_t nbytes,
 115                     off_t *sent, int flags, int kflags,
 116                     struct sendfile_sync *sfs, struct thread *td);
 117 typedef int fo_seek_t(struct file *fp, off_t offset, int whence,
 118                     struct thread *td);
 119 typedef int fo_fill_kinfo_t(struct file *fp, struct kinfo_file *kif,
 120                     struct filedesc *fdp);
 121 typedef int fo_flags_t;
 122
 123 struct fileops {
 124         fo_rdwr_t       *fo_read;
 125         fo_rdwr_t       *fo_write;
 126         fo_truncate_t   *fo_truncate;
 127         fo_ioctl_t      *fo_ioctl;
 128         fo_poll_t       *fo_poll;
 129         fo_kqfilter_t   *fo_kqfilter;
 130         fo_stat_t       *fo_stat;
 131         fo_close_t      *fo_close;
 132         fo_chmod_t      *fo_chmod;
 133         fo_chown_t      *fo_chown;
 134         fo_sendfile_t   *fo_sendfile;
 135         fo_seek_t       *fo_seek;
 136         fo_fill_kinfo_t *fo_fill_kinfo;
 137         fo_flags_t      fo_flags;       /* DFLAG_* below */
 138 };
 139
 140 #define DFLAG_PASSABLE  0x01    /* may be passed via unix sockets. */
 141 #define DFLAG_SEEKABLE  0x02    /* seekable / nonsequential */
 142 #endif /* _KERNEL */
 143
 144 #if defined(_KERNEL) || defined(_WANT_FILE)
 145 /*
 146  * Kernel descriptor table.
 147  * One entry for each open kernel vnode and socket.
 148  *
 149  * Below is the list of locks that protects members in struct file.
 150  *
 151  * (a) f_vnode lock required (shared allows both reads and writes)
 152  * (f) protected with mtx_lock(mtx_pool_find(fp))
 153  * (d) cdevpriv_mtx
 154  * none not locked
 155  */
 156
 157 struct fadvise_info {
 158         int             fa_advice;      /* (f) FADV_* type. */
 159         off_t           fa_start;       /* (f) Region start. */
 160         off_t           fa_end;         /* (f) Region end. */
 161         off_t           fa_prevstart;   /* (f) Previous NOREUSE start. */
 162         off_t           fa_prevend;     /* (f) Previous NOREUSE 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 _fdrop(struct file *fp, struct thread *td);
 238
 239 fo_rdwr_t       invfo_rdwr;
 240 fo_truncate_t   invfo_truncate;
 241 fo_ioctl_t      invfo_ioctl;
 242 fo_poll_t       invfo_poll;
 243 fo_kqfilter_t   invfo_kqfilter;
 244 fo_chmod_t      invfo_chmod;
 245 fo_chown_t      invfo_chown;
 246 fo_sendfile_t   invfo_sendfile;
 247
 248 fo_sendfile_t   vn_sendfile;
 249 fo_seek_t       vn_seek;
 250 fo_fill_kinfo_t vn_fill_kinfo;
 251 int vn_fill_kinfo_vnode(struct vnode *vp, struct kinfo_file *kif);
 252
 253 void finit(struct file *, u_int, short, void *, struct fileops *);
 254 int fgetvp(struct thread *td, int fd, cap_rights_t *rightsp,
 255     struct vnode **vpp);
 256 int fgetvp_exec(struct thread *td, int fd, cap_rights_t *rightsp,
 257     struct vnode **vpp);
 258 int fgetvp_rights(struct thread *td, int fd, cap_rights_t *needrightsp,
 259     struct filecaps *havecaps, struct vnode **vpp);
 260 int fgetvp_read(struct thread *td, int fd, cap_rights_t *rightsp,
 261     struct vnode **vpp);
 262 int fgetvp_write(struct thread *td, int fd, cap_rights_t *rightsp,
 263     struct vnode **vpp);
 264
 265 int fgetsock(struct thread *td, int fd, cap_rights_t *rightsp,
 266     struct socket **spp, u_int *fflagp);
 267 void fputsock(struct socket *sp);
 268
 269 static __inline int
 270 _fnoop(void)
 271 {
 272
 273         return (0);
 274 }
 275
 276 #define fhold(fp)                                                       \
 277         (refcount_acquire(&(fp)->f_count))
 278 #define fdrop(fp, td)                                                   \
 279         (refcount_release(&(fp)->f_count) ? _fdrop((fp), (td)) : _fnoop())
 280
 281 static __inline fo_rdwr_t       fo_read;
 282 static __inline fo_rdwr_t       fo_write;
 283 static __inline fo_truncate_t   fo_truncate;
 284 static __inline fo_ioctl_t      fo_ioctl;
 285 static __inline fo_poll_t       fo_poll;
 286 static __inline fo_kqfilter_t   fo_kqfilter;
 287 static __inline fo_stat_t       fo_stat;
 288 static __inline fo_close_t      fo_close;
 289 static __inline fo_chmod_t      fo_chmod;
 290 static __inline fo_chown_t      fo_chown;
 291 static __inline fo_sendfile_t   fo_sendfile;
 292
 293 static __inline int
 294 fo_read(struct file *fp, struct uio *uio, struct ucred *active_cred,
 295     int flags, struct thread *td)
 296 {
 297
 298         return ((*fp->f_ops->fo_read)(fp, uio, active_cred, flags, td));
 299 }
 300
 301 static __inline int
 302 fo_write(struct file *fp, struct uio *uio, struct ucred *active_cred,
 303     int flags, struct thread *td)
 304 {
 305
 306         return ((*fp->f_ops->fo_write)(fp, uio, active_cred, flags, td));
 307 }
 308
 309 static __inline int
 310 fo_truncate(struct file *fp, off_t length, struct ucred *active_cred,
 311     struct thread *td)
 312 {
 313
 314         return ((*fp->f_ops->fo_truncate)(fp, length, active_cred, td));
 315 }
 316
 317 static __inline int
 318 fo_ioctl(struct file *fp, u_long com, void *data, struct ucred *active_cred,
 319     struct thread *td)
 320 {
 321
 322         return ((*fp->f_ops->fo_ioctl)(fp, com, data, active_cred, td));
 323 }
 324
 325 static __inline int
 326 fo_poll(struct file *fp, int events, struct ucred *active_cred,
 327     struct thread *td)
 328 {
 329
 330         return ((*fp->f_ops->fo_poll)(fp, events, active_cred, td));
 331 }
 332
 333 static __inline int
 334 fo_stat(struct file *fp, struct stat *sb, struct ucred *active_cred,
 335     struct thread *td)
 336 {
 337
 338         return ((*fp->f_ops->fo_stat)(fp, sb, active_cred, td));
 339 }
 340
 341 static __inline int
 342 fo_close(struct file *fp, struct thread *td)
 343 {
 344
 345         return ((*fp->f_ops->fo_close)(fp, td));
 346 }
 347
 348 static __inline int
 349 fo_kqfilter(struct file *fp, struct knote *kn)
 350 {
 351
 352         return ((*fp->f_ops->fo_kqfilter)(fp, kn));
 353 }
 354
 355 static __inline int
 356 fo_chmod(struct file *fp, mode_t mode, struct ucred *active_cred,
 357     struct thread *td)
 358 {
 359
 360         return ((*fp->f_ops->fo_chmod)(fp, mode, active_cred, td));
 361 }
 362
 363 static __inline int
 364 fo_chown(struct file *fp, uid_t uid, gid_t gid, struct ucred *active_cred,
 365     struct thread *td)
 366 {
 367
 368         return ((*fp->f_ops->fo_chown)(fp, uid, gid, active_cred, td));
 369 }
 370
 371 static __inline int
 372 fo_sendfile(struct file *fp, int sockfd, struct uio *hdr_uio,
 373     struct uio *trl_uio, off_t offset, size_t nbytes, off_t *sent, int flags,
 374     int kflags, struct sendfile_sync *sfs, struct thread *td)
 375 {
 376
 377         return ((*fp->f_ops->fo_sendfile)(fp, sockfd, hdr_uio, trl_uio, offset,
 378             nbytes, sent, flags, kflags, sfs, td));
 379 }
 380
 381 static __inline int
 382 fo_seek(struct file *fp, off_t offset, int whence, struct thread *td)
 383 {
 384
 385         return ((*fp->f_ops->fo_seek)(fp, offset, whence, td));
 386 }
 387
 388 static __inline int
 389 fo_fill_kinfo(struct file *fp, struct kinfo_file *kif, struct filedesc *fdp)
 390 {
 391
 392         return ((*fp->f_ops->fo_fill_kinfo)(fp, kif, fdp));
 393 }
 394
 395 #endif /* _KERNEL */
 396
 397 #endif /* !SYS_FILE_H */