[lldb] Parse and display reporting errors from JSON crashlogs

[JDevlieghere]

Summary

JSON crashlogs have an optional field named reportNotes that contains any potential errors encountered by the crash reporter when generating the crashlog. Parse and display them in LLDB.

[aprantl]

sgtm

lldb/examples/python/crashlog.py

def __init__(self, debugger, path, verbose):
         """CrashLog constructor that take a path to a darwin crash log file"""
         symbolication.Symbolicator.__init__(self, debugger)
         self.path = os.path.expanduser(path)
         self.info_lines = list()
         self.system_profile = list()
         self.threads = list()
         self.backtraces = list()  # For application specific backtraces
         self.idents = list()  # A list of the required identifiers for doing all stack backtraces
+        self.errors = list()
         self.crashed_thread_idx = -1
         self.version = -1
         self.target = None
         self.verbose = verbose
 
     def dump(self):
         print("Crash Log File: %s" % (self.path))
         if self.backtraces:
def parse(self):
             self.data = json.loads(buffer)
         except ValueError:
             raise CrashLogFormatException()
 
         try:
             self.parse_process_info(self.data)
             self.parse_images(self.data['usedImages'])
             self.parse_threads(self.data['threads'])
+            self.parse_errors(self.data)
             thread = self.crashlog.threads[self.crashlog.crashed_thread_idx]
             reason = self.parse_crash_reason(self.data['exception'])
             if thread.reason:
                 thread.reason = '{} {}'.format(thread.reason, reason)
             else:
                 thread.reason = reason
         except (KeyError, ValueError, TypeError) as e:
             raise CrashLogParseException(
def parse_thread_registers(self, json_thread_state):
         for key, state in json_thread_state.items():
             try:
                value = int(state['value'])
                registers[key] = value
             except (TypeError, ValueError):
                pass
         return registers
 
+    def parse_errors(self, json_data):
+       if 'reportNotes' in json_data:
+          self.crashlog.errors = json_data['reportNotes']
+
 
 class CrashLogParseMode:
     NORMAL = 0
     THREAD = 1
     IMAGES = 2
     THREGS = 3
     SYSTEM = 4
     INSTRS = 5
if crash_log.backtraces:
         for thread in crash_log.backtraces:
             thread.dump_symbolicated(crash_log, options)
             print()
 
     for thread in crash_log.threads:
         thread.dump_symbolicated(crash_log, options)
         print()
 
+    if crash_log.errors:
+        print("Errors:")
+        for error in crash_log.errors:
+            print(error)
+
 
 def CreateSymbolicateCrashLogOptions(
         command_name,
         description,
         add_interactive_options):
     usage = "usage: %prog [options] <FILE> [FILE ...]"
     option_parser = optparse.OptionParser(
         description=description, prog='crashlog', usage=usage)

lldb/test/Shell/ScriptInterpreter/Python/Crashlog/Inputs/a.out.ips

"usedImages" : [
     "path" : "\/usr\/lib\/system\/libdyld.dylib",
     "name" : "libdyld.dylib"
   }
 ],
   "legacyInfo" : {
   "threadTriggered" : {
     "queue" : "com.apple.main-thread"
   }
-}
+},
+  "reportNotes" : [
+  "invalid foo",
+  "invalid bar"
+]
 }

lldb/test/Shell/ScriptInterpreter/Python/Crashlog/json.test

 # RUN: %clang_host -g %S/Inputs/test.c -o %t.out
 
 # RUN: cp %S/Inputs/a.out.ips %t.crash
 # RUN: python %S/patch-crashlog.py --binary %t.out --crashlog %t.crash --offsets '{"main":20, "bar":9, "foo":16}' --json
 # RUN: %lldb %t.out -o 'command script import lldb.macosx.crashlog' -o 'crashlog %t.crash' 2>&1 | FileCheck %s
 
 # RUN: cp %S/Inputs/a.out.ips %t.nometadata.crash
 # RUN: python %S/patch-crashlog.py --binary %t.out --crashlog %t.nometadata.crash --offsets '{"main":20, "bar":9, "foo":16}' --json --no-metadata
 # RUN: %lldb %t.out -o 'command script import lldb.macosx.crashlog' -o 'crashlog %t.nometadata.crash' 2>&1 | FileCheck %s
 
 # CHECK: Thread[0] Crashing Thread Name EXC_BAD_ACCESS (SIGSEGV) (KERN_INVALID_ADDRESS at 0x0000000000000000)
 # CHECK: [  0] {{.*}}out`foo + 16 at test.c
 # CHECK: [  1] {{.*}}out`bar + 8 at test.c
 # CHECK: [  2] {{.*}}out`main + 19 at test.c
 # CHECK: rbp = 0x00007ffeec22a530
+# CHECK: invalid foo
+# CHECK: invalid bar