1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
#[cfg(test)]
mod tests;

use crate::fmt;
use crate::sync::{mutex, poison, LockResult, MutexGuard, PoisonError};
use crate::sys_common::condvar as sys;
use crate::time::{Duration, Instant};

/// 指示是否因超时而返回的条件变量的定时等待的类型。
///
///
/// 它由 [`wait_timeout`] 方法返回。
///
/// [`wait_timeout`]: Condvar::wait_timeout
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
#[stable(feature = "wait_timeout", since = "1.5.0")]
pub struct WaitTimeoutResult(bool);

impl WaitTimeoutResult {
    /// 如果已知等待超时,则返回 `true`。
    ///
    /// # Examples
    ///
    /// 本示例生成一个线程,该线程将更新布尔值,然后等待 100 毫秒再通知 condvar。
    ///
    ///
    /// 主线程将在 condvar 上等待超时,然后在布尔值已更新并通知后离开。
    ///
    /// ```
    /// use std::sync::{Arc, Condvar, Mutex};
    /// use std::thread;
    /// use std::time::Duration;
    ///
    /// let pair = Arc::new((Mutex::new(false), Condvar::new()));
    /// let pair2 = Arc::clone(&pair);
    ///
    /// thread::spawn(move || {
    ///     let (lock, cvar) = &*pair2;
    ///
    ///     // 让我们等待 20 毫秒,然后再通知 condvar。
    ///     thread::sleep(Duration::from_millis(20));
    ///
    ///     let mut started = lock.lock().unwrap();
    ///     // 我们更新布尔值。
    ///     *started = true;
    ///     cvar.notify_one();
    /// });
    ///
    /// // 等待线程启动。
    /// let (lock, cvar) = &*pair;
    /// let mut started = lock.lock().unwrap();
    /// loop {
    ///     // 让我们在 condvar 的等待上设置超时。
    ///     let result = cvar.wait_timeout(started, Duration::from_millis(10)).unwrap();
    ///     // 10 毫秒已过去,或者值已更改!
    ///     started = result.0;
    ///     if *started == true {
    ///         // 我们已收到通知,并且值已更新,我们可以离开。
    ///         break
    ///     }
    /// }
    /// ```
    ///
    #[stable(feature = "wait_timeout", since = "1.5.0")]
    pub fn timed_out(&self) -> bool {
        self.0
    }
}

/// 条件变量
///
/// 条件变量表示阻塞线程的能力,以使线程在等待事件发生时不占用任何 CPU 时间。
/// 条件变量通常与布尔谓词 (条件) 和互斥锁相关联。
/// 在确定线程必须阻塞之前,始终在互斥锁内部验证该谓词。
///
/// 此模块中的函数将阻止当前的执行线程。
/// 请注意,对同一条件变量使用多个互斥锁的任何尝试都可能导致运行时 panic。
///
/// # Examples
///
/// ```
/// use std::sync::{Arc, Mutex, Condvar};
/// use std::thread;
///
/// let pair = Arc::new((Mutex::new(false), Condvar::new()));
/// let pair2 = Arc::clone(&pair);
///
/// // 在我们的锁内部,spawn 有一个新线程,然后等待它启动。
/// thread::spawn(move|| {
///     let (lock, cvar) = &*pair2;
///     let mut started = lock.lock().unwrap();
///     *started = true;
///     // 我们通知 condvar 值已更改。
///     cvar.notify_one();
/// });
///
/// // 等待线程启动。
/// let (lock, cvar) = &*pair;
/// let mut started = lock.lock().unwrap();
/// while !*started {
///     started = cvar.wait(started).unwrap();
/// }
/// ```
///
///
///
#[stable(feature = "rust1", since = "1.0.0")]
pub struct Condvar {
    inner: sys::Condvar,
}

impl Condvar {
    /// 创建一个新的条件变量,可以随时等待它并通知它。
    ///
    ///
    /// # Examples
    ///
    /// ```
    /// use std::sync::Condvar;
    ///
    /// let condvar = Condvar::new();
    /// ```
    #[stable(feature = "rust1", since = "1.0.0")]
    pub fn new() -> Condvar {
        Condvar { inner: sys::Condvar::new() }
    }

