2 * Copyright (c) 1982, 1986, 1989, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
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 $
41 #include <sys/types.h>
44 #include <sys/fcntl.h>
46 #ifndef _SYS_UNISTD_H_
47 #include <sys/unistd.h>
50 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
53 #include <sys/event.h>
56 #include <sys/queue.h>
58 #ifndef _SYS_SPINLOCK_H_
59 #include <sys/spinlock.h>
61 #ifndef _SYS_NAMECACHE_H_
62 #include <sys/namecache.h>
81 int (*fo_read) (struct file *fp, struct uio *uio,
82 struct ucred *cred, int flags);
83 int (*fo_write) (struct file *fp, struct uio *uio,
84 struct ucred *cred, int flags);
85 int (*fo_ioctl) (struct file *fp, u_long com, caddr_t data,
86 struct ucred *cred, struct sysmsg *msg);
87 int (*fo_kqfilter)(struct file *fp, struct knote *kn);
88 int (*fo_stat) (struct file *fp, struct stat *sb,
90 int (*fo_close) (struct file *fp);
91 int (*fo_shutdown)(struct file *fp, int how);
95 * Kernel descriptor table - One entry for each open kernel vnode and socket.
97 * (A) - (filehead_spin) - descriptor subsystems only (kern/kern_descrip.c)
98 * (U) - (unp_spin) - uipc subsystems only (kern/uipc_usrreq.c)
99 * (ro)- these fields may be read without holding a spinlock as long as you
100 * have (or know) that the reference to the fp is going to stay put.
101 * ? - remaining fields have to be spinlocked
104 LIST_ENTRY(file) f_list;/* (A) list of active files */
106 short f_type; /* (ro) descriptor type */
107 u_int f_flag; /* see fcntl.h */
108 struct ucred *f_cred; /* (ro) creds associated with descriptor */
109 struct fileops *f_ops; /* (ro) operations vector */
111 * count of sequential accesses -- cleared
112 * by most seek operations.
115 * offset of next expected read or write
118 void *f_data; /* vnode, pipe, socket, or kqueue */
119 void *f_data1; /* devfs per-file data */
120 int f_count; /* reference count */
121 int f_msgcount; /* (U) reference count from message queue */
122 struct nchandle f_nchandle; /* namecache reference */
123 struct spinlock f_spin; /* NOT USED */
124 struct klist f_klist;/* knotes attached to fp/kq */
127 #define DTYPE_VNODE 1 /* file */
128 #define DTYPE_SOCKET 2 /* communications endpoint */
129 #define DTYPE_PIPE 3 /* pipe */
130 #define DTYPE_FIFO 4 /* fifo (named pipe) */
131 #define DTYPE_KQUEUE 5 /* event queue */
132 #define DTYPE_CRYPTO 6 /* crypto */
133 #define DTYPE_MQUEUE 7 /* message queue */
135 LIST_HEAD(filelist, file);
141 #ifdef MALLOC_DECLARE
142 MALLOC_DECLARE(M_FILE);
145 extern void fhold(struct file *fp);
146 extern int fdrop (struct file *fp);
147 extern int checkfdclosed(struct filedesc *fdp, int fd, struct file *fp);
148 extern int fp_open(const char *path, int flags, int mode, struct file **fpp);
149 extern int fp_vpopen(struct vnode *vp, int flags, struct file **fpp);
150 extern int fp_pread(struct file *fp, void *buf, size_t nbytes, off_t offset, ssize_t *res, enum uio_seg);
151 extern int fp_pwrite(struct file *fp, void *buf, size_t nbytes, off_t offset, ssize_t *res, enum uio_seg);
152 extern int fp_read(struct file *fp, void *buf, size_t nbytes, ssize_t *res, int all, enum uio_seg);
153 extern int fp_write(struct file *fp, void *buf, size_t nbytes, ssize_t *res, enum uio_seg);
154 extern int fp_stat(struct file *fp, struct stat *ub);
155 extern int fp_mmap(void *addr, size_t size, int prot, int flags, struct file *fp, off_t pos, void **resp);
157 extern int nofo_shutdown(struct file *fp, int how);
159 extern int fp_close(struct file *fp);
160 extern int fp_shutdown(struct file *fp, int how);
162 extern struct fileops vnode_fileops;
163 extern struct fileops specvnode_fileops;
164 extern struct fileops badfileops;
165 extern int maxfiles; /* kernel limit on number of open files */
166 extern int maxfilesrootres; /* descriptors reserved for root use */
167 extern int minfilesperproc; /* minimum (safety) open files per proc */
168 extern int maxfilesperproc; /* per process limit on number of open files */
169 extern int maxfilesperuser; /* per user limit on number of open files */
171 /* Commonly used fileops */
172 int badfo_readwrite(struct file *fp, struct uio *uio,
173 struct ucred *cred, int flags);
174 int badfo_ioctl(struct file *fp, u_long com, caddr_t data,
175 struct ucred *cred, struct sysmsg *msg);
176 int badfo_kqfilter(struct file *fp, struct knote *kn);
177 int badfo_stat(struct file *fp, struct stat *sb, struct ucred *cred);
178 int badfo_close(struct file *fp);
179 int badfo_shutdown(struct file *fp, int how);
183 #endif /* !SYS_FILE_H */