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)
  53 #  define VMG_MULTIPLICITY 1
  54 # else
  55 #  define VMG_MULTIPLICITY 0
  56 # endif
  57 #endif
  58 #if VMG_MULTIPLICITY
  59 # ifndef PERL_IMPLICIT_CONTEXT
  60 #  error MULTIPLICITY builds must set PERL_IMPLICIT_CONTEXT
  61 # endif
  62 #endif
  63
  64 #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))
  65 # ifndef VMG_THREADSAFE
  66 #  define VMG_THREADSAFE 1
  67 # endif
  68 # ifndef MY_CXT_CLONE
  69 #  define MY_CXT_CLONE \
  70     dMY_CXT_SV;                                                      \
  71     my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
  72     Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
  73     sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
  74 # endif
  75 #else
  76 # undef  VMG_THREADSAFE
  77 # define VMG_THREADSAFE 0
  78 # undef  dMY_CXT
  79 # define dMY_CXT      dNOOP
  80 # undef  MY_CXT
  81 # define MY_CXT       vmg_globaldata
  82 # undef  START_MY_CXT
  83 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
  84 # undef  MY_CXT_INIT
  85 # define MY_CXT_INIT  NOOP
  86 # undef  MY_CXT_CLONE
  87 # define MY_CXT_CLONE NOOP
  88 #endif
  89
  90 #if VMG_THREADSAFE
  91 # define VMG_LOCK(M)   MUTEX_LOCK(M)
  92 # define VMG_UNLOCK(M) MUTEX_UNLOCK(M)
  93 #else
  94 # define VMG_LOCK(M)
  95 # define VMG_UNLOCK(M)
  96 #endif
  97
  98 /* --- Compatibility ------------------------------------------------------- */
  99
 100 #ifndef Newx
 101 # define Newx(v, n, c) New(0, v, n, c)
 102 #endif
 103
 104 #ifndef SvMAGIC_set
 105 # define SvMAGIC_set(sv, val) (SvMAGIC(sv) = (val))
 106 #endif
 107
 108 #ifndef SvRV_const
 109 # define SvRV_const(sv) SvRV((SV *) sv)
 110 #endif
 111
 112 #ifndef SvREFCNT_inc_simple_void
 113 # define SvREFCNT_inc_simple_void(sv) ((void) SvREFCNT_inc(sv))
 114 #endif
 115
 116 #ifndef mPUSHu
 117 # define mPUSHu(U) PUSHs(sv_2mortal(newSVuv(U)))
 118 #endif
 119
 120 #ifndef PERL_MAGIC_ext
 121 # define PERL_MAGIC_ext '~'
 122 #endif
 123
 124 #ifndef PERL_MAGIC_tied
 125 # define PERL_MAGIC_tied 'P'
 126 #endif
 127
 128 #ifndef MGf_LOCAL
 129 # define MGf_LOCAL 0
 130 #endif
 131
 132 #ifndef IN_PERL_COMPILETIME
 133 # define IN_PERL_COMPILETIME (PL_curcop == &PL_compiling)
 134 #endif
 135
 136 #ifndef OP_NAME
 137 # define OP_NAME(O) (PL_op_name[(O)->op_type])
 138 #endif
 139
 140 #ifndef OP_CLASS
 141 # define OP_CLASS(O) (PL_opargs[(O)->op_type] & OA_CLASS_MASK)
 142 #endif
 143
 144 #ifdef DEBUGGING
 145 # define VMG_ASSERT(C) assert(C)
 146 #else
 147 # define VMG_ASSERT(C)
 148 #endif
 149
 150 /* uvar magic and Hash::Util::FieldHash were commited with 28419, but we only
 151  * enable them on 5.10 */
 152 #if VMG_HAS_PERL(5, 10, 0)
 153 # define VMG_UVAR 1
 154 #else
 155 # define VMG_UVAR 0
 156 #endif
 157
 158 #if VMG_HAS_PERL_MAINT(5, 11, 0, 32969) || VMG_HAS_PERL(5, 12, 0)
 159 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 1
 160 #else
 161 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 0
 162 #endif
 163
 164 #if VMG_HAS_PERL(5, 17, 4)
 165 # define VMG_COMPAT_SCALAR_NOLEN 1
 166 #else
 167 # define VMG_COMPAT_SCALAR_NOLEN 0
 168 #endif
 169
 170 /* Applied to dev-5.9 as 25854, integrated to maint-5.8 as 28160, partially
 171  * reverted to dev-5.11 as 9cdcb38b */
 172 #if VMG_HAS_PERL_MAINT(5, 8, 9, 28160) || VMG_HAS_PERL_MAINT(5, 9, 3, 25854) || VMG_HAS_PERL(5, 10, 0)
 173 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
 174 #  if VMG_HAS_PERL(5, 11, 0)
 175 #   define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
 176 #  else
 177 #   define VMG_COMPAT_ARRAY_PUSH_NOLEN 1
 178 #  endif
 179 # endif
 180 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
 181 #  define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 1
 182 # endif
 183 #else
 184 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
 185 #  define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
 186 # endif
 187 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
 188 #  define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 0
 189 # endif
 190 #endif
 191
 192 /* Applied to dev-5.11 as 34908 */
 193 #if VMG_HAS_PERL_MAINT(5, 11, 0, 34908) || VMG_HAS_PERL(5, 12, 0)
 194 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 1
 195 #else
 196 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 0
 197 #endif
 198
 199 /* Applied to dev-5.9 as 31473 (see #43357), integrated to maint-5.8 as 32542 */
 200 #if VMG_HAS_PERL_MAINT(5, 8, 9, 32542) || VMG_HAS_PERL_MAINT(5, 9, 5, 31473) || VMG_HAS_PERL(5, 10, 0)
 201 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 1
 202 #else
 203 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 0
 204 #endif
 205
 206 #if VMG_HAS_PERL(5, 11, 0)
 207 # define VMG_COMPAT_HASH_DELETE_NOUVAR_VOID 1
 208 #else
 209 # define VMG_COMPAT_HASH_DELETE_NOUVAR_VOID 0
 210 #endif
 211
 212 #if VMG_HAS_PERL(5, 17, 0)
 213 # define VMG_COMPAT_CODE_COPY_CLONE 1
 214 #else
 215 # define VMG_COMPAT_CODE_COPY_CLONE 0
 216 #endif
 217
 218 #if VMG_HAS_PERL(5, 13, 2)
 219 # define VMG_COMPAT_GLOB_GET 1
 220 #else
 221 # define VMG_COMPAT_GLOB_GET 0
 222 #endif
 223
 224 #define VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE (VMG_HAS_PERL(5, 10, 0) && !VMG_HAS_PERL(5, 10, 1))
 225
 226 /* NewOp() isn't public in perl 5.8.0. */
 227 #define VMG_RESET_RMG_NEEDS_TRAMPOLINE (VMG_UVAR && (VMG_THREADSAFE || !VMG_HAS_PERL(5, 8, 1)))
 228
 229 /* ... Bug-free mg_magical ................................................. */
 230
 231 /* See the discussion at http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2008-01/msg00036.html */
 232
 233 #if VMG_HAS_PERL(5, 11, 3)
 234
 235 #define vmg_mg_magical(S) mg_magical(S)
 236
 237 #else
 238
 239 static void vmg_mg_magical(SV *sv) {
 240  const MAGIC *mg;
 241
 242  SvMAGICAL_off(sv);
 243  if ((mg = SvMAGIC(sv))) {
 244   do {
 245    const MGVTBL* const vtbl = mg->mg_virtual;
 246    if (vtbl) {
 247     if (vtbl->svt_get && !(mg->mg_flags & MGf_GSKIP))
 248      SvGMAGICAL_on(sv);
 249     if (vtbl->svt_set)
 250      SvSMAGICAL_on(sv);
 251     if (vtbl->svt_clear)
 252      SvRMAGICAL_on(sv);
 253    }
 254   } while ((mg = mg->mg_moremagic));
 255   if (!(SvFLAGS(sv) & (SVs_GMG|SVs_SMG)))
 256    SvRMAGICAL_on(sv);
 257  }
 258 }
 259
 260 #endif
 261
 262 /* --- Trampoline ops ------------------------------------------------------ */
 263
 264 #define VMG_NEEDS_TRAMPOLINE VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE || VMG_RESET_RMG_NEEDS_TRAMPOLINE
 265
 266 #if VMG_NEEDS_TRAMPOLINE
 267
 268 typedef struct {
 269  OP   temp;
 270  SVOP target;
 271 } vmg_trampoline;
 272
 273 static void vmg_trampoline_init(vmg_trampoline *t, OP *(*cb)(pTHX)) {
 274  t->temp.op_type    = OP_STUB;
 275  t->temp.op_ppaddr  = 0;
 276  t->temp.op_next    = (OP *) &t->target;
 277  t->temp.op_flags   = 0;
 278  t->temp.op_private = 0;
 279
 280  t->target.op_type    = OP_STUB;
 281  t->target.op_ppaddr  = cb;
 282  t->target.op_next    = NULL;
 283  t->target.op_flags   = 0;
 284  t->target.op_private = 0;
 285  t->target.op_sv      = NULL;
 286 }
 287
 288 static OP *vmg_trampoline_bump(pTHX_ vmg_trampoline *t, SV *sv, OP *o) {
 289 #define vmg_trampoline_bump(T, S, O) vmg_trampoline_bump(aTHX_ (T), (S), (O))
 290  t->temp         = *o;
 291  t->temp.op_next = (OP *) &t->target;
 292
 293  t->target.op_sv   = sv;
 294  t->target.op_next = o->op_next;
 295
 296  return &t->temp;
 297 }
 298
 299 #endif /* VMG_NEEDS_TRAMPOLINE */
 300
 301 /* --- Cleaner version of sv_magicext() ------------------------------------ */
 302
 303 static MAGIC *vmg_sv_magicext(pTHX_ SV *sv, SV *obj, const MGVTBL *vtbl, const void *ptr, I32 len) {
 304 #define vmg_sv_magicext(S, O, V, P, L) vmg_sv_magicext(aTHX_ (S), (O), (V), (P), (L))
 305  MAGIC *mg;
 306
 307  mg = sv_magicext(sv, obj, PERL_MAGIC_ext, vtbl, ptr, len);
 308  if (!mg)
 309   return NULL;
 310
 311  mg->mg_private = 0;
 312
 313  if (vtbl->svt_copy)
 314   mg->mg_flags |= MGf_COPY;
 315 #if MGf_DUP
 316  if (vtbl->svt_dup)
 317   mg->mg_flags |= MGf_DUP;
 318 #endif /* MGf_DUP */
 319 #if MGf_LOCAL
 320  if (vtbl->svt_local)
 321   mg->mg_flags |= MGf_LOCAL;
 322 #endif /* MGf_LOCAL */
 323
 324  if (mg->mg_flags & MGf_REFCOUNTED)
 325   SvREFCNT_dec(obj);
 326
 327  return mg;
 328 }
 329
 330 /* --- Safe version of call_sv() ------------------------------------------- */
 331
 332 static I32 vmg_call_sv(pTHX_ SV *sv, I32 flags, int (*cleanup)(pTHX_ void *), void *ud) {
 333 #define vmg_call_sv(S, F, C, U) vmg_call_sv(aTHX_ (S), (F), (C), (U))
 334  I32 ret;
 335  SV *old_err = NULL;
 336
 337  if (SvTRUE(ERRSV)) {
 338   old_err = newSVsv(ERRSV);
 339   sv_setsv(ERRSV, &PL_sv_undef);
 340  }
 341
 342  ret = call_sv(sv, flags | G_EVAL);
 343
 344  if (SvTRUE(ERRSV)) {
 345   SvREFCNT_dec(old_err);
 346
 347   if (IN_PERL_COMPILETIME) {
 348    if (!PL_in_eval) {
 349     if (PL_errors)
 350      sv_catsv(PL_errors, ERRSV);
 351     else
 352      Perl_warn(aTHX_ "%s", SvPV_nolen(ERRSV));
 353     SvCUR_set(ERRSV, 0);
 354    }
 355 #if VMG_HAS_PERL(5, 10, 0) || defined(PL_parser)
 356    if (PL_parser)
 357     ++PL_parser->error_count;
 358 #elif defined(PL_error_count)
 359    ++PL_error_count;
 360 #else
 361    ++PL_Ierror_count;
 362 #endif
 363   } else {
 364    if (!cleanup || cleanup(aTHX_ ud))
 365     croak(NULL);
 366   }
 367  } else {
 368   if (old_err) {
 369    sv_setsv(ERRSV, old_err);
 370    SvREFCNT_dec(old_err);
 371   }
 372  }
 373
 374  return ret;
 375 }
 376
 377 /* --- Stolen chunk of B --------------------------------------------------- */
 378
 379 typedef enum {
 380  OPc_NULL,
 381  OPc_BASEOP,
 382  OPc_UNOP,
 383  OPc_BINOP,
 384  OPc_LOGOP,
 385  OPc_LISTOP,
 386  OPc_PMOP,
 387  OPc_SVOP,
 388  OPc_PADOP,
 389  OPc_PVOP,
 390  OPc_LOOP,
 391  OPc_COP,
 392 #if VMG_HAS_PERL(5, 21, 5)
 393  OPc_METHOP,
 394 #endif
 395 #if VMG_HAS_PERL(5, 21, 7)
 396  OPc_UNOP_AUX,
 397 #endif
 398  OPc_MAX
 399 } opclass;
 400
 401 static const char *const vmg_opclassnames[] = {
 402  "B::NULL",
 403  "B::OP",
 404  "B::UNOP",
 405  "B::BINOP",
 406  "B::LOGOP",
 407  "B::LISTOP",
 408  "B::PMOP",
 409  "B::SVOP",
 410  "B::PADOP",
 411  "B::PVOP",
 412  "B::LOOP",
 413  "B::COP",
 414 #if VMG_HAS_PERL(5, 21, 5)
 415  "B::METHOP",
 416 #endif
 417 #if VMG_HAS_PERL(5, 21, 7)
 418  "B::UNOP_AUX",
 419 #endif
 420  NULL
 421 };
 422
 423 static opclass vmg_opclass(pTHX_ const OP *o) {
 424 #define vmg_opclass(O) vmg_opclass(aTHX_ (O))
 425 #if 0
 426  if (!o)
 427   return OPc_NULL;
 428 #endif
 429
 430  if (o->op_type == 0) {
 431 #if VMG_HAS_PERL(5, 21, 7)
 432   if (o->op_targ == OP_NEXTSTATE || o->op_targ == OP_DBSTATE)
 433    return OPc_COP;
 434 #endif
 435   return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
 436  }
 437
 438  if (o->op_type == OP_SASSIGN)
 439   return ((o->op_private & OPpASSIGN_BACKWARDS) ? OPc_UNOP : OPc_BINOP);
 440
 441  if (o->op_type == OP_AELEMFAST) {
 442 #if PERL_VERSION <= 14
 443   if (o->op_flags & OPf_SPECIAL)
 444    return OPc_BASEOP;
 445   else
 446 #endif
 447 #ifdef USE_ITHREADS
 448    return OPc_PADOP;
 449 #else
 450    return OPc_SVOP;
 451 #endif
 452  }
 453
 454 #ifdef USE_ITHREADS
 455  if (o->op_type == OP_GV || o->op_type == OP_GVSV || o->op_type == OP_RCATLINE)
 456   return OPc_PADOP;
 457 #endif
 458
 459  switch (OP_CLASS(o)) {
 460   case OA_BASEOP:
 461    return OPc_BASEOP;
 462   case OA_UNOP:
 463    return OPc_UNOP;
 464   case OA_BINOP:
 465    return OPc_BINOP;
 466   case OA_LOGOP:
 467    return OPc_LOGOP;
 468   case OA_LISTOP:
 469    return OPc_LISTOP;
 470   case OA_PMOP:
 471    return OPc_PMOP;
 472   case OA_SVOP:
 473    return OPc_SVOP;
 474   case OA_PADOP:
 475    return OPc_PADOP;
 476   case OA_PVOP_OR_SVOP:
 477    return (
 478 #if VMG_HAS_PERL(5, 13, 7)
 479            (o->op_type != OP_CUSTOM) &&
 480 #endif
 481            (o->op_private & (OPpTRANS_TO_UTF|OPpTRANS_FROM_UTF)))
 482 #if defined(USE_ITHREADS) && VMG_HAS_PERL(5, 8, 9)
 483            ? OPc_PADOP : OPc_PVOP;
 484 #else
 485            ? OPc_SVOP : OPc_PVOP;
 486 #endif
 487   case OA_LOOP:
 488    return OPc_LOOP;
 489   case OA_COP:
 490    return OPc_COP;
 491   case OA_BASEOP_OR_UNOP:
 492    return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
 493   case OA_FILESTATOP:
 494    return ((o->op_flags & OPf_KIDS) ? OPc_UNOP :
 495 #ifdef USE_ITHREADS
 496            (o->op_flags & OPf_REF) ? OPc_PADOP : OPc_BASEOP);
 497 #else
 498            (o->op_flags & OPf_REF) ? OPc_SVOP : OPc_BASEOP);
 499 #endif
 500   case OA_LOOPEXOP:
 501    if (o->op_flags & OPf_STACKED)
 502     return OPc_UNOP;
 503    else if (o->op_flags & OPf_SPECIAL)
 504     return OPc_BASEOP;
 505    else
 506     return OPc_PVOP;
 507 #if VMG_HAS_PERL(5, 21, 5)
 508   case OA_METHOP:
 509    return OPc_METHOP;
 510 #endif
 511 #if VMG_HAS_PERL(5, 21, 7)
 512   case OA_UNOP_AUX:
 513    return OPc_UNOP_AUX;
 514 #endif
 515  }
 516
 517  return OPc_BASEOP;
 518 }
 519
 520 /* --- Error messages ------------------------------------------------------ */
 521
 522 static const char vmg_invalid_wiz[] = "Invalid wizard object";
 523 static const char vmg_wrongargnum[] = "Wrong number of arguments";
 524
 525 /* --- Context-safe global data -------------------------------------------- */
 526
 527 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
 528
 529 typedef struct {
 530  HV             *b__op_stashes[OPc_MAX];
 531  I32             depth;
 532  MAGIC          *freed_tokens;
 533 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
 534  vmg_trampoline  propagate_errsv;
 535 #endif
 536 #if VMG_RESET_RMG_NEEDS_TRAMPOLINE
 537  vmg_trampoline  reset_rmg;
 538 #endif
 539 } my_cxt_t;
 540
 541 START_MY_CXT
 542
 543 /* --- <vmg_vtable> structure ---------------------------------------------- */
 544
 545 #if VMG_THREADSAFE
 546
 547 typedef struct {
 548  MGVTBL *vtbl;
 549  U32     refcount;
 550 } vmg_vtable;
 551
 552 static vmg_vtable *vmg_vtable_alloc(pTHX) {
 553 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
 554  vmg_vtable *t;
 555
 556  t = VOID2(vmg_vtable *, PerlMemShared_malloc(sizeof *t));
 557
 558  t->vtbl     = VOID2(MGVTBL *, PerlMemShared_malloc(sizeof *t->vtbl));
 559  t->refcount = 1;
 560
 561  return t;
 562 }
 563
 564 #define vmg_vtable_vtbl(T) (T)->vtbl
 565
 566 static perl_mutex vmg_vtable_refcount_mutex;
 567
 568 static vmg_vtable *vmg_vtable_dup(pTHX_ vmg_vtable *t) {
 569 #define vmg_vtable_dup(T) vmg_vtable_dup(aTHX_ (T))
 570  VMG_LOCK(&vmg_vtable_refcount_mutex);
 571  ++t->refcount;
 572  VMG_UNLOCK(&vmg_vtable_refcount_mutex);
 573
 574  return t;
 575 }
 576
 577 static void vmg_vtable_free(pTHX_ vmg_vtable *t) {
 578 #define vmg_vtable_free(T) vmg_vtable_free(aTHX_ (T))
 579  U32 refcount;
 580
 581  VMG_LOCK(&vmg_vtable_refcount_mutex);
 582  refcount = --t->refcount;
 583  VMG_UNLOCK(&vmg_vtable_refcount_mutex);
 584
 585  if (!refcount) {
 586   PerlMemShared_free(t->vtbl);
 587   PerlMemShared_free(t);
 588  }
 589 }
 590
 591 #else /* VMG_THREADSAFE */
 592
 593 typedef MGVTBL vmg_vtable;
 594
 595 static vmg_vtable *vmg_vtable_alloc(pTHX) {
 596 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
 597  vmg_vtable *t;
 598
 599  Newx(t, 1, vmg_vtable);
 600
 601  return t;
 602 }
 603
 604 #define vmg_vtable_vtbl(T) ((MGVTBL *) (T))
 605
 606 #define vmg_vtable_free(T) Safefree(T)
 607
 608 #endif /* !VMG_THREADSAFE */
 609
 610 /* --- <vmg_wizard> structure ---------------------------------------------- */
 611
 612 typedef struct {
 613  vmg_vtable *vtable;
 614
 615  U8 opinfo;
 616  U8 uvar;
 617
 618  SV *cb_data;
 619  SV *cb_get, *cb_set, *cb_len, *cb_clear, *cb_free;
 620  SV *cb_copy;
 621  SV *cb_dup;
 622 #if MGf_LOCAL
 623  SV *cb_local;
 624 #endif /* MGf_LOCAL */
 625 #if VMG_UVAR
 626  SV *cb_fetch, *cb_store, *cb_exists, *cb_delete;
 627 #endif /* VMG_UVAR */
 628 } vmg_wizard;
 629
 630 static void vmg_op_info_init(pTHX_ unsigned int opinfo);
 631
 632 static vmg_wizard *vmg_wizard_alloc(pTHX_ UV opinfo) {
 633 #define vmg_wizard_alloc(O) vmg_wizard_alloc(aTHX_ (O))
 634  vmg_wizard *w;
 635
 636  Newx(w, 1, vmg_wizard);
 637
 638  w->uvar   = 0;
 639  w->opinfo = (U8) ((opinfo < 255) ? opinfo : 255);
 640  if (w->opinfo)
 641   vmg_op_info_init(aTHX_ w->opinfo);
 642
 643  w->vtable = vmg_vtable_alloc();
 644
 645  return w;
 646 }
 647
 648 static void vmg_wizard_free(pTHX_ vmg_wizard *w) {
 649 #define vmg_wizard_free(W) vmg_wizard_free(aTHX_ (W))
 650  if (!w)
 651   return;
 652
 653  /* During global destruction, any of the callbacks may already have been
 654   * freed, so we can't rely on still being able to access them. */
 655  if (!PL_dirty) {
 656   SvREFCNT_dec(w->cb_data);
 657   SvREFCNT_dec(w->cb_get);
 658   SvREFCNT_dec(w->cb_set);
 659   SvREFCNT_dec(w->cb_len);
 660   SvREFCNT_dec(w->cb_clear);
 661   SvREFCNT_dec(w->cb_free);
 662   SvREFCNT_dec(w->cb_copy);
 663 #if 0
 664   SvREFCNT_dec(w->cb_dup);
 665 #endif
 666 #if MGf_LOCAL
 667   SvREFCNT_dec(w->cb_local);
 668 #endif /* MGf_LOCAL */
 669 #if VMG_UVAR
 670   SvREFCNT_dec(w->cb_fetch);
 671   SvREFCNT_dec(w->cb_store);
 672   SvREFCNT_dec(w->cb_exists);
 673   SvREFCNT_dec(w->cb_delete);
 674 #endif /* VMG_UVAR */
 675  }
 676
 677  /* PerlMemShared_free() and Safefree() are still fine during global
 678   * destruction though. */
 679  vmg_vtable_free(w->vtable);
 680  Safefree(w);
 681
 682  return;
 683 }
 684
 685 #if VMG_THREADSAFE
 686
 687 #define VMG_CLONE_CB(N) \
 688  z->cb_ ## N = (w->cb_ ## N) ? SvREFCNT_inc(sv_dup(w->cb_ ## N, params)) \
 689                              : NULL;
 690
 691 static const vmg_wizard *vmg_wizard_dup(pTHX_ const vmg_wizard *w, CLONE_PARAMS *params) {
 692 #define vmg_wizard_dup(W, P) vmg_wizard_dup(aTHX_ (W), (P))
 693  vmg_wizard *z;
 694
 695  if (!w)
 696   return NULL;
 697
 698  Newx(z, 1, vmg_wizard);
 699
 700  z->vtable = vmg_vtable_dup(w->vtable);
 701  z->uvar   = w->uvar;
 702  z->opinfo = w->opinfo;
 703
 704  VMG_CLONE_CB(data);
 705  VMG_CLONE_CB(get);
 706  VMG_CLONE_CB(set);
 707  VMG_CLONE_CB(len);
 708  VMG_CLONE_CB(clear);
 709  VMG_CLONE_CB(free);
 710  VMG_CLONE_CB(copy);
 711  VMG_CLONE_CB(dup);
 712 #if MGf_LOCAL
 713  VMG_CLONE_CB(local);
 714 #endif /* MGf_LOCAL */
 715 #if VMG_UVAR
 716  VMG_CLONE_CB(fetch);
 717  VMG_CLONE_CB(store);
 718  VMG_CLONE_CB(exists);
 719  VMG_CLONE_CB(delete);
 720 #endif /* VMG_UVAR */
 721
 722  return z;
 723 }
 724
 725 #endif /* VMG_THREADSAFE */
 726
 727 #define vmg_wizard_id(W) PTR2IV(vmg_vtable_vtbl((W)->vtable))
 728
 729 /* --- Wizard SV objects --------------------------------------------------- */
 730
 731 static int vmg_wizard_sv_free(pTHX_ SV *sv, MAGIC *mg) {
 732  vmg_wizard_free((vmg_wizard *) mg->mg_ptr);
 733
 734  return 0;
 735 }
 736
 737 #if VMG_THREADSAFE
 738
 739 static int vmg_wizard_sv_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *params) {
 740  mg->mg_ptr = (char *) vmg_wizard_dup((const vmg_wizard *) mg->mg_ptr, params);
 741
 742  return 0;
 743 }
 744
 745 #endif /* VMG_THREADSAFE */
 746
 747 static MGVTBL vmg_wizard_sv_vtbl = {
 748  NULL,               /* get */
 749  NULL,               /* set */
 750  NULL,               /* len */
 751  NULL,               /* clear */
 752  vmg_wizard_sv_free, /* free */
 753  NULL,               /* copy */
 754 #if VMG_THREADSAFE
 755  vmg_wizard_sv_dup,  /* dup */
 756 #else
 757  NULL,               /* dup */
 758 #endif
 759 #if MGf_LOCAL
 760  NULL,               /* local */
 761 #endif /* MGf_LOCAL */
 762 };
 763
 764 static SV *vmg_wizard_sv_new(pTHX_ const vmg_wizard *w) {
 765 #define vmg_wizard_sv_new(W) vmg_wizard_sv_new(aTHX_ (W))
 766  SV *wiz;
 767
 768 #if VMG_THREADSAFE
 769  wiz = newSV(0);
 770 #else
 771  wiz = newSViv(PTR2IV(w));
 772 #endif
 773
 774  vmg_sv_magicext(wiz, NULL, &vmg_wizard_sv_vtbl, w, 0);
 775
 776  SvREADONLY_on(wiz);
 777
 778  return wiz;
 779 }
 780
 781 #if VMG_THREADSAFE
 782
 783 #define vmg_sv_has_wizard_type(S) (SvTYPE(S) >= SVt_PVMG)
 784
 785 static const vmg_wizard *vmg_wizard_from_sv_nocheck(const SV *wiz) {
 786  MAGIC *mg;
 787
 788  for (mg = SvMAGIC(wiz); mg; mg = mg->mg_moremagic) {
 789   if (mg->mg_type == PERL_MAGIC_ext && mg->mg_virtual == &vmg_wizard_sv_vtbl)
 790    return (const vmg_wizard *) mg->mg_ptr;
 791  }
 792
 793  return NULL;
 794 }
 795
 796 #else /* VMG_THREADSAFE */
 797
 798 #define vmg_sv_has_wizard_type(S) SvIOK(S)
 799
 800 #define vmg_wizard_from_sv_nocheck(W) INT2PTR(const vmg_wizard *, SvIVX(W))
 801
 802 #endif /* !VMG_THREADSAFE */
 803
 804 #define vmg_wizard_from_sv(W) (vmg_sv_has_wizard_type(W) ? vmg_wizard_from_sv_nocheck(W) : NULL)
 805
 806 static const vmg_wizard *vmg_wizard_from_mg(const MAGIC *mg) {
 807  if (mg->mg_type == PERL_MAGIC_ext && mg->mg_len == HEf_SVKEY) {
 808   SV *sv = (SV *) mg->mg_ptr;
 809
 810   if (vmg_sv_has_wizard_type(sv))
 811    return vmg_wizard_from_sv_nocheck(sv);
 812  }
 813
 814  return NULL;
 815 }
 816
 817 #define vmg_wizard_from_mg_nocheck(M) vmg_wizard_from_sv_nocheck((const SV *) (M)->mg_ptr)
 818
 819 /* --- User-level functions implementation --------------------------------- */
 820
 821 static const MAGIC *vmg_find(const SV *sv, const vmg_wizard *w) {
 822  const MAGIC *mg;
 823  IV wid;
 824
 825  if (SvTYPE(sv) < SVt_PVMG)
 826   return NULL;
 827
 828  wid = vmg_wizard_id(w);
 829
 830  for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
 831   const vmg_wizard *z = vmg_wizard_from_mg(mg);
 832
 833   if (z && vmg_wizard_id(z) == wid)
 834    return mg;
 835  }
 836
 837  return NULL;
 838 }
 839
 840 /* ... Construct private data .............................................. */
 841
 842 static SV *vmg_data_new(pTHX_ SV *ctor, SV *sv, SV **args, I32 items) {
 843 #define vmg_data_new(C, S, A, I) vmg_data_new(aTHX_ (C), (S), (A), (I))
 844  I32 i;
 845  SV *nsv;
 846
 847  dSP;
 848
 849  ENTER;
 850  SAVETMPS;
 851
 852  PUSHSTACKi(PERLSI_MAGIC);
 853
 854  PUSHMARK(SP);
 855  EXTEND(SP, items + 1);
 856  PUSHs(sv_2mortal(newRV_inc(sv)));
 857  for (i = 0; i < items; ++i)
 858   PUSHs(args[i]);
 859  PUTBACK;
 860
 861  vmg_call_sv(ctor, G_SCALAR, 0, NULL);
 862
 863  SPAGAIN;
 864  nsv = POPs;
 865 #if VMG_HAS_PERL(5, 8, 3)
 866  SvREFCNT_inc_simple_void(nsv); /* Or it will be destroyed in FREETMPS */
 867 #else
 868  nsv = sv_newref(nsv);          /* Workaround some bug in SvREFCNT_inc() */
 869 #endif
 870  PUTBACK;
 871
 872  POPSTACK;
 873
 874  FREETMPS;
 875  LEAVE;
 876
 877  return nsv;
 878 }
 879
 880 static SV *vmg_data_get(pTHX_ SV *sv, const vmg_wizard *w) {
 881 #define vmg_data_get(S, W) vmg_data_get(aTHX_ (S), (W))
 882  const MAGIC *mg = vmg_find(sv, w);
 883
 884  return mg ? mg->mg_obj : NULL;
 885 }
 886
 887 /* ... Magic cast/dispell .................................................. */
 888
 889 #if VMG_UVAR
 890
 891 static I32 vmg_svt_val(pTHX_ IV, SV *);
 892
 893 typedef struct {
 894  struct ufuncs new_uf;
 895  struct ufuncs old_uf;
 896 } vmg_uvar_ud;
 897
 898 #endif /* VMG_UVAR */
 899
 900 static void vmg_mg_del(pTHX_ SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
 901 #define vmg_mg_del(S, P, M, N) vmg_mg_del(aTHX_ (S), (P), (M), (N))
 902  dMY_CXT;
 903
 904  if (prevmagic)
 905   prevmagic->mg_moremagic = moremagic;
 906  else
 907   SvMAGIC_set(sv, moremagic);
 908
 909  /* Destroy private data */
 910 #if VMG_UVAR
 911  if (mg->mg_type == PERL_MAGIC_uvar) {
 912   Safefree(mg->mg_ptr);
 913  } else {
 914 #endif /* VMG_UVAR */
 915   if (mg->mg_obj != sv) {
 916    SvREFCNT_dec(mg->mg_obj);
 917    mg->mg_obj = NULL;
 918   }
 919   /* Unreference the wizard */
 920   SvREFCNT_dec((SV *) mg->mg_ptr);
 921   mg->mg_ptr = NULL;
 922 #if VMG_UVAR
 923  }
 924 #endif /* VMG_UVAR */
 925
 926  if (MY_CXT.depth) {
 927   mg->mg_moremagic    = MY_CXT.freed_tokens;
 928   MY_CXT.freed_tokens = mg;
 929  } else {
 930   mg->mg_moremagic = NULL;
 931   Safefree(mg);
 932  }
 933 }
 934
 935 static int vmg_magic_chain_free(pTHX_ MAGIC *mg, MAGIC *skip) {
 936 #define vmg_magic_chain_free(M, S) vmg_magic_chain_free(aTHX_ (M), (S))
 937  int skipped = 0;
 938
 939  while (mg) {
 940   MAGIC *moremagic = mg->mg_moremagic;
 941
 942   if (mg == skip)
 943    ++skipped;
 944   else
 945    Safefree(mg);
 946
 947   mg = moremagic;
 948  }
 949
 950  return skipped;
 951 }
 952
 953 static UV vmg_cast(pTHX_ SV *sv, const vmg_wizard *w, const SV *wiz, SV **args, I32 items) {
 954 #define vmg_cast(S, W, WIZ, A, I) vmg_cast(aTHX_ (S), (W), (WIZ), (A), (I))
 955  MAGIC  *mg;
 956  MGVTBL *t;
 957  SV     *data;
 958  U32     oldgmg;
 959
 960  if (vmg_find(sv, w))
 961   return 1;
 962
 963  oldgmg = SvGMAGICAL(sv);
 964
 965  data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args, items) : NULL;
 966
 967  t  = vmg_vtable_vtbl(w->vtable);
 968  mg = vmg_sv_magicext(sv, data, t, wiz, HEf_SVKEY);
 969
 970  if (SvTYPE(sv) < SVt_PVHV)
 971   goto done;
 972
 973  /* The GMAGICAL flag only says that a hash is tied or has uvar magic - get
 974   * magic is actually never called for them. If the GMAGICAL flag was off before
 975   * calling sv_magicext(), the hash isn't tied and has no uvar magic. If it's
 976   * now on, then this wizard has get magic. Hence we can work around the
 977   * get/clear shortcoming by turning the GMAGICAL flag off. If the current magic
 978   * has uvar callbacks, it will be turned back on later. */
 979  if (!oldgmg && SvGMAGICAL(sv))
 980   SvGMAGICAL_off(sv);
 981
 982 #if VMG_UVAR
 983  if (w->uvar) {
 984   MAGIC *prevmagic, *moremagic = NULL;
 985   vmg_uvar_ud ud;
 986
 987   ud.new_uf.uf_val   = vmg_svt_val;
 988   ud.new_uf.uf_set   = NULL;
 989   ud.new_uf.uf_index = 0;
 990   ud.old_uf.uf_val   = NULL;
 991   ud.old_uf.uf_set   = NULL;
 992   ud.old_uf.uf_index = 0;
 993
 994   /* One uvar magic in the chain is enough. */
 995   for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
 996    moremagic = mg->mg_moremagic;
 997    if (mg->mg_type == PERL_MAGIC_uvar)
 998     break;
 999   }
