]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/socketengine.cpp
Add support for blocking tag messages with the deaf mode.
[user/henk/code/inspircd.git] / src / socketengine.cpp
index 74f8c18617a464b667430ba3fa46513d12d283a8..9186f2c8c9ce88b78b0314a6357ccf763c39fcd0 100644 (file)
@@ -1,70 +1,64 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *   Copyright (C) 2017-2020 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2013-2014 Adam <Adam@anope.org>
+ *   Copyright (C) 2012, 2014-2015 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2012 ChrisTX <xpipe@hotmail.de>
+ *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2008, 2017 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2007 burlex <burlex@e03df62e-2008-0410-955e-edbf42e46eb7>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2006-2008, 2010 Craig Edwards <brain@inspircd.org>
  *
- * 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/>.
  */
 
-/* $Core */
-
-/*********        DEFAULTS       **********/
-
-/* $ExtraSources: socketengines/socketengine_select.cpp */
-/* $ExtraObjects: socketengine_select.o */
-
-/* $If: USE_POLL */
-/* $ExtraSources: socketengines/socketengine_poll.cpp */
-/* $ExtraObjects: socketengine_poll.o */
-/* $EndIf */
-
-/* $If: USE_KQUEUE */
-/* $ExtraSources: socketengines/socketengine_kqueue.cpp */
-/* $ExtraObjects: socketengine_kqueue.o */
-/* $EndIf */
 
-/* $If: USE_EPOLL */
-/* $ExtraSources: socketengines/socketengine_epoll.cpp */
-/* $ExtraObjects: socketengine_epoll.o */
-/* $EndIf */
+#include "exitcodes.h"
+#include "inspircd.h"
 
-/* $If: USE_PORTS */
-/* $ExtraSources: socketengines/socketengine_ports.cpp */
-/* $ExtraObjects: socketengine_ports.o */
-/* $EndIf */
+#include <iostream>
 
-#include "inspircd.h"
-#include "socketengine.h"
+/** Reference table, contains all current handlers
+ **/
+std::vector<EventHandler*> SocketEngine::ref;
 
-bool EventHandler::AddIOHook(Module *IOHooker)
-{
-       if (this->IOHook)
-               return false;
+/** Current number of descriptors in the engine
+ */
+size_t SocketEngine::CurrentSetSize = 0;
 
-       this->IOHook = IOHooker;
-}
+/** List of handlers that want a trial read/write
+ */
+std::set<int> SocketEngine::trials;
 
-bool EventHandler::DelIOHook()
-{
-       if (!this->IOHook)
-               return false
+size_t SocketEngine::MaxSetSize = 0;
 
-       this->IOHook = false;
-}
+/** Socket engine statistics: count of various events, bandwidth usage
+ */
+SocketEngine::Statistics SocketEngine::stats;
 
-Module *EventHandler::GetIOHook()
+EventHandler::EventHandler()
 {
-       return this->IOHook;
+       fd = -1;
+       event_mask = 0;
 }
 
-int EventHandler::GetFd()
+void EventHandler::SwapInternals(EventHandler& other)
 {
-       return this->fd;
+       std::swap(fd, other.fd);
+       std::swap(event_mask, other.event_mask);
 }
 
 void EventHandler::SetFd(int FD)
@@ -72,82 +66,121 @@ void EventHandler::SetFd(int FD)
        this->fd = FD;
 }
 
-bool EventHandler::Readable()
+void EventHandler::OnEventHandlerWrite()
 {
-       return true;
 }
 
-bool EventHandler::Writeable()
+void EventHandler::OnEventHandlerError(int errornum)
 {
-       return false;
 }
 
-void SocketEngine::WantWrite(EventHandler* eh)
+void SocketEngine::InitError()
 {
+       std::cerr << con_red << "FATAL ERROR!" << con_reset << " Socket engine initialization failed. " << strerror(errno) << '.' << std::endl;
+       exit(EXIT_STATUS_SOCKETENGINE);
 }
 
-SocketEngine::SocketEngine(InspIRCd* Instance) : ServerInstance(Instance)
+void SocketEngine::LookupMaxFds()
 {
-       TotalEvents = WriteEvents = ReadEvents = ErrorEvents = 0;
-       lastempty = time(NULL);
-       indata = outdata = 0;
-}
+#if defined _WIN32
+       MaxSetSize = FD_SETSIZE;
+#else
+       struct rlimit limits;
+       if (!getrlimit(RLIMIT_NOFILE, &limits))
+               MaxSetSize = limits.rlim_cur;
 
-SocketEngine::~SocketEngine()
-{
+#if defined __APPLE__
+       limits.rlim_cur = limits.rlim_max == RLIM_INFINITY ? OPEN_MAX : limits.rlim_max;
+#else
+       limits.rlim_cur = limits.rlim_max;
+#endif
+       if (!setrlimit(RLIMIT_NOFILE, &limits))
+               MaxSetSize = limits.rlim_cur;
+#endif
 }
 
-bool SocketEngine::AddFd(EventHandler* eh)
+void SocketEngine::ChangeEventMask(EventHandler* eh, int change)
 {
-       return true;
-}
+       int old_m = eh->event_mask;
+       int new_m = old_m;
 
