Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(224)

Side by Side Diff: base/logging.cc

Issue 2034393004: Allow multiple logging::LogMessage{Handler,Listener}s Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: use ReadWriteLock, add comments Created 4 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be 2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file. 3 // found in the LICENSE file.
4 4
5 #include "base/logging.h" 5 #include "base/logging.h"
6 6
7 #include <limits.h> 7 #include <limits.h>
8 #include <stdint.h> 8 #include <stdint.h>
9 9
10 #include "base/macros.h" 10 #include "base/macros.h"
(...skipping 31 matching lines...) Expand 10 before | Expand all | Expand 10 after
42 #include <sys/stat.h> 42 #include <sys/stat.h>
43 #include <unistd.h> 43 #include <unistd.h>
44 #define MAX_PATH PATH_MAX 44 #define MAX_PATH PATH_MAX
45 typedef FILE* FileHandle; 45 typedef FILE* FileHandle;
46 typedef pthread_mutex_t* MutexHandle; 46 typedef pthread_mutex_t* MutexHandle;
47 #endif 47 #endif
48 48
49 #include <algorithm> 49 #include <algorithm>
50 #include <cstring> 50 #include <cstring>
51 #include <ctime> 51 #include <ctime>
52 #include <deque>
52 #include <iomanip> 53 #include <iomanip>
53 #include <ostream> 54 #include <ostream>
54 #include <string> 55 #include <string>
56 #include <unordered_set>
55 57
56 #include "base/base_switches.h" 58 #include "base/base_switches.h"
57 #include "base/command_line.h" 59 #include "base/command_line.h"
58 #include "base/debug/alias.h" 60 #include "base/debug/alias.h"
59 #include "base/debug/debugger.h" 61 #include "base/debug/debugger.h"
60 #include "base/debug/stack_trace.h" 62 #include "base/debug/stack_trace.h"
63 #include "base/lazy_instance.h"
61 #include "base/posix/eintr_wrapper.h" 64 #include "base/posix/eintr_wrapper.h"
62 #include "base/strings/string_piece.h" 65 #include "base/strings/string_piece.h"
63 #include "base/strings/string_util.h" 66 #include "base/strings/string_util.h"
64 #include "base/strings/stringprintf.h" 67 #include "base/strings/stringprintf.h"
65 #include "base/strings/sys_string_conversions.h" 68 #include "base/strings/sys_string_conversions.h"
66 #include "base/strings/utf_string_conversions.h" 69 #include "base/strings/utf_string_conversions.h"
67 #include "base/synchronization/lock_impl.h" 70 #include "base/synchronization/lock_impl.h"
71 #include "base/synchronization/read_write_lock.h"
68 #include "base/threading/platform_thread.h" 72 #include "base/threading/platform_thread.h"
69 #include "base/vlog.h" 73 #include "base/vlog.h"
70 #if defined(OS_POSIX) 74 #if defined(OS_POSIX)
71 #include "base/posix/safe_strerror.h" 75 #include "base/posix/safe_strerror.h"
72 #endif 76 #endif
73 77
74 #if defined(OS_ANDROID) 78 #if defined(OS_ANDROID)
75 #include <android/log.h> 79 #include <android/log.h>
76 #endif 80 #endif
77 81
(...skipping 38 matching lines...) Expand 10 before | Expand all | Expand 10 after
116 bool g_log_thread_id = false; 120 bool g_log_thread_id = false;
117 bool g_log_timestamp = true; 121 bool g_log_timestamp = true;
118 bool g_log_tickcount = false; 122 bool g_log_tickcount = false;
119 123
120 // Should we pop up fatal debug messages in a dialog? 124 // Should we pop up fatal debug messages in a dialog?
121 bool show_error_dialogs = false; 125 bool show_error_dialogs = false;
122 126
123 // An assert handler override specified by the client to be called instead of 127 // An assert handler override specified by the client to be called instead of
124 // the debug message dialog and process termination. 128 // the debug message dialog and process termination.
125 LogAssertHandlerFunction log_assert_handler = nullptr; 129 LogAssertHandlerFunction log_assert_handler = nullptr;
126 // A log message handler that gets notified of every log message we process. 130 // Log message handlers that get notified of every log message we process.
127 LogMessageHandlerFunction log_message_handler = nullptr; 131 base::LazyInstance<std::deque<LogMessageHandler*>>::Leaky log_message_handlers =
132 LAZY_INSTANCE_INITIALIZER;
133 base::LazyInstance<base::subtle::ReadWriteLock>::Leaky
134 log_message_handler_lock = LAZY_INSTANCE_INITIALIZER;
135 // Log message listeners that get notified of every log message we process
136 // before log message handlers.
137 base::LazyInstance<std::unordered_set<LogMessageListener*>>::Leaky
wychen 2016/08/17 17:08:54 Note to self: use deque.
138 log_message_listeners = LAZY_INSTANCE_INITIALIZER;
139 base::LazyInstance<base::subtle::ReadWriteLock>::Leaky
140 log_message_listener_lock = LAZY_INSTANCE_INITIALIZER;
128 141
129 // Helper functions to wrap platform differences. 142 // Helper functions to wrap platform differences.
130 143
131 int32_t CurrentProcessId() { 144 int32_t CurrentProcessId() {
132 #if defined(OS_WIN) 145 #if defined(OS_WIN)
133 return GetCurrentProcessId(); 146 return GetCurrentProcessId();
134 #elif defined(OS_POSIX) 147 #elif defined(OS_POSIX)
135 return getpid(); 148 return getpid();
136 #endif 149 #endif
137 } 150 }
(...skipping 197 matching lines...) Expand 10 before | Expand all | Expand 10 after
335 void CloseLogFileUnlocked() { 348 void CloseLogFileUnlocked() {
336 if (!g_log_file) 349 if (!g_log_file)
337 return; 350 return;
338 351
339 CloseFile(g_log_file); 352 CloseFile(g_log_file);
340 g_log_file = nullptr; 353 g_log_file = nullptr;
341 } 354 }
342 355
343 } // namespace 356 } // namespace
344 357
358 LogMessageHandler::LogMessageHandler() {
359 base::subtle::AutoWriteLock lock(log_message_handler_lock.Get());
360 log_message_handlers.Get().push_front(this);
361 }
362
363 LogMessageHandler::~LogMessageHandler() {
364 base::subtle::AutoWriteLock lock(log_message_handler_lock.Get());
365 auto& handlers = log_message_handlers.Get();
366 size_t count = handlers.size();
367 handlers.erase(std::remove(handlers.begin(), handlers.end(), this),
368 handlers.end());
369 DCHECK_EQ(count - 1, handlers.size());
370 }
371
372 size_t LogMessageHandlerCountForTesting() {
373 base::subtle::AutoReadLock lock(log_message_handler_lock.Get());
374 return log_message_handlers.Get().size();
375 }
376
377 LogMessageListener::LogMessageListener() {
378 base::subtle::AutoWriteLock lock(log_message_listener_lock.Get());
379 log_message_listeners.Get().insert(this);
380 }
381
382 LogMessageListener::~LogMessageListener() {
383 base::subtle::AutoWriteLock lock(log_message_listener_lock.Get());
384 size_t erased_count = log_message_listeners.Get().erase(this);
385 DCHECK_EQ(1u, erased_count);
386 }
387
388 size_t LogMessageListenerCountForTesting() {
389 base::subtle::AutoReadLock lock(log_message_listener_lock.Get());
390 return log_message_listeners.Get().size();
391 }
392
345 LoggingSettings::LoggingSettings() 393 LoggingSettings::LoggingSettings()
346 : logging_dest(LOG_DEFAULT), 394 : logging_dest(LOG_DEFAULT),
347 log_file(nullptr), 395 log_file(nullptr),
348 lock_log(LOCK_LOG_FILE), 396 lock_log(LOCK_LOG_FILE),
349 delete_old(APPEND_TO_OLD_LOG_FILE) {} 397 delete_old(APPEND_TO_OLD_LOG_FILE) {}
350 398
351 bool BaseInitLoggingImpl(const LoggingSettings& settings) { 399 bool BaseInitLoggingImpl(const LoggingSettings& settings) {
352 #if defined(OS_NACL) 400 #if defined(OS_NACL)
353 // Can log only to the system debug log. 401 // Can log only to the system debug log.
354 CHECK_EQ(settings.logging_dest & ~LOG_TO_SYSTEM_DEBUG_LOG, 0); 402 CHECK_EQ(settings.logging_dest & ~LOG_TO_SYSTEM_DEBUG_LOG, 0);
(...skipping 47 matching lines...) Expand 10 before | Expand all | Expand 10 after
402 return g_min_log_level; 450 return g_min_log_level;
403 } 451 }
404 452
405 bool ShouldCreateLogMessage(int severity) { 453 bool ShouldCreateLogMessage(int severity) {
406 if (severity < g_min_log_level) 454 if (severity < g_min_log_level)
407 return false; 455 return false;
408 456
409 // Return true here unless we know ~LogMessage won't do anything. Note that 457 // Return true here unless we know ~LogMessage won't do anything. Note that
410 // ~LogMessage writes to stderr if severity_ >= kAlwaysPrintErrorLevel, even 458 // ~LogMessage writes to stderr if severity_ >= kAlwaysPrintErrorLevel, even
411 // when g_logging_destination is LOG_NONE. 459 // when g_logging_destination is LOG_NONE.
412 return g_logging_destination != LOG_NONE || log_message_handler || 460 bool handlers_empty, listeners_empty;
413 severity >= kAlwaysPrintErrorLevel; 461 {
462 base::subtle::AutoReadLock lock(log_message_handler_lock.Get());
463 handlers_empty = log_message_handlers.Get().empty();
464 }
465 {
466 base::subtle::AutoReadLock lock(log_message_listener_lock.Get());
467 listeners_empty = log_message_listeners.Get().empty();
468 }
469 return g_logging_destination != LOG_NONE || !handlers_empty ||
470 !listeners_empty || severity >= kAlwaysPrintErrorLevel;
414 } 471 }
415 472
416 int GetVlogVerbosity() { 473 int GetVlogVerbosity() {
417 return std::max(-1, LOG_INFO - GetMinLogLevel()); 474 return std::max(-1, LOG_INFO - GetMinLogLevel());
418 } 475 }
419 476
420 int GetVlogLevelHelper(const char* file, size_t N) { 477 int GetVlogLevelHelper(const char* file, size_t N) {
421 DCHECK_GT(N, 0U); 478 DCHECK_GT(N, 0U);
422 // Note: |g_vlog_info| may change on a different thread during startup 479 // Note: |g_vlog_info| may change on a different thread during startup
423 // (but will always be valid or nullptr). 480 // (but will always be valid or nullptr).
(...skipping 12 matching lines...) Expand all
436 } 493 }
437 494
438 void SetShowErrorDialogs(bool enable_dialogs) { 495 void SetShowErrorDialogs(bool enable_dialogs) {
439 show_error_dialogs = enable_dialogs; 496 show_error_dialogs = enable_dialogs;
440 } 497 }
441 498
442 void SetLogAssertHandler(LogAssertHandlerFunction handler) { 499 void SetLogAssertHandler(LogAssertHandlerFunction handler) {
443 log_assert_handler = handler; 500 log_assert_handler = handler;
444 } 501 }
445 502
446 void SetLogMessageHandler(LogMessageHandlerFunction handler) {
447 log_message_handler = handler;
448 }
449
450 LogMessageHandlerFunction GetLogMessageHandler() {
451 return log_message_handler;
452 }
453
454 // Explicit instantiations for commonly used comparisons. 503 // Explicit instantiations for commonly used comparisons.
455 template std::string* MakeCheckOpString<int, int>( 504 template std::string* MakeCheckOpString<int, int>(
456 const int&, const int&, const char* names); 505 const int&, const int&, const char* names);
457 template std::string* MakeCheckOpString<unsigned long, unsigned long>( 506 template std::string* MakeCheckOpString<unsigned long, unsigned long>(
458 const unsigned long&, const unsigned long&, const char* names); 507 const unsigned long&, const unsigned long&, const char* names);
459 template std::string* MakeCheckOpString<unsigned long, unsigned int>( 508 template std::string* MakeCheckOpString<unsigned long, unsigned int>(
460 const unsigned long&, const unsigned int&, const char* names); 509 const unsigned long&, const unsigned int&, const char* names);
461 template std::string* MakeCheckOpString<unsigned int, unsigned long>( 510 template std::string* MakeCheckOpString<unsigned int, unsigned long>(
462 const unsigned int&, const unsigned long&, const char* names); 511 const unsigned int&, const unsigned long&, const char* names);
463 template std::string* MakeCheckOpString<std::string, std::string>( 512 template std::string* MakeCheckOpString<std::string, std::string>(
(...skipping 66 matching lines...) Expand 10 before | Expand all | Expand 10 after
530 if (severity_ == LOG_FATAL && !base::debug::BeingDebugged()) { 579 if (severity_ == LOG_FATAL && !base::debug::BeingDebugged()) {
531 // Include a stack trace on a fatal, unless a debugger is attached. 580 // Include a stack trace on a fatal, unless a debugger is attached.
532 base::debug::StackTrace trace; 581 base::debug::StackTrace trace;
533 stream_ << std::endl; // Newline to separate from log message. 582 stream_ << std::endl; // Newline to separate from log message.
534 trace.OutputToStream(&stream_); 583 trace.OutputToStream(&stream_);
535 } 584 }
536 #endif 585 #endif
537 stream_ << std::endl; 586 stream_ << std::endl;
538 std::string str_newline(stream_.str()); 587 std::string str_newline(stream_.str());
539 588
540 // Give any log message handler first dibs on the message. 589 {
541 if (log_message_handler && 590 base::subtle::AutoReadLock lock(log_message_listener_lock.Get());
542 log_message_handler(severity_, file_, line_, 591 // Broadcast to log message listeners first.
543 message_start_, str_newline)) { 592 for (auto* listener : log_message_listeners.Get()) {
544 // The handler took care of it, no further processing. 593 listener->OnMessage(severity_, file_, line_, message_start_, str_newline);
545 return; 594 }
595 }
596
597 {
598 base::subtle::AutoReadLock lock(log_message_handler_lock.Get());
599 // Give log message handlers first dibs on the message.
600 for (auto* handler : log_message_handlers.Get()) {
601 if (handler->OnMessage(severity_, file_, line_, message_start_,
602 str_newline)) {
603 // The handler took care of it, no further processing.
604 return;
605 }
606 }
546 } 607 }
547 608
548 if ((g_logging_destination & LOG_TO_SYSTEM_DEBUG_LOG) != 0) { 609 if ((g_logging_destination & LOG_TO_SYSTEM_DEBUG_LOG) != 0) {
549 #if defined(OS_WIN) 610 #if defined(OS_WIN)
550 OutputDebugStringA(str_newline.c_str()); 611 OutputDebugStringA(str_newline.c_str());
551 #elif defined(OS_MACOSX) 612 #elif defined(OS_MACOSX)
552 // In LOG_TO_SYSTEM_DEBUG_LOG mode, log messages are always written to 613 // In LOG_TO_SYSTEM_DEBUG_LOG mode, log messages are always written to
553 // stderr. If stderr is /dev/null, also log via ASL (Apple System Log). If 614 // stderr. If stderr is /dev/null, also log via ASL (Apple System Log). If
554 // there's something weird about stderr, assume that log messages are going 615 // there's something weird about stderr, assume that log messages are going
555 // nowhere and log via ASL too. Messages logged via ASL show up in 616 // nowhere and log via ASL too. Messages logged via ASL show up in
(...skipping 365 matching lines...) Expand 10 before | Expand all | Expand 10 after
921 BASE_EXPORT void LogErrorNotReached(const char* file, int line) { 982 BASE_EXPORT void LogErrorNotReached(const char* file, int line) {
922 LogMessage(file, line, LOG_ERROR).stream() 983 LogMessage(file, line, LOG_ERROR).stream()
923 << "NOTREACHED() hit."; 984 << "NOTREACHED() hit.";
924 } 985 }
925 986
926 } // namespace logging 987 } // namespace logging
927 988
928 std::ostream& std::operator<<(std::ostream& out, const wchar_t* wstr) { 989 std::ostream& std::operator<<(std::ostream& out, const wchar_t* wstr) {
929 return out << (wstr ? base::WideToUTF8(wstr) : std::string()); 990 return out << (wstr ? base::WideToUTF8(wstr) : std::string());
930 } 991 }
OLDNEW
« no previous file with comments | « base/logging.h ('k') | base/logging_unittest.cc » ('j') | base/logging_unittest.cc » ('J')

Powered by Google App Engine
This is Rietveld 408576698