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
|
/* $Id: kRdr.cpp 29 2009-07-01 20:30:29Z bird $ */
/** @file
* kRdr - The File Provider.
*/
/*
* Copyright (c) 2006-2007 Knut St. Osmundsen <bird-kStuff-spamix@anduin.net>
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*/
/*******************************************************************************
* Header Files *
*******************************************************************************/
#include "kRdrInternal.h"
/*******************************************************************************
* Global Variables *
*******************************************************************************/
/** The list of file providers. */
static PCKRDROPS g_pRdrHead = &g_kRdrFileOps;
/**
* Adds a new file provider.
*
* @param pAdd The new file provider.
*/
KRDR_DECL(void) kRdrAddProvider(PKRDROPS pAdd)
{
pAdd->pNext = g_pRdrHead;
g_pRdrHead = pAdd;
}
/**
* Tries to opens a file.
*
* @returns 0 on success, OS status code on failure.
* @param ppRdr Where to store the file provider instance.
* @param pszFilename The filename.
*/
KRDR_DECL(int) kRdrOpen(PPKRDR ppRdr, const char *pszFilename)
{
int rc = -1;
PCKRDROPS pCur;
for (pCur = g_pRdrHead; pCur; pCur = pCur->pNext)
{
rc = pCur->pfnCreate(ppRdr, pszFilename);
if (!rc)
return 0;
}
return rc;
}
/**
* Closes the file.
*
* @returns 0 on success, OS specific error code on failure.
* On failure, the file provider instance will be in an indeterminate state - don't touch it!
* @param pRdr The file provider instance.
*/
KRDR_DECL(int) kRdrClose(PKRDR pRdr)
{
KRDR_VALIDATE(pRdr);
return pRdr->pOps->pfnDestroy(pRdr);
}
/** Read bits from the file.
*
* @returns 0 on success, OS specific error code on failure.
* @param pRdr The file provider instance.
* @param pvBuf Where to put the bits.
* @param cb The number of bytes to read.
* @param off Where to start reading.
*/
KRDR_DECL(int) kRdrRead(PKRDR pRdr, void *pvBuf, KSIZE cb, KFOFF off)
{
KRDR_VALIDATE(pRdr);
return pRdr->pOps->pfnRead(pRdr, pvBuf, cb, off);
}
/** Map all the file bits into memory (read only).
*
* @returns 0 on success, OS specific error code on failure.
* @param pRdr The file provider instance.
* @param ppvBits Where to store the address of the mapping.
* The size can be obtained using pfnSize.
*/
KRDR_DECL(int) kRdrAllMap(PKRDR pRdr, const void **ppvBits)
{
KRDR_VALIDATE(pRdr);
return pRdr->pOps->pfnAllMap(pRdr, ppvBits);
}
/** Unmap a file bits mapping obtained by KRDROPS::pfnAllMap.
*
* @returns 0 on success, OS specific error code on failure.
* @param pRdr The file provider instance.
* @param pvBits The mapping address.
*/
KRDR_DECL(int) kRdrAllUnmap(PKRDR pRdr, const void *pvBits)
{
KRDR_VALIDATE(pRdr);
return pRdr->pOps->pfnAllUnmap(pRdr, pvBits);
}
/** Get the file size.
*
* @returns The file size. Returns -1 on failure.
* @param pRdr The file provider instance.
*/
KRDR_DECL(KFOFF) kRdrSize(PKRDR pRdr)
{
KRDR_VALIDATE(pRdr);
return pRdr->pOps->pfnSize(pRdr);
}
/** Get the file pointer offset.
*
* @returns The file pointer offset. Returns -1 on failure.
* @param pRdr The file provider instance.
*/
KRDR_DECL(KFOFF) kRdrTell(PKRDR pRdr)
{
KRDR_VALIDATE(pRdr);
return pRdr->pOps->pfnTell(pRdr);
}
/** Get the file name.
*
* @returns The file name. Returns NULL on failure.
* @param pRdr The file provider instance.
*/
KRDR_DECL(const char *) kRdrName(PKRDR pRdr)
{
KRDR_VALIDATE_EX(pRdr, NULL);
return pRdr->pOps->pfnName(pRdr);
}
/** Get the native file handle if possible.
*
* @returns The native file handle. Returns -1 if not available.
* @param pRdr The file provider instance.
*/
KRDR_DECL(KIPTR) kRdrNativeFH(PKRDR pRdr)
{
KRDR_VALIDATE_EX(pRdr, -1);
return pRdr->pOps->pfnNativeFH(pRdr);
}
/**
* Gets the page size used when mapping sections of the file.
*
* @returns The page size.
* @param pRdr The file provider instance.
*/
KRDR_DECL(KSIZE) kRdrPageSize(PKRDR pRdr)
{
KRDR_VALIDATE_EX(pRdr, 0x10000);
return pRdr->pOps->pfnPageSize(pRdr);
}
/**
* Maps the segments of a image into memory.
*
* The file reader will be using the RVA member of each segment to figure out where
* it goes relative to the image base address.
*
* @returns 0 on success, OS specific error code on failure.
* @param pRdr The file provider instance.
* @param ppvBase On input when fFixed is set, this contains the base address of the mapping.
* On output this contains the base of the image mapping.
* @param cSegments The number of segments in the array pointed to by paSegments.
* @param paSegments The segments thats going to be mapped.
* @param fFixed If set, the address at *ppvBase should be the base address of the mapping.
*/
KRDR_DECL(int) kRdrMap(PKRDR pRdr, void **ppvBase, KU32 cSegments, PCKLDRSEG paSegments, KBOOL fFixed)
{
KRDR_VALIDATE(pRdr);
return pRdr->pOps->pfnMap(pRdr, ppvBase, cSegments, paSegments, fFixed);
}
/**
* Reloads dirty pages in mapped image.
*
* @returns 0 on success, OS specific error code on failure.
* @param pRdr The file provider instance.
* @param pvBase The base address of the image mapping.
* @param cSegments The number of segments in the array pointed to by paSegments.
* @param paSegments The segments thats going to be mapped.
*/
KRDR_DECL(int) kRdrRefresh(PKRDR pRdr, void *pvBase, KU32 cSegments, PCKLDRSEG paSegments)
{
KRDR_VALIDATE(pRdr);
return pRdr->pOps->pfnRefresh(pRdr, pvBase, cSegments, paSegments);
}
/**
* Protects or unprotects an image mapping.
*
* This is typically used for getting write access to read or execute only
* pages while applying fixups.
*
* @returns 0 on success, OS specific error code on failure.
* @param pRdr The file provider instance.
* @param pvBase The base address of the image mapping.
* @param cSegments The number of segments in the array pointed to by paSegments.
* @param paSegments The segments thats going to be mapped.
* @param fUnprotectOrProtect When set the all mapped segments are made writable.
* When clean the segment protection is restored.
*/
KRDR_DECL(int) kRdrProtect(PKRDR pRdr, void *pvBase, KU32 cSegments, PCKLDRSEG paSegments, KBOOL fUnprotectOrProtect)
{
KRDR_VALIDATE(pRdr);
return pRdr->pOps->pfnProtect(pRdr, pvBase, cSegments, paSegments, fUnprotectOrProtect);
}
/**
* Unmaps a image mapping.
*
* @returns 0 on success, OS specific error code on failure.
* @param pRdr The file provider instance.
* @param pvBase The base address of the image mapping.
* @param cSegments The number of segments in the array pointed to by paSegments.
* @param paSegments The segments thats going to be mapped.
*/
KRDR_DECL(int) kRdrUnmap(PKRDR pRdr, void *pvBase, KU32 cSegments, PCKLDRSEG paSegments)
{
KRDR_VALIDATE(pRdr);
return pRdr->pOps->pfnUnmap(pRdr, pvBase, cSegments, paSegments);
}
/**
* We're done reading from the file but would like to keep file mappings.
*
* If the OS support closing the file handle while the file is mapped,
* the reader should do so.
*
* @param pRdr The file provider instance.
*/
KRDR_DECL(void) kRdrDone(PKRDR pRdr)
{
KRDR_VALIDATE_VOID(pRdr);
pRdr->pOps->pfnDone(pRdr);
}
|
