Magic.xs

   1 /* This file is part of the Variable::Magic Perl module.
   2  * See http://search.cpan.org/dist/Variable-Magic/ */
   3
   4 #include <stdarg.h> /* <va_list>, va_{start,arg,end}, ... */
   5
   6 #include <stdio.h>  /* sprintf() */
   7
   8 #define PERL_NO_GET_CONTEXT
   9 #include "EXTERN.h"
  10 #include "perl.h"
  11 #include "XSUB.h"
  12
  13 #define __PACKAGE__ "Variable::Magic"
  14
  15 #ifndef VMG_PERL_PATCHLEVEL
  16 # ifdef PERL_PATCHNUM
  17 #  define VMG_PERL_PATCHLEVEL PERL_PATCHNUM
  18 # else
  19 #  define VMG_PERL_PATCHLEVEL 0
  20 # endif
  21 #endif
  22
  23 #define VMG_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
  24
  25 #define VMG_HAS_PERL_BRANCH(R, V, S) (PERL_REVISION == (R) && PERL_VERSION == (V) && PERL_SUBVERSION >= (S))
  26
  27 #define VMG_HAS_PERL_MAINT(R, V, S, P) (PERL_REVISION == (R) && PERL_VERSION == (V) && (VMG_PERL_PATCHLEVEL >= (P) || (!VMG_PERL_PATCHLEVEL && PERL_SUBVERSION >= (S))))
  28
  29 /* --- Threads and multiplicity -------------------------------------------- */
  30
  31 #ifndef NOOP
  32 # define NOOP
  33 #endif
  34
  35 #ifndef dNOOP
  36 # define dNOOP
  37 #endif
  38
  39 /* Safe unless stated otherwise in Makefile.PL */
  40 #ifndef VMG_FORKSAFE
  41 # define VMG_FORKSAFE 1
  42 #endif
  43
  44 #ifndef VMG_MULTIPLICITY
  45 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
  46 #  define VMG_MULTIPLICITY 1
  47 # else
  48 #  define VMG_MULTIPLICITY 0
  49 # endif
  50 #endif
  51 #if VMG_MULTIPLICITY && !defined(tTHX)
  52 # define tTHX PerlInterpreter*
  53 #endif
  54
  55 #if VMG_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))
  56 # define VMG_THREADSAFE 1
  57 # ifndef MY_CXT_CLONE
  58 #  define MY_CXT_CLONE \
  59     dMY_CXT_SV;                                                      \
  60     my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
  61     Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
  62     sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
  63 # endif
  64 #else
  65 # define VMG_THREADSAFE 0
  66 # undef  dMY_CXT
  67 # define dMY_CXT      dNOOP
  68 # undef  MY_CXT
  69 # define MY_CXT       vmg_globaldata
  70 # undef  START_MY_CXT
  71 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
  72 # undef  MY_CXT_INIT
  73 # define MY_CXT_INIT  NOOP
  74 # undef  MY_CXT_CLONE
  75 # define MY_CXT_CLONE NOOP
  76 #endif
  77
  78 #if VMG_THREADSAFE
  79
  80 STATIC SV *vmg_clone(pTHX_ SV *sv, tTHX owner) {
  81 #define vmg_clone(P, O) vmg_clone(aTHX_ (P), (O))
  82  SV *dupsv;
  83
  84 #if VMG_HAS_PERL(5, 13, 2)
  85  CLONE_PARAMS *param = Perl_clone_params_new(owner, aTHX);
  86
  87  dupsv = sv_dup(sv, param);
  88
  89  Perl_clone_params_del(param);
  90 #else
  91  CLONE_PARAMS param;
  92
  93  param.stashes    = NULL; /* don't need it unless sv is a PVHV */
  94  param.flags      = 0;
  95  param.proto_perl = owner;
  96
  97  dupsv = sv_dup(sv, &param);
  98 #endif
  99
 100  return SvREFCNT_inc(dupsv);
 101 }
 102
 103 #endif /* VMG_THREADSAFE */
 104
 105 /* --- Compatibility ------------------------------------------------------- */
 106
 107 #ifndef Newx
 108 # define Newx(v, n, c) New(0, v, n, c)
 109 #endif
 110
 111 #ifndef SvMAGIC_set
 112 # define SvMAGIC_set(sv, val) (SvMAGIC(sv) = (val))
 113 #endif
 114
 115 #ifndef SvRV_const
 116 # define SvRV_const(sv) SvRV((SV *) sv)
 117 #endif
 118
 119 #ifndef SvREFCNT_inc_simple_void
 120 # define SvREFCNT_inc_simple_void(sv) SvREFCNT_inc(sv)
 121 #endif
 122
 123 #ifndef mPUSHu
 124 # define mPUSHu(U) PUSHs(sv_2mortal(newSVuv(U)))
 125 #endif
 126
 127 #ifndef PERL_MAGIC_ext
 128 # define PERL_MAGIC_ext '~'
 129 #endif
 130
 131 #ifndef PERL_MAGIC_tied
 132 # define PERL_MAGIC_tied 'P'
 133 #endif
 134
 135 #ifndef MGf_COPY
 136 # define MGf_COPY 0
 137 #endif
 138
 139 #ifndef MGf_DUP
 140 # define MGf_DUP 0
 141 #endif
 142
 143 #ifndef MGf_LOCAL
 144 # define MGf_LOCAL 0
 145 #endif
 146
 147 #ifndef IN_PERL_COMPILETIME
 148 # define IN_PERL_COMPILETIME (PL_curcop == &PL_compiling)
 149 #endif
 150
 151 /* uvar magic and Hash::Util::FieldHash were commited with 28419, but we only
 152  * enable them on 5.10 */
 153 #if VMG_HAS_PERL(5, 10, 0)
 154 # define VMG_UVAR 1
 155 #else
 156 # define VMG_UVAR 0
 157 #endif
 158
 159 /* Applied to dev-5.9 as 25854, integrated to maint-5.8 as 28160, partially
 160  * reverted to dev-5.11 as 9cdcb38b */
 161 #if VMG_HAS_PERL_MAINT(5, 8, 9, 28160) || VMG_HAS_PERL_MAINT(5, 9, 3, 25854) || VMG_HAS_PERL(5, 10, 0)
 162 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
 163 #  if VMG_HAS_PERL(5, 11, 0)
 164 #   define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
 165 #  else
 166 #   define VMG_COMPAT_ARRAY_PUSH_NOLEN 1
 167 #  endif
 168 # endif
 169 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
 170 #  define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 1
 171 # endif
 172 #else
 173 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
 174 #  define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
 175 # endif
 176 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
 177 #  define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 0
 178 # endif
 179 #endif
 180
 181 /* Applied to dev-5.11 as 34908 */
 182 #if VMG_HAS_PERL_MAINT(5, 11, 0, 34908) || VMG_HAS_PERL(5, 12, 0)
 183 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 1
 184 #else
 185 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 0
 186 #endif
 187
 188 /* Applied to dev-5.9 as 31473 (see #43357), integrated to maint-5.8 as 32542 */
 189 #if VMG_HAS_PERL_MAINT(5, 8, 9, 32542) || VMG_HAS_PERL_MAINT(5, 9, 5, 31473) || VMG_HAS_PERL(5, 10, 0)
 190 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 1
 191 #else
 192 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 0
 193 #endif
 194
 195 #if VMG_HAS_PERL_MAINT(5, 11, 0, 32969) || VMG_HAS_PERL(5, 12, 0)
 196 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 1
 197 #else
 198 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 0
 199 #endif
 200
 201 #if VMG_HAS_PERL(5, 13, 2)
 202 # define VMG_COMPAT_GLOB_GET 1
 203 #else
 204 # define VMG_COMPAT_GLOB_GET 0
 205 #endif
 206
 207 /* ... Bug-free mg_magical ................................................. */
 208
 209 /* See the discussion at http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2008-01/msg00036.html. This version is specialized to our needs. */
 210
 211 #if VMG_UVAR
 212
 213 STATIC void vmg_sv_magicuvar(pTHX_ SV *sv, const char *uf, I32 len) {
 214 #define vmg_sv_magicuvar(S, U, L) vmg_sv_magicuvar(aTHX_ (S), (U), (L))
 215  const MAGIC* mg;
 216  sv_magic(sv, NULL, PERL_MAGIC_uvar, uf, len);
 217  /* uvar magic has set and get magic, hence this has set SVs_GMG and SVs_SMG. */
 218  if ((mg = SvMAGIC(sv))) {
 219   SvRMAGICAL_off(sv);
 220   do {
 221    const MGVTBL* const vtbl = mg->mg_virtual;
 222    if (vtbl) {
 223     if (vtbl->svt_clear) {
 224      SvRMAGICAL_on(sv);
 225      break;
 226     }
 227    }
 228   } while ((mg = mg->mg_moremagic));
 229  }
 230 }
 231
 232 #endif /* VMG_UVAR */
 233
 234 /* ... Safe version of call_sv() ........................................... */
 235
 236 #define VMG_SAVE_LAST_CX (!VMG_HAS_PERL(5, 8, 4) || VMG_HAS_PERL(5, 9, 5))
 237
 238 STATIC I32 vmg_call_sv(pTHX_ SV *sv, I32 flags, I32 destructor) {
 239 #define vmg_call_sv(S, F, D) vmg_call_sv(aTHX_ (S), (F), (D))
 240  I32 ret, cxix = 0, in_eval = 0;
 241 #if VMG_SAVE_LAST_CX
 242  PERL_CONTEXT saved_cx;
 243 #endif
 244  SV *old_err = NULL;
 245
 246  if (SvTRUE(ERRSV)) {
 247   old_err = ERRSV;
 248   ERRSV   = newSV(0);
 249  }
 250
 251  if (cxstack_ix < cxstack_max) {
 252   cxix = cxstack_ix + 1;
 253   if (destructor && CxTYPE(cxstack + cxix) == CXt_EVAL)
 254    in_eval = 1;
 255  }
 256
 257 #if VMG_SAVE_LAST_CX
 258  /* The last popped context will be reused by call_sv(), but our callers may
 259   * still need its previous value. Back it up so that it isn't clobbered. */
 260  saved_cx = cxstack[cxix];
 261 #endif
 262
 263  ret = call_sv(sv, flags | G_EVAL);
 264
 265 #if VMG_SAVE_LAST_CX
 266  cxstack[cxix] = saved_cx;
 267 #endif
 268
 269  if (SvTRUE(ERRSV)) {
 270   if (old_err) {
 271    sv_setsv(old_err, ERRSV);
 272    SvREFCNT_dec(ERRSV);
 273    ERRSV = old_err;
 274   }
 275   if (IN_PERL_COMPILETIME) {
 276    if (!PL_in_eval) {
 277     if (PL_errors)
 278      sv_catsv(PL_errors, ERRSV);
 279     else
 280      Perl_warn(aTHX_ "%s", SvPV_nolen(ERRSV));
 281     SvCUR_set(ERRSV, 0);
 282    }
 283 #if VMG_HAS_PERL(5, 10, 0) || defined(PL_parser)
 284    if (PL_parser)
 285     ++PL_parser->error_count;
 286 #elif defined(PL_error_count)
 287    ++PL_error_count;
 288 #else
 289    ++PL_Ierror_count;
 290 #endif
 291    } else if (!in_eval)
 292     croak(NULL);
 293  } else {
 294   if (old_err) {
 295    SvREFCNT_dec(ERRSV);
 296    ERRSV = old_err;
 297   }
 298  }
 299
 300  return ret;
 301 }
 302
 303 /* --- Stolen chunk of B --------------------------------------------------- */
 304
 305 typedef enum {
 306  OPc_NULL   = 0,
 307  OPc_BASEOP = 1,
 308  OPc_UNOP   = 2,
 309  OPc_BINOP  = 3,
 310  OPc_LOGOP  = 4,
 311  OPc_LISTOP = 5,
 312  OPc_PMOP   = 6,
 313  OPc_SVOP   = 7,
 314  OPc_PADOP  = 8,
 315  OPc_PVOP   = 9,
 316  OPc_LOOP   = 10,
 317  OPc_COP    = 11,
 318  OPc_MAX    = 12
 319 } opclass;
 320
 321 STATIC const char *const vmg_opclassnames[] = {
 322  "B::NULL",
 323  "B::OP",
 324  "B::UNOP",
 325  "B::BINOP",
 326  "B::LOGOP",
 327  "B::LISTOP",
 328  "B::PMOP",
 329  "B::SVOP",
 330  "B::PADOP",
 331  "B::PVOP",
 332  "B::LOOP",
 333  "B::COP"
 334 };
 335
 336 STATIC opclass vmg_opclass(const OP *o) {
 337 #if 0
 338  if (!o)
 339   return OPc_NULL;
 340 #endif
 341
 342  if (o->op_type == 0)
 343   return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
 344
 345  if (o->op_type == OP_SASSIGN)
 346   return ((o->op_private & OPpASSIGN_BACKWARDS) ? OPc_UNOP : OPc_BINOP);
 347
 348  if (o->op_type == OP_AELEMFAST) {
 349   if (o->op_flags & OPf_SPECIAL)
 350    return OPc_BASEOP;
 351   else
 352 #ifdef USE_ITHREADS
 353    return OPc_PADOP;
 354 #else
 355    return OPc_SVOP;
 356 #endif
 357  }
 358
 359 #ifdef USE_ITHREADS
 360  if (o->op_type == OP_GV || o->op_type == OP_GVSV || o->op_type == OP_RCATLINE)
 361   return OPc_PADOP;
 362 #endif
 363
 364  switch (PL_opargs[o->op_type] & OA_CLASS_MASK) {
 365   case OA_BASEOP:
 366    return OPc_BASEOP;
 367   case OA_UNOP:
 368    return OPc_UNOP;
 369   case OA_BINOP:
 370    return OPc_BINOP;
 371   case OA_LOGOP:
 372    return OPc_LOGOP;
 373   case OA_LISTOP:
 374    return OPc_LISTOP;
 375   case OA_PMOP:
 376    return OPc_PMOP;
 377   case OA_SVOP:
 378    return OPc_SVOP;
 379   case OA_PADOP:
 380    return OPc_PADOP;
 381   case OA_PVOP_OR_SVOP:
 382    return (o->op_private & (OPpTRANS_TO_UTF|OPpTRANS_FROM_UTF)) ? OPc_SVOP : OPc_PVOP;
 383   case OA_LOOP:
 384    return OPc_LOOP;
 385   case OA_COP:
 386    return OPc_COP;
 387   case OA_BASEOP_OR_UNOP:
 388    return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
 389   case OA_FILESTATOP:
 390    return ((o->op_flags & OPf_KIDS) ? OPc_UNOP :
 391 #ifdef USE_ITHREADS
 392            (o->op_flags & OPf_REF) ? OPc_PADOP : OPc_BASEOP);
 393 #else
 394            (o->op_flags & OPf_REF) ? OPc_SVOP : OPc_BASEOP);
 395 #endif
 396   case OA_LOOPEXOP:
 397    if (o->op_flags & OPf_STACKED)
 398     return OPc_UNOP;
 399    else if (o->op_flags & OPf_SPECIAL)
 400     return OPc_BASEOP;
 401    else
 402     return OPc_PVOP;
 403  }
 404
 405  return OPc_BASEOP;
 406 }
 407
 408 /* --- Error messages ------------------------------------------------------ */
 409
 410 STATIC const char vmg_invalid_wiz[]    = "Invalid wizard object";
 411 STATIC const char vmg_wrongargnum[]    = "Wrong number of arguments";
 412 STATIC const char vmg_argstorefailed[] = "Error while storing arguments";
 413
 414 /* --- Signatures ---------------------------------------------------------- */
 415
 416 #define SIG_WZO ((U16) (0x3891))
 417 #define SIG_WIZ ((U16) (0x3892))
 418
 419 /* --- MGWIZ structure ----------------------------------------------------- */
 420
 421 typedef struct {
 422  MGVTBL *vtbl;
 423
 424  U8 opinfo;
 425  U8 uvar;
 426
 427  SV *cb_data;
 428  SV *cb_get, *cb_set, *cb_len, *cb_clear, *cb_free;
 429 #if MGf_COPY
 430  SV *cb_copy;
 431 #endif /* MGf_COPY */
 432 #if MGf_DUP
 433  SV *cb_dup;
 434 #endif /* MGf_DUP */
 435 #if MGf_LOCAL
 436  SV *cb_local;
 437 #endif /* MGf_LOCAL */
 438 #if VMG_UVAR
 439  SV *cb_fetch, *cb_store, *cb_exists, *cb_delete;
 440 #endif /* VMG_UVAR */
 441
 442 #if VMG_MULTIPLICITY
 443  tTHX owner;
 444 #endif /* VMG_MULTIPLICITY */
 445 } MGWIZ;
 446
 447 STATIC void vmg_mgwiz_free(pTHX_ MGWIZ *w) {
 448 #define vmg_mgwiz_free(W) vmg_mgwiz_free(aTHX_ (W))
 449  if (!w)
 450   return;
 451
 452  /* We reach this point in dirty state when ptable_free() is called from the
 453   * atexit cleanup callback, and that the global table still holds a live
 454   * wizard. This happens before all the SV bodies are freed, so all the wizard
 455   * callbacks are still alive (as they are referenced by the undead wizard).
 456   * Hence it is safe to decrement their refcount. Later on, the wizard free
 457   * callback itself will trigger when the wizard body is reaped, but it will
 458   * be skipped as it guards against dirty state - which is good since nothing
 459   * has to be done anymore at that point. */
 460
 461  SvREFCNT_dec(w->cb_data);
 462  SvREFCNT_dec(w->cb_get);
 463  SvREFCNT_dec(w->cb_set);
 464  SvREFCNT_dec(w->cb_len);
 465  SvREFCNT_dec(w->cb_clear);
 466  SvREFCNT_dec(w->cb_free);
 467 #if MGf_COPY
 468  SvREFCNT_dec(w->cb_copy);
 469 #endif /* MGf_COPY */
 470 #if 0 /* MGf_DUP */
 471  SvREFCNT_dec(w->cb_dup);
 472 #endif /* MGf_DUP */
 473 #if MGf_LOCAL
 474  SvREFCNT_dec(w->cb_local);
 475 #endif /* MGf_LOCAL */
 476 #if VMG_UVAR
 477  SvREFCNT_dec(w->cb_fetch);
 478  SvREFCNT_dec(w->cb_store);
 479  SvREFCNT_dec(w->cb_exists);
 480  SvREFCNT_dec(w->cb_delete);
 481 #endif /* VMG_UVAR */
 482
 483  Safefree(w->vtbl);
 484  Safefree(w);
 485
 486  return;
 487 }
 488
 489 #if VMG_THREADSAFE
 490
 491 #define VMG_CLONE_CB(N) \
 492  z->cb_ ## N = (w->cb_ ## N) ? vmg_clone(w->cb_ ## N, w->owner) \
 493                              : NULL;
 494
 495 STATIC MGWIZ *vmg_mgwiz_clone(pTHX_ const MGWIZ *w) {
 496 #define vmg_mgwiz_clone(W) vmg_mgwiz_clone(aTHX_ (W))
 497  MGVTBL *t;
 498  MGWIZ *z;
 499
 500  if (!w)
 501   return NULL;
 502
 503  Newx(t, 1, MGVTBL);
 504  Copy(w->vtbl, t, 1, MGVTBL);
 505
 506  Newx(z, 1, MGWIZ);
 507
 508  z->vtbl   = t;
 509  z->uvar   = w->uvar;
 510  z->opinfo = w->opinfo;
 511
 512  VMG_CLONE_CB(data);
 513  VMG_CLONE_CB(get);
 514  VMG_CLONE_CB(set);
 515  VMG_CLONE_CB(len);
 516  VMG_CLONE_CB(clear);
 517  VMG_CLONE_CB(free);
 518 #if MGf_COPY
 519  VMG_CLONE_CB(copy);
 520 #endif /* MGf_COPY */
 521 #if MGf_DUP
 522  VMG_CLONE_CB(dup);
 523 #endif /* MGf_DUP */
 524 #if MGf_LOCAL
 525  VMG_CLONE_CB(local);
 526 #endif /* MGf_LOCAL */
 527 #if VMG_UVAR
 528  VMG_CLONE_CB(fetch);
 529  VMG_CLONE_CB(store);
 530  VMG_CLONE_CB(exists);
 531  VMG_CLONE_CB(delete);
 532 #endif /* VMG_UVAR */
 533
 534  z->owner = aTHX;
 535
 536  return z;
 537 }
 538
 539 #endif /* VMG_THREADSAFE */
 540
 541 /* --- Context-safe global data -------------------------------------------- */
 542
 543 #if VMG_THREADSAFE
 544
 545 #define PTABLE_NAME        ptable
 546 #define PTABLE_VAL_FREE(V) vmg_mgwiz_free(V)
 547
 548 #define pPTBL  pTHX
 549 #define pPTBL_ pTHX_
 550 #define aPTBL  aTHX
 551 #define aPTBL_ aTHX_
 552
 553 #include "ptable.h"
 554
 555 #define ptable_store(T, K, V) ptable_store(aTHX_ (T), (K), (V))
 556 #define ptable_clear(T)       ptable_clear(aTHX_ (T))
 557 #define ptable_free(T)        ptable_free(aTHX_ (T))
 558
 559 #endif /* VMG_THREADSAFE */
 560
 561 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
 562
 563 typedef struct {
 564 #if VMG_THREADSAFE
 565  ptable *wizards;
 566  tTHX    owner;
 567 #endif
 568  HV     *b__op_stashes[OPc_MAX];
 569 } my_cxt_t;
 570
 571 START_MY_CXT
 572
 573 #if VMG_THREADSAFE
 574
 575 STATIC void vmg_ptable_clone(pTHX_ ptable_ent *ent, void *ud_) {
 576  my_cxt_t *ud = ud_;
 577  MGWIZ *w;
 578
 579  if (ud->owner == aTHX)
 580   return;
 581
 582  w = vmg_mgwiz_clone(ent->val);
 583  if (w)
 584   ptable_store(ud->wizards, ent->key, w);
 585 }
 586
 587 #endif /* VMG_THREADSAFE */
 588
 589 /* --- Wizard objects ------------------------------------------------------ */
 590
 591 STATIC int vmg_wizard_free(pTHX_ SV *sv, MAGIC *mg);
 592
 593 STATIC MGVTBL vmg_wizard_vtbl = {
 594  NULL,            /* get */
 595  NULL,            /* set */
 596  NULL,            /* len */
 597  NULL,            /* clear */
 598  vmg_wizard_free, /* free */
 599 #if MGf_COPY
 600  NULL,            /* copy */
 601 #endif /* MGf_COPY */
 602 #if MGf_DUP
 603  NULL,            /* dup */
 604 #endif /* MGf_DUP */
 605 #if MGf_LOCAL
 606  NULL,            /* local */
 607 #endif /* MGf_LOCAL */
 608 };
 609
 610 /* ... Wizard constructor .................................................. */
 611
 612 STATIC SV *vmg_wizard_new(pTHX_ const MGWIZ *w) {
 613 #define vmg_wizard_new(W) vmg_wizard_new(aTHX_ (W))
 614  SV *wiz = newSVuv(PTR2IV(w));
 615
 616  if (w) {
 617   MAGIC *mg = sv_magicext(wiz, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, 0);
 618   mg->mg_private = SIG_WZO;
 619  }
 620  SvREADONLY_on(wiz);
 621
 622  return wiz;
 623 }
 624
 625 STATIC const SV *vmg_wizard_validate(pTHX_ const SV *wiz) {
 626 #define vmg_wizard_validate(W) vmg_wizard_validate(aTHX_ (W))
 627  if (SvROK(wiz)) {
 628   wiz = SvRV_const(wiz);
 629   if (SvIOK(wiz))
 630    return wiz;
 631  }
 632
 633  croak(vmg_invalid_wiz);
 634  /* Not reached */
 635  return NULL;
 636 }
 637
 638 #define vmg_wizard_id(W)         SvIVX((const SV *) (W))
 639 #define vmg_wizard_main_mgwiz(W) INT2PTR(const MGWIZ *, vmg_wizard_id(W))
 640
 641 /* ... Wizard destructor ................................................... */
 642
 643 STATIC int vmg_wizard_free(pTHX_ SV *sv, MAGIC *mg) {
 644  MGWIZ *w;
 645
 646  if (PL_dirty) /* During global destruction, the context is already freed */
 647   return 0;
 648
 649  w = (MGWIZ *) vmg_wizard_main_mgwiz(sv);
 650
 651 #if VMG_THREADSAFE
 652  {
 653   dMY_CXT;
 654   ptable_store(MY_CXT.wizards, w, NULL);
 655  }
 656 #else /* VMG_THREADSAFE */
 657  vmg_mgwiz_free(w);
 658 #endif /* !VMG_THREADSAFE */
 659
 660  return 0;
 661 }
 662
 663 #if VMG_THREADSAFE
 664
 665 STATIC const MGWIZ *vmg_wizard_mgwiz(pTHX_ const SV *wiz) {
 666 #define vmg_wizard_mgwiz(W) vmg_wizard_mgwiz(aTHX_ ((const SV *) (W)))
 667  const MGWIZ *w;
 668
 669  w = vmg_wizard_main_mgwiz(wiz);
 670  if (w->owner == aTHX)
 671   return w;
 672
 673  {
 674   dMY_CXT;
 675   return ptable_fetch(MY_CXT.wizards, w);
 676  }
 677 }
 678
 679 #else /* VMG_THREADSAFE */
 680
 681 #define vmg_wizard_mgwiz(W) vmg_wizard_main_mgwiz(W)
 682
 683 #endif /* !VMG_THREADSAFE */
 684
 685 /* --- User-level functions implementation --------------------------------- */
 686
 687 STATIC const MAGIC *vmg_find(const SV *sv, const SV *wiz) {
 688  const MAGIC *mg, *moremagic;
 689  IV wid;
 690
 691  if (SvTYPE(sv) < SVt_PVMG)
 692   return NULL;
 693
 694  wid = vmg_wizard_id(wiz);
 695  for (mg = SvMAGIC(sv); mg; mg = moremagic) {
 696   moremagic = mg->mg_moremagic;
 697   if (mg->mg_type == PERL_MAGIC_ext && mg->mg_private == SIG_WIZ) {
 698    IV zid = vmg_wizard_id(mg->mg_ptr);
 699    if (zid == wid)
 700     return mg;
 701   }
 702  }
 703
 704  return NULL;
 705 }
 706
 707 /* ... Construct private data .............................................. */
 708
 709 STATIC SV *vmg_data_new(pTHX_ SV *ctor, SV *sv, SV **args, I32 items) {
 710 #define vmg_data_new(C, S, A, I) vmg_data_new(aTHX_ (C), (S), (A), (I))
 711  I32 i;
 712  SV *nsv;
 713
 714  dSP;
 715
 716  ENTER;
 717  SAVETMPS;
 718
 719  PUSHMARK(SP);
 720  EXTEND(SP, items + 1);
 721  PUSHs(sv_2mortal(newRV_inc(sv)));
 722  for (i = 0; i < items; ++i)
 723   PUSHs(args[i]);
 724  PUTBACK;
 725
 726  vmg_call_sv(ctor, G_SCALAR, 0);
 727
 728  SPAGAIN;
 729  nsv = POPs;
 730 #if VMG_HAS_PERL(5, 8, 3)
 731  SvREFCNT_inc_simple_void(nsv); /* Or it will be destroyed in FREETMPS */
 732 #else
 733  nsv = sv_newref(nsv);          /* Workaround some bug in SvREFCNT_inc() */
 734 #endif
 735  PUTBACK;
 736
 737  FREETMPS;
 738  LEAVE;
 739
 740  return nsv;
 741 }
 742
 743 STATIC SV *vmg_data_get(pTHX_ SV *sv, const SV *wiz) {
 744 #define vmg_data_get(S, W) vmg_data_get(aTHX_ (S), (W))
 745  const MAGIC *mg = vmg_find(sv, wiz);
 746  return mg ? mg->mg_obj : NULL;
 747 }
 748
 749 /* ... Magic cast/dispell .................................................. */
 750
 751 #if VMG_UVAR
 752 STATIC I32 vmg_svt_val(pTHX_ IV, SV *);
 753
 754 STATIC void vmg_uvar_del(SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
 755  if (prevmagic) {
 756   prevmagic->mg_moremagic = moremagic;
 757  } else {
 758   SvMAGIC_set(sv, moremagic);
 759  }
 760  mg->mg_moremagic = NULL;
 761  Safefree(mg->mg_ptr);
 762  Safefree(mg);
 763 }
 764 #endif /* VMG_UVAR */
 765
 766 STATIC UV vmg_cast(pTHX_ SV *sv, const SV *wiz, SV **args, I32 items) {
 767 #define vmg_cast(S, W, A, I) vmg_cast(aTHX_ (S), (W), (A), (I))
 768  MAGIC       *mg, *moremagic = NULL;
 769  SV          *data;
 770  const MGWIZ *w;
 771  U32          oldgmg;
 772
 773  if (vmg_find(sv, wiz))
 774   return 1;
 775
 776  w = vmg_wizard_mgwiz(wiz);
 777  oldgmg = SvGMAGICAL(sv);
 778
 779  data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args, items) : NULL;
 780  mg = sv_magicext(sv, data, PERL_MAGIC_ext, w->vtbl, (const char *) wiz, HEf_SVKEY);
 781  SvREFCNT_dec(data);
 782  mg->mg_private = SIG_WIZ;
 783 #if MGf_COPY
 784  if (w->cb_copy)
 785   mg->mg_flags |= MGf_COPY;
 786 #endif /* MGf_COPY */
 787 #if 0 /* MGf_DUP */
 788  if (w->cb_dup)
 789   mg->mg_flags |= MGf_DUP;
 790 #endif /* MGf_DUP */
 791 #if MGf_LOCAL
 792  if (w->cb_local)
 793   mg->mg_flags |= MGf_LOCAL;
 794 #endif /* MGf_LOCAL */
 795
 796  if (SvTYPE(sv) < SVt_PVHV)
 797   goto done;
 798
 799  /* The GMAGICAL flag only says that a hash is tied or has uvar magic - get
 800   * magic is actually never called for them. If the GMAGICAL flag was off before
 801   * calling sv_magicext(), the hash isn't tied and has no uvar magic. If it's
 802   * now on, then this wizard has get magic. Hence we can work around the
 803   * get/clear shortcoming by turning the GMAGICAL flag off. If the current magic
 804   * has uvar callbacks, it will be turned back on later. */
 805  if (!oldgmg && SvGMAGICAL(sv))
 806   SvGMAGICAL_off(sv);
 807
 808 #if VMG_UVAR
 809  if (w->uvar) {
 810   MAGIC *prevmagic;
 811   struct ufuncs uf[2];
 812
 813   uf[0].uf_val   = vmg_svt_val;
 814   uf[0].uf_set   = NULL;
 815   uf[0].uf_index = 0;
 816   uf[1].uf_val   = NULL;
 817   uf[1].uf_set   = NULL;
 818   uf[1].uf_index = 0;
 819
 820   /* One uvar magic in the chain is enough. */
 821   for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
 822    moremagic = mg->mg_moremagic;
 823    if (mg->mg_type == PERL_MAGIC_uvar)
 824     break;
 825   }
 826
 827   if (mg) { /* Found another uvar magic. */
 828    struct ufuncs *olduf = (struct ufuncs *) mg->mg_ptr;
 829    if (olduf->uf_val == vmg_svt_val) {
 830     /* It's our uvar magic, nothing to do. oldgmg was true. */
 831     goto done;
 832    } else {
 833     /* It's another uvar magic, backup it and replace it by ours. */
 834     uf[1] = *olduf;
 835     vmg_uvar_del(sv, prevmagic, mg, moremagic);
 836    }
 837   }
 838
 839   vmg_sv_magicuvar(sv, (const char *) &uf, sizeof(uf));
 840   /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
 841    * handled by our uvar callback. */
 842  }
 843 #endif /* VMG_UVAR */
 844
 845 done:
 846  return 1;
 847 }
 848
 849 STATIC UV vmg_dispell(pTHX_ SV *sv, const SV *wiz) {
 850 #define vmg_dispell(S, W) vmg_dispell(aTHX_ (S), (W))
 851 #if VMG_UVAR
 852  U32 uvars = 0;
 853 #endif /* VMG_UVAR */
 854  MAGIC *mg, *prevmagic, *moremagic = NULL;
 855  IV wid = vmg_wizard_id(wiz);
 856
 857  if (SvTYPE(sv) < SVt_PVMG)
 858   return 0;
 859
 860  for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
 861   moremagic = mg->mg_moremagic;
 862   if (mg->mg_type == PERL_MAGIC_ext && mg->mg_private == SIG_WIZ) {
 863    const MGWIZ *z   = vmg_wizard_mgwiz(mg->mg_ptr);
 864    IV           zid = vmg_wizard_id(mg->mg_ptr);
 865    if (zid == wid) {
 866 #if VMG_UVAR
 867     /* If the current has no uvar, short-circuit uvar deletion. */
 868     uvars = z->uvar ? (uvars + 1) : 0;
 869 #endif /* VMG_UVAR */
 870     break;
 871 #if VMG_UVAR
 872    } else if (z->uvar) {
 873     ++uvars;
 874     /* We can't break here since we need to find the ext magic to delete. */
 875 #endif /* VMG_UVAR */
 876    }
 877   }
 878  }
 879  if (!mg)
 880   return 0;
 881
 882  if (prevmagic) {
 883   prevmagic->mg_moremagic = moremagic;
 884  } else {
 885   SvMAGIC_set(sv, moremagic);
 886  }
 887  mg->mg_moremagic = NULL;
 888
 889  /* Destroy private data */
 890  if (mg->mg_obj != sv)
 891   SvREFCNT_dec(mg->mg_obj);
 892  /* Unreference the wizard */
 893  SvREFCNT_dec((SV *) mg->mg_ptr);
 894  Safefree(mg);
 895
 896 #if VMG_UVAR
 897  if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
 898   /* mg was the first ext magic in the chain that had uvar */
 899
 900   for (mg = moremagic; mg; mg = mg->mg_moremagic) {
 901    if (mg->mg_type == PERL_MAGIC_ext && mg->mg_private == SIG_WIZ) {
 902     const MGWIZ *z = vmg_wizard_mgwiz(mg->mg_ptr);
 903     if (z->uvar) {
 904      ++uvars;
 905      break;
 906     }
 907    }
 908   }
 909
 910   if (uvars == 1) {
 911    struct ufuncs *uf;
 912    for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
 913     moremagic = mg->mg_moremagic;
 914     if (mg->mg_type == PERL_MAGIC_uvar)
 915      break;
 916    }
 917    /* assert(mg); */
 918    uf = (struct ufuncs *) mg->mg_ptr;
 919    /* assert(uf->uf_val == vmg_svt_val); */
 920    if (uf[1].uf_val || uf[1].uf_set) {
 921     /* Revert the original uvar magic. */
 922     uf[0] = uf[1];
 923     Renew(uf, 1, struct ufuncs);
 924     mg->mg_ptr = (char *) uf;
 925     mg->mg_len = sizeof(struct ufuncs);
 926    } else {
 927     /* Remove the uvar magic. */
 928     vmg_uvar_del(sv, prevmagic, mg, moremagic);
 929    }
 930   }
 931  }
 932 #endif /* VMG_UVAR */
 933
 934  return 1;
 935 }
 936
 937 /* ... OP info ............................................................. */
 938
 939 #define VMG_OP_INFO_NAME   1
 940 #define VMG_OP_INFO_OBJECT 2
 941
 942 #if VMG_THREADSAFE
 943 STATIC perl_mutex vmg_op_name_init_mutex;
 944 #endif
 945
 946 STATIC U32           vmg_op_name_init      = 0;
 947 STATIC unsigned char vmg_op_name_len[MAXO] = { 0 };
 948
 949 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo) {
 950 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
 951  switch (opinfo) {
 952   case VMG_OP_INFO_NAME:
 953 #if VMG_THREADSAFE
 954    MUTEX_LOCK(&vmg_op_name_init_mutex);
 955 #endif
 956    if (!vmg_op_name_init) {
 957     OPCODE t;
 958     for (t = 0; t < OP_max; ++t)
 959      vmg_op_name_len[t] = strlen(PL_op_name[t]);
 960     vmg_op_name_init = 1;
 961    }
 962 #if VMG_THREADSAFE
 963    MUTEX_UNLOCK(&vmg_op_name_init_mutex);
 964 #endif
 965    break;
 966   case VMG_OP_INFO_OBJECT: {
 967    dMY_CXT;
 968    if (!MY_CXT.b__op_stashes[0]) {
 969     opclass c;
 970     require_pv("B.pm");
 971     for (c = OPc_NULL; c < OPc_MAX; ++c)
 972      MY_CXT.b__op_stashes[c] = gv_stashpv(vmg_opclassnames[c], 1);
 973    }
 974    break;
 975   }
 976   default:
 977    break;
 978  }
 979 }
 980
 981 STATIC SV *vmg_op_info(pTHX_ unsigned int opinfo) {
 982 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
 983  if (!PL_op)
 984   return &PL_sv_undef;
 985
 986  switch (opinfo) {
 987   case VMG_OP_INFO_NAME: {
 988    OPCODE t = PL_op->op_type;
 989    return sv_2mortal(newSVpvn(PL_op_name[t], vmg_op_name_len[t]));
 990   }
 991   case VMG_OP_INFO_OBJECT: {
 992    dMY_CXT;
 993    return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
 994                    MY_CXT.b__op_stashes[vmg_opclass(PL_op)]);
 995   }
 996   default:
 997    break;
 998  }
 999
