man/mann/memory.n - toolchains/skids - Git at Google

 '\"
 '\" Copyright (c) 1992-1999 by Karl Lehenbauer and Mark Diekhans
 '\" Copyright (c) 2000 by Scriptics Corporation.
 '\" All rights reserved.
 '\"
 '\" RCS: @(#) $Id: memory.n,v 1.4 2001/12/28 23:36:31 dgp Exp $
 '\"
 '\" The definitions below are for supplemental macros used in Tcl/Tk
 '\" manual entries.
 '\"
 '\" .AP type name in/out ?indent?
 '\"	Start paragraph describing an argument to a library procedure.
 '\"	type is type of argument (int, etc.), in/out is either "in", "out",
 '\"	or "in/out" to describe whether procedure reads or modifies arg,
 '\"	and indent is equivalent to second arg of .IP (shouldn't ever be
 '\"	needed;  use .AS below instead)
 '\"
 '\" .AS ?type? ?name?
 '\"	Give maximum sizes of arguments for setting tab stops.  Type and
 '\"	name are examples of largest possible arguments that will be passed
 '\"	to .AP later.  If args are omitted, default tab stops are used.
 '\"
 '\" .BS
 '\"	Start box enclosure.  From here until next .BE, everything will be
 '\"	enclosed in one large box.
 '\"
 '\" .BE
 '\"	End of box enclosure.
 '\"
 '\" .CS
 '\"	Begin code excerpt.
 '\"
 '\" .CE
 '\"	End code excerpt.
 '\"
 '\" .VS ?version? ?br?
 '\"	Begin vertical sidebar, for use in marking newly-changed parts
 '\"	of man pages.  The first argument is ignored and used for recording
 '\"	the version when the .VS was added, so that the sidebars can be
 '\"	found and removed when they reach a certain age.  If another argument
 '\"	is present, then a line break is forced before starting the sidebar.
 '\"
 '\" .VE
 '\"	End of vertical sidebar.
 '\"
 '\" .DS
 '\"	Begin an indented unfilled display.
 '\"
 '\" .DE
 '\"	End of indented unfilled display.
 '\"
 '\" .SO
 '\"	Start of list of standard options for a Tk widget.  The
 '\"	options follow on successive lines, in four columns separated
 '\"	by tabs.
 '\"
 '\" .SE
 '\"	End of list of standard options for a Tk widget.
 '\"
 '\" .OP cmdName dbName dbClass
 '\"	Start of description of a specific option.  cmdName gives the
 '\"	option's name as specified in the class command, dbName gives
 '\"	the option's name in the option database, and dbClass gives
 '\"	the option's class in the option database.
 '\"
 '\" .UL arg1 arg2
 '\"	Print arg1 underlined, then print arg2 normally.
 '\"
 '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
 '\"
 '\"	# Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
 .if t .wh -1.3i ^B
 .nr ^l \n(.l
 .ad b
 '\"	# Start an argument description
 .de AP
 .ie !"\\$4"" .TP \\$4
 .el \{\
 .   ie !"\\$2"" .TP \\n()Cu
 .   el          .TP 15
 .\}
 .ta \\n()Au \\n()Bu
 .ie !"\\$3"" \{\
 \&\\$1	\\fI\\$2\\fP	(\\$3)
 .\".b
 .\}
 .el \{\
 .br
 .ie !"\\$2"" \{\
 \&\\$1	\\fI\\$2\\fP
 .\}
 .el \{\
 \&\\fI\\$1\\fP
 .\}
 .\}
 ..
 '\"	# define tabbing values for .AP
 .de AS
 .nr )A 10n
 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
 .nr )B \\n()Au+15n
 .\"
 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 .nr )C \\n()Bu+\\w'(in/out)'u+2n
 ..
 .AS Tcl_Interp Tcl_CreateInterp in/out
 '\"	# BS - start boxed text
 '\"	# ^y = starting y location
 '\"	# ^b = 1
 .de BS
 .br
 .mk ^y
 .nr ^b 1u
 .if n .nf
 .if n .ti 0
 .if n \l'\\n(.lu\(ul'
 .if n .fi
 ..
 '\"	# BE - end boxed text (draw box now)
 .de BE
 .nf
 .ti 0
 .mk ^t
 .ie n \l'\\n(^lu\(ul'
 .el \{\
 .\"	Draw four-sided box normally, but don't draw top of
 .\"	box if the box started on an earlier page.
 .ie !\\n(^b-1 \{\
 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 .\}
 .el \}\
 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 .\}
 .\}
 .fi
 .br
 .nr ^b 0
 ..
 '\"	# VS - start vertical sidebar
 '\"	# ^Y = starting y location
 '\"	# ^v = 1 (for troff;  for nroff this doesn't matter)
 .de VS
 .if !"\\$2"" .br
 .mk ^Y
 .ie n 'mc \s12\(br\s0
 .el .nr ^v 1u
 ..
 '\"	# VE - end of vertical sidebar
 .de VE
 .ie n 'mc
 .el \{\
 .ev 2
 .nf
 .ti 0
 .mk ^t
 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 .sp -1
 .fi
 .ev
 .\}
 .nr ^v 0
 ..
 '\"	# Special macro to handle page bottom:  finish off current
 '\"	# box/sidebar if in box/sidebar mode, then invoked standard
 '\"	# page bottom macro.
 .de ^B
 .ev 2
 'ti 0
 'nf
 .mk ^t
 .if \\n(^b \{\
 .\"	Draw three-sided box if this is the box's first page,
 .\"	draw two sides but no top otherwise.
 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 .\}
 .if \\n(^v \{\
 .nr ^x \\n(^tu+1v-\\n(^Yu
 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 .\}
 .bp
 'fi
 .ev
 .if \\n(^b \{\
 .mk ^y
 .nr ^b 2
 .\}
 .if \\n(^v \{\
 .mk ^Y
 .\}
 ..
 '\"	# DS - begin display
 .de DS
 .RS
 .nf
 .sp
 ..
 '\"	# DE - end display
 .de DE
 .fi
 .RE
 .sp
 ..
 '\"	# SO - start of list of standard options
 .de SO
 .SH "STANDARD OPTIONS"
 .LP
 .nf
 .ta 5.5c 11c
 .ft B
 ..
 '\"	# SE - end of list of standard options
 .de SE
 .fi
 .ft R
 .LP
 See the \\fBoptions\\fR manual entry for details on the standard options.
 ..
 '\"	# OP - start of full description for a single option
 .de OP
 .LP
 .nf
 .ta 4c
 Command-Line Name:	\\fB\\$1\\fR
 Database Name:	\\fB\\$2\\fR
 Database Class:	\\fB\\$3\\fR
 .fi
 .IP
 ..
 '\"	# CS - begin code excerpt
 .de CS
 .RS
 .nf
 .ta .25i .5i .75i 1i
 ..
 '\"	# CE - end code excerpt
 .de CE
 .fi
 .RE
 ..
 .de UL
 \\$1\l'|0\(ul'\\$2
 ..
 .TH memory n 8.1 Tcl "Tcl Built-In Commands"
 .BS
 .SH NAME
 memory \- Control Tcl memory debugging capabilities.
 .SH SYNOPSIS
 \fBmemory \fIoption \fR?\fIarg arg ...\fR?

 .SH DESCRIPTION
 .PP
 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), 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
 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
 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.
 .RE
 .TP
 \fBmemory trace_on_at_malloc\fR \fIcount\fR
 Enable memory tracing after \fIcount\fR \fBckalloc\fR's have been performed.
 For example, if you enter \fBmemory trace_on_at_malloc 100\fR,
 after the 100th call to \fBckalloc\fR, memory trace information will begin
 being displayed for all allocations and frees.  Since there can be a lot
 of memory activity before a problem occurs, judicious use of this option
 can reduce the slowdown caused by tracing (and the amount of trace information
 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 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

 .SH KEYWORDS
 memory, debug
	'\"
	'\" Copyright (c) 1992-1999 by Karl Lehenbauer and Mark Diekhans
	'\" Copyright (c) 2000 by Scriptics Corporation.
	'\" All rights reserved.
	'\"
	'\" RCS: @(#) $Id: memory.n,v 1.4 2001/12/28 23:36:31 dgp Exp $
	'\"
	'\" The definitions below are for supplemental macros used in Tcl/Tk
	'\" manual entries.
	'\"
	'\" .AP type name in/out ?indent?
	'\" Start paragraph describing an argument to a library procedure.
	'\" type is type of argument (int, etc.), in/out is either "in", "out",
	'\" or "in/out" to describe whether procedure reads or modifies arg,
	'\" and indent is equivalent to second arg of .IP (shouldn't ever be
	'\" needed; use .AS below instead)
	'\"
	'\" .AS ?type? ?name?
	'\" Give maximum sizes of arguments for setting tab stops. Type and
	'\" name are examples of largest possible arguments that will be passed
	'\" to .AP later. If args are omitted, default tab stops are used.
	'\"
	'\" .BS
	'\" Start box enclosure. From here until next .BE, everything will be
	'\" enclosed in one large box.
	'\"
	'\" .BE
	'\" End of box enclosure.
	'\"
	'\" .CS
	'\" Begin code excerpt.
	'\"
	'\" .CE
	'\" End code excerpt.
	'\"
	'\" .VS ?version? ?br?
	'\" Begin vertical sidebar, for use in marking newly-changed parts
	'\" of man pages. The first argument is ignored and used for recording
	'\" the version when the .VS was added, so that the sidebars can be
	'\" found and removed when they reach a certain age. If another argument
	'\" is present, then a line break is forced before starting the sidebar.
	'\"
	'\" .VE
	'\" End of vertical sidebar.
	'\"
	'\" .DS
	'\" Begin an indented unfilled display.
	'\"
	'\" .DE
	'\" End of indented unfilled display.
	'\"
	'\" .SO
	'\" Start of list of standard options for a Tk widget. The
	'\" options follow on successive lines, in four columns separated
	'\" by tabs.
	'\"
	'\" .SE
	'\" End of list of standard options for a Tk widget.
	'\"
	'\" .OP cmdName dbName dbClass
	'\" Start of description of a specific option. cmdName gives the
	'\" option's name as specified in the class command, dbName gives
	'\" the option's name in the option database, and dbClass gives
	'\" the option's class in the option database.
	'\"
	'\" .UL arg1 arg2
	'\" Print arg1 underlined, then print arg2 normally.
	'\"
	'\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
	'\"
	'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
	.if t .wh -1.3i ^B
	.nr ^l \n(.l
	.ad b
	'\" # Start an argument description
	.de AP
	.ie !"\\$4"" .TP \\$4
	.el \{\
	. ie !"\\$2"" .TP \\n()Cu
	. el .TP 15
	.\}
	.ta \\n()Au \\n()Bu
	.ie !"\\$3"" \{\
	\&\\$1 \\fI\\$2\\fP (\\$3)
	.\".b
	.\}
	.el \{\
	.br
	.ie !"\\$2"" \{\
	\&\\$1 \\fI\\$2\\fP
	.\}
	.el \{\
	\&\\fI\\$1\\fP
	.\}
	.\}
	..
	'\" # define tabbing values for .AP
	.de AS
	.nr )A 10n
	.if !"\\$1"" .nr )A \\w'\\$1'u+3n
	.nr )B \\n()Au+15n
	.\"
	.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
	.nr )C \\n()Bu+\\w'(in/out)'u+2n
	..
	.AS Tcl_Interp Tcl_CreateInterp in/out
	'\" # BS - start boxed text
	'\" # ^y = starting y location
	'\" # ^b = 1
	.de BS
	.br
	.mk ^y
	.nr ^b 1u
	.if n .nf
	.if n .ti 0
	.if n \l'\\n(.lu\(ul'
	.if n .fi
	..
	'\" # BE - end boxed text (draw box now)
	.de BE
	.nf
	.ti 0
	.mk ^t
	.ie n \l'\\n(^lu\(ul'
	.el \{\
	.\" Draw four-sided box normally, but don't draw top of
	.\" box if the box started on an earlier page.
	.ie !\\n(^b-1 \{\
	\h'-1.5n'\L'\|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'\|0u-1.5n\(ul'
	.\}
	.el \}\
	\h'-1.5n'\L'\|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'\|0u-1.5n\(ul'
	.\}
	.\}
	.fi
	.br
	.nr ^b 0
	..
	'\" # VS - start vertical sidebar
	'\" # ^Y = starting y location
	'\" # ^v = 1 (for troff; for nroff this doesn't matter)
	.de VS
	.if !"\\$2"" .br
	.mk ^Y
	.ie n 'mc \s12\(br\s0
	.el .nr ^v 1u
	..
	'\" # VE - end of vertical sidebar
	.de VE
	.ie n 'mc
	.el \{\
	.ev 2
	.nf
	.ti 0
	.mk ^t
	\h'\|\\n(^lu+3n'\L'\|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-\|\\n(^lu+3n'
	.sp -1
	.fi
	.ev
	.\}
	.nr ^v 0
	..
	'\" # Special macro to handle page bottom: finish off current
	'\" # box/sidebar if in box/sidebar mode, then invoked standard
	'\" # page bottom macro.
	.de ^B
	.ev 2
	'ti 0
	'nf
	.mk ^t
	.if \\n(^b \{\
	.\" Draw three-sided box if this is the box's first page,
	.\" draw two sides but no top otherwise.
	.ie !\\n(^b-1 \h'-1.5n'\L'\|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'\|0u'\c
	.el \h'-1.5n'\L'\|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'\|0u'\c
	.\}
	.if \\n(^v \{\
	.nr ^x \\n(^tu+1v-\\n(^Yu
	\kx\h'-\\nxu'\h'\|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'\|0u'\c
	.\}
	.bp
	'fi
	.ev
	.if \\n(^b \{\
	.mk ^y
	.nr ^b 2
	.\}
	.if \\n(^v \{\
	.mk ^Y
	.\}
	..
	'\" # DS - begin display
	.de DS
	.RS
	.nf
	.sp
	..
	'\" # DE - end display
	.de DE
	.fi
	.RE
	.sp
	..
	'\" # SO - start of list of standard options
	.de SO
	.SH "STANDARD OPTIONS"
	.LP
	.nf
	.ta 5.5c 11c
	.ft B
	..
	'\" # SE - end of list of standard options
	.de SE
	.fi
	.ft R
	.LP
	See the \\fBoptions\\fR manual entry for details on the standard options.
	..
	'\" # OP - start of full description for a single option
	.de OP
	.LP
	.nf
	.ta 4c
	Command-Line Name: \\fB\\$1\\fR
	Database Name: \\fB\\$2\\fR
	Database Class: \\fB\\$3\\fR
	.fi
	.IP
	..
	'\" # CS - begin code excerpt
	.de CS
	.RS
	.nf
	.ta .25i .5i .75i 1i
	..
	'\" # CE - end code excerpt
	.de CE
	.fi
	.RE
	..
	.de UL
	\\$1\l'\|0\(ul'\\$2
	..
	.TH memory n 8.1 Tcl "Tcl Built-In Commands"
	.BS
	.SH NAME
	memory \- Control Tcl memory debugging capabilities.
	.SH SYNOPSIS
	\fBmemory \fIoption \fR?\fIarg arg ...\fR?

	.SH DESCRIPTION
	.PP
	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), 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
	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
	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.
	.RE
	.TP
	\fBmemory trace_on_at_malloc\fR \fIcount\fR
	Enable memory tracing after \fIcount\fR \fBckalloc\fR's have been performed.
	For example, if you enter \fBmemory trace_on_at_malloc 100\fR,
	after the 100th call to \fBckalloc\fR, memory trace information will begin
	being displayed for all allocations and frees. Since there can be a lot
	of memory activity before a problem occurs, judicious use of this option
	can reduce the slowdown caused by tracing (and the amount of trace information
	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 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

	.SH KEYWORDS
	memory, debug