Files
allwpilib/ntcore/src/main/native/cpp/InstanceImpl.cpp
Peter Johnson f8ed2a4d92 [wpiutil] Synchronization: fix shutdown use-after-free (#8213)
Also in ntcore, join the notifier thread on shutdown.
This prevents tsan from reporting it as a leaked thread.
2025-09-08 21:15:00 -07:00

233 lines
6.0 KiB
C++

// Copyright (c) FIRST and other WPILib contributors.
// Open Source Software; you can modify and/or share it under the terms of
// the WPILib BSD license file in the root directory of this project.
#include "InstanceImpl.h"
#include <memory>
#include <string>
#include <utility>
using namespace nt;
std::atomic<int> InstanceImpl::s_default{-1};
std::atomic<InstanceImpl*> InstanceImpl::s_instances[kNumInstances];
wpi::mutex InstanceImpl::s_mutex;
InstanceImpl::Cleanup InstanceImpl::s_cleanup;
using namespace std::placeholders;
InstanceImpl::InstanceImpl(int inst)
: listenerStorage{inst},
logger_impl{listenerStorage},
logger{
std::bind(&LoggerImpl::Log, &logger_impl, _1, _2, _3, _4)}, // NOLINT
connectionList{inst, listenerStorage},
localStorage{inst, listenerStorage, logger},
m_inst{inst} {
logger.set_min_level(logger_impl.GetMinLevel());
}
InstanceImpl* InstanceImpl::GetDefault() {
return Get(GetDefaultIndex());
}
InstanceImpl* InstanceImpl::Get(int inst) {
if (inst < 0 || inst >= kNumInstances) {
return nullptr;
}
return s_instances[inst];
}
int InstanceImpl::GetDefaultIndex() {
int inst = s_default;
if (inst >= 0) {
return inst;
}
// slow path
std::scoped_lock lock(s_mutex);
// double-check
inst = s_default;
if (inst >= 0) {
return inst;
}
// alloc and save
inst = AllocImpl();
s_default = inst;
return inst;
}
int InstanceImpl::Alloc() {
std::scoped_lock lock(s_mutex);
return AllocImpl();
}
int InstanceImpl::AllocImpl() {
int inst = 0;
for (; inst < kNumInstances; ++inst) {
if (!s_instances[inst]) {
s_instances[inst] = new InstanceImpl(inst);
return inst;
}
}
return -1;
}
void InstanceImpl::Destroy(int inst) {
std::scoped_lock lock(s_mutex);
if (inst < 0 || inst >= kNumInstances) {
return;
}
delete s_instances[inst].exchange(nullptr);
}
void InstanceImpl::StartLocal() {
std::scoped_lock lock{m_mutex};
if (networkMode != NT_NET_MODE_NONE) {
return;
}
networkMode = NT_NET_MODE_LOCAL;
}
void InstanceImpl::StopLocal() {
std::scoped_lock lock{m_mutex};
if ((networkMode & NT_NET_MODE_LOCAL) == 0) {
return;
}
networkMode = NT_NET_MODE_NONE;
}
void InstanceImpl::StartServer(std::string_view persistFilename,
std::string_view listenAddress,
unsigned int port) {
std::scoped_lock lock{m_mutex};
if (networkMode != NT_NET_MODE_NONE) {
return;
}
m_networkServer = std::make_shared<NetworkServer>(
persistFilename, listenAddress, port, localStorage, connectionList,
logger, [this] {
std::scoped_lock lock{m_mutex};
networkMode &= ~NT_NET_MODE_STARTING;
});
networkMode = NT_NET_MODE_SERVER | NT_NET_MODE_STARTING;
listenerStorage.NotifyTimeSync({}, NT_EVENT_TIMESYNC, 0, 0, true);
m_serverTimeOffset = 0;
m_rtt2 = 0;
}
void InstanceImpl::StopServer() {
std::shared_ptr<NetworkServer> server;
{
std::scoped_lock lock{m_mutex};
if ((networkMode & NT_NET_MODE_SERVER) == 0) {
return;
}
server = std::move(m_networkServer);
networkMode = NT_NET_MODE_NONE;
listenerStorage.NotifyTimeSync({}, NT_EVENT_TIMESYNC, 0, 0, false);
m_serverTimeOffset.reset();
m_rtt2 = 0;
}
}
void InstanceImpl::StartClient(std::string_view identity) {
std::scoped_lock lock{m_mutex};
if (networkMode != NT_NET_MODE_NONE) {
return;
}
m_networkClient = std::make_shared<NetworkClient>(
m_inst, identity, localStorage, connectionList, logger,
[this](int64_t serverTimeOffset, int64_t rtt2, bool valid) {
std::scoped_lock lock{m_mutex};
listenerStorage.NotifyTimeSync({}, NT_EVENT_TIMESYNC, serverTimeOffset,
rtt2, valid);
if (valid) {
m_serverTimeOffset = serverTimeOffset;
m_rtt2 = rtt2;
} else {
m_serverTimeOffset.reset();
m_rtt2 = 0;
}
});
if (!m_servers.empty()) {
m_networkClient->SetServers(m_servers);
}
networkMode = NT_NET_MODE_CLIENT;
}
void InstanceImpl::StopClient() {
std::shared_ptr<INetworkClient> client;
{
std::scoped_lock lock{m_mutex};
if ((networkMode & NT_NET_MODE_CLIENT) == 0) {
return;
}
client = std::move(m_networkClient);
networkMode = NT_NET_MODE_NONE;
}
client.reset();
{
std::scoped_lock lock{m_mutex};
listenerStorage.NotifyTimeSync({}, NT_EVENT_TIMESYNC, 0, 0, false);
m_serverTimeOffset.reset();
m_rtt2 = 0;
}
}
void InstanceImpl::SetServers(
std::span<const std::pair<std::string, unsigned int>> servers) {
std::scoped_lock lock{m_mutex};
m_servers = {servers.begin(), servers.end()};
if (m_networkClient) {
m_networkClient->SetServers(servers);
}
}
std::shared_ptr<NetworkServer> InstanceImpl::GetServer() {
std::scoped_lock lock{m_mutex};
return m_networkServer;
}
std::shared_ptr<INetworkClient> InstanceImpl::GetClient() {
std::scoped_lock lock{m_mutex};
return m_networkClient;
}
std::optional<int64_t> InstanceImpl::GetServerTimeOffset() {
std::scoped_lock lock{m_mutex};
return m_serverTimeOffset;
}
void InstanceImpl::AddTimeSyncListener(NT_Listener listener,
unsigned int eventMask) {
std::scoped_lock lock{m_mutex};
eventMask &= (NT_EVENT_TIMESYNC | NT_EVENT_IMMEDIATE);
listenerStorage.Activate(listener, eventMask);
if ((eventMask & (NT_EVENT_TIMESYNC | NT_EVENT_IMMEDIATE)) ==
(NT_EVENT_TIMESYNC | NT_EVENT_IMMEDIATE) &&
m_serverTimeOffset) {
listenerStorage.NotifyTimeSync({&listener, 1},
NT_EVENT_TIMESYNC | NT_EVENT_IMMEDIATE,
*m_serverTimeOffset, m_rtt2, true);
}
}
void InstanceImpl::Reset() {
std::scoped_lock lock{m_mutex};
m_networkServer.reset();
m_networkClient.reset();
m_servers.clear();
networkMode = NT_NET_MODE_NONE;
m_serverTimeOffset.reset();
m_rtt2 = 0;
listenerStorage.Reset();
// connectionList should have been cleared by destroying networkClient/server
localStorage.Reset();
}