-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * Copyright (C) 2014-2015 Attila Molnar <attilamolnar@hush.com>
+ * Copyright (C) 2014, 2016 Adam <Adam@anope.org>
+ * Copyright (C) 2013, 2017, 2019 Sadie Powell <sadie@witchery.services>
+ * Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ * Copyright (C) 2012 Ariadne Conill <ariadne@dereferenced.org>
+ * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+ * Copyright (C) 2007-2008 Dennis Friis <peavey@inspircd.org>
+ * Copyright (C) 2006-2008 Craig Edwards <brain@inspircd.org>
+ * Copyright (C) 2006, 2008 Robin Burchell <robin+git@viroteck.net>
*
- * 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/epoll.h>
-#include "socketengines/socketengine_epoll.h"
-#include <ulimit.h>
+#include <sys/resource.h>
-EPollEngine::EPollEngine(InspIRCd* Instance) : SocketEngine(Instance)
+/** A specialisation of the SocketEngine class, designed to use linux 2.6 epoll().
+ */
+namespace
{
- MAX_DESCRIPTORS = 0;
- // This is not a maximum, just a hint at the eventual number of sockets that may be polled.
- EngineHandle = epoll_create(GetMaxFds() / 4);
+ int EngineHandle;
- if (EngineHandle == -1)
- {
- ServerInstance->Logs->Log("SOCKET",DEFAULT, "ERROR: Could not initialize socket engine: %s", strerror(errno));
- ServerInstance->Logs->Log("SOCKET",DEFAULT, "ERROR: Your kernel probably does not have the proper features. This is a fatal error, exiting now.");
- printf("ERROR: Could not initialize socket engine: %s\n", strerror(errno));
- printf("ERROR: Your kernel probably does not have the proper features. This is a fatal error, exiting now.\n");
- ServerInstance->Exit(EXIT_STATUS_SOCKETENGINE);
- }
- CurrentSetSize = 0;
+ /** These are used by epoll() to hold socket events
+ */
+ std::vector<struct epoll_event> events(16);
+}
- ref = new EventHandler* [GetMaxFds()];
- events = new struct epoll_event[GetMaxFds()];
+void SocketEngine::Init()
+{
+ LookupMaxFds();
- memset(ref, 0, GetMaxFds() * sizeof(EventHandler*));
+ // 128 is not a maximum, just a hint at the eventual number of sockets that may be polled,
+ // and it is completely ignored by 2.6.8 and later kernels, except it must be larger than zero.
+ EngineHandle = epoll_create(128);
+ if (EngineHandle == -1)
+ InitError();
}
-EPollEngine::~EPollEngine()
+void SocketEngine::RecoverFromFork()
{
- this->Close(EngineHandle);
- delete[] ref;
- delete[] events;
}
-bool EPollEngine::AddFd(EventHandler* eh)
+void SocketEngine::Deinit()
{
- int fd = eh->GetFd();
- if ((fd < 0) || (fd > GetMaxFds() - 1))
+ Close(EngineHandle);
+}
+
+static unsigned mask_to_epoll(int event_mask)
+{
+ unsigned rv = 0;
+ if (event_mask & (FD_WANT_POLL_READ | FD_WANT_POLL_WRITE | FD_WANT_SINGLE_WRITE))
{
- ServerInstance->Logs->Log("SOCKET",DEBUG,"AddFd out of range: (fd: %d, max: %d)", fd, GetMaxFds());
- return false;
+ // we need to use standard polling on this FD
+ if (event_mask & (FD_WANT_POLL_READ | FD_WANT_FAST_READ))
+ rv |= EPOLLIN;
+ if (event_mask & (FD_WANT_POLL_WRITE | FD_WANT_FAST_WRITE | FD_WANT_SINGLE_WRITE))
+ rv |= EPOLLOUT;
}
+ else
+ {
+ // we can use edge-triggered polling on this FD
+ rv = EPOLLET;
+ if (event_mask & (FD_WANT_FAST_READ | FD_WANT_EDGE_READ))
+ rv |= EPOLLIN;
+ if (event_mask & (FD_WANT_FAST_WRITE | FD_WANT_EDGE_WRITE))
+ rv |= EPOLLOUT;
+ }
+ return rv;
+}
- if (GetRemainingFds() <= 1)
+bool SocketEngine::AddFd(EventHandler* eh, int event_mask)
+{
+ int fd = eh->GetFd();
+ if (fd < 0)
{
- ServerInstance->Logs->Log("SOCKET",DEBUG,"No remaining FDs cannot add fd: %d", fd);
+ ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "AddFd out of range: (fd: %d)", fd);
return false;
}
- if (ref[fd])
+ if (!SocketEngine::AddFdRef(eh))
{
- ServerInstance->Logs->Log("SOCKET",DEBUG,"Attempt to add duplicate fd: %d", fd);
+ ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "Attempt to add duplicate fd: %d", fd);
return false;
}
struct epoll_event ev;
- memset(&ev,0,sizeof(ev));
- eh->Readable() ? ev.events = EPOLLIN : ev.events = EPOLLOUT;
- ev.data.fd = fd;
+ memset(&ev, 0, sizeof(ev));
+ ev.events = mask_to_epoll(event_mask);
+ ev.data.ptr = static_cast<void*>(eh);
int i = epoll_ctl(EngineHandle, EPOLL_CTL_ADD, fd, &ev);
if (i < 0)
{
- ServerInstance->Logs->Log("SOCKET",DEBUG,"Error adding fd: %d to socketengine: %s", fd, strerror(errno));
+ ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "Error adding fd: %d to socketengine: %s", fd, strerror(errno));
return false;
}
- ServerInstance->Logs->Log("SOCKET",DEBUG,"New file descriptor: %d", fd);
+ ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "New file descriptor: %d", fd);
+
+ eh->SetEventMask(event_mask);
+ ResizeDouble(events);
- ref[fd] = eh;
- CurrentSetSize++;
return true;
}
-void EPollEngine::WantWrite(EventHandler* eh)
+void SocketEngine::OnSetEvent(EventHandler* eh, int old_mask, int new_mask)
{
- /** Use oneshot so that the system removes the writeable
- * status for us and saves us a call.
- */
- struct epoll_event ev;
- memset(&ev,0,sizeof(ev));
- ev.events = EPOLLOUT;
- ev.data.fd = eh->GetFd();
- epoll_ctl(EngineHandle, EPOLL_CTL_MOD, eh->GetFd(), &ev);
+ unsigned old_events = mask_to_epoll(old_mask);
+ unsigned new_events = mask_to_epoll(new_mask);
+ if (old_events != new_events)
+ {
+ // ok, we actually have something to tell the kernel about
+ struct epoll_event ev;
+ memset(&ev, 0, sizeof(ev));
+ ev.events = new_events;
+ ev.data.ptr = static_cast<void*>(eh);
+ epoll_ctl(EngineHandle, EPOLL_CTL_MOD, eh->GetFd(), &ev);
+ }
}
-bool EPollEngine::DelFd(EventHandler* eh, bool force)
+void SocketEngine::DelFd(EventHandler* eh)
{
int fd = eh->GetFd();
- if ((fd < 0) || (fd > GetMaxFds() - 1))
+ if (fd < 0)
{
- ServerInstance->Logs->Log("SOCKET",DEBUG,"DelFd out of range: (fd: %d, max: %d)", fd, GetMaxFds());
- return false;
+ ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "DelFd out of range: (fd: %d)", fd);
+ return;
}
+ // Do not initialize epoll_event because for EPOLL_CTL_DEL operations the event is ignored and can be NULL.
+ // In kernel versions before 2.6.9, the EPOLL_CTL_DEL operation required a non-NULL pointer in event,
+ // even though this argument is ignored. Since Linux 2.6.9, event can be specified as NULL when using EPOLL_CTL_DEL.
struct epoll_event ev;
- memset(&ev,0,sizeof(ev));
- eh->Readable() ? ev.events = EPOLLIN : ev.events = EPOLLOUT;
- ev.data.fd = fd;
int i = epoll_ctl(EngineHandle, EPOLL_CTL_DEL, fd, &ev);
- if (i < 0 && !force)
+ if (i < 0)
{
- ServerInstance->Logs->Log("SOCKET",DEBUG,"Cant remove socket: %s", strerror(errno));
- return false;
+ ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "epoll_ctl can't remove socket: %s", strerror(errno));
}
- ref[fd] = NULL;
- CurrentSetSize--;
+ SocketEngine::DelFdRef(eh);
- ServerInstance->Logs->Log("SOCKET",DEBUG,"Remove file descriptor: %d", fd);
- return true;
+ ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "Remove file descriptor: %d", fd);
}
-int EPollEngine::GetMaxFds()
+int SocketEngine::DispatchEvents()
{
- if (MAX_DESCRIPTORS)
- return MAX_DESCRIPTORS;
-
- int max = ulimit(4, 0);
- if (max > 0)
- {
- MAX_DESCRIPTORS = max;
- return max;
- }
- else
- {
- ServerInstance->Logs->Log("SOCKET", DEFAULT, "ERROR: Can't determine maximum number of open sockets!");
- printf("ERROR: Can't determine maximum number of open sockets!\n");
- ServerInstance->Exit(EXIT_STATUS_SOCKETENGINE);
- }
- return 0;
-}
+ int i = epoll_wait(EngineHandle, &events[0], events.size(), 1000);
+ ServerInstance->UpdateTime();
-int EPollEngine::GetRemainingFds()
-{
- return GetMaxFds() - CurrentSetSize;
-}
-
-int EPollEngine::DispatchEvents()
-{
- socklen_t codesize = sizeof(int);
- int errcode;
- int i = epoll_wait(EngineHandle, events, GetMaxFds() - 1, 1000);
-
- TotalEvents += i;
+ stats.TotalEvents += i;
for (int j = 0; j < i; j++)
{
- if (events[j].events & EPOLLHUP)
+ // Copy these in case the vector gets resized and ev invalidated
+ const epoll_event ev = events[j];
+
+ EventHandler* const eh = static_cast<EventHandler*>(ev.data.ptr);
+ const int fd = eh->GetFd();
+ if (fd < 0)
+ continue;
+
+ if (ev.events & EPOLLHUP)
{
- ErrorEvents++;
- if (ref[events[j].data.fd])
- ref[events[j].data.fd]->HandleEvent(EVENT_ERROR, 0);
+ stats.ErrorEvents++;
+ eh->OnEventHandlerError(0);
continue;
}
- if (events[j].events & EPOLLERR)
+
+ if (ev.events & EPOLLERR)
{
- ErrorEvents++;
+ stats.ErrorEvents++;
/* Get error number */
- if (getsockopt(events[j].data.fd, SOL_SOCKET, SO_ERROR, &errcode, &codesize) < 0)
+ socklen_t codesize = sizeof(int);
+ int errcode;
+ if (getsockopt(fd, SOL_SOCKET, SO_ERROR, &errcode, &codesize) < 0)
errcode = errno;
- if (ref[events[j].data.fd])
- ref[events[j].data.fd]->HandleEvent(EVENT_ERROR, errcode);
+ eh->OnEventHandlerError(errcode);
continue;
}
- if (events[j].events & EPOLLOUT)
+
+ int mask = eh->GetEventMask();
+ if (ev.events & EPOLLIN)
+ mask &= ~FD_READ_WILL_BLOCK;
+ if (ev.events & EPOLLOUT)
{
- WriteEvents++;
- struct epoll_event ev;
- memset(&ev,0,sizeof(ev));
- ev.events = EPOLLIN;
- ev.data.fd = events[j].data.fd;
- epoll_ctl(EngineHandle, EPOLL_CTL_MOD, events[j].data.fd, &ev);
- if (ref[events[j].data.fd])
- ref[events[j].data.fd]->HandleEvent(EVENT_WRITE);
+ mask &= ~FD_WRITE_WILL_BLOCK;
+ if (mask & FD_WANT_SINGLE_WRITE)
+ {
+ int nm = mask & ~FD_WANT_SINGLE_WRITE;
+ OnSetEvent(eh, mask, nm);
+ mask = nm;
+ }
}
- else
+ eh->SetEventMask(mask);
+ if (ev.events & EPOLLIN)
{
- ReadEvents++;
- if (ref[events[j].data.fd])
- ref[events[j].data.fd]->HandleEvent(EVENT_READ);
+ eh->OnEventHandlerRead();
+ if (eh != GetRef(fd))
+ // whoa! we got deleted, better not give out the write event
+ continue;
+ }
+ if (ev.events & EPOLLOUT)
+ {
+ eh->OnEventHandlerWrite();
}
}
return i;
}
-
-std::string EPollEngine::GetName()
-{
- return "epoll";
-}
-
projects / user / henk / code / inspircd.git / blobdiff