3 # Copyright (c) 2001 David Schleef <ds@schleef.org>
4 # Copyright (c) 2001 Erik Andersen <andersen@codepoet.org>
5 # Copyright (c) 2001 Stuart Hughes <seh@zee2.com>
6 # Copyright (c) 2002 Steven J. Hill <shill@broadcom.com>
7 # Copyright (c) 2006 Freescale Semiconductor, Inc <stuarth@freescale.com>
10 # March 2006: Stuart Hughes <stuarth@freescale.com>.
11 # Significant updates, including implementing the '-F' option
12 # and adding support for 2.6 kernels.
14 # This program is free software; you can redistribute it and/or modify it
15 # under the same terms as Perl itself.
16 use Getopt::Long qw(:config no_auto_abbrev no_ignore_case);
20 # Set up some default values
32 my $nm = $ENV{'NM'} || "nm";
41 $0 -b basedir { -k <vmlinux> | -F <System.map> } [options]...
43 -h --help : Show this help screen
44 -b --basedir : Modules base directory (e.g /lib/modules/<2.x.y>)
45 -k --kernel : Kernel binary for the target (e.g. vmlinux)
46 -F --kernelsyms : Kernel symbol file (e.g. System.map)
47 -n --stdout : Write to stdout instead of <basedir>/modules.dep
48 -v --verbose : Print out lots of debugging stuff
49 -P --symbol-prefix : Symbol prefix
50 -a --all : Probe all modules (default/only thing supported)
51 -e --errsyms : Report any symbols not supplied by modules/kernel
54 # get command-line options
57 "basedir|b=s" => \$basedir,
58 "kernel|k=s" => \$kernel,
59 "kernelsyms|F=s" => \$kernelsyms,
60 "stdout|n" => \$stdout,
61 "verbose|v" => \$verbose,
62 "symbol-prefix|P=s" => \$symprefix,
66 # ignored options (for historical usage)
73 die $usage unless $basedir && ( $kernel || $kernelsyms );
74 die "can't use both -k and -F\n\n$usage" if $kernel && $kernelsyms;
75 die "sorry, -A/--quick is not supported" if $quick;
76 die "--errsyms requires --kernelsyms" if $errsyms && !$kernelsyms;
78 # Strip any trailing or multiple slashes from basedir
81 # The base directory should contain /lib/modules somewhere
82 if($basedir !~ m-/lib/modules-) {
83 warn "WARNING: base directory does not match ..../lib/modules\n";
86 # if no kernel version is contained in the basedir, try to find one
87 if($basedir !~ m-/lib/modules/\d\.\d-) {
88 opendir(BD, $basedir) or die "can't open basedir $basedir : $!\n";
89 foreach ( readdir(BD) ) {
91 next unless -d "$basedir/$_";
92 warn "dir = $_\n" if $verbose;
95 warn("Guessed module directory as $basedir/$kdir\n");
100 die "Cannot find a kernel version under $basedir\n" unless $kdir;
101 $basedir = "$basedir/$kdir";
104 # Find the list of .o or .ko files living under $basedir
105 warn "**** Locating all modules\n" if $verbose;
108 if ( -f $_ && ! -d $_ ) {
109 $file = $File::Find::name;
110 if ( $file =~ /\.k?o$/ ) {
111 push(@liblist, $file);
112 warn "$file\n" if $verbose;
116 warn "**** Finished locating modules\n" if $verbose;
118 foreach my $obj ( @liblist ){
119 # turn the input file name into a target tag name
120 my ($tgtname) = $obj =~ m-(/lib/modules/.*)$-;
122 warn "\nMODULE = $tgtname\n" if $verbose;
124 # get a list of symbols
125 my @output=`$nm $obj`;
127 build_ref_tables($tgtname, \@output, $exp, $dep);
131 # vmlinux is a special name that is only used to resolve symbols
132 my $tgtname = 'vmlinux';
133 my @output = $kernelsyms ? `cat $kernelsyms` : `$nm $kernel`;
134 warn "\nMODULE = $tgtname\n" if $verbose;
135 build_ref_tables($tgtname, \@output, $exp, $dep);
137 # resolve the dependencies for each module
138 # reduce dependencies: remove unresolvable and resolved from vmlinux/System.map
140 foreach my $module (keys %$dep) {
141 warn "reducing module: $module\n" if $verbose;
142 $mod->{$module} = {};
143 foreach (@{$dep->{$module}}) {
145 warn "resolved symbol $_ in file $exp->{$_}\n" if $verbose;
146 next if $exp->{$_} =~ /vmlinux/;
147 $mod->{$module}{$exp->{$_}} = 1;
149 warn "unresolved symbol $_ in file $module\n";
154 # build a complete dependency list for each module and make sure it
155 # is kept in order proper order
159 my ($array, $ele) = @_;
160 # chop off the leading path /lib/modules/<kver>/ as modprobe
161 # will handle relative paths just fine
162 $ele =~ s:^/lib/modules/[^/]*/::;
163 foreach (@{$array}) {
168 unshift (@{$array}, $ele);
172 my ($depth, $mod, $mod2, $module, $this_module) = @_;
175 warn "${depth}loading deps of module: $this_module\n" if $verbose;
177 foreach my $md (keys %{$mod->{$this_module}}) {
178 add_mod_deps ($depth, $mod, $mod2, $module, $md);
179 warn "${depth} outputting $md\n" if $verbose;
180 maybe_unshift (\@{$$mod2->{$module}}, $md);
183 if (!%{$mod->{$this_module}}) {
184 warn "${depth} no deps\n" if $verbose;
187 foreach my $module (keys %$mod) {
188 warn "filling out module: $module\n" if $verbose;
189 @{$mod2->{$module}} = ();
190 add_mod_deps ("", $mod, \$mod2, $module, $module);
193 # figure out where the output should go
195 warn "writing $basedir/modules.dep\n" if $verbose;
196 open(STDOUT, ">$basedir/modules.dep")
197 or die "cannot open $basedir/modules.dep: $!";
199 my $kseries = $basedir =~ m,/2\.6\.[^/]*, ? '2.6' : '2.4';
201 foreach my $module ( keys %$mod ) {
202 if($kseries eq '2.4') {
204 my @sorted = sort bydep keys %{$mod->{$module}};
205 print join(" \\\n\t",@sorted);
208 my $shortmod = $module;
209 $shortmod =~ s:^/lib/modules/[^/]*/::;
211 my @sorted = @{$mod2->{$module}};
212 printf " " if @sorted;
213 print join(" ",@sorted);
221 my ($name, $sym_ar, $exp, $dep) = @_;
223 my $ksymtab = grep m/ ${symprefix}__ksymtab/, @$sym_ar;
225 # gather the exported symbols
227 # explicitly exported
228 foreach ( @$sym_ar ) {
229 / ${symprefix}__ksymtab_(.*)$/ and do {
230 my $sym = ${symprefix} . $1;
231 warn "sym = $sym\n" if $verbose;
232 $exp->{$sym} = $name;
236 # exporting all symbols
237 foreach ( @$sym_ar ) {
238 / [ABCDGRSTW] (.*)$/ and do {
239 warn "syma = $1\n" if $verbose;
245 # this takes makes sure modules with no dependencies get listed
246 push @{$dep->{$name}}, $symprefix . 'printk' unless $name eq 'vmlinux';
248 # gather the unresolved symbols
249 foreach ( @$sym_ar ) {
250 !/ ${symprefix}__this_module/ && / U (.*)$/ and do {
251 warn "und = $1\n" if $verbose;
252 push @{$dep->{$name}}, $1;
259 foreach my $f ( keys %{$mod->{$b}} ) {
273 depmod.pl - a cross platform script to generate kernel module
274 dependency lists (modules.conf) which can then be used by modprobe
275 on the target platform.
277 It supports Linux 2.4 and 2.6 styles of modules.conf (auto-detected)
281 depmod.pl [OPTION]... [basedir]...
285 depmod.pl -F linux/System.map -b target/lib/modules/2.6.11
289 The purpose of this script is to automagically generate a list of of kernel
290 module dependencies. This script produces dependency lists that should be
291 identical to the depmod program from the modutils package. Unlike the depmod
292 binary, however, depmod.pl is designed to be run on your host system, not
293 on your target system.
295 This script was written by David Schleef <ds@schleef.org> to be used in
296 conjunction with the BusyBox modprobe applet.
304 This displays the help message.
306 =item B<-b --basedir>
308 The base directory uner which the target's modules will be found. This
309 defaults to the /lib/modules directory.
311 If you don't specify the kernel version, this script will search for
312 one under the specified based directory and use the first thing that
313 looks like a kernel version.
317 Kernel binary for the target (vmlinux). You must either supply a kernel binary
318 or a kernel symbol file (using the -F option).
320 =item B<-F --kernelsyms>
322 Kernel symbol file for the target (System.map).
326 Write to stdout instead of modules.dep
327 kernel binary for the target (using the -k option).
331 Verbose (debug) output
335 =head1 COPYRIGHT AND LICENSE
337 Copyright (c) 2001 David Schleef <ds@schleef.org>
338 Copyright (c) 2001 Erik Andersen <andersen@codepoet.org>
339 Copyright (c) 2001 Stuart Hughes <seh@zee2.com>
340 Copyright (c) 2002 Steven J. Hill <shill@broadcom.com>
341 Copyright (c) 2006 Freescale Semiconductor, Inc <stuarth@freescale.com>
343 This program is free software; you can redistribute it and/or modify it
344 under the same terms as Perl itself.
348 David Schleef <ds@schleef.org>