src/gba/serialize.c (view raw)
1/* Copyright (c) 2013-2016 Jeffrey Pfau
2 *
3 * This Source Code Form is subject to the terms of the Mozilla Public
4 * License, v. 2.0. If a copy of the MPL was not distributed with this
5 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
6#include <mgba/internal/gba/serialize.h>
7
8#include <mgba/internal/arm/macros.h>
9#include <mgba/internal/gba/bios.h>
10#include <mgba/internal/gba/io.h>
11
12#include <mgba-util/memory.h>
13#include <mgba-util/vfs.h>
14
15#include <fcntl.h>
16
17const uint32_t GBA_SAVESTATE_MAGIC = 0x01000000;
18const uint32_t GBA_SAVESTATE_VERSION = 0x00000003;
19
20mLOG_DEFINE_CATEGORY(GBA_STATE, "GBA Savestate", "gba.serialize");
21
22struct GBABundledState {
23 struct GBASerializedState* state;
24 struct mStateExtdata* extdata;
25};
26
27void GBASerialize(struct GBA* gba, struct GBASerializedState* state) {
28 STORE_32(GBA_SAVESTATE_MAGIC + GBA_SAVESTATE_VERSION, 0, &state->versionMagic);
29 STORE_32(gba->biosChecksum, 0, &state->biosChecksum);
30 STORE_32(gba->romCrc32, 0, &state->romCrc32);
31 STORE_32(gba->timing.masterCycles, 0, &state->masterCycles);
32 STORE_64LE(gba->timing.globalCycles, 0, &state->globalCycles);
33
34 if (gba->memory.rom) {
35 state->id = ((struct GBACartridge*) gba->memory.rom)->id;
36 memcpy(state->title, ((struct GBACartridge*) gba->memory.rom)->title, sizeof(state->title));
37 } else {
38 state->id = 0;
39 memset(state->title, 0, sizeof(state->title));
40 }
41
42 int i;
43 for (i = 0; i < 16; ++i) {
44 STORE_32(gba->cpu->gprs[i], i * sizeof(state->cpu.gprs[0]), state->cpu.gprs);
45 }
46 STORE_32(gba->cpu->cpsr.packed, 0, &state->cpu.cpsr.packed);
47 STORE_32(gba->cpu->spsr.packed, 0, &state->cpu.spsr.packed);
48 STORE_32(gba->cpu->cycles, 0, &state->cpu.cycles);
49 STORE_32(gba->cpu->nextEvent, 0, &state->cpu.nextEvent);
50 for (i = 0; i < 6; ++i) {
51 int j;
52 for (j = 0; j < 7; ++j) {
53 STORE_32(gba->cpu->bankedRegisters[i][j], (i * 7 + j) * sizeof(gba->cpu->bankedRegisters[0][0]), state->cpu.bankedRegisters);
54 }
55 STORE_32(gba->cpu->bankedSPSRs[i], i * sizeof(gba->cpu->bankedSPSRs[0]), state->cpu.bankedSPSRs);
56 }
57
58 STORE_32(gba->memory.biosPrefetch, 0, &state->biosPrefetch);
59 STORE_32(gba->cpu->prefetch[0], 0, state->cpuPrefetch);
60 STORE_32(gba->cpu->prefetch[1], 4, state->cpuPrefetch);
61 STORE_32(gba->memory.lastPrefetchedPc, 0, &state->lastPrefetchedPc);
62
63 GBASerializedMiscFlags miscFlags = 0;
64 miscFlags = GBASerializedMiscFlagsSetHalted(miscFlags, gba->cpu->halted);
65 miscFlags = GBASerializedMiscFlagsSetPOSTFLG(miscFlags, gba->memory.io[REG_POSTFLG >> 1] & 1);
66 if (mTimingIsScheduled(&gba->timing, &gba->irqEvent)) {
67 miscFlags = GBASerializedMiscFlagsFillIrqPending(miscFlags);
68 STORE_32(gba->irqEvent.when - mTimingCurrentTime(&gba->timing), 0, &state->nextIrq);
69 }
70 miscFlags = GBASerializedMiscFlagsSetBlocked(miscFlags, gba->cpuBlocked);
71 STORE_32(miscFlags, 0, &state->miscFlags);
72
73 GBAMemorySerialize(&gba->memory, state);
74 GBAIOSerialize(gba, state);
75 GBAVideoSerialize(&gba->video, state);
76 GBAAudioSerialize(&gba->audio, state);
77 GBASavedataSerialize(&gba->memory.savedata, state);
78}
79
80bool GBADeserialize(struct GBA* gba, const struct GBASerializedState* state) {
81 bool error = false;
82 int32_t check;
83 uint32_t ucheck;
84 LOAD_32(ucheck, 0, &state->versionMagic);
85 if (ucheck > GBA_SAVESTATE_MAGIC + GBA_SAVESTATE_VERSION) {
86 mLOG(GBA_STATE, WARN, "Invalid or too new savestate: expected %08X, got %08X", GBA_SAVESTATE_MAGIC + GBA_SAVESTATE_VERSION, ucheck);
87 error = true;
88 } else if (ucheck < GBA_SAVESTATE_MAGIC) {
89 mLOG(GBA_STATE, WARN, "Invalid savestate: expected %08X, got %08X", GBA_SAVESTATE_MAGIC + GBA_SAVESTATE_VERSION, ucheck);
90 error = true;
91 } else if (ucheck < GBA_SAVESTATE_MAGIC + GBA_SAVESTATE_VERSION) {
92 mLOG(GBA_STATE, WARN, "Old savestate: expected %08X, got %08X, continuing anyway", GBA_SAVESTATE_MAGIC + GBA_SAVESTATE_VERSION, ucheck);
93 }
94 LOAD_32(ucheck, 0, &state->biosChecksum);
95 if (ucheck != gba->biosChecksum) {
96 mLOG(GBA_STATE, WARN, "Savestate created using a different version of the BIOS: expected %08X, got %08X", gba->biosChecksum, ucheck);
97 uint32_t pc;
98 LOAD_32(pc, ARM_PC * sizeof(state->cpu.gprs[0]), state->cpu.gprs);
99 if ((ucheck == GBA_BIOS_CHECKSUM || gba->biosChecksum == GBA_BIOS_CHECKSUM) && pc < SIZE_BIOS && pc >= 0x20) {
100 error = true;
101 }
102 }
103 if (gba->memory.rom && (state->id != ((struct GBACartridge*) gba->memory.rom)->id || memcmp(state->title, ((struct GBACartridge*) gba->memory.rom)->title, sizeof(state->title)))) {
104 mLOG(GBA_STATE, WARN, "Savestate is for a different game");
105 error = true;
106 } else if (!gba->memory.rom && state->id != 0) {
107 mLOG(GBA_STATE, WARN, "Savestate is for a game, but no game loaded");
108 error = true;
109 }
110 LOAD_32(ucheck, 0, &state->romCrc32);
111 if (ucheck != gba->romCrc32) {
112 mLOG(GBA_STATE, WARN, "Savestate is for a different version of the game");
113 }
114 LOAD_32(check, 0, &state->cpu.cycles);
115 if (check < 0) {
116 mLOG(GBA_STATE, WARN, "Savestate is corrupted: CPU cycles are negative");
117 error = true;
118 }
119 if (check >= (int32_t) GBA_ARM7TDMI_FREQUENCY) {
120 mLOG(GBA_STATE, WARN, "Savestate is corrupted: CPU cycles are too high");
121 error = true;
122 }
123 LOAD_32(check, ARM_PC * sizeof(state->cpu.gprs[0]), state->cpu.gprs);
124 int region = (check >> BASE_OFFSET);
125 if ((region == REGION_CART0 || region == REGION_CART1 || region == REGION_CART2) && ((check - WORD_SIZE_ARM) & SIZE_CART0) >= gba->memory.romSize - WORD_SIZE_ARM) {
126 mLOG(GBA_STATE, WARN, "Savestate created using a differently sized version of the ROM");
127 error = true;
128 }
129 if (error) {
130 return false;
131 }
132 mTimingClear(&gba->timing);
133 LOAD_32(gba->timing.masterCycles, 0, &state->masterCycles);
134 LOAD_64LE(gba->timing.globalCycles, 0, &state->globalCycles);
135
136 size_t i;
137 for (i = 0; i < 16; ++i) {
138 LOAD_32(gba->cpu->gprs[i], i * sizeof(gba->cpu->gprs[0]), state->cpu.gprs);
139 }
140 LOAD_32(gba->cpu->cpsr.packed, 0, &state->cpu.cpsr.packed);
141 LOAD_32(gba->cpu->spsr.packed, 0, &state->cpu.spsr.packed);
142 LOAD_32(gba->cpu->cycles, 0, &state->cpu.cycles);
143 LOAD_32(gba->cpu->nextEvent, 0, &state->cpu.nextEvent);
144 for (i = 0; i < 6; ++i) {
145 int j;
146 for (j = 0; j < 7; ++j) {
147 LOAD_32(gba->cpu->bankedRegisters[i][j], (i * 7 + j) * sizeof(gba->cpu->bankedRegisters[0][0]), state->cpu.bankedRegisters);
148 }
149 LOAD_32(gba->cpu->bankedSPSRs[i], i * sizeof(gba->cpu->bankedSPSRs[0]), state->cpu.bankedSPSRs);
150 }
151 gba->cpu->privilegeMode = gba->cpu->cpsr.priv;
152 gba->cpu->memory.setActiveRegion(gba->cpu, gba->cpu->gprs[ARM_PC]);
153 if (state->biosPrefetch) {
154 LOAD_32(gba->memory.biosPrefetch, 0, &state->biosPrefetch);
155 }
156 LOAD_32(gba->memory.lastPrefetchedPc, 0, &state->lastPrefetchedPc);
157 if (gba->cpu->cpsr.t) {
158 gba->cpu->executionMode = MODE_THUMB;
159 if (state->cpuPrefetch[0] && state->cpuPrefetch[1]) {
160 LOAD_32(gba->cpu->prefetch[0], 0, state->cpuPrefetch);
161 LOAD_32(gba->cpu->prefetch[1], 4, state->cpuPrefetch);
162 gba->cpu->prefetch[0] &= 0xFFFF;
163 gba->cpu->prefetch[1] &= 0xFFFF;
164 } else {
165 // Maintain backwards compat
166 LOAD_16(gba->cpu->prefetch[0], (gba->cpu->gprs[ARM_PC] - WORD_SIZE_THUMB) & gba->cpu->memory.activeMask, gba->cpu->memory.activeRegion);
167 LOAD_16(gba->cpu->prefetch[1], (gba->cpu->gprs[ARM_PC]) & gba->cpu->memory.activeMask, gba->cpu->memory.activeRegion);
168 }
169 } else {
170 gba->cpu->executionMode = MODE_ARM;
171 if (state->cpuPrefetch[0] && state->cpuPrefetch[1]) {
172 LOAD_32(gba->cpu->prefetch[0], 0, state->cpuPrefetch);
173 LOAD_32(gba->cpu->prefetch[1], 4, state->cpuPrefetch);
174 } else {
175 // Maintain backwards compat
176 LOAD_32(gba->cpu->prefetch[0], (gba->cpu->gprs[ARM_PC] - WORD_SIZE_ARM) & gba->cpu->memory.activeMask, gba->cpu->memory.activeRegion);
177 LOAD_32(gba->cpu->prefetch[1], (gba->cpu->gprs[ARM_PC]) & gba->cpu->memory.activeMask, gba->cpu->memory.activeRegion);
178 }
179 }
180 GBASerializedMiscFlags miscFlags = 0;
181 LOAD_32(miscFlags, 0, &state->miscFlags);
182 gba->cpu->halted = GBASerializedMiscFlagsGetHalted(miscFlags);
183 gba->memory.io[REG_POSTFLG >> 1] = GBASerializedMiscFlagsGetPOSTFLG(miscFlags);
184 if (GBASerializedMiscFlagsIsIrqPending(miscFlags)) {
185 int32_t when;
186 LOAD_32(when, 0, &state->nextIrq);
187 mTimingSchedule(&gba->timing, &gba->irqEvent, when);
188 }
189 gba->cpuBlocked = GBASerializedMiscFlagsGetBlocked(miscFlags);
190
191 GBAVideoDeserialize(&gba->video, state);
192 GBAMemoryDeserialize(&gba->memory, state);
193 GBAIODeserialize(gba, state);
194 GBAAudioDeserialize(&gba->audio, state);
195 GBASavedataDeserialize(&gba->memory.savedata, state);
196
197 gba->timing.reroot = gba->timing.root;
198 gba->timing.root = NULL;
199
200 return true;
201}