3 # Regenerate (overwriting only if changed):
11 # * information stored in regen/opcodes;
12 # * information stored in regen/op_private (which is actually perl code);
13 # * the values hardcoded into this script in @raw_alias.
15 # Accepts the standard regen_lib -q and -v args.
17 # This script is normally invoked from regen.pl.
22 # Get function prototypes
23 require './regen/regen_lib.pl';
26 my $oc = open_new('opcode.h', '>',
27 {by => 'regen/opcode.pl', from => 'its data',
28 file => 'opcode.h', style => '*',
29 copyright => [1993 .. 2007]});
31 my $on = open_new('opnames.h', '>',
32 { by => 'regen/opcode.pl', from => 'its data', style => '*',
33 file => 'opnames.h', copyright => [1999 .. 2008] });
35 my $oprivpm = open_new('lib/B/Op_private.pm', '>',
36 { by => 'regen/opcode.pl',
37 from => "data in\nregen/op_private "
38 ."and pod embedded in regen/opcode.pl",
40 file => 'lib/B/Op_private.pm',
41 copyright => [2014 .. 2014] });
43 # Read 'opcodes' data.
46 my (@ops, %desc, %check, %ckname, %flags, %args, %opnum);
48 open OPS, '<', 'regen/opcodes' or die $!;
54 my ($key, $desc, $check, $flags, $args) = split(/\t+/, $_, 5);
55 $args = '' unless defined $args;
57 warn qq[Description "$desc" duplicates $seen{$desc}\n]
58 if $seen{$desc} and $key !~ "concat|transr|(?:intro|clone)cv|lvref";
59 die qq[Opcode "$key" duplicates $seen{$key}\n] if $seen{$key};
60 die qq[Opcode "freed" is reserved for the slab allocator\n]
62 $seen{$desc} = qq[description of opcode "$key"];
63 $seen{$key} = qq[opcode "$key"];
68 $check{$key} = $check;
70 $flags{$key} = $flags;
74 # Set up aliases, and alternative funcs
78 # Format is "this function" => "does these op names"
80 Perl_do_kv => [qw( keys values )],
81 Perl_unimplemented_op => [qw(padany custom)],
82 # All the ops with a body of { return NORMAL; }
83 Perl_pp_null => [qw(scalar regcmaybe lineseq scope)],
85 Perl_pp_goto => ['dump'],
86 Perl_pp_require => ['dofile'],
87 Perl_pp_untie => ['dbmclose'],
88 Perl_pp_sysread => {read => '', recv => '#ifdef HAS_SOCKET'},
89 Perl_pp_sysseek => ['seek'],
90 Perl_pp_ioctl => ['fcntl'],
91 Perl_pp_ssockopt => {gsockopt => '#ifdef HAS_SOCKET'},
92 Perl_pp_getpeername => {getsockname => '#ifdef HAS_SOCKET'},
93 Perl_pp_stat => ['lstat'],
94 Perl_pp_ftrowned => [qw(fteowned ftzero ftsock ftchr ftblk
95 ftfile ftdir ftpipe ftsuid ftsgid
97 Perl_pp_fttext => ['ftbinary'],
98 Perl_pp_gmtime => ['localtime'],
99 Perl_pp_semget => [qw(shmget msgget)],
100 Perl_pp_semctl => [qw(shmctl msgctl)],
101 Perl_pp_ghostent => [qw(ghbyname ghbyaddr)],
102 Perl_pp_gnetent => [qw(gnbyname gnbyaddr)],
103 Perl_pp_gprotoent => [qw(gpbyname gpbynumber)],
104 Perl_pp_gservent => [qw(gsbyname gsbyport)],
105 Perl_pp_gpwent => [qw(gpwnam gpwuid)],
106 Perl_pp_ggrent => [qw(ggrnam ggrgid)],
107 Perl_pp_ftis => [qw(ftsize ftmtime ftatime ftctime)],
108 Perl_pp_chown => [qw(unlink chmod utime kill)],
109 Perl_pp_link => ['symlink'],
110 Perl_pp_ftrread => [qw(ftrwrite ftrexec fteread ftewrite
112 Perl_pp_shmwrite => [qw(shmread msgsnd msgrcv semop)],
113 Perl_pp_syswrite => {send => '#ifdef HAS_SOCKET'},
114 Perl_pp_defined => [qw(dor dorassign)],
115 Perl_pp_and => ['andassign'],
116 Perl_pp_or => ['orassign'],
117 Perl_pp_ucfirst => ['lcfirst'],
118 Perl_pp_sle => [qw(slt sgt sge)],
119 Perl_pp_print => ['say'],
120 Perl_pp_index => ['rindex'],
121 Perl_pp_oct => ['hex'],
122 Perl_pp_shift => ['pop'],
123 Perl_pp_sin => [qw(cos exp log sqrt)],
124 Perl_pp_bit_or => ['bit_xor'],
125 Perl_pp_nbit_or => ['nbit_xor'],
126 Perl_pp_sbit_or => ['sbit_xor'],
127 Perl_pp_rv2av => ['rv2hv'],
128 Perl_pp_akeys => ['avalues'],
129 Perl_pp_trans => [qw(trans transr)],
130 Perl_pp_chop => [qw(chop chomp)],
131 Perl_pp_schop => [qw(schop schomp)],
132 Perl_pp_bind => {connect => '#ifdef HAS_SOCKET'},
133 Perl_pp_preinc => ['i_preinc'],
134 Perl_pp_predec => ['i_predec'],
135 Perl_pp_postinc => ['i_postinc'],
136 Perl_pp_postdec => ['i_postdec'],
137 Perl_pp_ehostent => [qw(enetent eprotoent eservent
138 spwent epwent sgrent egrent)],
139 Perl_pp_shostent => [qw(snetent sprotoent sservent)],
140 Perl_pp_aelemfast => ['aelemfast_lex'],
141 Perl_pp_grepstart => ['mapstart'],
143 # 2 i_modulo mappings: 2nd is alt, needs 1st (explicit default) to not override the default
144 Perl_pp_i_modulo => ['i_modulo'],
145 Perl_pp_i_modulo_glibc_bugfix => {
147 '#if defined(__GLIBC__) && IVSIZE == 8 '.
148 ' && ( __GLIBC__ < 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ < 8))' },
151 while (my ($func, $names) = splice @raw_alias, 0, 2) {
152 if (ref $names eq 'ARRAY') {
155 ? $alts{$_} : $alias{$_} = [$func, ''];
158 while (my ($opname, $cond) = each %$names) {
159 defined $alias{$opname}
160 ? $alts{$opname} : $alias{$opname} = [$func, $cond];
165 foreach my $sock_func (qw(socket bind listen accept shutdown
166 ssockopt getpeername)) {
167 $alias{$sock_func} = ["Perl_pp_$sock_func", '#ifdef HAS_SOCKET'],
172 # =================================================================
174 # Functions for processing regen/op_private data.
176 # Put them in a separate package so that croak() does the right thing
183 # the vars holding the global state built up by all the calls to addbits()
186 # map OPpLVAL_INTRO => LVINTRO
190 # the numeric values of flags - what will get output as a #define
193 # %BITFIELDS: the various bit field types. The key is the concatenation of
194 # all the field values that make up a bit field hash; the values are bit
195 # field hash refs. This allows us to de-dup identical bit field defs
196 # across different ops, and thus make the output tables more compact (esp
197 # important for the C version)
200 # %FLAGS: the main data structure. Indexed by op name, then bit index:
202 # $FLAGS{rv2av}{2} = 'OPpSLICEWARNING';
203 # bit field (bits 5 and 6):
204 # $FLAGS{rv2av}{5} = $FLAGS{rv2av}{6} = { .... };
208 # do, with checking, $LABELS{$name} = $label
211 my ($name, $label) = @_;
212 if (exists $LABELS{$name} and $LABELS{$name} ne $label) {
213 croak "addbits(): label for flag '$name' redefined:\n"
214 . " was '$LABELS{$name}', now '$label'";
216 $LABELS{$name} = $label;
220 # do, with checking, $DEFINES{$name} = $val
223 my ($name, $val) = @_;
224 if (exists $DEFINES{$name} && $DEFINES{$name} != $val) {
225 croak "addbits(): value for flag '$name' redefined:\n"
226 . " was $DEFINES{$name}, now $val";
228 $DEFINES{$name} = $val;
232 # intended to be called from regen/op_private; see that file for details
237 croak "too few arguments for addbits()" unless @args >= 3;
238 my $op = shift @args;
239 croak "invalid op name: '$op'" unless exists $opnum{$op};
242 my $bits = shift @args;
243 if ($bits =~ /^[0-7]$/) {
245 croak "addbits(): too few arguments for single bit flag"
247 my $flag_name = shift @args;
248 my $flag_label = shift @args;
249 add_label($flag_name, $flag_label);
250 croak "addbits(): bit $bits of $op already specified ($FLAGS{$op}{$bits})"
251 if defined $FLAGS{$op}{$bits};
252 $FLAGS{$op}{$bits} = $flag_name;
253 add_define($flag_name, (1 << $bits));
255 elsif ($bits =~ /^([0-7])\.\.([0-7])$/) {
257 my ($bitmin, $bitmax) = ($1,$2);
259 croak "addbits(): min bit > max bit in bit range '$bits'"
260 unless $bitmin <= $bitmax;
261 croak "addbits(): bit field argument missing"
264 my $arg_hash = shift @args;
265 croak "addbits(): arg to $bits must be a hash ref"
266 unless defined $arg_hash and ref($arg_hash) =~ /HASH/;
269 @valid_keys{qw(baseshift_def bitcount_def mask_def label enum)} = ();
270 for (keys %$arg_hash) {
271 croak "addbits(): unrecognised bifield key: '$_'"
272 unless exists $valid_keys{$_};
276 $bitmask += (1 << $_) for $bitmin..$bitmax;
280 if (defined $arg_hash->{enum}) {
281 my $enum = $arg_hash->{enum};
282 croak "addbits(): arg to enum must be an array ref"
283 unless defined $enum and ref($enum) =~ /ARRAY/;
284 croak "addbits(): enum list must be in triplets"
285 unless @$enum % 3 == 0;
287 my $max_id = (1 << ($bitmax - $bitmin + 1)) - 1;
291 my $enum_ix = shift @e;
292 my $enum_name = shift @e;
293 my $enum_label = shift @e;
294 croak "addbits(): enum index must be a number: '$enum_ix'"
295 unless $enum_ix =~ /^\d+$/;
296 croak "addbits(): enum index too big: '$enum_ix'"
297 unless $enum_ix <= $max_id;
298 add_label($enum_name, $enum_label);
299 add_define($enum_name, $enum_ix << $bitmin);
300 $enum_id .= "($enum_ix:$enum_name:$enum_label)";
304 # id is a fingerprint of all the content of the bit field hash
305 my $id = join ':', map defined() ? $_ : "-undef-",
308 $arg_hash->{mask_def},
309 $arg_hash->{baseshift_def},
310 $arg_hash->{bitcount_def},
313 unless (defined $BITFIELDS{$id}) {
315 if (defined $arg_hash->{mask_def}) {
316 add_define($arg_hash->{mask_def}, $bitmask);
319 if (defined $arg_hash->{baseshift_def}) {
320 add_define($arg_hash->{baseshift_def}, $bitmin);
323 if (defined $arg_hash->{bitcount_def}) {
324 add_define($arg_hash->{bitcount_def}, $bitmax-$bitmin+1);
330 for (qw(baseshift_def bitcount_def mask_def label)) {
331 $copy->{$_} = $arg_hash->{$_} if defined $arg_hash->{$_};
333 if (defined $arg_hash->{enum}) {
334 $copy->{enum} = [ @{$arg_hash->{enum}} ];
337 # and add some extra fields
339 $copy->{bitmask} = $bitmask;
340 $copy->{bitmin} = $bitmin;
341 $copy->{bitmax} = $bitmax;
343 $BITFIELDS{$id} = $copy;
346 for my $bit ($bitmin..$bitmax) {
347 croak "addbits(): bit $bit of $op already specified ($FLAGS{$op}{$bit})"
348 if defined $FLAGS{$op}{$bit};
349 $FLAGS{$op}{$bit} = $BITFIELDS{$id};
353 croak "addbits(): invalid bit specifier '$bits'";
359 # intended to be called from regen/op_private; see that file for details
361 sub ::ops_with_flag {
363 return grep $flags{$_} =~ /\Q$flag/, sort keys %flags;
367 # intended to be called from regen/op_private; see that file for details
369 sub ::ops_with_check {
371 return grep $check{$_} eq $c, sort keys %check;
375 # intended to be called from regen/op_private; see that file for details
378 my ($i, $arg_type) = @_;
380 for my $op (sort keys %args) {
381 my @args = split(' ',$args{$op});
382 push @ops, $op if defined $args[$i] and $args[$i] eq $arg_type;
388 # output '#define OPpLVAL_INTRO 0x80' etc
393 for (sort { $DEFINES{$a} <=> $DEFINES{$b} || $a cmp $b } keys %DEFINES) {
394 printf $fh "#define %-23s 0x%02x\n", $_, $DEFINES{$_};
399 # Generate the content of B::Op_private
401 sub print_B_Op_private {
404 my $header = <<'EOF';
407 @B::Op_private - OP op_private flag definitions
413 @ # flag details for bit 7 of OP_AELEM's op_private:
414 @ my $name = $B::Op_private::bits{aelem}{7}; # OPpLVAL_INTRO
415 @ my $value = $B::Op_private::defines{$name}; # 128
416 @ my $label = $B::Op_private::labels{$name}; # LVINTRO
418 @ # the bit field at bits 5..6 of OP_AELEM's op_private:
419 @ my $bf = $B::Op_private::bits{aelem}{6};
420 @ my $mask = $bf->{bitmask}; # etc
424 @This module provides four global hashes:
426 @ %B::Op_private::bits
427 @ %B::Op_private::defines
428 @ %B::Op_private::labels
429 @ %B::Op_private::ops_using
431 @which contain information about the per-op meanings of the bits in the
436 @This is indexed by op name and then bit number (0..7). For single bit flags,
437 @it returns the name of the define (if any) for that bit:
439 @ $B::Op_private::bits{aelem}{7} eq 'OPpLVAL_INTRO';
441 @For bit fields, it returns a hash ref containing details about the field.
442 @The same reference will be returned for all bit positions that make
443 @up the bit field; so for example these both return the same hash ref:
445 @ $bitfield = $B::Op_private::bits{aelem}{5};
446 @ $bitfield = $B::Op_private::bits{aelem}{6};
448 @The general format of this hash ref is
451 @ # The bit range and mask; these are always present.
456 @ # (The remaining keys are optional)
458 @ # The names of any defines that were requested:
459 @ mask_def => 'OPpFOO_MASK',
460 @ baseshift_def => 'OPpFOO_SHIFT',
461 @ bitcount_def => 'OPpFOO_BITS',
463 @ # If present, Concise etc will display the value with a 'FOO='
464 @ # prefix. If it equals '-', then Concise will treat the bit
465 @ # field as raw bits and not try to interpret it.
468 @ # If present, specifies the names of some defines and the
469 @ # display labels that are used to assign meaning to particu-
470 @ # lar integer values within the bit field; e.g. 3 is dis-
483 @This gives the value of every C<OPp> define, e.g.
485 @ $B::Op_private::defines{OPpLVAL_INTRO} == 128;
489 @This gives the short display label for each define, as used by C<B::Concise>
490 @and C<perl -Dx>, e.g.
492 @ $B::Op_private::labels{OPpLVAL_INTRO} eq 'LVINTRO';
494 @If the label equals '-', then Concise will treat the bit as a raw bit and
495 @not try to display it symbolically.
497 @=head2 C<%ops_using>
499 @For each define, this gives a reference to an array of op names that use
502 @ @ops_using_lvintro = @{ $B::Op_private::ops_using{OPp_LVAL_INTRO} };
506 package B::Op_private;
511 # remove podcheck.t-defeating leading char
512 $header =~ s/^\@//gm;
514 my $v = (::perl_version())[3];
515 print $fh qq{\nour \$VERSION = "$v";\n\n};
519 # for each flag/bit combination, find the ops which use it
521 for my $op (sort keys %FLAGS) {
522 my $entry = $FLAGS{$op};
524 my $e = $entry->{$bit};
525 next unless defined $e;
526 next if ref $e; # bit field, not flag
527 push @{$combos{$e}{$bit}}, $op;
528 push @{$ops_using{$e}}, $op;
532 # dump flags used by multiple ops
533 for my $flag (sort keys %combos) {
534 for my $bit (sort keys %{$combos{$flag}}) {
535 my $ops = $combos{$flag}{$bit};
536 next unless @$ops > 1;
538 print $fh "\$bits{\$_}{$bit} = '$flag' for qw(@o);\n";
542 # dump bit field definitions
547 # stringified-ref to ref mapping
548 $bitfields{$_} = $_ for values %BITFIELDS;
550 my $s = "\nmy \@bf = (\n";
551 for my $bitfield_key (sort keys %BITFIELDS) {
552 my $bitfield = $BITFIELDS{$bitfield_key};
554 $bitfield_ix{$bitfield} = $ix;
557 for (qw(label mask_def baseshift_def bitcount_def)) {
558 next unless defined $bitfield->{$_};
559 $s .= sprintf " %-9s => '%s',\n",
562 for (qw(bitmin bitmax bitmask)) {
563 croak "panic" unless defined $bitfield->{$_};
564 $s .= sprintf " %-9s => %d,\n",
567 if (defined $bitfield->{enum}) {
568 $s .= " enum => [\n";
569 my @enum = @{$bitfield->{enum}};
572 my $name = shift @enum;
573 my $label = shift @enum;
574 $s .= sprintf " %d, %-10s, %s,\n",
575 $i, "'$name'", "'$label'";
586 # dump bitfields and remaining labels
588 for my $op (sort keys %FLAGS) {
591 my $entry = $FLAGS{$op};
594 for ($bit = 7; $bit >= 0; $bit--) {
595 next unless defined $entry->{$bit};
596 my $e = $entry->{$bit};
598 my $ix = $bitfield_ix{$e};
599 for (reverse $e->{bitmin}..$e->{bitmax}) {
601 push @vals, "\$bf[$ix]";
606 next if @{$combos{$e}{$bit}} > 1; # already output
613 $s = '@{' if @indices > 1;
615 $s .= '}' if @indices > 1;
616 $s .= '{' . join(',', @indices) . '} = ';
617 $s .= '(' if @indices > 1;
618 $s .= join ', ', @vals;
619 $s .= ')' if @indices > 1;
624 # populate %defines and %labels
626 print $fh "\n\nour %defines = (\n";
627 printf $fh " %-23s => %3d,\n", $_ , $DEFINES{$_} for sort keys %DEFINES;
628 print $fh ");\n\nour %labels = (\n";
629 printf $fh " %-23s => '%s',\n", $_ , $LABELS{$_} for sort keys %LABELS;
633 print $fh "\n\nour %ops_using = (\n";
634 # Save memory by using the same array wherever possible.
637 for my $flag (sort keys %ops_using) {
638 my $op_list = $ops_using{$flag} = "@{$ops_using{$flag}}";
639 if (!exists $flag_by_op_list{$op_list}) {
640 $flag_by_op_list{$op_list} = $flag;
641 printf $fh " %-23s => %s,\n", $flag , "[qw($op_list)]"
644 $pending .= "\$ops_using{$flag} = "
645 . "\$ops_using{$flag_by_op_list{$op_list}};\n";
648 print $fh ");\n\n$pending";
654 # output the contents of the assorted PL_op_private_*[] tables
656 sub print_PL_op_private_tables {
659 my $PL_op_private_labels = '';
660 my $PL_op_private_valid = '';
661 my $PL_op_private_bitdef_ix = '';
662 my $PL_op_private_bitdefs = '';
663 my $PL_op_private_bitfields = '';
668 # generate $PL_op_private_labels
672 $labs{$_} = 1 for values %LABELS; # de-duplicate labels
673 # add in bit field labels
674 for (values %BITFIELDS) {
675 next unless defined $_->{label};
676 $labs{$_->{label}} = 1;
680 for my $lab (sort keys %labs) {
681 $label_ix{$lab} = length $labels;
683 $PL_op_private_labels .=
685 . join(',', map("'$_'", split //, $lab))
691 # generate PL_op_private_bitfields
695 # stringified-ref to ref mapping
696 $bitfields{$_} = $_ for values %BITFIELDS;
699 for my $bitfield_key (sort keys %BITFIELDS) {
700 my $bf = $BITFIELDS{$bitfield_key};
701 $bitfield_ix{$bf} = $ix;
704 push @b, $bf->{bitmin},
705 defined $bf->{label} ? $label_ix{$bf->{label}} : -1;
706 my $enum = $bf->{enum};
711 my $name = shift @enum;
712 my $label = shift @enum;
713 push @b, $i, $label_ix{$label};
716 push @b, -1; # terminate enum list
718 $PL_op_private_bitfields .= " " . join(', ', @b) .",\n";
724 # generate PL_op_private_bitdefs, PL_op_private_bitdef_ix
727 my $bitdef_count = 0;
729 my %not_seen = %FLAGS;
734 for my $op (sort { $opnum{$a} <=> $opnum{$b} } keys %opnum) {
736 die "panic: opnum misorder: opnum=$opnum opnum{op}=$opnum{$op}"
737 unless $opnum == $opnum{$op};
738 delete $not_seen{$op};
741 my $entry = $FLAGS{$op};
745 for ($bit = 7; $bit >= 0; $bit--) {
746 my $e = $entry->{$bit};
747 next unless defined $e;
751 $ix = $bitfield_ix{$e};
752 die "panic: \$bit =\= $e->{bitmax}"
753 unless $bit == $e->{bitmax};
755 push @bitdefs, ( ($ix << 5) | ($bit << 2) | 2 );
759 $ix = $label_ix{$LABELS{$e}};
760 die "panic: no label ix for '$e'" unless defined $ix;
761 push @bitdefs, ( ($ix << 5) | ($bit << 2));
764 die "Too many labels or bitfields (ix=$ix): "
765 . "maybe the type of PL_op_private_bitdefs needs "
766 . "expanding from U16 to U32???";
770 $bitdefs[-1] |= 1; # stop bit
771 my $key = join(', ', map(sprintf("0x%04x", $_), @bitdefs));
772 if (!$seen_bitdefs{$key}) {
773 $index = $bitdef_count;
774 $bitdef_count += @bitdefs;
776 $seen_bitdefs{$key} = [$index, $key];
779 $index = $seen_bitdefs{$key}[0];
781 push @{$seen_bitdefs{$key}}, $op;
786 $PL_op_private_bitdef_ix .= sprintf " %4d, /* %s */\n", $index, $op;
789 die "panic: unprocessed ops: ". join(',', keys %not_seen);
791 for (@seen_bitdefs) {
793 $PL_op_private_bitdefs .= " $$_[1], /* @$_[2..$#$_] */\n";
798 # generate PL_op_private_valid
804 next unless exists $FLAGS{$op};
805 my $entry = $FLAGS{$op}{$bit};
806 next unless defined $entry;
808 # skip later entries for the same bit field
809 next if defined $last and $last == $entry;
812 defined $entry->{mask_def}
822 @flags = '0xff' if $op eq 'null' or $op eq 'custom';
824 $PL_op_private_valid .= sprintf " /* %-10s */ (%s),\n", uc($op),
825 @flags ? join('|', @flags): '0';
831 #ifndef PERL_GLOBAL_STRUCT_INIT
835 /* data about the flags in op_private */
837 EXTCONST I16 PL_op_private_bitdef_ix[];
838 EXTCONST U16 PL_op_private_bitdefs[];
839 EXTCONST char PL_op_private_labels[];
840 EXTCONST I16 PL_op_private_bitfields[];
841 EXTCONST U8 PL_op_private_valid[];
846 /* PL_op_private_labels[]: the short descriptions of private flags.
847 * All labels are concatenated into a single char array
848 * (separated by \\0's) for compactness.
851 EXTCONST char PL_op_private_labels[] = {
852 $PL_op_private_labels
857 /* PL_op_private_bitfields[]: details about each bit field type.
858 * Each definition consists of the following list of words:
860 * label (index into PL_op_private_labels[]; -1 if no label)
861 * repeat for each enum entry (if any):
863 * enum label (index into PL_op_private_labels[])
867 EXTCONST I16 PL_op_private_bitfields[] = {
868 $PL_op_private_bitfields
872 /* PL_op_private_bitdef_ix[]: map an op number to a starting position
873 * in PL_op_private_bitdefs. If -1, the op has no bits defined */
875 EXTCONST I16 PL_op_private_bitdef_ix[] = {
876 $PL_op_private_bitdef_ix
881 /* PL_op_private_bitdefs[]: given a starting position in this array (as
882 * supplied by PL_op_private_bitdef_ix[]), each word (until a stop bit is
883 * seen) defines the meaning of a particular op_private bit for a
884 * particular op. Each word consists of:
885 * bit 0: stop bit: this is the last bit def for the current op
886 * bit 1: bitfield: if set, this defines a bit field rather than a flag
887 * bits 2..4: unsigned number in the range 0..7 which is the bit number
888 * bits 5..15: unsigned number in the range 0..2047 which is an index
889 * into PL_op_private_labels[] (for a flag), or
890 * into PL_op_private_bitfields[] (for a bit field)
893 EXTCONST U16 PL_op_private_bitdefs[] = {
894 $PL_op_private_bitdefs
898 /* PL_op_private_valid: for each op, indexed by op_type, indicate which
899 * flags bits in op_private are legal */
901 EXTCONST U8 PL_op_private_valid[] = {
905 # endif /* !DOINIT */
906 #endif /* !PERL_GLOBAL_STRUCT_INIT */
916 # =================================================================
921 # read regen/op_private data
923 # This file contains Perl code that builds up some data structures
924 # which define what bits in op_private have what meanings for each op.
925 # It populates %LABELS, %DEFINES, %FLAGS, %BITFIELDS.
927 require './regen/op_private';
930 #print Dumper \%LABELS, \%DEFINES, \%FLAGS, \%BITFIELDS;
935 print $oc "#ifndef PERL_GLOBAL_STRUCT_INIT\n\n";
942 if (@unimplemented) {
944 foreach (@unimplemented) {
945 print $oc "#define $_ Perl_unimplemented_op\n";
947 print $oc "#endif\n";
954 my ($impl, $cond) = @{$alias{$_} || ["Perl_pp_$_", '']};
955 my $op_func = "Perl_pp_$_";
957 if ($cond ne $last_cond) {
958 # A change in condition. (including to or from no condition)
962 print $oc "$last_cond\n";
965 push @unimplemented, $op_func if $last_cond;
966 print $oc "#define $op_func $impl\n" if $impl ne $op_func;
968 # If the last op was conditional, we need to close it out:
972 print $on "typedef enum opcode {\n";
976 print $on "\t", tab(3,"OP_\U$_"), " = ", $i++, ",\n";
978 print $on "\t", tab(3,"OP_max"), "\n";
979 print $on "} opcode;\n";
980 print $on "\n#define MAXO ", scalar @ops, "\n";
981 print $on "#define OP_FREED MAXO\n";
983 # Emit op names and descriptions.
989 EXTCONST char* const PL_op_name[];
991 EXTCONST char* const PL_op_name[] = {
995 print $oc qq(\t"$_",\n);
1004 EXTCONST char* const PL_op_desc[];
1006 EXTCONST char* const PL_op_desc[] = {
1010 my($safe_desc) = $desc{$_};
1012 # Have to escape double quotes and escape characters.
1013 $safe_desc =~ s/([\\"])/\\$1/g;
1015 print $oc qq(\t"$safe_desc",\n);
1025 #endif /* !PERL_GLOBAL_STRUCT_INIT */
1028 # Emit ppcode switch array.
1034 #ifdef PERL_GLOBAL_STRUCT_INIT
1035 # define PERL_PPADDR_INITED
1036 static const Perl_ppaddr_t Gppaddr[]
1037 #elif !defined(PERL_GLOBAL_STRUCT)
1038 # define PERL_PPADDR_INITED
1039 EXT Perl_ppaddr_t PL_ppaddr[] /* or perlvars.h */
1040 #endif /* PERL_GLOBAL_STRUCT */
1041 #if (defined(DOINIT) && !defined(PERL_GLOBAL_STRUCT)) || defined(PERL_GLOBAL_STRUCT_INIT)
1042 # define PERL_PPADDR_INITED
1047 my $op_func = "Perl_pp_$_";
1048 my $name = $alias{$_};
1049 if ($name && $name->[0] ne $op_func) {
1050 print $oc "\t$op_func,\t/* implemented by $name->[0] */\n";
1053 print $oc "\t$op_func,\n";
1060 #ifdef PERL_PPADDR_INITED
1064 #ifdef PERL_GLOBAL_STRUCT_INIT
1065 # define PERL_CHECK_INITED
1066 static const Perl_check_t Gcheck[]
1067 #elif !defined(PERL_GLOBAL_STRUCT)
1068 # define PERL_CHECK_INITED
1069 EXT Perl_check_t PL_check[] /* or perlvars.h */
1071 #if (defined(DOINIT) && !defined(PERL_GLOBAL_STRUCT)) || defined(PERL_GLOBAL_STRUCT_INIT)
1072 # define PERL_CHECK_INITED
1077 print $oc "\t", tab(3, "Perl_$check{$_},"), "\t/* $_ */\n";
1083 #ifdef PERL_CHECK_INITED
1085 #endif /* #ifdef PERL_CHECK_INITED */
1087 #ifndef PERL_GLOBAL_STRUCT_INIT
1090 EXTCONST U32 PL_opargs[];
1092 EXTCONST U32 PL_opargs[] = {
1095 # Emit allowed argument types.
1102 'A', 3, # array value
1103 'H', 4, # hash value
1104 'C', 5, # code value
1105 'F', 6, # file value
1106 'R', 7, # scalar reference
1116 '$', 6, # svop_or_padop
1118 '"', 8, # pvop_or_svop
1121 '%', 11, # baseop_or_unop
1122 '-', 12, # filestatop
1129 'm' => 1, # needs stack mark
1130 'f' => 2, # fold constants
1131 's' => 4, # always produces scalar
1132 't' => 8, # needs target scalar
1133 'T' => 8 | 16, # ... which may be lexical
1134 'i' => 0, # always produces integer (unused since e7311069)
1135 'I' => 32, # has corresponding int op
1136 'd' => 64, # danger, make temp copy in list assignment
1137 'u' => 128, # defaults to $_
1140 my %OP_IS_SOCKET; # /Fs/
1141 my %OP_IS_FILETEST; # /F-/
1142 my %OP_IS_FT_ACCESS; # /F-+/
1143 my %OP_IS_NUMCOMPARE; # /S</
1144 my %OP_IS_DIRHOP; # /Fd/
1145 my %OP_IS_INFIX_BIT; # /S\|/
1152 my $flags = $flags{$op};
1153 for my $flag (keys %opflags) {
1154 if ($flags =~ s/$flag//) {
1155 die "Flag collision for '$op' ($flags{$op}, $flag)\n"
1156 if $argsum & $opflags{$flag};
1157 $argsum |= $opflags{$flag};
1160 die qq[Opcode '$op' has no class indicator ($flags{$op} => $flags)\n]
1161 unless exists $opclass{$flags};
1162 $argsum |= $opclass{$flags} << $OCSHIFT;
1163 my $argshift = $OASHIFT;
1164 for my $arg (split(' ',$args{$op})) {
1165 if ($arg =~ s/^D//) {
1166 # handle 1st, just to put D 1st.
1167 $OP_IS_DIRHOP{$op} = $opnum{$op};
1170 # record opnums of these opnames
1171 $OP_IS_SOCKET{$op} = $opnum{$op} if $arg =~ s/s//;
1172 $OP_IS_FILETEST{$op} = $opnum{$op} if $arg =~ s/-//;
1173 $OP_IS_FT_ACCESS{$op} = $opnum{$op} if $arg =~ s/\+//;
1175 elsif ($arg =~ /^S./) {
1176 $OP_IS_NUMCOMPARE{$op} = $opnum{$op} if $arg =~ s/<//;
1177 $OP_IS_INFIX_BIT {$op} = $opnum{$op} if $arg =~ s/\|//;
1179 my $argnum = ($arg =~ s/\?//) ? 8 : 0;
1180 die "op = $op, arg = $arg\n"
1181 unless exists $argnum{$arg};
1182 $argnum += $argnum{$arg};
1183 die "Argument overflow for '$op'\n"
1184 if $argshift >= $ARGBITS ||
1185 $argnum > ((1 << ($ARGBITS - $argshift)) - 1);
1186 $argsum += $argnum << $argshift;
1189 $argsum = sprintf("0x%08x", $argsum);
1190 print $oc "\t", tab(3, "$argsum,"), "/* $op */\n";
1197 #endif /* !PERL_GLOBAL_STRUCT_INIT */
1202 # Emit OP_IS_* macros
1204 print $on <<'EO_OP_IS_COMMENT';
1206 /* the OP_IS_* macros are optimized to a simple range check because
1207 all the member OPs are contiguous in regen/opcodes table.
1208 opcode.pl verifies the range contiguity, or generates an OR-equals
1212 gen_op_is_macro( \%OP_IS_SOCKET, 'OP_IS_SOCKET');
1213 gen_op_is_macro( \%OP_IS_FILETEST, 'OP_IS_FILETEST');
1214 gen_op_is_macro( \%OP_IS_FT_ACCESS, 'OP_IS_FILETEST_ACCESS');
1215 gen_op_is_macro( \%OP_IS_NUMCOMPARE, 'OP_IS_NUMCOMPARE');
1216 gen_op_is_macro( \%OP_IS_DIRHOP, 'OP_IS_DIRHOP');
1217 gen_op_is_macro( \%OP_IS_INFIX_BIT, 'OP_IS_INFIX_BIT');
1219 sub gen_op_is_macro {
1220 my ($op_is, $macname) = @_;
1223 # get opnames whose numbers are lowest and highest
1224 my ($first, @rest) = sort {
1225 $op_is->{$a} <=> $op_is->{$b}
1228 my $last = pop @rest; # @rest slurped, get its last
1229 die "Invalid range of ops: $first .. $last\n" unless $last;
1231 print $on "\n#define $macname(op) \\\n\t(";
1233 # verify that op-ct matches 1st..last range (and fencepost)
1234 # (we know there are no dups)
1235 if ( $op_is->{$last} - $op_is->{$first} == scalar @rest + 1) {
1237 # contiguous ops -> optimized version
1238 print $on "(op) >= OP_" . uc($first)
1239 . " && (op) <= OP_" . uc($last);
1242 print $on join(" || \\\n\t ",
1243 map { "(op) == OP_" . uc() } sort keys %$op_is);
1249 my $pp = open_new('pp_proto.h', '>',
1250 { by => 'opcode.pl', from => 'its data' });
1255 my $name = $alias{$_} ? $alias{$_}[0] : "Perl_pp_$_";
1258 print $pp "PERL_CALLCONV OP *$_(pTHX);\n" foreach sort keys %funcs;
1260 print $pp "\n/* alternative functions */\n" if keys %alts;
1261 for my $fn (sort keys %alts) {
1262 my ($x, $cond) = @{$alts{$fn}};
1263 print $pp "$cond\n" if $cond;
1264 print $pp "PERL_CALLCONV OP *$x(pTHX);\n";
1265 print $pp "#endif\n" if $cond;
1270 OP_PRIVATE::print_defines($oc);
1271 OP_PRIVATE::print_PL_op_private_tables($oc);
1273 OP_PRIVATE::print_B_Op_private($oprivpm);
1275 foreach ($oc, $on, $pp, $oprivpm) {
1276 read_only_bottom_close_and_rename($_);