blob: 9fe235cc93546ba779f707522f854f2a28f4d185 [file] [log] [blame]
[email protected]63e66802012-01-18 21:21:091// Copyright (c) 2012 The Chromium Authors. All rights reserved.
license.botbf09a502008-08-24 00:55:552// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
initial.commitd7cae122008-07-26 21:49:384
[email protected]b16ef312008-08-19 18:36:235#include "base/logging.h"
[email protected]f6abeba2008-08-08 13:27:286
[email protected]b16ef312008-08-19 18:36:237#if defined(OS_WIN)
[email protected]e36ddc82009-12-08 04:22:508#include <io.h>
[email protected]f6abeba2008-08-08 13:27:289#include <windows.h>
10typedef HANDLE FileHandle;
11typedef HANDLE MutexHandle;
[email protected]e36ddc82009-12-08 04:22:5012// Windows warns on using write(). It prefers _write().
13#define write(fd, buf, count) _write(fd, buf, static_cast<unsigned int>(count))
14// Windows doesn't define STDERR_FILENO. Define it here.
15#define STDERR_FILENO 2
[email protected]052f1b52008-11-06 21:43:0716#elif defined(OS_MACOSX)
[email protected]f6abeba2008-08-08 13:27:2817#include <mach/mach.h>
18#include <mach/mach_time.h>
19#include <mach-o/dyld.h>
[email protected]e43eddf12009-12-29 00:32:5220#elif defined(OS_POSIX)
[email protected]19ea84ca2010-11-12 08:37:0821#if defined(OS_NACL)
[email protected]19ea84ca2010-11-12 08:37:0822#include <sys/time.h> // timespec doesn't seem to be in <time.h>
23#else
[email protected]052f1b52008-11-06 21:43:0724#include <sys/syscall.h>
[email protected]19ea84ca2010-11-12 08:37:0825#endif
[email protected]052f1b52008-11-06 21:43:0726#include <time.h>
[email protected]614e9fa2008-08-11 22:52:5927#endif
28
29#if defined(OS_POSIX)
[email protected]d8617a62009-10-09 23:52:2030#include <errno.h>
[email protected]166326c62010-08-05 15:50:2331#include <pthread.h>
[email protected]f6abeba2008-08-08 13:27:2832#include <stdio.h>
[email protected]eb62f7262013-03-30 14:29:0033#include <stdlib.h>
[email protected]f6abeba2008-08-08 13:27:2834#include <string.h>
35#include <unistd.h>
36#define MAX_PATH PATH_MAX
37typedef FILE* FileHandle;
38typedef pthread_mutex_t* MutexHandle;
39#endif
40
[email protected]1f88b5162011-04-01 00:02:2941#include <algorithm>
42#include <cstring>
initial.commitd7cae122008-07-26 21:49:3843#include <ctime>
44#include <iomanip>
[email protected]1f88b5162011-04-01 00:02:2945#include <ostream>
[email protected]c914d8a2014-04-23 01:11:0146#include <string>
[email protected]b16ef312008-08-19 18:36:2347
initial.commitd7cae122008-07-26 21:49:3848#include "base/base_switches.h"
49#include "base/command_line.h"
[email protected]eb4c4d032012-04-03 18:45:0550#include "base/debug/alias.h"
[email protected]58580352010-10-26 04:07:5051#include "base/debug/debugger.h"
52#include "base/debug/stack_trace.h"
[email protected]2025d002012-11-14 20:54:3553#include "base/posix/eintr_wrapper.h"
[email protected]eb62f7262013-03-30 14:29:0054#include "base/strings/string_piece.h"
[email protected]c914d8a2014-04-23 01:11:0155#include "base/strings/string_util.h"
56#include "base/strings/stringprintf.h"
[email protected]a4ea1f12013-06-07 18:37:0757#include "base/strings/utf_string_conversions.h"
[email protected]bc581a682011-01-01 23:16:2058#include "base/synchronization/lock_impl.h"
[email protected]63e66802012-01-18 21:21:0959#include "base/threading/platform_thread.h"
[email protected]99b7c57f2010-09-29 19:26:3660#include "base/vlog.h"
[email protected]53c7ce42010-12-14 16:20:0461#if defined(OS_POSIX)
62#include "base/safe_strerror_posix.h"
63#endif
[email protected]52a261f2009-03-03 15:01:1264
[email protected]3132e35c2011-07-07 20:46:5065#if defined(OS_ANDROID)
66#include <android/log.h>
67#endif
68
initial.commitd7cae122008-07-26 21:49:3869namespace logging {
70
[email protected]064aa162011-12-03 00:30:0871namespace {
72
[email protected]99b7c57f2010-09-29 19:26:3673VlogInfo* g_vlog_info = NULL;
[email protected]064aa162011-12-03 00:30:0874VlogInfo* g_vlog_info_prev = NULL;
initial.commitd7cae122008-07-26 21:49:3875
76const char* const log_severity_names[LOG_NUM_SEVERITIES] = {
[email protected]fb62a532009-02-12 01:19:0577 "INFO", "WARNING", "ERROR", "ERROR_REPORT", "FATAL" };
initial.commitd7cae122008-07-26 21:49:3878
[email protected]80f360a2014-01-23 01:36:1979const char* log_severity_name(int severity)
80{
81 if (severity >= 0 && severity < LOG_NUM_SEVERITIES)
82 return log_severity_names[severity];
83 return "UNKNOWN";
84}
85
initial.commitd7cae122008-07-26 21:49:3886int min_log_level = 0;
[email protected]1d8c2702008-08-19 23:39:3287
[email protected]5e3f7c22013-06-21 21:15:3388LoggingDestination logging_destination = LOG_DEFAULT;
initial.commitd7cae122008-07-26 21:49:3889
[email protected]a33c9892008-08-25 20:10:3190// For LOG_ERROR and above, always print to stderr.
91const int kAlwaysPrintErrorLevel = LOG_ERROR;
92
[email protected]614e9fa2008-08-11 22:52:5993// Which log file to use? This is initialized by InitLogging or
initial.commitd7cae122008-07-26 21:49:3894// will be lazily initialized to the default value when it is
95// first needed.
[email protected]f6abeba2008-08-08 13:27:2896#if defined(OS_WIN)
[email protected]614e9fa2008-08-11 22:52:5997typedef std::wstring PathString;
[email protected]f6abeba2008-08-08 13:27:2898#else
[email protected]614e9fa2008-08-11 22:52:5999typedef std::string PathString;
[email protected]f6abeba2008-08-08 13:27:28100#endif
[email protected]614e9fa2008-08-11 22:52:59101PathString* log_file_name = NULL;
initial.commitd7cae122008-07-26 21:49:38102
103// this file is lazily opened and the handle may be NULL
[email protected]f6abeba2008-08-08 13:27:28104FileHandle log_file = NULL;
initial.commitd7cae122008-07-26 21:49:38105
106// what should be prepended to each message?
107bool log_process_id = false;
108bool log_thread_id = false;
109bool log_timestamp = true;
110bool log_tickcount = false;
111
[email protected]81e0a852010-08-17 00:38:12112// Should we pop up fatal debug messages in a dialog?
113bool show_error_dialogs = false;
114
initial.commitd7cae122008-07-26 21:49:38115// An assert handler override specified by the client to be called instead of
[email protected]fb62a532009-02-12 01:19:05116// the debug message dialog and process termination.
initial.commitd7cae122008-07-26 21:49:38117LogAssertHandlerFunction log_assert_handler = NULL;
[email protected]fb62a532009-02-12 01:19:05118// An report handler override specified by the client to be called instead of
119// the debug message dialog.
120LogReportHandlerFunction log_report_handler = NULL;
[email protected]2b07b8412009-11-25 15:26:34121// A log message handler that gets notified of every log message we process.
122LogMessageHandlerFunction log_message_handler = NULL;
initial.commitd7cae122008-07-26 21:49:38123
[email protected]f6abeba2008-08-08 13:27:28124// Helper functions to wrap platform differences.
125
[email protected]f8588472008-11-05 23:17:24126int32 CurrentProcessId() {
127#if defined(OS_WIN)
128 return GetCurrentProcessId();
129#elif defined(OS_POSIX)
130 return getpid();
131#endif
132}
133
[email protected]f8588472008-11-05 23:17:24134uint64 TickCount() {
135#if defined(OS_WIN)
136 return GetTickCount();
137#elif defined(OS_MACOSX)
138 return mach_absolute_time();
[email protected]19ea84ca2010-11-12 08:37:08139#elif defined(OS_NACL)
140 // NaCl sadly does not have _POSIX_TIMERS enabled in sys/features.h
141 // So we have to use clock() for now.
142 return clock();
[email protected]e43eddf12009-12-29 00:32:52143#elif defined(OS_POSIX)
[email protected]052f1b52008-11-06 21:43:07144 struct timespec ts;
145 clock_gettime(CLOCK_MONOTONIC, &ts);
146
147 uint64 absolute_micro =
148 static_cast<int64>(ts.tv_sec) * 1000000 +
149 static_cast<int64>(ts.tv_nsec) / 1000;
150
151 return absolute_micro;
[email protected]f8588472008-11-05 23:17:24152#endif
153}
154
[email protected]614e9fa2008-08-11 22:52:59155void DeleteFilePath(const PathString& log_name) {
[email protected]f6abeba2008-08-08 13:27:28156#if defined(OS_WIN)
[email protected]614e9fa2008-08-11 22:52:59157 DeleteFile(log_name.c_str());
[email protected]ac07ec52013-04-22 17:32:45158#elif defined (OS_NACL)
159 // Do nothing; unlink() isn't supported on NaCl.
[email protected]f6abeba2008-08-08 13:27:28160#else
[email protected]614e9fa2008-08-11 22:52:59161 unlink(log_name.c_str());
[email protected]f6abeba2008-08-08 13:27:28162#endif
163}
initial.commitd7cae122008-07-26 21:49:38164
[email protected]5f95d532010-10-01 17:16:58165PathString GetDefaultLogFile() {
[email protected]5b84fe32010-09-14 22:24:55166#if defined(OS_WIN)
167 // On Windows we use the same path as the exe.
168 wchar_t module_name[MAX_PATH];
169 GetModuleFileName(NULL, module_name, MAX_PATH);
[email protected]5f95d532010-10-01 17:16:58170
171 PathString log_file = module_name;
172 PathString::size_type last_backslash =
173 log_file.rfind('\\', log_file.size());
174 if (last_backslash != PathString::npos)
175 log_file.erase(last_backslash + 1);
176 log_file += L"debug.log";
177 return log_file;
[email protected]5b84fe32010-09-14 22:24:55178#elif defined(OS_POSIX)
179 // On other platforms we just use the current directory.
[email protected]5f95d532010-10-01 17:16:58180 return PathString("debug.log");
[email protected]5b84fe32010-09-14 22:24:55181#endif
182}
183
184// This class acts as a wrapper for locking the logging files.
185// LoggingLock::Init() should be called from the main thread before any logging
186// is done. Then whenever logging, be sure to have a local LoggingLock
187// instance on the stack. This will ensure that the lock is unlocked upon
188// exiting the frame.
189// LoggingLocks can not be nested.
190class LoggingLock {
191 public:
192 LoggingLock() {
193 LockLogging();
194 }
195
196 ~LoggingLock() {
197 UnlockLogging();
198 }
199
200 static void Init(LogLockingState lock_log, const PathChar* new_log_file) {
201 if (initialized)
202 return;
203 lock_log_file = lock_log;
204 if (lock_log_file == LOCK_LOG_FILE) {
205#if defined(OS_WIN)
206 if (!log_mutex) {
207 std::wstring safe_name;
208 if (new_log_file)
209 safe_name = new_log_file;
210 else
[email protected]5f95d532010-10-01 17:16:58211 safe_name = GetDefaultLogFile();
[email protected]5b84fe32010-09-14 22:24:55212 // \ is not a legal character in mutex names so we replace \ with /
213 std::replace(safe_name.begin(), safe_name.end(), '\\', '/');
214 std::wstring t(L"Global\\");
215 t.append(safe_name);
216 log_mutex = ::CreateMutex(NULL, FALSE, t.c_str());
[email protected]5f95d532010-10-01 17:16:58217
218 if (log_mutex == NULL) {
219#if DEBUG
220 // Keep the error code for debugging
221 int error = GetLastError(); // NOLINT
[email protected]58580352010-10-26 04:07:50222 base::debug::BreakDebugger();
[email protected]5f95d532010-10-01 17:16:58223#endif
224 // Return nicely without putting initialized to true.
225 return;
226 }
[email protected]5b84fe32010-09-14 22:24:55227 }
228#endif
229 } else {
[email protected]bc581a682011-01-01 23:16:20230 log_lock = new base::internal::LockImpl();
[email protected]5b84fe32010-09-14 22:24:55231 }
232 initialized = true;
233 }
234
235 private:
236 static void LockLogging() {
237 if (lock_log_file == LOCK_LOG_FILE) {
238#if defined(OS_WIN)
239 ::WaitForSingleObject(log_mutex, INFINITE);
240 // WaitForSingleObject could have returned WAIT_ABANDONED. We don't
241 // abort the process here. UI tests might be crashy sometimes,
242 // and aborting the test binary only makes the problem worse.
243 // We also don't use LOG macros because that might lead to an infinite
244 // loop. For more info see http://crbug.com/18028.
245#elif defined(OS_POSIX)
246 pthread_mutex_lock(&log_mutex);
247#endif
248 } else {
249 // use the lock
250 log_lock->Lock();
251 }
252 }
253
254 static void UnlockLogging() {
255 if (lock_log_file == LOCK_LOG_FILE) {
256#if defined(OS_WIN)
257 ReleaseMutex(log_mutex);
258#elif defined(OS_POSIX)
259 pthread_mutex_unlock(&log_mutex);
260#endif
261 } else {
262 log_lock->Unlock();
263 }
264 }
265
266 // The lock is used if log file locking is false. It helps us avoid problems
267 // with multiple threads writing to the log file at the same time. Use
268 // LockImpl directly instead of using Lock, because Lock makes logging calls.
[email protected]bc581a682011-01-01 23:16:20269 static base::internal::LockImpl* log_lock;
[email protected]5b84fe32010-09-14 22:24:55270
271 // When we don't use a lock, we are using a global mutex. We need to do this
272 // because LockFileEx is not thread safe.
273#if defined(OS_WIN)
274 static MutexHandle log_mutex;
275#elif defined(OS_POSIX)
276 static pthread_mutex_t log_mutex;
277#endif
278
279 static bool initialized;
280 static LogLockingState lock_log_file;
281};
282
283// static
284bool LoggingLock::initialized = false;
285// static
[email protected]bc581a682011-01-01 23:16:20286base::internal::LockImpl* LoggingLock::log_lock = NULL;
[email protected]5b84fe32010-09-14 22:24:55287// static
288LogLockingState LoggingLock::lock_log_file = LOCK_LOG_FILE;
289
290#if defined(OS_WIN)
291// static
292MutexHandle LoggingLock::log_mutex = NULL;
293#elif defined(OS_POSIX)
294pthread_mutex_t LoggingLock::log_mutex = PTHREAD_MUTEX_INITIALIZER;
295#endif
296
initial.commitd7cae122008-07-26 21:49:38297// Called by logging functions to ensure that debug_file is initialized
298// and can be used for writing. Returns false if the file could not be
299// initialized. debug_file will be NULL in this case.
300bool InitializeLogFileHandle() {
301 if (log_file)
302 return true;
303
[email protected]614e9fa2008-08-11 22:52:59304 if (!log_file_name) {
305 // Nobody has called InitLogging to specify a debug log file, so here we
306 // initialize the log file name to a default.
[email protected]5f95d532010-10-01 17:16:58307 log_file_name = new PathString(GetDefaultLogFile());
initial.commitd7cae122008-07-26 21:49:38308 }
309
[email protected]5e3f7c22013-06-21 21:15:33310 if ((logging_destination & LOG_TO_FILE) != 0) {
[email protected]614e9fa2008-08-11 22:52:59311#if defined(OS_WIN)
[email protected]1d8c2702008-08-19 23:39:32312 log_file = CreateFile(log_file_name->c_str(), GENERIC_WRITE,
initial.commitd7cae122008-07-26 21:49:38313 FILE_SHARE_READ | FILE_SHARE_WRITE, NULL,
314 OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
315 if (log_file == INVALID_HANDLE_VALUE || log_file == NULL) {
[email protected]1d8c2702008-08-19 23:39:32316 // try the current directory
317 log_file = CreateFile(L".\\debug.log", GENERIC_WRITE,
318 FILE_SHARE_READ | FILE_SHARE_WRITE, NULL,
319 OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
320 if (log_file == INVALID_HANDLE_VALUE || log_file == NULL) {
321 log_file = NULL;
322 return false;
323 }
initial.commitd7cae122008-07-26 21:49:38324 }
[email protected]1d8c2702008-08-19 23:39:32325 SetFilePointer(log_file, 0, 0, FILE_END);
[email protected]78c6dd62009-06-08 23:29:11326#elif defined(OS_POSIX)
327 log_file = fopen(log_file_name->c_str(), "a");
328 if (log_file == NULL)
329 return false;
[email protected]f6abeba2008-08-08 13:27:28330#endif
[email protected]1d8c2702008-08-19 23:39:32331 }
332
initial.commitd7cae122008-07-26 21:49:38333 return true;
334}
335
[email protected]17dcf752013-07-15 21:47:09336void CloseFile(FileHandle log) {
337#if defined(OS_WIN)
338 CloseHandle(log);
339#else
340 fclose(log);
341#endif
342}
343
344void CloseLogFileUnlocked() {
345 if (!log_file)
346 return;
347
348 CloseFile(log_file);
349 log_file = NULL;
350}
351
[email protected]064aa162011-12-03 00:30:08352} // namespace
353
[email protected]5e3f7c22013-06-21 21:15:33354LoggingSettings::LoggingSettings()
355 : logging_dest(LOG_DEFAULT),
356 log_file(NULL),
357 lock_log(LOCK_LOG_FILE),
[email protected]1a1505512014-03-10 18:23:38358 delete_old(APPEND_TO_OLD_LOG_FILE) {}
[email protected]064aa162011-12-03 00:30:08359
[email protected]5e3f7c22013-06-21 21:15:33360bool BaseInitLoggingImpl(const LoggingSettings& settings) {
[email protected]ac07ec52013-04-22 17:32:45361#if defined(OS_NACL)
[email protected]5e3f7c22013-06-21 21:15:33362 // Can log only to the system debug log.
363 CHECK_EQ(settings.logging_dest & ~LOG_TO_SYSTEM_DEBUG_LOG, 0);
[email protected]ac07ec52013-04-22 17:32:45364#endif
[email protected]380d8322012-02-28 21:35:44365 CommandLine* command_line = CommandLine::ForCurrentProcess();
[email protected]99b7c57f2010-09-29 19:26:36366 // Don't bother initializing g_vlog_info unless we use one of the
367 // vlog switches.
368 if (command_line->HasSwitch(switches::kV) ||
369 command_line->HasSwitch(switches::kVModule)) {
[email protected]064aa162011-12-03 00:30:08370 // NOTE: If g_vlog_info has already been initialized, it might be in use
371 // by another thread. Don't delete the old VLogInfo, just create a second
372 // one. We keep track of both to avoid memory leak warnings.
373 CHECK(!g_vlog_info_prev);
374 g_vlog_info_prev = g_vlog_info;
375
[email protected]99b7c57f2010-09-29 19:26:36376 g_vlog_info =
377 new VlogInfo(command_line->GetSwitchValueASCII(switches::kV),
[email protected]162ac0f2010-11-04 15:50:49378 command_line->GetSwitchValueASCII(switches::kVModule),
379 &min_log_level);
[email protected]99b7c57f2010-09-29 19:26:36380 }
381
[email protected]5e3f7c22013-06-21 21:15:33382 logging_destination = settings.logging_dest;
initial.commitd7cae122008-07-26 21:49:38383
[email protected]5e3f7c22013-06-21 21:15:33384 // ignore file options unless logging to file is set.
385 if ((logging_destination & LOG_TO_FILE) == 0)
[email protected]c7d5da992010-10-28 00:20:21386 return true;
initial.commitd7cae122008-07-26 21:49:38387
[email protected]17dcf752013-07-15 21:47:09388 LoggingLock::Init(settings.lock_log, settings.log_file);
389 LoggingLock logging_lock;
390
391 // Calling InitLogging twice or after some log call has already opened the
392 // default log file will re-initialize to the new options.
393 CloseLogFileUnlocked();
394
[email protected]614e9fa2008-08-11 22:52:59395 if (!log_file_name)
396 log_file_name = new PathString();
[email protected]5e3f7c22013-06-21 21:15:33397 *log_file_name = settings.log_file;
398 if (settings.delete_old == DELETE_OLD_LOG_FILE)
[email protected]614e9fa2008-08-11 22:52:59399 DeleteFilePath(*log_file_name);
initial.commitd7cae122008-07-26 21:49:38400
[email protected]c7d5da992010-10-28 00:20:21401 return InitializeLogFileHandle();
initial.commitd7cae122008-07-26 21:49:38402}
403
404void SetMinLogLevel(int level) {
[email protected]deba0ff2010-11-03 05:30:14405 min_log_level = std::min(LOG_ERROR_REPORT, level);
initial.commitd7cae122008-07-26 21:49:38406}
407
408int GetMinLogLevel() {
409 return min_log_level;
410}
411
[email protected]162ac0f2010-11-04 15:50:49412int GetVlogVerbosity() {
413 return std::max(-1, LOG_INFO - GetMinLogLevel());
414}
415
[email protected]99b7c57f2010-09-29 19:26:36416int GetVlogLevelHelper(const char* file, size_t N) {
417 DCHECK_GT(N, 0U);
[email protected]064aa162011-12-03 00:30:08418 // Note: g_vlog_info may change on a different thread during startup
419 // (but will always be valid or NULL).
420 VlogInfo* vlog_info = g_vlog_info;
421 return vlog_info ?
422 vlog_info->GetVlogLevel(base::StringPiece(file, N - 1)) :
[email protected]162ac0f2010-11-04 15:50:49423 GetVlogVerbosity();
[email protected]99b7c57f2010-09-29 19:26:36424}
425
initial.commitd7cae122008-07-26 21:49:38426void SetLogItems(bool enable_process_id, bool enable_thread_id,
427 bool enable_timestamp, bool enable_tickcount) {
428 log_process_id = enable_process_id;
429 log_thread_id = enable_thread_id;
430 log_timestamp = enable_timestamp;
431 log_tickcount = enable_tickcount;
432}
433
[email protected]81e0a852010-08-17 00:38:12434void SetShowErrorDialogs(bool enable_dialogs) {
435 show_error_dialogs = enable_dialogs;
436}
437
initial.commitd7cae122008-07-26 21:49:38438void SetLogAssertHandler(LogAssertHandlerFunction handler) {
439 log_assert_handler = handler;
440}
441
[email protected]fb62a532009-02-12 01:19:05442void SetLogReportHandler(LogReportHandlerFunction handler) {
443 log_report_handler = handler;
444}
445
[email protected]2b07b8412009-11-25 15:26:34446void SetLogMessageHandler(LogMessageHandlerFunction handler) {
447 log_message_handler = handler;
448}
449
[email protected]64e5cc02010-11-03 19:20:27450LogMessageHandlerFunction GetLogMessageHandler() {
451 return log_message_handler;
452}
453
[email protected]6d445d32010-09-30 19:10:03454// MSVC doesn't like complex extern templates and DLLs.
455#if !defined(COMPILER_MSVC)
456// Explicit instantiations for commonly used comparisons.
457template std::string* MakeCheckOpString<int, int>(
458 const int&, const int&, const char* names);
459template std::string* MakeCheckOpString<unsigned long, unsigned long>(
460 const unsigned long&, const unsigned long&, const char* names);
461template std::string* MakeCheckOpString<unsigned long, unsigned int>(
462 const unsigned long&, const unsigned int&, const char* names);
463template std::string* MakeCheckOpString<unsigned int, unsigned long>(
464 const unsigned int&, const unsigned long&, const char* names);
465template std::string* MakeCheckOpString<std::string, std::string>(
466 const std::string&, const std::string&, const char* name);
467#endif
[email protected]2b07b8412009-11-25 15:26:34468
[email protected]d81baca42010-03-01 13:10:22469// Displays a message box to the user with the error message in it.
470// Used for fatal messages, where we close the app simultaneously.
[email protected]561513f2010-12-16 23:29:25471// This is for developers only; we don't use this in circumstances
472// (like release builds) where users could see it, since users don't
473// understand these messages anyway.
[email protected]d81baca42010-03-01 13:10:22474void DisplayDebugMessageInDialog(const std::string& str) {
initial.commitd7cae122008-07-26 21:49:38475 if (str.empty())
476 return;
477
[email protected]81e0a852010-08-17 00:38:12478 if (!show_error_dialogs)
[email protected]846ed9c32010-07-29 20:33:44479 return;
480
[email protected]f6abeba2008-08-08 13:27:28481#if defined(OS_WIN)
[email protected]d81baca42010-03-01 13:10:22482 // For Windows programs, it's possible that the message loop is
483 // messed up on a fatal error, and creating a MessageBox will cause
484 // that message loop to be run. Instead, we try to spawn another
485 // process that displays its command line. We look for "Debug
486 // Message.exe" in the same directory as the application. If it
487 // exists, we use it, otherwise, we use a regular message box.
initial.commitd7cae122008-07-26 21:49:38488 wchar_t prog_name[MAX_PATH];
489 GetModuleFileNameW(NULL, prog_name, MAX_PATH);
490 wchar_t* backslash = wcsrchr(prog_name, '\\');
491 if (backslash)
492 backslash[1] = 0;
493 wcscat_s(prog_name, MAX_PATH, L"debug_message.exe");
494
[email protected]f729d7a2013-12-26 07:07:56495 std::wstring cmdline = base::UTF8ToWide(str);
[email protected]3ca4214c12009-03-25 22:12:02496 if (cmdline.empty())
497 return;
initial.commitd7cae122008-07-26 21:49:38498
499 STARTUPINFO startup_info;
500 memset(&startup_info, 0, sizeof(startup_info));
501 startup_info.cb = sizeof(startup_info);
502
503 PROCESS_INFORMATION process_info;
[email protected]3ca4214c12009-03-25 22:12:02504 if (CreateProcessW(prog_name, &cmdline[0], NULL, NULL, false, 0, NULL,
initial.commitd7cae122008-07-26 21:49:38505 NULL, &startup_info, &process_info)) {
506 WaitForSingleObject(process_info.hProcess, INFINITE);
507 CloseHandle(process_info.hThread);
508 CloseHandle(process_info.hProcess);
509 } else {
510 // debug process broken, let's just do a message box
[email protected]3ca4214c12009-03-25 22:12:02511 MessageBoxW(NULL, &cmdline[0], L"Fatal error",
initial.commitd7cae122008-07-26 21:49:38512 MB_OK | MB_ICONHAND | MB_TOPMOST);
513 }
[email protected]f6abeba2008-08-08 13:27:28514#else
[email protected]561513f2010-12-16 23:29:25515 // We intentionally don't implement a dialog on other platforms.
516 // You can just look at stderr.
[email protected]f6abeba2008-08-08 13:27:28517#endif
initial.commitd7cae122008-07-26 21:49:38518}
519
[email protected]3f85caa2009-04-14 16:52:11520#if defined(OS_WIN)
521LogMessage::SaveLastError::SaveLastError() : last_error_(::GetLastError()) {
522}
523
524LogMessage::SaveLastError::~SaveLastError() {
525 ::SetLastError(last_error_);
526}
527#endif // defined(OS_WIN)
528
initial.commitd7cae122008-07-26 21:49:38529LogMessage::LogMessage(const char* file, int line, LogSeverity severity,
530 int ctr)
[email protected]162ac0f2010-11-04 15:50:49531 : severity_(severity), file_(file), line_(line) {
initial.commitd7cae122008-07-26 21:49:38532 Init(file, line);
533}
534
[email protected]eae9c062011-01-11 00:50:59535LogMessage::LogMessage(const char* file, int line)
536 : severity_(LOG_INFO), file_(file), line_(line) {
537 Init(file, line);
538}
539
540LogMessage::LogMessage(const char* file, int line, LogSeverity severity)
541 : severity_(severity), file_(file), line_(line) {
542 Init(file, line);
543}
544
[email protected]9c7132e2011-02-08 07:39:08545LogMessage::LogMessage(const char* file, int line, std::string* result)
[email protected]162ac0f2010-11-04 15:50:49546 : severity_(LOG_FATAL), file_(file), line_(line) {
initial.commitd7cae122008-07-26 21:49:38547 Init(file, line);
[email protected]9c7132e2011-02-08 07:39:08548 stream_ << "Check failed: " << *result;
549 delete result;
initial.commitd7cae122008-07-26 21:49:38550}
551
[email protected]fb62a532009-02-12 01:19:05552LogMessage::LogMessage(const char* file, int line, LogSeverity severity,
[email protected]9c7132e2011-02-08 07:39:08553 std::string* result)
[email protected]162ac0f2010-11-04 15:50:49554 : severity_(severity), file_(file), line_(line) {
[email protected]fb62a532009-02-12 01:19:05555 Init(file, line);
[email protected]9c7132e2011-02-08 07:39:08556 stream_ << "Check failed: " << *result;
557 delete result;
[email protected]fb62a532009-02-12 01:19:05558}
559
initial.commitd7cae122008-07-26 21:49:38560LogMessage::~LogMessage() {
[email protected]145c7052014-04-18 23:40:16561#if !defined(NDEBUG) && !defined(OS_NACL) && !defined(__UCLIBC__)
[email protected]d1ccc35a2010-03-24 05:03:24562 if (severity_ == LOG_FATAL) {
563 // Include a stack trace on a fatal.
[email protected]58580352010-10-26 04:07:50564 base::debug::StackTrace trace;
[email protected]d1ccc35a2010-03-24 05:03:24565 stream_ << std::endl; // Newline to separate from log message.
566 trace.OutputToStream(&stream_);
567 }
[email protected]1d8c2702008-08-19 23:39:32568#endif
[email protected]d1ccc35a2010-03-24 05:03:24569 stream_ << std::endl;
570 std::string str_newline(stream_.str());
571
[email protected]2b07b8412009-11-25 15:26:34572 // Give any log message handler first dibs on the message.
[email protected]5e3f7c22013-06-21 21:15:33573 if (log_message_handler &&
574 log_message_handler(severity_, file_, line_,
575 message_start_, str_newline)) {
[email protected]162ac0f2010-11-04 15:50:49576 // The handler took care of it, no further processing.
[email protected]2b07b8412009-11-25 15:26:34577 return;
[email protected]162ac0f2010-11-04 15:50:49578 }
initial.commitd7cae122008-07-26 21:49:38579
[email protected]5e3f7c22013-06-21 21:15:33580 if ((logging_destination & LOG_TO_SYSTEM_DEBUG_LOG) != 0) {
[email protected]f6abeba2008-08-08 13:27:28581#if defined(OS_WIN)
initial.commitd7cae122008-07-26 21:49:38582 OutputDebugStringA(str_newline.c_str());
[email protected]3132e35c2011-07-07 20:46:50583#elif defined(OS_ANDROID)
[email protected]efbae7da2013-05-21 22:39:25584 android_LogPriority priority =
585 (severity_ < 0) ? ANDROID_LOG_VERBOSE : ANDROID_LOG_UNKNOWN;
[email protected]3132e35c2011-07-07 20:46:50586 switch (severity_) {
587 case LOG_INFO:
588 priority = ANDROID_LOG_INFO;
589 break;
590 case LOG_WARNING:
591 priority = ANDROID_LOG_WARN;
592 break;
593 case LOG_ERROR:
594 case LOG_ERROR_REPORT:
595 priority = ANDROID_LOG_ERROR;
596 break;
597 case LOG_FATAL:
598 priority = ANDROID_LOG_FATAL;
599 break;
600 }
601 __android_log_write(priority, "chromium", str_newline.c_str());
[email protected]107bc0f12008-08-26 17:48:18602#endif
[email protected]51105382014-03-14 17:02:15603 ignore_result(fwrite(str_newline.data(), str_newline.size(), 1, stderr));
[email protected]469006c2010-09-24 15:43:06604 fflush(stderr);
[email protected]a33c9892008-08-25 20:10:31605 } else if (severity_ >= kAlwaysPrintErrorLevel) {
606 // When we're only outputting to a log file, above a certain log level, we
607 // should still output to stderr so that we can better detect and diagnose
608 // problems with unit tests, especially on the buildbots.
[email protected]51105382014-03-14 17:02:15609 ignore_result(fwrite(str_newline.data(), str_newline.size(), 1, stderr));
[email protected]1ce41052009-12-02 00:34:02610 fflush(stderr);
[email protected]f6abeba2008-08-08 13:27:28611 }
[email protected]52a261f2009-03-03 15:01:12612
initial.commitd7cae122008-07-26 21:49:38613 // write to log file
[email protected]5e3f7c22013-06-21 21:15:33614 if ((logging_destination & LOG_TO_FILE) != 0) {
[email protected]17dcf752013-07-15 21:47:09615 // We can have multiple threads and/or processes, so try to prevent them
616 // from clobbering each other's writes.
617 // If the client app did not call InitLogging, and the lock has not
618 // been created do it now. We do this on demand, but if two threads try
619 // to do this at the same time, there will be a race condition to create
620 // the lock. This is why InitLogging should be called from the main
621 // thread at the beginning of execution.
622 LoggingLock::Init(LOCK_LOG_FILE, NULL);
[email protected]5b84fe32010-09-14 22:24:55623 LoggingLock logging_lock;
624 if (InitializeLogFileHandle()) {
[email protected]f6abeba2008-08-08 13:27:28625#if defined(OS_WIN)
[email protected]5b84fe32010-09-14 22:24:55626 SetFilePointer(log_file, 0, 0, SEEK_END);
627 DWORD num_written;
628 WriteFile(log_file,
629 static_cast<const void*>(str_newline.c_str()),
630 static_cast<DWORD>(str_newline.length()),
631 &num_written,
632 NULL);
[email protected]cba21962010-08-31 22:35:55633#else
[email protected]51105382014-03-14 17:02:15634 ignore_result(fwrite(
635 str_newline.data(), str_newline.size(), 1, log_file));
[email protected]5b84fe32010-09-14 22:24:55636 fflush(log_file);
[email protected]cba21962010-08-31 22:35:55637#endif
initial.commitd7cae122008-07-26 21:49:38638 }
639 }
640
641 if (severity_ == LOG_FATAL) {
[email protected]eb4c4d032012-04-03 18:45:05642 // Ensure the first characters of the string are on the stack so they
643 // are contained in minidumps for diagnostic purposes.
644 char str_stack[1024];
645 str_newline.copy(str_stack, arraysize(str_stack));
646 base::debug::Alias(str_stack);
647
[email protected]82d89ab2014-02-28 18:25:34648 if (log_assert_handler) {
649 // Make a copy of the string for the handler out of paranoia.
650 log_assert_handler(std::string(stream_.str()));
[email protected]1ffe08c12008-08-13 11:15:11651 } else {
[email protected]82d89ab2014-02-28 18:25:34652 // Don't use the string with the newline, get a fresh version to send to
653 // the debug message process. We also don't display assertions to the
654 // user in release mode. The enduser can't do anything with this
655 // information, and displaying message boxes when the application is
656 // hosed can cause additional problems.
[email protected]4d5901272008-11-06 00:33:50657#ifndef NDEBUG
[email protected]82d89ab2014-02-28 18:25:34658 DisplayDebugMessageInDialog(stream_.str());
[email protected]4d5901272008-11-06 00:33:50659#endif
[email protected]82d89ab2014-02-28 18:25:34660 // Crash the process to generate a dump.
661 base::debug::BreakDebugger();
initial.commitd7cae122008-07-26 21:49:38662 }
[email protected]fb62a532009-02-12 01:19:05663 } else if (severity_ == LOG_ERROR_REPORT) {
664 // We are here only if the user runs with --enable-dcheck in release mode.
665 if (log_report_handler) {
666 log_report_handler(std::string(stream_.str()));
667 } else {
[email protected]d81baca42010-03-01 13:10:22668 DisplayDebugMessageInDialog(stream_.str());
[email protected]fb62a532009-02-12 01:19:05669 }
initial.commitd7cae122008-07-26 21:49:38670 }
671}
672
[email protected]eae9c062011-01-11 00:50:59673// writes the common header info to the stream
674void LogMessage::Init(const char* file, int line) {
675 base::StringPiece filename(file);
676 size_t last_slash_pos = filename.find_last_of("\\/");
677 if (last_slash_pos != base::StringPiece::npos)
678 filename.remove_prefix(last_slash_pos + 1);
679
680 // TODO(darin): It might be nice if the columns were fixed width.
681
682 stream_ << '[';
683 if (log_process_id)
684 stream_ << CurrentProcessId() << ':';
685 if (log_thread_id)
[email protected]63e66802012-01-18 21:21:09686 stream_ << base::PlatformThread::CurrentId() << ':';
[email protected]eae9c062011-01-11 00:50:59687 if (log_timestamp) {
688 time_t t = time(NULL);
689 struct tm local_time = {0};
690#if _MSC_VER >= 1400
691 localtime_s(&local_time, &t);
692#else
693 localtime_r(&t, &local_time);
694#endif
695 struct tm* tm_time = &local_time;
696 stream_ << std::setfill('0')
697 << std::setw(2) << 1 + tm_time->tm_mon
698 << std::setw(2) << tm_time->tm_mday
699 << '/'
700 << std::setw(2) << tm_time->tm_hour
701 << std::setw(2) << tm_time->tm_min
702 << std::setw(2) << tm_time->tm_sec
703 << ':';
704 }
705 if (log_tickcount)
706 stream_ << TickCount() << ':';
707 if (severity_ >= 0)
[email protected]80f360a2014-01-23 01:36:19708 stream_ << log_severity_name(severity_);
[email protected]eae9c062011-01-11 00:50:59709 else
710 stream_ << "VERBOSE" << -severity_;
711
712 stream_ << ":" << filename << "(" << line << ")] ";
713
714 message_start_ = stream_.tellp();
715}
716
[email protected]d8617a62009-10-09 23:52:20717#if defined(OS_WIN)
718// This has already been defined in the header, but defining it again as DWORD
719// ensures that the type used in the header is equivalent to DWORD. If not,
720// the redefinition is a compile error.
721typedef DWORD SystemErrorCode;
722#endif
723
724SystemErrorCode GetLastSystemErrorCode() {
725#if defined(OS_WIN)
726 return ::GetLastError();
727#elif defined(OS_POSIX)
728 return errno;
729#else
730#error Not implemented
731#endif
732}
733
734#if defined(OS_WIN)
[email protected]c914d8a2014-04-23 01:11:01735BASE_EXPORT std::string SystemErrorCodeToString(SystemErrorCode error_code) {
736 const int error_message_buffer_size = 256;
737 char msgbuf[error_message_buffer_size];
738 DWORD flags = FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS;
739 DWORD len = FormatMessageA(flags, NULL, error_code, 0, msgbuf,
740 arraysize(msgbuf), NULL);
741 if (len) {
742 // Messages returned by system end with line breaks.
743 return base::CollapseWhitespaceASCII(msgbuf, true) +
744 base::StringPrintf(" (0x%X)", error_code);
745 }
746 return base::StringPrintf("Error (0x%X) while retrieving error. (0x%X)",
747 GetLastError(), error_code);
[email protected]d8617a62009-10-09 23:52:20748}
[email protected]c914d8a2014-04-23 01:11:01749#elif defined(OS_POSIX)
750BASE_EXPORT std::string SystemErrorCodeToString(SystemErrorCode error_code) {
751 return safe_strerror(error_code);
752}
753#else
754#error Not implemented
755#endif
[email protected]d8617a62009-10-09 23:52:20756
[email protected]c914d8a2014-04-23 01:11:01757
758#if defined(OS_WIN)
[email protected]d8617a62009-10-09 23:52:20759Win32ErrorLogMessage::Win32ErrorLogMessage(const char* file,
760 int line,
761 LogSeverity severity,
762 SystemErrorCode err)
763 : err_(err),
[email protected]d8617a62009-10-09 23:52:20764 log_message_(file, line, severity) {
765}
766
767Win32ErrorLogMessage::~Win32ErrorLogMessage() {
[email protected]c914d8a2014-04-23 01:11:01768 stream() << ": " << SystemErrorCodeToString(err_);
[email protected]20909e72012-04-05 16:57:06769 // We're about to crash (CHECK). Put |err_| on the stack (by placing it in a
770 // field) and use Alias in hopes that it makes it into crash dumps.
771 DWORD last_error = err_;
772 base::debug::Alias(&last_error);
[email protected]d8617a62009-10-09 23:52:20773}
774#elif defined(OS_POSIX)
775ErrnoLogMessage::ErrnoLogMessage(const char* file,
776 int line,
777 LogSeverity severity,
778 SystemErrorCode err)
779 : err_(err),
780 log_message_(file, line, severity) {
781}
782
783ErrnoLogMessage::~ErrnoLogMessage() {
[email protected]c914d8a2014-04-23 01:11:01784 stream() << ": " << SystemErrorCodeToString(err_);
[email protected]d8617a62009-10-09 23:52:20785}
786#endif // OS_WIN
787
initial.commitd7cae122008-07-26 21:49:38788void CloseLogFile() {
[email protected]5b84fe32010-09-14 22:24:55789 LoggingLock logging_lock;
[email protected]17dcf752013-07-15 21:47:09790 CloseLogFileUnlocked();
initial.commitd7cae122008-07-26 21:49:38791}
792
[email protected]e36ddc82009-12-08 04:22:50793void RawLog(int level, const char* message) {
794 if (level >= min_log_level) {
795 size_t bytes_written = 0;
796 const size_t message_len = strlen(message);
797 int rv;
798 while (bytes_written < message_len) {
799 rv = HANDLE_EINTR(
800 write(STDERR_FILENO, message + bytes_written,
801 message_len - bytes_written));
802 if (rv < 0) {
803 // Give up, nothing we can do now.
804 break;
805 }
806 bytes_written += rv;
807 }
808
809 if (message_len > 0 && message[message_len - 1] != '\n') {
810 do {
811 rv = HANDLE_EINTR(write(STDERR_FILENO, "\n", 1));
812 if (rv < 0) {
813 // Give up, nothing we can do now.
814 break;
815 }
816 } while (rv != 1);
817 }
818 }
819
820 if (level == LOG_FATAL)
[email protected]58580352010-10-26 04:07:50821 base::debug::BreakDebugger();
[email protected]e36ddc82009-12-08 04:22:50822}
823
[email protected]34a907732012-01-20 06:33:27824// This was defined at the beginning of this file.
825#undef write
826
[email protected]f01b88a2013-02-27 22:04:00827#if defined(OS_WIN)
828std::wstring GetLogFileFullPath() {
829 if (log_file_name)
830 return *log_file_name;
831 return std::wstring();
832}
833#endif
834
[email protected]96fd0032009-04-24 00:13:08835} // namespace logging
initial.commitd7cae122008-07-26 21:49:38836
837std::ostream& operator<<(std::ostream& out, const wchar_t* wstr) {
[email protected]f729d7a2013-12-26 07:07:56838 return out << base::WideToUTF8(std::wstring(wstr));
initial.commitd7cae122008-07-26 21:49:38839}