xref: /linux-6.15/scripts/checkstack.pl (revision d41e2d73)
11da177e4SLinus Torvalds#!/usr/bin/perl
21da177e4SLinus Torvalds
31da177e4SLinus Torvalds#	Check the stack usage of functions
41da177e4SLinus Torvalds#
52b54aaefSJoern Engel#	Copyright Joern Engel <[email protected]>
61da177e4SLinus Torvalds#	Inspired by Linus Torvalds
71da177e4SLinus Torvalds#	Original idea maybe from Keith Owens
81da177e4SLinus Torvalds#	s390 port and big speedup by Arnd Bergmann <[email protected]>
91da177e4SLinus Torvalds#	Mips port by Juan Quintela <[email protected]>
101da177e4SLinus Torvalds#	IA64 port via Andreas Dilger
111da177e4SLinus Torvalds#	Arm port by Holger Schurig
121da177e4SLinus Torvalds#	sh64 port by Paul Mundt
131da177e4SLinus Torvalds#	Random bits by Matt Mackall <[email protected]>
141da177e4SLinus Torvalds#	M68k port by Geert Uytterhoeven and Andreas Schwab
150367d892SHaavard Skinnemoen#	AVR32 port by Haavard Skinnemoen <[email protected]>
16562d139cSKyle McMartin#	PARISC port by Kyle McMartin <[email protected]>
17*d41e2d73SMartin Habets#	sparc port by Martin Habets <[email protected]>
181da177e4SLinus Torvalds#
191da177e4SLinus Torvalds#	Usage:
20477116e6SJoern Engel#	objdump -d vmlinux | scripts/checkstack.pl [arch]
211da177e4SLinus Torvalds#
221da177e4SLinus Torvalds#	TODO :	Port to all architectures (one regex per arch)
231da177e4SLinus Torvalds
241da177e4SLinus Torvalds# check for arch
251da177e4SLinus Torvalds#
261da177e4SLinus Torvalds# $re is used for two matches:
271da177e4SLinus Torvalds# $& (whole re) matches the complete objdump line with the stack growth
281da177e4SLinus Torvalds# $1 (first bracket) matches the size of the stack growth
291da177e4SLinus Torvalds#
30585e93aeSEric Sandeen# $dre is similar, but for dynamic stack redutions:
31585e93aeSEric Sandeen# $& (whole re) matches the complete objdump line with the stack growth
32585e93aeSEric Sandeen# $1 (first bracket) matches the dynamic amount of the stack growth
33585e93aeSEric Sandeen#
341da177e4SLinus Torvalds# use anything else and feel the pain ;)
35585e93aeSEric Sandeenmy (@stack, $re, $dre, $x, $xs);
361da177e4SLinus Torvalds{
371da177e4SLinus Torvalds	my $arch = shift;
381da177e4SLinus Torvalds	if ($arch eq "") {
391da177e4SLinus Torvalds		$arch = `uname -m`;
40abddaec5SEric Sandeen		chomp($arch);
411da177e4SLinus Torvalds	}
421da177e4SLinus Torvalds
431da177e4SLinus Torvalds	$x	= "[0-9a-f]";	# hex character
441da177e4SLinus Torvalds	$xs	= "[0-9a-f ]";	# hex character or space
451da177e4SLinus Torvalds	if ($arch eq 'arm') {
461da177e4SLinus Torvalds		#c0008ffc:	e24dd064	sub	sp, sp, #100	; 0x64
471da177e4SLinus Torvalds		$re = qr/.*sub.*sp, sp, #(([0-9]{2}|[3-9])[0-9]{2})/o;
480367d892SHaavard Skinnemoen	} elsif ($arch eq 'avr32') {
490367d892SHaavard Skinnemoen		#8000008a:       20 1d           sub sp,4
500367d892SHaavard Skinnemoen		#80000ca8:       fa cd 05 b0     sub sp,sp,1456
510367d892SHaavard Skinnemoen		$re = qr/^.*sub.*sp.*,([0-9]{1,8})/o;
521da177e4SLinus Torvalds	} elsif ($arch =~ /^i[3456]86$/) {
531da177e4SLinus Torvalds		#c0105234:       81 ec ac 05 00 00       sub    $0x5ac,%esp
541da177e4SLinus Torvalds		$re = qr/^.*[as][du][db]    \$(0x$x{1,8}),\%esp$/o;
55585e93aeSEric Sandeen		$dre = qr/^.*[as][du][db]    (%.*),\%esp$/o;
561da177e4SLinus Torvalds	} elsif ($arch eq 'x86_64') {
571da177e4SLinus Torvalds		#    2f60:	48 81 ec e8 05 00 00 	sub    $0x5e8,%rsp
581da177e4SLinus Torvalds		$re = qr/^.*[as][du][db]    \$(0x$x{1,8}),\%rsp$/o;
59585e93aeSEric Sandeen		$dre = qr/^.*[as][du][db]    (\%.*),\%rsp$/o;
601da177e4SLinus Torvalds	} elsif ($arch eq 'ia64') {
611da177e4SLinus Torvalds		#e0000000044011fc:       01 0f fc 8c     adds r12=-384,r12
621da177e4SLinus Torvalds		$re = qr/.*adds.*r12=-(([0-9]{2}|[3-9])[0-9]{2}),r12/o;
631da177e4SLinus Torvalds	} elsif ($arch eq 'm68k') {
641da177e4SLinus Torvalds		#    2b6c:       4e56 fb70       linkw %fp,#-1168
651da177e4SLinus Torvalds		#  1df770:       defc ffe4       addaw #-28,%sp
661da177e4SLinus Torvalds		$re = qr/.*(?:linkw %fp,|addaw )#-([0-9]{1,4})(?:,%sp)?$/o;
671da177e4SLinus Torvalds	} elsif ($arch eq 'mips64') {
681da177e4SLinus Torvalds		#8800402c:       67bdfff0        daddiu  sp,sp,-16
691da177e4SLinus Torvalds		$re = qr/.*daddiu.*sp,sp,-(([0-9]{2}|[3-9])[0-9]{2})/o;
701da177e4SLinus Torvalds	} elsif ($arch eq 'mips') {
711da177e4SLinus Torvalds		#88003254:       27bdffe0        addiu   sp,sp,-32
721da177e4SLinus Torvalds		$re = qr/.*addiu.*sp,sp,-(([0-9]{2}|[3-9])[0-9]{2})/o;
73562d139cSKyle McMartin	} elsif ($arch eq 'parisc' || $arch eq 'parisc64') {
74562d139cSKyle McMartin		$re = qr/.*ldo ($x{1,8})\(sp\),sp/o;
751da177e4SLinus Torvalds	} elsif ($arch eq 'ppc') {
761da177e4SLinus Torvalds		#c00029f4:       94 21 ff 30     stwu    r1,-208(r1)
771da177e4SLinus Torvalds		$re = qr/.*stwu.*r1,-($x{1,8})\(r1\)/o;
781da177e4SLinus Torvalds	} elsif ($arch eq 'ppc64') {
791da177e4SLinus Torvalds		#XXX
801da177e4SLinus Torvalds		$re = qr/.*stdu.*r1,-($x{1,8})\(r1\)/o;
81271c511dSJohannes Berg	} elsif ($arch eq 'powerpc') {
82271c511dSJohannes Berg		$re = qr/.*st[dw]u.*r1,-($x{1,8})\(r1\)/o;
831da177e4SLinus Torvalds	} elsif ($arch =~ /^s390x?$/) {
841da177e4SLinus Torvalds		#   11160:       a7 fb ff 60             aghi   %r15,-160
8589d49841SChristian Borntraeger		# or
8689d49841SChristian Borntraeger		#  100092:	 e3 f0 ff c8 ff 71	 lay	 %r15,-56(%r15)
8789d49841SChristian Borntraeger		$re = qr/.*(?:lay|ag?hi).*\%r15,-(([0-9]{2}|[3-9])[0-9]{2})
8889d49841SChristian Borntraeger		      (?:\(\%r15\))?$/ox;
891da177e4SLinus Torvalds	} elsif ($arch =~ /^sh64$/) {
901da177e4SLinus Torvalds		#XXX: we only check for the immediate case presently,
911da177e4SLinus Torvalds		#     though we will want to check for the movi/sub
921da177e4SLinus Torvalds		#     pair for larger users. -- PFM.
931da177e4SLinus Torvalds		#a00048e0:       d4fc40f0        addi.l  r15,-240,r15
941da177e4SLinus Torvalds		$re = qr/.*addi\.l.*r15,-(([0-9]{2}|[3-9])[0-9]{2}),r15/o;
951e9535a5SMike Frysinger	} elsif ($arch =~ /^blackfin$/) {
961e9535a5SMike Frysinger		#   0:   00 e8 38 01     LINK 0x4e0;
971e9535a5SMike Frysinger		$re = qr/.*[[:space:]]LINK[[:space:]]*(0x$x{1,8})/o;
98*d41e2d73SMartin Habets	} elsif ($arch eq 'sparc' || $arch eq 'sparc64') {
99*d41e2d73SMartin Habets		# f0019d10:       9d e3 bf 90     save  %sp, -112, %sp
100*d41e2d73SMartin Habets		$re = qr/.*save.*%sp, -(([0-9]{2}|[3-9])[0-9]{2}), %sp/o;
1011da177e4SLinus Torvalds	} else {
102abddaec5SEric Sandeen		print("wrong or unknown architecture \"$arch\"\n");
1031da177e4SLinus Torvalds		exit
1041da177e4SLinus Torvalds	}
1051da177e4SLinus Torvalds}
1061da177e4SLinus Torvalds
1071da177e4SLinus Torvaldssub bysize($) {
1081da177e4SLinus Torvalds	my ($asize, $bsize);
1091da177e4SLinus Torvalds	($asize = $a) =~ s/.*:	*(.*)$/$1/;
1101da177e4SLinus Torvalds	($bsize = $b) =~ s/.*:	*(.*)$/$1/;
1111da177e4SLinus Torvalds	$bsize <=> $asize
1121da177e4SLinus Torvalds}
1131da177e4SLinus Torvalds
1141da177e4SLinus Torvalds#
1151da177e4SLinus Torvalds# main()
1161da177e4SLinus Torvalds#
1171da177e4SLinus Torvaldsmy $funcre = qr/^$x* <(.*)>:$/;
1181da177e4SLinus Torvaldsmy $func;
1198ad2914dSRandy Dunlapmy $file, $lastslash;
1208ad2914dSRandy Dunlap
1211da177e4SLinus Torvaldswhile (my $line = <STDIN>) {
1221da177e4SLinus Torvalds	if ($line =~ m/$funcre/) {
1231da177e4SLinus Torvalds		$func = $1;
1241da177e4SLinus Torvalds	}
1258ad2914dSRandy Dunlap	elsif ($line =~ m/(.*):\s*file format/) {
1268ad2914dSRandy Dunlap		$file = $1;
1278ad2914dSRandy Dunlap		$file =~ s/\.ko//;
1288ad2914dSRandy Dunlap		$lastslash = rindex($file, "/");
1298ad2914dSRandy Dunlap		if ($lastslash != -1) {
1308ad2914dSRandy Dunlap			$file = substr($file, $lastslash + 1);
1318ad2914dSRandy Dunlap		}
1328ad2914dSRandy Dunlap	}
1338ad2914dSRandy Dunlap	elsif ($line =~ m/$re/) {
1341da177e4SLinus Torvalds		my $size = $1;
1351da177e4SLinus Torvalds		$size = hex($size) if ($size =~ /^0x/);
1361da177e4SLinus Torvalds
1371da177e4SLinus Torvalds		if ($size > 0xf0000000) {
1381da177e4SLinus Torvalds			$size = - $size;
1391da177e4SLinus Torvalds			$size += 0x80000000;
1401da177e4SLinus Torvalds			$size += 0x80000000;
1411da177e4SLinus Torvalds		}
1421da177e4SLinus Torvalds		next if ($size > 0x10000000);
1431da177e4SLinus Torvalds
1441da177e4SLinus Torvalds		next if $line !~ m/^($xs*)/;
1451da177e4SLinus Torvalds		my $addr = $1;
1461da177e4SLinus Torvalds		$addr =~ s/ /0/g;
1471da177e4SLinus Torvalds		$addr = "0x$addr";
1481da177e4SLinus Torvalds
1498ad2914dSRandy Dunlap		my $intro = "$addr $func [$file]:";
1501da177e4SLinus Torvalds		my $padlen = 56 - length($intro);
1511da177e4SLinus Torvalds		while ($padlen > 0) {
1521da177e4SLinus Torvalds			$intro .= '	';
1531da177e4SLinus Torvalds			$padlen -= 8;
1541da177e4SLinus Torvalds		}
1551da177e4SLinus Torvalds		next if ($size < 100);
1561da177e4SLinus Torvalds		push @stack, "$intro$size\n";
1571da177e4SLinus Torvalds	}
158585e93aeSEric Sandeen	elsif (defined $dre && $line =~ m/$dre/) {
159585e93aeSEric Sandeen		my $size = "Dynamic ($1)";
160585e93aeSEric Sandeen
161585e93aeSEric Sandeen		next if $line !~ m/^($xs*)/;
162585e93aeSEric Sandeen		my $addr = $1;
163585e93aeSEric Sandeen		$addr =~ s/ /0/g;
164585e93aeSEric Sandeen		$addr = "0x$addr";
165585e93aeSEric Sandeen
166585e93aeSEric Sandeen		my $intro = "$addr $func [$file]:";
167585e93aeSEric Sandeen		my $padlen = 56 - length($intro);
168585e93aeSEric Sandeen		while ($padlen > 0) {
169585e93aeSEric Sandeen			$intro .= '	';
170585e93aeSEric Sandeen			$padlen -= 8;
171585e93aeSEric Sandeen		}
172585e93aeSEric Sandeen		push @stack, "$intro$size\n";
173585e93aeSEric Sandeen	}
1741da177e4SLinus Torvalds}
1751da177e4SLinus Torvalds
1761da177e4SLinus Torvaldsprint sort bysize @stack;
177