diff options
Diffstat (limited to 'doc/memory.n')
| -rw-r--r-- | doc/memory.n | 67 |
1 files changed, 43 insertions, 24 deletions
diff --git a/doc/memory.n b/doc/memory.n index 1a9f888..e5033c7 100644 --- a/doc/memory.n +++ b/doc/memory.n @@ -3,7 +3,7 @@ '\" Copyright (c) 2000 by Scriptics Corporation. '\" All rights reserved. '\" -'\" RCS: @(#) $Id: memory.n,v 1.3 2000/09/07 14:27:49 poenitz Exp $ +'\" RCS: @(#) $Id: memory.n,v 1.4 2001/12/28 23:36:31 dgp Exp $ '\" .so man.macros .TH memory n 8.1 Tcl "Tcl Built-In Commands" @@ -19,15 +19,42 @@ The \fBmemory\fR command gives the Tcl developer control of Tcl's memory debugging capabilities. The memory command has several suboptions, which are described below. It is only available when Tcl has been compiled with memory debugging enabled (when \fBTCL_MEM_DEBUG\fR is defined at -compile time). +compile time), and after \fBTcl_InitMemory\fR has been called. +.TP +\fBmemory active\fR \fIfile\fR +Write a list of all currently allocated memory to the specified \fIfile\fR. +.TP +\fBmemory break_on_malloc\fR \fIcount\fR +After the \fIcount\fR allocations have been performed, \fBckalloc\fR +outputs a message to this effect and that it is now attempting to enter +the C debugger. Tcl will then issue a \fISIGINT\fR signal against itself. +If you are running Tcl under a C debugger, it should then enter the debugger +command mode. .TP \fBmemory info\fR -Produces a report containing the total allocations and frees since +Returns a report containing the total allocations and frees since Tcl began, the current packets allocated (the current number of calls to \fBckalloc\fR not met by a corresponding call to \fBckfree\fR), the current bytes allocated, and the maximum number of packets and bytes allocated. .TP +\fB memory init [on|off]\fR +Turn on or off the pre-initialization of all allocated memory +with bogus bytes. Useful for detecting the use of uninitialized values. +.TP +\fBmemory onexit\fR \fIfile\fR +Causes a list of all allocated memory to be written to the specified \fIfile\fR +during the finalization of Tcl's memory subsystem. Useful for checking +that memory is properly cleaned up during process exit. +.TP +\fBmemory tag\fR \fIstring\fR +Each packet of memory allocated by \fBckalloc\fR can have associated +with it a string-valued tag. In the lists of allocated memory generated +by \fBmemory active\fR and \fBmemory onexit\fR, the tag for each packet +is printed along with other information about the packet. The +\fBmemory tag\fR command sets the tag value for subsequent calls +to \fBckalloc\fR to be \fIstring\fR. +.TP \fBmemory trace [on|off]\fR .br Turns memory tracing on or off. When memory tracing is on, every call @@ -35,22 +62,12 @@ to \fBckalloc\fR causes a line of trace information to be written to \fIstderr\fR, consisting of the word \fIckalloc\fR, followed by the address returned, the amount of memory allocated, and the C filename and line number of the code performing the allocation. For example: +.RS .CS ckalloc 40e478 98 tclProc.c 1406 .CE Calls to \fBckfree\fR are traced in the same manner. -.TP -\fBmemory validate [on|off]\fR -Turns memory validation on or off. When memory validation is enabled, -on every call to \fBckalloc\fR or \fBckfree\fR, the guard zones are -checked for every piece of memory currently in existence that was -allocated by \fBckalloc\fR. This has a large performance impact and -should only be used when overwrite problems are strongly suspected. -The advantage of enabling memory validation is that a guard zone -overwrite can be detected on the first call to \fBckalloc\fR or -\fBckfree\fR after the overwrite occurred, rather than when the -specific memory with the overwritten guard zone(s) is freed, which may -occur long after the overwrite occurred. +.RE .TP \fBmemory trace_on_at_malloc\fR \fIcount\fR Enable memory tracing after \fIcount\fR \fBckalloc\fR's have been performed. @@ -63,15 +80,17 @@ produced), if you can identify a number of allocations that occur before the problem sets in. The current number of memory allocations that have occurred since Tcl started is printed on a guard zone failure. .TP -\fBmemory break_on_malloc\fR \fIcount\fR -After the \fBcount\fR allocations have been performed, \fBckalloc\fR's -output a message to this effect and that it is now attempting to enter -the C debugger. Tcl will then issue a \fISIGINT\fR signal against itself. -If you are running Tcl under a C debugger, it should then enter the debugger -command mode. -.TP -\fB memory display\fR \fIfile\fR -Write a list of all currently allocated memory to the specified file. +\fBmemory validate [on|off]\fR +Turns memory validation on or off. When memory validation is enabled, +on every call to \fBckalloc\fR or \fBckfree\fR, the guard zones are +checked for every piece of memory currently in existence that was +allocated by \fBckalloc\fR. This has a large performance impact and +should only be used when overwrite problems are strongly suspected. +The advantage of enabling memory validation is that a guard zone +overwrite can be detected on the first call to \fBckalloc\fR or +\fBckfree\fR after the overwrite occurred, rather than when the +specific memory with the overwritten guard zone(s) is freed, which may +occur long after the overwrite occurred. .SH "SEE ALSO" ckalloc, ckfree, Tcl_ValidateAllMemory, Tcl_DumpActiveMemory, TCL_MEM_DEBUG |