mirror of
https://github.com/XRPLF/rippled.git
synced 2025-12-06 17:27:55 +00:00
384 lines
13 KiB
C++
384 lines
13 KiB
C++
//------------------------------------------------------------------------------
|
|
/*
|
|
This file is part of rippled: https://github.com/ripple/rippled
|
|
Copyright (c) 2012, 2013 Ripple Labs Inc.
|
|
|
|
Permission to use, copy, modify, and/or distribute this software for any
|
|
purpose with or without fee is hereby granted, provided that the above
|
|
copyright notice and this permission notice appear in all copies.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
*/
|
|
//==============================================================================
|
|
|
|
#include <ripple/basics/Log.h>
|
|
#include <ripple/net/SNTPClient.h>
|
|
#include <ripple/types/RandomNumbers.h>
|
|
#include <beast/asio/placeholders.h>
|
|
#include <beast/threads/Thread.h>
|
|
#include <boost/foreach.hpp>
|
|
|
|
namespace ripple {
|
|
|
|
// #define SNTP_DEBUG
|
|
|
|
static uint8_t SNTPQueryData[48] =
|
|
{ 0x1B, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
|
|
|
|
// NTP query frequency - 4 minutes
|
|
#define NTP_QUERY_FREQUENCY (4 * 60)
|
|
|
|
// NTP minimum interval to query same servers - 3 minutes
|
|
#define NTP_MIN_QUERY (3 * 60)
|
|
|
|
// NTP sample window (should be odd)
|
|
#define NTP_SAMPLE_WINDOW 9
|
|
|
|
// NTP timestamp constant
|
|
#define NTP_UNIX_OFFSET 0x83AA7E80
|
|
|
|
// NTP timestamp validity
|
|
#define NTP_TIMESTAMP_VALID ((NTP_QUERY_FREQUENCY + NTP_MIN_QUERY) * 2)
|
|
|
|
// SNTP packet offsets
|
|
#define NTP_OFF_INFO 0
|
|
#define NTP_OFF_ROOTDELAY 1
|
|
#define NTP_OFF_ROOTDISP 2
|
|
#define NTP_OFF_REFERENCEID 3
|
|
#define NTP_OFF_REFTS_INT 4
|
|
#define NTP_OFF_REFTS_FRAC 5
|
|
#define NTP_OFF_ORGTS_INT 6
|
|
#define NTP_OFF_ORGTS_FRAC 7
|
|
#define NTP_OFF_RECVTS_INT 8
|
|
#define NTP_OFF_RECVTS_FRAC 9
|
|
#define NTP_OFF_XMITTS_INT 10
|
|
#define NTP_OFF_XMITTS_FRAC 11
|
|
|
|
class SNTPClientImp
|
|
: public SNTPClient
|
|
, public beast::Thread
|
|
, public beast::LeakChecked <SNTPClientImp>
|
|
{
|
|
public:
|
|
class SNTPQuery
|
|
{
|
|
public:
|
|
bool mReceivedReply;
|
|
time_t mLocalTimeSent;
|
|
std::uint32_t mQueryNonce;
|
|
|
|
SNTPQuery (time_t j = (time_t) - 1) : mReceivedReply (false), mLocalTimeSent (j)
|
|
{
|
|
;
|
|
}
|
|
};
|
|
|
|
//--------------------------------------------------------------------------
|
|
|
|
explicit SNTPClientImp (Stoppable& parent)
|
|
: SNTPClient (parent)
|
|
, Thread ("SNTPClient")
|
|
, mSocket (m_io_service)
|
|
, mTimer (m_io_service)
|
|
, mResolver (m_io_service)
|
|
, mOffset (0)
|
|
, mLastOffsetUpdate ((time_t) - 1)
|
|
, mReceiveBuffer (256)
|
|
{
|
|
mSocket.open (boost::asio::ip::udp::v4 ());
|
|
|
|
mSocket.async_receive_from (boost::asio::buffer (mReceiveBuffer, 256),
|
|
mReceiveEndpoint, std::bind (
|
|
&SNTPClientImp::receivePacket, this,
|
|
beast::asio::placeholders::error,
|
|
beast::asio::placeholders::bytes_transferred));
|
|
|
|
mTimer.expires_from_now (boost::posix_time::seconds (NTP_QUERY_FREQUENCY));
|
|
mTimer.async_wait (std::bind (&SNTPClientImp::timerEntry, this, beast::asio::placeholders::error));
|
|
}
|
|
|
|
~SNTPClientImp ()
|
|
{
|
|
stopThread ();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------
|
|
|
|
void onStart ()
|
|
{
|
|
startThread ();
|
|
}
|
|
|
|
void onStop ()
|
|
{
|
|
// HACK!
|
|
m_io_service.stop ();
|
|
}
|
|
|
|
void run ()
|
|
{
|
|
m_io_service.run ();
|
|
|
|
stopped ();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------
|
|
|
|
void init (const std::vector<std::string>& servers)
|
|
{
|
|
std::vector<std::string>::const_iterator it = servers.begin ();
|
|
|
|
if (it == servers.end ())
|
|
{
|
|
WriteLog (lsINFO, SNTPClient) << "SNTP: no server specified";
|
|
return;
|
|
}
|
|
|
|
BOOST_FOREACH (std::string const& it, servers)
|
|
addServer (it);
|
|
queryAll ();
|
|
}
|
|
|
|
void addServer (std::string const& server)
|
|
{
|
|
ScopedLockType sl (mLock);
|
|
mServers.push_back (std::make_pair (server, (time_t) - 1));
|
|
}
|
|
|
|
void queryAll ()
|
|
{
|
|
while (doQuery ())
|
|
{
|
|
}
|
|
}
|
|
|
|
bool getOffset (int& offset)
|
|
{
|
|
ScopedLockType sl (mLock);
|
|
|
|
if ((mLastOffsetUpdate == (time_t) - 1) || ((mLastOffsetUpdate + NTP_TIMESTAMP_VALID) < time (nullptr)))
|
|
return false;
|
|
|
|
offset = mOffset;
|
|
return true;
|
|
}
|
|
|
|
bool doQuery ()
|
|
{
|
|
ScopedLockType sl (mLock);
|
|
std::vector< std::pair<std::string, time_t> >::iterator best = mServers.end ();
|
|
|
|
for (std::vector< std::pair<std::string, time_t> >::iterator it = mServers.begin (), end = best;
|
|
it != end; ++it)
|
|
if ((best == end) || (it->second == (time_t) - 1) || (it->second < best->second))
|
|
best = it;
|
|
|
|
if (best == mServers.end ())
|
|
{
|
|
WriteLog (lsTRACE, SNTPClient) << "SNTP: No server to query";
|
|
return false;
|
|
}
|
|
|
|
time_t now = time (nullptr);
|
|
|
|
if ((best->second != (time_t) - 1) && ((best->second + NTP_MIN_QUERY) >= now))
|
|
{
|
|
WriteLog (lsTRACE, SNTPClient) << "SNTP: All servers recently queried";
|
|
return false;
|
|
}
|
|
|
|
best->second = now;
|
|
|
|
boost::asio::ip::udp::resolver::query query (boost::asio::ip::udp::v4 (), best->first, "ntp");
|
|
mResolver.async_resolve (query,
|
|
std::bind (&SNTPClientImp::resolveComplete, this,
|
|
beast::asio::placeholders::error, beast::asio::placeholders::iterator));
|
|
#ifdef SNTP_DEBUG
|
|
WriteLog (lsTRACE, SNTPClient) << "SNTP: Resolve pending for " << best->first;
|
|
#endif
|
|
return true;
|
|
}
|
|
|
|
void resolveComplete (const boost::system::error_code& error, boost::asio::ip::udp::resolver::iterator it)
|
|
{
|
|
if (!error)
|
|
{
|
|
boost::asio::ip::udp::resolver::iterator sel = it;
|
|
int i = 1;
|
|
|
|
while (++it != boost::asio::ip::udp::resolver::iterator ())
|
|
if ((rand () % ++i) == 0)
|
|
sel = it;
|
|
|
|
if (sel != boost::asio::ip::udp::resolver::iterator ())
|
|
{
|
|
ScopedLockType sl (mLock);
|
|
SNTPQuery& query = mQueries[*sel];
|
|
time_t now = time (nullptr);
|
|
|
|
if ((query.mLocalTimeSent == now) || ((query.mLocalTimeSent + 1) == now))
|
|
{
|
|
// This can happen if the same IP address is reached through multiple names
|
|
WriteLog (lsTRACE, SNTPClient) << "SNTP: Redundant query suppressed";
|
|
return;
|
|
}
|
|
|
|
query.mReceivedReply = false;
|
|
query.mLocalTimeSent = now;
|
|
RandomNumbers::getInstance ().fill (&query.mQueryNonce);
|
|
reinterpret_cast<std::uint32_t*> (SNTPQueryData)[NTP_OFF_XMITTS_INT] = static_cast<std::uint32_t> (time (nullptr)) + NTP_UNIX_OFFSET;
|
|
reinterpret_cast<std::uint32_t*> (SNTPQueryData)[NTP_OFF_XMITTS_FRAC] = query.mQueryNonce;
|
|
mSocket.async_send_to (boost::asio::buffer (SNTPQueryData, 48), *sel,
|
|
std::bind (&SNTPClientImp::sendComplete, this,
|
|
beast::asio::placeholders::error, beast::asio::placeholders::bytes_transferred));
|
|
}
|
|
}
|
|
}
|
|
|
|
void receivePacket (const boost::system::error_code& error, std::size_t bytes_xferd)
|
|
{
|
|
if (!error)
|
|
{
|
|
ScopedLockType sl (mLock);
|
|
#ifdef SNTP_DEBUG
|
|
WriteLog (lsTRACE, SNTPClient) << "SNTP: Packet from " << mReceiveEndpoint;
|
|
#endif
|
|
std::map<boost::asio::ip::udp::endpoint, SNTPQuery>::iterator query = mQueries.find (mReceiveEndpoint);
|
|
|
|
if (query == mQueries.end ())
|
|
WriteLog (lsDEBUG, SNTPClient) << "SNTP: Reply from " << mReceiveEndpoint << " found without matching query";
|
|
else if (query->second.mReceivedReply)
|
|
WriteLog (lsDEBUG, SNTPClient) << "SNTP: Duplicate response from " << mReceiveEndpoint;
|
|
else
|
|
{
|
|
query->second.mReceivedReply = true;
|
|
|
|
if (time (nullptr) > (query->second.mLocalTimeSent + 1))
|
|
WriteLog (lsWARNING, SNTPClient) << "SNTP: Late response from " << mReceiveEndpoint;
|
|
else if (bytes_xferd < 48)
|
|
WriteLog (lsWARNING, SNTPClient) << "SNTP: Short reply from " << mReceiveEndpoint
|
|
<< " (" << bytes_xferd << ") " << mReceiveBuffer.size ();
|
|
else if (reinterpret_cast<std::uint32_t*> (&mReceiveBuffer[0])[NTP_OFF_ORGTS_FRAC] != query->second.mQueryNonce)
|
|
WriteLog (lsWARNING, SNTPClient) << "SNTP: Reply from " << mReceiveEndpoint << "had wrong nonce";
|
|
else
|
|
processReply ();
|
|
}
|
|
}
|
|
|
|
mSocket.async_receive_from (boost::asio::buffer (mReceiveBuffer, 256), mReceiveEndpoint,
|
|
std::bind (&SNTPClientImp::receivePacket, this, beast::asio::placeholders::error,
|
|
beast::asio::placeholders::bytes_transferred));
|
|
}
|
|
|
|
void sendComplete (const boost::system::error_code& error, std::size_t)
|
|
{
|
|
CondLog (error, lsWARNING, SNTPClient) << "SNTP: Send error";
|
|
}
|
|
|
|
void processReply ()
|
|
{
|
|
assert (mReceiveBuffer.size () >= 48);
|
|
std::uint32_t* recvBuffer = reinterpret_cast<std::uint32_t*> (&mReceiveBuffer.front ());
|
|
|
|
unsigned info = ntohl (recvBuffer[NTP_OFF_INFO]);
|
|
int64_t timev = ntohl (recvBuffer[NTP_OFF_RECVTS_INT]);
|
|
unsigned stratum = (info >> 16) & 0xff;
|
|
|
|
if ((info >> 30) == 3)
|
|
{
|
|
WriteLog (lsINFO, SNTPClient) << "SNTP: Alarm condition " << mReceiveEndpoint;
|
|
return;
|
|
}
|
|
|
|
if ((stratum == 0) || (stratum > 14))
|
|
{
|
|
WriteLog (lsINFO, SNTPClient) << "SNTP: Unreasonable stratum (" << stratum << ") from " << mReceiveEndpoint;
|
|
return;
|
|
}
|
|
|
|
std::int64_t now = static_cast<int> (time (nullptr));
|
|
timev -= now;
|
|
timev -= NTP_UNIX_OFFSET;
|
|
|
|
// add offset to list, replacing oldest one if appropriate
|
|
mOffsetList.push_back (timev);
|
|
|
|
if (mOffsetList.size () >= NTP_SAMPLE_WINDOW)
|
|
mOffsetList.pop_front ();
|
|
|
|
mLastOffsetUpdate = now;
|
|
|
|
// select median time
|
|
std::list<int> offsetList = mOffsetList;
|
|
offsetList.sort ();
|
|
int j = offsetList.size ();
|
|
std::list<int>::iterator it = offsetList.begin ();
|
|
|
|
for (int i = 0; i < (j / 2); ++i)
|
|
++it;
|
|
|
|
mOffset = *it;
|
|
|
|
if ((j % 2) == 0)
|
|
mOffset = (mOffset + (*--it)) / 2;
|
|
|
|
if ((mOffset == -1) || (mOffset == 1)) // small corrections likely do more harm than good
|
|
mOffset = 0;
|
|
|
|
CondLog (timev || mOffset, lsTRACE, SNTPClient) << "SNTP: Offset is " << timev << ", new system offset is " << mOffset;
|
|
}
|
|
|
|
void timerEntry (const boost::system::error_code& error)
|
|
{
|
|
if (!error)
|
|
{
|
|
doQuery ();
|
|
mTimer.expires_from_now (boost::posix_time::seconds (NTP_QUERY_FREQUENCY));
|
|
mTimer.async_wait (std::bind (&SNTPClientImp::timerEntry, this, beast::asio::placeholders::error));
|
|
}
|
|
}
|
|
|
|
private:
|
|
typedef RippleMutex LockType;
|
|
typedef std::lock_guard <LockType> ScopedLockType;
|
|
LockType mLock;
|
|
|
|
boost::asio::io_service m_io_service;
|
|
std::map <boost::asio::ip::udp::endpoint, SNTPQuery> mQueries;
|
|
|
|
boost::asio::ip::udp::socket mSocket;
|
|
boost::asio::deadline_timer mTimer;
|
|
boost::asio::ip::udp::resolver mResolver;
|
|
|
|
std::vector< std::pair<std::string, time_t> > mServers;
|
|
|
|
int mOffset;
|
|
time_t mLastOffsetUpdate;
|
|
std::list<int> mOffsetList;
|
|
|
|
std::vector<uint8_t> mReceiveBuffer;
|
|
boost::asio::ip::udp::endpoint mReceiveEndpoint;
|
|
};
|
|
|
|
//------------------------------------------------------------------------------
|
|
|
|
SNTPClient::SNTPClient (Stoppable& parent)
|
|
: Stoppable ("SNTPClient", parent)
|
|
{
|
|
}
|
|
|
|
//------------------------------------------------------------------------------
|
|
|
|
SNTPClient* SNTPClient::New (Stoppable& parent)
|
|
{
|
|
return new SNTPClientImp (parent);
|
|
}
|
|
|
|
} // ripple
|