usr.sbin/fstyp: Add device name to HAMMER2 label for autofs -media mount
[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. 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.
16  *
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
27  * SUCH DAMAGE.
28  *
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 $
31  */
32
33 #ifndef _SYS_FILE_H_
34 #define _SYS_FILE_H_
35
36 #ifndef _SYS_TYPES_H_
37 #include <sys/types.h>
38 #endif
39 #ifndef _SYS_FCNTL_H_
40 #include <sys/fcntl.h>
41 #endif
42 #ifndef _SYS_UNISTD_H_
43 #include <sys/unistd.h>
44 #endif
45
46 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
47
48 #ifndef _SYS_EVENT_H_
49 #include <sys/event.h>
50 #endif
51 #ifndef _SYS_QUEUE_H_
52 #include <sys/queue.h>
53 #endif
54 #ifndef _SYS_SPINLOCK_H_
55 #include <sys/spinlock.h>
56 #endif
57 #ifndef _SYS_NAMECACHE_H_
58 #include <sys/namecache.h>
59 #endif
60 #ifndef _SYS__UIO_H_
61 #include <sys/_uio.h>
62 #endif
63
64 struct stat;
65 struct proc;
66 struct thread;
67 struct uio;
68 struct knote;
69 struct file;
70 struct ucred;
71 struct vnode;
72 struct lwkt_port;
73 struct namecache;
74 struct sysmsg;
75
76 struct  fileops {
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,
85                          struct ucred *cred);
86         int (*fo_close) (struct file *fp);
87         int (*fo_shutdown)(struct file *fp, int how);
88 };
89
90 /*
91  * Kernel descriptor table - One entry for each open kernel vnode and socket.
92  *
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
98  */
99 struct file {
100         LIST_ENTRY(file) f_list;/* (A) list of active files */
101         short   f_FILLER3;
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 */
106         int     f_seqcount;     /*
107                                  * count of sequential accesses -- cleared
108                                  * by most seek operations.
109                                  */
110         off_t   f_nextoff;      /*
111                                  * offset of next expected read or write
112                                  */
113         off_t   f_offset;
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 */
121         void   *private_data;   /* Linux (drm) per-file data */
122 };
123
124 #define DTYPE_VNODE     1       /* file */
125 #define DTYPE_SOCKET    2       /* communications endpoint */
126 #define DTYPE_PIPE      3       /* pipe */
127 #define DTYPE_FIFO      4       /* fifo (named pipe) */
128 #define DTYPE_KQUEUE    5       /* event queue */
129 #define DTYPE_CRYPTO    6       /* crypto */
130 #define DTYPE_MQUEUE    7       /* message queue */
131
132 LIST_HEAD(filelist, file);
133
134 #endif
135
136 #ifdef _KERNEL
137
138 #ifdef MALLOC_DECLARE
139 MALLOC_DECLARE(M_FILE);
140 #endif
141
142 extern void fhold(struct file *fp);
143 extern int fdrop (struct file *fp);
144 extern int checkfdclosed(thread_t td, struct filedesc *fdp, int fd,
145                         struct file *fp, int closedcounter);
146 extern int fp_open(const char *path, int flags, int mode, struct file **fpp);
147 extern int fp_vpopen(struct vnode *vp, int flags, struct file **fpp);
148 extern int fp_pread(struct file *fp, void *buf, size_t nbytes, off_t offset, ssize_t *res, enum uio_seg);
149 extern int fp_pwrite(struct file *fp, void *buf, size_t nbytes, off_t offset, ssize_t *res, enum uio_seg);
150 extern int fp_read(struct file *fp, void *buf, size_t nbytes, ssize_t *res, int all, enum uio_seg);
151 extern int fp_write(struct file *fp, void *buf, size_t nbytes, ssize_t *res, enum uio_seg);
152 extern int fp_stat(struct file *fp, struct stat *ub);
153 extern int fp_mmap(void *addr, size_t size, int prot, int flags, struct file *fp, off_t pos, void **resp);
154
155 extern int nofo_shutdown(struct file *fp, int how);
156
157 extern int fp_close(struct file *fp);
158 extern int fp_shutdown(struct file *fp, int how);
159
160 extern struct fileops vnode_fileops;
161 extern struct fileops specvnode_fileops;
162 extern struct fileops badfileops;
163 extern int maxfiles;            /* kernel limit on number of open files */
164 extern int maxfilesrootres;     /* descriptors reserved for root use */
165 extern int minfilesperproc;     /* minimum (safety) open files per proc */
166 extern int maxfilesperproc;     /* per process limit on number of open files */
167 extern int maxfilesperuser;     /* per user limit on number of open files */
168
169 /* Commonly used fileops */
170 int badfo_readwrite(struct file *fp, struct uio *uio,
171                     struct ucred *cred, int flags);
172 int badfo_ioctl(struct file *fp, u_long com, caddr_t data,
173                 struct ucred *cred, struct sysmsg *msg);
174 int badfo_kqfilter(struct file *fp, struct knote *kn);
175 int badfo_stat(struct file *fp, struct stat *sb, struct ucred *cred);
176 int badfo_close(struct file *fp);
177 int badfo_shutdown(struct file *fp, int how);
178
179 #endif /* _KERNEL */
180
181 #endif /* !SYS_FILE_H */