chrome/common/crash_keys.cc

   1 // Copyright (c) 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "chrome/common/crash_keys.h"
   6
   7 #include "base/command_line.h"
   8 #include "base/format_macros.h"
   9 #include "base/logging.h"
  10 #include "base/strings/string_split.h"
  11 #include "base/strings/string_util.h"
  12 #include "base/strings/stringprintf.h"
  13 #include "base/strings/utf_string_conversions.h"
  14 #include "chrome/common/chrome_switches.h"
  15 #include "content/public/common/content_switches.h"
  16 #include "ipc/ipc_switches.h"
  17
  18 #if defined(OS_MACOSX)
  19 #include "breakpad/src/common/simple_string_dictionary.h"
  20 #elif defined(OS_WIN)
  21 #include "breakpad/src/client/windows/common/ipc_protocol.h"
  22 #elif defined(OS_CHROMEOS)
  23 #include "chrome/common/chrome_switches.h"
  24 #include "gpu/command_buffer/service/gpu_switches.h"
  25 #include "ui/gl/gl_switches.h"
  26 #endif
  27
  28 namespace crash_keys {
  29
  30 // A small crash key, guaranteed to never be split into multiple pieces.
  31 const size_t kSmallSize = 63;
  32
  33 // A medium crash key, which will be chunked on certain platforms but not
  34 // others. Guaranteed to never be more than four chunks.
  35 const size_t kMediumSize = kSmallSize * 4;
  36
  37 // A large crash key, which will be chunked on all platforms. This should be
  38 // used sparingly.
  39 const size_t kLargeSize = kSmallSize * 16;
  40
  41 // The maximum lengths specified by breakpad include the trailing NULL, so
  42 // the actual length of the string is one less.
  43 #if defined(OS_MACOSX)
  44 static const size_t kSingleChunkLength =
  45     google_breakpad::SimpleStringDictionary::value_size - 1;
  46 #elif defined(OS_WIN)
  47 static const size_t kSingleChunkLength =
  48     google_breakpad::CustomInfoEntry::kValueMaxLength - 1;
  49 #else
  50 static const size_t kSingleChunkLength = 63;
  51 #endif
  52
  53 // Guarantees for crash key sizes.
  54 static_assert(kSmallSize <= kSingleChunkLength,
  55               "crash key chunk size too small");
  56 #if defined(OS_MACOSX)
  57 static_assert(kMediumSize <= kSingleChunkLength,
  58               "mac has medium size crash key chunks");
  59 #endif
  60
  61 #if defined(OS_MACOSX)
  62 // Crashpad owns the "guid" key. Chrome's metrics client ID is a separate ID
  63 // carried in a distinct "metrics_client_id" field.
  64 const char kMetricsClientId[] = "metrics_client_id";
  65 #else
  66 const char kClientId[] = "guid";
  67 #endif
  68
  69 const char kChannel[] = "channel";
  70
  71 const char kActiveURL[] = "url-chunk";
  72
  73 const char kFontKeyName[] = "font_key_name";
  74
  75 const char kSwitch[] = "switch-%" PRIuS;
  76 const char kNumSwitches[] = "num-switches";
  77
  78 const char kNumVariations[] = "num-experiments";
  79 const char kVariations[] = "variations";
  80
  81 const char kExtensionID[] = "extension-%" PRIuS;
  82 const char kNumExtensionsCount[] = "num-extensions";
  83
  84 const char kShutdownType[] = "shutdown-type";
  85
  86 #if !defined(OS_ANDROID)
  87 const char kGPUVendorID[] = "gpu-venid";
  88 const char kGPUDeviceID[] = "gpu-devid";
  89 #endif
  90 const char kGPUDriverVersion[] = "gpu-driver";
  91 const char kGPUPixelShaderVersion[] = "gpu-psver";
  92 const char kGPUVertexShaderVersion[] = "gpu-vsver";
  93 #if defined(OS_MACOSX)
  94 const char kGPUGLVersion[] = "gpu-glver";
  95 #elif defined(OS_POSIX)
  96 const char kGPUVendor[] = "gpu-gl-vendor";
  97 const char kGPURenderer[] = "gpu-gl-renderer";
  98 #endif
  99
 100 const char kPrinterInfo[] = "prn-info-%" PRIuS;
 101
 102 #if defined(OS_CHROMEOS)
 103 const char kNumberOfUsers[] = "num-users";
 104 #endif
 105
 106 #if defined(OS_MACOSX)
 107 namespace mac {
 108
 109 const char kFirstNSException[] = "firstexception";
 110 const char kFirstNSExceptionTrace[] = "firstexception_bt";
 111
 112 const char kLastNSException[] = "lastexception";
 113 const char kLastNSExceptionTrace[] = "lastexception_bt";
 114
 115 const char kNSException[] = "nsexception";
 116 const char kNSExceptionTrace[] = "nsexception_bt";
 117
 118 const char kSendAction[] = "sendaction";
 119
 120 const char kZombie[] = "zombie";
 121 const char kZombieTrace[] = "zombie_dealloc_bt";
 122
 123 }  // namespace mac
 124 #endif
 125
 126 #if defined(KASKO)
 127 const char kKaskoGuid[] = "kasko-guid";
 128 const char kKaskoEquivalentGuid[] = "kasko-equivalent-guid";
 129 #endif
 130
 131 const char kBug464926CrashKey[] = "bug-464926-info";
 132
 133 const char kViewCount[] = "view-count";
 134
 135 size_t RegisterChromeCrashKeys() {
 136   // The following keys may be chunked by the underlying crash logging system,
 137   // but ultimately constitute a single key-value pair.
 138   base::debug::CrashKey fixed_keys[] = {
 139 #if defined(OS_MACOSX)
 140     { kMetricsClientId, kSmallSize },
 141 #else
 142     { kClientId, kSmallSize },
 143 #endif
 144     { kChannel, kSmallSize },
 145     { kActiveURL, kLargeSize },
 146     { kNumSwitches, kSmallSize },
 147     { kNumVariations, kSmallSize },
 148     { kVariations, kLargeSize },
 149     { kNumExtensionsCount, kSmallSize },
 150     { kShutdownType, kSmallSize },
 151 #if !defined(OS_ANDROID)
 152     { kGPUVendorID, kSmallSize },
 153     { kGPUDeviceID, kSmallSize },
 154 #endif
 155     { kGPUDriverVersion, kSmallSize },
 156     { kGPUPixelShaderVersion, kSmallSize },
 157     { kGPUVertexShaderVersion, kSmallSize },
 158 #if defined(OS_MACOSX)
 159     { kGPUGLVersion, kSmallSize },
 160 #elif defined(OS_POSIX)
 161     { kGPUVendor, kSmallSize },
 162     { kGPURenderer, kSmallSize },
 163 #endif
 164
 165     // content/:
 166     { "discardable-memory-allocated", kSmallSize },
 167     { "discardable-memory-free", kSmallSize },
 168     { kFontKeyName, kSmallSize},
 169     { "ppapi_path", kMediumSize },
 170     { "subresource_url", kLargeSize },
 171     { "total-discardable-memory-allocated", kSmallSize },
 172 #if defined(OS_CHROMEOS)
 173     { kNumberOfUsers, kSmallSize },
 174 #endif
 175 #if defined(OS_MACOSX)
 176     { mac::kFirstNSException, kMediumSize },
 177     { mac::kFirstNSExceptionTrace, kMediumSize },
 178     { mac::kLastNSException, kMediumSize },
 179     { mac::kLastNSExceptionTrace, kMediumSize },
 180     { mac::kNSException, kMediumSize },
 181     { mac::kNSExceptionTrace, kMediumSize },
 182     { mac::kSendAction, kMediumSize },
 183     { mac::kZombie, kMediumSize },
 184     { mac::kZombieTrace, kMediumSize },
 185     // content/:
 186     { "channel_error_bt", kMediumSize },
 187     { "remove_route_bt", kMediumSize },
 188     { "rwhvm_window", kMediumSize },
 189     // media/:
 190     { "VideoCaptureDeviceQTKit", kSmallSize },
 191 #endif
 192 #if defined(KASKO)
 193     { kKaskoGuid, kSmallSize },
 194     { kKaskoEquivalentGuid, kSmallSize },
 195 #endif
 196     { kBug464926CrashKey, kSmallSize },
 197     { kViewCount, kSmallSize },
 198   };
 199
 200   // This dynamic set of keys is used for sets of key value pairs when gathering
 201   // a collection of data, like command line switches or extension IDs.
 202   std::vector<base::debug::CrashKey> keys(
 203       fixed_keys, fixed_keys + arraysize(fixed_keys));
 204
 205   // Register the switches.
 206   {
 207     // The fixed_keys names are string constants. Use static storage for
 208     // formatted key names as well, since they will persist for the duration of
 209     // the program.
 210     static char formatted_keys[kSwitchesMaxCount][sizeof(kSwitch) + 1] =
 211         {{ 0 }};
 212     const size_t formatted_key_len = sizeof(formatted_keys[0]);
 213     for (size_t i = 0; i < kSwitchesMaxCount; ++i) {
 214       // Name the keys using 1-based indexing.
 215       int n = base::snprintf(
 216           formatted_keys[i], formatted_key_len, kSwitch, i + 1);
 217       DCHECK_GT(n, 0);
 218       base::debug::CrashKey crash_key = { formatted_keys[i], kSmallSize };
 219       keys.push_back(crash_key);
 220     }
 221   }
 222
 223   // Register the extension IDs.
 224   {
 225     static char formatted_keys[kExtensionIDMaxCount][sizeof(kExtensionID) + 1] =
 226         {{ 0 }};
 227     const size_t formatted_key_len = sizeof(formatted_keys[0]);
 228     for (size_t i = 0; i < kExtensionIDMaxCount; ++i) {
 229       int n = base::snprintf(
 230           formatted_keys[i], formatted_key_len, kExtensionID, i + 1);
 231       DCHECK_GT(n, 0);
 232       base::debug::CrashKey crash_key = { formatted_keys[i], kSmallSize };
 233       keys.push_back(crash_key);
 234     }
 235   }
 236
 237   // Register the printer info.
 238   {
 239     static char formatted_keys[kPrinterInfoCount][sizeof(kPrinterInfo) + 1] =
 240         {{ 0 }};
 241     const size_t formatted_key_len = sizeof(formatted_keys[0]);
 242     for (size_t i = 0; i < kPrinterInfoCount; ++i) {
 243       // Key names are 1-indexed.
 244       int n = base::snprintf(
 245           formatted_keys[i], formatted_key_len, kPrinterInfo, i + 1);
 246       DCHECK_GT(n, 0);
 247       base::debug::CrashKey crash_key = { formatted_keys[i], kSmallSize };
 248       keys.push_back(crash_key);
 249     }
 250   }
 251
 252   return base::debug::InitCrashKeys(&keys.at(0), keys.size(),
 253                                     kSingleChunkLength);
 254 }
 255
 256 void SetMetricsClientIdFromGUID(const std::string& metrics_client_guid) {
 257   std::string stripped_guid(metrics_client_guid);
 258   // Remove all instance of '-' char from the GUID. So BCD-WXY becomes BCDWXY.
 259   ReplaceSubstringsAfterOffset(&stripped_guid, 0, "-", "");
 260   if (stripped_guid.empty())
 261     return;
 262
 263 #if defined(OS_MACOSX)
 264   // The crash client ID is maintained by Crashpad and is distinct from the
 265   // metrics client ID, which is carried in its own key.
 266   base::debug::SetCrashKeyValue(kMetricsClientId, stripped_guid);
 267 #else
 268   // The crash client ID is set by the application when Breakpad is in use.
 269   // The same ID as the metrics client ID is used.
 270   base::debug::SetCrashKeyValue(kClientId, stripped_guid);
 271 #endif
 272 }
 273
 274 void ClearMetricsClientId() {
 275 #if defined(OS_MACOSX)
 276   // Crashpad always monitors for crashes, but doesn't upload them when
 277   // crash reporting is disabled. The preference to upload crash reports is
 278   // linked to the preference for metrics reporting. When metrics reporting is
 279   // disabled, don't put the metrics client ID into crash dumps. This way, crash
 280   // reports that are saved but not uploaded will not have a metrics client ID
 281   // from the time that metrics reporting was disabled even if they are uploaded
 282   // by user action at a later date.
 283   //
 284   // Breakpad cannot be enabled or disabled without an application restart, and
 285   // it needs to use the metrics client ID as its stable crash client ID, so
 286   // leave its client ID intact even when metrics reporting is disabled while
 287   // the application is running.
 288   base::debug::ClearCrashKey(kMetricsClientId);
 289 #endif
 290 }
 291
 292 static bool IsBoringSwitch(const std::string& flag) {
 293   static const char* const kIgnoreSwitches[] = {
 294     switches::kEnableLogging,
 295     switches::kFlagSwitchesBegin,
 296     switches::kFlagSwitchesEnd,
 297     switches::kLoggingLevel,
 298 #if defined(OS_WIN)
 299     // This file is linked into both chrome.dll and chrome.exe. However //ipc
 300     // is only in the .dll, so this needs to be a literal rather than the
 301     // constant.
 302     "channel",  // switches::kProcessChannelID
 303 #else
 304     switches::kProcessChannelID,
 305 #endif
 306     switches::kProcessType,
 307     switches::kV,
 308     switches::kVModule,
 309 #if defined(OS_WIN)
 310     switches::kForceFieldTrials,
 311     switches::kPluginPath,
 312 #elif defined(OS_MACOSX)
 313     switches::kMetricsClientID,
 314 #elif defined(OS_CHROMEOS)
 315     switches::kPpapiFlashArgs,
 316     switches::kPpapiFlashPath,
 317     switches::kRegisterPepperPlugins,
 318     switches::kUIPrioritizeInGpuProcess,
 319     switches::kUseGL,
 320     switches::kUserDataDir,
 321     // Cros/CC flgas are specified as raw strings to avoid dependency.
 322     "child-wallpaper-large",
 323     "child-wallpaper-small",
 324     "default-wallpaper-large",
 325     "default-wallpaper-small",
 326     "guest-wallpaper-large",
 327     "guest-wallpaper-small",
 328     "enterprise-enable-forced-re-enrollment",
 329     "enterprise-enrollment-initial-modulus",
 330     "enterprise-enrollment-modulus-limit",
 331     "login-profile",
 332     "login-user",
 333     "max-tiles-for-interest-area",
 334     "max-unused-resource-memory-usage-percentage",
 335     "termination-message-file",
 336     "use-cras",
 337 #endif
 338   };
 339
 340 #if defined(OS_WIN)
 341   // Just about everything has this, don't bother.
 342   if (StartsWithASCII(flag, "/prefetch:", true))
 343     return true;
 344 #endif
 345
 346   if (!StartsWithASCII(flag, "--", true))
 347     return false;
 348   size_t end = flag.find("=");
 349   size_t len = (end == std::string::npos) ? flag.length() - 2 : end - 2;
 350   for (size_t i = 0; i < arraysize(kIgnoreSwitches); ++i) {
 351     if (flag.compare(2, len, kIgnoreSwitches[i]) == 0)
 352       return true;
 353   }
 354   return false;
 355 }
 356
 357 void SetSwitchesFromCommandLine(const base::CommandLine* command_line) {
 358   DCHECK(command_line);
 359   if (!command_line)
 360     return;
 361
 362   const base::CommandLine::StringVector& argv = command_line->argv();
 363
 364   // Set the number of switches in case size > kNumSwitches.
 365   base::debug::SetCrashKeyValue(kNumSwitches,
 366       base::StringPrintf("%" PRIuS, argv.size() - 1));
 367
 368   size_t key_i = 1;  // Key names are 1-indexed.
 369
 370   // Go through the argv, skipping the exec path.
 371   for (size_t i = 1; i < argv.size(); ++i) {
 372 #if defined(OS_WIN)
 373     std::string switch_str = base::WideToUTF8(argv[i]);
 374 #else
 375     std::string switch_str = argv[i];
 376 #endif
 377
 378     // Skip uninteresting switches.
 379     if (IsBoringSwitch(switch_str))
 380       continue;
 381
 382     // Stop if there are too many switches.
 383     if (i > crash_keys::kSwitchesMaxCount)
 384       break;
 385
 386     std::string key = base::StringPrintf(kSwitch, key_i++);
 387     base::debug::SetCrashKeyValue(key, switch_str);
 388   }
 389
 390   // Clear any remaining switches.
 391   for (; key_i <= kSwitchesMaxCount; ++key_i) {
 392     base::debug::ClearCrashKey(base::StringPrintf(kSwitch, key_i));
 393   }
 394 }
 395
 396 void SetVariationsList(const std::vector<std::string>& variations) {
 397   base::debug::SetCrashKeyValue(kNumVariations,
 398       base::StringPrintf("%" PRIuS, variations.size()));
 399
 400   std::string variations_string;
 401   variations_string.reserve(kLargeSize);
 402
 403   for (size_t i = 0; i < variations.size(); ++i) {
 404     const std::string& variation = variations[i];
 405     // Do not truncate an individual experiment.
 406     if (variations_string.size() + variation.size() >= kLargeSize)
 407       break;
 408     variations_string += variation;
 409     variations_string += ",";
 410   }
 411
 412   base::debug::SetCrashKeyValue(kVariations, variations_string);
 413 }
 414
 415 void SetActiveExtensions(const std::set<std::string>& extensions) {
 416   base::debug::SetCrashKeyValue(kNumExtensionsCount,
 417       base::StringPrintf("%" PRIuS, extensions.size()));
 418
 419   std::set<std::string>::const_iterator it = extensions.begin();
 420   for (size_t i = 0; i < kExtensionIDMaxCount; ++i) {
 421     std::string key = base::StringPrintf(kExtensionID, i + 1);
 422     if (it == extensions.end()) {
 423       base::debug::ClearCrashKey(key);
 424     } else {
 425       base::debug::SetCrashKeyValue(key, *it);
 426       ++it;
 427     }
 428   }
 429 }
 430
 431 ScopedPrinterInfo::ScopedPrinterInfo(const base::StringPiece& data) {
 432   std::vector<std::string> info;
 433   base::SplitString(data.as_string(), ';', &info);
 434   for (size_t i = 0; i < kPrinterInfoCount; ++i) {
 435     std::string key = base::StringPrintf(kPrinterInfo, i + 1);
 436     std::string value;
 437     if (i < info.size())
 438       value = info[i];
 439     base::debug::SetCrashKeyValue(key, value);
 440   }
 441 }
 442
 443 ScopedPrinterInfo::~ScopedPrinterInfo() {
 444   for (size_t i = 0; i < kPrinterInfoCount; ++i) {
 445     std::string key = base::StringPrintf(kPrinterInfo, i + 1);
 446     base::debug::ClearCrashKey(key);
 447   }
 448 }
 449
 450 }  // namespace crash_keys