1profile_on
2
3 SYNOPSIS
4  Enable code generation to support profiling hooks
5
6 USAGE
7  profile_on ( [line_by_line] )
8
9 DESCRIPTION
10  This function will turn cause the interpreter to generate code to
11  call hooks that are used to profile code.  The `profile_on'
12  function does not establish those hooks, rather it causes code to be
13  generated to support such hooks.
14
15  With no optional argument, only code to support function call hooks
16  will be generated.  To enable support for line-by-line profile
17  hooks, a value of 1 should be passed to this function.
18
19 SEE ALSO
20  profile_off, profile_begin, profile_end, profile_calibrate, profile_report}
21
22--------------------------------------------------------------
23
24profile_off
25
26 SYNOPSIS
27  Turn off code generation for profiling hooks
28
29 USAGE
30  profile_off ()
31
32 DESCRIPTION
33  This function turns off the generation of code to support profiling
34  hooks.
35
36 SEE ALSO
37  profile_on, profile_begin, profile_end, profile_calibrate, profile_report}
38
39--------------------------------------------------------------
40
41profile_begin
42
43 SYNOPSIS
44  Establish profiling hooks and reset the profiler
45
46 USAGE
47  profile_begin ( [line_by_line] )
48
49 DESCRIPTION
50  This function establishes the profiling hooks and resets or
51  initializes the profiler state.  By default, only hooks to gather
52  function call information are created.  To enable the gathering of
53  line-by-line information, a value of 1 should be passed to this
54  function.
55
56 SEE ALSO
57  profile_end, profile_on, profile_off, profile_calibrate, profile_report}
58
59--------------------------------------------------------------
60
61profile_end
62
63 SYNOPSIS
64  Remove profiling hooks and turn off profiler code generation
65
66 USAGE
67  profile_end ()
68
69 DESCRIPTION
70  The `profile_end' function turns off the code generation to
71  support profiling hooks and removes any profiling hooks that are in
72  place.
73
74 SEE ALSO
75  profile_begin, profile_on, profile_off, profile_calibrate, profile_report
76
77--------------------------------------------------------------
78
79profile_calibrate
80
81 SYNOPSIS
82  Calibrate the profiler
83
84 USAGE
85  profile_calibrate ([ N ])
86
87 DESCRIPTION
88 This function may be used to ``calibrate'' the profiler.  As the
89 performance of the profiler and the interpreter varies with a
90 platform and load-dependent manner, this function should be called
91 prior to enabling the profiler.  It tries to determine the average
92 amount of overhead per statement executed and function call by
93 executing a series of statements and functions many times to
94 determine statistically accurate values.  The optional parameter
95 `N' may be used to control the amount of code executed
96 for the calibration process.  If no value is provided, the `N'
97 will default to 1000.  The higher the value, the more accurate the
98 calibration will be and the longer the calibration process will take.
99
100 SEE ALSO
101  profile_begin, profile_end, profile_on, profile_off, profile_report
102
103--------------------------------------------------------------
104
105profile_report
106
107 SYNOPSIS
108  Generate the profile report
109
110 USAGE
111  profile_report (file)
112
113 DESCRIPTION
114  The function may be used to format the profile report and write it
115  to the specified file.  If the `file' parameter represents a
116  File_Type file descriptor, then the report will be written
117  the the descriptor.
118
119 SEE ALSO
120  profile_begin, profile_end, profile_on, profile_off, profile_calibrate
121
122--------------------------------------------------------------
123