1 /* 2 * Copyright (c) 2023-2025 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16 #ifndef GPU_CONTEXT_IMPL_H 17 #define GPU_CONTEXT_IMPL_H 18 19 #include <chrono> 20 #include <set> 21 #include <functional> 22 #include <unordered_map> 23 #include "base_impl.h" 24 #include "image/trace_memory_dump.h" 25 #ifdef RS_ENABLE_VK 26 #ifdef USE_M133_SKIA 27 #include "include/gpu/vk/VulkanBackendContext.h" 28 #else 29 #include "include/gpu/vk/GrVkBackendContext.h" 30 #endif 31 #endif 32 33 namespace OHOS { 34 namespace Rosen { 35 namespace Drawing { 36 using pid_t = int; 37 using MemoryOverflowCalllback = std::function<void(pid_t, uint64_t, bool)>; 38 struct GPUResourceTag; 39 struct HpsBlurParameter; 40 class GPUContext; 41 class GPUContextOptions; 42 class GPUContextImpl : public BaseImpl { 43 public: GPUContextImpl()44 GPUContextImpl() {}; ~GPUContextImpl()45 ~GPUContextImpl() override {}; 46 47 virtual bool BuildFromGL(const GPUContextOptions& options) = 0; 48 #ifdef RS_ENABLE_VK 49 #ifdef USE_M133_SKIA 50 virtual bool BuildFromVK(const skgpu::VulkanBackendContext& context) = 0; 51 virtual bool BuildFromVK(const skgpu::VulkanBackendContext& context, const GPUContextOptions& options) = 0; 52 #else 53 virtual bool BuildFromVK(const GrVkBackendContext& context) = 0; 54 virtual bool BuildFromVK(const GrVkBackendContext& context, const GPUContextOptions& options) = 0; 55 #endif 56 #endif 57 virtual void Flush() = 0; 58 virtual void FlushAndSubmit(bool syncCpu) = 0; 59 GenerateSubmitInfo(int seq)60 virtual void GenerateSubmitInfo(int seq) {} FlushCommands()61 virtual void FlushCommands() {} 62 63 virtual void Submit() = 0; 64 virtual void PerformDeferredCleanup(std::chrono::milliseconds msNotUsed) = 0; 65 66 virtual void GetResourceCacheLimits(int* maxResource, size_t* maxResourceBytes) const = 0; 67 virtual void SetResourceCacheLimits(int maxResource, size_t maxResourceBytes) = 0; 68 virtual void SetPurgeableResourceLimit(int purgeableMaxCount) = 0; 69 70 virtual void GetResourceCacheUsage(int* resourceCount, size_t* resourceBytes) const = 0; 71 72 virtual void FreeGpuResources() = 0; 73 74 virtual void ReclaimResources() = 0; 75 76 virtual void DumpGpuStats(std::string& out) = 0; 77 78 virtual void DumpAllResource(std::stringstream& dump) = 0; 79 80 virtual void ReleaseResourcesAndAbandonContext() = 0; 81 82 virtual void PurgeUnlockedResources(bool scratchResourcesOnly) = 0; 83 84 virtual void PurgeUnlockedResourcesByTag(bool scratchResourcesOnly, const GPUResourceTag &tag) = 0; 85 86 virtual void PurgeUnlockedResourcesByPid(bool scratchResourcesOnly, const std::set<pid_t>& exitedPidSet) = 0; 87 88 virtual void RegisterVulkanErrorCallback(const std::function<void()>& vulkanErrorCallback) = 0; 89 90 virtual void PurgeCacheBetweenFrames(bool scratchResourcesOnly, const std::set<pid_t>& exitedPidSet, 91 const std::set<pid_t>& protectedPidSet) = 0; 92 93 virtual void PurgeUnlockAndSafeCacheGpuResources() = 0; 94 95 virtual void ReleaseByTag(const GPUResourceTag &tag) = 0; 96 97 virtual void ResetContext() = 0; 98 99 virtual void DumpMemoryStatisticsByTag(TraceMemoryDump* traceMemoryDump, GPUResourceTag &tag) = 0; 100 101 virtual uint64_t NewDumpMemoryStatisticsByTag(TraceMemoryDump* traceMemoryDump, GPUResourceTag &tag) = 0; 102 103 virtual void DumpMemoryStatistics(TraceMemoryDump* traceMemoryDump) = 0; 104 105 virtual void SetCurrentGpuResourceTag(const GPUResourceTag &tag) = 0; 106 107 virtual GPUResourceTag GetCurrentGpuResourceTag() const = 0; 108 109 virtual void GetUpdatedMemoryMap(std::unordered_map<pid_t, size_t> &out) = 0; 110 111 virtual void InitGpuMemoryLimit(MemoryOverflowCalllback callback, uint64_t size) = 0; 112 113 #ifdef RS_ENABLE_VK 114 virtual void StoreVkPipelineCacheData() = 0; 115 #endif 116 117 virtual void RegisterPostFunc(const std::function<void(const std::function<void()>& task)>& func) = 0; 118 119 virtual void VmaDefragment() = 0; 120 121 virtual void BeginFrame() = 0; 122 123 virtual void EndFrame() = 0; 124 125 virtual void SetGpuCacheSuppressWindowSwitch(bool enabled) = 0; 126 127 virtual void SetGpuMemoryAsyncReclaimerSwitch(bool enabled, const std::function<void()>& setThreadPriority) = 0; 128 129 virtual void FlushGpuMemoryInWaitQueue() = 0; 130 131 virtual void SuppressGpuCacheBelowCertainRatio(const std::function<bool(void)>& nextFrameHasArrived) = 0; 132 133 virtual void GetHpsEffectSupport(std::vector<const char*>& instanceExtensions) = 0; 134 135 virtual void SetEarlyZEnabled(bool flag) = 0; 136 }; 137 } // namespace Drawing 138 } // namespace Rosen 139 } // namespace OHOS 140 #endif // GPU_CONTEXT_IMPL_H 141