std::shared_ptr
定义于头文件 <memory> |
||
template< class T > class shared_ptr; |
(C++11 起) | |
std::shared_ptr
是一个智能指针,它通过指针共享对象的所有权。多个 shared_ptr
对象可以拥有同一个对象。当以下任一情况发生时,对象会被销毁,其内存会被释放:
对象通过 delete-expression 或在构造 shared_ptr
时提供的自定义删除器进行销毁。
一个 shared_ptr
可以共享一个对象的所有权,同时存储指向另一个对象的指针。此功能可用于指向成员对象,同时拥有它们所属的对象。存储的指针是 get()、解引用和比较运算符所访问的指针。当引用计数为零时,传递给删除器的指针是受管理指针。
一个 shared_ptr
也可以不拥有任何对象,在这种情况下它被称为 *空* (如果使用别名构造函数创建空 shared_ptr
,它可能有一个非空的存储指针)。
shared_ptr
的所有特化都满足 CopyConstructible、CopyAssignable 和 LessThanComparable 的要求,并且可以 上下文转换为 bool
。
所有成员函数(包括复制构造函数和复制赋值)可以在不同 shared_ptr
对象上被多个线程调用,而无需额外同步,即使这些对象是副本并共享同一对象的所有权。如果多个执行线程在没有同步的情况下访问同一个 shared_ptr
对象,并且其中任何一个访问使用了 shared_ptr
的非 const 成员函数,则会发生数据竞争;可以使用 std::atomic
目录 |
[编辑] 成员类型
成员类型 | 定义 | ||||
element_type
|
| ||||
weak_type (从 C++17 开始) |
std::weak_ptr<T> |
[编辑] 成员函数
构造新的 shared_ptr (公共成员函数) | |
如果没有更多的 shared_ptr 链接到它,则销毁所拥有的对象。(公共成员函数) | |
赋值 shared_ptr (公共成员函数) | |
修改器 | |
替换托管对象 (公共成员函数) | |
交换管理对象 (公共成员函数) | |
观察器 | |
返回存储的指针 (公共成员函数) | |
解引用存储的指针 (公共成员函数) | |
(C++17) |
提供对存储数组的索引访问 (公共成员函数) |
返回引用同一管理对象的 shared_ptr 对象的数量(公共成员函数) | |
(C++20 前) |
检查管理对象是否仅由当前的 shared_ptr 对象管理(公共成员函数) |
检查存储的指针是否不为空 (公共成员函数) | |
提供共享指针的基于所有权的排序 (公共成员函数) | |
(C++26) |
提供基于所有者的共享指针哈希 (公共成员函数) |
(C++26) |
提供基于所有者的共享指针相等比较 (公共成员函数) |
[编辑] 非成员函数
(C++20 起) |
创建一个管理新对象的共享指针 (函数模板) |
创建一个共享指针,该指针管理使用分配器分配的新对象 (函数模板) | |
对存储的指针应用 static_cast、dynamic_cast、const_cast 或 reinterpret_cast (函数模板) | |
如果拥有,则返回指定类型的删除器 (函数模板) | |
(在 C++20 中移除)(在 C++20 中移除)(在 C++20 中移除)(在 C++20 中移除)(在 C++20 中移除)(C++20) |
与另一个 shared_ptr 或 nullptr 比较(函数模板) |
将存储的指针值输出到输出流 (函数模板) | |
(C++11) |
特化 std::swap 算法 (函数模板) |
特化 std::shared_ptr 的原子操作(函数模板) |
[编辑] 辅助类
(C++20) |
原子共享指针 (类模板特化) |
(C++11) |
std::shared_ptr 的哈希支持 (类模板特化) |
[编辑] 推导指南 (从 C++17 开始)
[编辑] 注意事项
一个对象的所有权只能通过复制构造或复制赋值其值给另一个 shared_ptr
来与另一个 shared_ptr
共享。使用由另一个 shared_ptr
拥有的原始底层指针构造新的 shared_ptr
会导致未定义行为。
std::shared_ptr
可以与 不完整类型 T
一起使用。但是,来自原始指针的构造函数(template<class Y> shared_ptr(Y*))和 template<class Y> void reset(Y*) 成员函数只能使用指向完整类型的指针调用(请注意,std::unique_ptr 可以由指向不完整类型的原始指针构造)。
std::shared_ptr<T> 中的 T
可以是函数类型:在这种情况下,它管理函数指针,而不是对象指针。这有时用于在任何函数被引用时保持动态库或插件加载。
void del(void(*)()) {} void fun() {} int main() { std::shared_ptr<void()> ee(fun, del); (*ee)(); }
[编辑] 实现说明
在典型的实现中,shared_ptr
只持有两个指针
- 存储的指针(由 get() 返回);
- 指向 *控制块* 的指针。
控制块是一个动态分配的对象,它包含
- 指向管理对象的指针或管理对象本身;
- 删除器(类型擦除);
- 分配器(类型擦除);
- 拥有管理对象的
shared_ptr
数量; - 引用管理对象的
weak_ptr
数量。
当通过调用 std::make_shared 或 std::allocate_shared 创建 shared_ptr
时,控制块和管理对象的内存都是通过单个分配创建的。管理对象在控制块的数据成员中就地构造。当通过 shared_ptr
的一个构造函数创建 shared_ptr
时,管理对象和控制块必须单独分配。在这种情况下,控制块存储指向管理对象的指针。
由 shared_ptr
直接持有的指针是 get() 返回的指针,而由控制块持有的指针/对象是当共享所有者数量达到零时将被删除的指针/对象。这些指针不一定相等。
shared_ptr
的析构函数递减控制块的共享所有者数量。如果该计数器达到零,控制块会调用管理对象的析构函数。控制块本身不会被释放,直到 std::weak_ptr 计数器也达到零。
在现有实现中,如果存在指向同一控制块的共享指针,则弱指针的数量会增加([1],[2])。
为了满足线程安全要求,引用计数器通常使用相当于 std::atomic::fetch_add 与 std::memory_order_relaxed 的操作来递增(递减需要更强的排序以安全地销毁控制块)。
[编辑] 示例
#include <chrono> #include <iostream> #include <memory> #include <mutex> #include <thread> using namespace std::chrono_literals; struct Base { Base() { std::cout << "Base::Base()\n"; } // Note: non-virtual destructor is OK here ~Base() { std::cout << "Base::~Base()\n"; } }; struct Derived : public Base { Derived() { std::cout << "Derived::Derived()\n"; } ~Derived() { std::cout << "Derived::~Derived()\n"; } }; void print(auto rem, std::shared_ptr<Base> const& sp) { std::cout << rem << "\n\tget() = " << sp.get() << ", use_count() = " << sp.use_count() << '\n'; } void thr(std::shared_ptr<Base> p) { std::this_thread::sleep_for(987ms); std::shared_ptr<Base> lp = p; // thread-safe, even though the // shared use_count is incremented { static std::mutex io_mutex; std::lock_guard<std::mutex> lk(io_mutex); print("Local pointer in a thread:", lp); } } int main() { std::shared_ptr<Base> p = std::make_shared<Derived>(); print("Created a shared Derived (as a pointer to Base)", p); std::thread t1{thr, p}, t2{thr, p}, t3{thr, p}; p.reset(); // release ownership from main print("Shared ownership between 3 threads and released ownership from main:", p); t1.join(); t2.join(); t3.join(); std::cout << "All threads completed, the last one deleted Derived.\n"; }
可能的输出
Base::Base() Derived::Derived() Created a shared Derived (as a pointer to Base) get() = 0x118ac30, use_count() = 1 Shared ownership between 3 threads and released ownership from main: get() = 0, use_count() = 0 Local pointer in a thread: get() = 0x118ac30, use_count() = 5 Local pointer in a thread: get() = 0x118ac30, use_count() = 4 Local pointer in a thread: get() = 0x118ac30, use_count() = 2 Derived::~Derived() Base::~Base() All threads completed, the last one deleted Derived.
[编辑] 示例
#include <iostream> #include <memory> struct MyObj { MyObj() { std::cout << "MyObj constructed\n"; } ~MyObj() { std::cout << "MyObj destructed\n"; } }; struct Container : std::enable_shared_from_this<Container> // note: public inheritance { std::shared_ptr<MyObj> memberObj; void CreateMember() { memberObj = std::make_shared<MyObj>(); } std::shared_ptr<MyObj> GetAsMyObj() { // Use an alias shared ptr for member return std::shared_ptr<MyObj>(shared_from_this(), memberObj.get()); } }; #define COUT(str) std::cout << '\n' << str << '\n' #define DEMO(...) std::cout << #__VA_ARGS__ << " = " << __VA_ARGS__ << '\n' int main() { COUT("Creating shared container"); std::shared_ptr<Container> cont = std::make_shared<Container>(); DEMO(cont.use_count()); DEMO(cont->memberObj.use_count()); COUT("Creating member"); cont->CreateMember(); DEMO(cont.use_count()); DEMO(cont->memberObj.use_count()); COUT("Creating another shared container"); std::shared_ptr<Container> cont2 = cont; DEMO(cont.use_count()); DEMO(cont->memberObj.use_count()); DEMO(cont2.use_count()); DEMO(cont2->memberObj.use_count()); COUT("GetAsMyObj"); std::shared_ptr<MyObj> myobj1 = cont->GetAsMyObj(); DEMO(myobj1.use_count()); DEMO(cont.use_count()); DEMO(cont->memberObj.use_count()); DEMO(cont2.use_count()); DEMO(cont2->memberObj.use_count()); COUT("Copying alias obj"); std::shared_ptr<MyObj> myobj2 = myobj1; DEMO(myobj1.use_count()); DEMO(myobj2.use_count()); DEMO(cont.use_count()); DEMO(cont->memberObj.use_count()); DEMO(cont2.use_count()); DEMO(cont2->memberObj.use_count()); COUT("Resetting cont2"); cont2.reset(); DEMO(myobj1.use_count()); DEMO(myobj2.use_count()); DEMO(cont.use_count()); DEMO(cont->memberObj.use_count()); COUT("Resetting myobj2"); myobj2.reset(); DEMO(myobj1.use_count()); DEMO(cont.use_count()); DEMO(cont->memberObj.use_count()); COUT("Resetting cont"); cont.reset(); DEMO(myobj1.use_count()); DEMO(cont.use_count()); }
输出
Creating shared container cont.use_count() = 1 cont->memberObj.use_count() = 0 Creating member MyObj constructed cont.use_count() = 1 cont->memberObj.use_count() = 1 Creating another shared container cont.use_count() = 2 cont->memberObj.use_count() = 1 cont2.use_count() = 2 cont2->memberObj.use_count() = 1 GetAsMyObj myobj1.use_count() = 3 cont.use_count() = 3 cont->memberObj.use_count() = 1 cont2.use_count() = 3 cont2->memberObj.use_count() = 1 Copying alias obj myobj1.use_count() = 4 myobj2.use_count() = 4 cont.use_count() = 4 cont->memberObj.use_count() = 1 cont2.use_count() = 4 cont2->memberObj.use_count() = 1 Resetting cont2 myobj1.use_count() = 3 myobj2.use_count() = 3 cont.use_count() = 3 cont->memberObj.use_count() = 1 Resetting myobj2 myobj1.use_count() = 2 cont.use_count() = 2 cont->memberObj.use_count() = 1 Resetting cont myobj1.use_count() = 1 cont.use_count() = 0 MyObj destructed
[编辑] 另请参阅
(C++11) |
具有唯一对象所有权语义的智能指针 (类模板) |
(C++11) |
由 std::shared_ptr 管理的对象的弱引用 (类模板) |