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. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * @(#)file.h 8.3 (Berkeley) 1/9/95
30 * $FreeBSD: src/sys/sys/file.h,v 1.22.2.7 2002/11/21 23:39:24 sam Exp $
37 #include <sys/types.h>
40 #include <sys/fcntl.h>
42 #ifndef _SYS_UNISTD_H_
43 #include <sys/unistd.h>
46 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
49 #include <sys/event.h>
52 #include <sys/queue.h>
54 #ifndef _SYS_SPINLOCK_H_
55 #include <sys/spinlock.h>
57 #ifndef _SYS_NAMECACHE_H_
58 #include <sys/namecache.h>
77 int (*fo_read
) (struct file
*fp
, struct uio
*uio
,
78 struct ucred
*cred
, int flags
);
79 int (*fo_write
) (struct file
*fp
, struct uio
*uio
,
80 struct ucred
*cred
, int flags
);
81 int (*fo_ioctl
) (struct file
*fp
, u_long com
, caddr_t data
,
82 struct ucred
*cred
, struct sysmsg
*msg
);
83 int (*fo_kqfilter
)(struct file
*fp
, struct knote
*kn
);
84 int (*fo_stat
) (struct file
*fp
, struct stat
*sb
,
86 int (*fo_close
) (struct file
*fp
);
87 int (*fo_shutdown
)(struct file
*fp
, int how
);
91 * Kernel descriptor table - One entry for each open kernel vnode and socket.
93 * (A) - (filehead_spin) - descriptor subsystems only (kern/kern_descrip.c)
94 * (U) - (unp_spin) - uipc subsystems only (kern/uipc_usrreq.c)
95 * (ro)- these fields may be read without holding a spinlock as long as you
96 * have (or know) that the reference to the fp is going to stay put.
97 * ? - remaining fields have to be spinlocked
100 LIST_ENTRY(file
) f_list
;/* (A) list of active files */
102 short f_type
; /* (ro) descriptor type */
103 u_int f_flag
; /* see fcntl.h */
104 struct ucred
*f_cred
; /* (ro) creds associated with descriptor */
105 struct fileops
*f_ops
; /* (ro) operations vector */
107 * count of sequential accesses -- cleared
108 * by most seek operations.
111 * offset of next expected read or write
114 void *f_data
; /* vnode, pipe, socket, or kqueue */
115 void *f_data1
; /* devfs per-file data */
116 int f_count
; /* reference count */
117 int f_msgcount
; /* (U) reference count from message queue */
118 struct nchandle f_nchandle
; /* namecache reference */
119 struct spinlock f_spin
; /* NOT USED */
120 struct klist f_klist
;/* knotes attached to fp/kq */
123 #define DTYPE_VNODE 1 /* file */
124 #define DTYPE_SOCKET 2 /* communications endpoint */
125 #define DTYPE_PIPE 3 /* pipe */
126 #define DTYPE_FIFO 4 /* fifo (named pipe) */
127 #define DTYPE_KQUEUE 5 /* event queue */
128 #define DTYPE_CRYPTO 6 /* crypto */
129 #define DTYPE_MQUEUE 7 /* message queue */
131 LIST_HEAD(filelist
, file
);
137 #ifdef MALLOC_DECLARE
138 MALLOC_DECLARE(M_FILE
);
141 extern void fhold(struct file
*fp
);
142 extern int fdrop (struct file
*fp
);
143 extern int checkfdclosed(struct filedesc
*fdp
, int fd
, struct file
*fp
);
144 extern int fp_open(const char *path
, int flags
, int mode
, struct file
**fpp
);
145 extern int fp_vpopen(struct vnode
*vp
, int flags
, struct file
**fpp
);
146 extern int fp_pread(struct file
*fp
, void *buf
, size_t nbytes
, off_t offset
, ssize_t
*res
, enum uio_seg
);
147 extern int fp_pwrite(struct file
*fp
, void *buf
, size_t nbytes
, off_t offset
, ssize_t
*res
, enum uio_seg
);
148 extern int fp_read(struct file
*fp
, void *buf
, size_t nbytes
, ssize_t
*res
, int all
, enum uio_seg
);
149 extern int fp_write(struct file
*fp
, void *buf
, size_t nbytes
, ssize_t
*res
, enum uio_seg
);
150 extern int fp_stat(struct file
*fp
, struct stat
*ub
);
151 extern int fp_mmap(void *addr
, size_t size
, int prot
, int flags
, struct file
*fp
, off_t pos
, void **resp
);
153 extern int nofo_shutdown(struct file
*fp
, int how
);
155 extern int fp_close(struct file
*fp
);
156 extern int fp_shutdown(struct file
*fp
, int how
);
158 extern struct fileops vnode_fileops
;
159 extern struct fileops specvnode_fileops
;
160 extern struct fileops badfileops
;
161 extern int maxfiles
; /* kernel limit on number of open files */
162 extern int maxfilesrootres
; /* descriptors reserved for root use */
163 extern int minfilesperproc
; /* minimum (safety) open files per proc */
164 extern int maxfilesperproc
; /* per process limit on number of open files */
165 extern int maxfilesperuser
; /* per user limit on number of open files */
167 /* Commonly used fileops */
168 int badfo_readwrite(struct file
*fp
, struct uio
*uio
,
169 struct ucred
*cred
, int flags
);
170 int badfo_ioctl(struct file
*fp
, u_long com
, caddr_t data
,
171 struct ucred
*cred
, struct sysmsg
*msg
);
172 int badfo_kqfilter(struct file
*fp
, struct knote
*kn
);
173 int badfo_stat(struct file
*fp
, struct stat
*sb
, struct ucred
*cred
);
174 int badfo_close(struct file
*fp
);
175 int badfo_shutdown(struct file
*fp
, int how
);
179 #endif /* !SYS_FILE_H */