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