Array.cpp

/**********************************************************************
Copyright 2021 The Khronos Group
Copyright 2022 Advanced Micro Devices, Inc
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 "Array.h"

namespace anari {
namespace rpr {

// Array //

Array::Array(void *appMem, ANARIMemoryDeleter deleter, void *deleterPtr, ANARIDataType elementType)
    : m_mem(appMem), m_deleter(deleter), m_elementType(elementType)
{}

Array::~Array()
{
  freeAppMemory();
}

ANARIDataType Array::elementType() const
{
  return m_elementType;
}

void *Array::map()
{
  return m_mem;
}

void Array::unmap()
{
  // TODO
}

bool Array::wasPrivatized() const
{
  return m_privatized;
}

void Array::makePrivatizedCopy(size_t numElements)
{
  void *appMem = m_mem;

  size_t numBytes = numElements * sizeOf(elementType());
  m_mem           = malloc(numBytes);
  std::memcpy(m_mem, appMem, numBytes);

  if (m_deleter)
  {
    m_deleter(m_deleterPtr, appMem);
    m_deleter = nullptr;
  }

  m_privatized = true;
}

void Array::freeAppMemory()
{
  if (m_deleter && m_mem)
  {
    m_deleter(m_deleterPtr, m_mem);
    m_mem     = nullptr;
    m_deleter = nullptr;
  } else if (wasPrivatized() && m_mem)
  {
    free(m_mem);
    m_mem = nullptr;
  }
}

// Array1D //

Array1D::Array1D(void *appMemory, ANARIMemoryDeleter deleter, void *deleterPtr, ANARIDataType type,
    uint64_t numItems, uint64_t byteStride)
    : Array(appMemory, deleter, deleterPtr, type), m_size(numItems)
{
  if (byteStride != 0)
    throw std::runtime_error("strided arrays not yet supported!");
}

ArrayShape Array1D::shape() const
{
  return ArrayShape::ARRAY1D;
}

size_t Array1D::size() const
{
  return m_size;
}

void Array1D::privatize()
{
  makePrivatizedCopy(size());
}

// Array2D //

Array2D::Array2D(void *appMemory, ANARIMemoryDeleter deleter, void *deleterPtr, ANARIDataType type,
    uint64_t numItems1, uint64_t numItems2, uint64_t byteStride1, uint64_t byteStride2)
    : Array(appMemory, deleter, deleterPtr, type)
{
  if (byteStride1 != 0 || byteStride2 != 0)
    throw std::runtime_error("strided arrays not yet supported!");

  m_size[0] = numItems1;
  m_size[1] = numItems2;
}

ArrayShape Array2D::shape() const
{
  return ArrayShape::ARRAY2D;
}

size_t Array2D::size(int dim) const
{
  return m_size[dim];
}

uvec2 Array2D::size() const
{
  return uvec2(uint32_t(size(0)), uint32_t(size(1)));
}

void Array2D::privatize()
{
  makePrivatizedCopy(size(0) * size(1));
}

// Array3D //

Array3D::Array3D(void *appMemory, ANARIMemoryDeleter deleter, void *deleterPtr, ANARIDataType type,
    uint64_t numItems1, uint64_t numItems2, uint64_t numItems3, uint64_t byteStride1, uint64_t byteStride2,
    uint64_t byteStride3)
    : Array(appMemory, deleter, deleterPtr, type)
{
  if (byteStride1 != 0 || byteStride2 != 0 || byteStride3 != 0)
    throw std::runtime_error("strided arrays not yet supported!");

  m_size[0] = numItems1;
  m_size[1] = numItems2;
  m_size[2] = numItems3;
}

ArrayShape Array3D::shape() const
{
  return ArrayShape::ARRAY3D;
}

size_t Array3D::size(int dim) const
{
  return m_size[dim];
}

uvec3 Array3D::size() const
{
  return uvec3(uint32_t(size(0)), uint32_t(size(1)), uint32_t(size(2)));
}

void Array3D::privatize()
{
  makePrivatizedCopy(size(0) * size(1) * size(2));
}

// ObjectArray //

ObjectArray::ObjectArray(void *appMemory, ANARIMemoryDeleter deleter, void *deleterPtr, ANARIDataType type,
    uint64_t numItems, uint64_t byteStride)
    : Array(appMemory, deleter, deleterPtr, type)
{
  if (byteStride != 0)
    throw std::runtime_error("strided arrays not yet supported!");

  m_handleArray.resize(numItems);

  auto **srcBegin = (Object **)appMemory;
  auto **srcEnd   = srcBegin + numItems;

  std::transform(srcBegin, srcEnd, m_handleArray.begin(), [](Object *obj) {
    obj->refInc();
    return obj;
  });
}

ObjectArray::~ObjectArray()
{
  removeAppendedHandles();
  for (auto *obj : m_handleArray)
    obj->refDec();
}

ArrayShape ObjectArray::shape() const
{
  return ArrayShape::ARRAY1D;
}

size_t ObjectArray::size() const
{
  return m_handleArray.size();
}

void ObjectArray::privatize()
{
  freeAppMemory();
}

Object **ObjectArray::handles()
{
  return m_handleArray.data();
}

void ObjectArray::appendHandle(Object *o)
{
  m_handleArray.push_back(o);
  m_numAppended++;
}

void ObjectArray::removeAppendedHandles()
{
  auto originalSize = m_handleArray.size() - m_numAppended;
  m_handleArray.resize(originalSize);
  m_numAppended = 0;
}

} // namespace rpr

ANARI_TYPEFOR_DEFINITION(rpr::Array *);
ANARI_TYPEFOR_DEFINITION(rpr::Array1D *);
ANARI_TYPEFOR_DEFINITION(rpr::Array2D *);
ANARI_TYPEFOR_DEFINITION(rpr::Array3D *);
ANARI_TYPEFOR_DEFINITION(rpr::ObjectArray *);

} // namespace anari