1

/* $Id$ */

     2

     3

/** @file saveload.cpp

     4

 * All actions handling saving and loading goes on in this file. The general actions

     5

 * are as follows for saving a game (loading is analogous):

     6

 * <ol>

     7

 * <li>initialize the writer by creating a temporary memory-buffer for it

     8

 * <li>go through all to-be saved elements, each 'chunk' (ChunkHandler) prefixed by a label

     9

 * <li>use their description array (SaveLoad) to know what elements to save and in what version

    10

 *    of the game it was active (used when loading)

    11

 * <li>write all data byte-by-byte to the temporary buffer so it is endian-safe

    12

 * <li>when the buffer is full; flush it to the output (eg save to file) (_sl.buf, _sl.bufp, _sl.bufe)

    13

 * <li>repeat this until everything is done, and flush any remaining output to file

    14

 * </ol>

    15

 */

    16

#include "stdafx.h"

    17

#include "openttd.h"

    18

#include "debug.h"

    19

#include "station_base.h"

    20

#include "thread.h"

    21

#include "town.h"

    22

#include "saveload.h"

    23

#include "network/network.h"

    24

#include "variables.h"

    25

#include "window_func.h"

    26

#include "strings_func.h"

    27

#include "gfx_func.h"

    28

#include "core/alloc_func.hpp"

    29

#include "functions.h"

    30

#include "core/endian_func.hpp"

    31

#include "vehicle_base.h"

    32

#include "autoreplace_base.h"

    33

#include "statusbar_gui.h"

    34

#include <list>

    35

    36

#include "table/strings.h"

    37

    38

extern const uint16 SAVEGAME_VERSION = 97;

    39

    40

SavegameType _savegame_type; ///< type of savegame we are loading

    41

    42

uint32 _ttdp_version;     ///< version of TTDP savegame (if applicable)

    43

uint16 _sl_version;       ///< the major savegame version identifier

    44

byte   _sl_minor_version; ///< the minor savegame version, DO NOT USE!

    45

    46

typedef void WriterProc(size_t len);

    47

typedef size_t ReaderProc();

    48

    49

/** The saveload struct, containing reader-writer functions, bufffer, version, etc. */

    50

static struct {

    51

	bool save;                           ///< are we doing a save or a load atm. True when saving

    52

	byte need_length;                    ///< ???

    53

	byte block_mode;                     ///< ???

    54

	bool error;                          ///< did an error occur or not

    55

    56

	size_t obj_len;                      ///< the length of the current object we are busy with

    57

	int array_index, last_array_index;   ///< in the case of an array, the current and last positions

    58

    59

	size_t offs_base;                    ///< the offset in number of bytes since we started writing data (eg uncompressed savegame size)

    60

    61

	WriterProc *write_bytes;             ///< savegame writer function

    62

	ReaderProc *read_bytes;              ///< savegame loader function

    63

    64

	const ChunkHandler* const *chs;      ///< the chunk of data that is being processed atm (vehicles, signs, etc.)

    65

    66

	/* When saving/loading savegames, they are always saved to a temporary memory-place

    67

	 * to be flushed to file (save) or to final place (load) when full. */

    68

	byte *bufp, *bufe;                   ///< bufp(ointer) gives the current position in the buffer bufe(nd) gives the end of the buffer

    69

    70

	/* these 3 may be used by compressor/decompressors. */

    71

	byte *buf;                           ///< pointer to temporary memory to read/write, initialized by SaveLoadFormat->initread/write

    72

	byte *buf_ori;                       ///< pointer to the original memory location of buf, used to free it afterwards

    73

	uint bufsize;                        ///< the size of the temporary memory *buf

    74

	FILE *fh;                            ///< the file from which is read or written to

    75

    76

	void (*excpt_uninit)();              ///< the function to execute on any encountered error

    77

	StringID error_str;                  ///< the translateable error message to show

    78

	char *extra_msg;                     ///< the error message

    79

} _sl;

    80

    81

    82

enum NeedLengthValues {NL_NONE = 0, NL_WANTLENGTH = 1, NL_CALCLENGTH = 2};

    83

    84

/** Error handler, calls longjmp to simulate an exception.

    85

 * @todo this was used to have a central place to handle errors, but it is

    86

 * pretty ugly, and seriously interferes with any multithreaded approaches */

    87

