-
Notifications
You must be signed in to change notification settings - Fork 16
/
mapper.rs
364 lines (324 loc) · 10.3 KB
/
mapper.rs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
#![allow(unused_imports)]
#![allow(dead_code)]
use std::cell::UnsafeCell;
use std::borrow::BorrowMut;
use std::io::Read;
use std::io::Write;
use crate::common::ternary;
use crate::serialization::Savable;
pub trait AddressSpace : Savable {
// Minimal definition
fn peek(&self, ptr: u16) -> u8;
fn poke(&mut self, ptr: u16, v: u8);
// Helper methods
fn peek16(&self, ptr:u16) -> u16 {
let low = self.peek(ptr);
let high = self.peek(ptr.wrapping_add(1));
let result = (low as u16) + ((high as u16) << 8);
//eprintln!("DEBUG - PEEK16 - {:x} {:x} {:x} {:x} {:x} {:x}", high, low, result, high as u16, low as u16, (high as u16) << 8);
return result;
}
fn peek_offset(&self, ptr: u16, os: i16) -> u8 {
return self.peek(ptr.wrapping_add(os as u16));
}
fn peek_offset16(&self, ptr: u16, os: i16) -> u16 {
return self.peek16(ptr.wrapping_add(os as u16));
}
fn poke_offset(&mut self, ptr: u16, os: i16, v: u8) {
self.poke(ptr.wrapping_add(os as u16), v);
}
}
pub struct Ram {
bs: Vec<u8>,
}
impl Ram {
pub fn new(size:usize) -> Ram {
Ram { bs: vec!(0; size) }
}
}
impl Savable for Ram {
fn save(&self, fh: &mut Write) {
self.bs.save(fh);
}
fn load(&mut self, fh: &mut Read) {
self.bs.load(fh);
}
}
impl AddressSpace for Ram {
fn peek(&self, ptr:u16) -> u8 {
return self.bs[ptr as usize];
}
fn poke(&mut self, ptr:u16, v:u8) {
self.bs[ptr as usize] = v;
}
}
impl<T:AddressSpace> AddressSpace for *mut T {
fn peek(&self, ptr:u16) -> u8 {
let t:&T = unsafe { &**self as &T};
return t.peek(ptr);
}
fn poke(&mut self, ptr:u16, x:u8) {
let t:&mut T = unsafe { &mut **self as &mut T };
t.poke(ptr, x);
}
}
impl<T:AddressSpace> Savable for *mut T {
// The pointer should still be valid, since this Trait updates objects in-place.
fn save(&self, _:&mut Write) { }
fn load(&mut self, _:&mut Read) { }
}
pub struct Rom {
bs: Vec<u8>,
}
impl Rom {
pub fn new(bs: Vec<u8>) -> Rom {
Rom { bs: bs }
}
}
impl Savable for Rom {
fn save(&self, fh: &mut Write) {
self.bs.save(fh);
}
fn load(&mut self, fh: &mut Read) {
self.bs.load(fh);
}
}
impl AddressSpace for Rom {
fn peek(&self, ptr:u16) -> u8 {
let value = self.bs[ptr as usize];
//eprintln!("DEBUG - ROM-ACCESS - ({:?}, {:?})", ptr, value);
return value;
}
fn poke(&mut self, ptr:u16, value:u8) {
panic!("Rom - Attempted to write read-only memory at {} - value={}", ptr, value);
}
}
pub struct MirroredAddressSpace {
base: Box<dyn AddressSpace>,
base_begin: u16,
base_end: u16,
extended_begin: u16,
extended_end: u16,
}
impl MirroredAddressSpace {
// If a memory range has been mirrored to another, map a pointer to the "base range" or fail if it lies outside.
fn map_address(&self, ptr: u16) -> u16 {
if ptr < self.extended_begin || ptr > self.extended_end {
panic!("map_address: Out of mapped range ({:?} not in range [{:?}, {:?}]", ptr, self.extended_begin, self.extended_end);
}
let width = self.base_end - self.base_begin + 1;
let relptr = ptr - self.extended_begin;
if relptr >= width {
return (ptr - self.extended_begin) % width + self.base_begin;
} else {
return relptr + self.base_begin;
}
}
}
impl Savable for MirroredAddressSpace {
fn save(&self, fh: &mut Write) {
self.base.save(fh);
self.base_begin.save(fh);
self.base_end.save(fh);
self.extended_begin.save(fh);
self.extended_end.save(fh);
}
fn load(&mut self, fh: &mut Read) {
self.base.load(fh);
self.base_begin.load(fh);
self.base_end.load(fh);
self.extended_begin.load(fh);
self.extended_end.load(fh);
}
}
impl AddressSpace for MirroredAddressSpace {
fn peek(&self, ptr:u16) -> u8 {
return self.base.peek(self.map_address(ptr));
}
fn poke(&mut self, ptr:u16, value:u8) {
let space_ptr = self.map_address(ptr);
self.base.poke(space_ptr, value);
}
}
pub struct NullAddressSpace { }
impl NullAddressSpace {
pub fn new() -> NullAddressSpace {
NullAddressSpace { }
}
}
impl Savable for NullAddressSpace {
fn save(&self, _fh: &mut Write) {}
fn load(&mut self, _fh: &mut Read) { }
}
impl AddressSpace for NullAddressSpace {
fn peek(&self, ptr:u16) -> u8{
eprintln!("DEBUG - READ FROM NULL MAP {:x}", ptr);
return 0;
}
fn poke(&mut self, ptr:u16, value:u8) {
eprintln!("DEBUG - WRITE TO NULL MAP {:x} {:x}", ptr, value);
}
}
type UsesOriginalAddress = bool;
struct Mapping(u16, u16, Box<dyn AddressSpace>, UsesOriginalAddress);
impl Mapping {
fn map_ptr(&self, ptr:u16) -> Option<u16> {
let Mapping(range_begin, range_end, _, use_original_address) = *self;
if ptr >= range_begin && ptr <= range_end {
let space_ptr = ternary(use_original_address, ptr, ptr - range_begin);
return Some(space_ptr);
}
return None;
}
}
impl Savable for Mapping {
fn save(&self, fh: &mut Write) {
self.0.save(fh);
self.1.save(fh);
self.2.save(fh);
self.3.save(fh);
}
fn load(&mut self, fh: &mut Read) {
self.0.load(fh);
self.1.load(fh);
self.2.load(fh);
self.3.load(fh);
}
}
pub struct Mapper {
mappings: Vec<Mapping>,
}
impl Savable for Mapper {
fn save(&self, fh: &mut Write) {
self.mappings.as_slice().save(fh);
}
fn load(&mut self, fh: &mut Read) {
self.mappings.as_mut_slice().load(fh);
}
}
impl Mapper {
pub fn new() -> Mapper {
Mapper {
mappings: Vec::new(),
}
}
fn print_mappings(&self) {
for Mapping(range_begin, range_end, _, use_original_address) in self.mappings.iter() {
eprintln!("[{:x}, {:x}] - {:?}", range_begin, range_end, use_original_address);
}
}
fn lookup_address_space(&self, ptr: u16) -> (usize, u16) {
for space_idx in 0..self.mappings.len() {
if let Some(space_ptr) = self.mappings[space_idx].map_ptr(ptr) {
return (space_idx, space_ptr);
}
}
eprintln!("lookup_address_space - Unmapped pointer {:?}.", ptr);
eprintln!("Mappings:");
self.print_mappings();
panic!();
}
pub fn map_address_space(&mut self, begin: u16, end: u16, space: Box<dyn AddressSpace>, use_original: bool) {
self.mappings.push(Mapping(begin, end, space, use_original));
}
pub fn map_ram(&mut self, begin: u16, end: u16) {
let size = end - begin;
let space:Ram = Ram{ bs: vec![0; size as usize] };
self.map_address_space(begin, end, Box::new(space), false);
}
pub fn map_rom(&mut self, begin: u16, end: u16, bytes: &[u8]) {
let space:Rom = Rom{ bs: bytes.to_vec() };
self.map_address_space(begin, end, Box::new(space), false);
}
pub fn map_null(&mut self, begin: u16, end: u16) {
let space:NullAddressSpace = NullAddressSpace {};
self.map_address_space(begin, end, Box::new(space), true);
}
pub fn map_mirrored(&mut self, begin: u16, end: u16, extended_begin: u16, extended_end: u16, space: Box<dyn AddressSpace>, use_original: bool) {
let base_begin =
if use_original { begin } else { 0 };
let base_end = base_begin + (end - begin);
let space:MirroredAddressSpace = MirroredAddressSpace {
base: space,
base_begin: base_begin, base_end,
extended_begin, extended_end,
};
self.map_address_space(extended_begin, extended_end, Box::new(space), true);
}
}
impl AddressSpace for Mapper {
fn peek(&self, ptr:u16) -> u8{
let (space_idx, space_ptr) = self.lookup_address_space(ptr);
let Mapping(_, _, space, _) = &self.mappings[space_idx];
//eprintln!("DEBUG - MEMORY-ACCESS - ({:?}, {:?})", space_idx, space_ptr);
let value = space.peek(space_ptr);
//eprintln!("DEBUG - MEMORY-ACCESS-RESULT - ({:x})", value);
return value;
}
fn poke(&mut self, ptr:u16, value:u8) {
let (space_idx, space_ptr) = self.lookup_address_space(ptr);
let &mut Mapping(_,_, ref mut space,_) = self.mappings.get_mut(space_idx).unwrap();
space.poke(space_ptr, value);
}
}
#[derive(Debug, PartialEq, Copy, Clone)]
pub enum AccessType { Read, Write }
pub type LoggedAddressSpaceRecord = (usize, AccessType, u16, u8);
pub struct LoggedAddressSpace {
pub space: Box<AddressSpace>,
pub log: UnsafeCell<Vec<LoggedAddressSpaceRecord>>,
}
impl Savable for LoggedAddressSpace {
fn save(&self, _fh: &mut Write) { panic!("save() unimplemented"); }
fn load(&mut self, _fh: &mut Read) { panic!("load() unimplemented"); }
}
impl LoggedAddressSpace {
pub fn new(space:Box<AddressSpace>) -> LoggedAddressSpace {
LoggedAddressSpace {
space: space,
log: UnsafeCell::new(vec!()),
}
}
pub fn get_log(&self) -> &mut Vec<LoggedAddressSpaceRecord> {
return unsafe { &mut *self.log.get() };
}
pub fn copy_log(&self) -> Vec<LoggedAddressSpaceRecord> {
return self.get_log().clone();
}
}
impl AddressSpace for LoggedAddressSpace {
fn peek(&self, ptr: u16) -> u8{
let v = self.space.peek(ptr);
let log = self.get_log();
let record = (log.len(), AccessType::Read, ptr, v);
log.push(record);
return v;
}
fn poke(&mut self, ptr: u16, v: u8) {
let log = self.get_log();
let record = (log.len(), AccessType::Write, ptr, v);
log.push(record);
self.space.poke(ptr, v);
}
}
mod tests {
use super::Rom;
use super::Mapper;
use super::AddressSpace;
#[test]
fn test_rom() {
let mut mapper = Mapper::new();
let bs = [1,2,3];
mapper.map_rom(0x1000, 0x1002, &bs);
assert_eq!(mapper.peek(0x1001), 2);
}
#[test]
fn test_mirrored() {
let mut mapper = Mapper::new();
let bs = vec!(1,2,3);
let rom:Rom = Rom::new(bs);
mapper.map_mirrored(0x1000, 0x1002, 0x5000, 0x6000, Box::new(rom), false);
assert_eq!(mapper.peek(0x5002), 3);
assert_eq!(mapper.peek(0x5005), 3);
}
}