Avi Drissman | 6459548 | 2022-09-14 20:52:29 | [diff] [blame] | 1 | // Copyright 2012 The Chromium Authors |
rch | 16c74d1d | 2016-04-22 06:14:07 | [diff] [blame] | 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
Ryan Hamilton | a3ee93a7 | 2018-08-01 22:03:08 | [diff] [blame] | 5 | #include "net/quic/quic_chromium_alarm_factory.h" |
rch | 16c74d1d | 2016-04-22 06:14:07 | [diff] [blame] | 6 | |
Hans Wennborg | 0924470b | 2020-04-27 21:08:05 | [diff] [blame] | 7 | #include "base/check.h" |
Avi Drissman | 41c4a41 | 2023-01-11 22:45:37 | [diff] [blame^] | 8 | #include "base/functional/bind.h" |
rch | 16c74d1d | 2016-04-22 06:14:07 | [diff] [blame] | 9 | #include "base/location.h" |
Keishi Hattori | 0e45c02 | 2021-11-27 09:25:52 | [diff] [blame] | 10 | #include "base/memory/raw_ptr.h" |
Sean Maher | e672a66 | 2023-01-09 21:42:28 | [diff] [blame] | 11 | #include "base/task/sequenced_task_runner.h" |
Francois Doray | c30a2d0 | 2021-06-18 21:36:01 | [diff] [blame] | 12 | #include "base/time/tick_clock.h" |
rch | 16c74d1d | 2016-04-22 06:14:07 | [diff] [blame] | 13 | #include "base/time/time.h" |
Francois Doray | c30a2d0 | 2021-06-18 21:36:01 | [diff] [blame] | 14 | #include "base/timer/timer.h" |
| 15 | #include "net/quic/platform/impl/quic_chromium_clock.h" |
rch | 16c74d1d | 2016-04-22 06:14:07 | [diff] [blame] | 16 | |
| 17 | namespace net { |
| 18 | |
| 19 | namespace { |
| 20 | |
Francois Doray | c30a2d0 | 2021-06-18 21:36:01 | [diff] [blame] | 21 | class QuicChromeAlarm : public quic::QuicAlarm, public base::TickClock { |
rch | 16c74d1d | 2016-04-22 06:14:07 | [diff] [blame] | 22 | public: |
Ryan Hamilton | 8d9ee76e | 2018-05-29 23:52:52 | [diff] [blame] | 23 | QuicChromeAlarm(const quic::QuicClock* clock, |
Francois Doray | c30a2d0 | 2021-06-18 21:36:01 | [diff] [blame] | 24 | base::SequencedTaskRunner* task_runner, |
Ryan Hamilton | 8d9ee76e | 2018-05-29 23:52:52 | [diff] [blame] | 25 | quic::QuicArenaScopedPtr<quic::QuicAlarm::Delegate> delegate) |
| 26 | : quic::QuicAlarm(std::move(delegate)), |
rch | 16c74d1d | 2016-04-22 06:14:07 | [diff] [blame] | 27 | clock_(clock), |
Francois Doray | c30a2d0 | 2021-06-18 21:36:01 | [diff] [blame] | 28 | // Unretained is safe because base::OneShotTimer never runs its task |
| 29 | // after being deleted. |
| 30 | on_alarm_callback_(base::BindRepeating(&QuicChromeAlarm::OnAlarm, |
| 31 | base::Unretained(this))), |
| 32 | timer_(std::make_unique<base::OneShotTimer>(this)) { |
| 33 | timer_->SetTaskRunner(task_runner); |
| 34 | } |
rch | 16c74d1d | 2016-04-22 06:14:07 | [diff] [blame] | 35 | |
| 36 | protected: |
| 37 | void SetImpl() override { |
| 38 | DCHECK(deadline().IsInitialized()); |
Francois Doray | c30a2d0 | 2021-06-18 21:36:01 | [diff] [blame] | 39 | const int64_t delay_us = (deadline() - clock_->Now()).ToMicroseconds(); |
Peter Kasting | e5a38ed | 2021-10-02 03:06:35 | [diff] [blame] | 40 | timer_->Start(FROM_HERE, base::Microseconds(delay_us), on_alarm_callback_); |
rch | 16c74d1d | 2016-04-22 06:14:07 | [diff] [blame] | 41 | } |
| 42 | |
| 43 | void CancelImpl() override { |
| 44 | DCHECK(!deadline().IsInitialized()); |
Francois Doray | c30a2d0 | 2021-06-18 21:36:01 | [diff] [blame] | 45 | timer_->Stop(); |
rch | 16c74d1d | 2016-04-22 06:14:07 | [diff] [blame] | 46 | } |
| 47 | |
| 48 | private: |
| 49 | void OnAlarm() { |
Francois Doray | c30a2d0 | 2021-06-18 21:36:01 | [diff] [blame] | 50 | DCHECK(deadline().IsInitialized()); |
rch | 16c74d1d | 2016-04-22 06:14:07 | [diff] [blame] | 51 | |
Francois Doray | c30a2d0 | 2021-06-18 21:36:01 | [diff] [blame] | 52 | // In tests, the time source used by the scheduler may not be in sync with |
| 53 | // |clock_|. Because of this, the scheduler may run this task when |
| 54 | // |clock->Now()| is smaller than |deadline()|. In that case, retry later. |
| 55 | // This shouldn't happen in production. |
rch | 16c74d1d | 2016-04-22 06:14:07 | [diff] [blame] | 56 | if (clock_->Now() < deadline()) { |
| 57 | SetImpl(); |
| 58 | return; |
| 59 | } |
| 60 | |
Francois Doray | c30a2d0 | 2021-06-18 21:36:01 | [diff] [blame] | 61 | DCHECK_LE(deadline(), clock_->Now()); |
rch | 16c74d1d | 2016-04-22 06:14:07 | [diff] [blame] | 62 | Fire(); |
| 63 | } |
| 64 | |
Francois Doray | c30a2d0 | 2021-06-18 21:36:01 | [diff] [blame] | 65 | // base::TickClock: |
| 66 | base::TimeTicks NowTicks() const override { |
| 67 | return quic::QuicChromiumClock::QuicTimeToTimeTicks(clock_->Now()); |
| 68 | } |
| 69 | |
Keishi Hattori | 0e45c02 | 2021-11-27 09:25:52 | [diff] [blame] | 70 | const raw_ptr<const quic::QuicClock> clock_; |
Francois Doray | c30a2d0 | 2021-06-18 21:36:01 | [diff] [blame] | 71 | base::RepeatingClosure on_alarm_callback_; |
| 72 | const std::unique_ptr<base::OneShotTimer> timer_; |
rch | 16c74d1d | 2016-04-22 06:14:07 | [diff] [blame] | 73 | }; |
| 74 | |
| 75 | } // namespace |
| 76 | |
| 77 | QuicChromiumAlarmFactory::QuicChromiumAlarmFactory( |
Francois Doray | c30a2d0 | 2021-06-18 21:36:01 | [diff] [blame] | 78 | base::SequencedTaskRunner* task_runner, |
Ryan Hamilton | 8d9ee76e | 2018-05-29 23:52:52 | [diff] [blame] | 79 | const quic::QuicClock* clock) |
Jeremy Roman | d54000b2 | 2019-07-08 18:40:16 | [diff] [blame] | 80 | : task_runner_(task_runner), clock_(clock) {} |
rch | 16c74d1d | 2016-04-22 06:14:07 | [diff] [blame] | 81 | |
Tsuyoshi Horo | 07c3f0e | 2022-06-16 07:30:47 | [diff] [blame] | 82 | QuicChromiumAlarmFactory::~QuicChromiumAlarmFactory() = default; |
rch | 16c74d1d | 2016-04-22 06:14:07 | [diff] [blame] | 83 | |
Ryan Hamilton | 8d9ee76e | 2018-05-29 23:52:52 | [diff] [blame] | 84 | quic::QuicArenaScopedPtr<quic::QuicAlarm> QuicChromiumAlarmFactory::CreateAlarm( |
| 85 | quic::QuicArenaScopedPtr<quic::QuicAlarm::Delegate> delegate, |
| 86 | quic::QuicConnectionArena* arena) { |
rch | 16c74d1d | 2016-04-22 06:14:07 | [diff] [blame] | 87 | if (arena != nullptr) { |
| 88 | return arena->New<QuicChromeAlarm>(clock_, task_runner_, |
| 89 | std::move(delegate)); |
| 90 | } else { |
Ryan Hamilton | 8d9ee76e | 2018-05-29 23:52:52 | [diff] [blame] | 91 | return quic::QuicArenaScopedPtr<quic::QuicAlarm>( |
rch | 16c74d1d | 2016-04-22 06:14:07 | [diff] [blame] | 92 | new QuicChromeAlarm(clock_, task_runner_, std::move(delegate))); |
| 93 | } |
| 94 | } |
| 95 | |
Ryan Hamilton | 8d9ee76e | 2018-05-29 23:52:52 | [diff] [blame] | 96 | quic::QuicAlarm* QuicChromiumAlarmFactory::CreateAlarm( |
| 97 | quic::QuicAlarm::Delegate* delegate) { |
| 98 | return new QuicChromeAlarm( |
| 99 | clock_, task_runner_, |
| 100 | quic::QuicArenaScopedPtr<quic::QuicAlarm::Delegate>(delegate)); |
rch | 16c74d1d | 2016-04-22 06:14:07 | [diff] [blame] | 101 | } |
| 102 | |
| 103 | } // namespace net |