Upper.xs

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