Change sendfile() to use the new m_ext callback scheme for cleaning up after
[dragonfly.git] / sys / sys / file.h
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.10 2004/05/13 23:49:25 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 vnode;
58 struct lwkt_port;
59
60 struct  fileops {
61         struct lwkt_port *fo_port;
62         int     (*fo_clone)(struct file *);     /* additional work after dup */
63
64         int     (*fold_read)    (struct file *fp, struct uio *uio,
65                                     struct ucred *cred, int flags,
66                                     struct thread *td);
67         int     (*fold_write)   (struct file *fp, struct uio *uio,
68                                     struct ucred *cred, int flags,
69                                     struct thread *td);
70         int     (*fold_ioctl)   (struct file *fp, u_long com,
71                                     caddr_t data, struct thread *td);
72         int     (*fold_poll)    (struct file *fp, int events,
73                                     struct ucred *cred, struct thread *td);
74         int     (*fold_kqfilter)        (struct file *fp,
75                                     struct knote *kn);
76         int     (*fold_stat)    (struct file *fp, struct stat *sb,
77                                     struct thread *td);
78         int     (*fold_close)   (struct file *fp, struct thread *td);
79 };
80
81 #define FOF_OFFSET      1       /* fo_read(), fo_write() flags */
82
83 /*
84  * Kernel descriptor table.
85  * One entry for each open kernel vnode and socket.
86  */
87 struct file {
88         LIST_ENTRY(file) f_list;/* list of active files */
89         short   f_FILLER3;      /* (old f_flag) */
90 #define DTYPE_VNODE     1       /* file */
91 #define DTYPE_SOCKET    2       /* communications endpoint */
92 #define DTYPE_PIPE      3       /* pipe */
93 #define DTYPE_FIFO      4       /* fifo (named pipe) */
94 #define DTYPE_KQUEUE    5       /* event queue */
95 #define DTYPE_CRYPTO    6       /* crypto */
96         short   f_type;         /* descriptor type */
97         u_int   f_flag;         /* see fcntl.h */
98         struct  ucred *f_cred;  /* credentials associated with descriptor */
99         struct  fileops *f_ops;
100         int     f_seqcount;     /*
101                                  * count of sequential accesses -- cleared
102                                  * by most seek operations.
103                                  */
104         off_t   f_nextoff;      /*
105                                  * offset of next expected read or write
106                                  */
107         off_t   f_offset;
108         caddr_t f_data;         /* vnode or socket */
109         int     f_count;        /* reference count */
110         int     f_msgcount;     /* reference count from message queue */
111 };
112
113 LIST_HEAD(filelist, file);
114
115 #endif
116
117 #ifdef _KERNEL
118
119 #ifdef MALLOC_DECLARE
120 MALLOC_DECLARE(M_FILE);
121 #endif
122
123 extern int fdrop (struct file *fp, struct thread *td);
124
125 extern int fp_open(const char *path, int flags, int mode, struct file **fpp);
126 extern int fp_vpopen(struct vnode *vp, int flags, struct file **fpp);
127 extern int fp_pread(struct file *fp, void *buf, size_t nbytes, off_t offset, ssize_t *res);
128 extern int fp_pwrite(struct file *fp, void *buf, size_t nbytes, off_t offset, ssize_t *res);
129 extern int fp_read(struct file *fp, void *buf, size_t nbytes, ssize_t *res);
130 extern int fp_write(struct file *fp, void *buf, size_t nbytes, ssize_t *res);
131 extern int fp_stat(struct file *fp, struct stat *ub);
132 extern int fp_mmap(void *addr, size_t size, int prot, int flags, struct file *fp, off_t pos, void **resp);
133
134 extern int fp_close(struct file *fp);
135
136 extern struct filelist filehead; /* head of list of open files */
137 extern struct fileops vnops;
138 extern struct fileops badfileops;
139 extern int maxfiles;            /* kernel limit on number of open files */
140 extern int maxfilesrootres;     /* descriptors reserved for root use */
141 extern int maxfilesperproc;     /* per process limit on number of open files */
142 extern int nfiles;              /* actual number of open files */
143
144 #endif /* _KERNEL */
145
146 #endif /* !SYS_FILE_H */