Namespaces
Variants
Views
Actions

Copy elision

From cppreference.com
< cpp‎ | language
Revision as of 06:25, 16 October 2020 by Space Mission (Talk | contribs)

 
C++
 
C++ language
General topics
Flow control
Conditional execution statements
if
Iteration statements (loops)
for
range-for (C++11)
Jump statements
Functions
Function declaration
Lambda function expression
inline specifier
Dynamic exception specifications (until C++17*)
noexcept specifier (C++11)
Exceptions
Namespaces
Types
Specifiers
const/volatile
decltype (C++11)
auto (C++11)
constexpr (C++11)
consteval (C++20)
constinit (C++20)
Storage duration specifiers
Initialization
Expressions
Alternative representations
Literals
Boolean - Integer - Floating-point
Character - String - nullptr (C++11)
User-defined (C++11)
Utilities
Attributes (C++11)
Types
typedef declaration
Type alias declaration (C++11)
Casts
Memory allocation
Classes
Class-specific function properties
explicit (C++11)
static

Special member functions
Templates
Miscellaneous
 
Initialization
 

Omits copy and move(since C++11) constructors, resulting in zero-copy pass-by-value semantics.

Contents

Explanation

Mandatory elision of copy/move operations

Under the following circumstances, the compilers are required to omit the copy and move construction of class objects, even if the copy/move constructor and the destructor have observable side-effects. The objects are constructed directly into the storage where they would otherwise be copied/moved to. The copy/move constructors need not be present or accessible: 

T f() {
    return T();
}
 
f(); // only one call to default constructor of T
The destructor of the type returned must be accessible at the point of the return statement and non-deleted, even though no T object is destroyed.
  • In the initialization of an object, when the initializer expression is a prvalue of the same class type (ignoring cv-qualification) as the variable type: 
T x = T(T(f())); // only one call to default constructor of T, to initialize x
This can only apply when the object being initialized is known not to be a potentially-overlapping subobject: 
struct C { /* ... */ };
C f();
struct D;
D g();
struct D : C {
    D() : C(f()) { }    // no elision when initializing a base-class subobject
    D(int) : D(g()) { } // no elision because the D object being initialized might
                        // be a base-class subobject of some other class
};

Note: the rule above does not specify an optimization: C++17 core language specification of prvalues and temporaries is fundamentally different from that of the earlier C++ revisions: there is no longer a temporary to copy/move from. Another way to describe C++17 mechanics is "unmaterialized value passing": prvalues are returned and used without ever materializing a temporary.

(since C++17)

Non-mandatory elision of copy/move(since C++11) operations

Under the following circumstances, the compilers are permitted, but not required to omit the copy and move(since C++11) construction of class objects even if the copy/move(since C++11) constructor and the destructor have observable side-effects. The objects are constructed directly into the storage where they would otherwise be copied/moved to. This is an optimization: even when it takes place and the copy/move(since C++11) constructor is not called, it still must be present and accessible (as if no optimization happened at all), otherwise the program is ill-formed:

  • In a return statement, when the operand is the name of a non-volatile object with automatic storage duration, which isn't a function parameter or a catch clause parameter, and which is of the same class type (ignoring cv-qualification) as the function return type. This variant of copy elision is known as NRVO, "named return value optimization".
  • In the initialization of an object, when the source object is a nameless temporary and is of the same class type (ignoring cv-qualification) as the target object. When the nameless temporary is the operand of a return statement, this variant of copy elision is known as RVO, "return value optimization".
(until C++17)

Return value optimization is mandatory and no longer considered as copy elision; see above.

(since C++17)
  • In a throw-expression, when the operand is the name of a non-volatile object with automatic storage duration, which isn't a function parameter or a catch clause parameter, and whose scope does not extend past the innermost try-block (if there is a try-block).
  • In a catch clause, when the argument is of the same type (ignoring cv-qualification) as the exception object thrown, the copy of the exception object is omitted and the body of the catch clause accesses the exception object directly, as if caught by reference (there cannot be a move from the exception object because it is always an lvalue). This is disabled if such copy elision would change the observable behavior of the program for any reason other than skipping the copy constructor and the destructor of the catch clause argument (for example, if the catch clause argument is modified, and the exception object is rethrown with throw).
