src/socketengines/socketengine_kqueue.cpp

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