]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/socketengines/socketengine_epoll.cpp
Add support for blocking tag messages with the deaf mode.
[user/henk/code/inspircd.git] / src / socketengines / socketengine_epoll.cpp
index f7e107e7b028cd4db4301b21b56f533117d8d432..7ca9da3fd8a113472d0ef3498d95247de2228c2c 100644 (file)
@@ -1,8 +1,16 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
- *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
- *   Copyright (C) 2007-2008 Craig Edwards <craigedwards@brainbox.cc>
+ *   Copyright (C) 2014-2015 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2014, 2016 Adam <Adam@anope.org>
+ *   Copyright (C) 2013, 2017, 2019 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2012 Ariadne Conill <ariadne@dereferenced.org>
+ *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+ *   Copyright (C) 2007-2008 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2006-2008 Craig Edwards <brain@inspircd.org>
+ *   Copyright (C) 2006, 2008 Robin Burchell <robin+git@viroteck.net>
  *
  * 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
  */
 
 
-#include <vector>
-#include <string>
-#include <map>
 #include "inspircd.h"
-#include "exitcodes.h"
-#include "socketengine.h"
+
 #include <sys/epoll.h>
-#include <ulimit.h>
-#include <iostream>
-#define EP_DELAY 5
+#include <sys/resource.h>
 
 /** A specialisation of the SocketEngine class, designed to use linux 2.6 epoll().
  */
-class EPollEngine : public SocketEngine
+namespace
 {
-private:
-       /** These are used by epoll() to hold socket events
-        */
-       struct epoll_event* events;
        int EngineHandle;
-public:
-       /** Create a new EPollEngine
-        */
-       EPollEngine();
-       /** Delete an EPollEngine
+
+       /** These are used by epoll() to hold socket events
         */
-       virtual ~EPollEngine();
-       virtual bool AddFd(EventHandler* eh, int event_mask);
-       virtual void OnSetEvent(EventHandler* eh, int old_mask, int new_mask);
-       virtual void DelFd(EventHandler* eh);
-       virtual int DispatchEvents();
-       virtual std::string GetName();
-};
+       std::vector<struct epoll_event> events(16);
+}
 
-EPollEngine::EPollEngine()
+void SocketEngine::Init()
 {
-       int max = ulimit(4, 0);
-       if (max > 0)
-       {
-               MAX_DESCRIPTORS = max;
-       }
-       else
-       {
-               ServerInstance->Logs->Log("SOCKET", DEFAULT, "ERROR: Can't determine maximum number of open sockets!");
-               std::cout << "ERROR: Can't determine maximum number of open sockets!" << std::endl;
-               ServerInstance->Exit(EXIT_STATUS_SOCKETENGINE);
-       }
-
-       // This is not a maximum, just a hint at the eventual number of sockets that may be polled.
-       EngineHandle = epoll_create(GetMaxFds() / 4);
+       LookupMaxFds();
 
+       // 128 is not a maximum, just a hint at the eventual number of sockets that may be polled,
+       // and it is completely ignored by 2.6.8 and later kernels, except it must be larger than zero.
+       EngineHandle = epoll_create(128);
        if (EngineHandle == -1)
-       {
-               ServerInstance->Logs->Log("SOCKET",DEFAULT, "ERROR: Could not initialize socket engine: %s", strerror(errno));
-               ServerInstance->Logs->Log("SOCKET",DEFAULT, "ERROR: Your kernel probably does not have the proper features. This is a fatal error, exiting now.");
-               std::cout << "ERROR: Could not initialize epoll socket engine: " << strerror(errno) << std::endl;
-               std::cout << "ERROR: Your kernel probably does not have the proper features. This is a fatal error, exiting now." << std::endl;
-               ServerInstance->Exit(EXIT_STATUS_SOCKETENGINE);
-       }
-
-       ref = new EventHandler* [GetMaxFds()];
-       events = new struct epoll_event[GetMaxFds()];
+               InitError();
+}
 
-       memset(ref, 0, GetMaxFds() * sizeof(EventHandler*));
+void SocketEngine::RecoverFromFork()
+{
 }
 
