version 1.15, 2004/05/13 13:27:38
|
version 1.42, 2014/11/10 16:16:47
|
|
|
//%2003//////////////////////////////////////////////////////////////////////// |
//%LICENSE//////////////////////////////////////////////////////////////// |
// | // |
// Copyright (c) 2000, 2001, 2002 BMC Software, Hewlett-Packard Development |
// Licensed to The Open Group (TOG) under one or more contributor license |
// Company, L. P., IBM Corp., The Open Group, Tivoli Systems. |
// agreements. Refer to the OpenPegasusNOTICE.txt file distributed with |
// Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L. P.; |
// this work for additional information regarding copyright ownership. |
// IBM Corp.; EMC Corporation, The Open Group. |
// Each contributor licenses this file to you under the OpenPegasus Open |
// |
// Source License; you may not use this file except in compliance with the |
// Permission is hereby granted, free of charge, to any person obtaining a copy |
// License. |
// of this software and associated documentation files (the "Software"), to |
|
// deal in the Software without restriction, including without limitation the |
|
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or |
|
// sell copies of the Software, and to permit persons to whom the Software is |
|
// furnished to do so, subject to the following conditions: |
|
// |
|
// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN |
|
// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED |
|
// "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT |
|
// LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR |
|
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT |
|
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN |
|
// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION |
|
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
|
// | // |
//============================================================================== |
// Permission is hereby granted, free of charge, to any person obtaining a |
|
// copy of this software and associated documentation files (the "Software"), |
|
// to deal in the Software without restriction, including without limitation |
|
// the rights to use, copy, modify, merge, publish, distribute, sublicense, |
|
// and/or sell copies of the Software, and to permit persons to whom the |
|
// Software is furnished to do so, subject to the following conditions: |
// | // |
// Author: Mike Brasher (mbrasher@bmc.com) |
// The above copyright notice and this permission notice shall be included |
|
// in all copies or substantial portions of the Software. |
// | // |
// Modified By: |
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
|
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
|
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
|
// IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY |
|
// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, |
|
// TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE |
|
// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
|
// |
|
////////////////////////////////////////////////////////////////////////// |
// | // |
//%///////////////////////////////////////////////////////////////////////////// | //%///////////////////////////////////////////////////////////////////////////// |
| |
#include "Socket.h" | #include "Socket.h" |
|
#include "Network.h" |
#ifdef PEGASUS_OS_TYPE_WINDOWS |
|
#include <windows.h> |
|
# ifndef _WINSOCKAPI_ |
|
# include <winsock2.h> |
|
# endif |
|
#else |
|
# include <cctype> | # include <cctype> |
#ifndef PEGASUS_OS_OS400 |
#include <cstring> |
# include <unistd.h> |
|
#else |
|
# include <unistd.cleinc> |
|
#endif |
|
# include <string.h> // added by rk for memcpy |
|
# include <cstdlib> |
|
# include <errno.h> |
|
# include <fcntl.h> |
|
# include <netdb.h> |
|
# include <netinet/in.h> |
|
# include <arpa/inet.h> |
|
# include <sys/socket.h> |
|
# include <errno.h> |
|
#endif |
|
|
|
#include <Pegasus/Common/Sharable.h> | #include <Pegasus/Common/Sharable.h> |
|
#include <Pegasus/Common/Logger.h> |
|
#include <Pegasus/Common/System.h> |
|
#include <Pegasus/Common/Tracer.h> |
|
#include <Pegasus/Common/Threads.h> |
|
#include <Pegasus/Common/Mutex.h> |
|
|
PEGASUS_NAMESPACE_BEGIN | PEGASUS_NAMESPACE_BEGIN |
| |
|
#ifdef PEGASUS_OS_TYPE_WINDOWS |
static Uint32 _socketInterfaceRefCount = 0; | static Uint32 _socketInterfaceRefCount = 0; |
|
static Mutex _socketInterfaceRefCountLock; |
|
#endif |
| |
Sint32 Socket::read(Sint32 socket, void* ptr, Uint32 size) |
Boolean Socket::timedConnect( |
|
SocketHandle socket, |
|
sockaddr* address, |
|
int addressLength, |
|
Uint32 timeoutMilliseconds) |
{ | { |
|
int connectResult; |
#ifdef PEGASUS_OS_TYPE_WINDOWS | #ifdef PEGASUS_OS_TYPE_WINDOWS |
return ::recv(socket, (char*)ptr, size, 0); |
connectResult = ::connect(socket, address, addressLength); |
#else |
|
#if defined (__GNUC__) && !defined(PEGASUS_OS_SOLARIS) && !defined(PEGASUS_OS_DARWIN) |
|
int ccode = TEMP_FAILURE_RETRY(::read(socket, (char*)ptr, size)); |
|
return ccode; |
|
#else | #else |
return ::read(socket, (char*)ptr, size); |
Uint32 maxConnectAttempts = 100; |
#endif |
// Retry the connect() until it succeeds or it fails with an error other |
|
// than EINTR, EAGAIN (for Linux), or ECONNREFUSED (for HP-UX and z/OS). |
|
while (((connectResult = ::connect(socket, address, addressLength)) == -1) |
|
&& (maxConnectAttempts-- > 0) |
|
&& ((errno == EINTR) || (errno == EAGAIN) || |
|
(errno == ECONNREFUSED))) |
|
{ |
|
Threads::sleep(1); |
|
} |
#endif | #endif |
|
|
|
if (connectResult == 0) |
|
{ |
|
return true; |
} | } |
| |
Sint32 Socket::write(Sint32 socket, const void* ptr, Uint32 size) |
if (getSocketError() == PEGASUS_NETWORK_EINPROGRESS) |
{ | { |
|
PEG_TRACE((TRC_HTTP, Tracer::LEVEL4, |
|
"Connection to server in progress. Waiting up to %u milliseconds " |
|
"for the socket to become connected.", |
|
timeoutMilliseconds)); |
|
|
|
fd_set fdwrite; |
|
FD_ZERO(&fdwrite); |
|
FD_SET(socket, &fdwrite); |
|
struct timeval timeoutValue = |
|
{ timeoutMilliseconds/1000, timeoutMilliseconds%1000*1000 }; |
|
int selectResult = -1; |
|
|
#ifdef PEGASUS_OS_TYPE_WINDOWS | #ifdef PEGASUS_OS_TYPE_WINDOWS |
return ::send(socket, (const char*)ptr, size, 0); |
PEGASUS_RETRY_SYSTEM_CALL( |
#else |
select(FD_SETSIZE, NULL, &fdwrite, &fdwrite, &timeoutValue), |
#if (__GNUC__) && !defined(PEGASUS_OS_SOLARIS) && !defined(PEGASUS_OS_DARWIN) |
selectResult); |
int ccode = TEMP_FAILURE_RETRY(::write(socket, (char*)ptr, size)); |
|
return ccode; |
|
#else | #else |
return ::write(socket, (char*)ptr, size); |
PEGASUS_RETRY_SYSTEM_CALL( |
#endif |
select(FD_SETSIZE, NULL, &fdwrite, NULL, &timeoutValue), |
|
selectResult); |
#endif | #endif |
|
if (selectResult == 0) |
|
{ |
|
PEG_TRACE_CSTRING(TRC_HTTP, Tracer::LEVEL1, |
|
"select() timed out waiting for the socket connection to be " |
|
"established."); |
|
return false; |
|
} |
|
else if (selectResult > 0) |
|
{ |
|
int optval; |
|
SocketLength optlen = sizeof(int); |
|
getsockopt(socket, SOL_SOCKET, SO_ERROR, (char*)&optval, &optlen); |
|
if (optval == 0) |
|
{ |
|
PEG_TRACE_CSTRING(TRC_HTTP, Tracer::LEVEL4, |
|
"Connection with server established."); |
|
return true; |
|
} |
|
else |
|
{ |
|
PEG_TRACE((TRC_HTTP, Tracer::LEVEL1, |
|
"Did not connect, getsockopt() returned optval = %d", |
|
optval)); |
|
return false; |
|
} |
|
} |
|
else |
|
{ |
|
PEG_TRACE((TRC_HTTP, Tracer::LEVEL1, |
|
"select() returned error code %d", |
|
getSocketError())); |
|
return false; |
|
} |
} | } |
| |
void Socket::close(Sint32 socket) |
PEG_TRACE((TRC_HTTP, Tracer::LEVEL1, |
|
"connect() returned error code %d", |
|
getSocketError())); |
|
return false; |
|
} |
|
|
|
Sint32 Socket::read(SocketHandle socket, void* ptr, Uint32 size) |
{ | { |
#ifdef PEGASUS_OS_TYPE_WINDOWS | #ifdef PEGASUS_OS_TYPE_WINDOWS |
closesocket(socket); |
return ::recv(socket, (char*)ptr, size, 0); |
#else |
|
#if (__GNUC__) && !defined(PEGASUS_OS_SOLARIS) && !defined(PEGASUS_OS_DARWIN) |
|
TEMP_FAILURE_RETRY(::close(socket)); |
|
#else | #else |
::close(socket); |
int status; |
#endif |
PEGASUS_RETRY_SYSTEM_CALL(::read(socket, (char*)ptr, size), status); |
|
return status; |
#endif | #endif |
} | } |
| |
int Socket::close2(Sint32 socket) |
Sint32 Socket::peek(SocketHandle socket, void* ptr, Uint32 size) |
{ | { |
#ifdef PEGASUS_OS_TYPE_WINDOWS | #ifdef PEGASUS_OS_TYPE_WINDOWS |
return closesocket(socket); |
return ::recv(socket, (char*)ptr, size, MSG_PEEK); |
#else |
|
#if (__GNUC__) && !defined(PEGASUS_OS_SOLARIS) && !defined(PEGASUS_OS_DARWIN) |
|
int ccode = TEMP_FAILURE_RETRY(::close(socket)); |
|
return ccode; |
|
#else | #else |
return ::close(socket); |
int status; |
#endif |
PEGASUS_RETRY_SYSTEM_CALL(::recv(socket, (char*)ptr, size, MSG_PEEK), |
|
status); |
|
return status; |
#endif | #endif |
} | } |
| |
|
Sint32 Socket::write(SocketHandle socket, const void* ptr, Uint32 size) |
|
{ |
|
#ifdef PEGASUS_OS_TYPE_WINDOWS |
|
return ::send(socket, (const char*)ptr, size, 0); |
|
#else |
|
int status; |
|
PEGASUS_RETRY_SYSTEM_CALL(::write(socket, (char*)ptr, size), status); |
|
return status; |
|
#endif |
|
} |
| |
void Socket::enableBlocking(Sint32 socket) |
Sint32 Socket::timedWrite( |
|
SocketHandle socket, |
|
const void* ptr, |
|
Uint32 size, |
|
Uint32 socketWriteTimeout) |
|
{ |
|
Sint32 bytesWritten = 0; |
|
Sint32 totalBytesWritten = 0; |
|
Boolean socketTimedOut = false; |
|
int selreturn = 0; |
|
while (1) |
{ | { |
#ifdef PEGASUS_OS_TYPE_WINDOWS | #ifdef PEGASUS_OS_TYPE_WINDOWS |
unsigned long flag = 0; |
PEGASUS_RETRY_SYSTEM_CALL( |
ioctlsocket(socket, FIONBIO, &flag); |
::send(socket, (const char*)ptr, size, 0), bytesWritten); |
#else | #else |
int flags = fcntl(socket, F_GETFL, 0); |
PEGASUS_RETRY_SYSTEM_CALL( |
flags &= ~O_NONBLOCK; |
::write(socket, (char*)ptr, size), bytesWritten); |
fcntl(socket, F_SETFL, flags); |
|
#endif | #endif |
|
// Some data written this cycle ? |
|
// Add it to the total amount of written data. |
|
if (bytesWritten > 0) |
|
{ |
|
totalBytesWritten += bytesWritten; |
|
socketTimedOut = false; |
} | } |
| |
int Socket::enableBlocking2(Sint32 socket) |
// All data written ? return amount of data written |
|
if ((Uint32)bytesWritten == size) |
{ | { |
|
return totalBytesWritten; |
|
} |
|
// If data has been written partially, we resume writing data |
|
// this also accounts for the case of a signal interrupt |
|
// (i.e. errno = EINTR) |
|
if (bytesWritten > 0) |
|
{ |
|
size -= bytesWritten; |
|
ptr = (void *)((char *)ptr + bytesWritten); |
|
continue; |
|
} |
|
// Something went wrong |
|
if (bytesWritten == PEGASUS_SOCKET_ERROR) |
|
{ |
|
// if we already waited for the socket to get ready, bail out |
|
if (socketTimedOut) return bytesWritten; |
#ifdef PEGASUS_OS_TYPE_WINDOWS | #ifdef PEGASUS_OS_TYPE_WINDOWS |
unsigned long flag = 0; |
if (WSAGetLastError() == WSAEWOULDBLOCK) |
return ioctlsocket(socket, FIONBIO, &flag); |
|
#else | #else |
int flags = fcntl(socket, F_GETFL, 0); |
if (errno == EAGAIN || errno == EWOULDBLOCK) |
flags &= ~O_NONBLOCK; |
|
return fcntl(socket, F_SETFL, flags); |
|
#endif | #endif |
|
{ |
|
fd_set fdwrite; |
|
// max. timeout seconds waiting for the socket to get ready |
|
struct timeval tv = { socketWriteTimeout, 0 }; |
|
FD_ZERO(&fdwrite); |
|
FD_SET(socket, &fdwrite); |
|
selreturn = select(FD_SETSIZE, NULL, &fdwrite, NULL, &tv); |
|
if (selreturn == 0) socketTimedOut = true; // ran out of time |
|
continue; |
|
} |
|
return bytesWritten; |
|
} |
|
} |
} | } |
| |
void Socket::disableBlocking(Sint32 socket) |
void Socket::close(SocketHandle& socket) |
|
{ |
|
if (socket != PEGASUS_INVALID_SOCKET) |
{ | { |
#ifdef PEGASUS_OS_TYPE_WINDOWS | #ifdef PEGASUS_OS_TYPE_WINDOWS |
unsigned long flag = 1; |
if (!closesocket(socket)) |
ioctlsocket(socket, FIONBIO, &flag); |
{ |
|
socket = PEGASUS_INVALID_SOCKET; |
|
} |
#else | #else |
int flags = fcntl(socket, F_GETFL, 0); |
int status; |
flags |= O_NONBLOCK; |
PEGASUS_RETRY_SYSTEM_CALL(::close(socket), status); |
fcntl(socket, F_SETFL, flags); |
|
|
if (status == 0) |
|
{ |
|
socket = PEGASUS_INVALID_SOCKET; |
|
} |
#endif | #endif |
} | } |
|
} |
| |
int Socket::disableBlocking2(Sint32 socket) |
void Socket::disableBlocking(SocketHandle socket) |
{ | { |
#ifdef PEGASUS_OS_TYPE_WINDOWS | #ifdef PEGASUS_OS_TYPE_WINDOWS |
unsigned long flag = 1; |
unsigned long flag = 1; // Use "flag = 0" to enable blocking |
return ioctlsocket(socket, FIONBIO, &flag); |
ioctlsocket(socket, FIONBIO, &flag); |
|
#elif PEGASUS_OS_VMS |
|
int flag=1; // Use "flag = 0" to enable blocking |
|
ioctl(socket, FIONBIO, &flag); |
#else | #else |
int flags = fcntl(socket, F_GETFL, 0); | int flags = fcntl(socket, F_GETFL, 0); |
flags |= O_NONBLOCK; |
flags |= O_NONBLOCK; // Use "flags &= ~O_NONBLOCK" to enable blocking |
return fcntl(socket, F_SETFL, flags); |
fcntl(socket, F_SETFL, flags); |
#endif | #endif |
} | } |
| |
void Socket::initializeInterface() | void Socket::initializeInterface() |
{ | { |
#ifdef PEGASUS_OS_TYPE_WINDOWS | #ifdef PEGASUS_OS_TYPE_WINDOWS |
|
AutoMutex mtx(_socketInterfaceRefCountLock); |
if (_socketInterfaceRefCount == 0) | if (_socketInterfaceRefCount == 0) |
{ | { |
WSADATA tmp; | WSADATA tmp; |
| |
if (WSAStartup(0x202, &tmp) == SOCKET_ERROR) |
int err = WSAStartup(0x202, &tmp); |
WSACleanup(); |
if (err != 0) |
|
{ |
|
throw Exception(MessageLoaderParms( |
|
"Common.Socket.WSASTARTUP_FAILED.WINDOWS", |
|
"WSAStartup failed with error $0.", |
|
err)); |
|
} |
} | } |
| |
_socketInterfaceRefCount++; | _socketInterfaceRefCount++; |
|
|
void Socket::uninitializeInterface() | void Socket::uninitializeInterface() |
{ | { |
#ifdef PEGASUS_OS_TYPE_WINDOWS | #ifdef PEGASUS_OS_TYPE_WINDOWS |
|
AutoMutex mtx(_socketInterfaceRefCountLock); |
_socketInterfaceRefCount--; | _socketInterfaceRefCount--; |
| |
if (_socketInterfaceRefCount == 0) | if (_socketInterfaceRefCount == 0) |
|
|
#endif | #endif |
} | } |
| |
|
//------------------------------------------------------------------------------ |
|
// |
|
// _setTCPNoDelay() |
|
// |
|
//------------------------------------------------------------------------------ |
| |
PEGASUS_NAMESPACE_END |
inline void _setTCPNoDelay(SocketHandle socket) |
|
{ |
|
// This function disables "Nagle's Algorithm" also known as "the TCP delay |
|
// algorithm", which causes read operations to obtain whatever data is |
|
// already in the input queue and then wait a little longer to see if |
|
// more data arrives. This algorithm optimizes the case in which data is |
|
// sent in only one direction but severely impairs performance of round |
|
// trip servers. Disabling TCP delay is a standard technique for round |
|
// trip servers. |
|
|
|
int opt = 1; |
|
setsockopt(socket, IPPROTO_TCP, TCP_NODELAY, (char*)&opt, sizeof(opt)); |
|
} |
|
|
|
#ifdef PEGASUS_OS_ZOS |
|
inline void _setInformIfNewTCPIP(SocketHandle socket) |
|
{ |
|
// This function enables the notification of the CIM Server that a new |
|
// TCPIP transport layer is active. This is needed to be aware of a |
|
// restart of the transport layer. When this option is in effect, |
|
// the accetp(), select(), and read() request will receive an errno=EIO. |
|
// Once this happens, the socket should be closed and create a new. |
|
|
|
int NewTcpipOn = 1; |
|
setibmsockopt( |
|
socket, |
|
SOL_SOCKET, |
|
SO_EioIfNewTP, |
|
(char*)&NewTcpipOn, |
|
sizeof(NewTcpipOn)); |
|
} |
|
#else |
|
inline void _setInformIfNewTCPIP(SocketHandle) |
|
{ |
|
} |
|
#endif |
|
|
|
|
|
SocketHandle Socket::createSocket(int domain, int type, int protocol) |
|
{ |
|
SocketHandle newSocket; |
|
|
|
if (domain == AF_UNIX) |
|
{ |
|
return socket(domain,type,protocol); |
|
} |
|
|
|
#ifdef PEGASUS_OS_ZOS |
|
bool sendTcpipMsg = true; |
|
#endif |
|
|
|
while (1) |
|
{ |
|
newSocket = socket(domain,type,protocol); |
|
|
|
if ((newSocket != PEGASUS_INVALID_SOCKET) || |
|
(getSocketError() != PEGASUS_NETWORK_TRYAGAIN)) |
|
{ |
|
break; |
|
} |
| |
|
#ifdef PEGASUS_OS_ZOS |
|
// The program should wait for transport layer to become ready. |
|
|
|
if (sendTcpipMsg) |
|
{ |
|
Logger::put_l( |
|
Logger::STANDARD_LOG, System::CIMSERVER, Logger::INFORMATION, |
|
MessageLoaderParms( |
|
"Common.Socket.WAIT_FOR_TCPIP", |
|
"TCP/IP temporary unavailable.")); |
|
sendTcpipMsg = false; |
|
} |
|
|
|
System::sleep(30); |
|
#endif |
|
} // wait for the transport layer become ready. |
|
|
|
// Is the socket in an unrecoverable error ? |
|
if (newSocket == PEGASUS_INVALID_SOCKET) |
|
{ |
|
// return immediate |
|
return PEGASUS_INVALID_SOCKET; |
|
} |
|
else |
|
{ |
|
// set aditional socket options |
|
_setTCPNoDelay(newSocket); |
|
_setInformIfNewTCPIP(newSocket); |
|
|
|
return newSocket; |
|
} |
|
} |
|
|
|
PEGASUS_NAMESPACE_END |