spingle/source/net_main.c

/*
Copyright (C) 1996-2001 Id Software, Inc.
Copyright (C) 2010-2014 QuakeSpasm developers

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

*/

#include "q_stdinc.h"
#include "net_sys.h"
#include "q_defs.h"
#include "net_defs.h"

qsocket_t       *net_activeSockets = NULL;
qsocket_t       *net_freeSockets = NULL;
int32_t         net_numsockets = 0;

bool    ipxAvailable = false;
bool    tcpipAvailable = false;

int32_t         net_hostport;
int32_t         DEFAULTnet_hostport = 26000;

char            my_ipx_address[NET_NAMELEN];
char            my_tcpip_address[NET_NAMELEN];

static bool     listening = false;

bool    slistInProgress = false;
bool    slistSilent = false;
bool    slistLocal = true;
static double   slistStartTime;
static int32_t          slistLastShown;

static void Slist_Send(void *unused);
static void Slist_Poll(void *unused);
static PollProcedure    slistSendProcedure = {NULL, 0.0, Slist_Send};
static PollProcedure    slistPollProcedure = {NULL, 0.0, Slist_Poll};

sizebuf_t       net_message;
int32_t         net_activeconnections           = 0;

int32_t         messagesSent                    = 0;
int32_t         messagesReceived                = 0;
int32_t         unreliableMessagesSent          = 0;
int32_t         unreliableMessagesReceived      = 0;

static  cvar_t  net_messagetimeout = {"net_messagetimeout", "300", CVAR_NONE};
cvar_t  hostname = {"hostname", "UNNAMED", CVAR_NONE};

// these two macros are to make the code more readable
#define sfunc   net_drivers[sock->driver]
#define dfunc   net_drivers[net_driverlevel]

int32_t         net_driverlevel;

double          net_time;


double SetNetTime(void)
{
	net_time = Sys_DoubleTime();
	return net_time;
}


/*
===================
NET_NewQSocket

Called by drivers when a new communications endpoint is required
The sequence and buffer members will be filled in properly
===================
*/
qsocket_t *NET_NewQSocket(void)
{
	qsocket_t       *sock;

	if(net_freeSockets == NULL)
		return NULL;

	if(net_activeconnections >= svs.maxclients)
		return NULL;

	// get one from free list
	sock = net_freeSockets;
	net_freeSockets = sock->next;

	// add it to active list
	sock->next = net_activeSockets;
	net_activeSockets = sock;

	sock->disconnected = false;
	sock->connecttime = net_time;
	strcpy(sock->address, "UNSET ADDRESS");
	sock->driver = net_driverlevel;
	sock->socket = 0;
	sock->driverdata = NULL;
	sock->canSend = true;
	sock->sendNext = false;
	sock->lastMessageTime = net_time;
	sock->ackSequence = 0;
	sock->sendSequence = 0;
	sock->unreliableSendSequence = 0;
	sock->sendMessageLength = 0;
	sock->receiveSequence = 0;
	sock->unreliableReceiveSequence = 0;
	sock->receiveMessageLength = 0;

	return sock;
}


void NET_FreeQSocket(qsocket_t *sock)
{
	qsocket_t       *s;

	// remove it from active list
	if(sock == net_activeSockets)
		net_activeSockets = net_activeSockets->next;
	else
	{
		for(s = net_activeSockets; s; s = s->next)
		{
			if(s->next == sock)
			{
				s->next = sock->next;
				break;
			}
		}

		if(!s)
			Sys_Error("NET_FreeQSocket: not active");
	}

	// add it to free list
	sock->next = net_freeSockets;
	net_freeSockets = sock;
	sock->disconnected = true;
}


double NET_QSocketGetTime(const qsocket_t *s)
{
	return s->connecttime;
}


const char *NET_QSocketGetAddressString(const qsocket_t *s)
{
	return s->address;
}


static void NET_Listen_f(void)
{
	if(Cmd_Argc() != 2)
	{
		Con_Printf("\"listen\" is \"%" PRIi32 "\"\n", listening ? 1 : 0);
		return;
	}

	listening = atoi(Cmd_Argv(1)) ? true : false;

	for(net_driverlevel = 0; net_driverlevel < net_numdrivers; net_driverlevel++)
	{
		if(net_drivers[net_driverlevel].initialized == false)
			continue;
		dfunc.Listen(listening);
	}
}


