1 | /* $Id: DBGPlugInOS2.cpp 69498 2017-10-28 15:07:25Z vboxsync $ */
|
---|
2 | /** @file
|
---|
3 | * DBGPlugInOS2 - Debugger and Guest OS Digger Plugin For OS/2.
|
---|
4 | */
|
---|
5 |
|
---|
6 | /*
|
---|
7 | * Copyright (C) 2009-2016 Oracle Corporation
|
---|
8 | *
|
---|
9 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
---|
10 | * available from http://www.virtualbox.org. This file is free software;
|
---|
11 | * you can redistribute it and/or modify it under the terms of the GNU
|
---|
12 | * General Public License (GPL) as published by the Free Software
|
---|
13 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
---|
14 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
---|
15 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
---|
16 | */
|
---|
17 |
|
---|
18 |
|
---|
19 | /*********************************************************************************************************************************
|
---|
20 | * Header Files *
|
---|
21 | *********************************************************************************************************************************/
|
---|
22 | #define LOG_GROUP LOG_GROUP_DBGF /// @todo add new log group.
|
---|
23 | #include "DBGPlugIns.h"
|
---|
24 | #include <VBox/vmm/dbgf.h>
|
---|
25 | #include <VBox/err.h>
|
---|
26 | #include <VBox/param.h>
|
---|
27 | #include <iprt/string.h>
|
---|
28 | #include <iprt/mem.h>
|
---|
29 | #include <iprt/stream.h>
|
---|
30 |
|
---|
31 |
|
---|
32 | /*********************************************************************************************************************************
|
---|
33 | * Structures and Typedefs *
|
---|
34 | *********************************************************************************************************************************/
|
---|
35 |
|
---|
36 | /** @name Internal OS/2 structures */
|
---|
37 |
|
---|
38 | /** @} */
|
---|
39 |
|
---|
40 |
|
---|
41 | typedef enum DBGDIGGEROS2VER
|
---|
42 | {
|
---|
43 | DBGDIGGEROS2VER_UNKNOWN,
|
---|
44 | DBGDIGGEROS2VER_1_x,
|
---|
45 | DBGDIGGEROS2VER_2_x,
|
---|
46 | DBGDIGGEROS2VER_3_0,
|
---|
47 | DBGDIGGEROS2VER_4_0,
|
---|
48 | DBGDIGGEROS2VER_4_5
|
---|
49 | } DBGDIGGEROS2VER;
|
---|
50 |
|
---|
51 | /**
|
---|
52 | * OS/2 guest OS digger instance data.
|
---|
53 | */
|
---|
54 | typedef struct DBGDIGGEROS2
|
---|
55 | {
|
---|
56 | /** Whether the information is valid or not.
|
---|
57 | * (For fending off illegal interface method calls.) */
|
---|
58 | bool fValid;
|
---|
59 | /** 32-bit (true) or 16-bit (false) */
|
---|
60 | bool f32Bit;
|
---|
61 |
|
---|
62 | /** The OS/2 guest version. */
|
---|
63 | DBGDIGGEROS2VER enmVer;
|
---|
64 | uint8_t OS2MajorVersion;
|
---|
65 | uint8_t OS2MinorVersion;
|
---|
66 |
|
---|
67 | /** Guest's Global Info Segment selector. */
|
---|
68 | uint16_t selGIS;
|
---|
69 |
|
---|
70 | } DBGDIGGEROS2;
|
---|
71 | /** Pointer to the OS/2 guest OS digger instance data. */
|
---|
72 | typedef DBGDIGGEROS2 *PDBGDIGGEROS2;
|
---|
73 |
|
---|
74 |
|
---|
75 | /*********************************************************************************************************************************
|
---|
76 | * Defined Constants And Macros *
|
---|
77 | *********************************************************************************************************************************/
|
---|
78 | /** The 'SAS ' signature. */
|
---|
79 | #define DIG_OS2_SAS_SIG RT_MAKE_U32_FROM_U8('S','A','S',' ')
|
---|
80 |
|
---|
81 | /** OS/2Warp on little endian ASCII systems. */
|
---|
82 | #define DIG_OS2_MOD_TAG UINT64_C(0x43532f3257617270)
|
---|
83 |
|
---|
84 |
|
---|
85 | /*********************************************************************************************************************************
|
---|
86 | * Internal Functions *
|
---|
87 | *********************************************************************************************************************************/
|
---|
88 | static DECLCALLBACK(int) dbgDiggerOS2Init(PUVM pUVM, void *pvData);
|
---|
89 |
|
---|
90 |
|
---|
91 |
|
---|
92 | #if 0 /* unused */
|
---|
93 | /**
|
---|
94 | * Process a PE image found in guest memory.
|
---|
95 | *
|
---|
96 | * @param pThis The instance data.
|
---|
97 | * @param pUVM The user mode VM handle.
|
---|
98 | * @param pszName The image name.
|
---|
99 | * @param pImageAddr The image address.
|
---|
100 | * @param cbImage The size of the image.
|
---|
101 | * @param pbBuf Scratch buffer containing the first
|
---|
102 | * RT_MIN(cbBuf, cbImage) bytes of the image.
|
---|
103 | * @param cbBuf The scratch buffer size.
|
---|
104 | */
|
---|
105 | static void dbgDiggerOS2ProcessImage(PDBGDIGGEROS2 pThis, PUVM pUVM, const char *pszName,
|
---|
106 | PCDBGFADDRESS pImageAddr, uint32_t cbImage,
|
---|
107 | uint8_t *pbBuf, size_t cbBuf)
|
---|
108 | {
|
---|
109 | RT_NOREF7(pThis, pUVM, pszName, pImageAddr, cbImage, pbBuf, cbBuf);
|
---|
110 | LogFlow(("DigOS2: %RGp %#x %s\n", pImageAddr->FlatPtr, cbImage, pszName));
|
---|
111 |
|
---|
112 | /* To be implemented.*/
|
---|
113 | }
|
---|
114 | #endif
|
---|
115 |
|
---|
116 |
|
---|
117 | /**
|
---|
118 | * @copydoc DBGFOSREG::pfnQueryInterface
|
---|
119 | */
|
---|
120 | static DECLCALLBACK(void *) dbgDiggerOS2QueryInterface(PUVM pUVM, void *pvData, DBGFOSINTERFACE enmIf)
|
---|
121 | {
|
---|
122 | RT_NOREF3(pUVM, pvData, enmIf);
|
---|
123 | return NULL;
|
---|
124 | }
|
---|
125 |
|
---|
126 |
|
---|
127 | /**
|
---|
128 | * @copydoc DBGFOSREG::pfnQueryVersion
|
---|
129 | */
|
---|
130 | static DECLCALLBACK(int) dbgDiggerOS2QueryVersion(PUVM pUVM, void *pvData, char *pszVersion, size_t cchVersion)
|
---|
131 | {
|
---|
132 | RT_NOREF1(pUVM);
|
---|
133 | PDBGDIGGEROS2 pThis = (PDBGDIGGEROS2)pvData;
|
---|
134 | Assert(pThis->fValid);
|
---|
135 | char *achOS2ProductType[32];
|
---|
136 | char *pszOS2ProductType = (char *)achOS2ProductType;
|
---|
137 |
|
---|
138 | if (pThis->OS2MajorVersion == 10)
|
---|
139 | {
|
---|
140 | RTStrPrintf(pszOS2ProductType, sizeof(achOS2ProductType), "OS/2 1.%02d", pThis->OS2MinorVersion);
|
---|
141 | pThis->enmVer = DBGDIGGEROS2VER_1_x;
|
---|
142 | }
|
---|
143 | else if (pThis->OS2MajorVersion == 20)
|
---|
144 | {
|
---|
145 | if (pThis->OS2MinorVersion < 30)
|
---|
146 | {
|
---|
147 | RTStrPrintf(pszOS2ProductType, sizeof(achOS2ProductType), "OS/2 2.%02d", pThis->OS2MinorVersion);
|
---|
148 | pThis->enmVer = DBGDIGGEROS2VER_2_x;
|
---|
149 | }
|
---|
150 | else if (pThis->OS2MinorVersion < 40)
|
---|
151 | {
|
---|
152 | RTStrPrintf(pszOS2ProductType, sizeof(achOS2ProductType), "OS/2 Warp");
|
---|
153 | pThis->enmVer = DBGDIGGEROS2VER_3_0;
|
---|
154 | }
|
---|
155 | else if (pThis->OS2MinorVersion == 40)
|
---|
156 | {
|
---|
157 | RTStrPrintf(pszOS2ProductType, sizeof(achOS2ProductType), "OS/2 Warp 4");
|
---|
158 | pThis->enmVer = DBGDIGGEROS2VER_4_0;
|
---|
159 | }
|
---|
160 | else
|
---|
161 | {
|
---|
162 | RTStrPrintf(pszOS2ProductType, sizeof(achOS2ProductType), "OS/2 Warp %d.%d",
|
---|
163 | pThis->OS2MinorVersion / 10, pThis->OS2MinorVersion % 10);
|
---|
164 | pThis->enmVer = DBGDIGGEROS2VER_4_5;
|
---|
165 | }
|
---|
166 | }
|
---|
167 | RTStrPrintf(pszVersion, cchVersion, "%u.%u (%s)", pThis->OS2MajorVersion, pThis->OS2MinorVersion, pszOS2ProductType);
|
---|
168 | return VINF_SUCCESS;
|
---|
169 | }
|
---|
170 |
|
---|
171 |
|
---|
172 | /**
|
---|
173 | * @copydoc DBGFOSREG::pfnTerm
|
---|
174 | */
|
---|
175 | static DECLCALLBACK(void) dbgDiggerOS2Term(PUVM pUVM, void *pvData)
|
---|
176 | {
|
---|
177 | RT_NOREF1(pUVM);
|
---|
178 | PDBGDIGGEROS2 pThis = (PDBGDIGGEROS2)pvData;
|
---|
179 | Assert(pThis->fValid);
|
---|
180 |
|
---|
181 | pThis->fValid = false;
|
---|
182 | }
|
---|
183 |
|
---|
184 |
|
---|
185 | /**
|
---|
186 | * @copydoc DBGFOSREG::pfnRefresh
|
---|
187 | */
|
---|
188 | static DECLCALLBACK(int) dbgDiggerOS2Refresh(PUVM pUVM, void *pvData)
|
---|
189 | {
|
---|
190 | PDBGDIGGEROS2 pThis = (PDBGDIGGEROS2)pvData;
|
---|
191 | NOREF(pThis);
|
---|
192 | Assert(pThis->fValid);
|
---|
193 |
|
---|
194 | /*
|
---|
195 | * For now we'll flush and reload everything.
|
---|
196 | */
|
---|
197 | RTDBGAS hDbgAs = DBGFR3AsResolveAndRetain(pUVM, DBGF_AS_KERNEL);
|
---|
198 | if (hDbgAs != NIL_RTDBGAS)
|
---|
199 | {
|
---|
200 | uint32_t iMod = RTDbgAsModuleCount(hDbgAs);
|
---|
201 | while (iMod-- > 0)
|
---|
202 | {
|
---|
203 | RTDBGMOD hMod = RTDbgAsModuleByIndex(hDbgAs, iMod);
|
---|
204 | if (hMod != NIL_RTDBGMOD)
|
---|
205 | {
|
---|
206 | if (RTDbgModGetTag(hMod) == DIG_OS2_MOD_TAG)
|
---|
207 | {
|
---|
208 | int rc = RTDbgAsModuleUnlink(hDbgAs, hMod);
|
---|
209 | AssertRC(rc);
|
---|
210 | }
|
---|
211 | RTDbgModRelease(hMod);
|
---|
212 | }
|
---|
213 | }
|
---|
214 | RTDbgAsRelease(hDbgAs);
|
---|
215 | }
|
---|
216 |
|
---|
217 | dbgDiggerOS2Term(pUVM, pvData);
|
---|
218 | return dbgDiggerOS2Init(pUVM, pvData);
|
---|
219 | }
|
---|
220 |
|
---|
221 |
|
---|
222 | /**
|
---|
223 | * @copydoc DBGFOSREG::pfnInit
|
---|
224 | */
|
---|
225 | static DECLCALLBACK(int) dbgDiggerOS2Init(PUVM pUVM, void *pvData)
|
---|
226 | {
|
---|
227 | PDBGDIGGEROS2 pThis = (PDBGDIGGEROS2)pvData;
|
---|
228 | Assert(!pThis->fValid);
|
---|
229 |
|
---|
230 | union
|
---|
231 | {
|
---|
232 | uint8_t au8[0x2000];
|
---|
233 | uint16_t au16[0x2000/2];
|
---|
234 | uint32_t au32[0x2000/4];
|
---|
235 | RTUTF16 wsz[0x2000/2];
|
---|
236 | } u;
|
---|
237 | DBGFADDRESS Addr;
|
---|
238 | int rc;
|
---|
239 |
|
---|
240 | /*
|
---|
241 | * Determine the OS/2 version.
|
---|
242 | */
|
---|
243 | do {
|
---|
244 | /* Version info is at GIS:15h (major/minor/revision). */
|
---|
245 | rc = DBGFR3AddrFromSelOff(pUVM, 0 /*idCpu*/, &Addr, pThis->selGIS, 0x15);
|
---|
246 | if (RT_FAILURE(rc))
|
---|
247 | break;
|
---|
248 | rc = DBGFR3MemRead(pUVM, 0 /*idCpu*/, &Addr, u.au32, sizeof(uint32_t));
|
---|
249 | if (RT_FAILURE(rc))
|
---|
250 | break;
|
---|
251 |
|
---|
252 | pThis->OS2MajorVersion = u.au8[0];
|
---|
253 | pThis->OS2MinorVersion = u.au8[1];
|
---|
254 |
|
---|
255 | pThis->fValid = true;
|
---|
256 | return VINF_SUCCESS;
|
---|
257 | } while (0);
|
---|
258 | return VERR_NOT_SUPPORTED;
|
---|
259 | }
|
---|
260 |
|
---|
261 |
|
---|
262 | /**
|
---|
263 | * @copydoc DBGFOSREG::pfnProbe
|
---|
264 | */
|
---|
265 | static DECLCALLBACK(bool) dbgDiggerOS2Probe(PUVM pUVM, void *pvData)
|
---|
266 | {
|
---|
267 | PDBGDIGGEROS2 pThis = (PDBGDIGGEROS2)pvData;
|
---|
268 | DBGFADDRESS Addr;
|
---|
269 | int rc;
|
---|
270 | uint16_t offInfo;
|
---|
271 | union
|
---|
272 | {
|
---|
273 | uint8_t au8[8192];
|
---|
274 | uint16_t au16[8192/2];
|
---|
275 | uint32_t au32[8192/4];
|
---|
276 | RTUTF16 wsz[8192/2];
|
---|
277 | } u;
|
---|
278 |
|
---|
279 | /*
|
---|
280 | * If the DWORD at 70:0 contains 'SAS ' it's quite unlikely that this wouldn't be OS/2.
|
---|
281 | * Note: The SAS layout is similar between 16-bit and 32-bit OS/2, but not identical.
|
---|
282 | * 32-bit OS/2 will have the flat kernel data selector at SAS:06. The selector is 168h
|
---|
283 | * or similar. For 16-bit OS/2 the field contains a table offset into the SAS which will
|
---|
284 | * be much smaller. Fun fact: The global infoseg selector in the SAS is bimodal in 16-bit
|
---|
285 | * OS/2 and will work in real mode as well.
|
---|
286 | */
|
---|
287 | do {
|
---|
288 | rc = DBGFR3AddrFromSelOff(pUVM, 0 /*idCpu*/, &Addr, 0x70, 0x00);
|
---|
289 | if (RT_FAILURE(rc))
|
---|
290 | break;
|
---|
291 | rc = DBGFR3MemRead(pUVM, 0 /*idCpu*/, &Addr, u.au32, 256);
|
---|
292 | if (RT_FAILURE(rc))
|
---|
293 | break;
|
---|
294 | if (u.au32[0] != DIG_OS2_SAS_SIG)
|
---|
295 | break;
|
---|
296 |
|
---|
297 | /* This sure looks like OS/2, but a bit of paranoia won't hurt. */
|
---|
298 | if (u.au16[2] >= u.au16[4])
|
---|
299 | break;
|
---|
300 |
|
---|
301 | /* If 4th word is bigger than 5th, it's the flat kernel mode selector. */
|
---|
302 | if (u.au16[3] > u.au16[4])
|
---|
303 | pThis->f32Bit = true;
|
---|
304 |
|
---|
305 | /* Offset into info table is either at SAS:14h or SAS:16h. */
|
---|
306 | if (pThis->f32Bit)
|
---|
307 | offInfo = u.au16[0x14/2];
|
---|
308 | else
|
---|
309 | offInfo = u.au16[0x16/2];
|
---|
310 |
|
---|
311 | /* The global infoseg selector is the first entry in the info table. */
|
---|
312 | pThis->selGIS = u.au16[offInfo/2];
|
---|
313 | return true;
|
---|
314 | } while (0);
|
---|
315 |
|
---|
316 | return false;
|
---|
317 | }
|
---|
318 |
|
---|
319 |
|
---|
320 | /**
|
---|
321 | * @copydoc DBGFOSREG::pfnDestruct
|
---|
322 | */
|
---|
323 | static DECLCALLBACK(void) dbgDiggerOS2Destruct(PUVM pUVM, void *pvData)
|
---|
324 | {
|
---|
325 | RT_NOREF2(pUVM, pvData);
|
---|
326 | }
|
---|
327 |
|
---|
328 |
|
---|
329 | /**
|
---|
330 | * @copydoc DBGFOSREG::pfnConstruct
|
---|
331 | */
|
---|
332 | static DECLCALLBACK(int) dbgDiggerOS2Construct(PUVM pUVM, void *pvData)
|
---|
333 | {
|
---|
334 | RT_NOREF1(pUVM);
|
---|
335 | PDBGDIGGEROS2 pThis = (PDBGDIGGEROS2)pvData;
|
---|
336 | pThis->fValid = false;
|
---|
337 | pThis->f32Bit = false;
|
---|
338 | pThis->enmVer = DBGDIGGEROS2VER_UNKNOWN;
|
---|
339 | return VINF_SUCCESS;
|
---|
340 | }
|
---|
341 |
|
---|
342 |
|
---|
343 | const DBGFOSREG g_DBGDiggerOS2 =
|
---|
344 | {
|
---|
345 | /* .u32Magic = */ DBGFOSREG_MAGIC,
|
---|
346 | /* .fFlags = */ 0,
|
---|
347 | /* .cbData = */ sizeof(DBGDIGGEROS2),
|
---|
348 | /* .szName = */ "OS/2",
|
---|
349 | /* .pfnConstruct = */ dbgDiggerOS2Construct,
|
---|
350 | /* .pfnDestruct = */ dbgDiggerOS2Destruct,
|
---|
351 | /* .pfnProbe = */ dbgDiggerOS2Probe,
|
---|
352 | /* .pfnInit = */ dbgDiggerOS2Init,
|
---|
353 | /* .pfnRefresh = */ dbgDiggerOS2Refresh,
|
---|
354 | /* .pfnTerm = */ dbgDiggerOS2Term,
|
---|
355 | /* .pfnQueryVersion = */ dbgDiggerOS2QueryVersion,
|
---|
356 | /* .pfnQueryInterface = */ dbgDiggerOS2QueryInterface,
|
---|
357 | /* .u32EndMagic = */ DBGFOSREG_MAGIC
|
---|
358 | };
|
---|