src/network/nSocket.cpp File Reference

#include "nSocket.h"
#include "aa_config.h"
#include "tRandom.h"
#include "tSysTime.h"
#include <string>
#include <stdio.h>
#include <string.h>
#include <sys/types.h>
#include <errno.h>
#include <stdlib.h>
#include <vector>
#include <arpa/inet.h>
#include <netinet/ip.h>
#include <netinet/in_systm.h>
#include <netinet/in.h>
#include <netdb.h>
#include <sys/param.h>
#include <sys/ioctl.h>
#include <sys/socket.h>
#include "tConfiguration.h"
#include "tRecorder.h"

Include dependency graph for nSocket.cpp:

Go to the source code of this file.

Classes
class	OneSocketOpened
	Exception to throw when a single socket was opened by request. More...
struct	nSocketType
	structure defining a socket type More...
struct	nHostInfo
	all information to reach a host More...
class	BindArchiver< Archiver >
class	ReadArchiver< Archiver >
	Read or write network read data. More...
Defines
#define	MAXHOSTNAMELEN   256
#define	NET_NAMELEN   100
Typedefs
typedef std::vector< nHostInfo >	nHostList
typedef int	NET_SIZE
typedef int	Socket
Enumerations
enum	nSocketError { nSocketError_Ignore, nSocketError_Reset }
Functions
std::istream &	operator>> (std::istream &s, nAddress &address)
std::istream &	operator>> (std::istream &s, nSocketType &type)
std::istream &	operator>> (std::istream &s, nHostInfo &hostInfo)
std::ostream &	operator<< (std::ostream &s, nAddress const &address)
std::ostream &	operator<< (std::ostream &s, nSocketType const &type)
std::ostream &	operator<< (std::ostream &s, nHostInfo const &hostInfo)
	tRECORD_AS (nSocketError, int)
char *	ANET_AddrToString (const struct sockaddr *addr)
int	ANET_GetSocketAddr (int sock, struct sockaddr *addr)
static void	Sys_Error (const char *x)
static void	Con_Printf (const char *x)
static void	Con_SafePrintf (const char *x)
static void	Con_DPrintf (const char *x)
static nSocketError	ANET_Error ()
static nOSNetworking const &	sn_InitOSNetworking ()
	initialize OS networking system and automatically shut it down later
tString const &	GetMyHostName ()
	determine name of this host
bool	ANET_ListenOn (nHostList const &addresses, nSocketListener::SocketArray &sockets, bool onesocketonly, bool ignoreErrors)
void	ANET_GetHostList (hostent const *hostentry, nHostList &hostList, int net_hostport, bool server=true)
void	ANET_GetHostList (char const *hostname, nHostList &hostList, int net_hostport, bool server=true)
bool	ANET_ListenOnConst (char const *hostname, int net_hostport, nSocketListener::SocketArray &sockets, bool &onesocketonly, bool &relaxed, bool &ignoreErrors)
bool	ANET_ListenOn (char *hostname, int net_hostport, nSocketListener::SocketArray &sockets, bool &onesocketonly, bool &relaxed, bool &ignoreErrors)
bool	ANET_Listen (bool state, int net_hostport, const tString &net_hostip, nSocketListener::SocketArray &sockets)
int	ANET_CloseSocket (int sock)
static int	PartialIPAddress (const char *in, struct sockaddr *hostaddr, int default_port, int default_addr)
char *	ANET_AddrToString (const struct sockaddr *addr)
int	ANET_GetSocketAddr (int sock, struct sockaddr *addr)
int	ANET_AddrCompare (struct sockaddr *addr1, struct sockaddr *addr2)
Variables
static bool	sn_listen = false
static char const *	hostnameSection = "HOSTNAME"
static char const *	recordingSection = "BIND"
static char const *	recordingSectionRead = "READ"

---

Define Documentation

#define MAXHOSTNAMELEN   256

Definition at line 108 of file nSocket.cpp.

