src/socketengines/socketengine_kqueue.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2009 Uli Schlachter <psychon@znc.in>
   6  *   Copyright (C) 2007-2008 Craig Edwards <craigedwards@brainbox.cc>
   7  *
   8  * This file is part of InspIRCd.  InspIRCd is free software: you can
   9  * redistribute it and/or modify it under the terms of the GNU General Public
  10  * License as published by the Free Software Foundation, version 2.
  11  *
  12  * This program is distributed in the hope that it will be useful, but WITHOUT
  13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  14  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  15  * details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21
  22 #include "inspircd.h"
  23 #include "exitcodes.h"
  24 #include <sys/types.h>
  25 #include <sys/event.h>
  26 #include <sys/time.h>
  27 #include "socketengine.h"
  28 #include <iostream>
  29 #include <sys/sysctl.h>
  30
  31 /** A specialisation of the SocketEngine class, designed to use BSD kqueue().
  32  */
  33 class KQueueEngine : public SocketEngine
  34 {
  35 private:
  36         int EngineHandle;
  37         /** These are used by kqueue() to hold socket events
  38          */
  39         std::vector<struct kevent> ke_list;
  40         /** This is a specialised time value used by kqueue()
  41          */
  42         struct timespec ts;
  43 public:
  44         /** Create a new KQueueEngine
  45          */
  46         KQueueEngine();
  47         /** Delete a KQueueEngine
  48          */
  49         virtual ~KQueueEngine();
  50         bool AddFd(EventHandler* eh, int event_mask);
  51         void OnSetEvent(EventHandler* eh, int old_mask, int new_mask);
  52         virtual void DelFd(EventHandler* eh);
  53         virtual int DispatchEvents();
  54         virtual void RecoverFromFork();
  55 };
  56
  57 KQueueEngine::KQueueEngine() : ke_list(1)
  58 {
  59         MAX_DESCRIPTORS = 0;
  60         int mib[2];
  61         size_t len;
  62
  63         mib[0] = CTL_KERN;
  64 #ifdef KERN_MAXFILESPERPROC
  65         mib[1] = KERN_MAXFILESPERPROC;
  66 #else
  67         mib[1] = KERN_MAXFILES;
  68 #endif
  69         len = sizeof(MAX_DESCRIPTORS);
  70         sysctl(mib, 2, &MAX_DESCRIPTORS, &len, NULL, 0);
  71         if (MAX_DESCRIPTORS <= 0)
  72         {
  73                 ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "ERROR: Can't determine maximum number of open sockets!");
  74                 std::cout << "ERROR: Can't determine maximum number of open sockets!" << std::endl;
  75                 ServerInstance->QuickExit(EXIT_STATUS_SOCKETENGINE);
  76         }
  77
  78         this->RecoverFromFork();
  79 }
  80
  81 void KQueueEngine::RecoverFromFork()
  82 {
  83         /*
  84          * The only bad thing about kqueue is that its fd cant survive a fork and is not inherited.
  85          * BUM HATS.
  86          *
  87          */
  88         EngineHandle = kqueue();
  89         if (EngineHandle == -1)
  90         {
  91                 ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "ERROR: Could not initialize socket engine. Your kernel probably does not have the proper features.");
  92                 ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "ERROR: this is a fatal error, exiting now.");
  93                 std::cout << "ERROR: Could not initialize socket engine. Your kernel probably does not have the proper features." << std::endl;
  94                 std::cout << "ERROR: this is a fatal error, exiting now." << std::endl;
  95                 ServerInstance->QuickExit(EXIT_STATUS_SOCKETENGINE);
  96         }
  97         CurrentSetSize = 0;
  98 }
  99
 100 KQueueEngine::~KQueueEngine()
 101 {
 102         this->Close(EngineHandle);
 103 }
 104
 105 bool KQueueEngine::AddFd(EventHandler* eh, int event_mask)
 106 {
 107         int fd = eh->GetFd();
 108
 109         if ((fd < 0) || (fd > GetMaxFds() - 1))
 110                 return false;
 111
 112         if (!SocketEngine::AddFd(eh))
 113                 return false;
 114
 115         // We always want to read from the socket...
 116         struct kevent ke;
 117         EV_SET(&ke, fd, EVFILT_READ, EV_ADD, 0, 0, NULL);
 118
 119         int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
 120         if (i == -1)
 121         {
 122                 ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "Failed to add fd: %d %s",
 123                                           fd, strerror(errno));
 124                 return false;
 125         }
 126
 127         ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "New file descriptor: %d", fd);
 128
 129         SocketEngine::SetEventMask(eh, event_mask);
 130         OnSetEvent(eh, 0, event_mask);
 131         CurrentSetSize++;
 132         ResizeDouble(ke_list);
 133
 134         return true;
 135 }
 136
 137 void KQueueEngine::DelFd(EventHandler* eh)
 138 {
 139         int fd = eh->GetFd();
 140
 141         if ((fd < 0) || (fd > GetMaxFds() - 1))
 142         {
 143                 ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "DelFd() on invalid fd: %d", fd);
 144                 return;
 145         }
 146
 147         struct kevent ke;
 148
 149         // First remove the write filter ignoring errors, since we can't be
 150         // sure if there are actually any write filters registered.
 151         EV_SET(&ke, eh->GetFd(), EVFILT_WRITE, EV_DELETE, 0, 0, NULL);
 152         kevent(EngineHandle, &ke, 1, 0, 0, NULL);
 153
 154         // Then remove the read filter.
 155         EV_SET(&ke, eh->GetFd(), EVFILT_READ, EV_DELETE, 0, 0, NULL);
 156         int j = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
 157
 158         if (j < 0)
 159         {
 160                 ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "Failed to remove fd: %d %s",
 161                                           fd, strerror(errno));
 162         }
 163
 164         SocketEngine::DelFd(eh);
 165         CurrentSetSize--;
 166
 167         ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "Remove file descriptor: %d", fd);
 168 }
 169
 170 void KQueueEngine::OnSetEvent(EventHandler* eh, int old_mask, int new_mask)
 171 {
 172         if ((new_mask & FD_WANT_POLL_WRITE) && !(old_mask & FD_WANT_POLL_WRITE))
 173         {
 174                 // new poll-style write
 175                 struct kevent ke;
 176                 EV_SET(&ke, eh->GetFd(), EVFILT_WRITE, EV_ADD, 0, 0, NULL);
 177                 int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
 178                 if (i < 0)
 179                         ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "Failed to mark for writing: %d %s",
 180                                                   eh->GetFd(), strerror(errno));
 181         }
 182         else if ((old_mask & FD_WANT_POLL_WRITE) && !(new_mask & FD_WANT_POLL_WRITE))
 183         {
 184                 // removing poll-style write
 185                 struct kevent ke;
 186                 EV_SET(&ke, eh->GetFd(), EVFILT_WRITE, EV_DELETE, 0, 0, NULL);
 187                 int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
 188                 if (i < 0)
 189                         ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "Failed to mark for writing: %d %s",
 190                                                   eh->GetFd(), strerror(errno));
 191         }
 192         if ((new_mask & (FD_WANT_FAST_WRITE | FD_WANT_SINGLE_WRITE)) && !(old_mask & (FD_WANT_FAST_WRITE | FD_WANT_SINGLE_WRITE)))
 193         {
 194                 // new one-shot write
 195                 struct kevent ke;
 196                 EV_SET(&ke, eh->GetFd(), EVFILT_WRITE, EV_ADD | EV_ONESHOT, 0, 0, NULL);
 197                 int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
 198                 if (i < 0)
 199                         ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "Failed to mark for writing: %d %s",
 200                                                   eh->GetFd(), strerror(errno));
 201         }
 202 }
 203
 204 int KQueueEngine::DispatchEvents()
 205 {
 206         ts.tv_nsec = 0;
 207         ts.tv_sec = 1;
 208
 209         int i = kevent(EngineHandle, NULL, 0, &ke_list[0], ke_list.size(), &ts);
 210         ServerInstance->UpdateTime();
 211
 212         if (i < 0)
 213                 return i;
 214
 215         TotalEvents += i;
 216
 217         for (int j = 0; j < i; j++)
 218         {
 219                 struct kevent& kev = ke_list[j];
 220
 221                 // Copy these in case the vector gets resized and kev invalidated
 222                 const int fd = kev.ident;
 223                 const short filter = kev.filter;
 224
 225                 EventHandler* eh = GetRef(fd);
 226                 if (!eh)
 227                         continue;
 228
 229                 if (kev.flags & EV_EOF)
 230                 {
 231                         ErrorEvents++;
 232                         eh->HandleEvent(EVENT_ERROR, kev.fflags);
 233                         continue;
 234                 }
 235                 if (filter == EVFILT_WRITE)
 236                 {
 237                         WriteEvents++;
 238                         /* When mask is FD_WANT_FAST_WRITE or FD_WANT_SINGLE_WRITE,
 239                          * we set a one-shot write, so we need to clear that bit
 240                          * to detect when it set again.
 241                          */
 242                         const int bits_to_clr = FD_WANT_SINGLE_WRITE | FD_WANT_FAST_WRITE | FD_WRITE_WILL_BLOCK;
 243                         SetEventMask(eh, eh->GetEventMask() & ~bits_to_clr);
 244                         eh->HandleEvent(EVENT_WRITE);
 245                 }
 246                 else if (filter == EVFILT_READ)
 247                 {
 248                         ReadEvents++;
 249                         SetEventMask(eh, eh->GetEventMask() & ~FD_READ_WILL_BLOCK);
 250                         eh->HandleEvent(EVENT_READ);
 251                 }
 252         }
 253
 254         return i;
 255 }
 256
 257 SocketEngine* CreateSocketEngine()
 258 {
 259         return new KQueueEngine;
 260 }