-bool SocketEngine::HasFd(int fd)
-{
-       if ((fd < 0) || (fd > MAX_DESCRIPTORS))
-               return false;
-       return ref[fd];
-}
+       // 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;
 
-EventHandler* SocketEngine::GetRef(int fd)
-{
-       if ((fd < 0) || (fd > MAX_DESCRIPTORS))
-               return 0;
-       return ref[fd];
+       // 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::DelFd(EventHandler* eh, bool force)
+void SocketEngine::DispatchTrialWrites()
 {
-       return true;
+       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++)
+       {
+               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->OnEventHandlerRead();
+               if ((mask & (FD_ADD_TRIAL_WRITE | FD_WRITE_WILL_BLOCK)) == FD_ADD_TRIAL_WRITE)
+                       eh->OnEventHandlerWrite();
+       }
 }
 
-int SocketEngine::GetMaxFds()
+bool SocketEngine::AddFdRef(EventHandler* eh)
 {
-       return 0;
+       int fd = eh->GetFd();
+       if (HasFd(fd))
+               return false;
+
+       while (static_cast<unsigned int>(fd) >= ref.size())
+               ref.resize(ref.empty() ? 1 : (ref.size() * 2));
+       ref[fd] = eh;
+       CurrentSetSize++;
+       return true;
 }
 
-int SocketEngine::GetRemainingFds()
+void SocketEngine::DelFdRef(EventHandler *eh)
 {
-       return 0;
+       int fd = eh->GetFd();
+       if (GetRef(fd) == eh)
+       {
+               ref[fd] = NULL;
+               CurrentSetSize--;
+       }
 }
 
-int SocketEngine::DispatchEvents()
+bool SocketEngine::HasFd(int fd)
 {
-       return 0;
+       return GetRef(fd) != NULL;
 }
 
-std::string SocketEngine::GetName()
+EventHandler* SocketEngine::GetRef(int fd)
 {
-       return "misconfigured";
+       if (fd < 0 || static_cast<unsigned int>(fd) >= ref.size())
+               return NULL;
+       return ref[fd];
 }
 
 bool SocketEngine::BoundsCheckFd(EventHandler* eh)
-{       
-       if (!eh)
-               return false;
-       if ((eh->GetFd() < 0) || (eh->GetFd() > MAX_DESCRIPTORS))
-               return false;
-       return true;
+{
+       return eh && eh->HasFd();
 }
 
 
@@ -156,18 +189,17 @@ int SocketEngine::Accept(EventHandler* fd, sockaddr *addr, socklen_t *addrlen)
        return accept(fd->GetFd(), addr, addrlen);
 }
 
