1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "debug.h"

     5

#include "network_data.h"

     6

     7

// Is the network enabled?

     8

#ifdef ENABLE_NETWORK

     9

    10

#include "functions.h"

    11

#include "string.h"

    12

#include "table/strings.h"

    13

#include "network_client.h"

    14

#include "command.h"

    15

#include "callback_table.h"

    16

#include "variables.h"

    17

    18

// This files handles the send/receive of all packets

    19

    20

// Create a packet for sending

    21

Packet *NetworkSend_Init(PacketType type)

    22

{

    23

	Packet *packet = malloc(sizeof(Packet));

    24

	// An error is inplace here, because it simply means we ran out of memory.

    25

	if (packet == NULL) error("Failed to allocate Packet");

    26

    27

	// Skip the size so we can write that in before sending the packet

    28

	packet->size = sizeof(packet->size);

    29

	packet->buffer[packet->size++] = type;

    30

	packet->pos = 0;

    31

    32

	return packet;

    33

}

    34

    35

// The next couple of functions make sure we can send

    36

//  uint8, uint16, uint32 and uint64 endian-safe

    37

//  over the network. The order it uses is:

    38

//

    39

//  1 2 3 4

    40

//

    41

    42

void NetworkSend_uint8(Packet *packet, uint8 data)

    43

{

    44

	assert(packet->size < sizeof(packet->buffer) - sizeof(data));

    45

	packet->buffer[packet->size++] = data;

    46

}

    47

    48

void NetworkSend_uint16(Packet *packet, uint16 data)

    49

{

    50

	assert(packet->size < sizeof(packet->buffer) - sizeof(data));

    51

	packet->buffer[packet->size++] = GB(data, 0, 8);

    52

	packet->buffer[packet->size++] = GB(data, 8, 8);

    53

}

    54

    55

void NetworkSend_uint32(Packet *packet, uint32 data)

    56

{

    57

	assert(packet->size < sizeof(packet->buffer) - sizeof(data));

    58

	packet->buffer[packet->size++] = GB(data,  0, 8);

    59

	packet->buffer[packet->size++] = GB(data,  8, 8);

    60

	packet->buffer[packet->size++] = GB(data, 16, 8);

    61

	packet->buffer[packet->size++] = GB(data, 24, 8);

    62

}

    63

    64

void NetworkSend_uint64(Packet *packet, uint64 data)

    65

{

    66

	assert(packet->size < sizeof(packet->buffer) - sizeof(data));

    67

	packet->buffer[packet->size++] = GB(data,  0, 8);

    68

	packet->buffer[packet->size++] = GB(data,  8, 8);

    69

	packet->buffer[packet->size++] = GB(data, 16, 8);

    70

	packet->buffer[packet->size++] = GB(data, 24, 8);

    71

	packet->buffer[packet->size++] = GB(data, 32, 8);

    72

	packet->buffer[packet->size++] = GB(data, 40, 8);

    73

	packet->buffer[packet->size++] = GB(data, 48, 8);

    74

	packet->buffer[packet->size++] = GB(data, 56, 8);

    75

}

    76

    77

// Sends a string over the network. It sends out

    78

//  the string + '\0'. No size-byte or something.

    79

void NetworkSend_string(Packet *packet, const char* data)

    80

{

    81

	assert(data != NULL);

    82

	assert(packet->size < sizeof(packet->buffer) - strlen(data) - 1);

    83

	while ((packet->buffer[packet->size++] = *data++) != '\0') {}

    84

}

    85

    86

// If PacketSize changes of size, you have to change the 2 packet->size

    87

//   lines below matching the size of packet->size/PacketSize!

    88

// (line 'packet->buffer[0] = packet->size & 0xFF;'  and below)

    89

assert_compile(sizeof(PacketSize) == 2);

    90

    91

// This function puts the packet in the send-queue and it is send

    92

//  as soon as possible

    93

// (that is: the next tick, or maybe one tick later if the

    94

//   OS-network-buffer is full)

    95

void NetworkSend_Packet(Packet *packet, NetworkClientState *cs)

    96

{

    97

	Packet *p;

    98

	assert(packet != NULL);

    99

   100

	packet->pos = 0;

   101

	packet->next = NULL;

   102

   103

	packet->buffer[0] = GB(packet->size, 0, 8);

   104

	packet->buffer[1] = GB(packet->size, 8, 8);

   105

   106

	// Locate last packet buffered for the client

   107

	p = cs->packet_queue;

   108

	if (p == NULL) {

   109

		// No packets yet

   110

		cs->packet_queue = packet;

   111

	} else {

   112

		// Skip to the last packet

   113

		while (p->next != NULL) p = p->next;

   114

		p->next = packet;

   115

	}

   116

}

   117

   118

