]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/socketengines/socketengine_kqueue.cpp
Add support for blocking tag messages with the deaf mode.
[user/henk/code/inspircd.git] / src / socketengines / socketengine_kqueue.cpp
index 63a877238cf77ad7b88b11b2a741f4fdf0a30eb8..e0a0535f4e8859da6de71de5ffa9cea42027a4c0 100644 (file)
@@ -1,76 +1,75 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2010 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ *   Copyright (C) 2014-2015 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2014 Adam <Adam@anope.org>
+ *   Copyright (C) 2012-2013, 2017, 2019 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
+ *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2006-2008, 2010 Craig Edwards <brain@inspircd.org>
  *
- * 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 <http://www.gnu.org/licenses/>.
  */
 
+
 #include "inspircd.h"
-#include "exitcodes.h"
+
 #include <sys/types.h>
 #include <sys/event.h>
 #include <sys/time.h>
-#include "socketengine.h"
+#include <sys/sysctl.h>
 
-/** A specialisation of the SocketEngine class, designed to use FreeBSD kqueue().
+/** A specialisation of the SocketEngine class, designed to use BSD kqueue().
  */
-class KQueueEngine : public SocketEngine
+namespace
 {
-private:
        int EngineHandle;
+       unsigned int ChangePos = 0;
        /** These are used by kqueue() to hold socket events
         */
-       struct kevent* ke_list;
-       /** This is a specialised time value used by kqueue()
-        */
-       struct timespec ts;
-public:
-       /** Create a new KQueueEngine
-        */
-       KQueueEngine();
-       /** Delete a KQueueEngine
-        */
-       virtual ~KQueueEngine();
-       bool AddFd(EventHandler* eh, int event_mask);
-       void OnSetEvent(EventHandler* eh, int old_mask, int new_mask);
-       virtual bool DelFd(EventHandler* eh, bool force = false);
-       virtual int DispatchEvents();
-       virtual std::string GetName();
-       virtual void RecoverFromFork();
-};
+       std::vector<struct kevent> ke_list(16);
 
-#include <sys/sysctl.h>
+       /** Pending changes
+        */
+       std::vector<struct kevent> changelist(8);
 
-KQueueEngine::KQueueEngine()
-{
-       MAX_DESCRIPTORS = 0;
-       int mib[2];
-       size_t len;
-
-       mib[0] = CTL_KERN;
-       mib[1] = KERN_MAXFILES;
-       len = sizeof(MAX_DESCRIPTORS);
-       sysctl(mib, 2, &MAX_DESCRIPTORS, &len, NULL, 0);
-       if (MAX_DESCRIPTORS <= 0)
+#if defined __NetBSD__ && __NetBSD_Version__ <= 999001400
+       inline intptr_t udata_cast(EventHandler* eh)
        {
-               ServerInstance->Logs->Log("SOCKET", DEFAULT, "ERROR: Can't determine maximum number of open sockets!");
-               printf("ERROR: Can't determine maximum number of open sockets!\n");
-               ServerInstance->Exit(EXIT_STATUS_SOCKETENGINE);
+               // On NetBSD <10 the last parameter of EV_SET is intptr_t.
+               return reinterpret_cast<intptr_t>(eh);
        }
+#else
+       inline void* udata_cast(EventHandler* eh)
+       {
+               // On other platforms the last parameter of EV_SET is void*.
+               return static_cast<void*>(eh);
+       }
+#endif
+}
 
-       this->RecoverFromFork();
-       ke_list = new struct kevent[GetMaxFds()];
-       ref = new EventHandler* [GetMaxFds()];
-       memset(ref, 0, GetMaxFds() * sizeof(EventHandler*));
+/** Initialize the kqueue engine
+ */
+void SocketEngine::Init()
+{
+       LookupMaxFds();
+       RecoverFromFork();
 }
 
-void KQueueEngine::RecoverFromFork()
+void SocketEngine::RecoverFromFork()
 {
        /*
         * The only bad thing about kqueue is that its fd cant survive a fork and is not inherited.
@@ -79,175 +78,142 @@ void KQueueEngine::RecoverFromFork()
         */
        EngineHandle = kqueue();
        if (EngineHandle == -1)
-       {
-               ServerInstance->Logs->Log("SOCKET",DEFAULT, "ERROR: Could not initialize socket engine. Your kernel probably does not have the proper features.");
-               ServerInstance->Logs->Log("SOCKET",DEFAULT, "ERROR: this is a fatal error, exiting now.");
-               printf("ERROR: Could not initialize socket engine. Your kernel probably does not have the proper features.\n");
-               printf("ERROR: this is a fatal error, exiting now.\n");
-               ServerInstance->Exit(EXIT_STATUS_SOCKETENGINE);
-       }
-       CurrentSetSize = 0;
+               InitError();
 }
 
