1 /*
2 * Copyright (C) 2021 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 #ifndef ANDROID_HARDWARE_NEURALNETWORKS_AIDL_UTILS_H
18 #define ANDROID_HARDWARE_NEURALNETWORKS_AIDL_UTILS_H
19
20 #include <android-base/logging.h>
21 #include <gtest/gtest.h>
22
23 #include <algorithm>
24 #include <array>
25 #include <iosfwd>
26 #include <string>
27 #include <utility>
28 #include <vector>
29
30 #include <aidl/android/hardware/neuralnetworks/IDevice.h>
31 #include <aidl/android/hardware/neuralnetworks/Memory.h>
32 #include <aidl/android/hardware/neuralnetworks/Operand.h>
33 #include <aidl/android/hardware/neuralnetworks/OperandType.h>
34 #include <aidl/android/hardware/neuralnetworks/Priority.h>
35 #include <aidl/android/hardware/neuralnetworks/Request.h>
36
37 #include <TestHarness.h>
38 #include <nnapi/SharedMemory.h>
39
40 namespace aidl::android::hardware::neuralnetworks {
41
42 namespace nn = ::android::nn;
43
44 inline constexpr Priority kDefaultPriority = Priority::MEDIUM;
45
46 inline constexpr Timing kNoTiming = {.timeOnDeviceNs = -1, .timeInDriverNs = -1};
47 inline constexpr int64_t kNoDeadline = -1;
48 inline constexpr int64_t kOmittedTimeoutDuration = -1;
49 inline constexpr int64_t kNoDuration = -1;
50 inline const std::vector<uint8_t> kEmptyCacheToken(IDevice::BYTE_SIZE_OF_CACHE_TOKEN);
51 inline const std::array<uint8_t, IDevice::BYTE_SIZE_OF_CACHE_TOKEN> kEmptyCacheTokenArray{};
52
53 // Returns the amount of space needed to store a value of the specified type.
54 //
55 // Aborts if the specified type is an extension type or OEM type.
56 uint32_t sizeOfData(OperandType type);
57
58 // Returns the amount of space needed to store a value of the dimensions and
59 // type of this operand. For a non-extension, non-OEM tensor with unspecified
60 // rank or at least one unspecified dimension, returns zero.
61 //
62 // Aborts if the specified type is an extension type or OEM type.
63 uint32_t sizeOfData(const Operand& operand);
64
65 // Convenience class to manage the lifetime of memory resources.
66 class TestMemoryBase {
67 DISALLOW_COPY_AND_ASSIGN(TestMemoryBase);
68
69 public:
70 TestMemoryBase() = default;
71 virtual ~TestMemoryBase() = default;
getPointer()72 uint8_t* getPointer() const { return mPtr; }
getAidlMemory()73 const Memory* getAidlMemory() const { return &mAidlMemory; }
74
75 protected:
76 uint8_t* mPtr = nullptr;
77 Memory mAidlMemory;
78 bool mIsValid = false;
79 };
80
81 class TestAshmem : public TestMemoryBase {
82 public:
83 // If aidlReadonly is true, getAidlMemory will return a sAIDL memory with readonly access;
84 // otherwise, the sAIDL memory has read-write access. This only affects the sAIDL memory.
85 // getPointer will always return a valid address with read-write access.
86 static std::unique_ptr<TestAshmem> create(uint32_t size, bool aidlReadonly = false);
87
88 // Prefer TestAshmem::create.
89 // The constructor calls initialize, which constructs the memory resources. This is a workaround
90 // that gtest macros cannot be used directly in a constructor.
TestAshmem(uint32_t size,bool aidlReadonly)91 TestAshmem(uint32_t size, bool aidlReadonly) { initialize(size, aidlReadonly); }
92
93 private:
94 void initialize(uint32_t size, bool aidlReadonly);
95 nn::Mapping mMappedMemory;
96 };
97
98 class TestBlobAHWB : public TestMemoryBase {
99 public:
100 static std::unique_ptr<TestBlobAHWB> create(uint32_t size);
101
102 // Prefer TestBlobAHWB::create.
103 // The constructor calls initialize, which constructs the memory resources. This is a
104 // workaround that gtest macros cannot be used directly in a constructor.
TestBlobAHWB(uint32_t size)105 TestBlobAHWB(uint32_t size) { initialize(size); }
106
107 private:
108 void initialize(uint32_t size);
109 nn::SharedMemory mMemory;
110 nn::Mapping mMapping;
111 };
112
113 enum class MemoryType { ASHMEM, BLOB_AHWB, DEVICE };
114
115 std::string toString(MemoryType type);
116
117 // Manages the lifetime of memory resources used in an execution.
118 class ExecutionContext {
119 DISALLOW_COPY_AND_ASSIGN(ExecutionContext);
120
121 public:
122 static constexpr uint32_t kInputPoolIndex = 0;
123 static constexpr uint32_t kOutputPoolIndex = 1;
124
125 ExecutionContext() = default;
126
127 // Create HIDL Request from the TestModel struct.
128 Request createRequest(const test_helper::TestModel& testModel,
129 MemoryType memoryType = MemoryType::ASHMEM);
130
131 // After execution, copy out output results from the output memory pool.
132 std::vector<test_helper::TestBuffer> getOutputBuffers(const Request& request) const;
133
134 private:
135 std::unique_ptr<TestMemoryBase> mInputMemory, mOutputMemory;
136 };
137
138 template <typename Type>
139 using Named = std::pair<std::string, Type>;
140
141 template <typename Type>
getName(const Named<Type> & namedData)142 const std::string& getName(const Named<Type>& namedData) {
143 return namedData.first;
144 }
145
146 template <typename Type>
getData(const Named<Type> & namedData)147 const Type& getData(const Named<Type>& namedData) {
148 return namedData.second;
149 }
150
151 std::string gtestCompliantName(std::string name);
152
153 // pretty-print values for error messages
154 ::std::ostream& operator<<(::std::ostream& os, ErrorStatus errorStatus);
155
156 } // namespace aidl::android::hardware::neuralnetworks
157
158 #endif // ANDROID_HARDWARE_NEURALNETWORKS_AIDL_UTILS_H
159