1 files changed, 251 insertions, 0 deletions
diff --git a/ipc/ipc_logging.cc b/ipc/ipc_logging.cc
new file mode 100644
index 000000000000..138e6acce735
--- /dev/null
+++ b/ipc/ipc_logging.cc
@@ -0,0 +1,251 @@
+// Copyright (c) 2010 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/command_line.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;
+
+// IPC::Logging is allocated as a singleton, so we don't need any kind of
+// special retention program.
+DISABLE_RUNNABLE_METHOD_REFCOUNT(IPC::Logging);
+
+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),
+      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);
+#else  // !defined(OS_WIN)
+  bool logging_env_var_set = (getenv("CHROME_IPC_LOGGING") != NULL);
+#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);
+    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);
+
+  if (MessageLoop::current() == main_thread_) {
+    Log(data);
+  } else {
+    main_thread_->PostTask(FROM_HERE, NewRunnableMethod(
+        this, &Logging::Log, 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);
+}
+
+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, NewRunnableMethod(
+            this, &Logging::OnSendLogs), 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;
+    }
+    fprintf(stderr, "ipc %s %d %s %s %s\n",
+            data.channel.c_str(),
+            data.routing_id,
+            data.flags.c_str(),
+            message_name.c_str(),
+            data.params.c_str());
+  }
+}
+
+void GenerateLogData(const std::string& channel, const Message& message,
+                     LogData* data) {
+  if (message.is_reply()) {
+    // "data" should already be filled in.
+    std::string params;
+    Logging::GetMessageText(data->type, NULL, &message, &params);
+
+    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, &params);
+
+    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