Gecko [ fernandoquevedodop.com ]

Name	Size	Permission
slshfun-1.html	1.64 KB	-rw-r--r--
slshfun-10.html	5.17 KB	-rw-r--r--
slshfun-11.html	5.36 KB	-rw-r--r--
slshfun-12.html	3.4 KB	-rw-r--r--
slshfun-13.html	7.79 KB	-rw-r--r--
slshfun-2.html	3.84 KB	-rw-r--r--
slshfun-3.html	9.51 KB	-rw-r--r--
slshfun-4.html	6.4 KB	-rw-r--r--
slshfun-5.html	6.61 KB	-rw-r--r--
slshfun-6.html	4.13 KB	-rw-r--r--
slshfun-7.html	3.36 KB	-rw-r--r--
slshfun-8.html	7.78 KB	-rw-r--r--
slshfun-9.html	9.96 KB	-rw-r--r--
slshfun.html	5.16 KB	-rw-r--r--

Code Editor : slshfun-10.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<HEAD>
 <META NAME="GENERATOR" CONTENT="LinuxDoc-Tools 0.9.69">
 <TITLE> SLSH Library Reference (version 2.3.0): Profiling Functions</TITLE>
 <LINK HREF="slshfun-11.html" REL=next>
 <LINK HREF="slshfun-9.html" REL=previous>
 <LINK HREF="slshfun.html#toc10" REL=contents>
</HEAD>
<BODY>
<A HREF="slshfun-11.html">Next</A>
<A HREF="slshfun-9.html">Previous</A>
<A HREF="slshfun.html#toc10">Contents</A>
<HR>
<H2><A NAME="s10">10.</A> <A HREF="slshfun.html#toc10">Profiling Functions</A></H2>

These functions are used by slprof for profiling slsh
applications.
<H2><A NAME="profile_on"></A> <A NAME="ss10.1">10.1</A> <A HREF="slshfun.html#toc10.1">profile_on</A>
</H2>

<DL>
<DT> Synopsis <DD>
Enable code generation to support profiling hooks
<DT> Usage <DD>
<CODE>profile_on ( [line_by_line] )</CODE>
<DT> Description <DD>
This function will turn cause the interpreter to generate code to
call hooks that are used to profile code. The <CODE>profile_on</CODE>
function does not establish those hooks, rather it causes code to be
generated to support such hooks.
With no optional argument, only code to support function call hooks
will be generated. To enable support for line-by-line profile
hooks, a value of 1 should be passed to this function.
<DT> See Also <DD>
<CODE>profile_off, profile_begin, profile_end, profile_calibrate, profile_report</CODE>}
</DL>

<H2><A NAME="profile_off"></A> <A NAME="ss10.2">10.2</A> <A HREF="slshfun.html#toc10.2">profile_off</A>
</H2>

<DL>
<DT> Synopsis <DD>
Turn off code generation for profiling hooks
<DT> Usage <DD>
<CODE>profile_off ()</CODE>
<DT> Description <DD>
This function turns off the generation of code to support profiling
hooks.
<DT> See Also <DD>
<CODE>profile_on, profile_begin, profile_end, profile_calibrate, profile_report</CODE>}
</DL>

<H2><A NAME="profile_begin"></A> <A NAME="ss10.3">10.3</A> <A HREF="slshfun.html#toc10.3">profile_begin</A>
</H2>

<DL>
<DT> Synopsis <DD>
Establish profiling hooks and reset the profiler
<DT> Usage <DD>
<CODE>profile_begin ( [line_by_line] )</CODE>
<DT> Description <DD>
This function establishes the profiling hooks and resets or
initializes the profiler state. By default, only hooks to gather
function call information are created. To enable the gathering of
line-by-line information, a value of 1 should be passed to this
function.
<DT> See Also <DD>
<CODE>profile_end, profile_on, profile_off, profile_calibrate, profile_report</CODE>}
</DL>

<H2><A NAME="profile_end"></A> <A NAME="ss10.4">10.4</A> <A HREF="slshfun.html#toc10.4">profile_end</A>
</H2>

<DL>
<DT> Synopsis <DD>
Remove profiling hooks and turn off profiler code generation
<DT> Usage <DD>
<CODE>profile_end ()</CODE>
<DT> Description <DD>
The <CODE>profile_end</CODE> function turns off the code generation to
support profiling hooks and removes any profiling hooks that are in
place.
<DT> See Also <DD>
<CODE>profile_begin, profile_on, profile_off, profile_calibrate, profile_report</CODE>
</DL>

<H2><A NAME="profile_calibrate"></A> <A NAME="ss10.5">10.5</A> <A HREF="slshfun.html#toc10.5">profile_calibrate</A>
</H2>

<DL>
<DT> Synopsis <DD>
Calibrate the profiler
<DT> Usage <DD>
<CODE>profile_calibrate ([ N ])</CODE>
<DT> Description <DD>
This function may be used to ``calibrate'' the profiler. As the
performance of the profiler and the interpreter varies with a
platform and load-dependent manner, this function should be called
prior to enabling the profiler. It tries to determine the average
amount of overhead per statement executed and function call by
executing a series of statements and functions many times to
determine statistically accurate values. The optional parameter
<CODE>N</CODE> may be used to control the amount of code executed
for the calibration process. If no value is provided, the <CODE>N</CODE>
will default to 1000. The higher the value, the more accurate the
calibration will be and the longer the calibration process will take.
<DT> See Also <DD>
<CODE>profile_begin, profile_end, profile_on, profile_off, profile_report</CODE>
</DL>

<H2><A NAME="profile_report"></A> <A NAME="ss10.6">10.6</A> <A HREF="slshfun.html#toc10.6">profile_report</A>
</H2>

<DL>
<DT> Synopsis <DD>
Generate the profile report
<DT> Usage <DD>
<CODE>profile_report (file)</CODE>
<DT> Description <DD>
The function may be used to format the profile report and write it
to the specified file. If the <CODE>file</CODE> parameter represents a
<CODE>File_Type</CODE> file descriptor, then the report will be written
the the descriptor.
<DT> See Also <DD>
<CODE>profile_begin, profile_end, profile_on, profile_off, profile_calibrate</CODE>
</DL>

<HR>
<A HREF="slshfun-11.html">Next</A>
<A HREF="slshfun-9.html">Previous</A>
<A HREF="slshfun.html#toc10">Contents</A>
</BODY>
</HTML>

${this.title}

Code Editor : slshfun-10.html