blob: d30b2194f50f0679001886b88002405b7f332bfb [file] [log] [blame]
rsesek@chromium.org4fd393b2012-01-19 06:21:09 +09001// Copyright (c) 2012 The Chromium Authors. All rights reserved.
license.botf003cfe2008-08-24 09:55:55 +09002// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
initial.commit3f4a7322008-07-27 06:49:38 +09004
darin@google.com12d40bb2008-08-20 03:36:23 +09005#include "base/logging.h"
pinkerton@google.com56053fe2008-08-08 22:27:28 +09006
darin@google.com12d40bb2008-08-20 03:36:23 +09007#if defined(OS_WIN)
willchan@chromium.org85113a12009-12-08 13:22:50 +09008#include <io.h>
pinkerton@google.com56053fe2008-08-08 22:27:28 +09009#include <windows.h>
10typedef HANDLE FileHandle;
11typedef HANDLE MutexHandle;
willchan@chromium.org85113a12009-12-08 13:22:50 +090012// 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
estade@chromium.orgf7855502008-11-07 06:43:07 +090016#elif defined(OS_MACOSX)
pinkerton@google.com56053fe2008-08-08 22:27:28 +090017#include <mach/mach.h>
18#include <mach/mach_time.h>
19#include <mach-o/dyld.h>
evan@chromium.org875bb6e2009-12-29 09:32:52 +090020#elif defined(OS_POSIX)
abarth@chromium.orge7162862010-11-12 17:37:08 +090021#if defined(OS_NACL)
abarth@chromium.orge7162862010-11-12 17:37:08 +090022#include <sys/time.h> // timespec doesn't seem to be in <time.h>
23#else
estade@chromium.orgf7855502008-11-07 06:43:07 +090024#include <sys/syscall.h>
abarth@chromium.orge7162862010-11-12 17:37:08 +090025#endif
estade@chromium.orgf7855502008-11-07 06:43:07 +090026#include <time.h>
evanm@google.com4487dd72008-08-12 07:52:59 +090027#endif
28
29#if defined(OS_POSIX)
tschmelcher@chromium.orgf29a4fc2009-10-10 08:52:20 +090030#include <errno.h>
bulach@chromium.org6d1153e2010-08-06 00:50:23 +090031#include <pthread.h>
pinkerton@google.com56053fe2008-08-08 22:27:28 +090032#include <stdlib.h>
33#include <stdio.h>
34#include <string.h>
35#include <unistd.h>
36#define MAX_PATH PATH_MAX
37typedef FILE* FileHandle;
38typedef pthread_mutex_t* MutexHandle;
39#endif
40
rvargas@google.comfa62cd22011-04-01 09:02:29 +090041#include <algorithm>
42#include <cstring>
initial.commit3f4a7322008-07-27 06:49:38 +090043#include <ctime>
44#include <iomanip>
rvargas@google.comfa62cd22011-04-01 09:02:29 +090045#include <ostream>
darin@google.com12d40bb2008-08-20 03:36:23 +090046
initial.commit3f4a7322008-07-27 06:49:38 +090047#include "base/base_switches.h"
48#include "base/command_line.h"
apatrick@chromium.org35e38992012-04-04 03:45:05 +090049#include "base/debug/alias.h"
brettw@chromium.org2f49b122010-10-26 13:07:50 +090050#include "base/debug/debugger.h"
51#include "base/debug/stack_trace.h"
willchan@chromium.org85113a12009-12-08 13:22:50 +090052#include "base/eintr_wrapper.h"
deanm@google.coma65ec9f2008-08-19 22:19:24 +090053#include "base/string_piece.h"
brettw@chromium.orge439a962011-01-02 08:16:20 +090054#include "base/synchronization/lock_impl.h"
rsesek@chromium.org4fd393b2012-01-19 06:21:09 +090055#include "base/threading/platform_thread.h"
brettw@chromium.org50c94652009-10-07 11:10:20 +090056#include "base/utf_string_conversions.h"
akalin@chromium.orgf0ee79c2010-09-30 04:26:36 +090057#include "base/vlog.h"
dmaclach@chromium.org3cae3402010-12-15 01:20:04 +090058#if defined(OS_POSIX)
59#include "base/safe_strerror_posix.h"
60#endif
maruel@chromium.org8fe7adc2009-03-04 00:01:12 +090061
michaelbai@google.com01ef2f22011-07-08 05:46:50 +090062#if defined(OS_ANDROID)
63#include <android/log.h>
64#endif
65
initial.commit3f4a7322008-07-27 06:49:38 +090066namespace logging {
67
akalin@chromium.orgfaed5f82011-01-11 10:03:36 +090068DcheckState g_dcheck_state = DISABLE_DCHECK_FOR_NON_OFFICIAL_RELEASE_BUILDS;
stevenjb@chromium.org6c56fa42011-12-03 09:30:08 +090069
70namespace {
71
akalin@chromium.orgf0ee79c2010-09-30 04:26:36 +090072VlogInfo* g_vlog_info = NULL;
stevenjb@chromium.org6c56fa42011-12-03 09:30:08 +090073VlogInfo* g_vlog_info_prev = NULL;
initial.commit3f4a7322008-07-27 06:49:38 +090074
75const char* const log_severity_names[LOG_NUM_SEVERITIES] = {
huanr@chromium.org656253e2009-02-12 10:19:05 +090076 "INFO", "WARNING", "ERROR", "ERROR_REPORT", "FATAL" };
initial.commit3f4a7322008-07-27 06:49:38 +090077
78int min_log_level = 0;
mmentovai@google.comf0944f32008-08-20 08:39:32 +090079
80// The default set here for logging_destination will only be used if
81// InitLogging is not called. On Windows, use a file next to the exe;
82// on POSIX platforms, where it may not even be possible to locate the
83// executable on disk, use stderr.
evanm@google.come41d3b32008-08-15 10:04:11 +090084#if defined(OS_WIN)
mmentovai@google.com0f8dd7e2008-08-23 02:09:34 +090085LoggingDestination logging_destination = LOG_ONLY_TO_FILE;
evanm@google.come41d3b32008-08-15 10:04:11 +090086#elif defined(OS_POSIX)
mmentovai@google.comf0944f32008-08-20 08:39:32 +090087LoggingDestination logging_destination = LOG_ONLY_TO_SYSTEM_DEBUG_LOG;
evanm@google.come41d3b32008-08-15 10:04:11 +090088#endif
initial.commit3f4a7322008-07-27 06:49:38 +090089
erikkay@google.coma1ca46c2008-08-26 05:10:31 +090090// For LOG_ERROR and above, always print to stderr.
91const int kAlwaysPrintErrorLevel = LOG_ERROR;
92
evanm@google.com4487dd72008-08-12 07:52:59 +090093// Which log file to use? This is initialized by InitLogging or
initial.commit3f4a7322008-07-27 06:49:38 +090094// will be lazily initialized to the default value when it is
95// first needed.
pinkerton@google.com56053fe2008-08-08 22:27:28 +090096#if defined(OS_WIN)
evanm@google.com4487dd72008-08-12 07:52:59 +090097typedef std::wstring PathString;
pinkerton@google.com56053fe2008-08-08 22:27:28 +090098#else
evanm@google.com4487dd72008-08-12 07:52:59 +090099typedef std::string PathString;
pinkerton@google.com56053fe2008-08-08 22:27:28 +0900100#endif
evanm@google.com4487dd72008-08-12 07:52:59 +0900101PathString* log_file_name = NULL;
initial.commit3f4a7322008-07-27 06:49:38 +0900102
103// this file is lazily opened and the handle may be NULL
pinkerton@google.com56053fe2008-08-08 22:27:28 +0900104FileHandle log_file = NULL;
initial.commit3f4a7322008-07-27 06:49:38 +0900105
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
cmasone@google.comf7802482010-08-17 09:38:12 +0900112// Should we pop up fatal debug messages in a dialog?
113bool show_error_dialogs = false;
114
initial.commit3f4a7322008-07-27 06:49:38 +0900115// An assert handler override specified by the client to be called instead of
huanr@chromium.org656253e2009-02-12 10:19:05 +0900116// the debug message dialog and process termination.
initial.commit3f4a7322008-07-27 06:49:38 +0900117LogAssertHandlerFunction log_assert_handler = NULL;
huanr@chromium.org656253e2009-02-12 10:19:05 +0900118// An report handler override specified by the client to be called instead of
119// the debug message dialog.
120LogReportHandlerFunction log_report_handler = NULL;
siggi@chromium.org4db65792009-11-26 00:26:34 +0900121// A log message handler that gets notified of every log message we process.
122LogMessageHandlerFunction log_message_handler = NULL;
initial.commit3f4a7322008-07-27 06:49:38 +0900123
pinkerton@google.com56053fe2008-08-08 22:27:28 +0900124// Helper functions to wrap platform differences.
125
estade@chromium.org1160a8b2008-11-06 08:17:24 +0900126int32 CurrentProcessId() {
127#if defined(OS_WIN)
128 return GetCurrentProcessId();
129#elif defined(OS_POSIX)
130 return getpid();
131#endif
132}
133
estade@chromium.org1160a8b2008-11-06 08:17:24 +0900134uint64 TickCount() {
135#if defined(OS_WIN)
136 return GetTickCount();
137#elif defined(OS_MACOSX)
138 return mach_absolute_time();
abarth@chromium.orge7162862010-11-12 17:37:08 +0900139#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();
evan@chromium.org875bb6e2009-12-29 09:32:52 +0900143#elif defined(OS_POSIX)
estade@chromium.orgf7855502008-11-07 06:43:07 +0900144 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;
estade@chromium.org1160a8b2008-11-06 08:17:24 +0900152#endif
153}
154
pinkerton@google.com56053fe2008-08-08 22:27:28 +0900155void CloseFile(FileHandle log) {
156#if defined(OS_WIN)
157 CloseHandle(log);
158#else
159 fclose(log);
160#endif
161}
162
evanm@google.com4487dd72008-08-12 07:52:59 +0900163void DeleteFilePath(const PathString& log_name) {
pinkerton@google.com56053fe2008-08-08 22:27:28 +0900164#if defined(OS_WIN)
evanm@google.com4487dd72008-08-12 07:52:59 +0900165 DeleteFile(log_name.c_str());
pinkerton@google.com56053fe2008-08-08 22:27:28 +0900166#else
evanm@google.com4487dd72008-08-12 07:52:59 +0900167 unlink(log_name.c_str());
pinkerton@google.com56053fe2008-08-08 22:27:28 +0900168#endif
169}
initial.commit3f4a7322008-07-27 06:49:38 +0900170
hansl@google.com6a29af52010-10-02 02:16:58 +0900171PathString GetDefaultLogFile() {
davemoore@chromium.orgc4dae762010-09-15 07:24:55 +0900172#if defined(OS_WIN)
173 // On Windows we use the same path as the exe.
174 wchar_t module_name[MAX_PATH];
175 GetModuleFileName(NULL, module_name, MAX_PATH);
hansl@google.com6a29af52010-10-02 02:16:58 +0900176
177 PathString log_file = module_name;
178 PathString::size_type last_backslash =
179 log_file.rfind('\\', log_file.size());
180 if (last_backslash != PathString::npos)
181 log_file.erase(last_backslash + 1);
182 log_file += L"debug.log";
183 return log_file;
davemoore@chromium.orgc4dae762010-09-15 07:24:55 +0900184#elif defined(OS_POSIX)
185 // On other platforms we just use the current directory.
hansl@google.com6a29af52010-10-02 02:16:58 +0900186 return PathString("debug.log");
davemoore@chromium.orgc4dae762010-09-15 07:24:55 +0900187#endif
188}
189
190// This class acts as a wrapper for locking the logging files.
191// LoggingLock::Init() should be called from the main thread before any logging
192// is done. Then whenever logging, be sure to have a local LoggingLock
193// instance on the stack. This will ensure that the lock is unlocked upon
194// exiting the frame.
195// LoggingLocks can not be nested.
196class LoggingLock {
197 public:
198 LoggingLock() {
199 LockLogging();
200 }
201
202 ~LoggingLock() {
203 UnlockLogging();
204 }
205
206 static void Init(LogLockingState lock_log, const PathChar* new_log_file) {
207 if (initialized)
208 return;
209 lock_log_file = lock_log;
210 if (lock_log_file == LOCK_LOG_FILE) {
211#if defined(OS_WIN)
212 if (!log_mutex) {
213 std::wstring safe_name;
214 if (new_log_file)
215 safe_name = new_log_file;
216 else
hansl@google.com6a29af52010-10-02 02:16:58 +0900217 safe_name = GetDefaultLogFile();
davemoore@chromium.orgc4dae762010-09-15 07:24:55 +0900218 // \ is not a legal character in mutex names so we replace \ with /
219 std::replace(safe_name.begin(), safe_name.end(), '\\', '/');
220 std::wstring t(L"Global\\");
221 t.append(safe_name);
222 log_mutex = ::CreateMutex(NULL, FALSE, t.c_str());
hansl@google.com6a29af52010-10-02 02:16:58 +0900223
224 if (log_mutex == NULL) {
225#if DEBUG
226 // Keep the error code for debugging
227 int error = GetLastError(); // NOLINT
brettw@chromium.org2f49b122010-10-26 13:07:50 +0900228 base::debug::BreakDebugger();
hansl@google.com6a29af52010-10-02 02:16:58 +0900229#endif
230 // Return nicely without putting initialized to true.
231 return;
232 }
davemoore@chromium.orgc4dae762010-09-15 07:24:55 +0900233 }
234#endif
235 } else {
brettw@chromium.orge439a962011-01-02 08:16:20 +0900236 log_lock = new base::internal::LockImpl();
davemoore@chromium.orgc4dae762010-09-15 07:24:55 +0900237 }
238 initialized = true;
239 }
240
241 private:
242 static void LockLogging() {
243 if (lock_log_file == LOCK_LOG_FILE) {
244#if defined(OS_WIN)
245 ::WaitForSingleObject(log_mutex, INFINITE);
246 // WaitForSingleObject could have returned WAIT_ABANDONED. We don't
247 // abort the process here. UI tests might be crashy sometimes,
248 // and aborting the test binary only makes the problem worse.
249 // We also don't use LOG macros because that might lead to an infinite
250 // loop. For more info see http://crbug.com/18028.
251#elif defined(OS_POSIX)
252 pthread_mutex_lock(&log_mutex);
253#endif
254 } else {
255 // use the lock
256 log_lock->Lock();
257 }
258 }
259
260 static void UnlockLogging() {
261 if (lock_log_file == LOCK_LOG_FILE) {
262#if defined(OS_WIN)
263 ReleaseMutex(log_mutex);
264#elif defined(OS_POSIX)
265 pthread_mutex_unlock(&log_mutex);
266#endif
267 } else {
268 log_lock->Unlock();
269 }
270 }
271
272 // The lock is used if log file locking is false. It helps us avoid problems
273 // with multiple threads writing to the log file at the same time. Use
274 // LockImpl directly instead of using Lock, because Lock makes logging calls.
brettw@chromium.orge439a962011-01-02 08:16:20 +0900275 static base::internal::LockImpl* log_lock;
davemoore@chromium.orgc4dae762010-09-15 07:24:55 +0900276
277 // When we don't use a lock, we are using a global mutex. We need to do this
278 // because LockFileEx is not thread safe.
279#if defined(OS_WIN)
280 static MutexHandle log_mutex;
281#elif defined(OS_POSIX)
282 static pthread_mutex_t log_mutex;
283#endif
284
285 static bool initialized;
286 static LogLockingState lock_log_file;
287};
288
289// static
290bool LoggingLock::initialized = false;
291// static
brettw@chromium.orge439a962011-01-02 08:16:20 +0900292base::internal::LockImpl* LoggingLock::log_lock = NULL;
davemoore@chromium.orgc4dae762010-09-15 07:24:55 +0900293// static
294LogLockingState LoggingLock::lock_log_file = LOCK_LOG_FILE;
295
296#if defined(OS_WIN)
297// static
298MutexHandle LoggingLock::log_mutex = NULL;
299#elif defined(OS_POSIX)
300pthread_mutex_t LoggingLock::log_mutex = PTHREAD_MUTEX_INITIALIZER;
301#endif
302
initial.commit3f4a7322008-07-27 06:49:38 +0900303// Called by logging functions to ensure that debug_file is initialized
304// and can be used for writing. Returns false if the file could not be
305// initialized. debug_file will be NULL in this case.
306bool InitializeLogFileHandle() {
307 if (log_file)
308 return true;
309
evanm@google.com4487dd72008-08-12 07:52:59 +0900310 if (!log_file_name) {
311 // Nobody has called InitLogging to specify a debug log file, so here we
312 // initialize the log file name to a default.
hansl@google.com6a29af52010-10-02 02:16:58 +0900313 log_file_name = new PathString(GetDefaultLogFile());
initial.commit3f4a7322008-07-27 06:49:38 +0900314 }
315
mmentovai@google.comf0944f32008-08-20 08:39:32 +0900316 if (logging_destination == LOG_ONLY_TO_FILE ||
317 logging_destination == LOG_TO_BOTH_FILE_AND_SYSTEM_DEBUG_LOG) {
evanm@google.com4487dd72008-08-12 07:52:59 +0900318#if defined(OS_WIN)
mmentovai@google.comf0944f32008-08-20 08:39:32 +0900319 log_file = CreateFile(log_file_name->c_str(), GENERIC_WRITE,
initial.commit3f4a7322008-07-27 06:49:38 +0900320 FILE_SHARE_READ | FILE_SHARE_WRITE, NULL,
321 OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
322 if (log_file == INVALID_HANDLE_VALUE || log_file == NULL) {
mmentovai@google.comf0944f32008-08-20 08:39:32 +0900323 // try the current directory
324 log_file = CreateFile(L".\\debug.log", GENERIC_WRITE,
325 FILE_SHARE_READ | FILE_SHARE_WRITE, NULL,
326 OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
327 if (log_file == INVALID_HANDLE_VALUE || log_file == NULL) {
328 log_file = NULL;
329 return false;
330 }
initial.commit3f4a7322008-07-27 06:49:38 +0900331 }
mmentovai@google.comf0944f32008-08-20 08:39:32 +0900332 SetFilePointer(log_file, 0, 0, FILE_END);
dkegel@google.com43c36742009-06-09 08:29:11 +0900333#elif defined(OS_POSIX)
334 log_file = fopen(log_file_name->c_str(), "a");
335 if (log_file == NULL)
336 return false;
pinkerton@google.com56053fe2008-08-08 22:27:28 +0900337#endif
mmentovai@google.comf0944f32008-08-20 08:39:32 +0900338 }
339
initial.commit3f4a7322008-07-27 06:49:38 +0900340 return true;
341}
342
stevenjb@chromium.org6c56fa42011-12-03 09:30:08 +0900343} // namespace
344
345
gspencer@chromium.org49c808a2010-10-28 09:20:21 +0900346bool BaseInitLoggingImpl(const PathChar* new_log_file,
derat@chromium.orgb2aa7c42010-08-24 04:57:46 +0900347 LoggingDestination logging_dest,
348 LogLockingState lock_log,
akalin@chromium.orgfaed5f82011-01-11 10:03:36 +0900349 OldFileDeletionState delete_old,
350 DcheckState dcheck_state) {
akalin@chromium.orgfaed5f82011-01-11 10:03:36 +0900351 g_dcheck_state = dcheck_state;
bbudge@chromium.orgd673b622012-02-29 06:35:44 +0900352// TODO(bbudge) Hook this up to NaCl logging.
353#if !defined(OS_NACL)
354 CommandLine* command_line = CommandLine::ForCurrentProcess();
akalin@chromium.orgf0ee79c2010-09-30 04:26:36 +0900355 // Don't bother initializing g_vlog_info unless we use one of the
356 // vlog switches.
357 if (command_line->HasSwitch(switches::kV) ||
358 command_line->HasSwitch(switches::kVModule)) {
stevenjb@chromium.org6c56fa42011-12-03 09:30:08 +0900359 // NOTE: If g_vlog_info has already been initialized, it might be in use
360 // by another thread. Don't delete the old VLogInfo, just create a second
361 // one. We keep track of both to avoid memory leak warnings.
362 CHECK(!g_vlog_info_prev);
363 g_vlog_info_prev = g_vlog_info;
364
akalin@chromium.orgf0ee79c2010-09-30 04:26:36 +0900365 g_vlog_info =
366 new VlogInfo(command_line->GetSwitchValueASCII(switches::kV),
siggi@chromium.org25396e12010-11-05 00:50:49 +0900367 command_line->GetSwitchValueASCII(switches::kVModule),
368 &min_log_level);
akalin@chromium.orgf0ee79c2010-09-30 04:26:36 +0900369 }
370
davemoore@chromium.orgc4dae762010-09-15 07:24:55 +0900371 LoggingLock::Init(lock_log, new_log_file);
372
373 LoggingLock logging_lock;
initial.commit3f4a7322008-07-27 06:49:38 +0900374
375 if (log_file) {
376 // calling InitLogging twice or after some log call has already opened the
377 // default log file will re-initialize to the new options
pinkerton@google.com56053fe2008-08-08 22:27:28 +0900378 CloseFile(log_file);
initial.commit3f4a7322008-07-27 06:49:38 +0900379 log_file = NULL;
380 }
381
initial.commit3f4a7322008-07-27 06:49:38 +0900382 logging_destination = logging_dest;
383
384 // ignore file options if logging is disabled or only to system
385 if (logging_destination == LOG_NONE ||
386 logging_destination == LOG_ONLY_TO_SYSTEM_DEBUG_LOG)
gspencer@chromium.org49c808a2010-10-28 09:20:21 +0900387 return true;
initial.commit3f4a7322008-07-27 06:49:38 +0900388
evanm@google.com4487dd72008-08-12 07:52:59 +0900389 if (!log_file_name)
390 log_file_name = new PathString();
391 *log_file_name = new_log_file;
initial.commit3f4a7322008-07-27 06:49:38 +0900392 if (delete_old == DELETE_OLD_LOG_FILE)
evanm@google.com4487dd72008-08-12 07:52:59 +0900393 DeleteFilePath(*log_file_name);
initial.commit3f4a7322008-07-27 06:49:38 +0900394
gspencer@chromium.org49c808a2010-10-28 09:20:21 +0900395 return InitializeLogFileHandle();
bbudge@chromium.orgd673b622012-02-29 06:35:44 +0900396#else
397 return true;
398#endif // !defined(OS_NACL)
initial.commit3f4a7322008-07-27 06:49:38 +0900399}
400
401void SetMinLogLevel(int level) {
akalin@chromium.org434c5b62010-11-03 14:30:14 +0900402 min_log_level = std::min(LOG_ERROR_REPORT, level);
initial.commit3f4a7322008-07-27 06:49:38 +0900403}
404
405int GetMinLogLevel() {
406 return min_log_level;
407}
408
siggi@chromium.org25396e12010-11-05 00:50:49 +0900409int GetVlogVerbosity() {
410 return std::max(-1, LOG_INFO - GetMinLogLevel());
411}
412
akalin@chromium.orgf0ee79c2010-09-30 04:26:36 +0900413int GetVlogLevelHelper(const char* file, size_t N) {
414 DCHECK_GT(N, 0U);
stevenjb@chromium.org6c56fa42011-12-03 09:30:08 +0900415 // Note: g_vlog_info may change on a different thread during startup
416 // (but will always be valid or NULL).
417 VlogInfo* vlog_info = g_vlog_info;
418 return vlog_info ?
419 vlog_info->GetVlogLevel(base::StringPiece(file, N - 1)) :
siggi@chromium.org25396e12010-11-05 00:50:49 +0900420 GetVlogVerbosity();
akalin@chromium.orgf0ee79c2010-09-30 04:26:36 +0900421}
422
initial.commit3f4a7322008-07-27 06:49:38 +0900423void SetLogItems(bool enable_process_id, bool enable_thread_id,
424 bool enable_timestamp, bool enable_tickcount) {
425 log_process_id = enable_process_id;
426 log_thread_id = enable_thread_id;
427 log_timestamp = enable_timestamp;
428 log_tickcount = enable_tickcount;
429}
430
cmasone@google.comf7802482010-08-17 09:38:12 +0900431void SetShowErrorDialogs(bool enable_dialogs) {
432 show_error_dialogs = enable_dialogs;
433}
434
initial.commit3f4a7322008-07-27 06:49:38 +0900435void SetLogAssertHandler(LogAssertHandlerFunction handler) {
436 log_assert_handler = handler;
437}
438
huanr@chromium.org656253e2009-02-12 10:19:05 +0900439void SetLogReportHandler(LogReportHandlerFunction handler) {
440 log_report_handler = handler;
441}
442
siggi@chromium.org4db65792009-11-26 00:26:34 +0900443void SetLogMessageHandler(LogMessageHandlerFunction handler) {
444 log_message_handler = handler;
445}
446
hansl@google.com519197c2010-11-04 04:20:27 +0900447LogMessageHandlerFunction GetLogMessageHandler() {
448 return log_message_handler;
449}
450
erg@google.com6575f362010-10-01 04:10:03 +0900451// MSVC doesn't like complex extern templates and DLLs.
452#if !defined(COMPILER_MSVC)
453// Explicit instantiations for commonly used comparisons.
454template std::string* MakeCheckOpString<int, int>(
455 const int&, const int&, const char* names);
456template std::string* MakeCheckOpString<unsigned long, unsigned long>(
457 const unsigned long&, const unsigned long&, const char* names);
458template std::string* MakeCheckOpString<unsigned long, unsigned int>(
459 const unsigned long&, const unsigned int&, const char* names);
460template std::string* MakeCheckOpString<unsigned int, unsigned long>(
461 const unsigned int&, const unsigned long&, const char* names);
462template std::string* MakeCheckOpString<std::string, std::string>(
463 const std::string&, const std::string&, const char* name);
464#endif
siggi@chromium.org4db65792009-11-26 00:26:34 +0900465
evan@chromium.org5f1eade2010-03-01 22:10:22 +0900466// Displays a message box to the user with the error message in it.
467// Used for fatal messages, where we close the app simultaneously.
evan@chromium.orge6bd8fa2010-12-17 08:29:25 +0900468// This is for developers only; we don't use this in circumstances
469// (like release builds) where users could see it, since users don't
470// understand these messages anyway.
evan@chromium.org5f1eade2010-03-01 22:10:22 +0900471void DisplayDebugMessageInDialog(const std::string& str) {
initial.commit3f4a7322008-07-27 06:49:38 +0900472 if (str.empty())
473 return;
474
cmasone@google.comf7802482010-08-17 09:38:12 +0900475 if (!show_error_dialogs)
phajdan.jr@chromium.orgd4794e62010-07-30 05:33:44 +0900476 return;
477
pinkerton@google.com56053fe2008-08-08 22:27:28 +0900478#if defined(OS_WIN)
evan@chromium.org5f1eade2010-03-01 22:10:22 +0900479 // For Windows programs, it's possible that the message loop is
480 // messed up on a fatal error, and creating a MessageBox will cause
481 // that message loop to be run. Instead, we try to spawn another
482 // process that displays its command line. We look for "Debug
483 // Message.exe" in the same directory as the application. If it
484 // exists, we use it, otherwise, we use a regular message box.
initial.commit3f4a7322008-07-27 06:49:38 +0900485 wchar_t prog_name[MAX_PATH];
486 GetModuleFileNameW(NULL, prog_name, MAX_PATH);
487 wchar_t* backslash = wcsrchr(prog_name, '\\');
488 if (backslash)
489 backslash[1] = 0;
490 wcscat_s(prog_name, MAX_PATH, L"debug_message.exe");
491
brettw@chromium.org50c94652009-10-07 11:10:20 +0900492 std::wstring cmdline = UTF8ToWide(str);
mark@chromium.orga332aa92009-03-26 07:12:02 +0900493 if (cmdline.empty())
494 return;
initial.commit3f4a7322008-07-27 06:49:38 +0900495
496 STARTUPINFO startup_info;
497 memset(&startup_info, 0, sizeof(startup_info));
498 startup_info.cb = sizeof(startup_info);
499
500 PROCESS_INFORMATION process_info;
mark@chromium.orga332aa92009-03-26 07:12:02 +0900501 if (CreateProcessW(prog_name, &cmdline[0], NULL, NULL, false, 0, NULL,
initial.commit3f4a7322008-07-27 06:49:38 +0900502 NULL, &startup_info, &process_info)) {
503 WaitForSingleObject(process_info.hProcess, INFINITE);
504 CloseHandle(process_info.hThread);
505 CloseHandle(process_info.hProcess);
506 } else {
507 // debug process broken, let's just do a message box
mark@chromium.orga332aa92009-03-26 07:12:02 +0900508 MessageBoxW(NULL, &cmdline[0], L"Fatal error",
initial.commit3f4a7322008-07-27 06:49:38 +0900509 MB_OK | MB_ICONHAND | MB_TOPMOST);
510 }
pinkerton@google.com56053fe2008-08-08 22:27:28 +0900511#else
evan@chromium.orge6bd8fa2010-12-17 08:29:25 +0900512 // We intentionally don't implement a dialog on other platforms.
513 // You can just look at stderr.
pinkerton@google.com56053fe2008-08-08 22:27:28 +0900514#endif
initial.commit3f4a7322008-07-27 06:49:38 +0900515}
516
tommi@google.com82788e12009-04-15 01:52:11 +0900517#if defined(OS_WIN)
518LogMessage::SaveLastError::SaveLastError() : last_error_(::GetLastError()) {
519}
520
521LogMessage::SaveLastError::~SaveLastError() {
522 ::SetLastError(last_error_);
523}
524#endif // defined(OS_WIN)
525
initial.commit3f4a7322008-07-27 06:49:38 +0900526LogMessage::LogMessage(const char* file, int line, LogSeverity severity,
527 int ctr)
siggi@chromium.org25396e12010-11-05 00:50:49 +0900528 : severity_(severity), file_(file), line_(line) {
initial.commit3f4a7322008-07-27 06:49:38 +0900529 Init(file, line);
530}
531
erg@google.com37c078e2011-01-11 09:50:59 +0900532LogMessage::LogMessage(const char* file, int line)
533 : severity_(LOG_INFO), file_(file), line_(line) {
534 Init(file, line);
535}
536
537LogMessage::LogMessage(const char* file, int line, LogSeverity severity)
538 : severity_(severity), file_(file), line_(line) {
539 Init(file, line);
540}
541
akalin@chromium.org63dab762011-02-08 16:39:08 +0900542LogMessage::LogMessage(const char* file, int line, std::string* result)
siggi@chromium.org25396e12010-11-05 00:50:49 +0900543 : severity_(LOG_FATAL), file_(file), line_(line) {
initial.commit3f4a7322008-07-27 06:49:38 +0900544 Init(file, line);
akalin@chromium.org63dab762011-02-08 16:39:08 +0900545 stream_ << "Check failed: " << *result;
546 delete result;
initial.commit3f4a7322008-07-27 06:49:38 +0900547}
548
huanr@chromium.org656253e2009-02-12 10:19:05 +0900549LogMessage::LogMessage(const char* file, int line, LogSeverity severity,
akalin@chromium.org63dab762011-02-08 16:39:08 +0900550 std::string* result)
siggi@chromium.org25396e12010-11-05 00:50:49 +0900551 : severity_(severity), file_(file), line_(line) {
huanr@chromium.org656253e2009-02-12 10:19:05 +0900552 Init(file, line);
akalin@chromium.org63dab762011-02-08 16:39:08 +0900553 stream_ << "Check failed: " << *result;
554 delete result;
huanr@chromium.org656253e2009-02-12 10:19:05 +0900555}
556
initial.commit3f4a7322008-07-27 06:49:38 +0900557LogMessage::~LogMessage() {
michaelbai@google.com01ef2f22011-07-08 05:46:50 +0900558 // TODO(port): enable stacktrace generation on LOG_FATAL once backtrace are
559 // working in Android.
bbudge@chromium.orgd673b622012-02-29 06:35:44 +0900560#if !defined(NDEBUG) && !defined(OS_ANDROID) && !defined(OS_NACL)
oshima@chromium.orgf79db072010-03-24 14:03:24 +0900561 if (severity_ == LOG_FATAL) {
562 // Include a stack trace on a fatal.
brettw@chromium.org2f49b122010-10-26 13:07:50 +0900563 base::debug::StackTrace trace;
oshima@chromium.orgf79db072010-03-24 14:03:24 +0900564 stream_ << std::endl; // Newline to separate from log message.
565 trace.OutputToStream(&stream_);
566 }
mmentovai@google.comf0944f32008-08-20 08:39:32 +0900567#endif
oshima@chromium.orgf79db072010-03-24 14:03:24 +0900568 stream_ << std::endl;
569 std::string str_newline(stream_.str());
570
siggi@chromium.org4db65792009-11-26 00:26:34 +0900571 // Give any log message handler first dibs on the message.
siggi@chromium.org25396e12010-11-05 00:50:49 +0900572 if (log_message_handler && log_message_handler(severity_, file_, line_,
573 message_start_, str_newline)) {
574 // The handler took care of it, no further processing.
siggi@chromium.org4db65792009-11-26 00:26:34 +0900575 return;
siggi@chromium.org25396e12010-11-05 00:50:49 +0900576 }
initial.commit3f4a7322008-07-27 06:49:38 +0900577
initial.commit3f4a7322008-07-27 06:49:38 +0900578 if (logging_destination == LOG_ONLY_TO_SYSTEM_DEBUG_LOG ||
pinkerton@google.com56053fe2008-08-08 22:27:28 +0900579 logging_destination == LOG_TO_BOTH_FILE_AND_SYSTEM_DEBUG_LOG) {
580#if defined(OS_WIN)
initial.commit3f4a7322008-07-27 06:49:38 +0900581 OutputDebugStringA(str_newline.c_str());
michaelbai@google.com01ef2f22011-07-08 05:46:50 +0900582#elif defined(OS_ANDROID)
583 android_LogPriority priority = ANDROID_LOG_UNKNOWN;
584 switch (severity_) {
585 case LOG_INFO:
586 priority = ANDROID_LOG_INFO;
587 break;
588 case LOG_WARNING:
589 priority = ANDROID_LOG_WARN;
590 break;
591 case LOG_ERROR:
592 case LOG_ERROR_REPORT:
593 priority = ANDROID_LOG_ERROR;
594 break;
595 case LOG_FATAL:
596 priority = ANDROID_LOG_FATAL;
597 break;
598 }
599 __android_log_write(priority, "chromium", str_newline.c_str());
erikkay@google.com7139eb22008-08-27 02:48:18 +0900600#endif
darin@chromium.org33fd3122010-09-25 00:43:06 +0900601 fprintf(stderr, "%s", str_newline.c_str());
602 fflush(stderr);
erikkay@google.coma1ca46c2008-08-26 05:10:31 +0900603 } else if (severity_ >= kAlwaysPrintErrorLevel) {
604 // When we're only outputting to a log file, above a certain log level, we
605 // should still output to stderr so that we can better detect and diagnose
606 // problems with unit tests, especially on the buildbots.
607 fprintf(stderr, "%s", str_newline.c_str());
derat@chromium.orge4ef1ac2009-12-02 09:34:02 +0900608 fflush(stderr);
pinkerton@google.com56053fe2008-08-08 22:27:28 +0900609 }
maruel@chromium.org8fe7adc2009-03-04 00:01:12 +0900610
davemoore@chromium.orgc4dae762010-09-15 07:24:55 +0900611 // We can have multiple threads and/or processes, so try to prevent them
612 // from clobbering each other's writes.
613 // If the client app did not call InitLogging, and the lock has not
614 // been created do it now. We do this on demand, but if two threads try
615 // to do this at the same time, there will be a race condition to create
616 // the lock. This is why InitLogging should be called from the main
617 // thread at the beginning of execution.
618 LoggingLock::Init(LOCK_LOG_FILE, NULL);
initial.commit3f4a7322008-07-27 06:49:38 +0900619 // write to log file
620 if (logging_destination != LOG_NONE &&
davemoore@chromium.orgc4dae762010-09-15 07:24:55 +0900621 logging_destination != LOG_ONLY_TO_SYSTEM_DEBUG_LOG) {
622 LoggingLock logging_lock;
623 if (InitializeLogFileHandle()) {
pinkerton@google.com56053fe2008-08-08 22:27:28 +0900624#if defined(OS_WIN)
davemoore@chromium.orgc4dae762010-09-15 07:24:55 +0900625 SetFilePointer(log_file, 0, 0, SEEK_END);
626 DWORD num_written;
627 WriteFile(log_file,
628 static_cast<const void*>(str_newline.c_str()),
629 static_cast<DWORD>(str_newline.length()),
630 &num_written,
631 NULL);
davemoore@chromium.org7e79d072010-09-01 07:35:55 +0900632#else
davemoore@chromium.orgc4dae762010-09-15 07:24:55 +0900633 fprintf(log_file, "%s", str_newline.c_str());
634 fflush(log_file);
davemoore@chromium.org7e79d072010-09-01 07:35:55 +0900635#endif
initial.commit3f4a7322008-07-27 06:49:38 +0900636 }
637 }
638
639 if (severity_ == LOG_FATAL) {
apatrick@chromium.org35e38992012-04-04 03:45:05 +0900640 // Ensure the first characters of the string are on the stack so they
641 // are contained in minidumps for diagnostic purposes.
642 char str_stack[1024];
643 str_newline.copy(str_stack, arraysize(str_stack));
644 base::debug::Alias(str_stack);
645
initial.commit3f4a7322008-07-27 06:49:38 +0900646 // display a message or break into the debugger on a fatal error
brettw@chromium.org2f49b122010-10-26 13:07:50 +0900647 if (base::debug::BeingDebugged()) {
648 base::debug::BreakDebugger();
deanm@google.comc2b652a2008-08-13 20:15:11 +0900649 } else {
initial.commit3f4a7322008-07-27 06:49:38 +0900650 if (log_assert_handler) {
651 // make a copy of the string for the handler out of paranoia
652 log_assert_handler(std::string(stream_.str()));
653 } else {
brettw@google.comed61ae42008-11-06 09:33:50 +0900654 // Don't use the string with the newline, get a fresh version to send to
655 // the debug message process. We also don't display assertions to the
656 // user in release mode. The enduser can't do anything with this
657 // information, and displaying message boxes when the application is
658 // hosed can cause additional problems.
659#ifndef NDEBUG
evan@chromium.org5f1eade2010-03-01 22:10:22 +0900660 DisplayDebugMessageInDialog(stream_.str());
brettw@google.comed61ae42008-11-06 09:33:50 +0900661#endif
initial.commit3f4a7322008-07-27 06:49:38 +0900662 // Crash the process to generate a dump.
brettw@chromium.org2f49b122010-10-26 13:07:50 +0900663 base::debug::BreakDebugger();
initial.commit3f4a7322008-07-27 06:49:38 +0900664 }
665 }
huanr@chromium.org656253e2009-02-12 10:19:05 +0900666 } else if (severity_ == LOG_ERROR_REPORT) {
667 // We are here only if the user runs with --enable-dcheck in release mode.
668 if (log_report_handler) {
669 log_report_handler(std::string(stream_.str()));
670 } else {
evan@chromium.org5f1eade2010-03-01 22:10:22 +0900671 DisplayDebugMessageInDialog(stream_.str());
huanr@chromium.org656253e2009-02-12 10:19:05 +0900672 }
initial.commit3f4a7322008-07-27 06:49:38 +0900673 }
674}
675
erg@google.com37c078e2011-01-11 09:50:59 +0900676// writes the common header info to the stream
677void LogMessage::Init(const char* file, int line) {
678 base::StringPiece filename(file);
679 size_t last_slash_pos = filename.find_last_of("\\/");
680 if (last_slash_pos != base::StringPiece::npos)
681 filename.remove_prefix(last_slash_pos + 1);
682
683 // TODO(darin): It might be nice if the columns were fixed width.
684
685 stream_ << '[';
686 if (log_process_id)
687 stream_ << CurrentProcessId() << ':';
688 if (log_thread_id)
rsesek@chromium.org4fd393b2012-01-19 06:21:09 +0900689 stream_ << base::PlatformThread::CurrentId() << ':';
erg@google.com37c078e2011-01-11 09:50:59 +0900690 if (log_timestamp) {
691 time_t t = time(NULL);
692 struct tm local_time = {0};
693#if _MSC_VER >= 1400
694 localtime_s(&local_time, &t);
695#else
696 localtime_r(&t, &local_time);
697#endif
698 struct tm* tm_time = &local_time;
699 stream_ << std::setfill('0')
700 << std::setw(2) << 1 + tm_time->tm_mon
701 << std::setw(2) << tm_time->tm_mday
702 << '/'
703 << std::setw(2) << tm_time->tm_hour
704 << std::setw(2) << tm_time->tm_min
705 << std::setw(2) << tm_time->tm_sec
706 << ':';
707 }
708 if (log_tickcount)
709 stream_ << TickCount() << ':';
710 if (severity_ >= 0)
711 stream_ << log_severity_names[severity_];
712 else
713 stream_ << "VERBOSE" << -severity_;
714
715 stream_ << ":" << filename << "(" << line << ")] ";
716
717 message_start_ = stream_.tellp();
718}
719
tschmelcher@chromium.orgf29a4fc2009-10-10 08:52:20 +0900720#if defined(OS_WIN)
721// This has already been defined in the header, but defining it again as DWORD
722// ensures that the type used in the header is equivalent to DWORD. If not,
723// the redefinition is a compile error.
724typedef DWORD SystemErrorCode;
725#endif
726
727SystemErrorCode GetLastSystemErrorCode() {
728#if defined(OS_WIN)
729 return ::GetLastError();
730#elif defined(OS_POSIX)
731 return errno;
732#else
733#error Not implemented
734#endif
735}
736
737#if defined(OS_WIN)
738Win32ErrorLogMessage::Win32ErrorLogMessage(const char* file,
739 int line,
740 LogSeverity severity,
741 SystemErrorCode err,
742 const char* module)
743 : err_(err),
744 module_(module),
745 log_message_(file, line, severity) {
746}
747
748Win32ErrorLogMessage::Win32ErrorLogMessage(const char* file,
749 int line,
750 LogSeverity severity,
751 SystemErrorCode err)
752 : err_(err),
753 module_(NULL),
754 log_message_(file, line, severity) {
755}
756
757Win32ErrorLogMessage::~Win32ErrorLogMessage() {
758 const int error_message_buffer_size = 256;
759 char msgbuf[error_message_buffer_size];
grt@chromium.org21ec5c32010-10-20 10:33:32 +0900760 DWORD flags = FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS;
tschmelcher@chromium.orgf29a4fc2009-10-10 08:52:20 +0900761 HMODULE hmod;
762 if (module_) {
763 hmod = GetModuleHandleA(module_);
764 if (hmod) {
765 flags |= FORMAT_MESSAGE_FROM_HMODULE;
766 } else {
767 // This makes a nested Win32ErrorLogMessage. It will have module_ of NULL
768 // so it will not call GetModuleHandle, so recursive errors are
769 // impossible.
770 DPLOG(WARNING) << "Couldn't open module " << module_
771 << " for error message query";
772 }
773 } else {
774 hmod = NULL;
775 }
776 DWORD len = FormatMessageA(flags,
777 hmod,
778 err_,
grt@chromium.org21ec5c32010-10-20 10:33:32 +0900779 0,
tschmelcher@chromium.orgf29a4fc2009-10-10 08:52:20 +0900780 msgbuf,
781 sizeof(msgbuf) / sizeof(msgbuf[0]),
782 NULL);
783 if (len) {
784 while ((len > 0) &&
785 isspace(static_cast<unsigned char>(msgbuf[len - 1]))) {
786 msgbuf[--len] = 0;
787 }
788 stream() << ": " << msgbuf;
789 } else {
790 stream() << ": Error " << GetLastError() << " while retrieving error "
791 << err_;
792 }
sky@chromium.orgd2a1c272012-04-06 01:57:06 +0900793 // We're about to crash (CHECK). Put |err_| on the stack (by placing it in a
794 // field) and use Alias in hopes that it makes it into crash dumps.
795 DWORD last_error = err_;
796 base::debug::Alias(&last_error);
tschmelcher@chromium.orgf29a4fc2009-10-10 08:52:20 +0900797}
798#elif defined(OS_POSIX)
799ErrnoLogMessage::ErrnoLogMessage(const char* file,
800 int line,
801 LogSeverity severity,
802 SystemErrorCode err)
803 : err_(err),
804 log_message_(file, line, severity) {
805}
806
807ErrnoLogMessage::~ErrnoLogMessage() {
808 stream() << ": " << safe_strerror(err_);
809}
810#endif // OS_WIN
811
initial.commit3f4a7322008-07-27 06:49:38 +0900812void CloseLogFile() {
davemoore@chromium.orgc4dae762010-09-15 07:24:55 +0900813 LoggingLock logging_lock;
814
initial.commit3f4a7322008-07-27 06:49:38 +0900815 if (!log_file)
816 return;
817
pinkerton@google.com56053fe2008-08-08 22:27:28 +0900818 CloseFile(log_file);
initial.commit3f4a7322008-07-27 06:49:38 +0900819 log_file = NULL;
820}
821
willchan@chromium.org85113a12009-12-08 13:22:50 +0900822void RawLog(int level, const char* message) {
823 if (level >= min_log_level) {
824 size_t bytes_written = 0;
825 const size_t message_len = strlen(message);
826 int rv;
827 while (bytes_written < message_len) {
828 rv = HANDLE_EINTR(
829 write(STDERR_FILENO, message + bytes_written,
830 message_len - bytes_written));
831 if (rv < 0) {
832 // Give up, nothing we can do now.
833 break;
834 }
835 bytes_written += rv;
836 }
837
838 if (message_len > 0 && message[message_len - 1] != '\n') {
839 do {
840 rv = HANDLE_EINTR(write(STDERR_FILENO, "\n", 1));
841 if (rv < 0) {
842 // Give up, nothing we can do now.
843 break;
844 }
845 } while (rv != 1);
846 }
847 }
848
849 if (level == LOG_FATAL)
brettw@chromium.org2f49b122010-10-26 13:07:50 +0900850 base::debug::BreakDebugger();
willchan@chromium.org85113a12009-12-08 13:22:50 +0900851}
852
akalin@chromium.org227369d2012-01-20 15:33:27 +0900853// This was defined at the beginning of this file.
854#undef write
855
ajwong@chromium.org24cb89e2009-04-24 09:13:08 +0900856} // namespace logging
initial.commit3f4a7322008-07-27 06:49:38 +0900857
858std::ostream& operator<<(std::ostream& out, const wchar_t* wstr) {
brettw@chromium.org50c94652009-10-07 11:10:20 +0900859 return out << WideToUTF8(std::wstring(wstr));
initial.commit3f4a7322008-07-27 06:49:38 +0900860}