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 /** A specialisation of the SocketEngine class, designed to use FreeBSD kqueue().
31 class KQueueEngine : public SocketEngine
35 /** These are used by kqueue() to hold socket events
37 struct kevent* ke_list;
38 /** This is a specialised time value used by kqueue()
42 /** Create a new KQueueEngine
45 /** Delete a KQueueEngine
47 virtual ~KQueueEngine();
48 bool AddFd(EventHandler* eh, int event_mask);
49 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 virtual void RecoverFromFork();
56 #include <sys/sysctl.h>
58 KQueueEngine::KQueueEngine()
65 mib[1] = KERN_MAXFILESPERPROC;
66 len = sizeof(MAX_DESCRIPTORS);
67 sysctl(mib, 2, &MAX_DESCRIPTORS, &len, NULL, 0);
68 if (MAX_DESCRIPTORS <= 0)
70 ServerInstance->Logs->Log("SOCKET", DEFAULT, "ERROR: Can't determine maximum number of open sockets!");
71 printf("ERROR: Can't determine maximum number of open sockets!\n");
72 ServerInstance->Exit(EXIT_STATUS_SOCKETENGINE);
75 this->RecoverFromFork();
76 ke_list = new struct kevent[GetMaxFds()];
77 ref = new EventHandler* [GetMaxFds()];
78 memset(ref, 0, GetMaxFds() * sizeof(EventHandler*));
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",DEFAULT, "ERROR: Could not initialize socket engine. Your kernel probably does not have the proper features.");
92 ServerInstance->Logs->Log("SOCKET",DEFAULT, "ERROR: this is a fatal error, exiting now.");
93 printf("ERROR: Could not initialize socket engine. Your kernel probably does not have the proper features.\n");
94 printf("ERROR: this is a fatal error, exiting now.\n");
95 ServerInstance->Exit(EXIT_STATUS_SOCKETENGINE);
100 KQueueEngine::~KQueueEngine()
102 this->Close(EngineHandle);
107 bool KQueueEngine::AddFd(EventHandler* eh, int event_mask)
109 int fd = eh->GetFd();
111 if ((fd < 0) || (fd > GetMaxFds() - 1))
117 // We always want to read from the socket...
119 EV_SET(&ke, fd, EVFILT_READ, EV_ADD, 0, 0, NULL);
121 int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
124 ServerInstance->Logs->Log("SOCKET",DEFAULT,"Failed to add fd: %d %s",
125 fd, strerror(errno));
130 SocketEngine::SetEventMask(eh, event_mask);
131 OnSetEvent(eh, 0, event_mask);
134 ServerInstance->Logs->Log("SOCKET",DEBUG,"New file descriptor: %d", fd);
138 void KQueueEngine::DelFd(EventHandler* eh)
140 int fd = eh->GetFd();
142 if ((fd < 0) || (fd > GetMaxFds() - 1))
144 ServerInstance->Logs->Log("SOCKET",DEFAULT,"DelFd() on invalid fd: %d", fd);
150 // First remove the write filter ignoring errors, since we can't be
151 // sure if there are actually any write filters registered.
152 EV_SET(&ke, eh->GetFd(), EVFILT_WRITE, EV_DELETE, 0, 0, NULL);
153 kevent(EngineHandle, &ke, 1, 0, 0, NULL);
155 // Then remove the read filter.
156 EV_SET(&ke, eh->GetFd(), EVFILT_READ, EV_DELETE, 0, 0, NULL);
157 int j = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
161 ServerInstance->Logs->Log("SOCKET",DEFAULT,"Failed to remove fd: %d %s",
162 fd, strerror(errno));
168 ServerInstance->Logs->Log("SOCKET",DEBUG,"Remove file descriptor: %d", fd);
171 void KQueueEngine::OnSetEvent(EventHandler* eh, int old_mask, int new_mask)
173 if ((new_mask & FD_WANT_POLL_WRITE) && !(old_mask & FD_WANT_POLL_WRITE))
175 // new poll-style write
177 EV_SET(&ke, eh->GetFd(), EVFILT_WRITE, EV_ADD, 0, 0, NULL);
178 int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
180 ServerInstance->Logs->Log("SOCKET",DEFAULT,"Failed to mark for writing: %d %s",
181 eh->GetFd(), strerror(errno));
184 else if ((old_mask & FD_WANT_POLL_WRITE) && !(new_mask & FD_WANT_POLL_WRITE))
186 // removing poll-style write
188 EV_SET(&ke, eh->GetFd(), EVFILT_WRITE, EV_DELETE, 0, 0, NULL);
189 int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
191 ServerInstance->Logs->Log("SOCKET",DEFAULT,"Failed to mark for writing: %d %s",
192 eh->GetFd(), strerror(errno));
195 if ((new_mask & (FD_WANT_FAST_WRITE | FD_WANT_SINGLE_WRITE)) && !(old_mask & (FD_WANT_FAST_WRITE | FD_WANT_SINGLE_WRITE)))
197 // new one-shot write
199 EV_SET(&ke, eh->GetFd(), EVFILT_WRITE, EV_ADD | EV_ONESHOT, 0, 0, NULL);
200 int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
202 ServerInstance->Logs->Log("SOCKET",DEFAULT,"Failed to mark for writing: %d %s",
203 eh->GetFd(), strerror(errno));
208 int KQueueEngine::DispatchEvents()
213 int i = kevent(EngineHandle, NULL, 0, &ke_list[0], GetMaxFds(), &ts);
214 ServerInstance->UpdateTime();
218 for (int j = 0; j < i; j++)
220 EventHandler* eh = ref[ke_list[j].ident];
223 if (ke_list[j].flags & EV_EOF)
226 eh->HandleEvent(EVENT_ERROR, ke_list[j].fflags);
229 if (ke_list[j].filter == EVFILT_WRITE)
232 /* When mask is FD_WANT_FAST_WRITE or FD_WANT_SINGLE_WRITE,
233 * we set a one-shot write, so we need to clear that bit
234 * to detect when it set again.
236 const int bits_to_clr = FD_WANT_SINGLE_WRITE | FD_WANT_FAST_WRITE | FD_WRITE_WILL_BLOCK;
237 SetEventMask(eh, eh->GetEventMask() & ~bits_to_clr);
238 eh->HandleEvent(EVENT_WRITE);
240 if (eh != ref[ke_list[j].ident])
241 // whoops, deleted out from under us
244 if (ke_list[j].filter == EVFILT_READ)
247 SetEventMask(eh, eh->GetEventMask() & ~FD_READ_WILL_BLOCK);
248 eh->HandleEvent(EVENT_READ);
255 std::string KQueueEngine::GetName()
260 SocketEngine* CreateSocketEngine()
262 return new KQueueEngine;