summaryrefslogtreecommitdiff
path: root/runtime/onert/core/include/exec/IExecutor.h
blob: bb5b5af98b7096f5b5f159ba080642dec17936bf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
/*
 * Copyright (c) 2019 Samsung Electronics Co., Ltd. All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @file  IExecutor.h
 * @brief This file defines interface of Executor
 */
#ifndef __ONERT_EXEC_I_EXECUTOR_H__
#define __ONERT_EXEC_I_EXECUTOR_H__

#include "ir/Graph.h"
#include "IFunction.h"
#include "IODescription.h"
#include "ir/Index.h"
#include "ir/OperationIndexMap.h"

#include <cstdint>
#include <memory>
#include <unordered_map>

namespace onert
{
namespace backend
{
class IPortableTensor;
namespace builtin
{
class IOTensor;
}
} // namespace backend
} // namespace onert
namespace onert
{
namespace exec
{
class IExecutionObserver;
/**
 * @brief Struct to define interface of Executor
 */
struct IExecutor
{
  /**
   * @brief Construct a new IExecutor object
   */
  IExecutor() = default;
  /**
   * @brief Destroy the IExecutor object
   */
  virtual ~IExecutor() = default;

  /**
   * @brief Returns graph object
   *
   * @return Graph object
   */
  virtual const ir::Graph &graph() = 0;

  /**
   * @brief Returns parent graph object
   *
   * @return Graph object
   */
  virtual const ir::Graph &parent_graph() = 0;

  /**
   * @brief     Set an ordering on operations
   * @param[in] ranks   The table encoding the ordering
   */
  virtual void setIndexedRanks(std::shared_ptr<ir::OperationIndexMap<int64_t>>) = 0;

  /**
   * @brief     Execute with user-given input/output description (for primary subgraph)
   * @param[in] desc Input and output description
   * @note      This method should be thread-safe
   */
  virtual void execute(const IODescription &desc) = 0;

  /**
   * @brief Execute with given input/output tensors
   *
   * For non-primary subgraphs, input and output tensors must be given.
   *
   * @param[in] inputs tensors that are passed as inputs
   * @param[in] outputs tensors that are passed as outputs
   */
  virtual void execute(const std::vector<backend::IPortableTensor *> &inputs,
                       const std::vector<backend::IPortableTensor *> &outputs) = 0;

  /**
   * @brief Get output tensor objects
   *
   * @return Vector of @c IOTensor
   */
  virtual const std::vector<backend::builtin::IOTensor *> &getOutputTensors() const = 0;
};

} // namespace exec
} // namespace onert

#endif // __ONERT_EXEC_I_EXECUTOR_H__