share/man/man9/VOP_LINK.9

   1 .\" Copyright (c) 1996 Doug Rabson
   2 .\"
   3 .\" All rights reserved.
   4 .\"
   5 .\" This program is free software.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD: src/share/man/man9/VOP_LINK.9,v 1.9.2.3 2001/12/17 11:30:18 ru Exp $
  28 .\"
  29 .Dd July 24, 1996
  30 .Dt VOP_LINK 9
  31 .Os
  32 .Sh NAME
  33 .Nm VOP_LINK
  34 .Nd create a new name for a file
  35 .Sh SYNOPSIS
  36 .In sys/param.h
  37 .In sys/vnode.h
  38 .Ft int
  39 .Fn VOP_LINK "struct vnode *dvp" "struct vnode *vp" "struct componentname *cnp"
  40 .Sh DESCRIPTION
  41 This links a new name in the specified directory to an existing file.
  42 .Pp
  43 Its arguments are:
  44 .Bl -tag -width 8n
  45 .It Fa dvp
  46 the vnode of the directory
  47 .It Fa vp
  48 the vnode of the file to be linked
  49 .It Fa cnp
  50 pathname information about the file
  51 .El
  52 .Pp
  53 The pathname info must be released on exit.  The directory and
  54 file vnodes should NOT be released on exit.
  55 .Sh LOCKS
  56 The directory,
  57 .Fa dvp
  58 is locked on entry and should remain locked on return.
  59 The file
  60 .Fa vp
  61 is not locked on entry and should remain that way on return.
  62 If your VOP code locks
  63 .Fa vp ,
  64 it must be sure to unlock prior to returning.
  65 .Sh RETURN VALUES
  66 Zero is returned if the file was linked successfully, otherwise an
  67 error is returned.
  68 .Sh PSEUDOCODE
  69 .Bd -literal
  70 int
  71 vop_link(struct vnode *dvp, struct vnode *vp, struct componentname *cnp)
  72 {
  73     int error = 0;
  74
  75     if (vp->v_mount != dvp->v_mount) {
  76         VOP_ABORTOP(dvp, cnp);
  77         error = EXDEV;
  78         goto out2;
  79     }
  80     if (vp != dvp && (error = VOP_LOCK(vp))) {
  81         VOP_ABORTOP(dvp, cnp);
  82         goto out2;
  83     }
  84
  85     /*
  86      * now that we've locked vp, we have to use out1 instead of out2
  87      */
  88
  89     if (vp would have too many links) {
  90         VOP_ABORTOP(dvp, cnp);
  91         error = EMLINK;
  92         goto out1;
  93     }
  94
  95     if (vp is immutable) {
  96         VOP_ABORTOP(dvp, cnp);
  97         error = EPERM;
  98         goto out1;
  99     }
 100
 101     /*
 102      * Increment link count of vp and write back the on-disc version of it.
 103      */
 104     ...;
 105
 106     if (!error) {
 107         /*
 108          * Add the new name to the directory.
 109          */
 110         ...;
 111     }
 112
 113     kfree(cnp->cn_pnbuf, M_NAMEI);
 114 out1:
 115     if (vp != dvp)
 116         VOP_UNLOCK(vp);
 117 out2:
 118
 119     return error;
 120 }
 121 .Ed
 122 .Sh ERRORS
 123 .Bl -tag -width Er
 124 .It Bq Er EPERM
 125 the file is immutable
 126 .El
 127 .Sh SEE ALSO
 128 .Xr vnode 9 ,
 129 .Xr vn_lock 9
 130 .Sh AUTHORS
 131 This man page was originally written by
 132 .An Doug Rabson .