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