usr/src/man/man3lib/libumem.3lib

   1 '\" te
   2 .\" Copyright (c) 2003, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH LIBUMEM 3LIB "May 22, 2003"
   7 .SH NAME
   8 libumem \- object-caching memory allocation library
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lumem\fR [ \fIlibrary\fR... ]
  13 #include <\fBumem.h\fR>
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 Functions in this library provide fast, scalable object-caching memory
  20 allocation with multithreaded application support. In addition to the standard
  21 \fBmalloc\fR(3C) family of functions and the more flexible
  22 \fBumem_alloc\fR(3MALLOC) family, \fBlibumem\fR provides powerful
  23 object-caching services as described in \fBumem_cache_create\fR(3MALLOC).
  24 .sp
  25 .LP
  26 The \fBlibumem\fR library also provides extensive debugging support, including
  27 detection of memory leaks, buffer overruns, multiple frees, use of
  28 uninitialized data, use of freed data, and many other common programming
  29 errors. See \fBumem_debug\fR(3MALLOC).
  30 .SH INTERFACES
  31 .sp
  32 .LP
  33 The shared object \fBlibumem.so.1\fR provides the public interfaces defined
  34 below. See \fBIntro\fR(3) for additional information on shared object
  35 interfaces.
  36 .sp
  37
  38 .sp
  39 .TS
  40 l l
  41 l l .
  42 \fBcalloc\fR    \fBfree\fR
  43 \fBmalloc\fR    \fBmemalign\fR
  44 \fBrealloc\fR   \fBumem_alloc\fR
  45 \fBumem_cache_alloc\fR  \fBumem_cache_create\fR
  46 \fBumem_cache_destroy\fR        \fBumem_cache_free\fR
  47 \fBumem_free\fR \fBumem_nofail_callback\fR
  48 \fBumem_zalloc\fR       \fBvalloc\fR
  49 .TE
  50
  51 .SH FILES
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fB/usr/lib/libumem.so.1\fR\fR
  56 .ad
  57 .RS 28n
  58 shared object
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fB/usr/lib/64/libumem.so.1\fR\fR
  65 .ad
  66 .RS 28n
  67 64-bit shared object
  68 .RE
  69
  70 .SH ATTRIBUTES
  71 .sp
  72 .LP
  73 See \fBattributes\fR(5) for descriptions of the following attributes:
  74 .sp
  75
  76 .sp
  77 .TS
  78 box;
  79 c | c
  80 l | l .
  81 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  82 _
  83 Interface Stability     Evolving
  84 _
  85 MT-Level        MT-Safe
  86 .TE
  87
  88 .SH SEE ALSO
  89 .sp
  90 .LP
  91 \fBIntro\fR(3), \fBmalloc\fR(3C), \fBumem_alloc\fR(3MALLOC),
  92 \fBumem_cache_create\fR(3MALLOC), \fBumem_debug\fR(3MALLOC),
  93 \fBattributes\fR(5)