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 - 1;
1076  SV **savesp = MY_CXT.unwind_storage.savesp;
1077  I32 mark;
1078
1079  PERL_UNUSED_VAR(ud_);
1080
1081  if (savesp)
1082   PL_stack_sp = savesp;
1083
1084  if (cxstack_ix > cxix)
1085   dounwind(cxix);
1086
1087  /* Hide the level */
1088  if (items >= 0)
1089   PL_stack_sp--;
1090
1091  mark = PL_markstack[cxstack[cxix].blk_oldmarksp];
1092  *PL_markstack_ptr = PL_stack_sp - PL_stack_base - items;
1093
1094  SU_D({
1095   I32 gimme = GIMME_V;
1096   PerlIO_printf(Perl_debug_log,
1097                 "%p: cx=%d gimme=%s items=%d sp=%d oldmark=%d mark=%d\n",
1098                 &MY_CXT, cxix,
1099                 gimme == G_VOID ? "void" : gimme == G_ARRAY ? "list" : "scalar",
1100                 items, PL_stack_sp - PL_stack_base, *PL_markstack_ptr, mark);
1101  });
1102
1103  PL_op = (OP *) &(MY_CXT.unwind_storage.return_op);
1104  PL_op = PL_op->op_ppaddr(aTHX);
1105
1106  *PL_markstack_ptr = mark;
1107
1108  MY_CXT.unwind_storage.proxy_op.op_next = PL_op;
1109  PL_op = &(MY_CXT.unwind_storage.proxy_op);
1110 }
1111
1112 /* --- Yield --------------------------------------------------------------- */
1113
1114 #if SU_HAS_PERL(5, 10, 0)
1115 # define SU_RETOP_SUB(C)   ((C)->blk_sub.retop)
1116 # define SU_RETOP_EVAL(C)  ((C)->blk_eval.retop)
1117 # define SU_RETOP_LOOP(C)  ((C)->blk_loop.my_op->op_lastop->op_next)
1118 # define SU_RETOP_GIVEN(C) ((C)->blk_givwhen.leave_op->op_next)
1119 #else
1120 # define SU_RETOP_SUB(C)  ((C)->blk_oldretsp > 0 ? PL_retstack[(C)->blk_oldretsp - 1] : NULL)
1121 # define SU_RETOP_EVAL(C) SU_RETOP_SUB(C)
1122 # define SU_RETOP_LOOP(C) ((C)->blk_loop.last_op->op_next)
1123 #endif
1124
1125 STATIC void su_yield(pTHX_ void *ud_) {
1126  dMY_CXT;
1127  PERL_CONTEXT *cx;
1128  I32 cxix      = MY_CXT.yield_storage.cxix;
1129  I32 items     = MY_CXT.yield_storage.items - 1;
1130  SV **savesp   = MY_CXT.yield_storage.savesp;
1131  opcode  type  = OP_NULL;
1132  U8      flags = 0;
1133  OP     *next;
1134
1135  PERL_UNUSED_VAR(ud_);
1136
1137  if (savesp)
1138   PL_stack_sp = savesp;
1139
1140  cx = cxstack + cxix;
1141  switch (CxTYPE(cx)) {
1142   case CXt_BLOCK: {
1143    I32 i, cur = cxstack_ix, n = 1;
1144    OP *o = NULL;
1145    /* Is this actually a given/when block? This may occur only when yield was
1146     * called with HERE (or nothing) as the context. */
1147 #if SU_HAS_PERL(5, 10, 0)
1148    if (cxix > 0) {
1149     PERL_CONTEXT *prev = cx - 1;
1150     U8 type = CxTYPE(prev);
1151     if ((type == CXt_GIVEN || type == CXt_WHEN)
1152         && (prev->blk_oldcop == cx->blk_oldcop)) {
1153      cxix--;
1154      cx = prev;
1155      if (type == CXt_GIVEN)
1156       goto cxt_given;
1157      else
1158       goto cxt_when;
1159     }
1160    }
1161 #endif
1162    type  = OP_LEAVE;
1163    next  = NULL;
1164    /* Bare blocks (that appear as do { ... } blocks, map { ... } blocks or
1165     * constant folded blcoks) don't need to save the op to return to anywhere
1166     * since 'last' isn't supposed to work inside them. So we climb higher in
1167     * the context stack until we reach a context that has a return op (i.e. a
1168     * sub, an eval, a format or a real loop), recording how many blocks we
1169     * crossed. Then we follow the op_next chain until we get to the leave op
1170     * that closes the original block, which we are assured to reach since
1171     * everything is static (the blocks we have crossed cannot be evals or
1172     * subroutine calls). */
1173    for (i = cxix + 1; i <= cur; ++i) {
1174     PERL_CONTEXT *cx2 = cxstack + i;
1175     switch (CxTYPE(cx2)) {
1176      case CXt_BLOCK:
1177       ++n;
1178       break;
1179      case CXt_SUB:
1180      case CXt_FORMAT:
1181       o = SU_RETOP_SUB(cx2);
1182       break;
1183      case CXt_EVAL:
1184       o = SU_RETOP_EVAL(cx2);
1185       break;
1186 #if SU_HAS_PERL(5, 11, 0)
1187      case CXt_LOOP_FOR:
1188      case CXt_LOOP_PLAIN:
1189      case CXt_LOOP_LAZYSV:
1190      case CXt_LOOP_LAZYIV:
1191 #else
1192      case CXt_LOOP:
1193 #endif
1194       o = SU_RETOP_LOOP(cx2);
1195       break;
1196     }
1197     if (o)
1198      break;
1199    }
1200    if (!o)
1201     o = PL_op;
1202    while (n && o) {
1203     /* We may find other enter/leave blocks on our way to the matching leave.
1204      * Make sure the depth is incremented/decremented appropriately. */
1205     if (o->op_type == OP_ENTER) {
1206      ++n;
1207     } else if (o->op_type == OP_LEAVE) {
1208      --n;
1209      if (!n) {
1210       next = o->op_next;
1211       break;
1212      }
1213     }
1214     o = o->op_next;
1215    }
1216    break;
1217   }
1218   case CXt_SUB:
1219   case CXt_FORMAT:
1220    type = OP_LEAVESUB;
1221    next = SU_RETOP_SUB(cx);
1222    break;
1223   case CXt_EVAL:
1224    type = CxTRYBLOCK(cx) ? OP_LEAVETRY : OP_LEAVEEVAL;
1225    next = SU_RETOP_EVAL(cx);
1226    break;
1227 #if SU_HAS_PERL(5, 11, 0)
1228   case CXt_LOOP_FOR:
1229   case CXt_LOOP_PLAIN:
1230   case CXt_LOOP_LAZYSV:
1231   case CXt_LOOP_LAZYIV:
1232 #else
1233   case CXt_LOOP:
1234 #endif
1235    type = OP_LEAVELOOP;
1236    next = SU_RETOP_LOOP(cx);
1237    break;
1238 #if SU_HAS_PERL(5, 10, 0)
1239   case CXt_GIVEN:
1240 cxt_given:
1241    type = OP_LEAVEGIVEN;
1242    next = SU_RETOP_GIVEN(cx);
1243    break;
1244   case CXt_WHEN:
1245 cxt_when:
1246 #if SU_HAS_PERL(5, 15, 1)
1247    type   = OP_LEAVEWHEN;
1248 #else
1249    type   = OP_BREAK;
1250    flags |= OPf_SPECIAL;
1251 #endif
1252    next   = NULL;
1253    break;
1254 #endif
1255   case CXt_SUBST:
1256    croak("yield() cannot target a substitution context");
1257    break;
1258   default:
1259    croak("yield() don't know how to leave a %s context", SU_CXNAME(cxstack + cxix));
1260    break;
1261  }
1262
1263  if (cxstack_ix > cxix)
1264   dounwind(cxix);
1265
1266  /* Hide the level */
1267  if (items >= 0)
1268   PL_stack_sp--;
1269  else
1270   items = 0;
1271
1272  /* Copy the arguments passed to yield() where the leave op expects to find
1273   * them. */
1274  if (items)
1275   Move(PL_stack_sp - items + 1, PL_stack_base + cx->blk_oldsp + 1, items, SV *);
1276  PL_stack_sp = PL_stack_base + cx->blk_oldsp + items;
1277
1278  flags |= OP_GIMME_REVERSE(cx->blk_gimme);
1279
1280  MY_CXT.yield_storage.leave_op.op_type   = type;
1281  MY_CXT.yield_storage.leave_op.op_ppaddr = PL_ppaddr[type];
1282  MY_CXT.yield_storage.leave_op.op_flags  = flags;
1283  MY_CXT.yield_storage.leave_op.op_next   = next;
1284
1285  PL_op = (OP *) &(MY_CXT.yield_storage.leave_op);
1286  PL_op = PL_op->op_ppaddr(aTHX);
1287
1288  MY_CXT.yield_storage.proxy_op.op_next = PL_op;
1289  PL_op = &(MY_CXT.yield_storage.proxy_op);
1290 }
1291
1292 /* --- Uplevel ------------------------------------------------------------- */
1293
1294 #define SU_UPLEVEL_SAVE(f, t) STMT_START { sud->old_##f = PL_##f; PL_##f = (t); } STMT_END
1295 #define SU_UPLEVEL_RESTORE(f) STMT_START { PL_##f = sud->old_##f; } STMT_END
1296
1297 STATIC su_uplevel_ud *su_uplevel_storage_new(pTHX_ I32 cxix) {
1298 #define su_uplevel_storage_new(I) su_uplevel_storage_new(aTHX_ (I))
1299  su_uplevel_ud *sud;
1300  UV depth;
1301  dMY_CXT;
1302
1303  sud = MY_CXT.uplevel_storage.root;
1304  if (sud) {
1305   MY_CXT.uplevel_storage.root = sud->next;
1306   MY_CXT.uplevel_storage.count--;
1307  } else {
1308   sud = su_uplevel_ud_new();
1309  }
1310
1311  sud->next = MY_CXT.uplevel_storage.top;
1312  MY_CXT.uplevel_storage.top = sud;
1313
1314  depth = su_uid_depth(cxix);
1315  su_uid_storage_dup(&sud->tmp_uid_storage, &MY_CXT.uid_storage, depth);
1316  sud->old_uid_storage = MY_CXT.uid_storage;
1317  MY_CXT.uid_storage   = sud->tmp_uid_storage;
1318
1319  return sud;
1320 }
1321
1322 STATIC void su_uplevel_storage_delete(pTHX_ su_uplevel_ud *sud) {
1323 #define su_uplevel_storage_delete(S) su_uplevel_storage_delete(aTHX_ (S))
1324  dMY_CXT;
1325
1326  sud->tmp_uid_storage = MY_CXT.uid_storage;
1327  MY_CXT.uid_storage   = sud->old_uid_storage;
1328  {
1329   su_uid **map;
1330   UV  i, alloc;
1331   map   = sud->tmp_uid_storage.map;
1332   alloc = sud->tmp_uid_storage.alloc;
1333   for (i = 0; i < alloc; ++i) {
1334    if (map[i])
1335     map[i]->flags &= SU_UID_ACTIVE;
1336   }
1337  }
1338  MY_CXT.uplevel_storage.top = sud->next;
1339
1340  if (MY_CXT.uplevel_storage.count >= SU_UPLEVEL_STORAGE_SIZE) {
1341   su_uplevel_ud_delete(sud);
1342  } else {
1343   sud->next = MY_CXT.uplevel_storage.root;
1344   MY_CXT.uplevel_storage.root = sud;
1345   MY_CXT.uplevel_storage.count++;
1346  }
1347 }
1348
1349 STATIC int su_uplevel_goto_static(const OP *o) {
1350  for (; o; o = o->op_sibling) {
1351   /* goto ops are unops with kids. */
1352   if (!(o->op_flags & OPf_KIDS))
1353    continue;
1354
1355   switch (o->op_type) {
1356    case OP_LEAVEEVAL:
1357    case OP_LEAVETRY:
1358     /* Don't care about gotos inside eval, as they are forbidden at run time. */
1359     break;
1360    case OP_GOTO:
1361     return 1;
1362    default:
1363     if (su_uplevel_goto_static(((const UNOP *) o)->op_first))
1364      return 1;
1365     break;
1366   }
1367  }
1368
1369  return 0;
1370 }
1371
1372 #if SU_UPLEVEL_HIJACKS_RUNOPS
1373
1374 STATIC int su_uplevel_goto_runops(pTHX) {
1375 #define su_uplevel_goto_runops() su_uplevel_goto_runops(aTHX)
1376  register OP *op;
1377  dVAR;
1378
1379  op = PL_op;
1380  do {
1381   if (op->op_type == OP_GOTO) {
1382    AV  *argarray = NULL;
1383    I32  cxix;
1384
1385    for (cxix = cxstack_ix; cxix >= 0; --cxix) {
1386     const PERL_CONTEXT *cx = cxstack + cxix;
1387
1388     switch (CxTYPE(cx)) {
1389      case CXt_SUB:
1390       if (CxHASARGS(cx)) {
1391        argarray = cx->blk_sub.argarray;
1392        goto done;
1393       }
1394       break;
1395      case CXt_EVAL:
1396      case CXt_FORMAT:
1397       goto done;
1398      default:
1399       break;
1400     }
1401    }
1402
1403 done:
1404    if (argarray) {
1405     dMY_CXT;
1406
1407     if (MY_CXT.uplevel_storage.top->cxix == cxix) {
1408      AV  *args  = GvAV(PL_defgv);
1409      I32  items = AvFILLp(args);
1410
1411      av_extend(argarray, items);
1412      Copy(AvARRAY(args), AvARRAY(argarray), items + 1, SV *);
1413      AvFILLp(argarray) = items;
1414     }
1415    }
1416   }
1417
1418   PL_op = op = op->op_ppaddr(aTHX);
1419
1420 #if !SU_HAS_PERL(5, 13, 0)
1421   PERL_ASYNC_CHECK();
1422 #endif
1423  } while (op);
1424
1425  TAINT_NOT;
1426
1427  return 0;
1428 }
1429
1430 #endif /* SU_UPLEVEL_HIJACKS_RUNOPS */
1431
1432 #define su_at_underscore(C) PadARRAY(PadlistARRAY(CvPADLIST(C))[CvDEPTH(C)])[0]
1433
1434 STATIC void su_uplevel_restore(pTHX_ void *sus_) {
1435  su_uplevel_ud *sud = sus_;
1436  PERL_SI *cur = sud->old_curstackinfo;
1437  PERL_SI *si  = sud->si;
1438
1439 #if SU_UPLEVEL_HIJACKS_RUNOPS
1440  if (PL_runops == su_uplevel_goto_runops)
1441   PL_runops = sud->old_runops;
1442 #endif
1443
1444  if (sud->callback) {
1445   PERL_CONTEXT *cx = cxstack + sud->cxix;
1446   AV     *argarray = MUTABLE_AV(su_at_underscore(sud->callback));
1447
1448   /* We have to fix the pad entry for @_ in the original callback because it
1449    * may have been reified. */
1450   if (AvREAL(argarray)) {
1451    const I32 fill = AvFILLp(argarray);
1452    SvREFCNT_dec(argarray);
1453    argarray = newAV();
1454    AvREAL_off(argarray);
1455    AvREIFY_on(argarray);
1456    av_extend(argarray, fill);
1457    su_at_underscore(sud->callback) = MUTABLE_SV(argarray);
1458   } else {
1459    CLEAR_ARGARRAY(argarray);
1460   }
1461
1462   /* If the old cv member is our renamed CV, it means that this place has been
1463    * reached without a goto() happening, and the old argarray member is
1464    * actually our fake argarray. Destroy it properly in that case. */
1465   if (cx->blk_sub.cv == sud->renamed) {
1466    SvREFCNT_dec(cx->blk_sub.argarray);
1467    cx->blk_sub.argarray = argarray;
1468   }
1469
1470   CvDEPTH(sud->callback)--;
1471   SvREFCNT_dec(sud->callback);
1472  }
1473
1474  /* Free the renamed CV. We must do it ourselves so that we can force the
1475   * depth to be 0, or perl would complain about it being "still in use".
1476   * But we *know* that it cannot be so. */
1477  if (sud->renamed) {
1478   CvDEPTH(sud->renamed)   = 0;
1479   CvPADLIST(sud->renamed) = NULL;
1480   SvREFCNT_dec(sud->renamed);
1481  }
1482
1483  CATCH_SET(sud->old_catch);
1484
1485  SU_UPLEVEL_RESTORE(op);
1486
1487  /* stack_grow() wants PL_curstack so restore the old stack first */
1488  if (PL_curstackinfo == si) {
1489   PL_curstack = cur->si_stack;
1490   if (sud->old_mainstack)
1491    SU_UPLEVEL_RESTORE(mainstack);
1492   SU_UPLEVEL_RESTORE(curstackinfo);
1493
1494   if (sud->died) {
1495    CV *target = sud->target;
1496    I32 levels = 0, i;
1497
1498    /* When we die, the depth of the target CV is not updated because of the
1499     * stack switcheroo. So we have to look at all the frames between the
1500     * uplevel call and the catch block to count how many call frames to the
1501     * target CV were skipped. */
1502    for (i = cur->si_cxix; i > sud->cxix; i--) {
1503     register const PERL_CONTEXT *cx = cxstack + i;
1504
1505     if (CxTYPE(cx) == CXt_SUB) {
1506      if (cx->blk_sub.cv == target)
1507       ++levels;
1508     }
1509    }
1510
1511    /* If we died, the replacement stack was already unwinded to the first
1512     * eval frame, and all the contexts down there were popped. We don't have
1513     * to pop manually any context of the original stack, because they must
1514     * have been in the replacement stack as well (since the second was copied
1515     * from the first). Thus we only have to make sure the original stack index
1516     * points to the context just below the first eval scope under the target
1517     * frame. */
1518    for (; i >= 0; i--) {
1519     register const PERL_CONTEXT *cx = cxstack + i;
1520
1521     switch (CxTYPE(cx)) {
1522      case CXt_SUB:
1523       if (cx->blk_sub.cv == target)
1524        ++levels;
1525       break;
1526      case CXt_EVAL:
1527       goto found_it;
1528       break;
1529      default:
1530       break;
1531     }
1532    }
1533
1534 found_it:
1535    CvDEPTH(target) = sud->target_depth - levels;
1536    PL_curstackinfo->si_cxix = i - 1;
1537
1538 #if !SU_HAS_PERL(5, 13, 1)
1539    /* Since $@ was maybe localized between the target frame and the uplevel
1540     * call, we forcefully flush the save stack to get rid of it and then
1541     * reset $@ to its proper value. Note that the the call to
1542     * su_uplevel_restore() must happen before the "reset $@" item of the save
1543     * stack is processed, as uplevel was called after the localization.
1544     * Andrew's changes to how $@ was handled, which were mainly integrated
1545     * between perl 5.13.0 and 5.13.1, fixed this. */
1546    if (ERRSV && SvTRUE(ERRSV)) {
1547     register const PERL_CONTEXT *cx = cxstack + i; /* This is the eval scope */
1548     SV *errsv = SvREFCNT_inc(ERRSV);
1549     PL_scopestack_ix = cx->blk_oldscopesp;
1550     leave_scope(PL_scopestack[PL_scopestack_ix]);
1551     sv_setsv(ERRSV, errsv);
1552     SvREFCNT_dec(errsv);
1553    }
1554 #endif
1555   }
1556  }
1557
1558  SU_UPLEVEL_RESTORE(curcop);
1559
1560  SvREFCNT_dec(sud->target);
1561
1562  PL_stack_base = AvARRAY(cur->si_stack);
1563  PL_stack_sp   = PL_stack_base + AvFILLp(cur->si_stack);
1564  PL_stack_max  = PL_stack_base + AvMAX(cur->si_stack);
1565
1566  /* When an exception is thrown from the uplevel'd subroutine,
1567   * su_uplevel_restore() may be called by the LEAVE in die_unwind() (renamed
1568   * die_where() in more recent perls), which has the sad habit of keeping a
1569   * pointer to the current context frame across this call. This means that we
1570   * can't free the temporary context stack we used for the uplevel call right
1571   * now, or that pointer upwards would point to garbage. */
1572 #if SU_HAS_PERL(5, 13, 7)
1573  /* This issue has been fixed in perl with commit 8f89e5a9, which was made
1574   * public in perl 5.13.7. */
1575  su_uplevel_storage_delete(sud);
1576 #else
1577  /* Otherwise, we just enqueue it back in the global storage list. */
1578  {
1579   dMY_CXT;
1580
1581   sud->tmp_uid_storage = MY_CXT.uid_storage;
1582   MY_CXT.uid_storage   = sud->old_uid_storage;
1583
1584   MY_CXT.uplevel_storage.top  = sud->next;
1585   sud->next = MY_CXT.uplevel_storage.root;
1586   MY_CXT.uplevel_storage.root = sud;
1587   MY_CXT.uplevel_storage.count++;
1588  }
1589 #endif
1590
1591  return;
1592 }
1593
1594 STATIC CV *su_cv_clone(pTHX_ CV *proto, GV *gv) {
1595 #define su_cv_clone(P, G) su_cv_clone(aTHX_ (P), (G))
1596  dVAR;
1597  CV *cv;
1598
1599  cv = MUTABLE_CV(newSV_type(SvTYPE(proto)));
1600
1601  CvFLAGS(cv)  = CvFLAGS(proto);
1602 #ifdef CVf_CVGV_RC
1603  CvFLAGS(cv) &= ~CVf_CVGV_RC;
1604 #endif
1605  CvDEPTH(cv)  = CvDEPTH(proto);
1606 #ifdef USE_ITHREADS
1607  CvFILE(cv)   = CvISXSUB(proto) ? CvFILE(proto) : savepv(CvFILE(proto));
1608 #else
1609  CvFILE(cv)   = CvFILE(proto);
1610 #endif
1611
1612  CvGV_set(cv, gv);
1613  CvSTASH_set(cv, CvSTASH(proto));
1614  /* Commit 4c74a7df, publicized with perl 5.13.3, began to add backrefs to
1615   * stashes. CvSTASH_set() started to do it as well with commit c68d95645
1616   * (which was part of perl 5.13.7). */
1617 #if SU_HAS_PERL(5, 13, 3) && !SU_HAS_PERL(5, 13, 7)
1618  if (CvSTASH(proto))
1619   Perl_sv_add_backref(aTHX_ CvSTASH(proto), MUTABLE_SV(cv));
1620 #endif
1621
1622  if (CvISXSUB(proto)) {
1623   CvXSUB(cv)       = CvXSUB(proto);
1624   CvXSUBANY(cv)    = CvXSUBANY(proto);
1625  } else {
1626   OP_REFCNT_LOCK;
1627   CvROOT(cv)       = OpREFCNT_inc(CvROOT(proto));
1628   OP_REFCNT_UNLOCK;
1629   CvSTART(cv)      = CvSTART(proto);
1630  }
1631  CvOUTSIDE(cv)     = CvOUTSIDE(proto);
1632 #ifdef CVf_WEAKOUTSIDE
1633  if (!(CvFLAGS(proto) & CVf_WEAKOUTSIDE))
1634 #endif
1635   SvREFCNT_inc_simple_void(CvOUTSIDE(cv));
1636  CvPADLIST(cv)     = CvPADLIST(proto);
1637 #ifdef CvOUTSIDE_SEQ
1638  CvOUTSIDE_SEQ(cv) = CvOUTSIDE_SEQ(proto);
1639 #endif
1640
1641  if (SvPOK(proto))
1642   sv_setpvn(MUTABLE_SV(cv), SvPVX_const(proto), SvCUR(proto));
1643
1644 #ifdef CvCONST
1645  if (CvCONST(cv))
1646   CvCONST_off(cv);
1647 #endif
1648
1649  return cv;
1650 }
1651
1652 STATIC I32 su_uplevel(pTHX_ CV *callback, I32 cxix, I32 args) {
1653 #define su_uplevel(C, I, A) su_uplevel(aTHX_ (C), (I), (A))
1654  su_uplevel_ud *sud;
1655  const PERL_CONTEXT *cx = cxstack + cxix;
1656  PERL_SI *si;
1657  PERL_SI *cur = PL_curstackinfo;
1658  SV **old_stack_sp;
1659  CV  *target;
1660  CV  *renamed;
1661  UNOP sub_op;
1662  I32  gimme;
1663  I32  old_mark, new_mark;
1664  I32  ret;
1665  dSP;
1666
1667  ENTER;
1668
1669  gimme = GIMME_V;
1670  /* Make PL_stack_sp point just before the CV. */
1671  PL_stack_sp -= args + 1;
1672  old_mark = AvFILLp(PL_curstack) = PL_stack_sp - PL_stack_base;
1673  SPAGAIN;
1674
1675  sud = su_uplevel_storage_new(cxix);
1676
1677  sud->cxix     = cxix;
1678  sud->died     = 1;
1679  sud->callback = NULL;
1680  sud->renamed  = NULL;
1681  SAVEDESTRUCTOR_X(su_uplevel_restore, sud);
1682
1683  si = sud->si;
1684
1685  si->si_type    = cur->si_type;
1686  si->si_next    = NULL;
1687  si->si_prev    = cur->si_prev;
1688 #ifdef DEBUGGING
1689  si->si_markoff = cx->blk_oldmarksp;
1690 #endif
1691
1692  /* Allocate enough space for all the elements of the original stack up to the
1693   * target context, plus the forthcoming arguments. */
1694  new_mark = cx->blk_oldsp;
1695  av_extend(si->si_stack, new_mark + 1 + args + 1);
1696  Copy(PL_curstack, AvARRAY(si->si_stack), new_mark + 1, SV *);
1697  AvFILLp(si->si_stack) = new_mark;
1698  SU_POISON(AvARRAY(si->si_stack) + new_mark + 1, args + 1, SV *);
1699
1700  /* Specialized SWITCHSTACK() */
1701  PL_stack_base = AvARRAY(si->si_stack);
1702  old_stack_sp  = PL_stack_sp;
1703  PL_stack_sp   = PL_stack_base + AvFILLp(si->si_stack);
1704  PL_stack_max  = PL_stack_base + AvMAX(si->si_stack);
1705  SPAGAIN;
1706
1707  /* Copy the context stack up to the context just below the target. */
1708  si->si_cxix = (cxix < 0) ? -1 : (cxix - 1);
1709  if (si->si_cxmax < cxix) {
1710   /* The max size must be at least two so that GROW(max) = (max*3)/2 > max */
1711   si->si_cxmax = (cxix < 4) ? 4 : cxix;
1712   Renew(si->si_cxstack, si->si_cxmax + 1, PERL_CONTEXT);
1713  }
1714  Copy(cur->si_cxstack, si->si_cxstack, cxix, PERL_CONTEXT);
1715  SU_POISON(si->si_cxstack + cxix, si->si_cxmax + 1 - cxix, PERL_CONTEXT);
1716
1717  target            = cx->blk_sub.cv;
1718  sud->target       = (CV *) SvREFCNT_inc(target);
1719  sud->target_depth = CvDEPTH(target);
1720
1721  /* blk_oldcop is essentially needed for caller() and stack traces. It has no
1722   * run-time implication, since PL_curcop will be overwritten as soon as we
1723   * enter a sub (a sub starts by a nextstate/dbstate). Hence it's safe to just
1724   * make it point to the blk_oldcop for the target frame, so that caller()
1725   * reports the right file name, line number and lexical hints. */
1726  SU_UPLEVEL_SAVE(curcop, cx->blk_oldcop);
1727  /* Don't reset PL_markstack_ptr, or we would overwrite the mark stack below
1728   * this point. Don't reset PL_curpm either, we want the most recent matches. */
1729
1730  SU_UPLEVEL_SAVE(curstackinfo, si);
1731  /* If those two are equal, we need to fool POPSTACK_TO() */
1732  if (PL_mainstack == PL_curstack)
1733   SU_UPLEVEL_SAVE(mainstack, si->si_stack);
1734  else
1735   sud->old_mainstack = NULL;
1736  PL_curstack = si->si_stack;
1737
1738  renamed      = su_cv_clone(callback, CvGV(target));
1739  sud->renamed = renamed;
1740
1741  PUSHMARK(SP);
1742  /* Both SP and old_stack_sp point just before the CV. */
1743  Copy(old_stack_sp + 2, SP + 1, args, SV *);
1744  SP += args;
1745  PUSHs((SV *) renamed);
1746  PUTBACK;
1747
1748  Zero(&sub_op, 1, UNOP);
1749  sub_op.op_type  = OP_ENTERSUB;
1750  sub_op.op_next  = NULL;
1751  sub_op.op_flags = OP_GIMME_REVERSE(gimme) | OPf_STACKED;
1752  if (PL_DBsub)
1753   sub_op.op_flags |= OPpENTERSUB_DB;
1754
1755  SU_UPLEVEL_SAVE(op, (OP *) &sub_op);
1756
1757 #if SU_UPLEVEL_HIJACKS_RUNOPS
1758  sud->old_runops = PL_runops;
1759 #endif
1760
1761  sud->old_catch = CATCH_GET;
1762  CATCH_SET(TRUE);
1763
1764  if ((PL_op = PL_ppaddr[OP_ENTERSUB](aTHX))) {
1765   PERL_CONTEXT *sub_cx = cxstack + cxstack_ix;
1766
1767   /* If pp_entersub() returns a non-null OP, it means that the callback is not
1768    * an XSUB. */
1769
1770   sud->callback = MUTABLE_CV(SvREFCNT_inc(callback));
1771   CvDEPTH(callback)++;
1772
1773   if (CxHASARGS(cx) && cx->blk_sub.argarray) {
1774    /* The call to pp_entersub() has saved the current @_ (in XS terms,
1775     * GvAV(PL_defgv)) in the savearray member, and has created a new argarray
1776     * with what we put on the stack. But we want to fake up the same arguments
1777     * as the ones in use at the context we uplevel to, so we replace the
1778     * argarray with an unreal copy of the original @_. */
1779    AV *av = newAV();
1780    AvREAL_off(av);
1781    AvREIFY_on(av);
1782    av_extend(av, AvMAX(cx->blk_sub.argarray));
1783    AvFILLp(av) = AvFILLp(cx->blk_sub.argarray);
1784    Copy(AvARRAY(cx->blk_sub.argarray), AvARRAY(av), AvFILLp(av) + 1, SV *);
1785    sub_cx->blk_sub.argarray = av;
1786   } else {
1787    SvREFCNT_inc_simple_void(sub_cx->blk_sub.argarray);
1788   }
1789
1790   if (su_uplevel_goto_static(CvROOT(renamed))) {
1791 #if SU_UPLEVEL_HIJACKS_RUNOPS
1792    if (PL_runops != PL_runops_std) {
1793     if (PL_runops == PL_runops_dbg) {
1794      if (PL_debug)
1795       croak("uplevel() can't execute code that calls goto when debugging flags are set");
1796     } else if (PL_runops != su_uplevel_goto_runops)
1797      croak("uplevel() can't execute code that calls goto with a custom runloop");
1798    }
1799
1800    PL_runops = su_uplevel_goto_runops;
1801 #else  /* SU_UPLEVEL_HIJACKS_RUNOPS */
1802    croak("uplevel() can't execute code that calls goto before perl 5.8");
1803 #endif /* !SU_UPLEVEL_HIJACKS_RUNOPS */
1804   }
1805
1806   CALLRUNOPS(aTHX);
1807  }
1808
1809  sud->died = 0;
1810
1811  ret = PL_stack_sp - (PL_stack_base + new_mark);
1812  if (ret > 0) {
1813   AV *old_stack = sud->old_curstackinfo->si_stack;
1814
1815   if (old_mark + ret > AvMAX(old_stack)) {
1816    /* Specialized EXTEND(old_sp, ret) */
1817    av_extend(old_stack, old_mark + ret + 1);
1818    old_stack_sp = AvARRAY(old_stack) + old_mark;
1819   }
1820
1821   Copy(PL_stack_sp - ret + 1, old_stack_sp + 1, ret, SV *);
1822   PL_stack_sp        += ret;
1823   AvFILLp(old_stack) += ret;
1824  }
1825
1826  LEAVE;
1827
1828  return ret;
1829 }
1830
1831 /* --- Unique context ID --------------------------------------------------- */
1832
1833 STATIC su_uid *su_uid_storage_fetch(pTHX_ UV depth) {
1834 #define su_uid_storage_fetch(D) su_uid_storage_fetch(aTHX_ (D))
1835  su_uid **map, *uid;
1836  STRLEN alloc;
1837  dMY_CXT;
1838
1839  map   = MY_CXT.uid_storage.map;
1840  alloc = MY_CXT.uid_storage.alloc;
1841
1842  if (depth >= alloc) {
1843   STRLEN i;
1844
1845   Renew(map, depth + 1, su_uid *);
1846   for (i = alloc; i <= depth; ++i)
1847    map[i] = NULL;
1848
1849   MY_CXT.uid_storage.map   = map;
1850   MY_CXT.uid_storage.alloc = depth + 1;
1851  }
1852
1853  uid = map[depth];
1854
1855  if (!uid) {
1856   Newx(uid, 1, su_uid);
1857   uid->seq   = 0;
1858   uid->flags = 0;
1859   map[depth] = uid;
1860  }
1861
1862  if (depth >= MY_CXT.uid_storage.used)
1863   MY_CXT.uid_storage.used = depth + 1;
1864
1865  return uid;
1866 }
1867
1868 STATIC int su_uid_storage_check(pTHX_ UV depth, UV seq) {
1869 #define su_uid_storage_check(D, S) su_uid_storage_check(aTHX_ (D), (S))
1870  su_uid *uid;
1871  dMY_CXT;
1872
1873  if (depth >= MY_CXT.uid_storage.used)
1874   return 0;
1875
1876  uid = MY_CXT.uid_storage.map[depth];
1877
1878  return uid && (uid->seq == seq) && (uid->flags & SU_UID_ACTIVE);
1879 }
1880
1881 STATIC void su_uid_drop(pTHX_ void *ud_) {
1882  su_uid *uid = ud_;
1883
1884  uid->flags &= ~SU_UID_ACTIVE;
1885 }
1886
1887 STATIC void su_uid_bump(pTHX_ void *ud_) {
1888  su_ud_reap *ud  = ud_;
1889
1890  SAVEDESTRUCTOR_X(su_uid_drop, ud->cb);
1891 }
1892
1893 STATIC SV *su_uid_get(pTHX_ I32 cxix) {
1894 #define su_uid_get(I) su_uid_get(aTHX_ (I))
1895  su_uid *uid;
1896  SV *uid_sv;
1897  UV depth;
1898
1899  depth = su_uid_depth(cxix);
1900  uid   = su_uid_storage_fetch(depth);
1901
1902  if (!(uid->flags & SU_UID_ACTIVE)) {
1903   su_ud_reap *ud;
1904
1905   uid->seq = su_uid_seq_next(depth);
1906   uid->flags |= SU_UID_ACTIVE;
1907
1908   Newx(ud, 1, su_ud_reap);
1909   SU_UD_ORIGIN(ud)  = NULL;
1910   SU_UD_HANDLER(ud) = su_uid_bump;
1911   ud->cb = (SV *) uid;
1912   su_init(ud, cxix, SU_SAVE_DESTRUCTOR_SIZE);
1913  }
1914
1915  uid_sv = sv_newmortal();
1916  sv_setpvf(uid_sv, "%"UVuf"-%"UVuf, depth, uid->seq);
1917  return uid_sv;
1918 }
1919
1920 #ifdef grok_number
1921
1922 #define su_grok_number(S, L, VP) grok_number((S), (L), (VP))
1923
1924 #else /* grok_number */
1925
1926 #define IS_NUMBER_IN_UV 0x1
1927
1928 STATIC int su_grok_number(pTHX_ const char *s, STRLEN len, UV *valuep) {
1929 #define su_grok_number(S, L, VP) su_grok_number(aTHX_ (S), (L), (VP))
1930  STRLEN i;
1931  SV *tmpsv;
1932
1933  /* This crude check should be good enough for a fallback implementation.
1934   * Better be too strict than too lax. */
1935  for (i = 0; i < len; ++i) {
1936   if (!isDIGIT(s[i]))
1937    return 0;
1938  }
1939
1940  tmpsv = sv_newmortal();
1941  sv_setpvn(tmpsv, s, len);
1942  *valuep = sv_2uv(tmpsv);
1943
1944  return IS_NUMBER_IN_UV;
1945 }
1946
1947 #endif /* !grok_number */
1948
1949 STATIC int su_uid_validate(pTHX_ SV *uid) {
1950 #define su_uid_validate(U) su_uid_validate(aTHX_ (U))
1951  const char *s;
1952  STRLEN len, p = 0;
1953  UV depth, seq;
1954  int type;
1955
1956  s = SvPV_const(uid, len);
1957
1958  while (p < len && s[p] != '-')
1959   ++p;
1960  if (p >= len)
1961   croak("UID contains only one part");
1962
1963  type = su_grok_number(s, p, &depth);
1964  if (type != IS_NUMBER_IN_UV)
1965   croak("First UID part is not an unsigned integer");
1966
1967  ++p; /* Skip '-'. As we used to have p < len, len - (p + 1) >= 0. */
1968
1969  type = su_grok_number(s + p, len - p, &seq);
1970  if (type != IS_NUMBER_IN_UV)
1971   croak("Second UID part is not an unsigned integer");
1972
1973  return su_uid_storage_check(depth, seq);
1974 }
1975
1976 /* --- Context operations -------------------------------------------------- */
1977
1978 /* Remove sequences of BLOCKs having DB for stash, followed by a SUB context
1979  * for the debugger callback. */
1980
1981 STATIC I32 su_context_skip_db(pTHX_ I32 cxix) {
1982 #define su_context_skip_db(C) su_context_skip_db(aTHX_ (C))
1983  I32 i;
1984
1985  if (!PL_DBsub)
1986   return cxix;
1987
1988  for (i = cxix; i > 0; --i) {
1989   PERL_CONTEXT *cx = cxstack + i;
1990
1991   switch (CxTYPE(cx)) {
1992    case CXt_BLOCK:
1993     if (cx->blk_oldcop && CopSTASH(cx->blk_oldcop) == GvSTASH(PL_DBgv))
1994      continue;
1995     break;
1996    case CXt_SUB:
1997     if (cx->blk_sub.cv == GvCV(PL_DBsub)) {
1998      cxix = i - 1;
1999      continue;
2000     }
2001     break;
2002    default:
2003     break;
2004   }
2005
2006   break;
2007  }
2008
2009  return cxix;
2010 }
2011
2012
2013 STATIC I32 su_context_normalize_up(pTHX_ I32 cxix) {
2014 #define su_context_normalize_up(C) su_context_normalize_up(aTHX_ (C))
2015  PERL_CONTEXT *cx;
2016
2017  if (cxix <= 0)
2018   return 0;
2019
2020  cx = cxstack + cxix;
2021  if (CxTYPE(cx) == CXt_BLOCK) {
2022   PERL_CONTEXT *prev = cx - 1;
2023
2024   switch (CxTYPE(prev)) {
2025 #if SU_HAS_PERL(5, 10, 0)
2026    case CXt_GIVEN:
2027    case CXt_WHEN:
2028 #endif
2029 #if SU_HAS_PERL(5, 11, 0)
2030    /* That's the only subcategory that can cause an extra BLOCK context */
2031    case CXt_LOOP_PLAIN:
2032 #else
2033    case CXt_LOOP:
2034 #endif
2035     if (cx->blk_oldcop == prev->blk_oldcop)
2036      return cxix - 1;
2037     break;
2038    case CXt_SUBST:
2039     if (cx->blk_oldcop && cx->blk_oldcop->op_sibling
2040                        && cx->blk_oldcop->op_sibling->op_type == OP_SUBST)
2041      return cxix - 1;
2042     break;
2043   }
2044  }
2045
2046  return cxix;
2047 }
2048
2049 STATIC I32 su_context_normalize_down(pTHX_ I32 cxix) {
2050 #define su_context_normalize_down(C) su_context_normalize_down(aTHX_ (C))
2051  PERL_CONTEXT *next;
2052
2053  if (cxix >= cxstack_ix)
2054   return cxstack_ix;
2055
2056  next = cxstack + cxix + 1;
2057  if (CxTYPE(next) == CXt_BLOCK) {
2058   PERL_CONTEXT *cx = next - 1;
2059
2060   switch (CxTYPE(cx)) {
2061 #if SU_HAS_PERL(5, 10, 0)
2062    case CXt_GIVEN:
2063    case CXt_WHEN:
2064 #endif
2065 #if SU_HAS_PERL(5, 11, 0)
2066    /* That's the only subcategory that can cause an extra BLOCK context */
2067    case CXt_LOOP_PLAIN:
2068 #else
2069    case CXt_LOOP:
2070 #endif
2071     if (cx->blk_oldcop == next->blk_oldcop)
2072      return cxix + 1;
2073     break;
2074    case CXt_SUBST:
2075     if (next->blk_oldcop && next->blk_oldcop->op_sibling
2076                          && next->blk_oldcop->op_sibling->op_type == OP_SUBST)
2077      return cxix + 1;
2078     break;
2079   }
2080  }
2081
2082  return cxix;
2083 }
2084
2085 #define su_context_here() su_context_normalize_up(su_context_skip_db(cxstack_ix))
2086
2087 /* --- Interpreter setup/teardown ------------------------------------------ */
2088
2089 STATIC void su_teardown(pTHX_ void *param) {
2090  su_uplevel_ud *cur;
2091  su_uid **map;
2092  dMY_CXT;
2093
2094  map = MY_CXT.uid_storage.map;
2095  if (map) {
2096   STRLEN i;
2097   for (i = 0; i < MY_CXT.uid_storage.used; ++i)
2098    Safefree(map[i]);
2099   Safefree(map);
2100  }
2101
2102  cur = MY_CXT.uplevel_storage.root;
2103  if (cur) {
2104   su_uplevel_ud *prev;
2105   do {
2106    prev = cur;
2107    cur  = prev->next;
2108    su_uplevel_ud_delete(prev);
2109   } while (cur);
2110  }
2111
2112  return;
2113 }
2114
2115 STATIC void su_setup(pTHX) {
2116 #define su_setup() su_setup(aTHX)
2117  MY_CXT_INIT;
2118
2119  MY_CXT.stack_placeholder = NULL;
2120
2121  /* NewOp() calls calloc() which just zeroes the memory with memset(). */
2122  Zero(&(MY_CXT.unwind_storage.return_op), 1, LISTOP);
2123  MY_CXT.unwind_storage.return_op.op_type   = OP_RETURN;
2124  MY_CXT.unwind_storage.return_op.op_ppaddr = PL_ppaddr[OP_RETURN];
2125
2126  Zero(&(MY_CXT.unwind_storage.proxy_op), 1, OP);
2127  MY_CXT.unwind_storage.proxy_op.op_type   = OP_STUB;
2128  MY_CXT.unwind_storage.proxy_op.op_ppaddr = NULL;
2129
2130  Zero(&(MY_CXT.yield_storage.leave_op), 1, UNOP);
2131  MY_CXT.yield_storage.leave_op.op_type   = OP_STUB;
2132  MY_CXT.yield_storage.leave_op.op_ppaddr = NULL;
2133
2134  Zero(&(MY_CXT.yield_storage.proxy_op), 1, OP);
2135  MY_CXT.yield_storage.proxy_op.op_type   = OP_STUB;
2136  MY_CXT.yield_storage.proxy_op.op_ppaddr = NULL;
2137
2138  MY_CXT.uplevel_storage.top   = NULL;
2139  MY_CXT.uplevel_storage.root  = NULL;
2140  MY_CXT.uplevel_storage.count = 0;
2141
2142  MY_CXT.uid_storage.map   = NULL;
2143  MY_CXT.uid_storage.used  = 0;
2144  MY_CXT.uid_storage.alloc = 0;
2145
2146  call_atexit(su_teardown, NULL);
2147
2148  return;
2149 }
2150
2151 /* --- XS ------------------------------------------------------------------ */
2152
2153 #define SU_GET_CONTEXT(A, B, D) \
2154  STMT_START {                   \
2155   if (items > A) {              \
2156    SV *csv = ST(B);             \
2157    if (!SvOK(csv))              \
2158     goto default_cx;            \
2159    cxix = SvIV(csv);            \
2160    if (cxix < 0)                \
2161     cxix = 0;                   \
2162    else if (cxix > cxstack_ix)  \
2163     goto default_cx;            \
2164   } else {                      \
2165 default_cx:                     \
2166    cxix = (D);                  \
2167   }                             \
2168  } STMT_END
2169
2170 #define SU_GET_LEVEL(A, B) \
2171  STMT_START {              \
2172   level = 0;               \
2173   if (items > 0) {         \
2174    SV *lsv = ST(B);        \
2175    if (SvOK(lsv)) {        \
2176     level = SvIV(lsv);     \
2177     if (level < 0)         \
2178      level = 0;            \
2179    }                       \
2180   }                        \
2181  } STMT_END
2182
2183 XS(XS_Scope__Upper_unwind); /* prototype to pass -Wmissing-prototypes */
2184
2185 XS(XS_Scope__Upper_unwind) {
2186 #ifdef dVAR
2187  dVAR; dXSARGS;
2188 #else
2189  dXSARGS;
2190 #endif
2191  dMY_CXT;
2192  I32 cxix;
2193
2194  PERL_UNUSED_VAR(cv); /* -W */
2195  PERL_UNUSED_VAR(ax); /* -Wall */
2196
2197  SU_GET_CONTEXT(0, items - 1, cxstack_ix);
2198  do {
2199   PERL_CONTEXT *cx = cxstack + cxix;
2200   switch (CxTYPE(cx)) {
2201    case CXt_SUB:
2202     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2203      continue;
2204    case CXt_EVAL:
2205    case CXt_FORMAT:
2206     MY_CXT.unwind_storage.cxix  = cxix;
2207     MY_CXT.unwind_storage.items = items;
2208     /* pp_entersub will want to sanitize the stack after returning from there
2209      * Screw that, we're insane */
2210     if (GIMME_V == G_SCALAR) {
2211      MY_CXT.unwind_storage.savesp = PL_stack_sp;
2212      /* dXSARGS calls POPMARK, so we need to match PL_markstack_ptr[1] */
2213      PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
2214     } else {
2215      MY_CXT.unwind_storage.savesp = NULL;
2216     }
2217     SAVEDESTRUCTOR_X(su_unwind, NULL);
2218     return;
2219    default:
2220     break;
2221   }
2222  } while (--cxix >= 0);
2223  croak("Can't return outside a subroutine");
2224 }
2225
2226 XS(XS_Scope__Upper_yield); /* prototype to pass -Wmissing-prototypes */
2227
2228 XS(XS_Scope__Upper_yield) {
2229 #ifdef dVAR
2230  dVAR; dXSARGS;
2231 #else
2232  dXSARGS;
2233 #endif
2234  dMY_CXT;
2235  I32 cxix;
2236
2237  PERL_UNUSED_VAR(cv); /* -W */
2238  PERL_UNUSED_VAR(ax); /* -Wall */
2239
2240  SU_GET_CONTEXT(0, items - 1, su_context_here());
2241  MY_CXT.yield_storage.cxix  = cxix;
2242  MY_CXT.yield_storage.items = items;
2243  /* See XS_Scope__Upper_unwind */
2244  if (GIMME_V == G_SCALAR) {
2245   MY_CXT.yield_storage.savesp = PL_stack_sp;
2246   PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
2247  } else {
2248   MY_CXT.yield_storage.savesp = NULL;
2249  }
2250  SAVEDESTRUCTOR_X(su_yield, NULL);
2251  return;
2252 }
2253
2254 MODULE = Scope::Upper            PACKAGE = Scope::Upper
2255
2256 PROTOTYPES: ENABLE
2257
2258 BOOT:
2259 {
2260  HV *stash;
2261
2262  MUTEX_INIT(&su_uid_seq_counter_mutex);
2263
2264  su_uid_seq_counter.seqs = NULL;
2265  su_uid_seq_counter.size = 0;
2266
2267  stash = gv_stashpv(__PACKAGE__, 1);
2268  newCONSTSUB(stash, "TOP",           newSViv(0));
2269  newCONSTSUB(stash, "SU_THREADSAFE", newSVuv(SU_THREADSAFE));
2270
2271  newXSproto("Scope::Upper::unwind", XS_Scope__Upper_unwind, file, NULL);
2272  newXSproto("Scope::Upper::yield",  XS_Scope__Upper_yield,  file, NULL);
2273
2274  su_setup();
2275 }
2276
2277 #if SU_THREADSAFE
2278
2279 void
2280 CLONE(...)
2281 PROTOTYPE: DISABLE
2282 PREINIT:
2283  su_uid_storage new_cxt;
2284 PPCODE:
2285  {
2286   dMY_CXT;
2287   new_cxt.map   = NULL;
2288   new_cxt.used  = 0;
2289   new_cxt.alloc = 0;
2290   su_uid_storage_dup(&new_cxt, &MY_CXT.uid_storage, MY_CXT.uid_storage.used);
2291  }
2292  {
2293   MY_CXT_CLONE;
2294   MY_CXT.uplevel_storage.top   = NULL;
2295   MY_CXT.uplevel_storage.root  = NULL;
2296   MY_CXT.uplevel_storage.count = 0;
2297   MY_CXT.uid_storage           = new_cxt;
2298  }
2299  XSRETURN(0);
2300
2301 #endif /* SU_THREADSAFE */
2302
2303 void
2304 HERE()
2305 PROTOTYPE:
2306 PREINIT:
2307  I32 cxix;
2308 PPCODE:
2309  cxix = su_context_here();
2310  EXTEND(SP, 1);
2311  mPUSHi(cxix);
2312  XSRETURN(1);
2313
2314 void
2315 UP(...)
2316 PROTOTYPE: ;$
2317 PREINIT:
2318  I32 cxix;
2319 PPCODE:
2320  SU_GET_CONTEXT(0, 0, su_context_here());
2321  if (cxix > 0) {
2322   --cxix;
2323   cxix = su_context_skip_db(cxix);
2324   cxix = su_context_normalize_up(cxix);
2325  }
2326  EXTEND(SP, 1);
2327  mPUSHi(cxix);
2328  XSRETURN(1);
2329
2330 void
2331 SUB(...)
2332 PROTOTYPE: ;$
2333 PREINIT:
2334  I32 cxix;
2335 PPCODE:
2336  SU_GET_CONTEXT(0, 0, cxstack_ix);
2337  EXTEND(SP, 1);
2338  for (; cxix >= 0; --cxix) {
2339   PERL_CONTEXT *cx = cxstack + cxix;
2340   switch (CxTYPE(cx)) {
2341    default:
2342     continue;
2343    case CXt_SUB:
2344     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2345      continue;
2346     mPUSHi(cxix);
2347     XSRETURN(1);
2348   }
2349  }
2350  XSRETURN_UNDEF;
2351
2352 void
2353 EVAL(...)
2354 PROTOTYPE: ;$
2355 PREINIT:
2356  I32 cxix;
2357 PPCODE:
2358  SU_GET_CONTEXT(0, 0, cxstack_ix);
2359  EXTEND(SP, 1);
2360  for (; cxix >= 0; --cxix) {
2361   PERL_CONTEXT *cx = cxstack + cxix;
2362   switch (CxTYPE(cx)) {
2363    default:
2364     continue;
2365    case CXt_EVAL:
2366     mPUSHi(cxix);
2367     XSRETURN(1);
2368   }
2369  }
2370  XSRETURN_UNDEF;
2371
2372 void
2373 SCOPE(...)
2374 PROTOTYPE: ;$
2375 PREINIT:
2376  I32 cxix, level;
2377 PPCODE:
2378  SU_GET_LEVEL(0, 0);
2379  cxix = su_context_here();
2380  while (--level >= 0) {
2381   if (cxix <= 0)
2382    break;
2383   --cxix;
2384   cxix = su_context_skip_db(cxix);
2385   cxix = su_context_normalize_up(cxix);
2386  }
2387  EXTEND(SP, 1);
2388  mPUSHi(cxix);
2389  XSRETURN(1);
2390
2391 void
2392 CALLER(...)
2393 PROTOTYPE: ;$
2394 PREINIT:
2395  I32 cxix, level;
2396 PPCODE:
2397  SU_GET_LEVEL(0, 0);
2398  for (cxix = cxstack_ix; cxix > 0; --cxix) {
2399   PERL_CONTEXT *cx = cxstack + cxix;
2400   switch (CxTYPE(cx)) {
2401    case CXt_SUB:
2402     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2403      continue;
2404    case CXt_EVAL:
2405    case CXt_FORMAT:
2406     if (--level < 0)
2407      goto done;
2408     break;
2409   }
2410  }
2411 done:
2412  EXTEND(SP, 1);
2413  mPUSHi(cxix);
2414  XSRETURN(1);
2415
2416 void
2417 want_at(...)
2418 PROTOTYPE: ;$
2419 PREINIT:
2420  I32 cxix;
2421 PPCODE:
2422  SU_GET_CONTEXT(0, 0, cxstack_ix);
2423  EXTEND(SP, 1);
2424  while (cxix > 0) {
2425   PERL_CONTEXT *cx = cxstack + cxix--;
2426   switch (CxTYPE(cx)) {
2427    case CXt_SUB:
2428     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2429      continue;
2430    case CXt_EVAL:
2431    case CXt_FORMAT: {
2432     I32 gimme = cx->blk_gimme;
2433     switch (gimme) {
2434      case G_VOID:   XSRETURN_UNDEF; break;
2435      case G_SCALAR: XSRETURN_NO;    break;
2436      case G_ARRAY:  XSRETURN_YES;   break;
2437     }
2438     break;
2439    }
2440   }
2441  }
2442  XSRETURN_UNDEF;
2443
2444 void
2445 reap(SV *hook, ...)
2446 PROTOTYPE: &;$
2447 PREINIT:
2448  I32 cxix;
2449  su_ud_reap *ud;
2450 CODE:
2451  SU_GET_CONTEXT(1, 1, su_context_skip_db(cxstack_ix));
2452  cxix = su_context_normalize_down(cxix);
2453  Newx(ud, 1, su_ud_reap);
2454  SU_UD_ORIGIN(ud)  = NULL;
2455  SU_UD_HANDLER(ud) = su_reap;
2456  ud->cb = newSVsv(hook);
2457  su_init(ud, cxix, SU_SAVE_DESTRUCTOR_SIZE);
2458
2459 void
2460 localize(SV *sv, SV *val, ...)
2461 PROTOTYPE: $$;$
2462 PREINIT:
2463  I32 cxix;
2464  I32 size;
2465  su_ud_localize *ud;
2466 CODE:
2467  SU_GET_CONTEXT(2, 2, su_context_skip_db(cxstack_ix));
2468  cxix = su_context_normalize_down(cxix);
2469  Newx(ud, 1, su_ud_localize);
2470  SU_UD_ORIGIN(ud)  = NULL;
2471  SU_UD_HANDLER(ud) = su_localize;
2472  size = su_ud_localize_init(ud, sv, val, NULL);
2473  su_init(ud, cxix, size);
2474
2475 void
2476 localize_elem(SV *sv, SV *elem, SV *val, ...)
2477 PROTOTYPE: $$$;$
2478 PREINIT:
2479  I32 cxix;
2480  I32 size;
2481  su_ud_localize *ud;
2482 CODE:
2483  if (SvTYPE(sv) >= SVt_PVGV)
2484   croak("Can't infer the element localization type from a glob and the value");
2485  SU_GET_CONTEXT(3, 3, su_context_skip_db(cxstack_ix));
2486  cxix = su_context_normalize_down(cxix);
2487  Newx(ud, 1, su_ud_localize);
2488  SU_UD_ORIGIN(ud)  = NULL;
2489  SU_UD_HANDLER(ud) = su_localize;
2490  size = su_ud_localize_init(ud, sv, val, elem);
2491  if (ud->type != SVt_PVAV && ud->type != SVt_PVHV) {
2492   SU_UD_LOCALIZE_FREE(ud);
2493   croak("Can't localize an element of something that isn't an array or a hash");
2494  }
2495  su_init(ud, cxix, size);
2496
2497 void
2498 localize_delete(SV *sv, SV *elem, ...)
2499 PROTOTYPE: $$;$
2500 PREINIT:
2501  I32 cxix;
2502  I32 size;
2503  su_ud_localize *ud;
2504 CODE:
2505  SU_GET_CONTEXT(2, 2, su_context_skip_db(cxstack_ix));
2506  cxix = su_context_normalize_down(cxix);
2507  Newx(ud, 1, su_ud_localize);
2508  SU_UD_ORIGIN(ud)  = NULL;
2509  SU_UD_HANDLER(ud) = su_localize;
2510  size = su_ud_localize_init(ud, sv, NULL, elem);
2511  su_init(ud, cxix, size);
2512
2513 void
2514 uplevel(SV *code, ...)
2515 PROTOTYPE: &@
2516 PREINIT:
2517  I32 cxix, ret, args = 0;
2518 PPCODE:
2519  if (SvROK(code))
2520   code = SvRV(code);
2521  if (SvTYPE(code) < SVt_PVCV)
2522   croak("First argument to uplevel must be a code reference");
2523  SU_GET_CONTEXT(1, items - 1, cxstack_ix);
2524  do {
2525   PERL_CONTEXT *cx = cxstack + cxix;
2526   switch (CxTYPE(cx)) {
2527    case CXt_EVAL:
2528     croak("Can't uplevel to an eval frame");
2529    case CXt_FORMAT:
2530     croak("Can't uplevel to a format frame");
2531    case CXt_SUB:
2532     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2533      continue;
2534     if (items > 1) {
2535      PL_stack_sp--;
2536      args = items - 2;
2537     }
2538     /* su_uplevel() takes care of extending the stack if needed. */
2539     ret = su_uplevel((CV *) code, cxix, args);
2540     XSRETURN(ret);
2541    default:
2542     break;
2543   }
2544  } while (--cxix >= 0);
2545  croak("Can't uplevel outside a subroutine");
2546
2547 void
2548 uid(...)
2549 PROTOTYPE: ;$
2550 PREINIT:
2551  I32 cxix;
2552  SV *uid;
2553 PPCODE:
2554  SU_GET_CONTEXT(0, 0, su_context_here());
2555  uid = su_uid_get(cxix);
2556  EXTEND(SP, 1);
2557  PUSHs(uid);
2558  XSRETURN(1);
2559
2560 void
2561 validate_uid(SV *uid)
2562 PROTOTYPE: $
2563 PREINIT:
2564  SV *ret;
2565 PPCODE:
2566  ret = su_uid_validate(uid) ? &PL_sv_yes : &PL_sv_no;
2567  EXTEND(SP, 1);
2568  PUSHs(ret);
2569  XSRETURN(1);