t/op/tie_fetch_count.t

   1 #!./perl
   2 # Tests counting number of FETCHes.
   3 #
   4 # See Bugs #76814 and #87708.
   5
   6 BEGIN {
   7     chdir 't' if -d 't';
   8     @INC = '../lib';
   9     require './test.pl';
  10     plan (tests => 312);
  11 }
  12
  13 use strict;
  14 use warnings;
  15
  16 my $count = 0;
  17
  18 # Usage:
  19 #   tie $var, "main", $val;          # FETCH returns $val
  20 #   tie $var, "main", $val1, $val2;  # FETCH returns the values in order,
  21 #                                    # one at a time, repeating the last
  22 #                                    # when the list is exhausted.
  23 sub TIESCALAR {my $pack = shift; bless [@_], $pack;}
  24 sub FETCH {$count ++; @{$_ [0]} == 1 ? ${$_ [0]}[0] : shift @{$_ [0]}}
  25 sub STORE { unshift @{$_[0]}, $_[1] }
  26
  27
  28 sub check_count {
  29     my $op = shift;
  30     my $expected = shift() // 1;
  31     local $::Level = $::Level + 1;
  32     is $count, $expected,
  33         "FETCH called " . (
  34           $expected == 1 ? "just once" :
  35           $expected == 2 ? "twice"     :
  36                            "$count times"
  37         ) . " using '$op'";
  38     $count = 0;
  39 }
  40
  41 my ($dummy, @dummy);
  42
  43 tie my $var => 'main', 1;
  44
  45 # Assignment.
  46 $dummy  =  $var         ; check_count "=";
  47 *dummy  =  $var         ; check_count '*glob = $tied';
  48
  49 # Unary +/-
  50 $dummy  = +$var         ; check_count "unary +";
  51 $dummy  = -$var         ; check_count "unary -";
  52
  53 # Basic arithmetic and string operators.
  54 $dummy  =  $var   +   1 ; check_count '+';
  55 $dummy  =  $var   -   1 ; check_count '-';
  56 $dummy  =  $var   /   1 ; check_count '/';
  57 $dummy  =  $var   *   1 ; check_count '*';
  58 $dummy  =  $var   %   1 ; check_count '%';
  59 $dummy  =  $var  **   1 ; check_count '**';
  60 $dummy  =  $var  <<   1 ; check_count '<<';
  61 $dummy  =  $var  >>   1 ; check_count '>>';
  62 $dummy  =  $var   x   1 ; check_count 'x';
  63 @dummy  = ($var)  x   1 ; check_count 'x';
  64 $dummy  =  $var   .   1 ; check_count '.';
  65 @dummy  =  $var  ..   1 ; check_count '$tied..1';
  66 @dummy  =   1    .. $var; check_count '1..$tied';
  67 tie my $v42 => 'main', "z";
  68 @dummy  =  $v42  ..  "a"; check_count '$tied.."a"';
  69 @dummy  =  "a"   .. $v42; check_count '"a"..$tied';
  70
  71 # Pre/post in/decrement
  72            $var ++      ; check_count 'post ++';
  73            $var --      ; check_count 'post --';
  74         ++ $var         ; check_count 'pre ++';
  75         -- $var         ; check_count 'pre --';
  76
  77 # Numeric comparison
  78 $dummy  =  $var  <    1 ; check_count '<';
  79 $dummy  =  $var  <=   1 ; check_count '<=';
  80 $dummy  =  $var  ==   1 ; check_count '==';
  81 $dummy  =  $var  >=   1 ; check_count '>=';
  82 $dummy  =  $var  >    1 ; check_count '>';
  83 $dummy  =  $var  !=   1 ; check_count '!=';
  84 $dummy  =  $var <=>   1 ; check_count '<=>';
  85
  86 # String comparison
  87 $dummy  =  $var  lt   1 ; check_count 'lt';
  88 $dummy  =  $var  le   1 ; check_count 'le';
  89 $dummy  =  $var  eq   1 ; check_count 'eq';
  90 $dummy  =  $var  ge   1 ; check_count 'ge';
  91 $dummy  =  $var  gt   1 ; check_count 'gt';
  92 $dummy  =  $var  ne   1 ; check_count 'ne';
  93 $dummy  =  $var cmp   1 ; check_count 'cmp';
  94
  95 # Bitwise operators
  96 $dummy  =  $var   &   1 ; check_count '&';
  97 $dummy  =  $var   ^   1 ; check_count '^';
  98 $dummy  =  $var   |   1 ; check_count '|';
  99 $dummy  = ~$var         ; check_count '~';
 100
 101 # Logical operators
 102 $dummy  = !$var         ; check_count '!';
 103 tie my $v_1, "main", 0;
 104 $dummy  =  $v_1  ||   1 ; check_count '||';
 105 $dummy  = ($v_1  or   1); check_count 'or';
 106 $dummy  =  $var  &&   1 ; check_count '&&';
 107 $dummy  = ($var and   1); check_count 'and';
 108 $dummy  = ($var xor   1); check_count 'xor';
 109 $dummy  =  $var ? 1 : 1 ; check_count '?:';
 110
 111 # Overloadable functions
 112 $dummy  =   sin $var    ; check_count 'sin';
 113 $dummy  =   cos $var    ; check_count 'cos';
 114 $dummy  =   exp $var    ; check_count 'exp';
 115 $dummy  =   abs $var    ; check_count 'abs';
 116 $dummy  =   log $var    ; check_count 'log';
 117 $dummy  =  sqrt $var    ; check_count 'sqrt';
 118 $dummy  =   int $var    ; check_count 'int';
 119 $dummy  = atan2 $var, 1 ; check_count 'atan2';
 120
 121 # Readline/glob
 122 tie my $var0, "main", \*DATA;
 123 $dummy  = <$var0>       ; check_count '<readline>';
 124 $var    = \1;
 125 $var   .= <DATA>        ; check_count '$tiedref .= <rcatline>';
 126 $var    = "tied";
 127 $var   .= <DATA>        ; check_count '$tiedstr .= <rcatline>';
 128 $var    = *foo;
 129 $var   .= <DATA>        ; check_count '$tiedglob .= <rcatline>';
 130 {   no warnings "glob";
 131     $dummy  = <${var}>      ; check_count '<glob>';
 132 }
 133
 134 # File operators
 135 for (split //, 'rwxoRWXOezsfdpSbctugkTBMAC') {
 136     no warnings 'unopened';
 137     $dummy  = eval "-$_ \$var"; check_count "-$_";
 138     # Make $var hold a glob:
 139     $var = *dummy; $dummy = $var; $count = 0;
 140     $dummy  = eval "-$_ \$var"; check_count "-$_ \$tied_glob";
 141     next if /[guk]/;
 142     $var = *dummy; $dummy = $var; $count = 0;
 143     eval "\$dummy = -$_ \\\$var";
 144     check_count "-$_ \\\$tied_glob";
 145 }
 146 $dummy  = -l $var       ; check_count '-l';
 147 $var = "test.pl";
 148 $dummy  = -e -e -e $var ; check_count '-e -e';
 149
 150 # Matching
 151 $_ = "foo";
 152 $dummy  =  $var =~ m/ / ; check_count 'm//';
 153 $dummy  =  $var =~ s/ //; check_count 's///';
 154 $dummy  =  $var ~~    1 ; check_count '~~';
 155 $dummy  =  $var =~ y/ //; check_count 'y///';
 156            $var = \1;
 157 $dummy  =  $var =~y/ /-/; check_count '$ref =~ y///';
 158            /$var/       ; check_count 'm/pattern/';
 159            /$var foo/   ; check_count 'm/$tied foo/';
 160           s/$var//      ; check_count 's/pattern//';
 161           s/$var foo//  ; check_count 's/$tied foo//';
 162           s/./$var/     ; check_count 's//replacement/';
 163
 164 # Dereferencing
 165 tie my $var1 => 'main', \1;
 166 $dummy  = $$var1        ; check_count '${}';
 167 tie my $var2 => 'main', [];
 168 $dummy  = @$var2        ; check_count '@{}';
 169 $dummy  = shift $var2   ; check_count 'shift arrayref';
 170 tie my $var3 => 'main', {};
 171 $dummy  = %$var3        ; check_count '%{}';
 172 $dummy  = keys $var3    ; check_count 'keys hashref';
 173 {
 174     no strict 'refs';
 175     tie my $var4 => 'main', **;
 176     $dummy  = *$var4        ; check_count '*{}';
 177 }
 178
 179 tie my $var5 => 'main', sub {1};
 180 $dummy  = &$var5        ; check_count '&{}';
 181
 182 {
 183     no strict 'refs';
 184     tie my $var1 => 'main', 1;
 185     $dummy  = $$var1        ; check_count 'symbolic ${}';
 186     $dummy  = @$var1        ; check_count 'symbolic @{}';
 187     $dummy  = %$var1        ; check_count 'symbolic %{}';
 188     $dummy  = *$var1        ; check_count 'symbolic *{}';
 189     local *1 = sub{};
 190     $dummy  = &$var1        ; check_count 'symbolic &{}';
 191
 192     # This test will not be a complete test if *988 has been created
 193     # already.  If this dies, change it to use another built-in variable.
 194     # In 5.10-14, rv2gv calls get-magic more times for built-in vars, which
 195     # is why we need the test this way.
 196     if (exists $::{988}) {
 197         die "*988 already exists. Please adjust this test"
 198     }
 199     tie my $var6 => main => 988;
 200     no warnings;
 201     readdir $var6           ; check_count 'symbolic readdir';
 202     if (exists $::{973}) { # Need a different variable here
 203         die "*973 already exists. Please adjust this test"
 204     }
 205     tie my $var7 => main => 973;
 206     defined $$var7          ; check_count 'symbolic defined ${}';
 207 }
 208
 209 tie my $var8 => 'main', 'main';
 210 sub bolgy {}
 211 $var8->bolgy            ; check_count '->method';
 212 {
 213     no warnings 'once';
 214     () = *swibble;
 215     # This must be the name of an existing glob to trigger the maximum
 216     # number of fetches in 5.14:
 217     tie my $var9 => 'main', 'swibble';
 218     no strict 'refs';
 219     use constant glumscrin => 'shreggleboughet';
 220     *$var9 = \&{"glumscrin"}; check_count '*$tied = \&{"name of const"}';
 221 }
 222
 223 # Functions that operate on filenames or filehandles
 224 for ([chdir=>''],[chmod=>'0,'],[chown=>'0,0,'],[utime=>'0,0,'],
 225      [truncate=>'',',0'],[stat=>''],[lstat=>''],[open=>'my $fh,"<&",'],
 226      ['()=sort'=>'',' 1,2,3']) {
 227     my($op,$args,$postargs) = @$_; $postargs //= '';
 228     # This line makes $var8 hold a glob:
 229     $var8 = *dummy; $dummy = $var8; $count = 0;
 230     eval "$op $args \$var8 $postargs";
 231     check_count "$op $args\$tied_glob$postargs";
 232     $var8 = *dummy; $dummy = $var8; $count = 0;
 233     my $ref = \$var8;
 234     eval "$op $args \$ref $postargs";
 235     check_count "$op $args\\\$tied_glob$postargs";
 236 }
 237
 238 {
 239     no warnings;
 240     $var = *foo;
 241     $dummy  =  select $var, undef, undef, 0
 242                             ; check_count 'select $tied_glob, ...';
 243     $var = \1;
 244     $dummy  =  select $var, undef, undef, 0
 245                             ; check_count 'select $tied_ref, ...';
 246     $var = undef;
 247     $dummy  =  select $var, undef, undef, 0
 248                             ; check_count 'select $tied_undef, ...';
 249 }
 250
 251 chop(my $u = "\xff\x{100}");
 252 tie $var, "main", $u;
 253 $dummy  = pack "u", $var; check_count 'pack "u", $utf8';
 254
 255 tie $var, "main", "\x{100}";
 256 pos$var = 0             ; check_count 'lvalue pos $utf8';
 257 $dummy=sprintf"%1s",$var; check_count 'sprintf "%1s", $utf8';
 258 $dummy=sprintf"%.1s",$var; check_count 'sprintf "%.1s", $utf8';
 259 $dummy  = substr$var,0,1; check_count 'substr $utf8';
 260 my $l   =\substr$var,0,1;
 261 $dummy  = $$l           ; check_count 'reading lvalue substr($utf8)';
 262 $$l     = 0             ; check_count 'setting lvalue substr($utf8)';
 263 tie $var, "main", "a";
 264 $$l     = "\x{100}"     ; check_count 'assigning $utf8 to lvalue substr';
 265 tie $var1, "main", "a";
 266 substr$var1,0,0,"\x{100}"; check_count '4-arg substr with utf8 replacement';
 267
 268 {
 269     local $SIG{__WARN__} = sub {};
 270     $dummy  =  warn $var    ; check_count 'warn $tied';
 271     tie $@, => 'main', 1;
 272     $dummy  =  warn         ; check_count 'warn() with $@ tied (num)';
 273     tie $@, => 'main', \1;
 274     $dummy  =  warn         ; check_count 'warn() with $@ tied (ref)';
 275     tie $@, => 'main', "foo\n";
 276     $dummy  =  warn         ; check_count 'warn() with $@ tied (str)';
 277     untie $@;
 278 }
 279
 280 ###############################################
 281 #        Tests for  $foo binop $foo           #
 282 ###############################################
 283
 284 # These test that binary ops call FETCH twice if the same scalar is used
 285 # for both operands. They also test that both return values from
 286 # FETCH are used.
 287
 288 my %mutators = map { ($_ => 1) } qw(. + - * / % ** << >> & | ^);
 289
 290
 291 sub _bin_test {
 292     my $int = shift;
 293     my $op = shift;
 294     my $exp = pop;
 295     my @fetches = @_;
 296
 297     $int = $int ? 'use integer; ' : '';
 298
 299     tie my $var, "main", @fetches;
 300     is(eval "$int\$var $op \$var", $exp, "retval of $int\$var $op \$var");
 301     check_count "$int$op", 2;
 302
 303     return unless $mutators{$op};
 304
 305     tie my $var2, "main", @fetches;
 306     is(eval "$int \$var2 $op= \$var2", $exp, "retval of $int \$var2 $op= \$var2");
 307     check_count "$int$op=", 3;
 308 }
 309
 310 sub bin_test {
 311     _bin_test(0, @_);
 312 }
 313
 314 sub bin_int_test {
 315     _bin_test(1, @_);
 316 }
 317
 318 bin_test '**',  2, 3, 8;
 319 bin_test '*' ,  2, 3, 6;
 320 bin_test '/' , 10, 2, 5;
 321 bin_test '%' , 11, 2, 1;
 322 bin_test 'x' , 11, 2, 1111;
 323 bin_test '-' , 11, 2, 9;
 324 bin_test '<<', 11, 2, 44;
 325 bin_test '>>', 44, 2, 11;
 326 bin_test '<' ,  1, 2, 1;
 327 bin_test '>' , 44, 2, 1;
 328 bin_test '<=', 44, 2, "";
 329 bin_test '>=',  1, 2, "";
 330 bin_test '!=',  1, 2, 1;
 331 bin_test '<=>', 1, 2, -1;
 332 bin_test 'le',  4, 2, "";
 333 bin_test 'lt',  1, 2, 1;
 334 bin_test 'gt',  4, 2, 1;
 335 bin_test 'ge',  1, 2, "";
 336 bin_test 'eq',  1, 2, "";
 337 bin_test 'ne',  1, 2, 1;
 338 bin_test 'cmp', 1, 2, -1;
 339 bin_test '&' ,  1, 2, 0;
 340 bin_test '|' ,  1, 2, 3;
 341 bin_test '^' ,  3, 5, 6;
 342 bin_test '.' ,  1, 2, 12;
 343 bin_test '==',  1, 2, "";
 344 bin_test '+' ,  1, 2, 3;
 345 bin_int_test '*' ,  2, 3, 6;
 346 bin_int_test '/' , 10, 2, 5;
 347 bin_int_test '%' , 11, 2, 1;
 348 bin_int_test '+' ,  1, 2, 3;
 349 bin_int_test '-' , 11, 2, 9;
 350 bin_int_test '<' ,  1, 2, 1;
 351 bin_int_test '>' , 44, 2, 1;
 352 bin_int_test '<=', 44, 2, "";
 353 bin_int_test '>=',  1, 2, "";
 354 bin_int_test '==',  1, 2, "";
 355 bin_int_test '!=',  1, 2, 1;
 356 bin_int_test '<=>', 1, 2, -1;
 357 tie $var, "main", 1, 4;
 358 cmp_ok(atan2($var, $var), '<', .3, 'retval of atan2 $var, $var');
 359 check_count 'atan2',  2;
 360
 361 __DATA__