[libc++] mdspan - implement default_accessor

[crtrott]

Summary

This implements default_accessor and its tests for mdspan.

[crtrott]

Fix include order.

[crtrott]

Fix whitespace in comment in test

[crtrott]

Fix more formatting stuff.

[crtrott]

Fix module include complaint

[crtrott]

Fix another missing include

[crtrott]

Missing include for modules build in test.

[ldionne]

libcxx/test/std/containers/views/mdspan/MinimalElementType.h

19

24–40

Let's make this all work at compile-time instead (https://godbolt.org/z/EshfM1rzn):

#include <memory>

struct MinimalElementType {
  int val;
  constexpr MinimalElementType() = delete;
  constexpr MinimalElementType(const MinimalElementType&) = delete;
  constexpr explicit MinimalElementType(int v) noexcept : val(v) {}
  constexpr MinimalElementType& operator=(const MinimalElementType&) = delete;
};

// Helper class to create pointer of MinimalElementType
template<class T, size_t N>
struct ElementPool {
  constexpr ElementPool() {
    ptr_ = std::allocator<T>().allocate(N);
    for (int i = 0; i != N; ++i)
      std::construct_at(ptr_ + i, 42);
  }

  constexpr T* get_ptr() { return ptr_; }

  constexpr ~ElementPool() {
    for (int i = 0; i != N; ++i)
      std::destroy_at(ptr_ + i);
    std::allocator<T>().deallocate(ptr_, N);
  }

private:
  T* ptr_;
};

constexpr bool f() {
    ElementPool<MinimalElementType, 128> pool;
    MinimalElementType* p = pool.get_ptr();
    return true;
}

int main() {
    f();
    static_assert(f());
}

libcxx/test/std/containers/views/mdspan/default_accessor/access.pass.cpp

31

Everywhere!

34

41

This won't be true anymore, we can run these tests always.

libcxx/test/std/containers/views/mdspan/default_accessor/ctor.conversion.pass.cpp

30–34

I don't find that the _t typedefs help readability. I think we should remove them.

53

Maybe add some sort of base/derived case here?

libcxx/test/std/containers/views/mdspan/default_accessor/ctor.default.pass.cpp

28

Do we want to add static_assert(std::is_trivially_default_constructible)? This would test that this is = default.

libcxx/test/std/containers/views/mdspan/default_accessor/element_type.verify.cpp

8

libcxx/test/std/containers/views/mdspan/default_accessor/offset.pass.cpp

26

This function name is wrong. Probably happens elsewhere too.

27–28

This comment isn't super useful IMO

34

[crtrott]

Address review comments

[crtrott]

Rebase on top of main.

[crtrott]

Fix module map issue which crept in during rebase

[ldionne]

Ship it!

(after a few comments and rebase and green CI)

Thanks!

libcxx/test/std/containers/views/mdspan/MinimalElementType.h

10–11

For the 3 macros within this file.

20

Let's be explicit about the fact that this isn't movable either. So delete move ctor and move assignment.

[crtrott]

Address last of Louis' comments and rebase.

libcxx/docs/Status/Cxx23.rst

 
 .. csv-table::
    :file: Cxx23Papers.csv
    :header-rows: 1
    :widths: auto
 
 .. note::
 
