xref: /freebsd/share/man/man9/VOP_LINK.9 (revision 394739140cd780cd7417ddfc4ba69019ec57f7d6)

.\" -*- nroff -*-
.\"
.\" Copyright (c) 1996 Doug Rabson
.\"
.\" All rights reserved.
.\"
.\" This program is free software.
.\"
.\" 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.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``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 DEVELOPERS 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.
.\"
.\" $FreeBSD$
.\"
.Dd July 24, 1996
.Os
.Dt VOP_LINK 9
.Sh NAME
.Nm VOP_LINK
.Nd create a new name for a file
.Sh SYNOPSIS
.In sys/param.h
.In sys/vnode.h
.Ft int
.Fn VOP_LINK "struct vnode *dvp" "struct vnode *vp" "struct componentname *cnp"
.Sh DESCRIPTION
This links a new name in the specified directory to an existing file.
.Pp
Its arguments are:
.Bl -tag -width 8n
.It Ar dvp
the vnode of the directory
.It Ar vp
the vnode of the file to be linked
.It Ar cnp
pathname information about the file
.El
.Pp
The pathname info should NOT be released on exit because it is done
by the caller.
The directory and file vnodes should NOT be released on exit.
.Sh LOCKS
.Xr VOP_LINK 9
expects the directory and file vnodes to be locked on entry and will leave
the vnodes locked on return.
.Sh RETURN VALUES
Zero is returned if the file was linked successfully, otherwise an
error is returned.
.Sh PSEUDOCODE
.Bd -literal
int
vop_link(struct vnode *dvp, struct vnode *vp, struct componentname *cnp)
{
    int error = 0;

    if (vp->v_mount != dvp->v_mount)
	return (EXDEV);

    if (vp would have too many links)
	return (EMLINK);

    if (vp is immutable)
	return (EPERM);

    /*
     * Increment link count of vp and write back the on-disc version of it.
     */
    ...;

    if (!error) {
	/*
	 * Add the new name to the directory.
	 */
	...;
    }

    return error;
}
.Ed
.Sh ERRORS
.Bl -tag -width Er
.It Bq Er EMLINK
The file has too many links.
.El
.Bl -tag -width Er
.It Bq Er EPERM
The file is immutable.
.El
.Bl -tag -width Er
.It Bq Er EXDEV
A hard link is not possible between different file systems.
.El
.Sh SEE ALSO
.Xr vnode 9 ,
.Xr vn_lock 9
.Sh AUTHORS
This man page was originally written by
.An Doug Rabson .