blob: e836092e76657df2e66349b624441a399cf7c0cc [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]b16ef312008-08-19 18:36:2346
initial.commitd7cae122008-07-26 21:49:3847#include "base/base_switches.h"
48#include "base/command_line.h"
[email protected]eb4c4d032012-04-03 18:45:0549#include "base/debug/alias.h"
[email protected]58580352010-10-26 04:07:5050#include "base/debug/debugger.h"
51#include "base/debug/stack_trace.h"
[email protected]2025d002012-11-14 20:54:3552#include "base/posix/eintr_wrapper.h"
[email protected]eb62f7262013-03-30 14:29:0053#include "base/strings/string_piece.h"
[email protected]a4ea1f12013-06-07 18:37:0754#include "base/strings/utf_string_conversions.h"
[email protected]bc581a682011-01-01 23:16:2055#include "base/synchronization/lock_impl.h"
[email protected]63e66802012-01-18 21:21:0956#include "base/threading/platform_thread.h"
[email protected]99b7c57f2010-09-29 19:26:3657#include "base/vlog.h"
[email protected]53c7ce42010-12-14 16:20:0458#if defined(OS_POSIX)
59#include "base/safe_strerror_posix.h"
60#endif
[email protected]52a261f2009-03-03 15:01:1261
[email protected]3132e35c2011-07-07 20:46:5062#if defined(OS_ANDROID)
63#include <android/log.h>
64#endif
65
initial.commitd7cae122008-07-26 21:49:3866namespace logging {
67
[email protected]7c10f7552011-01-11 01:03:3668DcheckState g_dcheck_state = DISABLE_DCHECK_FOR_NON_OFFICIAL_RELEASE_BUILDS;
[email protected]064aa162011-12-03 00:30:0869
[email protected]f12e596a2013-05-21 01:42:1070DcheckState get_dcheck_state() {
71 return g_dcheck_state;
72}
73
74void set_dcheck_state(DcheckState state) {
75 g_dcheck_state = state;
76}
77
[email protected]064aa162011-12-03 00:30:0878namespace {
79
[email protected]99b7c57f2010-09-29 19:26:3680VlogInfo* g_vlog_info = NULL;
[email protected]064aa162011-12-03 00:30:0881VlogInfo* g_vlog_info_prev = NULL;
initial.commitd7cae122008-07-26 21:49:3882
83const char* const log_severity_names[LOG_NUM_SEVERITIES] = {
[email protected]fb62a532009-02-12 01:19:0584 "INFO", "WARNING", "ERROR", "ERROR_REPORT", "FATAL" };
initial.commitd7cae122008-07-26 21:49:3885
86int 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),
358 delete_old(APPEND_TO_OLD_LOG_FILE),
359 dcheck_state(DISABLE_DCHECK_FOR_NON_OFFICIAL_RELEASE_BUILDS) {}
[email protected]064aa162011-12-03 00:30:08360
[email protected]5e3f7c22013-06-21 21:15:33361bool BaseInitLoggingImpl(const LoggingSettings& settings) {
[email protected]ac07ec52013-04-22 17:32:45362#if defined(OS_NACL)
[email protected]5e3f7c22013-06-21 21:15:33363 // Can log only to the system debug log.
364 CHECK_EQ(settings.logging_dest & ~LOG_TO_SYSTEM_DEBUG_LOG, 0);
[email protected]ac07ec52013-04-22 17:32:45365#endif
[email protected]5e3f7c22013-06-21 21:15:33366 g_dcheck_state = settings.dcheck_state;
[email protected]380d8322012-02-28 21:35:44367 CommandLine* command_line = CommandLine::ForCurrentProcess();
[email protected]99b7c57f2010-09-29 19:26:36368 // Don't bother initializing g_vlog_info unless we use one of the
369 // vlog switches.
370 if (command_line->HasSwitch(switches::kV) ||
371 command_line->HasSwitch(switches::kVModule)) {
[email protected]064aa162011-12-03 00:30:08372 // NOTE: If g_vlog_info has already been initialized, it might be in use
373 // by another thread. Don't delete the old VLogInfo, just create a second
374 // one. We keep track of both to avoid memory leak warnings.
375 CHECK(!g_vlog_info_prev);
376 g_vlog_info_prev = g_vlog_info;
377
[email protected]99b7c57f2010-09-29 19:26:36378 g_vlog_info =
379 new VlogInfo(command_line->GetSwitchValueASCII(switches::kV),
[email protected]162ac0f2010-11-04 15:50:49380 command_line->GetSwitchValueASCII(switches::kVModule),
381 &min_log_level);
[email protected]99b7c57f2010-09-29 19:26:36382 }
383
[email protected]5e3f7c22013-06-21 21:15:33384 logging_destination = settings.logging_dest;
initial.commitd7cae122008-07-26 21:49:38385
[email protected]5e3f7c22013-06-21 21:15:33386 // ignore file options unless logging to file is set.
387 if ((logging_destination & LOG_TO_FILE) == 0)
[email protected]c7d5da992010-10-28 00:20:21388 return true;
initial.commitd7cae122008-07-26 21:49:38389
[email protected]17dcf752013-07-15 21:47:09390 LoggingLock::Init(settings.lock_log, settings.log_file);
391 LoggingLock logging_lock;
392
393 // Calling InitLogging twice or after some log call has already opened the
394 // default log file will re-initialize to the new options.
395 CloseLogFileUnlocked();
396
[email protected]614e9fa2008-08-11 22:52:59397 if (!log_file_name)
398 log_file_name = new PathString();
[email protected]5e3f7c22013-06-21 21:15:33399 *log_file_name = settings.log_file;
400 if (settings.delete_old == DELETE_OLD_LOG_FILE)
[email protected]614e9fa2008-08-11 22:52:59401 DeleteFilePath(*log_file_name);
initial.commitd7cae122008-07-26 21:49:38402
[email protected]c7d5da992010-10-28 00:20:21403 return InitializeLogFileHandle();
initial.commitd7cae122008-07-26 21:49:38404}
405
406void SetMinLogLevel(int level) {
[email protected]deba0ff2010-11-03 05:30:14407 min_log_level = std::min(LOG_ERROR_REPORT, level);
initial.commitd7cae122008-07-26 21:49:38408}
409
410int GetMinLogLevel() {
411 return min_log_level;
412}
413
[email protected]162ac0f2010-11-04 15:50:49414int GetVlogVerbosity() {
415 return std::max(-1, LOG_INFO - GetMinLogLevel());
416}
417
[email protected]99b7c57f2010-09-29 19:26:36418int GetVlogLevelHelper(const char* file, size_t N) {
419 DCHECK_GT(N, 0U);
[email protected]064aa162011-12-03 00:30:08420 // Note: g_vlog_info may change on a different thread during startup
421 // (but will always be valid or NULL).
422 VlogInfo* vlog_info = g_vlog_info;
423 return vlog_info ?
424 vlog_info->GetVlogLevel(base::StringPiece(file, N - 1)) :
[email protected]162ac0f2010-11-04 15:50:49425 GetVlogVerbosity();
[email protected]99b7c57f2010-09-29 19:26:36426}
427
initial.commitd7cae122008-07-26 21:49:38428void SetLogItems(bool enable_process_id, bool enable_thread_id,
429 bool enable_timestamp, bool enable_tickcount) {
430 log_process_id = enable_process_id;
431 log_thread_id = enable_thread_id;
432 log_timestamp = enable_timestamp;
433 log_tickcount = enable_tickcount;
434}
435
[email protected]81e0a852010-08-17 00:38:12436void SetShowErrorDialogs(bool enable_dialogs) {
437 show_error_dialogs = enable_dialogs;
438}
439
initial.commitd7cae122008-07-26 21:49:38440void SetLogAssertHandler(LogAssertHandlerFunction handler) {
441 log_assert_handler = handler;
442}
443
[email protected]fb62a532009-02-12 01:19:05444void SetLogReportHandler(LogReportHandlerFunction handler) {
445 log_report_handler = handler;
446}
447
[email protected]2b07b8412009-11-25 15:26:34448void SetLogMessageHandler(LogMessageHandlerFunction handler) {
449 log_message_handler = handler;
450}
451
[email protected]64e5cc02010-11-03 19:20:27452LogMessageHandlerFunction GetLogMessageHandler() {
453 return log_message_handler;
454}
455
[email protected]6d445d32010-09-30 19:10:03456// MSVC doesn't like complex extern templates and DLLs.
457#if !defined(COMPILER_MSVC)
458// Explicit instantiations for commonly used comparisons.
459template std::string* MakeCheckOpString<int, int>(
460 const int&, const int&, const char* names);
461template std::string* MakeCheckOpString<unsigned long, unsigned long>(
462 const unsigned long&, const unsigned long&, const char* names);
463template std::string* MakeCheckOpString<unsigned long, unsigned int>(
464 const unsigned long&, const unsigned int&, const char* names);
465template std::string* MakeCheckOpString<unsigned int, unsigned long>(
466 const unsigned int&, const unsigned long&, const char* names);
467template std::string* MakeCheckOpString<std::string, std::string>(
468 const std::string&, const std::string&, const char* name);
469#endif
[email protected]2b07b8412009-11-25 15:26:34470
[email protected]d81baca42010-03-01 13:10:22471// Displays a message box to the user with the error message in it.
472// Used for fatal messages, where we close the app simultaneously.
[email protected]561513f2010-12-16 23:29:25473// This is for developers only; we don't use this in circumstances
474// (like release builds) where users could see it, since users don't
475// understand these messages anyway.
[email protected]d81baca42010-03-01 13:10:22476void DisplayDebugMessageInDialog(const std::string& str) {
initial.commitd7cae122008-07-26 21:49:38477 if (str.empty())
478 return;
479
[email protected]81e0a852010-08-17 00:38:12480 if (!show_error_dialogs)
[email protected]846ed9c32010-07-29 20:33:44481 return;
482
[email protected]f6abeba2008-08-08 13:27:28483#if defined(OS_WIN)
[email protected]d81baca42010-03-01 13:10:22484 // For Windows programs, it's possible that the message loop is
485 // messed up on a fatal error, and creating a MessageBox will cause
486 // that message loop to be run. Instead, we try to spawn another
487 // process that displays its command line. We look for "Debug
488 // Message.exe" in the same directory as the application. If it
489 // exists, we use it, otherwise, we use a regular message box.
initial.commitd7cae122008-07-26 21:49:38490 wchar_t prog_name[MAX_PATH];
491 GetModuleFileNameW(NULL, prog_name, MAX_PATH);
492 wchar_t* backslash = wcsrchr(prog_name, '\\');
493 if (backslash)
494 backslash[1] = 0;
495 wcscat_s(prog_name, MAX_PATH, L"debug_message.exe");
496
[email protected]047a03f2009-10-07 02:10:20497 std::wstring cmdline = UTF8ToWide(str);
[email protected]3ca4214c12009-03-25 22:12:02498 if (cmdline.empty())
499 return;
initial.commitd7cae122008-07-26 21:49:38500
501 STARTUPINFO startup_info;
502 memset(&startup_info, 0, sizeof(startup_info));
503 startup_info.cb = sizeof(startup_info);
504
505 PROCESS_INFORMATION process_info;
[email protected]3ca4214c12009-03-25 22:12:02506 if (CreateProcessW(prog_name, &cmdline[0], NULL, NULL, false, 0, NULL,
initial.commitd7cae122008-07-26 21:49:38507 NULL, &startup_info, &process_info)) {
508 WaitForSingleObject(process_info.hProcess, INFINITE);
509 CloseHandle(process_info.hThread);
510 CloseHandle(process_info.hProcess);
511 } else {
512 // debug process broken, let's just do a message box
[email protected]3ca4214c12009-03-25 22:12:02513 MessageBoxW(NULL, &cmdline[0], L"Fatal error",
initial.commitd7cae122008-07-26 21:49:38514 MB_OK | MB_ICONHAND | MB_TOPMOST);
515 }
[email protected]f6abeba2008-08-08 13:27:28516#else
[email protected]561513f2010-12-16 23:29:25517 // We intentionally don't implement a dialog on other platforms.
518 // You can just look at stderr.
[email protected]f6abeba2008-08-08 13:27:28519#endif
initial.commitd7cae122008-07-26 21:49:38520}
521
[email protected]3f85caa2009-04-14 16:52:11522#if defined(OS_WIN)
523LogMessage::SaveLastError::SaveLastError() : last_error_(::GetLastError()) {
524}
525
526LogMessage::SaveLastError::~SaveLastError() {
527 ::SetLastError(last_error_);
528}
529#endif // defined(OS_WIN)
530
initial.commitd7cae122008-07-26 21:49:38531LogMessage::LogMessage(const char* file, int line, LogSeverity severity,
532 int ctr)
[email protected]162ac0f2010-11-04 15:50:49533 : severity_(severity), file_(file), line_(line) {
initial.commitd7cae122008-07-26 21:49:38534 Init(file, line);
535}
536
[email protected]eae9c062011-01-11 00:50:59537LogMessage::LogMessage(const char* file, int line)
538 : severity_(LOG_INFO), file_(file), line_(line) {
539 Init(file, line);
540}
541
542LogMessage::LogMessage(const char* file, int line, LogSeverity severity)
543 : severity_(severity), file_(file), line_(line) {
544 Init(file, line);
545}
546
[email protected]9c7132e2011-02-08 07:39:08547LogMessage::LogMessage(const char* file, int line, std::string* result)
[email protected]162ac0f2010-11-04 15:50:49548 : severity_(LOG_FATAL), file_(file), line_(line) {
initial.commitd7cae122008-07-26 21:49:38549 Init(file, line);
[email protected]9c7132e2011-02-08 07:39:08550 stream_ << "Check failed: " << *result;
551 delete result;
initial.commitd7cae122008-07-26 21:49:38552}
553
[email protected]fb62a532009-02-12 01:19:05554LogMessage::LogMessage(const char* file, int line, LogSeverity severity,
[email protected]9c7132e2011-02-08 07:39:08555 std::string* result)
[email protected]162ac0f2010-11-04 15:50:49556 : severity_(severity), file_(file), line_(line) {
[email protected]fb62a532009-02-12 01:19:05557 Init(file, line);
[email protected]9c7132e2011-02-08 07:39:08558 stream_ << "Check failed: " << *result;
559 delete result;
[email protected]fb62a532009-02-12 01:19:05560}
561
initial.commitd7cae122008-07-26 21:49:38562LogMessage::~LogMessage() {
[email protected]22d955692013-07-04 06:04:46563#if !defined(NDEBUG) && !defined(OS_NACL)
[email protected]d1ccc35a2010-03-24 05:03:24564 if (severity_ == LOG_FATAL) {
565 // Include a stack trace on a fatal.
[email protected]58580352010-10-26 04:07:50566 base::debug::StackTrace trace;
[email protected]d1ccc35a2010-03-24 05:03:24567 stream_ << std::endl; // Newline to separate from log message.
568 trace.OutputToStream(&stream_);
569 }
[email protected]1d8c2702008-08-19 23:39:32570#endif
[email protected]d1ccc35a2010-03-24 05:03:24571 stream_ << std::endl;
572 std::string str_newline(stream_.str());
573
[email protected]2b07b8412009-11-25 15:26:34574 // Give any log message handler first dibs on the message.
[email protected]5e3f7c22013-06-21 21:15:33575 if (log_message_handler &&
576 log_message_handler(severity_, file_, line_,
577 message_start_, str_newline)) {
[email protected]162ac0f2010-11-04 15:50:49578 // The handler took care of it, no further processing.
[email protected]2b07b8412009-11-25 15:26:34579 return;
[email protected]162ac0f2010-11-04 15:50:49580 }
initial.commitd7cae122008-07-26 21:49:38581
[email protected]5e3f7c22013-06-21 21:15:33582 if ((logging_destination & LOG_TO_SYSTEM_DEBUG_LOG) != 0) {
[email protected]f6abeba2008-08-08 13:27:28583#if defined(OS_WIN)
initial.commitd7cae122008-07-26 21:49:38584 OutputDebugStringA(str_newline.c_str());
[email protected]3132e35c2011-07-07 20:46:50585#elif defined(OS_ANDROID)
[email protected]efbae7da2013-05-21 22:39:25586 android_LogPriority priority =
587 (severity_ < 0) ? ANDROID_LOG_VERBOSE : ANDROID_LOG_UNKNOWN;
[email protected]3132e35c2011-07-07 20:46:50588 switch (severity_) {
589 case LOG_INFO:
590 priority = ANDROID_LOG_INFO;
591 break;
592 case LOG_WARNING:
593 priority = ANDROID_LOG_WARN;
594 break;
595 case LOG_ERROR:
596 case LOG_ERROR_REPORT:
597 priority = ANDROID_LOG_ERROR;
598 break;
599 case LOG_FATAL:
600 priority = ANDROID_LOG_FATAL;
601 break;
602 }
603 __android_log_write(priority, "chromium", str_newline.c_str());
[email protected]107bc0f12008-08-26 17:48:18604#endif
[email protected]469006c2010-09-24 15:43:06605 fprintf(stderr, "%s", str_newline.c_str());
606 fflush(stderr);
[email protected]a33c9892008-08-25 20:10:31607 } else if (severity_ >= kAlwaysPrintErrorLevel) {
608 // When we're only outputting to a log file, above a certain log level, we
609 // should still output to stderr so that we can better detect and diagnose
610 // problems with unit tests, especially on the buildbots.
611 fprintf(stderr, "%s", str_newline.c_str());
[email protected]1ce41052009-12-02 00:34:02612 fflush(stderr);
[email protected]f6abeba2008-08-08 13:27:28613 }
[email protected]52a261f2009-03-03 15:01:12614
initial.commitd7cae122008-07-26 21:49:38615 // write to log file
[email protected]5e3f7c22013-06-21 21:15:33616 if ((logging_destination & LOG_TO_FILE) != 0) {
[email protected]17dcf752013-07-15 21:47:09617 // We can have multiple threads and/or processes, so try to prevent them
618 // from clobbering each other's writes.
619 // If the client app did not call InitLogging, and the lock has not
620 // been created do it now. We do this on demand, but if two threads try
621 // to do this at the same time, there will be a race condition to create
622 // the lock. This is why InitLogging should be called from the main
623 // thread at the beginning of execution.
624 LoggingLock::Init(LOCK_LOG_FILE, NULL);
[email protected]5b84fe32010-09-14 22:24:55625 LoggingLock logging_lock;
626 if (InitializeLogFileHandle()) {
[email protected]f6abeba2008-08-08 13:27:28627#if defined(OS_WIN)
[email protected]5b84fe32010-09-14 22:24:55628 SetFilePointer(log_file, 0, 0, SEEK_END);
629 DWORD num_written;
630 WriteFile(log_file,
631 static_cast<const void*>(str_newline.c_str()),
632 static_cast<DWORD>(str_newline.length()),
633 &num_written,
634 NULL);
[email protected]cba21962010-08-31 22:35:55635#else
[email protected]5b84fe32010-09-14 22:24:55636 fprintf(log_file, "%s", str_newline.c_str());
637 fflush(log_file);
[email protected]cba21962010-08-31 22:35:55638#endif
initial.commitd7cae122008-07-26 21:49:38639 }
640 }
641
642 if (severity_ == LOG_FATAL) {
[email protected]eb4c4d032012-04-03 18:45:05643 // Ensure the first characters of the string are on the stack so they
644 // are contained in minidumps for diagnostic purposes.
645 char str_stack[1024];
646 str_newline.copy(str_stack, arraysize(str_stack));
647 base::debug::Alias(str_stack);
648
initial.commitd7cae122008-07-26 21:49:38649 // display a message or break into the debugger on a fatal error
[email protected]58580352010-10-26 04:07:50650 if (base::debug::BeingDebugged()) {
651 base::debug::BreakDebugger();
[email protected]1ffe08c12008-08-13 11:15:11652 } else {
initial.commitd7cae122008-07-26 21:49:38653 if (log_assert_handler) {
654 // make a copy of the string for the handler out of paranoia
655 log_assert_handler(std::string(stream_.str()));
656 } else {
[email protected]4d5901272008-11-06 00:33:50657 // Don't use the string with the newline, get a fresh version to send to
658 // the debug message process. We also don't display assertions to the
659 // user in release mode. The enduser can't do anything with this
660 // information, and displaying message boxes when the application is
661 // hosed can cause additional problems.
662#ifndef NDEBUG
[email protected]d81baca42010-03-01 13:10:22663 DisplayDebugMessageInDialog(stream_.str());
[email protected]4d5901272008-11-06 00:33:50664#endif
initial.commitd7cae122008-07-26 21:49:38665 // Crash the process to generate a dump.
[email protected]58580352010-10-26 04:07:50666 base::debug::BreakDebugger();
initial.commitd7cae122008-07-26 21:49:38667 }
668 }
[email protected]fb62a532009-02-12 01:19:05669 } else if (severity_ == LOG_ERROR_REPORT) {
670 // We are here only if the user runs with --enable-dcheck in release mode.
671 if (log_report_handler) {
672 log_report_handler(std::string(stream_.str()));
673 } else {
[email protected]d81baca42010-03-01 13:10:22674 DisplayDebugMessageInDialog(stream_.str());
[email protected]fb62a532009-02-12 01:19:05675 }
initial.commitd7cae122008-07-26 21:49:38676 }
677}
678
[email protected]eae9c062011-01-11 00:50:59679// writes the common header info to the stream
680void LogMessage::Init(const char* file, int line) {
681 base::StringPiece filename(file);
682 size_t last_slash_pos = filename.find_last_of("\\/");
683 if (last_slash_pos != base::StringPiece::npos)
684 filename.remove_prefix(last_slash_pos + 1);
685
686 // TODO(darin): It might be nice if the columns were fixed width.
687
688 stream_ << '[';
689 if (log_process_id)
690 stream_ << CurrentProcessId() << ':';
691 if (log_thread_id)
[email protected]63e66802012-01-18 21:21:09692 stream_ << base::PlatformThread::CurrentId() << ':';
[email protected]eae9c062011-01-11 00:50:59693 if (log_timestamp) {
694 time_t t = time(NULL);
695 struct tm local_time = {0};
696#if _MSC_VER >= 1400
697 localtime_s(&local_time, &t);
698#else
699 localtime_r(&t, &local_time);
700#endif
701 struct tm* tm_time = &local_time;
702 stream_ << std::setfill('0')
703 << std::setw(2) << 1 + tm_time->tm_mon
704 << std::setw(2) << tm_time->tm_mday
705 << '/'
706 << std::setw(2) << tm_time->tm_hour
707 << std::setw(2) << tm_time->tm_min
708 << std::setw(2) << tm_time->tm_sec
709 << ':';
710 }
711 if (log_tickcount)
712 stream_ << TickCount() << ':';
713 if (severity_ >= 0)
714 stream_ << log_severity_names[severity_];
715 else
716 stream_ << "VERBOSE" << -severity_;
717
718 stream_ << ":" << filename << "(" << line << ")] ";
719
720 message_start_ = stream_.tellp();
721}
722
[email protected]d8617a62009-10-09 23:52:20723#if defined(OS_WIN)
724// This has already been defined in the header, but defining it again as DWORD
725// ensures that the type used in the header is equivalent to DWORD. If not,
726// the redefinition is a compile error.
727typedef DWORD SystemErrorCode;
728#endif
729
730SystemErrorCode GetLastSystemErrorCode() {
731#if defined(OS_WIN)
732 return ::GetLastError();
733#elif defined(OS_POSIX)
734 return errno;
735#else
736#error Not implemented
737#endif
738}
739
740#if defined(OS_WIN)
741Win32ErrorLogMessage::Win32ErrorLogMessage(const char* file,
742 int line,
743 LogSeverity severity,
744 SystemErrorCode err,
745 const char* module)
746 : err_(err),
747 module_(module),
748 log_message_(file, line, severity) {
749}
750
751Win32ErrorLogMessage::Win32ErrorLogMessage(const char* file,
752 int line,
753 LogSeverity severity,
754 SystemErrorCode err)
755 : err_(err),
756 module_(NULL),
757 log_message_(file, line, severity) {
758}
759
760Win32ErrorLogMessage::~Win32ErrorLogMessage() {
761 const int error_message_buffer_size = 256;
762 char msgbuf[error_message_buffer_size];
[email protected]6ac3df52010-10-20 01:33:32763 DWORD flags = FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS;
[email protected]d8617a62009-10-09 23:52:20764 HMODULE hmod;
765 if (module_) {
766 hmod = GetModuleHandleA(module_);
767 if (hmod) {
768 flags |= FORMAT_MESSAGE_FROM_HMODULE;
769 } else {
770 // This makes a nested Win32ErrorLogMessage. It will have module_ of NULL
771 // so it will not call GetModuleHandle, so recursive errors are
772 // impossible.
773 DPLOG(WARNING) << "Couldn't open module " << module_
774 << " for error message query";
775 }
776 } else {
777 hmod = NULL;
778 }
779 DWORD len = FormatMessageA(flags,
780 hmod,
781 err_,
[email protected]6ac3df52010-10-20 01:33:32782 0,
[email protected]d8617a62009-10-09 23:52:20783 msgbuf,
784 sizeof(msgbuf) / sizeof(msgbuf[0]),
785 NULL);
786 if (len) {
787 while ((len > 0) &&
788 isspace(static_cast<unsigned char>(msgbuf[len - 1]))) {
789 msgbuf[--len] = 0;
790 }
791 stream() << ": " << msgbuf;
792 } else {
793 stream() << ": Error " << GetLastError() << " while retrieving error "
794 << err_;
795 }
[email protected]20909e72012-04-05 16:57:06796 // We're about to crash (CHECK). Put |err_| on the stack (by placing it in a
797 // field) and use Alias in hopes that it makes it into crash dumps.
798 DWORD last_error = err_;
799 base::debug::Alias(&last_error);
[email protected]d8617a62009-10-09 23:52:20800}
801#elif defined(OS_POSIX)
802ErrnoLogMessage::ErrnoLogMessage(const char* file,
803 int line,
804 LogSeverity severity,
805 SystemErrorCode err)
806 : err_(err),
807 log_message_(file, line, severity) {
808}
809
810ErrnoLogMessage::~ErrnoLogMessage() {
811 stream() << ": " << safe_strerror(err_);
812}
813#endif // OS_WIN
814
initial.commitd7cae122008-07-26 21:49:38815void CloseLogFile() {
[email protected]5b84fe32010-09-14 22:24:55816 LoggingLock logging_lock;
[email protected]17dcf752013-07-15 21:47:09817 CloseLogFileUnlocked();
initial.commitd7cae122008-07-26 21:49:38818}
819
[email protected]e36ddc82009-12-08 04:22:50820void RawLog(int level, const char* message) {
821 if (level >= min_log_level) {
822 size_t bytes_written = 0;
823 const size_t message_len = strlen(message);
824 int rv;
825 while (bytes_written < message_len) {
826 rv = HANDLE_EINTR(
827 write(STDERR_FILENO, message + bytes_written,
828 message_len - bytes_written));
829 if (rv < 0) {
830 // Give up, nothing we can do now.
831 break;
832 }
833 bytes_written += rv;
834 }
835
836 if (message_len > 0 && message[message_len - 1] != '\n') {
837 do {
838 rv = HANDLE_EINTR(write(STDERR_FILENO, "\n", 1));
839 if (rv < 0) {
840 // Give up, nothing we can do now.
841 break;
842 }
843 } while (rv != 1);
844 }
845 }
846
847 if (level == LOG_FATAL)
[email protected]58580352010-10-26 04:07:50848 base::debug::BreakDebugger();
[email protected]e36ddc82009-12-08 04:22:50849}
850
[email protected]34a907732012-01-20 06:33:27851// This was defined at the beginning of this file.
852#undef write
853
[email protected]f01b88a2013-02-27 22:04:00854#if defined(OS_WIN)
855std::wstring GetLogFileFullPath() {
856 if (log_file_name)
857 return *log_file_name;
858 return std::wstring();
859}
860#endif
861
[email protected]96fd0032009-04-24 00:13:08862} // namespace logging
initial.commitd7cae122008-07-26 21:49:38863
864std::ostream& operator<<(std::ostream& out, const wchar_t* wstr) {
[email protected]047a03f2009-10-07 02:10:20865 return out << WideToUTF8(std::wstring(wstr));
initial.commitd7cae122008-07-26 21:49:38866}