[OpenSPARC-T2-SAM] / sam-t2 / devtools / amd64 / man / man3 / Tcl_InitMemory.3

'\"
'\" Copyright (c) 1992-1999 Karl Lehenbauer and Mark Diekhans.
'\" Copyright (c) 2000 by Scriptics Corporation.
'\" All rights reserved.
'\" 
'\" RCS: @(#) $Id: DumpActiveMemory.3,v 1.5 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 "Tcl_DumpActiveMemory" 3 8.1 Tcl "Tcl Library Procedures"
.BS
.SH NAME
Tcl_DumpActiveMemory, Tcl_InitMemory, Tcl_ValidateAllMemory \- Validated memory allocation interface.
.SH SYNOPSIS
.nf
\fB#include <tcl.h>\fR
.sp
int
\fBTcl_DumpActiveMemory\fR(\fIfileName\fR)
.sp
void
\fBTcl_InitMemory\fR(\fIinterp\fR)
.sp
void
\fBTcl_ValidateAllMemory\fR(\fIfileName, line\fR)

.SH ARGUMENTS
.AP Tcl_Interp *interp in
Tcl interpreter in which to add commands.
.AP "CONST char" *fileName in
For \fBTcl_DumpActiveMemory\fR, name of the file to which memory
information will be written.  For \fBTcl_ValidateAllMemory\fR, name of
the file from which the call is being made (normally \fB__FILE__\fR).
.AP int line in
Line number at which the call to \fBTcl_ValidateAllMemory\fR is made
(normally \fB__LINE__\fR).
.BE

.SH DESCRIPTION
These functions provide access to Tcl memory debugging information.
They are only functional when Tcl has been compiled with
\fBTCL_MEM_DEBUG\fR defined at compile-time.  When \fBTCL_MEM_DEBUG\fR
is not defined, these functions are all no-ops.
.PP 
\fBTcl_DumpActiveMemory\fR will output a list of all currently
allocated memory to the specified file.  The information output for
each allocated block of memory is:  starting and ending addresses
(excluding guard zone), size, source file where \fBckalloc\fR was
called to allocate the block and line number in that file.  It is
especially useful to call \fBTcl_DumpActiveMemory\fR after the Tcl
interpreter has been deleted.
.PP
\fBTcl_InitMemory\fR adds the Tcl \fBmemory\fR command to the
interpreter given by \fIinterp\fR.  \fBTcl_InitMemory\fR is called
by \fBTcl_Main\fR.
.PP
\fBTcl_ValidateAllMemory\fR forces a validation of the guard zones of
all currently allocated blocks of memory.  Normally validation of a
block occurs when its freed, unless full validation is enabled, in
which case validation of all blocks occurs when \fBckalloc\fR and
\fBckfree\fR are called.  This function forces the validation to occur
at any point.

.SH "SEE ALSO"
TCL_MEM_DEBUG, memory

.SH KEYWORDS
memory, debug
Commit	Line	Data
920dae64 AT	1	'\"
	2	'\" Copyright (c) 1992-1999 Karl Lehenbauer and Mark Diekhans.
	3	'\" Copyright (c) 2000 by Scriptics Corporation.
	4	'\" All rights reserved.
	5	'\"
	6	'\" RCS: @(#) $Id: DumpActiveMemory.3,v 1.5 2001/12/28 23:36:31 dgp Exp $
	7	'\"
	8	'\" The definitions below are for supplemental macros used in Tcl/Tk
	9	'\" manual entries.
	10	'\"
	11	'\" .AP type name in/out ?indent?
	12	'\" Start paragraph describing an argument to a library procedure.
	13	'\" type is type of argument (int, etc.), in/out is either "in", "out",
	14	'\" or "in/out" to describe whether procedure reads or modifies arg,
	15	'\" and indent is equivalent to second arg of .IP (shouldn't ever be
	16	'\" needed; use .AS below instead)
	17	'\"
	18	'\" .AS ?type? ?name?
	19	'\" Give maximum sizes of arguments for setting tab stops. Type and
	20	'\" name are examples of largest possible arguments that will be passed
	21	'\" to .AP later. If args are omitted, default tab stops are used.
	22	'\"
	23	'\" .BS
	24	'\" Start box enclosure. From here until next .BE, everything will be
	25	'\" enclosed in one large box.
	26	'\"
	27	'\" .BE
	28	'\" End of box enclosure.
	29	'\"
	30	'\" .CS
	31	'\" Begin code excerpt.
	32	'\"
	33	'\" .CE
	34	'\" End code excerpt.
	35	'\"
	36	'\" .VS ?version? ?br?
	37	'\" Begin vertical sidebar, for use in marking newly-changed parts
	38	'\" of man pages. The first argument is ignored and used for recording
	39	'\" the version when the .VS was added, so that the sidebars can be
	40	'\" found and removed when they reach a certain age. If another argument
	41	'\" is present, then a line break is forced before starting the sidebar.
	42	'\"
	43	'\" .VE
	44	'\" End of vertical sidebar.
	45	'\"
	46	'\" .DS
	47	'\" Begin an indented unfilled display.
	48	'\"
	49	'\" .DE
	50	'\" End of indented unfilled display.
	51	'\"
	52	'\" .SO
	53	'\" Start of list of standard options for a Tk widget. The
	54	'\" options follow on successive lines, in four columns separated
	55	'\" by tabs.
	56	'\"
	57	'\" .SE
	58	'\" End of list of standard options for a Tk widget.
	59	'\"
	60	'\" .OP cmdName dbName dbClass
	61	'\" Start of description of a specific option. cmdName gives the
	62	'\" option's name as specified in the class command, dbName gives
	63	'\" the option's name in the option database, and dbClass gives
	64	'\" the option's class in the option database.
