X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fm_spanningtree%2Ftreeserver.h;h=753a7bc131000b28ad2ea75bee079a19a5f3420b;hb=HEAD;hp=9f2e24172ad2d440bdc6ecf188b74e37bd2de252;hpb=5cc9614e73a783dec7a8e0887a0435cf577eaad4;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/m_spanningtree/treeserver.h b/src/modules/m_spanningtree/treeserver.h index 9f2e24172..753a7bc13 100644 --- a/src/modules/m_spanningtree/treeserver.h +++ b/src/modules/m_spanningtree/treeserver.h @@ -1,9 +1,14 @@ /* * InspIRCd -- Internet Relay Chat Daemon * + * Copyright (C) 2017 B00mX0r + * Copyright (C) 2013, 2017, 2019 Sadie Powell + * Copyright (C) 2012-2015 Attila Molnar + * Copyright (C) 2012, 2019 Robby + * Copyright (C) 2009-2010 Daniel De Graaf * Copyright (C) 2008 Robin Burchell + * Copyright (C) 2007, 2010 Craig Edwards * Copyright (C) 2007 Dennis Friis - * Copyright (C) 2007 Craig Edwards * * 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 @@ -22,6 +27,7 @@ #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 @@ -37,31 +43,53 @@ * TreeServer items, deleting and inserting them as they * are created and destroyed. */ -class TreeServer : public classbase +class TreeServer : public Server { TreeServer* Parent; /* Parent entry */ TreeServer* Route; /* Route entry */ std::vector Children; /* List of child objects */ - std::string ServerName; /* Server's name */ - std::string ServerDesc; /* Server's description */ std::string VersionString; /* Version string or empty string */ + + /** Full version string including patch version and other info + */ + std::string fullversion; + std::string rawversion; + TreeSocket* Socket; /* Socket used to communicate with this server */ - 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 */ - std::string sid; /* Server 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. + */ + unsigned int behind_bursting; + + /** 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(); + /** Used by SQuit logic to recursively remove servers + */ + void SQuitInternal(unsigned int& num_lost_servers, bool error); + + /** Remove the reference to this server from the hash maps + */ + void RemoveHash(); + public: + typedef std::vector ChildServers; FakeUser* const ServerUser; /* User representing this server */ const time_t age; - bool Warned; /* True if we've warned opers about high latency on this server */ - bool bursting; /* whether or not this server is bursting */ - 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? */ @@ -77,13 +105,29 @@ class TreeServer : public classbase */ TreeServer(const std::string& Name, const std::string& Desc, const std::string& id, TreeServer* Above, TreeSocket* Sock, bool Hide); - int QuitUsers(const std::string &reason); + /** 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 + * @param error Whether the server is being squit because of an error. + */ + void SQuitChild(TreeServer* server, const std::string& reason, bool error = false); + + /** SQuit this server, removing this server and all servers behind it + * @param reason Reason for quitting the server, sent to opers and other servers + * @param error Whether the server is being squit because of an error. + */ + void SQuit(const std::string& reason, bool error = false) + { + GetParent()->SQuitChild(this, reason, error); + } + + 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(); + TreeServer* GetRoute() const { return Route; } /** Returns true if this server is the tree root (i.e.: us) */ @@ -93,89 +137,68 @@ class TreeServer : public classbase */ bool IsLocal() const { return (this->Route == this); } - /** Get server name + /** Returns true if the server is awaiting destruction + * @return True if the server is waiting to be culled and deleted, false otherwise */ - const std::string& GetName() const { return ServerName; } - - /** Get server description (GECOS) - */ - const std::string& GetDesc(); + bool IsDead() const { return isdead; } /** Get server version string */ - const std::string& GetVersion(); - - /** Set time we are next due to ping this server - */ - void SetNextPingTime(time_t t); + const std::string& GetVersion() const { return VersionString; } - /** Get the time we are next due to ping this server + /** Get the full version string of this server + * @return The full version string of this server, including patch version and other info */ - time_t NextPingTime(); + const std::string& GetFullVersion() const { return fullversion; } - /** Last ping time in milliseconds, 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; - /** When we recieved BURST from this server, used to calculate total burst time at ENDBURST. + /** When we received BURST from this server, used to calculate total burst time at ENDBURST. */ - unsigned long StartBurst; + uint64_t StartBurst; /** True if this server is hidden */ bool Hidden; - /** True if the server answered their last ping - */ - bool AnsweredLastPing(); - - /** Set the server as responding to its last ping - */ - void SetPingFlag(); - /** Get the TreeSocket pointer for local servers. * For remote servers, this returns NULL. */ - TreeSocket* GetSocket(); + TreeSocket* GetSocket() const { return Socket; } /** Get the parent server. * For the root node, this returns NULL. */ - TreeServer* GetParent(); + TreeServer* GetParent() const { return Parent; } /** Set the server version string */ - void SetVersion(const std::string &Version); + void SetVersion(const std::string& verstr) { VersionString = verstr; } - /** Return number of child servers + /** Set the full version string + * @param verstr The version string to set */ - unsigned int ChildCount(); + void SetFullVersion(const std::string& verstr) { fullversion = verstr; } - /** Return a child server indexed 0..n + /** Set the raw version string */ - TreeServer* GetChild(unsigned int n); + void SetRawVersion(const std::string& verstr) { rawversion = verstr; } - /** Add a child server + /** 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 */ - void AddChild(TreeServer* Child); + void SetDesc(const std::string& descstr) { description = descstr; } - /** Delete a child server, return false if it didn't exist. + /** Return all child servers */ - bool DelChild(TreeServer* Child); - - /** 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. - */ - void Tidy(); - - /** Get server ID - */ - const std::string& GetID(); + const ChildServers& GetChildren() const { return Children; } /** Marks a server as having finished bursting and performs appropriate actions. */ @@ -183,11 +206,42 @@ class TreeServer : public classbase /** Recursive call for child servers */ void FinishBurstInternal(); - CullResult cull(); + /** (Re)check the uline state of this server + */ + void CheckULine(); - /** Destructor - * Removes the reference to this object from the - * hash maps. + /** Get the bursting state of this server + * @return True if this server is bursting, false if it isn't + */ + bool IsBursting() const { return (StartBurst != 0); } + + /** 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 IsBehindBursting() const { return (behind_bursting != 0); } + + /** Set the bursting state of the server + * @param startms Time the server started bursting, if 0 or omitted, use current time + */ + void BeginBurst(uint64_t startms = 0); + + /** Register a PONG from the server + */ + void OnPong() { pingtimer.OnPong(); } + + CullResult cull() CXX11_OVERRIDE; + + /** 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); + } };