public/lib/escher/flib/release_fence_signaller.h

// Copyright 2017 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef LIB_ESCHER_FLIB_RELEASE_FENCE_SIGNALLER_H_
#define LIB_ESCHER_FLIB_RELEASE_FENCE_SIGNALLER_H_

#include <deque>
#include <queue>

#include <lib/zx/event.h>
#include "lib/escher/flib/fence.h"
#include "lib/escher/impl/command_buffer_sequencer.h"
#include "lib/fidl/cpp/vector.h"
#include "lib/fxl/logging.h"

namespace escher {

// Signals a fence when all CommandBuffers started before the time of the
// fence's submission are finished. Used to ensure it is safe to release
// resources.
class ReleaseFenceSignaller
    : public escher::impl::CommandBufferSequencerListener {
 public:
  explicit ReleaseFenceSignaller(
      escher::impl::CommandBufferSequencer* command_buffer_sequencer);

  ~ReleaseFenceSignaller();

  // Must be called on the same thread that we're submitting frames to Escher.
  void AddVulkanReleaseFence(zx::event fence);

  // Must be called on the same thread that we're submitting frames to Escher.
  void AddVulkanReleaseFences(fidl::VectorPtr<zx::event> fences);

  // Must be called on the same thread that we're submitting frames to Escher.
  virtual void AddCPUReleaseFence(zx::event fence);

  // Must be called on the same thread that we're submitting frames to Escher.
  virtual void AddCPUReleaseFences(fidl::VectorPtr<zx::event> fences);

 private:
  // The sequence number for the most recently finished CommandBuffer.
  uint64_t last_finished_sequence_number_ = 0;

  // Implement impl::CommandBufferSequenceListener::CommandBufferFinished().
  // Signals any fences that correspond to a CommandBuffer with a sequence
  // numbers equal to or less than |sequence_number|.
  void OnCommandBufferFinished(uint64_t sequence_number) override;

  // A fence along with the sequence number it is waiting for before it will be
  // signalled.
  struct FenceWithSequenceNumber {
    uint64_t sequence_number;
    zx::event fence;
  };

  // Queue of fences we need to signal along with their corresponding sequence
  // numbers. The sequence numbers must be in non-decreasing order.
  std::queue<FenceWithSequenceNumber> pending_fences_;

  // Used to query for last generated sequence number, corresponding to the most
  // recently submitted CommandBuffer.
  escher::impl::CommandBufferSequencer* command_buffer_sequencer_;
};

}  // namespace escher

#endif  // LIB_ESCHER_FLIB_RELEASE_FENCE_SIGNALLER_H_