# Copyright (c) 2014-present PlatformIO # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. import os import re import subprocess import sys from platformio.compat import path_to_unicode, WINDOWS, PY2 from platformio.project.exception import PlatformioException from platformio.project.helpers import load_project_ide_data from platformio.commands.device import DeviceMonitorFilter # By design, __init__ is called inside miniterm and we can't pass context to it. # pylint: disable=attribute-defined-outside-init class Esp32BetterExceptionDecoder(DeviceMonitorFilter): NAME = "esp32_better_exception_decoder" def __call__(self): self.buffer = "" self.backtrace_re = re.compile( r"^Backtrace: ?((0x[0-9a-fA-F]+:0x[0-9a-fA-F]+ ?)+)\s*$" ) self.firmware_path = None self.addr2line_path = None self.enabled = self.setup_paths() if self.config.get("env:" + self.environment, "build_type") != "debug": print( """ Please build project in debug configuration to get more details about an exception. See https://docs.platformio.org/page/projectconf/build_configurations.html """ ) return self def setup_paths(self): self.project_dir = path_to_unicode(os.path.abspath(self.project_dir)) try: data = load_project_ide_data(self.project_dir, self.environment) self.firmware_path = data["prog_path"] if not os.path.isfile(self.firmware_path): sys.stderr.write( "%s: firmware at %s does not exist, rebuild the project?\n" % (self.__class__.__name__, self.firmware_path) ) return False cc_path = data.get("cc_path", "") if "-gcc" in cc_path: path = cc_path.replace("-gcc", "-addr2line") if os.path.isfile(path): self.addr2line_path = path return True except PlatformioException as e: sys.stderr.write( "%s: disabling, exception while looking for addr2line: %s\n" % (self.__class__.__name__, e) ) return False sys.stderr.write( "%s: disabling, failed to find addr2line.\n" % self.__class__.__name__ ) return False def rx(self, text): if not self.enabled: return text last = 0 while True: idx = text.find("\n", last) if idx == -1: if len(self.buffer) < 4096: self.buffer += text[last:] break line = text[last:idx] if self.buffer: line = self.buffer + line self.buffer = "" last = idx + 1 m = self.backtrace_re.match(line) if m is None: continue trace = self.get_backtrace(m) if len(trace) != "": text = text[: idx + 1] + trace + text[idx + 1 :] last += len(trace) return text def get_backtrace(self, match): addrs_parts = [part.strip() for part in match.group(1).split("0x") if part.strip() != ""] addrs_parts = ["0x" + part for part in addrs_parts] addrs_parts = [part + " " if not part.endswith(":") else part for part in addrs_parts] addrs = [addr.strip() for addr in "".join(addrs_parts).split(" ") if addr.strip() != ""] trace = "" enc = "mbcs" if WINDOWS else "utf-8" args = [self.addr2line_path, u"-fipC", u"-e", self.firmware_path] if PY2: args = [a.encode(enc) for a in args] try: for i, addr in enumerate(addrs): if PY2: addr = addr.encode(enc) output = ( subprocess.check_output(args + [addr]) .decode(enc) .strip() ) output = output.replace( "\n", "\n " ) # newlines happen with inlined methods output = self.strip_project_dir(output) trace += " #%-2d in %s\n" % (i, output) except subprocess.CalledProcessError as e: sys.stderr.write( "%s: failed to call %s: %s\n" % (self.__class__.__name__, self.addr2line_path, e) ) return trace def strip_project_dir(self, trace): while True: idx = trace.find(self.project_dir) if idx == -1: break trace = trace[:idx] + trace[idx + len(self.project_dir) + 1 :] return trace