]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/socketengine.cpp
Relax fd bounds checking
[user/henk/code/inspircd.git] / src / socketengine.cpp
index ceb1090f11dd4579dd0ebf2e23b987beb775630a..c6c520efcd12501212dabdddca8cd930e528076b 100644 (file)
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  Inspire is copyright (C) 2002-2006 ChatSpike-Dev.
- *                       E-mail:
- *                <brain@chatspike.net>
- *                <Craig@chatspike.net>
+ *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2005-2008 Craig Edwards <craigedwards@brainbox.cc>
+ *   Copyright (C) 2007 Burlex <???@???>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
  *
- * Written by Craig Edwards, Craig McLure, and others.
- * 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_config.h"
-#include "globals.h"
+
 #include "inspircd.h"
-#ifdef USE_EPOLL
-#include <sys/epoll.h>
-#endif
-#ifdef USE_KQUEUE
-#include <sys/types.h>
-#include <sys/event.h>
-#include <sys/time.h>
-#endif
-#include <vector>
-#include <string>
-#include "socketengine.h"
 
-char ref[MAX_DESCRIPTORS];
 
-SocketEngine::SocketEngine()
+/** Reference table, contains all current handlers
+ **/
+std::vector<EventHandler*> SocketEngine::ref;
+
+/** Current number of descriptors in the engine
+ */
+size_t SocketEngine::CurrentSetSize = 0;
+
+/** List of handlers that want a trial read/write
+ */
+std::set<int> SocketEngine::trials;
+
+int SocketEngine::MAX_DESCRIPTORS;
+
+/** Socket engine statistics: count of various events, bandwidth usage
+ */
+SocketEngine::Statistics SocketEngine::stats;
+
+EventHandler::EventHandler()
 {
-       log(DEBUG,"SocketEngine::SocketEngine()");
-#ifdef USE_EPOLL
-       EngineHandle = epoll_create(MAX_DESCRIPTORS);
-#endif
-#ifdef USE_KQUEUE
-       EngineHandle = kqueue();
-#endif
-       CurrentSetSize = 0;
+       fd = -1;
+       event_mask = 0;
 }
 
-SocketEngine::~SocketEngine()
+void EventHandler::SetFd(int FD)
 {
-       log(DEBUG,"SocketEngine::~SocketEngine()");
-#ifdef USE_EPOLL
-       close(EngineHandle);
-#endif
-#ifdef USE_KQUEUE
-       close(EngineHandle);
-#endif
+       this->fd = FD;
 }
 
-char SocketEngine::GetType(int fd)
+void SocketEngine::ChangeEventMask(EventHandler* eh, int change)
 {
-       if ((fd < 0) || (fd > MAX_DESCRIPTORS))
-               return X_EMPTY_SLOT;
-       /* Mask off the top bit used for 'read/write' state */
-       return (ref[fd] & ~0x80);
+       int old_m = eh->event_mask;
+       int new_m = old_m;
+
+       // if we are changing read/write type, remove the previously set bit
+       if (change & FD_WANT_READ_MASK)
+               new_m &= ~FD_WANT_READ_MASK;
+       if (change & FD_WANT_WRITE_MASK)
+               new_m &= ~FD_WANT_WRITE_MASK;
+
+       // if adding a trial read/write, insert it into the set
+       if (change & FD_TRIAL_NOTE_MASK && !(old_m & FD_TRIAL_NOTE_MASK))
+               trials.insert(eh->GetFd());
+
+       new_m |= change;
+       if (new_m == old_m)
+               return;
+
+       eh->event_mask = new_m;
+       OnSetEvent(eh, old_m, new_m);
 }
 
