OW_Win32SocketBaseImpl.cpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2001-2004 Vintela, Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
*  - Redistributions of source code must retain the above copyright notice,
*    this list of conditions and the following disclaimer.
*
*  - Redistributions in binary form must reproduce the above copyright notice,
*    this list of conditions and the following disclaimer in the documentation
*    and/or other materials provided with the distribution.
*
*  - Neither the name of Vintela, Inc. nor the names of its
*    contributors may be used to endorse or promote products derived from this
*    software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL Vintela, Inc. OR THE CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/

#include "OW_config.h"

#if defined(OW_WIN32)

#include "OW_SocketBaseImpl.hpp"
#include "OW_SocketUtils.hpp"
#include "OW_Format.hpp"
#include "OW_Assertion.hpp"
#include "OW_IOException.hpp"
#include "OW_Mutex.hpp"
#include "OW_MutexLock.hpp"
#include "OW_PosixUnnamedPipe.hpp"
#include "OW_Socket.hpp"
#include "OW_Thread.hpp"
#include "OW_System.hpp"

#include <cstdio>
#include <cerrno>
#include <fstream>
#include <ws2tcpip.h>

namespace
{

class SockInitializer
{
public:
   SockInitializer()
   {
      WSADATA wsaData;
      ::WSAStartup(MAKEWORD(2,2), &wsaData);
   }

   ~SockInitializer()
   {
      ::WSACleanup();
   }
};

// Force Winsock initialization on load
SockInitializer _sockInitializer;

void
_closeSocket(SOCKET& sockfd)
{
   if (sockfd != INVALID_SOCKET)
   {
      ::closesocket(sockfd);
      sockfd = INVALID_SOCKET;
   }
}

int
getAddrFromIface(OW_NAMESPACE::InetSocketAddress_t& addr)
{
   SOCKET sd = ::socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
    if (sd == SOCKET_ERROR)
   {
      return -1;
    }

   int cc = -1;
    INTERFACE_INFO interfaceList[20];
    unsigned long nBytesReturned;
   if (::WSAIoctl(sd, SIO_GET_INTERFACE_LIST, 0, 0, &interfaceList,
         sizeof(interfaceList), &nBytesReturned, 0, 0) != SOCKET_ERROR)
   {
      int nNumInterfaces = nBytesReturned / sizeof(INTERFACE_INFO);
      for (int i = 0; i < nNumInterfaces; ++i)
      {
         u_long nFlags = interfaceList[i].iiFlags;
         if (nFlags & IFF_UP)
         {
            cc = 0;
            ::memcpy(&addr, &(interfaceList[i].iiAddress), sizeof(addr));
            if (!(nFlags & IFF_LOOPBACK))
            {
               break;
            }
         }
      }
   }

   ::closesocket(sd);
    return 0;
}

}  // end of unnamed namespace

