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 #ifdef newSVpvn_flags
  84 # define su_newmortal_pvn(S, L) newSVpvn_flags((S), (L), SVs_TEMP)
  85 #else
  86 # define su_newmortal_pvn(S, L) sv_2mortal(newSVpvn((S), (L)))
  87 #endif
  88 #define su_newmortal_pvs(S) su_newmortal_pvn((S), sizeof(S)-1)
  89
  90 #ifndef SvPV_const
  91 # define SvPV_const(S, L) SvPV(S, L)
  92 #endif
  93
  94 #ifndef SvPVX_const
  95 # define SvPVX_const(S) SvPVX(S)
  96 #endif
  97
  98 #ifndef SvPV_nolen_const
  99 # define SvPV_nolen_const(S) SvPV_nolen(S)
 100 #endif
 101
 102 #ifndef SvREFCNT_inc_simple_void
 103 # define SvREFCNT_inc_simple_void(sv) ((void) SvREFCNT_inc(sv))
 104 #endif
 105
 106 #ifndef mPUSHi
 107 # define mPUSHi(I) PUSHs(sv_2mortal(newSViv(I)))
 108 #endif
 109
 110 #ifndef GvCV_set
 111 # define GvCV_set(G, C) (GvCV(G) = (C))
 112 #endif
 113
 114 #ifndef CvGV_set
 115 # define CvGV_set(C, G) (CvGV(C) = (G))
 116 #endif
 117
 118 #ifndef CvSTASH_set
 119 # define CvSTASH_set(C, S) (CvSTASH(C) = (S))
 120 #endif
 121
 122 #ifndef CvISXSUB
 123 # define CvISXSUB(C) CvXSUB(C)
 124 #endif
 125
 126 #ifndef PadlistARRAY
 127 # define PadlistARRAY(P) AvARRAY(P)
 128 # define PadARRAY(P)     AvARRAY(P)
 129 #endif
 130
 131 #ifndef CxHASARGS
 132 # define CxHASARGS(C) ((C)->blk_sub.hasargs)
 133 #endif
 134
 135 #ifndef CxGIMME
 136 # ifdef G_WANT
 137 #  define CxGIMME(C) ((C)->blk_gimme & G_WANT)
 138 # else
 139 #  define CxGIMME(C) ((C)->blk_gimme)
 140 # endif
 141 #endif
 142
 143 #ifndef CxOLD_OP_TYPE
 144 # define CxOLD_OP_TYPE(C) (C)->blk_eval.old_op_type
 145 #endif
 146
 147 #ifndef OutCopFILE
 148 # define OutCopFILE(C) CopFILE(C)
 149 #endif
 150
 151 #ifndef OutCopFILE_len
 152 # define OutCopFILE_len(C) strlen(OutCopFILE(C))
 153 #endif
 154
 155 #ifndef CopHINTS_get
 156 # define CopHINTS_get(C) ((I32) (C)->op_private & HINT_PRIVATE_MASK)
 157 #endif
 158
 159 #ifndef CopHINTHASH_get
 160 # define CopHINTHASH_get(C) (C)->cop_hints_hash
 161 #endif
 162
 163 #ifndef cophh_2hv
 164 # define COPHH           struct refcounted_he
 165 # define cophh_2hv(H, F) Perl_refcounted_he_chain_2hv(aTHX_ (H))
 166 #endif
 167
 168 #ifndef HvNAME_get
 169 # define HvNAME_get(H) HvNAME(H)
 170 #endif
 171
 172 #ifndef HvNAMELEN
 173 # define HvNAMELEN(H) strlen(HvNAME(H))
 174 #endif
 175
 176 #ifndef gv_fetchpvn_flags
 177 # define gv_fetchpvn_flags(A, B, C, D) gv_fetchpv((A), (C), (D))
 178 #endif
 179
 180 #ifndef hv_fetchs
 181 # define hv_fetchs(H, K, L) hv_fetch((H), (K), sizeof(K)-1, (L))
 182 #endif
 183
 184 #ifndef OP_GIMME_REVERSE
 185 static U8 su_op_gimme_reverse(U8 gimme) {
 186  switch (gimme) {
 187   case G_VOID:
 188    return OPf_WANT_VOID;
 189   case G_ARRAY:
 190    return OPf_WANT_LIST;
 191   default:
 192    break;
 193  }
 194
 195  return OPf_WANT_SCALAR;
 196 }
 197 #define OP_GIMME_REVERSE(G) su_op_gimme_reverse(G)
 198 #endif
 199
 200 #ifndef OpSIBLING
 201 # ifdef OP_SIBLING
 202 #  define OpSIBLING(O) OP_SIBLING(O)
 203 # else
 204 #  define OpSIBLING(O) ((O)->op_sibling)
 205 # endif
 206 #endif
 207
 208 #ifndef PERL_MAGIC_tied
 209 # define PERL_MAGIC_tied 'P'
 210 #endif
 211
 212 #ifndef PERL_MAGIC_env
 213 # define PERL_MAGIC_env 'E'
 214 #endif
 215
 216 #ifndef NEGATIVE_INDICES_VAR
 217 # define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"
 218 #endif
 219
 220 #define SU_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
 221 #define SU_HAS_PERL_EXACT(R, V, S) ((PERL_REVISION == (R)) && (PERL_VERSION == (V)) && (PERL_SUBVERSION == (S)))
 222
 223 /* --- Threads and multiplicity -------------------------------------------- */
 224
 225 #ifndef SU_MULTIPLICITY
 226 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
 227 #  define SU_MULTIPLICITY 1
 228 # else
 229 #  define SU_MULTIPLICITY 0
 230 # endif
 231 #endif
 232 #if SU_MULTIPLICITY && !defined(tTHX)
 233 # define tTHX PerlInterpreter*
 234 #endif
 235
 236 #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))
 237 # define SU_THREADSAFE 1
 238 # ifndef MY_CXT_CLONE
 239 #  define MY_CXT_CLONE \
 240     dMY_CXT_SV;                                                      \
 241     my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
 242     Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
 243     sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
 244 # endif
 245 #else
 246 # define SU_THREADSAFE 0
 247 # undef  dMY_CXT
 248 # define dMY_CXT      dNOOP
 249 # undef  MY_CXT
 250 # define MY_CXT       su_globaldata
 251 # undef  START_MY_CXT
 252 # define START_MY_CXT static my_cxt_t MY_CXT;
 253 # undef  MY_CXT_INIT
 254 # define MY_CXT_INIT  NOOP
 255 # undef  MY_CXT_CLONE
 256 # define MY_CXT_CLONE NOOP
 257 #endif
 258
 259 /* --- Unique context ID global storage ------------------------------------ */
 260
 261 /* ... Sequence ID counter ................................................. */
 262
 263 typedef struct {
 264  UV     *seqs;
 265  STRLEN  size;
 266 } su_uv_array;
 267
 268 static su_uv_array su_uid_seq_counter;
 269
 270 #ifdef USE_ITHREADS
 271
 272 static perl_mutex su_uid_seq_counter_mutex;
 273
 274 #define SU_LOCK(M)   MUTEX_LOCK(M)
 275 #define SU_UNLOCK(M) MUTEX_UNLOCK(M)
 276
 277 #else /* USE_ITHREADS */
 278
 279 #define SU_LOCK(M)
 280 #define SU_UNLOCK(M)
 281
 282 #endif /* !USE_ITHREADS */
 283
 284 static UV su_uid_seq_next(pTHX_ UV depth) {
 285 #define su_uid_seq_next(D) su_uid_seq_next(aTHX_ (D))
 286  UV seq;
 287  UV *seqs;
 288
 289  SU_LOCK(&su_uid_seq_counter_mutex);
 290
 291  seqs = su_uid_seq_counter.seqs;
 292
 293  if (depth >= su_uid_seq_counter.size) {
 294   UV i;
 295
 296   seqs = PerlMemShared_realloc(seqs, (depth + 1) * sizeof(UV));
 297   for (i = su_uid_seq_counter.size; i <= depth; ++i)
 298    seqs[i] = 0;
 299
 300   su_uid_seq_counter.seqs = seqs;
 301   su_uid_seq_counter.size = depth + 1;
 302  }
 303
 304  seq = ++seqs[depth];
 305
 306  SU_UNLOCK(&su_uid_seq_counter_mutex);
 307
 308  return seq;
 309 }
 310
 311 /* ... UID storage ......................................................... */
 312
 313 typedef struct {
 314  UV  seq;
 315  U32 flags;
 316 } su_uid;
 317
 318 #define SU_UID_ACTIVE 1
 319
 320 static UV su_uid_depth(pTHX_ I32 cxix) {
 321 #define su_uid_depth(I) su_uid_depth(aTHX_ (I))
 322  const PERL_SI *si;
 323  UV depth;
 324
 325  depth = cxix;
 326  for (si = PL_curstackinfo->si_prev; si; si = si->si_prev)
 327   depth += si->si_cxix + 1;
 328
 329  return depth;
 330 }
 331
 332 typedef struct {
 333  su_uid **map;
 334  STRLEN   used;
 335  STRLEN   alloc;
 336 } su_uid_storage;
 337
 338 static void su_uid_storage_dup(pTHX_ su_uid_storage *new_cxt, const su_uid_storage *old_cxt, UV max_depth) {
 339 #define su_uid_storage_dup(N, O, D) su_uid_storage_dup(aTHX_ (N), (O), (D))
 340  su_uid **old_map = old_cxt->map;
 341
 342  if (old_map) {
 343   su_uid **new_map = new_cxt->map;
 344   STRLEN old_used  = old_cxt->used;
 345   STRLEN new_used, new_alloc;
 346   STRLEN i;
 347
 348   new_used = max_depth < old_used ? max_depth : old_used;
 349   new_cxt->used = new_used;
 350
 351   if (new_used <= new_cxt->alloc)
 352    new_alloc = new_cxt->alloc;
 353   else {
 354    new_alloc = new_used;
 355    Renew(new_map, new_alloc, su_uid *);
 356    for (i = new_cxt->alloc; i < new_alloc; ++i)
 357     new_map[i] = NULL;
 358    new_cxt->map   = new_map;
 359    new_cxt->alloc = new_alloc;
 360   }
 361
 362   for (i = 0; i < new_alloc; ++i) {
 363    su_uid *new_uid = new_map[i];
 364
 365    if (i < new_used) { /* => i < max_depth && i < old_used */
 366     su_uid *old_uid = old_map[i];
 367
 368     if (old_uid && (old_uid->flags & SU_UID_ACTIVE)) {
 369      if (!new_uid) {
 370       Newx(new_uid, 1, su_uid);
 371       new_map[i] = new_uid;
 372      }
 373      *new_uid = *old_uid;
 374      continue;
 375     }
 376    }
 377
 378    if (new_uid)
 379     new_uid->flags &= ~SU_UID_ACTIVE;
 380   }
 381  }
 382
 383  return;
 384 }
 385
 386 /* --- unwind() global storage --------------------------------------------- */
 387
 388 typedef struct {
 389  I32      cxix;
 390  I32      items;
 391  SV     **savesp;
 392  LISTOP   return_op;
 393  OP       proxy_op;
 394 } su_unwind_storage;
 395
 396 /* --- yield() global storage ---------------------------------------------- */
 397
 398 typedef struct {
 399  I32      cxix;
 400  I32      items;
 401  SV     **savesp;
 402  UNOP     leave_op;
 403  OP       proxy_op;
 404 } su_yield_storage;
 405
 406 /* --- uplevel() data tokens and global storage ---------------------------- */
 407
 408 #define SU_UPLEVEL_HIJACKS_RUNOPS SU_HAS_PERL(5, 8, 0)
 409
 410 typedef struct {
 411  void          *next;
 412
 413  su_uid_storage tmp_uid_storage;
 414  su_uid_storage old_uid_storage;
 415
 416  I32            cxix;
 417
 418  I32            target_depth;
 419  CV            *target;
 420
 421  CV            *callback;
 422  CV            *renamed;
 423
 424  PERL_SI       *si;
 425  PERL_SI       *old_curstackinfo;
 426  AV            *old_mainstack;
 427
 428  COP           *old_curcop;
 429
 430  OP            *old_op;
 431 #if SU_UPLEVEL_HIJACKS_RUNOPS
 432  runops_proc_t  old_runops;
 433 #endif
 434  bool           old_catch;
 435
 436  bool           died;
 437 } su_uplevel_ud;
 438
 439 static su_uplevel_ud *su_uplevel_ud_new(pTHX) {
 440 #define su_uplevel_ud_new() su_uplevel_ud_new(aTHX)
 441  su_uplevel_ud *sud;
 442  PERL_SI       *si;
 443
 444  Newx(sud, 1, su_uplevel_ud);
 445  sud->next = NULL;
 446
 447  sud->tmp_uid_storage.map   = NULL;
 448  sud->tmp_uid_storage.used  = 0;
 449  sud->tmp_uid_storage.alloc = 0;
 450
 451  Newx(si, 1, PERL_SI);
 452  si->si_stack   = newAV();
 453  AvREAL_off(si->si_stack);
 454  si->si_cxstack = NULL;
 455  si->si_cxmax   = 0;
 456
 457  sud->si = si;
 458
 459  return sud;
 460 }
 461
 462 static void su_uplevel_ud_delete(pTHX_ su_uplevel_ud *sud) {
 463 #define su_uplevel_ud_delete(S) su_uplevel_ud_delete(aTHX_ (S))
 464  PERL_SI *si = sud->si;
 465
 466  Safefree(si->si_cxstack);
 467  SvREFCNT_dec(si->si_stack);
 468  Safefree(si);
 469
 470  if (sud->tmp_uid_storage.map) {
 471   su_uid **map   = sud->tmp_uid_storage.map;
 472   STRLEN   alloc = sud->tmp_uid_storage.alloc;
 473   STRLEN   i;
 474
 475   for (i = 0; i < alloc; ++i)
 476    Safefree(map[i]);
 477
 478   Safefree(map);
 479  }
 480
 481  Safefree(sud);
 482
 483  return;
 484 }
 485
 486 typedef struct {
 487  su_uplevel_ud *top;
 488  su_uplevel_ud *root;
 489  I32            count;
 490 } su_uplevel_storage;
 491
 492 #ifndef SU_UPLEVEL_STORAGE_SIZE
 493 # define SU_UPLEVEL_STORAGE_SIZE 4
 494 #endif
 495
 496 /* --- Global data --------------------------------------------------------- */
 497
 498 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
 499
 500 typedef struct {
 501  char               *stack_placeholder;
 502  su_unwind_storage   unwind_storage;
 503  su_yield_storage    yield_storage;
 504  su_uplevel_storage  uplevel_storage;
 505  su_uid_storage      uid_storage;
 506 } my_cxt_t;
 507
 508 START_MY_CXT
 509
 510 /* --- Stack manipulations ------------------------------------------------- */
 511
 512 #define SU_SAVE_PLACEHOLDER() save_pptr(&MY_CXT.stack_placeholder)
 513
 514 #define SU_SAVE_DESTRUCTOR_SIZE  3
 515 #define SU_SAVE_PLACEHOLDER_SIZE 3
 516
 517 #define SU_SAVE_SCALAR_SIZE 3
 518
 519 #define SU_SAVE_ARY_SIZE      3
 520 #define SU_SAVE_AELEM_SIZE    4
 521 #ifdef SAVEADELETE
 522 # define SU_SAVE_ADELETE_SIZE 3
 523 #else
 524 # define SU_SAVE_ADELETE_SIZE SU_SAVE_DESTRUCTOR_SIZE
 525 #endif
 526 #if SU_SAVE_AELEM_SIZE < SU_SAVE_ADELETE_SIZE
 527 # define SU_SAVE_AELEM_OR_ADELETE_SIZE SU_SAVE_ADELETE_SIZE
 528 #else
 529 # define SU_SAVE_AELEM_OR_ADELETE_SIZE SU_SAVE_AELEM_SIZE
 530 #endif
 531
 532 #define SU_SAVE_HASH_SIZE    3
 533 #define SU_SAVE_HELEM_SIZE   4
 534 #define SU_SAVE_HDELETE_SIZE 4
 535 #if SU_SAVE_HELEM_SIZE < SU_SAVE_HDELETE_SIZE
 536 # define SU_SAVE_HELEM_OR_HDELETE_SIZE SU_SAVE_HDELETE_SIZE
 537 #else
 538 # define SU_SAVE_HELEM_OR_HDELETE_SIZE SU_SAVE_HELEM_SIZE
 539 #endif
 540
 541 #define SU_SAVE_GVCV_SIZE SU_SAVE_DESTRUCTOR_SIZE
 542
 543 #if !SU_HAS_PERL(5, 8, 9)
 544 # define SU_SAVE_GP_SIZE 6
 545 #elif !SU_HAS_PERL(5, 13, 0) || (SU_RELEASE && SU_HAS_PERL_EXACT(5, 13, 0))
 546 # define SU_SAVE_GP_SIZE 3
 547 #elif !SU_HAS_PERL(5, 13, 8)
 548 # define SU_SAVE_GP_SIZE 4
 549 #else
 550 # define SU_SAVE_GP_SIZE 3
 551 #endif
 552
 553 #ifndef SvCANEXISTDELETE
 554 # define SvCANEXISTDELETE(sv) \
 555   (!SvRMAGICAL(sv)            \
 556    || ((mg = mg_find((SV *) sv, PERL_MAGIC_tied))            \
 557        && (stash = SvSTASH(SvRV(SvTIED_obj((SV *) sv, mg)))) \
 558        && gv_fetchmethod_autoload(stash, "EXISTS", TRUE)     \
 559        && gv_fetchmethod_autoload(stash, "DELETE", TRUE)     \
 560       )                       \
 561    )
 562 #endif
 563
 564 /* ... Saving array elements ............................................... */
 565
 566 static I32 su_av_key2idx(pTHX_ AV *av, I32 key) {
 567 #define su_av_key2idx(A, K) su_av_key2idx(aTHX_ (A), (K))
 568  I32 idx;
 569
 570  if (key >= 0)
 571   return key;
 572
 573 /* Added by MJD in perl-5.8.1 with 6f12eb6d2a1dfaf441504d869b27d2e40ef4966a */
 574 #if SU_HAS_PERL(5, 8, 1)
 575  if (SvRMAGICAL(av)) {
 576   const MAGIC * const tied_magic = mg_find((SV *) av, PERL_MAGIC_tied);
 577   if (tied_magic) {
 578    SV * const * const negative_indices_glob =
 579                     hv_fetch(SvSTASH(SvRV(SvTIED_obj((SV *) (av), tied_magic))),
 580                              NEGATIVE_INDICES_VAR, 16, 0);
 581    if (negative_indices_glob && SvTRUE(GvSV(*negative_indices_glob)))
 582     return key;
 583   }
 584  }
 585 #endif
 586
 587  idx = key + av_len(av) + 1;
 588  if (idx < 0)
 589   return key;
 590
 591  return idx;
 592 }
 593
 594 #ifndef SAVEADELETE
 595
 596 typedef struct {
 597  AV *av;
 598  I32 idx;
 599 } su_ud_adelete;
 600
 601 static void su_adelete(pTHX_ void *ud_) {
 602  su_ud_adelete *ud = (su_ud_adelete *) ud_;
 603
 604  av_delete(ud->av, ud->idx, G_DISCARD);
 605  SvREFCNT_dec(ud->av);
 606
 607  Safefree(ud);
 608 }
 609
 610 static void su_save_adelete(pTHX_ AV *av, I32 idx) {
 611 #define su_save_adelete(A, K) su_save_adelete(aTHX_ (A), (K))
 612  su_ud_adelete *ud;
 613
 614  Newx(ud, 1, su_ud_adelete);
 615  ud->av  = av;
 616  ud->idx = idx;
 617  SvREFCNT_inc_simple_void(av);
 618
 619  SAVEDESTRUCTOR_X(su_adelete, ud);
 620 }
 621
 622 #define SAVEADELETE(A, K) su_save_adelete((A), (K))
 623
 624 #endif /* SAVEADELETE */
 625
 626 static void su_save_aelem(pTHX_ AV *av, SV *key, SV *val) {
 627 #define su_save_aelem(A, K, V) su_save_aelem(aTHX_ (A), (K), (V))
 628  I32 idx;
 629  I32 preeminent = 1;
 630  SV **svp;
 631  HV *stash;
 632  MAGIC *mg;
 633
 634  idx = su_av_key2idx(av, SvIV(key));
 635
 636  if (SvCANEXISTDELETE(av))
 637   preeminent = av_exists(av, idx);
 638
 639  svp = av_fetch(av, idx, 1);
 640  if (!svp || *svp == &PL_sv_undef) croak(PL_no_aelem, idx);
 641
 642  if (preeminent)
 643   save_aelem(av, idx, svp);
 644  else
 645   SAVEADELETE(av, idx);
 646
 647  if (val) { /* local $x[$idx] = $val; */
 648   SvSetMagicSV(*svp, val);
 649  } else {   /* local $x[$idx]; delete $x[$idx]; */
 650   av_delete(av, idx, G_DISCARD);
 651  }
 652 }
 653
 654 /* ... Saving hash elements ................................................ */
 655
 656 static void su_save_helem(pTHX_ HV *hv, SV *keysv, SV *val) {
 657 #define su_save_helem(H, K, V) su_save_helem(aTHX_ (H), (K), (V))
 658  I32 preeminent = 1;
 659  HE *he;
 660  SV **svp;
 661  HV *stash;
 662  MAGIC *mg;
 663
 664  if (SvCANEXISTDELETE(hv) || mg_find((SV *) hv, PERL_MAGIC_env))
 665   preeminent = hv_exists_ent(hv, keysv, 0);
 666
 667  he  = hv_fetch_ent(hv, keysv, 1, 0);
 668  svp = he ? &HeVAL(he) : NULL;
 669  if (!svp || *svp == &PL_sv_undef) croak("Modification of non-creatable hash value attempted, subscript \"%s\"", SvPV_nolen_const(*svp));
 670
 671  if (HvNAME_get(hv) && isGV(*svp)) {
 672   save_gp((GV *) *svp, 0);
 673   return;
 674  }
 675
 676  if (preeminent)
 677   save_helem(hv, keysv, svp);
 678  else {
 679   STRLEN keylen;
 680   const char * const key = SvPV_const(keysv, keylen);
 681   SAVEDELETE(hv, savepvn(key, keylen),
 682                  SvUTF8(keysv) ? -(I32)keylen : (I32)keylen);
 683  }
 684
 685  if (val) { /* local $x{$keysv} = $val; */
 686   SvSetMagicSV(*svp, val);
 687  } else {   /* local $x{$keysv}; delete $x{$keysv}; */
 688   (void)hv_delete_ent(hv, keysv, G_DISCARD, HeHASH(he));
 689  }
 690 }
 691
 692 /* ... Saving code slots from a glob ....................................... */
 693
 694 #if !SU_HAS_PERL(5, 10, 0) && !defined(mro_method_changed_in)
 695 # define mro_method_changed_in(G) PL_sub_generation++
 696 #endif
 697
 698 typedef struct {
 699  GV *gv;
 700  CV *old_cv;
 701 } su_save_gvcv_ud;
 702
 703 static void su_restore_gvcv(pTHX_ void *ud_) {
 704  su_save_gvcv_ud *ud = ud_;
 705  GV              *gv = ud->gv;
 706
 707  GvCV_set(gv, ud->old_cv);
 708  GvCVGEN(gv) = 0;
 709  mro_method_changed_in(GvSTASH(gv));
 710
 711  Safefree(ud);
 712 }
 713
 714 static void su_save_gvcv(pTHX_ GV *gv) {
 715 #define su_save_gvcv(G) su_save_gvcv(aTHX_ (G))
 716  su_save_gvcv_ud *ud;
 717
 718  Newx(ud, 1, su_save_gvcv_ud);
 719  ud->gv     = gv;
 720  ud->old_cv = GvCV(gv);
 721
 722  GvCV_set(gv, NULL);
 723  GvCVGEN(gv) = 0;
 724  mro_method_changed_in(GvSTASH(gv));
 725
 726  SAVEDESTRUCTOR_X(su_restore_gvcv, ud);
 727 }
 728
 729 /* --- Actions ------------------------------------------------------------- */
 730
 731 typedef struct {
 732  U8   type;
 733  U8   private;
 734  U8   pad;
 735  /* spare */
 736  I32  depth;
 737  I32 *origin;
 738 } su_ud_common;
 739
 740 #define SU_UD_TYPE(U)    (((su_ud_common *) (U))->type)
 741 #define SU_UD_PRIVATE(U) (((su_ud_common *) (U))->private)
 742 #define SU_UD_PAD(U)     (((su_ud_common *) (U))->pad)
 743 #define SU_UD_DEPTH(U)   (((su_ud_common *) (U))->depth)
 744 #define SU_UD_ORIGIN(U)  (((su_ud_common *) (U))->origin)
 745
 746 #define SU_UD_TYPE_REAP     0
 747 #define SU_UD_TYPE_LOCALIZE 1
 748 #define SU_UD_TYPE_UID      2
 749
 750 #define SU_UD_FREE(U) STMT_START { \
 751  if (SU_UD_ORIGIN(U)) Safefree(SU_UD_ORIGIN(U)); \
 752  Safefree(U); \
 753 } STMT_END
 754
 755 /* ... Reap ................................................................ */
 756
 757 #define SU_SAVE_LAST_CX (!SU_HAS_PERL(5, 8, 4) || (SU_HAS_PERL(5, 9, 5) && !SU_HAS_PERL(5, 14, 0)) || SU_HAS_PERL(5, 15, 0))
 758
 759 typedef struct {
 760  su_ud_common ci;
 761  SV *cb;
 762 } su_ud_reap;
 763
 764 static void su_call(pTHX_ void *ud_) {
 765  su_ud_reap *ud = (su_ud_reap *) ud_;
 766 #if SU_SAVE_LAST_CX
 767  I32 cxix;
 768  PERL_CONTEXT saved_cx;
 769 #endif /* SU_SAVE_LAST_CX */
 770
 771  dSP;
 772
 773  SU_D({
 774   PerlIO_printf(Perl_debug_log,
 775                 "%p: @@@ call\n%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
 776                  ud, ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
 777  });
 778
 779  ENTER;
 780  SAVETMPS;
 781
 782  PUSHMARK(SP);
 783  PUTBACK;
 784
 785 #if SU_SAVE_LAST_CX
 786  /* If the recently popped context isn't saved there, it will be overwritten by
 787   * the sub scope from call_sv, although it's still needed in our caller. */
 788  cxix     = (cxstack_ix < cxstack_max) ? (cxstack_ix + 1) : Perl_cxinc(aTHX);
 789  saved_cx = cxstack[cxix];
 790 #endif /* SU_SAVE_LAST_CX */
 791
 792  call_sv(ud->cb, G_VOID);
 793
 794 #if SU_SAVE_LAST_CX
 795  cxstack[cxix] = saved_cx;
 796 #endif /* SU_SAVE_LAST_CX */
 797
 798  PUTBACK;
 799
 800  FREETMPS;
 801  LEAVE;
 802
 803  SvREFCNT_dec(ud->cb);
 804  SU_UD_FREE(ud);
 805 }
 806
 807 /* ... Localize & localize array/hash element .............................. */
 808
 809 typedef struct {
 810  su_ud_common ci;
 811  SV    *sv;
 812  SV    *val;
 813  SV    *elem;
 814 } su_ud_localize;
 815
 816 #define SU_UD_LOCALIZE_FREE(U) STMT_START { \
 817  SvREFCNT_dec((U)->elem); \
 818  SvREFCNT_dec((U)->val);  \
 819  SvREFCNT_dec((U)->sv);   \
 820  SU_UD_FREE(U);           \
 821 } STMT_END
 822
 823 static I32 su_ud_localize_init(pTHX_ su_ud_localize *ud, SV *sv, SV *val, SV *elem) {
 824 #define su_ud_localize_init(UD, S, V, E) su_ud_localize_init(aTHX_ (UD), (S), (V), (E))
 825  UV deref = 0;
 826  svtype t = SVt_NULL;
 827  I32 size;
 828
 829  SvREFCNT_inc_simple_void(sv);
 830
 831  if (SvTYPE(sv) >= SVt_PVGV) {
 832   if (!val || !SvROK(val)) { /* local *x; or local *x = $val; */
 833    t = SVt_PVGV;
 834   } else {                   /* local *x = \$val; */
 835    t = SvTYPE(SvRV(val));
 836    deref = 1;
 837   }
 838  } else if (SvROK(sv)) {
 839   croak("Invalid %s reference as the localization target",
 840                  sv_reftype(SvRV(sv), 0));
 841  } else {
 842   STRLEN len, l;
 843   const char *p = SvPV_const(sv, len), *s;
 844   for (s = p, l = len; l > 0 && isSPACE(*s); ++s, --l) { }
 845   if (!l) {
 846    l = len;
 847    s = p;
 848   }
 849   switch (*s) {
 850    case '$': t = SVt_PV;   break;
 851    case '@': t = SVt_PVAV; break;
 852    case '%': t = SVt_PVHV; break;
 853    case '&': t = SVt_PVCV; break;
 854    case '*': t = SVt_PVGV; break;
 855   }
 856   if (t != SVt_NULL) {
 857    ++s;
 858    --l;
 859   } else if (val) { /* t == SVt_NULL, type can't be inferred from the sigil */
 860    if (SvROK(val) && !sv_isobject(val)) {
 861     t = SvTYPE(SvRV(val));
 862     deref = 1;
 863    } else {
 864     t = SvTYPE(val);
 865    }
 866   }
 867   SvREFCNT_dec(sv);
 868   sv = newSVpvn(s, l);
 869  }
 870
 871  switch (t) {
 872   case SVt_PVAV:
 873    size  = elem ? SU_SAVE_AELEM_OR_ADELETE_SIZE
 874                 : SU_SAVE_ARY_SIZE;
 875    deref = 0;
 876    break;
 877   case SVt_PVHV:
 878    size  = elem ? SU_SAVE_HELEM_OR_HDELETE_SIZE
 879                 : SU_SAVE_HASH_SIZE;
 880    deref = 0;
 881    break;
 882   case SVt_PVGV:
 883    size  = SU_SAVE_GP_SIZE;
 884    deref = 0;
 885    break;
 886   case SVt_PVCV:
 887    size  = SU_SAVE_GVCV_SIZE;
 888    deref = 0;
 889    break;
 890   default:
 891    size = SU_SAVE_SCALAR_SIZE;
 892    break;
 893  }
 894  /* When deref is set, val isn't NULL */
 895
 896  SU_UD_PRIVATE(ud) = t;
 897
 898  ud->sv   = sv;
 899  ud->val  = val ? newSVsv(deref ? SvRV(val) : val) : NULL;
 900  ud->elem = SvREFCNT_inc(elem);
 901
 902  return size;
 903 }
 904
 905 static void su_localize(pTHX_ void *ud_) {
 906 #define su_localize(U) su_localize(aTHX_ (U))
 907  su_ud_localize *ud = (su_ud_localize *) ud_;
 908  SV *sv   = ud->sv;
 909  SV *val  = ud->val;
 910  SV *elem = ud->elem;
 911  svtype t = SU_UD_PRIVATE(ud);
 912  GV *gv;
 913
 914  if (SvTYPE(sv) >= SVt_PVGV) {
 915   gv = (GV *) sv;
 916  } else {
 917 #ifdef gv_fetchsv
 918   gv = gv_fetchsv(sv, GV_ADDMULTI, t);
 919 #else
 920   STRLEN len;
 921   const char *name = SvPV_const(sv, len);
 922   gv = gv_fetchpvn_flags(name, len, GV_ADDMULTI, t);
 923 #endif
 924  }
 925
 926  SU_D({
 927   SV *z = newSV(0);
 928   SvUPGRADE(z, t);
 929   PerlIO_printf(Perl_debug_log, "%p: === localize a %s\n",ud, sv_reftype(z, 0));
 930   PerlIO_printf(Perl_debug_log,
 931                 "%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
 932                  ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
 933   SvREFCNT_dec(z);
 934  });
 935
 936  /* Inspired from Alias.pm */
 937  switch (t) {
 938   case SVt_PVAV:
 939    if (elem) {
 940     su_save_aelem(GvAV(gv), elem, val);
 941     goto done;
 942    } else
 943     save_ary(gv);
 944    break;
 945   case SVt_PVHV:
 946    if (elem) {
 947     su_save_helem(GvHV(gv), elem, val);
 948     goto done;
 949    } else
 950     save_hash(gv);
 951    break;
 952   case SVt_PVGV:
 953    save_gp(gv, 1); /* hide previous entry in symtab */
 954    break;
 955   case SVt_PVCV:
 956    su_save_gvcv(gv);
 957    break;
 958   default:
 959    gv = (GV *) save_scalar(gv);
 960    break;
 961  }
 962
 963  if (val)
 964   SvSetMagicSV((SV *) gv, val);
 965
 966 done:
 967  SU_UD_LOCALIZE_FREE(ud);
 968 }
 969
 970 /* --- Pop a context back -------------------------------------------------- */
 971
 972 #ifdef DEBUGGING
 973 # define SU_CXNAME(C) PL_block_type[CxTYPE(C)]
 974 #else
 975 # if SU_HAS_PERL(5, 11, 0)
 976 static const char *su_block_type[] = {
 977  "NULL",
 978  "WHEN",
 979  "BLOCK",
 980  "GIVEN",
 981  "LOOP_FOR",
 982  "LOOP_PLAIN",
 983  "LOOP_LAZYSV",
 984  "LOOP_LAZYIV",
 985  "SUB",
 986  "FORMAT",
 987  "EVAL",
 988  "SUBST"
 989 };
 990 # elif SU_HAS_PERL(5, 9, 3)
 991 static const char *su_block_type[] = {
 992  "NULL",
 993  "SUB",
 994  "EVAL",
 995  "WHEN",
 996  "SUBST",
 997  "BLOCK",
 998  "FORMAT",
 999  "GIVEN",
1000  "LOOP_FOR",
1001  "LOOP_PLAIN",
1002  "LOOP_LAZYSV",
1003  "LOOP_LAZYIV"
1004 };
1005 # else
1006 static const char *su_block_type[] = {
1007  "NULL",
1008  "SUB",
1009  "EVAL",
1010  "LOOP",
1011  "SUBST",
1012  "BLOCK"
1013 };
1014 # endif
1015 # define SU_CXNAME(C) su_block_type[CxTYPE(C)]
1016 #endif
1017
1018 static void su_uid_bump(pTHX_ void *ud_);
1019
1020 static void su_pop(pTHX_ void *ud) {
1021 #define su_pop(U) su_pop(aTHX_ (U))
1022  I32 depth, base, mark, *origin;
1023  depth = SU_UD_DEPTH(ud);
1024
1025  SU_D(
1026   PerlIO_printf(Perl_debug_log,
1027    "%p: --- pop a %s\n"
1028    "%p: leave scope     at depth=%2d scope_ix=%2d cur_top=%2d cur_base=%2d\n",
1029     ud, SU_CXNAME(cxstack + cxstack_ix),
1030     ud, depth, PL_scopestack_ix,PL_savestack_ix,PL_scopestack[PL_scopestack_ix])
1031  );
1032
1033  origin = SU_UD_ORIGIN(ud);
1034  mark   = origin[depth];
1035  base   = origin[depth - 1];
1036
1037  SU_D(PerlIO_printf(Perl_debug_log,
1038                     "%p: original scope was %*c top=%2d     base=%2d\n",
1039                      ud,                24, ' ',    mark,        base));
1040
1041  if (base < mark) {
1042 #if SU_HAS_PERL(5, 19, 4)
1043   I32 save = -1;
1044   PERL_CONTEXT *cx;
1045 #endif
1046
1047   SU_D(PerlIO_printf(Perl_debug_log, "%p: clear leftovers\n", ud));
1048
1049 #if SU_HAS_PERL(5, 19, 4)
1050   cx = cxstack + cxstack_ix;
1051   if (CxTYPE(cx) == CXt_SUB || CxTYPE(cx) == CXt_FORMAT)
1052    save = PL_scopestack[cx->blk_oldscopesp - 1];
1053 #endif
1054
1055   PL_savestack_ix = mark;
1056   leave_scope(base);
1057
1058 #if SU_HAS_PERL(5, 19, 4)
1059   if (CxTYPE(cx) == CXt_SUB || CxTYPE(cx) == CXt_FORMAT)
1060    PL_scopestack[cx->blk_oldscopesp - 1] = save;
1061 #endif
1062  }
1063  PL_savestack_ix = base;
1064
1065  SU_UD_DEPTH(ud) = --depth;
1066
1067  if (depth > 0) {
1068   U8 pad;
1069
1070   if ((pad = SU_UD_PAD(ud)) > 0) {
1071    dMY_CXT;
1072    do {
1073     SU_D(PerlIO_printf(Perl_debug_log,
1074           "%p: push a pad slot at depth=%2d scope_ix=%2d save_ix=%2d\n",
1075            ud,                       depth, PL_scopestack_ix, PL_savestack_ix));
1076     SU_SAVE_PLACEHOLDER();
1077    } while (--pad);
1078   }
1079
1080   SU_D(PerlIO_printf(Perl_debug_log,
1081           "%p: push destructor at depth=%2d scope_ix=%2d save_ix=%2d\n",
1082            ud,                       depth, PL_scopestack_ix, PL_savestack_ix));
1083   SAVEDESTRUCTOR_X(su_pop, ud);
1084  } else {
1085   switch (SU_UD_TYPE(ud)) {
1086    case SU_UD_TYPE_REAP: {
1087     SU_D({
1088      PerlIO_printf(Perl_debug_log,
1089                 "%p: === reap\n%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
1090                  ud, ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
1091     });
1092     SAVEDESTRUCTOR_X(su_call, ud);
1093     break;
1094    }
1095    case SU_UD_TYPE_LOCALIZE:
1096     su_localize(ud);
1097     break;
1098    case SU_UD_TYPE_UID:
1099     su_uid_bump(aTHX_ ud);
1100     break;
1101   }
1102  }
1103
1104  SU_D(PerlIO_printf(Perl_debug_log,
1105                     "%p: --- end pop: cur_top=%2d == cur_base=%2d\n",
1106                      ud, PL_savestack_ix, PL_scopestack[PL_scopestack_ix]));
1107 }
1108
1109 /* --- Initialize the stack and the action userdata ------------------------ */
1110
1111 static I32 su_init(pTHX_ void *ud, I32 cxix, I32 size) {
1112 #define su_init(U, C, S) su_init(aTHX_ (U), (C), (S))
1113  I32 i, depth, offset, base, *origin;
1114  U8 pad;
1115
1116  SU_D(PerlIO_printf(Perl_debug_log, "%p: ### init for cx %d\n", ud, cxix));
1117
1118  if (size <= SU_SAVE_DESTRUCTOR_SIZE)
1119   pad = 0;
1120  else {
1121   I32 extra = size - SU_SAVE_DESTRUCTOR_SIZE;
1122   pad = extra / SU_SAVE_PLACEHOLDER_SIZE;
1123   if (extra % SU_SAVE_PLACEHOLDER_SIZE)
1124    ++pad;
1125  }
1126  offset = SU_SAVE_DESTRUCTOR_SIZE + SU_SAVE_PLACEHOLDER_SIZE * pad;
1127
1128  SU_D(PerlIO_printf(Perl_debug_log, "%p: size=%d pad=%d offset=%d\n",
1129                                      ud,    size,   pad,   offset));
1130
1131  depth = PL_scopestack_ix - cxstack[cxix].blk_oldscopesp;
1132  SU_D(PerlIO_printf(Perl_debug_log, "%p: going down to depth %d\n", ud, depth));
1133
1134  Newx(origin, depth + 1, I32);
1135  base = PL_scopestack_ix - depth;
1136  origin[0] = PL_scopestack[base];
1137  PL_scopestack[base] += size;
1138  for (i = 1; i < depth; ++i) {
1139   I32 j = i + base;
1140   origin[i] = PL_scopestack[j];
1141   PL_scopestack[j] += offset;
1142  }
1143  origin[depth] = PL_savestack_ix;
1144
1145  SU_UD_PAD(ud)    = pad;
1146  SU_UD_DEPTH(ud)  = depth;
1147  SU_UD_ORIGIN(ud) = origin;
1148
1149  /* Make sure the first destructor fires by pushing enough fake slots on the
1150   * stack. */
1151  if (PL_savestack_ix + SU_SAVE_DESTRUCTOR_SIZE
1152                                        <= PL_scopestack[PL_scopestack_ix - 1]) {
1153   dMY_CXT;
1154   do {
1155    SU_D(PerlIO_printf(Perl_debug_log,
1156                   "%p: push a fake slot      at scope_ix=%2d  save_ix=%2d\n",
1157                    ud,                      PL_scopestack_ix, PL_savestack_ix));
1158    SU_SAVE_PLACEHOLDER();
1159   } while (PL_savestack_ix + SU_SAVE_DESTRUCTOR_SIZE
1160                                         <= PL_scopestack[PL_scopestack_ix - 1]);
1161  }
1162  SU_D(PerlIO_printf(Perl_debug_log,
1163                   "%p: push first destructor at scope_ix=%2d  save_ix=%2d\n",
1164                    ud,                      PL_scopestack_ix, PL_savestack_ix));
1165  SAVEDESTRUCTOR_X(su_pop, ud);
1166
1167  SU_D({
1168   for (i = 0; i <= depth; ++i) {
1169    I32 j = PL_scopestack_ix  - i;
1170    PerlIO_printf(Perl_debug_log,
1171                  "%p: depth=%2d scope_ix=%2d saved_floor=%2d new_floor=%2d\n",
1172                   ud,        i, j, origin[depth - i],
1173                                    i == 0 ? PL_savestack_ix : PL_scopestack[j]);
1174   }
1175  });
1176
1177  return depth;
1178 }
1179
1180 /* --- Unwind stack -------------------------------------------------------- */
1181
1182 static void su_unwind(pTHX_ void *ud_) {
1183  dMY_CXT;
1184  I32 cxix  = MY_CXT.unwind_storage.cxix;
1185  I32 items = MY_CXT.unwind_storage.items;
1186  I32 mark;
1187
1188  PERL_UNUSED_VAR(ud_);
1189
1190  PL_stack_sp = MY_CXT.unwind_storage.savesp;
1191 #if SU_HAS_PERL(5, 19, 4)
1192  {
1193   I32 i;
1194   SV **sp = PL_stack_sp;
1195   for (i = -items + 1; i <= 0; ++i)
1196    if (!SvTEMP(sp[i]))
1197     sv_2mortal(SvREFCNT_inc(sp[i]));
1198  }
1199 #endif
1200
1201  if (cxstack_ix > cxix)
1202   dounwind(cxix);
1203
1204  mark = PL_markstack[cxstack[cxix].blk_oldmarksp];
1205  *PL_markstack_ptr = PL_stack_sp - PL_stack_base - items;
1206
1207  SU_D({
1208   I32 gimme = GIMME_V;
1209   PerlIO_printf(Perl_debug_log,
1210                 "%p: cx=%d gimme=%s items=%d sp=%d oldmark=%d mark=%d\n",
1211                 &MY_CXT, cxix,
1212                 gimme == G_VOID ? "void" : gimme == G_ARRAY ? "list" : "scalar",
1213                 items, PL_stack_sp - PL_stack_base, *PL_markstack_ptr, mark);
1214  });
1215
1216  PL_op = (OP *) &(MY_CXT.unwind_storage.return_op);
1217  PL_op = PL_op->op_ppaddr(aTHX);
1218
1219  *PL_markstack_ptr = mark;
1220
1221  MY_CXT.unwind_storage.proxy_op.op_next = PL_op;
1222  PL_op = &(MY_CXT.unwind_storage.proxy_op);
1223 }
1224
1225 /* --- Yield --------------------------------------------------------------- */
1226
1227 #if SU_HAS_PERL(5, 10, 0)
1228 # define SU_RETOP_SUB(C)   ((C)->blk_sub.retop)
1229 # define SU_RETOP_EVAL(C)  ((C)->blk_eval.retop)
1230 # define SU_RETOP_LOOP(C)  ((C)->blk_loop.my_op->op_lastop->op_next)
1231 # define SU_RETOP_GIVEN(C) ((C)->blk_givwhen.leave_op->op_next)
1232 #else
1233 # define SU_RETOP_SUB(C)  ((C)->blk_oldretsp > 0 ? PL_retstack[(C)->blk_oldretsp - 1] : NULL)
1234 # define SU_RETOP_EVAL(C) SU_RETOP_SUB(C)
1235 # define SU_RETOP_LOOP(C) ((C)->blk_loop.last_op->op_next)
1236 #endif
1237
1238 static void su_yield(pTHX_ void *ud_) {
1239  dMY_CXT;
1240  PERL_CONTEXT *cx;
1241  const char   *which = ud_;
1242  I32 cxix      = MY_CXT.yield_storage.cxix;
1243  I32 items     = MY_CXT.yield_storage.items;
1244  opcode  type  = OP_NULL;
1245  U8      flags = 0;
1246  OP     *next;
1247
1248  PERL_UNUSED_VAR(ud_);
1249
1250  cx = cxstack + cxix;
1251  switch (CxTYPE(cx)) {
1252   case CXt_BLOCK: {
1253    I32 i, cur = cxstack_ix, n = 1;
1254    OP *o = NULL;
1255    /* Is this actually a given/when block? This may occur only when yield was
1256     * called with HERE (or nothing) as the context. */
1257 #if SU_HAS_PERL(5, 10, 0)
1258    if (cxix > 0) {
1259     PERL_CONTEXT *prev = cx - 1;
1260     U8       prev_type = CxTYPE(prev);
1261     if ((prev_type == CXt_GIVEN || prev_type == CXt_WHEN)
1262         && (prev->blk_oldcop == cx->blk_oldcop)) {
1263      cxix--;
1264      cx = prev;
1265      if (prev_type == CXt_GIVEN)
1266       goto cxt_given;
1267      else
1268       goto cxt_when;
1269     }
1270    }
1271 #endif
1272    type  = OP_LEAVE;
1273    next  = NULL;
1274    /* Bare blocks (that appear as do { ... } blocks, map { ... } blocks or
1275     * constant folded blcoks) don't need to save the op to return to anywhere
1276     * since 'last' isn't supposed to work inside them. So we climb higher in
1277     * the context stack until we reach a context that has a return op (i.e. a
1278     * sub, an eval, a format or a real loop), recording how many blocks we
1279     * crossed. Then we follow the op_next chain until we get to the leave op
1280     * that closes the original block, which we are assured to reach since
1281     * everything is static (the blocks we have crossed cannot be evals or
1282     * subroutine calls). */
1283    for (i = cxix + 1; i <= cur; ++i) {
1284     PERL_CONTEXT *cx2 = cxstack + i;
1285     switch (CxTYPE(cx2)) {
1286      case CXt_BLOCK:
1287       ++n;
1288       break;
1289      case CXt_SUB:
1290      case CXt_FORMAT:
1291       o = SU_RETOP_SUB(cx2);
1292       break;
1293      case CXt_EVAL:
1294       o = SU_RETOP_EVAL(cx2);
1295       break;
1296 #if SU_HAS_PERL(5, 11, 0)
1297      case CXt_LOOP_FOR:
1298      case CXt_LOOP_PLAIN:
1299      case CXt_LOOP_LAZYSV:
1300      case CXt_LOOP_LAZYIV:
1301 #else
1302      case CXt_LOOP:
1303 #endif
1304       o = SU_RETOP_LOOP(cx2);
1305       break;
1306     }
1307     if (o)
1308      break;
1309    }
1310    if (!o)
1311     o = PL_op;
1312    while (n && o) {
1313     /* We may find other enter/leave blocks on our way to the matching leave.
1314      * Make sure the depth is incremented/decremented appropriately. */
1315     if (o->op_type == OP_ENTER) {
1316      ++n;
1317     } else if (o->op_type == OP_LEAVE) {
1318      --n;
1319      if (!n) {
1320       next = o->op_next;
1321       break;
1322      }
1323     }
1324     o = o->op_next;
1325    }
1326    break;
1327   }
1328   case CXt_SUB:
1329   case CXt_FORMAT:
1330    type = OP_LEAVESUB;
1331    next = SU_RETOP_SUB(cx);
1332    break;
1333   case CXt_EVAL:
1334    type = CxTRYBLOCK(cx) ? OP_LEAVETRY : OP_LEAVEEVAL;
1335    next = SU_RETOP_EVAL(cx);
1336    break;
1337 #if SU_HAS_PERL(5, 11, 0)
1338   case CXt_LOOP_FOR:
1339   case CXt_LOOP_PLAIN:
1340   case CXt_LOOP_LAZYSV:
1341   case CXt_LOOP_LAZYIV:
1342 #else
1343   case CXt_LOOP:
1344 #endif
1345    type = OP_LEAVELOOP;
1346    next = SU_RETOP_LOOP(cx);
1347    break;
1348 #if SU_HAS_PERL(5, 10, 0)
1349   case CXt_GIVEN:
1350 cxt_given:
1351    type = OP_LEAVEGIVEN;
1352    next = SU_RETOP_GIVEN(cx);
1353    break;
1354   case CXt_WHEN:
1355 cxt_when:
1356 #if SU_HAS_PERL(5, 15, 1)
1357    type   = OP_LEAVEWHEN;
1358 #else
1359    type   = OP_BREAK;
1360    flags |= OPf_SPECIAL;
1361 #endif
1362    next   = NULL;
1363    break;
1364 #endif
1365   case CXt_SUBST:
1366    croak("%s() can't target a substitution context", which);
1367    break;
1368   default:
1369    croak("%s() doesn't know how to leave a %s context",
1370           which,                         SU_CXNAME(cxstack + cxix));
1371    break;
1372  }
1373
1374  PL_stack_sp = MY_CXT.yield_storage.savesp;
1375 #if SU_HAS_PERL(5, 19, 4)
1376  {
1377   I32 i;
1378   SV **sp = PL_stack_sp;
1379   for (i = -items + 1; i <= 0; ++i)
1380    if (!SvTEMP(sp[i]))
1381     sv_2mortal(SvREFCNT_inc(sp[i]));
1382  }
1383 #endif
1384
1385  if (cxstack_ix > cxix)
1386   dounwind(cxix);
1387
1388  /* Copy the arguments passed to yield() where the leave op expects to find
1389   * them. */
1390  if (items)
1391   Move(PL_stack_sp - items + 1, PL_stack_base + cx->blk_oldsp + 1, items, SV *);
1392  PL_stack_sp = PL_stack_base + cx->blk_oldsp + items;
1393
1394  flags |= OP_GIMME_REVERSE(cx->blk_gimme);
1395
1396  MY_CXT.yield_storage.leave_op.op_type   = type;
1397  MY_CXT.yield_storage.leave_op.op_ppaddr = PL_ppaddr[type];
1398  MY_CXT.yield_storage.leave_op.op_flags  = flags;
1399  MY_CXT.yield_storage.leave_op.op_next   = next;
1400
1401  PL_op = (OP *) &(MY_CXT.yield_storage.leave_op);
1402  PL_op = PL_op->op_ppaddr(aTHX);
1403
1404  MY_CXT.yield_storage.proxy_op.op_next = PL_op;
1405  PL_op = &(MY_CXT.yield_storage.proxy_op);
1406 }
1407
1408 /* --- Uplevel ------------------------------------------------------------- */
1409
1410 #define SU_UPLEVEL_SAVE(f, t) STMT_START { sud->old_##f = PL_##f; PL_##f = (t); } STMT_END
1411 #define SU_UPLEVEL_RESTORE(f) STMT_START { PL_##f = sud->old_##f; } STMT_END
1412
1413 static su_uplevel_ud *su_uplevel_storage_new(pTHX_ I32 cxix) {
1414 #define su_uplevel_storage_new(I) su_uplevel_storage_new(aTHX_ (I))
1415  su_uplevel_ud *sud;
1416  UV depth;
1417  dMY_CXT;
1418
1419  sud = MY_CXT.uplevel_storage.root;
1420  if (sud) {
1421   MY_CXT.uplevel_storage.root = sud->next;
1422   MY_CXT.uplevel_storage.count--;
1423  } else {
1424   sud = su_uplevel_ud_new();
1425  }
1426
1427  sud->next = MY_CXT.uplevel_storage.top;
1428  MY_CXT.uplevel_storage.top = sud;
1429
1430  depth = su_uid_depth(cxix);
1431  su_uid_storage_dup(&sud->tmp_uid_storage, &MY_CXT.uid_storage, depth);
1432  sud->old_uid_storage = MY_CXT.uid_storage;
1433  MY_CXT.uid_storage   = sud->tmp_uid_storage;
1434
1435  return sud;
1436 }
1437
1438 #if SU_HAS_PERL(5, 13, 7)
1439
1440 static void su_uplevel_storage_delete(pTHX_ su_uplevel_ud *sud) {
1441 #define su_uplevel_storage_delete(S) su_uplevel_storage_delete(aTHX_ (S))
1442  dMY_CXT;
1443
1444  sud->tmp_uid_storage = MY_CXT.uid_storage;
1445  MY_CXT.uid_storage   = sud->old_uid_storage;
1446  {
1447   su_uid **map;
1448   UV  i, alloc;
1449   map   = sud->tmp_uid_storage.map;
1450   alloc = sud->tmp_uid_storage.alloc;
1451   for (i = 0; i < alloc; ++i) {
1452    if (map[i])
1453     map[i]->flags &= SU_UID_ACTIVE;
1454   }
1455  }
1456  MY_CXT.uplevel_storage.top = sud->next;
1457
1458  if (MY_CXT.uplevel_storage.count >= SU_UPLEVEL_STORAGE_SIZE) {
1459   su_uplevel_ud_delete(sud);
1460  } else {
1461   sud->next = MY_CXT.uplevel_storage.root;
1462   MY_CXT.uplevel_storage.root = sud;
1463   MY_CXT.uplevel_storage.count++;
1464  }
1465 }
1466
1467 #endif
1468
1469 static int su_uplevel_goto_static(const OP *o) {
1470  for (; o; o = OpSIBLING(o)) {
1471   /* goto ops are unops with kids. */
1472   if (!(o->op_flags & OPf_KIDS))
1473    continue;
1474
1475   switch (o->op_type) {
1476    case OP_LEAVEEVAL:
1477    case OP_LEAVETRY:
1478     /* Don't care about gotos inside eval, as they are forbidden at run time. */
1479     break;
1480    case OP_GOTO:
1481     return 1;
1482    default:
1483     if (su_uplevel_goto_static(((const UNOP *) o)->op_first))
1484      return 1;
1485     break;
1486   }
1487  }
1488
1489  return 0;
1490 }
1491
1492 #if SU_UPLEVEL_HIJACKS_RUNOPS
1493
1494 static int su_uplevel_goto_runops(pTHX) {
1495 #define su_uplevel_goto_runops() su_uplevel_goto_runops(aTHX)
1496  register OP *op;
1497  dVAR;
1498
1499  op = PL_op;
1500  do {
1501   if (op->op_type == OP_GOTO) {
1502    AV  *argarray = NULL;
1503    I32  cxix;
1504
1505    for (cxix = cxstack_ix; cxix >= 0; --cxix) {
1506     const PERL_CONTEXT *cx = cxstack + cxix;
1507
1508     switch (CxTYPE(cx)) {
1509      case CXt_SUB:
1510       if (CxHASARGS(cx)) {
1511        argarray = cx->blk_sub.argarray;
1512        goto done;
1513       }
1514       break;
1515      case CXt_EVAL:
1516      case CXt_FORMAT:
1517       goto done;
1518      default:
1519       break;
1520     }
1521    }
1522
1523 done:
1524    if (argarray) {
1525     dMY_CXT;
1526
1527     if (MY_CXT.uplevel_storage.top->cxix == cxix) {
1528      AV  *args  = GvAV(PL_defgv);
1529      I32  items = AvFILLp(args);
1530
1531      av_extend(argarray, items);
1532      Copy(AvARRAY(args), AvARRAY(argarray), items + 1, SV *);
1533      AvFILLp(argarray) = items;
1534     }
1535    }
1536   }
1537
1538   PL_op = op = op->op_ppaddr(aTHX);
1539
1540 #if !SU_HAS_PERL(5, 13, 0)
1541   PERL_ASYNC_CHECK();
1542 #endif
1543  } while (op);
1544
1545  TAINT_NOT;
1546
1547  return 0;
1548 }
1549
1550 #endif /* SU_UPLEVEL_HIJACKS_RUNOPS */
1551
1552 #define su_at_underscore(C) PadARRAY(PadlistARRAY(CvPADLIST(C))[CvDEPTH(C)])[0]
1553
1554 static void su_uplevel_restore(pTHX_ void *sus_) {
1555  su_uplevel_ud *sud = sus_;
1556  PERL_SI *cur = sud->old_curstackinfo;
1557  PERL_SI *si  = sud->si;
1558
1559 #if SU_UPLEVEL_HIJACKS_RUNOPS
1560  if (PL_runops == su_uplevel_goto_runops)
1561   PL_runops = sud->old_runops;
1562 #endif
1563
1564  if (sud->callback) {
1565   PERL_CONTEXT *cx = cxstack + sud->cxix;
1566   AV     *argarray = MUTABLE_AV(su_at_underscore(sud->callback));
1567
1568   /* We have to fix the pad entry for @_ in the original callback because it
1569    * may have been reified. */
1570   if (AvREAL(argarray)) {
1571    const I32 fill = AvFILLp(argarray);
1572    SvREFCNT_dec(argarray);
1573    argarray = newAV();
1574    AvREAL_off(argarray);
1575    AvREIFY_on(argarray);
1576    av_extend(argarray, fill);
1577    su_at_underscore(sud->callback) = MUTABLE_SV(argarray);
1578   } else {
1579    CLEAR_ARGARRAY(argarray);
1580   }
1581
1582   /* If the old cv member is our renamed CV, it means that this place has been
1583    * reached without a goto() happening, and the old argarray member is
1584    * actually our fake argarray. Destroy it properly in that case. */
1585   if (cx->blk_sub.cv == sud->renamed) {
1586    SvREFCNT_dec(cx->blk_sub.argarray);
1587    cx->blk_sub.argarray = argarray;
1588   }
1589
1590   CvDEPTH(sud->callback)--;
1591   SvREFCNT_dec(sud->callback);
1592  }
1593
1594  /* Free the renamed CV. We must do it ourselves so that we can force the
1595   * depth to be 0, or perl would complain about it being "still in use".
1596   * But we *know* that it cannot be so. */
1597  if (sud->renamed) {
1598   if (!CvISXSUB(sud->renamed)) {
1599    CvDEPTH(sud->renamed)   = 0;
1600    CvPADLIST(sud->renamed) = NULL;
1601   }
1602   SvREFCNT_dec(sud->renamed);
1603  }
1604
1605  CATCH_SET(sud->old_catch);
1606
1607  SU_UPLEVEL_RESTORE(op);
1608
1609  /* stack_grow() wants PL_curstack so restore the old stack first */
1610  if (PL_curstackinfo == si) {
1611   PL_curstack = cur->si_stack;
1612   if (sud->old_mainstack)
1613    SU_UPLEVEL_RESTORE(mainstack);
1614   SU_UPLEVEL_RESTORE(curstackinfo);
1615
1616   if (sud->died) {
1617    CV *target = sud->target;
1618    I32 levels = 0, i;
1619
1620    /* When we die, the depth of the target CV is not updated because of the
1621     * stack switcheroo. So we have to look at all the frames between the
1622     * uplevel call and the catch block to count how many call frames to the
1623     * target CV were skipped. */
1624    for (i = cur->si_cxix; i > sud->cxix; i--) {
1625     register const PERL_CONTEXT *cx = cxstack + i;
1626
1627     if (CxTYPE(cx) == CXt_SUB) {
1628      if (cx->blk_sub.cv == target)
1629       ++levels;
1630     }
1631    }
1632
1633    /* If we died, the replacement stack was already unwinded to the first
1634     * eval frame, and all the contexts down there were popped. We don't have
1635     * to pop manually any context of the original stack, because they must
1636     * have been in the replacement stack as well (since the second was copied
1637     * from the first). Thus we only have to make sure the original stack index
1638     * points to the context just below the first eval scope under the target
1639     * frame. */
1640    for (; i >= 0; i--) {
1641     register const PERL_CONTEXT *cx = cxstack + i;
1642
1643     switch (CxTYPE(cx)) {
1644      case CXt_SUB:
1645       if (cx->blk_sub.cv == target)
1646        ++levels;
1647       break;
1648      case CXt_EVAL:
1649       goto found_it;
1650       break;
1651      default:
1652       break;
1653     }
1654    }
1655
1656 found_it:
1657    CvDEPTH(target) = sud->target_depth - levels;
1658    PL_curstackinfo->si_cxix = i - 1;
1659
1660 #if !SU_HAS_PERL(5, 13, 1)
1661    /* Since $@ was maybe localized between the target frame and the uplevel
1662     * call, we forcefully flush the save stack to get rid of it and then
1663     * reset $@ to its proper value. Note that the the call to
1664     * su_uplevel_restore() must happen before the "reset $@" item of the save
1665     * stack is processed, as uplevel was called after the localization.
1666     * Andrew's changes to how $@ was handled, which were mainly integrated
1667     * between perl 5.13.0 and 5.13.1, fixed this. */
1668    if (ERRSV && SvTRUE(ERRSV)) {
1669     register const PERL_CONTEXT *cx = cxstack + i; /* This is the eval scope */
1670     SV *errsv = SvREFCNT_inc(ERRSV);
1671     PL_scopestack_ix = cx->blk_oldscopesp;
1672     leave_scope(PL_scopestack[PL_scopestack_ix]);
1673     sv_setsv(ERRSV, errsv);
1674     SvREFCNT_dec(errsv);
1675    }
1676 #endif
1677   }
1678  }
1679
1680  SU_UPLEVEL_RESTORE(curcop);
1681
1682  SvREFCNT_dec(sud->target);
1683
1684  PL_stack_base = AvARRAY(cur->si_stack);
1685  PL_stack_sp   = PL_stack_base + AvFILLp(cur->si_stack);
1686  PL_stack_max  = PL_stack_base + AvMAX(cur->si_stack);
1687
1688  /* When an exception is thrown from the uplevel'd subroutine,
1689   * su_uplevel_restore() may be called by the LEAVE in die_unwind() (renamed
1690   * die_where() in more recent perls), which has the sad habit of keeping a
1691   * pointer to the current context frame across this call. This means that we
1692   * can't free the temporary context stack we used for the uplevel call right
1693   * now, or that pointer upwards would point to garbage. */
1694 #if SU_HAS_PERL(5, 13, 7)
1695  /* This issue has been fixed in perl with commit 8f89e5a9, which was made
1696   * public in perl 5.13.7. */
1697  su_uplevel_storage_delete(sud);
1698 #else
1699  /* Otherwise, we just enqueue it back in the global storage list. */
1700  {
1701   dMY_CXT;
1702
1703   sud->tmp_uid_storage = MY_CXT.uid_storage;
1704   MY_CXT.uid_storage   = sud->old_uid_storage;
1705
1706   MY_CXT.uplevel_storage.top  = sud->next;
1707   sud->next = MY_CXT.uplevel_storage.root;
1708   MY_CXT.uplevel_storage.root = sud;
1709   MY_CXT.uplevel_storage.count++;
1710  }
1711 #endif
1712
1713  return;
1714 }
1715
1716 static CV *su_cv_clone(pTHX_ CV *proto, GV *gv) {
1717 #define su_cv_clone(P, G) su_cv_clone(aTHX_ (P), (G))
1718  dVAR;
1719  CV *cv;
1720
1721  cv = MUTABLE_CV(newSV_type(SvTYPE(proto)));
1722
1723  CvFLAGS(cv)  = CvFLAGS(proto);
1724 #ifdef CVf_CVGV_RC
1725  CvFLAGS(cv) &= ~CVf_CVGV_RC;
1726 #endif
1727  CvDEPTH(cv)  = CvDEPTH(proto);
1728 #ifdef USE_ITHREADS
1729  CvFILE(cv)   = CvISXSUB(proto) ? CvFILE(proto) : savepv(CvFILE(proto));
1730 #else
1731  CvFILE(cv)   = CvFILE(proto);
1732 #endif
1733
1734  CvGV_set(cv, gv);
1735 #if SU_RELEASE && SU_HAS_PERL_EXACT(5, 21, 4)
1736  CvNAMED_off(cv);
1737 #endif
1738  CvSTASH_set(cv, CvSTASH(proto));
1739  /* Commit 4c74a7df, publicized with perl 5.13.3, began to add backrefs to
1740   * stashes. CvSTASH_set() started to do it as well with commit c68d95645
1741   * (which was part of perl 5.13.7). */
1742 #if SU_HAS_PERL(5, 13, 3) && !SU_HAS_PERL(5, 13, 7)
1743  if (CvSTASH(proto))
1744   Perl_sv_add_backref(aTHX_ CvSTASH(proto), MUTABLE_SV(cv));
1745 #endif
1746
1747  if (CvISXSUB(proto)) {
1748   CvXSUB(cv)       = CvXSUB(proto);
1749   CvXSUBANY(cv)    = CvXSUBANY(proto);
1750  } else {
1751   OP_REFCNT_LOCK;
1752   CvROOT(cv)       = OpREFCNT_inc(CvROOT(proto));
1753   OP_REFCNT_UNLOCK;
1754   CvSTART(cv)      = CvSTART(proto);
1755   CvPADLIST(cv)    = CvPADLIST(proto);
1756  }
1757  CvOUTSIDE(cv)     = CvOUTSIDE(proto);
1758 #ifdef CVf_WEAKOUTSIDE
1759  if (!(CvFLAGS(proto) & CVf_WEAKOUTSIDE))
1760 #endif
1761   SvREFCNT_inc_simple_void(CvOUTSIDE(cv));
1762 #ifdef CvOUTSIDE_SEQ
1763  CvOUTSIDE_SEQ(cv) = CvOUTSIDE_SEQ(proto);
1764 #endif
1765
1766  if (SvPOK(proto))
1767   sv_setpvn(MUTABLE_SV(cv), SvPVX_const(proto), SvCUR(proto));
1768
1769 #ifdef CvCONST
1770  if (CvCONST(cv))
1771   CvCONST_off(cv);
1772 #endif
1773
1774  return cv;
1775 }
1776
1777 static I32 su_uplevel(pTHX_ CV *callback, I32 cxix, I32 args) {
1778 #define su_uplevel(C, I, A) su_uplevel(aTHX_ (C), (I), (A))
1779  su_uplevel_ud *sud;
1780  const PERL_CONTEXT *cx = cxstack + cxix;
1781  PERL_SI *si;
1782  PERL_SI *cur = PL_curstackinfo;
1783  SV **old_stack_sp;
1784  CV  *target;
1785  CV  *renamed;
1786  UNOP sub_op;
1787  I32  gimme;
1788  I32  old_mark, new_mark;
1789  I32  ret;
1790  dSP;
1791
1792  ENTER;
1793
1794  gimme = GIMME_V;
1795  /* Make PL_stack_sp point just before the CV. */
1796  PL_stack_sp -= args + 1;
1797  old_mark = AvFILLp(PL_curstack) = PL_stack_sp - PL_stack_base;
1798  SPAGAIN;
1799
1800  sud = su_uplevel_storage_new(cxix);
1801
1802  sud->cxix     = cxix;
1803  sud->died     = 1;
1804  sud->callback = NULL;
1805  sud->renamed  = NULL;
1806  SAVEDESTRUCTOR_X(su_uplevel_restore, sud);
1807
1808  si = sud->si;
1809
1810  si->si_type    = cur->si_type;
1811  si->si_next    = NULL;
1812  si->si_prev    = cur->si_prev;
1813 #ifdef DEBUGGING
1814  si->si_markoff = cx->blk_oldmarksp;
1815 #endif
1816
1817  /* Allocate enough space for all the elements of the original stack up to the
1818   * target context, plus the forthcoming arguments. */
1819  new_mark = cx->blk_oldsp;
1820  av_extend(si->si_stack, new_mark + 1 + args + 1);
1821  Copy(PL_curstack, AvARRAY(si->si_stack), new_mark + 1, SV *);
1822  AvFILLp(si->si_stack) = new_mark;
1823  SU_POISON(AvARRAY(si->si_stack) + new_mark + 1, args + 1, SV *);
1824
1825  /* Specialized SWITCHSTACK() */
1826  PL_stack_base = AvARRAY(si->si_stack);
1827  old_stack_sp  = PL_stack_sp;
1828  PL_stack_sp   = PL_stack_base + AvFILLp(si->si_stack);
1829  PL_stack_max  = PL_stack_base + AvMAX(si->si_stack);
1830  SPAGAIN;
1831
1832  /* Copy the context stack up to the context just below the target. */
1833  si->si_cxix = (cxix < 0) ? -1 : (cxix - 1);
1834  if (si->si_cxmax < cxix) {
1835   /* The max size must be at least two so that GROW(max) = (max*3)/2 > max */
1836   si->si_cxmax = (cxix < 4) ? 4 : cxix;
1837   Renew(si->si_cxstack, si->si_cxmax + 1, PERL_CONTEXT);
1838  }
1839  Copy(cur->si_cxstack, si->si_cxstack, cxix, PERL_CONTEXT);
1840  SU_POISON(si->si_cxstack + cxix, si->si_cxmax + 1 - cxix, PERL_CONTEXT);
1841
1842  target            = cx->blk_sub.cv;
1843  sud->target       = (CV *) SvREFCNT_inc(target);
1844  sud->target_depth = CvDEPTH(target);
1845
1846  /* blk_oldcop is essentially needed for caller() and stack traces. It has no
1847   * run-time implication, since PL_curcop will be overwritten as soon as we
1848   * enter a sub (a sub starts by a nextstate/dbstate). Hence it's safe to just
1849   * make it point to the blk_oldcop for the target frame, so that caller()
1850   * reports the right file name, line number and lexical hints. */
1851  SU_UPLEVEL_SAVE(curcop, cx->blk_oldcop);
1852  /* Don't reset PL_markstack_ptr, or we would overwrite the mark stack below
1853   * this point. Don't reset PL_curpm either, we want the most recent matches. */
1854
1855  SU_UPLEVEL_SAVE(curstackinfo, si);
1856  /* If those two are equal, we need to fool POPSTACK_TO() */
1857  if (PL_mainstack == PL_curstack)
1858   SU_UPLEVEL_SAVE(mainstack, si->si_stack);
1859  else
1860   sud->old_mainstack = NULL;
1861  PL_curstack = si->si_stack;
1862
1863  renamed      = su_cv_clone(callback, CvGV(target));
1864  sud->renamed = renamed;
1865
1866  PUSHMARK(SP);
1867  /* Both SP and old_stack_sp point just before the CV. */
1868  Copy(old_stack_sp + 2, SP + 1, args, SV *);
1869  SP += args;
1870  PUSHs((SV *) renamed);
1871  PUTBACK;
1872
1873  Zero(&sub_op, 1, UNOP);
1874  sub_op.op_type  = OP_ENTERSUB;
1875  sub_op.op_next  = NULL;
1876  sub_op.op_flags = OP_GIMME_REVERSE(gimme) | OPf_STACKED;
1877  if (PL_DBsub)
1878   sub_op.op_flags |= OPpENTERSUB_DB;
1879
1880  SU_UPLEVEL_SAVE(op, (OP *) &sub_op);
1881
1882 #if SU_UPLEVEL_HIJACKS_RUNOPS
1883  sud->old_runops = PL_runops;
1884 #endif
1885
1886  sud->old_catch = CATCH_GET;
1887  CATCH_SET(TRUE);
1888
1889  if ((PL_op = PL_ppaddr[OP_ENTERSUB](aTHX))) {
1890   PERL_CONTEXT *sub_cx = cxstack + cxstack_ix;
1891
1892   /* If pp_entersub() returns a non-null OP, it means that the callback is not
1893    * an XSUB. */
1894
1895   sud->callback = MUTABLE_CV(SvREFCNT_inc(callback));
1896   CvDEPTH(callback)++;
1897
1898   if (CxHASARGS(cx) && cx->blk_sub.argarray) {
1899    /* The call to pp_entersub() has saved the current @_ (in XS terms,
1900     * GvAV(PL_defgv)) in the savearray member, and has created a new argarray
1901     * with what we put on the stack. But we want to fake up the same arguments
1902     * as the ones in use at the context we uplevel to, so we replace the
1903     * argarray with an unreal copy of the original @_. */
1904    AV *av = newAV();
1905    AvREAL_off(av);
1906    AvREIFY_on(av);
1907    av_extend(av, AvMAX(cx->blk_sub.argarray));
1908    AvFILLp(av) = AvFILLp(cx->blk_sub.argarray);
1909    Copy(AvARRAY(cx->blk_sub.argarray), AvARRAY(av), AvFILLp(av) + 1, SV *);
1910    sub_cx->blk_sub.argarray = av;
1911   } else {
1912    SvREFCNT_inc_simple_void(sub_cx->blk_sub.argarray);
1913   }
1914
1915   if (su_uplevel_goto_static(CvROOT(renamed))) {
1916 #if SU_UPLEVEL_HIJACKS_RUNOPS
1917    if (PL_runops != PL_runops_std) {
1918     if (PL_runops == PL_runops_dbg) {
1919      if (PL_debug)
1920       croak("uplevel() can't execute code that calls goto when debugging flags are set");
1921     } else if (PL_runops != su_uplevel_goto_runops)
1922      croak("uplevel() can't execute code that calls goto with a custom runloop");
1923    }
1924
1925    PL_runops = su_uplevel_goto_runops;
1926 #else  /* SU_UPLEVEL_HIJACKS_RUNOPS */
1927    croak("uplevel() can't execute code that calls goto before perl 5.8");
1928 #endif /* !SU_UPLEVEL_HIJACKS_RUNOPS */
1929   }
1930
1931   CALLRUNOPS(aTHX);
1932  }
1933
1934  sud->died = 0;
1935
1936  ret = PL_stack_sp - (PL_stack_base + new_mark);
1937  if (ret > 0) {
1938   AV *old_stack = sud->old_curstackinfo->si_stack;
1939
1940   if (old_mark + ret > AvMAX(old_stack)) {
1941    /* Specialized EXTEND(old_sp, ret) */
1942    av_extend(old_stack, old_mark + ret + 1);
1943    old_stack_sp = AvARRAY(old_stack) + old_mark;
1944   }
1945
1946   Copy(PL_stack_sp - ret + 1, old_stack_sp + 1, ret, SV *);
1947   PL_stack_sp        += ret;
1948   AvFILLp(old_stack) += ret;
1949  }
1950
1951  LEAVE;
1952
1953  return ret;
1954 }
1955
1956 /* --- Unique context ID --------------------------------------------------- */
1957
1958 static su_uid *su_uid_storage_fetch(pTHX_ UV depth) {
1959 #define su_uid_storage_fetch(D) su_uid_storage_fetch(aTHX_ (D))
1960  su_uid **map, *uid;
1961  STRLEN alloc;
1962  dMY_CXT;
1963
1964  map   = MY_CXT.uid_storage.map;
1965  alloc = MY_CXT.uid_storage.alloc;
1966
1967  if (depth >= alloc) {
1968   STRLEN i;
1969
1970   Renew(map, depth + 1, su_uid *);
1971   for (i = alloc; i <= depth; ++i)
1972    map[i] = NULL;
1973
1974   MY_CXT.uid_storage.map   = map;
1975   MY_CXT.uid_storage.alloc = depth + 1;
1976  }
1977
1978  uid = map[depth];
1979
1980  if (!uid) {
1981   Newx(uid, 1, su_uid);
1982   uid->seq   = 0;
1983   uid->flags = 0;
1984   map[depth] = uid;
1985  }
1986
1987  if (depth >= MY_CXT.uid_storage.used)
1988   MY_CXT.uid_storage.used = depth + 1;
1989
1990  return uid;
1991 }
1992
1993 static int su_uid_storage_check(pTHX_ UV depth, UV seq) {
1994 #define su_uid_storage_check(D, S) su_uid_storage_check(aTHX_ (D), (S))
1995  su_uid *uid;
1996  dMY_CXT;
1997
1998  if (depth >= MY_CXT.uid_storage.used)
1999   return 0;
2000
2001  uid = MY_CXT.uid_storage.map[depth];
2002
2003  return uid && (uid->seq == seq) && (uid->flags & SU_UID_ACTIVE);
2004 }
2005
2006 static void su_uid_drop(pTHX_ void *ud_) {
2007  su_uid *uid = ud_;
2008
2009  uid->flags &= ~SU_UID_ACTIVE;
2010 }
2011
2012 static void su_uid_bump(pTHX_ void *ud_) {
2013  su_ud_reap *ud  = ud_;
2014
2015  SAVEDESTRUCTOR_X(su_uid_drop, ud->cb);
2016
2017  SU_UD_FREE(ud);
2018 }
2019
2020 static SV *su_uid_get(pTHX_ I32 cxix) {
2021 #define su_uid_get(I) su_uid_get(aTHX_ (I))
2022  su_uid *uid;
2023  SV *uid_sv;
2024  UV depth;
2025
2026  depth = su_uid_depth(cxix);
2027  uid   = su_uid_storage_fetch(depth);
2028
2029  if (!(uid->flags & SU_UID_ACTIVE)) {
2030   su_ud_reap *ud;
2031
2032   uid->seq = su_uid_seq_next(depth);
2033   uid->flags |= SU_UID_ACTIVE;
2034
2035   Newx(ud, 1, su_ud_reap);
2036   SU_UD_ORIGIN(ud)  = NULL;
2037   SU_UD_TYPE(ud)    = SU_UD_TYPE_UID;
2038   ud->cb = (SV *) uid;
2039   su_init(ud, cxix, SU_SAVE_DESTRUCTOR_SIZE);
2040  }
2041
2042  uid_sv = sv_newmortal();
2043  sv_setpvf(uid_sv, "%"UVuf"-%"UVuf, depth, uid->seq);
2044  return uid_sv;
2045 }
2046
2047 #ifdef grok_number
2048
2049 #define su_grok_number(S, L, VP) grok_number((S), (L), (VP))
2050
2051 #else /* grok_number */
2052
2053 #define IS_NUMBER_IN_UV 0x1
2054
2055 static int su_grok_number(pTHX_ const char *s, STRLEN len, UV *valuep) {
2056 #define su_grok_number(S, L, VP) su_grok_number(aTHX_ (S), (L), (VP))
2057  STRLEN i;
2058  SV *tmpsv;
2059
2060  /* This crude check should be good enough for a fallback implementation.
2061   * Better be too strict than too lax. */
2062  for (i = 0; i < len; ++i) {
2063   if (!isDIGIT(s[i]))
2064    return 0;
2065  }
2066
2067  tmpsv = sv_newmortal();
2068  sv_setpvn(tmpsv, s, len);
2069  *valuep = sv_2uv(tmpsv);
2070
2071  return IS_NUMBER_IN_UV;
2072 }
2073
2074 #endif /* !grok_number */
2075
2076 static int su_uid_validate(pTHX_ SV *uid) {
2077 #define su_uid_validate(U) su_uid_validate(aTHX_ (U))
2078  const char *s;
2079  STRLEN len, p = 0;
2080  UV depth, seq;
2081  int type;
2082
2083  s = SvPV_const(uid, len);
2084
2085  while (p < len && s[p] != '-')
2086   ++p;
2087  if (p >= len)
2088   croak("UID contains only one part");
2089
2090  type = su_grok_number(s, p, &depth);
2091  if (type != IS_NUMBER_IN_UV)
2092   croak("First UID part is not an unsigned integer");
2093
2094  ++p; /* Skip '-'. As we used to have p < len, len - (p + 1) >= 0. */
2095
2096  type = su_grok_number(s + p, len - p, &seq);
2097  if (type != IS_NUMBER_IN_UV)
2098   croak("Second UID part is not an unsigned integer");
2099
2100  return su_uid_storage_check(depth, seq);
2101 }
2102
2103 /* --- Context operations -------------------------------------------------- */
2104
2105 /* Remove sequences of BLOCKs having DB for stash, followed by a SUB context
2106  * for the debugger callback. */
2107
2108 static I32 su_context_skip_db(pTHX_ I32 cxix) {
2109 #define su_context_skip_db(C) su_context_skip_db(aTHX_ (C))
2110  I32 i;
2111
2112  if (!PL_DBsub)
2113   return cxix;
2114
2115  for (i = cxix; i > 0; --i) {
2116   PERL_CONTEXT *cx = cxstack + i;
2117
2118   switch (CxTYPE(cx)) {
2119 #if SU_HAS_PERL(5, 17, 1)
2120    case CXt_LOOP_PLAIN:
2121 #endif
2122    case CXt_BLOCK:
2123     if (cx->blk_oldcop && CopSTASH(cx->blk_oldcop) == GvSTASH(PL_DBgv))
2124      continue;
2125     break;
2126    case CXt_SUB:
2127     if (cx->blk_sub.cv == GvCV(PL_DBsub)) {
2128      cxix = i - 1;
2129      continue;
2130     }
2131     break;
2132    default:
2133     break;
2134   }
2135
2136   break;
2137  }
2138
2139  return cxix;
2140 }
2141
2142
2143 static I32 su_context_normalize_up(pTHX_ I32 cxix) {
2144 #define su_context_normalize_up(C) su_context_normalize_up(aTHX_ (C))
2145  PERL_CONTEXT *cx;
2146
2147  if (cxix <= 0)
2148   return 0;
2149
2150  cx = cxstack + cxix;
2151  if (CxTYPE(cx) == CXt_BLOCK) {
2152   PERL_CONTEXT *prev = cx - 1;
2153
2154   switch (CxTYPE(prev)) {
2155 #if SU_HAS_PERL(5, 10, 0)
2156    case CXt_GIVEN:
2157    case CXt_WHEN:
2158 #endif
2159 #if SU_HAS_PERL(5, 11, 0)
2160    /* That's the only subcategory that can cause an extra BLOCK context */
2161    case CXt_LOOP_PLAIN:
2162 #else
2163    case CXt_LOOP:
2164 #endif
2165     if (cx->blk_oldcop == prev->blk_oldcop)
2166      return cxix - 1;
2167     break;
2168    case CXt_SUBST:
2169     if (cx->blk_oldcop && OpSIBLING(cx->blk_oldcop)
2170                        && OpSIBLING(cx->blk_oldcop)->op_type == OP_SUBST)
2171      return cxix - 1;
2172     break;
2173   }
2174  }
2175
2176  return cxix;
2177 }
2178
2179 static I32 su_context_normalize_down(pTHX_ I32 cxix) {
2180 #define su_context_normalize_down(C) su_context_normalize_down(aTHX_ (C))
2181  PERL_CONTEXT *next;
2182
2183  if (cxix >= cxstack_ix)
2184   return cxstack_ix;
2185
2186  next = cxstack + cxix + 1;
2187  if (CxTYPE(next) == CXt_BLOCK) {
2188   PERL_CONTEXT *cx = next - 1;
2189
2190   switch (CxTYPE(cx)) {
2191 #if SU_HAS_PERL(5, 10, 0)
2192    case CXt_GIVEN:
2193    case CXt_WHEN:
2194 #endif
2195 #if SU_HAS_PERL(5, 11, 0)
2196    /* That's the only subcategory that can cause an extra BLOCK context */
2197    case CXt_LOOP_PLAIN:
2198 #else
2199    case CXt_LOOP:
2200 #endif
2201     if (cx->blk_oldcop == next->blk_oldcop)
2202      return cxix + 1;
2203     break;
2204    case CXt_SUBST:
2205     if (next->blk_oldcop && OpSIBLING(next->blk_oldcop)
2206                          && OpSIBLING(next->blk_oldcop)->op_type == OP_SUBST)
2207      return cxix + 1;
2208     break;
2209   }
2210  }
2211
2212  return cxix;
2213 }
2214
2215 #define su_context_here() su_context_normalize_up(su_context_skip_db(cxstack_ix))
2216
2217 static I32 su_context_gimme(pTHX_ I32 cxix) {
2218 #define su_context_gimme(C) su_context_gimme(aTHX_ (C))
2219  I32 i;
2220
2221  for (i = cxix; i >= 0; --i) {
2222   PERL_CONTEXT *cx = cxstack + i;
2223
2224   switch (CxTYPE(cx)) {
2225    /* gimme is always G_ARRAY for loop contexts. */
2226 #if SU_HAS_PERL(5, 11, 0)
2227    case CXt_LOOP_FOR:
2228    case CXt_LOOP_PLAIN:
2229    case CXt_LOOP_LAZYSV:
2230    case CXt_LOOP_LAZYIV:
2231 #else
2232    case CXt_LOOP:
2233 #endif
2234    case CXt_SUBST: {
2235     const COP *cop = cx->blk_oldcop;
2236     if (cop && OpSIBLING(cop)) {
2237      switch (OpSIBLING(cop)->op_flags & OPf_WANT) {
2238       case OPf_WANT_VOID:
2239        return G_VOID;
2240       case OPf_WANT_SCALAR:
2241        return G_SCALAR;
2242       case OPf_WANT_LIST:
2243        return G_ARRAY;
2244       default:
2245        break;
2246      }
2247     }
2248     break;
2249    }
2250    default:
2251     return CxGIMME(cx);
2252     break;
2253   }
2254  }
2255
2256  return G_VOID;
2257 }
2258
2259 /* --- Global setup/teardown ----------------------------------------------- */
2260
2261 static VOL U32 su_initialized = 0;
2262
2263 static void su_global_teardown(pTHX_ void *root) {
2264  if (!su_initialized)
2265   return;
2266
2267 #if SU_MULTIPLICITY
2268  if (aTHX != root)
2269   return;
2270 #endif
2271
2272  SU_LOCK(&su_uid_seq_counter_mutex);
2273  PerlMemShared_free(su_uid_seq_counter.seqs);
2274  su_uid_seq_counter.size = 0;
2275  SU_UNLOCK(&su_uid_seq_counter_mutex);
2276
2277  MUTEX_DESTROY(&su_uid_seq_counter_mutex);
2278
2279  su_initialized = 0;
2280
2281  return;
2282 }
2283
2284 XS(XS_Scope__Upper_unwind);
2285 XS(XS_Scope__Upper_yield);
2286 XS(XS_Scope__Upper_leave);
2287
2288 #if SU_HAS_PERL(5, 9, 0)
2289 # define SU_XS_FILE_TYPE const char
2290 #else
2291 # define SU_XS_FILE_TYPE char
2292 #endif
2293
2294 static void su_global_setup(pTHX_ SU_XS_FILE_TYPE *file) {
2295 #define su_global_setup(F) su_global_setup(aTHX_ (F))
2296  HV *stash;
2297
2298  if (su_initialized)
2299   return;
2300
2301  MUTEX_INIT(&su_uid_seq_counter_mutex);
2302
2303  SU_LOCK(&su_uid_seq_counter_mutex);
2304  su_uid_seq_counter.seqs = NULL;
2305  su_uid_seq_counter.size = 0;
2306  SU_UNLOCK(&su_uid_seq_counter_mutex);
2307
2308  stash = gv_stashpv(__PACKAGE__, 1);
2309  newCONSTSUB(stash, "TOP",           newSViv(0));
2310  newCONSTSUB(stash, "SU_THREADSAFE", newSVuv(SU_THREADSAFE));
2311
2312  newXSproto("Scope::Upper::unwind", XS_Scope__Upper_unwind, file, NULL);
2313  newXSproto("Scope::Upper::yield",  XS_Scope__Upper_yield,  file, NULL);
2314  newXSproto("Scope::Upper::leave",  XS_Scope__Upper_leave,  file, NULL);
2315
2316 #if SU_MULTIPLICITY
2317  call_atexit(su_global_teardown, aTHX);
2318 #else
2319  call_atexit(su_global_teardown, NULL);
2320 #endif
2321
2322  su_initialized = 1;
2323
2324  return;
2325 }
2326
2327 /* --- Interpreter setup/teardown ------------------------------------------ */
2328
2329 static void su_local_teardown(pTHX_ void *param) {
2330  su_uplevel_ud *cur;
2331  su_uid **map;
2332  dMY_CXT;
2333
2334  map = MY_CXT.uid_storage.map;
2335  if (map) {
2336   STRLEN i;
2337   for (i = 0; i < MY_CXT.uid_storage.used; ++i)
2338    Safefree(map[i]);
2339   Safefree(map);
2340  }
2341
2342  cur = MY_CXT.uplevel_storage.root;
2343  if (cur) {
2344   su_uplevel_ud *prev;
2345   do {
2346    prev = cur;
2347    cur  = prev->next;
2348    su_uplevel_ud_delete(prev);
2349   } while (cur);
2350  }
2351
2352  return;
2353 }
2354
2355 static void su_local_setup(pTHX) {
2356 #define su_local_setup() su_local_setup(aTHX)
2357  MY_CXT_INIT;
2358
2359  MY_CXT.stack_placeholder = NULL;
2360
2361  /* NewOp() calls calloc() which just zeroes the memory with memset(). */
2362  Zero(&(MY_CXT.unwind_storage.return_op), 1, LISTOP);
2363  MY_CXT.unwind_storage.return_op.op_type   = OP_RETURN;
2364  MY_CXT.unwind_storage.return_op.op_ppaddr = PL_ppaddr[OP_RETURN];
2365
2366  Zero(&(MY_CXT.unwind_storage.proxy_op), 1, OP);
2367  MY_CXT.unwind_storage.proxy_op.op_type   = OP_STUB;
2368  MY_CXT.unwind_storage.proxy_op.op_ppaddr = NULL;
2369
2370  Zero(&(MY_CXT.yield_storage.leave_op), 1, UNOP);
2371  MY_CXT.yield_storage.leave_op.op_type   = OP_STUB;
2372  MY_CXT.yield_storage.leave_op.op_ppaddr = NULL;
2373
2374  Zero(&(MY_CXT.yield_storage.proxy_op), 1, OP);
2375  MY_CXT.yield_storage.proxy_op.op_type   = OP_STUB;
2376  MY_CXT.yield_storage.proxy_op.op_ppaddr = NULL;
2377
2378  MY_CXT.uplevel_storage.top   = NULL;
2379  MY_CXT.uplevel_storage.root  = NULL;
2380  MY_CXT.uplevel_storage.count = 0;
2381
2382  MY_CXT.uid_storage.map   = NULL;
2383  MY_CXT.uid_storage.used  = 0;
2384  MY_CXT.uid_storage.alloc = 0;
2385
2386  call_atexit(su_local_teardown, NULL);
2387
2388  return;
2389 }
2390
2391 /* --- XS ------------------------------------------------------------------ */
2392
2393 #define SU_GET_CONTEXT(A, B, D) \
2394  STMT_START {                   \
2395   if (items > A) {              \
2396    SV *csv = ST(B);             \
2397    if (!SvOK(csv))              \
2398     goto default_cx;            \
2399    cxix = SvIV(csv);            \
2400    if (cxix < 0)                \
2401     cxix = 0;                   \
2402    else if (cxix > cxstack_ix)  \
2403     goto default_cx;            \
2404   } else {                      \
2405 default_cx:                     \
2406    cxix = (D);                  \
2407   }                             \
2408  } STMT_END
2409
2410 #define SU_GET_LEVEL(A, B) \
2411  STMT_START {              \
2412   level = 0;               \
2413   if (items > 0) {         \
2414    SV *lsv = ST(B);        \
2415    if (SvOK(lsv)) {        \
2416     level = SvIV(lsv);     \
2417     if (level < 0)         \
2418      level = 0;            \
2419    }                       \
2420   }                        \
2421  } STMT_END
2422
2423 #if SU_HAS_PERL(5, 10, 0)
2424 # define SU_INFO_COUNT 11
2425 #else
2426 # define SU_INFO_COUNT 10
2427 #endif
2428
2429 XS(XS_Scope__Upper_unwind) {
2430 #ifdef dVAR
2431  dVAR; dXSARGS;
2432 #else
2433  dXSARGS;
2434 #endif
2435  dMY_CXT;
2436  I32 cxix;
2437
2438  PERL_UNUSED_VAR(cv); /* -W */
2439  PERL_UNUSED_VAR(ax); /* -Wall */
2440
2441  SU_GET_CONTEXT(0, items - 1, cxstack_ix);
2442  do {
2443   PERL_CONTEXT *cx = cxstack + cxix;
2444   switch (CxTYPE(cx)) {
2445    case CXt_SUB:
2446     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2447      continue;
2448    case CXt_EVAL:
2449    case CXt_FORMAT:
2450     MY_CXT.unwind_storage.cxix   = cxix;
2451     MY_CXT.unwind_storage.items  = items;
2452     MY_CXT.unwind_storage.savesp = PL_stack_sp;
2453     if (items > 0) {
2454      MY_CXT.unwind_storage.items--;
2455      MY_CXT.unwind_storage.savesp--;
2456     }
2457     /* pp_entersub will want to sanitize the stack after returning from there
2458      * Screw that, we're insane!
2459      * dXSARGS calls POPMARK, so we need to match PL_markstack_ptr[1] */
2460     if (GIMME_V == G_SCALAR)
2461      PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
2462     SAVEDESTRUCTOR_X(su_unwind, NULL);
2463     return;
2464    default:
2465     break;
2466   }
2467  } while (--cxix >= 0);
2468  croak("Can't return outside a subroutine");
2469 }
2470
2471 static const char su_yield_name[] = "yield";
2472
2473 XS(XS_Scope__Upper_yield) {
2474 #ifdef dVAR
2475  dVAR; dXSARGS;
2476 #else
2477  dXSARGS;
2478 #endif
2479  dMY_CXT;
2480  I32 cxix;
2481
2482  PERL_UNUSED_VAR(cv); /* -W */
2483  PERL_UNUSED_VAR(ax); /* -Wall */
2484
2485  SU_GET_CONTEXT(0, items - 1, su_context_here());
2486  MY_CXT.yield_storage.cxix   = cxix;
2487  MY_CXT.yield_storage.items  = items;
2488  MY_CXT.yield_storage.savesp = PL_stack_sp;
2489  if (items > 0) {
2490   MY_CXT.yield_storage.items--;
2491   MY_CXT.yield_storage.savesp--;
2492  }
2493  /* See XS_Scope__Upper_unwind */
2494  if (GIMME_V == G_SCALAR)
2495   PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
2496  SAVEDESTRUCTOR_X(su_yield, su_yield_name);
2497  return;
2498 }
2499
2500 static const char su_leave_name[] = "leave";
2501
2502 XS(XS_Scope__Upper_leave) {
2503 #ifdef dVAR
2504  dVAR; dXSARGS;
2505 #else
2506  dXSARGS;
2507 #endif
2508  dMY_CXT;
2509
2510  PERL_UNUSED_VAR(cv); /* -W */
2511  PERL_UNUSED_VAR(ax); /* -Wall */
2512
2513  MY_CXT.yield_storage.cxix   = su_context_here();
2514  MY_CXT.yield_storage.items  = items;
2515  MY_CXT.yield_storage.savesp = PL_stack_sp;
2516  /* See XS_Scope__Upper_unwind */
2517  if (GIMME_V == G_SCALAR)
2518   PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
2519  SAVEDESTRUCTOR_X(su_yield, su_leave_name);
2520  return;
2521 }
2522
2523 MODULE = Scope::Upper            PACKAGE = Scope::Upper
2524
2525 PROTOTYPES: ENABLE
2526
2527 BOOT:
2528 {
2529  su_global_setup(file);
2530  su_local_setup();
2531 }
2532
2533 #if SU_THREADSAFE
2534
2535 void
2536 CLONE(...)
2537 PROTOTYPE: DISABLE
2538 PREINIT:
2539  su_uid_storage new_cxt;
2540 PPCODE:
2541  {
2542   dMY_CXT;
2543   new_cxt.map   = NULL;
2544   new_cxt.used  = 0;
2545   new_cxt.alloc = 0;
2546   su_uid_storage_dup(&new_cxt, &MY_CXT.uid_storage, MY_CXT.uid_storage.used);
2547  }
2548  {
2549   MY_CXT_CLONE;
2550   MY_CXT.uplevel_storage.top   = NULL;
2551   MY_CXT.uplevel_storage.root  = NULL;
2552   MY_CXT.uplevel_storage.count = 0;
2553   MY_CXT.uid_storage           = new_cxt;
2554  }
2555  XSRETURN(0);
2556
2557 #endif /* SU_THREADSAFE */
2558
2559 void
2560 HERE()
2561 PROTOTYPE:
2562 PREINIT:
2563  I32 cxix;
2564 PPCODE:
2565  cxix = su_context_here();
2566  EXTEND(SP, 1);
2567  mPUSHi(cxix);
2568  XSRETURN(1);
2569
2570 void
2571 UP(...)
2572 PROTOTYPE: ;$
2573 PREINIT:
2574  I32 cxix;
2575 PPCODE:
2576  SU_GET_CONTEXT(0, 0, su_context_here());
2577  if (cxix > 0) {
2578   --cxix;
2579   cxix = su_context_skip_db(cxix);
2580   cxix = su_context_normalize_up(cxix);
2581  }
2582  EXTEND(SP, 1);
2583  mPUSHi(cxix);
2584  XSRETURN(1);
2585
2586 void
2587 SUB(...)
2588 PROTOTYPE: ;$
2589 PREINIT:
2590  I32 cxix;
2591 PPCODE:
2592  SU_GET_CONTEXT(0, 0, cxstack_ix);
2593  EXTEND(SP, 1);
2594  for (; cxix >= 0; --cxix) {
2595   PERL_CONTEXT *cx = cxstack + cxix;
2596   switch (CxTYPE(cx)) {
2597    default:
2598     continue;
2599    case CXt_SUB:
2600     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2601      continue;
2602     mPUSHi(cxix);
2603     XSRETURN(1);
2604   }
2605  }
2606  XSRETURN_UNDEF;
2607
2608 void
2609 EVAL(...)
2610 PROTOTYPE: ;$
2611 PREINIT:
2612  I32 cxix;
2613 PPCODE:
2614  SU_GET_CONTEXT(0, 0, cxstack_ix);
2615  EXTEND(SP, 1);
2616  for (; cxix >= 0; --cxix) {
2617   PERL_CONTEXT *cx = cxstack + cxix;
2618   switch (CxTYPE(cx)) {
2619    default:
2620     continue;
2621    case CXt_EVAL:
2622     mPUSHi(cxix);
2623     XSRETURN(1);
2624   }
2625  }
2626  XSRETURN_UNDEF;
2627
2628 void
2629 SCOPE(...)
2630 PROTOTYPE: ;$
2631 PREINIT:
2632  I32 cxix, level;
2633 PPCODE:
2634  SU_GET_LEVEL(0, 0);
2635  cxix = su_context_here();
2636  while (--level >= 0) {
2637   if (cxix <= 0)
2638    break;
2639   --cxix;
2640   cxix = su_context_skip_db(cxix);
2641   cxix = su_context_normalize_up(cxix);
2642  }
2643  EXTEND(SP, 1);
2644  mPUSHi(cxix);
2645  XSRETURN(1);
2646
2647 void
2648 CALLER(...)
2649 PROTOTYPE: ;$
2650 PREINIT:
2651  I32 cxix, level;
2652 PPCODE:
2653  SU_GET_LEVEL(0, 0);
2654  for (cxix = cxstack_ix; cxix > 0; --cxix) {
2655   PERL_CONTEXT *cx = cxstack + cxix;
2656   switch (CxTYPE(cx)) {
2657    case CXt_SUB:
2658     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2659      continue;
2660    case CXt_EVAL:
2661    case CXt_FORMAT:
2662     if (--level < 0)
2663      goto done;
2664     break;
2665   }
2666  }
2667 done:
2668  EXTEND(SP, 1);
2669  mPUSHi(cxix);
2670  XSRETURN(1);
2671
2672 void
2673 want_at(...)
2674 PROTOTYPE: ;$
2675 PREINIT:
2676  I32 cxix;
2677 PPCODE:
2678  SU_GET_CONTEXT(0, 0, cxstack_ix);
2679  EXTEND(SP, 1);
2680  while (cxix > 0) {
2681   PERL_CONTEXT *cx = cxstack + cxix--;
2682   switch (CxTYPE(cx)) {
2683    case CXt_SUB:
2684     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2685      continue;
2686    case CXt_EVAL:
2687    case CXt_FORMAT: {
2688     I32 gimme = cx->blk_gimme;
2689     switch (gimme) {
2690      case G_VOID:   XSRETURN_UNDEF; break;
2691      case G_SCALAR: XSRETURN_NO;    break;
2692      case G_ARRAY:  XSRETURN_YES;   break;
2693     }
2694     break;
2695    }
2696   }
2697  }
2698  XSRETURN_UNDEF;
2699
2700 void
2701 context_info(...)
2702 PROTOTYPE: ;$
2703 PREINIT:
2704  I32 cxix;
2705  const PERL_CONTEXT *cx, *dbcx;
2706  COP *cop;
2707 PPCODE:
2708  SU_GET_CONTEXT(0, 0, su_context_skip_db(cxstack_ix));
2709  cxix = su_context_normalize_up(cxix);
2710  cx   = cxstack + cxix;
2711  dbcx = cx;
2712  if (PL_DBsub && cxix && (CxTYPE(cx) == CXt_SUB || CxTYPE(cx) == CXt_FORMAT)) {
2713   I32 i = su_context_skip_db(cxix - 1) + 1;
2714   if (i < cxix && CxTYPE(cxstack + i) == CXt_SUB)
2715    cx = cxstack + i;
2716  }
2717  cop  = cx->blk_oldcop;
2718  EXTEND(SP, SU_INFO_COUNT);
2719  /* stash (0) */
2720  {
2721   HV *stash = CopSTASH(cop);
2722   if (stash)
2723    PUSHs(su_newmortal_pvn(HvNAME(stash), HvNAMELEN(stash)));
2724   else
2725    PUSHs(&PL_sv_undef);
2726  }
2727  /* file (1) */
2728  PUSHs(su_newmortal_pvn(OutCopFILE(cop), OutCopFILE_len(cop)));
2729  /* line (2) */
2730  mPUSHi(CopLINE(cop));
2731  /* subroutine (3) and has_args (4) */
2732  switch (CxTYPE(cx)) {
2733   case CXt_SUB:
2734   case CXt_FORMAT: {
2735    GV *cvgv = CvGV(dbcx->blk_sub.cv);
2736    if (cvgv && isGV(cvgv)) {
2737     SV *sv = sv_newmortal();
2738     gv_efullname3(sv, cvgv, NULL);
2739     PUSHs(sv);
2740    } else {
2741     PUSHs(su_newmortal_pvs("(unknown)"));
2742    }
2743    if (CxHASARGS(cx))
2744     PUSHs(&PL_sv_yes);
2745    else
2746     PUSHs(&PL_sv_no);
2747    break;
2748   }
2749   case CXt_EVAL:
2750    PUSHs(su_newmortal_pvs("(eval)"));
2751    mPUSHi(0);
2752    break;
2753   default:
2754    PUSHs(&PL_sv_undef);
2755    PUSHs(&PL_sv_undef);
2756  }
2757  /* gimme (5) */
2758  switch (su_context_gimme(cxix)) {
2759   case G_ARRAY:
2760    PUSHs(&PL_sv_yes);
2761    break;
2762   case G_SCALAR:
2763    PUSHs(&PL_sv_no);
2764    break;
2765   default: /* G_VOID */
2766    PUSHs(&PL_sv_undef);
2767    break;
2768  }
2769  /* eval text (6) and is_require (7) */
2770  switch (CxTYPE(cx)) {
2771   case CXt_EVAL:
2772    if (CxOLD_OP_TYPE(cx) == OP_ENTEREVAL) {
2773     /* eval STRING */
2774 #if SU_HAS_PERL(5, 17, 4)
2775     PUSHs(newSVpvn_flags(SvPVX(cx->blk_eval.cur_text),
2776                          SvCUR(cx->blk_eval.cur_text)-2,
2777                          SvUTF8(cx->blk_eval.cur_text)|SVs_TEMP));
2778 #else
2779     PUSHs(cx->blk_eval.cur_text);
2780 #endif
2781     PUSHs(&PL_sv_no);
2782     break;
2783    } else if (cx->blk_eval.old_namesv) {
2784     /* require */
2785     PUSHs(sv_mortalcopy(cx->blk_eval.old_namesv));
2786     PUSHs(&PL_sv_yes);
2787     break;
2788    }
2789    /* FALLTHROUGH */
2790   default:
2791    /* Anything else including eval BLOCK */
2792    PUSHs(&PL_sv_undef);
2793    PUSHs(&PL_sv_undef);
2794    break;
2795  }
2796  /* hints (8) */
2797  mPUSHi(CopHINTS_get(cop));
2798  /* warnings (9) */
2799  {
2800   SV *mask = NULL;
2801 #if SU_HAS_PERL(5, 9, 4)
2802   STRLEN *old_warnings = cop->cop_warnings;
2803 #else
2804   SV *old_warnings = cop->cop_warnings;
2805 #endif
2806   if (old_warnings == pWARN_STD) {
2807    if (PL_dowarn & G_WARN_ON)
2808     goto context_info_warnings_on;
2809    else
2810 #if SU_HAS_PERL(5, 17, 4)
2811     mask = &PL_sv_undef;
2812 #else
2813     goto context_info_warnings_off;
2814 #endif
2815   } else if (old_warnings == pWARN_NONE) {
2816 #if !SU_HAS_PERL(5, 17, 4)
2817 context_info_warnings_off:
2818 #endif
2819    mask = su_newmortal_pvn(WARN_NONEstring, WARNsize);
2820   } else if (old_warnings == pWARN_ALL) {
2821    HV *bits;
2822 context_info_warnings_on:
2823 #if SU_HAS_PERL(5, 8, 7)
2824    bits = get_hv("warnings::Bits", 0);
2825    if (bits) {
2826     SV **bits_all = hv_fetchs(bits, "all", FALSE);
2827     if (bits_all)
2828      mask = sv_mortalcopy(*bits_all);
2829    }
2830 #endif
2831    if (!mask)
2832     mask = su_newmortal_pvn(WARN_ALLstring, WARNsize);
2833   } else {
2834 #if SU_HAS_PERL(5, 9, 4)
2835    mask = su_newmortal_pvn((char *) (old_warnings + 1), old_warnings[0]);
2836 #else
2837    mask = sv_mortalcopy(old_warnings);
2838 #endif
2839   }
2840   PUSHs(mask);
2841  }
2842 #if SU_HAS_PERL(5, 10, 0)
2843  /* hints hash (10) */
2844  {
2845   COPHH *hints_hash = CopHINTHASH_get(cop);
2846   if (hints_hash) {
2847    SV *rhv = sv_2mortal(newRV_noinc((SV *) cophh_2hv(hints_hash, 0)));
2848    PUSHs(rhv);
2849   } else {
2850    PUSHs(&PL_sv_undef);
2851   }
2852  }
2853 #endif
2854  XSRETURN(SU_INFO_COUNT);
2855
2856 void
2857 reap(SV *hook, ...)
2858 PROTOTYPE: &;$
2859 PREINIT:
2860  I32 cxix;
2861  su_ud_reap *ud;
2862 CODE:
2863  SU_GET_CONTEXT(1, 1, su_context_skip_db(cxstack_ix));
2864  cxix = su_context_normalize_down(cxix);
2865  Newx(ud, 1, su_ud_reap);
2866  SU_UD_ORIGIN(ud) = NULL;
2867  SU_UD_TYPE(ud)   = SU_UD_TYPE_REAP;
2868  ud->cb = newSVsv(hook);
2869  su_init(ud, cxix, SU_SAVE_DESTRUCTOR_SIZE);
2870
2871 void
2872 localize(SV *sv, SV *val, ...)
2873 PROTOTYPE: $$;$
2874 PREINIT:
2875  I32 cxix;
2876  I32 size;
2877  su_ud_localize *ud;
2878 CODE:
2879  SU_GET_CONTEXT(2, 2, su_context_skip_db(cxstack_ix));
2880  cxix = su_context_normalize_down(cxix);
2881  Newx(ud, 1, su_ud_localize);
2882  SU_UD_ORIGIN(ud) = NULL;
2883  SU_UD_TYPE(ud)   = SU_UD_TYPE_LOCALIZE;
2884  size = su_ud_localize_init(ud, sv, val, NULL);
2885  su_init(ud, cxix, size);
2886
2887 void
2888 localize_elem(SV *sv, SV *elem, SV *val, ...)
2889 PROTOTYPE: $$$;$
2890 PREINIT:
2891  I32 cxix;
2892  I32 size;
2893  su_ud_localize *ud;
2894 CODE:
2895  if (SvTYPE(sv) >= SVt_PVGV)
2896   croak("Can't infer the element localization type from a glob and the value");
2897  SU_GET_CONTEXT(3, 3, su_context_skip_db(cxstack_ix));
2898  cxix = su_context_normalize_down(cxix);
2899  Newx(ud, 1, su_ud_localize);
2900  SU_UD_ORIGIN(ud) = NULL;
2901  SU_UD_TYPE(ud)   = SU_UD_TYPE_LOCALIZE;
2902  size = su_ud_localize_init(ud, sv, val, elem);
2903  if (SU_UD_PRIVATE(ud) != SVt_PVAV && SU_UD_PRIVATE(ud) != SVt_PVHV) {
2904   SU_UD_LOCALIZE_FREE(ud);
2905   croak("Can't localize an element of something that isn't an array or a hash");
2906  }
2907  su_init(ud, cxix, size);
2908
2909 void
2910 localize_delete(SV *sv, SV *elem, ...)
2911 PROTOTYPE: $$;$
2912 PREINIT:
2913  I32 cxix;
2914  I32 size;
2915  su_ud_localize *ud;
2916 CODE:
2917  SU_GET_CONTEXT(2, 2, su_context_skip_db(cxstack_ix));
2918  cxix = su_context_normalize_down(cxix);
2919  Newx(ud, 1, su_ud_localize);
2920  SU_UD_ORIGIN(ud) = NULL;
2921  SU_UD_TYPE(ud)   = SU_UD_TYPE_LOCALIZE;
2922  size = su_ud_localize_init(ud, sv, NULL, elem);
2923  su_init(ud, cxix, size);
2924
2925 void
2926 uplevel(SV *code, ...)
2927 PROTOTYPE: &@
2928 PREINIT:
2929  I32 cxix, ret, args = 0;
2930 PPCODE:
2931  if (SvROK(code))
2932   code = SvRV(code);
2933  if (SvTYPE(code) < SVt_PVCV)
2934   croak("First argument to uplevel must be a code reference");
2935  SU_GET_CONTEXT(1, items - 1, cxstack_ix);
2936  do {
2937   PERL_CONTEXT *cx = cxstack + cxix;
2938   switch (CxTYPE(cx)) {
2939    case CXt_EVAL:
2940     croak("Can't uplevel to an eval frame");
2941    case CXt_FORMAT:
2942     croak("Can't uplevel to a format frame");
2943    case CXt_SUB:
2944     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2945      continue;
2946     if (items > 1) {
2947      PL_stack_sp--;
2948      args = items - 2;
2949     }
2950     /* su_uplevel() takes care of extending the stack if needed. */
2951     ret = su_uplevel((CV *) code, cxix, args);
2952     XSRETURN(ret);
2953    default:
2954     break;
2955   }
2956  } while (--cxix >= 0);
2957  croak("Can't uplevel outside a subroutine");
2958
2959 void
2960 uid(...)
2961 PROTOTYPE: ;$
2962 PREINIT:
2963  I32 cxix;
2964  SV *uid;
2965 PPCODE:
2966  SU_GET_CONTEXT(0, 0, su_context_here());
2967  uid = su_uid_get(cxix);
2968  EXTEND(SP, 1);
2969  PUSHs(uid);
2970  XSRETURN(1);
2971
2972 void
2973 validate_uid(SV *uid)
2974 PROTOTYPE: $
2975 PREINIT:
2976  SV *ret;
2977 PPCODE:
2978  ret = su_uid_validate(uid) ? &PL_sv_yes : &PL_sv_no;
2979  EXTEND(SP, 1);
2980  PUSHs(ret);
2981  XSRETURN(1);