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

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: address comments, deque for listeners, reentrant test 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>
55 56
56 #include "base/base_switches.h" 57 #include "base/base_switches.h"
57 #include "base/command_line.h" 58 #include "base/command_line.h"
58 #include "base/debug/alias.h" 59 #include "base/debug/alias.h"
59 #include "base/debug/debugger.h" 60 #include "base/debug/debugger.h"
60 #include "base/debug/stack_trace.h" 61 #include "base/debug/stack_trace.h"
62 #include "base/lazy_instance.h"
61 #include "base/posix/eintr_wrapper.h" 63 #include "base/posix/eintr_wrapper.h"
62 #include "base/strings/string_piece.h" 64 #include "base/strings/string_piece.h"
63 #include "base/strings/string_util.h" 65 #include "base/strings/string_util.h"
64 #include "base/strings/stringprintf.h" 66 #include "base/strings/stringprintf.h"
65 #include "base/strings/sys_string_conversions.h" 67 #include "base/strings/sys_string_conversions.h"
66 #include "base/strings/utf_string_conversions.h" 68 #include "base/strings/utf_string_conversions.h"
67 #include "base/synchronization/lock_impl.h" 69 #include "base/synchronization/lock_impl.h"
70 #include "base/synchronization/read_write_lock.h"
68 #include "base/threading/platform_thread.h" 71 #include "base/threading/platform_thread.h"
69 #include "base/vlog.h" 72 #include "base/vlog.h"
70 #if defined(OS_POSIX) 73 #if defined(OS_POSIX)
71 #include "base/posix/safe_strerror.h" 74 #include "base/posix/safe_strerror.h"
72 #endif 75 #endif
73 76
74 #if defined(OS_ANDROID) 77 #if defined(OS_ANDROID)
75 #include <android/log.h> 78 #include <android/log.h>
76 #endif 79 #endif
77 80
(...skipping 38 matching lines...) Expand 10 before | Expand all | Expand 10 after
116 bool g_log_thread_id = false; 119 bool g_log_thread_id = false;
117 bool g_log_timestamp = true; 120 bool g_log_timestamp = true;
118 bool g_log_tickcount = false; 121 bool g_log_tickcount = false;
119 122
120 // Should we pop up fatal debug messages in a dialog? 123 // Should we pop up fatal debug messages in a dialog?
121 bool show_error_dialogs = false; 124 bool show_error_dialogs = false;
122 125
123 // An assert handler override specified by the client to be called instead of 126 // An assert handler override specified by the client to be called instead of
124 // the debug message dialog and process termination. 127 // the debug message dialog and process termination.
125 LogAssertHandlerFunction log_assert_handler = nullptr; 128 LogAssertHandlerFunction log_assert_handler = nullptr;
126 // A log message handler that gets notified of every log message we process. 129 // Log message handlers that get notified of every log message we process.
127 LogMessageHandlerFunction log_message_handler = nullptr; 130 base::LazyInstance<std::deque<LogMessageHandler*>>::Leaky log_message_handlers =
131 LAZY_INSTANCE_INITIALIZER;
132 base::LazyInstance<base::subtle::ReadWriteLock>::Leaky
133 log_message_handler_lock = LAZY_INSTANCE_INITIALIZER;
134 // Log message listeners that get notified of every log message we process
135 // before log message handlers.
136 base::LazyInstance<std::deque<LogMessageListener*>>::Leaky
137 log_message_listeners = LAZY_INSTANCE_INITIALIZER;
138 base::LazyInstance<base::subtle::ReadWriteLock>::Leaky
139 log_message_listener_lock = LAZY_INSTANCE_INITIALIZER;
128 140
129 // Helper functions to wrap platform differences. 141 // Helper functions to wrap platform differences.
130 142
131 int32_t CurrentProcessId() { 143 int32_t CurrentProcessId() {
132 #if defined(OS_WIN) 144 #if defined(OS_WIN)
133 return GetCurrentProcessId(); 145 return GetCurrentProcessId();
134 #elif defined(OS_POSIX) 146 #elif defined(OS_POSIX)
135 return getpid(); 147 return getpid();
136 #endif 148 #endif
137 } 149 }
(...skipping 197 matching lines...) Expand 10 before | Expand all | Expand 10 after
335 void CloseLogFileUnlocked() { 347 void CloseLogFileUnlocked() {
336 if (!g_log_file) 348 if (!g_log_file)
337 return; 349 return;
338 350
339 CloseFile(g_log_file); 351 CloseFile(g_log_file);
340 g_log_file = nullptr; 352 g_log_file = nullptr;
341 } 353 }
342 354
343 } // namespace 355 } // namespace
344 356
357 LogMessageHandler::LogMessageHandler() {
358 base::subtle::AutoWriteLock lock(log_message_handler_lock.Get());
359 log_message_handlers.Get().push_front(this);
360 }
361
362 LogMessageHandler::~LogMessageHandler() {
363 base::subtle::AutoWriteLock lock(log_message_handler_lock.Get());
364 auto& handlers = log_message_handlers.Get();
365 size_t count = handlers.size();
366 handlers.erase(std::remove(handlers.begin(), handlers.end(), this),
367 handlers.end());
368 DCHECK_EQ(count - 1, handlers.size());
369 }
370
371 size_t LogMessageHandlerCountForTesting() {
372 base::subtle::AutoReadLock lock(log_message_handler_lock.Get());
373 return log_message_handlers.Get().size();
374 }
375
376 LogMessageListener::LogMessageListener() {
Mark Mentovai 2016/11/14 14:40:43 So much duplication…
wychen 2016/11/18 21:13:59 No more. :)
377 base::subtle::AutoWriteLock lock(log_message_listener_lock.Get());
378 log_message_listeners.Get().push_front(this);
379 }
380
381 LogMessageListener::~LogMessageListener() {
382 base::subtle::AutoWriteLock lock(log_message_listener_lock.Get());
383 auto& listeners = log_message_listeners.Get();
384 size_t count = listeners.size();
385 listeners.erase(std::remove(listeners.begin(), listeners.end(), this),
386 listeners.end());
387 DCHECK_EQ(count - 1, listeners.size());
388 }
389
390 size_t LogMessageListenerCountForTesting() {
391 base::subtle::AutoReadLock lock(log_message_listener_lock.Get());
392 return log_message_listeners.Get().size();
393 }
394
345 LoggingSettings::LoggingSettings() 395 LoggingSettings::LoggingSettings()
346 : logging_dest(LOG_DEFAULT), 396 : logging_dest(LOG_DEFAULT),
347 log_file(nullptr), 397 log_file(nullptr),
348 lock_log(LOCK_LOG_FILE), 398 lock_log(LOCK_LOG_FILE),
349 delete_old(APPEND_TO_OLD_LOG_FILE) {} 399 delete_old(APPEND_TO_OLD_LOG_FILE) {}
350 400
351 bool BaseInitLoggingImpl(const LoggingSettings& settings) { 401 bool BaseInitLoggingImpl(const LoggingSettings& settings) {
352 #if defined(OS_NACL) 402 #if defined(OS_NACL)
353 // Can log only to the system debug log. 403 // Can log only to the system debug log.
354 CHECK_EQ(settings.logging_dest & ~LOG_TO_SYSTEM_DEBUG_LOG, 0); 404 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; 452 return g_min_log_level;
403 } 453 }
404 454
405 bool ShouldCreateLogMessage(int severity) { 455 bool ShouldCreateLogMessage(int severity) {
406 if (severity < g_min_log_level) 456 if (severity < g_min_log_level)
407 return false; 457 return false;
408 458
409 // Return true here unless we know ~LogMessage won't do anything. Note that 459 // Return true here unless we know ~LogMessage won't do anything. Note that
410 // ~LogMessage writes to stderr if severity_ >= kAlwaysPrintErrorLevel, even 460 // ~LogMessage writes to stderr if severity_ >= kAlwaysPrintErrorLevel, even
411 // when g_logging_destination is LOG_NONE. 461 // when g_logging_destination is LOG_NONE.
412 return g_logging_destination != LOG_NONE || log_message_handler || 462 bool handlers_empty, listeners_empty;
413 severity >= kAlwaysPrintErrorLevel; 463 {
464 base::subtle::AutoReadLock lock(log_message_handler_lock.Get());
465 handlers_empty = log_message_handlers.Get().empty();
466 }
467 {
468 base::subtle::AutoReadLock lock(log_message_listener_lock.Get());
469 listeners_empty = log_message_listeners.Get().empty();
470 }
471 return g_logging_destination != LOG_NONE || !handlers_empty ||
472 !listeners_empty || severity >= kAlwaysPrintErrorLevel;
414 } 473 }
415 474
416 int GetVlogVerbosity() { 475 int GetVlogVerbosity() {
417 return std::max(-1, LOG_INFO - GetMinLogLevel()); 476 return std::max(-1, LOG_INFO - GetMinLogLevel());
418 } 477 }
419 478
420 int GetVlogLevelHelper(const char* file, size_t N) { 479 int GetVlogLevelHelper(const char* file, size_t N) {
421 DCHECK_GT(N, 0U); 480 DCHECK_GT(N, 0U);
422 // Note: |g_vlog_info| may change on a different thread during startup 481 // Note: |g_vlog_info| may change on a different thread during startup
423 // (but will always be valid or nullptr). 482 // (but will always be valid or nullptr).
(...skipping 12 matching lines...) Expand all
436 } 495 }
437 496
438 void SetShowErrorDialogs(bool enable_dialogs) { 497 void SetShowErrorDialogs(bool enable_dialogs) {
439 show_error_dialogs = enable_dialogs; 498 show_error_dialogs = enable_dialogs;
440 } 499 }
441 500
442 void SetLogAssertHandler(LogAssertHandlerFunction handler) { 501 void SetLogAssertHandler(LogAssertHandlerFunction handler) {
443 log_assert_handler = handler; 502 log_assert_handler = handler;
444 } 503 }
445 504
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. 505 // Explicit instantiations for commonly used comparisons.
455 template std::string* MakeCheckOpString<int, int>( 506 template std::string* MakeCheckOpString<int, int>(
456 const int&, const int&, const char* names); 507 const int&, const int&, const char* names);
457 template std::string* MakeCheckOpString<unsigned long, unsigned long>( 508 template std::string* MakeCheckOpString<unsigned long, unsigned long>(
458 const unsigned long&, const unsigned long&, const char* names); 509 const unsigned long&, const unsigned long&, const char* names);
459 template std::string* MakeCheckOpString<unsigned long, unsigned int>( 510 template std::string* MakeCheckOpString<unsigned long, unsigned int>(
460 const unsigned long&, const unsigned int&, const char* names); 511 const unsigned long&, const unsigned int&, const char* names);
461 template std::string* MakeCheckOpString<unsigned int, unsigned long>( 512 template std::string* MakeCheckOpString<unsigned int, unsigned long>(
462 const unsigned int&, const unsigned long&, const char* names); 513 const unsigned int&, const unsigned long&, const char* names);
463 template std::string* MakeCheckOpString<std::string, std::string>( 514 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()) { 581 if (severity_ == LOG_FATAL && !base::debug::BeingDebugged()) {
531 // Include a stack trace on a fatal, unless a debugger is attached. 582 // Include a stack trace on a fatal, unless a debugger is attached.
532 base::debug::StackTrace trace; 583 base::debug::StackTrace trace;
533 stream_ << std::endl; // Newline to separate from log message. 584 stream_ << std::endl; // Newline to separate from log message.
534 trace.OutputToStream(&stream_); 585 trace.OutputToStream(&stream_);
535 } 586 }
536 #endif 587 #endif
537 stream_ << std::endl; 588 stream_ << std::endl;
538 std::string str_newline(stream_.str()); 589 std::string str_newline(stream_.str());
539 590
540 // Give any log message handler first dibs on the message. 591 {
541 if (log_message_handler && 592 base::subtle::AutoReadLock lock(log_message_listener_lock.Get());
542 log_message_handler(severity_, file_, line_, 593 // Broadcast to log message listeners first.
543 message_start_, str_newline)) { 594 for (auto* listener : log_message_listeners.Get()) {
544 // The handler took care of it, no further processing. 595 listener->OnMessage(severity_, file_, line_, message_start_, str_newline);
545 return; 596 }
597 }
598
599 {
600 base::subtle::AutoReadLock lock(log_message_handler_lock.Get());
601 // Give log message handlers first dibs on the message.
602 for (auto* handler : log_message_handlers.Get()) {
603 if (handler->OnMessage(severity_, file_, line_, message_start_,
604 str_newline)) {
605 // The handler took care of it, no further processing.
606 return;
607 }
608 }
546 } 609 }
547 610
548 if ((g_logging_destination & LOG_TO_SYSTEM_DEBUG_LOG) != 0) { 611 if ((g_logging_destination & LOG_TO_SYSTEM_DEBUG_LOG) != 0) {
549 #if defined(OS_WIN) 612 #if defined(OS_WIN)
550 OutputDebugStringA(str_newline.c_str()); 613 OutputDebugStringA(str_newline.c_str());
551 #elif defined(OS_MACOSX) 614 #elif defined(OS_MACOSX)
552 // In LOG_TO_SYSTEM_DEBUG_LOG mode, log messages are always written to 615 // 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 616 // 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 617 // 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 618 // 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) { 984 BASE_EXPORT void LogErrorNotReached(const char* file, int line) {
922 LogMessage(file, line, LOG_ERROR).stream() 985 LogMessage(file, line, LOG_ERROR).stream()
923 << "NOTREACHED() hit."; 986 << "NOTREACHED() hit.";
924 } 987 }
925 988
926 } // namespace logging 989 } // namespace logging
927 990
928 std::ostream& std::operator<<(std::ostream& out, const wchar_t* wstr) { 991 std::ostream& std::operator<<(std::ostream& out, const wchar_t* wstr) {
929 return out << (wstr ? base::WideToUTF8(wstr) : std::string()); 992 return out << (wstr ? base::WideToUTF8(wstr) : std::string());
930 } 993 }
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698