Bochs: Difference between revisions

1,837 bytes added ,  29 days ago
m
Bot: Replace deprecated source tag with syntaxhighlight
[unchecked revision][unchecked revision]
m (Bot: Replace deprecated source tag with syntaxhighlight)
 
(17 intermediate revisions by 11 users not shown)
Line 1:
{{Emulators}}
 
'''Bochs''' is a steadily improving simulatoremulator for the [[:Category:x86|IA32x86]] platform. AmongIt othergreatly nicetiesimproves (suchOS asdevelopment removingbecause the needvirtual formachine arestarts rebootmuch toquicker testthan yourreal latest kernel buildhardware, just restart Bochs),plus it offers detailed debugging functionality that can help greatly during kernel development.
 
It is strongly suggested to get two installations of Bochs - in addition to the out-of-the-box version (which might well be one of the binary downloads), you should also compile a second instance with the internal debugger enabled - so when something strange occurs that your 'normal' debugging tools can't trace, you can cross-check it with the debug version. You may also wish to enable (and use) the debug i/oIO ports.
 
 
==Frequent error messages==
===Running in Bogus Memory===
You sent your code pointer (eipEIP) to some uninitialized memory area. This means you either followed a nullNULL (or uninitialized) pointer, or you damaged the return address of your [[Stack#Stack example on the X86 architecture|stack frame]]. Make your code more clean, test pointers before you follow them, initialize every pointer (especially those who are on the stack) and enable *-Wall* in GCC.
 
=== 3rd exception with no resolution===
 
The CPU didn't manage to invoke an exception handler and would normally [[Triple Fault|triple fault]]. This is probably due to a bad [[Interrupt Descriptor Table|IDT]] register content, or a bad IDT descriptor. Sometimes (but less likely), it can also be due to a severe bug in your exception handler code. Check your exception works with "illegal" ASMasm instructions like <tt>idiv 0</tt>, or
 
<syntaxhighlight lang="asm">
push 0xf001
pop ds ;; 0xf001 is no valid segment,
mov ax, ~[ds:0x12345678] ;; let's see if we get the GPF
</syntaxhighlight>
 
In several cases, there are other error messages prior to this one which can provide more details in the error. Some common messages that might be displayed:
Line 30 ⟶ 32:
 
===I/O Operand Size===
Bochs performs some paranoiacrather paranoid checks on I/O operand size. Reading a byte from port 0x1234 is usually not the same thing as reading a dword32-bit value. Go back to your chip's datasheetdata sheet and double-check that your sizes are correct.
 
=== fetch_raw_descriptor: LDTR.valid=0 ===
Many of you have said "but ... I do not have an LDT and I read it wasn't mandatory!?". You're right. And so is BOCHSBochs. This message usually means that your program tried to load a selector with some garbage value, which happened to have the 3rd bit (Table Indicator) set. The CPU will try to look up the descriptor in the LDT, but there's no LDT registered! In most cases, the error comes from some mispairing of push and pop on the stack, which lead to a non-selector value to be loaded in a segment register.
 
If you're still stuck, download the Bochs sourcessource package and search for the message you received. Then, maybe you can add extra information to the message-printing code (like the faulty offset of a segfault, the segment limit, etc). But keep away from modifying Bochs' operations! Every time I suspected a bug in Bochs, I was just misunderstanding the Intel Manual...
 
==Differences between Bochs and real hardware==
;Bochs enables A20Linethe A20 line in the BIOS
:Your PC doesn't necessarily do so. Sometimes there's a BIOS option, sometimes there isn't. Check your code that enables A20Linethe A20 line and make sure it has no issues with faster hardware.
 
;Bochs wipes out its memory
Line 45 ⟶ 47:
 
;Bochs does not properly emulate CPU cache/TLB
:Although Bochs does have these constructs, they do not work the same as a regular CPU cache/ or TLB and do not change based on which CPU is being emulated. If you're not handling caching or TLB refreshes correctly, behavior may differ in Bochs vs. hardware (ie,i.e. it may work on Bochs but not on hardware, or vice versa).
 
;Bochs floppy has no errors
:In a normalphysical PC, it's common to issue up to 3 read commands on a sector/track before it can be read fine. If you don't have proper error check/recovery in your bootsector, you're likely to run something that is not your kernel...
 
;Bochs is flexible about returning to real mode
:UnlikeDespite what Chris Giese's Protected Mode tutorial states, you do not have to be in 16-bit protected mode to clear the PE bit of cr0CR0. If you fail to enter 16-bit protected mode on a real PC, it will hang, without giving any error indication - no triple fault or anything!
 
;Bochs' timer is not realtimereal time
:(unless you configure it closer to real time). Waiting for 2 second on bochs will let any virtual device that needs 2 seconds to be ready be ready, but that could be just 0.02 seconds for you ... or that could be 200 seconds.
 
Line 88 ⟶ 90:
display_library: x, options="gui_debug"
 
In windowsa Windows environment, add belowthis line to your bochsrc.bxrc
 
display_library: win32, optionoptions="gui_debug"
 
It seems that on Windows, the "option" flag (what the above line used to read) will be accepted, but the GUI window will not appear.
 
===I/O debugger macros===
Some useful macros when Bochs is compiled with the I/O debug ports enabled (<tt>port_e9_hack: enabled=1</tt> if Bochs 2.4 or newer, <tt>configure --port-e9-hack</tt> if not):
 
<syntaxhighlight lang="c">
//outputs a character to the debug console
#define BochsConsolePrintChar(c) outportb(0xe9, c)
//stops simulation and breaks into the debug console
#define BochsBreak() outportw(0x8A00,0x8A00); outportw(0x8A00,0x08AE0);
</syntaxhighlight>
 
===Magic Breakpoint===
When you're using bochsBochs with the [http://bochs.sourceforge.net/doc/docbook/user/internal-debugger.html internal debugger], then you can trigger the debugger via a systemfacility called [http://bochs.sourceforge.net/doc/docbook/user/bochsrc.html#AEN2324 magic breakpoints]. To trigger a breakpoint, you can insert <tt>XCHGxchg BXbx, BXbx</tt> (in GAS syntax, <tt>xchgw %bx, %bx</tt>) anywhere in the code and bochsBochs will trap into the debugger as soon as it executes it. On real systemshardware this has no effect as it onlymerely replaces the BX register with itself.
 
You should put the following line in your bochsBochs configuration file to have it listen to magic breakpoints:
magic_break: enabled=1
 
On older versions, enabling the debugger alone doesn't compile in magic breakpoint support, you will also need to passspecify <tt>--enable-magic-breakpoint</tt> towhen configuring the configurebuild foron those versions.
 
===Debugging SMP===
Line 121 ⟶ 127:
Bochs places an automatic breakpoint just before the BIOS loads, this can be automatically skipped by putting <tt>continue</tt> as the first command in the said file.
 
===Debugging Triple Faults===
 
When using the internal debugger, you may change this line in your Bochs configuration file:
 
reset_on_triple_fault 0
 
This line disables the emulator reset on a Triple fault, enabling you to debug the code after a Triple fault occured (Very useful while implementing paging).
==Compiling Bochs from Source==
Bochs has many compile-time configuration options, some of which conflict, and therefore a binary distribution of Bochs may not be suitable for your purposes. I found it was best to compile my own copy of Bochs to be sure I had the features that I needed. Also, you should consider using the CVS snapshot version of Bochs if the released version is old and not working for you. I found this was necessary up until version 2.4 was released, for example. On Ubuntu, you may have to run
 
<syntaxhighlight lang="bash">
sudo apt-get install libgtk2.0-dev
</syntaxhighlight>
 
and enter your password. On other linux distros, try the equivalent.
 
The array of Bochs configuration options can be confusing, and you cannot assume the defaults are going to be sensible. These are the options I use, this can get you started:
 
<syntaxhighlight lang="bash">
./configure --enable-smp \
--enable-cpu-level=6 \
Line 144 ⟶ 164:
--disable-plugins \
--disable-docbook \
--with-x --with-x11 --with-term --with-sdl2
</syntaxhighlight>
 
A few notes:
* If you are on Windows, that last line should probably read "--with-win32".
* On Linux, using SDL as the display library over X11 is preferable as the performance appears to increase greatly on some setups
* Bochs has GDB- stub support, and its own internal debugger. These cannot be compiled into the same Bochs binary. The internal debugger is very useful, itits flag is --enable-debugger
* The GDB- stub in Bochs does not support SMP, last time I checked.
* If you do not enable PCI, then the Intel Multiprocessing tables will not appear in memory.
* I was unable to successfully load the GUI debugger without specifying <tt>--disable-plugins</tt>. Otherwise, I get dynamic loading symbol errors.
* Post-2.4.2 several of the CPU specific options were folded into the CPU-level specification and are therefore deprecated. They have been removed from the example above.
* The default compile does not support x86-64, --enable-x86-64 will turn it on
* On many Linux distributions it is possible to install Bochs via a package manager. For example, on distributions that use apt-get we can do
<syntaxhighlight lang="bash">
sudo apt-get install bochs
sudo apt-get install bochs-x
</syntaxhighlight>
to install Bochs and the X11 plugin (which may crash on ubuntu/linux mint: install the sdl plugin and use sdl instead of x as the display library in this case). Note that there is a big chance that the graphical debugger is not enabled in the binaries from the package manager.
 
==See Also==
Line 164 ⟶ 192:
===External Links===
*[http://bochs.sourceforge.net Bochs Homepage]
*[http://bochs.sourceforge.net/doc/docbook/user/internal-debugger.html Bochs internal debugger commands documentation]
*[http://www.codeproject.com/system/MakingOS_2.asp CodeProject article on using Bochs]