static void MaxPlayers_f(void)
{
	int32_t n;

	if(Cmd_Argc() != 2)
	{
		Con_Printf("\"maxplayers\" is \"%" PRIi32 "\"\n", svs.maxclients);
		return;
	}

	if(sv.active)
	{
		Con_Printf("maxplayers can not be changed while a server is running.\n");
		return;
	}

	n = atoi(Cmd_Argv(1));
	if(n < 1)
		n = 1;
	if(n > svs.maxclientslimit)
	{
		n = svs.maxclientslimit;
		Con_Printf("\"maxplayers\" set to \"%" PRIi32 "\"\n", n);
	}

	if((n == 1) && listening)
		Cbuf_AddText("listen 0\n");

	if((n > 1) && (!listening))
		Cbuf_AddText("listen 1\n");

	svs.maxclients = n;
	if(n == 1)
		Cvar_Set("deathmatch", "0");
	else
		Cvar_Set("deathmatch", "1");
}


static void NET_Port_f(void)
{
	int32_t n;

	if(Cmd_Argc() != 2)
	{
		Con_Printf("\"port\" is \"%" PRIi32 "\"\n", net_hostport);
		return;
	}

	n = atoi(Cmd_Argv(1));
	if(n < 1 || n > 65534)
	{
		Con_Printf("Bad value, must be between 1 and 65534\n");
		return;
	}

	DEFAULTnet_hostport = n;
	net_hostport = n;

	if(listening)
	{
		// force a change to the new port
		Cbuf_AddText("listen 0\n");
		Cbuf_AddText("listen 1\n");
	}
}


static void PrintSlistHeader(void)
{
	Con_Printf("Server          Map             Users\n");
	Con_Printf("--------------- --------------- -----\n");
	slistLastShown = 0;
}


static void PrintSlist(void)
{
	int32_t         n;

	for(n = slistLastShown; n < hostCacheCount; n++)
	{
		if(hostcache[n].maxusers)
			Con_Printf("%-15.15s %-15.15s %2" PRIu32 "/%2" PRIu32 "\n", hostcache[n].name, hostcache[n].map, hostcache[n].users, hostcache[n].maxusers);
		else
			Con_Printf("%-15.15s %-15.15s\n", hostcache[n].name, hostcache[n].map);
	}
	slistLastShown = n;
}


static void PrintSlistTrailer(void)
{
	if(hostCacheCount)
		Con_Printf("== end list ==\n\n");
	else
		Con_Printf("No servers found.\n\n");
}


void NET_Slist_f(void)
{
	if(slistInProgress)
		return;

	if(! slistSilent)
	{
		Con_Printf("Looking for servers...\n");
		PrintSlistHeader();
	}

	slistInProgress = true;
	slistStartTime = Sys_DoubleTime();

	SchedulePollProcedure(&slistSendProcedure, 0.0);
	SchedulePollProcedure(&slistPollProcedure, 0.1);

	hostCacheCount = 0;
}


void NET_SlistSort(void)
{
	if(hostCacheCount > 1)
	{
		int32_t i, j;
		hostcache_t temp;
		for(i = 0; i < hostCacheCount; i++)
		{
			for(j = i + 1; j < hostCacheCount; j++)
			{
				if(strcmp(hostcache[j].name, hostcache[i].name) < 0)
				{
					memcpy(&temp, &hostcache[j], sizeof(hostcache_t));
					memcpy(&hostcache[j], &hostcache[i], sizeof(hostcache_t));
					memcpy(&hostcache[i], &temp, sizeof(hostcache_t));
				}
			}
		}
	}
}


const char *NET_SlistPrintServer(int32_t idx)
{
	static char     string[64];

	if(idx < 0 || idx >= hostCacheCount)
		return "";

	if(hostcache[idx].maxusers)
	{
		q_snprintf(string, sizeof(string), "%-15.15s %-15.15s %2" PRIu32 "/%2" PRIu32 "\n",
		           hostcache[idx].name, hostcache[idx].map,
		           hostcache[idx].users, hostcache[idx].maxusers);
	}
	else
	{
		q_snprintf(string, sizeof(string), "%-15.15s %-15.15s\n",
		           hostcache[idx].name, hostcache[idx].map);
	}

	return string;
}


