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
|
/******************************************************************************
*
* Copyright (c) 1994-1999 Palm Computing, Inc. or its subsidiaries.
* All rights reserved.
*
* File: MemoryMgr.h
*
* Description:
* Include file for Memory Manager
*
* History:
* 10/25/94 RM Created by Ron Marianetti
* 10/28/99 kwk Added memErrROMOnlyCard.
*
*****************************************************************************/
#ifndef __MEMORYMGR_H__
#define __MEMORYMGR_H__
// Include elementary types
#include <PalmTypes.h> // Basic types
#include <CoreTraps.h> // Trap Numbers.
#include <ErrorBase.h>
/************************************************************
* Memory Manager Types
*************************************************************/
typedef enum { memIDPtr, memIDHandle } LocalIDKind;
/************************************************************
* Flags accepted as parameter for MemNewChunk.
*************************************************************/
#define memNewChunkFlagPreLock 0x0100
#define memNewChunkFlagNonMovable 0x0200
#define memNewChunkFlagAtStart 0x0400 // force allocation at front of heap
#define memNewChunkFlagAtEnd 0x0800 // force allocation at end of heap
/************************************************************
* Memory Manager Debug settings for the MemSetDebugMode function
*************************************************************/
#define memDebugModeCheckOnChange 0x0001
#define memDebugModeCheckOnAll 0x0002
#define memDebugModeScrambleOnChange 0x0004
#define memDebugModeScrambleOnAll 0x0008
#define memDebugModeFillFree 0x0010
#define memDebugModeAllHeaps 0x0020
#define memDebugModeRecordMinDynHeapFree 0x0040
/************************************************************
* Memory Manager result codes
*************************************************************/
#define memErrChunkLocked (memErrorClass | 1)
#define memErrNotEnoughSpace (memErrorClass | 2)
#define memErrInvalidParam (memErrorClass | 3) /* invalid param or requested size is too big */
#define memErrChunkNotLocked (memErrorClass | 4)
#define memErrCardNotPresent (memErrorClass | 5)
#define memErrNoCardHeader (memErrorClass | 6)
#define memErrInvalidStoreHeader (memErrorClass | 7)
#define memErrRAMOnlyCard (memErrorClass | 8)
#define memErrWriteProtect (memErrorClass | 9)
#define memErrNoRAMOnCard (memErrorClass | 10)
#define memErrNoStore (memErrorClass | 11)
#define memErrROMOnlyCard (memErrorClass | 12)
/********************************************************************
* Memory Manager Routines
* These are define as external calls only under emulation mode or
* under native mode from the module that actually installs the trap
* vectors
********************************************************************/
#ifdef REMOVE_FOR_EMULATOR
#ifdef __cplusplus
extern "C" {
#endif
//-------------------------------------------------------------------
// Initialization
//-------------------------------------------------------------------
Err MemInit(void)
SYS_TRAP(sysTrapMemInit);
Err MemKernelInit(void)
SYS_TRAP(sysTrapMemKernelInit);
Err MemInitHeapTable(UInt16 cardNo)
SYS_TRAP(sysTrapMemInitHeapTable);
//-------------------------------------------------------------------
// Card formatting and Info
//-------------------------------------------------------------------
UInt16 MemNumCards(void)
SYS_TRAP(sysTrapMemNumCards);
Err MemCardFormat(UInt16 cardNo, Char *cardNameP,
Char *manufNameP, Char *ramStoreNameP)
SYS_TRAP(sysTrapMemCardFormat);
Err MemCardInfo(UInt16 cardNo,
Char *cardNameP, Char *manufNameP,
UInt16 *versionP, UInt32 *crDateP,
UInt32 *romSizeP, UInt32 *ramSizeP,
UInt32 *freeBytesP)
SYS_TRAP(sysTrapMemCardInfo);
//-------------------------------------------------------------------
// Store Info
//-------------------------------------------------------------------
Err MemStoreInfo(UInt16 cardNo, UInt16 storeNumber,
UInt16 *versionP, UInt16 *flagsP, Char *nameP,
UInt32 * crDateP, UInt32 *bckUpDateP,
UInt32 * heapListOffsetP, UInt32 *initCodeOffset1P,
UInt32 *initCodeOffset2P, LocalID* databaseDirIDP)
SYS_TRAP(sysTrapMemStoreInfo);
Err MemStoreSetInfo(UInt16 cardNo, UInt16 storeNumber,
UInt16 *versionP, UInt16 *flagsP, Char *nameP,
UInt32 *crDateP, UInt32 *bckUpDateP,
UInt32 *heapListOffsetP, UInt32 *initCodeOffset1P,
UInt32 *initCodeOffset2P, LocalID* databaseDirIDP)
SYS_TRAP(sysTrapMemStoreSetInfo);
//-------------------------------------------------------------------
// Heap Info & Utilities
//-------------------------------------------------------------------
UInt16 MemNumHeaps(UInt16 cardNo)
SYS_TRAP(sysTrapMemNumHeaps);
UInt16 MemNumRAMHeaps(UInt16 cardNo)
SYS_TRAP(sysTrapMemNumRAMHeaps);
UInt16 MemHeapID(UInt16 cardNo, UInt16 heapIndex)
SYS_TRAP(sysTrapMemHeapID);
Boolean MemHeapDynamic(UInt16 heapID)
SYS_TRAP(sysTrapMemHeapDynamic);
Err MemHeapFreeBytes(UInt16 heapID, UInt32 *freeP, UInt32 *maxP)
SYS_TRAP(sysTrapMemHeapFreeBytes);
UInt32 MemHeapSize(UInt16 heapID)
SYS_TRAP(sysTrapMemHeapSize);
UInt16 MemHeapFlags(UInt16 heapID)
SYS_TRAP(sysTrapMemHeapFlags);
// Heap utilities
Err MemHeapCompact(UInt16 heapID)
SYS_TRAP(sysTrapMemHeapCompact);
Err MemHeapInit(UInt16 heapID, Int16 numHandles, Boolean initContents)
SYS_TRAP(sysTrapMemHeapInit);
Err MemHeapFreeByOwnerID(UInt16 heapID, UInt16 ownerID)
SYS_TRAP(sysTrapMemHeapFreeByOwnerID);
//-------------------------------------------------------------------
// Low Level Allocation
//-------------------------------------------------------------------
MemPtr MemChunkNew(UInt16 heapID, UInt32 size, UInt16 attr)
SYS_TRAP(sysTrapMemChunkNew);
Err MemChunkFree(MemPtr chunkDataP)
SYS_TRAP(sysTrapMemChunkFree);
//-------------------------------------------------------------------
// Pointer (Non-Movable) based Chunk Routines
//-------------------------------------------------------------------
MemPtr MemPtrNew(UInt32 size)
SYS_TRAP(sysTrapMemPtrNew);
#define MemPtrFree( p) \
MemChunkFree(p)
// Getting Attributes
MemHandle MemPtrRecoverHandle(MemPtr p)
SYS_TRAP(sysTrapMemPtrRecoverHandle);
UInt16 MemPtrFlags(MemPtr p)
SYS_TRAP(sysTrapMemPtrFlags);
UInt32 MemPtrSize(MemPtr p)
SYS_TRAP(sysTrapMemPtrSize);
UInt16 MemPtrOwner(MemPtr p)
SYS_TRAP(sysTrapMemPtrOwner);
UInt16 MemPtrHeapID(MemPtr p)
SYS_TRAP(sysTrapMemPtrHeapID);
Boolean MemPtrDataStorage(MemPtr p)
SYS_TRAP(sysTrapMemPtrDataStorage);
UInt16 MemPtrCardNo(MemPtr p)
SYS_TRAP(sysTrapMemPtrCardNo);
LocalID MemPtrToLocalID(MemPtr p)
SYS_TRAP(sysTrapMemPtrToLocalID);
// Setting Attributes
Err MemPtrSetOwner(MemPtr p, UInt16 owner)
SYS_TRAP(sysTrapMemPtrSetOwner);
Err MemPtrResize(MemPtr p, UInt32 newSize)
SYS_TRAP(sysTrapMemPtrResize);
Err MemPtrResetLock(MemPtr p)
SYS_TRAP(sysTrapMemPtrResetLock);
Err MemPtrUnlock(MemPtr p)
SYS_TRAP(sysTrapMemPtrUnlock);
//-------------------------------------------------------------------
// MemHandle (Movable) based Chunk Routines
//-------------------------------------------------------------------
MemHandle MemHandleNew(UInt32 size)
SYS_TRAP(sysTrapMemHandleNew);
Err MemHandleFree(MemHandle h)
SYS_TRAP(sysTrapMemHandleFree);
// Getting Attributes
UInt16 MemHandleFlags(MemHandle h)
SYS_TRAP(sysTrapMemHandleFlags);
UInt32 MemHandleSize(MemHandle h)
SYS_TRAP(sysTrapMemHandleSize);
UInt16 MemHandleOwner(MemHandle h)
SYS_TRAP(sysTrapMemHandleOwner);
UInt16 MemHandleLockCount(MemHandle h)
SYS_TRAP(sysTrapMemHandleLockCount);
UInt16 MemHandleHeapID(MemHandle h)
SYS_TRAP(sysTrapMemHandleHeapID);
Boolean MemHandleDataStorage(MemHandle h)
SYS_TRAP(sysTrapMemHandleDataStorage);
UInt16 MemHandleCardNo(MemHandle h)
SYS_TRAP(sysTrapMemHandleCardNo);
LocalID MemHandleToLocalID(MemHandle h)
SYS_TRAP(sysTrapMemHandleToLocalID);
// Setting Attributes
Err MemHandleSetOwner( MemHandle h, UInt16 owner)
SYS_TRAP(sysTrapMemHandleSetOwner);
Err MemHandleResize(MemHandle h, UInt32 newSize)
SYS_TRAP(sysTrapMemHandleResize);
MemPtr MemHandleLock(MemHandle h)
SYS_TRAP(sysTrapMemHandleLock);
Err MemHandleUnlock(MemHandle h)
SYS_TRAP(sysTrapMemHandleUnlock);
Err MemHandleResetLock(MemHandle h)
SYS_TRAP(sysTrapMemHandleResetLock);
//-------------------------------------------------------------------
// Local ID based routines
//-------------------------------------------------------------------
MemPtr MemLocalIDToGlobal(LocalID local, UInt16 cardNo)
SYS_TRAP(sysTrapMemLocalIDToGlobal);
LocalIDKind MemLocalIDKind(LocalID local)
SYS_TRAP(sysTrapMemLocalIDKind);
MemPtr MemLocalIDToPtr(LocalID local, UInt16 cardNo)
SYS_TRAP(sysTrapMemLocalIDToPtr);
MemPtr MemLocalIDToLockedPtr(LocalID local, UInt16 cardNo)
SYS_TRAP(sysTrapMemLocalIDToLockedPtr);
//-------------------------------------------------------------------
// Utilities
//-------------------------------------------------------------------
Err MemMove(void *dstP, const void *sP, Int32 numBytes)
SYS_TRAP(sysTrapMemMove);
Err MemSet(void *dstP, Int32 numBytes, UInt8 value)
SYS_TRAP(sysTrapMemSet);
Int16 MemCmp (const void *s1, const void *s2, Int32 numBytes)
SYS_TRAP(sysTrapMemCmp);
Err MemSemaphoreReserve(Boolean writeAccess)
SYS_TRAP(sysTrapMemSemaphoreReserve);
Err MemSemaphoreRelease(Boolean writeAccess)
SYS_TRAP(sysTrapMemSemaphoreRelease);
//-------------------------------------------------------------------
// Debugging Support
//-------------------------------------------------------------------
UInt16 MemDebugMode(void)
SYS_TRAP(sysTrapMemDebugMode);
Err MemSetDebugMode(UInt16 flags)
SYS_TRAP(sysTrapMemSetDebugMode);
Err MemHeapScramble(UInt16 heapID)
SYS_TRAP(sysTrapMemHeapScramble);
Err MemHeapCheck(UInt16 heapID)
SYS_TRAP(sysTrapMemHeapCheck);
#ifdef __cplusplus
}
#endif
#endif
#endif // __MEMORYMGR_H__
|