(since C++11)
  • In coroutines, copy/move of the parameter into coroutine state may be elided where this does not change the behavior of the program other than by omitting the calls to the parameter's constructor and destructor. This can take place if the parameter is never referenced after a suspension point or when the entire coroutine state was never heap-allocated in the first place.
(since C++20)

When copy elision occurs, the implementation treats the source and target of the omitted copy/move(since C++11) operation as simply two different ways of referring to the same object, and the destruction of that object occurs at the later of the times when the two objects would have been destroyed without the optimization (except that, if the parameter of the selected constructor is an rvalue reference to object type, the destruction occurs when the target would have been destroyed)(since C++17).

Multiple copy elisions may be chained to eliminate multiple copies. 

struct A {
    void *p;
    constexpr A(): p(this) {}
};
 
constexpr A g()
{
    A a;
    return a;
}
 
constexpr A a;          // a.p points to a
// constexpr A b = g(); // error: b.p would be dangling and would point to a temporary
                        // with automatic storage duration
 
void h()
{
    A c = g();          // c.p may point to c or to an ephemeral temporary
}
 
extern const A d; 
constexpr A f()
{
    A e;
    if (&e == &d)
        return A();
    else
        return e;
    // mandating NRVO in constant evaluation contexts would result in contradiction
    // that NRVO is performed if and only if it's not performed
} 
// constexpr A d = f(); // error: d.p would be dangling
 (since C++11)

Notes

Copy elision is the only allowed form of optimization(until C++14)one of the two allowed forms of optimization, alongside allocation elision and extension,(since C++14) that can change the observable side-effects. Because some compilers do not perform copy elision in every situation where it is allowed (e.g., in debug mode), programs that rely on the side-effects of copy/move constructors and destructors are not portable.

In a return statement or a throw-expression, if the compiler cannot perform copy elision but the conditions for copy elision are met or would be met, except that the source is a function parameter, the compiler will attempt to use the move constructor even if the object is designated by an lvalue; see return statement for details.

(since C++11)

Example

Run this code
#include <iostream>
#include <vector>
 
struct Noisy {
    Noisy() { std::cout << "constructed at " << this << '\n'; }
    Noisy(const Noisy&) { std::cout << "copy-constructed\n"; }
    Noisy(Noisy&&) { std::cout << "move-constructed\n"; }
    ~Noisy() { std::cout << "destructed at " << this << '\n'; }
};
 
std::vector<Noisy> f() {
    std::vector<Noisy> v = std::vector<Noisy>(3); // copy elision when initializing v
                                                  // from a temporary (until C++17)
                                                  // from a prvalue (since C++17)
    return v; // NRVO from v to the result object (not guaranteed, even in C++17)
}             // if optimization is disabled, the move constructor is called
 
void g(std::vector<Noisy> arg) {
    std::cout << "arg.size() = " << arg.size() << '\n';
}
 
int main() {
    std::vector<Noisy> v = f(); // copy elision in initialization of v
                                // from the temporary returned by f() (until C++17)
                                // from the prvalue f() (since C++17)
    g(f());                     // copy elision in initialization of the parameter of g()
                                // from the temporary returned by f() (until C++17)
                                // from the prvalue f() (since C++17)
}

Possible output: 

constructed at 0x2145c20
constructed at 0x2145c21
constructed at 0x2145c22
constructed at 0x2146c50
constructed at 0x2146c51
constructed at 0x2146c52
arg.size() = 3
destructed at 0x2146c50
destructed at 0x2146c51
destructed at 0x2146c52
destructed at 0x2145c20
destructed at 0x2145c21
destructed at 0x2145c22


Defect reports

The following behavior-changing defect reports were applied retroactively to previously published C++ standards.

DR Applied to Behavior as published Correct behavior
CWG 2022 C++14 copy elision was optional in constant expressions copy elision mandatory
CWG 2278 C++14 NRVO was mandatory in constant expressions forbid NRVO in constant expressions
CWG 2426 C++17 destructor not required when returning a prvalue destructor is potentially invoked

See also

Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/language/copy_elision&oldid=123433"