2013-07-04 20:56:19 +00:00
|
|
|
/*
|
2015-02-17 21:11:34 +00:00
|
|
|
* ZeroTier One - Network Virtualization Everywhere
|
|
|
|
* Copyright (C) 2011-2015 ZeroTier, Inc.
|
2013-07-04 20:56:19 +00:00
|
|
|
*
|
|
|
|
* This program is free software: you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*
|
|
|
|
* --
|
|
|
|
*
|
|
|
|
* ZeroTier may be used and distributed under the terms of the GPLv3, which
|
|
|
|
* are available at: http://www.gnu.org/licenses/gpl-3.0.html
|
|
|
|
*
|
|
|
|
* If you would like to embed ZeroTier into a commercial application or
|
|
|
|
* redistribute it in a modified binary form, please contact ZeroTier Networks
|
|
|
|
* LLC. Start here: http://www.zerotier.com/
|
|
|
|
*/
|
|
|
|
|
2013-12-07 00:49:20 +00:00
|
|
|
#ifndef ZT_TOPOLOGY_HPP
|
|
|
|
#define ZT_TOPOLOGY_HPP
|
2013-07-04 20:56:19 +00:00
|
|
|
|
2013-07-06 18:58:34 +00:00
|
|
|
#include <stdio.h>
|
|
|
|
#include <string.h>
|
2013-09-17 19:53:59 +00:00
|
|
|
|
2013-07-04 20:56:19 +00:00
|
|
|
#include <vector>
|
|
|
|
#include <stdexcept>
|
2014-10-14 23:38:27 +00:00
|
|
|
#include <algorithm>
|
2015-10-13 15:49:36 +00:00
|
|
|
#include <utility>
|
2013-07-04 20:56:19 +00:00
|
|
|
|
2013-10-05 14:19:12 +00:00
|
|
|
#include "Constants.hpp"
|
2014-08-14 23:52:22 +00:00
|
|
|
|
2013-07-04 20:56:19 +00:00
|
|
|
#include "Address.hpp"
|
2014-08-14 23:52:22 +00:00
|
|
|
#include "Identity.hpp"
|
2013-07-04 20:56:19 +00:00
|
|
|
#include "Peer.hpp"
|
|
|
|
#include "Mutex.hpp"
|
|
|
|
#include "InetAddress.hpp"
|
2015-09-04 19:14:21 +00:00
|
|
|
#include "Hashtable.hpp"
|
2015-10-13 01:25:29 +00:00
|
|
|
#include "World.hpp"
|
2013-07-04 20:56:19 +00:00
|
|
|
|
|
|
|
namespace ZeroTier {
|
|
|
|
|
|
|
|
class RuntimeEnvironment;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Database of network topology
|
|
|
|
*/
|
2013-08-05 20:06:16 +00:00
|
|
|
class Topology
|
2013-07-04 20:56:19 +00:00
|
|
|
{
|
|
|
|
public:
|
2014-10-13 21:12:51 +00:00
|
|
|
Topology(const RuntimeEnvironment *renv);
|
2013-08-05 20:06:16 +00:00
|
|
|
~Topology();
|
2013-07-04 20:56:19 +00:00
|
|
|
|
|
|
|
/**
|
2013-10-05 14:19:12 +00:00
|
|
|
* Add a peer to database
|
2013-07-04 20:56:19 +00:00
|
|
|
*
|
2013-10-05 14:19:12 +00:00
|
|
|
* This will not replace existing peers. In that case the existing peer
|
|
|
|
* record is returned.
|
|
|
|
*
|
|
|
|
* @param peer Peer to add
|
|
|
|
* @return New or existing peer (should replace 'peer')
|
2013-07-04 20:56:19 +00:00
|
|
|
*/
|
2013-10-05 14:19:12 +00:00
|
|
|
SharedPtr<Peer> addPeer(const SharedPtr<Peer> &peer);
|
2013-07-04 20:56:19 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get a peer from its address
|
2015-07-28 00:02:43 +00:00
|
|
|
*
|
2013-07-04 20:56:19 +00:00
|
|
|
* @param zta ZeroTier address of peer
|
|
|
|
* @return Peer or NULL if not found
|
|
|
|
*/
|
2014-10-13 21:12:51 +00:00
|
|
|
SharedPtr<Peer> getPeer(const Address &zta);
|
2013-10-21 18:12:00 +00:00
|
|
|
|
2015-10-27 23:52:44 +00:00
|
|
|
/**
|
|
|
|
* Get a peer only if it is presently in memory (no disk cache)
|
|
|
|
*
|
2015-11-02 23:38:53 +00:00
|
|
|
* This also does not update the lastUsed() time for peers, which means
|
|
|
|
* that it won't prevent them from falling out of RAM. This is currently
|
|
|
|
* used in the Cluster code to update peer info without forcing all peers
|
|
|
|
* across the entire cluster to remain in memory cache.
|
|
|
|
*
|
2015-10-27 23:52:44 +00:00
|
|
|
* @param zta ZeroTier address
|
|
|
|
* @param now Current time
|
|
|
|
*/
|
|
|
|
inline SharedPtr<Peer> getPeerNoCache(const Address &zta,const uint64_t now)
|
|
|
|
{
|
|
|
|
Mutex::Lock _l(_lock);
|
2015-10-30 20:39:28 +00:00
|
|
|
const SharedPtr<Peer> *const ap = _peers.get(zta);
|
2015-11-02 23:38:53 +00:00
|
|
|
if (ap)
|
2015-10-27 23:52:44 +00:00
|
|
|
return *ap;
|
|
|
|
return SharedPtr<Peer>();
|
|
|
|
}
|
|
|
|
|
2015-10-14 21:12:12 +00:00
|
|
|
/**
|
|
|
|
* Get the identity of a peer
|
|
|
|
*
|
|
|
|
* @param zta ZeroTier address of peer
|
|
|
|
* @return Identity or NULL Identity if not found
|
|
|
|
*/
|
|
|
|
Identity getIdentity(const Address &zta);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Cache an identity
|
|
|
|
*
|
|
|
|
* This is done automatically on addPeer(), and so is only useful for
|
|
|
|
* cluster identity replication.
|
|
|
|
*
|
|
|
|
* @param id Identity to cache
|
|
|
|
*/
|
|
|
|
void saveIdentity(const Identity &id);
|
|
|
|
|
2013-07-04 20:56:19 +00:00
|
|
|
/**
|
2015-06-19 17:23:25 +00:00
|
|
|
* Get the current favorite root server
|
2015-07-28 00:02:43 +00:00
|
|
|
*
|
2015-06-19 17:23:25 +00:00
|
|
|
* @return Root server with lowest latency or NULL if none
|
2013-07-04 20:56:19 +00:00
|
|
|
*/
|
2015-10-30 22:54:40 +00:00
|
|
|
inline SharedPtr<Peer> getBestRoot() { return getBestRoot((const Address *)0,0,false); }
|
2013-07-04 20:56:19 +00:00
|
|
|
|
|
|
|
/**
|
2015-06-19 17:23:25 +00:00
|
|
|
* Get the best root server, avoiding root servers listed in an array
|
2015-07-28 00:02:43 +00:00
|
|
|
*
|
2015-06-19 17:23:25 +00:00
|
|
|
* This will get the best root server (lowest latency, etc.) but will
|
|
|
|
* try to avoid the listed root servers, only using them if no others
|
2013-07-04 20:56:19 +00:00
|
|
|
* are available.
|
2015-07-28 00:02:43 +00:00
|
|
|
*
|
2013-07-04 20:56:19 +00:00
|
|
|
* @param avoid Nodes to avoid
|
|
|
|
* @param avoidCount Number of nodes to avoid
|
2015-06-19 17:23:25 +00:00
|
|
|
* @param strictAvoid If false, consider avoided root servers anyway if no non-avoid root servers are available
|
|
|
|
* @return Root server or NULL if none available
|
2013-07-04 20:56:19 +00:00
|
|
|
*/
|
2015-06-19 17:23:25 +00:00
|
|
|
SharedPtr<Peer> getBestRoot(const Address *avoid,unsigned int avoidCount,bool strictAvoid);
|
2013-07-04 20:56:19 +00:00
|
|
|
|
|
|
|
/**
|
2015-06-19 17:23:25 +00:00
|
|
|
* @param id Identity to check
|
2015-10-13 01:25:29 +00:00
|
|
|
* @return True if this is a designated root server in this world
|
2013-07-04 20:56:19 +00:00
|
|
|
*/
|
2015-10-13 01:25:29 +00:00
|
|
|
inline bool isRoot(const Identity &id) const
|
|
|
|
{
|
|
|
|
Mutex::Lock _l(_lock);
|
2015-10-19 19:56:29 +00:00
|
|
|
return (std::find(_rootAddresses.begin(),_rootAddresses.end(),id.address()) != _rootAddresses.end());
|
2015-10-13 01:25:29 +00:00
|
|
|
}
|
2013-07-04 20:56:19 +00:00
|
|
|
|
2015-10-19 19:56:29 +00:00
|
|
|
/**
|
|
|
|
* @param id Identity to check
|
|
|
|
* @return True if this is a root server or a network preferred relay from one of our networks
|
|
|
|
*/
|
|
|
|
bool isUpstream(const Identity &id) const;
|
|
|
|
|
2014-01-29 22:09:12 +00:00
|
|
|
/**
|
2015-06-19 17:23:25 +00:00
|
|
|
* @return Vector of root server addresses
|
2014-01-29 22:09:12 +00:00
|
|
|
*/
|
2015-06-19 17:23:25 +00:00
|
|
|
inline std::vector<Address> rootAddresses() const
|
2014-01-29 22:09:12 +00:00
|
|
|
{
|
2014-10-14 23:38:27 +00:00
|
|
|
Mutex::Lock _l(_lock);
|
2015-06-19 17:23:25 +00:00
|
|
|
return _rootAddresses;
|
2014-01-29 22:09:12 +00:00
|
|
|
}
|
|
|
|
|
2015-10-13 01:25:29 +00:00
|
|
|
/**
|
|
|
|
* @return Current World (copy)
|
|
|
|
*/
|
|
|
|
inline World world() const
|
|
|
|
{
|
|
|
|
Mutex::Lock _l(_lock);
|
|
|
|
return _world;
|
|
|
|
}
|
|
|
|
|
2015-10-13 15:49:36 +00:00
|
|
|
/**
|
2015-10-13 19:10:44 +00:00
|
|
|
* @return Current world ID
|
2015-10-13 15:49:36 +00:00
|
|
|
*/
|
2015-10-13 19:10:44 +00:00
|
|
|
inline uint64_t worldId() const
|
2015-10-13 15:49:36 +00:00
|
|
|
{
|
2015-10-13 19:10:44 +00:00
|
|
|
return _world.id(); // safe to read without lock, and used from within eachPeer() so don't lock
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return Current world timestamp
|
|
|
|
*/
|
|
|
|
inline uint64_t worldTimestamp() const
|
|
|
|
{
|
|
|
|
return _world.timestamp(); // safe to read without lock, and used from within eachPeer() so don't lock
|
2015-10-13 15:49:36 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Validate new world and update if newer and signature is okay
|
|
|
|
*
|
|
|
|
* @param newWorld Potential new world definition revision
|
|
|
|
* @return True if an update actually occurred
|
|
|
|
*/
|
|
|
|
bool worldUpdateIfValid(const World &newWorld);
|
|
|
|
|
2013-07-04 20:56:19 +00:00
|
|
|
/**
|
2013-10-05 14:19:12 +00:00
|
|
|
* Clean and flush database
|
2013-07-04 20:56:19 +00:00
|
|
|
*/
|
2014-10-01 21:05:25 +00:00
|
|
|
void clean(uint64_t now);
|
2013-07-04 20:56:19 +00:00
|
|
|
|
2015-10-26 19:41:08 +00:00
|
|
|
/**
|
2015-10-28 21:29:08 +00:00
|
|
|
* @return Number of peers with active direct paths
|
2015-10-26 19:41:08 +00:00
|
|
|
*/
|
2015-10-28 21:29:08 +00:00
|
|
|
unsigned long countActive() const;
|
2015-10-26 19:41:08 +00:00
|
|
|
|
2013-07-04 20:56:19 +00:00
|
|
|
/**
|
|
|
|
* Apply a function or function object to all peers
|
|
|
|
*
|
2014-09-17 19:54:39 +00:00
|
|
|
* Note: explicitly template this by reference if you want the object
|
|
|
|
* passed by reference instead of copied.
|
|
|
|
*
|
2014-10-14 23:38:27 +00:00
|
|
|
* Warning: be careful not to use features in these that call any other
|
|
|
|
* methods of Topology that may lock _lock, otherwise a recursive lock
|
|
|
|
* and deadlock or lock corruption may occur.
|
|
|
|
*
|
2013-07-04 20:56:19 +00:00
|
|
|
* @param f Function to apply
|
|
|
|
* @tparam F Function or function object type
|
|
|
|
*/
|
|
|
|
template<typename F>
|
|
|
|
inline void eachPeer(F f)
|
|
|
|
{
|
2014-10-14 23:38:27 +00:00
|
|
|
Mutex::Lock _l(_lock);
|
2015-10-02 00:09:01 +00:00
|
|
|
Hashtable< Address,SharedPtr<Peer> >::Iterator i(_peers);
|
2015-09-04 19:14:21 +00:00
|
|
|
Address *a = (Address *)0;
|
|
|
|
SharedPtr<Peer> *p = (SharedPtr<Peer> *)0;
|
2015-10-30 21:11:10 +00:00
|
|
|
while (i.next(a,p)) {
|
|
|
|
#ifdef ZT_TRACE
|
|
|
|
if (!(*p)) {
|
2015-10-30 22:54:40 +00:00
|
|
|
fprintf(stderr,"FATAL BUG: eachPeer() caught NULL peer for %s -- peer pointers in Topology should NEVER be NULL"ZT_EOL_S,a->toString().c_str());
|
2015-10-30 21:11:10 +00:00
|
|
|
abort();
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
f(*this,*((const SharedPtr<Peer> *)p));
|
|
|
|
}
|
2013-07-04 20:56:19 +00:00
|
|
|
}
|
|
|
|
|
2015-04-09 01:45:21 +00:00
|
|
|
/**
|
2015-10-13 15:49:36 +00:00
|
|
|
* @return All currently active peers by address (unsorted)
|
2015-04-09 01:45:21 +00:00
|
|
|
*/
|
2015-09-04 19:14:21 +00:00
|
|
|
inline std::vector< std::pair< Address,SharedPtr<Peer> > > allPeers() const
|
2015-04-09 01:45:21 +00:00
|
|
|
{
|
|
|
|
Mutex::Lock _l(_lock);
|
2015-10-02 00:09:01 +00:00
|
|
|
return _peers.entries();
|
2015-04-09 01:45:21 +00:00
|
|
|
}
|
|
|
|
|
2015-10-23 20:57:02 +00:00
|
|
|
/**
|
|
|
|
* @return True if I am a root server in the current World
|
|
|
|
*/
|
|
|
|
inline bool amRoot() const throw() { return _amRoot; }
|
|
|
|
|
2013-07-04 20:56:19 +00:00
|
|
|
private:
|
2014-10-13 21:12:51 +00:00
|
|
|
Identity _getIdentity(const Address &zta);
|
2015-10-13 15:49:36 +00:00
|
|
|
void _setWorld(const World &newWorld);
|
2013-07-04 20:56:19 +00:00
|
|
|
|
2014-10-13 21:12:51 +00:00
|
|
|
const RuntimeEnvironment *RR;
|
2013-10-21 15:15:47 +00:00
|
|
|
|
2015-10-13 01:25:29 +00:00
|
|
|
World _world;
|
2015-10-02 00:09:01 +00:00
|
|
|
Hashtable< Address,SharedPtr<Peer> > _peers;
|
2015-06-19 17:23:25 +00:00
|
|
|
std::vector< Address > _rootAddresses;
|
|
|
|
std::vector< SharedPtr<Peer> > _rootPeers;
|
2015-10-13 01:25:29 +00:00
|
|
|
bool _amRoot;
|
2014-10-14 23:38:27 +00:00
|
|
|
|
|
|
|
Mutex _lock;
|
2013-07-04 20:56:19 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
} // namespace ZeroTier
|
|
|
|
|
|
|
|
#endif
|