Upper.xs

   1 /* This file is part of the Scope::Upper Perl module.
   2  * See http://search.cpan.org/dist/Scope-Upper/ */
   3
   4 #define PERL_NO_GET_CONTEXT
   5 #include "EXTERN.h"
   6 #include "perl.h"
   7 #include "XSUB.h"
   8
   9 #define __PACKAGE__ "Scope::Upper"
  10
  11 #ifndef SU_DEBUG
  12 # define SU_DEBUG 0
  13 #endif
  14
  15 /* --- Compatibility ------------------------------------------------------- */
  16
  17 #ifndef NOOP
  18 # define NOOP
  19 #endif
  20
  21 #ifndef dNOOP
  22 # define dNOOP
  23 #endif
  24
  25 #ifndef dVAR
  26 # define dVAR dNOOP
  27 #endif
  28
  29 #ifndef MUTABLE_SV
  30 # define MUTABLE_SV(S) ((SV *) (S))
  31 #endif
  32
  33 #ifndef MUTABLE_AV
  34 # define MUTABLE_AV(A) ((AV *) (A))
  35 #endif
  36
  37 #ifndef MUTABLE_CV
  38 # define MUTABLE_CV(C) ((CV *) (C))
  39 #endif
  40
  41 #ifndef PERL_UNUSED_VAR
  42 # define PERL_UNUSED_VAR(V)
  43 #endif
  44
  45 #ifndef STMT_START
  46 # define STMT_START do
  47 #endif
  48
  49 #ifndef STMT_END
  50 # define STMT_END while (0)
  51 #endif
  52
  53 #if SU_DEBUG
  54 # define SU_D(X) STMT_START X STMT_END
  55 #else
  56 # define SU_D(X)
  57 #endif
  58
  59 #ifndef Newx
  60 # define Newx(v, n, c) New(0, v, n, c)
  61 #endif
  62
  63 #ifdef DEBUGGING
  64 # ifdef PoisonNew
  65 #  define SU_POISON(D, N, T) PoisonNew((D), (N), T)
  66 # elif defined(Poison)
  67 #  define SU_POISON(D, N, T) Poison((D), (N), T)
  68 # endif
  69 #endif
  70 #ifndef SU_POISON
  71 # define SU_POISON(D, N, T) NOOP
  72 #endif
  73
  74 #ifndef newSV_type
  75 STATIC SV *su_newSV_type(pTHX_ svtype t) {
  76  SV *sv = newSV(0);
  77  SvUPGRADE(sv, t);
  78  return sv;
  79 }
  80 # define newSV_type(T) su_newSV_type(aTHX_ (T))
  81 #endif
  82
  83 #ifndef SvPV_const
  84 # define SvPV_const(S, L) SvPV(S, L)
  85 #endif
  86
  87 #ifndef SvPVX_const
  88 # define SvPVX_const(S) SvPVX(S)
  89 #endif
  90
  91 #ifndef SvPV_nolen_const
  92 # define SvPV_nolen_const(S) SvPV_nolen(S)
  93 #endif
  94
  95 #ifndef SvREFCNT_inc_simple_void
  96 # define SvREFCNT_inc_simple_void(sv) ((void) SvREFCNT_inc(sv))
  97 #endif
  98
  99 #ifndef mPUSHi
 100 # define mPUSHi(I) PUSHs(sv_2mortal(newSViv(I)))
 101 #endif
 102
 103 #ifndef GvCV_set
 104 # define GvCV_set(G, C) (GvCV(G) = (C))
 105 #endif
 106
 107 #ifndef CvGV_set
 108 # define CvGV_set(C, G) (CvGV(C) = (G))
 109 #endif
 110
 111 #ifndef CvSTASH_set
 112 # define CvSTASH_set(C, S) (CvSTASH(C) = (S))
 113 #endif
 114
 115 #ifndef CvISXSUB
 116 # define CvISXSUB(C) CvXSUB(C)
 117 #endif
 118
 119 #ifndef CxHASARGS
 120 # define CxHASARGS(C) ((C)->blk_sub.hasargs)
 121 #endif
 122
 123 #ifndef HvNAME_get
 124 # define HvNAME_get(H) HvNAME(H)
 125 #endif
 126
 127 #ifndef gv_fetchpvn_flags
 128 # define gv_fetchpvn_flags(A, B, C, D) gv_fetchpv((A), (C), (D))
 129 #endif
 130
 131 #ifndef PERL_MAGIC_tied
 132 # define PERL_MAGIC_tied 'P'
 133 #endif
 134
 135 #ifndef PERL_MAGIC_env
 136 # define PERL_MAGIC_env 'E'
 137 #endif
 138
 139 #ifndef NEGATIVE_INDICES_VAR
 140 # define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"
 141 #endif
 142
 143 #define SU_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
 144 #define SU_HAS_PERL_EXACT(R, V, S) ((PERL_REVISION == (R)) && (PERL_VERSION == (V)) && (PERL_SUBVERSION == (S)))
 145
 146 /* --- Threads and multiplicity -------------------------------------------- */
 147
 148 #ifndef SU_MULTIPLICITY
 149 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
 150 #  define SU_MULTIPLICITY 1
 151 # else
 152 #  define SU_MULTIPLICITY 0
 153 # endif
 154 #endif
 155 #if SU_MULTIPLICITY && !defined(tTHX)
 156 # define tTHX PerlInterpreter*
 157 #endif
 158
 159 #if SU_MULTIPLICITY && defined(USE_ITHREADS) && defined(dMY_CXT) && defined(MY_CXT) && defined(START_MY_CXT) && defined(MY_CXT_INIT) && (defined(MY_CXT_CLONE) || defined(dMY_CXT_SV))
 160 # define SU_THREADSAFE 1
 161 # ifndef MY_CXT_CLONE
 162 #  define MY_CXT_CLONE \
 163     dMY_CXT_SV;                                                      \
 164     my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
 165     Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
 166     sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
 167 # endif
 168 #else
 169 # define SU_THREADSAFE 0
 170 # undef  dMY_CXT
 171 # define dMY_CXT      dNOOP
 172 # undef  MY_CXT
 173 # define MY_CXT       su_globaldata
 174 # undef  START_MY_CXT
 175 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
 176 # undef  MY_CXT_INIT
 177 # define MY_CXT_INIT  NOOP
 178 # undef  MY_CXT_CLONE
 179 # define MY_CXT_CLONE NOOP
 180 #endif
 181
 182 /* --- unwind() global storage --------------------------------------------- */
 183
 184 typedef struct {
 185  I32      cxix;
 186  I32      items;
 187  SV     **savesp;
 188  LISTOP   return_op;
 189  OP       proxy_op;
 190 } su_unwind_storage;
 191
 192 /* --- uplevel() data tokens and global storage ---------------------------- */
 193
 194 typedef struct {
 195  void *next;
 196
 197  I32  cxix;
 198  bool died;
 199
 200  CV  *target;
 201  I32  target_depth;
 202
 203  CV  *callback;
 204
 205  PERL_SI *si;
 206  PERL_SI *old_curstackinfo;
 207  AV      *old_mainstack;
 208
 209  COP *old_curcop;
 210
 211  bool old_catch;
 212  OP  *old_op;
 213 } su_uplevel_ud;
 214
 215 STATIC su_uplevel_ud *su_uplevel_ud_new(pTHX) {
 216 #define su_uplevel_ud_new() su_uplevel_ud_new(aTHX)
 217  su_uplevel_ud *sud;
 218  PERL_SI       *si;
 219
 220  Newx(sud, 1, su_uplevel_ud);
 221  sud->next = NULL;
 222
 223  Newx(si, 1, PERL_SI);
 224  si->si_stack   = newAV();
 225  AvREAL_off(si->si_stack);
 226  si->si_cxstack = NULL;
 227  si->si_cxmax   = 0;
 228
 229  sud->si = si;
 230
 231  return sud;
 232 }
 233
 234 STATIC void su_uplevel_ud_delete(pTHX_ su_uplevel_ud *sud) {
 235 #define su_uplevel_ud_delete(S) su_uplevel_ud_delete(aTHX_ (S))
 236  PERL_SI *si = sud->si;
 237
 238  Safefree(si->si_cxstack);
 239  SvREFCNT_dec(si->si_stack);
 240  Safefree(si);
 241  Safefree(sud);
 242
 243  return;
 244 }
 245
 246 typedef struct {
 247  su_uplevel_ud *root;
 248  I32            count;
 249 } su_uplevel_storage;
 250
 251 #ifndef SU_UPLEVEL_STORAGE_SIZE
 252 # define SU_UPLEVEL_STORAGE_SIZE 4
 253 #endif
 254
 255 /* --- Global data --------------------------------------------------------- */
 256
 257 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
 258
 259 typedef struct {
 260  char               *stack_placeholder;
 261  su_unwind_storage   unwind_storage;
 262  su_uplevel_storage  uplevel_storage;
 263 } my_cxt_t;
 264
 265 START_MY_CXT
 266
 267 /* --- Stack manipulations ------------------------------------------------- */
 268
 269 #define SU_SAVE_PLACEHOLDER() save_pptr(&MY_CXT.stack_placeholder)
 270
 271 #define SU_SAVE_DESTRUCTOR_SIZE  3
 272 #define SU_SAVE_PLACEHOLDER_SIZE 3
 273
 274 #define SU_SAVE_SCALAR_SIZE 3
 275
 276 #define SU_SAVE_ARY_SIZE      3
 277 #define SU_SAVE_AELEM_SIZE    4
 278 #ifdef SAVEADELETE
 279 # define SU_SAVE_ADELETE_SIZE 3
 280 #else
 281 # define SU_SAVE_ADELETE_SIZE SU_SAVE_DESTRUCTOR_SIZE
 282 #endif
 283 #if SU_SAVE_AELEM_SIZE < SU_SAVE_ADELETE_SIZE
 284 # define SU_SAVE_AELEM_OR_ADELETE_SIZE SU_SAVE_ADELETE_SIZE
 285 #else
 286 # define SU_SAVE_AELEM_OR_ADELETE_SIZE SU_SAVE_AELEM_SIZE
 287 #endif
 288
 289 #define SU_SAVE_HASH_SIZE    3
 290 #define SU_SAVE_HELEM_SIZE   4
 291 #define SU_SAVE_HDELETE_SIZE 4
 292 #if SU_SAVE_HELEM_SIZE < SU_SAVE_HDELETE_SIZE
 293 # define SU_SAVE_HELEM_OR_HDELETE_SIZE SU_SAVE_HDELETE_SIZE
 294 #else
 295 # define SU_SAVE_HELEM_OR_HDELETE_SIZE SU_SAVE_HELEM_SIZE
 296 #endif
 297
 298 #define SU_SAVE_GVCV_SIZE SU_SAVE_DESTRUCTOR_SIZE
 299
 300 #if !SU_HAS_PERL(5, 8, 9)
 301 # define SU_SAVE_GP_SIZE 6
 302 #elif !SU_HAS_PERL(5, 13, 0) || (SU_RELEASE && SU_HAS_PERL_EXACT(5, 13, 0))
 303 # define SU_SAVE_GP_SIZE 3
 304 #elif !SU_HAS_PERL(5, 13, 8)
 305 # define SU_SAVE_GP_SIZE 4
 306 #else
 307 # define SU_SAVE_GP_SIZE 3
 308 #endif
 309
 310 #ifndef SvCANEXISTDELETE
 311 # define SvCANEXISTDELETE(sv) \
 312   (!SvRMAGICAL(sv)            \
 313    || ((mg = mg_find((SV *) sv, PERL_MAGIC_tied))            \
 314        && (stash = SvSTASH(SvRV(SvTIED_obj((SV *) sv, mg)))) \
 315        && gv_fetchmethod_autoload(stash, "EXISTS", TRUE)     \
 316        && gv_fetchmethod_autoload(stash, "DELETE", TRUE)     \
 317       )                       \
 318    )
 319 #endif
 320
 321 /* ... Saving array elements ............................................... */
 322
 323 STATIC I32 su_av_key2idx(pTHX_ AV *av, I32 key) {
 324 #define su_av_key2idx(A, K) su_av_key2idx(aTHX_ (A), (K))
 325  I32 idx;
 326
 327  if (key >= 0)
 328   return key;
 329
 330 /* Added by MJD in perl-5.8.1 with 6f12eb6d2a1dfaf441504d869b27d2e40ef4966a */
 331 #if SU_HAS_PERL(5, 8, 1)
 332  if (SvRMAGICAL(av)) {
 333   const MAGIC * const tied_magic = mg_find((SV *) av, PERL_MAGIC_tied);
 334   if (tied_magic) {
 335    SV * const * const negative_indices_glob =
 336                     hv_fetch(SvSTASH(SvRV(SvTIED_obj((SV *) (av), tied_magic))),
 337                              NEGATIVE_INDICES_VAR, 16, 0);
 338    if (negative_indices_glob && SvTRUE(GvSV(*negative_indices_glob)))
 339     return key;
 340   }
 341  }
 342 #endif
 343
 344  idx = key + av_len(av) + 1;
 345  if (idx < 0)
 346   return key;
 347
 348  return idx;
 349 }
 350
 351 #ifndef SAVEADELETE
 352
 353 typedef struct {
 354  AV *av;
 355  I32 idx;
 356 } su_ud_adelete;
 357
 358 STATIC void su_adelete(pTHX_ void *ud_) {
 359  su_ud_adelete *ud = (su_ud_adelete *) ud_;
 360
 361  av_delete(ud->av, ud->idx, G_DISCARD);
 362  SvREFCNT_dec(ud->av);
 363
 364  Safefree(ud);
 365 }
 366
 367 STATIC void su_save_adelete(pTHX_ AV *av, I32 idx) {
 368 #define su_save_adelete(A, K) su_save_adelete(aTHX_ (A), (K))
 369  su_ud_adelete *ud;
 370
 371  Newx(ud, 1, su_ud_adelete);
 372  ud->av  = av;
 373  ud->idx = idx;
 374  SvREFCNT_inc_simple_void(av);
 375
 376  SAVEDESTRUCTOR_X(su_adelete, ud);
 377 }
 378
 379 #define SAVEADELETE(A, K) su_save_adelete((A), (K))
 380
 381 #endif /* SAVEADELETE */
 382
 383 STATIC void su_save_aelem(pTHX_ AV *av, SV *key, SV *val) {
 384 #define su_save_aelem(A, K, V) su_save_aelem(aTHX_ (A), (K), (V))
 385  I32 idx;
 386  I32 preeminent = 1;
 387  SV **svp;
 388  HV *stash;
 389  MAGIC *mg;
 390
 391  idx = su_av_key2idx(av, SvIV(key));
 392
 393  if (SvCANEXISTDELETE(av))
 394   preeminent = av_exists(av, idx);
 395
 396  svp = av_fetch(av, idx, 1);
 397  if (!svp || *svp == &PL_sv_undef) croak(PL_no_aelem, idx);
 398
 399  if (preeminent)
 400   save_aelem(av, idx, svp);
 401  else
 402   SAVEADELETE(av, idx);
 403
 404  if (val) { /* local $x[$idx] = $val; */
 405   SvSetMagicSV(*svp, val);
 406  } else {   /* local $x[$idx]; delete $x[$idx]; */
 407   av_delete(av, idx, G_DISCARD);
 408  }
 409 }
 410
 411 /* ... Saving hash elements ................................................ */
 412
 413 STATIC void su_save_helem(pTHX_ HV *hv, SV *keysv, SV *val) {
 414 #define su_save_helem(H, K, V) su_save_helem(aTHX_ (H), (K), (V))
 415  I32 preeminent = 1;
 416  HE *he;
 417  SV **svp;
 418  HV *stash;
 419  MAGIC *mg;
 420
 421  if (SvCANEXISTDELETE(hv) || mg_find((SV *) hv, PERL_MAGIC_env))
 422   preeminent = hv_exists_ent(hv, keysv, 0);
 423
 424  he  = hv_fetch_ent(hv, keysv, 1, 0);
 425  svp = he ? &HeVAL(he) : NULL;
 426  if (!svp || *svp == &PL_sv_undef) croak("Modification of non-creatable hash value attempted, subscript \"%s\"", SvPV_nolen_const(*svp));
 427
 428  if (HvNAME_get(hv) && isGV(*svp)) {
 429   save_gp((GV *) *svp, 0);
 430   return;
 431  }
 432
 433  if (preeminent)
 434   save_helem(hv, keysv, svp);
 435  else {
 436   STRLEN keylen;
 437   const char * const key = SvPV_const(keysv, keylen);
 438   SAVEDELETE(hv, savepvn(key, keylen),
 439                  SvUTF8(keysv) ? -(I32)keylen : (I32)keylen);
 440  }
 441
 442  if (val) { /* local $x{$keysv} = $val; */
 443   SvSetMagicSV(*svp, val);
 444  } else {   /* local $x{$keysv}; delete $x{$keysv}; */
 445   (void)hv_delete_ent(hv, keysv, G_DISCARD, HeHASH(he));
 446  }
 447 }
 448
 449 /* ... Saving code slots from a glob ....................................... */
 450
 451 #if !SU_HAS_PERL(5, 10, 0) && !defined(mro_method_changed_in)
 452 # define mro_method_changed_in(G) PL_sub_generation++
 453 #endif
 454
 455 typedef struct {
 456  GV *gv;
 457  CV *old_cv;
 458 } su_save_gvcv_ud;
 459
 460 STATIC void su_restore_gvcv(pTHX_ void *ud_) {
 461  su_save_gvcv_ud *ud = ud_;
 462  GV              *gv = ud->gv;
 463
 464  GvCV_set(gv, ud->old_cv);
 465  GvCVGEN(gv) = 0;
 466  mro_method_changed_in(GvSTASH(gv));
 467
 468  Safefree(ud);
 469 }
 470
 471 STATIC void su_save_gvcv(pTHX_ GV *gv) {
 472 #define su_save_gvcv(G) su_save_gvcv(aTHX_ (G))
 473  su_save_gvcv_ud *ud;
 474
 475  Newx(ud, 1, su_save_gvcv_ud);
 476  ud->gv     = gv;
 477  ud->old_cv = GvCV(gv);
 478
 479  GvCV_set(gv, NULL);
 480  GvCVGEN(gv) = 0;
 481  mro_method_changed_in(GvSTASH(gv));
 482
 483  SAVEDESTRUCTOR_X(su_restore_gvcv, ud);
 484 }
 485
 486 /* --- Actions ------------------------------------------------------------- */
 487
 488 typedef struct {
 489  I32 depth;
 490  I32 pad;
 491  I32 *origin;
 492  void (*handler)(pTHX_ void *);
 493 } su_ud_common;
 494
 495 #define SU_UD_DEPTH(U)   (((su_ud_common *) (U))->depth)
 496 #define SU_UD_PAD(U)     (((su_ud_common *) (U))->pad)
 497 #define SU_UD_ORIGIN(U)  (((su_ud_common *) (U))->origin)
 498 #define SU_UD_HANDLER(U) (((su_ud_common *) (U))->handler)
 499
 500 #define SU_UD_FREE(U) STMT_START { \
 501  if (SU_UD_ORIGIN(U)) Safefree(SU_UD_ORIGIN(U)); \
 502  Safefree(U); \
 503 } STMT_END
 504
 505 /* ... Reap ................................................................ */
 506
 507 typedef struct {
 508  su_ud_common ci;
 509  SV *cb;
 510 } su_ud_reap;
 511
 512 STATIC void su_call(pTHX_ void *ud_) {
 513  su_ud_reap *ud = (su_ud_reap *) ud_;
 514 #if SU_HAS_PERL(5, 9, 5)
 515  PERL_CONTEXT saved_cx;
 516  I32 cxix;
 517 #endif
 518
 519  dSP;
 520
 521  SU_D({
 522   PerlIO_printf(Perl_debug_log,
 523                 "%p: @@@ call\n%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
 524                  ud, ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
 525  });
 526
 527  ENTER;
 528  SAVETMPS;
 529
 530  PUSHMARK(SP);
 531  PUTBACK;
 532
 533  /* If the recently popped context isn't saved there, it will be overwritten by
 534   * the sub scope from call_sv, although it's still needed in our caller. */
 535
 536 #if SU_HAS_PERL(5, 9, 5)
 537  if (cxstack_ix < cxstack_max)
 538   cxix = cxstack_ix + 1;
 539  else
 540   cxix = Perl_cxinc(aTHX);
 541  saved_cx = cxstack[cxix];
 542 #endif
 543
 544  call_sv(ud->cb, G_VOID);
 545
 546 #if SU_HAS_PERL(5, 9, 5)
 547  cxstack[cxix] = saved_cx;
 548 #endif
 549
 550  PUTBACK;
 551
 552  FREETMPS;
 553  LEAVE;
 554
 555  SvREFCNT_dec(ud->cb);
 556  SU_UD_FREE(ud);
 557 }
 558
 559 STATIC void su_reap(pTHX_ void *ud) {
 560 #define su_reap(U) su_reap(aTHX_ (U))
 561  SU_D({
 562   PerlIO_printf(Perl_debug_log,
 563                 "%p: === reap\n%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
 564                  ud, ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
 565  });
 566
 567  SAVEDESTRUCTOR_X(su_call, ud);
 568 }
 569
 570 /* ... Localize & localize array/hash element .............................. */
 571
 572 typedef struct {
 573  su_ud_common ci;
 574  SV    *sv;
 575  SV    *val;
 576  SV    *elem;
 577  svtype type;
 578 } su_ud_localize;
 579
 580 #define SU_UD_LOCALIZE_FREE(U) STMT_START { \
 581  SvREFCNT_dec((U)->elem); \
 582  SvREFCNT_dec((U)->val);  \
 583  SvREFCNT_dec((U)->sv);   \
 584  SU_UD_FREE(U);           \
 585 } STMT_END
 586
 587 STATIC I32 su_ud_localize_init(pTHX_ su_ud_localize *ud, SV *sv, SV *val, SV *elem) {
 588 #define su_ud_localize_init(UD, S, V, E) su_ud_localize_init(aTHX_ (UD), (S), (V), (E))
 589  UV deref = 0;
 590  svtype t = SVt_NULL;
 591  I32 size;
 592
 593  SvREFCNT_inc_simple_void(sv);
 594
 595  if (SvTYPE(sv) >= SVt_PVGV) {
 596   if (!val || !SvROK(val)) { /* local *x; or local *x = $val; */
 597    t = SVt_PVGV;
 598   } else {                   /* local *x = \$val; */
 599    t = SvTYPE(SvRV(val));
 600    deref = 1;
 601   }
 602  } else if (SvROK(sv)) {
 603   croak("Invalid %s reference as the localization target",
 604                  sv_reftype(SvRV(sv), 0));
 605  } else {
 606   STRLEN len, l;
 607   const char *p = SvPV_const(sv, len), *s;
 608   for (s = p, l = len; l > 0 && isSPACE(*s); ++s, --l) { }
 609   if (!l) {
 610    l = len;
 611    s = p;
 612   }
 613   switch (*s) {
 614    case '$': t = SVt_PV;   break;
 615    case '@': t = SVt_PVAV; break;
 616    case '%': t = SVt_PVHV; break;
 617    case '&': t = SVt_PVCV; break;
 618    case '*': t = SVt_PVGV; break;
 619   }
 620   if (t != SVt_NULL) {
 621    ++s;
 622    --l;
 623   } else if (val) { /* t == SVt_NULL, type can't be inferred from the sigil */
 624    if (SvROK(val) && !sv_isobject(val)) {
 625     t = SvTYPE(SvRV(val));
 626     deref = 1;
 627    } else {
 628     t = SvTYPE(val);
 629    }
 630   }
 631   SvREFCNT_dec(sv);
 632   sv = newSVpvn(s, l);
 633  }
 634
 635  switch (t) {
 636   case SVt_PVAV:
 637    size  = elem ? SU_SAVE_AELEM_OR_ADELETE_SIZE
 638                 : SU_SAVE_ARY_SIZE;
 639    deref = 0;
 640    break;
 641   case SVt_PVHV:
 642    size  = elem ? SU_SAVE_HELEM_OR_HDELETE_SIZE
 643                 : SU_SAVE_HASH_SIZE;
 644    deref = 0;
 645    break;
 646   case SVt_PVGV:
 647    size  = SU_SAVE_GP_SIZE;
 648    deref = 0;
 649    break;
 650   case SVt_PVCV:
 651    size  = SU_SAVE_GVCV_SIZE;
 652    deref = 0;
 653    break;
 654   default:
 655    size = SU_SAVE_SCALAR_SIZE;
 656    break;
 657  }
 658  /* When deref is set, val isn't NULL */
 659
 660  ud->sv   = sv;
 661  ud->val  = val ? newSVsv(deref ? SvRV(val) : val) : NULL;
 662  ud->elem = SvREFCNT_inc(elem);
 663  ud->type = t;
 664
 665  return size;
 666 }
 667
 668 STATIC void su_localize(pTHX_ void *ud_) {
 669 #define su_localize(U) su_localize(aTHX_ (U))
 670  su_ud_localize *ud = (su_ud_localize *) ud_;
 671  SV *sv   = ud->sv;
 672  SV *val  = ud->val;
 673  SV *elem = ud->elem;
 674  svtype t = ud->type;
 675  GV *gv;
 676
 677  if (SvTYPE(sv) >= SVt_PVGV) {
 678   gv = (GV *) sv;
 679  } else {
 680 #ifdef gv_fetchsv
 681   gv = gv_fetchsv(sv, GV_ADDMULTI, t);
 682 #else
 683   STRLEN len;
 684   const char *name = SvPV_const(sv, len);
 685   gv = gv_fetchpvn_flags(name, len, GV_ADDMULTI, t);
 686 #endif
 687  }
 688
 689  SU_D({
 690   SV *z = newSV(0);
 691   SvUPGRADE(z, t);
 692   PerlIO_printf(Perl_debug_log, "%p: === localize a %s\n",ud, sv_reftype(z, 0));
 693   PerlIO_printf(Perl_debug_log,
 694                 "%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
 695                  ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
 696   SvREFCNT_dec(z);
 697  });
 698
 699  /* Inspired from Alias.pm */
 700  switch (t) {
 701   case SVt_PVAV:
 702    if (elem) {
 703     su_save_aelem(GvAV(gv), elem, val);
 704     goto done;
 705    } else
 706     save_ary(gv);
 707    break;
 708   case SVt_PVHV:
 709    if (elem) {
 710     su_save_helem(GvHV(gv), elem, val);
 711     goto done;
 712    } else
 713     save_hash(gv);
 714    break;
 715   case SVt_PVGV:
 716    save_gp(gv, 1); /* hide previous entry in symtab */
 717    break;
 718   case SVt_PVCV:
 719    su_save_gvcv(gv);
 720    break;
 721   default:
 722    gv = (GV *) save_scalar(gv);
 723    break;
 724  }
 725
 726  if (val)
 727   SvSetMagicSV((SV *) gv, val);
 728
 729 done:
 730  SU_UD_LOCALIZE_FREE(ud);
 731 }
 732
 733 /* --- Pop a context back -------------------------------------------------- */
 734
 735 #if SU_DEBUG
 736 # ifdef DEBUGGING
 737 #  define SU_CXNAME PL_block_type[CxTYPE(&cxstack[cxstack_ix])]
 738 # else
 739 #  define SU_CXNAME "XXX"
 740 # endif
 741 #endif
 742
 743 STATIC void su_pop(pTHX_ void *ud) {
 744 #define su_pop(U) su_pop(aTHX_ (U))
 745  I32 depth, base, mark, *origin;
 746  depth = SU_UD_DEPTH(ud);
 747
 748  SU_D(
 749   PerlIO_printf(Perl_debug_log,
 750    "%p: --- pop a %s\n"
 751    "%p: leave scope     at depth=%2d scope_ix=%2d cur_top=%2d cur_base=%2d\n",
 752     ud, SU_CXNAME,
 753     ud, depth, PL_scopestack_ix,PL_savestack_ix,PL_scopestack[PL_scopestack_ix])
 754  );
 755
 756  origin = SU_UD_ORIGIN(ud);
 757  mark   = origin[depth];
 758  base   = origin[depth - 1];
 759
 760  SU_D(PerlIO_printf(Perl_debug_log,
 761                     "%p: original scope was %*c top=%2d     base=%2d\n",
 762                      ud,                24, ' ',    mark,        base));
 763
 764  if (base < mark) {
 765   SU_D(PerlIO_printf(Perl_debug_log, "%p: clear leftovers\n", ud));
 766   PL_savestack_ix = mark;
 767   leave_scope(base);
 768  }
 769  PL_savestack_ix = base;
 770
 771  SU_UD_DEPTH(ud) = --depth;
 772
 773  if (depth > 0) {
 774   I32 pad;
 775
 776   if ((pad = SU_UD_PAD(ud))) {
 777    dMY_CXT;
 778    do {
 779     SU_D(PerlIO_printf(Perl_debug_log,
 780           "%p: push a pad slot at depth=%2d scope_ix=%2d save_ix=%2d\n",
 781            ud,                       depth, PL_scopestack_ix, PL_savestack_ix));
 782     SU_SAVE_PLACEHOLDER();
 783    } while (--pad);
 784   }
 785
 786   SU_D(PerlIO_printf(Perl_debug_log,
 787           "%p: push destructor at depth=%2d scope_ix=%2d save_ix=%2d\n",
 788            ud,                       depth, PL_scopestack_ix, PL_savestack_ix));
 789   SAVEDESTRUCTOR_X(su_pop, ud);
 790  } else {
 791   SU_UD_HANDLER(ud)(aTHX_ ud);
 792  }
 793
 794  SU_D(PerlIO_printf(Perl_debug_log,
 795                     "%p: --- end pop: cur_top=%2d == cur_base=%2d\n",
 796                      ud, PL_savestack_ix, PL_scopestack[PL_scopestack_ix]));
 797 }
 798
 799 /* --- Initialize the stack and the action userdata ------------------------ */
 800
 801 STATIC I32 su_init(pTHX_ void *ud, I32 cxix, I32 size) {
 802 #define su_init(U, C, S) su_init(aTHX_ (U), (C), (S))
 803  I32 i, depth = 1, pad, offset, *origin;
 804
 805  SU_D(PerlIO_printf(Perl_debug_log, "%p: ### init for cx %d\n", ud, cxix));
 806
 807  if (size <= SU_SAVE_DESTRUCTOR_SIZE)
 808   pad = 0;
 809  else {
 810   I32 extra = size - SU_SAVE_DESTRUCTOR_SIZE;
 811   pad = extra / SU_SAVE_PLACEHOLDER_SIZE;
 812   if (extra % SU_SAVE_PLACEHOLDER_SIZE)
 813    ++pad;
 814  }
 815  offset = SU_SAVE_DESTRUCTOR_SIZE + SU_SAVE_PLACEHOLDER_SIZE * pad;
 816
 817  SU_D(PerlIO_printf(Perl_debug_log, "%p: size=%d pad=%d offset=%d\n",
 818                                      ud,    size,   pad,   offset));
 819
 820  for (i = cxstack_ix; i > cxix; --i) {
 821   PERL_CONTEXT *cx = cxstack + i;
 822   switch (CxTYPE(cx)) {
 823 #if SU_HAS_PERL(5, 10, 0)
 824    case CXt_BLOCK:
 825     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is block\n", ud, i));
 826     /* Given and when blocks are actually followed by a simple block, so skip
 827      * it if needed. */
 828     if (cxix > 0) { /* Implies i > 0 */
 829      PERL_CONTEXT *next = cx - 1;
 830      if (CxTYPE(next) == CXt_GIVEN || CxTYPE(next) == CXt_WHEN)
 831       --cxix;
 832     }
 833     depth++;
 834     break;
 835 #endif
 836 #if SU_HAS_PERL(5, 11, 0)
 837    case CXt_LOOP_FOR:
 838    case CXt_LOOP_PLAIN:
 839    case CXt_LOOP_LAZYSV:
 840    case CXt_LOOP_LAZYIV:
 841 #else
 842    case CXt_LOOP:
 843 #endif
 844     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is loop\n", ud, i));
 845     depth += 2;
 846     break;
 847    default:
 848     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is other\n", ud, i));
 849     depth++;
 850     break;
 851   }
 852  }
 853  SU_D(PerlIO_printf(Perl_debug_log, "%p: going down to depth %d\n", ud, depth));
 854
 855  Newx(origin, depth + 1, I32);
 856  origin[0] = PL_scopestack[PL_scopestack_ix - depth];
 857  PL_scopestack[PL_scopestack_ix - depth] += size;
 858  for (i = depth - 1; i >= 1; --i) {
 859   I32 j = PL_scopestack_ix - i;
 860   origin[depth - i] = PL_scopestack[j];
 861   PL_scopestack[j] += offset;
 862  }
 863  origin[depth] = PL_savestack_ix;
 864
 865  SU_UD_ORIGIN(ud) = origin;
 866  SU_UD_DEPTH(ud)  = depth;
 867  SU_UD_PAD(ud)    = pad;
 868
 869  /* Make sure the first destructor fires by pushing enough fake slots on the
 870   * stack. */
 871  if (PL_savestack_ix + SU_SAVE_DESTRUCTOR_SIZE
 872                                        <= PL_scopestack[PL_scopestack_ix - 1]) {
 873   dMY_CXT;
 874   do {
 875    SU_D(PerlIO_printf(Perl_debug_log,
 876                   "%p: push a fake slot      at scope_ix=%2d  save_ix=%2d\n",
 877                    ud,                      PL_scopestack_ix, PL_savestack_ix));
 878    SU_SAVE_PLACEHOLDER();
 879   } while (PL_savestack_ix + SU_SAVE_DESTRUCTOR_SIZE
 880                                         <= PL_scopestack[PL_scopestack_ix - 1]);
 881  }
 882  SU_D(PerlIO_printf(Perl_debug_log,
 883                   "%p: push first destructor at scope_ix=%2d  save_ix=%2d\n",
 884                    ud,                      PL_scopestack_ix, PL_savestack_ix));
 885  SAVEDESTRUCTOR_X(su_pop, ud);
 886
 887  SU_D({
 888   for (i = 0; i <= depth; ++i) {
 889    I32 j = PL_scopestack_ix  - i;
 890    PerlIO_printf(Perl_debug_log,
 891                  "%p: depth=%2d scope_ix=%2d saved_floor=%2d new_floor=%2d\n",
 892                   ud,        i, j, origin[depth - i],
 893                                    i == 0 ? PL_savestack_ix : PL_scopestack[j]);
 894   }
 895  });
 896
 897  return depth;
 898 }
 899
 900 /* --- Unwind stack -------------------------------------------------------- */
 901
 902 STATIC void su_unwind(pTHX_ void *ud_) {
 903  dMY_CXT;
 904  I32 cxix    = MY_CXT.unwind_storage.cxix;
 905  I32 items   = MY_CXT.unwind_storage.items - 1;
 906  SV **savesp = MY_CXT.unwind_storage.savesp;
 907  I32 mark;
 908
 909  PERL_UNUSED_VAR(ud_);
 910
 911  if (savesp)
 912   PL_stack_sp = savesp;
 913
 914  if (cxstack_ix > cxix)
 915   dounwind(cxix);
 916
 917  /* Hide the level */
 918  if (items >= 0)
 919   PL_stack_sp--;
 920
 921  mark = PL_markstack[cxstack[cxix].blk_oldmarksp];
 922  *PL_markstack_ptr = PL_stack_sp - PL_stack_base - items;
 923
 924  SU_D({
 925   I32 gimme = GIMME_V;
 926   PerlIO_printf(Perl_debug_log,
 927                 "%p: cx=%d gimme=%s items=%d sp=%d oldmark=%d mark=%d\n",
 928                 &MY_CXT, cxix,
 929                 gimme == G_VOID ? "void" : gimme == G_ARRAY ? "list" : "scalar",
 930                 items, PL_stack_sp - PL_stack_base, *PL_markstack_ptr, mark);
 931  });
 932
 933  PL_op = (OP *) &(MY_CXT.unwind_storage.return_op);
 934  PL_op = PL_op->op_ppaddr(aTHX);
 935
 936  *PL_markstack_ptr = mark;
 937
 938  MY_CXT.unwind_storage.proxy_op.op_next = PL_op;
 939  PL_op = &(MY_CXT.unwind_storage.proxy_op);
 940 }
 941
 942 /* --- Uplevel ------------------------------------------------------------- */
 943
 944 #ifndef OP_GIMME_REVERSE
 945 STATIC U8 su_op_gimme_reverse(U8 gimme) {
 946  switch (gimme) {
 947   case G_VOID:
 948    return OPf_WANT_VOID;
 949   case G_ARRAY:
 950    return OPf_WANT_LIST;
 951   default:
 952    break;
 953  }
 954
 955  return OPf_WANT_SCALAR;
 956 }
 957 #define OP_GIMME_REVERSE(G) su_op_gimme_reverse(G)
 958 #endif
 959
 960 #define SU_UPLEVEL_SAVE(f, t) STMT_START { sud->old_##f = PL_##f; PL_##f = (t); } STMT_END
 961 #define SU_UPLEVEL_RESTORE(f) STMT_START { PL_##f = sud->old_##f; } STMT_END
 962
 963 STATIC su_uplevel_ud *su_uplevel_storage_new(pTHX) {
 964 #define su_uplevel_storage_new() su_uplevel_storage_new(aTHX)
 965  su_uplevel_ud *sud;
 966  dMY_CXT;
 967
 968  sud = MY_CXT.uplevel_storage.root;
 969  if (sud) {
 970   MY_CXT.uplevel_storage.root = sud->next;
 971   MY_CXT.uplevel_storage.count--;
 972  } else {
 973   sud = su_uplevel_ud_new();
 974  }
 975
 976  return sud;
 977 }
 978
 979 STATIC void su_uplevel_storage_delete(pTHX_ su_uplevel_ud *sud) {
 980 #define su_uplevel_storage_delete(S) su_uplevel_storage_delete(aTHX_ (S))
 981  dMY_CXT;
 982
 983  if (MY_CXT.uplevel_storage.count >= SU_UPLEVEL_STORAGE_SIZE) {
 984   su_uplevel_ud_delete(sud);
 985  } else {
 986   sud->next = MY_CXT.uplevel_storage.root;
 987   MY_CXT.uplevel_storage.root = sud;
 988   MY_CXT.uplevel_storage.count++;
 989  }
 990 }
 991
 992 #define SU_HAS_EXT_MAGIC SU_HAS_PERL(5, 8, 0)
 993
 994 #if SU_HAS_EXT_MAGIC && !SU_HAS_PERL(5, 13, 7)
 995
 996 STATIC int su_uplevel_restore_free(pTHX_ SV *sv, MAGIC *mg) {
 997  su_uplevel_storage_delete((su_uplevel_ud *) mg->mg_ptr);
 998
 999  return 0;
1000 }
1001
1002 STATIC MGVTBL su_uplevel_restore_vtbl = {
1003  0,
1004  0,
1005  0,
1006  0,
1007  su_uplevel_restore_free
1008 };
1009
1010 #endif /* SU_HAS_EXT_MAGIC && !SU_HAS_PERL(5, 13, 7) */
1011
1012 STATIC void su_uplevel_restore(pTHX_ void *sus_) {
1013  su_uplevel_ud *sud = sus_;
1014  const PERL_CONTEXT *sub_cx;
1015  PERL_SI *cur = sud->old_curstackinfo;
1016  PERL_SI *si  = sud->si;
1017
1018  sub_cx = cxstack + sud->cxix;
1019
1020  /* When we reach this place, POPSUB has already been called (with our fake
1021   * argarray). GvAV(PL_defgv) points to the savearray (that is, what @_ was
1022   * before uplevel). argarray is either the fake AV we created in su_uplevel()
1023   * or some empty replacement POPSUB creates when @_ is reified. In both cases
1024   * we have to destroy it before the context stack is swapped back to its
1025   * original state. */
1026  SvREFCNT_dec(sub_cx->blk_sub.argarray);
1027
1028  /* PUSHSUB was exerted with the original callback, but after calling
1029   * pp_entersub() we hijacked the blk_sub.cv member of the fresh sub context
1030   * with the renamed CV. Thus POPSUB and LEAVESUB applied to this CV, not the
1031   * original. Repair this imbalance right now. */
1032  if (!(CvDEPTH(sud->callback) = sub_cx->blk_sub.olddepth))
1033   LEAVESUB(sud->callback);
1034
1035  /* Free the renamed cv. */
1036  {
1037   CV *renamed_cv = sub_cx->blk_sub.cv;
1038   CvDEPTH(renamed_cv) = 0;
1039   SvREFCNT_dec(renamed_cv);
1040  }
1041
1042  CATCH_SET(sud->old_catch);
1043
1044  SU_UPLEVEL_RESTORE(op);
1045
1046  /* stack_grow() wants PL_curstack so restore the old stack first */
1047  if (PL_curstackinfo == si) {
1048   PL_curstack = cur->si_stack;
1049   if (sud->old_mainstack)
1050    SU_UPLEVEL_RESTORE(mainstack);
1051   SU_UPLEVEL_RESTORE(curstackinfo);
1052
1053   if (sud->died) {
1054    CV *target = sud->target;
1055    I32 levels = 0, i;
1056
1057    /* When we die, the depth of the target CV is not updated because of the
1058     * stack switcheroo. So we have to look at all the frames between the
1059     * uplevel call and the catch block to count how many call frames to the
1060     * target CV were skipped. */
1061    for (i = cur->si_cxix; i > sud->cxix; i--) {
1062     register const PERL_CONTEXT *cx = cxstack + i;
1063
1064     if (CxTYPE(cx) == CXt_SUB) {
1065      if (cx->blk_sub.cv == target)
1066       ++levels;
1067     }
1068    }
1069
1070    /* If we died, the replacement stack was already unwinded to the first
1071     * eval frame, and all the contexts down there were popped. We don't have
1072     * to pop manually any context of the original stack, because they must
1073     * have been in the replacement stack as well (since the second was copied
1074     * from the first). Thus we only have to make sure the original stack index
1075     * points to the context just below the first eval scope under the target
1076     * frame. */
1077    for (; i >= 0; i--) {
1078     register const PERL_CONTEXT *cx = cxstack + i;
1079
1080     switch (CxTYPE(cx)) {
1081      case CXt_SUB:
1082       if (cx->blk_sub.cv == target)
1083        ++levels;
1084       break;
1085      case CXt_EVAL:
1086       goto found_it;
1087       break;
1088      default:
1089       break;
1090     }
1091    }
1092
1093 found_it:
1094    CvDEPTH(target) = sud->target_depth - levels;
1095    PL_curstackinfo->si_cxix = i - 1;
1096
1097 #if !SU_HAS_PERL(5, 13, 1)
1098    /* Since $@ was maybe localized between the target frame and the uplevel
1099     * call, we forcefully flush the save stack to get rid of it and then
1100     * reset $@ to its proper value. Note that the the call to
1101     * su_uplevel_restore() must happen before the "reset $@" item of the save
1102     * stack is processed, as uplevel was called after the localization.
1103     * Andrew's changes to how $@ was handled, which were mainly integrated
1104     * between perl 5.13.0 and 5.13.1, fixed this. */
1105    if (ERRSV && SvTRUE(ERRSV)) {
1106     register const PERL_CONTEXT *cx = cxstack + i; /* This is the eval scope */
1107     SV *errsv = SvREFCNT_inc(ERRSV);
1108     PL_scopestack_ix = cx->blk_oldscopesp;
1109     leave_scope(PL_scopestack[PL_scopestack_ix]);
1110     sv_setsv(ERRSV, errsv);
1111     SvREFCNT_dec(errsv);
1112    }
1113 #endif
1114   }
1115  }
1116
1117  SU_UPLEVEL_RESTORE(curcop);
1118
1119  SvREFCNT_dec(sud->target);
1120
1121  PL_stack_base = AvARRAY(cur->si_stack);
1122  PL_stack_sp   = PL_stack_base + AvFILLp(cur->si_stack);
1123  PL_stack_max  = PL_stack_base + AvMAX(cur->si_stack);
1124
1125  /* When an exception is thrown from the uplevel'd subroutine,
1126   * su_uplevel_restore() may be called by the LEAVE in die_unwind() (renamed
1127   * die_where() in more recent perls), which has the sad habit of keeping a
1128   * pointer to the current context frame across this call. This means that we
1129   * can't free the temporary context stack we used for the uplevel call right
1130   * now, or that pointer upwards would point to garbage. */
1131 #if SU_HAS_PERL(5, 13, 7)
1132  /* This issue has been fixed in perl with commit 8f89e5a9, which was made
1133   * public in perl 5.13.7. */
1134  su_uplevel_storage_delete(sud);
1135 #elif SU_HAS_EXT_MAGIC
1136  /* If 'ext' magic is available, we work around this by attaching the state
1137   * data to a scalar that will be freed "soon". */
1138  {
1139   SV *sv = sv_newmortal();
1140
1141   sv_magicext(sv, NULL, PERL_MAGIC_ext, &su_uplevel_restore_vtbl,
1142                         (const char *) sud, 0);
1143  }
1144 #else
1145  /* Otherwise, we just enqueue it back in the global storage list. */
1146  {
1147   dMY_CXT;
1148
1149   sud->next = MY_CXT.uplevel_storage.root;
1150   MY_CXT.uplevel_storage.root = sud;
1151   MY_CXT.uplevel_storage.count++;
1152  }
1153 #endif
1154
1155  return;
1156 }
1157
1158 STATIC CV *su_cv_clone(pTHX_ CV *proto, GV *gv) {
1159 #define su_cv_clone(P, G) su_cv_clone(aTHX_ (P), (G))
1160  dVAR;
1161  AV        *protopadlist = CvPADLIST(proto);
1162  const AV  *protopadname = (const AV *) *av_fetch(protopadlist, 0, FALSE);
1163  SV       **pname        = AvARRAY(protopadname);
1164  const I32  fpadlist     = AvFILLp(protopadlist);
1165  const I32  fpadname     = AvFILLp(protopadname);
1166  AV *padlist, *padname;
1167  CV *cv;
1168
1169  cv = MUTABLE_CV(newSV_type(SvTYPE(proto)));
1170
1171  CvFLAGS(cv)  = CvFLAGS(proto);
1172 #ifdef CVf_CVGV_RC
1173  CvFLAGS(cv) &= ~CVf_CVGV_RC;
1174 #endif
1175  CvDEPTH(cv)  = CvDEPTH(proto);
1176 #ifdef USE_ITHREADS
1177  CvFILE(cv)   = CvISXSUB(proto) ? CvFILE(proto) : savepv(CvFILE(proto));
1178 #else
1179  CvFILE(cv)   = CvFILE(proto);
1180 #endif
1181
1182  CvGV_set(cv, gv);
1183  CvSTASH_set(cv, CvSTASH(proto));
1184  /* Commit 4c74a7df, publicized with perl 5.13.3, began to add backrefs to
1185   * stashes. CvSTASH_set() started to do it as well with commit c68d95645
1186   * (which was part of perl 5.13.7). */
1187 #if SU_HAS_PERL(5, 13, 3) && !SU_HAS_PERL(5, 13, 7)
1188  if (CvSTASH(proto))
1189   Perl_sv_add_backref(aTHX_ CvSTASH(proto), MUTABLE_SV(cv));
1190 #endif
1191
1192  OP_REFCNT_LOCK;
1193  CvROOT(cv)        = OpREFCNT_inc(CvROOT(proto));
1194  OP_REFCNT_UNLOCK;
1195  CvSTART(cv)       = CvSTART(proto);
1196  CvOUTSIDE(cv)     = CvOUTSIDE(proto);
1197 #ifdef CVf_WEAKOUTSIDE
1198  if (!(CvFLAGS(proto) & CVf_WEAKOUTSIDE))
1199 #endif
1200   SvREFCNT_inc_simple_void(CvOUTSIDE(cv));
1201 #ifdef CvOUTSIDE_SEQ
1202  CvOUTSIDE_SEQ(cv) = CvOUTSIDE_SEQ(proto);
1203 #endif
1204
1205  if (SvPOK(proto))
1206   sv_setpvn(MUTABLE_SV(cv), SvPVX_const(proto), SvCUR(proto));
1207
1208  padlist = newAV();
1209  AvREAL_off(padlist);
1210  av_fill(padlist, fpadlist);
1211  CvPADLIST(cv) = padlist;
1212
1213  padname = newAV();
1214  av_fill(padname, fpadname);
1215  if (fpadname >= 0) {
1216   I32 j;
1217   SV **psvp = AvARRAY(protopadname);
1218   SV **svp  = AvARRAY(padname);
1219
1220   svp[0] = &PL_sv_undef;
1221   for (j = 1; j <= fpadname; ++j)
1222    svp[j] = SvREFCNT_inc(psvp[j]);
1223  }
1224  AvARRAY(padlist)[0] = MUTABLE_SV(padname);
1225
1226  if (fpadlist >= 1) {
1227   I32 i;
1228
1229   for (i = 1; i <= fpadlist; ++i) {
1230    AV  *protoframe = MUTABLE_AV(AvARRAY(protopadlist)[i]);
1231    AV  *frame      = newAV();
1232    SV **psvp       = AvARRAY(protoframe);
1233    SV **svp;
1234    I32  j,  fframe = AvFILLp(protoframe);
1235
1236    av_fill(frame, fframe);
1237    svp = AvARRAY(frame);
1238    if (i == 1) {
1239     AV *a0 = newAV(); /* will be @_ */
1240     AvREAL_off(a0);
1241     AvREIFY_on(a0);
1242     svp[0] = MUTABLE_SV(a0);
1243    } else {
1244     svp[0] = SvREFCNT_inc(psvp[0]);
1245    }
1246    for (j = 1; j <= fframe; ++j)
1247     svp[j] = SvREFCNT_inc(psvp[j]);
1248
1249    AvARRAY(padlist)[i] = MUTABLE_SV(frame);
1250   }
1251  }
1252
1253 #ifdef CvCONST
1254  if (CvCONST(cv))
1255   CvCONST_off(cv);
1256 #endif
1257
1258  return cv;
1259 }
1260
1261 STATIC I32 su_uplevel(pTHX_ CV *callback, I32 cxix, I32 args) {
1262 #define su_uplevel(C, I, A) su_uplevel(aTHX_ (C), (I), (A))
1263  su_uplevel_ud *sud;
1264  const PERL_CONTEXT *cx = cxstack + cxix;
1265  PERL_SI *si;
1266  PERL_SI *cur = PL_curstackinfo;
1267  SV **old_stack_sp;
1268  CV  *target;
1269  UNOP sub_op;
1270  I32  gimme;
1271  I32  old_mark, new_mark;
1272  I32  ret;
1273  dSP;
1274
1275  ENTER;
1276
1277  gimme = GIMME_V;
1278  /* Make PL_stack_sp point just before the CV. */
1279  PL_stack_sp -= args + 1;
1280  old_mark = AvFILLp(PL_curstack) = PL_stack_sp - PL_stack_base;
1281  SPAGAIN;
1282
1283  sud = su_uplevel_storage_new();
1284
1285  sud->cxix     = cxix;
1286  sud->died     = 1;
1287  sud->callback = callback;
1288  SAVEDESTRUCTOR_X(su_uplevel_restore, sud);
1289
1290  si = sud->si;
1291
1292  si->si_type    = cur->si_type;
1293  si->si_next    = NULL;
1294  si->si_prev    = cur->si_prev;
1295 #ifdef DEBUGGING
1296  si->si_markoff = cx->blk_oldmarksp;
1297 #endif
1298
1299  /* Allocate enough space for all the elements of the original stack up to the
1300   * target context, plus the forthcoming arguments. */
1301  new_mark = cx->blk_oldsp;
1302  av_extend(si->si_stack, new_mark + 1 + args + 1);
1303  Copy(PL_curstack, AvARRAY(si->si_stack), new_mark + 1, SV *);
1304  AvFILLp(si->si_stack) = new_mark;
1305  SU_POISON(AvARRAY(si->si_stack) + new_mark + 1, args + 1, SV *);
1306
1307  /* Specialized SWITCHSTACK() */
1308  PL_stack_base = AvARRAY(si->si_stack);
1309  old_stack_sp  = PL_stack_sp;
1310  PL_stack_sp   = PL_stack_base + AvFILLp(si->si_stack);
1311  PL_stack_max  = PL_stack_base + AvMAX(si->si_stack);
1312  SPAGAIN;
1313
1314  /* Copy the context stack up to the context just below the target. */
1315  si->si_cxix = (cxix < 0) ? -1 : (cxix - 1);
1316  if (si->si_cxmax < cxix) {
1317   /* The max size must be at least two so that GROW(max) = (max*3)/2 > max */
1318   si->si_cxmax = (cxix < 4) ? 4 : cxix;
1319   Renew(si->si_cxstack, si->si_cxmax + 1, PERL_CONTEXT);
1320  }
1321  Copy(cur->si_cxstack, si->si_cxstack, cxix, PERL_CONTEXT);
1322  SU_POISON(si->si_cxstack + cxix, si->si_cxmax + 1 - cxix, PERL_CONTEXT);
1323
1324  target            = cx->blk_sub.cv;
1325  sud->target       = (CV *) SvREFCNT_inc(target);
1326  sud->target_depth = CvDEPTH(target);
1327
1328  /* blk_oldcop is essentially needed for caller() and stack traces. It has no
1329   * run-time implication, since PL_curcop will be overwritten as soon as we
1330   * enter a sub (a sub starts by a nextstate/dbstate). Hence it's safe to just
1331   * make it point to the blk_oldcop for the target frame, so that caller()
1332   * reports the right file name, line number and lexical hints. */
1333  SU_UPLEVEL_SAVE(curcop, cx->blk_oldcop);
1334  /* Don't reset PL_markstack_ptr, or we would overwrite the mark stack below
1335   * this point. Don't reset PL_curpm either, we want the most recent matches. */
1336
1337  SU_UPLEVEL_SAVE(curstackinfo, si);
1338  /* If those two are equal, we need to fool POPSTACK_TO() */
1339  if (PL_mainstack == PL_curstack)
1340   SU_UPLEVEL_SAVE(mainstack, si->si_stack);
1341  else
1342   sud->old_mainstack = NULL;
1343  PL_curstack = si->si_stack;
1344
1345  PUSHMARK(SP);
1346  /* Both SP and old_stack_sp point just before the CV. */
1347  Copy(old_stack_sp + 2, SP + 1, args, SV *);
1348  SP += args;
1349  PUSHs((SV *) callback);
1350  PUTBACK;
1351
1352  Zero(&sub_op, 1, UNOP);
1353  sub_op.op_type  = OP_ENTERSUB;
1354  sub_op.op_next  = NULL;
1355  sub_op.op_flags = OP_GIMME_REVERSE(gimme) | OPf_STACKED;
1356  if (PL_DBsub)
1357   sub_op.op_flags |= OPpENTERSUB_DB;
1358
1359  SU_UPLEVEL_SAVE(op, (OP *) &sub_op);
1360
1361  sud->old_catch = CATCH_GET;
1362  CATCH_SET(TRUE);
1363
1364  if ((PL_op = PL_ppaddr[OP_ENTERSUB](aTHX))) {
1365   PERL_CONTEXT *sub_cx;
1366   CV *renamed_cv;
1367
1368   renamed_cv = su_cv_clone(callback, CvGV(target));
1369
1370   sub_cx = cxstack + cxstack_ix;
1371   sub_cx->blk_sub.cv = renamed_cv;
1372   if (!sub_cx->blk_sub.olddepth) {
1373    SvREFCNT_inc_simple_void(renamed_cv);
1374    SvREFCNT_inc_simple_void(renamed_cv);
1375    SAVEFREESV(renamed_cv);
1376   }
1377
1378   if (CxHASARGS(cx) && cx->blk_sub.argarray) {
1379    /* The call to pp_entersub() has saved the current @_ (in XS terms,
1380     * GvAV(PL_defgv)) in the savearray member, and has created a new argarray
1381     * with what we put on the stack. But we want to fake up the same arguments
1382     * as the ones in use at the context we uplevel to, so we replace the
1383     * argarray with an unreal copy of the original @_. */
1384    AV *av = newAV();
1385    AvREAL_off(av);
1386    av_extend(av, AvMAX(cx->blk_sub.argarray));
1387    AvFILLp(av) = AvFILLp(cx->blk_sub.argarray);
1388    Copy(AvARRAY(cx->blk_sub.argarray), AvARRAY(av), AvFILLp(av) + 1, SV *);
1389    cxstack[cxix].blk_sub.argarray = av;
1390   } else {
1391    SvREFCNT_inc_simple_void(cxstack[cxix].blk_sub.argarray);
1392   }
1393
1394   CALLRUNOPS(aTHX);
1395
1396   ret = PL_stack_sp - (PL_stack_base + new_mark);
1397  }
1398
1399  sud->died = 0;
1400
1401  SPAGAIN;
1402
1403  if (ret > 0) {
1404   AV *old_stack = sud->old_curstackinfo->si_stack;
1405
1406   if (old_mark + ret > AvMAX(old_stack)) {
1407    /* Specialized EXTEND(old_sp, ret) */
1408    av_extend(old_stack, old_mark + ret + 1);
1409    old_stack_sp = AvARRAY(old_stack) + old_mark;
1410   }
1411
1412   Copy(PL_stack_sp - ret + 1, old_stack_sp + 1, ret, SV *);
1413   PL_stack_sp        += ret;
1414   AvFILLp(old_stack) += ret;
1415  }
1416
1417  PUTBACK;
1418
1419  LEAVE;
1420
1421  return ret;
1422 }
1423
1424 /* --- Interpreter setup/teardown ------------------------------------------ */
1425
1426 STATIC void su_teardown(pTHX_ void *param) {
1427  su_uplevel_ud *cur;
1428  dMY_CXT;
1429
1430  cur = MY_CXT.uplevel_storage.root;
1431  if (cur) {
1432   su_uplevel_ud *prev;
1433   do {
1434    prev = cur;
1435    cur  = prev->next;
1436    su_uplevel_ud_delete(prev);
1437   } while (cur);
1438  }
1439
1440  return;
1441 }
1442
1443 STATIC void su_setup(pTHX) {
1444 #define su_setup() su_setup(aTHX)
1445  MY_CXT_INIT;
1446
1447  MY_CXT.stack_placeholder = NULL;
1448
1449  /* NewOp() calls calloc() which just zeroes the memory with memset(). */
1450  Zero(&(MY_CXT.unwind_storage.return_op), 1, LISTOP);
1451  MY_CXT.unwind_storage.return_op.op_type   = OP_RETURN;
1452  MY_CXT.unwind_storage.return_op.op_ppaddr = PL_ppaddr[OP_RETURN];
1453
1454  Zero(&(MY_CXT.unwind_storage.proxy_op), 1, OP);
1455  MY_CXT.unwind_storage.proxy_op.op_type   = OP_STUB;
1456  MY_CXT.unwind_storage.proxy_op.op_ppaddr = NULL;
1457
1458  MY_CXT.uplevel_storage.root  = NULL;
1459  MY_CXT.uplevel_storage.count = 0;
1460
1461  call_atexit(su_teardown, NULL);
1462
1463  return;
1464 }
1465
1466 /* --- XS ------------------------------------------------------------------ */
1467
1468 #if SU_HAS_PERL(5, 8, 9)
1469 # define SU_SKIP_DB_MAX 2
1470 #else
1471 # define SU_SKIP_DB_MAX 3
1472 #endif
1473
1474 /* Skip context sequences of 1 to SU_SKIP_DB_MAX (included) block contexts
1475  * followed by a DB sub */
1476
1477 #define SU_SKIP_DB(C) \
1478  STMT_START {         \
1479   I32 skipped = 0;    \
1480   PERL_CONTEXT *base = cxstack;      \
1481   PERL_CONTEXT *cx   = base + (C);   \
1482   while (cx >= base && (C) > skipped && CxTYPE(cx) == CXt_BLOCK) \
1483    --cx, ++skipped;                  \
1484   if (cx >= base && (C) > skipped) { \
1485    switch (CxTYPE(cx)) {  \
1486     case CXt_SUB:         \
1487      if (skipped <= SU_SKIP_DB_MAX && cx->blk_sub.cv == GvCV(PL_DBsub)) \
1488       (C) -= skipped + 1; \
1489       break;              \
1490     default:              \
1491      break;               \
1492    }                      \
1493   }                       \
1494  } STMT_END
1495
1496 #define SU_GET_CONTEXT(A, B)   \
1497  STMT_START {                  \
1498   if (items > A) {             \
1499    SV *csv = ST(B);            \
1500    if (!SvOK(csv))             \
1501     goto default_cx;           \
1502    cxix = SvIV(csv);           \
1503    if (cxix < 0)               \
1504     cxix = 0;                  \
1505    else if (cxix > cxstack_ix) \
1506     cxix = cxstack_ix;         \
1507   } else {                     \
1508 default_cx:                    \
1509    cxix = cxstack_ix;          \
1510    if (PL_DBsub)               \
1511     SU_SKIP_DB(cxix);          \
1512   }                            \
1513  } STMT_END
1514
1515 #define SU_GET_LEVEL(A, B) \
1516  STMT_START {              \
1517   level = 0;               \
1518   if (items > 0) {         \
1519    SV *lsv = ST(B);        \
1520    if (SvOK(lsv)) {        \
1521     level = SvIV(lsv);     \
1522     if (level < 0)         \
1523      level = 0;            \
1524    }                       \
1525   }                        \
1526  } STMT_END
1527
1528 XS(XS_Scope__Upper_unwind); /* prototype to pass -Wmissing-prototypes */
1529
1530 XS(XS_Scope__Upper_unwind) {
1531 #ifdef dVAR
1532  dVAR; dXSARGS;
1533 #else
1534  dXSARGS;
1535 #endif
1536  dMY_CXT;
1537  I32 cxix;
1538
1539  PERL_UNUSED_VAR(cv); /* -W */
1540  PERL_UNUSED_VAR(ax); /* -Wall */
1541
1542  SU_GET_CONTEXT(0, items - 1);
1543  do {
1544   PERL_CONTEXT *cx = cxstack + cxix;
1545   switch (CxTYPE(cx)) {
1546    case CXt_SUB:
1547     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
1548      continue;
1549    case CXt_EVAL:
1550    case CXt_FORMAT:
1551     MY_CXT.unwind_storage.cxix  = cxix;
1552     MY_CXT.unwind_storage.items = items;
1553     /* pp_entersub will want to sanitize the stack after returning from there
1554      * Screw that, we're insane */
1555     if (GIMME_V == G_SCALAR) {
1556      MY_CXT.unwind_storage.savesp = PL_stack_sp;
1557      /* dXSARGS calls POPMARK, so we need to match PL_markstack_ptr[1] */
1558      PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
1559     } else {
1560      MY_CXT.unwind_storage.savesp = NULL;
1561     }
1562     SAVEDESTRUCTOR_X(su_unwind, NULL);
1563     return;
1564    default:
1565     break;
1566   }
1567  } while (--cxix >= 0);
1568  croak("Can't return outside a subroutine");
1569 }
1570
1571 MODULE = Scope::Upper            PACKAGE = Scope::Upper
1572
1573 PROTOTYPES: ENABLE
1574
1575 BOOT:
1576 {
1577  HV *stash;
1578
1579  stash = gv_stashpv(__PACKAGE__, 1);
1580  newCONSTSUB(stash, "TOP",           newSViv(0));
1581  newCONSTSUB(stash, "SU_THREADSAFE", newSVuv(SU_THREADSAFE));
1582
1583  newXSproto("Scope::Upper::unwind", XS_Scope__Upper_unwind, file, NULL);
1584
1585  su_setup();
1586 }
1587
1588 #if SU_THREADSAFE
1589
1590 void
1591 CLONE(...)
1592 PROTOTYPE: DISABLE
1593 PPCODE:
1594  {
1595   MY_CXT_CLONE;
1596   MY_CXT.uplevel_storage.root  = NULL;
1597   MY_CXT.uplevel_storage.count = 0;
1598  }
1599  XSRETURN(0);
1600
1601 #endif /* SU_THREADSAFE */
1602
1603 void
1604 HERE()
1605 PROTOTYPE:
1606 PREINIT:
1607  I32 cxix = cxstack_ix;
1608 PPCODE:
1609  if (PL_DBsub)
1610   SU_SKIP_DB(cxix);
1611  EXTEND(SP, 1);
1612  mPUSHi(cxix);
1613  XSRETURN(1);
1614
1615 void
1616 UP(...)
1617 PROTOTYPE: ;$
1618 PREINIT:
1619  I32 cxix;
1620 PPCODE:
1621  SU_GET_CONTEXT(0, 0);
1622  if (--cxix < 0)
1623   cxix = 0;
1624  if (PL_DBsub)
1625   SU_SKIP_DB(cxix);
1626  EXTEND(SP, 1);
1627  mPUSHi(cxix);
1628  XSRETURN(1);
1629
1630 void
1631 SUB(...)
1632 PROTOTYPE: ;$
1633 PREINIT:
1634  I32 cxix;
1635 PPCODE:
1636  SU_GET_CONTEXT(0, 0);
1637  EXTEND(SP, 1);
1638  for (; cxix >= 0; --cxix) {
1639   PERL_CONTEXT *cx = cxstack + cxix;
1640   switch (CxTYPE(cx)) {
1641    default:
1642     continue;
1643    case CXt_SUB:
1644     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
1645      continue;
1646     mPUSHi(cxix);
1647     XSRETURN(1);
1648   }
1649  }
1650  XSRETURN_UNDEF;
1651
1652 void
1653 EVAL(...)
1654 PROTOTYPE: ;$
1655 PREINIT:
1656  I32 cxix;
1657 PPCODE:
1658  SU_GET_CONTEXT(0, 0);
1659  EXTEND(SP, 1);
1660  for (; cxix >= 0; --cxix) {
1661   PERL_CONTEXT *cx = cxstack + cxix;
1662   switch (CxTYPE(cx)) {
1663    default:
1664     continue;
1665    case CXt_EVAL:
1666     mPUSHi(cxix);
1667     XSRETURN(1);
1668   }
1669  }
1670  XSRETURN_UNDEF;
1671
1672 void
1673 SCOPE(...)
1674 PROTOTYPE: ;$
1675 PREINIT:
1676  I32 cxix, level;
1677 PPCODE:
1678  SU_GET_LEVEL(0, 0);
1679  cxix = cxstack_ix;
1680  if (PL_DBsub) {
1681   SU_SKIP_DB(cxix);
1682   while (cxix > 0) {
1683    if (--level < 0)
1684     break;
1685    --cxix;
1686    SU_SKIP_DB(cxix);
1687   }
1688  } else {
1689   cxix -= level;
1690   if (cxix < 0)
1691    cxix = 0;
1692  }
1693  EXTEND(SP, 1);
1694  mPUSHi(cxix);
1695  XSRETURN(1);
1696
1697 void
1698 CALLER(...)
1699 PROTOTYPE: ;$
1700 PREINIT:
1701  I32 cxix, level;
1702 PPCODE:
1703  SU_GET_LEVEL(0, 0);
1704  for (cxix = cxstack_ix; cxix > 0; --cxix) {
1705   PERL_CONTEXT *cx = cxstack + cxix;
1706   switch (CxTYPE(cx)) {
1707    case CXt_SUB:
1708     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
1709      continue;
1710    case CXt_EVAL:
1711    case CXt_FORMAT:
1712     if (--level < 0)
1713      goto done;
1714     break;
1715   }
1716  }
1717 done:
1718  EXTEND(SP, 1);
1719  mPUSHi(cxix);
1720  XSRETURN(1);
1721
1722 void
1723 want_at(...)
1724 PROTOTYPE: ;$
1725 PREINIT:
1726  I32 cxix;
1727 PPCODE:
1728  SU_GET_CONTEXT(0, 0);
1729  EXTEND(SP, 1);
1730  while (cxix > 0) {
1731   PERL_CONTEXT *cx = cxstack + cxix--;
1732   switch (CxTYPE(cx)) {
1733    case CXt_SUB:
1734    case CXt_EVAL:
1735    case CXt_FORMAT: {
1736     I32 gimme = cx->blk_gimme;
1737     switch (gimme) {
1738      case G_VOID:   XSRETURN_UNDEF; break;
1739      case G_SCALAR: XSRETURN_NO;    break;
1740      case G_ARRAY:  XSRETURN_YES;   break;
1741     }
1742     break;
1743    }
1744   }
1745  }
1746  XSRETURN_UNDEF;
1747
1748 void
1749 reap(SV *hook, ...)
1750 PROTOTYPE: &;$
1751 PREINIT:
1752  I32 cxix;
1753  su_ud_reap *ud;
1754 CODE:
1755  SU_GET_CONTEXT(1, 1);
1756  Newx(ud, 1, su_ud_reap);
1757  SU_UD_ORIGIN(ud)  = NULL;
1758  SU_UD_HANDLER(ud) = su_reap;
1759  ud->cb = newSVsv(hook);
1760  su_init(ud, cxix, SU_SAVE_DESTRUCTOR_SIZE);
1761
1762 void
1763 localize(SV *sv, SV *val, ...)
1764 PROTOTYPE: $$;$
1765 PREINIT:
1766  I32 cxix;
1767  I32 size;
1768  su_ud_localize *ud;
1769 CODE:
1770  SU_GET_CONTEXT(2, 2);
1771  Newx(ud, 1, su_ud_localize);
1772  SU_UD_ORIGIN(ud)  = NULL;
1773  SU_UD_HANDLER(ud) = su_localize;
1774  size = su_ud_localize_init(ud, sv, val, NULL);
1775  su_init(ud, cxix, size);
1776
1777 void
1778 localize_elem(SV *sv, SV *elem, SV *val, ...)
1779 PROTOTYPE: $$$;$
1780 PREINIT:
1781  I32 cxix;
1782  I32 size;
1783  su_ud_localize *ud;
1784 CODE:
1785  if (SvTYPE(sv) >= SVt_PVGV)
1786   croak("Can't infer the element localization type from a glob and the value");
1787  SU_GET_CONTEXT(3, 3);
1788  Newx(ud, 1, su_ud_localize);
1789  SU_UD_ORIGIN(ud)  = NULL;
1790  SU_UD_HANDLER(ud) = su_localize;
1791  size = su_ud_localize_init(ud, sv, val, elem);
1792  if (ud->type != SVt_PVAV && ud->type != SVt_PVHV) {
1793   SU_UD_LOCALIZE_FREE(ud);
1794   croak("Can't localize an element of something that isn't an array or a hash");
1795  }
1796  su_init(ud, cxix, size);
1797
1798 void
1799 localize_delete(SV *sv, SV *elem, ...)
1800 PROTOTYPE: $$;$
1801 PREINIT:
1802  I32 cxix;
1803  I32 size;
1804  su_ud_localize *ud;
1805 CODE:
1806  SU_GET_CONTEXT(2, 2);
1807  Newx(ud, 1, su_ud_localize);
1808  SU_UD_ORIGIN(ud)  = NULL;
1809  SU_UD_HANDLER(ud) = su_localize;
1810  size = su_ud_localize_init(ud, sv, NULL, elem);
1811  su_init(ud, cxix, size);
1812
1813 void
1814 uplevel(SV *code, ...)
1815 PROTOTYPE: &@
1816 PREINIT:
1817  I32 cxix, ret, args = 0;
1818 PPCODE:
1819  if (SvROK(code))
1820   code = SvRV(code);
1821  if (SvTYPE(code) < SVt_PVCV)
1822   croak("First argument to uplevel must be a code reference");
1823  SU_GET_CONTEXT(1, items - 1);
1824  do {
1825   PERL_CONTEXT *cx = cxstack + cxix;
1826   switch (CxTYPE(cx)) {
1827    case CXt_EVAL:
1828     croak("Can't uplevel to an eval frame");
1829    case CXt_FORMAT:
1830     croak("Can't uplevel to a format frame");
1831    case CXt_SUB:
1832     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
1833      continue;
1834     if (items > 1) {
1835      PL_stack_sp--;
1836      args = items - 2;
1837     }
1838     /* su_uplevel() takes care of extending the stack if needed. */
1839     ret = su_uplevel((CV *) code, cxix, args);
1840     XSRETURN(ret);
1841    default:
1842     break;
1843   }
1844  } while (--cxix >= 0);
1845  croak("Can't uplevel outside a subroutine");