1# $NetBSD: vnode_if.src,v 1.30 2001/09/15 20:36:37 chs Exp $ 2# 3# Copyright (c) 1992, 1993 4# The Regents of the University of California. All rights reserved. 5# 6# Redistribution and use in source and binary forms, with or without 7# modification, are permitted provided that the following conditions 8# are met: 9# 1. Redistributions of source code must retain the above copyright 10# notice, this list of conditions and the following disclaimer. 11# 2. Redistributions in binary form must reproduce the above copyright 12# notice, this list of conditions and the following disclaimer in the 13# documentation and/or other materials provided with the distribution. 14# 3. All advertising materials mentioning features or use of this software 15# must display the following acknowledgement: 16# This product includes software developed by the University of 17# California, Berkeley and its contributors. 18# 4. Neither the name of the University nor the names of its contributors 19# may be used to endorse or promote products derived from this software 20# without specific prior written permission. 21# 22# THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25# ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32# SUCH DAMAGE. 33# 34# @(#)vnode_if.src 8.14 (Berkeley) 8/6/95 35# 36# 37 38# 39# Above each of the vop descriptors is a specification of the locking 40# protocol used by each vop call. The first column is the name of 41# the variable, the remaining three columns are in, out and error 42# respectively. The "in" column defines the lock state on input, 43# the "out" column defines the state on succesful return, and the 44# "error" column defines the locking state on error exit. 45# 46# The locking value can take the following values: 47# L: locked. 48# U: unlocked. 49# -: not applicable. vnode does not yet (or no longer) exists. 50# =: the same on input and output, may be either L or U. 51# X: locked if not nil. 52# 53# For operations other than VOP_LOOKUP which require a component name 54# parameter, the flags required for the initial namei() call are listed. 55# Additional flags may be added to the namei() call, but these are required. 56# 57 58# 59#% lookup dvp L ? ? 60#% lookup vpp - L - 61# 62# XXX - the lookup locking protocol defies simple description and depends 63# on the flags and operation fields in the (cnp) structure. Note 64# especially that *vpp may equal dvp and both may be locked. 65# 66# More details: 67# There are three types of lookups: ".", ".." (ISDOTDOT), and other. 68# On successful lookup of ".", a reference is added to dvp, and it 69# is returned in *vpp. 70# To look up ISDOTDOT, dvp is unlocked, the ".." node is locked, and 71# then dvp is relocked iff LOCKPARENT is set and this is the last 72# component name (ISLASTCN set). This preserves the 73# protocol of always locking nodes from root ("/") downward and 74# prevents deadlock. 75# Other lookups find the named node (creating the vnode if needed) and 76# return it, locked, in *vpp. 77# For non-"." lookups, if LOCKPARENT is not set or this was not the 78# last component name, dvp is returned unlocked on a successful 79# lookup. 80# On failure, *vpp is NULL, and *dvp is left locked. If there was 81# an error re-locking dvp (for instance in the ISDOTDOT case), 82# the error is returned with PDIRUNLOCK set. 83# 84# *vpp is always locked on return if the operation succeeds. 85# typically, if *vpp == dvp, you need to release twice, but unlock once. 86# 87# The PDIRUNLOCK flag is set when dvp is unlocked in the lookup routine. 88# It signals the caller that dvp's lock state changed. It will 89# be set on exit if either a successful lookup unlocked the 90# parrent, or there was an error re-locking dvp in the ISDOTDOT case. 91# 92# See sys/sys/namei.h for a description of the SAVENAME and SAVESTART 93# flags. 94# 95vop_lookup { 96 IN struct vnode *dvp; 97 INOUT struct vnode **vpp; 98 IN struct componentname *cnp; 99}; 100 101# 102#% create dvp L U U 103#% create vpp - L - 104# 105#! create cnp CREATE, LOCKPARENT 106# 107vop_create { 108 IN WILLPUT struct vnode *dvp; 109 OUT struct vnode **vpp; 110 IN struct componentname *cnp; 111 IN struct vattr *vap; 112}; 113 114# 115#% mknod dvp L U U 116#% mknod vpp - L - 117# 118#! mknod cnp CREATE, LOCKPARENT 119# 120vop_mknod { 121 IN WILLPUT struct vnode *dvp; 122 OUT struct vnode **vpp; 123 IN struct componentname *cnp; 124 IN struct vattr *vap; 125}; 126 127# 128#% open vp L L L 129# 130vop_open { 131 IN struct vnode *vp; 132 IN int mode; 133 IN struct ucred *cred; 134 IN struct proc *p; 135}; 136 137# 138#% close vp L L L 139# 140vop_close { 141 IN struct vnode *vp; 142 IN int fflag; 143 IN struct ucred *cred; 144 IN struct proc *p; 145}; 146 147# 148#% access vp L L L 149# 150vop_access { 151 IN struct vnode *vp; 152 IN int mode; 153 IN struct ucred *cred; 154 IN struct proc *p; 155}; 156 157# 158#% getattr vp = = = 159# 160vop_getattr { 161 IN struct vnode *vp; 162 IN struct vattr *vap; 163 IN struct ucred *cred; 164 IN struct proc *p; 165}; 166 167# 168#% setattr vp L L L 169# 170vop_setattr { 171 IN struct vnode *vp; 172 IN struct vattr *vap; 173 IN struct ucred *cred; 174 IN struct proc *p; 175}; 176 177# 178#% read vp L L L 179# 180vop_read { 181 IN struct vnode *vp; 182 INOUT struct uio *uio; 183 IN int ioflag; 184 IN struct ucred *cred; 185}; 186 187# 188#% write vp L L L 189# 190vop_write { 191 IN struct vnode *vp; 192 INOUT struct uio *uio; 193 IN int ioflag; 194 IN struct ucred *cred; 195}; 196 197# 198#% ioctl vp U U U 199# 200vop_ioctl { 201 IN struct vnode *vp; 202 IN u_long command; 203 IN caddr_t data; 204 IN int fflag; 205 IN struct ucred *cred; 206 IN struct proc *p; 207}; 208 209# 210#% fcntl vp L L L 211# 212vop_fcntl { 213 IN struct vnode *vp; 214 IN u_int command; 215 IN caddr_t data; 216 IN int fflag; 217 IN struct ucred *cred; 218 IN struct proc *p; 219}; 220 221# 222#% poll vp U U U 223# 224vop_poll { 225 IN struct vnode *vp; 226 IN int events; 227 IN struct proc *p; 228}; 229 230# 231#% revoke vp U U U 232# 233vop_revoke { 234 IN struct vnode *vp; 235 IN int flags; 236}; 237 238# 239#% mmap vp = = = 240# 241vop_mmap { 242 IN struct vnode *vp; 243 IN int fflags; 244 IN struct ucred *cred; 245 IN struct proc *p; 246}; 247 248# 249#% fsync vp L L L 250# 251vop_fsync { 252 IN struct vnode *vp; 253 IN struct ucred *cred; 254 IN int flags; 255 IN off_t offlo 256 IN off_t offhi 257 IN struct proc *p; 258}; 259 260# 261# Needs work: Is newoff right? What's it mean? 262# 263vop_seek { 264 IN struct vnode *vp; 265 IN off_t oldoff; 266 IN off_t newoff; 267 IN struct ucred *cred; 268}; 269 270# 271#% remove dvp L U U 272#% remove vp L U U 273# 274#! remove cnp DELETE, LOCKPARENT | LOCKLEAF 275# 276vop_remove { 277 IN WILLPUT struct vnode *dvp; 278 IN WILLPUT struct vnode *vp; 279 IN struct componentname *cnp; 280}; 281 282# 283#% link vp U U U 284#% link tdvp L U U 285# 286#! link cnp CREATE, LOCKPARENT 287# 288vop_link { 289 IN WILLPUT struct vnode *dvp; 290 IN struct vnode *vp; 291 IN struct componentname *cnp; 292}; 293 294# 295#% rename fdvp U U U 296#% rename fvp U U U 297#% rename tdvp L U U 298#% rename tvp X U U 299# 300#! rename fcnp DELETE, WANTPARENT | SAVESTART 301#! rename tcnp RENAME, LOCKPARENT | LOCKLEAF | NOCACHE | SAVESTART 302# 303# XXX the vop_rename routines should REALLY NOT be depending on SAVESTART! 304# 305vop_rename { 306 IN WILLRELE struct vnode *fdvp; 307 IN WILLRELE struct vnode *fvp; 308 IN struct componentname *fcnp; 309 IN WILLPUT struct vnode *tdvp; 310 IN WILLRELE struct vnode *tvp; 311 IN struct componentname *tcnp; 312}; 313 314# 315#% mkdir dvp L U U 316#% mkdir vpp - L - 317# 318#! mkdir cnp CREATE, LOCKPARENT 319# 320vop_mkdir { 321 IN WILLPUT struct vnode *dvp; 322 OUT struct vnode **vpp; 323 IN struct componentname *cnp; 324 IN struct vattr *vap; 325}; 326 327# 328#% rmdir dvp L U U 329#% rmdir vp L U U 330# 331#! rmdir cnp DELETE, LOCKPARENT | LOCKLEAF 332# 333vop_rmdir { 334 IN WILLPUT struct vnode *dvp; 335 IN WILLPUT struct vnode *vp; 336 IN struct componentname *cnp; 337}; 338 339# 340#% symlink dvp L U U 341#% symlink vpp - L - 342# 343#! symlink cnp CREATE, LOCKPARENT 344# 345vop_symlink { 346 IN WILLPUT struct vnode *dvp; 347 OUT struct vnode **vpp; 348 IN struct componentname *cnp; 349 IN struct vattr *vap; 350 IN char *target; 351}; 352 353# 354#% readdir vp L L L 355# 356vop_readdir { 357 IN struct vnode *vp; 358 INOUT struct uio *uio; 359 IN struct ucred *cred; 360 OUT int *eofflag; 361 OUT off_t **cookies; 362 IN int *ncookies; 363}; 364 365# 366#% readlink vp L L L 367# 368vop_readlink { 369 IN struct vnode *vp; 370 INOUT struct uio *uio; 371 IN struct ucred *cred; 372}; 373 374# 375#% abortop dvp = = = 376# 377#! abortop cnp as appropriate. 378# 379vop_abortop { 380 IN struct vnode *dvp; 381 IN struct componentname *cnp; 382}; 383 384# 385#% inactive vp L U U 386# 387vop_inactive { 388 IN WILLUNLOCK struct vnode *vp; 389 IN struct proc *p; 390}; 391 392# 393#% reclaim vp U U U 394# 395vop_reclaim { 396 IN struct vnode *vp; 397 IN struct proc *p; 398}; 399 400# 401#% lock vp U L U 402# 403vop_lock { 404 IN struct vnode *vp; 405 IN int flags; 406}; 407 408# 409#% unlock vp L U L 410# 411vop_unlock { 412 IN struct vnode *vp; 413 IN int flags; 414}; 415 416# 417#% bmap vp L L L 418#% bmap vpp - U - 419# 420vop_bmap { 421 IN struct vnode *vp; 422 IN daddr_t bn; 423 OUT struct vnode **vpp; 424 IN daddr_t *bnp; 425 OUT int *runp; 426}; 427 428# 429# Needs work: no vp? 430# 431#vop_strategy { 432# IN struct buf *bp; 433#}; 434 435# 436#% print vp = = = 437# 438vop_print { 439 IN struct vnode *vp; 440}; 441 442# 443#% islocked vp = = = 444# 445vop_islocked { 446 IN struct vnode *vp; 447}; 448 449# 450#% pathconf vp L L L 451# 452vop_pathconf { 453 IN struct vnode *vp; 454 IN int name; 455 OUT register_t *retval; 456}; 457 458# 459#% advlock vp U U U 460# 461vop_advlock { 462 IN struct vnode *vp; 463 IN caddr_t id; 464 IN int op; 465 IN struct flock *fl; 466 IN int flags; 467}; 468 469# 470#% blkatoff vp L L L 471# 472vop_blkatoff { 473 IN struct vnode *vp; 474 IN off_t offset; 475 OUT char **res; 476 OUT struct buf **bpp; 477}; 478 479# 480#% valloc pvp L L L 481# 482vop_valloc { 483 IN struct vnode *pvp; 484 IN int mode; 485 IN struct ucred *cred; 486 OUT struct vnode **vpp; 487}; 488 489# 490#% balloc vp L L L 491# 492vop_balloc { 493 IN struct vnode *vp; 494 IN off_t startoffset; 495 IN int size; 496 IN struct ucred *cred; 497 IN int flags; 498 OUT struct buf **bpp; 499}; 500 501# 502#% reallocblks vp L L L 503# 504vop_reallocblks { 505 IN struct vnode *vp; 506 IN struct cluster_save *buflist; 507}; 508 509# 510#% vfree pvp L L L 511# 512vop_vfree { 513 IN struct vnode *pvp; 514 IN ino_t ino; 515 IN int mode; 516}; 517 518# 519#% truncate vp L L L 520# 521vop_truncate { 522 IN struct vnode *vp; 523 IN off_t length; 524 IN int flags; 525 IN struct ucred *cred; 526 IN struct proc *p; 527}; 528 529# 530#% update vp L L L 531# 532vop_update { 533 IN struct vnode *vp; 534 IN struct timespec *access; 535 IN struct timespec *modify; 536 IN int flags; 537}; 538 539# 540#% lease vp = = = 541# 542vop_lease { 543 IN struct vnode *vp; 544 IN struct proc *p; 545 IN struct ucred *cred; 546 IN int flag; 547}; 548 549# 550#% whiteout dvp L L L 551#% whiteout cnp - - - 552#% whiteout flag - - - 553# 554#! whiteout cnp CREATE, LOCKPARENT 555# 556vop_whiteout { 557 IN struct vnode *dvp; 558 IN struct componentname *cnp; 559 IN int flags; 560}; 561 562# 563# Needs work: no vp? 564# 565#vop_bwrite { 566# IN struct buf *bp; 567#}; 568 569# 570#% getpages vp L L L 571# 572vop_getpages { 573 IN struct vnode *vp; 574 IN voff_t offset; 575 IN struct vm_page **m; 576 IN int *count; 577 IN int centeridx; 578 IN vm_prot_t access_type; 579 IN int advice; 580 IN int flags; 581}; 582 583# 584#% putpages vp = = = 585# 586vop_putpages { 587 IN struct vnode *vp; 588 IN voff_t offlo; 589 IN voff_t offhi; 590 IN int flags; 591}; 592