src/kademlia/routing/RoutingZone.h

   1 //                                                              -*- C++ -*-
   2 // This file is part of the aMule Project.
   3 //
   4 // Copyright (c) 2004-2008 Angel Vidal (Kry) ( kry@amule.org )
   5 // Copyright (c) 2004-2008 aMule Team ( admin@amule.org / http://www.amule.org )
   6 // Copyright (c) 2003 Barry Dunne (http://www.emule-project.net)
   7 //
   8 // Any parts of this program derived from the xMule, lMule or eMule project,
   9 // or contributed by third-party developers are copyrighted by their
  10 // respective authors.
  11 //
  12 // This program is free software; you can redistribute it and/or modify
  13 // it under the terms of the GNU General Public License as published by
  14 // the Free Software Foundation; either version 2 of the License, or
  15 // (at your option) any later version.
  16 //
  17 // This program is distributed in the hope that it will be useful,
  18 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 // GNU General Public License for more details.
  21 //
  22 // You should have received a copy of the GNU General Public License
  23 // along with this program; if not, write to the Free Software
  24 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
  25 //
  26
  27 // Note To Mods //
  28 /*
  29 Please do not change anything here and release it..
  30 There is going to be a new forum created just for the Kademlia side of the client..
  31 If you feel there is an error or a way to improve something, please
  32 post it in the forum first and let us look at it.. If it is a real improvement,
  33 it will be added to the offical client.. Changing something without knowing
  34 what all it does can cause great harm to the network if released in mass form..
  35 Any mod that changes anything within the Kademlia side will not be allowed to advertise
  36 there client on the eMule forum..
  37 */
  38
  39 #ifndef __ROUTING_ZONE__
  40 #define __ROUTING_ZONE__
  41
  42 #include "Maps.h"
  43 #include "../utils/UInt128.h"
  44
  45 ////////////////////////////////////////
  46 namespace Kademlia {
  47 ////////////////////////////////////////
  48
  49 class CRoutingBin;
  50 class CContact;
  51 class CKadUDPKey;
  52
  53 /**
  54  * The *Zone* is just a node in a binary tree of *Zone*s.
  55  * Each zone is either an internal node or a leaf node.
  56  * Internal nodes have "bin == null" and "subZones[i] != null",
  57  * leaf nodes have "subZones[i] == null" and "bin != null".
  58  *
  59  * All key pseudoaddresses are relative to the center (self), which
  60  * is considered to be 000..000
  61  */
  62 class CRoutingZone
  63 {
  64 public:
  65
  66         CRoutingZone();
  67         ~CRoutingZone();
  68
  69         bool     OnBigTimer() const;
  70         void     OnSmallTimer();
  71         uint32_t Consolidate();
  72
  73         bool     Add(const CUInt128 &id, uint32_t ip, uint16_t port, uint16_t tport, uint8_t version, const CKadUDPKey& key, bool ipVerified, bool update);
  74         bool     AddUnfiltered(const CUInt128 &id, uint32_t ip, uint16_t port, uint16_t tport, uint8_t version, const CKadUDPKey& key, bool ipVerified, bool update);
  75         bool     Add(CContact *contact, bool update);
  76
  77         void     ReadFile(const wxString& specialNodesdat = wxEmptyString);
  78
  79         CContact *GetContact(const CUInt128& id) const throw();
  80         CContact *GetContact(uint32_t ip, uint16_t port, bool tcpPort) const throw();
  81         CContact *GetRandomContact(uint32_t maxType, uint32_t minKadVersion) const throw();
  82         uint32_t GetNumContacts() const throw();
  83
  84         // Returns a list of all contacts in all leafs of this zone.
  85         void     GetAllEntries(ContactList *result, bool emptyFirst = true) const;
  86
  87         // Returns the *maxRequired* tokens that are closest to the target within this zone's subtree.
  88         void     GetClosestTo(uint32_t maxType, const CUInt128& target, const CUInt128& distance, uint32_t maxRequired, ContactMap *result, bool emptyFirst = true, bool setInUse = false) const;
  89
  90         // Ideally: Returns all contacts that are in buckets of common range between us and the asker.
  91         // In practice: returns the contacts from the top (2^{logBase+1}) buckets.
  92         uint32_t GetBootstrapContacts(ContactList *results, uint32_t maxRequired) const;
  93
  94         uint32_t EstimateCount() const throw();
  95
  96         time_t   m_nextBigTimer;
  97         time_t   m_nextSmallTimer;
  98
  99 private:
 100
 101         CRoutingZone(CRoutingZone *super_zone, int level, const CUInt128& zone_index) { Init(super_zone, level, zone_index); }
 102         void Init(CRoutingZone *super_zone, int level, const CUInt128& zone_index);
 103
 104         void WriteFile();
 105
 106         bool IsLeaf() const throw() { return m_bin != NULL; }
 107         bool CanSplit() const throw();
 108
 109         // Returns all contacts from this zone tree that are no deeper than *depth* from the current zone.
 110         void TopDepth(int depth, ContactList *result, bool emptyFirst = true) const;
 111
 112         // Returns the maximum depth of the tree as the number of edges of the longest path to a leaf.
 113         uint32_t GetMaxDepth() const throw();
 114
 115         void RandomBin(ContactList *result, bool emptyFirst = true) const;
 116
 117         void Split();
 118
 119         void StartTimer();
 120         void StopTimer();
 121
 122         void RandomLookup() const;
 123
 124         /**
 125          * Generates a new TokenBin for this zone. Used when the current zone is becoming a leaf zone.
 126          * Must be deleted by caller
 127          */
 128         CRoutingZone *GenSubZone(unsigned side);
 129
 130         /**
 131          * Zone pair is an array of two. Either both entries are null, which
 132          * means that *this* is a leaf zone, or both are non-null which means
 133          * that *this* has been split into equally sized finer zones.
 134          * The zone with index 0 is the one closer to our *self* token.
 135          */
 136         CRoutingZone *m_subZones[2];
 137         CRoutingZone *m_superZone;
 138
 139         static wxString m_filename;
 140         static CUInt128 me;
 141
 142         /**
 143          * The level indicates what size chunk of the address space
 144          * this zone is representing. Level 0 is the whole space,
 145          * level 1 is 1/2 of the space, level 2 is 1/4, etc.
 146          */
 147         uint32_t m_level;
 148
 149         /**
 150          * This is the distance in number of zones from the zone at this level
 151          * that contains the center of the system; distance is wrt the XOR metric.
 152          */
 153         CUInt128 m_zoneIndex;
 154
 155         /** List of contacts, if this zone is a leaf zone. */
 156         CRoutingBin *m_bin;
 157 };
 158
 159 } // End namespace
 160
 161 #endif // __ROUTING_ZONE__
 162 // File_checked_for_headers