-KQueueEngine::~KQueueEngine()
+/** Shutdown the kqueue engine
+ */
+void SocketEngine::Deinit()
 {
-       this->Close(EngineHandle);
-       delete[] ref;
-       delete[] ke_list;
+       Close(EngineHandle);
 }
 
-bool KQueueEngine::AddFd(EventHandler* eh, int event_mask)
+static struct kevent* GetChangeKE()
+{
+       if (ChangePos >= changelist.size())
+               changelist.resize(changelist.size() * 2);
+       return &changelist[ChangePos++];
+}
+
+bool SocketEngine::AddFd(EventHandler* eh, int event_mask)
 {
        int fd = eh->GetFd();
 
-       if ((fd < 0) || (fd > GetMaxFds() - 1))
+       if (fd < 0)
                return false;
 
-       if (ref[fd])
+       if (!SocketEngine::AddFdRef(eh))
                return false;
 
        // We always want to read from the socket...
-       struct kevent ke;
-       EV_SET(&ke, fd, EVFILT_READ, EV_ADD, 0, 0, NULL);
+       struct kevent* ke = GetChangeKE();
+       EV_SET(ke, fd, EVFILT_READ, EV_ADD, 0, 0, udata_cast(eh));
 
-       int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
-       if (i == -1)
-       {
-               ServerInstance->Logs->Log("SOCKET",DEFAULT,"Failed to add fd: %d %s",
-                                         fd, strerror(errno));
-               return false;
-       }
+       ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "New file descriptor: %d", fd);
 
-       ref[fd] = eh;
-       SocketEngine::SetEventMask(eh, event_mask);
+       eh->SetEventMask(event_mask);
        OnSetEvent(eh, 0, event_mask);
-       CurrentSetSize++;
+       ResizeDouble(ke_list);
 
-       ServerInstance->Logs->Log("SOCKET",DEBUG,"New file descriptor: %d", fd);
        return true;
 }
 
-bool KQueueEngine::DelFd(EventHandler* eh, bool force)
+void SocketEngine::DelFd(EventHandler* eh)
 {
        int fd = eh->GetFd();
 
-       if ((fd < 0) || (fd > GetMaxFds() - 1))
+       if (fd < 0)
        {
-               ServerInstance->Logs->Log("SOCKET",DEFAULT,"DelFd() on invalid fd: %d", fd);
-               return false;
+               ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "DelFd() on invalid fd: %d", fd);
+               return;
        }
 
-       struct kevent ke;
-
        // First remove the write filter ignoring errors, since we can't be
        // sure if there are actually any write filters registered.
-       EV_SET(&ke, eh->GetFd(), EVFILT_WRITE, EV_DELETE, 0, 0, NULL);
-       kevent(EngineHandle, &ke, 1, 0, 0, NULL);
+       struct kevent* ke = GetChangeKE();
+       EV_SET(ke, eh->GetFd(), EVFILT_WRITE, EV_DELETE, 0, 0, NULL);
 
        // Then remove the read filter.
-       EV_SET(&ke, eh->GetFd(), EVFILT_READ, EV_DELETE, 0, 0, NULL);
-       int j = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
-
-       if ((j < 0) && !force)
-       {
-               ServerInstance->Logs->Log("SOCKET",DEFAULT,"Failed to remove fd: %d %s",
-                                         fd, strerror(errno));
-               return false;
-       }
+       ke = GetChangeKE();
+       EV_SET(ke, eh->GetFd(), EVFILT_READ, EV_DELETE, 0, 0, NULL);
 
-       CurrentSetSize--;
-       ref[fd] = NULL;
+       SocketEngine::DelFdRef(eh);
 
-       ServerInstance->Logs->Log("SOCKET",DEBUG,"Remove file descriptor: %d", fd);
-       return true;
+       ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "Remove file descriptor: %d", fd);
 }
 
