share/man/man9/vn_fullpath.9

   1 .\"
   2 .\" Copyright (c) 2003 Robert N. M. Watson.
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice(s), this list of conditions and the following disclaimer as
  10 .\"    the first lines of this file unmodified other than the possible
  11 .\"    addition of one or more copyright notices.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice(s), 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 COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
  17 .\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19 .\" DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
  20 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21 .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  22 .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  23 .\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  26 .\" DAMAGE.
  27 .\"
  28 .\" $FreeBSD$
  29 .\"
  30 .Dd November 23, 2008
  31 .Dt VN_FULLPATH 9
  32 .Os
  33 .Sh NAME
  34 .Nm vn_fullpath
  35 .Nd "convert a vnode reference to a full pathname, given a process context"
  36 .Sh SYNOPSIS
  37 .In sys/param.h
  38 .In sys/vnode.h
  39 .Ft int
  40 .Fo vn_fullpath
  41 .Fa "struct thread *td" "struct vnode *vp" "char **retbuf" "char **freebuf"
  42 .Fc
  43 .Sh DESCRIPTION
  44 The
  45 .Fn vn_fullpath
  46 function makes a
  47 .Dq "best effort"
  48 attempt to generate a string pathname for
  49 the passed vnode; the resulting path, if any, will be relative to
  50 the root directory of the process associated with the passed thread pointer.
  51 The
  52 .Fn vn_fullpath
  53 function
  54 is implemented by inspecting the VFS name cache, and attempting to
  55 reconstruct a path from the process root to the object.
  56 .Pp
  57 This process is necessarily unreliable for several reasons: intermediate
  58 entries in the path may not be found in the cache; files may have more
  59 than one name (hard links), not all file systems use the name cache
  60 (specifically, most synthetic file systems do not); a single name may
  61 be used for more than one file (in the context of file systems covering
  62 other file systems); a file may have no name (if deleted but still
  63 open or referenced).
  64 However, the resulting string may still be more useable to a user than
  65 a vnode pointer value, or a device number and inode number.
  66 Code consuming the results of this function should anticipate (and
  67 properly handle) failure.
  68 .Pp
  69 Its arguments are:
  70 .Bl -tag -width ".Fa freebuf"
  71 .It Fa td
  72 The thread performing the call; this pointer will be dereferenced to find
  73 the process and its file descriptor structure, in order to identify the
  74 root vnode to use.
  75 .It Fa vp
  76 The vnode to search for.  No need to be locked by the caller.
  77 .It Fa retbuf
  78 Pointer to a
  79 .Vt "char *"
  80 that
  81 .Fn vn_fullpath
  82 may (on success) point at a newly
  83 allocated buffer containing the resulting pathname.
  84 .It Fa freebuf
  85 Pointer to a
  86 .Vt "char *"
  87 that
  88 .Fn vn_fullpath
  89 may (on success) point at a buffer
  90 to be freed, when the caller is done with
  91 .Fa retbuf .
  92 .El
  93 .Pp
  94 Typical consumers will declare two character pointers:
  95 .Va fullpath
  96 and
  97 .Va freepath ;
  98 they will set
  99 .Va freepath
 100 to
 101 .Dv NULL ,
 102 and
 103 .Va fullpath
 104 to a name to use
 105 in the event that the call to
 106 .Fn vn_fullpath
 107 fails.
 108 After done with the value of
 109 .Va fullpath ,
 110 the caller will check if
 111 .Va freepath
 112 is
 113 .Pf non- Dv NULL ,
 114 and if so, invoke
 115 .Xr free 9
 116 with a pool type of
 117 .Dv M_TEMP .
 118 .Sh RETURN VALUES
 119 If the vnode is successfully converted to a pathname, 0 is returned;
 120 otherwise, an error number is returned.
 121 .Sh SEE ALSO
 122 .Xr free 9
 123 .Sh AUTHORS
 124 This manual page was written by
 125 .An Robert Watson Aq rwatson@FreeBSD.org .