operation.hpp 16.3 KB
Newer Older
Paul's avatar
Paul committed
1
2
#ifndef MIGRAPHX_GUARD_MIGRAPHLIB_OPERAND_HPP
#define MIGRAPHX_GUARD_MIGRAPHLIB_OPERAND_HPP
Paul's avatar
Paul committed
3

Paul's avatar
Paul committed
4
#include <cassert>
Paul's avatar
Paul committed
5
6
7
8
9
#include <string>
#include <functional>
#include <memory>
#include <type_traits>
#include <utility>
Shucai Xiao's avatar
Shucai Xiao committed
10
#include <unordered_map>
Paul's avatar
Paul committed
11
12
#include <migraphx/reflect.hpp>
#include <migraphx/streamutils.hpp>
Shucai Xiao's avatar
Shucai Xiao committed
13
#include <migraphx/normalize_attributes.hpp>
Paul's avatar
Paul committed
14
#include <migraphx/argument.hpp>
Shucai Xiao's avatar
Shucai Xiao committed
15
#include <migraphx/module_ref.hpp>
16
#include <migraphx/serialize.hpp>
Paul's avatar
Paul committed
17
#include <migraphx/auto_any_cast.hpp>
Paul's avatar
Paul committed
18
#include <migraphx/config.hpp>
Paul's avatar
Paul committed
19

