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