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