/share/man/man9/VOP_ADVLOCK.9

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 88 lines · 88 code · 0 blank · 0 comment · 0 complexity · 082d3f60c839844acccd70d0cac2d7a2 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 June 30, 1999
    32. 

  32. .Dt VOP_ADVLOCK 9
    33. 

  33. .Os
    34. 

  34. .Sh NAME
    35. 

  35. .Nm VOP_ADVLOCK
    36. 

  36. .Nd advisory record locking
    37. 

  37. .Sh SYNOPSIS
    38. 

  38. .In sys/param.h
    39. 

  39. .In sys/vnode.h
    40. 

  40. .In sys/fcntl.h
    41. 

  41. .In sys/lockf.h
    42. 

  42. .Ft int
    43. 

  43. .Fn VOP_ADVLOCK "struct vnode *vp" "caddr_t id" "int op" "struct flock *fl" "int flags"
    44. 

  44. .Sh DESCRIPTION
    45. 

  45. The arguments are:
    46. 

  46. .Bl -tag -width flags
    47. 

  47. .It Fa vp
    48. 

  48. The vnode being manipulated.
    49. 

  49. .It Fa id
    50. 

  50. The id token which is changing the lock.
    51. 

  51. .It Fa op
    52. 

  52. The operation to perform (see
    53. 

  53. .Xr fcntl 2 ) .
    54. 

  54. .It Fa fl
    55. 

  55. Description of the lock.
    56. 

  56. .It Fa flags
    57. 

  57. One of more of the following:
    58. 

  58. .Pp
    59. 

  59. .Bl -tag -width ".Dv F_UNLCK" -offset indent -compact
    60. 

  60. .It Dv F_RDLCK
    61. 

  61. Shared or read lock.
    62. 

  62. .It Dv F_UNLCK
    63. 

  63. Unlock.
    64. 

  64. .It Dv F_WRLCK
    65. 

  65. Exclusive or write lock.
    66. 

  66. .It Dv F_WAIT
    67. 

  67. Wait until lock is granted.
    68. 

  68. .It Dv F_FLOCK
    69. 

  69. Use
    70. 

  70. .Xr flock 2
    71. 

  71. semantics for lock.
    72. 

  72. .It Dv F_POSIX
    73. 

  73. Use POSIX semantics for lock.
    74. 

  74. .El
    75. 

  75. .El
    76. 

  76. .Pp
    77. 

  77. This entry point manipulates advisory record locks on the file.
    78. 

  78. Most file systems delegate the work for this call to
    79. 

  79. .Fn lf_advlock .
    80. 

  80. .Sh RETURN VALUES
    81. 

  81. Zero is returned on success, otherwise an error is returned.
    82. 

  82. .Sh SEE ALSO
    83. 

  83. .Xr fcntl 2 ,
    84. 

  84. .Xr flock 2 ,
    85. 

  85. .Xr vnode 9
    86. 

  86. .Sh AUTHORS
    87. 

  87. This manual page was written by
    88. 

  88. .An Doug Rabson .
    89.