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 #ifndef ANDROID_HARDWARE_INTERFACES_NEURALNETWORKS_UTILS_COMMON_RESILIENT_PREPARED_MODEL_H
18 #define ANDROID_HARDWARE_INTERFACES_NEURALNETWORKS_UTILS_COMMON_RESILIENT_PREPARED_MODEL_H
19 
20 #include <android-base/thread_annotations.h>
21 #include <nnapi/IPreparedModel.h>
22 #include <nnapi/Result.h>
23 #include <nnapi/Types.h>
24 
25 #include <functional>
26 #include <memory>
27 #include <mutex>
28 #include <utility>
29 #include <vector>
30 
31 namespace android::hardware::neuralnetworks::utils {
32 
33 class ResilientPreparedModel final : public nn::IPreparedModel,
34                                      public std::enable_shared_from_this<ResilientPreparedModel> {
35     struct PrivateConstructorTag {};
36 
37   public:
38     using Factory = std::function<nn::GeneralResult<nn::SharedPreparedModel>()>;
39 
40     static nn::GeneralResult<std::shared_ptr<const ResilientPreparedModel>> create(
41             Factory makePreparedModel);
42 
43     explicit ResilientPreparedModel(PrivateConstructorTag tag, Factory makePreparedModel,
44                                     nn::SharedPreparedModel preparedModel);
45 
46     nn::SharedPreparedModel getPreparedModel() const;
47     nn::GeneralResult<nn::SharedPreparedModel> recover(
48             const nn::IPreparedModel* failingPreparedModel) const;
49 
50     nn::ExecutionResult<std::pair<std::vector<nn::OutputShape>, nn::Timing>> execute(
51             const nn::Request& request, nn::MeasureTiming measure,
52             const nn::OptionalTimePoint& deadline, const nn::OptionalDuration& loopTimeoutDuration,
53             const std::vector<nn::TokenValuePair>& hints,
54             const std::vector<nn::ExtensionNameAndPrefix>& extensionNameToPrefix) const override;
55 
56     nn::GeneralResult<std::pair<nn::SyncFence, nn::ExecuteFencedInfoCallback>> executeFenced(
57             const nn::Request& request, const std::vector<nn::SyncFence>& waitFor,
58             nn::MeasureTiming measure, const nn::OptionalTimePoint& deadline,
59             const nn::OptionalDuration& loopTimeoutDuration,
60             const nn::OptionalDuration& timeoutDurationAfterFence,
61             const std::vector<nn::TokenValuePair>& hints,
62             const std::vector<nn::ExtensionNameAndPrefix>& extensionNameToPrefix) const override;
63 
64     nn::GeneralResult<nn::SharedExecution> createReusableExecution(
65             const nn::Request& request, nn::MeasureTiming measure,
66             const nn::OptionalDuration& loopTimeoutDuration,
67             const std::vector<nn::TokenValuePair>& hints,
68             const std::vector<nn::ExtensionNameAndPrefix>& extensionNameToPrefix) const override;
69 
70     nn::GeneralResult<nn::SharedBurst> configureExecutionBurst() const override;
71 
72     std::any getUnderlyingResource() const override;
73 
74   private:
75     bool isValidInternal() const EXCLUDES(mMutex);
76     nn::GeneralResult<nn::SharedExecution> createReusableExecutionInternal(
77             const nn::Request& request, nn::MeasureTiming measure,
78             const nn::OptionalDuration& loopTimeoutDuration,
79             const std::vector<nn::TokenValuePair>& metaData,
80             const std::vector<nn::ExtensionNameAndPrefix>& extensionNameToPrefix) const;
81     nn::GeneralResult<nn::SharedBurst> configureExecutionBurstInternal() const;
82 
83     const Factory kMakePreparedModel;
84     mutable std::mutex mMutex;
85     mutable nn::SharedPreparedModel mPreparedModel GUARDED_BY(mMutex);
86 };
87 
88 }  // namespace android::hardware::neuralnetworks::utils
89 
90 #endif  // ANDROID_HARDWARE_INTERFACES_NEURALNETWORKS_UTILS_COMMON_RESILIENT_PREPARED_MODEL_H
91