2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2014-2015 Attila Molnar <attilamolnar@hush.com>
5 * Copyright (C) 2014, 2016 Adam <Adam@anope.org>
6 * Copyright (C) 2013, 2017, 2019 Sadie Powell <sadie@witchery.services>
7 * Copyright (C) 2012 William Pitcock <nenolod@dereferenced.org>
8 * Copyright (C) 2012 Robby <robby@chatbelgie.be>
9 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
10 * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
11 * Copyright (C) 2007-2008 Dennis Friis <peavey@inspircd.org>
12 * Copyright (C) 2007-2008 Craig Edwards <brain@inspircd.org>
13 * Copyright (C) 2006, 2008 Robin Burchell <robin+git@viroteck.net>
15 * This file is part of InspIRCd. InspIRCd is free software: you can
16 * redistribute it and/or modify it under the terms of the GNU General Public
17 * License as published by the Free Software Foundation, version 2.
19 * This program is distributed in the hope that it will be useful, but WITHOUT
20 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
21 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
24 * You should have received a copy of the GNU General Public License
25 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 #include <sys/epoll.h>
32 #include <sys/resource.h>
34 /** A specialisation of the SocketEngine class, designed to use linux 2.6 epoll().
40 /** These are used by epoll() to hold socket events
42 std::vector<struct epoll_event> events(16);
45 void SocketEngine::Init()
49 // 128 is not a maximum, just a hint at the eventual number of sockets that may be polled,
50 // and it is completely ignored by 2.6.8 and later kernels, except it must be larger than zero.
51 EngineHandle = epoll_create(128);
52 if (EngineHandle == -1)
56 void SocketEngine::RecoverFromFork()
60 void SocketEngine::Deinit()
65 static unsigned mask_to_epoll(int event_mask)
68 if (event_mask & (FD_WANT_POLL_READ | FD_WANT_POLL_WRITE | FD_WANT_SINGLE_WRITE))
70 // we need to use standard polling on this FD
71 if (event_mask & (FD_WANT_POLL_READ | FD_WANT_FAST_READ))
73 if (event_mask & (FD_WANT_POLL_WRITE | FD_WANT_FAST_WRITE | FD_WANT_SINGLE_WRITE))
78 // we can use edge-triggered polling on this FD
80 if (event_mask & (FD_WANT_FAST_READ | FD_WANT_EDGE_READ))
82 if (event_mask & (FD_WANT_FAST_WRITE | FD_WANT_EDGE_WRITE))
88 bool SocketEngine::AddFd(EventHandler* eh, int event_mask)
93 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "AddFd out of range: (fd: %d)", fd);
97 if (!SocketEngine::AddFdRef(eh))
99 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "Attempt to add duplicate fd: %d", fd);
103 struct epoll_event ev;
104 memset(&ev, 0, sizeof(ev));
105 ev.events = mask_to_epoll(event_mask);
106 ev.data.ptr = static_cast<void*>(eh);
107 int i = epoll_ctl(EngineHandle, EPOLL_CTL_ADD, fd, &ev);
110 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "Error adding fd: %d to socketengine: %s", fd, strerror(errno));
114 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "New file descriptor: %d", fd);
116 eh->SetEventMask(event_mask);
117 ResizeDouble(events);
122 void SocketEngine::OnSetEvent(EventHandler* eh, int old_mask, int new_mask)
124 unsigned old_events = mask_to_epoll(old_mask);
125 unsigned new_events = mask_to_epoll(new_mask);
126 if (old_events != new_events)
128 // ok, we actually have something to tell the kernel about
129 struct epoll_event ev;
130 memset(&ev, 0, sizeof(ev));
131 ev.events = new_events;
132 ev.data.ptr = static_cast<void*>(eh);
133 epoll_ctl(EngineHandle, EPOLL_CTL_MOD, eh->GetFd(), &ev);
137 void SocketEngine::DelFd(EventHandler* eh)
139 int fd = eh->GetFd();
142 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "DelFd out of range: (fd: %d)", fd);
146 // Do not initialize epoll_event because for EPOLL_CTL_DEL operations the event is ignored and can be NULL.
147 // In kernel versions before 2.6.9, the EPOLL_CTL_DEL operation required a non-NULL pointer in event,
148 // even though this argument is ignored. Since Linux 2.6.9, event can be specified as NULL when using EPOLL_CTL_DEL.
149 struct epoll_event ev;
150 int i = epoll_ctl(EngineHandle, EPOLL_CTL_DEL, fd, &ev);
154 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "epoll_ctl can't remove socket: %s", strerror(errno));
157 SocketEngine::DelFdRef(eh);
159 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "Remove file descriptor: %d", fd);
162 int SocketEngine::DispatchEvents()
164 int i = epoll_wait(EngineHandle, &events[0], events.size(), 1000);
165 ServerInstance->UpdateTime();
167 stats.TotalEvents += i;
169 for (int j = 0; j < i; j++)
171 // Copy these in case the vector gets resized and ev invalidated
172 const epoll_event ev = events[j];
174 EventHandler* const eh = static_cast<EventHandler*>(ev.data.ptr);
175 const int fd = eh->GetFd();
179 if (ev.events & EPOLLHUP)
182 eh->OnEventHandlerError(0);
186 if (ev.events & EPOLLERR)
189 /* Get error number */
190 socklen_t codesize = sizeof(int);
192 if (getsockopt(fd, SOL_SOCKET, SO_ERROR, &errcode, &codesize) < 0)
194 eh->OnEventHandlerError(errcode);
198 int mask = eh->GetEventMask();
199 if (ev.events & EPOLLIN)
200 mask &= ~FD_READ_WILL_BLOCK;
201 if (ev.events & EPOLLOUT)
203 mask &= ~FD_WRITE_WILL_BLOCK;
204 if (mask & FD_WANT_SINGLE_WRITE)
206 int nm = mask & ~FD_WANT_SINGLE_WRITE;
207 OnSetEvent(eh, mask, nm);
211 eh->SetEventMask(mask);
212 if (ev.events & EPOLLIN)
214 eh->OnEventHandlerRead();
215 if (eh != GetRef(fd))
216 // whoa! we got deleted, better not give out the write event
219 if (ev.events & EPOLLOUT)
221 eh->OnEventHandlerWrite();