FreeBSD/Linux Kernel Cross Reference
sys/kern/vnode_if.src

     #-
     # Copyright (c) 1992, 1993
     #       The Regents of the University of California.  All rights reserved.
     #
     # Redistribution and use in source and binary forms, with or without
     # modification, are permitted provided that the following conditions
     # are met:
     # 1. Redistributions of source code must retain the above copyright
     #    notice, this list of conditions and the following disclaimer.
    # 2. Redistributions in binary form must reproduce the above copyright
    #    notice, this list of conditions and the following disclaimer in the
    #    documentation and/or other materials provided with the distribution.
    # 3. Neither the name of the University nor the names of its contributors
    #    may be used to endorse or promote products derived from this software
    #    without specific prior written permission.
    #
    # THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
    # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    # ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
    # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
    # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    # SUCH DAMAGE.
    #
    #       @(#)vnode_if.src        8.12 (Berkeley) 5/14/95
    # $FreeBSD$
    #
    
    #
    # Above each of the vop descriptors in lines starting with %%
    # is a specification of the locking protocol used by each vop call.
    # The first column is the name of the variable, the remaining three
    # columns are in, out and error respectively.  The "in" column defines
    # the lock state on input, the "out" column defines the state on successful
    # return, and the "error" column defines the locking state on error exit.
    #
    # The locking value can take the following values:
    # L: locked; not converted to type of lock.
    # E: locked with exclusive lock for this process.
    # U: unlocked.
    # -: not applicable.  vnode does not yet (or no longer) exists.
    # =: the same on input and output, may be either L or U.
    #
    # The parameter named "vpp" is assumed to be always used with double
    # indirection (**vpp) and that name is hard-coded in vnode_if.awk !
    #
    # Lines starting with %! specify a pre or post-condition function
    # to call before/after the vop call.
    #
    # If other such parameters are introduced, they have to be added to
    # the AWK script at the head of the definition of "add_debug_code()".
    #
    
    vop_islocked {
            IN struct vnode *vp;
    };
    
    
    %% lookup       dvp     L L L
    %% lookup       vpp     - L -
    
    # XXX - the lookup locking protocol defies simple description and depends
    #       on the flags and operation fields in the (cnp) structure.  Note
    #       especially that *vpp may equal dvp and both may be locked.
    
    vop_lookup {
            IN struct vnode *dvp;
            INOUT struct vnode **vpp;
            IN struct componentname *cnp;
    };
    
    
    %% cachedlookup dvp     L L L
    %% cachedlookup vpp     - L -
    
    # This must be an exact copy of lookup.  See kern/vfs_cache.c for details.
    
    vop_cachedlookup {
            IN struct vnode *dvp;
            INOUT struct vnode **vpp;
            IN struct componentname *cnp;
    };
    
    
    %% create       dvp     E E E
    %% create       vpp     - L -
    %! create       pre     vop_create_pre
    %! create       post    vop_create_post
    
    vop_create {
            IN struct vnode *dvp;
            OUT struct vnode **vpp;
            IN struct componentname *cnp;
            IN struct vattr *vap;
    };
   
   
   %% whiteout     dvp     E E E
   %! whiteout     pre     vop_whiteout_pre
   %! whiteout     post    vop_whiteout_post
   
   vop_whiteout {
           IN struct vnode *dvp;
           IN struct componentname *cnp;
           IN int flags;
   };
   
   
   %% mknod        dvp     E E E
   %% mknod        vpp     - L -
   %! mknod        pre     vop_mknod_pre
   %! mknod        post    vop_mknod_post
   
   vop_mknod {
           IN struct vnode *dvp;
           OUT struct vnode **vpp;
           IN struct componentname *cnp;
           IN struct vattr *vap;
   };
   
   
   %% open         vp      L L L
   %! open         post    vop_open_post
   
   vop_open {
           IN struct vnode *vp;
           IN int mode;
           IN struct ucred *cred;
           IN struct thread *td;
           IN struct file *fp;
   };
   
   
   %% close        vp      L L L
   %! close        post    vop_close_post
   
   vop_close {
           IN struct vnode *vp;
           IN int fflag;
           IN struct ucred *cred;
           IN struct thread *td;
   };
   
   
   %% fplookup_vexec       vp      - - -
   %! fplookup_vexec       debugpre        vop_fplookup_vexec_debugpre
   %! fplookup_vexec       debugpost       vop_fplookup_vexec_debugpost
   
   vop_fplookup_vexec {
           IN struct vnode *vp;
           IN struct ucred *cred;
   };
   
   
   %% fplookup_symlink     vp      - - -
   %! fplookup_symlink     debugpre        vop_fplookup_symlink_debugpre
   %! fplookup_symlink     debugpost       vop_fplookup_symlink_debugpost
   
   vop_fplookup_symlink {
           IN struct vnode *vp;
           IN struct cache_fpl *fpl;
   };
   
   
   %% access       vp      L L L
   
   vop_access {
           IN struct vnode *vp;
           IN accmode_t accmode;
           IN struct ucred *cred;
           IN struct thread *td;
   };
   
   
   %% accessx      vp      L L L
   
   vop_accessx {
           IN struct vnode *vp;
           IN accmode_t accmode;
           IN struct ucred *cred;
           IN struct thread *td;
   };
   
   
   %% stat vp      L L L
   
   vop_stat {
           IN struct vnode *vp;
           OUT struct stat *sb;
           IN struct ucred *active_cred;
           IN struct ucred *file_cred;
   };
   
   
   %% getattr      vp      L L L
   
   vop_getattr {
           IN struct vnode *vp;
           OUT struct vattr *vap;
           IN struct ucred *cred;
   };
   
   
   %% setattr      vp      E E E
   %! setattr      pre     vop_setattr_pre
   %! setattr      post    vop_setattr_post
   
   vop_setattr {
           IN struct vnode *vp;
           IN struct vattr *vap;
           IN struct ucred *cred;
   };
   
   
   %% mmapped      vp      L L L
   
   vop_mmapped {
           IN struct vnode *vp;
   };
   
   
   %% read         vp      L L L
   %! read         post    vop_read_post
   
   vop_read {
           IN struct vnode *vp;
           INOUT struct uio *uio;
           IN int ioflag;
           IN struct ucred *cred;
   };
   
   
   %% read_pgcache vp      - - -
   %! read_pgcache post    vop_read_pgcache_post
   
   vop_read_pgcache {
           IN struct vnode *vp;
           INOUT struct uio *uio;
           IN int ioflag;
           IN struct ucred *cred;
   };
   
   
   %% write        vp      L L L
   %! write        pre     VOP_WRITE_PRE
   %! write        post    VOP_WRITE_POST
   
   vop_write {
           IN struct vnode *vp;
           INOUT struct uio *uio;
           IN int ioflag;
           IN struct ucred *cred;
   };
   
   
   %% ioctl        vp      U U U
   
   vop_ioctl {
           IN struct vnode *vp;
           IN u_long command;
           IN void *data;
           IN int fflag;
           IN struct ucred *cred;
           IN struct thread *td;
   };
   
   
   %% poll         vp      U U U
   
   vop_poll {
           IN struct vnode *vp;
           IN int events;
           IN struct ucred *cred;
           IN struct thread *td;
   };
   
   
   %% kqfilter     vp      U U U
   
   vop_kqfilter {
           IN struct vnode *vp;
           IN struct knote *kn;
   };
   
   
   %% revoke       vp      L L L
   
   vop_revoke {
           IN struct vnode *vp;
           IN int flags;
   };
   
   
   %% fsync        vp      - - -
   %! fsync        pre     vop_fsync_debugpre
   %! fsync        post    vop_fsync_debugpost
   
   vop_fsync {
           IN struct vnode *vp;
           IN int waitfor;
           IN struct thread *td;
   };
   
   
   %% remove       dvp     E E E
   %% remove       vp      E E E
   %! remove       pre     vop_remove_pre
   %! remove       post    vop_remove_post
   
   vop_remove {
           IN struct vnode *dvp;
           IN struct vnode *vp;
           IN struct componentname *cnp;
   };
   
   
   %% link         tdvp    E E E
   %% link         vp      E E E
   %! link         pre     vop_link_pre
   %! link         post    vop_link_post
   
   vop_link {
           IN struct vnode *tdvp;
           IN struct vnode *vp;
           IN struct componentname *cnp;
   };
   
   
   %! rename       pre     vop_rename_pre
   %! rename       post    vop_rename_post
   
   vop_rename {
           IN WILLRELE struct vnode *fdvp;
           IN WILLRELE struct vnode *fvp;
           IN struct componentname *fcnp;
           IN WILLRELE struct vnode *tdvp;
           IN WILLRELE struct vnode *tvp;
           IN struct componentname *tcnp;
   };
   
   
   %% mkdir        dvp     E E E
   %% mkdir        vpp     - E -
   %! mkdir        pre     vop_mkdir_pre
   %! mkdir        post    vop_mkdir_post
   %! mkdir        debugpost vop_mkdir_debugpost
   
   vop_mkdir {
           IN struct vnode *dvp;
           OUT struct vnode **vpp;
           IN struct componentname *cnp;
           IN struct vattr *vap;
   };
   
   
   %% rmdir        dvp     E E E
   %% rmdir        vp      E E E
   %! rmdir        pre     vop_rmdir_pre
   %! rmdir        post    vop_rmdir_post
   
   vop_rmdir {
           IN struct vnode *dvp;
           IN struct vnode *vp;
           IN struct componentname *cnp;
   };
   
   
   %% symlink      dvp     E E E
   %% symlink      vpp     - E -
   %! symlink      pre     vop_symlink_pre
   %! symlink      post    vop_symlink_post
   
   vop_symlink {
           IN struct vnode *dvp;
           OUT struct vnode **vpp;
           IN struct componentname *cnp;
           IN struct vattr *vap;
           IN const char *target;
   };
   
   
   %% readdir      vp      L L L
   %! readdir      post    vop_readdir_post
   
   vop_readdir {
           IN struct vnode *vp;
           INOUT struct uio *uio;
           IN struct ucred *cred;
           INOUT int *eofflag;
           OUT int *ncookies;
           INOUT uint64_t **cookies;
   };
   
   
   %% readlink     vp      L L L
   
   vop_readlink {
           IN struct vnode *vp;
           INOUT struct uio *uio;
           IN struct ucred *cred;
   };
   
   
   %% inactive     vp      E E E
   
   vop_inactive {
           IN struct vnode *vp;
   };
   
   %! need_inactive        debugpre        vop_need_inactive_debugpre
   %! need_inactive        debugpost       vop_need_inactive_debugpost
   
   vop_need_inactive {
           IN struct vnode *vp;
   };
   
   %% reclaim      vp      E E E
   %! reclaim      post    vop_reclaim_post
   
   vop_reclaim {
           IN struct vnode *vp;
   };
   
   
   %! lock1        debugpre        vop_lock_debugpre
   %! lock1        debugpost       vop_lock_debugpost
   
   vop_lock1 {
           IN struct vnode *vp;
           IN int flags;
           IN const char *file;
           IN int line;
   };
   
   
   %! unlock       debugpre        vop_unlock_debugpre
   
   vop_unlock {
           IN struct vnode *vp;
   };
   
   
   %% bmap         vp      L L L
   
   vop_bmap {
           IN struct vnode *vp;
           IN daddr_t bn;
           OUT struct bufobj **bop;
           IN daddr_t *bnp;
           OUT int *runp;
           OUT int *runb;
   };
   
   
   %% strategy     vp      L L L
   %! strategy     debugpre        vop_strategy_debugpre
   
   vop_strategy {
           IN struct vnode *vp;
           IN struct buf *bp;
   };
   
   
   %% getwritemount vp     = = =
   
   vop_getwritemount {
           IN struct vnode *vp;
           OUT struct mount **mpp;
   };
   
   
   %% print        vp      - - -
   
   vop_print {
           IN struct vnode *vp;
   };
   
   
   %% pathconf     vp      L L L
   
   vop_pathconf {
           IN struct vnode *vp;
           IN int name;
           OUT long *retval;
   };
   
   
   %% advlock      vp      U U U
   
   vop_advlock {
           IN struct vnode *vp;
           IN void *id;
           IN int op;
           IN struct flock *fl;
           IN int flags;
   };
   
   
   %% advlockasync vp      U U U
   
   vop_advlockasync {
           IN struct vnode *vp;
           IN void *id;
           IN int op;
           IN struct flock *fl;
           IN int flags;
           IN struct task *task;   
           INOUT void **cookiep;
   };
   
   
   %% advlockpurge vp      E E E
   
   vop_advlockpurge {
           IN struct vnode *vp;
   };
   
   
   %% reallocblks  vp      E E E
   
   vop_reallocblks {
           IN struct vnode *vp;
           IN struct cluster_save *buflist;
   };
   
   
   %% getpages     vp      L L L
   
   vop_getpages {
           IN struct vnode *vp;
           IN vm_page_t *m;
           IN int count;
           IN int *rbehind;
           IN int *rahead;
   };
   
   
   %% getpages_async       vp      L L L
   
   vop_getpages_async {
           IN struct vnode *vp;
           IN vm_page_t *m;
           IN int count;
           IN int *rbehind;
           IN int *rahead;
           IN vop_getpages_iodone_t *iodone;
           IN void *arg;
   };
   
   
   %% putpages     vp      L L L
   
   vop_putpages {
           IN struct vnode *vp;
           IN vm_page_t *m;
           IN int count;
           IN int sync;
           IN int *rtvals;
   };
   
   
   %% getacl       vp      L L L
   
   vop_getacl {
           IN struct vnode *vp;
           IN acl_type_t type;
           OUT struct acl *aclp;
           IN struct ucred *cred;
           IN struct thread *td;
   };
   
   
   %% setacl       vp      E E E
   %! setacl       pre     vop_setacl_pre
   %! setacl       post    vop_setacl_post
   
   vop_setacl {
           IN struct vnode *vp;
           IN acl_type_t type;
           IN struct acl *aclp;
           IN struct ucred *cred;
           IN struct thread *td;
   };
   
   
   %% aclcheck     vp      = = =
   
   vop_aclcheck {
           IN struct vnode *vp;
           IN acl_type_t type;
           IN struct acl *aclp;
           IN struct ucred *cred;
           IN struct thread *td;
   };
   
   
   %% closeextattr vp      L L L
   
   vop_closeextattr {
           IN struct vnode *vp;
           IN int commit;
           IN struct ucred *cred;
           IN struct thread *td;
   };
   
   
   %% getextattr   vp      L L L
   
   vop_getextattr {
           IN struct vnode *vp;
           IN int attrnamespace;
           IN const char *name;
           INOUT struct uio *uio;
           OUT size_t *size;
           IN struct ucred *cred;
           IN struct thread *td;
   };
   
   
   %% listextattr  vp      L L L
   
   vop_listextattr {
           IN struct vnode *vp;
           IN int attrnamespace;
           INOUT struct uio *uio;
           OUT size_t *size;
           IN struct ucred *cred;
           IN struct thread *td;
   };
   
   
   %% openextattr  vp      L L L
   
   vop_openextattr {
           IN struct vnode *vp;
           IN struct ucred *cred;
           IN struct thread *td;
   };
   
   
   %% deleteextattr        vp      E E E
   %! deleteextattr        pre     vop_deleteextattr_pre
   %! deleteextattr        post    vop_deleteextattr_post
   
   vop_deleteextattr {
           IN struct vnode *vp;
           IN int attrnamespace;
           IN const char *name;
           IN struct ucred *cred;
           IN struct thread *td;
   };
   
   
   %% setextattr   vp      E E E
   %! setextattr   pre     vop_setextattr_pre
   %! setextattr   post    vop_setextattr_post
   
   vop_setextattr {
           IN struct vnode *vp;
           IN int attrnamespace;
           IN const char *name;
           INOUT struct uio *uio;
           IN struct ucred *cred;
           IN struct thread *td;
   };
   
   
   %% setlabel     vp      E E E
   
   vop_setlabel {
           IN struct vnode *vp;
           IN struct label *label;
           IN struct ucred *cred;
           IN struct thread *td;
   };
   
   
   %% vptofh       vp      = = =
   
   vop_vptofh {
           IN struct vnode *vp;
           IN struct fid *fhp;
   };
   
   
   %% vptocnp              vp      L L L
   %% vptocnp              vpp     - U -
   
   vop_vptocnp {
           IN struct vnode *vp;
           OUT struct vnode **vpp;
           INOUT char *buf;
           INOUT size_t *buflen;
   };
   
   
   %% allocate     vp      E E E
   
   vop_allocate {
           IN struct vnode *vp;
           INOUT off_t *offset;
           INOUT off_t *len;
           IN int ioflag;
           IN struct ucred *cred;
   };
   
   
   %% advise       vp      U U U
   
   vop_advise {
           IN struct vnode *vp;
           IN off_t start;
           IN off_t end;
           IN int advice;
   };
   
   
   %% unp_bind     vp      E E E
   
   vop_unp_bind {
           IN struct vnode *vp;
           IN struct unpcb *unpcb;
   };
   
   
   %% unp_connect  vp      L L L
   
   vop_unp_connect {
           IN struct vnode *vp;
           OUT struct unpcb **unpcb;
   };
   
   
   %% unp_detach   vp      = = =
   
   vop_unp_detach {
           IN struct vnode *vp;
   };
   
   
   %% is_text      vp      L L L
   
   vop_is_text {
           IN struct vnode *vp;
   };
   
   
   %% set_text     vp      = = =
   
   vop_set_text {
           IN struct vnode *vp;
   };
   
   
   %% vop_unset_text       vp      L L L
   
   vop_unset_text {
           IN struct vnode *vp;
   };
   
   
   %% add_writecount       vp      L L L
   
   vop_add_writecount {
           IN struct vnode *vp;
           IN int inc;
   };
   
   
   %% fdatasync    vp      - - -
   %! fdatasync    pre     vop_fdatasync_debugpre
   %! fdatasync    post    vop_fdatasync_debugpost
   
   vop_fdatasync {
           IN struct vnode *vp;
           IN struct thread *td;
   };
   
   
   %% copy_file_range      invp    U U U
   %% copy_file_range      outvp   U U U
   
   vop_copy_file_range {
           IN struct vnode *invp;
           INOUT off_t *inoffp;
           IN struct vnode *outvp;
           INOUT off_t *outoffp;
           INOUT size_t *lenp;
           IN unsigned int flags;
           IN struct ucred *incred;
           IN struct ucred *outcred;
           IN struct thread *fsizetd;
   };
   
   
   %% vput_pair    dvp     E - -
   
   vop_vput_pair {
           IN struct vnode *dvp;
           INOUT struct vnode **vpp;
           IN bool unlock_vp;
   };
   
   
   %% deallocate   vp      L L L
   
   vop_deallocate {
           IN struct vnode *vp;
           INOUT off_t *offset;
           INOUT off_t *len;
           IN int flags;
           IN int ioflag;
           IN struct ucred *cred;
   };
   
   
   # The VOPs below are spares at the end of the table to allow new VOPs to be
   # added in stable branches without breaking the KBI.  New VOPs in HEAD should
   # be added above these spares.  When merging a new VOP to a stable branch,
   # the new VOP should replace one of the spares.
   
   vop_spare1 {
           IN struct vnode *vp;
   };
   
   vop_spare2 {
           IN struct vnode *vp;
   };
   
   vop_spare3 {
           IN struct vnode *vp;
   };
   
   vop_spare4 {
           IN struct vnode *vp;
   };
   
   vop_spare5 {
           IN struct vnode *vp;
   };

Cache object: 91d2ddc39e0237760befb9685615567a