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