Difference between revisions of "Profiling Module"
Jump to navigation
Jump to search
(14 intermediate revisions by 2 users not shown) | |||
Line 16: | Line 16: | ||
| '''Summary''' | | '''Summary''' | ||
|Measures the execution time and memory consumption required for evaluating the specified {{Code|$expression}} and returns a map with the results. The following {{Code|$options}} are available: | |Measures the execution time and memory consumption required for evaluating the specified {{Code|$expression}} and returns a map with the results. The following {{Code|$options}} are available: | ||
− | * {{Code| | + | * {{Code|time}}: Include execution time in result as {{Code|xs:decimal}} (unit: milliseconds; default: true). |
− | * {{Code| | + | * {{Code|memory}}: Include memory consumption in result as {{Code|xs:integer}} (unit: bytes; default: false). |
* {{Code|value}}: Include value in result (default: true). | * {{Code|value}}: Include value in result (default: true). | ||
Helpful notes: | Helpful notes: | ||
Line 31: | Line 31: | ||
| | | | ||
* Return a human-readable representation of the memory consumption caused by fetching an XML document (<code>fetch:xml</code> is used, as <code>fn:doc</code> may already be evaluated at compilation time): | * Return a human-readable representation of the memory consumption caused by fetching an XML document (<code>fetch:xml</code> is used, as <code>fn:doc</code> may already be evaluated at compilation time): | ||
− | < | + | <syntaxhighlight lang="xquery"> |
prof:track(fetch:xml('factbook.xml'))?memory | prof:track(fetch:xml('factbook.xml'))?memory | ||
=> prof:human() | => prof:human() | ||
− | </ | + | </syntaxhighlight> |
* The function call <code>prof:track((1 to 1000000)[. mod 2 = 0], map { 'time': false() })</code> will return something similar to: | * The function call <code>prof:track((1 to 1000000)[. mod 2 = 0], map { 'time': false() })</code> will return something similar to: | ||
− | < | + | <syntaxhighlight lang="xquery"> |
map { | map { | ||
"memory": 21548400, | "memory": 21548400, | ||
"value": (2, 4, 6, 8, 10, ...) | "value": (2, 4, 6, 8, 10, ...) | ||
} | } | ||
− | </ | + | </syntaxhighlight> |
|} | |} | ||
Line 113: | Line 113: | ||
| '''Examples''' | | '''Examples''' | ||
| Measures the time of an expression: | | Measures the time of an expression: | ||
− | < | + | <syntaxhighlight lang="xquery"> |
let $ns1 := prof:current-ns() | let $ns1 := prof:current-ns() | ||
return ( | return ( | ||
Line 122: | Line 122: | ||
return $ms || ' ms' | return $ms || ' ms' | ||
) | ) | ||
− | </ | + | </syntaxhighlight> |
|} | |} | ||
Line 132: | Line 132: | ||
|- | |- | ||
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
− | |{{Func|prof:dump|$expr as item()|empty-sequence()}}<br />{{Func|prof:dump|$expr as item(), $label as xs:string|empty-sequence()}}<br /> | + | |{{Func|prof:dump|$expr as item()*|empty-sequence()}}<br />{{Func|prof:dump|$expr as item()*, $label as xs:string|empty-sequence()}}<br /> |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
Line 149: | Line 149: | ||
|- | |- | ||
| '''Summary''' | | '''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.<br />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 | + | |Prints a list of all current local and global variable assignments to standard error or, if the GUI is used, to the Info View.<br />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 {{Option|INLINELIMIT}} to <code>0</code>. |
|- | |- | ||
| '''Properties''' | | '''Properties''' | ||
Line 156: | Line 156: | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
− | * {{Code|for $x in 1 to 2 return prof:variables()}} will dump the values of <code>$x</code> to standard error. | + | * {{Code|for $x in 1 to 2 return ($x, prof:variables())}} will dump the values of <code>$x</code> to standard error. |
|} | |} | ||
Line 168: | Line 168: | ||
| '''Summary''' | | '''Summary''' | ||
|Similar to {{Code|fn:trace($expr, $msg)}}, but instead of a user-defined message, it emits the compile-time type and estimated result size of its argument. | |Similar to {{Code|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== | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signatures''' | ||
+ | |{{Func|prof:gc||empty-sequence()}}<br/>{{Func|prof:gc|$count as xs:integer|empty-sequence()}} | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Enforces Java garbage collection. If no {{Code|$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== | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signatures''' | ||
+ | |{{Func|prof:runtime|$name of xs:string|xs:integer}} | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Returns the value of the specified runtime {{Code|$option}}. The following options exist: | ||
+ | * {{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|used}}: Currently used memory (varies over time, will shrink after garbage collection). | ||
+ | * {{Code|processors}}: number of processors available to the Java virtual machine. | ||
+ | |- | ||
+ | |{{Code|option}} | ||
+ | |The specified option is unknown. | ||
+ | |- | ||
+ | | '''Examples''' | ||
+ | | | ||
+ | * <code>prof:gc(3), prof:human(prof:runtime('used'))</code> performs some garbage collection and returns the currently used amount of memory in a user-friendly format. | ||
|} | |} | ||
Line 217: | Line 250: | ||
| | | | ||
* {{Code|prof:human(16384)}} returns {{Code|16K}}. | * {{Code|prof:human(16384)}} returns {{Code|16K}}. | ||
+ | |} | ||
+ | |||
+ | =Errors= | ||
+ | |||
+ | {| class="wikitable" width="100%" | ||
+ | ! width="110"|Code | ||
+ | |Description | ||
+ | |- | ||
+ | |{{Code|option}} | ||
+ | |The specified option is unknown. | ||
|} | |} | ||
=Changelog= | =Changelog= | ||
+ | |||
+ | ;Version 9.2 | ||
+ | |||
+ | * Added: [[#prof:gc|prof:gc]], [[#prof:runtime|prof:runtime]] | ||
+ | * Updated: [[#prof:track|prof:track]]: decimal timing results; by default no memory profiling | ||
;Version 9.0 | ;Version 9.0 | ||
* Added: [[#prof:track|prof:track]] | * Added: [[#prof:track|prof:track]] | ||
− | * Updated: renamed prof:mem to [[#prof:memory|prof:memory]] | + | * Updated: renamed prof:mem to [[#prof:memory|prof:memory]], [[#prof:time|prof:time]]: <code>$cache</code> argument removed |
;Version 8.5 | ;Version 8.5 |
Revision as of 16:18, 27 February 2020
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
Signatures | prof:track($expression as item()) as item()* prof:track($expression as item(), $options as map(*)?) as item()*
|
Summary | Measures the execution time and memory consumption required for evaluating the specified $expression 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:xml('factbook.xml'))?memory => prof:human() </syntaxhighlight>
<syntaxhighlight lang="xquery"> map { "memory": 21548400, "value": (2, 4, 6, 8, 10, ...) } </syntaxhighlight> |
prof:time
Signatures | prof:time($expr as item()) as item()* prof:time($expr as item(), $label as xs:string) as item()*
|
Summary | Measures the time needed to evaluate $expr 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
Signatures | prof:memory($expr as item()) as item()* prof:memory($expr as item(), $label as xs:string) as item()*
|
Summary | Measures the memory allocated by evaluating $expr 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
Signatures | 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
Signatures | 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
Signatures | prof:dump($expr as item()*) as empty-sequence() prof:dump($expr as item()*, $label as xs:string) as empty-sequence() |
Summary | Dumps a serialized representation of $expr 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
Signatures | 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
Signatures | 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
Signatures | prof:gc() as empty-sequence() 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
Signatures | prof:runtime($name of xs:string) as xs:integer
|
Summary | Returns the value of the specified runtime $option . The following options exist:
|
option
|
The specified option is unknown. |
Examples |
|
Helper Functions
prof:void
Signatures | prof:void($value as item()*) as empty-sequence()
|
Summary | Swallows all items of the specified $value and returns an empty sequence. This function is helpful if some code needs to be evaluated and if the actual result is irrelevant.
|
Properties | The function is non-deterministic: evaluation order will be preserved by the compiler. |
Examples |
|
prof:sleep
Signatures | 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
Signatures | 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.