xref: /linux-6.15/scripts/checkstack.pl (revision fda9f990)
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
15e05503efSJean Delvare#	AVR32 port by Haavard Skinnemoen (Atmel)
16562d139cSKyle McMartin#	PARISC port by Kyle McMartin <[email protected]>
17d41e2d73SMartin 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
241f2a144fSStephen Hemmingeruse strict;
251f2a144fSStephen Hemminger
261da177e4SLinus Torvalds# check for arch
271da177e4SLinus Torvalds#
281da177e4SLinus Torvalds# $re is used for two matches:
291da177e4SLinus Torvalds# $& (whole re) matches the complete objdump line with the stack growth
301da177e4SLinus Torvalds# $1 (first bracket) matches the size of the stack growth
311da177e4SLinus Torvalds#
32585e93aeSEric Sandeen# $dre is similar, but for dynamic stack redutions:
33585e93aeSEric Sandeen# $& (whole re) matches the complete objdump line with the stack growth
34585e93aeSEric Sandeen# $1 (first bracket) matches the dynamic amount of the stack growth
35585e93aeSEric Sandeen#
361da177e4SLinus Torvalds# use anything else and feel the pain ;)
37690998b6SJames Hoganmy (@stack, $re, $dre, $x, $xs, $funcre);
381da177e4SLinus Torvalds{
391da177e4SLinus Torvalds	my $arch = shift;
401da177e4SLinus Torvalds	if ($arch eq "") {
411da177e4SLinus Torvalds		$arch = `uname -m`;
42abddaec5SEric Sandeen		chomp($arch);
431da177e4SLinus Torvalds	}
441da177e4SLinus Torvalds
451da177e4SLinus Torvalds	$x	= "[0-9a-f]";	# hex character
461da177e4SLinus Torvalds	$xs	= "[0-9a-f ]";	# hex character or space
47690998b6SJames Hogan	$funcre = qr/^$x* <(.*)>:$/;
481da177e4SLinus Torvalds	if ($arch eq 'arm') {
491da177e4SLinus Torvalds		#c0008ffc:	e24dd064	sub	sp, sp, #100	; 0x64
501da177e4SLinus Torvalds		$re = qr/.*sub.*sp, sp, #(([0-9]{2}|[3-9])[0-9]{2})/o;
510367d892SHaavard Skinnemoen	} elsif ($arch eq 'avr32') {
520367d892SHaavard Skinnemoen		#8000008a:       20 1d           sub sp,4
530367d892SHaavard Skinnemoen		#80000ca8:       fa cd 05 b0     sub sp,sp,1456
540367d892SHaavard Skinnemoen		$re = qr/^.*sub.*sp.*,([0-9]{1,8})/o;
55*fda9f990SKonstantin Khlebnikov	} elsif ($arch =~ /^x86(_64)?$/ || $arch =~ /^i[3456]86$/) {
561da177e4SLinus Torvalds		#c0105234:       81 ec ac 05 00 00       sub    $0x5ac,%esp
57*fda9f990SKonstantin Khlebnikov		# or
581da177e4SLinus Torvalds		#    2f60:    48 81 ec e8 05 00 00       sub    $0x5e8,%rsp
59*fda9f990SKonstantin Khlebnikov		$re = qr/^.*[as][du][db]    \$(0x$x{1,8}),\%(e|r)sp$/o;
60*fda9f990SKonstantin Khlebnikov		$dre = qr/^.*[as][du][db]    (%.*),\%(e|r)sp$/o;
611da177e4SLinus Torvalds	} elsif ($arch eq 'ia64') {
621da177e4SLinus Torvalds		#e0000000044011fc:       01 0f fc 8c     adds r12=-384,r12
631da177e4SLinus Torvalds		$re = qr/.*adds.*r12=-(([0-9]{2}|[3-9])[0-9]{2}),r12/o;
641da177e4SLinus Torvalds	} elsif ($arch eq 'm68k') {
651da177e4SLinus Torvalds		#    2b6c:       4e56 fb70       linkw %fp,#-1168
661da177e4SLinus Torvalds		#  1df770:       defc ffe4       addaw #-28,%sp
671da177e4SLinus Torvalds		$re = qr/.*(?:linkw %fp,|addaw )#-([0-9]{1,4})(?:,%sp)?$/o;
68690998b6SJames Hogan	} elsif ($arch eq 'metag') {
69690998b6SJames Hogan		#400026fc:       40 00 00 82     ADD       A0StP,A0StP,#0x8
70690998b6SJames Hogan		$re = qr/.*ADD.*A0StP,A0StP,\#(0x$x{1,8})/o;
71690998b6SJames Hogan		$funcre = qr/^$x* <[^\$](.*)>:$/;
721da177e4SLinus Torvalds	} elsif ($arch eq 'mips64') {
731da177e4SLinus Torvalds		#8800402c:       67bdfff0        daddiu  sp,sp,-16
741da177e4SLinus Torvalds		$re = qr/.*daddiu.*sp,sp,-(([0-9]{2}|[3-9])[0-9]{2})/o;
751da177e4SLinus Torvalds	} elsif ($arch eq 'mips') {
761da177e4SLinus Torvalds		#88003254:       27bdffe0        addiu   sp,sp,-32
771da177e4SLinus Torvalds		$re = qr/.*addiu.*sp,sp,-(([0-9]{2}|[3-9])[0-9]{2})/o;
78562d139cSKyle McMartin	} elsif ($arch eq 'parisc' || $arch eq 'parisc64') {
79562d139cSKyle McMartin		$re = qr/.*ldo ($x{1,8})\(sp\),sp/o;
801da177e4SLinus Torvalds	} elsif ($arch eq 'ppc') {
811da177e4SLinus Torvalds		#c00029f4:       94 21 ff 30     stwu    r1,-208(r1)
821da177e4SLinus Torvalds		$re = qr/.*stwu.*r1,-($x{1,8})\(r1\)/o;
831da177e4SLinus Torvalds	} elsif ($arch eq 'ppc64') {
841da177e4SLinus Torvalds		#XXX
851da177e4SLinus Torvalds		$re = qr/.*stdu.*r1,-($x{1,8})\(r1\)/o;
86271c511dSJohannes Berg	} elsif ($arch eq 'powerpc') {
87271c511dSJohannes Berg		$re = qr/.*st[dw]u.*r1,-($x{1,8})\(r1\)/o;
881da177e4SLinus Torvalds	} elsif ($arch =~ /^s390x?$/) {
891da177e4SLinus Torvalds		#   11160:       a7 fb ff 60             aghi   %r15,-160
9089d49841SChristian Borntraeger		# or
9189d49841SChristian Borntraeger		#  100092:	 e3 f0 ff c8 ff 71	 lay	 %r15,-56(%r15)
9289d49841SChristian Borntraeger		$re = qr/.*(?:lay|ag?hi).*\%r15,-(([0-9]{2}|[3-9])[0-9]{2})
9389d49841SChristian Borntraeger		      (?:\(\%r15\))?$/ox;
941da177e4SLinus Torvalds	} elsif ($arch =~ /^sh64$/) {
951da177e4SLinus Torvalds		#XXX: we only check for the immediate case presently,
961da177e4SLinus Torvalds		#     though we will want to check for the movi/sub
971da177e4SLinus Torvalds		#     pair for larger users. -- PFM.
981da177e4SLinus Torvalds		#a00048e0:       d4fc40f0        addi.l  r15,-240,r15
991da177e4SLinus Torvalds		$re = qr/.*addi\.l.*r15,-(([0-9]{2}|[3-9])[0-9]{2}),r15/o;
1001e9535a5SMike Frysinger	} elsif ($arch =~ /^blackfin$/) {
1011e9535a5SMike Frysinger		#   0:   00 e8 38 01     LINK 0x4e0;
1021e9535a5SMike Frysinger		$re = qr/.*[[:space:]]LINK[[:space:]]*(0x$x{1,8})/o;
103d41e2d73SMartin Habets	} elsif ($arch eq 'sparc' || $arch eq 'sparc64') {
104d41e2d73SMartin Habets		# f0019d10:       9d e3 bf 90     save  %sp, -112, %sp
105d41e2d73SMartin Habets		$re = qr/.*save.*%sp, -(([0-9]{2}|[3-9])[0-9]{2}), %sp/o;
1061da177e4SLinus Torvalds	} else {
107abddaec5SEric Sandeen		print("wrong or unknown architecture \"$arch\"\n");
1081da177e4SLinus Torvalds		exit
1091da177e4SLinus Torvalds	}
1101da177e4SLinus Torvalds}
1111da177e4SLinus Torvalds
1121da177e4SLinus Torvalds#
1131da177e4SLinus Torvalds# main()
1141da177e4SLinus Torvalds#
1151f2a144fSStephen Hemmingermy ($func, $file, $lastslash);
1168ad2914dSRandy Dunlap
1171da177e4SLinus Torvaldswhile (my $line = <STDIN>) {
1181da177e4SLinus Torvalds	if ($line =~ m/$funcre/) {
1191da177e4SLinus Torvalds		$func = $1;
1201da177e4SLinus Torvalds	}
1218ad2914dSRandy Dunlap	elsif ($line =~ m/(.*):\s*file format/) {
1228ad2914dSRandy Dunlap		$file = $1;
1238ad2914dSRandy Dunlap		$file =~ s/\.ko//;
1248ad2914dSRandy Dunlap		$lastslash = rindex($file, "/");
1258ad2914dSRandy Dunlap		if ($lastslash != -1) {
1268ad2914dSRandy Dunlap			$file = substr($file, $lastslash + 1);
1278ad2914dSRandy Dunlap		}
1288ad2914dSRandy Dunlap	}
1298ad2914dSRandy Dunlap	elsif ($line =~ m/$re/) {
1301da177e4SLinus Torvalds		my $size = $1;
1311da177e4SLinus Torvalds		$size = hex($size) if ($size =~ /^0x/);
1321da177e4SLinus Torvalds
1331da177e4SLinus Torvalds		if ($size > 0xf0000000) {
1341da177e4SLinus Torvalds			$size = - $size;
1351da177e4SLinus Torvalds			$size += 0x80000000;
1361da177e4SLinus Torvalds			$size += 0x80000000;
1371da177e4SLinus Torvalds		}
1381da177e4SLinus Torvalds		next if ($size > 0x10000000);
1391da177e4SLinus Torvalds
1401da177e4SLinus Torvalds		next if $line !~ m/^($xs*)/;
1411da177e4SLinus Torvalds		my $addr = $1;
1421da177e4SLinus Torvalds		$addr =~ s/ /0/g;
1431da177e4SLinus Torvalds		$addr = "0x$addr";
1441da177e4SLinus Torvalds
1458ad2914dSRandy Dunlap		my $intro = "$addr $func [$file]:";
1461da177e4SLinus Torvalds		my $padlen = 56 - length($intro);
1471da177e4SLinus Torvalds		while ($padlen > 0) {
1481da177e4SLinus Torvalds			$intro .= '	';
1491da177e4SLinus Torvalds			$padlen -= 8;
1501da177e4SLinus Torvalds		}
1511da177e4SLinus Torvalds		next if ($size < 100);
1521da177e4SLinus Torvalds		push @stack, "$intro$size\n";
1531da177e4SLinus Torvalds	}
154585e93aeSEric Sandeen	elsif (defined $dre && $line =~ m/$dre/) {
155585e93aeSEric Sandeen		my $size = "Dynamic ($1)";
156585e93aeSEric Sandeen
157585e93aeSEric Sandeen		next if $line !~ m/^($xs*)/;
158585e93aeSEric Sandeen		my $addr = $1;
159585e93aeSEric Sandeen		$addr =~ s/ /0/g;
160585e93aeSEric Sandeen		$addr = "0x$addr";
161585e93aeSEric Sandeen
162585e93aeSEric Sandeen		my $intro = "$addr $func [$file]:";
163585e93aeSEric Sandeen		my $padlen = 56 - length($intro);
164585e93aeSEric Sandeen		while ($padlen > 0) {
165585e93aeSEric Sandeen			$intro .= '	';
166585e93aeSEric Sandeen			$padlen -= 8;
167585e93aeSEric Sandeen		}
168585e93aeSEric Sandeen		push @stack, "$intro$size\n";
169585e93aeSEric Sandeen	}
1701da177e4SLinus Torvalds}
1711da177e4SLinus Torvalds
1721f2a144fSStephen Hemminger# Sort output by size (last field)
1731f2a144fSStephen Hemmingerprint sort { ($b =~ /:\t*(\d+)$/)[0] <=> ($a =~ /:\t*(\d+)$/)[0] } @stack;
174