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 : Server(ServerInstance->Config->ServerName, ServerInstance->Config->ServerDesc)
37 , Parent(NULL), Route(NULL)
38 , VersionString(ServerInstance->GetVersionString())
39 , fullversion(ServerInstance->GetVersionString(true))
40 , Socket(NULL), sid(ServerInstance->Config->GetSID()), behind_bursting(0), isdead(false)
41 , ServerUser(ServerInstance->FakeClient)
42 , age(ServerInstance->Time()), Warned(false), UserCount(ServerInstance->Users.GetLocalUsers().size())
43 , OperCount(0), rtt(0), StartBurst(0), Hidden(false)
48 /** When we create a new server, we call this constructor to initialize it.
49 * This constructor initializes the server's Route and Parent, and sets up
50 * its ping counters so that it will be pinged one minute from now.
52 TreeServer::TreeServer(const std::string& Name, const std::string& Desc, const std::string& id, TreeServer* Above, TreeSocket* Sock, bool Hide)
54 , Parent(Above), Socket(Sock), sid(id), behind_bursting(Parent->behind_bursting), isdead(false)
55 , ServerUser(new FakeUser(id, this))
56 , age(ServerInstance->Time()), Warned(false), UserCount(0), OperCount(0), rtt(0), StartBurst(0), Hidden(Hide)
58 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "New server %s behind_bursting %u", GetName().c_str(), behind_bursting);
60 SetNextPingTime(ServerInstance->Time() + Utils->PingFreq);
63 /* find the 'route' for this server (e.g. the one directly connected
64 * to the local server, which we can use to reach it)
66 * In the following example, consider we have just added a TreeServer
67 * class for server G on our network, of which we are server A.
68 * To route traffic to G (marked with a *) we must send the data to
69 * B (marked with a +) so this algorithm initializes the 'Route'
70 * value to point at whichever server traffic must be routed through
71 * to get here. If we were to try this algorithm with server B,
72 * the Route pointer would point at its own object ('this').
82 * We only run this algorithm when a server is created, as
83 * the routes remain constant while ever the server exists, and
84 * do not need to be re-calculated.
88 if (Route == Utils->TreeRoot)
94 while (this->Route->GetParent() != Utils->TreeRoot)
96 this->Route = Route->GetParent();
100 /* Because recursive code is slow and takes a lot of resources,
101 * we store two representations of the server tree. The first
102 * is a recursive structure where each server references its
103 * children and its parent, which is used for netbursts and
104 * netsplits to dump the whole dataset to the other server,
105 * and the second is used for very fast lookups when routing
106 * messages and is instead a hash_map, where each item can
107 * be referenced by its server name. The AddHashEntry()
108 * call below automatically inserts each TreeServer class
109 * into the hash_map as it is created. There is a similar
110 * maintainance call in the destructor to tidy up deleted
114 this->AddHashEntry();
115 Parent->AddChild(this);
118 void TreeServer::BeginBurst(unsigned long startms)
122 unsigned long now = ServerInstance->Time() * 1000 + (ServerInstance->Time_ns() / 1000000);
123 // If the start time is in the future (clocks are not synced) then use current time
124 if ((!startms) || (startms > now))
126 this->StartBurst = startms;
127 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Server %s started bursting at time %lu behind_bursting %u", sid.c_str(), startms, behind_bursting);
130 void TreeServer::FinishBurstInternal()
132 // Check is needed because 1202 protocol servers don't send the bursting state of a server, so servers
133 // introduced during a netburst may later send ENDBURST which would normally decrease this counter
134 if (behind_bursting > 0)
136 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "FinishBurstInternal() %s behind_bursting %u", GetName().c_str(), behind_bursting);
138 if (!IsBehindBursting())
140 SetNextPingTime(ServerInstance->Time() + Utils->PingFreq);
143 for (ChildServers::const_iterator i = Children.begin(); i != Children.end(); ++i)
145 TreeServer* child = *i;
146 child->FinishBurstInternal();
150 void TreeServer::FinishBurst()
152 ServerInstance->XLines->ApplyLines();
153 long ts = ServerInstance->Time() * 1000 + (ServerInstance->Time_ns() / 1000000);
154 unsigned long bursttime = ts - this->StartBurst;
155 ServerInstance->SNO->WriteToSnoMask(Parent == Utils->TreeRoot ? 'l' : 'L', "Received end of netburst from \2%s\2 (burst time: %lu %s)",
156 GetName().c_str(), (bursttime > 10000 ? bursttime / 1000 : bursttime), (bursttime > 10000 ? "secs" : "msecs"));
157 AddServerEvent(Utils->Creator, GetName());
160 FinishBurstInternal();
163 void TreeServer::SQuitChild(TreeServer* server, const std::string& reason)
165 DelServerEvent(Utils->Creator, server->GetName());
170 // Server split from us, generate a SQUIT message and broadcast it
171 ServerInstance->SNO->WriteGlobalSno('l', "Server \002" + server->GetName() + "\002 split: " + reason);
172 CmdBuilder("SQUIT").push(server->GetID()).push_last(reason).Broadcast();
176 ServerInstance->SNO->WriteToSnoMask('L', "Server \002" + server->GetName() + "\002 split from server \002" + GetName() + "\002 with reason: " + reason);
179 unsigned int num_lost_servers = 0;
180 server->SQuitInternal(num_lost_servers);
182 const std::string quitreason = GetName() + " " + server->GetName();
183 unsigned int num_lost_users = QuitUsers(quitreason);
185 ServerInstance->SNO->WriteToSnoMask(IsRoot() ? 'l' : 'L', "Netsplit complete, lost \002%u\002 user%s on \002%u\002 server%s.",
186 num_lost_users, num_lost_users != 1 ? "s" : "", num_lost_servers, num_lost_servers != 1 ? "s" : "");
188 // No-op if the socket is already closed (i.e. it called us)
189 if (server->IsLocal())
190 server->GetSocket()->Close();
192 // Add the server to the cull list, the servers behind it are handled by cull() and the destructor
193 ServerInstance->GlobalCulls.AddItem(server);
196 void TreeServer::SQuitInternal(unsigned int& num_lost_servers)
198 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Server %s lost in split", GetName().c_str());
200 for (ChildServers::const_iterator i = Children.begin(); i != Children.end(); ++i)
202 TreeServer* server = *i;
203 server->SQuitInternal(num_lost_servers);
206 // Mark server as dead
212 unsigned int TreeServer::QuitUsers(const std::string& reason)
214 std::string publicreason = ServerInstance->Config->HideSplits ? "*.net *.split" : reason;
216 const user_hash& users = ServerInstance->Users->GetUsers();
217 unsigned int original_size = users.size();
218 for (user_hash::const_iterator i = users.begin(); i != users.end(); )
220 User* user = i->second;
221 // Increment the iterator now because QuitUser() removes the user from the container
223 TreeServer* server = TreeServer::Get(user);
224 if (server->IsDead())
225 ServerInstance->Users->QuitUser(user, publicreason, &reason);
227 return original_size - users.size();
230 void TreeServer::CheckULine()
232 uline = silentuline = false;
234 ConfigTagList tags = ServerInstance->Config->ConfTags("uline");
235 for (ConfigIter i = tags.first; i != tags.second; ++i)
237 ConfigTag* tag = i->second;
238 std::string server = tag->getString("server");
239 if (!strcasecmp(server.c_str(), GetName().c_str()))
243 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Servers should not uline themselves (at " + tag->getTagLocation() + ")");
248 silentuline = tag->getBool("silent");
254 /** This method is used to add the structure to the
255 * hash_map for linear searches. It is only called
256 * by the constructors.
258 void TreeServer::AddHashEntry()
260 Utils->serverlist[GetName()] = this;
261 Utils->sidlist[sid] = this;
264 void TreeServer::SetNextPingTime(time_t t)
267 LastPingWasGood = false;
270 time_t TreeServer::NextPingTime()
275 bool TreeServer::AnsweredLastPing()
277 return LastPingWasGood;
280 void TreeServer::SetPingFlag()
282 LastPingWasGood = true;
285 void TreeServer::AddChild(TreeServer* Child)
287 Children.push_back(Child);
290 bool TreeServer::DelChild(TreeServer* Child)
292 return stdalgo::erase(Children, Child);
295 CullResult TreeServer::cull()
297 // Recursively cull all servers that are under us in the tree
298 for (ChildServers::const_iterator i = Children.begin(); i != Children.end(); ++i)
300 TreeServer* server = *i;
306 return classbase::cull();
309 TreeServer::~TreeServer()
311 // Recursively delete all servers that are under us in the tree first
312 for (ChildServers::const_iterator i = Children.begin(); i != Children.end(); ++i)
315 // Delete server user unless it's us
320 void TreeServer::RemoveHash()
322 // XXX: Erase server from UserManager::uuidlist now, to allow sid reuse in the current main loop
323 // iteration, before the cull list is applied
324 ServerInstance->Users->uuidlist.erase(sid);
326 Utils->sidlist.erase(sid);
327 Utils->serverlist.erase(GetName());