blob: 6f692fab392848f867c8baed10feb91c74d460bf [file] [log] [blame]
// Copyright 2014 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 <memory>
#include <vector>
#include "base/auto_reset.h"
#include "base/macros.h"
#include "base/memory/ref_counted.h"
#include "base/synchronization/lock.h"
#include "base/threading/thread_checker.h"
#include "cc/trees/swap_promise.h"
#include "content/common/content_export.h"
namespace IPC {
class Message;
namespace content {
class FrameSwapMessageSubQueue;
// Queue used to keep track of which IPC::Messages should be sent after a
// particular compositor frame swap. The messages are guaranteed to be processed
// after the frame is processed, but there is no guarantee that nothing else
// happens between processing the frame and processing the messages.
class CONTENT_EXPORT FrameSwapMessageQueue
: public base::RefCountedThreadSafe<FrameSwapMessageQueue> {
class CONTENT_EXPORT SendMessageScope {
virtual ~SendMessageScope() {}
explicit FrameSwapMessageQueue(int32_t routing_id);
// Queues message to be returned on a matching DrainMessages call.
// |source_frame_number| frame number to queue |msg| for.
// |msg| - message to queue. The method takes ownership of |msg|.
// |is_first| - output parameter. Set to true if this was the first message
// enqueued for the given source_frame_number.
void QueueMessageForFrame(int source_frame_number,
std::unique_ptr<IPC::Message> msg,
bool* is_first);
// Returns true if there are no messages in the queue.
bool Empty() const;
// Should be called when a successful activation occurs. The messages for
// that activation can be obtained by calling DrainMessages.
// |source_frame_number| frame number for which the activate occurred.
void DidActivate(int source_frame_number);
// Should be called when a successful swap occurs. The messages for that
// swap can be obtained by calling DrainMessages.
// |source_frame_number| frame number for which the swap occurred.
void DidSwap(int source_frame_number);
// Should be called when we know a swap will not occur.
// |source_frame_number| frame number for which the swap will not occur.
// |reason| reason for the which the swap will not occur.
// |messages| depending on |reason| it may make sense to deliver certain
// messages asynchronously. This vector will contain those
// messages.
void DidNotSwap(int source_frame_number,
cc::SwapPromise::DidNotSwapReason reason,
std::vector<std::unique_ptr<IPC::Message>>* messages);
// A SendMessageScope object must be held by the caller when this method is
// called.
// |messages| vector to store messages, it's not cleared, only appended to.
// The method will append messages queued for frame numbers lower
// or equal to |source_frame_number|
void DrainMessages(std::vector<std::unique_ptr<IPC::Message>>* messages);
// SendMessageScope is used to make sure that messages sent from different
// threads (impl/main) are scheduled in the right order on the IO threads.
// Returns an object that must be kept in scope till an IPC message containing
// |messages| is sent.
std::unique_ptr<SendMessageScope> AcquireSendMessageScope();
static void TransferMessages(
std::vector<std::unique_ptr<IPC::Message>>* source,
std::vector<IPC::Message>* dest);
int32_t routing_id() const { return routing_id_; }
void NotifyFramesAreDiscarded(bool frames_are_discarded);
bool AreFramesDiscarded();
friend class base::RefCountedThreadSafe<FrameSwapMessageQueue>;
mutable base::Lock lock_;
std::unique_ptr<FrameSwapMessageSubQueue> visual_state_queue_;
std::vector<std::unique_ptr<IPC::Message>> next_drain_messages_;
int32_t routing_id_ = 0;
bool frames_are_discarded_ = false;
} // namespace content