1000
1001   if (mg) { /* Found another uvar magic. */
1002    struct ufuncs *uf = (struct ufuncs *) mg->mg_ptr;
1003    if (uf->uf_val == vmg_svt_val) {
1004     /* It's our uvar magic, nothing to do. oldgmg was true. */
1005     goto done;
1006    } else {
1007     /* It's another uvar magic, backup it and replace it by ours. */
1008     ud.old_uf = *uf;
1009     vmg_mg_del(sv, prevmagic, mg, moremagic);
1010    }
1011   }
1012
1013   sv_magic(sv, NULL, PERL_MAGIC_uvar, (const char *) &ud, sizeof(ud));
1014   vmg_mg_magical(sv);
1015   /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
1016    * handled by our uvar callback. */
1017  }
1018 #endif /* VMG_UVAR */
1019
1020 done:
1021  return 1;
1022 }
1023
1024 static UV vmg_dispell(pTHX_ SV *sv, const vmg_wizard *w) {
1025 #define vmg_dispell(S, W) vmg_dispell(aTHX_ (S), (W))
1026 #if VMG_UVAR
1027  U32 uvars = 0;
1028 #endif /* VMG_UVAR */
1029  MAGIC *mg, *prevmagic, *moremagic = NULL;
1030  IV wid = vmg_wizard_id(w);
1031
1032  if (SvTYPE(sv) < SVt_PVMG)
1033   return 0;
1034
1035  for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
1036   const vmg_wizard *z;
1037
1038   moremagic = mg->mg_moremagic;
1039
1040   z = vmg_wizard_from_mg(mg);
1041   if (z) {
1042    IV zid = vmg_wizard_id(z);
1043
1044 #if VMG_UVAR
1045    if (zid == wid) {
1046     /* If the current has no uvar, short-circuit uvar deletion. */
1047     uvars = z->uvar ? (uvars + 1) : 0;
1048     break;
1049    } else if (z->uvar) {
1050     ++uvars;
1051     /* We can't break here since we need to find the ext magic to delete. */
1052    }
1053 #else /* VMG_UVAR */
1054    if (zid == wid)
1055     break;
1056 #endif /* !VMG_UVAR */
1057   }
1058  }
1059  if (!mg)
1060   return 0;
1061
1062  vmg_mg_del(sv, prevmagic, mg, moremagic);
1063
1064 #if VMG_UVAR
1065  if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
1066   /* mg was the first ext magic in the chain that had uvar */
1067
1068   for (mg = moremagic; mg; mg = mg->mg_moremagic) {
1069    const vmg_wizard *z = vmg_wizard_from_mg(mg);
1070
1071    if (z && z->uvar) {
1072     ++uvars;
1073     break;
1074    }
1075   }
1076
1077   if (uvars == 1) {
1078    vmg_uvar_ud *ud;
1079
1080    for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
1081     moremagic = mg->mg_moremagic;
1082     if (mg->mg_type == PERL_MAGIC_uvar)
1083      break;
1084    }
1085
1086    ud = (vmg_uvar_ud *) mg->mg_ptr;
1087    if (ud->old_uf.uf_val || ud->old_uf.uf_set) {
1088     /* Revert the original uvar magic. */
1089     struct ufuncs *uf;
1090     Newx(uf, 1, struct ufuncs);
1091     *uf = ud->old_uf;
1092     Safefree(ud);
1093     mg->mg_ptr = (char *) uf;
1094     mg->mg_len = sizeof(*uf);
1095    } else {
1096     /* Remove the uvar magic. */
1097     vmg_mg_del(sv, prevmagic, mg, moremagic);
1098    }
1099   }
1100  }
1101 #endif /* VMG_UVAR */
1102
1103  vmg_mg_magical(sv);
1104
1105  return 1;
1106 }
1107
1108 /* ... OP info ............................................................. */
1109
1110 #define VMG_OP_INFO_NAME   1
1111 #define VMG_OP_INFO_OBJECT 2
1112
1113 #if VMG_THREADSAFE
1114 static perl_mutex vmg_op_name_init_mutex;
1115 #endif
1116
1117 static U32           vmg_op_name_init      = 0;
1118 static unsigned char vmg_op_name_len[MAXO] = { 0 };
1119
1120 static void vmg_op_info_init(pTHX_ unsigned int opinfo) {
1121 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
1122  switch (opinfo) {
1123   case VMG_OP_INFO_NAME:
1124    VMG_LOCK(&vmg_op_name_init_mutex);
1125    if (!vmg_op_name_init) {
1126     OPCODE t;
1127     for (t = 0; t < OP_max; ++t)
1128      vmg_op_name_len[t] = strlen(PL_op_name[t]);
1129     vmg_op_name_init = 1;
1130    }
1131    VMG_UNLOCK(&vmg_op_name_init_mutex);
1132    break;
1133   case VMG_OP_INFO_OBJECT: {
1134    dMY_CXT;
1135    if (!MY_CXT.b__op_stashes[0]) {
1136     int c;
1137     require_pv("B.pm");
1138     for (c = OPc_NULL; c < OPc_MAX; ++c)
1139      MY_CXT.b__op_stashes[c] = gv_stashpv(vmg_opclassnames[c], 1);
1140    }
1141    break;
1142   }
1143   default:
1144    break;
1145  }
1146 }
1147
1148 static SV *vmg_op_info(pTHX_ unsigned int opinfo) {
1149 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
1150  if (!PL_op)
1151   return &PL_sv_undef;
1152
1153  switch (opinfo) {
1154   case VMG_OP_INFO_NAME: {
1155    const char *name;
1156    STRLEN      name_len;
1157    OPCODE      t = PL_op->op_type;
1158    name     = OP_NAME(PL_op);
1159    name_len = (t == OP_CUSTOM) ? strlen(name) : vmg_op_name_len[t];
1160    return sv_2mortal(newSVpvn(name, name_len));
1161   }
1162   case VMG_OP_INFO_OBJECT: {
1163    dMY_CXT;
1164    return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
1165                    MY_CXT.b__op_stashes[vmg_opclass(PL_op)]);
1166   }
1167   default:
1168    break;
1169  }
1170
1171  return &PL_sv_undef;
1172 }
1173
1174 /* --- svt callbacks ------------------------------------------------------- */
1175
1176 #define VMG_CB_CALL_ARGS_MASK  15
1177 #define VMG_CB_CALL_ARGS_SHIFT 4
1178 #define VMG_CB_CALL_OPINFO     (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT) /* 1|2 */
1179 #define VMG_CB_CALL_GUARD      4
1180
1181 static int vmg_dispell_guard_oncroak(pTHX_ void *ud) {
1182  dMY_CXT;
1183
1184  MY_CXT.depth--;
1185
1186  /* If we're at the upmost magic call and we're about to die, we can just free
1187   * the tokens right now, since we will jump past the problematic part of our
1188   * caller. */
1189  if (MY_CXT.depth == 0 && MY_CXT.freed_tokens) {
1190   vmg_magic_chain_free(MY_CXT.freed_tokens, NULL);
1191   MY_CXT.freed_tokens = NULL;
1192  }
1193
1194  return 1;
1195 }
1196
1197 static int vmg_dispell_guard_free(pTHX_ SV *sv, MAGIC *mg) {
1198  vmg_magic_chain_free((MAGIC *) mg->mg_ptr, NULL);
1199
1200  return 0;
1201 }
1202
1203 #if VMG_THREADSAFE
1204
1205 static int vmg_dispell_guard_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *params) {
1206  /* The freed magic tokens aren't cloned by perl because it cannot reach them
1207   * (they have been detached from their parent SV when they were enqueued).
1208   * Hence there's nothing to purge in the new thread. */
1209  mg->mg_ptr = NULL;
1210
1211  return 0;
1212 }
1213
1214 #endif /* VMG_THREADSAFE */
1215
1216 static MGVTBL vmg_dispell_guard_vtbl = {
1217  NULL,                   /* get */
1218  NULL,                   /* set */
1219  NULL,                   /* len */
1220  NULL,                   /* clear */
1221  vmg_dispell_guard_free, /* free */
1222  NULL,                   /* copy */
1223 #if VMG_THREADSAFE
1224  vmg_dispell_guard_dup,  /* dup */
1225 #else
1226  NULL,                   /* dup */
1227 #endif
1228 #if MGf_LOCAL
1229  NULL,                   /* local */
1230 #endif /* MGf_LOCAL */
1231 };
1232
1233 static SV *vmg_dispell_guard_new(pTHX_ MAGIC *root) {
1234 #define vmg_dispell_guard_new(R) vmg_dispell_guard_new(aTHX_ (R))
1235  SV *guard;
1236
1237  guard = sv_newmortal();
1238  vmg_sv_magicext(guard, NULL, &vmg_dispell_guard_vtbl, root, 0);
1239
1240  return guard;
1241 }
1242
1243 static int vmg_cb_call(pTHX_ SV *cb, unsigned int flags, SV *sv, ...) {
1244  va_list ap;
1245  int ret = 0;
1246  unsigned int i, args, opinfo;
1247  MAGIC **chain = NULL;
1248  SV *svr;
1249
1250  dSP;
1251
1252  args    = flags & VMG_CB_CALL_ARGS_MASK;
1253  flags >>= VMG_CB_CALL_ARGS_SHIFT;
1254  opinfo  = flags & VMG_CB_CALL_OPINFO;
1255
1256  ENTER;
1257  SAVETMPS;
1258
1259  PUSHSTACKi(PERLSI_MAGIC);
1260
1261  PUSHMARK(SP);
1262  EXTEND(SP, args + 1);
1263  PUSHs(sv_2mortal(newRV_inc(sv)));
1264  va_start(ap, sv);
1265  for (i = 0; i < args; ++i) {
1266   SV *sva = va_arg(ap, SV *);
1267   PUSHs(sva ? sva : &PL_sv_undef);
1268  }
1269  va_end(ap);
1270  if (opinfo)
1271   XPUSHs(vmg_op_info(opinfo));
1272  PUTBACK;
1273
1274  if (flags & VMG_CB_CALL_GUARD) {
1275   dMY_CXT;
1276   MY_CXT.depth++;
1277   vmg_call_sv(cb, G_SCALAR, vmg_dispell_guard_oncroak, NULL);
1278   MY_CXT.depth--;
1279   if (MY_CXT.depth == 0 && MY_CXT.freed_tokens)
1280    chain = &MY_CXT.freed_tokens;
1281  } else {
1282   vmg_call_sv(cb, G_SCALAR, 0, NULL);
1283  }
1284
1285  SPAGAIN;
1286  svr = POPs;
1287  if (SvOK(svr))
1288   ret = (int) SvIV(svr);
1289  if (SvROK(svr))
1290   SvREFCNT_inc(svr);
1291  else
1292   svr = NULL;
1293  PUTBACK;
1294
1295  POPSTACK;
1296
1297  FREETMPS;
1298  LEAVE;
1299
1300  if (svr && !SvTEMP(svr))
1301   sv_2mortal(svr);
1302
1303  if (chain) {
1304   vmg_dispell_guard_new(*chain);
1305   *chain = NULL;
1306  }
1307
1308  return ret;
1309 }
1310
1311 #define VMG_CB_FLAGS(OI, A) \
1312         ((((unsigned int) (OI)) << VMG_CB_CALL_ARGS_SHIFT) | (A))
1313
1314 #define vmg_cb_call1(I, OI, S, A1) \
1315         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 1), (S), (A1))
1316 #define vmg_cb_call2(I, OI, S, A1, A2) \
1317         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 2), (S), (A1), (A2))
1318 #define vmg_cb_call3(I, OI, S, A1, A2, A3) \
1319         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 3), (S), (A1), (A2), (A3))
1320
1321 /* ... Default no-op magic callback ........................................ */
1322
1323 static int vmg_svt_default_noop(pTHX_ SV *sv, MAGIC *mg) {
1324  return 0;
1325 }
1326
1327 /* ... get magic ........................................................... */
1328
1329 static int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
1330  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1331
1332  return vmg_cb_call1(w->cb_get, w->opinfo, sv, mg->mg_obj);
1333 }
1334
1335 #define vmg_svt_get_noop vmg_svt_default_noop
1336
1337 /* ... set magic ........................................................... */
1338
1339 static int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
1340  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1341
1342  return vmg_cb_call1(w->cb_set, w->opinfo, sv, mg->mg_obj);
1343 }
1344
1345 #define vmg_svt_set_noop vmg_svt_default_noop
1346
1347 /* ... len magic ........................................................... */
1348
1349 static U32 vmg_sv_len(pTHX_ SV *sv) {
1350 #define vmg_sv_len(S) vmg_sv_len(aTHX_ (S))
1351  STRLEN len;
1352 #if VMG_HAS_PERL(5, 9, 3)
1353  const U8 *s = VOID2(const U8 *, VOID2(const void *, SvPV_const(sv, len)));
1354 #else
1355  U8 *s = SvPV(sv, len);
1356 #endif
1357
1358  return DO_UTF8(sv) ? utf8_length(s, s + len) : len;
1359 }
1360
1361 static U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
1362  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1363  unsigned int opinfo = w->opinfo;
1364  U32 len, ret;
1365  SV *svr;
1366  svtype t = SvTYPE(sv);
1367
1368  dSP;
1369
1370  ENTER;
1371  SAVETMPS;
1372
1373  PUSHSTACKi(PERLSI_MAGIC);
1374
1375  PUSHMARK(SP);
1376  EXTEND(SP, 3);
1377  PUSHs(sv_2mortal(newRV_inc(sv)));
1378  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1379  if (t < SVt_PVAV) {
1380   len = vmg_sv_len(sv);
1381   mPUSHu(len);
1382  } else if (t == SVt_PVAV) {
1383   len = av_len((AV *) sv) + 1;
1384   mPUSHu(len);
1385  } else {
1386   len = 0;
1387   PUSHs(&PL_sv_undef);
1388  }
1389  if (opinfo)
1390   XPUSHs(vmg_op_info(opinfo));
1391  PUTBACK;
1392
1393  vmg_call_sv(w->cb_len, G_SCALAR, 0, NULL);
1394
1395  SPAGAIN;
1396  svr = POPs;
1397  ret = SvOK(svr) ? (U32) SvUV(svr) : len;
1398  if (t == SVt_PVAV)
1399   --ret;
1400  PUTBACK;
1401
1402  POPSTACK;
1403
1404  FREETMPS;
1405  LEAVE;
1406
1407  return ret;
1408 }
1409
1410 static U32 vmg_svt_len_noop(pTHX_ SV *sv, MAGIC *mg) {
1411  U32    len = 0;
1412  svtype t   = SvTYPE(sv);
1413
1414  if (t < SVt_PVAV) {
1415   len = vmg_sv_len(sv);
1416  } else if (t == SVt_PVAV) {
1417   len = (U32) av_len((AV *) sv);
1418  }
1419
1420  return len;
1421 }
1422
1423 /* ... clear magic ......................................................... */
1424
1425 static int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
1426  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1427  unsigned int flags  = w->opinfo;
1428
1429 #if !VMG_HAS_PERL(5, 12, 0)
1430  flags |= VMG_CB_CALL_GUARD;
1431 #endif
1432
1433  return vmg_cb_call1(w->cb_clear, flags, sv, mg->mg_obj);
1434 }
1435
1436 #define vmg_svt_clear_noop vmg_svt_default_noop
1437
1438 /* ... free magic .......................................................... */
1439
1440 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
1441
1442 static OP *vmg_pp_propagate_errsv(pTHX) {
1443  SVOP *o = cSVOPx(PL_op);
1444
1445  if (o->op_sv) {
1446   sv_setsv(ERRSV, o->op_sv);
1447   SvREFCNT_dec(o->op_sv);
1448   o->op_sv = NULL;
1449  }
1450
1451  return NORMAL;
1452 }
1453
1454 #endif /* VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE */
1455
1456 static int vmg_propagate_errsv_free(pTHX_ SV *sv, MAGIC *mg) {
1457  if (mg->mg_obj)
1458   sv_setsv(ERRSV, mg->mg_obj);
1459
1460  return 0;
1461 }
1462
1463 /* perl is already kind enough to handle the cloning of the mg_obj member,
1464    hence we don't need to define a dup magic callback. */
1465
1466 static MGVTBL vmg_propagate_errsv_vtbl = {
1467  0,                        /* get */
1468  0,                        /* set */
1469  0,                        /* len */
1470  0,                        /* clear */
1471  vmg_propagate_errsv_free, /* free */
1472  0,                        /* copy */
1473  0,                        /* dup */
1474 #if MGf_LOCAL
1475  0,                        /* local */
1476 #endif /* MGf_LOCAL */
1477 };
1478
1479 typedef struct {
1480  SV  *sv;
1481  int  in_eval;
1482  I32  base;
1483 } vmg_svt_free_cleanup_ud;
1484
1485 static int vmg_svt_free_cleanup(pTHX_ void *ud_) {
1486  vmg_svt_free_cleanup_ud *ud = VOID2(vmg_svt_free_cleanup_ud *, ud_);
1487
1488  if (ud->in_eval) {
1489   U32 optype = PL_op ? PL_op->op_type : OP_NULL;
1490
1491   if (optype == OP_LEAVETRY || optype == OP_LEAVEEVAL) {
1492    SV *errsv = newSVsv(ERRSV);
1493
1494    FREETMPS;
1495    LEAVE_SCOPE(ud->base);
1496
1497 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
1498    if (optype == OP_LEAVETRY) {
1499     dMY_CXT;
1500     PL_op = vmg_trampoline_bump(&MY_CXT.propagate_errsv, errsv, PL_op);
1501    } else if (optype == OP_LEAVEEVAL) {
1502     SV *guard = sv_newmortal();
1503     vmg_sv_magicext(guard, errsv, &vmg_propagate_errsv_vtbl, NULL, 0);
1504    }
1505 #else /* !VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE */
1506 # if !VMG_HAS_PERL(5, 8, 9)
1507    {
1508     SV *guard = sv_newmortal();
1509     vmg_sv_magicext(guard, errsv, &vmg_propagate_errsv_vtbl, NULL, 0);
1510    }
1511 # else
1512    vmg_sv_magicext(ERRSV, errsv, &vmg_propagate_errsv_vtbl, NULL, 0);
1513 # endif
1514 #endif /* VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE */
1515
1516    SAVETMPS;
1517   }
1518
1519   /* Don't propagate */
1520   return 0;
1521  } else {
1522   SV    *sv = ud->sv;
1523   MAGIC *mg;
1524
1525   /* We are about to croak() while sv is being destroyed. Try to clean up
1526    * things a bit. */
1527   mg = SvMAGIC(sv);
1528   if (mg) {
1529    vmg_mg_del(sv, NULL, mg, mg->mg_moremagic);
1530    mg_magical(sv);
1531   }
1532   SvREFCNT_dec(sv);
1533
1534   vmg_dispell_guard_oncroak(aTHX_ NULL);
1535
1536   /* After that, propagate the error upwards. */
1537   return 1;
1538  }
1539 }
1540
1541 static int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
1542  vmg_svt_free_cleanup_ud ud;
1543  const vmg_wizard *w;
1544  int ret = 0;
1545  SV *svr;
1546
1547  dSP;
1548
1549  /* During global destruction, we cannot be sure that the wizard and its free
1550   * callback are still alive. */
1551  if (PL_dirty)
1552   return 0;
1553
1554  w = vmg_wizard_from_mg_nocheck(mg);
1555
1556  /* So that it survives the temp cleanup below */
1557  SvREFCNT_inc_simple_void(sv);
1558
1559 #if !(VMG_HAS_PERL_MAINT(5, 11, 0, 32686) || VMG_HAS_PERL(5, 12, 0))
1560  /* The previous magic tokens were freed but the magic chain wasn't updated, so
1561   * if you access the sv from the callback the old deleted magics will trigger
1562   * and cause memory misreads. Change 32686 solved it that way : */
1563  SvMAGIC_set(sv, mg);
1564 #endif
1565
1566  ud.sv = sv;
1567  if (cxstack_ix < cxstack_max) {
1568   ud.in_eval = (CxTYPE(cxstack + cxstack_ix + 1) == CXt_EVAL);
1569   ud.base    = ud.in_eval ? PL_scopestack[PL_scopestack_ix] : 0;
1570  } else {
1571   ud.in_eval = 0;
1572   ud.base    = 0;
1573  }
1574
1575  ENTER;
1576  SAVETMPS;
1577
1578  PUSHSTACKi(PERLSI_MAGIC);
1579
1580  PUSHMARK(SP);
1581  EXTEND(SP, 2);
1582  PUSHs(sv_2mortal(newRV_inc(sv)));
1583  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1584  if (w->opinfo)
1585   XPUSHs(vmg_op_info(w->opinfo));
1586  PUTBACK;
1587
1588  {
1589   dMY_CXT;
1590   MY_CXT.depth++;
1591   vmg_call_sv(w->cb_free, G_SCALAR, vmg_svt_free_cleanup, &ud);
1592   MY_CXT.depth--;
1593   if (MY_CXT.depth == 0 && MY_CXT.freed_tokens) {
1594    /* Free all the tokens in the chain but the current one (if it's present).
1595     * It will be taken care of by our caller, Perl_mg_free(). */
1596    vmg_magic_chain_free(MY_CXT.freed_tokens, mg);
1597    MY_CXT.freed_tokens = NULL;
1598   }
1599  }
1600
1601  SPAGAIN;
1602  svr = POPs;
1603  if (SvOK(svr))
1604   ret = (int) SvIV(svr);
1605  PUTBACK;
1606
1607  POPSTACK;
1608
1609  FREETMPS;
1610  LEAVE;
1611
1612  /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
1613   * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
1614  --SvREFCNT(sv);
1615
1616  /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
1617   * mg->mg_ptr reference count */
1618  return ret;
1619 }
1620
1621 #define vmg_svt_free_noop vmg_svt_default_noop
1622
1623 #if VMG_HAS_PERL_MAINT(5, 11, 0, 33256) || VMG_HAS_PERL(5, 12, 0)
1624 # define VMG_SVT_COPY_KEYLEN_TYPE I32
1625 #else
1626 # define VMG_SVT_COPY_KEYLEN_TYPE int
1627 #endif
1628
1629 /* ... copy magic .......................................................... */
1630
1631 static int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key, VMG_SVT_COPY_KEYLEN_TYPE keylen) {
1632  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1633  SV *keysv;
1634  int ret;
1635
1636  if (keylen == HEf_SVKEY) {
1637   keysv = (SV *) key;
1638  } else {
1639   keysv = newSVpvn(key, keylen);
1640  }
1641
1642  if (SvTYPE(sv) >= SVt_PVCV)
1643   nsv = sv_2mortal(newRV_inc(nsv));
1644
1645  ret = vmg_cb_call3(w->cb_copy, w->opinfo, sv, mg->mg_obj, keysv, nsv);
1646
1647  if (keylen != HEf_SVKEY) {
1648   SvREFCNT_dec(keysv);
1649  }
1650
1651  return ret;
1652 }
1653
1654 static int vmg_svt_copy_noop(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key, VMG_SVT_COPY_KEYLEN_TYPE keylen) {
1655  return 0;
1656 }
1657
1658 /* ... dup magic ........................................................... */
1659
1660 #if 0
1661 static int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
1662  return 0;
1663 }
1664 #define vmg_svt_dup_noop vmg_svt_dup
1665 #endif
1666
1667 /* ... local magic ......................................................... */
1668
1669 #if MGf_LOCAL
1670
1671 static int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
1672  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1673
1674  return vmg_cb_call1(w->cb_local, w->opinfo, nsv, mg->mg_obj);
1675 }
1676
1677 #define vmg_svt_local_noop vmg_svt_default_noop
1678
1679 #endif /* MGf_LOCAL */
1680
1681 /* ... uvar magic .......................................................... */
1682
1683 #if VMG_UVAR
1684
1685 static OP *vmg_pp_reset_rmg(pTHX) {
1686  SVOP *o = cSVOPx(PL_op);
1687
1688  SvRMAGICAL_on(o->op_sv);
1689  o->op_sv = NULL;
1690
1691  return NORMAL;
1692 }
1693
1694 static I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
1695  vmg_uvar_ud *ud;
1696  MAGIC *mg, *umg, *moremagic;
1697  SV *key = NULL, *newkey = NULL;
1698  int tied = 0;
1699
1700  umg = mg_find(sv, PERL_MAGIC_uvar);
1701  /* umg can't be NULL or we wouldn't be there. */
1702  key = umg->mg_obj;
1703  ud  = (vmg_uvar_ud *) umg->mg_ptr;
1704
1705  if (ud->old_uf.uf_val)
1706   ud->old_uf.uf_val(aTHX_ action, sv);
1707  if (ud->old_uf.uf_set)
1708   ud->old_uf.uf_set(aTHX_ action, sv);
1709
1710  for (mg = SvMAGIC(sv); mg; mg = moremagic) {
1711   const vmg_wizard *w;
1712
1713   /* mg may be freed later by the uvar call, so we need to fetch the next
1714    * token before reaching that fateful point. */
1715   moremagic = mg->mg_moremagic;
1716
1717   switch (mg->mg_type) {
1718    case PERL_MAGIC_ext:
1719     break;
1720    case PERL_MAGIC_tied:
1721     ++tied;
1722     continue;
1723    default:
1724     continue;
1725   }
1726
1727   w = vmg_wizard_from_mg(mg);
1728   if (!w)
1729    continue;
1730
1731   switch (w->uvar) {
1732    case 0:
1733     continue;
1734    case 2:
1735     if (!newkey)
1736      newkey = key = umg->mg_obj = sv_mortalcopy(umg->mg_obj);
1737   }
1738
1739   switch (action
1740              & (HV_FETCH_ISSTORE|HV_FETCH_ISEXISTS|HV_FETCH_LVALUE|HV_DELETE)) {
1741    case 0:
1742     if (w->cb_fetch)
1743      vmg_cb_call2(w->cb_fetch, w->opinfo | VMG_CB_CALL_GUARD, sv,
1744                                mg->mg_obj, key);
1745     break;
1746    case HV_FETCH_ISSTORE:
1747    case HV_FETCH_LVALUE:
1748    case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
1749     if (w->cb_store)
1750      vmg_cb_call2(w->cb_store, w->opinfo | VMG_CB_CALL_GUARD, sv,
1751                                mg->mg_obj, key);
1752     break;
1753    case HV_FETCH_ISEXISTS:
1754     if (w->cb_exists)
1755      vmg_cb_call2(w->cb_exists, w->opinfo | VMG_CB_CALL_GUARD, sv,
1756                                 mg->mg_obj, key);
1757     break;
1758    case HV_DELETE:
1759     if (w->cb_delete)
1760      vmg_cb_call2(w->cb_delete, w->opinfo | VMG_CB_CALL_GUARD, sv,
1761                                 mg->mg_obj, key);
1762     break;
1763   }
1764  }
1765
1766  if (SvRMAGICAL(sv) && !tied && !(action & (HV_FETCH_ISSTORE|HV_DELETE))) {
1767   /* Temporarily hide the RMAGICAL flag of the hash so it isn't wrongly
1768    * mistaken for a tied hash by the rest of hv_common. It will be reset by
1769    * the op_ppaddr of a new fake op injected between the current and the next
1770    * one. */
1771
1772 #if VMG_RESET_RMG_NEEDS_TRAMPOLINE
1773
1774   dMY_CXT;
1775
1776   PL_op = vmg_trampoline_bump(&MY_CXT.reset_rmg, sv, PL_op);
1777
1778 #else /* !VMG_RESET_RMG_NEEDS_TRAMPOLINE */
1779
1780   OP   *nop  = PL_op->op_next;
1781   SVOP *svop = NULL;
1782
1783   if (nop && nop->op_ppaddr == vmg_pp_reset_rmg) {
1784    svop = (SVOP *) nop;
1785   } else {
1786    NewOp(1101, svop, 1, SVOP);
1787    svop->op_type    = OP_STUB;
1788    svop->op_ppaddr  = vmg_pp_reset_rmg;
1789    svop->op_next    = nop;
1790    svop->op_flags   = 0;
1791    svop->op_private = 0;
1792
1793    PL_op->op_next = (OP *) svop;
1794   }
1795
1796   svop->op_sv = sv;
1797
1798 #endif /* VMG_RESET_RMG_NEEDS_TRAMPOLINE */
1799
1800   SvRMAGICAL_off(sv);
1801  }
1802
1803  return 0;
1804 }
1805
1806 #endif /* VMG_UVAR */
1807
1808 /* --- Module setup/teardown ----------------------------------------------- */
1809
1810 #if VMG_THREADSAFE
1811
1812 static I32 vmg_loaded = 0;
1813
1814 /* We must use preexistent global mutexes or we will never be able to destroy
1815  * them. */
1816 # if VMG_HAS_PERL(5, 9, 3)
1817 #  define VMG_LOADED_LOCK   MUTEX_LOCK(&PL_my_ctx_mutex)
1818 #  define VMG_LOADED_UNLOCK MUTEX_UNLOCK(&PL_my_ctx_mutex)
1819 # else
1820 #  define VMG_LOADED_LOCK   OP_REFCNT_LOCK
1821 #  define VMG_LOADED_UNLOCK OP_REFCNT_UNLOCK
1822 # endif
1823
1824 static void vmg_global_teardown_late_locked(pTHX) {
1825 #define vmg_global_teardown_late_locked() vmg_global_teardown_late_locked(aTHX)
1826  MUTEX_DESTROY(&vmg_op_name_init_mutex);
1827  MUTEX_DESTROY(&vmg_vtable_refcount_mutex);
1828
1829  return;
1830 }
1831
1832 static int vmg_global_teardown_free(pTHX_ SV *sv, MAGIC *mg) {
1833  VMG_LOADED_LOCK;
1834
1835  if (vmg_loaded == 0)
1836   vmg_global_teardown_late_locked();
1837
1838  VMG_LOADED_UNLOCK;
1839
1840  return 0;
1841 }
1842
1843 static MGVTBL vmg_global_teardown_vtbl = {
1844  0,
1845  0,
1846  0,
1847  0,
1848  vmg_global_teardown_free
1849 #if MGf_COPY
1850  , 0
1851 #endif
1852 #if MGf_DUP
1853  , 0
1854 #endif
1855 #if MGf_LOCAL
1856  , 0
1857 #endif
1858 };
1859
1860 static signed char vmg_destruct_level(pTHX) {
1861 #define vmg_destruct_level() vmg_destruct_level(aTHX)
1862  signed char lvl;
1863
1864  lvl = PL_perl_destruct_level;
1865
1866 #ifdef DEBUGGING
1867  {
1868   const char *s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
1869   if (s) {
1870    int i;
1871 #if VMG_HAS_PERL(5, 21, 3)
1872    if (strEQ(s, "-1")) {
1873     i = -1;
1874    } else {
1875 # if VMG_HAS_PERL(5, 21, 10)
1876     UV uv;
1877     if (Perl_grok_atoUV(s, &uv, NULL) && uv <= INT_MAX)
1878      i = (int) uv;
1879     else
1880      i = 0;
1881 # else /* VMG_HAS_PERL(5, 21, 3) && !VMG_HAS_PERL(5, 21, 10) */
1882     i = Perl_grok_atou(s, NULL);
1883 # endif
1884    }
1885 #else /* !VMG_HAS_PERL(5, 21, 3) */
1886    i = atoi(s);
1887 #endif
1888    if (lvl < i)
1889     lvl = i;
1890   }
1891  }
1892 #endif
1893
1894  return lvl;
1895 }
1896
1897 #endif /* VMG_THREADSAFE */
1898
1899 static void vmg_teardown(pTHX_ void *param) {
1900  dMY_CXT;
1901
1902 #if VMG_THREADSAFE
1903  VMG_LOADED_LOCK;
1904
1905  if (vmg_loaded == 1) {
1906   vmg_loaded = 0;
1907   if (vmg_destruct_level() == 0) {
1908    vmg_global_teardown_late_locked();
1909   } else {
1910    if (!PL_strtab)
1911     PL_strtab = newHV();
1912    vmg_sv_magicext((SV *) PL_strtab, NULL, &vmg_global_teardown_vtbl, NULL, 0);
1913   }
1914  } else {
1915   VMG_ASSERT(vmg_loaded > 1);
1916   --vmg_loaded;
1917  }
1918
1919  VMG_LOADED_UNLOCK;
1920 #endif
1921
1922  if (MY_CXT.depth == 0 && MY_CXT.freed_tokens) {
1923   vmg_magic_chain_free(MY_CXT.freed_tokens, NULL);
1924   MY_CXT.freed_tokens = NULL;
1925  }
1926
1927  return;
1928 }
1929
1930 static void vmg_setup(pTHX) {
1931 #define vmg_setup() vmg_setup(aTHX)
1932  HV *stash;
1933  int c;
1934  MY_CXT_INIT;
1935
1936 #if VMG_THREADSAFE
1937  VMG_LOADED_LOCK;
1938
1939  if (vmg_loaded == 0) {
1940   MUTEX_INIT(&vmg_vtable_refcount_mutex);
1941   MUTEX_INIT(&vmg_op_name_init_mutex);
1942   vmg_loaded = 1;
1943  } else {
1944   VMG_ASSERT(vmg_loaded > 0);
1945   ++vmg_loaded;
1946  }
1947
1948  VMG_LOADED_UNLOCK;
1949 #endif
1950
1951  for (c = OPc_NULL; c < OPc_MAX; ++c)
1952   MY_CXT.b__op_stashes[c] = NULL;
1953
1954  MY_CXT.depth        = 0;
1955  MY_CXT.freed_tokens = NULL;
1956
1957 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
1958  vmg_trampoline_init(&MY_CXT.propagate_errsv, vmg_pp_propagate_errsv);
1959 #endif
1960 #if VMG_RESET_RMG_NEEDS_TRAMPOLINE
1961  vmg_trampoline_init(&MY_CXT.reset_rmg, vmg_pp_reset_rmg);
1962 #endif
1963
1964  stash = gv_stashpv(__PACKAGE__, 1);
1965  newCONSTSUB(stash, "MGf_COPY",  newSVuv(MGf_COPY));
1966  newCONSTSUB(stash, "MGf_DUP",   newSVuv(MGf_DUP));
1967  newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
1968  newCONSTSUB(stash, "VMG_UVAR",  newSVuv(VMG_UVAR));
1969  newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
1970                     newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
1971  newCONSTSUB(stash, "VMG_COMPAT_SCALAR_NOLEN",
1972                     newSVuv(VMG_COMPAT_SCALAR_NOLEN));
1973  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
1974                     newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
1975  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID",
1976                     newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID));
1977  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
1978                     newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
1979  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
1980                     newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
1981  newCONSTSUB(stash, "VMG_COMPAT_HASH_DELETE_NOUVAR_VOID",
1982                     newSVuv(VMG_COMPAT_HASH_DELETE_NOUVAR_VOID));
1983  newCONSTSUB(stash, "VMG_COMPAT_CODE_COPY_CLONE",
1984                     newSVuv(VMG_COMPAT_CODE_COPY_CLONE));
1985  newCONSTSUB(stash, "VMG_COMPAT_GLOB_GET", newSVuv(VMG_COMPAT_GLOB_GET));
1986  newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
1987  newCONSTSUB(stash, "VMG_THREADSAFE",      newSVuv(VMG_THREADSAFE));
1988  newCONSTSUB(stash, "VMG_FORKSAFE",        newSVuv(VMG_FORKSAFE));
1989  newCONSTSUB(stash, "VMG_OP_INFO_NAME",    newSVuv(VMG_OP_INFO_NAME));
1990  newCONSTSUB(stash, "VMG_OP_INFO_OBJECT",  newSVuv(VMG_OP_INFO_OBJECT));
1991
1992  call_atexit(vmg_teardown, NULL);
1993
1994  return;
1995 }
1996
1997 /* --- Macros for the XS section ------------------------------------------- */
1998
1999 #ifdef CvISXSUB
2000 # define VMG_CVOK(C) \
2001    ((CvISXSUB(C) ? (void *) CvXSUB(C) : (void *) CvROOT(C)) ? 1 : 0)
2002 #else
2003 # define VMG_CVOK(C) (CvROOT(C) || CvXSUB(C))
2004 #endif
2005
2006 #define VMG_CBOK(S) ((SvTYPE(S) == SVt_PVCV) ? VMG_CVOK(S) : SvOK(S))
2007
2008 #define VMG_SET_CB(S, N) {       \
2009  SV *cb = (S);                   \
2010  if (SvOK(cb) && SvROK(cb)) {    \
2011   cb = SvRV(cb);                 \
2012   if (VMG_CBOK(cb))              \
2013    SvREFCNT_inc_simple_void(cb); \
2014   else                           \
2015    cb = NULL;                    \
2016  } else {                        \
2017   cb = NULL;                     \
2018  }                               \
2019  w->cb_ ## N = cb;               \
2020 }
2021
2022 #define VMG_SET_SVT_CB(S, N) {   \
2023  SV *cb = (S);                   \
2024  if (SvOK(cb) && SvROK(cb)) {    \
2025   cb = SvRV(cb);                 \
2026   if (VMG_CBOK(cb)) {            \
2027    t->svt_ ## N = vmg_svt_ ## N; \
2028    SvREFCNT_inc_simple_void(cb); \
2029   } else {                       \
2030    t->svt_ ## N = vmg_svt_ ## N ## _noop; \
2031    cb           = NULL;          \
2032   }                              \
2033  } else {                        \
2034   t->svt_ ## N = NULL;           \
2035   cb           = NULL;           \
2036  }                               \
2037  w->cb_ ## N = cb;               \
2038 }
2039
2040 /* --- XS ------------------------------------------------------------------ */
2041
2042 MODULE = Variable::Magic            PACKAGE = Variable::Magic
2043
2044 PROTOTYPES: ENABLE
2045
2046 BOOT:
2047 {
2048  vmg_setup();
2049 }
2050
2051 #if VMG_THREADSAFE
2052
2053 void
2054 CLONE(...)
2055 PROTOTYPE: DISABLE
2056 PREINIT:
2057  U32 had_b__op_stash = 0;
2058  I32 old_depth;
2059  int c;
2060 PPCODE:
2061  {
2062   dMY_CXT;
2063   for (c = OPc_NULL; c < OPc_MAX; ++c) {
2064    if (MY_CXT.b__op_stashes[c])
2065     had_b__op_stash |= (((U32) 1) << c);
2066   }
2067   old_depth = MY_CXT.depth;
2068  }
2069  {
2070   MY_CXT_CLONE;
2071   for (c = OPc_NULL; c < OPc_MAX; ++c) {
2072    MY_CXT.b__op_stashes[c] = (had_b__op_stash & (((U32) 1) << c))
2073                               ? gv_stashpv(vmg_opclassnames[c], 1) : NULL;
2074   }
2075   MY_CXT.depth        = old_depth;
2076   MY_CXT.freed_tokens = NULL;
2077   VMG_LOADED_LOCK;
2078   VMG_ASSERT(vmg_loaded > 0);
2079   ++vmg_loaded;
2080   VMG_LOADED_UNLOCK;
2081  }
2082  XSRETURN(0);
2083
2084 #endif /* VMG_THREADSAFE */
2085
2086 SV *_wizard(...)
2087 PROTOTYPE: DISABLE
2088 PREINIT:
2089  vmg_wizard *w;
2090  MGVTBL *t;
2091  SV *op_info, *copy_key;
2092  I32 i = 0;
2093 CODE:
2094  if (items != 9
2095 #if MGf_LOCAL
2096               + 1
2097 #endif /* MGf_LOCAL */
2098 #if VMG_UVAR
2099               + 5
2100 #endif /* VMG_UVAR */
2101               ) { croak(vmg_wrongargnum); }
2102
2103  op_info = ST(i++);
2104  w = vmg_wizard_alloc(SvOK(op_info) ? SvUV(op_info) : 0);
2105  t = vmg_vtable_vtbl(w->vtable);
2106
2107  VMG_SET_CB(ST(i++), data);
2108
2109  VMG_SET_SVT_CB(ST(i++), get);
2110  VMG_SET_SVT_CB(ST(i++), set);
2111  VMG_SET_SVT_CB(ST(i++), len);
2112  VMG_SET_SVT_CB(ST(i++), clear);
2113  VMG_SET_SVT_CB(ST(i++), free);
2114  VMG_SET_SVT_CB(ST(i++), copy);
2115  /* VMG_SET_SVT_CB(ST(i++), dup); */
2116  i++;
2117  t->svt_dup = NULL;
2118  w->cb_dup  = NULL;
2119 #if MGf_LOCAL
2120  VMG_SET_SVT_CB(ST(i++), local);
2121 #endif /* MGf_LOCAL */
2122 #if VMG_UVAR
2123  VMG_SET_CB(ST(i++), fetch);
2124  VMG_SET_CB(ST(i++), store);
2125  VMG_SET_CB(ST(i++), exists);
2126  VMG_SET_CB(ST(i++), delete);
2127
2128  copy_key = ST(i++);
2129  if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
2130   w->uvar = SvTRUE(copy_key) ? 2 : 1;
2131 #endif /* VMG_UVAR */
2132
2133  RETVAL = newRV_noinc(vmg_wizard_sv_new(w));
2134 OUTPUT:
2135  RETVAL
2136
2137 SV *cast(SV *sv, SV *wiz, ...)
2138 PROTOTYPE: \[$@%&*]$@
2139 PREINIT:
2140  const vmg_wizard *w = NULL;
2141  SV **args = NULL;
2142  I32 i = 0;
2143 CODE:
2144  if (items > 2) {
2145   i = items - 2;
2146   args = &ST(2);
2147  }
2148  if (SvROK(wiz)) {
2149   wiz = SvRV_const(wiz);
2150   w   = vmg_wizard_from_sv(wiz);
2151  }
2152  if (!w)
2153   croak(vmg_invalid_wiz);
2154  RETVAL = newSVuv(vmg_cast(SvRV(sv), w, wiz, args, i));
2155 OUTPUT:
2156  RETVAL
2157
2158 void
2159 getdata(SV *sv, SV *wiz)
2160 PROTOTYPE: \[$@%&*]$
2161 PREINIT:
2162  const vmg_wizard *w = NULL;
2163  SV *data;
2164 PPCODE:
2165  if (SvROK(wiz))
2166   w = vmg_wizard_from_sv(SvRV_const(wiz));
2167  if (!w)
2168   croak(vmg_invalid_wiz);
2169  data = vmg_data_get(SvRV(sv), w);
2170  if (!data)
2171   XSRETURN_EMPTY;
2172  ST(0) = data;
2173  XSRETURN(1);
2174
2175 SV *dispell(SV *sv, SV *wiz)
2176 PROTOTYPE: \[$@%&*]$
2177 PREINIT:
2178  const vmg_wizard *w = NULL;
2179 CODE:
2180  if (SvROK(wiz))
2181   w = vmg_wizard_from_sv(SvRV_const(wiz));
2182  if (!w)
2183   croak(vmg_invalid_wiz);
2184  RETVAL = newSVuv(vmg_dispell(SvRV(sv), w));
2185 OUTPUT:
2186  RETVAL