X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fm_spanningtree%2Ftreeserver.h;h=037edd1943599c8165fb409ec41990ff09e2b3d1;hb=b4599531f97a9e6207b6bb8d728d7523b6995523;hp=28e36252d905a6cd18e5a309d0d7aee2dd2d0b85;hpb=2add2b79ca3152201e325ed75c09e0c9bd0fecc4;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/m_spanningtree/treeserver.h b/src/modules/m_spanningtree/treeserver.h index 28e36252d..037edd194 100644 --- a/src/modules/m_spanningtree/treeserver.h +++ b/src/modules/m_spanningtree/treeserver.h @@ -1,18 +1,28 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd: (C) 2002-2007 InspIRCd Development Team - * See: http://www.inspircd.org/wiki/index.php/Credits + * Copyright (C) 2008 Robin Burchell + * Copyright (C) 2007 Dennis Friis + * Copyright (C) 2007 Craig Edwards * - * This program is free but copyrighted software; see - * the file COPYING for details. + * This file is part of InspIRCd. InspIRCd is free software: you can + * redistribute it and/or modify it under the terms of the GNU General Public + * License as published by the Free Software Foundation, version 2. * - * --------------------------------------------------- + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . */ -#ifndef __TREESERVER_H__ -#define __TREESERVER_H__ + +#pragma once + +#include "treesocket.h" +#include "pingtimer.h" /** Each server in the tree is represented by one class of * type TreeServer. A locally connected TreeServer can @@ -28,179 +38,208 @@ * TreeServer items, deleting and inserting them as they * are created and destroyed. */ -class TreeServer : public classbase +class TreeServer : public Server { - InspIRCd* ServerInstance; /* Creator */ TreeServer* Parent; /* Parent entry */ TreeServer* Route; /* Route entry */ std::vector Children; /* List of child objects */ - irc::string ServerName; /* Server's name */ - std::string ServerDesc; /* Server's description */ std::string VersionString; /* Version string or empty string */ - unsigned int ServerUserCount; /* How many users are on this server? [note: doesn't care about +i] */ - unsigned int ServerOperCount; /* How many opers are on this server? */ - TreeSocket* Socket; /* For directly connected servers this points at the socket object */ - time_t NextPing; /* After this time, the server should be PINGed*/ - bool LastPingWasGood; /* True if the server responded to the last PING with a PONG */ - SpanningTreeUtilities* Utils; /* Utility class */ + + /** Full version string including patch version and other info + */ + std::string fullversion; + std::string rawversion; + + TreeSocket* Socket; /* Socket used to communicate with this server */ std::string sid; /* Server ID */ - bool DupError; /* True if the server ID is duplicated (!) */ - /** Set server ID - * @param id Server ID - * @throws CoreException on duplicate ID + /** Counter counting how many servers are bursting in front of this server, including + * this server. Set to parents' value on construction then it is increased if the + * server itself starts bursting. Decreased when a server on the path to this server + * finishes burst. */ - void SetID(const std::string &id); + unsigned int behind_bursting; - public: + /** True if this server has been lost in a split and is awaiting destruction + */ + bool isdead; + + /** Timer handling PINGing the server and killing it on timeout + */ + PingTimer pingtimer; + + /** This method is used to add this TreeServer to the + * hash maps. It is only called by the constructors. + */ + void AddHashEntry(); - bool Warned; /* True if we've warned opers about high latency on this server */ + /** Used by SQuit logic to recursively remove servers + */ + void SQuitInternal(unsigned int& num_lost_servers); - /** We don't use this constructor. Its a dummy, and won't cause any insertion - * of the TreeServer into the hash_map. See below for the two we DO use. + /** Remove the reference to this server from the hash maps */ - TreeServer(SpanningTreeUtilities* Util, InspIRCd* Instance, const std::string &id); + void RemoveHash(); + + public: + typedef std::vector ChildServers; + FakeUser* const ServerUser; /* User representing this server */ + const time_t age; + + unsigned int UserCount; /* How many users are on this server? [note: doesn't care about +i] */ + unsigned int OperCount; /* How many opers are on this server? */ /** We use this constructor only to create the 'root' item, Utils->TreeRoot, which * represents our own server. Therefore, it has no route, no parent, and * no socket associated with it. Its version string is our own local version. */ - TreeServer(SpanningTreeUtilities* Util, InspIRCd* Instance, std::string Name, std::string Desc, const std::string &id); - + TreeServer(); + /** When we create a new server, we call this constructor to initialize it. * This constructor initializes the server's Route and Parent, and sets up * its ping counters so that it will be pinged one minute from now. */ - TreeServer(SpanningTreeUtilities* Util, InspIRCd* Instance, std::string Name, std::string Desc, const std::string &id, TreeServer* Above, TreeSocket* Sock, bool Hide); - - int QuitUsers(const std::string &reason); + TreeServer(const std::string& Name, const std::string& Desc, const std::string& id, TreeServer* Above, TreeSocket* Sock, bool Hide); - /** This method is used to add the structure to the - * hash_map for linear searches. It is only called - * by the constructors. + /** SQuit a server connected to this server, removing the given server and all servers behind it + * @param server Server to squit, must be directly below this server + * @param reason Reason for quitting the server, sent to opers and other servers */ - void AddHashEntry(); + void SQuitChild(TreeServer* server, const std::string& reason); - /** This method removes the reference to this object - * from the hash_map which is used for linear searches. - * It is only called by the default destructor. + /** SQuit this server, removing this server and all servers behind it + * @param reason Reason for quitting the server, sent to opers and other servers */ - void DelHashEntry(); + void SQuit(const std::string& reason) + { + GetParent()->SQuitChild(this, reason); + } + + static unsigned int QuitUsers(const std::string& reason); /** Get route. * The 'route' is defined as the locally- * connected server which can be used to reach this server. */ - TreeServer* GetRoute(); - - /** Get server name - */ - std::string GetName(); + TreeServer* GetRoute() const { return Route; } - /** Get server description (GECOS) + /** Returns true if this server is the tree root (i.e.: us) */ - std::string GetDesc(); + bool IsRoot() const { return (this->Parent == NULL); } - /** Get server version string + /** Returns true if this server is locally connected */ - std::string GetVersion(); + bool IsLocal() const { return (this->Route == this); } - /** Set time we are next due to ping this server + /** Returns true if the server is awaiting destruction + * @return True if the server is waiting to be culled and deleted, false otherwise */ - void SetNextPingTime(time_t t); + bool IsDead() const { return isdead; } - /** Get the time we are next due to ping this server + /** Get server version string */ - time_t NextPingTime(); + const std::string& GetVersion() const { return VersionString; } - /** Time of last ping used to calculate this->rtt below + /** Get the full version string of this server + * @return The full version string of this server, including patch version and other info */ - time_t LastPing; + const std::string& GetFullVersion() const { return fullversion; } - /** Last ping time in microseconds, used to calculate round trip time + /** Get the raw version string of this server */ - unsigned long LastPingMsec; + const std::string& GetRawVersion() const { return rawversion; } /** Round trip time of last ping */ unsigned long rtt; - /** True if this server is hidden + /** When we recieved BURST from this server, used to calculate total burst time at ENDBURST. */ - bool Hidden; + uint64_t StartBurst; - /** True if the server answered their last ping + /** True if this server is hidden */ - bool AnsweredLastPing(); + bool Hidden; - /** Set the server as responding to its last ping + /** Get the TreeSocket pointer for local servers. + * For remote servers, this returns NULL. */ - void SetPingFlag(); + TreeSocket* GetSocket() const { return Socket; } - /** Get the number of users on this server. + /** Get the parent server. + * For the root node, this returns NULL. */ - unsigned int GetUserCount(); + TreeServer* GetParent() const { return Parent; } - /** Increment or decrement the user count by diff. + /** Set the server version string */ - void SetUserCount(int diff); + void SetVersion(const std::string& verstr) { VersionString = verstr; } - /** Gets the numbers of opers on this server. + /** Set the full version string + * @param verstr The version string to set */ - unsigned int GetOperCount(); + void SetFullVersion(const std::string& verstr) { fullversion = verstr; } - /** Increment or decrement the oper count by diff. + /** Set the raw version string */ - void SetOperCount(int diff); + void SetRawVersion(const std::string& verstr) { rawversion = verstr; } - /** Get the TreeSocket pointer for local servers. - * For remote servers, this returns NULL. + /** Sets the description of this server. Called when the description of a remote server changes + * and we are notified about it. + * @param descstr The description to set */ - TreeSocket* GetSocket(); + void SetDesc(const std::string& descstr) { description = descstr; } - /** Get the parent server. - * For the root node, this returns NULL. + /** Return all child servers */ - TreeServer* GetParent(); + const ChildServers& GetChildren() const { return Children; } - /** Set the server version string + /** Get server ID */ - void SetVersion(const std::string &Version); + const std::string& GetID() const { return sid; } - /** Return number of child servers + /** Marks a server as having finished bursting and performs appropriate actions. */ - unsigned int ChildCount(); + void FinishBurst(); + /** Recursive call for child servers */ + void FinishBurstInternal(); - /** Return a child server indexed 0..n + /** (Re)check the uline state of this server */ - TreeServer* GetChild(unsigned int n); + void CheckULine(); - /** Add a child server + /** Get the bursting state of this server + * @return True if this server is bursting, false if it isn't */ - void AddChild(TreeServer* Child); + bool IsBursting() const { return (StartBurst != 0); } - /** Delete a child server, return false if it didn't exist. + /** Check whether this server is behind a bursting server or is itself bursting. + * This can tell whether a user is on a part of the network that is still bursting. + * @return True if this server is bursting or is behind a server that is bursting, false if it isn't */ - bool DelChild(TreeServer* Child); + bool IsBehindBursting() const { return (behind_bursting != 0); } - /** Removes child nodes of this node, and of that node, etc etc. - * This is used during netsplits to automatically tidy up the - * server tree. It is slow, we don't use it for much else. + /** Set the bursting state of the server + * @param startms Time the server started bursting, if 0 or omitted, use current time */ - bool Tidy(); + void BeginBurst(uint64_t startms = 0); - /** Get server ID + /** Register a PONG from the server */ - std::string& GetID(); + void OnPong() { pingtimer.OnPong(); } - /** True on duplicate server ID (server not usable) - */ - bool DuplicateID(); + CullResult cull() CXX11_OVERRIDE; - /** Destructor + /** Destructor, deletes ServerUser unless IsRoot() */ ~TreeServer(); + /** Returns the TreeServer the given user is connected to + * @param user The user whose server to return + * @return The TreeServer this user is connected to. + */ + static TreeServer* Get(User* user) + { + return static_cast(user->server); + } }; - -#endif