From e167e9e61f433329e5ddd664e96696f6757df735 Mon Sep 17 00:00:00 2001 From: "nealsid@gmail.com" Date: Thu, 19 Aug 2010 21:53:35 +0000 Subject: [PATCH] Add glog style logging to symupload git-svn-id: http://google-breakpad.googlecode.com/svn/trunk@658 4c0a9323-5329-0410-9bdc-e9ce6186880e --- src/common/windows/http_upload.cc | 61 +++++++++++++- src/common/windows/wchar_logging.h | 59 ++++++++++++++ src/tools/windows/symupload/symupload.cc | 31 ++++++- src/tools/windows/symupload/symupload.vcproj | 86 +++++++++++++++++++- 4 files changed, 228 insertions(+), 9 deletions(-) create mode 100644 src/common/windows/wchar_logging.h diff --git a/src/common/windows/http_upload.cc b/src/common/windows/http_upload.cc index 65265723..77c5f749 100644 --- a/src/common/windows/http_upload.cc +++ b/src/common/windows/http_upload.cc @@ -35,9 +35,15 @@ #include #include "common/windows/string_utils-inl.h" +#include "common/windows/wchar_logging.h" #include "common/windows/http_upload.h" +// See comment in symupload.cc about #undef ERROR. Unfortunately this has to +// violate style guide and come after http_upload.h. +#undef ERROR +#include "third_party/glog/glog/src/windows/glog/logging.h" + namespace google_breakpad { using std::ifstream; @@ -45,6 +51,28 @@ using std::ios; static const wchar_t kUserAgent[] = L"Breakpad/1.0 (Windows)"; +wchar_t lastErrorMessageBuffer[1024]; + +// Helper method to convert Last Error into a text message. Uses a static +// buffer, so don't save the message across Win32 calls that might change +// the last error. +// +// This function saves/restores the last error and it isn't thread safe. +const wchar_t* FormatLastError() { + DWORD oldLastError = GetLastError(); + wchar_t lastErrorTempBuffer[1024]; + if (FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM, NULL, GetLastError(), 0, + lastErrorTempBuffer, 1024, NULL) == 0) { + wsprintf(lastErrorMessageBuffer, L"%d: (format message failed: %d)", + oldLastError, GetLastError()); + } else { + wsprintf(lastErrorMessageBuffer, L"%d: %s", oldLastError, + lastErrorTempBuffer); + } + SetLastError(oldLastError); + return lastErrorMessageBuffer; +} + // Helper class which closes an internet handle when it goes away class HTTPUpload::AutoInternetHandle { public: @@ -72,7 +100,19 @@ bool HTTPUpload::SendRequest(const wstring &url, if (response_code) { *response_code = 0; } - + VLOG(1) << "HTTPUpload::SendRequest"; + VLOG(1) << "\tURL: " << url; + VLOG(1) << "\tUpload_File: " << upload_file; + VLOG(1) << "\tFile_part_name: " << file_part_name; + VLOG(1) << "\tParameters: "; + string s; + if (VLOG_IS_ON(1)) { + for (std::map::const_iterator it = parameters.begin(); + it != parameters.end(); ++it) { + VLOG(1) << "\t\t" << it->first << " = " << it->second; + } + } + // TODO(bryner): support non-ASCII parameter names if (!CheckParameters(parameters)) { return false; @@ -90,7 +130,9 @@ bool HTTPUpload::SendRequest(const wstring &url, components.lpszUrlPath = path; components.dwUrlPathLength = sizeof(path) / sizeof(path[0]); if (!InternetCrackUrl(url.c_str(), static_cast(url.size()), - 0, &components)) { + 0, &components)) { + LOG(ERROR) << "InternetCrackUrl failed: " << FormatLastError(); + LOG(ERROR) << "This indicates a malformed upload server name"; return false; } bool secure = false; @@ -106,6 +148,7 @@ bool HTTPUpload::SendRequest(const wstring &url, NULL, // proxy bypass 0)); // flags if (!internet.get()) { + LOG(ERROR) << "InternetOpen returned NULL: " << FormatLastError(); return false; } @@ -118,6 +161,7 @@ bool HTTPUpload::SendRequest(const wstring &url, 0, // flags NULL)); // context if (!connection.get()) { + LOG(ERROR) << "InternetConnect returned NULL: " << FormatLastError(); return false; } @@ -131,6 +175,7 @@ bool HTTPUpload::SendRequest(const wstring &url, http_open_flags, NULL)); // context if (!request.get()) { + LOG(ERROR) << "HttpOpenRequest returned NULL: " << FormatLastError(); return false; } @@ -152,13 +197,17 @@ bool HTTPUpload::SendRequest(const wstring &url, INTERNET_OPTION_SEND_TIMEOUT, timeout, sizeof(timeout))) { - fwprintf(stderr, L"Could not unset send timeout, continuing...\n"); + LOG(ERROR) << "InternetSetOption on send timeout returned NULL: " + << FormatLastError(); + fwprintf(stderr, L"Could not unset send timeout, continuing...\n"); } if (!InternetSetOption(request.get(), INTERNET_OPTION_RECEIVE_TIMEOUT, timeout, sizeof(timeout))) { + LOG(ERROR) << "InternetSetOption on receive timeout returned NULL: " + << FormatLastError(); fwprintf(stderr, L"Could not unset receive timeout, continuing...\n"); } } @@ -166,6 +215,7 @@ bool HTTPUpload::SendRequest(const wstring &url, if (!HttpSendRequest(request.get(), NULL, 0, const_cast(request_body.data()), static_cast(request_body.size()))) { + LOG(ERROR) << "HttpSendRequest on send returned NULL: " << FormatLastError(); return false; } @@ -175,6 +225,7 @@ bool HTTPUpload::SendRequest(const wstring &url, if (!HttpQueryInfo(request.get(), HTTP_QUERY_STATUS_CODE, static_cast(&http_status), &http_status_size, 0)) { + LOG(ERROR) << "HttpQueryInfo after send returned NULL: " << FormatLastError(); return false; } @@ -187,6 +238,8 @@ bool HTTPUpload::SendRequest(const wstring &url, if (result) { result = ReadResponse(request.get(), response_body); + } else { + LOG(ERROR) << "Http send request returned: " << result; } return result; @@ -397,11 +450,13 @@ bool HTTPUpload::CheckParameters(const map ¶meters) { pos != parameters.end(); ++pos) { const wstring &str = pos->first; if (str.size() == 0) { + LOG(ERROR) << "Parameter " << str << " had non ascii characters"; return false; // disallow empty parameter names } for (unsigned int i = 0; i < str.size(); ++i) { wchar_t c = str[i]; if (c < 32 || c == '"' || c > 127) { + LOG(ERROR) << "Parameter " << str << " had non ascii characters"; return false; } } diff --git a/src/common/windows/wchar_logging.h b/src/common/windows/wchar_logging.h new file mode 100644 index 00000000..b0a02f47 --- /dev/null +++ b/src/common/windows/wchar_logging.h @@ -0,0 +1,59 @@ +// Copyright (c) 2010, Google Inc. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// This header file defines << for wchar, which is necessary for google glog +// to correctly log strings that have that constituent type. +// See http://code.google.com/p/google-glog/issues/detail?id=4 + + +#ifndef WCHAR_LOGGING_H_ +#define WCHAR_LOGGING_H_ + +#include + +#include +#include + +inline std::ostream& operator<<(std::ostream& out, const wchar_t* str) { + size_t len; + wcstombs_s(&len, NULL, 0, str, _TRUNCATE); + char* buf = (char*)malloc(len + 1); + buf[len] = 0; + size_t converted; + wcstombs_s(&converted, buf, len, str, _TRUNCATE); + out << buf; + free(buf); + return out; +} + +inline std::ostream& operator<<(std::ostream& out, const std::wstring& str) { + return operator<<(out, str.c_str()); +} + +#endif // WCHAR_LOGGING_H_ \ No newline at end of file diff --git a/src/tools/windows/symupload/symupload.cc b/src/tools/windows/symupload/symupload.cc index b858a63d..0b2f366a 100644 --- a/src/tools/windows/symupload/symupload.cc +++ b/src/tools/windows/symupload/symupload.cc @@ -51,10 +51,14 @@ #include #include -#include "common/windows/string_utils-inl.h" - #include "common/windows/http_upload.h" #include "common/windows/pdb_source_line_writer.h" +#include "common/windows/string_utils-inl.h" +#include "common/windows/wchar_logging.h" +// See http://code.google.com/p/google-glog/issues/detail?id=33 for why +// this #undef is added. +#undef ERROR +#include "third_party/glog/glog/src/windows/glog/logging.h" using std::string; using std::wstring; @@ -112,12 +116,15 @@ static bool DumpSymbolsToTempFile(const wchar_t *file, wstring *temp_file_path, PDBModuleInfo *pdb_info) { google_breakpad::PDBSourceLineWriter writer; + VLOG(1) << "DumpSymbolsToTempFile opening file"; // Use EXE_FILE to get information out of the exe/dll in addition to the // pdb. The name and version number of the exe/dll are of value, and // there's no way to locate an exe/dll given a pdb. if (!writer.Open(file, PDBSourceLineWriter::EXE_FILE)) { + VLOG(1) << "Error opening input module"; return false; } + VLOG(1) << "DumpSymbolsToTempFile file opened"; wchar_t temp_path[_MAX_PATH]; if (GetTempPath(_MAX_PATH, temp_path) == 0) { @@ -128,6 +135,7 @@ static bool DumpSymbolsToTempFile(const wchar_t *file, if (GetTempFileName(temp_path, L"sym", 0, temp_filename) == 0) { return false; } + VLOG(1) << "Temporary symbol filename is: " << temp_filename; FILE *temp_file = NULL; #if _MSC_VER >= 1400 // MSVC 2005/8 @@ -145,7 +153,8 @@ static bool DumpSymbolsToTempFile(const wchar_t *file, fclose(temp_file); if (!success) { _wunlink(temp_filename); - return false; + LOG(ERROR) << "Error writing to temp file"; + return false; } *temp_file_path = temp_filename; @@ -160,11 +169,24 @@ void printUsageAndExit() { exit(0); } int wmain(int argc, wchar_t *argv[]) { + char progname[MAX_PATH]; + size_t convertedChars; + wcstombs_s(&convertedChars, progname, MAX_PATH, argv[0], _TRUNCATE); + google::InitGoogleLogging(progname); + if ((argc != 3) && (argc != 5)) { printUsageAndExit(); } + if (argc == 5) { + VLOG(1) << "Module: " << argv[3]; + VLOG(1) << "Server: " << argv[4]; + } else { + VLOG(1) << "Module: " << argv[1]; + VLOG(1) << "Server: " << argv[2]; + } + const wchar_t *module, *url; int timeout = -1; if (argc == 3) { @@ -181,12 +203,15 @@ int wmain(int argc, wchar_t *argv[]) { } } + VLOG(1) << "Beginning symbol dump"; wstring symbol_file; PDBModuleInfo pdb_info; if (!DumpSymbolsToTempFile(module, &symbol_file, &pdb_info)) { fwprintf(stderr, L"Could not get symbol data from %s\n", module); + LOG(ERROR) << "Could not get symbol data from " << module; return 1; } + VLOG(1) << "Symbol dump completed to " << symbol_file; wstring code_file = WindowsStringUtils::GetBaseName(wstring(module)); diff --git a/src/tools/windows/symupload/symupload.vcproj b/src/tools/windows/symupload/symupload.vcproj index d6d07f1e..b11389c2 100644 --- a/src/tools/windows/symupload/symupload.vcproj +++ b/src/tools/windows/symupload/symupload.vcproj @@ -39,7 +39,7 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +