c++ return reference / stack memory [duplicate]

Question

This question already has answers here:

Can a local variable's memory be accessed outside its scope? (20 answers)

Closed 6 years ago.

A basic question that I'm not sure of the answer. Is the follow function valid?

std::vector<int> & test_function() {
   std::vector<int> x;

   // do whatever

   return x;
}

If so, why? Shouldn't the program delete x from the stack after the function returns? Thanks.

Answer 1

The behavior is undefined. You shouldn't return references to local variables.

Answer 2

Yes it's valid, but if you attempt to use the returned value, you'll get undefined behavior.

Answer 3

You can't return a reference to a local variable for the same reason you can't return a pointer to a local variable, because on return from the function those local variables are deallocated and therefore the reference or pointer becomes invalid.

Answer 4

The function is well-formed (syntactically correct), but as soon as the function returns, the returned reference is invalid and cannot be used.

To clarify: the code in question does not invoke any undefined behavior. You can safely call this function so long as you do not use the return value, e.g., this is valid:

test_function(); // ok

However, if you try to use the return value (i.e., initialize another reference with it or copy the referent into another object) then you will invoke undefined behavior because the lifetime of the referent (the object x) will have ended (x will be destroyed when the function returns because it is an automatic variable):

std::vector<int>& vec = test_function(); // undefined
std::vector<int> vec = test_function();  // undefined