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