Passing shared pointers as arguments
Yes, the entire idea about a shared_ptr<> is that multiple instances can hold the same raw pointer and the underlying memory will only be freed when there the last instance of shared_ptr<> is destroyed.
I would avoid a pointer to a shared_ptr<> as that defeats the purpose as you are now dealing with raw_pointers again.
I want to pass a shared pointer to a function. Can you help me with that?
Sure, I can help with you that. I assume you have some understanding of ownership semantics in C++. Is that true?
Yeah, I'm reasonably comfortable with the subject.
Good.
Ok, I can only think of two reasons to take a shared_ptr
argument:
- The function wants to share ownership of the object;
- The function does some operation that works specifically on
shared_ptr
s.
Which one are you interested in?
I'm looking for a general answer, so I'm actually interested in both. I'm curious about what you mean in case #2, though.
Examples of such functions include std::static_pointer_cast
, custom comparators, or predicates. For example, if you need to find all unique shared_ptr from a vector, you need such a predicate.
Ah, when the function actually needs to manipulate the smart pointer itself.
Exactly.
In that case, I think we should pass by reference.
Yes. And if it doesn't change the pointer, you want to pass by const reference. There's no need to copy since you don't need to share ownership. That's the other scenario.
Ok, got it. Let's talk about the other scenario.
The one where you share the ownership? Ok. How do you share ownership with shared_ptr
?
By copying it.
Then the function will need to make a copy of a shared_ptr
, correct?
Obviously. So I pass it by a reference to const and copy to a local variable?
No, that's a pessimization. If it is passed by reference, the function will have no choice but to make the copy manually. If it is passed by value the compiler will pick the best choice between a copy and a move and perform it automatically. So, pass by value.
Good point. I must remember that "Want Speed? Pass by Value." article more often.
Wait, what if the function stores the
shared_ptr
in a member variable, for example? Won't that make a redundant copy?
The function can simply move the shared_ptr
argument into its storage. Moving a shared_ptr
is cheap because it doesn't change any reference counts.
Ah, good idea.
But I'm thinking of a third scenario: what if you don't want to manipulate the
shared_ptr
, nor to share ownership?
In that case, shared_ptr
is completely irrelevant to the function. If you want to manipulate the pointee, take a pointee, and let the callers pick what ownership semantics they want.
And should I take the pointee by reference or by value?
The usual rules apply. Smart pointers don't change anything.
Pass by value if I'm going to copy, pass by reference if I want to avoid a copy.
Right.
Hmm. I think you forgot yet another scenario. What if I want to share ownership, but only depending on a certain condition?
Ah, an interesting edge case. I don't expect that to happen often. But when it happens you can either pass by value and ignore the copy if you don't need it, or pass by reference and make the copy if you need it.
I risk one redundant copy in the first option, and lose a potential move in the second. Can't I eat the cake and have it too?
If you're in a situation where that really matters, you can provide two overloads, one taking a const lvalue reference, and another taking an rvalue reference. One copies, the other moves. A perfect-forwarding function template is another option.
I think that covers all the possible scenarios. Thank you very much.
I think people are unnecessarily scared of using raw pointers as function parameters. If the function is not going to store the pointer or otherwise affect its lifetime, a raw pointer works just as well and represents the lowest common denominator. Consider for example how you would pass a unique_ptr
into a function that takes a shared_ptr
as a parameter, either by value or by const reference?
void DoSomething(myClass * p);
DoSomething(myClass_shared_ptr.get());
DoSomething(myClass_unique_ptr.get());
A raw pointer as a function parameter does not prevent you from using smart pointers in the calling code, where it really matters.