2 * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
4 * @APPLE_LICENSE_HEADER_START@
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.
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
20 * @APPLE_LICENSE_HEADER_END@
22 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
24 * Copyright (c) 1989, 1993
25 * The Regents of the University of California. All rights reserved.
27 * Redistribution and use in source and binary forms, with or without
28 * modification, are permitted provided that the following conditions
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.
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
55 * @(#)vnode.h 8.17 (Berkeley) 5/20/95
61 #include <sys/appleapiopts.h>
62 #include <sys/cdefs.h>
63 #include <sys/queue.h>
71 #include <sys/systm.h>
72 #include <vm/vm_pageout.h>
75 #ifdef __APPLE_API_PRIVATE
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.
83 * Vnode types. VNON means no type.
85 enum vtype
{ VNON
, VREG
, VDIR
, VBLK
, VCHR
, VLNK
, VSOCK
, VFIFO
, VBAD
, VSTR
,
90 * These are for the benefit of external programs only (e.g., pstat)
91 * and should NEVER be inspected by the kernel.
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
};
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().
103 LIST_HEAD(buflists
, buf
);
105 #define MAX_CLUSTERS 4 /* maximum number of vfs clusters per vnode */
108 unsigned int start_pg
;
109 unsigned int last_pg
;
112 struct v_padded_clusters
{
114 struct v_cluster v_c
[MAX_CLUSTERS
];
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.
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 */
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 char *vu_name
; /* name (only for VREG) */
145 struct ubc_info
*v_ubcinfo
; /* valid for (VREG) */
146 struct nqlease
*v_lease
; /* Soft reference to lease */
147 void *v_scmap
; /* pointer to sparse cluster map */
148 int v_scdirty
; /* number of dirty pages in the sparse cluster map */
149 daddr_t v_ciosiz
; /* real size of I/O for cluster */
150 int v_clen
; /* length of current cluster */
151 int v_ralen
; /* Read-ahead length */
152 daddr_t v_maxra
; /* last readahead block */
154 simple_lock_data_t v_ilk
; /* lock on usecount and flag */
155 struct v_padded_clusters v_cl
; /* vfs cluster IO */
157 #define v_clusters v_un1.v_cl.v_c
158 #define v_interlock v_un1.v_ilk
160 struct lock__bsd__
*v_vnlock
; /* used for non-locking fs's */
161 long v_writecount
; /* reference count of writers */
162 enum vtagtype v_tag
; /* type of underlying data */
163 void *v_data
; /* private data for fs */
165 #define v_mountedhere v_un.vu_mountedhere
166 #define v_socket v_un.vu_socket
167 #define v_specinfo v_un.vu_specinfo
168 #define v_fifoinfo v_un.vu_fifoinfo
170 // NOTE: Do not use these macros. They are for vfs internal use only.
171 #define VNAME(vp) ((char *)((vp)->v_type == VREG ? (vp)->v_un.vu_name : (vp)->v_scmap))
172 #define VPARENT(vp) ((struct vnode *)((vp)->v_type == VREG ? (vp)->v_un1.v_cl.v_pad : (vp)->v_scdirty))
178 #define VROOT 0x000001 /* root of its file system */
179 #define VTEXT 0x000002 /* vnode is a pure text prototype */
180 #define VSYSTEM 0x000004 /* vnode being used by kernel */
181 #define VISTTY 0x000008 /* vnode represents a tty */
182 #define VWASMAPPED 0x000010 /* vnode was mapped before */
183 #define VTERMINATE 0x000020 /* terminating memory object */
184 #define VTERMWANT 0x000040 /* wating for memory object death */
185 #define VMOUNT 0x000080 /* mount operation in progress */
186 #define VXLOCK 0x000100 /* vnode is locked to change underlying type */
187 #define VXWANT 0x000200 /* process is waiting for vnode */
188 #define VBWAIT 0x000400 /* waiting for output to complete */
189 #define VALIASED 0x000800 /* vnode has an alias */
190 #define VORECLAIM 0x001000 /* vm object is being reclaimed */
191 #define VNOCACHE_DATA 0x002000 /* don't keep data cached once it's been consumed */
192 #define VSTANDARD 0x004000 /* vnode obtained from common pool */
193 #define VAGE 0x008000 /* Insert vnode at head of free list */
194 #define VRAOFF 0x010000 /* read ahead disabled */
195 #define VUINIT 0x020000 /* ubc_info being initialized */
196 #define VUWANT 0x040000 /* process is wating for VUINIT */
197 #define VUINACTIVE 0x080000 /* UBC vnode is on inactive list */
198 #define VHASDIRTY 0x100000 /* UBC vnode may have 1 or more */
199 /* delayed dirty pages that need to be flushed at the next 'sync' */
200 #define VSWAP 0x200000 /* vnode is being used as swapfile */
201 #define VTHROTTLED 0x400000 /* writes or pageouts have been throttled */
202 /* wakeup tasks waiting when count falls below threshold */
203 #define VNOFLUSH 0x800000 /* don't vflush() if SKIPSYSTEM */
204 #define VDELETED 0x1000000 /* this vnode is being deleted */
205 #define VFULLFSYNC 0x2000000 /* ask the drive to write the data to the media */
206 #define VHASBEENPAGED 0x4000000 /* vnode has been recently paged to */
209 * Vnode attributes. A field value of VNOVAL represents a field whose value
210 * is unavailable (getattr) or which is not to be changed (setattr).
213 enum vtype va_type
; /* vnode type (for create) */
214 u_short va_mode
; /* files access mode and type */
215 short va_nlink
; /* number of references to file */
216 uid_t va_uid
; /* owner user id */
217 gid_t va_gid
; /* owner group id */
218 long va_fsid
; /* file system id (dev for now) */
219 long va_fileid
; /* file id */
220 u_quad_t va_size
; /* file size in bytes */
221 long va_blocksize
; /* blocksize preferred for i/o */
222 struct timespec va_atime
; /* time of last access */
223 struct timespec va_mtime
; /* time of last modification */
224 struct timespec va_ctime
; /* time file changed */
225 u_long va_gen
; /* generation number of file */
226 u_long va_flags
; /* flags defined for file */
227 dev_t va_rdev
; /* device the special file represents */
228 u_quad_t va_bytes
; /* bytes of disk space held by file */
229 u_quad_t va_filerev
; /* file modification number */
230 u_int va_vaflags
; /* operations flags, see below */
231 long va_spare
; /* remain quad aligned */
235 * Flags for va_vaflags.
237 #define VA_UTIMES_NULL 0x01 /* utimes argument was NULL */
238 #define VA_EXCLUSIVE 0x02 /* exclusive create request */
243 #define IO_UNIT 0x01 /* do I/O as atomic unit */
244 #define IO_APPEND 0x02 /* append write to end */
245 #define IO_SYNC 0x04 /* do I/O synchronously */
246 #define IO_NODELOCKED 0x08 /* underlying node already locked */
247 #define IO_NDELAY 0x10 /* FNDELAY flag set in file table */
248 #define IO_NOZEROFILL 0x20 /* F_SETSIZE fcntl uses to prevent zero filling */
249 #define IO_TAILZEROFILL 0x40 /* zero fills at the tail of write */
250 #define IO_HEADZEROFILL 0x80 /* zero fills at the head of write */
251 #define IO_NOZEROVALID 0x100 /* do not zero fill if valid page */
252 #define IO_NOZERODIRTY 0x200 /* do not zero fill if page is dirty */
255 * Modes. Some values same as Ixxx entries from inode.h for now.
257 #define VSUID 04000 /* set user id on execution */
258 #define VSGID 02000 /* set group id on execution */
259 #define VSVTX 01000 /* save swapped text even after use */
260 #define VREAD 00400 /* read, write, execute permissions */
265 * Token indicating no attribute value yet assigned.
271 * Convert between vnode types and inode formats (since POSIX.1
272 * defines mode word of stat structure in terms of inode formats).
274 extern enum vtype iftovt_tab
[];
275 extern int vttoif_tab
[];
276 #define IFTOVT(mode) (iftovt_tab[((mode) & S_IFMT) >> 12])
277 #define VTTOIF(indx) (vttoif_tab[(int)(indx)])
278 #define MAKEIMODE(indx, mode) (int)(VTTOIF(indx) | (mode))
281 * Flags to various vnode functions.
283 #define SKIPSYSTEM 0x0001 /* vflush: skip vnodes marked VSYSTEM */
284 #define FORCECLOSE 0x0002 /* vflush: force file closeure */
285 #define WRITECLOSE 0x0004 /* vflush: only close writeable files */
286 #define SKIPSWAP 0x0008 /* vflush: skip vnodes marked VSWAP */
288 #define DOCLOSE 0x0008 /* vclean: close active files */
290 #define V_SAVE 0x0001 /* vinvalbuf: sync file first */
291 #define V_SAVEMETA 0x0002 /* vinvalbuf: leave indirect blocks */
293 #define REVOKEALL 0x0001 /* vop_revoke: revoke all aliases */
295 /* flags for vop_allocate */
296 #define PREALLOCATE 0x00000001 /* preallocate allocation blocks */
297 #define ALLOCATECONTIG 0x00000002 /* allocate contigious space */
298 #define ALLOCATEALL 0x00000004 /* allocate all requested space */
299 /* or no space at all */
300 #define FREEREMAINDER 0x00000008 /* deallocate allocated but */
301 /* unfilled blocks */
302 #define ALLOCATEFROMPEOF 0x00000010 /* allocate from the physical eof */
303 #define ALLOCATEFROMVOL 0x00000020 /* allocate from the volume offset */
306 #define VATTR_NULL(vap) vattr_null(vap)
307 #define HOLDRELE(vp) holdrele(vp)
308 #define VHOLD(vp) vhold(vp)
310 void holdrele
__P((struct vnode
*));
311 void vattr_null
__P((struct vattr
*));
312 void vhold
__P((struct vnode
*));
314 #define VATTR_NULL(vap) (*(vap) = va_null) /* initialize a vattr */
315 #define HOLDRELE(vp) holdrele(vp) /* decrease buf or page ref */
316 extern __inline
void holdrele(struct vnode
*vp
)
318 simple_lock(&vp
->v_interlock
);
320 simple_unlock(&vp
->v_interlock
);
322 #define VHOLD(vp) vhold(vp) /* increase buf or page ref */
323 extern __inline
void vhold(struct vnode
*vp
)
325 simple_lock(&vp
->v_interlock
);
326 if (++vp
->v_holdcnt
<= 0)
327 panic("vhold: v_holdcnt");
328 simple_unlock(&vp
->v_interlock
);
330 #endif /* DIAGNOSTIC */
332 #define VREF(vp) vref(vp)
333 void vref
__P((struct vnode
*));
334 #define NULLVP ((struct vnode *)NULL)
339 extern struct vnode
*rootvnode
; /* root (i.e. "/") vnode */
340 extern int desiredvnodes
; /* number of vnodes desired */
341 extern struct vattr va_null
; /* predefined null vattr structure */
344 * Macro/function to check for client cache inconsistency w.r.t. leasing.
346 #define LEASE_READ 0x1 /* Check lease for readers */
347 #define LEASE_WRITE 0x2 /* Check lease for modifiers */
351 * Mods for exensibility.
355 * Flags for vdesc_flags:
357 #define VDESC_MAX_VPS 16
358 /* Low order 16 flag bits are reserved for willrele flags for vp arguments. */
359 #define VDESC_VP0_WILLRELE 0x0001
360 #define VDESC_VP1_WILLRELE 0x0002
361 #define VDESC_VP2_WILLRELE 0x0004
362 #define VDESC_VP3_WILLRELE 0x0008
363 #define VDESC_NOMAP_VPP 0x0100
364 #define VDESC_VPP_WILLRELE 0x0200
367 * VDESC_NO_OFFSET is used to identify the end of the offset list
368 * and in places where no such field exists.
370 #define VDESC_NO_OFFSET -1
373 * This structure describes the vnode operation taking place.
375 struct vnodeop_desc
{
376 int vdesc_offset
; /* offset in vector--first for speed */
377 char *vdesc_name
; /* a readable name for debugging */
378 int vdesc_flags
; /* VDESC_* flags */
381 * These ops are used by bypass routines to map and locate arguments.
382 * Creds and procs are not needed in bypass routines, but sometimes
383 * they are useful to (for example) transport layers.
384 * Nameidata is useful because it has a cred in it.
386 int *vdesc_vp_offsets
; /* list ended by VDESC_NO_OFFSET */
387 int vdesc_vpp_offset
; /* return vpp location */
388 int vdesc_cred_offset
; /* cred location, if any */
389 int vdesc_proc_offset
; /* proc location, if any */
390 int vdesc_componentname_offset
; /* if any */
392 * Finally, we've got a list of private data (about each operation)
393 * for each transport layer. (Support to manage this list is not
396 caddr_t
*vdesc_transports
;
399 #endif /* __APPLE_API_PRIVATE */
403 #ifdef __APPLE_API_PRIVATE
405 * A list of all the operation descs.
407 extern struct vnodeop_desc
*vnodeop_descs
[];
410 * Interlock for scanning list of vnodes attached to a mountpoint
412 extern struct slock mntvnode_slock
;
415 * This macro is very helpful in defining those offsets in the vdesc struct.
417 * This is stolen from X11R4. I ingored all the fancy stuff for
418 * Crays, so if you decide to port this to such a serious machine,
419 * you might want to consult Intrisics.h's XtOffset{,Of,To}.
421 #define VOPARG_OFFSET(p_type,field) \
422 ((int) (((char *) (&(((p_type)NULL)->field))) - ((char *) NULL)))
423 #define VOPARG_OFFSETOF(s_type,field) \
424 VOPARG_OFFSET(s_type*,field)
425 #define VOPARG_OFFSETTO(S_TYPE,S_OFFSET,STRUCT_P) \
426 ((S_TYPE)(((char*)(STRUCT_P))+(S_OFFSET)))
430 * This structure is used to configure the new vnodeops vector.
432 struct vnodeopv_entry_desc
{
433 struct vnodeop_desc
*opve_op
; /* which operation this is */
434 int (*opve_impl
)(void *); /* code implementing this operation */
436 struct vnodeopv_desc
{
437 /* ptr to the ptr to the vector where op should go */
438 int (***opv_desc_vector_p
)(void *);
439 struct vnodeopv_entry_desc
*opv_desc_ops
; /* null terminated list */
443 * A default routine which just returns an error.
445 int vn_default_error
__P((void));
448 * A generic structure.
449 * This can be used by bypass routines to identify generic arguments.
451 struct vop_generic_args
{
452 struct vnodeop_desc
*a_desc
;
453 /* other random data follows, presumably */
457 * VOCALL calls an op given an ops vector. We break it out because BSD's
458 * vclean changes the ops vector and then wants to call ops with the old
461 #define VOCALL(OPSV,OFF,AP) (( *((OPSV)[(OFF)])) (AP))
464 * This call works for vnodes in the kernel.
466 #define VCALL(VP,OFF,AP) VOCALL((VP)->v_op,(OFF),(AP))
467 #define VDESC(OP) (& __CONCAT(OP,_desc))
468 #define VOFFSET(OP) (VDESC(OP)->vdesc_offset)
470 #endif /* __APPLE_API_PRIVATE */
473 * Finally, include the default set of vnode operations.
475 #include <sys/vnode_if.h>
478 * vnode manipulation functions.
490 struct vop_bwrite_args
;
492 #ifdef __APPLE_API_EVOLVING
493 int bdevvp
__P((dev_t dev
, struct vnode
**vpp
));
494 void cvtstat
__P((struct stat
*st
, struct ostat
*ost
));
495 int getnewvnode
__P((enum vtagtype tag
,
496 struct mount
*mp
, int (**vops
)(void *), struct vnode
**vpp
));
497 void insmntque
__P((struct vnode
*vp
, struct mount
*mp
));
498 void vattr_null
__P((struct vattr
*vap
));
499 int vcount
__P((struct vnode
*vp
));
500 int vflush
__P((struct mount
*mp
, struct vnode
*skipvp
, int flags
));
501 int vget
__P((struct vnode
*vp
, int lockflag
, struct proc
*p
));
502 void vgone
__P((struct vnode
*vp
));
503 int vinvalbuf
__P((struct vnode
*vp
, int save
, struct ucred
*cred
,
504 struct proc
*p
, int slpflag
, int slptimeo
));
505 void vprint
__P((char *label
, struct vnode
*vp
));
506 int vrecycle
__P((struct vnode
*vp
, struct slock
*inter_lkp
,
508 int vn_bwrite
__P((struct vop_bwrite_args
*ap
));
509 int vn_close
__P((struct vnode
*vp
,
510 int flags
, struct ucred
*cred
, struct proc
*p
));
511 int vn_lock
__P((struct vnode
*vp
, int flags
, struct proc
*p
));
512 int vn_open
__P((struct nameidata
*ndp
, int fmode
, int cmode
));
513 #ifndef __APPLE_API_PRIVATE
514 __private_extern__
int
515 vn_open_modflags
__P((struct nameidata
*ndp
, int *fmode
, int cmode
));
516 #endif /* __APPLE_API_PRIVATE */
517 int vn_rdwr
__P((enum uio_rw rw
, struct vnode
*vp
, caddr_t base
,
518 int len
, off_t offset
, enum uio_seg segflg
, int ioflg
,
519 struct ucred
*cred
, int *aresid
, struct proc
*p
));
520 int vn_stat
__P((struct vnode
*vp
, struct stat
*sb
, struct proc
*p
));
521 int vop_noislocked
__P((struct vop_islocked_args
*));
522 int vop_nolock
__P((struct vop_lock_args
*));
523 int vop_nounlock
__P((struct vop_unlock_args
*));
524 int vop_revoke
__P((struct vop_revoke_args
*));
526 checkalias
__P((struct vnode
*vp
, dev_t nvp_rdev
, struct mount
*mp
));
527 void vput
__P((struct vnode
*vp
));
528 void vrele
__P((struct vnode
*vp
));
529 int vaccess
__P((mode_t file_mode
, uid_t uid
, gid_t gid
,
530 mode_t acc_mode
, struct ucred
*cred
));
531 int getvnode
__P((struct proc
*p
, int fd
, struct file
**fpp
));
532 #endif /* __APPLE_API_EVOLVING */
536 #endif /* !_VNODE_H_ */