summaryrefslogtreecommitdiff
path: root/compiler/exo-tflite/src/Dialect/IR/TFLNodes.h
blob: f9ff2223f245acc59685cf39cf50ad64a322a064 (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
/*
 * 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.
 */

#ifndef __LOCOEX_IR_TFLNODES_H__
#define __LOCOEX_IR_TFLNODES_H__

#include "TFLNodeDecl.h"
#include "TFLOpcode.h"

#include <loco/IR/Node.h>
#include <loco/IR/NodeMixins.h>

#include <array>

namespace locoex
{

/**
 * @brief Nodes with the fixed number of inputs
 */
template <unsigned N, typename Base> class FixedArityNode : public Base
{
public:
  FixedArityNode()
  {
    for (uint32_t n = 0; n < N; ++n)
    {
      _args[n] = std::unique_ptr<loco::Use>(new loco::Use{this});
    }
  }

  virtual ~FixedArityNode() = default;

public:
  unsigned arity(void) const final { return N; }

  loco::Node *arg(uint32_t n) const final { return _args.at(n)->node(); }

  void drop(void) final
  {
    for (uint32_t n = 0; n < N; ++n)
    {
      _args.at(n)->node(nullptr);
    }
  }

protected:
  // This API allows inherited classes to access "_args" field.
  loco::Use *at(unsigned n) const { return _args.at(n).get(); }

private:
  std::array<std::unique_ptr<loco::Use>, N> _args;
};

enum class FusedActFunc
{
  UNDEFINED, // This is not defined by TFLite. This was added to prevent programming error.
  NONE,
  RELU,
  RELU6
};

enum class Padding
{
  UNDEFINED, // This is not defined by TFLite. This was added to prevent programming error.
  SAME,
  VALID,
};

class Filter final
{
public:
  Filter() : _w(1), _h(1) {}

  int32_t w() const { return _w; }
  void w(int32_t w) { _w = w; }

  int32_t h() const { return _h; }
  void h(int32_t h) { _h = h; }

private:
  int32_t _w;
  int32_t _h;
};

class Stride final
{
public:
  Stride() : _w(1), _h(1) {}

  int32_t w() const { return _w; }
  void w(int32_t w) { _w = w; }

  int32_t h() const { return _h; }
  void h(int32_t h) { _h = h; }

private:
  int32_t _w;
  int32_t _h;
};

/**
 * @brief ADD in TensorFlow Lite
 */
class TFLAdd final : public FixedArityNode<2, TFLNodeImpl<TFLOpcode::ADD>>
{
public:
  TFLAdd() = default;

public:
  loco::Node *x(void) const { return at(0)->node(); }
  void x(loco::Node *node) { at(0)->node(node); }

  loco::Node *y(void) const { return at(1)->node(); }
  void y(loco::Node *node) { at(1)->node(node); }
};

/**
 * @brief AVERAGE_POOL_2D in TensorFlow Lite
 */
class TFLAveragePool2D final : public FixedArityNode<1, TFLNodeImpl<TFLOpcode::AVERAGE_POOL_2D>>
{
public:
  TFLAveragePool2D()
      : _fused_act_fun(FusedActFunc::UNDEFINED), _padding(Padding::UNDEFINED) { /* empty */}

public:
  loco::Node *value(void) const { return at(0)->node(); }
  void value(loco::Node *node) { at(0)->node(node); }

  FusedActFunc fusedActivationFunction() const { return _fused_act_fun; }
  void fusedActivationFunction(FusedActFunc fused_act_fun) { _fused_act_fun = fused_act_fun; }

  Padding padding() const { return _padding; }
  void padding(Padding padding) { _padding = padding; }

  const Filter *filter(void) const { return &_filter; }
  Filter *filter(void) { return &_filter; }

  const Stride *stride(void) const { return &_stride; }
  Stride *stride(void) { return &_stride; }

private:
  FusedActFunc _fused_act_fun;
  Padding _padding;
  Stride _stride;
  Filter _filter;
};

// TODO TFLConcatenation

// TODO TFLConv2D

// TODO TFLDepthwiseConv2D

// TODO TFLDiv

/**
 * @brief MAX_POOL_2D in TensorFlow Lite
 */
class TFLMaxPool2D final : public FixedArityNode<1, TFLNodeImpl<TFLOpcode::MAX_POOL_2D>>
{
public:
  TFLMaxPool2D()
      : _fused_act_fun(FusedActFunc::UNDEFINED), _padding(Padding::UNDEFINED) { /* empty */}

public:
  loco::Node *value(void) const { return at(0)->node(); }
  void value(loco::Node *node) { at(0)->node(node); }

  FusedActFunc fusedActivationFunction() const { return _fused_act_fun; }
  void fusedActivationFunction(FusedActFunc fused_act_fun) { _fused_act_fun = fused_act_fun; }

  Padding padding() const { return _padding; }
  void padding(Padding padding) { _padding = padding; }

  const Filter *filter(void) const { return &_filter; }
  Filter *filter(void) { return &_filter; }

  const Stride *stride(void) const { return &_stride; }
  Stride *stride(void) { return &_stride; }

private:
  FusedActFunc _fused_act_fun;
  Padding _padding;
  Stride _stride;
  Filter _filter;
};

/**
 * @brief MUL in TensorFlow Lite
 */
class TFLMul final : public FixedArityNode<2, TFLNodeImpl<TFLOpcode::MUL>>
{
public:
  TFLMul() = default;

public:
  loco::Node *x(void) const { return at(0)->node(); }
  void x(loco::Node *node) { at(0)->node(node); }

  loco::Node *y(void) const { return at(1)->node(); }
  void y(loco::Node *node) { at(1)->node(node); }
};

class TFLRelu final : public FixedArityNode<1, TFLNodeImpl<TFLOpcode::RELU>>
{
public:
  TFLRelu() = default;

public:
  loco::Node *features(void) const { return at(0)->node(); }
  void features(loco::Node *node) { at(0)->node(node); }
};

// TODO TFLRelu6

// TODO TFLReshape

// TODO TFLSoftmax

// TODO TFLSqrt

// TODO TFLSub

// TODO TFLTanh

// TODO TFLTranspose

// TODO define more children of TFLNode

} // namespace locoex

#endif // __LOCOEX_IR_TFLNODES_H__