/share/man/man9/vm_map_submap.9

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

    

  1. .\"
    2. 

  2. .\" Copyright (c) 2003 Bruce M Simpson <bms@spc.org>
    3. 

  3. .\" All rights reserved.
    4. 

  4. .\"
    5. 

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

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

  7. .\" are met:
    8. 

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

  9. .\"    notice, this list of conditions and the following disclaimer.
    10. 

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

  11. .\"    notice, this list of conditions and the following disclaimer in the
    12. 

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

  13. .\"
    14. 

  14. .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
    15. 

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

  16. .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    17. 

  17. .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
    18. 

  18. .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    19. 

  19. .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    20. 

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

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

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

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

  24. .\" SUCH DAMAGE.
    25. 

  25. .\"
    26. 

  26. .\" $FreeBSD$
    27. 

  27. .\"
    28. 

  28. .Dd July 19, 2003
    29. 

  29. .Dt VM_MAP_SUBMAP 9
    30. 

  30. .Os
    31. 

  31. .Sh NAME
    32. 

  32. .Nm vm_map_submap
    33. 

  33. .Nd create a subordinate map
    34. 

  34. .Sh SYNOPSIS
    35. 

  35. .In sys/param.h
    36. 

  36. .In vm/vm.h
    37. 

  37. .In vm/vm_map.h
    38. 

  38. .Ft int
    39. 

  39. .Fo vm_map_submap
    40. 

  40. .Fa "vm_map_t map" "vm_offset_t start" "vm_offset_t end" "vm_map_t submap"
    41. 

  41. .Fc
    42. 

  42. .Sh DESCRIPTION
    43. 

  43. The
    44. 

  44. .Fn vm_map_submap
    45. 

  45. function marks the range bounded by
    46. 

  46. .Fa start
    47. 

  47. and
    48. 

  48. .Fa end
    49. 

  49. within the map
    50. 

  50. .Fa map
    51. 

  51. as being handled by a subordinate map
    52. 

  52. .Fa sub_map .
    53. 

  53. .Pp
    54. 

  54. It is generally called by the kernel memory allocator.
    55. 

  55. .Sh IMPLEMENTATION NOTES
    56. 

  56. This function is for internal use only.
    57. 

  57. .Pp
    58. 

  58. Both maps must exist.
    59. 

  59. The range must have been created with
    60. 

  60. .Xr vm_map_find 9
    61. 

  61. previously.
    62. 

  62. .Pp
    63. 

  63. No other operations may have been performed on this range
    64. 

  64. before calling this function.
    65. 

  65. Only the
    66. 

  66. .Fn vm_fault
    67. 

  67. operation may be performed within this range after calling
    68. 

  68. this function.
    69. 

  69. .Pp
    70. 

  70. To remove a submapping, one must first remove the range from
    71. 

  71. the parent
    72. 

  72. .Fa map ,
    73. 

  73. and then destroy the
    74. 

  74. .Fa sub_map .
    75. 

  75. This procedure is not recommended.
    76. 

  76. .Sh RETURN VALUES
    77. 

  77. The
    78. 

  78. .Fn vm_map_submap
    79. 

  79. function returns
    80. 

  80. .Dv KERN_SUCCESS
    81. 

  81. if successful.
    82. 

  82. .Pp
    83. 

  83. Otherwise, it returns
    84. 

  84. .Dv KERN_INVALID_ARGUMENT
    85. 

  85. if the caller requested copy-on-write flags,
    86. 

  86. or if the range specified for the sub-map was out of range for the parent map,
    87. 

  87. or if a
    88. 

  88. .Dv NULL
    89. 

  89. backing object was specified.
    90. 

  90. .Sh SEE ALSO
    91. 

  91. .Xr vm_map 9 ,
    92. 

  92. .Xr vm_map_find 9
    93. 

  93. .Sh AUTHORS
    94. 

  94. This manual page was written by
    95. 

  95. .An Bruce M Simpson Aq bms@spc.org .
    96.