static void NORETURN SlError(StringID string, const char *extra_msg = NULL)

    88

{

    89

	_sl.error_str = string;

    90

	free(_sl.extra_msg);

    91

	_sl.extra_msg = (extra_msg == NULL) ? NULL : strdup(extra_msg);

    92

	throw std::exception();

    93

}

    94

    95

typedef void (*AsyncSaveFinishProc)();

    96

static AsyncSaveFinishProc _async_save_finish = NULL;

    97

    98

/**

    99

 * Called by save thread to tell we finished saving.

   100

 */

   101

static void SetAsyncSaveFinish(AsyncSaveFinishProc proc)

   102

{

   103

	if (_exit_game) return;

   104

	while (_async_save_finish != NULL) CSleep(10);

   105

   106

	_async_save_finish = proc;

   107

}

   108

   109

/**

   110

 * Handle async save finishes.

   111

 */

   112

void ProcessAsyncSaveFinish()

   113

{

   114

	if (_async_save_finish == NULL) return;

   115

   116

	_async_save_finish();

   117

   118

	_async_save_finish = NULL;

   119

}

   120

   121

/**

   122

 * Fill the input buffer by reading from the file with the given reader

   123

 */

   124

static void SlReadFill()

   125

{

   126

	size_t len = _sl.read_bytes();

   127

	if (len == 0) SlError(STR_GAME_SAVELOAD_ERROR_BROKEN_SAVEGAME, "Unexpected end of chunk");

   128

   129

	_sl.bufp = _sl.buf;

   130

	_sl.bufe = _sl.buf + len;

   131

	_sl.offs_base += len;

   132

}

   133

   134

static inline size_t SlGetOffs() {return _sl.offs_base - (_sl.bufe - _sl.bufp);}

   135

   136

/** Return the size in bytes of a certain type of normal/atomic variable

   137

 * as it appears in memory. See VarTypes

   138

 * @param conv VarType type of variable that is used for calculating the size

   139

 * @return Return the size of this type in bytes */

   140

static inline byte SlCalcConvMemLen(VarType conv)

   141

{

   142

	static const byte conv_mem_size[] = {1, 1, 1, 2, 2, 4, 4, 8, 8, 0};

   143

	byte length = GB(conv, 4, 4);

   144

	assert(length < lengthof(conv_mem_size));

   145

	return conv_mem_size[length];

   146

}

   147

   148

/** Return the size in bytes of a certain type of normal/atomic variable

   149

 * as it appears in a saved game. See VarTypes

   150

 * @param conv VarType type of variable that is used for calculating the size

   151

 * @return Return the size of this type in bytes */

   152

static inline byte SlCalcConvFileLen(VarType conv)

   153

{

   154

	static const byte conv_file_size[] = {1, 1, 2, 2, 4, 4, 8, 8, 2};

   155

	byte length = GB(conv, 0, 4);

   156

	assert(length < lengthof(conv_file_size));

   157

	return conv_file_size[length];

   158

}

   159

   160

/** Return the size in bytes of a reference (pointer) */

   161

static inline size_t SlCalcRefLen() {return CheckSavegameVersion(69) ? 2 : 4;}

   162

   163

/** Flush the output buffer by writing to disk with the given reader.

   164

 * If the buffer pointer has not yet been set up, set it up now. Usually

   165

 * only called when the buffer is full, or there is no more data to be processed

   166

 */

   167

static void SlWriteFill()

   168

{

   169

	/* flush the buffer to disk (the writer) */

   170

	if (_sl.bufp != NULL) {

   171

		uint len = _sl.bufp - _sl.buf;

   172

		_sl.offs_base += len;

   173

		if (len) _sl.write_bytes(len);

   174

	}

   175

   176

	/* All the data from the buffer has been written away, rewind to the beginning

   177

	 * to start reading in more data */

   178

	_sl.bufp = _sl.buf;

   179

	_sl.bufe = _sl.buf + _sl.bufsize;

   180

}

   181

   182

/** Read in a single byte from file. If the temporary buffer is full,

   183

 * flush it to its final destination

   184

 * @return return the read byte from file

   185

 */

   186

static inline byte SlReadByteInternal()

   187

