Upstream version 9.38.198.0
[platform/framework/web/crosswalk.git] / src / content / common / gpu / gpu_command_buffer_stub.cc
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 "base/bind.h"
6 #include "base/bind_helpers.h"
7 #include "base/command_line.h"
8 #include "base/debug/trace_event.h"
9 #include "base/hash.h"
10 #include "base/json/json_writer.h"
11 #include "base/memory/shared_memory.h"
12 #include "base/time/time.h"
13 #include "build/build_config.h"
14 #include "content/common/gpu/devtools_gpu_instrumentation.h"
15 #include "content/common/gpu/gpu_channel.h"
16 #include "content/common/gpu/gpu_channel_manager.h"
17 #include "content/common/gpu/gpu_command_buffer_stub.h"
18 #include "content/common/gpu/gpu_memory_buffer_factory.h"
19 #include "content/common/gpu/gpu_memory_manager.h"
20 #include "content/common/gpu/gpu_memory_tracking.h"
21 #include "content/common/gpu/gpu_messages.h"
22 #include "content/common/gpu/gpu_watchdog.h"
23 #include "content/common/gpu/image_transport_surface.h"
24 #include "content/common/gpu/media/gpu_video_decode_accelerator.h"
25 #include "content/common/gpu/media/gpu_video_encode_accelerator.h"
26 #include "content/common/gpu/sync_point_manager.h"
27 #include "content/public/common/content_client.h"
28 #include "gpu/command_buffer/common/constants.h"
29 #include "gpu/command_buffer/common/gles2_cmd_utils.h"
30 #include "gpu/command_buffer/common/mailbox.h"
31 #include "gpu/command_buffer/service/gl_context_virtual.h"
32 #include "gpu/command_buffer/service/gl_state_restorer_impl.h"
33 #include "gpu/command_buffer/service/image_manager.h"
34 #include "gpu/command_buffer/service/logger.h"
35 #include "gpu/command_buffer/service/mailbox_manager.h"
36 #include "gpu/command_buffer/service/memory_tracking.h"
37 #include "gpu/command_buffer/service/query_manager.h"
38 #include "ui/gl/gl_bindings.h"
39 #include "ui/gl/gl_switches.h"
40
41 #if defined(OS_WIN)
42 #include "content/public/common/sandbox_init.h"
43 #endif
44
45 #if defined(OS_ANDROID)
46 #include "content/common/gpu/stream_texture_android.h"
47 #endif
48
49 namespace content {
50 struct WaitForCommandState {
51   WaitForCommandState(int32 start, int32 end, IPC::Message* reply)
52       : start(start), end(end), reply(reply) {}
53
54   int32 start;
55   int32 end;
56   scoped_ptr<IPC::Message> reply;
57 };
58
59 namespace {
60
61 // The GpuCommandBufferMemoryTracker class provides a bridge between the
62 // ContextGroup's memory type managers and the GpuMemoryManager class.
63 class GpuCommandBufferMemoryTracker : public gpu::gles2::MemoryTracker {
64  public:
65   explicit GpuCommandBufferMemoryTracker(GpuChannel* channel) :
66       tracking_group_(channel->gpu_channel_manager()->gpu_memory_manager()->
67           CreateTrackingGroup(channel->renderer_pid(), this)) {
68   }
69
70   virtual void TrackMemoryAllocatedChange(
71       size_t old_size,
72       size_t new_size,
73       gpu::gles2::MemoryTracker::Pool pool) OVERRIDE {
74     tracking_group_->TrackMemoryAllocatedChange(
75         old_size, new_size, pool);
76   }
77
78   virtual bool EnsureGPUMemoryAvailable(size_t size_needed) OVERRIDE {
79     return tracking_group_->EnsureGPUMemoryAvailable(size_needed);
80   };
81
82  private:
83   virtual ~GpuCommandBufferMemoryTracker() {
84   }
85   scoped_ptr<GpuMemoryTrackingGroup> tracking_group_;
86
87   DISALLOW_COPY_AND_ASSIGN(GpuCommandBufferMemoryTracker);
88 };
89
90 // FastSetActiveURL will shortcut the expensive call to SetActiveURL when the
91 // url_hash matches.
92 void FastSetActiveURL(const GURL& url, size_t url_hash) {
93   // Leave the previously set URL in the empty case -- empty URLs are given by
94   // WebKitPlatformSupportImpl::createOffscreenGraphicsContext3D. Hopefully the
95   // onscreen context URL was set previously and will show up even when a crash
96   // occurs during offscreen command processing.
97   if (url.is_empty())
98     return;
99   static size_t g_last_url_hash = 0;
100   if (url_hash != g_last_url_hash) {
101     g_last_url_hash = url_hash;
102     GetContentClient()->SetActiveURL(url);
103   }
104 }
105
106 // The first time polling a fence, delay some extra time to allow other
107 // stubs to process some work, or else the timing of the fences could
108 // allow a pattern of alternating fast and slow frames to occur.
109 const int64 kHandleMoreWorkPeriodMs = 2;
110 const int64 kHandleMoreWorkPeriodBusyMs = 1;
111
112 // Prevents idle work from being starved.
113 const int64 kMaxTimeSinceIdleMs = 10;
114
115 class DevToolsChannelData : public base::debug::ConvertableToTraceFormat {
116  public:
117   static scoped_refptr<base::debug::ConvertableToTraceFormat> CreateForChannel(
118       GpuChannel* channel);
119
120   virtual void AppendAsTraceFormat(std::string* out) const OVERRIDE {
121     std::string tmp;
122     base::JSONWriter::Write(value_.get(), &tmp);
123     *out += tmp;
124   }
125
126  private:
127   explicit DevToolsChannelData(base::Value* value) : value_(value) {}
128   virtual ~DevToolsChannelData() {}
129   scoped_ptr<base::Value> value_;
130   DISALLOW_COPY_AND_ASSIGN(DevToolsChannelData);
131 };
132
133 scoped_refptr<base::debug::ConvertableToTraceFormat>
134 DevToolsChannelData::CreateForChannel(GpuChannel* channel) {
135   scoped_ptr<base::DictionaryValue> res(new base::DictionaryValue);
136   res->SetInteger("renderer_pid", channel->renderer_pid());
137   res->SetDouble("used_bytes", channel->GetMemoryUsage());
138   res->SetDouble("limit_bytes",
139                  channel->gpu_channel_manager()
140                      ->gpu_memory_manager()
141                      ->GetMaximumClientAllocation());
142   return new DevToolsChannelData(res.release());
143 }
144
145 }  // namespace
146
147 GpuCommandBufferStub::GpuCommandBufferStub(
148     GpuChannel* channel,
149     GpuCommandBufferStub* share_group,
150     const gfx::GLSurfaceHandle& handle,
151     gpu::gles2::MailboxManager* mailbox_manager,
152     const gfx::Size& size,
153     const gpu::gles2::DisallowedFeatures& disallowed_features,
154     const std::vector<int32>& attribs,
155     gfx::GpuPreference gpu_preference,
156     bool use_virtualized_gl_context,
157     int32 route_id,
158     int32 surface_id,
159     GpuWatchdog* watchdog,
160     bool software,
161     const GURL& active_url)
162     : channel_(channel),
163       handle_(handle),
164       initial_size_(size),
165       disallowed_features_(disallowed_features),
166       requested_attribs_(attribs),
167       gpu_preference_(gpu_preference),
168       use_virtualized_gl_context_(use_virtualized_gl_context),
169       route_id_(route_id),
170       surface_id_(surface_id),
171       software_(software),
172       last_flush_count_(0),
173       last_memory_allocation_valid_(false),
174       watchdog_(watchdog),
175       sync_point_wait_count_(0),
176       delayed_work_scheduled_(false),
177       previous_messages_processed_(0),
178       active_url_(active_url),
179       total_gpu_memory_(0) {
180   active_url_hash_ = base::Hash(active_url.possibly_invalid_spec());
181   FastSetActiveURL(active_url_, active_url_hash_);
182
183   gpu::gles2::ContextCreationAttribHelper attrib_parser;
184   attrib_parser.Parse(requested_attribs_);
185
186   if (share_group) {
187     context_group_ = share_group->context_group_;
188     DCHECK(context_group_->bind_generates_resource() ==
189            attrib_parser.bind_generates_resource);
190   } else {
191     context_group_ = new gpu::gles2::ContextGroup(
192         mailbox_manager,
193         new GpuCommandBufferMemoryTracker(channel),
194         channel_->gpu_channel_manager()->shader_translator_cache(),
195         NULL,
196         attrib_parser.bind_generates_resource);
197   }
198
199   use_virtualized_gl_context_ |=
200       context_group_->feature_info()->workarounds().use_virtualized_gl_contexts;
201 }
202
203 GpuCommandBufferStub::~GpuCommandBufferStub() {
204   Destroy();
205
206   GpuChannelManager* gpu_channel_manager = channel_->gpu_channel_manager();
207   gpu_channel_manager->Send(new GpuHostMsg_DestroyCommandBuffer(surface_id()));
208 }
209
210 GpuMemoryManager* GpuCommandBufferStub::GetMemoryManager() const {
211     return channel()->gpu_channel_manager()->gpu_memory_manager();
212 }
213
214 bool GpuCommandBufferStub::OnMessageReceived(const IPC::Message& message) {
215   TRACE_EVENT1(TRACE_DISABLED_BY_DEFAULT("devtools.timeline"),
216                "GPUTask",
217                "data",
218                DevToolsChannelData::CreateForChannel(channel()));
219   // TODO(yurys): remove devtools_gpu_instrumentation call once DevTools
220   // Timeline migrates to tracing crbug.com/361045.
221   devtools_gpu_instrumentation::ScopedGpuTask task(channel());
222   FastSetActiveURL(active_url_, active_url_hash_);
223
224   bool have_context = false;
225   // Ensure the appropriate GL context is current before handling any IPC
226   // messages directed at the command buffer. This ensures that the message
227   // handler can assume that the context is current (not necessary for
228   // Echo, RetireSyncPoint, or WaitSyncPoint).
229   if (decoder_.get() && message.type() != GpuCommandBufferMsg_Echo::ID &&
230       message.type() != GpuCommandBufferMsg_WaitForTokenInRange::ID &&
231       message.type() != GpuCommandBufferMsg_WaitForGetOffsetInRange::ID &&
232       message.type() != GpuCommandBufferMsg_RetireSyncPoint::ID &&
233       message.type() != GpuCommandBufferMsg_SetLatencyInfo::ID) {
234     if (!MakeCurrent())
235       return false;
236     have_context = true;
237   }
238
239   // Always use IPC_MESSAGE_HANDLER_DELAY_REPLY for synchronous message handlers
240   // here. This is so the reply can be delayed if the scheduler is unscheduled.
241   bool handled = true;
242   IPC_BEGIN_MESSAGE_MAP(GpuCommandBufferStub, message)
243     IPC_MESSAGE_HANDLER_DELAY_REPLY(GpuCommandBufferMsg_Initialize,
244                                     OnInitialize);
245     IPC_MESSAGE_HANDLER_DELAY_REPLY(GpuCommandBufferMsg_SetGetBuffer,
246                                     OnSetGetBuffer);
247     IPC_MESSAGE_HANDLER(GpuCommandBufferMsg_ProduceFrontBuffer,
248                         OnProduceFrontBuffer);
249     IPC_MESSAGE_HANDLER(GpuCommandBufferMsg_Echo, OnEcho);
250     IPC_MESSAGE_HANDLER_DELAY_REPLY(GpuCommandBufferMsg_WaitForTokenInRange,
251                                     OnWaitForTokenInRange);
252     IPC_MESSAGE_HANDLER_DELAY_REPLY(GpuCommandBufferMsg_WaitForGetOffsetInRange,
253                                     OnWaitForGetOffsetInRange);
254     IPC_MESSAGE_HANDLER(GpuCommandBufferMsg_AsyncFlush, OnAsyncFlush);
255     IPC_MESSAGE_HANDLER(GpuCommandBufferMsg_SetLatencyInfo, OnSetLatencyInfo);
256     IPC_MESSAGE_HANDLER(GpuCommandBufferMsg_Rescheduled, OnRescheduled);
257     IPC_MESSAGE_HANDLER(GpuCommandBufferMsg_RegisterTransferBuffer,
258                         OnRegisterTransferBuffer);
259     IPC_MESSAGE_HANDLER(GpuCommandBufferMsg_DestroyTransferBuffer,
260                         OnDestroyTransferBuffer);
261     IPC_MESSAGE_HANDLER_DELAY_REPLY(GpuCommandBufferMsg_CreateVideoDecoder,
262                                     OnCreateVideoDecoder)
263     IPC_MESSAGE_HANDLER_DELAY_REPLY(GpuCommandBufferMsg_CreateVideoEncoder,
264                                     OnCreateVideoEncoder)
265     IPC_MESSAGE_HANDLER(GpuCommandBufferMsg_SetSurfaceVisible,
266                         OnSetSurfaceVisible)
267     IPC_MESSAGE_HANDLER(GpuCommandBufferMsg_RetireSyncPoint,
268                         OnRetireSyncPoint)
269     IPC_MESSAGE_HANDLER(GpuCommandBufferMsg_SignalSyncPoint,
270                         OnSignalSyncPoint)
271     IPC_MESSAGE_HANDLER(GpuCommandBufferMsg_SignalQuery,
272                         OnSignalQuery)
273     IPC_MESSAGE_HANDLER(
274         GpuCommandBufferMsg_SetClientHasMemoryAllocationChangedCallback,
275         OnSetClientHasMemoryAllocationChangedCallback)
276     IPC_MESSAGE_HANDLER(GpuCommandBufferMsg_RegisterGpuMemoryBuffer,
277                         OnRegisterGpuMemoryBuffer);
278     IPC_MESSAGE_HANDLER(GpuCommandBufferMsg_UnregisterGpuMemoryBuffer,
279                         OnUnregisterGpuMemoryBuffer);
280     IPC_MESSAGE_HANDLER(GpuCommandBufferMsg_CreateStreamTexture,
281                         OnCreateStreamTexture)
282     IPC_MESSAGE_UNHANDLED(handled = false)
283   IPC_END_MESSAGE_MAP()
284
285   CheckCompleteWaits();
286
287   if (have_context) {
288     // Ensure that any delayed work that was created will be handled.
289     ScheduleDelayedWork(kHandleMoreWorkPeriodMs);
290   }
291
292   DCHECK(handled);
293   return handled;
294 }
295
296 bool GpuCommandBufferStub::Send(IPC::Message* message) {
297   return channel_->Send(message);
298 }
299
300 bool GpuCommandBufferStub::IsScheduled() {
301   return (!scheduler_.get() || scheduler_->IsScheduled());
302 }
303
304 bool GpuCommandBufferStub::HasMoreWork() {
305   return scheduler_.get() && scheduler_->HasMoreWork();
306 }
307
308 void GpuCommandBufferStub::PollWork() {
309   TRACE_EVENT0("gpu", "GpuCommandBufferStub::PollWork");
310   delayed_work_scheduled_ = false;
311   FastSetActiveURL(active_url_, active_url_hash_);
312   if (decoder_.get() && !MakeCurrent())
313     return;
314
315   if (scheduler_) {
316     bool fences_complete = scheduler_->PollUnscheduleFences();
317     // Perform idle work if all fences are complete.
318     if (fences_complete) {
319       uint64 current_messages_processed =
320           channel()->gpu_channel_manager()->MessagesProcessed();
321       // We're idle when no messages were processed or scheduled.
322       bool is_idle =
323           (previous_messages_processed_ == current_messages_processed) &&
324           !channel()->gpu_channel_manager()->HandleMessagesScheduled();
325       if (!is_idle && !last_idle_time_.is_null()) {
326         base::TimeDelta time_since_idle = base::TimeTicks::Now() -
327             last_idle_time_;
328         base::TimeDelta max_time_since_idle =
329             base::TimeDelta::FromMilliseconds(kMaxTimeSinceIdleMs);
330
331         // Force idle when it's been too long since last time we were idle.
332         if (time_since_idle > max_time_since_idle)
333           is_idle = true;
334       }
335
336       if (is_idle) {
337         last_idle_time_ = base::TimeTicks::Now();
338         scheduler_->PerformIdleWork();
339       }
340     }
341   }
342   ScheduleDelayedWork(kHandleMoreWorkPeriodBusyMs);
343 }
344
345 bool GpuCommandBufferStub::HasUnprocessedCommands() {
346   if (command_buffer_) {
347     gpu::CommandBuffer::State state = command_buffer_->GetLastState();
348     return state.put_offset != state.get_offset &&
349         !gpu::error::IsError(state.error);
350   }
351   return false;
352 }
353
354 void GpuCommandBufferStub::ScheduleDelayedWork(int64 delay) {
355   if (!HasMoreWork()) {
356     last_idle_time_ = base::TimeTicks();
357     return;
358   }
359
360   if (delayed_work_scheduled_)
361     return;
362   delayed_work_scheduled_ = true;
363
364   // Idle when no messages are processed between now and when
365   // PollWork is called.
366   previous_messages_processed_ =
367       channel()->gpu_channel_manager()->MessagesProcessed();
368   if (last_idle_time_.is_null())
369     last_idle_time_ = base::TimeTicks::Now();
370
371   // IsScheduled() returns true after passing all unschedule fences
372   // and this is when we can start performing idle work. Idle work
373   // is done synchronously so we can set delay to 0 and instead poll
374   // for more work at the rate idle work is performed. This also ensures
375   // that idle work is done as efficiently as possible without any
376   // unnecessary delays.
377   if (scheduler_.get() &&
378       scheduler_->IsScheduled() &&
379       scheduler_->HasMoreIdleWork()) {
380     delay = 0;
381   }
382
383   base::MessageLoop::current()->PostDelayedTask(
384       FROM_HERE,
385       base::Bind(&GpuCommandBufferStub::PollWork, AsWeakPtr()),
386       base::TimeDelta::FromMilliseconds(delay));
387 }
388
389 void GpuCommandBufferStub::OnEcho(const IPC::Message& message) {
390   TRACE_EVENT0("gpu", "GpuCommandBufferStub::OnEcho");
391   Send(new IPC::Message(message));
392 }
393
394 bool GpuCommandBufferStub::MakeCurrent() {
395   if (decoder_->MakeCurrent())
396     return true;
397   DLOG(ERROR) << "Context lost because MakeCurrent failed.";
398   command_buffer_->SetContextLostReason(decoder_->GetContextLostReason());
399   command_buffer_->SetParseError(gpu::error::kLostContext);
400   CheckContextLost();
401   return false;
402 }
403
404 void GpuCommandBufferStub::Destroy() {
405   if (wait_for_token_) {
406     Send(wait_for_token_->reply.release());
407     wait_for_token_.reset();
408   }
409   if (wait_for_get_offset_) {
410     Send(wait_for_get_offset_->reply.release());
411     wait_for_get_offset_.reset();
412   }
413   if (handle_.is_null() && !active_url_.is_empty()) {
414     GpuChannelManager* gpu_channel_manager = channel_->gpu_channel_manager();
415     gpu_channel_manager->Send(new GpuHostMsg_DidDestroyOffscreenContext(
416         active_url_));
417   }
418
419   memory_manager_client_state_.reset();
420
421   while (!sync_points_.empty())
422     OnRetireSyncPoint(sync_points_.front());
423
424   if (decoder_)
425     decoder_->set_engine(NULL);
426
427   // The scheduler has raw references to the decoder and the command buffer so
428   // destroy it before those.
429   scheduler_.reset();
430
431   bool have_context = false;
432   if (decoder_ && command_buffer_ &&
433       command_buffer_->GetLastState().error != gpu::error::kLostContext)
434     have_context = decoder_->MakeCurrent();
435   FOR_EACH_OBSERVER(DestructionObserver,
436                     destruction_observers_,
437                     OnWillDestroyStub());
438
439   if (decoder_) {
440     decoder_->Destroy(have_context);
441     decoder_.reset();
442   }
443
444   command_buffer_.reset();
445
446   // Remove this after crbug.com/248395 is sorted out.
447   surface_ = NULL;
448 }
449
450 void GpuCommandBufferStub::OnInitializeFailed(IPC::Message* reply_message) {
451   Destroy();
452   GpuCommandBufferMsg_Initialize::WriteReplyParams(
453       reply_message, false, gpu::Capabilities());
454   Send(reply_message);
455 }
456
457 void GpuCommandBufferStub::OnInitialize(
458     base::SharedMemoryHandle shared_state_handle,
459     IPC::Message* reply_message) {
460   TRACE_EVENT0("gpu", "GpuCommandBufferStub::OnInitialize");
461   DCHECK(!command_buffer_.get());
462
463   scoped_ptr<base::SharedMemory> shared_state_shm(
464       new base::SharedMemory(shared_state_handle, false));
465
466   command_buffer_.reset(new gpu::CommandBufferService(
467       context_group_->transfer_buffer_manager()));
468
469   bool result = command_buffer_->Initialize();
470   DCHECK(result);
471
472   decoder_.reset(::gpu::gles2::GLES2Decoder::Create(context_group_.get()));
473
474   scheduler_.reset(new gpu::GpuScheduler(command_buffer_.get(),
475                                          decoder_.get(),
476                                          decoder_.get()));
477   if (preemption_flag_.get())
478     scheduler_->SetPreemptByFlag(preemption_flag_);
479
480   decoder_->set_engine(scheduler_.get());
481
482   if (!handle_.is_null()) {
483 #if defined(OS_MACOSX) || defined(UI_COMPOSITOR_IMAGE_TRANSPORT)
484     if (software_) {
485       LOG(ERROR) << "No software support.";
486       OnInitializeFailed(reply_message);
487       return;
488     }
489 #endif
490
491     surface_ = ImageTransportSurface::CreateSurface(
492         channel_->gpu_channel_manager(),
493         this,
494         handle_);
495   } else {
496     GpuChannelManager* manager = channel_->gpu_channel_manager();
497     surface_ = manager->GetDefaultOffscreenSurface();
498   }
499
500   if (!surface_.get()) {
501     DLOG(ERROR) << "Failed to create surface.";
502     OnInitializeFailed(reply_message);
503     return;
504   }
505
506   scoped_refptr<gfx::GLContext> context;
507   if (use_virtualized_gl_context_ && channel_->share_group()) {
508     context = channel_->share_group()->GetSharedContext();
509     if (!context.get()) {
510       context = gfx::GLContext::CreateGLContext(
511           channel_->share_group(),
512           channel_->gpu_channel_manager()->GetDefaultOffscreenSurface(),
513           gpu_preference_);
514       if (!context.get()) {
515         DLOG(ERROR) << "Failed to create shared context for virtualization.";
516         OnInitializeFailed(reply_message);
517         return;
518       }
519       channel_->share_group()->SetSharedContext(context.get());
520     }
521     // This should be a non-virtual GL context.
522     DCHECK(context->GetHandle());
523     context = new gpu::GLContextVirtual(
524         channel_->share_group(), context.get(), decoder_->AsWeakPtr());
525     if (!context->Initialize(surface_.get(), gpu_preference_)) {
526       // TODO(sievers): The real context created above for the default
527       // offscreen surface might not be compatible with this surface.
528       // Need to adjust at least GLX to be able to create the initial context
529       // with a config that is compatible with onscreen and offscreen surfaces.
530       context = NULL;
531
532       DLOG(ERROR) << "Failed to initialize virtual GL context.";
533       OnInitializeFailed(reply_message);
534       return;
535     }
536   }
537   if (!context.get()) {
538     context = gfx::GLContext::CreateGLContext(
539         channel_->share_group(), surface_.get(), gpu_preference_);
540   }
541   if (!context.get()) {
542     DLOG(ERROR) << "Failed to create context.";
543     OnInitializeFailed(reply_message);
544     return;
545   }
546
547   if (!context->MakeCurrent(surface_.get())) {
548     LOG(ERROR) << "Failed to make context current.";
549     OnInitializeFailed(reply_message);
550     return;
551   }
552
553   if (!context->GetGLStateRestorer()) {
554     context->SetGLStateRestorer(
555         new gpu::GLStateRestorerImpl(decoder_->AsWeakPtr()));
556   }
557
558   if (!context->GetTotalGpuMemory(&total_gpu_memory_))
559     total_gpu_memory_ = 0;
560
561   if (!context_group_->has_program_cache()) {
562     context_group_->set_program_cache(
563         channel_->gpu_channel_manager()->program_cache());
564   }
565
566   // Initialize the decoder with either the view or pbuffer GLContext.
567   if (!decoder_->Initialize(surface_,
568                             context,
569                             !surface_id(),
570                             initial_size_,
571                             disallowed_features_,
572                             requested_attribs_)) {
573     DLOG(ERROR) << "Failed to initialize decoder.";
574     OnInitializeFailed(reply_message);
575     return;
576   }
577
578   if (CommandLine::ForCurrentProcess()->HasSwitch(
579       switches::kEnableGPUServiceLogging)) {
580     decoder_->set_log_commands(true);
581   }
582
583   decoder_->GetLogger()->SetMsgCallback(
584       base::Bind(&GpuCommandBufferStub::SendConsoleMessage,
585                  base::Unretained(this)));
586   decoder_->SetShaderCacheCallback(
587       base::Bind(&GpuCommandBufferStub::SendCachedShader,
588                  base::Unretained(this)));
589   decoder_->SetWaitSyncPointCallback(
590       base::Bind(&GpuCommandBufferStub::OnWaitSyncPoint,
591                  base::Unretained(this)));
592
593   command_buffer_->SetPutOffsetChangeCallback(
594       base::Bind(&GpuCommandBufferStub::PutChanged, base::Unretained(this)));
595   command_buffer_->SetGetBufferChangeCallback(
596       base::Bind(&gpu::GpuScheduler::SetGetBuffer,
597                  base::Unretained(scheduler_.get())));
598   command_buffer_->SetParseErrorCallback(
599       base::Bind(&GpuCommandBufferStub::OnParseError, base::Unretained(this)));
600   scheduler_->SetSchedulingChangedCallback(
601       base::Bind(&GpuChannel::StubSchedulingChanged,
602                  base::Unretained(channel_)));
603
604   if (watchdog_) {
605     scheduler_->SetCommandProcessedCallback(
606         base::Bind(&GpuCommandBufferStub::OnCommandProcessed,
607                    base::Unretained(this)));
608   }
609
610   const size_t kSharedStateSize = sizeof(gpu::CommandBufferSharedState);
611   if (!shared_state_shm->Map(kSharedStateSize)) {
612     DLOG(ERROR) << "Failed to map shared state buffer.";
613     OnInitializeFailed(reply_message);
614     return;
615   }
616   command_buffer_->SetSharedStateBuffer(gpu::MakeBackingFromSharedMemory(
617       shared_state_shm.Pass(), kSharedStateSize));
618
619   gpu::Capabilities capabilities = decoder_->GetCapabilities();
620   capabilities.future_sync_points = channel_->allow_future_sync_points();
621
622   GpuCommandBufferMsg_Initialize::WriteReplyParams(
623       reply_message, true, capabilities);
624   Send(reply_message);
625
626   if (handle_.is_null() && !active_url_.is_empty()) {
627     GpuChannelManager* gpu_channel_manager = channel_->gpu_channel_manager();
628     gpu_channel_manager->Send(new GpuHostMsg_DidCreateOffscreenContext(
629         active_url_));
630   }
631 }
632
633 void GpuCommandBufferStub::OnSetLatencyInfo(
634     const std::vector<ui::LatencyInfo>& latency_info) {
635   if (!ui::LatencyInfo::Verify(latency_info,
636                                "GpuCommandBufferStub::OnSetLatencyInfo"))
637     return;
638   if (!latency_info_callback_.is_null())
639     latency_info_callback_.Run(latency_info);
640 }
641
642 void GpuCommandBufferStub::OnCreateStreamTexture(
643     uint32 texture_id, int32 stream_id, bool* succeeded) {
644 #if defined(OS_ANDROID)
645   *succeeded = StreamTexture::Create(this, texture_id, stream_id);
646 #else
647   *succeeded = false;
648 #endif
649 }
650
651 void GpuCommandBufferStub::SetLatencyInfoCallback(
652     const LatencyInfoCallback& callback) {
653   latency_info_callback_ = callback;
654 }
655
656 int32 GpuCommandBufferStub::GetRequestedAttribute(int attr) const {
657   // The command buffer is pairs of enum, value
658   // search for the requested attribute, return the value.
659   for (std::vector<int32>::const_iterator it = requested_attribs_.begin();
660        it != requested_attribs_.end(); ++it) {
661     if (*it++ == attr) {
662       return *it;
663     }
664   }
665   return -1;
666 }
667
668 void GpuCommandBufferStub::OnSetGetBuffer(int32 shm_id,
669                                           IPC::Message* reply_message) {
670   TRACE_EVENT0("gpu", "GpuCommandBufferStub::OnSetGetBuffer");
671   if (command_buffer_)
672     command_buffer_->SetGetBuffer(shm_id);
673   Send(reply_message);
674 }
675
676 void GpuCommandBufferStub::OnProduceFrontBuffer(const gpu::Mailbox& mailbox) {
677   TRACE_EVENT0("gpu", "GpuCommandBufferStub::OnProduceFrontBuffer");
678   if (!decoder_) {
679     LOG(ERROR) << "Can't produce front buffer before initialization.";
680     return;
681   }
682
683   decoder_->ProduceFrontBuffer(mailbox);
684 }
685
686 void GpuCommandBufferStub::OnParseError() {
687   TRACE_EVENT0("gpu", "GpuCommandBufferStub::OnParseError");
688   DCHECK(command_buffer_.get());
689   gpu::CommandBuffer::State state = command_buffer_->GetLastState();
690   IPC::Message* msg = new GpuCommandBufferMsg_Destroyed(
691       route_id_, state.context_lost_reason);
692   msg->set_unblock(true);
693   Send(msg);
694
695   // Tell the browser about this context loss as well, so it can
696   // determine whether client APIs like WebGL need to be immediately
697   // blocked from automatically running.
698   GpuChannelManager* gpu_channel_manager = channel_->gpu_channel_manager();
699   gpu_channel_manager->Send(new GpuHostMsg_DidLoseContext(
700       handle_.is_null(), state.context_lost_reason, active_url_));
701
702   CheckContextLost();
703 }
704
705 void GpuCommandBufferStub::OnWaitForTokenInRange(int32 start,
706                                                  int32 end,
707                                                  IPC::Message* reply_message) {
708   TRACE_EVENT0("gpu", "GpuCommandBufferStub::OnWaitForTokenInRange");
709   DCHECK(command_buffer_.get());
710   CheckContextLost();
711   if (wait_for_token_)
712     LOG(ERROR) << "Got WaitForToken command while currently waiting for token.";
713   wait_for_token_ =
714       make_scoped_ptr(new WaitForCommandState(start, end, reply_message));
715   CheckCompleteWaits();
716 }
717
718 void GpuCommandBufferStub::OnWaitForGetOffsetInRange(
719     int32 start,
720     int32 end,
721     IPC::Message* reply_message) {
722   TRACE_EVENT0("gpu", "GpuCommandBufferStub::OnWaitForGetOffsetInRange");
723   DCHECK(command_buffer_.get());
724   CheckContextLost();
725   if (wait_for_get_offset_) {
726     LOG(ERROR)
727         << "Got WaitForGetOffset command while currently waiting for offset.";
728   }
729   wait_for_get_offset_ =
730       make_scoped_ptr(new WaitForCommandState(start, end, reply_message));
731   CheckCompleteWaits();
732 }
733
734 void GpuCommandBufferStub::CheckCompleteWaits() {
735   if (wait_for_token_ || wait_for_get_offset_) {
736     gpu::CommandBuffer::State state = command_buffer_->GetLastState();
737     if (wait_for_token_ &&
738         (gpu::CommandBuffer::InRange(
739              wait_for_token_->start, wait_for_token_->end, state.token) ||
740          state.error != gpu::error::kNoError)) {
741       ReportState();
742       GpuCommandBufferMsg_WaitForTokenInRange::WriteReplyParams(
743           wait_for_token_->reply.get(), state);
744       Send(wait_for_token_->reply.release());
745       wait_for_token_.reset();
746     }
747     if (wait_for_get_offset_ &&
748         (gpu::CommandBuffer::InRange(wait_for_get_offset_->start,
749                                      wait_for_get_offset_->end,
750                                      state.get_offset) ||
751          state.error != gpu::error::kNoError)) {
752       ReportState();
753       GpuCommandBufferMsg_WaitForGetOffsetInRange::WriteReplyParams(
754           wait_for_get_offset_->reply.get(), state);
755       Send(wait_for_get_offset_->reply.release());
756       wait_for_get_offset_.reset();
757     }
758   }
759 }
760
761 void GpuCommandBufferStub::OnAsyncFlush(int32 put_offset, uint32 flush_count) {
762   TRACE_EVENT1(
763       "gpu", "GpuCommandBufferStub::OnAsyncFlush", "put_offset", put_offset);
764   DCHECK(command_buffer_.get());
765   if (flush_count - last_flush_count_ < 0x8000000U) {
766     last_flush_count_ = flush_count;
767     command_buffer_->Flush(put_offset);
768   } else {
769     // We received this message out-of-order. This should not happen but is here
770     // to catch regressions. Ignore the message.
771     NOTREACHED() << "Received a Flush message out-of-order";
772   }
773
774   ReportState();
775 }
776
777 void GpuCommandBufferStub::OnRescheduled() {
778   gpu::CommandBuffer::State pre_state = command_buffer_->GetLastState();
779   command_buffer_->Flush(pre_state.put_offset);
780   gpu::CommandBuffer::State post_state = command_buffer_->GetLastState();
781
782   if (pre_state.get_offset != post_state.get_offset)
783     ReportState();
784 }
785
786 void GpuCommandBufferStub::OnRegisterTransferBuffer(
787     int32 id,
788     base::SharedMemoryHandle transfer_buffer,
789     uint32 size) {
790   TRACE_EVENT0("gpu", "GpuCommandBufferStub::OnRegisterTransferBuffer");
791
792   // Take ownership of the memory and map it into this process.
793   // This validates the size.
794   scoped_ptr<base::SharedMemory> shared_memory(
795       new base::SharedMemory(transfer_buffer, false));
796   if (!shared_memory->Map(size)) {
797     DVLOG(0) << "Failed to map shared memory.";
798     return;
799   }
800
801   if (command_buffer_) {
802     command_buffer_->RegisterTransferBuffer(
803         id, gpu::MakeBackingFromSharedMemory(shared_memory.Pass(), size));
804   }
805 }
806
807 void GpuCommandBufferStub::OnDestroyTransferBuffer(int32 id) {
808   TRACE_EVENT0("gpu", "GpuCommandBufferStub::OnDestroyTransferBuffer");
809
810   if (command_buffer_)
811     command_buffer_->DestroyTransferBuffer(id);
812 }
813
814 void GpuCommandBufferStub::OnCommandProcessed() {
815   if (watchdog_)
816     watchdog_->CheckArmed();
817 }
818
819 void GpuCommandBufferStub::ReportState() { command_buffer_->UpdateState(); }
820
821 void GpuCommandBufferStub::PutChanged() {
822   FastSetActiveURL(active_url_, active_url_hash_);
823   scheduler_->PutChanged();
824 }
825
826 void GpuCommandBufferStub::OnCreateVideoDecoder(
827     media::VideoCodecProfile profile,
828     int32 decoder_route_id,
829     IPC::Message* reply_message) {
830   TRACE_EVENT0("gpu", "GpuCommandBufferStub::OnCreateVideoDecoder");
831   GpuVideoDecodeAccelerator* decoder = new GpuVideoDecodeAccelerator(
832       decoder_route_id, this, channel_->io_message_loop());
833   decoder->Initialize(profile, reply_message);
834   // decoder is registered as a DestructionObserver of this stub and will
835   // self-delete during destruction of this stub.
836 }
837
838 void GpuCommandBufferStub::OnCreateVideoEncoder(
839     media::VideoFrame::Format input_format,
840     const gfx::Size& input_visible_size,
841     media::VideoCodecProfile output_profile,
842     uint32 initial_bitrate,
843     int32 encoder_route_id,
844     IPC::Message* reply_message) {
845   TRACE_EVENT0("gpu", "GpuCommandBufferStub::OnCreateVideoEncoder");
846   GpuVideoEncodeAccelerator* encoder =
847       new GpuVideoEncodeAccelerator(encoder_route_id, this);
848   encoder->Initialize(input_format,
849                       input_visible_size,
850                       output_profile,
851                       initial_bitrate,
852                       reply_message);
853   // encoder is registered as a DestructionObserver of this stub and will
854   // self-delete during destruction of this stub.
855 }
856
857 void GpuCommandBufferStub::OnSetSurfaceVisible(bool visible) {
858   TRACE_EVENT0("gpu", "GpuCommandBufferStub::OnSetSurfaceVisible");
859   if (memory_manager_client_state_)
860     memory_manager_client_state_->SetVisible(visible);
861 }
862
863 void GpuCommandBufferStub::AddSyncPoint(uint32 sync_point) {
864   sync_points_.push_back(sync_point);
865 }
866
867 void GpuCommandBufferStub::OnRetireSyncPoint(uint32 sync_point) {
868   DCHECK(!sync_points_.empty() && sync_points_.front() == sync_point);
869   sync_points_.pop_front();
870   if (context_group_->mailbox_manager()->UsesSync() && MakeCurrent())
871     context_group_->mailbox_manager()->PushTextureUpdates();
872   GpuChannelManager* manager = channel_->gpu_channel_manager();
873   manager->sync_point_manager()->RetireSyncPoint(sync_point);
874 }
875
876 bool GpuCommandBufferStub::OnWaitSyncPoint(uint32 sync_point) {
877   if (!sync_point)
878     return true;
879   GpuChannelManager* manager = channel_->gpu_channel_manager();
880   if (manager->sync_point_manager()->IsSyncPointRetired(sync_point))
881     return true;
882
883   if (sync_point_wait_count_ == 0) {
884     TRACE_EVENT_ASYNC_BEGIN1("gpu", "WaitSyncPoint", this,
885                              "GpuCommandBufferStub", this);
886   }
887   scheduler_->SetScheduled(false);
888   ++sync_point_wait_count_;
889   manager->sync_point_manager()->AddSyncPointCallback(
890       sync_point,
891       base::Bind(&GpuCommandBufferStub::OnSyncPointRetired,
892                  this->AsWeakPtr()));
893   return scheduler_->IsScheduled();
894 }
895
896 void GpuCommandBufferStub::OnSyncPointRetired() {
897   --sync_point_wait_count_;
898   if (sync_point_wait_count_ == 0) {
899     TRACE_EVENT_ASYNC_END1("gpu", "WaitSyncPoint", this,
900                            "GpuCommandBufferStub", this);
901   }
902   scheduler_->SetScheduled(true);
903 }
904
905 void GpuCommandBufferStub::OnSignalSyncPoint(uint32 sync_point, uint32 id) {
906   GpuChannelManager* manager = channel_->gpu_channel_manager();
907   manager->sync_point_manager()->AddSyncPointCallback(
908       sync_point,
909       base::Bind(&GpuCommandBufferStub::OnSignalSyncPointAck,
910                  this->AsWeakPtr(),
911                  id));
912 }
913
914 void GpuCommandBufferStub::OnSignalSyncPointAck(uint32 id) {
915   Send(new GpuCommandBufferMsg_SignalSyncPointAck(route_id_, id));
916 }
917
918 void GpuCommandBufferStub::OnSignalQuery(uint32 query_id, uint32 id) {
919   if (decoder_) {
920     gpu::gles2::QueryManager* query_manager = decoder_->GetQueryManager();
921     if (query_manager) {
922       gpu::gles2::QueryManager::Query* query =
923           query_manager->GetQuery(query_id);
924       if (query) {
925         query->AddCallback(
926           base::Bind(&GpuCommandBufferStub::OnSignalSyncPointAck,
927                      this->AsWeakPtr(),
928                      id));
929         return;
930       }
931     }
932   }
933   // Something went wrong, run callback immediately.
934   OnSignalSyncPointAck(id);
935 }
936
937
938 void GpuCommandBufferStub::OnSetClientHasMemoryAllocationChangedCallback(
939     bool has_callback) {
940   TRACE_EVENT0(
941       "gpu",
942       "GpuCommandBufferStub::OnSetClientHasMemoryAllocationChangedCallback");
943   if (has_callback) {
944     if (!memory_manager_client_state_) {
945       memory_manager_client_state_.reset(GetMemoryManager()->CreateClientState(
946           this, surface_id_ != 0, true));
947     }
948   } else {
949     memory_manager_client_state_.reset();
950   }
951 }
952
953 void GpuCommandBufferStub::OnRegisterGpuMemoryBuffer(
954     int32 id,
955     gfx::GpuMemoryBufferHandle handle,
956     uint32 width,
957     uint32 height,
958     uint32 internalformat) {
959   TRACE_EVENT0("gpu", "GpuCommandBufferStub::OnRegisterGpuMemoryBuffer");
960 #if defined(OS_ANDROID)
961   // Verify that renderer is not trying to use a surface texture it doesn't own.
962   if (handle.type == gfx::SURFACE_TEXTURE_BUFFER &&
963       handle.surface_texture_id.secondary_id != channel()->client_id()) {
964     LOG(ERROR) << "Illegal surface texture ID for renderer.";
965     return;
966   }
967 #endif
968
969   if (!decoder_)
970     return;
971
972   gpu::gles2::ImageManager* image_manager = decoder_->GetImageManager();
973   DCHECK(image_manager);
974   if (image_manager->LookupImage(id)) {
975     LOG(ERROR) << "Image already exists with same ID.";
976     return;
977   }
978
979   GpuChannelManager* manager = channel_->gpu_channel_manager();
980   scoped_refptr<gfx::GLImage> image =
981       manager->gpu_memory_buffer_factory()->CreateImageForGpuMemoryBuffer(
982           handle,
983           gfx::Size(width, height),
984           internalformat,
985           channel()->client_id());
986   if (!image)
987     return;
988
989   // For Android specific workaround.
990   if (context_group_->feature_info()->workarounds().release_image_after_use)
991     image->SetReleaseAfterUse();
992
993   image_manager->AddImage(image.get(), id);
994 }
995
996 void GpuCommandBufferStub::OnUnregisterGpuMemoryBuffer(int32 id) {
997   TRACE_EVENT0("gpu", "GpuCommandBufferStub::OnUnregisterGpuMemoryBuffer");
998
999   if (!decoder_)
1000     return;
1001
1002   gpu::gles2::ImageManager* image_manager = decoder_->GetImageManager();
1003   DCHECK(image_manager);
1004   if (!image_manager->LookupImage(id)) {
1005     LOG(ERROR) << "Image with ID doesn't exist.";
1006     return;
1007   }
1008
1009   image_manager->RemoveImage(id);
1010 }
1011
1012 void GpuCommandBufferStub::SendConsoleMessage(
1013     int32 id,
1014     const std::string& message) {
1015   GPUCommandBufferConsoleMessage console_message;
1016   console_message.id = id;
1017   console_message.message = message;
1018   IPC::Message* msg = new GpuCommandBufferMsg_ConsoleMsg(
1019       route_id_, console_message);
1020   msg->set_unblock(true);
1021   Send(msg);
1022 }
1023
1024 void GpuCommandBufferStub::SendCachedShader(
1025     const std::string& key, const std::string& shader) {
1026   channel_->CacheShader(key, shader);
1027 }
1028
1029 void GpuCommandBufferStub::AddDestructionObserver(
1030     DestructionObserver* observer) {
1031   destruction_observers_.AddObserver(observer);
1032 }
1033
1034 void GpuCommandBufferStub::RemoveDestructionObserver(
1035     DestructionObserver* observer) {
1036   destruction_observers_.RemoveObserver(observer);
1037 }
1038
1039 void GpuCommandBufferStub::SetPreemptByFlag(
1040     scoped_refptr<gpu::PreemptionFlag> flag) {
1041   preemption_flag_ = flag;
1042   if (scheduler_)
1043     scheduler_->SetPreemptByFlag(preemption_flag_);
1044 }
1045
1046 bool GpuCommandBufferStub::GetTotalGpuMemory(uint64* bytes) {
1047   *bytes = total_gpu_memory_;
1048   return !!total_gpu_memory_;
1049 }
1050
1051 gfx::Size GpuCommandBufferStub::GetSurfaceSize() const {
1052   if (!surface_.get())
1053     return gfx::Size();
1054   return surface_->GetSize();
1055 }
1056
1057 gpu::gles2::MemoryTracker* GpuCommandBufferStub::GetMemoryTracker() const {
1058   return context_group_->memory_tracker();
1059 }
1060
1061 void GpuCommandBufferStub::SetMemoryAllocation(
1062     const gpu::MemoryAllocation& allocation) {
1063   if (!last_memory_allocation_valid_ ||
1064       !allocation.Equals(last_memory_allocation_)) {
1065     Send(new GpuCommandBufferMsg_SetMemoryAllocation(
1066         route_id_, allocation));
1067   }
1068
1069   last_memory_allocation_valid_ = true;
1070   last_memory_allocation_ = allocation;
1071 }
1072
1073 void GpuCommandBufferStub::SuggestHaveFrontBuffer(
1074     bool suggest_have_frontbuffer) {
1075   // This can be called outside of OnMessageReceived, so the context needs
1076   // to be made current before calling methods on the surface.
1077   if (surface_.get() && MakeCurrent())
1078     surface_->SetFrontbufferAllocation(suggest_have_frontbuffer);
1079 }
1080
1081 bool GpuCommandBufferStub::CheckContextLost() {
1082   DCHECK(command_buffer_);
1083   gpu::CommandBuffer::State state = command_buffer_->GetLastState();
1084   bool was_lost = state.error == gpu::error::kLostContext;
1085   // Lose all other contexts if the reset was triggered by the robustness
1086   // extension instead of being synthetic.
1087   if (was_lost && decoder_ && decoder_->WasContextLostByRobustnessExtension() &&
1088       (gfx::GLContext::LosesAllContextsOnContextLost() ||
1089        use_virtualized_gl_context_))
1090     channel_->LoseAllContexts();
1091   CheckCompleteWaits();
1092   return was_lost;
1093 }
1094
1095 void GpuCommandBufferStub::MarkContextLost() {
1096   if (!command_buffer_ ||
1097       command_buffer_->GetLastState().error == gpu::error::kLostContext)
1098     return;
1099
1100   command_buffer_->SetContextLostReason(gpu::error::kUnknown);
1101   if (decoder_)
1102     decoder_->LoseContext(GL_UNKNOWN_CONTEXT_RESET_ARB);
1103   command_buffer_->SetParseError(gpu::error::kLostContext);
1104 }
1105
1106 uint64 GpuCommandBufferStub::GetMemoryUsage() const {
1107   return GetMemoryManager()->GetClientMemoryUsage(this);
1108 }
1109
1110 }  // namespace content