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>
31 /** A specialisation of the SocketEngine class, designed to use linux 2.6 epoll().
33 class EPollEngine : public SocketEngine
36 /** These are used by epoll() to hold socket events
38 struct epoll_event* events;
41 /** Create a new EPollEngine
44 /** Delete an EPollEngine
46 virtual ~EPollEngine();
47 virtual bool AddFd(EventHandler* eh, int event_mask);
48 virtual void OnSetEvent(EventHandler* eh, int old_mask, int new_mask);
49 virtual void DelFd(EventHandler* eh);
50 virtual int DispatchEvents();
51 virtual std::string GetName();
54 EPollEngine::EPollEngine()
56 int max = ulimit(4, 0);
59 MAX_DESCRIPTORS = max;
63 ServerInstance->Logs->Log("SOCKET", DEFAULT, "ERROR: Can't determine maximum number of open sockets!");
64 printf("ERROR: Can't determine maximum number of open sockets!\n");
65 ServerInstance->Exit(EXIT_STATUS_SOCKETENGINE);
68 // This is not a maximum, just a hint at the eventual number of sockets that may be polled.
69 EngineHandle = epoll_create(GetMaxFds() / 4);
71 if (EngineHandle == -1)
73 ServerInstance->Logs->Log("SOCKET",DEFAULT, "ERROR: Could not initialize socket engine: %s", strerror(errno));
74 ServerInstance->Logs->Log("SOCKET",DEFAULT, "ERROR: Your kernel probably does not have the proper features. This is a fatal error, exiting now.");
75 printf("ERROR: Could not initialize epoll socket engine: %s\n", strerror(errno));
76 printf("ERROR: Your kernel probably does not have the proper features. This is a fatal error, exiting now.\n");
77 ServerInstance->Exit(EXIT_STATUS_SOCKETENGINE);
80 ref = new EventHandler* [GetMaxFds()];
81 events = new struct epoll_event[GetMaxFds()];
83 memset(ref, 0, GetMaxFds() * sizeof(EventHandler*));
86 EPollEngine::~EPollEngine()
88 this->Close(EngineHandle);
93 static int mask_to_epoll(int event_mask)
96 if (event_mask & (FD_WANT_POLL_READ | FD_WANT_POLL_WRITE | FD_WANT_SINGLE_WRITE))
98 // we need to use standard polling on this FD
99 if (event_mask & (FD_WANT_POLL_READ | FD_WANT_FAST_READ))
101 if (event_mask & (FD_WANT_POLL_WRITE | FD_WANT_FAST_WRITE | FD_WANT_SINGLE_WRITE))
106 // we can use edge-triggered polling on this FD
108 if (event_mask & (FD_WANT_FAST_READ | FD_WANT_EDGE_READ))
110 if (event_mask & (FD_WANT_FAST_WRITE | FD_WANT_EDGE_WRITE))
116 bool EPollEngine::AddFd(EventHandler* eh, int event_mask)
118 int fd = eh->GetFd();
119 if ((fd < 0) || (fd > GetMaxFds() - 1))
121 ServerInstance->Logs->Log("SOCKET",DEBUG,"AddFd out of range: (fd: %d, max: %d)", fd, GetMaxFds());
127 ServerInstance->Logs->Log("SOCKET",DEBUG,"Attempt to add duplicate fd: %d", fd);
131 struct epoll_event ev;
132 memset(&ev,0,sizeof(ev));
133 ev.events = mask_to_epoll(event_mask);
135 int i = epoll_ctl(EngineHandle, EPOLL_CTL_ADD, fd, &ev);
138 ServerInstance->Logs->Log("SOCKET",DEBUG,"Error adding fd: %d to socketengine: %s", fd, strerror(errno));
142 ServerInstance->Logs->Log("SOCKET",DEBUG,"New file descriptor: %d", fd);
145 SocketEngine::SetEventMask(eh, event_mask);
150 void EPollEngine::OnSetEvent(EventHandler* eh, int old_mask, int new_mask)
152 int old_events = mask_to_epoll(old_mask);
153 int new_events = mask_to_epoll(new_mask);
154 if (old_events != new_events)
156 // ok, we actually have something to tell the kernel about
157 struct epoll_event ev;
158 memset(&ev,0,sizeof(ev));
159 ev.events = new_events;
160 ev.data.fd = eh->GetFd();
161 epoll_ctl(EngineHandle, EPOLL_CTL_MOD, eh->GetFd(), &ev);
165 void EPollEngine::DelFd(EventHandler* eh)
167 int fd = eh->GetFd();
168 if ((fd < 0) || (fd > GetMaxFds() - 1))
170 ServerInstance->Logs->Log("SOCKET",DEBUG,"DelFd out of range: (fd: %d, max: %d)", fd, GetMaxFds());
174 struct epoll_event ev;
175 memset(&ev,0,sizeof(ev));
177 int i = epoll_ctl(EngineHandle, EPOLL_CTL_DEL, fd, &ev);
181 ServerInstance->Logs->Log("SOCKET",DEBUG,"epoll_ctl can't remove socket: %s", strerror(errno));
186 ServerInstance->Logs->Log("SOCKET",DEBUG,"Remove file descriptor: %d", fd);
190 int EPollEngine::DispatchEvents()
192 socklen_t codesize = sizeof(int);
194 int i = epoll_wait(EngineHandle, events, GetMaxFds() - 1, 1000);
195 ServerInstance->UpdateTime();
199 for (int j = 0; j < i; j++)
201 EventHandler* eh = ref[events[j].data.fd];
204 ServerInstance->Logs->Log("SOCKET",DEBUG,"Got event on unknown fd: %d", events[j].data.fd);
205 epoll_ctl(EngineHandle, EPOLL_CTL_DEL, events[j].data.fd, &events[j]);
208 if (events[j].events & EPOLLHUP)
211 eh->HandleEvent(EVENT_ERROR, 0);
214 if (events[j].events & EPOLLERR)
217 /* Get error number */
218 if (getsockopt(events[j].data.fd, SOL_SOCKET, SO_ERROR, &errcode, &codesize) < 0)
220 eh->HandleEvent(EVENT_ERROR, errcode);
223 int mask = eh->GetEventMask();
224 if (events[j].events & EPOLLIN)
225 mask &= ~FD_READ_WILL_BLOCK;
226 if (events[j].events & EPOLLOUT)
228 mask &= ~FD_WRITE_WILL_BLOCK;
229 if (mask & FD_WANT_SINGLE_WRITE)
231 int nm = mask & ~FD_WANT_SINGLE_WRITE;
232 OnSetEvent(eh, mask, nm);
236 SetEventMask(eh, mask);
237 if (events[j].events & EPOLLIN)
240 eh->HandleEvent(EVENT_READ);
241 if (eh != ref[events[j].data.fd])
242 // whoa! we got deleted, better not give out the write event
245 if (events[j].events & EPOLLOUT)
248 eh->HandleEvent(EVENT_WRITE);
255 std::string EPollEngine::GetName()
260 SocketEngine* CreateSocketEngine()
262 return new EPollEngine;