{

   188

	if (_sl.bufp == _sl.bufe) SlReadFill();

   189

	return *_sl.bufp++;

   190

}

   191

   192

/** Wrapper for SlReadByteInternal */

   193

byte SlReadByte() {return SlReadByteInternal();}

   194

   195

/** Write away a single byte from memory. If the temporary buffer is full,

   196

 * flush it to its destination (file)

   197

 * @param b the byte that is currently written

   198

 */

   199

static inline void SlWriteByteInternal(byte b)

   200

{

   201

	if (_sl.bufp == _sl.bufe) SlWriteFill();

   202

	*_sl.bufp++ = b;

   203

}

   204

   205

/** Wrapper for SlWriteByteInternal */

   206

void SlWriteByte(byte b) {SlWriteByteInternal(b);}

   207

   208

static inline int SlReadUint16()

   209

{

   210

	int x = SlReadByte() << 8;

   211

	return x | SlReadByte();

   212

}

   213

   214

static inline uint32 SlReadUint32()

   215

{

   216

	uint32 x = SlReadUint16() << 16;

   217

	return x | SlReadUint16();

   218

}

   219

   220

static inline uint64 SlReadUint64()

   221

{

   222

	uint32 x = SlReadUint32();

   223

	uint32 y = SlReadUint32();

   224

	return (uint64)x << 32 | y;

   225

}

   226

   227

static inline void SlWriteUint16(uint16 v)

   228

{

   229

	SlWriteByte(GB(v, 8, 8));

   230

	SlWriteByte(GB(v, 0, 8));

   231

}

   232

   233

static inline void SlWriteUint32(uint32 v)

   234

{

   235

	SlWriteUint16(GB(v, 16, 16));

   236

	SlWriteUint16(GB(v,  0, 16));

   237

}

   238

   239

static inline void SlWriteUint64(uint64 x)

   240

{

   241

	SlWriteUint32((uint32)(x >> 32));

   242

	SlWriteUint32((uint32)x);

   243

}

   244

   245

/**

   246

 * Read in the header descriptor of an object or an array.

   247

 * If the highest bit is set (7), then the index is bigger than 127

   248

 * elements, so use the next byte to read in the real value.

   249

 * The actual value is then both bytes added with the first shifted

   250

 * 8 bits to the left, and dropping the highest bit (which only indicated a big index).

   251

 * x = ((x & 0x7F) << 8) + SlReadByte();

   252

 * @return Return the value of the index

   253

 */

   254

static uint SlReadSimpleGamma()

   255

{

   256

	uint i = SlReadByte();

   257

	if (HasBit(i, 7)) {

   258

		i &= ~0x80;

   259

		if (HasBit(i, 6)) {

   260

			i &= ~0x40;

   261

			if (HasBit(i, 5)) {

   262

				i &= ~0x20;

   263

				if (HasBit(i, 4))

   264

					SlError(STR_GAME_SAVELOAD_ERROR_BROKEN_SAVEGAME, "Unsupported gamma");

   265

				i = (i << 8) | SlReadByte();

   266

			}

   267

			i = (i << 8) | SlReadByte();

   268

		}

   269

		i = (i << 8) | SlReadByte();

   270

	}

   271

	return i;

   272

}

   273

   274

/**

   275

 * Write the header descriptor of an object or an array.

   276

 * If the element is bigger than 127, use 2 bytes for saving

   277

 * and use the highest byte of the first written one as a notice

   278

 * that the length consists of 2 bytes, etc.. like this:

   279

 * 0xxxxxxx

   280

 * 10xxxxxx xxxxxxxx

   281

 * 110xxxxx xxxxxxxx xxxxxxxx

   282

 * 1110xxxx xxxxxxxx xxxxxxxx xxxxxxxx

   283

 * @param i Index being written

   284

 */

   285

   286

static void SlWriteSimpleGamma(size_t i)

   287

{

   288

	if (i >= (1 << 7)) {

   289

		if (i >= (1 << 14)) {

   290

			if (i >= (1 << 21)) {

   291

				assert(i < (1 << 28));

   292

				SlWriteByte((byte)(0xE0 | (i >> 24)));

   293

				SlWriteByte((byte)(i >> 16));

   294

			} else {

   295

				SlWriteByte((byte)(0xC0 | (i >> 16)));

   296

			}

   297

			SlWriteByte((byte)(i >> 8));

   298

		} else {

   299

			SlWriteByte((byte)(0x80 | (i >> 8)));

   300

		}

   301

	}

   302

	SlWriteByte((byte)i);

   303

}

   304

   305