// Functions to help NetworkRecv_Packet/NetworkSend_Packet a bit

   119

//  A socket can make errors. When that happens

   120

//  this handles what to do.

   121

// For clients: close connection and drop back to main-menu

   122

// For servers: close connection and that is it

   123

static NetworkRecvStatus CloseConnection(NetworkClientState *cs)

   124

{

   125

	NetworkCloseClient(cs);

   126

   127

	// Clients drop back to the main menu

   128

	if (!_network_server && _networking) {

   129

		_switch_mode = SM_MENU;

   130

		_networking = false;

   131

		_switch_mode_errorstr = STR_NETWORK_ERR_LOSTCONNECTION;

   132

   133

		return NETWORK_RECV_STATUS_CONN_LOST;

   134

	}

   135

   136

	return NETWORK_RECV_STATUS_OKAY;

   137

}

   138

   139

// Sends all the buffered packets out for this client

   140

//  it stops when:

   141

//   1) all packets are send (queue is empty)

   142

//   2) the OS reports back that it can not send any more

   143

//        data right now (full network-buffer, it happens ;))

   144

//   3) sending took too long

   145

bool NetworkSend_Packets(NetworkClientState *cs)

   146

{

   147

	ssize_t res;

   148

	Packet *p;

   149

   150

	// We can not write to this socket!!

   151

	if (!cs->writable) return false;

   152

	if (cs->socket == INVALID_SOCKET) return false;

   153

   154

	p = cs->packet_queue;

   155

	while (p != NULL) {

   156

		res = send(cs->socket, p->buffer + p->pos, p->size - p->pos, 0);

   157

		if (res == -1) {

   158

			int err = GET_LAST_ERROR();

   159

			if (err != EWOULDBLOCK) {

   160

				// Something went wrong.. close client!

   161

				DEBUG(net, 0) ("[NET] send() failed with error %d", err);

   162

				CloseConnection(cs);

   163

				return false;

   164

			}

   165

			return true;

   166

		}

   167

		if (res == 0) {

   168

			// Client/server has left us :(

   169

			CloseConnection(cs);

   170

			return false;

   171

		}

   172

   173

		p->pos += res;

   174

   175

		// Is this packet sent?

   176

		if (p->pos == p->size) {

   177

			// Go to the next packet

   178

			cs->packet_queue = p->next;

   179

			free(p);

   180

			p = cs->packet_queue;

   181

		} else {

   182

			return true;

   183

		}

   184

	}

   185

   186

	return true;

   187

}

   188

   189

   190

// Receiving commands

   191

// Again, the next couple of functions are endian-safe

   192

//  see the comment around NetworkSend_uint8 for more info.

   193

uint8 NetworkRecv_uint8(NetworkClientState *cs, Packet *packet)

   194

{

   195

	/* Don't allow reading from a closed socket */

   196

	if (cs->quited) return 0;

   197

   198

	/* Check if variable is within packet-size */

   199

	if (packet->pos + 1 > packet->size) {

   200

		CloseConnection(cs);

   201

		return 0;

   202

	}

   203

   204

	return packet->buffer[packet->pos++];

   205

}

   206

   207

uint16 NetworkRecv_uint16(NetworkClientState *cs, Packet *packet)

   208

{

   209

	uint16 n;

   210

   211

	/* Don't allow reading from a closed socket */

   212

	if (cs->quited) return 0;

   213

   214

	/* Check if variable is within packet-size */

   215

	if (packet->pos + 2 > packet->size) {

   216

		CloseConnection(cs);

   217

		return 0;

   218

	}

   219

   220

	n  = (uint16)packet->buffer[packet->pos++];

   221

	n += (uint16)packet->buffer[packet->pos++] << 8;

   222

	return n;

   223

}

   224

   225

uint32 NetworkRecv_uint32(NetworkClientState *cs, Packet *packet)

   226

{

   227

	uint32 n;

   228

   229

	/* Don't allow reading from a closed socket */

   230

	if (cs->quited) return 0;

   231

   232

	/* Check if variable is within packet-size */

   233

	if (packet->pos + 4 > packet->size) {

   234

		CloseConnection(cs);

   235

		return 0;

   236

	}

   237

   238

	n  = (uint32)packet->buffer[packet->pos++];

   239

	n += (uint32)packet->buffer[packet->pos++] << 8;

   240

	n += (uint32)packet->buffer[packet->pos++] << 16;

   241

	n += (uint32)packet->buffer[packet->pos++] << 24;

   242

	return n;

   243

}

   244

   245

uint64 NetworkRecv_uint64(NetworkClientState *cs, Packet *packet)

   246

