chrome/common/ipc_logging.h

// Copyright (c) 2006-2008 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.

#ifndef CHROME_COMMON_IPC_LOGGING_H_
#define CHROME_COMMON_IPC_LOGGING_H_

#include "chrome/common/ipc_message.h"  // For IPC_MESSAGE_LOG_ENABLED.

#ifdef IPC_MESSAGE_LOG_ENABLED

#include "base/lock.h"
#include "base/object_watcher.h"
#include "base/singleton.h"

class MessageLoop;

namespace IPC {

class Message;

// One instance per process.  Needs to be created on the main thread (the UI
// thread in the browser) but OnPreDispatchMessage/OnPostDispatchMessage
// can be called on other threads.
class Logging : public base::ObjectWatcher::Delegate {
 public:
  // Implemented by consumers of log messages.
  class Consumer {
   public:
    virtual void Log(const IPC::LogData& data) = 0;
  };

  void SetConsumer(Consumer* consumer);

  ~Logging();
  static Logging* current();

  void Enable();
  void Disable();
  bool inline Enabled() const;

  // Called by child processes to give the logger object the channel to send
  // logging data to the browser process.
  void SetIPCSender(IPC::Message::Sender* sender);

  // Called in the browser process when logging data from a child process is
  // received.
  void OnReceivedLoggingMessage(const Message& message);

  void OnSendMessage(Message* message, const std::wstring& channel_id);
  void OnPreDispatchMessage(const Message& message);
  void OnPostDispatchMessage(const Message& message,
                             const std::wstring& channel_id);

  // Returns the name of the logging enabled/disabled events so that the
  // sandbox can add them to to the policy.  If true, gets the name of the
  // enabled event, if false, gets the name of the disabled event.
  static std::wstring GetEventName(bool enabled);

  // Like the *MsgLog functions declared for each message class, except this
  // calls the correct one based on the message type automatically.  Defined in
  // ipc_logging.cc.
  static void GetMessageText(uint16 type, std::wstring* name,
                             const Message* message, std::wstring* params);

  // ObjectWatcher::Delegate implementation
  void OnObjectSignaled(HANDLE object);

 private:
  friend struct DefaultSingletonTraits<IPC::Logging>;
  Logging();

  std::wstring GetEventName(int browser_pid, bool enabled);
  void OnSendLogs();
  void Log(const LogData& data);

  void RegisterWaitForEvent(bool enabled);

  base::ObjectWatcher watcher_;

  HANDLE logging_event_on_;
  HANDLE logging_event_off_;
  bool enabled_;

  std::vector<LogData> queued_logs_;
  bool queue_invoke_later_pending_;

  IPC::Message::Sender* sender_;
  MessageLoop* main_thread_;

  Consumer* consumer_;
};

}  // namespace IPC

#endif // IPC_MESSAGE_LOG_ENABLED

#endif  // CHROME_COMMON_IPC_LOGGING_H_