summaryrefslogtreecommitdiff
path: root/runtimes/neurun/frontend/nnapi/execution.cc
blob: 837cab0fa1740b058d06f2f99f2bd7b398722f4d (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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
/*
 * Copyright (c) 2018 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.
 */

#include <NeuralNetworks.h>

#include <new>

#include "wrapper/ANeuralNetworksCompilation.h"
#include "wrapper/ANeuralNetworksExecution.h"
#include "wrapper/ANeuralNetworksMemory.h"
#include "wrapper/ANeuralNetworksEvent.h"
#include "wrapper/NNAPIConvert.h"
#include "util/logging.h"

//
// NNAPI Implementation
//
int ANeuralNetworksExecution_create(ANeuralNetworksCompilation *compilation,
                                    ANeuralNetworksExecution **execution)
{
  if ((compilation == nullptr) || (execution == nullptr))
  {
    VERBOSE(NNAPI::Execution) << "create: Incorrect null pointer parameter(s)" << std::endl;
    return ANEURALNETWORKS_UNEXPECTED_NULL;
  }

  std::shared_ptr<neurun::exec::IExecutor> executor;

  compilation->publish(executor);

  if (executor == nullptr)
  {
    VERBOSE(NNAPI::Execution) << "create: Never compiled yet" << std::endl;
    return ANEURALNETWORKS_BAD_STATE;
  }

  *execution = new (std::nothrow) ANeuralNetworksExecution{executor};
  if (*execution == nullptr)
  {
    VERBOSE(NNAPI::Execution) << "create: Fail to create execution object" << std::endl;
    return ANEURALNETWORKS_OUT_OF_MEMORY;
  }

  return ANEURALNETWORKS_NO_ERROR;
}

// NOTE Handle optional input
//  Unspecified shape on model build
//    Optional and omitted input on execution: skip input setting (workaround for LSTM)
//    Optional but not omitted input on execution: cannot handle
//    Normal input on execution: cannot handle
//  Fully specified shape on model build
//    Optional input on execution: cannot handle
//    Normal input: handle normally
int ANeuralNetworksExecution_setInput(ANeuralNetworksExecution *execution, int32_t index,
                                      const ANeuralNetworksOperandType *type, const void *buffer,
                                      size_t length)
{
  // Don't check type
  // Comment about ANeuralNetworksOperandType in NeuralNetworks.h:
  //  If the input or output is optional and omitted then it need not have a fully specified tensor
  //  operand type
  if ((execution == nullptr) || ((buffer == nullptr) && (length != 0)))
  {
    VERBOSE(NNAPI::Execution) << "setInput: Incorrect null pointer parameter(s)" << std::endl;
    return ANEURALNETWORKS_UNEXPECTED_NULL;
  }

  if ((buffer != nullptr) && (length == 0))
  {
    VERBOSE(NNAPI::Execution) << "setInput: Zero length input" << std::endl;
    return ANEURALNETWORKS_BAD_DATA;
  }

  const auto operand_index = execution->getInputOperandIndex(index);
  if (!operand_index.valid())
  {
    VERBOSE(NNAPI::Execution) << "setInput: Invalid input index" << std::endl;
    return ANEURALNETWORKS_BAD_DATA;
  }

  // Omitted optional input
  // LSTM operation's some inputs can be optional input
  if ((buffer == nullptr) && (length == 0))
  {
    if (execution->haveUnspecifiedDims(operand_index))
    {
      return ANEURALNETWORKS_NO_ERROR;
    }
    else
    {
      VERBOSE(NNAPI::Execution) << "setInput: Cannot handle fully-specified shape on model build "
                                   "but omitted input on execution"
                                << std::endl;
      return ANEURALNETWORKS_BAD_DATA;
    }
  }

  if (type != nullptr)
  {
    if (!execution->compareDataType(type, operand_index))
    {
      VERBOSE(NNAPI::Execution) << "setInput: Data type mismatch" << std::endl;
      return ANEURALNETWORKS_BAD_DATA;
    }

    if (!execution->compareShape(type, operand_index))
    {
      VERBOSE(NNAPI::Execution) << "setInput: Shape mismatch" << std::endl;
      return ANEURALNETWORKS_BAD_DATA;
    }

    if (NNAPIConvert::calculateSizeFromType(type) != length)
    {
      VERBOSE(NNAPI::Execution) << "setInput: Invalid length" << std::endl;
      return ANEURALNETWORKS_BAD_DATA;
    }
  }
  else
  {
    if (execution->haveUnspecifiedDims(operand_index))
    {
      VERBOSE(NNAPI::Execution) << "setInput: Unspecified dimension value" << std::endl;
      return ANEURALNETWORKS_BAD_DATA;
    }

    if (execution->getOperandSize(operand_index) != length)
    {
      VERBOSE(NNAPI::Execution) << "setInput: Invalid length" << std::endl;
      return ANEURALNETWORKS_BAD_DATA;
    }
  }

  if (!execution->setInput(index, type, buffer, length))
  {
    VERBOSE(NNAPI::Execution) << "setInput: Fail to set input" << std::endl;
    return ANEURALNETWORKS_BAD_DATA;
  }

  return ANEURALNETWORKS_NO_ERROR;
}

int ANeuralNetworksExecution_setOutput(ANeuralNetworksExecution *execution, int32_t index,
                                       const ANeuralNetworksOperandType *type, void *buffer,
                                       size_t length)
{
  // Don't check type
  // Comment about ANeuralNetworksOperandType in NeuralNetworks.h:
  //  If the input or output is optional and omitted then it need not have a fully specified tensor
  //  operand type
  if ((execution == nullptr) || ((buffer == nullptr) && (length != 0)))
  {
    VERBOSE(NNAPI::Execution) << "setOutput: Incorrect null pointer parameter(s)" << std::endl;
    return ANEURALNETWORKS_UNEXPECTED_NULL;
  }

  if ((buffer != nullptr) && (length == 0))
  {
    VERBOSE(NNAPI::Execution) << "setOutput: Zero length output" << std::endl;
    return ANEURALNETWORKS_BAD_DATA;
  }

  // Handle optional output
  if (buffer == nullptr)
  {
    return ANEURALNETWORKS_NO_ERROR;
  }

  const auto operand_index = execution->getOutputOperandIndex(index);
  if (!operand_index.valid())
  {
    VERBOSE(NNAPI::Execution) << "setOutput: Invalid output index" << std::endl;
    return ANEURALNETWORKS_BAD_DATA;
  }

  if (type != nullptr)
  {
    if (!execution->compareDataType(type, operand_index))
    {
      VERBOSE(NNAPI::Execution) << "setOutput: Data type mismatch" << std::endl;
      return ANEURALNETWORKS_BAD_DATA;
    }

    if (!execution->compareShape(type, operand_index))
    {
      VERBOSE(NNAPI::Execution) << "setOutput: Shape mismatch" << std::endl;
      return ANEURALNETWORKS_BAD_DATA;
    }

    if (NNAPIConvert::calculateSizeFromType(type) != length)
    {
      VERBOSE(NNAPI::Execution) << "setOutput: Invalid length" << std::endl;
      return ANEURALNETWORKS_BAD_DATA;
    }
  }
  else
  {
    if (execution->haveUnspecifiedDims(operand_index))
    {
      VERBOSE(NNAPI::Execution) << "setOutput: Unspecified dimension value" << std::endl;
      return ANEURALNETWORKS_BAD_DATA;
    }

    if (execution->getOperandSize(operand_index) != length)
    {
      VERBOSE(NNAPI::Execution) << "setInput: Invalid length" << std::endl;
      return ANEURALNETWORKS_BAD_DATA;
    }
  }

  if (!execution->setOutput(index, type, buffer, length))
  {
    VERBOSE(NNAPI::Execution) << "setOutput: Fail to set output" << std::endl;
    return ANEURALNETWORKS_BAD_DATA;
  }

  return ANEURALNETWORKS_NO_ERROR;
}

int ANeuralNetworksExecution_startCompute(ANeuralNetworksExecution *execution,
                                          ANeuralNetworksEvent **event)
{
  if ((execution == nullptr) || (event == nullptr))
  {
    VERBOSE(NNAPI::Execution) << "startCompute: Incorrect null pointer parameter(s)" << std::endl;
    return ANEURALNETWORKS_UNEXPECTED_NULL;
  }

  // TODO: Handle event
  auto instance = execution->instance();
  *event = new (std::nothrow) ANeuralNetworksEvent{instance};
  if (*event == nullptr)
  {
    VERBOSE(NNAPI::Execution) << "startCompute: Fail to create event" << std::endl;
    return ANEURALNETWORKS_OUT_OF_MEMORY;
  }

  if (!execution->startExecute())
  {
    VERBOSE(NNAPI::Execution) << "startCompute: Fail to start execution" << std::endl;
    return ANEURALNETWORKS_BAD_STATE;
  }

  return ANEURALNETWORKS_NO_ERROR;
}

void ANeuralNetworksExecution_free(ANeuralNetworksExecution *execution) { delete execution; }

int ANeuralNetworksExecution_setInputFromMemory(ANeuralNetworksExecution *execution, int32_t index,
                                                const ANeuralNetworksOperandType *type,
                                                const ANeuralNetworksMemory *memory, size_t offset,
                                                size_t length)
{
  if ((execution == nullptr) || (memory == nullptr))
  {
    VERBOSE(NNAPI::Execution) << "setInputFromMemory: Incorrect null pointer parameter(s)"
                              << std::endl;
    return ANEURALNETWORKS_UNEXPECTED_NULL;
  }

  if (length == 0)
  {
    VERBOSE(NNAPI::Execution) << "setInputFromMemory: Zero length input" << std::endl;
    return ANEURALNETWORKS_BAD_DATA;
  }

  const auto operand_index = execution->getInputOperandIndex(index);
  if (!operand_index.valid())
  {
    VERBOSE(NNAPI::Execution) << "setInputFromMemory: Invalid input index" << std::endl;
    return ANEURALNETWORKS_BAD_DATA;
  }

  if (type != nullptr)
  {
    if (!execution->compareDataType(type, operand_index))
    {
      VERBOSE(NNAPI::Execution) << "setInputFromMemory: Data type mismatch" << std::endl;
      return ANEURALNETWORKS_BAD_DATA;
    }

    if (!execution->compareShape(type, operand_index))
    {
      VERBOSE(NNAPI::Execution) << "setInputFromMemory: Shape mismatch" << std::endl;
      return ANEURALNETWORKS_BAD_DATA;
    }

    if (NNAPIConvert::calculateSizeFromType(type) != length)
    {
      VERBOSE(NNAPI::Execution) << "setInputFromMemory: Invalid length" << std::endl;
      return ANEURALNETWORKS_BAD_DATA;
    }
  }
  else
  {
    if (execution->haveUnspecifiedDims(operand_index))
    {
      VERBOSE(NNAPI::Execution) << "setInputFromMemory: Unspecified dimension value" << std::endl;
      return ANEURALNETWORKS_BAD_DATA;
    }

    if (execution->getOperandSize(operand_index) != length)
    {
      VERBOSE(NNAPI::Execution) << "setInputFromMemory: Invalid length" << std::endl;
      return ANEURALNETWORKS_BAD_DATA;
    }
  }

  if (!memory->vaildAccess(offset, length))
  {
    VERBOSE(NNAPI::Execution) << "setInputFromMemory: Invalid memory access" << std::endl;
    return ANEURALNETWORKS_BAD_DATA;
  }

  if (!execution->setInput(index, type, reinterpret_cast<const void *>(memory->base() + offset),
                           length))
  {
    VERBOSE(NNAPI::Execution) << "setInputFromMemory: Fail to set input" << std::endl;
    return ANEURALNETWORKS_BAD_DATA;
  }

  return ANEURALNETWORKS_NO_ERROR;
}

int ANeuralNetworksExecution_setOutputFromMemory(ANeuralNetworksExecution *execution, int32_t index,
                                                 const ANeuralNetworksOperandType *type,
                                                 const ANeuralNetworksMemory *memory, size_t offset,
                                                 size_t length)
{
  if ((execution == nullptr) || (memory == nullptr))
  {
    VERBOSE(NNAPI::Execution) << "setOutputFromMemory: Incorrect null pointer parameter(s)"
                              << std::endl;
    return ANEURALNETWORKS_UNEXPECTED_NULL;
  }

  if (length == 0)
  {
    VERBOSE(NNAPI::Execution) << "setOutputFromMemory: Zero length input" << std::endl;
    return ANEURALNETWORKS_BAD_DATA;
  }

  const auto operand_index = execution->getOutputOperandIndex(index);
  if (!operand_index.valid())
  {
    VERBOSE(NNAPI::Execution) << "setOutputFromMemory: Invalid output index" << std::endl;
    return ANEURALNETWORKS_BAD_DATA;
  }

  if (type != nullptr)
  {
    if (!execution->compareDataType(type, operand_index))
    {
      VERBOSE(NNAPI::Execution) << "setOutputFromMemory: Data type mismatch" << std::endl;
      return ANEURALNETWORKS_BAD_DATA;
    }

    if (!execution->compareShape(type, operand_index))
    {
      VERBOSE(NNAPI::Execution) << "setOutputFromMemory: Shape mismatch" << std::endl;
      return ANEURALNETWORKS_BAD_DATA;
    }

    if (NNAPIConvert::calculateSizeFromType(type) != length)
    {
      VERBOSE(NNAPI::Execution) << "setOutputFromMemory: Invalid length" << std::endl;
      return ANEURALNETWORKS_BAD_DATA;
    }
  }
  else
  {
    if (execution->haveUnspecifiedDims(operand_index))
    {
      VERBOSE(NNAPI::Execution) << "setOutputFromMemory: Unspecified dimension value" << std::endl;
      return ANEURALNETWORKS_BAD_DATA;
    }

    if (execution->getOperandSize(operand_index) != length)
    {
      VERBOSE(NNAPI::Execution) << "setOutputFromMemory: Invalid length" << std::endl;
      return ANEURALNETWORKS_BAD_DATA;
    }
  }

  if (!memory->vaildAccess(offset, length))
  {
    VERBOSE(NNAPI::Execution) << "setOutputFromMemory: Invalid memory access" << std::endl;
    return ANEURALNETWORKS_BAD_DATA;
  }

  if (!execution->setOutput(index, type, reinterpret_cast<void *>(memory->base() + offset), length))
  {
    VERBOSE(NNAPI::Execution) << "setOutputFromMemory: Fail to set input" << std::endl;
    return ANEURALNETWORKS_BAD_DATA;
  }

  return ANEURALNETWORKS_NO_ERROR;
}