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 static void su_reap(pTHX_ void *ud) {
 808 #define su_reap(U) su_reap(aTHX_ (U))
 809  SU_D({
 810   PerlIO_printf(Perl_debug_log,
 811                 "%p: === reap\n%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
 812                  ud, ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
 813  });
 814
 815  SAVEDESTRUCTOR_X(su_call, ud);
 816 }
 817
 818 /* ... Localize & localize array/hash element .............................. */
 819
 820 typedef struct {
 821  su_ud_common ci;
 822  SV    *sv;
 823  SV    *val;
 824  SV    *elem;
 825 } su_ud_localize;
 826
 827 #define SU_UD_LOCALIZE_FREE(U) STMT_START { \
 828  SvREFCNT_dec((U)->elem); \
 829  SvREFCNT_dec((U)->val);  \
 830  SvREFCNT_dec((U)->sv);   \
 831  SU_UD_FREE(U);           \
 832 } STMT_END
 833
 834 static I32 su_ud_localize_init(pTHX_ su_ud_localize *ud, SV *sv, SV *val, SV *elem) {
 835 #define su_ud_localize_init(UD, S, V, E) su_ud_localize_init(aTHX_ (UD), (S), (V), (E))
 836  UV deref = 0;
 837  svtype t = SVt_NULL;
 838  I32 size;
 839
 840  SvREFCNT_inc_simple_void(sv);
 841
 842  if (SvTYPE(sv) >= SVt_PVGV) {
 843   if (!val || !SvROK(val)) { /* local *x; or local *x = $val; */
 844    t = SVt_PVGV;
 845   } else {                   /* local *x = \$val; */
 846    t = SvTYPE(SvRV(val));
 847    deref = 1;
 848   }
 849  } else if (SvROK(sv)) {
 850   croak("Invalid %s reference as the localization target",
 851                  sv_reftype(SvRV(sv), 0));
 852  } else {
 853   STRLEN len, l;
 854   const char *p = SvPV_const(sv, len), *s;
 855   for (s = p, l = len; l > 0 && isSPACE(*s); ++s, --l) { }
 856   if (!l) {
 857    l = len;
 858    s = p;
 859   }
 860   switch (*s) {
 861    case '$': t = SVt_PV;   break;
 862    case '@': t = SVt_PVAV; break;
 863    case '%': t = SVt_PVHV; break;
 864    case '&': t = SVt_PVCV; break;
 865    case '*': t = SVt_PVGV; break;
 866   }
 867   if (t != SVt_NULL) {
 868    ++s;
 869    --l;
 870   } else if (val) { /* t == SVt_NULL, type can't be inferred from the sigil */
 871    if (SvROK(val) && !sv_isobject(val)) {
 872     t = SvTYPE(SvRV(val));
 873     deref = 1;
 874    } else {
 875     t = SvTYPE(val);
 876    }
 877   }
 878   SvREFCNT_dec(sv);
 879   sv = newSVpvn(s, l);
 880  }
 881
 882  switch (t) {
 883   case SVt_PVAV:
 884    size  = elem ? SU_SAVE_AELEM_OR_ADELETE_SIZE
 885                 : SU_SAVE_ARY_SIZE;
 886    deref = 0;
 887    break;
 888   case SVt_PVHV:
 889    size  = elem ? SU_SAVE_HELEM_OR_HDELETE_SIZE
 890                 : SU_SAVE_HASH_SIZE;
 891    deref = 0;
 892    break;
 893   case SVt_PVGV:
 894    size  = SU_SAVE_GP_SIZE;
 895    deref = 0;
 896    break;
 897   case SVt_PVCV:
 898    size  = SU_SAVE_GVCV_SIZE;
 899    deref = 0;
 900    break;
 901   default:
 902    size = SU_SAVE_SCALAR_SIZE;
 903    break;
 904  }
 905  /* When deref is set, val isn't NULL */
 906
 907  SU_UD_PRIVATE(ud) = t;
 908
 909  ud->sv   = sv;
 910  ud->val  = val ? newSVsv(deref ? SvRV(val) : val) : NULL;
 911  ud->elem = SvREFCNT_inc(elem);
 912
 913  return size;
 914 }
 915
 916 static void su_localize(pTHX_ void *ud_) {
 917 #define su_localize(U) su_localize(aTHX_ (U))
 918  su_ud_localize *ud = (su_ud_localize *) ud_;
 919  SV *sv   = ud->sv;
 920  SV *val  = ud->val;
 921  SV *elem = ud->elem;
 922  svtype t = SU_UD_PRIVATE(ud);
 923  GV *gv;
 924
 925  if (SvTYPE(sv) >= SVt_PVGV) {
 926   gv = (GV *) sv;
 927  } else {
 928 #ifdef gv_fetchsv
 929   gv = gv_fetchsv(sv, GV_ADDMULTI, t);
 930 #else
 931   STRLEN len;
 932   const char *name = SvPV_const(sv, len);
 933   gv = gv_fetchpvn_flags(name, len, GV_ADDMULTI, t);
 934 #endif
 935  }
 936
 937  SU_D({
 938   SV *z = newSV(0);
 939   SvUPGRADE(z, t);
 940   PerlIO_printf(Perl_debug_log, "%p: === localize a %s\n",ud, sv_reftype(z, 0));
 941   PerlIO_printf(Perl_debug_log,
 942                 "%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
 943                  ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
 944   SvREFCNT_dec(z);
 945  });
 946
 947  /* Inspired from Alias.pm */
 948  switch (t) {
 949   case SVt_PVAV:
 950    if (elem) {
 951     su_save_aelem(GvAV(gv), elem, val);
 952     goto done;
 953    } else
 954     save_ary(gv);
 955    break;
 956   case SVt_PVHV:
 957    if (elem) {
 958     su_save_helem(GvHV(gv), elem, val);
 959     goto done;
 960    } else
 961     save_hash(gv);
 962    break;
 963   case SVt_PVGV:
 964    save_gp(gv, 1); /* hide previous entry in symtab */
 965    break;
 966   case SVt_PVCV:
 967    su_save_gvcv(gv);
 968    break;
 969   default:
 970    gv = (GV *) save_scalar(gv);
 971    break;
 972  }
 973
 974  if (val)
 975   SvSetMagicSV((SV *) gv, val);
 976
 977 done:
 978  SU_UD_LOCALIZE_FREE(ud);
 979 }
 980
 981 /* --- Pop a context back -------------------------------------------------- */
 982
 983 #ifdef DEBUGGING
 984 # define SU_CXNAME(C) PL_block_type[CxTYPE(C)]
 985 #else
 986 # if SU_HAS_PERL(5, 11, 0)
 987 static const char *su_block_type[] = {
 988  "NULL",
 989  "WHEN",
 990  "BLOCK",
 991  "GIVEN",
 992  "LOOP_FOR",
 993  "LOOP_PLAIN",
 994  "LOOP_LAZYSV",
 995  "LOOP_LAZYIV",
 996  "SUB",
 997  "FORMAT",
 998  "EVAL",
 999  "SUBST"
1000 };
1001 # elif SU_HAS_PERL(5, 9, 3)
1002 static const char *su_block_type[] = {
1003  "NULL",
1004  "SUB",
1005  "EVAL",
1006  "WHEN",
1007  "SUBST",
1008  "BLOCK",
1009  "FORMAT",
1010  "GIVEN",
1011  "LOOP_FOR",
1012  "LOOP_PLAIN",
1013  "LOOP_LAZYSV",
1014  "LOOP_LAZYIV"
1015 };
1016 # else
1017 static const char *su_block_type[] = {
1018  "NULL",
1019  "SUB",
1020  "EVAL",
1021  "LOOP",
1022  "SUBST",
1023  "BLOCK"
1024 };
1025 # endif
1026 # define SU_CXNAME(C) su_block_type[CxTYPE(C)]
1027 #endif
1028
1029 static void su_uid_bump(pTHX_ void *);
1030
1031 static void (*su_handler[])(pTHX_ void *) = {
1032  su_reap,
1033  su_localize,
1034  su_uid_bump
1035 };
1036
1037 static void su_pop(pTHX_ void *ud) {
1038 #define su_pop(U) su_pop(aTHX_ (U))
1039  I32 depth, base, mark, *origin;
1040  depth = SU_UD_DEPTH(ud);
1041
1042  SU_D(
1043   PerlIO_printf(Perl_debug_log,
1044    "%p: --- pop a %s\n"
1045    "%p: leave scope     at depth=%2d scope_ix=%2d cur_top=%2d cur_base=%2d\n",
1046     ud, SU_CXNAME(cxstack + cxstack_ix),
1047     ud, depth, PL_scopestack_ix,PL_savestack_ix,PL_scopestack[PL_scopestack_ix])
1048  );
1049
1050  origin = SU_UD_ORIGIN(ud);
1051  mark   = origin[depth];
1052  base   = origin[depth - 1];
1053
1054  SU_D(PerlIO_printf(Perl_debug_log,
1055                     "%p: original scope was %*c top=%2d     base=%2d\n",
1056                      ud,                24, ' ',    mark,        base));
1057
1058  if (base < mark) {
1059 #if SU_HAS_PERL(5, 19, 4)
1060   I32 save = -1;
1061   PERL_CONTEXT *cx;
1062 #endif
1063
1064   SU_D(PerlIO_printf(Perl_debug_log, "%p: clear leftovers\n", ud));
1065
1066 #if SU_HAS_PERL(5, 19, 4)
1067   cx = cxstack + cxstack_ix;
1068   if (CxTYPE(cx) == CXt_SUB || CxTYPE(cx) == CXt_FORMAT)
1069    save = PL_scopestack[cx->blk_oldscopesp - 1];
1070 #endif
1071
1072   PL_savestack_ix = mark;
1073   leave_scope(base);
1074
1075 #if SU_HAS_PERL(5, 19, 4)
1076   if (CxTYPE(cx) == CXt_SUB || CxTYPE(cx) == CXt_FORMAT)
1077    PL_scopestack[cx->blk_oldscopesp - 1] = save;
1078 #endif
1079  }
1080  PL_savestack_ix = base;
1081
1082  SU_UD_DEPTH(ud) = --depth;
1083
1084  if (depth > 0) {
1085   U8 pad;
1086
1087   if ((pad = SU_UD_PAD(ud)) > 0) {
1088    dMY_CXT;
1089    do {
1090     SU_D(PerlIO_printf(Perl_debug_log,
1091           "%p: push a pad slot at depth=%2d scope_ix=%2d save_ix=%2d\n",
1092            ud,                       depth, PL_scopestack_ix, PL_savestack_ix));
1093     SU_SAVE_PLACEHOLDER();
1094    } while (--pad);
1095   }
1096
1097   SU_D(PerlIO_printf(Perl_debug_log,
1098           "%p: push destructor at depth=%2d scope_ix=%2d save_ix=%2d\n",
1099            ud,                       depth, PL_scopestack_ix, PL_savestack_ix));
1100   SAVEDESTRUCTOR_X(su_pop, ud);
1101  } else {
1102   su_handler[SU_UD_TYPE(ud)](aTHX_ ud);
1103  }
1104
1105  SU_D(PerlIO_printf(Perl_debug_log,
1106                     "%p: --- end pop: cur_top=%2d == cur_base=%2d\n",
1107                      ud, PL_savestack_ix, PL_scopestack[PL_scopestack_ix]));
1108 }
1109
1110 /* --- Initialize the stack and the action userdata ------------------------ */
1111
1112 static I32 su_init(pTHX_ void *ud, I32 cxix, I32 size) {
1113 #define su_init(U, C, S) su_init(aTHX_ (U), (C), (S))
1114  I32 i, depth, offset, base, *origin;
1115  U8 pad;
1116
1117  SU_D(PerlIO_printf(Perl_debug_log, "%p: ### init for cx %d\n", ud, cxix));
1118
1119  if (size <= SU_SAVE_DESTRUCTOR_SIZE)
1120   pad = 0;
1121  else {
1122   I32 extra = size - SU_SAVE_DESTRUCTOR_SIZE;
1123   pad = extra / SU_SAVE_PLACEHOLDER_SIZE;
1124   if (extra % SU_SAVE_PLACEHOLDER_SIZE)
1125    ++pad;
1126  }
1127  offset = SU_SAVE_DESTRUCTOR_SIZE + SU_SAVE_PLACEHOLDER_SIZE * pad;
1128
1129  SU_D(PerlIO_printf(Perl_debug_log, "%p: size=%d pad=%d offset=%d\n",
1130                                      ud,    size,   pad,   offset));
1131
1132  depth = PL_scopestack_ix - cxstack[cxix].blk_oldscopesp;
1133  SU_D(PerlIO_printf(Perl_debug_log, "%p: going down to depth %d\n", ud, depth));
1134
1135  Newx(origin, depth + 1, I32);
1136  base = PL_scopestack_ix - depth;
1137  origin[0] = PL_scopestack[base];
1138  PL_scopestack[base] += size;
1139  for (i = 1; i < depth; ++i) {
1140   I32 j = i + base;
1141   origin[i] = PL_scopestack[j];
1142   PL_scopestack[j] += offset;
1143  }
1144  origin[depth] = PL_savestack_ix;
1145
1146  SU_UD_PAD(ud)    = pad;
1147  SU_UD_DEPTH(ud)  = depth;
1148  SU_UD_ORIGIN(ud) = origin;
1149
1150  /* Make sure the first destructor fires by pushing enough fake slots on the
1151   * stack. */
1152  if (PL_savestack_ix + SU_SAVE_DESTRUCTOR_SIZE
1153                                        <= PL_scopestack[PL_scopestack_ix - 1]) {
1154   dMY_CXT;
1155   do {
1156    SU_D(PerlIO_printf(Perl_debug_log,
1157                   "%p: push a fake slot      at scope_ix=%2d  save_ix=%2d\n",
1158                    ud,                      PL_scopestack_ix, PL_savestack_ix));
1159    SU_SAVE_PLACEHOLDER();
1160   } while (PL_savestack_ix + SU_SAVE_DESTRUCTOR_SIZE
1161                                         <= PL_scopestack[PL_scopestack_ix - 1]);
1162  }
1163  SU_D(PerlIO_printf(Perl_debug_log,
1164                   "%p: push first destructor at scope_ix=%2d  save_ix=%2d\n",
1165                    ud,                      PL_scopestack_ix, PL_savestack_ix));
1166  SAVEDESTRUCTOR_X(su_pop, ud);
1167
1168  SU_D({
1169   for (i = 0; i <= depth; ++i) {
1170    I32 j = PL_scopestack_ix  - i;
1171    PerlIO_printf(Perl_debug_log,
1172                  "%p: depth=%2d scope_ix=%2d saved_floor=%2d new_floor=%2d\n",
1173                   ud,        i, j, origin[depth - i],
1174                                    i == 0 ? PL_savestack_ix : PL_scopestack[j]);
1175   }
1176  });
1177
1178  return depth;
1179 }
1180
1181 /* --- Unwind stack -------------------------------------------------------- */
1182
1183 static void su_unwind(pTHX_ void *ud_) {
1184  dMY_CXT;
1185  I32 cxix  = MY_CXT.unwind_storage.cxix;
1186  I32 items = MY_CXT.unwind_storage.items;
1187  I32 mark;
1188
1189  PERL_UNUSED_VAR(ud_);
1190
1191  PL_stack_sp = MY_CXT.unwind_storage.savesp;
1192 #if SU_HAS_PERL(5, 19, 4)
1193  {
1194   I32 i;
1195   SV **sp = PL_stack_sp;
1196   for (i = -items + 1; i <= 0; ++i)
1197    if (!SvTEMP(sp[i]))
1198     sv_2mortal(SvREFCNT_inc(sp[i]));
1199  }
1200 #endif
1201
1202  if (cxstack_ix > cxix)
1203   dounwind(cxix);
1204
1205  mark = PL_markstack[cxstack[cxix].blk_oldmarksp];
1206  *PL_markstack_ptr = PL_stack_sp - PL_stack_base - items;
1207
1208  SU_D({
1209   I32 gimme = GIMME_V;
1210   PerlIO_printf(Perl_debug_log,
1211                 "%p: cx=%d gimme=%s items=%d sp=%d oldmark=%d mark=%d\n",
1212                 &MY_CXT, cxix,
1213                 gimme == G_VOID ? "void" : gimme == G_ARRAY ? "list" : "scalar",
1214                 items, PL_stack_sp - PL_stack_base, *PL_markstack_ptr, mark);
1215  });
1216
1217  PL_op = (OP *) &(MY_CXT.unwind_storage.return_op);
1218  PL_op = PL_op->op_ppaddr(aTHX);
1219
1220  *PL_markstack_ptr = mark;
1221
1222  MY_CXT.unwind_storage.proxy_op.op_next = PL_op;
1223  PL_op = &(MY_CXT.unwind_storage.proxy_op);
1224 }
1225
1226 /* --- Yield --------------------------------------------------------------- */
1227
1228 #if SU_HAS_PERL(5, 10, 0)
1229 # define SU_RETOP_SUB(C)   ((C)->blk_sub.retop)
1230 # define SU_RETOP_EVAL(C)  ((C)->blk_eval.retop)
1231 # define SU_RETOP_LOOP(C)  ((C)->blk_loop.my_op->op_lastop->op_next)
1232 # define SU_RETOP_GIVEN(C) ((C)->blk_givwhen.leave_op->op_next)
1233 #else
1234 # define SU_RETOP_SUB(C)  ((C)->blk_oldretsp > 0 ? PL_retstack[(C)->blk_oldretsp - 1] : NULL)
1235 # define SU_RETOP_EVAL(C) SU_RETOP_SUB(C)
1236 # define SU_RETOP_LOOP(C) ((C)->blk_loop.last_op->op_next)
1237 #endif
1238
1239 static void su_yield(pTHX_ void *ud_) {
1240  dMY_CXT;
1241  PERL_CONTEXT *cx;
1242  const char   *which = ud_;
1243  I32 cxix      = MY_CXT.yield_storage.cxix;
1244  I32 items     = MY_CXT.yield_storage.items;
1245  opcode  type  = OP_NULL;
1246  U8      flags = 0;
1247  OP     *next;
1248
1249  PERL_UNUSED_VAR(ud_);
1250
1251  cx = cxstack + cxix;
1252  switch (CxTYPE(cx)) {
1253   case CXt_BLOCK: {
1254    I32 i, cur = cxstack_ix, n = 1;
1255    OP *o = NULL;
1256    /* Is this actually a given/when block? This may occur only when yield was
1257     * called with HERE (or nothing) as the context. */
1258 #if SU_HAS_PERL(5, 10, 0)
1259    if (cxix > 0) {
1260     PERL_CONTEXT *prev = cx - 1;
1261     U8       prev_type = CxTYPE(prev);
1262     if ((prev_type == CXt_GIVEN || prev_type == CXt_WHEN)
1263         && (prev->blk_oldcop == cx->blk_oldcop)) {
1264      cxix--;
1265      cx = prev;
1266      if (prev_type == CXt_GIVEN)
1267       goto cxt_given;
1268      else
1269       goto cxt_when;
1270     }
1271    }
1272 #endif
1273    type  = OP_LEAVE;
1274    next  = NULL;
1275    /* Bare blocks (that appear as do { ... } blocks, map { ... } blocks or
1276     * constant folded blcoks) don't need to save the op to return to anywhere
1277     * since 'last' isn't supposed to work inside them. So we climb higher in
1278     * the context stack until we reach a context that has a return op (i.e. a
1279     * sub, an eval, a format or a real loop), recording how many blocks we
1280     * crossed. Then we follow the op_next chain until we get to the leave op
1281     * that closes the original block, which we are assured to reach since
1282     * everything is static (the blocks we have crossed cannot be evals or
1283     * subroutine calls). */
1284    for (i = cxix + 1; i <= cur; ++i) {
1285     PERL_CONTEXT *cx2 = cxstack + i;
1286     switch (CxTYPE(cx2)) {
1287      case CXt_BLOCK:
1288       ++n;
1289       break;
1290      case CXt_SUB:
1291      case CXt_FORMAT:
1292       o = SU_RETOP_SUB(cx2);
1293       break;
1294      case CXt_EVAL:
1295       o = SU_RETOP_EVAL(cx2);
1296       break;
1297 #if SU_HAS_PERL(5, 11, 0)
1298      case CXt_LOOP_FOR:
1299      case CXt_LOOP_PLAIN:
1300      case CXt_LOOP_LAZYSV:
1301      case CXt_LOOP_LAZYIV:
1302 #else
1303      case CXt_LOOP:
1304 #endif
1305       o = SU_RETOP_LOOP(cx2);
1306       break;
1307     }
1308     if (o)
1309      break;
1310    }
1311    if (!o)
1312     o = PL_op;
1313    while (n && o) {
1314     /* We may find other enter/leave blocks on our way to the matching leave.
1315      * Make sure the depth is incremented/decremented appropriately. */
1316     if (o->op_type == OP_ENTER) {
1317      ++n;
1318     } else if (o->op_type == OP_LEAVE) {
1319      --n;
1320      if (!n) {
1321       next = o->op_next;
1322       break;
1323      }
1324     }
1325     o = o->op_next;
1326    }
1327    break;
1328   }
1329   case CXt_SUB:
1330   case CXt_FORMAT:
1331    type = OP_LEAVESUB;
1332    next = SU_RETOP_SUB(cx);
1333    break;
1334   case CXt_EVAL:
1335    type = CxTRYBLOCK(cx) ? OP_LEAVETRY : OP_LEAVEEVAL;
1336    next = SU_RETOP_EVAL(cx);
1337    break;
1338 #if SU_HAS_PERL(5, 11, 0)
1339   case CXt_LOOP_FOR:
1340   case CXt_LOOP_PLAIN:
1341   case CXt_LOOP_LAZYSV:
1342   case CXt_LOOP_LAZYIV:
1343 #else
1344   case CXt_LOOP:
1345 #endif
1346    type = OP_LEAVELOOP;
1347    next = SU_RETOP_LOOP(cx);
1348    break;
1349 #if SU_HAS_PERL(5, 10, 0)
1350   case CXt_GIVEN:
1351 cxt_given:
1352    type = OP_LEAVEGIVEN;
1353    next = SU_RETOP_GIVEN(cx);
1354    break;
1355   case CXt_WHEN:
1356 cxt_when:
1357 #if SU_HAS_PERL(5, 15, 1)
1358    type   = OP_LEAVEWHEN;
1359 #else
1360    type   = OP_BREAK;
1361    flags |= OPf_SPECIAL;
1362 #endif
1363    next   = NULL;
1364    break;
1365 #endif
1366   case CXt_SUBST:
1367    croak("%s() can't target a substitution context", which);
1368    break;
1369   default:
1370    croak("%s() doesn't know how to leave a %s context",
1371           which,                         SU_CXNAME(cxstack + cxix));
1372    break;
1373  }
1374
1375  PL_stack_sp = MY_CXT.yield_storage.savesp;
1376 #if SU_HAS_PERL(5, 19, 4)
1377  {
1378   I32 i;
1379   SV **sp = PL_stack_sp;
1380   for (i = -items + 1; i <= 0; ++i)
1381    if (!SvTEMP(sp[i]))
1382     sv_2mortal(SvREFCNT_inc(sp[i]));
1383  }
1384 #endif
1385
1386  if (cxstack_ix > cxix)
1387   dounwind(cxix);
1388
1389  /* Copy the arguments passed to yield() where the leave op expects to find
1390   * them. */
1391  if (items)
1392   Move(PL_stack_sp - items + 1, PL_stack_base + cx->blk_oldsp + 1, items, SV *);
1393  PL_stack_sp = PL_stack_base + cx->blk_oldsp + items;
1394
1395  flags |= OP_GIMME_REVERSE(cx->blk_gimme);
1396
1397  MY_CXT.yield_storage.leave_op.op_type   = type;
1398  MY_CXT.yield_storage.leave_op.op_ppaddr = PL_ppaddr[type];
1399  MY_CXT.yield_storage.leave_op.op_flags  = flags;
1400  MY_CXT.yield_storage.leave_op.op_next   = next;
1401
1402  PL_op = (OP *) &(MY_CXT.yield_storage.leave_op);
1403  PL_op = PL_op->op_ppaddr(aTHX);
1404
1405  MY_CXT.yield_storage.proxy_op.op_next = PL_op;
1406  PL_op = &(MY_CXT.yield_storage.proxy_op);
1407 }
1408
1409 /* --- Uplevel ------------------------------------------------------------- */
1410
1411 #define SU_UPLEVEL_SAVE(f, t) STMT_START { sud->old_##f = PL_##f; PL_##f = (t); } STMT_END
1412 #define SU_UPLEVEL_RESTORE(f) STMT_START { PL_##f = sud->old_##f; } STMT_END
1413
1414 static su_uplevel_ud *su_uplevel_storage_new(pTHX_ I32 cxix) {
1415 #define su_uplevel_storage_new(I) su_uplevel_storage_new(aTHX_ (I))
1416  su_uplevel_ud *sud;
1417  UV depth;
1418  dMY_CXT;
1419
1420  sud = MY_CXT.uplevel_storage.root;
1421  if (sud) {
1422   MY_CXT.uplevel_storage.root = sud->next;
1423   MY_CXT.uplevel_storage.count--;
1424  } else {
1425   sud = su_uplevel_ud_new();
1426  }
1427
1428  sud->next = MY_CXT.uplevel_storage.top;
1429  MY_CXT.uplevel_storage.top = sud;
1430
1431  depth = su_uid_depth(cxix);
1432  su_uid_storage_dup(&sud->tmp_uid_storage, &MY_CXT.uid_storage, depth);
1433  sud->old_uid_storage = MY_CXT.uid_storage;
1434  MY_CXT.uid_storage   = sud->tmp_uid_storage;
1435
1436  return sud;
1437 }
1438
1439 #if SU_HAS_PERL(5, 13, 7)
1440
1441 static void su_uplevel_storage_delete(pTHX_ su_uplevel_ud *sud) {
1442 #define su_uplevel_storage_delete(S) su_uplevel_storage_delete(aTHX_ (S))
1443  dMY_CXT;
1444
1445  sud->tmp_uid_storage = MY_CXT.uid_storage;
1446  MY_CXT.uid_storage   = sud->old_uid_storage;
1447  {
1448   su_uid **map;
1449   UV  i, alloc;
1450   map   = sud->tmp_uid_storage.map;
1451   alloc = sud->tmp_uid_storage.alloc;
1452   for (i = 0; i < alloc; ++i) {
1453    if (map[i])
1454     map[i]->flags &= SU_UID_ACTIVE;
1455   }
1456  }
1457  MY_CXT.uplevel_storage.top = sud->next;
1458
1459  if (MY_CXT.uplevel_storage.count >= SU_UPLEVEL_STORAGE_SIZE) {
1460   su_uplevel_ud_delete(sud);
1461  } else {
1462   sud->next = MY_CXT.uplevel_storage.root;
1463   MY_CXT.uplevel_storage.root = sud;
1464   MY_CXT.uplevel_storage.count++;
1465  }
1466 }
1467
1468 #endif
1469
1470 static int su_uplevel_goto_static(const OP *o) {
1471  for (; o; o = OpSIBLING(o)) {
1472   /* goto ops are unops with kids. */
1473   if (!(o->op_flags & OPf_KIDS))
1474    continue;
1475
1476   switch (o->op_type) {
1477    case OP_LEAVEEVAL:
1478    case OP_LEAVETRY:
1479     /* Don't care about gotos inside eval, as they are forbidden at run time. */
1480     break;
1481    case OP_GOTO:
1482     return 1;
1483    default:
1484     if (su_uplevel_goto_static(((const UNOP *) o)->op_first))
1485      return 1;
1486     break;
1487   }
1488  }
1489
1490  return 0;
1491 }
1492
1493 #if SU_UPLEVEL_HIJACKS_RUNOPS
1494
1495 static int su_uplevel_goto_runops(pTHX) {
1496 #define su_uplevel_goto_runops() su_uplevel_goto_runops(aTHX)
1497  register OP *op;
1498  dVAR;
1499
1500  op = PL_op;
1501  do {
1502   if (op->op_type == OP_GOTO) {
1503    AV  *argarray = NULL;
1504    I32  cxix;
1505
1506    for (cxix = cxstack_ix; cxix >= 0; --cxix) {
1507     const PERL_CONTEXT *cx = cxstack + cxix;
1508
1509     switch (CxTYPE(cx)) {
1510      case CXt_SUB:
1511       if (CxHASARGS(cx)) {
1512        argarray = cx->blk_sub.argarray;
1513        goto done;
1514       }
1515       break;
1516      case CXt_EVAL:
1517      case CXt_FORMAT:
1518       goto done;
1519      default:
1520       break;
1521     }
1522    }
1523
1524 done:
1525    if (argarray) {
1526     dMY_CXT;
1527
1528     if (MY_CXT.uplevel_storage.top->cxix == cxix) {
1529      AV  *args  = GvAV(PL_defgv);
1530      I32  items = AvFILLp(args);
1531
1532      av_extend(argarray, items);
1533      Copy(AvARRAY(args), AvARRAY(argarray), items + 1, SV *);
1534      AvFILLp(argarray) = items;
1535     }
1536    }
1537   }
1538
1539   PL_op = op = op->op_ppaddr(aTHX);
1540
1541 #if !SU_HAS_PERL(5, 13, 0)
1542   PERL_ASYNC_CHECK();
1543 #endif
1544  } while (op);
1545
1546  TAINT_NOT;
1547
1548  return 0;
1549 }
1550
1551 #endif /* SU_UPLEVEL_HIJACKS_RUNOPS */
1552
1553 #define su_at_underscore(C) PadARRAY(PadlistARRAY(CvPADLIST(C))[CvDEPTH(C)])[0]
1554
1555 static void su_uplevel_restore(pTHX_ void *sus_) {
1556  su_uplevel_ud *sud = sus_;
1557  PERL_SI *cur = sud->old_curstackinfo;
1558  PERL_SI *si  = sud->si;
1559
1560 #if SU_UPLEVEL_HIJACKS_RUNOPS
1561  if (PL_runops == su_uplevel_goto_runops)
1562   PL_runops = sud->old_runops;
1563 #endif
1564
1565  if (sud->callback) {
1566   PERL_CONTEXT *cx = cxstack + sud->cxix;
1567   AV     *argarray = MUTABLE_AV(su_at_underscore(sud->callback));
1568
1569   /* We have to fix the pad entry for @_ in the original callback because it
1570    * may have been reified. */
1571   if (AvREAL(argarray)) {
1572    const I32 fill = AvFILLp(argarray);
1573    SvREFCNT_dec(argarray);
1574    argarray = newAV();
1575    AvREAL_off(argarray);
1576    AvREIFY_on(argarray);
1577    av_extend(argarray, fill);
1578    su_at_underscore(sud->callback) = MUTABLE_SV(argarray);
1579   } else {
1580    CLEAR_ARGARRAY(argarray);
1581   }
1582
1583   /* If the old cv member is our renamed CV, it means that this place has been
1584    * reached without a goto() happening, and the old argarray member is
1585    * actually our fake argarray. Destroy it properly in that case. */
1586   if (cx->blk_sub.cv == sud->renamed) {
1587    SvREFCNT_dec(cx->blk_sub.argarray);
1588    cx->blk_sub.argarray = argarray;
1589   }
1590
1591   CvDEPTH(sud->callback)--;
1592   SvREFCNT_dec(sud->callback);
1593  }
1594
1595  /* Free the renamed CV. We must do it ourselves so that we can force the
1596   * depth to be 0, or perl would complain about it being "still in use".
1597   * But we *know* that it cannot be so. */
1598  if (sud->renamed) {
1599   if (!CvISXSUB(sud->renamed)) {
1600    CvDEPTH(sud->renamed)   = 0;
1601    CvPADLIST(sud->renamed) = NULL;
1602   }
1603   SvREFCNT_dec(sud->renamed);
1604  }
1605
1606  CATCH_SET(sud->old_catch);
1607
1608  SU_UPLEVEL_RESTORE(op);
1609
1610  /* stack_grow() wants PL_curstack so restore the old stack first */
1611  if (PL_curstackinfo == si) {
1612   PL_curstack = cur->si_stack;
1613   if (sud->old_mainstack)
1614    SU_UPLEVEL_RESTORE(mainstack);
1615   SU_UPLEVEL_RESTORE(curstackinfo);
1616
1617   if (sud->died) {
1618    CV *target = sud->target;
1619    I32 levels = 0, i;
1620
1621    /* When we die, the depth of the target CV is not updated because of the
1622     * stack switcheroo. So we have to look at all the frames between the
1623     * uplevel call and the catch block to count how many call frames to the
1624     * target CV were skipped. */
1625    for (i = cur->si_cxix; i > sud->cxix; i--) {
1626     register const PERL_CONTEXT *cx = cxstack + i;
1627
1628     if (CxTYPE(cx) == CXt_SUB) {
1629      if (cx->blk_sub.cv == target)
1630       ++levels;
1631     }
1632    }
1633
1634    /* If we died, the replacement stack was already unwinded to the first
1635     * eval frame, and all the contexts down there were popped. We don't have
1636     * to pop manually any context of the original stack, because they must
1637     * have been in the replacement stack as well (since the second was copied
1638     * from the first). Thus we only have to make sure the original stack index
1639     * points to the context just below the first eval scope under the target
1640     * frame. */
1641    for (; i >= 0; i--) {
1642     register const PERL_CONTEXT *cx = cxstack + i;
1643
1644     switch (CxTYPE(cx)) {
1645      case CXt_SUB:
1646       if (cx->blk_sub.cv == target)
1647        ++levels;
1648       break;
1649      case CXt_EVAL:
1650       goto found_it;
1651       break;
1652      default:
1653       break;
1654     }
1655    }
1656
1657 found_it:
1658    CvDEPTH(target) = sud->target_depth - levels;
1659    PL_curstackinfo->si_cxix = i - 1;
1660
1661 #if !SU_HAS_PERL(5, 13, 1)
1662    /* Since $@ was maybe localized between the target frame and the uplevel
1663     * call, we forcefully flush the save stack to get rid of it and then
1664     * reset $@ to its proper value. Note that the the call to
1665     * su_uplevel_restore() must happen before the "reset $@" item of the save
1666     * stack is processed, as uplevel was called after the localization.
1667     * Andrew's changes to how $@ was handled, which were mainly integrated
1668     * between perl 5.13.0 and 5.13.1, fixed this. */
1669    if (ERRSV && SvTRUE(ERRSV)) {
1670     register const PERL_CONTEXT *cx = cxstack + i; /* This is the eval scope */
1671     SV *errsv = SvREFCNT_inc(ERRSV);
1672     PL_scopestack_ix = cx->blk_oldscopesp;
1673     leave_scope(PL_scopestack[PL_scopestack_ix]);
1674     sv_setsv(ERRSV, errsv);
1675     SvREFCNT_dec(errsv);
1676    }
1677 #endif
1678   }
1679  }
1680
1681  SU_UPLEVEL_RESTORE(curcop);
1682
1683  SvREFCNT_dec(sud->target);
1684
1685  PL_stack_base = AvARRAY(cur->si_stack);
1686  PL_stack_sp   = PL_stack_base + AvFILLp(cur->si_stack);
1687  PL_stack_max  = PL_stack_base + AvMAX(cur->si_stack);
1688
1689  /* When an exception is thrown from the uplevel'd subroutine,
1690   * su_uplevel_restore() may be called by the LEAVE in die_unwind() (renamed
1691   * die_where() in more recent perls), which has the sad habit of keeping a
1692   * pointer to the current context frame across this call. This means that we
1693   * can't free the temporary context stack we used for the uplevel call right
1694   * now, or that pointer upwards would point to garbage. */
1695 #if SU_HAS_PERL(5, 13, 7)
1696  /* This issue has been fixed in perl with commit 8f89e5a9, which was made
1697   * public in perl 5.13.7. */
1698  su_uplevel_storage_delete(sud);
1699 #else
1700  /* Otherwise, we just enqueue it back in the global storage list. */
1701  {
1702   dMY_CXT;
1703
1704   sud->tmp_uid_storage = MY_CXT.uid_storage;
1705   MY_CXT.uid_storage   = sud->old_uid_storage;
1706
1707   MY_CXT.uplevel_storage.top  = sud->next;
1708   sud->next = MY_CXT.uplevel_storage.root;
1709   MY_CXT.uplevel_storage.root = sud;
1710   MY_CXT.uplevel_storage.count++;
1711  }
1712 #endif
1713
1714  return;
1715 }
1716
1717 static CV *su_cv_clone(pTHX_ CV *proto, GV *gv) {
1718 #define su_cv_clone(P, G) su_cv_clone(aTHX_ (P), (G))
1719  dVAR;
1720  CV *cv;
1721
1722  cv = MUTABLE_CV(newSV_type(SvTYPE(proto)));
1723
1724  CvFLAGS(cv)  = CvFLAGS(proto);
1725 #ifdef CVf_CVGV_RC
1726  CvFLAGS(cv) &= ~CVf_CVGV_RC;
1727 #endif
1728  CvDEPTH(cv)  = CvDEPTH(proto);
1729 #ifdef USE_ITHREADS
1730  CvFILE(cv)   = CvISXSUB(proto) ? CvFILE(proto) : savepv(CvFILE(proto));
1731 #else
1732  CvFILE(cv)   = CvFILE(proto);
1733 #endif
1734
1735  CvGV_set(cv, gv);
1736 #if SU_RELEASE && SU_HAS_PERL_EXACT(5, 21, 4)
1737  CvNAMED_off(cv);
1738 #endif
1739  CvSTASH_set(cv, CvSTASH(proto));
1740  /* Commit 4c74a7df, publicized with perl 5.13.3, began to add backrefs to
1741   * stashes. CvSTASH_set() started to do it as well with commit c68d95645
1742   * (which was part of perl 5.13.7). */
1743 #if SU_HAS_PERL(5, 13, 3) && !SU_HAS_PERL(5, 13, 7)
1744  if (CvSTASH(proto))
1745   Perl_sv_add_backref(aTHX_ CvSTASH(proto), MUTABLE_SV(cv));
1746 #endif
1747
1748  if (CvISXSUB(proto)) {
1749   CvXSUB(cv)       = CvXSUB(proto);
1750   CvXSUBANY(cv)    = CvXSUBANY(proto);
1751  } else {
1752   OP_REFCNT_LOCK;
1753   CvROOT(cv)       = OpREFCNT_inc(CvROOT(proto));
1754   OP_REFCNT_UNLOCK;
1755   CvSTART(cv)      = CvSTART(proto);
1756   CvPADLIST(cv)    = CvPADLIST(proto);
1757  }
1758  CvOUTSIDE(cv)     = CvOUTSIDE(proto);
1759 #ifdef CVf_WEAKOUTSIDE
1760  if (!(CvFLAGS(proto) & CVf_WEAKOUTSIDE))
1761 #endif
1762   SvREFCNT_inc_simple_void(CvOUTSIDE(cv));
1763 #ifdef CvOUTSIDE_SEQ
1764  CvOUTSIDE_SEQ(cv) = CvOUTSIDE_SEQ(proto);
1765 #endif
1766
1767  if (SvPOK(proto))
1768   sv_setpvn(MUTABLE_SV(cv), SvPVX_const(proto), SvCUR(proto));
1769
1770 #ifdef CvCONST
1771  if (CvCONST(cv))
1772   CvCONST_off(cv);
1773 #endif
1774
1775  return cv;
1776 }
1777
1778 static I32 su_uplevel(pTHX_ CV *callback, I32 cxix, I32 args) {
1779 #define su_uplevel(C, I, A) su_uplevel(aTHX_ (C), (I), (A))
1780  su_uplevel_ud *sud;
1781  const PERL_CONTEXT *cx = cxstack + cxix;
1782  PERL_SI *si;
1783  PERL_SI *cur = PL_curstackinfo;
1784  SV **old_stack_sp;
1785  CV  *target;
1786  CV  *renamed;
1787  UNOP sub_op;
1788  I32  gimme;
1789  I32  old_mark, new_mark;
1790  I32  ret;
1791  dSP;
1792
1793  ENTER;
1794
1795  gimme = GIMME_V;
1796  /* Make PL_stack_sp point just before the CV. */
1797  PL_stack_sp -= args + 1;
1798  old_mark = AvFILLp(PL_curstack) = PL_stack_sp - PL_stack_base;
1799  SPAGAIN;
1800
1801  sud = su_uplevel_storage_new(cxix);
1802
1803  sud->cxix     = cxix;
1804  sud->died     = 1;
1805  sud->callback = NULL;
1806  sud->renamed  = NULL;
1807  SAVEDESTRUCTOR_X(su_uplevel_restore, sud);
1808
1809  si = sud->si;
1810
1811  si->si_type    = cur->si_type;
1812  si->si_next    = NULL;
1813  si->si_prev    = cur->si_prev;
1814 #ifdef DEBUGGING
1815  si->si_markoff = cx->blk_oldmarksp;
1816 #endif
1817
1818  /* Allocate enough space for all the elements of the original stack up to the
1819   * target context, plus the forthcoming arguments. */
1820  new_mark = cx->blk_oldsp;
1821  av_extend(si->si_stack, new_mark + 1 + args + 1);
1822  Copy(PL_curstack, AvARRAY(si->si_stack), new_mark + 1, SV *);
1823  AvFILLp(si->si_stack) = new_mark;
1824  SU_POISON(AvARRAY(si->si_stack) + new_mark + 1, args + 1, SV *);
1825
1826  /* Specialized SWITCHSTACK() */
1827  PL_stack_base = AvARRAY(si->si_stack);
1828  old_stack_sp  = PL_stack_sp;
1829  PL_stack_sp   = PL_stack_base + AvFILLp(si->si_stack);
1830  PL_stack_max  = PL_stack_base + AvMAX(si->si_stack);
1831  SPAGAIN;
1832
1833  /* Copy the context stack up to the context just below the target. */
1834  si->si_cxix = (cxix < 0) ? -1 : (cxix - 1);
1835  if (si->si_cxmax < cxix) {
1836   /* The max size must be at least two so that GROW(max) = (max*3)/2 > max */
1837   si->si_cxmax = (cxix < 4) ? 4 : cxix;
1838   Renew(si->si_cxstack, si->si_cxmax + 1, PERL_CONTEXT);
1839  }
1840  Copy(cur->si_cxstack, si->si_cxstack, cxix, PERL_CONTEXT);
1841  SU_POISON(si->si_cxstack + cxix, si->si_cxmax + 1 - cxix, PERL_CONTEXT);
1842
1843  target            = cx->blk_sub.cv;
1844  sud->target       = (CV *) SvREFCNT_inc(target);
1845  sud->target_depth = CvDEPTH(target);
1846
1847  /* blk_oldcop is essentially needed for caller() and stack traces. It has no
1848   * run-time implication, since PL_curcop will be overwritten as soon as we
1849   * enter a sub (a sub starts by a nextstate/dbstate). Hence it's safe to just
1850   * make it point to the blk_oldcop for the target frame, so that caller()
1851   * reports the right file name, line number and lexical hints. */
1852  SU_UPLEVEL_SAVE(curcop, cx->blk_oldcop);
1853  /* Don't reset PL_markstack_ptr, or we would overwrite the mark stack below
1854   * this point. Don't reset PL_curpm either, we want the most recent matches. */
1855
1856  SU_UPLEVEL_SAVE(curstackinfo, si);
1857  /* If those two are equal, we need to fool POPSTACK_TO() */
1858  if (PL_mainstack == PL_curstack)
1859   SU_UPLEVEL_SAVE(mainstack, si->si_stack);
1860  else
1861   sud->old_mainstack = NULL;
1862  PL_curstack = si->si_stack;
1863
1864  renamed      = su_cv_clone(callback, CvGV(target));
1865  sud->renamed = renamed;
1866
1867  PUSHMARK(SP);
1868  /* Both SP and old_stack_sp point just before the CV. */
1869  Copy(old_stack_sp + 2, SP + 1, args, SV *);
1870  SP += args;
1871  PUSHs((SV *) renamed);
1872  PUTBACK;
1873
1874  Zero(&sub_op, 1, UNOP);
1875  sub_op.op_type  = OP_ENTERSUB;
1876  sub_op.op_next  = NULL;
1877  sub_op.op_flags = OP_GIMME_REVERSE(gimme) | OPf_STACKED;
1878  if (PL_DBsub)
1879   sub_op.op_flags |= OPpENTERSUB_DB;
1880
1881  SU_UPLEVEL_SAVE(op, (OP *) &sub_op);
1882
1883 #if SU_UPLEVEL_HIJACKS_RUNOPS
1884  sud->old_runops = PL_runops;
1885 #endif
1886
1887  sud->old_catch = CATCH_GET;
1888  CATCH_SET(TRUE);
1889
1890  if ((PL_op = PL_ppaddr[OP_ENTERSUB](aTHX))) {
1891   PERL_CONTEXT *sub_cx = cxstack + cxstack_ix;
1892
1893   /* If pp_entersub() returns a non-null OP, it means that the callback is not
1894    * an XSUB. */
1895
1896   sud->callback = MUTABLE_CV(SvREFCNT_inc(callback));
1897   CvDEPTH(callback)++;
1898
1899   if (CxHASARGS(cx) && cx->blk_sub.argarray) {
1900    /* The call to pp_entersub() has saved the current @_ (in XS terms,
1901     * GvAV(PL_defgv)) in the savearray member, and has created a new argarray
1902     * with what we put on the stack. But we want to fake up the same arguments
1903     * as the ones in use at the context we uplevel to, so we replace the
1904     * argarray with an unreal copy of the original @_. */
1905    AV *av = newAV();
1906    AvREAL_off(av);
1907    AvREIFY_on(av);
1908    av_extend(av, AvMAX(cx->blk_sub.argarray));
1909    AvFILLp(av) = AvFILLp(cx->blk_sub.argarray);
1910    Copy(AvARRAY(cx->blk_sub.argarray), AvARRAY(av), AvFILLp(av) + 1, SV *);
1911    sub_cx->blk_sub.argarray = av;
1912   } else {
1913    SvREFCNT_inc_simple_void(sub_cx->blk_sub.argarray);
1914   }
1915
1916   if (su_uplevel_goto_static(CvROOT(renamed))) {
1917 #if SU_UPLEVEL_HIJACKS_RUNOPS
1918    if (PL_runops != PL_runops_std) {
1919     if (PL_runops == PL_runops_dbg) {
1920      if (PL_debug)
1921       croak("uplevel() can't execute code that calls goto when debugging flags are set");
1922     } else if (PL_runops != su_uplevel_goto_runops)
1923      croak("uplevel() can't execute code that calls goto with a custom runloop");
1924    }
1925
1926    PL_runops = su_uplevel_goto_runops;
1927 #else  /* SU_UPLEVEL_HIJACKS_RUNOPS */
1928    croak("uplevel() can't execute code that calls goto before perl 5.8");
1929 #endif /* !SU_UPLEVEL_HIJACKS_RUNOPS */
1930   }
1931
1932   CALLRUNOPS(aTHX);
1933  }
1934
1935  sud->died = 0;
1936
1937  ret = PL_stack_sp - (PL_stack_base + new_mark);
1938  if (ret > 0) {
1939   AV *old_stack = sud->old_curstackinfo->si_stack;
1940
1941   if (old_mark + ret > AvMAX(old_stack)) {
1942    /* Specialized EXTEND(old_sp, ret) */
1943    av_extend(old_stack, old_mark + ret + 1);
1944    old_stack_sp = AvARRAY(old_stack) + old_mark;
1945   }
1946
1947   Copy(PL_stack_sp - ret + 1, old_stack_sp + 1, ret, SV *);
1948   PL_stack_sp        += ret;
1949   AvFILLp(old_stack) += ret;
1950  }
1951
1952  LEAVE;
1953
1954  return ret;
1955 }
1956
1957 /* --- Unique context ID --------------------------------------------------- */
1958
1959 static su_uid *su_uid_storage_fetch(pTHX_ UV depth) {
1960 #define su_uid_storage_fetch(D) su_uid_storage_fetch(aTHX_ (D))
1961  su_uid **map, *uid;
1962  STRLEN alloc;
1963  dMY_CXT;
1964
1965  map   = MY_CXT.uid_storage.map;
1966  alloc = MY_CXT.uid_storage.alloc;
1967
1968  if (depth >= alloc) {
1969   STRLEN i;
1970
1971   Renew(map, depth + 1, su_uid *);
1972   for (i = alloc; i <= depth; ++i)
1973    map[i] = NULL;
1974
1975   MY_CXT.uid_storage.map   = map;
1976   MY_CXT.uid_storage.alloc = depth + 1;
1977  }
1978
1979  uid = map[depth];
1980
1981  if (!uid) {
1982   Newx(uid, 1, su_uid);
1983   uid->seq   = 0;
1984   uid->flags = 0;
1985   map[depth] = uid;
1986  }
1987
1988  if (depth >= MY_CXT.uid_storage.used)
1989   MY_CXT.uid_storage.used = depth + 1;
1990
1991  return uid;
1992 }
1993
1994 static int su_uid_storage_check(pTHX_ UV depth, UV seq) {
1995 #define su_uid_storage_check(D, S) su_uid_storage_check(aTHX_ (D), (S))
1996  su_uid *uid;
1997  dMY_CXT;
1998
1999  if (depth >= MY_CXT.uid_storage.used)
2000   return 0;
2001
2002  uid = MY_CXT.uid_storage.map[depth];
2003
2004  return uid && (uid->seq == seq) && (uid->flags & SU_UID_ACTIVE);
2005 }
2006
2007 static void su_uid_drop(pTHX_ void *ud_) {
2008  su_uid *uid = ud_;
2009
2010  uid->flags &= ~SU_UID_ACTIVE;
2011 }
2012
2013 static void su_uid_bump(pTHX_ void *ud_) {
2014  su_ud_reap *ud  = ud_;
2015
2016  SAVEDESTRUCTOR_X(su_uid_drop, ud->cb);
2017
2018  SU_UD_FREE(ud);
2019 }
2020
2021 static SV *su_uid_get(pTHX_ I32 cxix) {
2022 #define su_uid_get(I) su_uid_get(aTHX_ (I))
2023  su_uid *uid;
2024  SV *uid_sv;
2025  UV depth;
2026
2027  depth = su_uid_depth(cxix);
2028  uid   = su_uid_storage_fetch(depth);
2029
2030  if (!(uid->flags & SU_UID_ACTIVE)) {
2031   su_ud_reap *ud;
2032
2033   uid->seq = su_uid_seq_next(depth);
2034   uid->flags |= SU_UID_ACTIVE;
2035
2036   Newx(ud, 1, su_ud_reap);
2037   SU_UD_ORIGIN(ud)  = NULL;
2038   SU_UD_TYPE(ud)    = SU_UD_TYPE_UID;
2039   ud->cb = (SV *) uid;
2040   su_init(ud, cxix, SU_SAVE_DESTRUCTOR_SIZE);
2041  }
2042
2043  uid_sv = sv_newmortal();
2044  sv_setpvf(uid_sv, "%"UVuf"-%"UVuf, depth, uid->seq);
2045  return uid_sv;
2046 }
2047
2048 #ifdef grok_number
2049
2050 #define su_grok_number(S, L, VP) grok_number((S), (L), (VP))
2051
2052 #else /* grok_number */
2053
2054 #define IS_NUMBER_IN_UV 0x1
2055
2056 static int su_grok_number(pTHX_ const char *s, STRLEN len, UV *valuep) {
2057 #define su_grok_number(S, L, VP) su_grok_number(aTHX_ (S), (L), (VP))
2058  STRLEN i;
2059  SV *tmpsv;
2060
2061  /* This crude check should be good enough for a fallback implementation.
2062   * Better be too strict than too lax. */
2063  for (i = 0; i < len; ++i) {
2064   if (!isDIGIT(s[i]))
2065    return 0;
2066  }
2067
2068  tmpsv = sv_newmortal();
2069  sv_setpvn(tmpsv, s, len);
2070  *valuep = sv_2uv(tmpsv);
2071
2072  return IS_NUMBER_IN_UV;
2073 }
2074
2075 #endif /* !grok_number */
2076
2077 static int su_uid_validate(pTHX_ SV *uid) {
2078 #define su_uid_validate(U) su_uid_validate(aTHX_ (U))
2079  const char *s;
2080  STRLEN len, p = 0;
2081  UV depth, seq;
2082  int type;
2083
2084  s = SvPV_const(uid, len);
2085
2086  while (p < len && s[p] != '-')
2087   ++p;
2088  if (p >= len)
2089   croak("UID contains only one part");
2090
2091  type = su_grok_number(s, p, &depth);
2092  if (type != IS_NUMBER_IN_UV)
2093   croak("First UID part is not an unsigned integer");
2094
2095  ++p; /* Skip '-'. As we used to have p < len, len - (p + 1) >= 0. */
2096
2097  type = su_grok_number(s + p, len - p, &seq);
2098  if (type != IS_NUMBER_IN_UV)
2099   croak("Second UID part is not an unsigned integer");
2100
2101  return su_uid_storage_check(depth, seq);
2102 }
2103
2104 /* --- Context operations -------------------------------------------------- */
2105
2106 /* Remove sequences of BLOCKs having DB for stash, followed by a SUB context
2107  * for the debugger callback. */
2108
2109 static I32 su_context_skip_db(pTHX_ I32 cxix) {
2110 #define su_context_skip_db(C) su_context_skip_db(aTHX_ (C))
2111  I32 i;
2112
2113  if (!PL_DBsub)
2114   return cxix;
2115
2116  for (i = cxix; i > 0; --i) {
2117   PERL_CONTEXT *cx = cxstack + i;
2118
2119   switch (CxTYPE(cx)) {
2120 #if SU_HAS_PERL(5, 17, 1)
2121    case CXt_LOOP_PLAIN:
2122 #endif
2123    case CXt_BLOCK:
2124     if (cx->blk_oldcop && CopSTASH(cx->blk_oldcop) == GvSTASH(PL_DBgv))
2125      continue;
2126     break;
2127    case CXt_SUB:
2128     if (cx->blk_sub.cv == GvCV(PL_DBsub)) {
2129      cxix = i - 1;
2130      continue;
2131     }
2132     break;
2133    default:
2134     break;
2135   }
2136
2137   break;
2138  }
2139
2140  return cxix;
2141 }
2142
2143
2144 static I32 su_context_normalize_up(pTHX_ I32 cxix) {
2145 #define su_context_normalize_up(C) su_context_normalize_up(aTHX_ (C))
2146  PERL_CONTEXT *cx;
2147
2148  if (cxix <= 0)
2149   return 0;
2150
2151  cx = cxstack + cxix;
2152  if (CxTYPE(cx) == CXt_BLOCK) {
2153   PERL_CONTEXT *prev = cx - 1;
2154
2155   switch (CxTYPE(prev)) {
2156 #if SU_HAS_PERL(5, 10, 0)
2157    case CXt_GIVEN:
2158    case CXt_WHEN:
2159 #endif
2160 #if SU_HAS_PERL(5, 11, 0)
2161    /* That's the only subcategory that can cause an extra BLOCK context */
2162    case CXt_LOOP_PLAIN:
2163 #else
2164    case CXt_LOOP:
2165 #endif
2166     if (cx->blk_oldcop == prev->blk_oldcop)
2167      return cxix - 1;
2168     break;
2169    case CXt_SUBST:
2170     if (cx->blk_oldcop && OpSIBLING(cx->blk_oldcop)
2171                        && OpSIBLING(cx->blk_oldcop)->op_type == OP_SUBST)
2172      return cxix - 1;
2173     break;
2174   }
2175  }
2176
2177  return cxix;
2178 }
2179
2180 static I32 su_context_normalize_down(pTHX_ I32 cxix) {
2181 #define su_context_normalize_down(C) su_context_normalize_down(aTHX_ (C))
2182  PERL_CONTEXT *next;
2183
2184  if (cxix >= cxstack_ix)
2185   return cxstack_ix;
2186
2187  next = cxstack + cxix + 1;
2188  if (CxTYPE(next) == CXt_BLOCK) {
2189   PERL_CONTEXT *cx = next - 1;
2190
2191   switch (CxTYPE(cx)) {
2192 #if SU_HAS_PERL(5, 10, 0)
2193    case CXt_GIVEN:
2194    case CXt_WHEN:
2195 #endif
2196 #if SU_HAS_PERL(5, 11, 0)
2197    /* That's the only subcategory that can cause an extra BLOCK context */
2198    case CXt_LOOP_PLAIN:
2199 #else
2200    case CXt_LOOP:
2201 #endif
2202     if (cx->blk_oldcop == next->blk_oldcop)
2203      return cxix + 1;
2204     break;
2205    case CXt_SUBST:
2206     if (next->blk_oldcop && OpSIBLING(next->blk_oldcop)
2207                          && OpSIBLING(next->blk_oldcop)->op_type == OP_SUBST)
2208      return cxix + 1;
2209     break;
2210   }
2211  }
2212
2213  return cxix;
2214 }
2215
2216 #define su_context_here() su_context_normalize_up(su_context_skip_db(cxstack_ix))
2217
2218 static I32 su_context_gimme(pTHX_ I32 cxix) {
2219 #define su_context_gimme(C) su_context_gimme(aTHX_ (C))
2220  I32 i;
2221
2222  for (i = cxix; i >= 0; --i) {
2223   PERL_CONTEXT *cx = cxstack + i;
2224
2225   switch (CxTYPE(cx)) {
2226    /* gimme is always G_ARRAY for loop contexts. */
2227 #if SU_HAS_PERL(5, 11, 0)
2228    case CXt_LOOP_FOR:
2229    case CXt_LOOP_PLAIN:
2230    case CXt_LOOP_LAZYSV:
2231    case CXt_LOOP_LAZYIV:
2232 #else
2233    case CXt_LOOP:
2234 #endif
2235    case CXt_SUBST: {
2236     const COP *cop = cx->blk_oldcop;
2237     if (cop && OpSIBLING(cop)) {
2238      switch (OpSIBLING(cop)->op_flags & OPf_WANT) {
2239       case OPf_WANT_VOID:
2240        return G_VOID;
2241       case OPf_WANT_SCALAR:
2242        return G_SCALAR;
2243       case OPf_WANT_LIST:
2244        return G_ARRAY;
2245       default:
2246        break;
2247      }
2248     }
2249     break;
2250    }
2251    default:
2252     return CxGIMME(cx);
2253     break;
2254   }
2255  }
2256
2257  return G_VOID;
2258 }
2259
2260 /* --- Global setup/teardown ----------------------------------------------- */
2261
2262 static VOL U32 su_initialized = 0;
2263
2264 static void su_global_teardown(pTHX_ void *root) {
2265  if (!su_initialized)
2266   return;
2267
2268 #if SU_MULTIPLICITY
2269  if (aTHX != root)
2270   return;
2271 #endif
2272
2273  SU_LOCK(&su_uid_seq_counter_mutex);
2274  PerlMemShared_free(su_uid_seq_counter.seqs);
2275  su_uid_seq_counter.size = 0;
2276  SU_UNLOCK(&su_uid_seq_counter_mutex);
2277
2278  MUTEX_DESTROY(&su_uid_seq_counter_mutex);
2279
2280  su_initialized = 0;
2281
2282  return;
2283 }
2284
2285 XS(XS_Scope__Upper_unwind);
2286 XS(XS_Scope__Upper_yield);
2287 XS(XS_Scope__Upper_leave);
2288
2289 #if SU_HAS_PERL(5, 9, 0)
2290 # define SU_XS_FILE_TYPE const char
2291 #else
2292 # define SU_XS_FILE_TYPE char
2293 #endif
2294
2295 static void su_global_setup(pTHX_ SU_XS_FILE_TYPE *file) {
2296 #define su_global_setup(F) su_global_setup(aTHX_ (F))
2297  HV *stash;
2298
2299  if (su_initialized)
2300   return;
2301
2302  MUTEX_INIT(&su_uid_seq_counter_mutex);
2303
2304  SU_LOCK(&su_uid_seq_counter_mutex);
2305  su_uid_seq_counter.seqs = NULL;
2306  su_uid_seq_counter.size = 0;
2307  SU_UNLOCK(&su_uid_seq_counter_mutex);
2308
2309  stash = gv_stashpv(__PACKAGE__, 1);
2310  newCONSTSUB(stash, "TOP",           newSViv(0));
2311  newCONSTSUB(stash, "SU_THREADSAFE", newSVuv(SU_THREADSAFE));
2312
2313  newXSproto("Scope::Upper::unwind", XS_Scope__Upper_unwind, file, NULL);
2314  newXSproto("Scope::Upper::yield",  XS_Scope__Upper_yield,  file, NULL);
2315  newXSproto("Scope::Upper::leave",  XS_Scope__Upper_leave,  file, NULL);
2316
2317 #if SU_MULTIPLICITY
2318  call_atexit(su_global_teardown, aTHX);
2319 #else
2320  call_atexit(su_global_teardown, NULL);
2321 #endif
2322
2323  su_initialized = 1;
2324
2325  return;
2326 }
2327
2328 /* --- Interpreter setup/teardown ------------------------------------------ */
2329
2330 static void su_local_teardown(pTHX_ void *param) {
2331  su_uplevel_ud *cur;
2332  su_uid **map;
2333  dMY_CXT;
2334
2335  map = MY_CXT.uid_storage.map;
2336  if (map) {
2337   STRLEN i;
2338   for (i = 0; i < MY_CXT.uid_storage.used; ++i)
2339    Safefree(map[i]);
2340   Safefree(map);
2341  }
2342
2343  cur = MY_CXT.uplevel_storage.root;
2344  if (cur) {
2345   su_uplevel_ud *prev;
2346   do {
2347    prev = cur;
2348    cur  = prev->next;
2349    su_uplevel_ud_delete(prev);
2350   } while (cur);
2351  }
2352
2353  return;
2354 }
2355
2356 static void su_local_setup(pTHX) {
2357 #define su_local_setup() su_local_setup(aTHX)
2358  MY_CXT_INIT;
2359
2360  MY_CXT.stack_placeholder = NULL;
2361
2362  /* NewOp() calls calloc() which just zeroes the memory with memset(). */
2363  Zero(&(MY_CXT.unwind_storage.return_op), 1, LISTOP);
2364  MY_CXT.unwind_storage.return_op.op_type   = OP_RETURN;
2365  MY_CXT.unwind_storage.return_op.op_ppaddr = PL_ppaddr[OP_RETURN];
2366
2367  Zero(&(MY_CXT.unwind_storage.proxy_op), 1, OP);
2368  MY_CXT.unwind_storage.proxy_op.op_type   = OP_STUB;
2369  MY_CXT.unwind_storage.proxy_op.op_ppaddr = NULL;
2370
2371  Zero(&(MY_CXT.yield_storage.leave_op), 1, UNOP);
2372  MY_CXT.yield_storage.leave_op.op_type   = OP_STUB;
2373  MY_CXT.yield_storage.leave_op.op_ppaddr = NULL;
2374
2375  Zero(&(MY_CXT.yield_storage.proxy_op), 1, OP);
2376  MY_CXT.yield_storage.proxy_op.op_type   = OP_STUB;
2377  MY_CXT.yield_storage.proxy_op.op_ppaddr = NULL;
2378
2379  MY_CXT.uplevel_storage.top   = NULL;
2380  MY_CXT.uplevel_storage.root  = NULL;
2381  MY_CXT.uplevel_storage.count = 0;
2382
2383  MY_CXT.uid_storage.map   = NULL;
2384  MY_CXT.uid_storage.used  = 0;
2385  MY_CXT.uid_storage.alloc = 0;
2386
2387  call_atexit(su_local_teardown, NULL);
2388
2389  return;
2390 }
2391
2392 /* --- XS ------------------------------------------------------------------ */
2393
2394 #define SU_GET_CONTEXT(A, B, D) \
2395  STMT_START {                   \
2396   if (items > A) {              \
2397    SV *csv = ST(B);             \
2398    if (!SvOK(csv))              \
2399     goto default_cx;            \
2400    cxix = SvIV(csv);            \
2401    if (cxix < 0)                \
2402     cxix = 0;                   \
2403    else if (cxix > cxstack_ix)  \
2404     goto default_cx;            \
2405   } else {                      \
2406 default_cx:                     \
2407    cxix = (D);                  \
2408   }                             \
2409  } STMT_END
2410
2411 #define SU_GET_LEVEL(A, B) \
2412  STMT_START {              \
2413   level = 0;               \
2414   if (items > 0) {         \
2415    SV *lsv = ST(B);        \
2416    if (SvOK(lsv)) {        \
2417     level = SvIV(lsv);     \
2418     if (level < 0)         \
2419      level = 0;            \
2420    }                       \
2421   }                        \
2422  } STMT_END
2423
2424 #if SU_HAS_PERL(5, 10, 0)
2425 # define SU_INFO_COUNT 11
2426 #else
2427 # define SU_INFO_COUNT 10
2428 #endif
2429
2430 XS(XS_Scope__Upper_unwind) {
2431 #ifdef dVAR
2432  dVAR; dXSARGS;
2433 #else
2434  dXSARGS;
2435 #endif
2436  dMY_CXT;
2437  I32 cxix;
2438
2439  PERL_UNUSED_VAR(cv); /* -W */
2440  PERL_UNUSED_VAR(ax); /* -Wall */
2441
2442  SU_GET_CONTEXT(0, items - 1, cxstack_ix);
2443  do {
2444   PERL_CONTEXT *cx = cxstack + cxix;
2445   switch (CxTYPE(cx)) {
2446    case CXt_SUB:
2447     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2448      continue;
2449    case CXt_EVAL:
2450    case CXt_FORMAT:
2451     MY_CXT.unwind_storage.cxix   = cxix;
2452     MY_CXT.unwind_storage.items  = items;
2453     MY_CXT.unwind_storage.savesp = PL_stack_sp;
2454     if (items > 0) {
2455      MY_CXT.unwind_storage.items--;
2456      MY_CXT.unwind_storage.savesp--;
2457     }
2458     /* pp_entersub will want to sanitize the stack after returning from there
2459      * Screw that, we're insane!
2460      * dXSARGS calls POPMARK, so we need to match PL_markstack_ptr[1] */
2461     if (GIMME_V == G_SCALAR)
2462      PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
2463     SAVEDESTRUCTOR_X(su_unwind, NULL);
2464     return;
2465    default:
2466     break;
2467   }
2468  } while (--cxix >= 0);
2469  croak("Can't return outside a subroutine");
2470 }
2471
2472 static const char su_yield_name[] = "yield";
2473
2474 XS(XS_Scope__Upper_yield) {
2475 #ifdef dVAR
2476  dVAR; dXSARGS;
2477 #else
2478  dXSARGS;
2479 #endif
2480  dMY_CXT;
2481  I32 cxix;
2482
2483  PERL_UNUSED_VAR(cv); /* -W */
2484  PERL_UNUSED_VAR(ax); /* -Wall */
2485
2486  SU_GET_CONTEXT(0, items - 1, su_context_here());
2487  MY_CXT.yield_storage.cxix   = cxix;
2488  MY_CXT.yield_storage.items  = items;
2489  MY_CXT.yield_storage.savesp = PL_stack_sp;
2490  if (items > 0) {
2491   MY_CXT.yield_storage.items--;
2492   MY_CXT.yield_storage.savesp--;
2493  }
2494  /* See XS_Scope__Upper_unwind */
2495  if (GIMME_V == G_SCALAR)
2496   PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
2497  SAVEDESTRUCTOR_X(su_yield, su_yield_name);
2498  return;
2499 }
2500
2501 static const char su_leave_name[] = "leave";
2502
2503 XS(XS_Scope__Upper_leave) {
2504 #ifdef dVAR
2505  dVAR; dXSARGS;
2506 #else
2507  dXSARGS;
2508 #endif
2509  dMY_CXT;
2510
2511  PERL_UNUSED_VAR(cv); /* -W */
2512  PERL_UNUSED_VAR(ax); /* -Wall */
2513
2514  MY_CXT.yield_storage.cxix   = su_context_here();
2515  MY_CXT.yield_storage.items  = items;
2516  MY_CXT.yield_storage.savesp = PL_stack_sp;
2517  /* See XS_Scope__Upper_unwind */
2518  if (GIMME_V == G_SCALAR)
2519   PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
2520  SAVEDESTRUCTOR_X(su_yield, su_leave_name);
2521  return;
2522 }
2523
2524 MODULE = Scope::Upper            PACKAGE = Scope::Upper
2525
2526 PROTOTYPES: ENABLE
2527
2528 BOOT:
2529 {
2530  su_global_setup(file);
2531  su_local_setup();
2532 }
2533
2534 #if SU_THREADSAFE
2535
2536 void
2537 CLONE(...)
2538 PROTOTYPE: DISABLE
2539 PREINIT:
2540  su_uid_storage new_cxt;
2541 PPCODE:
2542  {
2543   dMY_CXT;
2544   new_cxt.map   = NULL;
2545   new_cxt.used  = 0;
2546   new_cxt.alloc = 0;
2547   su_uid_storage_dup(&new_cxt, &MY_CXT.uid_storage, MY_CXT.uid_storage.used);
2548  }
2549  {
2550   MY_CXT_CLONE;
2551   MY_CXT.uplevel_storage.top   = NULL;
2552   MY_CXT.uplevel_storage.root  = NULL;
2553   MY_CXT.uplevel_storage.count = 0;
2554   MY_CXT.uid_storage           = new_cxt;
2555  }
2556  XSRETURN(0);
2557
2558 #endif /* SU_THREADSAFE */
2559
2560 void
2561 HERE()
2562 PROTOTYPE:
2563 PREINIT:
2564  I32 cxix;
2565 PPCODE:
2566  cxix = su_context_here();
2567  EXTEND(SP, 1);
2568  mPUSHi(cxix);
2569  XSRETURN(1);
2570
2571 void
2572 UP(...)
2573 PROTOTYPE: ;$
2574 PREINIT:
2575  I32 cxix;
2576 PPCODE:
2577  SU_GET_CONTEXT(0, 0, su_context_here());
2578  if (cxix > 0) {
2579   --cxix;
2580   cxix = su_context_skip_db(cxix);
2581   cxix = su_context_normalize_up(cxix);
2582  }
2583  EXTEND(SP, 1);
2584  mPUSHi(cxix);
2585  XSRETURN(1);
2586
2587 void
2588 SUB(...)
2589 PROTOTYPE: ;$
2590 PREINIT:
2591  I32 cxix;
2592 PPCODE:
2593  SU_GET_CONTEXT(0, 0, cxstack_ix);
2594  EXTEND(SP, 1);
2595  for (; cxix >= 0; --cxix) {
2596   PERL_CONTEXT *cx = cxstack + cxix;
2597   switch (CxTYPE(cx)) {
2598    default:
2599     continue;
2600    case CXt_SUB:
2601     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2602      continue;
2603     mPUSHi(cxix);
2604     XSRETURN(1);
2605   }
2606  }
2607  XSRETURN_UNDEF;
2608
2609 void
2610 EVAL(...)
2611 PROTOTYPE: ;$
2612 PREINIT:
2613  I32 cxix;
2614 PPCODE:
2615  SU_GET_CONTEXT(0, 0, cxstack_ix);
2616  EXTEND(SP, 1);
2617  for (; cxix >= 0; --cxix) {
2618   PERL_CONTEXT *cx = cxstack + cxix;
2619   switch (CxTYPE(cx)) {
2620    default:
2621     continue;
2622    case CXt_EVAL:
2623     mPUSHi(cxix);
2624     XSRETURN(1);
2625   }
2626  }
2627  XSRETURN_UNDEF;
2628
2629 void
2630 SCOPE(...)
2631 PROTOTYPE: ;$
2632 PREINIT:
2633  I32 cxix, level;
2634 PPCODE:
2635  SU_GET_LEVEL(0, 0);
2636  cxix = su_context_here();
2637  while (--level >= 0) {
2638   if (cxix <= 0)
2639    break;
2640   --cxix;
2641   cxix = su_context_skip_db(cxix);
2642   cxix = su_context_normalize_up(cxix);
2643  }
2644  EXTEND(SP, 1);
2645  mPUSHi(cxix);
2646  XSRETURN(1);
2647
2648 void
2649 CALLER(...)
2650 PROTOTYPE: ;$
2651 PREINIT:
2652  I32 cxix, level;
2653 PPCODE:
2654  SU_GET_LEVEL(0, 0);
2655  for (cxix = cxstack_ix; cxix > 0; --cxix) {
2656   PERL_CONTEXT *cx = cxstack + cxix;
2657   switch (CxTYPE(cx)) {
2658    case CXt_SUB:
2659     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2660      continue;
2661    case CXt_EVAL:
2662    case CXt_FORMAT:
2663     if (--level < 0)
2664      goto done;
2665     break;
2666   }
2667  }
2668 done:
2669  EXTEND(SP, 1);
2670  mPUSHi(cxix);
2671  XSRETURN(1);
2672
2673 void
2674 want_at(...)
2675 PROTOTYPE: ;$
2676 PREINIT:
2677  I32 cxix;
2678 PPCODE:
2679  SU_GET_CONTEXT(0, 0, cxstack_ix);
2680  EXTEND(SP, 1);
2681  while (cxix > 0) {
2682   PERL_CONTEXT *cx = cxstack + cxix--;
2683   switch (CxTYPE(cx)) {
2684    case CXt_SUB:
2685     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2686      continue;
2687    case CXt_EVAL:
2688    case CXt_FORMAT: {
2689     I32 gimme = cx->blk_gimme;
2690     switch (gimme) {
2691      case G_VOID:   XSRETURN_UNDEF; break;
2692      case G_SCALAR: XSRETURN_NO;    break;
2693      case G_ARRAY:  XSRETURN_YES;   break;
2694     }
2695     break;
2696    }
2697   }
2698  }
2699  XSRETURN_UNDEF;
2700
2701 void
2702 context_info(...)
2703 PROTOTYPE: ;$
2704 PREINIT:
2705  I32 cxix;
2706  const PERL_CONTEXT *cx, *dbcx;
2707  COP *cop;
2708 PPCODE:
2709  SU_GET_CONTEXT(0, 0, su_context_skip_db(cxstack_ix));
2710  cxix = su_context_normalize_up(cxix);
2711  cx   = cxstack + cxix;
2712  dbcx = cx;
2713  if (PL_DBsub && cxix && (CxTYPE(cx) == CXt_SUB || CxTYPE(cx) == CXt_FORMAT)) {
2714   I32 i = su_context_skip_db(cxix - 1) + 1;
2715   if (i < cxix && CxTYPE(cxstack + i) == CXt_SUB)
2716    cx = cxstack + i;
2717  }
2718  cop  = cx->blk_oldcop;
2719  EXTEND(SP, SU_INFO_COUNT);
2720  /* stash (0) */
2721  {
2722   HV *stash = CopSTASH(cop);
2723   if (stash)
2724    PUSHs(su_newmortal_pvn(HvNAME(stash), HvNAMELEN(stash)));
2725   else
2726    PUSHs(&PL_sv_undef);
2727  }
2728  /* file (1) */
2729  PUSHs(su_newmortal_pvn(OutCopFILE(cop), OutCopFILE_len(cop)));
2730  /* line (2) */
2731  mPUSHi(CopLINE(cop));
2732  /* subroutine (3) and has_args (4) */
2733  switch (CxTYPE(cx)) {
2734   case CXt_SUB:
2735   case CXt_FORMAT: {
2736    GV *cvgv = CvGV(dbcx->blk_sub.cv);
2737    if (cvgv && isGV(cvgv)) {
2738     SV *sv = sv_newmortal();
2739     gv_efullname3(sv, cvgv, NULL);
2740     PUSHs(sv);
2741    } else {
2742     PUSHs(su_newmortal_pvs("(unknown)"));
2743    }
2744    if (CxHASARGS(cx))
2745     PUSHs(&PL_sv_yes);
2746    else
2747     PUSHs(&PL_sv_no);
2748    break;
2749   }
2750   case CXt_EVAL:
2751    PUSHs(su_newmortal_pvs("(eval)"));
2752    mPUSHi(0);
2753    break;
2754   default:
2755    PUSHs(&PL_sv_undef);
2756    PUSHs(&PL_sv_undef);
2757  }
2758  /* gimme (5) */
2759  switch (su_context_gimme(cxix)) {
2760   case G_ARRAY:
2761    PUSHs(&PL_sv_yes);
2762    break;
2763   case G_SCALAR:
2764    PUSHs(&PL_sv_no);
2765    break;
2766   default: /* G_VOID */
2767    PUSHs(&PL_sv_undef);
2768    break;
2769  }
2770  /* eval text (6) and is_require (7) */
2771  switch (CxTYPE(cx)) {
2772   case CXt_EVAL:
2773    if (CxOLD_OP_TYPE(cx) == OP_ENTEREVAL) {
2774     /* eval STRING */
2775 #if SU_HAS_PERL(5, 17, 4)
2776     PUSHs(newSVpvn_flags(SvPVX(cx->blk_eval.cur_text),
2777                          SvCUR(cx->blk_eval.cur_text)-2,
2778                          SvUTF8(cx->blk_eval.cur_text)|SVs_TEMP));
2779 #else
2780     PUSHs(cx->blk_eval.cur_text);
2781 #endif
2782     PUSHs(&PL_sv_no);
2783     break;
2784    } else if (cx->blk_eval.old_namesv) {
2785     /* require */
2786     PUSHs(sv_mortalcopy(cx->blk_eval.old_namesv));
2787     PUSHs(&PL_sv_yes);
2788     break;
2789    }
2790    /* FALLTHROUGH */
2791   default:
2792    /* Anything else including eval BLOCK */
2793    PUSHs(&PL_sv_undef);
2794    PUSHs(&PL_sv_undef);
2795    break;
2796  }
2797  /* hints (8) */
2798  mPUSHi(CopHINTS_get(cop));
2799  /* warnings (9) */
2800  {
2801   SV *mask = NULL;
2802 #if SU_HAS_PERL(5, 9, 4)
2803   STRLEN *old_warnings = cop->cop_warnings;
2804 #else
2805   SV *old_warnings = cop->cop_warnings;
2806 #endif
2807   if (old_warnings == pWARN_STD) {
2808    if (PL_dowarn & G_WARN_ON)
2809     goto context_info_warnings_on;
2810    else
2811 #if SU_HAS_PERL(5, 17, 4)
2812     mask = &PL_sv_undef;
2813 #else
2814     goto context_info_warnings_off;
2815 #endif
2816   } else if (old_warnings == pWARN_NONE) {
2817 #if !SU_HAS_PERL(5, 17, 4)
2818 context_info_warnings_off:
2819 #endif
2820    mask = su_newmortal_pvn(WARN_NONEstring, WARNsize);
2821   } else if (old_warnings == pWARN_ALL) {
2822    HV *bits;
2823 context_info_warnings_on:
2824 #if SU_HAS_PERL(5, 8, 7)
2825    bits = get_hv("warnings::Bits", 0);
2826    if (bits) {
2827     SV **bits_all = hv_fetchs(bits, "all", FALSE);
2828     if (bits_all)
2829      mask = sv_mortalcopy(*bits_all);
2830    }
2831 #endif
2832    if (!mask)
2833     mask = su_newmortal_pvn(WARN_ALLstring, WARNsize);
2834   } else {
2835 #if SU_HAS_PERL(5, 9, 4)
2836    mask = su_newmortal_pvn((char *) (old_warnings + 1), old_warnings[0]);
2837 #else
2838    mask = sv_mortalcopy(old_warnings);
2839 #endif
2840   }
2841   PUSHs(mask);
2842  }
2843 #if SU_HAS_PERL(5, 10, 0)
2844  /* hints hash (10) */
2845  {
2846   COPHH *hints_hash = CopHINTHASH_get(cop);
2847   if (hints_hash) {
2848    SV *rhv = sv_2mortal(newRV_noinc((SV *) cophh_2hv(hints_hash, 0)));
2849    PUSHs(rhv);
2850   } else {
2851    PUSHs(&PL_sv_undef);
2852   }
2853  }
2854 #endif
2855  XSRETURN(SU_INFO_COUNT);
2856
2857 void
2858 reap(SV *hook, ...)
2859 PROTOTYPE: &;$
2860 PREINIT:
2861  I32 cxix;
2862  su_ud_reap *ud;
2863 CODE:
2864  SU_GET_CONTEXT(1, 1, su_context_skip_db(cxstack_ix));
2865  cxix = su_context_normalize_down(cxix);
2866  Newx(ud, 1, su_ud_reap);
2867  SU_UD_ORIGIN(ud) = NULL;
2868  SU_UD_TYPE(ud)   = SU_UD_TYPE_REAP;
2869  ud->cb = newSVsv(hook);
2870  su_init(ud, cxix, SU_SAVE_DESTRUCTOR_SIZE);
2871
2872 void
2873 localize(SV *sv, SV *val, ...)
2874 PROTOTYPE: $$;$
2875 PREINIT:
2876  I32 cxix;
2877  I32 size;
2878  su_ud_localize *ud;
2879 CODE:
2880  SU_GET_CONTEXT(2, 2, su_context_skip_db(cxstack_ix));
2881  cxix = su_context_normalize_down(cxix);
2882  Newx(ud, 1, su_ud_localize);
2883  SU_UD_ORIGIN(ud) = NULL;
2884  SU_UD_TYPE(ud)   = SU_UD_TYPE_LOCALIZE;
2885  size = su_ud_localize_init(ud, sv, val, NULL);
2886  su_init(ud, cxix, size);
2887
2888 void
2889 localize_elem(SV *sv, SV *elem, SV *val, ...)
2890 PROTOTYPE: $$$;$
2891 PREINIT:
2892  I32 cxix;
2893  I32 size;
2894  su_ud_localize *ud;
2895 CODE:
2896  if (SvTYPE(sv) >= SVt_PVGV)
2897   croak("Can't infer the element localization type from a glob and the value");
2898  SU_GET_CONTEXT(3, 3, su_context_skip_db(cxstack_ix));
2899  cxix = su_context_normalize_down(cxix);
2900  Newx(ud, 1, su_ud_localize);
2901  SU_UD_ORIGIN(ud) = NULL;
2902  SU_UD_TYPE(ud)   = SU_UD_TYPE_LOCALIZE;
2903  size = su_ud_localize_init(ud, sv, val, elem);
2904  if (SU_UD_PRIVATE(ud) != SVt_PVAV && SU_UD_PRIVATE(ud) != SVt_PVHV) {
2905   SU_UD_LOCALIZE_FREE(ud);
2906   croak("Can't localize an element of something that isn't an array or a hash");
2907  }
2908  su_init(ud, cxix, size);
2909
2910 void
2911 localize_delete(SV *sv, SV *elem, ...)
2912 PROTOTYPE: $$;$
2913 PREINIT:
2914  I32 cxix;
2915  I32 size;
2916  su_ud_localize *ud;
2917 CODE:
2918  SU_GET_CONTEXT(2, 2, su_context_skip_db(cxstack_ix));
2919  cxix = su_context_normalize_down(cxix);
2920  Newx(ud, 1, su_ud_localize);
2921  SU_UD_ORIGIN(ud) = NULL;
2922  SU_UD_TYPE(ud)   = SU_UD_TYPE_LOCALIZE;
2923  size = su_ud_localize_init(ud, sv, NULL, elem);
2924  su_init(ud, cxix, size);
2925
2926 void
2927 uplevel(SV *code, ...)
2928 PROTOTYPE: &@
2929 PREINIT:
2930  I32 cxix, ret, args = 0;
2931 PPCODE:
2932  if (SvROK(code))
2933   code = SvRV(code);
2934  if (SvTYPE(code) < SVt_PVCV)
2935   croak("First argument to uplevel must be a code reference");
2936  SU_GET_CONTEXT(1, items - 1, cxstack_ix);
2937  do {
2938   PERL_CONTEXT *cx = cxstack + cxix;
2939   switch (CxTYPE(cx)) {
2940    case CXt_EVAL:
2941     croak("Can't uplevel to an eval frame");
2942    case CXt_FORMAT:
2943     croak("Can't uplevel to a format frame");
2944    case CXt_SUB:
2945     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2946      continue;
2947     if (items > 1) {
2948      PL_stack_sp--;
2949      args = items - 2;
2950     }
2951     /* su_uplevel() takes care of extending the stack if needed. */
2952     ret = su_uplevel((CV *) code, cxix, args);
2953     XSRETURN(ret);
2954    default:
2955     break;
2956   }
2957  } while (--cxix >= 0);
2958  croak("Can't uplevel outside a subroutine");
2959
2960 void
2961 uid(...)
2962 PROTOTYPE: ;$
2963 PREINIT:
2964  I32 cxix;
2965  SV *uid;
2966 PPCODE:
2967  SU_GET_CONTEXT(0, 0, su_context_here());
2968  uid = su_uid_get(cxix);
2969  EXTEND(SP, 1);
2970  PUSHs(uid);
2971  XSRETURN(1);
2972
2973 void
2974 validate_uid(SV *uid)
2975 PROTOTYPE: $
2976 PREINIT:
2977  SV *ret;
2978 PPCODE:
2979  ret = su_uid_validate(uid) ? &PL_sv_yes : &PL_sv_no;
2980  EXTEND(SP, 1);
2981  PUSHs(ret);
2982  XSRETURN(1);