1 /*
2 * Copyright (C) 2018 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 #include <android-base/scopeguard.h>
18 #include <gtest/gtest.h>
19 #include <nnapi/SharedMemory.h>
20 #include <nnapi/Types.h>
21 #include <nnapi/Validation.h>
22
23 #include "GeneratedTestUtils.h"
24 #include "Memory.h"
25 #include "ModelBuilder.h"
26 #include "TestNeuralNetworksWrapper.h"
27
28 #ifdef __ANDROID__
29 #include <android/hardware_buffer.h>
30 #endif // __ANDROID__
31
32 namespace android::nn::compliance_test {
33
34 using namespace test_helper;
35 using WrapperModel = test_wrapper::Model;
36 using WrapperOperandType = test_wrapper::OperandType;
37 using WrapperType = test_wrapper::Type;
38
39 // Tag for the compilance tests
40 class ComplianceTest : public ::testing::Test {};
41
42 // Verifies the earliest supported version for the model.
testAvailableSinceVersion(const WrapperModel & wrapperModel,const Version testVersion)43 static void testAvailableSinceVersion(const WrapperModel& wrapperModel, const Version testVersion) {
44 // Creates a canonical model from a wrapper model.
45 auto modelBuilder = reinterpret_cast<const ModelBuilder*>(wrapperModel.getHandle());
46 EXPECT_TRUE(modelBuilder->isFinished());
47 EXPECT_TRUE(modelBuilder->isValid());
48 Model model = modelBuilder->makeModel();
49 const auto modelVersion = validate(model);
50 ASSERT_TRUE(modelVersion.ok()) << modelVersion.error();
51 ASSERT_EQ(testVersion, modelVersion.value());
52 }
53
54 // Verifies the earliest supported version for the request.
testAvailableSinceVersion(const Request & request,const Version testVersion)55 static void testAvailableSinceVersion(const Request& request, const Version testVersion) {
56 const auto requestVersion = validate(request);
57 ASSERT_TRUE(requestVersion.ok()) << requestVersion.error();
58 ASSERT_EQ(testVersion, requestVersion.value());
59 }
60
61 static const WrapperOperandType kTypeTensorFloat(WrapperType::TENSOR_FLOAT32, {1});
62 static const WrapperOperandType kTypeTensorFloatRank0(WrapperType::TENSOR_FLOAT32, {});
63 static const WrapperOperandType kTypeInt32(WrapperType::INT32, {});
64
65 const int32_t kNoActivation = ANEURALNETWORKS_FUSED_NONE;
66
TEST_F(ComplianceTest,Rank0TensorModelInput)67 TEST_F(ComplianceTest, Rank0TensorModelInput) {
68 // A simple ADD operation: op1 ADD op2 = op3, with op1 and op2 of rank 0.
69 WrapperModel model;
70 auto op1 = model.addOperand(&kTypeTensorFloatRank0);
71 auto op2 = model.addOperand(&kTypeTensorFloatRank0);
72 auto op3 = model.addOperand(&kTypeTensorFloat);
73 auto act = model.addConstantOperand(&kTypeInt32, kNoActivation);
74 model.addOperation(ANEURALNETWORKS_ADD, {op1, op2, act}, {op3});
75 model.identifyInputsAndOutputs({op1, op2}, {op3});
76 ASSERT_TRUE(model.isValid());
77 model.finish();
78 testAvailableSinceVersion(model, kVersionFeatureLevel3);
79 }
80
TEST_F(ComplianceTest,Rank0TensorModelOutput)81 TEST_F(ComplianceTest, Rank0TensorModelOutput) {
82 // A simple ADD operation: op1 ADD op2 = op3, with op3 of rank 0.
83 WrapperModel model;
84 auto op1 = model.addOperand(&kTypeTensorFloat);
85 auto op2 = model.addOperand(&kTypeTensorFloat);
86 auto op3 = model.addOperand(&kTypeTensorFloatRank0);
87 auto act = model.addConstantOperand(&kTypeInt32, kNoActivation);
88 model.addOperation(ANEURALNETWORKS_ADD, {op1, op2, act}, {op3});
89 model.identifyInputsAndOutputs({op1, op2}, {op3});
90 ASSERT_TRUE(model.isValid());
91 model.finish();
92 testAvailableSinceVersion(model, kVersionFeatureLevel3);
93 }
94
TEST_F(ComplianceTest,Rank0TensorTemporaryVariable)95 TEST_F(ComplianceTest, Rank0TensorTemporaryVariable) {
96 // Two ADD operations: op1 ADD op2 = op3, op3 ADD op4 = op5, with op3 of rank 0.
97 WrapperModel model;
98 auto op1 = model.addOperand(&kTypeTensorFloat);
99 auto op2 = model.addOperand(&kTypeTensorFloat);
100 auto op3 = model.addOperand(&kTypeTensorFloatRank0);
101 auto op4 = model.addOperand(&kTypeTensorFloat);
102 auto op5 = model.addOperand(&kTypeTensorFloat);
103 auto act = model.addConstantOperand(&kTypeInt32, kNoActivation);
104 model.addOperation(ANEURALNETWORKS_ADD, {op1, op2, act}, {op3});
105 model.addOperation(ANEURALNETWORKS_ADD, {op3, op4, act}, {op5});
106 model.identifyInputsAndOutputs({op1, op2, op4}, {op5});
107 ASSERT_TRUE(model.isValid());
108 model.finish();
109 testAvailableSinceVersion(model, kVersionFeatureLevel3);
110 }
111
112 // Hardware buffers are an Android concept, which aren't necessarily
113 // available on other platforms such as ChromeOS, which also build NNAPI.
114 #if defined(__ANDROID__)
TEST_F(ComplianceTest,HardwareBufferModel)115 TEST_F(ComplianceTest, HardwareBufferModel) {
116 const size_t memorySize = 20;
117 AHardwareBuffer_Desc desc{
118 .width = memorySize,
119 .height = 1,
120 .layers = 1,
121 .format = AHARDWAREBUFFER_FORMAT_BLOB,
122 .usage = AHARDWAREBUFFER_USAGE_CPU_READ_OFTEN | AHARDWAREBUFFER_USAGE_CPU_WRITE_OFTEN,
123 };
124
125 AHardwareBuffer* buffer = nullptr;
126 ASSERT_EQ(AHardwareBuffer_allocate(&desc, &buffer), 0);
127 auto allocateGuard =
128 android::base::make_scope_guard([buffer]() { AHardwareBuffer_release(buffer); });
129
130 test_wrapper::Memory memory(buffer);
131 ASSERT_TRUE(memory.isValid());
132
133 // A simple ADD operation: op1 ADD op2 = op3, with op2 using a const hardware buffer.
134 WrapperModel model;
135 auto op1 = model.addOperand(&kTypeTensorFloat);
136 auto op2 = model.addOperand(&kTypeTensorFloat);
137 auto op3 = model.addOperand(&kTypeTensorFloat);
138 auto act = model.addConstantOperand(&kTypeInt32, kNoActivation);
139 model.setOperandValueFromMemory(op2, &memory, 0, sizeof(float));
140 model.addOperation(ANEURALNETWORKS_ADD, {op1, op2, act}, {op3});
141 model.identifyInputsAndOutputs({op1}, {op3});
142 ASSERT_TRUE(model.isValid());
143 model.finish();
144 testAvailableSinceVersion(model, kVersionFeatureLevel3);
145 }
146
TEST_F(ComplianceTest,HardwareBufferRequest)147 TEST_F(ComplianceTest, HardwareBufferRequest) {
148 constexpr size_t kAhwbMemorySize = 1024;
149 const auto [n, ahwb] = MemoryRuntimeAHWB::create(kAhwbMemorySize);
150 ASSERT_EQ(n, ANEURALNETWORKS_NO_ERROR);
151 const Request::MemoryPool ahwbMemoryPool = ahwb->getMemoryPool();
152
153 constexpr size_t kSharedMemorySize = 1024;
154 auto maybeSharedMemoryPool = createSharedMemory(kSharedMemorySize);
155 ASSERT_TRUE(maybeSharedMemoryPool.ok()) << maybeSharedMemoryPool.error().message;
156 const Request::MemoryPool sharedMemoryPool = std::move(maybeSharedMemoryPool).value();
157
158 // AHardwareBuffer as input.
159 testAvailableSinceVersion(
160 Request{
161 .inputs = {{.lifetime = Request::Argument::LifeTime::POOL,
162 .location = {.poolIndex = 0, .length = kAhwbMemorySize},
163 .dimensions = {}}},
164 .outputs = {{.lifetime = Request::Argument::LifeTime::POOL,
165 .location = {.poolIndex = 1, .length = kSharedMemorySize},
166 .dimensions = {}}},
167 .pools = {ahwbMemoryPool, sharedMemoryPool},
168 },
169 kVersionFeatureLevel3);
170
171 // AHardwareBuffer as output.
172 testAvailableSinceVersion(
173 Request{
174 .inputs = {{.lifetime = Request::Argument::LifeTime::POOL,
175 .location = {.poolIndex = 0, .length = kSharedMemorySize},
176 .dimensions = {}}},
177 .outputs = {{.lifetime = Request::Argument::LifeTime::POOL,
178 .location = {.poolIndex = 1, .length = kAhwbMemorySize},
179 .dimensions = {}}},
180 .pools = {sharedMemoryPool, ahwbMemoryPool},
181 },
182 kVersionFeatureLevel3);
183 }
184 #endif
185
TEST_F(ComplianceTest,DeviceMemory)186 TEST_F(ComplianceTest, DeviceMemory) {
187 constexpr size_t kSharedMemorySize = 1024;
188 auto maybeSharedMemoryPool = createSharedMemory(kSharedMemorySize);
189 ASSERT_TRUE(maybeSharedMemoryPool.ok()) << maybeSharedMemoryPool.error().message;
190 const Request::MemoryPool sharedMemoryPool = std::move(maybeSharedMemoryPool).value();
191 const Request::MemoryPool deviceMemoryPool = Request::MemoryDomainToken(1);
192
193 // Device memory as input.
194 testAvailableSinceVersion(
195 Request{
196 .inputs = {{.lifetime = Request::Argument::LifeTime::POOL,
197 .location = {.poolIndex = 0},
198 .dimensions = {}}},
199 .outputs = {{.lifetime = Request::Argument::LifeTime::POOL,
200 .location = {.poolIndex = 1, .length = kSharedMemorySize},
201 .dimensions = {}}},
202 .pools = {deviceMemoryPool, sharedMemoryPool},
203 },
204 kVersionFeatureLevel4);
205
206 // Device memory as output.
207 testAvailableSinceVersion(
208 Request{
209 .inputs = {{.lifetime = Request::Argument::LifeTime::POOL,
210 .location = {.poolIndex = 0, .length = kSharedMemorySize},
211 .dimensions = {}}},
212 .outputs = {{.lifetime = Request::Argument::LifeTime::POOL,
213 .location = {.poolIndex = 1},
214 .dimensions = {}}},
215 .pools = {sharedMemoryPool, deviceMemoryPool},
216 },
217 kVersionFeatureLevel4);
218 }
219
220 class GeneratedComplianceTest : public generated_tests::GeneratedTestBase {};
221
TEST_P(GeneratedComplianceTest,Test)222 TEST_P(GeneratedComplianceTest, Test) {
223 generated_tests::GeneratedModel model;
224 generated_tests::createModel(testModel, &model);
225 ASSERT_TRUE(model.isValid());
226 model.finish();
227 switch (testModel.minSupportedVersion) {
228 // TODO(b/209797313): Unify HalVersion and Version.
229 case TestHalVersion::V1_0:
230 testAvailableSinceVersion(model, kVersionFeatureLevel1);
231 break;
232 case TestHalVersion::V1_1:
233 testAvailableSinceVersion(model, kVersionFeatureLevel2);
234 break;
235 case TestHalVersion::V1_2:
236 testAvailableSinceVersion(model, kVersionFeatureLevel3);
237 break;
238 case TestHalVersion::V1_3:
239 testAvailableSinceVersion(model, kVersionFeatureLevel4);
240 break;
241 case TestHalVersion::AIDL_V1:
242 testAvailableSinceVersion(model, kVersionFeatureLevel5);
243 break;
244 case TestHalVersion::AIDL_V2:
245 testAvailableSinceVersion(model, kVersionFeatureLevel6);
246 break;
247 case TestHalVersion::AIDL_V3:
248 testAvailableSinceVersion(model, kVersionFeatureLevel7);
249 break;
250 case TestHalVersion::UNKNOWN:
251 FAIL();
252 }
253 }
254
__anonaaf995c20202(const TestModel& testModel) 255 INSTANTIATE_GENERATED_TEST(GeneratedComplianceTest, [](const TestModel& testModel) {
256 return !testModel.expectFailure && testModel.minSupportedVersion != TestHalVersion::UNKNOWN;
257 });
258
259 } // namespace android::nn::compliance_test
260