xref: /illumos-gate/usr/src/man/man3lib/libumem.3lib (revision 2aeafac3612e19716bf8164f89c3c9196342979c)
te
Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
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.
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.
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]
LIBUMEM 3LIB "February 23, 2020"
NAME
libumem - object-caching memory allocation library
SYNOPSIS
cc [ flag... ] file... -lumem [ library... ]
#include <umem.h>
DESCRIPTION
Functions in this library provide fast, scalable object-caching memory allocation with multithreaded application support. In addition to the standard malloc(3C) family of functions and the more flexible umem_alloc(3MALLOC) family, libumem provides powerful object-caching services as described in umem_cache_create(3MALLOC).

The libumem library also provides extensive debugging support, including detection of memory leaks, buffer overruns, multiple frees, use of uninitialized data, use of freed data, and many other common programming errors. See umem_debug(3MALLOC).

INTERFACES
The shared object libumem.so.1 provides the public interfaces defined below. See Intro(3) for additional information on shared object interfaces.
calloc free
malloc memalign
realloc umem_alloc
umem_cache_alloc umem_cache_create
umem_cache_destroy umem_cache_free
umem_free umem_nofail_callback
umem_setmtbf umem_zalloc
valloc
FILES
/usr/lib/libumem.so.1

shared object

/usr/lib/64/libumem.so.1

64-bit shared object

ATTRIBUTES
See attributes(5) for descriptions of the following attributes:
ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Evolving
MT-Level MT-Safe
SEE ALSO
Intro(3), malloc(3C), umem_alloc(3MALLOC), umem_cache_create(3MALLOC), umem_debug(3MALLOC), umem_setmtbf(3MALLOC), attributes(5)