allow kconfig symbols to be shared between packages
[openwrt.git] / scripts / metadata.pl
1 #!/usr/bin/perl
2 use strict;
3 my %preconfig;
4 my %package;
5 my %srcpackage;
6 my %category;
7 my %subdir;
8
9 sub get_multiline {
10         my $prefix = shift;
11         my $str;
12         while (<>) {
13                 last if /^@@/;
14                 s/^\s*//g;
15                 $str .= (($_ and $prefix) ? $prefix . $_ : $_);
16         }
17
18         return $str;
19 }
20
21 sub parse_target_metadata() {
22         my ($target, @target, $profile);        
23         while (<>) {
24                 chomp;
25                 /^Target:\s*((.+)-(\d+\.\d+))\s*$/ and do {
26                         my $conf = uc $3.'_'.$2;
27                         $conf =~ tr/\.-/__/;
28                         $target = {
29                                 id => $1,
30                                 conf => $conf,
31                                 board => $2,
32                                 kernel => $3,
33                                 profiles => []
34                         };
35                         push @target, $target;
36                 };
37                 /^Target-Name:\s*(.+)\s*$/ and $target->{name} = $1;
38                 /^Target-Path:\s*(.+)\s*$/ and $target->{path} = $1;
39                 /^Target-Arch:\s*(.+)\s*$/ and $target->{arch} = $1;
40                 /^Target-Features:\s*(.+)\s*$/ and $target->{features} = [ split(/\s+/, $1) ];
41                 /^Target-Description:/ and $target->{desc} = get_multiline();
42                 /^Linux-Version:\s*(.+)\s*$/ and $target->{version} = $1;
43                 /^Linux-Release:\s*(.+)\s*$/ and $target->{release} = $1;
44                 /^Linux-Kernel-Arch:\s*(.+)\s*$/ and $target->{karch} = $1;
45                 /^Default-Packages:\s*(.+)\s*$/ and $target->{packages} = [ split(/\s+/, $1) ];
46                 /^Target-Profile:\s*(.+)\s*$/ and do {
47                         $profile = {
48                                 id => $1,
49                                 name => $1,
50                                 packages => []
51                         };
52                         push @{$target->{profiles}}, $profile;
53                 };
54                 /^Target-Profile-Name:\s*(.+)\s*$/ and $profile->{name} = $1;
55                 /^Target-Profile-Packages:\s*(.*)\s*$/ and $profile->{packages} = [ split(/\s+/, $1) ];
56                 /^Target-Profile-Description:\s*(.*)\s*/ and $profile->{desc} = get_multiline();
57                 /^Target-Profile-Config:/ and $profile->{config} = get_multiline("\t");
58                 /^Target-Profile-Kconfig:/ and $profile->{kconfig} = 1;
59         }
60         foreach my $target (@target) {
61                 @{$target->{profiles}} > 0 or $target->{profiles} = [
62                         {
63                                 id => 'Default',
64                                 name => 'Default',
65                                 packages => []
66                         }
67                 ];
68         }
69         return @target;
70 }
71
72 sub parse_package_metadata() {
73         my $pkg;
74         my $makefile;
75         my $preconfig;
76         my $subdir;
77         my $src;
78         while (<>) {
79                 chomp;
80                 /^Source-Makefile: \s*((.+\/)([^\/]+)\/Makefile)\s*$/ and do {
81                         $makefile = $1;
82                         $subdir = $2;
83                         $src = $3;
84                         $subdir =~ s/^package\///;
85                         $subdir{$src} = $subdir;
86                         $srcpackage{$src} = [];
87                         undef $pkg;
88                 };
89                 /^Package:\s*(.+?)\s*$/ and do {
90                         $pkg = {};
91                         $pkg->{src} = $src;
92                         $pkg->{makefile} = $makefile;
93                         $pkg->{name} = $1;
94                         $pkg->{default} = "m if ALL";
95                         $pkg->{depends} = [];
96                         $pkg->{builddepends} = [];
97                         $pkg->{subdir} = $subdir;
98                         $package{$1} = $pkg;
99                         push @{$srcpackage{$src}}, $pkg;
100                 };
101                 /^Version: \s*(.+)\s*$/ and $pkg->{version} = $1;
102                 /^Title: \s*(.+)\s*$/ and $pkg->{title} = $1;
103                 /^Menu: \s*(.+)\s*$/ and $pkg->{menu} = $1;
104                 /^Submenu: \s*(.+)\s*$/ and $pkg->{submenu} = $1;
105                 /^Submenu-Depends: \s*(.+)\s*$/ and $pkg->{submenudep} = $1;
106                 /^Default: \s*(.+)\s*$/ and $pkg->{default} = $1;
107                 /^Provides: \s*(.+)\s*$/ and do {
108                         my @vpkg = split /\s+/, $1;
109                         foreach my $vpkg (@vpkg) {
110                                 $package{$vpkg} or $package{$vpkg} = { vdepends => [] };
111                                 push @{$package{$vpkg}->{vdepends}}, $pkg->{name};
112                         }
113                 };
114                 /^Depends: \s*(.+)\s*$/ and $pkg->{depends} = [ split /\s+/, $1 ];
115                 /^Build-Depends: \s*(.+)\s*$/ and $pkg->{builddepends} = [ split /\s+/, $1 ];
116                 /^Category: \s*(.+)\s*$/ and do {
117                         $pkg->{category} = $1;
118                         defined $category{$1} or $category{$1} = {};
119                         defined $category{$1}->{$src} or $category{$1}->{$src} = [];
120                         push @{$category{$1}->{$src}}, $pkg;
121                 };
122                 /^Description: \s*(.*)\s*$/ and $pkg->{description} = "\t\t $1\n". get_multiline("\t\t ");
123                 /^Config: \s*(.*)\s*$/ and $pkg->{config} = "$1\n".get_multiline();
124                 /^Prereq-Check:/ and $pkg->{prereq} = 1;
125                 /^Preconfig:\s*(.+)\s*$/ and do {
126                         my $pkgname = $pkg->{name};
127                         $preconfig{$pkgname} or $preconfig{$pkgname} = [];
128                         $preconfig = {
129                                 id => $1
130                         };
131                         push @{$preconfig{$pkgname}}, $preconfig;
132                 };
133                 /^Preconfig-Type:\s*(.*?)\s*$/ and $preconfig->{type} = $1;
134                 /^Preconfig-Label:\s*(.*?)\s*$/ and $preconfig->{label} = $1;
135                 /^Preconfig-Default:\s*(.*?)\s*$/ and $preconfig->{default} = $1;
136         }
137         return %category;
138 }
139
140 sub gen_kconfig_overrides() {
141         my %config;
142         my %kconfig;
143         my $package;
144         my $pkginfo = shift @ARGV;
145         my $cfgfile = shift @ARGV;
146
147         # parameter 2: build system config
148         open FILE, "<$cfgfile" or return;
149         while (<FILE>) {
150                 /^(CONFIG_.+?)=(.+)$/ and $config{$1} = 1;
151         }
152         close FILE;
153
154         # parameter 1: package metadata
155         open FILE, "<$pkginfo" or return;
156         while (<FILE>) {
157                 /^Package:\s*(.+?)\s*$/ and $package = $1;
158                 /^Kernel-Config:\s*(.+?)\s*$/ and do {
159                         my @config = split /\s+/, $1;
160                         foreach my $config (@config) {
161                                 my $val = 'm';
162                                 my $override;
163                                 if ($config =~ /^(.+?)=(.+)$/) {
164                                         $config = $1;
165                                         $override = 1;
166                                         $val = $2;
167                                 }
168                                 if ($config{"CONFIG_PACKAGE_$package"} and ($config ne 'n')) {
169                                         $kconfig{$config} = $val;
170                                 } elsif (!$override) {
171                                         $kconfig{$config} or $kconfig{$config} = 'n';
172                                 }
173                         }
174                 };
175         };
176         close FILE;
177
178         foreach my $kconfig (sort keys %kconfig) {
179                 if ($kconfig{$kconfig} eq 'n') {
180                         print "# $kconfig is not set\n";
181                 } else {
182                         print "$kconfig=$kconfig{$kconfig}\n";
183                 }
184         }
185 }
186
187 sub merge_package_lists($$) {
188         my $list1 = shift;
189         my $list2 = shift;
190         my @l = ();
191         my %pkgs;
192
193         foreach my $pkg (@$list1, @$list2) {
194                 $pkgs{$pkg} = 1;
195         }
196         foreach my $pkg (keys %pkgs) {
197                 push @l, $pkg unless ($pkg =~ /^-/ or $pkgs{"-$pkg"});
198         }
199         return sort(@l);
200 }
201
202 sub gen_target_mk() {
203         my @target = parse_target_metadata();
204         
205         @target = sort {
206                 $a->{id} cmp $b->{id}
207         } @target;
208         
209         foreach my $target (@target) {
210                 my ($profiles_def, $profiles_eval);
211                 my $conf = uc $target->{kernel}.'_'.$target->{board};
212                 $conf =~ tr/\.-/__/;
213                 
214                 foreach my $profile (@{$target->{profiles}}) {
215                         $profiles_def .= "
216   define Profile/$conf\_$profile->{id}
217     ID:=$profile->{id}
218     NAME:=$profile->{name}
219     PACKAGES:=".join(" ", merge_package_lists($target->{packages}, $profile->{packages}))."\n";
220                         $profile->{kconfig} and $profiles_def .= "    KCONFIG:=1\n";
221                         $profiles_def .= "  endef";
222                         $profiles_eval .= "
223 \$(eval \$(call AddProfile,$conf\_$profile->{id}))"
224                 }
225                 print "
226 ifeq (\$(CONFIG_LINUX_$conf),y)
227   define Target
228     KERNEL:=$target->{kernel}
229     BOARD:=$target->{board}
230     BOARDNAME:=$target->{name}
231     LINUX_VERSION:=$target->{version}
232     LINUX_RELEASE:=$target->{release}
233     LINUX_KARCH:=$target->{karch}
234     DEFAULT_PACKAGES:=".join(" ", @{$target->{packages}})."
235   endef$profiles_def
236 endif$profiles_eval
237
238 "
239         }
240         print "\$(eval \$(call Target))\n";
241 }
242
243 sub target_config_features(@) {
244         my $ret;
245
246         while ($_ = shift @_) {
247                 /broken/ and $ret .= "\tdepends BROKEN\n";
248                 /pci/ and $ret .= "\tselect PCI_SUPPORT\n";
249                 /usb/ and $ret .= "\tselect USB_SUPPORT\n";
250                 /atm/ and $ret .= "\tselect ATM_SUPPORT\n";
251                 /pcmcia/ and $ret .= "\tselect PCMCIA_SUPPORT\n";
252                 /video/ and $ret .= "\tselect VIDEO_SUPPORT\n";
253                 /squashfs/ and $ret .= "\tselect USES_SQUASHFS\n";
254                 /jffs2/ and $ret .= "\tselect USES_JFFS2\n";
255                 /ext2/ and $ret .= "\tselect USES_EXT2\n";
256         }
257         return $ret;
258 }
259
260
261 sub gen_target_config() {
262         my @target = parse_target_metadata();
263
264         @target = sort {
265                 $a->{name} cmp $b->{name}
266         } @target;
267         
268         
269         print <<EOF;
270 choice
271         prompt "Target System"
272         default LINUX_2_4_BRCM
273         reset if !DEVEL
274         
275 EOF
276
277         foreach my $target (@target) {
278                 my $features = target_config_features(@{$target->{features}});
279                 my $help = $target->{desc};
280                 my $kernel = $target->{kernel};
281                 $kernel =~ tr/./_/;
282
283                 chomp $features;
284                 $features .= "\n";
285                 if ($help =~ /\w+/) {
286                         $help =~ s/^\s*/\t  /mg;
287                         $help = "\thelp\n$help";
288                 } else {
289                         undef $help;
290                 }
291         
292                 print <<EOF
293 config LINUX_$target->{conf}
294         bool "$target->{name}"
295         select $target->{arch}
296         select LINUX_$kernel
297 $features$help
298
299 EOF
300         }
301
302         print <<EOF;
303 if DEVEL
304
305 config LINUX_2_6_ARM
306         bool "UNSUPPORTED little-endian arm platform"
307         depends BROKEN
308         select LINUX_2_6
309         select arm
310
311 config LINUX_2_6_CRIS
312         bool "UNSUPPORTED cris platform"
313         depends BROKEN
314         select LINUX_2_6
315         select cris
316
317 config LINUX_2_6_M68K
318         bool "UNSUPPORTED m68k platform"
319         depends BROKEN
320         select LINUX_2_6
321         select m68k
322
323 config LINUX_2_6_SH3
324         bool "UNSUPPORTED little-endian sh3 platform"
325         depends BROKEN
326         select LINUX_2_6
327         select sh3
328
329 config LINUX_2_6_SH3EB
330         bool "UNSUPPORTED big-endian sh3 platform"
331         depends BROKEN
332         select LINUX_2_6
333         select sh3eb
334
335 config LINUX_2_6_SH4
336         bool "UNSUPPORTED little-endian sh4 platform"
337         depends BROKEN
338         select LINUX_2_6
339         select sh4
340
341 config LINUX_2_6_SH4EB
342         bool "UNSUPPORTED big-endian sh4 platform"
343         depends BROKEN
344         select LINUX_2_6
345         select sh4eb
346
347 config LINUX_2_6_SPARC
348         bool "UNSUPPORTED sparc platform"
349         depends BROKEN
350         select LINUX_2_6
351         select sparc
352
353 endif
354
355 endchoice
356
357 choice
358         prompt "Target Profile"
359
360 EOF
361         
362         foreach my $target (@target) {
363                 my $profiles = $target->{profiles};
364                 
365                 foreach my $profile (@$profiles) {
366                         print <<EOF;
367 config LINUX_$target->{conf}_$profile->{id}
368         bool "$profile->{name}"
369         depends LINUX_$target->{conf}
370 $profile->{config}
371 EOF
372                         $profile->{kconfig} and print "\tselect PROFILE_KCONFIG\n";
373                         my @pkglist = merge_package_lists($target->{packages}, $profile->{packages});
374                         foreach my $pkg (@pkglist) {
375                                 print "\tselect DEFAULT_$pkg\n";
376                         }
377                         print "\n";
378                 }
379         }
380
381         print "endchoice\n";
382 }
383
384
385 sub find_package_dep($$) {
386         my $pkg = shift;
387         my $name = shift;
388         my $deps = ($pkg->{vdepends} or $pkg->{depends});
389
390         return 0 unless defined $deps;
391         foreach my $dep (@{$deps}) {
392                 return 1 if $dep eq $name;
393                 return 1 if ($package{$dep} and (find_package_dep($package{$dep},$name) == 1));
394         }
395         return 0;
396 }
397
398 sub package_depends($$) {
399         my $a = shift;
400         my $b = shift;
401         my $ret;
402
403         return 0 if ($a->{submenu} ne $b->{submenu});
404         if (find_package_dep($a, $b->{name}) == 1) {
405                 $ret = 1;
406         } elsif (find_package_dep($b, $a->{name}) == 1) {
407                 $ret = -1;
408         } else {
409                 return 0;
410         }
411         return $ret;
412 }
413
414 sub mconf_depends($$) {
415         my $depends = shift;
416         my $only_dep = shift;
417         my $res;
418
419         $depends or return;
420         my @depends = @$depends;
421         foreach my $depend (@depends) {
422                 my $m = "depends";
423                 $depend =~ s/^([@\+]+)//;
424                 my $flags = $1;
425                 my $vdep;
426         
427                 if ($vdep = $package{$depend}->{vdepends}) {
428                         $depend = join("||", map { "PACKAGE_".$_ } @$vdep);
429                 } else {
430                         $flags =~ /\+/ and do {
431                                 next if $only_dep;
432                                 $m = "select";
433
434                                 # Menuconfig will not treat 'select FOO' as a real dependency
435                                 # thus if FOO depends on other config options, these dependencies
436                                 # will not be checked. To fix this, we simply emit all of FOO's
437                                 # depends here as well.
438                                 $package{$depend} and $res .= mconf_depends($package{$depend}->{depends}, 1);
439                         };
440                         $flags =~ /@/ or $depend = "PACKAGE_$depend";
441                 }
442                 $res .= "\t\t$m $depend\n";
443         }
444         return $res;
445 }
446
447 sub print_package_config_category($) {
448         my $cat = shift;
449         my %menus;
450         my %menu_dep;
451         
452         return unless $category{$cat};
453         
454         print "menu \"$cat\"\n\n";
455         my %spkg = %{$category{$cat}};
456         
457         foreach my $spkg (sort {uc($a) cmp uc($b)} keys %spkg) {
458                 foreach my $pkg (@{$spkg{$spkg}}) {
459                         my $menu = $pkg->{submenu};
460                         if ($menu) {
461                                 $menu_dep{$menu} or $menu_dep{$menu} = $pkg->{submenudep};
462                         } else {
463                                 $menu = 'undef';
464                         }
465                         $menus{$menu} or $menus{$menu} = [];
466                         push @{$menus{$menu}}, $pkg;
467                         print "\tconfig DEFAULT_".$pkg->{name}."\n";
468                         print "\t\tbool\n\n";
469                 }
470         }
471         my @menus = sort {
472                 ($a eq 'undef' ?  1 : 0) or
473                 ($b eq 'undef' ? -1 : 0) or
474                 ($a cmp $b)
475         } keys %menus;
476
477         foreach my $menu (@menus) {
478                 my @pkgs = sort {
479                         package_depends($a, $b) or
480                         ($a->{name} cmp $b->{name})
481                 } @{$menus{$menu}};
482                 if ($menu ne 'undef') {
483                         $menu_dep{$menu} and print "if $menu_dep{$menu}\n";
484                         print "menu \"$menu\"\n";
485                 }
486                 foreach my $pkg (@pkgs) {
487                         my $title = $pkg->{name};
488                         my $c = (72 - length($pkg->{name}) - length($pkg->{title}));
489                         if ($c > 0) {
490                                 $title .= ("." x $c). " ". $pkg->{title};
491                         }
492                         print "\t";
493                         $pkg->{menu} and print "menu";
494                         print "config PACKAGE_".$pkg->{name}."\n";
495                         print "\t\ttristate \"$title\"\n";
496                         print "\t\tdefault y if DEFAULT_".$pkg->{name}."\n";
497                         foreach my $default (split /\s*,\s*/, $pkg->{default}) {
498                                 print "\t\tdefault $default\n";
499                         }
500                         print mconf_depends($pkg->{depends}, 0);
501                         print "\t\thelp\n";
502                         print $pkg->{description};
503                         print "\n";
504
505                         $pkg->{config} and print $pkg->{config}."\n";
506                 }
507                 if ($menu ne 'undef') {
508                         print "endmenu\n";
509                         $menu_dep{$menu} and print "endif\n";
510                 }
511         }
512         print "endmenu\n\n";
513         
514         undef $category{$cat};
515 }
516
517 sub gen_package_config() {
518         parse_package_metadata();
519         print "menuconfig UCI_PRECONFIG\n\tbool \"Image configuration\"\n";
520         foreach my $preconfig (keys %preconfig) {
521                 foreach my $cfg (@{$preconfig{$preconfig}}) {
522                         my $conf = $cfg->{id};
523                         $conf =~ tr/\.-/__/;
524                         print <<EOF
525         config UCI_PRECONFIG_$conf
526                 string "$cfg->{label}" if UCI_PRECONFIG
527                 depends PACKAGE_$preconfig
528                 default "$cfg->{default}"
529
530 EOF
531                 }
532         }
533         print_package_config_category 'Base system';
534         foreach my $cat (keys %category) {
535                 print_package_config_category $cat;
536         }
537 }
538
539 sub gen_package_mk() {
540         my %conf;
541         my %dep;
542         my $line;
543
544         parse_package_metadata();
545         foreach my $name (sort {uc($a) cmp uc($b)} keys %package) {
546                 my $config;
547                 my $pkg = $package{$name};
548                 
549                 next if defined $pkg->{vdepends};
550                 if ($ENV{SDK}) {
551                         $conf{$pkg->{src}} or do {
552                                 $config = 'm';
553                                 $conf{$pkg->{src}} = 1;
554                         };
555                 } else {
556                         $config = "\$(CONFIG_PACKAGE_$name)"
557                 }
558                 if ($config) {
559                         print "package-$config += $pkg->{subdir}$pkg->{src}\n";
560                         $pkg->{prereq} and print "prereq-$config += $pkg->{src}\n";
561                 }
562         
563                 my $hasdeps = 0;
564                 my $depline = "";
565                 foreach my $dep (@{$pkg->{depends}}, @{$pkg->{builddepends}}) {
566                         next if $dep =~ /@/;
567                         $dep =~ s/\+//;
568                         my $idx;
569                         my $pkg_dep = $package{$dep};
570                         next if defined $pkg_dep->{vdepends};
571
572                         if (defined $pkg_dep->{src}) {
573                                 ($pkg->{src} ne $pkg_dep->{src}) and $idx = $pkg_dep->{subdir}.$pkg_dep->{src};
574                         } elsif (defined($srcpackage{$dep})) {
575                                 $idx = $subdir{$dep}.$dep;
576                         }
577                         undef $idx if $idx =~ /^(kernel)|(base-files)$/;
578                         if ($idx) {
579                                 next if $dep{$pkg->{src}."->".$idx};
580                                 $depline .= " $idx\-compile";
581                                 $dep{$pkg->{src}."->".$idx} = 1;
582                         }
583                 }
584                 if ($depline) {
585                         $line .= $pkg->{subdir}."$pkg->{src}-compile: $depline\n";
586                 }
587         }
588         
589         if ($line ne "") {
590                 print "\n$line";
591         }
592         foreach my $preconfig (keys %preconfig) {
593                 my $cmds;
594                 foreach my $cfg (@{$preconfig{$preconfig}}) {
595                         my $conf = $cfg->{id};
596                         $conf =~ tr/\.-/__/;
597                         $cmds .= "\techo \"uci set '$cfg->{id}=\$(subst \",,\$(CONFIG_UCI_PRECONFIG_$conf))'\"; \\\n";
598                 }
599                 next unless $cmds;
600                 print <<EOF
601
602 \$(TARGET_DIR)/etc/uci-defaults/$preconfig: FORCE
603         ( \\
604 $cmds \\
605         ) > \$@
606         
607 ifneq (\$(UCI_PRECONFIG)\$(CONFIG_UCI_PRECONFIG),)
608   preconfig: \$(TARGET_DIR)/etc/uci-defaults/$preconfig
609 endif
610 EOF
611         }
612 }
613
614
615 sub parse_command() {
616         my $cmd = shift @ARGV;
617         for ($cmd) {
618                 /^target_mk$/ and return gen_target_mk();
619                 /^target_config$/ and return gen_target_config();
620                 /^package_mk$/ and return gen_package_mk();
621                 /^package_config$/ and return gen_package_config();
622                 /^kconfig/ and return gen_kconfig_overrides();
623         }
624         print <<EOF
625 Available Commands:
626         $0 target_mk [file]             Target metadata in makefile format
627         $0 target_config [file]         Target metadata in Kconfig format
628         $0 package_mk [file]            Package metadata in makefile format
629         $0 package_config [file]        Package metadata in Kconfig format
630         $0 kconfig [file] [config]      Kernel config overrides
631
632 EOF
633 }
634
635 parse_command();