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