src/inspsocket.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2007-2009 Robin Burchell <robin+git@viroteck.net>
   6  *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
   7  *   Copyright (C) 2006-2007 Craig Edwards <craigedwards@brainbox.cc>
   8  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
   9  *   Copyright (C) 2006 Oliver Lupton <oliverlupton@gmail.com>
  10  *
  11  * This file is part of InspIRCd.  InspIRCd is free software: you can
  12  * redistribute it and/or modify it under the terms of the GNU General Public
  13  * License as published by the Free Software Foundation, version 2.
  14  *
  15  * This program is distributed in the hope that it will be useful, but WITHOUT
  16  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  18  * details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  */
  23
  24
  25 #include "inspircd.h"
  26 #include "iohook.h"
  27
  28 BufferedSocket::BufferedSocket()
  29 {
  30         Timeout = NULL;
  31         state = I_ERROR;
  32 }
  33
  34 BufferedSocket::BufferedSocket(int newfd)
  35 {
  36         Timeout = NULL;
  37         this->fd = newfd;
  38         this->state = I_CONNECTED;
  39         if (fd > -1)
  40                 SocketEngine::AddFd(this, FD_WANT_FAST_READ | FD_WANT_EDGE_WRITE);
  41 }
  42
  43 void BufferedSocket::DoConnect(const std::string &ipaddr, int aport, unsigned long maxtime, const std::string &connectbindip)
  44 {
  45         BufferedSocketError err = BeginConnect(ipaddr, aport, maxtime, connectbindip);
  46         if (err != I_ERR_NONE)
  47         {
  48                 state = I_ERROR;
  49                 SetError(SocketEngine::LastError());
  50                 OnError(err);
  51         }
  52 }
  53
  54 BufferedSocketError BufferedSocket::BeginConnect(const std::string &ipaddr, int aport, unsigned long maxtime, const std::string &connectbindip)
  55 {
  56         irc::sockets::sockaddrs addr, bind;
  57         if (!irc::sockets::aptosa(ipaddr, aport, addr))
  58         {
  59                 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "BUG: Hostname passed to BufferedSocket, rather than an IP address!");
  60                 return I_ERR_CONNECT;
  61         }
  62
  63         bind.sa.sa_family = 0;
  64         if (!connectbindip.empty())
  65         {
  66                 if (!irc::sockets::aptosa(connectbindip, 0, bind))
  67                 {
  68                         return I_ERR_BIND;
  69                 }
  70         }
  71
  72         return BeginConnect(addr, bind, maxtime);
  73 }
  74
  75 BufferedSocketError BufferedSocket::BeginConnect(const irc::sockets::sockaddrs& dest, const irc::sockets::sockaddrs& bind, unsigned long timeout)
  76 {
  77         if (fd < 0)
  78                 fd = socket(dest.sa.sa_family, SOCK_STREAM, 0);
  79
  80         if (fd < 0)
  81                 return I_ERR_SOCKET;
  82
  83         if (bind.sa.sa_family != 0)
  84         {
  85                 if (SocketEngine::Bind(fd, bind) < 0)
  86                         return I_ERR_BIND;
  87         }
  88
  89         SocketEngine::NonBlocking(fd);
  90
  91         if (SocketEngine::Connect(this, &dest.sa, dest.sa_size()) == -1)
  92         {
  93                 if (errno != EINPROGRESS)
  94                         return I_ERR_CONNECT;
  95         }
  96
  97         this->state = I_CONNECTING;
  98
  99         if (!SocketEngine::AddFd(this, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE | FD_WRITE_WILL_BLOCK))
 100                 return I_ERR_NOMOREFDS;
 101
 102         this->Timeout = new SocketTimeout(this->GetFd(), this, timeout);
 103         ServerInstance->Timers.AddTimer(this->Timeout);
 104
 105         ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "BufferedSocket::DoConnect success");
 106         return I_ERR_NONE;
 107 }
 108
 109 void StreamSocket::Close()
 110 {
 111         if (this->fd > -1)
 112         {
 113                 // final chance, dump as much of the sendq as we can
 114                 DoWrite();
 115                 if (GetIOHook())
 116                 {
 117                         GetIOHook()->OnStreamSocketClose(this);
 118                         delete iohook;
 119                         DelIOHook();
 120                 }
 121                 SocketEngine::Shutdown(this, 2);
 122                 SocketEngine::Close(this);
 123         }
 124 }
 125
 126 CullResult StreamSocket::cull()
 127 {
 128         Close();
 129         return EventHandler::cull();
 130 }
 131
 132 bool StreamSocket::GetNextLine(std::string& line, char delim)
 133 {
 134         std::string::size_type i = recvq.find(delim);
 135         if (i == std::string::npos)
 136                 return false;
 137         line.assign(recvq, 0, i);
 138         recvq.erase(0, i + 1);
 139         return true;
 140 }
 141
 142 void StreamSocket::DoRead()
 143 {
 144         if (GetIOHook())
 145         {
 146                 int rv = GetIOHook()->OnStreamSocketRead(this, recvq);
 147                 if (rv > 0)
 148                         OnDataReady();
 149                 if (rv < 0)
 150                         SetError("Read Error"); // will not overwrite a better error message
 151         }
 152         else
 153         {
 154                 char* ReadBuffer = ServerInstance->GetReadBuffer();
 155                 int n = SocketEngine::Recv(this, ReadBuffer, ServerInstance->Config->NetBufferSize, 0);
 156                 if (n == ServerInstance->Config->NetBufferSize)
 157                 {
 158                         SocketEngine::ChangeEventMask(this, FD_WANT_FAST_READ | FD_ADD_TRIAL_READ);
 159                         recvq.append(ReadBuffer, n);
 160                         OnDataReady();
 161                 }
 162                 else if (n > 0)
 163                 {
 164                         SocketEngine::ChangeEventMask(this, FD_WANT_FAST_READ);
 165                         recvq.append(ReadBuffer, n);
 166                         OnDataReady();
 167                 }
 168                 else if (n == 0)
 169                 {
 170                         error = "Connection closed";
 171                         SocketEngine::ChangeEventMask(this, FD_WANT_NO_READ | FD_WANT_NO_WRITE);
 172                 }
 173                 else if (SocketEngine::IgnoreError())
 174                 {
 175                         SocketEngine::ChangeEventMask(this, FD_WANT_FAST_READ | FD_READ_WILL_BLOCK);
 176                 }
 177                 else if (errno == EINTR)
 178                 {
 179                         SocketEngine::ChangeEventMask(this, FD_WANT_FAST_READ | FD_ADD_TRIAL_READ);
 180                 }
 181                 else
 182                 {
 183                         error = SocketEngine::LastError();
 184                         SocketEngine::ChangeEventMask(this, FD_WANT_NO_READ | FD_WANT_NO_WRITE);
 185                 }
 186         }
 187 }
 188
 189 /* Don't try to prepare huge blobs of data to send to a blocked socket */
 190 static const int MYIOV_MAX = IOV_MAX < 128 ? IOV_MAX : 128;
 191
 192 void StreamSocket::DoWrite()
 193 {
 194         if (sendq.empty())
 195                 return;
 196         if (!error.empty() || fd < 0)
 197         {
 198                 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "DoWrite on errored or closed socket");
 199                 return;
 200         }
 201
 202         if (GetIOHook())
 203         {
 204                 int rv = GetIOHook()->OnStreamSocketWrite(this, sendq);
 205                 if (rv < 0)
 206                         SetError("Write Error"); // will not overwrite a better error message
 207
 208                 // rv == 0 means the socket has blocked. Stop trying to send data.
 209                 // IOHook has requested unblock notification from the socketengine.
 210         }
 211         else
 212         {
 213                 // don't even try if we are known to be blocking
 214                 if (GetEventMask() & FD_WRITE_WILL_BLOCK)
 215                         return;
 216                 // start out optimistic - we won't need to write any more
 217                 int eventChange = FD_WANT_EDGE_WRITE;
 218                 while (error.empty() && !sendq.empty() && eventChange == FD_WANT_EDGE_WRITE)
 219                 {
 220                         // Prepare a writev() call to write all buffers efficiently
 221                         int bufcount = sendq.size();
 222
 223                         // cap the number of buffers at MYIOV_MAX
 224                         if (bufcount > MYIOV_MAX)
 225                         {
 226                                 bufcount = MYIOV_MAX;
 227                         }
 228
 229                         int rv_max = 0;
 230                         int rv;
 231                         {
 232                                 SocketEngine::IOVector iovecs[MYIOV_MAX];
 233                                 size_t j = 0;
 234                                 for (SendQueue::const_iterator i = sendq.begin(), end = i+bufcount; i != end; ++i, j++)
 235                                 {
 236                                         const SendQueue::Element& elem = *i;
 237                                         iovecs[j].iov_base = const_cast<char*>(elem.data());
 238                                         iovecs[j].iov_len = elem.length();
 239                                         rv_max += elem.length();
 240                                 }
 241                                 rv = SocketEngine::WriteV(this, iovecs, bufcount);
 242                         }
 243
 244                         if (rv == (int)sendq.bytes())
 245                         {
 246                                 // it's our lucky day, everything got written out. Fast cleanup.
 247                                 // This won't ever happen if the number of buffers got capped.
 248                                 sendq.clear();
 249                         }
 250                         else if (rv > 0)
 251                         {
 252                                 // Partial write. Clean out strings from the sendq
 253                                 if (rv < rv_max)
 254                                 {
 255                                         // it's going to block now
 256                                         eventChange = FD_WANT_FAST_WRITE | FD_WRITE_WILL_BLOCK;
 257                                 }
 258                                 while (rv > 0 && !sendq.empty())
 259                                 {
 260                                         const SendQueue::Element& front = sendq.front();
 261                                         if (front.length() <= (size_t)rv)
 262                                         {
 263                                                 // this string got fully written out
 264                                                 rv -= front.length();
 265                                                 sendq.pop_front();
 266                                         }
 267                                         else
 268                                         {
 269                                                 // stopped in the middle of this string
 270                                                 sendq.erase_front(rv);
 271                                                 rv = 0;
 272                                         }
 273                                 }
 274                         }
 275                         else if (rv == 0)
 276                         {
 277                                 error = "Connection closed";
 278                         }
 279                         else if (SocketEngine::IgnoreError())
 280                         {
 281                                 eventChange = FD_WANT_FAST_WRITE | FD_WRITE_WILL_BLOCK;
 282                         }
 283                         else if (errno == EINTR)
 284                         {
 285                                 // restart interrupted syscall
 286                                 errno = 0;
 287                         }
 288                         else
 289                         {
 290                                 error = SocketEngine::LastError();
 291                         }
 292                 }
 293                 if (!error.empty())
 294                 {
 295                         // error - kill all events
 296                         SocketEngine::ChangeEventMask(this, FD_WANT_NO_READ | FD_WANT_NO_WRITE);
 297                 }
 298                 else
 299                 {
 300                         SocketEngine::ChangeEventMask(this, eventChange);
 301                 }
 302         }
 303 }
 304
 305 void StreamSocket::WriteData(const std::string &data)
 306 {
 307         if (fd < 0)
 308         {
 309                 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "Attempt to write data to dead socket: %s",
 310                         data.c_str());
 311                 return;
 312         }
 313
 314         /* Append the data to the back of the queue ready for writing */
 315         sendq.push_back(data);
 316
 317         SocketEngine::ChangeEventMask(this, FD_ADD_TRIAL_WRITE);
 318 }
 319
 320 bool SocketTimeout::Tick(time_t)
 321 {
 322         ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "SocketTimeout::Tick");
 323
 324         if (SocketEngine::GetRef(this->sfd) != this->sock)
 325         {
 326                 delete this;
 327                 return false;
 328         }
 329
 330         if (this->sock->state == I_CONNECTING)
 331         {
 332                 // for connecting sockets, the timeout can occur
 333                 // which causes termination of the connection after
 334                 // the given number of seconds without a successful
 335                 // connection.
 336                 this->sock->OnTimeout();
 337                 this->sock->OnError(I_ERR_TIMEOUT);
 338                 this->sock->state = I_ERROR;
 339
 340                 ServerInstance->GlobalCulls.AddItem(sock);
 341         }
 342
 343         this->sock->Timeout = NULL;
 344         delete this;
 345         return false;
 346 }
 347
 348 void BufferedSocket::OnConnected() { }
 349 void BufferedSocket::OnTimeout() { return; }
 350
 351 void BufferedSocket::OnEventHandlerWrite()
 352 {
 353         if (state == I_CONNECTING)
 354         {
 355                 state = I_CONNECTED;
 356                 this->OnConnected();
 357                 if (!GetIOHook())
 358                         SocketEngine::ChangeEventMask(this, FD_WANT_FAST_READ | FD_WANT_EDGE_WRITE);
 359         }
 360         this->StreamSocket::OnEventHandlerWrite();
 361 }
 362
 363 BufferedSocket::~BufferedSocket()
 364 {
 365         this->Close();
 366         // The timer is removed from the TimerManager in Timer::~Timer()
 367         delete Timeout;
 368 }
 369
 370 void StreamSocket::OnEventHandlerError(int errornum)
 371 {
 372         if (!error.empty())
 373                 return;
 374
 375         if (errornum == 0)
 376                 SetError("Connection closed");
 377         else
 378                 SetError(SocketEngine::GetError(errornum));
 379
 380         BufferedSocketError errcode = I_ERR_OTHER;
 381         switch (errornum)
 382         {
 383                 case ETIMEDOUT:
 384                         errcode = I_ERR_TIMEOUT;
 385                         break;
 386                 case ECONNREFUSED:
 387                 case 0:
 388                         errcode = I_ERR_CONNECT;
 389                         break;
 390                 case EADDRINUSE:
 391                         errcode = I_ERR_BIND;
 392                         break;
 393                 case EPIPE:
 394                 case EIO:
 395                         errcode = I_ERR_WRITE;
 396                         break;
 397         }
 398
 399         // Log and call OnError()
 400         CheckError(errcode);
 401 }
 402
 403 void StreamSocket::OnEventHandlerRead()
 404 {
 405         if (!error.empty())
 406                 return;
 407
 408         try
 409         {
 410                 DoRead();
 411         }
 412         catch (CoreException& ex)
 413         {
 414                 ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "Caught exception in socket processing on FD %d - '%s'", fd, ex.GetReason().c_str());
 415                 SetError(ex.GetReason());
 416         }
 417         CheckError(I_ERR_OTHER);
 418 }
 419
 420 void StreamSocket::OnEventHandlerWrite()
 421 {
 422         if (!error.empty())
 423                 return;
 424
 425         DoWrite();
 426         CheckError(I_ERR_OTHER);
 427 }
 428
 429 void StreamSocket::CheckError(BufferedSocketError errcode)
 430 {
 431         if (!error.empty())
 432         {
 433                 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "Error on FD %d - '%s'", fd, error.c_str());
 434                 OnError(errcode);
 435         }
 436 }