]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/inspsocket.cpp
Move socket hooking in inspsocket to utilise the new system properly.
[user/henk/code/inspircd.git] / src / inspsocket.cpp
index dc0c5bebafc7e519f22252f9f683837de4066e83..3b28cc3bd567eb17f3a0792bff17acb67b96eb8a 100644 (file)
@@ -2,7 +2,7 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
  * See: http://www.inspircd.org/wiki/index.php/Credits
  *
  * This program is free but copyrighted software; see
@@ -11,6 +11,8 @@
  * ---------------------------------------------------
  */
 
+/* $Core */
+
 #include "socket.h"
 #include "inspstring.h"
 #include "socketengine.h"
 
 using irc::sockets::OpenTCPSocket;
 
-bool InspSocket::Readable()
+bool BufferedSocket::Readable()
 {
        return ((this->state != I_CONNECTING) && (this->WaitingForWriteEvent == false));
 }
 
-InspSocket::InspSocket(InspIRCd* SI)
+BufferedSocket::BufferedSocket(InspIRCd* SI)
 {
        this->Timeout = NULL;
        this->state = I_DISCONNECTED;
        this->fd = -1;
        this->WaitingForWriteEvent = false;
        this->Instance = SI;
-       this->IsIOHooked = false;
 }
 
-InspSocket::InspSocket(InspIRCd* SI, int newfd, const char* ip)
+BufferedSocket::BufferedSocket(InspIRCd* SI, int newfd, const char* ip)
 {
        this->Timeout = NULL;
        this->fd = newfd;
@@ -41,19 +42,17 @@ InspSocket::InspSocket(InspIRCd* SI, int newfd, const char* ip)
        strlcpy(this->IP,ip,MAXBUF);
        this->WaitingForWriteEvent = false;
        this->Instance = SI;
-       this->IsIOHooked = false;
        if (this->fd > -1)
                this->Instance->SE->AddFd(this);
 }
 
