2 * InspIRCd -- Internet Relay Chat Daemon
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>
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.
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
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/>.
23 #include "exitcodes.h"
24 #include <sys/types.h>
25 #include <sys/event.h>
27 #include "socketengine.h"
29 #include <sys/sysctl.h>
31 /** A specialisation of the SocketEngine class, designed to use BSD kqueue().
33 class KQueueEngine : public SocketEngine
37 /** These are used by kqueue() to hold socket events
39 std::vector<struct kevent> ke_list;
40 /** This is a specialised time value used by kqueue()
44 /** Create a new KQueueEngine
47 /** Delete a KQueueEngine
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();
57 KQueueEngine::KQueueEngine() : ke_list(1)
64 #ifdef KERN_MAXFILESPERPROC
65 mib[1] = KERN_MAXFILESPERPROC;
67 mib[1] = KERN_MAXFILES;
69 len = sizeof(MAX_DESCRIPTORS);
70 sysctl(mib, 2, &MAX_DESCRIPTORS, &len, NULL, 0);
71 if (MAX_DESCRIPTORS <= 0)
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);
78 this->RecoverFromFork();
81 void KQueueEngine::RecoverFromFork()
84 * The only bad thing about kqueue is that its fd cant survive a fork and is not inherited.
88 EngineHandle = kqueue();
89 if (EngineHandle == -1)
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);
100 KQueueEngine::~KQueueEngine()
102 this->Close(EngineHandle);
105 bool KQueueEngine::AddFd(EventHandler* eh, int event_mask)
107 int fd = eh->GetFd();
109 if ((fd < 0) || (fd > GetMaxFds() - 1))
112 if (!SocketEngine::AddFd(eh))
115 // We always want to read from the socket...
117 EV_SET(&ke, fd, EVFILT_READ, EV_ADD, 0, 0, NULL);
119 int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
122 ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "Failed to add fd: %d %s",
123 fd, strerror(errno));
127 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "New file descriptor: %d", fd);
129 SocketEngine::SetEventMask(eh, event_mask);
130 OnSetEvent(eh, 0, event_mask);
132 ResizeDouble(ke_list);
137 void KQueueEngine::DelFd(EventHandler* eh)
139 int fd = eh->GetFd();
141 if ((fd < 0) || (fd > GetMaxFds() - 1))
143 ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "DelFd() on invalid fd: %d", fd);
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);
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);
160 ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "Failed to remove fd: %d %s",
161 fd, strerror(errno));
164 SocketEngine::DelFd(eh);
167 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "Remove file descriptor: %d", fd);
170 void KQueueEngine::OnSetEvent(EventHandler* eh, int old_mask, int new_mask)
172 if ((new_mask & FD_WANT_POLL_WRITE) && !(old_mask & FD_WANT_POLL_WRITE))
174 // new poll-style write
176 EV_SET(&ke, eh->GetFd(), EVFILT_WRITE, EV_ADD, 0, 0, NULL);
177 int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
179 ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "Failed to mark for writing: %d %s",
180 eh->GetFd(), strerror(errno));
182 else if ((old_mask & FD_WANT_POLL_WRITE) && !(new_mask & FD_WANT_POLL_WRITE))
184 // removing poll-style write
186 EV_SET(&ke, eh->GetFd(), EVFILT_WRITE, EV_DELETE, 0, 0, NULL);
187 int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
189 ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "Failed to mark for writing: %d %s",
190 eh->GetFd(), strerror(errno));
192 if ((new_mask & (FD_WANT_FAST_WRITE | FD_WANT_SINGLE_WRITE)) && !(old_mask & (FD_WANT_FAST_WRITE | FD_WANT_SINGLE_WRITE)))
194 // new one-shot write
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);
199 ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "Failed to mark for writing: %d %s",
200 eh->GetFd(), strerror(errno));
204 int KQueueEngine::DispatchEvents()
209 int i = kevent(EngineHandle, NULL, 0, &ke_list[0], ke_list.size(), &ts);
210 ServerInstance->UpdateTime();
217 for (int j = 0; j < i; j++)
219 struct kevent& kev = ke_list[j];
221 // Copy these in case the vector gets resized and kev invalidated
222 const int fd = kev.ident;
223 const short filter = kev.filter;
225 EventHandler* eh = GetRef(fd);
229 if (kev.flags & EV_EOF)
232 eh->HandleEvent(EVENT_ERROR, kev.fflags);
235 if (filter == EVFILT_WRITE)
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.
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);
246 else if (filter == EVFILT_READ)
249 SetEventMask(eh, eh->GetEventMask() & ~FD_READ_WILL_BLOCK);
250 eh->HandleEvent(EVENT_READ);
257 SocketEngine* CreateSocketEngine()
259 return new KQueueEngine;