]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/socketengines/socketengine_epoll.cpp
Replace SocketEngine::GetName() with INSPIRCD_SOCKETENGINE_NAME define
[user/henk/code/inspircd.git] / src / socketengines / socketengine_epoll.cpp
index a749208d1e48c2252c7fd86d9083cc4e80749d3b..800cc76570b811e6174de6e851d298f50b7b6690 100644 (file)
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2007-2008 Craig Edwards <craigedwards@brainbox.cc>
  *
- * 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 <vector>
+#include <string>
+#include <map>
 #include "inspircd.h"
 #include "exitcodes.h"
+#include "socketengine.h"
 #include <sys/epoll.h>
-#include "socketengines/socketengine_epoll.h"
 #include <ulimit.h>
+#include <iostream>
+#define EP_DELAY 5
 
-EPollEngine::EPollEngine(InspIRCd* Instance) : SocketEngine(Instance)
+/** A specialisation of the SocketEngine class, designed to use linux 2.6 epoll().
+ */
+class EPollEngine : public SocketEngine
 {
-       EngineHandle = epoll_create(GetMaxFds());
+private:
+       /** These are used by epoll() to hold socket events
+        */
+       std::vector<struct epoll_event> events;
+       int EngineHandle;
+public:
+       /** Create a new EPollEngine
+        */
+       EPollEngine();
+       /** Delete an EPollEngine
+        */
+       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();
+};
 
-       if (EngineHandle == -1)
+EPollEngine::EPollEngine() : events(1)
+{
+       CurrentSetSize = 0;
+       int max = ulimit(4, 0);
+       if (max > 0)
        {
-               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.");
-               printf("ERROR: Could not initialize socket engine: %s\n", strerror(errno));
-               printf("ERROR: Your kernel probably does not have the proper features. This is a fatal error, exiting now.\n");
-               ServerInstance->Exit(EXIT_STATUS_SOCKETENGINE);
+               MAX_DESCRIPTORS = max;
+       }
+       else
+       {
+               ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "ERROR: Can't determine maximum number of open sockets!");
+               std::cout << "ERROR: Can't determine maximum number of open sockets!" << std::endl;
+               ServerInstance->QuickExit(EXIT_STATUS_SOCKETENGINE);
        }
-       CurrentSetSize = 0;
 
-       ref = new EventHandler* [GetMaxFds()];
-       events = new struct epoll_event[GetMaxFds()];
+       // This is not a maximum, just a hint at the eventual number of sockets that may be polled.
+       EngineHandle = epoll_create(GetMaxFds() / 4);
 
-       memset(ref, 0, GetMaxFds() * sizeof(EventHandler*));
+       if (EngineHandle == -1)
+       {
+               ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "ERROR: Could not initialize socket engine: %s", strerror(errno));
+               ServerInstance->Logs->Log("SOCKET", LOG_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->QuickExit(EXIT_STATUS_SOCKETENGINE);
+       }
 }
 
 EPollEngine::~EPollEngine()
 {
        this->Close(EngineHandle);
-       delete[] ref;
-       delete[] events;
 }
 
-bool EPollEngine::AddFd(EventHandler* eh)
+static unsigned mask_to_epoll(int event_mask)
+{
+       unsigned rv = 0;
+       if (event_mask & (FD_WANT_POLL_READ | FD_WANT_POLL_WRITE | FD_WANT_SINGLE_WRITE))
+       {
+               // we need to use standard polling on this FD
+               if (event_mask & (FD_WANT_POLL_READ | FD_WANT_FAST_READ))
+                       rv |= EPOLLIN;
+               if (event_mask & (FD_WANT_POLL_WRITE | FD_WANT_FAST_WRITE | FD_WANT_SINGLE_WRITE))
+                       rv |= EPOLLOUT;
+       }
+       else
+       {
+               // we can use edge-triggered polling on this FD
+               rv = EPOLLET;
+               if (event_mask & (FD_WANT_FAST_READ | FD_WANT_EDGE_READ))
+                       rv |= EPOLLIN;
+               if (event_mask & (FD_WANT_FAST_WRITE | FD_WANT_EDGE_WRITE))
+                       rv |= EPOLLOUT;
+       }
+       return rv;
+}
+
+bool EPollEngine::AddFd(EventHandler* eh, int event_mask)
 {
        int fd = eh->GetFd();
        if ((fd < 0) || (fd > GetMaxFds() - 1))
        {
-               ServerInstance->Logs->Log("SOCKET",DEBUG,"Out of range FD");
+               ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "AddFd out of range: (fd: %d, max: %d)", fd, GetMaxFds());
                return false;
        }
 
