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 <iostream>
  28 #include <sys/sysctl.h>
  29
  30 /** A specialisation of the SocketEngine class, designed to use BSD kqueue().
  31  */
  32 namespace
  33 {
  34         int EngineHandle;
  35         unsigned int ChangePos = 0;
  36         /** These are used by kqueue() to hold socket events
  37          */
  38         std::vector<struct kevent> ke_list(16);
  39
  40         /** Pending changes
  41          */
  42         std::vector<struct kevent> changelist(8);
  43 }
  44
  45 /** Initialize the kqueue engine
  46  */
  47 void SocketEngine::Init()
  48 {
  49         MAX_DESCRIPTORS = 0;
  50         int mib[2];
  51         size_t len;
  52
  53         mib[0] = CTL_KERN;
  54 #ifdef KERN_MAXFILESPERPROC
  55         mib[1] = KERN_MAXFILESPERPROC;
  56 #else
  57         mib[1] = KERN_MAXFILES;
  58 #endif
  59         len = sizeof(MAX_DESCRIPTORS);
  60         // MAX_DESCRIPTORS is mainly used for display purposes, no problem if the sysctl() below fails
  61         sysctl(mib, 2, &MAX_DESCRIPTORS, &len, NULL, 0);
  62
  63         RecoverFromFork();
  64 }
  65
  66 void SocketEngine::RecoverFromFork()
  67 {
  68         /*
  69          * The only bad thing about kqueue is that its fd cant survive a fork and is not inherited.
  70          * BUM HATS.
  71          *
  72          */
  73         EngineHandle = kqueue();
  74         if (EngineHandle == -1)
  75         {
  76                 ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "ERROR: Could not initialize socket engine. Your kernel probably does not have the proper features.");
  77                 ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "ERROR: this is a fatal error, exiting now.");
  78                 std::cout << "ERROR: Could not initialize socket engine. Your kernel probably does not have the proper features." << std::endl;
  79                 std::cout << "ERROR: this is a fatal error, exiting now." << std::endl;
  80                 ServerInstance->QuickExit(EXIT_STATUS_SOCKETENGINE);
  81         }
  82 }
  83
  84 /** Shutdown the kqueue engine
  85  */
  86 void SocketEngine::Deinit()
  87 {
  88         Close(EngineHandle);
  89 }
  90
  91 static struct kevent* GetChangeKE()
  92 {
  93         if (ChangePos >= changelist.size())
  94                 changelist.resize(changelist.size() * 2);
  95         return &changelist[ChangePos++];
  96 }
  97
  98 bool SocketEngine::AddFd(EventHandler* eh, int event_mask)
  99 {
 100         int fd = eh->GetFd();
 101
 102         if (fd < 0)
 103                 return false;
 104
 105         if (!SocketEngine::AddFdRef(eh))
 106                 return false;
 107
 108         // We always want to read from the socket...
 109         struct kevent* ke = GetChangeKE();
 110         EV_SET(ke, fd, EVFILT_READ, EV_ADD, 0, 0, static_cast<void*>(eh));
 111
 112         ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "New file descriptor: %d", fd);
 113
 114         eh->SetEventMask(event_mask);
 115         OnSetEvent(eh, 0, event_mask);
 116         ResizeDouble(ke_list);
 117
 118         return true;
 119 }
 120
 121 void SocketEngine::DelFd(EventHandler* eh)
 122 {
 123         int fd = eh->GetFd();
 124
 125         if (fd < 0)
 126         {
 127                 ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "DelFd() on invalid fd: %d", fd);
 128                 return;
 129         }
 130
 131         // First remove the write filter ignoring errors, since we can't be
 132         // sure if there are actually any write filters registered.
 133         struct kevent* ke = GetChangeKE();
 134         EV_SET(ke, eh->GetFd(), EVFILT_WRITE, EV_DELETE, 0, 0, NULL);
 135
 136         // Then remove the read filter.
 137         ke = GetChangeKE();
 138         EV_SET(ke, eh->GetFd(), EVFILT_READ, EV_DELETE, 0, 0, NULL);
 139
 140         SocketEngine::DelFdRef(eh);
 141
 142         ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "Remove file descriptor: %d", fd);
 143 }
 144
 145 void SocketEngine::OnSetEvent(EventHandler* eh, int old_mask, int new_mask)
 146 {
 147         if ((new_mask & FD_WANT_POLL_WRITE) && !(old_mask & FD_WANT_POLL_WRITE))
 148         {
 149                 // new poll-style write
 150                 struct kevent* ke = GetChangeKE();
 151                 EV_SET(ke, eh->GetFd(), EVFILT_WRITE, EV_ADD, 0, 0, static_cast<void*>(eh));
 152         }
 153         else if ((old_mask & FD_WANT_POLL_WRITE) && !(new_mask & FD_WANT_POLL_WRITE))
 154         {
 155                 // removing poll-style write
 156                 struct kevent* ke = GetChangeKE();
 157                 EV_SET(ke, eh->GetFd(), EVFILT_WRITE, EV_DELETE, 0, 0, NULL);
 158         }
 159         if ((new_mask & (FD_WANT_FAST_WRITE | FD_WANT_SINGLE_WRITE)) && !(old_mask & (FD_WANT_FAST_WRITE | FD_WANT_SINGLE_WRITE)))
 160         {
 161                 struct kevent* ke = GetChangeKE();
 162                 EV_SET(ke, eh->GetFd(), EVFILT_WRITE, EV_ADD | EV_ONESHOT, 0, 0, static_cast<void*>(eh));
 163         }
 164 }
 165
 166 int SocketEngine::DispatchEvents()
 167 {
 168         struct timespec ts;
 169         ts.tv_nsec = 0;
 170         ts.tv_sec = 1;
 171
 172         int i = kevent(EngineHandle, &changelist.front(), ChangePos, &ke_list.front(), ke_list.size(), &ts);
 173         ChangePos = 0;
 174         ServerInstance->UpdateTime();
 175
 176         if (i < 0)
 177                 return i;
 178
 179         stats.TotalEvents += i;
 180
 181         for (int j = 0; j < i; j++)
 182         {
 183                 struct kevent& kev = ke_list[j];
 184                 EventHandler* eh = static_cast<EventHandler*>(kev.udata);
 185                 if (!eh)
 186                         continue;
 187
 188                 // Copy these in case the vector gets resized and kev invalidated
 189                 const int fd = eh->GetFd();
 190                 const short filter = kev.filter;
 191                 if (fd < 0)
 192                         continue;
 193
 194                 if (kev.flags & EV_EOF)
 195                 {
 196                         stats.ErrorEvents++;
 197                         eh->OnEventHandlerError(kev.fflags);
 198                         continue;
 199                 }
 200                 if (filter == EVFILT_WRITE)
 201                 {
 202                         stats.WriteEvents++;
 203                         /* When mask is FD_WANT_FAST_WRITE or FD_WANT_SINGLE_WRITE,
 204                          * we set a one-shot write, so we need to clear that bit
 205                          * to detect when it set again.
 206                          */
 207                         const int bits_to_clr = FD_WANT_SINGLE_WRITE | FD_WANT_FAST_WRITE | FD_WRITE_WILL_BLOCK;
 208                         eh->SetEventMask(eh->GetEventMask() & ~bits_to_clr);
 209                         eh->OnEventHandlerWrite();
 210                 }
 211                 else if (filter == EVFILT_READ)
 212                 {
 213                         stats.ReadEvents++;
 214                         eh->SetEventMask(eh->GetEventMask() & ~FD_READ_WILL_BLOCK);
 215                         eh->OnEventHandlerRead();
 216                 }
 217         }
 218
 219         return i;
 220 }