blob: 76bb24c4fb626f5d767c5dc272e981714e2fede7 [file] [log] [blame]
// 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 <map>
#include <string>
#include <vector>
#include "base/macros.h"
#include "base/memory/singleton.h"
#include "base/memory/writable_shared_memory_region.h"
#include "content/common/histogram_fetcher.mojom.h"
namespace content {
class HistogramSubscriber;
class ChildProcessHost;
class RenderProcessHost;
// HistogramController is used on the browser process to collect histogram data.
// Only the browser UI thread is allowed to interact with the
// HistogramController object.
class HistogramController {
// Returns the HistogramController object for the current process, or NULL if
// none.
static HistogramController* GetInstance();
// Normally instantiated when the child process is launched. Only one instance
// should be created per process.
virtual ~HistogramController();
// Register the subscriber so that it will be called when for example
// OnHistogramDataCollected is returning histogram data from a child process.
// This is called on UI thread.
void Register(HistogramSubscriber* subscriber);
// Unregister the subscriber so that it will not be called when for example
// OnHistogramDataCollected is returning histogram data from a child process.
// Safe to call even if caller is not the current subscriber.
void Unregister(const HistogramSubscriber* subscriber);
// Contact all processes and get their histogram data.
void GetHistogramData(int sequence_number);
// Notify the |subscriber_| that it should expect at least |pending_processes|
// additional calls to OnHistogramDataCollected(). OnPendingProcess() may be
// called repeatedly; the last call will have |end| set to true, indicating
// that there is no longer a possibility for the count of pending processes to
// increase. This is called on the UI thread.
void OnPendingProcesses(int sequence_number, int pending_processes, bool end);
// Send the |histogram| back to the |subscriber_|.
// This can be called from any thread.
void OnHistogramDataCollected(
int sequence_number,
const std::vector<std::string>& pickled_histograms);
template <class T>
void SetHistogramMemory(T*, base::WritableSharedMemoryRegion);
// Some hosts can be re-used before Mojo recognizes that their connections
// are invalid because the previous child process died.
template <class T>
void NotifyChildDied(T*);
friend struct base::LeakySingletonTraits<HistogramController>;
// Contact PLUGIN and GPU child processes and get their histogram data.
// TODO(rtenneti): Enable getting histogram data for other processes like
// PPAPI and NACL.
void GetHistogramDataFromChildProcesses(int sequence_number);
HistogramSubscriber* subscriber_;
template <class T>
using ChildHistogramFetcherMap =
std::map<T*, content::mojom::ChildHistogramFetcherPtr>;
template <class T>
void InsertChildHistogramFetcherInterface(
T* host,
content::mojom::ChildHistogramFetcherPtr child_histogram_fetcher);
template <class T>
content::mojom::ChildHistogramFetcher* GetChildHistogramFetcherInterface(
T* host);
template <class T>
void RemoveChildHistogramFetcherInterface(T* host);
// Specialize this template for each ChildHistogramFetcherMap defined below.
template <class T>
ChildHistogramFetcherMap<T>& GetChildHistogramFetcherMap();
ChildHistogramFetcherMap<RenderProcessHost> renderer_histogram_fetchers_;
ChildHistogramFetcherMap<ChildProcessHost> child_histogram_fetchers_;
} // namespace content