src/modules/m_spanningtree/treeserver.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2007-2008 Craig Edwards <craigedwards@brainbox.cc>
   6  *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
   7  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
   8  *
   9  * This file is part of InspIRCd.  InspIRCd is free software: you can
  10  * redistribute it and/or modify it under the terms of the GNU General Public
  11  * License as published by the Free Software Foundation, version 2.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22
  23 #include "inspircd.h"
  24 #include "xline.h"
  25 #include "main.h"
  26 #include "modules/spanningtree.h"
  27
  28 #include "utils.h"
  29 #include "treeserver.h"
  30
  31 /** We use this constructor only to create the 'root' item, Utils->TreeRoot, which
  32  * represents our own server. Therefore, it has no route, no parent, and
  33  * no socket associated with it. Its version string is our own local version.
  34  */
  35 TreeServer::TreeServer()
  36         : Server(ServerInstance->Config->ServerName)
  37         , Parent(NULL), Route(NULL), ServerDesc(ServerInstance->Config->ServerDesc)
  38         , VersionString(ServerInstance->GetVersionString()), Socket(NULL), sid(ServerInstance->Config->GetSID()), ServerUser(ServerInstance->FakeClient)
  39         , age(ServerInstance->Time()), Warned(false), bursting(false), UserCount(0), OperCount(0), rtt(0), StartBurst(0), Hidden(false)
  40 {
  41         AddHashEntry();
  42 }
  43
  44 /** When we create a new server, we call this constructor to initialize it.
  45  * This constructor initializes the server's Route and Parent, and sets up
  46  * its ping counters so that it will be pinged one minute from now.
  47  */
  48 TreeServer::TreeServer(const std::string& Name, const std::string& Desc, const std::string& id, TreeServer* Above, TreeSocket* Sock, bool Hide)
  49         : Server(Name)
  50         , Parent(Above), ServerDesc(Desc), Socket(Sock), sid(id), ServerUser(new FakeUser(id, this))
  51         , age(ServerInstance->Time()), Warned(false), bursting(true), UserCount(0), OperCount(0), rtt(0), Hidden(Hide)
  52 {
  53         CheckULine();
  54         SetNextPingTime(ServerInstance->Time() + Utils->PingFreq);
  55         SetPingFlag();
  56
  57         long ts = ServerInstance->Time() * 1000 + (ServerInstance->Time_ns() / 1000000);
  58         this->StartBurst = ts;
  59         ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Server %s started bursting at time %lu", sid.c_str(), ts);
  60
  61         /* find the 'route' for this server (e.g. the one directly connected
  62          * to the local server, which we can use to reach it)
  63          *
  64          * In the following example, consider we have just added a TreeServer
  65          * class for server G on our network, of which we are server A.
  66          * To route traffic to G (marked with a *) we must send the data to
  67          * B (marked with a +) so this algorithm initializes the 'Route'
  68          * value to point at whichever server traffic must be routed through
  69          * to get here. If we were to try this algorithm with server B,
  70          * the Route pointer would point at its own object ('this').
  71          *
  72          *            A
  73          *           / \
  74          *        + B   C
  75          *         / \   \
  76          *        D   E   F
  77          *       /         \
  78          *    * G           H
  79          *
  80          * We only run this algorithm when a server is created, as
  81          * the routes remain constant while ever the server exists, and
  82          * do not need to be re-calculated.
  83          */
  84
  85         Route = Above;
  86         if (Route == Utils->TreeRoot)
  87         {
  88                 Route = this;
  89         }
  90         else
  91         {
  92                 while (this->Route->GetParent() != Utils->TreeRoot)
  93                 {
  94                         this->Route = Route->GetParent();
  95                 }
  96         }
  97
  98         /* Because recursive code is slow and takes a lot of resources,
  99          * we store two representations of the server tree. The first
 100          * is a recursive structure where each server references its
 101          * children and its parent, which is used for netbursts and
 102          * netsplits to dump the whole dataset to the other server,
 103          * and the second is used for very fast lookups when routing
 104          * messages and is instead a hash_map, where each item can
 105          * be referenced by its server name. The AddHashEntry()
 106          * call below automatically inserts each TreeServer class
 107          * into the hash_map as it is created. There is a similar
 108          * maintainance call in the destructor to tidy up deleted
 109          * servers.
 110          */
 111
 112         this->AddHashEntry();
 113 }
 114
 115 const std::string& TreeServer::GetID()
 116 {
 117         return sid;
 118 }
 119
 120 void TreeServer::FinishBurstInternal()
 121 {
 122         this->bursting = false;
 123         SetNextPingTime(ServerInstance->Time() + Utils->PingFreq);
 124         SetPingFlag();
 125         for (ChildServers::const_iterator i = Children.begin(); i != Children.end(); ++i)
 126         {
 127                 TreeServer* child = *i;
 128                 child->FinishBurstInternal();
 129         }
 130 }
 131
 132 void TreeServer::FinishBurst()
 133 {
 134         FinishBurstInternal();
 135         ServerInstance->XLines->ApplyLines();
 136         long ts = ServerInstance->Time() * 1000 + (ServerInstance->Time_ns() / 1000000);
 137         unsigned long bursttime = ts - this->StartBurst;
 138         ServerInstance->SNO->WriteToSnoMask(Parent == Utils->TreeRoot ? 'l' : 'L', "Received end of netburst from \2%s\2 (burst time: %lu %s)",
 139                 GetName().c_str(), (bursttime > 10000 ? bursttime / 1000 : bursttime), (bursttime > 10000 ? "secs" : "msecs"));
 140         AddServerEvent(Utils->Creator, GetName());
 141 }
 142
 143 int TreeServer::QuitUsers(const std::string &reason)
 144 {
 145         std::string publicreason = ServerInstance->Config->HideSplits ? "*.net *.split" : reason;
 146
 147         const user_hash& users = *ServerInstance->Users->clientlist;
 148         unsigned int original_size = users.size();
 149         for (user_hash::const_iterator i = users.begin(); i != users.end(); )
 150         {
 151                 User* user = i->second;
 152                 // Increment the iterator now because QuitUser() removes the user from the container
 153                 ++i;
 154                 if (user->server == this)
 155                         ServerInstance->Users->QuitUser(user, publicreason, &reason);
 156         }
 157         return original_size - users.size();
 158 }
 159
 160 void TreeServer::CheckULine()
 161 {
 162         uline = silentuline = false;
 163         std::map<irc::string, bool>::iterator it = ServerInstance->Config->ulines.find(GetName().c_str());
 164         if (it != ServerInstance->Config->ulines.end())
 165         {
 166                 uline = true;
 167                 silentuline = it->second;
 168         }
 169 }
 170
 171 /** This method is used to add the structure to the
 172  * hash_map for linear searches. It is only called
 173  * by the constructors.
 174  */
 175 void TreeServer::AddHashEntry()
 176 {
 177         Utils->serverlist[GetName()] = this;
 178         Utils->sidlist[sid] = this;
 179 }
 180
 181 /** These accessors etc should be pretty self-
 182  * explanitory.
 183  */
 184 TreeServer* TreeServer::GetRoute()
 185 {
 186         return Route;
 187 }
 188
 189 const std::string& TreeServer::GetDesc()
 190 {
 191         return ServerDesc;
 192 }
 193
 194 const std::string& TreeServer::GetVersion()
 195 {
 196         return VersionString;
 197 }
 198
 199 void TreeServer::SetNextPingTime(time_t t)
 200 {
 201         this->NextPing = t;
 202         LastPingWasGood = false;
 203 }
 204
 205 time_t TreeServer::NextPingTime()
 206 {
 207         return NextPing;
 208 }
 209
 210 bool TreeServer::AnsweredLastPing()
 211 {
 212         return LastPingWasGood;
 213 }
 214
 215 void TreeServer::SetPingFlag()
 216 {
 217         LastPingWasGood = true;
 218 }
 219
 220 TreeSocket* TreeServer::GetSocket()
 221 {
 222         return Socket;
 223 }
 224
 225 TreeServer* TreeServer::GetParent()
 226 {
 227         return Parent;
 228 }
 229
 230 void TreeServer::SetVersion(const std::string &Version)
 231 {
 232         VersionString = Version;
 233 }
 234
 235 void TreeServer::AddChild(TreeServer* Child)
 236 {
 237         Children.push_back(Child);
 238 }
 239
 240 bool TreeServer::DelChild(TreeServer* Child)
 241 {
 242         std::vector<TreeServer*>::iterator it = std::find(Children.begin(), Children.end(), Child);
 243         if (it != Children.end())
 244         {
 245                 Children.erase(it);
 246                 return true;
 247         }
 248         return false;
 249 }
 250
 251 /** Removes child nodes of this node, and of that node, etc etc.
 252  * This is used during netsplits to automatically tidy up the
 253  * server tree. It is slow, we don't use it for much else.
 254  */
 255 void TreeServer::Tidy()
 256 {
 257         while (1)
 258         {
 259                 std::vector<TreeServer*>::iterator a = Children.begin();
 260                 if (a == Children.end())
 261                         return;
 262                 TreeServer* s = *a;
 263                 s->Tidy();
 264                 s->cull();
 265                 Children.erase(a);
 266                 delete s;
 267         }
 268 }
 269
 270 CullResult TreeServer::cull()
 271 {
 272         if (!IsRoot())
 273                 ServerUser->cull();
 274         return classbase::cull();
 275 }
 276
 277 TreeServer::~TreeServer()
 278 {
 279         /* We'd better tidy up after ourselves, eh? */
 280         if (!IsRoot())
 281                 delete ServerUser;
 282
 283         Utils->sidlist.erase(sid);
 284         Utils->serverlist.erase(GetName());
 285 }