render_thread.h revision 116680a4aac90f2aa7413d9095a592090648e557
1f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles)#ifndef CONTENT_PUBLIC_RENDERER_RENDER_THREAD_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define CONTENT_PUBLIC_RENDERER_RENDER_THREAD_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 82a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "base/basictypes.h" 92a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "base/callback.h" 102a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "base/memory/shared_memory.h" 112a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "base/metrics/user_metrics_action.h" 125d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)#include "content/common/content_export.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ipc/ipc_channel_proxy.h" 14ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch#include "ipc/ipc_sender.h" 15c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(OS_WIN) 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <windows.h> 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2058e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdochclass GURL; 21a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace base { 23a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)class MessageLoop; 245d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)class MessageLoopProxy; 25eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdochclass WaitableEvent; 26bb1529ce867d8845a77ec7cdf3e3003ef1771a40Ben Murdoch} 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace IPC { 29a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)class MessageFilter; 30a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)class SyncChannel; 31a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)class SyncMessageFilter; 32a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)} 33f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) 342a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)namespace v8 { 352a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class Extension; 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 37f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) 38f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles)namespace content { 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 406d86b77056ed63eb6871182f42a9fd5f07550f90Torne (Richard Coles)class RenderProcessObserver; 416d86b77056ed63eb6871182f42a9fd5f07550f90Torne (Richard Coles)class ResourceDispatcherDelegate; 426d86b77056ed63eb6871182f42a9fd5f07550f90Torne (Richard Coles)class ServiceRegistry; 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class CONTENT_EXPORT RenderThread : public IPC::Sender { 45f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) public: 467dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch // Returns the one render thread for this process. Note that this can only 477dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch // be accessed when running on the render thread itself. 487dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch static RenderThread* Get(); 497dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch 507dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch RenderThread(); 516d86b77056ed63eb6871182f42a9fd5f07550f90Torne (Richard Coles) virtual ~RenderThread(); 526d86b77056ed63eb6871182f42a9fd5f07550f90Torne (Richard Coles) 536d86b77056ed63eb6871182f42a9fd5f07550f90Torne (Richard Coles) virtual base::MessageLoop* GetMessageLoop() = 0; 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual IPC::SyncChannel* GetChannel() = 0; 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual std::string GetLocale() = 0; 56f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) virtual IPC::SyncMessageFilter* GetSyncMessageFilter() = 0; 5758e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch virtual scoped_refptr<base::MessageLoopProxy> GetIOMessageLoopProxy() = 0; 5858e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch 5958e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch // Called to add or remove a listener for a particular message routing ID. 6058e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch // These methods normally get delegated to a MessageRouter. 61f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) virtual void AddRoute(int32 routing_id, IPC::Listener* listener) = 0; 622a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void RemoveRoute(int32 routing_id) = 0; 632a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual int GenerateRoutingID() = 0; 642a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 652a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // These map to IPC::ChannelProxy methods. 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void AddFilter(IPC::MessageFilter* filter) = 0; 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void RemoveFilter(IPC::MessageFilter* filter) = 0; 68f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) 69a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) // Add/remove observers for the process. 70a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) virtual void AddObserver(RenderProcessObserver* observer) = 0; 71a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) virtual void RemoveObserver(RenderProcessObserver* observer) = 0; 72a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 73f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // Set the ResourceDispatcher delegate object for this process. 74f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) virtual void SetResourceDispatcherDelegate( 75f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) ResourceDispatcherDelegate* delegate) = 0; 76f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) 77f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) // We initialize WebKit as late as possible. Call this to force 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // initialization. 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void EnsureWebKitInitialized() = 0; 80f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Sends over a base::UserMetricsAction to be recorded by user metrics as 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // an action. Once a new user metric is added, run 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // tools/metrics/actions/extract_actions.py 842a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // to add the metric to actions.xml, then update the <owner>s and 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // <description> sections. Make sure to include the actions.xml file when you 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // upload your code for review! 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // WARNING: When using base::UserMetricsAction, base::UserMetricsAction 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // and a string literal parameter must be on the same line, e.g. 90f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) // RenderThread::Get()->RecordAction( 912a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // base::UserMetricsAction("my extremely long action name")); 922a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // because otherwise our processing scripts won't pick up on new actions. 932a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void RecordAction(const base::UserMetricsAction& action) = 0; 942a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 952a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Sends over a string to be recorded by user metrics as a computed action. 962a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // When you use this you need to also update the rules for extracting known 972a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // actions in chrome/tools/extract_actions.py. 982a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void RecordComputedAction(const std::string& action) = 0; 99f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) 1002a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Asks the host to create a block of shared memory for the renderer. 1012a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // The shared memory allocated by the host is returned back. 102a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch virtual scoped_ptr<base::SharedMemory> HostAllocateSharedMemoryBuffer( 1032a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) size_t buffer_size) = 0; 1042a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 105f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) // Registers the given V8 extension with WebKit. 106f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) virtual void RegisterExtension(v8::Extension* extension) = 0; 107ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 108ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Schedule a call to IdleHandler with the given initial delay. 109ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch virtual void ScheduleIdleHandler(int64 initial_delay_ms) = 0; 110f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) 111a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch // A task we invoke periodically to assist with idle cleanup. 112a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch virtual void IdleHandler() = 0; 113ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 114ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Get/Set the delay for how often the idle handler is called. 1152a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual int64 GetIdleNotificationDelayInMs() const = 0; 1162a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void SetIdleNotificationDelayInMs( 117f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) int64 idle_notification_delay_in_ms) = 0; 1182a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1197d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles) virtual void UpdateHistograms(int sequence_number) = 0; 1205d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1215d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Post task to all worker threads. Returns number of workers. 1225d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) virtual int PostTaskToAllWebWorkers(const base::Closure& closure) = 0; 1232a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 124c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Resolve the proxy servers to use for a given url. On success true is 1252a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // returned and |proxy_list| is set to a PAC string containing a list of 126010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) // proxy servers. 1272a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual bool ResolveProxy(const GURL& url, std::string* proxy_list) = 0; 1282a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1292a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Gets the shutdown event for the process. 1302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual base::WaitableEvent* GetShutdownEvent() = 0; 131f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) 132f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles)#if defined(OS_WIN) 133f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) // Request that the given font be loaded by the browser so it's cached by the 134f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) // OS. Please see ChildProcessHost::PreCacheFont for details. 135f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) virtual void PreCacheFont(const LOGFONT& log_font) = 0; 136f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) 137f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) // Release cached font. 1382a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void ReleaseCachedFonts() = 0; 1392a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#endif 1402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1412a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns the ServiceRegistry for this thread. 142f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) virtual ServiceRegistry* GetServiceRegistry() = 0; 143ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch}; 144ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 145ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch} // namespace content 146ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 147ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#endif // CONTENT_PUBLIC_RENDERER_RENDER_THREAD_H_ 148ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch