#ifndef MIGRAPHX_GUARD_MIGRAPHLIB_OPERAND_HPP #define MIGRAPHX_GUARD_MIGRAPHLIB_OPERAND_HPP #include #include #include #include #include #include #include #include #include #include #include #include #include namespace migraphx { inline namespace MIGRAPHX_INLINE_NS { #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; /// An optional method that can be used to finalize the operator before running void finalize(context& ctx); /// 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. shape compute_shape(const std::vector& input) const; /** * @brief This performs the operation's computation. * * This method can be optional when the operation is only used as a placeholder to be lowered * later on. * * @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`. * @param input This is the `argument` result from the previous instruction's computation. * @return Return an `argument` of the result computation. The `shape` of `argument` should be * the same the `output` shape. */ argument compute(context& ctx, const shape& output, const std::vector& input) const; /// An optional method to return which argument the output will alias. If /// there is no aliased output then -1 can be returned. int output_alias(const std::vector& input) const; /// An optional stream operator to print the operation. When this is not /// implemented, it will just print the operation's name. friend std::ostream& operator<<(std::ostream& os, const operation& op); }; /// Returns true if operation does not require a context to run compute bool is_context_free(const operation& x); /// Returns true if the operation has a finalize method bool has_finalize(const operation& x); #else namespace operation_stream { template auto operator<<(std::ostream& os, const T& x) -> decltype(os << x.name()) { os << x.name(); char delim = '['; reflect_each(x, [&](auto& y, auto name) { os << delim; os << name << "="; stream_write_value(os, y); delim = ','; }); if(delim == ',') os << "]"; return os; } } // namespace operation_stream namespace operation_equal { template auto operator==(const T& x, const U& y) -> decltype(x.name() == y.name()) { if(x.name() != y.name()) return false; const auto& yy = any_cast(y); return reflect_tie(x) == reflect_tie(yy); } } // namespace operation_equal template auto compute_op(rank<2>, const T& x, context& ctx, const shape& output_shape, const std::vector& input) -> decltype(x.compute(auto_any_cast(ctx), output_shape, input)) { return x.compute(auto_any_cast(ctx), output_shape, input); } template auto compute_op( rank<1>, const T& x, context&, const shape& output_shape, const std::vector& input) -> decltype(x.compute(output_shape, input)) { return x.compute(output_shape, input); } template argument compute_op(rank<0>, const T& x, context&, const shape&, const std::vector&) { std::string name = x.name(); MIGRAPHX_THROW("Not computable: " + name); } template argument compute_op(const T& x, context& ctx, const shape& output_shape, const std::vector& input) { return compute_op(rank<2>{}, x, ctx, output_shape, input); } template auto compute_op(rank<2>, const T& x, const shape& output_shape, const std::vector& input) -> decltype(x.compute(output_shape, input)) { return x.compute(output_shape, input); } template auto compute_op(rank<1>, const T& x, const shape& output_shape, const std::vector& input) -> decltype(x.compute(auto_any_cast(std::declval()), output_shape, input)) { std::string name = x.name(); MIGRAPHX_THROW("Not computable without a context: " + name); } template argument compute_op(rank<0>, const T& x, const shape&, const std::vector&) { std::string name = x.name(); MIGRAPHX_THROW("Not computable: " + name); } template argument compute_op(const T& x, const shape& output_shape, const std::vector& input) { return compute_op(rank<2>{}, x, output_shape, input); } template auto is_context_free_op(rank<1>, const T& x, const shape& output_shape, const std::vector& input) -> decltype(x.compute(output_shape, input), std::true_type{}); template auto is_context_free_op(rank<0>, const T&, const shape&, const std::vector&) -> std::false_type; template auto is_context_free_op(const T& x) -> decltype(is_context_free_op( rank<1>{}, x, std::declval(), std::declval>())) { return {}; } template int output_alias_op(rank<0>, const T&, const std::vector&) { return -1; } template auto output_alias_op(rank<1>, const T& x, const std::vector& shapes) -> decltype(x.output_alias(shapes)) { return x.output_alias(shapes); } template int output_alias_op(const T& x, const std::vector& shapes) { return output_alias_op(rank<1>{}, x, shapes); } template auto finalize_op( rank<1>, T& x, context& ctx, const shape& output_shape, const std::vector& input) -> decltype(x.finalize(auto_any_cast(ctx), output_shape, input), void()) { x.finalize(auto_any_cast(ctx), output_shape, input); } template void finalize_op(rank<0>, T&, context&, const shape&, const std::vector&) { } template void finalize_op(T& x, context& ctx, const shape& output_shape, const std::vector& input) { finalize_op(rank<1>{}, x, ctx, output_shape, input); } template auto has_finalize_op( rank<1>, T& x, context& ctx, const shape& output_shape, const std::vector& input) -> decltype(x.finalize(auto_any_cast(ctx), output_shape, input), std::true_type{}); template auto has_finalize_op(rank<0>, T&, context&, const shape&, const std::vector&) -> std::false_type; template auto has_finalize_op(const T&) -> decltype(has_finalize_op(rank<1>{}, std::declval(), std::declval(), std::declval(), std::declval>())) { return {}; } <% interface( 'operation', virtual('name', returns = 'std::string', const = True), virtual('is_context_free', returns = 'bool', const = True, default = 'is_context_free_op'), virtual('has_finalize', returns = 'bool', const = True, default = 'has_finalize_op'), virtual('output_alias', returns = 'int', input = 'const std::vector&', const = True, default = 'output_alias_op'), virtual('finalize', ctx = 'context&', output = 'const shape&', input = 'const std::vector&', default = 'finalize_op'), virtual('compute_shape', returns = 'shape', input = 'const std::vector&', const = True), virtual('compute', returns = 'argument', ctx = 'context&', output = 'const shape&', input = 'const std::vector&', const = True, default = 'compute_op'), virtual('compute', returns = 'argument', output = 'const shape&', input = 'const std::vector&', const = True, default = 'compute_op'), friend('operator<<', returns = 'std::ostream &', os = 'std::ostream &', op = 'const operation &', using = 'migraphx::operation_stream::operator<<'), friend('operator==', returns = 'bool', x = 'const operation &', y = 'const operation &', using = 'migraphx::operation_equal::operator==')) %> inline bool operator!=(const operation& x, const operation& y) { return !(x == y); } inline bool is_context_free(const operation& op) { return op.is_context_free(); } template bool is_context_free(const T& x) { return is_context_free_op(x); } inline bool has_finalize(const operation& op) { return op.has_finalize(); } template bool has_finalize(const T& x) { return has_finalize_op(x); } #endif } // namespace MIGRAPHX_INLINE_NS } // namespace migraphx #endif