namespace OW_NAMESPACE
{

using std::istream;
using std::ostream;
using std::iostream;
using std::ifstream;
using std::ofstream;
using std::fstream;
using std::ios;
String SocketBaseImpl::m_traceFileOut;
String SocketBaseImpl::m_traceFileIn;

// static
int
SocketBaseImpl::waitForEvent(HANDLE eventArg, int secsToTimeout)
{
   DWORD timeout = (secsToTimeout != -1)
      ? static_cast<DWORD>(secsToTimeout * 1000)
      : INFINITE;
   
   int cc;
   if(Socket::getShutDownMechanism() != NULL)
   {
      HANDLE events[2];
      events[0] = Socket::getShutDownMechanism();
      events[1] = eventArg;

      DWORD index = ::WaitForMultipleObjects(
         2,
         events,
         FALSE,
         timeout);

      switch (index)
      {
         case WAIT_FAILED:
            cc = -2;
            break;
         case WAIT_TIMEOUT:
            cc = -1;
            break;
         default:
            index -= WAIT_OBJECT_0;
            // If not shutdown event, then reset
            if (index != 0)
            {
               ::ResetEvent(eventArg);
            }
            cc = static_cast<int>(index);
            break;
      }
   }
   else
   {
      switch(::WaitForSingleObject(eventArg, timeout))
      {
         case WAIT_OBJECT_0:
            ::ResetEvent(eventArg);
            cc = 1;
            break;
         case WAIT_TIMEOUT:
            cc = -1;
            break;
         default:
            cc = -2;
            break;
      }
   }
      
   return cc;
}

#pragma warning (push)
#pragma warning (disable: 4355)

SocketBaseImpl::SocketBaseImpl()
   : SelectableIFC()
   , IOIFC()
   , m_isConnected(false)
   , m_sockfd(INVALID_SOCKET)
   , m_localAddress()
   , m_peerAddress()
   , m_event(NULL)
   , m_recvTimeoutExprd(false)
   , m_streamBuf(this)
   , m_in(&m_streamBuf)
   , m_out(&m_streamBuf)
   , m_inout(&m_streamBuf)
   , m_recvTimeout(-1)
   , m_sendTimeout(-1)
   , m_connectTimeout(0)
{
   m_out.exceptions(std::ios::badbit);
   m_inout.exceptions(std::ios::badbit);
   m_event = ::CreateEvent(NULL, TRUE, FALSE, NULL);
   OW_ASSERT(m_event != NULL);
}
SocketBaseImpl::SocketBaseImpl(SocketHandle_t fd,
      SocketAddress::AddressType addrType)
   : SelectableIFC()
   , IOIFC()
   , m_isConnected(true)
   , m_sockfd(fd)
   , m_localAddress(SocketAddress::getAnyLocalHost())
   , m_peerAddress(SocketAddress::allocEmptyAddress(addrType))
   , m_event(NULL)
   , m_recvTimeoutExprd(false)
   , m_streamBuf(this)
   , m_in(&m_streamBuf)
   , m_out(&m_streamBuf)
   , m_inout(&m_streamBuf)
   , m_recvTimeout(-1)
   , m_sendTimeout(-1)
   , m_connectTimeout(0)
{
   OW_ASSERT(addrType == SocketAddress::INET);

   m_out.exceptions(std::ios::badbit);
   m_inout.exceptions(std::ios::badbit);
   m_event = ::CreateEvent(NULL, TRUE, FALSE, NULL);
   OW_ASSERT(m_event != NULL);
   fillInetAddrParms();
}
SocketBaseImpl::SocketBaseImpl(const SocketAddress& addr)
   : SelectableIFC()
   , IOIFC()
   , m_isConnected(false)
   , m_sockfd(INVALID_SOCKET)
   , m_localAddress(SocketAddress::getAnyLocalHost())
   , m_peerAddress(addr)
   , m_event(NULL)
   , m_recvTimeoutExprd(false)
   , m_streamBuf(this)
   , m_in(&m_streamBuf)
   , m_out(&m_streamBuf)
   , m_inout(&m_streamBuf)
   , m_recvTimeout(-1)
   , m_sendTimeout(-1)
   , m_connectTimeout(0)
{
   m_out.exceptions(std::ios::badbit);
   m_inout.exceptions(std::ios::badbit);
   m_event = ::CreateEvent(NULL, TRUE, FALSE, NULL);
   OW_ASSERT(m_event != NULL);
   connect(m_peerAddress);
}

#pragma warning (pop)

SocketBaseImpl::~SocketBaseImpl()
{
   try
   {
      disconnect();
   }
   catch (...)
   {
      // don't let exceptions escape
   }
   ::CloseHandle(m_event);
}
Select_t
SocketBaseImpl::getSelectObj() const
{
   Select_t st;
   st.event = m_event;
   st.sockfd = m_sockfd;
   st.networkevents = FD_READ | FD_WRITE;
   st.doreset = true;
   return st;
}
void
SocketBaseImpl::connect(const SocketAddress& addr)
{
   if (m_isConnected)
   {
      disconnect();
   }
   m_streamBuf.reset();
   m_in.clear();
   m_out.clear();
   m_inout.clear();
   OW_ASSERT(addr.getType() == SocketAddress::INET);

   m_sockfd = ::socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
   if (m_sockfd == INVALID_SOCKET)
   {
      OW_THROW(SocketException, 
         Format("Failed to create a socket: %1",
         System::lastErrorMsg(true)).c_str());
   }

   int cc;
   WSANETWORKEVENTS networkEvents;

   // Connect non-blocking
   if(::WSAEventSelect(m_sockfd, m_event, FD_CONNECT) != 0)
   {
      OW_THROW(SocketException, 
         Format("WSAEventSelect Failed: %1",
         System::lastErrorMsg(true)).c_str());
   }

   if (::connect(m_sockfd, addr.getNativeForm(), addr.getNativeFormSize())
      == SOCKET_ERROR)
   {
      int lastError = ::WSAGetLastError();
        if (lastError != WSAEWOULDBLOCK && lastError != WSAEINPROGRESS)
      {
         _closeSocket(m_sockfd);
         OW_THROW(SocketException,
            Format("Failed to connect to: %1: %2(%3)", addr.toString(),
               lastError, System::lastErrorMsg(true)).c_str());
      }

      int tmoutval = (m_connectTimeout > 0) ? m_connectTimeout : INFINITE;

      // Wait for connection event to come through
      while (true)
      {
         // Wait for the socket's event to get signaled
         if ((cc = waitForEvent(m_event, tmoutval)) < 1)
         {
            _closeSocket(m_sockfd);
            switch (cc)
            {
               case 0:     // Shutdown event
                  OW_THROW(SocketException,
                     "Sockets have been shutdown");
               case -1: // Timed out
                  OW_THROW(SocketException,
                     Format("Win32SocketBaseImpl connection"
                        " timed out. Timeout val = %1",
                        m_connectTimeout).c_str());
               default: // Error on wait
                  OW_THROW(SocketException, Format("SocketBaseImpl::"
                     "connect() wait failed: %1(%2)",
                     ::WSAGetLastError(),
                     System::lastErrorMsg(true)).c_str());
            }
         }

         // Find out what network event took place
         if (::WSAEnumNetworkEvents(m_sockfd, m_event, &networkEvents)
            == SOCKET_ERROR)
         {
            _closeSocket(m_sockfd);
            OW_THROW(SocketException,
               Format("SocketBaseImpl::connect()"
                  " failed getting network events: %1(%2)",
                  ::WSAGetLastError(),
                  System::lastErrorMsg(true)).c_str());
         }

         // Was it a connect event?
         if (networkEvents.lNetworkEvents & FD_CONNECT)
         {
            // Did connect fail?
            if (networkEvents.iErrorCode[FD_CONNECT_BIT])
            {
               ::WSASetLastError(networkEvents.iErrorCode[FD_CONNECT_BIT]);
               _closeSocket(m_sockfd);
                    OW_THROW(SocketException,
                  Format("SocketBaseImpl::connect() failed: %1(%2)",
                  ::WSAGetLastError(),
                  System::lastErrorMsg(true)).c_str());
            }
            break;
         }
      }  // while (true) - waiting for connection event
   }  // if SOCKET_ERROR on connect

   // Set socket back to blocking
   if(::WSAEventSelect(m_sockfd, m_event, 0) != 0)
   {
      _closeSocket(m_sockfd);
      OW_THROW(SocketException, 
         Format("Resetting socket with WSAEventSelect Failed: %1",
         System::lastErrorMsg(true)).c_str());
   }
   u_long ioctlarg = 0;
   ::ioctlsocket(m_sockfd, FIONBIO, &ioctlarg);

   m_isConnected = true;

   m_peerAddress = addr; // To get the hostname from addr

   OW_ASSERT(addr.getType() == SocketAddress::INET);

   fillInetAddrParms();
}

void
SocketBaseImpl::disconnect()
{
   if(m_in)
   {
      m_in.clear(ios::eofbit);
   }
   if(m_out)
   {
        m_out.clear(ios::eofbit);
   }
   if(!m_inout.fail())
   {
      m_inout.clear(ios::eofbit);
   }

   ::SetEvent(m_event);
   _closeSocket(m_sockfd);
   m_isConnected = false;
}

void
SocketBaseImpl::fillInetAddrParms()
{
   socklen_t len;
   InetSocketAddress_t addr;
   ::memset(&addr, 0, sizeof(addr));
   len = sizeof(addr);
   bool gotAddr = false;

   if (m_sockfd != INVALID_SOCKET)
   {
      len = sizeof(addr);
      if (::getsockname(m_sockfd,
         reinterpret_cast<struct sockaddr*>(&addr), &len) != SOCKET_ERROR)
      {
         m_localAddress.assignFromNativeForm(&addr, len);
      }
      else if (getAddrFromIface(addr) == 0)
      {
         len = sizeof(addr);
         m_localAddress.assignFromNativeForm(&addr, len);
      }

      len = sizeof(addr);
      if (::getpeername(m_sockfd, reinterpret_cast<struct sockaddr*>(&addr),
         &len) != SOCKET_ERROR)
      {
         m_peerAddress.assignFromNativeForm(&addr, len);
      }
   }
   else if (getAddrFromIface(addr) == 0)
   {
      m_localAddress.assignFromNativeForm(&addr, len);
   }
}

static Mutex guard;
int
SocketBaseImpl::write(const void* dataOut, int dataOutLen, bool errorAsException)
{
   int rc = 0;
   bool isError = false;
   if (m_isConnected)
   {
      isError = waitForOutput(m_sendTimeout);
      if (isError)
      {
         rc = -1;
      }
      else
      {
         rc = writeAux(dataOut, dataOutLen);
         if (!m_traceFileOut.empty() && rc > 0)
         {
            MutexLock ml(guard);
            ofstream traceFile(m_traceFileOut.c_str(), std::ios::app);
            if (!traceFile)
            {
               OW_THROW(IOException, "Failed opening socket dump file");
            }
            if (!traceFile.write(static_cast<const char*>(dataOut), rc))
            {
               OW_THROW(IOException, "Failed writing to socket dump");
            }

            ofstream comboTraceFile(String(m_traceFileOut + "Combo").c_str(), std::ios::app);
            if (!comboTraceFile)
            {
               OW_THROW(IOException, "Failed opening socket dump file");
            }
            comboTraceFile << "\n--->Out " << rc << " bytes<---\n";
            if (!comboTraceFile.write(static_cast<const char*>(dataOut), rc))
            {
               OW_THROW(IOException, "Failed writing to socket dump");
            }
         }
      }
   }
   else
   {
      rc = -1;
   }
   if (rc < 0 && errorAsException)
   {
      OW_THROW(SocketException, "SocketBaseImpl::write");
   }
   return rc;
}
int
SocketBaseImpl::read(void* dataIn, int dataInLen, bool errorAsException)   
{
   int rc = 0;
   bool isError = false;
   if (m_isConnected)
   {
      isError = waitForInput(m_recvTimeout);
      if (isError)
      {
         rc = -1;
      }
      else
      {
         rc = readAux(dataIn, dataInLen);
         if (!m_traceFileIn.empty() && rc > 0)
         {
            MutexLock ml(guard);
            ofstream traceFile(m_traceFileIn.c_str(), std::ios::app);
            if (!traceFile)
            {
               OW_THROW(IOException, "Failed opening tracefile");
            }
            if (!traceFile.write(reinterpret_cast<const char*>(dataIn), rc))
            {
               OW_THROW(IOException, "Failed writing to socket dump");
            }

            ofstream comboTraceFile(String(m_traceFileOut + "Combo").c_str(), std::ios::app);
            if (!comboTraceFile)
            {
               OW_THROW(IOException, "Failed opening socket dump file");
            }
            comboTraceFile << "\n--->In " << rc << " bytes<---\n";
            if (!comboTraceFile.write(reinterpret_cast<const char*>(dataIn), rc))
            {
               OW_THROW(IOException, "Failed writing to socket dump");
            }
         }
      }
   }
   else
   {
      rc = -1;
   }
   if (rc < 0)
   {
      if (errorAsException)
         OW_THROW(SocketException, "SocketBaseImpl::read");
   }
   return rc;
}
bool
SocketBaseImpl::waitForInput(int timeOutSecs)
{
   int rval = SocketUtils::waitForIO(m_sockfd, m_event, timeOutSecs, FD_READ);
   if (rval == ETIMEDOUT)
   {
      m_recvTimeoutExprd = true;
   }
   else
   {
      m_recvTimeoutExprd = false;
   }
   return (rval != 0);
}
bool
SocketBaseImpl::waitForOutput(int timeOutSecs)
{
   return SocketUtils::waitForIO(m_sockfd, m_event, timeOutSecs,
      FD_WRITE) != 0;
}
istream&
SocketBaseImpl::getInputStream()
{
   return m_in;
}
ostream&
SocketBaseImpl::getOutputStream()
{
   return m_out;
}
iostream&
SocketBaseImpl::getIOStream()
{
   return m_inout;
}
// STATIC
void
SocketBaseImpl::setDumpFiles(const String& in, const String& out)
{
   m_traceFileOut = out;
   m_traceFileIn = in;
}

} // end namespace OW_NAMESPACE

#endif   // #if defined(OW_WIN32)

---