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