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                 {
 205                         {
 206                                 {
 207                                         int rv = GetIOHook()->OnStreamSocketWrite(this);
 208                                         if (rv > 0)
 209                                         {
 210                                                 // consumed the entire string, and is ready for more
 211                                         }
 212                                         else if (rv == 0)
 213                                         {
 214                                                 // socket has blocked. Stop trying to send data.
 215                                                 // IOHook has requested unblock notification from the socketengine
 216                                                 return;
 217                                         }
 218                                         else
 219                                         {
 220                                                 SetError("Write Error"); // will not overwrite a better error message
 221                                                 return;
 222                                         }
 223                                 }
 224                         }
 225                 }
 226         }
 227         else
 228         {
 229                 // don't even try if we are known to be blocking
 230                 if (GetEventMask() & FD_WRITE_WILL_BLOCK)
 231                         return;
 232                 // start out optimistic - we won't need to write any more
 233                 int eventChange = FD_WANT_EDGE_WRITE;
 234                 while (error.empty() && !sendq.empty() && eventChange == FD_WANT_EDGE_WRITE)
 235                 {
 236                         // Prepare a writev() call to write all buffers efficiently
 237                         int bufcount = sendq.size();
 238
 239                         // cap the number of buffers at MYIOV_MAX
 240                         if (bufcount > MYIOV_MAX)
 241                         {
 242                                 bufcount = MYIOV_MAX;
 243                         }
 244
 245                         int rv_max = 0;
 246                         int rv;
 247                         {
 248                                 SocketEngine::IOVector iovecs[MYIOV_MAX];
 249                                 size_t j = 0;
 250                                 for (SendQueue::const_iterator i = sendq.begin(), end = i+bufcount; i != end; ++i, j++)
 251                                 {
 252                                         const SendQueue::Element& elem = *i;
 253                                         iovecs[j].iov_base = const_cast<char*>(elem.data());
 254                                         iovecs[j].iov_len = elem.length();
 255                                         rv_max += elem.length();
 256                                 }
 257                                 rv = SocketEngine::WriteV(this, iovecs, bufcount);
 258                         }
 259
 260                         if (rv == (int)sendq.bytes())
 261                         {
 262                                 // it's our lucky day, everything got written out. Fast cleanup.
 263                                 // This won't ever happen if the number of buffers got capped.
 264                                 sendq.clear();
 265                         }
 266                         else if (rv > 0)
 267                         {
 268                                 // Partial write. Clean out strings from the sendq
 269                                 if (rv < rv_max)
 270                                 {
 271                                         // it's going to block now
 272                                         eventChange = FD_WANT_FAST_WRITE | FD_WRITE_WILL_BLOCK;
 273                                 }
 274                                 while (rv > 0 && !sendq.empty())
 275                                 {
 276                                         const SendQueue::Element& front = sendq.front();
 277                                         if (front.length() <= (size_t)rv)
 278                                         {
 279                                                 // this string got fully written out
 280                                                 rv -= front.length();
 281                                                 sendq.pop_front();
 282                                         }
 283                                         else
 284                                         {
 285                                                 // stopped in the middle of this string
 286                                                 sendq.erase_front(rv);
 287                                                 rv = 0;
 288                                         }
 289                                 }
 290                         }
 291                         else if (rv == 0)
 292                         {
 293                                 error = "Connection closed";
 294                         }
 295                         else if (SocketEngine::IgnoreError())
 296                         {
 297                                 eventChange = FD_WANT_FAST_WRITE | FD_WRITE_WILL_BLOCK;
 298                         }
 299                         else if (errno == EINTR)
 300                         {
 301                                 // restart interrupted syscall
 302                                 errno = 0;
 303                         }
 304                         else
 305                         {
 306                                 error = SocketEngine::LastError();
 307                         }
 308                 }
 309                 if (!error.empty())
 310                 {
 311                         // error - kill all events
 312                         SocketEngine::ChangeEventMask(this, FD_WANT_NO_READ | FD_WANT_NO_WRITE);
 313                 }
 314                 else
 315                 {
 316                         SocketEngine::ChangeEventMask(this, eventChange);
 317                 }
 318         }
 319 }
 320
 321 void StreamSocket::WriteData(const std::string &data)
 322 {
 323         if (fd < 0)
 324         {
 325                 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "Attempt to write data to dead socket: %s",
 326                         data.c_str());
 327                 return;
 328         }
 329
 330         /* Append the data to the back of the queue ready for writing */
 331         sendq.push_back(data);
 332
 333         SocketEngine::ChangeEventMask(this, FD_ADD_TRIAL_WRITE);
 334 }
 335
 336 bool SocketTimeout::Tick(time_t)
 337 {
 338         ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "SocketTimeout::Tick");
 339
 340         if (SocketEngine::GetRef(this->sfd) != this->sock)
 341         {
 342                 delete this;
 343                 return false;
 344         }
 345
 346         if (this->sock->state == I_CONNECTING)
 347         {
 348                 // for connecting sockets, the timeout can occur
 349                 // which causes termination of the connection after
 350                 // the given number of seconds without a successful
 351                 // connection.
 352                 this->sock->OnTimeout();
 353                 this->sock->OnError(I_ERR_TIMEOUT);
 354                 this->sock->state = I_ERROR;
 355
 356                 ServerInstance->GlobalCulls.AddItem(sock);
 357         }
 358
 359         this->sock->Timeout = NULL;
 360         delete this;
 361         return false;
 362 }
 363
 364 void BufferedSocket::OnConnected() { }
 365 void BufferedSocket::OnTimeout() { return; }
 366
 367 void BufferedSocket::OnEventHandlerWrite()
 368 {
 369         if (state == I_CONNECTING)
 370         {
 371                 state = I_CONNECTED;
 372                 this->OnConnected();
 373                 if (!GetIOHook())
 374                         SocketEngine::ChangeEventMask(this, FD_WANT_FAST_READ | FD_WANT_EDGE_WRITE);
 375         }
 376         this->StreamSocket::OnEventHandlerWrite();
 377 }
 378
 379 BufferedSocket::~BufferedSocket()
 380 {
 381         this->Close();
 382         // The timer is removed from the TimerManager in Timer::~Timer()
 383         delete Timeout;
 384 }
 385
 386 void StreamSocket::OnEventHandlerError(int errornum)
 387 {
 388         if (!error.empty())
 389                 return;
 390
 391         if (errornum == 0)
 392                 SetError("Connection closed");
 393         else
 394                 SetError(SocketEngine::GetError(errornum));
 395
 396         BufferedSocketError errcode = I_ERR_OTHER;
 397         switch (errornum)
 398         {
 399                 case ETIMEDOUT:
 400                         errcode = I_ERR_TIMEOUT;
 401                         break;
 402                 case ECONNREFUSED:
 403                 case 0:
 404                         errcode = I_ERR_CONNECT;
 405                         break;
 406                 case EADDRINUSE:
 407                         errcode = I_ERR_BIND;
 408                         break;
 409                 case EPIPE:
 410                 case EIO:
 411                         errcode = I_ERR_WRITE;
 412                         break;
 413         }
 414
 415         // Log and call OnError()
 416         CheckError(errcode);
 417 }
 418
 419 void StreamSocket::OnEventHandlerRead()
 420 {
 421         if (!error.empty())
 422                 return;
 423
 424         try
 425         {
 426                 DoRead();
 427         }
 428         catch (CoreException& ex)
 429         {
 430                 ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "Caught exception in socket processing on FD %d - '%s'", fd, ex.GetReason().c_str());
 431                 SetError(ex.GetReason());
 432         }
 433         CheckError(I_ERR_OTHER);
 434 }
 435
 436 void StreamSocket::OnEventHandlerWrite()
 437 {
 438         if (!error.empty())
 439                 return;
 440
 441         DoWrite();
 442         CheckError(I_ERR_OTHER);
 443 }
 444
 445 void StreamSocket::CheckError(BufferedSocketError errcode)
 446 {
 447         if (!error.empty())
 448         {
 449                 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "Error on FD %d - '%s'", fd, error.c_str());
 450                 OnError(errcode);
 451         }
 452 }