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