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