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 #ifndef SvPV_const
  84 # define SvPV_const(S, L) SvPV(S, L)
  85 #endif
  86
  87 #ifndef SvPVX_const
  88 # define SvPVX_const(S) SvPVX(S)
  89 #endif
  90
  91 #ifndef SvPV_nolen_const
  92 # define SvPV_nolen_const(S) SvPV_nolen(S)
  93 #endif
  94
  95 #ifndef SvREFCNT_inc_simple_void
  96 # define SvREFCNT_inc_simple_void(sv) ((void) SvREFCNT_inc(sv))
  97 #endif
  98
  99 #ifndef mPUSHi
 100 # define mPUSHi(I) PUSHs(sv_2mortal(newSViv(I)))
 101 #endif
 102
 103 #ifndef GvCV_set
 104 # define GvCV_set(G, C) (GvCV(G) = (C))
 105 #endif
 106
 107 #ifndef CvGV_set
 108 # define CvGV_set(C, G) (CvGV(C) = (G))
 109 #endif
 110
 111 #ifndef CvSTASH_set
 112 # define CvSTASH_set(C, S) (CvSTASH(C) = (S))
 113 #endif
 114
 115 #ifndef CvISXSUB
 116 # define CvISXSUB(C) CvXSUB(C)
 117 #endif
 118
 119 #ifndef PadlistARRAY
 120 # define PadlistARRAY(P) AvARRAY(P)
 121 # define PadARRAY(P)     AvARRAY(P)
 122 #endif
 123
 124 #ifndef CxHASARGS
 125 # define CxHASARGS(C) ((C)->blk_sub.hasargs)
 126 #endif
 127
 128 #ifndef HvNAME_get
 129 # define HvNAME_get(H) HvNAME(H)
 130 #endif
 131
 132 #ifndef gv_fetchpvn_flags
 133 # define gv_fetchpvn_flags(A, B, C, D) gv_fetchpv((A), (C), (D))
 134 #endif
 135
 136 #ifndef OP_GIMME_REVERSE
 137 STATIC U8 su_op_gimme_reverse(U8 gimme) {
 138  switch (gimme) {
 139   case G_VOID:
 140    return OPf_WANT_VOID;
 141   case G_ARRAY:
 142    return OPf_WANT_LIST;
 143   default:
 144    break;
 145  }
 146
 147  return OPf_WANT_SCALAR;
 148 }
 149 #define OP_GIMME_REVERSE(G) su_op_gimme_reverse(G)
 150 #endif
 151
 152 #ifndef PERL_MAGIC_tied
 153 # define PERL_MAGIC_tied 'P'
 154 #endif
 155
 156 #ifndef PERL_MAGIC_env
 157 # define PERL_MAGIC_env 'E'
 158 #endif
 159
 160 #ifndef NEGATIVE_INDICES_VAR
 161 # define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"
 162 #endif
 163
 164 #define SU_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
 165 #define SU_HAS_PERL_EXACT(R, V, S) ((PERL_REVISION == (R)) && (PERL_VERSION == (V)) && (PERL_SUBVERSION == (S)))
 166
 167 /* --- Threads and multiplicity -------------------------------------------- */
 168
 169 #ifndef SU_MULTIPLICITY
 170 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
 171 #  define SU_MULTIPLICITY 1
 172 # else
 173 #  define SU_MULTIPLICITY 0
 174 # endif
 175 #endif
 176 #if SU_MULTIPLICITY && !defined(tTHX)
 177 # define tTHX PerlInterpreter*
 178 #endif
 179
 180 #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))
 181 # define SU_THREADSAFE 1
 182 # ifndef MY_CXT_CLONE
 183 #  define MY_CXT_CLONE \
 184     dMY_CXT_SV;                                                      \
 185     my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
 186     Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
 187     sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
 188 # endif
 189 #else
 190 # define SU_THREADSAFE 0
 191 # undef  dMY_CXT
 192 # define dMY_CXT      dNOOP
 193 # undef  MY_CXT
 194 # define MY_CXT       su_globaldata
 195 # undef  START_MY_CXT
 196 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
 197 # undef  MY_CXT_INIT
 198 # define MY_CXT_INIT  NOOP
 199 # undef  MY_CXT_CLONE
 200 # define MY_CXT_CLONE NOOP
 201 #endif
 202
 203 /* --- Unique context ID global storage ------------------------------------ */
 204
 205 /* ... Sequence ID counter ................................................. */
 206
 207 typedef struct {
 208  UV     *seqs;
 209  STRLEN  size;
 210 } su_uv_array;
 211
 212 STATIC su_uv_array su_uid_seq_counter;
 213
 214 #ifdef USE_ITHREADS
 215
 216 STATIC perl_mutex su_uid_seq_counter_mutex;
 217
 218 #define SU_LOCK(M)   MUTEX_LOCK(M)
 219 #define SU_UNLOCK(M) MUTEX_UNLOCK(M)
 220
 221 #else /* USE_ITHREADS */
 222
 223 #define SU_LOCK(M)
 224 #define SU_UNLOCK(M)
 225
 226 #endif /* !USE_ITHREADS */
 227
 228 STATIC UV su_uid_seq_next(pTHX_ UV depth) {
 229 #define su_uid_seq_next(D) su_uid_seq_next(aTHX_ (D))
 230  UV seq;
 231  UV *seqs;
 232
 233  SU_LOCK(&su_uid_seq_counter_mutex);
 234
 235  seqs = su_uid_seq_counter.seqs;
 236
 237  if (depth >= su_uid_seq_counter.size) {
 238   UV i;
 239
 240   seqs = PerlMemShared_realloc(seqs, (depth + 1) * sizeof(UV));
 241   for (i = su_uid_seq_counter.size; i <= depth; ++i)
 242    seqs[i] = 0;
 243
 244   su_uid_seq_counter.seqs = seqs;
 245   su_uid_seq_counter.size = depth + 1;
 246  }
 247
 248  seq = ++seqs[depth];
 249
 250  SU_UNLOCK(&su_uid_seq_counter_mutex);
 251
 252  return seq;
 253 }
 254
 255 /* ... UID storage ......................................................... */
 256
 257 typedef struct {
 258  UV  seq;
 259  U32 flags;
 260 } su_uid;
 261
 262 #define SU_UID_ACTIVE 1
 263
 264 STATIC UV su_uid_depth(pTHX_ I32 cxix) {
 265 #define su_uid_depth(I) su_uid_depth(aTHX_ (I))
 266  const PERL_SI *si;
 267  UV depth;
 268
 269  depth = cxix;
 270  for (si = PL_curstackinfo->si_prev; si; si = si->si_prev)
 271   depth += si->si_cxix + 1;
 272
 273  return depth;
 274 }
 275
 276 typedef struct {
 277  su_uid **map;
 278  STRLEN   used;
 279  STRLEN   alloc;
 280 } su_uid_storage;
 281
 282 STATIC void su_uid_storage_dup(pTHX_ su_uid_storage *new_cxt, const su_uid_storage *old_cxt, UV max_depth) {
 283 #define su_uid_storage_dup(N, O, D) su_uid_storage_dup(aTHX_ (N), (O), (D))
 284  su_uid **old_map = old_cxt->map;
 285
 286  if (old_map) {
 287   su_uid **new_map = new_cxt->map;
 288   STRLEN old_used  = old_cxt->used;
 289   STRLEN old_alloc = old_cxt->alloc;
 290   STRLEN new_used, new_alloc;
 291   STRLEN i;
 292
 293   new_used = max_depth < old_used ? max_depth : old_used;
 294   new_cxt->used = new_used;
 295
 296   if (new_used <= new_cxt->alloc)
 297    new_alloc = new_cxt->alloc;
 298   else {
 299    new_alloc = new_used;
 300    Renew(new_map, new_alloc, su_uid *);
 301    for (i = new_cxt->alloc; i < new_alloc; ++i)
 302     new_map[i] = NULL;
 303    new_cxt->map   = new_map;
 304    new_cxt->alloc = new_alloc;
 305   }
 306
 307   for (i = 0; i < new_alloc; ++i) {
 308    su_uid *new_uid = new_map[i];
 309
 310    if (i < new_used) { /* => i < max_depth && i < old_used */
 311     su_uid *old_uid = old_map[i];
 312
 313     if (old_uid && (old_uid->flags & SU_UID_ACTIVE)) {
 314      if (!new_uid) {
 315       Newx(new_uid, 1, su_uid);
 316       new_map[i] = new_uid;
 317      }
 318      *new_uid = *old_uid;
 319      continue;
 320     }
 321    }
 322
 323    if (new_uid)
 324     new_uid->flags &= ~SU_UID_ACTIVE;
 325   }
 326  }
 327
 328  return;
 329 }
 330
 331 /* --- unwind() global storage --------------------------------------------- */
 332
 333 typedef struct {
 334  I32      cxix;
 335  I32      items;
 336  SV     **savesp;
 337  LISTOP   return_op;
 338  OP       proxy_op;
 339 } su_unwind_storage;
 340
 341 /* --- uplevel() data tokens and global storage ---------------------------- */
 342
 343 #define SU_UPLEVEL_HIJACKS_RUNOPS SU_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  I32            target_depth;
 354  CV            *target;
 355
 356  CV            *callback;
 357  CV            *renamed;
 358
 359  PERL_SI       *si;
 360  PERL_SI       *old_curstackinfo;
 361  AV            *old_mainstack;
 362
 363  COP           *old_curcop;
 364
 365  OP            *old_op;
 366 #if SU_UPLEVEL_HIJACKS_RUNOPS
 367  runops_proc_t  old_runops;
 368 #endif
 369  bool           old_catch;
 370
 371  bool           died;
 372 } su_uplevel_ud;
 373
 374 STATIC su_uplevel_ud *su_uplevel_ud_new(pTHX) {
 375 #define su_uplevel_ud_new() su_uplevel_ud_new(aTHX)
 376  su_uplevel_ud *sud;
 377  PERL_SI       *si;
 378
 379  Newx(sud, 1, su_uplevel_ud);
 380  sud->next = NULL;
 381
 382  sud->tmp_uid_storage.map   = NULL;
 383  sud->tmp_uid_storage.used  = 0;
 384  sud->tmp_uid_storage.alloc = 0;
 385
 386  Newx(si, 1, PERL_SI);
 387  si->si_stack   = newAV();
 388  AvREAL_off(si->si_stack);
 389  si->si_cxstack = NULL;
 390  si->si_cxmax   = 0;
 391
 392  sud->si = si;
 393
 394  return sud;
 395 }
 396
 397 STATIC void su_uplevel_ud_delete(pTHX_ su_uplevel_ud *sud) {
 398 #define su_uplevel_ud_delete(S) su_uplevel_ud_delete(aTHX_ (S))
 399  PERL_SI *si = sud->si;
 400
 401  Safefree(si->si_cxstack);
 402  SvREFCNT_dec(si->si_stack);
 403  Safefree(si);
 404
 405  if (sud->tmp_uid_storage.map) {
 406   su_uid **map   = sud->tmp_uid_storage.map;
 407   STRLEN   alloc = sud->tmp_uid_storage.alloc;
 408   STRLEN   i;
 409
 410   for (i = 0; i < alloc; ++i)
 411    Safefree(map[i]);
 412
 413   Safefree(map);
 414  }
 415
 416  Safefree(sud);
 417
 418  return;
 419 }
 420
 421 typedef struct {
 422  su_uplevel_ud *top;
 423  su_uplevel_ud *root;
 424  I32            count;
 425 } su_uplevel_storage;
 426
 427 #ifndef SU_UPLEVEL_STORAGE_SIZE
 428 # define SU_UPLEVEL_STORAGE_SIZE 4
 429 #endif
 430
 431 /* --- Global data --------------------------------------------------------- */
 432
 433 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
 434
 435 typedef struct {
 436  char               *stack_placeholder;
 437  su_unwind_storage   unwind_storage;
 438  su_uplevel_storage  uplevel_storage;
 439  su_uid_storage      uid_storage;
 440 } my_cxt_t;
 441
 442 START_MY_CXT
 443
 444 /* --- Stack manipulations ------------------------------------------------- */
 445
 446 #define SU_SAVE_PLACEHOLDER() save_pptr(&MY_CXT.stack_placeholder)
 447
 448 #define SU_SAVE_DESTRUCTOR_SIZE  3
 449 #define SU_SAVE_PLACEHOLDER_SIZE 3
 450
 451 #define SU_SAVE_SCALAR_SIZE 3
 452
 453 #define SU_SAVE_ARY_SIZE      3
 454 #define SU_SAVE_AELEM_SIZE    4
 455 #ifdef SAVEADELETE
 456 # define SU_SAVE_ADELETE_SIZE 3
 457 #else
 458 # define SU_SAVE_ADELETE_SIZE SU_SAVE_DESTRUCTOR_SIZE
 459 #endif
 460 #if SU_SAVE_AELEM_SIZE < SU_SAVE_ADELETE_SIZE
 461 # define SU_SAVE_AELEM_OR_ADELETE_SIZE SU_SAVE_ADELETE_SIZE
 462 #else
 463 # define SU_SAVE_AELEM_OR_ADELETE_SIZE SU_SAVE_AELEM_SIZE
 464 #endif
 465
 466 #define SU_SAVE_HASH_SIZE    3
 467 #define SU_SAVE_HELEM_SIZE   4
 468 #define SU_SAVE_HDELETE_SIZE 4
 469 #if SU_SAVE_HELEM_SIZE < SU_SAVE_HDELETE_SIZE
 470 # define SU_SAVE_HELEM_OR_HDELETE_SIZE SU_SAVE_HDELETE_SIZE
 471 #else
 472 # define SU_SAVE_HELEM_OR_HDELETE_SIZE SU_SAVE_HELEM_SIZE
 473 #endif
 474
 475 #define SU_SAVE_GVCV_SIZE SU_SAVE_DESTRUCTOR_SIZE
 476
 477 #if !SU_HAS_PERL(5, 8, 9)
 478 # define SU_SAVE_GP_SIZE 6
 479 #elif !SU_HAS_PERL(5, 13, 0) || (SU_RELEASE && SU_HAS_PERL_EXACT(5, 13, 0))
 480 # define SU_SAVE_GP_SIZE 3
 481 #elif !SU_HAS_PERL(5, 13, 8)
 482 # define SU_SAVE_GP_SIZE 4
 483 #else
 484 # define SU_SAVE_GP_SIZE 3
 485 #endif
 486
 487 #ifndef SvCANEXISTDELETE
 488 # define SvCANEXISTDELETE(sv) \
 489   (!SvRMAGICAL(sv)            \
 490    || ((mg = mg_find((SV *) sv, PERL_MAGIC_tied))            \
 491        && (stash = SvSTASH(SvRV(SvTIED_obj((SV *) sv, mg)))) \
 492        && gv_fetchmethod_autoload(stash, "EXISTS", TRUE)     \
 493        && gv_fetchmethod_autoload(stash, "DELETE", TRUE)     \
 494       )                       \
 495    )
 496 #endif
 497
 498 /* ... Saving array elements ............................................... */
 499
 500 STATIC I32 su_av_key2idx(pTHX_ AV *av, I32 key) {
 501 #define su_av_key2idx(A, K) su_av_key2idx(aTHX_ (A), (K))
 502  I32 idx;
 503
 504  if (key >= 0)
 505   return key;
 506
 507 /* Added by MJD in perl-5.8.1 with 6f12eb6d2a1dfaf441504d869b27d2e40ef4966a */
 508 #if SU_HAS_PERL(5, 8, 1)
 509  if (SvRMAGICAL(av)) {
 510   const MAGIC * const tied_magic = mg_find((SV *) av, PERL_MAGIC_tied);
 511   if (tied_magic) {
 512    SV * const * const negative_indices_glob =
 513                     hv_fetch(SvSTASH(SvRV(SvTIED_obj((SV *) (av), tied_magic))),
 514                              NEGATIVE_INDICES_VAR, 16, 0);
 515    if (negative_indices_glob && SvTRUE(GvSV(*negative_indices_glob)))
 516     return key;
 517   }
 518  }
 519 #endif
 520
 521  idx = key + av_len(av) + 1;
 522  if (idx < 0)
 523   return key;
 524
 525  return idx;
 526 }
 527
 528 #ifndef SAVEADELETE
 529
 530 typedef struct {
 531  AV *av;
 532  I32 idx;
 533 } su_ud_adelete;
 534
 535 STATIC void su_adelete(pTHX_ void *ud_) {
 536  su_ud_adelete *ud = (su_ud_adelete *) ud_;
 537
 538  av_delete(ud->av, ud->idx, G_DISCARD);
 539  SvREFCNT_dec(ud->av);
 540
 541  Safefree(ud);
 542 }
 543
 544 STATIC void su_save_adelete(pTHX_ AV *av, I32 idx) {
 545 #define su_save_adelete(A, K) su_save_adelete(aTHX_ (A), (K))
 546  su_ud_adelete *ud;
 547
 548  Newx(ud, 1, su_ud_adelete);
 549  ud->av  = av;
 550  ud->idx = idx;
 551  SvREFCNT_inc_simple_void(av);
 552
 553  SAVEDESTRUCTOR_X(su_adelete, ud);
 554 }
 555
 556 #define SAVEADELETE(A, K) su_save_adelete((A), (K))
 557
 558 #endif /* SAVEADELETE */
 559
 560 STATIC void su_save_aelem(pTHX_ AV *av, SV *key, SV *val) {
 561 #define su_save_aelem(A, K, V) su_save_aelem(aTHX_ (A), (K), (V))
 562  I32 idx;
 563  I32 preeminent = 1;
 564  SV **svp;
 565  HV *stash;
 566  MAGIC *mg;
 567
 568  idx = su_av_key2idx(av, SvIV(key));
 569
 570  if (SvCANEXISTDELETE(av))
 571   preeminent = av_exists(av, idx);
 572
 573  svp = av_fetch(av, idx, 1);
 574  if (!svp || *svp == &PL_sv_undef) croak(PL_no_aelem, idx);
 575
 576  if (preeminent)
 577   save_aelem(av, idx, svp);
 578  else
 579   SAVEADELETE(av, idx);
 580
 581  if (val) { /* local $x[$idx] = $val; */
 582   SvSetMagicSV(*svp, val);
 583  } else {   /* local $x[$idx]; delete $x[$idx]; */
 584   av_delete(av, idx, G_DISCARD);
 585  }
 586 }
 587
 588 /* ... Saving hash elements ................................................ */
 589
 590 STATIC void su_save_helem(pTHX_ HV *hv, SV *keysv, SV *val) {
 591 #define su_save_helem(H, K, V) su_save_helem(aTHX_ (H), (K), (V))
 592  I32 preeminent = 1;
 593  HE *he;
 594  SV **svp;
 595  HV *stash;
 596  MAGIC *mg;
 597
 598  if (SvCANEXISTDELETE(hv) || mg_find((SV *) hv, PERL_MAGIC_env))
 599   preeminent = hv_exists_ent(hv, keysv, 0);
 600
 601  he  = hv_fetch_ent(hv, keysv, 1, 0);
 602  svp = he ? &HeVAL(he) : NULL;
 603  if (!svp || *svp == &PL_sv_undef) croak("Modification of non-creatable hash value attempted, subscript \"%s\"", SvPV_nolen_const(*svp));
 604
 605  if (HvNAME_get(hv) && isGV(*svp)) {
 606   save_gp((GV *) *svp, 0);
 607   return;
 608  }
 609
 610  if (preeminent)
 611   save_helem(hv, keysv, svp);
 612  else {
 613   STRLEN keylen;
 614   const char * const key = SvPV_const(keysv, keylen);
 615   SAVEDELETE(hv, savepvn(key, keylen),
 616                  SvUTF8(keysv) ? -(I32)keylen : (I32)keylen);
 617  }
 618
 619  if (val) { /* local $x{$keysv} = $val; */
 620   SvSetMagicSV(*svp, val);
 621  } else {   /* local $x{$keysv}; delete $x{$keysv}; */
 622   (void)hv_delete_ent(hv, keysv, G_DISCARD, HeHASH(he));
 623  }
 624 }
 625
 626 /* ... Saving code slots from a glob ....................................... */
 627
 628 #if !SU_HAS_PERL(5, 10, 0) && !defined(mro_method_changed_in)
 629 # define mro_method_changed_in(G) PL_sub_generation++
 630 #endif
 631
 632 typedef struct {
 633  GV *gv;
 634  CV *old_cv;
 635 } su_save_gvcv_ud;
 636
 637 STATIC void su_restore_gvcv(pTHX_ void *ud_) {
 638  su_save_gvcv_ud *ud = ud_;
 639  GV              *gv = ud->gv;
 640
 641  GvCV_set(gv, ud->old_cv);
 642  GvCVGEN(gv) = 0;
 643  mro_method_changed_in(GvSTASH(gv));
 644
 645  Safefree(ud);
 646 }
 647
 648 STATIC void su_save_gvcv(pTHX_ GV *gv) {
 649 #define su_save_gvcv(G) su_save_gvcv(aTHX_ (G))
 650  su_save_gvcv_ud *ud;
 651
 652  Newx(ud, 1, su_save_gvcv_ud);
 653  ud->gv     = gv;
 654  ud->old_cv = GvCV(gv);
 655
 656  GvCV_set(gv, NULL);
 657  GvCVGEN(gv) = 0;
 658  mro_method_changed_in(GvSTASH(gv));
 659
 660  SAVEDESTRUCTOR_X(su_restore_gvcv, ud);
 661 }
 662
 663 /* --- Actions ------------------------------------------------------------- */
 664
 665 typedef struct {
 666  I32 depth;
 667  I32 pad;
 668  I32 *origin;
 669  void (*handler)(pTHX_ void *);
 670 } su_ud_common;
 671
 672 #define SU_UD_DEPTH(U)   (((su_ud_common *) (U))->depth)
 673 #define SU_UD_PAD(U)     (((su_ud_common *) (U))->pad)
 674 #define SU_UD_ORIGIN(U)  (((su_ud_common *) (U))->origin)
 675 #define SU_UD_HANDLER(U) (((su_ud_common *) (U))->handler)
 676
 677 #define SU_UD_FREE(U) STMT_START { \
 678  if (SU_UD_ORIGIN(U)) Safefree(SU_UD_ORIGIN(U)); \
 679  Safefree(U); \
 680 } STMT_END
 681
 682 /* ... Reap ................................................................ */
 683
 684 #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))
 685
 686 typedef struct {
 687  su_ud_common ci;
 688  SV *cb;
 689 } su_ud_reap;
 690
 691 STATIC void su_call(pTHX_ void *ud_) {
 692  su_ud_reap *ud = (su_ud_reap *) ud_;
 693 #if SU_SAVE_LAST_CX
 694  I32 cxix;
 695  PERL_CONTEXT saved_cx;
 696 #endif /* SU_SAVE_LAST_CX */
 697
 698  dSP;
 699
 700  SU_D({
 701   PerlIO_printf(Perl_debug_log,
 702                 "%p: @@@ call\n%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
 703                  ud, ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
 704  });
 705
 706  ENTER;
 707  SAVETMPS;
 708
 709  PUSHMARK(SP);
 710  PUTBACK;
 711
 712 #if SU_SAVE_LAST_CX
 713  /* If the recently popped context isn't saved there, it will be overwritten by
 714   * the sub scope from call_sv, although it's still needed in our caller. */
 715  cxix     = (cxstack_ix < cxstack_max) ? (cxstack_ix + 1) : Perl_cxinc(aTHX);
 716  saved_cx = cxstack[cxix];
 717 #endif /* SU_SAVE_LAST_CX */
 718
 719  call_sv(ud->cb, G_VOID);
 720
 721 #if SU_SAVE_LAST_CX
 722  cxstack[cxix] = saved_cx;
 723 #endif /* SU_SAVE_LAST_CX */
 724
 725  PUTBACK;
 726
 727  FREETMPS;
 728  LEAVE;
 729
 730  SvREFCNT_dec(ud->cb);
 731  SU_UD_FREE(ud);
 732 }
 733
 734 STATIC void su_reap(pTHX_ void *ud) {
 735 #define su_reap(U) su_reap(aTHX_ (U))
 736  SU_D({
 737   PerlIO_printf(Perl_debug_log,
 738                 "%p: === reap\n%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
 739                  ud, ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
 740  });
 741
 742  SAVEDESTRUCTOR_X(su_call, ud);
 743 }
 744
 745 /* ... Localize & localize array/hash element .............................. */
 746
 747 typedef struct {
 748  su_ud_common ci;
 749  SV    *sv;
 750  SV    *val;
 751  SV    *elem;
 752  svtype type;
 753 } su_ud_localize;
 754
 755 #define SU_UD_LOCALIZE_FREE(U) STMT_START { \
 756  SvREFCNT_dec((U)->elem); \
 757  SvREFCNT_dec((U)->val);  \
 758  SvREFCNT_dec((U)->sv);   \
 759  SU_UD_FREE(U);           \
 760 } STMT_END
 761
 762 STATIC I32 su_ud_localize_init(pTHX_ su_ud_localize *ud, SV *sv, SV *val, SV *elem) {
 763 #define su_ud_localize_init(UD, S, V, E) su_ud_localize_init(aTHX_ (UD), (S), (V), (E))
 764  UV deref = 0;
 765  svtype t = SVt_NULL;
 766  I32 size;
 767
 768  SvREFCNT_inc_simple_void(sv);
 769
 770  if (SvTYPE(sv) >= SVt_PVGV) {
 771   if (!val || !SvROK(val)) { /* local *x; or local *x = $val; */
 772    t = SVt_PVGV;
 773   } else {                   /* local *x = \$val; */
 774    t = SvTYPE(SvRV(val));
 775    deref = 1;
 776   }
 777  } else if (SvROK(sv)) {
 778   croak("Invalid %s reference as the localization target",
 779                  sv_reftype(SvRV(sv), 0));
 780  } else {
 781   STRLEN len, l;
 782   const char *p = SvPV_const(sv, len), *s;
 783   for (s = p, l = len; l > 0 && isSPACE(*s); ++s, --l) { }
 784   if (!l) {
 785    l = len;
 786    s = p;
 787   }
 788   switch (*s) {
 789    case '$': t = SVt_PV;   break;
 790    case '@': t = SVt_PVAV; break;
 791    case '%': t = SVt_PVHV; break;
 792    case '&': t = SVt_PVCV; break;
 793    case '*': t = SVt_PVGV; break;
 794   }
 795   if (t != SVt_NULL) {
 796    ++s;
 797    --l;
 798   } else if (val) { /* t == SVt_NULL, type can't be inferred from the sigil */
 799    if (SvROK(val) && !sv_isobject(val)) {
 800     t = SvTYPE(SvRV(val));
 801     deref = 1;
 802    } else {
 803     t = SvTYPE(val);
 804    }
 805   }
 806   SvREFCNT_dec(sv);
 807   sv = newSVpvn(s, l);
 808  }
 809
 810  switch (t) {
 811   case SVt_PVAV:
 812    size  = elem ? SU_SAVE_AELEM_OR_ADELETE_SIZE
 813                 : SU_SAVE_ARY_SIZE;
 814    deref = 0;
 815    break;
 816   case SVt_PVHV:
 817    size  = elem ? SU_SAVE_HELEM_OR_HDELETE_SIZE
 818                 : SU_SAVE_HASH_SIZE;
 819    deref = 0;
 820    break;
 821   case SVt_PVGV:
 822    size  = SU_SAVE_GP_SIZE;
 823    deref = 0;
 824    break;
 825   case SVt_PVCV:
 826    size  = SU_SAVE_GVCV_SIZE;
 827    deref = 0;
 828    break;
 829   default:
 830    size = SU_SAVE_SCALAR_SIZE;
 831    break;
 832  }
 833  /* When deref is set, val isn't NULL */
 834
 835  ud->sv   = sv;
 836  ud->val  = val ? newSVsv(deref ? SvRV(val) : val) : NULL;
 837  ud->elem = SvREFCNT_inc(elem);
 838  ud->type = t;
 839
 840  return size;
 841 }
 842
 843 STATIC void su_localize(pTHX_ void *ud_) {
 844 #define su_localize(U) su_localize(aTHX_ (U))
 845  su_ud_localize *ud = (su_ud_localize *) ud_;
 846  SV *sv   = ud->sv;
 847  SV *val  = ud->val;
 848  SV *elem = ud->elem;
 849  svtype t = ud->type;
 850  GV *gv;
 851
 852  if (SvTYPE(sv) >= SVt_PVGV) {
 853   gv = (GV *) sv;
 854  } else {
 855 #ifdef gv_fetchsv
 856   gv = gv_fetchsv(sv, GV_ADDMULTI, t);
 857 #else
 858   STRLEN len;
 859   const char *name = SvPV_const(sv, len);
 860   gv = gv_fetchpvn_flags(name, len, GV_ADDMULTI, t);
 861 #endif
 862  }
 863
 864  SU_D({
 865   SV *z = newSV(0);
 866   SvUPGRADE(z, t);
 867   PerlIO_printf(Perl_debug_log, "%p: === localize a %s\n",ud, sv_reftype(z, 0));
 868   PerlIO_printf(Perl_debug_log,
 869                 "%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
 870                  ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
 871   SvREFCNT_dec(z);
 872  });
 873
 874  /* Inspired from Alias.pm */
 875  switch (t) {
 876   case SVt_PVAV:
 877    if (elem) {
 878     su_save_aelem(GvAV(gv), elem, val);
 879     goto done;
 880    } else
 881     save_ary(gv);
 882    break;
 883   case SVt_PVHV:
 884    if (elem) {
 885     su_save_helem(GvHV(gv), elem, val);
 886     goto done;
 887    } else
 888     save_hash(gv);
 889    break;
 890   case SVt_PVGV:
 891    save_gp(gv, 1); /* hide previous entry in symtab */
 892    break;
 893   case SVt_PVCV:
 894    su_save_gvcv(gv);
 895    break;
 896   default:
 897    gv = (GV *) save_scalar(gv);
 898    break;
 899  }
 900
 901  if (val)
 902   SvSetMagicSV((SV *) gv, val);
 903
 904 done:
 905  SU_UD_LOCALIZE_FREE(ud);
 906 }
 907
 908 /* --- Pop a context back -------------------------------------------------- */
 909
 910 #if SU_DEBUG
 911 # ifdef DEBUGGING
 912 #  define SU_CXNAME(C) PL_block_type[CxTYPE(C)]
 913 # else
 914 #  define SU_CXNAME(C) "XXX"
 915 # endif
 916 #endif
 917
 918 STATIC void su_pop(pTHX_ void *ud) {
 919 #define su_pop(U) su_pop(aTHX_ (U))
 920  I32 depth, base, mark, *origin;
 921  depth = SU_UD_DEPTH(ud);
 922
 923  SU_D(
 924   PerlIO_printf(Perl_debug_log,
 925    "%p: --- pop a %s\n"
 926    "%p: leave scope     at depth=%2d scope_ix=%2d cur_top=%2d cur_base=%2d\n",
 927     ud, SU_CXNAME(cxstack + cxstack_ix),
 928     ud, depth, PL_scopestack_ix,PL_savestack_ix,PL_scopestack[PL_scopestack_ix])
 929  );
 930
 931  origin = SU_UD_ORIGIN(ud);
 932  mark   = origin[depth];
 933  base   = origin[depth - 1];
 934
 935  SU_D(PerlIO_printf(Perl_debug_log,
 936                     "%p: original scope was %*c top=%2d     base=%2d\n",
 937                      ud,                24, ' ',    mark,        base));
 938
 939  if (base < mark) {
 940   SU_D(PerlIO_printf(Perl_debug_log, "%p: clear leftovers\n", ud));
 941   PL_savestack_ix = mark;
 942   leave_scope(base);
 943  }
 944  PL_savestack_ix = base;
 945
 946  SU_UD_DEPTH(ud) = --depth;
 947
 948  if (depth > 0) {
 949   I32 pad;
 950
 951   if ((pad = SU_UD_PAD(ud))) {
 952    dMY_CXT;
 953    do {
 954     SU_D(PerlIO_printf(Perl_debug_log,
 955           "%p: push a pad slot at depth=%2d scope_ix=%2d save_ix=%2d\n",
 956            ud,                       depth, PL_scopestack_ix, PL_savestack_ix));
 957     SU_SAVE_PLACEHOLDER();
 958    } while (--pad);
 959   }
 960
 961   SU_D(PerlIO_printf(Perl_debug_log,
 962           "%p: push destructor at depth=%2d scope_ix=%2d save_ix=%2d\n",
 963            ud,                       depth, PL_scopestack_ix, PL_savestack_ix));
 964   SAVEDESTRUCTOR_X(su_pop, ud);
 965  } else {
 966   SU_UD_HANDLER(ud)(aTHX_ ud);
 967  }
 968
 969  SU_D(PerlIO_printf(Perl_debug_log,
 970                     "%p: --- end pop: cur_top=%2d == cur_base=%2d\n",
 971                      ud, PL_savestack_ix, PL_scopestack[PL_scopestack_ix]));
 972 }
 973
 974 /* --- Initialize the stack and the action userdata ------------------------ */
 975
 976 STATIC I32 su_init(pTHX_ void *ud, I32 cxix, I32 size) {
 977 #define su_init(U, C, S) su_init(aTHX_ (U), (C), (S))
 978  I32 i, depth = 1, pad, offset, *origin;
 979
 980  SU_D(PerlIO_printf(Perl_debug_log, "%p: ### init for cx %d\n", ud, cxix));
 981
 982  if (size <= SU_SAVE_DESTRUCTOR_SIZE)
 983   pad = 0;
 984  else {
 985   I32 extra = size - SU_SAVE_DESTRUCTOR_SIZE;
 986   pad = extra / SU_SAVE_PLACEHOLDER_SIZE;
 987   if (extra % SU_SAVE_PLACEHOLDER_SIZE)
 988    ++pad;
 989  }
 990  offset = SU_SAVE_DESTRUCTOR_SIZE + SU_SAVE_PLACEHOLDER_SIZE * pad;
 991
 992  SU_D(PerlIO_printf(Perl_debug_log, "%p: size=%d pad=%d offset=%d\n",
 993                                      ud,    size,   pad,   offset));
 994
 995  for (i = cxstack_ix; i > cxix; --i) {
 996   PERL_CONTEXT *cx = cxstack + i;
 997   switch (CxTYPE(cx)) {
 998 #if SU_HAS_PERL(5, 11, 0)
 999    case CXt_LOOP_FOR:
1000    case CXt_LOOP_PLAIN:
1001    case CXt_LOOP_LAZYSV:
1002    case CXt_LOOP_LAZYIV:
1003 #else
1004    case CXt_LOOP:
1005 #endif
1006     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is loop\n", ud, i));
1007     depth += 2;
1008     break;
1009    default:
1010     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is other\n", ud, i));
1011     depth++;
1012     break;
1013   }
1014  }
1015  SU_D(PerlIO_printf(Perl_debug_log, "%p: going down to depth %d\n", ud, depth));
1016
1017  Newx(origin, depth + 1, I32);
1018  origin[0] = PL_scopestack[PL_scopestack_ix - depth];
1019  PL_scopestack[PL_scopestack_ix - depth] += size;
1020  for (i = depth - 1; i >= 1; --i) {
1021   I32 j = PL_scopestack_ix - i;
1022   origin[depth - i] = PL_scopestack[j];
1023   PL_scopestack[j] += offset;
1024  }
1025  origin[depth] = PL_savestack_ix;
1026
1027  SU_UD_ORIGIN(ud) = origin;
1028  SU_UD_DEPTH(ud)  = depth;
1029  SU_UD_PAD(ud)    = pad;
1030
1031  /* Make sure the first destructor fires by pushing enough fake slots on the
1032   * stack. */
1033  if (PL_savestack_ix + SU_SAVE_DESTRUCTOR_SIZE
1034                                        <= PL_scopestack[PL_scopestack_ix - 1]) {
1035   dMY_CXT;
1036   do {
1037    SU_D(PerlIO_printf(Perl_debug_log,
1038                   "%p: push a fake slot      at scope_ix=%2d  save_ix=%2d\n",
1039                    ud,                      PL_scopestack_ix, PL_savestack_ix));
1040    SU_SAVE_PLACEHOLDER();
1041   } while (PL_savestack_ix + SU_SAVE_DESTRUCTOR_SIZE
1042                                         <= PL_scopestack[PL_scopestack_ix - 1]);
1043  }
1044  SU_D(PerlIO_printf(Perl_debug_log,
1045                   "%p: push first destructor at scope_ix=%2d  save_ix=%2d\n",
1046                    ud,                      PL_scopestack_ix, PL_savestack_ix));
1047  SAVEDESTRUCTOR_X(su_pop, ud);
1048
1049  SU_D({
1050   for (i = 0; i <= depth; ++i) {
1051    I32 j = PL_scopestack_ix  - i;
1052    PerlIO_printf(Perl_debug_log,
1053                  "%p: depth=%2d scope_ix=%2d saved_floor=%2d new_floor=%2d\n",
1054                   ud,        i, j, origin[depth - i],
1055                                    i == 0 ? PL_savestack_ix : PL_scopestack[j]);
1056   }
1057  });
1058
1059  return depth;
1060 }
1061
1062 /* --- Unwind stack -------------------------------------------------------- */
1063
1064 STATIC void su_unwind(pTHX_ void *ud_) {
1065  dMY_CXT;
1066  I32 cxix    = MY_CXT.unwind_storage.cxix;
1067  I32 items   = MY_CXT.unwind_storage.items - 1;
1068  SV **savesp = MY_CXT.unwind_storage.savesp;
1069  I32 mark;
1070
1071  PERL_UNUSED_VAR(ud_);
1072
1073  if (savesp)
1074   PL_stack_sp = savesp;
1075
1076  if (cxstack_ix > cxix)
1077   dounwind(cxix);
1078
1079  /* Hide the level */
1080  if (items >= 0)
1081   PL_stack_sp--;
1082
1083  mark = PL_markstack[cxstack[cxix].blk_oldmarksp];
1084  *PL_markstack_ptr = PL_stack_sp - PL_stack_base - items;
1085
1086  SU_D({
1087   I32 gimme = GIMME_V;
1088   PerlIO_printf(Perl_debug_log,
1089                 "%p: cx=%d gimme=%s items=%d sp=%d oldmark=%d mark=%d\n",
1090                 &MY_CXT, cxix,
1091                 gimme == G_VOID ? "void" : gimme == G_ARRAY ? "list" : "scalar",
1092                 items, PL_stack_sp - PL_stack_base, *PL_markstack_ptr, mark);
1093  });
1094
1095  PL_op = (OP *) &(MY_CXT.unwind_storage.return_op);
1096  PL_op = PL_op->op_ppaddr(aTHX);
1097
1098  *PL_markstack_ptr = mark;
1099
1100  MY_CXT.unwind_storage.proxy_op.op_next = PL_op;
1101  PL_op = &(MY_CXT.unwind_storage.proxy_op);
1102 }
1103
1104 /* --- Uplevel ------------------------------------------------------------- */
1105
1106 #define SU_UPLEVEL_SAVE(f, t) STMT_START { sud->old_##f = PL_##f; PL_##f = (t); } STMT_END
1107 #define SU_UPLEVEL_RESTORE(f) STMT_START { PL_##f = sud->old_##f; } STMT_END
1108
1109 STATIC su_uplevel_ud *su_uplevel_storage_new(pTHX_ I32 cxix) {
1110 #define su_uplevel_storage_new(I) su_uplevel_storage_new(aTHX_ (I))
1111  su_uplevel_ud *sud;
1112  UV depth;
1113  dMY_CXT;
1114
1115  sud = MY_CXT.uplevel_storage.root;
1116  if (sud) {
1117   MY_CXT.uplevel_storage.root = sud->next;
1118   MY_CXT.uplevel_storage.count--;
1119  } else {
1120   sud = su_uplevel_ud_new();
1121  }
1122
1123  sud->next = MY_CXT.uplevel_storage.top;
1124  MY_CXT.uplevel_storage.top = sud;
1125
1126  depth = su_uid_depth(cxix);
1127  su_uid_storage_dup(&sud->tmp_uid_storage, &MY_CXT.uid_storage, depth);
1128  sud->old_uid_storage = MY_CXT.uid_storage;
1129  MY_CXT.uid_storage   = sud->tmp_uid_storage;
1130
1131  return sud;
1132 }
1133
1134 STATIC void su_uplevel_storage_delete(pTHX_ su_uplevel_ud *sud) {
1135 #define su_uplevel_storage_delete(S) su_uplevel_storage_delete(aTHX_ (S))
1136  dMY_CXT;
1137
1138  sud->tmp_uid_storage = MY_CXT.uid_storage;
1139  MY_CXT.uid_storage   = sud->old_uid_storage;
1140  {
1141   su_uid **map;
1142   UV  i, alloc;
1143   map   = sud->tmp_uid_storage.map;
1144   alloc = sud->tmp_uid_storage.alloc;
1145   for (i = 0; i < alloc; ++i) {
1146    if (map[i])
1147     map[i]->flags &= SU_UID_ACTIVE;
1148   }
1149  }
1150  MY_CXT.uplevel_storage.top = sud->next;
1151
1152  if (MY_CXT.uplevel_storage.count >= SU_UPLEVEL_STORAGE_SIZE) {
1153   su_uplevel_ud_delete(sud);
1154  } else {
1155   sud->next = MY_CXT.uplevel_storage.root;
1156   MY_CXT.uplevel_storage.root = sud;
1157   MY_CXT.uplevel_storage.count++;
1158  }
1159 }
1160
1161 STATIC int su_uplevel_goto_static(const OP *o) {
1162  for (; o; o = o->op_sibling) {
1163   /* goto ops are unops with kids. */
1164   if (!(o->op_flags & OPf_KIDS))
1165    continue;
1166
1167   switch (o->op_type) {
1168    case OP_LEAVEEVAL:
1169    case OP_LEAVETRY:
1170     /* Don't care about gotos inside eval, as they are forbidden at run time. */
1171     break;
1172    case OP_GOTO:
1173     return 1;
1174    default:
1175     if (su_uplevel_goto_static(cUNOPo->op_first))
1176      return 1;
1177     break;
1178   }
1179  }
1180
1181  return 0;
1182 }
1183
1184 #if SU_UPLEVEL_HIJACKS_RUNOPS
1185
1186 STATIC int su_uplevel_goto_runops(pTHX) {
1187 #define su_uplevel_goto_runops() su_uplevel_goto_runops(aTHX)
1188  register OP *op;
1189  dVAR;
1190
1191  op = PL_op;
1192  do {
1193   if (op->op_type == OP_GOTO) {
1194    AV  *argarray = NULL;
1195    I32  cxix;
1196
1197    for (cxix = cxstack_ix; cxix >= 0; --cxix) {
1198     const PERL_CONTEXT *cx = cxstack + cxix;
1199
1200     switch (CxTYPE(cx)) {
1201      case CXt_SUB:
1202       if (CxHASARGS(cx)) {
1203        argarray = cx->blk_sub.argarray;
1204        goto done;
1205       }
1206       break;
1207      case CXt_EVAL:
1208      case CXt_FORMAT:
1209       goto done;
1210      default:
1211       break;
1212     }
1213    }
1214
1215 done:
1216    if (argarray) {
1217     dMY_CXT;
1218
1219     if (MY_CXT.uplevel_storage.top->cxix == cxix) {
1220      AV  *args  = GvAV(PL_defgv);
1221      I32  items = AvFILLp(args);
1222
1223      av_extend(argarray, items);
1224      Copy(AvARRAY(args), AvARRAY(argarray), items + 1, SV *);
1225      AvFILLp(argarray) = items;
1226     }
1227    }
1228   }
1229
1230   PL_op = op = op->op_ppaddr(aTHX);
1231
1232 #if !SU_HAS_PERL(5, 13, 0)
1233   PERL_ASYNC_CHECK();
1234 #endif
1235  } while (op);
1236
1237  TAINT_NOT;
1238
1239  return 0;
1240 }
1241
1242 #endif /* SU_UPLEVEL_HIJACKS_RUNOPS */
1243
1244 #define su_at_underscore(C) PadARRAY(PadlistARRAY(CvPADLIST(C))[CvDEPTH(C)])[0]
1245
1246 STATIC void su_uplevel_restore(pTHX_ void *sus_) {
1247  su_uplevel_ud *sud = sus_;
1248  PERL_SI *cur = sud->old_curstackinfo;
1249  PERL_SI *si  = sud->si;
1250
1251 #if SU_UPLEVEL_HIJACKS_RUNOPS
1252  if (PL_runops == su_uplevel_goto_runops)
1253   PL_runops = sud->old_runops;
1254 #endif
1255
1256  if (sud->callback) {
1257   PERL_CONTEXT *cx = cxstack + sud->cxix;
1258   AV     *argarray = MUTABLE_AV(su_at_underscore(sud->callback));
1259
1260   /* We have to fix the pad entry for @_ in the original callback because it
1261    * may have been reified. */
1262   if (AvREAL(argarray)) {
1263    const I32 fill = AvFILLp(argarray);
1264    SvREFCNT_dec(argarray);
1265    argarray = newAV();
1266    AvREAL_off(argarray);
1267    AvREIFY_on(argarray);
1268    av_extend(argarray, fill);
1269    su_at_underscore(sud->callback) = MUTABLE_SV(argarray);
1270   } else {
1271    CLEAR_ARGARRAY(argarray);
1272   }
1273
1274   /* If the old cv member is our renamed CV, it means that this place has been
1275    * reached without a goto() happening, and the old argarray member is
1276    * actually our fake argarray. Destroy it properly in that case. */
1277   if (cx->blk_sub.cv == sud->renamed) {
1278    SvREFCNT_dec(cx->blk_sub.argarray);
1279    cx->blk_sub.argarray = argarray;
1280   }
1281
1282   CvDEPTH(sud->callback)--;
1283   SvREFCNT_dec(sud->callback);
1284  }
1285
1286  /* Free the renamed CV. We must do it ourselves so that we can force the
1287   * depth to be 0, or perl would complain about it being "still in use".
1288   * But we *know* that it cannot be so. */
1289  if (sud->renamed) {
1290   CvDEPTH(sud->renamed)   = 0;
1291   CvPADLIST(sud->renamed) = NULL;
1292   SvREFCNT_dec(sud->renamed);
1293  }
1294
1295  CATCH_SET(sud->old_catch);
1296
1297  SU_UPLEVEL_RESTORE(op);
1298
1299  /* stack_grow() wants PL_curstack so restore the old stack first */
1300  if (PL_curstackinfo == si) {
1301   PL_curstack = cur->si_stack;
1302   if (sud->old_mainstack)
1303    SU_UPLEVEL_RESTORE(mainstack);
1304   SU_UPLEVEL_RESTORE(curstackinfo);
1305
1306   if (sud->died) {
1307    CV *target = sud->target;
1308    I32 levels = 0, i;
1309
1310    /* When we die, the depth of the target CV is not updated because of the
1311     * stack switcheroo. So we have to look at all the frames between the
1312     * uplevel call and the catch block to count how many call frames to the
1313     * target CV were skipped. */
1314    for (i = cur->si_cxix; i > sud->cxix; i--) {
1315     register const PERL_CONTEXT *cx = cxstack + i;
1316
1317     if (CxTYPE(cx) == CXt_SUB) {
1318      if (cx->blk_sub.cv == target)
1319       ++levels;
1320     }
1321    }
1322
1323    /* If we died, the replacement stack was already unwinded to the first
1324     * eval frame, and all the contexts down there were popped. We don't have
1325     * to pop manually any context of the original stack, because they must
1326     * have been in the replacement stack as well (since the second was copied
1327     * from the first). Thus we only have to make sure the original stack index
1328     * points to the context just below the first eval scope under the target
1329     * frame. */
1330    for (; i >= 0; i--) {
1331     register const PERL_CONTEXT *cx = cxstack + i;
1332
1333     switch (CxTYPE(cx)) {
1334      case CXt_SUB:
1335       if (cx->blk_sub.cv == target)
1336        ++levels;
1337       break;
1338      case CXt_EVAL:
1339       goto found_it;
1340       break;
1341      default:
1342       break;
1343     }
1344    }
1345
1346 found_it:
1347    CvDEPTH(target) = sud->target_depth - levels;
1348    PL_curstackinfo->si_cxix = i - 1;
1349
1350 #if !SU_HAS_PERL(5, 13, 1)
1351    /* Since $@ was maybe localized between the target frame and the uplevel
1352     * call, we forcefully flush the save stack to get rid of it and then
1353     * reset $@ to its proper value. Note that the the call to
1354     * su_uplevel_restore() must happen before the "reset $@" item of the save
1355     * stack is processed, as uplevel was called after the localization.
1356     * Andrew's changes to how $@ was handled, which were mainly integrated
1357     * between perl 5.13.0 and 5.13.1, fixed this. */
1358    if (ERRSV && SvTRUE(ERRSV)) {
1359     register const PERL_CONTEXT *cx = cxstack + i; /* This is the eval scope */
1360     SV *errsv = SvREFCNT_inc(ERRSV);
1361     PL_scopestack_ix = cx->blk_oldscopesp;
1362     leave_scope(PL_scopestack[PL_scopestack_ix]);
1363     sv_setsv(ERRSV, errsv);
1364     SvREFCNT_dec(errsv);
1365    }
1366 #endif
1367   }
1368  }
1369
1370  SU_UPLEVEL_RESTORE(curcop);
1371
1372  SvREFCNT_dec(sud->target);
1373
1374  PL_stack_base = AvARRAY(cur->si_stack);
1375  PL_stack_sp   = PL_stack_base + AvFILLp(cur->si_stack);
1376  PL_stack_max  = PL_stack_base + AvMAX(cur->si_stack);
1377
1378  /* When an exception is thrown from the uplevel'd subroutine,
1379   * su_uplevel_restore() may be called by the LEAVE in die_unwind() (renamed
1380   * die_where() in more recent perls), which has the sad habit of keeping a
1381   * pointer to the current context frame across this call. This means that we
1382   * can't free the temporary context stack we used for the uplevel call right
1383   * now, or that pointer upwards would point to garbage. */
1384 #if SU_HAS_PERL(5, 13, 7)
1385  /* This issue has been fixed in perl with commit 8f89e5a9, which was made
1386   * public in perl 5.13.7. */
1387  su_uplevel_storage_delete(sud);
1388 #else
1389  /* Otherwise, we just enqueue it back in the global storage list. */
1390  {
1391   dMY_CXT;
1392
1393   sud->tmp_uid_storage = MY_CXT.uid_storage;
1394   MY_CXT.uid_storage   = sud->old_uid_storage;
1395
1396   MY_CXT.uplevel_storage.top  = sud->next;
1397   sud->next = MY_CXT.uplevel_storage.root;
1398   MY_CXT.uplevel_storage.root = sud;
1399   MY_CXT.uplevel_storage.count++;
1400  }
1401 #endif
1402
1403  return;
1404 }
1405
1406 STATIC CV *su_cv_clone(pTHX_ CV *proto, GV *gv) {
1407 #define su_cv_clone(P, G) su_cv_clone(aTHX_ (P), (G))
1408  dVAR;
1409  CV *cv;
1410
1411  cv = MUTABLE_CV(newSV_type(SvTYPE(proto)));
1412
1413  CvFLAGS(cv)  = CvFLAGS(proto);
1414 #ifdef CVf_CVGV_RC
1415  CvFLAGS(cv) &= ~CVf_CVGV_RC;
1416 #endif
1417  CvDEPTH(cv)  = CvDEPTH(proto);
1418 #ifdef USE_ITHREADS
1419  CvFILE(cv)   = CvISXSUB(proto) ? CvFILE(proto) : savepv(CvFILE(proto));
1420 #else
1421  CvFILE(cv)   = CvFILE(proto);
1422 #endif
1423
1424  CvGV_set(cv, gv);
1425  CvSTASH_set(cv, CvSTASH(proto));
1426  /* Commit 4c74a7df, publicized with perl 5.13.3, began to add backrefs to
1427   * stashes. CvSTASH_set() started to do it as well with commit c68d95645
1428   * (which was part of perl 5.13.7). */
1429 #if SU_HAS_PERL(5, 13, 3) && !SU_HAS_PERL(5, 13, 7)
1430  if (CvSTASH(proto))
1431   Perl_sv_add_backref(aTHX_ CvSTASH(proto), MUTABLE_SV(cv));
1432 #endif
1433
1434  if (CvISXSUB(proto)) {
1435   CvXSUB(cv)       = CvXSUB(proto);
1436   CvXSUBANY(cv)    = CvXSUBANY(proto);
1437  } else {
1438   OP_REFCNT_LOCK;
1439   CvROOT(cv)       = OpREFCNT_inc(CvROOT(proto));
1440   OP_REFCNT_UNLOCK;
1441   CvSTART(cv)      = CvSTART(proto);
1442  }
1443  CvOUTSIDE(cv)     = CvOUTSIDE(proto);
1444 #ifdef CVf_WEAKOUTSIDE
1445  if (!(CvFLAGS(proto) & CVf_WEAKOUTSIDE))
1446 #endif
1447   SvREFCNT_inc_simple_void(CvOUTSIDE(cv));
1448  CvPADLIST(cv)     = CvPADLIST(proto);
1449 #ifdef CvOUTSIDE_SEQ
1450  CvOUTSIDE_SEQ(cv) = CvOUTSIDE_SEQ(proto);
1451 #endif
1452
1453  if (SvPOK(proto))
1454   sv_setpvn(MUTABLE_SV(cv), SvPVX_const(proto), SvCUR(proto));
1455
1456 #ifdef CvCONST
1457  if (CvCONST(cv))
1458   CvCONST_off(cv);
1459 #endif
1460
1461  return cv;
1462 }
1463
1464 STATIC I32 su_uplevel(pTHX_ CV *callback, I32 cxix, I32 args) {
1465 #define su_uplevel(C, I, A) su_uplevel(aTHX_ (C), (I), (A))
1466  su_uplevel_ud *sud;
1467  const PERL_CONTEXT *cx = cxstack + cxix;
1468  PERL_SI *si;
1469  PERL_SI *cur = PL_curstackinfo;
1470  SV **old_stack_sp;
1471  CV  *target;
1472  CV  *renamed;
1473  UNOP sub_op;
1474  I32  gimme;
1475  I32  old_mark, new_mark;
1476  I32  ret;
1477  dSP;
1478
1479  ENTER;
1480
1481  gimme = GIMME_V;
1482  /* Make PL_stack_sp point just before the CV. */
1483  PL_stack_sp -= args + 1;
1484  old_mark = AvFILLp(PL_curstack) = PL_stack_sp - PL_stack_base;
1485  SPAGAIN;
1486
1487  sud = su_uplevel_storage_new(cxix);
1488
1489  sud->cxix     = cxix;
1490  sud->died     = 1;
1491  sud->callback = NULL;
1492  sud->renamed  = NULL;
1493  SAVEDESTRUCTOR_X(su_uplevel_restore, sud);
1494
1495  si = sud->si;
1496
1497  si->si_type    = cur->si_type;
1498  si->si_next    = NULL;
1499  si->si_prev    = cur->si_prev;
1500 #ifdef DEBUGGING
1501  si->si_markoff = cx->blk_oldmarksp;
1502 #endif
1503
1504  /* Allocate enough space for all the elements of the original stack up to the
1505   * target context, plus the forthcoming arguments. */
1506  new_mark = cx->blk_oldsp;
1507  av_extend(si->si_stack, new_mark + 1 + args + 1);
1508  Copy(PL_curstack, AvARRAY(si->si_stack), new_mark + 1, SV *);
1509  AvFILLp(si->si_stack) = new_mark;
1510  SU_POISON(AvARRAY(si->si_stack) + new_mark + 1, args + 1, SV *);
1511
1512  /* Specialized SWITCHSTACK() */
1513  PL_stack_base = AvARRAY(si->si_stack);
1514  old_stack_sp  = PL_stack_sp;
1515  PL_stack_sp   = PL_stack_base + AvFILLp(si->si_stack);
1516  PL_stack_max  = PL_stack_base + AvMAX(si->si_stack);
1517  SPAGAIN;
1518
1519  /* Copy the context stack up to the context just below the target. */
1520  si->si_cxix = (cxix < 0) ? -1 : (cxix - 1);
1521  if (si->si_cxmax < cxix) {
1522   /* The max size must be at least two so that GROW(max) = (max*3)/2 > max */
1523   si->si_cxmax = (cxix < 4) ? 4 : cxix;
1524   Renew(si->si_cxstack, si->si_cxmax + 1, PERL_CONTEXT);
1525  }
1526  Copy(cur->si_cxstack, si->si_cxstack, cxix, PERL_CONTEXT);
1527  SU_POISON(si->si_cxstack + cxix, si->si_cxmax + 1 - cxix, PERL_CONTEXT);
1528
1529  target            = cx->blk_sub.cv;
1530  sud->target       = (CV *) SvREFCNT_inc(target);
1531  sud->target_depth = CvDEPTH(target);
1532
1533  /* blk_oldcop is essentially needed for caller() and stack traces. It has no
1534   * run-time implication, since PL_curcop will be overwritten as soon as we
1535   * enter a sub (a sub starts by a nextstate/dbstate). Hence it's safe to just
1536   * make it point to the blk_oldcop for the target frame, so that caller()
1537   * reports the right file name, line number and lexical hints. */
1538  SU_UPLEVEL_SAVE(curcop, cx->blk_oldcop);
1539  /* Don't reset PL_markstack_ptr, or we would overwrite the mark stack below
1540   * this point. Don't reset PL_curpm either, we want the most recent matches. */
1541
1542  SU_UPLEVEL_SAVE(curstackinfo, si);
1543  /* If those two are equal, we need to fool POPSTACK_TO() */
1544  if (PL_mainstack == PL_curstack)
1545   SU_UPLEVEL_SAVE(mainstack, si->si_stack);
1546  else
1547   sud->old_mainstack = NULL;
1548  PL_curstack = si->si_stack;
1549
1550  renamed      = su_cv_clone(callback, CvGV(target));
1551  sud->renamed = renamed;
1552
1553  PUSHMARK(SP);
1554  /* Both SP and old_stack_sp point just before the CV. */
1555  Copy(old_stack_sp + 2, SP + 1, args, SV *);
1556  SP += args;
1557  PUSHs((SV *) renamed);
1558  PUTBACK;
1559
1560  Zero(&sub_op, 1, UNOP);
1561  sub_op.op_type  = OP_ENTERSUB;
1562  sub_op.op_next  = NULL;
1563  sub_op.op_flags = OP_GIMME_REVERSE(gimme) | OPf_STACKED;
1564  if (PL_DBsub)
1565   sub_op.op_flags |= OPpENTERSUB_DB;
1566
1567  SU_UPLEVEL_SAVE(op, (OP *) &sub_op);
1568
1569 #if SU_UPLEVEL_HIJACKS_RUNOPS
1570  sud->old_runops = PL_runops;
1571 #endif
1572
1573  sud->old_catch = CATCH_GET;
1574  CATCH_SET(TRUE);
1575
1576  if ((PL_op = PL_ppaddr[OP_ENTERSUB](aTHX))) {
1577   PERL_CONTEXT *sub_cx = cxstack + cxstack_ix;
1578
1579   /* If pp_entersub() returns a non-null OP, it means that the callback is not
1580    * an XSUB. */
1581
1582   sud->callback = MUTABLE_CV(SvREFCNT_inc(callback));
1583   CvDEPTH(callback)++;
1584
1585   if (CxHASARGS(cx) && cx->blk_sub.argarray) {
1586    /* The call to pp_entersub() has saved the current @_ (in XS terms,
1587     * GvAV(PL_defgv)) in the savearray member, and has created a new argarray
1588     * with what we put on the stack. But we want to fake up the same arguments
1589     * as the ones in use at the context we uplevel to, so we replace the
1590     * argarray with an unreal copy of the original @_. */
1591    AV *av = newAV();
1592    AvREAL_off(av);
1593    AvREIFY_on(av);
1594    av_extend(av, AvMAX(cx->blk_sub.argarray));
1595    AvFILLp(av) = AvFILLp(cx->blk_sub.argarray);
1596    Copy(AvARRAY(cx->blk_sub.argarray), AvARRAY(av), AvFILLp(av) + 1, SV *);
1597    sub_cx->blk_sub.argarray = av;
1598   } else {
1599    SvREFCNT_inc_simple_void(sub_cx->blk_sub.argarray);
1600   }
1601
1602   if (su_uplevel_goto_static(CvROOT(renamed))) {
1603 #if SU_UPLEVEL_HIJACKS_RUNOPS
1604    if (PL_runops != PL_runops_std) {
1605     if (PL_runops == PL_runops_dbg) {
1606      if (PL_debug)
1607       croak("uplevel() can't execute code that calls goto when debugging flags are set");
1608     } else if (PL_runops != su_uplevel_goto_runops)
1609      croak("uplevel() can't execute code that calls goto with a custom runloop");
1610    }
1611
1612    PL_runops = su_uplevel_goto_runops;
1613 #else  /* SU_UPLEVEL_HIJACKS_RUNOPS */
1614    croak("uplevel() can't execute code that calls goto before perl 5.8");
1615 #endif /* !SU_UPLEVEL_HIJACKS_RUNOPS */
1616   }
1617
1618   CALLRUNOPS(aTHX);
1619  }
1620
1621  sud->died = 0;
1622
1623  ret = PL_stack_sp - (PL_stack_base + new_mark);
1624  if (ret > 0) {
1625   AV *old_stack = sud->old_curstackinfo->si_stack;
1626
1627   if (old_mark + ret > AvMAX(old_stack)) {
1628    /* Specialized EXTEND(old_sp, ret) */
1629    av_extend(old_stack, old_mark + ret + 1);
1630    old_stack_sp = AvARRAY(old_stack) + old_mark;
1631   }
1632
1633   Copy(PL_stack_sp - ret + 1, old_stack_sp + 1, ret, SV *);
1634   PL_stack_sp        += ret;
1635   AvFILLp(old_stack) += ret;
1636  }
1637
1638  LEAVE;
1639
1640  return ret;
1641 }
1642
1643 /* --- Unique context ID --------------------------------------------------- */
1644
1645 STATIC su_uid *su_uid_storage_fetch(pTHX_ UV depth) {
1646 #define su_uid_storage_fetch(D) su_uid_storage_fetch(aTHX_ (D))
1647  su_uid **map, *uid;
1648  STRLEN alloc;
1649  dMY_CXT;
1650
1651  map   = MY_CXT.uid_storage.map;
1652  alloc = MY_CXT.uid_storage.alloc;
1653
1654  if (depth >= alloc) {
1655   STRLEN i;
1656
1657   Renew(map, depth + 1, su_uid *);
1658   for (i = alloc; i <= depth; ++i)
1659    map[i] = NULL;
1660
1661   MY_CXT.uid_storage.map   = map;
1662   MY_CXT.uid_storage.alloc = depth + 1;
1663  }
1664
1665  uid = map[depth];
1666
1667  if (!uid) {
1668   Newx(uid, 1, su_uid);
1669   uid->seq   = 0;
1670   uid->flags = 0;
1671   map[depth] = uid;
1672  }
1673
1674  if (depth >= MY_CXT.uid_storage.used)
1675   MY_CXT.uid_storage.used = depth + 1;
1676
1677  return uid;
1678 }
1679
1680 STATIC int su_uid_storage_check(pTHX_ UV depth, UV seq) {
1681 #define su_uid_storage_check(D, S) su_uid_storage_check(aTHX_ (D), (S))
1682  su_uid *uid;
1683  dMY_CXT;
1684
1685  if (depth >= MY_CXT.uid_storage.used)
1686   return 0;
1687
1688  uid = MY_CXT.uid_storage.map[depth];
1689
1690  return uid && (uid->seq == seq) && (uid->flags & SU_UID_ACTIVE);
1691 }
1692
1693 STATIC void su_uid_drop(pTHX_ void *ud_) {
1694  su_uid *uid = ud_;
1695
1696  uid->flags &= ~SU_UID_ACTIVE;
1697 }
1698
1699 STATIC void su_uid_bump(pTHX_ void *ud_) {
1700  su_ud_reap *ud  = ud_;
1701
1702  SAVEDESTRUCTOR_X(su_uid_drop, ud->cb);
1703 }
1704
1705 STATIC SV *su_uid_get(pTHX_ I32 cxix) {
1706 #define su_uid_get(I) su_uid_get(aTHX_ (I))
1707  su_uid *uid;
1708  SV *uid_sv;
1709  UV depth;
1710
1711  depth = su_uid_depth(cxix);
1712  uid   = su_uid_storage_fetch(depth);
1713
1714  if (!(uid->flags & SU_UID_ACTIVE)) {
1715   su_ud_reap *ud;
1716
1717   uid->seq = su_uid_seq_next(depth);
1718   uid->flags |= SU_UID_ACTIVE;
1719
1720   Newx(ud, 1, su_ud_reap);
1721   SU_UD_ORIGIN(ud)  = NULL;
1722   SU_UD_HANDLER(ud) = su_uid_bump;
1723   ud->cb = (SV *) uid;
1724   su_init(ud, cxix, SU_SAVE_DESTRUCTOR_SIZE);
1725  }
1726
1727  uid_sv = sv_newmortal();
1728  sv_setpvf(uid_sv, "%"UVuf"-%"UVuf, depth, uid->seq);
1729  return uid_sv;
1730 }
1731
1732 #ifdef grok_number
1733
1734 #define su_grok_number(S, L, VP) grok_number((S), (L), (VP))
1735
1736 #else /* grok_number */
1737
1738 #define IS_NUMBER_IN_UV 0x1
1739
1740 STATIC int su_grok_number(pTHX_ const char *s, STRLEN len, UV *valuep) {
1741 #define su_grok_number(S, L, VP) su_grok_number(aTHX_ (S), (L), (VP))
1742  STRLEN i;
1743  SV *tmpsv;
1744
1745  /* This crude check should be good enough for a fallback implementation.
1746   * Better be too strict than too lax. */
1747  for (i = 0; i < len; ++i) {
1748   if (!isDIGIT(s[i]))
1749    return 0;
1750  }
1751
1752  tmpsv = sv_newmortal();
1753  sv_setpvn(tmpsv, s, len);
1754  *valuep = sv_2uv(tmpsv);
1755
1756  return IS_NUMBER_IN_UV;
1757 }
1758
1759 #endif /* !grok_number */
1760
1761 STATIC int su_uid_validate(pTHX_ SV *uid) {
1762 #define su_uid_validate(U) su_uid_validate(aTHX_ (U))
1763  const char *s;
1764  STRLEN len, p = 0;
1765  UV depth, seq;
1766  int type;
1767
1768  s = SvPV_const(uid, len);
1769
1770  while (p < len && s[p] != '-')
1771   ++p;
1772  if (p >= len)
1773   croak("UID contains only one part");
1774
1775  type = su_grok_number(s, p, &depth);
1776  if (type != IS_NUMBER_IN_UV)
1777   croak("First UID part is not an unsigned integer");
1778
1779  ++p; /* Skip '-'. As we used to have p < len, len - (p + 1) >= 0. */
1780
1781  type = su_grok_number(s + p, len - p, &seq);
1782  if (type != IS_NUMBER_IN_UV)
1783   croak("Second UID part is not an unsigned integer");
1784
1785  return su_uid_storage_check(depth, seq);
1786 }
1787
1788 /* --- Context operations -------------------------------------------------- */
1789
1790 #if SU_HAS_PERL(5, 8, 9)
1791 # define SU_SKIP_DB_MAX 2
1792 #else
1793 # define SU_SKIP_DB_MAX 3
1794 #endif
1795
1796 /* Skip context sequences of 1 to SU_SKIP_DB_MAX (included) block contexts
1797  * followed by a DB sub */
1798
1799 #define SU_SKIP_DB(C) \
1800  STMT_START {         \
1801   I32 skipped = 0;    \
1802   PERL_CONTEXT *base = cxstack;      \
1803   PERL_CONTEXT *cx   = base + (C);   \
1804   while (cx >= base && (C) > skipped && CxTYPE(cx) == CXt_BLOCK) \
1805    --cx, ++skipped;                  \
1806   if (cx >= base && (C) > skipped) { \
1807    switch (CxTYPE(cx)) {  \
1808     case CXt_SUB:         \
1809      if (skipped <= SU_SKIP_DB_MAX && cx->blk_sub.cv == GvCV(PL_DBsub)) \
1810       (C) -= skipped + 1; \
1811       break;              \
1812     default:              \
1813      break;               \
1814    }                      \
1815   }                       \
1816  } STMT_END
1817
1818 STATIC I32 su_context_up(pTHX_ I32 cxix) {
1819 #define su_context_up(C) su_context_up(aTHX_ (C))
1820  PERL_CONTEXT *cx;
1821
1822  if (cxix <= 0)
1823   return 0;
1824
1825  cx = cxstack + cxix;
1826  if (CxTYPE(cx) == CXt_BLOCK) {
1827   PERL_CONTEXT *prev = cx - 1;
1828
1829   switch (CxTYPE(prev)) {
1830 #if SU_HAS_PERL(5, 10, 0)
1831    case CXt_GIVEN:
1832    case CXt_WHEN:
1833 #endif
1834 #if SU_HAS_PERL(5, 11, 0)
1835    /* That's the only subcategory that can cause an extra BLOCK context */
1836    case CXt_LOOP_PLAIN:
1837 #else
1838    case CXt_LOOP:
1839 #endif
1840     if (cx->blk_oldcop == prev->blk_oldcop)
1841      cxix -= 2;
1842     else
1843      --cxix;
1844     break;
1845    case CXt_SUBST:
1846     if (cx->blk_oldcop && cx->blk_oldcop->op_sibling
1847                        && cx->blk_oldcop->op_sibling->op_type == OP_SUBST)
1848      cxix -= 2;
1849     else
1850      --cxix;
1851     break;
1852    default:
1853     --cxix;
1854     break;
1855   }
1856  } else {
1857   --cxix;
1858  }
1859
1860  if (PL_DBsub)
1861   SU_SKIP_DB(cxix);
1862
1863  return cxix;
1864 }
1865
1866 /* --- Interpreter setup/teardown ------------------------------------------ */
1867
1868 STATIC void su_teardown(pTHX_ void *param) {
1869  su_uplevel_ud *cur;
1870  su_uid **map;
1871  dMY_CXT;
1872
1873  map = MY_CXT.uid_storage.map;
1874  if (map) {
1875   STRLEN i;
1876   for (i = 0; i < MY_CXT.uid_storage.used; ++i)
1877    Safefree(map[i]);
1878   Safefree(map);
1879  }
1880
1881  cur = MY_CXT.uplevel_storage.root;
1882  if (cur) {
1883   su_uplevel_ud *prev;
1884   do {
1885    prev = cur;
1886    cur  = prev->next;
1887    su_uplevel_ud_delete(prev);
1888   } while (cur);
1889  }
1890
1891  return;
1892 }
1893
1894 STATIC void su_setup(pTHX) {
1895 #define su_setup() su_setup(aTHX)
1896  MY_CXT_INIT;
1897
1898  MY_CXT.stack_placeholder = NULL;
1899
1900  /* NewOp() calls calloc() which just zeroes the memory with memset(). */
1901  Zero(&(MY_CXT.unwind_storage.return_op), 1, LISTOP);
1902  MY_CXT.unwind_storage.return_op.op_type   = OP_RETURN;
1903  MY_CXT.unwind_storage.return_op.op_ppaddr = PL_ppaddr[OP_RETURN];
1904
1905  Zero(&(MY_CXT.unwind_storage.proxy_op), 1, OP);
1906  MY_CXT.unwind_storage.proxy_op.op_type   = OP_STUB;
1907  MY_CXT.unwind_storage.proxy_op.op_ppaddr = NULL;
1908
1909  MY_CXT.uplevel_storage.top   = NULL;
1910  MY_CXT.uplevel_storage.root  = NULL;
1911  MY_CXT.uplevel_storage.count = 0;
1912
1913  MY_CXT.uid_storage.map   = NULL;
1914  MY_CXT.uid_storage.used  = 0;
1915  MY_CXT.uid_storage.alloc = 0;
1916
1917  call_atexit(su_teardown, NULL);
1918
1919  return;
1920 }
1921
1922 /* --- XS ------------------------------------------------------------------ */
1923
1924 #define SU_GET_CONTEXT(A, B)   \
1925  STMT_START {                  \
1926   if (items > A) {             \
1927    SV *csv = ST(B);            \
1928    if (!SvOK(csv))             \
1929     goto default_cx;           \
1930    cxix = SvIV(csv);           \
1931    if (cxix < 0)               \
1932     cxix = 0;                  \
1933    else if (cxix > cxstack_ix) \
1934     cxix = cxstack_ix;         \
1935   } else {                     \
1936 default_cx:                    \
1937    cxix = cxstack_ix;          \
1938    if (PL_DBsub)               \
1939     SU_SKIP_DB(cxix);          \
1940   }                            \
1941  } STMT_END
1942
1943 #define SU_GET_LEVEL(A, B) \
1944  STMT_START {              \
1945   level = 0;               \
1946   if (items > 0) {         \
1947    SV *lsv = ST(B);        \
1948    if (SvOK(lsv)) {        \
1949     level = SvIV(lsv);     \
1950     if (level < 0)         \
1951      level = 0;            \
1952    }                       \
1953   }                        \
1954  } STMT_END
1955
1956 XS(XS_Scope__Upper_unwind); /* prototype to pass -Wmissing-prototypes */
1957
1958 XS(XS_Scope__Upper_unwind) {
1959 #ifdef dVAR
1960  dVAR; dXSARGS;
1961 #else
1962  dXSARGS;
1963 #endif
1964  dMY_CXT;
1965  I32 cxix;
1966
1967  PERL_UNUSED_VAR(cv); /* -W */
1968  PERL_UNUSED_VAR(ax); /* -Wall */
1969
1970  SU_GET_CONTEXT(0, items - 1);
1971  do {
1972   PERL_CONTEXT *cx = cxstack + cxix;
1973   switch (CxTYPE(cx)) {
1974    case CXt_SUB:
1975     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
1976      continue;
1977    case CXt_EVAL:
1978    case CXt_FORMAT:
1979     MY_CXT.unwind_storage.cxix  = cxix;
1980     MY_CXT.unwind_storage.items = items;
1981     /* pp_entersub will want to sanitize the stack after returning from there
1982      * Screw that, we're insane */
1983     if (GIMME_V == G_SCALAR) {
1984      MY_CXT.unwind_storage.savesp = PL_stack_sp;
1985      /* dXSARGS calls POPMARK, so we need to match PL_markstack_ptr[1] */
1986      PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
1987     } else {
1988      MY_CXT.unwind_storage.savesp = NULL;
1989     }
1990     SAVEDESTRUCTOR_X(su_unwind, NULL);
1991     return;
1992    default:
1993     break;
1994   }
1995  } while (--cxix >= 0);
1996  croak("Can't return outside a subroutine");
1997 }
1998
1999 MODULE = Scope::Upper            PACKAGE = Scope::Upper
2000
2001 PROTOTYPES: ENABLE
2002
2003 BOOT:
2004 {
2005  HV *stash;
2006
2007  MUTEX_INIT(&su_uid_seq_counter_mutex);
2008
2009  su_uid_seq_counter.seqs = NULL;
2010  su_uid_seq_counter.size = 0;
2011
2012  stash = gv_stashpv(__PACKAGE__, 1);
2013  newCONSTSUB(stash, "TOP",           newSViv(0));
2014  newCONSTSUB(stash, "SU_THREADSAFE", newSVuv(SU_THREADSAFE));
2015
2016  newXSproto("Scope::Upper::unwind", XS_Scope__Upper_unwind, file, NULL);
2017
2018  su_setup();
2019 }
2020
2021 #if SU_THREADSAFE
2022
2023 void
2024 CLONE(...)
2025 PROTOTYPE: DISABLE
2026 PREINIT:
2027  su_uid_storage new_cxt;
2028 PPCODE:
2029  {
2030   dMY_CXT;
2031   new_cxt.map   = NULL;
2032   new_cxt.used  = 0;
2033   new_cxt.alloc = 0;
2034   su_uid_storage_dup(&new_cxt, &MY_CXT.uid_storage, MY_CXT.uid_storage.used);
2035  }
2036  {
2037   MY_CXT_CLONE;
2038   MY_CXT.uplevel_storage.top   = NULL;
2039   MY_CXT.uplevel_storage.root  = NULL;
2040   MY_CXT.uplevel_storage.count = 0;
2041   MY_CXT.uid_storage           = new_cxt;
2042  }
2043  XSRETURN(0);
2044
2045 #endif /* SU_THREADSAFE */
2046
2047 void
2048 HERE()
2049 PROTOTYPE:
2050 PREINIT:
2051  I32 cxix = cxstack_ix;
2052 PPCODE:
2053  if (PL_DBsub)
2054   SU_SKIP_DB(cxix);
2055  EXTEND(SP, 1);
2056  mPUSHi(cxix);
2057  XSRETURN(1);
2058
2059 void
2060 UP(...)
2061 PROTOTYPE: ;$
2062 PREINIT:
2063  I32 cxix;
2064 PPCODE:
2065  SU_GET_CONTEXT(0, 0);
2066  cxix = su_context_up(cxix);
2067  EXTEND(SP, 1);
2068  mPUSHi(cxix);
2069  XSRETURN(1);
2070
2071 void
2072 SUB(...)
2073 PROTOTYPE: ;$
2074 PREINIT:
2075  I32 cxix;
2076 PPCODE:
2077  SU_GET_CONTEXT(0, 0);
2078  EXTEND(SP, 1);
2079  for (; cxix >= 0; --cxix) {
2080   PERL_CONTEXT *cx = cxstack + cxix;
2081   switch (CxTYPE(cx)) {
2082    default:
2083     continue;
2084    case CXt_SUB:
2085     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2086      continue;
2087     mPUSHi(cxix);
2088     XSRETURN(1);
2089   }
2090  }
2091  XSRETURN_UNDEF;
2092
2093 void
2094 EVAL(...)
2095 PROTOTYPE: ;$
2096 PREINIT:
2097  I32 cxix;
2098 PPCODE:
2099  SU_GET_CONTEXT(0, 0);
2100  EXTEND(SP, 1);
2101  for (; cxix >= 0; --cxix) {
2102   PERL_CONTEXT *cx = cxstack + cxix;
2103   switch (CxTYPE(cx)) {
2104    default:
2105     continue;
2106    case CXt_EVAL:
2107     mPUSHi(cxix);
2108     XSRETURN(1);
2109   }
2110  }
2111  XSRETURN_UNDEF;
2112
2113 void
2114 SCOPE(...)
2115 PROTOTYPE: ;$
2116 PREINIT:
2117  I32 cxix, level;
2118 PPCODE:
2119  SU_GET_LEVEL(0, 0);
2120  cxix = cxstack_ix;
2121  if (PL_DBsub)
2122   SU_SKIP_DB(cxix);
2123  while (--level >= 0)
2124   cxix = su_context_up(cxix);
2125  EXTEND(SP, 1);
2126  mPUSHi(cxix);
2127  XSRETURN(1);
2128
2129 void
2130 CALLER(...)
2131 PROTOTYPE: ;$
2132 PREINIT:
2133  I32 cxix, level;
2134 PPCODE:
2135  SU_GET_LEVEL(0, 0);
2136  for (cxix = cxstack_ix; cxix > 0; --cxix) {
2137   PERL_CONTEXT *cx = cxstack + cxix;
2138   switch (CxTYPE(cx)) {
2139    case CXt_SUB:
2140     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2141      continue;
2142    case CXt_EVAL:
2143    case CXt_FORMAT:
2144     if (--level < 0)
2145      goto done;
2146     break;
2147   }
2148  }
2149 done:
2150  EXTEND(SP, 1);
2151  mPUSHi(cxix);
2152  XSRETURN(1);
2153
2154 void
2155 want_at(...)
2156 PROTOTYPE: ;$
2157 PREINIT:
2158  I32 cxix;
2159 PPCODE:
2160  SU_GET_CONTEXT(0, 0);
2161  EXTEND(SP, 1);
2162  while (cxix > 0) {
2163   PERL_CONTEXT *cx = cxstack + cxix--;
2164   switch (CxTYPE(cx)) {
2165    case CXt_SUB:
2166    case CXt_EVAL:
2167    case CXt_FORMAT: {
2168     I32 gimme = cx->blk_gimme;
2169     switch (gimme) {
2170      case G_VOID:   XSRETURN_UNDEF; break;
2171      case G_SCALAR: XSRETURN_NO;    break;
2172      case G_ARRAY:  XSRETURN_YES;   break;
2173     }
2174     break;
2175    }
2176   }
2177  }
2178  XSRETURN_UNDEF;
2179
2180 void
2181 reap(SV *hook, ...)
2182 PROTOTYPE: &;$
2183 PREINIT:
2184  I32 cxix;
2185  su_ud_reap *ud;
2186 CODE:
2187  SU_GET_CONTEXT(1, 1);
2188  Newx(ud, 1, su_ud_reap);
2189  SU_UD_ORIGIN(ud)  = NULL;
2190  SU_UD_HANDLER(ud) = su_reap;
2191  ud->cb = newSVsv(hook);
2192  su_init(ud, cxix, SU_SAVE_DESTRUCTOR_SIZE);
2193
2194 void
2195 localize(SV *sv, SV *val, ...)
2196 PROTOTYPE: $$;$
2197 PREINIT:
2198  I32 cxix;
2199  I32 size;
2200  su_ud_localize *ud;
2201 CODE:
2202  SU_GET_CONTEXT(2, 2);
2203  Newx(ud, 1, su_ud_localize);
2204  SU_UD_ORIGIN(ud)  = NULL;
2205  SU_UD_HANDLER(ud) = su_localize;
2206  size = su_ud_localize_init(ud, sv, val, NULL);
2207  su_init(ud, cxix, size);
2208
2209 void
2210 localize_elem(SV *sv, SV *elem, SV *val, ...)
2211 PROTOTYPE: $$$;$
2212 PREINIT:
2213  I32 cxix;
2214  I32 size;
2215  su_ud_localize *ud;
2216 CODE:
2217  if (SvTYPE(sv) >= SVt_PVGV)
2218   croak("Can't infer the element localization type from a glob and the value");
2219  SU_GET_CONTEXT(3, 3);
2220  Newx(ud, 1, su_ud_localize);
2221  SU_UD_ORIGIN(ud)  = NULL;
2222  SU_UD_HANDLER(ud) = su_localize;
2223  size = su_ud_localize_init(ud, sv, val, elem);
2224  if (ud->type != SVt_PVAV && ud->type != SVt_PVHV) {
2225   SU_UD_LOCALIZE_FREE(ud);
2226   croak("Can't localize an element of something that isn't an array or a hash");
2227  }
2228  su_init(ud, cxix, size);
2229
2230 void
2231 localize_delete(SV *sv, SV *elem, ...)
2232 PROTOTYPE: $$;$
2233 PREINIT:
2234  I32 cxix;
2235  I32 size;
2236  su_ud_localize *ud;
2237 CODE:
2238  SU_GET_CONTEXT(2, 2);
2239  Newx(ud, 1, su_ud_localize);
2240  SU_UD_ORIGIN(ud)  = NULL;
2241  SU_UD_HANDLER(ud) = su_localize;
2242  size = su_ud_localize_init(ud, sv, NULL, elem);
2243  su_init(ud, cxix, size);
2244
2245 void
2246 uplevel(SV *code, ...)
2247 PROTOTYPE: &@
2248 PREINIT:
2249  I32 cxix, ret, args = 0;
2250 PPCODE:
2251  if (SvROK(code))
2252   code = SvRV(code);
2253  if (SvTYPE(code) < SVt_PVCV)
2254   croak("First argument to uplevel must be a code reference");
2255  SU_GET_CONTEXT(1, items - 1);
2256  do {
2257   PERL_CONTEXT *cx = cxstack + cxix;
2258   switch (CxTYPE(cx)) {
2259    case CXt_EVAL:
2260     croak("Can't uplevel to an eval frame");
2261    case CXt_FORMAT:
2262     croak("Can't uplevel to a format frame");
2263    case CXt_SUB:
2264     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2265      continue;
2266     if (items > 1) {
2267      PL_stack_sp--;
2268      args = items - 2;
2269     }
2270     /* su_uplevel() takes care of extending the stack if needed. */
2271     ret = su_uplevel((CV *) code, cxix, args);
2272     XSRETURN(ret);
2273    default:
2274     break;
2275   }
2276  } while (--cxix >= 0);
2277  croak("Can't uplevel outside a subroutine");
2278
2279 void
2280 uid(...)
2281 PROTOTYPE: ;$
2282 PREINIT:
2283  I32 cxix;
2284  SV *uid;
2285 PPCODE:
2286  SU_GET_CONTEXT(0, 0);
2287  uid = su_uid_get(cxix);
2288  EXTEND(SP, 1);
2289  PUSHs(uid);
2290  XSRETURN(1);
2291
2292 void
2293 validate_uid(SV *uid)
2294 PROTOTYPE: $
2295 PREINIT:
2296  SV *ret;
2297 PPCODE:
2298  ret = su_uid_validate(uid) ? &PL_sv_yes : &PL_sv_no;
2299  EXTEND(SP, 1);
2300  PUSHs(ret);
2301  XSRETURN(1);