summaryrefslogtreecommitdiff
path: root/runtimes/libs/rua/core/include/rua/Service.h
blob: a79524a8ae564bc03307350b9f88ba7db360022f (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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
/*
 * 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 Service.h
 * @brief Core abstraction that RUA depends on.
 */
#ifndef __NNFW_RUA_SERVICE_H__
#define __NNFW_RUA_SERVICE_H__

#include "NeuralNetworks.h"

struct ANeuralNetworksMemory;
struct ANeuralNetworksEvent;

struct ANeuralNetworksModel;
struct ANeuralNetworksCompilation;
struct ANeuralNetworksExecution;

namespace rua
{

/**
 * @brief A wrapper for ANeuralNetworkMemory API
 */
struct MemoryService
{
  virtual ~MemoryService() = default;

  virtual int createFromFd(size_t size, int protect, int fd, size_t offset,
                           ANeuralNetworksMemory **memory) const = 0;

  virtual void free(ANeuralNetworksMemory *memory) const = 0;
};

/**
 * @brief A wrapper for ANeuralNetworkModel API
 */
struct ModelService
{
  virtual ~ModelService() = default;

  virtual int create(ANeuralNetworksModel **model) const = 0;

  virtual int addOperand(ANeuralNetworksModel *model,
                         const ANeuralNetworksOperandType *type) const = 0;

  virtual int setOperandValue(ANeuralNetworksModel *model, int32_t index, const void *buffer,
                              size_t length) const = 0;

  virtual int setOperandValueFromMemory(ANeuralNetworksModel *model, int32_t index,
                                        const ANeuralNetworksMemory *memory, size_t offset,
                                        size_t length) const = 0;

  virtual int addOperation(ANeuralNetworksModel *model, ANeuralNetworksOperationType type,
                           uint32_t inputCount, const uint32_t *inputs, uint32_t outputCount,
                           const uint32_t *outputs) const = 0;

  virtual int identifyInputsAndOutputs(ANeuralNetworksModel *model, uint32_t inputCount,
                                       const uint32_t *inputs, uint32_t outputCount,
                                       const uint32_t *outputs) const = 0;

  virtual int relaxComputationFloat32toFloat16(ANeuralNetworksModel *model, bool allow) const = 0;

  virtual int finish(ANeuralNetworksModel *model) const = 0;

  virtual void free(ANeuralNetworksModel *model) const = 0;
};

/**
 * @brief A wrapper for ANeuralNetworkCompilation API
 */
struct CompilationService
{
  virtual ~CompilationService() = default;

  virtual int create(ANeuralNetworksModel *model,
                     ANeuralNetworksCompilation **compilation) const = 0;

  virtual int setPreference(ANeuralNetworksCompilation *compilation, int32_t preference) const = 0;
  virtual int finish(ANeuralNetworksCompilation *compilation) const = 0;

  virtual void free(ANeuralNetworksCompilation *compilation) const = 0;
};

/**
 * @brief A wrapper for ANeuralNetworkExecution API
 */
struct ExecutionService
{
  virtual ~ExecutionService() = default;

  virtual int create(ANeuralNetworksCompilation *compilation,
                     ANeuralNetworksExecution **execution) const = 0;

  virtual void free(ANeuralNetworksExecution *execution) const = 0;

  virtual int setInput(ANeuralNetworksExecution *execution, int32_t index,
                       const ANeuralNetworksOperandType *type, const void *buffer,
                       size_t length) const = 0;

  virtual int setInputFromMemory(ANeuralNetworksExecution *execution, int32_t index,
                                 const ANeuralNetworksOperandType *type,
                                 const ANeuralNetworksMemory *memory, size_t offset,
                                 size_t length) const = 0;

  virtual int setOutput(ANeuralNetworksExecution *execution, int32_t index,
                        const ANeuralNetworksOperandType *type, void *buffer,
                        size_t length) const = 0;

  virtual int setOutputFromMemory(ANeuralNetworksExecution *execution, int32_t index,
                                  const ANeuralNetworksOperandType *type,
                                  const ANeuralNetworksMemory *memory, size_t offset,
                                  size_t length) const = 0;

  virtual int startCompute(ANeuralNetworksExecution *execution,
                           ANeuralNetworksEvent **event) const = 0;
};

/**
 * @brief A wrapper for ANeuralNetworkEvent API
 */
struct EventService
{
  virtual int wait(ANeuralNetworksEvent *event) const = 0;
  virtual void free(ANeuralNetworksEvent *event) const = 0;
};

/**
 * @brief A wrapper for Android NN rutime itself
 */
struct RuntimeService
{
  virtual ~RuntimeService() = default;

  virtual const MemoryService *memory(void) const = 0;
  virtual const ModelService *model(void) const = 0;
  virtual const CompilationService *compilation(void) const = 0;
  virtual const ExecutionService *execution(void) const = 0;
  virtual const EventService *event(void) const = 0;
};

} // namespace rua

#endif // __NNFW_RUA_SERVICE_H__