{

   247

	uint64 n;

   248

   249

	/* Don't allow reading from a closed socket */

   250

	if (cs->quited) return 0;

   251

   252

	/* Check if variable is within packet-size */

   253

	if (packet->pos + 8 > packet->size) {

   254

		CloseConnection(cs);

   255

		return 0;

   256

	}

   257

   258

	n  = (uint64)packet->buffer[packet->pos++];

   259

	n += (uint64)packet->buffer[packet->pos++] << 8;

   260

	n += (uint64)packet->buffer[packet->pos++] << 16;

   261

	n += (uint64)packet->buffer[packet->pos++] << 24;

   262

	n += (uint64)packet->buffer[packet->pos++] << 32;

   263

	n += (uint64)packet->buffer[packet->pos++] << 40;

   264

	n += (uint64)packet->buffer[packet->pos++] << 48;

   265

	n += (uint64)packet->buffer[packet->pos++] << 56;

   266

	return n;

   267

}

   268

   269

// Reads a string till it finds a '\0' in the stream

   270

void NetworkRecv_string(NetworkClientState *cs, Packet *p, char *buffer, size_t size)

   271

{

   272

	PacketSize pos;

   273

	char *bufp = buffer;

   274

   275

	/* Don't allow reading from a closed socket */

   276

	if (cs->quited) return;

   277

   278

	pos = p->pos;

   279

	while (--size > 0 && pos < p->size && (*buffer++ = p->buffer[pos++]) != '\0') {}

   280

   281

	if (size == 0 || pos == p->size) {

   282

		*buffer = '\0';

   283

		// If size was sooner to zero then the string in the stream

   284

		//  skip till the \0, so the packet can be read out correctly for the rest

   285

		while (pos < p->size && p->buffer[pos] != '\0') pos++;

   286

		pos++;

   287

	}

   288

	p->pos = pos;

   289

   290

	str_validate(bufp);

   291

}

   292

   293

// If PacketSize changes of size, you have to change the 2 packet->size

   294

//   lines below matching the size of packet->size/PacketSize!

   295

// (the line: 'p->size = (uint16)p->buffer[0];' and below)

   296

assert_compile(sizeof(PacketSize) == 2);

   297

   298

Packet *NetworkRecv_Packet(NetworkClientState *cs, NetworkRecvStatus *status)

   299

{

   300

	ssize_t res;

   301

	Packet *p;

   302

   303

	*status = NETWORK_RECV_STATUS_OKAY;

   304

   305

	if (cs->socket == INVALID_SOCKET) return NULL;

   306

   307

	if (cs->packet_recv == NULL) {

   308

		cs->packet_recv = malloc(sizeof(Packet));

   309

		if (cs->packet_recv == NULL) error("Failed to allocate packet");

   310

		// Set pos to zero!

   311

		cs->packet_recv->pos = 0;

   312

		cs->packet_recv->size = 0; // Can be ommited, just for safety reasons

   313

	}

   314

   315

	p = cs->packet_recv;

   316

   317

	// Read packet size

   318

	if (p->pos < sizeof(PacketSize)) {

   319

		while (p->pos < sizeof(PacketSize)) {

   320

			// Read the size of the packet

   321

			res = recv(cs->socket, p->buffer + p->pos, sizeof(PacketSize) - p->pos, 0);

   322

			if (res == -1) {

   323

				int err = GET_LAST_ERROR();

   324

				if (err != EWOULDBLOCK) {

   325

					// Something went wrong..

   326

					if (err != 104) // 104 is Connection Reset by Peer

   327

						DEBUG(net, 0) ("[NET] recv() failed with error %d", err);

   328

					*status = CloseConnection(cs);

   329

					return NULL;

   330

				}

   331

				// Connection would block, so stop for now

   332

				return NULL;

   333

			}

   334

			if (res == 0) {

   335

				// Client/server has left us :(

   336

				*status = CloseConnection(cs);

   337

				return NULL;

   338

			}

   339

			p->pos += res;

   340

		}

   341

   342

		p->size = (uint16)p->buffer[0];

   343

		p->size += (uint16)p->buffer[1] << 8;

   344

   345

		if (p->size > SEND_MTU) {

   346

			*status = CloseConnection(cs);

   347

			return NULL;

   348

		}

   349

	}

   350

   351

	// Read rest of packet

   352

	while (p->pos < p->size) {

   353

		res = recv(cs->socket, p->buffer + p->pos, p->size - p->pos, 0);

   354

		if (res == -1) {

   355

			int err = GET_LAST_ERROR();

   356

			if (err != EWOULDBLOCK) {

   357

				// Something went wrong..

   358

				if (err != 104) // 104 is Connection Reset by Peer

   359

					DEBUG(net, 0) ("[NET] recv() failed with error %d", err);

   360

				*status = CloseConnection(cs);

   361

				return NULL;

   362

			}

   363

			// Connection would block

   364

			return NULL;

   365

		}

   366

		if (res == 0) {

   367

			// Client/server has left us :(

   368

			*status = CloseConnection(cs);

   369

			return NULL;

   370

		}

   371

   372

		p->pos += res;

   373

	}

   374

   375

	// We have a complete packet, return it!

   376

	p->pos = 2;

   377

	p->next = NULL; // Should not be needed, but who knows...

   378

   379

	// Prepare for receiving a new packet

   380

	cs->packet_recv = NULL;

   381

   382

	return p;

   383

}

   384

   385

