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 #include "socketengine.h"
21 /** A specialisation of the SocketEngine class, designed to use FreeBSD kqueue().
23 class KQueueEngine : public SocketEngine
27 /** These are used by kqueue() to hold socket events
29 struct kevent* ke_list;
30 /** This is a specialised time value used by kqueue()
34 /** Create a new KQueueEngine
37 /** Delete a KQueueEngine
39 virtual ~KQueueEngine();
40 bool AddFd(EventHandler* eh, int event_mask);
41 void OnSetEvent(EventHandler* eh, int old_mask, int new_mask);
42 virtual void DelFd(EventHandler* eh);
43 virtual int DispatchEvents();
44 virtual std::string GetName();
45 virtual void RecoverFromFork();
48 #include <sys/sysctl.h>
50 KQueueEngine::KQueueEngine()
57 mib[1] = KERN_MAXFILESPERPROC;
58 len = sizeof(MAX_DESCRIPTORS);
59 sysctl(mib, 2, &MAX_DESCRIPTORS, &len, NULL, 0);
60 if (MAX_DESCRIPTORS <= 0)
62 ServerInstance->Logs->Log("SOCKET", DEFAULT, "ERROR: Can't determine maximum number of open sockets!");
63 printf("ERROR: Can't determine maximum number of open sockets!\n");
64 ServerInstance->Exit(EXIT_STATUS_SOCKETENGINE);
67 this->RecoverFromFork();
68 ke_list = new struct kevent[GetMaxFds()];
69 ref = new EventHandler* [GetMaxFds()];
70 memset(ref, 0, GetMaxFds() * sizeof(EventHandler*));
73 void KQueueEngine::RecoverFromFork()
76 * The only bad thing about kqueue is that its fd cant survive a fork and is not inherited.
80 EngineHandle = kqueue();
81 if (EngineHandle == -1)
83 ServerInstance->Logs->Log("SOCKET",DEFAULT, "ERROR: Could not initialize socket engine. Your kernel probably does not have the proper features.");
84 ServerInstance->Logs->Log("SOCKET",DEFAULT, "ERROR: this is a fatal error, exiting now.");
85 printf("ERROR: Could not initialize socket engine. Your kernel probably does not have the proper features.\n");
86 printf("ERROR: this is a fatal error, exiting now.\n");
87 ServerInstance->Exit(EXIT_STATUS_SOCKETENGINE);
92 KQueueEngine::~KQueueEngine()
94 this->Close(EngineHandle);
99 bool KQueueEngine::AddFd(EventHandler* eh, int event_mask)
101 int fd = eh->GetFd();
103 if ((fd < 0) || (fd > GetMaxFds() - 1))
109 // We always want to read from the socket...
111 EV_SET(&ke, fd, EVFILT_READ, EV_ADD, 0, 0, NULL);
113 int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
116 ServerInstance->Logs->Log("SOCKET",DEFAULT,"Failed to add fd: %d %s",
117 fd, strerror(errno));
122 SocketEngine::SetEventMask(eh, event_mask);
123 OnSetEvent(eh, 0, event_mask);
126 ServerInstance->Logs->Log("SOCKET",DEBUG,"New file descriptor: %d", fd);
130 void KQueueEngine::DelFd(EventHandler* eh)
132 int fd = eh->GetFd();
134 if ((fd < 0) || (fd > GetMaxFds() - 1))
136 ServerInstance->Logs->Log("SOCKET",DEFAULT,"DelFd() on invalid fd: %d", fd);
142 // First remove the write filter ignoring errors, since we can't be
143 // sure if there are actually any write filters registered.
144 EV_SET(&ke, eh->GetFd(), EVFILT_WRITE, EV_DELETE, 0, 0, NULL);
145 kevent(EngineHandle, &ke, 1, 0, 0, NULL);
147 // Then remove the read filter.
148 EV_SET(&ke, eh->GetFd(), EVFILT_READ, EV_DELETE, 0, 0, NULL);
149 int j = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
153 ServerInstance->Logs->Log("SOCKET",DEFAULT,"Failed to remove fd: %d %s",
154 fd, strerror(errno));
160 ServerInstance->Logs->Log("SOCKET",DEBUG,"Remove file descriptor: %d", fd);
163 void KQueueEngine::OnSetEvent(EventHandler* eh, int old_mask, int new_mask)
165 if ((new_mask & FD_WANT_POLL_WRITE) && !(old_mask & FD_WANT_POLL_WRITE))
167 // new poll-style write
169 EV_SET(&ke, eh->GetFd(), EVFILT_WRITE, EV_ADD, 0, 0, NULL);
170 int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
172 ServerInstance->Logs->Log("SOCKET",DEFAULT,"Failed to mark for writing: %d %s",
173 eh->GetFd(), strerror(errno));
176 else if ((old_mask & FD_WANT_POLL_WRITE) && !(new_mask & FD_WANT_POLL_WRITE))
178 // removing poll-style write
180 EV_SET(&ke, eh->GetFd(), EVFILT_WRITE, EV_DELETE, 0, 0, NULL);
181 int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
183 ServerInstance->Logs->Log("SOCKET",DEFAULT,"Failed to mark for writing: %d %s",
184 eh->GetFd(), strerror(errno));
187 if ((new_mask & (FD_WANT_FAST_WRITE | FD_WANT_SINGLE_WRITE)) && !(old_mask & (FD_WANT_FAST_WRITE | FD_WANT_SINGLE_WRITE)))
189 // new one-shot write
191 EV_SET(&ke, eh->GetFd(), EVFILT_WRITE, EV_ADD | EV_ONESHOT, 0, 0, NULL);
192 int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
194 ServerInstance->Logs->Log("SOCKET",DEFAULT,"Failed to mark for writing: %d %s",
195 eh->GetFd(), strerror(errno));
200 int KQueueEngine::DispatchEvents()
205 int i = kevent(EngineHandle, NULL, 0, &ke_list[0], GetMaxFds(), &ts);
206 ServerInstance->UpdateTime();
210 for (int j = 0; j < i; j++)
212 EventHandler* eh = ref[ke_list[j].ident];
215 if (ke_list[j].flags & EV_EOF)
218 eh->HandleEvent(EVENT_ERROR, ke_list[j].fflags);
221 if (ke_list[j].filter == EVFILT_WRITE)
224 /* When mask is FD_WANT_FAST_WRITE or FD_WANT_SINGLE_WRITE,
225 * we set a one-shot write, so we need to clear that bit
226 * to detect when it set again.
228 const int bits_to_clr = FD_WANT_SINGLE_WRITE | FD_WANT_FAST_WRITE | FD_WRITE_WILL_BLOCK;
229 SetEventMask(eh, eh->GetEventMask() & ~bits_to_clr);
230 eh->HandleEvent(EVENT_WRITE);
232 if (eh != ref[ke_list[j].ident])
233 // whoops, deleted out from under us
236 if (ke_list[j].filter == EVFILT_READ)
239 SetEventMask(eh, eh->GetEventMask() & ~FD_READ_WILL_BLOCK);
240 eh->HandleEvent(EVENT_READ);
247 std::string KQueueEngine::GetName()
252 SocketEngine* CreateSocketEngine()
254 return new KQueueEngine;