-Version 1.8.0, July 2014 +Version 2.2.1, February 2019
Manual written by: Thomas Huth, Matthias Arndt @@ -87,31 +87,31 @@ Hatari on the WWW:
-Hatari is an Atari ST, STE, TT and Falcon emulator for Linux, OSX, +Hatari is an Atari ST, STE, TT and Falcon emulator for Linux, *BSD, macOS, Windows and other Systems which are supported by the SDL library. The emulator is open source software and is distributed under the terms of the GNU General Public License (GPL).
-The Atari ST was a 16/32 bit computer system which was first released by Atari +The Atari ST was a 16/32-bit computer system which was first released by Atari in 1985. Using the Motorola 68000 CPU, it was a very popular computer having quite a lot of CPU power at that time. See Appendix B for details on emulation in general.
-Unlike many other Atari ST emulators which try to give you a good +Unlike many other Atari emulators which try to give you a good environment for running GEM applications, Hatari tries to emulate the hardware -of a ST as close as possible so that it is able to run most of the old ST games +as close as possible so that it is able to run most of the old games and demos. Of course you can run normal GEM applications with Hatari, too. -Recent versions of Hatari even feature STE, Falcon and basic TT emulation.
+Hatari can also emulate a Mega-STE, which had slightly different hardware +compared to a normal STE (like a built-in real time clock chip). +
There is support for following additional TT features:
+Note that TT emulation is incomplete – e.g. the second MFP is not +emulated yet. +
There is support for following additional Falcon features:
@@ -180,13 +189,21 @@ Recent versions of Hatari even feature S+Both TT and Falcon emulation support NVRAM for persistent OS configuration +and RTC (real time clock). +
See the developers' doc/todo.txt file (included with Hatari sources) for the details on the few remaining @@ -197,35 +214,14 @@ to be affected by them.
Hatari currently has the following minimum system requirements:
--In the course of time Hatari has successfully been tested by various people on -the following systems: +Hatari needs a fast machine (1 GHz or more for ST/STE emulation, > 2 GHz +for Falcon emulation) which is running a POSIX compatible operating system +(preferably GNU/Linux) that supports the SDL library. +There are also some ports to other operating systems like macOS or Windows, +but they are not used by the developers, so such builds are normally not very +well tested.
-The versions available in your Linux distribution will be sufficient @@ -262,7 +263,7 @@ package.
-After you've verified that you have the required libraries and their +After you have verified that you have the required libraries and their development files, change to the hatari/ directory. Create a build/ directory under it and configure the build system for your environment: @@ -299,21 +300,21 @@ of the emulated Atari.
Unfortunately it is not possible to ship an original ROM image with the Hatari package since these images are still copyrighted. -But you can easily create an image with a real ST and one of those various -ROM-image programs for the ST (search for "TOSDUMP" with your -favourite internet search engine). If your old ST does not work anymore, you -can also try to search the internet directly for corresponding TOS ROM image, -but don't ask the Hatari team where to get one.
+But you can easily create an image with a real Atari machine and one of +those various ROM-image programs for them (search for "TOSDUMP" with your +favourite internet search engine).Another solution is EmuTOS, which is also shipped with the official release versions of Hatari. EmuTOS is an open-source TOS clone. You can find it at: http://emutos.sourceforge.net/. -It is not the best solution for playing games or running other old software -due to compatibility issues (see emutos.txt for -more details), but it's free and compatible with Hatari.
-If you do not specify a TOS image on the commandline nor can Hatari -find a suitable TOS image in the default dir, you'll get the chance to -select a TOS image file from the GUI.
+It is not the best solution for Falcon emulation, playing old games +or running other old software due to compatibility issues (see +emutos.txt for more details), +but it is free, compatible with Hatari, doesn't require driver to +support harddisk images, and it boots much faster than original TOS. +If you do not specify a TOS image on the commandline and Hatari +cannot find a suitable TOS image in the default dir, you'll get the +chance to select a TOS image file from the GUI.
Some of the run-time changes require emulation to be reseted for them +
Some of the run-time changes require emulation to be reset for them to take effect.
@@ -372,11 +374,10 @@ to take effect.Booting will be done from the disk image or directory that's given last on the command line as an option or the argument (and which @@ -422,6 +423,10 @@ user configuration files <bool>
On fast machine helps skipping (fast forwarding) Hatari output
+--auto <program>
+Autostarts given program, if TOS finds it. +Program needs to be given with full path it will have under +emulation, for example "C:\DIR\PROGRAM.PRG"
-m, @@ -432,6 +437,9 @@ color
<x>Select monitor type (x = mono/rgb/vga/tv)
+--tos-res <x>
+Select TOS resolution for color monitors +(x = low/med/high/ttlow/ttmed)
-f, --fullscreen
Start the emulator in fullscreen @@ -440,6 +448,9 @@ mode
Start the emulator in windowed mode
--grab
Grab mouse (also) in windowed mode
+--resizable <bool>
+Allow window resizing
+NOTE: this is supported only by Hatari SDL2 build
--borders <bool>
Show ST/STE/Falcon screen borders (for low/med resolution overscan demos)
@@ -471,19 +482,28 @@ for borders / zooming <bool>Force internal bitdepth (x = 8/15/16/32, 0=disable)
+--disable-video +<bool>
+Run emulation without displaying video (audio only)
--desktop-st <bool>
-Whether fullscreen mode uses desktop -resolution to avoid: messing multi-screen setups, several seconds -delay needed by LCD monitors resolution switching and the resulting -sound break. As Hatari ST/E display code doesn’t support -zooming (except low-rez doubling), it doesn’t get scaled (by -Hatari or monitor) when this is enabled. Therefore this is mainly -useful only if you suffer from the described effects, but still -want to grab mouse and remove other distractions from the screen -just by toggling fullscreen mode. (disabled by default)
++NOTE: this has effect only for SDL1 Hatari build. In SDL2 build, +--desktop option controls also ST/STe mode.
+Whether to use desktop resolution on fullscreen +to avoid issues related to resolution switching (messing multi-screen +setups, several seconds delay needed for resolution switching by some +LCD monitors and the resulting sound break). Otherwise fullscreen will +use a resolution that is closest to the Hatari window size.
+As Hatari ST/STe display code doesn't support +zooming (except low-rez doubling), it doesn't get scaled (by Hatari or +monitor) when this is enabled, and you may get large black borders +around ST/STe screen. Therefore this is mainly useful only if you +suffer from the described effects, but still want to grab mouse and +remove other distractions from the screen just by toggling fullscreen +mode. (disabled by default)
--spec512 <x>
Hatari uses this threshold to decide @@ -494,6 +514,14 @@ Spectrum512 screen conversion functions <x>
Zoom (double) low resolution (1=no, 2=yes)
+--video-timing +<x>
+Wakeup State for MMU/GLUE (x=ws1/ws2/ws3/ws4/random, +default ws3). When powering on, the STF will randomly choose one of these +wake up states. The state will then affect the timings where border removals +and other video tricks should be made, which can give different results on +screen. For example, WS3 is known to be compatible with many demos, while WS1 can show +more problems.
@@ -528,11 +556,30 @@ depth <x> (x = 1, 2 or 4)
--vdi-width <w>
Use extended VDI resolution with width -<w> (320 < w <= 1280)
+<w> (320 < w <= 2048)--vdi-height <h>
Use extended VDI resolution with height -<h> (200 < h <= 960)
+<h> (200 < h <= 1280) ++TOS and popular GEM progams add extra restrictions for the VDI screen +size. In total screen can take at maximum 300kB, width needs to be +multiple of 128/planes, and height multiple of 16 pixels (or 8, +depending on system font height). That translates to following maximum +standard resolutions for the VDI mode: +
+monochrome
++FullHD (1920×1080), WUXGA (1920x1200) and QWXGA (2048x1152) +
+2 plane mode (4 colors)
++HD (1280x720), WXGA (1280x768) and XGA+ (1152x864) +
+4 plane mode (16-colors)
++qHD (960x540), DVGA (960x640) and WSVGA (1024x600) +
--crop @@ -540,18 +587,22 @@ depth <x> (x = 1, 2 or 4)
Remove statusbar from the screen captures
--avirecord
-Start AVI recording
---avi-vcodec -<x>
-Select avi video codec (x = -bmp/png)
---avi-fps -<x>
-Force avi frame rate (x = -50/60/71/...)
---avi-file -<file>
-Use <file> to record avi
+Start AVI recording. Note: recording will +automatically stop when emulation resolution changes.
+--avi-vcodec <x>
+Select AVI video codec (x = bmp/png). +PNG compression can be much slower than using the uncompressed BMP +format, but uncompressed video content takes huge amount of space.
+--png-level <x>
+Select PNG compression level for AVI video (x = 0-9). +Both compression efficiency and speed depend on the compressed +screen content. Highest compression level (9) can be really +slow with some content. Levels 3-6 should compress nearly as well +with clearly smaller CPU overhead.
+--avi-fps <x>
+Force AVI frame rate (x = 50/60/71/...)
+--avi-file <file>
+Use <file> to record AVI
-j, @@ -566,24 +617,30 @@ given port
<file>Enable printer support and write data to <file>
+--midi <bool>
+Enable MIDI support (PortMidi only)
--midi-in <filename>
Enable MIDI support and write MIDI data -to <file>
+to <file> (Linux only)--midi-out <filename>
Enable MIDI support and read MIDI data -from <file>
+from <file> (Linux only)--rs232-in <filename>
-Enable serial port support and use +
Enable MFP serial port support and use <file> as the input device
--rs232-out <filename>
-Enable serial port support and use +
Enable MFP serial port support and use <file> as the output device
+--scc-b-out +<filename>
+Enable SCC channel B serial port support and use +<file> for the output (only for Mega-STE, TT and Falcon)
---drive-a <bool>
Enable/disable drive A (default is on)
@@ -602,11 +659,27 @@ from <file>--disk-b <file>
Set disk image for floppy drive B
+--fastfdc +<bool>
+Speed up FDC emulation (can cause +incompatibilities)
--protect-floppy <x>
Write protect floppy image contents (on/off/auto). With "auto" option write protection is according to the disk image file attributes
+ +-d, --harddrive +<dir>
+GEMDOS HD emulation. Emulate hard disk partition(s) +with <dir> contents. If directory contains only single letter +(C-Z) subdirectories, each of these subdirectories will be treated +as a separate partition, otherwise the given directory itself will +be assigned to drive "C:". In the multiple partition case, the +letters used as the subdirectory names will determine to which +drives/partitions they’re assigned. If <dir> is +an empty string, then harddrive's emulation is disabled
--protect-hd <x>
Write protect hard drive <dir> @@ -616,34 +689,49 @@ the file attribute modifications for the emulation
--gemdos-case <x>
Specify whether new dir/filenames are forced to be -in upper or lower case with the GEMDOS HD emulation. Off/upper/lower, off by default +in upper or lower case with GEMDOS HD emulation. Off/upper/lower, off by default
--d, --harddrive -<dir>
-Emulate hard disk partition(s) with -<dir> contents. If directory contains only single letter -(C-Z) subdirectories, each of these subdirectories will be treated -as a separate partition, otherwise the given directory itself will -be assigned to drive "C:". In the multiple partition case, the -letters used as the subdirectory names will determine to which -drives/partitions they’re assigned. If <dir> is -an empty string, then harddrive's emulation is disabled
---acsi -<file>
-Emulate an ACSI hard drive with an image -<file>
+--gemdos-time <x>
+Specify what file modification timestamps should be used, +emulation internal (atari) ones, or ones from the machine (host) on which +the machine is running. While Atari emulation and host clocks are in sync +at Hatari startup, they will diverge while emulation is running, especially +if you use fast forward. Default is "atari". If you modify files accessed +by the Atari side, directly from the host side while Hatari is already +running, you may want to use "host" option
+--gemdos-conv <bool>
+Whether GEMDOS file names with 8-bit (non-ASCII) characters +are converted between Atari and host character sets. On Linux, host file +name character set is assumed to be UTF-8. This option is disabled by +default, in case you have transferred files from Atari machine without +proper file name conversion (e.g. by zipping them on Atari and +unzipping on PC)
+--gemdos-drive <drive>
+Assign (separately specified) GEMDOS HD to given +drive letter (C-Z) instead of default C:, or use "skip" to specify +that Hatari should add GEMDOS HD after IDE and ACSI drives (assumes +Hatari and native HD driver parse same number of partitions from +the partition tables in HD images)
+--acsi <id>=<file>
+Emulate an ACSI hard drive with given bus ID (0-7) +using image <file>. If just a filename is given, it is assigned to +bus ID 0
+--scsi <id>=<file>
+Emulate a SCSI hard drive with given bus ID (0-7) +using image <file>. If just a filename is given, it is assigned to +bus ID 0
--ide-master <file>
-Emulate an IDE master hard drive with an +
Emulate an IDE 0 (master) hard drive with an image <file>
--ide-slave <file>
-Emulate an IDE slave hard drive with an +
Emulate an IDE 1 (slave) hard drive with an image <file>
---fastfdc -<bool>
-Speed up FDC emulation (can cause -incompatibilities)
+--ide-swap <id>=<x>
+Set byte-swap option <x> (off/on/auto) for +given IDE <id> (0/1). If just option is given, it is applied to +IDE 0
@@ -652,7 +740,11 @@ incompatibilities)
-s, --memsize <x>
Set amount of emulated RAM, x = 1 to 14 -MiB, or 0 for 512 KiB
+MiB, or 0 for 512 KiB. Other values are considered as a size in KiB +--ttram +<x>
+Set amount of emulated TT RAM (for Falcon and TT +mode), x = 0 to 512 MiB
-t, @@ -669,24 +761,36 @@ you are doing!
(only works if GEMDOS HD emulation and extended VDI resolution are disabled) ---cpulevel <x>
Specify CPU (680x0) to use (use x >= 1 with EmuTOS or TOS >= 2.06 only!)
--cpuclock <x>
-Set the CPU clock (8, 16 or 32 Mhz)
+Set the CPU clock (8, 16 or 32 MHz)
--compatible <bool>
Use a more compatible, but slower 68000 CPU mode with better prefetch accuracy and cycle counting
+--cpu-exact <bool>
+Use cycle exact CPU emulation (cache emulation)
+--addr24 <bool>
+Use 24-bit instead of 32-bit addressing mode (24-bit is enabled by default)
+--fpu <x>
+FPU type (x=none/68881/68882/internal)
+--fpu-softfloat <bool>
+Use full software FPU emulation (Softfloat library)
+--mmu <bool>
+Use MMU emulation
+--machine <x>
-Select machine type (x = st, ste, tt or -falcon)
+Select machine type (x = st, megast, ste, +megaste, tt or falcon)
--blitter <bool>
Enable blitter emulation (ST only)
@@ -704,9 +808,6 @@ interrupts.Patch TOS and initialize the so-called "memvalid" system variables to by-pass the memory test of TOS, so that the system boots faster.
---rtc -<bool>
-Enable real-time clock
--mic @@ -725,7 +826,7 @@ matches evenly with the STE/TT/Falcon so <x>
SDL’s sound buffer size: 10-100, or 0 to use default buffer size. By default Hatari uses an SDL -buffer size of 1024 samples, which gives approximatively 20-30 ms +buffer size of 1024 samples, which gives approximately 20-30 ms of sound depending on the chosen sound frequency. Under some OS or with not fully supported sound card, this default setting can cause a bigger delay at lower frequency (nearly 0.5 sec). In that case, @@ -752,6 +853,8 @@ values measured on STF and "linear" just voices.
-W, --wincon
+Open console window (Windows only)
-D, --debug
Toggle whether CPU exceptions invoke @@ -760,12 +863,13 @@ the debugger
Specify which exceptions invoke debugger, see "--debug-except help" for available (comma separated) exception flags.
---bios-intercept
+--bios-intercept <bool>
-Toggle XBios command parsing. Allows Atari programs to use all Hatari -functionality and change Hatari state through Hatari specifit +Enable/disable XBios command parsing. Allows Atari programs to use all Hatari +functionality and change Hatari state through Hatari specific XBios(255) calls. XBios(20) printscreen calls produce also Hatari -screenshots.
+screenshots. XBios(11) Dbmsg call can be used to invoke the debugger. +--conout <device>
Enable console (xconout vector functions) output redirection for given <device> to host terminal. Device 2 is for @@ -799,10 +903,18 @@ used to create it automatically.
core dumps. SDL parachute is enabled by default to restore video mode in case Hatari terminates abnormally while using non-standard screen resolution. ---control-socket -<file>
-Hatari reads options from given socket -at run-time
+--control-socket <path>
++Hatari connects to given local socket file and reads commands from it. +Use when the control process life-time is longer than Hatari's, or +control process needs response from Hatari +
+--cmd-fifo <path>
++Hatari creates the indicated FIFO file and reads commands from it. +Commands can be echoed to FIFO file, and are same as with the control +socket. Hatari outputs help for unrecognized commands and subcommands +
--log-file <file>
Save log output to <file> @@ -818,6 +930,11 @@ given level
--run-vbls <x>
Exit after X VBLs
+--benchmark
+Start in benchmark mode (use with --run-vbls). +This allows to measure the speed of the emulation in frames per second +by running at maximum speed (don't wait for VBL). Disable audio/video +output to have as little OS overhead as possible
Type hatari --help to list all the command line options supported by a given version of Hatari.
@@ -825,7 +942,7 @@ the command line options supported by aOnce you've started Hatari successfully, you can use the emulator as +
Once you have started Hatari successfully, you can use the emulator as an almost complete Atari ST computer system.
You can load the current settings from a configuration file by clicking -on and you can save +on the button, and save the current settings to a configuration file by clicking on -. +the button.
Click to go back and continue the emulation. All changed options will be applied.
-Select the option if you +Select the "Reset machine" option if you want the emulated machine to perform a cold reset. This is equal to switching the power off and on again on a real Atari machine.
@@ -890,16 +1007,21 @@ changes that you have made.You can use the three buttons in the upper right corner for additional folder navigation. Click the button to go up one level - in the directory tree. Click the button to return - to your home directory. The button can be clicked - to go to the root directory of the file system. + in the directory tree. The button takes you + to the current working directory (i.e. the folder that was current when + Hatari has been started). Click the button to + return to your home directory. The button can + be clicked to go to the root directory of the file system. +
++ When you tick the "Show hidden files" setting, Hatari will + also show files that start with a dot in the file selection dialog.
-
The machine type option is used to select the type of Atari computer to
- be emulated. The ST was the very first 16/32-bit computer from Atari.
- Most older games and demos require an ST. The STE was introduced some years
- later and had some more advanced hardware features. There are not that many
- demos or games that really require an STE but since most normal ST games/demos
- also work with an STE, it's normally safe to always work in STE mode.
-
- TT and Falcon are more advanced, but they are not as compatible to the ST as
- the STE was. Therefore many old games and demos do not work with these machine
- types anymore. There were only very few programs that were made for the TT
- exclusively, while there were some interesting games and demos specially made
- for the Falcon.
-
- Note: Falcon and especially TT emulation are still considered as
- experimental and incomplete.
- Quite a bunch of programs do not work very well yet.
-
- For STE emulation a STE compatible TOS image, e.q. version 1.06, 1.62 or - 2.x, is strongly recommended. For TT emulation you need TOS 3.0x and for Falcon - emulation you need TOS 4.0x. EmuTOS can be used on all machine types. -
- -- The CPU type option can be used to select the level of the central processing - unit. If you are not sure what to use, simply select 68000 for ST and STE - machines and 68030 for TT and Falcon emulation, since this were the original - configurations used in the Atari computers. In case you want to vary - the CPU type, you have got to be aware of some constraints: + be emulated:
+ Note: Falcon and especially TT emulation are still considered as + experimental and incomplete, so quite a bunch of programs do not work very + well yet. + Also a lot of old games and demos do not work with these machine types + anymore since the hardware is quite a bit different. There were only very + few programs that were made for the TT exclusively, while there were some + interesting games and demos specially made for the Falcon. +
- The CPU clock option can be used to select the frequency that is used - to clock the CPU. 8 Mhz is the standard for ST and STE and the most - compatible frequency for old software. - Use 16 MHz for Mega STE and Falcon emulation. - The CPU in the TT was clocked with 32 MHz. + The video timings ("wakestate") settings influence the internal + timings of the ST video chip emulation. You normally do not have to change + these unless you know what you are doing, only some very few demos require + a special setting here.
+For Falcon mode, you can choose whether you want to disable DSP emulation, fake it or enable full emulation. Most Falcon programs only play sound or work @@ -981,7 +1094,7 @@ changes that you have made. power (more than 2 GHz) for full emulation. So if you have a slow host CPU, you can try if your Falcon program also runs with DSP disabled or in the "dummy" fake mode. - Note that you can not change this option while the DSP based program already + Note that you cannot change this option while the DSP based program already runs.
@@ -989,21 +1102,11 @@ changes that you have made. be used to fine-tune the machine and CPU types.
- If you enable the "Real time clock emulation" switch, a RTC (like the ones - that could be found in the Mega-ST and Mega-STE computers) will be emulated - based on the time of the host computer. - This option is only affects the emulation of ST and STE machines. TT and - Falcon used a different kind of RTC (which is not optional and thus always - enabled in Hatari). - Note: You need at least TOS 1.02 for proper RTC emulation, TOS 1.00 does - not support this. -
-- The next check box can be used to enable/disable Blitter emulation. + The Blitter option can be set to enable Blitter emulation in plain ST mode. The Blitter is a custom chip that accelerates some graphical operations. - This switch only toggles the Blitter in plain ST mode. In STE and Falcon mode, - the Blitter is always enabled (since these machines have always been sold - with a Blitter chip). The TT was always shipped without the Blitter chip. + Note that in Mega-ST, STE and Falcon mode, the Blitter is always enabled + (since these machines have always been sold with a Blitter chip). The TT + was always shipped without the Blitter chip.
The "Patch Timer-D" option changes the Timer-D initialization from @@ -1021,6 +1124,66 @@ changes that you have made. to be switched off to get those programs running.
+ NOTE: The emulated Atari system is very very sensitive to all of + these options and it is strongly recommended to reset the emulation after + changing them (for most things that's done automatically). + Most settings are also selected automatically when one uses the + --machine command line option. +
+ + +
++ The CPU type option can be used to select the level of the central processing + unit. If you are not sure what to use, simply select 68000 for ST and STE + machines and 68030 for TT and Falcon emulation, since this were the original + configurations used in the Atari computers. In case you want to vary + the CPU type, you have got to be aware of some constraints: +
++ The CPU clock option can be used to select the frequency that is used + to clock the CPU. 8 MHz is the standard for ST and STE and the most + compatible frequency for old software. + Use 16 MHz for Mega STE and Falcon emulation. + The CPU in the TT was clocked with 32 MHz. +
+ +The "Prefetch mode" option is used to enable the emulation of 68k address errors and the so-called CPU prefetch buffer. This is needed for best compatibility, but it slows down emulation a little bit so you can disable it @@ -1030,21 +1193,20 @@ changes that you have made. The "Cycle exact", the "MMU emulation" and "24-bit addressing" option are only available in the "WinUAE" builds - of Hatari. They are considered as experimental and should be switched off - unless you know what you are doing. + of Hatari. They are considered as experimental and should only be changed + if you know what you are doing.
The FPU settings are also only available with the "WinUAE" builds of Hatari. They can be used to select the type of floating point unit of CPUs - >= 68020. In the normal builds of Hatari, the FPU is always enabled for - 68030 and 68040 CPUs. -
-
- NOTE: The emulated Atari system is very very sensitive to all of
- these options and it is strongly recommended to reset the emulation after
- changing them (for most things that's done automatically).
- The correct CPU type and clock are automatically selected when one uses the
- --machine command line option.
+ >= 68020. In the non-WinUAE builds of Hatari, the FPU is always enabled for
+ 68030 and 68040 CPUs.
+ When emulating the FPU, you can use your own PC's CPU/FPU to do the math.
+ This is the default and fastest method, but recent CPU might have some slight
+ differences in rounding when compared to a real Motorala FPU.
+ For higher precision, you can select the "Softfloat" emulation mode : this will
+ emulate all the FPU operations using only the CPU and with the same rules as the
+ Motorala's FPU. In that case, FPU emulation will be a little slower.
If you want, you can set Hatari to write-protect your disks. Atari ST - virii can spread on disk images, so that can be a good idea. However, + viruses can spread on disk images, so that can be a good idea. However, note that some programs won't work correctly (or at all) with write protected disks, and things like saving highscores in games will fail.
@@ -1135,7 +1297,7 @@ ends with a 'b'.
- Here you can select a hard disk image file for ACSI, IDE master or - slave hard drive emulation, or you can select a host directory to be - emulated as the Atari hard drive. -
-- Check "Boot from HD" if you want Hatari to execute the AUTO folder on - the hard disk. This option is checked by default if you specify a - hard disk image or a directory via the command line. -
-- Removing the check from the "Allow GEMDOS drive modification" option - will prevent Atari programs from modifying the files in GEMDOS HD - emulation directory or creating new files under it. -
-- Note that for IDE hard drive emulation you also need a TOS version >= 2.05. - And ACSI hard drive emulation does not work with TOS 4.0x in Falcon mode. + Here you can select a hard disk image file for ACSI, SCSI or IDE hard drive + emulation, or you can select a host directory to be emulated as the Atari + hard drive. Use the arrow buttons to select the ID of the drive that you + want to set, then click on to choose + a file which should be used for providing the contents of the hard disk, + or click on to disable the current ID. +
++ IDE controllers are using a 16-bit interface, so depending on where the + contents of a real hard disk have initially been created (on an Atari + machine or on a PC), and depending on where the contents have been read + out from the disk, 16-bit values in the image might be byte-swapped. + Hatari can either try to detect this situation automatically (when + "Auto" is selected), or you can tell Hatari whether it should + always byte-swap the disk image contents or not. +
+
+ GEMDOS HD emulation can be used to provide a folder on your host
+ computer file system as hard drive(s) to the emulated Atari. Select
+ to choose a folder, or
+ to disable the drive(s) again.
+
+ The "Atari <-> host 8-bit filename conversion" setting
+ can be used to tell Hatari whether it should try to convert the character
+ set of the file names on the host to the Atari character set, since
+ modern operating systems use different character sets than Atari TOS.
+ File name conversion option is best-effort conversion between
+ the host OS and Atari character set for the non-ASCII file names
+ exposed by the GEMDOS HD emulation.
+
+ GEMDOS HD emulation can override partition(s) from HD images.
+ With "Add GEMDOS HD after ACSI/SCSI/IDE partitions" option Hatari
+ tries to assign it to a drive after the partitions on HD images,
+ instead of C: (whether that works correctly depends on whether
+ your emulated Atari hard disk interprets the HD images partition
+ tables similarly to Hatari, and whether it starts assigning them
+ from C: onwards). As a last resort, you can use "--gemdos-drive"
+ command line option to explicitly specify which drive should be
+ used for GEMDOS HD.
+
+ Finally, you can also choose whether you want to provide the files on
+ GEMDOS HD only as write-protected to the Atari environment or not,
+ or whether you want Hatari to select this status automatically depending
+ on the file attributes of the file in the host file system.
+
+ Check "Boot from HD" to set given hard disk image / directory as TOS + boot device (if ACSI or IDE is enabled, it is C:, otherwise it is the + first specified GEMDOS HD drive). With command line options, the value + of this setting depends on whether you specify floppy image or harddisk + later on the command line (later one takes precedence). +
++ Note that you need TOS version >= 2.05 to boot from IDE hard drive. + ACSI hard drive emulation does not work with TOS 4.0x in Falcon mode. + For SCSI emulation, you either need to run with TT or Falcon emulation. + Please also refer to the Hard disk support + chapter for more details about hard disk emulation.
You can select the amount of RAM for the emulated ST here. Only +
You can select the amount of RAM for the emulated machine here. Only amounts that were valid on a real unmodified STFM can be selected.
Note: This option is critical and you are strongly advised -to reset the emulated ST +to reset the emulated machine when changing this option.
+TT RAM size allows to emulate up to 512 MiB of 32-bit RAM. This is only +useful in Falcon or TT mode and require to disable "24 bit addressing" mode +in the CPU options
Here you will find the options to save memory snapshots as well.
Click on to save a memory snapshot to file. You can select a new filename here.
@@ -1182,7 +1388,7 @@ to file. You can select a new filename h snapshot from a file. Use the fileselector to select the snapshot to be restored.NOTE: Memory snapshots are not interchangeable between -different versions of Hatari. E.q. if you compile a newer Hatari, you +different versions of Hatari. e.g. if you compile a newer Hatari, you cannot load your old memory snapshots back.
@@ -1200,12 +1406,14 @@ You can also select an optional cartridg class="button">Eject to disconnect the custom cartridge image.+Depending on the machine type that you want to emulate, you can either use +EmuTOS, or you must use a TOS version that supports the machine type. For ST mode, use TOS 1.00, 1.02, 1.04 or 2.06. For STE mode, use TOS 1.06, 1.62, 2.05 or 2.06. -If you want to use the TT mode, you must specify a TOS 3.06 image here. -And in Falcon mode, you have to use either TOS 4.00, 4.02, 4.04 or 4.92. -However, you should always use TOS 4.04 for Falcon mode, it's the most common one. -Also note that TOS 4.92 can not be booted from a boot disk (like it's done on a +If you want to use the TT mode, you must specify a TOS 3.05 or 3.06 image here. +And in Falcon mode, you have to use either TOS 4.00, 4.02, 4.04 or 4.92. However, +you should always use TOS 4.04 for Falcon mode, it is the most common one. +Also note that TOS 4.92 cannot be booted from a boot disk (like it is done on a real Falcon), you have to specify it directly in the TOS ROM setup dialog here.
@@ -1278,25 +1486,40 @@ certain games. In some other games, it g In TT mode, you can only choose between TT-high resolution ("Mono") and normal modes (select one of the other monitor types). Finally the Falcon mode supports all four types of monitors. Note that most - Falcon demos/games require a RGB or TV mode and do not work with VGA. + Falcon demos/games require a RGB or TV mode, and do not work with + VGA, although there are also few VGA-only games and demos.
"Show ST/STE borders" toggles the displaying of the borders around the ST / - STE screen. Some demos and games use the screen borders for displaying + STE. Some demos and games use the screen borders for displaying additional graphics. As enabling this option increases CPU computing time, don't enable it if you have a very slow computer. - This option affects only the ST and STE modes, TT and Falcon modes are - always displayed without borders. + Borders are shown also in Falcon emulation, but Videl emulation doesn't + yet support palette effects. + This option doesn't affect TT screen mode or extended VDI resolutions. +
+
+Extended VDI resolutions will emulate a sort of extended graphics card
+in the emulated machine, which gives you larger (2-16 color)
+resolutions for GEM. Select a resolution and color depth. Check to
+activate. This mode isn't affect by the other video options mentioned
+above. Uncheck to get back to a normal ST behaviour.
Note that there are several gotchas with extended VDI +resolutions:
+
-Extended VDI resolutions will emulate a sort of extended graphics
-card in the emulated ST which give you larger resolutions with a higher
-colordepth for GEM. Select a resolution and color depth. Check to
-activate. It will disable all other video options mentioned above.
-Uncheck to get back to a normal ST behaviour.
-Note: Using an extended resolution will only work with GEM
-conformant applications. 99% of all games and demos will not run if you
-activate any extended resolution here.
+Because TT and Falcon support natively larger resolutions,
+VDI mode is most useful with ST / STE emulation.
You should set these values to a size that suits best your monitor -resolution. It's intended to help in getting Hatari to best use your +resolution. It is intended to help in getting Hatari to best use your monitor space on a windowed mode and in fullscreen avoiding "fuzzy" scaling done by your LCD monitor.
@@ -1389,7 +1612,7 @@ the screenshots and recorded videos.
"Symbolic" tries to map the symbolic values of your PC keys to the ST keys. It should be working pretty good on all systems as long - as your keyboard layout looks close to the standard english keyboard + as your keyboard layout looks close to the standard English keyboard layout. However, you might experience some problems with special keys like brackets etc.
-"Scancode" uses the scancode values of your PC keys for keyboard - mapping. This only works on certain architectures like Linux where the - scancodes are similar to the ST scancodes (e.g. it does not work on Mac OS X). +
"Scancode" uses the scancode values of your PC keys for keyboard mapping. + This only works on certain architectures like Linux where the scancodes are + similar to the ST scancodes (e.g. it does not work on macOS with SDL1.2). If it works on your system, this often gives better results than the symbolic mapping. Note that you also need a TOS version with the right language (e.g. use a French TOS if you are using a French keyboard).
@@ -1412,10 +1635,26 @@ the screenshots and recorded videos. at the supplied example mapfile (keymap-sample.txt) to see how to create your own keyboard mapping.- When the emulator runs in fast forward mode, and you want to type text, - it can be annoying that the emulated system detects multiple key events - due to the key repetition of the emulated system. To avoid this you can - disable the key repetition in fast forward mode here. + The "Shortcuts" section can be used to configure the keyboard shortcuts + that can be activated while the emulation is running. Hatari supports + two sets of keyboard shortcuts: The first type is activated by pressing a + modifier key (AltGr / right Alt by default, Cmd key on macOS) together with + the key, and the second type is directly activated by pressing a single key, + without additional modifier key. + Use the arrow buttons to select the shortcut that you want to change, + then press one of the buttons to + change the key for the shortcut. You'll be prompted to press the key + that should be used. + If you reconsider and don't want to change the key, you can press the + left mouse button instead. By pressing the right mouse button during + the prompt, you can also erase the current shortcut setting. +
++ The last setting in this dialog can be used to disable the key repetition + in fast forward mode. When the emulator runs in fast forward mode, and you + want to type text, it can be annoying that the emulated system detects + multiple key events due to the key repetition of the emulated system. + So this can be avoided by enabling this option.
@@ -1472,9 +1711,9 @@ details. enter a new filename as well.Check the second checkmark to enable RS232 support. The RS232 device is configured according to the settings of -the emulated RS232 of the Atari ST. This means Hatari will +the emulated MFP RS232 of the Atari ST/STE/TT. This means Hatari will automatically use baudrate and handshaking as configured for the -emulated ST.
+emulated machine.Click on to select suitable device files for serial input and output. On Linux a good choice is /dev/ttyS0 or /dev/ttyS1. @@ -1484,17 +1723,44 @@ Click on
| ALTGR+a | +AltGr+a | record animation | |
| ALTGR+g | +AltGr+g | grab a screenshot | |
| ALTGR+i | +AltGr+i | boss key: leave full screen mode, pause Hatari and iconify its window | |
| ALTGR+j | -toggle joystick emulation via cursor keys - on/off between ports 0 and 1 | -||
| ALTGR+m | +AltGr+m | (un-)lock the mouse into the window | |
| ALTGR+r | +AltGr+r | (warm) reset the ST | |
| ALTGR+c | -coldreset the ST (same as the original power switch) | +AltGr+c | +cold reset the ST (same as the original power switch) |
| ALTGR+d | +AltGr+d | open dialog to select/change disk A | |
| ALTGR+s | +AltGr+s | enable/disable sound | |
| ALTGR+q | +AltGr+q | quit the emulator | |
| ALTGR+x | +AltGr+x | toggle normal speed/fast forward | |
| ALTGR+y | +AltGr+y | enable/disable sound recording | |
| ALTGR+k | +AltGr+k | save memory snapshot | |
| ALTGR+l | +AltGr+l | load memory snapshot | |
| ALTGR+f or F11 | +AltGr+j | +toggle joystick emulation via cursor keys + on/off between ports 0 and 1 | +|
| AltGr+F1 | +switch joystick type on joy port 0 | +||
| AltGr+F2 | +switch joystick type on joy port 1 | +||
| AltGr+F3 | +switch joystick type for joypad A | +||
| AltGr+F4 | +switch joystick type for joypad B | +||
| AltGr+b | +toggle borders on/off | +||
| AltGr+f or F11 | toggle between fullscreen and windowed mode | ||
| ALTGR+o or F12 | +AltGr+o or F12 | activate the options GUI | |
| PAUSE | +Pause | pause emulation | |
| AltGr+PAUSE | +AltGr+Pause | invoke the internal Hatari debugger |
You can change the key bindings from the Hatari configuration file. -The required key values can be seen in the SDL_keysym.h include file -(usually in /usr/include/SDL/).
+See keymap-sample.txt file for instructions.NOTE: Problems with simultenous keypresses most likely aren't an +
NOTE: Problems with simultaneous keypresses most likely aren't an issue in Hatari as many modern keyboards report/support only three -simultenous key presses (or even just two depending on which keys +simultaneous key presses (or even just two depending on which keys are in question). Expensive gaming keyboards support more.
@@ -1645,23 +1930,26 @@ the ST mouse pointer.However it is a little bit different in windowed mode as mouse cursor positions between host and emulated Atari can get out of sync. This can be worked around by constraining the mouse -to the Hatari window. Pressing the ALTGR+m +to the Hatari window. Pressing the AltGr+m hotkey combination or starting Hatari with the --grab command line option grabs the mouse i.e. locks its movements to the Hatari window. Press the shortcut key (again) to go back to normal mouse behaviour -which allows you to move mouse outside outside the Hatari window while +which allows you to move mouse outside the Hatari window while Hatari is up and running. Note: pausing the emulation will also (temporarily) release the mouse grab.
+Middle button click emulates double click, which is very useful +in Fast Forward mode (where normal double clicking is nearly +impossible).
Mouse scrollwheel will act as cursor up and down keys.
The Atari ST joysticks are emulated ofcourse allowing you to play +
The Atari ST joysticks are emulated of course allowing you to play your favourite games with Hatari.
The default mode is to use a connected PC joystick. You can use any -joystick that is supported by your kernel. If your joystick works with -other applications, it will likely work with Hatari as well. Make sure +joystick that is supported by your kernel / SDL library. If your joystick works +with other applications, it will likely work with Hatari as well. Make sure it is calibrated and then off you go. Move the stick to point into the desired direction. Please note that Hatari will not detect analogue movement as the Atari ST only had digital joysticks. The first @@ -1722,10 +2010,14 @@ this can cause your printer to print out
Serial communications in Hatari is designed to directly use a serial port on your PC.
Communications parameters are set automatically upon the settings of -the emulated ST. This means all you do is to set -the communication parameters like baudrate from your ST communications -software. Hatari will do the rest and handle -the serial input and output for you.
+the emulated machine. This means all you do is to set the communication +parameters like baudrate from the emulated communications software. +Hatari will do the rest and handle the serial input and output for you. +Note that the “normal” RS232 port of Hatari is the one that +is connected to the MFP chip of the selected system. This port is only +wired on the ST, STE and TT machines, but not on the Falcon. To use serial +port emulation in Falcon mode, you have to use the “SCC channel B” +emulation instead.
If you've got a disk image that has been created with the old ST +
If you have got a disk image that has been created with the old ST emulator PaCifiST (for DOS) or with early versions of the program Makedisk, and the disk image does not work with Hatari, then the disk probably suffers from the "PaCifiST bootsector bug" (Hatari will @@ -1848,12 +2140,22 @@ for bigger images is not tested very wel
The maximum size of partitions inside the hard disk (images) depends on the TOS version. TOS 1.00 and 1.02 support up to 256 MB, TOS 1.04 to 3.06 up to -512 MiB and TOS 4.0x supports up to 1 GB partitions. +512 MB and TOS 4.0x supports up to 1 GB partitions. +
++NOTE: you need to be careful when mounting device files. Depending on +the system setup (e.g. udev settings) partitions on memory cards etc. +can be mounted automatically. When Hatari is started and uses a device +file with partitions that are already mounted, data can be destroyed +(when several programs independently write to the same device). +Disable your desktop automount, or remember to manually unmount +devices before giving them to Hatari.
+-With the GEMDOS HD emulation, you can easily "mount" a folder from the +With GEMDOS HD emulation, you can easily "mount" a folder from the host file system to a drive of the emulated Atari.
@@ -1862,13 +2164,22 @@ subdirectories, each of these subdirecto separate partition, otherwise the given directory itself will be assigned to drive "C:". In the multiple partition case, the letters used as the subdirectory names will determine to which -drives/partitions they're assigned. +drives/partitions they're assigned. For example following +directory setup: +
++partitions/ + + C/ + + D/ ++
+That is given to Hatari as "hatari -d partitions", will give you +GEMDOS HD emulated C: and D: drives.
GEMDOS HD emulation is an easy way to share files between the -host system and the emulated Atari, but there are also some known -limitations which are due to the way the GEMDOS HD emulation is -implemented: +host system and the emulated Atari, but there are also several +limitations:
-So, if your programs complain that they could not find/read/write -files on the GEMDOS emulated drive, you should try to copy them to a -floppy disk image or a real hard disk image! +If your programs complain that they could not find/read/write +files on the GEMDOS emulated drive, you can copy and use them +from a floppy disk image or a real hard disk image instead.
+ ++Accessing HD image files is easiest with EmuTOS. It supports both +ASCI and IDE interfaces, regardless of emulated machine type, and +understands DOS partition tables without additional drivers. +atari-hd-image.sh script coming +with Hatari can be used to create such image files and to copy +initial data to them. +
++If you have an hard drive (image) with Atari format partition table, +that should already have hard disk driver on it and work fine. +Partitioning/formatting them is the problem. Creating such images +from scratch is described in following sections. +
+ +To use the ACSI hard drive emulation, you need a hard disk image file @@ -1925,19 +2266,24 @@ disk image with it.
Formatting and partitioning works currently only with AHDI 5, but you -can install the AHDI 6 driver to the hard disk after it's formatted. +can install the AHDI 6 driver to the hard disk after it is formatted. Restart the emulated system, run AHDI.PRG from the floppy disk to access the hard disk image from the emulated Atari and then run HINSTALL.PRG. After installing the hard disk driver to the fresh HD image with HINSTALL.PRG, you can boot directly from the hard disk image.
++HD Driver (v9) partitioning is also compatible with Hatari ACSI +emulation. CBHD and ICDPro AdSCSI drivers work on images which have +been partitioned elsewhere. +
+-
As the IDE disk format (little endian) differs from the ACSI disk format (big endian), you need separate disk images for them. Hatari doesn't -currently support formatting IDE disks with AHDI, but you can do it with +currently support partitioning IDE disks with AHDI, but you can do it with Cecile.
@@ -1963,9 +2309,9 @@ If you only want to use your HD image in the Cecile hard disk driver to the image from the Cecile CC_TOOLS.APP: Click the "Installer" button and save the Cecile driver to the 1st partition on "Hatari IDE disk". If you want to also use your HD -image in ST/STE mode, you need to get and install AHDI 6 driver on it -instead (see ASCI hard drive -emulation section). +image in ST/STE mode, you need to get and install either HD Driver or +AHDI 6 driver on it instead (see ASCI +hard drive emulation section).
Then you can boot from your hard disk image by simply specifying it @@ -1980,19 +2326,23 @@ either through GEMDOS HD partitions (hos Hatari emulation) or accessing the images directly on the host (outside the emulation). Both have their own limitations.
-If it's fine for the IDE/ACSI partitions to be first, you can use -hard disk images with AHDI or Cecile driver and a multipartition -GEMDOS HD setup as described in above sections. If you want to boot from -a GEMDOS HD partition i.e. such to be before hard disk image partitions, -and still to be able to access all the IDE/ACSI partitions, you need to -use HD Driver.
+If it is fine for the IDE/ACSI partitions to be first, you can +either use ACSI/IDE partition skip option, or a multipartition GEMDOS +HD setup as described in above sections. +
+ +If you want to boot from a GEMDOS HD partition i.e. such to be +before hard disk image partitions, and still to be able to access all +the IDE/ACSI partitions, you need to use HD Driver. Note: this is the +preferred method with EmuTOS (v0.9.x), because it doesn't run/use +driver installed to the IDE/ACSI image directly although its own +partition table/type support is very limited.
Uwe Seimet's HD Driver works fine with both the Hatari GEMDOS HD partitions and normal -hard disk images. However, it doesn't work with EmuTOS so you need -real TOS (at least version v1.04). +hard disk images.
First copy the HDDRIVER.PRG binary into your GEMDOS HD emulation @@ -2005,12 +2355,14 @@ this GEMDOS HD directory, for example li "hatari --harddrive gemdos-hd/ --ide-master ide-hd.image".
-If you're using the demo version of HD Driver, you can -write files only to the C: partition, i.e. in above case only copy -files from the hard disk image partition to the GEMDOS HD partition (with -some write slowndowns included into the demo version). If you want to -copy files to the hard disk image with the demo version of -the HD Driver, you need to set the hard disk image as drive C:.
+If you're using +the demo version +of HD Driver, you can write files only to the C: partition, i.e. in +above case only copy files from the hard disk image partition to the +GEMDOS HD partition (with some write slowdowns included into the demo +version). If you want to copy files to the hard disk image with +the demo version of the HD Driver, you need to set the hard disk +image as drive C:.
To accomplish this, set the GEMDOS HD partitions to be from D: forward, i.e. have a directory which contains only single letter subdirectories, @@ -2019,7 +2371,8 @@ mkdir gemdos-hd/D
". Then give Hat a boot floppy image containing the demo version of HDDRIVER.PRG in its AUTO folder, like this: "hatari --ide-master ide-hd.image --harddrive gemdos-hd/ hd-driver-floppy.st". - +You can convert HD Driver ZIP package to floppy image with the +zip2st utility.-Note that plain EmuTOS supports only ACSI and the listed HD drivers -support only IDE (emulation). Cecile needs TT or Falcon and HD Driver -doesn't work with EmuTOS. To summarise; if ASCI emulation and -EmuTOS are enough, use those. Otherwise, if you want to use TT or -Falcon emulation, use Cecile (or full HD Driver version if you have -it), otherwise use HD Driver (demo). +To summarise; if EmuTOS is enough, use that. Otherwise, if you want to +use TT or Falcon emulation, use Cecile (or full HD Driver version if +you have it), otherwise use HD Driver (demo).
To access the content of the partitions on Linux host, there are two @@ -2073,9 +2424,8 @@ MTOOLS_NO_VFAT=1 mcopy -spmv -i hd.img f
-This is recommended even by Mtools documentation, but it's less -convenient as it requires root rights. First you need to "loop" -mount the image: +This is recommended even by Mtools documentation, but it is less convenient +as it requires root rights. First you need to "loop" mount the image:
$ su
@@ -2095,9 +2445,9 @@ the hd.img
-After you've copied the relevant files to the "hd" directory, you need
-unmount the file system and remove the loop device binding before using
-the disk image from Hatari:
+After you have copied the relevant files to the "hd" directory, you need
+to unmount the file system and remove the loop device binding before
+using the disk image from Hatari:
# umount $mountdir
@@ -2113,21 +2463,31 @@ analyzing code that runs in the emulated
-The debugger uses Hatari's parent console window, so make sure you run
-Hatari from the command line when you want to use the debugger. On
-Linux you can add for example an icon to your desktop that does it
-with something like this (replace "xterm" with your favorite terminal
-program):
+On Unix (Linux / macOS) debugger uses Hatari's parent console window, so
+make sure you run Hatari from the command line when you want to use
+the debugger. On Windows you need to use "-W" option to get console
+window. You can add an icon to your desktop that does it. On Linux
+it should do something like this (replace "xterm" with your favorite
+terminal program):
xterm -T "Hatari debug window" -e hatari
-To run debugger commands at Hatari startup, one can use the "--parse
-<file>" command line option. This is useful e.g. for debugging
-TOS or some demo startup code, or if you always want to use some
-specific debugger setup (breakpoints etc).
+To run debugger commands from a file at Hatari startup, one can use
+the "--parse <file>" command line option. This is useful e.g.
+for debugging TOS or some demo startup code, or if you always want to
+use some specific debugger setup (breakpoints etc).
+
+
+
+Note that when debugger scripts are run, current directory is set to
+the currently running script's directory i.e. all file operations are
+relative to it. After script finishes, earlier current directory is
+restored. To set current directory from a setup script, e.g. for
+scripts run at breakpoints, you need to give '-f' option for the
+'cd' command.
@@ -2141,14 +2501,14 @@ You can invoke the debugger manually by
With the "-D" command line option, you can toggle whether m68k
exceptions will also invoke the debugger. Which exceptions cause
-this, can be controlled with the "--debug-except" option.
+this, can be controlled with the "--debug-except" option.
Giving "-D" option at Hatari startup is not advised because TOS HW
-checks generate some exceptions at every TOS boot. It's better to
+checks generate some exceptions at every TOS boot. It is better to
toggle exception catching later from the debugger with the "setopt -D"
-command.
+command.
@@ -2170,15 +2530,18 @@ Generic commands:
cd ( ) : change directory
evaluate ( e) : evaluate an expression
help ( h) : print help
- history (hi) : show last CPU & DSP PC values & executed instructions
+ history (hi) : show last CPU/DSP PC values & executed instructions
info ( i) : show machine/OS information
lock ( ) : specify information to show on entering the debugger
logfile ( f) : open or close log file
parse ( p) : get debugger commands from file
+ rename ( ) : rename given file
+ reset ( ) : reset emulation
setopt ( o) : set Hatari command line and debugger options
stateload ( ) : restore emulation state
statesave ( ) : save emulation state
trace ( t) : select Hatari tracing settings
+ variables ( v) : List builtin symbols / variables
quit ( q) : quit emulator
CPU commands:
@@ -2193,7 +2556,7 @@ CPU commands:
savebin ( ) : save memory to a file
symbols ( ) : load CPU symbols & their addresses
step ( s) : single-step CPU
- next ( n) : step CPU, proceeding through subroutine calls
+ next ( n) : step CPU through subroutine calls / to given instruction type
cont ( c) : continue emulation / CPU single-stepping
DSP commands:
@@ -2205,7 +2568,7 @@ DSP commands:
dspprofile (dp) : profile DSP code
dspreg (dr) : read/write DSP registers
dspstep (ds) : single-step DSP
- dspnext (dn) : step DSP, proceeding through subroutine calls
+ dspnext (dn) : step DSP through subroutine calls / to given instruction type
dspcont (dc) : continue emulation / DSP single-stepping
@@ -2221,7 +2584,7 @@ pressing TAB will (for most commands) sh
If you want to give numbers in other number bases
than the default/selected one, they need to be prefixed with a
character indicating this. For decimals this prefix is "#" (#15),
-for hexadecimals "$" ($F), and for binary values it's "%" (%1111).
+for hexadecimals "$" ($F), and for binary values it is "%" (%1111).
@@ -2240,14 +2603,14 @@ conditional breakpoints can be unexpecte
Instead of a number, you can also use an arithmetic expression, by
surrounding it with quotes (""). An expression can contain
-calculations with CPU and DSP register, symbol and Hatari variable
-values in addition to numbers. For example to give a sum of A0 and
-D0 register values to a command, use "a0+d0".
+calculations with CPU and DSP registers, symbols and Hatari variables
+in addition to numbers. For example to give a sum of A0 and D0
+register values to a command, use "a0+d0".
-Within arithmetic expressions parenthesis are used both to change
-the order of precendence and to indicate indirect addressing.
+Also within arithmetic expressions, parenthesis are used to indicate
+indirect addressing, not to change the order of precedence.
Unlike with conditional breakpoint expressions (explained below), you
cannot give size for the indirect addressing, a long value is always
read from the RAM address given within parenthesis. For example to
@@ -2257,7 +2620,7 @@ get a long value pointed by stack pointe
Values of arithmetic expressions are always evaluated before being
given to a command. Except for "evaluate" and "address" commands,
-they always need to be marked with quotes (""). Besides arithmetics,
+they always need to be marked with quotes (""). Besides arithmetic,
this can be used also to give symbol/register/variable values to
commands that don't otherwise interpret them. If command complains
that it didn't recognize e.g. a register name, just put it to quotes
@@ -2265,6 +2628,29 @@ and it will be "evaluated" before being
+Virtual V0-V7 "registers" can be used to store intermediate results
+for calculations. For example, to get a sum of "_counter" symbol
+address contents one could use following in suitable breakpoint:
+
+
+# store counter sum to V0 virtual register
+r v0=(_counter)
+# store count of how many values are added
+r v1="v1+1"
+
+And then later on, calculate the average:
+
+# round the counter sum (add half count to sum)
+r v2="v0 + v1/2"
+# and calculate the rounded average (rounded sum / count)
+e v2/v1
+
+(Another virtual register was used for rounding here, in case one
+wants to continue summing the _counter values with the original
+value.)
+
+
+
With command argument completion (see build
notes), result from the last "evaluate" command can be inserted
by typing '$' and pressing TAB.
@@ -2281,8 +2667,11 @@ commands to do the same for the DSP.
> help memdump
'memdump' or 'm' - dump memory
-Usage: m [start address-[end address]]
- dump memory at address or continue dump from previous address.
+Usage: m [b|w|l] [start address-[end address| count]]
+ dump memory at address or continue dump from previous address.
+ By default memory output is done as bytes, with 'w' or 'l'
+ option, it will be done as words/longs instead. Output amount
+ can be given either as a count or an address range.
> help disasm
@@ -2305,7 +2694,7 @@ Both commands accept in addition to nume
and symbol names, like in above example. If you don't specify an
address, the commands continue showing from an address that comes
after the previously shown data. "disasm" command default address
-will be reseted to PC address every time you re-enter the debugger.
+will be reset to PC address every time you re-enter the debugger.
@@ -2365,22 +2754,21 @@ dsp_symbols").
For a program under GEMDOS HD emulation
-If you're using GEMDOS HD emulation, and your program contains symbol
-table in DRI/GST format, you can load its symbol names/addresses to
-the debugger with the following command, after program has been loaded
-to the memory by TOS (see setting
-breakpoint at program startup):
+If currently running program contains debug symbol table,
+and it is started from GEMDOS HD emulated drive, its symbol names /
+addresses are automatically loaded when debugger is entered, and
+removed when program terminates.
+
+
+Above happens only if there are no symbols loaded when the program
+starts. If there are, you can load program symbol data manually with
+the following command, after program has been loaded to the memory by
+TOS (see setting breakpoint at program
+startup):
symbols prg
-
-
-
-Debugger loads the symbols automatically for currently running
-Atari program when entering the debugger, if no CPU symbols are yet
-loaded.
-
The options you need to add suitable symbol table to your programs,
@@ -2390,10 +2778,11 @@ depend on which toolchain you use to bui
Devpac:
"OPT D+,X+"
AHCC:
-"-g", and "-l" option for local symbols, both for linking
+"-g" and "-l" options for linking
GCC:
-"-Wl,--traditional-format" option for linking,
- and "-g" for compilation to get local symbols
+"-g" for compilation, and no strip option for linking
+(with older Hatari versions that didn't support a.out format,
+also "-Wl,--traditional-format" option was needed for linking)
VBCC:
"-g" (can only be used at linking phase), when VBCC
configuration file uses "-bataritos" option for
@@ -2411,10 +2800,10 @@ $ gst2ascii -l -o program.tos > progr
For a program on a (disk) image
-If the program isn't run from a GEMDOS HD emulated drive, but from a
-cartridge, floppy or HD image, you need to have the corresponding
-program also as normal host file which location you can give to the
-debugger:
+If the program isn't run from a GEMDOS HD emulated drive, but from
+a cartridge, floppy or HD image, you need to have the corresponding
+program also as a normal host file which location you can give to
+the debugger:
symbols /path/to/the/program.tos
@@ -2424,18 +2813,30 @@ symbols /path/to/the/program.tos
ASCII debug symbol files
-If Hatari complains that your program doesn't have DRI/GST format
-symbol table, or its symbols are in some other format, and you
-cannot re-compile it to have them, you have two options:
+If Hatari complains that your program doesn't have debug symbol table,
+or its symbols are in some unsupported format, and you cannot re-compile
+it to include a.out or GST/DRI symbols, you have two options:
- Convert the symbols to ASCII format understood by the Hatari debugger.
Writing converters for other ASCII formats is easy, and Hatari already
- contains covertors for DSP LOD files, nm
+ contains converters for DSP LOD files, nm
output for MiNT/a.out binaries and AHCC map files.
-
- Create the ASCII symbols file by hand as you're debugging a program.
+
- Create the ASCII symbols file by hand while you're debugging a program.
+NOTE: nm output for GCC generated
+a.out binaries includes labels also for loops,
+not just functions. While loop labels are fine for debugging, they should
+be removed before profiling. Besides causing misleading profile
+results, loop labels can seriously slow down profiling
+(call graph tracking is automatically enabled for profiling when debug
+symbols are loaded, and operations done on each matched symbol address
+cause huge overhead if that match is for something happening every few
+instructions).
+
+
+
ASCII symbols file format is following:
e01034 T random
@@ -2453,7 +2854,7 @@ starting with '#' (comments) are ignored
Debugger will automatically "relocate" the symbol addresses when it
loads them from a program binary, but with ASCII symbol files you need
to give the relocation offset(s) separately, unless the symbol names
-are for fixed adresses (like is the case e.g. with EmuTOS):
+are for fixed addresses (like is the case e.g. with EmuTOS):
symbols program.sym TEXT DATA BSS
@@ -2488,7 +2889,7 @@ breakpoints so you need to use "b" comma
Then there are the conditional breakpoints which can handle much more
complex break condition expressions; they can track changes to
register and memory values with bitmasks, include multiple conditions
-for triggering a breakpoint and so on. Use "b" (or "db" for the DSP)
+for triggering a breakpoint and so on. Use "b" (or "db" for the DSP)
to manage them.
@@ -2524,7 +2925,7 @@ conditions need to be true for a breakpo
Normally when a breakpoint is triggered, emulation is stopped and you
get to the debugger. Breakpoint options can be used to affect what
happens when a breakpoint is triggered. These options are given after
-the conditions and are prefixed with ':'.
+the conditions and are prefixed with ':'.
@@ -2538,7 +2939,7 @@ a $1234 :2
- once
-
-Delete the breakpoint when it's hit i.e. trigger it only once. It may
+Delete the breakpoint when it is hit, i.e. trigger it only once. It may
be useful if you just want to get a specific address. Or if you're on
an instruction that jumps back to a start of the loop and you want to
finish the loop, you could use:
@@ -2639,7 +3040,7 @@ b (a0) = "d0"
If you're interested only on certain bits in the value, you can use
'&' and a numeric mask on either side of comparison operator to
-mask the coresponding value, like this:
+mask the corresponding value, like this:
b ($ff820).w & 3 = (a0) && (a1) = d0 & %1100
@@ -2657,7 +3058,7 @@ b d0 > $20 && d0 < $40
As a convenience, if the both sides of the comparison are exactly the
-same (i.e. condition is redundant as it's always either true or
+same (i.e. condition is redundant as it is always either true or
false), the right side of the comparison is replaced with
its current value. This way you can give something like this:
@@ -2682,7 +3083,7 @@ b ($ffff9202).w ! ($ffff9202).w :trace
Because tracking breakpoint conditions will print the evaluated
value when it changes, they're typically used with the trace option
-to track changes e.g. to some IO register.
+to track changes e.g. to some I/O register.
@@ -2698,19 +3099,19 @@ unless tracking condition is given as th
-
Hatari will internally update some register values without immediately
-updating the corresponding IO address range memory addresses. For
+updating the corresponding I/O address range memory addresses. For
example the Busy bit for the internal Blitter control register is
-(internally) cleared when Blitter activity stops, but the actual IO
+(internally) cleared when Blitter activity stops, but the actual I/O
address for that control register gets updated only when something
-actually writes or reads that IO address. Many HW registers behave
+actually writes or reads that I/O address. Many HW registers behave
like this (status registers in FDC, ACIA, MFP, Blitter...).
-For breakpoints that track just a single IO register memory address, or
+For breakpoints that track just a single I/O register memory address, or
multiple ones of which none are modified by Hatari,
only by emulated code, this is not a problem, they get triggered as
expected.
-However, if you have a breakpoint that tracks multiple IO registers
+However, if you have a breakpoint that tracks multiple I/O registers
where some of them are updated by Hatari, for example to check that
other Blitter registers aren't updated while control register
indicates Blitter to be active (busy), things don't work as expected!
@@ -2723,23 +3124,37 @@ indicates Blitter to be active (busy), t
In addition to loaded symbols, the debugger supports also setting
conditional breakpoints on values of some "virtual" variables listed
-by "b help". For example:
+by "variables" (v) command. For example:
-- If you want the emulation to stop on the first instruction of
- next program; after TOS desktop is up, set a breakpoint on
- the TEXT segment address given in a program basepage:
+
- Aes/Bios/Gemdos/LineA/LineF/Vdi/XbiosOpcode variables can be used
+ to catch AES, BIOS, GEMDOS, Line-A, Line-F, VDI and XBIOS OS-calls.
+ By default they contain the 0xffff value, so to trace e.g. all AES
+ calls (instead of a specific one) one needs to use something like this:
+
+b AesOpcode ! AesOpcode && AesOpcode < 0xffff :trace
+
+
+- To stop when TOS starts next program, set a breakpoint for
+ Pexec(0,...) OS call:
+
+b GemdosOpcode = 0x4B && OsCallParam = 0x0
+
+
+- Then, to stop emulation on the first instruction of that
+ program, set a breakpoint when program counter matches
+ the TEXT (i.e. code) segment address (taken from program
+ basepage):
b pc = TEXT :once
-Note1: It's better to trigger it only once because if you'd leave it on,
-during reboot you would get a warning for every instruction until TOS sets
-a valid basepage.
+Note1: It is better to trigger it only once, because if you would leave it
+on, during (re)boot you would get a warning for every instruction
+(until TOS sets a valid basepage).
-Note2: you cannot use an address breakpoint for this because value of
-a variable given to address breakpoint is evaluated when it's set, not
-at run-time, so it cannot get the new value that the TEXT variable
-gets when you start a program.
+Note2: you cannot use an address breakpoint for this because
+variable values are evaluated at run-time only for conditional
+breakpoints.
- To view current program DATA and BSS segment contents,
use the corresponding variables:
@@ -2750,25 +3165,17 @@ m BSS
- If you want to stop at a specific cycle within a frame (that is,
PC relative to the current VBL/HBL in cycles), set breakpoints to
- specific "HBL" and "FrameCycles" variable values. If you for
- example want to break after 20 HBLs, use:
+ specific "HBL" and "FrameCycles" variable values. If you want,
+ for example, to break after 20 HBLs, use:
b HBL = "HBL+20"
-- Aes/Bios/Gemdos/LineA/LineF/Vdi/XbiosOpcode variables can be used
- to catch AES, BIOS, GEMDOS, Line-A, Line-F, VDI and XBIOS OS-calls.
- By default they contain the 0xffff value, so to trace e.g. all AES
- calls, instead of a specific one, one needs to use something like this:
-
-b AesOpcode ! AesOpcode && AesOpcode < 0xffff :trace
-
-
Hint: "info" command "aes", "bios", "gemdos", "vdi" and "xbios"
-subcommands for can be used to list the corresponding OS-call opcodes.
+subcommands can be used to list the corresponding OS-call opcodes.
For example, to see the GEMDOS opcodes, use:
info gemdos 1
@@ -2787,25 +3194,30 @@ another one is set.
For example if you have these input files:
-- "break.ini":
+
- "pexec.ini":
-b GemdosOpcode = 0x3D :trace :once :file program.ini
+# continue to "program.ini" on Pexec(0, ....)
+b GemdosOpcode = 0x4B && OsCallParam = 0x0 :trace :once :file program.ini
- "program.ini":
+# continue to "trace.ini" when program execution starts
b pc = TEXT :trace :once :file trace.ini
- "trace.ini":
+# load symbols, trace gemdos & program function calls
symbols prg
trace gemdos,cpu_symbols
+# continue to "disable.ini" after 4 VBLs
b VBL = "VBL+4" :trace :once :file disable.ini
- "disable.ini":
+# stop tracing and remove breakpoints
trace none
b all
@@ -2813,20 +3225,19 @@ b all
-And then start Hatari with the first debugger input file and a GEMDOS
-HD directory containing "desktop.inf" file:
+And then start Hatari with the first debugger input file:
-hatari --parse break.ini /path/to/your/program.tos
+hatari --parse pexec.ini /path/to/your/program.tos
-- "break.ini" input file will break when TOS opens
- the "desktop.inf" file (it's the first Fopen() i.e. GEMDOS call
- 0x3D done by TOS at boot) and the breakpoint will run
- the debugger commands from the "symbols.ini" file
-
- "program.ini" will setup breakpoint to program startup
- (because TEXT variable cannot be used before TOS has booted)
+
- "pexec.ini" sets a breakpoint to parse debugger commands from
+ "program.ini" when TOS starts loading the given program
+ (it is first Pexec(0) after boot)
+
- "program.ini" sets a breakpoint to parse debugger commands from
+ "trace.ini" when program code begins executing. These two steps
+ are needed because TEXT variable isn't valid until TOS has booted
- "trace.ini" input file loads symbols for the run program, sets Hatari
to trace several things (see Tracing section
below) in the emulated system for few VBLs until breakpoint runs
@@ -2840,18 +3251,18 @@ hatari --parse break.ini /path/to/your/p
- Because debugger input files cannot "continue"
emulation, ":trace" option needs to be used for the breakpoint(s)
if you want emulation to continue after the breakpoint action(s).
-- In simpler breakpoint chain (like above), new breakpoint just
-replaces the previous one, ":once" option tells that breakpoint
-isn't needed after it's hit.
+
- In simpler breakpoint chain (like above), where new breakpoint
+just replaces the previous one, ":once" option tells debugger that
+breakpoint isn't needed after it is hit.
-Hint: It's better to test each input file separate before testing the
-whole chain. Besides the ":file" breakpoint option, these debugger
-input files can be also read with the debugger "file" command, "lock"
-command "file" option and with the Hatari "--parse" command line
-option.
+Hint: It is better to test each input file separately before testing
+the whole chain. Besides the ":file" breakpoint option, you can test
+these debugger input files also with the debugger "file" command,
+"file" option for the "lock" command, and with the Hatari "--parse"
+command line option.
Stepping through code
@@ -2867,19 +3278,29 @@ triggers) if you omit the instruction co
If you want to continue just to the next instruction, use "s" (step)
command to continue for exactly one instruction, or "n" (next), if you
-want to skip subroutine and exception calls. "ds" and "dn" commands
-do the same for DSP.
+want to skip subroutine + exception calls and DBCC branching backwards
+(i.e. loops). "ds" and "dn" commands do the same for DSP (except that
+"dn" doesn't skip loops).
You can also continue with the "n" until instruction of certain
type is encountered, by giving it the instruction type:
-- "branch" matches branch instructions: BCC, BRA, DBCC, JMP
-- "subcall" matches subroutine calls: BSR, JSR
-- "subreturn" matches return from subroutine: RTD, RTR, RTS
-- "exception" matches exceptions: BKPT, ILLG, STOP, TRAP, TRAPV
-- "exreturn" matches return from exception: RTE
+- "branch" matches branch instructions:
+ CPU: BCC, BRA, DBCC, JMP
+ DSP: DO/ENDO JCC, JCLR, JMP, JSET, REP
+- "subcall" matches subroutine calls:
+ CPU: BSR, JSR
+ DSP: JSCC, JSCLR, JSSET, JSR
+- "subreturn" matches return from subroutine:
+ CPU: RTD, RTR, RTS
+ DSP: RTS
+- "exception" matches exceptions:
+ CPU: BKPT, ILLG, STOP, TRAP, TRAPV
+- "exreturn" matches return from exception:
+ CPU: RTE
+ DSP: RTI
- "return" matches both subroutine and exception returns
@@ -2911,7 +3332,7 @@ Notes:
-
If GEMDOS HD emulation isn't enabled, GEMDOS call tracing needs to be
-enabled at Hatari command line, it's not possible to enable it after
+enabled at Hatari command line, it is not possible to enable it after
TOS has initialized GEMDOS.
-
@@ -2930,7 +3351,7 @@ it cannot be changed from within the deb
-If there isn't a trace option for something you'd like to track,
+If there isn't a trace option for something you would like to track,
you may be able to use tracing breakpoints, explained above.
For example, following tracks Line-A calls:
@@ -2995,35 +3416,39 @@ Cartridge ROM (0xFA0000-0xFC0000):
Investigating the profile data
-When you're back in debugger, you can inspect the collected profile data:
+When you are back in debugger, you can inspect the collected profile data:
> h profile
'profile' - profile CPU code
Usage: profile <subcommand> [parameter]
- Subcommands:
- - on
+ Subcommands:
+ - on
- off
- counts [count]
- cycles [count]
- - misses [count]
+ - i-misses [count]
+ - d-hits [count]
- symbols [count]
- addresses [address]
- callers
+ - caches
- stack
- stats
- save <file>
- loops <file> [CPU limit] [DSP limit]
- 'on' & 'off' enable and disable profiling. Data is collected
+ 'on' ¨ 'off' enable and disable profiling. Data is collected
until debugger is entered again at which point you get profiling
statistics ('stats') summary.
Then you can ask for list of the PC addresses, sorted either by
- execution 'counts', used 'cycles' or cache 'misses'. First can
- be limited just to named addresses with 'symbols'. Optional
- count will limit how many items will be shown.
+ execution 'counts', used 'cycles', i-cache misses or d-cache hits.
+ First can be limited just to named addresses with 'symbols'.
+ Optional count will limit how many items will be shown.
+
+ 'caches' shows histogram of CPU cache usage.
'addresses' lists the profiled addresses in order, with the
instructions (currently) residing at them. By default this
@@ -3065,15 +3490,16 @@ around top addresses:
> profile addresses 0xe06f04
# disassembly with profile data:
-# <instructions percentage>% (<sum of instructions>, <sum of cycles>, <sum of i-cache misses>)
-$e06f04 : bra.s $e06f10 0.00% (48, 576, 0)
-$e06f06 : move.b $fffffa01.w,d1 12.11% (555708, 8902068, 0)
-$e06f0a : btst #5,d1 12.11% (555708, 6685268, 0)
-$e06f0e : beq.s $e06f1e 12.11% (555708, 4457312, 0)
-$e06f10 : move.l $4ba,d1 12.11% (555724, 11125668, 0)
-$e06f16 : cmp.l d1,d0 12.11% (555724, 4461708, 0)
-$e06f18 : bgt.s $e06f06 12.11% (555724, 4455040, 0)
-$e06f1a : moveq #1,d0 0.00% (16, 64, 0)
+# <instructions percentage>% (<sum of instructions>, <sum of cycles>, <sum of i-cache misses>, <sum of d-cache hits>)
+
+$e06f04 : bra.s $e06f10 0.00% (48, 576, 0, 0)
+$e06f06 : move.b $fffffa01.w,d1 12.11% (555708, 8902068, 0, 0)
+$e06f0a : btst #5,d1 12.11% (555708, 6685268, 0, 0)
+$e06f0e : beq.s $e06f1e 12.11% (555708, 4457312, 0, 0)
+$e06f10 : move.l $4ba,d1 12.11% (555724, 11125668, 0, 0)
+$e06f16 : cmp.l d1,d0 12.11% (555724, 4461708, 0, 0)
+$e06f18 : bgt.s $e06f06 12.11% (555724, 4455040, 0, 0)
+$e06f1a : moveq #1,d0 0.00% (16, 64, 0, 0)
Disassembled 8 (of active 14240) CPU addresses.
@@ -3096,16 +3522,15 @@ Profile data accuracy from most to least
default emulation options are used is following:
- Executed CPU and DSP instruction counts are accurate.
-- DSP cycles counts (and their variance information) should be accurate.
-
-- 030 CPU instruction cache miss information (provided by WinUAE CPU core)
- is assumed to be accurate.
-- Cycles used by a given CPU instruction depend to some extent on what
- instruction(s), and data in case of 030, was processed before it.
- While Hatari has some (instruction pairing) heuristics to take
- that into account for 68000, in general instruction cycles are
- averages. For 68000, cycles (provided by OldUAE CPU core) should
- be fairly accurate, for 68030 they aren't (yet) not very accurate.
+- 68000 cycle counts have been tested to be accurate to within 1%.
+- DSP cycle counts (and the variance information) should be accurate.
+- 030 CPU instruction cache hit/miss counts (provided by WinUAE CPU core)
+ are assumed to be accurate.
+- As to 680x0 cycles... Cycles used by a given CPU instruction depend
+ on what instruction(s) is executed, where it was executed (ST or
+ TT-RAM) and what data was processed before it (was it cached).
+ E.g. 030 cycle counts can be off by tens of percents.
+- FPU instruction cycles can be off by 2x.
@@ -3149,6 +3574,11 @@ Finalizing costs for 12 non-returned fun
("profile stack" command can be used in breakpoints with :noinit
option to show backtraces during caller profiling.)
+Note: rest of this subsection is about caller information format
+which is mainly of interest for people writing profiling
+post-processing tools. Come back here if you think there's
+some problem with callgraphs produced by those tools.
+
Other information collected during profiling is shown with
following command:
@@ -3170,7 +3600,7 @@ following command:
For example, if you don't know all the places from which a certain
function is called, or in what context a certain interrupt handler can
-be called during the period you're profiling, profile caller
+be called during the period you are profiling, profile caller
information will tell you:
@@ -3217,7 +3647,7 @@ profiler cannot determine when exception
has special code to handle EmuTOS AES switcher because of this).
Typically this produces large list of functions that are finalized
at profile end, so it should be easy to detect.
-- Compilicated recursive calls seem to sometimes cause inclusive
+
- Complicated recursive calls seem to sometimes cause inclusive
costs (ones including costs of further subroutine calls) to be
incorrect. Sometimes this can be noticed by them being even
>100%.
@@ -3229,7 +3659,7 @@ profiler cannot determine when exception
Saving profile data to a file
-It's useful to save the profile data to a file:
+
It is useful to save the profile data to a file:
> profile save program-profile.txt
@@ -3237,7 +3667,7 @@ profiler cannot determine when exception
With the saved profile disassembly (and optional caller information)
you can more easily investigate what your program did during
profiling, search symbols & addresses in it, and compare the
-results to profiles you've saved from earlier versions of your code.
+results to profiles you have saved from earlier versions of your code.
You may even create your own post-processing tools for
investigating the profiling data more closely, e.g. to
@@ -3266,7 +3696,7 @@ installed by Hatari, to:
When the data is post-processed, you should always provide
the post-processor symbols for the profile code! Relying just on the
-symbol in the profile data can cause costs to be asssigned to wrong
+symbol in the profile data can cause costs to be assigned to wrong
symbol, if symbol's code wasn't called through symbol's own address,
but by jumping inside its code.
@@ -3282,11 +3712,11 @@ the symbols as TEXT (code) section relat
$ hatari_profile.py -r program.sym program-profile.txt
-If symbols are included to your binary in DRI/GST format, first they -need to be extracted to the ASCII format +
If symbols are included to your binary, first they need to be +extracted to the ASCII format understood by the post-processor:
-$ gst2ascii -l -o program.prg > program.sym +$ gst2ascii -a -l -o program.prg > program.sym
If there are some extra symbols that you don't want to see @@ -3295,7 +3725,7 @@ but e.g. loop labels, you can either rem from the ASCII *.sym file, or filter them out with grep:
-$ gst2ascii -l -o program.prg | grep -v -e useless1 -e useless2 > program.sym +$ gst2ascii -a -l -o program.prg | grep -v -e useless1 -e useless2 > program.sym@@ -3367,7 +3797,7 @@ Instruction cache misses:
If you want to see also symbol addresses and what is per call -cost, add -i option:
+cost, add -i option:
$ hatari_profile.py -st -i -r program.sym program-profile.txt [...] @@ -3397,7 +3827,7 @@ a cost count.)If your profile file contains caller information, you should add -p option to see it, as that will also help in detecting symbol issues (see Interpreting -the numbers):
+the numbers):
$ hatari_profile.py -st -p -r program.sym program-profile.txt [...] @@ -3492,8 +3922,8 @@ is same as count for how many times firsWhile subroutine costs should be more accurate and relevant, due to code optimizations many of the functions are not called as subroutines -(on m68k, using JSR/BSR), but just jumped or branced to. Because of -this, it's useful to compare both subroutine and between-symbols +(on m68k, using JSR/BSR), but just jumped or branched to. Because of +this, it is useful to compare both subroutine and between-symbols costs. One should be able to see from the profile disassembly which of the above cases is cause for the discrepancy in the values.
@@ -3505,10 +3935,10 @@ sure your optimization efforts can actuaGenerating and viewing callgraphs
-Callgraphs require saved profile data to contain caller function -address information, i.e. symbols should have been loaded before -starting profiling (either automatically, or manually from ASCII -symbols file).
+Callgraphs require that saved profile data contains caller +function address information, i.e. symbols for the code should +be loaded before starting profiling it (see +loading symbol data).
Separate callgraphs will be created for each of the costs (0=calls, 1=instructions, 2=cycles) with the -g option:
@@ -3558,7 +3988,7 @@ $ dot -Tsvg program-profile-1.dot > p
If profile is for larger and more varied amount of code -(e.g. program startup), the resulting callgraph can be so -huge it's unreadable.
++If profile is for larger and more varied amount of code (e.g. program startup), +the resulting callgraph can be so huge that it not really readable anymore. +
If your code has interrupt handlers, they can get called at any point, which can show in callgraph as "explicit" calls @@ -3594,7 +4025,7 @@ $ hatari_profile.py -p -g --ignore-to
In large callgraph most of the functions aren't really interesting, because their contribution to the cost is insignificant. You can remove large number of them with --no-leafs and --no-intermediate -options, those options act only on on nodes which costs are below +options, those options act only on nodes which costs are below given threshold. Leaf nodes are ones which don't have any parents and/or children. Intermediate ones have only single parent and children (node calling itself is not taken into account). @@ -3606,7 +4037,7 @@ threshold with --emph-limit (-e) option: $ hatari_profile.py -p -g -l 0.5 -e 2.0 -r program.sym program-profile.txt -
If you're not interested in from how many different addresses +
If you are not interested in from how many different addresses a given function calls another function, use --compact option. If you still see multiple calls between two nodes with it, the reason is that they happened through different call paths which were removed from @@ -3621,7 +4052,7 @@ often doesn't leave much of a call hiera consider removing all nodes except for subroutine call ones, with the --only-subroutines option.
-If you have trouble locating nodes you're specially interested +
If you have trouble locating nodes you are specially interested about, you can either color them differently with the --mark option, or exclude everything else from the callgraph except those nodes and their immediate callers & callees, with the --only option:
@@ -3663,7 +4094,7 @@ sections.trace gemdos,io_all@@ -3680,12 +4111,11 @@ a $12345 :6
history on b pc=($8) @@ -3694,7 +4124,11 @@ After bus error invokes debugger, 'histo to see (executed memory addresses with their current) instructions leading to the error. The most interesting vector addresses are: $8 (Bus error), $C (Address error), $10 (Illegal instruction), -$14 (Division by zero). +$14 (Division by zero).
+NOTE: Normally, to invoke debugger for larger set of exceptions, one +would use Hatari's "--debug-except" option to specify on which +exceptions debugger is invoked, and "setopt -D" to enable that on +run-time.
+b d1 & 0xff ! d1 & 0xff ++
b ($ff820a).b & 2 = 2 @@ -3744,6 +4186,17 @@ b ($ff820a).b & 2 ! ($ff820a).b & 2 :t
+info basepage ++To see e.g. all Falcon Videl register values, use: +
+info videl ++
@@ -3832,6 +4285,19 @@ Please see also Profiling section for more info. +
@@ -3850,14 +4316,14 @@ callstack information (with some limitat
profile on symbols prg b pc = _my_function :quiet :noinit :file showstack.iniI.e. whenever 'my_function' address is called, quietly trigger a -breakpoint without reseting profiling (callstack) information and run +breakpoint without resetting profiling (callstack) information and run debugger command(s) from the 'showstack.ini' debugger script file, which contains following command:
@@ -3887,7 +4353,7 @@ history, editing and especially the comp command, command argument and symbol names.-If you're building Hatari yourself, please make sure that you have the +If you are building Hatari yourself, please make sure that you have the GNU readline development files installed (on Debian / Ubuntu these come from the libreadline5-dev package). Otherwise the name completion and other features don't get enabled when you configure Hatari. @@ -3908,55 +4374,92 @@ overhead.
The operating system and libraries below Hatari can also sometimes have a noticeable effect on performance.
++Hatari can be sped up considerably by giving up some emulation or +emulator accuracy. With ST/STe emulation, these options should be +needed only on slow devices, typically ARM and/or mobile ones (e.g. +Rasberry Pi). +
+ -Improving Hatari performance
+Operating system components performance
-Hatari currently runs best in 16 or 32 bits per pixel color depth -mode, so try to avoid 24 bits per pixel display modes if possible. -16-bit mode is fastest. +Finding out whether there's a performance problem with the system +components (like SDL) in your setup, requires profiling Hatari and +rest of the system. How to do that is OS specific. On Linux that would +involve running "perf record -a" command (as root) on the background +for few minutes while Hatari is running, and then investigating +the results with "perf report" command. +
+ ++Some other process eating CPU cycles from Hatari one can see just with +the (Linux/Unix) "top" command. +
+ + +Build options impact on performance
+ ++Linux: Some HW platforms don't have properly HW accelerated +3D driver and SDL implementation. On these platforms it's better to +build Hatari with SDL v1.x than SDL 2.x, as latter can cause CPU +based 3D driver to be used for scaling Hatari graphics. +
+ ++MacOS: With SDL v1.x, frame skipping, zooming and drive LED +options (listed below) seem to have a large effect on performance in +the windowed mode. This is apparently due to issues in the SDL macOS +backend and how macOS itself composites non-fullscreen window +contents. These shouldn't be an issue with the SDL2 build of Hatari.
-On OSX, frame skipping, zooming and drive LED options (listed below) -seem to have a large effect on performance in the windowed mode. -This is apparently due to issues in the SDL OSX backend and how OSX -itself composites non-fullscreen window contents. OSX uses always -32-bit mode. +Compiler: Unless you have disabled compiler optimizations +(like GCC's -O2 or -O3 options) in the Hatari build, the extra +optimization flags (like GCC's "-mtune=i686") don't seem to have very +large effect on Hatari performance. Using GCC -O3 option instead of +-O2 can give minor (5-10%) performance improvements for things (mainly +demos) that use very heavily interrupts.
-Unless you've disabled compiler optimizations (like GCC's -O2 or -O3 -options) in the Hatari build, the extra optimization flags (like GCC's -"-mtune=i686") don't seem to have very large effect on Hatari -performance. Using GCC -O3 option instead of -O2 can give minor -(5-10%) performance improvements for things (demos) that use very -heavily interrupts. +CPU emulation: Hatari can be built with two different CPU +core implementations. The newer WinUAE CPU core has more accurate CPU +emulation and supports all of the higher end 680x0 CPU features. This +accuracy causes it to be clearly slower, than the OldAUE CPU core +implementation. If run-time options (acceptable to you) don't give +enough performance, give the OldUAE CPU core also a try.
-However, Hatari can be sped up considerably by giving up some -emulation or emulator accuracy. Except for DSP, these options -should be needed only on very slow devices like handhelds. See below. +Older versions: If nothing else helps, try (building) much +earlier Hatari version. More accurate emulation in newer Hatari +versions means that they can be slower despite optimizations.
+Run-time options not affecting emulation accuracy
+-If nothing else helps, try an earlier Hatari version. More accurate -emulation or emulator output in newer Hatari versions means that they -can be slower despite optimizations. +Hatari currently runs best in 16 or 32 bits per pixel color depth +mode, so try to avoid 24 bits per pixel display modes if possible. +16-bit mode is faster with SDL1. MacOS uses always 32-bit mode.
-Emulation options
+Run-time emulation options
-Emulation options have the largest impact on performance. -These options can be changed from the Hatari GUI System dialog and -the emulation needs to be rebooted for any of these changes to take -an effect! They're enabled by default. +Emulation options have the largest impact on Hatari performance. These +options can be changed from the Hatari GUI System and CPU dialogs and +the emulation needs to be rebooted for any of these changes to take an +effect! They are enabled by default.
-DSP
+DSP (Falcon)
+Emulating the Falcon DSP is performance-wise several times more demanding than emulating the m68k; DSP runs at higher frequency, executes many @@ -3967,47 +4470,56 @@ that do use DSP, many use it only for ba fine without the real DSP emulation.
+CPU: cycle exact (030/TT/Falcon)
+ ++WinUAE CPU core supports 030 cache emulation for cycle accuracy. This +is very heavy. Unless program needs cycle accuracy to work correctly, +you can disable it. Many Falcon demos need it, application and games +normally don't. +
+Timer-D
-The single largest factor contributing to general Hatari emulation -performance is the handling of interrupts. Enabling Timer-D patching -option (about) doubles Hatari ST/STE emulation performance as it -significantly reduces the number of interrupts generated by the emulated -Atari machine. Using this has adverse effect only for very rare programs. +With ST/STe, the single largest factor contributing to general Hatari +emulation performance is the handling of interrupts. Enabling Timer-D +patching option (about) doubles Hatari ST/STE emulation performance +with OldUAE CPU core as it significantly reduces the number of +interrupts generated by the emulated Atari machine. Using this has +adverse effect only for very rare programs.
FDC
While accurate FDC emulation doesn't take that much CPU, it slows down floppy image accesses (and Hatari startup) a lot. Only very -few demos and games require accurate FDC emulation for their copy protection, -so enabling fast floppy access is fairly safe. +few demos and games require accurate FDC emulation for their copy +protection, so enabling fast floppy access is fairly safe.
-Compatible CPU
+CPU: prefetch
-After the DSP and interrupts, m68k emulation takes most time. -Disabling the "Slower but more compatible CPU" option will speed up -the emulation a lot, but it won't anymore be cycle accurate. This can -be fine for many games and other programs, but won't work e.g. for demos -using overscan or rasters. +After the DSP, cycle accuracy and interrupts, m68k emulation takes +most time. Disabling the "Prefetch" / "Compatible" option can speed up +the emulation noticeably, but it will be less accurate. This can be +fine for many games and other programs, but won't work e.g. for demos +using overscan or rasters. This is recommended only as a last resort.
-Roughly speaking, for DSP emulation, one needs at least 2Ghz machine. -For normal (unpatched) Timer-D frequency on some specific cases (like -demos with overscan 512 color animations) one may need over 1GHz -machine, but some rare ST/STE demos may require over 1GHz machine even -with Timer-D patching. For "Compatible CPU" one needs at least 1/2Ghz -machine. +Roughly speaking, for Falcon DSP emulation with cycle exact 030 cache +emulation, one needs at least 3Ghz machine. For normal (unpatched) +Timer-D frequency on some specific cases (like demos with overscan 512 +color animations) one may need over 1GHz machine for ST/STE emulation, +but some rare demos may require over 1GHz machine even with Timer-D +patching.
NOTE: Above options may cause some programs to work in correctly. The Hatari Software Compatibility List -lists programs known to need real real Falcon DSP emulation, Timer-D -frequency or accurate FDC timings. Disabling "Compatible CPU" option -is recommended only as a last resort. +lists programs known to need real Falcon DSP emulation, Timer-D +frequency or accurate FDC timings.
@@ -4021,6 +4533,7 @@ be toggled at run-time without rebootingSound
+Internal Hatari sound handling and the SDL_mixer sound thread libALSA sound processing can account up to 1/3 of the Hatari CPU usage @@ -4031,21 +4544,34 @@ in Hatari as this can significantly redu interrupts.
++If program supports both ST and STE, use STE. Emulating DMA sound, is +more lightweight than interrupt heavy ST sound. +
+ ++If problem is occasional performance related audio glitches, increasing +the sound buffer size (with "--sound-buffer-size" option) may help, but +it increases sound latency. +
+Frame skipping
+Screen rendering can take noticeable amount of CPU time. The default Hatari "auto" frame skipping should be used unless there's a good reason not to. It will skip converting and showing some of the frames if there's not enough time for them.
+Also, if your monitor refresh frequency is lower than the selected Hatari monitor frequency (e.g. LCD monitors usually use 60Hz whereas Atari monochrome monitor uses 71Hz), you should use frameskip of one. The reason is that if your SDL library uses VSync to synchronize the -output to screen (like OSX one?), with zero frame skip that forces the -emulation to run slower than a real Atari. If SDL doesn't use VSync, -Hatari does redundant work to convert frames you can't see. +output to screen, with zero frame skip that forces the emulation to +run slower than a real Atari. If SDL doesn't use VSync, Hatari does +redundant work to convert frames you can't see.
Zooming
@@ -4091,14 +4617,16 @@ is completely busy, it will increase toHatari has also a facility to measure FPS i.e. Frames Per Second. -Just enable the --fast-forward option -on command line (or use the corresponding keyboard shortcut), and -after a while, press the "Pause" key. Whenever Hatari emulation is -paused, Hatari will output on console how many VBLs it could show per -second along with some other numbers. +Enable frame skipping with +--fast-forward yes option +(or use the corresponding keyboard shortcut) and set +--log-level info. +Then after a while, press the "Pause" key. Whenever Hatari emulation +is paused, Hatari will output on console info on how many VBLs it +could show per second, along with some other numbers.
-It depends on what you want to measure, but usually it's best to +It depends on what you want to measure, but usually it is best to disable sound and set high frame skip like --sound off --frameskips 60 so that the associated external overheads are minimized. E.g. video output @@ -4111,7 +4639,7 @@ call, only the time spent by the Hatari On other systems, much less accurate SDL "wall clock" timings are used. To make latter more accurate you could use also --run-vbls option to specify how many -VBLs Hatari should run before it exits. In this case it's best to +VBLs Hatari should run before it exits. In this case it is best to either have the test-case run automatically from the AUTO-folder or given as memory snapshot to Hatari with the frame skip set equal to the VBL count. @@ -4121,7 +4649,7 @@ Note that these numbers can fluctuate qu when the SDL timings are used, so for (statistically) reliable numbers you may need to repeat the measurement several times. You should of course make also sure that the system doesn't have any other activity -at the same time you're making the measurements. +at the same time you are making the measurements.
@@ -4153,11 +4681,9 @@ GNU General Public LicenseEmulation via software is an art and Hatari is an example of this.
Emulation is to make a computer behave like a (probably) completely -different machine on the lowest possible niveau. +different machine on the lowest possible level. This includes CPU and custom chip emulation allowing software written -for the emulated machine to be run without notice. -A good emulator will run most of the software intended for the emulated -platform without trouble. +for the emulated machine to be run without it noticing a difference.
The key to emulation is to simply do those things with a software @@ -4181,8 +4707,8 @@ error-free using such a simple loop syst
But in most cases the CPU emulation is the simplest part. Correct -emulation of the various custom chips and hardware -parts of the emulated system is much trickier. +emulation of the various custom chips and hardware parts of the +emulated system, and their proper synchronization, is much trickier.