text: /*******************************************************************************
  * Copyright 2019-2021 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.
  *******************************************************************************/
  
  #include <cstring>
  #include <memory>
  #include <tuple>
  
  #include "dnnl_test_common.hpp"
  #include "gtest/gtest.h"
  
  #include "oneapi/dnnl/dnnl.hpp"
  
  namespace dnnl {
  
  using data_t = float;
  
  struct params_t {
      memory::dims dims;
      memory::format_tag fmt_tag;
      dnnl_status_t expected_status;
  };
  
  using params_w_engine_t = std::tuple<dnnl::engine::kind, params_t>;
  
  class memory_creation_test_t
      : public ::testing::TestWithParam<params_w_engine_t> {
  protected:
      void SetUp() override {
          params_w_engine_t pwe
                  = ::testing::TestWithParam<decltype(pwe)>::GetParam();
  
          auto engine_kind = std::get<0>(pwe);
          if (dnnl::engine::get_count(engine_kind) == 0) return;
  
          eng = dnnl::engine(engine_kind, 0);
          p = std::get<1>(pwe);
      }
  
      void Test() {
          dnnl::memory::desc md(p.dims, memory::data_type::f32, p.fmt_tag);
          dnnl::memory::dim phys_size = md.get_size() / sizeof(data_t);
  
  #ifdef DNNL_SYCL_CUDA
          const dnnl::impl::memory_desc_wrapper mdw(md.data);
          SKIP_IF(!mdw.is_plain() && !mdw.format_any(),
                  "Non-plain formats are not supported on CUDA backend");
  #endif
  
          // mem0
          // Initially spoiled by putting non-zero values in padded area.
          auto mem0 = test::make_memory(md, eng);
  
          // `runtime`-aware buffer for future mem1
          auto mem1_placeholder = test::make_memory(md, eng);
  
          // Map-unmap section
          {
              // Put non-zeros even to the padded area
              auto mem0_ptr = map_memory<data_t>(mem0);
              if (phys_size) GTEST_EXPECT_NE(mem0_ptr, nullptr);
              fill_data<data_t>(phys_size, mem0_ptr);
  
              // mem1_placeholder = copy(mem0)
              auto mem1_ph_ptr = map_memory<data_t>(mem1_placeholder);
              if (phys_size) GTEST_EXPECT_NE(mem1_ph_ptr, nullptr);
              for (dnnl::memory::dim i = 0; i < phys_size; ++i)
                  mem1_ph_ptr[i] = mem0_ptr[i];
          }
  
          auto mem1 = test::make_memory(md, eng, nullptr);
          mem1.set_data_handle(mem1_placeholder.get_data_handle());
  
          // Map-unmap section
          {
              auto mem0_ptr = map_memory<data_t>(mem0);
              if (phys_size) GTEST_EXPECT_NE(mem0_ptr, nullptr);
              auto mem1_ptr = map_memory<data_t>(mem1);
              if (phys_size) GTEST_EXPECT_NE(mem1_ptr, nullptr);
  
              // Check if mem0 == mem1
              for (dnnl::memory::dim i = 0; i < phys_size; ++i)
                  ASSERT_EQ(mem0_ptr[i], mem1_ptr[i]) << i;
          }
      }
  
      dnnl::engine eng;
      params_t p;
  };
  
  TEST_P(memory_creation_test_t, TestsMemoryCreation) {
      SKIP_IF(eng.get(true) == nullptr, "Engine is not supported");
      catch_expected_failures([=]() { Test(); },
              p.expected_status != dnnl_success, p.expected_status);
  }
  
  namespace {
  auto all_engine_kinds
          = ::testing::Values(dnnl::engine::kind::cpu, dnnl::engine::kind::gpu);
  
  using fmt = dnnl::memory::format_tag;
  
  auto cases_expect_to_fail = ::testing::Values(
          params_t {{2, 2, -1, 1}, fmt::nchw, dnnl_invalid_arguments},
          params_t {{1, 2, 3, 4}, fmt::any, dnnl_invalid_arguments});
  
  auto cases_zero_dim = ::testing::Values(params_t {{2, 0, 1, 1}, fmt::nChw16c},
          params_t {{0, 1, 0, 1}, fmt::nhwc}, params_t {{2, 1, 0, 1}, fmt::nchw});
  
  auto cases_generic = ::testing::Values(params_t {{2, 15, 3, 2}, fmt::nChw16c},
          params_t {{2, 15, 3, 2, 4}, fmt::nCdhw8c},
          params_t {{2, 9, 3}, fmt::OIw8o4i},
          params_t {{2, 9, 3, 2}, fmt::OIhw8o4i},
          params_t {{2, 9, 3, 2}, fmt::OIhw8o8i},
          params_t {{2, 9, 3, 2}, fmt::OIhw8i16o2i},
          params_t {{2, 9, 3, 2}, fmt::OIhw8o16i2o},
          params_t {{2, 9, 3, 2}, fmt::OIhw16o16i},
          params_t {{2, 9, 3, 2}, fmt::OIhw16i16o},
          params_t {{2, 9, 3, 2}, fmt::OIhw4i16o4i},
          params_t {{2, 9, 3, 2}, fmt::OIhw2i8o4i},
          params_t {{2, 9, 3, 2, 4}, fmt::OIdhw8o4i},
          params_t {{2, 17, 9, 2}, fmt::gOIw8o4i},
          params_t {{2, 9, 3}, fmt::OwI16o4i},
          params_t {{2, 9, 3, 2}, fmt::OhwI16o4i},
          params_t {{2, 15, 9, 3, 2}, fmt::OdhwI16o4i},
          params_t {{2, 15, 9, 3}, fmt::gOwI16o4i},
          params_t {{2, 15, 9, 3, 2}, fmt::gOhwI16o4i},
          params_t {{3, 18, 9, 3, 2, 3}, fmt::gOdhwI16o4i},
          params_t {{3, 18, 9, 3, 2, 3}, fmt::gOIdhw4i16o4i},
          params_t {{2, 18, 8, 4, 2, 3}, fmt::gOIdhw2i8o4i},
          params_t {{1, 2, 9, 3, 3, 2}, fmt::gOIdhw4o4i},
          params_t {{2, 9, 3, 2}, fmt::OIhw16i16o4i},
          params_t {{2, 9, 3, 2}, fmt::OIhw16i16o2i},
          params_t {{2, 9, 3, 2}, fmt::OIhw16o16i2o},
          params_t {{2, 9, 4, 3, 2}, fmt::OIdhw16i16o4i},
          params_t {{2, 9, 4, 3, 2}, fmt::OIdhw16i16o2i},
          params_t {{2, 9, 4, 3, 2}, fmt::gOihw16o},
          params_t {{2, 17, 9, 3, 2}, fmt::gOIhw8o4i},
          params_t {{1, 2, 9, 3, 2}, fmt::gOIhw8o8i},
          params_t {{1, 2, 9, 3, 2}, fmt::gOIhw4o4i},
          params_t {{1, 2, 9, 3, 2}, fmt::gOIhw8i8o},
          params_t {{2, 17, 9, 3, 2}, fmt::gOIhw4i16o4i},
          params_t {{2, 17, 9, 3, 2}, fmt::gOIhw2i8o4i},
          params_t {{2, 17, 9, 3, 2, 4}, fmt::gOIdhw8o4i},
          params_t {{2, 16, 16, 3}, fmt::gOIw2i4o2i},
          params_t {{2, 8, 6, 3, 3}, fmt::gOIhw2i4o2i},
          params_t {{2, 14, 18, 3, 3, 4}, fmt::gOIdhw2i4o2i},
          params_t {{2, 16, 16, 3}, fmt::gOIw4i8o2i},
          params_t {{2, 12, 18, 3, 2}, fmt::gOIhw4i8o2i},
          params_t {{2, 10, 6, 3, 5, 3}, fmt::gOIdhw4i8o2i},
          params_t {{2, 2, 3, 4}, fmt::gOIw2o4i2o},
          params_t {{2, 18, 8, 3, 3}, fmt::gOIhw2o4i2o},
          params_t {{2, 10, 6, 6, 3, 3}, fmt::gOIdhw2o4i2o},
          params_t {{2, 2, 4, 3}, fmt::gOIw4o8i2o},
          params_t {{2, 14, 10, 3, 3}, fmt::gOIhw4o8i2o},
          params_t {{2, 8, 8, 3, 3, 3}, fmt::gOIdhw4o8i2o},
          params_t {{15, 16, 16, 3, 3}, fmt::Goihw8g},
          params_t {{2, 9, 3}, fmt::OIw2i8o4i},
          params_t {{2, 17, 9, 3}, fmt::gOIw2i8o4i},
          params_t {{15, 16, 16, 3}, fmt::Goiw8g},
          params_t {{2, 17, 9, 3, 2}, fmt::gOIhw16i16o4i},
          params_t {{2, 17, 9, 3, 2}, fmt::gOIhw16i16o2i},
          params_t {{2, 17, 9, 3, 2}, fmt::gOIhw16o16i2o},
          params_t {{2, 15, 17, 9, 3, 2}, fmt::gOIdhw16i16o4i},
          params_t {{2, 15, 17, 9, 3, 2}, fmt::gOIdhw16i16o2i});
  } // namespace
  
  INSTANTIATE_TEST_SUITE_P(TestMemoryCreationEF, memory_creation_test_t,
          ::testing::Combine(all_engine_kinds, cases_expect_to_fail));
  
  INSTANTIATE_TEST_SUITE_P(TestMemoryCreationZeroDim, memory_creation_test_t,
          ::testing::Combine(all_engine_kinds, cases_zero_dim));
  
  INSTANTIATE_TEST_SUITE_P(TestMemoryCreationOK, memory_creation_test_t,
          ::testing::Combine(all_engine_kinds, cases_generic));
  
  class c_api_memory_test_t : public ::testing::Test {
      void SetUp() override {}
  };
  
  TEST_F(c_api_memory_test_t, TestZeroPadBoom) {
  #if defined(DNNL_WITH_SYCL) || DNNL_CPU_RUNTIME == DNNL_RUNTIME_NONE
      SKIP_IF(true, "Test does not support SYCL and GPU only.");
  #endif
  
      dnnl_memory_desc_t md;
      memset(&md, 0xcc, sizeof(md));
  
      md.ndims = 2;
      md.data_type = dnnl_f32;
      md.offset0 = 0;
      md.dims[0] = 1;
      md.dims[1] = 1001;
      md.padded_dims[0] = 1;
      md.padded_dims[1] = 1008;
      md.padded_offsets[0] = 0;
      md.padded_offsets[1] = 0;
  
      md.extra.flags = dnnl_memory_extra_flag_none;
  
      md.format_kind = dnnl_blocked;
      md.format_desc.blocking.inner_nblks = 1;
      md.format_desc.blocking.inner_blks[0] = 16;
      md.format_desc.blocking.inner_idxs[0] = 1;
      md.format_desc.blocking.strides[0] = 1008;
      md.format_desc.blocking.strides[1] = 16;
  
      dnnl_engine_t e;
      ASSERT_TRUE(dnnl_success == dnnl_engine_create(&e, dnnl_cpu, 0));
  
      dnnl_memory_t m;
      ASSERT_TRUE(
              dnnl_success == dnnl_memory_create(&m, &md, e, DNNL_MEMORY_NONE));
  
      void *p = malloc(dnnl_memory_desc_get_size(&md));
      ASSERT_TRUE(p != nullptr);
      ASSERT_TRUE(dnnl_success == dnnl_memory_set_data_handle(m, p)); // Boom
  
      ASSERT_TRUE(dnnl_success == dnnl_memory_destroy(m));
      free(p);
  
      ASSERT_TRUE(dnnl_success == dnnl_engine_destroy(e));
  }
  
  #if DNNL_CPU_RUNTIME != DNNL_RUNTIME_DPCPP \
          && DNNL_CPU_RUNTIME != DNNL_RUNTIME_NONE
  TEST(memory_test_cpp, TestSetDataHandleCPU) {
      engine eng = engine(engine::kind::cpu, 0);
      stream str = make_stream(eng);
  
      const memory::dim N = 1, C = 5, W = 7, H = 7;
      memory::desc data_md(
              {N, C, W, H}, memory::data_type::f32, memory::format_tag::nChw16c);
      auto mem = test::make_memory(data_md, eng, DNNL_MEMORY_NONE);
  
      float *p = (float *)malloc(mem.get_desc().get_size());
      ASSERT_TRUE(p != nullptr);
      mem.set_data_handle(p, str);
  
      ASSERT_TRUE(N == 1);
      ASSERT_TRUE(C < 16);
      ASSERT_TRUE(data_md.data.format_kind == dnnl_blocked);
      ASSERT_TRUE(data_md.data.format_desc.blocking.inner_nblks == 1);
      ASSERT_TRUE(data_md.data.format_desc.blocking.inner_blks[0] == 16);
  
      free(p);
  }
  #endif
  
  } // namespace dnnl
  