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