Add a section on the allocator name space and its interactions with

memstat_mtl_find().

MFC after:	10 days

1 files changed, 22 insertions, 0 deletions

diff --git a/lib/libmemstat/libmemstat.3 b/lib/libmemstat/libmemstat.3
index c5aa3c7..42f0871 100644
--- a/lib/libmemstat/libmemstat.3
+++ b/lib/libmemstat/libmemstat.3
@@ -189,6 +189,28 @@ be initialized to
 or
 .Dv NULL
 before first use.
+.Ss Allocator Types
+Currently,
+.Nm
+supports two kernel allocators:
+.Dv ALLOCATOR_UMA
+for
+.Xr uma 9 ,
+and
+.Dv ALLOCATOR_MALLOC
+for
+.Xr malloc 9 .
+These values may be passed to
+.Fn memstat_mtl_find ,
+and will be returned by
+.Fn memstat_get_allocator .
+Two additional constants in the allocator name space are defined:
+.Dv ALLOCATOR_UNKNOWN ,
+which will only be returned as a result of a library error, and
+.Dv ALLOCATOR_ANY ,
+which can be used to specify that returning types matching any allocator is
+permittible from
+.Fn memstat_mtl_find .
 .Sh EXAMPLES
 Create a memory type list, query the
 .Xr uma 9