package plcrash

Get desktop application:
View/edit binary Protocol Buffers messages

Legacy processor architecture type codes. These codes have been deprecated.

Used in: CrashReport.SystemInfo

• X86_32 = 0

  x86

• X86_64 = 1

  x86-64

• ARMV6 = 2

  ARMv6

• PPC = 3

  PPC

• PPC64 = 4

  * PPC64

• ARMV7 = 5

  ARMv7

• ARCHITECTURE_UNKNOWN = 6

  Unknown processor type.

A crash report

• required CrashReport.SystemInfo system_info = 1

  Host system data

• required CrashReport.ApplicationInfo application_info = 2

• repeated CrashReport.Thread threads = 3

  All backtraces

• repeated CrashReport.BinaryImage binary_images = 4

  All loaded binary images

• optional CrashReport.Exception exception = 5

  The exception that triggered the crash (if any)

• required CrashReport.Signal signal = 6

  The signal that triggered the crash

• optional CrashReport.ProcessInfo process_info = 7

  The process info. Required for all v1.1+ crash reports.

• optional CrashReport.MachineInfo machine_info = 8

  Host architecture information. Required for all v1.1+ crash reports. If unavailable, the information should be derived from the deprecated SystemInfo.architecture field.

• optional CrashReport.ReportInfo report_info = 9

  Report format information. Required for all v1.1+ crash reports.

• optional bytes custom_data = 10

  Custom data. Can be used by user to store contextual information for the crash.

Application info

Used in: CrashReport

• required string identifier = 1

  Unique application identifier

• required string version = 2

  Application version string

• optional string marketing_version = 3

  Application marketing version string

Binary image

Used in: CrashReport

• required uint64 base_address = 1

  Image base address

• required uint64 size = 2

  Segment size

• required string name = 3

  Name of the binary image (should be a full path name)

• optional bytes uuid = 4

  128-bit object UUID (matches Mach-O DWARF dSYM files)

• optional Processor code_type = 5

  The image's code type. Should be included in all v1.1+ crash reports. The code type may differ between binaries in the case of architectures with forwards-compatible code types, such as ARM, where armv6 and armv7 images may be mixed.

Exception

Used in: CrashReport

• required string name = 1

  The exception name that triggered this crash

• required string reason = 2

  The exception reason

• repeated Thread.StackFrame frames = 3

  The exception's original call stack, if available. This may be preserved across rethrow of an exception, and can be used to determine the original call stack.

Host architecture information.

Used in: CrashReport

• optional string model = 1

  Hardware model (eg, MacBookPro6,1)

• required Processor processor = 2

  The host processor.

• required uint32 processor_count = 3

  The number of actual physical processor cores. Note that the number of active processors may be managed by the operating system's power management system, and this value may not reflect the number of active processors at the time of the crash.

• required uint32 logical_processor_count = 4

  The number of logical processors. Note that the number of active processors may be managed by the operating system's power management system, and this value may not reflect the number of active processors at the time of the crash.

Process Data. This was not available in earlier releases of the crash reporter and is marked optional for compatibility.

Used in: CrashReport

• optional string process_name = 1

  Application process name

• required uint32 process_id = 2

  Application process ID

• optional string process_path = 3

  Application process path

• optional string parent_process_name = 4

  Application parent process name

• required uint32 parent_process_id = 5

  Application parent process ID

• required bool native = 6

  * If false, the process is being run via process-level CPU emulation (such as Rosetta).

• optional uint64 start_time = 7

  * The start time of the process (as seconds since UNIX epoch). The field may be ommitted if the start time can not be determined.

Processor information

Used in: BinaryImage, MachineInfo

• optional Processor.TypeEncoding encoding = 1

  * The CPU type encoding that should be used to interpret cpu_type and cpu_subtype. This value is required.

• required uint64 type = 2

  * The CPU type.

• required uint64 subtype = 3

  * The CPU subtype.

