blob: 42cf4b358fa7653dd9e117cf12cbe0382e609ed9 [file] [log] [blame] [edit]
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CONTENT_PUBLIC_RENDERER_RENDER_THREAD_H_
#define CONTENT_PUBLIC_RENDERER_RENDER_THREAD_H_
#include <stddef.h>
#include <stdint.h>
#include <memory>
#include "base/auto_reset.h"
#include "base/functional/callback_forward.h"
#include "base/memory/scoped_refptr.h"
#include "base/task/single_thread_task_runner.h"
#include "content/common/buildflags.h"
#include "content/common/content_export.h"
#include "content/public/child/child_thread.h"
#include "third_party/blink/public/common/tokens/tokens.h"
#include "third_party/blink/public/platform/web_string.h"
#include "third_party/perfetto/include/perfetto/tracing/traced_proto.h"
namespace base {
class UnguessableToken;
class WaitableEvent;
}
namespace blink {
struct UserAgentMetadata;
namespace scheduler {
enum class WebRendererProcessType;
}
} // namespace blink
namespace perfetto::protos::pbzero {
class RenderProcessHost;
}
namespace IPC {
class Listener;
#if BUILDFLAG(CONTENT_ENABLE_LEGACY_IPC)
class MessageFilter;
#endif
class SyncChannel;
class SyncMessageFilter;
} // namespace IPC
namespace content {
class RenderThreadObserver;
class CONTENT_EXPORT RenderThread : virtual public ChildThread {
public:
// Returns the one render thread for this process. Note that this can only
// be accessed when running on the render thread itself.
static RenderThread* Get();
// Returns true if the current thread is the main thread.
static bool IsMainThread();
RenderThread();
~RenderThread() override;
virtual IPC::SyncChannel* GetChannel() = 0;
virtual std::string GetLocale() = 0;
#if BUILDFLAG(CONTENT_ENABLE_LEGACY_IPC)
virtual IPC::SyncMessageFilter* GetSyncMessageFilter() = 0;
// Called to add or remove a listener for a particular message routing ID.
// These methods normally get delegated to a MessageRouter.
virtual void AddRoute(int32_t routing_id, IPC::Listener* listener) = 0;
// Attach a task runner to run received IPC tasks on for the given routing ID.
// This must be called after the route has already been added via AddRoute(),
// but it is optional. The default main thread task runner would be used if
// this method is not called.
virtual void AttachTaskRunnerToRoute(
int32_t routing_id,
scoped_refptr<base::SingleThreadTaskRunner> task_runner) = 0;
virtual void RemoveRoute(int32_t routing_id) = 0;
// These map to IPC::ChannelProxy methods.
virtual void AddFilter(IPC::MessageFilter* filter) = 0;
virtual void RemoveFilter(IPC::MessageFilter* filter) = 0;
#endif
virtual bool GenerateFrameRoutingID(
int32_t& routing_id,
blink::LocalFrameToken& frame_token,
base::UnguessableToken& devtools_frame_token,
blink::DocumentToken& document_token) = 0;
// Add/remove observers for the process.
virtual void AddObserver(RenderThreadObserver* observer) = 0;
virtual void RemoveObserver(RenderThreadObserver* observer) = 0;
// Post task to all worker threads. Returns number of workers.
virtual int PostTaskToAllWebWorkers(base::RepeatingClosure closure) = 0;
// Gets the shutdown event for the process.
virtual base::WaitableEvent* GetShutdownEvent() = 0;
// Retrieve the process ID of the browser process.
virtual int32_t GetClientId() = 0;
// Set the renderer process type.
virtual void SetRendererProcessType(
blink::scheduler::WebRendererProcessType type) = 0;
// Returns the user-agent string.
virtual blink::WebString GetUserAgent() = 0;
virtual const blink::UserAgentMetadata& GetUserAgentMetadata() = 0;
// Write a representation of the current Renderer process into a trace.
virtual void WriteIntoTrace(
perfetto::TracedProto<perfetto::protos::pbzero::RenderProcessHost>
proto) = 0;
private:
const base::AutoReset<RenderThread*> resetter_;
};
} // namespace content
#endif // CONTENT_PUBLIC_RENDERER_RENDER_THREAD_H_