1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
|
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "ipc/ipc_logging.h"
#ifdef IPC_MESSAGE_LOG_ENABLED
#define IPC_MESSAGE_MACROS_LOG_ENABLED
#endif
#include "base/bind.h"
#include "base/bind_helpers.h"
#include "base/command_line.h"
#include "base/location.h"
#include "base/logging.h"
#include "base/message_loop.h"
#include "base/process_util.h"
#include "base/string_number_conversions.h"
#include "base/string_util.h"
#include "base/threading/thread.h"
#include "base/time.h"
#include "ipc/ipc_switches.h"
#include "ipc/ipc_sync_message.h"
#include "ipc/ipc_message_utils.h"
#if defined(OS_POSIX)
#include <unistd.h>
#endif
#ifdef IPC_MESSAGE_LOG_ENABLED
using base::Time;
namespace IPC {
const int kLogSendDelayMs = 100;
// We use a pointer to the function table to avoid any linker dependencies on
// all the traits used as IPC message parameters.
LogFunctionMap* Logging::log_function_map_;
Logging::Logging()
: enabled_(false),
enabled_on_stderr_(false),
enabled_color_(false),
queue_invoke_later_pending_(false),
sender_(NULL),
main_thread_(MessageLoop::current()),
consumer_(NULL) {
#if defined(OS_WIN)
// getenv triggers an unsafe warning. Simply check how big of a buffer
// would be needed to fetch the value to see if the enviornment variable is
// set.
size_t requiredSize = 0;
getenv_s(&requiredSize, NULL, 0, "CHROME_IPC_LOGGING");
bool logging_env_var_set = (requiredSize != 0);
if (requiredSize <= 6) {
char buffer[6];
getenv_s(&requiredSize, buffer, sizeof(buffer), "CHROME_IPC_LOGGING");
if (requiredSize && !strncmp("color", buffer, 6))
enabled_color_ = true;
}
#else // !defined(OS_WIN)
const char* ipc_logging = getenv("CHROME_IPC_LOGGING");
bool logging_env_var_set = (ipc_logging != NULL);
if (ipc_logging && !strcmp(ipc_logging, "color"))
enabled_color_ = true;
#endif //defined(OS_WIN)
if (logging_env_var_set) {
enabled_ = true;
enabled_on_stderr_ = true;
}
}
Logging::~Logging() {
}
Logging* Logging::GetInstance() {
return Singleton<Logging>::get();
}
void Logging::SetConsumer(Consumer* consumer) {
consumer_ = consumer;
}
void Logging::Enable() {
enabled_ = true;
}
void Logging::Disable() {
enabled_ = false;
}
void Logging::OnSendLogs() {
queue_invoke_later_pending_ = false;
if (!sender_)
return;
Message* msg = new Message(
MSG_ROUTING_CONTROL, IPC_LOGGING_ID, Message::PRIORITY_NORMAL);
WriteParam(msg, queued_logs_);
queued_logs_.clear();
sender_->Send(msg);
}
void Logging::SetIPCSender(IPC::Message::Sender* sender) {
sender_ = sender;
}
void Logging::OnReceivedLoggingMessage(const Message& message) {
std::vector<LogData> data;
void* iter = NULL;
if (!ReadParam(&message, &iter, &data))
return;
for (size_t i = 0; i < data.size(); ++i) {
Log(data[i]);
}
}
void Logging::OnSendMessage(Message* message, const std::string& channel_id) {
if (!Enabled())
return;
if (message->is_reply()) {
LogData* data = message->sync_log_data();
if (!data)
return;
// This is actually the delayed reply to a sync message. Create a string
// of the output parameters, add it to the LogData that was earlier stashed
// with the reply, and log the result.
data->channel = channel_id;
GenerateLogData("", *message, data, true);
Log(*data);
delete data;
message->set_sync_log_data(NULL);
} else {
// If the time has already been set (i.e. by ChannelProxy), keep that time
// instead as it's more accurate.
if (!message->sent_time())
message->set_sent_time(Time::Now().ToInternalValue());
}
}
void Logging::OnPreDispatchMessage(const Message& message) {
message.set_received_time(Time::Now().ToInternalValue());
}
void Logging::OnPostDispatchMessage(const Message& message,
const std::string& channel_id) {
if (!Enabled() ||
!message.sent_time() ||
!message.received_time() ||
message.dont_log())
return;
LogData data;
GenerateLogData(channel_id, message, &data, true);
if (MessageLoop::current() == main_thread_) {
Log(data);
} else {
main_thread_->PostTask(
FROM_HERE, base::Bind(&Logging::Log, base::Unretained(this), data));
}
}
void Logging::GetMessageText(uint32 type, std::string* name,
const Message* message,
std::string* params) {
if (!log_function_map_)
return;
LogFunctionMap::iterator it = log_function_map_->find(type);
if (it == log_function_map_->end()) {
if (name) {
*name = "[UNKNOWN MSG ";
*name += base::IntToString(type);
*name += " ]";
}
return;
}
(*it->second)(name, message, params);
}
const char* Logging::ANSIEscape(ANSIColor color) {
if (!enabled_color_)
return "";
switch (color) {
case ANSI_COLOR_RESET:
return "\033[m";
case ANSI_COLOR_BLACK:
return "\033[0;30m";
case ANSI_COLOR_RED:
return "\033[0;31m";
case ANSI_COLOR_GREEN:
return "\033[0;32m";
case ANSI_COLOR_YELLOW:
return "\033[0;33m";
case ANSI_COLOR_BLUE:
return "\033[0;34m";
case ANSI_COLOR_MAGENTA:
return "\033[0;35m";
case ANSI_COLOR_CYAN:
return "\033[0;36m";
case ANSI_COLOR_WHITE:
return "\033[0;37m";
}
return "";
}
Logging::ANSIColor Logging::DelayColor(double delay) {
if (delay < 0.1)
return ANSI_COLOR_GREEN;
if (delay < 0.25)
return ANSI_COLOR_BLACK;
if (delay < 0.5)
return ANSI_COLOR_YELLOW;
return ANSI_COLOR_RED;
}
void Logging::Log(const LogData& data) {
if (consumer_) {
// We're in the browser process.
consumer_->Log(data);
} else {
// We're in the renderer or plugin processes.
if (sender_) {
queued_logs_.push_back(data);
if (!queue_invoke_later_pending_) {
queue_invoke_later_pending_ = true;
MessageLoop::current()->PostDelayedTask(
FROM_HERE, base::Bind(&Logging::OnSendLogs, base::Unretained(this)),
base::TimeDelta::FromMilliseconds(kLogSendDelayMs));
}
}
}
if (enabled_on_stderr_) {
std::string message_name;
if (data.message_name.empty()) {
message_name = StringPrintf("[unknown type %d]", data.type);
} else {
message_name = data.message_name;
}
double receive_delay =
(Time::FromInternalValue(data.receive) -
Time::FromInternalValue(data.sent)).InSecondsF();
double dispatch_delay =
(Time::FromInternalValue(data.dispatch) -
Time::FromInternalValue(data.sent)).InSecondsF();
fprintf(stderr,
"ipc %s %d %s %s%s %s%s\n %18.5f %s%18.5f %s%18.5f%s\n",
data.channel.c_str(),
data.routing_id,
data.flags.c_str(),
ANSIEscape(sender_ ? ANSI_COLOR_BLUE : ANSI_COLOR_CYAN),
message_name.c_str(),
ANSIEscape(ANSI_COLOR_RESET),
data.params.c_str(),
Time::FromInternalValue(data.sent).ToDoubleT(),
ANSIEscape(DelayColor(receive_delay)),
Time::FromInternalValue(data.receive).ToDoubleT(),
ANSIEscape(DelayColor(dispatch_delay)),
Time::FromInternalValue(data.dispatch).ToDoubleT(),
ANSIEscape(ANSI_COLOR_RESET)
);
}
}
void GenerateLogData(const std::string& channel, const Message& message,
LogData* data, bool get_params) {
if (message.is_reply()) {
// "data" should already be filled in.
std::string params;
Logging::GetMessageText(data->type, NULL, &message, ¶ms);
if (!data->params.empty() && !params.empty())
data->params += ", ";
data->flags += " DR";
data->params += params;
} else {
std::string flags;
if (message.is_sync())
flags = "S";
if (message.is_reply())
flags += "R";
if (message.is_reply_error())
flags += "E";
std::string params, message_name;
Logging::GetMessageText(message.type(), &message_name, &message,
get_params ? ¶ms : NULL);
data->channel = channel;
data->routing_id = message.routing_id();
data->type = message.type();
data->flags = flags;
data->sent = message.sent_time();
data->receive = message.received_time();
data->dispatch = Time::Now().ToInternalValue();
data->params = params;
data->message_name = message_name;
}
}
}
#endif // IPC_MESSAGE_LOG_ENABLED
|