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