i2pd/libi2pd/TunnelPool.h

147 lines
6.0 KiB
C
Raw Normal View History

/*
* Copyright (c) 2013-2020, The PurpleI2P Project
*
* This file is part of Purple i2pd project and licensed under BSD3
*
* See full license text in LICENSE file at top of project tree
*/
2014-03-14 20:35:02 +04:00
#ifndef TUNNEL_POOL__
#define TUNNEL_POOL__
2014-03-18 00:50:03 +04:00
#include <inttypes.h>
#include <set>
#include <vector>
2014-03-18 00:50:03 +04:00
#include <utility>
2014-10-03 18:35:11 +04:00
#include <mutex>
2015-01-20 06:28:13 +03:00
#include <memory>
#include "Identity.h"
2014-03-14 20:35:02 +04:00
#include "LeaseSet.h"
#include "RouterInfo.h"
#include "I2NPProtocol.h"
#include "TunnelBase.h"
2014-04-02 21:14:21 +04:00
#include "RouterContext.h"
2014-10-07 04:18:18 +04:00
#include "Garlic.h"
2014-03-14 20:35:02 +04:00
namespace i2p
{
namespace tunnel
{
const int TUNNEL_POOL_MANAGE_INTERVAL = 10; // in seconds
2014-03-14 20:35:02 +04:00
class Tunnel;
class InboundTunnel;
class OutboundTunnel;
2017-04-08 22:14:47 +03:00
typedef std::shared_ptr<const i2p::data::IdentityEx> Peer;
typedef std::vector<Peer> Path;
2016-08-29 19:09:37 +03:00
/** interface for custom tunnel peer selection algorithm */
struct ITunnelPeerSelector
{
2017-04-08 22:14:47 +03:00
virtual ~ITunnelPeerSelector() {};
virtual bool SelectPeers(Path & peers, int hops, bool isInbound) = 0;
2016-08-29 19:09:37 +03:00
};
2017-04-08 22:14:47 +03:00
typedef std::function<std::shared_ptr<const i2p::data::RouterInfo>(std::shared_ptr<const i2p::data::RouterInfo>)> SelectHopFunc;
// standard peer selection algorithm
bool StandardSelectPeers(Path & path, int hops, bool inbound, SelectHopFunc nextHop);
2015-01-20 06:28:13 +03:00
class TunnelPool: public std::enable_shared_from_this<TunnelPool> // per local destination
2014-03-14 20:35:02 +04:00
{
public:
TunnelPool (int numInboundHops, int numOutboundHops, int numInboundTunnels, int numOutboundTunnels);
2014-03-14 20:35:02 +04:00
~TunnelPool ();
std::shared_ptr<i2p::garlic::GarlicDestination> GetLocalDestination () const { return m_LocalDestination; };
void SetLocalDestination (std::shared_ptr<i2p::garlic::GarlicDestination> destination) { m_LocalDestination = destination; };
2015-06-10 22:32:55 +03:00
void SetExplicitPeers (std::shared_ptr<std::vector<i2p::data::IdentHash> > explicitPeers);
2014-04-02 21:14:21 +04:00
void CreateTunnels ();
2015-01-27 22:55:46 +03:00
void TunnelCreated (std::shared_ptr<InboundTunnel> createdTunnel);
void TunnelExpired (std::shared_ptr<InboundTunnel> expiredTunnel);
void TunnelCreated (std::shared_ptr<OutboundTunnel> createdTunnel);
void TunnelExpired (std::shared_ptr<OutboundTunnel> expiredTunnel);
2015-04-15 04:37:21 +03:00
void RecreateInboundTunnel (std::shared_ptr<InboundTunnel> tunnel);
void RecreateOutboundTunnel (std::shared_ptr<OutboundTunnel> tunnel);
2015-01-27 22:55:46 +03:00
std::vector<std::shared_ptr<InboundTunnel> > GetInboundTunnels (int num) const;
std::shared_ptr<OutboundTunnel> GetNextOutboundTunnel (std::shared_ptr<OutboundTunnel> excluded = nullptr) const;
std::shared_ptr<InboundTunnel> GetNextInboundTunnel (std::shared_ptr<InboundTunnel> excluded = nullptr) const;
std::shared_ptr<OutboundTunnel> GetNewOutboundTunnel (std::shared_ptr<OutboundTunnel> old) const;
2014-03-18 00:50:03 +04:00
void TestTunnels ();
void ManageTunnels (uint64_t ts);
2015-06-16 17:14:14 +03:00
void ProcessGarlicMessage (std::shared_ptr<I2NPMessage> msg);
void ProcessDeliveryStatus (std::shared_ptr<I2NPMessage> msg);
2014-03-18 00:50:03 +04:00
bool IsActive () const { return m_IsActive; };
void SetActive (bool isActive) { m_IsActive = isActive; };
2014-10-11 17:47:24 +04:00
void DetachTunnels ();
2016-02-15 02:30:07 +03:00
int GetNumInboundTunnels () const { return m_NumInboundTunnels; };
int GetNumOutboundTunnels () const { return m_NumOutboundTunnels; };
2018-01-02 19:34:58 +03:00
int GetNumInboundHops() const { return m_NumInboundHops; };
int GetNumOutboundHops() const { return m_NumOutboundHops; };
2016-08-29 19:09:37 +03:00
2018-01-02 19:34:58 +03:00
/** i2cp reconfigure */
bool Reconfigure(int inboundHops, int outboundHops, int inboundQuant, int outboundQuant);
void SetCustomPeerSelector(ITunnelPeerSelector * selector);
void UnsetCustomPeerSelector();
bool HasCustomPeerSelector();
2016-11-15 18:20:09 +03:00
/** @brief make this tunnel pool yield tunnels that fit latency range [min, max] */
void RequireLatency(uint64_t min, uint64_t max) { m_MinLatency = min; m_MaxLatency = max; }
2016-11-15 18:20:09 +03:00
/** @brief return true if this tunnel pool has a latency requirement */
bool HasLatencyRequirement() const { return m_MinLatency > 0 && m_MaxLatency > 0; }
2016-11-15 18:20:09 +03:00
/** @brief get the lowest latency tunnel in this tunnel pool regardless of latency requirements */
std::shared_ptr<InboundTunnel> GetLowestLatencyInboundTunnel(std::shared_ptr<InboundTunnel> exclude = nullptr) const;
std::shared_ptr<OutboundTunnel> GetLowestLatencyOutboundTunnel(std::shared_ptr<OutboundTunnel> exclude = nullptr) const;
2016-11-15 23:40:09 +03:00
// for overriding tunnel peer selection
std::shared_ptr<const i2p::data::RouterInfo> SelectNextHop (std::shared_ptr<const i2p::data::RouterInfo> prevHop) const;
private:
void CreateInboundTunnel ();
2014-03-17 00:03:20 +04:00
void CreateOutboundTunnel ();
void CreatePairedInboundTunnel (std::shared_ptr<OutboundTunnel> outboundTunnel);
template<class TTunnels>
typename TTunnels::value_type GetNextTunnel (TTunnels& tunnels, typename TTunnels::value_type excluded) const;
2015-11-03 17:15:49 +03:00
bool SelectPeers (std::vector<std::shared_ptr<const i2p::data::IdentityEx> >& hops, bool isInbound);
bool SelectExplicitPeers (std::vector<std::shared_ptr<const i2p::data::IdentityEx> >& hops, bool isInbound);
2015-06-10 22:32:55 +03:00
2014-03-14 20:35:02 +04:00
private:
std::shared_ptr<i2p::garlic::GarlicDestination> m_LocalDestination;
2015-05-05 19:32:13 +03:00
int m_NumInboundHops, m_NumOutboundHops, m_NumInboundTunnels, m_NumOutboundTunnels;
std::shared_ptr<std::vector<i2p::data::IdentHash> > m_ExplicitPeers;
2014-10-03 18:35:11 +04:00
mutable std::mutex m_InboundTunnelsMutex;
2015-01-27 22:55:46 +03:00
std::set<std::shared_ptr<InboundTunnel>, TunnelCreationTimeCmp> m_InboundTunnels; // recent tunnel appears first
2014-10-03 18:35:11 +04:00
mutable std::mutex m_OutboundTunnelsMutex;
2015-01-27 22:55:46 +03:00
std::set<std::shared_ptr<OutboundTunnel>, TunnelCreationTimeCmp> m_OutboundTunnels;
mutable std::mutex m_TestsMutex;
2015-01-27 22:55:46 +03:00
std::map<uint32_t, std::pair<std::shared_ptr<OutboundTunnel>, std::shared_ptr<InboundTunnel> > > m_Tests;
bool m_IsActive;
uint64_t m_NextManageTime; // in seconds
std::mutex m_CustomPeerSelectorMutex;
ITunnelPeerSelector * m_CustomPeerSelector;
2016-11-15 18:20:09 +03:00
uint64_t m_MinLatency = 0; // if > 0 this tunnel pool will try building tunnels with minimum latency by ms
uint64_t m_MaxLatency = 0; // if > 0 this tunnel pool will try building tunnels with maximum latency by ms
2014-09-30 06:18:32 +04:00
public:
// for HTTP only
const decltype(m_OutboundTunnels)& GetOutboundTunnels () const { return m_OutboundTunnels; };
const decltype(m_InboundTunnels)& GetInboundTunnels () const { return m_InboundTunnels; };
};
2014-03-14 20:35:02 +04:00
}
}
#endif