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
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
|
/* 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$
*
*/
#include "sci/engine/seg_manager.h"
#include "sci/engine/state.h"
#include "sci/engine/intmap.h"
namespace Sci {
#define DEFAULT_SCRIPTS 32
#define DEFAULT_OBJECTS 8 // default # of objects per script
#define DEFAULT_OBJECTS_INCREMENT 4 // Number of additional objects to instantiate if we're running out of them
//#define GC_DEBUG // Debug garbage collection
//#define GC_DEBUG_VERBOSE // Debug garbage verbosely
#undef DEBUG_SEG_MANAGER // Define to turn on debugging
#define GET_SEGID() \
if (flag == SCRIPT_ID) \
id = segGet(id); \
VERIFY(check(id), "invalid seg id");
#if 0
// Unreferenced - removed
#define VERIFY_MEM(mem_ptr, ret) \
if (!(mem_ptr)) {\
sciprintf( "%s, *d, no enough memory", __FILE__, __LINE__ ); \
return ret; \
}
#endif
#define INVALID_SCRIPT_ID -1
inline int SegManager::findFreeId(int *id) {
bool was_added = false;
int retval = 0;
while (!was_added) {
retval = id_seg_map->checkKey(reserved_id, true, &was_added);
*id = reserved_id--;
if (reserved_id < -1000000)
reserved_id = -10;
// Make sure we don't underflow
}
return retval;
}
MemObject *SegManager::allocNonscriptSegment(memObjType type, SegmentId *segid) {
// Allocates a non-script segment
int id;
*segid = findFreeId(&id);
return memObjAllocate(*segid, id, type);
}
SegManager::SegManager(bool sci1_1) {
int i;
// Initialise memory count
mem_allocated = 0;
id_seg_map = new IntMapper();
reserved_id = INVALID_SCRIPT_ID;
id_seg_map->checkKey(reserved_id, true); // reserve 0 for seg_id
reserved_id--; // reserved_id runs in the reversed direction to make sure no one will use it.
heap_size = DEFAULT_SCRIPTS;
heap = (MemObject **)sci_calloc(heap_size, sizeof(MemObject *));
Clones_seg_id = 0;
Lists_seg_id = 0;
Nodes_seg_id = 0;
Hunks_seg_id = 0;
exports_wide = 0;
isSci1_1 = sci1_1;
// initialize the heap pointers
for (i = 0; i < heap_size; i++) {
heap[i] = NULL;
}
// gc initialisation
gc_mark_bits = 0;
}
// Destroy the object, free the memorys if allocated before
SegManager::~SegManager() {
int i;
// Free memory
for (i = 0; i < heap_size; i++) {
if (heap[i])
deallocate(i, false);
}
delete id_seg_map;
free(heap);
}
// allocate a memory for script from heap
// Parameters: (EngineState *) s: The state to operate on
// (int) script_nr: The script number to load
// Returns : 0 - allocation failure
// 1 - allocated successfully
// seg_id - allocated segment id
MemObject *SegManager::allocateScript(EngineState *s, int script_nr, int* seg_id) {
int seg;
bool was_added;
MemObject* mem;
seg = id_seg_map->checkKey(script_nr, true, &was_added);
if (!was_added) {
*seg_id = seg;
return heap[*seg_id];
}
// allocate the MemObject
mem = memObjAllocate(seg, script_nr, MEM_OBJ_SCRIPT);
if (!mem) {
sciprintf("%s, %d, Not enough memory, ", __FILE__, __LINE__);
return NULL;
}
*seg_id = seg;
return mem;
}
void SegManager::setScriptSize(MemObject *mem, EngineState *s, int script_nr) {
resource_t *script = scir_find_resource(s->resmgr, sci_script, script_nr, 0);
resource_t *heap = scir_find_resource(s->resmgr, sci_heap, script_nr, 0);
mem->data.script.script_size = script->size;
mem->data.script.heap_size = 0; // Set later
if (!script || (s->version >= SCI_VERSION(1, 001, 000) && !heap)) {
sciprintf("%s: failed to load %s\n", __FUNCTION__, !script ? "script" : "heap");
return;
}
if (s->version < SCI_VERSION_FTU_NEW_SCRIPT_HEADER) {
mem->data.script.buf_size = script->size + getUInt16(script->data) * 2;
//locals_size = getUInt16(script->data) * 2;
} else if (s->version < SCI_VERSION(1, 001, 000)) {
mem->data.script.buf_size = script->size;
} else {
mem->data.script.buf_size = script->size + heap->size;
mem->data.script.heap_size = heap->size;
// Ensure that the start of the heap resource can be word-aligned.
if (script->size & 2) {
mem->data.script.buf_size++;
mem->data.script.script_size++;
}
if (mem->data.script.buf_size > 65535) {
sciprintf("Script and heap sizes combined exceed 64K.\n"
"This means a fundamental design bug was made in FreeSCI\n"
"regarding SCI1.1 games.\nPlease report this so it can be"
"fixed in the next major version!\n");
return;
}
}
}
int SegManager::initialiseScript(MemObject *mem, EngineState *s, int script_nr) {
// allocate the script.buf
Script *scr;
setScriptSize(mem, s, script_nr);
mem->data.script.buf = (byte*) sci_malloc(mem->data.script.buf_size);
dbgPrint("mem->data.script.buf ", mem->data.script.buf);
if (!mem->data.script.buf) {
freeScript(mem);
sciprintf("SegManager: Not enough memory space for script size");
mem->data.script.buf_size = 0;
return 0;
}
// Initialize objects
scr = &(mem->data.script);
scr->objects = NULL;
scr->objects_allocated = 0;
scr->objects_nr = 0; // No objects recorded yet
scr->locals_offset = 0;
scr->locals_block = NULL;
scr->code = NULL;
scr->code_blocks_nr = 0;
scr->code_blocks_allocated = 0;
scr->nr = script_nr;
scr->marked_as_deleted = 0;
scr->relocated = 0;
scr->obj_indices = new IntMapper();
if (s->version >= SCI_VERSION(1, 001, 000))
scr->heap_start = scr->buf + scr->script_size;
else
scr->heap_start = scr->buf;
return 1;
}
int SegManager::deallocate(int seg, bool recursive) {
MemObject *mobj;
VERIFY(check(seg), "invalid seg id");
int i;
mobj = heap[seg];
id_seg_map->removeKey(mobj->segmgr_id);
switch (mobj->type) {
case MEM_OBJ_SCRIPT:
freeScript(mobj);
mobj->data.script.buf = NULL;
if (recursive && mobj->data.script.locals_segment)
deallocate(mobj->data.script.locals_segment, recursive);
break;
case MEM_OBJ_LOCALS:
free(mobj->data.locals.locals);
mobj->data.locals.locals = NULL;
break;
case MEM_OBJ_DYNMEM:
free(mobj->data.dynmem.description);
mobj->data.dynmem.description = NULL;
free(mobj->data.dynmem.buf);
mobj->data.dynmem.buf = NULL;
break;
case MEM_OBJ_SYS_STRINGS:
for (i = 0; i < SYS_STRINGS_MAX; i++) {
SystemString *str = &mobj->data.sys_strings.strings[i];
if (str->name) {
free(str->name);
str->name = NULL;
free(str->value);
str->value = NULL;
str->max_size = 0;
}
}
break;
case MEM_OBJ_STACK:
free(mobj->data.stack.entries);
mobj->data.stack.entries = NULL;
break;
case MEM_OBJ_LISTS:
free(mobj->data.lists.table);
mobj->data.lists.table = NULL;
mobj->data.lists.entries_nr = mobj->data.lists.max_entry = 0;
break;
case MEM_OBJ_NODES:
free(mobj->data.nodes.table);
mobj->data.nodes.table = NULL;
mobj->data.nodes.entries_nr = mobj->data.nodes.max_entry = 0;
break;
case MEM_OBJ_CLONES:
free(mobj->data.clones.table);
mobj->data.clones.table = NULL;
mobj->data.clones.entries_nr = mobj->data.clones.max_entry = 0;
break;
case MEM_OBJ_HUNK:
free(mobj->data.hunks.table);
mobj->data.hunks.table = NULL;
mobj->data.hunks.entries_nr = mobj->data.hunks.max_entry = 0;
break;
case MEM_OBJ_RESERVED:
free(mobj->data.reserved);
break;
default:
fprintf(stderr, "Deallocating segment type %d not supported!\n",
mobj->type);
BREAKPOINT();
}
free(mobj);
heap[seg] = NULL;
return 1;
}
int SegManager::scriptMarkedDeleted(int script_nr) {
Script *scr;
int seg = segGet(script_nr);
VERIFY(check(seg), "invalid seg id");
scr = &(heap[seg]->data.script);
return scr->marked_as_deleted;
}
void SegManager::markScriptDeleted(int script_nr) {
Script *scr;
int seg = segGet(script_nr);
VERIFY(check(seg), "invalid seg id");
scr = &(heap[seg]->data.script);
scr->marked_as_deleted = 1;
}
void SegManager::unmarkScriptDeleted(int script_nr) {
Script *scr;
int seg = segGet(script_nr);
VERIFY(check(seg), "invalid seg id");
scr = &(heap[seg]->data.script);
scr->marked_as_deleted = 0;
}
int SegManager::scriptIsMarkedAsDeleted(SegmentId seg) {
Script *scr;
if (!check(seg))
return 0;
if (heap[seg]->type != MEM_OBJ_SCRIPT)
return 0;
scr = &(heap[seg]->data.script);
return scr->marked_as_deleted;
}
int SegManager::deallocateScript(int script_nr) {
int seg = segGet(script_nr);
deallocate(seg, true);
return 1;
}
MemObject *SegManager::memObjAllocate(SegmentId segid, int hash_id, memObjType type) {
MemObject *mem = (MemObject *)sci_calloc(sizeof(MemObject), 1);
if (!mem) {
sciprintf("SegManager: invalid mem_obj ");
return NULL;
}
if (segid >= heap_size) {
void *temp;
int oldhs = heap_size;
if (segid >= heap_size * 2) {
sciprintf("SegManager: hash_map error or others??");
return NULL;
}
heap_size *= 2;
temp = sci_realloc((void *)heap, heap_size * sizeof(MemObject *));
if (!temp) {
sciprintf("SegManager: Not enough memory space for script size");
return NULL;
}
heap = (MemObject **)temp;
// Clear pointers
memset(heap + oldhs, 0, sizeof(MemObject *) * (heap_size - oldhs));
}
mem->segmgr_id = hash_id;
mem->type = type;
// hook it to the heap
heap[segid] = mem;
return mem;
}
/* No longer in use?
void SegManager::sm_object_init(Object *object) {
if (!object)
return;
object->variables_nr = 0;
object->variables = NULL;
};*/
void SegManager::freeScript(MemObject *mem) {
if (!mem)
return;
if (mem->data.script.buf) {
free(mem->data.script.buf);
mem->data.script.buf = NULL;
mem->data.script.buf_size = 0;
}
if (mem->data.script.objects) {
int i;
for (i = 0; i < mem->data.script.objects_nr; i++) {
Object* object = &mem->data.script.objects[i];
if (object->variables) {
free(object->variables);
object->variables = NULL;
object->variables_nr = 0;
}
}
free(mem->data.script.objects);
mem->data.script.objects = NULL;
mem->data.script.objects_nr = 0;
}
delete mem->data.script.obj_indices;
free(mem->data.script.code);
}
// memory operations
#if 0
// Unreferenced - removed
static void SegManager::sm_mset(int offset, int c, size_t n, int id, int flag) {
MemObject *mem_obj;
GET_SEGID();
mem_obj = heap[id];
switch (mem_obj->type) {
case MEM_OBJ_SCRIPT:
if (mem_obj->data.script.buf) {
memset(mem_obj->data.script.buf + offset, c, n);
}
break;
case MEM_OBJ_CLONES:
sciprintf("memset for clones haven't been implemented\n");
break;
default:
sciprintf("unknown mem obj type\n");
break;
}
}
#endif
#if 0
// Unreferenced - removed
static void SegManager::sm_mcpy_in_in(int dst, const int src, size_t n, int id, int flag) {
MemObject *mem_obj;
GET_SEGID();
mem_obj = heap[id];
switch (mem_obj->type) {
case MEM_OBJ_SCRIPT:
if (mem_obj->data.script.buf) {
memcpy(mem_obj->data.script.buf + dst, mem_obj->data.script.buf + src, n);
}
break;
case MEM_OBJ_CLONES:
sciprintf("memcpy for clones haven't been implemented\n");
break;
default:
sciprintf("unknown mem obj type\n");
break;
}
}
#endif
void SegManager::mcpyInOut(int dst, const void *src, size_t n, int id, int flag) {
MemObject *mem_obj;
GET_SEGID();
mem_obj = heap[id];
switch (mem_obj->type) {
case MEM_OBJ_SCRIPT:
if (mem_obj->data.script.buf) {
memcpy(mem_obj->data.script.buf + dst, src, n);
}
break;
case MEM_OBJ_CLONES:
sciprintf("memcpy for clones hasn't been implemented yet\n");
break;
default:
sciprintf("unknown mem obj type\n");
break;
}
}
#if 0
// Unreferenced - removed
static void SegManager::sm_mcpy_out_in(void *dst, const int src, size_t n, int id, int flag) {
MemObject *mem_obj;
GET_SEGID();
mem_obj = heap[id];
switch (mem_obj->type) {
case MEM_OBJ_SCRIPT:
if (mem_obj->data.script.buf) {
memcpy(dst, mem_obj->data.script.buf + src, n);
}
break;
case MEM_OBJ_CLONES:
sciprintf("memcpy for clones hasn't been implemented yet\n");
break;
default:
sciprintf("unknown mem obj type\n");
break;
}
}
#endif
int16 SegManager::getHeap(reg_t reg) {
MemObject *mem_obj;
memObjType mem_type;
VERIFY(check(reg.segment), "Invalid seg id");
mem_obj = heap[reg.segment];
mem_type = mem_obj->type;
switch (mem_type) {
case MEM_OBJ_SCRIPT:
VERIFY(reg.offset + 1 < (uint16)mem_obj->data.script.buf_size, "invalid offset\n");
return (mem_obj->data.script.buf[reg.offset] | (mem_obj->data.script.buf[reg.offset+1]) << 8);
case MEM_OBJ_CLONES:
sciprintf("memcpy for clones hasn't been implemented yet\n");
break;
default:
sciprintf("unknown mem obj type\n");
break;
}
return 0; // never get here
}
#if 0
// Unreferenced - removed
void SegManager::sm_put_heap(reg_t reg, int16 value) {
MemObject *mem_obj;
memObjType mem_type;
VERIFY(check(reg.segment), "Invalid seg id");
mem_obj = heap[reg.segment];
mem_type = mem_obj->type;
switch (mem_type) {
case MEM_OBJ_SCRIPT:
VERIFY(reg.offset + 1 < (uint16)mem_obj->data.script.buf_size, "invalid offset");
mem_obj->data.script.buf[reg.offset] = value & 0xff;
mem_obj->data.script.buf[reg.offset + 1] = value >> 8;
break;
case MEM_OBJ_CLONES:
sciprintf("memcpy for clones haven't been implemented\n");
break;
default:
sciprintf("unknown mem obj type\n");
break;
}
}
#endif
// return the seg if script_id is valid and in the map, else -1
int SegManager::segGet(int script_id) {
return id_seg_map->checkKey(script_id, false);
}
// validate the seg
// return:
// false - invalid seg
// true - valid seg
bool SegManager::check(int seg) {
if (seg < 0 || seg >= heap_size) {
return false;
}
if (!heap[seg]) {
sciprintf("SegManager: seg %x is removed from memory, but not removed from hash_map\n", seg);
return false;
}
return true;
}
int SegManager::scriptIsLoaded(int id, idFlag flag) {
if (flag == SCRIPT_ID)
id = segGet(id);
return check(id);
}
void SegManager::incrementLockers(int id, idFlag flag) {
if (flag == SCRIPT_ID)
id = segGet(id);
VERIFY(check(id), "invalid seg id");
heap[id]->data.script.lockers++;
}
void SegManager::decrementLockers(int id, idFlag flag) {
if (flag == SCRIPT_ID)
id = segGet(id);
VERIFY(check(id), "invalid seg id");
if (heap[id]->data.script.lockers > 0)
heap[id]->data.script.lockers--;
}
int SegManager::getLockers(int id, idFlag flag) {
if (flag == SCRIPT_ID)
id = segGet(id);
VERIFY(check(id), "invalid seg id");
return heap[id]->data.script.lockers;
}
void SegManager::setLockers(int lockers, int id, idFlag flag) {
if (flag == SCRIPT_ID)
id = segGet(id);
VERIFY(check(id), "invalid seg id");
heap[id]->data.script.lockers = lockers;
}
void SegManager::setExportTableOffset(int offset, int id, idFlag flag) {
Script *scr = &(heap[id]->data.script);
GET_SEGID();
if (offset) {
scr->export_table = (uint16 *)(scr->buf + offset + 2);
scr->exports_nr = getUInt16((byte *)(scr->export_table - 1));
} else {
scr->export_table = NULL;
scr->exports_nr = 0;
}
}
#if 0
// Unreferenced - removed
int SegManager::sm_hash_segment_data(int id) {
int i, len, hash_code = 0x55555555;
char *buf;
if (heap[id]->type == MEM_OBJ_LISTS)
return 0;
if (heap[id]->type == MEM_OBJ_NODES)
return 0;
if (heap[id]->type == MEM_OBJ_CLONES)
return 0;
buf = (char *)dereference(make_reg(id, 0), &len);
for (i = 0; i < len; i++)
hash_code = (hash_code * 19) + *(buf + i);
return hash_code;
}
#endif
void SegManager::setExportWidth(int flag) {
exports_wide = flag;
}
#if 0
// Unreferenced - removed
static uint16 *SegManager::sm_get_export_table_offset(int id, int flag, int *max) {
GET_SEGID();
if (max)
*max = heap[id]->data.script.exports_nr;
return heap[id]->data.script.export_table;
}
#endif
void SegManager::setSynonymsOffset(int offset, int id, idFlag flag) {
GET_SEGID();
heap[id]->data.script.synonyms = heap[id]->data.script.buf + offset;
}
byte *SegManager::getSynonyms(int id, idFlag flag) {
GET_SEGID();
return heap[id]->data.script.synonyms;
}
void SegManager::setSynonymsNr(int nr, int id, idFlag flag) {
GET_SEGID();
heap[id]->data.script.synonyms_nr = nr;
}
int SegManager::getSynonymsNr(int id, idFlag flag) {
GET_SEGID();
return heap[id]->data.script.synonyms_nr;
}
#if 0
// Unreferenced - removed
static int SegManager::sm_get_heappos(int id, int flag) {
GET_SEGID();
return 0;
}
#endif
#if 0
// Unreferenced - removed
static void SegManager::sm_set_variables(reg_t reg, int obj_index, reg_t variable_reg, int variable_index) {
Script *script;
VERIFY(check(reg.segment), "invalid seg id");
VERIFY(heap[reg.segment], "invalid mem");
script = &(heap[reg.segment]->data.script);
VERIFY(obj_index < script->objects_nr, "Invalid obj_index");
VERIFY(variable_index >= 0 && variable_index < script->objects[obj_index].variables_nr, "Attempt to write to invalid variable number");
script->objects[obj_index].variables[variable_index] = variable_reg;
}
#endif
inline int SegManager::relocateBlock(reg_t *block, int block_location, int block_items, SegmentId segment, int location) {
int rel = location - block_location;
int index;
if (rel < 0)
return 0;
index = rel >> 1;
if (index >= block_items)
return 0;
if (rel & 1) {
sciprintf("Error: Attempt to relocate odd variable #%d.5e (relative to %04x)\n", index, block_location);
return 0;
}
block[index].segment = segment; // Perform relocation
if (isSci1_1)
block[index].offset += heap[segment]->data.script.script_size;
return 1;
}
inline int SegManager::relocateLocal(Script *scr, SegmentId segment, int location) {
if (scr->locals_block)
return relocateBlock(scr->locals_block->locals, scr->locals_offset, scr->locals_block->nr, segment, location);
else
return 0; // No hands, no cookies
}
inline int SegManager::relocateObject(Object *obj, SegmentId segment, int location) {
return relocateBlock(obj->variables, obj->pos.offset, obj->variables_nr, segment, location);
}
void SegManager::scriptAddCodeBlock(reg_t location) {
MemObject *mobj = heap[location.segment];
Script *scr;
int index;
VERIFY(!(location.segment >= heap_size || mobj->type != MEM_OBJ_SCRIPT), "Attempt to add a code block to non-script\n");
scr = &(mobj->data.script);
if (++scr->code_blocks_nr > scr->code_blocks_allocated) {
scr->code_blocks_allocated += DEFAULT_OBJECTS_INCREMENT;
scr->code = (CodeBlock *)sci_realloc(scr->code, scr->code_blocks_allocated * sizeof(CodeBlock));
}
index = scr->code_blocks_nr - 1;
scr->code[index].pos = location;
scr->code[index].size = getUInt16(scr->buf + location.offset - 2);
}
void SegManager::scriptRelocate(reg_t block) {
MemObject *mobj = heap[block.segment];
Script *scr;
int count;
int i;
VERIFY(!(block.segment >= heap_size || mobj->type != MEM_OBJ_SCRIPT), "Attempt relocate non-script\n");
scr = &(mobj->data.script);
VERIFY(block.offset < (uint16)scr->buf_size && getUInt16(scr->buf + block.offset) * 2 + block.offset < (uint16)scr->buf_size,
"Relocation block outside of script\n");
count = getUInt16(scr->buf + block.offset);
for (i = 0; i <= count; i++) {
int pos = getUInt16(scr->buf + block.offset + 2 + (i * 2));
if (!pos)
continue; // FIXME: A hack pending investigation
if (!relocateLocal(scr, block.segment, pos)) {
int k, done = 0;
for (k = 0; !done && k < scr->objects_nr; k++) {
if (relocateObject(scr->objects + k, block.segment, pos))
done = 1;
}
for (k = 0; !done && k < scr->code_blocks_nr; k++) {
if (pos >= scr->code[k].pos.offset &&
pos < scr->code[k].pos.offset + scr->code[k].size)
done = 1;
}
if (!done) {
sciprintf("While processing relocation block "PREG":\n", PRINT_REG(block));
sciprintf("Relocation failed for index %04x (%d/%d)\n", pos, i + 1, count);
if (scr->locals_block)
sciprintf("- locals: %d at %04x\n", scr->locals_block->nr, scr->locals_offset);
else
sciprintf("- No locals\n");
for (k = 0; k < scr->objects_nr; k++)
sciprintf("- obj#%d at %04x w/ %d vars\n", k, scr->objects[k].pos.offset, scr->objects[k].variables_nr);
// SQ3 script 71 has broken relocation entries.
// Since this is mainstream, we can't break out as we used to do.
sciprintf("Trying to continue anyway...\n");
// BREAKPOINT();
}
}
}
}
void SegManager::heapRelocate(EngineState *s, reg_t block) {
MemObject *mobj = heap[block.segment];
Script *scr;
int count;
int i;
VERIFY(!(block.segment >= heap_size || mobj->type != MEM_OBJ_SCRIPT), "Attempt relocate non-script\n");
scr = &(mobj->data.script);
VERIFY(block.offset < (uint16)scr->heap_size && getUInt16(scr->heap_start + block.offset) * 2 + block.offset < (uint16)scr->buf_size,
"Relocation block outside of script\n");
if (scr->relocated)
return;
scr->relocated = 1;
count = getUInt16(scr->heap_start + block.offset);
for (i = 0; i < count; i++) {
int pos = getUInt16(scr->heap_start + block.offset + 2 + (i * 2)) + scr->script_size;
if (!relocateLocal(scr, block.segment, pos)) {
int k, done = 0;
for (k = 0; !done && k < scr->objects_nr; k++) {
if (relocateObject(scr->objects + k, block.segment, pos))
done = 1;
}
if (!done) {
sciprintf("While processing relocation block "PREG":\n", PRINT_REG(block));
sciprintf("Relocation failed for index %04x (%d/%d)\n", pos, i + 1, count);
if (scr->locals_block)
sciprintf("- locals: %d at %04x\n", scr->locals_block->nr, scr->locals_offset);
else
sciprintf("- No locals\n");
for (k = 0; k < scr->objects_nr; k++)
sciprintf("- obj#%d at %04x w/ %d vars\n", k, scr->objects[k].pos.offset, scr->objects[k].variables_nr);
sciprintf("Triggering breakpoint...\n");
BREAKPOINT();
}
}
}
}
#define INST_LOOKUP_CLASS(id) ((id == 0xffff) ? NULL_REG : get_class_address(s, id, SCRIPT_GET_LOCK, NULL_REG))
reg_t get_class_address(EngineState *s, int classnr, int lock, reg_t caller);
Object *SegManager::scriptObjInit0(EngineState *s, reg_t obj_pos) {
MemObject *mobj = heap[obj_pos.segment];
Script *scr;
Object *obj;
int id;
unsigned int base = obj_pos.offset - SCRIPT_OBJECT_MAGIC_OFFSET;
reg_t temp;
VERIFY(!(obj_pos.segment >= heap_size || mobj->type != MEM_OBJ_SCRIPT), "Attempt to initialize object in non-script\n");
scr = &(mobj->data.script);
VERIFY(base < scr->buf_size, "Attempt to initialize object beyond end of script\n");
if (!scr->objects) {
scr->objects_allocated = DEFAULT_OBJECTS;
scr->objects = (Object *)sci_malloc(sizeof(Object) * scr->objects_allocated);
}
if (scr->objects_nr == scr->objects_allocated) {
scr->objects_allocated += DEFAULT_OBJECTS_INCREMENT;
scr->objects = (Object *)sci_realloc(scr->objects, sizeof(Object) * scr->objects_allocated);
}
temp = make_reg(obj_pos.segment, base);
id = scr->obj_indices->checkKey(base, true);
scr->objects_nr++;
obj = scr->objects + id;
VERIFY(base + SCRIPT_FUNCTAREAPTR_OFFSET < scr->buf_size, "Function area pointer stored beyond end of script\n");
{
byte *data = (byte *)(scr->buf + base);
int funct_area = getUInt16(data + SCRIPT_FUNCTAREAPTR_OFFSET);
int variables_nr;
int functions_nr;
int is_class;
int i;
obj->flags = 0;
obj->pos = temp;
VERIFY(base + funct_area < scr->buf_size, "Function area pointer references beyond end of script");
variables_nr = getUInt16(data + SCRIPT_SELECTORCTR_OFFSET);
functions_nr = getUInt16(data + funct_area - 2);
is_class = getUInt16(data + SCRIPT_INFO_OFFSET) & SCRIPT_INFO_CLASS;
VERIFY(base + funct_area + functions_nr * 2
// add again for classes, since those also store selectors
+ (is_class ? functions_nr * 2 : 0) < scr->buf_size, "Function area extends beyond end of script");
obj->variables_nr = variables_nr;
obj->variables = (reg_t *)sci_malloc(sizeof(reg_t) * variables_nr);
obj->methods_nr = functions_nr;
obj->base = scr->buf;
obj->base_obj = data;
obj->base_method = (uint16 *)(data + funct_area);
obj->base_vars = NULL;
for (i = 0; i < variables_nr; i++)
obj->variables[i] = make_reg(0, getUInt16(data + (i * 2)));
}
return obj;
}
Object *SegManager::scriptObjInit11(EngineState *s, reg_t obj_pos) {
MemObject *mobj = heap[obj_pos.segment];
Script *scr;
Object *obj;
int id;
int base = obj_pos.offset;
VERIFY(!(obj_pos.segment >= heap_size || mobj->type != MEM_OBJ_SCRIPT), "Attempt to initialize object in non-script\n");
scr = &(mobj->data.script);
VERIFY(base < (uint16)scr->buf_size, "Attempt to initialize object beyond end of script\n");
if (!scr->objects) {
scr->objects_allocated = DEFAULT_OBJECTS;
scr->objects = (Object *)sci_malloc(sizeof(Object) * scr->objects_allocated);
}
if (scr->objects_nr == scr->objects_allocated) {
scr->objects_allocated += DEFAULT_OBJECTS_INCREMENT;
scr->objects = (Object *)sci_realloc(scr->objects, sizeof(Object) * scr->objects_allocated);
}
id = scr->obj_indices->checkKey(obj_pos.offset, true);
scr->objects_nr++;
obj = scr->objects + id;
VERIFY(base + SCRIPT_FUNCTAREAPTR_OFFSET < (uint16)scr->buf_size, "Function area pointer stored beyond end of script\n");
{
byte *data = (byte *)(scr->buf + base);
uint16 *funct_area = (uint16 *)(scr->buf + getUInt16(data + 6));
uint16 *prop_area = (uint16 *)(scr->buf + getUInt16(data + 4));
int variables_nr;
int functions_nr;
int is_class;
int i;
obj->flags = 0;
obj->pos = obj_pos;
VERIFY((byte *) funct_area < scr->buf + scr->buf_size, "Function area pointer references beyond end of script");
variables_nr = getUInt16(data + 2);
functions_nr = *funct_area;
is_class = getUInt16(data + 14) & SCRIPT_INFO_CLASS;
obj->base_method = funct_area;
obj->base_vars = prop_area;
VERIFY(((byte *) funct_area + functions_nr) < scr->buf + scr->buf_size, "Function area extends beyond end of script");
obj->variables_nr = variables_nr;
obj->variable_names_nr = variables_nr;
obj->variables = (reg_t *)sci_malloc(sizeof(reg_t) * variables_nr);
obj->methods_nr = functions_nr;
obj->base = scr->buf;
obj->base_obj = data;
for (i = 0; i < variables_nr; i++)
obj->variables[i] = make_reg(0, getUInt16(data + (i * 2)));
}
return obj;
}
Object *SegManager::scriptObjInit(EngineState *s, reg_t obj_pos) {
if (!isSci1_1)
return scriptObjInit0(s, obj_pos);
else
return scriptObjInit11(s, obj_pos);
}
LocalVariables *SegManager::allocLocalsSegment(Script *scr, int count) {
if (!count) { // No locals
scr->locals_segment = 0;
scr->locals_block = NULL;
return NULL;
} else {
MemObject *mobj;
LocalVariables *locals;
if (scr->locals_segment) {
mobj = heap[scr->locals_segment];
VERIFY(mobj != NULL, "Re-used locals segment was NULL'd out");
VERIFY(mobj->type == MEM_OBJ_LOCALS, "Re-used locals segment did not consist of local variables");
VERIFY(mobj->data.locals.script_id == scr->nr, "Re-used locals segment belonged to other script");
} else
mobj = allocNonscriptSegment(MEM_OBJ_LOCALS, &scr->locals_segment);
locals = scr->locals_block = &(mobj->data.locals);
locals->script_id = scr->nr;
locals->locals = (reg_t *)sci_calloc(count, sizeof(reg_t));
locals->nr = count;
return locals;
}
}
void SegManager::scriptInitialiseLocalsZero(SegmentId seg, int count) {
MemObject *mobj = heap[seg];
Script *scr;
VERIFY(!(seg >= heap_size || mobj->type != MEM_OBJ_SCRIPT), "Attempt to initialize locals in non-script\n");
scr = &(mobj->data.script);
scr->locals_offset = -count * 2; // Make sure it's invalid
allocLocalsSegment(scr, count);
}
void SegManager::scriptInitialiseLocals(reg_t location) {
MemObject *mobj = heap[location.segment];
unsigned int count;
Script *scr;
LocalVariables *locals;
VERIFY(!(location.segment >= heap_size || mobj->type != MEM_OBJ_SCRIPT), "Attempt to initialize locals in non-script\n");
scr = &(mobj->data.script);
VERIFY(location.offset + 1 < (uint16)scr->buf_size, "Locals beyond end of script\n");
if (isSci1_1)
count = getUInt16(scr->buf + location.offset - 2);
else
count = (getUInt16(scr->buf + location.offset - 2) - 4) >> 1;
// half block size
scr->locals_offset = location.offset;
if (!(location.offset + count * 2 + 1 < scr->buf_size)) {
sciprintf("Locals extend beyond end of script: offset %04x, count %x vs size %x\n", location.offset, count, (uint)scr->buf_size);
count = (scr->buf_size - location.offset) >> 1;
}
locals = allocLocalsSegment(scr, count);
if (locals) {
uint i;
byte *base = (byte *)(scr->buf + location.offset);
for (i = 0; i < count; i++)
locals->locals[i].offset = getUInt16(base + i * 2);
}
}
void SegManager::scriptRelocateExportsSci11(int seg) {
MemObject *mobj = heap[seg];
Script *scr;
int i;
int location;
VERIFY(!(seg >= heap_size || mobj->type != MEM_OBJ_SCRIPT), "Attempt to relocate exports in non-script\n");
scr = &(mobj->data.script);
for (i = 0; i < scr->exports_nr; i++) {
/* We are forced to use an ugly heuristic here to distinguish function
exports from object/class exports. The former kind points into the
script resource, the latter into the heap resource. */
location = getUInt16((byte *)(scr->export_table + i));
if (getUInt16(scr->heap_start + location) == SCRIPT_OBJECT_MAGIC_NUMBER) {
putInt16((byte *)(scr->export_table + i), location + scr->heap_start - scr->buf);
} else {
// Otherwise it's probably a function export,
// and we don't need to do anything.
}
}
}
void SegManager::scriptInitialiseObjectsSci11(EngineState *s, int seg) {
MemObject *mobj = heap[seg];
Script *scr;
byte *seeker;
VERIFY(!(seg >= heap_size || mobj->type != MEM_OBJ_SCRIPT), "Attempt to relocate exports in non-script\n");
scr = &(mobj->data.script);
seeker = scr->heap_start + 4 + getUInt16(scr->heap_start + 2) * 2;
while (getUInt16(seeker) == SCRIPT_OBJECT_MAGIC_NUMBER) {
if (getUInt16(seeker + 14) & SCRIPT_INFO_CLASS) {
int classpos = seeker - scr->buf;
int species = getUInt16(seeker + 10);
if (species < 0 || species >= s->classtable_size) {
sciprintf("Invalid species %d(0x%x) not in interval [0,%d) while instantiating script %d\n",
species, species, s->classtable_size, scr->nr);
script_debug_flag = script_error_flag = 1;
return;
}
s->classtable[species].script = scr->nr;
s->classtable[species].reg.segment = seg;
s->classtable[species].reg.offset = classpos;
}
seeker += getUInt16(seeker + 2) * 2;
}
seeker = scr->heap_start + 4 + getUInt16(scr->heap_start + 2) * 2;
while (getUInt16(seeker) == SCRIPT_OBJECT_MAGIC_NUMBER) {
reg_t reg;
Object *obj;
reg.segment = seg;
reg.offset = seeker - scr->buf;
obj = scriptObjInit(s, reg);
#if 0
if (obj->variables[5].offset != 0xffff) {
obj->variables[5] = INST_LOOKUP_CLASS(obj->variables[5].offset);
base_obj = obj_get(s, obj->variables[5]);
obj->variable_names_nr = base_obj->variables_nr;
obj->base_obj = base_obj->base_obj;
}
#endif
// Copy base from species class, as we need its selector IDs
obj->variables[6] = INST_LOOKUP_CLASS(obj->variables[6].offset);
seeker += getUInt16(seeker + 2) * 2;
}
}
void SegManager::scriptFreeUnusedObjects(SegmentId seg) {
MemObject *mobj = heap[seg];
Script *scr;
VERIFY(!(seg >= heap_size || mobj->type != MEM_OBJ_SCRIPT), "Attempt to free unused objects in non-script\n");
scr = &(mobj->data.script);
if (scr->objects_allocated > scr->objects_nr) {
if (scr->objects_nr)
scr->objects = (Object *)sci_realloc(scr->objects, sizeof(Object) * scr->objects_nr);
else {
if (scr->objects_allocated)
free(scr->objects);
scr->objects = NULL;
}
scr->objects_allocated = scr->objects_nr;
}
}
/*
static inline char *SegManager::dynprintf(char *msg, ...) {
va_list argp;
char *buf = (char *)sci_malloc(strlen(msg) + 100);
va_start(argp, msg);
vsprintf(buf, msg, argp);
va_end(argp);
return buf;
}
*/
dstack_t *SegManager::allocateStack(int size, SegmentId *segid) {
MemObject *memobj = allocNonscriptSegment(MEM_OBJ_STACK, segid);
dstack_t *retval = &(memobj->data.stack);
retval->entries = (reg_t*)sci_calloc(size, sizeof(reg_t));
retval->nr = size;
return retval;
}
SystemStrings *SegManager::allocateSysStrings(SegmentId *segid) {
MemObject *memobj = allocNonscriptSegment(MEM_OBJ_SYS_STRINGS, segid);
SystemStrings *retval = &(memobj->data.sys_strings);
memset(retval, 0, sizeof(SystemString)*SYS_STRINGS_MAX);
return retval;
}
#if 0
// Unreferenced - removed
SegmentId SegManager::sm_allocate_reserved_segment(char *src_name) {
SegmentId segid;
MemObject *memobj = allocNonscriptSegment(MEM_OBJ_RESERVED, &segid);
char *name = sci_strdup(src_name);
memobj->data.reserved = name;
return segid;
}
#endif
uint16 SegManager::validateExportFunc(int pubfunct, int seg) {
Script* script;
uint16 offset;
VERIFY(check(seg), "invalid seg id");
VERIFY(heap[seg]->type == MEM_OBJ_SCRIPT, "Can only validate exports on scripts");
script = &heap[seg]->data.script;
if (script->exports_nr <= pubfunct) {
sciprintf("pubfunct is invalid");
return 0;
}
if (exports_wide)
pubfunct *= 2;
offset = getUInt16((byte *)(script->export_table + pubfunct));
VERIFY(offset < script->buf_size, "invalid export function pointer");
return offset;
}
void SegManager::free_hunk_entry(reg_t addr) {
free_Hunk(addr);
}
Hunk *SegManager::alloc_hunk_entry(const char *hunk_type, int size, reg_t *reg) {
Hunk *h = alloc_Hunk(reg);
if (!h)
return NULL;
h->mem = sci_malloc(size);
h->size = size;
h->type = hunk_type;
return h;
}
void _clone_cleanup(Clone *clone) {
if (clone->variables)
free(clone->variables); // Free the dynamically allocated memory part
}
void _hunk_cleanup(Hunk *hunk) {
if (hunk->mem)
free(hunk->mem);
}
DEFINE_HEAPENTRY(List, 8, 4)
DEFINE_HEAPENTRY(Node, 32, 16)
DEFINE_HEAPENTRY_WITH_CLEANUP(Clone, 16, 4, _clone_cleanup)
DEFINE_HEAPENTRY_WITH_CLEANUP(Hunk, 4, 4, _hunk_cleanup)
#define DEFINE_ALLOC_DEALLOC(TYPE, SEGTYPE, PLURAL) \
TYPE *SegManager::alloc_##TYPE(reg_t *addr) { \
MemObject *mobj; \
TYPE##Table *table; \
int offset; \
\
if (!TYPE##s_seg_id) { \
mobj = allocNonscriptSegment(SEGTYPE, &(TYPE##s_seg_id)); \
init_##TYPE##_table(&(mobj->data.PLURAL)); \
} else \
mobj = heap[TYPE##s_seg_id]; \
\
table = &(mobj->data.PLURAL); \
offset = Sci::alloc_##TYPE##_entry(table); \
\
*addr = make_reg(TYPE##s_seg_id, offset); \
return &(mobj->data.PLURAL.table[offset].entry); \
} \
\
void SegManager::free_##TYPE(reg_t addr) { \
MemObject *mobj = GET_SEGMENT(*this, addr.segment, SEGTYPE); \
\
if (!mobj) { \
sciprintf("Attempt to free " #TYPE " from address "PREG": Invalid segment type\n", PRINT_REG(addr)); \
return; \
} \
\
Sci::free_##TYPE##_entry(&(mobj->data.PLURAL), addr.offset); \
}
DEFINE_ALLOC_DEALLOC(Clone, MEM_OBJ_CLONES, clones)
DEFINE_ALLOC_DEALLOC(List, MEM_OBJ_LISTS, lists)
DEFINE_ALLOC_DEALLOC(Node, MEM_OBJ_NODES, nodes)
DEFINE_ALLOC_DEALLOC(Hunk, MEM_OBJ_HUNK, hunks)
byte *SegManager::dereference(reg_t pointer, int *size) {
MemObject *mobj;
byte *base = NULL;
int count;
if (!pointer.segment || (pointer.segment >= heap_size) || !heap[pointer.segment]) {
sciprintf("Error: Attempt to dereference invalid pointer "PREG"!\n",
PRINT_REG(pointer));
return NULL; /* Invalid */
}
mobj = heap[pointer.segment];
switch (mobj->type) {
case MEM_OBJ_SCRIPT:
if (pointer.offset > mobj->data.script.buf_size) {
sciprintf("Error: Attempt to dereference invalid pointer "PREG" into script segment (script size=%d)\n",
PRINT_REG(pointer), (uint)mobj->data.script.buf_size);
return NULL;
}
if (size)
*size = mobj->data.script.buf_size - pointer.offset;
return (byte *)(mobj->data.script.buf + pointer.offset);
break;
case MEM_OBJ_LOCALS:
count = mobj->data.locals.nr * sizeof(reg_t);
base = (byte *)mobj->data.locals.locals;
break;
case MEM_OBJ_STACK:
count = mobj->data.stack.nr * sizeof(reg_t);
base = (byte *)mobj->data.stack.entries;
break;
case MEM_OBJ_DYNMEM:
count = mobj->data.dynmem.size;
base = (byte *)mobj->data.dynmem.buf;
break;
case MEM_OBJ_SYS_STRINGS:
if (size)
*size = mobj->data.sys_strings.strings[pointer.offset].max_size;
if (pointer.offset < SYS_STRINGS_MAX && mobj->data.sys_strings.strings[pointer.offset].name)
return (byte *)(mobj->data.sys_strings.strings[pointer.offset].value);
else {
sciprintf("Error: Attempt to dereference invalid pointer "PREG"!\n",
PRINT_REG(pointer));
return NULL;
}
case MEM_OBJ_RESERVED:
sciprintf("Error: Trying to dereference pointer "PREG" to reserved segment `%s'!\n",
PRINT_REG(pointer),
mobj->data.reserved);
return NULL;
break;
default:
sciprintf("Error: Trying to dereference pointer "PREG" to inappropriate"
" segment!\n",
PRINT_REG(pointer));
return NULL;
}
if (size)
*size = count;
return
base + pointer.offset;
}
unsigned char *SegManager::allocDynmem(int size, const char *descr, reg_t *addr) {
SegmentId seg;
MemObject *mobj = allocNonscriptSegment(MEM_OBJ_DYNMEM, &seg);
*addr = make_reg(seg, 0);
mobj->data.dynmem.size = size;
if (size == 0)
mobj->data.dynmem.buf = NULL;
else
mobj->data.dynmem.buf = (byte*) sci_malloc(size);
mobj->data.dynmem.description = sci_strdup(descr);
return (unsigned char *)(mobj->data.dynmem.buf);
}
const char *SegManager::getDescription(reg_t addr) {
MemObject *mobj = heap[addr.segment];
if (addr.segment >= heap_size)
return "";
switch (mobj->type) {
case MEM_OBJ_DYNMEM:
return mobj->data.dynmem.description;
default:
return "";
}
}
int SegManager::freeDynmem(reg_t addr) {
if (addr.segment <= 0 || addr.segment >= heap_size || !heap[addr.segment] || heap[addr.segment]->type != MEM_OBJ_DYNMEM)
return 1; // error
deallocate(addr.segment, true);
return 0; // OK
}
void SegManager::dbgPrint(const char* msg, void *i) {
#ifdef DEBUG_SEG_MANAGER
char buf[1000];
sprintf(buf, "%s = [0x%x], dec:[%d]", msg, i, i);
perror(buf);
#endif
}
// ------------------- Segment interface ------------------
SegInterface::SegInterface(SegManager *segmgr, MemObject *mobj, SegmentId segId, memObjType typeId) :
_segmgr(segmgr), _mobj(mobj), _segId(segId), _typeId(typeId) {
VERIFY(_mobj->type == _typeId, "Invalid MemObject type");
}
reg_t SegInterface::findCanonicAddress(reg_t addr) {
return addr;
}
void SegInterface::freeAtAddress(reg_t sub_addr) {
}
void SegInterface::listAllDeallocatable(void *param, void (*note)(void *param, reg_t addr)) {
}
void SegInterface::listAllOutgoingReferences(EngineState *s, reg_t object, void *param, void (*note)(void *param, reg_t addr)) {
}
//-------------------- base --------------------
class SegInterfaceBase : public SegInterface {
protected:
SegInterfaceBase(SegManager *segmgr, MemObject *mobj, SegmentId segId, memObjType typeId) :
SegInterface(segmgr, mobj, segId, typeId) {}
public:
reg_t findCanonicAddress(reg_t addr);
void listAllDeallocatable(void *param, void (*note)(void *param, reg_t addr));
};
reg_t SegInterfaceBase::findCanonicAddress(reg_t addr) {
addr.offset = 0;
return addr;
}
void SegInterfaceBase::listAllDeallocatable(void *param, void (*note)(void *param, reg_t addr)) {
(*note)(param, make_reg(_segId, 0));
}
//-------------------- script --------------------
class SegInterfaceScript : public SegInterfaceBase {
public:
SegInterfaceScript(SegManager *segmgr, MemObject *mobj, SegmentId segId) :
SegInterfaceBase(segmgr, mobj, segId, MEM_OBJ_SCRIPT) {}
void freeAtAddress(reg_t addr);
void listAllOutgoingReferences(EngineState *s, reg_t addr, void *param, void (*note)(void *param, reg_t addr));
};
void SegInterfaceScript::freeAtAddress(reg_t addr) {
Script *script = &(_mobj->data.script);
/*
sciprintf("[GC] Freeing script "PREG"\n", PRINT_REG(addr));
if (script->locals_segment)
sciprintf("[GC] Freeing locals %04x:0000\n", script->locals_segment);
*/
if (script->marked_as_deleted)
_segmgr->deallocateScript(script->nr);
}
void SegInterfaceScript::listAllOutgoingReferences(EngineState *s, reg_t addr, void *param, void (*note)(void *param, reg_t addr)) {
Script *script = &(_mobj->data.script);
if (addr.offset <= script->buf_size && addr.offset >= -SCRIPT_OBJECT_MAGIC_OFFSET && RAW_IS_OBJECT(script->buf + addr.offset)) {
int idx = RAW_GET_CLASS_INDEX(script, addr);
if (idx >= 0 && idx < script->objects_nr) {
Object *obj = script->objects + idx;
int i;
// Note all local variables, if we have a local variable environment
if (script->locals_segment)
(*note)(param, make_reg(script->locals_segment, 0));
for (i = 0; i < obj->variables_nr; i++)
(*note)(param, obj->variables[i]);
} else {
fprintf(stderr, "Request for outgoing script-object reference at "PREG" yielded invalid index %d\n", PRINT_REG(addr), idx);
}
} else {
/* fprintf(stderr, "Unexpected request for outgoing script-object references at "PREG"\n", PRINT_REG(addr));*/
/* Happens e.g. when we're looking into strings */
}
}
#define LIST_ALL_DEALLOCATABLE(kind, kind_field) \
kind##Table * table = &(_mobj->data.kind_field); \
int i; \
\
for (i = 0; i < table->max_entry; i++) \
if (ENTRY_IS_VALID(table, i)) \
(*note) (param, make_reg(_segId, i));
//-------------------- clones --------------------
class SegInterfaceClones : public SegInterface {
public:
SegInterfaceClones(SegManager *segmgr, MemObject *mobj, SegmentId segId) :
SegInterface(segmgr, mobj, segId, MEM_OBJ_CLONES) {}
void freeAtAddress(reg_t addr);
void listAllDeallocatable(void *param, void (*note)(void *param, reg_t addr));
void listAllOutgoingReferences(EngineState *s, reg_t addr, void *param, void (*note)(void *param, reg_t addr));
};
void SegInterfaceClones::listAllDeallocatable(void *param, void (*note)(void *param, reg_t addr)) {
LIST_ALL_DEALLOCATABLE(Clone, clones);
}
void SegInterfaceClones::listAllOutgoingReferences(EngineState *s, reg_t addr, void *param, void (*note)(void *param, reg_t addr)) {
CloneTable *clone_table = &(_mobj->data.clones);
Clone *clone;
int i;
assert(addr.segment == _segId);
if (!(ENTRY_IS_VALID(clone_table, addr.offset))) {
fprintf(stderr, "Unexpected request for outgoing references from clone at "PREG"\n", PRINT_REG(addr));
// BREAKPOINT();
return;
}
clone = &(clone_table->table[addr.offset].entry);
// Emit all member variables (including references to the 'super' delegate)
for (i = 0; i < clone->variables_nr; i++)
(*note)(param, clone->variables[i]);
// Note that this also includes the 'base' object, which is part of the script and therefore also emits the locals.
(*note)(param, clone->pos);
//sciprintf("[GC] Reporting clone-pos "PREG"\n", PRINT_REG(clone->pos));
}
void SegInterfaceClones::freeAtAddress(reg_t addr) {
Object *victim_obj;
assert(addr.segment == _segId);
victim_obj = &(_mobj->data.clones.table[addr.offset].entry);
#ifdef GC_DEBUG
if (!(victim_obj->flags & OBJECT_FLAG_FREED))
sciprintf("[GC] Warning: Clone "PREG" not reachable and not freed (freeing now)\n", PRINT_REG(addr));
#ifdef GC_DEBUG_VERBOSE
else
sciprintf("[GC-DEBUG] Clone "PREG": Freeing\n", PRINT_REG(addr));
#endif
#endif
/*
sciprintf("[GC] Clone "PREG": Freeing\n", PRINT_REG(addr));
sciprintf("[GC] Clone had pos "PREG"\n", PRINT_REG(victim_obj->pos));
*/
free(victim_obj->variables);
victim_obj->variables = NULL;
_segmgr->free_Clone(addr);
}
//-------------------- locals --------------------
class SegInterfaceLocals : public SegInterface {
public:
SegInterfaceLocals(SegManager *segmgr, MemObject *mobj, SegmentId segId) :
SegInterface(segmgr, mobj, segId, MEM_OBJ_LOCALS) {}
reg_t findCanonicAddress(reg_t addr);
void freeAtAddress(reg_t addr);
void listAllOutgoingReferences(EngineState *s, reg_t addr, void *param, void (*note)(void *param, reg_t addr));
};
reg_t SegInterfaceLocals::findCanonicAddress(reg_t addr) {
LocalVariables *locals = &(_mobj->data.locals);
// Reference the owning script
SegmentId owner_seg = _segmgr->segGet(locals->script_id);
assert(owner_seg >= 0);
return make_reg(owner_seg, 0);
}
void SegInterfaceLocals::freeAtAddress(reg_t sub_addr) {
//sciprintf(" Request to free "PREG"\n", PRINT_REG(sub_addr));
// STUB
}
void SegInterfaceLocals::listAllOutgoingReferences(EngineState *s, reg_t addr, void *param, void (*note)(void*param, reg_t addr)) {
LocalVariables *locals = &(_mobj->data.locals);
int i;
assert(addr.segment == _segId);
for (i = 0; i < locals->nr; i++)
(*note)(param, locals->locals[i]);
}
//-------------------- stack --------------------
class SegInterfaceStack : public SegInterface {
public:
SegInterfaceStack(SegManager *segmgr, MemObject *mobj, SegmentId segId) :
SegInterface(segmgr, mobj, segId, MEM_OBJ_STACK) {}
reg_t findCanonicAddress(reg_t addr);
void listAllOutgoingReferences(EngineState *s, reg_t addr, void *param, void (*note)(void *param, reg_t addr));
};
reg_t SegInterfaceStack::findCanonicAddress(reg_t addr) {
addr.offset = 0;
return addr;
}
void SegInterfaceStack::listAllOutgoingReferences(EngineState *s, reg_t addr, void *param, void (*note)(void*param, reg_t addr)) {
int i;
fprintf(stderr, "Emitting %d stack entries\n", _mobj->data.stack.nr);
for (i = 0; i < _mobj->data.stack.nr; i++)
(*note)(param, _mobj->data.stack.entries[i]);
fprintf(stderr, "DONE");
}
//-------------------- system strings --------------------
class SegInterfaceSysStrings : public SegInterface {
public:
SegInterfaceSysStrings(SegManager *segmgr, MemObject *mobj, SegmentId segId) :
SegInterface(segmgr, mobj, segId, MEM_OBJ_SYS_STRINGS) {}
};
//-------------------- lists --------------------
class SegInterfaceLists : public SegInterface {
public:
SegInterfaceLists(SegManager *segmgr, MemObject *mobj, SegmentId segId) :
SegInterface(segmgr, mobj, segId, MEM_OBJ_LISTS) {}
void freeAtAddress(reg_t addr);
void listAllDeallocatable(void *param, void (*note)(void *param, reg_t addr));
void listAllOutgoingReferences(EngineState *s, reg_t addr, void *param, void (*note)(void *param, reg_t addr));
};
void SegInterfaceLists::freeAtAddress(reg_t sub_addr) {
_segmgr->free_List(sub_addr);
}
void SegInterfaceLists::listAllDeallocatable(void *param, void (*note)(void*param, reg_t addr)) {
LIST_ALL_DEALLOCATABLE(List, lists);
}
void SegInterfaceLists::listAllOutgoingReferences(EngineState *s, reg_t addr, void *param, void (*note)(void*param, reg_t addr)) {
ListTable *table = &(_mobj->data.lists);
List *list = &(table->table[addr.offset].entry);
if (!ENTRY_IS_VALID(table, addr.offset)) {
fprintf(stderr, "Invalid list referenced for outgoing references: "PREG"\n", PRINT_REG(addr));
return;
}
note(param, list->first);
note(param, list->last);
// We could probably get away with just one of them, but
// let's be conservative here.
}
//-------------------- nodes --------------------
class SegInterfaceNodes : public SegInterface {
public:
SegInterfaceNodes(SegManager *segmgr, MemObject *mobj, SegmentId segId) :
SegInterface(segmgr, mobj, segId, MEM_OBJ_NODES) {}
void freeAtAddress(reg_t addr);
void listAllDeallocatable(void *param, void (*note)(void *param, reg_t addr));
void listAllOutgoingReferences(EngineState *s, reg_t addr, void *param, void (*note)(void *param, reg_t addr));
};
void SegInterfaceNodes::freeAtAddress(reg_t sub_addr) {
_segmgr->free_Node(sub_addr);
}
void SegInterfaceNodes::listAllDeallocatable(void *param, void (*note)(void*param, reg_t addr)) {
LIST_ALL_DEALLOCATABLE(Node, nodes);
}
void SegInterfaceNodes::listAllOutgoingReferences(EngineState *s, reg_t addr, void *param, void (*note)(void*param, reg_t addr)) {
NodeTable *table = &(_mobj->data.nodes);
Node *node = &(table->table[addr.offset].entry);
if (!ENTRY_IS_VALID(table, addr.offset)) {
fprintf(stderr, "Invalid node referenced for outgoing references: "PREG"\n", PRINT_REG(addr));
return;
}
// We need all four here. Can't just stick with 'pred' OR 'succ' because node operations allow us
// to walk around from any given node
note(param, node->pred);
note(param, node->succ);
note(param, node->key);
note(param, node->value);
}
//-------------------- hunk --------------------
class SegInterfaceHunk : public SegInterface {
public:
SegInterfaceHunk(SegManager *segmgr, MemObject *mobj, SegmentId segId) :
SegInterface(segmgr, mobj, segId, MEM_OBJ_HUNK) {}
void freeAtAddress(reg_t addr);
void listAllDeallocatable(void *param, void (*note)(void *param, reg_t addr));
};
void SegInterfaceHunk::freeAtAddress(reg_t sub_addr) {
//sciprintf(" Request to free "PREG"\n", PRINT_REG(sub_addr));
// STUB
}
void SegInterfaceHunk::listAllDeallocatable(void *param, void (*note)(void*param, reg_t addr)) {
LIST_ALL_DEALLOCATABLE(Hunk, hunks);
}
//-------------------- dynamic memory --------------------
class SegInterfaceDynMem : public SegInterfaceBase {
public:
SegInterfaceDynMem(SegManager *segmgr, MemObject *mobj, SegmentId segId) :
SegInterfaceBase(segmgr, mobj, segId, MEM_OBJ_DYNMEM) {}
void freeAtAddress(reg_t addr);
};
void SegInterfaceDynMem::freeAtAddress(reg_t sub_addr) {
//sciprintf(" Request to free "PREG"\n", PRINT_REG(sub_addr));
// STUB
}
//-------------------- reserved --------------------
class SegInterfaceReserved : public SegInterface {
public:
SegInterfaceReserved(SegManager *segmgr, MemObject *mobj, SegmentId segId) :
SegInterface(segmgr, mobj, segId, MEM_OBJ_RESERVED) {}
};
SegInterface *SegManager::getSegInterface(SegmentId segid) {
if (!check(segid))
return NULL; // Invalid segment
SegInterface *retval = NULL;
MemObject *mobj = heap[segid];
switch (mobj->type) {
case MEM_OBJ_SCRIPT:
retval = new SegInterfaceScript(this, mobj, segid);
break;
case MEM_OBJ_CLONES:
retval = new SegInterfaceClones(this, mobj, segid);
break;
case MEM_OBJ_LOCALS:
retval = new SegInterfaceLocals(this, mobj, segid);
break;
case MEM_OBJ_STACK:
retval = new SegInterfaceStack(this, mobj, segid);
break;
case MEM_OBJ_SYS_STRINGS:
retval = new SegInterfaceSysStrings(this, mobj, segid);
break;
case MEM_OBJ_LISTS:
retval = new SegInterfaceLists(this, mobj, segid);
break;
case MEM_OBJ_NODES:
retval = new SegInterfaceNodes(this, mobj, segid);
break;
case MEM_OBJ_HUNK:
retval = new SegInterfaceHunk(this, mobj, segid);
break;
case MEM_OBJ_DYNMEM:
retval = new SegInterfaceDynMem(this, mobj, segid);
break;
case MEM_OBJ_RESERVED:
retval = new SegInterfaceReserved(this, mobj, segid);
break;
default:
error("Improper segment interface for %d", mobj->type);
}
return retval;
}
} // End of namespace Sci
|