-EPollEngine::~EPollEngine()
+void SocketEngine::Deinit()
 {
-       this->Close(EngineHandle);
-       delete[] ref;
-       delete[] events;
+       Close(EngineHandle);
 }
 
 static unsigned mask_to_epoll(int event_mask)
@@ -114,41 +85,41 @@ static unsigned mask_to_epoll(int event_mask)
        return rv;
 }
 
-bool EPollEngine::AddFd(EventHandler* eh, int event_mask)
+bool SocketEngine::AddFd(EventHandler* eh, int event_mask)
 {
        int fd = eh->GetFd();
-       if ((fd < 0) || (fd > GetMaxFds() - 1))
+       if (fd < 0)
        {
-               ServerInstance->Logs->Log("SOCKET",DEBUG,"AddFd out of range: (fd: %d, max: %d)", fd, GetMaxFds());
+               ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "AddFd out of range: (fd: %d)", fd);
                return false;
        }
 
-       if (ref[fd])
+       if (!SocketEngine::AddFdRef(eh))
        {
-               ServerInstance->Logs->Log("SOCKET",DEBUG,"Attempt to add duplicate fd: %d", fd);
+               ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "Attempt to add duplicate fd: %d", fd);
                return false;
        }
 
        struct epoll_event ev;
-       memset(&ev,0,sizeof(ev));
+       memset(&ev, 0, sizeof(ev));
        ev.events = mask_to_epoll(event_mask);
-       ev.data.fd = fd;
+       ev.data.ptr = static_cast<void*>(eh);
        int i = epoll_ctl(EngineHandle, EPOLL_CTL_ADD, fd, &ev);
        if (i < 0)
        {
-               ServerInstance->Logs->Log("SOCKET",DEBUG,"Error adding fd: %d to socketengine: %s", fd, strerror(errno));
+               ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "Error adding fd: %d to socketengine: %s", fd, strerror(errno));
                return false;
        }
 
-       ServerInstance->Logs->Log("SOCKET",DEBUG,"New file descriptor: %d", fd);
+       ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "New file descriptor: %d", fd);
+
+       eh->SetEventMask(event_mask);
+       ResizeDouble(events);
 
-       ref[fd] = eh;
-       SocketEngine::SetEventMask(eh, event_mask);
-       CurrentSetSize++;
        return true;
 }
 
-void EPollEngine::OnSetEvent(EventHandler* eh, int old_mask, int new_mask)
+void SocketEngine::OnSetEvent(EventHandler* eh, int old_mask, int new_mask)
 {
        unsigned old_events = mask_to_epoll(old_mask);
        unsigned new_events = mask_to_epoll(new_mask);
@@ -156,75 +127,78 @@ void EPollEngine::OnSetEvent(EventHandler* eh, int old_mask, int new_mask)
        {
                // ok, we actually have something to tell the kernel about
                struct epoll_event ev;
-               memset(&ev,0,sizeof(ev));
+               memset(&ev, 0, sizeof(ev));
                ev.events = new_events;
-               ev.data.fd = eh->GetFd();
+               ev.data.ptr = static_cast<void*>(eh);
                epoll_ctl(EngineHandle, EPOLL_CTL_MOD, eh->GetFd(), &ev);
        }
 }
 
-void EPollEngine::DelFd(EventHandler* eh)
+void SocketEngine::DelFd(EventHandler* eh)
 {
        int fd = eh->GetFd();
-       if ((fd < 0) || (fd > GetMaxFds() - 1))
+       if (fd < 0)
        {
-               ServerInstance->Logs->Log("SOCKET",DEBUG,"DelFd out of range: (fd: %d, max: %d)", fd, GetMaxFds());
+               ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "DelFd out of range: (fd: %d)", fd);
                return;
        }
 
+       // Do not initialize epoll_event because for EPOLL_CTL_DEL operations the event is ignored and can be NULL.
+       // In kernel versions before 2.6.9, the EPOLL_CTL_DEL operation required a non-NULL pointer in event,
+       // even though this argument is ignored. Since Linux 2.6.9, event can be specified as NULL when using EPOLL_CTL_DEL.
        struct epoll_event ev;