const char *NET_SlistPrintServerName(int32_t idx)
{
	if(idx < 0 || idx >= hostCacheCount)
		return "";
	return hostcache[idx].cname;
}


static void Slist_Send(void *unused)
{
	(void)unused;
	for(net_driverlevel = 0; net_driverlevel < net_numdrivers; net_driverlevel++)
	{
		if(!slistLocal && IS_LOOP_DRIVER(net_driverlevel))
			continue;
		if(net_drivers[net_driverlevel].initialized == false)
			continue;
		dfunc.SearchForHosts(true);
	}

	if((Sys_DoubleTime() - slistStartTime) < 0.5)
		SchedulePollProcedure(&slistSendProcedure, 0.75);
}


static void Slist_Poll(void *unused)
{
	(void)unused;
	for(net_driverlevel = 0; net_driverlevel < net_numdrivers; net_driverlevel++)
	{
		if(!slistLocal && IS_LOOP_DRIVER(net_driverlevel))
			continue;
		if(net_drivers[net_driverlevel].initialized == false)
			continue;
		dfunc.SearchForHosts(false);
	}

	if(! slistSilent)
		PrintSlist();

	if((Sys_DoubleTime() - slistStartTime) < 1.5)
	{
		SchedulePollProcedure(&slistPollProcedure, 0.1);
		return;
	}

	if(! slistSilent)
		PrintSlistTrailer();
	slistInProgress = false;
	slistSilent = false;
	slistLocal = true;
}


/*
===================
NET_Connect
===================
*/

int32_t hostCacheCount = 0;
hostcache_t hostcache[HOSTCACHESIZE];

qsocket_t *NET_Connect(const char *host)
{
	qsocket_t               *ret;
	int32_t                         n;
	int32_t                         numdrivers = net_numdrivers;

	SetNetTime();

	if(host && *host == 0)
		host = NULL;

	if(host)
	{
		if(q_strcasecmp(host, "local") == 0)
		{
			numdrivers = 1;
			goto justdoit;
		}

		if(hostCacheCount)
		{
			for(n = 0; n < hostCacheCount; n++)
				if(q_strcasecmp(host, hostcache[n].name) == 0)
				{
					host = hostcache[n].cname;
					break;
				}
			if(n < hostCacheCount)
				goto justdoit;
		}
	}

	slistSilent = host ? true : false;
	NET_Slist_f();

	while(slistInProgress)
		NET_Poll();

	if(host == NULL)
	{
		if(hostCacheCount != 1)
			return NULL;
		host = hostcache[0].cname;
		Con_Printf("Connecting to...\n%s @ %s\n\n", hostcache[0].name, host);
	}

	if(hostCacheCount)
	{
		for(n = 0; n < hostCacheCount; n++)
		{
			if(q_strcasecmp(host, hostcache[n].name) == 0)
			{
				host = hostcache[n].cname;
				break;
			}
		}
	}

justdoit:
	for(net_driverlevel = 0; net_driverlevel < numdrivers; net_driverlevel++)
	{
		if(net_drivers[net_driverlevel].initialized == false)
			continue;
		ret = dfunc.Connect(host);
		if(ret)
			return ret;
	}

	if(host)
	{
		Con_Printf("\n");
		PrintSlistHeader();
		PrintSlist();
		PrintSlistTrailer();
	}

	return NULL;
}


/*
===================
NET_CheckNewConnections
===================
*/
qsocket_t *NET_CheckNewConnections(void)
{
	qsocket_t       *ret;

	SetNetTime();

	for(net_driverlevel = 0; net_driverlevel < net_numdrivers; net_driverlevel++)
	{
		if(net_drivers[net_driverlevel].initialized == false)
			continue;
		if(!IS_LOOP_DRIVER(net_driverlevel) && listening == false)
			continue;
		ret = dfunc.CheckNewConnections();
		if(ret)
		{
			return ret;
		}
	}

	return NULL;
}

/*
===================
NET_Close
===================
*/
void NET_Close(qsocket_t *sock)
{
	if(!sock)
		return;

	if(sock->disconnected)
		return;

	SetNetTime();

	// call the driver_Close function
	sfunc.Close(sock);

	NET_FreeQSocket(sock);
}


