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