-       memset(&ev,0,sizeof(ev));
-       ev.data.fd = fd;
        int i = epoll_ctl(EngineHandle, EPOLL_CTL_DEL, fd, &ev);
 
        if (i < 0)
        {
-               ServerInstance->Logs->Log("SOCKET",DEBUG,"epoll_ctl can't remove socket: %s", strerror(errno));
+               ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "epoll_ctl can't remove socket: %s", strerror(errno));
        }
 
-       ref[fd] = NULL;
+       SocketEngine::DelFdRef(eh);
 
-       ServerInstance->Logs->Log("SOCKET",DEBUG,"Remove file descriptor: %d", fd);
-       CurrentSetSize--;
+       ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "Remove file descriptor: %d", fd);
 }
 
-int EPollEngine::DispatchEvents()
+int SocketEngine::DispatchEvents()
 {
-       socklen_t codesize = sizeof(int);
-       int errcode;
-       int i = epoll_wait(EngineHandle, events, GetMaxFds() - 1, 1000);
+       int i = epoll_wait(EngineHandle, &events[0], events.size(), 1000);
        ServerInstance->UpdateTime();
 
-       TotalEvents += i;
+       stats.TotalEvents += i;
 
        for (int j = 0; j < i; j++)
        {
-               EventHandler* eh = ref[events[j].data.fd];
-               if (!eh)
-               {
-                       ServerInstance->Logs->Log("SOCKET",DEBUG,"Got event on unknown fd: %d", events[j].data.fd);
-                       epoll_ctl(EngineHandle, EPOLL_CTL_DEL, events[j].data.fd, &events[j]);
+               // Copy these in case the vector gets resized and ev invalidated
+               const epoll_event ev = events[j];
+
+               EventHandler* const eh = static_cast<EventHandler*>(ev.data.ptr);
+               const int fd = eh->GetFd();
+               if (fd < 0)
                        continue;
-               }
-               if (events[j].events & EPOLLHUP)
+
+               if (ev.events & EPOLLHUP)
                {
-                       ErrorEvents++;
-                       eh->HandleEvent(EVENT_ERROR, 0);
+                       stats.ErrorEvents++;
+                       eh->OnEventHandlerError(0);
                        continue;
                }
-               if (events[j].events & EPOLLERR)
+
+               if (ev.events & EPOLLERR)
                {
-                       ErrorEvents++;
+                       stats.ErrorEvents++;
                        /* Get error number */
-                       if (getsockopt(events[j].data.fd, SOL_SOCKET, SO_ERROR, &errcode, &codesize) < 0)
+                       socklen_t codesize = sizeof(int);
+                       int errcode;
+                       if (getsockopt(fd, SOL_SOCKET, SO_ERROR, &errcode, &codesize) < 0)
                                errcode = errno;
-                       eh->HandleEvent(EVENT_ERROR, errcode);
+                       eh->OnEventHandlerError(errcode);
                        continue;
                }
+
                int mask = eh->GetEventMask();
-               if (events[j].events & EPOLLIN)
+               if (ev.events & EPOLLIN)
                        mask &= ~FD_READ_WILL_BLOCK;
-               if (events[j].events & EPOLLOUT)
+               if (ev.events & EPOLLOUT)
                {
                        mask &= ~FD_WRITE_WILL_BLOCK;
                        if (mask & FD_WANT_SINGLE_WRITE)
@@ -234,31 +208,19 @@ int EPollEngine::DispatchEvents()
                                mask = nm;
                        }
                }
-               SetEventMask(eh, mask);
-               if (events[j].events & EPOLLIN)
+               eh->SetEventMask(mask);
+               if (ev.events & EPOLLIN)
                {
-                       ReadEvents++;
-                       eh->HandleEvent(EVENT_READ);
-                       if (eh != ref[events[j].data.fd])
+                       eh->OnEventHandlerRead();
+                       if (eh != GetRef(fd))
                                // whoa! we got deleted, better not give out the write event
                                continue;
                }
-               if (events[j].events & EPOLLOUT)
+               if (ev.events & EPOLLOUT)
                {
-                       WriteEvents++;
-                       eh->HandleEvent(EVENT_WRITE);
+                       eh->OnEventHandlerWrite();
                }
        }
 
        return i;
 }
-
-std::string EPollEngine::GetName()
-{
-       return "epoll";
-}
-
-SocketEngine* CreateSocketEngine()
-{
-       return new EPollEngine;
-}