This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
B::Debug enhancements
[perl5.git] / opcode.pl
CommitLineData
d6480c9d
NC
1#!/usr/bin/perl -w
2use strict;
3
36bb303b
NC
4BEGIN {
5 # Get function prototypes
9ad884cb 6 require 'regen_lib.pl';
36bb303b 7}
79072805 8
d6480c9d
NC
9my $opcode_new = 'opcode.h-new';
10my $opname_new = 'opnames.h-new';
bb6f4497 11open(OC, ">$opcode_new") || die "Can't create $opcode_new: $!\n";
dfb1454f 12binmode OC;
bb6f4497 13open(ON, ">$opname_new") || die "Can't create $opname_new: $!\n";
dfb1454f 14binmode ON;
79072805
LW
15select OC;
16
17# Read data.
18
d6480c9d 19my %seen;
e71197e2 20my (@ops, %desc, %check, %ckname, %flags, %args, %opnum);
d6480c9d 21
79072805
LW
22while (<DATA>) {
23 chop;
24 next unless $_;
25 next if /^#/;
d6480c9d
NC
26 my ($key, $desc, $check, $flags, $args) = split(/\t+/, $_, 5);
27 $args = '' unless defined $args;
c07a80fd
PP
28
29 warn qq[Description "$desc" duplicates $seen{$desc}\n] if $seen{$desc};
30 die qq[Opcode "$key" duplicates $seen{$key}\n] if $seen{$key};
31 $seen{$desc} = qq[description of opcode "$key"];
32 $seen{$key} = qq[opcode "$key"];
33
79072805 34 push(@ops, $key);
e71197e2 35 $opnum{$key} = $#ops;
c07a80fd 36 $desc{$key} = $desc;
79072805
LW
37 $check{$key} = $check;
38 $ckname{$check}++;
39 $flags{$key} = $flags;
40 $args{$key} = $args;
41}
42
1d5774de
NC
43# Set up aliases
44
45my %alias;
46
47# Format is "this function" => "does these op names"
48my @raw_alias = (
6faeeb49 49 Perl_do_kv => [qw( keys values )],
d83386fa 50 Perl_unimplemented_op => [qw(padany mapstart custom)],
0b612f93
NC
51 # All the ops with a body of { return NORMAL; }
52 Perl_pp_null => [qw(scalar regcmaybe lineseq scope)],
53
54 Perl_pp_goto => ['dump'],
55 Perl_pp_require => ['dofile'],
56 Perl_pp_untie => ['dbmclose'],
57 Perl_pp_sysread => [qw(read recv)],
58 Perl_pp_sysseek => ['seek'],
59 Perl_pp_ioctl => ['fcntl'],
60 Perl_pp_ssockopt => ['gsockopt'],
61 Perl_pp_getpeername => ['getsockname'],
62 Perl_pp_stat => ['lstat'],
f1cb2d48 63 Perl_pp_ftrowned => [qw(fteowned ftzero ftsock ftchr ftblk
17ad201a
NC
64 ftfile ftdir ftpipe ftsuid ftsgid
65 ftsvtx)],
0b612f93
NC
66 Perl_pp_fttext => ['ftbinary'],
67 Perl_pp_gmtime => ['localtime'],
68 Perl_pp_semget => [qw(shmget msgget)],
69 Perl_pp_semctl => [qw(shmctl msgctl)],
0b612f93
NC
70 Perl_pp_ghostent => [qw(ghbyname ghbyaddr)],
71 Perl_pp_gnetent => [qw(gnbyname gnbyaddr)],
72 Perl_pp_gprotoent => [qw(gpbyname gpbynumber)],
73 Perl_pp_gservent => [qw(gsbyname gsbyport)],
74 Perl_pp_gpwent => [qw(gpwnam gpwuid)],
75 Perl_pp_ggrent => [qw(ggrnam ggrgid)],
957b0e1d 76 Perl_pp_ftis => [qw(ftsize ftmtime ftatime ftctime)],
605b9385 77 Perl_pp_chown => [qw(unlink chmod utime kill)],
ce6987d0 78 Perl_pp_link => ['symlink'],
af9e49b4
NC
79 Perl_pp_ftrread => [qw(ftrwrite ftrexec fteread ftewrite
80 fteexec)],
ca563b4e 81 Perl_pp_shmwrite => [qw(shmread msgsnd msgrcv semop)],
64a1bc8e 82 Perl_pp_send => ['syswrite'],
c960fc3b 83 Perl_pp_defined => [qw(dor dorassign)],
62726f23
SP
84 Perl_pp_and => ['andassign'],
85 Perl_pp_or => ['orassign'],
12e9c124 86 Perl_pp_ucfirst => ['lcfirst'],
afd9910b 87 Perl_pp_sle => [qw(slt sgt sge)],
0d863452 88 Perl_pp_print => ['say'],
2723d216 89 Perl_pp_index => ['rindex'],
daa2adfd 90 Perl_pp_oct => ['hex'],
789b4bc9 91 Perl_pp_shift => ['pop'],
71302fe3 92 Perl_pp_sin => [qw(cos exp log sqrt)],
3658c1f1 93 Perl_pp_bit_or => ['bit_xor'],
17ab7946 94 Perl_pp_rv2av => ['rv2hv'],
878d132a 95 Perl_pp_akeys => ['avalues'],
605b9385 96 );
1d5774de
NC
97
98while (my ($func, $names) = splice @raw_alias, 0, 2) {
6faeeb49 99 $alias{$_} = $func for @$names;
1d5774de
NC
100}
101
79072805
LW
102# Emit defines.
103
748a9306 104print <<"END";
37442d52
RGS
105/* -*- buffer-read-only: t -*-
106 *
d6376244
JH
107 * opcode.h
108 *
699a97de
RGS
109 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
110 * 2001, 2002, 2003, 2004, 2005, 2006, 2007 by Larry Wall and others
d6376244
JH
111 *
112 * You may distribute under the terms of either the GNU General Public
113 * License or the Artistic License, as specified in the README file.
114 *
115 * !!!!!!! DO NOT EDIT THIS FILE !!!!!!!
116 * This file is built by opcode.pl from its data. Any changes made here
117 * will be lost!
118 */
a27f85b3 119
27da23d5
JH
120#ifndef PERL_GLOBAL_STRUCT_INIT
121
864dbfa3
GS
122#define Perl_pp_i_preinc Perl_pp_preinc
123#define Perl_pp_i_predec Perl_pp_predec
124#define Perl_pp_i_postinc Perl_pp_postinc
125#define Perl_pp_i_postdec Perl_pp_postdec
748a9306 126
65bca31a
NC
127PERL_PPDEF(Perl_unimplemented_op)
128
748a9306 129END
abdd5c84
GS
130
131print ON <<"END";
37442d52
RGS
132/* -*- buffer-read-only: t -*-
133 *
d6376244
JH
134 * opnames.h
135 *
cfc85103 136 * Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
699a97de 137 * 2007 by Larry Wall and others
d6376244
JH
138 *
139 * You may distribute under the terms of either the GNU General Public
140 * License or the Artistic License, as specified in the README file.
141 *
142 *
143 * !!!!!!! DO NOT EDIT THIS FILE !!!!!!!
144 * This file is built by opcode.pl from its data. Any changes made here
145 * will be lost!
146 */
abdd5c84
GS
147
148typedef enum opcode {
149END
150
d6480c9d 151my $i = 0;
79072805 152for (@ops) {
e71197e2
JC
153 # print ON "\t", &tab(3,"OP_\U$_,"), "/* ", $i++, " */\n";
154 print ON "\t", &tab(3,"OP_\U$_"), " = ", $i++, ",\n";
79072805 155}
abdd5c84
GS
156print ON "\t", &tab(3,"OP_max"), "\n";
157print ON "} opcode;\n";
4c80c0b2
NC
158print ON "\n#define MAXO ", scalar @ops, "\n";
159print ON "#define OP_phoney_INPUT_ONLY -1\n";
160print ON "#define OP_phoney_OUTPUT_ONLY -2\n\n";
79072805 161
c07a80fd 162# Emit op names and descriptions.
79072805
LW
163
164print <<END;
73c4f7a1
GS
165START_EXTERN_C
166
4a36906c
RGS
167#define OP_NAME(o) ((o)->op_type == OP_CUSTOM ? custom_op_name(o) : \\
168 PL_op_name[(o)->op_type])
169#define OP_DESC(o) ((o)->op_type == OP_CUSTOM ? custom_op_desc(o) : \\
170 PL_op_desc[(o)->op_type])
53e06cf0 171
79072805 172#ifndef DOINIT
27da23d5 173EXTCONST char* const PL_op_name[];
79072805 174#else
27da23d5 175EXTCONST char* const PL_op_name[] = {
79072805
LW
176END
177
178for (@ops) {
c07a80fd
PP
179 print qq(\t"$_",\n);
180}
181
182print <<END;
183};
184#endif
185
186END
187
188print <<END;
189#ifndef DOINIT
27da23d5 190EXTCONST char* const PL_op_desc[];
c07a80fd 191#else
27da23d5 192EXTCONST char* const PL_op_desc[] = {
c07a80fd
PP
193END
194
195for (@ops) {
42d38218
MS
196 my($safe_desc) = $desc{$_};
197
a567e93b 198 # Have to escape double quotes and escape characters.
42d38218
MS
199 $safe_desc =~ s/(^|[^\\])([\\"])/$1\\$2/g;
200
201 print qq(\t"$safe_desc",\n);
79072805
LW
202}
203
204print <<END;
205};
206#endif
207
73c4f7a1
GS
208END_EXTERN_C
209
27da23d5 210#endif /* !PERL_GLOBAL_STRUCT_INIT */
22c35a8c 211END
79072805 212
22c35a8c 213# Emit function declarations.
79072805 214
22c35a8c 215#for (sort keys %ckname) {
cea2e8a9 216# print "OP *\t", &tab(3,$_),"(pTHX_ OP* o);\n";
22c35a8c
GS
217#}
218#
219#print "\n";
220#
221#for (@ops) {
cea2e8a9 222# print "OP *\t", &tab(3, "pp_$_"), "(pTHX);\n";
22c35a8c 223#}
79072805
LW
224
225# Emit ppcode switch array.
226
227print <<END;
228
73c4f7a1
GS
229START_EXTERN_C
230
27da23d5 231#ifdef PERL_GLOBAL_STRUCT_INIT
97aff369 232# define PERL_PPADDR_INITED
27da23d5 233static const Perl_ppaddr_t Gppaddr[]
79072805 234#else
27da23d5 235# ifndef PERL_GLOBAL_STRUCT
97aff369 236# define PERL_PPADDR_INITED
27da23d5
JH
237EXT Perl_ppaddr_t PL_ppaddr[] /* or perlvars.h */
238# endif
239#endif /* PERL_GLOBAL_STRUCT */
240#if (defined(DOINIT) && !defined(PERL_GLOBAL_STRUCT)) || defined(PERL_GLOBAL_STRUCT_INIT)
97aff369 241# define PERL_PPADDR_INITED
27da23d5 242= {
79072805
LW
243END
244
245for (@ops) {
6faeeb49
MB
246 if (my $name = $alias{$_}) {
247 print "\tMEMBER_TO_FPTR($name),\t/* Perl_pp_$_ */\n";
248 }
249 else {
250 print "\tMEMBER_TO_FPTR(Perl_pp_$_),\n";
251 }
79072805
LW
252}
253
254print <<END;
27da23d5 255}
79072805 256#endif
97aff369 257#ifdef PERL_PPADDR_INITED
27da23d5 258;
97aff369 259#endif
79072805
LW
260
261END
262
263# Emit check routines.
264
265print <<END;
27da23d5 266#ifdef PERL_GLOBAL_STRUCT_INIT
97aff369 267# define PERL_CHECK_INITED
27da23d5 268static const Perl_check_t Gcheck[]
79072805 269#else
27da23d5 270# ifndef PERL_GLOBAL_STRUCT
97aff369 271# define PERL_CHECK_INITED
27da23d5
JH
272EXT Perl_check_t PL_check[] /* or perlvars.h */
273# endif
274#endif
275#if (defined(DOINIT) && !defined(PERL_GLOBAL_STRUCT)) || defined(PERL_GLOBAL_STRUCT_INIT)
97aff369 276# define PERL_CHECK_INITED
27da23d5 277= {
79072805
LW
278END
279
280for (@ops) {
2b260de0 281 print "\t", &tab(3, "MEMBER_TO_FPTR(Perl_$check{$_}),"), "\t/* $_ */\n";
79072805
LW
282}
283
284print <<END;
27da23d5 285}
79072805 286#endif
97aff369 287#ifdef PERL_CHECK_INITED
27da23d5 288;
97aff369 289#endif /* #ifdef PERL_CHECK_INITED */
79072805
LW
290
291END
292
293# Emit allowed argument types.
294
c2dedb93
MHM
295my $ARGBITS = 32;
296
79072805 297print <<END;
27da23d5
JH
298#ifndef PERL_GLOBAL_STRUCT_INIT
299
79072805 300#ifndef DOINIT
1ccb7c8d 301EXTCONST U32 PL_opargs[];
79072805 302#else
1ccb7c8d 303EXTCONST U32 PL_opargs[] = {
79072805
LW
304END
305
d6480c9d
NC
306my %argnum = (
307 'S', 1, # scalar
308 'L', 2, # list
309 'A', 3, # array value
310 'H', 4, # hash value
311 'C', 5, # code value
312 'F', 6, # file value
313 'R', 7, # scalar reference
79072805
LW
314);
315
d6480c9d 316my %opclass = (
db173bac
MB
317 '0', 0, # baseop
318 '1', 1, # unop
319 '2', 2, # binop
320 '|', 3, # logop
1a67a97c
SM
321 '@', 4, # listop
322 '/', 5, # pmop
350de78d 323 '$', 6, # svop_or_padop
7934575e 324 '#', 7, # padop
1a67a97c
SM
325 '"', 8, # pvop_or_svop
326 '{', 9, # loop
327 ';', 10, # cop
328 '%', 11, # baseop_or_unop
329 '-', 12, # filestatop
330 '}', 13, # loopexop
db173bac
MB
331);
332
c2dedb93
MHM
333my %opflags = (
334 'm' => 1, # needs stack mark
335 'f' => 2, # fold constants
336 's' => 4, # always produces scalar
337 't' => 8, # needs target scalar
338 'T' => 8 | 256, # ... which may be lexical
339 'i' => 16, # always produces integer
340 'I' => 32, # has corresponding int op
341 'd' => 64, # danger, unknown side effects
342 'u' => 128, # defaults to $_
343);
344
a85d93d9
JH
345my %OP_IS_SOCKET;
346my %OP_IS_FILETEST;
c2dedb93
MHM
347my $OCSHIFT = 9;
348my $OASHIFT = 13;
a85d93d9 349
c2dedb93 350for my $op (@ops) {
d6480c9d 351 my $argsum = 0;
c2dedb93
MHM
352 my $flags = $flags{$op};
353 for my $flag (keys %opflags) {
354 if ($flags =~ s/$flag//) {
355 die "Flag collision for '$op' ($flags{$op}, $flag)"
356 if $argsum & $opflags{$flag};
357 $argsum |= $opflags{$flag};
358 }
359 }
360 die qq[Opcode '$op' has no class indicator ($flags{$op} => $flags)]
361 unless exists $opclass{$flags};
362 $argsum |= $opclass{$flags} << $OCSHIFT;
363 my $argshift = $OASHIFT;
364 for my $arg (split(' ',$args{$op})) {
a85d93d9 365 if ($arg =~ /^F/) {
e71197e2
JC
366 # record opnums of these opnames
367 $OP_IS_SOCKET{$op} = $opnum{$op} if $arg =~ s/s//;
368 $OP_IS_FILETEST{$op} = $opnum{$op} if $arg =~ s/-//;
a85d93d9 369 }
d6480c9d 370 my $argnum = ($arg =~ s/\?//) ? 8 : 0;
c2dedb93
MHM
371 die "op = $op, arg = $arg\n"
372 unless exists $argnum{$arg};
79072805 373 $argnum += $argnum{$arg};
c2dedb93
MHM
374 die "Argument overflow for '$op'\n"
375 if $argshift >= $ARGBITS ||
376 $argnum > ((1 << ($ARGBITS - $argshift)) - 1);
377 $argsum += $argnum << $argshift;
378 $argshift += 4;
79072805
LW
379 }
380 $argsum = sprintf("0x%08x", $argsum);
c2dedb93 381 print "\t", &tab(3, "$argsum,"), "/* $op */\n";
79072805
LW
382}
383
384print <<END;
385};
386#endif
73c4f7a1 387
bae1192d
JH
388#endif /* !PERL_GLOBAL_STRUCT_INIT */
389
73c4f7a1 390END_EXTERN_C
27da23d5 391
79072805
LW
392END
393
e71197e2
JC
394# Emit OP_IS_* macros
395
396print ON <<EO_OP_IS_COMMENT;
397
398/* the OP_IS_(SOCKET|FILETEST) macros are optimized to a simple range
399 check because all the member OPs are contiguous in opcode.pl
400 <DATA> table. opcode.pl verifies the range contiguity. */
401
402EO_OP_IS_COMMENT
403
404gen_op_is_macro( \%OP_IS_SOCKET, 'OP_IS_SOCKET');
405gen_op_is_macro( \%OP_IS_FILETEST, 'OP_IS_FILETEST');
406
407sub gen_op_is_macro {
408 my ($op_is, $macname) = @_;
409 if (keys %$op_is) {
410
411 # get opnames whose numbers are lowest and highest
412 my ($first, @rest) = sort {
413 $op_is->{$a} <=> $op_is->{$b}
414 } keys %$op_is;
415
416 my $last = pop @rest; # @rest slurped, get its last
417
418 # verify that op-ct matches 1st..last range (and fencepost)
419 # (we know there are no dups)
420 if ( $op_is->{$last} - $op_is->{$first} == scalar @rest + 1) {
421
422 # contiguous ops -> optimized version
423 print ON "#define $macname(op) \\\n\t(";
424 print ON "(op) >= OP_" . uc($first) . " && (op) <= OP_" . uc($last);
425 print ON ")\n\n";
426 }
427 else {
428 print ON "\n#define $macname(op) \\\n\t(";
429 print ON join(" || \\\n\t ",
430 map { "(op) == OP_" . uc() } sort keys %OP_IS_SOCKET);
431 print ON ")\n\n";
432 }
433 }
a85d93d9
JH
434}
435
37442d52
RGS
436print OC "/* ex: set ro: */\n";
437print ON "/* ex: set ro: */\n";
438
735e0d5c 439close OC or die "Error closing opcode.h: $!";
abdd5c84 440close ON or die "Error closing opnames.h: $!";
735e0d5c 441
36bb303b
NC
442foreach ('opcode.h', 'opnames.h') {
443 safer_rename_silent $_, "$_-old";
444}
445safer_rename $opcode_new, 'opcode.h';
446safer_rename $opname_new, 'opnames.h';
46f659cb 447
d6480c9d
NC
448my $pp_proto_new = 'pp_proto.h-new';
449my $pp_sym_new = 'pp.sym-new';
bb6f4497
CL
450
451open PP, ">$pp_proto_new" or die "Error creating $pp_proto_new: $!";
dfb1454f 452binmode PP;
bb6f4497 453open PPSYM, ">$pp_sym_new" or die "Error creating $pp_sym_new: $!";
dfb1454f 454binmode PPSYM;
22c35a8c 455
a27f85b3 456print PP <<"END";
37442d52
RGS
457/* -*- buffer-read-only: t -*-
458 !!!!!!! DO NOT EDIT THIS FILE !!!!!!!
a27f85b3
GS
459 This file is built by opcode.pl from its data. Any changes made here
460 will be lost!
461*/
462
463END
464
465print PPSYM <<"END";
37442d52 466# -*- buffer-read-only: t -*-
a27f85b3 467#
a567e93b 468# !!!!!!! DO NOT EDIT THIS FILE !!!!!!!
a27f85b3
GS
469# This file is built by opcode.pl from its data. Any changes made here
470# will be lost!
471#
472
473END
474
475
22c35a8c 476for (sort keys %ckname) {
864dbfa3
GS
477 print PP "PERL_CKDEF(Perl_$_)\n";
478 print PPSYM "Perl_$_\n";
20ce7b12 479#OP *\t", &tab(3,$_),"(OP* o);\n";
22c35a8c
GS
480}
481
482print PP "\n\n";
483
735e0d5c 484for (@ops) {
15e52e56 485 next if /^i_(pre|post)(inc|dec)$/;
53e06cf0 486 next if /^custom$/;
864dbfa3
GS
487 print PP "PERL_PPDEF(Perl_pp_$_)\n";
488 print PPSYM "Perl_pp_$_\n";
735e0d5c 489}
37442d52
RGS
490print PP "\n/* ex: set ro: */\n";
491print PPSYM "\n# ex: set ro:\n";
735e0d5c
IZ
492
493close PP or die "Error closing pp_proto.h: $!";
22c35a8c 494close PPSYM or die "Error closing pp.sym: $!";
735e0d5c 495
36bb303b
NC
496foreach ('pp_proto.h', 'pp.sym') {
497 safer_rename_silent $_, "$_-old";
498}
499safer_rename $pp_proto_new, 'pp_proto.h';
500safer_rename $pp_sym_new, 'pp.sym';
46f659cb 501
24600adc
JH
502END {
503 foreach ('opcode.h', 'opnames.h', 'pp_proto.h', 'pp.sym') {
504 1 while unlink "$_-old";
505 }
506}
507
79072805
LW
508###########################################################################
509sub tab {
d6480c9d 510 my ($l, $t) = @_;
79072805
LW
511 $t .= "\t" x ($l - (length($t) + 1) / 8);
512 $t;
513}
514###########################################################################
b162f9ea
IZ
515
516# Some comments about 'T' opcode classifier:
517
518# Safe to set if the ppcode uses:
519# tryAMAGICbin, tryAMAGICun, SETn, SETi, SETu, PUSHn, PUSHTARG, SETTARG,
520# SETs(TARG), XPUSHn, XPUSHu,
521
522# Unsafe to set if the ppcode uses dTARG or [X]RETPUSH[YES|NO|UNDEF]
523
524# lt and friends do SETs (including ncmp, but not scmp)
525
21f5b33c
GS
526# Additional mode of failure: the opcode can modify TARG before it "used"
527# all the arguments (or may call an external function which does the same).
528# If the target coincides with one of the arguments ==> kaboom.
529
b162f9ea
IZ
530# pp.c pos substr each not OK (RETPUSHUNDEF)
531# substr vec also not OK due to LV to target (are they???)
532# ref not OK (RETPUSHNO)
533# trans not OK (dTARG; TARG = sv_newmortal();)
534# ucfirst etc not OK: TMP arg processed inplace
69b47968 535# quotemeta not OK (unsafe when TARG == arg)
91e74348 536# each repeat not OK too due to list context
b162f9ea 537# pack split - unknown whether they are safe
dae78bb1
IZ
538# sprintf: is calling do_sprintf(TARG,...) which can act on TARG
539# before other args are processed.
b162f9ea 540
21f5b33c
GS
541# Suspicious wrt "additional mode of failure" (and only it):
542# schop, chop, postinc/dec, bit_and etc, negate, complement.
543
544# Also suspicious: 4-arg substr, sprintf, uc/lc (POK_only), reverse, pack.
545
546# substr/vec: doing TAINT_off()???
547
b162f9ea
IZ
548# pp_hot.c
549# readline - unknown whether it is safe
550# match subst not OK (dTARG)
551# grepwhile not OK (not always setting)
69b47968 552# join not OK (unsafe when TARG == arg)
b162f9ea 553
21f5b33c
GS
554# Suspicious wrt "additional mode of failure": concat (dealt with
555# in ck_sassign()), join (same).
556
b162f9ea
IZ
557# pp_ctl.c
558# mapwhile flip caller not OK (not always setting)
559
560# pp_sys.c
561# backtick glob warn die not OK (not always setting)
562# warn not OK (RETPUSHYES)
563# open fileno getc sysread syswrite ioctl accept shutdown
564# ftsize(etc) readlink telldir fork alarm getlogin not OK (RETPUSHUNDEF)
565# umask select not OK (XPUSHs(&PL_sv_undef);)
566# fileno getc sysread syswrite tell not OK (meth("FILENO" "GETC"))
567# sselect shm* sem* msg* syscall - unknown whether they are safe
568# gmtime not OK (list context)
569
21f5b33c
GS
570# Suspicious wrt "additional mode of failure": warn, die, select.
571
79072805
LW
572__END__
573
d83386fa
NC
574# New ops always go at the end
575# The restriction on having custom as the last op has been removed
7399586d 576
64b99527
SC
577# A recapitulation of the format of this file:
578# The file consists of five columns: the name of the op, an English
579# description, the name of the "check" routine used to optimize this
580# operation, some flags, and a description of the operands.
581
582# The flags consist of options followed by a mandatory op class signifier
583
584# The classes are:
585# baseop - 0 unop - 1 binop - 2
586# logop - | listop - @ pmop - /
587# padop/svop - $ padop - # (unused) loop - {
588# baseop/unop - % loopexop - } filestatop - -
3508218b 589# pvop/svop - " cop - ;
64b99527
SC
590
591# Other options are:
592# needs stack mark - m
593# needs constant folding - f
594# produces a scalar - s
595# produces an integer - i
596# needs a target - t
597# target can be in a pad - T
598# has a corresponding integer version - I
599# has side effects - d
600# uses $_ if no argument given - u
601
602# Values for the operands are:
603# scalar - S list - L array - A
604# hash - H sub (CV) - C file - F
605# socket - Fs filetest - F- reference - R
606# "?" denotes an optional operand.
607
79072805
LW
608# Nothing.
609
610null null operation ck_null 0
93a17b20 611stub stub ck_null 0
db173bac 612scalar scalar ck_fun s% S
79072805
LW
613
614# Pushy stuff.
615
db173bac
MB
616pushmark pushmark ck_null s0
617wantarray wantarray ck_null is0
79072805 618
db173bac 619const constant item ck_svconst s$
79072805 620
7934575e
GS
621gvsv scalar variable ck_null ds$
622gv glob value ck_null ds$
db173bac
MB
623gelem glob elem ck_null d2 S S
624padsv private variable ck_null ds0
625padav private array ck_null d0
626padhv private hash ck_null d0
f1612b5c 627padany private value ck_null d0
79072805 628
1167e5da 629pushre push regexp ck_null d/
79072805
LW
630
631# References and stuff.
632
db173bac 633rv2gv ref-to-glob cast ck_rvconst ds1
b89fed5f 634rv2sv scalar dereference ck_rvconst ds1
db173bac 635av2arylen array length ck_null is1
b89fed5f 636rv2cv subroutine dereference ck_rvconst d1
db173bac
MB
637anoncode anonymous subroutine ck_anoncode $
638prototype subroutine prototype ck_null s% S
5d11ae5e 639refgen reference constructor ck_spair m1 L
dfa0f641 640srefgen single ref constructor ck_null fs1 S
db173bac
MB
641ref reference-type operator ck_fun stu% S?
642bless bless ck_fun s@ S S?
79072805
LW
643
644# Pushy I/O.
645
01f5bc1b 646backtick quoted execution (``, qx) ck_open tu% S?
0a753a76 647# glob defaults its first arg to $_
649da076 648glob glob ck_glob t@ S?
e4b7ebf3 649readline <HANDLE> ck_readline t% F?
5fc9b9e4 650rcatline append I/O operator ck_null t$
79072805
LW
651
652# Bindable operators.
653
f1612b5c
GS
654regcmaybe regexp internal guard ck_fun s1 S
655regcreset regexp internal reset ck_fun s1 S
656regcomp regexp compilation ck_null s| S
657match pattern match (m//) ck_match d/
658qr pattern quote (qr//) ck_match s/
59f00321 659subst substitution (s///) ck_match dis/ S
f1612b5c 660substcont substitution iterator ck_null dis|
59f00321 661trans transliteration (tr///) ck_match is" S
79072805
LW
662
663# Lvalue operators.
db173bac
MB
664# sassign is special-cased for op class
665
b162f9ea 666sassign scalar assignment ck_sassign s0
db173bac
MB
667aassign list assignment ck_null t2 L L
668
21f5b33c
GS
669chop chop ck_spair mts% L
670schop scalar chop ck_null stu% S?
f1612b5c
GS
671chomp chomp ck_spair mTs% L
672schomp scalar chomp ck_null sTu% S?
69794302 673defined defined operator ck_defined isu% S?
db173bac
MB
674undef undef operator ck_lfun s% S?
675study study ck_fun su% S?
676pos match position ck_lfun stu% S?
677
42d38218
MS
678preinc preincrement (++) ck_lfun dIs1 S
679i_preinc integer preincrement (++) ck_lfun dis1 S
680predec predecrement (--) ck_lfun dIs1 S
681i_predec integer predecrement (--) ck_lfun dis1 S
21f5b33c 682postinc postincrement (++) ck_lfun dIst1 S
42d38218 683i_postinc integer postincrement (++) ck_lfun disT1 S
21f5b33c 684postdec postdecrement (--) ck_lfun dIst1 S
42d38218 685i_postdec integer postdecrement (--) ck_lfun disT1 S
79072805
LW
686
687# Ordinary operators.
688
42d38218
MS
689pow exponentiation (**) ck_null fsT2 S S
690
f1612b5c 691multiply multiplication (*) ck_null IfsT2 S S
42d38218
MS
692i_multiply integer multiplication (*) ck_null ifsT2 S S
693divide division (/) ck_null IfsT2 S S
694i_divide integer division (/) ck_null ifsT2 S S
695modulo modulus (%) ck_null IifsT2 S S
696i_modulo integer modulus (%) ck_null ifsT2 S S
697repeat repeat (x) ck_repeat mt2 L S
698
699add addition (+) ck_null IfsT2 S S
700i_add integer addition (+) ck_null ifsT2 S S
701subtract subtraction (-) ck_null IfsT2 S S
702i_subtract integer subtraction (-) ck_null ifsT2 S S
df91b2c5 703concat concatenation (.) or string ck_concat fsT2 S S
b162f9ea 704stringify string ck_fun fsT@ S
db173bac 705
42d38218
MS
706left_shift left bitshift (<<) ck_bitop fsT2 S S
707right_shift right bitshift (>>) ck_bitop fsT2 S S
708
709lt numeric lt (<) ck_null Iifs2 S S
710i_lt integer lt (<) ck_null ifs2 S S
711gt numeric gt (>) ck_null Iifs2 S S
712i_gt integer gt (>) ck_null ifs2 S S
713le numeric le (<=) ck_null Iifs2 S S
714i_le integer le (<=) ck_null ifs2 S S
715ge numeric ge (>=) ck_null Iifs2 S S
716i_ge integer ge (>=) ck_null ifs2 S S
717eq numeric eq (==) ck_null Iifs2 S S
718i_eq integer eq (==) ck_null ifs2 S S
719ne numeric ne (!=) ck_null Iifs2 S S
720i_ne integer ne (!=) ck_null ifs2 S S
721ncmp numeric comparison (<=>) ck_null Iifst2 S S
722i_ncmp integer comparison (<=>) ck_null ifst2 S S
db173bac 723
2de3dbcc
JH
724slt string lt ck_null ifs2 S S
725sgt string gt ck_null ifs2 S S
726sle string le ck_null ifs2 S S
727sge string ge ck_null ifs2 S S
db173bac
MB
728seq string eq ck_null ifs2 S S
729sne string ne ck_null ifs2 S S
2de3dbcc 730scmp string comparison (cmp) ck_null ifst2 S S
db173bac 731
21f5b33c
GS
732bit_and bitwise and (&) ck_bitop fst2 S S
733bit_xor bitwise xor (^) ck_bitop fst2 S S
734bit_or bitwise or (|) ck_bitop fst2 S S
db173bac 735
21f5b33c 736negate negation (-) ck_null Ifst1 S
f1612b5c 737i_negate integer negation (-) ck_null ifsT1 S
db173bac 738not not ck_null ifs1 S
21f5b33c 739complement 1's complement (~) ck_bitop fst1 S
79072805 740
fdecdb95
NC
741smartmatch smart match ck_smartmatch s2
742
79072805
LW
743# High falutin' math.
744
f1612b5c
GS
745atan2 atan2 ck_fun fsT@ S S
746sin sin ck_fun fsTu% S?
747cos cos ck_fun fsTu% S?
748rand rand ck_fun sT% S?
749srand srand ck_fun s% S?
750exp exp ck_fun fsTu% S?
751log log ck_fun fsTu% S?
752sqrt sqrt ck_fun fsTu% S?
79072805 753
cf26c822
CS
754# Lowbrow math.
755
b162f9ea
IZ
756int int ck_fun fsTu% S?
757hex hex ck_fun fsTu% S?
758oct oct ck_fun fsTu% S?
759abs abs ck_fun fsTu% S?
79072805
LW
760
761# String stuff.
762
9784f5f4 763length length ck_fun ifsTu% S?
35fba0d9 764substr substr ck_substr st@ S S S? S?
db173bac 765vec vec ck_fun ist@ S S S
79072805 766
b162f9ea
IZ
767index index ck_index isT@ S S S?
768rindex rindex ck_index isT@ S S S?
79072805 769
fc7325bb 770sprintf sprintf ck_fun mst@ S L
db173bac 771formline formline ck_fun ms@ S L
b162f9ea
IZ
772ord ord ck_fun ifsTu% S?
773chr chr ck_fun fsTu% S?
774crypt crypt ck_fun fsT@ S S
2de3dbcc
JH
775ucfirst ucfirst ck_fun fstu% S?
776lcfirst lcfirst ck_fun fstu% S?
777uc uc ck_fun fstu% S?
778lc lc ck_fun fstu% S?
69b47968 779quotemeta quotemeta ck_fun fstu% S?
79072805
LW
780
781# Arrays.
782
f1612b5c 783rv2av array dereference ck_rvconst dt1
7934575e 784aelemfast constant array element ck_null s$ A S
db173bac
MB
785aelem array element ck_null s2 A S
786aslice array slice ck_null m@ A L
79072805 787
878d132a
NC
788aeach each on array ck_each % A
789akeys keys on array ck_each t% A
790avalues values on array ck_each t% A
791
aa689395 792# Hashes.
79072805 793
878d132a
NC
794each each ck_each % H
795values values ck_each t% H
796keys keys ck_each t% H
db173bac 797delete delete ck_delete % S
42d38218 798exists exists ck_exists is% S
f1612b5c 799rv2hv hash dereference ck_rvconst dt1
c2dedb93 800helem hash element ck_null s2 H S
db173bac 801hslice hash slice ck_null m@ H L
79072805
LW
802
803# Explosives and implosives.
804
bab9c0ac 805unpack unpack ck_unpack @ S S?
db173bac
MB
806pack pack ck_fun mst@ S L
807split split ck_split t@ S S S
297b36dc 808join join or string ck_join mst@ S L
79072805
LW
809
810# List operators.
811
db173bac
MB
812list list ck_null m@ L
813lslice list slice ck_null 2 H L L
42d38218
MS
814anonlist anonymous list ([]) ck_fun ms@ L
815anonhash anonymous hash ({}) ck_fun ms@ L
79072805 816
db173bac 817splice splice ck_fun m@ A S? S? L
b162f9ea 818push push ck_fun imsT@ A L
26f600bc
RGS
819pop pop ck_shift s% A?
820shift shift ck_shift s% A?
b162f9ea 821unshift unshift ck_fun imsT@ A L
9850bf21 822sort sort ck_sort dm@ C? L
db173bac 823reverse reverse ck_fun mt@ L
79072805 824
f1612b5c
GS
825grepstart grep ck_grep dm@ C L
826grepwhile grep iterator ck_null dt|
79072805 827
f1612b5c
GS
828mapstart map ck_grep dm@ C L
829mapwhile map iterator ck_null dt|
a0d0e21e 830
79072805
LW
831# Range stuff.
832
1a67a97c 833range flipflop ck_null | S S
db173bac
MB
834flip range (or flip) ck_null 1 S S
835flop range (or flop) ck_null 1
79072805
LW
836
837# Control.
838
42d38218 839and logical and (&&) ck_null |
f1612b5c
GS
840or logical or (||) ck_null |
841xor logical xor ck_null fs2 S S
fdecdb95 842dor defined or (//) ck_null |
f1612b5c 843cond_expr conditional expression ck_null d|
42d38218
MS
844andassign logical and assignment (&&=) ck_null s|
845orassign logical or assignment (||=) ck_null s|
fdecdb95 846dorassign defined or assignment (//=) ck_null s|
db173bac 847
f5d5a27c 848method method lookup ck_method d1
db173bac
MB
849entersub subroutine entry ck_subr dmt1 L
850leavesub subroutine exit ck_null 1
78f9721b 851leavesublv lvalue subroutine return ck_null 1
db173bac
MB
852caller caller ck_fun t% S?
853warn warn ck_fun imst@ L
96e176bf 854die die ck_die dimst@ L
f1612b5c 855reset symbol reset ck_fun is% S?
db173bac
MB
856
857lineseq line sequence ck_null @
722969e2
DM
858nextstate next statement ck_null s;
859dbstate debug next statement ck_null s;
e9c54c90 860unstack iteration finalizer ck_null s0
79072805 861enter block entry ck_null 0
db173bac
MB
862leave block exit ck_null @
863scope block ck_null @
864enteriter foreach loop entry ck_null d{
79072805 865iter foreach loop iterator ck_null 0
db173bac
MB
866enterloop loop entry ck_null d{
867leaveloop loop exit ck_null 2
78f9721b 868return return ck_return dm@ L
db173bac
MB
869last last ck_null ds}
870next next ck_null ds}
871redo redo ck_null ds}
872dump dump ck_null ds}
873goto goto ck_null ds}
d98f61e7 874exit exit ck_exit ds% S?
fdecdb95
NC
875method_named method with known name ck_null d$
876
877entergiven given() ck_null d|
878leavegiven leave given block ck_null 1
879enterwhen when() ck_null d|
880leavewhen leave when block ck_null 1
881break break ck_null 0
882continue continue ck_null 0
79072805 883
79072805
LW
884# I/O.
885
a567e93b 886open open ck_open ismt@ F S? L
db173bac
MB
887close close ck_fun is% F?
888pipe_op pipe ck_fun is@ F F
79072805 889
db173bac 890fileno fileno ck_fun ist% F
a86a20aa 891umask umask ck_fun ist% S?
1c1fc3ea 892binmode binmode ck_fun s@ F S?
79072805 893
db173bac
MB
894tie tie ck_fun idms@ R S L
895untie untie ck_fun is% R
896tied tied ck_fun s% R
897dbmopen dbmopen ck_fun is@ H S S
898dbmclose dbmclose ck_fun is% H
79072805 899
db173bac
MB
900sselect select system call ck_select t@ S S S S
901select select ck_select st@ F?
79072805 902
db173bac 903getc getc ck_eof st% F?
d1a002d4 904read read ck_fun imst@ F R S S?
db173bac
MB
905enterwrite write ck_fun dis% F?
906leavewrite write exit ck_null 1
79072805 907
db173bac
MB
908prtf printf ck_listiob ims@ F? L
909print print ck_listiob ims@ F? L
fdecdb95 910say say ck_listiob ims@ F? L
79072805 911
db173bac
MB
912sysopen sysopen ck_fun s@ F S S S?
913sysseek sysseek ck_fun s@ F S S
d1a002d4 914sysread sysread ck_fun imst@ F R S S?
145d37e2 915syswrite syswrite ck_fun imst@ F S S? S?
79072805 916
db173bac
MB
917eof eof ck_eof is% F?
918tell tell ck_fun st% F?
919seek seek ck_fun s@ F S S
9b01e405 920# truncate really behaves as if it had both "S S" and "F S"
db173bac 921truncate truncate ck_trunc is@ S S
79072805 922
db173bac
MB
923fcntl fcntl ck_fun st@ F S S
924ioctl ioctl ck_fun st@ F S S
b162f9ea 925flock flock ck_fun isT@ F S
79072805 926
e71197e2
JC
927# Sockets. OP_IS_SOCKET wants them consecutive (so moved 1st 2)
928
929send send ck_fun imst@ Fs S S S?
930recv recv ck_fun imst@ Fs R S S
79072805 931
a85d93d9
JH
932socket socket ck_fun is@ Fs S S S
933sockpair socketpair ck_fun is@ Fs Fs S S S
79072805 934
a85d93d9
JH
935bind bind ck_fun is@ Fs S
936connect connect ck_fun is@ Fs S
937listen listen ck_fun is@ Fs S
938accept accept ck_fun ist@ Fs Fs
939shutdown shutdown ck_fun ist@ Fs S
79072805 940
a85d93d9
JH
941gsockopt getsockopt ck_fun is@ Fs S S
942ssockopt setsockopt ck_fun is@ Fs S S S
79072805 943
a85d93d9
JH
944getsockname getsockname ck_fun is% Fs
945getpeername getpeername ck_fun is% Fs
79072805 946
e71197e2 947# Stat calls. OP_IS_FILETEST wants them consecutive.
79072805 948
db173bac
MB
949lstat lstat ck_ftst u- F
950stat stat ck_ftst u- F
a85d93d9
JH
951ftrread -R ck_ftst isu- F-
952ftrwrite -W ck_ftst isu- F-
953ftrexec -X ck_ftst isu- F-
954fteread -r ck_ftst isu- F-
955ftewrite -w ck_ftst isu- F-
956fteexec -x ck_ftst isu- F-
957ftis -e ck_ftst isu- F-
a85d93d9
JH
958ftsize -s ck_ftst istu- F-
959ftmtime -M ck_ftst stu- F-
960ftatime -A ck_ftst stu- F-
961ftctime -C ck_ftst stu- F-
7834bb7e
NC
962ftrowned -O ck_ftst isu- F-
963fteowned -o ck_ftst isu- F-
964ftzero -z ck_ftst isu- F-
a85d93d9
JH
965ftsock -S ck_ftst isu- F-
966ftchr -c ck_ftst isu- F-
967ftblk -b ck_ftst isu- F-
968ftfile -f ck_ftst isu- F-
969ftdir -d ck_ftst isu- F-
970ftpipe -p ck_ftst isu- F-
a85d93d9
JH
971ftsuid -u ck_ftst isu- F-
972ftsgid -g ck_ftst isu- F-
973ftsvtx -k ck_ftst isu- F-
7834bb7e 974ftlink -l ck_ftst isu- F-
a85d93d9
JH
975fttty -t ck_ftst is- F-
976fttext -T ck_ftst isu- F-
977ftbinary -B ck_ftst isu- F-
79072805
LW
978
979# File calls.
980
d4ac975e
GA
981# chdir really behaves as if it had both "S?" and "F?"
982chdir chdir ck_chdir isT% S?
b162f9ea
IZ
983chown chown ck_fun imsT@ L
984chroot chroot ck_fun isTu% S?
985unlink unlink ck_fun imsTu@ L
a86a20aa 986chmod chmod ck_fun imsT@ L
b162f9ea
IZ
987utime utime ck_fun imsT@ L
988rename rename ck_fun isT@ S S
989link link ck_fun isT@ S S
990symlink symlink ck_fun isT@ S S
db173bac 991readlink readlink ck_fun stu% S?
491873e5 992mkdir mkdir ck_fun isTu@ S? S?
b162f9ea 993rmdir rmdir ck_fun isTu% S?
79072805
LW
994
995# Directory calls.
996
1e2c6ed7 997open_dir opendir ck_fun is@ F S
db173bac
MB
998readdir readdir ck_fun % F
999telldir telldir ck_fun st% F
1000seekdir seekdir ck_fun s@ F S
1001rewinddir rewinddir ck_fun s% F
1002closedir closedir ck_fun is% F
79072805
LW
1003
1004# Process control.
1005
db173bac 1006fork fork ck_null ist0
b162f9ea
IZ
1007wait wait ck_null isT0
1008waitpid waitpid ck_fun isT@ S S
1009system system ck_exec imsT@ S? L
1010exec exec ck_exec dimsT@ S? L
1011kill kill ck_fun dimsT@ L
1012getppid getppid ck_null isT0
1013getpgrp getpgrp ck_fun isT% S?
1014setpgrp setpgrp ck_fun isT@ S? S?
1015getpriority getpriority ck_fun isT@ S S
1016setpriority setpriority ck_fun isT@ S S S
79072805
LW
1017
1018# Time calls.
1019
cd39f2b6
JH
1020# NOTE: MacOS patches the 'i' of time() away later when the interpreter
1021# is created because in MacOS time() is already returning times > 2**31-1,
1022# that is, non-integers.
1023
b162f9ea 1024time time ck_null isT0
79072805 1025tms times ck_null 0
db173bac
MB
1026localtime localtime ck_fun t% S?
1027gmtime gmtime ck_fun t% S?
1028alarm alarm ck_fun istu% S?
b162f9ea 1029sleep sleep ck_fun isT% S?
79072805
LW
1030
1031# Shared memory.
1032
db173bac
MB
1033shmget shmget ck_fun imst@ S S S
1034shmctl shmctl ck_fun imst@ S S S
1035shmread shmread ck_fun imst@ S S S S
1036shmwrite shmwrite ck_fun imst@ S S S S
79072805
LW
1037
1038# Message passing.
1039
db173bac
MB
1040msgget msgget ck_fun imst@ S S
1041msgctl msgctl ck_fun imst@ S S S
1042msgsnd msgsnd ck_fun imst@ S S S
1043msgrcv msgrcv ck_fun imst@ S S S S S
79072805
LW
1044
1045# Semaphores.
1046
7834bb7e 1047semop semop ck_fun imst@ S S
db173bac
MB
1048semget semget ck_fun imst@ S S S
1049semctl semctl ck_fun imst@ S S S S
79072805
LW
1050
1051# Eval.
1052
db173bac 1053require require ck_require du% S?
b3f4d674 1054dofile do "file" ck_fun d1 S
996c9baa 1055hintseval eval hints ck_svconst s$
b3f4d674
GS
1056entereval eval "string" ck_eval d% S
1057leaveeval eval "string" exit ck_null 1 S
db173bac 1058#evalonce eval constant string ck_null d1 S
42d38218 1059entertry eval {block} ck_null |
f1612b5c 1060leavetry eval {block} exit ck_null @
79072805
LW
1061
1062# Get system info.
1063
db173bac
MB
1064ghbyname gethostbyname ck_fun % S
1065ghbyaddr gethostbyaddr ck_fun @ S S
79072805 1066ghostent gethostent ck_null 0
db173bac
MB
1067gnbyname getnetbyname ck_fun % S
1068gnbyaddr getnetbyaddr ck_fun @ S S
79072805 1069gnetent getnetent ck_null 0
db173bac
MB
1070gpbyname getprotobyname ck_fun % S
1071gpbynumber getprotobynumber ck_fun @ S
79072805 1072gprotoent getprotoent ck_null 0
db173bac
MB
1073gsbyname getservbyname ck_fun @ S S
1074gsbyport getservbyport ck_fun @ S S
79072805 1075gservent getservent ck_null 0
db173bac
MB
1076shostent sethostent ck_fun is% S
1077snetent setnetent ck_fun is% S
1078sprotoent setprotoent ck_fun is% S
1079sservent setservent ck_fun is% S
1080ehostent endhostent ck_null is0
1081enetent endnetent ck_null is0
1082eprotoent endprotoent ck_null is0
1083eservent endservent ck_null is0
1084gpwnam getpwnam ck_fun % S
1085gpwuid getpwuid ck_fun % S
79072805 1086gpwent getpwent ck_null 0
db173bac
MB
1087spwent setpwent ck_null is0
1088epwent endpwent ck_null is0
1089ggrnam getgrnam ck_fun % S
1090ggrgid getgrgid ck_fun % S
79072805 1091ggrent getgrent ck_null 0
db173bac
MB
1092sgrent setgrent ck_null is0
1093egrent endgrent ck_null is0
1094getlogin getlogin ck_null st0
79072805
LW
1095
1096# Miscellaneous.
1097
db173bac 1098syscall syscall ck_fun imst@ S L
c0329465
MB
1099
1100# For multi-threading
5a47f09b 1101lock lock ck_rfun s% R
7399586d 1102
c5917253
NC
1103# For state support
1104
1105once once ck_null |
1106
53e06cf0 1107custom unknown custom operator ck_null 0