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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program 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; either version 2
* of the License, or (at your option) any later version.
* This program 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. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* $URL$
* $Id$
*
* This file contains the handle based Memory Manager code
*/
#define BODGE
#include "common/file.h"
#include "tinsel/drives.h"
#include "tinsel/dw.h"
#include "tinsel/handle.h"
#include "tinsel/heapmem.h" // heap memory manager
#include "tinsel/timers.h" // for DwGetCurrentTime()
#include "tinsel/tinsel.h"
#include "tinsel/scene.h"
namespace Tinsel {
//----------------- EXTERNAL GLOBAL DATA --------------------
#ifdef DEBUG
bool bLockedScene = 0;
#endif
//----------------- LOCAL DEFINES --------------------
struct MEMHANDLE {
char szName[12]; ///< file name of graphics file
int32 filesize; ///< file size and flags
MEM_NODE *_node; ///< memory node for the graphics
uint8 *_ptr; ///< start of data for fixed blocks (i.e., preloaded data)
uint32 flags2;
};
/** memory allocation flags - stored in the top bits of the filesize field */
enum {
fPreload = 0x01000000L, ///< preload memory
fDiscard = 0x02000000L, ///< discard memory
fSound = 0x04000000L, ///< sound data
fGraphic = 0x08000000L, ///< graphic data
fCompressed = 0x10000000L, ///< compressed data
fLoaded = 0x20000000L ///< set when file data has been loaded
};
#define FSIZE_MASK 0x00FFFFFFL ///< mask to isolate the filesize
#define MALLOC_MASK 0xFF000000L ///< mask to isolate the memory allocation flags
//#define HANDLEMASK 0xFF800000L ///< get handle of address
//----------------- LOCAL GLOBAL DATA --------------------
// handle table gets loaded from index file at runtime
static MEMHANDLE *handleTable = 0;
// number of handles in the handle table
static uint numHandles = 0;
static uint32 cdPlayHandle = (uint32)-1;
static int cdPlayFileNum, cdPlaySceneNum;
static SCNHANDLE cdBaseHandle = 0, cdTopHandle = 0;
static Common::File cdGraphStream;
static char szCdPlayFile[100];
//----------------- FORWARD REFERENCES --------------------
static void LoadFile(MEMHANDLE *pH); // load a memory block as a file
/**
* Loads the graphics handle table index file and preloads all the
* permanent graphics etc.
*/
void SetupHandleTable(void) {
bool t2Flag = (TinselVersion == TINSEL_V2);
int RECORD_SIZE = t2Flag ? 24 : 20;
int len;
uint i;
MEMHANDLE *pH;
Common::File f;
if (f.open(TinselV1PSX? PSX_INDEX_FILENAME : INDEX_FILENAME)) {
// get size of index file
len = f.size();
if (len > 0) {
if ((len % RECORD_SIZE) != 0) {
// index file is corrupt
error(FILE_IS_CORRUPT, TinselV1PSX? PSX_INDEX_FILENAME : INDEX_FILENAME);
}
// calc number of handles
numHandles = len / RECORD_SIZE;
// allocate memory for the index file
handleTable = (MEMHANDLE *)calloc(numHandles, sizeof(struct MEMHANDLE));
// make sure memory allocated
assert(handleTable);
// load data
for (i = 0; i < numHandles; i++) {
f.read(handleTable[i].szName, 12);
handleTable[i].filesize = f.readUint32LE();
// The pointer should always be NULL. We don't
// need to read that from the file.
handleTable[i]._node = NULL;
handleTable[i]._ptr = NULL;
f.seek(4, SEEK_CUR);
// For Discworld 2, read in the flags2 field
handleTable[i].flags2 = t2Flag ? f.readUint32LE() : 0;
}
if (f.ioFailed()) {
// index file is corrupt
error(FILE_IS_CORRUPT, (TinselV1PSX? PSX_INDEX_FILENAME : INDEX_FILENAME));
}
// close the file
f.close();
} else { // index file is corrupt
error(FILE_IS_CORRUPT, (TinselV1PSX? PSX_INDEX_FILENAME : INDEX_FILENAME));
}
} else { // cannot find the index file
error(CANNOT_FIND_FILE, (TinselV1PSX? PSX_INDEX_FILENAME : INDEX_FILENAME));
}
// allocate memory nodes and load all permanent graphics
for (i = 0, pH = handleTable; i < numHandles; i++, pH++) {
if (pH->filesize & fPreload) {
// allocate a fixed memory node for permanent files
pH->_ptr = (uint8 *)MemoryAllocFixed((pH->filesize & FSIZE_MASK));
pH->_node = NULL;
// make sure memory allocated
assert(pH->_ptr);
// load the data
LoadFile(pH);
}
#ifdef BODGE
else if ((pH->filesize & FSIZE_MASK) == 8) {
pH->_node = NULL;
pH->_ptr = NULL;
}
#endif
else {
// allocate a discarded memory node for other files
pH->_node = MemoryNoAlloc();
pH->_ptr = NULL;
// make sure memory allocated
assert(pH->_node || pH->_ptr);
}
}
}
void FreeHandleTable(void) {
if (handleTable) {
free(handleTable);
handleTable = NULL;
}
if (cdGraphStream.isOpen())
cdGraphStream.close();
}
/**
* Loads a memory block as a file.
*/
void OpenCDGraphFile(void) {
if (cdGraphStream.isOpen())
cdGraphStream.close();
// As the theory goes, the right CD will be in there!
if (!cdGraphStream.open(szCdPlayFile))
error(CANNOT_FIND_FILE, szCdPlayFile);
}
void LoadCDGraphData(MEMHANDLE *pH) {
// read the data
uint bytes;
byte *addr;
int retries = 0;
assert(!(pH->filesize & fCompressed));
// Can't be preloaded
assert(!(pH->filesize & fPreload));
// discardable - lock the memory
addr = (byte *)MemoryLock(pH->_node);
// make sure address is valid
assert(addr);
// Move to correct place in file and load the required data
cdGraphStream.seek(cdBaseHandle & OFFSETMASK, SEEK_SET);
bytes = cdGraphStream.read(addr, (cdTopHandle - cdBaseHandle) & OFFSETMASK);
// New code to try and handle CD read failures 24/2/97
while (bytes != ((cdTopHandle - cdBaseHandle) & OFFSETMASK) && retries++ < MAX_READ_RETRIES) {
// Try again
cdGraphStream.seek(cdBaseHandle & OFFSETMASK, SEEK_SET);
bytes = cdGraphStream.read(addr, (cdTopHandle - cdBaseHandle) & OFFSETMASK);
}
// discardable - unlock the memory
MemoryUnlock(pH->_node);
// set the loaded flag
pH->filesize |= fLoaded;
// clear the loading flag
// pH->filesize &= ~fLoading;
if (bytes != ((cdTopHandle-cdBaseHandle) & OFFSETMASK))
// file is corrupt
error(FILE_READ_ERROR, "CD play file");
}
/**
* Called immediatly preceding a CDplay().
* Prepares the ground so that when LockMem() is called, the
* appropriate section of the extra scene file is loaded.
* @param start Handle of start of range
* @param next Handle of end of range + 1
*/
void LoadExtraGraphData(SCNHANDLE start, SCNHANDLE next) {
if (cdPlayFileNum == cdPlaySceneNum && start == cdBaseHandle)
return;
OpenCDGraphFile();
MemoryDiscard((handleTable + cdPlayHandle)->_node); // Free it
// It must always be the same
assert(cdPlayHandle == (start >> SCNHANDLE_SHIFT));
assert(cdPlayHandle == (next >> SCNHANDLE_SHIFT));
cdBaseHandle = start;
cdTopHandle = next;
}
void SetCdPlaySceneDetails(int fileNum, const char *fileName) {
cdPlaySceneNum = fileNum;
strcpy(szCdPlayFile, fileName);
}
void SetCdPlayHandle(int fileNum) {
cdPlayHandle = fileNum;
}
/**
* Loads a memory block as a file.
* @param pH Memory block pointer
*/
void LoadFile(MEMHANDLE *pH) {
Common::File f;
char szFilename[sizeof(pH->szName) + 1];
if (pH->filesize & fCompressed) {
error("Compression handling has been removed");
}
// extract and zero terminate the filename
strncpy(szFilename, pH->szName, sizeof(pH->szName));
szFilename[sizeof(pH->szName)] = 0;
if (f.open(szFilename)) {
// read the data
int bytes;
uint8 *addr;
if (pH->filesize & fPreload)
// preload - no need to lock the memory
addr = pH->_ptr;
else {
// discardable - lock the memory
addr = (uint8 *)MemoryLock(pH->_node);
}
// make sure address is valid
assert(addr);
bytes = f.read(addr, pH->filesize & FSIZE_MASK);
// close the file
f.close();
if ((pH->filesize & fPreload) == 0) {
// discardable - unlock the memory
MemoryUnlock(pH->_node);
}
// set the loaded flag
pH->filesize |= fLoaded;
if (bytes == (pH->filesize & FSIZE_MASK)) {
return;
}
// file is corrupt
error(FILE_IS_CORRUPT, szFilename);
}
// cannot find file
error(CANNOT_FIND_FILE, szFilename);
}
/**
* Returns the address of a image, given its memory handle.
* @param offset Handle and offset to data
*/
byte *LockMem(SCNHANDLE offset) {
uint32 handle = offset >> SCNHANDLE_SHIFT; // calc memory handle to use
MEMHANDLE *pH; // points to table entry
// range check the memory handle
assert(handle < numHandles);
pH = handleTable + handle;
if (pH->filesize & fPreload) {
// permanent files are already loaded
return pH->_ptr + (offset & OFFSETMASK);
} else if (handle == cdPlayHandle) {
// Must be in currently loaded/loadable range
if (offset < cdBaseHandle || offset >= cdTopHandle)
error("Overlapping (in time) CD-plays");
// may have been discarded, make sure memory is allocated
MemoryReAlloc(pH->_node, cdTopHandle - cdBaseHandle);
if (!(pH->filesize & fLoaded)) {
LoadCDGraphData(pH);
// update the LRU time (new in this file)
MemoryTouch(pH->_node);
}
return MemoryDeref(pH->_node) + ((offset - cdBaseHandle) & OFFSETMASK);
} else {
// may have been discarded, make sure memory is allocated
MemoryReAlloc(pH->_node, pH->filesize & FSIZE_MASK);
if (!(pH->filesize & fLoaded)) {
if (TinselV2) {
SetCD(pH->flags2 & fAllCds);
CdCD(nullContext);
}
LoadFile(pH);
// make sure address is valid
assert(pH->filesize & fLoaded);
}
return MemoryDeref(pH->_node) + (offset & OFFSETMASK);
}
}
/**
* Called to lock the current scene and make it non-discardable.
* @param offset Handle and offset to data
*/
void LockScene(SCNHANDLE offset) {
uint32 handle = offset >> SCNHANDLE_SHIFT; // calc memory handle to use
MEMHANDLE *pH; // points to table entry
#ifdef DEBUG
assert(!bLockedScene); // Trying to lock more than one scene
#endif
// range check the memory handle
assert(handle < numHandles);
pH = handleTable + handle;
// compact the heap to avoid fragmentation while scene is non-discardable
HeapCompact(MAX_INT, false);
if ((pH->filesize & fPreload) == 0) {
// Ensure the scene handle is allocated.
MemoryReAlloc(pH->_node, pH->filesize & FSIZE_MASK);
// Now lock it to make sure it stays allocated and in a fixed position.
MemoryLock(pH->_node);
#ifdef DEBUG
bLockedScene = true;
#endif
}
}
/**
* Called to make the current scene discardable again.
* @param offset Handle and offset to data
*/
void UnlockScene(SCNHANDLE offset) {
uint32 handle = offset >> SCNHANDLE_SHIFT; // calc memory handle to use
MEMHANDLE *pH; // points to table entry
// range check the memory handle
assert(handle < numHandles);
pH = handleTable + handle;
if ((pH->filesize & fPreload) == 0) {
// unlock the scene data
MemoryUnlock(pH->_node);
#ifdef DEBUG
bLockedScene = false;
#endif
}
}
/*----------------------------------------------------------------------*/
#ifdef BODGE
/**
* Validates that a specified handle pointer is valid
* @param offset Handle and offset to data
*/
bool ValidHandle(SCNHANDLE offset) {
uint32 handle = offset >> SCNHANDLE_SHIFT; // calc memory handle to use
MEMHANDLE *pH; // points to table entry
// range check the memory handle
assert(handle < numHandles);
pH = handleTable + handle;
return (pH->filesize & FSIZE_MASK) != 8;
}
#endif
/**
* TouchMem
* @param offset Handle and offset to data
*/
void TouchMem(SCNHANDLE offset) {
MEMHANDLE *pH; // points to table entry
uint32 handle = offset >> SCNHANDLE_SHIFT; // calc memory handle to use
if (offset != 0) {
pH = handleTable + handle;
// update the LRU time whether its loaded or not!
if (pH->_node)
MemoryTouch(pH->_node);
}
}
/**
* Returns true if the given handle is into the cd graph data
* @param offset Handle and offset to data
*/
bool IsCdPlayHandle(SCNHANDLE offset) {
uint32 handle = offset >> SCNHANDLE_SHIFT; // calc memory handle to use
// range check the memory handle
assert(handle < numHandles);
return (handle == cdPlayHandle);
}
/**
* Returns the CD for a given scene handle
*/
int CdNumber(SCNHANDLE offset) {
uint handle = offset >> SCNHANDLE_SHIFT; // calc memory handle to use
// range check the memory handle
assert(handle < numHandles);
MEMHANDLE *pH = handleTable + handle;
if (!TinselV2)
return 1;
return GetCD(pH->flags2 & fAllCds);
}
} // End of namespace Tinsel
|