This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
pp_leaveeval: reset stack in VOID context
[perl5.git] / ext / XS-APItest / t / call.t
CommitLineData
d1f347d7
DM
1#!perl -w
2
3# test the various call-into-perl-from-C functions
4# DAPM Aug 2004
5
d1f347d7
DM
6use warnings;
7use strict;
8
43d2322d 9# Test::More doesn't have fresh_perl_is() yet
7ce09284 10# use Test::More tests => 342;
d1f347d7 11
dedbcade 12BEGIN {
2adbc9b6 13 require '../../t/test.pl';
7051b8c3 14 plan(455);
dedbcade
DM
15 use_ok('XS::APItest')
16};
d1f347d7
DM
17
18#########################
19
4aca2f62
DM
20# f(): general test sub to be called by call_sv() etc.
21# Return the called args, but with the first arg replaced with 'b',
22# and the last arg replaced with x/y/z depending on context
23#
d1f347d7
DM
24sub f {
25 shift;
26 unshift @_, 'b';
27 pop @_;
28 @_, defined wantarray ? wantarray ? 'x' : 'y' : 'z';
29}
30
a85ce6f0
DD
31our $call_sv_count = 0;
32sub i {
33 $call_sv_count++;
34}
35call_sv_C();
36is($call_sv_count, 6, "call_sv_C passes");
37
d1f347d7 38sub d {
d1f347d7
DM
39 die "its_dead_jim\n";
40}
41
42my $obj = bless [], 'Foo';
43
44sub Foo::meth {
45 return 'bad_self' unless @_ && ref $_[0] && ref($_[0]) eq 'Foo';
46 shift;
47 shift;
48 unshift @_, 'b';
49 pop @_;
50 @_, defined wantarray ? wantarray ? 'x' : 'y' : 'z';
51}
52
53sub Foo::d {
d1f347d7
DM
54 die "its_dead_jim\n";
55}
56
57for my $test (
58 # flags args expected description
59 [ G_VOID, [ ], [ qw(z 1) ], '0 args, G_VOID' ],
60 [ G_VOID, [ qw(a p q) ], [ qw(z 1) ], '3 args, G_VOID' ],
61 [ G_SCALAR, [ ], [ qw(y 1) ], '0 args, G_SCALAR' ],
62 [ G_SCALAR, [ qw(a p q) ], [ qw(y 1) ], '3 args, G_SCALAR' ],
63 [ G_ARRAY, [ ], [ qw(x 1) ], '0 args, G_ARRAY' ],
64 [ G_ARRAY, [ qw(a p q) ], [ qw(b p x 3) ], '3 args, G_ARRAY' ],
65 [ G_DISCARD, [ ], [ qw(0) ], '0 args, G_DISCARD' ],
66 [ G_DISCARD, [ qw(a p q) ], [ qw(0) ], '3 args, G_DISCARD' ],
67)
68{
69 my ($flags, $args, $expected, $description) = @$test;
70
71 ok(eq_array( [ call_sv(\&f, $flags, @$args) ], $expected),
72 "$description call_sv(\\&f)");
73
74 ok(eq_array( [ call_sv(*f, $flags, @$args) ], $expected),
75 "$description call_sv(*f)");
76
77 ok(eq_array( [ call_sv('f', $flags, @$args) ], $expected),
78 "$description call_sv('f')");
79
80 ok(eq_array( [ call_pv('f', $flags, @$args) ], $expected),
81 "$description call_pv('f')");
82
83 ok(eq_array( [ eval_sv('f(' . join(',',map"'$_'",@$args) . ')', $flags) ],
2aabfe8a
DM
84 $flags == G_VOID ? [ 0 ] : $expected
85 ),
86 "$description eval_sv('f(args)')");
d1f347d7
DM
87
88 ok(eq_array( [ call_method('meth', $flags, $obj, @$args) ], $expected),
89 "$description call_method('meth')");
90
b8d2d791
NC
91 my $returnval = ((($flags & G_WANT) == G_ARRAY) || ($flags & G_DISCARD))
92 ? [0] : [ undef, 1 ];
d1f347d7
DM
93 for my $keep (0, G_KEEPERR) {
94 my $desc = $description . ($keep ? ' G_KEEPERR' : '');
7ce09284
Z
95 my $exp_warn = $keep ? "\t(in cleanup) its_dead_jim\n" : "";
96 my $exp_err = $keep ? "before\n"
d1f347d7 97 : "its_dead_jim\n";
7ce09284
Z
98 my $warn;
99 local $SIG{__WARN__} = sub { $warn .= $_[0] };
d1f347d7 100 $@ = "before\n";
7ce09284 101 $warn = "";
d1f347d7 102 ok(eq_array( [ call_sv('d', $flags|G_EVAL|$keep, @$args) ],
b8d2d791 103 $returnval),
d1f347d7
DM
104 "$desc G_EVAL call_sv('d')");
105 is($@, $exp_err, "$desc G_EVAL call_sv('d') - \$@");
7ce09284 106 is($warn, $exp_warn, "$desc G_EVAL call_sv('d') - warning");
d1f347d7
DM
107
108 $@ = "before\n";
7ce09284 109 $warn = "";
d1f347d7 110 ok(eq_array( [ call_pv('d', $flags|G_EVAL|$keep, @$args) ],
b8d2d791 111 $returnval),
d1f347d7
DM
112 "$desc G_EVAL call_pv('d')");
113 is($@, $exp_err, "$desc G_EVAL call_pv('d') - \$@");
7ce09284 114 is($warn, $exp_warn, "$desc G_EVAL call_pv('d') - warning");
d1f347d7
DM
115
116 $@ = "before\n";
7ce09284 117 $warn = "";
d1f347d7 118 ok(eq_array( [ eval_sv('d()', $flags|$keep) ],
b8d2d791 119 $returnval),
d1f347d7
DM
120 "$desc eval_sv('d()')");
121 is($@, $exp_err, "$desc eval_sv('d()') - \$@");
7ce09284 122 is($warn, $exp_warn, "$desc G_EVAL eval_sv('d') - warning");
d1f347d7
DM
123
124 $@ = "before\n";
7ce09284 125 $warn = "";
d1f347d7 126 ok(eq_array( [ call_method('d', $flags|G_EVAL|$keep, $obj, @$args) ],
b8d2d791 127 $returnval),
d1f347d7
DM
128 "$desc G_EVAL call_method('d')");
129 is($@, $exp_err, "$desc G_EVAL call_method('d') - \$@");
7ce09284 130 is($warn, $exp_warn, "$desc G_EVAL call_method('d') - warning");
d1f347d7
DM
131 }
132
133 ok(eq_array( [ sub { call_sv('f', $flags|G_NOARGS, "bad") }->(@$args) ],
134 $expected), "$description G_NOARGS call_sv('f')");
135
136 ok(eq_array( [ sub { call_pv('f', $flags|G_NOARGS, "bad") }->(@$args) ],
137 $expected), "$description G_NOARGS call_pv('f')");
138
139 ok(eq_array( [ sub { eval_sv('f(@_)', $flags|G_NOARGS) }->(@$args) ],
2aabfe8a
DM
140 $flags == G_VOID ? [ 0 ] : $expected
141 ),
142 "$description G_NOARGS eval_sv('f(@_)')");
d1f347d7
DM
143
144 # XXX call_method(G_NOARGS) isn't tested: I'm assuming
145 # it's not a sensible combination. DAPM.
146
147 ok(eq_array( [ eval { call_sv('d', $flags, @$args)}, $@ ],
148 [ "its_dead_jim\n" ]), "$description eval { call_sv('d') }");
149
150 ok(eq_array( [ eval { call_pv('d', $flags, @$args) }, $@ ],
151 [ "its_dead_jim\n" ]), "$description eval { call_pv('d') }");
152
153 ok(eq_array( [ eval { eval_sv('d', $flags), $@ }, $@ ],
b8d2d791 154 [ @$returnval,
dedbcade 155 "its_dead_jim\n", '' ]),
d1f347d7
DM
156 "$description eval { eval_sv('d') }");
157
158 ok(eq_array( [ eval { call_method('d', $flags, $obj, @$args) }, $@ ],
159 [ "its_dead_jim\n" ]), "$description eval { call_method('d') }");
160
161};
162
0b06a753
NT
163{
164 # these are the ones documented in perlcall.pod
165 my @flags = (G_DISCARD, G_NOARGS, G_EVAL, G_KEEPERR);
166 my $mask = 0;
167 $mask |= $_ for (@flags);
168 is(unpack('%32b*', pack('l', $mask)), @flags,
169 "G_DISCARD and the rest are separate bits");
170}
171
7ce09284
Z
172foreach my $inx ("", "aabbcc\n", [qw(aa bb cc)]) {
173 foreach my $outx ("", "xxyyzz\n", [qw(xx yy zz)]) {
174 my $warn;
175 local $SIG{__WARN__} = sub { $warn .= $_[0] };
176 $@ = $outx;
177 $warn = "";
178 call_sv(sub { die $inx if $inx }, G_VOID|G_EVAL);
179 ok ref($@) eq ref($inx) && $@ eq $inx;
180 $warn =~ s/ at [^\n]*\n\z//;
181 is $warn, "";
182 $@ = $outx;
183 $warn = "";
184 call_sv(sub { die $inx if $inx }, G_VOID|G_EVAL|G_KEEPERR);
185 ok ref($@) eq ref($outx) && $@ eq $outx;
186 $warn =~ s/ at [^\n]*\n\z//;
187 is $warn, $inx ? "\t(in cleanup) $inx" : "";
188 }
189}
190
191{
192 no warnings "misc";
193 my $warn = "";
194 local $SIG{__WARN__} = sub { $warn .= $_[0] };
195 call_sv(sub { die "aa\n" }, G_VOID|G_EVAL|G_KEEPERR);
196 is $warn, "";
197}
198
199{
fc941f37 200 no warnings "misc";
7ce09284
Z
201 my $warn = "";
202 local $SIG{__WARN__} = sub { $warn .= $_[0] };
fc941f37 203 call_sv(sub { use warnings "misc"; die "aa\n" }, G_VOID|G_EVAL|G_KEEPERR);
7ce09284
Z
204 is $warn, "\t(in cleanup) aa\n";
205}
206
d1f347d7
DM
207is(eval_pv('f()', 0), 'y', "eval_pv('f()', 0)");
208is(eval_pv('f(qw(a b c))', 0), 'y', "eval_pv('f(qw(a b c))', 0)");
209is(eval_pv('d()', 0), undef, "eval_pv('d()', 0)");
210is($@, "its_dead_jim\n", "eval_pv('d()', 0) - \$@");
211is(eval { eval_pv('d()', 1) } , undef, "eval { eval_pv('d()', 1) }");
212is($@, "its_dead_jim\n", "eval { eval_pv('d()', 1) } - \$@");
dedbcade 213
4aca2f62
DM
214
215# #3719 - check that the eval call variants handle exceptions correctly,
216# and do the right thing with $@, both with and without G_KEEPERR set.
217
218sub f99 { 99 };
219
a1f85fba
DM
220my @bodies = (
221 # [ code, is_fn_name, expect_success, has_inner_die, expected_err ]
4aca2f62 222
a1f85fba
DM
223 # ok
224 [ 'f99', 1, 1, 0, qr/^$/, ],
225 # compile-time err
226 [ '$x=', 0, 0, 0, qr/syntax error/, ],
227 # compile-time exception
228 [ 'BEGIN { die "die in BEGIN"}', 0, 0, 1, qr/die in BEGIN/, ],
229 # run-time exception
230 [ 'd', 1, 0, 0, qr/its_dead_jim/, ],
7051b8c3
DM
231 # success with caught exception
232 [ 'eval { die "blah" }; 99', 0, 1, 1, qr/^$/, ],
a1f85fba
DM
233);
234
235
236for my $fn_type (qw(eval_pv eval_sv call_sv)) {
4aca2f62
DM
237
238 my $warn_msg;
6b2fb389 239 local $SIG{__WARN__} = sub { $warn_msg .= $_[0] };
4aca2f62 240
a1f85fba
DM
241 for my $body (@bodies) {
242 my ($code, $is_fn_name, $expect_success,
243 $has_inner_die, $expected_err_qr) = @$body;
4aca2f62
DM
244
245 # call_sv can only handle function names, not code snippets
a1f85fba 246 next if $fn_type eq 'call_sv' and !$is_fn_name;
4aca2f62
DM
247
248 for my $keep (0, G_KEEPERR) {
4aca2f62
DM
249 my $keep_desc = $keep ? 'G_KEEPERR' : '0';
250
251 my $desc;
a1f85fba 252 my $expect = $expect_success;
4aca2f62
DM
253
254 undef $warn_msg;
255 $@ = 'pre-err';
256
257 my @ret;
a1f85fba 258 if ($fn_type eq 'eval_pv') {
4aca2f62
DM
259 # eval_pv returns its result rather than a 'succeed' boolean
260 $expect = $expect ? '99' : undef;
261
262 # eval_pv doesn't support G_KEEPERR, but it has a croak
263 # boolean arg instead, so switch on that instead
264 if ($keep) {
265 $desc = "eval { eval_pv('$code', 1) }";
266 @ret = eval { eval_pv($code, 1); '99' };
267 # die in eval returns empty list
268 push @ret, undef unless @ret;
269 }
270 else {
271 $desc = "eval_pv('$code', 0)";
272 @ret = eval_pv($code, 0);
273 }
274 }
a1f85fba 275 elsif ($fn_type eq 'eval_sv') {
4aca2f62
DM
276 $desc = "eval_sv('$code', G_ARRAY|$keep_desc)";
277 @ret = eval_sv($code, G_ARRAY|$keep);
278 }
a1f85fba 279 elsif ($fn_type eq 'call_sv') {
4aca2f62
DM
280 $desc = "call_sv('$code', G_EVAL|G_ARRAY|$keep_desc)";
281 @ret = call_sv($code, G_EVAL|G_ARRAY|$keep);
282 }
a1f85fba 283 is(scalar @ret, ($expect_success && $fn_type ne 'eval_pv') ? 2 : 1,
4aca2f62
DM
284 "$desc - number of returned args");
285 is($ret[-1], $expect, "$desc - return value");
286
a1f85fba 287 if ($keep && $fn_type ne 'eval_pv') {
6b2fb389 288 # G_KEEPERR doesn't propagate into inner evals, requires etc
a1f85fba 289 unless ($keep && $has_inner_die) {
6b2fb389
DM
290 is($@, 'pre-err', "$desc - \$@ unmodified");
291 }
4aca2f62
DM
292 $@ = $warn_msg;
293 }
294 else {
295 is($warn_msg, undef, "$desc - __WARN__ not called");
aaa63dae 296 unlike($@, qr/pre-err/, "$desc - \$@ modified");
4aca2f62 297 }
a1f85fba 298 like($@, $expected_err_qr, "$desc - the correct error message");
4aca2f62
DM
299 }
300 }
301}
302
dedbcade
DM
303# DAPM 9-Aug-04. A taint test in eval_sv() could die after setting up
304# a new jump level but before pushing an eval context, leading to
305# stack corruption
306
2adbc9b6 307fresh_perl_is(<<'EOF', "x=2", { switches => ['-T', '-I../../lib'] }, 'eval_sv() taint');
dedbcade
DM
308use XS::APItest;
309
310my $x = 0;
311sub f {
312 eval { my @a = ($^X . "x" , eval_sv(q(die "inner\n"), 0)) ; };
313 $x++;
314 $a <=> $b;
315}
316
317eval { my @a = sort f 2, 1; $x++};
318print "x=$x\n";
319EOF
320