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