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                         try
 118                         {
 119                                 GetIOHook()->OnStreamSocketClose(this);
 120                         }
 121                         catch (CoreException& modexcept)
 122                         {
 123                                 ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "%s threw an exception: %s",
 124                                         modexcept.GetSource().c_str(), modexcept.GetReason().c_str());
 125                         }
 126                         delete iohook;
 127                         DelIOHook();
 128                 }
 129                 SocketEngine::Shutdown(this, 2);
 130                 SocketEngine::Close(this);
 131         }
 132 }
 133
 134 CullResult StreamSocket::cull()
 135 {
 136         Close();
 137         return EventHandler::cull();
 138 }
 139
 140 bool StreamSocket::GetNextLine(std::string& line, char delim)
 141 {
 142         std::string::size_type i = recvq.find(delim);
 143         if (i == std::string::npos)
 144                 return false;
 145         line.assign(recvq, 0, i);
 146         recvq.erase(0, i + 1);
 147         return true;
 148 }
 149
 150 void StreamSocket::DoRead()
 151 {
 152         if (GetIOHook())
 153         {
 154                 int rv = -1;
 155                 try
 156                 {
 157                         rv = GetIOHook()->OnStreamSocketRead(this, recvq);
 158                 }
 159                 catch (CoreException& modexcept)
 160                 {
 161                         ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "%s threw an exception: %s",
 162                                 modexcept.GetSource().c_str(), modexcept.GetReason().c_str());
 163                         return;
 164                 }
 165                 if (rv > 0)
 166                         OnDataReady();
 167                 if (rv < 0)
 168                         SetError("Read Error"); // will not overwrite a better error message
 169         }
 170         else
 171         {
 172                 char* ReadBuffer = ServerInstance->GetReadBuffer();
 173                 int n = SocketEngine::Recv(this, ReadBuffer, ServerInstance->Config->NetBufferSize, 0);
 174                 if (n == ServerInstance->Config->NetBufferSize)
 175                 {
 176                         SocketEngine::ChangeEventMask(this, FD_WANT_FAST_READ | FD_ADD_TRIAL_READ);
 177                         recvq.append(ReadBuffer, n);
 178                         OnDataReady();
 179                 }
 180                 else if (n > 0)
 181                 {
 182                         SocketEngine::ChangeEventMask(this, FD_WANT_FAST_READ);
 183                         recvq.append(ReadBuffer, n);
 184                         OnDataReady();
 185                 }
 186                 else if (n == 0)
 187                 {
 188                         error = "Connection closed";
 189                         SocketEngine::ChangeEventMask(this, FD_WANT_NO_READ | FD_WANT_NO_WRITE);
 190                 }
 191                 else if (SocketEngine::IgnoreError())
 192                 {
 193                         SocketEngine::ChangeEventMask(this, FD_WANT_FAST_READ | FD_READ_WILL_BLOCK);
 194                 }
 195                 else if (errno == EINTR)
 196                 {
 197                         SocketEngine::ChangeEventMask(this, FD_WANT_FAST_READ | FD_ADD_TRIAL_READ);
 198                 }
 199                 else
 200                 {
 201                         error = SocketEngine::LastError();
 202                         SocketEngine::ChangeEventMask(this, FD_WANT_NO_READ | FD_WANT_NO_WRITE);
 203                 }
 204         }
 205 }
 206
 207 /* Don't try to prepare huge blobs of data to send to a blocked socket */
 208 static const int MYIOV_MAX = IOV_MAX < 128 ? IOV_MAX : 128;
 209
 210 void StreamSocket::DoWrite()
 211 {
 212         if (sendq.empty())
 213                 return;
 214         if (!error.empty() || fd < 0)
 215         {
 216                 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "DoWrite on errored or closed socket");
 217                 return;
 218         }
 219
 220 #ifndef DISABLE_WRITEV
 221         if (GetIOHook())
 222 #endif
 223         {
 224                 int rv = -1;
 225                 try
 226                 {
 227                         while (error.empty() && !sendq.empty())
 228                         {
 229                                 if (sendq.size() > 1 && sendq[0].length() < 1024)
 230                                 {
 231                                         // Avoid multiple repeated SSL encryption invocations
 232                                         // This adds a single copy of the queue, but avoids
 233                                         // much more overhead in terms of system calls invoked
 234                                         // by the IOHook.
 235                                         //
 236                                         // The length limit of 1024 is to prevent merging strings
 237                                         // more than once when writes begin to block.
 238                                         std::string tmp;
 239                                         tmp.reserve(1280);
 240                                         while (!sendq.empty() && tmp.length() < 1024)
 241                                         {
 242                                                 tmp.append(sendq.front());
 243                                                 sendq.pop_front();
 244                                         }
 245                                         sendq.push_front(tmp);
 246                                 }
 247                                 std::string& front = sendq.front();
 248                                 int itemlen = front.length();
 249                                 if (GetIOHook())
 250                                 {
 251                                         rv = GetIOHook()->OnStreamSocketWrite(this, front);
 252                                         if (rv > 0)
 253                                         {
 254                                                 // consumed the entire string, and is ready for more
 255                                                 sendq_len -= itemlen;
 256                                                 sendq.pop_front();
 257                                         }
 258                                         else if (rv == 0)
 259                                         {
 260                                                 // socket has blocked. Stop trying to send data.
 261                                                 // IOHook has requested unblock notification from the socketengine
 262
 263                                                 // Since it is possible that a partial write took place, adjust sendq_len
 264                                                 sendq_len = sendq_len - itemlen + front.length();
 265                                                 return;
 266                                         }
 267                                         else
 268                                         {
 269                                                 SetError("Write Error"); // will not overwrite a better error message
 270                                                 return;
 271                                         }
 272                                 }
 273 #ifdef DISABLE_WRITEV
 274                                 else
 275                                 {
 276                                         rv = SocketEngine::Send(this, front.data(), itemlen, 0);
 277                                         if (rv == 0)
 278                                         {
 279                                                 SetError("Connection closed");
 280                                                 return;
 281                                         }
 282                                         else if (rv < 0)
 283                                         {
 284                                                 if (errno == EINTR || SocketEngine::IgnoreError())
 285                                                         SocketEngine::ChangeEventMask(this, FD_WANT_FAST_WRITE | FD_WRITE_WILL_BLOCK);
 286                                                 else
 287                                                         SetError(SocketEngine::LastError());
 288                                                 return;
 289                                         }
 290                                         else if (rv < itemlen)
 291                                         {
 292                                                 SocketEngine::ChangeEventMask(this, FD_WANT_FAST_WRITE | FD_WRITE_WILL_BLOCK);
 293                                                 front.erase(0, rv);
 294                                                 sendq_len -= rv;
 295                                                 return;
 296                                         }
 297                                         else
 298                                         {
 299                                                 sendq_len -= itemlen;
 300                                                 sendq.pop_front();
 301                                                 if (sendq.empty())
 302                                                         SocketEngine::ChangeEventMask(this, FD_WANT_EDGE_WRITE);
 303                                         }
 304                                 }
 305 #endif
 306                         }
 307                 }
 308                 catch (CoreException& modexcept)
 309                 {
 310                         ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "%s threw an exception: %s",
 311                                 modexcept.GetSource().c_str(), modexcept.GetReason().c_str());
 312                 }
 313         }
 314 #ifndef DISABLE_WRITEV
 315         else
 316         {
 317                 // don't even try if we are known to be blocking
 318                 if (GetEventMask() & FD_WRITE_WILL_BLOCK)
 319                         return;
 320                 // start out optimistic - we won't need to write any more
 321                 int eventChange = FD_WANT_EDGE_WRITE;
 322                 while (error.empty() && sendq_len && eventChange == FD_WANT_EDGE_WRITE)
 323                 {
 324                         // Prepare a writev() call to write all buffers efficiently
 325                         int bufcount = sendq.size();
 326
 327                         // cap the number of buffers at MYIOV_MAX
 328                         if (bufcount > MYIOV_MAX)
 329                         {
 330                                 bufcount = MYIOV_MAX;
 331                         }
 332
 333                         int rv_max = 0;
 334                         int rv;
 335                         {
 336                                 iovec iovecs[MYIOV_MAX];
 337                                 for (int i = 0; i < bufcount; i++)
 338                                 {
 339                                         iovecs[i].iov_base = const_cast<char*>(sendq[i].data());
 340                                         iovecs[i].iov_len = sendq[i].length();
 341                                         rv_max += sendq[i].length();
 342                                 }
 343                                 rv = SocketEngine::WriteV(this, iovecs, bufcount);
 344                         }
 345
 346                         if (rv == (int)sendq_len)
 347                         {
 348                                 // it's our lucky day, everything got written out. Fast cleanup.
 349                                 // This won't ever happen if the number of buffers got capped.
 350                                 sendq_len = 0;
 351                                 sendq.clear();
 352                         }
 353                         else if (rv > 0)
 354                         {
 355                                 // Partial write. Clean out strings from the sendq
 356                                 if (rv < rv_max)
 357                                 {
 358                                         // it's going to block now
 359                                         eventChange = FD_WANT_FAST_WRITE | FD_WRITE_WILL_BLOCK;
 360                                 }
 361                                 sendq_len -= rv;
 362                                 while (rv > 0 && !sendq.empty())
 363                                 {
 364                                         std::string& front = sendq.front();
 365                                         if (front.length() <= (size_t)rv)
 366                                         {
 367                                                 // this string got fully written out
 368                                                 rv -= front.length();
 369                                                 sendq.pop_front();
 370                                         }
 371                                         else
 372                                         {
 373                                                 // stopped in the middle of this string
 374                                                 front.erase(0, rv);
 375                                                 rv = 0;
 376                                         }
 377                                 }
 378                         }
 379                         else if (rv == 0)
 380                         {
 381                                 error = "Connection closed";
 382                         }
 383                         else if (SocketEngine::IgnoreError())
 384                         {
 385                                 eventChange = FD_WANT_FAST_WRITE | FD_WRITE_WILL_BLOCK;
 386                         }
 387                         else if (errno == EINTR)
 388                         {
 389                                 // restart interrupted syscall
 390                                 errno = 0;
 391                         }
 392                         else
 393                         {
 394                                 error = SocketEngine::LastError();
 395                         }
 396                 }
 397                 if (!error.empty())
 398                 {
 399                         // error - kill all events
 400                         SocketEngine::ChangeEventMask(this, FD_WANT_NO_READ | FD_WANT_NO_WRITE);
 401                 }
 402                 else
 403                 {
 404                         SocketEngine::ChangeEventMask(this, eventChange);
 405                 }
 406         }
 407 #endif
 408 }
 409
 410 void StreamSocket::WriteData(const std::string &data)
 411 {
 412         if (fd < 0)
 413         {
 414                 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "Attempt to write data to dead socket: %s",
 415                         data.c_str());
 416                 return;
 417         }
 418
 419         /* Append the data to the back of the queue ready for writing */
 420         sendq.push_back(data);
 421         sendq_len += data.length();
 422
 423         SocketEngine::ChangeEventMask(this, FD_ADD_TRIAL_WRITE);
 424 }
 425
 426 bool SocketTimeout::Tick(time_t)
 427 {
 428         ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "SocketTimeout::Tick");
 429
 430         if (SocketEngine::GetRef(this->sfd) != this->sock)
 431         {
 432                 delete this;
 433                 return false;
 434         }
 435
 436         if (this->sock->state == I_CONNECTING)
 437         {
 438                 // for connecting sockets, the timeout can occur
 439                 // which causes termination of the connection after
 440                 // the given number of seconds without a successful
 441                 // connection.
 442                 this->sock->OnTimeout();
 443                 this->sock->OnError(I_ERR_TIMEOUT);
 444                 this->sock->state = I_ERROR;
 445
 446                 ServerInstance->GlobalCulls.AddItem(sock);
 447         }
 448
 449         this->sock->Timeout = NULL;
 450         delete this;
 451         return false;
 452 }
 453
 454 void BufferedSocket::OnConnected() { }
 455 void BufferedSocket::OnTimeout() { return; }
 456
 457 void BufferedSocket::DoWrite()
 458 {
 459         if (state == I_CONNECTING)
 460         {
 461                 state = I_CONNECTED;
 462                 this->OnConnected();
 463                 if (!GetIOHook())
 464                         SocketEngine::ChangeEventMask(this, FD_WANT_FAST_READ | FD_WANT_EDGE_WRITE);
 465         }
 466         this->StreamSocket::DoWrite();
 467 }
 468
 469 BufferedSocket::~BufferedSocket()
 470 {
 471         this->Close();
 472         // The timer is removed from the TimerManager in Timer::~Timer()
 473         delete Timeout;
 474 }
 475
 476 void StreamSocket::HandleEvent(EventType et, int errornum)
 477 {
 478         if (!error.empty())
 479                 return;
 480         BufferedSocketError errcode = I_ERR_OTHER;
 481         try {
 482                 switch (et)
 483                 {
 484                         case EVENT_ERROR:
 485                         {
 486                                 if (errornum == 0)
 487                                         SetError("Connection closed");
 488                                 else
 489                                         SetError(SocketEngine::GetError(errornum));
 490                                 switch (errornum)
 491                                 {
 492                                         case ETIMEDOUT:
 493                                                 errcode = I_ERR_TIMEOUT;
 494                                                 break;
 495                                         case ECONNREFUSED:
 496                                         case 0:
 497                                                 errcode = I_ERR_CONNECT;
 498                                                 break;
 499                                         case EADDRINUSE:
 500                                                 errcode = I_ERR_BIND;
 501                                                 break;
 502                                         case EPIPE:
 503                                         case EIO:
 504                                                 errcode = I_ERR_WRITE;
 505                                                 break;
 506                                 }
 507                                 break;
 508                         }
 509                         case EVENT_READ:
 510                         {
 511                                 DoRead();
 512                                 break;
 513                         }
 514                         case EVENT_WRITE:
 515                         {
 516                                 DoWrite();
 517                                 break;
 518                         }
 519                 }
 520         }
 521         catch (CoreException& ex)
 522         {
 523                 ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "Caught exception in socket processing on FD %d - '%s'",
 524                         fd, ex.GetReason().c_str());
 525                 SetError(ex.GetReason());
 526         }
 527         if (!error.empty())
 528         {
 529                 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "Error on FD %d - '%s'", fd, error.c_str());
 530                 OnError(errcode);
 531         }
 532 }