forked from DFHack/df-structures
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Common.pm
566 lines (445 loc) · 13.7 KB
/
Common.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
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
package Common;
use utf8;
use strict;
use warnings;
BEGIN {
use Exporter ();
our $VERSION = 1.00;
our @ISA = qw(Exporter);
our @EXPORT = qw(
$main_namespace $export_prefix
%types %type_files %globals %global_files *typename *filename
&parse_address &check_bad_attrs &check_name
&is_attr_true &type_header_def &add_type_to_hash &add_global_to_hash
*lines *indentation &with_emit &emit &indent &outdent &emit_block
&is_primitive_type &primitive_type_name &get_primitive_base
*weak_refs *strong_refs *header_refs &header_ref ®ister_ref &decode_type_name_ref
&with_capture_traits &with_emit_traits
*cur_header_name %header_data &with_header_file
%static_lines %static_includes &static_include_type &with_emit_static
&ensure_name &with_anon
&fully_qualified_name &type_identity_reference
&get_comment &emit_comment
*field_defs %field_defs_extra &generate_field_table
);
our %EXPORT_TAGS = ( ); # eg: TAG => [ qw!name1 name2! ],
our @EXPORT_OK = qw( );
}
END { }
use XML::LibXML;
our $main_namespace = '';
our $export_prefix = '';
our %types;
our %type_files;
our %globals;
our %global_files;
# Misc XML analysis
our $typename;
our $filename;
sub parse_address($;$) {
my ($str,$in_bits) = @_;
return undef unless defined $str;
# Parse the format used by offset attributes in xml
$str =~ /^0x([0-9a-f]+)(?:\.([0-7]))?$/
or die "Invalid address syntax: $str\n";
my ($full, $bv) = ($1, $2);
die "Bits not allowed: $str\n" unless $in_bits;
return $in_bits ? (hex($full)*8 + ($bv||0)) : hex($full);
}
sub check_bad_attrs($;$$) {
my ($tag, $allow_size, $allow_align) = @_;
die "Cannot use size, alignment or offset for ".$tag->nodeName."\n"
if ((!$allow_size && defined $tag->getAttribute('size')) ||
defined $tag->getAttribute('offset') ||
(!$allow_align && defined $tag->getAttribute('alignment')));
}
sub check_name($) {
my ($name) = @_;
$name =~ /^[_a-zA-Z][_a-zA-Z0-9]*$/
or die "Invalid identifier: $name\n";
return $name;
}
sub is_attr_true($$) {
my ($tag, $name) = @_;
return ($tag->getAttribute($name)||'') eq 'true';
}
sub type_header_def($) {
my ($name) = @_;
return uc($main_namespace).'_'.uc($name).'_H';
}
sub add_type_to_hash($) {
my ($type) = @_;
my $name = $type->getAttribute('type-name')
or die "Type without a name in $filename\n";
die "Duplicate definition of $name in $filename\n" if $types{$name};
local $typename = $name;
check_bad_attrs $type;
$types{$name} = $type;
$type_files{$name} = $filename;
}
sub add_global_to_hash($) {
my ($type) = @_;
my $name = $type->getAttribute('name')
or die "Global without a name in $filename\n";
die "Duplicate definition of global $name in $filename\n" if $globals{$name};
local $typename = $name;
check_bad_attrs $type;
$globals{$name} = $type;
$global_files{$name} = $filename;
}
# Text generation with indentation
our @lines;
our $indentation = 0;
sub with_emit(&;$) {
# Executes the code block, and returns emitted lines
my ($blk, $start_indent) = @_;
local @lines;
local $indentation = ($start_indent||0);
$blk->();
return @lines;
}
sub emit(@) {
# Emit an indented line to be returned from with_emit
my $line = join('',map { defined($_) ? $_ : '' } @_);
$line = (' 'x$indentation).$line unless length($line) == 0;
push @lines, $line;
}
sub indent(&) {
# Indent lines emitted from the block by one step
my ($blk) = @_;
local $indentation = $indentation+2;
$blk->();
}
sub outdent(&) {
# Unindent lines emitted from the block by one step
my ($blk) = @_;
local $indentation = ($indentation >= 2 ? $indentation-2 : 0);
$blk->();
}
sub emit_block(&;$$%) {
# Emit a full {...} block with indentation
my ($blk, $prefix, $suffix, %flags) = @_;
my @inner = &with_emit($blk,$indentation+2);
return if $flags{-auto} && !@inner;
$prefix ||= '';
$suffix ||= '';
emit $prefix,'{';
push @lines, @inner;
emit '}',$suffix;
}
# Primitive types
my @primitive_type_list =
qw(int8_t uint8_t int16_t uint16_t
int32_t uint32_t int64_t uint64_t
long
s-float d-float
bool flag-bit
padding static-string);
my %primitive_aliases = (
's-float' => 'float',
'd-float' => 'double',
'static-string' => 'char',
'flag-bit' => 'void',
'padding' => 'void',
);
my %primitive_types;
$primitive_types{$_}++ for @primitive_type_list;
sub is_primitive_type($) {
return $primitive_types{$_[0]};
}
sub primitive_type_name($) {
my ($tag_name) = @_;
$primitive_types{$tag_name}
or die "Not primitive: $tag_name\n";
return $primitive_aliases{$tag_name} || $tag_name;
}
sub get_primitive_base($;$) {
my ($tag, $default) = @_;
my $base = $tag->getAttribute('base-type') || $default || 'uint32_t';
if ($base =~ /u?int[136]?[2468]_t/) {
header_ref("cstdint");
}
$primitive_types{$base} or die "Must be primitive: $base\n";
return $base;
}
# Type references
our %weak_refs;
our %strong_refs;
our %header_refs;
sub register_ref($;$) {
# Register a reference to another type.
# Strong ones require the type to be included.
my ($ref, $is_strong) = @_;
if ($ref) {
my $type = $types{$ref}
or die "Unknown type $ref referenced.\n";
if ($is_strong) {
$strong_refs{$ref}++;
} else {
$weak_refs{$ref}++;
}
return $type;
} else {
return undef;
}
}
sub header_ref($;$) {
my ($header) = @_;
$header_refs{$header}++;
}
sub decode_type_name_ref($;%) {
# Interpret the type-name field of a tag
my ($tag,%flags) = @_;
my $force_type = $flags{-force_type};
my $attr = $flags{-attr_name} || 'type-name';
my $tname = $tag->getAttribute($attr) or return undef;
if ($primitive_types{$tname}) {
die "Cannot use type $tname as $attr here: $tag\n"
if ($force_type && $force_type ne 'primitive');
return primitive_type_name($tname);
} else {
register_ref $tname, !$flags{-weak};
die "Cannot use type $tname as $attr here: $tag\n"
if ($force_type && $force_type ne $types{$tname}->getAttribute('ld:meta'));
my $rtype = $main_namespace.'::'.$tname;
return wantarray ? ($rtype, $types{$tname}) : $rtype;
}
}
# Trait generation
our @trait_lines;
our $trait_indent = 2;
sub with_capture_traits(&) {
my ($blk) = @_;
local $trait_indent = $indentation;
local @trait_lines = ();
$blk->();
push @lines, @trait_lines;
}
sub with_emit_traits(&) {
my ($blk) = @_;
push @trait_lines, &with_emit($blk,$trait_indent);
}
# Include file generation
our $cur_header_name;
our %header_data;
sub with_header_file(&$) {
my ($handler, $header_name) = @_;
local $cur_header_name = $header_name;
local %weak_refs;
local %strong_refs;
local %header_refs;
# Emit the actual type definition
my @code = with_emit {
with_capture_traits {
&with_anon($handler);
};
} 2;
delete $weak_refs{$header_name};
delete $strong_refs{$header_name};
# Add wrapping
my @all = with_emit {
my $def = type_header_def($header_name);
emit "#pragma once";
emit "#ifdef __GNUC__";
emit "#pragma GCC system_header";
emit "#endif";
for my $strong (sort { $a cmp $b } keys %header_refs) {
emit "#include \"$strong\"";
}
for my $strong (sort { $a cmp $b } keys %strong_refs) {
emit "#include \"$strong.h\"";
}
emit_block {
for my $weak (sort { $a cmp $b } keys %weak_refs) {
next if $strong_refs{$weak};
my $ttype = $types{$weak};
my $meta = $ttype->getAttribute('ld:meta');
my $tstr = 'struct';
$tstr = 'enum' if $meta eq 'enum-type';
$tstr = 'union' if $meta eq 'bitfield-type';
$tstr = 'union' if ($meta eq 'struct-type' && is_attr_true($ttype,'is-union'));
emit $tstr, ' ', $weak, ';';
}
push @lines, @code;
} "namespace $main_namespace ";
};
$header_data{$header_name} = \@all;
}
# Static file output
our $cur_static;
our %static_lines;
our %static_includes;
sub static_include_type($) {
$static_includes{$cur_static}{$_[0]}++;
}
sub with_emit_static(&;$) {
my ($blk, $tag) = @_;
$tag ||= '';
local $cur_static = $tag;
my @inner = &with_emit($blk,2) or return;
$static_includes{$tag}{$cur_header_name}++ if $cur_header_name;
push @{$static_lines{$tag}}, @inner;
}
# Anonymous variable names
our $anon_id = 0;
our $anon_prefix;
sub ensure_name($) {
# If the name is empty, assign an auto-generated one
my ($name) = @_;
unless ($name) {
$name = $anon_prefix.(($anon_id == 0) ? '' : '_'.$anon_id);
$anon_id++;
}
return check_name($name);
}
sub with_anon(&;$) {
# Establish a new anonymous namespace
my ($blk,$stem) = @_;
local $anon_id = $stem ? 0 : 1;
local $anon_prefix = ($stem||'anon');
$blk->();
}
# Global type names
sub fully_qualified_name($$;$) {
my ($tag, $name, $no_ns) = @_;
my @names;
push @names, $main_namespace unless $no_ns;
for my $parent ($tag->findnodes('ancestor::*')) {
if ($parent->nodeName eq 'ld:global-type') {
push @names, $parent->getAttribute('type-name');
} elsif ($parent->nodeName eq 'ld:global-object') {
push @names, 'global';
} elsif (my $n = $parent->getAttribute('ld:typedef-name')) {
push @names, $n;
}
}
push @names, $name if defined $name;
return join('::',@names);
}
sub type_identity_reference($%) {
my ($tag, %flags) = @_;
return 'NULL' unless $tag;
my $name = $tag->nodeName;
if ($flags{-parent}) {
while (defined $tag) {
$tag = $tag->parentNode;
last unless $tag;
$name = $tag->nodeName;
if ($name eq 'ld:data-definition') {
$tag = undef;
last;
}
last if $name eq 'ld:global-type';
last if $name eq 'ld:global-object';
last if $tag->getAttribute('ld:typedef-name');
}
return 'NULL' unless $tag;
}
return '&global::_identity' if $name eq 'ld:global-object';
my $meta = $tag->getAttribute('ld:meta');
my $subtype = $tag->getAttribute('ld:subtype')||'';
my $tname;
if ($name eq 'ld:global-type') {
$tname = $tag->getAttribute('type-name');
} elsif ($meta eq 'compound') {
$tname = $tag->getAttribute('ld:typedef-name')
} else {
return undef if $flags{-allow_complex};
}
$tname or die "No type name: ".$tag->toString();
my $fqn = fully_qualified_name($tag, $tname, 1);
if ($meta eq 'enum-type' || $subtype eq 'enum' ||
$meta eq 'bitfield-type' || $subtype eq 'bitfield' ||
is_attr_true($tag, 'ld:in-union') ||
is_attr_true($tag, 'is-union'))
{
return 'TID('.$fqn.')';
} else {
return '&'.$fqn.'::_identity';
}
}
# Comments
sub get_comment($) {
my ($tag) = @_;
return '' unless $tag;
my $since = $tag->getAttribute('since');
my $comment = $tag->getAttribute('comment');
my $val = '';
if ($since) {
$val = $val . 'since ' . $since;
if ($comment) {
$val = $val . '; ';
}
}
if ($comment) {
$val = $val . $comment;
}
if ($val) {
return ' /*!< '.$val.' */';
} else {
return '';
}
}
sub emit_comment($;%) {
my ($tag,%flags) = @_;
return unless $tag;
my $val = $tag->findvalue('child::comment');
if ($flags{-attr}) {
my $attr = $tag->getAttribute('comment');
if ($attr && $val) {
$val = $attr."\n".$val;
} else {
$val ||= $attr;
}
my $since = $tag->getAttribute('since');
if ($since) {
$val .= "\nSince " . $since;
}
}
if ($val) {
emit '/**';
for my $line (split(/\n/, $val)) {
$line =~ s/^\s*//;
$line =~ s/\s*$//;
next if $line eq '';
emit ' * ', $line;
}
emit ' */';
}
}
# Field tables
our @field_defs;
our %field_defs_extra;
sub generate_field_table(&$) {
my ($blk, $full_name) = @_;
local @field_defs;
my $ftable_name = $full_name.'_fields';
$ftable_name =~ s/::/_doT_Dot_/g;
$ftable_name =~ s/</_lT_/g;
$ftable_name =~ s/>/_Gt_/g;
&with_anon($blk, 'T_'.$ftable_name);
return 'NULL' unless @field_defs;
emit "#define CUR_STRUCT $full_name";
if (%field_defs_extra) {
emit "#define EXTRA(name) ${ftable_name}_Extra_ ## name";
for my $extra_name (sort keys %field_defs_extra) {
emit_block {
emit $field_defs_extra{$extra_name}{index_enum} || 0, ",";
emit $field_defs_extra{$extra_name}{ref_target} || 0, ",";
emit $field_defs_extra{$extra_name}{union_tag_field} || 0, ",";
emit $field_defs_extra{$extra_name}{union_tag_attr} || 0, ",";
} "static const struct_field_info_extra EXTRA(${extra_name}) = ", ";";
}
}
emit_block {
emit '{ ', join(', ', @$_), ' },' for @field_defs;
emit "{ FLD_END }";
} "static const struct_field_info ${ftable_name}[] = ", ";";
emit "#undef CUR_STRUCT";
if (%field_defs_extra) {
emit "#undef EXTRA";
%field_defs_extra = ();
}
return $ftable_name;
}
1;