-
Notifications
You must be signed in to change notification settings - Fork 138
/
Vtable.pm
417 lines (312 loc) · 10.1 KB
/
Vtable.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
# Copyright (C) 2001-2011, Parrot Foundation.
=head1 NAME
Parrot::Vtable - Functions for manipulating vtables
=head1 SYNOPSIS
use Parrot::Vtable;
=head1 DESCRIPTION
C<Parrot::Vtable> provides a collection of functions for manipulating PMC
vtables. It is used by F<tools/build/pmc2c.pl>, F<tools/build/vtable_h.pl>,
F<tools/build/vtable_extend.pl> and F<tools/dev/gen_class.pl>.
=head2 Functions
The following functions are exported:
=over 4
=cut
package Parrot::Vtable;
use strict;
use warnings;
use base qw( Exporter );
use FileHandle;
our @EXPORT = qw(parse_vtable vtbl_defs vtbl_struct vtbl_macros vtbl_embed);
sub make_re {
my $re = shift;
my $comp_re = qr/$re/;
return ( defined $comp_re )
? $comp_re
: "(?:$re)";
}
my $ident_re = make_re('[A-Za-z_][A-Za-z0-9_]*');
my $type_re = make_re( '(?:(?:struct\s+)|(?:union\s+))?' . $ident_re . '\**' );
my $const_re = make_re( '(?:const\s+)?' );
my $c_param_re = make_re( $const_re . $type_re . '\s+' . $ident_re );
my $param_re = make_re( '(?:(?:' . $c_param_re . ')|(?:ARG[_A-Z]+\(\s*' . $c_param_re . '\)))' );
my $arglist_re = make_re( '(?:' . $param_re . '(?:\s*,\s*' . $param_re . ')*)?' );
my $method_re =
make_re( '^\s*(' . $type_re . ')\s+(' . $ident_re . ')\s*\((' . $arglist_re . ')\)\s*$' );
my $attrs_re = make_re('(?::(\w+)\s*)*');
my $attr_re = make_re(':(\w+)\s*');
sub parse_attrs {
my $attrs = shift;
my $default = shift || {};
my $result = {%$default};
$result->{$1} = 1 while $attrs =~ /$attr_re/g;
return $result;
}
=item C<parse_vtable($file)>
Returns a reference to an array containing
[ return_type method_name parameters section MMD_type attributes ]
for each vtable function defined in C<$file>. If it is not an MMD method,
C<MMD_type> is -1.
=cut
sub parse_vtable {
my $file = shift;
my $vtable = [];
my $mmd = [];
my $fh = FileHandle->new( $file, O_RDONLY ) or die "Can't open $file for reading: $!\n";
my $section = 'MAIN';
my $default_attrs = {};
while (<$fh>) {
chomp;
s/\s+$//;
next if /^\s*#/ or /^$/;
if (/^\[(\w+)\]\s*($attrs_re)/) {
$section = $1;
$default_attrs = parse_attrs($2);
}
elsif (
m/^\s*
($type_re)\s+
($ident_re)\s*
\(($arglist_re)\)
(?:\s+(MMD_\w+))?\s*($attrs_re)$/x
)
{
my $mmdop = defined $4 ? $4 : -1;
my $entry = [ $1, $2, $3, $section, $mmdop, parse_attrs( $5, $default_attrs ) ];
if ( defined $4 ) {
push @{$mmd}, $entry;
}
else {
push @{$vtable}, $entry;
}
}
else {
die "Syntax error at $file line " . $fh->input_line_number() . "\n";
}
}
# We probably should sort on insert, but this is easier for now. And it's
# compile time, so it's not all that important.
return [ @{$mmd}, sort { $a->[1] cmp $b->[1] } @{$vtable} ];
}
=item C<vtbl_defs($vtable)>
Returns the C C<typedef> definitions for the elements in the referenced
vtable array.
=cut
sub vtbl_defs {
my $vtable = shift;
my $defs = q{};
for my $entry ( @{$vtable} ) {
next if ( $entry->[4] =~ /MMD_/ );
# Put arg annotations on points if appropriate
my @args = split( /\s*,\s*/, $entry->[2] );
for my $arg ( @args ) {
if ( $arg =~ /^STRING\b/ ) {
# It would be nice if we could const STRINGs but they might have to calculate a hashval.
$arg = "ARGMOD($arg)";
}
}
# The source PMC can always get modified.
my $args = join( ', ', 'PARROT_INTERP', 'ARGMOD(PMC *pmc)', @args);
$defs .= "typedef $entry->[0] (*$entry->[1]_method_t)($args);\n";
}
return $defs;
}
=item C<vtbl_struct($vtable)>
Returns the C C<struct> definitions for the elements in the referenced
vtable array.
=cut
sub vtbl_struct {
my $vtable = shift;
my $struct = q{};
$struct = <<'EOF';
typedef enum {
VTABLE_IS_CONST_FLAG = 0x001,
VTABLE_HAS_CONST_TOO = 0x002,
VTABLE_PMC_NEEDS_EXT = 0x004,
VTABLE_DATA_IS_PMC = 0x008,
VTABLE_PMC_IS_SINGLETON = 0x010,
VTABLE_IS_SHARED_FLAG = 0x020,
VTABLE_IS_CONST_PMC_FLAG = 0x040,
VTABLE_HAS_READONLY_FLAG = 0x080,
VTABLE_IS_READONLY_FLAG = 0x100
} vtable_flags_t;
typedef struct _vtable {
PMC *_namespace; /* Pointer to namespace for this class */
INTVAL base_type; /* 'type' value for MMD */
STRING *whoami; /* Name of class this vtable is for */
UINTVAL flags; /* VTABLE flags (constant, is_ro, etc). */
STRING *provides_str; /* space-separated list of interfaces */
Hash *isa_hash; /* Hash of class names */
PMC *pmc_class; /* for PMCs: a PMC of that type
for objects: the class PMC */
PMC *mro; /* array PMC of [class, parents ... ] */
const char *attribute_defs; /* list of PMC attributes */
struct _vtable *ro_variant_vtable; /* A variant of this vtable with the
opposite IS_READONLY flag */
/* Vtable Functions */
EOF
for my $entry ( @{$vtable} ) {
next if ( $entry->[4] =~ /MMD_/ );
$struct .= " $entry->[1]_method_t $entry->[1];\n";
}
$struct .= <<'EOF';
UINTVAL attr_size; /* Size of the attributes struct */
EOF
$struct .= "} _vtable;\n";
return $struct;
}
=item C<vtbl_macros($vtable)>
Returns the C C<#define> definitions for the elements in the referenced
vtable array.
=cut
sub vtbl_macros {
my $vtable = shift;
my $macros = <<'EOM';
/*
* vtable accessor macros
* as vtable functions might get moved around internally
* these macros hide the details
*/
EOM
for my $entry ( @{$vtable} ) {
next if ( $entry->[4] =~ /MMD_/ );
my @args = split /,\s*/, $entry->[2];
s/^ARG[_A-Z]+\((.+)\)/$1/ for @args; # Strip annotations, if any
unshift @args, "i interp", "p pmc";
my $args = join ', ', map { ( split / /, $args[$_] )[-1] } ( 0 .. $#args );
$macros .= <<"EOM";
#define VTABLE_$entry->[1]($args) \\
(pmc)->vtable->$entry->[1]($args)
EOM
}
# Slot numbers
$macros .= <<"EOM";
/*
* vtable slot names
*/
EOM
my $vtable_slot_num = 9;
for my $entry ( @{$vtable} ) {
my $uc_meth = uc $entry->[1];
$macros .= <<"EOM";
#define PARROT_VTABLE_SLOT_${uc_meth} ${vtable_slot_num}
EOM
++$vtable_slot_num;
}
# finally the name mapping
$macros .= <<'EOM';
#define PARROT_VTABLE_LOW 9
static PARROT_OBSERVER const char * const Parrot_vtable_slot_names[] = {
"", /* Pointer to namespace for this class */
"", /* 'type' value for MMD */
"", /* Name of class this vtable is for */
"", /* VTABLE flags (constant, is_ro, etc). */
"", /* space-separated list of interfaces */
"", /* space-separated list of classes */
"", /* class */
"", /* mro */
"", /* ro_variant_vtable */
/* Vtable Functions */
EOM
my $num_vtable_funcs = 0;
for my $entry ( @{$vtable} ) {
next if ( $entry->[4] =~ /MMD_/ );
$num_vtable_funcs++;
$macros .= <<"EOM";
\"$entry->[1]\",
EOM
}
$macros .= <<"EOM";
NULL
};
#define NUM_VTABLE_FUNCTIONS $num_vtable_funcs
EOM
$macros;
}
=item C<vtbl_embed($vtable)>
Returns the C function definitions to call the vtable functions on a PMC for the
elements in the referenced vtable array.
=cut
sub vtbl_embed {
my $vtable = shift;
my $funcs = q{};
my $protos = q{};
for my $entry (@$vtable) {
my ( $return_type, $name, $params, $section, $mmd ) = @$entry;
next unless $mmd eq '-1';
my @params = parse_params($params);
my @sig = ( 'PARROT_INTERP', 'Parrot_PMC pmc' );
my @args = ( 'interp', 'pmc' );
while ( my ( $type, $name ) = splice( @params, 0, 2 ) ) {
eval {
push @sig, find_type($type) . ' ' . $name;
push @args, $name;
};
}
next if $@;
# these are internals-ish and should not be exposed
next if $name =~ m/^(destroy|mark|invoke)$/;
my $signature = join( ', ', @sig );
my $arguments = join( ', ', @args );
my $ret_type = find_type($return_type);
$protos .= sprintf "PARROT_EXPORT %s Parrot_PMC_%s( %s );\n", $ret_type, $name,
$signature;
# make sure the bare POD here doesn't appear in this module's perldoc
(my $func_header =<< " END_HEADER") =~ s/^ //mg;
/*
=item C<%s
%s(%s)>
=cut
*/
PARROT_EXPORT %s
Parrot_PMC_%s( %s )
{
END_HEADER
$funcs .= sprintf $func_header, ( $ret_type, $name, $signature ) x 2;
$funcs .= " $ret_type retval;\n" unless $ret_type eq 'void';
$funcs .= "retval = " unless $ret_type eq 'void';
$funcs .= "VTABLE_$name( $arguments );
return";
$funcs .= " retval" unless $ret_type eq 'void';
$funcs .= ";\n}\n\n";
}
return ( $funcs, $protos );
}
sub find_type {
my $type = shift;
my %typemap = (
'STRING*' => 'Parrot_String',
'void*' => 'void*',
'INTVAL' => 'Parrot_Int',
'PMC*' => 'Parrot_PMC',
'FLOATVAL' => 'Parrot_Float',
'void' => 'void',
'UINTVAL' => 'Parrot_Int',
'size_t' => 'size_t',
'opcode_t*' => 'Parrot_Opcode*',
);
die "Unknown type $type\n" unless exists $typemap{$type};
return $typemap{$type};
}
sub parse_params {
my $params = shift;
my @params;
while ( $params =~ m/(\w+\*?) (\w+)/g ) {
push @params, $1, $2;
}
return @params;
}
=back
=head1 SEE ALSO
=over 4
=item F<tools/build/vtable_extend.pl>
=item F<tools/build/pmc2c.pl>
=item F<tools/build/vtable_h.pl>
=item F<tools/dev/gen_class.pl>
=cut
1;
# Local Variables:
# mode: cperl
# cperl-indent-level: 4
# fill-column: 100
# End:
# vim: expandtab shiftwidth=4: