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 PERL_UNUSED_VAR
  18 # define PERL_UNUSED_VAR(V)
  19 #endif
  20
  21 #ifndef STMT_START
  22 # define STMT_START do
  23 #endif
  24
  25 #ifndef STMT_END
  26 # define STMT_END while (0)
  27 #endif
  28
  29 #if SU_DEBUG
  30 # define SU_D(X) STMT_START X STMT_END
  31 #else
  32 # define SU_D(X)
  33 #endif
  34
  35 #ifndef Newx
  36 # define Newx(v, n, c) New(0, v, n, c)
  37 #endif
  38
  39 #ifndef SvPV_const
  40 # define SvPV_const(S, L) SvPV(S, L)
  41 #endif
  42
  43 #ifndef SvPV_nolen_const
  44 # define SvPV_nolen_const(S) SvPV_nolen(S)
  45 #endif
  46
  47 #ifndef SvREFCNT_inc_simple_void
  48 # define SvREFCNT_inc_simple_void(sv) SvREFCNT_inc(sv)
  49 #endif
  50
  51 #ifndef HvNAME_get
  52 # define HvNAME_get(H) HvNAME(H)
  53 #endif
  54
  55 #ifndef gv_fetchpvn_flags
  56 # define gv_fetchpvn_flags(A, B, C, D) gv_fetchpv((A), (C), (D))
  57 #endif
  58
  59 #ifndef PERL_MAGIC_tied
  60 # define PERL_MAGIC_tied 'P'
  61 #endif
  62
  63 #ifndef PERL_MAGIC_env
  64 # define PERL_MAGIC_env 'E'
  65 #endif
  66
  67 #ifndef NEGATIVE_INDICES_VAR
  68 # define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"
  69 #endif
  70
  71 #define SU_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
  72
  73 /* --- Threads and multiplicity -------------------------------------------- */
  74
  75 #ifndef NOOP
  76 # define NOOP
  77 #endif
  78
  79 #ifndef dNOOP
  80 # define dNOOP
  81 #endif
  82
  83 #ifndef SU_MULTIPLICITY
  84 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
  85 #  define SU_MULTIPLICITY 1
  86 # else
  87 #  define SU_MULTIPLICITY 0
  88 # endif
  89 #endif
  90 #if SU_MULTIPLICITY && !defined(tTHX)
  91 # define tTHX PerlInterpreter*
  92 #endif
  93
  94 #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))
  95 # define SU_THREADSAFE 1
  96 # ifndef MY_CXT_CLONE
  97 #  define MY_CXT_CLONE \
  98     dMY_CXT_SV;                                                      \
  99     my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
 100     Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
 101     sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
 102 # endif
 103 #else
 104 # define SU_THREADSAFE 0
 105 # undef  dMY_CXT
 106 # define dMY_CXT      dNOOP
 107 # undef  MY_CXT
 108 # define MY_CXT       su_globaldata
 109 # undef  START_MY_CXT
 110 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
 111 # undef  MY_CXT_INIT
 112 # define MY_CXT_INIT  NOOP
 113 # undef  MY_CXT_CLONE
 114 # define MY_CXT_CLONE NOOP
 115 #endif
 116
 117 /* --- Global data --------------------------------------------------------- */
 118
 119 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
 120
 121 typedef struct {
 122  char *stack_placeholder;
 123  I32   cxix;
 124  I32   items;
 125  SV  **savesp;
 126  OP    fakeop;
 127 } my_cxt_t;
 128
 129 START_MY_CXT
 130
 131 /* --- Stack manipulations ------------------------------------------------- */
 132
 133 #define SU_SAVE_PLACEHOLDER() save_pptr(&MY_CXT.stack_placeholder)
 134
 135 #define SU_SAVE_DESTRUCTOR_SIZE  3
 136 #define SU_SAVE_PLACEHOLDER_SIZE 3
 137
 138 #ifndef SvCANEXISTDELETE
 139 # define SvCANEXISTDELETE(sv) \
 140   (!SvRMAGICAL(sv)            \
 141    || ((mg = mg_find((SV *) sv, PERL_MAGIC_tied))            \
 142        && (stash = SvSTASH(SvRV(SvTIED_obj((SV *) sv, mg)))) \
 143        && gv_fetchmethod_autoload(stash, "EXISTS", TRUE)     \
 144        && gv_fetchmethod_autoload(stash, "DELETE", TRUE)     \
 145       )                       \
 146    )
 147 #endif
 148
 149 /* ... Saving array elements ............................................... */
 150
 151 STATIC I32 su_av_key2idx(pTHX_ AV *av, I32 key) {
 152 #define su_av_key2idx(A, K) su_av_key2idx(aTHX_ (A), (K))
 153  I32 idx;
 154
 155  if (key >= 0)
 156   return key;
 157
 158 /* Added by MJD in perl-5.8.1 with 6f12eb6d2a1dfaf441504d869b27d2e40ef4966a */
 159 #if SU_HAS_PERL(5, 8, 1)
 160  if (SvRMAGICAL(av)) {
 161   const MAGIC * const tied_magic = mg_find((SV *) av, PERL_MAGIC_tied);
 162   if (tied_magic) {
 163    SV * const * const negative_indices_glob =
 164                     hv_fetch(SvSTASH(SvRV(SvTIED_obj((SV *) (av), tied_magic))),
 165                              NEGATIVE_INDICES_VAR, 16, 0);
 166    if (negative_indices_glob && SvTRUE(GvSV(*negative_indices_glob)))
 167     return key;
 168   }
 169  }
 170 #endif
 171
 172  idx = key + av_len(av) + 1;
 173  if (idx < 0)
 174   return key;
 175
 176  return idx;
 177 }
 178
 179 #ifndef SAVEADELETE
 180
 181 typedef struct {
 182  AV *av;
 183  I32 idx;
 184 } su_ud_adelete;
 185
 186 STATIC void su_adelete(pTHX_ void *ud_) {
 187  su_ud_adelete *ud = (su_ud_adelete *) ud_;
 188
 189  av_delete(ud->av, ud->idx, G_DISCARD);
 190  SvREFCNT_dec(ud->av);
 191
 192  Safefree(ud);
 193 }
 194
 195 STATIC void su_save_adelete(pTHX_ AV *av, I32 idx) {
 196 #define su_save_adelete(A, K) su_save_adelete(aTHX_ (A), (K))
 197  su_ud_adelete *ud;
 198
 199  Newx(ud, 1, su_ud_adelete);
 200  ud->av  = av;
 201  ud->idx = idx;
 202  SvREFCNT_inc_simple_void(av);
 203
 204  SAVEDESTRUCTOR_X(su_adelete, ud);
 205 }
 206
 207 #define SAVEADELETE(A, K) su_save_adelete((A), (K))
 208
 209 #endif /* SAVEADELETE */
 210
 211 STATIC void su_save_aelem(pTHX_ AV *av, SV *key, SV *val) {
 212 #define su_save_aelem(A, K, V) su_save_aelem(aTHX_ (A), (K), (V))
 213  I32 idx;
 214  I32 preeminent = 1;
 215  SV **svp;
 216  HV *stash;
 217  MAGIC *mg;
 218
 219  idx = su_av_key2idx(av, SvIV(key));
 220
 221  if (SvCANEXISTDELETE(av))
 222   preeminent = av_exists(av, idx);
 223
 224  svp = av_fetch(av, idx, 1);
 225  if (!svp || *svp == &PL_sv_undef) croak(PL_no_aelem, idx);
 226
 227  if (preeminent)
 228   save_aelem(av, idx, svp);
 229  else
 230   SAVEADELETE(av, idx);
 231
 232  if (val) { /* local $x[$idx] = $val; */
 233   SvSetMagicSV(*svp, val);
 234  } else {   /* local $x[$idx]; delete $x[$idx]; */
 235   av_delete(av, idx, G_DISCARD);
 236  }
 237 }
 238
 239 /* ... Saving hash elements ................................................ */
 240
 241 STATIC void su_save_helem(pTHX_ HV *hv, SV *keysv, SV *val) {
 242 #define su_save_helem(H, K, V) su_save_helem(aTHX_ (H), (K), (V))
 243  I32 preeminent = 1;
 244  HE *he;
 245  SV **svp;
 246  HV *stash;
 247  MAGIC *mg;
 248
 249  if (SvCANEXISTDELETE(hv) || mg_find((SV *) hv, PERL_MAGIC_env))
 250   preeminent = hv_exists_ent(hv, keysv, 0);
 251
 252  he  = hv_fetch_ent(hv, keysv, 1, 0);
 253  svp = he ? &HeVAL(he) : NULL;
 254  if (!svp || *svp == &PL_sv_undef) croak("Modification of non-creatable hash value attempted, subscript \"%s\"", SvPV_nolen_const(*svp));
 255
 256  if (HvNAME_get(hv) && isGV(*svp)) {
 257   save_gp((GV *) *svp, 0);
 258   return;
 259  }
 260
 261  if (preeminent)
 262   save_helem(hv, keysv, svp);
 263  else {
 264   STRLEN keylen;
 265   const char * const key = SvPV_const(keysv, keylen);
 266   SAVEDELETE(hv, savepvn(key, keylen),
 267                  SvUTF8(keysv) ? -(I32)keylen : (I32)keylen);
 268  }
 269
 270  if (val) { /* local $x{$keysv} = $val; */
 271   SvSetMagicSV(*svp, val);
 272  } else {   /* local $x{$keysv}; delete $x{$keysv}; */
 273   (void)hv_delete_ent(hv, keysv, G_DISCARD, HeHASH(he));
 274  }
 275 }
 276
 277 /* --- Actions ------------------------------------------------------------- */
 278
 279 typedef struct {
 280  I32 depth;
 281  I32 pad;
 282  I32 *origin;
 283  void (*handler)(pTHX_ void *);
 284 } su_ud_common;
 285
 286 #define SU_UD_DEPTH(U)   (((su_ud_common *) (U))->depth)
 287 #define SU_UD_PAD(U)     (((su_ud_common *) (U))->pad)
 288 #define SU_UD_ORIGIN(U)  (((su_ud_common *) (U))->origin)
 289 #define SU_UD_HANDLER(U) (((su_ud_common *) (U))->handler)
 290
 291 #define SU_UD_FREE(U) STMT_START { \
 292  if (SU_UD_ORIGIN(U)) Safefree(SU_UD_ORIGIN(U)); \
 293  Safefree(U); \
 294 } STMT_END
 295
 296 /* ... Reap ................................................................ */
 297
 298 typedef struct {
 299  su_ud_common ci;
 300  SV *cb;
 301 } su_ud_reap;
 302
 303 STATIC void su_call(pTHX_ void *ud_) {
 304  su_ud_reap *ud = (su_ud_reap *) ud_;
 305 #if SU_HAS_PERL(5, 9, 5)
 306  PERL_CONTEXT saved_cx;
 307  I32 cxix;
 308 #endif
 309
 310  dSP;
 311
 312  SU_D({
 313   PerlIO_printf(Perl_debug_log,
 314                 "%p: @@@ call\n%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
 315                  ud, ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
 316  });
 317
 318  ENTER;
 319  SAVETMPS;
 320
 321  PUSHMARK(SP);
 322  PUTBACK;
 323
 324  /* If the recently popped context isn't saved there, it will be overwritten by
 325   * the sub scope from call_sv, although it's still needed in our caller. */
 326
 327 #if SU_HAS_PERL(5, 9, 5)
 328  if (cxstack_ix < cxstack_max)
 329   cxix = cxstack_ix + 1;
 330  else
 331   cxix = Perl_cxinc(aTHX);
 332  saved_cx = cxstack[cxix];
 333 #endif
 334
 335  call_sv(ud->cb, G_VOID);
 336
 337 #if SU_HAS_PERL(5, 9, 5)
 338  cxstack[cxix] = saved_cx;
 339 #endif
 340
 341  PUTBACK;
 342
 343  FREETMPS;
 344  LEAVE;
 345
 346  SvREFCNT_dec(ud->cb);
 347  SU_UD_FREE(ud);
 348 }
 349
 350 STATIC void su_reap(pTHX_ void *ud) {
 351 #define su_reap(U) su_reap(aTHX_ (U))
 352  SU_D({
 353   PerlIO_printf(Perl_debug_log,
 354                 "%p: === reap\n%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
 355                  ud, ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
 356  });
 357
 358  SAVEDESTRUCTOR_X(su_call, ud);
 359 }
 360
 361 /* ... Localize & localize array/hash element .............................. */
 362
 363 typedef struct {
 364  su_ud_common ci;
 365  SV    *sv;
 366  SV    *val;
 367  SV    *elem;
 368  svtype type;
 369 } su_ud_localize;
 370
 371 STATIC void su_ud_localize_init(pTHX_ su_ud_localize *ud, SV *sv, SV *val, SV *elem) {
 372 #define su_ud_localize_init(UD, S, V, E) su_ud_localize_init(aTHX_ (UD), (S), (V), (E))
 373  UV deref = 0;
 374  svtype t = SVt_NULL;
 375
 376  SvREFCNT_inc_simple_void(sv);
 377
 378  if (SvTYPE(sv) >= SVt_PVGV) {
 379   if (!val || !SvROK(val)) { /* local *x; or local *x = $val; */
 380    t = SVt_PVGV;
 381   } else {                   /* local *x = \$val; */
 382    t = SvTYPE(SvRV(val));
 383    deref = 1;
 384   }
 385  } else if (SvROK(sv)) {
 386   croak("Invalid %s reference as the localization target",
 387                  sv_reftype(SvRV(sv), 0));
 388  } else {
 389   STRLEN len, l;
 390   const char *p = SvPV_const(sv, len), *s;
 391   for (s = p, l = len; l > 0 && isSPACE(*s); ++s, --l) { }
 392   if (!l) {
 393    l = len;
 394    s = p;
 395   }
 396   switch (*s) {
 397    case '$': t = SVt_PV;   break;
 398    case '@': t = SVt_PVAV; break;
 399    case '%': t = SVt_PVHV; break;
 400    case '&': t = SVt_PVCV; break;
 401    case '*': t = SVt_PVGV; break;
 402   }
 403   if (t != SVt_NULL) {
 404    ++s;
 405    --l;
 406   } else if (val) { /* t == SVt_NULL, type can't be inferred from the sigil */
 407    if (SvROK(val) && !sv_isobject(val)) {
 408     t = SvTYPE(SvRV(val));
 409     deref = 1;
 410    } else {
 411     t = SvTYPE(val);
 412    }
 413   }
 414   SvREFCNT_dec(sv);
 415   sv = newSVpvn(s, l);
 416  }
 417
 418  switch (t) {
 419   case SVt_PVAV:
 420   case SVt_PVHV:
 421   case SVt_PVCV:
 422   case SVt_PVGV:
 423    deref = 0;
 424   default:
 425    break;
 426  }
 427  /* When deref is set, val isn't NULL */
 428
 429  ud->sv   = sv;
 430  ud->val  = val ? newSVsv(deref ? SvRV(val) : val) : NULL;
 431  ud->elem = SvREFCNT_inc(elem);
 432  ud->type = t;
 433 }
 434
 435 STATIC void su_localize(pTHX_ void *ud_) {
 436 #define su_localize(U) su_localize(aTHX_ (U))
 437  su_ud_localize *ud = (su_ud_localize *) ud_;
 438  SV *sv   = ud->sv;
 439  SV *val  = ud->val;
 440  SV *elem = ud->elem;
 441  svtype t = ud->type;
 442  GV *gv;
 443
 444  if (SvTYPE(sv) >= SVt_PVGV) {
 445   gv = (GV *) sv;
 446  } else {
 447 #ifdef gv_fetchsv
 448   gv = gv_fetchsv(sv, GV_ADDMULTI, t);
 449 #else
 450   STRLEN len;
 451   const char *name = SvPV_const(sv, len);
 452   gv = gv_fetchpvn_flags(name, len, GV_ADDMULTI, t);
 453 #endif
 454  }
 455
 456  SU_D({
 457   SV *z = newSV(0);
 458   SvUPGRADE(z, t);
 459   PerlIO_printf(Perl_debug_log, "%p: === localize a %s\n",ud, sv_reftype(z, 0));
 460   PerlIO_printf(Perl_debug_log,
 461                 "%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
 462                  ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
 463   SvREFCNT_dec(z);
 464  });
 465
 466  /* Inspired from Alias.pm */
 467  switch (t) {
 468   case SVt_PVAV:
 469    if (elem) {
 470     su_save_aelem(GvAV(gv), elem, val);
 471     goto done;
 472    } else
 473     save_ary(gv);
 474    break;
 475   case SVt_PVHV:
 476    if (elem) {
 477     su_save_helem(GvHV(gv), elem, val);
 478     goto done;
 479    } else
 480     save_hash(gv);
 481    break;
 482   case SVt_PVGV:
 483    save_gp(gv, 1); /* hide previous entry in symtab */
 484    break;
 485   case SVt_PVCV:
 486    SAVESPTR(GvCV(gv));
 487    GvCV(gv) = NULL;
 488    break;
 489   default:
 490    gv = (GV *) save_scalar(gv);
 491    break;
 492  }
 493
 494  if (val)
 495   SvSetMagicSV((SV *) gv, val);
 496
 497 done:
 498  SvREFCNT_dec(ud->elem);
 499  SvREFCNT_dec(ud->val);
 500  SvREFCNT_dec(ud->sv);
 501  SU_UD_FREE(ud);
 502 }
 503
 504 /* --- Pop a context back -------------------------------------------------- */
 505
 506 #if SU_DEBUG
 507 # ifdef DEBUGGING
 508 #  define SU_CXNAME PL_block_type[CxTYPE(&cxstack[cxstack_ix])]
 509 # else
 510 #  define SU_CXNAME "XXX"
 511 # endif
 512 #endif
 513
 514 STATIC void su_pop(pTHX_ void *ud) {
 515 #define su_pop(U) su_pop(aTHX_ (U))
 516  I32 depth, base, mark, *origin;
 517  depth = SU_UD_DEPTH(ud);
 518
 519  SU_D(
 520   PerlIO_printf(Perl_debug_log,
 521    "%p: --- pop a %s\n"
 522    "%p: leave scope     at depth=%2d scope_ix=%2d cur_top=%2d cur_base=%2d\n",
 523     ud, SU_CXNAME,
 524     ud, depth, PL_scopestack_ix,PL_savestack_ix,PL_scopestack[PL_scopestack_ix])
 525  );
 526
 527  origin = SU_UD_ORIGIN(ud);
 528  mark   = origin[depth];
 529  base   = origin[depth - 1];
 530
 531  SU_D(PerlIO_printf(Perl_debug_log,
 532                     "%p: original scope was %*c top=%2d     base=%2d\n",
 533                      ud,                24, ' ',    mark,        base));
 534
 535  if (base < mark) {
 536   SU_D(PerlIO_printf(Perl_debug_log, "%p: clear leftovers\n", ud));
 537   PL_savestack_ix = mark;
 538   leave_scope(base);
 539  }
 540  PL_savestack_ix = base;
 541
 542  SU_UD_DEPTH(ud) = --depth;
 543
 544  if (depth > 0) {
 545   I32 pad;
 546
 547   if ((pad = SU_UD_PAD(ud))) {
 548    dMY_CXT;
 549    do {
 550     SU_D(PerlIO_printf(Perl_debug_log,
 551           "%p: push a pad slot at depth=%2d scope_ix=%2d save_ix=%2d\n",
 552            ud,                       depth, PL_scopestack_ix, PL_savestack_ix));
 553     SU_SAVE_PLACEHOLDER();
 554    } while (--pad);
 555   }
 556
 557   SU_D(PerlIO_printf(Perl_debug_log,
 558           "%p: push destructor at depth=%2d scope_ix=%2d save_ix=%2d\n",
 559            ud,                       depth, PL_scopestack_ix, PL_savestack_ix));
 560   SAVEDESTRUCTOR_X(su_pop, ud);
 561  } else {
 562   SU_UD_HANDLER(ud)(aTHX_ ud);
 563  }
 564
 565  SU_D(PerlIO_printf(Perl_debug_log,
 566                     "%p: --- end pop: cur_top=%2d == cur_base=%2d\n",
 567                      ud, PL_savestack_ix, PL_scopestack[PL_scopestack_ix]));
 568 }
 569
 570 /* --- Initialize the stack and the action userdata ------------------------ */
 571
 572 STATIC I32 su_init(pTHX_ I32 cxix, void *ud, I32 size) {
 573 #define su_init(L, U, S) su_init(aTHX_ (L), (U), (S))
 574  I32 i, depth = 1, pad, offset, *origin;
 575
 576  SU_D(PerlIO_printf(Perl_debug_log, "%p: ### init for cx %d\n", ud, cxix));
 577
 578  if (size <= SU_SAVE_DESTRUCTOR_SIZE)
 579   pad = 0;
 580  else {
 581   I32 extra = size - SU_SAVE_DESTRUCTOR_SIZE;
 582   pad = extra / SU_SAVE_PLACEHOLDER_SIZE;
 583   if (extra % SU_SAVE_PLACEHOLDER_SIZE)
 584    ++pad;
 585  }
 586  offset = SU_SAVE_DESTRUCTOR_SIZE + SU_SAVE_PLACEHOLDER_SIZE * pad;
 587
 588  SU_D(PerlIO_printf(Perl_debug_log, "%p: size=%d pad=%d offset=%d\n",
 589                                      ud,    size,   pad,   offset));
 590
 591  for (i = cxstack_ix; i > cxix; --i) {
 592   PERL_CONTEXT *cx = cxstack + i;
 593   switch (CxTYPE(cx)) {
 594 #if SU_HAS_PERL(5, 10, 0)
 595    case CXt_BLOCK:
 596     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is block\n", ud, i));
 597     /* Given and when blocks are actually followed by a simple block, so skip
 598      * it if needed. */
 599     if (cxix > 0) { /* Implies i > 0 */
 600      PERL_CONTEXT *next = cx - 1;
 601      if (CxTYPE(next) == CXt_GIVEN || CxTYPE(next) == CXt_WHEN)
 602       --cxix;
 603     }
 604     depth++;
 605     break;
 606 #endif
 607 #if SU_HAS_PERL(5, 11, 0)
 608    case CXt_LOOP_FOR:
 609    case CXt_LOOP_PLAIN:
 610    case CXt_LOOP_LAZYSV:
 611    case CXt_LOOP_LAZYIV:
 612 #else
 613    case CXt_LOOP:
 614 #endif
 615     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is loop\n", ud, i));
 616     depth += 2;
 617     break;
 618    default:
 619     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is other\n", ud, i));
 620     depth++;
 621     break;
 622   }
 623  }
 624  SU_D(PerlIO_printf(Perl_debug_log, "%p: going down to depth %d\n", ud, depth));
 625
 626  Newx(origin, depth + 1, I32);
 627  origin[0] = PL_scopestack[PL_scopestack_ix - depth];
 628  PL_scopestack[PL_scopestack_ix - depth] += size;
 629  for (i = depth - 1; i >= 1; --i) {
 630   I32 j = PL_scopestack_ix - i;
 631   origin[depth - i] = PL_scopestack[j];
 632   PL_scopestack[j] += offset;
 633  }
 634  origin[depth] = PL_savestack_ix;
 635
 636  SU_UD_ORIGIN(ud) = origin;
 637  SU_UD_DEPTH(ud)  = depth;
 638  SU_UD_PAD(ud)    = pad;
 639
 640  /* Make sure the first destructor fires by pushing enough fake slots on the
 641   * stack. */
 642  if (PL_savestack_ix + SU_SAVE_DESTRUCTOR_SIZE
 643                                        <= PL_scopestack[PL_scopestack_ix - 1]) {
 644   dMY_CXT;
 645   do {
 646    SU_D(PerlIO_printf(Perl_debug_log,
 647                   "%p: push a fake slot      at scope_ix=%2d  save_ix=%2d\n",
 648                    ud,                      PL_scopestack_ix, PL_savestack_ix));
 649    SU_SAVE_PLACEHOLDER();
 650   } while (PL_savestack_ix + SU_SAVE_DESTRUCTOR_SIZE
 651                                         <= PL_scopestack[PL_scopestack_ix - 1]);
 652  }
 653  SU_D(PerlIO_printf(Perl_debug_log,
 654                   "%p: push first destructor at scope_ix=%2d  save_ix=%2d\n",
 655                    ud,                      PL_scopestack_ix, PL_savestack_ix));
 656  SAVEDESTRUCTOR_X(su_pop, ud);
 657
 658  SU_D({
 659   for (i = 0; i <= depth; ++i) {
 660    I32 j = PL_scopestack_ix  - i;
 661    PerlIO_printf(Perl_debug_log,
 662                  "%p: depth=%2d scope_ix=%2d saved_floor=%2d new_floor=%2d\n",
 663                   ud,        i, j, origin[depth - i],
 664                                    i == 0 ? PL_savestack_ix : PL_scopestack[j]);
 665   }
 666  });
 667
 668  return depth;
 669 }
 670
 671 /* --- Unwind stack -------------------------------------------------------- */
 672
 673 STATIC void su_unwind(pTHX_ void *ud_) {
 674  dMY_CXT;
 675  I32 cxix    = MY_CXT.cxix;
 676  I32 items   = MY_CXT.items - 1;
 677  SV **savesp = MY_CXT.savesp;
 678  I32 mark;
 679
 680  PERL_UNUSED_VAR(ud_);
 681
 682  if (savesp)
 683   PL_stack_sp = savesp;
 684
 685  if (cxstack_ix > cxix)
 686   dounwind(cxix);
 687
 688  /* Hide the level */
 689  if (items >= 0)
 690   PL_stack_sp--;
 691
 692  mark = PL_markstack[cxstack[cxix].blk_oldmarksp];
 693  *PL_markstack_ptr = PL_stack_sp - PL_stack_base - items;
 694
 695  SU_D({
 696   I32 gimme = GIMME_V;
 697   PerlIO_printf(Perl_debug_log,
 698                 "%p: cx=%d gimme=%s items=%d sp=%d oldmark=%d mark=%d\n",
 699                 &MY_CXT, cxix,
 700                 gimme == G_VOID ? "void" : gimme == G_ARRAY ? "list" : "scalar",
 701                 items, PL_stack_sp - PL_stack_base, *PL_markstack_ptr, mark);
 702  });
 703
 704  PL_op = PL_ppaddr[OP_RETURN](aTHX);
 705  *PL_markstack_ptr = mark;
 706
 707  MY_CXT.fakeop.op_next = PL_op;
 708  PL_op = &(MY_CXT.fakeop);
 709 }
 710
 711 /* --- XS ------------------------------------------------------------------ */
 712
 713 #if SU_HAS_PERL(5, 8, 9)
 714 # define SU_SKIP_DB_MAX 2
 715 #else
 716 # define SU_SKIP_DB_MAX 3
 717 #endif
 718
 719 /* Skip context sequences of 1 to SU_SKIP_DB_MAX (included) block contexts
 720  * followed by a DB sub */
 721
 722 #define SU_SKIP_DB(C) \
 723  STMT_START {         \
 724   I32 skipped = 0;    \
 725   PERL_CONTEXT *base = cxstack;      \
 726   PERL_CONTEXT *cx   = base + (C);   \
 727   while (cx >= base && (C) > skipped && CxTYPE(cx) == CXt_BLOCK) \
 728    --cx, ++skipped;                  \
 729   if (cx >= base && (C) > skipped) { \
 730    switch (CxTYPE(cx)) {  \
 731     case CXt_SUB:         \
 732      if (skipped <= SU_SKIP_DB_MAX && cx->blk_sub.cv == GvCV(PL_DBsub)) \
 733       (C) -= skipped + 1; \
 734       break;              \
 735     default:              \
 736      break;               \
 737    }                      \
 738   }                       \
 739  } STMT_END
 740
 741 #define SU_GET_CONTEXT(A, B)   \
 742  STMT_START {                  \
 743   if (items > A) {             \
 744    SV *csv = ST(B);            \
 745    if (!SvOK(csv))             \
 746     goto default_cx;           \
 747    cxix = SvIV(csv);           \
 748    if (cxix < 0)               \
 749     cxix = 0;                  \
 750    else if (cxix > cxstack_ix) \
 751     cxix = cxstack_ix;         \
 752   } else {                     \
 753 default_cx:                    \
 754    cxix = cxstack_ix;          \
 755    if (PL_DBsub)               \
 756     SU_SKIP_DB(cxix);          \
 757   }                            \
 758  } STMT_END
 759
 760 #define SU_GET_LEVEL(A, B) \
 761  STMT_START {              \
 762   level = 0;               \
 763   if (items > 0) {         \
 764    SV *lsv = ST(B);        \
 765    if (SvOK(lsv)) {        \
 766     level = SvIV(lsv);     \
 767     if (level < 0)         \
 768      level = 0;            \
 769    }                       \
 770   }                        \
 771  } STMT_END
 772
 773 XS(XS_Scope__Upper_unwind); /* prototype to pass -Wmissing-prototypes */
 774
 775 XS(XS_Scope__Upper_unwind) {
 776 #ifdef dVAR
 777  dVAR; dXSARGS;
 778 #else
 779  dXSARGS;
 780 #endif
 781  dMY_CXT;
 782  I32 cxix;
 783
 784  PERL_UNUSED_VAR(cv); /* -W */
 785  PERL_UNUSED_VAR(ax); /* -Wall */
 786
 787  SU_GET_CONTEXT(0, items - 1);
 788  do {
 789   PERL_CONTEXT *cx = cxstack + cxix;
 790   switch (CxTYPE(cx)) {
 791    case CXt_SUB:
 792     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
 793      continue;
 794    case CXt_EVAL:
 795    case CXt_FORMAT:
 796     MY_CXT.cxix  = cxix;
 797     MY_CXT.items = items;
 798     /* pp_entersub will want to sanitize the stack after returning from there
 799      * Screw that, we're insane */
 800     if (GIMME_V == G_SCALAR) {
 801      MY_CXT.savesp = PL_stack_sp;
 802      /* dXSARGS calls POPMARK, so we need to match PL_markstack_ptr[1] */
 803      PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
 804     } else {
 805      MY_CXT.savesp = NULL;
 806     }
 807     SAVEDESTRUCTOR_X(su_unwind, NULL);
 808     return;
 809    default:
 810     break;
 811   }
 812  } while (--cxix >= 0);
 813  croak("Can't return outside a subroutine");
 814 }
 815
 816 MODULE = Scope::Upper            PACKAGE = Scope::Upper
 817
 818 PROTOTYPES: ENABLE
 819
 820 BOOT:
 821 {
 822  HV *stash;
 823
 824  MY_CXT_INIT;
 825  MY_CXT.stack_placeholder = NULL;
 826
 827  stash = gv_stashpv(__PACKAGE__, 1);
 828  newCONSTSUB(stash, "TOP",           newSViv(0));
 829  newCONSTSUB(stash, "SU_THREADSAFE", newSVuv(SU_THREADSAFE));
 830
 831  newXSproto("Scope::Upper::unwind", XS_Scope__Upper_unwind, file, NULL);
 832 }
 833
 834 #if SU_THREADSAFE
 835
 836 void
 837 CLONE(...)
 838 PROTOTYPE: DISABLE
 839 CODE:
 840  PERL_UNUSED_VAR(items);
 841  {
 842   MY_CXT_CLONE;
 843  }
 844
 845 #endif /* SU_THREADSAFE */
 846
 847 SV *
 848 HERE()
 849 PROTOTYPE:
 850 PREINIT:
 851  I32 cxix = cxstack_ix;
 852 CODE:
 853  if (PL_DBsub)
 854   SU_SKIP_DB(cxix);
 855  RETVAL = newSViv(cxix);
 856 OUTPUT:
 857  RETVAL
 858
 859 SV *
 860 UP(...)
 861 PROTOTYPE: ;$
 862 PREINIT:
 863  I32 cxix;
 864 CODE:
 865  SU_GET_CONTEXT(0, 0);
 866  if (--cxix < 0)
 867   cxix = 0;
 868  if (PL_DBsub)
 869   SU_SKIP_DB(cxix);
 870  RETVAL = newSViv(cxix);
 871 OUTPUT:
 872  RETVAL
 873
 874 void
 875 SUB(...)
 876 PROTOTYPE: ;$
 877 PREINIT:
 878  I32 cxix;
 879 PPCODE:
 880  SU_GET_CONTEXT(0, 0);
 881  for (; cxix >= 0; --cxix) {
 882   PERL_CONTEXT *cx = cxstack + cxix;
 883   switch (CxTYPE(cx)) {
 884    default:
 885     continue;
 886    case CXt_SUB:
 887     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
 888      continue;
 889     ST(0) = sv_2mortal(newSViv(cxix));
 890     XSRETURN(1);
 891   }
 892  }
 893  XSRETURN_UNDEF;
 894
 895 void
 896 EVAL(...)
 897 PROTOTYPE: ;$
 898 PREINIT:
 899  I32 cxix;
 900 PPCODE:
 901  SU_GET_CONTEXT(0, 0);
 902  for (; cxix >= 0; --cxix) {
 903   PERL_CONTEXT *cx = cxstack + cxix;
 904   switch (CxTYPE(cx)) {
 905    default:
 906     continue;
 907    case CXt_EVAL:
 908     ST(0) = sv_2mortal(newSViv(cxix));
 909     XSRETURN(1);
 910   }
 911  }
 912  XSRETURN_UNDEF;
 913
 914 void
 915 SCOPE(...)
 916 PROTOTYPE: ;$
 917 PREINIT:
 918  I32 cxix, level;
 919 PPCODE:
 920  SU_GET_LEVEL(0, 0);
 921  cxix = cxstack_ix;
 922  if (PL_DBsub) {
 923   SU_SKIP_DB(cxix);
 924   while (cxix > 0) {
 925    if (--level < 0)
 926     break;
 927    --cxix;
 928    SU_SKIP_DB(cxix);
 929   }
 930  } else {
 931   cxix -= level;
 932   if (cxix < 0)
 933    cxix = 0;
 934  }
 935  ST(0) = sv_2mortal(newSViv(cxix));
 936  XSRETURN(1);
 937
 938 void
 939 CALLER(...)
 940 PROTOTYPE: ;$
 941 PREINIT:
 942  I32 cxix, level;
 943 PPCODE:
 944  SU_GET_LEVEL(0, 0);
 945  for (cxix = cxstack_ix; cxix > 0; --cxix) {
 946   PERL_CONTEXT *cx = cxstack + cxix;
 947   switch (CxTYPE(cx)) {
 948    case CXt_SUB:
 949     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
 950      continue;
 951    case CXt_EVAL:
 952    case CXt_FORMAT:
 953     if (--level < 0)
 954      goto done;
 955     break;
 956   }
 957  }
 958 done:
 959  ST(0) = sv_2mortal(newSViv(cxix));
 960  XSRETURN(1);
 961
 962 void
 963 want_at(...)
 964 PROTOTYPE: ;$
 965 PREINIT:
 966  I32 cxix;
 967 PPCODE:
 968  SU_GET_CONTEXT(0, 0);
 969  while (cxix > 0) {
 970   PERL_CONTEXT *cx = cxstack + cxix--;
 971   switch (CxTYPE(cx)) {
 972    case CXt_SUB:
 973    case CXt_EVAL:
 974    case CXt_FORMAT: {
 975     I32 gimme = cx->blk_gimme;
 976     switch (gimme) {
 977      case G_VOID:   XSRETURN_UNDEF; break;
 978      case G_SCALAR: XSRETURN_NO;    break;
 979      case G_ARRAY:  XSRETURN_YES;   break;
 980     }
 981     break;
 982    }
 983   }
 984  }
 985  XSRETURN_UNDEF;
 986
 987 void
 988 reap(SV *hook, ...)
 989 PROTOTYPE: &;$
 990 PREINIT:
 991  I32 cxix;
 992  su_ud_reap *ud;
 993 CODE:
 994  SU_GET_CONTEXT(1, 1);
 995  Newx(ud, 1, su_ud_reap);
 996  SU_UD_ORIGIN(ud)  = NULL;
 997  SU_UD_HANDLER(ud) = su_reap;
 998  ud->cb = newSVsv(hook);
 999  su_init(cxix, ud, 3);
1000
1001 void
1002 localize(SV *sv, SV *val, ...)
1003 PROTOTYPE: $$;$
1004 PREINIT:
1005  I32 cxix;
1006  I32 size = 3;
1007  su_ud_localize *ud;
1008 CODE:
1009  SU_GET_CONTEXT(2, 2);
1010  Newx(ud, 1, su_ud_localize);
1011  SU_UD_ORIGIN(ud)  = NULL;
1012  SU_UD_HANDLER(ud) = su_localize;
1013  su_ud_localize_init(ud, sv, val, NULL);
1014 #if !SU_HAS_PERL(5, 8, 9)
1015  if (ud->type >= SVt_PVGV)
1016   size = 6;
1017 #endif
1018  su_init(cxix, ud, size);
1019
1020 void
1021 localize_elem(SV *sv, SV *elem, SV *val, ...)
1022 PROTOTYPE: $$$;$
1023 PREINIT:
1024  I32 cxix;
1025  su_ud_localize *ud;
1026 CODE:
1027  if (SvTYPE(sv) >= SVt_PVGV)
1028   croak("Can't infer the element localization type from a glob and the value");
1029  SU_GET_CONTEXT(3, 3);
1030  Newx(ud, 1, su_ud_localize);
1031  SU_UD_ORIGIN(ud)  = NULL;
1032  SU_UD_HANDLER(ud) = su_localize;
1033  su_ud_localize_init(ud, sv, val, elem);
1034  if (ud->type != SVt_PVAV && ud->type != SVt_PVHV) {
1035   Safefree(ud);
1036   croak("Can't localize an element of something that isn't an array or a hash");
1037  }
1038  su_init(cxix, ud, 4);
1039
1040 void
1041 localize_delete(SV *sv, SV *elem, ...)
1042 PROTOTYPE: $$;$
1043 PREINIT:
1044  I32 cxix;
1045  I32 size = 4;
1046  su_ud_localize *ud;
1047 CODE:
1048  SU_GET_CONTEXT(2, 2);
1049  Newx(ud, 1, su_ud_localize);
1050  SU_UD_ORIGIN(ud)  = NULL;
1051  SU_UD_HANDLER(ud) = su_localize;
1052  su_ud_localize_init(ud, sv, NULL, elem);
1053 #if !SU_HAS_PERL(5, 8, 9)
1054  if (ud->type >= SVt_PVGV)
1055   size = 6;
1056 #endif
1057  su_init(cxix, ud, size);