/share/man/man9/VFS_ROOT.9

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 67 lines · 67 code · 0 blank · 0 comment · 0 complexity · 78239920024239d151f72315b0a84033 MD5 · raw file 

    

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

  2. .\"
    3. 

  3. .\" Copyright (c) 1996 Doug Rabson
    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 May 23, 2009
    32. 

  32. .Dt VFS_ROOT 9
    33. 

  33. .Os
    34. 

  34. .Sh NAME
    35. 

  35. .Nm VFS_ROOT
    36. 

  36. .Nd return the root vnode of a file system
    37. 

  37. .Sh SYNOPSIS
    38. 

  38. .In sys/param.h
    39. 

  39. .In sys/mount.h
    40. 

  40. .In sys/vnode.h
    41. 

  41. .Ft int
    42. 

  42. .Fn VFS_ROOT "struct mount *mp" "int flags" "struct vnode **vpp"
    43. 

  43. .Sh DESCRIPTION
    44. 

  44. Return a locked vnode for the root directory of the file system.
    45. 

  45. .Pp
    46. 

  46. Its arguments are:
    47. 

  47. .Bl -tag -width flags
    48. 

  48. .It Fa mp
    49. 

  49. The file system.
    50. 

  50. .It Fa flags
    51. 

  51. The lock type.
    52. 

  52. Could be
    53. 

  53. .Dv LK_EXCLUSIVE
    54. 

  54. or
    55. 

  55. .Dv LK_SHARED .
    56. 

  56. File system is free to ignore the
    57. 

  57. .Fa flags
    58. 

  58. argument and instead acquire an exclusive lock.
    59. 

  59. .It Fa vpp
    60. 

  60. Return parameter for the root vnode.
    61. 

  61. .El
    62. 

  62. .Sh SEE ALSO
    63. 

  63. .Xr VFS 9 ,
    64. 

  64. .Xr vnode 9
    65. 

  65. .Sh AUTHORS
    66. 

  66. This manual page was written by
    67. 

  67. .An Doug Rabson .
    68.