blob: 04aabb67465d751312d681ef58d791c440383988 [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
avi51ba3e692015-12-26 17:30:507#include <limits.h>
avi9b6f42932015-12-26 22:15:148#include <stdint.h>
9
Chris Hamilton306740d2019-04-25 18:48:3610#include "base/pending_task.h"
Weze976b732018-10-20 03:37:3111#include "base/stl_util.h"
Chris Hamilton306740d2019-04-25 18:48:3612#include "base/task/common/task_annotator.h"
Nicolò Mazzucato6c278d9b2019-08-02 16:25:4413#include "base/trace_event/trace_event.h"
avi9b6f42932015-12-26 22:15:1414#include "build/build_config.h"
avi51ba3e692015-12-26 17:30:5015
[email protected]b16ef312008-08-19 18:36:2316#if defined(OS_WIN)
[email protected]e36ddc82009-12-08 04:22:5017#include <io.h>
alex-accc1bde62017-04-19 08:33:5518#include <windows.h>
[email protected]f6abeba2008-08-08 13:27:2819typedef HANDLE FileHandle;
20typedef HANDLE MutexHandle;
[email protected]e36ddc82009-12-08 04:22:5021// Windows warns on using write(). It prefers _write().
22#define write(fd, buf, count) _write(fd, buf, static_cast<unsigned int>(count))
23// Windows doesn't define STDERR_FILENO. Define it here.
24#define STDERR_FILENO 2
Eric Noyaufce100702017-10-16 09:46:3425
[email protected]052f1b52008-11-06 21:43:0726#elif defined(OS_MACOSX)
Eric Noyaufce100702017-10-16 09:46:3427// In MacOS 10.12 and iOS 10.0 and later ASL (Apple System Log) was deprecated
28// in favor of OS_LOG (Unified Logging).
29#include <AvailabilityMacros.h>
30#if defined(OS_IOS)
31#if !defined(__IPHONE_10_0) || __IPHONE_OS_VERSION_MIN_REQUIRED < __IPHONE_10_0
32#define USE_ASL
33#endif
34#else // !defined(OS_IOS)
35#if !defined(MAC_OS_X_VERSION_10_12) || \
36 MAC_OS_X_VERSION_MIN_REQUIRED < MAC_OS_X_VERSION_10_12
37#define USE_ASL
38#endif
39#endif // defined(OS_IOS)
40
41#if defined(USE_ASL)
mark4c7449c2015-11-10 19:53:4242#include <asl.h>
Eric Noyaufce100702017-10-16 09:46:3443#else
44#include <os/log.h>
45#endif
46
mark4c7449c2015-11-10 19:53:4247#include <CoreFoundation/CoreFoundation.h>
[email protected]f6abeba2008-08-08 13:27:2848#include <mach/mach.h>
49#include <mach/mach_time.h>
50#include <mach-o/dyld.h>
Eric Noyaufce100702017-10-16 09:46:3451
Fabrice de Gans-Riberi306871de2018-05-16 19:38:3952#elif defined(OS_POSIX) || defined(OS_FUCHSIA)
[email protected]19ea84ca2010-11-12 08:37:0853#if defined(OS_NACL)
thestig75f87352014-12-03 21:42:2754#include <sys/time.h> // timespec doesn't seem to be in <time.h>
[email protected]19ea84ca2010-11-12 08:37:0855#endif
[email protected]052f1b52008-11-06 21:43:0756#include <time.h>
[email protected]614e9fa2008-08-11 22:52:5957#endif
58
Fabrice de Gans-Riberi306871de2018-05-16 19:38:3959#if defined(OS_FUCHSIA)
Sharon Yanga4b908de2019-05-07 22:19:0360#include <lib/syslog/global.h>
61#include <lib/syslog/logger.h>
Fabrice de Gans-Riberi306871de2018-05-16 19:38:3962#include <zircon/process.h>
63#include <zircon/syscalls.h>
64#endif
65
66#if defined(OS_ANDROID)
67#include <android/log.h>
68#endif
69
70#if defined(OS_POSIX) || defined(OS_FUCHSIA)
[email protected]d8617a62009-10-09 23:52:2071#include <errno.h>
mark4c7449c2015-11-10 19:53:4272#include <paths.h>
[email protected]166326c62010-08-05 15:50:2373#include <pthread.h>
[email protected]f6abeba2008-08-08 13:27:2874#include <stdio.h>
[email protected]eb62f7262013-03-30 14:29:0075#include <stdlib.h>
[email protected]f6abeba2008-08-08 13:27:2876#include <string.h>
mark4c7449c2015-11-10 19:53:4277#include <sys/stat.h>
Chris Findeisen2a373a2d2019-08-15 19:44:3078#include "base/process/process_handle.h"
[email protected]f6abeba2008-08-08 13:27:2879#define MAX_PATH PATH_MAX
80typedef FILE* FileHandle;
81typedef pthread_mutex_t* MutexHandle;
82#endif
83
[email protected]1f88b5162011-04-01 00:02:2984#include <algorithm>
85#include <cstring>
initial.commitd7cae122008-07-26 21:49:3886#include <ctime>
87#include <iomanip>
[email protected]1f88b5162011-04-01 00:02:2988#include <ostream>
[email protected]c914d8a2014-04-23 01:11:0189#include <string>
alex-accc1bde62017-04-19 08:33:5590#include <utility>
[email protected]b16ef312008-08-19 18:36:2391
initial.commitd7cae122008-07-26 21:49:3892#include "base/base_switches.h"
alex-accc1bde62017-04-19 08:33:5593#include "base/callback.h"
initial.commitd7cae122008-07-26 21:49:3894#include "base/command_line.h"
Brett Wilson1f07f20e2017-10-02 18:55:2895#include "base/containers/stack.h"
alex-accc1bde62017-04-19 08:33:5596#include "base/debug/activity_tracker.h"
[email protected]eb4c4d032012-04-03 18:45:0597#include "base/debug/alias.h"
[email protected]58580352010-10-26 04:07:5098#include "base/debug/debugger.h"
99#include "base/debug/stack_trace.h"
Alan Cutter9b0e1ab2019-03-21 04:22:16100#include "base/debug/task_trace.h"
Yannic Bonenberger3dcd7fe2019-06-08 11:01:45101#include "base/no_destructor.h"
Sharon Yanga4b908de2019-05-07 22:19:03102#include "base/path_service.h"
[email protected]2025d002012-11-14 20:54:35103#include "base/posix/eintr_wrapper.h"
[email protected]eb62f7262013-03-30 14:29:00104#include "base/strings/string_piece.h"
Xianzhu Wangae8d96a32018-10-16 20:41:13105#include "base/strings/string_split.h"
[email protected]c914d8a2014-04-23 01:11:01106#include "base/strings/string_util.h"
107#include "base/strings/stringprintf.h"
mark4c7449c2015-11-10 19:53:42108#include "base/strings/sys_string_conversions.h"
[email protected]a4ea1f12013-06-07 18:37:07109#include "base/strings/utf_string_conversions.h"
[email protected]bc581a682011-01-01 23:16:20110#include "base/synchronization/lock_impl.h"
[email protected]63e66802012-01-18 21:21:09111#include "base/threading/platform_thread.h"
[email protected]99b7c57f2010-09-29 19:26:36112#include "base/vlog.h"
Fabrice de Gans-Riberi306871de2018-05-16 19:38:39113
Cliff Smolinskyc5c52102019-05-03 20:51:54114#if defined(OS_WIN)
115#include "base/win/win_util.h"
116#endif
117
Fabrice de Gans-Riberi306871de2018-05-16 19:38:39118#if defined(OS_POSIX) || defined(OS_FUCHSIA)
brettw6ee6fd62015-06-09 18:05:24119#include "base/posix/safe_strerror.h"
[email protected]53c7ce42010-12-14 16:20:04120#endif
[email protected]52a261f2009-03-03 15:01:12121
Robbie McElrath8bf49842019-08-20 22:22:53122#if defined(OS_CHROMEOS)
123#include "base/files/scoped_file.h"
124#endif
125
initial.commitd7cae122008-07-26 21:49:38126namespace logging {
127
[email protected]064aa162011-12-03 00:30:08128namespace {
129
thestig3e4787d2015-05-19 19:31:52130VlogInfo* g_vlog_info = nullptr;
131VlogInfo* g_vlog_info_prev = nullptr;
initial.commitd7cae122008-07-26 21:49:38132
weza245bd072017-06-18 23:26:34133const char* const log_severity_names[] = {"INFO", "WARNING", "ERROR", "FATAL"};
Avi Drissmane3b70bf2019-01-04 19:50:22134static_assert(LOG_NUM_SEVERITIES == base::size(log_severity_names),
weza245bd072017-06-18 23:26:34135 "Incorrect number of log_severity_names");
initial.commitd7cae122008-07-26 21:49:38136
thestig75f87352014-12-03 21:42:27137const char* log_severity_name(int severity) {
[email protected]80f360a2014-01-23 01:36:19138 if (severity >= 0 && severity < LOG_NUM_SEVERITIES)
139 return log_severity_names[severity];
140 return "UNKNOWN";
141}
142
thestig3e4787d2015-05-19 19:31:52143int g_min_log_level = 0;
[email protected]1d8c2702008-08-19 23:39:32144
Sharon Yang7cb919a2019-05-20 20:27:15145// Specifies the process' logging sink(s), represented as a combination of
146// LoggingDestination values joined by bitwise OR.
147int g_logging_destination = LOG_DEFAULT;
initial.commitd7cae122008-07-26 21:49:38148
[email protected]a33c9892008-08-25 20:10:31149// For LOG_ERROR and above, always print to stderr.
150const int kAlwaysPrintErrorLevel = LOG_ERROR;
151
[email protected]614e9fa2008-08-11 22:52:59152// Which log file to use? This is initialized by InitLogging or
initial.commitd7cae122008-07-26 21:49:38153// will be lazily initialized to the default value when it is
154// first needed.
jdoerrie5c4dc4e2019-02-01 18:02:33155using PathString = base::FilePath::StringType;
thestig3e4787d2015-05-19 19:31:52156PathString* g_log_file_name = nullptr;
initial.commitd7cae122008-07-26 21:49:38157
thestig3e4787d2015-05-19 19:31:52158// This file is lazily opened and the handle may be nullptr
159FileHandle g_log_file = nullptr;
initial.commitd7cae122008-07-26 21:49:38160
thestig3e4787d2015-05-19 19:31:52161// What should be prepended to each message?
162bool g_log_process_id = false;
163bool g_log_thread_id = false;
164bool g_log_timestamp = true;
165bool g_log_tickcount = false;
James Cooka0536c32018-08-01 20:13:31166const char* g_log_prefix = nullptr;
initial.commitd7cae122008-07-26 21:49:38167
[email protected]81e0a852010-08-17 00:38:12168// Should we pop up fatal debug messages in a dialog?
169bool show_error_dialogs = false;
170
initial.commitd7cae122008-07-26 21:49:38171// An assert handler override specified by the client to be called instead of
alex-accc1bde62017-04-19 08:33:55172// the debug message dialog and process termination. Assert handlers are stored
173// in stack to allow overriding and restoring.
Yannic Bonenberger3dcd7fe2019-06-08 11:01:45174base::stack<LogAssertHandlerFunction>& GetLogAssertHandlerStack() {
175 static base::NoDestructor<base::stack<LogAssertHandlerFunction>> instance;
176 return *instance;
177}
alex-accc1bde62017-04-19 08:33:55178
[email protected]2b07b8412009-11-25 15:26:34179// A log message handler that gets notified of every log message we process.
thestig3e4787d2015-05-19 19:31:52180LogMessageHandlerFunction log_message_handler = nullptr;
initial.commitd7cae122008-07-26 21:49:38181
avi9b6f42932015-12-26 22:15:14182uint64_t TickCount() {
[email protected]f8588472008-11-05 23:17:24183#if defined(OS_WIN)
184 return GetTickCount();
Wezb0501302018-03-09 05:18:45185#elif defined(OS_FUCHSIA)
Sharon Yang52c60992019-05-16 22:41:35186 return zx_clock_get_monotonic() /
Wezb0501302018-03-09 05:18:45187 static_cast<zx_time_t>(base::Time::kNanosecondsPerMicrosecond);
Fabrice de Gans-Riberi306871de2018-05-16 19:38:39188#elif defined(OS_MACOSX)
189 return mach_absolute_time();
[email protected]19ea84ca2010-11-12 08:37:08190#elif defined(OS_NACL)
191 // NaCl sadly does not have _POSIX_TIMERS enabled in sys/features.h
192 // So we have to use clock() for now.
193 return clock();
[email protected]e43eddf12009-12-29 00:32:52194#elif defined(OS_POSIX)
[email protected]052f1b52008-11-06 21:43:07195 struct timespec ts;
196 clock_gettime(CLOCK_MONOTONIC, &ts);
197
avi9b6f42932015-12-26 22:15:14198 uint64_t absolute_micro = static_cast<int64_t>(ts.tv_sec) * 1000000 +
199 static_cast<int64_t>(ts.tv_nsec) / 1000;
[email protected]052f1b52008-11-06 21:43:07200
201 return absolute_micro;
[email protected]f8588472008-11-05 23:17:24202#endif
203}
204
[email protected]614e9fa2008-08-11 22:52:59205void DeleteFilePath(const PathString& log_name) {
[email protected]f6abeba2008-08-08 13:27:28206#if defined(OS_WIN)
jdoerriebacc1962019-02-07 13:39:22207 DeleteFile(base::as_wcstr(log_name));
thestig75f87352014-12-03 21:42:27208#elif defined(OS_NACL)
[email protected]ac07ec52013-04-22 17:32:45209 // Do nothing; unlink() isn't supported on NaCl.
Fabrice de Gans-Riberi306871de2018-05-16 19:38:39210#elif defined(OS_POSIX) || defined(OS_FUCHSIA)
[email protected]614e9fa2008-08-11 22:52:59211 unlink(log_name.c_str());
Fabrice de Gans-Riberi306871de2018-05-16 19:38:39212#else
213#error Unsupported platform
[email protected]f6abeba2008-08-08 13:27:28214#endif
215}
initial.commitd7cae122008-07-26 21:49:38216
[email protected]5f95d532010-10-01 17:16:58217PathString GetDefaultLogFile() {
[email protected]5b84fe32010-09-14 22:24:55218#if defined(OS_WIN)
219 // On Windows we use the same path as the exe.
jdoerrie5c4dc4e2019-02-01 18:02:33220 base::char16 module_name[MAX_PATH];
jdoerriebacc1962019-02-07 13:39:22221 GetModuleFileName(nullptr, base::as_writable_wcstr(module_name), MAX_PATH);
[email protected]5f95d532010-10-01 17:16:58222
scottmgfc5b7072015-01-27 21:46:28223 PathString log_name = module_name;
224 PathString::size_type last_backslash = log_name.rfind('\\', log_name.size());
[email protected]5f95d532010-10-01 17:16:58225 if (last_backslash != PathString::npos)
scottmgfc5b7072015-01-27 21:46:28226 log_name.erase(last_backslash + 1);
jdoerrie5c4dc4e2019-02-01 18:02:33227 log_name += STRING16_LITERAL("debug.log");
scottmgfc5b7072015-01-27 21:46:28228 return log_name;
Fabrice de Gans-Riberi306871de2018-05-16 19:38:39229#elif defined(OS_POSIX) || defined(OS_FUCHSIA)
[email protected]5b84fe32010-09-14 22:24:55230 // On other platforms we just use the current directory.
[email protected]5f95d532010-10-01 17:16:58231 return PathString("debug.log");
[email protected]5b84fe32010-09-14 22:24:55232#endif
233}
234
ananta61762fb2015-09-18 01:00:09235// We don't need locks on Windows for atomically appending to files. The OS
236// provides this functionality.
Fabrice de Gans-Riberi306871de2018-05-16 19:38:39237#if defined(OS_POSIX) || defined(OS_FUCHSIA)
[email protected]5b84fe32010-09-14 22:24:55238// This class acts as a wrapper for locking the logging files.
239// LoggingLock::Init() should be called from the main thread before any logging
240// is done. Then whenever logging, be sure to have a local LoggingLock
241// instance on the stack. This will ensure that the lock is unlocked upon
242// exiting the frame.
243// LoggingLocks can not be nested.
244class LoggingLock {
245 public:
246 LoggingLock() {
247 LockLogging();
248 }
249
250 ~LoggingLock() {
251 UnlockLogging();
252 }
253
254 static void Init(LogLockingState lock_log, const PathChar* new_log_file) {
255 if (initialized)
256 return;
257 lock_log_file = lock_log;
[email protected]5f95d532010-10-01 17:16:58258
ananta61762fb2015-09-18 01:00:09259 if (lock_log_file != LOCK_LOG_FILE)
[email protected]bc581a682011-01-01 23:16:20260 log_lock = new base::internal::LockImpl();
ananta61762fb2015-09-18 01:00:09261
[email protected]5b84fe32010-09-14 22:24:55262 initialized = true;
263 }
264
265 private:
266 static void LockLogging() {
267 if (lock_log_file == LOCK_LOG_FILE) {
[email protected]5b84fe32010-09-14 22:24:55268 pthread_mutex_lock(&log_mutex);
[email protected]5b84fe32010-09-14 22:24:55269 } else {
270 // use the lock
271 log_lock->Lock();
272 }
273 }
274
275 static void UnlockLogging() {
276 if (lock_log_file == LOCK_LOG_FILE) {
[email protected]5b84fe32010-09-14 22:24:55277 pthread_mutex_unlock(&log_mutex);
[email protected]5b84fe32010-09-14 22:24:55278 } else {
279 log_lock->Unlock();
280 }
281 }
282
283 // The lock is used if log file locking is false. It helps us avoid problems
284 // with multiple threads writing to the log file at the same time. Use
285 // LockImpl directly instead of using Lock, because Lock makes logging calls.
[email protected]bc581a682011-01-01 23:16:20286 static base::internal::LockImpl* log_lock;
[email protected]5b84fe32010-09-14 22:24:55287
288 // When we don't use a lock, we are using a global mutex. We need to do this
289 // because LockFileEx is not thread safe.
[email protected]5b84fe32010-09-14 22:24:55290 static pthread_mutex_t log_mutex;
[email protected]5b84fe32010-09-14 22:24:55291
292 static bool initialized;
293 static LogLockingState lock_log_file;
294};
295
296// static
297bool LoggingLock::initialized = false;
298// static
thestig3e4787d2015-05-19 19:31:52299base::internal::LockImpl* LoggingLock::log_lock = nullptr;
[email protected]5b84fe32010-09-14 22:24:55300// static
301LogLockingState LoggingLock::lock_log_file = LOCK_LOG_FILE;
302
[email protected]5b84fe32010-09-14 22:24:55303pthread_mutex_t LoggingLock::log_mutex = PTHREAD_MUTEX_INITIALIZER;
[email protected]5b84fe32010-09-14 22:24:55304
Fabrice de Gans-Riberi306871de2018-05-16 19:38:39305#endif // OS_POSIX || OS_FUCHSIA
ananta61762fb2015-09-18 01:00:09306
thestig3e4787d2015-05-19 19:31:52307// Called by logging functions to ensure that |g_log_file| is initialized
initial.commitd7cae122008-07-26 21:49:38308// and can be used for writing. Returns false if the file could not be
thestig3e4787d2015-05-19 19:31:52309// initialized. |g_log_file| will be nullptr in this case.
initial.commitd7cae122008-07-26 21:49:38310bool InitializeLogFileHandle() {
thestig3e4787d2015-05-19 19:31:52311 if (g_log_file)
initial.commitd7cae122008-07-26 21:49:38312 return true;
313
thestig3e4787d2015-05-19 19:31:52314 if (!g_log_file_name) {
[email protected]614e9fa2008-08-11 22:52:59315 // Nobody has called InitLogging to specify a debug log file, so here we
316 // initialize the log file name to a default.
thestig3e4787d2015-05-19 19:31:52317 g_log_file_name = new PathString(GetDefaultLogFile());
initial.commitd7cae122008-07-26 21:49:38318 }
319
Robbie McElrath8bf49842019-08-20 22:22:53320 if ((g_logging_destination & LOG_TO_FILE) == 0)
321 return true;
322
[email protected]614e9fa2008-08-11 22:52:59323#if defined(OS_WIN)
Robbie McElrath8bf49842019-08-20 22:22:53324 // The FILE_APPEND_DATA access mask ensures that the file is atomically
325 // appended to across accesses from multiple threads.
326 // https://msdn.microsoft.com/en-us/library/windows/desktop/aa364399(v=vs.85).aspx
327 // https://msdn.microsoft.com/en-us/library/windows/desktop/aa363858(v=vs.85).aspx
328 g_log_file = CreateFile(base::as_wcstr(*g_log_file_name), FILE_APPEND_DATA,
329 FILE_SHARE_READ | FILE_SHARE_WRITE, nullptr,
330 OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL, nullptr);
331 if (g_log_file == INVALID_HANDLE_VALUE || g_log_file == nullptr) {
332 // We are intentionally not using FilePath or FileUtil here to reduce the
333 // dependencies of the logging implementation. For e.g. FilePath and
334 // FileUtil depend on shell32 and user32.dll. This is not acceptable for
335 // some consumers of base logging like chrome_elf, etc.
336 // Please don't change the code below to use FilePath.
337 // try the current directory
338 base::char16 system_buffer[MAX_PATH];
339 system_buffer[0] = 0;
340 DWORD len = ::GetCurrentDirectory(base::size(system_buffer),
341 base::as_writable_wcstr(system_buffer));
342 if (len == 0 || len > base::size(system_buffer))
343 return false;
344
345 *g_log_file_name = system_buffer;
346 // Append a trailing backslash if needed.
347 if (g_log_file_name->back() != L'\\')
348 *g_log_file_name += STRING16_LITERAL("\\");
349 *g_log_file_name += STRING16_LITERAL("debug.log");
350
jdoerriebacc1962019-02-07 13:39:22351 g_log_file = CreateFile(base::as_wcstr(*g_log_file_name), FILE_APPEND_DATA,
thestig3e4787d2015-05-19 19:31:52352 FILE_SHARE_READ | FILE_SHARE_WRITE, nullptr,
353 OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL, nullptr);
354 if (g_log_file == INVALID_HANDLE_VALUE || g_log_file == nullptr) {
Robbie McElrath8bf49842019-08-20 22:22:53355 g_log_file = nullptr;
[email protected]78c6dd62009-06-08 23:29:11356 return false;
Robbie McElrath8bf49842019-08-20 22:22:53357 }
358 }
359#elif defined(OS_POSIX) || defined(OS_FUCHSIA)
360 g_log_file = fopen(g_log_file_name->c_str(), "a");
361 if (g_log_file == nullptr)
362 return false;
Fabrice de Gans-Riberi306871de2018-05-16 19:38:39363#else
364#error Unsupported platform
[email protected]f6abeba2008-08-08 13:27:28365#endif
[email protected]1d8c2702008-08-19 23:39:32366
initial.commitd7cae122008-07-26 21:49:38367 return true;
368}
369
[email protected]17dcf752013-07-15 21:47:09370void CloseFile(FileHandle log) {
371#if defined(OS_WIN)
372 CloseHandle(log);
Fabrice de Gans-Riberi306871de2018-05-16 19:38:39373#elif defined(OS_POSIX) || defined(OS_FUCHSIA)
[email protected]17dcf752013-07-15 21:47:09374 fclose(log);
Fabrice de Gans-Riberi306871de2018-05-16 19:38:39375#else
376#error Unsupported platform
[email protected]17dcf752013-07-15 21:47:09377#endif
378}
379
380void CloseLogFileUnlocked() {
thestig3e4787d2015-05-19 19:31:52381 if (!g_log_file)
[email protected]17dcf752013-07-15 21:47:09382 return;
383
thestig3e4787d2015-05-19 19:31:52384 CloseFile(g_log_file);
385 g_log_file = nullptr;
Robbie McElrath8bf49842019-08-20 22:22:53386
387 // If we initialized logging via an externally-provided file descriptor, we
388 // won't have a log path set and shouldn't try to reopen the log file.
389 if (!g_log_file_name)
390 g_logging_destination &= ~LOG_TO_FILE;
[email protected]17dcf752013-07-15 21:47:09391}
392
[email protected]064aa162011-12-03 00:30:08393} // namespace
394
Tomas Popelaafffa972018-11-13 20:42:05395#if defined(DCHECK_IS_CONFIGURABLE)
Sigurdur Asgeirsson69d0bcd2018-03-29 21:50:51396// In DCHECK-enabled Chrome builds, allow the meaning of LOG_DCHECK to be
Wez289477f2017-08-24 20:51:30397// determined at run-time. We default it to INFO, to avoid it triggering
398// crashes before the run-time has explicitly chosen the behaviour.
399BASE_EXPORT logging::LogSeverity LOG_DCHECK = LOG_INFO;
Tomas Popelaafffa972018-11-13 20:42:05400#endif // defined(DCHECK_IS_CONFIGURABLE)
Wez289477f2017-08-24 20:51:30401
scottmg3c957a52016-12-10 20:57:59402// This is never instantiated, it's just used for EAT_STREAM_PARAMETERS to have
403// an object of the correct type on the LHS of the unused part of the ternary
404// operator.
405std::ostream* g_swallow_stream;
406
[email protected]5e3f7c22013-06-21 21:15:33407bool BaseInitLoggingImpl(const LoggingSettings& settings) {
[email protected]ac07ec52013-04-22 17:32:45408#if defined(OS_NACL)
Sharon Yang7cb919a2019-05-20 20:27:15409 // Can log only to the system debug log and stderr.
410 CHECK_EQ(settings.logging_dest & ~(LOG_TO_SYSTEM_DEBUG_LOG | LOG_TO_STDERR),
411 0u);
[email protected]ac07ec52013-04-22 17:32:45412#endif
Robbie McElrath8bf49842019-08-20 22:22:53413
pgal.u-szeged421dddb2014-11-25 12:55:02414 base::CommandLine* command_line = base::CommandLine::ForCurrentProcess();
thestig3e4787d2015-05-19 19:31:52415 // Don't bother initializing |g_vlog_info| unless we use one of the
[email protected]99b7c57f2010-09-29 19:26:36416 // vlog switches.
417 if (command_line->HasSwitch(switches::kV) ||
418 command_line->HasSwitch(switches::kVModule)) {
thestig3e4787d2015-05-19 19:31:52419 // NOTE: If |g_vlog_info| has already been initialized, it might be in use
[email protected]064aa162011-12-03 00:30:08420 // by another thread. Don't delete the old VLogInfo, just create a second
421 // one. We keep track of both to avoid memory leak warnings.
422 CHECK(!g_vlog_info_prev);
423 g_vlog_info_prev = g_vlog_info;
424
[email protected]99b7c57f2010-09-29 19:26:36425 g_vlog_info =
426 new VlogInfo(command_line->GetSwitchValueASCII(switches::kV),
[email protected]162ac0f2010-11-04 15:50:49427 command_line->GetSwitchValueASCII(switches::kVModule),
thestig3e4787d2015-05-19 19:31:52428 &g_min_log_level);
[email protected]99b7c57f2010-09-29 19:26:36429 }
430
thestig3e4787d2015-05-19 19:31:52431 g_logging_destination = settings.logging_dest;
initial.commitd7cae122008-07-26 21:49:38432
Wez224c0bf62019-05-24 19:26:13433#if defined(OS_FUCHSIA)
434 if (g_logging_destination & LOG_TO_SYSTEM_DEBUG_LOG) {
435 fx_logger_config_t config;
436 config.min_severity = FX_LOG_INFO;
437 config.console_fd = -1;
438 config.log_service_channel = ZX_HANDLE_INVALID;
439 std::string log_tag = command_line->GetProgram().BaseName().AsUTF8Unsafe();
440 const char* log_tag_data = log_tag.data();
441 config.tags = &log_tag_data;
442 config.num_tags = 1;
443 fx_log_init_with_config(&config);
444 }
445#endif
446
[email protected]5e3f7c22013-06-21 21:15:33447 // ignore file options unless logging to file is set.
thestig3e4787d2015-05-19 19:31:52448 if ((g_logging_destination & LOG_TO_FILE) == 0)
[email protected]c7d5da992010-10-28 00:20:21449 return true;
initial.commitd7cae122008-07-26 21:49:38450
Fabrice de Gans-Riberi306871de2018-05-16 19:38:39451#if defined(OS_POSIX) || defined(OS_FUCHSIA)
Robbie McElrath8bf49842019-08-20 22:22:53452 LoggingLock::Init(settings.lock_log, settings.log_file_path);
[email protected]17dcf752013-07-15 21:47:09453 LoggingLock logging_lock;
ananta61762fb2015-09-18 01:00:09454#endif
[email protected]17dcf752013-07-15 21:47:09455
456 // Calling InitLogging twice or after some log call has already opened the
457 // default log file will re-initialize to the new options.
458 CloseLogFileUnlocked();
459
Robbie McElrath8bf49842019-08-20 22:22:53460#if defined(OS_CHROMEOS)
461 if (settings.log_file) {
462 DCHECK(!settings.log_file_path);
463 g_log_file = settings.log_file;
464 return true;
465 }
466#endif
467
thestig3e4787d2015-05-19 19:31:52468 if (!g_log_file_name)
469 g_log_file_name = new PathString();
Robbie McElrath8bf49842019-08-20 22:22:53470 *g_log_file_name = settings.log_file_path;
[email protected]5e3f7c22013-06-21 21:15:33471 if (settings.delete_old == DELETE_OLD_LOG_FILE)
thestig3e4787d2015-05-19 19:31:52472 DeleteFilePath(*g_log_file_name);
initial.commitd7cae122008-07-26 21:49:38473
[email protected]c7d5da992010-10-28 00:20:21474 return InitializeLogFileHandle();
initial.commitd7cae122008-07-26 21:49:38475}
476
477void SetMinLogLevel(int level) {
thestig3e4787d2015-05-19 19:31:52478 g_min_log_level = std::min(LOG_FATAL, level);
initial.commitd7cae122008-07-26 21:49:38479}
480
481int GetMinLogLevel() {
thestig3e4787d2015-05-19 19:31:52482 return g_min_log_level;
initial.commitd7cae122008-07-26 21:49:38483}
484
skobesc78c0ad72015-12-07 20:21:23485bool ShouldCreateLogMessage(int severity) {
486 if (severity < g_min_log_level)
487 return false;
488
Wez6c8acb82019-07-18 00:32:59489 // Return true here unless we know ~LogMessage won't do anything.
skobesc78c0ad72015-12-07 20:21:23490 return g_logging_destination != LOG_NONE || log_message_handler ||
491 severity >= kAlwaysPrintErrorLevel;
492}
493
Wez6c8acb82019-07-18 00:32:59494// Returns true when LOG_TO_STDERR flag is set, or |severity| is high.
495// If |severity| is high then true will be returned when no log destinations are
496// set, or only LOG_TO_FILE is set, since that is useful for local development
497// and debugging.
498bool ShouldLogToStderr(int severity) {
499 if (g_logging_destination & LOG_TO_STDERR)
500 return true;
501 if (severity >= kAlwaysPrintErrorLevel)
502 return (g_logging_destination & ~LOG_TO_FILE) == LOG_NONE;
503 return false;
504}
505
[email protected]162ac0f2010-11-04 15:50:49506int GetVlogVerbosity() {
507 return std::max(-1, LOG_INFO - GetMinLogLevel());
508}
509
[email protected]99b7c57f2010-09-29 19:26:36510int GetVlogLevelHelper(const char* file, size_t N) {
511 DCHECK_GT(N, 0U);
thestig3e4787d2015-05-19 19:31:52512 // Note: |g_vlog_info| may change on a different thread during startup
513 // (but will always be valid or nullptr).
[email protected]064aa162011-12-03 00:30:08514 VlogInfo* vlog_info = g_vlog_info;
515 return vlog_info ?
516 vlog_info->GetVlogLevel(base::StringPiece(file, N - 1)) :
[email protected]162ac0f2010-11-04 15:50:49517 GetVlogVerbosity();
[email protected]99b7c57f2010-09-29 19:26:36518}
519
initial.commitd7cae122008-07-26 21:49:38520void SetLogItems(bool enable_process_id, bool enable_thread_id,
521 bool enable_timestamp, bool enable_tickcount) {
thestig3e4787d2015-05-19 19:31:52522 g_log_process_id = enable_process_id;
523 g_log_thread_id = enable_thread_id;
524 g_log_timestamp = enable_timestamp;
525 g_log_tickcount = enable_tickcount;
initial.commitd7cae122008-07-26 21:49:38526}
527
James Cooka0536c32018-08-01 20:13:31528void SetLogPrefix(const char* prefix) {
529 DCHECK(!prefix ||
530 base::ContainsOnlyChars(prefix, "abcdefghijklmnopqrstuvwxyz"));
531 g_log_prefix = prefix;
532}
533
[email protected]81e0a852010-08-17 00:38:12534void SetShowErrorDialogs(bool enable_dialogs) {
535 show_error_dialogs = enable_dialogs;
536}
537
alex-accc1bde62017-04-19 08:33:55538ScopedLogAssertHandler::ScopedLogAssertHandler(
539 LogAssertHandlerFunction handler) {
Yannic Bonenberger3dcd7fe2019-06-08 11:01:45540 GetLogAssertHandlerStack().push(std::move(handler));
alex-accc1bde62017-04-19 08:33:55541}
542
543ScopedLogAssertHandler::~ScopedLogAssertHandler() {
Yannic Bonenberger3dcd7fe2019-06-08 11:01:45544 GetLogAssertHandlerStack().pop();
initial.commitd7cae122008-07-26 21:49:38545}
546
[email protected]2b07b8412009-11-25 15:26:34547void SetLogMessageHandler(LogMessageHandlerFunction handler) {
548 log_message_handler = handler;
549}
550
[email protected]64e5cc02010-11-03 19:20:27551LogMessageHandlerFunction GetLogMessageHandler() {
552 return log_message_handler;
553}
554
[email protected]6d445d32010-09-30 19:10:03555// Explicit instantiations for commonly used comparisons.
556template std::string* MakeCheckOpString<int, int>(
557 const int&, const int&, const char* names);
558template std::string* MakeCheckOpString<unsigned long, unsigned long>(
559 const unsigned long&, const unsigned long&, const char* names);
560template std::string* MakeCheckOpString<unsigned long, unsigned int>(
561 const unsigned long&, const unsigned int&, const char* names);
562template std::string* MakeCheckOpString<unsigned int, unsigned long>(
563 const unsigned int&, const unsigned long&, const char* names);
564template std::string* MakeCheckOpString<std::string, std::string>(
565 const std::string&, const std::string&, const char* name);
[email protected]2b07b8412009-11-25 15:26:34566
jbroman6bcfec422016-05-26 00:28:46567void MakeCheckOpValueString(std::ostream* os, std::nullptr_t p) {
brucedawson93a60b8c2016-04-28 20:46:16568 (*os) << "nullptr";
569}
570
[email protected]f2c05492014-06-17 12:04:23571#if !defined(NDEBUG)
[email protected]d81baca42010-03-01 13:10:22572// Displays a message box to the user with the error message in it.
573// Used for fatal messages, where we close the app simultaneously.
[email protected]561513f2010-12-16 23:29:25574// This is for developers only; we don't use this in circumstances
575// (like release builds) where users could see it, since users don't
576// understand these messages anyway.
[email protected]d81baca42010-03-01 13:10:22577void DisplayDebugMessageInDialog(const std::string& str) {
initial.commitd7cae122008-07-26 21:49:38578 if (str.empty())
579 return;
580
[email protected]81e0a852010-08-17 00:38:12581 if (!show_error_dialogs)
[email protected]846ed9c32010-07-29 20:33:44582 return;
583
[email protected]f6abeba2008-08-08 13:27:28584#if defined(OS_WIN)
[email protected]561513f2010-12-16 23:29:25585 // We intentionally don't implement a dialog on other platforms.
586 // You can just look at stderr.
Cliff Smolinskyc5c52102019-05-03 20:51:54587 if (base::win::IsUser32AndGdi32Available()) {
588 MessageBoxW(nullptr, base::as_wcstr(base::UTF8ToUTF16(str)), L"Fatal error",
589 MB_OK | MB_ICONHAND | MB_TOPMOST);
590 } else {
591 OutputDebugStringW(base::as_wcstr(base::UTF8ToUTF16(str)));
592 }
thestig3e4787d2015-05-19 19:31:52593#endif // defined(OS_WIN)
initial.commitd7cae122008-07-26 21:49:38594}
[email protected]f2c05492014-06-17 12:04:23595#endif // !defined(NDEBUG)
initial.commitd7cae122008-07-26 21:49:38596
[email protected]eae9c062011-01-11 00:50:59597LogMessage::LogMessage(const char* file, int line, LogSeverity severity)
598 : severity_(severity), file_(file), line_(line) {
599 Init(file, line);
600}
601
tnagel4a045d3f2015-07-12 14:19:28602LogMessage::LogMessage(const char* file, int line, const char* condition)
603 : severity_(LOG_FATAL), file_(file), line_(line) {
604 Init(file, line);
605 stream_ << "Check failed: " << condition << ". ";
606}
607
[email protected]9c7132e2011-02-08 07:39:08608LogMessage::LogMessage(const char* file, int line, std::string* result)
[email protected]162ac0f2010-11-04 15:50:49609 : severity_(LOG_FATAL), file_(file), line_(line) {
initial.commitd7cae122008-07-26 21:49:38610 Init(file, line);
[email protected]9c7132e2011-02-08 07:39:08611 stream_ << "Check failed: " << *result;
612 delete result;
initial.commitd7cae122008-07-26 21:49:38613}
614
[email protected]fb62a532009-02-12 01:19:05615LogMessage::LogMessage(const char* file, int line, LogSeverity severity,
[email protected]9c7132e2011-02-08 07:39:08616 std::string* result)
[email protected]162ac0f2010-11-04 15:50:49617 : severity_(severity), file_(file), line_(line) {
[email protected]fb62a532009-02-12 01:19:05618 Init(file, line);
[email protected]9c7132e2011-02-08 07:39:08619 stream_ << "Check failed: " << *result;
620 delete result;
[email protected]fb62a532009-02-12 01:19:05621}
622
initial.commitd7cae122008-07-26 21:49:38623LogMessage::~LogMessage() {
alex-accc1bde62017-04-19 08:33:55624 size_t stack_start = stream_.tellp();
rayb0088ee52017-04-26 22:35:08625#if !defined(OFFICIAL_BUILD) && !defined(OS_NACL) && !defined(__UCLIBC__) && \
626 !defined(OS_AIX)
brucedawson7c559eb2015-09-05 00:34:42627 if (severity_ == LOG_FATAL && !base::debug::BeingDebugged()) {
628 // Include a stack trace on a fatal, unless a debugger is attached.
Alan Cutter9b0e1ab2019-03-21 04:22:16629 base::debug::StackTrace stack_trace;
[email protected]d1ccc35a2010-03-24 05:03:24630 stream_ << std::endl; // Newline to separate from log message.
Alan Cutter9b0e1ab2019-03-21 04:22:16631 stack_trace.OutputToStream(&stream_);
632 base::debug::TaskTrace task_trace;
633 if (!task_trace.empty())
634 task_trace.OutputToStream(&stream_);
Chris Hamilton306740d2019-04-25 18:48:36635
Chris Hamilton888085312019-05-30 00:53:30636 // Include the IPC context, if any.
637 // TODO(chrisha): Integrate with symbolization once those tools exist!
Chris Hamilton306740d2019-04-25 18:48:36638 const auto* task = base::TaskAnnotator::CurrentTaskForThread();
Chris Hamilton888085312019-05-30 00:53:30639 if (task && task->ipc_hash) {
640 stream_ << "IPC message handler context: "
641 << base::StringPrintf("0x%08X", task->ipc_hash) << std::endl;
Chris Hamilton306740d2019-04-25 18:48:36642 }
[email protected]d1ccc35a2010-03-24 05:03:24643 }
[email protected]1d8c2702008-08-19 23:39:32644#endif
[email protected]d1ccc35a2010-03-24 05:03:24645 stream_ << std::endl;
646 std::string str_newline(stream_.str());
Nicolò Mazzucato6c278d9b2019-08-02 16:25:44647 TRACE_LOG_MESSAGE(
648 file_, base::StringPiece(str_newline).substr(message_start_), line_);
[email protected]d1ccc35a2010-03-24 05:03:24649
[email protected]2b07b8412009-11-25 15:26:34650 // Give any log message handler first dibs on the message.
[email protected]5e3f7c22013-06-21 21:15:33651 if (log_message_handler &&
652 log_message_handler(severity_, file_, line_,
653 message_start_, str_newline)) {
[email protected]162ac0f2010-11-04 15:50:49654 // The handler took care of it, no further processing.
[email protected]2b07b8412009-11-25 15:26:34655 return;
[email protected]162ac0f2010-11-04 15:50:49656 }
initial.commitd7cae122008-07-26 21:49:38657
thestig3e4787d2015-05-19 19:31:52658 if ((g_logging_destination & LOG_TO_SYSTEM_DEBUG_LOG) != 0) {
[email protected]f6abeba2008-08-08 13:27:28659#if defined(OS_WIN)
initial.commitd7cae122008-07-26 21:49:38660 OutputDebugStringA(str_newline.c_str());
mark4c7449c2015-11-10 19:53:42661#elif defined(OS_MACOSX)
662 // In LOG_TO_SYSTEM_DEBUG_LOG mode, log messages are always written to
Eric Noyaufce100702017-10-16 09:46:34663 // stderr. If stderr is /dev/null, also log via ASL (Apple System Log) or
664 // its successor OS_LOG. If there's something weird about stderr, assume
665 // that log messages are going nowhere and log via ASL/OS_LOG too.
666 // Messages logged via ASL/OS_LOG show up in Console.app.
mark4c7449c2015-11-10 19:53:42667 //
668 // Programs started by launchd, as UI applications normally are, have had
669 // stderr connected to /dev/null since OS X 10.8. Prior to that, stderr was
670 // a pipe to launchd, which logged what it received (see log_redirect_fd in
671 // 10.7.5 launchd-392.39/launchd/src/launchd_core_logic.c).
672 //
673 // Another alternative would be to determine whether stderr is a pipe to
674 // launchd and avoid logging via ASL only in that case. See 10.7.5
675 // CF-635.21/CFUtilities.c also_do_stderr(). This would result in logging to
Eric Noyaufce100702017-10-16 09:46:34676 // both stderr and ASL/OS_LOG even in tests, where it's undesirable to log
677 // to the system log at all.
mark4c7449c2015-11-10 19:53:42678 //
679 // Note that the ASL client by default discards messages whose levels are
680 // below ASL_LEVEL_NOTICE. It's possible to change that with
681 // asl_set_filter(), but this is pointless because syslogd normally applies
682 // the same filter.
Eric Noyaufce100702017-10-16 09:46:34683 const bool log_to_system = []() {
mark4c7449c2015-11-10 19:53:42684 struct stat stderr_stat;
685 if (fstat(fileno(stderr), &stderr_stat) == -1) {
686 return true;
687 }
688 if (!S_ISCHR(stderr_stat.st_mode)) {
689 return false;
690 }
691
692 struct stat dev_null_stat;
693 if (stat(_PATH_DEVNULL, &dev_null_stat) == -1) {
694 return true;
695 }
696
697 return !S_ISCHR(dev_null_stat.st_mode) ||
698 stderr_stat.st_rdev == dev_null_stat.st_rdev;
699 }();
700
Eric Noyaufce100702017-10-16 09:46:34701 if (log_to_system) {
mark4c7449c2015-11-10 19:53:42702 // Log roughly the same way that CFLog() and NSLog() would. See 10.10.5
703 // CF-1153.18/CFUtilities.c __CFLogCString().
mark4c7449c2015-11-10 19:53:42704 CFBundleRef main_bundle = CFBundleGetMainBundle();
705 CFStringRef main_bundle_id_cf =
706 main_bundle ? CFBundleGetIdentifier(main_bundle) : nullptr;
Eric Noyaufce100702017-10-16 09:46:34707 std::string main_bundle_id =
mark4c7449c2015-11-10 19:53:42708 main_bundle_id_cf ? base::SysCFStringRefToUTF8(main_bundle_id_cf)
Eric Noyaufce100702017-10-16 09:46:34709 : std::string("");
710#if defined(USE_ASL)
711 // The facility is set to the main bundle ID if available. Otherwise,
712 // "com.apple.console" is used.
713 const class ASLClient {
mark4c7449c2015-11-10 19:53:42714 public:
Bruce Dawson4c6f8e12017-11-16 04:35:59715 explicit ASLClient(const std::string& facility)
716 : client_(asl_open(nullptr, facility.c_str(), ASL_OPT_NO_DELAY)) {}
mark4c7449c2015-11-10 19:53:42717 ~ASLClient() { asl_close(client_); }
718
719 aslclient get() const { return client_; }
720
721 private:
722 aslclient client_;
723 DISALLOW_COPY_AND_ASSIGN(ASLClient);
Eric Noyaufce100702017-10-16 09:46:34724 } asl_client(main_bundle_id.empty() ? main_bundle_id
725 : "com.apple.console");
mark4c7449c2015-11-10 19:53:42726
Eric Noyaufce100702017-10-16 09:46:34727 const class ASLMessage {
mark4c7449c2015-11-10 19:53:42728 public:
729 ASLMessage() : message_(asl_new(ASL_TYPE_MSG)) {}
730 ~ASLMessage() { asl_free(message_); }
731
732 aslmsg get() const { return message_; }
733
734 private:
735 aslmsg message_;
736 DISALLOW_COPY_AND_ASSIGN(ASLMessage);
737 } asl_message;
738
739 // By default, messages are only readable by the admin group. Explicitly
740 // make them readable by the user generating the messages.
741 char euid_string[12];
Avi Drissmane3b70bf2019-01-04 19:50:22742 snprintf(euid_string, base::size(euid_string), "%d", geteuid());
mark4c7449c2015-11-10 19:53:42743 asl_set(asl_message.get(), ASL_KEY_READ_UID, euid_string);
744
745 // Map Chrome log severities to ASL log levels.
746 const char* const asl_level_string = [](LogSeverity severity) {
747 // ASL_LEVEL_* are ints, but ASL needs equivalent strings. This
748 // non-obvious two-step macro trick achieves what's needed.
749 // https://gcc.gnu.org/onlinedocs/cpp/Stringification.html
750#define ASL_LEVEL_STR(level) ASL_LEVEL_STR_X(level)
751#define ASL_LEVEL_STR_X(level) #level
752 switch (severity) {
753 case LOG_INFO:
754 return ASL_LEVEL_STR(ASL_LEVEL_INFO);
755 case LOG_WARNING:
756 return ASL_LEVEL_STR(ASL_LEVEL_WARNING);
757 case LOG_ERROR:
758 return ASL_LEVEL_STR(ASL_LEVEL_ERR);
759 case LOG_FATAL:
760 return ASL_LEVEL_STR(ASL_LEVEL_CRIT);
761 default:
762 return severity < 0 ? ASL_LEVEL_STR(ASL_LEVEL_DEBUG)
763 : ASL_LEVEL_STR(ASL_LEVEL_NOTICE);
764 }
765#undef ASL_LEVEL_STR
766#undef ASL_LEVEL_STR_X
767 }(severity_);
768 asl_set(asl_message.get(), ASL_KEY_LEVEL, asl_level_string);
769
770 asl_set(asl_message.get(), ASL_KEY_MSG, str_newline.c_str());
771
772 asl_send(asl_client.get(), asl_message.get());
Eric Noyaufce100702017-10-16 09:46:34773#else // !defined(USE_ASL)
774 const class OSLog {
775 public:
776 explicit OSLog(const char* subsystem)
777 : os_log_(subsystem ? os_log_create(subsystem, "chromium_logging")
778 : OS_LOG_DEFAULT) {}
779 ~OSLog() {
780 if (os_log_ != OS_LOG_DEFAULT) {
781 os_release(os_log_);
782 }
783 }
784 os_log_t get() const { return os_log_; }
785
786 private:
787 os_log_t os_log_;
788 DISALLOW_COPY_AND_ASSIGN(OSLog);
789 } log(main_bundle_id.empty() ? nullptr : main_bundle_id.c_str());
790 const os_log_type_t os_log_type = [](LogSeverity severity) {
791 switch (severity) {
792 case LOG_INFO:
793 return OS_LOG_TYPE_INFO;
794 case LOG_WARNING:
795 return OS_LOG_TYPE_DEFAULT;
796 case LOG_ERROR:
797 return OS_LOG_TYPE_ERROR;
798 case LOG_FATAL:
799 return OS_LOG_TYPE_FAULT;
800 default:
801 return severity < 0 ? OS_LOG_TYPE_DEBUG : OS_LOG_TYPE_DEFAULT;
802 }
803 }(severity_);
804 os_log_with_type(log.get(), os_log_type, "%{public}s",
805 str_newline.c_str());
806#endif // defined(USE_ASL)
mark4c7449c2015-11-10 19:53:42807 }
[email protected]3132e35c2011-07-07 20:46:50808#elif defined(OS_ANDROID)
[email protected]efbae7da2013-05-21 22:39:25809 android_LogPriority priority =
810 (severity_ < 0) ? ANDROID_LOG_VERBOSE : ANDROID_LOG_UNKNOWN;
[email protected]3132e35c2011-07-07 20:46:50811 switch (severity_) {
812 case LOG_INFO:
813 priority = ANDROID_LOG_INFO;
814 break;
815 case LOG_WARNING:
816 priority = ANDROID_LOG_WARN;
817 break;
818 case LOG_ERROR:
[email protected]3132e35c2011-07-07 20:46:50819 priority = ANDROID_LOG_ERROR;
820 break;
821 case LOG_FATAL:
822 priority = ANDROID_LOG_FATAL;
823 break;
824 }
Tomasz Ĺšniatowski23dd15af2019-02-15 08:32:03825 const char kAndroidLogTag[] = "chromium";
Xianzhu Wangae8d96a32018-10-16 20:41:13826#if DCHECK_IS_ON()
827 // Split the output by new lines to prevent the Android system from
828 // truncating the log.
Tomasz Ĺšniatowski23dd15af2019-02-15 08:32:03829 std::vector<std::string> lines = base::SplitString(
830 str_newline, "\n", base::KEEP_WHITESPACE, base::SPLIT_WANT_ALL);
831 // str_newline has an extra newline appended to it (at the top of this
832 // function), so skip the last split element to avoid needlessly
833 // logging an empty string.
834 lines.pop_back();
835 for (const auto& line : lines)
836 __android_log_write(priority, kAndroidLogTag, line.c_str());
Xianzhu Wangae8d96a32018-10-16 20:41:13837#else
838 // The Android system may truncate the string if it's too long.
Tomasz Ĺšniatowski23dd15af2019-02-15 08:32:03839 __android_log_write(priority, kAndroidLogTag, str_newline.c_str());
[email protected]107bc0f12008-08-26 17:48:18840#endif
Sharon Yanga4b908de2019-05-07 22:19:03841#elif defined(OS_FUCHSIA)
842 fx_log_severity_t severity = FX_LOG_INFO;
Wez224c0bf62019-05-24 19:26:13843 switch (severity_) {
Sharon Yanga4b908de2019-05-07 22:19:03844 case LOG_INFO:
845 severity = FX_LOG_INFO;
846 break;
847 case LOG_WARNING:
848 severity = FX_LOG_WARNING;
849 break;
850 case LOG_ERROR:
851 severity = FX_LOG_ERROR;
852 break;
853 case LOG_FATAL:
Wez224c0bf62019-05-24 19:26:13854 // Don't use FX_LOG_FATAL, otherwise fx_logger_log() will abort().
855 severity = FX_LOG_ERROR;
Sharon Yanga4b908de2019-05-07 22:19:03856 break;
857 }
858
859 fx_logger_t* logger = fx_log_get_logger();
860 if (logger) {
Wez224c0bf62019-05-24 19:26:13861 // Temporarily pop the trailing newline, since fx_logger will add one.
862 str_newline.pop_back();
863 fx_logger_log(logger, severity, nullptr, str_newline.c_str());
864 str_newline.push_back('\n');
Sharon Yanga4b908de2019-05-07 22:19:03865 }
866#endif // OS_FUCHSIA
Sharon Yang7cb919a2019-05-20 20:27:15867 }
868
Wez6c8acb82019-07-18 00:32:59869 if (ShouldLogToStderr(severity_)) {
[email protected]51105382014-03-14 17:02:15870 ignore_result(fwrite(str_newline.data(), str_newline.size(), 1, stderr));
[email protected]1ce41052009-12-02 00:34:02871 fflush(stderr);
[email protected]f6abeba2008-08-08 13:27:28872 }
[email protected]52a261f2009-03-03 15:01:12873
thestig3e4787d2015-05-19 19:31:52874 if ((g_logging_destination & LOG_TO_FILE) != 0) {
[email protected]17dcf752013-07-15 21:47:09875 // We can have multiple threads and/or processes, so try to prevent them
876 // from clobbering each other's writes.
877 // If the client app did not call InitLogging, and the lock has not
878 // been created do it now. We do this on demand, but if two threads try
879 // to do this at the same time, there will be a race condition to create
880 // the lock. This is why InitLogging should be called from the main
881 // thread at the beginning of execution.
Fabrice de Gans-Riberi306871de2018-05-16 19:38:39882#if defined(OS_POSIX) || defined(OS_FUCHSIA)
thestig3e4787d2015-05-19 19:31:52883 LoggingLock::Init(LOCK_LOG_FILE, nullptr);
[email protected]5b84fe32010-09-14 22:24:55884 LoggingLock logging_lock;
ananta61762fb2015-09-18 01:00:09885#endif
[email protected]5b84fe32010-09-14 22:24:55886 if (InitializeLogFileHandle()) {
[email protected]f6abeba2008-08-08 13:27:28887#if defined(OS_WIN)
[email protected]5b84fe32010-09-14 22:24:55888 DWORD num_written;
thestig3e4787d2015-05-19 19:31:52889 WriteFile(g_log_file,
[email protected]5b84fe32010-09-14 22:24:55890 static_cast<const void*>(str_newline.c_str()),
891 static_cast<DWORD>(str_newline.length()),
892 &num_written,
thestig3e4787d2015-05-19 19:31:52893 nullptr);
Fabrice de Gans-Riberi306871de2018-05-16 19:38:39894#elif defined(OS_POSIX) || defined(OS_FUCHSIA)
[email protected]51105382014-03-14 17:02:15895 ignore_result(fwrite(
thestig3e4787d2015-05-19 19:31:52896 str_newline.data(), str_newline.size(), 1, g_log_file));
897 fflush(g_log_file);
Fabrice de Gans-Riberi306871de2018-05-16 19:38:39898#else
899#error Unsupported platform
[email protected]cba21962010-08-31 22:35:55900#endif
initial.commitd7cae122008-07-26 21:49:38901 }
902 }
903
904 if (severity_ == LOG_FATAL) {
bcwhite7a30eb42016-12-02 21:23:40905 // Write the log message to the global activity tracker, if running.
906 base::debug::GlobalActivityTracker* tracker =
907 base::debug::GlobalActivityTracker::Get();
908 if (tracker)
909 tracker->RecordLogMessage(str_newline);
910
[email protected]eb4c4d032012-04-03 18:45:05911 // Ensure the first characters of the string are on the stack so they
Weze976b732018-10-20 03:37:31912 // are contained in minidumps for diagnostic purposes. We place start
913 // and end marker values at either end, so we can scan captured stacks
914 // for the data easily.
915 struct {
916 uint32_t start_marker = 0xbedead01;
917 char data[1024];
918 uint32_t end_marker = 0x5050dead;
919 } str_stack;
920 base::strlcpy(str_stack.data, str_newline.data(),
921 base::size(str_stack.data));
922 base::debug::Alias(&str_stack);
[email protected]eb4c4d032012-04-03 18:45:05923
Yannic Bonenberger3dcd7fe2019-06-08 11:01:45924 if (!GetLogAssertHandlerStack().empty()) {
alex-accc1bde62017-04-19 08:33:55925 LogAssertHandlerFunction log_assert_handler =
Yannic Bonenberger3dcd7fe2019-06-08 11:01:45926 GetLogAssertHandlerStack().top();
alex-accc1bde62017-04-19 08:33:55927
928 if (log_assert_handler) {
929 log_assert_handler.Run(
930 file_, line_,
931 base::StringPiece(str_newline.c_str() + message_start_,
932 stack_start - message_start_),
933 base::StringPiece(str_newline.c_str() + stack_start));
934 }
[email protected]1ffe08c12008-08-13 11:15:11935 } else {
[email protected]82d89ab2014-02-28 18:25:34936 // Don't use the string with the newline, get a fresh version to send to
937 // the debug message process. We also don't display assertions to the
938 // user in release mode. The enduser can't do anything with this
939 // information, and displaying message boxes when the application is
940 // hosed can cause additional problems.
[email protected]4d5901272008-11-06 00:33:50941#ifndef NDEBUG
brucedawson7c559eb2015-09-05 00:34:42942 if (!base::debug::BeingDebugged()) {
943 // Displaying a dialog is unnecessary when debugging and can complicate
944 // debugging.
945 DisplayDebugMessageInDialog(stream_.str());
946 }
[email protected]4d5901272008-11-06 00:33:50947#endif
[email protected]82d89ab2014-02-28 18:25:34948 // Crash the process to generate a dump.
Torne (Richard Coles)54b86796a62018-07-24 14:59:52949#if defined(OFFICIAL_BUILD) && defined(NDEBUG)
950 IMMEDIATE_CRASH();
951#else
[email protected]82d89ab2014-02-28 18:25:34952 base::debug::BreakDebugger();
Torne (Richard Coles)54b86796a62018-07-24 14:59:52953#endif
initial.commitd7cae122008-07-26 21:49:38954 }
955 }
956}
957
[email protected]eae9c062011-01-11 00:50:59958// writes the common header info to the stream
959void LogMessage::Init(const char* file, int line) {
960 base::StringPiece filename(file);
961 size_t last_slash_pos = filename.find_last_of("\\/");
962 if (last_slash_pos != base::StringPiece::npos)
963 filename.remove_prefix(last_slash_pos + 1);
964
965 // TODO(darin): It might be nice if the columns were fixed width.
966
967 stream_ << '[';
James Cooka0536c32018-08-01 20:13:31968 if (g_log_prefix)
969 stream_ << g_log_prefix << ':';
thestig3e4787d2015-05-19 19:31:52970 if (g_log_process_id)
Chris Findeisen2a373a2d2019-08-15 19:44:30971 stream_ << base::GetUniqueIdForProcess() << ':';
thestig3e4787d2015-05-19 19:31:52972 if (g_log_thread_id)
[email protected]63e66802012-01-18 21:21:09973 stream_ << base::PlatformThread::CurrentId() << ':';
thestig3e4787d2015-05-19 19:31:52974 if (g_log_timestamp) {
Fabrice de Gans-Riberi306871de2018-05-16 19:38:39975#if defined(OS_WIN)
976 SYSTEMTIME local_time;
977 GetLocalTime(&local_time);
978 stream_ << std::setfill('0')
979 << std::setw(2) << local_time.wMonth
980 << std::setw(2) << local_time.wDay
981 << '/'
982 << std::setw(2) << local_time.wHour
983 << std::setw(2) << local_time.wMinute
984 << std::setw(2) << local_time.wSecond
985 << '.'
986 << std::setw(3)
987 << local_time.wMilliseconds
988 << ':';
989#elif defined(OS_POSIX) || defined(OS_FUCHSIA)
djkurtz543a3be2016-11-30 14:17:34990 timeval tv;
991 gettimeofday(&tv, nullptr);
992 time_t t = tv.tv_sec;
993 struct tm local_time;
[email protected]eae9c062011-01-11 00:50:59994 localtime_r(&t, &local_time);
[email protected]eae9c062011-01-11 00:50:59995 struct tm* tm_time = &local_time;
996 stream_ << std::setfill('0')
997 << std::setw(2) << 1 + tm_time->tm_mon
998 << std::setw(2) << tm_time->tm_mday
999 << '/'
1000 << std::setw(2) << tm_time->tm_hour
1001 << std::setw(2) << tm_time->tm_min
1002 << std::setw(2) << tm_time->tm_sec
djkurtz543a3be2016-11-30 14:17:341003 << '.'
1004 << std::setw(6) << tv.tv_usec
[email protected]eae9c062011-01-11 00:50:591005 << ':';
Fabrice de Gans-Riberi306871de2018-05-16 19:38:391006#else
1007#error Unsupported platform
djkurtz543a3be2016-11-30 14:17:341008#endif
[email protected]eae9c062011-01-11 00:50:591009 }
thestig3e4787d2015-05-19 19:31:521010 if (g_log_tickcount)
[email protected]eae9c062011-01-11 00:50:591011 stream_ << TickCount() << ':';
1012 if (severity_ >= 0)
[email protected]80f360a2014-01-23 01:36:191013 stream_ << log_severity_name(severity_);
[email protected]eae9c062011-01-11 00:50:591014 else
1015 stream_ << "VERBOSE" << -severity_;
1016
1017 stream_ << ":" << filename << "(" << line << ")] ";
1018
pkasting9cf9b94a2014-10-01 22:18:431019 message_start_ = stream_.str().length();
[email protected]eae9c062011-01-11 00:50:591020}
1021
[email protected]d8617a62009-10-09 23:52:201022#if defined(OS_WIN)
1023// This has already been defined in the header, but defining it again as DWORD
1024// ensures that the type used in the header is equivalent to DWORD. If not,
1025// the redefinition is a compile error.
1026typedef DWORD SystemErrorCode;
1027#endif
1028
1029SystemErrorCode GetLastSystemErrorCode() {
1030#if defined(OS_WIN)
1031 return ::GetLastError();
Fabrice de Gans-Riberi306871de2018-05-16 19:38:391032#elif defined(OS_POSIX) || defined(OS_FUCHSIA)
[email protected]d8617a62009-10-09 23:52:201033 return errno;
[email protected]d8617a62009-10-09 23:52:201034#endif
1035}
1036
[email protected]c914d8a2014-04-23 01:11:011037BASE_EXPORT std::string SystemErrorCodeToString(SystemErrorCode error_code) {
Fabrice de Gans-Riberi306871de2018-05-16 19:38:391038#if defined(OS_WIN)
thestig75f87352014-12-03 21:42:271039 const int kErrorMessageBufferSize = 256;
1040 char msgbuf[kErrorMessageBufferSize];
[email protected]c914d8a2014-04-23 01:11:011041 DWORD flags = FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS;
thestig3e4787d2015-05-19 19:31:521042 DWORD len = FormatMessageA(flags, nullptr, error_code, 0, msgbuf,
Avi Drissmane3b70bf2019-01-04 19:50:221043 base::size(msgbuf), nullptr);
[email protected]c914d8a2014-04-23 01:11:011044 if (len) {
1045 // Messages returned by system end with line breaks.
1046 return base::CollapseWhitespaceASCII(msgbuf, true) +
Bruce Dawson19175842017-08-02 17:00:451047 base::StringPrintf(" (0x%lX)", error_code);
[email protected]c914d8a2014-04-23 01:11:011048 }
Bruce Dawson19175842017-08-02 17:00:451049 return base::StringPrintf("Error (0x%lX) while retrieving error. (0x%lX)",
[email protected]c914d8a2014-04-23 01:11:011050 GetLastError(), error_code);
Fabrice de Gans-Riberi306871de2018-05-16 19:38:391051#elif defined(OS_POSIX) || defined(OS_FUCHSIA)
Robert Sesekd2f495f2017-07-25 22:03:141052 return base::safe_strerror(error_code) +
1053 base::StringPrintf(" (%d)", error_code);
thestig3e4787d2015-05-19 19:31:521054#endif // defined(OS_WIN)
Fabrice de Gans-Riberi306871de2018-05-16 19:38:391055}
[email protected]d8617a62009-10-09 23:52:201056
[email protected]c914d8a2014-04-23 01:11:011057
1058#if defined(OS_WIN)
[email protected]d8617a62009-10-09 23:52:201059Win32ErrorLogMessage::Win32ErrorLogMessage(const char* file,
1060 int line,
1061 LogSeverity severity,
1062 SystemErrorCode err)
1063 : err_(err),
[email protected]d8617a62009-10-09 23:52:201064 log_message_(file, line, severity) {
1065}
1066
1067Win32ErrorLogMessage::~Win32ErrorLogMessage() {
[email protected]c914d8a2014-04-23 01:11:011068 stream() << ": " << SystemErrorCodeToString(err_);
[email protected]20909e72012-04-05 16:57:061069 // We're about to crash (CHECK). Put |err_| on the stack (by placing it in a
1070 // field) and use Alias in hopes that it makes it into crash dumps.
1071 DWORD last_error = err_;
1072 base::debug::Alias(&last_error);
[email protected]d8617a62009-10-09 23:52:201073}
Fabrice de Gans-Riberi306871de2018-05-16 19:38:391074#elif defined(OS_POSIX) || defined(OS_FUCHSIA)
[email protected]d8617a62009-10-09 23:52:201075ErrnoLogMessage::ErrnoLogMessage(const char* file,
1076 int line,
1077 LogSeverity severity,
1078 SystemErrorCode err)
1079 : err_(err),
1080 log_message_(file, line, severity) {
1081}
1082
1083ErrnoLogMessage::~ErrnoLogMessage() {
[email protected]c914d8a2014-04-23 01:11:011084 stream() << ": " << SystemErrorCodeToString(err_);
Robert Sesekd2f495f2017-07-25 22:03:141085 // We're about to crash (CHECK). Put |err_| on the stack (by placing it in a
1086 // field) and use Alias in hopes that it makes it into crash dumps.
1087 int last_error = err_;
1088 base::debug::Alias(&last_error);
[email protected]d8617a62009-10-09 23:52:201089}
thestig3e4787d2015-05-19 19:31:521090#endif // defined(OS_WIN)
[email protected]d8617a62009-10-09 23:52:201091
initial.commitd7cae122008-07-26 21:49:381092void CloseLogFile() {
Fabrice de Gans-Riberi306871de2018-05-16 19:38:391093#if defined(OS_POSIX) || defined(OS_FUCHSIA)
[email protected]5b84fe32010-09-14 22:24:551094 LoggingLock logging_lock;
ananta61762fb2015-09-18 01:00:091095#endif
[email protected]17dcf752013-07-15 21:47:091096 CloseLogFileUnlocked();
initial.commitd7cae122008-07-26 21:49:381097}
1098
Robbie McElrath8bf49842019-08-20 22:22:531099#if defined(OS_CHROMEOS)
1100FILE* DuplicateLogFILE() {
1101 if ((g_logging_destination & LOG_TO_FILE) == 0 || !InitializeLogFileHandle())
1102 return nullptr;
1103
1104 int log_fd = fileno(g_log_file);
1105 if (log_fd == -1)
1106 return nullptr;
1107 base::ScopedFD dup_fd(dup(log_fd));
1108 if (dup_fd == -1)
1109 return nullptr;
1110 FILE* duplicate = fdopen(dup_fd.get(), "a");
1111 if (!duplicate)
1112 return nullptr;
1113 ignore_result(dup_fd.release());
1114 return duplicate;
1115}
1116#endif
1117
[email protected]e36ddc82009-12-08 04:22:501118void RawLog(int level, const char* message) {
erikchen0c9fe712016-03-11 22:07:491119 if (level >= g_min_log_level && message) {
[email protected]e36ddc82009-12-08 04:22:501120 size_t bytes_written = 0;
1121 const size_t message_len = strlen(message);
1122 int rv;
1123 while (bytes_written < message_len) {
1124 rv = HANDLE_EINTR(
1125 write(STDERR_FILENO, message + bytes_written,
1126 message_len - bytes_written));
1127 if (rv < 0) {
1128 // Give up, nothing we can do now.
1129 break;
1130 }
1131 bytes_written += rv;
1132 }
1133
1134 if (message_len > 0 && message[message_len - 1] != '\n') {
1135 do {
1136 rv = HANDLE_EINTR(write(STDERR_FILENO, "\n", 1));
1137 if (rv < 0) {
1138 // Give up, nothing we can do now.
1139 break;
1140 }
1141 } while (rv != 1);
1142 }
1143 }
1144
1145 if (level == LOG_FATAL)
[email protected]58580352010-10-26 04:07:501146 base::debug::BreakDebugger();
[email protected]e36ddc82009-12-08 04:22:501147}
1148
[email protected]34a907732012-01-20 06:33:271149// This was defined at the beginning of this file.
1150#undef write
1151
[email protected]f01b88a2013-02-27 22:04:001152#if defined(OS_WIN)
ananta61762fb2015-09-18 01:00:091153bool IsLoggingToFileEnabled() {
1154 return g_logging_destination & LOG_TO_FILE;
1155}
1156
jdoerrie5c4dc4e2019-02-01 18:02:331157base::string16 GetLogFileFullPath() {
thestig3e4787d2015-05-19 19:31:521158 if (g_log_file_name)
1159 return *g_log_file_name;
jdoerrie5c4dc4e2019-02-01 18:02:331160 return base::string16();
[email protected]f01b88a2013-02-27 22:04:001161}
1162#endif
1163
tnagel80388e682015-05-26 13:27:561164BASE_EXPORT void LogErrorNotReached(const char* file, int line) {
tnagelff3f34a2015-05-24 12:59:141165 LogMessage(file, line, LOG_ERROR).stream()
1166 << "NOTREACHED() hit.";
1167}
1168
[email protected]96fd0032009-04-24 00:13:081169} // namespace logging
initial.commitd7cae122008-07-26 21:49:381170
[email protected]81411c62014-07-08 23:03:061171std::ostream& std::operator<<(std::ostream& out, const wchar_t* wstr) {
erikchen0c9fe712016-03-11 22:07:491172 return out << (wstr ? base::WideToUTF8(wstr) : std::string());
initial.commitd7cae122008-07-26 21:49:381173}