1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="luasandbox.getprofilerfunctionreport" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>LuaSandbox::getProfilerFunctionReport</refname>
<refpurpose>Fetch profiler data</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>LuaSandbox::getProfilerFunctionReport</methodname>
<methodparam choice="opt"><type>int</type><parameter>units</parameter><initializer>LuaSandbox::SECONDS</initializer></methodparam>
</methodsynopsis>
<para>
For a profiling instance previously started by
<methodname>LuaSandbox::enableProfiler</methodname>, get a
report of the cost of each function.
</para>
<para>
The measurement unit used for the cost is determined by the
<varname>$units</varname> parameter:
</para>
<para>
<variablelist>
<varlistentry>
<term><constant>LuaSandbox::SAMPLES</constant></term>
<listitem><para>Measure in number of samples.</para></listitem>
</varlistentry>
<varlistentry>
<term><constant>LuaSandbox::SECONDS</constant></term>
<listitem><para>Measure in seconds of CPU time.</para></listitem>
</varlistentry>
<varlistentry>
<term><constant>LuaSandbox::PERCENT</constant></term>
<listitem><para>Measure percentage of CPU time.</para></listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>units</parameter></term>
<listitem>
<para>
Measurement unit constant.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns profiler measurements, sorted in descending order, as an associative
<type>array</type>. Keys are the Lua function names (with source file and line
defined in angle brackets), values are the measurements as <type>int</type>
or <type>float</type>.
</para>
<note>
<para>
On Windows, this function always returns an empty array. On operating systems that do
not support <constant>CLOCK_THREAD_CPUTIME_ID</constant>, such as FreeBSD
and Mac OS X, this function will report the elapsed wall-clock time, not
CPU time.
</para>
</note>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Profiling Lua code</title>
<programlisting role="php">
<![CDATA[
<?php
// create a new LuaSandbox
$sandbox = new LuaSandbox();
// Start the profiler
$sandbox->enableProfiler( 0.01 );
// ... Execute some Lua code here ...
// Fetch the profiler data
$data = $sandbox->getProfilerFunctionReport();
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
