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_INTERFACES_NEURALNETWORKS_1_0_UTILS_EXECUTION_H
18 #define ANDROID_HARDWARE_INTERFACES_NEURALNETWORKS_1_0_UTILS_EXECUTION_H
19 
20 #include <android/hardware/neuralnetworks/1.0/IPreparedModel.h>
21 #include <nnapi/IExecution.h>
22 #include <nnapi/Result.h>
23 #include <nnapi/Types.h>
24 #include <nnapi/hal/CommonUtils.h>
25 
26 #include "PreparedModel.h"
27 #include "nnapi/hal/1.0/ProtectCallback.h"
28 
29 #include <memory>
30 #include <utility>
31 #include <vector>
32 
33 // See hardware/interfaces/neuralnetworks/utils/README.md for more information on HIDL interface
34 // lifetimes across processes and for protecting asynchronous calls across HIDL.
35 
36 namespace android::hardware::neuralnetworks::V1_0::utils {
37 
38 class Execution final : public nn::IExecution, public std::enable_shared_from_this<Execution> {
39     struct PrivateConstructorTag {};
40 
41   public:
42     static nn::GeneralResult<std::shared_ptr<const Execution>> create(
43             std::shared_ptr<const PreparedModel> preparedModel, Request request,
44             hal::utils::RequestRelocation relocation);
45 
46     Execution(PrivateConstructorTag tag, std::shared_ptr<const PreparedModel> preparedModel,
47               Request request, hal::utils::RequestRelocation relocation);
48 
49     nn::ExecutionResult<std::pair<std::vector<nn::OutputShape>, nn::Timing>> compute(
50             const nn::OptionalTimePoint& deadline) const override;
51 
52     nn::GeneralResult<std::pair<nn::SyncFence, nn::ExecuteFencedInfoCallback>> computeFenced(
53             const std::vector<nn::SyncFence>& waitFor, const nn::OptionalTimePoint& deadline,
54             const nn::OptionalDuration& timeoutDurationAfterFence) const override;
55 
56   private:
57     const std::shared_ptr<const PreparedModel> kPreparedModel;
58     const Request kRequest;
59     const hal::utils::RequestRelocation kRelocation;
60 };
61 
62 }  // namespace android::hardware::neuralnetworks::V1_0::utils
63 
64 #endif  // ANDROID_HARDWARE_INTERFACES_NEURALNETWORKS_1_0_UTILS_EXECUTION_H
65