/*
=================
NET_GetMessage

If there is a complete message, return it in net_message

returns 0 if no data is waiting
returns 1 if a message was received
returns -1 if connection is invalid
=================
*/
int32_t NET_GetMessage(qsocket_t *sock)
{
	int32_t ret;

	if(!sock)
		return -1;

	if(sock->disconnected)
	{
		Con_Printf("NET_GetMessage: disconnected socket\n");
		return -1;
	}

	SetNetTime();

	ret = sfunc.QGetMessage(sock);

	// see if this connection has timed out
	if(ret == 0 && !IS_LOOP_DRIVER(sock->driver))
	{
		if(net_time - sock->lastMessageTime > net_messagetimeout.value)
		{
			NET_Close(sock);
			return -1;
		}
	}

	if(ret > 0)
	{
		if(!IS_LOOP_DRIVER(sock->driver))
		{
			sock->lastMessageTime = net_time;
			if(ret == 1)
				messagesReceived++;
			else if(ret == 2)
				unreliableMessagesReceived++;
		}
	}

	return ret;
}


/*
==================
NET_SendMessage

Try to send a complete length+message unit over the reliable stream.
returns 0 if the message cannot be delivered reliably, but the connection
                is still considered valid
returns 1 if the message was sent properly
returns -1 if the connection died
==================
*/
int32_t NET_SendMessage(qsocket_t *sock, sizebuf_t *data)
{
	int32_t         r;

	if(!sock)
		return -1;

	if(sock->disconnected)
	{
		Con_Printf("NET_SendMessage: disconnected socket\n");
		return -1;
	}

	SetNetTime();
	r = sfunc.QSendMessage(sock, data);
	if(r == 1 && !IS_LOOP_DRIVER(sock->driver))
		messagesSent++;

	return r;
}


int32_t NET_SendUnreliableMessage(qsocket_t *sock, sizebuf_t *data)
{
	int32_t         r;

	if(!sock)
		return -1;

	if(sock->disconnected)
	{
		Con_Printf("NET_SendMessage: disconnected socket\n");
		return -1;
	}

	SetNetTime();
	r = sfunc.SendUnreliableMessage(sock, data);
	if(r == 1 && !IS_LOOP_DRIVER(sock->driver))
		unreliableMessagesSent++;

	return r;
}


/*
==================
NET_CanSendMessage

Returns true or false if the given qsocket can currently accept a
message to be transmitted.
==================
*/
bool NET_CanSendMessage(qsocket_t *sock)
{
	if(!sock)
		return false;

	if(sock->disconnected)
		return false;

	SetNetTime();

	return sfunc.CanSendMessage(sock);
}


int32_t NET_SendToAll(sizebuf_t *data, double blocktime)
{
	double          start;
	int32_t                 i;
	int32_t                 count = 0;
	bool    msg_init[MAX_SCOREBOARD];       /* did we write the message to the client's connection  */
	bool    msg_sent[MAX_SCOREBOARD];       /* did the msg arrive its destination (canSend state).  */

	for(i = 0, host_client = svs.clients; i < svs.maxclients; i++, host_client++)
	{
		/*
		if (!host_client->netconnection)
		        continue;
		if (host_client->active)
		*/
		if(host_client->netconnection && host_client->active)
		{
			if(IS_LOOP_DRIVER(host_client->netconnection->driver))
			{
				NET_SendMessage(host_client->netconnection, data);
				msg_init[i] = true;
				msg_sent[i] = true;
				continue;
			}
			count++;
			msg_init[i] = false;
			msg_sent[i] = false;
		}
		else
		{
			msg_init[i] = true;
			msg_sent[i] = true;
		}
	}

	start = Sys_DoubleTime();
	while(count)
	{
		count = 0;
		for(i = 0, host_client = svs.clients; i < svs.maxclients; i++, host_client++)
		{
			if(! msg_init[i])
			{
				if(NET_CanSendMessage(host_client->netconnection))
				{
					msg_init[i] = true;
					NET_SendMessage(host_client->netconnection, data);
				}
				else
				{
					NET_GetMessage(host_client->netconnection);
				}
				count++;
				continue;
			}

			if(! msg_sent[i])
			{
				if(NET_CanSendMessage(host_client->netconnection))
				{
					msg_sent[i] = true;
				}
				else
				{
					NET_GetMessage(host_client->netconnection);
				}
				count++;
				continue;
			}
		}
		if((Sys_DoubleTime() - start) > blocktime)
			break;
	}
	return count;
}


