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.18 2006/05/20 02:42:13 dillon Exp $
  36  */
  37
  38 #ifndef _SYS_FILE_H_
  39 #define _SYS_FILE_H_
  40
  41 #ifndef _SYS_TYPES_H_
  42 #include <sys/types.h>
  43 #endif
  44 #ifndef _SYS_FCNTL_H_
  45 #include <sys/fcntl.h>
  46 #endif
  47 #ifndef _SYS_UNISTD_H_
  48 #include <sys/unistd.h>
  49 #endif
  50
  51 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
  52
  53 #ifndef _SYS_QUEUE_H_
  54 #include <sys/queue.h>
  55 #endif
  56
  57 struct stat;
  58 struct proc;
  59 struct thread;
  60 struct uio;
  61 struct knote;
  62 struct file;
  63 struct ucred;
  64 struct vnode;
  65 struct lwkt_port;
  66 struct namecache;
  67
  68 struct  fileops {
  69         struct lwkt_port *fo_port;
  70         int (*fo_clone)         (struct file *);/* additional work after dup */
  71
  72         int (*fold_read)        (struct file *fp, struct uio *uio,
  73                                  struct ucred *cred, int flags);
  74         int (*fold_write)       (struct file *fp, struct uio *uio,
  75                                  struct ucred *cred, int flags);
  76         int (*fold_ioctl)       (struct file *fp, u_long com, caddr_t data,
  77                                  struct ucred *cred);
  78         int (*fold_poll)        (struct file *fp, int events,
  79                                  struct ucred *cred);
  80         int (*fold_kqfilter)    (struct file *fp, struct knote *kn);
  81         int (*fold_stat)        (struct file *fp, struct stat *sb,
  82                                  struct ucred *cred);
  83         int (*fold_close)       (struct file *fp);
  84         int (*fold_shutdown)    (struct file *fp, int how);
  85 };
  86
  87 #define FOF_OFFSET      1       /* fo_read(), fo_write() flags */
  88
  89 /*
  90  * Kernel descriptor table.
  91  * One entry for each open kernel vnode and socket.
  92  */
  93 struct file {
  94         LIST_ENTRY(file) f_list;/* list of active files */
  95         short   f_FILLER3;      /* (old f_flag) */
  96 #define DTYPE_VNODE     1       /* file */
  97 #define DTYPE_SOCKET    2       /* communications endpoint */
  98 #define DTYPE_PIPE      3       /* pipe */
  99 #define DTYPE_FIFO      4       /* fifo (named pipe) */
 100 #define DTYPE_KQUEUE    5       /* event queue */
 101 #define DTYPE_CRYPTO    6       /* crypto */
 102         short   f_type;         /* descriptor type */
 103         u_int   f_flag;         /* see fcntl.h */
 104         struct  ucred *f_cred;  /* credentials associated with descriptor */
 105         struct  fileops *f_ops;
 106         int     f_seqcount;     /*
 107                                  * count of sequential accesses -- cleared
 108                                  * by most seek operations.
 109                                  */
 110         off_t   f_nextoff;      /*
 111                                  * offset of next expected read or write
 112                                  */
 113         off_t   f_offset;
 114         void   *f_data;         /* vnode, pipe, socket, or kqueue */
 115         int     f_count;        /* reference count */
 116         int     f_msgcount;     /* reference count from message queue */
 117         struct namecache *f_ncp; /* ncp (required for directories) */
 118 };
 119
 120 LIST_HEAD(filelist, file);
 121
 122 #endif
 123
 124 #ifdef _KERNEL
 125
 126 #ifdef MALLOC_DECLARE
 127 MALLOC_DECLARE(M_FILE);
 128 #endif
 129
 130 extern int fdrop (struct file *fp);
 131 extern int fp_open(const char *path, int flags, int mode, struct file **fpp);
 132 extern int fp_vpopen(struct vnode *vp, int flags, struct file **fpp);
 133 extern int fp_pread(struct file *fp, void *buf, size_t nbytes, off_t offset, ssize_t *res);
 134 extern int fp_pwrite(struct file *fp, void *buf, size_t nbytes, off_t offset, ssize_t *res);
 135 extern int fp_read(struct file *fp, void *buf, size_t nbytes, ssize_t *res, int all);
 136 extern int fp_write(struct file *fp, void *buf, size_t nbytes, ssize_t *res);
 137 extern int fp_stat(struct file *fp, struct stat *ub);
 138 extern int fp_mmap(void *addr, size_t size, int prot, int flags, struct file *fp, off_t pos, void **resp);
 139
 140 extern int nofo_shutdown(struct file *fp, int how);
 141
 142 extern int fp_close(struct file *fp);
 143 extern int fp_shutdown(struct file *fp, int how);
 144
 145 extern struct filelist filehead; /* head of list of open files */
 146 extern struct fileops vnode_fileops;
 147 extern struct fileops specvnode_fileops;
 148 extern struct fileops badfileops;
 149 extern int maxfiles;            /* kernel limit on number of open files */
 150 extern int maxfilesrootres;     /* descriptors reserved for root use */
 151 extern int maxfilesperproc;     /* per process limit on number of open files */
 152 extern int nfiles;              /* actual number of open files */
 153
 154 #endif /* _KERNEL */
 155
 156 #endif /* !SYS_FILE_H */