blob: 4800f82e203125f7e04eea9f02b46a940564dd77 [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]bc581a682011-01-01 23:16:2054#include "base/synchronization/lock_impl.h"
[email protected]63e66802012-01-18 21:21:0955#include "base/threading/platform_thread.h"
[email protected]047a03f2009-10-07 02:10:2056#include "base/utf_string_conversions.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
88// The default set here for logging_destination will only be used if
89// InitLogging is not called. On Windows, use a file next to the exe;
90// on POSIX platforms, where it may not even be possible to locate the
91// executable on disk, use stderr.
[email protected]4c0040c2008-08-15 01:04:1192#if defined(OS_WIN)
[email protected]fe613522008-08-22 17:09:3493LoggingDestination logging_destination = LOG_ONLY_TO_FILE;
[email protected]4c0040c2008-08-15 01:04:1194#elif defined(OS_POSIX)
[email protected]1d8c2702008-08-19 23:39:3295LoggingDestination logging_destination = LOG_ONLY_TO_SYSTEM_DEBUG_LOG;
[email protected]4c0040c2008-08-15 01:04:1196#endif
initial.commitd7cae122008-07-26 21:49:3897
[email protected]a33c9892008-08-25 20:10:3198// For LOG_ERROR and above, always print to stderr.
99const int kAlwaysPrintErrorLevel = LOG_ERROR;
100
[email protected]614e9fa2008-08-11 22:52:59101// Which log file to use? This is initialized by InitLogging or
initial.commitd7cae122008-07-26 21:49:38102// will be lazily initialized to the default value when it is
103// first needed.
[email protected]f6abeba2008-08-08 13:27:28104#if defined(OS_WIN)
[email protected]614e9fa2008-08-11 22:52:59105typedef std::wstring PathString;
[email protected]f6abeba2008-08-08 13:27:28106#else
[email protected]614e9fa2008-08-11 22:52:59107typedef std::string PathString;
[email protected]f6abeba2008-08-08 13:27:28108#endif
[email protected]614e9fa2008-08-11 22:52:59109PathString* log_file_name = NULL;
initial.commitd7cae122008-07-26 21:49:38110
111// this file is lazily opened and the handle may be NULL
[email protected]f6abeba2008-08-08 13:27:28112FileHandle log_file = NULL;
initial.commitd7cae122008-07-26 21:49:38113
114// what should be prepended to each message?
115bool log_process_id = false;
116bool log_thread_id = false;
117bool log_timestamp = true;
118bool log_tickcount = false;
119
[email protected]81e0a852010-08-17 00:38:12120// Should we pop up fatal debug messages in a dialog?
121bool show_error_dialogs = false;
122
initial.commitd7cae122008-07-26 21:49:38123// An assert handler override specified by the client to be called instead of
[email protected]fb62a532009-02-12 01:19:05124// the debug message dialog and process termination.
initial.commitd7cae122008-07-26 21:49:38125LogAssertHandlerFunction log_assert_handler = NULL;
[email protected]fb62a532009-02-12 01:19:05126// An report handler override specified by the client to be called instead of
127// the debug message dialog.
128LogReportHandlerFunction log_report_handler = NULL;
[email protected]2b07b8412009-11-25 15:26:34129// A log message handler that gets notified of every log message we process.
130LogMessageHandlerFunction log_message_handler = NULL;
initial.commitd7cae122008-07-26 21:49:38131
[email protected]f6abeba2008-08-08 13:27:28132// Helper functions to wrap platform differences.
133
[email protected]f8588472008-11-05 23:17:24134int32 CurrentProcessId() {
135#if defined(OS_WIN)
136 return GetCurrentProcessId();
137#elif defined(OS_POSIX)
138 return getpid();
139#endif
140}
141
[email protected]f8588472008-11-05 23:17:24142uint64 TickCount() {
143#if defined(OS_WIN)
144 return GetTickCount();
145#elif defined(OS_MACOSX)
146 return mach_absolute_time();
[email protected]19ea84ca2010-11-12 08:37:08147#elif defined(OS_NACL)
148 // NaCl sadly does not have _POSIX_TIMERS enabled in sys/features.h
149 // So we have to use clock() for now.
150 return clock();
[email protected]e43eddf12009-12-29 00:32:52151#elif defined(OS_POSIX)
[email protected]052f1b52008-11-06 21:43:07152 struct timespec ts;
153 clock_gettime(CLOCK_MONOTONIC, &ts);
154
155 uint64 absolute_micro =
156 static_cast<int64>(ts.tv_sec) * 1000000 +
157 static_cast<int64>(ts.tv_nsec) / 1000;
158
159 return absolute_micro;
[email protected]f8588472008-11-05 23:17:24160#endif
161}
162
[email protected]f6abeba2008-08-08 13:27:28163void CloseFile(FileHandle log) {
164#if defined(OS_WIN)
165 CloseHandle(log);
166#else
167 fclose(log);
168#endif
169}
170
[email protected]614e9fa2008-08-11 22:52:59171void DeleteFilePath(const PathString& log_name) {
[email protected]f6abeba2008-08-08 13:27:28172#if defined(OS_WIN)
[email protected]614e9fa2008-08-11 22:52:59173 DeleteFile(log_name.c_str());
[email protected]ac07ec52013-04-22 17:32:45174#elif defined (OS_NACL)
175 // Do nothing; unlink() isn't supported on NaCl.
[email protected]f6abeba2008-08-08 13:27:28176#else
[email protected]614e9fa2008-08-11 22:52:59177 unlink(log_name.c_str());
[email protected]f6abeba2008-08-08 13:27:28178#endif
179}
initial.commitd7cae122008-07-26 21:49:38180
[email protected]5f95d532010-10-01 17:16:58181PathString GetDefaultLogFile() {
[email protected]5b84fe32010-09-14 22:24:55182#if defined(OS_WIN)
183 // On Windows we use the same path as the exe.
184 wchar_t module_name[MAX_PATH];
185 GetModuleFileName(NULL, module_name, MAX_PATH);
[email protected]5f95d532010-10-01 17:16:58186
187 PathString log_file = module_name;
188 PathString::size_type last_backslash =
189 log_file.rfind('\\', log_file.size());
190 if (last_backslash != PathString::npos)
191 log_file.erase(last_backslash + 1);
192 log_file += L"debug.log";
193 return log_file;
[email protected]5b84fe32010-09-14 22:24:55194#elif defined(OS_POSIX)
195 // On other platforms we just use the current directory.
[email protected]5f95d532010-10-01 17:16:58196 return PathString("debug.log");
[email protected]5b84fe32010-09-14 22:24:55197#endif
198}
199
200// This class acts as a wrapper for locking the logging files.
201// LoggingLock::Init() should be called from the main thread before any logging
202// is done. Then whenever logging, be sure to have a local LoggingLock
203// instance on the stack. This will ensure that the lock is unlocked upon
204// exiting the frame.
205// LoggingLocks can not be nested.
206class LoggingLock {
207 public:
208 LoggingLock() {
209 LockLogging();
210 }
211
212 ~LoggingLock() {
213 UnlockLogging();
214 }
215
216 static void Init(LogLockingState lock_log, const PathChar* new_log_file) {
217 if (initialized)
218 return;
219 lock_log_file = lock_log;
220 if (lock_log_file == LOCK_LOG_FILE) {
221#if defined(OS_WIN)
222 if (!log_mutex) {
223 std::wstring safe_name;
224 if (new_log_file)
225 safe_name = new_log_file;
226 else
[email protected]5f95d532010-10-01 17:16:58227 safe_name = GetDefaultLogFile();
[email protected]5b84fe32010-09-14 22:24:55228 // \ is not a legal character in mutex names so we replace \ with /
229 std::replace(safe_name.begin(), safe_name.end(), '\\', '/');
230 std::wstring t(L"Global\\");
231 t.append(safe_name);
232 log_mutex = ::CreateMutex(NULL, FALSE, t.c_str());
[email protected]5f95d532010-10-01 17:16:58233
234 if (log_mutex == NULL) {
235#if DEBUG
236 // Keep the error code for debugging
237 int error = GetLastError(); // NOLINT
[email protected]58580352010-10-26 04:07:50238 base::debug::BreakDebugger();
[email protected]5f95d532010-10-01 17:16:58239#endif
240 // Return nicely without putting initialized to true.
241 return;
242 }
[email protected]5b84fe32010-09-14 22:24:55243 }
244#endif
245 } else {
[email protected]bc581a682011-01-01 23:16:20246 log_lock = new base::internal::LockImpl();
[email protected]5b84fe32010-09-14 22:24:55247 }
248 initialized = true;
249 }
250
251 private:
252 static void LockLogging() {
253 if (lock_log_file == LOCK_LOG_FILE) {
254#if defined(OS_WIN)
255 ::WaitForSingleObject(log_mutex, INFINITE);
256 // WaitForSingleObject could have returned WAIT_ABANDONED. We don't
257 // abort the process here. UI tests might be crashy sometimes,
258 // and aborting the test binary only makes the problem worse.
259 // We also don't use LOG macros because that might lead to an infinite
260 // loop. For more info see http://crbug.com/18028.
261#elif defined(OS_POSIX)
262 pthread_mutex_lock(&log_mutex);
263#endif
264 } else {
265 // use the lock
266 log_lock->Lock();
267 }
268 }
269
270 static void UnlockLogging() {
271 if (lock_log_file == LOCK_LOG_FILE) {
272#if defined(OS_WIN)
273 ReleaseMutex(log_mutex);
274#elif defined(OS_POSIX)
275 pthread_mutex_unlock(&log_mutex);
276#endif
277 } else {
278 log_lock->Unlock();
279 }
280 }
281
282 // The lock is used if log file locking is false. It helps us avoid problems
283 // with multiple threads writing to the log file at the same time. Use
284 // LockImpl directly instead of using Lock, because Lock makes logging calls.
[email protected]bc581a682011-01-01 23:16:20285 static base::internal::LockImpl* log_lock;
[email protected]5b84fe32010-09-14 22:24:55286
287 // When we don't use a lock, we are using a global mutex. We need to do this
288 // because LockFileEx is not thread safe.
289#if defined(OS_WIN)
290 static MutexHandle log_mutex;
291#elif defined(OS_POSIX)
292 static pthread_mutex_t log_mutex;
293#endif
294
295 static bool initialized;
296 static LogLockingState lock_log_file;
297};
298
299// static
300bool LoggingLock::initialized = false;
301// static
[email protected]bc581a682011-01-01 23:16:20302base::internal::LockImpl* LoggingLock::log_lock = NULL;
[email protected]5b84fe32010-09-14 22:24:55303// static
304LogLockingState LoggingLock::lock_log_file = LOCK_LOG_FILE;
305
306#if defined(OS_WIN)
307// static
308MutexHandle LoggingLock::log_mutex = NULL;
309#elif defined(OS_POSIX)
310pthread_mutex_t LoggingLock::log_mutex = PTHREAD_MUTEX_INITIALIZER;
311#endif
312
initial.commitd7cae122008-07-26 21:49:38313// Called by logging functions to ensure that debug_file is initialized
314// and can be used for writing. Returns false if the file could not be
315// initialized. debug_file will be NULL in this case.
316bool InitializeLogFileHandle() {
317 if (log_file)
318 return true;
319
[email protected]614e9fa2008-08-11 22:52:59320 if (!log_file_name) {
321 // Nobody has called InitLogging to specify a debug log file, so here we
322 // initialize the log file name to a default.
[email protected]5f95d532010-10-01 17:16:58323 log_file_name = new PathString(GetDefaultLogFile());
initial.commitd7cae122008-07-26 21:49:38324 }
325
[email protected]1d8c2702008-08-19 23:39:32326 if (logging_destination == LOG_ONLY_TO_FILE ||
327 logging_destination == LOG_TO_BOTH_FILE_AND_SYSTEM_DEBUG_LOG) {
[email protected]614e9fa2008-08-11 22:52:59328#if defined(OS_WIN)
[email protected]1d8c2702008-08-19 23:39:32329 log_file = CreateFile(log_file_name->c_str(), GENERIC_WRITE,
initial.commitd7cae122008-07-26 21:49:38330 FILE_SHARE_READ | FILE_SHARE_WRITE, NULL,
331 OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
332 if (log_file == INVALID_HANDLE_VALUE || log_file == NULL) {
[email protected]1d8c2702008-08-19 23:39:32333 // try the current directory
334 log_file = CreateFile(L".\\debug.log", GENERIC_WRITE,
335 FILE_SHARE_READ | FILE_SHARE_WRITE, NULL,
336 OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
337 if (log_file == INVALID_HANDLE_VALUE || log_file == NULL) {
338 log_file = NULL;
339 return false;
340 }
initial.commitd7cae122008-07-26 21:49:38341 }
[email protected]1d8c2702008-08-19 23:39:32342 SetFilePointer(log_file, 0, 0, FILE_END);
[email protected]78c6dd62009-06-08 23:29:11343#elif defined(OS_POSIX)
344 log_file = fopen(log_file_name->c_str(), "a");
345 if (log_file == NULL)
346 return false;
[email protected]f6abeba2008-08-08 13:27:28347#endif
[email protected]1d8c2702008-08-19 23:39:32348 }
349
initial.commitd7cae122008-07-26 21:49:38350 return true;
351}
352
[email protected]064aa162011-12-03 00:30:08353} // namespace
354
355
[email protected]c7d5da992010-10-28 00:20:21356bool BaseInitLoggingImpl(const PathChar* new_log_file,
[email protected]ff3d0c32010-08-23 19:57:46357 LoggingDestination logging_dest,
358 LogLockingState lock_log,
[email protected]7c10f7552011-01-11 01:03:36359 OldFileDeletionState delete_old,
360 DcheckState dcheck_state) {
[email protected]ac07ec52013-04-22 17:32:45361#if defined(OS_NACL)
362 CHECK(logging_dest == LOG_NONE ||
363 logging_dest == LOG_ONLY_TO_SYSTEM_DEBUG_LOG);
364#endif
[email protected]7c10f7552011-01-11 01:03:36365 g_dcheck_state = dcheck_state;
[email protected]380d8322012-02-28 21:35:44366 CommandLine* command_line = CommandLine::ForCurrentProcess();
[email protected]99b7c57f2010-09-29 19:26:36367 // Don't bother initializing g_vlog_info unless we use one of the
368 // vlog switches.
369 if (command_line->HasSwitch(switches::kV) ||
370 command_line->HasSwitch(switches::kVModule)) {
[email protected]064aa162011-12-03 00:30:08371 // NOTE: If g_vlog_info has already been initialized, it might be in use
372 // by another thread. Don't delete the old VLogInfo, just create a second
373 // one. We keep track of both to avoid memory leak warnings.
374 CHECK(!g_vlog_info_prev);
375 g_vlog_info_prev = g_vlog_info;
376
[email protected]99b7c57f2010-09-29 19:26:36377 g_vlog_info =
378 new VlogInfo(command_line->GetSwitchValueASCII(switches::kV),
[email protected]162ac0f2010-11-04 15:50:49379 command_line->GetSwitchValueASCII(switches::kVModule),
380 &min_log_level);
[email protected]99b7c57f2010-09-29 19:26:36381 }
382
[email protected]5b84fe32010-09-14 22:24:55383 LoggingLock::Init(lock_log, new_log_file);
384
385 LoggingLock logging_lock;
initial.commitd7cae122008-07-26 21:49:38386
387 if (log_file) {
388 // calling InitLogging twice or after some log call has already opened the
389 // default log file will re-initialize to the new options
[email protected]f6abeba2008-08-08 13:27:28390 CloseFile(log_file);
initial.commitd7cae122008-07-26 21:49:38391 log_file = NULL;
392 }
393
initial.commitd7cae122008-07-26 21:49:38394 logging_destination = logging_dest;
395
396 // ignore file options if logging is disabled or only to system
397 if (logging_destination == LOG_NONE ||
398 logging_destination == LOG_ONLY_TO_SYSTEM_DEBUG_LOG)
[email protected]c7d5da992010-10-28 00:20:21399 return true;
initial.commitd7cae122008-07-26 21:49:38400
[email protected]614e9fa2008-08-11 22:52:59401 if (!log_file_name)
402 log_file_name = new PathString();
403 *log_file_name = new_log_file;
initial.commitd7cae122008-07-26 21:49:38404 if (delete_old == DELETE_OLD_LOG_FILE)
[email protected]614e9fa2008-08-11 22:52:59405 DeleteFilePath(*log_file_name);
initial.commitd7cae122008-07-26 21:49:38406
[email protected]c7d5da992010-10-28 00:20:21407 return InitializeLogFileHandle();
initial.commitd7cae122008-07-26 21:49:38408}
409
410void SetMinLogLevel(int level) {
[email protected]deba0ff2010-11-03 05:30:14411 min_log_level = std::min(LOG_ERROR_REPORT, level);
initial.commitd7cae122008-07-26 21:49:38412}
413
414int GetMinLogLevel() {
415 return min_log_level;
416}
417
[email protected]162ac0f2010-11-04 15:50:49418int GetVlogVerbosity() {
419 return std::max(-1, LOG_INFO - GetMinLogLevel());
420}
421
[email protected]99b7c57f2010-09-29 19:26:36422int GetVlogLevelHelper(const char* file, size_t N) {
423 DCHECK_GT(N, 0U);
[email protected]064aa162011-12-03 00:30:08424 // Note: g_vlog_info may change on a different thread during startup
425 // (but will always be valid or NULL).
426 VlogInfo* vlog_info = g_vlog_info;
427 return vlog_info ?
428 vlog_info->GetVlogLevel(base::StringPiece(file, N - 1)) :
[email protected]162ac0f2010-11-04 15:50:49429 GetVlogVerbosity();
[email protected]99b7c57f2010-09-29 19:26:36430}
431
initial.commitd7cae122008-07-26 21:49:38432void SetLogItems(bool enable_process_id, bool enable_thread_id,
433 bool enable_timestamp, bool enable_tickcount) {
434 log_process_id = enable_process_id;
435 log_thread_id = enable_thread_id;
436 log_timestamp = enable_timestamp;
437 log_tickcount = enable_tickcount;
438}
439
[email protected]81e0a852010-08-17 00:38:12440void SetShowErrorDialogs(bool enable_dialogs) {
441 show_error_dialogs = enable_dialogs;
442}
443
initial.commitd7cae122008-07-26 21:49:38444void SetLogAssertHandler(LogAssertHandlerFunction handler) {
445 log_assert_handler = handler;
446}
447
[email protected]fb62a532009-02-12 01:19:05448void SetLogReportHandler(LogReportHandlerFunction handler) {
449 log_report_handler = handler;
450}
451
[email protected]2b07b8412009-11-25 15:26:34452void SetLogMessageHandler(LogMessageHandlerFunction handler) {
453 log_message_handler = handler;
454}
455
[email protected]64e5cc02010-11-03 19:20:27456LogMessageHandlerFunction GetLogMessageHandler() {
457 return log_message_handler;
458}
459
[email protected]6d445d32010-09-30 19:10:03460// MSVC doesn't like complex extern templates and DLLs.
461#if !defined(COMPILER_MSVC)
462// Explicit instantiations for commonly used comparisons.
463template std::string* MakeCheckOpString<int, int>(
464 const int&, const int&, const char* names);
465template std::string* MakeCheckOpString<unsigned long, unsigned long>(
466 const unsigned long&, const unsigned long&, const char* names);
467template std::string* MakeCheckOpString<unsigned long, unsigned int>(
468 const unsigned long&, const unsigned int&, const char* names);
469template std::string* MakeCheckOpString<unsigned int, unsigned long>(
470 const unsigned int&, const unsigned long&, const char* names);
471template std::string* MakeCheckOpString<std::string, std::string>(
472 const std::string&, const std::string&, const char* name);
473#endif
[email protected]2b07b8412009-11-25 15:26:34474
[email protected]d81baca42010-03-01 13:10:22475// Displays a message box to the user with the error message in it.
476// Used for fatal messages, where we close the app simultaneously.
[email protected]561513f2010-12-16 23:29:25477// This is for developers only; we don't use this in circumstances
478// (like release builds) where users could see it, since users don't
479// understand these messages anyway.
[email protected]d81baca42010-03-01 13:10:22480void DisplayDebugMessageInDialog(const std::string& str) {
initial.commitd7cae122008-07-26 21:49:38481 if (str.empty())
482 return;
483
[email protected]81e0a852010-08-17 00:38:12484 if (!show_error_dialogs)
[email protected]846ed9c32010-07-29 20:33:44485 return;
486
[email protected]f6abeba2008-08-08 13:27:28487#if defined(OS_WIN)
[email protected]d81baca42010-03-01 13:10:22488 // For Windows programs, it's possible that the message loop is
489 // messed up on a fatal error, and creating a MessageBox will cause
490 // that message loop to be run. Instead, we try to spawn another
491 // process that displays its command line. We look for "Debug
492 // Message.exe" in the same directory as the application. If it
493 // exists, we use it, otherwise, we use a regular message box.
initial.commitd7cae122008-07-26 21:49:38494 wchar_t prog_name[MAX_PATH];
495 GetModuleFileNameW(NULL, prog_name, MAX_PATH);
496 wchar_t* backslash = wcsrchr(prog_name, '\\');
497 if (backslash)
498 backslash[1] = 0;
499 wcscat_s(prog_name, MAX_PATH, L"debug_message.exe");
500
[email protected]047a03f2009-10-07 02:10:20501 std::wstring cmdline = UTF8ToWide(str);
[email protected]3ca4214c12009-03-25 22:12:02502 if (cmdline.empty())
503 return;
initial.commitd7cae122008-07-26 21:49:38504
505 STARTUPINFO startup_info;
506 memset(&startup_info, 0, sizeof(startup_info));
507 startup_info.cb = sizeof(startup_info);
508
509 PROCESS_INFORMATION process_info;
[email protected]3ca4214c12009-03-25 22:12:02510 if (CreateProcessW(prog_name, &cmdline[0], NULL, NULL, false, 0, NULL,
initial.commitd7cae122008-07-26 21:49:38511 NULL, &startup_info, &process_info)) {
512 WaitForSingleObject(process_info.hProcess, INFINITE);
513 CloseHandle(process_info.hThread);
514 CloseHandle(process_info.hProcess);
515 } else {
516 // debug process broken, let's just do a message box
[email protected]3ca4214c12009-03-25 22:12:02517 MessageBoxW(NULL, &cmdline[0], L"Fatal error",
initial.commitd7cae122008-07-26 21:49:38518 MB_OK | MB_ICONHAND | MB_TOPMOST);
519 }
[email protected]f6abeba2008-08-08 13:27:28520#else
[email protected]561513f2010-12-16 23:29:25521 // We intentionally don't implement a dialog on other platforms.
522 // You can just look at stderr.
[email protected]f6abeba2008-08-08 13:27:28523#endif
initial.commitd7cae122008-07-26 21:49:38524}
525
[email protected]3f85caa2009-04-14 16:52:11526#if defined(OS_WIN)
527LogMessage::SaveLastError::SaveLastError() : last_error_(::GetLastError()) {
528}
529
530LogMessage::SaveLastError::~SaveLastError() {
531 ::SetLastError(last_error_);
532}
533#endif // defined(OS_WIN)
534
initial.commitd7cae122008-07-26 21:49:38535LogMessage::LogMessage(const char* file, int line, LogSeverity severity,
536 int ctr)
[email protected]162ac0f2010-11-04 15:50:49537 : severity_(severity), file_(file), line_(line) {
initial.commitd7cae122008-07-26 21:49:38538 Init(file, line);
539}
540
[email protected]eae9c062011-01-11 00:50:59541LogMessage::LogMessage(const char* file, int line)
542 : severity_(LOG_INFO), file_(file), line_(line) {
543 Init(file, line);
544}
545
546LogMessage::LogMessage(const char* file, int line, LogSeverity severity)
547 : severity_(severity), file_(file), line_(line) {
548 Init(file, line);
549}
550
[email protected]9c7132e2011-02-08 07:39:08551LogMessage::LogMessage(const char* file, int line, std::string* result)
[email protected]162ac0f2010-11-04 15:50:49552 : severity_(LOG_FATAL), file_(file), line_(line) {
initial.commitd7cae122008-07-26 21:49:38553 Init(file, line);
[email protected]9c7132e2011-02-08 07:39:08554 stream_ << "Check failed: " << *result;
555 delete result;
initial.commitd7cae122008-07-26 21:49:38556}
557
[email protected]fb62a532009-02-12 01:19:05558LogMessage::LogMessage(const char* file, int line, LogSeverity severity,
[email protected]9c7132e2011-02-08 07:39:08559 std::string* result)
[email protected]162ac0f2010-11-04 15:50:49560 : severity_(severity), file_(file), line_(line) {
[email protected]fb62a532009-02-12 01:19:05561 Init(file, line);
[email protected]9c7132e2011-02-08 07:39:08562 stream_ << "Check failed: " << *result;
563 delete result;
[email protected]fb62a532009-02-12 01:19:05564}
565
initial.commitd7cae122008-07-26 21:49:38566LogMessage::~LogMessage() {
[email protected]3132e35c2011-07-07 20:46:50567 // TODO(port): enable stacktrace generation on LOG_FATAL once backtrace are
568 // working in Android.
[email protected]380d8322012-02-28 21:35:44569#if !defined(NDEBUG) && !defined(OS_ANDROID) && !defined(OS_NACL)
[email protected]d1ccc35a2010-03-24 05:03:24570 if (severity_ == LOG_FATAL) {
571 // Include a stack trace on a fatal.
[email protected]58580352010-10-26 04:07:50572 base::debug::StackTrace trace;
[email protected]d1ccc35a2010-03-24 05:03:24573 stream_ << std::endl; // Newline to separate from log message.
574 trace.OutputToStream(&stream_);
575 }
[email protected]1d8c2702008-08-19 23:39:32576#endif
[email protected]d1ccc35a2010-03-24 05:03:24577 stream_ << std::endl;
578 std::string str_newline(stream_.str());
579
[email protected]2b07b8412009-11-25 15:26:34580 // Give any log message handler first dibs on the message.
[email protected]162ac0f2010-11-04 15:50:49581 if (log_message_handler && log_message_handler(severity_, file_, line_,
582 message_start_, str_newline)) {
583 // The handler took care of it, no further processing.
[email protected]2b07b8412009-11-25 15:26:34584 return;
[email protected]162ac0f2010-11-04 15:50:49585 }
initial.commitd7cae122008-07-26 21:49:38586
initial.commitd7cae122008-07-26 21:49:38587 if (logging_destination == LOG_ONLY_TO_SYSTEM_DEBUG_LOG ||
[email protected]f6abeba2008-08-08 13:27:28588 logging_destination == LOG_TO_BOTH_FILE_AND_SYSTEM_DEBUG_LOG) {
589#if defined(OS_WIN)
initial.commitd7cae122008-07-26 21:49:38590 OutputDebugStringA(str_newline.c_str());
[email protected]3132e35c2011-07-07 20:46:50591#elif defined(OS_ANDROID)
[email protected]efbae7da2013-05-21 22:39:25592 android_LogPriority priority =
593 (severity_ < 0) ? ANDROID_LOG_VERBOSE : ANDROID_LOG_UNKNOWN;
[email protected]3132e35c2011-07-07 20:46:50594 switch (severity_) {
595 case LOG_INFO:
596 priority = ANDROID_LOG_INFO;
597 break;
598 case LOG_WARNING:
599 priority = ANDROID_LOG_WARN;
600 break;
601 case LOG_ERROR:
602 case LOG_ERROR_REPORT:
603 priority = ANDROID_LOG_ERROR;
604 break;
605 case LOG_FATAL:
606 priority = ANDROID_LOG_FATAL;
607 break;
608 }
609 __android_log_write(priority, "chromium", str_newline.c_str());
[email protected]107bc0f12008-08-26 17:48:18610#endif
[email protected]469006c2010-09-24 15:43:06611 fprintf(stderr, "%s", str_newline.c_str());
612 fflush(stderr);
[email protected]a33c9892008-08-25 20:10:31613 } else if (severity_ >= kAlwaysPrintErrorLevel) {
614 // When we're only outputting to a log file, above a certain log level, we
615 // should still output to stderr so that we can better detect and diagnose
616 // problems with unit tests, especially on the buildbots.
617 fprintf(stderr, "%s", str_newline.c_str());
[email protected]1ce41052009-12-02 00:34:02618 fflush(stderr);
[email protected]f6abeba2008-08-08 13:27:28619 }
[email protected]52a261f2009-03-03 15:01:12620
[email protected]5b84fe32010-09-14 22:24:55621 // We can have multiple threads and/or processes, so try to prevent them
622 // from clobbering each other's writes.
623 // If the client app did not call InitLogging, and the lock has not
624 // been created do it now. We do this on demand, but if two threads try
625 // to do this at the same time, there will be a race condition to create
626 // the lock. This is why InitLogging should be called from the main
627 // thread at the beginning of execution.
628 LoggingLock::Init(LOCK_LOG_FILE, NULL);
initial.commitd7cae122008-07-26 21:49:38629 // write to log file
630 if (logging_destination != LOG_NONE &&
[email protected]5b84fe32010-09-14 22:24:55631 logging_destination != LOG_ONLY_TO_SYSTEM_DEBUG_LOG) {
632 LoggingLock logging_lock;
633 if (InitializeLogFileHandle()) {
[email protected]f6abeba2008-08-08 13:27:28634#if defined(OS_WIN)
[email protected]5b84fe32010-09-14 22:24:55635 SetFilePointer(log_file, 0, 0, SEEK_END);
636 DWORD num_written;
637 WriteFile(log_file,
638 static_cast<const void*>(str_newline.c_str()),
639 static_cast<DWORD>(str_newline.length()),
640 &num_written,
641 NULL);
[email protected]cba21962010-08-31 22:35:55642#else
[email protected]5b84fe32010-09-14 22:24:55643 fprintf(log_file, "%s", str_newline.c_str());
644 fflush(log_file);
[email protected]cba21962010-08-31 22:35:55645#endif
initial.commitd7cae122008-07-26 21:49:38646 }
647 }
648
649 if (severity_ == LOG_FATAL) {
[email protected]eb4c4d032012-04-03 18:45:05650 // Ensure the first characters of the string are on the stack so they
651 // are contained in minidumps for diagnostic purposes.
652 char str_stack[1024];
653 str_newline.copy(str_stack, arraysize(str_stack));
654 base::debug::Alias(str_stack);
655
initial.commitd7cae122008-07-26 21:49:38656 // display a message or break into the debugger on a fatal error
[email protected]58580352010-10-26 04:07:50657 if (base::debug::BeingDebugged()) {
658 base::debug::BreakDebugger();
[email protected]1ffe08c12008-08-13 11:15:11659 } else {
initial.commitd7cae122008-07-26 21:49:38660 if (log_assert_handler) {
661 // make a copy of the string for the handler out of paranoia
662 log_assert_handler(std::string(stream_.str()));
663 } else {
[email protected]4d5901272008-11-06 00:33:50664 // Don't use the string with the newline, get a fresh version to send to
665 // the debug message process. We also don't display assertions to the
666 // user in release mode. The enduser can't do anything with this
667 // information, and displaying message boxes when the application is
668 // hosed can cause additional problems.
669#ifndef NDEBUG
[email protected]d81baca42010-03-01 13:10:22670 DisplayDebugMessageInDialog(stream_.str());
[email protected]4d5901272008-11-06 00:33:50671#endif
initial.commitd7cae122008-07-26 21:49:38672 // Crash the process to generate a dump.
[email protected]58580352010-10-26 04:07:50673 base::debug::BreakDebugger();
initial.commitd7cae122008-07-26 21:49:38674 }
675 }
[email protected]fb62a532009-02-12 01:19:05676 } else if (severity_ == LOG_ERROR_REPORT) {
677 // We are here only if the user runs with --enable-dcheck in release mode.
678 if (log_report_handler) {
679 log_report_handler(std::string(stream_.str()));
680 } else {
[email protected]d81baca42010-03-01 13:10:22681 DisplayDebugMessageInDialog(stream_.str());
[email protected]fb62a532009-02-12 01:19:05682 }
initial.commitd7cae122008-07-26 21:49:38683 }
684}
685
[email protected]eae9c062011-01-11 00:50:59686// writes the common header info to the stream
687void LogMessage::Init(const char* file, int line) {
688 base::StringPiece filename(file);
689 size_t last_slash_pos = filename.find_last_of("\\/");
690 if (last_slash_pos != base::StringPiece::npos)
691 filename.remove_prefix(last_slash_pos + 1);
692
693 // TODO(darin): It might be nice if the columns were fixed width.
694
695 stream_ << '[';
696 if (log_process_id)
697 stream_ << CurrentProcessId() << ':';
698 if (log_thread_id)
[email protected]63e66802012-01-18 21:21:09699 stream_ << base::PlatformThread::CurrentId() << ':';
[email protected]eae9c062011-01-11 00:50:59700 if (log_timestamp) {
701 time_t t = time(NULL);
702 struct tm local_time = {0};
703#if _MSC_VER >= 1400
704 localtime_s(&local_time, &t);
705#else
706 localtime_r(&t, &local_time);
707#endif
708 struct tm* tm_time = &local_time;
709 stream_ << std::setfill('0')
710 << std::setw(2) << 1 + tm_time->tm_mon
711 << std::setw(2) << tm_time->tm_mday
712 << '/'
713 << std::setw(2) << tm_time->tm_hour
714 << std::setw(2) << tm_time->tm_min
715 << std::setw(2) << tm_time->tm_sec
716 << ':';
717 }
718 if (log_tickcount)
719 stream_ << TickCount() << ':';
720 if (severity_ >= 0)
721 stream_ << log_severity_names[severity_];
722 else
723 stream_ << "VERBOSE" << -severity_;
724
725 stream_ << ":" << filename << "(" << line << ")] ";
726
727 message_start_ = stream_.tellp();
728}
729
[email protected]d8617a62009-10-09 23:52:20730#if defined(OS_WIN)
731// This has already been defined in the header, but defining it again as DWORD
732// ensures that the type used in the header is equivalent to DWORD. If not,
733// the redefinition is a compile error.
734typedef DWORD SystemErrorCode;
735#endif
736
737SystemErrorCode GetLastSystemErrorCode() {
738#if defined(OS_WIN)
739 return ::GetLastError();
740#elif defined(OS_POSIX)
741 return errno;
742#else
743#error Not implemented
744#endif
745}
746
747#if defined(OS_WIN)
748Win32ErrorLogMessage::Win32ErrorLogMessage(const char* file,
749 int line,
750 LogSeverity severity,
751 SystemErrorCode err,
752 const char* module)
753 : err_(err),
754 module_(module),
755 log_message_(file, line, severity) {
756}
757
758Win32ErrorLogMessage::Win32ErrorLogMessage(const char* file,
759 int line,
760 LogSeverity severity,
761 SystemErrorCode err)
762 : err_(err),
763 module_(NULL),
764 log_message_(file, line, severity) {
765}
766
767Win32ErrorLogMessage::~Win32ErrorLogMessage() {
768 const int error_message_buffer_size = 256;
769 char msgbuf[error_message_buffer_size];
[email protected]6ac3df52010-10-20 01:33:32770 DWORD flags = FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS;
[email protected]d8617a62009-10-09 23:52:20771 HMODULE hmod;
772 if (module_) {
773 hmod = GetModuleHandleA(module_);
774 if (hmod) {
775 flags |= FORMAT_MESSAGE_FROM_HMODULE;
776 } else {
777 // This makes a nested Win32ErrorLogMessage. It will have module_ of NULL
778 // so it will not call GetModuleHandle, so recursive errors are
779 // impossible.
780 DPLOG(WARNING) << "Couldn't open module " << module_
781 << " for error message query";
782 }
783 } else {
784 hmod = NULL;
785 }
786 DWORD len = FormatMessageA(flags,
787 hmod,
788 err_,
[email protected]6ac3df52010-10-20 01:33:32789 0,
[email protected]d8617a62009-10-09 23:52:20790 msgbuf,
791 sizeof(msgbuf) / sizeof(msgbuf[0]),
792 NULL);
793 if (len) {
794 while ((len > 0) &&
795 isspace(static_cast<unsigned char>(msgbuf[len - 1]))) {
796 msgbuf[--len] = 0;
797 }
798 stream() << ": " << msgbuf;
799 } else {
800 stream() << ": Error " << GetLastError() << " while retrieving error "
801 << err_;
802 }
[email protected]20909e72012-04-05 16:57:06803 // We're about to crash (CHECK). Put |err_| on the stack (by placing it in a
804 // field) and use Alias in hopes that it makes it into crash dumps.
805 DWORD last_error = err_;
806 base::debug::Alias(&last_error);
[email protected]d8617a62009-10-09 23:52:20807}
808#elif defined(OS_POSIX)
809ErrnoLogMessage::ErrnoLogMessage(const char* file,
810 int line,
811 LogSeverity severity,
812 SystemErrorCode err)
813 : err_(err),
814 log_message_(file, line, severity) {
815}
816
817ErrnoLogMessage::~ErrnoLogMessage() {
818 stream() << ": " << safe_strerror(err_);
819}
820#endif // OS_WIN
821
initial.commitd7cae122008-07-26 21:49:38822void CloseLogFile() {
[email protected]5b84fe32010-09-14 22:24:55823 LoggingLock logging_lock;
824
initial.commitd7cae122008-07-26 21:49:38825 if (!log_file)
826 return;
827
[email protected]f6abeba2008-08-08 13:27:28828 CloseFile(log_file);
initial.commitd7cae122008-07-26 21:49:38829 log_file = NULL;
830}
831
[email protected]e36ddc82009-12-08 04:22:50832void RawLog(int level, const char* message) {
833 if (level >= min_log_level) {
834 size_t bytes_written = 0;
835 const size_t message_len = strlen(message);
836 int rv;
837 while (bytes_written < message_len) {
838 rv = HANDLE_EINTR(
839 write(STDERR_FILENO, message + bytes_written,
840 message_len - bytes_written));
841 if (rv < 0) {
842 // Give up, nothing we can do now.
843 break;
844 }
845 bytes_written += rv;
846 }
847
848 if (message_len > 0 && message[message_len - 1] != '\n') {
849 do {
850 rv = HANDLE_EINTR(write(STDERR_FILENO, "\n", 1));
851 if (rv < 0) {
852 // Give up, nothing we can do now.
853 break;
854 }
855 } while (rv != 1);
856 }
857 }
858
859 if (level == LOG_FATAL)
[email protected]58580352010-10-26 04:07:50860 base::debug::BreakDebugger();
[email protected]e36ddc82009-12-08 04:22:50861}
862
[email protected]34a907732012-01-20 06:33:27863// This was defined at the beginning of this file.
864#undef write
865
[email protected]f01b88a2013-02-27 22:04:00866#if defined(OS_WIN)
867std::wstring GetLogFileFullPath() {
868 if (log_file_name)
869 return *log_file_name;
870 return std::wstring();
871}
872#endif
873
[email protected]96fd0032009-04-24 00:13:08874} // namespace logging
initial.commitd7cae122008-07-26 21:49:38875
876std::ostream& operator<<(std::ostream& out, const wchar_t* wstr) {
[email protected]047a03f2009-10-07 02:10:20877 return out << WideToUTF8(std::wstring(wstr));
initial.commitd7cae122008-07-26 21:49:38878}