OpenTTD

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

saveload.cpp
Go to the documentation of this file.
1 /* $Id: saveload.cpp 27572 2016-05-22 10:10:17Z frosch $ */
2
3 /*
4 * This file is part of OpenTTD.
5 * OpenTTD 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, version 2.
6 * OpenTTD 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.
7 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8 */
9
24 #include "../stdafx.h"
25 #include "../debug.h"
26 #include "../station_base.h"
27 #include "../thread/thread.h"
28 #include "../town.h"
29 #include "../network/network.h"
30 #include "../window_func.h"
31 #include "../strings_func.h"
32 #include "../core/endian_func.hpp"
33 #include "../vehicle_base.h"
34 #include "../company_func.h"
35 #include "../date_func.h"
36 #include "../autoreplace_base.h"
37 #include "../roadstop_base.h"
38 #include "../linkgraph/linkgraph.h"
39 #include "../linkgraph/linkgraphjob.h"
40 #include "../statusbar_gui.h"
41 #include "../fileio_func.h"
42 #include "../gamelog.h"
43 #include "../string_func.h"
44 #include "../fios.h"
45 #include "../error.h"
46
47 #include "table/strings.h"
48
49 #include "saveload_internal.h"
50 #include "saveload_filter.h"
51
52 #include "../safeguards.h"
53
54 /*
55 * Previous savegame versions, the trunk revision where they were
56 * introduced and the released version that had that particular
57 * savegame version.
58 * Up to savegame version 18 there is a minor version as well.
59 *
60 * 1.0 0.1.x, 0.2.x
61 * 2.0 0.3.0
62 * 2.1 0.3.1, 0.3.2
63 * 3.x lost
64 * 4.0 1
65 * 4.1 122 0.3.3, 0.3.4
66 * 4.2 1222 0.3.5
67 * 4.3 1417
68 * 4.4 1426
69 * 5.0 1429
70 * 5.1 1440
71 * 5.2 1525 0.3.6
72 * 6.0 1721
73 * 6.1 1768
74 * 7.0 1770
75 * 8.0 1786
76 * 9.0 1909
77 * 10.0 2030
78 * 11.0 2033
79 * 11.1 2041
80 * 12.1 2046
81 * 13.1 2080 0.4.0, 0.4.0.1
82 * 14.0 2441
83 * 15.0 2499
84 * 16.0 2817
85 * 16.1 3155
86 * 17.0 3212
87 * 17.1 3218
88 * 18 3227
89 * 19 3396
90 * 20 3403
91 * 21 3472 0.4.x
92 * 22 3726
93 * 23 3915
94 * 24 4150
95 * 25 4259
96 * 26 4466
97 * 27 4757
98 * 28 4987
99 * 29 5070
100 * 30 5946
101 * 31 5999
102 * 32 6001
103 * 33 6440
104 * 34 6455
105 * 35 6602
106 * 36 6624
107 * 37 7182
108 * 38 7195
109 * 39 7269
110 * 40 7326
111 * 41 7348 0.5.x
112 * 42 7573
113 * 43 7642
114 * 44 8144
115 * 45 8501
116 * 46 8705
117 * 47 8735
118 * 48 8935
119 * 49 8969
120 * 50 8973
121 * 51 8978
122 * 52 9066
123 * 53 9316
124 * 54 9613
125 * 55 9638
126 * 56 9667
127 * 57 9691
128 * 58 9762
129 * 59 9779
130 * 60 9874
131 * 61 9892
132 * 62 9905
133 * 63 9956
134 * 64 10006
135 * 65 10210
136 * 66 10211
137 * 67 10236
138 * 68 10266
139 * 69 10319
140 * 70 10541
141 * 71 10567
142 * 72 10601
143 * 73 10903
144 * 74 11030
145 * 75 11107
146 * 76 11139
147 * 77 11172
148 * 78 11176
149 * 79 11188
150 * 80 11228
151 * 81 11244
152 * 82 11410
153 * 83 11589
154 * 84 11822
155 * 85 11874
156 * 86 12042
157 * 87 12129
158 * 88 12134
159 * 89 12160
160 * 90 12293
161 * 91 12347
162 * 92 12381 0.6.x
163 * 93 12648
164 * 94 12816
165 * 95 12924
166 * 96 13226
167 * 97 13256
168 * 98 13375
169 * 99 13838
170 * 100 13952
171 * 101 14233
172 * 102 14332
173 * 103 14598
174 * 104 14735
175 * 105 14803
176 * 106 14919
177 * 107 15027
178 * 108 15045
179 * 109 15075
180 * 110 15148
181 * 111 15190
182 * 112 15290
183 * 113 15340
184 * 114 15601
185 * 115 15695
186 * 116 15893 0.7.x
187 * 117 16037
188 * 118 16129
189 * 119 16242
190 * 120 16439
191 * 121 16694
192 * 122 16855
193 * 123 16909
194 * 124 16993
195 * 125 17113
196 * 126 17433
197 * 127 17439
198 * 128 18281
199 * 129 18292
200 * 130 18404
201 * 131 18481
202 * 132 18522
203 * 133 18674
204 * 134 18703
205 * 135 18719
206 * 136 18764
207 * 137 18912
208 * 138 18942 1.0.x
209 * 139 19346
210 * 140 19382
211 * 141 19799
212 * 142 20003
213 * 143 20048
214 * 144 20334
215 * 145 20376
216 * 146 20446
217 * 147 20621
218 * 148 20659
219 * 149 20832
220 * 150 20857
221 * 151 20918
222 * 152 21171
223 * 153 21263
224 * 154 21426
225 * 155 21453
226 * 156 21728
227 * 157 21862
228 * 158 21933
229 * 159 21962
230 * 160 21974 1.1.x
231 * 161 22567
232 * 162 22713
233 * 163 22767
234 * 164 23290
235 * 165 23304
236 * 166 23415
237 * 167 23504
238 * 168 23637
239 * 169 23816
240 * 170 23826
241 * 171 23835
242 * 172 23947
243 * 173 23967 1.2.0-RC1
244 * 174 23973 1.2.x
245 * 175 24136
246 * 176 24446
247 * 177 24619
248 * 178 24789
249 * 179 24810
250 * 180 24998 1.3.x
251 * 181 25012
252 * 182 25296
253 * 183 25363
254 * 184 25508
255 * 185 25620
256 * 186 25833
257 * 187 25899
258 * 188 26169 1.4.x
259 * 189 26450
260 * 190 26547
261 * 191 26646
262 * 192 26700
263 * 193 26802
264 * 194 26881 1.5.x, 1.6.0
265 * 195 27572 1.6.x
266 */
267 extern const uint16 SAVEGAME_VERSION = 195;
268
269 SavegameType _savegame_type;
270
271 uint32 _ttdp_version;
272 uint16 _sl_version;
273 byte _sl_minor_version;
274 char _savegame_format[8];
275 bool _do_autosave;
276
278 enum SaveLoadAction {
279 SLA_LOAD,
280 SLA_SAVE,
281 SLA_PTRS,
282 SLA_NULL,
283 SLA_LOAD_CHECK,
284 };
285
286 enum NeedLength {
287 NL_NONE = 0,
288 NL_WANTLENGTH = 1,
289 NL_CALCLENGTH = 2,
290 };
291
293 static const size_t MEMORY_CHUNK_SIZE = 128 * 1024;
294
296 struct ReadBuffer {
297 byte buf[MEMORY_CHUNK_SIZE];
298 byte *bufp;
299 byte *bufe;
300 LoadFilter *reader;
301 size_t read;
302
307 ReadBuffer(LoadFilter *reader) : bufp(NULL), bufe(NULL), reader(reader), read(0)
308 {
309 }
310
311 inline byte ReadByte()
312 {
313 if (this->bufp == this->bufe) {
314 size_t len = this->reader->Read(this->buf, lengthof(this->buf));
315 if (len == 0) SlErrorCorrupt("Unexpected end of chunk");
316
317 this->read += len;
318 this->bufp = this->buf;
319 this->bufe = this->buf + len;
320 }
321
322 return *this->bufp++;
323 }
324
329 size_t GetSize() const
330 {
331 return this->read - (this->bufe - this->bufp);
332 }
333 };
334
335
337 struct MemoryDumper {
338 AutoFreeSmallVector<byte *, 16> blocks;
339 byte *buf;
340 byte *bufe;
341
343 MemoryDumper() : buf(NULL), bufe(NULL)
344 {
345 }
346
351 inline void WriteByte(byte b)
352 {
353 /* Are we at the end of this chunk? */
354 if (this->buf == this->bufe) {
355 this->buf = CallocT<byte>(MEMORY_CHUNK_SIZE);
356 *this->blocks.Append() = this->buf;
357 this->bufe = this->buf + MEMORY_CHUNK_SIZE;
358 }
359
360 *this->buf++ = b;
361 }
362
367 void Flush(SaveFilter *writer)
368 {
369 uint i = 0;
370 size_t t = this->GetSize();
371
372 while (t > 0) {
373 size_t to_write = min(MEMORY_CHUNK_SIZE, t);
374
375 writer->Write(this->blocks[i++], to_write);
376 t -= to_write;
377 }
378
379 writer->Finish();
380 }
381
386 size_t GetSize() const
387 {
388 return this->blocks.Length() * MEMORY_CHUNK_SIZE - (this->bufe - this->buf);
389 }
390 };
391
393 struct SaveLoadParams {
394 SaveLoadAction action;
395 NeedLength need_length;
396 byte block_mode;
397 bool error;
398
399 size_t obj_len;
400 int array_index, last_array_index;
401
402 MemoryDumper *dumper;
403 SaveFilter *sf;
404
405 ReadBuffer *reader;
406 LoadFilter *lf;
407
408 StringID error_str;
409 char *extra_msg;
410
411 byte ff_state;
412 bool saveinprogress;
413 };
414
415 static SaveLoadParams _sl;
416
417 /* these define the chunks */
418 extern const ChunkHandler _gamelog_chunk_handlers[];
419 extern const ChunkHandler _map_chunk_handlers[];
420 extern const ChunkHandler _misc_chunk_handlers[];
421 extern const ChunkHandler _name_chunk_handlers[];
422 extern const ChunkHandler _cheat_chunk_handlers[] ;
423 extern const ChunkHandler _setting_chunk_handlers[];
424 extern const ChunkHandler _company_chunk_handlers[];
425 extern const ChunkHandler _engine_chunk_handlers[];
426 extern const ChunkHandler _veh_chunk_handlers[];
427 extern const ChunkHandler _waypoint_chunk_handlers[];
428 extern const ChunkHandler _depot_chunk_handlers[];
429 extern const ChunkHandler _order_chunk_handlers[];
430 extern const ChunkHandler _town_chunk_handlers[];
431 extern const ChunkHandler _sign_chunk_handlers[];
432 extern const ChunkHandler _station_chunk_handlers[];
433 extern const ChunkHandler _industry_chunk_handlers[];
434 extern const ChunkHandler _economy_chunk_handlers[];
435 extern const ChunkHandler _subsidy_chunk_handlers[];
436 extern const ChunkHandler _cargomonitor_chunk_handlers[];
437 extern const ChunkHandler _goal_chunk_handlers[];
438 extern const ChunkHandler _story_page_chunk_handlers[];
439 extern const ChunkHandler _ai_chunk_handlers[];
440 extern const ChunkHandler _game_chunk_handlers[];
441 extern const ChunkHandler _animated_tile_chunk_handlers[];
442 extern const ChunkHandler _newgrf_chunk_handlers[];
443 extern const ChunkHandler _group_chunk_handlers[];
444 extern const ChunkHandler _cargopacket_chunk_handlers[];
445 extern const ChunkHandler _autoreplace_chunk_handlers[];
446 extern const ChunkHandler _labelmaps_chunk_handlers[];
447 extern const ChunkHandler _linkgraph_chunk_handlers[];
448 extern const ChunkHandler _airport_chunk_handlers[];
449 extern const ChunkHandler _object_chunk_handlers[];
450 extern const ChunkHandler _persistent_storage_chunk_handlers[];
451
453 static const ChunkHandler * const _chunk_handlers[] = {
454 _gamelog_chunk_handlers,
455 _map_chunk_handlers,
456 _misc_chunk_handlers,
457 _name_chunk_handlers,
458 _cheat_chunk_handlers,
459 _setting_chunk_handlers,
460 _veh_chunk_handlers,
461 _waypoint_chunk_handlers,
462 _depot_chunk_handlers,
463 _order_chunk_handlers,
464 _industry_chunk_handlers,
465 _economy_chunk_handlers,
466 _subsidy_chunk_handlers,
467 _cargomonitor_chunk_handlers,
468 _goal_chunk_handlers,
469 _story_page_chunk_handlers,
470 _engine_chunk_handlers,
471 _town_chunk_handlers,
472 _sign_chunk_handlers,
473 _station_chunk_handlers,
474 _company_chunk_handlers,
475 _ai_chunk_handlers,
476 _game_chunk_handlers,
477 _animated_tile_chunk_handlers,
478 _newgrf_chunk_handlers,
479 _group_chunk_handlers,
480 _cargopacket_chunk_handlers,
481 _autoreplace_chunk_handlers,
482 _labelmaps_chunk_handlers,
483 _linkgraph_chunk_handlers,
484 _airport_chunk_handlers,
485 _object_chunk_handlers,
486 _persistent_storage_chunk_handlers,
487 NULL,
488 };
489
494 #define FOR_ALL_CHUNK_HANDLERS(ch) \
495 for (const ChunkHandler * const *chsc = _chunk_handlers; *chsc != NULL; chsc++) \
496 for (const ChunkHandler *ch = *chsc; ch != NULL; ch = (ch->flags & CH_LAST) ? NULL : ch + 1)
497
499 static void SlNullPointers()
500 {
501 _sl.action = SLA_NULL;
502
503 /* We don't want any savegame conversion code to run
504 * during NULLing; especially those that try to get
505 * pointers from other pools. */
506 _sl_version = SAVEGAME_VERSION;
507
508 DEBUG(sl, 1, "Nulling pointers");
509
510 FOR_ALL_CHUNK_HANDLERS(ch) {
511 if (ch->ptrs_proc != NULL) {
512 DEBUG(sl, 2, "Nulling pointers for %c%c%c%c", ch->id >> 24, ch->id >> 16, ch->id >> 8, ch->id);
513 ch->ptrs_proc();
514 }
515 }
516
517 DEBUG(sl, 1, "All pointers nulled");
518
519 assert(_sl.action == SLA_NULL);
520 }
521
530 void NORETURN SlError(StringID string, const char *extra_msg)
531 {
532 /* Distinguish between loading into _load_check_data vs. normal save/load. */
533 if (_sl.action == SLA_LOAD_CHECK) {
534 _load_check_data.error = string;
535 free(_load_check_data.error_data);
536 _load_check_data.error_data = (extra_msg == NULL) ? NULL : stredup(extra_msg);
537 } else {
538 _sl.error_str = string;
539 free(_sl.extra_msg);
540 _sl.extra_msg = (extra_msg == NULL) ? NULL : stredup(extra_msg);
541 }
542
543 /* We have to NULL all pointers here; we might be in a state where
544 * the pointers are actually filled with indices, which means that
545 * when we access them during cleaning the pool dereferences of
546 * those indices will be made with segmentation faults as result. */
547 if (_sl.action == SLA_LOAD || _sl.action == SLA_PTRS) SlNullPointers();
548 throw std::exception();
549 }
550
558 void NORETURN SlErrorCorrupt(const char *msg)
559 {
560 SlError(STR_GAME_SAVELOAD_ERROR_BROKEN_SAVEGAME, msg);
561 }
562
563
564 typedef void (*AsyncSaveFinishProc)();
565 static AsyncSaveFinishProc _async_save_finish = NULL;
566 static ThreadObject *_save_thread;
567
572 static void SetAsyncSaveFinish(AsyncSaveFinishProc proc)
573 {
574 if (_exit_game) return;
575 while (_async_save_finish != NULL) CSleep(10);
576
577 _async_save_finish = proc;
578 }
579
583 void ProcessAsyncSaveFinish()
584 {
585 if (_async_save_finish == NULL) return;
586
587 _async_save_finish();
588
589 _async_save_finish = NULL;
590
591 if (_save_thread != NULL) {
592 _save_thread->Join();
593 delete _save_thread;
594 _save_thread = NULL;
595 }
596 }
597
602 byte SlReadByte()
603 {
604 return _sl.reader->ReadByte();
605 }
606
611 void SlWriteByte(byte b)
612 {
613 _sl.dumper->WriteByte(b);
614 }
615
616 static inline int SlReadUint16()
617 {
618 int x = SlReadByte() << 8;
619 return x | SlReadByte();
620 }
621
622 static inline uint32 SlReadUint32()
623 {
624 uint32 x = SlReadUint16() << 16;
625 return x | SlReadUint16();
626 }
627
628 static inline uint64 SlReadUint64()
629 {
630 uint32 x = SlReadUint32();
631 uint32 y = SlReadUint32();
632 return (uint64)x << 32 | y;
633 }
634
635 static inline void SlWriteUint16(uint16 v)
636 {
637 SlWriteByte(GB(v, 8, 8));
638 SlWriteByte(GB(v, 0, 8));
639 }
640
641 static inline void SlWriteUint32(uint32 v)
642 {
643 SlWriteUint16(GB(v, 16, 16));
644 SlWriteUint16(GB(v, 0, 16));
645 }
646
647 static inline void SlWriteUint64(uint64 x)
648 {
649 SlWriteUint32((uint32)(x >> 32));
650 SlWriteUint32((uint32)x);
651 }
652
658 static inline void SlSkipBytes(size_t length)
659 {
660 for (; length != 0; length--) SlReadByte();
661 }
662
672 static uint SlReadSimpleGamma()
673 {
674 uint i = SlReadByte();
675 if (HasBit(i, 7)) {
676 i &= ~0x80;
677 if (HasBit(i, 6)) {
678 i &= ~0x40;
679 if (HasBit(i, 5)) {
680 i &= ~0x20;
681 if (HasBit(i, 4)) {
682 i &= ~0x10;
683 if (HasBit(i, 3)) {
684 SlErrorCorrupt("Unsupported gamma");
685 }
686 i = SlReadByte(); // 32 bits only.
687 }
688 i = (i << 8) | SlReadByte();
689 }
690 i = (i << 8) | SlReadByte();
691 }
692 i = (i << 8) | SlReadByte();
693 }
694 return i;
695 }
696
714 static void SlWriteSimpleGamma(size_t i)
715 {
716 if (i >= (1 << 7)) {
717 if (i >= (1 << 14)) {
718 if (i >= (1 << 21)) {
719 if (i >= (1 << 28)) {
720 assert(i <= UINT32_MAX); // We can only support 32 bits for now.
721 SlWriteByte((byte)(0xF0));
722 SlWriteByte((byte)(i >> 24));
723 } else {
724 SlWriteByte((byte)(0xE0 | (i >> 24)));
725 }
726 SlWriteByte((byte)(i >> 16));
727 } else {
728 SlWriteByte((byte)(0xC0 | (i >> 16)));
729 }
730 SlWriteByte((byte)(i >> 8));
731 } else {
732 SlWriteByte((byte)(0x80 | (i >> 8)));
733 }
734 }
735 SlWriteByte((byte)i);
736 }
737
739 static inline uint SlGetGammaLength(size_t i)
740 {
741 return 1 + (i >= (1 << 7)) + (i >= (1 << 14)) + (i >= (1 << 21)) + (i >= (1 << 28));
742 }
743
744 static inline uint SlReadSparseIndex()
745 {
746 return SlReadSimpleGamma();
747 }
748
749 static inline void SlWriteSparseIndex(uint index)
750 {
751 SlWriteSimpleGamma(index);
752 }
753
754 static inline uint SlReadArrayLength()
755 {
756 return SlReadSimpleGamma();
757 }
758
759 static inline void SlWriteArrayLength(size_t length)
760 {
761 SlWriteSimpleGamma(length);
762 }
763
764 static inline uint SlGetArrayLength(size_t length)
765 {
766 return SlGetGammaLength(length);
767 }
768
775 static inline uint SlCalcConvMemLen(VarType conv)
776 {
777 static const byte conv_mem_size[] = {1, 1, 1, 2, 2, 4, 4, 8, 8, 0};
778 byte length = GB(conv, 4, 4);
779
780 switch (length << 4) {
781 case SLE_VAR_STRB:
782 case SLE_VAR_STRBQ:
783 case SLE_VAR_STR:
784 case SLE_VAR_STRQ:
785 return SlReadArrayLength();
786
787 default:
788 assert(length < lengthof(conv_mem_size));
789 return conv_mem_size[length];
790 }
791 }
792
799 static inline byte SlCalcConvFileLen(VarType conv)
800 {
801 static const byte conv_file_size[] = {1, 1, 2, 2, 4, 4, 8, 8, 2};
802 byte length = GB(conv, 0, 4);
803 assert(length < lengthof(conv_file_size));
804 return conv_file_size[length];
805 }
806
808 static inline size_t SlCalcRefLen()
809 {
810 return IsSavegameVersionBefore(69) ? 2 : 4;
811 }
812
813 void SlSetArrayIndex(uint index)
814 {
815 _sl.need_length = NL_WANTLENGTH;
816 _sl.array_index = index;
817 }
818
819 static size_t _next_offs;
820
825 int SlIterateArray()
826 {
827 int index;
828
829 /* After reading in the whole array inside the loop
830 * we must have read in all the data, so we must be at end of current block. */
831 if (_next_offs != 0 && _sl.reader->GetSize() != _next_offs) SlErrorCorrupt("Invalid chunk size");
832
833 for (;;) {
834 uint length = SlReadArrayLength();
835 if (length == 0) {
836 _next_offs = 0;
837 return -1;
838 }
839
840 _sl.obj_len = --length;
841 _next_offs = _sl.reader->GetSize() + length;
842
843 switch (_sl.block_mode) {
844 case CH_SPARSE_ARRAY: index = (int)SlReadSparseIndex(); break;
845 case CH_ARRAY: index = _sl.array_index++; break;
846 default:
847 DEBUG(sl, 0, "SlIterateArray error");
848 return -1; // error
849 }
850
851 if (length != 0) return index;
852 }
853 }
854
858 void SlSkipArray()
859 {
860 while (SlIterateArray() != -1) {
861 SlSkipBytes(_next_offs - _sl.reader->GetSize());
862 }
863 }
864
870 void SlSetLength(size_t length)
871 {
872 assert(_sl.action == SLA_SAVE);
873
874 switch (_sl.need_length) {
875 case NL_WANTLENGTH:
876 _sl.need_length = NL_NONE;
877 switch (_sl.block_mode) {
878 case CH_RIFF:
879 /* Ugly encoding of >16M RIFF chunks
880 * The lower 24 bits are normal
881 * The uppermost 4 bits are bits 24:27 */
882 assert(length < (1 << 28));
883 SlWriteUint32((uint32)((length & 0xFFFFFF) | ((length >> 24) << 28)));
884 break;
885 case CH_ARRAY:
886 assert(_sl.last_array_index <= _sl.array_index);
887 while (++_sl.last_array_index <= _sl.array_index) {
888 SlWriteArrayLength(1);
889 }
890 SlWriteArrayLength(length + 1);
891 break;
892 case CH_SPARSE_ARRAY:
893 SlWriteArrayLength(length + 1 + SlGetArrayLength(_sl.array_index)); // Also include length of sparse index.
894 SlWriteSparseIndex(_sl.array_index);
895 break;
896 default: NOT_REACHED();
897 }
898 break;
899
900 case NL_CALCLENGTH:
901 _sl.obj_len += (int)length;
902 break;
903
904 default: NOT_REACHED();
905 }
906 }
907
914 static void SlCopyBytes(void *ptr, size_t length)
915 {
916 byte *p = (byte *)ptr;
917
918 switch (_sl.action) {
919 case SLA_LOAD_CHECK:
920 case SLA_LOAD:
921 for (; length != 0; length--) *p++ = SlReadByte();
922 break;
923 case SLA_SAVE:
924 for (; length != 0; length--) SlWriteByte(*p++);
925 break;
926 default: NOT_REACHED();
927 }
928 }
929
931 size_t SlGetFieldLength()
932 {
933 return _sl.obj_len;
934 }
935
943 int64 ReadValue(const void *ptr, VarType conv)
944 {
945 switch (GetVarMemType(conv)) {
946 case SLE_VAR_BL: return (*(const bool *)ptr != 0);
947 case SLE_VAR_I8: return *(const int8 *)ptr;
948 case SLE_VAR_U8: return *(const byte *)ptr;
949 case SLE_VAR_I16: return *(const int16 *)ptr;
950 case SLE_VAR_U16: return *(const uint16*)ptr;
951 case SLE_VAR_I32: return *(const int32 *)ptr;
952 case SLE_VAR_U32: return *(const uint32*)ptr;
953 case SLE_VAR_I64: return *(const int64 *)ptr;
954 case SLE_VAR_U64: return *(const uint64*)ptr;
955 case SLE_VAR_NULL:return 0;
956 default: NOT_REACHED();
957 }
958 }
959
967 void WriteValue(void *ptr, VarType conv, int64 val)
968 {
969 switch (GetVarMemType(conv)) {
970 case SLE_VAR_BL: *(bool *)ptr = (val != 0); break;
971 case SLE_VAR_I8: *(int8 *)ptr = val; break;
972 case SLE_VAR_U8: *(byte *)ptr = val; break;
973 case SLE_VAR_I16: *(int16 *)ptr = val; break;
974 case SLE_VAR_U16: *(uint16*)ptr = val; break;
975 case SLE_VAR_I32: *(int32 *)ptr = val; break;
976 case SLE_VAR_U32: *(uint32*)ptr = val; break;
977 case SLE_VAR_I64: *(int64 *)ptr = val; break;
978 case SLE_VAR_U64: *(uint64*)ptr = val; break;
979 case SLE_VAR_NAME: *(char**)ptr = CopyFromOldName(val); break;
980 case SLE_VAR_NULL: break;
981 default: NOT_REACHED();
982 }
983 }
984
993 static void SlSaveLoadConv(void *ptr, VarType conv)
994 {
995 switch (_sl.action) {
996 case SLA_SAVE: {
997 int64 x = ReadValue(ptr, conv);
998
999 /* Write the value to the file and check if its value is in the desired range */
1000 switch (GetVarFileType(conv)) {
1001 case SLE_FILE_I8: assert(x >= -128 && x <= 127); SlWriteByte(x);break;
1002 case SLE_FILE_U8: assert(x >= 0 && x <= 255); SlWriteByte(x);break;
1003 case SLE_FILE_I16:assert(x >= -32768 && x <= 32767); SlWriteUint16(x);break;
1004 case SLE_FILE_STRINGID:
1005 case SLE_FILE_U16:assert(x >= 0 && x <= 65535); SlWriteUint16(x);break;
1006 case SLE_FILE_I32:
1007 case SLE_FILE_U32: SlWriteUint32((uint32)x);break;
1008 case SLE_FILE_I64:
1009 case SLE_FILE_U64: SlWriteUint64(x);break;
1010 default: NOT_REACHED();
1011 }
1012 break;
1013 }
1014 case SLA_LOAD_CHECK:
1015 case SLA_LOAD: {
1016 int64 x;
1017 /* Read a value from the file */
1018 switch (GetVarFileType(conv)) {
1019 case SLE_FILE_I8: x = (int8 )SlReadByte(); break;
1020 case SLE_FILE_U8: x = (byte )SlReadByte(); break;
1021 case SLE_FILE_I16: x = (int16 )SlReadUint16(); break;
1022 case SLE_FILE_U16: x = (uint16)SlReadUint16(); break;
1023 case SLE_FILE_I32: x = (int32 )SlReadUint32(); break;
1024 case SLE_FILE_U32: x = (uint32)SlReadUint32(); break;
1025 case SLE_FILE_I64: x = (int64 )SlReadUint64(); break;
1026 case SLE_FILE_U64: x = (uint64)SlReadUint64(); break;
1027 case SLE_FILE_STRINGID: x = RemapOldStringID((uint16)SlReadUint16()); break;
1028 default: NOT_REACHED();
1029 }
1030
1031 /* Write The value to the struct. These ARE endian safe. */
1032 WriteValue(ptr, conv, x);
1033 break;
1034 }
1035 case SLA_PTRS: break;
1036 case SLA_NULL: break;
1037 default: NOT_REACHED();
1038 }
1039 }
1040
1050 static inline size_t SlCalcNetStringLen(const char *ptr, size_t length)
1051 {
1052 if (ptr == NULL) return 0;
1053 return min(strlen(ptr), length - 1);
1054 }
1055
1065 static inline size_t SlCalcStringLen(const void *ptr, size_t length, VarType conv)
1066 {
1067 size_t len;
1068 const char *str;
1069
1070 switch (GetVarMemType(conv)) {
1071 default: NOT_REACHED();
1072 case SLE_VAR_STR:
1073 case SLE_VAR_STRQ:
1074 str = *(const char * const *)ptr;
1075 len = SIZE_MAX;
1076 break;
1077 case SLE_VAR_STRB:
1078 case SLE_VAR_STRBQ:
1079 str = (const char *)ptr;
1080 len = length;
1081 break;
1082 }
1083
1084 len = SlCalcNetStringLen(str, len);
1085 return len + SlGetArrayLength(len); // also include the length of the index
1086 }
1087
1094 static void SlString(void *ptr, size_t length, VarType conv)
1095 {
1096 switch (_sl.action) {
1097 case SLA_SAVE: {
1098 size_t len;
1099 switch (GetVarMemType(conv)) {
1100 default: NOT_REACHED();
1101 case SLE_VAR_STRB:
1102 case SLE_VAR_STRBQ:
1103 len = SlCalcNetStringLen((char *)ptr, length);
1104 break;
1105 case SLE_VAR_STR:
1106 case SLE_VAR_STRQ:
1107 ptr = *(char **)ptr;
1108 len = SlCalcNetStringLen((char *)ptr, SIZE_MAX);
1109 break;
1110 }
1111
1112 SlWriteArrayLength(len);
1113 SlCopyBytes(ptr, len);
1114 break;
1115 }
1116 case SLA_LOAD_CHECK:
1117 case SLA_LOAD: {
1118 size_t len = SlReadArrayLength();
1119
1120 switch (GetVarMemType(conv)) {
1121 default: NOT_REACHED();
1122 case SLE_VAR_STRB:
1123 case SLE_VAR_STRBQ:
1124 if (len >= length) {
1125 DEBUG(sl, 1, "String length in savegame is bigger than buffer, truncating");
1126 SlCopyBytes(ptr, length);
1127 SlSkipBytes(len - length);
1128 len = length - 1;
1129 } else {
1130 SlCopyBytes(ptr, len);
1131 }
1132 break;
1133 case SLE_VAR_STR:
1134 case SLE_VAR_STRQ: // Malloc'd string, free previous incarnation, and allocate
1135 free(*(char **)ptr);
1136 if (len == 0) {
1137 *(char **)ptr = NULL;
1138 return;
1139 } else {
1140 *(char **)ptr = MallocT<char>(len + 1); // terminating '\0'
1141 ptr = *(char **)ptr;
1142 SlCopyBytes(ptr, len);
1143 }
1144 break;
1145 }
1146
1147 ((char *)ptr)[len] = '\0'; // properly terminate the string
1148 StringValidationSettings settings = SVS_REPLACE_WITH_QUESTION_MARK;
1149 if ((conv & SLF_ALLOW_CONTROL) != 0) {
1150 settings = settings | SVS_ALLOW_CONTROL_CODE;
1151 if (IsSavegameVersionBefore(169)) {
1152 str_fix_scc_encoded((char *)ptr, (char *)ptr + len);
1153 }
1154 }
1155 if ((conv & SLF_ALLOW_NEWLINE) != 0) {
1156 settings = settings | SVS_ALLOW_NEWLINE;
1157 }
1158 str_validate((char *)ptr, (char *)ptr + len, settings);
1159 break;
1160 }
1161 case SLA_PTRS: break;
1162 case SLA_NULL: break;
1163 default: NOT_REACHED();
1164 }
1165 }
1166
1172 static inline size_t SlCalcArrayLen(size_t length, VarType conv)
1173 {
1174 return SlCalcConvFileLen(conv) * length;
1175 }
1176
1183 void SlArray(void *array, size_t length, VarType conv)
1184 {
1185 if (_sl.action == SLA_PTRS || _sl.action == SLA_NULL) return;
1186
1187 /* Automatically calculate the length? */
1188 if (_sl.need_length != NL_NONE) {
1189 SlSetLength(SlCalcArrayLen(length, conv));
1190 /* Determine length only? */
1191 if (_sl.need_length == NL_CALCLENGTH) return;
1192 }
1193
1194 /* NOTICE - handle some buggy stuff, in really old versions everything was saved
1195 * as a byte-type. So detect this, and adjust array size accordingly */
1196 if (_sl.action != SLA_SAVE && _sl_version == 0) {
1197 /* all arrays except difficulty settings */
1198 if (conv == SLE_INT16 || conv == SLE_UINT16 || conv == SLE_STRINGID ||
1199 conv == SLE_INT32 || conv == SLE_UINT32) {
1200 SlCopyBytes(array, length * SlCalcConvFileLen(conv));
1201 return;
1202 }
1203 /* used for conversion of Money 32bit->64bit */
1204 if (conv == (SLE_FILE_I32 | SLE_VAR_I64)) {
1205 for (uint i = 0; i < length; i++) {
1206 ((int64*)array)[i] = (int32)BSWAP32(SlReadUint32());
1207 }
1208 return;
1209 }
1210 }
1211
1212 /* If the size of elements is 1 byte both in file and memory, no special
1213 * conversion is needed, use specialized copy-copy function to speed up things */
1214 if (conv == SLE_INT8 || conv == SLE_UINT8) {
1215 SlCopyBytes(array, length);
1216 } else {
1217 byte *a = (byte*)array;
1218 byte mem_size = SlCalcConvMemLen(conv);
1219
1220 for (; length != 0; length --) {
1221 SlSaveLoadConv(a, conv);
1222 a += mem_size; // get size
1223 }
1224 }
1225 }
1226
1227
1238 static size_t ReferenceToInt(const void *obj, SLRefType rt)
1239 {
1240 assert(_sl.action == SLA_SAVE);
1241
1242 if (obj == NULL) return 0;
1243
1244 switch (rt) {
1245 case REF_VEHICLE_OLD: // Old vehicles we save as new ones
1246 case REF_VEHICLE: return ((const Vehicle*)obj)->index + 1;
1247 case REF_STATION: return ((const Station*)obj)->index + 1;
1248 case REF_TOWN: return ((const Town*)obj)->index + 1;
1249 case REF_ORDER: return ((const Order*)obj)->index + 1;
1250 case REF_ROADSTOPS: return ((const RoadStop*)obj)->index + 1;
1251 case REF_ENGINE_RENEWS: return ((const EngineRenew*)obj)->index + 1;
1252 case REF_CARGO_PACKET: return ((const CargoPacket*)obj)->index + 1;
1253 case REF_ORDERLIST: return ((const OrderList*)obj)->index + 1;
1254 case REF_STORAGE: return ((const PersistentStorage*)obj)->index + 1;
1255 case REF_LINK_GRAPH: return ((const LinkGraph*)obj)->index + 1;
1256 case REF_LINK_GRAPH_JOB: return ((const LinkGraphJob*)obj)->index + 1;
1257 default: NOT_REACHED();
1258 }
1259 }
1260
1271 static void *IntToReference(size_t index, SLRefType rt)
1272 {
1273 assert_compile(sizeof(size_t) <= sizeof(void *));
1274
1275 assert(_sl.action == SLA_PTRS);
1276
1277 /* After version 4.3 REF_VEHICLE_OLD is saved as REF_VEHICLE,
1278 * and should be loaded like that */
1279 if (rt == REF_VEHICLE_OLD && !IsSavegameVersionBefore(4, 4)) {
1280 rt = REF_VEHICLE;
1281 }
1282
1283 /* No need to look up NULL pointers, just return immediately */
1284 if (index == (rt == REF_VEHICLE_OLD ? 0xFFFF : 0)) return NULL;
1285
1286 /* Correct index. Old vehicles were saved differently:
1287 * invalid vehicle was 0xFFFF, now we use 0x0000 for everything invalid. */
1288 if (rt != REF_VEHICLE_OLD) index--;
1289
1290 switch (rt) {
1291 case REF_ORDERLIST:
1292 if (OrderList::IsValidID(index)) return OrderList::Get(index);
1293 SlErrorCorrupt("Referencing invalid OrderList");
1294
1295 case REF_ORDER:
1296 if (Order::IsValidID(index)) return Order::Get(index);
1297 /* in old versions, invalid order was used to mark end of order list */
1298 if (IsSavegameVersionBefore(5, 2)) return NULL;
1299 SlErrorCorrupt("Referencing invalid Order");
1300
1301 case REF_VEHICLE_OLD:
1302 case REF_VEHICLE:
1303 if (Vehicle::IsValidID(index)) return Vehicle::Get(index);
1304 SlErrorCorrupt("Referencing invalid Vehicle");
1305
1306 case REF_STATION:
1307 if (Station::IsValidID(index)) return Station::Get(index);
1308 SlErrorCorrupt("Referencing invalid Station");
1309
1310 case REF_TOWN:
1311 if (Town::IsValidID(index)) return Town::Get(index);
1312 SlErrorCorrupt("Referencing invalid Town");
1313
1314 case REF_ROADSTOPS:
1315 if (RoadStop::IsValidID(index)) return RoadStop::Get(index);
1316 SlErrorCorrupt("Referencing invalid RoadStop");
1317
1318 case REF_ENGINE_RENEWS:
1319 if (EngineRenew::IsValidID(index)) return EngineRenew::Get(index);
1320 SlErrorCorrupt("Referencing invalid EngineRenew");
1321
1322 case REF_CARGO_PACKET:
1323 if (CargoPacket::IsValidID(index)) return CargoPacket::Get(index);
1324 SlErrorCorrupt("Referencing invalid CargoPacket");
1325
1326 case REF_STORAGE:
1327 if (PersistentStorage::IsValidID(index)) return PersistentStorage::Get(index);
1328 SlErrorCorrupt("Referencing invalid PersistentStorage");
1329
1330 case REF_LINK_GRAPH:
1331 if (LinkGraph::IsValidID(index)) return LinkGraph::Get(index);
1332 SlErrorCorrupt("Referencing invalid LinkGraph");
1333
1334 case REF_LINK_GRAPH_JOB:
1335 if (LinkGraphJob::IsValidID(index)) return LinkGraphJob::Get(index);
1336 SlErrorCorrupt("Referencing invalid LinkGraphJob");
1337
1338 default: NOT_REACHED();
1339 }
1340 }
1341
1346 static inline size_t SlCalcListLen(const void *list)
1347 {
1348 const std::list<void *> *l = (const std::list<void *> *) list;
1349
1350 int type_size = IsSavegameVersionBefore(69) ? 2 : 4;
1351 /* Each entry is saved as type_size bytes, plus type_size bytes are used for the length
1352 * of the list */
1353 return l->size() * type_size + type_size;
1354 }
1355
1356
1362 static void SlList(void *list, SLRefType conv)
1363 {
1364 /* Automatically calculate the length? */
1365 if (_sl.need_length != NL_NONE) {
1366 SlSetLength(SlCalcListLen(list));
1367 /* Determine length only? */
1368 if (_sl.need_length == NL_CALCLENGTH) return;
1369 }
1370
1371 typedef std::list<void *> PtrList;
1372 PtrList *l = (PtrList *)list;
1373
1374 switch (_sl.action) {
1375 case SLA_SAVE: {
1376 SlWriteUint32((uint32)l->size());
1377
1378 PtrList::iterator iter;
1379 for (iter = l->begin(); iter != l->end(); ++iter) {
1380 void *ptr = *iter;
1381 SlWriteUint32((uint32)ReferenceToInt(ptr, conv));
1382 }
1383 break;
1384 }
1385 case SLA_LOAD_CHECK:
1386 case SLA_LOAD: {
1387 size_t length = IsSavegameVersionBefore(69) ? SlReadUint16() : SlReadUint32();
1388
1389 /* Load each reference and push to the end of the list */
1390 for (size_t i = 0; i < length; i++) {
1391 size_t data = IsSavegameVersionBefore(69) ? SlReadUint16() : SlReadUint32();
1392 l->push_back((void *)data);
1393 }
1394 break;
1395 }
1396 case SLA_PTRS: {
1397 PtrList temp = *l;
1398
1399 l->clear();
1400 PtrList::iterator iter;
1401 for (iter = temp.begin(); iter != temp.end(); ++iter) {
1402 void *ptr = IntToReference((size_t)*iter, conv);
1403 l->push_back(ptr);
1404 }
1405 break;
1406 }
1407 case SLA_NULL:
1408 l->clear();
1409 break;
1410 default: NOT_REACHED();
1411 }
1412 }
1413
1414
1416 static inline bool SlIsObjectValidInSavegame(const SaveLoad *sld)
1417 {
1418 if (_sl_version < sld->version_from || _sl_version > sld->version_to) return false;
1419 if (sld->conv & SLF_NOT_IN_SAVE) return false;
1420
1421 return true;
1422 }
1423
1429 static inline bool SlSkipVariableOnLoad(const SaveLoad *sld)
1430 {
1431 if ((sld->conv & SLF_NO_NETWORK_SYNC) && _sl.action != SLA_SAVE && _networking && !_network_server) {
1432 SlSkipBytes(SlCalcConvMemLen(sld->conv) * sld->length);
1433 return true;
1434 }
1435
1436 return false;
1437 }
1438
1445 size_t SlCalcObjLength(const void *object, const SaveLoad *sld)
1446 {
1447 size_t length = 0;
1448
1449 /* Need to determine the length and write a length tag. */
1450 for (; sld->cmd != SL_END; sld++) {
1451 length += SlCalcObjMemberLength(object, sld);
1452 }
1453 return length;
1454 }
1455
1456 size_t SlCalcObjMemberLength(const void *object, const SaveLoad *sld)
1457 {
1458 assert(_sl.action == SLA_SAVE);
1459
1460 switch (sld->cmd) {
1461 case SL_VAR:
1462 case SL_REF:
1463 case SL_ARR:
1464 case SL_STR:
1465 case SL_LST:
1466 /* CONDITIONAL saveload types depend on the savegame version */
1467 if (!SlIsObjectValidInSavegame(sld)) break;
1468
1469 switch (sld->cmd) {
1470 case SL_VAR: return SlCalcConvFileLen(sld->conv);
1471 case SL_REF: return SlCalcRefLen();
1472 case SL_ARR: return SlCalcArrayLen(sld->length, sld->conv);
1473 case SL_STR: return SlCalcStringLen(GetVariableAddress(object, sld), sld->length, sld->conv);
1474 case SL_LST: return SlCalcListLen(GetVariableAddress(object, sld));
1475 default: NOT_REACHED();
1476 }
1477 break;
1478 case SL_WRITEBYTE: return 1; // a byte is logically of size 1
1479 case SL_VEH_INCLUDE: return SlCalcObjLength(object, GetVehicleDescription(VEH_END));
1480 case SL_ST_INCLUDE: return SlCalcObjLength(object, GetBaseStationDescription());
1481 default: NOT_REACHED();
1482 }
1483 return 0;
1484 }
1485
1491 static bool IsVariableSizeRight(const SaveLoad *sld)
1492 {
1493 switch (sld->cmd) {
1494 case SL_VAR:
1495 switch (GetVarMemType(sld->conv)) {
1496 case SLE_VAR_BL:
1497 return sld->size == sizeof(bool);
1498 case SLE_VAR_I8:
1499 case SLE_VAR_U8:
1500 return sld->size == sizeof(int8);
1501 case SLE_VAR_I16:
1502 case SLE_VAR_U16:
1503 return sld->size == sizeof(int16);
1504 case SLE_VAR_I32:
1505 case SLE_VAR_U32:
1506 return sld->size == sizeof(int32);
1507 case SLE_VAR_I64:
1508 case SLE_VAR_U64:
1509 return sld->size == sizeof(int64);
1510 default:
1511 return sld->size == sizeof(void *);
1512 }
1513 case SL_REF:
1514 /* These should all be pointer sized. */
1515 return sld->size == sizeof(void *);
1516
1517 case SL_STR:
1518 /* These should be pointer sized, or fixed array. */
1519 return sld->size == sizeof(void *) || sld->size == sld->length;
1520
1521 default:
1522 return true;
1523 }
1524 }
1525
1526 bool SlObjectMember(void *ptr, const SaveLoad *sld)
1527 {
1528 assert(IsVariableSizeRight(sld));
1529
1530 VarType conv = GB(sld->conv, 0, 8);
1531 switch (sld->cmd) {
1532 case SL_VAR:
1533 case SL_REF:
1534 case SL_ARR:
1535 case SL_STR:
1536 case SL_LST:
1537 /* CONDITIONAL saveload types depend on the savegame version */
1538 if (!SlIsObjectValidInSavegame(sld)) return false;
1539 if (SlSkipVariableOnLoad(sld)) return false;
1540
1541 switch (sld->cmd) {
1542 case SL_VAR: SlSaveLoadConv(ptr, conv); break;
1543 case SL_REF: // Reference variable, translate
1544 switch (_sl.action) {
1545 case SLA_SAVE:
1546 SlWriteUint32((uint32)ReferenceToInt(*(void **)ptr, (SLRefType)conv));
1547 break;
1548 case SLA_LOAD_CHECK:
1549 case SLA_LOAD:
1550 *(size_t *)ptr = IsSavegameVersionBefore(69) ? SlReadUint16() : SlReadUint32();
1551 break;
1552 case SLA_PTRS:
1553 *(void **)ptr = IntToReference(*(size_t *)ptr, (SLRefType)conv);
1554 break;
1555 case SLA_NULL:
1556 *(void **)ptr = NULL;
1557 break;
1558 default: NOT_REACHED();
1559 }
1560 break;
1561 case SL_ARR: SlArray(ptr, sld->length, conv); break;
1562 case SL_STR: SlString(ptr, sld->length, sld->conv); break;
1563 case SL_LST: SlList(ptr, (SLRefType)conv); break;
1564 default: NOT_REACHED();
1565 }
1566 break;
1567
1568 /* SL_WRITEBYTE translates a value of a variable to another one upon
1569 * saving or loading.
1570 * XXX - variable renaming abuse
1571 * game_value: the value of the variable ingame is abused by sld->version_from
1572 * file_value: the value of the variable in the savegame is abused by sld->version_to */
1573 case SL_WRITEBYTE:
1574 switch (_sl.action) {
1575 case SLA_SAVE: SlWriteByte(sld->version_to); break;
1576 case SLA_LOAD_CHECK:
1577 case SLA_LOAD: *(byte *)ptr = sld->version_from; break;
1578 case SLA_PTRS: break;
1579 case SLA_NULL: break;
1580 default: NOT_REACHED();
1581 }
1582 break;
1583
1584 /* SL_VEH_INCLUDE loads common code for vehicles */
1585 case SL_VEH_INCLUDE:
1586 SlObject(ptr, GetVehicleDescription(VEH_END));
1587 break;
1588
1589 case SL_ST_INCLUDE:
1590 SlObject(ptr, GetBaseStationDescription());
1591 break;
1592
1593 default: NOT_REACHED();
1594 }
1595 return true;
1596 }
1597
1603 void SlObject(void *object, const SaveLoad *sld)
1604 {
1605 /* Automatically calculate the length? */
1606 if (_sl.need_length != NL_NONE) {
1607 SlSetLength(SlCalcObjLength(object, sld));
1608 if (_sl.need_length == NL_CALCLENGTH) return;
1609 }
1610
1611 for (; sld->cmd != SL_END; sld++) {
1612 void *ptr = sld->global ? sld->address : GetVariableAddress(object, sld);
1613 SlObjectMember(ptr, sld);
1614 }
1615 }
1616
1621 void SlGlobList(const SaveLoadGlobVarList *sldg)
1622 {
1623 SlObject(NULL, (const SaveLoad*)sldg);
1624 }
1625
1631 void SlAutolength(AutolengthProc *proc, void *arg)
1632 {
1633 size_t offs;
1634
1635 assert(_sl.action == SLA_SAVE);
1636
1637 /* Tell it to calculate the length */
1638 _sl.need_length = NL_CALCLENGTH;
1639 _sl.obj_len = 0;
1640 proc(arg);
1641
1642 /* Setup length */
1643 _sl.need_length = NL_WANTLENGTH;
1644 SlSetLength(_sl.obj_len);
1645
1646 offs = _sl.dumper->GetSize() + _sl.obj_len;
1647
1648 /* And write the stuff */
1649 proc(arg);
1650
1651 if (offs != _sl.dumper->GetSize()) SlErrorCorrupt("Invalid chunk size");
1652 }
1653
1658 static void SlLoadChunk(const ChunkHandler *ch)
1659 {
1660 byte m = SlReadByte();
1661 size_t len;
1662 size_t endoffs;
1663
1664 _sl.block_mode = m;
1665 _sl.obj_len = 0;
1666
1667 switch (m) {
1668 case CH_ARRAY:
1669 _sl.array_index = 0;
1670 ch->load_proc();
1671 if (_next_offs != 0) SlErrorCorrupt("Invalid array length");
1672 break;
1673 case CH_SPARSE_ARRAY:
1674 ch->load_proc();
1675 if (_next_offs != 0) SlErrorCorrupt("Invalid array length");
1676 break;
1677 default:
1678 if ((m & 0xF) == CH_RIFF) {
1679 /* Read length */
1680 len = (SlReadByte() << 16) | ((m >> 4) << 24);
1681 len += SlReadUint16();
1682 _sl.obj_len = len;
1683 endoffs = _sl.reader->GetSize() + len;
1684 ch->load_proc();
1685 if (_sl.reader->GetSize() != endoffs) SlErrorCorrupt("Invalid chunk size");
1686 } else {
1687 SlErrorCorrupt("Invalid chunk type");
1688 }
1689 break;
1690 }
1691 }
1692
1698 static void SlLoadCheckChunk(const ChunkHandler *ch)
1699 {
1700 byte m = SlReadByte();
1701 size_t len;
1702 size_t endoffs;
1703
1704 _sl.block_mode = m;
1705 _sl.obj_len = 0;
1706
1707 switch (m) {
1708 case CH_ARRAY:
1709 _sl.array_index = 0;
1710 if (ch->load_check_proc) {
1711 ch->load_check_proc();
1712 } else {
1713 SlSkipArray();
1714 }
1715 break;
1716 case CH_SPARSE_ARRAY:
1717 if (ch->load_check_proc) {
1718 ch->load_check_proc();
1719 } else {
1720 SlSkipArray();
1721 }
1722 break;
1723 default:
1724 if ((m & 0xF) == CH_RIFF) {
1725 /* Read length */
1726 len = (SlReadByte() << 16) | ((m >> 4) << 24);
1727 len += SlReadUint16();
1728 _sl.obj_len = len;
1729 endoffs = _sl.reader->GetSize() + len;
1730 if (ch->load_check_proc) {
1731 ch->load_check_proc();
1732 } else {
1733 SlSkipBytes(len);
1734 }
1735 if (_sl.reader->GetSize() != endoffs) SlErrorCorrupt("Invalid chunk size");
1736 } else {
1737 SlErrorCorrupt("Invalid chunk type");
1738 }
1739 break;
1740 }
1741 }
1742
1747 static ChunkSaveLoadProc *_stub_save_proc;
1748
1754 static inline void SlStubSaveProc2(void *arg)
1755 {
1756 _stub_save_proc();
1757 }
1758
1764 static void SlStubSaveProc()
1765 {
1766 SlAutolength(SlStubSaveProc2, NULL);
1767 }
1768
1774 static void SlSaveChunk(const ChunkHandler *ch)
1775 {
1776 ChunkSaveLoadProc *proc = ch->save_proc;
1777
1778 /* Don't save any chunk information if there is no save handler. */
1779 if (proc == NULL) return;
1780
1781 SlWriteUint32(ch->id);
1782 DEBUG(sl, 2, "Saving chunk %c%c%c%c", ch->id >> 24, ch->id >> 16, ch->id >> 8, ch->id);
1783
1784 if (ch->flags & CH_AUTO_LENGTH) {
1785 /* Need to calculate the length. Solve that by calling SlAutoLength in the save_proc. */
1786 _stub_save_proc = proc;
1787 proc = SlStubSaveProc;
1788 }
1789
1790 _sl.block_mode = ch->flags & CH_TYPE_MASK;
1791 switch (ch->flags & CH_TYPE_MASK) {
1792 case CH_RIFF:
1793 _sl.need_length = NL_WANTLENGTH;
1794 proc();
1795 break;
1796 case CH_ARRAY:
1797 _sl.last_array_index = 0;
1798 SlWriteByte(CH_ARRAY);
1799 proc();
1800 SlWriteArrayLength(0); // Terminate arrays
1801 break;
1802 case CH_SPARSE_ARRAY:
1803 SlWriteByte(CH_SPARSE_ARRAY);
1804 proc();
1805 SlWriteArrayLength(0); // Terminate arrays
1806 break;
1807 default: NOT_REACHED();
1808 }
1809 }
1810
1812 static void SlSaveChunks()
1813 {
1814 FOR_ALL_CHUNK_HANDLERS(ch) {
1815 SlSaveChunk(ch);
1816 }
1817
1818 /* Terminator */
1819 SlWriteUint32(0);
1820 }
1821
1828 static const ChunkHandler *SlFindChunkHandler(uint32 id)
1829 {
1830 FOR_ALL_CHUNK_HANDLERS(ch) if (ch->id == id) return ch;
1831 return NULL;
1832 }
1833
1835 static void SlLoadChunks()
1836 {
1837 uint32 id;
1838 const ChunkHandler *ch;
1839
1840 for (id = SlReadUint32(); id != 0; id = SlReadUint32()) {
1841 DEBUG(sl, 2, "Loading chunk %c%c%c%c", id >> 24, id >> 16, id >> 8, id);
1842
1843 ch = SlFindChunkHandler(id);
1844 if (ch == NULL) SlErrorCorrupt("Unknown chunk type");
1845 SlLoadChunk(ch);
1846 }
1847 }
1848
1850 static void SlLoadCheckChunks()
1851 {
1852 uint32 id;
1853 const ChunkHandler *ch;
1854
1855 for (id = SlReadUint32(); id != 0; id = SlReadUint32()) {
1856 DEBUG(sl, 2, "Loading chunk %c%c%c%c", id >> 24, id >> 16, id >> 8, id);
1857
1858 ch = SlFindChunkHandler(id);
1859 if (ch == NULL) SlErrorCorrupt("Unknown chunk type");
1860 SlLoadCheckChunk(ch);
1861 }
1862 }
1863
1865 static void SlFixPointers()
1866 {
1867 _sl.action = SLA_PTRS;
1868
1869 DEBUG(sl, 1, "Fixing pointers");
1870
1871 FOR_ALL_CHUNK_HANDLERS(ch) {
1872 if (ch->ptrs_proc != NULL) {
1873 DEBUG(sl, 2, "Fixing pointers for %c%c%c%c", ch->id >> 24, ch->id >> 16, ch->id >> 8, ch->id);
1874 ch->ptrs_proc();
1875 }
1876 }
1877
1878 DEBUG(sl, 1, "All pointers fixed");
1879
1880 assert(_sl.action == SLA_PTRS);
1881 }
1882
1883
1885 struct FileReader : LoadFilter {
1886 FILE *file;
1887 long begin;
1888
1893 FileReader(FILE *file) : LoadFilter(NULL), file(file), begin(ftell(file))
1894 {
1895 }
1896
1898 ~FileReader()
1899 {
1900 if (this->file != NULL) fclose(this->file);
1901 this->file = NULL;
1902
1903 /* Make sure we don't double free. */
1904 _sl.sf = NULL;
1905 }
1906
1907 /* virtual */ size_t Read(byte *buf, size_t size)
1908 {
1909 /* We're in the process of shutting down, i.e. in "failure" mode. */
1910 if (this->file == NULL) return 0;
1911
1912 return fread(buf, 1, size, this->file);
1913 }
1914
1915 /* virtual */ void Reset()
1916 {
1917 clearerr(this->file);
1918 if (fseek(this->file, this->begin, SEEK_SET)) {
1919 DEBUG(sl, 1, "Could not reset the file reading");
1920 }
1921 }
1922 };
1923
1925 struct FileWriter : SaveFilter {
1926 FILE *file;
1927
1932 FileWriter(FILE *file) : SaveFilter(NULL), file(file)
1933 {
1934 }
1935
1937 ~FileWriter()
1938 {
1939 this->Finish();
1940
1941 /* Make sure we don't double free. */
1942 _sl.sf = NULL;
1943 }
1944
1945 /* virtual */ void Write(byte *buf, size_t size)
1946 {
1947 /* We're in the process of shutting down, i.e. in "failure" mode. */
1948 if (this->file == NULL) return;
1949
1950 if (fwrite(buf, 1, size, this->file) != size) SlError(STR_GAME_SAVELOAD_ERROR_FILE_NOT_WRITEABLE);
1951 }
1952
1953 /* virtual */ void Finish()
1954 {
1955 if (this->file != NULL) fclose(this->file);
1956 this->file = NULL;
1957 }
1958 };
1959
1960 /*******************************************
1961 ********** START OF LZO CODE **************
1962 *******************************************/
1963
1964 #ifdef WITH_LZO
1965 #include <lzo/lzo1x.h>
1966
1968 static const uint LZO_BUFFER_SIZE = 8192;
1969
1971 struct LZOLoadFilter : LoadFilter {
1976 LZOLoadFilter(LoadFilter *chain) : LoadFilter(chain)
1977 {
1978 if (lzo_init() != LZO_E_OK) SlError(STR_GAME_SAVELOAD_ERROR_BROKEN_INTERNAL_ERROR, "cannot initialize decompressor");
1979 }
1980
1981 /* virtual */ size_t Read(byte *buf, size_t ssize)
1982 {
1983 assert(ssize >= LZO_BUFFER_SIZE);
1984
1985 /* Buffer size is from the LZO docs plus the chunk header size. */
1986 byte out[LZO_BUFFER_SIZE + LZO_BUFFER_SIZE / 16 + 64 + 3 + sizeof(uint32) * 2];
1987 uint32 tmp[2];
1988 uint32 size;
1989 lzo_uint len;
1990
1991 /* Read header*/
1992 if (this->chain->Read((byte*)tmp, sizeof(tmp)) != sizeof(tmp)) SlError(STR_GAME_SAVELOAD_ERROR_FILE_NOT_READABLE, "File read failed");
1993
1994 /* Check if size is bad */
1995 ((uint32*)out)[0] = size = tmp[1];
1996
1997 if (_sl_version != 0) {
1998 tmp[0] = TO_BE32(tmp[0]);
1999 size = TO_BE32(size);
2000 }
2001
2002 if (size >= sizeof(out)) SlErrorCorrupt("Inconsistent size");
2003
2004 /* Read block */
2005 if (this->chain->Read(out + sizeof(uint32), size) != size) SlError(STR_GAME_SAVELOAD_ERROR_FILE_NOT_READABLE);
2006
2007 /* Verify checksum */
2008 if (tmp[0] != lzo_adler32(0, out, size + sizeof(uint32))) SlErrorCorrupt("Bad checksum");
2009
2010 /* Decompress */
2011 lzo1x_decompress_safe(out + sizeof(uint32) * 1, size, buf, &len, NULL);
2012 return len;
2013 }
2014 };
2015
2017 struct LZOSaveFilter : SaveFilter {
2023 LZOSaveFilter(SaveFilter *chain, byte compression_level) : SaveFilter(chain)
2024 {
2025 if (lzo_init() != LZO_E_OK) SlError(STR_GAME_SAVELOAD_ERROR_BROKEN_INTERNAL_ERROR, "cannot initialize compressor");
2026 }
2027
2028 /* virtual */ void Write(byte *buf, size_t size)
2029 {
2030 const lzo_bytep in = buf;
2031 /* Buffer size is from the LZO docs plus the chunk header size. */
2032 byte out[LZO_BUFFER_SIZE + LZO_BUFFER_SIZE / 16 + 64 + 3 + sizeof(uint32) * 2];
2033 byte wrkmem[LZO1X_1_MEM_COMPRESS];
2034 lzo_uint outlen;
2035
2036 do {
2037 /* Compress up to LZO_BUFFER_SIZE bytes at once. */
2038 lzo_uint len = size > LZO_BUFFER_SIZE ? LZO_BUFFER_SIZE : (lzo_uint)size;
2039 lzo1x_1_compress(in, len, out + sizeof(uint32) * 2, &outlen, wrkmem);
2040 ((uint32*)out)[1] = TO_BE32((uint32)outlen);
2041 ((uint32*)out)[0] = TO_BE32(lzo_adler32(0, out + sizeof(uint32), outlen + sizeof(uint32)));
2042 this->chain->Write(out, outlen + sizeof(uint32) * 2);
2043
2044 /* Move to next data chunk. */
2045 size -= len;
2046 in += len;
2047 } while (size > 0);
2048 }
2049 };
2050
2051 #endif /* WITH_LZO */
2052
2053 /*********************************************
2054 ******** START OF NOCOMP CODE (uncompressed)*
2055 *********************************************/
2056
2058 struct NoCompLoadFilter : LoadFilter {
2063 NoCompLoadFilter(LoadFilter *chain) : LoadFilter(chain)
2064 {
2065 }
2066
2067 /* virtual */ size_t Read(byte *buf, size_t size)
2068 {
2069 return this->chain->Read(buf, size);
2070 }
2071 };
2072
2074 struct NoCompSaveFilter : SaveFilter {
2080 NoCompSaveFilter(SaveFilter *chain, byte compression_level) : SaveFilter(chain)
2081 {
2082 }
2083
2084 /* virtual */ void Write(byte *buf, size_t size)
2085 {
2086 this->chain->Write(buf, size);
2087 }
2088 };
2089
2090 /********************************************
2091 ********** START OF ZLIB CODE **************
2092 ********************************************/
2093
2094 #if defined(WITH_ZLIB)
2095 #include <zlib.h>
2096
2098 struct ZlibLoadFilter : LoadFilter {
2099 z_stream z;
2100 byte fread_buf[MEMORY_CHUNK_SIZE];
2101
2106 ZlibLoadFilter(LoadFilter *chain) : LoadFilter(chain)
2107 {
2108 memset(&this->z, 0, sizeof(this->z));
2109 if (inflateInit(&this->z) != Z_OK) SlError(STR_GAME_SAVELOAD_ERROR_BROKEN_INTERNAL_ERROR, "cannot initialize decompressor");
2110 }
2111
2113 ~ZlibLoadFilter()
2114 {
2115 inflateEnd(&this->z);
2116 }
2117
2118 /* virtual */ size_t Read(byte *buf, size_t size)
2119 {
2120 this->z.next_out = buf;
2121 this->z.avail_out = (uint)size;
2122
2123 do {
2124 /* read more bytes from the file? */
2125 if (this->z.avail_in == 0) {
2126 this->z.next_in = this->fread_buf;
2127 this->z.avail_in = (uint)this->chain->Read(this->fread_buf, sizeof(this->fread_buf));
2128 }
2129
2130 /* inflate the data */
2131 int r = inflate(&this->z, 0);
2132 if (r == Z_STREAM_END) break;
2133
2134 if (r != Z_OK) SlError(STR_GAME_SAVELOAD_ERROR_BROKEN_INTERNAL_ERROR, "inflate() failed");
2135 } while (this->z.avail_out != 0);
2136
2137 return size - this->z.avail_out;
2138 }
2139 };
2140
2142 struct ZlibSaveFilter : SaveFilter {
2143 z_stream z;
2144
2150 ZlibSaveFilter(SaveFilter *chain, byte compression_level) : SaveFilter(chain)
2151 {
2152 memset(&this->z, 0, sizeof(this->z));
2153 if (deflateInit(&this->z, compression_level) != Z_OK) SlError(STR_GAME_SAVELOAD_ERROR_BROKEN_INTERNAL_ERROR, "cannot initialize compressor");
2154 }
2155
2157 ~ZlibSaveFilter()
2158 {
2159 deflateEnd(&this->z);
2160 }
2161
2168 void WriteLoop(byte *p, size_t len, int mode)
2169 {
2170 byte buf[MEMORY_CHUNK_SIZE]; // output buffer
2171 uint n;
2172 this->z.next_in = p;
2173 this->z.avail_in = (uInt)len;
2174 do {
2175 this->z.next_out = buf;
2176 this->z.avail_out = sizeof(buf);
2177
2185 int r = deflate(&this->z, mode);
2186
2187 /* bytes were emitted? */
2188 if ((n = sizeof(buf) - this->z.avail_out) != 0) {
2189 this->chain->Write(buf, n);
2190 }
2191 if (r == Z_STREAM_END) break;
2192
2193 if (r != Z_OK) SlError(STR_GAME_SAVELOAD_ERROR_BROKEN_INTERNAL_ERROR, "zlib returned error code");
2194 } while (this->z.avail_in || !this->z.avail_out);
2195 }
2196
2197 /* virtual */ void Write(byte *buf, size_t size)
2198 {
2199 this->WriteLoop(buf, size, 0);
2200 }
2201
2202 /* virtual */ void Finish()
2203 {
2204 this->WriteLoop(NULL, 0, Z_FINISH);
2205 this->chain->Finish();
2206 }
2207 };
2208
2209 #endif /* WITH_ZLIB */
2210
2211 /********************************************
2212 ********** START OF LZMA CODE **************
2213 ********************************************/
2214
2215 #if defined(WITH_LZMA)
2216 #include <lzma.h>
2217
2224 static const lzma_stream _lzma_init = LZMA_STREAM_INIT;
2225
2227 struct LZMALoadFilter : LoadFilter {
2228 lzma_stream lzma;
2229 byte fread_buf[MEMORY_CHUNK_SIZE];
2230
2235 LZMALoadFilter(LoadFilter *chain) : LoadFilter(chain), lzma(_lzma_init)
2236 {
2237 /* Allow saves up to 256 MB uncompressed */
2238 if (lzma_auto_decoder(&this->lzma, 1 << 28, 0) != LZMA_OK) SlError(STR_GAME_SAVELOAD_ERROR_BROKEN_INTERNAL_ERROR, "cannot initialize decompressor");
2239 }
2240
2242 ~LZMALoadFilter()
2243 {
2244 lzma_end(&this->lzma);
2245 }
2246
2247 /* virtual */ size_t Read(byte *buf, size_t size)
2248 {
2249 this->lzma.next_out = buf;
2250 this->lzma.avail_out = size;
2251
2252 do {
2253 /* read more bytes from the file? */
2254 if (this->lzma.avail_in == 0) {
2255 this->lzma.next_in = this->fread_buf;
2256 this->lzma.avail_in = this->chain->Read(this->fread_buf, sizeof(this->fread_buf));
2257 }
2258
2259 /* inflate the data */
2260 lzma_ret r = lzma_code(&this->lzma, LZMA_RUN);
2261 if (r == LZMA_STREAM_END) break;
2262 if (r != LZMA_OK) SlError(STR_GAME_SAVELOAD_ERROR_BROKEN_INTERNAL_ERROR, "liblzma returned error code");
2263 } while (this->lzma.avail_out != 0);
2264
2265 return size - this->lzma.avail_out;
2266 }
2267 };
2268
2270 struct LZMASaveFilter : SaveFilter {
2271 lzma_stream lzma;
2272
2278 LZMASaveFilter(SaveFilter *chain, byte compression_level) : SaveFilter(chain), lzma(_lzma_init)
2279 {
2280 if (lzma_easy_encoder(&this->lzma, compression_level, LZMA_CHECK_CRC32) != LZMA_OK) SlError(STR_GAME_SAVELOAD_ERROR_BROKEN_INTERNAL_ERROR, "cannot initialize compressor");
2281 }
2282
2284 ~LZMASaveFilter()
2285 {
2286 lzma_end(&this->lzma);
2287 }
2288
2295 void WriteLoop(byte *p, size_t len, lzma_action action)
2296 {
2297 byte buf[MEMORY_CHUNK_SIZE]; // output buffer
2298 size_t n;
2299 this->lzma.next_in = p;
2300 this->lzma.avail_in = len;
2301 do {
2302 this->lzma.next_out = buf;
2303 this->lzma.avail_out = sizeof(buf);
2304
2305 lzma_ret r = lzma_code(&this->lzma, action);
2306
2307 /* bytes were emitted? */
2308 if ((n = sizeof(buf) - this->lzma.avail_out) != 0) {
2309 this->chain->Write(buf, n);
2310 }
2311 if (r == LZMA_STREAM_END) break;
2312 if (r != LZMA_OK) SlError(STR_GAME_SAVELOAD_ERROR_BROKEN_INTERNAL_ERROR, "liblzma returned error code");
2313 } while (this->lzma.avail_in || !this->lzma.avail_out);
2314 }
2315
2316 /* virtual */ void Write(byte *buf, size_t size)
2317 {
2318 this->WriteLoop(buf, size, LZMA_RUN);
2319 }
2320
2321 /* virtual */ void Finish()
2322 {
2323 this->WriteLoop(NULL, 0, LZMA_FINISH);
2324 this->chain->Finish();
2325 }
2326 };
2327
2328 #endif /* WITH_LZMA */
2329
2330 /*******************************************
2331 ************* END OF CODE *****************
2332 *******************************************/
2333
2335 struct SaveLoadFormat {
2336 const char *name;
2337 uint32 tag;
2338
2339 LoadFilter *(*init_load)(LoadFilter *chain);
2340 SaveFilter *(*init_write)(SaveFilter *chain, byte compression);
2341
2342 byte min_compression;
2343 byte default_compression;
2344 byte max_compression;
2345 };
2346
2348 static const SaveLoadFormat _saveload_formats[] = {
2349 #if defined(WITH_LZO)
2350 /* Roughly 75% larger than zlib level 6 at only ~7% of the CPU usage. */
2351 {"lzo", TO_BE32X('OTTD'), CreateLoadFilter<LZOLoadFilter>, CreateSaveFilter<LZOSaveFilter>, 0, 0, 0},
2352 #else
2353 {"lzo", TO_BE32X('OTTD'), NULL, NULL, 0, 0, 0},
2354 #endif
2355 /* Roughly 5 times larger at only 1% of the CPU usage over zlib level 6. */
2356 {"none", TO_BE32X('OTTN'), CreateLoadFilter<NoCompLoadFilter>, CreateSaveFilter<NoCompSaveFilter>, 0, 0, 0},
2357 #if defined(WITH_ZLIB)
2358 /* After level 6 the speed reduction is significant (1.5x to 2.5x slower per level), but the reduction in filesize is
2359 * fairly insignificant (~1% for each step). Lower levels become ~5-10% bigger by each level than level 6 while level
2360 * 1 is "only" 3 times as fast. Level 0 results in uncompressed savegames at about 8 times the cost of "none". */
2361 {"zlib", TO_BE32X('OTTZ'), CreateLoadFilter<ZlibLoadFilter>, CreateSaveFilter<ZlibSaveFilter>, 0, 6, 9},
2362 #else
2363 {"zlib", TO_BE32X('OTTZ'), NULL, NULL, 0, 0, 0},
2364 #endif
2365 #if defined(WITH_LZMA)
2366 /* Level 2 compression is speed wise as fast as zlib level 6 compression (old default), but results in ~10% smaller saves.
2367 * Higher compression levels are possible, and might improve savegame size by up to 25%, but are also up to 10 times slower.
2368 * The next significant reduction in file size is at level 4, but that is already 4 times slower. Level 3 is primarily 50%
2369 * slower while not improving the filesize, while level 0 and 1 are faster, but don't reduce savegame size much.
2370 * It's OTTX and not e.g. OTTL because liblzma is part of xz-utils and .tar.xz is preferred over .tar.lzma. */
2371 {"lzma", TO_BE32X('OTTX'), CreateLoadFilter<LZMALoadFilter>, CreateSaveFilter<LZMASaveFilter>, 0, 2, 9},
2372 #else
2373 {"lzma", TO_BE32X('OTTX'), NULL, NULL, 0, 0, 0},
2374 #endif
2375 };
2376
2384 static const SaveLoadFormat *GetSavegameFormat(char *s, byte *compression_level)
2385 {
2386 const SaveLoadFormat *def = lastof(_saveload_formats);
2387
2388 /* find default savegame format, the highest one with which files can be written */
2389 while (!def->init_write) def--;
2390
2391 if (!StrEmpty(s)) {
2392 /* Get the ":..." of the compression level out of the way */
2393 char *complevel = strrchr(s, ':');
2394 if (complevel != NULL) *complevel = '\0';
2395
2396 for (const SaveLoadFormat *slf = &_saveload_formats[0]; slf != endof(_saveload_formats); slf++) {
2397 if (slf->init_write != NULL && strcmp(s, slf->name) == 0) {
2398 *compression_level = slf->default_compression;
2399 if (complevel != NULL) {
2400 /* There is a compression level in the string.
2401 * First restore the : we removed to do proper name matching,
2402 * then move the the begin of the actual version. */
2403 *complevel = ':';
2404 complevel++;
2405
2406 /* Get the version and determine whether all went fine. */
2407 char *end;
2408 long level = strtol(complevel, &end, 10);
2409 if (end == complevel || level != Clamp(level, slf->min_compression, slf->max_compression)) {
2410 SetDParamStr(0, complevel);
2411 ShowErrorMessage(STR_CONFIG_ERROR, STR_CONFIG_ERROR_INVALID_SAVEGAME_COMPRESSION_LEVEL, WL_CRITICAL);
2412 } else {
2413 *compression_level = level;
2414 }
2415 }
2416 return slf;
2417 }
2418 }
2419
2420 SetDParamStr(0, s);
2421 SetDParamStr(1, def->name);
2422 ShowErrorMessage(STR_CONFIG_ERROR, STR_CONFIG_ERROR_INVALID_SAVEGAME_COMPRESSION_ALGORITHM, WL_CRITICAL);
2423
2424 /* Restore the string by adding the : back */
2425 if (complevel != NULL) *complevel = ':';
2426 }
2427 *compression_level = def->default_compression;
2428 return def;
2429 }
2430
2431 /* actual loader/saver function */
2432 void InitializeGame(uint size_x, uint size_y, bool reset_date, bool reset_settings);
2433 extern bool AfterLoadGame();
2434 extern bool LoadOldSaveGame(const char *file);
2435
2439 static inline void ClearSaveLoadState()
2440 {
2441 delete _sl.dumper;
2442 _sl.dumper = NULL;
2443
2444 delete _sl.sf;
2445 _sl.sf = NULL;
2446
2447 delete _sl.reader;
2448 _sl.reader = NULL;
2449
2450 delete _sl.lf;
2451 _sl.lf = NULL;
2452 }
2453
2459 static void SaveFileStart()
2460 {
2461 _sl.ff_state = _fast_forward;
2462 _fast_forward = 0;
2463 if (_cursor.sprite == SPR_CURSOR_MOUSE) SetMouseCursor(SPR_CURSOR_ZZZ, PAL_NONE);
2464
2465 InvalidateWindowData(WC_STATUS_BAR, 0, SBI_SAVELOAD_START);
2466 _sl.saveinprogress = true;
2467 }
2468
2470 static void SaveFileDone()
2471 {
2472 if (_game_mode != GM_MENU) _fast_forward = _sl.ff_state;
2473 if (_cursor.sprite == SPR_CURSOR_ZZZ) SetMouseCursor(SPR_CURSOR_MOUSE, PAL_NONE);
2474
2475 InvalidateWindowData(WC_STATUS_BAR, 0, SBI_SAVELOAD_FINISH);
2476 _sl.saveinprogress = false;
2477 }
2478
2480 void SetSaveLoadError(StringID str)
2481 {
2482 _sl.error_str = str;
2483 }
2484
2486 const char *GetSaveLoadErrorString()
2487 {
2488 SetDParam(0, _sl.error_str);
2489 SetDParamStr(1, _sl.extra_msg);
2490
2491 static char err_str[512];
2492 GetString(err_str, _sl.action == SLA_SAVE ? STR_ERROR_GAME_SAVE_FAILED : STR_ERROR_GAME_LOAD_FAILED, lastof(err_str));
2493 return err_str;
2494 }
2495
2497 static void SaveFileError()
2498 {
2499 SetDParamStr(0, GetSaveLoadErrorString());
2500 ShowErrorMessage(STR_JUST_RAW_STRING, INVALID_STRING_ID, WL_ERROR);
2501 SaveFileDone();
2502 }
2503
2508 static SaveOrLoadResult SaveFileToDisk(bool threaded)
2509 {
2510 try {
2511 byte compression;
2512 const SaveLoadFormat *fmt = GetSavegameFormat(_savegame_format, &compression);
2513
2514 /* We have written our stuff to memory, now write it to file! */
2515 uint32 hdr[2] = { fmt->tag, TO_BE32(SAVEGAME_VERSION << 16) };
2516 _sl.sf->Write((byte*)hdr, sizeof(hdr));
2517
2518 _sl.sf = fmt->init_write(_sl.sf, compression);
2519 _sl.dumper->Flush(_sl.sf);
2520
2521 ClearSaveLoadState();
2522
2523 if (threaded) SetAsyncSaveFinish(SaveFileDone);
2524
2525 return SL_OK;
2526 } catch (...) {
2527 ClearSaveLoadState();
2528
2529 AsyncSaveFinishProc asfp = SaveFileDone;
2530
2531 /* We don't want to shout when saving is just
2532 * cancelled due to a client disconnecting. */
2533 if (_sl.error_str != STR_NETWORK_ERROR_LOSTCONNECTION) {
2534 /* Skip the "colour" character */
2535 DEBUG(sl, 0, "%s", GetSaveLoadErrorString() + 3);
2536 asfp = SaveFileError;
2537 }
2538
2539 if (threaded) {
2540 SetAsyncSaveFinish(asfp);
2541 } else {
2542 asfp();
2543 }
2544 return SL_ERROR;
2545 }
2546 }
2547
2549 static void SaveFileToDiskThread(void *arg)
2550 {
2551 SaveFileToDisk(true);
2552 }
2553
2554 void WaitTillSaved()
2555 {
2556 if (_save_thread == NULL) return;
2557
2558 _save_thread->Join();
2559 delete _save_thread;
2560 _save_thread = NULL;
2561
2562 /* Make sure every other state is handled properly as well. */
2563 ProcessAsyncSaveFinish();
2564 }
2565
2574 static SaveOrLoadResult DoSave(SaveFilter *writer, bool threaded)
2575 {
2576 assert(!_sl.saveinprogress);
2577
2578 _sl.dumper = new MemoryDumper();
2579 _sl.sf = writer;
2580
2581 _sl_version = SAVEGAME_VERSION;
2582
2583 SaveViewportBeforeSaveGame();
2584 SlSaveChunks();
2585
2586 SaveFileStart();
2587 if (!threaded || !ThreadObject::New(&SaveFileToDiskThread, NULL, &_save_thread)) {
2588 if (threaded) DEBUG(sl, 1, "Cannot create savegame thread, reverting to single-threaded mode...");
2589
2590 SaveOrLoadResult result = SaveFileToDisk(false);
2591 SaveFileDone();
2592
2593 return result;
2594 }
2595
2596 return SL_OK;
2597 }
2598
2605 SaveOrLoadResult SaveWithFilter(SaveFilter *writer, bool threaded)
2606 {
2607 try {
2608 _sl.action = SLA_SAVE;
2609 return DoSave(writer, threaded);
2610 } catch (...) {
2611 ClearSaveLoadState();
2612 return SL_ERROR;
2613 }
2614 }
2615
2622 static SaveOrLoadResult DoLoad(LoadFilter *reader, bool load_check)
2623 {
2624 _sl.lf = reader;
2625
2626 if (load_check) {
2627 /* Clear previous check data */
2628 _load_check_data.Clear();
2629 /* Mark SL_LOAD_CHECK as supported for this savegame. */
2630 _load_check_data.checkable = true;
2631 }
2632
2633 uint32 hdr[2];
2634 if (_sl.lf->Read((byte*)hdr, sizeof(hdr)) != sizeof(hdr)) SlError(STR_GAME_SAVELOAD_ERROR_FILE_NOT_READABLE);
2635
2636 /* see if we have any loader for this type. */
2637 const SaveLoadFormat *fmt = _saveload_formats;
2638 for (;;) {
2639 /* No loader found, treat as version 0 and use LZO format */
2640 if (fmt == endof(_saveload_formats)) {
2641 DEBUG(sl, 0, "Unknown savegame type, trying to load it as the buggy format");
2642 _sl.lf->Reset();
2643 _sl_version = 0;
2644 _sl_minor_version = 0;
2645
2646 /* Try to find the LZO savegame format; it uses 'OTTD' as tag. */
2647 fmt = _saveload_formats;
2648 for (;;) {
2649 if (fmt == endof(_saveload_formats)) {
2650 /* Who removed LZO support? Bad bad boy! */
2651 NOT_REACHED();
2652 }
2653 if (fmt->tag == TO_BE32X('OTTD')) break;
2654 fmt++;
2655 }
2656 break;
2657 }
2658
2659 if (fmt->tag == hdr[0]) {
2660 /* check version number */
2661 _sl_version = TO_BE32(hdr[1]) >> 16;
2662 /* Minor is not used anymore from version 18.0, but it is still needed
2663 * in versions before that (4 cases) which can't be removed easy.
2664 * Therefore it is loaded, but never saved (or, it saves a 0 in any scenario). */
2665 _sl_minor_version = (TO_BE32(hdr[1]) >> 8) & 0xFF;
2666
2667 DEBUG(sl, 1, "Loading savegame version %d", _sl_version);
2668
2669 /* Is the version higher than the current? */
2670 if (_sl_version > SAVEGAME_VERSION) SlError(STR_GAME_SAVELOAD_ERROR_TOO_NEW_SAVEGAME);
2671 break;
2672 }
2673
2674 fmt++;
2675 }
2676
2677 /* loader for this savegame type is not implemented? */
2678 if (fmt->init_load == NULL) {
2679 char err_str[64];
2680 seprintf(err_str, lastof(err_str), "Loader for '%s' is not available.", fmt->name);
2681 SlError(STR_GAME_SAVELOAD_ERROR_BROKEN_INTERNAL_ERROR, err_str);
2682 }
2683
2684 _sl.lf = fmt->init_load(_sl.lf);
2685 _sl.reader = new ReadBuffer(_sl.lf);
2686 _next_offs = 0;
2687
2688 if (!load_check) {
2689 /* Old maps were hardcoded to 256x256 and thus did not contain
2690 * any mapsize information. Pre-initialize to 256x256 to not to
2691 * confuse old games */
2692 InitializeGame(256, 256, true, true);
2693
2694 GamelogReset();
2695
2696 if (IsSavegameVersionBefore(4)) {
2697 /*
2698 * NewGRFs were introduced between 0.3,4 and 0.3.5, which both
2699 * shared savegame version 4. Anything before that 'obviously'
2700 * does not have any NewGRFs. Between the introduction and
2701 * savegame version 41 (just before 0.5) the NewGRF settings
2702 * were not stored in the savegame and they were loaded by
2703 * using the settings from the main menu.
2704 * So, to recap:
2705 * - savegame version < 4: do not load any NewGRFs.
2706 * - savegame version >= 41: load NewGRFs from savegame, which is
2707 * already done at this stage by
2708 * overwriting the main menu settings.
2709 * - other savegame versions: use main menu settings.
2710 *
2711 * This means that users *can* crash savegame version 4..40
2712 * savegames if they set incompatible NewGRFs in the main menu,
2713 * but can't crash anymore for savegame version < 4 savegames.
2714 *
2715 * Note: this is done here because AfterLoadGame is also called
2716 * for TTO/TTD/TTDP savegames which have their own NewGRF logic.
2717 */
2718 ClearGRFConfigList(&_grfconfig);
2719 }
2720 }
2721
2722 if (load_check) {
2723 /* Load chunks into _load_check_data.
2724 * No pools are loaded. References are not possible, and thus do not need resolving. */
2725 SlLoadCheckChunks();
2726 } else {
2727 /* Load chunks and resolve references */
2728 SlLoadChunks();
2729 SlFixPointers();
2730 }
2731
2732 ClearSaveLoadState();
2733
2734 _savegame_type = SGT_OTTD;
2735
2736 if (load_check) {
2737 /* The only part from AfterLoadGame() we need */
2738 _load_check_data.grf_compatibility = IsGoodGRFConfigList(_load_check_data.grfconfig);
2739 } else {
2740 GamelogStartAction(GLAT_LOAD);
2741
2742 /* After loading fix up savegame for any internal changes that
2743 * might have occurred since then. If it fails, load back the old game. */
2744 if (!AfterLoadGame()) {
2745 GamelogStopAction();
2746 return SL_REINIT;
2747 }
2748
2749 GamelogStopAction();
2750 }
2751
2752 return SL_OK;
2753 }
2754
2760 SaveOrLoadResult LoadWithFilter(LoadFilter *reader)
2761 {
2762 try {
2763 _sl.action = SLA_LOAD;
2764 return DoLoad(reader, false);
2765 } catch (...) {
2766 ClearSaveLoadState();
2767 return SL_REINIT;
2768 }
2769 }
2770
2780 SaveOrLoadResult SaveOrLoad(const char *filename, int mode, Subdirectory sb, bool threaded)
2781 {
2782 /* An instance of saving is already active, so don't go saving again */
2783 if (_sl.saveinprogress && mode == SL_SAVE && threaded) {
2784 /* if not an autosave, but a user action, show error message */
2785 if (!_do_autosave) ShowErrorMessage(STR_ERROR_SAVE_STILL_IN_PROGRESS, INVALID_STRING_ID, WL_ERROR);
2786 return SL_OK;
2787 }
2788 WaitTillSaved();
2789
2790 try {
2791 /* Load a TTDLX or TTDPatch game */
2792 if (mode == SL_OLD_LOAD) {
2793 InitializeGame(256, 256, true, true); // set a mapsize of 256x256 for TTDPatch games or it might get confused
2794
2795 /* TTD/TTO savegames have no NewGRFs, TTDP savegame have them
2796 * and if so a new NewGRF list will be made in LoadOldSaveGame.
2797 * Note: this is done here because AfterLoadGame is also called
2798 * for OTTD savegames which have their own NewGRF logic. */
2799 ClearGRFConfigList(&_grfconfig);
2800 GamelogReset();
2801 if (!LoadOldSaveGame(filename)) return SL_REINIT;
2802 _sl_version = 0;
2803 _sl_minor_version = 0;
2804 GamelogStartAction(GLAT_LOAD);
2805 if (!AfterLoadGame()) {
2806 GamelogStopAction();
2807 return SL_REINIT;
2808 }
2809 GamelogStopAction();
2810 return SL_OK;
2811 }
2812
2813 switch (mode) {
2814 case SL_LOAD_CHECK: _sl.action = SLA_LOAD_CHECK; break;
2815 case SL_LOAD: _sl.action = SLA_LOAD; break;
2816 case SL_SAVE: _sl.action = SLA_SAVE; break;
2817 default: NOT_REACHED();
2818 }
2819
2820 FILE *fh = (mode == SL_SAVE) ? FioFOpenFile(filename, "wb", sb) : FioFOpenFile(filename, "rb", sb);
2821
2822 /* Make it a little easier to load savegames from the console */
2823 if (fh == NULL && mode != SL_SAVE) fh = FioFOpenFile(filename, "rb", SAVE_DIR);
2824 if (fh == NULL && mode != SL_SAVE) fh = FioFOpenFile(filename, "rb", BASE_DIR);
2825 if (fh == NULL && mode != SL_SAVE) fh = FioFOpenFile(filename, "rb", SCENARIO_DIR);
2826
2827 if (fh == NULL) {
2828 SlError(mode == SL_SAVE ? STR_GAME_SAVELOAD_ERROR_FILE_NOT_WRITEABLE : STR_GAME_SAVELOAD_ERROR_FILE_NOT_READABLE);
2829 }
2830
2831 if (mode == SL_SAVE) { // SAVE game
2832 DEBUG(desync, 1, "save: %08x; %02x; %s", _date, _date_fract, filename);
2833 if (_network_server || !_settings_client.gui.threaded_saves) threaded = false;
2834
2835 return DoSave(new FileWriter(fh), threaded);
2836 }
2837
2838 /* LOAD game */
2839 assert(mode == SL_LOAD || mode == SL_LOAD_CHECK);
2840 DEBUG(desync, 1, "load: %s", filename);
2841 return DoLoad(new FileReader(fh), mode == SL_LOAD_CHECK);
2842 } catch (...) {
2843 ClearSaveLoadState();
2844
2845 /* Skip the "colour" character */
2846 if (mode != SL_LOAD_CHECK) DEBUG(sl, 0, "%s", GetSaveLoadErrorString() + 3);
2847
2848 /* A saver/loader exception!! reinitialize all variables to prevent crash! */
2849 return (mode == SL_LOAD || mode == SL_OLD_LOAD) ? SL_REINIT : SL_ERROR;
2850 }
2851 }
2852
2854 void DoExitSave()
2855 {
2856 SaveOrLoad("exit.sav", SL_SAVE, AUTOSAVE_DIR);
2857 }
2858
2864 void GenerateDefaultSaveName(char *buf, const char *last)
2865 {
2866 /* Check if we have a name for this map, which is the name of the first
2867 * available company. When there's no company available we'll use
2868 * 'Spectator' as "company" name. */
2869 CompanyID cid = _local_company;
2870 if (!Company::IsValidID(cid)) {
2871 const Company *c;
2872 FOR_ALL_COMPANIES(c) {
2873 cid = c->index;
2874 break;
2875 }
2876 }
2877
2878 SetDParam(0, cid);
2879
2880 /* Insert current date */
2881 switch (_settings_client.gui.date_format_in_default_names) {
2882 case 0: SetDParam(1, STR_JUST_DATE_LONG); break;
2883 case 1: SetDParam(1, STR_JUST_DATE_TINY); break;
2884 case 2: SetDParam(1, STR_JUST_DATE_ISO); break;
2885 default: NOT_REACHED();
2886 }
2887 SetDParam(2, _date);
2888
2889 /* Get the correct string (special string for when there's not company) */
2890 GetString(buf, !Company::IsValidID(cid) ? STR_SAVEGAME_NAME_SPECTATOR : STR_SAVEGAME_NAME_DEFAULT, last);
2891 SanitizeFilename(buf);
2892 }
2893
2894 #if 0
2895
2901 int GetSavegameType(char *file)
2902 {
2903 const SaveLoadFormat *fmt;
2904 uint32 hdr;
2905 FILE *f;
2906 int mode = SL_OLD_LOAD;
2907
2908 f = fopen(file, "rb");
2909 if (fread(&hdr, sizeof(hdr), 1, f) != 1) {
2910 DEBUG(sl, 0, "Savegame is obsolete or invalid format");
2911 mode = SL_LOAD; // don't try to get filename, just show name as it is written
2912 } else {
2913 /* see if we have any loader for this type. */
2914 for (fmt = _saveload_formats; fmt != endof(_saveload_formats); fmt++) {
2915 if (fmt->tag == hdr) {
2916 mode = SL_LOAD; // new type of savegame
2917 break;
2918 }
2919 }
2920 }
2921
2922 fclose(f);
2923 return mode;
2924 }
2925 #endif