Files
clang-p2996/libcxx/test/std/utilities/expected/expected.void/assign/assign.copy.pass.cpp
Jan Kokemüller 4f4690530e [libc++] Ensure that std::expected has no tail padding (#69673)
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>
2024-01-22 09:05:39 -05:00

146 lines
4.2 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 expected& operator=(const expected& rhs);
//
// Effects:
// - If this->has_value() && rhs.has_value() is true, no effects.
// - Otherwise, if this->has_value() is true, equivalent to: construct_at(addressof(unex), rhs.unex); has_val = false;
// - Otherwise, if rhs.has_value() is true, destroys unex and sets has_val to true.
// - Otherwise, equivalent to unex = rhs.error().
//
// Returns: *this.
//
// Remarks: This operator is defined as deleted unless is_copy_assignable_v<E> is true and is_copy_constructible_v<E> is true.
#include <cassert>
#include <concepts>
#include <expected>
#include <type_traits>
#include <utility>
#include "../../types.h"
#include "test_macros.h"
struct NotCopyConstructible {
NotCopyConstructible(const NotCopyConstructible&) = delete;
NotCopyConstructible& operator=(const NotCopyConstructible&) = default;
};
struct NotCopyAssignable {
NotCopyAssignable(const NotCopyAssignable&) = default;
NotCopyAssignable& operator=(const NotCopyAssignable&) = delete;
};
// Test constraints
static_assert(std::is_copy_assignable_v<std::expected<void, int>>);
// !is_copy_assignable_v<E>
static_assert(!std::is_copy_assignable_v<std::expected<void, NotCopyAssignable>>);
// !is_copy_constructible_v<E>
static_assert(!std::is_copy_assignable_v<std::expected<void, NotCopyConstructible>>);
constexpr bool test() {
// If this->has_value() && rhs.has_value() is true, no effects.
{
std::expected<void, int> e1;
std::expected<void, int> e2;
decltype(auto) x = (e1 = e2);
static_assert(std::same_as<decltype(x), std::expected<void, int>&>);
assert(&x == &e1);
assert(e1.has_value());
}
// Otherwise, if this->has_value() is true, equivalent to: construct_at(addressof(unex), rhs.unex); has_val = false;
{
Traced::state state{};
std::expected<void, Traced> e1;
std::expected<void, Traced> e2(std::unexpect, state, 5);
decltype(auto) x = (e1 = e2);
static_assert(std::same_as<decltype(x), std::expected<void, Traced>&>);
assert(&x == &e1);
assert(!e1.has_value());
assert(e1.error().data_ == 5);
assert(state.copyCtorCalled);
}
// Otherwise, if rhs.has_value() is true, destroys unex and sets has_val to true.
{
Traced::state state{};
std::expected<void, Traced> e1(std::unexpect, state, 5);
std::expected<void, Traced> e2;
decltype(auto) x = (e1 = e2);
static_assert(std::same_as<decltype(x), std::expected<void, Traced>&>);
assert(&x == &e1);
assert(e1.has_value());
assert(state.dtorCalled);
}
// Otherwise, equivalent to unex = rhs.error().
{
Traced::state state{};
std::expected<void, Traced> e1(std::unexpect, state, 5);
std::expected<void, Traced> e2(std::unexpect, state, 10);
decltype(auto) x = (e1 = e2);
static_assert(std::same_as<decltype(x), std::expected<void, Traced>&>);
assert(&x == &e1);
assert(!e1.has_value());
assert(e1.error().data_ == 10);
assert(state.copyAssignCalled);
}
// CheckForInvalidWrites
{
{
CheckForInvalidWrites<true, true> e1;
CheckForInvalidWrites<true, true> e2(std::unexpect);
e1 = e2;
assert(e1.check());
assert(e2.check());
}
{
CheckForInvalidWrites<false, true> e1;
CheckForInvalidWrites<false, true> e2(std::unexpect);
e1 = e2;
assert(e1.check());
assert(e2.check());
}
}
return true;
}
void testException() {
#ifndef TEST_HAS_NO_EXCEPTIONS
std::expected<void, ThrowOnCopyConstruct> e1(std::in_place);
std::expected<void, ThrowOnCopyConstruct> e2(std::unexpect);
try {
e1 = e2;
assert(false);
} catch (Except) {
assert(e1.has_value());
}
#endif // TEST_HAS_NO_EXCEPTIONS
}
int main(int, char**) {
test();
static_assert(test());
testException();
return 0;
}