Upper.xs

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