share/man/man9/VOP_LINK.9

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