-bool SocketEngine::AddFd(int fd, bool readable, char type)
+void SocketEngine::DispatchTrialWrites()
 {
-       if ((fd < 0) || (fd > MAX_DESCRIPTORS))
-               return false;
-       if (GetRemainingFds() <= 1)
+       std::vector<int> working_list;
+       working_list.reserve(trials.size());
+       working_list.assign(trials.begin(), trials.end());
+       trials.clear();
+       for(unsigned int i=0; i < working_list.size(); i++)
        {
-               log(DEFAULT,"ERROR: System out of file descriptors!");
-               return false;
-       }
-#ifdef USE_SELECT
-       fds[fd] = fd;
-#endif
-       ref[fd] = type;
-       if (readable)
-       {
-               log(DEBUG,"Set readbit");
-               ref[fd] |= X_READBIT;
-       }
-       log(DEBUG,"Add socket %d",fd);
-#ifdef USE_EPOLL
-       struct epoll_event ev;
-       log(DEBUG,"epoll: Add socket to events, ep=%d socket=%d",EngineHandle,fd);
-       readable ? ev.events = EPOLLIN | EPOLLET : ev.events = EPOLLOUT | EPOLLET;
-       ev.data.fd = fd;
-       int i = epoll_ctl(EngineHandle, EPOLL_CTL_ADD, fd, &ev);
-       if (i < 0)
-       {
-               log(DEBUG,"epoll: List insertion failure!");
-               return false;
+               int fd = working_list[i];
+               EventHandler* eh = GetRef(fd);
+               if (!eh)
+                       continue;
+               int mask = eh->event_mask;
+               eh->event_mask &= ~(FD_ADD_TRIAL_READ | FD_ADD_TRIAL_WRITE);
+               if ((mask & (FD_ADD_TRIAL_READ | FD_READ_WILL_BLOCK)) == FD_ADD_TRIAL_READ)
+                       eh->HandleEvent(EVENT_READ, 0);
+               if ((mask & (FD_ADD_TRIAL_WRITE | FD_WRITE_WILL_BLOCK)) == FD_ADD_TRIAL_WRITE)
+                       eh->HandleEvent(EVENT_WRITE, 0);
        }
-#endif
-#ifdef USE_KQUEUE
-       struct kevent ke;
-       log(DEBUG,"kqueue: Add socket to events, kq=%d socket=%d",EngineHandle,fd);
-       EV_SET(&ke, fd, readable ? EVFILT_READ : EVFILT_WRITE, EV_ADD, 0, 0, NULL);
-       int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
-       if (i == -1)
-       {
-               log(DEBUG,"kqueue: List insertion failure!");
+}
+
+bool SocketEngine::AddFdRef(EventHandler* eh)
+{
+       int fd = eh->GetFd();
+       if (HasFd(fd))
                return false;
-       }
-#endif
+
+       while (static_cast<unsigned int>(fd) >= ref.size())
+               ref.resize(ref.empty() ? 1 : (ref.size() * 2));
+       ref[fd] = eh;
        CurrentSetSize++;
        return true;
 }
 
-bool SocketEngine::DelFd(int fd)
+void SocketEngine::DelFdRef(EventHandler *eh)
 {
-       log(DEBUG,"SocketEngine::DelFd(%d)",fd);
-
-       if ((fd < 0) || (fd > MAX_DESCRIPTORS))
-               return false;
-
-#ifdef USE_SELECT
-       std::map<int,int>::iterator t = fds.find(fd);
-       if (t != fds.end())
+       int fd = eh->GetFd();
+       if (GetRef(fd) == eh)
        {
-               fds.erase(t);
-               log(DEBUG,"Deleted fd %d",fd);
+               ref[fd] = NULL;
+               CurrentSetSize--;
        }
-#endif
-#ifdef USE_KQUEUE
-       struct kevent ke;
-       EV_SET(&ke, fd, ref[fd] & X_READBIT ? EVFILT_READ : EVFILT_WRITE, EV_DELETE, 0, 0, NULL);
-       int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
-       if (i == -1)
-       {
-               log(DEBUG,"kqueue: Failed to remove socket from queue!");
+}
+
+bool SocketEngine::HasFd(int fd)
+{
+       return GetRef(fd) != NULL;
+}
+
+EventHandler* SocketEngine::GetRef(int fd)
+{
+       if (fd < 0 || static_cast<unsigned int>(fd) >= ref.size())
+               return NULL;
+       return ref[fd];
+}
+
+bool SocketEngine::BoundsCheckFd(EventHandler* eh)
+{
+       if (!eh)
                return false;
-       }
-#endif
-#ifdef USE_EPOLL
-       struct epoll_event ev;
-       ref[fd] && X_READBIT ? ev.events = EPOLLIN | EPOLLET : ev.events = EPOLLOUT | EPOLLET;
-       ev.data.fd = fd;
-       int i = epoll_ctl(EngineHandle, EPOLL_CTL_DEL, fd, &ev);
-       if (i < 0)
-       {
-               log(DEBUG,"epoll: List deletion failure!");
+       if (eh->GetFd() < 0)
                return false;
-       }
-#endif
-       CurrentSetSize--;
-       ref[fd] = 0;
        return true;
 }
 
