2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2007-2008 Craig Edwards <craigedwards@brainbox.cc>
7 * This file is part of InspIRCd. InspIRCd is free software: you can
8 * redistribute it and/or modify it under the terms of the GNU General Public
9 * License as published by the Free Software Foundation, version 2.
11 * This program is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
13 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 #include "exitcodes.h"
26 #include "socketengine.h"
27 #include <sys/epoll.h>
32 /** A specialisation of the SocketEngine class, designed to use linux 2.6 epoll().
34 class EPollEngine : public SocketEngine
37 /** These are used by epoll() to hold socket events
39 struct epoll_event* events;
42 /** Create a new EPollEngine
45 /** Delete an EPollEngine
47 virtual ~EPollEngine();
48 virtual bool AddFd(EventHandler* eh, int event_mask);
49 virtual void OnSetEvent(EventHandler* eh, int old_mask, int new_mask);
50 virtual void DelFd(EventHandler* eh);
51 virtual int DispatchEvents();
52 virtual std::string GetName();
55 EPollEngine::EPollEngine()
57 int max = ulimit(4, 0);
60 MAX_DESCRIPTORS = max;
64 ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "ERROR: Can't determine maximum number of open sockets!");
65 std::cout << "ERROR: Can't determine maximum number of open sockets!" << std::endl;
66 ServerInstance->QuickExit(EXIT_STATUS_SOCKETENGINE);
69 // This is not a maximum, just a hint at the eventual number of sockets that may be polled.
70 EngineHandle = epoll_create(GetMaxFds() / 4);
72 if (EngineHandle == -1)
74 ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "ERROR: Could not initialize socket engine: %s", strerror(errno));
75 ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "ERROR: Your kernel probably does not have the proper features. This is a fatal error, exiting now.");
76 std::cout << "ERROR: Could not initialize epoll socket engine: " << strerror(errno) << std::endl;
77 std::cout << "ERROR: Your kernel probably does not have the proper features. This is a fatal error, exiting now." << std::endl;
78 ServerInstance->QuickExit(EXIT_STATUS_SOCKETENGINE);
81 ref = new EventHandler* [GetMaxFds()];
82 events = new struct epoll_event[GetMaxFds()];
84 memset(ref, 0, GetMaxFds() * sizeof(EventHandler*));
87 EPollEngine::~EPollEngine()
89 this->Close(EngineHandle);
94 static unsigned mask_to_epoll(int event_mask)
97 if (event_mask & (FD_WANT_POLL_READ | FD_WANT_POLL_WRITE | FD_WANT_SINGLE_WRITE))
99 // we need to use standard polling on this FD
100 if (event_mask & (FD_WANT_POLL_READ | FD_WANT_FAST_READ))
102 if (event_mask & (FD_WANT_POLL_WRITE | FD_WANT_FAST_WRITE | FD_WANT_SINGLE_WRITE))
107 // we can use edge-triggered polling on this FD
109 if (event_mask & (FD_WANT_FAST_READ | FD_WANT_EDGE_READ))
111 if (event_mask & (FD_WANT_FAST_WRITE | FD_WANT_EDGE_WRITE))
117 bool EPollEngine::AddFd(EventHandler* eh, int event_mask)
119 int fd = eh->GetFd();
120 if ((fd < 0) || (fd > GetMaxFds() - 1))
122 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "AddFd out of range: (fd: %d, max: %d)", fd, GetMaxFds());
128 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "Attempt to add duplicate fd: %d", fd);
132 struct epoll_event ev;
133 memset(&ev,0,sizeof(ev));
134 ev.events = mask_to_epoll(event_mask);
136 int i = epoll_ctl(EngineHandle, EPOLL_CTL_ADD, fd, &ev);
139 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "Error adding fd: %d to socketengine: %s", fd, strerror(errno));
143 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "New file descriptor: %d", fd);
146 SocketEngine::SetEventMask(eh, event_mask);
151 void EPollEngine::OnSetEvent(EventHandler* eh, int old_mask, int new_mask)
153 unsigned old_events = mask_to_epoll(old_mask);
154 unsigned new_events = mask_to_epoll(new_mask);
155 if (old_events != new_events)
157 // ok, we actually have something to tell the kernel about
158 struct epoll_event ev;
159 memset(&ev,0,sizeof(ev));
160 ev.events = new_events;
161 ev.data.fd = eh->GetFd();
162 epoll_ctl(EngineHandle, EPOLL_CTL_MOD, eh->GetFd(), &ev);
166 void EPollEngine::DelFd(EventHandler* eh)
168 int fd = eh->GetFd();
169 if ((fd < 0) || (fd > GetMaxFds() - 1))
171 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "DelFd out of range: (fd: %d, max: %d)", fd, GetMaxFds());
175 struct epoll_event ev;
176 memset(&ev,0,sizeof(ev));
178 int i = epoll_ctl(EngineHandle, EPOLL_CTL_DEL, fd, &ev);
182 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "epoll_ctl can't remove socket: %s", strerror(errno));
187 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "Remove file descriptor: %d", fd);
191 int EPollEngine::DispatchEvents()
193 socklen_t codesize = sizeof(int);
195 int i = epoll_wait(EngineHandle, events, GetMaxFds() - 1, 1000);
196 ServerInstance->UpdateTime();
200 for (int j = 0; j < i; j++)
202 EventHandler* eh = ref[events[j].data.fd];
205 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "Got event on unknown fd: %d", events[j].data.fd);
206 epoll_ctl(EngineHandle, EPOLL_CTL_DEL, events[j].data.fd, &events[j]);
209 if (events[j].events & EPOLLHUP)
212 eh->HandleEvent(EVENT_ERROR, 0);
215 if (events[j].events & EPOLLERR)
218 /* Get error number */
219 if (getsockopt(events[j].data.fd, SOL_SOCKET, SO_ERROR, &errcode, &codesize) < 0)
221 eh->HandleEvent(EVENT_ERROR, errcode);
224 int mask = eh->GetEventMask();
225 if (events[j].events & EPOLLIN)
226 mask &= ~FD_READ_WILL_BLOCK;
227 if (events[j].events & EPOLLOUT)
229 mask &= ~FD_WRITE_WILL_BLOCK;
230 if (mask & FD_WANT_SINGLE_WRITE)
232 int nm = mask & ~FD_WANT_SINGLE_WRITE;
233 OnSetEvent(eh, mask, nm);
237 SetEventMask(eh, mask);
238 if (events[j].events & EPOLLIN)
241 eh->HandleEvent(EVENT_READ);
242 if (eh != ref[events[j].data.fd])
243 // whoa! we got deleted, better not give out the write event
246 if (events[j].events & EPOLLOUT)
249 eh->HandleEvent(EVENT_WRITE);
256 std::string EPollEngine::GetName()
261 SocketEngine* CreateSocketEngine()
263 return new EPollEngine;