text: /*******************************************************************************
  * Copyright 2016-2020 Intel Corporation
  *
  * 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 INNER_PRODUCT_PD_HPP
  #define INNER_PRODUCT_PD_HPP
  
  #include "dnnl.h"
  
  #include "c_types_map.hpp"
  #include "primitive_desc.hpp"
  #include "utils.hpp"
  
  namespace dnnl {
  namespace impl {
  
  struct inner_product_fwd_pd_t;
  
  struct inner_product_pd_t : public primitive_desc_t {
      static constexpr auto base_pkind = primitive_kind::inner_product;
  
      inner_product_pd_t(const inner_product_desc_t *adesc,
              const primitive_attr_t *attr,
              const inner_product_fwd_pd_t *hint_fwd_pd)
          : primitive_desc_t(attr, base_pkind)
          , desc_(*adesc)
          , hint_fwd_pd_(hint_fwd_pd) {}
  
      const inner_product_desc_t *desc() const { return &desc_; }
      virtual const op_desc_t *op_desc() const override {
          return reinterpret_cast<const op_desc_t *>(this->desc());
      }
  
      virtual status_t query(query_t what, int idx, void *result) const override {
          switch (what) {
              case query::prop_kind:
                  *(prop_kind_t *)result = desc()->prop_kind;
                  break;
              case query::inner_product_d:
                  *(const inner_product_desc_t **)result = desc();
                  break;
              default: return primitive_desc_t::query(what, idx, result);
          }
          return status::success;
      }
  
      /* common inner_product aux functions */
  
      dim_t MB() const { return invariant_src_md()->dims[0]; }
      dim_t IC() const { return invariant_src_md()->dims[1]; }
      dim_t OC() const { return invariant_dst_md()->dims[1]; }
  
      dim_t ID() const {
          return ndims() >= 5 ? invariant_src_md()->dims[ndims() - 3] : 1;
      }
      dim_t IH() const {
          return ndims() >= 4 ? invariant_src_md()->dims[ndims() - 2] : 1;
      }
      dim_t IW() const {
          return ndims() >= 3 ? invariant_src_md()->dims[ndims() - 1] : 1;
      }
  
      dim_t OD() const {
          return ndims() >= 5 ? invariant_dst_md()->dims[ndims() - 3] : 1;
      }
      dim_t OH() const {
          return ndims() >= 4 ? invariant_dst_md()->dims[ndims() - 2] : 1;
      }
      dim_t OW() const {
          return ndims() >= 3 ? invariant_dst_md()->dims[ndims() - 1] : 1;
      }
  
      dim_t KD() const {
          return ndims() >= 5 ? invariant_wei_md()->dims[ndims() - 3] : 1;
      }
      dim_t KH() const {
          return ndims() >= 4 ? invariant_wei_md()->dims[ndims() - 2] : 1;
      }
      dim_t KW() const {
          return ndims() >= 3 ? invariant_wei_md()->dims[ndims() - 1] : 1;
      }
  
      dim_t IC_total() const {
          return utils::array_product(&invariant_src_md()->dims[1], ndims() - 1);
      }
  
      dim_t IC_total_padded() const {
          auto src_d = desc()->prop_kind == prop_kind::backward_data
                  ? memory_desc_wrapper(diff_src_md())
                  : memory_desc_wrapper(src_md());
          assert(src_d.is_blocking_desc());
          if (!src_d.is_blocking_desc()) return -1;
          return utils::array_product(src_d.padded_dims() + 1, ndims() - 1);
      }
  
      int ndims() const { return invariant_src_md()->ndims; }
  
      bool with_bias() const {
          auto *bia_d = desc()->prop_kind == prop_kind::backward_weights
                  ? &desc()->diff_bias_desc
                  : &desc()->bias_desc;
          return !memory_desc_wrapper(bia_d).is_zero();
      }
  
      bool has_zero_dim_memory() const {
          const auto s_d = memory_desc_wrapper(*invariant_src_md());
          const auto d_d = memory_desc_wrapper(*invariant_dst_md());
          return s_d.has_zero_dim() || d_d.has_zero_dim();
      }
  
      bool is_fwd() const {
          return utils::one_of(desc_.prop_kind, prop_kind::forward_training,
                  prop_kind::forward_inference);
      }
  
      virtual const memory_desc_t *invariant_src_md() const {
          return desc()->prop_kind == prop_kind::backward_data ? diff_src_md()
                                                               : src_md();
      }
  
      virtual const memory_desc_t *invariant_wei_md(int index = 0) const {
          return desc()->prop_kind == prop_kind::backward_weights
                  ? diff_weights_md(index)
                  : weights_md(index);
      }
  
      virtual const memory_desc_t *invariant_bia_md() const {
          return invariant_wei_md(1);
      }
  
      virtual const memory_desc_t *invariant_dst_md() const {
          return is_fwd() ? dst_md() : diff_dst_md();
      }
  
  protected:
      inner_product_desc_t desc_;
      const inner_product_fwd_pd_t *hint_fwd_pd_;
  
      bool expect_data_types(data_type_t src_dt, data_type_t wei_dt,
              data_type_t bia_dt, data_type_t dst_dt, data_type_t acc_dt) const {
          bool ok = true
                  && (src_dt == data_type::undef
                          || invariant_src_md()->data_type == src_dt)
                  && (wei_dt == data_type::undef
                          || invariant_wei_md()->data_type == wei_dt)
                  && (dst_dt == data_type::undef
                          || invariant_dst_md()->data_type == dst_dt)
                  && (acc_dt == data_type::undef
                          || desc_.accum_data_type == acc_dt);
          if (with_bias() && bia_dt != data_type::undef)
              ok = ok && invariant_bia_md()->data_type == bia_dt;
          return ok;
      }
  };
  
  struct inner_product_fwd_pd_t : public inner_product_pd_t {
      typedef inner_product_fwd_pd_t base_class;
      typedef inner_product_fwd_pd_t hint_class;
  
      inner_product_fwd_pd_t(const inner_product_desc_t *adesc,
              const primitive_attr_t *attr,
              const inner_product_fwd_pd_t *hint_fwd_pd)
          : inner_product_pd_t(adesc, attr, hint_fwd_pd)
          , src_md_(desc_.src_desc)
          , weights_md_(desc_.weights_desc)
          , bias_md_(desc_.bias_desc)
          , dst_md_(desc_.dst_desc) {}
  
      virtual arg_usage_t arg_usage(int arg) const override {
          if (utils::one_of(arg, DNNL_ARG_SRC, DNNL_ARG_WEIGHTS))
              return arg_usage_t::input;
  
          if (arg == DNNL_ARG_BIAS && with_bias()) return arg_usage_t::input;
  
          if (arg == DNNL_ARG_DST) return arg_usage_t::output;
  
          return primitive_desc_t::arg_usage(arg);
      }
  
      virtual const memory_desc_t *arg_md(int arg) const override {
          switch (arg) {
              case DNNL_ARG_SRC: return src_md(0);
              case DNNL_ARG_WEIGHTS: return weights_md(0);
              case DNNL_ARG_BIAS: return weights_md(1);
              case DNNL_ARG_DST: return dst_md(0);
              default: return inner_product_pd_t::arg_md(arg);
          }
      }
  
      virtual const memory_desc_t *src_md(int index = 0) const override {
          return index == 0 ? &src_md_ : &glob_zero_md;
      }
      virtual const memory_desc_t *dst_md(int index = 0) const override {
          return index == 0 ? &dst_md_ : &glob_zero_md;
      }
      virtual const memory_desc_t *weights_md(int index = 0) const override {
          if (index == 0) return &weights_md_;
          if (index == 1 && with_bias()) return &bias_md_;
          return &glob_zero_md;
      }
  
      virtual int n_inputs() const override { return 2 + with_bias(); }
      virtual int n_outputs() const override { return 1; }
  
  protected:
      memory_desc_t src_md_;
      memory_desc_t weights_md_;
      memory_desc_t bias_md_;
      memory_desc_t dst_md_;
  };
  
  struct inner_product_bwd_data_pd_t : public inner_product_pd_t {
      typedef inner_product_bwd_data_pd_t base_class;
      typedef inner_product_fwd_pd_t hint_class;
  
      inner_product_bwd_data_pd_t(const inner_product_desc_t *adesc,
              const primitive_attr_t *attr,
              const inner_product_fwd_pd_t *hint_fwd_pd)
          : inner_product_pd_t(adesc, attr, hint_fwd_pd)
          , diff_src_md_(desc_.diff_src_desc)
          , weights_md_(desc_.weights_desc)
          , diff_dst_md_(desc_.diff_dst_desc) {}
  
      virtual arg_usage_t arg_usage(int arg) const override {
          if (utils::one_of(arg, DNNL_ARG_WEIGHTS, DNNL_ARG_DIFF_DST))
              return arg_usage_t::input;
  
          if (arg == DNNL_ARG_DIFF_SRC) return arg_usage_t::output;
  
          return primitive_desc_t::arg_usage(arg);
      }
  
      virtual const memory_desc_t *arg_md(int arg) const override {
          switch (arg) {
              case DNNL_ARG_DIFF_SRC: return diff_src_md(0);
              case DNNL_ARG_WEIGHTS: return weights_md(0);
              case DNNL_ARG_DIFF_DST: return diff_dst_md(0);
              default: return inner_product_pd_t::arg_md(arg);
          }
      }
  
      virtual const memory_desc_t *diff_src_md(int index = 0) const override {
          return index == 0 ? &diff_src_md_ : &glob_zero_md;
      }
      virtual const memory_desc_t *diff_dst_md(int index = 0) const override {
          return index == 0 ? &diff_dst_md_ : &glob_zero_md;
      }
      virtual const memory_desc_t *weights_md(int index = 0) const override {
          return index == 0 ? &weights_md_ : &glob_zero_md;
      }
  
      virtual int n_inputs() const override { return 2; }
      virtual int n_outputs() const override { return 1; }
  
  protected:
      memory_desc_t diff_src_md_;
      memory_desc_t weights_md_;
      memory_desc_t diff_dst_md_;
  };
  
  struct inner_product_bwd_weights_pd_t : public inner_product_pd_t {
      typedef inner_product_bwd_weights_pd_t base_class;
      typedef inner_product_fwd_pd_t hint_class;
  
      inner_product_bwd_weights_pd_t(const inner_product_desc_t *adesc,
              const primitive_attr_t *attr,
              const inner_product_fwd_pd_t *hint_fwd_pd)
          : inner_product_pd_t(adesc, attr, hint_fwd_pd)
          , src_md_(desc_.src_desc)
          , diff_weights_md_(desc_.diff_weights_desc)
          , diff_bias_md_(desc_.diff_bias_desc)
          , diff_dst_md_(desc_.diff_dst_desc) {}
  
      virtual arg_usage_t arg_usage(int arg) const override {
          if (utils::one_of(arg, DNNL_ARG_SRC, DNNL_ARG_DIFF_DST))
              return arg_usage_t::input;
  
          if (arg == DNNL_ARG_DIFF_WEIGHTS) return arg_usage_t::output;
  
          if (arg == DNNL_ARG_DIFF_BIAS && with_bias())
              return arg_usage_t::output;
  
          return primitive_desc_t::arg_usage(arg);
      }
  
      virtual const memory_desc_t *arg_md(int arg) const override {
          switch (arg) {
              case DNNL_ARG_SRC: return src_md(0);
              case DNNL_ARG_DIFF_WEIGHTS: return diff_weights_md(0);
              case DNNL_ARG_DIFF_BIAS: return diff_weights_md(1);
              case DNNL_ARG_DIFF_DST: return diff_dst_md(0);
              default: return inner_product_pd_t::arg_md(arg);
          }
      }
  
      virtual const memory_desc_t *src_md(int index = 0) const override {
          return index == 0 ? &src_md_ : &glob_zero_md;
      }
      virtual const memory_desc_t *diff_dst_md(int index = 0) const override {
          return index == 0 ? &diff_dst_md_ : &glob_zero_md;
      }
      virtual const memory_desc_t *diff_weights_md(int index = 0) const override {
          if (index == 0) return &diff_weights_md_;
          if (index == 1 && with_bias()) return &diff_bias_md_;
          return &glob_zero_md;
      }
  
      virtual int n_inputs() const override { return 2; }
      virtual int n_outputs() const override { return 1 + with_bias(); }
  
  protected:
      memory_desc_t src_md_;
      memory_desc_t diff_weights_md_;
      memory_desc_t diff_bias_md_;
      memory_desc_t diff_dst_md_;
  };
  
  } // namespace impl
  } // namespace dnnl
  
  #endif
  
  // vim: et ts=4 sw=4 cindent cino+=l0,\:4,N-s
  