levin@chromium.org | 5c52868 | 2011-03-28 10:54:15 +0900 | [diff] [blame] | 1 | // Copyright (c) 2011 The Chromium Authors. All rights reserved. |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
| 5 | #ifndef IPC_IPC_LOGGING_H_ |
| 6 | #define IPC_IPC_LOGGING_H_ |
| 7 | |
davidsz | 3bf38eb | 2017-05-12 18:19:23 +0900 | [diff] [blame] | 8 | #include "ipc/ipc_features.h" |
| 9 | |
| 10 | #if BUILDFLAG(IPC_MESSAGE_LOG_ENABLED) |
| 11 | |
tfarina | 1cbfa08 | 2015-09-05 03:47:57 +0900 | [diff] [blame] | 12 | #include <stdint.h> |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 13 | #include <vector> |
| 14 | |
brettw@chromium.org | 30230a8 | 2013-06-12 02:52:44 +0900 | [diff] [blame] | 15 | #include "base/containers/hash_tables.h" |
fdoray | c10eab4 | 2016-06-21 05:23:32 +0900 | [diff] [blame] | 16 | #include "base/memory/ref_counted.h" |
levin@chromium.org | 5c52868 | 2011-03-28 10:54:15 +0900 | [diff] [blame] | 17 | #include "base/memory/singleton.h" |
fdoray | c10eab4 | 2016-06-21 05:23:32 +0900 | [diff] [blame] | 18 | #include "base/single_thread_task_runner.h" |
darin@chromium.org | 80e4c5e | 2011-08-16 05:41:46 +0900 | [diff] [blame] | 19 | #include "ipc/ipc_export.h" |
davidsz | 3bf38eb | 2017-05-12 18:19:23 +0900 | [diff] [blame] | 20 | #include "ipc/ipc_message.h" |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 21 | |
jam@chromium.org | 86a8de1 | 2010-12-09 08:34:16 +0900 | [diff] [blame] | 22 | // Logging function. |name| is a string in ASCII and |params| is a string in |
| 23 | // UTF-8. |
| 24 | typedef void (*LogFunction)(std::string* name, |
| 25 | const IPC::Message* msg, |
| 26 | std::string* params); |
| 27 | |
tfarina | 1cbfa08 | 2015-09-05 03:47:57 +0900 | [diff] [blame] | 28 | typedef base::hash_map<uint32_t, LogFunction > LogFunctionMap; |
jam@chromium.org | 86a8de1 | 2010-12-09 08:34:16 +0900 | [diff] [blame] | 29 | |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 30 | namespace IPC { |
| 31 | |
| 32 | class Message; |
viettrungluu@chromium.org | 5254ca0 | 2012-12-15 07:56:28 +0900 | [diff] [blame] | 33 | class Sender; |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 34 | |
| 35 | // One instance per process. Needs to be created on the main thread (the UI |
| 36 | // thread in the browser) but OnPreDispatchMessage/OnPostDispatchMessage |
| 37 | // can be called on other threads. |
darin@chromium.org | 80e4c5e | 2011-08-16 05:41:46 +0900 | [diff] [blame] | 38 | class IPC_EXPORT Logging { |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 39 | public: |
| 40 | // Implemented by consumers of log messages. |
| 41 | class Consumer { |
| 42 | public: |
| 43 | virtual void Log(const LogData& data) = 0; |
jamesr@chromium.org | ab4c65e | 2009-12-16 10:01:25 +0900 | [diff] [blame] | 44 | |
| 45 | protected: |
| 46 | virtual ~Consumer() {} |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 47 | }; |
| 48 | |
| 49 | void SetConsumer(Consumer* consumer); |
| 50 | |
| 51 | ~Logging(); |
satish@chromium.org | aa87060 | 2010-12-13 17:18:55 +0900 | [diff] [blame] | 52 | static Logging* GetInstance(); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 53 | |
jrg@chromium.org | f2b21be | 2009-09-29 06:08:04 +0900 | [diff] [blame] | 54 | // Enable and Disable are NOT cross-process; they only affect the |
| 55 | // current thread/process. If you want to modify the value for all |
| 56 | // processes, perhaps your intent is to call |
| 57 | // g_browser_process->SetIPCLoggingEnabled(). |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 58 | void Enable(); |
| 59 | void Disable(); |
| 60 | bool Enabled() const { return enabled_; } |
| 61 | |
| 62 | // Called by child processes to give the logger object the channel to send |
| 63 | // logging data to the browser process. |
brettw@chromium.org | f947ed0 | 2012-06-12 07:35:26 +0900 | [diff] [blame] | 64 | void SetIPCSender(Sender* sender); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 65 | |
| 66 | // Called in the browser process when logging data from a child process is |
| 67 | // received. |
| 68 | void OnReceivedLoggingMessage(const Message& message); |
| 69 | |
sammc | 65f302f | 2016-11-15 09:34:36 +0900 | [diff] [blame] | 70 | void OnSendMessage(Message* message); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 71 | void OnPreDispatchMessage(const Message& message); |
sammc | 65f302f | 2016-11-15 09:34:36 +0900 | [diff] [blame] | 72 | void OnPostDispatchMessage(const Message& message); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 73 | |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 74 | // Like the *MsgLog functions declared for each message class, except this |
| 75 | // calls the correct one based on the message type automatically. Defined in |
| 76 | // ipc_logging.cc. |
tfarina | 1cbfa08 | 2015-09-05 03:47:57 +0900 | [diff] [blame] | 77 | static void GetMessageText(uint32_t type, std::string* name, |
erg@google.com | 8aca727 | 2010-08-19 03:33:57 +0900 | [diff] [blame] | 78 | const Message* message, std::string* params); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 79 | |
jam@chromium.org | 86a8de1 | 2010-12-09 08:34:16 +0900 | [diff] [blame] | 80 | static void set_log_function_map(LogFunctionMap* functions) { |
| 81 | log_function_map_ = functions; |
| 82 | } |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 83 | |
jam@chromium.org | 86a8de1 | 2010-12-09 08:34:16 +0900 | [diff] [blame] | 84 | static LogFunctionMap* log_function_map() { |
| 85 | return log_function_map_; |
| 86 | } |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 87 | |
| 88 | private: |
scottbyer@chromium.org | f0cf0b7 | 2011-10-21 04:34:43 +0900 | [diff] [blame] | 89 | typedef enum { |
| 90 | ANSI_COLOR_RESET = -1, |
| 91 | ANSI_COLOR_BLACK, |
| 92 | ANSI_COLOR_RED, |
| 93 | ANSI_COLOR_GREEN, |
| 94 | ANSI_COLOR_YELLOW, |
| 95 | ANSI_COLOR_BLUE, |
| 96 | ANSI_COLOR_MAGENTA, |
| 97 | ANSI_COLOR_CYAN, |
| 98 | ANSI_COLOR_WHITE |
| 99 | } ANSIColor; |
| 100 | const char* ANSIEscape(ANSIColor color); |
| 101 | ANSIColor DelayColor(double delay); |
| 102 | |
olli.raula | 5ba9489 | 2015-09-10 20:14:22 +0900 | [diff] [blame] | 103 | friend struct base::DefaultSingletonTraits<Logging>; |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 104 | Logging(); |
| 105 | |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 106 | void OnSendLogs(); |
| 107 | void Log(const LogData& data); |
| 108 | |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 109 | bool enabled_; |
jrg@chromium.org | f2b21be | 2009-09-29 06:08:04 +0900 | [diff] [blame] | 110 | bool enabled_on_stderr_; // only used on POSIX for now |
scottbyer@chromium.org | f0cf0b7 | 2011-10-21 04:34:43 +0900 | [diff] [blame] | 111 | bool enabled_color_; // only used on POSIX for now |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 112 | |
| 113 | std::vector<LogData> queued_logs_; |
| 114 | bool queue_invoke_later_pending_; |
| 115 | |
brettw@chromium.org | f947ed0 | 2012-06-12 07:35:26 +0900 | [diff] [blame] | 116 | Sender* sender_; |
fdoray | c10eab4 | 2016-06-21 05:23:32 +0900 | [diff] [blame] | 117 | scoped_refptr<base::SingleThreadTaskRunner> main_thread_; |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 118 | |
| 119 | Consumer* consumer_; |
| 120 | |
jam@chromium.org | 86a8de1 | 2010-12-09 08:34:16 +0900 | [diff] [blame] | 121 | static LogFunctionMap* log_function_map_; |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 122 | }; |
| 123 | |
| 124 | } // namespace IPC |
| 125 | |
davidsz | 3bf38eb | 2017-05-12 18:19:23 +0900 | [diff] [blame] | 126 | #endif // BUILDFLAG(IPC_MESSAGE_LOG_ENABLED) |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 127 | |
| 128 | #endif // IPC_IPC_LOGGING_H_ |