blob: fd8c064301735998e51023cd1bc85d3260049e47 [file] [log] [blame]
// Copyright (c) 2011 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.
#pragma once
#include "ipc/ipc_message.h" // For IPC_MESSAGE_LOG_ENABLED.
#include <vector>
#include "base/hash_tables.h"
#include "base/memory/scoped_ptr.h"
#include "base/memory/singleton.h"
#include "base/message_loop.h"
// Logging function. |name| is a string in ASCII and |params| is a string in
// UTF-8.
typedef void (*LogFunction)(std::string* name,
const IPC::Message* msg,
std::string* params);
typedef base::hash_map<uint32, LogFunction > LogFunctionMap;
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 {
// Implemented by consumers of log messages.
class Consumer {
virtual void Log(const LogData& data) = 0;
virtual ~Consumer() {}
void SetConsumer(Consumer* consumer);
static Logging* GetInstance();
// Enable and Disable are NOT cross-process; they only affect the
// current thread/process. If you want to modify the value for all
// processes, perhaps your intent is to call
// g_browser_process->SetIPCLoggingEnabled().
void Enable();
void Disable();
bool Enabled() const { return enabled_; }
// Called by child processes to give the logger object the channel to send
// logging data to the browser process.
void SetIPCSender(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::string& channel_id);
void OnPreDispatchMessage(const Message& message);
void OnPostDispatchMessage(const Message& message,
const std::string& 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
static void GetMessageText(uint32 type, std::string* name,
const Message* message, std::string* params);
static void set_log_function_map(LogFunctionMap* functions) {
log_function_map_ = functions;
static LogFunctionMap* log_function_map() {
return log_function_map_;
friend struct DefaultSingletonTraits<Logging>;
void OnSendLogs();
void Log(const LogData& data);
bool enabled_;
bool enabled_on_stderr_; // only used on POSIX for now
std::vector<LogData> queued_logs_;
bool queue_invoke_later_pending_;
Message::Sender* sender_;
MessageLoop* main_thread_;
Consumer* consumer_;
static LogFunctionMap* log_function_map_;
} // namespace IPC
#endif // IPC_IPC_LOGGING_H_