-int SocketEngine::GetMaxFds()
+
+int SocketEngine::Accept(EventHandler* fd, sockaddr *addr, socklen_t *addrlen)
+{
+       return accept(fd->GetFd(), addr, addrlen);
+}
+
+int SocketEngine::Close(EventHandler* eh)
 {
-#ifdef USE_SELECT
-       return FD_SETSIZE;
-#endif
-#ifdef USE_KQUEUE
-       return MAX_DESCRIPTORS;
-#endif
-#ifdef USE_EPOLL
-       return MAX_DESCRIPTORS;
+       DelFd(eh);
+       int ret = Close(eh->GetFd());
+       eh->SetFd(-1);
+       return ret;
+}
+
+int SocketEngine::Close(int fd)
+{
+#ifdef _WIN32
+       return closesocket(fd);
+#else
+       return close(fd);
 #endif
 }
 
-int SocketEngine::GetRemainingFds()
+int SocketEngine::Blocking(int fd)
 {
-#ifdef USE_SELECT
-       return FD_SETSIZE - CurrentSetSize;
+#ifdef _WIN32
+       unsigned long opt = 0;
+       return ioctlsocket(fd, FIONBIO, &opt);
+#else
+       int flags = fcntl(fd, F_GETFL, 0);
+       return fcntl(fd, F_SETFL, flags & ~O_NONBLOCK);
 #endif
-#ifdef USE_KQUEUE
-       return MAX_DESCRIPTORS - CurrentSetSize;
+}
+
+int SocketEngine::NonBlocking(int fd)
+{
+#ifdef _WIN32
+       unsigned long opt = 1;
+       return ioctlsocket(fd, FIONBIO, &opt);
+#else
+       int flags = fcntl(fd, F_GETFL, 0);
+       return fcntl(fd, F_SETFL, flags | O_NONBLOCK);
 #endif
-#ifdef USE_EPOLL
-       return MAX_DESCRIPTORS - CurrentSetSize;
+}
+
+void SocketEngine::SetReuse(int fd)
+{
+       int on = 1;
+       setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, (char*)&on, sizeof(on));
+}
+
+int SocketEngine::RecvFrom(EventHandler* fd, void *buf, size_t len, int flags, sockaddr *from, socklen_t *fromlen)
+{
+       int nbRecvd = recvfrom(fd->GetFd(), (char*)buf, len, flags, from, fromlen);
+       if (nbRecvd > 0)
+               stats.Update(nbRecvd, 0);
+       return nbRecvd;
+}
+
+int SocketEngine::Send(EventHandler* fd, const void *buf, size_t len, int flags)
+{
+       int nbSent = send(fd->GetFd(), (const char*)buf, len, flags);
+       if (nbSent > 0)
+               stats.Update(0, nbSent);
+       return nbSent;
+}
+
+int SocketEngine::Recv(EventHandler* fd, void *buf, size_t len, int flags)
+{
+       int nbRecvd = recv(fd->GetFd(), (char*)buf, len, flags);
+       if (nbRecvd > 0)
+               stats.Update(nbRecvd, 0);
+       return nbRecvd;
+}
+
+int SocketEngine::SendTo(EventHandler* fd, const void *buf, size_t len, int flags, const sockaddr *to, socklen_t tolen)
+{
+       int nbSent = sendto(fd->GetFd(), (const char*)buf, len, flags, to, tolen);
+       if (nbSent > 0)
+               stats.Update(0, nbSent);
+       return nbSent;
+}
+
+int SocketEngine::Connect(EventHandler* fd, const sockaddr *serv_addr, socklen_t addrlen)
+{
+       int ret = connect(fd->GetFd(), serv_addr, addrlen);
+#ifdef _WIN32
+       if ((ret == SOCKET_ERROR) && (WSAGetLastError() == WSAEWOULDBLOCK))
+               errno = EINPROGRESS;
 #endif
+       return ret;
 }
 
