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