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