2 * InspIRCd -- Internet Relay Chat Daemon
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>
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.
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
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/>.
28 BufferedSocket::BufferedSocket()
34 BufferedSocket::BufferedSocket(int newfd)
38 this->state = I_CONNECTED;
40 SocketEngine::AddFd(this, FD_WANT_FAST_READ | FD_WANT_EDGE_WRITE);
43 void BufferedSocket::DoConnect(const std::string &ipaddr, int aport, unsigned long maxtime, const std::string &connectbindip)
45 BufferedSocketError err = BeginConnect(ipaddr, aport, maxtime, connectbindip);
46 if (err != I_ERR_NONE)
49 SetError(SocketEngine::LastError());
54 BufferedSocketError BufferedSocket::BeginConnect(const std::string &ipaddr, int aport, unsigned long maxtime, const std::string &connectbindip)
56 irc::sockets::sockaddrs addr, bind;
57 if (!irc::sockets::aptosa(ipaddr, aport, addr))
59 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "BUG: Hostname passed to BufferedSocket, rather than an IP address!");
63 bind.sa.sa_family = 0;
64 if (!connectbindip.empty())
66 if (!irc::sockets::aptosa(connectbindip, 0, bind))
72 return BeginConnect(addr, bind, maxtime);
75 BufferedSocketError BufferedSocket::BeginConnect(const irc::sockets::sockaddrs& dest, const irc::sockets::sockaddrs& bind, unsigned long timeout)
78 fd = socket(dest.sa.sa_family, SOCK_STREAM, 0);
83 if (bind.sa.sa_family != 0)
85 if (SocketEngine::Bind(fd, bind) < 0)
89 SocketEngine::NonBlocking(fd);
91 if (SocketEngine::Connect(this, &dest.sa, dest.sa_size()) == -1)
93 if (errno != EINPROGRESS)
97 this->state = I_CONNECTING;
99 if (!SocketEngine::AddFd(this, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE | FD_WRITE_WILL_BLOCK))
100 return I_ERR_NOMOREFDS;
102 this->Timeout = new SocketTimeout(this->GetFd(), this, timeout);
103 ServerInstance->Timers.AddTimer(this->Timeout);
105 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "BufferedSocket::DoConnect success");
109 void StreamSocket::Close()
113 // final chance, dump as much of the sendq as we can
117 GetIOHook()->OnStreamSocketClose(this);
121 SocketEngine::Shutdown(this, 2);
122 SocketEngine::Close(this);
126 CullResult StreamSocket::cull()
129 return EventHandler::cull();
132 bool StreamSocket::GetNextLine(std::string& line, char delim)
134 std::string::size_type i = recvq.find(delim);
135 if (i == std::string::npos)
137 line.assign(recvq, 0, i);
138 recvq.erase(0, i + 1);
142 void StreamSocket::DoRead()
146 int rv = GetIOHook()->OnStreamSocketRead(this, recvq);
150 SetError("Read Error"); // will not overwrite a better error message
154 char* ReadBuffer = ServerInstance->GetReadBuffer();
155 int n = SocketEngine::Recv(this, ReadBuffer, ServerInstance->Config->NetBufferSize, 0);
156 if (n == ServerInstance->Config->NetBufferSize)
158 SocketEngine::ChangeEventMask(this, FD_WANT_FAST_READ | FD_ADD_TRIAL_READ);
159 recvq.append(ReadBuffer, n);
164 SocketEngine::ChangeEventMask(this, FD_WANT_FAST_READ);
165 recvq.append(ReadBuffer, n);
170 error = "Connection closed";
171 SocketEngine::ChangeEventMask(this, FD_WANT_NO_READ | FD_WANT_NO_WRITE);
173 else if (SocketEngine::IgnoreError())
175 SocketEngine::ChangeEventMask(this, FD_WANT_FAST_READ | FD_READ_WILL_BLOCK);
177 else if (errno == EINTR)
179 SocketEngine::ChangeEventMask(this, FD_WANT_FAST_READ | FD_ADD_TRIAL_READ);
183 error = SocketEngine::LastError();
184 SocketEngine::ChangeEventMask(this, FD_WANT_NO_READ | FD_WANT_NO_WRITE);
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;
192 void StreamSocket::DoWrite()
196 if (!error.empty() || fd < 0)
198 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "DoWrite on errored or closed socket");
205 while (error.empty() && !sendq.empty())
207 if (sendq.size() > 1 && sendq.front().length() < 1024)
209 // Avoid multiple repeated SSL encryption invocations
210 // This adds a single copy of the queue, but avoids
211 // much more overhead in terms of system calls invoked
214 // The length limit of 1024 is to prevent merging strings
215 // more than once when writes begin to block.
218 while (!sendq.empty() && tmp.length() < 1024)
220 tmp.append(sendq.front());
223 sendq.push_front(tmp);
227 int rv = GetIOHook()->OnStreamSocketWrite(this);
230 // consumed the entire string, and is ready for more
235 // socket has blocked. Stop trying to send data.
236 // IOHook has requested unblock notification from the socketengine
241 SetError("Write Error"); // will not overwrite a better error message
250 // don't even try if we are known to be blocking
251 if (GetEventMask() & FD_WRITE_WILL_BLOCK)
253 // start out optimistic - we won't need to write any more
254 int eventChange = FD_WANT_EDGE_WRITE;
255 while (error.empty() && !sendq.empty() && eventChange == FD_WANT_EDGE_WRITE)
257 // Prepare a writev() call to write all buffers efficiently
258 int bufcount = sendq.size();
260 // cap the number of buffers at MYIOV_MAX
261 if (bufcount > MYIOV_MAX)
263 bufcount = MYIOV_MAX;
269 SocketEngine::IOVector iovecs[MYIOV_MAX];
271 for (SendQueue::const_iterator i = sendq.begin(), end = i+bufcount; i != end; ++i, j++)
273 const SendQueue::Element& elem = *i;
274 iovecs[j].iov_base = const_cast<char*>(elem.data());
275 iovecs[j].iov_len = elem.length();
276 rv_max += elem.length();
278 rv = SocketEngine::WriteV(this, iovecs, bufcount);
281 if (rv == (int)sendq.bytes())
283 // it's our lucky day, everything got written out. Fast cleanup.
284 // This won't ever happen if the number of buffers got capped.
289 // Partial write. Clean out strings from the sendq
292 // it's going to block now
293 eventChange = FD_WANT_FAST_WRITE | FD_WRITE_WILL_BLOCK;
295 while (rv > 0 && !sendq.empty())
297 const SendQueue::Element& front = sendq.front();
298 if (front.length() <= (size_t)rv)
300 // this string got fully written out
301 rv -= front.length();
306 // stopped in the middle of this string
307 sendq.erase_front(rv);
314 error = "Connection closed";
316 else if (SocketEngine::IgnoreError())
318 eventChange = FD_WANT_FAST_WRITE | FD_WRITE_WILL_BLOCK;
320 else if (errno == EINTR)
322 // restart interrupted syscall
327 error = SocketEngine::LastError();
332 // error - kill all events
333 SocketEngine::ChangeEventMask(this, FD_WANT_NO_READ | FD_WANT_NO_WRITE);
337 SocketEngine::ChangeEventMask(this, eventChange);
342 void StreamSocket::WriteData(const std::string &data)
346 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "Attempt to write data to dead socket: %s",
351 /* Append the data to the back of the queue ready for writing */
352 sendq.push_back(data);
354 SocketEngine::ChangeEventMask(this, FD_ADD_TRIAL_WRITE);
357 bool SocketTimeout::Tick(time_t)
359 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "SocketTimeout::Tick");
361 if (SocketEngine::GetRef(this->sfd) != this->sock)
367 if (this->sock->state == I_CONNECTING)
369 // for connecting sockets, the timeout can occur
370 // which causes termination of the connection after
371 // the given number of seconds without a successful
373 this->sock->OnTimeout();
374 this->sock->OnError(I_ERR_TIMEOUT);
375 this->sock->state = I_ERROR;
377 ServerInstance->GlobalCulls.AddItem(sock);
380 this->sock->Timeout = NULL;
385 void BufferedSocket::OnConnected() { }
386 void BufferedSocket::OnTimeout() { return; }
388 void BufferedSocket::OnEventHandlerWrite()
390 if (state == I_CONNECTING)
395 SocketEngine::ChangeEventMask(this, FD_WANT_FAST_READ | FD_WANT_EDGE_WRITE);
397 this->StreamSocket::OnEventHandlerWrite();
400 BufferedSocket::~BufferedSocket()
403 // The timer is removed from the TimerManager in Timer::~Timer()
407 void StreamSocket::OnEventHandlerError(int errornum)
413 SetError("Connection closed");
415 SetError(SocketEngine::GetError(errornum));
417 BufferedSocketError errcode = I_ERR_OTHER;
421 errcode = I_ERR_TIMEOUT;
425 errcode = I_ERR_CONNECT;
428 errcode = I_ERR_BIND;
432 errcode = I_ERR_WRITE;
436 // Log and call OnError()
440 void StreamSocket::OnEventHandlerRead()
449 catch (CoreException& ex)
451 ServerInstance->Logs->Log("SOCKET", LOG_DEFAULT, "Caught exception in socket processing on FD %d - '%s'", fd, ex.GetReason().c_str());
452 SetError(ex.GetReason());
454 CheckError(I_ERR_OTHER);
457 void StreamSocket::OnEventHandlerWrite()
463 CheckError(I_ERR_OTHER);
466 void StreamSocket::CheckError(BufferedSocketError errcode)
470 ServerInstance->Logs->Log("SOCKET", LOG_DEBUG, "Error on FD %d - '%s'", fd, error.c_str());