1000  return &PL_sv_undef;
1001 }
1002
1003 /* ... svt callbacks ....................................................... */
1004
1005 #define VMG_CB_CALL_ARGS_MASK  15
1006 #define VMG_CB_CALL_ARGS_SHIFT 4
1007 #define VMG_CB_CALL_OPINFO     (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT)
1008
1009 STATIC int vmg_cb_call(pTHX_ SV *cb, unsigned int flags, SV *sv, ...) {
1010  va_list ap;
1011  int ret = 0;
1012  unsigned int i, args, opinfo;
1013  SV *svr;
1014
1015  dSP;
1016
1017  args    = flags & VMG_CB_CALL_ARGS_MASK;
1018  flags >>= VMG_CB_CALL_ARGS_SHIFT;
1019  opinfo  = flags & VMG_CB_CALL_OPINFO;
1020
1021  ENTER;
1022  SAVETMPS;
1023
1024  PUSHMARK(SP);
1025  EXTEND(SP, args + 1);
1026  PUSHs(sv_2mortal(newRV_inc(sv)));
1027  va_start(ap, sv);
1028  for (i = 0; i < args; ++i) {
1029   SV *sva = va_arg(ap, SV *);
1030   PUSHs(sva ? sva : &PL_sv_undef);
1031  }
1032  va_end(ap);
1033  if (opinfo)
1034   XPUSHs(vmg_op_info(opinfo));
1035  PUTBACK;
1036
1037  vmg_call_sv(cb, G_SCALAR, 0);
1038
1039  SPAGAIN;
1040  svr = POPs;
1041  if (SvOK(svr))
1042   ret = (int) SvIV(svr);
1043  PUTBACK;
1044
1045  FREETMPS;
1046  LEAVE;
1047
1048  return ret;
1049 }
1050
1051 #define VMG_CB_FLAGS(OI, A) \
1052         ((((unsigned int) (OI)) << VMG_CB_CALL_ARGS_SHIFT) | (A))
1053
1054 #define vmg_cb_call1(I, OI, S, A1) \
1055         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 1), (S), (A1))
1056 #define vmg_cb_call2(I, OI, S, A1, A2) \
1057         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 2), (S), (A1), (A2))
1058 #define vmg_cb_call3(I, OI, S, A1, A2, A3) \
1059         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 3), (S), (A1), (A2), (A3))
1060
1061 STATIC int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
1062  const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
1063  return vmg_cb_call1(w->cb_get, w->opinfo, sv, mg->mg_obj);
1064 }
1065
1066 STATIC int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
1067  const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
1068  return vmg_cb_call1(w->cb_set, w->opinfo, sv, mg->mg_obj);
1069 }
1070
1071 STATIC U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
1072  const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
1073  unsigned int opinfo = w->opinfo;
1074  U32 len, ret;
1075  SV *svr;
1076  svtype t = SvTYPE(sv);
1077
1078  dSP;
1079
1080  ENTER;
1081  SAVETMPS;
1082
1083  PUSHMARK(SP);
1084  EXTEND(SP, 3);
1085  PUSHs(sv_2mortal(newRV_inc(sv)));
1086  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1087  if (t < SVt_PVAV) {
1088   STRLEN l;
1089 #if VMG_HAS_PERL(5, 9, 3)
1090   const U8 *s = SvPV_const(sv, l);
1091 #else
1092   U8 *s = SvPV(sv, l);
1093 #endif
1094   if (DO_UTF8(sv))
1095    len = utf8_length(s, s + l);
1096   else
1097    len = l;
1098   mPUSHu(len);
1099  } else if (t == SVt_PVAV) {
1100   len = av_len((AV *) sv) + 1;
1101   mPUSHu(len);
1102  } else {
1103   len = 0;
1104   PUSHs(&PL_sv_undef);
1105  }
1106  if (opinfo)
1107   XPUSHs(vmg_op_info(opinfo));
1108  PUTBACK;
1109
1110  vmg_call_sv(w->cb_len, G_SCALAR, 0);
1111
1112  SPAGAIN;
1113  svr = POPs;
1114  ret = SvOK(svr) ? (U32) SvUV(svr) : len;
1115  if (t == SVt_PVAV)
1116   --ret;
1117  PUTBACK;
1118
1119  FREETMPS;
1120  LEAVE;
1121
1122  return ret;
1123 }
1124
1125 STATIC int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
1126  const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
1127  return vmg_cb_call1(w->cb_clear, w->opinfo, sv, mg->mg_obj);
1128 }
1129
1130 STATIC int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
1131  const MGWIZ *w;
1132  int ret = 0;
1133  SV *svr;
1134
1135  dSP;
1136
1137  /* Don't even bother if we are in global destruction - the wizard is prisoner
1138   * of circular references and we are way beyond user realm */
1139  if (PL_dirty)
1140   return 0;
1141
1142  w = vmg_wizard_mgwiz(mg->mg_ptr);
1143
1144  /* So that it survives the temp cleanup below */
1145  SvREFCNT_inc_simple_void(sv);
1146
1147 #if !(VMG_HAS_PERL_MAINT(5, 11, 0, 32686) || VMG_HAS_PERL(5, 12, 0))
1148  /* The previous magic tokens were freed but the magic chain wasn't updated, so
1149   * if you access the sv from the callback the old deleted magics will trigger
1150   * and cause memory misreads. Change 32686 solved it that way : */
1151  SvMAGIC_set(sv, mg);
1152 #endif
1153
1154  ENTER;
1155  SAVETMPS;
1156
1157  PUSHMARK(SP);
1158  EXTEND(SP, 2);
1159  PUSHs(sv_2mortal(newRV_inc(sv)));
1160  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1161  if (w->opinfo)
1162   XPUSHs(vmg_op_info(w->opinfo));
1163  PUTBACK;
1164
1165  vmg_call_sv(w->cb_free, G_SCALAR, 1);
1166
1167  SPAGAIN;
1168  svr = POPs;
1169  if (SvOK(svr))
1170   ret = (int) SvIV(svr);
1171  PUTBACK;
1172
1173  FREETMPS;
1174  LEAVE;
1175
1176  /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
1177   * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
1178  --SvREFCNT(sv);
1179
1180  /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
1181   * mg->mg_ptr reference count */
1182  return ret;
1183 }
1184
1185 #if MGf_COPY
1186 STATIC int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key,
1187 # if VMG_HAS_PERL_MAINT(5, 11, 0, 33256) || VMG_HAS_PERL(5, 12, 0)
1188   I32 keylen
1189 # else
1190   int keylen
1191 # endif
1192  ) {
1193  SV *keysv;
1194  const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
1195  int ret;
1196
1197  if (keylen == HEf_SVKEY) {
1198   keysv = (SV *) key;
1199  } else {
1200   keysv = newSVpvn(key, keylen);
1201  }
1202
1203  ret = vmg_cb_call3(w->cb_copy, w->opinfo, sv, mg->mg_obj, keysv, nsv);
1204
1205  if (keylen != HEf_SVKEY) {
1206   SvREFCNT_dec(keysv);
1207  }
1208
1209  return ret;
1210 }
1211 #endif /* MGf_COPY */
1212
1213 #if 0 /*  MGf_DUP */
1214 STATIC int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
1215  return 0;
1216 }
1217 #endif /* MGf_DUP */
1218
1219 #if MGf_LOCAL
1220 STATIC int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
1221  const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
1222  return vmg_cb_call1(w->cb_local, w->opinfo, nsv, mg->mg_obj);
1223 }
1224 #endif /* MGf_LOCAL */
1225
1226 #if VMG_UVAR
1227 STATIC OP *vmg_pp_resetuvar(pTHX) {
1228  SvRMAGICAL_on(cSVOP_sv);
1229  return NORMAL;
1230 }
1231
1232 STATIC I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
1233  struct ufuncs *uf;
1234  MAGIC *mg, *umg;
1235  SV *key = NULL, *newkey = NULL;
1236  int tied = 0;
1237
1238  umg = mg_find(sv, PERL_MAGIC_uvar);
1239  /* umg can't be NULL or we wouldn't be there. */
1240  key = umg->mg_obj;
1241  uf  = (struct ufuncs *) umg->mg_ptr;
1242
1243  if (uf[1].uf_val)
1244   uf[1].uf_val(aTHX_ action, sv);
1245  if (uf[1].uf_set)
1246   uf[1].uf_set(aTHX_ action, sv);
1247
1248  action &= HV_FETCH_ISSTORE | HV_FETCH_ISEXISTS | HV_FETCH_LVALUE | HV_DELETE;
1249  for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
1250   const MGWIZ *w;
1251   switch (mg->mg_type) {
1252    case PERL_MAGIC_ext:
1253     break;
1254    case PERL_MAGIC_tied:
1255     ++tied;
1256     continue;
1257    default:
1258     continue;
1259   }
1260   if (mg->mg_private != SIG_WIZ) continue;
1261   w = vmg_wizard_mgwiz(mg->mg_ptr);
1262   switch (w->uvar) {
1263    case 0:
1264     continue;
1265    case 2:
1266     if (!newkey)
1267      newkey = key = umg->mg_obj = sv_mortalcopy(umg->mg_obj);
1268   }
1269   switch (action) {
1270    case 0:
1271     if (w->cb_fetch)
1272      vmg_cb_call2(w->cb_fetch, w->opinfo, sv, mg->mg_obj, key);
1273     break;
1274    case HV_FETCH_ISSTORE:
1275    case HV_FETCH_LVALUE:
1276    case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
1277     if (w->cb_store)
1278      vmg_cb_call2(w->cb_store, w->opinfo, sv, mg->mg_obj, key);
1279     break;
1280    case HV_FETCH_ISEXISTS:
1281     if (w->cb_exists)
1282      vmg_cb_call2(w->cb_exists, w->opinfo, sv, mg->mg_obj, key);
1283     break;
1284    case HV_DELETE:
1285     if (w->cb_delete)
1286      vmg_cb_call2(w->cb_delete, w->opinfo, sv, mg->mg_obj, key);
1287     break;
1288   }
1289  }
1290
1291  if (SvRMAGICAL(sv) && !tied) {
1292   /* Temporarily hide the RMAGICAL flag of the hash so it isn't wrongly
1293    * mistaken for a tied hash by the rest of hv_common. It will be reset by
1294    * the op_ppaddr of a new fake op injected between the current and the next
1295    * one. */
1296   OP *o = PL_op;
1297   if (!o->op_next || o->op_next->op_ppaddr != vmg_pp_resetuvar) {
1298    SVOP *svop;
1299    NewOp(1101, svop, 1, SVOP);
1300    svop->op_type   = OP_STUB;
1301    svop->op_ppaddr = vmg_pp_resetuvar;
1302    svop->op_next   = o->op_next;
1303    svop->op_flags  = 0;
1304    svop->op_sv     = sv;
1305    o->op_next      = (OP *) svop;
1306   }
1307   SvRMAGICAL_off(sv);
1308  }
1309
1310  return 0;
1311 }
1312 #endif /* VMG_UVAR */
1313
1314 /* --- Macros for the XS section ------------------------------------------- */
1315
1316 #define VMG_SET_CB(S, N)              \
1317  cb = (S);                            \
1318  w->cb_ ## N = (SvOK(cb) && SvROK(cb)) ? SvREFCNT_inc(SvRV(cb)) : NULL;
1319
1320 #define VMG_SET_SVT_CB(S, N)          \
1321  cb = (S);                            \
1322  if (SvOK(cb) && SvROK(cb)) {         \
1323   t->svt_ ## N = vmg_svt_ ## N;       \
1324   w->cb_  ## N = SvREFCNT_inc(SvRV(cb)); \
1325  } else {                             \
1326   t->svt_ ## N = NULL;                \
1327   w->cb_  ## N = NULL;                \
1328  }
1329
1330 #if VMG_THREADSAFE
1331
1332 STATIC void vmg_cleanup(pTHX_ void *ud) {
1333  dMY_CXT;
1334
1335  ptable_free(MY_CXT.wizards);
1336  MY_CXT.wizards = NULL;
1337 }
1338
1339 #endif /* VMG_THREADSAFE */
1340
1341 /* --- XS ------------------------------------------------------------------ */
1342
1343 MODULE = Variable::Magic            PACKAGE = Variable::Magic
1344
1345 PROTOTYPES: ENABLE
1346
1347 BOOT:
1348 {
1349  HV *stash;
1350
1351  MY_CXT_INIT;
1352 #if VMG_THREADSAFE
1353  MY_CXT.wizards = ptable_new();
1354  MY_CXT.owner   = aTHX;
1355 #endif
1356  MY_CXT.b__op_stashes[0] = NULL;
1357 #if VMG_THREADSAFE
1358  MUTEX_INIT(&vmg_op_name_init_mutex);
1359  call_atexit(vmg_cleanup, NULL);
1360 #endif
1361
1362  stash = gv_stashpv(__PACKAGE__, 1);
1363  newCONSTSUB(stash, "MGf_COPY",  newSVuv(MGf_COPY));
1364  newCONSTSUB(stash, "MGf_DUP",   newSVuv(MGf_DUP));
1365  newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
1366  newCONSTSUB(stash, "VMG_UVAR",  newSVuv(VMG_UVAR));
1367  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
1368                     newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
1369  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID",
1370                     newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID));
1371  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
1372                     newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
1373  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
1374                     newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
1375  newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
1376                     newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
1377  newCONSTSUB(stash, "VMG_COMPAT_GLOB_GET", newSVuv(VMG_COMPAT_GLOB_GET));
1378  newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
1379  newCONSTSUB(stash, "VMG_THREADSAFE",      newSVuv(VMG_THREADSAFE));
1380  newCONSTSUB(stash, "VMG_FORKSAFE",        newSVuv(VMG_FORKSAFE));
1381  newCONSTSUB(stash, "VMG_OP_INFO_NAME",    newSVuv(VMG_OP_INFO_NAME));
1382  newCONSTSUB(stash, "VMG_OP_INFO_OBJECT",  newSVuv(VMG_OP_INFO_OBJECT));
1383 }
1384
1385 #if VMG_THREADSAFE
1386
1387 void
1388 CLONE(...)
1389 PROTOTYPE: DISABLE
1390 PREINIT:
1391  ptable *t;
1392  U32     had_b__op_stash = 0;
1393  opclass c;
1394 PPCODE:
1395  {
1396   my_cxt_t ud;
1397   dMY_CXT;
1398
1399   ud.wizards = t = ptable_new();
1400   ud.owner   = MY_CXT.owner;
1401   ptable_walk(MY_CXT.wizards, vmg_ptable_clone, &ud);
1402
1403   for (c = OPc_NULL; c < OPc_MAX; ++c) {
1404    if (MY_CXT.b__op_stashes[c])
1405     had_b__op_stash |= (((U32) 1) << c);
1406   }
1407  }
1408  {
1409   MY_CXT_CLONE;
1410   MY_CXT.wizards = t;
1411   MY_CXT.owner   = aTHX;
1412   for (c = OPc_NULL; c < OPc_MAX; ++c) {
1413    MY_CXT.b__op_stashes[c] = (had_b__op_stash & (((U32) 1) << c))
1414                               ? gv_stashpv(vmg_opclassnames[c], 1) : NULL;
1415   }
1416  }
1417  XSRETURN(0);
1418
1419 #endif /* VMG_THREADSAFE */
1420
1421 SV *_wizard(...)
1422 PROTOTYPE: DISABLE
1423 PREINIT:
1424  I32 i = 0;
1425  UV opinfo;
1426  MGWIZ *w;
1427  MGVTBL *t;
1428  SV *cb;
1429 CODE:
1430  dMY_CXT;
1431
1432  if (items != 7
1433 #if MGf_COPY
1434               + 1
1435 #endif /* MGf_COPY */
1436 #if MGf_DUP
1437               + 1
1438 #endif /* MGf_DUP */
1439 #if MGf_LOCAL
1440               + 1
1441 #endif /* MGf_LOCAL */
1442 #if VMG_UVAR
1443               + 5
1444 #endif /* VMG_UVAR */
1445               ) { croak(vmg_wrongargnum); }
1446
1447  Newx(t, 1, MGVTBL);
1448  Newx(w, 1, MGWIZ);
1449
1450  VMG_SET_CB(ST(i++), data);
1451
1452  cb = ST(i++);
1453  opinfo = SvOK(cb) ? SvUV(cb) : 0;
1454  w->opinfo = (U8) ((opinfo < 255) ? opinfo : 255);
1455  if (w->opinfo)
1456   vmg_op_info_init(w->opinfo);
1457
1458  VMG_SET_SVT_CB(ST(i++), get);
1459  VMG_SET_SVT_CB(ST(i++), set);
1460  VMG_SET_SVT_CB(ST(i++), len);
1461  VMG_SET_SVT_CB(ST(i++), clear);
1462  VMG_SET_SVT_CB(ST(i++), free);
1463 #if MGf_COPY
1464  VMG_SET_SVT_CB(ST(i++), copy);
1465 #endif /* MGf_COPY */
1466 #if MGf_DUP
1467  /* VMG_SET_SVT_CB(ST(i++), dup); */
1468  i++;
1469  t->svt_dup = NULL;
1470  w->cb_dup  = NULL;
1471 #endif /* MGf_DUP */
1472 #if MGf_LOCAL
1473  VMG_SET_SVT_CB(ST(i++), local);
1474 #endif /* MGf_LOCAL */
1475 #if VMG_UVAR
1476  VMG_SET_CB(ST(i++), fetch);
1477  VMG_SET_CB(ST(i++), store);
1478  VMG_SET_CB(ST(i++), exists);
1479  VMG_SET_CB(ST(i++), delete);
1480  cb = ST(i++);
1481  if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
1482   w->uvar = SvTRUE(cb) ? 2 : 1;
1483  else
1484   w->uvar = 0;
1485 #endif /* VMG_UVAR */
1486 #if VMG_MULTIPLICITY
1487  w->owner = aTHX;
1488 #endif /* VMG_MULTIPLICITY */
1489  w->vtbl  = t;
1490 #if VMG_THREADSAFE
1491  ptable_store(MY_CXT.wizards, w, w);
1492 #endif /* VMG_THREADSAFE */
1493
1494  RETVAL = newRV_noinc(vmg_wizard_new(w));
1495 OUTPUT:
1496  RETVAL
1497
1498 SV *cast(SV *sv, SV *wiz, ...)
1499 PROTOTYPE: \[$@%&*]$@
1500 PREINIT:
1501  SV **args = NULL;
1502  I32 i = 0;
1503 CODE:
1504  if (items > 2) {
1505   i = items - 2;
1506   args = &ST(2);
1507  }
1508  RETVAL = newSVuv(vmg_cast(SvRV(sv), vmg_wizard_validate(wiz), args, i));
1509 OUTPUT:
1510  RETVAL
1511
1512 void
1513 getdata(SV *sv, SV *wiz)
1514 PROTOTYPE: \[$@%&*]$
1515 PREINIT:
1516  SV *data;
1517 PPCODE:
1518  data = vmg_data_get(SvRV(sv), vmg_wizard_validate(wiz));
1519  if (!data)
1520   XSRETURN_EMPTY;
1521  ST(0) = data;
1522  XSRETURN(1);
1523
1524 SV *dispell(SV *sv, SV *wiz)
1525 PROTOTYPE: \[$@%&*]$
1526 CODE:
1527  RETVAL = newSVuv(vmg_dispell(SvRV(sv), vmg_wizard_validate(wiz)));
1528 OUTPUT:
1529  RETVAL