^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) #! /usr/bin/env perl
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) # SPDX-License-Identifier: GPL-2.0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) #
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) # Detect cycles in the header file dependency graph
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) # Vegard Nossum <vegardno@ifi.uio.no>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) #
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) use strict;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) use warnings;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) use Getopt::Long;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) my $opt_all;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) my @opt_include;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) my $opt_graph;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) &Getopt::Long::Configure(qw(bundling pass_through));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) &GetOptions(
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) help => \&help,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) version => \&version,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) all => \$opt_all,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) "I=s" => \@opt_include,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) graph => \$opt_graph,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) );
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) push @opt_include, 'include';
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) my %deps = ();
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) my %linenos = ();
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) my @headers = grep { strip($_) } @ARGV;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) parse_all(@headers);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) if($opt_graph) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) graph();
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) } else {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) detect_cycles(@headers);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) sub help {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) print "Usage: $0 [options] file...\n";
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) print "\n";
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) print "Options:\n";
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) print " --all\n";
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) print " --graph\n";
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) print "\n";
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) print " -I includedir\n";
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) print "\n";
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) print "To make nice graphs, try:\n";
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) print " $0 --graph include/linux/kernel.h | dot -Tpng -o graph.png\n";
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) exit;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) sub version {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) print "headerdep version 2\n";
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) exit;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) # Get a file name that is relative to our include paths
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) sub strip {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) my $filename = shift;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) for my $i (@opt_include) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) my $stripped = $filename;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) $stripped =~ s/^$i\///;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) return $stripped if $stripped ne $filename;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) return $filename;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) # Search for the file name in the list of include paths
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) sub search {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) my $filename = shift;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) return $filename if -f $filename;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) for my $i (@opt_include) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) my $path = "$i/$filename";
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) return $path if -f $path;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) return;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) sub parse_all {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) # Parse all the headers.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) my @queue = @_;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) while(@queue) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) my $header = pop @queue;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) next if exists $deps{$header};
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) $deps{$header} = [] unless exists $deps{$header};
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) my $path = search($header);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) next unless $path;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) open(my $file, '<', $path) or die($!);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) chomp(my @lines = <$file>);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) close($file);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) for my $i (0 .. $#lines) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) my $line = $lines[$i];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) if(my($dep) = ($line =~ m/^#\s*include\s*<(.*?)>/)) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) push @queue, $dep;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) push @{$deps{$header}}, [$i + 1, $dep];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) sub print_cycle {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) # $cycle[n] includes $cycle[n + 1];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) # $cycle[-1] will be the culprit
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) my $cycle = shift;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) # Adjust the line numbers
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) for my $i (0 .. $#$cycle - 1) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) $cycle->[$i]->[0] = $cycle->[$i + 1]->[0];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) $cycle->[-1]->[0] = 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) my $first = shift @$cycle;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) my $last = pop @$cycle;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) my $msg = "In file included";
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) printf "%s from %s,\n", $msg, $last->[1] if defined $last;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) for my $header (reverse @$cycle) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) printf "%s from %s:%d%s\n",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) " " x length $msg,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) $header->[1], $header->[0],
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) $header->[1] eq $last->[1] ? ' <-- here' : '';
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) printf "%s:%d: warning: recursive header inclusion\n",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) $first->[1], $first->[0];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) # Find and print the smallest cycle starting in the specified node.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) sub detect_cycles {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) my @queue = map { [[0, $_]] } @_;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) while(@queue) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) my $top = pop @queue;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) my $name = $top->[-1]->[1];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) for my $dep (@{$deps{$name}}) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) my $chain = [@$top, [$dep->[0], $dep->[1]]];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) # If the dep already exists in the chain, we have a
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) # cycle...
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) if(grep { $_->[1] eq $dep->[1] } @$top) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) print_cycle($chain);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) next if $opt_all;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) return;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) push @queue, $chain;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) sub mangle {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) $_ = shift;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) s/\//__/g;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) s/\./_/g;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) s/-/_/g;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) $_;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) # Output dependency graph in GraphViz language.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) sub graph {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) print "digraph {\n";
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) print "\t/* vertices */\n";
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) for my $header (keys %deps) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178) printf "\t%s [label=\"%s\"];\n",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) mangle($header), $header;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) print "\n";
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) print "\t/* edges */\n";
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185) for my $header (keys %deps) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) for my $dep (@{$deps{$header}}) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) printf "\t%s -> %s;\n",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) mangle($header), mangle($dep->[1]);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192) print "}\n";
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193) }
Orange Pi5 kernel
Deprecated Linux kernel 5.10.110 for OrangePi 5/5B/5+ boards
3 Commits
0 Branches
0 Tags