1 /*
2  * Copyright (c) 2023 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 #include "include/gpu/vk/GrVkBackendContext.h"
27 #endif
28 
29 namespace OHOS {
30 namespace Rosen {
31 namespace Drawing {
32 using pid_t = int;
33 using MemoryOverflowCalllback = std::function<void(pid_t, uint64_t, bool)>;
34 struct GPUResourceTag;
35 struct HpsBlurParameter;
36 class GPUContext;
37 class GPUContextOptions;
38 class GPUContextImpl : public BaseImpl {
39 public:
GPUContextImpl()40     GPUContextImpl() {};
~GPUContextImpl()41     ~GPUContextImpl() override {};
42 
43     virtual bool BuildFromGL(const GPUContextOptions& options) = 0;
44 #ifdef RS_ENABLE_VK
45     virtual bool BuildFromVK(const GrVkBackendContext& context) = 0;
46     virtual bool BuildFromVK(const GrVkBackendContext& context, const GPUContextOptions& options) = 0;
47 #endif
48     virtual void Flush() = 0;
49     virtual void FlushAndSubmit(bool syncCpu) = 0;
50     virtual void Submit() = 0;
51     virtual void PerformDeferredCleanup(std::chrono::milliseconds msNotUsed) = 0;
52 
53     virtual void GetResourceCacheLimits(int* maxResource, size_t* maxResourceBytes) const = 0;
54     virtual void SetResourceCacheLimits(int maxResource, size_t maxResourceBytes) = 0;
55 
56     virtual void GetResourceCacheUsage(int* resourceCount, size_t* resourceBytes) const = 0;
57 
58     virtual void FreeGpuResources() = 0;
59 
60     virtual void DumpGpuStats(std::string& out) = 0;
61 
62     virtual void ReleaseResourcesAndAbandonContext() = 0;
63 
64     virtual void PurgeUnlockedResources(bool scratchResourcesOnly) = 0;
65 
66     virtual void PurgeUnlockedResourcesByTag(bool scratchResourcesOnly, const GPUResourceTag &tag) = 0;
67 
68     virtual void PurgeUnlockedResourcesByPid(bool scratchResourcesOnly, const std::set<pid_t>& exitedPidSet) = 0;
69 
70     virtual void PurgeCacheBetweenFrames(bool scratchResourcesOnly, const std::set<pid_t>& exitedPidSet,
71         const std::set<pid_t>& protectedPidSet) = 0;
72 
73     virtual void PurgeUnlockAndSafeCacheGpuResources() = 0;
74 
75     virtual void ReleaseByTag(const GPUResourceTag &tag) = 0;
76 
77     virtual void ResetContext() = 0;
78 
79     virtual void DumpMemoryStatisticsByTag(TraceMemoryDump* traceMemoryDump, GPUResourceTag &tag) = 0;
80 
81     virtual void DumpMemoryStatistics(TraceMemoryDump* traceMemoryDump) = 0;
82 
83     virtual void SetCurrentGpuResourceTag(const GPUResourceTag &tag) = 0;
84 
85     virtual void GetUpdatedMemoryMap(std::unordered_map<pid_t, size_t> &out) = 0;
86 
87     virtual void InitGpuMemoryLimit(MemoryOverflowCalllback callback, uint64_t size) = 0;
88 
89 #ifdef RS_ENABLE_VK
90     virtual void StoreVkPipelineCacheData() = 0;
91 #endif
92 
93     virtual void RegisterPostFunc(const std::function<void(const std::function<void()>& task)>& func) = 0;
94 
95     virtual void VmaDefragment() = 0;
96 
97     virtual void BeginFrame() = 0;
98 
99     virtual void EndFrame() = 0;
100 
101     virtual void SetGpuCacheSuppressWindowSwitch(bool enabled) = 0;
102 
103     virtual void SetGpuMemoryAsyncReclaimerSwitch(bool enabled, const std::function<void()>& setThreadPriority) = 0;
104 
105     virtual void FlushGpuMemoryInWaitQueue() = 0;
106 
107     virtual void SuppressGpuCacheBelowCertainRatio(const std::function<bool(void)>& nextFrameHasArrived) = 0;
108 };
109 } // namespace Drawing
110 } // namespace Rosen
111 } // namespace OHOS
112 #endif // GPU_CONTEXT_IMPL_H
113