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