Upper.xs

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