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