// Add a command to the local command queue

   386

void NetworkAddCommandQueue(NetworkClientState *cs, CommandPacket *cp)

   387

{

   388

	CommandPacket* new_cp = malloc(sizeof(*new_cp));

   389

   390

	*new_cp = *cp;

   391

   392

	if (cs->command_queue == NULL) {

   393

		cs->command_queue = new_cp;

   394

	} else {

   395

		CommandPacket *c = cs->command_queue;

   396

		while (c->next != NULL) c = c->next;

   397

		c->next = new_cp;

   398

	}

   399

}

   400

   401

// Prepare a DoCommand to be send over the network

   402

void NetworkSend_Command(TileIndex tile, uint32 p1, uint32 p2, uint32 cmd, CommandCallback *callback)

   403

{

   404

	CommandPacket *c = malloc(sizeof(CommandPacket));

   405

	byte temp_callback;

   406

   407

	c->player = _local_player;

   408

	c->next = NULL;

   409

	c->tile = tile;

   410

	c->p1 = p1;

   411

	c->p2 = p2;

   412

	c->cmd = cmd;

   413

	c->callback = 0;

   414

   415

	temp_callback = 0;

   416

   417

	while (temp_callback < _callback_table_count && _callback_table[temp_callback] != callback)

   418

		temp_callback++;

   419

	if (temp_callback == _callback_table_count) {

   420

		DEBUG(net, 0) ("[NET] Unknown callback. (Pointer: %p) No callback sent.", callback);

   421

		temp_callback = 0; /* _callback_table[0] == NULL */

   422

	}

   423

   424

	if (_network_server) {

   425

		// We are the server, so set the command to be executed next possible frame

   426

		c->frame = _frame_counter_max + 1;

   427

	} else {

   428

		c->frame = 0; // The client can't tell which frame, so just make it 0

   429

	}

   430

   431

	ttd_strlcpy(c->text, (_cmd_text != NULL) ? _cmd_text : "", lengthof(c->text));

   432

   433

	if (_network_server) {

   434

		// If we are the server, we queue the command in our 'special' queue.

   435

		//   In theory, we could execute the command right away, but then the

   436

		//   client on the server can do everything 1 tick faster than others.

   437

		//   So to keep the game fair, we delay the command with 1 tick

   438

		//   which gives about the same speed as most clients.

   439

		NetworkClientState *cs;

   440

   441

		// And we queue it for delivery to the clients

   442

		FOR_ALL_CLIENTS(cs) {

   443

			if (cs->status > STATUS_AUTH) NetworkAddCommandQueue(cs, c);

   444

		}

   445

   446

		// Only the server gets the callback, because clients should not get them

   447

		c->callback = temp_callback;

   448

		if (_local_command_queue == NULL) {

   449

			_local_command_queue = c;

   450

		} else {

   451

			// Find last packet

   452

			CommandPacket *cp = _local_command_queue;

   453

			while (cp->next != NULL) cp = cp->next;

   454

			cp->next = c;

   455

		}

   456

   457

		return;

   458

	}

   459

   460

	// Clients send their command to the server and forget all about the packet

   461

	c->callback = temp_callback;

   462

	SEND_COMMAND(PACKET_CLIENT_COMMAND)(c);

   463

}

   464

   465

// Execute a DoCommand we received from the network

   466

void NetworkExecuteCommand(CommandPacket *cp)

   467

{

   468

	_current_player = cp->player;

   469

	_cmd_text = cp->text;

   470

	/* cp->callback is unsigned. so we don't need to do lower bounds checking. */

   471

	if (cp->callback > _callback_table_count) {

   472

		DEBUG(net,0) ("[NET] Received out-of-bounds callback! (%d)", cp->callback);

   473

		cp->callback = 0;

   474

	}

   475

	DoCommandP(cp->tile, cp->p1, cp->p2, _callback_table[cp->callback], cp->cmd | CMD_NETWORK_COMMAND);

   476

}

   477

   478

#endif /* ENABLE_NETWORK */