/work/obj-fuzz/dist/include/CrashAnnotations.h

Source (jump to first uncovered line)
/* This file was autogenerated by toolkit/crashreporter/generate_crash_reporter_sources.py. DO NOT EDIT */

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef CrashAnnotations_h
#define CrashAnnotations_h

#include <cstdint>

namespace CrashReporter {

// Typed enum representing all crash annotations
enum class Annotation : uint32_t {
  A11yHandlerRegistered = 0,
  AbortMessage = 1,
  Accessibility = 2,
  AccessibilityClient = 3,
  AccessibilityInProcClient = 4,
  ActualStreamLen = 5,
  AdapterDeviceID = 6,
  AdapterDriverVersion = 7,
  AdapterSubsysID = 8,
  AdapterVendorID = 9,
  Addons = 10,
  AppInitDLLs = 11,
  AsyncShutdownModule = 12,
  AsyncShutdownTimeout = 13,
  AvailablePageFile = 14,
  AvailablePhysicalMemory = 15,
  AvailableVirtualMemory = 16,
  BIOS_Manufacturer = 17,
  BlockedDllList = 18,
  BlocklistInitFailed = 19,
  BreakpadReserveAddress = 20,
  BreakpadReserveSize = 21,
  BuildID = 22,
  CPUMicrocodeVersion = 23,
  ClassRegistrationInfoChild = 24,
  ClassRegistrationInfoParent = 25,
  CoMarshalInterfaceFailure = 26,
  CoUnmarshalInterfaceResult = 27,
  ContainsMemoryReport = 28,
  ContentSandboxCapabilities = 29,
  ContentSandboxCapable = 30,
  ContentSandboxEnabled = 31,
  ContentSandboxLevel = 32,
  CpuUsageFlashProcess1 = 33,
  CpuUsageFlashProcess2 = 34,
  CrashAddressLikelyWrong = 35,
  CrashTime = 36,
  CreateStreamOnHGlobalFailure = 37,
  CycleCollector = 38,
  DOMIPCEnabled = 39,
  DeviceResetReason = 40,
  EMCheckCompatibility = 41,
  EventLoopNestingLevel = 42,
  ExpectedStreamLen = 43,
  FlashProcessDump = 44,
  FramePoisonBase = 45,
  FramePoisonSize = 46,
  GMPLibraryPath = 47,
  GMPPlugin = 48,
  GPUProcessLaunchCount = 49,
  GPUProcessStatus = 50,
  GetHGlobalFromStreamFailure = 51,
  GraphicsCriticalError = 52,
  GraphicsSanityTest = 53,
  GraphicsStartupTest = 54,
  HangMonitorDescription = 55,
  HasDeviceTouchScreen = 56,
  IAccessibleConfig = 57,
  IPCFatalErrorMsg = 58,
  IPCFatalErrorProtocol = 59,
  IPCMessageName = 60,
  IPCMessageSize = 61,
  IPCReadErrorReason = 62,
  IPCShutdownState = 63,
  IPCSystemError = 64,
  IPCTransportFailureReason = 65,
  InstallTime = 66,
  InterfaceRegistrationInfoChild = 67,
  InterfaceRegistrationInfoParent = 68,
  IpcCreateEndpointsNsresult = 69,
  IpcCreatePipeCloExecErrno = 70,
  IpcCreatePipeFcntlErrno = 71,
  IpcCreatePipeSocketPairErrno = 72,
  IpcCreateTransportDupErrno = 73,
  IsGarbageCollecting = 74,
  JSLargeAllocationFailure = 75,
  JSOutOfMemory = 76,
  JavaStackTrace = 77,
  LowCommitSpaceEvents = 78,
  MarshalActCtxManifestPath = 79,
  MemoryErrorCorrection = 80,
  MozCrashReason = 81,
  Notes = 82,
  NumberOfProcessors = 83,
  OOMAllocationSize = 84,
  PluginCpuUsage = 85,
  PluginFilename = 86,
  PluginHang = 87,
  PluginHangUIDuration = 88,
  PluginName = 89,
  PluginVersion = 90,
  ProcessType = 91,
  ProductID = 92,
  ProductName = 93,
  ProxyStreamSize = 94,
  ProxyStreamSizeFrom = 95,
  ProxyStreamUnmarshalStatus = 96,
  ProxyStreamValid = 97,
  RecordReplay = 98,
  RecordReplayError = 99,
  RecordReplayHang = 100,
  ReleaseChannel = 101,
  RemoteType = 102,
  SafeMode = 103,
  SecondsSinceLastCrash = 104,
  ServerURL = 105,
  SheetLoadFailure = 106,
  ShutdownProgress = 107,
  StartupCrash = 108,
  StartupTime = 109,
  StatFailure = 110,
  StorageConnectionNotClosed = 111,
  SystemMemoryUsePercentage = 112,
  TelemetryClientId = 113,
  TelemetryEnvironment = 114,
  TelemetryServerURL = 115,
  TelemetrySessionId = 116,
  TestKey = 117,
  TestUnicode = 118,
  TextureUsage = 119,
  ThreadIdNameMapping = 120,
  TotalPageFile = 121,
  TotalPhysicalMemory = 122,
  TotalVirtualMemory = 123,
  URL = 124,
  UnknownNetAddrSocketFamily = 125,
  UnmarshalActCtx = 126,
  UnmarshalActCtxManifestPath = 127,
  UptimeTS = 128,
  User32BeforeBlocklist = 129,
  Vendor = 130,
  Version = 131,
  Winsock_LSP = 132,
  additional_minidumps = 133,
  ipc_channel_error = 134,
  nsAsyncShutdownComponent = 135,
  useragent_locale = 136,
  Count = 137
};

// Stringified crash annotation names
const char* const kAnnotationStrings[] = {
  "A11yHandlerRegistered",
  "AbortMessage",
  "Accessibility",
  "AccessibilityClient",
  "AccessibilityInProcClient",
  "ActualStreamLen",
  "AdapterDeviceID",
  "AdapterDriverVersion",
  "AdapterSubsysID",
  "AdapterVendorID",
  "Add-ons",
  "AppInitDLLs",
  "AsyncShutdownModule",
  "AsyncShutdownTimeout",
  "AvailablePageFile",
  "AvailablePhysicalMemory",
  "AvailableVirtualMemory",
  "BIOS_Manufacturer",
  "BlockedDllList",
  "BlocklistInitFailed",
  "BreakpadReserveAddress",
  "BreakpadReserveSize",
  "BuildID",
  "CPUMicrocodeVersion",
  "ClassRegistrationInfoChild",
  "ClassRegistrationInfoParent",
  "CoMarshalInterfaceFailure",
  "CoUnmarshalInterfaceResult",
  "ContainsMemoryReport",
  "ContentSandboxCapabilities",
  "ContentSandboxCapable",
  "ContentSandboxEnabled",
  "ContentSandboxLevel",
  "CpuUsageFlashProcess1",
  "CpuUsageFlashProcess2",
  "CrashAddressLikelyWrong",
  "CrashTime",
  "CreateStreamOnHGlobalFailure",
  "CycleCollector",
  "DOMIPCEnabled",
  "DeviceResetReason",
  "EMCheckCompatibility",
  "EventLoopNestingLevel",
  "ExpectedStreamLen",
  "FlashProcessDump",
  "FramePoisonBase",
  "FramePoisonSize",
  "GMPLibraryPath",
  "GMPPlugin",
  "GPUProcessLaunchCount",
  "GPUProcessStatus",
  "GetHGlobalFromStreamFailure",
  "GraphicsCriticalError",
  "GraphicsSanityTest",
  "GraphicsStartupTest",
  "HangMonitorDescription",
  "HasDeviceTouchScreen",
  "IAccessibleConfig",
  "IPCFatalErrorMsg",
  "IPCFatalErrorProtocol",
  "IPCMessageName",
  "IPCMessageSize",
  "IPCReadErrorReason",
  "IPCShutdownState",
  "IPCSystemError",
  "IPCTransportFailureReason",
  "InstallTime",
  "InterfaceRegistrationInfoChild",
  "InterfaceRegistrationInfoParent",
  "IpcCreateEndpointsNsresult",
  "IpcCreatePipeCloExecErrno",
  "IpcCreatePipeFcntlErrno",
  "IpcCreatePipeSocketPairErrno",
  "IpcCreateTransportDupErrno",
  "IsGarbageCollecting",
  "JSLargeAllocationFailure",
  "JSOutOfMemory",
  "JavaStackTrace",
  "LowCommitSpaceEvents",
  "MarshalActCtxManifestPath",
  "MemoryErrorCorrection",
  "MozCrashReason",
  "Notes",
  "NumberOfProcessors",
  "OOMAllocationSize",
  "PluginCpuUsage",
  "PluginFilename",
  "PluginHang",
  "PluginHangUIDuration",
  "PluginName",
  "PluginVersion",
  "ProcessType",
  "ProductID",
  "ProductName",
  "ProxyStreamSize",
  "ProxyStreamSizeFrom",
  "ProxyStreamUnmarshalStatus",
  "ProxyStreamValid",
  "RecordReplay",
  "RecordReplayError",
  "RecordReplayHang",
  "ReleaseChannel",
  "RemoteType",
  "SafeMode",
  "SecondsSinceLastCrash",
  "ServerURL",
  "SheetLoadFailure",
  "ShutdownProgress",
  "StartupCrash",
  "StartupTime",
  "StatFailure",
  "StorageConnectionNotClosed",
  "SystemMemoryUsePercentage",
  "TelemetryClientId",
  "TelemetryEnvironment",
  "TelemetryServerURL",
  "TelemetrySessionId",
  "TestKey",
  "TestUnicode",
  "TextureUsage",
  "ThreadIdNameMapping",
  "TotalPageFile",
  "TotalPhysicalMemory",
  "TotalVirtualMemory",
  "URL",
  "UnknownNetAddrSocketFamily",
  "UnmarshalActCtx",
  "UnmarshalActCtxManifestPath",
  "UptimeTS",
  "User32BeforeBlocklist",
  "Vendor",
  "Version",
  "Winsock_LSP",
  "additional_minidumps",
  "ipc_channel_error",
  "nsAsyncShutdownComponent",
  "useragent_locale"
};

// Whitelist of crash annotations that can be included in a crash ping
const Annotation kCrashPingWhitelist[] = {
  Annotation::AsyncShutdownTimeout,
  Annotation::AvailablePageFile,
  Annotation::AvailablePhysicalMemory,
  Annotation::AvailableVirtualMemory,
  Annotation::BlockedDllList,
  Annotation::BlocklistInitFailed,
  Annotation::BuildID,
  Annotation::ContainsMemoryReport,
  Annotation::CrashTime,
  Annotation::EventLoopNestingLevel,
  Annotation::IsGarbageCollecting,
  Annotation::LowCommitSpaceEvents,
  Annotation::MozCrashReason,
  Annotation::OOMAllocationSize,
  Annotation::ProductID,
  Annotation::ProductName,
  Annotation::ReleaseChannel,
  Annotation::RemoteType,
  Annotation::SecondsSinceLastCrash,
  Annotation::ShutdownProgress,
  Annotation::StartupCrash,
  Annotation::SystemMemoryUsePercentage,
  Annotation::TextureUsage,
  Annotation::TotalPageFile,
  Annotation::TotalPhysicalMemory,
  Annotation::TotalVirtualMemory,
  Annotation::UptimeTS,
  Annotation::User32BeforeBlocklist,
  Annotation::ipc_channel_error
};

// Blacklist of crash annotations that shouldn't be read from a content process
const Annotation kContentProcessBlacklist[] = {
  Annotation::FramePoisonBase,
  Annotation::FramePoisonSize,
  Annotation::StartupCrash,
  Annotation::StartupTime,
  Annotation::URL
};

/**
 * Return the string representation of a crash annotation.
 *
 * @param aAnnotation a crash annotation
 * @returns A constant string holding the annotation name
 */
static inline const char*
AnnotationToString(Annotation aAnnotation) {
  return kAnnotationStrings[static_cast<uint32_t>(aAnnotation)];
}

/**
 * Converts a string to its corresponding crash annotation.
 *
 * @param aResult a reference where the annotation will be stored
 * @param aValue the string to be converted
 * @return true if the string was successfully converted, false if it did not
 *         correspond to any known annotation
 */
bool AnnotationFromString(Annotation& aResult, const char* aValue);

/**
 * Checks if the given crash annotation is whitelisted for inclusion in the
 * crash ping.
 *
 * @param aAnnotation the crash annotation to be checked
 * @return true if the annotation can be included in the crash ping, false
 *         otherwise
 */
bool IsAnnotationWhitelistedForPing(Annotation aAnnotation);

/**
 * Checks if the given crash annotation needs to be filtered out when reading
 * a content process crash annotations. Blacklisted annotations will be
 * replaced with ones provided by the parent process.
 *
 * @param aAnnotation the crash annotation to be checked
 * @return true if the annotation needs to be filtered out when reading
 *         annotations provided by a content process, false otherwise
 */
bool IsAnnotationBlacklistedForContent(Annotation aAnnotation);

} // namespace CrashReporter

