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

Cache object: 4f418595e205c21c6b9b2cb936667235


[ 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.