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