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