Michael Butler | 4b276a7 | 2020-08-06 23:22:35 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2020 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 "PreparedModel.h" |
| 18 | |
Michael Butler | 137ee99 | 2021-11-01 16:40:31 -0700 | [diff] [blame] | 19 | #include "Burst.h" |
| 20 | #include "BurstUtils.h" |
Michael Butler | 4b276a7 | 2020-08-06 23:22:35 -0700 | [diff] [blame] | 21 | #include "Callbacks.h" |
| 22 | #include "Conversions.h" |
Xusong Wang | 5f6bedb | 2021-03-03 16:20:37 -0800 | [diff] [blame] | 23 | #include "Execution.h" |
Michael Butler | 4b276a7 | 2020-08-06 23:22:35 -0700 | [diff] [blame] | 24 | #include "Utils.h" |
| 25 | |
| 26 | #include <android/hardware/neuralnetworks/1.0/types.h> |
| 27 | #include <android/hardware/neuralnetworks/1.1/types.h> |
| 28 | #include <android/hardware/neuralnetworks/1.2/IPreparedModel.h> |
| 29 | #include <android/hardware/neuralnetworks/1.2/types.h> |
| 30 | #include <nnapi/IPreparedModel.h> |
| 31 | #include <nnapi/Result.h> |
| 32 | #include <nnapi/Types.h> |
| 33 | #include <nnapi/hal/1.0/Conversions.h> |
Michael Butler | 49d95e0 | 2021-10-15 18:52:52 -0700 | [diff] [blame] | 34 | #include <nnapi/hal/1.0/HandleError.h> |
Michael Butler | e8645c3 | 2021-10-15 18:42:32 -0700 | [diff] [blame] | 35 | #include <nnapi/hal/1.0/ProtectCallback.h> |
Michael Butler | 4b276a7 | 2020-08-06 23:22:35 -0700 | [diff] [blame] | 36 | #include <nnapi/hal/CommonUtils.h> |
Michael Butler | 4b276a7 | 2020-08-06 23:22:35 -0700 | [diff] [blame] | 37 | |
Michael Butler | 76e491f | 2020-12-19 01:55:32 -0800 | [diff] [blame] | 38 | #include <chrono> |
Michael Butler | 4b276a7 | 2020-08-06 23:22:35 -0700 | [diff] [blame] | 39 | #include <memory> |
| 40 | #include <tuple> |
| 41 | #include <utility> |
| 42 | #include <vector> |
| 43 | |
Michael Butler | aad934b | 2020-12-13 23:06:06 -0800 | [diff] [blame] | 44 | // See hardware/interfaces/neuralnetworks/utils/README.md for more information on HIDL interface |
| 45 | // lifetimes across processes and for protecting asynchronous calls across HIDL. |
| 46 | |
Michael Butler | 4b276a7 | 2020-08-06 23:22:35 -0700 | [diff] [blame] | 47 | namespace android::hardware::neuralnetworks::V1_2::utils { |
Michael Butler | 4b276a7 | 2020-08-06 23:22:35 -0700 | [diff] [blame] | 48 | |
| 49 | nn::GeneralResult<std::shared_ptr<const PreparedModel>> PreparedModel::create( |
Michael Butler | 7fd03c2 | 2020-12-06 21:50:59 -0800 | [diff] [blame] | 50 | sp<V1_2::IPreparedModel> preparedModel, bool executeSynchronously) { |
Michael Butler | 4b276a7 | 2020-08-06 23:22:35 -0700 | [diff] [blame] | 51 | if (preparedModel == nullptr) { |
Michael Butler | 7fd03c2 | 2020-12-06 21:50:59 -0800 | [diff] [blame] | 52 | return NN_ERROR() << "V1_2::utils::PreparedModel::create must have non-null preparedModel"; |
Michael Butler | 4b276a7 | 2020-08-06 23:22:35 -0700 | [diff] [blame] | 53 | } |
| 54 | |
| 55 | auto deathHandler = NN_TRY(hal::utils::DeathHandler::create(preparedModel)); |
Michael Butler | 7fd03c2 | 2020-12-06 21:50:59 -0800 | [diff] [blame] | 56 | return std::make_shared<const PreparedModel>(PrivateConstructorTag{}, executeSynchronously, |
| 57 | std::move(preparedModel), std::move(deathHandler)); |
Michael Butler | 4b276a7 | 2020-08-06 23:22:35 -0700 | [diff] [blame] | 58 | } |
| 59 | |
Michael Butler | 7fd03c2 | 2020-12-06 21:50:59 -0800 | [diff] [blame] | 60 | PreparedModel::PreparedModel(PrivateConstructorTag /*tag*/, bool executeSynchronously, |
| 61 | sp<V1_2::IPreparedModel> preparedModel, |
Michael Butler | 4b276a7 | 2020-08-06 23:22:35 -0700 | [diff] [blame] | 62 | hal::utils::DeathHandler deathHandler) |
Michael Butler | 7fd03c2 | 2020-12-06 21:50:59 -0800 | [diff] [blame] | 63 | : kExecuteSynchronously(executeSynchronously), |
| 64 | kPreparedModel(std::move(preparedModel)), |
| 65 | kDeathHandler(std::move(deathHandler)) {} |
Michael Butler | 4b276a7 | 2020-08-06 23:22:35 -0700 | [diff] [blame] | 66 | |
| 67 | nn::ExecutionResult<std::pair<std::vector<nn::OutputShape>, nn::Timing>> |
| 68 | PreparedModel::executeSynchronously(const V1_0::Request& request, MeasureTiming measure) const { |
Michael Butler | 7fd03c2 | 2020-12-06 21:50:59 -0800 | [diff] [blame] | 69 | auto cb = hal::utils::CallbackValue(executionCallback); |
Michael Butler | 4b276a7 | 2020-08-06 23:22:35 -0700 | [diff] [blame] | 70 | |
| 71 | const auto ret = kPreparedModel->executeSynchronously(request, measure, cb); |
Michael Butler | cca3e20 | 2020-11-22 20:25:34 -0800 | [diff] [blame] | 72 | HANDLE_TRANSPORT_FAILURE(ret); |
Michael Butler | 4b276a7 | 2020-08-06 23:22:35 -0700 | [diff] [blame] | 73 | |
Michael Butler | 7fd03c2 | 2020-12-06 21:50:59 -0800 | [diff] [blame] | 74 | return cb.take(); |
Michael Butler | 4b276a7 | 2020-08-06 23:22:35 -0700 | [diff] [blame] | 75 | } |
| 76 | |
| 77 | nn::ExecutionResult<std::pair<std::vector<nn::OutputShape>, nn::Timing>> |
| 78 | PreparedModel::executeAsynchronously(const V1_0::Request& request, MeasureTiming measure) const { |
| 79 | const auto cb = sp<ExecutionCallback>::make(); |
| 80 | const auto scoped = kDeathHandler.protectCallback(cb.get()); |
| 81 | |
| 82 | const auto ret = kPreparedModel->execute_1_2(request, measure, cb); |
Michael Butler | cca3e20 | 2020-11-22 20:25:34 -0800 | [diff] [blame] | 83 | const auto status = HANDLE_TRANSPORT_FAILURE(ret); |
Michael Butler | 7fd03c2 | 2020-12-06 21:50:59 -0800 | [diff] [blame] | 84 | if (status != V1_0::ErrorStatus::OUTPUT_INSUFFICIENT_SIZE) { |
Michael Butler | 49d95e0 | 2021-10-15 18:52:52 -0700 | [diff] [blame] | 85 | HANDLE_STATUS_HIDL(status) << "execution failed with " << toString(status); |
Michael Butler | 4b276a7 | 2020-08-06 23:22:35 -0700 | [diff] [blame] | 86 | } |
| 87 | |
| 88 | return cb->get(); |
| 89 | } |
| 90 | |
| 91 | nn::ExecutionResult<std::pair<std::vector<nn::OutputShape>, nn::Timing>> PreparedModel::execute( |
| 92 | const nn::Request& request, nn::MeasureTiming measure, |
| 93 | const nn::OptionalTimePoint& /*deadline*/, |
Miao Wang | 0e671f3 | 2021-10-26 20:03:05 +0000 | [diff] [blame] | 94 | const nn::OptionalDuration& /*loopTimeoutDuration*/, |
| 95 | const std::vector<nn::TokenValuePair>& /*hints*/, |
| 96 | const std::vector<nn::ExtensionNameAndPrefix>& /*extensionNameToPrefix*/) const { |
Michael Butler | 4b276a7 | 2020-08-06 23:22:35 -0700 | [diff] [blame] | 97 | // Ensure that request is ready for IPC. |
| 98 | std::optional<nn::Request> maybeRequestInShared; |
Xusong Wang | 5f6bedb | 2021-03-03 16:20:37 -0800 | [diff] [blame] | 99 | hal::utils::RequestRelocation relocation; |
Michael Butler | ff9a5a5 | 2021-10-15 16:23:20 -0700 | [diff] [blame] | 100 | const nn::Request& requestInShared = NN_TRY(hal::utils::convertRequestFromPointerToShared( |
| 101 | &request, nn::kDefaultRequestMemoryAlignment, nn::kMinMemoryPadding, |
| 102 | &maybeRequestInShared, &relocation)); |
Michael Butler | 4b276a7 | 2020-08-06 23:22:35 -0700 | [diff] [blame] | 103 | |
Michael Butler | ff9a5a5 | 2021-10-15 16:23:20 -0700 | [diff] [blame] | 104 | const auto hidlRequest = NN_TRY(convert(requestInShared)); |
| 105 | const auto hidlMeasure = NN_TRY(convert(measure)); |
Michael Butler | 4b276a7 | 2020-08-06 23:22:35 -0700 | [diff] [blame] | 106 | |
Xusong Wang | 5f6bedb | 2021-03-03 16:20:37 -0800 | [diff] [blame] | 107 | return executeInternal(hidlRequest, hidlMeasure, relocation); |
| 108 | } |
| 109 | |
| 110 | nn::ExecutionResult<std::pair<std::vector<nn::OutputShape>, nn::Timing>> |
| 111 | PreparedModel::executeInternal(const V1_0::Request& request, MeasureTiming measure, |
| 112 | const hal::utils::RequestRelocation& relocation) const { |
| 113 | if (relocation.input) { |
| 114 | relocation.input->flush(); |
| 115 | } |
| 116 | |
| 117 | auto result = kExecuteSynchronously ? executeSynchronously(request, measure) |
| 118 | : executeAsynchronously(request, measure); |
Michael Butler | 7fd03c2 | 2020-12-06 21:50:59 -0800 | [diff] [blame] | 119 | auto [outputShapes, timing] = NN_TRY(std::move(result)); |
Michael Butler | 4b276a7 | 2020-08-06 23:22:35 -0700 | [diff] [blame] | 120 | |
Xusong Wang | 5f6bedb | 2021-03-03 16:20:37 -0800 | [diff] [blame] | 121 | if (relocation.output) { |
| 122 | relocation.output->flush(); |
| 123 | } |
Michael Butler | 7fd03c2 | 2020-12-06 21:50:59 -0800 | [diff] [blame] | 124 | return std::make_pair(std::move(outputShapes), timing); |
Michael Butler | 4b276a7 | 2020-08-06 23:22:35 -0700 | [diff] [blame] | 125 | } |
| 126 | |
| 127 | nn::GeneralResult<std::pair<nn::SyncFence, nn::ExecuteFencedInfoCallback>> |
Miao Wang | 0e671f3 | 2021-10-26 20:03:05 +0000 | [diff] [blame] | 128 | PreparedModel::executeFenced( |
| 129 | const nn::Request& /*request*/, const std::vector<nn::SyncFence>& /*waitFor*/, |
| 130 | nn::MeasureTiming /*measure*/, const nn::OptionalTimePoint& /*deadline*/, |
| 131 | const nn::OptionalDuration& /*loopTimeoutDuration*/, |
| 132 | const nn::OptionalDuration& /*timeoutDurationAfterFence*/, |
| 133 | const std::vector<nn::TokenValuePair>& /*hints*/, |
| 134 | const std::vector<nn::ExtensionNameAndPrefix>& /*extensionNameToPrefix*/) const { |
Michael Butler | 4b276a7 | 2020-08-06 23:22:35 -0700 | [diff] [blame] | 135 | return NN_ERROR(nn::ErrorStatus::GENERAL_FAILURE) |
| 136 | << "IPreparedModel::executeFenced is not supported on 1.2 HAL service"; |
| 137 | } |
| 138 | |
Xusong Wang | 5f6bedb | 2021-03-03 16:20:37 -0800 | [diff] [blame] | 139 | nn::GeneralResult<nn::SharedExecution> PreparedModel::createReusableExecution( |
| 140 | const nn::Request& request, nn::MeasureTiming measure, |
Miao Wang | 0e671f3 | 2021-10-26 20:03:05 +0000 | [diff] [blame] | 141 | const nn::OptionalDuration& /*loopTimeoutDuration*/, |
| 142 | const std::vector<nn::TokenValuePair>& /*hints*/, |
| 143 | const std::vector<nn::ExtensionNameAndPrefix>& /*extensionNameToPrefix*/) const { |
Xusong Wang | 5f6bedb | 2021-03-03 16:20:37 -0800 | [diff] [blame] | 144 | // Ensure that request is ready for IPC. |
| 145 | std::optional<nn::Request> maybeRequestInShared; |
| 146 | hal::utils::RequestRelocation relocation; |
| 147 | const nn::Request& requestInShared = NN_TRY(hal::utils::convertRequestFromPointerToShared( |
Xusong Wang | e3d0dad | 2021-05-07 14:13:22 -0700 | [diff] [blame] | 148 | &request, nn::kDefaultRequestMemoryAlignment, nn::kMinMemoryPadding, |
| 149 | &maybeRequestInShared, &relocation)); |
Xusong Wang | 5f6bedb | 2021-03-03 16:20:37 -0800 | [diff] [blame] | 150 | |
| 151 | auto hidlRequest = NN_TRY(convert(requestInShared)); |
| 152 | auto hidlMeasure = NN_TRY(convert(measure)); |
| 153 | return Execution::create(shared_from_this(), std::move(hidlRequest), std::move(relocation), |
| 154 | hidlMeasure); |
| 155 | } |
| 156 | |
Michael Butler | 2a8b679 | 2020-12-18 20:31:14 -0800 | [diff] [blame] | 157 | nn::GeneralResult<nn::SharedBurst> PreparedModel::configureExecutionBurst() const { |
Michael Butler | 76e491f | 2020-12-19 01:55:32 -0800 | [diff] [blame] | 158 | const auto pollingTimeWindow = getBurstControllerPollingTimeWindow(); |
Michael Butler | 137ee99 | 2021-11-01 16:40:31 -0700 | [diff] [blame] | 159 | return Burst::create(shared_from_this(), kPreparedModel, pollingTimeWindow); |
Michael Butler | 2a8b679 | 2020-12-18 20:31:14 -0800 | [diff] [blame] | 160 | } |
| 161 | |
Michael Butler | 4b276a7 | 2020-08-06 23:22:35 -0700 | [diff] [blame] | 162 | std::any PreparedModel::getUnderlyingResource() const { |
Michael Butler | 7fd03c2 | 2020-12-06 21:50:59 -0800 | [diff] [blame] | 163 | sp<V1_2::IPreparedModel> resource = kPreparedModel; |
Michael Butler | 4b276a7 | 2020-08-06 23:22:35 -0700 | [diff] [blame] | 164 | return resource; |
| 165 | } |
| 166 | |
| 167 | } // namespace android::hardware::neuralnetworks::V1_2::utils |