-int SocketEngine::Wait(int* fdlist)
+int SocketEngine::Shutdown(EventHandler* fd, int how)
 {
-       int result = 0;
-#ifdef USE_SELECT
-       FD_ZERO(&wfdset);
-       FD_ZERO(&rfdset);
-       timeval tval;
-       int sresult;
-       for (std::map<int,int>::iterator a = fds.begin(); a != fds.end(); a++)
-       {
-               if (ref[a->second] & X_READBIT)
-               {
-                       FD_SET (a->second, &rfdset);
-               }
-               else
-               {
-                       FD_SET (a->second, &wfdset);
-               }
-               
-       }
-       tval.tv_sec = 0;
-       tval.tv_usec = 100L;
-       sresult = select(FD_SETSIZE, &rfdset, &wfdset, NULL, &tval);
-       if (sresult > 0)
+       return shutdown(fd->GetFd(), how);
+}
+
+int SocketEngine::Bind(int fd, const irc::sockets::sockaddrs& addr)
+{
+       return bind(fd, &addr.sa, addr.sa_size());
+}
+
+int SocketEngine::Listen(int sockfd, int backlog)
+{
+       return listen(sockfd, backlog);
+}
+
+int SocketEngine::Shutdown(int fd, int how)
+{
+       return shutdown(fd, how);
+}
+
+void SocketEngine::Statistics::Update(size_t len_in, size_t len_out)
+{
+       CheckFlush();
+       indata += len_in;
+       outdata += len_out;
+}
+
+void SocketEngine::Statistics::CheckFlush() const
+{
+       // Reset the in/out byte counters if it has been more than a second
+       time_t now = ServerInstance->Time();
+       if (lastempty != now)
        {
-               for (std::map<int,int>::iterator a = fds.begin(); a != fds.end(); a++)
-               {
-                       if ((FD_ISSET (a->second, &rfdset)) || (FD_ISSET (a->second, &wfdset)))
-                               fdlist[result++] = a->second;
-               }
+               lastempty = now;
+               indata = outdata = 0;
        }
-#endif
-#ifdef USE_KQUEUE
-       ts.tv_nsec = 10000L;
-       ts.tv_sec = 0;
-       int i = kevent(EngineHandle, NULL, 0, &ke_list[0], MAX_DESCRIPTORS, &ts);
-       for (int j = 0; j < i; j++)
-               fdlist[result++] = ke_list[j].ident;
-#endif
-#ifdef USE_EPOLL
-       int i = epoll_wait(EngineHandle, events, MAX_DESCRIPTORS, 100);
-       for (int j = 0; j < i; j++)
-               fdlist[result++] = events[j].data.fd;
-#endif
-       return result;
 }
 
-std::string SocketEngine::GetName()
+void SocketEngine::Statistics::GetBandwidth(float& kbitpersec_in, float& kbitpersec_out, float& kbitpersec_total) const
 {
-#ifdef USE_SELECT
-       return "select";
-#endif
-#ifdef USE_KQUEUE
-       return "kqueue";
+       CheckFlush();
+       float in_kbit = indata * 8;
+       float out_kbit = outdata * 8;
+       kbitpersec_total = ((in_kbit + out_kbit) / 1024);
+       kbitpersec_in = in_kbit / 1024;
+       kbitpersec_out = out_kbit / 1024;
+}
+
+std::string SocketEngine::LastError()
+{
+#ifndef _WIN32
+       return strerror(errno);
+#else
+       char szErrorString[500];
+       DWORD dwErrorCode = WSAGetLastError();
+       if (FormatMessageA(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS, NULL, dwErrorCode, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), (LPSTR)szErrorString, _countof(szErrorString), NULL) == 0)
+               sprintf_s(szErrorString, _countof(szErrorString), "Error code: %u", dwErrorCode);
+       return szErrorString;
 #endif
-#ifdef USE_EPOLL
-       return "epoll";
+}
+
+std::string SocketEngine::GetError(int errnum)
+{
+#ifndef _WIN32
+       return strerror(errnum);
+#else
+       WSASetLastError(errnum);
+       return LastError();
 #endif
-       return "misconfigured";
 }