Commit | Line | Data |
---|---|---|
15637ed4 RG |
1 | /* |
2 | * Copyright (c) 1989 The Regents of the University of California. | |
3 | * 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 | * | |
78ed81a3 | 33 | * from: @(#)vnode.h 7.39 (Berkeley) 6/27/91 |
34 | * $Id$ | |
15637ed4 RG |
35 | */ |
36 | ||
37 | #ifndef KERNEL | |
38 | #include <machine/endian.h> | |
39 | #endif | |
40 | ||
41 | /* | |
42 | * The vnode is the focus of all file activity in UNIX. | |
43 | * There is a unique vnode allocated for each active file, | |
44 | * each current directory, each mounted-on file, text file, and the root. | |
45 | */ | |
46 | ||
47 | /* | |
48 | * vnode types. VNON means no type. | |
49 | */ | |
50 | enum vtype { VNON, VREG, VDIR, VBLK, VCHR, VLNK, VSOCK, VFIFO, VBAD }; | |
51 | ||
52 | /* | |
53 | * Vnode tag types. | |
54 | * These are for the benefit of external programs only (e.g., pstat) | |
55 | * and should NEVER be inspected inside the kernel. | |
56 | */ | |
78ed81a3 | 57 | enum vtagtype { VT_NON, VT_UFS, VT_NFS, VT_MFS, VT_PCFS, VT_ISOFS }; |
15637ed4 RG |
58 | |
59 | /* | |
60 | * This defines the maximum size of the private data area | |
61 | * permitted for any file system type. A defined constant | |
62 | * is used rather than a union structure to cut down on the | |
63 | * number of header files that must be included. | |
64 | */ | |
65 | #define VN_MAXPRIVATE 188 | |
66 | ||
67 | struct vnode { | |
68 | u_long v_flag; /* vnode flags (see below) */ | |
69 | short v_usecount; /* reference count of users */ | |
70 | short v_writecount; /* reference count of writers */ | |
71 | long v_holdcnt; /* page & buffer references */ | |
72 | off_t v_lastr; /* last read (read-ahead) */ | |
73 | u_long v_id; /* capability identifier */ | |
74 | struct mount *v_mount; /* ptr to vfs we are in */ | |
75 | struct vnodeops *v_op; /* vnode operations */ | |
76 | struct vnode *v_freef; /* vnode freelist forward */ | |
77 | struct vnode **v_freeb; /* vnode freelist back */ | |
78 | struct vnode *v_mountf; /* vnode mountlist forward */ | |
79 | struct vnode **v_mountb; /* vnode mountlist back */ | |
80 | struct buf *v_cleanblkhd; /* clean blocklist head */ | |
81 | struct buf *v_dirtyblkhd; /* dirty blocklist head */ | |
82 | long v_numoutput; /* num of writes in progress */ | |
83 | enum vtype v_type; /* vnode type */ | |
84 | union { | |
85 | struct mount *vu_mountedhere;/* ptr to mounted vfs (VDIR) */ | |
86 | struct socket *vu_socket; /* unix ipc (VSOCK) */ | |
87 | caddr_t vu_vmdata; /* private data for vm (VREG) */ | |
88 | struct specinfo *vu_specinfo; /* device (VCHR, VBLK) */ | |
89 | struct fifoinfo *vu_fifoinfo; /* fifo (VFIFO) */ | |
90 | } v_un; | |
91 | enum vtagtype v_tag; /* type of underlying data */ | |
92 | char v_data[VN_MAXPRIVATE]; /* private data for fs */ | |
93 | }; | |
94 | #define v_mountedhere v_un.vu_mountedhere | |
95 | #define v_socket v_un.vu_socket | |
96 | #define v_vmdata v_un.vu_vmdata | |
97 | #define v_specinfo v_un.vu_specinfo | |
98 | #define v_fifoinfo v_un.vu_fifoinfo | |
99 | ||
100 | /* | |
101 | * vnode flags. | |
102 | */ | |
103 | #define VROOT 0x0001 /* root of its file system */ | |
104 | #define VTEXT 0x0002 /* vnode is a pure text prototype */ | |
105 | #define VSYSTEM 0x0004 /* vnode being used by kernel */ | |
106 | #define VXLOCK 0x0100 /* vnode is locked to change underlying type */ | |
107 | #define VXWANT 0x0200 /* process is waiting for vnode */ | |
108 | #define VBWAIT 0x0400 /* waiting for output to complete */ | |
109 | #define VALIASED 0x0800 /* vnode has an alias */ | |
110 | ||
111 | /* | |
112 | * Vnode attributes. A field value of VNOVAL | |
113 | * represents a field whose value is unavailable | |
114 | * (getattr) or which is not to be changed (setattr). | |
115 | */ | |
116 | struct vattr { | |
117 | enum vtype va_type; /* vnode type (for create) */ | |
118 | u_short va_mode; /* files access mode and type */ | |
119 | short va_nlink; /* number of references to file */ | |
120 | uid_t va_uid; /* owner user id */ | |
121 | gid_t va_gid; /* owner group id */ | |
122 | long va_fsid; /* file system id (dev for now) */ | |
123 | long va_fileid; /* file id */ | |
124 | u_quad va_qsize; /* file size in bytes */ | |
125 | long va_blocksize; /* blocksize preferred for i/o */ | |
126 | struct timeval va_atime; /* time of last access */ | |
127 | struct timeval va_mtime; /* time of last modification */ | |
128 | struct timeval va_ctime; /* time file changed */ | |
129 | u_long va_gen; /* generation number of file */ | |
130 | u_long va_flags; /* flags defined for file */ | |
131 | dev_t va_rdev; /* device the special file represents */ | |
132 | u_quad va_qbytes; /* bytes of disk space held by file */ | |
133 | }; | |
134 | #if BYTE_ORDER == LITTLE_ENDIAN | |
135 | #define va_size va_qsize.val[0] | |
136 | #define va_size_rsv va_qsize.val[1] | |
137 | #define va_bytes va_qbytes.val[0] | |
138 | #define va_bytes_rsv va_qbytes.val[1] | |
139 | #else | |
140 | #define va_size va_qsize.val[1] | |
141 | #define va_size_rsv va_qsize.val[0] | |
142 | #define va_bytes va_qbytes.val[1] | |
143 | #define va_bytes_rsv va_qbytes.val[0] | |
144 | #endif | |
145 | ||
146 | /* | |
147 | * Operations on vnodes. | |
148 | */ | |
149 | #ifdef __STDC__ | |
150 | struct flock; | |
151 | struct nameidata; | |
152 | #endif | |
153 | ||
154 | struct vnodeops { | |
155 | int (*vop_lookup) __P((struct vnode *vp, struct nameidata *ndp, | |
156 | struct proc *p)); | |
157 | int (*vop_create) __P((struct nameidata *ndp, struct vattr *vap, | |
158 | struct proc *p)); | |
159 | int (*vop_mknod) __P((struct nameidata *ndp, struct vattr *vap, | |
160 | struct ucred *cred, struct proc *p)); | |
161 | int (*vop_open) __P((struct vnode *vp, int mode, | |
162 | struct ucred *cred, struct proc *p)); | |
163 | int (*vop_close) __P((struct vnode *vp, int fflag, | |
164 | struct ucred *cred, struct proc *p)); | |
165 | int (*vop_access) __P((struct vnode *vp, int mode, | |
166 | struct ucred *cred, struct proc *p)); | |
167 | int (*vop_getattr) __P((struct vnode *vp, struct vattr *vap, | |
168 | struct ucred *cred, struct proc *p)); | |
169 | int (*vop_setattr) __P((struct vnode *vp, struct vattr *vap, | |
170 | struct ucred *cred, struct proc *p)); | |
171 | int (*vop_read) __P((struct vnode *vp, struct uio *uio, | |
172 | int ioflag, struct ucred *cred)); | |
173 | int (*vop_write) __P((struct vnode *vp, struct uio *uio, | |
174 | int ioflag, struct ucred *cred)); | |
175 | int (*vop_ioctl) __P((struct vnode *vp, int command, | |
176 | caddr_t data, int fflag, | |
177 | struct ucred *cred, struct proc *p)); | |
178 | int (*vop_select) __P((struct vnode *vp, int which, int fflags, | |
179 | struct ucred *cred, struct proc *p)); | |
180 | int (*vop_mmap) __P((struct vnode *vp, int fflags, | |
181 | struct ucred *cred, struct proc *p)); | |
182 | int (*vop_fsync) __P((struct vnode *vp, int fflags, | |
183 | struct ucred *cred, int waitfor, | |
184 | struct proc *p)); | |
185 | int (*vop_seek) __P((struct vnode *vp, off_t oldoff, | |
186 | off_t newoff, struct ucred *cred)); | |
187 | int (*vop_remove) __P((struct nameidata *ndp, struct proc *p)); | |
188 | int (*vop_link) __P((struct vnode *vp, struct nameidata *ndp, | |
189 | struct proc *p)); | |
190 | int (*vop_rename) __P((struct nameidata *fndp, | |
191 | struct nameidata *tdnp, struct proc *p)); | |
192 | int (*vop_mkdir) __P((struct nameidata *ndp, struct vattr *vap, | |
193 | struct proc *p)); | |
194 | int (*vop_rmdir) __P((struct nameidata *ndp, struct proc *p)); | |
195 | int (*vop_symlink) __P((struct nameidata *ndp, struct vattr *vap, | |
196 | char *target, struct proc *p)); | |
197 | int (*vop_readdir) __P((struct vnode *vp, struct uio *uio, | |
198 | struct ucred *cred, int *eofflagp)); | |
199 | int (*vop_readlink) __P((struct vnode *vp, struct uio *uio, | |
200 | struct ucred *cred)); | |
201 | int (*vop_abortop) __P((struct nameidata *ndp)); | |
202 | int (*vop_inactive) __P((struct vnode *vp, struct proc *p)); | |
203 | int (*vop_reclaim) __P((struct vnode *vp)); | |
204 | int (*vop_lock) __P((struct vnode *vp)); | |
205 | int (*vop_unlock) __P((struct vnode *vp)); | |
206 | int (*vop_bmap) __P((struct vnode *vp, daddr_t bn, | |
207 | struct vnode **vpp, daddr_t *bnp)); | |
208 | int (*vop_strategy) __P((struct buf *bp)); | |
209 | int (*vop_print) __P((struct vnode *vp)); | |
210 | int (*vop_islocked) __P((struct vnode *vp)); | |
211 | int (*vop_advlock) __P((struct vnode *vp, caddr_t id, int op, | |
212 | struct flock *fl, int flags)); | |
213 | }; | |
214 | ||
215 | /* Macros to call the vnode ops */ | |
216 | #define VOP_LOOKUP(v,n,p) (*((v)->v_op->vop_lookup))(v,n,p) | |
217 | #define VOP_CREATE(n,a,p) (*((n)->ni_dvp->v_op->vop_create))(n,a,p) | |
218 | #define VOP_MKNOD(n,a,c,p) (*((n)->ni_dvp->v_op->vop_mknod))(n,a,c,p) | |
219 | #define VOP_OPEN(v,f,c,p) (*((v)->v_op->vop_open))(v,f,c,p) | |
220 | #define VOP_CLOSE(v,f,c,p) (*((v)->v_op->vop_close))(v,f,c,p) | |
221 | #define VOP_ACCESS(v,f,c,p) (*((v)->v_op->vop_access))(v,f,c,p) | |
222 | #define VOP_GETATTR(v,a,c,p) (*((v)->v_op->vop_getattr))(v,a,c,p) | |
223 | #define VOP_SETATTR(v,a,c,p) (*((v)->v_op->vop_setattr))(v,a,c,p) | |
224 | #define VOP_READ(v,u,i,c) (*((v)->v_op->vop_read))(v,u,i,c) | |
225 | #define VOP_WRITE(v,u,i,c) (*((v)->v_op->vop_write))(v,u,i,c) | |
226 | #define VOP_IOCTL(v,o,d,f,c,p) (*((v)->v_op->vop_ioctl))(v,o,d,f,c,p) | |
227 | #define VOP_SELECT(v,w,f,c,p) (*((v)->v_op->vop_select))(v,w,f,c,p) | |
228 | #define VOP_MMAP(v,c,p) (*((v)->v_op->vop_mmap))(v,c,p) | |
229 | #define VOP_FSYNC(v,f,c,w,p) (*((v)->v_op->vop_fsync))(v,f,c,w,p) | |
230 | #define VOP_SEEK(v,p,o,w) (*((v)->v_op->vop_seek))(v,p,o,w) | |
231 | #define VOP_REMOVE(n,p) (*((n)->ni_dvp->v_op->vop_remove))(n,p) | |
232 | #define VOP_LINK(v,n,p) (*((n)->ni_dvp->v_op->vop_link))(v,n,p) | |
233 | #define VOP_RENAME(s,t,p) (*((s)->ni_dvp->v_op->vop_rename))(s,t,p) | |
234 | #define VOP_MKDIR(n,a,p) (*((n)->ni_dvp->v_op->vop_mkdir))(n,a,p) | |
235 | #define VOP_RMDIR(n,p) (*((n)->ni_dvp->v_op->vop_rmdir))(n,p) | |
236 | #define VOP_SYMLINK(n,a,m,p) (*((n)->ni_dvp->v_op->vop_symlink))(n,a,m,p) | |
237 | #define VOP_READDIR(v,u,c,e) (*((v)->v_op->vop_readdir))(v,u,c,e) | |
238 | #define VOP_READLINK(v,u,c) (*((v)->v_op->vop_readlink))(v,u,c) | |
239 | #define VOP_ABORTOP(n) (*((n)->ni_dvp->v_op->vop_abortop))(n) | |
240 | #define VOP_INACTIVE(v,p) (*((v)->v_op->vop_inactive))(v,p) | |
241 | #define VOP_RECLAIM(v) (*((v)->v_op->vop_reclaim))(v) | |
242 | #define VOP_LOCK(v) (*((v)->v_op->vop_lock))(v) | |
243 | #define VOP_UNLOCK(v) (*((v)->v_op->vop_unlock))(v) | |
244 | #define VOP_BMAP(v,s,p,n) (*((v)->v_op->vop_bmap))(v,s,p,n) | |
245 | #define VOP_STRATEGY(b) (*((b)->b_vp->v_op->vop_strategy))(b) | |
246 | #define VOP_PRINT(v) (*((v)->v_op->vop_print))(v) | |
247 | #define VOP_ISLOCKED(v) (((v)->v_flag & VXLOCK) || \ | |
248 | (*((v)->v_op->vop_islocked))(v)) | |
249 | #define VOP_ADVLOCK(v,p,o,l,f) (*((v)->v_op->vop_advlock))(v,p,o,l,f) | |
250 | ||
251 | /* | |
252 | * flags for ioflag | |
253 | */ | |
254 | #define IO_UNIT 0x01 /* do I/O as atomic unit */ | |
255 | #define IO_APPEND 0x02 /* append write to end */ | |
256 | #define IO_SYNC 0x04 /* do I/O synchronously */ | |
257 | #define IO_NODELOCKED 0x08 /* underlying node already locked */ | |
258 | #define IO_NDELAY 0x10 /* FNDELAY flag set in file table */ | |
259 | ||
260 | /* | |
261 | * Modes. Some values same as Ixxx entries from inode.h for now | |
262 | */ | |
263 | #define VSUID 04000 /* set user id on execution */ | |
264 | #define VSGID 02000 /* set group id on execution */ | |
265 | #define VSVTX 01000 /* save swapped text even after use */ | |
266 | #define VREAD 0400 /* read, write, execute permissions */ | |
267 | #define VWRITE 0200 | |
268 | #define VEXEC 0100 | |
269 | ||
270 | /* | |
271 | * Token indicating no attribute value yet assigned | |
272 | */ | |
273 | #define VNOVAL ((unsigned)0xffffffff) | |
274 | ||
275 | #ifdef KERNEL | |
276 | /* | |
277 | * public vnode manipulation functions | |
278 | */ | |
279 | int vn_open __P((struct nameidata *ndp, struct proc *p, int fmode, | |
280 | int cmode)); | |
281 | int vn_close __P((struct vnode *vp, int flags, struct ucred *cred, | |
282 | struct proc *p)); | |
283 | int vn_rdwr __P((enum uio_rw rw, struct vnode *vp, caddr_t base, | |
284 | int len, off_t offset, enum uio_seg segflg, int ioflg, | |
285 | struct ucred *cred, int *aresid, struct proc *p)); | |
286 | int vn_read __P((struct file *fp, struct uio *uio, struct ucred *cred)); | |
287 | int vn_write __P((struct file *fp, struct uio *uio, struct ucred *cred)); | |
288 | int vn_ioctl __P((struct file *fp, int com, caddr_t data, struct proc *p)); | |
289 | int vn_select __P((struct file *fp, int which, struct proc *p)); | |
290 | int vn_closefile __P((struct file *fp, struct proc *p)); | |
291 | int getnewvnode __P((enum vtagtype tag, struct mount *mp, | |
292 | struct vnodeops *vops, struct vnode **vpp)); | |
293 | int bdevvp __P((int dev, struct vnode **vpp)); | |
294 | /* check for special device aliases */ | |
295 | /* XXX nvp_rdev should be type dev_t, not int */ | |
296 | struct vnode *checkalias __P((struct vnode *vp, int nvp_rdev, | |
297 | struct mount *mp)); | |
298 | void vattr_null __P((struct vattr *vap)); | |
299 | int vcount __P((struct vnode *vp)); /* total references to a device */ | |
300 | int vget __P((struct vnode *vp)); /* get first reference to a vnode */ | |
301 | void vref __P((struct vnode *vp)); /* increase reference to a vnode */ | |
302 | void vput __P((struct vnode *vp)); /* unlock and release vnode */ | |
303 | void vrele __P((struct vnode *vp)); /* release vnode */ | |
304 | void vgone __P((struct vnode *vp)); /* completely recycle vnode */ | |
305 | void vgoneall __P((struct vnode *vp));/* recycle vnode and all its aliases */ | |
306 | ||
307 | /* | |
308 | * Flags to various vnode functions. | |
309 | */ | |
310 | #define SKIPSYSTEM 0x0001 /* vflush: skip vnodes marked VSYSTEM */ | |
311 | #define FORCECLOSE 0x0002 /* vflush: force file closeure */ | |
312 | #define DOCLOSE 0x0004 /* vclean: close active files */ | |
313 | ||
314 | #ifndef DIAGNOSTIC | |
315 | #define VREF(vp) (vp)->v_usecount++ /* increase reference */ | |
316 | #define VHOLD(vp) (vp)->v_holdcnt++ /* increase buf or page ref */ | |
317 | #define HOLDRELE(vp) (vp)->v_holdcnt-- /* decrease buf or page ref */ | |
318 | #define VATTR_NULL(vap) (*(vap) = va_null) /* initialize a vattr */ | |
319 | #else /* DIAGNOSTIC */ | |
320 | #define VREF(vp) vref(vp) | |
321 | #define VHOLD(vp) vhold(vp) | |
322 | #define HOLDRELE(vp) holdrele(vp) | |
323 | #define VATTR_NULL(vap) vattr_null(vap) | |
324 | #endif | |
325 | ||
326 | #define NULLVP ((struct vnode *)NULL) | |
327 | ||
328 | /* | |
329 | * Global vnode data. | |
330 | */ | |
331 | extern struct vnode *rootdir; /* root (i.e. "/") vnode */ | |
332 | extern long desiredvnodes; /* number of vnodes desired */ | |
333 | extern struct vattr va_null; /* predefined null vattr structure */ | |
334 | #endif |