Currently std::expected can have some padding bytes in its tail due to
[[no_unique_address]]. Those padding bytes can be used by other objects.
For example, in the current implementation:
sizeof(std::expected<std::optional<int>, bool>) ==
sizeof(std::expected<std::expected<std::optional<int>, bool>, bool>)
As a result, the data layout of an
std::expected<std::expected<std::optional<int>, bool>, bool>
can look like this:
+-- optional "has value" flag
| +--padding
/---int---\ | |
00 00 00 00 01 00 00 00
| |
| +- "outer" expected "has value" flag
|
+- expected "has value" flag
This is problematic because `emplace()`ing the "inner" expected can not
only overwrite the "inner" expected "has value" flag (issue #68552) but
also the tail padding where other objects might live.
This patch fixes the problem by ensuring that std::expected has no tail
padding, which is achieved by conditional usage of [[no_unique_address]]
based on the tail padding that this would create.
This is an ABI breaking change because the following property changes:
sizeof(std::expected<std::optional<int>, bool>) <
sizeof(std::expected<std::expected<std::optional<int>, bool>, bool>)
Before the change, this relation didn't hold. After the change, the relation
does hold, which means that the size of std::expected in these cases increases
after this patch. The data layout will change in the following cases where
tail padding can be reused by other objects:
class foo : std::expected<std::optional<int>, bool> {
bool b;
};
or using [[no_unique_address]]:
struct foo {
[[no_unique_address]] std::expected<std::optional<int>, bool> e;
bool b;
};
The vendor communication is handled in #70820.
Fixes: #70494
Co-authored-by: philnik777 <nikolasklauser@berlin.de>
Co-authored-by: Louis Dionne <ldionne.2@gmail.com>
324 lines
9.1 KiB
C++
324 lines
9.1 KiB
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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// UNSUPPORTED: c++03, c++11, c++14, c++17, c++20
|
|
|
|
// constexpr void swap(expected& rhs) noexcept(see below);
|
|
//
|
|
// Constraints:
|
|
// is_swappable_v<T> is true and
|
|
// is_swappable_v<E> is true and
|
|
// is_move_constructible_v<T> && is_move_constructible_v<E> is true, and
|
|
// is_nothrow_move_constructible_v<T> || is_nothrow_move_constructible_v<E> is true.
|
|
//
|
|
// Throws: Any exception thrown by the expressions in the Effects.
|
|
// Remarks: The exception specification is equivalent to:
|
|
// is_nothrow_move_constructible_v<T> && is_nothrow_swappable_v<T> &&
|
|
// is_nothrow_move_constructible_v<E> && is_nothrow_swappable_v<E>
|
|
|
|
#include <cassert>
|
|
#include <expected>
|
|
#include <type_traits>
|
|
#include <utility>
|
|
|
|
#include "../../types.h"
|
|
#include "test_macros.h"
|
|
|
|
// Test Constraints:
|
|
template <class T, class E>
|
|
concept HasMemberSwap = requires(std::expected<T, E> x, std::expected<T, E> y) { x.swap(y); };
|
|
|
|
static_assert(HasMemberSwap<int, int>);
|
|
|
|
struct NotSwappable {};
|
|
void swap(NotSwappable&, NotSwappable&) = delete;
|
|
|
|
// !is_swappable_v<T>
|
|
static_assert(!HasMemberSwap<NotSwappable, int>);
|
|
|
|
// !is_swappable_v<E>
|
|
static_assert(!HasMemberSwap<int, NotSwappable>);
|
|
|
|
struct NotMoveConstructible {
|
|
NotMoveConstructible(NotMoveConstructible&&) = delete;
|
|
friend void swap(NotMoveConstructible&, NotMoveConstructible&) {}
|
|
};
|
|
|
|
// !is_move_constructible_v<T>
|
|
static_assert(!HasMemberSwap<NotMoveConstructible, int>);
|
|
|
|
// !is_move_constructible_v<E>
|
|
static_assert(!HasMemberSwap<int, NotMoveConstructible>);
|
|
|
|
struct MoveMayThrow {
|
|
MoveMayThrow(MoveMayThrow&&) noexcept(false);
|
|
friend void swap(MoveMayThrow&, MoveMayThrow&) noexcept {}
|
|
};
|
|
|
|
// !is_nothrow_move_constructible_v<T> && is_nothrow_move_constructible_v<E>
|
|
static_assert(HasMemberSwap<MoveMayThrow, int>);
|
|
|
|
// is_nothrow_move_constructible_v<T> && !is_nothrow_move_constructible_v<E>
|
|
static_assert(HasMemberSwap<int, MoveMayThrow>);
|
|
|
|
// !is_nothrow_move_constructible_v<T> && !is_nothrow_move_constructible_v<E>
|
|
static_assert(!HasMemberSwap<MoveMayThrow, MoveMayThrow>);
|
|
|
|
// Test noexcept
|
|
template <class T, class E>
|
|
concept MemberSwapNoexcept = //
|
|
requires(std::expected<T, E> x, std::expected<T, E> y) {
|
|
{ x.swap(y) } noexcept;
|
|
};
|
|
|
|
static_assert(MemberSwapNoexcept<int, int>);
|
|
|
|
// !is_nothrow_move_constructible_v<T>
|
|
static_assert(!MemberSwapNoexcept<MoveMayThrow, int>);
|
|
|
|
// !is_nothrow_move_constructible_v<E>
|
|
static_assert(!MemberSwapNoexcept<int, MoveMayThrow>);
|
|
|
|
struct SwapMayThrow {
|
|
friend void swap(SwapMayThrow&, SwapMayThrow&) noexcept(false) {}
|
|
};
|
|
|
|
// !is_nothrow_swappable_v<T>
|
|
static_assert(!MemberSwapNoexcept<SwapMayThrow, int>);
|
|
|
|
// !is_nothrow_swappable_v<E>
|
|
static_assert(!MemberSwapNoexcept<int, SwapMayThrow>);
|
|
|
|
constexpr bool test() {
|
|
// this->has_value() && rhs.has_value()
|
|
{
|
|
std::expected<ADLSwap, int> x(std::in_place, 5);
|
|
std::expected<ADLSwap, int> y(std::in_place, 10);
|
|
x.swap(y);
|
|
|
|
assert(x.has_value());
|
|
assert(x->i == 10);
|
|
assert(x->adlSwapCalled);
|
|
assert(y.has_value());
|
|
assert(y->i == 5);
|
|
assert(y->adlSwapCalled);
|
|
}
|
|
|
|
// !this->has_value() && !rhs.has_value()
|
|
{
|
|
std::expected<int, ADLSwap> x(std::unexpect, 5);
|
|
std::expected<int, ADLSwap> y(std::unexpect, 10);
|
|
x.swap(y);
|
|
|
|
assert(!x.has_value());
|
|
assert(x.error().i == 10);
|
|
assert(x.error().adlSwapCalled);
|
|
assert(!y.has_value());
|
|
assert(y.error().i == 5);
|
|
assert(y.error().adlSwapCalled);
|
|
}
|
|
|
|
// this->has_value() && !rhs.has_value()
|
|
// && is_nothrow_move_constructible_v<E>
|
|
{
|
|
std::expected<TrackedMove<true>, TrackedMove<true>> e1(std::in_place, 5);
|
|
std::expected<TrackedMove<true>, TrackedMove<true>> e2(std::unexpect, 10);
|
|
|
|
e1.swap(e2);
|
|
|
|
assert(!e1.has_value());
|
|
assert(e1.error().i == 10);
|
|
assert(e2.has_value());
|
|
assert(e2->i == 5);
|
|
|
|
assert(e1.error().numberOfMoves == 2);
|
|
assert(!e1.error().swapCalled);
|
|
assert(e2->numberOfMoves == 1);
|
|
assert(!e2->swapCalled);
|
|
}
|
|
|
|
// this->has_value() && !rhs.has_value()
|
|
// && !is_nothrow_move_constructible_v<E>
|
|
{
|
|
std::expected<TrackedMove<true>, TrackedMove<false>> e1(std::in_place, 5);
|
|
std::expected<TrackedMove<true>, TrackedMove<false>> e2(std::unexpect, 10);
|
|
|
|
e1.swap(e2);
|
|
|
|
assert(!e1.has_value());
|
|
assert(e1.error().i == 10);
|
|
assert(e2.has_value());
|
|
assert(e2->i == 5);
|
|
|
|
assert(e1.error().numberOfMoves == 1);
|
|
assert(!e1.error().swapCalled);
|
|
assert(e2->numberOfMoves == 2);
|
|
assert(!e2->swapCalled);
|
|
}
|
|
|
|
// !this->has_value() && rhs.has_value()
|
|
// && is_nothrow_move_constructible_v<E>
|
|
{
|
|
std::expected<TrackedMove<true>, TrackedMove<true>> e1(std::unexpect, 10);
|
|
std::expected<TrackedMove<true>, TrackedMove<true>> e2(std::in_place, 5);
|
|
|
|
e1.swap(e2);
|
|
|
|
assert(e1.has_value());
|
|
assert(e1->i == 5);
|
|
assert(!e2.has_value());
|
|
assert(e2.error().i == 10);
|
|
|
|
assert(e1->numberOfMoves == 1);
|
|
assert(!e1->swapCalled);
|
|
assert(e2.error().numberOfMoves == 2);
|
|
assert(!e2.error().swapCalled);
|
|
}
|
|
|
|
// !this->has_value() && rhs.has_value()
|
|
// && !is_nothrow_move_constructible_v<E>
|
|
{
|
|
std::expected<TrackedMove<true>, TrackedMove<false>> e1(std::unexpect, 10);
|
|
std::expected<TrackedMove<true>, TrackedMove<false>> e2(std::in_place, 5);
|
|
|
|
e1.swap(e2);
|
|
|
|
assert(e1.has_value());
|
|
assert(e1->i == 5);
|
|
assert(!e2.has_value());
|
|
assert(e2.error().i == 10);
|
|
|
|
assert(e1->numberOfMoves == 2);
|
|
assert(!e1->swapCalled);
|
|
assert(e2.error().numberOfMoves == 1);
|
|
assert(!e2.error().swapCalled);
|
|
}
|
|
|
|
// TailClobberer
|
|
{
|
|
// is_nothrow_move_constructible_v<E>
|
|
{
|
|
std::expected<TailClobbererNonTrivialMove<0, true>, TailClobbererNonTrivialMove<1, true>> x(std::in_place);
|
|
std::expected<TailClobbererNonTrivialMove<0, true>, TailClobbererNonTrivialMove<1, true>> y(std::unexpect);
|
|
|
|
x.swap(y);
|
|
|
|
// Both of these would fail if adjusting the "has value" flags happened
|
|
// _before_ constructing the member objects inside the `swap`.
|
|
assert(!x.has_value());
|
|
assert(y.has_value());
|
|
}
|
|
|
|
// !is_nothrow_move_constructible_v<E>
|
|
{
|
|
std::expected<TailClobbererNonTrivialMove<0, true>, TailClobbererNonTrivialMove<1, false>> x(std::in_place);
|
|
std::expected<TailClobbererNonTrivialMove<0, true>, TailClobbererNonTrivialMove<1, false>> y(std::unexpect);
|
|
|
|
x.swap(y);
|
|
|
|
// Both of these would fail if adjusting the "has value" flags happened
|
|
// _before_ constructing the member objects inside the `swap`.
|
|
assert(!x.has_value());
|
|
assert(y.has_value());
|
|
}
|
|
}
|
|
|
|
// CheckForInvalidWrites
|
|
{
|
|
{
|
|
CheckForInvalidWrites<true> x(std::unexpect);
|
|
CheckForInvalidWrites<true> y;
|
|
|
|
x.swap(y);
|
|
|
|
assert(x.check());
|
|
assert(y.check());
|
|
}
|
|
{
|
|
CheckForInvalidWrites<false> x(std::unexpect);
|
|
CheckForInvalidWrites<false> y;
|
|
|
|
x.swap(y);
|
|
|
|
assert(x.check());
|
|
assert(y.check());
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
void testException() {
|
|
#ifndef TEST_HAS_NO_EXCEPTIONS
|
|
// !e1.has_value() && e2.has_value()
|
|
{
|
|
std::expected<ThrowOnMoveConstruct, int> e1(std::unexpect, 5);
|
|
std::expected<ThrowOnMoveConstruct, int> e2(std::in_place);
|
|
try {
|
|
e1.swap(e2);
|
|
assert(false);
|
|
} catch (Except) {
|
|
assert(!e1.has_value());
|
|
assert(e1.error() == 5);
|
|
}
|
|
}
|
|
|
|
// e1.has_value() && !e2.has_value()
|
|
{
|
|
std::expected<int, ThrowOnMoveConstruct> e1(5);
|
|
std::expected<int, ThrowOnMoveConstruct> e2(std::unexpect);
|
|
try {
|
|
e1.swap(e2);
|
|
assert(false);
|
|
} catch (Except) {
|
|
assert(e1.has_value());
|
|
assert(*e1 == 5);
|
|
}
|
|
}
|
|
|
|
// TailClobberer
|
|
{
|
|
// is_nothrow_move_constructible_v<E>
|
|
{
|
|
std::expected<TailClobbererNonTrivialMove<0, false, true>, TailClobbererNonTrivialMove<1>> x(std::in_place);
|
|
std::expected<TailClobbererNonTrivialMove<0, false, true>, TailClobbererNonTrivialMove<1>> y(std::unexpect);
|
|
try {
|
|
x.swap(y);
|
|
assert(false);
|
|
} catch (Except) {
|
|
assert(x.has_value());
|
|
// This would fail if `TailClobbererNonTrivialMove<1>` clobbered the
|
|
// flag when rolling back the swap.
|
|
assert(!y.has_value());
|
|
}
|
|
}
|
|
|
|
// !is_nothrow_move_constructible_v<E>
|
|
{
|
|
std::expected<TailClobbererNonTrivialMove<0>, TailClobbererNonTrivialMove<1, false, true>> x(std::in_place);
|
|
std::expected<TailClobbererNonTrivialMove<0>, TailClobbererNonTrivialMove<1, false, true>> y(std::unexpect);
|
|
try {
|
|
x.swap(y);
|
|
assert(false);
|
|
} catch (Except) {
|
|
// This would fail if `TailClobbererNonTrivialMove<0>` clobbered the
|
|
// flag when rolling back the swap.
|
|
assert(x.has_value());
|
|
assert(!y.has_value());
|
|
}
|
|
}
|
|
}
|
|
#endif // TEST_HAS_NO_EXCEPTIONS
|
|
}
|
|
|
|
int main(int, char**) {
|
|
test();
|
|
static_assert(test());
|
|
testException();
|
|
return 0;
|
|
}
|