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