/** Return how many bytes used to encode a gamma value */

   306

static inline uint SlGetGammaLength(size_t i)

   307

{

   308

	return 1 + (i >= (1 << 7)) + (i >= (1 << 14)) + (i >= (1 << 21));

   309

}

   310

   311

static inline uint SlReadSparseIndex() {return SlReadSimpleGamma();}

   312

static inline void SlWriteSparseIndex(uint index) {SlWriteSimpleGamma(index);}

   313

   314

static inline uint SlReadArrayLength() {return SlReadSimpleGamma();}

   315

static inline void SlWriteArrayLength(size_t length) {SlWriteSimpleGamma(length);}

   316

static inline uint SlGetArrayLength(size_t length) {return SlGetGammaLength(length);}

   317

   318

void SlSetArrayIndex(uint index)

   319

{

   320

	_sl.need_length = NL_WANTLENGTH;

   321

	_sl.array_index = index;

   322

}

   323

   324

static size_t _next_offs;

   325

   326

/**

   327

 * Iterate through the elements of an array and read the whole thing

   328

 * @return The index of the object, or -1 if we have reached the end of current block

   329

 */

   330

int SlIterateArray()

   331

{

   332

	int index;

   333

   334

	/* After reading in the whole array inside the loop

   335

	 * we must have read in all the data, so we must be at end of current block. */

   336

	if (_next_offs != 0 && SlGetOffs() != _next_offs) SlError(STR_GAME_SAVELOAD_ERROR_BROKEN_SAVEGAME, "Invalid chunk size");

   337

   338

	while (true) {

   339

		uint length = SlReadArrayLength();

   340

		if (length == 0) {

   341

			_next_offs = 0;

   342

			return -1;

   343

		}

   344

   345

		_sl.obj_len = --length;

   346

		_next_offs = SlGetOffs() + length;

   347

   348

		switch (_sl.block_mode) {

   349

		case CH_SPARSE_ARRAY: index = (int)SlReadSparseIndex(); break;

   350

		case CH_ARRAY:        index = _sl.array_index++; break;

   351

		default:

   352

			DEBUG(sl, 0, "SlIterateArray error");

   353

			return -1; // error

   354

		}

   355

   356

		if (length != 0) return index;

   357

	}

   358

}

   359

   360

/**

   361

 * Sets the length of either a RIFF object or the number of items in an array.

   362

 * This lets us load an object or an array of arbitrary size

   363

 * @param length The length of the sought object/array

   364

 */

   365

void SlSetLength(size_t length)

   366

{

   367

	assert(_sl.save);

   368

   369

	switch (_sl.need_length) {

   370

	case NL_WANTLENGTH:

   371

		_sl.need_length = NL_NONE;

   372

		switch (_sl.block_mode) {

   373

		case CH_RIFF:

   374

			/* Ugly encoding of >16M RIFF chunks

   375

			 * The lower 24 bits are normal

   376

			 * The uppermost 4 bits are bits 24:27 */

   377

			assert(length < (1 << 28));

   378

			SlWriteUint32((uint32)((length & 0xFFFFFF) | ((length >> 24) << 28)));

   379

			break;

   380

		case CH_ARRAY:

   381

			assert(_sl.last_array_index <= _sl.array_index);

   382

			while (++_sl.last_array_index <= _sl.array_index)

   383

				SlWriteArrayLength(1);

   384

			SlWriteArrayLength(length + 1);

   385

			break;

   386

		case CH_SPARSE_ARRAY:

   387

			SlWriteArrayLength(length + 1 + SlGetArrayLength(_sl.array_index)); // Also include length of sparse index.

   388

			SlWriteSparseIndex(_sl.array_index);

   389

			break;

   390

		default: NOT_REACHED();

   391

		} break;

   392

	case NL_CALCLENGTH:

   393

		_sl.obj_len += (int)length;

   394

		break;

   395

	}

   396

}

   397

   398