-       if (GetRemainingFds() <= 1)
-               return false;
-
-       if (ref[fd])
+       if (!SocketEngine::AddFd(eh))
+       {
+               ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "Attempt to add duplicate fd: %d", fd);
                return false;
+       }
 
        struct epoll_event ev;
-       memset(&ev,0,sizeof(struct epoll_event));
-       eh->Readable() ? ev.events = EPOLLIN : ev.events = EPOLLOUT;
+       memset(&ev, 0, sizeof(ev));
+       ev.events = mask_to_epoll(event_mask);
        ev.data.fd = fd;
        int i = epoll_ctl(EngineHandle, EPOLL_CTL_ADD, fd, &ev);
        if (i < 0)
        {
+               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);
 
-       ref[fd] = eh;
+       SocketEngine::SetEventMask(eh, event_mask);
        CurrentSetSize++;
+       ResizeDouble(events);
+
        return true;
 }
 
-void EPollEngine::WantWrite(EventHandler* eh)
+void EPollEngine::OnSetEvent(EventHandler* eh, int old_mask, int new_mask)
 {
-       /** Use oneshot so that the system removes the writeable
-        * status for us and saves us a call.
-        */
-       struct epoll_event ev;
-       memset(&ev,0,sizeof(struct epoll_event));
-       ev.events = EPOLLOUT;
-       ev.data.fd = eh->GetFd();
-       epoll_ctl(EngineHandle, EPOLL_CTL_MOD, eh->GetFd(), &ev);
+       unsigned old_events = mask_to_epoll(old_mask);
+       unsigned new_events = mask_to_epoll(new_mask);
+       if (old_events != new_events)
+       {
+               // ok, we actually have something to tell the kernel about
+               struct epoll_event ev;
+               memset(&ev, 0, sizeof(ev));
+               ev.events = new_events;
+               ev.data.fd = eh->GetFd();
+               epoll_ctl(EngineHandle, EPOLL_CTL_MOD, eh->GetFd(), &ev);
+       }
 }
 
-bool EPollEngine::DelFd(EventHandler* eh, bool force)
+void EPollEngine::DelFd(EventHandler* eh)
 {
        int fd = eh->GetFd();
        if ((fd < 0) || (fd > GetMaxFds() - 1))
-               return false;
+       {
+               ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "DelFd out of range: (fd: %d, max: %d)", fd, GetMaxFds());
+               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(struct epoll_event));
-       eh->Readable() ? ev.events = EPOLLIN : ev.events = EPOLLOUT;
-       ev.data.fd = fd;
        int i = epoll_ctl(EngineHandle, EPOLL_CTL_DEL, fd, &ev);
 
-       if (i < 0 && !force)
+       if (i < 0)
        {
-               ServerInstance->Logs->Log("SOCKET",DEBUG,"Cant remove socket: %s", strerror(errno));
-               return false;
+               ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "epoll_ctl can't remove socket: %s", strerror(errno));
        }
 
-       ref[fd] = NULL;
-       CurrentSetSize--;
-
-       ServerInstance->Logs->Log("SOCKET",DEBUG,"Remove file descriptor: %d", fd);
-       return true;
-}
-
-int EPollEngine::GetMaxFds()
-{
-       if (MAX_DESCRIPTORS)
-               return MAX_DESCRIPTORS;
-
-       int max = ulimit(4, 0);
-       if (max > 0)
-       {
-               MAX_DESCRIPTORS = max;
-               return max;
-       }
-       else
-       {
-               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);
-       }
-       return 0;
-}
+       SocketEngine::DelFd(eh);
 
