regexec.c - add assert and test for savestack overflow in Issue #20826.

We have a bug where we can overflow the save-stack. This tests for it
in a TODO test. The next patch will fix it. Note the test will only fail
in debugging as it requires the assert() to be compiled in.

2 files changed, 16 insertions, 1 deletions

diff --git a/regexec.c b/regexec.c
index c37193d004..3d9caa5104 100644
--- a/regexec.c
+++ b/regexec.c
@@ -263,6 +263,7 @@ S_regcppush(pTHX_ const regexp *rex, I32 parenfloor, U32 maxopenparen _pDEPTH)
     );
 
     SSCHECK(total_elems + REGCP_FRAME_ELEMS);
+    assert((IV)PL_savestack_max > (IV)(total_elems + REGCP_FRAME_ELEMS));
 
     /* memcpy the offs inside the stack - it's faster than for loop */
     memcpy(&PL_savestack[PL_savestack_ix], rex->offs + parenfloor + 1, paren_bytes_to_push);
diff --git a/t/re/pat.t b/t/re/pat.t
index 2de4981195..d950c30ec9 100644
--- a/t/re/pat.t
+++ b/t/re/pat.t
@@ -27,7 +27,7 @@ skip_all_without_unicode_tables();
 
 my $has_locales = locales_enabled('LC_CTYPE');
 
-plan tests => 1230;  # Update this when adding/deleting tests.
+plan tests => 1231;  # Update this when adding/deleting tests.
 
 run_tests() unless caller;
 
@@ -2413,6 +2413,20 @@ SKIP:
         is($y,"b","Branch reset in list context check 11 (b)");
         is($z,"z","Branch reset in list context check 12 (z)");
     }
+    TODO:{
+        local $::TODO = "Will be fixed next commit";
+        # Test for GH Issue #20826. Save stack overflow introduced in
+        # 92373dea9d7bcc0a017f20cb37192c1d8400767f PR #20530.
+        # Note this test depends on an assert so it will only fail
+        # under DEBUGGING.
+        fresh_perl_is(q{
+            $_ = "x" x 1000;
+            my $pat = '(.)' x 200;
+            $pat = qr/($pat)+/;
+            m/$pat/;
+            print "ok";
+        }, 'ok', {}, 'gh20826: test regex save stack overflow');
+    }
 } # End of sub run_tests
 
 1;