-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd: (C) 2002-2009 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * Copyright (C) 2014-2015 Attila Molnar <attilamolnar@hush.com>
+ * Copyright (C) 2014 Adam <Adam@anope.org>
+ * Copyright (C) 2012-2013, 2017, 2019 Sadie Powell <sadie@witchery.services>
+ * Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ * Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
+ * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+ * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ * Copyright (C) 2006-2008, 2010 Craig Edwards <brain@inspircd.org>
*
- * This program is free but copyrighted software; see
- * the file COPYING for details.
+ * This file is part of InspIRCd. InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
*
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+
#include "inspircd.h"
-#include "exitcodes.h"
+
#include <sys/types.h>
#include <sys/event.h>
#include <sys/time.h>
-#include "socketengines/socketengine_kqueue.h"
#include <sys/sysctl.h>
-KQueueEngine::KQueueEngine(InspIRCd* Instance) : SocketEngine(Instance)
+/** A specialisation of the SocketEngine class, designed to use BSD kqueue().
+ */
+namespace
+{
+ int EngineHandle;
+ unsigned int ChangePos = 0;
+ /** These are used by kqueue() to hold socket events
+ */
+ std::vector<struct kevent> ke_list(16);
+
+ /** Pending changes
+ */
+ std::vector<struct kevent> changelist(8);
+
+#if defined __NetBSD__ && __NetBSD_Version__ <= 999001400
+ inline intptr_t udata_cast(EventHandler* eh)
+ {
+ // On NetBSD <10 the last parameter of EV_SET is intptr_t.
+ return reinterpret_cast<intptr_t>(eh);
+ }
+#else
+ inline void* udata_cast(EventHandler* eh)
+ {
+ // On other platforms the last parameter of EV_SET is void*.
+ return static_cast<void*>(eh);
+ }
+#endif
+}
+
+/** Initialize the kqueue engine
+ */
+void SocketEngine::Init()
{
- MAX_DESCRIPTORS = 0;
- this->RecoverFromFork();
- ke_list = new struct kevent[GetMaxFds()];
- ref = new EventHandler* [GetMaxFds()];
- memset(ref, 0, GetMaxFds() * sizeof(EventHandler*));
+ LookupMaxFds();
+ RecoverFromFork();
}
-void KQueueEngine::RecoverFromFork()
+void SocketEngine::RecoverFromFork()
{
/*
* The only bad thing about kqueue is that its fd cant survive a fork and is not inherited.
* BUM HATS.
- *
+ *
*/
EngineHandle = kqueue();
if (EngineHandle == -1)
- {
- ServerInstance->Logs->Log("SOCKET",DEFAULT, "ERROR: Could not initialize socket engine. Your kernel probably does not have the proper features.");
- ServerInstance->Logs->Log("SOCKET",DEFAULT, "ERROR: this is a fatal error, exiting now.");
- printf("ERROR: Could not initialize socket engine. Your kernel probably does not have the proper features.\n");
- printf("ERROR: this is a fatal error, exiting now.\n");
- ServerInstance->Exit(EXIT_STATUS_SOCKETENGINE);
- }
- CurrentSetSize = 0;
+ InitError();
}
-KQueueEngine::~KQueueEngine()
+/** Shutdown the kqueue engine
+ */
+void SocketEngine::Deinit()
{
- this->Close(EngineHandle);
- delete[] ref;
- delete[] ke_list;
+ Close(EngineHandle);
}
-bool KQueueEngine::AddFd(EventHandler* eh)
+static struct kevent* GetChangeKE()
{
- int fd = eh->GetFd();
+ if (ChangePos >= changelist.size())
+ changelist.resize(changelist.size() * 2);
+ return &changelist[ChangePos++];
+}
- if ((fd < 0) || (fd > GetMaxFds() - 1))
- return false;
+bool SocketEngine::AddFd(EventHandler* eh, int event_mask)
+{
+ int fd = eh->GetFd();
- if (GetRemainingFds() <= 1)
+ if (fd < 0)
return false;
- if (ref[fd])
+ if (!SocketEngine::AddFdRef(eh))
return false;
- struct kevent ke;
- EV_SET(&ke, fd, eh->Readable() ? EVFILT_READ : EVFILT_WRITE, EV_ADD, 0, 0, NULL);
+ // We always want to read from the socket...
+ struct kevent* ke = GetChangeKE();
+ EV_SET(ke, fd, EVFILT_READ, EV_ADD, 0, 0, udata_cast(eh));
- int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
- if (i == -1)
- {
- return false;
- }
+ ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "New file descriptor: %d", fd);
- ref[fd] = eh;
- CurrentSetSize++;
+ eh->SetEventMask(event_mask);
+ OnSetEvent(eh, 0, event_mask);
+ ResizeDouble(ke_list);
- ServerInstance->Logs->Log("SOCKET",DEBUG,"New file descriptor: %d", fd);
return true;
}
-bool KQueueEngine::DelFd(EventHandler* eh, bool force)
+void SocketEngine::DelFd(EventHandler* eh)
{
int fd = eh->GetFd();
- if ((fd < 0) || (fd > GetMaxFds() - 1))
- return false;
-
- struct kevent ke;
- EV_SET(&ke, eh->GetFd(), EVFILT_READ, EV_DELETE, 0, 0, NULL);
-
- int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
-
- EV_SET(&ke, eh->GetFd(), EVFILT_WRITE, EV_DELETE, 0, 0, NULL);
-
- int j = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
+ if (fd < 0)
+ {
+ ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "DelFd() on invalid fd: %d", fd);
+ return;
+ }
- if ((j < 0) && (i < 0) && !force)
- return false;
+ // First remove the write filter ignoring errors, since we can't be
+ // sure if there are actually any write filters registered.
+ struct kevent* ke = GetChangeKE();
+ EV_SET(ke, eh->GetFd(), EVFILT_WRITE, EV_DELETE, 0, 0, NULL);
- CurrentSetSize--;
- ref[fd] = NULL;
+ // Then remove the read filter.
+ ke = GetChangeKE();
+ EV_SET(ke, eh->GetFd(), EVFILT_READ, EV_DELETE, 0, 0, NULL);
- //ServerInstance->Logs->Log("SOCKET",DEBUG,"Remove file descriptor: %d", fd);
- return true;
-}
+ SocketEngine::DelFdRef(eh);
-void KQueueEngine::WantWrite(EventHandler* eh)
-{
- /** When changing an item in a kqueue, there is no 'modify' call
- * as in epoll. Instead, we add the item again, and this overwrites
- * the original setting rather than adding it twice. See man kqueue.
- */
- struct kevent ke;
- EV_SET(&ke, eh->GetFd(), EVFILT_READ, EV_ADD | EV_ONESHOT, 0, 0, NULL);
- EV_SET(&ke, eh->GetFd(), EVFILT_WRITE, EV_ADD | EV_ONESHOT, 0, 0, NULL);
- kevent(EngineHandle, &ke, 1, 0, 0, NULL);
+ ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "Remove file descriptor: %d", fd);
}
-int KQueueEngine::GetMaxFds()
+void SocketEngine::OnSetEvent(EventHandler* eh, int old_mask, int new_mask)
{
- if (!MAX_DESCRIPTORS)
+ if ((new_mask & FD_WANT_POLL_WRITE) && !(old_mask & FD_WANT_POLL_WRITE))
{
- int mib[2], maxfiles;
- size_t len;
-
- mib[0] = CTL_KERN;
- mib[1] = KERN_MAXFILES;
- len = sizeof(maxfiles);
- sysctl(mib, 2, &maxfiles, &len, NULL, 0);
- MAX_DESCRIPTORS = maxfiles;
- return maxfiles;
+ // new poll-style write
+ struct kevent* ke = GetChangeKE();
+ EV_SET(ke, eh->GetFd(), EVFILT_WRITE, EV_ADD, 0, 0, udata_cast(eh));
+ }
+ else if ((old_mask & FD_WANT_POLL_WRITE) && !(new_mask & FD_WANT_POLL_WRITE))
+ {
+ // removing poll-style write
+ struct kevent* ke = GetChangeKE();
+ EV_SET(ke, eh->GetFd(), EVFILT_WRITE, EV_DELETE, 0, 0, NULL);
+ }
+ if ((new_mask & (FD_WANT_FAST_WRITE | FD_WANT_SINGLE_WRITE)) && !(old_mask & (FD_WANT_FAST_WRITE | FD_WANT_SINGLE_WRITE)))
+ {
+ struct kevent* ke = GetChangeKE();
+ EV_SET(ke, eh->GetFd(), EVFILT_WRITE, EV_ADD | EV_ONESHOT, 0, 0, udata_cast(eh));
}
- return MAX_DESCRIPTORS;
-}
-
-int KQueueEngine::GetRemainingFds()
-{
- return GetMaxFds() - CurrentSetSize;
}
-int KQueueEngine::DispatchEvents()
+int SocketEngine::DispatchEvents()
{
+ struct timespec ts;
ts.tv_nsec = 0;
ts.tv_sec = 1;
- int i = kevent(EngineHandle, NULL, 0, &ke_list[0], GetMaxFds(), &ts);
+ int i = kevent(EngineHandle, &changelist.front(), ChangePos, &ke_list.front(), ke_list.size(), &ts);
+ ChangePos = 0;
+ ServerInstance->UpdateTime();
- TotalEvents += i;
+ if (i < 0)
+ return i;
+
+ stats.TotalEvents += i;
for (int j = 0; j < i; j++)
{
- if (ke_list[j].flags & EV_EOF)
+ // This can't be a static_cast because udata is intptr_t on NetBSD.
+ struct kevent& kev = ke_list[j];
+ EventHandler* eh = reinterpret_cast<EventHandler*>(kev.udata);
+ if (!eh)
+ continue;
+
+ // Copy these in case the vector gets resized and kev invalidated
+ const int fd = eh->GetFd();
+ const short filter = kev.filter;
+ if (fd < 0)
+ continue;
+
+ if (kev.flags & EV_EOF)
{
- /* We love you kqueue, oh yes we do *sings*!
- * kqueue gives us the error number directly in the EOF state!
- * Unlike smelly epoll and select, where we have to getsockopt
- * to get the error, this saves us time and cpu cycles. Go BSD!
- */
- ErrorEvents++;
- if (ref[ke_list[j].ident])
- ref[ke_list[j].ident]->HandleEvent(EVENT_ERROR, ke_list[j].fflags);
+ stats.ErrorEvents++;
+ eh->OnEventHandlerError(kev.fflags);
continue;
}
- if (ke_list[j].filter == EVFILT_WRITE)
+ if (filter == EVFILT_WRITE)
{
- /* This looks wrong but its right. As above, theres no modify
- * call in kqueue. See the manpage.
+ /* When mask is FD_WANT_FAST_WRITE or FD_WANT_SINGLE_WRITE,
+ * we set a one-shot write, so we need to clear that bit
+ * to detect when it set again.
*/
- if (ref[ke_list[j].ident]->Readable())
- {
- struct kevent ke;
- EV_SET(&ke, ke_list[j].ident, EVFILT_READ, EV_ADD, 0, 0, NULL);
- kevent(EngineHandle, &ke, 1, 0, 0, NULL);
- }
- WriteEvents++;
- if (ref[ke_list[j].ident])
- ref[ke_list[j].ident]->HandleEvent(EVENT_WRITE);
+ const int bits_to_clr = FD_WANT_SINGLE_WRITE | FD_WANT_FAST_WRITE | FD_WRITE_WILL_BLOCK;
+ eh->SetEventMask(eh->GetEventMask() & ~bits_to_clr);
+ eh->OnEventHandlerWrite();
}
- if (ke_list[j].filter == EVFILT_READ)
+ else if (filter == EVFILT_READ)
{
- ReadEvents++;
- if (ref[ke_list[j].ident])
- ref[ke_list[j].ident]->HandleEvent(EVENT_READ);
+ eh->SetEventMask(eh->GetEventMask() & ~FD_READ_WILL_BLOCK);
+ eh->OnEventHandlerRead();
}
}
return i;
}
-
-std::string KQueueEngine::GetName()
-{
- return "kqueue";
-}
projects / user / henk / code / inspircd.git / blobdiff