2 * InspIRCd -- Internet Relay Chat Daemon
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>
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.
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
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/>.
26 #include "modules/spanningtree.h"
29 #include "treeserver.h"
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.
35 TreeServer::TreeServer()
36 : Parent(NULL), Route(NULL), ServerName(ServerInstance->Config->ServerName), ServerDesc(ServerInstance->Config->ServerDesc)
37 , VersionString(ServerInstance->GetVersionString()), Socket(NULL), sid(ServerInstance->Config->GetSID()), ServerUser(ServerInstance->FakeClient)
38 , age(ServerInstance->Time()), Warned(false), bursting(false), UserCount(0), OperCount(0), rtt(0), StartBurst(0), Hidden(false)
43 /** When we create a new server, we call this constructor to initialize it.
44 * This constructor initializes the server's Route and Parent, and sets up
45 * its ping counters so that it will be pinged one minute from now.
47 TreeServer::TreeServer(const std::string& Name, const std::string& Desc, const std::string& id, TreeServer* Above, TreeSocket* Sock, bool Hide)
48 : Parent(Above), ServerName(Name), ServerDesc(Desc), Socket(Sock), sid(id), ServerUser(new FakeUser(id, Name))
49 , age(ServerInstance->Time()), Warned(false), bursting(true), UserCount(0), OperCount(0), rtt(0), Hidden(Hide)
51 SetNextPingTime(ServerInstance->Time() + Utils->PingFreq);
54 long ts = ServerInstance->Time() * 1000 + (ServerInstance->Time_ns() / 1000000);
55 this->StartBurst = ts;
56 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Server %s started bursting at time %lu", sid.c_str(), ts);
58 /* find the 'route' for this server (e.g. the one directly connected
59 * to the local server, which we can use to reach it)
61 * In the following example, consider we have just added a TreeServer
62 * class for server G on our network, of which we are server A.
63 * To route traffic to G (marked with a *) we must send the data to
64 * B (marked with a +) so this algorithm initializes the 'Route'
65 * value to point at whichever server traffic must be routed through
66 * to get here. If we were to try this algorithm with server B,
67 * the Route pointer would point at its own object ('this').
77 * We only run this algorithm when a server is created, as
78 * the routes remain constant while ever the server exists, and
79 * do not need to be re-calculated.
83 if (Route == Utils->TreeRoot)
89 while (this->Route->GetParent() != Utils->TreeRoot)
91 this->Route = Route->GetParent();
95 /* Because recursive code is slow and takes a lot of resources,
96 * we store two representations of the server tree. The first
97 * is a recursive structure where each server references its
98 * children and its parent, which is used for netbursts and
99 * netsplits to dump the whole dataset to the other server,
100 * and the second is used for very fast lookups when routing
101 * messages and is instead a hash_map, where each item can
102 * be referenced by its server name. The AddHashEntry()
103 * call below automatically inserts each TreeServer class
104 * into the hash_map as it is created. There is a similar
105 * maintainance call in the destructor to tidy up deleted
109 this->AddHashEntry();
112 const std::string& TreeServer::GetID()
117 void TreeServer::FinishBurstInternal()
119 this->bursting = false;
120 SetNextPingTime(ServerInstance->Time() + Utils->PingFreq);
122 for(unsigned int q=0; q < ChildCount(); q++)
124 TreeServer* child = GetChild(q);
125 child->FinishBurstInternal();
129 void TreeServer::FinishBurst()
131 FinishBurstInternal();
132 ServerInstance->XLines->ApplyLines();
133 long ts = ServerInstance->Time() * 1000 + (ServerInstance->Time_ns() / 1000000);
134 unsigned long bursttime = ts - this->StartBurst;
135 ServerInstance->SNO->WriteToSnoMask(Parent == Utils->TreeRoot ? 'l' : 'L', "Received end of netburst from \2%s\2 (burst time: %lu %s)",
136 ServerName.c_str(), (bursttime > 10000 ? bursttime / 1000 : bursttime), (bursttime > 10000 ? "secs" : "msecs"));
137 AddServerEvent(Utils->Creator, ServerName);
140 int TreeServer::QuitUsers(const std::string &reason)
142 const char* reason_s = reason.c_str();
143 std::vector<User*> time_to_die;
144 for (user_hash::iterator n = ServerInstance->Users->clientlist->begin(); n != ServerInstance->Users->clientlist->end(); n++)
146 if (n->second->server == ServerName)
148 time_to_die.push_back(n->second);
151 for (std::vector<User*>::iterator n = time_to_die.begin(); n != time_to_die.end(); n++)
156 if (Utils->quiet_bursts)
159 if (ServerInstance->Config->HideSplits)
160 ServerInstance->Users->QuitUser(a, "*.net *.split", reason_s);
162 ServerInstance->Users->QuitUser(a, reason_s);
165 return time_to_die.size();
168 /** This method is used to add the structure to the
169 * hash_map for linear searches. It is only called
170 * by the constructors.
172 void TreeServer::AddHashEntry()
174 Utils->serverlist[ServerName] = this;
175 Utils->sidlist[sid] = this;
178 /** These accessors etc should be pretty self-
181 TreeServer* TreeServer::GetRoute()
186 const std::string& TreeServer::GetDesc()
191 const std::string& TreeServer::GetVersion()
193 return VersionString;
196 void TreeServer::SetNextPingTime(time_t t)
199 LastPingWasGood = false;
202 time_t TreeServer::NextPingTime()
207 bool TreeServer::AnsweredLastPing()
209 return LastPingWasGood;
212 void TreeServer::SetPingFlag()
214 LastPingWasGood = true;
217 TreeSocket* TreeServer::GetSocket()
222 TreeServer* TreeServer::GetParent()
227 void TreeServer::SetVersion(const std::string &Version)
229 VersionString = Version;
232 unsigned int TreeServer::ChildCount()
234 return Children.size();
237 TreeServer* TreeServer::GetChild(unsigned int n)
239 if (n < Children.size())
241 /* Make sure they cant request
242 * an out-of-range object. After
243 * all we know what these programmer
244 * types are like *grin*.
254 void TreeServer::AddChild(TreeServer* Child)
256 Children.push_back(Child);
259 bool TreeServer::DelChild(TreeServer* Child)
261 std::vector<TreeServer*>::iterator it = std::find(Children.begin(), Children.end(), Child);
262 if (it != Children.end())
270 /** Removes child nodes of this node, and of that node, etc etc.
271 * This is used during netsplits to automatically tidy up the
272 * server tree. It is slow, we don't use it for much else.
274 void TreeServer::Tidy()
278 std::vector<TreeServer*>::iterator a = Children.begin();
279 if (a == Children.end())
289 CullResult TreeServer::cull()
291 if (ServerUser != ServerInstance->FakeClient)
293 return classbase::cull();
296 TreeServer::~TreeServer()
298 /* We'd better tidy up after ourselves, eh? */
299 if (ServerUser != ServerInstance->FakeClient)
302 Utils->sidlist.erase(sid);
303 Utils->serverlist.erase(ServerName);