/*
* InspIRCd -- Internet Relay Chat Daemon
*
* Copyright (C) 2017-2020, 2022 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
* Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
* Copyright (C) 2006-2008 Craig Edwards <brain@inspircd.org>
*
* 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 "exitcodes.h"
#include "inspircd.h"
#include <iostream>
/** 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;
size_t SocketEngine::MaxSetSize = 0;
/** Socket engine statistics: count of various events, bandwidth usage
*/
SocketEngine::Statistics SocketEngine::stats;
EventHandler::EventHandler()
{
fd = -1;
event_mask = 0;
}
void EventHandler::SwapInternals(EventHandler& other)
{
std::swap(fd, other.fd);
std::swap(event_mask, other.event_mask);
}
void EventHandler::SetFd(int FD)
{
this->fd = FD;
}
void EventHandler::OnEventHandlerWrite()
{
}
void EventHandler::OnEventHandlerError(int errornum)
{
}
void SocketEngine::InitError()
{
std::cerr << con_red << "FATAL ERROR!" << con_reset << " Socket engine initialization failed. " << strerror(errno) << '.' << std::endl;
InspIRCd::QuickExit(EXIT_STATUS_SOCKETENGINE);
}
void SocketEngine::LookupMaxFds()
{
#if defined _WIN32
MaxSetSize = FD_SETSIZE;
#else
struct rlimit limits;
if (!getrlimit(RLIMIT_NOFILE, &limits))
MaxSetSize = limits.rlim_cur;
#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
}
void SocketEngine::ChangeEventMask(EventHandler* eh, int change)
{
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);
}
void SocketEngine::DispatchTrialWrites()
{
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();
}
}
bool SocketEngine::AddFdRef(EventHandler* eh)
{
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;
}
void SocketEngine::DelFdRef(EventHandler *eh)
{
int fd = eh->GetFd();
if (GetRef(fd) == eh)
{
ref[fd] = NULL;
CurrentSetSize--;
}
}
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)
{
return eh && eh->HasFd();
}
int SocketEngine::Accept(EventHandler* fd, sockaddr *addr, socklen_t *addrlen)
{
return accept(fd->GetFd(), addr, addrlen);
}
int SocketEngine::Close(EventHandler* eh)
{
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::Blocking(int fd)
{
#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
}
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
}
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);
stats.UpdateReadCounters(nbRecvd);
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);
stats.UpdateWriteCounters(nbSent);
return nbSent;
}
int SocketEngine::Recv(EventHandler* fd, void *buf, size_t len, int 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 irc::sockets::sockaddrs& address)
{
int nbSent = sendto(fd->GetFd(), (const char*)buf, len, flags, &address.sa, address.sa_size());
stats.UpdateWriteCounters(nbSent);
return nbSent;
}
int SocketEngine::WriteV(EventHandler* fd, const IOVector* iovec, int count)
{
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)
{
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::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::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)
{
lastempty = now;
indata = outdata = 0;
}
}
void SocketEngine::Statistics::GetBandwidth(float& kbitpersec_in, float& kbitpersec_out, float& kbitpersec_total) const
{
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
std::string err = GetErrorMessage(WSAGetLastError());
for (size_t pos = 0; ((pos = err.find_first_of("\r\n", pos)) != std::string::npos); )
err[pos] = ' ';
return err;
#endif
}
std::string SocketEngine::GetError(int errnum)
{
#ifndef _WIN32
return strerror(errnum);
#else
WSASetLastError(errnum);
return LastError();
#endif
}