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_UTILS_COMMON_RESILIENT_EXECUTION_H
18 #define ANDROID_HARDWARE_INTERFACES_NEURALNETWORKS_UTILS_COMMON_RESILIENT_EXECUTION_H
19 
20 #include <android-base/thread_annotations.h>
21 #include <nnapi/IExecution.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 ResilientExecution final : public nn::IExecution,
34                                  public std::enable_shared_from_this<ResilientExecution> {
35     struct PrivateConstructorTag {};
36 
37   public:
38     using Factory = std::function<nn::GeneralResult<nn::SharedExecution>()>;
39 
40     static nn::GeneralResult<std::shared_ptr<const ResilientExecution>> create(
41             Factory makeExecution);
42 
43     ResilientExecution(PrivateConstructorTag tag, Factory makeExecution,
44                        nn::SharedExecution execution);
45 
46     nn::SharedExecution getExecution() const;
47     nn::GeneralResult<nn::SharedExecution> recover(const nn::IExecution* failingExecution) const;
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     bool isValidInternal() const EXCLUDES(mMutex);
58 
59     const Factory kMakeExecution;
60     mutable std::mutex mMutex;
61     mutable nn::SharedExecution mExecution GUARDED_BY(mMutex);
62 };
63 
64 }  // namespace android::hardware::neuralnetworks::utils
65 
66 #endif  // ANDROID_HARDWARE_INTERFACES_NEURALNETWORKS_UTILS_COMMON_RESILIENT_EXECUTION_H
67