pimhwang
/
qTox
mirror of https://github.com/qTox/qTox.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

refactor(bootstrap): Use std::shuffle instead of custom not fully random logic 

Simplifies logic and naming.
reviewable/pr6453/r2
Anthony Bilinski 4 years ago
parent
bf6d01598f
commit
aeb8a9aca1
No known key found for this signature in database
GPG Key ID: 2AA8E0DA1B31FB3C
9 changed files with 48 additions and 47 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 48
      src/core/core.cpp
  2. 8
      src/core/core.h
  3. 19
      src/core/toxoptions.cpp
  4. 2
      src/core/toxoptions.h
  5. 2
      src/model/ibootstraplistgenerator.h
  6. 2
      src/net/bootstrapnodeupdater.cpp
  7. 2
      src/net/bootstrapnodeupdater.h
  8. 2
      src/persistence/profile.cpp
  9. 10
      test/core/core_test.cpp

48
src/core/core.cpp
Unescape View File

@ -42,6 +42,7 @@
#include <QStringBuilder> #include <QStringBuilder>
#include <QTimer> #include <QTimer>
#include <algorithm>
#include <cassert> #include <cassert>
#include <chrono> #include <chrono>
#include <memory> #include <memory>
@ -473,13 +474,21 @@ bool parseErr(Tox_Err_Conference_Delete error, int line)
} }
} }
QList<DhtServer> shuffleBootstrapNodes(QList<DhtServer> bootstrapNodes)
{
std::mt19937 rng(std::chrono::high_resolution_clock::now().time_since_epoch().count());
std::shuffle(bootstrapNodes.begin(), bootstrapNodes.end(), rng);
return bootstrapNodes;
}
} // namespace } // namespace
Core::Core(QThread* coreThread, IBootstrapListGenerator& _bootstrapNodes) Core::Core(QThread* coreThread, IBootstrapListGenerator& _bootstrapListGenerator, const ICoreSettings& _settings)
: tox(nullptr) : tox(nullptr)
, toxTimer{new QTimer{this}} , toxTimer{new QTimer{this}}
, coreThread(coreThread) , coreThread(coreThread)
, bootstrapNodes(_bootstrapNodes) , bootstrapListGenerator(_bootstrapListGenerator)
, settings(_settings)
{ {
assert(toxTimer); assert(toxTimer);
toxTimer->setSingleShot(true); toxTimer->setSingleShot(true);
@ -527,7 +536,7 @@ void Core::registerCallbacks(Tox* tox)
* @param settings Settings specific to Core * @param settings Settings specific to Core
* @return nullptr or a Core object ready to start * @return nullptr or a Core object ready to start
*/ */
ToxCorePtr Core::makeToxCore(const QByteArray& savedata, const ICoreSettings* const settings, ToxCorePtr Core::makeToxCore(const QByteArray& savedata, const ICoreSettings& settings,
IBootstrapListGenerator& bootstrapNodes, ToxCoreErrors* err) IBootstrapListGenerator& bootstrapNodes, ToxCoreErrors* err)
{ {
QThread* thread = new QThread(); QThread* thread = new QThread();
@ -546,7 +555,7 @@ ToxCorePtr Core::makeToxCore(const QByteArray& savedata, const ICoreSettings* co
return {}; return {};
} }
ToxCorePtr core(new Core(thread, bootstrapNodes)); ToxCorePtr core(new Core(thread, bootstrapNodes, settings));
if (core == nullptr) { if (core == nullptr) {
if (err) { if (err) {
*err = ToxCoreErrors::ERROR_ALLOC; *err = ToxCoreErrors::ERROR_ALLOC;
@ -813,31 +822,30 @@ void Core::bootstrapDht()
{ {
ASSERT_CORE_THREAD; ASSERT_CORE_THREAD;
QList<DhtServer> bootstrapNodesList = bootstrapNodes.getBootstrapnodes();
int listSize = bootstrapNodesList.size(); auto const shuffledBootstrapNodes = shuffleBootstrapNodes(bootstrapListGenerator.getBootstrapnodes());
if (!listSize) { if (shuffledBootstrapNodes.empty()) {
qWarning() << "No bootstrap node list"; qWarning() << "No bootstrap node list";
return; return;
} }
int i = 0;
std::mt19937 rng(std::chrono::high_resolution_clock::now().time_since_epoch().count());
std::uniform_int_distribution<int> distribution(0, listSize - 1);
static int j = distribution(rng);
// i think the more we bootstrap, the more we jitter because the more we overwrite nodes // i think the more we bootstrap, the more we jitter because the more we overwrite nodes
while (i < 2) { auto numNewNodes = 2;
const DhtServer& dhtServer = bootstrapNodesList[j % listSize]; for (int i = 0; i < numNewNodes && i < shuffledBootstrapNodes.size(); ++i) {
qDebug("Connecting to bootstrap node %d", j % listSize); const auto& dhtServer = shuffledBootstrapNodes.at(i);
QByteArray address; QByteArray address;
if (dhtServer.ipv4.isEmpty() && !dhtServer.ipv6.isEmpty()) { if (!dhtServer.ipv4.isEmpty()) {
address = dhtServer.ipv4.toLatin1();
} else if (!dhtServer.ipv6.isEmpty() && settings.getEnableIPv6()) {
address = dhtServer.ipv6.toLatin1(); address = dhtServer.ipv6.toLatin1();
} else { } else {
address = dhtServer.ipv4.toLatin1(); ++numNewNodes;
continue;
} }
const uint8_t* pkPtr = dhtServer.publicKey.getData(); ToxPk pk{dhtServer.publicKey};
qDebug() << "Connecting to bootstrap node" << pk.toString();
const uint8_t* pkPtr = pk.getData();
Tox_Err_Bootstrap error; Tox_Err_Bootstrap error;
if (dhtServer.statusUdp) { if (dhtServer.statusUdp) {
@ -850,10 +858,6 @@ void Core::bootstrapDht()
tox_add_tcp_relay(tox.get(), address.constData(), tcpPort, pkPtr, &error); tox_add_tcp_relay(tox.get(), address.constData(), tcpPort, pkPtr, &error);
PARSE_ERR(error); PARSE_ERR(error);
} }
// bootstrap off every 5th node (+ a special case to avoid cycles when listSize % 5 == 0)
j += 5 + !(listSize % 5);
++i;
} }
} }

8
src/core/core.h
Unescape View File

@ -52,6 +52,7 @@ class GroupInvite;
class Profile; class Profile;
class Core; class Core;
class IBootstrapListGenerator; class IBootstrapListGenerator;
class DhtServer;
using ToxCorePtr = std::unique_ptr<Core>; using ToxCorePtr = std::unique_ptr<Core>;
@ -71,7 +72,7 @@ public:
ERROR_ALLOC ERROR_ALLOC
}; };
static ToxCorePtr makeToxCore(const QByteArray& savedata, const ICoreSettings* const settings, static ToxCorePtr makeToxCore(const QByteArray& savedata, const ICoreSettings& settings,
IBootstrapListGenerator& bootstrapNodes, ToxCoreErrors* err = nullptr); IBootstrapListGenerator& bootstrapNodes, ToxCoreErrors* err = nullptr);
const CoreAV* getAv() const; const CoreAV* getAv() const;
CoreAV* getAv(); CoreAV* getAv();
@ -195,7 +196,7 @@ signals:
void failedToRemoveFriend(uint32_t friendId); void failedToRemoveFriend(uint32_t friendId);
private: private:
Core(QThread* coreThread, IBootstrapListGenerator& _bootstrapNodes); Core(QThread* coreThread, IBootstrapListGenerator& _bootstrapNodes, const ICoreSettings& settings);
static void onFriendRequest(Tox* tox, const uint8_t* cUserId, const uint8_t* cMessage, static void onFriendRequest(Tox* tox, const uint8_t* cUserId, const uint8_t* cMessage,
size_t cMessageSize, void* core); size_t cMessageSize, void* core);
@ -262,5 +263,6 @@ private:
mutable CompatibleRecursiveMutex coreLoopLock; mutable CompatibleRecursiveMutex coreLoopLock;
std::unique_ptr<QThread> coreThread; std::unique_ptr<QThread> coreThread;
IBootstrapListGenerator& bootstrapNodes; const IBootstrapListGenerator& bootstrapListGenerator;
const ICoreSettings& settings;
}; };

19
src/core/toxoptions.cpp
Unescape View File

@ -67,7 +67,7 @@ ToxOptions::operator Tox_Options*()
* @return ToxOptions instance initialized to create Tox instance * @return ToxOptions instance initialized to create Tox instance
*/ */
std::unique_ptr<ToxOptions> ToxOptions::makeToxOptions(const QByteArray& savedata, std::unique_ptr<ToxOptions> ToxOptions::makeToxOptions(const QByteArray& savedata,
const ICoreSettings* s) const ICoreSettings& s)
{ {
Tox_Options* tox_opts = tox_options_new(nullptr); Tox_Options* tox_opts = tox_options_new(nullptr);
@ -77,7 +77,7 @@ std::unique_ptr<ToxOptions> ToxOptions::makeToxOptions(const QByteArray& savedat
} }
// need to init proxyAddr here, because we need it to construct ToxOptions // need to init proxyAddr here, because we need it to construct ToxOptions
const QString proxyAddr = s == nullptr ? QString{} : s->getProxyAddr(); const QString proxyAddr = s.getProxyAddr();
auto toxOptions = std::unique_ptr<ToxOptions>(new ToxOptions(tox_opts, proxyAddr.toUtf8())); auto toxOptions = std::unique_ptr<ToxOptions>(new ToxOptions(tox_opts, proxyAddr.toUtf8()));
// register log first, to get messages as early as possible // register log first, to get messages as early as possible
@ -89,19 +89,14 @@ std::unique_ptr<ToxOptions> ToxOptions::makeToxOptions(const QByteArray& savedat
tox_options_set_savedata_data(*toxOptions, reinterpret_cast<const uint8_t*>(savedata.data()), tox_options_set_savedata_data(*toxOptions, reinterpret_cast<const uint8_t*>(savedata.data()),
savedata.size()); savedata.size());
if(s == nullptr) {
qDebug() << "Using Tox default settings";
return toxOptions;
}
// IPv6 needed for LAN discovery, but can crash some weird routers. On by default, can be // IPv6 needed for LAN discovery, but can crash some weird routers. On by default, can be
// disabled in options. // disabled in options.
const bool enableIPv6 = s->getEnableIPv6(); const bool enableIPv6 = s.getEnableIPv6();
bool forceTCP = s->getForceTCP(); bool forceTCP = s.getForceTCP();
// LAN requiring UDP is a toxcore limitation, ideally wouldn't be related // LAN requiring UDP is a toxcore limitation, ideally wouldn't be related
const bool enableLanDiscovery = s->getEnableLanDiscovery() && !forceTCP; const bool enableLanDiscovery = s.getEnableLanDiscovery() && !forceTCP;
ICoreSettings::ProxyType proxyType = s->getProxyType(); ICoreSettings::ProxyType proxyType = s.getProxyType();
quint16 proxyPort = s->getProxyPort(); quint16 proxyPort = s.getProxyPort();
if (!enableLanDiscovery) { if (!enableLanDiscovery) {
qWarning() << "Core starting without LAN discovery. Peers can only be found through DHT."; qWarning() << "Core starting without LAN discovery. Peers can only be found through DHT.";

2
src/core/toxoptions.h
Unescape View File

@ -34,7 +34,7 @@ public:
operator Tox_Options*(); operator Tox_Options*();
const char* getProxyAddrData() const; const char* getProxyAddrData() const;
static std::unique_ptr<ToxOptions> makeToxOptions(const QByteArray& savedata, static std::unique_ptr<ToxOptions> makeToxOptions(const QByteArray& savedata,
const ICoreSettings* s); const ICoreSettings& s);
bool getIPv6Enabled() const; bool getIPv6Enabled() const;
void setIPv6Enabled(bool enabled); void setIPv6Enabled(bool enabled);

2
src/model/ibootstraplistgenerator.h
Unescape View File

@ -32,5 +32,5 @@ public:
IBootstrapListGenerator(IBootstrapListGenerator&&) = default; IBootstrapListGenerator(IBootstrapListGenerator&&) = default;
IBootstrapListGenerator& operator=(IBootstrapListGenerator&&) = default; IBootstrapListGenerator& operator=(IBootstrapListGenerator&&) = default;
virtual QList<DhtServer> getBootstrapnodes() = 0; virtual QList<DhtServer> getBootstrapnodes() const = 0;
}; };

2
src/net/bootstrapnodeupdater.cpp
Unescape View File

@ -213,7 +213,7 @@ BootstrapNodeUpdater::BootstrapNodeUpdater(const QNetworkProxy& proxy, Paths& _p
, QObject{parent} , QObject{parent}
{} {}
QList<DhtServer> BootstrapNodeUpdater::getBootstrapnodes() QList<DhtServer> BootstrapNodeUpdater::getBootstrapnodes() const
{ {
auto userFilePath = paths.getUserNodesFilePath(); auto userFilePath = paths.getUserNodesFilePath();
if (!QFile(userFilePath).exists()) { if (!QFile(userFilePath).exists()) {

2
src/net/bootstrapnodeupdater.h
Unescape View File

@ -35,7 +35,7 @@ class BootstrapNodeUpdater : public QObject, public IBootstrapListGenerator
Q_OBJECT Q_OBJECT
public: public:
explicit BootstrapNodeUpdater(const QNetworkProxy& proxy, Paths& _paths, QObject* parent = nullptr); explicit BootstrapNodeUpdater(const QNetworkProxy& proxy, Paths& _paths, QObject* parent = nullptr);
QList<DhtServer> getBootstrapnodes() override; QList<DhtServer> getBootstrapnodes() const override;
void requestBootstrapNodes(); void requestBootstrapNodes();
static QList<DhtServer> loadDefaultBootstrapNodes(); static QList<DhtServer> loadDefaultBootstrapNodes();

2
src/persistence/profile.cpp
Unescape View File

@ -248,7 +248,7 @@ void Profile::initCore(const QByteArray& toxsave, Settings& s, bool isNewProfile
new BootstrapNodeUpdater(s.getProxy(), paths)); new BootstrapNodeUpdater(s.getProxy(), paths));
Core::ToxCoreErrors err; Core::ToxCoreErrors err;
core = Core::makeToxCore(toxsave, &s, *bootstrapNodes, &err); core = Core::makeToxCore(toxsave, s, *bootstrapNodes, &err);
if (!core) { if (!core) {
switch (err) { switch (err) {
case Core::ToxCoreErrors::BAD_PROXY: case Core::ToxCoreErrors::BAD_PROXY:

10
test/core/core_test.cpp
Unescape View File

@ -79,10 +79,10 @@ private:
class MockNodeListGenerator : public IBootstrapListGenerator class MockNodeListGenerator : public IBootstrapListGenerator
{ {
QList<DhtServer> getBootstrapnodes(); QList<DhtServer> getBootstrapnodes() const override;
}; };
QList<DhtServer> MockNodeListGenerator::getBootstrapnodes() { QList<DhtServer> MockNodeListGenerator::getBootstrapnodes() const {
return BootstrapNodeUpdater::loadDefaultBootstrapNodes(); return BootstrapNodeUpdater::loadDefaultBootstrapNodes();
} }
@ -117,7 +117,7 @@ void TestCore::startup_without_proxy()
MockNodeListGenerator nodesGenerator{}; MockNodeListGenerator nodesGenerator{};
test_core = Core::makeToxCore(savedata, settings.get(), nodesGenerator, err); test_core = Core::makeToxCore(savedata, *settings, nodesGenerator, err);
if (test_core == nullptr) { if (test_core == nullptr) {
QFAIL("ToxCore initialisation failed"); QFAIL("ToxCore initialisation failed");
@ -144,7 +144,7 @@ void TestCore::startup_with_invalid_proxy()
MockNodeListGenerator nodesGenerator{}; MockNodeListGenerator nodesGenerator{};
test_core = Core::makeToxCore(savedata, settings.get(), nodesGenerator, err); test_core = Core::makeToxCore(savedata, *settings, nodesGenerator, err);
if (test_core != nullptr) { if (test_core != nullptr) {
QFAIL("ToxCore initialisation passed with invalid SOCKS5 proxy address"); QFAIL("ToxCore initialisation passed with invalid SOCKS5 proxy address");
@ -156,7 +156,7 @@ void TestCore::startup_with_invalid_proxy()
settings->setProxyPort(9985); settings->setProxyPort(9985);
settings->setProxyType(MockSettings::ProxyType::ptHTTP); settings->setProxyType(MockSettings::ProxyType::ptHTTP);
test_core = Core::makeToxCore(savedata, settings.get(), nodesGenerator, err); test_core = Core::makeToxCore(savedata, *settings, nodesGenerator, err);
if (test_core != nullptr) { if (test_core != nullptr) {
QFAIL("ToxCore initialisation passed with invalid HTTP proxy address"); QFAIL("ToxCore initialisation passed with invalid HTTP proxy address");

Write Preview
Loading…
Cancel
Save