1dd9759e70659e2558accfba81ac4ca09b31dfe2
[sip-router] / doc / scripts / cdefs2doc / dump_cfg_defs.pl
1 #!/usr/bin/perl
2
3 #
4 # Generate docs from ser/sip-router cfg group descriptions
5 # (run on files generated by gcc -fdump-translation-unit -c file.c, 
6 #  try -h for help)
7 # E.g.: dump_cfg_defs.pl --file cfg_core.c  --defs="-DUSE_SCTP ..."
8 #
9 # History:
10 # =======
11 #  2009-10-16  initial version (Andrei Pelinescu-Onciul <andrei@iptel.org>)
12 #
13
14 # Note: uses GCC::TranslationUnit (see cpan) with the following patch:
15 #@@ -251,6 +251,8 @@
16 #           $node->{vector}[$key] = $value;
17 #       } elsif($key =~ /^op (\d+)$/) {
18 #           $node->{operand}[$1] = $value;
19 #+      } elsif ($key eq "val") {
20 #+              push @{$node->{$key}}, ($value) ;
21 #       } else {
22 #           $node->{$key} = $value;
23 #       }
24
25 #
26 # Assumptions:
27 #  - the first array of type cfg_def_t with an initializer is the array
28 #    with the config definitions (name, type, description a.s.o.). Only
29 #    one cfg_def array per file is supported.
30 #  - the first variable of type struct cfg_group_(.*) , with an intializer,
31 #    contains the default values. If no group name is specified on the 
32 #    command line (--group) the group name is derived from the struct
33 #    name ($1). The default values are optional. Only one such variable is
34 #    supported per file.
35 #  - if the number of the default values is different from the number of
36 #    elements in the config defs array, the default values are discarded.
37 #
38 # Output notes:
39 #  - range is not printed if min==max==0.
40 #  - default values are not printed if missing
41
42
43 use strict;
44 use warnings;
45 use Getopt::Long;
46 use File::Temp qw(:mktemp);
47 use File::Basename;
48 use lib "/home/andrei/perl/modules/share/perl/5.10.1";
49 use GCC::TranslationUnit;
50
51 # text printed if we discover that GCC::TranslationUnit is unpatched
52 my $patch_required="$0 requires a patched GCC:TranslationUnit, see the " .
53                                 "comments at the beginning of the file or try --patch\n";
54 # gcc name
55 my $gcc="gcc";
56 # default defines
57 my $c_defs="-D__CPU_i386 -D__OS_linux -DSER_VER=2099099 -DPKG_MALLOC -DSHM_MEM  -DSHM_MMAP -DDNS_IP_HACK -DUSE_IPV6 -DUSE_MCAST -DUSE_TCP -DUSE_DNS_CACHE -DUSE_DNS_FAILOVER -DUSE_DST_BLACKLIST -DUSE_NAPTR  -DUSE_TLS -DTLS_HOOKS -DFAST_LOCK   -DCC_GCC_LIKE_ASM -DHAVE_GETHOSTBYNAME2 -DHAVE_UNION_SEMUN -DHAVE_SCHED_YIELD -DHAVE_MSG_NOSIGNAL -DHAVE_MSGHDR_MSG_CONTROL -DHAVE_ALLOCA_H -DHAVE_SCHED_SETSCHEDULER -DHAVE_EPOLL -DUSE_SCTP -DNAME='\"ser\"' -DVERSION='\"2.99.99-pre3\"' -DARCH='\"i386\"' -DOS_QUOTED='\"linux\"' -DSER_MOD_INTERFACE";
58
59 # file with gcc syntax tree
60 my $file; #"tcp_options.c.001t.tu" ;
61 my $tmp_file;
62 my $src_fname;
63
64 # type to look for
65 my $var_type="cfg_def_t";
66
67 my $tu;
68 my $node;
69 my $i;
70 my @cfg_defs; # filled with config var definition (cfg_def_t)
71 my @cfg_default; # filled with config var defaults
72 my ($cfg_grp_name, $def_cfg_name, $cfg_var_name);
73
74 my ($opt_help, $opt_txt, $opt_is_tu, $dbg, $opt_grp_name, $opt_patch);
75 my $opt_force_grp_name;
76
77
78
79 sub show_patch
80 {
81 my $patch='
82 --- GCC/TranslationUnit.pm.orig 2009-10-16 17:57:51.275963053 +0200
83 +++ GCC/TranslationUnit.pm      2009-10-16 20:17:28.128455959 +0200
84 @@ -251,6 +251,8 @@
85             $node->{vector}[$key] = $value;
86         } elsif($key =~ /^op (\d+)$/) {
87             $node->{operand}[$1] = $value;
88 +       } elsif ($key eq "val") {
89 +               push @{$node->{$key}}, ($value) ;
90         } else {
91             $node->{$key} = $value;
92         }
93 ';
94
95 print $patch;
96 }
97
98
99 sub help
100 {
101         #print "Usage: $0 --file fname [--src src_fname] [--txt|-t] [--help|-h]\n";
102         $~ = "USAGE";
103         write;
104
105 format USAGE =
106 Usage @*  -f filename | --file filename  [options...]
107       $0
108 Options:
109          -f        filename    - use filename for input (see also -T/--tu).
110          --file    filename    - same as -f.
111          -h | -? | --help      - this help message.
112          -D | --dbg | --debug  - enable debugging messages.
113          -d | --defs           - defines to be passed on gcc's command line
114                                  (e.g. --defs="-DUSE_SCTP -DUSE_TCP").
115          -g | --grp  name
116          --group     name      - config group name used if one cannot be
117                                  autodetected (e.g. no default value 
118                                  intializer present in the file).
119          -G | --force-grp name
120          --force-group    name - force using a config group name, even if one
121                                  is autodetected (see also -g).
122          --gcc     gcc_name    - run gcc_name instead of gcc.
123          -t | --txt            - text mode output.
124          -T | --tu             - the input file is in raw gcc translation
125                                  unit format (as produced by
126                                    gcc -fdump-translation-unit -c ). If not
127                                  present it's assumed that the file contains
128                                  C code.
129          -s | --src | --source - name of the source file, needed only if
130                                  the input file is in "raw" translation
131                                  unit format (--tu) and usefull to restrict
132                                  and speed-up the search.
133          --patch               - show patches needed for the
134                                  GCC::TranslationUnit package.
135 .
136
137 }
138
139 # eliminate casts and expressions.
140 # (always go on the first operand)
141 # params: node (GCC::Node)
142 # result: if node is an expression it will walk on operand(0) until first non
143 # expression element is found
144 sub expr_op0{
145         my $n=shift;
146         
147         while(($n->isa('GCC::Node::Expression') || $n->isa('GCC::Node::Unary')) &&
148                         defined $n->operand(0)) {
149                 $n=$n->operand(0);
150         }
151         return $n;
152 }
153
154
155
156 # read command line args
157 if ($#ARGV < 0 || ! GetOptions( 'help|h|?' => \$opt_help,
158                                                                 'file|f=s' => \$file,
159                                                                 'txt|t' => \$opt_txt,
160                                                                 'tu|T' => \$opt_is_tu,
161                                                                 'source|src|s=s' => \$src_fname,
162                                                                 'defs|d=s'=>\$c_defs,
163                                                                 'group|grp|g=s'=>\$opt_grp_name,
164                                                                 'force-group|force-grp|G=s' =>
165                                                                                                         \$opt_force_grp_name,
166                                                                 'dbg|debug|D'=>\$dbg,
167                                                                 'gcc=s' => \$gcc,
168                                                                 'patch' => \$opt_patch) ||
169                 defined $opt_help) {
170         do { show_patch(); exit 0; } if (defined $opt_patch);
171         select(STDERR) if ! defined $opt_help;
172         help();
173         exit((defined $opt_help)?0:1);
174 }
175
176 do { show_patch(); exit 0; } if (defined $opt_patch);
177 do { select(STDERR); help(); exit 1 } if (!defined $file);
178
179 if (! defined $opt_is_tu){
180         # file is not a gcc translation-unit dump
181         # => we have to create one
182         $src_fname=basename($file);
183         $tmp_file = "/tmp/" . mktemp ("dump_translation_unit_XXXXXX");
184         system("$gcc -fdump-translation-unit $c_defs -c $file -o $tmp_file.o && \
185                         mv \"$src_fname\".001t.tu  $tmp_file") == 0 or
186                 die "$gcc failed to generate a translation unit dump from $file";
187         $tu=GCC::TranslationUnit::Parser->parsefile($tmp_file);
188         print(STDERR "src name $src_fname\n") if $dbg;
189         unlink($tmp_file, "$tmp_file.o");
190 }else{
191         $tu=GCC::TranslationUnit::Parser->parsefile($file);
192 }
193
194 print(STDERR "Parsing file $file...\n") if $dbg;
195 #
196 # function_decl: name, type, srcp (source), chan?, body?, link (e.g. extern)
197 # parm_decl: name, type, scpe, srcp, chan, argt, size, algn, used
198 # field_decl: name, type, scpe (scope), srcp, size, algn, bpos (bit pos?)
199 #
200 # array_type: size, algn, elts (elements?), domn ?
201 #
202 #
203 # name as string $node->name->identifier
204 #
205 # E.g.: static cfg_def_t tcp_cfg_def[]= {...}
206 #                        ^^^^^^^^^^^
207 #
208 # @7695 var_decl:  name: @7705   type: @7706    srcp: tcp_options.c:51
209 #                  chan: @7707    init: @7708    size: @7709
210 #                  algn: 256      used: 1
211
212 # @7705 (var name)      identifier_node strg: tcp_cfg_def lngt 11
213 # @7706 (var type)      array_type: size:@7709 algn: 32 elts: @2265 domn: @7718
214 # @7707 (? next ?  )    function_decl: ....
215 # @7708 (intializer)    constructor: lngt: 25
216 #                                    idx : @20      val : @7723    [...]
217 # @7709                 interget_cst: type: @11 low: 5600
218 #
219 # @2265 (array type)    record_type: name: @2256    unql: @2255    size: @2002
220 #                                    algn: 32       tag : struct   flds: @2263
221 # @2256 (type)          type_decl: name: @2264    type: @2265    srcp: cfg.h:73
222 #                                  chan: @2266
223 # @2264 (name)                  identifier_node:  strg: cfg_def_t
224
225 print(STDERR "Searching...\n") if $dbg;
226 $i=0;
227 # iterate on the entire nodes array (returned by gcc), but skipping node 0
228 SEARCH: for $node (@{$tu}[1..$#{$tu}]) {
229         $i++;
230         while($node) {
231                 if (
232                         @cfg_defs == 0 &&  # parse it only once
233                         $node->isa('GCC::Node::var_decl') &&
234                         $node->type->isa('GCC::Node::array_type')  &&
235                         (! defined $src_fname || $src_fname eq "" ||
236                                 $node->source=~"$src_fname")
237                         ){
238                         # found a var decl. that it's an array
239                         # check if it's a valid array type
240                         next if (!(     $node->type->can('elements') &&
241                                                 defined $node->type->elements &&
242                                                 $node->type->elements->can('name') &&
243                                                 defined $node->type->elements->name &&
244                                                 $node->type->elements->name->can('name') &&
245                                                 defined $node->type->elements->name->name)
246                                         );
247                         my $type_name= $node->type->elements->name->name->identifier;
248                         if ($type_name eq $var_type) {
249                                 #printf "tree[$i]: found var %s %s (%s)\n",
250                                 #               $type_name,
251                                 #               $node->name->identifier,v
252                                 #               $node->source;
253                                 #print ("keys:", join " ", keys %$node, "\n");
254                                 #print ("keys init:", join " ", keys %{$node->initial}, "\n");
255                                 if ($node->can('initial') && defined $node->initial) {
256                                         my %c1=%{$node->initial};
257                                         $cfg_var_name=$node->name->identifier;
258                                         if (defined $c1{val}){
259                                                 my $c1_el;
260                                                 die $patch_required if (ref($c1{val}) ne "ARRAY");
261                                                 # iterate on array elem., level 1( top {} )
262                                                 # each element is a constructor
263                                                 for $c1_el (@{$c1{val}}) {
264                                                         # finally we are a the lower {} initializer
265                                                         my %c2=%{$c1_el};
266                                                         my @el=@{$c2{val}};
267                                                         my ($name_n, $type_n, $min_n, $max_n, $fixup_n, 
268                                                                         $pcbk_n, $desc_n)=@el;
269                                                         my ($name, $type, $min, $max, $desc);
270                                                         if ($name_n->isa('GCC::Node::integer_cst')){
271                                                                 printf(" ERROR: integer non-0 name (%d)\n",
272                                                                                 $name_n->low) if ($name_n->low!=0);
273                                                                 if (@cfg_default > 0){
274                                                                         last SEARCH; # exit
275                                                                 }else{
276                                                                         next; # have to look for defaults too
277                                                                 }
278                                                         }
279                                                         $name=expr_op0($name_n)->string;
280                                                         $type=$type_n->low;
281                                                         $min=$min_n->low;
282                                                         $max=$max_n->low;
283                                                         $desc=expr_op0($desc_n)->string;
284                                                         push @cfg_defs, [$name, $type, $min, $max, $desc];
285                                                 }
286                                         }
287                                 }
288                         }
289                 }elsif (@cfg_default == 0 && # parse it only once
290                                 $node->isa('GCC::Node::var_decl') &&
291                                 $node->type->isa('GCC::Node::record_type') &&
292                                 (! defined $src_fname || $src_fname eq "" ||
293                                         $node->source=~"$src_fname") &&
294                                 defined $node->type->name->can('identifier') &&
295                                 $node->type->name->identifier=~"cfg_group_([a-z0-9_]+)" &&
296                                 $node->can('initial') && defined $node->initial) {
297                                 my %c1=%{$node->initial};
298                                 if (defined $c1{val}){
299                                         my $c1_el;
300                                         $cfg_grp_name=$1;
301                                         $def_cfg_name=$node->name->identifier;
302                                         print(STDERR "found default cfg: $def_cfg_name,", 
303                                                                 "grp $cfg_grp_name\n") if $dbg;
304                                         die $patch_required if (ref($c1{val}) ne "ARRAY");
305                                         # iterate on array elem.,( top {} )
306                                         # each element is an integer, expr (string pointer) or
307                                         # constructor (str)
308                                         for $c1_el (@{$c1{val}}) {
309                                                 if ($c1_el->isa('GCC::Node::integer_cst')){
310                                                         push @cfg_default, $c1_el->low;
311                                                 }elsif ($c1_el->isa('GCC::Node::constructor')){
312                                                         push @cfg_default, "<unknown:str>";
313                                                 }else{
314                                                         push @cfg_default, expr_op0($c1_el)->string;
315                                                 }
316                                         }
317                                         last SEARCH if @cfg_defs > 0; # exit
318                                 }
319                 }
320         } continue {
321                 if ($node->can('chain')){
322                         $node = $node->chain;
323                 }else{
324                         last;
325                 }
326         }
327 }
328
329 print(STDERR "Done.\n") if $dbg;
330
331 my ($name, $flags, $min, $max, $desc);
332 my ($type, $extra_txt, $default);
333
334 if (@cfg_defs > 0){
335         my $l;
336         my $no=@cfg_default;
337         $i=0;
338         if ($no > 0 && @cfg_defs != $no) {
339                 print(STDERR "WARNING: different array lenghts ($def_cfg_name($no) &&",
340                                 " $cfg_var_name($(scalar @cfg_defs)))\n");
341                 $no=0;
342         }
343         # dump the configuration in txt mode
344         if (defined $opt_force_grp_name) {
345                 $cfg_grp_name=$opt_force_grp_name;
346         }elsif (!defined $cfg_grp_name && defined $opt_grp_name) {
347                 $cfg_grp_name=$opt_grp_name;
348         }
349         $~ = "HEADER"; write;
350         $~ = "VARLINE2" ;
351         for $l (@cfg_defs){
352                 ($name, $flags, $min, $max, $desc)=@{$l};
353                 $type="";
354                 $extra_txt="";
355                 $default= ($no>0) ? $cfg_default[$i] : "";
356                 
357                 $i++;
358                 if ($min==0 && $max==0) {
359                         $min=""; $max="";
360                 }
361                 if ($flags & 8) {
362                         $type="integer";
363                 }elsif ($flags & 16) {
364                         $type="string";
365                 }elsif ($flags & 32) {
366                         $type="string"; # str
367                 }else{
368                         my $t = $flags & 7;
369                         $t == 1 && do { $type="integer"; };
370                         $t == 2 && do { $type="string"; };
371                         $t == 3 && do { $type="string"; }; # str
372                         $t == 4 && do { $type=""; }; # pointer
373                 }
374                 
375                 $extra_txt.="Read-only." if ($flags & 128 );
376                 $desc.=".";
377                 # generate txt description
378                 write;
379         }
380 }else{
381         die "no configuration variables found in $file\n";
382 }
383
384
385 sub valid_grp_name
386 {
387         my $name=shift;
388         return defined $name && $name ne "";
389 }
390
391
392 format HEADER =
393 Configuration Variables@*
394 (valid_grp_name $cfg_grp_name) ? " for " . $cfg_grp_name : ""
395 =======================@*
396 "=" x length((valid_grp_name $cfg_grp_name)?" for " . $cfg_grp_name : "")
397
398 @||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
399 "[ this file is autogenerated, do not edit ]"
400
401
402 .
403
404 format VARLINE =
405 @>. @<<<<<<<<<<<<<<<<<<< - ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
406 $i, $name,                 $desc
407 ~~                         ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
408                            $desc
409 ~                          Default: @*.
410                            $default
411 ~                          Range: @* - @*.
412                                   $min, $max
413 ~                          Type: @*. ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
414                                  $type, $extra_txt
415 ~~                         ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
416                            $extra_txt
417
418 .
419
420 format VARLINE2 =
421 @>. @*
422 $i, (valid_grp_name $cfg_grp_name)?$cfg_grp_name . "." . $name : $name
423 ~~      ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
424         $desc
425 ~       Default: @*.
426                  $default
427 ~       Range: @* - @*.
428                $min, $max
429 ~       Type: @*. ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
430               $type, $extra_txt
431 ~~      ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
432         $extra_txt
433
434 .