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