MakeAlternativeSource.cpp@ 67789

Last change on this file since 67789 was 67789, checked in by vboxsync, 7 years ago
Devices/PC/BIOS: updated alternative sources
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 63.1 KB

Line
1	/* $Id: MakeAlternativeSource.cpp 67789 2017-07-05 11:23:43Z vboxsync $ */
2	/** @file
3	* MakeAlternative - Generate an Alternative BIOS Source that requires less tools.
4	*/
5
6	/*
7	* Copyright (C) 2012-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	#include <iprt/asm.h>
23	#include <iprt/buildconfig.h>
24	#include <iprt/ctype.h>
25	#include <iprt/dbg.h>
26	#include <iprt/file.h>
27	#include <iprt/getopt.h>
28	#include <iprt/initterm.h>
29	#include <iprt/list.h>
30	#include <iprt/mem.h>
31	#include <iprt/message.h>
32	#include <iprt/string.h>
33	#include <iprt/stream.h>
34	#include <iprt/x86.h>
35
36	#include <VBox/dis.h>
37
38
39	/*********************************************************************************************************************************
40	* Structures and Typedefs *
41	*********************************************************************************************************************************/
42	/**
43	* A BIOS segment.
44	*/
45	typedef struct BIOSSEG
46	{
47	char szName[32];
48	char szClass[32];
49	char szGroup[32];
50	RTFAR16 Address;
51	uint32_t uFlatAddr;
52	uint32_t cb;
53	} BIOSSEG;
54	/** Pointer to a BIOS segment. */
55	typedef BIOSSEG *PBIOSSEG;
56
57
58	/**
59	* A BIOS object file.
60	*/
61	typedef struct BIOSOBJFILE
62	{
63	RTLISTNODE Node;
64	char *pszSource;
65	char *pszObject;
66	} BIOSOBJFILE;
67	/** A BIOS object file. */
68	typedef BIOSOBJFILE *PBIOSOBJFILE;
69
70
71	/**
72	* Pointer to a BIOS map parser handle.
73	*/
74	typedef struct BIOSMAP
75	{
76	/** The stream pointer. */
77	PRTSTREAM hStrm;
78	/** The file name. */
79	const char *pszMapFile;
80	/** Set when EOF has been reached. */
81	bool fEof;
82	/** The current line number (0 based).*/
83	uint32_t iLine;
84	/** The length of the current line. */
85	uint32_t cch;
86	/** The offset of the first non-white character on the line. */
87	uint32_t offNW;
88	/** The line buffer. */
89	char szLine[16384];
90	} BIOSMAP;
91	/** Pointer to a BIOS map parser handle. */
92	typedef BIOSMAP *PBIOSMAP;
93
94
95	/*********************************************************************************************************************************
96	* Global Variables *
97	*********************************************************************************************************************************/
98	/** The verbosity level.*/
99	static unsigned g_cVerbose = 1 /0/;
100	/** Pointer to the BIOS image. */
101	static uint8_t const *g_pbImg;
102	/** The size of the BIOS image. */
103	static size_t g_cbImg;
104
105	/** Debug module for the map file. */
106	static RTDBGMOD g_hMapMod = NIL_RTDBGMOD;
107	/** The number of BIOS segments found in the map file. */
108	static uint32_t g_cSegs = 0;
109	/** Array of BIOS segments from the map file. */
110	static BIOSSEG g_aSegs[32];
111	/** List of BIOSOBJFILE. */
112	static RTLISTANCHOR g_ObjList;
113
114	/** The output stream. */
115	static PRTSTREAM g_hStrmOutput = NULL;
116
117	/** The type of BIOS we're working on. */
118	static enum BIOSTYPE
119	{
120	kBiosType_System = 0,
121	kBiosType_Vga
122	} g_enmBiosType = kBiosType_System;
123	/** The flat ROM base address. */
124	static uint32_t g_uBiosFlatBase = 0xf0000;
125
126
127	static bool outputPrintfV(const char *pszFormat, va_list va)
128	{
129	int rc = RTStrmPrintfV(g_hStrmOutput, pszFormat, va);
130	if (RT_FAILURE(rc))
131	{
132	RTMsgError("Output error: %Rrc\n", rc);
133	return false;
134	}
135	return true;
136	}
137
138
139	static bool outputPrintf(const char *pszFormat, ...)
140	{
141	va_list va;
142	va_start(va, pszFormat);
143	bool fRc = outputPrintfV(pszFormat, va);
144	va_end(va);
145	return fRc;
146	}
147
148
149	/**
150	* Opens the output file for writing.
151	*
152	* @returns RTEXITCODE_SUCCESS or RTEXITCODE_FAILURE+msg.
153	* @param pszOutput Path to the output file.
154	*/
155	static RTEXITCODE OpenOutputFile(const char *pszOutput)
156	{
157	if (!pszOutput)
158	g_hStrmOutput = g_pStdOut;
159	else
160	{
161	int rc = RTStrmOpen(pszOutput, "w", &g_hStrmOutput);
162	if (RT_FAILURE(rc))
163	return RTMsgErrorExit(RTEXITCODE_FAILURE, "Failed to open output file '%s': %Rrc", pszOutput, rc);
164	}
165	return RTEXITCODE_SUCCESS;
166	}
167
168
169	/**
170	* Displays a disassembly error and returns @c false.
171	*
172	* @returns @c false.
173	* @param pszFormat The error format string.
174	* @param ... Format argument.
175	*/
176	static bool disError(const char *pszFormat, ...)
177	{
178	va_list va;
179	va_start(va, pszFormat);
180	RTMsgErrorV(pszFormat, va);
181	va_end(va);
182	return false;
183	}
184
185
186	/**
187	* Output the disassembly file header.
188	*
189	* @returns @c true on success,
190	*/
191	static bool disFileHeader(void)
192	{
193	bool fRc;
194	fRc = outputPrintf("; $Id: MakeAlternativeSource.cpp 67789 2017-07-05 11:23:43Z vboxsync $ \n"
195	";; @file\n"
196	"; Auto Generated source file. Do not edit.\n"
197	";\n"
198	);
199	if (!fRc)
200	return fRc;
201
202	/*
203	* List the header of each source file, up to and including the
204	* copyright notice.
205	*/
206	bool fNeedLgplDisclaimer = false;
207	PBIOSOBJFILE pObjFile;
208	RTListForEach(&g_ObjList, pObjFile, BIOSOBJFILE, Node)
209	{
210	PRTSTREAM hStrm;
211	int rc = RTStrmOpen(pObjFile->pszSource, "r", &hStrm);
212	if (RT_SUCCESS(rc))
213	{
214	fRc = outputPrintf("\n"
215	";\n"
216	"; Source file: %Rbn\n"
217	";\n"
218	, pObjFile->pszSource);
219	uint32_t iLine = 0;
220	bool fSeenCopyright = false;
221	char szLine[4096];
222	while ((rc = RTStrmGetLine(hStrm, szLine, sizeof(szLine))) == VINF_SUCCESS)
223	{
224	iLine++;
225
226	/* Check if we're done. */
227	char *psz = RTStrStrip(szLine);
228	if ( fSeenCopyright
229	&& ( (psz[0] == '*' && psz[1] == '/')
230	\|\| psz[0] == '\0') )
231	break;
232
233	/* Strip comment suffix. */
234	size_t cch = strlen(psz);
235	if (cch >= 2 && psz[cch - 1] == '/' && psz[cch - 2] == '*')
236	{
237	psz[cch - 2] = '\0';
238	RTStrStripR(psz);
239	}
240
241	/* Skip line prefix. */
242	if (psz[0] == '/' && psz[1] == '*')
243	psz += 2;
244	else if (psz[0] == '*')
245	psz += 1;
246	else
247	while (*psz == ';')
248	psz++;
249	if (RT_C_IS_SPACE(*psz))
250	psz++;
251
252	/* Skip the doxygen file tag line. */
253	if (!strcmp(psz, "* @file") \|\| !strcmp(psz, "@file"))
254	continue;
255
256	/* Detect copyright section. */
257	if ( !fSeenCopyright
258	&& ( strstr(psz, "Copyright")
259	\|\| strstr(psz, "copyright")) )
260	fSeenCopyright = true;
261
262	/* Detect LGPL. */
263	if (strstr(psz, "LGPL"))
264	fNeedLgplDisclaimer = true;
265
266	fRc = outputPrintf("; %s\n", psz) && fRc;
267	}
268
269	RTStrmClose(hStrm);
270	if (rc != VINF_SUCCESS)
271	return disError("Error reading '%s': rc=%Rrc iLine=%u", pObjFile->pszSource, rc, iLine);
272	}
273	}
274
275	/*
276	* Add Oracle LGPL disclaimer.
277	*/
278	if (fNeedLgplDisclaimer)
279	outputPrintf("\n"
280	";\n"
281	"; Oracle LGPL Disclaimer: For the avoidance of doubt, except that if any license choice\n"
282	"; other than GPL or LGPL is available it will apply instead, Oracle elects to use only\n"
283	"; the Lesser General Public License version 2.1 (LGPLv2) at this time for any software where\n"
284	"; a choice of LGPL license versions is made available with the language indicating\n"
285	"; that LGPLv2 or any later version may be used, or where a choice of which version\n"
286	"; of the LGPL is applied is otherwise unspecified.\n"
287	";\n"
288	"\n");
289
290	/*
291	* Set the org.
292	*/
293	fRc = outputPrintf("\n"
294	"\n"
295	"\n"
296	) && fRc;
297	return fRc;
298	}
299
300
301	/**
302	* Checks if a byte sequence could be a string litteral.
303	*
304	* @returns @c true if it is, @c false if it isn't.
305	* @param uFlatAddr The address of the byte sequence.
306	* @param cb The length of the sequence.
307	*/
308	static bool disIsString(uint32_t uFlatAddr, uint32_t cb)
309	{
310	if (cb < 6)
311	return false;
312
313	uint8_t const *pb = &g_pbImg[uFlatAddr - g_uBiosFlatBase];
314	while (cb > 0)
315	{
316	if ( !RT_C_IS_PRINT(*pb)
317	&& *pb != '\r'
318	&& *pb != '\n'
319	&& *pb != '\t')
320	{
321	if (*pb == '\0')
322	{
323	do
324	{
325	pb++;
326	cb--;
327	} while (cb > 0 && *pb == '\0');
328	return cb == 0;
329	}
330	return false;
331	}
332	pb++;
333	cb--;
334	}
335
336	return true;
337	}
338
339
340	#if 0 /* unused */
341	/**
342	* Checks if a dword could be a far 16:16 BIOS address.
343	*
344	* @returns @c true if it is, @c false if it isn't.
345	* @param uFlatAddr The address of the dword.
346	*/
347	static bool disIsFarBiosAddr(uint32_t uFlatAddr)
348	{
349	uint16_t const pu16 = (uint16_t const )&g_pbImg[uFlatAddr - g_uBiosFlatBase];
350	if (pu16[1] < 0xf000)
351	return false;
352	if (pu16[1] > 0xfff0)
353	return false;
354	uint32_t uFlatAddr2 = (uint32_t)(pu16[1] << 4) \| pu16[0];
355	if (uFlatAddr2 >= g_uBiosFlatBase + g_cbImg)
356	return false;
357	return true;
358	}
359	#endif
360
361
362	static bool disByteData(uint32_t uFlatAddr, uint32_t cb)
363	{
364	uint8_t const *pb = &g_pbImg[uFlatAddr - g_uBiosFlatBase];
365	size_t cbOnLine = 0;
366	while (cb-- > 0)
367	{
368	bool fRc;
369	if (cbOnLine >= 16)
370	{
371	fRc = outputPrintf("\n"
372	" db 0%02xh", *pb);
373	cbOnLine = 1;
374	}
375	else if (!cbOnLine)
376	{
377	fRc = outputPrintf(" db 0%02xh", *pb);
378	cbOnLine = 1;
379	}
380	else
381	{
382	fRc = outputPrintf(", 0%02xh", *pb);
383	cbOnLine++;
384	}
385	if (!fRc)
386	return false;
387	pb++;
388	}
389	return outputPrintf("\n");
390	}
391
392
393	static bool disWordData(uint32_t uFlatAddr, uint32_t cb)
394	{
395	if (cb & 1)
396	return disError("disWordData expects word aligned size: cb=%#x uFlatAddr=%#x", uFlatAddr, cb);
397
398	uint16_t const pu16 = (uint16_t const )&g_pbImg[uFlatAddr - g_uBiosFlatBase];
399	size_t cbOnLine = 0;
400	while (cb > 0)
401	{
402	bool fRc;
403	if (cbOnLine >= 16)
404	{
405	fRc = outputPrintf("\n"
406	" dw 0%04xh", *pu16);
407	cbOnLine = 2;
408	}
409	else if (!cbOnLine)
410	{
411	fRc = outputPrintf(" dw 0%04xh", *pu16);
412	cbOnLine = 2;
413	}
414	else
415	{
416	fRc = outputPrintf(", 0%04xh", *pu16);
417	cbOnLine += 2;
418	}
419	if (!fRc)
420	return false;
421	pu16++;
422	cb -= 2;
423	}
424	return outputPrintf("\n");
425	}
426
427
428	static bool disDWordData(uint32_t uFlatAddr, uint32_t cb)
429	{
430	if (cb & 3)
431	return disError("disWordData expects dword aligned size: cb=%#x uFlatAddr=%#x", uFlatAddr, cb);
432
433	uint32_t const pu32 = (uint32_t const )&g_pbImg[uFlatAddr - g_uBiosFlatBase];
434	size_t cbOnLine = 0;
435	while (cb > 0)
436	{
437	bool fRc;
438	if (cbOnLine >= 16)
439	{
440	fRc = outputPrintf("\n"
441	" dd 0%08xh", *pu32);
442	cbOnLine = 4;
443	}
444	else if (!cbOnLine)
445	{
446	fRc = outputPrintf(" dd 0%08xh", *pu32);
447	cbOnLine = 4;
448	}
449	else
450	{
451	fRc = outputPrintf(", 0%08xh", *pu32);
452	cbOnLine += 4;
453	}
454	if (!fRc)
455	return false;
456	pu32++;
457	cb -= 4;
458	}
459	return outputPrintf("\n");
460	}
461
462
463	static bool disStringData(uint32_t uFlatAddr, uint32_t cb)
464	{
465	uint8_t const *pb = &g_pbImg[uFlatAddr - g_uBiosFlatBase];
466	uint32_t cchOnLine = 0;
467	while (cb > 0)
468	{
469	/* Line endings and beginnings. */
470	if (cchOnLine >= 72)
471	{
472	if (!outputPrintf("\n"))
473	return false;
474	cchOnLine = 0;
475	}
476	if ( !cchOnLine
477	&& !outputPrintf(" db "))
478	return false;
479
480	/* See how many printable character we've got. */
481	uint32_t cchPrintable = 0;
482	while ( cchPrintable < cb
483	&& RT_C_IS_PRINT(pb[cchPrintable])
484	&& pb[cchPrintable] != '\'')
485	cchPrintable++;
486
487	bool fRc = true;
488	if (cchPrintable)
489	{
490	if (cchPrintable + cchOnLine > 72)
491	cchPrintable = 72 - cchOnLine;
492	if (cchOnLine)
493	{
494	fRc = outputPrintf(", '%.*s'", cchPrintable, pb);
495	cchOnLine += 4 + cchPrintable;
496	}
497	else
498	{
499	fRc = outputPrintf("'%.*s'", cchPrintable, pb);
500	cchOnLine += 2 + cchPrintable;
501	}
502	pb += cchPrintable;
503	cb -= cchPrintable;
504	}
505	else
506	{
507	if (cchOnLine)
508	{
509	fRc = outputPrintf(", 0%02xh", *pb);
510	cchOnLine += 6;
511	}
512	else
513	{
514	fRc = outputPrintf("0%02xh", *pb);
515	cchOnLine += 4;
516	}
517	pb++;
518	cb--;
519	}
520	if (!fRc)
521	return false;
522	}
523	return outputPrintf("\n");
524	}
525
526
527	/**
528	* For dumping a portion of a string table.
529	*
530	* @returns @c true on success, @c false on failure.
531	* @param uFlatAddr The start address.
532	* @param cb The size of the string table.
533	*/
534	static bool disStringsData(uint32_t uFlatAddr, uint32_t cb)
535	{
536	uint8_t const *pb = &g_pbImg[uFlatAddr - g_uBiosFlatBase];
537	uint32_t cchOnLine = 0;
538	uint8_t bPrev = 255;
539	while (cb > 0)
540	{
541	/* Line endings and beginnings. */
542	if ( cchOnLine >= 72
543	\|\| (bPrev == '\0' && *pb != '\0'))
544	{
545	if (!outputPrintf("\n"))
546	return false;
547	cchOnLine = 0;
548	}
549	if ( !cchOnLine
550	&& !outputPrintf(" db "))
551	return false;
552
553	/* See how many printable character we've got. */
554	uint32_t cchPrintable = 0;
555	while ( cchPrintable < cb
556	&& RT_C_IS_PRINT(pb[cchPrintable])
557	&& pb[cchPrintable] != '\'')
558	cchPrintable++;
559
560	bool fRc = true;
561	if (cchPrintable)
562	{
563	if (cchPrintable + cchOnLine > 72)
564	cchPrintable = 72 - cchOnLine;
565	if (cchOnLine)
566	{
567	fRc = outputPrintf(", '%.*s'", cchPrintable, pb);
568	cchOnLine += 4 + cchPrintable;
569	}
570	else
571	{
572	fRc = outputPrintf("'%.*s'", cchPrintable, pb);
573	cchOnLine += 2 + cchPrintable;
574	}
575	pb += cchPrintable;
576	cb -= cchPrintable;
577	}
578	else
579	{
580	if (cchOnLine)
581	{
582	fRc = outputPrintf(", 0%02xh", *pb);
583	cchOnLine += 6;
584	}
585	else
586	{
587	fRc = outputPrintf("0%02xh", *pb);
588	cchOnLine += 4;
589	}
590	pb++;
591	cb--;
592	}
593	if (!fRc)
594	return false;
595	bPrev = pb[-1];
596	}
597	return outputPrintf("\n");
598	}
599
600
601	/**
602	* Minds the gap between two segments.
603	*
604	* Gaps should generally be zero filled.
605	*
606	* @returns @c true on success, @c false on failure.
607	* @param uFlatAddr The address of the gap.
608	* @param cbPadding The size of the gap.
609	*/
610	static bool disCopySegmentGap(uint32_t uFlatAddr, uint32_t cbPadding)
611	{
612	if (g_cVerbose > 0)
613	outputPrintf("\n"
614	" ; Padding %#x bytes at %#x\n", cbPadding, uFlatAddr);
615	uint8_t const *pb = &g_pbImg[uFlatAddr - g_uBiosFlatBase];
616	if (ASMMemIsZero(pb, cbPadding))
617	return outputPrintf(" times %u db 0\n", cbPadding);
618
619	return disByteData(uFlatAddr, cbPadding);
620	}
621
622
623	/**
624	* Worker for disGetNextSymbol that only does the looking up, no RTDBSYMBOL::cb
625	* calc.
626	*
627	* @param uFlatAddr The address to start searching at.
628	* @param cbMax The size of the search range.
629	* @param poff Where to return the offset between the symbol
630	* and @a uFlatAddr.
631	* @param pSym Where to return the symbol data.
632	*/
633	static void disGetNextSymbolWorker(uint32_t uFlatAddr, uint32_t cbMax, uint32_t *poff, PRTDBGSYMBOL pSym)
634	{
635	RTINTPTR off = 0;
636	int rc = RTDbgModSymbolByAddr(g_hMapMod, RTDBGSEGIDX_RVA, uFlatAddr, RTDBGSYMADDR_FLAGS_GREATER_OR_EQUAL, &off, pSym);
637	if (RT_SUCCESS(rc))
638	{
639	/* negative offset, indicates beyond. */
640	if (off <= 0)
641	{
642	*poff = (uint32_t)-off;
643	return;
644	}
645
646	outputPrintf(" ; !! RTDbgModSymbolByAddr(,,%#x,,) -> off=%RTptr cb=%RTptr uValue=%RTptr '%s'\n",
647	uFlatAddr, off, pSym->cb, pSym->Value, pSym->szName);
648	}
649	else if (rc != VERR_SYMBOL_NOT_FOUND)
650	outputPrintf(" ; !! RTDbgModSymbolByAddr(,,%#x,,) -> %Rrc\n", uFlatAddr, rc);
651
652	RTStrPrintf(pSym->szName, sizeof(pSym->szName), "_dummy_addr_%#x", uFlatAddr + cbMax);
653	pSym->Value = uFlatAddr + cbMax;
654	pSym->cb = 0;
655	pSym->offSeg = uFlatAddr + cbMax;
656	pSym->iSeg = RTDBGSEGIDX_RVA;
657	pSym->iOrdinal = 0;
658	pSym->fFlags = 0;
659	*poff = cbMax;
660	}
661
662
663	/**
664	* Gets the symbol at or after the given address.
665	*
666	* If there are no symbols in the specified range, @a pSym and @a poff will be
667	* set up to indicate a symbol at the first byte after the range.
668	*
669	* @param uFlatAddr The address to start searching at.
670	* @param cbMax The size of the search range.
671	* @param poff Where to return the offset between the symbol
672	* and @a uFlatAddr.
673	* @param pSym Where to return the symbol data.
674	*/
675	static void disGetNextSymbol(uint32_t uFlatAddr, uint32_t cbMax, uint32_t *poff, PRTDBGSYMBOL pSym)
676	{
677	disGetNextSymbolWorker(uFlatAddr, cbMax, poff, pSym);
678	if ( *poff < cbMax
679	&& pSym->cb == 0)
680	{
681	if (*poff + 1 < cbMax)
682	{
683	uint32_t off2;
684	RTDBGSYMBOL Sym2;
685	disGetNextSymbolWorker(uFlatAddr + poff + 1, cbMax - poff - 1, &off2, &Sym2);
686	pSym->cb = off2 + 1;
687	}
688	else
689	pSym->cb = 1;
690	}
691	if (pSym->cb > cbMax - *poff)
692	pSym->cb = cbMax - *poff;
693
694	if (g_cVerbose > 1)
695	outputPrintf(" ; disGetNextSymbol %#x LB %#x -> off=%#x cb=%RTptr uValue=%RTptr '%s'\n",
696	uFlatAddr, cbMax, *poff, pSym->cb, pSym->Value, pSym->szName);
697
698	}
699
700
701	/**
702	* For dealing with the const segment (string constants).
703	*
704	* @returns @c true on success, @c false on failure.
705	* @param iSeg The segment.
706	*/
707	static bool disConstSegment(uint32_t iSeg)
708	{
709	uint32_t uFlatAddr = g_aSegs[iSeg].uFlatAddr;
710	uint32_t cb = g_aSegs[iSeg].cb;
711
712	while (cb > 0)
713	{
714	uint32_t off;
715	RTDBGSYMBOL Sym;
716	disGetNextSymbol(uFlatAddr, cb, &off, &Sym);
717
718	if (off > 0)
719	{
720	if (!disStringsData(uFlatAddr, off))
721	return false;
722	cb -= off;
723	uFlatAddr += off;
724	off = 0;
725	if (!cb)
726	break;
727	}
728
729	bool fRc;
730	if (off == 0)
731	{
732	size_t cchName = strlen(Sym.szName);
733	fRc = outputPrintf("%s: %*s; %#x LB %#x\n", Sym.szName, cchName < 41 - 2 ? cchName - 41 - 2 : 0, "", uFlatAddr, Sym.cb);
734	if (!fRc)
735	return false;
736	fRc = disStringsData(uFlatAddr, Sym.cb);
737	uFlatAddr += Sym.cb;
738	cb -= Sym.cb;
739	}
740	else
741	{
742	fRc = disStringsData(uFlatAddr, Sym.cb);
743	uFlatAddr += cb;
744	cb = 0;
745	}
746	if (!fRc)
747	return false;
748	}
749
750	return true;
751	}
752
753
754
755	static bool disDataSegment(uint32_t iSeg)
756	{
757	uint32_t uFlatAddr = g_aSegs[iSeg].uFlatAddr;
758	uint32_t cb = g_aSegs[iSeg].cb;
759
760	while (cb > 0)
761	{
762	uint32_t off;
763	RTDBGSYMBOL Sym;
764	disGetNextSymbol(uFlatAddr, cb, &off, &Sym);
765
766	if (off > 0)
767	{
768	if (!disByteData(uFlatAddr, off))
769	return false;
770	cb -= off;
771	uFlatAddr += off;
772	off = 0;
773	if (!cb)
774	break;
775	}
776
777	bool fRc;
778	if (off == 0)
779	{
780	size_t cchName = strlen(Sym.szName);
781	fRc = outputPrintf("%s: %*s; %#x LB %#x\n", Sym.szName, cchName < 41 - 2 ? cchName - 41 - 2 : 0, "", uFlatAddr, Sym.cb);
782	if (!fRc)
783	return false;
784
785	if (Sym.cb == 2)
786	fRc = disWordData(uFlatAddr, 2);
787	//else if (Sym.cb == 4 && disIsFarBiosAddr(uFlatAddr))
788	// fRc = disDWordData(uFlatAddr, 4);
789	else if (Sym.cb == 4)
790	fRc = disDWordData(uFlatAddr, 4);
791	else if (disIsString(uFlatAddr, Sym.cb))
792	fRc = disStringData(uFlatAddr, Sym.cb);
793	else
794	fRc = disByteData(uFlatAddr, Sym.cb);
795
796	uFlatAddr += Sym.cb;
797	cb -= Sym.cb;
798	}
799	else
800	{
801	fRc = disByteData(uFlatAddr, cb);
802	uFlatAddr += cb;
803	cb = 0;
804	}
805	if (!fRc)
806	return false;
807	}
808
809	return true;
810	}
811
812
813	static bool disIsCodeAndAdjustSize(uint32_t uFlatAddr, PRTDBGSYMBOL pSym, PBIOSSEG pSeg)
814	{
815	RT_NOREF_PV(uFlatAddr);
816
817	switch (g_enmBiosType)
818	{
819	/*
820	* This is for the PC BIOS.
821	*/
822	case kBiosType_System:
823	if (!strcmp(pSeg->szName, "BIOSSEG"))
824	{
825	if ( !strcmp(pSym->szName, "rom_fdpt")
826	\|\| !strcmp(pSym->szName, "pmbios_gdt")
827	\|\| !strcmp(pSym->szName, "pmbios_gdt_desc")
828	\|\| !strcmp(pSym->szName, "_pmode_IDT")
829	\|\| !strcmp(pSym->szName, "_rmode_IDT")
830	\|\| !strncmp(pSym->szName, RT_STR_TUPLE("font"))
831	\|\| !strcmp(pSym->szName, "bios_string")
832	\|\| !strcmp(pSym->szName, "vector_table")
833	\|\| !strcmp(pSym->szName, "pci_routing_table_structure")
834	\|\| !strcmp(pSym->szName, "_pci_routing_table")
835	)
836	return false;
837	}
838
839	if (!strcmp(pSym->szName, "cpu_reset"))
840	pSym->cb = RT_MIN(pSym->cb, 5);
841	else if (!strcmp(pSym->szName, "pci_init_end"))
842	pSym->cb = RT_MIN(pSym->cb, 3);
843	break;
844
845	/*
846	* This is for the VGA BIOS.
847	*/
848	case kBiosType_Vga:
849	break;
850	}
851
852	return true;
853	}
854
855
856	static bool disIs16BitCode(const char *pszSymbol)
857	{
858	RT_NOREF_PV(pszSymbol);
859	return true;
860	}
861
862
863	/**
864	* Deals with instructions that YASM will assemble differently than WASM/WCC.
865	*/
866	static size_t disHandleYasmDifferences(PDISCPUSTATE pCpuState, uint32_t uFlatAddr, uint32_t cbInstr,
867	char *pszBuf, size_t cbBuf, size_t cchUsed)
868	{
869	bool fDifferent = DISFormatYasmIsOddEncoding(pCpuState);
870	uint8_t const *pb = &g_pbImg[uFlatAddr - g_uBiosFlatBase];
871
872	/*
873	* Disassembler bugs.
874	*/
875	/** @todo Group 1a and 11 seems to be disassembled incorrectly when
876	* modrm.reg != 0. Those encodings should be invalid AFAICT. */
877
878	if ( ( pCpuState->bOpCode == 0x8f /* group 1a */
879	\|\| pCpuState->bOpCode == 0xc7 /* group 11 */
880	\|\| pCpuState->bOpCode == 0xc6 /* group 11 - not verified */
881	)
882	&& pCpuState->ModRM.Bits.Reg != 0)
883	fDifferent = true;
884	/*
885	* Check these out and consider adding them to DISFormatYasmIsOddEncoding.
886	*/
887	else if ( pb[0] == 0xf3
888	&& pb[1] == 0x66
889	&& pb[2] == 0x6d)
890	fDifferent = true; /* rep insd - prefix switched. */
891	else if ( pb[0] == 0xc6
892	&& pb[1] == 0xc5
893	&& pb[2] == 0xba)
894	fDifferent = true; /* mov ch, 0bah - yasm uses a short sequence: 0xb5 0xba. */
895
896	/*
897	* 32-bit retf.
898	*/
899	else if ( pb[0] == 0x66
900	&& pb[1] == 0xcb)
901	fDifferent = true;
902
903	/*
904	* Handle different stuff.
905	*/
906	if (fDifferent)
907	{
908	disByteData(uFlatAddr, cbInstr); /* lazy bird. */
909
910	if (cchUsed + 2 < cbBuf)
911	{
912	memmove(pszBuf + 2, pszBuf, cchUsed + 1); /* include terminating \0 */
913	cchUsed += 2;
914	}
915
916	pszBuf[0] = ';';
917	pszBuf[1] = ' ';
918	}
919
920	return cchUsed;
921	}
922
923
924	/**
925	* @callback_method_impl{FNDISREADBYTES}
926	*
927	* @remarks @a uSrcAddr is the flat address.
928	*/
929	static DECLCALLBACK(int) disReadOpcodeBytes(PDISCPUSTATE pDis, uint8_t offInstr, uint8_t cbMinRead, uint8_t cbMaxRead)
930	{
931	RT_NOREF_PV(cbMinRead);
932
933	RTUINTPTR offBios = pDis->uInstrAddr + offInstr - g_uBiosFlatBase;
934	size_t cbToRead = cbMaxRead;
935	if (offBios + cbToRead > g_cbImg)
936	{
937	if (offBios >= g_cbImg)
938	cbToRead = 0;
939	else
940	cbToRead = g_cbImg - offBios;
941	}
942	memcpy(&pDis->abInstr[offInstr], &g_pbImg[offBios], cbToRead);
943	pDis->cbCachedInstr = (uint8_t)(offInstr + cbToRead);
944	return VINF_SUCCESS;
945	}
946
947
948	/**
949	* Disassembles code.
950	*
951	* @returns @c true on success, @c false on failure.
952	* @param uFlatAddr The address where the code starts.
953	* @param cb The amount of code to disassemble.
954	* @param fIs16Bit Is is 16-bit (@c true) or 32-bit (@c false).
955	*/
956	static bool disCode(uint32_t uFlatAddr, uint32_t cb, bool fIs16Bit)
957	{
958	uint8_t const *pb = &g_pbImg[uFlatAddr - g_uBiosFlatBase];
959
960	while (cb > 0)
961	{
962	/* Trailing zero padding detection. */
963	if ( *pb == '\0'
964	&& ASMMemIsZero(pb, RT_MIN(cb, 8)))
965	{
966	void *pv = ASMMemFirstNonZero(pb, cb);
967	uint32_t cbZeros = pv ? (uint32_t)((uint8_t const *)pv - pb) : cb;
968	if (!outputPrintf(" times %#x db 0\n", cbZeros))
969	return false;
970	cb -= cbZeros;
971	pb += cbZeros;
972	uFlatAddr += cbZeros;
973	if ( cb == 2
974	&& pb[0] == 'X'
975	&& pb[1] == 'M')
976	return disStringData(uFlatAddr, cb);
977	}
978	/* Work arounds for switch tables and such (disas assertions). */
979	else if ( 0
980	\|\| ( pb[0] == 0x50 /* int13_cdemu switch */
981	&& pb[1] == 0x4e
982	&& pb[2] == 0x49
983	&& pb[3] == 0x48
984	&& pb[4] == 0x47
985	)
986	\|\| ( pb[0] == 0x8b /* _int13_harddisk_ext switch */
987	&& pb[1] == 0x46
988	&& pb[2] == 0x16
989	&& pb[3] == 0x30
990	&& pb[4] == 0xe8
991	&& pb[5] == 0x80
992	)
993	\|\| ( pb[0] == 0xd8
994	&& pb[1] == 0x5f
995	&& pb[2] == 0x0b
996	&& pb[3] == 0x60
997	&& pb[4] == 0x0b
998	&& pb[5] == 0x60
999	)
1000	\|\| ( pb[0] == 0x67 /* _pci16_function switch */
1001	&& pb[1] == 0x92
1002	&& pb[2] == 0x81
1003	&& pb[3] == 0x92
1004	&& pb[4] == 0x94
1005	&& pb[5] == 0x92
1006	)
1007	\|\| ( pb[0] == 0xa3 /* _int1a_function switch */
1008	&& pb[1] == 0x67
1009	&& pb[2] == 0xca
1010	&& pb[3] == 0x67
1011	&& pb[4] == 0xef
1012	&& pb[5] == 0x67
1013	)
1014	\|\| ( pb[0] == 0x0b /* _ahci_init byte table */
1015	&& pb[1] == 0x05
1016	&& pb[2] == 0x04
1017	&& pb[3] == 0x03
1018	&& pb[4] == 0x02
1019	&& pb[5] == 0x01
1020	)
1021	\|\| ( pb[0] == 0x00 /* bytes after apm_out_str_ */
1022	&& pb[1] == 0x00
1023	&& pb[2] == 0x00
1024	&& pb[3] == 0x00
1025	&& pb[4] == 0x00
1026	&& pb[5] == 0x00
1027	&& pb[6] == 0xe0
1028	&& pb[7] == 0xa0
1029	&& pb[8] == 0xe2
1030	&& pb[9] == 0xa0
1031	)
1032	\|\| ( pb[0] == 0xf0 /* switch for apm_worker */
1033	&& pb[1] == 0xa0
1034	&& pb[2] == 0xf2
1035	&& pb[3] == 0xa0
1036	&& pb[4] == 0xf6
1037	&& pb[5] == 0xa0
1038	)
1039	\|\| ( pb[0] == 0xd4
1040	&& pb[1] == 0xc6
1041	&& pb[2] == 0xc5
1042	&& pb[3] == 0xba
1043	&& pb[4] == 0xb8
1044	&& pb[5] == 0xb6
1045	)
1046	\|\| ( pb[0] == 0xec /* _int15_function switch */
1047	&& pb[1] == 0xe9
1048	&& pb[2] == 0xd8
1049	&& pb[3] == 0xc1
1050	&& pb[4] == 0xc0
1051	&& pb[5] == 0xbf
1052	)
1053	\|\| ( pb[0] == 0x21 /* _int15_function32 switch */
1054	&& pb[1] == 0x66
1055	&& pb[2] == 0x43
1056	&& pb[3] == 0x66
1057	&& pb[4] == 0x66
1058	&& pb[5] == 0x66
1059	)
1060	\|\| ( pb[0] == 0xf0 /* int15_function_mouse switch */
1061	&& pb[1] == 0x75
1062	&& pb[2] == 0x66
1063	&& pb[3] == 0x76
1064	&& pb[4] == 0xe9
1065	&& pb[5] == 0x76
1066	)
1067	\|\| ( pb[0] == 0x60
1068	&& pb[1] == 0xa0
1069	&& pb[2] == 0x62
1070	&& pb[3] == 0xa0
1071	&& pb[4] == 0x66
1072	&& pb[5] == 0xa0
1073	)
1074	\|\| 0
1075	)
1076	return disByteData(uFlatAddr, cb);
1077	else
1078	{
1079	unsigned cbInstr;
1080	DISCPUSTATE CpuState;
1081	int rc = DISInstrWithReader(uFlatAddr, fIs16Bit ? DISCPUMODE_16BIT : DISCPUMODE_32BIT,
1082	disReadOpcodeBytes, NULL, &CpuState, &cbInstr);
1083	if ( RT_SUCCESS(rc)
1084	&& cbInstr <= cb
1085	&& CpuState.pCurInstr
1086	&& CpuState.pCurInstr->uOpcode != OP_INVALID)
1087	{
1088	char szTmp[4096];
1089	size_t cch = DISFormatYasmEx(&CpuState, szTmp, sizeof(szTmp),
1090	DIS_FMT_FLAGS_STRICT
1091	\| DIS_FMT_FLAGS_BYTES_RIGHT \| DIS_FMT_FLAGS_BYTES_COMMENT \| DIS_FMT_FLAGS_BYTES_SPACED,
1092	NULL, NULL);
1093	cch = disHandleYasmDifferences(&CpuState, uFlatAddr, cbInstr, szTmp, sizeof(szTmp), cch);
1094	Assert(cch < sizeof(szTmp));
1095
1096	if (g_cVerbose > 1)
1097	{
1098	while (cch < 72)
1099	szTmp[cch++] = ' ';
1100	RTStrPrintf(&szTmp[cch], sizeof(szTmp) - cch, "; %#x", uFlatAddr);
1101	}
1102
1103	if (!outputPrintf(" %s\n", szTmp))
1104	return false;
1105	cb -= cbInstr;
1106	pb += cbInstr;
1107	uFlatAddr += cbInstr;
1108	}
1109	else
1110	{
1111	if (!disByteData(uFlatAddr, 1))
1112	return false;
1113	cb--;
1114	pb++;
1115	uFlatAddr++;
1116	}
1117	}
1118	}
1119	return true;
1120	}
1121
1122
1123	static bool disCodeSegment(uint32_t iSeg)
1124	{
1125	uint32_t uFlatAddr = g_aSegs[iSeg].uFlatAddr;
1126	uint32_t cb = g_aSegs[iSeg].cb;
1127
1128	while (cb > 0)
1129	{
1130	uint32_t off;
1131	RTDBGSYMBOL Sym;
1132	disGetNextSymbol(uFlatAddr, cb, &off, &Sym);
1133
1134	if (off > 0)
1135	{
1136	if (!disByteData(uFlatAddr, off))
1137	return false;
1138	cb -= off;
1139	uFlatAddr += off;
1140	off = 0;
1141	if (!cb)
1142	break;
1143	}
1144
1145	bool fRc;
1146	if (off == 0)
1147	{
1148	size_t cchName = strlen(Sym.szName);
1149	fRc = outputPrintf("%s: %*s; %#x LB %#x\n", Sym.szName, cchName < 41 - 2 ? cchName - 41 - 2 : 0, "", uFlatAddr, Sym.cb);
1150	if (!fRc)
1151	return false;
1152
1153	if (disIsCodeAndAdjustSize(uFlatAddr, &Sym, &g_aSegs[iSeg]))
1154	fRc = disCode(uFlatAddr, Sym.cb, disIs16BitCode(Sym.szName));
1155	else
1156	fRc = disByteData(uFlatAddr, Sym.cb);
1157
1158	uFlatAddr += Sym.cb;
1159	cb -= Sym.cb;
1160	}
1161	else
1162	{
1163	fRc = disByteData(uFlatAddr, cb);
1164	uFlatAddr += cb;
1165	cb = 0;
1166	}
1167	if (!fRc)
1168	return false;
1169	}
1170
1171	return true;
1172	}
1173
1174
1175	static RTEXITCODE DisassembleBiosImage(void)
1176	{
1177	if (!disFileHeader())
1178	return RTEXITCODE_FAILURE;
1179
1180	/*
1181	* Work the image segment by segment.
1182	*/
1183	bool fRc = true;
1184	uint32_t uFlatAddr = g_uBiosFlatBase;
1185	for (uint32_t iSeg = 0; iSeg < g_cSegs && fRc; iSeg++)
1186	{
1187	/* Is there a gap between the segments? */
1188	if (uFlatAddr < g_aSegs[iSeg].uFlatAddr)
1189	{
1190	fRc = disCopySegmentGap(uFlatAddr, g_aSegs[iSeg].uFlatAddr - uFlatAddr);
1191	if (!fRc)
1192	break;
1193	uFlatAddr = g_aSegs[iSeg].uFlatAddr;
1194	}
1195	else if (uFlatAddr > g_aSegs[iSeg].uFlatAddr)
1196	return RTMsgErrorExit(RTEXITCODE_FAILURE, "Overlapping segments: %u and %u; uFlatAddr=%#x\n", iSeg - 1, iSeg, uFlatAddr);
1197
1198	/* Disassemble the segment. */
1199	fRc = outputPrintf("\n"
1200	"section %s progbits vstart=%#x align=1 ; size=%#x class=%s group=%s\n",
1201	g_aSegs[iSeg].szName, g_aSegs[iSeg].uFlatAddr - g_uBiosFlatBase,
1202	g_aSegs[iSeg].cb, g_aSegs[iSeg].szClass, g_aSegs[iSeg].szGroup);
1203	if (!fRc)
1204	return RTEXITCODE_FAILURE;
1205	if (!strcmp(g_aSegs[iSeg].szName, "CONST"))
1206	fRc = disConstSegment(iSeg);
1207	else if (!strcmp(g_aSegs[iSeg].szClass, "DATA"))
1208	fRc = disDataSegment(iSeg);
1209	else
1210	fRc = disCodeSegment(iSeg);
1211
1212	/* Advance. */
1213	uFlatAddr += g_aSegs[iSeg].cb;
1214	}
1215
1216	/* Final gap. */
1217	if (uFlatAddr < g_uBiosFlatBase + g_cbImg)
1218	fRc = disCopySegmentGap(uFlatAddr, (uint32_t)(g_uBiosFlatBase + g_cbImg - uFlatAddr));
1219	else if (uFlatAddr > g_uBiosFlatBase + g_cbImg)
1220	return RTMsgErrorExit(RTEXITCODE_FAILURE, "Last segment spills beyond 1MB; uFlatAddr=%#x\n", uFlatAddr);
1221
1222	if (!fRc)
1223	return RTEXITCODE_FAILURE;
1224	return RTEXITCODE_SUCCESS;
1225	}
1226
1227
1228
1229	/**
1230	* Parses the symbol file for the BIOS.
1231	*
1232	* This is in ELF/DWARF format.
1233	*
1234	* @returns RTEXITCODE_SUCCESS or RTEXITCODE_FAILURE+msg.
1235	* @param pszBiosSym Path to the sym file.
1236	*/
1237	static RTEXITCODE ParseSymFile(const char *pszBiosSym)
1238	{
1239	#if 1
1240	/** @todo use RTDbg* later. (Just checking for existance currently.) */
1241	PRTSTREAM hStrm;
1242	int rc = RTStrmOpen(pszBiosSym, "rb", &hStrm);
1243	if (RT_FAILURE(rc))
1244	return RTMsgErrorExit(RTEXITCODE_FAILURE, "Error opening '%s': %Rrc", pszBiosSym, rc);
1245	RTStrmClose(hStrm);
1246	#else
1247	RTDBGMOD hDbgMod;
1248	int rc = RTDbgModCreateFromImage(&hDbgMod, pszBiosSym, "VBoxBios", 0 /fFlags/);
1249	RTMsgInfo("RTDbgModCreateFromImage -> %Rrc\n", rc);
1250	#endif
1251	return RTEXITCODE_SUCCESS;
1252	}
1253
1254
1255	/**
1256	* Display an error with the mapfile name and current line, return false.
1257	*
1258	* @returns @c false.
1259	* @param pMap The map file handle.
1260	* @param pszFormat The format string.
1261	* @param ... Format arguments.
1262	*/
1263	static bool mapError(PBIOSMAP pMap, const char *pszFormat, ...)
1264	{
1265	va_list va;
1266	va_start(va, pszFormat);
1267	RTMsgError("%s:%d: %N", pMap->pszMapFile, pMap->iLine, pszFormat, va);
1268	va_end(va);
1269	return false;
1270	}
1271
1272
1273	/**
1274	* Reads a line from the file.
1275	*
1276	* @returns @c true on success, @c false + msg on failure, @c false on eof.
1277	* @param pMap The map file handle.
1278	*/
1279	static bool mapReadLine(PBIOSMAP pMap)
1280	{
1281	int rc = RTStrmGetLine(pMap->hStrm, pMap->szLine, sizeof(pMap->szLine));
1282	if (RT_FAILURE(rc))
1283	{
1284	if (rc == VERR_EOF)
1285	{
1286	pMap->fEof = true;
1287	pMap->cch = 0;
1288	pMap->offNW = 0;
1289	pMap->szLine[0] = '\0';
1290	}
1291	else
1292	RTMsgError("%s:%d: Read error %Rrc", pMap->pszMapFile, pMap->iLine + 1, rc);
1293	return false;
1294	}
1295	pMap->iLine++;
1296	pMap->cch = (uint32_t)strlen(pMap->szLine);
1297
1298	/* Check out leading white space. */
1299	if (!RT_C_IS_SPACE(pMap->szLine[0]))
1300	pMap->offNW = 0;
1301	else
1302	{
1303	uint32_t off = 1;
1304	while (RT_C_IS_SPACE(pMap->szLine[off]))
1305	off++;
1306	pMap->offNW = off;
1307	}
1308
1309	return true;
1310	}
1311
1312
1313	/**
1314	* Checks if it is an empty line.
1315	* @returns @c true if empty, @c false if not.
1316	* @param pMap The map file handle.
1317	*/
1318	static bool mapIsEmptyLine(PBIOSMAP pMap)
1319	{
1320	Assert(pMap->offNW <= pMap->cch);
1321	return pMap->offNW == pMap->cch;
1322	}
1323
1324
1325	/**
1326	* Reads ahead in the map file until a non-empty line or EOF is encountered.
1327	*
1328	* @returns @c true on success, @c false + msg on failure, @c false on eof.
1329	* @param pMap The map file handle.
1330	*/
1331	static bool mapSkipEmptyLines(PBIOSMAP pMap)
1332	{
1333	for (;;)
1334	{
1335	if (!mapReadLine(pMap))
1336	return false;
1337	if (pMap->offNW < pMap->cch)
1338	return true;
1339	}
1340	}
1341
1342
1343	/**
1344	* Reads ahead in the map file until an empty line or EOF is encountered.
1345	*
1346	* @returns @c true on success, @c false + msg on failure, @c false on eof.
1347	* @param pMap The map file handle.
1348	*/
1349	static bool mapSkipNonEmptyLines(PBIOSMAP pMap)
1350	{
1351	for (;;)
1352	{
1353	if (!mapReadLine(pMap))
1354	return false;
1355	if (pMap->offNW == pMap->cch)
1356	return true;
1357	}
1358	}
1359
1360
1361	/**
1362	* Strips the current line.
1363	*
1364	* The string length may change.
1365	*
1366	* @returns Pointer to the first non-space character.
1367	* @param pMap The map file handle.
1368	* @param pcch Where to return the length of the unstripped
1369	* part. Optional.
1370	*/
1371	static char mapStripCurrentLine(PBIOSMAP pMap, size_t pcch)
1372	{
1373	char *psz = &pMap->szLine[pMap->offNW];
1374	char *pszEnd = &pMap->szLine[pMap->cch];
1375	while ( (uintptr_t)pszEnd > (uintptr_t)psz
1376	&& RT_C_IS_SPACE(pszEnd[-1]))
1377	{
1378	*--pszEnd = '\0';
1379	pMap->cch--;
1380	}
1381	if (pcch)
1382	*pcch = pszEnd - psz;
1383	return psz;
1384	}
1385
1386
1387	/**
1388	* Reads a line from the file and right strips it.
1389	*
1390	* @returns Pointer to szLine on success, @c NULL + msg on failure, @c NULL on
1391	* EOF.
1392	* @param pMap The map file handle.
1393	* @param pcch Where to return the length of the unstripped
1394	* part. Optional.
1395	*/
1396	static char mapReadLineStripRight(PBIOSMAP pMap, size_t pcch)
1397	{
1398	if (!mapReadLine(pMap))
1399	return NULL;
1400	mapStripCurrentLine(pMap, NULL);
1401	if (pcch)
1402	*pcch = pMap->cch;
1403	return pMap->szLine;
1404	}
1405
1406
1407	/**
1408	* mapReadLine() + mapStripCurrentLine().
1409	*
1410	* @returns Pointer to the first non-space character in the new line. NULL on
1411	* read error (bitched already) or end of file.
1412	* @param pMap The map file handle.
1413	* @param pcch Where to return the length of the unstripped
1414	* part. Optional.
1415	*/
1416	static char mapReadLineStrip(PBIOSMAP pMap, size_t pcch)
1417	{
1418	if (!mapReadLine(pMap))
1419	return NULL;
1420	return mapStripCurrentLine(pMap, pcch);
1421	}
1422
1423
1424	/**
1425	* Parses a word, copying it into the supplied buffer, and skipping any spaces
1426	* following it.
1427	*
1428	* @returns @c true on success, @c false on failure.
1429	* @param ppszCursor Pointer to the cursor variable.
1430	* @param pszBuf The output buffer.
1431	* @param cbBuf The size of the output buffer.
1432	*/
1433	static bool mapParseWord(char *ppszCursor, char pszBuf, size_t cbBuf)
1434	{
1435	/* Check that we start on a non-blank. */
1436	char pszStart = ppszCursor;
1437	if (!pszStart \|\| RT_C_IS_SPACE(pszStart))
1438	return false;
1439
1440	/* Find the end of the word. */
1441	char *psz = pszStart + 1;
1442	while (psz && !RT_C_IS_SPACE(psz))
1443	psz++;
1444
1445	/* Copy it. */
1446	size_t cchWord = (uintptr_t)psz - (uintptr_t)pszStart;
1447	if (cchWord >= cbBuf)
1448	return false;
1449	memcpy(pszBuf, pszStart, cchWord);
1450	pszBuf[cchWord] = '\0';
1451
1452	/* Skip blanks following it. */
1453	while (RT_C_IS_SPACE(*psz))
1454	psz++;
1455	*ppszCursor = psz;
1456	return true;
1457	}
1458
1459
1460	/**
1461	* Parses an 16:16 address.
1462	*
1463	* @returns @c true on success, @c false on failure.
1464	* @param ppszCursor Pointer to the cursor variable.
1465	* @param pAddr Where to return the address.
1466	*/
1467	static bool mapParseAddress(char **ppszCursor, PRTFAR16 pAddr)
1468	{
1469	char szWord[32];
1470	if (!mapParseWord(ppszCursor, szWord, sizeof(szWord)))
1471	return false;
1472	size_t cchWord = strlen(szWord);
1473
1474	/* An address is at least 16:16 format. It may be 16:32. It may also be flagged. */
1475	size_t cchAddr = 4 + 1 + 4;
1476	if (cchWord < cchAddr)
1477	return false;
1478	if ( !RT_C_IS_XDIGIT(szWord[0])
1479	\|\| !RT_C_IS_XDIGIT(szWord[1])
1480	\|\| !RT_C_IS_XDIGIT(szWord[2])
1481	\|\| !RT_C_IS_XDIGIT(szWord[3])
1482	\|\| szWord[4] != ':'
1483	\|\| !RT_C_IS_XDIGIT(szWord[5])
1484	\|\| !RT_C_IS_XDIGIT(szWord[6])
1485	\|\| !RT_C_IS_XDIGIT(szWord[7])
1486	\|\| !RT_C_IS_XDIGIT(szWord[8])
1487	)
1488	return false;
1489	if ( cchWord > cchAddr
1490	&& RT_C_IS_XDIGIT(szWord[9])
1491	&& RT_C_IS_XDIGIT(szWord[10])
1492	&& RT_C_IS_XDIGIT(szWord[11])
1493	&& RT_C_IS_XDIGIT(szWord[12]))
1494	cchAddr += 4;
1495
1496	/* Drop flag if present. */
1497	if (cchWord > cchAddr)
1498	{
1499	if (RT_C_IS_XDIGIT(szWord[cchAddr]))
1500	return false;
1501	szWord[cchAddr] = '\0';
1502	cchWord = cchAddr;
1503	}
1504
1505	/* Convert it. */
1506	szWord[4] = '\0';
1507	int rc1 = RTStrToUInt16Full(szWord, 16, &pAddr->sel);
1508	if (rc1 != VINF_SUCCESS)
1509	return false;
1510
1511	int rc2 = RTStrToUInt16Full(szWord + 5, 16, &pAddr->off);
1512	if (rc2 != VINF_SUCCESS)
1513	return false;
1514	return true;
1515	}
1516
1517
1518	/**
1519	* Parses a size.
1520	*
1521	* @returns @c true on success, @c false on failure.
1522	* @param ppszCursor Pointer to the cursor variable.
1523	* @param pcb Where to return the size.
1524	*/
1525	static bool mapParseSize(char *ppszCursor, uint32_t pcb)
1526	{
1527	char szWord[32];
1528	if (!mapParseWord(ppszCursor, szWord, sizeof(szWord)))
1529	return false;
1530	size_t cchWord = strlen(szWord);
1531	if (cchWord != 8)
1532	return false;
1533
1534	int rc = RTStrToUInt32Full(szWord, 16, pcb);
1535	if (rc != VINF_SUCCESS)
1536	return false;
1537	return true;
1538	}
1539
1540
1541	/**
1542	* Parses a section box and the following column header.
1543	*
1544	* @returns @c true on success, @c false + msg on failure, @c false on eof.
1545	* @param pMap Map file handle.
1546	* @param pszSectionNm The expected section name.
1547	* @param cColumns The number of columns.
1548	* @param ... The column names.
1549	*/
1550	static bool mapSkipThruColumnHeadings(PBIOSMAP pMap, const char *pszSectionNm, uint32_t cColumns, ...)
1551	{
1552	if ( mapIsEmptyLine(pMap)
1553	&& !mapSkipEmptyLines(pMap))
1554	return false;
1555
1556	/* +------------+ */
1557	size_t cch;
1558	char *psz = mapStripCurrentLine(pMap, &cch);
1559	if (!psz)
1560	return false;
1561
1562	if ( psz[0] != '+'
1563	\|\| psz[1] != '-'
1564	\|\| psz[2] != '-'
1565	\|\| psz[3] != '-'
1566	\|\| psz[cch - 4] != '-'
1567	\|\| psz[cch - 3] != '-'
1568	\|\| psz[cch - 2] != '-'
1569	\|\| psz[cch - 1] != '+'
1570	)
1571	{
1572	RTMsgError("%s:%d: Expected section box: +-----...", pMap->pszMapFile, pMap->iLine);
1573	return false;
1574	}
1575
1576	/* \| pszSectionNm \| */
1577	psz = mapReadLineStrip(pMap, &cch);
1578	if (!psz)
1579	return false;
1580
1581	size_t cchSectionNm = strlen(pszSectionNm);
1582	if ( psz[0] != '\|'
1583	\|\| psz[1] != ' '
1584	\|\| psz[2] != ' '
1585	\|\| psz[3] != ' '
1586	\|\| psz[cch - 4] != ' '
1587	\|\| psz[cch - 3] != ' '
1588	\|\| psz[cch - 2] != ' '
1589	\|\| psz[cch - 1] != '\|'
1590	\|\| cch != 1 + 3 + cchSectionNm + 3 + 1
1591	\|\| strncmp(&psz[4], pszSectionNm, cchSectionNm)
1592	)
1593	{
1594	RTMsgError("%s:%d: Expected section box: \| %s \|", pMap->pszMapFile, pMap->iLine, pszSectionNm);
1595	return false;
1596	}
1597
1598	/* +------------+ */
1599	psz = mapReadLineStrip(pMap, &cch);
1600	if (!psz)
1601	return false;
1602	if ( psz[0] != '+'
1603	\|\| psz[1] != '-'
1604	\|\| psz[2] != '-'
1605	\|\| psz[3] != '-'
1606	\|\| psz[cch - 4] != '-'
1607	\|\| psz[cch - 3] != '-'
1608	\|\| psz[cch - 2] != '-'
1609	\|\| psz[cch - 1] != '+'
1610	)
1611	{
1612	RTMsgError("%s:%d: Expected section box: +-----...", pMap->pszMapFile, pMap->iLine);
1613	return false;
1614	}
1615
1616	/* There may be a few lines describing the table notation now, surrounded by blank lines. */
1617	do
1618	{
1619	psz = mapReadLineStripRight(pMap, &cch);
1620	if (!psz)
1621	return false;
1622	} while ( *psz == '\0'
1623	\|\| ( !RT_C_IS_SPACE(psz[0])
1624	&& RT_C_IS_SPACE(psz[1])
1625	&& psz[2] == '='
1626	&& RT_C_IS_SPACE(psz[3]))
1627	);
1628
1629	/* Should have the column heading now. */
1630	va_list va;
1631	va_start(va, cColumns);
1632	for (uint32_t i = 0; i < cColumns; i++)
1633	{
1634	const char pszColumn = va_arg(va, const char );
1635	size_t cchColumn = strlen(pszColumn);
1636	if ( strncmp(psz, pszColumn, cchColumn)
1637	\|\| ( psz[cchColumn] != '\0'
1638	&& !RT_C_IS_SPACE(psz[cchColumn])))
1639	{
1640	va_end(va);
1641	RTMsgError("%s:%d: Expected column '%s' found '%s'", pMap->pszMapFile, pMap->iLine, pszColumn, psz);
1642	return false;
1643	}
1644	psz += cchColumn;
1645	while (RT_C_IS_SPACE(*psz))
1646	psz++;
1647	}
1648	va_end(va);
1649
1650	/* The next line is the underlining. */
1651	psz = mapReadLineStripRight(pMap, &cch);
1652	if (!psz)
1653	return false;
1654	if (*psz != '=' \|\| psz[cch - 1] != '=')
1655	{
1656	RTMsgError("%s:%d: Expected column header underlining", pMap->pszMapFile, pMap->iLine);
1657	return false;
1658	}
1659
1660	/* Skip one blank line. */
1661	psz = mapReadLineStripRight(pMap, &cch);
1662	if (!psz)
1663	return false;
1664	if (*psz)
1665	{
1666	RTMsgError("%s:%d: Expected blank line beneath the column headers", pMap->pszMapFile, pMap->iLine);
1667	return false;
1668	}
1669
1670	return true;
1671	}
1672
1673
1674	/**
1675	* Parses a segment list.
1676	*
1677	* @returns @c true on success, @c false + msg on failure, @c false on eof.
1678	* @param pMap The map file handle.
1679	*/
1680	static bool mapParseSegments(PBIOSMAP pMap)
1681	{
1682	for (;;)
1683	{
1684	if (!mapReadLineStripRight(pMap, NULL))
1685	return false;
1686
1687	/* The end? The line should be empty. Expectes segment name to not
1688	start with a space. */
1689	if (!pMap->szLine[0] \|\| RT_C_IS_SPACE(pMap->szLine[0]))
1690	{
1691	if (!pMap->szLine[0])
1692	return true;
1693	RTMsgError("%s:%u: Malformed segment line", pMap->pszMapFile, pMap->iLine);
1694	return false;
1695	}
1696
1697	/* Parse the segment line. */
1698	uint32_t iSeg = g_cSegs;
1699	if (iSeg >= RT_ELEMENTS(g_aSegs))
1700	{
1701	RTMsgError("%s:%u: Too many segments", pMap->pszMapFile, pMap->iLine);
1702	return false;
1703	}
1704
1705	char *psz = pMap->szLine;
1706	if (!mapParseWord(&psz, g_aSegs[iSeg].szName, sizeof(g_aSegs[iSeg].szName)))
1707	RTMsgError("%s:%u: Segment name parser error", pMap->pszMapFile, pMap->iLine);
1708	else if (!mapParseWord(&psz, g_aSegs[iSeg].szClass, sizeof(g_aSegs[iSeg].szClass)))
1709	RTMsgError("%s:%u: Segment class parser error", pMap->pszMapFile, pMap->iLine);
1710	else if (!mapParseWord(&psz, g_aSegs[iSeg].szGroup, sizeof(g_aSegs[iSeg].szGroup)))
1711	RTMsgError("%s:%u: Segment group parser error", pMap->pszMapFile, pMap->iLine);
1712	else if (!mapParseAddress(&psz, &g_aSegs[iSeg].Address))
1713	RTMsgError("%s:%u: Segment address parser error", pMap->pszMapFile, pMap->iLine);
1714	else if (!mapParseSize(&psz, &g_aSegs[iSeg].cb))
1715	RTMsgError("%s:%u: Segment size parser error", pMap->pszMapFile, pMap->iLine);
1716	else
1717	{
1718	g_aSegs[iSeg].uFlatAddr = ((uint32_t)g_aSegs[iSeg].Address.sel << 4) + g_aSegs[iSeg].Address.off;
1719	g_cSegs++;
1720	if (g_cVerbose > 2)
1721	RTStrmPrintf(g_pStdErr, "read segment at %08x / %04x:%04x LB %04x %s / %s / %s\n",
1722	g_aSegs[iSeg].uFlatAddr,
1723	g_aSegs[iSeg].Address.sel,
1724	g_aSegs[iSeg].Address.off,
1725	g_aSegs[iSeg].cb,
1726	g_aSegs[iSeg].szName,
1727	g_aSegs[iSeg].szClass,
1728	g_aSegs[iSeg].szGroup);
1729
1730	while (RT_C_IS_SPACE(*psz))
1731	psz++;
1732	if (!*psz)
1733	continue;
1734	RTMsgError("%s:%u: Junk at end of line", pMap->pszMapFile, pMap->iLine);
1735	}
1736	return false;
1737	}
1738	}
1739
1740
1741	/**
1742	* Sorts the segment array by flat address and adds them to the debug module.
1743	*
1744	* @returns @c true on success, @c false + msg on failure, @c false on eof.
1745	*/
1746	static bool mapSortAndAddSegments(void)
1747	{
1748	for (uint32_t i = 0; i < g_cSegs; i++)
1749	{
1750	for (uint32_t j = i + 1; j < g_cSegs; j++)
1751	if (g_aSegs[j].uFlatAddr < g_aSegs[i].uFlatAddr)
1752	{
1753	BIOSSEG Tmp = g_aSegs[i];
1754	g_aSegs[i] = g_aSegs[j];
1755	g_aSegs[j] = Tmp;
1756	}
1757	if (g_cVerbose > 0)
1758	RTStrmPrintf(g_pStdErr, "segment at %08x / %04x:%04x LB %04x %s / %s / %s\n",
1759	g_aSegs[i].uFlatAddr,
1760	g_aSegs[i].Address.sel,
1761	g_aSegs[i].Address.off,
1762	g_aSegs[i].cb,
1763	g_aSegs[i].szName,
1764	g_aSegs[i].szClass,
1765	g_aSegs[i].szGroup);
1766
1767	RTDBGSEGIDX idx = i;
1768	int rc = RTDbgModSegmentAdd(g_hMapMod, g_aSegs[i].uFlatAddr, g_aSegs[i].cb, g_aSegs[i].szName, 0 /fFlags/, &idx);
1769	if (RT_FAILURE(rc))
1770	{
1771	RTMsgError("RTDbgModSegmentAdd failed on %s: %Rrc", g_aSegs[i].szName);
1772	return false;
1773	}
1774	}
1775	return true;
1776	}
1777
1778
1779	/**
1780	* Parses a segment list.
1781	*
1782	* @returns @c true on success, @c false + msg on failure, @c false on eof.
1783	* @param pMap The map file handle.
1784	*/
1785	static bool mapParseSymbols(PBIOSMAP pMap)
1786	{
1787	for (;;)
1788	{
1789	if (!mapReadLineStripRight(pMap, NULL))
1790	return false;
1791
1792	/* The end? The line should be empty. Expectes segment name to not
1793	start with a space. */
1794	if (!pMap->szLine[0] \|\| RT_C_IS_SPACE(pMap->szLine[0]))
1795	{
1796	if (!pMap->szLine[0])
1797	return true;
1798	return mapError(pMap, "Malformed symbol line");
1799	}
1800
1801	if (!strncmp(pMap->szLine, RT_STR_TUPLE("Module: ")))
1802	{
1803	/* Parse the module line. */
1804	size_t offObj = sizeof("Module: ") - 1;
1805	while (RT_C_IS_SPACE(pMap->szLine[offObj]))
1806	offObj++;
1807	size_t offSrc = offObj;
1808	char ch;
1809	while ((ch = pMap->szLine[offSrc]) != '(' && ch != '\0')
1810	offSrc++;
1811	size_t cchObj = offSrc - offObj;
1812
1813	offSrc++;
1814	size_t cchSrc = offSrc;
1815	while ((ch = pMap->szLine[cchSrc]) != ')' && ch != '\0')
1816	cchSrc++;
1817	cchSrc -= offSrc;
1818	if (ch != ')')
1819	return mapError(pMap, "Symbol/Module line parse error");
1820
1821	PBIOSOBJFILE pObjFile = (PBIOSOBJFILE)RTMemAllocZ(sizeof(*pObjFile) + cchSrc + cchObj + 2);
1822	if (!pObjFile)
1823	return mapError(pMap, "Out of memory");
1824	char psz = (char )(pObjFile + 1);
1825	pObjFile->pszObject = psz;
1826	memcpy(psz, &pMap->szLine[offObj], cchObj);
1827	psz += cchObj;
1828	*psz++ = '\0';
1829	pObjFile->pszSource = psz;
1830	memcpy(psz, &pMap->szLine[offSrc], cchSrc);
1831	psz[cchSrc] = '\0';
1832	RTListAppend(&g_ObjList, &pObjFile->Node);
1833	}
1834	else
1835	{
1836	/* Parse the segment line. */
1837	RTFAR16 Addr;
1838	char *psz = pMap->szLine;
1839	if (!mapParseAddress(&psz, &Addr))
1840	return mapError(pMap, "Symbol address parser error");
1841
1842	char szName[4096];
1843	if (!mapParseWord(&psz, szName, sizeof(szName)))
1844	return mapError(pMap, "Symbol name parser error");
1845
1846	uint32_t uFlatAddr = ((uint32_t)Addr.sel << 4) + Addr.off;
1847	if (uFlatAddr != 0)
1848	{
1849	int rc = RTDbgModSymbolAdd(g_hMapMod, szName, RTDBGSEGIDX_RVA, uFlatAddr, 0 /cb/, 0 /fFlags/, NULL);
1850	if (RT_FAILURE(rc) && rc != VERR_DBG_ADDRESS_CONFLICT)
1851	{
1852	/* HACK ALERT! For dealing with lables at segment size. / /* @todo fix end labels. */
1853	rc = RTDbgModSymbolAdd(g_hMapMod, szName, RTDBGSEGIDX_RVA, uFlatAddr - 1, 0 /cb/, 0 /fFlags/, NULL);
1854	if (RT_FAILURE(rc) && rc != VERR_DBG_ADDRESS_CONFLICT)
1855	return mapError(pMap, "RTDbgModSymbolAdd failed: %Rrc", rc);
1856	}
1857
1858	if (g_cVerbose > 2)
1859	RTStrmPrintf(g_pStdErr, "read symbol - %08x %s\n", uFlatAddr, szName);
1860	while (RT_C_IS_SPACE(*psz))
1861	psz++;
1862	if (*psz)
1863	return mapError(pMap, "Junk at end of line");
1864	}
1865
1866	}
1867	}
1868	}
1869
1870
1871	/**
1872	* Parses the given map file.
1873	*
1874	* @returns RTEXITCODE_SUCCESS and lots of globals, or RTEXITCODE_FAILURE and a
1875	* error message.
1876	* @param pMap The map file handle.
1877	*/
1878	static RTEXITCODE mapParseFile(PBIOSMAP pMap)
1879	{
1880	int rc = RTDbgModCreate(&g_hMapMod, "VBoxBios", 0 /cbSeg/, 0 /fFlags/);
1881	if (RT_FAILURE(rc))
1882	return RTMsgErrorExit(RTEXITCODE_FAILURE, "RTDbgModCreate failed: %Rrc", rc);
1883
1884	/*
1885	* Read the header.
1886	*/
1887	if (!mapReadLine(pMap))
1888	return RTEXITCODE_FAILURE;
1889	if (strncmp(pMap->szLine, RT_STR_TUPLE("Open Watcom Linker Version")))
1890	return RTMsgErrorExit(RTEXITCODE_FAILURE, "Unexpected map-file header: '%s'", pMap->szLine);
1891	if ( !mapSkipNonEmptyLines(pMap)
1892	\|\| !mapSkipEmptyLines(pMap))
1893	return RTEXITCODE_FAILURE;
1894
1895	/*
1896	* Skip groups.
1897	*/
1898	if (!mapSkipThruColumnHeadings(pMap, "Groups", 3, "Group", "Address", "Size", NULL))
1899	return RTEXITCODE_FAILURE;
1900	if (!mapSkipNonEmptyLines(pMap))
1901	return RTEXITCODE_FAILURE;
1902
1903	/*
1904	* Parse segments.
1905	*/
1906	if (!mapSkipThruColumnHeadings(pMap, "Segments", 5, "Segment", "Class", "Group", "Address", "Size"))
1907	return RTEXITCODE_FAILURE;
1908	if (!mapParseSegments(pMap))
1909	return RTEXITCODE_FAILURE;
1910	if (!mapSortAndAddSegments())
1911	return RTEXITCODE_FAILURE;
1912
1913	/*
1914	* Parse symbols.
1915	*/
1916	if (!mapSkipThruColumnHeadings(pMap, "Memory Map", 2, "Address", "Symbol"))
1917	return RTEXITCODE_FAILURE;
1918	if (!mapParseSymbols(pMap))
1919	return RTEXITCODE_FAILURE;
1920
1921	/* Ignore the rest of the file. */
1922	return RTEXITCODE_SUCCESS;
1923	}
1924
1925
1926	/**
1927	* Parses the linker map file for the BIOS.
1928	*
1929	* This is generated by the Watcom linker.
1930	*
1931	* @returns RTEXITCODE_SUCCESS or RTEXITCODE_FAILURE+msg.
1932	* @param pszBiosMap Path to the map file.
1933	*/
1934	static RTEXITCODE ParseMapFile(const char *pszBiosMap)
1935	{
1936	BIOSMAP Map;
1937	Map.pszMapFile = pszBiosMap;
1938	Map.hStrm = NULL;
1939	Map.iLine = 0;
1940	Map.fEof = false;
1941	Map.cch = 0;
1942	Map.offNW = 0;
1943	int rc = RTStrmOpen(pszBiosMap, "r", &Map.hStrm);
1944	if (RT_FAILURE(rc))
1945	return RTMsgErrorExit(RTEXITCODE_FAILURE, "Error opening '%s': %Rrc", pszBiosMap, rc);
1946	RTEXITCODE rcExit = mapParseFile(&Map);
1947	RTStrmClose(Map.hStrm);
1948	return rcExit;
1949	}
1950
1951
1952	/**
1953	* Reads the BIOS image into memory (g_pbImg and g_cbImg).
1954	*
1955	* @returns RTEXITCODE_SUCCESS or RTEXITCODE_FAILURE+msg.
1956	* @param pszBiosImg Path to the image file.
1957	*/
1958	static RTEXITCODE ReadBiosImage(const char *pszBiosImg)
1959	{
1960	void *pvImg;
1961	size_t cbImg;
1962	int rc = RTFileReadAll(pszBiosImg, &pvImg, &cbImg);
1963	if (RT_FAILURE(rc))
1964	return RTMsgErrorExit(RTEXITCODE_FAILURE, "Error reading '%s': %Rrc", pszBiosImg, rc);
1965
1966	size_t cbImgExpect;
1967	switch (g_enmBiosType)
1968	{
1969	case kBiosType_System: cbImgExpect = _64K; break;
1970	case kBiosType_Vga: cbImgExpect = _32K; break;
1971	default: cbImgExpect = 0; break;
1972	}
1973	if (cbImg != cbImgExpect)
1974	{
1975	RTFileReadAllFree(pvImg, cbImg);
1976	return RTMsgErrorExit(RTEXITCODE_FAILURE, "The BIOS image %u bytes intead of %u bytes", cbImg, cbImgExpect);
1977	}
1978
1979	g_pbImg = (uint8_t *)pvImg;
1980	g_cbImg = cbImg;
1981	return RTEXITCODE_SUCCESS;
1982	}
1983
1984
1985	int main(int argc, char **argv)
1986	{
1987	int rc = RTR3InitExe(argc, &argv, 0);
1988	if (RT_FAILURE(rc))
1989	return RTMsgInitFailure(rc);
1990
1991	RTListInit(&g_ObjList);
1992
1993	/*
1994	* Option config.
1995	*/
1996	static RTGETOPTDEF const s_aOpts[] =
1997	{
1998	{ "--bios-image", 'i', RTGETOPT_REQ_STRING },
1999	{ "--bios-map", 'm', RTGETOPT_REQ_STRING },
2000	{ "--bios-sym", 's', RTGETOPT_REQ_STRING },
2001	{ "--bios-type", 't', RTGETOPT_REQ_STRING },
2002	{ "--output", 'o', RTGETOPT_REQ_STRING },
2003	{ "--verbose", 'v', RTGETOPT_REQ_NOTHING },
2004	{ "--quiet", 'q', RTGETOPT_REQ_NOTHING },
2005	};
2006
2007	const char *pszBiosMap = NULL;
2008	const char *pszBiosSym = NULL;
2009	const char *pszBiosImg = NULL;
2010	const char *pszOutput = NULL;
2011
2012	RTGETOPTUNION ValueUnion;
2013	RTGETOPTSTATE GetOptState;
2014	rc = RTGetOptInit(&GetOptState, argc, argv, &s_aOpts[0], RT_ELEMENTS(s_aOpts), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
2015	AssertReleaseRCReturn(rc, RTEXITCODE_FAILURE);
2016
2017	/*
2018	* Process the options.
2019	*/
2020	while ((rc = RTGetOpt(&GetOptState, &ValueUnion)) != 0)
2021	{
2022	switch (rc)
2023	{
2024	case 'i':
2025	if (pszBiosImg)
2026	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "--bios-image is given more than once");
2027	pszBiosImg = ValueUnion.psz;
2028	break;
2029
2030	case 'm':
2031	if (pszBiosMap)
2032	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "--bios-map is given more than once");
2033	pszBiosMap = ValueUnion.psz;
2034	break;
2035
2036	case 's':
2037	if (pszBiosSym)
2038	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "--bios-sym is given more than once");
2039	pszBiosSym = ValueUnion.psz;
2040	break;
2041
2042	case 'o':
2043	if (pszOutput)
2044	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "--output is given more than once");
2045	pszOutput = ValueUnion.psz;
2046	break;
2047
2048	case 't':
2049	if (!strcmp(ValueUnion.psz, "system"))
2050	{
2051	g_enmBiosType = kBiosType_System;
2052	g_uBiosFlatBase = 0xf0000;
2053	}
2054	else if (!strcmp(ValueUnion.psz, "vga"))
2055	{
2056	g_enmBiosType = kBiosType_Vga;
2057	g_uBiosFlatBase = 0xc0000;
2058	}
2059	else
2060	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Unknown bios type '%s'", ValueUnion.psz);
2061	break;
2062
2063	case 'v':
2064	g_cVerbose++;
2065	break;
2066
2067	case 'q':
2068	g_cVerbose = 0;
2069	break;
2070
2071	case 'H':
2072	RTPrintf("usage: %Rbn --bios-image <file.img> --bios-map <file.map> [--output <file.asm>]\n",
2073	argv[0]);
2074	return RTEXITCODE_SUCCESS;
2075
2076	case 'V':
2077	{
2078	/* The following is assuming that svn does it's job here. */
2079	char szRev[] = "$Revision: 67789 $";
2080	char *psz = szRev;
2081	while (psz && !RT_C_IS_DIGIT(psz))
2082	psz++;
2083	size_t i = strlen(psz);
2084	while (i > 0 && !RT_C_IS_DIGIT(psz[i - 1]))
2085	psz[--i] = '\0';
2086
2087	RTPrintf("r%s\n", psz);
2088	return RTEXITCODE_SUCCESS;
2089	}
2090
2091	default:
2092	return RTGetOptPrintError(rc, &ValueUnion);
2093	}
2094	}
2095
2096	/*
2097	* Got it all?
2098	*/
2099	if (!pszBiosImg)
2100	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "--bios-image is required");
2101	if (!pszBiosMap)
2102	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "--bios-map is required");
2103	if (!pszBiosSym)
2104	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "--bios-sym is required");
2105
2106	/*
2107	* Do the job.
2108	*/
2109	RTEXITCODE rcExit;
2110	rcExit = ReadBiosImage(pszBiosImg);
2111	if (rcExit == RTEXITCODE_SUCCESS)
2112	rcExit = ParseMapFile(pszBiosMap);
2113	if (rcExit == RTEXITCODE_SUCCESS)
2114	rcExit = ParseSymFile(pszBiosSym);
2115	if (rcExit == RTEXITCODE_SUCCESS)
2116	rcExit = OpenOutputFile(pszOutput);
2117	if (rcExit == RTEXITCODE_SUCCESS)
2118	rcExit = DisassembleBiosImage();
2119
2120	return rcExit;
2121	}
2122

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Devices/BiosCommonCode/MakeAlternativeSource.cpp@ 67789

Download in other formats: