diff --git a/book/contents/SUMMARY.md b/book/contents/SUMMARY.md index 31edbf25..9d962e3d 100644 --- a/book/contents/SUMMARY.md +++ b/book/contents/SUMMARY.md @@ -79,8 +79,8 @@ - [线程同步：消息传递](advance/concurrency-with-threads/message-passing.md) - [线程同步：锁、Condvar和信号量](advance/concurrency-with-threads/sync1.md) - [线程同步：Atomic原子操作与内存顺序](advance/concurrency-with-threads/sync2.md) - - [Send、Sync todo](advance/multi-threads/send-sync.md) - - [一个综合例子 todo](advance/multi-threads/example.md) + - [基于Send和Sync的线程安全](advance/concurrency-with-threads/send-sync.md) + - [一个综合例子](advance/concurrency-with-threads/example.md) - [async/await并发编程 todo](advance/async/intro.md) - [async/await语法 todo](advance/async/async-await.md) - [future详解 todo](advance/async/future/into.md) @@ -139,7 +139,7 @@ - [用Rust增强Javascript todo](rustjs/intro.md) - [deno todo](rustjs/deno.md) - + - [wasm tod](rustjs/wasm/intro.md) - [复杂错误索引 todo](errorindex/intro.md) - [所有权和借用 todo](errorindex/borrowing/intro.md) - [生命周期 todo](errorindex/lifetime/intro.md) @@ -210,6 +210,7 @@ - [CPU缓存性能优化 todo](performance/cpu-cache.md) - [计算性能优化 todo](performance/calculate.md) - [堆和栈 todo](performance/heap-stack.md) + - [内存allocator todo](performance/allocator.md) - [常用性能测试工具 todo](performance/tools.md) - [编译器 todo](compiler/intro.md) diff --git a/book/contents/advance/multi-threads/example.md b/book/contents/advance/concurrency-with-threads/example.md similarity index 100% rename from book/contents/advance/multi-threads/example.md rename to book/contents/advance/concurrency-with-threads/example.md diff --git a/book/contents/advance/concurrency-with-threads/send-sync.md b/book/contents/advance/concurrency-with-threads/send-sync.md index fbfc7aa1..a225d169 100644 --- a/book/contents/advance/concurrency-with-threads/send-sync.md +++ b/book/contents/advance/concurrency-with-threads/send-sync.md @@ -1,4 +1,178 @@ -# Send、Sync(todo) +# 基于Send和Sync的线程安全 +为何Rc、RefCell和原生指针不可以在多线程间使用？如何让原生指针可以在多线程使用？我们一起来探寻下这些问题的答案。 + +## 无法用于多线程的`Rc` +先来看一段多线程使用`Rc`的代码: +```rust +use std::thread; +use std::rc::Rc; +fn main() { + let v = Rc::new(5); + let t = thread::spawn(move || { + println!("{}",v); + }); + + t.join().unwrap(); +} +``` + +以上代码将`v`的所有权通过`move`转移到子线程中，看似正确实则会报错： +```console +error[E0277]: `Rc` cannot be sent between threads safely +------ 省略部分报错 -------- + = help: within `[closure@src/main.rs:5:27: 7:6]`, the trait `Send` is not implemented for `Rc` +``` + +表面原因是`Rc`无法在线程间安全的转移，实际是编译器给予我们的那句帮助: `the trait Send is not implemented for Rc`(`Rc`未实现`Send`特征), 那么此处的`Send`特征又是何方神圣？ + +## Rc和Arc源码对比 +在介绍`Send`特征之前，再来看看`Arc`为何可以在多线程使用，玄机在于两者的源码实现上： +```rust +// Rc源码片段 +impl !marker::Send for Rc {} +impl !marker::Sync for Rc {} + +// Arc源码片段 +unsafe impl Send for Arc {} +unsafe impl Sync for Arc {} +``` + +`!`代表移除特征的相应实现，上面代码中`Rc`的`Send`和`Sync`特征被特地移除了实现，而`Arc`则相反，实现了`Sync + Send`，再结合之前的编译器报错，大概可以明白了：`Send`和`Sync`是在线程间安全使用一个值的关键。 + +## Send和Sync +`Send`和`Sync`是Rust安全并发的重中之重，但是实际上它们只是标记特征(marker trait，该特征未定义任何行为，因此非常适合用于标记), 来看看它们的作用： + +- 实现`Send`的类型可以在线程间安全的传递其所有权 +- 实现了`Sync`的类型可以在线程间安全的共享(通过引用) + +这里还有一个潜在的依赖：一个类型要在线程间安全的共享的前提是，指向它的引用必须能在线程间传递。因为如果引用都不能被传递，我们就无法在多个线程间使用引用去访问同一个数据了。 + +由上可知，**若类型T的引用`&T`是`Send`，则`T`是`Sync`**。 + +没有例子的概念讲解都是耍流氓，来看看`RwLock`的实现: +```rust +unsafe impl Sync for RwLock {} +``` + +首先`RwLock`可以在线程间安全的共享，那它肯定是实现了`Sync`，但是我们的关注点不在这里。众多周知，`RwLock`可以并发的读，说明其中的值`T`必定也可以在线程间共享，那`T`必定要实现`Sync`。 + +果不其然，上述代码中，`T`的特征约束中就有一个`Sync`特征，那问题又来了，`Mutex`是不是相反？再来看看: +```rust +unsafe impl Sync for Mutex {} +``` + +不出所料，`Mutex`中的`T`并没有`Sync`特征约束。 + +武学秘籍再好，不见生死也是花拳绣腿。同样的，我们需要通过实战来彻底掌握`Send`和`Sync`，但在实战之前，先来简单看看有哪些类型实现了它们。 + +## 实现`Send`和`Sync`的类型 +在Rust中，几乎所有类型都默认实现了`Send`和`Sync`，而且由于这两个特征都是可自动派生的特征(通过`derive`派生)，意味着一个复合类型(例如结构体), 只要它内部的所有成员都实现了`Send`或者`Sync`，那么它就自动实现了`Send`或`Sync`。 + +正是因为以上规则，Rust中绝大多数类型都实现了`Send`和`Sync`，除了以下几个(事实上不止这几个，只不过它们比较常见): + +- 原生指针两者都没实现，因为它本身就没有任何安全保证 +- `UnsafeCell`不是`Sync`，因此`Cell`和`RefCell`也不是 +- `Rc`两者都没实现(因为内部的引用计数器不是线程安全的) + +当然，如果是自定义的复合类型，那没实现那哥俩的就较为常见了：**只要复合类型中有一个成员不是`Send`或`Sync`，那么该符合类型也就不是`Send`或`Sync`**。 + +至此，相关的概念大家已经掌握，但是我敢肯定，对于这两个滑不溜秋的家伙，大家依然会非常模糊，不知道它们该如何使用。那么我们来一起看看如何让原生指针可以在线程间安全的使用。 + +## 为原生指针实现`Send` +上面我们提到原生指针既没实现`Send`，意味着下面代码会报错: +```rust +use std::thread; +fn main() { + let p = 5 as *mut u8; + let t = thread::spawn(move || { + println!("{:?}",p); + }); + + t.join().unwrap(); +} +``` +报错跟之前无二： `*mut u8 cannot be sent between threads safely`, 但是有一个问题，我们无法为其直接实现`Send`特征，好在可以用[`newtype`类型](../custom-type.md#newtype):`struct MyBox(*mut u8);`。 + +还记得之前的规则吗：复合类型中有一个成员没实现`Send`，该复合类型就不是`Send`，因此我们需要手动为它实现: +```rust +use std::thread; + +#[derive(Debug)] +struct MyBox(*mut u8); +unsafe impl Send for MyBox {} +fn main() { + let p = MyBox(5 as *mut u8); + let t = thread::spawn(move || { + println!("{:?}",p); + }); + + t.join().unwrap(); +} +``` + +此时，我们的指针已经可以欢快的在多线程间撒欢，以上代码很简单，但有一点需要注意：`Send`和`Sync`是`unsafe`特征，实现时需要用`unsafe`代码块包裹。 + +## 为原生指针实现`Sync` +由于`Sync`是多线程间共享一个值，大家可能会想这么实现： +```rust +use std::thread; +fn main() { + let v = 5; + let t = thread::spawn(|| { + println!("{:?}",&v); + }); + + t.join().unwrap(); +} +``` + +关于这种用法，在多线程章节也提到过，线程如果直接去借用其它线程的变量，会报错:`closure may outlive the current function,`, 原因在于编译器无法确定主线程`main`和子线程`t`谁的生命周期更长，特别是当两个线程都是子线程时，没有任何人知道哪个子线程会先结束，包括编译器！ + +因此我们得配合`Arc`去使用: +```rust +use std::thread; +use std::sync::Arc; +use std::sync::Mutex; + +#[derive(Debug)] +struct MyBox(*const u8); +unsafe impl Send for MyBox {} + +fn main() { + let b = &MyBox(5 as *const u8); + let v = Arc::new(Mutex::new(b)); + let t = thread::spawn(move || { + let _v1 = v.lock().unwrap(); + }); + + t.join().unwrap(); +} +``` + +上面代码将智能指针`v`的所有权转移给新线程，同时`v`包含了一个引用类型`b`，当在新的线程中试图获取内部的引用时，会报错： +```console +error[E0277]: `*const u8` cannot be shared between threads safely +--> src/main.rs:25:13 +| +25 | let t = thread::spawn(move || { +| ^^^^^^^^^^^^^ `*const u8` cannot be shared between threads safely +| += help: within `MyBox`, the trait `Sync` is not implemented for `*const u8` +``` + +因为我们访问的引用实际上还是对主线程中的数据的借用，转移进来的仅仅是外层的智能指针引用。要解决很简单，为`MyBox`实现`Sync`: +```rust +unsafe impl Sync for MyBox {} +``` + +## 总结 +通过上面的两个原生指针的例子，我们了解了如何实现`Send`和`Sync`，以及如何只实现`Send`而不实现`Sync`，简单总结下： + +1. 实现`Send`的类型可以在线程间安全的传递其所有权, 实现`Sync`的类型可以在线程间安全的共享(通过引用) +2. 绝大部分类型都实现了`Send`和`Sync`，常见的未实现的有：原生指针、Cell/RefCell、Rc等 +3. 可以为自定义类型实现`Send`和`Sync`，但是需要`unsafe`代码块 +4. 可以为部分Rust中的类型实现`Send`、`Sync`，但是需要使用`newtype`，例如文中的原生指针例子 + + -https://www.reddit.com/r/learnrust/comments/rufs0n/can_a_reference_to_a_type_mytype_implement/ \ No newline at end of file diff --git a/book/contents/advance/multi-threads/send-sync.md b/book/contents/advance/multi-threads/send-sync.md deleted file mode 100644 index d31d3e55..00000000 --- a/book/contents/advance/multi-threads/send-sync.md +++ /dev/null @@ -1 +0,0 @@ -# Send、Sync todo diff --git a/book/contents/performance/allocator.md b/book/contents/performance/allocator.md new file mode 100644 index 00000000..bab9e468 --- /dev/null +++ b/book/contents/performance/allocator.md @@ -0,0 +1,3 @@ +# 内存allocator todo + +https://www.reddit.com/r/rust/comments/s28g4x/allocating_many_boxes_at_once/ \ No newline at end of file diff --git a/book/contents/rustjs/wasm/intro.md b/book/contents/rustjs/wasm/intro.md new file mode 100644 index 00000000..0188e222 --- /dev/null +++ b/book/contents/rustjs/wasm/intro.md @@ -0,0 +1,3 @@ +# wasm tod + +https://github.com/iantheearl/rust-typescript-template \ No newline at end of file