Upper.xs

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