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