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