Hash :
cae00d9b
Author :
Date :
2023-01-17T18:44:48
Vulkan: Cleanup shared ring buffer cmd alloc feature.
Changes:
- Simplified "SharedCommandBlockPool" interface.
Removed "ptrOut" and "usesCommandHeaderSizeForOffsetOut" parameters,
because "headerOut" has exactly the same value.
- Refactoring of "SharedCommandBlockPool" classes.
Some public methods made private, inline, or moved into ".cpp".
- Replace some getters with more specific/restrictive methods:
- "RingBufferAllocatorBuffer::getStorageSize()" -> "isEmpty()"
- "CommandBufferHelperCommon::getAllocator()"
-> "hasAllocatorLinks()"
- Added extra ASSERT()s.
- fixed typo "kMinRingBufferAllocatio(r)Capacity"
- other minor modifications.
Bug: angleproject:6401
Bug: b/256666069
Change-Id: I8f5c1c928bac5f8ecdfce7d411834f7ea39d11ac
Reviewed-on: https://chromium-review.googlesource.com/c/angle/angle/+/4218364
Commit-Queue: Igor Nazarov <i.nazarov@samsung.com>
Commit-Queue: Shahbaz Youssefi <syoussefi@chromium.org>
Reviewed-by: Charlie Lao <cclao@google.com>
Reviewed-by: Shahbaz Youssefi <syoussefi@chromium.org>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
//
// Copyright 2022 The ANGLE Project Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
//
// AllocatorHelperRing:
// Manages the ring buffer allocators used in the command buffers.
//
#ifndef LIBANGLE_RENDERER_VULKAN_ALLOCATORHELPERRING_H_
#define LIBANGLE_RENDERER_VULKAN_ALLOCATORHELPERRING_H_
#include "common/RingBufferAllocator.h"
#include "common/vulkan/vk_headers.h"
#include "libANGLE/renderer/vulkan/vk_command_buffer_utils.h"
#include "libANGLE/renderer/vulkan/vk_wrapper.h"
namespace rx
{
namespace vk
{
namespace priv
{
class SecondaryCommandBuffer;
} // namespace priv
using SharedCommandMemoryAllocator = angle::SharedRingBufferAllocator;
using RingBufferAllocator = angle::RingBufferAllocator;
// Used in CommandBufferHelperCommon
class SharedCommandBlockAllocator
{
public:
SharedCommandBlockAllocator() : mAllocator(nullptr), mAllocSharedCP(nullptr) {}
void resetAllocator();
bool hasAllocatorLinks() const { return mAllocator || mAllocSharedCP; }
void init() {}
void attachAllocator(SharedCommandMemoryAllocator *allocator);
SharedCommandMemoryAllocator *detachAllocator(bool isCommandBufferEmpty);
SharedCommandMemoryAllocator *getAllocator() { return mAllocator; }
private:
// Using a ring buffer allocator for less memory overhead (observed with enabled async queue)
SharedCommandMemoryAllocator *mAllocator;
angle::SharedRingBufferAllocatorCheckPoint *mAllocSharedCP;
angle::RingBufferAllocatorCheckPoint mAllocReleaseCP;
};
// Used in SecondaryCommandBuffer
class SharedCommandBlockPool final : angle::RingBufferAllocateListener
{
public:
SharedCommandBlockPool()
: mLastCommandBlock(nullptr), mFinishedCommandSize(0), mCommandBuffer(nullptr)
{}
static constexpr size_t kCommandHeaderSize = 4;
using CommandHeaderIDType = uint16_t;
// Make sure the size of command header ID type is less than total command header size.
static_assert(sizeof(CommandHeaderIDType) < kCommandHeaderSize, "Check size of CommandHeader");
void setCommandBuffer(priv::SecondaryCommandBuffer *commandBuffer)
{
mCommandBuffer = commandBuffer;
}
void resetCommandBuffer() { mCommandBuffer = nullptr; }
void reset(CommandBufferCommandTracker *commandBufferTracker)
{
mLastCommandBlock = nullptr;
mFinishedCommandSize = 0;
if (mAllocator.valid())
{
mAllocator.release(mAllocator.getReleaseCheckPoint());
pushNewCommandBlock(mAllocator.allocate(0));
}
}
angle::Result initialize(SharedCommandMemoryAllocator *allocator)
{
return angle::Result::Continue;
}
bool valid() const { return mAllocator.valid(); }
bool empty() const { return getCommandSize() == 0; }
void getMemoryUsageStats(size_t *usedMemoryOut, size_t *allocatedMemoryOut) const;
void terminateLastCommandBlock()
{
if (mLastCommandBlock)
{
ASSERT(mAllocator.valid());
ASSERT(mAllocator.getPointer() >= mLastCommandBlock);
ASSERT(mAllocator.getFragmentSize() >= kCommandHeaderSize);
reinterpret_cast<CommandHeaderIDType &>(*(mAllocator.getPointer())) = 0;
}
}
// Initialize the SecondaryCommandBuffer by setting the allocator it will use
void attachAllocator(SharedCommandMemoryAllocator *source);
void detachAllocator(SharedCommandMemoryAllocator *destination);
void onNewVariableSizedCommand(const size_t requiredSize,
const size_t allocationSize,
uint8_t **headerOut)
{
*headerOut = allocateCommand(allocationSize);
}
void onNewCommand(const size_t requiredSize, const size_t allocationSize, uint8_t **headerOut)
{
*headerOut = allocateCommand(allocationSize);
}
private:
uint8_t *allocateCommand(size_t allocationSize)
{
ASSERT(mLastCommandBlock);
return mAllocator.allocate(static_cast<uint32_t>(allocationSize));
}
// The following is used to give the size of the command buffer in bytes
uint32_t getCommandSize() const
{
uint32_t result = mFinishedCommandSize;
if (mLastCommandBlock)
{
ASSERT(mAllocator.valid());
ASSERT(mAllocator.getPointer() >= mLastCommandBlock);
result += static_cast<uint32_t>(mAllocator.getPointer() - mLastCommandBlock);
}
return result;
}
void pushNewCommandBlock(uint8_t *block);
void finishLastCommandBlock();
// Functions derived from RingBufferAllocateListener
virtual void onRingBufferNewFragment() override;
virtual void onRingBufferFragmentEnd() override;
// Using a ring buffer allocator for less memory overhead (observed with enabled async queue)
RingBufferAllocator mAllocator;
uint8_t *mLastCommandBlock;
uint32_t mFinishedCommandSize;
// Points to the parent command buffer.
priv::SecondaryCommandBuffer *mCommandBuffer;
};
} // namespace vk
} // namespace rx
#endif // LIBANGLE_RENDERER_VULKAN_ALLOCATORHELPERRING_H_