| // Copyright (c) 2009 The Chromium Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #include "chrome/app/breakpad_win.h" |
| |
| #include <windows.h> |
| #include <shellapi.h> |
| #include <tchar.h> |
| #include <vector> |
| |
| #include "base/base_switches.h" |
| #include "base/command_line.h" |
| #include "base/file_util.h" |
| #include "base/file_version_info.h" |
| #include "base/registry.h" |
| #include "base/string_util.h" |
| #include "base/win_util.h" |
| #include "chrome/app/hard_error_handler_win.h" |
| #include "chrome/common/env_vars.h" |
| #include "chrome/common/result_codes.h" |
| #include "chrome/installer/util/install_util.h" |
| #include "chrome/installer/util/google_update_settings.h" |
| #include "breakpad/src/client/windows/handler/exception_handler.h" |
| |
| namespace { |
| |
| const wchar_t kGoogleUpdatePipeName[] = L"\\\\.\\pipe\\GoogleCrashServices\\"; |
| const wchar_t kChromePipeName[] = L"\\\\.\\pipe\\ChromeCrashServices"; |
| |
| // This is the well known SID for the system principal. |
| const wchar_t kSystemPrincipalSid[] =L"S-1-5-18"; |
| |
| google_breakpad::ExceptionHandler* g_breakpad = NULL; |
| |
| // A pointer to the custom entries that we send in the event of a crash. We need |
| // this pointer, along with the offsets into it below, so that we can keep the |
| // data updated as the state of the browser changes. |
| static std::vector<google_breakpad::CustomInfoEntry>* g_custom_entries = NULL; |
| static size_t g_url_chunks_offset; |
| static size_t g_extension_ids_offset; |
| static size_t g_client_id_offset; |
| |
| // Dumps the current process memory. |
| extern "C" void __declspec(dllexport) __cdecl DumpProcess() { |
| if (g_breakpad) |
| g_breakpad->WriteMinidump(); |
| } |
| |
| // Reduces the size of the string |str| to a max of 64 chars. Required because |
| // breakpad's CustomInfoEntry raises an invalid_parameter error if the string |
| // we want to set is longer. |
| std::wstring TrimToBreakpadMax(const std::wstring& str) { |
| std::wstring shorter(str); |
| return shorter.substr(0, |
| google_breakpad::CustomInfoEntry::kValueMaxLength - 1); |
| } |
| |
| // Returns the custom info structure based on the dll in parameter and the |
| // process type. |
| google_breakpad::CustomClientInfo* GetCustomInfo(const std::wstring& dll_path, |
| const std::wstring& type) { |
| scoped_ptr<FileVersionInfo> |
| version_info(FileVersionInfo::CreateFileVersionInfo(dll_path)); |
| |
| std::wstring version, product; |
| if (version_info.get()) { |
| // Get the information from the file. |
| product = version_info->product_short_name(); |
| version = version_info->product_version(); |
| if (!version_info->is_official_build()) |
| version.append(L"-devel"); |
| } else { |
| // No version info found. Make up the values. |
| product = L"Chrome"; |
| version = L"0.0.0.0-devel"; |
| } |
| |
| // We only expect this method to be called once per process. |
| DCHECK(!g_custom_entries); |
| g_custom_entries = new std::vector<google_breakpad::CustomInfoEntry>; |
| |
| // Common g_custom_entries. |
| g_custom_entries->push_back( |
| google_breakpad::CustomInfoEntry(L"ver", version.c_str())); |
| g_custom_entries->push_back( |
| google_breakpad::CustomInfoEntry(L"prod", product.c_str())); |
| g_custom_entries->push_back( |
| google_breakpad::CustomInfoEntry(L"plat", L"Win32")); |
| g_custom_entries->push_back( |
| google_breakpad::CustomInfoEntry(L"ptype", type.c_str())); |
| |
| g_extension_ids_offset = g_custom_entries->size(); |
| for (int i = 0; i < kMaxReportedActiveExtensions; ++i) { |
| g_custom_entries->push_back(google_breakpad::CustomInfoEntry( |
| StringPrintf(L"extension-%i", i + 1).c_str(), L"")); |
| } |
| |
| // Read the id from registry. If reporting has never been enabled |
| // the result will be empty string. Its OK since when user enables reporting |
| // we will insert the new value at this location. |
| std::wstring guid; |
| GoogleUpdateSettings::GetMetricsId(&guid); |
| g_client_id_offset = g_custom_entries->size(); |
| g_custom_entries->push_back( |
| google_breakpad::CustomInfoEntry(L"guid", guid.c_str())); |
| |
| if (type == L"renderer" || type == L"plugin") { |
| // Create entries for the URL. Currently we only allow each chunk to be 64 |
| // characters, which isn't enough for a URL. As a hack we create 8 entries |
| // and split the URL across the g_custom_entries. |
| g_url_chunks_offset = g_custom_entries->size(); |
| for (int i = 0; i < kMaxUrlChunks; ++i) { |
| g_custom_entries->push_back(google_breakpad::CustomInfoEntry( |
| StringPrintf(L"url-chunk-%i", i + 1).c_str(), L"")); |
| } |
| } else { |
| // Browser-specific g_custom_entries. |
| google_breakpad::CustomInfoEntry switch1(L"switch-1", L""); |
| google_breakpad::CustomInfoEntry switch2(L"switch-2", L""); |
| |
| // Get the first two command line switches if they exist. The CommandLine |
| // class does not allow to enumerate the switches so we do it by hand. |
| int num_args = 0; |
| wchar_t** args = ::CommandLineToArgvW(::GetCommandLineW(), &num_args); |
| if (args) { |
| if (num_args > 1) |
| switch1.set_value(TrimToBreakpadMax(args[1]).c_str()); |
| if (num_args > 2) |
| switch2.set_value(TrimToBreakpadMax(args[2]).c_str()); |
| } |
| |
| g_custom_entries->push_back(switch1); |
| g_custom_entries->push_back(switch2); |
| } |
| |
| static google_breakpad::CustomClientInfo custom_client_info; |
| custom_client_info.entries = &g_custom_entries->front(); |
| custom_client_info.count = g_custom_entries->size(); |
| |
| return &custom_client_info; |
| } |
| |
| // Contains the information needed by the worker thread. |
| struct CrashReporterInfo { |
| google_breakpad::CustomClientInfo* custom_info; |
| std::wstring dll_path; |
| std::wstring process_type; |
| }; |
| |
| // This callback is executed when the browser process has crashed, after |
| // the crash dump has been created. We need to minimize the amount of work |
| // done here since we have potentially corrupted process. Our job is to |
| // spawn another instance of chrome which will show a 'chrome has crashed' |
| // dialog. This code needs to live in the exe and thus has no access to |
| // facilities such as the i18n helpers. |
| bool DumpDoneCallback(const wchar_t*, const wchar_t*, void*, |
| EXCEPTION_POINTERS* ex_info, |
| MDRawAssertionInfo*, bool) { |
| // If the exception is because there was a problem loading a delay-loaded |
| // module, then show the user a dialog explaining the problem and then exit. |
| if (DelayLoadFailureExceptionMessageBox(ex_info)) |
| return true; |
| |
| // We set CHROME_CRASHED env var. If the CHROME_RESTART is present. |
| // This signals the child process to show the 'chrome has crashed' dialog. |
| if (!::GetEnvironmentVariableW(env_vars::kRestartInfo, NULL, 0)) |
| return true; |
| ::SetEnvironmentVariableW(env_vars::kShowRestart, L"1"); |
| // Now we just start chrome browser with the same command line. |
| STARTUPINFOW si = {sizeof(si)}; |
| PROCESS_INFORMATION pi; |
| if (::CreateProcessW(NULL, ::GetCommandLineW(), NULL, NULL, FALSE, |
| CREATE_UNICODE_ENVIRONMENT, NULL, NULL, &si, &pi)) { |
| ::CloseHandle(pi.hProcess); |
| ::CloseHandle(pi.hThread); |
| } |
| // After this return we will be terminated. The actual return value is |
| // not used at all. |
| return true; |
| } |
| |
| // flag to indicate that we are already handling an exception. |
| volatile LONG handling_exception = 0; |
| |
| // This callback is executed when the Chrome process has crashed and *before* |
| // the crash dump is created. To prevent duplicate crash reports we |
| // make every thread calling this method, except the very first one, |
| // go to sleep. |
| bool FilterCallback(void*, EXCEPTION_POINTERS*, MDRawAssertionInfo*) { |
| // Capture every thread except the first one in the sleep. We don't |
| // want multiple threads to concurrently report exceptions. |
| if (::InterlockedCompareExchange(&handling_exception, 1, 0) == 1) { |
| ::Sleep(INFINITE); |
| } |
| return true; |
| } |
| |
| // Previous unhandled filter. Will be called if not null when we |
| // intercept a crash. |
| LPTOP_LEVEL_EXCEPTION_FILTER previous_filter = NULL; |
| |
| // Exception filter used when breakpad is not enabled. We just display |
| // the "Do you want to restart" message and then we call the previous filter. |
| long WINAPI ChromeExceptionFilter(EXCEPTION_POINTERS* info) { |
| DumpDoneCallback(NULL, NULL, NULL, info, NULL, false); |
| |
| if (previous_filter) |
| return previous_filter(info); |
| |
| return EXCEPTION_EXECUTE_HANDLER; |
| } |
| |
| extern "C" void __declspec(dllexport) __cdecl SetActiveURL( |
| const wchar_t* url_cstring) { |
| DCHECK(url_cstring); |
| |
| std::wstring url(url_cstring); |
| size_t chunk_index = 0; |
| size_t url_size = url.size(); |
| |
| // Split the url across all the chunks. |
| for (size_t url_offset = 0; |
| chunk_index < kMaxUrlChunks && url_offset < url_size; ++chunk_index) { |
| size_t current_chunk_size = std::min(url_size - url_offset, |
| static_cast<size_t>( |
| google_breakpad::CustomInfoEntry::kValueMaxLength - 1)); |
| |
| wchar_t* entry_value = |
| (*g_custom_entries)[g_url_chunks_offset + chunk_index].value; |
| url._Copy_s(entry_value, |
| google_breakpad::CustomInfoEntry::kValueMaxLength, |
| current_chunk_size, url_offset); |
| entry_value[current_chunk_size] = L'\0'; |
| url_offset += current_chunk_size; |
| } |
| |
| // And null terminate any unneeded chunks. |
| for (; chunk_index < kMaxUrlChunks; ++chunk_index) |
| (*g_custom_entries)[g_url_chunks_offset + chunk_index].value[0] = L'\0'; |
| } |
| |
| extern "C" void __declspec(dllexport) __cdecl SetClientId( |
| const wchar_t* client_id) { |
| if (client_id == NULL) |
| return; |
| |
| wcscpy_s((*g_custom_entries)[g_client_id_offset].value, |
| google_breakpad::CustomInfoEntry::kValueMaxLength, |
| client_id); |
| } |
| |
| extern "C" void __declspec(dllexport) __cdecl SetExtensionID( |
| int index, const wchar_t* id) { |
| DCHECK(id); |
| DCHECK(index < kMaxReportedActiveExtensions); |
| |
| wcscpy_s((*g_custom_entries)[g_extension_ids_offset + index].value, |
| google_breakpad::CustomInfoEntry::kValueMaxLength, |
| id); |
| } |
| |
| } // namespace |
| |
| // This function is executed by the child process that DumpDoneCallback() |
| // spawned and basically just shows the 'chrome has crashed' dialog if |
| // the CHROME_CRASHED environment variable is present. |
| bool ShowRestartDialogIfCrashed(bool* exit_now) { |
| if (!::GetEnvironmentVariableW(env_vars::kShowRestart, NULL, 0)) |
| return false; |
| |
| DWORD len = ::GetEnvironmentVariableW(env_vars::kRestartInfo, NULL, 0); |
| if (!len) |
| return true; |
| |
| // We wrap the call to MessageBoxW with a SEH handler because it some |
| // machines with CursorXP, PeaDict or with FontExplorer installed it crashes |
| // uncontrollably here. Being this a best effort deal we better go away. |
| #pragma warning(push) |
| #pragma warning(disable:4509) // warning: SEH used but dlg_strings has a dtor. |
| __try { |
| wchar_t* restart_data = new wchar_t[len + 1]; |
| ::GetEnvironmentVariableW(env_vars::kRestartInfo, restart_data, len); |
| restart_data[len] = 0; |
| // The CHROME_RESTART var contains the dialog strings separated by '|'. |
| // See PrepareRestartOnCrashEnviroment() function for details. |
| std::vector<std::wstring> dlg_strings; |
| SplitString(restart_data, L'|', &dlg_strings); |
| delete[] restart_data; |
| if (dlg_strings.size() < 3) |
| return true; |
| |
| // If the UI layout is right-to-left, we need to pass the appropriate MB_XXX |
| // flags so that an RTL message box is displayed. |
| UINT flags = MB_OKCANCEL | MB_ICONWARNING; |
| if (dlg_strings[2] == env_vars::kRtlLocale) |
| flags |= MB_RIGHT | MB_RTLREADING; |
| |
| // Show the dialog now. It is ok if another chrome is started by the |
| // user since we have not initialized the databases. |
| *exit_now = (IDOK != ::MessageBoxW(NULL, dlg_strings[1].c_str(), |
| dlg_strings[0].c_str(), flags)); |
| } __except(EXCEPTION_EXECUTE_HANDLER) { |
| // Its not safe to continue executing, exit silently here. |
| ::ExitProcess(ResultCodes::RESPAWN_FAILED); |
| } |
| #pragma warning(pop) |
| return true; |
| } |
| |
| static DWORD __stdcall InitCrashReporterThread(void* param) { |
| scoped_ptr<CrashReporterInfo> info( |
| reinterpret_cast<CrashReporterInfo*>(param)); |
| |
| // GetCustomInfo can take a few milliseconds to get the file information, so |
| // we do it here so it can run in a separate thread. |
| info->custom_info = GetCustomInfo(info->dll_path, info->process_type); |
| |
| google_breakpad::ExceptionHandler::MinidumpCallback callback = NULL; |
| if (info->process_type == L"browser") { |
| // We install the post-dump callback only for the browser process. It |
| // spawns a new browser process. |
| callback = &DumpDoneCallback; |
| } |
| |
| const CommandLine& command = *CommandLine::ForCurrentProcess(); |
| bool use_crash_service = command.HasSwitch(switches::kNoErrorDialogs) || |
| GetEnvironmentVariable(L"CHROME_HEADLESS", NULL, 0); |
| |
| std::wstring pipe_name; |
| if (use_crash_service) { |
| // Crash reporting is done by crash_service.exe. |
| pipe_name = kChromePipeName; |
| } else { |
| // We want to use the Google Update crash reporting. We need to check if the |
| // user allows it first. |
| if (!GoogleUpdateSettings::GetCollectStatsConsent()) { |
| // The user did not allow Google Update to send crashes, we need to use |
| // our default crash handler instead, but only for the browser process. |
| if (callback) |
| InitDefaultCrashCallback(); |
| return 0; |
| } |
| |
| // Build the pipe name. It can be either: |
| // System-wide install: "NamedPipe\GoogleCrashServices\S-1-5-18" |
| // Per-user install: "NamedPipe\GoogleCrashServices\<user SID>" |
| std::wstring user_sid; |
| if (InstallUtil::IsPerUserInstall(info->dll_path.c_str())) { |
| if (!win_util::GetUserSidString(&user_sid)) { |
| if (callback) |
| InitDefaultCrashCallback(); |
| return -1; |
| } |
| } else { |
| user_sid = kSystemPrincipalSid; |
| } |
| |
| pipe_name = kGoogleUpdatePipeName; |
| pipe_name += user_sid; |
| } |
| |
| // Get the alternate dump directory. We use the temp path. |
| wchar_t temp_dir[MAX_PATH] = {0}; |
| ::GetTempPathW(MAX_PATH, temp_dir); |
| |
| bool full_dump = command.HasSwitch(switches::kFullMemoryCrashReport); |
| MINIDUMP_TYPE dump_type = full_dump ? MiniDumpWithFullMemory : MiniDumpNormal; |
| |
| g_breakpad = new google_breakpad::ExceptionHandler(temp_dir, &FilterCallback, |
| callback, NULL, |
| google_breakpad::ExceptionHandler::HANDLER_ALL, |
| dump_type, pipe_name.c_str(), info->custom_info); |
| |
| if (!g_breakpad->IsOutOfProcess()) { |
| // The out-of-process handler is unavailable. |
| ::SetEnvironmentVariable(env_vars::kNoOOBreakpad, |
| info->process_type.c_str()); |
| } else { |
| // Tells breakpad to handle breakpoint and single step exceptions. |
| // This might break JIT debuggers, but at least it will always |
| // generate a crashdump for these exceptions. |
| g_breakpad->set_handle_debug_exceptions(true); |
| } |
| |
| return 0; |
| } |
| |
| void InitDefaultCrashCallback() { |
| previous_filter = SetUnhandledExceptionFilter(ChromeExceptionFilter); |
| } |
| |
| void InitCrashReporterWithDllPath(const std::wstring& dll_path) { |
| const CommandLine& command = *CommandLine::ForCurrentProcess(); |
| if (!command.HasSwitch(switches::kDisableBreakpad)) { |
| // Disable the message box for assertions. |
| _CrtSetReportMode(_CRT_ASSERT, 0); |
| |
| // Query the custom_info now because if we do it in the thread it's going to |
| // fail in the sandbox. The thread will delete this object. |
| scoped_ptr<CrashReporterInfo> info(new CrashReporterInfo); |
| info->process_type = command.GetSwitchValue(switches::kProcessType); |
| if (info->process_type.empty()) |
| info->process_type = L"browser"; |
| |
| info->dll_path = dll_path; |
| |
| // If this is not the browser, we can't be sure that we will be able to |
| // initialize the crash_handler in another thread, so we run it right away. |
| // This is important to keep the thread for the browser process because |
| // it may take some times to initialize the crash_service process. We use |
| // the Windows worker pool to make better reuse of the thread. |
| if (info->process_type != L"browser") { |
| InitCrashReporterThread(info.release()); |
| } else { |
| if (QueueUserWorkItem( |
| &InitCrashReporterThread, |
| info.release(), |
| WT_EXECUTELONGFUNCTION) == 0) { |
| // We failed to queue to the worker pool, initialize in this thread. |
| InitCrashReporterThread(info.release()); |
| } |
| } |
| } |
| } |