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