libreoffice-online/common/Watchdog.hpp
Caolán McNamara 038e278b03 bump watchdog pings from 20ms to 50ms
Signed-off-by: Caolán McNamara <caolan.mcnamara@collabora.com>
Change-Id: Ib1add9a1e392e96ad9f92feffd518b92aeb6a81c
2024-04-30 17:55:13 +02:00

132 lines
3.4 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
/*
* Copyright the Collabora Online contributors.
*
* SPDX-License-Identifier: MPL-2.0
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
#pragma once
#include <thread>
#include <chrono>
#include <mutex>
#include <csignal>
#include <condition_variable>
extern "C"
{
void handleUserProfileSignal(const int /* signal */);
}
/*
* A class to watch to see when threads are not making progress.
*/
class Watchdog : private std::thread
{
std::atomic<bool> _exit;
std::unique_ptr<std::thread> _thread;
std::mutex _lock;
std::condition_variable _condition;
typedef std::pair<std::atomic<uint64_t>*,int *> WatchDetail;
std::vector<WatchDetail> _times;
static const uint64_t MsToTrigger = 100;
public:
Watchdog()
{
startThread();
// Steal SIGUSR2 from the backtrace handler for profiling
struct sigaction action;
sigemptyset(&action.sa_mask);
action.sa_flags = 0;
action.sa_handler = handleUserProfileSignal;
sigaction(SIGUSR2, &action, nullptr);
}
~Watchdog()
{
if (_thread)
joinThread();
}
static uint64_t getDisableStamp() { return 0; }
static uint64_t getTimestamp()
{
return std::chrono::duration_cast<std::chrono::milliseconds>(
std::chrono::steady_clock::now().time_since_epoch())
.count();
}
void startThread()
{
assert(!_thread);
_exit = false;
_thread.reset(new std::thread(&Watchdog::checkTime, this));
}
void joinThread()
{
if (_thread)
{
_exit = true;
_condition.notify_all();
_thread->join();
_thread.reset();
}
}
void checkTime()
{
std::unique_lock<std::mutex> guard(_lock);
while (!_exit)
{
{
uint64_t msSinceEpoc = getTimestamp();
for (auto d : _times)
{
uint64_t snapshot = *d.first; // one atomic read
if (snapshot == 0) // sleeping / polling
continue;
// out of the poll for longer than threshold:
if (msSinceEpoc - snapshot > MsToTrigger)
{
// Signal the poorly behaved thread to profile it
Util::killThreadById(*d.second, SIGUSR2);
break;
}
}
}
_condition.wait_for(guard, std::chrono::milliseconds(50));
}
}
void addTime(std::atomic<uint64_t> *timeRef, int *threadIdRef)
{
std::lock_guard<std::mutex> guard(_lock);
_times.push_back(WatchDetail(timeRef, threadIdRef));
}
void removeTime(std::atomic<uint64_t> *timeRef)
{
std::lock_guard<std::mutex> guard(_lock);
for (auto it = _times.begin(); it != _times.end(); it++)
{
if (it->first == timeRef)
{
it = _times.erase(it);
return;
}
}
assert("missing time to remove" && false);
}
};
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */