/share/man/man9/getnewvnode.9

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 69 lines · 69 code · 0 blank · 0 comment · 0 complexity · 9ecd68832e10d636c23bdfc824b29180 MD5 · raw file 

    

  1. .\"
    2. 

  2. .\" Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. All rights reserved.
    3. 

  3. .\"
    4. 

  4. .\" Redistribution and use in source and binary forms, with or without
    5. 

  5. .\" modification, are permitted provided that the following conditions
    6. 

  6. .\" are met:
    7. 

  7. .\" 1. Redistributions of source code must retain the above copyright
    8. 

  8. .\"    notice(s), this list of conditions and the following disclaimer as
    9. 

  9. .\"    the first lines of this file unmodified other than the possible
    10. 

  10. .\"    addition of one or more copyright notices.
    11. 

  11. .\" 2. Redistributions in binary form must reproduce the above copyright
    12. 

  12. .\"    notice(s), this list of conditions and the following disclaimer in the
    13. 

  13. .\"    documentation and/or other materials provided with the distribution.
    14. 

  14. .\"
    15. 

  15. .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
    16. 

  16. .\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
    17. 

  17. .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    18. 

  18. .\" DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
    19. 

  19. .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
    20. 

  20. .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
    21. 

  21. .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
    22. 

  22. .\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    23. 

  23. .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
    24. 

  24. .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
    25. 

  25. .\" DAMAGE.
    26. 

  26. .\"
    27. 

  27. .\" $FreeBSD$
    28. 

  28. .\"
    29. 

  29. .Dd November 21, 2001
    30. 

  30. .Dt GETNEWVNODE 9
    31. 

  31. .Os
    32. 

  32. .Sh NAME
    33. 

  33. .Nm getnewvnode
    34. 

  34. .Nd "get a new vnode"
    35. 

  35. .Sh SYNOPSIS
    36. 

  36. .In sys/param.h
    37. 

  37. .In sys/vnode.h
    38. 

  38. .In sys/mount.h
    39. 

  39. .Ft int
    40. 

  40. .Fn getnewvnode "const char *tag" "struct mount *mp" "vop_t **vops" "struct vnode **vpp"
    41. 

  41. .Sh DESCRIPTION
    42. 

  42. The
    43. 

  43. .Fn getnewvnode
    44. 

  44. function initializes a new vnode, assigning it the vnode operations passed in
    45. 

  45. .Fa vops .
    46. 

  46. The vnode is either freshly allocated, or taken from the head of the
    47. 

  47. free list depending on the number of vnodes already in the system.
    48. 

  48. .Pp
    49. 

  49. The arguments to
    50. 

  50. .Fn getnewvnode
    51. 

  51. are:
    52. 

  52. .Bl -tag -width ".Fa vops"
    53. 

  53. .It Fa tag
    54. 

  54. The file system type string.
    55. 

  55. This field should only be referenced for debugging or for userland utilities.
    56. 

  56. .It Fa mp
    57. 

  57. The mount point to add the new vnode to.
    58. 

  58. .It Fa vops
    59. 

  59. The vnode operations to assign to the new vnode.
    60. 

  60. .It Fa vpp
    61. 

  61. Points to the new vnode upon successful completion.
    62. 

  62. .El
    63. 

  63. .Sh RETURN VALUES
    64. 

  64. .Fn getnewvnode
    65. 

  65. returns 0 on success.
    66. 

  66. There are currently no failure conditions - that do not result in a panic.
    67. 

  67. .Sh AUTHORS
    68. 

  68. This manual page was written by
    69. 

  69. .An Chad David Aq davidc@acns.ab.ca .
    70.