tensor_layout.cpp

/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree.
 */

#include <c10/util/irange.h>
#include <c10/util/safe_numerics.h>
#include <executorch/runtime/core/exec_aten/exec_aten.h>
#include <executorch/runtime/core/exec_aten/util/scalar_type_util.h>
#include <executorch/runtime/core/span.h>
#include <executorch/runtime/core/tensor_layout.h>

namespace executorch {
namespace ET_RUNTIME_NAMESPACE {

namespace {
Result<size_t> calculate_nbytes(
    const Span<const int32_t>& sizes,
    const executorch::aten::ScalarType& scalar_type) {
  size_t n = 1;
  for (const auto i : c10::irange(sizes.size())) {
    if (sizes[i] < 0) {
      return Error::InvalidArgument;
    }
    size_t next = 0;
    if (c10::mul_overflows(n, static_cast<size_t>(sizes[i]), &next)) {
      return Error::InvalidArgument;
    }
    n = next;
  }
  // Use the full namespace to disambiguate from c10::elementSize.
  const size_t elem_size =
      static_cast<size_t>(executorch::runtime::elementSize(scalar_type));
  size_t total = 0;
  if (c10::mul_overflows(n, elem_size, &total)) {
    return Error::InvalidArgument;
  }
  return total;
}
} // namespace

Result<const TensorLayout> TensorLayout::create(
    Span<const int32_t> sizes,
    Span<const uint8_t> dim_order,
    executorch::aten::ScalarType scalar_type) {
  auto nbytes = calculate_nbytes(sizes, scalar_type);
  if (!nbytes.ok()) {
    return nbytes.error();
  }

  if (dim_order.size() != sizes.size()) {
    return Error::InvalidArgument;
  }

  for (const auto i : c10::irange(dim_order.size())) {
    if (dim_order[i] >= sizes.size()) {
      return Error::InvalidArgument;
    }
  }
  return TensorLayout(sizes, dim_order, scalar_type, nbytes.get());
}
} // namespace ET_RUNTIME_NAMESPACE
} // namespace executorch