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 STATIC I32 su_ud_localize_init(pTHX_ su_ud_localize *ud, SV *sv, SV *val, SV *elem) {
 406 #define su_ud_localize_init(UD, S, V, E) su_ud_localize_init(aTHX_ (UD), (S), (V), (E))
 407  UV deref = 0;
 408  svtype t = SVt_NULL;
 409  I32 size;
 410
 411  SvREFCNT_inc_simple_void(sv);
 412
 413  if (SvTYPE(sv) >= SVt_PVGV) {
 414   if (!val || !SvROK(val)) { /* local *x; or local *x = $val; */
 415    t = SVt_PVGV;
 416   } else {                   /* local *x = \$val; */
 417    t = SvTYPE(SvRV(val));
 418    deref = 1;
 419   }
 420  } else if (SvROK(sv)) {
 421   croak("Invalid %s reference as the localization target",
 422                  sv_reftype(SvRV(sv), 0));
 423  } else {
 424   STRLEN len, l;
 425   const char *p = SvPV_const(sv, len), *s;
 426   for (s = p, l = len; l > 0 && isSPACE(*s); ++s, --l) { }
 427   if (!l) {
 428    l = len;
 429    s = p;
 430   }
 431   switch (*s) {
 432    case '$': t = SVt_PV;   break;
 433    case '@': t = SVt_PVAV; break;
 434    case '%': t = SVt_PVHV; break;
 435    case '&': t = SVt_PVCV; break;
 436    case '*': t = SVt_PVGV; break;
 437   }
 438   if (t != SVt_NULL) {
 439    ++s;
 440    --l;
 441   } else if (val) { /* t == SVt_NULL, type can't be inferred from the sigil */
 442    if (SvROK(val) && !sv_isobject(val)) {
 443     t = SvTYPE(SvRV(val));
 444     deref = 1;
 445    } else {
 446     t = SvTYPE(val);
 447    }
 448   }
 449   SvREFCNT_dec(sv);
 450   sv = newSVpvn(s, l);
 451  }
 452
 453  switch (t) {
 454   case SVt_PVAV:
 455    size  = elem ? SU_SAVE_AELEM_OR_ADELETE_SIZE
 456                 : SU_SAVE_ARY_SIZE;
 457    deref = 0;
 458    break;
 459   case SVt_PVHV:
 460    size  = elem ? SU_SAVE_HELEM_OR_HDELETE_SIZE
 461                 : SU_SAVE_HASH_SIZE;
 462    deref = 0;
 463    break;
 464   case SVt_PVGV:
 465    size  = SU_SAVE_GP_SIZE;
 466    deref = 0;
 467    break;
 468   case SVt_PVCV:
 469    size  = SU_SAVE_SPTR_SIZE;
 470    deref = 0;
 471    break;
 472   default:
 473    size = SU_SAVE_SCALAR_SIZE;
 474    break;
 475  }
 476  /* When deref is set, val isn't NULL */
 477
 478  ud->sv   = sv;
 479  ud->val  = val ? newSVsv(deref ? SvRV(val) : val) : NULL;
 480  ud->elem = SvREFCNT_inc(elem);
 481  ud->type = t;
 482
 483  return size;
 484 }
 485
 486 STATIC void su_localize(pTHX_ void *ud_) {
 487 #define su_localize(U) su_localize(aTHX_ (U))
 488  su_ud_localize *ud = (su_ud_localize *) ud_;
 489  SV *sv   = ud->sv;
 490  SV *val  = ud->val;
 491  SV *elem = ud->elem;
 492  svtype t = ud->type;
 493  GV *gv;
 494
 495  if (SvTYPE(sv) >= SVt_PVGV) {
 496   gv = (GV *) sv;
 497  } else {
 498 #ifdef gv_fetchsv
 499   gv = gv_fetchsv(sv, GV_ADDMULTI, t);
 500 #else
 501   STRLEN len;
 502   const char *name = SvPV_const(sv, len);
 503   gv = gv_fetchpvn_flags(name, len, GV_ADDMULTI, t);
 504 #endif
 505  }
 506
 507  SU_D({
 508   SV *z = newSV(0);
 509   SvUPGRADE(z, t);
 510   PerlIO_printf(Perl_debug_log, "%p: === localize a %s\n",ud, sv_reftype(z, 0));
 511   PerlIO_printf(Perl_debug_log,
 512                 "%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
 513                  ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
 514   SvREFCNT_dec(z);
 515  });
 516
 517  /* Inspired from Alias.pm */
 518  switch (t) {
 519   case SVt_PVAV:
 520    if (elem) {
 521     su_save_aelem(GvAV(gv), elem, val);
 522     goto done;
 523    } else
 524     save_ary(gv);
 525    break;
 526   case SVt_PVHV:
 527    if (elem) {
 528     su_save_helem(GvHV(gv), elem, val);
 529     goto done;
 530    } else
 531     save_hash(gv);
 532    break;
 533   case SVt_PVGV:
 534    save_gp(gv, 1); /* hide previous entry in symtab */
 535    break;
 536   case SVt_PVCV:
 537    SAVESPTR(GvCV(gv));
 538    GvCV(gv) = NULL;
 539    break;
 540   default:
 541    gv = (GV *) save_scalar(gv);
 542    break;
 543  }
 544
 545  if (val)
 546   SvSetMagicSV((SV *) gv, val);
 547
 548 done:
 549  SvREFCNT_dec(ud->elem);
 550  SvREFCNT_dec(ud->val);
 551  SvREFCNT_dec(ud->sv);
 552  SU_UD_FREE(ud);
 553 }
 554
 555 /* --- Pop a context back -------------------------------------------------- */
 556
 557 #if SU_DEBUG
 558 # ifdef DEBUGGING
 559 #  define SU_CXNAME PL_block_type[CxTYPE(&cxstack[cxstack_ix])]
 560 # else
 561 #  define SU_CXNAME "XXX"
 562 # endif
 563 #endif
 564
 565 STATIC void su_pop(pTHX_ void *ud) {
 566 #define su_pop(U) su_pop(aTHX_ (U))
 567  I32 depth, base, mark, *origin;
 568  depth = SU_UD_DEPTH(ud);
 569
 570  SU_D(
 571   PerlIO_printf(Perl_debug_log,
 572    "%p: --- pop a %s\n"
 573    "%p: leave scope     at depth=%2d scope_ix=%2d cur_top=%2d cur_base=%2d\n",
 574     ud, SU_CXNAME,
 575     ud, depth, PL_scopestack_ix,PL_savestack_ix,PL_scopestack[PL_scopestack_ix])
 576  );
 577
 578  origin = SU_UD_ORIGIN(ud);
 579  mark   = origin[depth];
 580  base   = origin[depth - 1];
 581
 582  SU_D(PerlIO_printf(Perl_debug_log,
 583                     "%p: original scope was %*c top=%2d     base=%2d\n",
 584                      ud,                24, ' ',    mark,        base));
 585
 586  if (base < mark) {
 587   SU_D(PerlIO_printf(Perl_debug_log, "%p: clear leftovers\n", ud));
 588   PL_savestack_ix = mark;
 589   leave_scope(base);
 590  }
 591  PL_savestack_ix = base;
 592
 593  SU_UD_DEPTH(ud) = --depth;
 594
 595  if (depth > 0) {
 596   I32 pad;
 597
 598   if ((pad = SU_UD_PAD(ud))) {
 599    dMY_CXT;
 600    do {
 601     SU_D(PerlIO_printf(Perl_debug_log,
 602           "%p: push a pad slot at depth=%2d scope_ix=%2d save_ix=%2d\n",
 603            ud,                       depth, PL_scopestack_ix, PL_savestack_ix));
 604     SU_SAVE_PLACEHOLDER();
 605    } while (--pad);
 606   }
 607
 608   SU_D(PerlIO_printf(Perl_debug_log,
 609           "%p: push destructor at depth=%2d scope_ix=%2d save_ix=%2d\n",
 610            ud,                       depth, PL_scopestack_ix, PL_savestack_ix));
 611   SAVEDESTRUCTOR_X(su_pop, ud);
 612  } else {
 613   SU_UD_HANDLER(ud)(aTHX_ ud);
 614  }
 615
 616  SU_D(PerlIO_printf(Perl_debug_log,
 617                     "%p: --- end pop: cur_top=%2d == cur_base=%2d\n",
 618                      ud, PL_savestack_ix, PL_scopestack[PL_scopestack_ix]));
 619 }
 620
 621 /* --- Initialize the stack and the action userdata ------------------------ */
 622
 623 STATIC I32 su_init(pTHX_ I32 cxix, void *ud, I32 size) {
 624 #define su_init(L, U, S) su_init(aTHX_ (L), (U), (S))
 625  I32 i, depth = 1, pad, offset, *origin;
 626
 627  SU_D(PerlIO_printf(Perl_debug_log, "%p: ### init for cx %d\n", ud, cxix));
 628
 629  if (size <= SU_SAVE_DESTRUCTOR_SIZE)
 630   pad = 0;
 631  else {
 632   I32 extra = size - SU_SAVE_DESTRUCTOR_SIZE;
 633   pad = extra / SU_SAVE_PLACEHOLDER_SIZE;
 634   if (extra % SU_SAVE_PLACEHOLDER_SIZE)
 635    ++pad;
 636  }
 637  offset = SU_SAVE_DESTRUCTOR_SIZE + SU_SAVE_PLACEHOLDER_SIZE * pad;
 638
 639  SU_D(PerlIO_printf(Perl_debug_log, "%p: size=%d pad=%d offset=%d\n",
 640                                      ud,    size,   pad,   offset));
 641
 642  for (i = cxstack_ix; i > cxix; --i) {
 643   PERL_CONTEXT *cx = cxstack + i;
 644   switch (CxTYPE(cx)) {
 645 #if SU_HAS_PERL(5, 10, 0)
 646    case CXt_BLOCK:
 647     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is block\n", ud, i));
 648     /* Given and when blocks are actually followed by a simple block, so skip
 649      * it if needed. */
 650     if (cxix > 0) { /* Implies i > 0 */
 651      PERL_CONTEXT *next = cx - 1;
 652      if (CxTYPE(next) == CXt_GIVEN || CxTYPE(next) == CXt_WHEN)
 653       --cxix;
 654     }
 655     depth++;
 656     break;
 657 #endif
 658 #if SU_HAS_PERL(5, 11, 0)
 659    case CXt_LOOP_FOR:
 660    case CXt_LOOP_PLAIN:
 661    case CXt_LOOP_LAZYSV:
 662    case CXt_LOOP_LAZYIV:
 663 #else
 664    case CXt_LOOP:
 665 #endif
 666     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is loop\n", ud, i));
 667     depth += 2;
 668     break;
 669    default:
 670     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is other\n", ud, i));
 671     depth++;
 672     break;
 673   }
 674  }
 675  SU_D(PerlIO_printf(Perl_debug_log, "%p: going down to depth %d\n", ud, depth));
 676
 677  Newx(origin, depth + 1, I32);
 678  origin[0] = PL_scopestack[PL_scopestack_ix - depth];
 679  PL_scopestack[PL_scopestack_ix - depth] += size;
 680  for (i = depth - 1; i >= 1; --i) {
 681   I32 j = PL_scopestack_ix - i;
 682   origin[depth - i] = PL_scopestack[j];
 683   PL_scopestack[j] += offset;
 684  }
 685  origin[depth] = PL_savestack_ix;
 686
 687  SU_UD_ORIGIN(ud) = origin;
 688  SU_UD_DEPTH(ud)  = depth;
 689  SU_UD_PAD(ud)    = pad;
 690
 691  /* Make sure the first destructor fires by pushing enough fake slots on the
 692   * stack. */
 693  if (PL_savestack_ix + SU_SAVE_DESTRUCTOR_SIZE
 694                                        <= PL_scopestack[PL_scopestack_ix - 1]) {
 695   dMY_CXT;
 696   do {
 697    SU_D(PerlIO_printf(Perl_debug_log,
 698                   "%p: push a fake slot      at scope_ix=%2d  save_ix=%2d\n",
 699                    ud,                      PL_scopestack_ix, PL_savestack_ix));
 700    SU_SAVE_PLACEHOLDER();
 701   } while (PL_savestack_ix + SU_SAVE_DESTRUCTOR_SIZE
 702                                         <= PL_scopestack[PL_scopestack_ix - 1]);
 703  }
 704  SU_D(PerlIO_printf(Perl_debug_log,
 705                   "%p: push first destructor at scope_ix=%2d  save_ix=%2d\n",
 706                    ud,                      PL_scopestack_ix, PL_savestack_ix));
 707  SAVEDESTRUCTOR_X(su_pop, ud);
 708
 709  SU_D({
 710   for (i = 0; i <= depth; ++i) {
 711    I32 j = PL_scopestack_ix  - i;
 712    PerlIO_printf(Perl_debug_log,
 713                  "%p: depth=%2d scope_ix=%2d saved_floor=%2d new_floor=%2d\n",
 714                   ud,        i, j, origin[depth - i],
 715                                    i == 0 ? PL_savestack_ix : PL_scopestack[j]);
 716   }
 717  });
 718
 719  return depth;
 720 }
 721
 722 /* --- Unwind stack -------------------------------------------------------- */
 723
 724 STATIC void su_unwind(pTHX_ void *ud_) {
 725  dMY_CXT;
 726  I32 cxix    = MY_CXT.cxix;
 727  I32 items   = MY_CXT.items - 1;
 728  SV **savesp = MY_CXT.savesp;
 729  I32 mark;
 730
 731  PERL_UNUSED_VAR(ud_);
 732
 733  if (savesp)
 734   PL_stack_sp = savesp;
 735
 736  if (cxstack_ix > cxix)
 737   dounwind(cxix);
 738
 739  /* Hide the level */
 740  if (items >= 0)
 741   PL_stack_sp--;
 742
 743  mark = PL_markstack[cxstack[cxix].blk_oldmarksp];
 744  *PL_markstack_ptr = PL_stack_sp - PL_stack_base - items;
 745
 746  SU_D({
 747   I32 gimme = GIMME_V;
 748   PerlIO_printf(Perl_debug_log,
 749                 "%p: cx=%d gimme=%s items=%d sp=%d oldmark=%d mark=%d\n",
 750                 &MY_CXT, cxix,
 751                 gimme == G_VOID ? "void" : gimme == G_ARRAY ? "list" : "scalar",
 752                 items, PL_stack_sp - PL_stack_base, *PL_markstack_ptr, mark);
 753  });
 754
 755  PL_op = PL_ppaddr[OP_RETURN](aTHX);
 756  *PL_markstack_ptr = mark;
 757
 758  MY_CXT.fakeop.op_next = PL_op;
 759  PL_op = &(MY_CXT.fakeop);
 760 }
 761
 762 /* --- XS ------------------------------------------------------------------ */
 763
 764 #if SU_HAS_PERL(5, 8, 9)
 765 # define SU_SKIP_DB_MAX 2
 766 #else
 767 # define SU_SKIP_DB_MAX 3
 768 #endif
 769
 770 /* Skip context sequences of 1 to SU_SKIP_DB_MAX (included) block contexts
 771  * followed by a DB sub */
 772
 773 #define SU_SKIP_DB(C) \
 774  STMT_START {         \
 775   I32 skipped = 0;    \
 776   PERL_CONTEXT *base = cxstack;      \
 777   PERL_CONTEXT *cx   = base + (C);   \
 778   while (cx >= base && (C) > skipped && CxTYPE(cx) == CXt_BLOCK) \
 779    --cx, ++skipped;                  \
 780   if (cx >= base && (C) > skipped) { \
 781    switch (CxTYPE(cx)) {  \
 782     case CXt_SUB:         \
 783      if (skipped <= SU_SKIP_DB_MAX && cx->blk_sub.cv == GvCV(PL_DBsub)) \
 784       (C) -= skipped + 1; \
 785       break;              \
 786     default:              \
 787      break;               \
 788    }                      \
 789   }                       \
 790  } STMT_END
 791
 792 #define SU_GET_CONTEXT(A, B)   \
 793  STMT_START {                  \
 794   if (items > A) {             \
 795    SV *csv = ST(B);            \
 796    if (!SvOK(csv))             \
 797     goto default_cx;           \
 798    cxix = SvIV(csv);           \
 799    if (cxix < 0)               \
 800     cxix = 0;                  \
 801    else if (cxix > cxstack_ix) \
 802     cxix = cxstack_ix;         \
 803   } else {                     \
 804 default_cx:                    \
 805    cxix = cxstack_ix;          \
 806    if (PL_DBsub)               \
 807     SU_SKIP_DB(cxix);          \
 808   }                            \
 809  } STMT_END
 810
 811 #define SU_GET_LEVEL(A, B) \
 812  STMT_START {              \
 813   level = 0;               \
 814   if (items > 0) {         \
 815    SV *lsv = ST(B);        \
 816    if (SvOK(lsv)) {        \
 817     level = SvIV(lsv);     \
 818     if (level < 0)         \
 819      level = 0;            \
 820    }                       \
 821   }                        \
 822  } STMT_END
 823
 824 XS(XS_Scope__Upper_unwind); /* prototype to pass -Wmissing-prototypes */
 825
 826 XS(XS_Scope__Upper_unwind) {
 827 #ifdef dVAR
 828  dVAR; dXSARGS;
 829 #else
 830  dXSARGS;
 831 #endif
 832  dMY_CXT;
 833  I32 cxix;
 834
 835  PERL_UNUSED_VAR(cv); /* -W */
 836  PERL_UNUSED_VAR(ax); /* -Wall */
 837
 838  SU_GET_CONTEXT(0, items - 1);
 839  do {
 840   PERL_CONTEXT *cx = cxstack + cxix;
 841   switch (CxTYPE(cx)) {
 842    case CXt_SUB:
 843     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
 844      continue;
 845    case CXt_EVAL:
 846    case CXt_FORMAT:
 847     MY_CXT.cxix  = cxix;
 848     MY_CXT.items = items;
 849     /* pp_entersub will want to sanitize the stack after returning from there
 850      * Screw that, we're insane */
 851     if (GIMME_V == G_SCALAR) {
 852      MY_CXT.savesp = PL_stack_sp;
 853      /* dXSARGS calls POPMARK, so we need to match PL_markstack_ptr[1] */
 854      PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
 855     } else {
 856      MY_CXT.savesp = NULL;
 857     }
 858     SAVEDESTRUCTOR_X(su_unwind, NULL);
 859     return;
 860    default:
 861     break;
 862   }
 863  } while (--cxix >= 0);
 864  croak("Can't return outside a subroutine");
 865 }
 866
 867 MODULE = Scope::Upper            PACKAGE = Scope::Upper
 868
 869 PROTOTYPES: ENABLE
 870
 871 BOOT:
 872 {
 873  HV *stash;
 874
 875  MY_CXT_INIT;
 876  MY_CXT.stack_placeholder = NULL;
 877
 878  stash = gv_stashpv(__PACKAGE__, 1);
 879  newCONSTSUB(stash, "TOP",           newSViv(0));
 880  newCONSTSUB(stash, "SU_THREADSAFE", newSVuv(SU_THREADSAFE));
 881
 882  newXSproto("Scope::Upper::unwind", XS_Scope__Upper_unwind, file, NULL);
 883 }
 884
 885 #if SU_THREADSAFE
 886
 887 void
 888 CLONE(...)
 889 PROTOTYPE: DISABLE
 890 CODE:
 891  PERL_UNUSED_VAR(items);
 892  {
 893   MY_CXT_CLONE;
 894  }
 895
 896 #endif /* SU_THREADSAFE */
 897
 898 SV *
 899 HERE()
 900 PROTOTYPE:
 901 PREINIT:
 902  I32 cxix = cxstack_ix;
 903 CODE:
 904  if (PL_DBsub)
 905   SU_SKIP_DB(cxix);
 906  RETVAL = newSViv(cxix);
 907 OUTPUT:
 908  RETVAL
 909
 910 SV *
 911 UP(...)
 912 PROTOTYPE: ;$
 913 PREINIT:
 914  I32 cxix;
 915 CODE:
 916  SU_GET_CONTEXT(0, 0);
 917  if (--cxix < 0)
 918   cxix = 0;
 919  if (PL_DBsub)
 920   SU_SKIP_DB(cxix);
 921  RETVAL = newSViv(cxix);
 922 OUTPUT:
 923  RETVAL
 924
 925 void
 926 SUB(...)
 927 PROTOTYPE: ;$
 928 PREINIT:
 929  I32 cxix;
 930 PPCODE:
 931  SU_GET_CONTEXT(0, 0);
 932  for (; cxix >= 0; --cxix) {
 933   PERL_CONTEXT *cx = cxstack + cxix;
 934   switch (CxTYPE(cx)) {
 935    default:
 936     continue;
 937    case CXt_SUB:
 938     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
 939      continue;
 940     ST(0) = sv_2mortal(newSViv(cxix));
 941     XSRETURN(1);
 942   }
 943  }
 944  XSRETURN_UNDEF;
 945
 946 void
 947 EVAL(...)
 948 PROTOTYPE: ;$
 949 PREINIT:
 950  I32 cxix;
 951 PPCODE:
 952  SU_GET_CONTEXT(0, 0);
 953  for (; cxix >= 0; --cxix) {
 954   PERL_CONTEXT *cx = cxstack + cxix;
 955   switch (CxTYPE(cx)) {
 956    default:
 957     continue;
 958    case CXt_EVAL:
 959     ST(0) = sv_2mortal(newSViv(cxix));
 960     XSRETURN(1);
 961   }
 962  }
 963  XSRETURN_UNDEF;
 964
 965 void
 966 SCOPE(...)
 967 PROTOTYPE: ;$
 968 PREINIT:
 969  I32 cxix, level;
 970 PPCODE:
 971  SU_GET_LEVEL(0, 0);
 972  cxix = cxstack_ix;
 973  if (PL_DBsub) {
 974   SU_SKIP_DB(cxix);
 975   while (cxix > 0) {
 976    if (--level < 0)
 977     break;
 978    --cxix;
 979    SU_SKIP_DB(cxix);
 980   }
 981  } else {
 982   cxix -= level;
 983   if (cxix < 0)
 984    cxix = 0;
 985  }
 986  ST(0) = sv_2mortal(newSViv(cxix));
 987  XSRETURN(1);
 988
 989 void
 990 CALLER(...)
 991 PROTOTYPE: ;$
 992 PREINIT:
 993  I32 cxix, level;
 994 PPCODE:
 995  SU_GET_LEVEL(0, 0);
 996  for (cxix = cxstack_ix; cxix > 0; --cxix) {
 997   PERL_CONTEXT *cx = cxstack + cxix;
 998   switch (CxTYPE(cx)) {
 999    case CXt_SUB:
1000     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
1001      continue;
1002    case CXt_EVAL:
1003    case CXt_FORMAT:
1004     if (--level < 0)
1005      goto done;
1006     break;
1007   }
1008  }
1009 done:
1010  ST(0) = sv_2mortal(newSViv(cxix));
1011  XSRETURN(1);
1012
1013 void
1014 want_at(...)
1015 PROTOTYPE: ;$
1016 PREINIT:
1017  I32 cxix;
1018 PPCODE:
1019  SU_GET_CONTEXT(0, 0);
1020  while (cxix > 0) {
1021   PERL_CONTEXT *cx = cxstack + cxix--;
1022   switch (CxTYPE(cx)) {
1023    case CXt_SUB:
1024    case CXt_EVAL:
1025    case CXt_FORMAT: {
1026     I32 gimme = cx->blk_gimme;
1027     switch (gimme) {
1028      case G_VOID:   XSRETURN_UNDEF; break;
1029      case G_SCALAR: XSRETURN_NO;    break;
1030      case G_ARRAY:  XSRETURN_YES;   break;
1031     }
1032     break;
1033    }
1034   }
1035  }
1036  XSRETURN_UNDEF;
1037
1038 void
1039 reap(SV *hook, ...)
1040 PROTOTYPE: &;$
1041 PREINIT:
1042  I32 cxix;
1043  su_ud_reap *ud;
1044 CODE:
1045  SU_GET_CONTEXT(1, 1);
1046  Newx(ud, 1, su_ud_reap);
1047  SU_UD_ORIGIN(ud)  = NULL;
1048  SU_UD_HANDLER(ud) = su_reap;
1049  ud->cb = newSVsv(hook);
1050  su_init(cxix, ud, SU_SAVE_DESTRUCTOR_SIZE);
1051
1052 void
1053 localize(SV *sv, SV *val, ...)
1054 PROTOTYPE: $$;$
1055 PREINIT:
1056  I32 cxix;
1057  I32 size;
1058  su_ud_localize *ud;
1059 CODE:
1060  SU_GET_CONTEXT(2, 2);
1061  Newx(ud, 1, su_ud_localize);
1062  SU_UD_ORIGIN(ud)  = NULL;
1063  SU_UD_HANDLER(ud) = su_localize;
1064  size = su_ud_localize_init(ud, sv, val, NULL);
1065  su_init(cxix, ud, size);
1066
1067 void
1068 localize_elem(SV *sv, SV *elem, SV *val, ...)
1069 PROTOTYPE: $$$;$
1070 PREINIT:
1071  I32 cxix;
1072  I32 size;
1073  su_ud_localize *ud;
1074 CODE:
1075  if (SvTYPE(sv) >= SVt_PVGV)
1076   croak("Can't infer the element localization type from a glob and the value");
1077  SU_GET_CONTEXT(3, 3);
1078  Newx(ud, 1, su_ud_localize);
1079  SU_UD_ORIGIN(ud)  = NULL;
1080  SU_UD_HANDLER(ud) = su_localize;
1081  size = su_ud_localize_init(ud, sv, val, elem);
1082  if (ud->type != SVt_PVAV && ud->type != SVt_PVHV) {
1083   Safefree(ud);
1084   croak("Can't localize an element of something that isn't an array or a hash");
1085  }
1086  su_init(cxix, ud, size);
1087
1088 void
1089 localize_delete(SV *sv, SV *elem, ...)
1090 PROTOTYPE: $$;$
1091 PREINIT:
1092  I32 cxix;
1093  I32 size;
1094  su_ud_localize *ud;
1095 CODE:
1096  SU_GET_CONTEXT(2, 2);
1097  Newx(ud, 1, su_ud_localize);
1098  SU_UD_ORIGIN(ud)  = NULL;
1099  SU_UD_HANDLER(ud) = su_localize;
1100  size = su_ud_localize_init(ud, sv, NULL, elem);
1101  su_init(cxix, ud, size);