-int EPollEngine::GetRemainingFds()
-{
-       return GetMaxFds() - CurrentSetSize;
+       ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "Remove file descriptor: %d", fd);
+       CurrentSetSize--;
 }
 
 int EPollEngine::DispatchEvents()
 {
-       socklen_t codesize;
+       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;
 
        for (int j = 0; j < i; j++)
        {
-               if (events[j].events & EPOLLHUP)
+               // Copy these in case the vector gets resized and ev invalidated
+               const epoll_event ev = events[j];
+
+               EventHandler* eh = GetRef(ev.data.fd);
+               if (!eh)
+               {
+                       ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "Got event on unknown fd: %d", events[j].data.fd);
+                       epoll_ctl(EngineHandle, EPOLL_CTL_DEL, events[j].data.fd, &events[j]);
+                       continue;
+               }
+
+               if (ev.events & EPOLLHUP)
                {
                        ErrorEvents++;
-                       if (ref[events[j].data.fd])
-                               ref[events[j].data.fd]->HandleEvent(EVENT_ERROR, 0);
+                       eh->HandleEvent(EVENT_ERROR, 0);
                        continue;
                }
-               if (events[j].events & EPOLLERR)
+
+               if (ev.events & EPOLLERR)
                {
                        ErrorEvents++;
                        /* Get error number */
-                       if (getsockopt(events[j].data.fd, SOL_SOCKET, SO_ERROR, &errcode, &codesize) < 0)
+                       if (getsockopt(ev.data.fd, SOL_SOCKET, SO_ERROR, &errcode, &codesize) < 0)
                                errcode = errno;
-                       if (ref[events[j].data.fd])
-                               ref[events[j].data.fd]->HandleEvent(EVENT_ERROR, errcode);
+                       eh->HandleEvent(EVENT_ERROR, errcode);
                        continue;
                }
-               if (events[j].events & EPOLLOUT)
+
+               int mask = eh->GetEventMask();
+               if (ev.events & EPOLLIN)
+                       mask &= ~FD_READ_WILL_BLOCK;
+               if (ev.events & EPOLLOUT)
                {
-                       WriteEvents++;
-                       struct epoll_event ev;
-                       memset(&ev,0,sizeof(struct epoll_event));
-                       ev.events = EPOLLIN;
-                       ev.data.fd = events[j].data.fd;
-                       epoll_ctl(EngineHandle, EPOLL_CTL_MOD, events[j].data.fd, &ev);
-                       if (ref[events[j].data.fd])
-                               ref[events[j].data.fd]->HandleEvent(EVENT_WRITE);
+                       mask &= ~FD_WRITE_WILL_BLOCK;
+                       if (mask & FD_WANT_SINGLE_WRITE)
+                       {
+                               int nm = mask & ~FD_WANT_SINGLE_WRITE;
+                               OnSetEvent(eh, mask, nm);
+                               mask = nm;
+                       }
                }
-               else
+               SetEventMask(eh, mask);
+               if (ev.events & EPOLLIN)
                {
                        ReadEvents++;
-                       if (ref[events[j].data.fd])
-                               ref[events[j].data.fd]->HandleEvent(EVENT_READ);
+                       eh->HandleEvent(EVENT_READ);
+                       if (eh != GetRef(ev.data.fd))
+                               // whoa! we got deleted, better not give out the write event
+                               continue;
+               }
+               if (ev.events & EPOLLOUT)
+               {
+                       WriteEvents++;
+                       eh->HandleEvent(EVENT_WRITE);
                }
        }
 
        return i;
 }
 
-std::string EPollEngine::GetName()
+SocketEngine* CreateSocketEngine()
 {
-       return "epoll";
+       return new EPollEngine;
 }
-