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  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  *      @(#)file.h      8.3 (Berkeley) 1/9/95
  34  * $FreeBSD: src/sys/sys/file.h,v 1.22.2.7 2002/11/21 23:39:24 sam Exp $
  35  * $DragonFly: src/sys/sys/file.h,v 1.3 2003/06/25 03:56:10 dillon Exp $
  36  */
  37
  38 #ifndef _SYS_FILE_H_
  39 #define _SYS_FILE_H_
  40
  41 #ifndef _KERNEL
  42 #include <sys/fcntl.h>
  43 #include <sys/unistd.h>
  44 #endif
  45
  46 #ifdef _KERNEL
  47 #include <sys/queue.h>
  48
  49 struct stat;
  50 struct proc;
  51 struct thread;
  52 struct uio;
  53 struct knote;
  54
  55 /*
  56  * Kernel descriptor table.
  57  * One entry for each open kernel vnode and socket.
  58  */
  59 struct file {
  60         LIST_ENTRY(file) f_list;/* list of active files */
  61         short   f_FILLER3;      /* (old f_flag) */
  62 #define DTYPE_VNODE     1       /* file */
  63 #define DTYPE_SOCKET    2       /* communications endpoint */
  64 #define DTYPE_PIPE      3       /* pipe */
  65 #define DTYPE_FIFO      4       /* fifo (named pipe) */
  66 #define DTYPE_KQUEUE    5       /* event queue */
  67 #define DTYPE_CRYPTO    6       /* crypto */
  68         short   f_type;         /* descriptor type */
  69         u_int   f_flag;         /* see fcntl.h */
  70         struct  ucred *f_cred;  /* credentials associated with descriptor */
  71         struct  fileops {
  72                 int     (*fo_read)      __P((struct file *fp, struct uio *uio,
  73                                             struct ucred *cred, int flags,
  74                                             struct thread *td));
  75                 int     (*fo_write)     __P((struct file *fp, struct uio *uio,
  76                                             struct ucred *cred, int flags,
  77                                             struct thread *td));
  78 #define FOF_OFFSET      1
  79                 int     (*fo_ioctl)     __P((struct file *fp, u_long com,
  80                                             caddr_t data, struct thread *td));
  81                 int     (*fo_poll)      __P((struct file *fp, int events,
  82                                             struct ucred *cred, struct thread *td));
  83                 int     (*fo_kqfilter)  __P((struct file *fp,
  84                                             struct knote *kn));
  85                 int     (*fo_stat)      __P((struct file *fp, struct stat *sb,
  86                                             struct thread *td));
  87                 int     (*fo_close)     __P((struct file *fp, struct thread *td));
  88         } *f_ops;
  89         int     f_seqcount;     /*
  90                                  * count of sequential accesses -- cleared
  91                                  * by most seek operations.
  92                                  */
  93         off_t   f_nextoff;      /*
  94                                  * offset of next expected read or write
  95                                  */
  96         off_t   f_offset;
  97         caddr_t f_data;         /* vnode or socket */
  98         int     f_count;        /* reference count */
  99         int     f_msgcount;     /* reference count from message queue */
 100 };
 101
 102 #ifdef MALLOC_DECLARE
 103 MALLOC_DECLARE(M_FILE);
 104 #endif
 105
 106 extern int fdrop __P((struct file *fp, struct thread *td));
 107
 108 LIST_HEAD(filelist, file);
 109 extern struct filelist filehead; /* head of list of open files */
 110 extern struct fileops vnops;
 111 extern struct fileops badfileops;
 112 extern int maxfiles;            /* kernel limit on number of open files */
 113 extern int maxfilesperproc;     /* per process limit on number of open files */
 114 extern int nfiles;              /* actual number of open files */
 115
 116 #endif /* _KERNEL */
 117
 118 #endif /* !SYS_FILE_H */