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
|
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "base/threading/watchdog.h"
#include "base/compiler_specific.h"
#include "base/logging.h"
#include "base/no_destructor.h"
#include "base/threading/platform_thread.h"
namespace base {
namespace {
// When the debugger breaks (when we alarm), all the other alarms that are
// armed will expire (also alarm). To diminish this effect, we track any
// delay due to debugger breaks, and we *try* to adjust the effective start
// time of other alarms to step past the debugging break.
// Without this safety net, any alarm will typically trigger a host of follow
// on alarms from callers that specify old times.
struct StaticData {
// Lock for access of static data...
Lock lock;
// When did we last alarm and get stuck (for a while) in a debugger?
TimeTicks last_debugged_alarm_time;
// How long did we sit on a break in the debugger?
TimeDelta last_debugged_alarm_delay;
};
StaticData* GetStaticData() {
static base::NoDestructor<StaticData> static_data;
return static_data.get();
}
} // namespace
// Start thread running in a Disarmed state.
Watchdog::Watchdog(const TimeDelta& duration,
const std::string& thread_watched_name,
bool enabled,
Delegate* delegate)
: enabled_(enabled),
condition_variable_(&lock_),
state_(DISARMED),
duration_(duration),
thread_watched_name_(thread_watched_name),
thread_delegate_(this),
delegate_(delegate) {
if (!enabled_) {
return; // Don't start thread, or doing anything really.
}
enabled_ = PlatformThread::Create(0, // Default stack size.
&thread_delegate_, &handle_);
DCHECK(enabled_);
}
// Notify watchdog thread, and wait for it to finish up.
Watchdog::~Watchdog() {
if (!enabled_) {
return;
}
if (!IsJoinable()) {
Cleanup();
}
PlatformThread::Join(handle_);
}
void Watchdog::Cleanup() {
if (!enabled_) {
return;
}
AutoLock lock(lock_);
state_ = SHUTDOWN;
condition_variable_.Signal();
}
bool Watchdog::IsJoinable() {
if (!enabled_) {
return true;
}
AutoLock lock(lock_);
return (state_ == JOINABLE);
}
void Watchdog::Arm() {
ArmAtStartTime(TimeTicks::Now());
}
void Watchdog::ArmSomeTimeDeltaAgo(const TimeDelta& time_delta) {
ArmAtStartTime(TimeTicks::Now() - time_delta);
}
// Start clock for watchdog.
void Watchdog::ArmAtStartTime(const TimeTicks start_time) {
AutoLock lock(lock_);
start_time_ = start_time;
state_ = ARMED;
// Force watchdog to wake up, and go to sleep with the timer ticking with the
// proper duration.
condition_variable_.Signal();
}
// Disable watchdog so that it won't do anything when time expires.
void Watchdog::Disarm() {
AutoLock lock(lock_);
state_ = DISARMED;
// We don't need to signal, as the watchdog will eventually wake up, and it
// will check its state and time, and act accordingly.
}
void Watchdog::Alarm() {
if (delegate_) {
delegate_->Alarm();
} else {
DefaultAlarm();
}
}
void Watchdog::DefaultAlarm() {
DVLOG(1) << "Watchdog alarmed for " << thread_watched_name_;
}
//------------------------------------------------------------------------------
// Internal private methods that the watchdog thread uses.
void Watchdog::ThreadDelegate::ThreadMain() {
SetThreadName();
TimeDelta remaining_duration;
StaticData* static_data = GetStaticData();
while (true) {
AutoLock lock(watchdog_->lock_);
while (DISARMED == watchdog_->state_) {
watchdog_->condition_variable_.Wait();
}
if (SHUTDOWN == watchdog_->state_) {
watchdog_->state_ = JOINABLE;
return;
}
DCHECK(ARMED == watchdog_->state_);
remaining_duration =
watchdog_->duration_ - (TimeTicks::Now() - watchdog_->start_time_);
if (remaining_duration.InMilliseconds() > 0) {
// Spurios wake? Timer drifts? Go back to sleep for remaining time.
watchdog_->condition_variable_.TimedWait(remaining_duration);
continue;
}
// We overslept, so this seems like a real alarm.
// Watch out for a user that stopped the debugger on a different alarm!
{
AutoLock static_lock(static_data->lock);
if (static_data->last_debugged_alarm_time > watchdog_->start_time_) {
// False alarm: we started our clock before the debugger break (last
// alarm time).
watchdog_->start_time_ += static_data->last_debugged_alarm_delay;
if (static_data->last_debugged_alarm_time > watchdog_->start_time_) {
// Too many alarms must have taken place.
watchdog_->state_ = DISARMED;
}
continue;
}
}
watchdog_->state_ = DISARMED; // Only alarm at most once.
TimeTicks last_alarm_time = TimeTicks::Now();
{
AutoUnlock unlock(watchdog_->lock_);
watchdog_->Alarm(); // Set a break point here to debug on alarms.
}
TimeDelta last_alarm_delay = TimeTicks::Now() - last_alarm_time;
if (last_alarm_delay <= Milliseconds(2)) {
continue;
}
// Ignore race of two alarms/breaks going off at roughly the same time.
AutoLock static_lock(static_data->lock);
// This was a real debugger break.
static_data->last_debugged_alarm_time = last_alarm_time;
static_data->last_debugged_alarm_delay = last_alarm_delay;
}
}
void Watchdog::ThreadDelegate::SetThreadName() const {
std::string name = watchdog_->thread_watched_name_ + " Watchdog";
PlatformThread::SetName(name);
DVLOG(1) << "Watchdog active: " << name;
}
// static
void Watchdog::ResetStaticData() {
StaticData* static_data = GetStaticData();
AutoLock lock(static_data->lock);
// See https://crbug.com/734232 for why this cannot be zero-initialized.
static_data->last_debugged_alarm_time = TimeTicks::Min();
static_data->last_debugged_alarm_delay = TimeDelta();
}
} // namespace base
|