/share/man/man9/pmap_resident_count.9

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 74 lines · 74 code · 0 blank · 0 comment · 0 complexity · 4a726dc4b669d30e8eef735df8dc1a11 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 21, 2003
    29. 

  29. .Dt PMAP_RESIDENT_COUNT 9
    30. 

  30. .Os
    31. 

  31. .Sh NAME
    32. 

  32. .Nm pmap_resident_count ,
    33. 

  33. .Nm pmap_wired_count
    34. 

  34. .Nd return page resident and wiring statistics
    35. 

  35. .Sh SYNOPSIS
    36. 

  36. .In sys/param.h
    37. 

  37. .In vm/vm.h
    38. 

  38. .In vm/pmap.h
    39. 

  39. .Ft long
    40. 

  40. .Fn pmap_resident_count "pmap_t pmap"
    41. 

  41. .Ft long
    42. 

  42. .Fn pmap_wired_count "pmap_t pmap"
    43. 

  43. .Sh DESCRIPTION
    44. 

  44. The
    45. 

  45. .Fn pmap_resident_count
    46. 

  46. and
    47. 

  47. .Fn pmap_wired_count
    48. 

  48. macros allow
    49. 

  49. .Nm pmap
    50. 

  50. consumers to retrieve statistics from the
    51. 

  51. .Va pm_stats
    52. 

  52. member of the machine-dependent structure
    53. 

  53. .Vt struct pmap .
    54. 

  54. .Sh IMPLEMENTATION NOTES
    55. 

  55. Both functions are defined as in-line macros.
    56. 

  56. The members which they access have type
    57. 

  57. .Vt long .
    58. 

  58. .Sh RETURN VALUES
    59. 

  59. The
    60. 

  60. .Fn pmap_resident_count
    61. 

  61. returns the number of pages in the physical map
    62. 

  62. .Va pmap
    63. 

  63. which are currently resident in main memory.
    64. 

  64. .Pp
    65. 

  65. The
    66. 

  66. .Fn pmap_wired_count
    67. 

  67. returns the number of pages in the physical map
    68. 

  68. .Va pmap
    69. 

  69. which are currently wired into in main memory.
    70. 

  70. .Sh SEE ALSO
    71. 

  71. .Xr pmap 9
    72. 

  72. .Sh AUTHORS
    73. 

  73. This manual page was written by
    74. 

  74. .An Bruce M Simpson Aq bms@spc.org .
    75.