1 /* 2 * Copyright (c) 1989 The Regents of the University of California. 3 * All rights reserved. 4 * 5 * %sccs.include.redist.c% 6 * 7 * @(#)vnode.h 7.62 (Berkeley) 10/22/92 8 */ 9 10 #ifndef KERNEL 11 #include <machine/endian.h> 12 #endif 13 #include <sys/queue.h> 14 15 /* 16 * The vnode is the focus of all file activity in UNIX. There is a 17 * unique vnode allocated for each active file, each current directory, 18 * each mounted-on file, text file, and the root. 19 */ 20 21 /* 22 * Vnode types. VNON means no type. 23 */ 24 enum vtype { VNON, VREG, VDIR, VBLK, VCHR, VLNK, VSOCK, VFIFO, VBAD }; 25 26 /* 27 * Vnode tag types. 28 * These are for the benefit of external programs only (e.g., pstat) 29 * and should NEVER be inspected by the kernel. 30 */ 31 enum vtagtype { VT_NON, VT_UFS, VT_NFS, VT_MFS, VT_LFS }; 32 33 /* 34 * Each underlying filesystem allocates its own private area and hangs 35 * it from v_data. If non-null, this area is free in getnewvnode(). 36 */ 37 struct vnode { 38 u_long v_flag; /* vnode flags (see below) */ 39 short v_usecount; /* reference count of users */ 40 short v_writecount; /* reference count of writers */ 41 long v_holdcnt; /* page & buffer references */ 42 daddr_t v_lastr; /* last read (read-ahead) */ 43 u_long v_id; /* capability identifier */ 44 struct mount *v_mount; /* ptr to vfs we are in */ 45 int (**v_op)(); /* vnode operations vector */ 46 struct vnode *v_freef; /* vnode freelist forward */ 47 struct vnode **v_freeb; /* vnode freelist back */ 48 struct vnode *v_mountf; /* vnode mountlist forward */ 49 struct vnode **v_mountb; /* vnode mountlist back */ 50 struct list_entry v_cleanblkhd; /* clean blocklist head */ 51 struct list_entry v_dirtyblkhd; /* dirty blocklist head */ 52 long v_numoutput; /* num of writes in progress */ 53 enum vtype v_type; /* vnode type */ 54 union { 55 struct mount *vu_mountedhere;/* ptr to mounted vfs (VDIR) */ 56 struct socket *vu_socket; /* unix ipc (VSOCK) */ 57 caddr_t vu_vmdata; /* private data for vm (VREG) */ 58 struct specinfo *vu_specinfo; /* device (VCHR, VBLK) */ 59 struct fifoinfo *vu_fifoinfo; /* fifo (VFIFO) */ 60 } v_un; 61 struct nqlease *v_lease; /* Soft reference to lease */ 62 long v_spare[13]; /* round to 128 bytes */ 63 enum vtagtype v_tag; /* type of underlying data */ 64 void *v_data; /* private data for fs */ 65 }; 66 #define v_mountedhere v_un.vu_mountedhere 67 #define v_socket v_un.vu_socket 68 #define v_vmdata v_un.vu_vmdata 69 #define v_specinfo v_un.vu_specinfo 70 #define v_fifoinfo v_un.vu_fifoinfo 71 72 /* 73 * Vnode flags. 74 */ 75 #define VROOT 0x0001 /* root of its file system */ 76 #define VTEXT 0x0002 /* vnode is a pure text prototype */ 77 #define VSYSTEM 0x0004 /* vnode being used by kernel */ 78 #define VXLOCK 0x0100 /* vnode is locked to change underlying type */ 79 #define VXWANT 0x0200 /* process is waiting for vnode */ 80 #define VBWAIT 0x0400 /* waiting for output to complete */ 81 #define VALIASED 0x0800 /* vnode has an alias */ 82 #define VDIROP 0x1000 /* LFS: vnode is involved in a directory op */ 83 84 /* 85 * Vnode attributes. A field value of VNOVAL represents a field whose value 86 * is unavailable (getattr) or which is not to be changed (setattr). 87 */ 88 struct vattr { 89 enum vtype va_type; /* vnode type (for create) */ 90 u_short va_mode; /* files access mode and type */ 91 short va_nlink; /* number of references to file */ 92 uid_t va_uid; /* owner user id */ 93 gid_t va_gid; /* owner group id */ 94 long va_fsid; /* file system id (dev for now) */ 95 long va_fileid; /* file id */ 96 u_quad_t va_size; /* file size in bytes */ 97 long va_blocksize; /* blocksize preferred for i/o */ 98 struct timespec va_atime; /* time of last access */ 99 struct timespec va_mtime; /* time of last modification */ 100 struct timespec va_ctime; /* time file changed */ 101 u_long va_gen; /* generation number of file */ 102 u_long va_flags; /* flags defined for file */ 103 dev_t va_rdev; /* device the special file represents */ 104 u_quad_t va_bytes; /* bytes of disk space held by file */ 105 u_quad_t va_filerev; /* file modification number */ 106 }; 107 108 /* 109 * Flags for ioflag. 110 */ 111 #define IO_UNIT 0x01 /* do I/O as atomic unit */ 112 #define IO_APPEND 0x02 /* append write to end */ 113 #define IO_SYNC 0x04 /* do I/O synchronously */ 114 #define IO_NODELOCKED 0x08 /* underlying node already locked */ 115 #define IO_NDELAY 0x10 /* FNDELAY flag set in file table */ 116 117 /* 118 * Modes. Some values same as Ixxx entries from inode.h for now. 119 */ 120 #define VSUID 04000 /* set user id on execution */ 121 #define VSGID 02000 /* set group id on execution */ 122 #define VSVTX 01000 /* save swapped text even after use */ 123 #define VREAD 00400 /* read, write, execute permissions */ 124 #define VWRITE 00200 125 #define VEXEC 00100 126 127 /* 128 * Token indicating no attribute value yet assigned. 129 */ 130 #define VNOVAL (-1) 131 132 #ifdef KERNEL 133 /* 134 * Convert between vnode types and inode formats (since POSIX.1 135 * defines mode word of stat structure in terms of inode formats). 136 */ 137 extern enum vtype iftovt_tab[]; 138 extern int vttoif_tab[]; 139 #define IFTOVT(mode) (iftovt_tab[((mode) & S_IFMT) >> 12]) 140 #define VTTOIF(indx) (vttoif_tab[(int)(indx)]) 141 #define MAKEIMODE(indx, mode) (int)(VTTOIF(indx) | (mode)) 142 143 /* 144 * Flags to various vnode functions. 145 */ 146 #define SKIPSYSTEM 0x0001 /* vflush: skip vnodes marked VSYSTEM */ 147 #define FORCECLOSE 0x0002 /* vflush: force file closeure */ 148 #define DOCLOSE 0x0004 /* vclean: close active files */ 149 #define V_SAVE 0x0001 /* vinvalbuf: sync file first */ 150 #define V_SAVEMETA 0x0002 /* vinvalbuf: leave indirect blocks */ 151 152 #ifdef DIAGNOSTIC 153 #define HOLDRELE(vp) holdrele(vp) 154 #define VATTR_NULL(vap) vattr_null(vap) 155 #define VHOLD(vp) vhold(vp) 156 #define VREF(vp) vref(vp) 157 158 void holdrele __P((struct vnode *)); 159 void vattr_null __P((struct vattr *)); 160 void vhold __P((struct vnode *)); 161 void vref __P((struct vnode *)); 162 #else 163 #define HOLDRELE(vp) (vp)->v_holdcnt-- /* decrease buf or page ref */ 164 #define VATTR_NULL(vap) (*(vap) = va_null) /* initialize a vattr */ 165 #define VHOLD(vp) (vp)->v_holdcnt++ /* increase buf or page ref */ 166 #define VREF(vp) (vp)->v_usecount++ /* increase reference */ 167 #endif 168 169 #define NULLVP ((struct vnode *)NULL) 170 171 /* 172 * Global vnode data. 173 */ 174 extern struct vnode *rootdir; /* root (i.e. "/") vnode */ 175 extern int desiredvnodes; /* number of vnodes desired */ 176 extern struct vattr va_null; /* predefined null vattr structure */ 177 178 /* 179 * Macro/function to check for client cache inconsistency w.r.t. leasing. 180 */ 181 #define LEASE_READ 0x1 /* Check lease for readers */ 182 #define LEASE_WRITE 0x2 /* Check lease for modifiers */ 183 184 #ifdef NFS 185 void lease_check __P((struct vnode *vp, struct proc *p, 186 struct ucred *ucred, int flag)); 187 void lease_updatetime __P((int deltat)); 188 #define LEASE_CHECK(vp, p, cred, flag) lease_check((vp), (p), (cred), (flag)) 189 #define LEASE_UPDATETIME(dt) lease_updatetime(dt) 190 #else 191 #define LEASE_CHECK(vp, p, cred, flag) 192 #define LEASE_UPDATETIME(dt) 193 #endif /* NFS */ 194 #endif /* KERNEL */ 195 196 197 /* 198 * Mods for exensibility. 199 */ 200 201 /* 202 * Flags for vdesc_flags: 203 */ 204 #define VDESC_MAX_VPS 16 205 /* Low order 16 flag bits are reserved for willrele flags for vp arguments. */ 206 #define VDESC_VP0_WILLRELE 0x0001 207 #define VDESC_VP1_WILLRELE 0x0002 208 #define VDESC_VP2_WILLRELE 0x0004 209 #define VDESC_VP3_WILLRELE 0x0008 210 #define VDESC_NOMAP_VPP 0x0100 211 #define VDESC_VPP_WILLRELE 0x0200 212 213 /* 214 * VDESC_NO_OFFSET is used to identify the end of the offset list 215 * and in places where no such field exists. 216 */ 217 #define VDESC_NO_OFFSET -1 218 219 /* 220 * This structure describes the vnode operation taking place. 221 */ 222 struct vnodeop_desc { 223 int vdesc_offset; /* offset in vector--first for speed */ 224 char *vdesc_name; /* a readable name for debugging */ 225 int vdesc_flags; /* VDESC_* flags */ 226 227 /* 228 * These ops are used by bypass routines to map and locate arguments. 229 * Creds and procs are not needed in bypass routines, but sometimes 230 * they are useful to (for example) transport layers. 231 * Nameidata is useful because it has a cred in it. 232 */ 233 int *vdesc_vp_offsets; /* list ended by VDESC_NO_OFFSET */ 234 int vdesc_vpp_offset; /* return vpp location */ 235 int vdesc_cred_offset; /* cred location, if any */ 236 int vdesc_proc_offset; /* proc location, if any */ 237 int vdesc_componentname_offset; /* if any */ 238 /* 239 * Finally, we've got a list of private data (about each operation) 240 * for each transport layer. (Support to manage this list is not 241 * yet part of BSD.) 242 */ 243 caddr_t *vdesc_transports; 244 }; 245 246 #ifdef KERNEL 247 /* 248 * A list of all the operation descs. 249 */ 250 extern struct vnodeop_desc *vnodeop_descs[]; 251 252 253 /* 254 * This macro is very helpful in defining those offsets in the vdesc struct. 255 * 256 * This is stolen from X11R4. I ingored all the fancy stuff for 257 * Crays, so if you decide to port this to such a serious machine, 258 * you might want to consult Intrisics.h's XtOffset{,Of,To}. 259 */ 260 #define VOPARG_OFFSET(p_type,field) \ 261 ((int) (((char *) (&(((p_type)NULL)->field))) - ((char *) NULL))) 262 #define VOPARG_OFFSETOF(s_type,field) \ 263 VOPARG_OFFSET(s_type*,field) 264 #define VOPARG_OFFSETTO(S_TYPE,S_OFFSET,STRUCT_P) \ 265 ((S_TYPE)(((char*)(STRUCT_P))+(S_OFFSET))) 266 267 268 /* 269 * This structure is used to configure the new vnodeops vector. 270 */ 271 struct vnodeopv_entry_desc { 272 struct vnodeop_desc *opve_op; /* which operation this is */ 273 int (*opve_impl)(); /* code implementing this operation */ 274 }; 275 struct vnodeopv_desc { 276 /* ptr to the ptr to the vector where op should go */ 277 int (***opv_desc_vector_p)(); 278 struct vnodeopv_entry_desc *opv_desc_ops; /* null terminated list */ 279 }; 280 281 /* 282 * A default routine which just returns an error. 283 */ 284 int vn_default_error __P((void)); 285 286 /* 287 * A generic structure. 288 * This can be used by bypass routines to identify generic arguments. 289 */ 290 struct vop_generic_args { 291 struct vnodeop_desc *a_desc; 292 /* other random data follows, presumably */ 293 }; 294 295 /* 296 * VOCALL calls an op given an ops vector. We break it out because BSD's 297 * vclean changes the ops vector and then wants to call ops with the old 298 * vector. 299 */ 300 #define VOCALL(OPSV,OFF,AP) (( *((OPSV)[(OFF)])) (AP)) 301 302 /* 303 * This call works for vnodes in the kernel. 304 */ 305 #define VCALL(VP,OFF,AP) VOCALL((VP)->v_op,(OFF),(AP)) 306 #define VDESC(OP) (& __CONCAT(OP,_desc)) 307 #define VOFFSET(OP) (VDESC(OP)->vdesc_offset) 308 309 /* 310 * Finally, include the default set of vnode operations. 311 */ 312 #include <vnode_if.h> 313 314 /* 315 * Public vnode manipulation functions. 316 */ 317 struct file; 318 struct mount; 319 struct nameidata; 320 struct proc; 321 struct stat; 322 struct ucred; 323 struct uio; 324 struct vattr; 325 struct vnode; 326 struct vop_bwrite_args; 327 328 int bdevvp __P((dev_t dev, struct vnode **vpp)); 329 int getnewvnode __P((enum vtagtype tag, 330 struct mount *mp, int (**vops)(), struct vnode **vpp)); 331 int vinvalbuf __P((struct vnode *vp, int save, struct ucred *cred, 332 struct proc *p)); 333 void vattr_null __P((struct vattr *vap)); 334 int vcount __P((struct vnode *vp)); 335 int vget __P((struct vnode *vp)); 336 void vgone __P((struct vnode *vp)); 337 void vgoneall __P((struct vnode *vp)); 338 int vn_bwrite __P((struct vop_bwrite_args *ap)); 339 int vn_close __P((struct vnode *vp, 340 int flags, struct ucred *cred, struct proc *p)); 341 int vn_closefile __P((struct file *fp, struct proc *p)); 342 int vn_ioctl __P((struct file *fp, int com, caddr_t data, struct proc *p)); 343 int vn_open __P((struct nameidata *ndp, int fmode, int cmode)); 344 int vn_rdwr __P((enum uio_rw rw, struct vnode *vp, caddr_t base, 345 int len, off_t offset, enum uio_seg segflg, int ioflg, 346 struct ucred *cred, int *aresid, struct proc *p)); 347 int vn_read __P((struct file *fp, struct uio *uio, struct ucred *cred)); 348 int vn_select __P((struct file *fp, int which, struct proc *p)); 349 int vn_stat __P((struct vnode *vp, struct stat *sb, struct proc *p)); 350 int vn_write __P((struct file *fp, struct uio *uio, struct ucred *cred)); 351 struct vnode * 352 checkalias __P((struct vnode *vp, dev_t nvp_rdev, struct mount *mp)); 353 void vput __P((struct vnode *vp)); 354 void vref __P((struct vnode *vp)); 355 void vrele __P((struct vnode *vp)); 356 #endif /* KERNEL */ 357