/share/man/man9/VOP_VPTOCNP.9

 1.\" -*- nroff -*-
 2.\"
 3.\" Copyright (c) 2008 Joe Marcus Clarke
 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$
30.\"
31.Dd November 19, 2011
32.Dt VOP_VPTOCNP 9
33.Os
34.Sh NAME
35.Nm VOP_VPTOCNP
36.Nd translate a vnode to its component name
37.Sh SYNOPSIS
38.In sys/param.h
39.In sys/vnode.h
40.Ft int
41.Fn VOP_VPTOCNP "struct vnode *vp" "struct vnode **dvp" "char *buf" "int *buflen"
42.Sh DESCRIPTION
43This translates a vnode into its component name, and writes that name to
44the head of the buffer specified by
45.Fa buf .
46.Bl -tag -width buflen
47.It Fa vp
48The vnode to translate.
49.It Fa dvp
50The vnode of the parent directory of
51.Fa vp .
52.It Fa buf
53The buffer into which to prepend the component name.
54.It Fa buflen
55The remaining size of the buffer.
56.El
57.Pp
58The default implementation of
59.Nm
60scans through
61.Fa vp Ns 's
62parent directory looking for a dirent with a matching file number.  If
63.Fa vp
64is not a directory, then
65.Nm
66returns ENOENT.
67.Sh LOCKS
68The vnode should be locked on entry and will still be locked on exit.
69The parent directory vnode will be unlocked on a successful exit.
70However, it will have its use count incremented.
71.Sh RETURN VALUES
72Zero is returned on success, otherwise an error code is returned.
73.Sh ERRORS
74.Bl -tag -width Er
75.It Bq Er ENOMEM
76The buffer was not large enough to hold the vnode's component name.
77.It Bq Er ENOENT
78The vnode was not found on the file system.
79.El
80.Sh SEE ALSO
81.Xr VOP_LOOKUP 9 ,
82.Xr vnode 9
83.Sh NOTES
84This interface is a work in progress.
85.Sh HISTORY
86The function
87.Nm
88appeared in
89.Fx 8.0 .
90.Sh AUTHORS
91This manual page was written by
92.An Joe Marcus Clarke .