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