blob: 22997bfb644d44373a7315904447e999bea3e95b [file] [log] [blame]
Krzysztof Kosińskib1361112021-03-11 18:05:01 -08001#!/usr/bin/env python3
Ben Chengb42dad02013-04-25 15:14:04 -07002#
3# Copyright (C) 2013 The Android Open Source Project
4#
5# Licensed under the Apache License, Version 2.0 (the "License");
6# you may not use this file except in compliance with the License.
7# You may obtain a copy of the License at
8#
9# http://www.apache.org/licenses/LICENSE-2.0
10#
11# Unless required by applicable law or agreed to in writing, software
12# distributed under the License is distributed on an "AS IS" BASIS,
13# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14# See the License for the specific language governing permissions and
15# limitations under the License.
16
17"""stack symbolizes native crash dumps."""
18
Christopher Ferrisece64c42015-08-20 20:09:09 -070019import os
Ben Chengb42dad02013-04-25 15:14:04 -070020import re
Christopher Ferrisece64c42015-08-20 20:09:09 -070021import subprocess
Ben Chengb42dad02013-04-25 15:14:04 -070022import symbol
Christopher Ferrisece64c42015-08-20 20:09:09 -070023import tempfile
Elliott Hughesa9e34172014-07-01 14:56:22 -070024import unittest
Ben Chengb42dad02013-04-25 15:14:04 -070025
Elliott Hughesc3166be2014-07-07 15:06:28 -070026import example_crashes
27
Ben Chengb42dad02013-04-25 15:14:04 -070028def ConvertTrace(lines):
Brigid Smithea0a8352014-06-30 16:01:40 -070029 tracer = TraceConverter()
Krzysztof Kosińskib1361112021-03-11 18:05:01 -080030 print("Reading symbols from", symbol.SYMBOLS_DIR)
Brigid Smithea0a8352014-06-30 16:01:40 -070031 tracer.ConvertTrace(lines)
32
33class TraceConverter:
Krzysztof Kosińskib1361112021-03-11 18:05:01 -080034 process_info_line = re.compile(r"(pid: [0-9]+, tid: [0-9]+.*)")
35 revision_line = re.compile(r"(Revision: '(.*)')")
36 signal_line = re.compile(r"(signal [0-9]+ \(.*\).*)")
37 abort_message_line = re.compile(r"(Abort message: '.*')")
38 thread_line = re.compile(r"(.*)(--- ){15}---")
Ben Chengb42dad02013-04-25 15:14:04 -070039 dalvik_jni_thread_line = re.compile("(\".*\" prio=[0-9]+ tid=[0-9]+ NATIVE.*)")
40 dalvik_native_thread_line = re.compile("(\".*\" sysTid=[0-9]+ nice=[0-9]+.*)")
Brigid Smithea0a8352014-06-30 16:01:40 -070041 register_line = re.compile("$a")
42 trace_line = re.compile("$a")
Andreas Gamped900d082015-08-21 15:25:03 -070043 sanitizer_trace_line = re.compile("$a")
Brigid Smithea0a8352014-06-30 16:01:40 -070044 value_line = re.compile("$a")
45 code_line = re.compile("$a")
Krzysztof Kosińskib1361112021-03-11 18:05:01 -080046 zipinfo_central_directory_line = re.compile(r"Central\s+directory\s+entry")
Christopher Ferrisabe22f42016-03-16 12:17:59 -070047 zipinfo_central_info_match = re.compile(
Krzysztof Kosińskib1361112021-03-11 18:05:01 -080048 r"^\s*(\S+)$\s*offset of local header from start of archive:\s*(\d+)"
49 r".*^\s*compressed size:\s+(\d+)", re.M | re.S)
50 unreachable_line = re.compile(r"((\d+ bytes in \d+ unreachable allocations)|"
51 r"(\d+ bytes unreachable at [0-9a-f]+)|"
52 r"(referencing \d+ unreachable bytes in \d+ allocation(s)?)|"
53 r"(and \d+ similar unreachable bytes in \d+ allocation(s)?))")
Ben Chengb42dad02013-04-25 15:14:04 -070054 trace_lines = []
55 value_lines = []
56 last_frame = -1
Brigid Smithea0a8352014-06-30 16:01:40 -070057 width = "{8}"
Elliott Hughesc3c86192014-08-29 13:49:57 -070058 spacing = ""
Christopher Ferrisece64c42015-08-20 20:09:09 -070059 apk_info = dict()
Ben Chengb42dad02013-04-25 15:14:04 -070060
Elliott Hughesa9e34172014-07-01 14:56:22 -070061 register_names = {
62 "arm": "r0|r1|r2|r3|r4|r5|r6|r7|r8|r9|sl|fp|ip|sp|lr|pc|cpsr",
Elliott Hughesbe4de462014-07-14 17:15:41 -070063 "arm64": "x0|x1|x2|x3|x4|x5|x6|x7|x8|x9|x10|x11|x12|x13|x14|x15|x16|x17|x18|x19|x20|x21|x22|x23|x24|x25|x26|x27|x28|x29|x30|sp|pc|pstate",
Elliott Hughesa9e34172014-07-01 14:56:22 -070064 "mips": "zr|at|v0|v1|a0|a1|a2|a3|t0|t1|t2|t3|t4|t5|t6|t7|s0|s1|s2|s3|s4|s5|s6|s7|t8|t9|k0|k1|gp|sp|s8|ra|hi|lo|bva|epc",
Andreas Gampe55218412015-05-21 14:44:21 -070065 "mips64": "zr|at|v0|v1|a0|a1|a2|a3|a4|a5|a6|a7|t0|t1|t2|t3|s0|s1|s2|s3|s4|s5|s6|s7|t8|t9|k0|k1|gp|sp|s8|ra|hi|lo|bva|epc",
Elliott Hughesa9e34172014-07-01 14:56:22 -070066 "x86": "eax|ebx|ecx|edx|esi|edi|x?cs|x?ds|x?es|x?fs|x?ss|eip|ebp|esp|flags",
67 "x86_64": "rax|rbx|rcx|rdx|rsi|rdi|r8|r9|r10|r11|r12|r13|r14|r15|cs|ss|rip|rbp|rsp|eflags",
68 }
69
70 def UpdateAbiRegexes(self):
Brigid Smithea0a8352014-06-30 16:01:40 -070071 if symbol.ARCH == "arm64" or symbol.ARCH == "mips64" or symbol.ARCH == "x86_64":
72 self.width = "{16}"
Elliott Hughesc3c86192014-08-29 13:49:57 -070073 self.spacing = " "
Brigid Smith15142f72014-07-15 13:47:07 -070074 else:
75 self.width = "{8}"
Elliott Hughesc3c86192014-08-29 13:49:57 -070076 self.spacing = ""
Brigid Smithea0a8352014-06-30 16:01:40 -070077
Elliott Hughesbe4de462014-07-14 17:15:41 -070078 self.register_line = re.compile("(([ ]*\\b(" + self.register_names[symbol.ARCH] + ")\\b +[0-9a-f]" + self.width + "){2,5})")
Brigid Smithea0a8352014-06-30 16:01:40 -070079
80 # Note that both trace and value line matching allow for variable amounts of
81 # whitespace (e.g. \t). This is because the we want to allow for the stack
82 # tool to operate on AndroidFeedback provided system logs. AndroidFeedback
83 # strips out double spaces that are found in tombsone files and logcat output.
84 #
85 # Examples of matched trace lines include lines from tombstone files like:
86 # #00 pc 001cf42e /data/data/com.my.project/lib/libmyproject.so
87 #
88 # Or lines from AndroidFeedback crash report system logs like:
89 # 03-25 00:51:05.520 I/DEBUG ( 65): #00 pc 001cf42e /data/data/com.my.project/lib/libmyproject.so
90 # Please note the spacing differences.
Andreas Gamped900d082015-08-21 15:25:03 -070091 self.trace_line = re.compile(
Krzysztof Kosińskib1361112021-03-11 18:05:01 -080092 r".*" # Random start stuff.
93 r"\#(?P<frame>[0-9]+)" # Frame number.
94 r"[ \t]+..[ \t]+" # (space)pc(space).
95 r"(?P<offset>[0-9a-f]" + self.width + ")[ \t]+" # Offset (hex number given without
96 # 0x prefix).
97 r"(?P<dso>\[[^\]]+\]|[^\r\n \t]*)" # Library name.
98 r"( \(offset (?P<so_offset>0x[0-9a-fA-F]+)\))?" # Offset into the file to find the start of the shared so.
99 r"(?P<symbolpresent> \((?P<symbol>.*)\))?") # Is the symbol there?
100 # pylint: disable-msg=C6310
Andreas Gamped900d082015-08-21 15:25:03 -0700101 # Sanitizer output. This is different from debuggerd output, and it is easier to handle this as
102 # its own regex. Example:
103 # 08-19 05:29:26.283 397 403 I : #0 0xb6a15237 (/system/lib/libclang_rt.asan-arm-android.so+0x4f237)
104 self.sanitizer_trace_line = re.compile(
Krzysztof Kosińskib1361112021-03-11 18:05:01 -0800105 r".*" # Random start stuff.
106 r"\#(?P<frame>[0-9]+)" # Frame number.
107 r"[ \t]+0x[0-9a-f]+[ \t]+" # PC, not interesting to us.
108 r"\(" # Opening paren.
109 r"(?P<dso>[^+]+)" # Library name.
110 r"\+" # '+'
111 r"0x(?P<offset>[0-9a-f]+)" # Offset (hex number given with
112 # 0x prefix).
113 r"\)") # Closing paren.
114 # pylint: disable-msg=C6310
Brigid Smithea0a8352014-06-30 16:01:40 -0700115 # Examples of matched value lines include:
116 # bea4170c 8018e4e9 /data/data/com.my.project/lib/libmyproject.so
117 # bea4170c 8018e4e9 /data/data/com.my.project/lib/libmyproject.so (symbol)
118 # 03-25 00:51:05.530 I/DEBUG ( 65): bea4170c 8018e4e9 /data/data/com.my.project/lib/libmyproject.so
119 # Again, note the spacing differences.
Krzysztof Kosińskib1361112021-03-11 18:05:01 -0800120 self.value_line = re.compile(r"(.*)([0-9a-f]" + self.width + r")[ \t]+([0-9a-f]" + self.width + r")[ \t]+([^\r\n \t]*)( \((.*)\))?")
Brigid Smithea0a8352014-06-30 16:01:40 -0700121 # Lines from 'code around' sections of the output will be matched before
122 # value lines because otheriwse the 'code around' sections will be confused as
123 # value lines.
124 #
125 # Examples include:
126 # 801cf40c ffffc4cc 00b2f2c5 00b2f1c7 00c1e1a8
127 # 03-25 00:51:05.530 I/DEBUG ( 65): 801cf40c ffffc4cc 00b2f2c5 00b2f1c7 00c1e1a8
Krzysztof Kosińskib1361112021-03-11 18:05:01 -0800128 self.code_line = re.compile(r"(.*)[ \t]*[a-f0-9]" + self.width +
129 r"[ \t]*[a-f0-9]" + self.width +
130 r"[ \t]*[a-f0-9]" + self.width +
131 r"[ \t]*[a-f0-9]" + self.width +
132 r"[ \t]*[a-f0-9]" + self.width +
133 r"[ \t]*[ \r\n]") # pylint: disable-msg=C6310
Brigid Smithea0a8352014-06-30 16:01:40 -0700134
135 def CleanLine(self, ln):
136 # AndroidFeedback adds zero width spaces into its crash reports. These
137 # should be removed or the regular expresssions will fail to match.
Krzysztof Kosińskib1361112021-03-11 18:05:01 -0800138 return ln.encode().decode(encoding='utf8', errors='ignore')
Brigid Smithea0a8352014-06-30 16:01:40 -0700139
140 def PrintTraceLines(self, trace_lines):
141 """Print back trace."""
Krzysztof Kosińskib1361112021-03-11 18:05:01 -0800142 maxlen = max(len(tl[1]) for tl in trace_lines)
143 print("\nStack Trace:")
144 print(" RELADDR " + self.spacing + "FUNCTION".ljust(maxlen) + " FILE:LINE")
Brigid Smithea0a8352014-06-30 16:01:40 -0700145 for tl in self.trace_lines:
146 (addr, symbol_with_offset, location) = tl
Krzysztof Kosińskib1361112021-03-11 18:05:01 -0800147 print(" %8s %s %s" % (addr, symbol_with_offset.ljust(maxlen), location))
Brigid Smithea0a8352014-06-30 16:01:40 -0700148
149 def PrintValueLines(self, value_lines):
150 """Print stack data values."""
Krzysztof Kosińskib1361112021-03-11 18:05:01 -0800151 maxlen = max(len(tl[2]) for tl in self.value_lines)
152 print("\nStack Data:")
153 print(" ADDR " + self.spacing + "VALUE " + "FUNCTION".ljust(maxlen) + " FILE:LINE")
Brigid Smithea0a8352014-06-30 16:01:40 -0700154 for vl in self.value_lines:
155 (addr, value, symbol_with_offset, location) = vl
Krzysztof Kosińskib1361112021-03-11 18:05:01 -0800156 print(" %8s %8s %s %s" % (addr, value, symbol_with_offset.ljust(maxlen), location))
Brigid Smithea0a8352014-06-30 16:01:40 -0700157
158 def PrintOutput(self, trace_lines, value_lines):
159 if self.trace_lines:
160 self.PrintTraceLines(self.trace_lines)
161 if self.value_lines:
162 self.PrintValueLines(self.value_lines)
163
164 def PrintDivider(self):
Krzysztof Kosińskib1361112021-03-11 18:05:01 -0800165 print("\n-----------------------------------------------------\n")
Brigid Smithea0a8352014-06-30 16:01:40 -0700166
Christopher Ferrisece64c42015-08-20 20:09:09 -0700167 def DeleteApkTmpFiles(self):
Christopher Ferrisabe22f42016-03-16 12:17:59 -0700168 for _, _, tmp_files in self.apk_info.values():
169 for tmp_file in tmp_files.values():
170 os.unlink(tmp_file)
Christopher Ferrisece64c42015-08-20 20:09:09 -0700171
Brigid Smithea0a8352014-06-30 16:01:40 -0700172 def ConvertTrace(self, lines):
Krzysztof Kosińskib1361112021-03-11 18:05:01 -0800173 lines = [self.CleanLine(line) for line in lines]
Christopher Ferrisece64c42015-08-20 20:09:09 -0700174 try:
Christopher Ferrisbf8a9402016-03-11 15:50:46 -0800175 if not symbol.ARCH:
176 symbol.SetAbi(lines)
177 self.UpdateAbiRegexes()
Christopher Ferrisece64c42015-08-20 20:09:09 -0700178 for line in lines:
179 self.ProcessLine(line)
180 self.PrintOutput(self.trace_lines, self.value_lines)
181 finally:
182 # Delete any temporary files created while processing the lines.
183 self.DeleteApkTmpFiles()
Brigid Smithea0a8352014-06-30 16:01:40 -0700184
Andreas Gamped900d082015-08-21 15:25:03 -0700185 def MatchTraceLine(self, line):
186 if self.trace_line.match(line):
187 match = self.trace_line.match(line)
188 return {"frame": match.group("frame"),
189 "offset": match.group("offset"),
Christopher Ferrisece64c42015-08-20 20:09:09 -0700190 "so_offset": match.group("so_offset"),
Andreas Gamped900d082015-08-21 15:25:03 -0700191 "dso": match.group("dso"),
192 "symbol_present": bool(match.group("symbolpresent")),
193 "symbol_name": match.group("symbol")}
194 if self.sanitizer_trace_line.match(line):
195 match = self.sanitizer_trace_line.match(line)
196 return {"frame": match.group("frame"),
197 "offset": match.group("offset"),
Andreas Gampe57acd5f2015-09-17 11:44:21 -0700198 "so_offset": None,
Andreas Gamped900d082015-08-21 15:25:03 -0700199 "dso": match.group("dso"),
200 "symbol_present": False,
201 "symbol_name": None}
202 return None
203
Christopher Ferrisece64c42015-08-20 20:09:09 -0700204 def ExtractLibFromApk(self, apk, shared_lib_name):
205 # Create a temporary file containing the shared library from the apk.
206 tmp_file = None
207 try:
208 tmp_fd, tmp_file = tempfile.mkstemp()
209 if subprocess.call(["unzip", "-p", apk, shared_lib_name], stdout=tmp_fd) == 0:
210 os.close(tmp_fd)
211 shared_file = tmp_file
212 tmp_file = None
213 return shared_file
214 finally:
215 if tmp_file:
216 os.close(tmp_fd)
217 os.unlink(tmp_file)
218 return None
219
Christopher Ferrisabe22f42016-03-16 12:17:59 -0700220 def ProcessCentralInfo(self, offset_list, central_info):
221 match = self.zipinfo_central_info_match.search(central_info)
222 if not match:
223 raise Exception("Cannot find all info from zipinfo\n" + central_info)
224 name = match.group(1)
225 start = int(match.group(2))
226 end = start + int(match.group(3))
227
228 offset_list.append([name, start, end])
229 return name, start, end
230
Christopher Ferrisece64c42015-08-20 20:09:09 -0700231 def GetLibFromApk(self, apk, offset):
232 # Convert the string to hex.
233 offset = int(offset, 16)
234
235 # Check if we already have information about this offset.
236 if apk in self.apk_info:
Christopher Ferrisabe22f42016-03-16 12:17:59 -0700237 apk_full_path, offset_list, tmp_files = self.apk_info[apk]
238 for file_name, start, end in offset_list:
239 if offset >= start and offset < end:
240 if file_name in tmp_files:
241 return file_name, tmp_files[file_name]
Christopher Ferrisece64c42015-08-20 20:09:09 -0700242 tmp_file = self.ExtractLibFromApk(apk_full_path, file_name)
243 if tmp_file:
Christopher Ferrisabe22f42016-03-16 12:17:59 -0700244 tmp_files[file_name] = tmp_file
Christopher Ferrisece64c42015-08-20 20:09:09 -0700245 return file_name, tmp_file
246 break
247 return None, None
248
249 if not "ANDROID_PRODUCT_OUT" in os.environ:
Krzysztof Kosińskib1361112021-03-11 18:05:01 -0800250 print("ANDROID_PRODUCT_OUT environment variable not set.")
Christopher Ferrisece64c42015-08-20 20:09:09 -0700251 return None, None
252 out_dir = os.environ["ANDROID_PRODUCT_OUT"]
253 if not os.path.exists(out_dir):
Krzysztof Kosińskib1361112021-03-11 18:05:01 -0800254 print("ANDROID_PRODUCT_OUT", out_dir, "does not exist.")
Christopher Ferrisece64c42015-08-20 20:09:09 -0700255 return None, None
256 if apk.startswith("/"):
257 apk_full_path = out_dir + apk
258 else:
259 apk_full_path = os.path.join(out_dir, apk)
260 if not os.path.exists(apk_full_path):
Krzysztof Kosińskib1361112021-03-11 18:05:01 -0800261 print("Cannot find apk", apk)
Christopher Ferrisece64c42015-08-20 20:09:09 -0700262 return None, None
263
Christopher Ferris7ea56f02021-10-21 00:20:18 +0000264 cmd = subprocess.Popen(["zipinfo", "-v", apk_full_path], stdout=subprocess.PIPE,
265 encoding='utf8')
Christopher Ferrisabe22f42016-03-16 12:17:59 -0700266 # Find the first central info marker.
267 for line in cmd.stdout:
268 if self.zipinfo_central_directory_line.search(line):
269 break
270
271 central_info = ""
272 file_name = None
Christopher Ferrisece64c42015-08-20 20:09:09 -0700273 offset_list = []
274 for line in cmd.stdout:
Christopher Ferrisabe22f42016-03-16 12:17:59 -0700275 match = self.zipinfo_central_directory_line.search(line)
Christopher Ferrisece64c42015-08-20 20:09:09 -0700276 if match:
Christopher Ferrisabe22f42016-03-16 12:17:59 -0700277 cur_name, start, end = self.ProcessCentralInfo(offset_list, central_info)
278 if not file_name and offset >= start and offset < end:
279 file_name = cur_name
280 central_info = ""
281 else:
282 central_info += line
283 if central_info:
284 cur_name, start, end = self.ProcessCentralInfo(offset_list, central_info)
285 if not file_name and offset >= start and offset < end:
286 file_name = cur_name
Christopher Ferrisece64c42015-08-20 20:09:09 -0700287
Christopher Ferris7ea56f02021-10-21 00:20:18 +0000288 # Make sure the offset_list is sorted, the zip file does not guarantee
289 # that the entries are in order.
290 offset_list = sorted(offset_list, key=lambda entry: entry[1])
291
Christopher Ferrisece64c42015-08-20 20:09:09 -0700292 # Save the information from the zip.
Christopher Ferrisabe22f42016-03-16 12:17:59 -0700293 tmp_files = dict()
294 self.apk_info[apk] = [apk_full_path, offset_list, tmp_files]
295 if not file_name:
Christopher Ferrisece64c42015-08-20 20:09:09 -0700296 return None, None
Christopher Ferrisabe22f42016-03-16 12:17:59 -0700297 tmp_shared_lib = self.ExtractLibFromApk(apk_full_path, file_name)
Christopher Ferrisece64c42015-08-20 20:09:09 -0700298 if tmp_shared_lib:
Christopher Ferrisabe22f42016-03-16 12:17:59 -0700299 tmp_files[file_name] = tmp_shared_lib
300 return file_name, tmp_shared_lib
Christopher Ferrisece64c42015-08-20 20:09:09 -0700301 return None, None
302
Christopher Ferris1f2051d2021-09-10 14:41:00 -0700303 def GetLibPath(self, lib):
304 symbol_dir = symbol.SYMBOLS_DIR
305 if os.path.isfile(symbol_dir + lib):
306 return lib
307
308 # When using atest, test paths are different between the out/ directory
309 # and device. Apply fixups.
310 if not lib.startswith("/data/local/tests/") and not lib.startswith("/data/local/tmp/"):
311 print("WARNING: Cannot find %s in symbol directory" % lib)
312 return lib
313
314 test_name = lib.rsplit("/", 1)[-1]
315 test_dir = "/data/nativetest"
316 test_dir_bitness = ""
317 if symbol.ARCH.endswith("64"):
318 bitness = "64"
319 test_dir_bitness = "64"
320 else:
321 bitness = "32"
322
323 # Unfortunately, the location of the real symbol file is not
324 # standardized, so we need to go hunting for it.
325
326 # This is in vendor, look for the value in:
327 # /data/nativetest{64}/vendor/test_name/test_name
328 if lib.startswith("/data/local/tests/vendor/"):
329 lib_path = os.path.join(test_dir + test_dir_bitness, "vendor", test_name, test_name)
330 if os.path.isfile(symbol_dir + lib_path):
331 return lib_path
332
333 # Look for the path in:
334 # /data/nativetest{64}/test_name/test_name
335 lib_path = os.path.join(test_dir + test_dir_bitness, test_name, test_name)
336 if os.path.isfile(symbol_dir + lib_path):
337 return lib_path
338
339 # CtsXXX tests are in really non-standard locations try:
340 # /data/nativetest/{test_name}
341 lib_path = os.path.join(test_dir, test_name)
342 if os.path.isfile(symbol_dir + lib_path):
343 return lib_path
344 # Try:
345 # /data/nativetest/{test_name}{32|64}
346 lib_path += bitness
347 if os.path.isfile(symbol_dir + lib_path):
348 return lib_path
349
350 # Cannot find location, give up and return the original path
351 print("WARNING: Cannot find %s in symbol directory" % lib)
352 return lib
353
354
Brigid Smithea0a8352014-06-30 16:01:40 -0700355 def ProcessLine(self, line):
Brigid Smith9c2192a2014-07-07 10:33:21 -0700356 ret = False
Brigid Smithea0a8352014-06-30 16:01:40 -0700357 process_header = self.process_info_line.search(line)
358 signal_header = self.signal_line.search(line)
359 abort_message_header = self.abort_message_line.search(line)
360 thread_header = self.thread_line.search(line)
361 register_header = self.register_line.search(line)
Brigid Smith0b309402014-07-07 14:34:00 -0700362 revision_header = self.revision_line.search(line)
Brigid Smithea0a8352014-06-30 16:01:40 -0700363 dalvik_jni_thread_header = self.dalvik_jni_thread_line.search(line)
364 dalvik_native_thread_header = self.dalvik_native_thread_line.search(line)
Colin Cross807ec0e2016-03-04 17:29:01 -0800365 unreachable_header = self.unreachable_line.search(line)
Christopher Ferrisbf8a9402016-03-11 15:50:46 -0800366 if process_header or signal_header or abort_message_header or thread_header or \
Colin Cross807ec0e2016-03-04 17:29:01 -0800367 register_header or dalvik_jni_thread_header or dalvik_native_thread_header or \
368 revision_header or unreachable_header:
369 ret = True
Brigid Smithea0a8352014-06-30 16:01:40 -0700370 if self.trace_lines or self.value_lines:
371 self.PrintOutput(self.trace_lines, self.value_lines)
372 self.PrintDivider()
373 self.trace_lines = []
374 self.value_lines = []
375 self.last_frame = -1
Ben Chengb42dad02013-04-25 15:14:04 -0700376 if process_header:
Krzysztof Kosińskib1361112021-03-11 18:05:01 -0800377 print(process_header.group(1))
Ben Chengb42dad02013-04-25 15:14:04 -0700378 if signal_header:
Krzysztof Kosińskib1361112021-03-11 18:05:01 -0800379 print(signal_header.group(1))
Elliott Hughesd2471c82014-06-17 16:55:10 -0700380 if abort_message_header:
Krzysztof Kosińskib1361112021-03-11 18:05:01 -0800381 print(abort_message_header.group(1))
Ben Chengb42dad02013-04-25 15:14:04 -0700382 if register_header:
Krzysztof Kosińskib1361112021-03-11 18:05:01 -0800383 print(register_header.group(1))
Ben Chengb42dad02013-04-25 15:14:04 -0700384 if thread_header:
Krzysztof Kosińskib1361112021-03-11 18:05:01 -0800385 print(thread_header.group(1))
Ben Chengb42dad02013-04-25 15:14:04 -0700386 if dalvik_jni_thread_header:
Krzysztof Kosińskib1361112021-03-11 18:05:01 -0800387 print(dalvik_jni_thread_header.group(1))
Ben Chengb42dad02013-04-25 15:14:04 -0700388 if dalvik_native_thread_header:
Krzysztof Kosińskib1361112021-03-11 18:05:01 -0800389 print(dalvik_native_thread_header.group(1))
Brigid Smith0b309402014-07-07 14:34:00 -0700390 if revision_header:
Krzysztof Kosińskib1361112021-03-11 18:05:01 -0800391 print(revision_header.group(1))
Colin Cross807ec0e2016-03-04 17:29:01 -0800392 if unreachable_header:
Krzysztof Kosińskib1361112021-03-11 18:05:01 -0800393 print(unreachable_header.group(1))
Christopher Ferrisbf8a9402016-03-11 15:50:46 -0800394 return True
Andreas Gamped900d082015-08-21 15:25:03 -0700395 trace_line_dict = self.MatchTraceLine(line)
396 if trace_line_dict is not None:
Brigid Smith9c2192a2014-07-07 10:33:21 -0700397 ret = True
Andreas Gampe48068ac2016-07-25 21:07:27 -0700398 frame = int(trace_line_dict["frame"])
Andreas Gamped900d082015-08-21 15:25:03 -0700399 code_addr = trace_line_dict["offset"]
400 area = trace_line_dict["dso"]
Christopher Ferrisece64c42015-08-20 20:09:09 -0700401 so_offset = trace_line_dict["so_offset"]
Andreas Gamped900d082015-08-21 15:25:03 -0700402 symbol_present = trace_line_dict["symbol_present"]
403 symbol_name = trace_line_dict["symbol_name"]
Ben Chengb42dad02013-04-25 15:14:04 -0700404
Brigid Smithea0a8352014-06-30 16:01:40 -0700405 if frame <= self.last_frame and (self.trace_lines or self.value_lines):
406 self.PrintOutput(self.trace_lines, self.value_lines)
407 self.PrintDivider()
408 self.trace_lines = []
409 self.value_lines = []
410 self.last_frame = frame
Ben Chengb42dad02013-04-25 15:14:04 -0700411
Brigid Smithea0a8352014-06-30 16:01:40 -0700412 if area == "<unknown>" or area == "[heap]" or area == "[stack]":
413 self.trace_lines.append((code_addr, "", area))
Ben Chengb42dad02013-04-25 15:14:04 -0700414 else:
Christopher Ferrisece64c42015-08-20 20:09:09 -0700415 # If this is an apk, it usually means that there is actually
416 # a shared so that was loaded directly out of it. In that case,
417 # extract the shared library and the name of the shared library.
418 lib = None
Christopher Ferris55a96992019-03-13 15:37:31 -0700419 # The format of the map name:
420 # Some.apk!libshared.so
421 # or
422 # Some.apk
423 if so_offset:
424 # If it ends in apk, we are done.
425 apk = None
426 if area.endswith(".apk"):
427 apk = area
428 else:
Christopher Ferris5e4b3722020-01-31 14:38:07 -0800429 index = area.rfind(".so!")
Christopher Ferris55a96992019-03-13 15:37:31 -0700430 if index != -1:
Christopher Ferris5e4b3722020-01-31 14:38:07 -0800431 # Sometimes we'll see something like:
432 # #01 pc abcd libart.so!libart.so (offset 0x134000)
433 # Remove everything after the ! and zero the offset value.
434 area = area[0:index + 3]
435 so_offset = 0
436 else:
437 index = area.rfind(".apk!")
438 if index != -1:
439 apk = area[0:index + 4]
Christopher Ferrisac90d1d2019-03-15 12:21:57 -0700440 if apk:
Christopher Ferris55a96992019-03-13 15:37:31 -0700441 lib_name, lib = self.GetLibFromApk(apk, so_offset)
Christopher Ferrisece64c42015-08-20 20:09:09 -0700442 if not lib:
443 lib = area
444 lib_name = None
445
Krzysztof Kosińskidd45e182021-02-24 15:21:50 -0800446 # When using atest, test paths are different between the out/ directory
447 # and device. Apply fixups.
Christopher Ferris1f2051d2021-09-10 14:41:00 -0700448 lib = self.GetLibPath(lib)
Krzysztof Kosińskidd45e182021-02-24 15:21:50 -0800449
Ben Chengb42dad02013-04-25 15:14:04 -0700450 # If a calls b which further calls c and c is inlined to b, we want to
451 # display "a -> b -> c" in the stack trace instead of just "a -> c"
Christopher Ferrisece64c42015-08-20 20:09:09 -0700452 info = symbol.SymbolInformation(lib, code_addr)
Ben Chengb42dad02013-04-25 15:14:04 -0700453 nest_count = len(info) - 1
454 for (source_symbol, source_location, object_symbol_with_offset) in info:
455 if not source_symbol:
456 if symbol_present:
457 source_symbol = symbol.CallCppFilt(symbol_name)
458 else:
Brigid Smithea0a8352014-06-30 16:01:40 -0700459 source_symbol = "<unknown>"
Ben Chengb42dad02013-04-25 15:14:04 -0700460 if not source_location:
461 source_location = area
Christopher Ferrisece64c42015-08-20 20:09:09 -0700462 if lib_name:
463 source_location += "(" + lib_name + ")"
Ben Chengb42dad02013-04-25 15:14:04 -0700464 if nest_count > 0:
465 nest_count = nest_count - 1
Brigid Smithea0a8352014-06-30 16:01:40 -0700466 arrow = "v------>"
467 if symbol.ARCH == "arm64" or symbol.ARCH == "mips64" or symbol.ARCH == "x86_64":
468 arrow = "v-------------->"
469 self.trace_lines.append((arrow, source_symbol, source_location))
Ben Chengb42dad02013-04-25 15:14:04 -0700470 else:
471 if not object_symbol_with_offset:
472 object_symbol_with_offset = source_symbol
Brigid Smithea0a8352014-06-30 16:01:40 -0700473 self.trace_lines.append((code_addr,
Ben Chengb42dad02013-04-25 15:14:04 -0700474 object_symbol_with_offset,
475 source_location))
Brigid Smithea0a8352014-06-30 16:01:40 -0700476 if self.code_line.match(line):
Ben Chengb42dad02013-04-25 15:14:04 -0700477 # Code lines should be ignored. If this were exluded the 'code around'
478 # sections would trigger value_line matches.
Brigid Smith9c2192a2014-07-07 10:33:21 -0700479 return ret
Brigid Smithea0a8352014-06-30 16:01:40 -0700480 if self.value_line.match(line):
Brigid Smith9c2192a2014-07-07 10:33:21 -0700481 ret = True
Brigid Smithea0a8352014-06-30 16:01:40 -0700482 match = self.value_line.match(line)
Ben Chengb42dad02013-04-25 15:14:04 -0700483 (unused_, addr, value, area, symbol_present, symbol_name) = match.groups()
Brigid Smithea0a8352014-06-30 16:01:40 -0700484 if area == "<unknown>" or area == "[heap]" or area == "[stack]" or not area:
485 self.value_lines.append((addr, value, "", area))
Ben Chengb42dad02013-04-25 15:14:04 -0700486 else:
487 info = symbol.SymbolInformation(area, value)
488 (source_symbol, source_location, object_symbol_with_offset) = info.pop()
Christopher Ferris5f1b4f02016-09-19 13:24:37 -0700489 # If there is no information, skip this.
490 if source_symbol or source_location or object_symbol_with_offset:
491 if not source_symbol:
492 if symbol_present:
493 source_symbol = symbol.CallCppFilt(symbol_name)
494 else:
495 source_symbol = "<unknown>"
496 if not source_location:
497 source_location = area
498 if not object_symbol_with_offset:
499 object_symbol_with_offset = source_symbol
500 self.value_lines.append((addr,
501 value,
502 object_symbol_with_offset,
503 source_location))
Ben Chengb42dad02013-04-25 15:14:04 -0700504
Brigid Smith9c2192a2014-07-07 10:33:21 -0700505 return ret
Elliott Hughesa9e34172014-07-01 14:56:22 -0700506
507
Elliott Hughesa9e34172014-07-01 14:56:22 -0700508class RegisterPatternTests(unittest.TestCase):
509 def assert_register_matches(self, abi, example_crash, stupid_pattern):
510 tc = TraceConverter()
Christopher Ferrisbf8a9402016-03-11 15:50:46 -0800511 lines = example_crash.split('\n')
512 symbol.SetAbi(lines)
513 tc.UpdateAbiRegexes()
514 for line in lines:
Elliott Hughesc3c86192014-08-29 13:49:57 -0700515 tc.ProcessLine(line)
Elliott Hughesa9e34172014-07-01 14:56:22 -0700516 is_register = (re.search(stupid_pattern, line) is not None)
517 matched = (tc.register_line.search(line) is not None)
Krzysztof Kosińskib1361112021-03-11 18:05:01 -0800518 self.assertEqual(matched, is_register, line)
Elliott Hughesc3c86192014-08-29 13:49:57 -0700519 tc.PrintOutput(tc.trace_lines, tc.value_lines)
Elliott Hughesa9e34172014-07-01 14:56:22 -0700520
521 def test_arm_registers(self):
Elliott Hughesc3166be2014-07-07 15:06:28 -0700522 self.assert_register_matches("arm", example_crashes.arm, '\\b(r0|r4|r8|ip)\\b')
Elliott Hughesa9e34172014-07-01 14:56:22 -0700523
524 def test_arm64_registers(self):
Elliott Hughesc3166be2014-07-07 15:06:28 -0700525 self.assert_register_matches("arm64", example_crashes.arm64, '\\b(x0|x4|x8|x12|x16|x20|x24|x28|sp)\\b')
Elliott Hughesa9e34172014-07-01 14:56:22 -0700526
527 def test_mips_registers(self):
Elliott Hughesc3166be2014-07-07 15:06:28 -0700528 self.assert_register_matches("mips", example_crashes.mips, '\\b(zr|a0|t0|t4|s0|s4|t8|gp|hi)\\b')
Elliott Hughesa9e34172014-07-01 14:56:22 -0700529
Andreas Gampe820ca722015-06-01 15:43:52 -0700530 def test_mips64_registers(self):
531 self.assert_register_matches("mips64", example_crashes.mips64, '\\b(zr|a0|a4|t0|s0|s4|t8|gp|hi)\\b')
532
Elliott Hughesa9e34172014-07-01 14:56:22 -0700533 def test_x86_registers(self):
Elliott Hughesc3166be2014-07-07 15:06:28 -0700534 self.assert_register_matches("x86", example_crashes.x86, '\\b(eax|esi|xcs|eip)\\b')
Elliott Hughesa9e34172014-07-01 14:56:22 -0700535
536 def test_x86_64_registers(self):
Elliott Hughesc3166be2014-07-07 15:06:28 -0700537 self.assert_register_matches("x86_64", example_crashes.x86_64, '\\b(rax|rsi|r8|r12|cs|rip)\\b')
Elliott Hughesa9e34172014-07-01 14:56:22 -0700538
Colin Cross807ec0e2016-03-04 17:29:01 -0800539class LibmemunreachablePatternTests(unittest.TestCase):
540 def test_libmemunreachable(self):
541 tc = TraceConverter()
542 lines = example_crashes.libmemunreachable.split('\n')
543
544 symbol.SetAbi(lines)
Krzysztof Kosińskib1361112021-03-11 18:05:01 -0800545 self.assertEqual(symbol.ARCH, "arm")
Colin Cross807ec0e2016-03-04 17:29:01 -0800546
547 tc.UpdateAbiRegexes()
548 header_lines = 0
Colin Cross1127df92016-07-26 10:15:01 -0700549 trace_lines = 0
Colin Cross807ec0e2016-03-04 17:29:01 -0800550 for line in lines:
551 tc.ProcessLine(line)
552 if re.search(tc.unreachable_line, line) is not None:
553 header_lines += 1
Colin Cross1127df92016-07-26 10:15:01 -0700554 if tc.MatchTraceLine(line) is not None:
555 trace_lines += 1
Krzysztof Kosińskib1361112021-03-11 18:05:01 -0800556 self.assertEqual(header_lines, 3)
557 self.assertEqual(trace_lines, 2)
Colin Cross807ec0e2016-03-04 17:29:01 -0800558 tc.PrintOutput(tc.trace_lines, tc.value_lines)
Elliott Hughesa9e34172014-07-01 14:56:22 -0700559
Andreas Gampe48068ac2016-07-25 21:07:27 -0700560class LongASANStackTests(unittest.TestCase):
561 # Test that a long ASAN-style (non-padded frame numbers) stack trace is not split into two
562 # when the frame number becomes two digits. This happened before as the frame number was
563 # handled as a string and not converted to an integral.
564 def test_long_asan_crash(self):
565 tc = TraceConverter()
566 lines = example_crashes.long_asan_crash.splitlines()
567 symbol.SetAbi(lines)
568 tc.UpdateAbiRegexes()
569 # Test by making sure trace_line_count is monotonically non-decreasing. If the stack trace
570 # is split, a separator is printed and trace_lines is flushed.
571 trace_line_count = 0
572 for line in lines:
573 tc.ProcessLine(line)
574 self.assertLessEqual(trace_line_count, len(tc.trace_lines))
575 trace_line_count = len(tc.trace_lines)
576 # The split happened at transition of frame #9 -> #10. Make sure we have parsed (and stored)
577 # more than ten frames.
578 self.assertGreater(trace_line_count, 10)
579 tc.PrintOutput(tc.trace_lines, tc.value_lines)
580
Christopher Ferris5f1b4f02016-09-19 13:24:37 -0700581class ValueLinesTest(unittest.TestCase):
582 def test_value_line_skipped(self):
583 tc = TraceConverter()
584 symbol.SetAbi(["ABI: 'arm'"])
585 tc.UpdateAbiRegexes()
586 tc.ProcessLine(" 12345678 00001000 .")
587 self.assertEqual([], tc.value_lines)
588
Elliott Hughesa9e34172014-07-01 14:56:22 -0700589if __name__ == '__main__':
Krzysztof Kosińskib1361112021-03-11 18:05:01 -0800590 unittest.main(verbosity=2)