xref: /dragonfly/sys/sys/file.h (revision 16777b6b)
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.5 2003/08/27 02:03:22 dillon 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 lwkt_port;
58 
59 struct	fileops {
60 	struct lwkt_port *fo_port;
61 	u_int	fo_autoq;
62 
63 	int	(*fold_read)	(struct file *fp, struct uio *uio,
64 				    struct ucred *cred, int flags,
65 				    struct thread *td);
66 	int	(*fold_write)	(struct file *fp, struct uio *uio,
67 				    struct ucred *cred, int flags,
68 				    struct thread *td);
69 	int	(*fold_ioctl)	(struct file *fp, u_long com,
70 				    caddr_t data, struct thread *td);
71 	int	(*fold_poll)	(struct file *fp, int events,
72 				    struct ucred *cred, struct thread *td);
73 	int	(*fold_kqfilter)	(struct file *fp,
74 				    struct knote *kn);
75 	int	(*fold_stat)	(struct file *fp, struct stat *sb,
76 				    struct thread *td);
77 	int	(*fold_close)	(struct file *fp, struct thread *td);
78 };
79 
80 #define	FOF_OFFSET	1	/* fo_read(), fo_write() flags */
81 
82 /*
83  * Kernel descriptor table.
84  * One entry for each open kernel vnode and socket.
85  */
86 struct file {
87 	LIST_ENTRY(file) f_list;/* list of active files */
88 	short	f_FILLER3;	/* (old f_flag) */
89 #define	DTYPE_VNODE	1	/* file */
90 #define	DTYPE_SOCKET	2	/* communications endpoint */
91 #define	DTYPE_PIPE	3	/* pipe */
92 #define	DTYPE_FIFO	4	/* fifo (named pipe) */
93 #define	DTYPE_KQUEUE	5	/* event queue */
94 #define DTYPE_CRYPTO	6	/* crypto */
95 	short	f_type;		/* descriptor type */
96 	u_int	f_flag;		/* see fcntl.h */
97 	struct	ucred *f_cred;	/* credentials associated with descriptor */
98 	struct  fileops *f_ops;
99 	int	f_seqcount;	/*
100 				 * count of sequential accesses -- cleared
101 				 * by most seek operations.
102 				 */
103 	off_t	f_nextoff;	/*
104 				 * offset of next expected read or write
105 				 */
106 	off_t	f_offset;
107 	caddr_t	f_data;		/* vnode or socket */
108 	int	f_count;	/* reference count */
109 	int	f_msgcount;	/* reference count from message queue */
110 };
111 
112 LIST_HEAD(filelist, file);
113 
114 #endif
115 
116 #ifdef _KERNEL
117 
118 #ifdef MALLOC_DECLARE
119 MALLOC_DECLARE(M_FILE);
120 #endif
121 
122 extern int fdrop (struct file *fp, struct thread *td);
123 
124 extern struct filelist filehead; /* head of list of open files */
125 extern struct fileops vnops;
126 extern struct fileops badfileops;
127 extern int maxfiles;		/* kernel limit on number of open files */
128 extern int maxfilesperproc;	/* per process limit on number of open files */
129 extern int nfiles;		/* actual number of open files */
130 
131 #endif /* _KERNEL */
132 
133 #endif /* !SYS_FILE_H */
134