Difference between revisions of "Profiling Module"
Jump to navigation
Jump to search
m (Text replacement - "'''Signatures'''" to "'''Signature'''") |
|||
Line 13: | Line 13: | ||
| width='120' | '''Signature''' | | width='120' | '''Signature''' | ||
|<pre>prof:track( | |<pre>prof:track( | ||
− | $ | + | $input as item()*, |
− | $options | + | $options as map(*)? := () |
) as item()*</pre> | ) as item()*</pre> | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |Measures the execution time and memory consumption required for evaluating the specified {{Code|$ | + | |Measures the execution time and memory consumption required for evaluating the specified {{Code|$input}} and returns a map with the results. The following {{Code|$options}} are available: |
* {{Code|time}}: Include execution time in result as {{Code|xs:decimal}} (unit: milliseconds; default: true). | * {{Code|time}}: Include execution time in result as {{Code|xs:decimal}} (unit: milliseconds; default: true). | ||
* {{Code|memory}}: Include memory consumption in result as {{Code|xs:integer}} (unit: bytes; default: false). | * {{Code|memory}}: Include memory consumption in result as {{Code|xs:integer}} (unit: bytes; default: false). | ||
Line 53: | Line 53: | ||
| width='120' | '''Signature''' | | width='120' | '''Signature''' | ||
|<pre>prof:time( | |<pre>prof:time( | ||
− | $ | + | $input as item(), |
$label as xs:string := () | $label as xs:string := () | ||
) as item()*</pre> | ) as item()*</pre> | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |Measures the time needed to evaluate {{Code|$ | + | |Measures the time needed to evaluate {{Code|$input}} and outputs a string to standard error or, if the GUI is used, to the Info View. An optional {{Code|$label}} may be specified to tag the profiling result. See {{Function||prof:track}} for further notes. |
|- valign="top" | |- valign="top" | ||
| '''Properties''' | | '''Properties''' | ||
Line 74: | Line 74: | ||
| width='120' | '''Signature''' | | width='120' | '''Signature''' | ||
|<pre>prof:memory( | |<pre>prof:memory( | ||
− | $ | + | $input as item(), |
$label as xs:string := () | $label as xs:string := () | ||
) as item()*</pre> | ) as item()*</pre> | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |Measures the memory allocated by evaluating {{Code|$ | + | |Measures the memory allocated by evaluating {{Code|$input}} and outputs a string to standard error or, if the GUI is used, to the Info View. An optional {{Code|$label}} may be specified to tag the profiling result. See {{Function||prof:track}} for further notes. |
|- valign="top" | |- valign="top" | ||
| '''Properties''' | | '''Properties''' | ||
Line 142: | Line 142: | ||
| width='120' | '''Signature''' | | width='120' | '''Signature''' | ||
|<pre>prof:dump( | |<pre>prof:dump( | ||
− | $ | + | $input as item()*, |
$label as xs:string := () | $label as xs:string := () | ||
) as empty-sequence()</pre> | ) as empty-sequence()</pre> | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |Dumps a serialized representation of {{Code|$ | + | |Dumps a serialized representation of {{Code|$input}} to {{Code|STDERR}}, optionally prefixed with {{Code|$label}}, and returns an empty sequence. If the GUI is used, the dumped result is shown in the [[Graphical User Interface#Visualizations|Info View]]. |
|- valign="top" | |- valign="top" | ||
| '''Properties''' | | '''Properties''' | ||
Line 203: | Line 203: | ||
| width='120' | '''Signature''' | | width='120' | '''Signature''' | ||
|<pre>prof:runtime( | |<pre>prof:runtime( | ||
− | $ | + | $option as xs:string |
) as xs:integer</pre> | ) as xs:integer</pre> | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |Returns the value of the specified runtime {{Code|$option}}. The following options | + | |Returns the value of the specified runtime {{Code|$option}}. The following options are available: |
* {{Code|max}}: Maximum memory that the Java virtual machine will attempt to use. | * {{Code|max}}: Maximum memory that the Java virtual machine will attempt to use. | ||
* {{Code|total}}: Total memory in the Java virtual machine (varies over time). | * {{Code|total}}: Total memory in the Java virtual machine (varies over time). | ||
Line 229: | Line 229: | ||
| width='120' | '''Signature''' | | width='120' | '''Signature''' | ||
|<pre>prof:void( | |<pre>prof:void( | ||
− | $ | + | $input as item()* |
) as empty-sequence()</pre> | ) as empty-sequence()</pre> | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |Swallows all items of the specified {{Code|$ | + | |Swallows all items of the specified {{Code|$input}} and returns an empty sequence. This function is helpful if some code needs to be evaluated and if the resulting value is irrelevant. |
|- valign="top" | |- valign="top" | ||
| '''Properties''' | | '''Properties''' |
Revision as of 16:06, 9 March 2023
This XQuery Module contains various functions to test and profile code, and to dump information to standard output.
Contents
Conventions
All functions and errors in this module are assigned to the http://basex.org/modules/prof
namespace, which is statically bound to the prof
prefix.
Performance Functions
prof:track
Signature | prof:track( $input as item()*, $options as map(*)? := () ) as item()* |
Summary | Measures the execution time and memory consumption required for evaluating the specified $input and returns a map with the results. The following $options are available:
Helpful notes:
|
Properties | The function is non-deterministic: evaluation order will be preserved by the compiler. |
Examples |
<syntaxhighlight lang="xquery"> prof:track(fetch:doc('factbook.xml'))?memory => prof:human() </syntaxhighlight>
<syntaxhighlight lang="xquery"> map { "memory": 21548400, "value": (2, 4, 6, 8, 10, ...) } </syntaxhighlight> |
prof:time
Signature | prof:time( $input as item(), $label as xs:string := () ) as item()* |
Summary | Measures the time needed to evaluate $input and outputs a string to standard error or, if the GUI is used, to the Info View. An optional $label may be specified to tag the profiling result. See prof:track for further notes.
|
Properties | The function is non-deterministic: evaluation order will be preserved by the compiler. |
Examples |
|
prof:memory
Signature | prof:memory( $input as item(), $label as xs:string := () ) as item()* |
Summary | Measures the memory allocated by evaluating $input and outputs a string to standard error or, if the GUI is used, to the Info View. An optional $label may be specified to tag the profiling result. See prof:track for further notes.
|
Properties | The function is non-deterministic: evaluation order will be preserved by the compiler. |
Examples |
|
prof:current-ms
Signature | prof:current-ms() as xs:integer |
Summary | Returns the number of milliseconds passed since 1970/01/01 UTC. The granularity of the value depends on the underlying operating system and may be larger. For example, many operating systems measure time in units of tens of milliseconds. |
Properties | In contrast to fn:current-time() , the function is non-deterministic and returns different values every time it is called. Its evaluation order will be preserved by the compiler.
|
Examples |
|
prof:current-ns
Signature | prof:current-ns() as xs:integer |
Summary | Returns the current value of the most precise available system timer in nanoseconds. |
Properties | In contrast to fn:current-time() , the function is non-deterministic and returns different values every time it is called. Its evaluation order will be preserved by the compiler.
|
Examples | Measures the time of an expression:
<syntaxhighlight lang="xquery"> let $ns1 := prof:current-ns() return ( (: process to measure :) (1 to 1000000)[. = 0], let $ns2 := prof:current-ns() let $ms := ((($ns2 - $ns1) idiv 10000) div 100) return $ms || ' ms' ) </syntaxhighlight> |
Debugging Functions
prof:dump
Signature | prof:dump( $input as item()*, $label as xs:string := () ) as empty-sequence() |
Summary | Dumps a serialized representation of $input to STDERR , optionally prefixed with $label , and returns an empty sequence. If the GUI is used, the dumped result is shown in the Info View.
|
Properties | In contrast to fn:trace() , the consumed expression will not be passed on.
|
prof:variables
Signature | prof:variables() as empty-sequence() |
Summary | Prints a list of all current local and global variable assignments to standard error or, if the GUI is used, to the Info View. As every query is optimized before being evaluated, not all of the original variables may be visible in the output. Moreover, many variables of function calls will disappear because functions are inlined. Function inlining can be turned off by setting INLINELIMIT to 0 .
|
Properties | The function is non-deterministic: evaluation order will be preserved by the compiler. |
Examples |
|
prof:type
Signature | prof:type( $expr as item()* ) as item()* |
Summary | Similar to fn:trace($expr, $msg) , but instead of a user-defined message, it emits the compile-time type and estimated result size of its argument.
|
prof:gc
Signature | prof:gc( $count as xs:integer := () ) as empty-sequence() |
Summary | Enforces Java garbage collection. If no $count is supplied, garbage will be collected once. Please note that this function should only be used for debugging purposes; in productive code, it is best to trust the garbage collecting strategies of Java.
|
prof:runtime
Signature | prof:runtime( $option as xs:string ) as xs:integer |
Summary | Returns the value of the specified runtime $option . The following options are available:
|
option
|
The specified option is unknown. |
Examples |
|
Helper Functions
prof:void
Signature | prof:void( $input as item()* ) as empty-sequence() |
Summary | Swallows all items of the specified $input and returns an empty sequence. This function is helpful if some code needs to be evaluated and if the resulting value is irrelevant.
|
Properties | The function is non-deterministic: evaluation order will be preserved by the compiler. |
Examples |
|
prof:sleep
Signature | prof:sleep( $ms as xs:integer ) as empty-sequence() |
Summary | Sleeps for the specified number of milliseconds. |
Properties | The function is non-deterministic: evaluation order will be preserved by the compiler. |
prof:human
Signature | prof:human( $number as xs:integer ) as xs:string |
Summary | Returns a human-readable representation of the specified $number .
|
Example |
|
Errors
Code | Description |
---|---|
option
|
The specified option is unknown. |
Changelog
- Version 9.2
- Added:
prof:gc
,prof:runtime
- Updated:
prof:track
: decimal timing results; by default no memory profiling
- Version 9.0
- Added:
prof:track
- Updated: renamed prof:mem to
prof:memory
,prof:time
:$cache
argument removed
- Version 8.5
- Added:
prof:type
(moved from XQuery Module)
- Version 8.1
- Added:
prof:variables
- Version 7.7
- Added:
prof:void
- Version 7.6
- Added:
prof:human
- Version 7.5
- Added:
prof:dump
,prof:current-ms
,prof:current-ns
This module was introduced with Version 7.3.