blob: d48dfed6d3dba7ffee3e67668ab9bc3944876c67 [file] [log] [blame]
Kamil Rytarowskicb77f0d2017-05-07 23:25:26 +02001#!/usr/bin/env perl
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01002# SPDX-License-Identifier: GPL-2.0
Linus Torvalds1da177e2005-04-16 15:20:36 -07003
4# Check the stack usage of functions
5#
Joern Engel2b54aae2008-02-06 01:38:02 -08006# Copyright Joern Engel <joern@lazybastard.org>
Linus Torvalds1da177e2005-04-16 15:20:36 -07007# Inspired by Linus Torvalds
8# Original idea maybe from Keith Owens
9# s390 port and big speedup by Arnd Bergmann <arnd@bergmann-dalldorf.de>
10# Mips port by Juan Quintela <quintela@mandrakesoft.com>
11# IA64 port via Andreas Dilger
12# Arm port by Holger Schurig
13# sh64 port by Paul Mundt
14# Random bits by Matt Mackall <mpm@selenic.com>
15# M68k port by Geert Uytterhoeven and Andreas Schwab
Kyle McMartin208ad002014-06-20 11:41:37 -040016# AArch64, PARISC ports by Kyle McMartin
Martin Habetsd41e2d72008-10-21 21:58:29 -070017# sparc port by Martin Habets <errandir_news@mph.eclipse.co.uk>
Breno Leitao8449a4c2017-11-28 17:29:34 -020018# ppc64le port by Breno Leitao <leitao@debian.org>
Wadim Mueller1fd49a02022-07-13 21:41:10 +020019# riscv port by Wadim Mueller <wafgo01@gmail.com>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#
21# Usage:
Joern Engel477116e2007-10-18 23:39:18 -070022# objdump -d vmlinux | scripts/checkstack.pl [arch]
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#
24# TODO : Port to all architectures (one regex per arch)
25
Stephen Hemminger1f2a1442010-02-22 15:17:09 -080026use strict;
27
Linus Torvalds1da177e2005-04-16 15:20:36 -070028# check for arch
29#
30# $re is used for two matches:
31# $& (whole re) matches the complete objdump line with the stack growth
32# $1 (first bracket) matches the size of the stack growth
33#
Eric Sandeen585e93a2008-07-25 01:45:27 -070034# $dre is similar, but for dynamic stack redutions:
35# $& (whole re) matches the complete objdump line with the stack growth
36# $1 (first bracket) matches the dynamic amount of the stack growth
37#
Maninder Singh3311eee2020-05-08 16:33:16 +053038# $sub: subroutine for special handling to check stack usage.
39#
Linus Torvalds1da177e2005-04-16 15:20:36 -070040# use anything else and feel the pain ;)
Maninder Singh3311eee2020-05-08 16:33:16 +053041my (@stack, $re, $dre, $sub, $x, $xs, $funcre, $min_stack);
Linus Torvalds1da177e2005-04-16 15:20:36 -070042{
43 my $arch = shift;
44 if ($arch eq "") {
45 $arch = `uname -m`;
Eric Sandeenabddaec2008-07-25 01:45:28 -070046 chomp($arch);
Linus Torvalds1da177e2005-04-16 15:20:36 -070047 }
48
Maninder Singh572220a2020-05-08 16:33:15 +053049 $min_stack = shift;
50 if ($min_stack eq "" || $min_stack !~ /^\d+$/) {
51 $min_stack = 100;
52 }
53
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 $x = "[0-9a-f]"; # hex character
55 $xs = "[0-9a-f ]"; # hex character or space
James Hogan690998b2012-10-17 15:21:13 +010056 $funcre = qr/^$x* <(.*)>:$/;
George G. Davis4f45d622019-06-03 10:30:39 -040057 if ($arch =~ '^(aarch|arm)64$') {
Qian Caif1733a12018-12-14 14:17:20 -080058 #ffffffc0006325cc: a9bb7bfd stp x29, x30, [sp, #-80]!
Qian Cai919e9d32018-12-28 00:31:28 -080059 #a110: d11643ff sub sp, sp, #0x590
Qian Caif1733a12018-12-14 14:17:20 -080060 $re = qr/^.*stp.*sp, \#-([0-9]{1,8})\]\!/o;
Qian Cai919e9d32018-12-28 00:31:28 -080061 $dre = qr/^.*sub.*sp, sp, #(0x$x{1,8})/o;
Kyle McMartin208ad002014-06-20 11:41:37 -040062 } elsif ($arch eq 'arm') {
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 #c0008ffc: e24dd064 sub sp, sp, #100 ; 0x64
Maninder Singh6ce16f22020-05-08 16:33:17 +053064 $re = qr/.*sub.*sp, sp, #([0-9]{1,4})/o;
Maninder Singh3311eee2020-05-08 16:33:16 +053065 $sub = \&arm_push_handling;
Konstantin Khlebnikovfda9f992014-08-08 14:23:35 -070066 } elsif ($arch =~ /^x86(_64)?$/ || $arch =~ /^i[3456]86$/) {
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 #c0105234: 81 ec ac 05 00 00 sub $0x5ac,%esp
Konstantin Khlebnikovfda9f992014-08-08 14:23:35 -070068 # or
69 # 2f60: 48 81 ec e8 05 00 00 sub $0x5e8,%rsp
70 $re = qr/^.*[as][du][db] \$(0x$x{1,8}),\%(e|r)sp$/o;
71 $dre = qr/^.*[as][du][db] (%.*),\%(e|r)sp$/o;
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 } elsif ($arch eq 'ia64') {
73 #e0000000044011fc: 01 0f fc 8c adds r12=-384,r12
74 $re = qr/.*adds.*r12=-(([0-9]{2}|[3-9])[0-9]{2}),r12/o;
75 } elsif ($arch eq 'm68k') {
76 # 2b6c: 4e56 fb70 linkw %fp,#-1168
77 # 1df770: defc ffe4 addaw #-28,%sp
78 $re = qr/.*(?:linkw %fp,|addaw )#-([0-9]{1,4})(?:,%sp)?$/o;
79 } elsif ($arch eq 'mips64') {
80 #8800402c: 67bdfff0 daddiu sp,sp,-16
81 $re = qr/.*daddiu.*sp,sp,-(([0-9]{2}|[3-9])[0-9]{2})/o;
82 } elsif ($arch eq 'mips') {
83 #88003254: 27bdffe0 addiu sp,sp,-32
84 $re = qr/.*addiu.*sp,sp,-(([0-9]{2}|[3-9])[0-9]{2})/o;
Tobias Klauser0e5a47a2017-02-22 15:40:23 -080085 } elsif ($arch eq 'nios2') {
86 #25a8: defffb04 addi sp,sp,-20
87 $re = qr/.*addi.*sp,sp,-(([0-9]{2}|[3-9])[0-9]{2})/o;
Stafford Hornef72deab2017-01-03 16:15:03 +090088 } elsif ($arch eq 'openrisc') {
89 # c000043c: 9c 21 fe f0 l.addi r1,r1,-272
90 $re = qr/.*l\.addi.*r1,r1,-(([0-9]{2}|[3-9])[0-9]{2})/o;
Kyle McMartin562d1392007-10-20 13:18:56 -070091 } elsif ($arch eq 'parisc' || $arch eq 'parisc64') {
92 $re = qr/.*ldo ($x{1,8})\(sp\),sp/o;
Breno Leitao8449a4c2017-11-28 17:29:34 -020093 } elsif ($arch eq 'powerpc' || $arch =~ /^ppc(64)?(le)?$/ ) {
94 # powerpc : 94 21 ff 30 stwu r1,-208(r1)
95 # ppc64(le) : 81 ff 21 f8 stdu r1,-128(r1)
Johannes Berg271c5112006-08-22 16:57:05 +020096 $re = qr/.*st[dw]u.*r1,-($x{1,8})\(r1\)/o;
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 } elsif ($arch =~ /^s390x?$/) {
98 # 11160: a7 fb ff 60 aghi %r15,-160
Christian Borntraeger89d49842008-10-10 21:33:30 +020099 # or
100 # 100092: e3 f0 ff c8 ff 71 lay %r15,-56(%r15)
101 $re = qr/.*(?:lay|ag?hi).*\%r15,-(([0-9]{2}|[3-9])[0-9]{2})
102 (?:\(\%r15\))?$/ox;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 } elsif ($arch =~ /^sh64$/) {
104 #XXX: we only check for the immediate case presently,
105 # though we will want to check for the movi/sub
106 # pair for larger users. -- PFM.
107 #a00048e0: d4fc40f0 addi.l r15,-240,r15
108 $re = qr/.*addi\.l.*r15,-(([0-9]{2}|[3-9])[0-9]{2}),r15/o;
Martin Habetsd41e2d72008-10-21 21:58:29 -0700109 } elsif ($arch eq 'sparc' || $arch eq 'sparc64') {
110 # f0019d10: 9d e3 bf 90 save %sp, -112, %sp
111 $re = qr/.*save.*%sp, -(([0-9]{2}|[3-9])[0-9]{2}), %sp/o;
Wadim Mueller1fd49a02022-07-13 21:41:10 +0200112 } elsif ($arch =~ /^riscv(64)?$/) {
113 #ffffffff8036e868: c2010113 addi sp,sp,-992
114 $re = qr/.*addi.*sp,sp,-(([0-9]{2}|[3-9])[0-9]{2})/o;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 } else {
Eric Sandeenabddaec2008-07-25 01:45:28 -0700116 print("wrong or unknown architecture \"$arch\"\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 exit
118 }
119}
120
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121#
Maninder Singh3311eee2020-05-08 16:33:16 +0530122# To count stack usage of push {*, fp, ip, lr, pc} instruction in ARM,
123# if FRAME POINTER is enabled.
124# e.g. c01f0d48: e92ddff0 push {r4, r5, r6, r7, r8, r9, sl, fp, ip, lr, pc}
125#
126sub arm_push_handling {
127 my $regex = qr/.*push.*fp, ip, lr, pc}/o;
128 my $size = 0;
129 my $line_arg = shift;
130
131 if ($line_arg =~ m/$regex/) {
132 $size = $line_arg =~ tr/,//;
133 $size = ($size + 1) * 4;
134 }
135
136 return $size;
137}
138
139#
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140# main()
141#
Maninder Singh677f1412020-05-08 16:33:14 +0530142my ($func, $file, $lastslash, $total_size, $addr, $intro);
143
144$total_size = 0;
Randy Dunlap8ad29142006-06-25 05:48:29 -0700145
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146while (my $line = <STDIN>) {
147 if ($line =~ m/$funcre/) {
148 $func = $1;
Maninder Singh677f1412020-05-08 16:33:14 +0530149 next if $line !~ m/^($xs*)/;
Maninder Singh572220a2020-05-08 16:33:15 +0530150 if ($total_size > $min_stack) {
Maninder Singh677f1412020-05-08 16:33:14 +0530151 push @stack, "$intro$total_size\n";
152 }
153
154 $addr = $1;
155 $addr =~ s/ /0/g;
156 $addr = "0x$addr";
157
158 $intro = "$addr $func [$file]:";
159 my $padlen = 56 - length($intro);
160 while ($padlen > 0) {
161 $intro .= ' ';
162 $padlen -= 8;
163 }
164
165 $total_size = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 }
Randy Dunlap8ad29142006-06-25 05:48:29 -0700167 elsif ($line =~ m/(.*):\s*file format/) {
168 $file = $1;
169 $file =~ s/\.ko//;
170 $lastslash = rindex($file, "/");
171 if ($lastslash != -1) {
172 $file = substr($file, $lastslash + 1);
173 }
174 }
175 elsif ($line =~ m/$re/) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 my $size = $1;
177 $size = hex($size) if ($size =~ /^0x/);
178
179 if ($size > 0xf0000000) {
180 $size = - $size;
181 $size += 0x80000000;
182 $size += 0x80000000;
183 }
184 next if ($size > 0x10000000);
185
Maninder Singh677f1412020-05-08 16:33:14 +0530186 $total_size += $size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 }
Eric Sandeen585e93a2008-07-25 01:45:27 -0700188 elsif (defined $dre && $line =~ m/$dre/) {
Maninder Singh677f1412020-05-08 16:33:14 +0530189 my $size = $1;
Eric Sandeen585e93a2008-07-25 01:45:27 -0700190
Maninder Singh677f1412020-05-08 16:33:14 +0530191 $size = hex($size) if ($size =~ /^0x/);
192 $total_size += $size;
Eric Sandeen585e93a2008-07-25 01:45:27 -0700193 }
Maninder Singh3311eee2020-05-08 16:33:16 +0530194 elsif (defined $sub) {
195 my $size = &$sub($line);
196
197 $total_size += $size;
198 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199}
Maninder Singh572220a2020-05-08 16:33:15 +0530200if ($total_size > $min_stack) {
Maninder Singh677f1412020-05-08 16:33:14 +0530201 push @stack, "$intro$total_size\n";
202}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203
Stephen Hemminger1f2a1442010-02-22 15:17:09 -0800204# Sort output by size (last field)
205print sort { ($b =~ /:\t*(\d+)$/)[0] <=> ($a =~ /:\t*(\d+)$/)[0] } @stack;