ext/Opcode/Opcode.xs

   1 #define PERL_NO_GET_CONTEXT
   2 #include "EXTERN.h"
   3 #include "perl.h"
   4 #include "XSUB.h"
   5
   6 /* PL_maxo shouldn't differ from MAXO but leave room anyway (see BOOT:) */
   7 #define OP_MASK_BUF_SIZE (MAXO + 100)
   8
   9 /* XXX op_named_bits and opset_all are never freed */
  10 #define MY_CXT_KEY "Opcode::_guts" XS_VERSION
  11
  12 typedef struct {
  13     HV *        x_op_named_bits;        /* cache shared for whole process */
  14     SV *        x_opset_all;            /* mask with all bits set       */
  15     IV          x_opset_len;            /* length of opmasks in bytes   */
  16 #if 0
  17     int         x_opcode_debug;         /* unused warn() emitting debugging code */
  18 #endif
  19 } my_cxt_t;
  20
  21 START_MY_CXT
  22
  23 #define op_named_bits           (MY_CXT.x_op_named_bits)
  24 #define opset_all               (MY_CXT.x_opset_all)
  25 #define opset_len               (MY_CXT.x_opset_len)
  26 #if 0
  27 #  define opcode_debug          (MY_CXT.x_opcode_debug)
  28 #else
  29  /* no API to turn this on at runtime, so constant fold the code away */
  30 #  define opcode_debug          0
  31 #endif
  32
  33 static SV  *new_opset (pTHX_ SV *old_opset);
  34 static int  verify_opset (pTHX_ SV *opset, int fatal);
  35 static void set_opset_bits (pTHX_ char *bitmap, SV *bitspec, int on, const char *opname);
  36 static void put_op_bitspec (pTHX_ const char *optag,  STRLEN len, SV *opset);
  37 static SV  *get_op_bitspec (pTHX_ const char *opname, STRLEN len, int fatal);
  38
  39
  40 /* Initialise our private op_named_bits HV.
  41  * It is first loaded with the name and number of each perl operator.
  42  * Then the builtin tags :none and :all are added.
  43  * Opcode.pm loads the standard optags from __DATA__
  44  * XXX leak-alert: data allocated here is never freed, call this
  45  *     at most once
  46  */
  47
  48 static void
  49 op_names_init(pTHX)
  50 {
  51     int i;
  52     STRLEN len;
  53     char **op_names;
  54     char *bitmap;
  55     dMY_CXT;
  56
  57     op_named_bits = newHV();
  58     op_names = get_op_names();
  59     for(i=0; i < PL_maxo; ++i) {
  60         SV * const sv = newSViv(i);
  61         SvREADONLY_on(sv);
  62         (void) hv_store(op_named_bits, op_names[i], strlen(op_names[i]), sv, 0);
  63     }
  64
  65     put_op_bitspec(aTHX_ STR_WITH_LEN(":none"), sv_2mortal(new_opset(aTHX_ Nullsv)));
  66
  67     opset_all = new_opset(aTHX_ Nullsv);
  68     bitmap = SvPV(opset_all, len);
  69     memset(bitmap, 0xFF, len-1); /* deal with last byte specially, see below */
  70     /* Take care to set the right number of bits in the last byte */
  71     bitmap[len-1] = (PL_maxo & 0x07) ? ~(0xFF << (PL_maxo & 0x07)) : 0xFF;
  72     put_op_bitspec(aTHX_ STR_WITH_LEN(":all"), opset_all); /* don't mortalise */
  73 }
  74
  75
  76 /* Store a new tag definition. Always a mask.
  77  * The tag must not already be defined.
  78  * SV *mask is copied not referenced.
  79  */
  80
  81 static void
  82 put_op_bitspec(pTHX_ const char *optag, STRLEN len, SV *mask)
  83 {
  84     SV **svp;
  85     dMY_CXT;
  86
  87     verify_opset(aTHX_ mask,1);
  88     svp = hv_fetch(op_named_bits, optag, len, 1);
  89     if (SvOK(*svp))
  90         croak("Opcode tag \"%s\" already defined", optag);
  91     sv_setsv(*svp, mask);
  92     SvREADONLY_on(*svp);
  93 }
  94
  95
  96
  97 /* Fetch a 'bits' entry for an opname or optag (IV/PV).
  98  * Note that we return the actual entry for speed.
  99  * Always sv_mortalcopy() if returning it to user code.
 100  */
 101
 102 static SV *
 103 get_op_bitspec(pTHX_ const char *opname, STRLEN len, int fatal)
 104 {
 105     SV **svp;
 106     dMY_CXT;
 107
 108     svp = hv_fetch(op_named_bits, opname, len, 0);
 109     if (!svp || !SvOK(*svp)) {
 110         if (!fatal)
 111             return Nullsv;
 112         if (*opname == ':')
 113             croak("Unknown operator tag \"%s\"", opname);
 114         if (*opname == '!')     /* XXX here later, or elsewhere? */
 115             croak("Can't negate operators here (\"%s\")", opname);
 116         if (isALPHA(*opname))
 117             croak("Unknown operator name \"%s\"", opname);
 118         croak("Unknown operator prefix \"%s\"", opname);
 119     }
 120     return *svp;
 121 }
 122
 123
 124
 125 static SV *
 126 new_opset(pTHX_ SV *old_opset)
 127 {
 128     SV *opset;
 129     dMY_CXT;
 130
 131     if (old_opset) {
 132         verify_opset(aTHX_ old_opset,1);
 133         opset = newSVsv(old_opset);
 134     }
 135     else {
 136         opset = newSV(opset_len);
 137         Zero(SvPVX_const(opset), opset_len + 1, char);
 138         SvCUR_set(opset, opset_len);
 139         (void)SvPOK_only(opset);
 140     }
 141     /* not mortalised here */
 142     return opset;
 143 }
 144
 145
 146 static int
 147 verify_opset(pTHX_ SV *opset, int fatal)
 148 {
 149     const char *err = NULL;
 150     dMY_CXT;
 151
 152     if      (!SvOK(opset))              err = "undefined";
 153     else if (!SvPOK(opset))             err = "wrong type";
 154     else if (SvCUR(opset) != (STRLEN)opset_len) err = "wrong size";
 155     if (err && fatal) {
 156         croak("Invalid opset: %s", err);
 157     }
 158     return !err;
 159 }
 160
 161
 162 static void
 163 set_opset_bits(pTHX_ char *bitmap, SV *bitspec, int on, const char *opname)
 164 {
 165     dMY_CXT;
 166
 167     if (SvIOK(bitspec)) {
 168         const int myopcode = SvIV(bitspec);
 169         const int offset = myopcode >> 3;
 170         const int bit    = myopcode & 0x07;
 171         if (myopcode >= PL_maxo || myopcode < 0)
 172             croak("panic: opcode \"%s\" value %d is invalid", opname, myopcode);
 173         if (opcode_debug >= 2)
 174             warn("set_opset_bits bit %2d (off=%d, bit=%d) %s %s\n",
 175                         myopcode, offset, bit, opname, (on)?"on":"off");
 176         if (on)
 177             bitmap[offset] |= 1 << bit;
 178         else
 179             bitmap[offset] &= ~(1 << bit);
 180     }
 181     else if (SvPOK(bitspec) && SvCUR(bitspec) == (STRLEN)opset_len) {
 182
 183         STRLEN len;
 184         const char * const specbits = SvPV(bitspec, len);
 185         if (opcode_debug >= 2)
 186             warn("set_opset_bits opset %s %s\n", opname, (on)?"on":"off");
 187         if (on)
 188             while(len-- > 0) bitmap[len] |=  specbits[len];
 189         else
 190             while(len-- > 0) bitmap[len] &= ~specbits[len];
 191     }
 192     else
 193         croak("panic: invalid bitspec for \"%s\" (type %u)",
 194                 opname, (unsigned)SvTYPE(bitspec));
 195 }
 196
 197
 198 static void
 199 opmask_add(pTHX_ SV *opset)     /* THE ONLY FUNCTION TO EDIT PL_op_mask ITSELF  */
 200 {
 201     int i,j;
 202     char *bitmask;
 203     STRLEN len;
 204     int myopcode = 0;
 205     dMY_CXT;
 206
 207     verify_opset(aTHX_ opset,1);                /* croaks on bad opset  */
 208
 209     if (!PL_op_mask)            /* caller must ensure PL_op_mask exists */
 210         croak("Can't add to uninitialised PL_op_mask");
 211
 212     /* OPCODES ALREADY MASKED ARE NEVER UNMASKED. See opmask_addlocal() */
 213
 214     bitmask = SvPV(opset, len);
 215     for (i=0; i < opset_len; i++) {
 216         const U16 bits = bitmask[i];
 217         if (!bits) {    /* optimise for sparse masks */
 218             myopcode += 8;
 219             continue;
 220         }
 221         for (j=0; j < 8 && myopcode < PL_maxo; )
 222             PL_op_mask[myopcode++] |= bits & (1 << j++);
 223     }
 224 }
 225
 226 static void
 227 opmask_addlocal(pTHX_ SV *opset, char *op_mask_buf) /* Localise PL_op_mask then opmask_add() */
 228 {
 229     char *orig_op_mask = PL_op_mask;
 230     dMY_CXT;
 231
 232     SAVEVPTR(PL_op_mask);
 233     /* XXX casting to an ordinary function ptr from a member function ptr
 234      * is disallowed by Borland
 235      */
 236     if (opcode_debug >= 2)
 237         SAVEDESTRUCTOR((void(*)(void*))Perl_warn,"PL_op_mask restored");
 238     PL_op_mask = &op_mask_buf[0];
 239     if (orig_op_mask)
 240         Copy(orig_op_mask, PL_op_mask, PL_maxo, char);
 241     else
 242         Zero(PL_op_mask, PL_maxo, char);
 243     opmask_add(aTHX_ opset);
 244 }
 245
 246
 247
 248 MODULE = Opcode PACKAGE = Opcode
 249
 250 PROTOTYPES: ENABLE
 251
 252 BOOT:
 253 {
 254     MY_CXT_INIT;
 255     assert(PL_maxo < OP_MASK_BUF_SIZE);
 256     opset_len = (PL_maxo + 7) / 8;
 257     if (opcode_debug >= 1)
 258         warn("opset_len %ld\n", (long)opset_len);
 259     op_names_init(aTHX);
 260 }
 261
 262 void
 263 _safe_pkg_prep(Package)
 264     SV *Package
 265 PPCODE:
 266     HV *hv;
 267     char *hvname;
 268     ENTER;
 269
 270     hv = gv_stashsv(Package, GV_ADDWARN); /* should exist already       */
 271
 272     hvname = HvNAME_get(hv);
 273     if (!hvname || strNE(hvname, "main")) {
 274         /* make it think it's in main:: */
 275         hv_name_set(hv, "main", 4, 0);
 276         (void) hv_store(hv,"_",1,(SV *)PL_defgv,0);  /* connect _ to global */
 277         SvREFCNT_inc((SV *)PL_defgv);  /* want to keep _ around! */
 278     }
 279     LEAVE;
 280
 281
 282
 283
 284
 285 void
 286 _safe_call_sv(Package, mask, codesv)
 287     SV *        Package
 288     SV *        mask
 289     SV *        codesv
 290 PPCODE:
 291     char op_mask_buf[OP_MASK_BUF_SIZE];
 292     GV *gv;
 293     HV *dummy_hv;
 294
 295     ENTER;
 296
 297     opmask_addlocal(aTHX_ mask, op_mask_buf);
 298
 299     save_aptr(&PL_endav);
 300     PL_endav = (AV*)sv_2mortal((SV*)newAV()); /* ignore END blocks for now      */
 301
 302     save_hptr(&PL_defstash);            /* save current default stash   */
 303     /* the assignment to global defstash changes our sense of 'main'    */
 304     PL_defstash = gv_stashsv(Package, GV_ADDWARN); /* should exist already      */
 305
 306     SAVEGENERICSV(PL_curstash);
 307     PL_curstash = (HV *)SvREFCNT_inc_simple(PL_defstash);
 308
 309     /* defstash must itself contain a main:: so we'll add that now      */
 310     /* take care with the ref counts (was cause of long standing bug)   */
 311     /* XXX I'm still not sure if this is right, GV_ADDWARN should warn! */
 312     gv = gv_fetchpvs("main::", GV_ADDWARN, SVt_PVHV);
 313     sv_free((SV*)GvHV(gv));
 314     GvHV(gv) = (HV*)SvREFCNT_inc(PL_defstash);
 315
 316     /* %INC must be clean for use/require in compartment */
 317     dummy_hv = save_hash(PL_incgv);
 318     GvHV(PL_incgv) = (HV*)SvREFCNT_inc(GvHV(gv_HVadd(gv_fetchpvs("INC",GV_ADD,SVt_PVHV))));
 319
 320     /* Invalidate class and method caches */
 321     ++PL_sub_generation;
 322     hv_clear(PL_stashcache);
 323
 324     PUSHMARK(SP);
 325     /* use caller’s context */
 326     perl_call_sv(codesv, GIMME_V|G_EVAL|G_KEEPERR);
 327     sv_free( (SV *) dummy_hv);  /* get rid of what save_hash gave us*/
 328     SPAGAIN; /* for the PUTBACK added by xsubpp */
 329     LEAVE;
 330
 331     /* Invalidate again */
 332     ++PL_sub_generation;
 333     hv_clear(PL_stashcache);
 334
 335
 336 int
 337 verify_opset(opset, fatal = 0)
 338     SV *opset
 339     int fatal
 340 CODE:
 341     RETVAL = verify_opset(aTHX_ opset,fatal);
 342 OUTPUT:
 343     RETVAL
 344
 345 void
 346 invert_opset(opset)
 347     SV *opset
 348 CODE:
 349     {
 350     char *bitmap;
 351     dMY_CXT;
 352     STRLEN len = opset_len;
 353
 354     opset = sv_2mortal(new_opset(aTHX_ opset)); /* verify and clone opset */
 355     bitmap = SvPVX(opset);
 356     while(len-- > 0)
 357         bitmap[len] = ~bitmap[len];
 358     /* take care of extra bits beyond PL_maxo in last byte      */
 359     if (PL_maxo & 07)
 360         bitmap[opset_len-1] &= ~(0xFF << (PL_maxo & 0x07));
 361     }
 362     ST(0) = opset;
 363
 364
 365 void
 366 opset_to_ops(opset, desc = 0)
 367     SV *opset
 368     int desc
 369 PPCODE:
 370     {
 371     STRLEN len;
 372     int i, j, myopcode;
 373     const char * const bitmap = SvPV(opset, len);
 374     char **names = (desc) ? get_op_descs() : get_op_names();
 375     dMY_CXT;
 376
 377     verify_opset(aTHX_ opset,1);
 378     for (myopcode=0, i=0; i < opset_len; i++) {
 379         const U16 bits = bitmap[i];
 380         for (j=0; j < 8 && myopcode < PL_maxo; j++, myopcode++) {
 381             if ( bits & (1 << j) )
 382                 XPUSHs(newSVpvn_flags(names[myopcode], strlen(names[myopcode]),
 383                                       SVs_TEMP));
 384         }
 385     }
 386     }
 387
 388
 389 void
 390 opset(...)
 391 CODE:
 392     int i;
 393     SV *bitspec;
 394     STRLEN len, on;
 395
 396     SV * const opset = sv_2mortal(new_opset(aTHX_ Nullsv));
 397     char * const bitmap = SvPVX(opset);
 398     for (i = 0; i < items; i++) {
 399         const char *opname;
 400         on = 1;
 401         if (verify_opset(aTHX_ ST(i),0)) {
 402             opname = "(opset)";
 403             bitspec = ST(i);
 404         }
 405         else {
 406             opname = SvPV(ST(i), len);
 407             if (*opname == '!') { on=0; ++opname;--len; }
 408             bitspec = get_op_bitspec(aTHX_ opname, len, 1);
 409         }
 410         set_opset_bits(aTHX_ bitmap, bitspec, on, opname);
 411     }
 412     ST(0) = opset;
 413
 414
 415 #define PERMITING  (ix == 0 || ix == 1)
 416 #define ONLY_THESE (ix == 0 || ix == 2)
 417
 418 void
 419 permit_only(safe, ...)
 420     SV *safe
 421 ALIAS:
 422         permit    = 1
 423         deny_only = 2
 424         deny      = 3
 425 CODE:
 426     int i;
 427     SV *bitspec, *mask;
 428     char *bitmap;
 429     STRLEN len;
 430     dMY_CXT;
 431
 432     if (!SvROK(safe) || !SvOBJECT(SvRV(safe)) || SvTYPE(SvRV(safe))!=SVt_PVHV)
 433         croak("Not a Safe object");
 434     mask = *hv_fetch((HV*)SvRV(safe), "Mask",4, 1);
 435     if (ONLY_THESE)     /* *_only = new mask, else edit current */
 436         sv_setsv(mask, sv_2mortal(new_opset(aTHX_ PERMITING ? opset_all : Nullsv)));
 437     else
 438         verify_opset(aTHX_ mask,1); /* croaks */
 439     bitmap = SvPVX(mask);
 440     for (i = 1; i < items; i++) {
 441         const char *opname;
 442         int on = PERMITING ? 0 : 1;             /* deny = mask bit on   */
 443         if (verify_opset(aTHX_ ST(i),0)) {      /* it's a valid mask    */
 444             opname = "(opset)";
 445             bitspec = ST(i);
 446         }
 447         else {                          /* it's an opname/optag */
 448             opname = SvPV(ST(i), len);
 449             /* invert if op has ! prefix (only one allowed)     */
 450             if (*opname == '!') { on = !on; ++opname; --len; }
 451             bitspec = get_op_bitspec(aTHX_ opname, len, 1); /* croaks */
 452         }
 453         set_opset_bits(aTHX_ bitmap, bitspec, on, opname);
 454     }
 455     ST(0) = &PL_sv_yes;
 456
 457
 458
 459 void
 460 opdesc(...)
 461 PPCODE:
 462     int i;
 463     STRLEN len;
 464     SV **args;
 465     char **op_desc = get_op_descs();
 466     dMY_CXT;
 467
 468     /* copy args to a scratch area since we may push output values onto */
 469     /* the stack faster than we read values off it if masks are used.   */
 470     args = (SV**)SvPVX(newSVpvn_flags((char*)&ST(0), items*sizeof(SV*), SVs_TEMP));
 471     for (i = 0; i < items; i++) {
 472         const char * const opname = SvPV(args[i], len);
 473         SV *bitspec = get_op_bitspec(aTHX_ opname, len, 1);
 474         if (SvIOK(bitspec)) {
 475             const int myopcode = SvIV(bitspec);
 476             if (myopcode < 0 || myopcode >= PL_maxo)
 477                 croak("panic: opcode %d (%s) out of range",myopcode,opname);
 478             XPUSHs(newSVpvn_flags(op_desc[myopcode], strlen(op_desc[myopcode]),
 479                                   SVs_TEMP));
 480         }
 481         else if (SvPOK(bitspec) && SvCUR(bitspec) == (STRLEN)opset_len) {
 482             int b, j;
 483             const char * const bitmap = SvPV_nolen_const(bitspec);
 484             int myopcode = 0;
 485             for (b=0; b < opset_len; b++) {
 486                 const U16 bits = bitmap[b];
 487                 for (j=0; j < 8 && myopcode < PL_maxo; j++, myopcode++)
 488                     if (bits & (1 << j))
 489                         XPUSHs(newSVpvn_flags(op_desc[myopcode],
 490                                               strlen(op_desc[myopcode]),
 491                                               SVs_TEMP));
 492             }
 493         }
 494         else
 495             croak("panic: invalid bitspec for \"%s\" (type %u)",
 496                 opname, (unsigned)SvTYPE(bitspec));
 497     }
 498
 499
 500 void
 501 define_optag(optagsv, mask)
 502     SV *optagsv
 503     SV *mask
 504 CODE:
 505     STRLEN len;
 506     const char *optag = SvPV(optagsv, len);
 507
 508     put_op_bitspec(aTHX_ optag, len, mask); /* croaks */
 509     ST(0) = &PL_sv_yes;
 510
 511
 512 void
 513 empty_opset()
 514 CODE:
 515     ST(0) = sv_2mortal(new_opset(aTHX_ Nullsv));
 516
 517 void
 518 full_opset()
 519 CODE:
 520     dMY_CXT;
 521     ST(0) = sv_2mortal(new_opset(aTHX_ opset_all));
 522
 523 void
 524 opmask_add(opset)
 525     SV *opset
 526 PREINIT:
 527     if (!PL_op_mask)
 528         Newxz(PL_op_mask, PL_maxo, char);
 529 CODE:
 530     opmask_add(aTHX_ opset);
 531
 532 void
 533 opcodes()
 534 PPCODE:
 535     if (GIMME_V == G_ARRAY) {
 536         croak("opcodes in list context not yet implemented"); /* XXX */
 537     }
 538     else {
 539         XPUSHs(sv_2mortal(newSViv(PL_maxo)));
 540     }
 541
 542 void
 543 opmask()
 544 CODE:
 545     ST(0) = sv_2mortal(new_opset(aTHX_ Nullsv));
 546     if (PL_op_mask) {
 547         char * const bitmap = SvPVX(ST(0));
 548         int myopcode;
 549         for(myopcode=0; myopcode < PL_maxo; ++myopcode) {
 550             if (PL_op_mask[myopcode])
 551                 bitmap[myopcode >> 3] |= 1 << (myopcode & 0x07);
 552         }
 553     }
 554