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()
58 int max = ulimit(4, 0);
61 MAX_DESCRIPTORS = max;
65 ServerInstance->Logs->Log("SOCKET", DEFAULT, "ERROR: Can't determine maximum number of open sockets!");
66 std::cout << "ERROR: Can't determine maximum number of open sockets!" << std::endl;
67 ServerInstance->QuickExit(EXIT_STATUS_SOCKETENGINE);
70 // This is not a maximum, just a hint at the eventual number of sockets that may be polled.
71 EngineHandle = epoll_create(GetMaxFds() / 4);
73 if (EngineHandle == -1)
75 ServerInstance->Logs->Log("SOCKET",DEFAULT, "ERROR: Could not initialize socket engine: %s", strerror(errno));
76 ServerInstance->Logs->Log("SOCKET",DEFAULT, "ERROR: Your kernel probably does not have the proper features. This is a fatal error, exiting now.");
77 std::cout << "ERROR: Could not initialize epoll socket engine: " << strerror(errno) << std::endl;
78 std::cout << "ERROR: Your kernel probably does not have the proper features. This is a fatal error, exiting now." << std::endl;
79 ServerInstance->QuickExit(EXIT_STATUS_SOCKETENGINE);
82 ref = new EventHandler* [GetMaxFds()];
83 events = new struct epoll_event[GetMaxFds()];
85 memset(ref, 0, GetMaxFds() * sizeof(EventHandler*));
88 EPollEngine::~EPollEngine()
90 this->Close(EngineHandle);
95 static unsigned mask_to_epoll(int event_mask)
98 if (event_mask & (FD_WANT_POLL_READ | FD_WANT_POLL_WRITE | FD_WANT_SINGLE_WRITE))
100 // we need to use standard polling on this FD
101 if (event_mask & (FD_WANT_POLL_READ | FD_WANT_FAST_READ))
103 if (event_mask & (FD_WANT_POLL_WRITE | FD_WANT_FAST_WRITE | FD_WANT_SINGLE_WRITE))
108 // we can use edge-triggered polling on this FD
110 if (event_mask & (FD_WANT_FAST_READ | FD_WANT_EDGE_READ))
112 if (event_mask & (FD_WANT_FAST_WRITE | FD_WANT_EDGE_WRITE))
118 bool EPollEngine::AddFd(EventHandler* eh, int event_mask)
120 int fd = eh->GetFd();
121 if ((fd < 0) || (fd > GetMaxFds() - 1))
123 ServerInstance->Logs->Log("SOCKET",DEBUG,"AddFd out of range: (fd: %d, max: %d)", fd, GetMaxFds());
129 ServerInstance->Logs->Log("SOCKET",DEBUG,"Attempt to add duplicate fd: %d", fd);
133 struct epoll_event ev;
134 memset(&ev,0,sizeof(ev));
135 ev.events = mask_to_epoll(event_mask);
137 int i = epoll_ctl(EngineHandle, EPOLL_CTL_ADD, fd, &ev);
140 ServerInstance->Logs->Log("SOCKET",DEBUG,"Error adding fd: %d to socketengine: %s", fd, strerror(errno));
144 ServerInstance->Logs->Log("SOCKET",DEBUG,"New file descriptor: %d", fd);
147 SocketEngine::SetEventMask(eh, event_mask);
152 void EPollEngine::OnSetEvent(EventHandler* eh, int old_mask, int new_mask)
154 unsigned old_events = mask_to_epoll(old_mask);
155 unsigned new_events = mask_to_epoll(new_mask);
156 if (old_events != new_events)
158 // ok, we actually have something to tell the kernel about
159 struct epoll_event ev;
160 memset(&ev,0,sizeof(ev));
161 ev.events = new_events;
162 ev.data.fd = eh->GetFd();
163 epoll_ctl(EngineHandle, EPOLL_CTL_MOD, eh->GetFd(), &ev);
167 void EPollEngine::DelFd(EventHandler* eh)
169 int fd = eh->GetFd();
170 if ((fd < 0) || (fd > GetMaxFds() - 1))
172 ServerInstance->Logs->Log("SOCKET",DEBUG,"DelFd out of range: (fd: %d, max: %d)", fd, GetMaxFds());
176 struct epoll_event ev;
177 memset(&ev,0,sizeof(ev));
179 int i = epoll_ctl(EngineHandle, EPOLL_CTL_DEL, fd, &ev);
183 ServerInstance->Logs->Log("SOCKET",DEBUG,"epoll_ctl can't remove socket: %s", strerror(errno));
188 ServerInstance->Logs->Log("SOCKET",DEBUG,"Remove file descriptor: %d", fd);
192 int EPollEngine::DispatchEvents()
194 socklen_t codesize = sizeof(int);
196 int i = epoll_wait(EngineHandle, events, GetMaxFds() - 1, 1000);
197 ServerInstance->UpdateTime();
201 for (int j = 0; j < i; j++)
203 EventHandler* eh = ref[events[j].data.fd];
206 ServerInstance->Logs->Log("SOCKET",DEBUG,"Got event on unknown fd: %d", events[j].data.fd);
207 epoll_ctl(EngineHandle, EPOLL_CTL_DEL, events[j].data.fd, &events[j]);
210 if (events[j].events & EPOLLHUP)
213 eh->HandleEvent(EVENT_ERROR, 0);
216 if (events[j].events & EPOLLERR)
219 /* Get error number */
220 if (getsockopt(events[j].data.fd, SOL_SOCKET, SO_ERROR, &errcode, &codesize) < 0)
222 eh->HandleEvent(EVENT_ERROR, errcode);
225 int mask = eh->GetEventMask();
226 if (events[j].events & EPOLLIN)
227 mask &= ~FD_READ_WILL_BLOCK;
228 if (events[j].events & EPOLLOUT)
230 mask &= ~FD_WRITE_WILL_BLOCK;
231 if (mask & FD_WANT_SINGLE_WRITE)
233 int nm = mask & ~FD_WANT_SINGLE_WRITE;
234 OnSetEvent(eh, mask, nm);
238 SetEventMask(eh, mask);
239 if (events[j].events & EPOLLIN)
242 eh->HandleEvent(EVENT_READ);
243 if (eh != ref[events[j].data.fd])
244 // whoa! we got deleted, better not give out the write event
247 if (events[j].events & EPOLLOUT)
250 eh->HandleEvent(EVENT_WRITE);
257 std::string EPollEngine::GetName()
262 SocketEngine* CreateSocketEngine()
264 return new EPollEngine;