diff options
Diffstat (limited to 'doc/bird.sgml')
| -rw-r--r-- | doc/bird.sgml | 50 |
1 files changed, 49 insertions, 1 deletions
diff --git a/doc/bird.sgml b/doc/bird.sgml index c76873cd..b3ac38b0 100644 --- a/doc/bird.sgml +++ b/doc/bird.sgml @@ -25,7 +25,7 @@ configuration - something in config which is not keyword. Ondrej Filip <it/<feela@network.cz>/, Pavel Machek <it/<pavel@ucw.cz>/, Martin Mares <it/<mj@ucw.cz>/, -Maria Jan Matejka <it/<mq@jmq.cz>/, +Maria Matejka <it/<mq@jmq.cz>/, Ondrej Zajicek <it/<santiago@crfreenet.org>/ </author> @@ -3759,6 +3759,54 @@ protocol ospf MyOSPF { } </code> +<sect>Perf +<label id="perf"> + +<sect1>Introduction +<label id="perf-intro"> + +<p>The Perf protocol is a generator of fake routes together with a time measurement +framework. Its purpose is to check BIRD performance and to benchmark filters. + +<p>Import mode of this protocol runs in several steps. In each step, it generates 2^x routes, +imports them into the appropriate table and withdraws them. The exponent x is configurable. +It runs the benchmark several times for the same x, then it increases x by one +until it gets too high, then it stops. + +<p>Export mode of this protocol repeats route refresh from table and measures how long it takes. + +<p>Output data is logged on info level. There is a Perl script <cf>proto/perf/parse.pl</cf> +which may be handy to parse the data and draw some plots. + +<p>Implementation of this protocol is experimental. Use with caution and do not keep +any instance of Perf in production configs for long time. The config interface is also unstable +and may change in future versions without warning. + +<sect1>Configuration +<label id="perf-config"> + +<p><descrip> + <tag><label id="perf-mode">mode import|export</tag> + Set perf mode. Default: import + + <tag><label id="perf-repeat">repeat <m/number/</tag> + Run this amount of iterations of the benchmark for every amount step. Default: 4 + + <tag><label id="perf-from">exp from <m/number/</tag> + Begin benchmarking on this exponent for number of generated routes in one step. + Default: 10 + + <tag><label id="perf-to">exp to <m/number/</tag> + Stop benchmarking on this exponent. Default: 20 + + <tag><label id="perf-threshold-min">threshold min <m/time/</tag> + If a run for the given exponent took less than this time for route import, + increase the exponent immediately. Default: 1 ms + + <tag><label id="perf-threshold-max">threshold max <m/time/</tag> + If every run for the given exponent took at least this time for route import, + stop benchmarking. Default: 500 ms +</descrip> <sect>Pipe <label id="pipe"> |