su_uplevel: populate lower stack frames properly

When creating a temporary new argument stack, su_uplevel() copies most of
the old stack to a new one. This isn't really needed, as the new stack
will be abandoned before it ever pops back to that level.  But it *is*
needed when debugging code prints out the stack, as in for example,
'perl -Dstv'.

However, the code didn't actually copy the old stack: it copied garbage
instead, since it was using PL_curstack rather than AvARRAY(PL_curstack)
as the address of of the old stack. Which was causing 'perl -Dstv' to
SEGV.

This commit fixes that.

fix unwind()

Perl 5.23.4 debugging builds added asserts to POPMARK etc that nothing
was underflowing etc. At this point 52-unwind-context.t started failing
with

    Perl_pp_return: Assertion `((my_perl->Imarkstack_ptr) >
    (my_perl->Imarkstack)) || !"MARK underflow"' failed.

Properly pushing a new mark for pp_return to pop rather than doing it
manually seems to fix this.

get su_init/su_pop working under 5.23.8

In 5.23.8 there are two big differences to the way perl's context system
manipulates the savestack. Firstly, pushing a scope no longer does one or
two ENTER's instead the old value of PL_savestack_ix is stored as
cx->blk_oldsaveix. This means that the boundaries of savestack frames are
now not only specified as scopestack entries, but also as blk_oldsaveix
entries.

Secondly, most values that need restoring are saved in new fields in the
CX structure rather than being pushed on the savestack; this means that it
is quite likely that two nested scopes can share the same savestack index.

This commit gets all the test scripts working that mainly test the
savestack manipulation code (su_init and su_pop).

It does this by:

*) allowing the offset by which a savestack frame boundary is adjusted to
be variable (rather than always SU_SAVE_DESTRUCTOR_SIZE), and by turning
the origin array into an array of structs, one field of which is the
offset for that depth. This allows multiple empty savestack frames
to all trigger, by ensuring that each adjusted boundary is higher than the
previous.

*) padding the savestack using SAVEt_ALLOC, which allows a variable-sized
chunk of savestack to be reserved, with minimal overhead during scope exit.

In addition,

*) the various SU_SAVE_AELEM_SIZE type macros have been rationalised and
better commented;
*) debugging output for su_init and su_pop has been improved
*) the names of context types (for debugging) have been updated for 5.23.8
and some errors fixes for older perl versions

Some basic 5.23.8 fixes

The context system has changed a lot in 5.23.8. This commit
just gets the code compiling again; it doesn';t attempt to fix any
breakage.

Temporarily rename xsh_debug_log to su_debug_log

In a previous commit that function was renamed, but none of its callers
were renamed. For now, revert the function back to its old name

Fix off-by-one error in su_uplevel_ud->si initialization

si->si_cxmax is the last available context slot, hence should be -1 if we
don't allocate any.

The Big Boilerplate Factorization

This is 0.28

Don't hardcode the length of NEGATIVE_INDICES_VAR

Only dump debug info when $Scope::Upper::DEBUG is true

Factor a part of the debugging logic into an helper function

Add braces around a condition block

Add a comment in the initializing loop in su_init()

Document the new warnings and caveats

Add some comments to the mysterious su_init()/su_pop()

Remove one level of indirection in the UID internal structure

On top of the memory savings, this seems to make the UID stress test about
7% faster, even with a threaded build.

Port t/79-uid-threads.t to the new threads interface

For some reason it was still calling threads->create(). This commit also
makes sure that the test is resilient to stray exits.

Harden t/69-uplevel-threads.t against stray exits

Harden t/59-yield-threads.t against stray exits

Harden t/54-unwind-threads.t against stray exits

Harden t/09-load-tests.t against stray exits

Update VPIT::TestHelpers to ba865c42

Also warn when SUB() and EVAL() cannot find an appropriate target

Warn when the words target a context outside of the current stack

Note that the check is done when the target context is defined and not
when the helpers use it.

This fixes RT #104751.

Stop copying the reap-ed coderef

Remove some extraneous SU_UD_ORIGIN(ud) initializations

Revamp the different su_ud_* subtypes

For reap(), su_call() now only gets the SV cb and not the whole su_ud_reap
structure. This lets us free the ud in su_pop(), and likewise for
su_localize(). As for the uid feature, it gets its own su_ud_uid structure
instead of hijacking su_ud_reap, so that su_uid_bump() is no longer needed.

Replace the su_handler[] dispatch table by a switch

This lets us inline the handlers in su_pop(), which is somewhat clearer.

Remove the code coverage link

It's outdated and now covered by cpancover.

Refactor the su_ud_common structure

The handler member is replaced by a small integer index into a static array.
The pad member is shrank so that it can be packed together with the type.
In the remaining space, we fit a private member that can be used to remove
the type member of su_ud_localize.

Greatly simplify the depth computation in su_init()

In order to count how many scopes we will have to pop, it is enough to take
the difference between the current scope (PL_scopestack_ix) and the one
just below the target context (cxstack[cxix].blk_oldscopesp).

Give a proper definition of SU_CXNAME() for non DEBUGGING builds

Rewrite the origin initialization loop in su_init()

It used to iterate downward, and then the indices used were of the form
a - i and b - i.

Silence a 'shadowing' warning

Update t/09-load-threads.t

It now also exercises cloning.

Update VPIT::TestHelpers to 2a6ac0f1

Update t/09-load-threads.t

It now has better diagnostics in case of failure, and it tests asymetrical
thread termination.

Add a missing volatile qualifier

Improve scheduling for the parallel loading test

This is 0.27

Document that we can no longer die from uplevel in the debugger

Also preserve PL_scopestack[cx->blk_oldscopesp - 1] in formats

Correctly use $TEST_VERBOSE in the testdeb target

Preserve PL_scopestack[cx->blk_oldscopesp - 1] in su_pop()

Starting from perl 5.19.4 commit 2537512, pp_leavesub does a second
leave_scope(PL_scopestack[cx->blk_oldscopesp - 1]) just after the usual
LEAVE call. However, this index in the scope stack may be overwritten
by our own "flush" leave_scope() call in su_pop(). More precisely, this
seems to happen in sv_clear() (called from sv_free2() called from
sv_unref_flags() called from sv_force_normal_flags() called from
leave_scope()) and only when the debugger is enabled.

Add POSIX to build requires

Update the ActivePerl/gcc-3.4 hack for EUMM 7.04

Starting from this version, PERL_ARCHIVE is quoted so we can no longer set
it to the empty string. Instead, we remove all occurrences of PERL_ARCHIVE
in the linking step section of the Makefile, which is OK since we specify
the perl DLL in other variables. This new technique is still valid for
older versions of EUMM.

Don't compile su_uplevel_storage_delete() before perl 5.13.7

As it is unused on these older perls.

Protect t/09-load-threads.t against old relocated perls

Update VPIT::TestHelpers to 4eeb5afc

Also test that the module can be loaded in the main body

In t/09-load-threads.t, handle spawn() failures gracefully

Thoroughly test module loading in threads

Update VPIT::TestHelpers to 6ca15279

Update VPIT::TestHelpers to 6cd68168

And port threads tests to its new interface. The new 'force threads test'
environment variable is PERL_FORCE_TEST_THREADS.

Release UID global memory at global teardown time

Revamp the setup boot logic

Silence an "unused label" compiler warning

Replace STATIC by static

Fix a memory leak with the uid() feature

The user data token was never freed.

This is 0.26

Bump copyright year

Update VPIT::TestHelpers to 3c878c7c

Don’t use CvPADLIST on XSUBs

That field has been repurposed for XSUBs in perl 5.21.7. It used to be
ignored for older perls.

This fixes RT #100264.

Remove an unused variable declaration

Really be compatible with the OP_PARENT feature

OP_SIBLING() has been renamed to OpSIBLING() in perl 5.21.7.

This is 0.25

Update VPIT::TestHelpers to 4fb18792

Bump copyright year

Work around an assertion failure in perl 5.21.4

This was fixed in perl by commit 5988f306, in which Father Chrysostomos
says "CvNAMED should never be on after calling [CvGV_set], regardless
of the previous state of the CV".

Add support for PERL_OP_PARENT

This was introduced in perl 5.21.2.

This is 0.24

Preserve lexicals across dounwind() calls on perl 5.19.4 and above

unwind() used to rely on the stack being preserved when dounwind() is
called. However, starting with change 25375124, dounwind() can now call
leave_scope() which will clean up lexicals in the unwinded scopes. We
can work around this by temporarily bumping the refcount of possibly
problematic scalars before calling dounwind().

See also https://rt.perl.org/rt3/Ticket/Display.html?id=119681.

This is 0.23

Style nits

Adjust t/07-context_info.t for perl 5.19.3

This fixes RT #88177.

Update bundled Test::Leaner to 0.05

Enforce the perl dependency in the module file

Make Perl version numbers more readable

Remove obsolete kwalitee workarounds

No tabs please

Stop bundling author tests

Silence experimental warnings on perl 5.17.11+ for given/when in tests

Using if.pm would have been cleaner but it is core only on perl 5.6.2, and
we still support 5.6.1. Moreover, trusting the toolchain on such old perls
is not really an option.

Typos in POD

Reported by dsteinbrunner@pobox.com.

This fixes RT #87178.

Update the bug tracker URL in META after the rt.perl.org upgrade

Get rid of t/99-kwalitee.t

New versions started to throw warnings if specific environment variables
are not set. This may be appropriate for dist manager users, but not really
for the rest of the world.

Since kwalitee metrics are either obvious or useless, there's no big loss
in removing this test anyway.

This is 0.22

Bump copyright year

Update VPIT::TestHelpers to e8344578

context_info() should ignore %warnings::Bits until perl 5.8.7

Just like what caller() does.

Correct the top warnings mask for 5.6 in t/07-context_info.t

It changes depending on whether the test is called with -w or not, which
itself depends on the version of Test::Harness used. To add to the
confusion, perl 5.6.1 comes without Test::More, so installing it pulls a
recent version of Test::Harness that does no longer enforces -w.

Require perl 5.6.1

Also skip the uplevel across eval/local $@ test on perl 5.8.[345]

A more recent set of debugging 5.8 perls shows that this test also causes
"Can't undef active subroutine during global destruction" errors with
perl 5.8.[345]. The test used to be skipped for perl 5.8.[0126], it is now
skipped for perl 5.8.[0-6], which makes definitely more sense anyway.

Skip 'yield to subst context' tests on perl 5.8 and below

The snippet :

    my $s = "foo";
    eval { $s =~ s/./die "wut"/e };
    qr/bar/;

segfaults on a threaded, debugging and poisonous perl 5.8.9. Just to be
safe, the relevant test won't be run before perl 5.10.

Don't run the POD spelling test in taint mode

This causes the test to crash on perl 5.12 and below with sensitive
architectures like FreeBSD. Ultimately the root of the issue seems to have
been https://rt.perl.org/rt3/Public/Bug/Display.html?id=60378.

Thanks Slaven Rezic for debugging this.

Add Config to build_requires

This is 0.21

Remove an extra ;

Force linking against the perl dll when using gcc 3.4 on Windows

When a Windows perl links an XS shared object to an import library using
gcc/g++ version 3.4.x, strange breakage happens at load time because the
mutex-related symbols seems not to be reachable. This situation happens
especially for AS perl and the default compiler suite it installs.

We fix this by forcing g++ to link against the dll instead, which should
be in the same directory as the perl executable (at least for AS perl).

Make t/07-context_info.t pass with perls that have usesitecustomize set

sitecustomize.pl adds a "BEGIN { do { my $x; 1 } }" at the beginning of
the test code, which causes HINT_BLOCK_SCOPE to leak to the main program.

Fix context_info() warnings field for perl 5.17.4