    /// 阻塞当前线程,直到此条件变量收到通知为止。
    ///
    /// 该函数将自动解锁指定的互斥锁 (由 `guard` 表示) 并阻塞当前线程。
    /// 这意味着在互斥锁解锁后逻辑上发生的任何对 [`notify_one`] 或 [`notify_all`] 的调用都可以唤醒该线程。
    /// 当此函数调用返回时,将重新获得指定的锁。
    ///
    /// 请注意,此函数易受虚假唤醒的影响。
    /// 条件变量通常具有与之关联的布尔谓词,并且每次此函数返回时都必须始终检查谓词,以防止虚假唤醒。
    ///
    ///
    /// # Errors
    ///
    /// 如果正在等待的互斥锁在此线程重新获取锁时中毒,则此函数将返回错误。
    /// 有关更多信息,请参见有关 [`Mutex`] 类型的 [poisoning] 的信息。
    ///
    /// # Panics
    ///
    /// 如果长时间使用此函数与多个互斥锁,则该函数可能为 [`panic!`]。
    ///
    /// [`notify_one`]: Self::notify_one
    /// [`notify_all`]: Self::notify_all
    /// [poisoning]: super::Mutex#poisoning
    /// [`Mutex`]: super::Mutex
    ///
    /// # Examples
    ///
    /// ```
    /// use std::sync::{Arc, Mutex, Condvar};
    /// use std::thread;
    ///
    /// let pair = Arc::new((Mutex::new(false), Condvar::new()));
    /// let pair2 = Arc::clone(&pair);
    ///
    /// thread::spawn(move|| {
    ///     let (lock, cvar) = &*pair2;
    ///     let mut started = lock.lock().unwrap();
    ///     *started = true;
    ///     // 我们通知 condvar 值已更改。
    ///     cvar.notify_one();
    /// });
    ///
    /// // 等待线程启动。
    /// let (lock, cvar) = &*pair;
    /// let mut started = lock.lock().unwrap();
    /// // 只要 `Mutex<bool>` 内部的值为 `false`,我们就等待。
    /// while !*started {
    ///     started = cvar.wait(started).unwrap();
    /// }
    /// ```
    ///
    ///
    ///
    ///
    ///
    ///
    #[stable(feature = "rust1", since = "1.0.0")]
    pub fn wait<'a, T>(&self, guard: MutexGuard<'a, T>) -> LockResult<MutexGuard<'a, T>> {
        let poisoned = unsafe {
            let lock = mutex::guard_lock(&guard);
            self.inner.wait(lock);
            mutex::guard_poison(&guard).get()
        };
        if poisoned { Err(PoisonError::new(guard)) } else { Ok(guard) }
    }

    /// 阻止当前线程,直到此条件变量接收到通知并且所提供的条件为 false 为止。
    ///
    /// 该函数将自动解锁指定的互斥锁 (由 `guard` 表示) 并阻塞当前线程。
    /// 这意味着在互斥锁解锁后逻辑上发生的任何对 [`notify_one`] 或 [`notify_all`] 的调用都可以唤醒该线程。
    ///
    /// 当此函数调用返回时,将重新获得指定的锁。
    ///
    /// # Errors
    ///
    /// 如果正在等待的互斥锁在此线程重新获取锁时中毒,则此函数将返回错误。
    /// 有关更多信息,请参见有关 [`Mutex`] 类型的 [poisoning] 的信息。
    ///
    /// [`notify_one`]: Self::notify_one
    /// [`notify_all`]: Self::notify_all
    /// [poisoning]: super::Mutex#poisoning
    /// [`Mutex`]: super::Mutex
    ///
    /// # Examples
    ///
    /// ```
    /// use std::sync::{Arc, Mutex, Condvar};
    /// use std::thread;
    ///
    /// let pair = Arc::new((Mutex::new(true), Condvar::new()));
    /// let pair2 = Arc::clone(&pair);
    ///
    /// thread::spawn(move|| {
    ///     let (lock, cvar) = &*pair2;
    ///     let mut pending = lock.lock().unwrap();
    ///     *pending = false;
    ///     // 我们通知 condvar 值已更改。
    ///     cvar.notify_one();
    /// });
    ///
    /// // 等待线程启动。
    /// let (lock, cvar) = &*pair;
    /// // 只要 `Mutex<bool>` 内部的值为 `true`,我们就等待。
    /// let _guard = cvar.wait_while(lock.lock().unwrap(), |pending| { *pending }).unwrap();
    /// ```
    ///
    ///
    ///
    #[stable(feature = "wait_until", since = "1.42.0")]
    pub fn wait_while<'a, T, F>(
        &self,
        mut guard: MutexGuard<'a, T>,
        mut condition: F,
    ) -> LockResult<MutexGuard<'a, T>>
    where
        F: FnMut(&mut T) -> bool,
    {
        while condition(&mut *guard) {
            guard = self.wait(guard)?;
        }
        Ok(guard)
    }

    /// 等待此条件变量以获取通知,并在指定的持续时间后超时。
    ///
    /// 该函数的语义与 [`wait`] 等效,除了线程被阻塞的时间大约不超过 `ms` 毫秒。
    /// 由于诸如抢占或平台差异之类的异常可能不会导致等待的最大时间精确为 `ms`,因此此方法不应用于精确的计时。
    ///
    ///
    /// 请注意,已尽最大努力确保使用单调时钟来测量等待的时间,并且不受系统时间更改的影响。
    ///
    /// 仅当已知超时已经过去时,返回的布尔值为 `false`。
    ///
    /// 与 [`wait`] 一样,无论是否经过超时,都将在此函数返回时重新获取指定的锁。
    ///
    /// [`wait`]: Self::wait
    ///
    /// # Examples
    ///
    /// ```
    /// use std::sync::{Arc, Mutex, Condvar};
    /// use std::thread;
    ///
    /// let pair = Arc::new((Mutex::new(false), Condvar::new()));
    /// let pair2 = Arc::clone(&pair);
    ///
    /// thread::spawn(move|| {
    ///     let (lock, cvar) = &*pair2;
    ///     let mut started = lock.lock().unwrap();
    ///     *started = true;
    ///     // 我们通知 condvar 值已更改。
    ///     cvar.notify_one();
    /// });
    ///
    /// // 等待线程启动。
    /// let (lock, cvar) = &*pair;
    /// let mut started = lock.lock().unwrap();
    /// // 只要 `Mutex<bool>` 内部的值为 `false`,我们就等待。
    /// loop {
    ///     let result = cvar.wait_timeout_ms(started, 10).unwrap();
    ///     // 10 毫秒已过去,或者值已更改!
    ///     started = result.0;
    ///     if *started == true {
    ///         // 我们已收到通知,并且值已更新,我们可以离开。
    ///         break
    ///     }
    /// }
    /// ```
    ///
    ///
    ///
    ///
    ///
    ///
    ///
    ///
    #[stable(feature = "rust1", since = "1.0.0")]
    #[rustc_deprecated(since = "1.6.0", reason = "replaced by `std::sync::Condvar::wait_timeout`")]
    pub fn wait_timeout_ms<'a, T>(
        &self,
        guard: MutexGuard<'a, T>,
        ms: u32,
    ) -> LockResult<(MutexGuard<'a, T>, bool)> {
        let res = self.wait_timeout(guard, Duration::from_millis(ms as u64));
        poison::map_result(res, |(a, b)| (a, !b.timed_out()))
    }

    /// 等待此条件变量以获取通知,并在指定的持续时间后超时。
    ///
    /// 该函数的语义与 [`wait`] 等效,除了线程被阻塞的时间不超过 `dur`。
    /// 由于诸如抢占或平台差异之类的异常可能不会导致等待的最大时间精确为 `dur`,因此此方法不应用于精确的计时。
    ///
    ///
    /// 请注意,已尽最大努力确保使用单调时钟来测量等待的时间,并且不受系统时间更改的影响。
    /// 此函数易受虚假唤醒的影响。
    /// 条件变量通常具有与之关联的布尔谓词,并且每次此函数返回时都必须始终检查谓词,以防止虚假唤醒。
    /// 另外,尽管有虚假的唤醒,但通常还是希望超时不超过某个持续时间,因此睡眠时间会减少睡眠量。
    /// 或者,在谓词为 true 时,使用 `wait_timeout_while` 方法等待超时。
    ///
    /// 返回的 [`WaitTimeoutResult`] 值指示是否已知超时。
    ///
    /// 与 [`wait`] 一样,无论是否经过超时,都将在此函数返回时重新获取指定的锁。
    ///
    /// [`wait`]: Self::wait
    /// [`wait_timeout_while`]: Self::wait_timeout_while
    ///
    /// # Examples
    ///
    /// ```
    /// use std::sync::{Arc, Mutex, Condvar};
    /// use std::thread;
    /// use std::time::Duration;
    ///
    /// let pair = Arc::new((Mutex::new(false), Condvar::new()));
    /// let pair2 = Arc::clone(&pair);
    ///
    /// thread::spawn(move|| {
    ///     let (lock, cvar) = &*pair2;
    ///     let mut started = lock.lock().unwrap();
    ///     *started = true;
    ///     // 我们通知 condvar 值已更改。
    ///     cvar.notify_one();
    /// });
    ///
    /// // 等待线程启动
    /// let (lock, cvar) = &*pair;
    /// let mut started = lock.lock().unwrap();
    /// // 只要 `Mutex<bool>` 内的值为 `false`,我们就等待
    /// loop {
    ///     let result = cvar.wait_timeout(started, Duration::from_millis(10)).unwrap();
    ///     // 10 毫秒已过去,或者值已更改!
    ///     started = result.0;
    ///     if *started == true {
    ///         // 我们已收到通知,并且值已更新,我们可以离开。
    ///         break
    ///     }
    /// }
    /// ```
    ///
    ///
    ///
    ///
    ///
    ///
    ///
    ///
    ///
    ///
    #[stable(feature = "wait_timeout", since = "1.5.0")]
    pub fn wait_timeout<'a, T>(
        &self,
        guard: MutexGuard<'a, T>,
        dur: Duration,
    ) -> LockResult<(MutexGuard<'a, T>, WaitTimeoutResult)> {
        let (poisoned, result) = unsafe {
            let lock = mutex::guard_lock(&guard);
            let success = self.inner.wait_timeout(lock, dur);
            (mutex::guard_poison(&guard).get(), WaitTimeoutResult(!success))
        };
        if poisoned { Err(PoisonError::new((guard, result))) } else { Ok((guard, result)) }
    }

    /// 等待此条件变量以获取通知,并在指定的持续时间后超时。
    ///
    /// 该函数的语义与 [`wait_while`] 等效,除了线程被阻塞的时间不超过 `dur`。
    /// 由于诸如抢占或平台差异之类的异常可能不会导致等待的最大时间精确为 `dur`,因此此方法不应用于精确的计时。
    ///
    ///
    /// 请注意,已尽最大努力确保使用单调时钟来测量等待的时间,并且不受系统时间更改的影响。
    ///
    /// 返回的 [`WaitTimeoutResult`] 值指示是否已知超时已经过去,而没有满足条件。
    ///
    /// 与 [`wait_while`] 一样,无论是否经过超时,都将在此函数返回时重新获取指定的锁。
    ///
    /// [`wait_while`]: Self::wait_while
    /// [`wait_timeout`]: Self::wait_timeout
    ///
    /// # Examples
    ///
    /// ```
    /// use std::sync::{Arc, Mutex, Condvar};
    /// use std::thread;
    /// use std::time::Duration;
    ///
    /// let pair = Arc::new((Mutex::new(true), Condvar::new()));
    /// let pair2 = Arc::clone(&pair);
    ///
    /// thread::spawn(move|| {
    ///     let (lock, cvar) = &*pair2;
    ///     let mut pending = lock.lock().unwrap();
    ///     *pending = false;
    ///     // 我们通知 condvar 值已更改。
    ///     cvar.notify_one();
    /// });
    ///
    /// // 等待线程启动
    /// let (lock, cvar) = &*pair;
    /// let result = cvar.wait_timeout_while(
    ///     lock.lock().unwrap(),
    ///     Duration::from_millis(100),
    ///     |&mut pending| pending,
    /// ).unwrap();
    /// if result.1.timed_out() {
    ///     // 超时,条件永远不会为假。
    /// }
    /// // 通过 result.0 访问锁定的互斥锁
    /// ```
    ///
    ///
    ///
    ///
    ///
    ///
    ///
    #[stable(feature = "wait_timeout_until", since = "1.42.0")]
    pub fn wait_timeout_while<'a, T, F>(
        &self,
        mut guard: MutexGuard<'a, T>,
        dur: Duration,
        mut condition: F,
    ) -> LockResult<(MutexGuard<'a, T>, WaitTimeoutResult)>
    where
        F: FnMut(&mut T) -> bool,
    {
        let start = Instant::now();
        loop {
            if !condition(&mut *guard) {
                return Ok((guard, WaitTimeoutResult(false)));
            }
            let timeout = match dur.checked_sub(start.elapsed()) {
                Some(timeout) => timeout,
                None => return Ok((guard, WaitTimeoutResult(true))),
            };
            guard = self.wait_timeout(guard, timeout)?.0;
        }
    }

    /// 在此 condvar 上唤醒一个阻塞的线程。
    ///
    /// 如果此条件变量上有阻塞的线程,则它将从其调用中唤醒到 [`wait`] 或 [`wait_timeout`]。
    /// 不会以任何方式缓冲对 `notify_one` 的调用。
    ///
    /// 要唤醒所有线程,请参见 [`notify_all`]。
    ///
    /// [`wait`]: Self::wait
    /// [`wait_timeout`]: Self::wait_timeout
    /// [`notify_all`]: Self::notify_all
    ///
    /// # Examples
    ///
    /// ```
    /// use std::sync::{Arc, Mutex, Condvar};
    /// use std::thread;
    ///
    /// let pair = Arc::new((Mutex::new(false), Condvar::new()));
    /// let pair2 = Arc::clone(&pair);
    ///
    /// thread::spawn(move|| {
    ///     let (lock, cvar) = &*pair2;
    ///     let mut started = lock.lock().unwrap();
    ///     *started = true;
    ///     // 我们通知 condvar 值已更改。
    ///     cvar.notify_one();
    /// });
    ///
    /// // 等待线程启动。
    /// let (lock, cvar) = &*pair;
    /// let mut started = lock.lock().unwrap();
    /// // 只要 `Mutex<bool>` 内部的值为 `false`,我们就等待。
    /// while !*started {
    ///     started = cvar.wait(started).unwrap();
    /// }
    /// ```
    ///
    #[stable(feature = "rust1", since = "1.0.0")]
    pub fn notify_one(&self) {
        self.inner.notify_one()
    }

    /// 唤醒此 condvar 上的所有阻塞线程。
    ///
    /// 此方法将确保唤醒条件变量上的所有当前侍者。
    /// 不会以任何方式缓冲对 `notify_all()` 的调用。
    ///
    /// 要仅唤醒一个线程,请参见 [`notify_one`]。
    ///
    /// [`notify_one`]: Self::notify_one
    ///
    /// # Examples
    ///
    /// ```
    /// use std::sync::{Arc, Mutex, Condvar};
    /// use std::thread;
    ///
    /// let pair = Arc::new((Mutex::new(false), Condvar::new()));
    /// let pair2 = Arc::clone(&pair);
    ///
    /// thread::spawn(move|| {
    ///     let (lock, cvar) = &*pair2;
    ///     let mut started = lock.lock().unwrap();
    ///     *started = true;
    ///     // 我们通知 condvar 值已更改。
    ///     cvar.notify_all();
    /// });
    ///
    /// // 等待线程启动。
    /// let (lock, cvar) = &*pair;
    /// let mut started = lock.lock().unwrap();
    /// // 只要 `Mutex<bool>` 内部的值为 `false`,我们就等待。
    /// while !*started {
    ///     started = cvar.wait(started).unwrap();
    /// }
    /// ```
    ///
    #[stable(feature = "rust1", since = "1.0.0")]
    pub fn notify_all(&self) {
        self.inner.notify_all()
    }
}

#[stable(feature = "std_debug", since = "1.16.0")]
impl fmt::Debug for Condvar {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("Condvar").finish_non_exhaustive()
    }
}

#[stable(feature = "condvar_default", since = "1.10.0")]
impl Default for Condvar {
    /// 创建一个 `Condvar`,可以等待它并通知它。
    fn default() -> Condvar {
        Condvar::new()
    }
}