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

Cache object: d5bec5dfb2761062d9bed66a94da8bed


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