-int SocketEngine::Close(EventHandler* fd)
+int SocketEngine::Close(EventHandler* eh)
 {
-#ifdef WINDOWS
-       return closesocket(fd->GetFd());
-#else
-       return close(fd->GetFd());
-#endif
+       DelFd(eh);
+       int ret = Close(eh->GetFd());
+       eh->SetFd(-1);
+       return ret;
 }
 
 int SocketEngine::Close(int fd)
 {
-#ifdef WINDOWS
+#ifdef _WIN32
        return closesocket(fd);
 #else
        return close(fd);
@@ -176,18 +208,18 @@ int SocketEngine::Close(int fd)
 
 int SocketEngine::Blocking(int fd)
 {
-#ifdef WINDOWS
+#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);
+       return fcntl(fd, F_SETFL, flags & ~O_NONBLOCK);
 #endif
 }
 
 int SocketEngine::NonBlocking(int fd)
 {
-#ifdef WINDOWS
+#ifdef _WIN32
        unsigned long opt = 1;
        return ioctlsocket(fd, FIONBIO, &opt);
 #else
@@ -196,38 +228,74 @@ int SocketEngine::NonBlocking(int fd)
 #endif
 }
 
-int SocketEngine::GetSockName(EventHandler* fd, sockaddr *name, socklen_t* namelen)
+void SocketEngine::SetReuse(int fd)
 {
-       return getsockname(fd->GetFd(), name, namelen);
+       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)
 {
-       this->UpdateStats(len, 0);
-       return recvfrom(fd->GetFd(), (char*)buf, len, flags, from, fromlen);
+       int nbRecvd = recvfrom(fd->GetFd(), (char*)buf, len, flags, from, fromlen);
+       stats.UpdateReadCounters(nbRecvd);
+       return nbRecvd;
 }
 
 int SocketEngine::Send(EventHandler* fd, const void *buf, size_t len, int flags)
 {
-       this->UpdateStats(0, len);
-       return send(fd->GetFd(), (const char*)buf, len, flags);
+       int nbSent = send(fd->GetFd(), (const char*)buf, len, flags);
+       stats.UpdateWriteCounters(nbSent);
+       return nbSent;
 }
 
 int SocketEngine::Recv(EventHandler* fd, void *buf, size_t len, int flags)
 {
-       this->UpdateStats(len, 0);
-       return recv(fd->GetFd(), (char*)buf, len, flags);
+       int nbRecvd = recv(fd->GetFd(), (char*)buf, len, flags);
+       stats.UpdateReadCounters(nbRecvd);
+       return nbRecvd;
 }
 
-int SocketEngine::SendTo(EventHandler* fd, const void *buf, size_t len, int flags, const sockaddr *to, socklen_t tolen)
+int SocketEngine::SendTo(EventHandler* fd, const void* buf, size_t len, int flags, const irc::sockets::sockaddrs& address)
 {
-       this->UpdateStats(0, len);
-       return sendto(fd->GetFd(), (const char*)buf, len, flags, to, tolen);
+       int nbSent = sendto(fd->GetFd(), (const char*)buf, len, flags, &address.sa, address.sa_size());
+       stats.UpdateWriteCounters(nbSent);
+       return nbSent;
 }
 
-int SocketEngine::Connect(EventHandler* fd, const sockaddr *serv_addr, socklen_t addrlen)
+int SocketEngine::WriteV(EventHandler* fd, const IOVector* iovec, int count)
 {
-       return connect(fd->GetFd(), serv_addr, addrlen);
+       int sent = writev(fd->GetFd(), iovec, count);
+       stats.UpdateWriteCounters(sent);
+       return sent;
+}
+
+#ifdef _WIN32
+int SocketEngine::WriteV(EventHandler* fd, const iovec* iovec, int count)
+{
+       // On Windows the fields in iovec are not in the order required by the Winsock API; IOVector has
+       // the fields in the correct order.
+       // Create temporary IOVectors from the iovecs and pass them to the WriteV() method that accepts the
+       // platform's native struct.
+       IOVector wiovec[128];
+       count = std::min(count, static_cast<int>(sizeof(wiovec) / sizeof(IOVector)));
+
+       for (int i = 0; i < count; i++)
+       {
+               wiovec[i].iov_len = iovec[i].iov_len;
+               wiovec[i].iov_base = reinterpret_cast<char*>(iovec[i].iov_base);
+       }
+       return WriteV(fd, wiovec, count);
+}
+#endif
+
+int SocketEngine::Connect(EventHandler* fd, const irc::sockets::sockaddrs& address)
+{
+       int ret = connect(fd->GetFd(), &address.sa, address.sa_size());
+#ifdef _WIN32
+       if ((ret == SOCKET_ERROR) && (WSAGetLastError() == WSAEWOULDBLOCK))
+               errno = EINPROGRESS;
+#endif
+       return ret;
 }
 
 int SocketEngine::Shutdown(EventHandler* fd, int how)
@@ -235,9 +303,9 @@ int SocketEngine::Shutdown(EventHandler* fd, int how)
        return shutdown(fd->GetFd(), how);
 }
 
-int SocketEngine::Bind(int fd, const sockaddr *my_addr, socklen_t addrlen)
+int SocketEngine::Bind(int fd, const irc::sockets::sockaddrs& addr)
 {
-       return bind(fd, my_addr, addrlen);
+       return bind(fd, &addr.sa, addr.sa_size());
 }
 
 int SocketEngine::Listen(int sockfd, int backlog)
@@ -250,27 +318,74 @@ int SocketEngine::Shutdown(int fd, int how)
        return shutdown(fd, how);
 }
 
-void SocketEngine::RecoverFromFork()
+void SocketEngine::Statistics::UpdateReadCounters(int len_in)
+{
+       CheckFlush();
+
+       ReadEvents++;
+       if (len_in > 0)
+               indata += len_in;
+       else if (len_in < 0)
+               ErrorEvents++;
+}
+
+void SocketEngine::Statistics::UpdateWriteCounters(int len_out)
 {
+       CheckFlush();
+
+       WriteEvents++;
+       if (len_out > 0)
+               outdata += len_out;
+       else if (len_out < 0)
+               ErrorEvents++;
 }
 
-void SocketEngine::UpdateStats(size_t len_in, size_t len_out)
+void SocketEngine::Statistics::CheckFlush() const
 {
-       if (lastempty != time(NULL))
+       // Reset the in/out byte counters if it has been more than a second
+       time_t now = ServerInstance->Time();
+       if (lastempty != now)
        {
-               lastempty = time(NULL);
+               lastempty = now;
                indata = outdata = 0;
        }
-       indata += len_in;
-       outdata += len_out;
 }
 
-void SocketEngine::GetStats(float &kbitpersec_in, float &kbitpersec_out, float &kbitpersec_total)
+void SocketEngine::Statistics::GetBandwidth(float& kbitpersec_in, float& kbitpersec_out, float& kbitpersec_total) const
 {
-       UpdateStats(0, 0); /* Forces emptying of the values if its been more than a second */
+       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);
+
+       std::string::size_type p;
+       std::string ret = szErrorString;
+       while ((p = ret.find_last_of("\r\n")) != std::string::npos)
+               ret.erase(p, 1);
+
+       return ret;
+#endif
+}
+
+std::string SocketEngine::GetError(int errnum)
+{
+#ifndef _WIN32
+       return strerror(errnum);
+#else
+       WSASetLastError(errnum);
+       return LastError();
+#endif
+}