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    break;
 944   case SVt_PVHV:
 945    if (elem) {
 946     su_save_helem(GvHV(gv), elem, val);
 947     return;
 948    } else
 949     save_hash(gv);
 950    break;
 951   case SVt_PVGV:
 952    save_gp(gv, 1); /* hide previous entry in symtab */
 953    break;
 954   case SVt_PVCV:
 955    su_save_gvcv(gv);
 956    break;
 957   default:
 958    gv = (GV *) save_scalar(gv);
 959    break;
 960  }
 961
 962  if (val)
 963   SvSetMagicSV((SV *) gv, val);
 964
 965  return;
 966 }
 967
 968 /* ... Unique context ID ................................................... */
 969
 970 /* We must pass the index because XSH_CXT.uid_storage might be reallocated
 971  * between the UID fetch and the invalidation at the end of scope. */
 972
 973 typedef struct {
 974  su_ud_common ci;
 975  I32          idx;
 976 } su_ud_uid;
 977
 978 static void su_uid_drop(pTHX_ void *ud_) {
 979  su_ud_uid *ud = ud_;
 980  dXSH_CXT;
 981
 982  XSH_CXT.uid_storage.map[ud->idx].flags &= ~SU_UID_ACTIVE;
 983
 984  SU_UD_FREE(ud);
 985
 986  return;
 987 }
 988
 989 /* --- Pop a context back -------------------------------------------------- */
 990
 991 #ifdef DEBUGGING
 992 # define SU_CX_TYPENAME(T) PL_block_type[(T)]
 993 #else
 994 # if XSH_HAS_PERL(5, 23, 8)
 995 static const char *su_block_type[] = {
 996  "NULL",
 997  "WHEN",
 998  "BLOCK",
 999  "GIVEN",
1000  "LOOP_ARY",
1001  "LOOP_LAZYSV",
1002  "LOOP_LAZYIV",
1003  "LOOP_LIST",
1004  "LOOP_PLAIN",
1005  "SUB",
1006  "FORMAT",
1007  "EVAL",
1008  "SUBST"
1009 };
1010 # elif XSH_HAS_PERL(5, 11, 0)
1011 static const char *su_block_type[] = {
1012  "NULL",
1013  "WHEN",
1014  "BLOCK",
1015  "GIVEN",
1016  "LOOP_FOR",
1017  "LOOP_PLAIN",
1018  "LOOP_LAZYSV",
1019  "LOOP_LAZYIV",
1020  "SUB",
1021  "FORMAT",
1022  "EVAL",
1023  "SUBST"
1024 };
1025 # elif XSH_HAS_PERL(5, 10, 0)
1026 static const char *su_block_type[] = {
1027  "NULL",
1028  "SUB",
1029  "EVAL",
1030  "LOOP",
1031  "SUBST",
1032  "BLOCK",
1033  "FORMAT"
1034  "WHEN",
1035  "GIVEN"
1036 };
1037 # else
1038 static const char *su_block_type[] = {
1039  "NULL",
1040  "SUB",
1041  "EVAL",
1042  "LOOP",
1043  "SUBST",
1044  "BLOCK",
1045  "FORMAT"
1046 };
1047 # endif
1048 # define SU_CX_TYPENAME(T) su_block_type[(T)]
1049 #endif
1050
1051 #define SU_CXNAME(C) SU_CX_TYPENAME(CxTYPE(C))
1052
1053 /* for debugging. These indicate how many ENTERs each context type
1054  * does before the PUSHBLOCK */
1055
1056 static const int su_cxt_enter_count[] = {
1057 # if XSH_HAS_PERL(5, 23, 8)
1058   0 /* context pushes no longer do ENTERs */
1059 # elif XSH_HAS_PERL(5, 11, 0)
1060  /* NULL WHEN BLOCK GIVEN LOOP_FOR LOOP_PLAIN LOOP_LAZYSV
1061   * LOOP_LAZYIV SUB FORMAT EVAL SUBST */
1062  0, 1, 1, 1, 2, 2, 2, 2, 1, 1, 1, 0
1063 # elif XSH_HAS_PERL(5, 10, 0)
1064  /* NULL SUB EVAL LOOP SUBST BLOCK FORMAT WHEN GIVEN */
1065  0, 1, 1, 2, 0, 1, 1, 1, 1
1066 # else
1067  /* NULL SUB EVAL LOOP SUBST BLOCK FORMAT */
1068  0, 1, 1, 2, 0, 1, 1
1069 # endif
1070 };
1071
1072 /* push at least 'size' slots worth of padding onto the savestack */
1073
1074 static void su_ss_push_padding(pTHX_ void *ud, I32 size) {
1075  if (size <= 0)
1076   return;
1077  if (size < SU_SAVE_ALLOC_SIZE + 1) /* minimum possible SAVEt_ALLOC */
1078   size = SU_SAVE_ALLOC_SIZE + 1;
1079  XSH_D(su_debug_log(
1080         "%p:     push %2d padding at save_ix=%d\n",
1081          ud, size, PL_savestack_ix));
1082  save_alloc((size - SU_SAVE_ALLOC_SIZE)*sizeof(*PL_savestack), 0);
1083 }
1084
1085 static void su_pop(pTHX_ void *ud);
1086
1087 /* push an su_pop destructor onto the savestack with suitable padding.
1088  * first indicates that this is the first push of a destructor */
1089
1090 static void su_ss_push_destructor(pTHX_ void *ud, I32 depth, bool first) {
1091  su_ud_origin_elem *origin = SU_UD_ORIGIN(ud);
1092
1093  assert(first || origin[depth+1].orig_ix == PL_savestack_ix);
1094  su_ss_push_padding(aTHX_ ud,
1095     (origin[depth].orig_ix + origin[depth].offset) - PL_savestack_ix);
1096  XSH_D(su_debug_log(
1097         "%p:     push destructor at save_ix=%d depth=%d scope_ix=%d\n",
1098          ud, PL_savestack_ix, depth, PL_scopestack_ix));
1099  SAVEDESTRUCTOR_X(su_pop, ud);
1100  assert(first ||
1101         PL_savestack_ix <= origin[depth+1].orig_ix +  origin[depth+1].offset);
1102 }
1103
1104 /* this is called during each leave_scope() via SAVEDESTRUCTOR_X */
1105
1106 static void su_pop(pTHX_ void *ud) {
1107 #define su_pop(U) su_pop(aTHX_ (U))
1108  I32 depth, base, mark;
1109  su_ud_origin_elem *origin;
1110
1111  depth  = SU_UD_DEPTH(ud);
1112  origin = SU_UD_ORIGIN(ud);
1113
1114  XSH_D(su_debug_log( "%p: ### su_pop: depth=%d\n", ud, depth));
1115
1116  depth--;
1117  mark = PL_savestack_ix;
1118  base = origin[depth].orig_ix;
1119
1120  XSH_D(su_debug_log("%p:     residual savestack frame is %d(+%d)..%d\n",
1121                      ud, base, origin[depth].offset, mark));
1122
1123  if (base < mark) {
1124   XSH_D(su_debug_log("%p:     clear leftovers at %d..%d\n", ud, base, mark));
1125   leave_scope(base);
1126  }
1127  assert(PL_savestack_ix == base);
1128
1129  SU_UD_DEPTH(ud) = depth;
1130
1131  if (depth > 0) {
1132   su_ss_push_destructor(aTHX_ ud, depth-1, 0);
1133  } else {
1134   I32 offset = origin[0].offset; /* grab value before origin is freed */
1135   switch (SU_UD_TYPE(ud)) {
1136    case SU_UD_TYPE_REAP: {
1137     XSH_D(su_debug_log("%p:     === reap\n%p: depth=%d scope_ix=%d save_ix=%d\n",
1138                    ud, ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix));
1139     SAVEDESTRUCTOR_X(su_call, SU_UD_REAP_CB(ud));
1140     SU_UD_FREE(ud);
1141     break;
1142    }
1143    case SU_UD_TYPE_LOCALIZE:
1144     su_localize(ud);
1145     SU_UD_LOCALIZE_FREE(ud);
1146     break;
1147    case SU_UD_TYPE_UID:
1148     SAVEDESTRUCTOR_X(su_uid_drop, ud);
1149     break;
1150   }
1151   /* perl 5.23.8 onwards is very fussy about the return from leave_scope()
1152    * leaving PL_savestack_ix where it expects it to be */
1153   if (PL_savestack_ix < base + offset) {
1154    I32 gap = (base + offset) - PL_savestack_ix;
1155    assert(gap >= SU_SAVE_ALLOC_SIZE + 1);
1156    su_ss_push_padding(aTHX_ ud, gap);
1157   }
1158   assert(PL_savestack_ix == base + offset);
1159  }
1160
1161  XSH_D(su_debug_log("%p:     end pop: ss_ix=%d\n", ud, PL_savestack_ix));
1162 }
1163
1164 /* --- Initialize the stack and the action userdata ------------------------ */
1165
1166 static void su_init(pTHX_ void *ud, I32 cxix, I32 size) {
1167 #define su_init(U, C, S) su_init(aTHX_ (U), (C), (S))
1168  I32 i, depth;
1169  su_ud_origin_elem *origin;
1170  I32 cur_cx_ix;
1171  I32 cur_scope_ix;
1172
1173  XSH_D(su_debug_log("%p: ### su_init(cxix=%d, size=%d)\n", ud, cxix, size));
1174
1175  depth = PL_scopestack_ix - cxstack[cxix].blk_oldscopesp;
1176 #if SU_HAS_NEW_CXT
1177  depth += (cxstack_ix - cxix); /* each context frame holds 1 scope */
1178 #endif
1179  XSH_D(su_debug_log(
1180    "%p:     going down by depth=%d with scope_ix=%d save_ix=%d\n",
1181     ud, depth, PL_scopestack_ix, PL_savestack_ix));
1182
1183  /* Artificially increase the position of each savestack frame boundary
1184   * to make space to squeeze in a 'size' sized entry (first one) or a
1185   * SU_SAVE_DESTRUCTOR_SIZE sized entry (higher ones). In addition, make
1186   * sure that each boundary is higher than the previous, so that *every*
1187   * scope exit triggers a call to leave_scope(). Each scope exit will call
1188   * the su_pop() destructor, which is responsible for: freeing any
1189   * savestack entries below the artificially raised floor; then pushing a
1190   * new destructor in that space. On the final pop, the "real" savestack
1191   * action is pushed rather than another destructor.
1192   *
1193   * On older perls, savestack frame boundaries are specified by a range of
1194   * scopestack entries (one per ENTER). Each scope entry typically does
1195   * one or two ENTERs followed by a PUSHBLOCK. Thus the
1196   * cx->blku_oldscopesp field set by the PUSHBLOCK points to the next free
1197   * slot, which is one above the last of the ENTERs. In the debugging
1198   * output we indicate that by bracketing the ENTERs directly preceding
1199   * that context push with dashes, e.g.:
1200   *
1201   *   13b98d8:     ------------------
1202   *   13b98d8:                 ENTER origin[0] scope[3] savestack=3+3
1203   *   13b98d8:                 ENTER origin[1] scope[4] savestack=9+3
1204   *   13b98d8:     cx=1  LOOP_LAZYIV
1205   *   13b98d8:     ------------------
1206   *
1207   * In addition to context stack pushes, other activities can push ENTERs
1208   * too, such as grep expr and XS sub calls.
1209   *
1210   * For newer perls (SU_HAS_NEW_CXT), a context push no longer does any
1211   * ENTERs; instead the old savestack position is stored in the new
1212   * cx->blk_oldsaveix field; thus this field specifies an additional
1213   * savestack frame boundary point in addition to the scopestack entries,
1214   * and will also need adjusting.
1215   *
1216   * We record the original and modified position of each boundary in the
1217   * origin array.
1218   *
1219   * The passed cxix argument represents the scope we wish to inject into;
1220   * we have to adjust all the savestack frame boundaries above (but not
1221   * including) that context.
1222   */
1223
1224  Newx(origin, depth, su_ud_origin_elem);
1225
1226  cur_cx_ix  = cxix;
1227  cur_scope_ix = cxstack[cxix].blk_oldscopesp;
1228 #if SU_HAS_NEW_CXT
1229  XSH_D(su_debug_log("%p:     cx=%-2d %-11s\n",
1230       ud, cur_cx_ix, SU_CXNAME(cxstack+cur_cx_ix)));
1231  cur_cx_ix++;
1232 #endif
1233
1234  for (i = 0; cur_scope_ix < PL_scopestack_ix; i++) {
1235   I32 *ixp;
1236   I32 offset;
1237
1238 #if SU_HAS_NEW_CXT
1239
1240   if (   cur_cx_ix <= cxstack_ix
1241       && cur_scope_ix == cxstack[cur_cx_ix].blk_oldscopesp
1242   )
1243    ixp = &(cxstack[cur_cx_ix++].blk_oldsaveix);
1244   else
1245    ixp = &PL_scopestack[cur_scope_ix++]; /* an ENTER pushed after cur context */
1246
1247 #else
1248
1249   XSH_D({
1250    if (cur_cx_ix <= cxstack_ix) {
1251     if (cur_scope_ix == cxstack[cur_cx_ix].blk_oldscopesp) {
1252      su_debug_log(
1253        "%p:     cx=%-2d %s\n%p:     ------------------\n",
1254        ud, cur_cx_ix, SU_CXNAME(cxstack+cur_cx_ix), ud);
1255      cur_cx_ix++;
1256     }
1257     else if (cur_scope_ix + su_cxt_enter_count[CxTYPE(cxstack+cur_cx_ix)]
1258              == cxstack[cur_cx_ix].blk_oldscopesp)
1259      su_debug_log("%p:     ------------------\n", ud);
1260    }
1261   });
1262   ixp = &PL_scopestack[cur_scope_ix++];
1263
1264 #endif
1265
1266   if (i == 0)
1267    offset = size;
1268   else {
1269    /* we have three constraints to satisfy:
1270     * 1) Each adjusted offset must be at least SU_SAVE_DESTRUCTOR_SIZE
1271     *    above its unadjusted boundary, so that there is space to inject a
1272     *    destructor into the outer scope.
1273     * 2) Each adjusted boundary must be at least SU_SAVE_DESTRUCTOR_SIZE
1274     *    higher than the previous adjusted boundary, so that a new
1275     *    destructor can be added below the Nth adjusted frame boundary,
1276     *    but be within the (N-1)th adjusted frame and so be triggered on
1277     *    the next scope exit;
1278     * 3) If the adjustment needs to be greater than SU_SAVE_DESTRUCTOR_SIZE,
1279     *    then it should be greater by an amount of at least the minimum
1280     *    pad side, so a destructor and padding can be pushed.
1281     */
1282    I32 pad;
1283    offset = SU_SAVE_DESTRUCTOR_SIZE; /* rule 1 */
1284    pad = (origin[i-1].orig_ix + origin[i-1].offset) + offset - (*ixp + offset);
1285    if (pad > 0) { /* rule 2 */
1286     if (pad < SU_SAVE_ALLOC_SIZE + 1) /* rule 3 */
1287      pad = SU_SAVE_ALLOC_SIZE + 1;
1288     offset += pad;
1289    }
1290   }
1291
1292   origin[i].offset = offset;
1293   origin[i].orig_ix = *ixp;
1294   *ixp += offset;
1295
1296 #if SU_HAS_NEW_CXT
1297   XSH_D({
1298    if (ixp == &PL_scopestack[cur_scope_ix-1])
1299     su_debug_log(
1300      "%p:           ENTER       origin[%d] scope[%d] savestack=%d+%d\n",
1301       ud, i, cur_scope_ix, origin[i].orig_ix, origin[i].offset);
1302    else
1303     su_debug_log(
1304      "%p:     cx=%-2d %-11s origin[%d] scope[%d] savestack=%d+%d\n",
1305       ud, cur_cx_ix-1, SU_CXNAME(cxstack+cur_cx_ix-1),
1306       i, cur_scope_ix, origin[i].orig_ix, origin[i].offset);
1307   });
1308 #else
1309   XSH_D(su_debug_log(
1310     "%p:                 ENTER origin[%d] scope[%d] savestack=%d+%d\n",
1311      ud, i, cur_scope_ix, origin[i].orig_ix, origin[i].offset));
1312 #endif
1313
1314  }
1315
1316  assert(i == depth);
1317
1318  SU_UD_DEPTH(ud)  = depth;
1319  SU_UD_ORIGIN(ud) = origin;
1320
1321  su_ss_push_destructor(aTHX_ ud, depth-1, 1);
1322 }
1323
1324 /* --- Unwind stack -------------------------------------------------------- */
1325
1326 static void su_unwind(pTHX_ void *ud_) {
1327  dXSH_CXT;
1328  I32 cxix  = XSH_CXT.unwind_storage.cxix;
1329  I32 items = XSH_CXT.unwind_storage.items;
1330  I32 mark;
1331
1332  PERL_UNUSED_VAR(ud_);
1333
1334  PL_stack_sp = XSH_CXT.unwind_storage.savesp;
1335 #if XSH_HAS_PERL(5, 19, 4)
1336  {
1337   I32 i;
1338   SV **sp = PL_stack_sp;
1339   for (i = -items + 1; i <= 0; ++i)
1340    if (!SvTEMP(sp[i]))
1341     sv_2mortal(SvREFCNT_inc(sp[i]));
1342  }
1343 #endif
1344
1345  if (cxstack_ix > cxix)
1346   dounwind(cxix);
1347
1348  mark = PL_markstack[cxstack[cxix].blk_oldmarksp];
1349  PUSHMARK(PL_stack_sp - items);
1350
1351  XSH_D({
1352   I32 gimme = GIMME_V;
1353   su_debug_log("%p: cx=%d gimme=%s items=%d sp=%d oldmark=%d mark=%d\n",
1354                 &XSH_CXT, cxix,
1355                 gimme == G_VOID ? "void" : gimme == G_ARRAY ? "list" : "scalar",
1356                 items, PL_stack_sp - PL_stack_base, *PL_markstack_ptr, mark);
1357  });
1358
1359  PL_op = (OP *) &(XSH_CXT.unwind_storage.return_op);
1360  PL_op = PL_op->op_ppaddr(aTHX);
1361
1362  *PL_markstack_ptr = mark;
1363
1364  XSH_CXT.unwind_storage.proxy_op.op_next = PL_op;
1365  PL_op = &(XSH_CXT.unwind_storage.proxy_op);
1366 }
1367
1368 /* --- Yield --------------------------------------------------------------- */
1369
1370 #if XSH_HAS_PERL(5, 10, 0)
1371 # define SU_RETOP_SUB(C)   ((C)->blk_sub.retop)
1372 # define SU_RETOP_EVAL(C)  ((C)->blk_eval.retop)
1373 # define SU_RETOP_LOOP(C)  ((C)->blk_loop.my_op->op_lastop->op_next)
1374 # define SU_RETOP_GIVEN(C) ((C)->blk_givwhen.leave_op->op_next)
1375 #else
1376 # define SU_RETOP_SUB(C)  ((C)->blk_oldretsp > 0 ? PL_retstack[(C)->blk_oldretsp - 1] : NULL)
1377 # define SU_RETOP_EVAL(C) SU_RETOP_SUB(C)
1378 # define SU_RETOP_LOOP(C) ((C)->blk_loop.last_op->op_next)
1379 #endif
1380
1381 static void su_yield(pTHX_ void *ud_) {
1382  dXSH_CXT;
1383  PERL_CONTEXT *cx;
1384  const char   *which = ud_;
1385  I32 cxix      = XSH_CXT.yield_storage.cxix;
1386  I32 items     = XSH_CXT.yield_storage.items;
1387  opcode  type  = OP_NULL;
1388  U8      flags = 0;
1389  OP     *next;
1390
1391  PERL_UNUSED_VAR(ud_);
1392
1393  cx = cxstack + cxix;
1394  switch (CxTYPE(cx)) {
1395   case CXt_BLOCK: {
1396    I32 i, cur = cxstack_ix, n = 1;
1397    OP *o = NULL;
1398    /* Is this actually a given/when block? This may occur only when yield was
1399     * called with HERE (or nothing) as the context. */
1400 #if XSH_HAS_PERL(5, 10, 0)
1401    if (cxix > 0) {
1402     PERL_CONTEXT *prev = cx - 1;
1403     U8       prev_type = CxTYPE(prev);
1404     if ((prev_type == CXt_GIVEN || prev_type == CXt_WHEN)
1405         && (prev->blk_oldcop == cx->blk_oldcop)) {
1406      cxix--;
1407      cx = prev;
1408      if (prev_type == CXt_GIVEN)
1409       goto cxt_given;
1410      else
1411       goto cxt_when;
1412     }
1413    }
1414 #endif
1415    type  = OP_LEAVE;
1416    next  = NULL;
1417    /* Bare blocks (that appear as do { ... } blocks, map { ... } blocks or
1418     * constant folded blcoks) don't need to save the op to return to anywhere
1419     * since 'last' isn't supposed to work inside them. So we climb higher in
1420     * the context stack until we reach a context that has a return op (i.e. a
1421     * sub, an eval, a format or a real loop), recording how many blocks we
1422     * crossed. Then we follow the op_next chain until we get to the leave op
1423     * that closes the original block, which we are assured to reach since
1424     * everything is static (the blocks we have crossed cannot be evals or
1425     * subroutine calls). */
1426    for (i = cxix + 1; i <= cur; ++i) {
1427     PERL_CONTEXT *cx2 = cxstack + i;
1428     switch (CxTYPE(cx2)) {
1429      case CXt_BLOCK:
1430       ++n;
1431       break;
1432      case CXt_SUB:
1433      case CXt_FORMAT:
1434       o = SU_RETOP_SUB(cx2);
1435       break;
1436      case CXt_EVAL:
1437       o = SU_RETOP_EVAL(cx2);
1438       break;
1439 #if XSH_HAS_PERL(5, 11, 0)
1440 # if XSH_HAS_PERL(5, 23, 8)
1441      case CXt_LOOP_ARY:
1442      case CXt_LOOP_LIST:
1443 # else
1444      case CXt_LOOP_FOR:
1445 # endif
1446      case CXt_LOOP_PLAIN:
1447      case CXt_LOOP_LAZYSV:
1448      case CXt_LOOP_LAZYIV:
1449 #else
1450      case CXt_LOOP:
1451 #endif
1452       o = SU_RETOP_LOOP(cx2);
1453       break;
1454     }
1455     if (o)
1456      break;
1457    }
1458    if (!o)
1459     o = PL_op;
1460    while (n && o) {
1461     /* We may find other enter/leave blocks on our way to the matching leave.
1462      * Make sure the depth is incremented/decremented appropriately. */
1463     if (o->op_type == OP_ENTER) {
1464      ++n;
1465     } else if (o->op_type == OP_LEAVE) {
1466      --n;
1467      if (!n) {
1468       next = o->op_next;
1469       break;
1470      }
1471     }
1472     o = o->op_next;
1473    }
1474    break;
1475   }
1476   case CXt_SUB:
1477   case CXt_FORMAT:
1478    type = OP_LEAVESUB;
1479    next = SU_RETOP_SUB(cx);
1480    break;
1481   case CXt_EVAL:
1482    type = CxTRYBLOCK(cx) ? OP_LEAVETRY : OP_LEAVEEVAL;
1483    next = SU_RETOP_EVAL(cx);
1484    break;
1485 #if XSH_HAS_PERL(5, 11, 0)
1486 # if XSH_HAS_PERL(5, 23, 8)
1487   case CXt_LOOP_ARY:
1488   case CXt_LOOP_LIST:
1489 # else
1490   case CXt_LOOP_FOR:
1491 # endif
1492   case CXt_LOOP_PLAIN:
1493   case CXt_LOOP_LAZYSV:
1494   case CXt_LOOP_LAZYIV:
1495 #else
1496   case CXt_LOOP:
1497 #endif
1498    type = OP_LEAVELOOP;
1499    next = SU_RETOP_LOOP(cx);
1500    break;
1501 #if XSH_HAS_PERL(5, 10, 0)
1502   case CXt_GIVEN:
1503 cxt_given:
1504    type = OP_LEAVEGIVEN;
1505    next = SU_RETOP_GIVEN(cx);
1506    break;
1507   case CXt_WHEN:
1508 cxt_when:
1509 #if XSH_HAS_PERL(5, 15, 1)
1510    type   = OP_LEAVEWHEN;
1511 #else
1512    type   = OP_BREAK;
1513    flags |= OPf_SPECIAL;
1514 #endif
1515    next   = NULL;
1516    break;
1517 #endif
1518   case CXt_SUBST:
1519    croak("%s() can't target a substitution context", which);
1520    break;
1521   default:
1522    croak("%s() doesn't know how to leave a %s context",
1523           which,                         SU_CXNAME(cxstack + cxix));
1524    break;
1525  }
1526
1527  PL_stack_sp = XSH_CXT.yield_storage.savesp;
1528 #if XSH_HAS_PERL(5, 19, 4)
1529  {
1530   I32 i;
1531   SV **sp = PL_stack_sp;
1532   for (i = -items + 1; i <= 0; ++i)
1533    if (!SvTEMP(sp[i]))
1534     sv_2mortal(SvREFCNT_inc(sp[i]));
1535  }
1536 #endif
1537
1538  if (cxstack_ix > cxix)
1539   dounwind(cxix);
1540
1541  /* Copy the arguments passed to yield() where the leave op expects to find
1542   * them. */
1543  if (items)
1544   Move(PL_stack_sp - items + 1, PL_stack_base + cx->blk_oldsp + 1, items, SV *);
1545  PL_stack_sp = PL_stack_base + cx->blk_oldsp + items;
1546
1547  flags |= OP_GIMME_REVERSE(cx->blk_gimme);
1548
1549  XSH_CXT.yield_storage.leave_op.op_type   = type;
1550  XSH_CXT.yield_storage.leave_op.op_ppaddr = PL_ppaddr[type];
1551  XSH_CXT.yield_storage.leave_op.op_flags  = flags;
1552  XSH_CXT.yield_storage.leave_op.op_next   = next;
1553
1554  PL_op = (OP *) &(XSH_CXT.yield_storage.leave_op);
1555  PL_op = PL_op->op_ppaddr(aTHX);
1556
1557  XSH_CXT.yield_storage.proxy_op.op_next = PL_op;
1558  PL_op = &(XSH_CXT.yield_storage.proxy_op);
1559 }
1560
1561 /* --- Uplevel ------------------------------------------------------------- */
1562
1563 #define SU_UPLEVEL_SAVE(f, t) STMT_START { sud->old_##f = PL_##f; PL_##f = (t); } STMT_END
1564 #define SU_UPLEVEL_RESTORE(f) STMT_START { PL_##f = sud->old_##f; } STMT_END
1565
1566 static su_uplevel_ud *su_uplevel_storage_new(pTHX_ I32 cxix) {
1567 #define su_uplevel_storage_new(I) su_uplevel_storage_new(aTHX_ (I))
1568  su_uplevel_ud *sud;
1569  UV depth;
1570  dXSH_CXT;
1571
1572  sud = XSH_CXT.uplevel_storage.root;
1573  if (sud) {
1574   XSH_CXT.uplevel_storage.root = sud->next;
1575   XSH_CXT.uplevel_storage.count--;
1576  } else {
1577   sud = su_uplevel_ud_new();
1578  }
1579
1580  sud->next = XSH_CXT.uplevel_storage.top;
1581  XSH_CXT.uplevel_storage.top = sud;
1582
1583  depth = su_uid_depth(cxix);
1584  su_uid_storage_dup(&sud->tmp_uid_storage, &XSH_CXT.uid_storage, depth);
1585  sud->old_uid_storage = XSH_CXT.uid_storage;
1586  XSH_CXT.uid_storage  = sud->tmp_uid_storage;
1587
1588  return sud;
1589 }
1590
1591 #if XSH_HAS_PERL(5, 13, 7)
1592
1593 static void su_uplevel_storage_delete(pTHX_ su_uplevel_ud *sud) {
1594 #define su_uplevel_storage_delete(S) su_uplevel_storage_delete(aTHX_ (S))
1595  dXSH_CXT;
1596
1597  sud->tmp_uid_storage = XSH_CXT.uid_storage;
1598  XSH_CXT.uid_storage   = sud->old_uid_storage;
1599  {
1600   su_uid *map;
1601   STRLEN  i, alloc;
1602   map   = sud->tmp_uid_storage.map;
1603   alloc = sud->tmp_uid_storage.alloc;
1604   for (i = 0; i < alloc; ++i)
1605    map[i].flags &= ~SU_UID_ACTIVE;
1606  }
1607  XSH_CXT.uplevel_storage.top = sud->next;
1608
1609  if (XSH_CXT.uplevel_storage.count >= SU_UPLEVEL_STORAGE_SIZE) {
1610   su_uplevel_ud_delete(sud);
1611  } else {
1612   sud->next = XSH_CXT.uplevel_storage.root;
1613   XSH_CXT.uplevel_storage.root = sud;
1614   XSH_CXT.uplevel_storage.count++;
1615  }
1616 }
1617
1618 #endif
1619
1620 static int su_uplevel_goto_static(const OP *o) {
1621  for (; o; o = OpSIBLING(o)) {
1622   /* goto ops are unops with kids. */
1623   if (!(o->op_flags & OPf_KIDS))
1624    continue;
1625
1626   switch (o->op_type) {
1627    case OP_LEAVEEVAL:
1628    case OP_LEAVETRY:
1629     /* Don't care about gotos inside eval, as they are forbidden at run time. */
1630     break;
1631    case OP_GOTO:
1632     return 1;
1633    default:
1634     if (su_uplevel_goto_static(((const UNOP *) o)->op_first))
1635      return 1;
1636     break;
1637   }
1638  }
1639
1640  return 0;
1641 }
1642
1643 #if !SU_HAS_NEW_CXT && SU_UPLEVEL_HIJACKS_RUNOPS
1644
1645 static int su_uplevel_goto_runops(pTHX) {
1646 #define su_uplevel_goto_runops() su_uplevel_goto_runops(aTHX)
1647  register OP *op;
1648  dVAR;
1649
1650  op = PL_op;
1651  do {
1652   if (op->op_type == OP_GOTO) {
1653    AV  *argarray = NULL;
1654    I32  cxix;
1655
1656    for (cxix = cxstack_ix; cxix >= 0; --cxix) {
1657     const PERL_CONTEXT *cx = cxstack + cxix;
1658
1659     switch (CxTYPE(cx)) {
1660      case CXt_SUB:
1661       if (CxHASARGS(cx)) {
1662        argarray = cx->blk_sub.argarray;
1663        goto done;
1664       }
1665       break;
1666      case CXt_EVAL:
1667      case CXt_FORMAT:
1668       goto done;
1669      default:
1670       break;
1671     }
1672    }
1673
1674 done:
1675    if (argarray) {
1676     dXSH_CXT;
1677
1678     if (XSH_CXT.uplevel_storage.top->cxix == cxix) {
1679      AV  *args  = GvAV(PL_defgv);
1680      I32  items = AvFILLp(args);
1681
1682      av_extend(argarray, items);
1683      Copy(AvARRAY(args), AvARRAY(argarray), items + 1, SV *);
1684      AvFILLp(argarray) = items;
1685     }
1686    }
1687   }
1688
1689   PL_op = op = op->op_ppaddr(aTHX);
1690
1691 #if !XSH_HAS_PERL(5, 13, 0)
1692   PERL_ASYNC_CHECK();
1693 #endif
1694  } while (op);
1695
1696  TAINT_NOT;
1697
1698  return 0;
1699 }
1700
1701 #endif /* SU_UPLEVEL_HIJACKS_RUNOPS */
1702
1703 #define su_at_underscore(C) PadARRAY(PadlistARRAY(CvPADLIST(C))[CvDEPTH(C)])[0]
1704
1705 #if SU_HAS_NEW_CXT
1706
1707 static void su_uplevel_restore_new(pTHX_ void *sus_) {
1708  su_uplevel_ud *sud = sus_;
1709  PERL_CONTEXT *cx;
1710  I32 i;
1711  U8 *saved_cxtypes = sud->cxtypes;
1712
1713  for (i = 0; i < sud->gap; i++) {
1714   PERL_CONTEXT *cx = cxstack + sud->cxix + i;
1715    XSH_D(su_debug_log("su_uplevel_restore: i=%d cxix=%d type %s => %s\n",
1716         i, cx-cxstack, SU_CX_TYPENAME(CxTYPE(cx)),
1717         SU_CX_TYPENAME(saved_cxtypes[i] & CXTYPEMASK)));
1718    cx->cx_type = saved_cxtypes[i];
1719  }
1720  Safefree(saved_cxtypes);
1721
1722  /* renamed is a copy of callback, but they share the same CvPADLIST.
1723   * At this point any calls to renamed should have exited so that its
1724   * depth is back to that of of callback. At this point its safe to free
1725   * renamed, then undo the extra ref count that was ensuring that callback
1726   * remains alive
1727   */
1728  assert(sud->renamed);
1729  assert(sud->callback);
1730
1731  CvDEPTH(sud->callback)--;
1732  assert(CvDEPTH(sud->callback) == CvDEPTH(sud->renamed));
1733  if (!CvISXSUB(sud->renamed)) {
1734   CvDEPTH(sud->renamed)   = 0;
1735   CvPADLIST(sud->renamed) = NULL;
1736  }
1737  SvREFCNT_dec(sud->renamed);
1738  SvREFCNT_dec(sud->callback);
1739
1740  SU_UPLEVEL_RESTORE(curcop);
1741
1742  su_uplevel_storage_delete(sud);
1743
1744  return;
1745 }
1746
1747 #else
1748
1749 /* 5.23.7 and earlier */
1750
1751 static void su_uplevel_restore_old(pTHX_ void *sus_) {
1752  su_uplevel_ud *sud = sus_;
1753  PERL_SI *cur = sud->old_curstackinfo;
1754  PERL_SI *si  = sud->si;
1755
1756 #if SU_UPLEVEL_HIJACKS_RUNOPS
1757  if (PL_runops == su_uplevel_goto_runops)
1758   PL_runops = sud->old_runops;
1759 #endif
1760
1761  if (sud->callback) {
1762   PERL_CONTEXT *cx = cxstack + sud->cxix;
1763   AV     *argarray = MUTABLE_AV(su_at_underscore(sud->callback));
1764
1765   /* We have to fix the pad entry for @_ in the original callback because it
1766    * may have been reified. */
1767   if (AvREAL(argarray)) {
1768    const I32 fill = AvFILLp(argarray);
1769    SvREFCNT_dec(argarray);
1770    argarray = newAV();
1771    AvREAL_off(argarray);
1772    AvREIFY_on(argarray);
1773    av_extend(argarray, fill);
1774    su_at_underscore(sud->callback) = MUTABLE_SV(argarray);
1775   } else {
1776    CLEAR_ARGARRAY(argarray);
1777   }
1778
1779   /* If the old cv member is our renamed CV, it means that this place has been
1780    * reached without a goto() happening, and the old argarray member is
1781    * actually our fake argarray. Destroy it properly in that case. */
1782   if (cx->blk_sub.cv == sud->renamed) {
1783    SvREFCNT_dec(cx->blk_sub.argarray);
1784    cx->blk_sub.argarray = argarray;
1785   }
1786
1787   CvDEPTH(sud->callback)--;
1788   SvREFCNT_dec(sud->callback);
1789  }
1790
1791  /* Free the renamed CV. We must do it ourselves so that we can force the
1792   * depth to be 0, or perl would complain about it being "still in use".
1793   * But we *know* that it cannot be so. */
1794  if (sud->renamed) {
1795   if (!CvISXSUB(sud->renamed)) {
1796    CvDEPTH(sud->renamed)   = 0;
1797    CvPADLIST(sud->renamed) = NULL;
1798   }
1799   SvREFCNT_dec(sud->renamed);
1800  }
1801
1802  CATCH_SET(sud->old_catch);
1803
1804  SU_UPLEVEL_RESTORE(op);
1805
1806  /* stack_grow() wants PL_curstack so restore the old stack first */
1807  if (PL_curstackinfo == si) {
1808   PL_curstack = cur->si_stack;
1809   if (sud->old_mainstack)
1810    SU_UPLEVEL_RESTORE(mainstack);
1811   SU_UPLEVEL_RESTORE(curstackinfo);
1812
1813   if (sud->died) {
1814    CV *target = sud->target;
1815    I32 levels = 0, i;
1816
1817    /* When we die, the depth of the target CV is not updated because of the
1818     * stack switcheroo. So we have to look at all the frames between the
1819     * uplevel call and the catch block to count how many call frames to the
1820     * target CV were skipped. */
1821    for (i = cur->si_cxix; i > sud->cxix; i--) {
1822     register const PERL_CONTEXT *cx = cxstack + i;
1823
1824     if (CxTYPE(cx) == CXt_SUB) {
1825      if (cx->blk_sub.cv == target)
1826       ++levels;
1827     }
1828    }
1829
1830    /* If we died, the replacement stack was already unwinded to the first
1831     * eval frame, and all the contexts down there were popped. We don't have
1832     * to pop manually any context of the original stack, because they must
1833     * have been in the replacement stack as well (since the second was copied
1834     * from the first). Thus we only have to make sure the original stack index
1835     * points to the context just below the first eval scope under the target
1836     * frame. */
1837    for (; i >= 0; i--) {
1838     register const PERL_CONTEXT *cx = cxstack + i;
1839
1840     switch (CxTYPE(cx)) {
1841      case CXt_SUB:
1842       if (cx->blk_sub.cv == target)
1843        ++levels;
1844       break;
1845      case CXt_EVAL:
1846       goto found_it;
1847       break;
1848      default:
1849       break;
1850     }
1851    }
1852
1853 found_it:
1854    CvDEPTH(target) = sud->target_depth - levels;
1855    PL_curstackinfo->si_cxix = i - 1;
1856
1857 #if !XSH_HAS_PERL(5, 13, 1)
1858    /* Since $@ was maybe localized between the target frame and the uplevel
1859     * call, we forcefully flush the save stack to get rid of it and then
1860     * reset $@ to its proper value. Note that the the call to
1861     * su_uplevel_restore() must happen before the "reset $@" item of the save
1862     * stack is processed, as uplevel was called after the localization.
1863     * Andrew's changes to how $@ was handled, which were mainly integrated
1864     * between perl 5.13.0 and 5.13.1, fixed this. */
1865    if (ERRSV && SvTRUE(ERRSV)) {
1866     register const PERL_CONTEXT *cx = cxstack + i; /* This is the eval scope */
1867     SV *errsv = SvREFCNT_inc(ERRSV);
1868     PL_scopestack_ix = cx->blk_oldscopesp;
1869     leave_scope(PL_scopestack[PL_scopestack_ix]);
1870     sv_setsv(ERRSV, errsv);
1871     SvREFCNT_dec(errsv);
1872    }
1873 #endif
1874   }
1875  }
1876
1877  SU_UPLEVEL_RESTORE(curcop);
1878
1879  SvREFCNT_dec(sud->target);
1880
1881  PL_stack_base = AvARRAY(cur->si_stack);
1882  PL_stack_sp   = PL_stack_base + AvFILLp(cur->si_stack);
1883  PL_stack_max  = PL_stack_base + AvMAX(cur->si_stack);
1884
1885  /* When an exception is thrown from the uplevel'd subroutine,
1886   * su_uplevel_restore() may be called by the LEAVE in die_unwind() (renamed
1887   * die_where() in more recent perls), which has the sad habit of keeping a
1888   * pointer to the current context frame across this call. This means that we
1889   * can't free the temporary context stack we used for the uplevel call right
1890   * now, or that pointer upwards would point to garbage. */
1891 #if XSH_HAS_PERL(5, 13, 7)
1892  /* This issue has been fixed in perl with commit 8f89e5a9, which was made
1893   * public in perl 5.13.7. */
1894  su_uplevel_storage_delete(sud);
1895 #else
1896  /* Otherwise, we just enqueue it back in the global storage list. */
1897  {
1898   dXSH_CXT;
1899
1900   sud->tmp_uid_storage = XSH_CXT.uid_storage;
1901   XSH_CXT.uid_storage  = sud->old_uid_storage;
1902
1903   XSH_CXT.uplevel_storage.top  = sud->next;
1904   sud->next = XSH_CXT.uplevel_storage.root;
1905   XSH_CXT.uplevel_storage.root = sud;
1906   XSH_CXT.uplevel_storage.count++;
1907  }
1908 #endif
1909
1910  return;
1911 }
1912
1913 #endif
1914
1915 static CV *su_cv_clone(pTHX_ CV *proto, GV *gv) {
1916 #define su_cv_clone(P, G) su_cv_clone(aTHX_ (P), (G))
1917  dVAR;
1918  CV *cv;
1919
1920  cv = MUTABLE_CV(newSV_type(SvTYPE(proto)));
1921
1922  CvFLAGS(cv)  = CvFLAGS(proto);
1923 #ifdef CVf_CVGV_RC
1924  CvFLAGS(cv) &= ~CVf_CVGV_RC;
1925 #endif
1926  CvDEPTH(cv)  = CvDEPTH(proto);
1927 #ifdef USE_ITHREADS
1928  CvFILE(cv)   = CvISXSUB(proto) ? CvFILE(proto) : savepv(CvFILE(proto));
1929 #else
1930  CvFILE(cv)   = CvFILE(proto);
1931 #endif
1932
1933  CvGV_set(cv, gv);
1934 #if SU_RELEASE && XSH_HAS_PERL_EXACT(5, 21, 4)
1935  CvNAMED_off(cv);
1936 #endif
1937  CvSTASH_set(cv, CvSTASH(proto));
1938  /* Commit 4c74a7df, publicized with perl 5.13.3, began to add backrefs to
1939   * stashes. CvSTASH_set() started to do it as well with commit c68d95645
1940   * (which was part of perl 5.13.7). */
1941 #if XSH_HAS_PERL(5, 13, 3) && !XSH_HAS_PERL(5, 13, 7)
1942  if (CvSTASH(proto))
1943   Perl_sv_add_backref(aTHX_ CvSTASH(proto), MUTABLE_SV(cv));
1944 #endif
1945
1946  if (CvISXSUB(proto)) {
1947   CvXSUB(cv)       = CvXSUB(proto);
1948   CvXSUBANY(cv)    = CvXSUBANY(proto);
1949  } else {
1950   OP_REFCNT_LOCK;
1951   CvROOT(cv)       = OpREFCNT_inc(CvROOT(proto));
1952   OP_REFCNT_UNLOCK;
1953   CvSTART(cv)      = CvSTART(proto);
1954   CvPADLIST(cv)    = CvPADLIST(proto);
1955  }
1956  CvOUTSIDE(cv)     = CvOUTSIDE(proto);
1957 #ifdef CVf_WEAKOUTSIDE
1958  if (!(CvFLAGS(proto) & CVf_WEAKOUTSIDE))
1959 #endif
1960   SvREFCNT_inc_simple_void(CvOUTSIDE(cv));
1961 #ifdef CvOUTSIDE_SEQ
1962  CvOUTSIDE_SEQ(cv) = CvOUTSIDE_SEQ(proto);
1963 #endif
1964
1965  if (SvPOK(proto))
1966   sv_setpvn(MUTABLE_SV(cv), SvPVX_const(proto), SvCUR(proto));
1967
1968 #ifdef CvCONST
1969  if (CvCONST(cv))
1970   CvCONST_off(cv);
1971 #endif
1972
1973  return cv;
1974 }
1975
1976 #if SU_HAS_NEW_CXT
1977
1978 /* this one-shot runops "loop" is designed to be called just before
1979  * execution of the first op following an uplevel()'s entersub. It gets a
1980  * chance to fix up the args as seen by caller(), before immediately
1981  * falling through to the previous runops loop. Note that pp_entersub is
1982  * called directly by call_sv() rather than being called from a runops
1983  * loop.
1984  */
1985
1986 static int su_uplevel_runops_hook_entersub(pTHX) {
1987  OP *op = PL_op;
1988  dXSH_CXT;
1989  su_uplevel_ud *sud = XSH_CXT.uplevel_storage.top;
1990
1991  /* Create a new array containing a copy of the original sub's call args,
1992   * then stick it in PL_curpad[0] of the current running sub so that
1993   * thay will be seen by caller().
1994   */
1995  assert(sud);
1996  if (sud->argarray) {
1997   AV *av = newAV();
1998   AvREAL_off(av);
1999   AvREIFY_on(av);
2000   av_extend(av, AvMAX(sud->argarray));
2001   AvFILLp(av) = AvFILLp(sud->argarray);
2002   Copy(AvARRAY(sud->argarray), AvARRAY(av), AvFILLp(av) + 1, SV *);
2003
2004   /* should be referenced by PL_curpad[0] and *_ */
2005   assert(SvREFCNT(PL_curpad[0]) > 1);
2006   SvREFCNT_dec(PL_curpad[0]);
2007
2008   PL_curpad[0] = (SV*)av;
2009  }
2010
2011  /* undo the temporary runops hook and fall through to a real runops loop. */
2012  assert(sud->old_runops != su_uplevel_runops_hook_entersub);
2013  PL_runops = sud->old_runops;
2014  CALLRUNOPS(aTHX);
2015  return 0;
2016 }
2017
2018 static I32 su_uplevel_new(pTHX_ CV *callback, I32 cxix, I32 args) {
2019  su_uplevel_ud *sud;
2020  U8 *saved_cxtypes;
2021  I32 i, ret;
2022  I32  gimme;
2023  CV *base_cv = cxstack[cxix].blk_sub.cv;
2024  dSP;
2025
2026  assert(CxTYPE(&cxstack[cxix]) == CXt_SUB);
2027
2028  ENTER;
2029
2030  gimme = GIMME_V;
2031
2032  /* At this point SP points to the top arg.
2033   * Shuffle the args down by one, eliminating the CV slot */
2034  Move(SP - args + 1, SP - args, args, SV*);
2035  SP--;
2036  PUSHMARK(SP - args);
2037  PUTBACK;
2038
2039  sud = su_uplevel_storage_new(cxix);
2040
2041  sud->cxix     = cxix;
2042  sud->callback = (CV*)SvREFCNT_inc_simple(callback);
2043  sud->renamed  = NULL;
2044  sud->gap      = cxstack_ix - cxix + 1;
2045  sud->argarray = NULL;
2046
2047  Newx(saved_cxtypes, sud->gap, U8);
2048  sud->cxtypes = saved_cxtypes;
2049
2050  SAVEDESTRUCTOR_X(su_uplevel_restore_new, sud);
2051  SU_UPLEVEL_SAVE(curcop, cxstack[cxix].blk_oldcop);
2052
2053 /* temporarily change the type of any contexts to NULL, so they're
2054  * invisible to caller() etc. */
2055  for (i = 0; i < sud->gap; i++) {
2056   PERL_CONTEXT *cx = cxstack + cxix + i;
2057   saved_cxtypes[i] = cx->cx_type; /* save type and flags */
2058   XSH_D(su_debug_log("su_uplevel: i=%d cxix=%d type %-11s => %s\n",
2059         i, cx-cxstack, SU_CX_TYPENAME(CxTYPE(cx)), SU_CX_TYPENAME(CXt_NULL)));
2060   cx->cx_type = (CXt_NULL | CXp_SU_UPLEVEL_NULLED);
2061  }
2062
2063  /* create a copy of the callback with a doctored name (as seen by
2064   * caller). It shares the padlist with callback */
2065  sud->renamed = su_cv_clone(callback, CvGV(base_cv));
2066  sud->old_runops = PL_runops;
2067
2068  if (!CvISXSUB(sud->renamed) && CxHASARGS(&cxstack[cxix])) {
2069   sud->argarray = (AV*)su_at_underscore(base_cv);
2070   assert(PL_runops != su_uplevel_runops_hook_entersub);
2071   /* set up a one-shot runops hook so that we can fake up the
2072    * args as seen by caller() on return from pp_entersub */
2073   PL_runops = su_uplevel_runops_hook_entersub;
2074  }
2075
2076  CvDEPTH(callback)++; /* match what CvDEPTH(sud->renamed) is about to become */
2077
2078  ret = call_sv((SV*)sud->renamed, gimme);
2079
2080  LEAVE;
2081
2082  return ret;
2083 }
2084
2085 #else
2086
2087 static I32 su_uplevel_old(pTHX_ CV *callback, I32 cxix, I32 args) {
2088  su_uplevel_ud *sud;
2089  const PERL_CONTEXT *cx = cxstack + cxix;
2090  PERL_SI *si;
2091  PERL_SI *cur = PL_curstackinfo;
2092  SV **old_stack_sp;
2093  CV  *target;
2094  CV  *renamed;
2095  UNOP sub_op;
2096  I32  gimme;
2097  I32  old_mark, new_mark;
2098  I32  ret;
2099  dSP;
2100
2101  ENTER;
2102
2103  gimme = GIMME_V;
2104  /* Make PL_stack_sp point just before the CV. */
2105  PL_stack_sp -= args + 1;
2106  old_mark = AvFILLp(PL_curstack) = PL_stack_sp - PL_stack_base;
2107  SPAGAIN;
2108
2109  sud = su_uplevel_storage_new(cxix);
2110
2111  sud->cxix     = cxix;
2112  sud->died     = 1;
2113  sud->callback = NULL;
2114  sud->renamed  = NULL;
2115  SAVEDESTRUCTOR_X(su_uplevel_restore_old, sud);
2116
2117  si = sud->si;
2118
2119  si->si_type    = cur->si_type;
2120  si->si_next    = NULL;
2121  si->si_prev    = cur->si_prev;
2122 #ifdef DEBUGGING
2123  si->si_markoff = cx->blk_oldmarksp;
2124 #endif
2125
2126  /* Allocate enough space for all the elements of the original stack up to the
2127   * target context, plus the forthcoming arguments. */
2128  new_mark = cx->blk_oldsp;
2129  av_extend(si->si_stack, new_mark + 1 + args + 1);
2130  Copy(AvARRAY(PL_curstack), AvARRAY(si->si_stack), new_mark + 1, SV *);
2131  AvFILLp(si->si_stack) = new_mark;
2132  SU_POISON(AvARRAY(si->si_stack) + new_mark + 1, args + 1, SV *);
2133
2134  /* Specialized SWITCHSTACK() */
2135  PL_stack_base = AvARRAY(si->si_stack);
2136  old_stack_sp  = PL_stack_sp;
2137  PL_stack_sp   = PL_stack_base + AvFILLp(si->si_stack);
2138  PL_stack_max  = PL_stack_base + AvMAX(si->si_stack);
2139  SPAGAIN;
2140
2141  /* Copy the context stack up to the context just below the target. */
2142  si->si_cxix = (cxix < 0) ? -1 : (cxix - 1);
2143  if (si->si_cxmax < cxix) {
2144   /* The max size must be at least two so that GROW(max) = (max*3)/2 > max */
2145   si->si_cxmax = (cxix < 4) ? 4 : cxix;
2146   Renew(si->si_cxstack, si->si_cxmax + 1, PERL_CONTEXT);
2147  }
2148  Copy(cur->si_cxstack, si->si_cxstack, cxix, PERL_CONTEXT);
2149  SU_POISON(si->si_cxstack + cxix, si->si_cxmax + 1 - cxix, PERL_CONTEXT);
2150
2151  target            = cx->blk_sub.cv;
2152  sud->target       = (CV *) SvREFCNT_inc(target);
2153  sud->target_depth = CvDEPTH(target);
2154
2155  /* blk_oldcop is essentially needed for caller() and stack traces. It has no
2156   * run-time implication, since PL_curcop will be overwritten as soon as we
2157   * enter a sub (a sub starts by a nextstate/dbstate). Hence it's safe to just
2158   * make it point to the blk_oldcop for the target frame, so that caller()
2159   * reports the right file name, line number and lexical hints. */
2160  SU_UPLEVEL_SAVE(curcop, cx->blk_oldcop);
2161  /* Don't reset PL_markstack_ptr, or we would overwrite the mark stack below
2162   * this point. Don't reset PL_curpm either, we want the most recent matches. */
2163
2164  SU_UPLEVEL_SAVE(curstackinfo, si);
2165  /* If those two are equal, we need to fool POPSTACK_TO() */
2166  if (PL_mainstack == PL_curstack)
2167   SU_UPLEVEL_SAVE(mainstack, si->si_stack);
2168  else
2169   sud->old_mainstack = NULL;
2170  PL_curstack = si->si_stack;
2171
2172  renamed      = su_cv_clone(callback, CvGV(target));
2173  sud->renamed = renamed;
2174
2175  PUSHMARK(SP);
2176  /* Both SP and old_stack_sp point just before the CV. */
2177  Copy(old_stack_sp + 2, SP + 1, args, SV *);
2178  SP += args;
2179  PUSHs((SV *) renamed);
2180  PUTBACK;
2181
2182  Zero(&sub_op, 1, UNOP);
2183  sub_op.op_type  = OP_ENTERSUB;
2184  sub_op.op_next  = NULL;
2185  sub_op.op_flags = OP_GIMME_REVERSE(gimme) | OPf_STACKED;
2186  if (PL_DBsub)
2187   sub_op.op_flags |= OPpENTERSUB_DB;
2188
2189  SU_UPLEVEL_SAVE(op, (OP *) &sub_op);
2190
2191 #if SU_UPLEVEL_HIJACKS_RUNOPS
2192  sud->old_runops = PL_runops;
2193 #endif
2194
2195  sud->old_catch = CATCH_GET;
2196  CATCH_SET(TRUE);
2197
2198  if ((PL_op = PL_ppaddr[OP_ENTERSUB](aTHX))) {
2199   PERL_CONTEXT *sub_cx = cxstack + cxstack_ix;
2200   AV *argarray = cx->blk_sub.argarray;
2201
2202   /* If pp_entersub() returns a non-null OP, it means that the callback is not
2203    * an XSUB. */
2204
2205   sud->callback = MUTABLE_CV(SvREFCNT_inc(callback));
2206   CvDEPTH(callback)++;
2207
2208   if (CxHASARGS(cx) && argarray) {
2209    /* The call to pp_entersub() has saved the current @_ (in XS terms,
2210     * GvAV(PL_defgv)) in the savearray member, and has created a new argarray
2211     * with what we put on the stack. But we want to fake up the same arguments
2212     * as the ones in use at the context we uplevel to, so we replace the
2213     * argarray with an unreal copy of the original @_. */
2214    AV *av = newAV();
2215    AvREAL_off(av);
2216    AvREIFY_on(av);
2217    av_extend(av, AvMAX(argarray));
2218    AvFILLp(av) = AvFILLp(argarray);
2219    Copy(AvARRAY(argarray), AvARRAY(av), AvFILLp(av) + 1, SV *);
2220    sub_cx->blk_sub.argarray = av;
2221   } else {
2222    SvREFCNT_inc_simple_void(sub_cx->blk_sub.argarray);
2223   }
2224
2225   if (su_uplevel_goto_static(CvROOT(renamed))) {
2226 #if SU_UPLEVEL_HIJACKS_RUNOPS
2227    if (PL_runops != PL_runops_std) {
2228     if (PL_runops == PL_runops_dbg) {
2229      if (PL_debug)
2230       croak("uplevel() can't execute code that calls goto when debugging flags are set");
2231     } else if (PL_runops != su_uplevel_goto_runops)
2232      croak("uplevel() can't execute code that calls goto with a custom runloop");
2233    }
2234
2235    PL_runops = su_uplevel_goto_runops;
2236 #else  /* SU_UPLEVEL_HIJACKS_RUNOPS */
2237    croak("uplevel() can't execute code that calls goto before perl 5.8");
2238 #endif /* !SU_UPLEVEL_HIJACKS_RUNOPS */
2239   }
2240
2241   CALLRUNOPS(aTHX);
2242  }
2243
2244  sud->died = 0;
2245
2246  ret = PL_stack_sp - (PL_stack_base + new_mark);
2247  if (ret > 0) {
2248   AV *old_stack = sud->old_curstackinfo->si_stack;
2249
2250   if (old_mark + ret > AvMAX(old_stack)) {
2251    /* Specialized EXTEND(old_sp, ret) */
2252    av_extend(old_stack, old_mark + ret + 1);
2253    old_stack_sp = AvARRAY(old_stack) + old_mark;
2254   }
2255
2256   Copy(PL_stack_sp - ret + 1, old_stack_sp + 1, ret, SV *);
2257   PL_stack_sp        += ret;
2258   AvFILLp(old_stack) += ret;
2259  }
2260
2261  LEAVE;
2262
2263  return ret;
2264 }
2265
2266 #endif
2267
2268 /* --- Unique context ID --------------------------------------------------- */
2269
2270 static su_uid *su_uid_storage_fetch(pTHX_ UV depth) {
2271 #define su_uid_storage_fetch(D) su_uid_storage_fetch(aTHX_ (D))
2272  su_uid *map;
2273  STRLEN  alloc;
2274  dXSH_CXT;
2275
2276  map   = XSH_CXT.uid_storage.map;
2277  alloc = XSH_CXT.uid_storage.alloc;
2278
2279  if (depth >= alloc) {
2280   STRLEN i;
2281
2282   Renew(map, depth + 1, su_uid);
2283   for (i = alloc; i <= depth; ++i) {
2284    map[i].seq   = 0;
2285    map[i].flags = 0;
2286   }
2287
2288   XSH_CXT.uid_storage.map   = map;
2289   XSH_CXT.uid_storage.alloc = depth + 1;
2290  }
2291
2292  if (depth >= XSH_CXT.uid_storage.used)
2293   XSH_CXT.uid_storage.used = depth + 1;
2294
2295  return map + depth;
2296 }
2297
2298 static int su_uid_storage_check(pTHX_ UV depth, UV seq) {
2299 #define su_uid_storage_check(D, S) su_uid_storage_check(aTHX_ (D), (S))
2300  su_uid *uid;
2301  dXSH_CXT;
2302
2303  if (depth >= XSH_CXT.uid_storage.used)
2304   return 0;
2305
2306  uid = XSH_CXT.uid_storage.map + depth;
2307
2308  return (uid->seq == seq) && (uid->flags & SU_UID_ACTIVE);
2309 }
2310
2311 static SV *su_uid_get(pTHX_ I32 cxix) {
2312 #define su_uid_get(I) su_uid_get(aTHX_ (I))
2313  su_uid *uid;
2314  SV     *uid_sv;
2315  UV      depth;
2316
2317  depth = su_uid_depth(cxix);
2318  uid   = su_uid_storage_fetch(depth);
2319
2320  if (!(uid->flags & SU_UID_ACTIVE)) {
2321   su_ud_uid *ud;
2322
2323   uid->seq    = su_uid_seq_next(depth);
2324   uid->flags |= SU_UID_ACTIVE;
2325
2326   Newx(ud, 1, su_ud_uid);
2327   SU_UD_TYPE(ud) = SU_UD_TYPE_UID;
2328   ud->idx        = depth;
2329   su_init(ud, cxix, SU_SAVE_DESTRUCTOR_SIZE);
2330  }
2331
2332  uid_sv = sv_newmortal();
2333  sv_setpvf(uid_sv, "%"UVuf"-%"UVuf, depth, uid->seq);
2334
2335  return uid_sv;
2336 }
2337
2338 #ifdef grok_number
2339
2340 #define su_grok_number(S, L, VP) grok_number((S), (L), (VP))
2341
2342 #else /* grok_number */
2343
2344 #define IS_NUMBER_IN_UV 0x1
2345
2346 static int su_grok_number(pTHX_ const char *s, STRLEN len, UV *valuep) {
2347 #define su_grok_number(S, L, VP) su_grok_number(aTHX_ (S), (L), (VP))
2348  STRLEN i;
2349  SV *tmpsv;
2350
2351  /* This crude check should be good enough for a fallback implementation.
2352   * Better be too strict than too lax. */
2353  for (i = 0; i < len; ++i) {
2354   if (!isDIGIT(s[i]))
2355    return 0;
2356  }
2357
2358  tmpsv = sv_newmortal();
2359  sv_setpvn(tmpsv, s, len);
2360  *valuep = sv_2uv(tmpsv);
2361
2362  return IS_NUMBER_IN_UV;
2363 }
2364
2365 #endif /* !grok_number */
2366
2367 static int su_uid_validate(pTHX_ SV *uid) {
2368 #define su_uid_validate(U) su_uid_validate(aTHX_ (U))
2369  const char *s;
2370  STRLEN len, p = 0;
2371  UV depth, seq;
2372  int type;
2373
2374  s = SvPV_const(uid, len);
2375
2376  while (p < len && s[p] != '-')
2377   ++p;
2378  if (p >= len)
2379   croak("UID contains only one part");
2380
2381  type = su_grok_number(s, p, &depth);
2382  if (type != IS_NUMBER_IN_UV)
2383   croak("First UID part is not an unsigned integer");
2384
2385  ++p; /* Skip '-'. As we used to have p < len, len - (p + 1) >= 0. */
2386
2387  type = su_grok_number(s + p, len - p, &seq);
2388  if (type != IS_NUMBER_IN_UV)
2389   croak("Second UID part is not an unsigned integer");
2390
2391  return su_uid_storage_check(depth, seq);
2392 }
2393
2394 /* --- Context operations -------------------------------------------------- */
2395
2396 /* Remove sequences of BLOCKs having DB for stash, followed by a SUB context
2397  * for the debugger callback. */
2398
2399 static I32 su_context_skip_db(pTHX_ I32 cxix) {
2400 #define su_context_skip_db(C) su_context_skip_db(aTHX_ (C))
2401  I32 i;
2402
2403  if (!PL_DBsub)
2404   return cxix;
2405
2406  for (i = cxix; i > 0; --i) {
2407   PERL_CONTEXT *cx = cxstack + i;
2408
2409   switch (CxTYPE(cx)) {
2410 #if XSH_HAS_PERL(5, 17, 1)
2411    case CXt_LOOP_PLAIN:
2412 #endif
2413    case CXt_BLOCK:
2414     if (cx->blk_oldcop && CopSTASH(cx->blk_oldcop) == GvSTASH(PL_DBgv))
2415      continue;
2416     break;
2417    case CXt_SUB:
2418     if (cx->blk_sub.cv == GvCV(PL_DBsub)) {
2419      cxix = i - 1;
2420      continue;
2421     }
2422     break;
2423    default:
2424     break;
2425   }
2426
2427   break;
2428  }
2429
2430  return cxix;
2431 }
2432
2433 #if SU_HAS_NEW_CXT
2434
2435 /* convert a physical context stack index into the logical equivalent:
2436  * one that ignores all the context frames hidden by uplevel().
2437  * Perl-level functions use logical args (e.g. UP takes an optional logical
2438  * value and returns a logical value), while we use and store *real*
2439  * values internally.
2440  */
2441
2442 static I32 su_context_real2logical(pTHX_ I32 cxix) {
2443 # define su_context_real2logical(C) su_context_real2logical(aTHX_ (C))
2444  PERL_CONTEXT *cx;
2445  I32 i, gaps = 0;
2446
2447  for (i = 0; i <= cxix; i++) {
2448   cx = cxstack + i;
2449   if (cx->cx_type == (CXt_NULL | CXp_SU_UPLEVEL_NULLED))
2450    gaps++;
2451  }
2452  XSH_D(su_debug_log("su_context_real2logical: %d => %d\n", cxix, cxix - gaps));
2453  return cxix - gaps;
2454 }
2455
2456 /* convert a logical context stack index (one that ignores all the context
2457  * frames hidden by uplevel) into the physical equivalent
2458  */
2459
2460 static I32 su_context_logical2real(pTHX_ I32 cxix) {
2461 # define su_context_logical2real(C) su_context_logical2real(aTHX_ (C))
2462  PERL_CONTEXT *cx;
2463  I32 i, seen = -1;
2464
2465  for (i = 0; i <= cxstack_ix; i++) {
2466   PERL_CONTEXT *cx = cxstack + i;
2467   if (cx->cx_type != (CXt_NULL | CXp_SU_UPLEVEL_NULLED))
2468    seen++;
2469   if (seen >= cxix)
2470    break;
2471  }
2472  XSH_D(su_debug_log("su_context_logical2real: %d => %d\n", cxix, i));
2473  if (i > cxstack_ix)
2474   i = cxstack_ix;
2475  return i;
2476 }
2477
2478 #else
2479 # define su_context_real2logical(C) (C)
2480 # define su_context_logical2real(C) (C)
2481 #endif
2482
2483 static I32 su_context_normalize_up(pTHX_ I32 cxix) {
2484 #define su_context_normalize_up(C) su_context_normalize_up(aTHX_ (C))
2485  PERL_CONTEXT *cx;
2486
2487  if (cxix <= 0)
2488   return 0;
2489
2490  cx = cxstack + cxix;
2491  if (CxTYPE(cx) == CXt_BLOCK) {
2492   PERL_CONTEXT *prev = cx - 1;
2493
2494   switch (CxTYPE(prev)) {
2495 #if XSH_HAS_PERL(5, 10, 0)
2496    case CXt_GIVEN:
2497    case CXt_WHEN:
2498 #endif
2499 #if XSH_HAS_PERL(5, 11, 0)
2500    /* That's the only subcategory that can cause an extra BLOCK context */
2501    case CXt_LOOP_PLAIN:
2502 #else
2503    case CXt_LOOP:
2504 #endif
2505     if (cx->blk_oldcop == prev->blk_oldcop)
2506      return cxix - 1;
2507     break;
2508    case CXt_SUBST:
2509     if (cx->blk_oldcop && OpSIBLING(cx->blk_oldcop)
2510                        && OpSIBLING(cx->blk_oldcop)->op_type == OP_SUBST)
2511      return cxix - 1;
2512     break;
2513   }
2514  }
2515
2516  return cxix;
2517 }
2518
2519 static I32 su_context_normalize_down(pTHX_ I32 cxix) {
2520 #define su_context_normalize_down(C) su_context_normalize_down(aTHX_ (C))
2521  PERL_CONTEXT *next;
2522
2523  if (cxix >= cxstack_ix)
2524   return cxstack_ix;
2525
2526  next = cxstack + cxix + 1;
2527  if (CxTYPE(next) == CXt_BLOCK) {
2528   PERL_CONTEXT *cx = next - 1;
2529
2530   switch (CxTYPE(cx)) {
2531 #if XSH_HAS_PERL(5, 10, 0)
2532    case CXt_GIVEN:
2533    case CXt_WHEN:
2534 #endif
2535 #if XSH_HAS_PERL(5, 11, 0)
2536    /* That's the only subcategory that can cause an extra BLOCK context */
2537    case CXt_LOOP_PLAIN:
2538 #else
2539    case CXt_LOOP:
2540 #endif
2541     if (cx->blk_oldcop == next->blk_oldcop)
2542      return cxix + 1;
2543     break;
2544    case CXt_SUBST:
2545     if (next->blk_oldcop && OpSIBLING(next->blk_oldcop)
2546                          && OpSIBLING(next->blk_oldcop)->op_type == OP_SUBST)
2547      return cxix + 1;
2548     break;
2549   }
2550  }
2551
2552  return cxix;
2553 }
2554
2555 #define su_context_here() su_context_normalize_up(su_context_skip_db(cxstack_ix))
2556
2557 static I32 su_context_gimme(pTHX_ I32 cxix) {
2558 #define su_context_gimme(C) su_context_gimme(aTHX_ (C))
2559  I32 i;
2560
2561  for (i = cxix; i >= 0; --i) {
2562   PERL_CONTEXT *cx = cxstack + i;
2563
2564   switch (CxTYPE(cx)) {
2565    /* gimme is always G_ARRAY for loop contexts. */
2566 #if XSH_HAS_PERL(5, 11, 0)
2567 # if XSH_HAS_PERL(5, 23, 8)
2568    case CXt_LOOP_ARY:
2569    case CXt_LOOP_LIST:
2570 # else
2571    case CXt_LOOP_FOR:
2572 # endif
2573    case CXt_LOOP_PLAIN:
2574    case CXt_LOOP_LAZYSV:
2575    case CXt_LOOP_LAZYIV:
2576 #else
2577    case CXt_LOOP:
2578 #endif
2579    case CXt_SUBST: {
2580     const COP *cop = cx->blk_oldcop;
2581     if (cop && OpSIBLING(cop)) {
2582      switch (OpSIBLING(cop)->op_flags & OPf_WANT) {
2583       case OPf_WANT_VOID:
2584        return G_VOID;
2585       case OPf_WANT_SCALAR:
2586        return G_SCALAR;
2587       case OPf_WANT_LIST:
2588        return G_ARRAY;
2589       default:
2590        break;
2591      }
2592     }
2593     break;
2594    }
2595    default:
2596     return CxGIMME(cx);
2597     break;
2598   }
2599  }
2600
2601  return G_VOID;
2602 }
2603
2604 /* --- Module setup/teardown ----------------------------------------------- */
2605
2606 static void xsh_user_global_setup(pTHX) {
2607  HV *stash;
2608
2609  MUTEX_INIT(&su_uid_seq_counter_mutex);
2610
2611  XSH_LOCK(&su_uid_seq_counter_mutex);
2612  su_uid_seq_counter.seqs = NULL;
2613  su_uid_seq_counter.size = 0;
2614  XSH_UNLOCK(&su_uid_seq_counter_mutex);
2615
2616  stash = gv_stashpv(XSH_PACKAGE, 1);
2617  newCONSTSUB(stash, "TOP",           newSViv(0));
2618  newCONSTSUB(stash, "SU_THREADSAFE", newSVuv(XSH_THREADSAFE));
2619
2620  return;
2621 }
2622
2623 static void xsh_user_local_setup(pTHX_ xsh_user_cxt_t *cxt) {
2624
2625  /* NewOp() calls calloc() which just zeroes the memory with memset(). */
2626  Zero(&(cxt->unwind_storage.return_op), 1, LISTOP);
2627  cxt->unwind_storage.return_op.op_type   = OP_RETURN;
2628  cxt->unwind_storage.return_op.op_ppaddr = PL_ppaddr[OP_RETURN];
2629
2630  Zero(&(cxt->unwind_storage.proxy_op), 1, OP);
2631  cxt->unwind_storage.proxy_op.op_type   = OP_STUB;
2632  cxt->unwind_storage.proxy_op.op_ppaddr = NULL;
2633
2634  Zero(&(cxt->yield_storage.leave_op), 1, UNOP);
2635  cxt->yield_storage.leave_op.op_type   = OP_STUB;
2636  cxt->yield_storage.leave_op.op_ppaddr = NULL;
2637
2638  Zero(&(cxt->yield_storage.proxy_op), 1, OP);
2639  cxt->yield_storage.proxy_op.op_type   = OP_STUB;
2640  cxt->yield_storage.proxy_op.op_ppaddr = NULL;
2641
2642  cxt->uplevel_storage.top   = NULL;
2643  cxt->uplevel_storage.root  = NULL;
2644  cxt->uplevel_storage.count = 0;
2645
2646  cxt->uid_storage.map   = NULL;
2647  cxt->uid_storage.used  = 0;
2648  cxt->uid_storage.alloc = 0;
2649
2650  return;
2651 }
2652
2653 static void xsh_user_local_teardown(pTHX_ xsh_user_cxt_t *cxt) {
2654  su_uplevel_ud *cur;
2655
2656  Safefree(cxt->uid_storage.map);
2657
2658  cur = cxt->uplevel_storage.root;
2659  if (cur) {
2660   su_uplevel_ud *prev;
2661   do {
2662    prev = cur;
2663    cur  = prev->next;
2664    su_uplevel_ud_delete(prev);
2665   } while (cur);
2666  }
2667
2668  return;
2669 }
2670
2671 static void xsh_user_global_teardown(pTHX) {
2672  XSH_LOCK(&su_uid_seq_counter_mutex);
2673  PerlMemShared_free(su_uid_seq_counter.seqs);
2674  su_uid_seq_counter.size = 0;
2675  XSH_UNLOCK(&su_uid_seq_counter_mutex);
2676
2677  MUTEX_DESTROY(&su_uid_seq_counter_mutex);
2678
2679  return;
2680 }
2681
2682 /* --- XS ------------------------------------------------------------------ */
2683
2684 /* D is real; B is logical. Returns real. */
2685
2686 #define SU_GET_CONTEXT(A, B, D) \
2687  STMT_START {                   \
2688   if (items > A) {              \
2689    SV *csv = ST(B);             \
2690    if (!SvOK(csv))              \
2691     goto default_cx;            \
2692    cxix = SvIV(csv);            \
2693    if (cxix < 0)                \
2694     cxix = 0;                   \
2695    else if (cxix > cxstack_ix)  \
2696     goto default_cx;            \
2697    cxix = su_context_logical2real(cxix); \
2698   } else {                      \
2699 default_cx:                     \
2700    cxix = (D);                  \
2701   }                             \
2702  } STMT_END
2703
2704 #define SU_GET_LEVEL(A, B) \
2705  STMT_START {              \
2706   level = 0;               \
2707   if (items > 0) {         \
2708    SV *lsv = ST(B);        \
2709    if (SvOK(lsv)) {        \
2710     level = SvIV(lsv);     \
2711     if (level < 0)         \
2712      level = 0;            \
2713    }                       \
2714   }                        \
2715  } STMT_END
2716
2717 #if XSH_HAS_PERL(5, 10, 0)
2718 # define SU_INFO_COUNT 11
2719 #else
2720 # define SU_INFO_COUNT 10
2721 #endif
2722
2723 XS(XS_Scope__Upper_unwind) {
2724 #ifdef dVAR
2725  dVAR; dXSARGS;
2726 #else
2727  dXSARGS;
2728 #endif
2729  dXSH_CXT;
2730  I32 cxix;
2731
2732  PERL_UNUSED_VAR(cv); /* -W */
2733  PERL_UNUSED_VAR(ax); /* -Wall */
2734
2735  SU_GET_CONTEXT(0, items - 1, cxstack_ix);
2736  do {
2737   PERL_CONTEXT *cx = cxstack + cxix;
2738   switch (CxTYPE(cx)) {
2739    case CXt_SUB:
2740     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2741      continue;
2742    case CXt_EVAL:
2743    case CXt_FORMAT:
2744     XSH_CXT.unwind_storage.cxix   = cxix;
2745     XSH_CXT.unwind_storage.items  = items;
2746     XSH_CXT.unwind_storage.savesp = PL_stack_sp;
2747     if (items > 0) {
2748      XSH_CXT.unwind_storage.items--;
2749      XSH_CXT.unwind_storage.savesp--;
2750     }
2751     /* pp_entersub will want to sanitize the stack after returning from there
2752      * Screw that, we're insane!
2753      * dXSARGS calls POPMARK, so we need to match PL_markstack_ptr[1] */
2754     if (GIMME_V == G_SCALAR)
2755      PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
2756     SAVEDESTRUCTOR_X(su_unwind, NULL);
2757     return;
2758    default:
2759     break;
2760   }
2761  } while (--cxix >= 0);
2762  croak("Can't return outside a subroutine");
2763 }
2764
2765 static const char su_yield_name[] = "yield";
2766
2767 XS(XS_Scope__Upper_yield) {
2768 #ifdef dVAR
2769  dVAR; dXSARGS;
2770 #else
2771  dXSARGS;
2772 #endif
2773  dXSH_CXT;
2774  I32 cxix;
2775
2776  PERL_UNUSED_VAR(cv); /* -W */
2777  PERL_UNUSED_VAR(ax); /* -Wall */
2778
2779  SU_GET_CONTEXT(0, items - 1, su_context_here());
2780  XSH_CXT.yield_storage.cxix   = cxix;
2781  XSH_CXT.yield_storage.items  = items;
2782  XSH_CXT.yield_storage.savesp = PL_stack_sp;
2783  if (items > 0) {
2784   XSH_CXT.yield_storage.items--;
2785   XSH_CXT.yield_storage.savesp--;
2786  }
2787  /* See XS_Scope__Upper_unwind */
2788  if (GIMME_V == G_SCALAR)
2789   PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
2790  SAVEDESTRUCTOR_X(su_yield, su_yield_name);
2791  return;
2792 }
2793
2794 static const char su_leave_name[] = "leave";
2795
2796 XS(XS_Scope__Upper_leave) {
2797 #ifdef dVAR
2798  dVAR; dXSARGS;
2799 #else
2800  dXSARGS;
2801 #endif
2802  dXSH_CXT;
2803
2804  PERL_UNUSED_VAR(cv); /* -W */
2805  PERL_UNUSED_VAR(ax); /* -Wall */
2806
2807  XSH_CXT.yield_storage.cxix   = su_context_here();
2808  XSH_CXT.yield_storage.items  = items;
2809  XSH_CXT.yield_storage.savesp = PL_stack_sp;
2810  /* See XS_Scope__Upper_unwind */
2811  if (GIMME_V == G_SCALAR)
2812   PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
2813  SAVEDESTRUCTOR_X(su_yield, su_leave_name);
2814  return;
2815 }
2816
2817 MODULE = Scope::Upper            PACKAGE = Scope::Upper
2818
2819 PROTOTYPES: ENABLE
2820
2821 BOOT:
2822 {
2823  xsh_setup();
2824  newXSproto("Scope::Upper::unwind", XS_Scope__Upper_unwind, file, NULL);
2825  newXSproto("Scope::Upper::yield",  XS_Scope__Upper_yield,  file, NULL);
2826  newXSproto("Scope::Upper::leave",  XS_Scope__Upper_leave,  file, NULL);
2827 }
2828
2829 #if XSH_THREADSAFE
2830
2831 void
2832 CLONE(...)
2833 PROTOTYPE: DISABLE
2834 PPCODE:
2835  xsh_clone();
2836  XSRETURN(0);
2837
2838 #endif /* XSH_THREADSAFE */
2839
2840 void
2841 HERE()
2842 PROTOTYPE:
2843 PREINIT:
2844  I32 cxix;
2845 PPCODE:
2846  cxix = su_context_real2logical(su_context_here());
2847  EXTEND(SP, 1);
2848  mPUSHi(cxix);
2849  XSRETURN(1);
2850
2851 void
2852 UP(...)
2853 PROTOTYPE: ;$
2854 PREINIT:
2855  I32 cxix;
2856 PPCODE:
2857  SU_GET_CONTEXT(0, 0, su_context_here());
2858  if (cxix > 0) {
2859   --cxix;
2860   cxix = su_context_skip_db(cxix);
2861   cxix = su_context_normalize_up(cxix);
2862   cxix = su_context_real2logical(cxix);
2863  } else {
2864   warn(su_stack_smash);
2865  }
2866  EXTEND(SP, 1);
2867  mPUSHi(cxix);
2868  XSRETURN(1);
2869
2870 void
2871 SUB(...)
2872 PROTOTYPE: ;$
2873 PREINIT:
2874  I32 cxix;
2875 PPCODE:
2876  SU_GET_CONTEXT(0, 0, cxstack_ix);
2877  EXTEND(SP, 1);
2878  for (; cxix >= 0; --cxix) {
2879   PERL_CONTEXT *cx = cxstack + cxix;
2880   switch (CxTYPE(cx)) {
2881    default:
2882     continue;
2883    case CXt_SUB:
2884     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2885      continue;
2886     cxix = su_context_real2logical(cxix);
2887     mPUSHi(cxix);
2888     XSRETURN(1);
2889   }
2890  }
2891  warn(su_no_such_target, "subroutine");
2892  XSRETURN_UNDEF;
2893
2894 void
2895 EVAL(...)
2896 PROTOTYPE: ;$
2897 PREINIT:
2898  I32 cxix;
2899 PPCODE:
2900  SU_GET_CONTEXT(0, 0, cxstack_ix);
2901  EXTEND(SP, 1);
2902  for (; cxix >= 0; --cxix) {
2903   PERL_CONTEXT *cx = cxstack + cxix;
2904   switch (CxTYPE(cx)) {
2905    default:
2906     continue;
2907    case CXt_EVAL:
2908     cxix = su_context_real2logical(cxix);
2909     mPUSHi(cxix);
2910     XSRETURN(1);
2911   }
2912  }
2913  warn(su_no_such_target, "eval");
2914  XSRETURN_UNDEF;
2915
2916 void
2917 SCOPE(...)
2918 PROTOTYPE: ;$
2919 PREINIT:
2920  I32 cxix, level;
2921 PPCODE:
2922  SU_GET_LEVEL(0, 0);
2923  cxix = su_context_here();
2924  while (--level >= 0) {
2925   if (cxix <= 0) {
2926    warn(su_stack_smash);
2927    break;
2928   }
2929   --cxix;
2930   cxix = su_context_skip_db(cxix);
2931   cxix = su_context_normalize_up(cxix);
2932   cxix = su_context_real2logical(cxix);
2933  }
2934  EXTEND(SP, 1);
2935  mPUSHi(cxix);
2936  XSRETURN(1);
2937
2938 void
2939 CALLER(...)
2940 PROTOTYPE: ;$
2941 PREINIT:
2942  I32 cxix, level;
2943 PPCODE:
2944  SU_GET_LEVEL(0, 0);
2945  for (cxix = cxstack_ix; cxix > 0; --cxix) {
2946   PERL_CONTEXT *cx = cxstack + cxix;
2947   switch (CxTYPE(cx)) {
2948    case CXt_SUB:
2949     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2950      continue;
2951    case CXt_EVAL:
2952    case CXt_FORMAT:
2953     if (--level < 0)
2954      goto done;
2955     break;
2956   }
2957  }
2958 done:
2959  if (level >= 0)
2960   warn(su_stack_smash);
2961  EXTEND(SP, 1);
2962  cxix = su_context_real2logical(cxix);
2963  mPUSHi(cxix);
2964  XSRETURN(1);
2965
2966 void
2967 want_at(...)
2968 PROTOTYPE: ;$
2969 PREINIT:
2970  I32 cxix;
2971 PPCODE:
2972  SU_GET_CONTEXT(0, 0, cxstack_ix);
2973  EXTEND(SP, 1);
2974  while (cxix > 0) {
2975   PERL_CONTEXT *cx = cxstack + cxix--;
2976   switch (CxTYPE(cx)) {
2977    case CXt_SUB:
2978     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2979      continue;
2980    case CXt_EVAL:
2981    case CXt_FORMAT: {
2982     I32 gimme = cx->blk_gimme;
2983     switch (gimme) {
2984      case G_VOID:   XSRETURN_UNDEF; break;
2985      case G_SCALAR: XSRETURN_NO;    break;
2986      case G_ARRAY:  XSRETURN_YES;   break;
2987     }
2988     break;
2989    }
2990   }
2991  }
2992  XSRETURN_UNDEF;
2993
2994 void
2995 context_info(...)
2996 PROTOTYPE: ;$
2997 PREINIT:
2998  I32 cxix;
2999  const PERL_CONTEXT *cx, *dbcx;
3000  COP *cop;
3001 PPCODE:
3002  SU_GET_CONTEXT(0, 0, su_context_skip_db(cxstack_ix));
3003  cxix = su_context_normalize_up(cxix);
3004  cx   = cxstack + cxix;
3005  dbcx = cx;
3006  if (PL_DBsub && cxix && (CxTYPE(cx) == CXt_SUB || CxTYPE(cx) == CXt_FORMAT)) {
3007   I32 i = su_context_skip_db(cxix - 1) + 1;
3008   if (i < cxix && CxTYPE(cxstack + i) == CXt_SUB)
3009    cx = cxstack + i;
3010  }
3011  cop  = cx->blk_oldcop;
3012  EXTEND(SP, SU_INFO_COUNT);
3013  /* stash (0) */
3014  {
3015   HV *stash = CopSTASH(cop);
3016   if (stash)
3017    PUSHs(su_newmortal_pvn(HvNAME(stash), HvNAMELEN(stash)));
3018   else
3019    PUSHs(&PL_sv_undef);
3020  }
3021  /* file (1) */
3022  PUSHs(su_newmortal_pvn(OutCopFILE(cop), OutCopFILE_len(cop)));
3023  /* line (2) */
3024  mPUSHi(CopLINE(cop));
3025  /* subroutine (3) and has_args (4) */
3026  switch (CxTYPE(cx)) {
3027   case CXt_SUB:
3028   case CXt_FORMAT: {
3029    GV *cvgv = CvGV(dbcx->blk_sub.cv);
3030    if (cvgv && isGV(cvgv)) {
3031     SV *sv = sv_newmortal();
3032     gv_efullname3(sv, cvgv, NULL);
3033     PUSHs(sv);
3034    } else {
3035     PUSHs(su_newmortal_pvs("(unknown)"));
3036    }
3037    if (CxHASARGS(cx))
3038     PUSHs(&PL_sv_yes);
3039    else
3040     PUSHs(&PL_sv_no);
3041    break;
3042   }
3043   case CXt_EVAL:
3044    PUSHs(su_newmortal_pvs("(eval)"));
3045    mPUSHi(0);
3046    break;
3047   default:
3048    PUSHs(&PL_sv_undef);
3049    PUSHs(&PL_sv_undef);
3050  }
3051  /* gimme (5) */
3052  switch (su_context_gimme(cxix)) {
3053   case G_ARRAY:
3054    PUSHs(&PL_sv_yes);
3055    break;
3056   case G_SCALAR:
3057    PUSHs(&PL_sv_no);
3058    break;
3059   default: /* G_VOID */
3060    PUSHs(&PL_sv_undef);
3061    break;
3062  }
3063  /* eval text (6) and is_require (7) */
3064  switch (CxTYPE(cx)) {
3065   case CXt_EVAL:
3066    if (CxOLD_OP_TYPE(cx) == OP_ENTEREVAL) {
3067     /* eval STRING */
3068 #if XSH_HAS_PERL(5, 17, 4)
3069     PUSHs(newSVpvn_flags(SvPVX(cx->blk_eval.cur_text),
3070                          SvCUR(cx->blk_eval.cur_text)-2,
3071                          SvUTF8(cx->blk_eval.cur_text)|SVs_TEMP));
3072 #else
3073     PUSHs(cx->blk_eval.cur_text);
3074 #endif
3075     PUSHs(&PL_sv_no);
3076     break;
3077    } else if (cx->blk_eval.old_namesv) {
3078     /* require */
3079     PUSHs(sv_mortalcopy(cx->blk_eval.old_namesv));
3080     PUSHs(&PL_sv_yes);
3081     break;
3082    }
3083    /* FALLTHROUGH */
3084   default:
3085    /* Anything else including eval BLOCK */
3086    PUSHs(&PL_sv_undef);
3087    PUSHs(&PL_sv_undef);
3088    break;
3089  }
3090  /* hints (8) */
3091  mPUSHi(CopHINTS_get(cop));
3092  /* warnings (9) */
3093  {
3094   SV *mask = NULL;
3095 #if XSH_HAS_PERL(5, 9, 4)
3096   STRLEN *old_warnings = cop->cop_warnings;
3097 #else
3098   SV *old_warnings = cop->cop_warnings;
3099 #endif
3100   if (old_warnings == pWARN_STD) {
3101    if (PL_dowarn & G_WARN_ON)
3102     goto context_info_warnings_on;
3103    else
3104 #if XSH_HAS_PERL(5, 17, 4)
3105     mask = &PL_sv_undef;
3106 #else
3107     goto context_info_warnings_off;
3108 #endif
3109   } else if (old_warnings == pWARN_NONE) {
3110 #if !XSH_HAS_PERL(5, 17, 4)
3111 context_info_warnings_off:
3112 #endif
3113    mask = su_newmortal_pvn(WARN_NONEstring, WARNsize);
3114   } else if (old_warnings == pWARN_ALL) {
3115    HV *bits;
3116 context_info_warnings_on:
3117 #if XSH_HAS_PERL(5, 8, 7)
3118    bits = get_hv("warnings::Bits", 0);
3119    if (bits) {
3120     SV **bits_all = hv_fetchs(bits, "all", FALSE);
3121     if (bits_all)
3122      mask = sv_mortalcopy(*bits_all);
3123    }
3124 #endif
3125    if (!mask)
3126     mask = su_newmortal_pvn(WARN_ALLstring, WARNsize);
3127   } else {
3128 #if XSH_HAS_PERL(5, 9, 4)
3129    mask = su_newmortal_pvn((char *) (old_warnings + 1), old_warnings[0]);
3130 #else
3131    mask = sv_mortalcopy(old_warnings);
3132 #endif
3133   }
3134   PUSHs(mask);
3135  }
3136 #if XSH_HAS_PERL(5, 10, 0)
3137  /* hints hash (10) */
3138  {
3139   COPHH *hints_hash = CopHINTHASH_get(cop);
3140   if (hints_hash) {
3141    SV *rhv = sv_2mortal(newRV_noinc((SV *) cophh_2hv(hints_hash, 0)));
3142    PUSHs(rhv);
3143   } else {
3144    PUSHs(&PL_sv_undef);
3145   }
3146  }
3147 #endif
3148  XSRETURN(SU_INFO_COUNT);
3149
3150 void
3151 reap(SV *hook, ...)
3152 PROTOTYPE: &;$
3153 PREINIT:
3154  I32 cxix;
3155  su_ud_reap *ud;
3156 CODE:
3157  SU_GET_CONTEXT(1, 1, su_context_skip_db(cxstack_ix));
3158  cxix = su_context_normalize_down(cxix);
3159  Newx(ud, 1, su_ud_reap);
3160  SU_UD_TYPE(ud) = SU_UD_TYPE_REAP;
3161  ud->cb         = (SvROK(hook) && SvTYPE(SvRV(hook)) >= SVt_PVCV)
3162                   ? SvRV(hook) : hook;
3163  SvREFCNT_inc_simple_void(ud->cb);
3164  su_init(ud, cxix, SU_SAVE_DESTRUCTOR_SIZE);
3165
3166 void
3167 localize(SV *sv, SV *val, ...)
3168 PROTOTYPE: $$;$
3169 PREINIT:
3170  I32 cxix;
3171  I32 size;
3172  su_ud_localize *ud;
3173 CODE:
3174  SU_GET_CONTEXT(2, 2, su_context_skip_db(cxstack_ix));
3175  cxix = su_context_normalize_down(cxix);
3176  Newx(ud, 1, su_ud_localize);
3177  SU_UD_TYPE(ud) = SU_UD_TYPE_LOCALIZE;
3178  size = su_ud_localize_init(ud, sv, val, NULL);
3179  su_init(ud, cxix, size);
3180
3181 void
3182 localize_elem(SV *sv, SV *elem, SV *val, ...)
3183 PROTOTYPE: $$$;$
3184 PREINIT:
3185  I32 cxix;
3186  I32 size;
3187  su_ud_localize *ud;
3188 CODE:
3189  if (SvTYPE(sv) >= SVt_PVGV)
3190   croak("Can't infer the element localization type from a glob and the value");
3191  SU_GET_CONTEXT(3, 3, su_context_skip_db(cxstack_ix));
3192  cxix = su_context_normalize_down(cxix);
3193  Newx(ud, 1, su_ud_localize);
3194  /* Initialize SU_UD_ORIGIN(ud) in case SU_UD_LOCALIZE_FREE(ud) needs it */
3195  SU_UD_ORIGIN(ud) = NULL;
3196  SU_UD_TYPE(ud)   = SU_UD_TYPE_LOCALIZE;
3197  size = su_ud_localize_init(ud, sv, val, elem);
3198  if (SU_UD_PRIVATE(ud) != SVt_PVAV && SU_UD_PRIVATE(ud) != SVt_PVHV) {
3199   SU_UD_LOCALIZE_FREE(ud);
3200   croak("Can't localize an element of something that isn't an array or a hash");
3201  }
3202  su_init(ud, cxix, size);
3203
3204 void
3205 localize_delete(SV *sv, SV *elem, ...)
3206 PROTOTYPE: $$;$
3207 PREINIT:
3208  I32 cxix;
3209  I32 size;
3210  su_ud_localize *ud;
3211 CODE:
3212  SU_GET_CONTEXT(2, 2, su_context_skip_db(cxstack_ix));
3213  cxix = su_context_normalize_down(cxix);
3214  Newx(ud, 1, su_ud_localize);
3215  SU_UD_TYPE(ud) = SU_UD_TYPE_LOCALIZE;
3216  size = su_ud_localize_init(ud, sv, NULL, elem);
3217  su_init(ud, cxix, size);
3218
3219 void
3220 uplevel(SV *code, ...)
3221 PROTOTYPE: &@
3222 PREINIT:
3223  I32 cxix, ret, args = 0;
3224 PPCODE:
3225  if (SvROK(code))
3226   code = SvRV(code);
3227  if (SvTYPE(code) < SVt_PVCV)
3228   croak("First argument to uplevel must be a code reference");
3229  SU_GET_CONTEXT(1, items - 1, cxstack_ix);
3230  do {
3231   PERL_CONTEXT *cx = cxstack + cxix;
3232   switch (CxTYPE(cx)) {
3233    case CXt_EVAL:
3234     croak("Can't uplevel to an eval frame");
3235    case CXt_FORMAT:
3236     croak("Can't uplevel to a format frame");
3237    case CXt_SUB:
3238     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
3239      continue;
3240     if (items > 1) {
3241      PL_stack_sp--;
3242      args = items - 2;
3243     }
3244     /* su_uplevel() takes care of extending the stack if needed. */
3245 #if SU_HAS_NEW_CXT
3246     ret = su_uplevel_new(aTHX_ (CV *) code, cxix, args);
3247 #else
3248     ret = su_uplevel_old(aTHX_ (CV *) code, cxix, args);
3249 #endif
3250     XSRETURN(ret);
3251    default:
3252     break;
3253   }
3254  } while (--cxix >= 0);
3255  croak("Can't uplevel outside a subroutine");
3256
3257 void
3258 uid(...)
3259 PROTOTYPE: ;$
3260 PREINIT:
3261  I32 cxix;
3262  SV *uid;
3263 PPCODE:
3264  SU_GET_CONTEXT(0, 0, su_context_here());
3265  uid = su_uid_get(cxix);
3266  EXTEND(SP, 1);
3267  PUSHs(uid);
3268  XSRETURN(1);
3269
3270 void
3271 validate_uid(SV *uid)
3272 PROTOTYPE: $
3273 PREINIT:
3274  SV *ret;
3275 PPCODE:
3276  ret = su_uid_validate(uid) ? &PL_sv_yes : &PL_sv_no;
3277  EXTEND(SP, 1);
3278  PUSHs(ret);
3279  XSRETURN(1);