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.23 2006/08/06 18:56:46 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 #ifndef _SYS_SPINLOCK_H_ 57 #include <sys/spinlock.h> 58 #endif 59 60 struct stat; 61 struct proc; 62 struct thread; 63 struct uio; 64 struct knote; 65 struct file; 66 struct ucred; 67 struct vnode; 68 struct lwkt_port; 69 struct namecache; 70 71 struct fileops { 72 int (*fo_read) (struct file *fp, struct uio *uio, 73 struct ucred *cred, int flags); 74 int (*fo_write) (struct file *fp, struct uio *uio, 75 struct ucred *cred, int flags); 76 int (*fo_ioctl) (struct file *fp, u_long com, caddr_t data, 77 struct ucred *cred); 78 int (*fo_poll) (struct file *fp, int events, 79 struct ucred *cred); 80 int (*fo_kqfilter)(struct file *fp, struct knote *kn); 81 int (*fo_stat) (struct file *fp, struct stat *sb, 82 struct ucred *cred); 83 int (*fo_close) (struct file *fp); 84 int (*fo_shutdown)(struct file *fp, int how); 85 }; 86 87 /* 88 * Kernel descriptor table - One entry for each open kernel vnode and socket. 89 * 90 * (A) - (filehead_spin) - descriptor subsystems only (kern/kern_descrip.c) 91 * (U) - (unp_spin) - uipc subsystems only (kern/uipc_usrreq.c) 92 * (ro)- these fields may be read without holding a spinlock as long as you 93 * have (or know) that the reference to the fp is going to stay put. 94 * ? - remaining fields have to be spinlocked 95 */ 96 struct file { 97 LIST_ENTRY(file) f_list;/* (A) list of active files */ 98 short f_FILLER3; 99 short f_type; /* (ro) descriptor type */ 100 u_int f_flag; /* see fcntl.h */ 101 struct ucred *f_cred; /* (ro) creds associated with descriptor */ 102 struct fileops *f_ops; /* (ro) operations vector */ 103 int f_seqcount; /* 104 * count of sequential accesses -- cleared 105 * by most seek operations. 106 */ 107 off_t f_nextoff; /* 108 * offset of next expected read or write 109 */ 110 off_t f_offset; 111 void *f_data; /* vnode, pipe, socket, or kqueue */ 112 int f_count; /* reference count */ 113 int f_msgcount; /* (U) reference count from message queue */ 114 struct namecache *f_ncp; /* ncp (required for directories) */ 115 struct spinlock f_spin; 116 }; 117 118 #define DTYPE_VNODE 1 /* file */ 119 #define DTYPE_SOCKET 2 /* communications endpoint */ 120 #define DTYPE_PIPE 3 /* pipe */ 121 #define DTYPE_FIFO 4 /* fifo (named pipe) */ 122 #define DTYPE_KQUEUE 5 /* event queue */ 123 #define DTYPE_CRYPTO 6 /* crypto */ 124 #define DTYPE_SYSLINK 7 /* syslink */ 125 126 LIST_HEAD(filelist, file); 127 128 #endif 129 130 #ifdef _KERNEL 131 132 #ifdef MALLOC_DECLARE 133 MALLOC_DECLARE(M_FILE); 134 #endif 135 136 extern void fhold(struct file *fp); 137 extern int fdrop (struct file *fp); 138 extern int fp_open(const char *path, int flags, int mode, struct file **fpp); 139 extern int fp_vpopen(struct vnode *vp, int flags, struct file **fpp); 140 extern int fp_pread(struct file *fp, void *buf, size_t nbytes, off_t offset, ssize_t *res); 141 extern int fp_pwrite(struct file *fp, void *buf, size_t nbytes, off_t offset, ssize_t *res); 142 extern int fp_read(struct file *fp, void *buf, size_t nbytes, ssize_t *res, int all); 143 extern int fp_write(struct file *fp, void *buf, size_t nbytes, ssize_t *res); 144 extern int fp_stat(struct file *fp, struct stat *ub); 145 extern int fp_mmap(void *addr, size_t size, int prot, int flags, struct file *fp, off_t pos, void **resp); 146 147 extern int nofo_shutdown(struct file *fp, int how); 148 149 extern int fp_close(struct file *fp); 150 extern int fp_shutdown(struct file *fp, int how); 151 152 extern struct fileops vnode_fileops; 153 extern struct fileops specvnode_fileops; 154 extern struct fileops badfileops; 155 extern int maxfiles; /* kernel limit on number of open files */ 156 extern int maxfilesrootres; /* descriptors reserved for root use */ 157 extern int maxfilesperproc; /* per process limit on number of open files */ 158 159 #endif /* _KERNEL */ 160 161 #endif /* !SYS_FILE_H */ 162