]> git.saurik.com Git - apple/xnu.git/blob - bsd/sys/vnode.h
0ddf130b7b9d37b39e85141a29770ddcd9da5882
[apple/xnu.git] / bsd / sys / vnode.h
1 /*
2 * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
6 * Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
7 *
8 * This file contains Original Code and/or Modifications of Original Code
9 * as defined in and that are subject to the Apple Public Source License
10 * Version 2.0 (the 'License'). You may not use this file except in
11 * compliance with the License. Please obtain a copy of the License at
12 * http://www.opensource.apple.com/apsl/ and read it before using this
13 * file.
14 *
15 * The Original Code and all software distributed under the License are
16 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
17 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
18 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
20 * Please see the License for the specific language governing rights and
21 * limitations under the License.
22 *
23 * @APPLE_LICENSE_HEADER_END@
24 */
25 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
26 /*
27 * Copyright (c) 1989, 1993
28 * The Regents of the University of California. All rights reserved.
29 *
30 * Redistribution and use in source and binary forms, with or without
31 * modification, are permitted provided that the following conditions
32 * are met:
33 * 1. Redistributions of source code must retain the above copyright
34 * notice, this list of conditions and the following disclaimer.
35 * 2. Redistributions in binary form must reproduce the above copyright
36 * notice, this list of conditions and the following disclaimer in the
37 * documentation and/or other materials provided with the distribution.
38 * 3. All advertising materials mentioning features or use of this software
39 * must display the following acknowledgement:
40 * This product includes software developed by the University of
41 * California, Berkeley and its contributors.
42 * 4. Neither the name of the University nor the names of its contributors
43 * may be used to endorse or promote products derived from this software
44 * without specific prior written permission.
45 *
46 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
47 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
48 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
49 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
50 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
51 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
52 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
53 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
54 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
55 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
56 * SUCH DAMAGE.
57 *
58 * @(#)vnode.h 8.17 (Berkeley) 5/20/95
59 */
60
61 #ifndef _VNODE_H_
62 #define _VNODE_H_
63
64 #include <sys/appleapiopts.h>
65 #include <sys/cdefs.h>
66 #include <sys/queue.h>
67 #include <sys/lock.h>
68
69 #include <sys/time.h>
70 #include <sys/uio.h>
71
72 #include <sys/vm.h>
73 #ifdef KERNEL
74 #include <sys/systm.h>
75 #include <vm/vm_pageout.h>
76 #endif /* KERNEL */
77
78 #ifdef __APPLE_API_PRIVATE
79 /*
80 * The vnode is the focus of all file activity in UNIX. There is a
81 * unique vnode allocated for each active file, each current directory,
82 * each mounted-on file, text file, and the root.
83 */
84
85 /*
86 * Vnode types. VNON means no type.
87 */
88 enum vtype { VNON, VREG, VDIR, VBLK, VCHR, VLNK, VSOCK, VFIFO, VBAD, VSTR,
89 VCPLX };
90
91 /*
92 * Vnode tag types.
93 * These are for the benefit of external programs only (e.g., pstat)
94 * and should NEVER be inspected by the kernel.
95 */
96 enum vtagtype {
97 VT_NON, VT_UFS, VT_NFS, VT_MFS, VT_MSDOSFS, VT_LFS, VT_LOFS, VT_FDESC,
98 VT_PORTAL, VT_NULL, VT_UMAP, VT_KERNFS, VT_PROCFS, VT_AFS, VT_ISOFS,
99 VT_UNION, VT_HFS, VT_VOLFS, VT_DEVFS, VT_WEBDAV, VT_UDF, VT_AFP,
100 VT_CDDA, VT_CIFS,VT_OTHER};
101
102 /*
103 * Each underlying filesystem allocates its own private area and hangs
104 * it from v_data. If non-null, this area is freed in getnewvnode().
105 */
106 LIST_HEAD(buflists, buf);
107
108 #define MAX_CLUSTERS 4 /* maximum number of vfs clusters per vnode */
109
110 struct v_cluster {
111 unsigned int start_pg;
112 unsigned int last_pg;
113 };
114
115 struct v_padded_clusters {
116 long v_pad;
117 struct v_cluster v_c[MAX_CLUSTERS];
118 };
119
120 /*
121 * Reading or writing any of these items requires holding the appropriate lock.
122 * v_freelist is locked by the global vnode_free_list simple lock.
123 * v_mntvnodes is locked by the global mntvnodes simple lock.
124 * v_flag, v_usecount, v_holdcount and v_writecount are
125 * locked by the v_interlock simple lock.
126 */
127 struct vnode {
128 u_long v_flag; /* vnode flags (see below) */
129 long v_usecount; /* reference count of users */
130 long v_holdcnt; /* page & buffer references */
131 daddr_t v_lastr; /* last read (read-ahead) */
132 u_long v_id; /* capability identifier */
133 struct mount *v_mount; /* ptr to vfs we are in */
134 int (**v_op)(void *); /* vnode operations vector */
135 TAILQ_ENTRY(vnode) v_freelist; /* vnode freelist */
136 LIST_ENTRY(vnode) v_mntvnodes; /* vnodes for mount point */
137 struct buflists v_cleanblkhd; /* clean blocklist head */
138 struct buflists v_dirtyblkhd; /* dirty blocklist head */
139 long v_numoutput; /* num of writes in progress */
140 enum vtype v_type; /* vnode type */
141 union {
142 struct mount *vu_mountedhere;/* ptr to mounted vfs (VDIR) */
143 struct socket *vu_socket; /* unix ipc (VSOCK) */
144 struct specinfo *vu_specinfo; /* device (VCHR, VBLK) */
145 struct fifoinfo *vu_fifoinfo; /* fifo (VFIFO) */
146 } v_un;
147 struct ubc_info *v_ubcinfo; /* valid for (VREG) */
148 struct nqlease *v_lease; /* Soft reference to lease */
149 daddr_t v_lastw; /* last write (write cluster) */
150 daddr_t v_cstart; /* start block of cluster */
151 daddr_t v_ciosiz; /* real size of I/O for cluster */
152 int v_clen; /* length of current cluster */
153 int v_ralen; /* Read-ahead length */
154 daddr_t v_maxra; /* last readahead block */
155 union {
156 simple_lock_data_t v_ilk; /* lock on usecount and flag */
157 struct v_padded_clusters v_cl; /* vfs cluster IO */
158 } v_un1;
159 #define v_clusters v_un1.v_cl.v_c
160 #define v_interlock v_un1.v_ilk
161
162 struct lock__bsd__ *v_vnlock; /* used for non-locking fs's */
163 long v_writecount; /* reference count of writers */
164 enum vtagtype v_tag; /* type of underlying data */
165 void *v_data; /* private data for fs */
166 };
167 #define v_mountedhere v_un.vu_mountedhere
168 #define v_socket v_un.vu_socket
169 #define v_specinfo v_un.vu_specinfo
170 #define v_fifoinfo v_un.vu_fifoinfo
171
172 /*
173 * Vnode flags.
174 */
175 #define VROOT 0x000001 /* root of its file system */
176 #define VTEXT 0x000002 /* vnode is a pure text prototype */
177 #define VSYSTEM 0x000004 /* vnode being used by kernel */
178 #define VISTTY 0x000008 /* vnode represents a tty */
179 #define VWASMAPPED 0x000010 /* vnode was mapped before */
180 #define VTERMINATE 0x000020 /* terminating memory object */
181 #define VTERMWANT 0x000040 /* wating for memory object death */
182 #define VMOUNT 0x000080 /* mount operation in progress */
183 #define VXLOCK 0x000100 /* vnode is locked to change underlying type */
184 #define VXWANT 0x000200 /* process is waiting for vnode */
185 #define VBWAIT 0x000400 /* waiting for output to complete */
186 #define VALIASED 0x000800 /* vnode has an alias */
187 #define VORECLAIM 0x001000 /* vm object is being reclaimed */
188 #define VNOCACHE_DATA 0x002000 /* don't keep data cached once it's been consumed */
189 #define VSTANDARD 0x004000 /* vnode obtained from common pool */
190 #define VAGE 0x008000 /* Insert vnode at head of free list */
191 #define VRAOFF 0x010000 /* read ahead disabled */
192 #define VUINIT 0x020000 /* ubc_info being initialized */
193 #define VUWANT 0x040000 /* process is wating for VUINIT */
194 #define VUINACTIVE 0x080000 /* UBC vnode is on inactive list */
195 #define VHASDIRTY 0x100000 /* UBC vnode may have 1 or more */
196 /* delayed dirty pages that need to be flushed at the next 'sync' */
197 #define VSWAP 0x200000 /* vnode is being used as swapfile */
198 #define VTHROTTLED 0x400000 /* writes or pageouts have been throttled */
199 /* wakeup tasks waiting when count falls below threshold */
200 #define VNOFLUSH 0x800000 /* don't vflush() if SKIPSYSTEM */
201
202
203 /*
204 * Vnode attributes. A field value of VNOVAL represents a field whose value
205 * is unavailable (getattr) or which is not to be changed (setattr).
206 */
207 struct vattr {
208 enum vtype va_type; /* vnode type (for create) */
209 u_short va_mode; /* files access mode and type */
210 short va_nlink; /* number of references to file */
211 uid_t va_uid; /* owner user id */
212 gid_t va_gid; /* owner group id */
213 long va_fsid; /* file system id (dev for now) */
214 long va_fileid; /* file id */
215 u_quad_t va_size; /* file size in bytes */
216 long va_blocksize; /* blocksize preferred for i/o */
217 struct timespec va_atime; /* time of last access */
218 struct timespec va_mtime; /* time of last modification */
219 struct timespec va_ctime; /* time file changed */
220 u_long va_gen; /* generation number of file */
221 u_long va_flags; /* flags defined for file */
222 dev_t va_rdev; /* device the special file represents */
223 u_quad_t va_bytes; /* bytes of disk space held by file */
224 u_quad_t va_filerev; /* file modification number */
225 u_int va_vaflags; /* operations flags, see below */
226 long va_spare; /* remain quad aligned */
227 };
228
229 /*
230 * Flags for va_vaflags.
231 */
232 #define VA_UTIMES_NULL 0x01 /* utimes argument was NULL */
233 #define VA_EXCLUSIVE 0x02 /* exclusive create request */
234
235 /*
236 * Flags for ioflag.
237 */
238 #define IO_UNIT 0x01 /* do I/O as atomic unit */
239 #define IO_APPEND 0x02 /* append write to end */
240 #define IO_SYNC 0x04 /* do I/O synchronously */
241 #define IO_NODELOCKED 0x08 /* underlying node already locked */
242 #define IO_NDELAY 0x10 /* FNDELAY flag set in file table */
243 #define IO_NOZEROFILL 0x20 /* F_SETSIZE fcntl uses to prevent zero filling */
244 #define IO_TAILZEROFILL 0x40 /* zero fills at the tail of write */
245 #define IO_HEADZEROFILL 0x80 /* zero fills at the head of write */
246 #define IO_NOZEROVALID 0x100 /* do not zero fill if valid page */
247 #define IO_NOZERODIRTY 0x200 /* do not zero fill if page is dirty */
248
249 /*
250 * Modes. Some values same as Ixxx entries from inode.h for now.
251 */
252 #define VSUID 04000 /* set user id on execution */
253 #define VSGID 02000 /* set group id on execution */
254 #define VSVTX 01000 /* save swapped text even after use */
255 #define VREAD 00400 /* read, write, execute permissions */
256 #define VWRITE 00200
257 #define VEXEC 00100
258
259 /*
260 * Token indicating no attribute value yet assigned.
261 */
262 #define VNOVAL (-1)
263
264 #ifdef KERNEL
265 /*
266 * Convert between vnode types and inode formats (since POSIX.1
267 * defines mode word of stat structure in terms of inode formats).
268 */
269 extern enum vtype iftovt_tab[];
270 extern int vttoif_tab[];
271 #define IFTOVT(mode) (iftovt_tab[((mode) & S_IFMT) >> 12])
272 #define VTTOIF(indx) (vttoif_tab[(int)(indx)])
273 #define MAKEIMODE(indx, mode) (int)(VTTOIF(indx) | (mode))
274
275 /*
276 * Flags to various vnode functions.
277 */
278 #define SKIPSYSTEM 0x0001 /* vflush: skip vnodes marked VSYSTEM */
279 #define FORCECLOSE 0x0002 /* vflush: force file closeure */
280 #define WRITECLOSE 0x0004 /* vflush: only close writeable files */
281 #define SKIPSWAP 0x0008 /* vflush: skip vnodes marked VSWAP */
282
283 #define DOCLOSE 0x0008 /* vclean: close active files */
284
285 #define V_SAVE 0x0001 /* vinvalbuf: sync file first */
286 #define V_SAVEMETA 0x0002 /* vinvalbuf: leave indirect blocks */
287
288 #define REVOKEALL 0x0001 /* vop_revoke: revoke all aliases */
289
290 /* flags for vop_allocate */
291 #define PREALLOCATE 0x00000001 /* preallocate allocation blocks */
292 #define ALLOCATECONTIG 0x00000002 /* allocate contigious space */
293 #define ALLOCATEALL 0x00000004 /* allocate all requested space */
294 /* or no space at all */
295 #define FREEREMAINDER 0x00000008 /* deallocate allocated but */
296 /* unfilled blocks */
297 #define ALLOCATEFROMPEOF 0x00000010 /* allocate from the physical eof */
298 #define ALLOCATEFROMVOL 0x00000020 /* allocate from the volume offset */
299
300 #if DIAGNOSTIC
301 #define VATTR_NULL(vap) vattr_null(vap)
302 #define HOLDRELE(vp) holdrele(vp)
303 #define VHOLD(vp) vhold(vp)
304
305 void holdrele __P((struct vnode *));
306 void vattr_null __P((struct vattr *));
307 void vhold __P((struct vnode *));
308 #else
309 #define VATTR_NULL(vap) (*(vap) = va_null) /* initialize a vattr */
310 #define HOLDRELE(vp) holdrele(vp) /* decrease buf or page ref */
311 extern __inline void holdrele(struct vnode *vp)
312 {
313 simple_lock(&vp->v_interlock);
314 vp->v_holdcnt--;
315 simple_unlock(&vp->v_interlock);
316 }
317 #define VHOLD(vp) vhold(vp) /* increase buf or page ref */
318 extern __inline void vhold(struct vnode *vp)
319 {
320 simple_lock(&vp->v_interlock);
321 if (++vp->v_holdcnt <= 0)
322 panic("vhold: v_holdcnt");
323 simple_unlock(&vp->v_interlock);
324 }
325 #endif /* DIAGNOSTIC */
326
327 #define VREF(vp) vref(vp)
328 void vref __P((struct vnode *));
329 #define NULLVP ((struct vnode *)NULL)
330
331 /*
332 * Global vnode data.
333 */
334 extern struct vnode *rootvnode; /* root (i.e. "/") vnode */
335 extern int desiredvnodes; /* number of vnodes desired */
336 extern struct vattr va_null; /* predefined null vattr structure */
337
338 /*
339 * Macro/function to check for client cache inconsistency w.r.t. leasing.
340 */
341 #define LEASE_READ 0x1 /* Check lease for readers */
342 #define LEASE_WRITE 0x2 /* Check lease for modifiers */
343 #endif /* KERNEL */
344
345 /*
346 * Mods for exensibility.
347 */
348
349 /*
350 * Flags for vdesc_flags:
351 */
352 #define VDESC_MAX_VPS 16
353 /* Low order 16 flag bits are reserved for willrele flags for vp arguments. */
354 #define VDESC_VP0_WILLRELE 0x0001
355 #define VDESC_VP1_WILLRELE 0x0002
356 #define VDESC_VP2_WILLRELE 0x0004
357 #define VDESC_VP3_WILLRELE 0x0008
358 #define VDESC_NOMAP_VPP 0x0100
359 #define VDESC_VPP_WILLRELE 0x0200
360
361 /*
362 * VDESC_NO_OFFSET is used to identify the end of the offset list
363 * and in places where no such field exists.
364 */
365 #define VDESC_NO_OFFSET -1
366
367 /*
368 * This structure describes the vnode operation taking place.
369 */
370 struct vnodeop_desc {
371 int vdesc_offset; /* offset in vector--first for speed */
372 char *vdesc_name; /* a readable name for debugging */
373 int vdesc_flags; /* VDESC_* flags */
374
375 /*
376 * These ops are used by bypass routines to map and locate arguments.
377 * Creds and procs are not needed in bypass routines, but sometimes
378 * they are useful to (for example) transport layers.
379 * Nameidata is useful because it has a cred in it.
380 */
381 int *vdesc_vp_offsets; /* list ended by VDESC_NO_OFFSET */
382 int vdesc_vpp_offset; /* return vpp location */
383 int vdesc_cred_offset; /* cred location, if any */
384 int vdesc_proc_offset; /* proc location, if any */
385 int vdesc_componentname_offset; /* if any */
386 /*
387 * Finally, we've got a list of private data (about each operation)
388 * for each transport layer. (Support to manage this list is not
389 * yet part of BSD.)
390 */
391 caddr_t *vdesc_transports;
392 };
393
394 #endif /* __APPLE_API_PRIVATE */
395
396 #ifdef KERNEL
397
398 #ifdef __APPLE_API_PRIVATE
399 /*
400 * A list of all the operation descs.
401 */
402 extern struct vnodeop_desc *vnodeop_descs[];
403
404 /*
405 * Interlock for scanning list of vnodes attached to a mountpoint
406 */
407 extern struct slock mntvnode_slock;
408
409 /*
410 * This macro is very helpful in defining those offsets in the vdesc struct.
411 *
412 * This is stolen from X11R4. I ingored all the fancy stuff for
413 * Crays, so if you decide to port this to such a serious machine,
414 * you might want to consult Intrisics.h's XtOffset{,Of,To}.
415 */
416 #define VOPARG_OFFSET(p_type,field) \
417 ((int) (((char *) (&(((p_type)NULL)->field))) - ((char *) NULL)))
418 #define VOPARG_OFFSETOF(s_type,field) \
419 VOPARG_OFFSET(s_type*,field)
420 #define VOPARG_OFFSETTO(S_TYPE,S_OFFSET,STRUCT_P) \
421 ((S_TYPE)(((char*)(STRUCT_P))+(S_OFFSET)))
422
423
424 /*
425 * This structure is used to configure the new vnodeops vector.
426 */
427 struct vnodeopv_entry_desc {
428 struct vnodeop_desc *opve_op; /* which operation this is */
429 int (*opve_impl)(void *); /* code implementing this operation */
430 };
431 struct vnodeopv_desc {
432 /* ptr to the ptr to the vector where op should go */
433 int (***opv_desc_vector_p)(void *);
434 struct vnodeopv_entry_desc *opv_desc_ops; /* null terminated list */
435 };
436
437 /*
438 * A default routine which just returns an error.
439 */
440 int vn_default_error __P((void));
441
442 /*
443 * A generic structure.
444 * This can be used by bypass routines to identify generic arguments.
445 */
446 struct vop_generic_args {
447 struct vnodeop_desc *a_desc;
448 /* other random data follows, presumably */
449 };
450
451 /*
452 * VOCALL calls an op given an ops vector. We break it out because BSD's
453 * vclean changes the ops vector and then wants to call ops with the old
454 * vector.
455 */
456 #define VOCALL(OPSV,OFF,AP) (( *((OPSV)[(OFF)])) (AP))
457
458 /*
459 * This call works for vnodes in the kernel.
460 */
461 #define VCALL(VP,OFF,AP) VOCALL((VP)->v_op,(OFF),(AP))
462 #define VDESC(OP) (& __CONCAT(OP,_desc))
463 #define VOFFSET(OP) (VDESC(OP)->vdesc_offset)
464
465 #endif /* __APPLE_API_PRIVATE */
466
467 /*
468 * Finally, include the default set of vnode operations.
469 */
470 #include <sys/vnode_if.h>
471
472 /*
473 * vnode manipulation functions.
474 */
475 struct file;
476 struct mount;
477 struct nameidata;
478 struct ostat;
479 struct proc;
480 struct stat;
481 struct ucred;
482 struct uio;
483 struct vattr;
484 struct vnode;
485 struct vop_bwrite_args;
486
487 #ifdef __APPLE_API_EVOLVING
488 int bdevvp __P((dev_t dev, struct vnode **vpp));
489 void cvtstat __P((struct stat *st, struct ostat *ost));
490 int getnewvnode __P((enum vtagtype tag,
491 struct mount *mp, int (**vops)(void *), struct vnode **vpp));
492 void insmntque __P((struct vnode *vp, struct mount *mp));
493 void vattr_null __P((struct vattr *vap));
494 int vcount __P((struct vnode *vp));
495 int vflush __P((struct mount *mp, struct vnode *skipvp, int flags));
496 int vget __P((struct vnode *vp, int lockflag, struct proc *p));
497 void vgone __P((struct vnode *vp));
498 int vinvalbuf __P((struct vnode *vp, int save, struct ucred *cred,
499 struct proc *p, int slpflag, int slptimeo));
500 void vprint __P((char *label, struct vnode *vp));
501 int vrecycle __P((struct vnode *vp, struct slock *inter_lkp,
502 struct proc *p));
503 int vn_bwrite __P((struct vop_bwrite_args *ap));
504 int vn_close __P((struct vnode *vp,
505 int flags, struct ucred *cred, struct proc *p));
506 int vn_lock __P((struct vnode *vp, int flags, struct proc *p));
507 int vn_open __P((struct nameidata *ndp, int fmode, int cmode));
508 int vn_rdwr __P((enum uio_rw rw, struct vnode *vp, caddr_t base,
509 int len, off_t offset, enum uio_seg segflg, int ioflg,
510 struct ucred *cred, int *aresid, struct proc *p));
511 int vn_stat __P((struct vnode *vp, struct stat *sb, struct proc *p));
512 int vop_noislocked __P((struct vop_islocked_args *));
513 int vop_nolock __P((struct vop_lock_args *));
514 int vop_nounlock __P((struct vop_unlock_args *));
515 int vop_revoke __P((struct vop_revoke_args *));
516 struct vnode *
517 checkalias __P((struct vnode *vp, dev_t nvp_rdev, struct mount *mp));
518 void vput __P((struct vnode *vp));
519 void vrele __P((struct vnode *vp));
520 int vaccess __P((mode_t file_mode, uid_t uid, gid_t gid,
521 mode_t acc_mode, struct ucred *cred));
522 int getvnode __P((struct proc *p, int fd, struct file **fpp));
523 #endif __APPLE_API_EVOLVING
524
525 #endif /* KERNEL */
526
527 #endif /* !_VNODE_H_ */