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