/**

   399

 * Save/Load bytes. These do not need to be converted to Little/Big Endian

   400

 * so directly write them or read them to/from file

   401

 * @param ptr The source or destination of the object being manipulated

   402

 * @param length number of bytes this fast CopyBytes lasts

   403

 */

   404

static void SlCopyBytes(void *ptr, size_t length)

   405

{

   406

	byte *p = (byte*)ptr;

   407

   408

	if (_sl.save) {

   409

		for (; length != 0; length--) {SlWriteByteInternal(*p++);}

   410

	} else {

   411

		for (; length != 0; length--) {*p++ = SlReadByteInternal();}

   412

	}

   413

}

   414

   415

/** Read in bytes from the file/data structure but don't do

   416

 * anything with them, discarding them in effect

   417

 * @param length The amount of bytes that is being treated this way

   418

 */

   419

static inline void SlSkipBytes(size_t length)

   420

{

   421

	for (; length != 0; length--) SlReadByte();

   422

}

   423

   424

/* Get the length of the current object */

   425

size_t SlGetFieldLength() {return _sl.obj_len;}

   426

   427

/** Return a signed-long version of the value of a setting

   428

 * @param ptr pointer to the variable

   429

 * @param conv type of variable, can be a non-clean

   430

 * type, eg one with other flags because it is parsed

   431

 * @return returns the value of the pointer-setting */

   432

int64 ReadValue(const void *ptr, VarType conv)

   433

{

   434

	switch (GetVarMemType(conv)) {

   435

	case SLE_VAR_BL:  return (*(bool*)ptr != 0);

   436

	case SLE_VAR_I8:  return *(int8*  )ptr;

   437

	case SLE_VAR_U8:  return *(byte*  )ptr;

   438

	case SLE_VAR_I16: return *(int16* )ptr;

   439

	case SLE_VAR_U16: return *(uint16*)ptr;

   440

	case SLE_VAR_I32: return *(int32* )ptr;

   441

	case SLE_VAR_U32: return *(uint32*)ptr;

   442

	case SLE_VAR_I64: return *(int64* )ptr;

   443

	case SLE_VAR_U64: return *(uint64*)ptr;

   444

	case SLE_VAR_NULL:return 0;

   445

	default: NOT_REACHED();

   446

	}

   447

   448

	/* useless, but avoids compiler warning this way */

   449

	return 0;

   450

}

   451

   452

/** Write the value of a setting

   453

 * @param ptr pointer to the variable

   454

 * @param conv type of variable, can be a non-clean type, eg

   455

 *             with other flags. It is parsed upon read

   456

 * @param val the new value being given to the variable */

   457

void WriteValue(void *ptr, VarType conv, int64 val)

   458

{

   459

	switch (GetVarMemType(conv)) {

   460

	case SLE_VAR_BL:  *(bool  *)ptr = (val != 0);  break;

   461

	case SLE_VAR_I8:  *(int8  *)ptr = val; break;

   462

	case SLE_VAR_U8:  *(byte  *)ptr = val; break;

   463

	case SLE_VAR_I16: *(int16 *)ptr = val; break;

   464

	case SLE_VAR_U16: *(uint16*)ptr = val; break;

   465

	case SLE_VAR_I32: *(int32 *)ptr = val; break;

   466

	case SLE_VAR_U32: *(uint32*)ptr = val; break;

   467

	case SLE_VAR_I64: *(int64 *)ptr = val; break;

   468

	case SLE_VAR_U64: *(uint64*)ptr = val; break;

   469

	case SLE_VAR_NAME: *(char**)ptr = CopyFromOldName(val); break;

   470

	case SLE_VAR_NULL: break;

   471

	default: NOT_REACHED();

   472

	}

   473

}

   474

   475

/**

   476

 * Handle all conversion and typechecking of variables here.

   477

 * In the case of saving, read in the actual value from the struct

   478

 * and then write them to file, endian safely. Loading a value

   479

 * goes exactly the opposite way

   480

 * @param ptr The object being filled/read

   481

 * @param conv VarType type of the current element of the struct

   482

 */

   483

static void SlSaveLoadConv(void *ptr, VarType conv)

   484

{

   485

	int64 x = 0;

   486

   487

	if (_sl.save) { // SAVE values

   488

		/* Read a value from the struct. These ARE endian safe. */

   489

		x = ReadValue(ptr, conv);