This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Tweak sv_pos_b2u_flags check in pp_index
[perl5.git] / t / perf / benchmarks
1 #!perl
2
3 # This file specifies an array-of-hashes that define snippets of code that
4 # can be run by various measurement and profiling tools.
5 #
6 # The basic idea is that any time you add an optimisation that is intended
7 # to make a particular construct faster, then you should add that construct
8 # to this file.
9 #
10 # Under the normal test suite, the test file benchmarks.t does a basic
11 # compile and run of each of these snippets; not to test performance,
12 # but just to ensure that the code doesn't have errors.
13 #
14 # Over time, it is intended that various measurement and profiling tools
15 # will be written that can run selected (or all) snippets in various
16 # environments. These will not be run as part of a normal test suite run.
17 #
18 # It is intended that the tests in this file will be lightweight; e.g.
19 # a hash access, an empty function call, or a single regex match etc.
20 #
21 # This file is designed to be read in by 'do' (and in such a way that
22 # multiple versions of this file from different releases can be read in
23 # by a single process).
24 #
25 # The top-level array has name/hash pairs (we use an array rather than a
26 # hash so that duplicate keys can be spotted) Each name is a token that
27 # describes a particular test. Code will be compiled in the package named
28 # after the token, so it should match /^(\w|::)+$/a. It is intended that
29 # this can be used on the command line of tools to select particular
30 # tests.
31 # In addition, the package names are arranged into an informal hierarchy
32 # whose top members are (this is subject to change):
33 #
34 #     call::     subroutine and method handling
35 #     expr::     expressions: e.g. $x=1, $foo{bar}[0]
36 #     loop::     structural code like for, while(), etc
37 #     regex::    regular expressions
38 #     string::   string handling
39 #
40 #
41 # Each hash has three fields:
42 #
43 #   desc is a description of the test
44 #   setup is a string containing setup code
45 #   code  is a string containing the code to run in a loop
46 #
47 # So typically a benchmark tool might do something like
48 #
49 #   eval "package $token; $setup; for (1..1000000) { $code }"
50 #
51 # Currently the only tool that uses this file is Porting/bench.pl;
52 # try C<perl Porting/bench.pl --help> for more info
53
54
55 [
56     'call::sub::3_args' => {
57         desc    => 'function call with 3 local lexical vars',
58         setup   => 'sub f { my ($a, $b, $c) = @_ }',
59         code    => 'f(1,2,3)',
60     },
61
62     'expr::assign::scalar_lex' => {
63         desc    => 'lexical $x = 1',
64         setup   => 'my $x',
65         code    => '$x = 1',
66     },
67     'expr::assign::2list_lex' => {
68         desc    => 'lexical ($x, $y) = (1, 2)',
69         setup   => 'my ($x, $y)',
70         code    => '($x, $y) = (1, 2)',
71     },
72
73     'expr::index::utf8_postion_1' => {
74         desc    => 'index of a utf8 string, matching at position 1',
75         setup   => 'utf8::upgrade my $x = "abc"',
76         code    => 'index $x, "b"',
77     },
78 ];
79