1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2010 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
15 #include "exitcodes.h"
16 #include <sys/types.h>
17 #include <sys/event.h>
19 /* +------------------------------------+
20 * | Inspire Internet Relay Chat Daemon |
21 * +------------------------------------+
23 * InspIRCd: (C) 2002-2010 InspIRCd Development Team
24 * See: http://wiki.inspircd.org/Credits
26 * This program is free but copyrighted software; see
27 * the file COPYING for details.
29 * ---------------------------------------------------
32 #ifndef __SOCKETENGINE_KQUEUE__
33 #define __SOCKETENGINE_KQUEUE__
38 #include "inspircd_config.h"
40 #include <sys/types.h>
41 #include <sys/event.h>
43 #include "socketengine.h"
45 /** A specialisation of the SocketEngine class, designed to use FreeBSD kqueue().
47 class KQueueEngine : public SocketEngine
51 /** These are used by kqueue() to hold socket events
53 struct kevent* ke_list;
54 /** This is a specialised time value used by kqueue()
58 /** Create a new KQueueEngine
61 /** Delete a KQueueEngine
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();
74 #include <sys/sysctl.h>
76 KQueueEngine::KQueueEngine()
79 this->RecoverFromFork();
80 ke_list = new struct kevent[GetMaxFds()];
81 ref = new EventHandler* [GetMaxFds()];
82 memset(ref, 0, GetMaxFds() * sizeof(EventHandler*));
85 void KQueueEngine::RecoverFromFork()
88 * The only bad thing about kqueue is that its fd cant survive a fork and is not inherited.
92 EngineHandle = kqueue();
93 if (EngineHandle == -1)
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);
104 KQueueEngine::~KQueueEngine()
106 this->Close(EngineHandle);
111 bool KQueueEngine::AddFd(EventHandler* eh, int event_mask)
113 int fd = eh->GetFd();
115 if ((fd < 0) || (fd > GetMaxFds() - 1))
121 // We always want to read from the socket...
123 EV_SET(&ke, fd, EVFILT_READ, EV_ADD, 0, 0, NULL);
125 int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
128 ServerInstance->Logs->Log("SOCKET",DEFAULT,"Failed to add fd: %d %s",
129 fd, strerror(errno));
134 SocketEngine::SetEventMask(eh, event_mask);
135 OnSetEvent(eh, 0, event_mask);
138 ServerInstance->Logs->Log("SOCKET",DEBUG,"New file descriptor: %d", fd);
142 bool KQueueEngine::DelFd(EventHandler* eh, bool force)
144 int fd = eh->GetFd();
146 if ((fd < 0) || (fd > GetMaxFds() - 1))
148 ServerInstance->Logs->Log("SOCKET",DEFAULT,"DelFd() on invalid fd: %d", fd);
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);
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);
163 if ((j < 0) && !force)
165 ServerInstance->Logs->Log("SOCKET",DEFAULT,"Failed to remove fd: %d %s",
166 fd, strerror(errno));
173 ServerInstance->Logs->Log("SOCKET",DEBUG,"Remove file descriptor: %d", fd);
177 void KQueueEngine::OnSetEvent(EventHandler* eh, int old_mask, int new_mask)
179 if ((new_mask & FD_WANT_POLL_WRITE) && !(old_mask & FD_WANT_POLL_WRITE))
181 // new poll-style write
183 EV_SET(&ke, eh->GetFd(), EVFILT_WRITE, EV_ADD, 0, 0, NULL);
184 int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
186 ServerInstance->Logs->Log("SOCKET",DEFAULT,"Failed to mark for writing: %d %s",
187 eh->GetFd(), strerror(errno));
190 else if ((old_mask & FD_WANT_POLL_WRITE) && !(new_mask & FD_WANT_POLL_WRITE))
192 // removing poll-style write
194 EV_SET(&ke, eh->GetFd(), EVFILT_WRITE, EV_DELETE, 0, 0, NULL);
195 int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
197 ServerInstance->Logs->Log("SOCKET",DEFAULT,"Failed to mark for writing: %d %s",
198 eh->GetFd(), strerror(errno));
201 if ((new_mask & (FD_WANT_FAST_WRITE | FD_WANT_SINGLE_WRITE)) && !(old_mask & (FD_WANT_FAST_WRITE | FD_WANT_SINGLE_WRITE)))
203 // new one-shot write
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);
208 ServerInstance->Logs->Log("SOCKET",DEFAULT,"Failed to mark for writing: %d %s",
209 eh->GetFd(), strerror(errno));
214 int KQueueEngine::DispatchEvents()
219 int i = kevent(EngineHandle, NULL, 0, &ke_list[0], GetMaxFds(), &ts);
223 for (int j = 0; j < i; j++)
225 EventHandler* eh = ref[ke_list[j].ident];
228 if (ke_list[j].flags & EV_EOF)
231 eh->HandleEvent(EVENT_ERROR, ke_list[j].fflags);
234 if (ke_list[j].filter == EVFILT_WRITE)
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.
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);
245 if (ke_list[j].filter == EVFILT_READ)
248 SetEventMask(eh, eh->GetEventMask() & ~FD_READ_WILL_BLOCK);
249 eh->HandleEvent(EVENT_READ);
256 std::string KQueueEngine::GetName()
261 SocketEngine* CreateSocketEngine()
263 return new KQueueEngine;