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