Magic-Mirror/llvm-capstone
1
0
Fork 0
mirror of https://github.com/capstone-engine/llvm-capstone.git synced 2024-10-07 10:54:01 +00:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

[libc++][PSTL] Implement std::stable_sort

Browse Source 
Reviewed By: #libc, ldionne

Spies: ldionne, libcxx-commits

Differential Revision: https://reviews.llvm.org/D151573
This commit is contained in:
Nikolas Klauser 2023-06-01 15:05:11 -07:00
parent 722832e6d7
commit d51a84b405
11 changed files with 260 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
libcxx/include/CMakeLists.txt
View File

@ -80,6 +80,7 @@ set(files
__algorithm/pstl_backends/cpu_backends/for_each.h
__algorithm/pstl_backends/cpu_backends/merge.h
__algorithm/pstl_backends/cpu_backends/serial.h
__algorithm/pstl_backends/cpu_backends/stable_sort.h
__algorithm/pstl_backends/cpu_backends/thread.h
__algorithm/pstl_backends/cpu_backends/transform.h
__algorithm/pstl_backends/cpu_backends/transform_reduce.h
@ -89,6 +90,7 @@ set(files
__algorithm/pstl_for_each.h
__algorithm/pstl_frontend_dispatch.h
__algorithm/pstl_merge.h
__algorithm/pstl_stable_sort.h
__algorithm/pstl_transform.h
__algorithm/push_heap.h
__algorithm/ranges_adjacent_find.h

3
libcxx/include/__algorithm/pstl_backend.h
View File

@ -32,6 +32,9 @@ A PSTL parallel backend is a tag type to which the following functions are assoc
template <class _ExecutionPolicy, class _Iterator, class _Predicate>
_Iterator __pstl_find_if(_Backend, _Iterator __first, _Iterator __last, _Predicate __pred);
template <class _ExecutionPolicy, class _RandomAccessIterator, class _Comp>
void __pstl_stable_sort(_Backend, _RandomAccessIterator __first, _RandomAccessIterator __last, _Comp __comp);
template <class _ExecutionPolicy, class _InIterator, class _OutIterator, class _UnaryOperation>
_OutIterator __pstl_transform(_InIterator __first, _InIterator __last, _OutIterator __result, _UnaryOperation __op);

7
libcxx/include/__algorithm/pstl_backends/cpu_backend.h
View File

@ -37,6 +37,12 @@
_Compare __comp,
_LeafMerge __leaf_merge);
template <class _RandomAccessIterator, class _Comp, class _LeafSort>
void __parallel_stable_sort(_RandomAccessIterator __first,
_RandomAccessIterator __last,
_Comp __comp,
_LeafSort __leaf_sort);
TODO: Document the parallel backend
*/
@ -46,6 +52,7 @@
#include <__algorithm/pstl_backends/cpu_backends/find_if.h>
#include <__algorithm/pstl_backends/cpu_backends/for_each.h>
#include <__algorithm/pstl_backends/cpu_backends/merge.h>
#include <__algorithm/pstl_backends/cpu_backends/stable_sort.h>
#include <__algorithm/pstl_backends/cpu_backends/transform.h>
#include <__algorithm/pstl_backends/cpu_backends/transform_reduce.h>

7
libcxx/include/__algorithm/pstl_backends/cpu_backends/serial.h
View File

@ -12,6 +12,7 @@
#include <__config>
#include <__utility/move.h>
#include <cstddef>
#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
# pragma GCC system_header
@ -35,6 +36,12 @@ __parallel_transform_reduce(_Index __first, _Index __last, _UnaryOp, _Tp __init,
return __reduce(std::move(__first), std::move(__last), std::move(__init));
}
template <class _RandomAccessIterator, class _Compare, class _LeafSort>
_LIBCPP_HIDE_FROM_ABI void __parallel_stable_sort(
_RandomAccessIterator __first, _RandomAccessIterator __last, _Compare __comp, _LeafSort __leaf_sort) {
__leaf_sort(__first, __last, __comp);
}
_LIBCPP_HIDE_FROM_ABI inline void __cancel_execution() {}
template <class _RandomAccessIterator1,

45
libcxx/include/__algorithm/pstl_backends/cpu_backends/stable_sort.h Normal file
View File

@ -0,0 +1,45 @@
//===----------------------------------------------------------------------===//
//
// 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 _LIBCPP___ALGORITHM_PSTL_BACKENDS_CPU_BACKENDS_STABLE_SORT_H
#define _LIBCPP___ALGORITHM_PSTL_BACKENDS_CPU_BACKENDS_STABLE_SORT_H
#include <__algorithm/pstl_backends/cpu_backends/backend.h>
#include <__algorithm/stable_sort.h>
#include <__config>
#include <__type_traits/is_execution_policy.h>
#include <__utility/terminate_on_exception.h>
#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
# pragma GCC system_header
#endif
#if !defined(_LIBCPP_HAS_NO_INCOMPLETE_PSTL) && _LIBCPP_STD_VER >= 17
_LIBCPP_BEGIN_NAMESPACE_STD
template <class _ExecutionPolicy, class _RandomAccessIterator, class _Comp>
_LIBCPP_HIDE_FROM_ABI void
__pstl_stable_sort(__cpu_backend_tag, _RandomAccessIterator __first, _RandomAccessIterator __last, _Comp __comp) {
if constexpr (__is_parallel_execution_policy_v<_ExecutionPolicy>) {
std::__terminate_on_exception([&] {
__par_backend::__parallel_stable_sort(
__first, __last, __comp, [](_RandomAccessIterator __g_first, _RandomAccessIterator __g_last, _Comp __g_comp) {
std::stable_sort(__g_first, __g_last, __g_comp);
});
});
} else {
std::stable_sort(__first, __last, __comp);
}
}
_LIBCPP_END_NAMESPACE_STD
#endif // !defined(_LIBCPP_HAS_NO_INCOMPLETE_PSTL) && _LIBCPP_STD_VER >= 17
#endif // _LIBCPP___ALGORITHM_PSTL_BACKENDS_CPU_BACKENDS_STABLE_SORT_H

7
libcxx/include/__algorithm/pstl_backends/cpu_backends/thread.h
View File

@ -12,6 +12,7 @@
#include <__assert>
#include <__config>
#include <__utility/move.h>
#include <cstddef>
#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
# pragma GCC system_header
@ -38,6 +39,12 @@ __parallel_transform_reduce(_Index __first, _Index __last, _UnaryOp, _Tp __init,
return __reduce(std::move(__first), std::move(__last), std::move(__init));
}
template <class _RandomAccessIterator, class _Compare, class _LeafSort>
_LIBCPP_HIDE_FROM_ABI void __parallel_stable_sort(
_RandomAccessIterator __first, _RandomAccessIterator __last, _Compare __comp, _LeafSort __leaf_sort) {
__leaf_sort(__first, __last, __comp);
}
_LIBCPP_HIDE_FROM_ABI inline void __cancel_execution() {}
template <class _RandomAccessIterator1,

41
libcxx/include/__algorithm/pstl_stable_sort.h Normal file
View File

@ -0,0 +1,41 @@
//===----------------------------------------------------------------------===//
//
// 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 _LIBCPP___ALGORITHM_PSTL_STABLE_SORT_H
#define _LIBCPP___ALGORITHM_PSTL_STABLE_SORT_H
#include <__algorithm/pstl_backend.h>
#include <__config>
#include <__functional/operations.h>
#include <__type_traits/is_execution_policy.h>
#include <__type_traits/remove_cvref.h>
#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
# pragma GCC system_header
#endif
#if !defined(_LIBCPP_HAS_NO_INCOMPLETE_PSTL) && _LIBCPP_STD_VER >= 17
_LIBCPP_BEGIN_NAMESPACE_STD
template <class _ExecutionPolicy,
class _RandomAccessIterator,
class _Comp = less<>,
class _RawPolicy = __remove_cvref_t<_ExecutionPolicy>,
enable_if_t<is_execution_policy_v<_RawPolicy>, int> = 0>
_LIBCPP_HIDE_FROM_ABI void
stable_sort(_ExecutionPolicy&&, _RandomAccessIterator __first, _RandomAccessIterator __last, _Comp __comp = {}) {
using _Backend = typename __select_backend<_RawPolicy>::type;
std::__pstl_stable_sort<_RawPolicy>(_Backend{}, std::move(__first), std::move(__last), std::move(__comp));
}
_LIBCPP_END_NAMESPACE_STD
#endif // !defined(_LIBCPP_HAS_NO_INCOMPLETE_PSTL) && _LIBCPP_STD_VER >= 17
#endif // _LIBCPP___ALGORITHM_PSTL_STABLE_SORT_H

1
libcxx/include/algorithm
View File

@ -1806,6 +1806,7 @@ template <class BidirectionalIterator, class Compare>
#include <__algorithm/pstl_find.h>
#include <__algorithm/pstl_for_each.h>
#include <__algorithm/pstl_merge.h>
#include <__algorithm/pstl_stable_sort.h>
#include <__algorithm/pstl_transform.h>
#include <__algorithm/push_heap.h>
#include <__algorithm/ranges_adjacent_find.h>

3
libcxx/include/module.modulemap.in
View File

@ -345,6 +345,9 @@ module std [system] {
module pstl_backends_cpu_backends_serial {
private header "__algorithm/pstl_backends/cpu_backends/serial.h"
}
module pstl_backends_cpu_backends_stable_sort {
private header "__algorithm/pstl_backends/cpu_backends/stable_sort.h"
}
module pstl_backends_cpu_backends_thread {
private header "__algorithm/pstl_backends/cpu_backends/thread.h"
}

1
libcxx/test/libcxx/private_headers.verify.cpp
View File

@ -123,6 +123,7 @@ END-SCRIPT
#include <__algorithm/pstl_backends/cpu_backends/for_each.h> // expected-error@*:* {{use of private header from outside its module: '__algorithm/pstl_backends/cpu_backends/for_each.h'}}
#include <__algorithm/pstl_backends/cpu_backends/merge.h> // expected-error@*:* {{use of private header from outside its module: '__algorithm/pstl_backends/cpu_backends/merge.h'}}
#include <__algorithm/pstl_backends/cpu_backends/serial.h> // expected-error@*:* {{use of private header from outside its module: '__algorithm/pstl_backends/cpu_backends/serial.h'}}
#include <__algorithm/pstl_backends/cpu_backends/stable_sort.h> // expected-error@*:* {{use of private header from outside its module: '__algorithm/pstl_backends/cpu_backends/stable_sort.h'}}
#include <__algorithm/pstl_backends/cpu_backends/thread.h> // expected-error@*:* {{use of private header from outside its module: '__algorithm/pstl_backends/cpu_backends/thread.h'}}
#include <__algorithm/pstl_backends/cpu_backends/transform.h> // expected-error@*:* {{use of private header from outside its module: '__algorithm/pstl_backends/cpu_backends/transform.h'}}
#include <__algorithm/pstl_backends/cpu_backends/transform_reduce.h> // expected-error@*:* {{use of private header from outside its module: '__algorithm/pstl_backends/cpu_backends/transform_reduce.h'}}

143
libcxx/test/std/algorithms/alg.sorting/alg.sort/stable.sort/pstl.stable_sort.pass.cpp Normal file
View File

@ -0,0 +1,143 @@
//===----------------------------------------------------------------------===//
//
// 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
// UNSUPPORTED: libcpp-has-no-incomplete-pstl
// <algorithm>
// template<class ExecutionPolicy, class RandomAccessIterator>
// void stable_sort(ExecutionPolicy&& exec,
// RandomAccessIterator first, RandomAccessIterator last);
//
// template<class ExecutionPolicy, class RandomAccessIterator, class Compare>
// void stable_sort(ExecutionPolicy&& exec,
// RandomAccessIterator first, RandomAccessIterator last,
// Compare comp);
#include <algorithm>
#include <array>
#include <atomic>
#include <cassert>
#include <vector>
#include "test_macros.h"
#include "test_execution_policies.h"
#include "test_iterators.h"
EXECUTION_POLICY_SFINAE_TEST(stable_sort);
static_assert(sfinae_test_stable_sort<int, int*, int*, bool (*)(int)>);
static_assert(!sfinae_test_stable_sort<std::execution::parallel_policy, int*, int*, bool (*)(int, int)>);
struct OrderedValue {
int value;
double original_order;
bool operator==(const OrderedValue& other) const { return other.value == value; }
auto operator<(const OrderedValue& rhs) const { return value < rhs.value; }
auto operator>(const OrderedValue& rhs) const { return value > rhs.value; }
};
template <class Iter, std::size_t N>
void test_one(std::array<int, N> input, std::array<int, N> expected) {
std::stable_sort(Iter(input.data()), Iter(input.data() + input.size()));
assert(input == expected);
}
template <class Iter>
struct Test {
template <class Policy>
void operator()(Policy&& policy) {
// Empty sequence.
test_one<Iter, 0>({}, {});
// 1-element sequence.
test_one<Iter, 1>({1}, {1});
// 2-element sequence.
test_one<Iter, 2>({2, 1}, {1, 2});
// 3-element sequence.
test_one<Iter, 3>({2, 1, 3}, {1, 2, 3});
// Longer sequence.
test_one<Iter, 8>({2, 1, 3, 6, 8, 4, 11, 5}, {1, 2, 3, 4, 5, 6, 8, 11});
// Longer sequence with duplicates.
test_one<Iter, 7>({2, 1, 3, 6, 2, 8, 6}, {1, 2, 2, 3, 6, 6, 8});
// All elements are the same.
test_one<Iter, 3>({1, 1, 1}, {1, 1, 1});
// Already sorted.
test_one<Iter, 5>({1, 2, 3, 4, 5}, {1, 2, 3, 4, 5});
// Reverse-sorted.
test_one<Iter, 5>({5, 4, 3, 2, 1}, {1, 2, 3, 4, 5});
// Repeating pattern.
test_one<Iter, 6>({1, 2, 1, 2, 1, 2}, {1, 1, 1, 2, 2, 2});
{ // The sort is stable (equivalent elements remain in the same order).
using V = OrderedValue;
using Array = std::array<V, 20>;
Array in = {V{10, 10.1}, {12, 12.1}, {3, 3.1}, {5, 5.1}, {3, 3.2}, {3, 3.3}, {11, 11.1},
{12, 12.2}, {4, 4.1}, {4, 4.2}, {4, 4.3}, {1, 1.1}, {6, 6.1}, {3, 3.4},
{10, 10.2}, {8, 8.1}, {12, 12.3}, {1, 1.2}, {1, 1.3}, {5, 5.2}};
Array expected = {V{1, 1.1}, {1, 1.2}, {1, 1.3}, {3, 3.1}, {3, 3.2}, {3, 3.3}, {3, 3.4},
{4, 4.1}, {4, 4.2}, {4, 4.3}, {5, 5.1}, {5, 5.2}, {6, 6.1}, {8, 8.1},
{10, 10.1}, {10, 10.2}, {11, 11.1}, {12, 12.1}, {12, 12.2}, {12, 12.3}};
std::stable_sort(policy, in.begin(), in.end());
assert(in == expected);
}
{ // A custom comparator works and is stable.
using V = OrderedValue;
using Array = std::array<V, 11>;
Array in = {
V{1, 1.1},
{2, 2.1},
{2, 2.2},
{3, 3.1},
{2, 2.3},
{3, 3.2},
{4, 4.1},
{5, 5.1},
{2, 2.4},
{5, 5.2},
{1, 1.2}};
Array expected = {
V{5, 5.1},
{5, 5.2},
{4, 4.1},
{3, 3.1},
{3, 3.2},
{2, 2.1},
{2, 2.2},
{2, 2.3},
{2, 2.4},
{1, 1.1},
{1, 1.2}};
std::stable_sort(policy, in.begin(), in.end(), std::greater{});
assert(in == expected);
}
}
};
int main(int, char**) {
types::for_each(types::random_access_iterator_list<int*>{}, TestIteratorWithPolicies<Test>{});
#ifndef TEST_HAS_NO_EXCEPTIONS
std::set_terminate(terminate_successful);
int a[] = {1, 2};
try {
std::stable_sort(std::execution::par, std::begin(a), std::end(a), [](int, int) -> bool { throw int{}; });
} catch (int) {
assert(false);
}
#endif
return 0;
}