This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
6c583123b3e868a17f0aa2610d92b1433172de66
[perl5.git] / 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 #if !defined(PERL_OBJECT)
209     /* XXX casting to an ordinary function ptr from a member function ptr
210      * is disallowed by Borland
211      */
212     if (opcode_debug >= 2)
213         SAVEDESTRUCTOR((void(*)(void*))Perl_warn,"PL_op_mask restored");
214 #endif
215     PL_op_mask = &op_mask_buf[0];
216     if (orig_op_mask)
217         Copy(orig_op_mask, PL_op_mask, PL_maxo, char);
218     else
219         Zero(PL_op_mask, PL_maxo, char);
220     opmask_add(aTHX_ opset);
221 }
222
223
224
225 MODULE = Opcode PACKAGE = Opcode
226
227 PROTOTYPES: ENABLE
228
229 BOOT:
230     assert(PL_maxo < OP_MASK_BUF_SIZE);
231     opset_len = (PL_maxo + 7) / 8;
232     if (opcode_debug >= 1)
233         warn("opset_len %ld\n", (long)opset_len);
234     op_names_init(aTHX);
235
236 void
237 _safe_pkg_prep(Package)
238     char *      Package
239 PPCODE:
240     HV *hv; 
241     ENTER;
242    
243     hv = gv_stashpv(Package, GV_ADDWARN); /* should exist already       */
244
245     if (strNE(HvNAME(hv),"main")) {
246         Safefree(HvNAME(hv));         
247         HvNAME(hv) = savepv("main"); /* make it think it's in main:: */
248         hv_store(hv,"_",1,(SV *)PL_defgv,0);  /* connect _ to global */
249         SvREFCNT_inc((SV *)PL_defgv);  /* want to keep _ around! */
250     }
251     LEAVE;
252
253
254
255
256
257 void
258 _safe_call_sv(Package, mask, codesv)
259     char *      Package
260     SV *        mask
261     SV *        codesv
262 PPCODE:
263     char op_mask_buf[OP_MASK_BUF_SIZE];
264     GV *gv;
265
266     ENTER;
267
268     opmask_addlocal(aTHX_ mask, op_mask_buf);
269
270     save_aptr(&PL_endav);
271     PL_endav = (AV*)sv_2mortal((SV*)newAV()); /* ignore END blocks for now      */
272
273     save_hptr(&PL_defstash);            /* save current default stash   */
274     /* the assignment to global defstash changes our sense of 'main'    */
275     PL_defstash = gv_stashpv(Package, GV_ADDWARN); /* should exist already      */
276
277     save_hptr(&PL_curstash);
278     PL_curstash = PL_defstash;
279
280     /* defstash must itself contain a main:: so we'll add that now      */
281     /* take care with the ref counts (was cause of long standing bug)   */
282     /* XXX I'm still not sure if this is right, GV_ADDWARN should warn! */
283     gv = gv_fetchpv("main::", GV_ADDWARN, SVt_PVHV);
284     sv_free((SV*)GvHV(gv));
285     GvHV(gv) = (HV*)SvREFCNT_inc(PL_defstash);
286
287     /* %INC must be clean for use/require in compartment */
288     save_hash(PL_incgv);
289     sv_free((SV*)GvHV(PL_incgv));  /* get rid of what save_hash gave us*/
290     GvHV(PL_incgv) = (HV*)SvREFCNT_inc(GvHV(gv_HVadd(gv_fetchpv("INC",TRUE,SVt_PVHV))));
291
292     PUSHMARK(SP);
293     perl_call_sv(codesv, GIMME|G_EVAL|G_KEEPERR); /* use callers context */
294     SPAGAIN; /* for the PUTBACK added by xsubpp */
295     LEAVE;
296
297
298 int
299 verify_opset(opset, fatal = 0)
300     SV *opset
301     int fatal
302 CODE:
303     RETVAL = verify_opset(aTHX_ opset,fatal);
304 OUTPUT:
305     RETVAL
306
307 void
308 invert_opset(opset)
309     SV *opset
310 CODE:
311     {
312     char *bitmap;
313     STRLEN len = opset_len;
314     opset = sv_2mortal(new_opset(aTHX_ opset)); /* verify and clone opset */
315     bitmap = SvPVX(opset);
316     while(len-- > 0)
317         bitmap[len] = ~bitmap[len];
318     /* take care of extra bits beyond PL_maxo in last byte      */
319     if (PL_maxo & 07)
320         bitmap[opset_len-1] &= ~(0xFF << (PL_maxo & 0x07));
321     }
322     ST(0) = opset;
323
324
325 void
326 opset_to_ops(opset, desc = 0)
327     SV *opset
328     int desc
329 PPCODE:
330     {
331     STRLEN len;
332     int i, j, myopcode;
333     char *bitmap = SvPV(opset, len);
334     char **names = (desc) ? get_op_descs() : get_op_names();
335     verify_opset(aTHX_ opset,1);
336     for (myopcode=0, i=0; i < opset_len; i++) {
337         U16 bits = bitmap[i];
338         for (j=0; j < 8 && myopcode < PL_maxo; j++, myopcode++) {
339             if ( bits & (1 << j) )
340                 XPUSHs(sv_2mortal(newSVpv(names[myopcode], 0)));
341         }
342     }
343     }
344
345
346 void
347 opset(...)
348 CODE:
349     int i;
350     SV *bitspec, *opset;
351     char *bitmap;
352     STRLEN len, on;
353     opset = sv_2mortal(new_opset(aTHX_ Nullsv));
354     bitmap = SvPVX(opset);
355     for (i = 0; i < items; i++) {
356         char *opname;
357         on = 1;
358         if (verify_opset(aTHX_ ST(i),0)) {
359             opname = "(opset)";
360             bitspec = ST(i);
361         }
362         else {
363             opname = SvPV(ST(i), len);
364             if (*opname == '!') { on=0; ++opname;--len; }
365             bitspec = get_op_bitspec(aTHX_ opname, len, 1);
366         }
367         set_opset_bits(aTHX_ bitmap, bitspec, on, opname);
368     }
369     ST(0) = opset;
370
371
372 #define PERMITING  (ix == 0 || ix == 1)
373 #define ONLY_THESE (ix == 0 || ix == 2)
374
375 void
376 permit_only(safe, ...)
377     SV *safe
378 ALIAS:
379         permit    = 1
380         deny_only = 2
381         deny      = 3
382 CODE:
383     int i, on;
384     SV *bitspec, *mask;
385     char *bitmap, *opname;
386     STRLEN len;
387
388     if (!SvROK(safe) || !SvOBJECT(SvRV(safe)) || SvTYPE(SvRV(safe))!=SVt_PVHV)
389         croak("Not a Safe object");
390     mask = *hv_fetch((HV*)SvRV(safe), "Mask",4, 1);
391     if (ONLY_THESE)     /* *_only = new mask, else edit current */
392         sv_setsv(mask, sv_2mortal(new_opset(aTHX_ PERMITING ? opset_all : Nullsv)));
393     else
394         verify_opset(aTHX_ mask,1); /* croaks */
395     bitmap = SvPVX(mask);
396     for (i = 1; i < items; i++) {
397         on = PERMITING ? 0 : 1;         /* deny = mask bit on   */
398         if (verify_opset(aTHX_ ST(i),0)) {      /* it's a valid mask    */
399             opname = "(opset)";
400             bitspec = ST(i);
401         }
402         else {                          /* it's an opname/optag */
403             opname = SvPV(ST(i), len);
404             /* invert if op has ! prefix (only one allowed)     */
405             if (*opname == '!') { on = !on; ++opname; --len; }
406             bitspec = get_op_bitspec(aTHX_ opname, len, 1); /* croaks */
407         }
408         set_opset_bits(aTHX_ bitmap, bitspec, on, opname);
409     }
410     ST(0) = &PL_sv_yes;
411
412
413
414 void
415 opdesc(...)
416 PPCODE:
417     int i, myopcode;
418     STRLEN len;
419     SV **args;
420     char **op_desc = get_op_descs(); 
421     /* copy args to a scratch area since we may push output values onto */
422     /* the stack faster than we read values off it if masks are used.   */
423     args = (SV**)SvPVX(sv_2mortal(newSVpvn((char*)&ST(0), items*sizeof(SV*))));
424     for (i = 0; i < items; i++) {
425         char *opname = SvPV(args[i], len);
426         SV *bitspec = get_op_bitspec(aTHX_ opname, len, 1);
427         if (SvIOK(bitspec)) {
428             myopcode = SvIV(bitspec);
429             if (myopcode < 0 || myopcode >= PL_maxo)
430                 croak("panic: opcode %d (%s) out of range",myopcode,opname);
431             XPUSHs(sv_2mortal(newSVpv(op_desc[myopcode], 0)));
432         }
433         else if (SvPOK(bitspec) && SvCUR(bitspec) == opset_len) {
434             int b, j;
435             STRLEN n_a;
436             char *bitmap = SvPV(bitspec,n_a);
437             myopcode = 0;
438             for (b=0; b < opset_len; b++) {
439                 U16 bits = bitmap[b];
440                 for (j=0; j < 8 && myopcode < PL_maxo; j++, myopcode++)
441                     if (bits & (1 << j))
442                         XPUSHs(sv_2mortal(newSVpv(op_desc[myopcode], 0)));
443             }
444         }
445         else
446             croak("panic: invalid bitspec for \"%s\" (type %u)",
447                 opname, (unsigned)SvTYPE(bitspec));
448     }
449
450
451 void
452 define_optag(optagsv, mask)
453     SV *optagsv
454     SV *mask
455 CODE:
456     STRLEN len;
457     char *optag = SvPV(optagsv, len);
458     put_op_bitspec(aTHX_ optag, len, mask); /* croaks */
459     ST(0) = &PL_sv_yes;
460
461
462 void
463 empty_opset()
464 CODE:
465     ST(0) = sv_2mortal(new_opset(aTHX_ Nullsv));
466
467 void
468 full_opset()
469 CODE:
470     ST(0) = sv_2mortal(new_opset(aTHX_ opset_all));
471
472 void
473 opmask_add(opset)
474     SV *opset
475 PREINIT:
476     if (!PL_op_mask)
477         Newz(0, PL_op_mask, PL_maxo, char);
478 CODE:
479     opmask_add(aTHX_ opset);
480
481 void
482 opcodes()
483 PPCODE:
484     if (GIMME == G_ARRAY) {
485         croak("opcodes in list context not yet implemented"); /* XXX */
486     }
487     else {
488         XPUSHs(sv_2mortal(newSViv(PL_maxo)));
489     }
490
491 void
492 opmask()
493 CODE:
494     ST(0) = sv_2mortal(new_opset(aTHX_ Nullsv));
495     if (PL_op_mask) {
496         char *bitmap = SvPVX(ST(0));
497         int myopcode;
498         for(myopcode=0; myopcode < PL_maxo; ++myopcode) {
499             if (PL_op_mask[myopcode])
500                 bitmap[myopcode >> 3] |= 1 << (myopcode & 0x07);
501         }
502     }
503