OSDN Git Service

Retire LDP man-pages repository
[linuxjm/LDP_man-pages.git] / original / man3 / malloc_get_state.3
diff --git a/original/man3/malloc_get_state.3 b/original/man3/malloc_get_state.3
deleted file mode 100644 (file)
index d5e94dc..0000000
+++ /dev/null
@@ -1,122 +0,0 @@
-.\" Copyright (c) 2012 by Michael Kerrisk <mtk.manpages@gmail.com>
-.\"
-.\" %%%LICENSE_START(VERBATIM)
-.\" Permission is granted to make and distribute verbatim copies of this
-.\" manual provided the copyright notice and this permission notice are
-.\" preserved on all copies.
-.\"
-.\" Permission is granted to copy and distribute modified versions of this
-.\" manual under the conditions for verbatim copying, provided that the
-.\" entire resulting derived work is distributed under the terms of a
-.\" permission notice identical to this one.
-.\"
-.\" Since the Linux kernel and libraries are constantly changing, this
-.\" manual page may be incorrect or out-of-date.  The author(s) assume no
-.\" responsibility for errors or omissions, or for damages resulting from
-.\" the use of the information contained herein.  The author(s) may not
-.\" have taken the same level of care in the production of this manual,
-.\" which is licensed free of charge, as they might when working
-.\" professionally.
-.\"
-.\" Formatted or processed versions of this manual, if unaccompanied by
-.\" the source, must acknowledge the copyright and authors of this work.
-.\" %%%LICENSE_END
-.\"
-.TH MALLOC_GET_STATE 3 2014-06-13 "GNU" "Linux Programmer's Manual"
-.SH NAME
-malloc_get_state, malloc_set_state \- record and restore state of malloc implementation
-.SH SYNOPSIS
-.nf
-.B #include <malloc.h>
-.sp
-.BI "void* malloc_get_state(void);"
-
-.BI "int malloc_set_state(void *" state );
-.fi
-.SH DESCRIPTION
-The
-.BR malloc_get_state ()
-function records the current state of all
-.BR malloc (3)
-internal bookkeeping variables
-(but not the actual contents of the heap
-or the state of
-.BR malloc_hook (3)
-functions pointers).
-The state is recorded in a system-dependent opaque data structure
-dynamically allocated via
-.BR malloc (3),
-and a pointer to that data structure is returned as the function result.
-(It is the caller's responsibility to
-.BR free (3)
-this memory.)
-
-The
-.BR malloc_set_state ()
-function restores the state of all
-.BR malloc (3)
-internal bookkeeping variables to the values recorded in
-the opaque data structure pointed to by
-.IR state .
-.SH RETURN VALUE
-On success,
-.BR malloc_get_state ()
-returns a pointer to a newly allocated opaque data structure.
-On error (for example, memory could not be allocated for the data structure),
-.BR malloc_get_state ()
-returns NULL.
-
-On success,
-.BR malloc_set_state ()
-returns 0.
-If the implementation detects that
-.I state
-does not point to a correctly formed data structure,
-.\" if(ms->magic != MALLOC_STATE_MAGIC) return -1;
-.BR malloc_set_state ()
-returns \-1.
-If the implementation detects that
-the version of the data structure referred to by
-.I state
-is a more recent version than this implementation knows about,
-.\" /* Must fail if the major version is too high. */
-.\" if((ms->version & ~0xffl) > (MALLOC_STATE_VERSION & ~0xffl)) return -2;
-.BR malloc_set_state ()
-returns \-2.
-.SH CONFORMING TO
-These functions are GNU extensions.
-.SH NOTES
-These functions are useful when using this
-.BR malloc (3)
-implementation as part of a shared library,
-and the heap contents are saved/restored via some other method.
-This technique is used by GNU Emacs to implement its "dumping" function.
-
-Hook function pointers are never saved or restored by these
-functions, with two exceptions:
-if malloc checking (see
-.BR mallopt (3))
-was in use when
-.BR malloc_get_state ()
-was called, then
-.BR malloc_set_state ()
-resets malloc checking hooks
-.\" i.e., calls __malloc_check_init()
-if possible;
-.\" i.e., malloc checking is not already in use
-.\" and the caller requested malloc checking
-if malloc checking was not in use in the recorded state,
-but the caller has requested malloc checking,
-then the hooks are reset to 0.
-.SH SEE ALSO
-.BR malloc (3),
-.BR mallopt (3)
-.SH COLOPHON
-This page is part of release 3.79 of the Linux
-.I man-pages
-project.
-A description of the project,
-information about reporting bugs,
-and the latest version of this page,
-can be found at
-\%http://www.kernel.org/doc/man\-pages/.