The Design and Implementation of the FreeBSD Operating System, Second Edition
[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/sys/file.h

Version: -  FREEBSD  -  FREEBSD10  -  FREEBSD9  -  FREEBSD92  -  FREEBSD91  -  FREEBSD90  -  FREEBSD8  -  FREEBSD82  -  FREEBSD81  -  FREEBSD80  -  FREEBSD7  -  FREEBSD74  -  FREEBSD73  -  FREEBSD72  -  FREEBSD71  -  FREEBSD70  -  FREEBSD6  -  FREEBSD64  -  FREEBSD63  -  FREEBSD62  -  FREEBSD61  -  FREEBSD60  -  FREEBSD5  -  FREEBSD55  -  FREEBSD54  -  FREEBSD53  -  FREEBSD52  -  FREEBSD51  -  FREEBSD50  -  FREEBSD4  -  FREEBSD3  -  FREEBSD22  -  cheribsd  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1  -  FREEBSD-LIBC  -  FREEBSD8-LIBC  -  FREEBSD7-LIBC  -  FREEBSD6-LIBC  -  GLIBC27 
SearchContext: -  none  -  3  -  10 

    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: stable/9/sys/sys/file.h 245103 2013-01-06 15:07:19Z kib $
   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 #define FOF_OFFSET      0x01    /* Use the offset in uio argument */
   76 #define FOF_NOLOCK      0x02    /* Do not take FOFFSET_LOCK */
   77 #define FOF_NEXTOFF     0x04    /* Also update f_nextoff */
   78 #define FOF_NOUPDATE    0x10    /* Do not update f_offset */
   79 off_t foffset_lock(struct file *fp, int flags);
   80 void foffset_lock_uio(struct file *fp, struct uio *uio, int flags);
   81 void foffset_unlock(struct file *fp, off_t val, int flags);
   82 void foffset_unlock_uio(struct file *fp, struct uio *uio, int flags);
   83 
   84 static inline off_t
   85 foffset_get(struct file *fp)
   86 {
   87 
   88         return (foffset_lock(fp, FOF_NOLOCK));
   89 }
   90 
   91 typedef int fo_rdwr_t(struct file *fp, struct uio *uio,
   92                     struct ucred *active_cred, int flags,
   93                     struct thread *td);
   94 typedef int fo_truncate_t(struct file *fp, off_t length,
   95                     struct ucred *active_cred, struct thread *td);
   96 typedef int fo_ioctl_t(struct file *fp, u_long com, void *data,
   97                     struct ucred *active_cred, struct thread *td);
   98 typedef int fo_poll_t(struct file *fp, int events,
   99                     struct ucred *active_cred, struct thread *td);
  100 typedef int fo_kqfilter_t(struct file *fp, struct knote *kn);
  101 typedef int fo_stat_t(struct file *fp, struct stat *sb,
  102                     struct ucred *active_cred, struct thread *td);
  103 typedef int fo_close_t(struct file *fp, struct thread *td);
  104 typedef int fo_chmod_t(struct file *fp, mode_t mode,
  105                     struct ucred *active_cred, struct thread *td);
  106 typedef int fo_chown_t(struct file *fp, uid_t uid, gid_t gid,
  107                     struct ucred *active_cred, struct thread *td);
  108 typedef int fo_flags_t;
  109 
  110 struct fileops {
  111         fo_rdwr_t       *fo_read;
  112         fo_rdwr_t       *fo_write;
  113         fo_truncate_t   *fo_truncate;
  114         fo_ioctl_t      *fo_ioctl;
  115         fo_poll_t       *fo_poll;
  116         fo_kqfilter_t   *fo_kqfilter;
  117         fo_stat_t       *fo_stat;
  118         fo_close_t      *fo_close;
  119         fo_chmod_t      *fo_chmod;
  120         fo_chown_t      *fo_chown;
  121         fo_flags_t      fo_flags;       /* DFLAG_* below */
  122 };
  123 
  124 #define DFLAG_PASSABLE  0x01    /* may be passed via unix sockets. */
  125 #define DFLAG_SEEKABLE  0x02    /* seekable / nonsequential */
  126 #endif /* _KERNEL */
  127 
  128 #if defined(_KERNEL) || defined(_WANT_FILE)
  129 /*
  130  * Kernel descriptor table.
  131  * One entry for each open kernel vnode and socket.
  132  *
  133  * Below is the list of locks that protects members in struct file.
  134  *
  135  * (f) protected with mtx_lock(mtx_pool_find(fp))
  136  * (d) cdevpriv_mtx
  137  * none not locked
  138  */
  139 
  140 struct fadvise_info {
  141         int             fa_advice;      /* (f) FADV_* type. */
  142         off_t           fa_start;       /* (f) Region start. */
  143         off_t           fa_end;         /* (f) Region end. */
  144         off_t           fa_prevstart;   /* (f) Previous NOREUSE start. */
  145         off_t           fa_prevend;     /* (f) Previous NOREUSE end. */
  146 };
  147 
  148 struct file {
  149         void            *f_data;        /* file descriptor specific data */
  150         struct fileops  *f_ops;         /* File operations */
  151         struct ucred    *f_cred;        /* associated credentials. */
  152         struct vnode    *f_vnode;       /* NULL or applicable vnode */
  153         short           f_type;         /* descriptor type */
  154         short           f_vnread_flags; /* (f) Sleep lock for f_offset */
  155         volatile u_int  f_flag;         /* see fcntl.h */
  156         volatile u_int  f_count;        /* reference count */
  157         /*
  158          *  DTYPE_VNODE specific fields.
  159          */
  160         int             f_seqcount;     /* Count of sequential accesses. */
  161         off_t           f_nextoff;      /* next expected read/write offset. */
  162         union {
  163                 struct cdev_privdata *fvn_cdevpriv;
  164                                         /* (d) Private data for the cdev. */
  165                 struct fadvise_info *fvn_advice;
  166         } f_vnun;
  167         /*
  168          *  DFLAG_SEEKABLE specific fields
  169          */
  170         off_t           f_offset;
  171         /*
  172          * Mandatory Access control information.
  173          */
  174         void            *f_label;       /* Place-holder for MAC label. */
  175 };
  176 
  177 #define f_cdevpriv      f_vnun.fvn_cdevpriv
  178 #define f_advice        f_vnun.fvn_advice
  179 
  180 #define FOFFSET_LOCKED       0x1
  181 #define FOFFSET_LOCK_WAITING 0x2
  182 #define FDEVFS_VNODE         0x4
  183 
  184 #endif /* _KERNEL || _WANT_FILE */
  185 
  186 /*
  187  * Userland version of struct file, for sysctl
  188  */
  189 struct xfile {
  190         size_t  xf_size;        /* size of struct xfile */
  191         pid_t   xf_pid;         /* owning process */
  192         uid_t   xf_uid;         /* effective uid of owning process */
  193         int     xf_fd;          /* descriptor number */
  194         void    *xf_file;       /* address of struct file */
  195         short   xf_type;        /* descriptor type */
  196         int     xf_count;       /* reference count */
  197         int     xf_msgcount;    /* references from message queue */
  198         off_t   xf_offset;      /* file offset */
  199         void    *xf_data;       /* file descriptor specific data */
  200         void    *xf_vnode;      /* vnode pointer */
  201         u_int   xf_flag;        /* flags (see fcntl.h) */
  202 };
  203 
  204 #ifdef _KERNEL
  205 
  206 #ifdef MALLOC_DECLARE
  207 MALLOC_DECLARE(M_FILE);
  208 #endif
  209 
  210 extern struct fileops vnops;
  211 extern struct fileops badfileops;
  212 extern struct fileops socketops;
  213 extern int maxfiles;            /* kernel limit on number of open files */
  214 extern int maxfilesperproc;     /* per process limit on number of open files */
  215 extern volatile int openfiles;  /* actual number of open files */
  216 
  217 int fget(struct thread *td, int fd, cap_rights_t rights, struct file **fpp);
  218 int fget_mmap(struct thread *td, int fd, cap_rights_t rights,
  219     u_char *maxprotp, struct file **fpp);
  220 int fget_read(struct thread *td, int fd, cap_rights_t rights,
  221     struct file **fpp);
  222 int fget_write(struct thread *td, int fd, cap_rights_t rights,
  223     struct file **fpp);
  224 int fgetcap(struct thread *td, int fd, struct file **fpp);
  225 int _fdrop(struct file *fp, struct thread *td);
  226 
  227 /*
  228  * The socket operations are used a couple of places.
  229  * XXX: This is wrong, they should go through the operations vector for
  230  * XXX: sockets instead of going directly for the individual functions. /phk
  231  */
  232 fo_rdwr_t       soo_read;
  233 fo_rdwr_t       soo_write;
  234 fo_truncate_t   soo_truncate;
  235 fo_ioctl_t      soo_ioctl;
  236 fo_poll_t       soo_poll;
  237 fo_kqfilter_t   soo_kqfilter;
  238 fo_stat_t       soo_stat;
  239 fo_close_t      soo_close;
  240 
  241 fo_chmod_t      invfo_chmod;
  242 fo_chown_t      invfo_chown;
  243 
  244 void finit(struct file *, u_int, short, void *, struct fileops *);
  245 int fgetvp(struct thread *td, int fd, cap_rights_t rights, struct vnode **vpp);
  246 int fgetvp_exec(struct thread *td, int fd, cap_rights_t rights,
  247     struct vnode **vpp);
  248 int fgetvp_rights(struct thread *td, int fd, cap_rights_t need,
  249     cap_rights_t *have, struct vnode **vpp);
  250 int fgetvp_read(struct thread *td, int fd, cap_rights_t rights,
  251     struct vnode **vpp);
  252 int fgetvp_write(struct thread *td, int fd, cap_rights_t rights,
  253     struct vnode **vpp);
  254 
  255 int fgetsock(struct thread *td, int fd, cap_rights_t rights,
  256     struct socket **spp, u_int *fflagp);
  257 void fputsock(struct socket *sp);
  258 
  259 static __inline int
  260 _fnoop(void)
  261 {
  262 
  263         return (0);
  264 }
  265 
  266 #define fhold(fp)                                                       \
  267         (refcount_acquire(&(fp)->f_count))
  268 #define fdrop(fp, td)                                                   \
  269         (refcount_release(&(fp)->f_count) ? _fdrop((fp), (td)) : _fnoop())
  270 
  271 static __inline fo_rdwr_t       fo_read;
  272 static __inline fo_rdwr_t       fo_write;
  273 static __inline fo_truncate_t   fo_truncate;
  274 static __inline fo_ioctl_t      fo_ioctl;
  275 static __inline fo_poll_t       fo_poll;
  276 static __inline fo_kqfilter_t   fo_kqfilter;
  277 static __inline fo_stat_t       fo_stat;
  278 static __inline fo_close_t      fo_close;
  279 static __inline fo_chmod_t      fo_chmod;
  280 static __inline fo_chown_t      fo_chown;
  281 
  282 static __inline int
  283 fo_read(struct file *fp, struct uio *uio, struct ucred *active_cred,
  284     int flags, struct thread *td)
  285 {
  286 
  287         return ((*fp->f_ops->fo_read)(fp, uio, active_cred, flags, td));
  288 }
  289 
  290 static __inline int
  291 fo_write(struct file *fp, struct uio *uio, struct ucred *active_cred,
  292     int flags, struct thread *td)
  293 {
  294 
  295         return ((*fp->f_ops->fo_write)(fp, uio, active_cred, flags, td));
  296 }
  297 
  298 static __inline int
  299 fo_truncate(struct file *fp, off_t length, struct ucred *active_cred,
  300     struct thread *td)
  301 {
  302 
  303         return ((*fp->f_ops->fo_truncate)(fp, length, active_cred, td));
  304 }
  305 
  306 static __inline int
  307 fo_ioctl(struct file *fp, u_long com, void *data, struct ucred *active_cred,
  308     struct thread *td)
  309 {
  310 
  311         return ((*fp->f_ops->fo_ioctl)(fp, com, data, active_cred, td));
  312 }
  313 
  314 static __inline int
  315 fo_poll(struct file *fp, int events, struct ucred *active_cred,
  316     struct thread *td)
  317 {
  318 
  319         return ((*fp->f_ops->fo_poll)(fp, events, active_cred, td));
  320 }
  321 
  322 static __inline int
  323 fo_stat(struct file *fp, struct stat *sb, struct ucred *active_cred,
  324     struct thread *td)
  325 {
  326 
  327         return ((*fp->f_ops->fo_stat)(fp, sb, active_cred, td));
  328 }
  329 
  330 static __inline int
  331 fo_close(struct file *fp, struct thread *td)
  332 {
  333 
  334         return ((*fp->f_ops->fo_close)(fp, td));
  335 }
  336 
  337 static __inline int
  338 fo_kqfilter(struct file *fp, struct knote *kn)
  339 {
  340 
  341         return ((*fp->f_ops->fo_kqfilter)(fp, kn));
  342 }
  343 
  344 static __inline int
  345 fo_chmod(struct file *fp, mode_t mode, struct ucred *active_cred,
  346     struct thread *td)
  347 {
  348 
  349         return ((*fp->f_ops->fo_chmod)(fp, mode, active_cred, td));
  350 }
  351 
  352 static __inline int
  353 fo_chown(struct file *fp, uid_t uid, gid_t gid, struct ucred *active_cred,
  354     struct thread *td)
  355 {
  356 
  357         return ((*fp->f_ops->fo_chown)(fp, uid, gid, active_cred, td));
  358 }
  359 
  360 #endif /* _KERNEL */
  361 
  362 #endif /* !SYS_FILE_H */

Cache object: 98076dc281109b1bdef7269080ce8464


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.