libmemstat.3 (206622) | libmemstat.3 (210823) |
---|---|
1.\" Copyright (c) 2005 Robert N. M. Watson 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. --- 8 unchanged lines hidden (view full) --- 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" | 1.\" Copyright (c) 2005 Robert N. M. Watson 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. --- 8 unchanged lines hidden (view full) --- 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" |
25.\" $FreeBSD: head/lib/libmemstat/libmemstat.3 206622 2010-04-14 19:08:06Z uqs $ | 25.\" $FreeBSD: head/lib/libmemstat/libmemstat.3 210823 2010-08-03 17:40:09Z joel $ |
26.\" 27.Dd June 27, 2005 28.Dt LIBMEMSTAT 3 29.Os 30.Sh NAME 31.Nm libmemstat 32.Nd "library interface to retrieve kernel memory allocator statistics" 33.Sh LIBRARY --- 219 unchanged lines hidden (view full) --- 253.Fn memstat_mtl_find , 254and will be returned by 255.Fn memstat_get_allocator . 256Two additional constants in the allocator name space are defined: 257.Dv ALLOCATOR_UNKNOWN , 258which will only be returned as a result of a library error, and 259.Dv ALLOCATOR_ANY , 260which can be used to specify that returning types matching any allocator is | 26.\" 27.Dd June 27, 2005 28.Dt LIBMEMSTAT 3 29.Os 30.Sh NAME 31.Nm libmemstat 32.Nd "library interface to retrieve kernel memory allocator statistics" 33.Sh LIBRARY --- 219 unchanged lines hidden (view full) --- 253.Fn memstat_mtl_find , 254and will be returned by 255.Fn memstat_get_allocator . 256Two additional constants in the allocator name space are defined: 257.Dv ALLOCATOR_UNKNOWN , 258which will only be returned as a result of a library error, and 259.Dv ALLOCATOR_ANY , 260which can be used to specify that returning types matching any allocator is |
261permittible from | 261permittable from |
262.Fn memstat_mtl_find . 263.Ss Access Method List 264The following accessor methods are defined, of which some will be valid for 265a given memory type: 266.Bl -tag -width indent 267.It Fn memstat_get_name 268Return a pointer to the name of the memory type. 269Memory for the name is owned by --- 6 unchanged lines hidden (view full) --- 276.It Fn memstat_get_allocator 277Return an integer identifier for the memory allocator that owns the memory 278type. 279.It Fn memstat_get_countlimit 280If the memory type has an administrative limit on the number of simultaneous 281allocations, return it. 282.It Fn memstat_get_byteslimit 283If the memory type has an administrative limit on the number of bytes of | 262.Fn memstat_mtl_find . 263.Ss Access Method List 264The following accessor methods are defined, of which some will be valid for 265a given memory type: 266.Bl -tag -width indent 267.It Fn memstat_get_name 268Return a pointer to the name of the memory type. 269Memory for the name is owned by --- 6 unchanged lines hidden (view full) --- 276.It Fn memstat_get_allocator 277Return an integer identifier for the memory allocator that owns the memory 278type. 279.It Fn memstat_get_countlimit 280If the memory type has an administrative limit on the number of simultaneous 281allocations, return it. 282.It Fn memstat_get_byteslimit 283If the memory type has an administrative limit on the number of bytes of |
284memory that may be simultaenously allocated for the memory type, return it. | 284memory that may be simultaneously allocated for the memory type, return it. |
285.It Fn memstat_get_sizemask 286If the memory type supports variable allocation sizes, return a bitmask of 287sizes allocated for the memory type. 288.It Fn memstat_get_size 289If the memory type supports a fixed allocation size, return that size. 290.It Fn memstat_get_memalloced 291Return the total number of bytes allocated for the memory type over its 292lifetime. --- 204 unchanged lines hidden --- | 285.It Fn memstat_get_sizemask 286If the memory type supports variable allocation sizes, return a bitmask of 287sizes allocated for the memory type. 288.It Fn memstat_get_size 289If the memory type supports a fixed allocation size, return that size. 290.It Fn memstat_get_memalloced 291Return the total number of bytes allocated for the memory type over its 292lifetime. --- 204 unchanged lines hidden --- |