src/modules/m_spanningtree/treeserver.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
   6  * See: http://wiki.inspircd.org/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #include "inspircd.h"
  15 #include "commands/cmd_whois.h"
  16 #include "commands/cmd_stats.h"
  17 #include "socket.h"
  18 #include "xline.h"
  19 #include "transport.h"
  20
  21 #include "m_spanningtree/utils.h"
  22 #include "m_spanningtree/treeserver.h"
  23
  24 /* $ModDep: m_spanningtree/utils.h m_spanningtree/treeserver.h */
  25
  26 TreeServer::TreeServer(SpanningTreeUtilities* Util, InspIRCd* Instance, const std::string &id) : ServerInstance(Instance), Utils(Util)
  27 {
  28         Parent = NULL;
  29         bursting = false;
  30         ServerName.clear();
  31         ServerDesc.clear();
  32         VersionString.clear();
  33         ServerUserCount = ServerOperCount = 0;
  34         StartBurst = rtt = 0;
  35         Warned = Hidden = false;
  36         VersionString = ServerInstance->GetVersionString();
  37         SetID(id);
  38 }
  39
  40 /** We use this constructor only to create the 'root' item, Utils->TreeRoot, which
  41  * represents our own server. Therefore, it has no route, no parent, and
  42  * no socket associated with it. Its version string is our own local version.
  43  */
  44 TreeServer::TreeServer(SpanningTreeUtilities* Util, InspIRCd* Instance, std::string Name, std::string Desc, const std::string &id)
  45                                                 : ServerInstance(Instance), ServerName(Name.c_str()), ServerDesc(Desc), Utils(Util)
  46 {
  47         bursting = false;
  48         Parent = NULL;
  49         VersionString.clear();
  50         ServerUserCount = ServerOperCount = 0;
  51         VersionString = ServerInstance->GetVersionString();
  52         Route = NULL;
  53         Socket = NULL; /* Fix by brain */
  54         StartBurst = rtt = 0;
  55         Warned = Hidden = false;
  56         AddHashEntry();
  57         SetID(id);
  58 }
  59
  60 /** When we create a new server, we call this constructor to initialize it.
  61  * This constructor initializes the server's Route and Parent, and sets up
  62  * its ping counters so that it will be pinged one minute from now.
  63  */
  64 TreeServer::TreeServer(SpanningTreeUtilities* Util, InspIRCd* Instance, std::string Name, std::string Desc, const std::string &id, TreeServer* Above, TreeSocket* Sock, bool Hide)
  65         : ServerInstance(Instance), Parent(Above), ServerName(Name.c_str()), ServerDesc(Desc), Socket(Sock), Utils(Util), Hidden(Hide)
  66 {
  67         bursting = false;
  68         VersionString.clear();
  69         ServerUserCount = ServerOperCount = 0;
  70         this->SetNextPingTime(ServerInstance->Time() + Utils->PingFreq);
  71         this->SetPingFlag();
  72         Warned = false;
  73         StartBurst = rtt = 0;
  74
  75         timeval t;
  76         gettimeofday(&t, NULL);
  77         long ts = (t.tv_sec * 1000) + (t.tv_usec / 1000);
  78         this->StartBurst = ts;
  79         Instance->Logs->Log("m_spanningtree",DEBUG, "Started bursting at time %lu", ts);
  80
  81         /* find the 'route' for this server (e.g. the one directly connected
  82          * to the local server, which we can use to reach it)
  83          *
  84          * In the following example, consider we have just added a TreeServer
  85          * class for server G on our network, of which we are server A.
  86          * To route traffic to G (marked with a *) we must send the data to
  87          * B (marked with a +) so this algorithm initializes the 'Route'
  88          * value to point at whichever server traffic must be routed through
  89          * to get here. If we were to try this algorithm with server B,
  90          * the Route pointer would point at its own object ('this').
  91          *
  92          *            A
  93          *           / \
  94          *        + B   C
  95          *         / \   \
  96          *        D   E   F
  97          *       /         \
  98          *    * G           H
  99          *
 100          * We only run this algorithm when a server is created, as
 101          * the routes remain constant while ever the server exists, and
 102          * do not need to be re-calculated.
 103          */
 104
 105         Route = Above;
 106         if (Route == Utils->TreeRoot)
 107         {
 108                 Route = this;
 109         }
 110         else
 111         {
 112                 while (this->Route->GetParent() != Utils->TreeRoot)
 113                 {
 114                         this->Route = Route->GetParent();
 115                 }
 116         }
 117
 118         /* Because recursive code is slow and takes a lot of resources,
 119          * we store two representations of the server tree. The first
 120          * is a recursive structure where each server references its
 121          * children and its parent, which is used for netbursts and
 122          * netsplits to dump the whole dataset to the other server,
 123          * and the second is used for very fast lookups when routing
 124          * messages and is instead a hash_map, where each item can
 125          * be referenced by its server name. The AddHashEntry()
 126          * call below automatically inserts each TreeServer class
 127          * into the hash_map as it is created. There is a similar
 128          * maintainance call in the destructor to tidy up deleted
 129          * servers.
 130          */
 131
 132         this->AddHashEntry();
 133
 134         SetID(id);
 135 }
 136
 137 std::string& TreeServer::GetID()
 138 {
 139         return sid;
 140 }
 141
 142 void TreeServer::FinishBurstInternal()
 143 {
 144         this->bursting = false;
 145         for(unsigned int q=0; q < ChildCount(); q++)
 146         {
 147                 TreeServer* child = GetChild(q);
 148                 child->FinishBurstInternal();
 149         }
 150 }
 151
 152 void TreeServer::FinishBurst()
 153 {
 154         FinishBurstInternal();
 155         ServerInstance->XLines->ApplyLines();
 156         timeval t;
 157         gettimeofday(&t, NULL);
 158         long ts = (t.tv_sec * 1000) + (t.tv_usec / 1000);
 159         unsigned long bursttime = ts - this->StartBurst;
 160         ServerInstance->SNO->WriteToSnoMask('l', "Received end of netburst from \2%s\2 (burst time: %lu %s)", ServerName.c_str(), (bursttime > 1000 ? bursttime / 1000 : bursttime), (bursttime > 1000 ? "secs" : "msecs"));
 161         Event rmode((char*)ServerName.c_str(),  (Module*)Utils->Creator, "new_server");
 162         rmode.Send(ServerInstance);
 163 }
 164
 165 void TreeServer::SetID(const std::string &id)
 166 {
 167         ServerInstance->Logs->Log("m_spanningtree",DEBUG, "Setting SID to " + id);
 168         sid = id;
 169         Utils->sidlist[sid] = this;
 170 }
 171
 172 int TreeServer::QuitUsers(const std::string &reason)
 173 {
 174         const char* reason_s = reason.c_str();
 175         std::vector<User*> time_to_die;
 176         for (user_hash::iterator n = ServerInstance->Users->clientlist->begin(); n != ServerInstance->Users->clientlist->end(); n++)
 177         {
 178                 if (!strcmp(n->second->server, this->ServerName.c_str()))
 179                 {
 180                         time_to_die.push_back(n->second);
 181                 }
 182         }
 183         for (std::vector<User*>::iterator n = time_to_die.begin(); n != time_to_die.end(); n++)
 184         {
 185                 User* a = (User*)*n;
 186                 if (!IS_LOCAL(a))
 187                 {
 188                         if (ServerInstance->Config->HideSplits)
 189                                 ServerInstance->Users->QuitUser(a, "*.net *.split", reason_s);
 190                         else
 191                                 ServerInstance->Users->QuitUser(a, reason_s);
 192
 193                         if (this->Utils->quiet_bursts)
 194                                 ServerInstance->GlobalCulls.MakeSilent(a);
 195                 }
 196         }
 197         return time_to_die.size();
 198 }
 199
 200 /** This method is used to add the structure to the
 201  * hash_map for linear searches. It is only called
 202  * by the constructors.
 203  */
 204 void TreeServer::AddHashEntry()
 205 {
 206         server_hash::iterator iter = Utils->serverlist.find(this->ServerName.c_str());
 207         if (iter == Utils->serverlist.end())
 208                 Utils->serverlist[this->ServerName.c_str()] = this;
 209 }
 210
 211 /** This method removes the reference to this object
 212  * from the hash_map which is used for linear searches.
 213  * It is only called by the default destructor.
 214  */
 215 void TreeServer::DelHashEntry()
 216 {
 217         server_hash::iterator iter = Utils->serverlist.find(this->ServerName.c_str());
 218         if (iter != Utils->serverlist.end())
 219                 Utils->serverlist.erase(iter);
 220 }
 221
 222 /** These accessors etc should be pretty self-
 223  * explanitory.
 224  */
 225 TreeServer* TreeServer::GetRoute()
 226 {
 227         return Route;
 228 }
 229
 230 std::string TreeServer::GetName()
 231 {
 232         return ServerName.c_str();
 233 }
 234
 235 std::string TreeServer::GetDesc()
 236 {
 237         return ServerDesc;
 238 }
 239
 240 std::string TreeServer::GetVersion()
 241 {
 242         return VersionString;
 243 }
 244
 245 void TreeServer::SetNextPingTime(time_t t)
 246 {
 247         this->NextPing = t;
 248         LastPingWasGood = false;
 249 }
 250
 251 time_t TreeServer::NextPingTime()
 252 {
 253         return NextPing;
 254 }
 255
 256 bool TreeServer::AnsweredLastPing()
 257 {
 258         return LastPingWasGood;
 259 }
 260
 261 void TreeServer::SetPingFlag()
 262 {
 263         LastPingWasGood = true;
 264 }
 265
 266 unsigned int TreeServer::GetUserCount()
 267 {
 268         return ServerUserCount;
 269 }
 270
 271 void TreeServer::SetUserCount(int diff)
 272 {
 273         ServerUserCount += diff;
 274 }
 275
 276 void TreeServer::SetOperCount(int diff)
 277 {
 278         ServerOperCount += diff;
 279 }
 280
 281 unsigned int TreeServer::GetOperCount()
 282 {
 283         return ServerOperCount;
 284 }
 285
 286 TreeSocket* TreeServer::GetSocket()
 287 {
 288         return Socket;
 289 }
 290
 291 TreeServer* TreeServer::GetParent()
 292 {
 293         return Parent;
 294 }
 295
 296 void TreeServer::SetVersion(const std::string &Version)
 297 {
 298         VersionString = Version;
 299 }
 300
 301 unsigned int TreeServer::ChildCount()
 302 {
 303         return Children.size();
 304 }
 305
 306 TreeServer* TreeServer::GetChild(unsigned int n)
 307 {
 308         if (n < Children.size())
 309         {
 310                 /* Make sure they  cant request
 311                  * an out-of-range object. After
 312                  * all we know what these programmer
 313                  * types are like *grin*.
 314                  */
 315                 return Children[n];
 316         }
 317         else
 318         {
 319                 return NULL;
 320         }
 321 }
 322
 323 void TreeServer::AddChild(TreeServer* Child)
 324 {
 325         Children.push_back(Child);
 326 }
 327
 328 bool TreeServer::DelChild(TreeServer* Child)
 329 {
 330         for (std::vector<TreeServer*>::iterator a = Children.begin(); a < Children.end(); a++)
 331         {
 332                 if (*a == Child)
 333                 {
 334                         Children.erase(a);
 335                         return true;
 336                 }
 337         }
 338         return false;
 339 }
 340
 341 /** Removes child nodes of this node, and of that node, etc etc.
 342  * This is used during netsplits to automatically tidy up the
 343  * server tree. It is slow, we don't use it for much else.
 344  */
 345 bool TreeServer::Tidy()
 346 {
 347         bool stillchildren = true;
 348         while (stillchildren)
 349         {
 350                 stillchildren = false;
 351                 for (std::vector<TreeServer*>::iterator a = Children.begin(); a < Children.end(); a++)
 352                 {
 353                         TreeServer* s = (TreeServer*)*a;
 354                         s->Tidy();
 355                         Children.erase(a);
 356                         delete s;
 357                         stillchildren = true;
 358                         break;
 359                 }
 360         }
 361         return true;
 362 }
 363
 364 TreeServer::~TreeServer()
 365 {
 366         /* We'd better tidy up after ourselves, eh? */
 367         this->DelHashEntry();
 368
 369         server_hash::iterator iter = Utils->sidlist.find(GetID());
 370         if (iter != Utils->sidlist.end())
 371                 Utils->sidlist.erase(iter);
 372 }