//=============================================================================

/*
====================
NET_Init
====================
*/

void NET_Init(void)
{
	int32_t                 i;
	qsocket_t       *s;

	i = COM_CheckParm("-port");
	if(!i)
		i = COM_CheckParm("-udpport");
	if(!i)
		i = COM_CheckParm("-ipxport");

	if(i)
	{
		if(i < com_argc - 1)
			DEFAULTnet_hostport = atoi(com_argv[i + 1]);
		else
			Sys_Error("NET_Init: you must specify a number after -port");
	}
	net_hostport = DEFAULTnet_hostport;

	net_numsockets = svs.maxclientslimit;
	if(cls.state != ca_dedicated)
		net_numsockets++;
	if(COM_CheckParm("-listen") || cls.state == ca_dedicated)
		listening = true;

	SetNetTime();

	for(i = 0; i < net_numsockets; i++)
	{
		s = (qsocket_t *)Hunk_AllocName(sizeof(qsocket_t), "qsocket");
		s->next = net_freeSockets;
		net_freeSockets = s;
		s->disconnected = true;
	}

	// allocate space for network message buffer
	SZ_Alloc(&net_message, NET_MAXMESSAGE);

	Cvar_RegisterVariable(&net_messagetimeout);
	Cvar_RegisterVariable(&hostname);

	Cmd_AddCommand("slist", NET_Slist_f);
	Cmd_AddCommand("listen", NET_Listen_f);
	Cmd_AddCommand("maxplayers", MaxPlayers_f);
	Cmd_AddCommand("port", NET_Port_f);

	// initialize all the drivers
	for(i = net_driverlevel = 0; net_driverlevel < net_numdrivers; net_driverlevel++)
	{
		if(net_drivers[net_driverlevel].Init() == -1)
			continue;
		i++;
		net_drivers[net_driverlevel].initialized = true;
		if(listening)
			net_drivers[net_driverlevel].Listen(true);
	}

	/* Loop_Init() returns -1 for dedicated server case,
	 * therefore the i == 0 check is correct */
	if(i == 0
	                && cls.state == ca_dedicated
	  )
	{
		Sys_Error("Network not available!");
	}

	if(*my_ipx_address)
	{
		Con_DPrintf("IPX address %s\n", my_ipx_address);
	}
	if(*my_tcpip_address)
	{
		Con_DPrintf("TCP/IP address %s\n", my_tcpip_address);
	}
}

/*
====================
NET_Shutdown
====================
*/

void NET_Shutdown(void)
{
	qsocket_t       *sock;

	SetNetTime();

	for(sock = net_activeSockets; sock; sock = sock->next)
		NET_Close(sock);

//
// shutdown the drivers
//
	for(net_driverlevel = 0; net_driverlevel < net_numdrivers; net_driverlevel++)
	{
		if(net_drivers[net_driverlevel].initialized == true)
		{
			net_drivers[net_driverlevel].Shutdown();
			net_drivers[net_driverlevel].initialized = false;
		}
	}
}


static PollProcedure *pollProcedureList = NULL;

void NET_Poll(void)
{
	PollProcedure *pp;

	SetNetTime();

	for(pp = pollProcedureList; pp; pp = pp->next)
	{
		if(pp->nextTime > net_time)
			break;
		pollProcedureList = pp->next;
		pp->procedure(pp->arg);
	}
}


void SchedulePollProcedure(PollProcedure *proc, double timeOffset)
{
	PollProcedure *pp, *prev;

	proc->nextTime = Sys_DoubleTime() + timeOffset;
	for(pp = pollProcedureList, prev = NULL; pp; pp = pp->next)
	{
		if(pp->nextTime >= proc->nextTime)
			break;
		prev = pp;
	}

	if(prev == NULL)
	{
		proc->next = pollProcedureList;
		pollProcedureList = proc;
		return;
	}

	proc->next = pp;
	prev->next = proc;
}