/
dump_counters.pl
executable file
·442 lines (384 loc) · 13.8 KB
/
dump_counters.pl
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
#!/usr/bin/perl
#
# Generate docs from ser/sip-router counter groups descriptions
# (run on files generated by gcc -fdump-translation-unit -c file.c,
# try -h for help)
# E.g.: dump_counters.pl --file tcp_stats.c --defs="-DUSE_SCTP ..."
#
# Note: uses GCC::TranslationUnit (see cpan) with the following patch:
#@@ -251,6 +251,8 @@
# $node->{vector}[$key] = $value;
# } elsif($key =~ /^op (\d+)$/) {
# $node->{operand}[$1] = $value;
#+ } elsif ($key eq "val") {
#+ push @{$node->{$key}}, ($value) ;
# } else {
# $node->{$key} = $value;
# }
#
#
# Assumptions:
# - the first array of type counter_def_t with an initializer is the array
# with the counter definitions (handler pointer, name, flags, callback,
# callback_param, description). Only one counter_def_t array per file is
# supported.
use strict;
use warnings;
use Getopt::Long;
use File::Temp qw(:mktemp);
use File::Basename;
use GCC::TranslationUnit;
# text printed if we discover that GCC::TranslationUnit is unpatched
my $patch_required="$0 requires a patched GCC:TranslationUnit, see the " .
"comments at the beginning of the file or try --patch\n";
# gcc name
my $gcc="gcc";
# default defines
my $c_defs="DNAME='\"kamailio\"' -DVERSION='\"5.1.0-dev3\"' -DARCH='\"x86_64\"' -DOS='linux_' -DOS_QUOTED='\"linux\"' -DCOMPILER='\"gcc 4.9.2\"' -D__CPU_x86_64 -D__OS_linux -DSER_VER=5001000 -DCFG_DIR='\"/usr/local/etc/kamailio/\"' -DRUN_DIR='\"/run/kamailio/\"' -DPKG_MALLOC -DSHM_MEM -DSHM_MMAP -DDNS_IP_HACK -DUSE_MCAST -DUSE_TCP -DDISABLE_NAGLE -DHAVE_RESOLV_RES -DUSE_DNS_CACHE -DUSE_DNS_FAILOVER -DUSE_DST_BLOCKLIST -DUSE_NAPTR -DWITH_XAVP -DMEM_JOIN_FREE -DF_MALLOC -DQ_MALLOC -DTLSF_MALLOC -DDBG_SR_MEMORY -DUSE_TLS -DTLS_HOOKS -DUSE_CORE_STATS -DSTATISTICS -DMALLOC_STATS -DWITH_AS_SUPPORT -DUSE_SCTP -DFAST_LOCK -DADAPTIVE_WAIT -DADAPTIVE_WAIT_LOOPS=1024 -DCC_GCC_LIKE_ASM -DHAVE_GETHOSTBYNAME2 -DHAVE_UNION_SEMUN -DHAVE_SCHED_YIELD -DHAVE_MSG_NOSIGNAL -DHAVE_MSGHDR_MSG_CONTROL -DHAVE_ALLOCA_H -DHAVE_TIMEGM -DHAVE_SCHED_SETSCHEDULER -DHAVE_IP_MREQN -DHAVE_EPOLL -DHAVE_SIGIO_RT -DSIGINFO64_WORKARROUND -DUSE_FUTEX -DHAVE_SELECT";
# file with gcc syntax tree
my $file; #"tcp_options.c.001t.tu" ;
my $tmp_file;
my $src_fname;
# type to look for
my $var_type="counter_def_t";
my $tu;
my $node;
my $i;
my @cnt_defs; # filled with counter definitions (counter_def_t)
my ($cnt_grp_name, $def_cnt_name, $cnt_name);
my ($opt_help, $opt_txt, $opt_is_tu, $dbg, $opt_grp_name, $opt_patch);
my ($opt_force_grp_name, $opt_docbook);
# default output formats
my $output_format_header="HEADER";
my $output_format_footer="FOOTER";
my $output_format_varline="VARLINE2";
sub show_patch
{
my $patch='
--- GCC/TranslationUnit.pm.orig 2009-10-16 17:57:51.275963053 +0200
+++ GCC/TranslationUnit.pm 2009-10-16 20:17:28.128455959 +0200
@@ -251,6 +251,8 @@
$node->{vector}[$key] = $value;
} elsif($key =~ /^op (\d+)$/) {
$node->{operand}[$1] = $value;
+ } elsif ($key eq "val") {
+ push @{$node->{$key}}, ($value) ;
} else {
$node->{$key} = $value;
}
';
print $patch;
}
sub help
{
#print "Usage: $0 --file fname [--src src_fname] [--txt|-t] [--help|-h]\n";
$~ = "USAGE";
write;
format USAGE =
Usage @* -f filename | --file filename [options...]
$0
Options:
-f filename - use filename for input (see also -T/--tu).
--file filename - same as -f.
-h | -? | --help - this help message.
-D | --dbg | --debug - enable debugging messages.
-d | --defs - defines to be passed on gcc's command line
(e.g. --defs="-DUSE_SCTP -DUSE_TCP").
-g | --grp name
--group name - counter group name used if one cannot be
autodetected.
-G | --force-grp name
--force-group name - force using a counter group name, even if one
is autodetected (see also -g).
--gcc gcc_name - run gcc_name instead of gcc.
-t | --txt - text mode output.
--docbook | --xml - docbook output (xml).
-T | --tu - the input file is in raw gcc translation
unit format (as produced by
gcc -fdump-translation-unit -c ). If not
present it's assumed that the file contains
C code.
-s | --src | --source - name of the source file, needed only if
the input file is in "raw" translation
unit format (--tu) and usefull to restrict
and speed-up the search.
--patch - show patches needed for the
GCC::TranslationUnit package.
.
}
# escape a string for xml use
# params: string to be escaped
# return: escaped string
sub xml_escape{
my $s=shift;
my %escapes = (
'"' => '"',
"'" => ''',
'&' => '&',
'<' => '<',
'>' => '>'
);
$s=~s/(["'&<>])/$escapes{$1}/g;
return $s;
}
# escape a string according with the output requirements
# params: string to be escaped
# return: escaped string
sub output_esc{
return xml_escape(shift) if defined $opt_docbook;
return shift;
}
# eliminate casts and expressions.
# (always go on the first operand)
# params: node (GCC::Node)
# result: if node is an expression it will walk on operand(0) until first non
# expression element is found
sub expr_op0{
my $n=shift;
while(($n->isa('GCC::Node::Expression') || $n->isa('GCC::Node::Unary')) &&
defined $n->operand(0)) {
$n=$n->operand(0);
}
return $n;
}
# read command line args
if ($#ARGV < 0 || ! GetOptions( 'help|h|?' => \$opt_help,
'file|f=s' => \$file,
'txt|t' => \$opt_txt,
'docbook|xml' => \$opt_docbook,
'tu|T' => \$opt_is_tu,
'source|src|s=s' => \$src_fname,
'defs|d=s'=>\$c_defs,
'group|grp|g=s'=>\$opt_grp_name,
'force-group|force-grp|G=s' =>
\$opt_force_grp_name,
'dbg|debug|D'=>\$dbg,
'gcc=s' => \$gcc,
'patch' => \$opt_patch) ||
defined $opt_help) {
do { show_patch(); exit 0; } if (defined $opt_patch);
select(STDERR) if ! defined $opt_help;
help();
exit((defined $opt_help)?0:1);
}
do { show_patch(); exit 0; } if (defined $opt_patch);
do { select(STDERR); help(); exit 1 } if (!defined $file);
if (defined $opt_txt){
$output_format_header="HEADER";
$output_format_footer="FOOTER";
$output_format_varline="VARLINE2";
}elsif (defined $opt_docbook){
$output_format_header="DOCBOOK_HEADER";
$output_format_footer="DOCBOOK_FOOTER";
$output_format_varline="DOCBOOK_VARLINE";
}
if (! defined $opt_is_tu){
# file is not a gcc translation-unit dump
# => we have to create one
$src_fname=basename($file);
$tmp_file = "/tmp/" . mktemp ("dump_translation_unit_XXXXXX");
# Note: gcc < 4.5 will produce the translation unit dump in a file in
# the current directory. gcc 4.5 will write it in the same directory as
# the output file.
system("$gcc -fdump-translation-unit $c_defs -c $file -o $tmp_file") == 0
or die "$gcc -fdump-translation-unit $c_defs -c $file -o $tmp_file" .
" failed to generate a translation unit dump from $file";
if (system("if [ -f \"$src_fname\".001t.tu ]; then \
mv \"$src_fname\".001t.tu $tmp_file; \
else mv /tmp/\"$src_fname\".001t.tu $tmp_file; fi ") != 0) {
unlink($tmp_file, "$tmp_file.o");
die "could not find the gcc translation unit dump file" .
" ($src_fname.001t.tu) neither in the current directory" .
" or /tmp";
};
$tu=GCC::TranslationUnit::Parser->parsefile($tmp_file);
print(STDERR "src name $src_fname\n") if $dbg;
unlink($tmp_file, "$tmp_file.o");
}else{
$tu=GCC::TranslationUnit::Parser->parsefile($file);
}
print(STDERR "Parsing file $file...\n") if $dbg;
#
# function_decl: name, type, srcp (source), chan?, body?, link (e.g. extern)
# parm_decl: name, type, scpe, srcp, chan, argt, size, algn, used
# field_decl: name, type, scpe (scope), srcp, size, algn, bpos (bit pos?)
#
# array_type: size, algn, elts (elements?), domn ?
#
#
# name as string $node->name->identifier
#
# E.g.: static cfg_def_t tcp_cfg_def[]= {...}
# ^^^^^^^^^^^
#
# @7695 var_decl: name: @7705 type: @7706 srcp: tcp_options.c:51
# chan: @7707 init: @7708 size: @7709
# algn: 256 used: 1
#
# @7705 (var name) identifier_node strg: tcp_cfg_def lngt 11
# @7706 (var type) array_type: size:@7709 algn: 32 elts: @2265 domn: @7718
# @7707 (? next ? ) function_decl: ....
# @7708 (initializer) constructor: lngt: 25
# idx : @20 val : @7723 [...]
# @7709 interget_cst: type: @11 low: 5600
#
# @2265 (array type) record_type: name: @2256 unql: @2255 size: @2002
# algn: 32 tag : struct flds: @2263
# @2256 (type) type_decl: name: @2264 type: @2265 srcp: cfg.h:73
# chan: @2266
# @2264 (name) identifier_node: strg: cfg_def_t
print(STDERR "Searching...\n") if $dbg;
$i=0;
# iterate on the entire nodes array (returned by gcc), but skipping node 0
SEARCH: for $node (@{$tu}[1..$#{$tu}]) {
$i++;
while($node) {
if (
@cnt_defs == 0 && # parse it only once
$node->isa('GCC::Node::var_decl') &&
$node->type->isa('GCC::Node::array_type') &&
(! defined $src_fname || $src_fname eq "" ||
$node->source=~"$src_fname")
){
# found a var decl. that it's an array
# check if it's a valid array type
next if (!( $node->type->can('elements') &&
defined $node->type->elements &&
$node->type->elements->can('name') &&
defined $node->type->elements->name &&
$node->type->elements->name->can('name') &&
defined $node->type->elements->name->name)
);
my $type_name= $node->type->elements->name->name->identifier;
if ($type_name eq $var_type) {
#printf "tree[$i]: found var %s %s (%s)\n",
# $type_name,
# $node->name->identifier,v
# $node->source;
#print ("keys:", join " ", keys %$node, "\n");
#print ("keys init:", join " ", keys %{$node->initial}, "\n");
if ($node->can('initial') && defined $node->initial) {
my %c1=%{$node->initial};
$cnt_name=$node->name->identifier;
if (defined $c1{val}){
my $c1_el;
die $patch_required if (ref($c1{val}) ne "ARRAY");
# iterate on array elem., level 1( top {} )
# each element is a constructor
for $c1_el (@{$c1{val}}) {
# finally we are a the lower {} initializer
my %c2=%{$c1_el};
my @el=@{$c2{val}};
my ($handle_n, $name_n, $flags_n, $cbk_n,
$cbk_param_n, $desc_n)=@el;
my ($name, $desc);
if ($name_n->isa('GCC::Node::integer_cst')){
printf(" ERROR: integer non-0 name (%d)\n",
$name_n->low) if ($name_n->low!=0);
last SEARCH; # exit
}
$name=expr_op0($name_n)->string;
$desc=expr_op0($desc_n)->string;
push @cnt_defs, [$name, $desc];
}
}
}
}
}
} continue {
if ($node->can('chain')){
$node = $node->chain;
}else{
last;
}
}
}
print(STDERR "Done.\n") if $dbg;
my ($name, $flags, $min, $max, $desc);
my ($type, $extra_txt, $default);
if (@cnt_defs > 0){
my $l;
my $no=@cnt_defs;
$i=0;
# dump the configuration in txt mode
if (defined $opt_force_grp_name) {
$cnt_grp_name=output_esc($opt_force_grp_name);
}elsif (!defined $cnt_grp_name && defined $opt_grp_name) {
$cnt_grp_name=output_esc($opt_grp_name);
}
$~ = $output_format_header; write;
$~ = $output_format_varline ;
for $l (@cnt_defs){
($name, $desc)=@{$l};
$extra_txt="";
$i++;
$extra_txt=output_esc($extra_txt);
$desc .= "." if $desc =~ /[^.]$/;
$desc=output_esc($desc);
$name=output_esc($name);
# generate txt description
write;
}
$~ = $output_format_footer; write;
}else{
die "no counter variables found in $file\n";
}
sub valid_grp_name
{
my $name=shift;
return defined $name && $name ne "";
}
format HEADER =
Counters@*
(valid_grp_name $cnt_grp_name) ? " for " . $cnt_grp_name : ""
=======================@*
"=" x length((valid_grp_name $cnt_grp_name)?" for " . $cnt_grp_name : "")
@||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
"[ this file is autogenerated, do not edit ]"
.
format FOOTER =
.
format VARLINE =
@>. @<<<<<<<<<<<<<<<<<<< - ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
$i, $name, $desc
~~ ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
$desc
~~ ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
$extra_txt
.
format VARLINE2 =
@>. @*
$i, (valid_grp_name $cnt_grp_name)?$cnt_grp_name . "." . $name : $name
~~ ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
$desc
~~ ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
$extra_txt
.
format DOCBOOK_HEADER =
<?xml version="1.0" encoding="UTF-8"?>
<!-- this file is autogenerated, do not edit! -->
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<chapter id="counters@*">
(valid_grp_name $cnt_grp_name) ? "." . $cnt_grp_name : ""
<title> Counters@*</title>
(valid_grp_name $cnt_grp_name) ? " for " . $cnt_grp_name : ""
.
format DOCBOOK_FOOTER =
</chapter>
.
format DOCBOOK_VARLINE =
<section id="@*">
(valid_grp_name $cnt_grp_name)?$cnt_grp_name . "." . $name : $name
<title>@*</title>
(valid_grp_name $cnt_grp_name)?$cnt_grp_name . "." . $name : $name
<para>
~~ ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
$desc
</para>
<para>
~~ ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
$extra_txt
</para>
</section>
.