65	'\"
66	'\" .UL arg1 arg2
67	'\" Print arg1 underlined, then print arg2 normally.
68	'\"
69	'\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
70	'\"
71	'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
72	.if t .wh -1.3i ^B
73	.nr ^l \n(.l
74	.ad b
75	'\" # Start an argument description
76	.de AP
77	.ie !"\\$4"" .TP \\$4
78	.el \{\
79	. ie !"\\$2"" .TP \\n()Cu
80	. el .TP 15
81	.\}
82	.ta \\n()Au \\n()Bu
83	.ie !"\\$3"" \{\
84	\&\\$1 \\fI\\$2\\fP (\\$3)
85	.\".b
86	.\}
87	.el \{\
88	.br
89	.ie !"\\$2"" \{\
90	\&\\$1 \\fI\\$2\\fP
91	.\}
92	.el \{\
93	\&\\fI\\$1\\fP
94	.\}
95	.\}
96	..
97	'\" # define tabbing values for .AP
98	.de AS
99	.nr )A 10n
100	.if !"\\$1"" .nr )A \\w'\\$1'u+3n
101	.nr )B \\n()Au+15n
102	.\"
103	.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
104	.nr )C \\n()Bu+\\w'(in/out)'u+2n
105	..
106	.AS Tcl_Interp Tcl_CreateInterp in/out
107	'\" # BS - start boxed text
108	'\" # ^y = starting y location
109	'\" # ^b = 1
110	.de BS
111	.br
112	.mk ^y
113	.nr ^b 1u
114	.if n .nf
115	.if n .ti 0
116	.if n \l'\\n(.lu\(ul'
117	.if n .fi
118	..
119	'\" # BE - end boxed text (draw box now)
120	.de BE
121	.nf
122	.ti 0
123	.mk ^t
124	.ie n \l'\\n(^lu\(ul'
125	.el \{\
126	.\" Draw four-sided box normally, but don't draw top of
127	.\" box if the box started on an earlier page.
128	.ie !\\n(^b-1 \{\
129	\h'-1.5n'\L'\|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'\|0u-1.5n\(ul'
130	.\}
131	.el \}\
132	\h'-1.5n'\L'\|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'\|0u-1.5n\(ul'
133	.\}
134	.\}
135	.fi
136	.br
137	.nr ^b 0
138	..
139	'\" # VS - start vertical sidebar
140	'\" # ^Y = starting y location
141	'\" # ^v = 1 (for troff; for nroff this doesn't matter)
142	.de VS
143	.if !"\\$2"" .br
144	.mk ^Y
145	.ie n 'mc \s12\(br\s0
146	.el .nr ^v 1u
147	..
148	'\" # VE - end of vertical sidebar
149	.de VE
150	.ie n 'mc
151	.el \{\
152	.ev 2
153	.nf
154	.ti 0
155	.mk ^t
156	\h'\|\\n(^lu+3n'\L'\|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-\|\\n(^lu+3n'
157	.sp -1
158	.fi
159	.ev
160	.\}
161	.nr ^v 0
162	..
163	'\" # Special macro to handle page bottom: finish off current
164	'\" # box/sidebar if in box/sidebar mode, then invoked standard
165	'\" # page bottom macro.
166	.de ^B
167	.ev 2
168	'ti 0
169	'nf
170	.mk ^t
171	.if \\n(^b \{\
172	.\" Draw three-sided box if this is the box's first page,
173	.\" draw two sides but no top otherwise.
174	.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
175	.el \h'-1.5n'\L'\|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'\|0u'\c
176	.\}
177	.if \\n(^v \{\
178	.nr ^x \\n(^tu+1v-\\n(^Yu
179	\kx\h'-\\nxu'\h'\|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'\|0u'\c
180	.\}
181	.bp
182	'fi
183	.ev
184	.if \\n(^b \{\
185	.mk ^y
186	.nr ^b 2
187	.\}
188	.if \\n(^v \{\
189	.mk ^Y
190	.\}
191	..
192	'\" # DS - begin display
193	.de DS
194	.RS
195	.nf
196	.sp
197	..
198	'\" # DE - end display
199	.de DE
200	.fi
201	.RE
202	.sp
203	..
204	'\" # SO - start of list of standard options
205	.de SO
206	.SH "STANDARD OPTIONS"
207	.LP
208	.nf
209	.ta 5.5c 11c
210	.ft B
211	..
212	'\" # SE - end of list of standard options
213	.de SE
214	.fi
215	.ft R
216	.LP
217	See the \\fBoptions\\fR manual entry for details on the standard options.
218	..
219	'\" # OP - start of full description for a single option
220	.de OP
221	.LP
222	.nf
223	.ta 4c
224	Command-Line Name: \\fB\\$1\\fR
225	Database Name: \\fB\\$2\\fR
226	Database Class: \\fB\\$3\\fR
227	.fi
228	.IP
229	..
230	'\" # CS - begin code excerpt
231	.de CS
232	.RS
233	.nf
234	.ta .25i .5i .75i 1i
235	..
236	'\" # CE - end code excerpt
237	.de CE
238	.fi
239	.RE
240	..
241	.de UL
242	\\$1\l'\|0\(ul'\\$2
243	..
244	.TH "Tcl_DumpActiveMemory" 3 8.1 Tcl "Tcl Library Procedures"
245	.BS
246	.SH NAME
247	Tcl_DumpActiveMemory, Tcl_InitMemory, Tcl_ValidateAllMemory \- Validated memory allocation interface.
248	.SH SYNOPSIS
249	.nf
250	\fB#include <tcl.h>\fR
251	.sp
252	int
253	\fBTcl_DumpActiveMemory\fR(\fIfileName\fR)
254	.sp
255	void
256	\fBTcl_InitMemory\fR(\fIinterp\fR)
257	.sp
258	void
259	\fBTcl_ValidateAllMemory\fR(\fIfileName, line\fR)
260
261	.SH ARGUMENTS
262	.AP Tcl_Interp *interp in
263	Tcl interpreter in which to add commands.
264	.AP "CONST char" *fileName in
265	For \fBTcl_DumpActiveMemory\fR, name of the file to which memory
266	information will be written. For \fBTcl_ValidateAllMemory\fR, name of
267	the file from which the call is being made (normally \fB__FILE__\fR).
268	.AP int line in
269	Line number at which the call to \fBTcl_ValidateAllMemory\fR is made
270	(normally \fB__LINE__\fR).
271	.BE
272
273	.SH DESCRIPTION
274	These functions provide access to Tcl memory debugging information.
275	They are only functional when Tcl has been compiled with
276	\fBTCL_MEM_DEBUG\fR defined at compile-time. When \fBTCL_MEM_DEBUG\fR
277	is not defined, these functions are all no-ops.
278	.PP
279	\fBTcl_DumpActiveMemory\fR will output a list of all currently
280	allocated memory to the specified file. The information output for
281	each allocated block of memory is: starting and ending addresses
282	(excluding guard zone), size, source file where \fBckalloc\fR was
283	called to allocate the block and line number in that file. It is
284	especially useful to call \fBTcl_DumpActiveMemory\fR after the Tcl
285	interpreter has been deleted.
286	.PP
287	\fBTcl_InitMemory\fR adds the Tcl \fBmemory\fR command to the
288	interpreter given by \fIinterp\fR. \fBTcl_InitMemory\fR is called
289	by \fBTcl_Main\fR.
290	.PP
291	\fBTcl_ValidateAllMemory\fR forces a validation of the guard zones of
292	all currently allocated blocks of memory. Normally validation of a
293	block occurs when its freed, unless full validation is enabled, in
294	which case validation of all blocks occurs when \fBckalloc\fR and
295	\fBckfree\fR are called. This function forces the validation to occur
296	at any point.
297
298	.SH "SEE ALSO"
299	TCL_MEM_DEBUG, memory
300
301	.SH KEYWORDS
302	memory, debug
303
304