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