-   .. [#note-P0009R18] P0009R18: ``extents``, ``dextents``, ``layout_left``, and ``layout_right`` are implemented.
+   .. [#note-P0009R18] P0009R18: ``extents``, ``dextents``, ``layout_left``, ``layout_right``, and ``default_accessor`` are implemented.
    .. [#note-P0533R9] P0533R9: ``isfinite``, ``isinf``, ``isnan`` and ``isnormal`` are implemented.
    .. [#note-P1413R3] P1413R3: ``std::aligned_storage_t`` and ``std::aligned_union_t`` are marked deprecated, but
       clang doesn't issue a diagnostic for deprecated using template declarations.
    .. [#note-P2520R0] P2520R0: Libc++ implemented this paper as a DR in C++20 as well.
    .. [#note-P2711R1] P2711R1: ``join_with_view`` hasn't been done yet since this type isn't implemented yet.
    .. [#note-P2693R1] P1413R3: The formatter for ``std::thread::id`` is implemented.
       The formatter for ``stacktrace`` is not implemented, since ``stacktrace`` is
       not implemented yet.

libcxx/include/CMakeLists.txt

set(files
   __iterator/sortable.h
   __iterator/unreachable_sentinel.h
   __iterator/wrap_iter.h
   __locale
   __locale_dir/locale_base_api/bsd_locale_defaults.h
   __locale_dir/locale_base_api/bsd_locale_fallbacks.h
   __locale_dir/locale_base_api/locale_guard.h
   __mbstate_t.h
+  __mdspan/default_accessor.h
   __mdspan/extents.h
   __mdspan/layout_left.h
   __mdspan/layout_right.h
   __memory/addressof.h
   __memory/align.h
   __memory/aligned_alloc.h
   __memory/allocate_at_least.h
   __memory/allocation_guard.h

libcxx/include/__mdspan/default_accessor.h

+// -*- C++ -*-
+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//                        Kokkos v. 4.0
+//       Copyright (2022) National Technology & Engineering
+//               Solutions of Sandia, LLC (NTESS).
+//
+// Under the terms of Contract DE-NA0003525 with NTESS,
+// the U.S. Government retains certain rights in this software.
+//
+//===---------------------------------------------------------------------===//
+
+#ifndef _LIBCPP___MDSPAN_DEFAULT_ACCESSOR_H
+#define _LIBCPP___MDSPAN_DEFAULT_ACCESSOR_H
+
+#include <__config>
+#include <__type_traits/is_abstract.h>
+#include <__type_traits/is_array.h>
+#include <__type_traits/is_convertible.h>
+#include <__type_traits/remove_const.h>
+#include <cinttypes>
+#include <cstddef>
+
+#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
+#  pragma GCC system_header
+#endif
+
+_LIBCPP_PUSH_MACROS
+#include <__undef_macros>
+
+_LIBCPP_BEGIN_NAMESPACE_STD
+
+#if _LIBCPP_STD_VER >= 23
+
+template <class _ElementType>
+struct default_accessor {
+  static_assert(!is_array_v<_ElementType>, "default_accessor: template argument may not be an array type");
+  static_assert(!is_abstract_v<_ElementType>, "default_accessor: template argument may not be an abstract class");
+
+  using offset_policy    = default_accessor;
+  using element_type     = _ElementType;
+  using reference        = _ElementType&;
+  using data_handle_type = _ElementType*;
+
+  _LIBCPP_HIDE_FROM_ABI constexpr default_accessor() noexcept = default;
+  template <class _OtherElementType>
+    requires(is_convertible_v<_OtherElementType (*)[], element_type (*)[]>)
+  _LIBCPP_HIDE_FROM_ABI constexpr default_accessor(default_accessor<_OtherElementType>) noexcept {}
+
+  _LIBCPP_HIDE_FROM_ABI constexpr reference access(data_handle_type __p, size_t __i) const noexcept { return __p[__i]; }
+  _LIBCPP_HIDE_FROM_ABI constexpr data_handle_type offset(data_handle_type __p, size_t __i) const noexcept {
+    return __p + __i;
+  }
+};
+
+#endif // _LIBCPP_STD_VER >= 23
+
+_LIBCPP_END_NAMESPACE_STD
+
+_LIBCPP_POP_MACROS
+
+#endif // _LIBCPP___MDSPAN_DEFAULT_ACCESSOR_H

libcxx/include/mdspan

namespace std {
 
   // [mdspan.layout], layout mapping
   struct layout_left;
   struct layout_right;
   struct layout_stride; // not implemented yet
 
   // [mdspan.accessor.default], class template default_accessor
   template<class ElementType>
-    class default_accessor; // not implemented yet
+    class default_accessor;
 
   // [mdspan.mdspan], class template mdspan
   template<class ElementType, class Extents, class LayoutPolicy = layout_right,
            class AccessorPolicy = default_accessor<ElementType>>
     class mdspan; // not implemented yet
 }
 
 // extents synopsis
public:
     template<class OtherExtents>
       friend constexpr bool operator==(const mapping&, const mapping<OtherExtents>&) noexcept;
 
   private:
     extents_type extents_{};    // exposition only
   };
 }
 
+// default_accessor synopsis
+
+namespace std {
+  template<class ElementType>
+  struct default_accessor {
+    using offset_policy = default_accessor;
+    using element_type = ElementType;
+    using reference = ElementType&;
+    using data_handle_type = ElementType*;
+
+    constexpr default_accessor() noexcept = default;
+    template<class OtherElementType>
+      constexpr default_accessor(default_accessor<OtherElementType>) noexcept;
+    constexpr reference access(data_handle_type p, size_t i) const noexcept;
+    constexpr data_handle_type offset(data_handle_type p, size_t i) const noexcept;
+  };
+}
+
 */
 
 #ifndef _LIBCPP_MDSPAN
 #define _LIBCPP_MDSPAN
 
 #include <__config>
 #include <__fwd/mdspan.h>
+#include <__mdspan/default_accessor.h>
 #include <__mdspan/extents.h>
 #include <__mdspan/layout_left.h>
 #include <__mdspan/layout_right.h>
 
 #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
 #  pragma GCC system_header
 #endif
 
 #endif // _LIBCPP_MDSPAN

libcxx/include/module.modulemap.in

   }
   module mdspan {
     header "mdspan"
     export array
     export span
     export *
 
     module __mdspan {
+      module default_accessor                { private header "__mdspan/default_accessor.h" }
       module extents                         { private header "__mdspan/extents.h" }
       module layout_left                     { private header "__mdspan/layout_left.h" }
       module layout_right                    { private header "__mdspan/layout_right.h" }
       module mdspan_fwd                      { private header "__fwd/mdspan.h" }
     }
   }
   module memory {
     header "memory"

libcxx/modules/std/mdspan.cppm

export namespace std {
   // [mdspan.extents.dextents], alias template dextents
   using std::dextents;
 
   // [mdspan.layout], layout mapping
   using std::layout_left;
   using std::layout_right;
   // using std::layout_stride;
 
-#if 0
-  // [mdspan.accessor.default], class template default_­accessor
+  // [mdspan.accessor.default], class template default_accessor
   using std::default_accessor;
 
   // [mdspan.mdspan], class template mdspan
-  using std::mdspan;
-#endif
+  // using std::mdspan;
 } // namespace std

libcxx/test/std/containers/views/mdspan/MinimalElementType.h

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef TEST_STD_CONTAINERS_MINIMAL_ELEMENT_TYPE_H
+#define TEST_STD_CONTAINERS_MINIMAL_ELEMENT_TYPE_H
+
+// Idiosyncratic element type for mdspan
+// Make sure we don't assume copyable, default constructible etc.
+struct MinimalElementType {
+  int val;
+  constexpr MinimalElementType() = delete;
+  constexpr MinimalElementType(const MinimalElementType&) = delete;
+  constexpr explicit MinimalElementType(int v) noexcept : val(v){};
+  constexpr MinimalElementType& operator=(const MinimalElementType&) = delete;
+};
+
+// Helper class to create pointer of MinimalElementType
+template<class T>
+struct MinimalElementTypeDataHelper {
+  T ptr[128];
+  constexpr MinimalElementTypeDataHelper() = default;
+  constexpr T* get_ptr() { return ptr; }
+};
+
+// Alignment of this class is implicitly correct due to ptr
+template<>
+struct MinimalElementTypeDataHelper<MinimalElementType> {
+  MinimalElementType* ptr;
+  char data_ptr[512];
+  MinimalElementTypeDataHelper() {
+      ptr = reinterpret_cast<MinimalElementType*>(data_ptr);
+  }
+  constexpr MinimalElementType* get_ptr() { return ptr; }
+};
+
+#endif // TEST_STD_CONTAINERS_MINIMAL_ELEMENT_TYPE_H

libcxx/test/std/containers/views/mdspan/default_accessor/access.pass.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+// UNSUPPORTED: c++03, c++11, c++14, c++17, c++20
+
+// <mdspan>
+
+// constexpr reference access(data_handle_type p, size_t i) const noexcept;
+//
+// Effects: Equivalent to: return p[i];
+
+#include <mdspan>
+#include <cassert>
+
+#include "test_macros.h"
+
+#include "../MinimalElementType.h"
+
+template <class T>
+constexpr void test_construction() {
+  // Need this helper because MinimalElementType is not default constructible
+  MinimalElementTypeDataHelper<std::remove_const_t<T>> data;
+  T* ptr = data.get_ptr();
+  std::default_accessor<T> acc;
+  for(int i=0; i<10; i++) {
+    static_assert(std::is_same_v<decltype(acc.access(ptr, i)), typename std::default_accessor<T>::reference>);
+    ASSERT_NOEXCEPT(acc.access(ptr, i));
+    assert(&data.ptr[i] == &acc.access(ptr, i));
+  }
+}
+
+constexpr bool test() {
+  test_construction<int>();
+  test_construction<const int>();
+  // MinimalElementType can't be constructed in consteval scope
+  if !consteval {
+    test_construction<MinimalElementType>();
+    test_construction<const MinimalElementType>();
+  }
+  return true;
+}
+
+int main(int, char**) {
+  test();
+  static_assert(test());
+  return 0;
+}

libcxx/test/std/containers/views/mdspan/default_accessor/ctor.conversion.pass.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+// UNSUPPORTED: c++03, c++11, c++14, c++17, c++20
+
+// <mdspan>
+//
+// Test converting constructor:
+//
+// template<class OtherElementType>
+//   constexpr default_accessor(default_accessor<OtherElementType>) noexcept {}
+//
+// Constraints: is_convertible_v<OtherElementType(*)[], element_type(*)[]> is true.
+
+#include <mdspan>
+#include <cassert>
+#include <cstdint>
+
+#include "test_macros.h"
+
+#include "../MinimalElementType.h"
+
+template <class FromT, class ToT>
+constexpr void test_conversion() {
+  using acc_from_t = std::default_accessor<FromT>;
+  using acc_to_t = std::default_accessor<ToT>;
+  acc_from_t acc_from;
+  ASSERT_NOEXCEPT(acc_to_t(acc_from));
+  [[maybe_unused]] acc_to_t acc_to(acc_from);
+}
+
+constexpr bool test() {
+  // default accessor conversion largely behaves like pointer conversion
+  test_conversion<int, int>();
+  test_conversion<int, const int>();
+  test_conversion<const int, const int>();
+  test_conversion<MinimalElementType, MinimalElementType>();
+  test_conversion<MinimalElementType, const MinimalElementType>();
+  test_conversion<const MinimalElementType, const MinimalElementType>();
+
+  // char is convertible to int, but accessors are not
+  static_assert(!std::is_constructible_v<std::default_accessor<int>, std::default_accessor<char>>);
+  // don't allow conversion from const elements to non-const
+  static_assert(!std::is_constructible_v<std::default_accessor<int>, std::default_accessor<const int>>);
+  // MinimalElementType is constructible from int, but accessors should not be convertible
+  static_assert(!std::is_constructible_v<std::default_accessor<MinimalElementType>, std::default_accessor<int>>);
+  // don't allow conversion from const elements to non-const
+  static_assert(!std::is_constructible_v<std::default_accessor<MinimalElementType>, std::default_accessor<const MinimalElementType>>);
+
+  return true;
+}
+
+int main(int, char**) {
+  test();
+  static_assert(test());
+  return 0;
+}

libcxx/test/std/containers/views/mdspan/default_accessor/ctor.default.pass.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+// UNSUPPORTED: c++03, c++11, c++14, c++17, c++20
+
+// <mdspan>
+
+// Test default construction:
+//
+// constexpr default_accessor() noexcept = default;
+
+#include <mdspan>
+#include <cassert>
+#include <cstdint>
+
+#include "test_macros.h"
+
+#include "../MinimalElementType.h"
+
+template <class T>
+constexpr void test_construction() {
+  ASSERT_NOEXCEPT(std::default_accessor<T>{});
+  [[maybe_unused]] std::default_accessor<T> acc;
+}
+
+constexpr bool test() {
+  test_construction<int>();
+  test_construction<const int>();
+  test_construction<MinimalElementType>();
+  test_construction<const MinimalElementType>();
+  return true;
+}
+
+int main(int, char**) {
+  test();
+  static_assert(test());
+  return 0;
+}

libcxx/test/std/containers/views/mdspan/default_accessor/element_type.verify.cpp

+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+// REQUIRES: has-unix-headers
+// UNSUPPORTED: c++03, c++11, c++14, c++17, c++20
+
+// <mdspan>
+
+// template<class ElementType>
+// class default_accessor;
+
+// ElementType is required to be a complete object type that is neither an abstract class type nor an array type.
+
+#include <mdspan>
+
+class AbstractClass {
+public:
+  virtual void method() = 0;
+};
+
+void not_abstract_class() {
+  // expected-error-re@*:* {{{{(static_assert|static assertion)}} failed {{.*}}default_accessor: template argument may not be an abstract class}}
+  [[maybe_unused]] std::default_accessor<AbstractClass> acc;
+}
+
+void not_array_type() {
+  // expected-error-re@*:* {{{{(static_assert|static assertion)}} failed {{.*}}default_accessor: template argument may not be an array type}}
+  [[maybe_unused]] std::default_accessor<int[5]> acc;
+}
+

libcxx/test/std/containers/views/mdspan/default_accessor/offset.pass.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+// UNSUPPORTED: c++03, c++11, c++14, c++17, c++20
+
+// <mdspan>
+
+// constexpr data_handle_type offset(data_handle_type p, size_t i) const noexcept;
+//
+// Effects: Equivalent to: return p+i;
+
+#include <mdspan>
+#include <cassert>
+
+#include "test_macros.h"
+
+#include "../MinimalElementType.h"
+
+template <class T>
+constexpr void test_construction() {
+  // Need this helper because MinimalElementType is not default constructible
+  MinimalElementTypeDataHelper<std::remove_const_t<T>> data;
+  T* ptr = data.get_ptr();
+  std::default_accessor<T> acc;
+  for(int i=0; i<10; i++) {
+    static_assert(std::is_same_v<decltype(acc.offset(ptr, i)), typename std::default_accessor<T>::data_handle_type>);
+    ASSERT_NOEXCEPT(acc.offset(ptr, i));
+    assert(data.ptr + i == acc.offset(ptr, i));
+  }
+}
+
+constexpr bool test() {
+  test_construction<int>();
+  test_construction<const int>();
+  // MinimalElementType can't be constructed in consteval scope
+  if !consteval {
+    test_construction<MinimalElementType>();
+    test_construction<const MinimalElementType>();
+  }
+  return true;
+}
+
+int main(int, char**) {
+  test();
+  static_assert(test());
+  return 0;
+}

libcxx/test/std/containers/views/mdspan/default_accessor/types.pass.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+// UNSUPPORTED: c++03, c++11, c++14, c++17, c++20
+
+// <mdspan>
+
+//  template<class ElementType>
+//  struct default_accessor {
+//    using offset_policy = default_accessor;
+//    using element_type = ElementType;
+//    using reference = ElementType&;
+//    using data_handle_type = ElementType*;
+//    ...
+//  };
+//
+//  Each specialization of default_accessor is a trivially copyable type that models semiregular.
+
+
+#include <mdspan>
+#include <type_traits>
+#include <concepts>
+#include <cassert>
+
+#include "test_macros.h"
+
+#include "../MinimalElementType.h"
+
+template <class T>
+void test() {
+  using A = std::default_accessor<T>;
+  ASSERT_SAME_TYPE(typename A::offset_policy, A);
+  ASSERT_SAME_TYPE(typename A::element_type, T);
+  ASSERT_SAME_TYPE(typename A::reference, T&);
+  ASSERT_SAME_TYPE(typename A::data_handle_type, T*);
+
+  static_assert(std::semiregular<A>);
+  static_assert(std::is_trivially_copyable_v<A>);
+
+  LIBCPP_STATIC_ASSERT(std::is_empty_v<A>);
+}
+
+int main(int, char**) {
+  test<int>();
+  test<const int>();
+  test<MinimalElementType>();
+  test<const MinimalElementType>();
+  return 0;
+}