Home | History | Annotate | Download | only in gpu
      1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
      2 // Use of this source code is governed by a BSD-style license that can be
      3 // found in the LICENSE file.
      4 
      5 #include "content/renderer/gpu/compositor_output_surface.h"
      6 
      7 #include "base/command_line.h"
      8 #include "base/message_loop/message_loop_proxy.h"
      9 #include "cc/output/compositor_frame.h"
     10 #include "cc/output/compositor_frame_ack.h"
     11 #include "cc/output/managed_memory_policy.h"
     12 #include "cc/output/output_surface_client.h"
     13 #include "content/common/gpu/client/command_buffer_proxy_impl.h"
     14 #include "content/common/gpu/client/context_provider_command_buffer.h"
     15 #include "content/common/gpu/client/webgraphicscontext3d_command_buffer_impl.h"
     16 #include "content/common/view_messages.h"
     17 #include "content/public/common/content_switches.h"
     18 #include "content/renderer/gpu/frame_swap_message_queue.h"
     19 #include "content/renderer/render_thread_impl.h"
     20 #include "gpu/command_buffer/client/context_support.h"
     21 #include "gpu/command_buffer/client/gles2_interface.h"
     22 #include "ipc/ipc_forwarding_message_filter.h"
     23 #include "ipc/ipc_sync_channel.h"
     24 
     25 namespace {
     26 // There are several compositor surfaces in a process, but they share the same
     27 // compositor thread, so we use a simple int here to track prefer-smoothness.
     28 int g_prefer_smoothness_count = 0;
     29 } // namespace
     30 
     31 namespace content {
     32 
     33 //------------------------------------------------------------------------------
     34 
     35 // static
     36 IPC::ForwardingMessageFilter* CompositorOutputSurface::CreateFilter(
     37     base::TaskRunner* target_task_runner)
     38 {
     39   uint32 messages_to_filter[] = {
     40     ViewMsg_UpdateVSyncParameters::ID,
     41     ViewMsg_SwapCompositorFrameAck::ID,
     42     ViewMsg_ReclaimCompositorResources::ID,
     43 #if defined(OS_ANDROID)
     44     ViewMsg_BeginFrame::ID
     45 #endif
     46   };
     47 
     48   return new IPC::ForwardingMessageFilter(
     49       messages_to_filter, arraysize(messages_to_filter),
     50       target_task_runner);
     51 }
     52 
     53 CompositorOutputSurface::CompositorOutputSurface(
     54     int32 routing_id,
     55     uint32 output_surface_id,
     56     const scoped_refptr<ContextProviderCommandBuffer>& context_provider,
     57     scoped_ptr<cc::SoftwareOutputDevice> software_device,
     58     scoped_refptr<FrameSwapMessageQueue> swap_frame_message_queue,
     59     bool use_swap_compositor_frame_message)
     60     : OutputSurface(context_provider, software_device.Pass()),
     61       output_surface_id_(output_surface_id),
     62       use_swap_compositor_frame_message_(use_swap_compositor_frame_message),
     63       output_surface_filter_(
     64           RenderThreadImpl::current()->compositor_output_surface_filter()),
     65       frame_swap_message_queue_(swap_frame_message_queue),
     66       routing_id_(routing_id),
     67       prefers_smoothness_(false),
     68 #if defined(OS_WIN)
     69       // TODO(epenner): Implement PlatformThread::CurrentHandle() on windows.
     70       main_thread_handle_(base::PlatformThreadHandle()),
     71 #else
     72       main_thread_handle_(base::PlatformThread::CurrentHandle()),
     73 #endif
     74       layout_test_mode_(RenderThreadImpl::current()->layout_test_mode()),
     75       weak_ptrs_(this) {
     76   DCHECK(output_surface_filter_.get());
     77   DCHECK(frame_swap_message_queue_.get());
     78   DetachFromThread();
     79   message_sender_ = RenderThreadImpl::current()->sync_message_filter();
     80   DCHECK(message_sender_.get());
     81   if (OutputSurface::software_device())
     82     capabilities_.max_frames_pending = 1;
     83 }
     84 
     85 CompositorOutputSurface::~CompositorOutputSurface() {
     86   DCHECK(CalledOnValidThread());
     87   SetNeedsBeginFrame(false);
     88   if (!HasClient())
     89     return;
     90   UpdateSmoothnessTakesPriority(false);
     91   if (output_surface_proxy_.get())
     92     output_surface_proxy_->ClearOutputSurface();
     93   output_surface_filter_->RemoveRoute(routing_id_);
     94 }
     95 
     96 bool CompositorOutputSurface::BindToClient(
     97     cc::OutputSurfaceClient* client) {
     98   DCHECK(CalledOnValidThread());
     99 
    100   if (!cc::OutputSurface::BindToClient(client))
    101     return false;
    102 
    103   output_surface_proxy_ = new CompositorOutputSurfaceProxy(this);
    104   output_surface_filter_->AddRoute(
    105       routing_id_,
    106       base::Bind(&CompositorOutputSurfaceProxy::OnMessageReceived,
    107                  output_surface_proxy_));
    108 
    109   if (!context_provider()) {
    110     // Without a GPU context, the memory policy otherwise wouldn't be set.
    111     client->SetMemoryPolicy(cc::ManagedMemoryPolicy(
    112         128 * 1024 * 1024,
    113         gpu::MemoryAllocation::CUTOFF_ALLOW_NICE_TO_HAVE,
    114         base::SharedMemory::GetHandleLimit() / 3));
    115   }
    116 
    117   return true;
    118 }
    119 
    120 void CompositorOutputSurface::ShortcutSwapAck(
    121     uint32 output_surface_id,
    122     scoped_ptr<cc::GLFrameData> gl_frame_data,
    123     scoped_ptr<cc::SoftwareFrameData> software_frame_data) {
    124   if (!layout_test_previous_frame_ack_) {
    125     layout_test_previous_frame_ack_.reset(new cc::CompositorFrameAck);
    126     layout_test_previous_frame_ack_->gl_frame_data.reset(new cc::GLFrameData);
    127   }
    128 
    129   OnSwapAck(output_surface_id, *layout_test_previous_frame_ack_);
    130 
    131   layout_test_previous_frame_ack_->gl_frame_data = gl_frame_data.Pass();
    132   layout_test_previous_frame_ack_->last_software_frame_id =
    133       software_frame_data ? software_frame_data->id : 0;
    134 }
    135 
    136 void CompositorOutputSurface::SwapBuffers(cc::CompositorFrame* frame) {
    137   if (layout_test_mode_ && use_swap_compositor_frame_message_) {
    138     // This code path is here to support layout tests that are currently
    139     // doing a readback in the renderer instead of the browser. So they
    140     // are using deprecated code paths in the renderer and don't need to
    141     // actually swap anything to the browser. We shortcut the swap to the
    142     // browser here and just ack directly within the renderer process.
    143     // Once crbug.com/311404 is fixed, this can be removed.
    144 
    145     // This would indicate that crbug.com/311404 is being fixed, and this
    146     // block needs to be removed.
    147     DCHECK(!frame->delegated_frame_data);
    148 
    149     base::Closure closure =
    150         base::Bind(&CompositorOutputSurface::ShortcutSwapAck,
    151                    weak_ptrs_.GetWeakPtr(),
    152                    output_surface_id_,
    153                    base::Passed(&frame->gl_frame_data),
    154                    base::Passed(&frame->software_frame_data));
    155 
    156     if (context_provider()) {
    157       gpu::gles2::GLES2Interface* context = context_provider()->ContextGL();
    158       context->Flush();
    159       uint32 sync_point = context->InsertSyncPointCHROMIUM();
    160       context_provider()->ContextSupport()->SignalSyncPoint(sync_point,
    161                                                             closure);
    162     } else {
    163       base::MessageLoopProxy::current()->PostTask(FROM_HERE, closure);
    164     }
    165     client_->DidSwapBuffers();
    166     return;
    167   }
    168 
    169   if (use_swap_compositor_frame_message_) {
    170     {
    171       ScopedVector<IPC::Message> messages;
    172       std::vector<IPC::Message> messages_to_deliver_with_frame;
    173       scoped_ptr<FrameSwapMessageQueue::SendMessageScope> send_message_scope =
    174           frame_swap_message_queue_->AcquireSendMessageScope();
    175       frame_swap_message_queue_->DrainMessages(&messages);
    176       FrameSwapMessageQueue::TransferMessages(messages,
    177                                               &messages_to_deliver_with_frame);
    178       Send(new ViewHostMsg_SwapCompositorFrame(routing_id_,
    179                                                output_surface_id_,
    180                                                *frame,
    181                                                messages_to_deliver_with_frame));
    182       // ~send_message_scope.
    183     }
    184     client_->DidSwapBuffers();
    185     return;
    186   }
    187 
    188   if (frame->gl_frame_data) {
    189     ContextProviderCommandBuffer* provider_command_buffer =
    190         static_cast<ContextProviderCommandBuffer*>(context_provider());
    191     CommandBufferProxyImpl* command_buffer_proxy =
    192         provider_command_buffer->GetCommandBufferProxy();
    193     DCHECK(command_buffer_proxy);
    194     command_buffer_proxy->SetLatencyInfo(frame->metadata.latency_info);
    195   }
    196 
    197   OutputSurface::SwapBuffers(frame);
    198 }
    199 
    200 void CompositorOutputSurface::OnMessageReceived(const IPC::Message& message) {
    201   DCHECK(CalledOnValidThread());
    202   if (!HasClient())
    203     return;
    204   IPC_BEGIN_MESSAGE_MAP(CompositorOutputSurface, message)
    205     IPC_MESSAGE_HANDLER(ViewMsg_UpdateVSyncParameters,
    206                         OnUpdateVSyncParametersFromBrowser);
    207     IPC_MESSAGE_HANDLER(ViewMsg_SwapCompositorFrameAck, OnSwapAck);
    208     IPC_MESSAGE_HANDLER(ViewMsg_ReclaimCompositorResources, OnReclaimResources);
    209 #if defined(OS_ANDROID)
    210     IPC_MESSAGE_HANDLER(ViewMsg_BeginFrame, OnBeginFrame);
    211 #endif
    212   IPC_END_MESSAGE_MAP()
    213 }
    214 
    215 void CompositorOutputSurface::OnUpdateVSyncParametersFromBrowser(
    216     base::TimeTicks timebase,
    217     base::TimeDelta interval) {
    218   DCHECK(CalledOnValidThread());
    219   CommitVSyncParameters(timebase, interval);
    220 }
    221 
    222 #if defined(OS_ANDROID)
    223 void CompositorOutputSurface::SetNeedsBeginFrame(bool enable) {
    224   DCHECK(CalledOnValidThread());
    225   Send(new ViewHostMsg_SetNeedsBeginFrame(routing_id_, enable));
    226 }
    227 
    228 void CompositorOutputSurface::OnBeginFrame(const cc::BeginFrameArgs& args) {
    229   DCHECK(CalledOnValidThread());
    230   client_->BeginFrame(args);
    231 }
    232 #endif  // defined(OS_ANDROID)
    233 
    234 void CompositorOutputSurface::OnSwapAck(uint32 output_surface_id,
    235                                         const cc::CompositorFrameAck& ack) {
    236   // Ignore message if it's a stale one coming from a different output surface
    237   // (e.g. after a lost context).
    238   if (output_surface_id != output_surface_id_)
    239     return;
    240   ReclaimResources(&ack);
    241   client_->DidSwapBuffersComplete();
    242 }
    243 
    244 void CompositorOutputSurface::OnReclaimResources(
    245     uint32 output_surface_id,
    246     const cc::CompositorFrameAck& ack) {
    247   // Ignore message if it's a stale one coming from a different output surface
    248   // (e.g. after a lost context).
    249   if (output_surface_id != output_surface_id_)
    250     return;
    251   ReclaimResources(&ack);
    252 }
    253 
    254 bool CompositorOutputSurface::Send(IPC::Message* message) {
    255   return message_sender_->Send(message);
    256 }
    257 
    258 namespace {
    259 #if defined(OS_ANDROID)
    260   void SetThreadPriorityToIdle(base::PlatformThreadHandle handle) {
    261     base::PlatformThread::SetThreadPriority(
    262        handle, base::kThreadPriority_Background);
    263   }
    264   void SetThreadPriorityToDefault(base::PlatformThreadHandle handle) {
    265     base::PlatformThread::SetThreadPriority(
    266        handle, base::kThreadPriority_Normal);
    267   }
    268 #else
    269   void SetThreadPriorityToIdle(base::PlatformThreadHandle handle) {}
    270   void SetThreadPriorityToDefault(base::PlatformThreadHandle handle) {}
    271 #endif
    272 }
    273 
    274 void CompositorOutputSurface::UpdateSmoothnessTakesPriority(
    275     bool prefers_smoothness) {
    276 #ifndef NDEBUG
    277   // If we use different compositor threads, we need to
    278   // use an atomic int to track prefer smoothness count.
    279   base::PlatformThreadId g_last_thread = base::PlatformThread::CurrentId();
    280   DCHECK_EQ(g_last_thread, base::PlatformThread::CurrentId());
    281 #endif
    282   if (prefers_smoothness_ == prefers_smoothness)
    283     return;
    284   // If this is the first surface to start preferring smoothness,
    285   // Throttle the main thread's priority.
    286   if (prefers_smoothness_ == false &&
    287       ++g_prefer_smoothness_count == 1) {
    288     SetThreadPriorityToIdle(main_thread_handle_);
    289   }
    290   // If this is the last surface to stop preferring smoothness,
    291   // Reset the main thread's priority to the default.
    292   if (prefers_smoothness_ == true &&
    293       --g_prefer_smoothness_count == 0) {
    294     SetThreadPriorityToDefault(main_thread_handle_);
    295   }
    296   prefers_smoothness_ = prefers_smoothness;
    297 }
    298 
    299 }  // namespace content
    300