Paul's avatar
Paul committed
20
namespace migraphx {
Paul's avatar
Paul committed
21
inline namespace MIGRAPHX_INLINE_NS {
Paul's avatar
Paul committed
22

Paul's avatar
Paul committed
23
24
struct context;

Paul's avatar
Paul committed
25
26
27
28
29
30
31
32
#ifdef DOXYGEN

/// The operation interface represents an action an instruction will perform. All
/// operation classes must be CopyConstructible.
struct operation
{
    /// A unique name identifying the operation
    std::string name() const;
Paul's avatar
Paul committed
33
34
    /// An optional method that can be used to finalize the operator before running
    void finalize(context& ctx);
Paul's avatar
Paul committed
35
36
37
    /// This is used to compute the resulting shape from an operation. If an
    /// operation cannot be run with input shapes, then it should throw an
    /// exception.
Paul's avatar
Paul committed
38
    shape compute_shape(const std::vector<shape>& input) const;
Paul's avatar
Paul committed
39
    /**
Paul's avatar
Paul committed
40
41
     * @brief This performs the operation's computation.
     *
Paul's avatar
Paul committed
42
43
     * This method can be optional when the operation is only used as a placeholder to be lowered
     * later on.
Paul's avatar
Paul committed
44
45
46
47
48
     *
     * @param ctx This is the context created by the `target` during compilation. Implementations
     * can use the target's `context` class rather than the `context` interface class.
     * @param output This is the output shape. It is equivalent to running `compute_shape` with each
     * `shape` of the `argument`.
Paul's avatar
Paul committed
49
     * @param input This is the `argument` result from the previous instruction's computation.
Paul's avatar
Paul committed
50
51
     * @return Return an `argument` of the result computation. The `shape` of `argument` should be
     * the same the `output` shape.
Paul's avatar
Paul committed
52
     */
Paul's avatar
Paul committed
53
    argument compute(context& ctx, const shape& output, const std::vector<argument>& input) const;
Paul's avatar
Paul committed
54
55
    /// An optional method to return which argument the output will alias. If
    /// there is no aliased output then -1 can be returned.
Paul's avatar
Paul committed
56
    std::ptrdiff_t output_alias(const std::vector<shape>& input) const;
Paul's avatar
Paul committed
57
58
    /// An optional stream operator to print the operation. When this is not
    /// implemented, it will just print the operation's name.
Paul's avatar
Paul committed
59
    friend std::ostream& operator<<(std::ostream& os, const operation& op);
Paul's avatar
Paul committed
60
61
};

Paul's avatar
Paul committed
62
63
/// Returns true if operation does not require a context to run compute
bool is_context_free(const operation& x);
Shucai Xiao's avatar
Shucai Xiao committed
64
65
/// Returns true if operation needs normalization before running compute
bool need_normalization(const operation& x);
Paul's avatar
Paul committed
66
67
/// Returns true if the operation has a finalize method
bool has_finalize(const operation& x);
Paul's avatar
Paul committed
68

Paul's avatar
Paul committed
69
70
#else

71
72
73
namespace detail {

namespace operation_operators {
Paul's avatar
Paul committed
74

Paul's avatar
Paul committed
75
76
template <class T>
auto operator<<(std::ostream& os, const T& x) -> decltype(os << x.name())
Paul's avatar
Paul committed
77
{
Paul's avatar
Paul committed
78
79
    os << x.name();
    char delim = '[';
Paul's avatar
Paul committed
80
    reflect_each(x, [&](auto&& y, auto name) {
Paul's avatar
Paul committed
81
        os << delim;
Paul's avatar
Paul committed
82
83
        os << name << "=";
        stream_write_value(os, y);
Paul's avatar
Paul committed
84
85
        delim = ',';
    });
Paul's avatar
Paul committed
86
87
    if(delim == ',')
        os << "]";
Paul's avatar
Paul committed
88
    return os;
Paul's avatar
Paul committed
89
90
}

Paul's avatar
Paul committed
91
92
93
template <class T, class U>
auto operator==(const T& x, const U& y) -> decltype(x.name() == y.name())
{
Paul's avatar
Paul committed
94
95
    static_assert(is_reflectable<T>{} or sizeof(T) <= 1,
                  "Missing equality operator or reflect method.");
Paul's avatar
Paul committed
96
97
98
99
100
101
    if(x.name() != y.name())
        return false;
    const auto& yy = any_cast<T>(y);
    return reflect_tie(x) == reflect_tie(yy);
}

102
} // namespace operation_operators
Paul's avatar
Paul committed
103

Shucai Xiao's avatar
Shucai Xiao committed
104
template <class T>
Shucai Xiao's avatar
Shucai Xiao committed
105
106
auto normalize_compute_shape_op(rank<1>, const T& x, const std::vector<shape>& inputs)
    -> decltype(x.normalize_compute_shape(inputs))
Shucai Xiao's avatar
Shucai Xiao committed
107
108
109
110
111
112
{
    dependent_type<operation, T> y = x;
    normalize_attributes(y, inputs[0].lens());
    return any_cast<T>(y).normalize_compute_shape(inputs);
}

Shucai Xiao's avatar
Shucai Xiao committed
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
template <class T>
shape normalize_compute_shape_op(rank<0>, const T& x, const std::vector<shape>&)
{
    std::string name = x.name();
    MIGRAPHX_THROW("Shape not computable: " + name);
}

template <class T>
shape normalize_compute_shape_op(const T& x, const std::vector<shape>& inputs)
{
    return normalize_compute_shape_op(rank<1>{}, x, inputs);
}

template <class T>
auto compute_shape_op(rank<1>,
                      const T& x,
                      const std::vector<shape>& inputs,
                      const std::vector<module_ref>& mod_args)
    -> decltype(x.compute_shape(inputs, mod_args))
{
    return x.compute_shape(inputs, mod_args);
}

template <class T>
shape
    compute_shape_op(rank<0>, const T& x, const std::vector<shape>&, const std::vector<module_ref>&)
{
    std::string name = x.name();
    MIGRAPHX_THROW("Shape not computable: " + name);
}

template <class T>
shape compute_shape_op(const T& x,
                       const std::vector<shape>& inputs,
                       const std::vector<module_ref>& mod_args)
{
    return compute_shape_op(rank<1>{}, x, inputs, mod_args);
}

template <class T>
auto normalize_compute_shape_op(rank<1>,
                                const T& x,
                                const std::vector<shape>& inputs,
                                std::vector<module_ref>& mod_args)
    -> decltype(x.normalize_compute_shape(inputs, mod_args))
{
    return x.normalize_compute_shape(inputs, mod_args);
}

template <class T>
shape normalize_compute_shape_op(rank<0>,
                                 const T& x,
                                 const std::vector<shape>&,
                                 const std::vector<module_ref>&)
{
    std::string name = x.name();
    MIGRAPHX_THROW("Shape not computable: " + name);
}

template <class T>
shape normalize_compute_shape_op(const T& x,
                                 const std::vector<shape>& inputs,
                                 std::vector<module_ref>& mod_args)
{
    return normalize_compute_shape_op(rank<1>{}, x, inputs, mod_args);
}

Paul's avatar
Paul committed
180
template <class T>
Paul's avatar
Paul committed
181
auto compute_op(rank<2>,
Paul's avatar
Paul committed
182
183
184
185
186
                const T& x,
                context& ctx,
                const shape& output_shape,
                const std::vector<argument>& input)
    -> decltype(x.compute(auto_any_cast(ctx), output_shape, input))
Paul's avatar
Paul committed
187
188
189
190
{
    return x.compute(auto_any_cast(ctx), output_shape, input);
}

Paul's avatar
Paul committed
191
template <class T>
Paul's avatar
Paul committed
192
193
auto compute_op(
    rank<1>, const T& x, context&, const shape& output_shape, const std::vector<argument>& input)
Paul's avatar
Paul committed
194
195
196
197
198
    -> decltype(x.compute(output_shape, input))
{
    return x.compute(output_shape, input);
}

Paul's avatar
Paul committed
199
template <class T>
Paul's avatar
Paul committed
200
argument compute_op(rank<0>, const T& x, context&, const shape&, const std::vector<argument>&)
Paul's avatar
Paul committed
201
{
Paul's avatar
Paul committed
202
    std::string name = x.name();
Paul's avatar
Paul committed
203
    MIGRAPHX_THROW("Not computable: " + name);
Paul's avatar
Paul committed
204
205
}

Paul's avatar
Paul committed
206
template <class T>
Paul's avatar
Paul committed
207
208
argument
compute_op(const T& x, context& ctx, const shape& output_shape, const std::vector<argument>& input)
Paul's avatar
Paul committed
209
{
Paul's avatar
Paul committed
210
211
212
213
    return compute_op(rank<2>{}, x, ctx, output_shape, input);
}

template <class T>
Paul's avatar
Paul committed
214
auto compute_op(rank<2>, const T& x, const shape& output_shape, const std::vector<argument>& input)
Paul's avatar
Paul committed
215
216
217
218
219
220
    -> decltype(x.compute(output_shape, input))
{
    return x.compute(output_shape, input);
}

template <class T>
Paul's avatar
Paul committed
221
auto compute_op(rank<1>, const T& x, const shape& output_shape, const std::vector<argument>& input)
Paul's avatar
Paul committed
222
223
224
225
226
227
228
229
230
231
232
233
234
235
    -> decltype(x.compute(auto_any_cast(std::declval<context&>()), output_shape, input))
{
    std::string name = x.name();
    MIGRAPHX_THROW("Not computable without a context: " + name);
}

template <class T>
argument compute_op(rank<0>, const T& x, const shape&, const std::vector<argument>&)
{
    std::string name = x.name();
    MIGRAPHX_THROW("Not computable: " + name);
}

template <class T>
Paul's avatar
Paul committed
236
argument compute_op(const T& x, const shape& output_shape, const std::vector<argument>& input)
Paul's avatar
Paul committed
237
238
239
240
{
    return compute_op(rank<2>{}, x, output_shape, input);
}

Shucai Xiao's avatar
Shucai Xiao committed
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
template <class T, class F>
auto compute_op(rank<1>,
                const T& x,
                const std::vector<argument>& inputs,
                const std::vector<module_ref>& module_args,
                F f) -> decltype(x.compute(inputs, module_args, f))
{
    return x.compute(inputs, module_args, f);
}

template <class T, class F>
argument
    compute_op(rank<0>, const T& x, const std::vector<argument>&, const std::vector<module_ref>&, F)
{
    std::string name = x.name();
    MIGRAPHX_THROW("Not computable: " + name);
}

template <class T, class F>
argument compute_op(const T& x,
                    const std::vector<argument>& inputs,
                    const std::vector<module_ref>& module_args,
                    F f)
{
    return compute_op(rank<1>{}, x, inputs, module_args, f);
}

Paul's avatar
Paul committed
268
template <class T>
Paul's avatar
Paul committed
269
270
271
272
273
auto is_context_free_op(rank<1>,
                        const T& x,
                        const shape& output_shape,
                        const std::vector<argument>& input)
    -> decltype(x.compute(output_shape, input), std::true_type{});
Paul's avatar
Paul committed
274
275

template <class T>
Paul's avatar
Paul committed
276
277
auto is_context_free_op(rank<0>, const T&, const shape&, const std::vector<argument>&)
    -> std::false_type;
Paul's avatar
Paul committed
278
279

template <class T>
Paul's avatar
Paul committed
280
281
auto is_context_free_op(const T& x) -> decltype(is_context_free_op(
    rank<1>{}, x, std::declval<const shape&>(), std::declval<std::vector<argument>>()))
Paul's avatar
Paul committed
282
283
{
    return {};
Paul's avatar
Paul committed
284
285
}

Shucai Xiao's avatar
Shucai Xiao committed
286
287
288
289
290
291
292
293
294
295
296
297
298
299
template <class T>
auto need_normalization_op(rank<1>, const T& x, const std::vector<shape>& inputs)
    -> decltype(x.normalize_compute_shape(inputs), std::true_type{});

template <class T>
auto need_normalization_op(rank<0>, const T&, const std::vector<shape>&) -> std::false_type;

template <class T>
auto need_normalization_op(const T& x)
    -> decltype(need_normalization_op(rank<1>{}, x, std::declval<std::vector<shape>>()))
{
    return {};
}

Paul's avatar
Paul committed
300
template <class T>
301
std::ptrdiff_t output_alias_op(const T&, const std::vector<shape>&)
Paul's avatar
Paul committed
302
303
304
305
{
    return -1;
}

Paul's avatar
Paul committed
306
template <class T>
Paul's avatar
Paul committed
307
308
auto finalize_op(
    rank<1>, T& x, context& ctx, const shape& output_shape, const std::vector<shape>& input)
Paul's avatar
Paul committed
309
310
311
312
313
314
315
    -> decltype(x.finalize(auto_any_cast(ctx), output_shape, input), void())
{
    x.finalize(auto_any_cast(ctx), output_shape, input);
}

template <class T>
void finalize_op(rank<0>, T&, context&, const shape&, const std::vector<shape>&)
Paul's avatar
Paul committed
316
317
{
}
Paul's avatar
Paul committed
318
319
320
321
322
323
324
325

template <class T>
void finalize_op(T& x, context& ctx, const shape& output_shape, const std::vector<shape>& input)
{
    finalize_op(rank<1>{}, x, ctx, output_shape, input);
}

template <class T>
Paul's avatar
Paul committed
326
327
auto has_finalize_op(
    rank<1>, T& x, context& ctx, const shape& output_shape, const std::vector<shape>& input)
Paul's avatar
Paul committed
328
329
330
331
332
333
334
    -> decltype(x.finalize(auto_any_cast(ctx), output_shape, input), std::true_type{});

template <class T>
auto has_finalize_op(rank<0>, T&, context&, const shape&, const std::vector<shape>&)
    -> std::false_type;

template <class T>
Paul's avatar
Paul committed
335
336
337
338
339
auto has_finalize_op(const T&) -> decltype(has_finalize_op(rank<1>{},
                                                           std::declval<T&>(),
                                                           std::declval<context&>(),
                                                           std::declval<const shape&>(),
                                                           std::declval<std::vector<shape>>()))
Paul's avatar
Paul committed
340
341
342
343
{
    return {};
}

344
345
346
347
348
349
template <class T>
value attributes_op(const T&)
{
    return value::object{};
}

350
351
352
353
354
355
356
357
358
template <class T>
value to_value_op(const T& x)
{
    return migraphx::to_value(x);
}

template <class T>
void from_value_op(T& x, const value& v)
{
359
360
    if(not(v.is_object() or (v.empty() and v.is_array())))
        MIGRAPHX_THROW("Value is not an object");
361
362
363
    return migraphx::from_value(v, x);
}

364
365
} // namespace detail

366
<%
Paul's avatar
Paul committed
367
368
369
 interface(
     'operation',
     virtual('name', returns = 'std::string', const = True),
Paul's avatar
Paul committed
370
371
     virtual(
         'is_context_free', returns = 'bool', const = True, default = 'detail::is_context_free_op'),
Shucai Xiao's avatar
Shucai Xiao committed
372
373
374
375
     virtual('need_normalization',
             returns = 'bool',
             const   = True,
             default = 'detail::need_normalization_op'),
376
     virtual('has_finalize', returns = 'bool', const = True, default = 'detail::has_finalize_op'),
Paul's avatar
Paul committed
377
     virtual('output_alias',
Paul's avatar
Paul committed
378
             returns = 'std::ptrdiff_t',
Paul's avatar
Paul committed
379
380
             input   = 'const std::vector<shape>&',
             const   = True,
381
             default = 'detail::output_alias_op'),
Paul's avatar
Paul committed
382
383
384
385
     virtual('finalize',
             ctx     = 'context&',
             output  = 'const shape&',
             input   = 'const std::vector<shape>&',
386
             default = 'detail::finalize_op'),
Shucai Xiao's avatar
Shucai Xiao committed
387
388
389
390
391
     virtual('compute_shape',
             returns = 'shape',
             input   = 'const std::vector<shape>&',
             const   = True,
             default = 'detail::normalize_compute_shape_op'),
Shucai Xiao's avatar
Shucai Xiao committed
392
393
394
395
396
397
     virtual('compute_shape',
             returns  = 'shape',
             inputs   = 'const std::vector<shape>&',
             mod_args = 'const std::vector<module_ref>&',
             const    = True,
             default  = 'detail::compute_shape_op'),
Paul's avatar
Paul committed
398
399
400
401
402
403
     virtual('compute',
             returns = 'argument',
             ctx     = 'context&',
             output  = 'const shape&',
             input   = 'const std::vector<argument>&',
             const   = True,
404
             default = 'detail::compute_op'),
Paul's avatar
Paul committed
405
406
407
408
409
     virtual('compute',
             returns = 'argument',
             output  = 'const shape&',
             input   = 'const std::vector<argument>&',
             const   = True,
410
             default = 'detail::compute_op'),
Shucai Xiao's avatar
Shucai Xiao committed
411
412
413
414
415
416
417
418
419
     virtual(
         'compute',
         returns     = 'argument',
         input       = 'const std::vector<argument>&',
         module_args = 'const std::vector<module_ref>&',
         run =
             'std::function<std::vector<argument>(module_ref& mdl, const std::unordered_map<std::string, argument>& inputs)>',
         const   = True,
         default = 'detail::compute_op'),
420
421
     virtual('to_value', returns = 'value', const = True, default = 'detail::to_value_op'),
     virtual('from_value', v = 'const value&', default = 'detail::from_value_op'),
422
     virtual('attributes', returns = 'value', const = True, default = 'detail::attributes_op'),
Paul's avatar
Paul committed
423
424
425
426
     friend('operator<<',
            returns = 'std::ostream &',
            os      = 'std::ostream &',
            op      = 'const operation &',
427
            using   = 'migraphx::detail::operation_operators::operator<<'),
Paul's avatar
Paul committed
428
429
430
431
     friend('operator==',
            returns = 'bool',
            x       = 'const operation &',
            y       = 'const operation &',
432
            using   = 'migraphx::detail::operation_operators::operator==')) %>
Paul's avatar
Paul committed
433
434

    inline bool operator!=(const operation& x, const operation& y)
Paul's avatar
Paul committed
435
436
437
438
{
    return !(x == y);
}

439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
inline shape compute_shape(const operation& op, const std::vector<shape>& inputs)
{
    return op.compute_shape(inputs);
}

template <class T>
inline auto compute_shape(const T& op, const std::vector<shape>& inputs)
    -> decltype(op.compute_shape(inputs))
{
    return op.compute_shape(inputs);
}

template <class T>
inline auto compute_shape(const T& op, const std::vector<shape>& inputs)
    -> decltype(op.normalize_compute_shape(inputs))
{
    return detail::normalize_compute_shape_op(op, inputs);
}

Shucai Xiao's avatar
Shucai Xiao committed
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
inline shape compute_shape(const operation& op,
                           const std::vector<shape>& inputs,
                           const std::vector<module_ref>& mod_args)
{
    return op.compute_shape(inputs, mod_args);
}

template <class T>
inline auto compute_shape(const T& op,
                          const std::vector<shape>& inputs,
                          const std::vector<module_ref>& mod_args)
    -> decltype(op.compute_shape(inputs, mod_args))
{
    return op.compute_shape(inputs, mod_args);
}

template <class T>
inline auto compute_shape(const T& op,
                          const std::vector<shape>& inputs,
                          const std::vector<module_ref>& mod_args)
    -> decltype(op.normalize_compute_shape(inputs, mod_args))
{
    return detail::normalize_compute_shape_op(op, inputs, mod_args);
}

Paul's avatar
Paul committed
483
inline bool is_context_free(const operation& op) { return op.is_context_free(); }
Paul's avatar
Paul committed
484

Paul's avatar
Paul committed
485
template <class T>
Paul's avatar
Paul committed
486
487
bool is_context_free(const T& x)
{
488
    return detail::is_context_free_op(x);
Paul's avatar
Paul committed
489
490
}

Shucai Xiao's avatar
Shucai Xiao committed
491
492
493
494
495
496
497
498
inline bool need_normalization(const operation& op) { return op.need_normalization(); }

template <class T>
bool need_normalization(const T& x)
{
    return detail::need_normalization_op(x);
}

Paul's avatar
Paul committed
499
500
501
502
503
inline bool has_finalize(const operation& op) { return op.has_finalize(); }

template <class T>
bool has_finalize(const T& x)
{
504
    return detail::has_finalize_op(x);
Paul's avatar
Paul committed
505
506
}

507
508
509
void migraphx_to_value(value& v, const operation& op);
void migraphx_from_value(const value& v, operation& op);

Paul's avatar
Paul committed
510
511
#endif

Paul's avatar
Paul committed
512
} // namespace MIGRAPHX_INLINE_NS
Paul's avatar
Paul committed
513
} // namespace migraphx
Paul's avatar
Paul committed
514
515

#endif