#endif // CrashAnnotations_h

Coverage Report

Created: 2018-09-25 14:53

Line	Count	Source (jump to first uncovered line)
1		/* This file was autogenerated by toolkit/crashreporter/generate_crash_reporter_sources.py. DO NOT EDIT */
2
3		/* This Source Code Form is subject to the terms of the Mozilla Public
4		* License, v. 2.0. If a copy of the MPL was not distributed with this
5		* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
6
7		#ifndef CrashAnnotations_h
8		#define CrashAnnotations_h
9
10		#include <cstdint>
11
12		namespace CrashReporter {
13
14		// Typed enum representing all crash annotations
15		enum class Annotation : uint32_t {
16		A11yHandlerRegistered = 0,
17		AbortMessage = 1,
18		Accessibility = 2,
19		AccessibilityClient = 3,
20		AccessibilityInProcClient = 4,
21		ActualStreamLen = 5,
22		AdapterDeviceID = 6,
23		AdapterDriverVersion = 7,
24		AdapterSubsysID = 8,
25		AdapterVendorID = 9,
26		Addons = 10,
27		AppInitDLLs = 11,
28		AsyncShutdownModule = 12,
29		AsyncShutdownTimeout = 13,
30		AvailablePageFile = 14,
31		AvailablePhysicalMemory = 15,
32		AvailableVirtualMemory = 16,
33		BIOS_Manufacturer = 17,
34		BlockedDllList = 18,
35		BlocklistInitFailed = 19,
36		BreakpadReserveAddress = 20,
37		BreakpadReserveSize = 21,
38		BuildID = 22,
39		CPUMicrocodeVersion = 23,