Referenced by GetMyHostName().

#define NET_NAMELEN   100

Definition at line 229 of file nSocket.cpp.

---

Typedef Documentation

typedef int NET_SIZE [static]

Definition at line 253 of file nSocket.cpp.

typedef std::vector< nHostInfo > nHostList

Definition at line 212 of file nSocket.cpp.

typedef int Socket [static]

Definition at line 331 of file nSocket.cpp.

---

Enumeration Type Documentation

enum nSocketError

Enumerator:

nSocketError_Ignore
nSocketError_Reset

Definition at line 214 of file nSocket.cpp.

{
    nSocketError_Ignore,                                // nothing special happened

---

Function Documentation

int @94::ANET_AddrCompare	(	struct sockaddr *	addr1,
		struct sockaddr *	addr2
	)			[static]

Definition at line 842 of file nSocket.cpp.

{
    if (addr1->sa_family != addr2->sa_family)
        return -1;

    if (((struct sockaddr_in *)addr1)->sin_addr.s_addr != ((struct sockaddr_in *)addr2)->sin_addr.s_addr)
        return -1;

    if (((struct sockaddr_in *)addr1)->sin_port != ((struct sockaddr_in *)addr2)->sin_port)
        return 1;

char* @94::ANET_AddrToString

(

const struct sockaddr *

addr

)

[static]

Definition at line 814 of file nSocket.cpp.

References buffer.

{
    static char buffer[23];
    int haddr;

    haddr = ntohl(((struct sockaddr_in const *)addr)->sin_addr.s_addr);
    snprintf(buffer,22, "%d.%d.%d.%d:%d", (haddr >> 24) & 0xff, (haddr >> 16) & 0xff, (haddr >> 8) & 0xff, haddr & 0xff, ntohs(((struct sockaddr_in const *)addr)->sin_port));

char* @94::ANET_AddrToString

(

const struct sockaddr *

addr

)

[static]

Referenced by nAddress::ToString().

Here is the caller graph for this function:

int @94::ANET_CloseSocket

(

int

sock

)

[static]

Definition at line 746 of file nSocket.cpp.

Referenced by nSocket::Bind(), and nSocket::Close().

{
    //if (sock == net_broadcastsocket)
    //    net_broadcastsocket = 0;

Here is the caller graph for this function:

static nSocketError @94::ANET_Error

(

)

[static]

Definition at line 256 of file nSocket.cpp.

References con, nSocketError_Ignore, nSocketError_Reset, tRecorder::PlaybackStrict(), tRecorder::Record(), and section.

Referenced by nSocket::Bind(), nSocket::CheckNewConnection(), nSocket::Read(), and nSocket::Write().

{
    int error = 0;
    nSocketError aError = nSocketError_Ignore;

    // play back error message
    static char const * section = "NETERROR";
    if ( !tRecorder::PlaybackStrict( section, aError ) )
    {
        // get error from OS
#ifdef WIN32
        error = WSAGetLastError();
#else
        error = errno;
#endif
        switch ( error )
        {
        case EADDRINUSE:
            break;
        case ENOTSOCK:
            aError = nSocketError_Reset;
            break;
        case ECONNRESET:
            aError = nSocketError_Reset;
            break;
        case ECONNREFUSED:
            break;
        case EWOULDBLOCK:
        case ENETUNREACH:
            aError = nSocketError_Ignore;
            break;
            //          case NOTINITIALISED:
            //                  break;
        case ENETDOWN:
            break;
        case EFAULT:
            aError = nSocketError_Reset;
            break;
        case EINTR:
            break;
        case EINVAL:
            break;
        case EISCONN:
            break;
        case ENETRESET:
            break;
        case EOPNOTSUPP:
        case EAFNOSUPPORT:
        case EADDRNOTAVAIL:
            aError = nSocketError_Reset;
            break;
        case ESHUTDOWN:
            break;
    #ifndef WIN32
        case EMSGSIZE:
            break;
    #endif
        case ETIMEDOUT:
            break;
        default:
    #ifdef DEBUG
            con << "Unknown network error " << error << "\n";
    #endif
            break;
        }
    }

    // record error message
    tRecorder::Record( section, aError );


    //  st_Breakpoint();

Here is the call graph for this function:

Here is the caller graph for this function:

void @94::ANET_GetHostList	(	char const *	hostname,
		nHostList &	hostList,
		int	net_hostport,
		bool	server = true
	)			[static]

Definition at line 530 of file nSocket.cpp.

References nHostInfo::address, ANET_GetHostList(), con, nHostInfo::name, tRecorder::Playback(), tRecorder::Record(), section, server(), nAddress::SetPort(), and sn_InitOSNetworking().

{
    sn_InitOSNetworking();

    hostList.clear();

    // if hostname is NULL, add generic host entry
    if ( !hostname )
    {
        nHostInfo info;
        info.name      = "localhost";
        info.address.SetPort( net_hostport );

        // add it to list and return
        hostList.push_back( info );
        return;
    }

    // read addresses from recording
    static char const * section = "MULTIHOSTBYNAME";
    static char const * sectionEnd = "MULTIHOSTBYNAMEEND";
    nHostInfo read;
    while ( tRecorder::Playback( section, read ) )
    {
        hostList.push_back( read );
    }
    if ( !tRecorder::Playback( sectionEnd ) )
    {
        // look up hostname
        struct hostent *hostentry;
        hostentry = gethostbyname (hostname);
        if (!hostentry)
        {
#ifndef WIN32
            con << "Error looking up " << ( hostname ? hostname : "localhost" ) << " : " << gai_strerror( h_errno ) << "\n";
#endif
            return;
        }

        // delegate
        ANET_GetHostList( hostentry, hostList, net_hostport, server );
    }

    // write addresses to recording
    for ( nHostList::const_iterator iter = hostList.begin(); iter != hostList.end(); ++iter )
        tRecorder::Record( section, read );

Here is the call graph for this function:

void @94::ANET_GetHostList	(	hostent const *	hostentry,
		nHostList &	hostList,
		int	net_hostport,
		bool	server = true
	)			[static]

Definition at line 509 of file nSocket.cpp.

References nHostInfo::address, nAddress::FromHostent(), nHostInfo::name, nAddress::SetPort(), nSocketType::type, and nHostInfo::type.

Referenced by ANET_GetHostList().

{
    // iterate over addresses
    char * * addressList = hostentry->h_addr_list;
    while (*addressList)
    {
        // prepare host info (TODO: IPV6/TCP compatibility)
        nHostInfo info;
        info.type.type = hostentry->h_addrtype;
        info.name      = hostentry->h_name;
        info.address.FromHostent( hostentry->h_length, *addressList );
        info.address.SetPort( net_hostport );

        // add it to list
        hostList.push_back( info );

        ++addressList; // next address

Here is the call graph for this function:

Here is the caller graph for this function:

int @94::ANET_GetSocketAddr	(	int	sock,
		struct sockaddr *	addr
	)			[static]

Definition at line 826 of file nSocket.cpp.

{
    NET_SIZE addrlen = sizeof(struct sockaddr);
    // unsigned int a;

    memset(addr, 0, sizeof(struct sockaddr));
    getsockname(sock, (struct sockaddr *)addr, &addrlen);
    // a = ((struct sockaddr_in *)addr)->sin_addr.s_addr;
    //if (a == 0 || a == inet_addr("127.0.0.1"))
    //    ((struct sockaddr_in *)addr)->sin_addr.s_addr = 0x7f000001;

int @94::ANET_GetSocketAddr	(	int	sock,
		struct sockaddr *	addr
	)			[static]

Referenced by nSocket::Bind().

Here is the caller graph for this function:

bool @94::ANET_Listen	(	bool	state,
		int	net_hostport,
		const tString &	net_hostip,
		nSocketListener::SocketArray &	sockets
	)			[static]

Definition at line 686 of file nSocket.cpp.

Referenced by nSocketListener::Listen().

{
    sn_listen = state;

    // enable listening
    if (state)
    {
        // reset sockets if we are already listening
        if (!sockets.empty())
            ANET_Listen( false, net_hostport, net_hostip, sockets );

        bool relaxed = false, onesocketonly = false, ignoreErrors = false;

        // first try: generate sockets for explicitly requested IP
        tString ips = net_hostip;   // copy of the hostname string
        size_t lastpos = 0;            // position where the current IP starts
        for ( size_t pos = 0; pos < ips.Size(); ++pos )
        {
            if (isblank(ips[pos]))
            {
                ips[pos] = '\0';
                if ( pos > lastpos )
                    if ( !ANET_ListenOn( &ips[lastpos], net_hostport, sockets, onesocketonly, relaxed, ignoreErrors ) )
                        return false;
                ips[pos] = ' ';
                lastpos = pos + 1;
            }
        }
        // don't forget the last IP entry
        if ( ips.Size() > lastpos )
            if ( !ANET_ListenOn( &ips[lastpos], net_hostport, sockets, onesocketonly, relaxed, ignoreErrors ) )
                return false;

        //#else
        //        old fallback code
        //        nSocket socket;
        //        socket.Open( net_hostport );
        //        sockets.push_back( socket );
        //#endif

        // report success or failure ( in relaxed mode when no socket was created )
        return !relaxed || !sockets.empty();
    }

    // disable listening
    if (sockets.empty())
        return false;

    // close sockets
    for ( nSocketListener::SocketArray::iterator iter = sockets.begin(); iter != sockets.end(); ++iter )
    {
        (*iter).Close();
    }
    sockets.clear();

Here is the caller graph for this function:

bool @94::ANET_ListenOn	(	char *	hostname,
		int	net_hostport,
		nSocketListener::SocketArray &	sockets,
		bool &	onesocketonly,
		bool &	relaxed,
		bool &	ignoreErrors
	)			[static]

Definition at line 659 of file nSocket.cpp.

{
    // skip whitespace
    while ( isblank( *hostname ) )
        hostname ++;

    // quit silently on empty hostname
    if ( !*hostname )
        return true;

    // replace colon by null temporarily, add port offset to net_hostport
    char * colon = NULL;
    if ( hostname )
        colon = strrchr (hostname, ':');
    if ( colon )
    {
        *colon = 0;
        net_hostport += atoi ( colon + 1 );
    }

    // don't forget to restore the colon when we're done here
    nColonRestaurator restaurator( colon );

    // delegate to function that does not modify the hostname

bool @94::ANET_ListenOn	(	nHostList const &	addresses,
		nSocketListener::SocketArray &	sockets,
		bool	onesocketonly,
		bool	ignoreErrors
	)			[static]

Definition at line 453 of file nSocket.cpp.

References con, tException::GetDescription(), tException::GetName(), and nSocket::Open().

{
    bool ret = true;

    for (nHostList::const_iterator iter = addresses.begin(); iter != addresses.end(); ++iter)
    {
        nHostInfo const & address = *iter;

        nSocket socket;
        int error = -1;
        try
        {
            error = socket.Open( address );
        }
        catch ( nSocket::PermanentError & e )
        {
            // ignore errors on request
            if ( ignoreErrors )
            {
                con << "sn_SetNetState: can't setup listening socket. Reason given:\n"
                << e.GetName() << ": " << e.GetDescription() << "\nIgnoring on user request.\n";
                return true;
            }
            else
            {
                throw;
            }
        }

        if ( error == 0 )
        {
            // store the socket
            sockets.push_back( socket );

            // return if we only want one socket
            if ( onesocketonly )
            {
#ifndef NOEXCEPT
                throw OneSocketOpened();
#endif
                return true;
            }
        }
        else
        {
            // report error
            ret = false;
        }
    }

    // return result

Here is the call graph for this function:

bool @94::ANET_ListenOnConst	(	char const *	hostname,
		int	net_hostport,
		nSocketListener::SocketArray &	sockets,
		bool &	onesocketonly,
		bool &	relaxed,
		bool &	ignoreErrors
	)			[static]

Definition at line 579 of file nSocket.cpp.

{
    if ( hostname )
    {
        // check if only one of the following sockets is required
        if ( 0 == strcmp( hostname, "ONEOF" ) )
        {
            onesocketonly = true;
            return true;
        }

        // check if partial failures are tolerated
        if ( 0 == strcmp( hostname, "RELAXED" ) )
        {
            relaxed = true;
            return true;
        }

        // check if errors should be ignored
        if ( 0 == strcmp( hostname, "IGNOREERRORS" ) )
        {
            ignoreErrors = true;
            return true;
        }

        // replace "ALL" by hostname
        else if ( 0 == strcmp( hostname, "ALL" ) )
        {
            hostname = GetMyHostName();
        }

        // replace "ANY" by 0
        if ( 0 == strcmp( hostname, "ANY" ) )
            hostname = NULL;
    }

    // look up hostname
    nHostList hostList;
    ANET_GetHostList( hostname, hostList, net_hostport );

    if ( hostList.empty() )
    {
        // name lookup failures won't be tolerated here
#ifndef NOEXCEPT
        if ( !ignoreErrors )
        {
            tString details( "Hostname lookup failed for " );
            details += hostname ? hostname : "localhost";
            details += " while trying to open listening sockets.";
            throw nSocket::PermanentError( details );
        }
#endif

        // fallback for nonexceptional systems
        if ( hostname )
            con << "ANET_ListenOn: Could not resolve " << hostname << " to bind socket to its IPs.\n";
        else
            con << "ANET_ListenOn: Could not determine generic IP to bind socket on.\n";

        return ignoreErrors;
    }
    bool ret = ANET_ListenOn( hostList, sockets, onesocketonly, ignoreErrors );

    // in relaxed mode, only one socket needs to be opened ( the caller needs to check that finally ). Otherwise, all socket openings need to have succeeded.

static void @94::Con_DPrintf

(

const char *

x

)

[inline, static]

Definition at line 246 of file nSocket.cpp.

                                             {

static void @94::Con_Printf

(

const char *

x

)

[inline, static]

Definition at line 238 of file nSocket.cpp.

Referenced by nSocket::Broadcast().

                                            {

Here is the caller graph for this function:

static void @94::Con_SafePrintf

(

const char *

x

)

[inline, static]

Definition at line 242 of file nSocket.cpp.

                                                {

tString const& @94::GetMyHostName

(

)

[static]

determine name of this host

Definition at line 429 of file nSocket.cpp.

References tString::Len(), MAXHOSTNAMELEN, tRecorder::PlaybackStrict(), and tRecorder::Record().

{
    static tString ret;
    if ( ret.Len() <= 1 )
    {
        // read hostname from recording
        if ( !tRecorder::PlaybackStrict( hostnameSection, ret ) )
        {
            // look up hostname
            char buff[MAXHOSTNAMELEN]="\0";
            if ( 0 == gethostname(buff, MAXHOSTNAMELEN) )
                ret = buff;
            else
                ret = "localhost";
        }

        // write hostname to recording
        tRecorder::Record( hostnameSection, ret );
    }

Here is the call graph for this function:

std::ostream& operator<<	(	std::ostream &	s,
		nHostInfo const &	hostInfo
	)

Definition at line 200 of file nSocket.cpp.

{
    // write name
    s << tLineString( hostInfo.name );

    // write address and type
    s << hostInfo.address;
    s << hostInfo.type;

std::ostream& operator<<	(	std::ostream &	s,
		nSocketType const &	type
	)

Definition at line 192 of file nSocket.cpp.

{
    // write data
    s << type.family << ' ' << type.type << ' ' << type.protocol;

std::ostream& operator<<	(	std::ostream &	s,
		nAddress const &	address
	)

Definition at line 184 of file nSocket.cpp.

{
    // write address
    s << tLineString( address.ToString() );

std::istream& operator>>	(	std::istream &	s,
		nHostInfo &	hostInfo
	)

Definition at line 170 of file nSocket.cpp.

{
    // read name
    tLineString name;
    s >> name;
    hostInfo.name = name;

    // read address and type
    s >> hostInfo.address;
    s >> hostInfo.type;

std::istream& operator>>	(	std::istream &	s,
		nSocketType &	type
	)

Definition at line 162 of file nSocket.cpp.

{
    // read data
    s >> type.family >> type.type >> type.protocol;

std::istream& operator>>	(	std::istream &	s,
		nAddress &	address
	)

Definition at line 152 of file nSocket.cpp.

References nAddress::FromString().

{
    // read address
    tLineString line;
    s >> line;
    address.FromString( line );

Here is the call graph for this function:

static int @94::PartialIPAddress	(	const char *	in,
		struct sockaddr *	hostaddr,
		int	default_port,
		int	default_addr
	)			[static]

Definition at line 763 of file nSocket.cpp.

References b.

Referenced by nAddress::SetAddress(), and nAddress::SetHostname().

{
    char buff[256];
    char *b;
    int addr;
    int num;
    int mask;
    int run;
    int port;

    buff[0] = '.';
    b = buff;
    strncpy(buff+1, in,254);
    if (buff[1] == '.')
        b++;

    addr = 0;
    mask=-1;
    while (*b == '.')
    {
        b++;
        num = 0;
        run = 0;
        while (!( *b < '0' || *b > '9'))
        {
            num = num*10 + *b++ - '0';
            if (++run > 3)
                return -1;
        }
        if ((*b < '0' || *b > '9') && *b != '.' && *b != ':' && *b != 0)
            return -1;
        if (num < 0 || num > 255)
            return -1;
        mask<<=8;
        addr = (addr<<8) + num;
    }

    if (*b++ == ':')
        port = atoi(b);
    else
        port = default_port;

    hostaddr->sa_family = AF_INET;
    ((struct sockaddr_in *)hostaddr)->sin_port = htons((short)port);
    ((struct sockaddr_in *)hostaddr)->sin_addr.s_addr = (default_addr & htonl(mask)) | htonl(addr);

Here is the caller graph for this function:

static nOSNetworking const& @94::sn_InitOSNetworking

(

)

[static]

initialize OS networking system and automatically shut it down later

Definition at line 420 of file nSocket.cpp.

Referenced by ANET_GetHostList(), nSocket::Create(), nAddress::GetAddress(), nAddress::GetHostname(), nBasicNetworkSystem::Init(), nAddress::SetAddress(), and nAddress::SetHostname().

{
    static nOSNetworking osNetworking;

Here is the caller graph for this function:

static void @94::Sys_Error

(

const char *

x

)

[inline, static]

Definition at line 233 of file nSocket.cpp.

References con.

Referenced by nSocket::CheckNewConnection(), and nBasicNetworkSystem::Init().

                                           {
    con << x;

Here is the caller graph for this function:

tRECORD_AS	(	nSocketError	,
		int
	)

---

Variable Documentation

char* colon_

Definition at line 656 of file nSocket.cpp.

char const* hostnameSection = "HOSTNAME" [static]

Definition at line 426 of file nSocket.cpp.

char const* recordingSection = "BIND" [static]

Definition at line 1557 of file nSocket.cpp.

Referenced by EventArchiver< Archiver >::Archive(), and tReproducibleRandomizer::tReproducibleRandomizer().

char const* recordingSectionRead = "READ" [static]

Definition at line 1946 of file nSocket.cpp.

bool sn_listen = false [static]

Definition at line 400 of file nSocket.cpp.

---