-void KQueueEngine::OnSetEvent(EventHandler* eh, int old_mask, int new_mask)
+void SocketEngine::OnSetEvent(EventHandler* eh, int old_mask, int new_mask)
 {
        if ((new_mask & FD_WANT_POLL_WRITE) && !(old_mask & FD_WANT_POLL_WRITE))
        {
                // new poll-style write
-               struct kevent ke;
-               EV_SET(&ke, eh->GetFd(), EVFILT_WRITE, EV_ADD, 0, 0, NULL);
-               int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
-               if (i < 0) {
-                       ServerInstance->Logs->Log("SOCKET",DEFAULT,"Failed to mark for writing: %d %s",
-                                                 eh->GetFd(), strerror(errno));
-               }
+               struct kevent* ke = GetChangeKE();
+               EV_SET(ke, eh->GetFd(), EVFILT_WRITE, EV_ADD, 0, 0, udata_cast(eh));
        }
        else if ((old_mask & FD_WANT_POLL_WRITE) && !(new_mask & FD_WANT_POLL_WRITE))
        {
                // removing poll-style write
-               struct kevent ke;
-               EV_SET(&ke, eh->GetFd(), EVFILT_WRITE, EV_DELETE, 0, 0, NULL);
-               int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
-               if (i < 0) {
-                       ServerInstance->Logs->Log("SOCKET",DEFAULT,"Failed to mark for writing: %d %s",
-                                                 eh->GetFd(), strerror(errno));
-               }
+               struct kevent* ke = GetChangeKE();
+               EV_SET(ke, eh->GetFd(), EVFILT_WRITE, EV_DELETE, 0, 0, NULL);
        }
        if ((new_mask & (FD_WANT_FAST_WRITE | FD_WANT_SINGLE_WRITE)) && !(old_mask & (FD_WANT_FAST_WRITE | FD_WANT_SINGLE_WRITE)))
        {
-               // new one-shot write
-               struct kevent ke;
-               EV_SET(&ke, eh->GetFd(), EVFILT_WRITE, EV_ADD | EV_ONESHOT, 0, 0, NULL);
-               int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
-               if (i < 0) {
-                       ServerInstance->Logs->Log("SOCKET",DEFAULT,"Failed to mark for writing: %d %s",
-                                                 eh->GetFd(), strerror(errno));
-               }
+               struct kevent* ke = GetChangeKE();
+               EV_SET(ke, eh->GetFd(), EVFILT_WRITE, EV_ADD | EV_ONESHOT, 0, 0, udata_cast(eh));
        }
 }
 
-int KQueueEngine::DispatchEvents()
+int SocketEngine::DispatchEvents()
 {
+       struct timespec ts;
        ts.tv_nsec = 0;
        ts.tv_sec = 1;
 
-       int i = kevent(EngineHandle, NULL, 0, &ke_list[0], GetMaxFds(), &ts);
+       int i = kevent(EngineHandle, &changelist.front(), ChangePos, &ke_list.front(), ke_list.size(), &ts);
+       ChangePos = 0;
        ServerInstance->UpdateTime();
 
-       TotalEvents += i;
+       if (i < 0)
+               return i;
+
+       stats.TotalEvents += i;
 
        for (int j = 0; j < i; j++)
        {
-               EventHandler* eh = ref[ke_list[j].ident];
+               // This can't be a static_cast because udata is intptr_t on NetBSD.
+               struct kevent& kev = ke_list[j];
+               EventHandler* eh = reinterpret_cast<EventHandler*>(kev.udata);
                if (!eh)
                        continue;
-               if (ke_list[j].flags & EV_EOF)
+
+               // Copy these in case the vector gets resized and kev invalidated
+               const int fd = eh->GetFd();
+               const short filter = kev.filter;
+               if (fd < 0)
+                       continue;
+
+               if (kev.flags & EV_EOF)
                {
-                       ErrorEvents++;
-                       eh->HandleEvent(EVENT_ERROR, ke_list[j].fflags);
+                       stats.ErrorEvents++;
+                       eh->OnEventHandlerError(kev.fflags);
                        continue;
                }
-               if (ke_list[j].filter == EVFILT_WRITE)
+               if (filter == EVFILT_WRITE)
                {
-                       WriteEvents++;
                        /* When mask is FD_WANT_FAST_WRITE or FD_WANT_SINGLE_WRITE,
                         * we set a one-shot write, so we need to clear that bit
                         * to detect when it set again.
                         */
                        const int bits_to_clr = FD_WANT_SINGLE_WRITE | FD_WANT_FAST_WRITE | FD_WRITE_WILL_BLOCK;
-                       SetEventMask(eh, eh->GetEventMask() & ~bits_to_clr);
-                       eh->HandleEvent(EVENT_WRITE);
+                       eh->SetEventMask(eh->GetEventMask() & ~bits_to_clr);
+                       eh->OnEventHandlerWrite();
                }
-               if (ke_list[j].filter == EVFILT_READ)
+               else if (filter == EVFILT_READ)
                {
-                       ReadEvents++;
-                       SetEventMask(eh, eh->GetEventMask() & ~FD_READ_WILL_BLOCK);
-                       eh->HandleEvent(EVENT_READ);
+                       eh->SetEventMask(eh->GetEventMask() & ~FD_READ_WILL_BLOCK);
+                       eh->OnEventHandlerRead();
                }
        }
 
        return i;
 }
-
-std::string KQueueEngine::GetName()
-{
-       return "kqueue";
-}
-
-SocketEngine* CreateSocketEngine()
-{
-       return new KQueueEngine;
-}