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