CPU Type Encodings The wire format maintains support for multiple CPU type encodings; it is expected that different operating systems may target different processors, and the reported CPU type and subtype information may not be easily or directly expressed when not using the vendor's own defined types. Currently, only Apple Mach CPU type/subtype information is supported by the wire protocol. These types are stable, intended to be encoded in Mach-O files, and are defined in mach/machine.h on Mac OS X. Implementations must gracefully handle the addition of unknown type encodings.

Used in: Processor

• TYPE_ENCODING_UNKNOWN = 0

  Unknown processor type encoding.

• TYPE_ENCODING_MACH = 1

  Apple Mach-defined processor types.

Report format information

Used in: CrashReport

• required bool user_requested = 1

  * If true, this report was generated on request, and no crash occured.

• optional bytes uuid = 2

  * A client-generated 16 byte OSF standard UUID for this report. May be used to filter duplicate reports submitted by a single client.

Signal Information

Used in: CrashReport

• required string name = 1

  * Signal name

• required string code = 2

  Signal code

• required uint64 address = 3

  Faulting instruction or address

• optional Signal.MachException mach_exception = 4

  The Mach Exception that triggered the crash. This field will only be included in the case that encoding crash reporter's exception-based reporting was enabled, and a Mach exception was caught. If the mach_exception field is defined, the legacy signal info will also be provided; this is required to maintain backwards compatibility with existing report handlers. Note, however, that the signal info may be derived from the Mach exception info by the encoding crash reporter, and thus may not exactly match the kernel exception-to-signal mappings implemented in xnu. As such, when Mach exception data is available, its use should be preferred.

Mach exception info.

Used in: Signal

• required uint64 type = 1

  The exception type. These values will generally be common across most Apple platforms.

• repeated uint64 codes = 2

  The exception codes. Interpretation of these values depends on the exception type, and/or the faulting platform.

A symbol table entry.

Used in: Thread.StackFrame

• required string name = 1

  The symbol name

• required uint64 start_address = 2

  The symbol start address

• optional uint64 end_address = 3

  The symbol end address, if explicitly defined. This will only be included if the end address is explicitly defined (eg, by DWARF debugging information), will not be derived by best-guess heuristics.

Used in: CrashReport

• optional SystemInfo.OperatingSystem operating_system = 1

  Operating system

• required string os_version = 2

  OS version

• required Architecture architecture = 3

  Processor architecture (deprecated in favor of machine_info)

• required int64 timestamp = 4

  Date crash report was generated (as seconds since epoch). 0 if the time is unknown or can not be determined.

• optional string os_build = 5

  OS build number (eg, 10J869)

Known operating system types

Used in: SystemInfo

• MAC_OS_X = 0

  Mac OS X

• IPHONE_OS = 1

  iPhone OS

• IPHONE_SIMULATOR = 2

  iPhone Simulator (Mac OS X w/ simulator runtime environment)

• APPLE_TVOS = 4

  Apple tvOS

• OS_UNKNOWN = 3

  Unknown operating system.

Thread state

Used in: CrashReport

• required uint32 thread_number = 1

  Thread number (indexed at 0, must be unique within a crash report)

• repeated Thread.StackFrame frames = 2

  Backtrace stack frames

• required bool crashed = 3

  True if this is the crashed thread

• repeated Thread.RegisterValue registers = 4

  Thread registers (required if this is the crashed thread, optional otherwise). Note that if an error occurs during crash report generation, the register values may be missing for the crashed thread.

A single register value

Used in: Thread

• required string name = 1

  Register name (r1, ebp, ...)

• required uint64 value = 2

  Register value (32-bit or 64-bit)

Stack frame

Used in: Exception, Thread

• required uint64 pc = 3

  Instruction pointer

• optional Symbol symbol = 6

  Optional symbol information for this frame's PC. If computed client-side, this value is a best guess, and may be inaccurate. Symbol information may not be available, in which case this field will be excluded from the report. This method of encoding symbol records is unfortunately ineffecient, as it is possible that the same symbol will be included multiple times in a single crash report. Unfortunately, insofar as the crash reporter must remain async-safe, there is no reasonable way to perform symbol uniquing at the time the report is written. A future version of this format may resolve this issue, and migrate to the use of an index into a shared symbol table.