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