-InspSocket::InspSocket(InspIRCd* SI, const std::string &ipaddr, int aport, bool listening, unsigned long maxtime, const std::string &connectbindip)
+BufferedSocket::BufferedSocket(InspIRCd* SI, const std::string &ipaddr, int aport, bool listening, unsigned long maxtime, const std::string &connectbindip)
 {
        this->cbindip = connectbindip;
        this->fd = -1;
        this->Instance = SI;
        strlcpy(host,ipaddr.c_str(),MAXBUF);
        this->WaitingForWriteEvent = false;
-       this->IsIOHooked = false;
        this->Timeout = NULL;
        if (listening)
        {
@@ -114,7 +113,7 @@ InspSocket::InspSocket(InspIRCd* SI, const std::string &ipaddr, int aport, bool
                }
                if (!ipvalid)
                {
-                       this->Instance->Log(DEBUG,"BUG: Hostname passed to InspSocket, rather than an IP address!");
+                       this->Instance->Logs->Log("SOCKET", DEBUG,"BUG: Hostname passed to BufferedSocket, rather than an IP address!");
                        this->OnError(I_ERR_CONNECT);
                        this->Close();
                        this->fd = -1;
@@ -137,19 +136,22 @@ InspSocket::InspSocket(InspIRCd* SI, const std::string &ipaddr, int aport, bool
        }
 }
 
-void InspSocket::WantWrite()
+void BufferedSocket::WantWrite()
 {
        this->Instance->SE->WantWrite(this);
        this->WaitingForWriteEvent = true;
 }
 
-void InspSocket::SetQueues(int nfd)
+void BufferedSocket::SetQueues(int nfd)
 {
        // attempt to increase socket sendq and recvq as high as its possible
        int sendbuf = 32768;
        int recvbuf = 32768;
        if(setsockopt(nfd,SOL_SOCKET,SO_SNDBUF,(const char *)&sendbuf,sizeof(sendbuf)) || setsockopt(nfd,SOL_SOCKET,SO_RCVBUF,(const char *)&recvbuf,sizeof(sendbuf)))
-               this->Instance->Log(DEFAULT, "Could not increase SO_SNDBUF/SO_RCVBUF for socket %u", GetFd());
+       {
+               //this->Instance->Log(DEFAULT, "Could not increase SO_SNDBUF/SO_RCVBUF for socket %u", GetFd());
+               ; // do nothing. I'm a little sick of people trying to interpret this message as a result of why their incorrect setups don't work.
+       }
 }
 
 /* Most irc servers require you to specify the ip you want to bind to.
@@ -160,7 +162,7 @@ void InspSocket::SetQueues(int nfd)
  * This is easier to configure when you have a lot of links and a lot
  * of servers to configure.
  */
-bool InspSocket::BindAddr(const std::string &ip)
+bool BufferedSocket::BindAddr(const std::string &ip)
 {
        ConfigReader Conf(this->Instance);
        socklen_t size = sizeof(sockaddr_in);
@@ -173,10 +175,10 @@ bool InspSocket::BindAddr(const std::string &ip)
        int j = 0;
        while (j < Conf.Enumerate("bind") || (!ip.empty()))
        {
-               std::string IP = ip.empty() ? Conf.ReadValue("bind","address",j) : ip;
+               std::string sIP = ip.empty() ? Conf.ReadValue("bind","address",j) : ip;
                if (!ip.empty() || Conf.ReadValue("bind","type",j) == "servers")
                {
-                       if (!ip.empty() || ((IP != "*") && (IP != "127.0.0.1") && (!IP.empty()) && (IP != "::1")))
+                       if (!ip.empty() || ((sIP != "*") && (sIP != "127.0.0.1") && (!sIP.empty()) && (sIP != "::1")))
                        {
                                /* The [2] is required because we may write a sockaddr_in6 here, and sockaddr_in6 is larger than sockaddr, where sockaddr_in4 is not. */
                                sockaddr* s = new sockaddr[2];
@@ -184,7 +186,7 @@ bool InspSocket::BindAddr(const std::string &ip)
                                if (v6)
                                {
                                        in6_addr n;
-                                       if (inet_pton(AF_INET6, IP.c_str(), &n) > 0)
+                                       if (inet_pton(AF_INET6, sIP.c_str(), &n) > 0)
                                        {
                                                memcpy(&((sockaddr_in6*)s)->sin6_addr, &n, sizeof(sockaddr_in6));
                                                ((sockaddr_in6*)s)->sin6_port = 0;
@@ -202,7 +204,7 @@ bool InspSocket::BindAddr(const std::string &ip)
 #endif
                                {
                                        in_addr n;
-                                       if (inet_aton(IP.c_str(), &n) > 0)
+                                       if (inet_aton(sIP.c_str(), &n) > 0)
                                        {
                                                ((sockaddr_in*)s)->sin_addr = n;
                                                ((sockaddr_in*)s)->sin_port = 0;
@@ -231,10 +233,11 @@ bool InspSocket::BindAddr(const std::string &ip)
                }
                j++;
        }
+       Instance->Logs->Log("SOCKET", DEBUG,"nothing in the config to bind()!");
        return true;
 }
 
-bool InspSocket::DoConnect()
+bool BufferedSocket::DoConnect()
 {
        /* The [2] is required because we may write a sockaddr_in6 here, and sockaddr_in6 is larger than sockaddr, where sockaddr_in4 is not. */
        sockaddr* addr = new sockaddr[2];
@@ -338,11 +341,13 @@ bool InspSocket::DoConnect()
                }
                this->SetQueues(this->fd);
        }
+
+       Instance->Logs->Log("SOCKET", DEBUG,"BufferedSocket::DoConnect success");
        return true;
 }
 
 
-void InspSocket::Close()
+void BufferedSocket::Close()
 {
        /* Save this, so we dont lose it,
         * otherise on failure, error messages
@@ -351,15 +356,16 @@ void InspSocket::Close()
        int save = errno;
        if (this->fd > -1)
        {
-               if (this->IsIOHooked && Instance->Config->GetIOHook(this))
+               if (this->GetIOHook())
                {
                        try
                        {
-                               Instance->Config->GetIOHook(this)->OnRawSocketClose(this->fd);
+                               if (this->state != I_LISTENING)
+                                       this->GetIOHook()->OnRawSocketClose(this->fd);
                        }
                        catch (CoreException& modexcept)
                        {
-                               Instance->Log(DEFAULT,"%s threw an exception: %s", modexcept.GetSource(), modexcept.GetReason());
+                               Instance->Logs->Log("SOCKET", DEFAULT,"%s threw an exception: %s", modexcept.GetSource(), modexcept.GetReason());
                        }
                }
                Instance->SE->Shutdown(this, 2);
@@ -372,29 +378,30 @@ void InspSocket::Close()
        errno = save;
 }
 
-std::string InspSocket::GetIP()
+std::string BufferedSocket::GetIP()
 {
        return this->IP;
 }
 
-char* InspSocket::Read()
+const char* BufferedSocket::Read()
 {
        if (!Instance->SE->BoundsCheckFd(this))
                return NULL;
 
        int n = 0;
+       char* ReadBuffer = Instance->GetReadBuffer();
 
-       if (this->IsIOHooked)
+       if (this->GetIOHook())
        {
                int result2 = 0;
                int MOD_RESULT = 0;
                try
                {
-                       MOD_RESULT = Instance->Config->GetIOHook(this)->OnRawSocketRead(this->fd,this->ibuf,sizeof(this->ibuf),result2);
+                       MOD_RESULT = this->GetIOHook()->OnRawSocketRead(this->fd, ReadBuffer, Instance->Config->NetBufferSize, result2);
                }
                catch (CoreException& modexcept)
                {
-                       Instance->Log(DEFAULT,"%s threw an exception: %s", modexcept.GetSource(), modexcept.GetReason());
+                       Instance->Logs->Log("SOCKET", DEFAULT,"%s threw an exception: %s", modexcept.GetSource(), modexcept.GetReason());
                }
                if (MOD_RESULT < 0)
                {
@@ -408,13 +415,19 @@ char* InspSocket::Read()
        }
        else
        {
-               n = recv(this->fd,this->ibuf,sizeof(this->ibuf),0);
+               n = recv(this->fd, ReadBuffer, Instance->Config->NetBufferSize, 0);
        }
 
-       if ((n > 0) && (n <= (int)sizeof(this->ibuf)))
+       /*
+        * This used to do some silly bounds checking instead of just passing bufsize - 1 to recv.
+        * Not only does that make absolutely no sense, but it could potentially result in a read buffer's worth
+        * of data being thrown into the bit bucket for no good reason, which is just *stupid*.. do things correctly now.
+        * --w00t (july 2, 2008)
+        */
+       if (n > 0)
        {
-               ibuf[n] = 0;
-               return ibuf;
+               ReadBuffer[n] = 0;
+               return ReadBuffer;
        }
        else
        {
@@ -426,29 +439,33 @@ char* InspSocket::Read()
        }
 }
 
-void InspSocket::MarkAsClosed()
-{
-}
-
-// There are two possible outcomes to this function.
-// It will either write all of the data, or an undefined amount.
-// If an undefined amount is written the connection has failed
-// and should be aborted.
-int InspSocket::Write(const std::string &data)
+/*
+ * This function formerly tried to flush write buffer each call.
+ * While admirable in attempting to get the data out to wherever
+ * it is going, on a full socket, it's just going to syscall write() and
+ * EAGAIN constantly, instead of waiting in the SE to know if it can write
+ * which will chew a bit of CPU.
+ *
+ * So, now this function returns void (take note) and just adds to the sendq.
+ *
+ * It'll get written at a determinate point when the socketengine tells us it can write.
+ *             -- w00t (april 1, 2008)
+ */
+void BufferedSocket::Write(const std::string &data)
 {
-       /* Try and append the data to the back of the queue, and send it on its way
-        */
+       /* Append the data to the back of the queue ready for writing */
        outbuffer.push_back(data);
+
+       /* Mark ourselves as wanting write */
        this->Instance->SE->WantWrite(this);
-       return (!this->FlushWriteBuffer());
 }
 
-bool InspSocket::FlushWriteBuffer()
+bool BufferedSocket::FlushWriteBuffer()
 {
        errno = 0;
        if ((this->fd > -1) && (this->state == I_CONNECTED))
        {
-               if (this->IsIOHooked)
+               if (this->GetIOHook())
                {
                        while (outbuffer.size() && (errno != EAGAIN))
                        {
@@ -457,12 +474,12 @@ bool InspSocket::FlushWriteBuffer()
                                        /* XXX: The lack of buffering here is NOT a bug, modules implementing this interface have to
                                         * implement their own buffering mechanisms
                                         */
-                                       Instance->Config->GetIOHook(this)->OnRawSocketWrite(this->fd, outbuffer[0].c_str(), outbuffer[0].length());
+                                       this->GetIOHook()->OnRawSocketWrite(this->fd, outbuffer[0].c_str(), outbuffer[0].length());
                                        outbuffer.pop_front();
                                }
                                catch (CoreException& modexcept)
                                {
-                                       Instance->Log(DEBUG,"%s threw an exception: %s", modexcept.GetSource(), modexcept.GetReason());
+                                       Instance->Logs->Log("SOCKET", DEBUG,"%s threw an exception: %s", modexcept.GetSource(), modexcept.GetReason());
                                        return true;
                                }
                        }
@@ -526,8 +543,10 @@ bool InspSocket::FlushWriteBuffer()
        return (fd < 0);
 }
 
-void SocketTimeout::Tick(time_t now)
+void SocketTimeout::Tick(time_t)
 {
+       ServerInstance->Logs->Log("SOCKET", DEBUG,"SocketTimeout::Tick");
+
        if (ServerInstance->SE->GetRef(this->sfd) != this->sock)
                return;
 
@@ -554,7 +573,7 @@ void SocketTimeout::Tick(time_t now)
        this->sock->Timeout = NULL;
 }
 
-bool InspSocket::Poll()
+bool BufferedSocket::Poll()
 {
        int incoming = -1;
 
@@ -582,16 +601,16 @@ bool InspSocket::Poll()
 #endif
                        this->SetState(I_CONNECTED);
 
-                       if (Instance->Config->GetIOHook(this))
+                       if (this->GetIOHook())
                        {
-                               Instance->Log(DEBUG,"Hook for raw connect");
+                               Instance->Logs->Log("SOCKET",DEBUG,"Hook for raw connect");
                                try
                                {
-                                       Instance->Config->GetIOHook(this)->OnRawSocketConnect(this->fd);
+                                       this->GetIOHook()->OnRawSocketConnect(this->fd);
                                }
                                catch (CoreException& modexcept)
                                {
-                                       Instance->Log(DEBUG,"%s threw an exception: %s", modexcept.GetSource(), modexcept.GetReason());
+                                       Instance->Logs->Log("SOCKET",DEBUG,"%s threw an exception: %s", modexcept.GetSource(), modexcept.GetReason());
                                }
                        }
                        return this->OnConnected();
@@ -615,20 +634,25 @@ bool InspSocket::Poll()
                        }
                        else
 #endif
+                       {
+                               // FIX: we were doing this for IPv6 connections as well, which was fucking recvip..
+                               // Add brackets to make this a bit clearer. -- w00t (Jan 15, 2008)
+                               recvip = inet_ntoa(((sockaddr_in*)client)->sin_addr);
+                       }
+
                        Instance->SE->NonBlocking(incoming);
 
-                       recvip = inet_ntoa(((sockaddr_in*)client)->sin_addr);
                        this->OnIncomingConnection(incoming, (char*)recvip.c_str());
 
-                       if (this->IsIOHooked)
+                       if (this->GetIOHook())
                        {
                                try
                                {
-                                       Instance->Config->GetIOHook(this)->OnRawSocketAccept(incoming, recvip.c_str(), this->port);
+                                       this->GetIOHook()->OnRawSocketAccept(incoming, recvip.c_str(), this->port);
                                }
                                catch (CoreException& modexcept)
                                {
-                                       Instance->Log(DEBUG,"%s threw an exception: %s", modexcept.GetSource(), modexcept.GetReason());
+                                       Instance->Logs->Log("SOCKET",DEBUG,"%s threw an exception: %s", modexcept.GetSource(), modexcept.GetReason());
                                }
                        }
 
@@ -648,31 +672,31 @@ bool InspSocket::Poll()
        return true;
 }
 
-void InspSocket::SetState(InspSocketState s)
+void BufferedSocket::SetState(BufferedSocketState s)
 {
        this->state = s;
 }
 
-InspSocketState InspSocket::GetState()
+BufferedSocketState BufferedSocket::GetState()
 {
        return this->state;
 }
 
-int InspSocket::GetFd()
+int BufferedSocket::GetFd()
 {
        return this->fd;
 }
 
-bool InspSocket::OnConnected() { return true; }
-void InspSocket::OnError(InspSocketError e) { return; }
-int InspSocket::OnDisconnect() { return 0; }
-int InspSocket::OnIncomingConnection(int newfd, char* ip) { return 0; }
-bool InspSocket::OnDataReady() { return true; }
-bool InspSocket::OnWriteReady() { return true; }
-void InspSocket::OnTimeout() { return; }
-void InspSocket::OnClose() { return; }
+bool BufferedSocket::OnConnected() { return true; }
+void BufferedSocket::OnError(BufferedSocketError) { return; }
+int BufferedSocket::OnDisconnect() { return 0; }
+int BufferedSocket::OnIncomingConnection(int, char*) { return 0; }
+bool BufferedSocket::OnDataReady() { return true; }
+bool BufferedSocket::OnWriteReady() { return true; }
+void BufferedSocket::OnTimeout() { return; }
+void BufferedSocket::OnClose() { return; }
 
-InspSocket::~InspSocket()
+BufferedSocket::~BufferedSocket()
 {
        this->Close();
        if (Timeout)
@@ -682,7 +706,7 @@ InspSocket::~InspSocket()
        }
 }
 
-void InspSocket::HandleEvent(EventType et, int errornum)
+void BufferedSocket::HandleEvent(EventType et, int errornum)
 {
        switch (et)
        {
@@ -732,7 +756,7 @@ void InspSocket::HandleEvent(EventType et, int errornum)
                                /* This might look wrong as if we should be actually calling
                                 * with EVENT_WRITE, but trust me it is correct. There are some
                                 * writeability-state things in the read code, because of how
-                                * InspSocket used to work regarding write buffering in previous
+                                * BufferedSocket used to work regarding write buffering in previous
                                 * versions of InspIRCd. - Brain
                                 */
                                this->HandleEvent(EVENT_READ);