diff options
author | Peter Tribble <peter.tribble@gmail.com> | 2017-12-09 16:30:07 +0000 |
---|---|---|
committer | Robert Mustacchi <rm@joyent.com> | 2017-12-15 20:06:24 +0000 |
commit | a8feb7338362ea067733d5dd40f4365dd99c4d31 (patch) | |
tree | abf21bf836b94ff80bef7be2efa0b01309bea8f5 /usr/src | |
parent | bea2d2b818ffe6739ebe3d447f51007733f518ce (diff) | |
download | illumos-gate-a8feb7338362ea067733d5dd40f4365dd99c4d31.tar.gz |
8910 man pages should refer to our Modular Debugger Guide
Reviewed by: Toomas Soome <tsoome@me.com>
Reviewed by: Yuri Pankov <yuripv@gmx.com>
Approved by: Robert Mustacchi <rm@joyent.com>
Diffstat (limited to 'usr/src')
-rw-r--r-- | usr/src/man/man1/adb.1 | 13 | ||||
-rw-r--r-- | usr/src/man/man1/kmdb.1 | 24 | ||||
-rw-r--r-- | usr/src/man/man1/mdb.1 | 43 | ||||
-rw-r--r-- | usr/src/man/man1m/kadb.1m | 17 | ||||
-rw-r--r-- | usr/src/man/man3malloc/umem_alloc.3malloc | 17 | ||||
-rw-r--r-- | usr/src/man/man3malloc/umem_debug.3malloc | 13 |
6 files changed, 55 insertions, 72 deletions
diff --git a/usr/src/man/man1/adb.1 b/usr/src/man/man1/adb.1 index 49c687ba21..08e5f05a0c 100644 --- a/usr/src/man/man1/adb.1 +++ b/usr/src/man/man1/adb.1 @@ -3,7 +3,7 @@ .\" 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] -.TH ADB 1 "Nov 29, 2005" +.TH ADB 1 "Dec 9, 2017" .SH NAME adb \- general-purpose debugger .SH SYNOPSIS @@ -13,7 +13,6 @@ adb \- general-purpose debugger .fi .SH DESCRIPTION -.sp .LP The \fBadb\fR utility is an interactive, general-purpose debugger. It can be used to examine files and provides a controlled environment for the execution @@ -25,14 +24,16 @@ The \fBadb\fR utility is now implemented as a link to the \fBmdb\fR(1) utility. processes as well as the live operating system or operating system crash dumps. The new \fBmdb\fR(1) utility provides complete backwards compatibility with the existing syntax and features of \fBadb\fR, including support for processing -\fBadb\fR macro files. The \fISolaris Modular Debugger Guide\fR and -\fBmdb\fR(1) man page describes the features of \fBmdb\fR, including its +\fBadb\fR macro files. The \fIModular Debugger Guide\fR and +\fBmdb\fR(1) man page describe the features of \fBmdb\fR, including its \fBadb\fR compatibility mode. This mode will be activated by default when the \fBadb\fR link is executed. .SH SEE ALSO -.sp .LP \fBmdb\fR(1), \fBattributes\fR(5) .sp .LP -\fISolaris Modular Debugger Guide\fR +\fIModular Debugger Guide\fR: +.sp +.LP +https://illumos.org/books/mdb/ diff --git a/usr/src/man/man1/kmdb.1 b/usr/src/man/man1/kmdb.1 index c688045b59..29d69c1d46 100644 --- a/usr/src/man/man1/kmdb.1 +++ b/usr/src/man/man1/kmdb.1 @@ -3,12 +3,11 @@ .\" 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] -.TH KMDB 1 "May 3, 2007" +.TH KMDB 1 "Dec 9, 2017" .SH NAME kmdb \- in situ kernel debugger .SH SYNOPSIS .SS "Boot-time Loading" -.sp .LP SPARC .LP @@ -36,7 +35,6 @@ x86 .fi .SH DESCRIPTION -.sp .LP \fBkmdb\fR is an interactive kernel debugger which implements the user interface and functionality of \fBmdb\fR(1) in a live kernel context. @@ -49,9 +47,8 @@ This man page describes the features and functionality that are unique to \fBkmdb\fR or different in \fBkmdb\fR as compared to \fBmdb\fR(1). For more information on \fBmdb\fR(1) or further details on the features and functionality implemented by \fBkmdb\fR, see the \fBmdb\fR(1) man page and the -\fISolaris Modular Debugger Guide\fR. +\fIModular Debugger Guide\fR. .SS "Loading and Unloading" -.sp .ne 2 .na \fBBoot-time Loading\fR @@ -107,7 +104,6 @@ the value of the \fBTERM\fR environment variable unless overridden by the .RE .SS "Debugger Entry" -.sp .LP Debugger entry can be requested explicitly or implicitly. Implicit entry, encountered when breakpoints or other execution control features are used, is @@ -147,7 +143,6 @@ set nopanicdebug = 1 This can be useful if you want to keep \fBkmdb\fR loaded, but always want a panic to trigger a crash dump without entering the debugger. .SS "Execution Control" -.sp .LP For the most part, the execution control facilities provided by \fBkmdb\fR for the kernel mirror those provided by the \fBmdb\fR(1) process target. @@ -161,7 +156,6 @@ size, and type of watchpoints allowed. The \fB::wp\fR command does not allow a watchpoint to be created if it is incompatible with the watchpoints supported by the hardware. .SS "Debugger modules (dmods)" -.sp .LP As with \fBmdb\fR(1), \fBkmdb\fR is installed with a number of subsystem-specific debugger modules, or dmods. The dmods are loaded and @@ -176,7 +170,6 @@ is complete, the system is stopped and the debugger is automatically re-entered. For a dmod load, processing is completed when the load of a requested dmod succeeds or fails. Status messages are provided in either case. .SS "Processor-specific functionality" -.sp .LP Some functionality is specific to an individual processor type. An example of such functionality is the branch tracing provided by various x86 processors. @@ -188,14 +181,12 @@ Even though the debugger might provide support for a given processor type, the support is not exposed until the kernel has progressed to the point at which processor identification has completed. .SS "Kernel Macros" -.sp .LP The debugger provides access to a set of macros that are precompiled into the debugger. Only the precompiled macros are available . Unlike with \fBmdb\fR(1), the \fB$< dcmd\fR may not be used to load macros from arbitrary locations. Use the \fB$M\fR command to list the available macros. .SS "Built-in dcmds" -.sp .LP This section lists dcmds that are unique to \fBkmdb\fR or those with behavior that differs in \fBkmdb\fR as compared to \fBmdb\fR(1). @@ -438,7 +429,6 @@ callback string. If the string contains meta-characters, it must be quoted. .RE .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -454,20 +444,17 @@ Interface Stability Evolving .TE .SH SEE ALSO -.sp .LP -\fBmdb\fR(1), \fBboot\fR(1M), \fBdumpadm\fR(1M), \fBkernel\fR(1M), +\fBkbd\fR(1), \fBmdb\fR(1), \fBboot\fR(1M), \fBdumpadm\fR(1M), \fBkernel\fR(1M), \fBsystem\fR(4), \fBattributes\fR(5) .sp .LP -\fISolaris Modular Debugger Guide\fR -.SS "SPARC Only" +\fIModular Debugger Guide\fR: .sp .LP -\fBkbd\fR(1) +https://illumos.org/books/mdb/ .SH NOTES .SS "Limitations on Memory Available to the Debugger" -.sp .LP The memory region available to the debugger is allocated when the debugger is loaded, and is fixed at that point. If dcmds attempt to allocate more memory @@ -476,7 +463,6 @@ attempt to recover gracefully from an out-of-memory situation, but may be unable to, and may be forced to terminate the system. This constraint is especially acute on 32-bit x86 systems. .SS "Performance Impact" -.sp .LP System performance will be negatively impacted by the loading of \fBkmdb\fR, as the debugger will consume kernel memory and other limited system resources. diff --git a/usr/src/man/man1/mdb.1 b/usr/src/man/man1/mdb.1 index 4ff373e3dc..a4bb05a51e 100644 --- a/usr/src/man/man1/mdb.1 +++ b/usr/src/man/man1/mdb.1 @@ -4,7 +4,7 @@ .\" 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] -.TH MDB 1 "May 13, 2017" +.TH MDB 1 "Dec 9, 2017" .SH NAME mdb \- modular debugger .SH SYNOPSIS @@ -21,7 +21,7 @@ mdb \- modular debugger The \fBmdb\fR utility is an extensible utility for low-level debugging and editing of the live operating system, operating system crash dumps, user processes, user process core dumps, and object files. For a more detailed -description of \fBmdb\fR features, refer to the manual, \fISolaris Modular +description of \fBmdb\fR features, refer to the \fIModular Debugger Guide\fR. .sp .LP @@ -64,7 +64,7 @@ executes the corresponding dcmds. Each dcmd can also accept a list of string or numerical arguments, as shown in the syntax description below. \fBmdb\fR contains a set of built-in dcmds, described below, that are always available. You can also extend the capabilities of \fBmdb\fR itself by writing your own -dcmds, as described in the \fISolaris Modular Debugger Guide\fR. +dcmds, as described in the \fIModular Debugger Guide\fR. .sp .LP A \fIwalker\fR is a set of routines that describe how to walk, or iterate, @@ -79,16 +79,16 @@ A debugger module, or \fIdmod\fR (pronounced dee-mod), is a dynamically loaded library containing a set of dcmds and walkers. During initialization, \fBmdb\fR attempts to load dmods corresponding to the load objects present in the target. You can subsequently load or unload dmods at any time while running \fBmdb\fR. -\fBmdb\fR ships with a set of standard dmods for debugging the Solaris kernel. -The \fISolaris Modular Debugger Guide\fR contains more information on +\fBmdb\fR ships with a set of standard dmods for debugging the kernel. +The \fIModular Debugger Guide\fR contains more information on developing your own debugger modules. .sp .LP A \fImacro file\fR is a text file containing a set of commands to execute. Macro files are typically used to automate the process of displaying a simple data structure. \fBmdb\fR provides complete backward compatibility for the -execution of macro files written for \fBadb\fR(1), and the Solaris installation -includes a set of macro files for debugging the Solaris kernel that can be used +execution of macro files written for \fBadb\fR(1), and illumos +includes a set of macro files for debugging the kernel that can be used with either tool. .SS "Syntax" .LP @@ -726,7 +726,7 @@ in the target's virtual address space. A target can support multiple symbol tables including, but not limited to, a primary executable symbol table, a primary dynamic symbol table, a run-time link-editor symbol table, and standard and dynamic symbol tables for each of a number of load objects (such as shared -libraries in a user process, or kernel modules in the Solaris kernel). The +libraries in a user process, or kernel modules in the kernel). The target typically searches the primary executable's symbol tables first, and then one or more of the other symbol tables. Notice that \fBELF\fR symbol tables only contain entries for external, global, and static symbols; automatic @@ -1551,9 +1551,9 @@ to the corresponding named variable. .sp .LP The \fBmdb\fR kernel target exports the virtual address of the corresponding -internal thread structure as the identifier for a given thread. The \fISolaris -Modular Debugger Guide\fR provides more information on debugging support for -threads in the Solaris kernel. The \fBmdb\fR process target provides proper +internal thread structure as the identifier for a given thread. The \fIModular +Debugger Guide\fR provides more information on debugging support for +threads in the kernel. The \fBmdb\fR process target provides proper support for examination of multi-threaded user processes that use the native \fBlwp_*\fR interfaces, \fB/usr/lib/libthread.so\fR or \fB/usr/lib/lwp/libthread.so\fR. When debugging a live user process, \fBmdb\fR @@ -3663,7 +3663,7 @@ List the external data buffers exported by the current target. External data buffers represent information associated with the target that can not be accessed through standard target facilities (that is, an address space, symbol table, or register set). These buffers can be consumed by dcmds; for more -information, refer to the \fISolaris Modular Debugger Guide\fR. +information, refer to the \fIModular Debugger Guide\fR. .RE .sp @@ -4410,7 +4410,7 @@ Interface Stability Evolving .SH SEE ALSO .LP -\fBadb\fR(1), \fBcmdtool\fR(1), \fBgcore\fR(1), \fBproc\fR(1), \fBpgrep\fR(1), +\fBadb\fR(1), \fBgcore\fR(1), \fBproc\fR(1), \fBpgrep\fR(1), \fBps\fR(1), \fBstty\fR(1), \fBtruss\fR(1), \fBuname\fR(1), \fBcoreadm\fR(1M), \fBdumpadm\fR(1M), \fBlargefile\fR(5), \fBsavecore\fR(1M), \fBexec\fR(2), \fBfork\fR(2), \fB_lwp_self\fR(2), \fBpipe\fR(2), \fBvfork\fR(2), @@ -4423,7 +4423,10 @@ Interface Stability Evolving \fILinker and Libraries Guide\fR .sp .LP -\fISolaris Modular Debugger Guide\fR +\fIModular Debugger Guide\fR: +.sp +.LP +https://illumos.org/books/mdb/ .SH WARNINGS .SS "Use of the Error Recovery Mechanism" .LP @@ -4455,8 +4458,8 @@ Solaris 9, text sections and read-only data are included in core files by default. Users can configure their processes to exclude that information from core files using \fBcoreadm\fR(1M). Thus, the information presented by \fBmdb\fR for those core files can not match the data that was present at the -time the process dumped core. Core files from Solaris x86 systems can not be -examined on Solaris SPARC systems, and vice-versa. +time the process dumped core. Core files from x86 systems can not be +examined on SPARC systems, and vice-versa. .SS "Limitations on Examining Crash Dump Files" .LP Crash dumps from Solaris 7 and earlier releases can only be examined with the @@ -4464,8 +4467,8 @@ aid of the libkvm from the corresponding operating system release. If a crash dump from one operating system release is examined using the dmods from a different operating system release, changes in the kernel implementation can prevent some dcmds or walkers from working properly. \fBmdb\fR issues a warning -message if it detects this condition. Crash dumps from Solaris x86 systems can -not be examined on Solaris SPARC systems, and vice-versa. +message if it detects this condition. Crash dumps from x86 systems can +not be examined on SPARC systems, and vice-versa. .SS "Relationship Between 32-bit and 64-bit Debugger" .LP \fBmdb\fR provides support for debugging both 32-bit and 64-bit programs. Once @@ -4552,10 +4555,10 @@ left stopped and abandoned using the \fB::release\fR \fB-a\fR option. The \fB::list\fR, \fB::offsetof\fR, \fB::print\fR, and \fB::sizeof\fR dcmds require that one or more load objects contain compressed symbolic debugging information suitable for use with \fBmdb\fR. This information is currently only -available for certain Solaris kernel modules. +available for certain kernel modules. .SS "Developer Information" .LP -The \fISolaris Modular Debugger Guide\fR provides a more detailed description +The \fIModular Debugger Guide\fR provides a more detailed description of \fBmdb\fR features, as well as information for debugger module developers. .sp .LP diff --git a/usr/src/man/man1m/kadb.1m b/usr/src/man/man1m/kadb.1m index eb60061636..25a2089f0e 100644 --- a/usr/src/man/man1m/kadb.1m +++ b/usr/src/man/man1m/kadb.1m @@ -3,7 +3,7 @@ .\" 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] -.TH KADB 1M "Jul 2, 2004" +.TH KADB 1M "Dec 9, 2017" .SH NAME kadb \- a kernel debugger .SH SYNOPSIS @@ -20,7 +20,6 @@ kadb \- a kernel debugger .fi .SH DESCRIPTION -.sp .LP \fBkadb\fR, an interactive kernel debugger, has been replaced by \fBkmdb\fR(1). For backwards compatibility, the methods used to load \fBkadb\fR will be @@ -36,10 +35,9 @@ differences between \fBmdb\fR and \fBkmdb\fR. This man page describes the major changes and incompatibilities between \fBkadb\fR and \fBkmdb\fR. .sp .LP -Consult the \fISolaris Modular Debugger Guide\fR for a detailed description of +Consult the \fIModular Debugger Guide\fR for a detailed description of both \fBmdb\fR and \fBkmdb\fR. .SS "Major changes" -.sp .LP This section briefly lists the major differences between \fBkadb\fR and \fBkmdb\fR. It is not intended to be exhaustive. @@ -72,13 +70,12 @@ been changed. .RE .SS "Significant Incompatibilities" -.sp .LP This section lists the significant features that have changed incompatibly between \fBkadb\fR and \fBkmdb\fR(1). It is not intended to be exhaustive. All \fBkmdb\fR(1) commands referenced here are fully described in the \fBkmdb\fR(1) -man page. A description as well as examples can be found in the \fISolaris -Modular Debugger Guide\fR. +man page. A description as well as examples can be found in the \fIModular +Debugger Guide\fR. .sp .ne 2 .na @@ -117,9 +114,11 @@ port sizes supported by \fBkadb\fR. .RE .SH SEE ALSO -.sp .LP \fBadb\fR(1), \fBmdb\fR(1), \fBkmdb\fR(1), \fBattributes\fR(5) .sp .LP -\fISolaris Modular Debugger Guide\fR +\fIModular Debugger Guide\fR: +.sp +.LP +https://illumos.org/books/mdb/ diff --git a/usr/src/man/man3malloc/umem_alloc.3malloc b/usr/src/man/man3malloc/umem_alloc.3malloc index d8680ca083..4ef98da14f 100644 --- a/usr/src/man/man3malloc/umem_alloc.3malloc +++ b/usr/src/man/man3malloc/umem_alloc.3malloc @@ -4,7 +4,7 @@ .\" 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] -.TH UMEM_ALLOC 3MALLOC "Mar 24, 2008" +.TH UMEM_ALLOC 3MALLOC "Dec 9, 2017" .SH NAME umem_alloc, umem_zalloc, umem_free, umem_nofail_callback \- fast, scalable memory allocation @@ -63,7 +63,6 @@ cc [ \fIflag \&.\|.\|.\fR ] \fIfile\fR\&.\|.\|. \fB-lumem\fR [ \fIlibrary \&.\|. .fi .SH DESCRIPTION -.sp .LP The \fBumem_alloc()\fR function returns a pointer to a block of \fIsize\fR bytes suitably aligned for any variable type. The initial contents of memory @@ -109,8 +108,8 @@ callback with \fBUMEM_CALLBACK_EXIT\fR(\fIstatus\fR), one will call .ie t \(bu .el o invoking a context-changing function (\fBsetcontext\fR(2)) or a non-local jump -(\fBlongjmp\fR(3C) or \fBsiglongjmp\fR(3C), or ending the current thread of -control (\fBthr_exit\fR(3C) or \fBpthread_exit\fR(3C). The application is +(\fBlongjmp\fR(3C) or \fBsiglongjmp\fR(3C)), or ending the current thread of +control (\fBthr_exit\fR(3C) or \fBpthread_exit\fR(3C)). The application is responsible for any necessary cleanup. The state of \fBlibumem\fR remains consistent. .RE @@ -147,7 +146,6 @@ The \fBmalloc()\fR, \fBcalloc()\fR, \fBfree()\fR, \fBmemalign()\fR, \fBmalloc\fR(3C). The \fBlibumem\fR library provides these functions for backwards-compatibility with the standard functions. .SH ENVIRONMENT VARIABLES -.sp .LP See \fBumem_debug\fR(3MALLOC) for environment variables that effect the debugging features of the \fBlibumem\fR library. @@ -350,7 +348,6 @@ if (status == NULL) { .in -2 .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -374,7 +371,6 @@ Standard See below. For \fBmalloc()\fR, \fBcalloc()\fR, \fBfree()\fR, \fBrealloc()\fR, and \fBvalloc()\fR, see \fBstandards\fR(5). .SH SEE ALSO -.sp .LP \fBexit\fR(2), \fBmmap\fR(2), \fBsbrk\fR(2), \fBbsdmalloc\fR(3MALLOC), \fBlibumem\fR(3LIB), \fBlongjmp\fR(3C), \fBmalloc\fR(3C), @@ -384,10 +380,12 @@ For \fBmalloc()\fR, \fBcalloc()\fR, \fBfree()\fR, \fBrealloc()\fR, and \fBstandards\fR(5) .sp .LP -\fISolaris Modular Debugger Guide\fR -.SH WARNINGS +\fIModular Debugger Guide\fR: .sp .LP +https://illumos.org/books/mdb/ +.SH WARNINGS +.LP Any of the following can cause undefined results: .RS +4 .TP @@ -421,7 +419,6 @@ Performing \fBUMEM_NOFAIL\fR allocations from an \fBatexit\fR(3C) handler. If the \fBUMEM_NOFAIL\fR callback performs \fBUMEM_NOFAIL\fR allocations, infinite recursion can occur. .SH NOTES -.sp .LP The following list compares the features of the \fBmalloc\fR(3C), \fBbsdmalloc\fR(3MALLOC), \fBmalloc\fR(3MALLOC), \fBmtmalloc\fR(3MALLOC) , and diff --git a/usr/src/man/man3malloc/umem_debug.3malloc b/usr/src/man/man3malloc/umem_debug.3malloc index 9d308f2156..89fda62a80 100644 --- a/usr/src/man/man3malloc/umem_debug.3malloc +++ b/usr/src/man/man3malloc/umem_debug.3malloc @@ -3,7 +3,7 @@ .\" 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] -.TH UMEM_DEBUG 3MALLOC "Jul 26, 2002" +.TH UMEM_DEBUG 3MALLOC "Dec 9, 2017" .SH NAME umem_debug \- debugging features of the umem library .SH SYNOPSIS @@ -14,7 +14,6 @@ umem_debug \- debugging features of the umem library .fi .SH DESCRIPTION -.sp .LP The \fBlibumem\fR library provides debugging features that detect memory leaks, buffer overruns, multiple frees, use of uninitialized data, use of freed data, @@ -26,7 +25,6 @@ When the library detects an error, it writes a description of the error to an internal buffer that is readable with the \fB::umem_status\fR \fBmdb\fR(1) \fIdcmd\fR and then calls \fBabort\fR(3C). .SH ENVIRONMENT VARIABLES -.sp .ne 2 .na \fB\fBUMEM_DEBUG\fR\fR @@ -168,7 +166,6 @@ cannot be allocated. .RE .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -186,21 +183,21 @@ MT-Level MT-Safe .TE .SH SEE ALSO -.sp .LP \fBmdb\fR(1), \fBabort\fR(3C), \fBsignal\fR(3C), \fBumem_cache_create\fR(3MALLOC), \fBattributes\fR(5) .sp .LP -\fISolaris Modular Debugger Guide\fR -.SH WARNINGS +\fIModular Debugger Guide\fR: .sp .LP +https://illumos.org/books/mdb/ +.SH WARNINGS +.LP When \fBlibumem\fR aborts the process using \fBabort\fR(3C), any existing signal handler for \fBSIGABRT\fR is called. If the signal handler performs allocations, undefined behavior can result. .SH NOTES -.sp .LP Some of the debugging features work only for allocations smaller than 16 kilobytes in size. Allocations larger than 16 kilobytes could have reduced |