src/socketengines/socketengine_epoll.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2007-2008 Craig Edwards <craigedwards@brainbox.cc>
   6  *
   7  * This file is part of InspIRCd.  InspIRCd is free software: you can
   8  * redistribute it and/or modify it under the terms of the GNU General Public
   9  * License as published by the Free Software Foundation, version 2.
  10  *
  11  * This program is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  13  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  14  * details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20
  21 #include <vector>
  22 #include <string>
  23 #include <map>
  24 #include "inspircd.h"
  25 #include "exitcodes.h"
  26 #include "socketengine.h"
  27 #include <sys/epoll.h>
  28 #include <ulimit.h>
  29 #include <iostream>
  30 #define EP_DELAY 5
  31
  32 /** A specialisation of the SocketEngine class, designed to use linux 2.6 epoll().
  33  */
  34 class EPollEngine : public SocketEngine
  35 {
  36 private:
  37         /** These are used by epoll() to hold socket events
  38          */
  39         struct epoll_event* events;
  40         int EngineHandle;
  41 public:
  42         /** Create a new EPollEngine
  43          */
  44         EPollEngine();
  45         /** Delete an EPollEngine
  46          */
  47         virtual ~EPollEngine();
  48         virtual bool AddFd(EventHandler* eh, int event_mask);
  49         virtual void OnSetEvent(EventHandler* eh, int old_mask, int new_mask);
  50         virtual void DelFd(EventHandler* eh);
  51         virtual int DispatchEvents();
  52         virtual std::string GetName();
  53 };
  54
  55 EPollEngine::EPollEngine()
  56 {
  57         int max = ulimit(4, 0);
  58         if (max > 0)
  59         {
  60                 MAX_DESCRIPTORS = max;
  61         }
  62         else
  63         {
  64                 ServerInstance->Logs->Log("SOCKET", DEFAULT, "ERROR: Can't determine maximum number of open sockets!");
  65                 std::cout << "ERROR: Can't determine maximum number of open sockets!" << std::endl;
  66                 ServerInstance->Exit(EXIT_STATUS_SOCKETENGINE);
  67         }
  68
  69         // This is not a maximum, just a hint at the eventual number of sockets that may be polled.
  70         EngineHandle = epoll_create(GetMaxFds() / 4);
  71
  72         if (EngineHandle == -1)
  73         {
  74                 ServerInstance->Logs->Log("SOCKET",DEFAULT, "ERROR: Could not initialize socket engine: %s", strerror(errno));
  75                 ServerInstance->Logs->Log("SOCKET",DEFAULT, "ERROR: Your kernel probably does not have the proper features. This is a fatal error, exiting now.");
  76                 std::cout << "ERROR: Could not initialize epoll socket engine: " << strerror(errno) << std::endl;
  77                 std::cout << "ERROR: Your kernel probably does not have the proper features. This is a fatal error, exiting now." << std::endl;
  78                 ServerInstance->Exit(EXIT_STATUS_SOCKETENGINE);
  79         }
  80
  81         ref = new EventHandler* [GetMaxFds()];
  82         events = new struct epoll_event[GetMaxFds()];
  83
  84         memset(ref, 0, GetMaxFds() * sizeof(EventHandler*));
  85 }
  86
  87 EPollEngine::~EPollEngine()
  88 {
  89         this->Close(EngineHandle);
  90         delete[] ref;
  91         delete[] events;
  92 }
  93
  94 static unsigned mask_to_epoll(int event_mask)
  95 {
  96         unsigned rv = 0;
  97         if (event_mask & (FD_WANT_POLL_READ | FD_WANT_POLL_WRITE | FD_WANT_SINGLE_WRITE))
  98         {
  99                 // we need to use standard polling on this FD
 100                 if (event_mask & (FD_WANT_POLL_READ | FD_WANT_FAST_READ))
 101                         rv |= EPOLLIN;
 102                 if (event_mask & (FD_WANT_POLL_WRITE | FD_WANT_FAST_WRITE | FD_WANT_SINGLE_WRITE))
 103                         rv |= EPOLLOUT;
 104         }
 105         else
 106         {
 107                 // we can use edge-triggered polling on this FD
 108                 rv = EPOLLET;
 109                 if (event_mask & (FD_WANT_FAST_READ | FD_WANT_EDGE_READ))
 110                         rv |= EPOLLIN;
 111                 if (event_mask & (FD_WANT_FAST_WRITE | FD_WANT_EDGE_WRITE))
 112                         rv |= EPOLLOUT;
 113         }
 114         return rv;
 115 }
 116
 117 bool EPollEngine::AddFd(EventHandler* eh, int event_mask)
 118 {
 119         int fd = eh->GetFd();
 120         if ((fd < 0) || (fd > GetMaxFds() - 1))
 121         {
 122                 ServerInstance->Logs->Log("SOCKET",DEBUG,"AddFd out of range: (fd: %d, max: %d)", fd, GetMaxFds());
 123                 return false;
 124         }
 125
 126         if (ref[fd])
 127         {
 128                 ServerInstance->Logs->Log("SOCKET",DEBUG,"Attempt to add duplicate fd: %d", fd);
 129                 return false;
 130         }
 131
 132         struct epoll_event ev;
 133         memset(&ev,0,sizeof(ev));
 134         ev.events = mask_to_epoll(event_mask);
 135         ev.data.fd = fd;
 136         int i = epoll_ctl(EngineHandle, EPOLL_CTL_ADD, fd, &ev);
 137         if (i < 0)
 138         {
 139                 ServerInstance->Logs->Log("SOCKET",DEBUG,"Error adding fd: %d to socketengine: %s", fd, strerror(errno));
 140                 return false;
 141         }
 142
 143         ServerInstance->Logs->Log("SOCKET",DEBUG,"New file descriptor: %d", fd);
 144
 145         ref[fd] = eh;
 146         SocketEngine::SetEventMask(eh, event_mask);
 147         CurrentSetSize++;
 148         return true;
 149 }
 150
 151 void EPollEngine::OnSetEvent(EventHandler* eh, int old_mask, int new_mask)
 152 {
 153         unsigned old_events = mask_to_epoll(old_mask);
 154         unsigned new_events = mask_to_epoll(new_mask);
 155         if (old_events != new_events)
 156         {
 157                 // ok, we actually have something to tell the kernel about
 158                 struct epoll_event ev;
 159                 memset(&ev,0,sizeof(ev));
 160                 ev.events = new_events;
 161                 ev.data.fd = eh->GetFd();
 162                 epoll_ctl(EngineHandle, EPOLL_CTL_MOD, eh->GetFd(), &ev);
 163         }
 164 }
 165
 166 void EPollEngine::DelFd(EventHandler* eh)
 167 {
 168         int fd = eh->GetFd();
 169         if ((fd < 0) || (fd > GetMaxFds() - 1))
 170         {
 171                 ServerInstance->Logs->Log("SOCKET",DEBUG,"DelFd out of range: (fd: %d, max: %d)", fd, GetMaxFds());
 172                 return;
 173         }
 174
 175         struct epoll_event ev;
 176         memset(&ev,0,sizeof(ev));
 177         ev.data.fd = fd;
 178         int i = epoll_ctl(EngineHandle, EPOLL_CTL_DEL, fd, &ev);
 179
 180         if (i < 0)
 181         {
 182                 ServerInstance->Logs->Log("SOCKET",DEBUG,"epoll_ctl can't remove socket: %s", strerror(errno));
 183         }
 184
 185         ref[fd] = NULL;
 186
 187         ServerInstance->Logs->Log("SOCKET",DEBUG,"Remove file descriptor: %d", fd);
 188         CurrentSetSize--;
 189 }
 190
 191 int EPollEngine::DispatchEvents()
 192 {
 193         socklen_t codesize = sizeof(int);
 194         int errcode;
 195         int i = epoll_wait(EngineHandle, events, GetMaxFds() - 1, 1000);
 196         ServerInstance->UpdateTime();
 197
 198         TotalEvents += i;
 199
 200         for (int j = 0; j < i; j++)
 201         {
 202                 EventHandler* eh = ref[events[j].data.fd];
 203                 if (!eh)
 204                 {
 205                         ServerInstance->Logs->Log("SOCKET",DEBUG,"Got event on unknown fd: %d", events[j].data.fd);
 206                         epoll_ctl(EngineHandle, EPOLL_CTL_DEL, events[j].data.fd, &events[j]);
 207                         continue;
 208                 }
 209                 if (events[j].events & EPOLLHUP)
 210                 {
 211                         ErrorEvents++;
 212                         eh->HandleEvent(EVENT_ERROR, 0);
 213                         continue;
 214                 }
 215                 if (events[j].events & EPOLLERR)
 216                 {
 217                         ErrorEvents++;
 218                         /* Get error number */
 219                         if (getsockopt(events[j].data.fd, SOL_SOCKET, SO_ERROR, &errcode, &codesize) < 0)
 220                                 errcode = errno;
 221                         eh->HandleEvent(EVENT_ERROR, errcode);
 222                         continue;
 223                 }
 224                 int mask = eh->GetEventMask();
 225                 if (events[j].events & EPOLLIN)
 226                         mask &= ~FD_READ_WILL_BLOCK;
 227                 if (events[j].events & EPOLLOUT)
 228                 {
 229                         mask &= ~FD_WRITE_WILL_BLOCK;
 230                         if (mask & FD_WANT_SINGLE_WRITE)
 231                         {
 232                                 int nm = mask & ~FD_WANT_SINGLE_WRITE;
 233                                 OnSetEvent(eh, mask, nm);
 234                                 mask = nm;
 235                         }
 236                 }
 237                 SetEventMask(eh, mask);
 238                 if (events[j].events & EPOLLIN)
 239                 {
 240                         ReadEvents++;
 241                         eh->HandleEvent(EVENT_READ);
 242                         if (eh != ref[events[j].data.fd])
 243                                 // whoa! we got deleted, better not give out the write event
 244                                 continue;
 245                 }
 246                 if (events[j].events & EPOLLOUT)
 247                 {
 248                         WriteEvents++;
 249                         eh->HandleEvent(EVENT_WRITE);
 250                 }
 251         }
 252
 253         return i;
 254 }
 255
 256 std::string EPollEngine::GetName()
 257 {
 258         return "epoll";
 259 }
 260
 261 SocketEngine* CreateSocketEngine()
 262 {
 263         return new EPollEngine;
 264 }