freebsd-skq/share/man/man9/VOP_ABORTOP.9
dillon 609f54c951 Update errors in documentation for various VOP_ calls. Specifically,
describe the correct locking state expected on entry and return.
1999-09-24 07:07:02 +00:00

77 lines
2.3 KiB
Groff

.\" -*- 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_ABORTOP 9
.Sh NAME
.Nm VOP_ABORTOP
.Nd abort a directory operation
.Sh SYNOPSIS
.Fd #include <sys/param.h>
.Fd #include <sys/vnode.h>
.Ft int
.Fn VOP_ABORTOP "struct vnode *dvp" "struct componentname *cnp"
.Sh DESCRIPTION
This is called after
.Xr namei 9
when a
.Dv CREATE /
.Dv DELETE
isn't actually done.
If a buffer has been saved in anticipation of a
.Dv CREATE ,
delete it.
.Bl -tag -width dvp
.It Ar dvp
the vnode of the directory
.It Ar cnp
pathname information for the aborted operation
.El
.Sh PSEUDOCODE
.Bd -literal
int
vop_abortop(struct vnode *dvp, struct componentname *cnp)
{
if ((cnp->cn_flags & (HASBUF | SAVESTART)) == HASBUF)
free(cnp->cn_pnbuf, M_NAMEI);
return 0;
}
.Ed
.Sh LOCKS
.Fa dvp
should be locked on entry and remain locked on return.
.Sh SEE ALSO
.Xr vnode 9
.Sh AUTHORS
This man page was written by
.An Doug Rabson .