/share/man/man9/VOP_VPTOCNP.9

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 92 lines · 92 code · 0 blank · 0 comment · 0 complexity · 3ccd88d5e371064b43e20e857d846578 MD5 · raw file 

    

  1. .\" -*- nroff -*-
    2. 

  2. .\"
    3. 

  3. .\" Copyright (c) 2008 Joe Marcus Clarke
    4. 

  4. .\"
    5. 

  5. .\" All rights reserved.
    6. 

  6. .\"
    7. 

  7. .\" This program is free software.
    8. 

  8. .\"
    9. 

  9. .\" Redistribution and use in source and binary forms, with or without
    10. 

  10. .\" modification, are permitted provided that the following conditions
    11. 

  11. .\" are met:
    12. 

  12. .\" 1. Redistributions of source code must retain the above copyright
    13. 

  13. .\"    notice, this list of conditions and the following disclaimer.
    14. 

  14. .\" 2. Redistributions in binary form must reproduce the above copyright
    15. 

  15. .\"    notice, this list of conditions and the following disclaimer in the
    16. 

  16. .\"    documentation and/or other materials provided with the distribution.
    17. 

  17. .\"
    18. 

  18. .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
    19. 

  19. .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
    20. 

  20. .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
    21. 

  21. .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
    22. 

  22. .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
    23. 

  23. .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    24. 

  24. .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    25. 

  25. .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    26. 

  26. .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
    27. 

  27. .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    28. 

  28. .\"
    29. 

  29. .\" $FreeBSD$
    30. 

  30. .\"
    31. 

  31. .Dd November 19, 2011
    32. 

  32. .Dt VOP_VPTOCNP 9
    33. 

  33. .Os
    34. 

  34. .Sh NAME
    35. 

  35. .Nm VOP_VPTOCNP
    36. 

  36. .Nd translate a vnode to its component name
    37. 

  37. .Sh SYNOPSIS
    38. 

  38. .In sys/param.h
    39. 

  39. .In sys/vnode.h
    40. 

  40. .Ft int
    41. 

  41. .Fn VOP_VPTOCNP "struct vnode *vp" "struct vnode **dvp" "char *buf" "int *buflen"
    42. 

  42. .Sh DESCRIPTION
    43. 

  43. This translates a vnode into its component name, and writes that name to
    44. 

  44. the head of the buffer specified by
    45. 

  45. .Fa buf .
    46. 

  46. .Bl -tag -width buflen
    47. 

  47. .It Fa vp
    48. 

  48. The vnode to translate.
    49. 

  49. .It Fa dvp
    50. 

  50. The vnode of the parent directory of
    51. 

  51. .Fa vp .
    52. 

  52. .It Fa buf
    53. 

  53. The buffer into which to prepend the component name.
    54. 

  54. .It Fa buflen
    55. 

  55. The remaining size of the buffer.
    56. 

  56. .El
    57. 

  57. .Pp
    58. 

  58. The default implementation of
    59. 

  59. .Nm
    60. 

  60. scans through
    61. 

  61. .Fa vp Ns 's
    62. 

  62. parent directory looking for a dirent with a matching file number.  If
    63. 

  63. .Fa vp
    64. 

  64. is not a directory, then
    65. 

  65. .Nm
    66. 

  66. returns ENOENT.
    67. 

  67. .Sh LOCKS
    68. 

  68. The vnode should be locked on entry and will still be locked on exit.
    69. 

  69. The parent directory vnode will be unlocked on a successful exit.
    70. 

  70. However, it will have its use count incremented.
    71. 

  71. .Sh RETURN VALUES
    72. 

  72. Zero is returned on success, otherwise an error code is returned.
    73. 

  73. .Sh ERRORS
    74. 

  74. .Bl -tag -width Er
    75. 

  75. .It Bq Er ENOMEM
    76. 

  76. The buffer was not large enough to hold the vnode's component name.
    77. 

  77. .It Bq Er ENOENT
    78. 

  78. The vnode was not found on the file system.
    79. 

  79. .El
    80. 

  80. .Sh SEE ALSO
    81. 

  81. .Xr VOP_LOOKUP 9 ,
    82. 

  82. .Xr vnode 9
    83. 

  83. .Sh NOTES
    84. 

  84. This interface is a work in progress.
    85. 

  85. .Sh HISTORY
    86. 

  86. The function
    87. 

  87. .Nm
    88. 

  88. appeared in
    89. 

  89. .Fx 8.0 .
    90. 

  90. .Sh AUTHORS
    91. 

  91. This manual page was written by
    92. 

  92. .An Joe Marcus Clarke .
    93.