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