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