Project has switched to libdwarf 20201201
[clinton/Virtual-Jaguar-Rx.git] / docs / vj_HistoryNotes.txt
1Release 5 (TBA)
30) Added a date creation stamp in the application command line information
4- This date already appears in the Release 4 executable but was not referenced in his history note
51) Added a specific breakpoint for the M68K illegal instruction exception
6-- Alert box will display a message and then the code will stop
72) Added a specific breakpoint for the M68K address error exception
8-- Alert box will display a message and then the code will stop
2d99e2b7 93) Added a HW registers browser window and set a tab for the Blitter
104) Added detection for the unsigned/signed short type
11-- Will allow the return of a short type variable's value
0029c507 125) Added a specific breakpoint for the M68K Unimplemented instruction, and Exception not referenced exceptions
2a13a691 136) Fix potential emulator freeze after an exception has occured
258b1c16 147) Fix a random crash when reading the source lines information
c3b14e59 158) Added ELF & DWARF .debug* types
7575ebee 169) Added ELF section types check and new error messages
1710) Modified the call stack layout window and added source filename from the called source line
1811) Added a source tab in the main window for step into tracing
1912) Added the step over for source level tracing
2013) Set text conversion to Qt/HTML format for the M68K tracing window
2114) Added a source code file date check when reading DWARF information
009df4d7 22-- Will avoid source code mismatching with the ELF executable
36452de8 2315) Remove Visual Studio 2015 support
5b652120 2416) Work around fix for a compilation error on Linux
b45a1df3 25-- EEPROM directory creation allowed only for Windows at the moment
5b652120 2617) Project has switched to libdwarf 20201201 library 64bits for VS 2017
28Release 4a (15th August 2019)
30Git commit: f04df4f185ed4f3cfc805d0f61b3c019a108ae2c
320) Fix specific breakpoint for ROM cartridge or unknown memory location writing
34Release 4 (10th August 2019)
36Git commit: 9b25d85d1ea4a9476b83476bcec65e05464f68da
380) The zoom value setting has been fixed in the registry
391) Debugger mode now shares the same alpine rom path setting
402) Local variables window displays register name now
413) Switch to Zlib 1.2.11 static library 64bits for VS 2017
424) Switch to SDL 1.2.15 static library 64bits for VS 2017
435) Local variables window displays values from function's parameters
446) Fixed the typedef's name display in Local and Watch variables window
457) Breakpoint may now occur in case of a ROM cartridge writing
46-- ROM cartridge writing detection follow the alpine "allow writes to cartridge rom"'s flag check
47-- Alert box will display a message with possibility to pass or not the breakpoint only if this is related to a 8 or 16 bits ROM access
488) Local variables window detects now if a variable is used or not by the code
499) The address provided in the debugger memory windows is now verified to prevent crash
50-- Wrong address will be displayed in red
5110) UI changes
52-- Added new icons for the exit and status features
53-- Modified icons for the SP (Stack) browser
54-- Unified icons sizes depend on their usage (drop down menu and main menu)
55-- Underline the active M68K line in the disassembly window
56-- Allow the up/down navigation on the SP (Stack) browser
57-- Restart function cleans-up the SP (Stack) browser and the heap allocator system
58-- Fixed the up navigation on the memory window
5911) Added some log information for the emulator initialisations
6012) Breakpoint will happen in case of writing at unknown memory location
61-- Alert box will display a message and then the code will stop
6213) Added the DRAM size in the emulator status window
6314) Debugger sources code clean-up
6415) Added a call stack feature
6516) Follow platform requirement to prevent source file reading issue
6617) UI modifications
67-- Modified icon for the memory window to make a distinction with the memory browser
68-- The all watch, and Exception Vector Table windows, can be closed using keyboard
69-- Renamed the debugger dedicated icons to make a distinction
70-- Added the call stack window
7118) Fixed a crash in the all watch window after loading a new binary without ELF/DWARF information
72-- Previously used ELF/DWARF information was still accessible
7319) Fixed slash/backslash issue, in the Alpine tab, to follow platform requirement
7420) Heap allocation window uses the DRAM size limit option and detect if heap allocation shares space with SP (Stack)
7521) Added a Jaguar model and BIOS configuration tab
7622) Jaguar model and BIOS configuration integration
7723) Added LEB128 decoding functions
78-- It is used for the DWARF decoding information
7924) Debugger support improvement
80-- DWARF support for the enum type (partial), structure and subroutine type
81-- Debugger can report variable's unsigned char value
8225) UI modifications
83-- Added a status bar, better status report & information display for the heap allocation window
84-- Added a status bar, better status report & information display for the local variables window
85-- Added better information display for the exception vectors table window, and added some missing vectors
86-- Added a status bar, better status report & information display for the call stack window
87-- Added a status bar, better status report & information display for the all watches window
8826) Added screenshot feature
89-- Not accessible in debugger mode
90-- Added screenshot editable path in the general tab, and a key binding
9127) Minor misspellings fixes
9228) DWARF source code directory path clean-up
9329) Added a source code files list viewer
94-- List comes from the DWARF information
9530) Check potential variables missing/incomplete description found in the DWARF information
96-- No crash involved but can help to reduce such as variables duplicate or the blank ones
9731) Added a sorting filter in the all watches window
9832) Improve source code file reading to avoid additional text/bytes reading
9933) Help & content texts updates
10034) Fixed a crash legacy issue when emulator launches in Alpine mode without a valid rom
10135) Added the support for the used lines source's DWARF structure
102-- Mostly used to handle missing subprogram's lines information, and missing CU's low/high PC
10336) Added the Rx version's contact in the help text
10437) Added search paths in case of missing DWARF directories information
105-- Used to look for the file(s)
10638) Setup CU's low/high PC in case of the DWARF structures doesn't have it
107-- Used mostly to allow display the source assembled with vasm
10839) Added function name support from ELF structure
10940) Added the return address information in the call stack
8d705db0 11041) Added multiple breakpoints feature, and their key bindings, for functions only
24470541 11142) Added timer initialisation for the SDL setup
f99a6ebc 11243) Added a cartridge view menu
24470541 113-- Added a window to display my own directory and his files list
6642f781 11444) Debugger sources code clean-up
acd3342f 11545) Fix a crash when emulator, in non-debugger mode, opens the breakpoint UIs at launch
f951022b 11646) Fix crash with potential missing DWARF structure tag's type name
c57d3e56 11747) Added ELF sections check so a potential unknown section will stop, or not stop, the decoding
aae93d86 11848) Project has switched to Qt 5.12.0 library 64bits for VS 2017
3323d78b 11949) Added a Save Dump As... feature to save a memory zone to a file
12050) The -d command line option, dedicated to the debugger, has been renamed to avoid duplication with the dsp one
121-- -d has been renamed by -D because another -d was also used for the dsp command line option
8d705db0 12251) Removed the sorting filter in the all watches window
96bd5390 12352) Fix the support of the DRAM size limit option in the heap allocation window
f99a6ebc 12453) Set cartridge view menu for debugger mode only
8b11a1b0 12554) Prevent crash in case of call stack is out of range
127Release 3 (13th November 2017)
129Git commit: b1b673a3b0d19e3c2c45b6590b773b11e45bced7
1310) Fixed the windows respawning in the next emulator launch within --alpine or --debugger options
1321) Added an Exception Vector Table window
1332) Modified the About window to update the credits list in a more appropriate way
134-- Updated the emulator application credits line
1353) Added 'Rx' word to the emulator name
1364) Fixed a crash when reading the DWARF information in the case of the DWARF2 format has not been used
1375) Added ui, alpine and debugger groups in the settings
1386) Added the possibility to erase settings
1397) Added the --es-all, --es-ui, --es-alpine and --es-debugger options to erase specific settings
1408) Added a key bindings tab and adapted the configuration dialog tabs
141-- User can modify the key bindings where appropriate
142-- Key bindings UI is displayed based on the option used (--debugger, -- alpine)
1439) Fixed a crash, in Release mode, when the HW labels setting is turn on
14410) Solved an interference between the HW labels setting and the one used by the debugger
145-- The setting is now only the reference used
14611) Fixed the SP (Stack) browser UI potential missing data
14712) Create a directory for EEPROMs (based on the EEPROMs setting) if it doesn't already exist
14813) Keep the scrollbar position in accordance of the M68K PC pointer
149-- UI displays the source without the need to move down/up the scrollbar
15014) Fixed a crash when DWARF information report a source line number exceeding the number of lines present in a source file
151-- This may come from the linker vlink
15215) Improved the .heap section detection to avoid a detection error
153-- Depend vlink version, .heap section may have an Alloc flag
15416) Fixed a crash when DWARF information does references to missing source code files
15517) Added a local variables window
aae93d86 15618) Project has switched to Visual Studio 2017 and Qt 5.9.1 library
158Release 2 (3rd September 2017)
1600) Added some error detections when reading the ELF executable file
1611) Added all hardware labels (based on the document scans from the Version 2.4 - June 7, 1995)
1622) "Step Over" code function for BSR/JSR functions
1633) Added the .debug_ranges detection to avoid a detection error
1644) DWARF support
165-- TAG: Compilation Unit, Subprogram, Variables, Types
166-- Line numbers, symbols, functions
1675) Added an All Watch window for non-local variables
1686) Added a heap allocator window based on my own memory allocation functions
1697) Added additional 4 memory windows with address input based on hexa, decimal or symbol name
1708) Windows refreshing executed only if windows is visible
1719) Added a restart function
172-- Restart only the 68000 program counter to his original set
17310) Modified the icons color backgound for the "Step In" and "Step Over" functions
17411) Updated the About window to update the credits list
17512) 64 bits Release executable
17613) Fixed (hacking) the display of the SP (Stack) browser
17714) Set the emulator in Halt mode when launched in alpine debug mode without a loaded rom
178-- Otherwise the 68000 program counter will have a 0 value and will execute the code at this address
17915) Added some information in the --help/-h/-? option
18016) --debugger option no longer force the log file
18117) Added a --dram-max option to extend the DRAM size to 8MB
18218) Added the "enter" key support when setting the BPM (Breapoint)
18319) Save the windows positions, size and visibilities (show or hide) status
184-- Such windows will automatically respawn in the next emulator launch
186Release 1 (12th February 2017)
1880) BPM (Breapoint) now stop at the designated address and no longer stop after executing the code
1891) Clean-up the tracing / no-tracing flags for better U.I understanding
1902) Added SP (Stack) browser
1913) User can change now the number of lines of disassembly displayed in the tracing window
1924) User can turn on/off the op-codes associated in the disassembly lines displayed in the M68K tracing window
1935) Added an emulator status window (GPU status, M68K debugger and tracking status)
1946) Added a GPU disassembly tracing window - Display the current PC pointer
1957) Added a DSP disassembly tracing window - Display the current PC pointer
1968) Added possibility to change refresh rate of browsers when emulation is launched
1979) Display partial hardware labels (Internal Memory and Graphics sub-system address space) in the disassembly lines displayed in the M68K tracing window
198-- Display first the hardware labels (based from the Jag V8 dev. PDF) and then the ones possibly found in the ELF debug symbol
19910) Minor U.I cosmetic changes
20011) User can turn on/off the hardware labels associated in the disassembly lines displayed in the M68K tracing window
201-- It doesn't apply to the hardware labels possibly found in the ELF debug symbol
203Release 0 (5th January 2017)
2050) New option --debugger
2061) ELF format support
2072) ELF debug symbol support
2083) "Step Into" code function
2094) Menus layout dedicated to the debugger
2105) Added a dedicated main window for tracing (M68K)
2116) Added a Debugger tab in the config tab
2127) Visual Studio 2015 project support
2138) libelf-0.8.13 library support
2149) 64 bits debug executable only
217Known issues
aae93d86 2191) Video output is not displayed due to my OpenGL / Qt5 5.5.1 integration with VS 2015 but solved when using the Qt 5.9.1 package for VS 2017
2202) The BPM (Breapoint) remains stuck on his address when user wants to continue the code execution
221-- Need to trace over the BPM or unset the BPM
222-- The issue can be prevented if the code doesn't set IRQ, otherwise the IRQ will need to be traced to get back control
2233) DWARF 2 support
224-- With GCC: the code must be compiled with the -gdwarf-2 option
2254) The Local and Watch variables window may display not available type information or empty information
226-- Such missing information may be included in future release
227-- The 'const' type may not be reported correctly in the DWARF information
2285) The 2MB mirroring is no longer applied in case of --dram-max option usage
2296) Stack must reflect the --dram-max option usage otherwise the stack may be corrupted
230-- The application needs to set the SP (Stack) in accordance
2317) The Exception Vector Table window displays only 65 vectors
232-- Missing vectors may be added in future release
2338) User needs to manualy check if the Atari Jaguar executable match his source code files
234-- Otherwise, source code and assembly may not match or leads to instabilities
2359) The emulator needs to be restarted in case of the following actions occur
236-- Key bindings changes
237-- BIOS selection changes and without new executable load
23810) In the case of a ROM cartridge writing, and with occuring breakpoint, the PC pointer will point at the next instruction and not at the instruction causing the breakpoint
23911) Emulator will crash in case of wrong address value provided in the memory browser
24012) The RAM access log is limited to the 2MB
24113) In various occasions, global variables may be duplicated or without name in the DWARF information
242-- It may come from the Vlink linker and/or GCC 7.1.0 or 8.2.0 compilation with -gdwarf-2 option
24314) Source code disply only assembled code from vasm with option -dwarf
24415) After a new breakpoint set, the breakpoint list window is not refreshed
245-- User must perform an operation, such code tracing, to see the breakpoints list update
24616) Some ASCII characters may be not displayed correctly
aae93d86 247-- Probably depend how the text is displayed, this is related to the Qt/HTML encoding done when reading DWARF file
24470541 24817) Potential legacy crash when leaving emulator in pause mode for a long period of time
aae93d86 249-- Need much investigation
251Cosmetic / UX issues
2531) The SP (Stack) icon color backgound doesn't look similar with the other ones
2542) The SP (Stack) browser size always open at a forced size no matter if the size has been changed
2553) Not every features have associated key bindings
257Legacy issues/hints
2591) Emulator seems to have easter egg(s)
260-- The option --yarrr displays a single message and end the application
261-- Pressing F8, while in the main window, will create an extra message in the log file
2622) The --alpine option force the log file but it can be override if --no-log option is set after the --alpine option
264Project information
2661) Code based on the Shamus Hammons source code available via Gethub by the 12th September 2017 (2.1.3 Final)
2672) Visual Studio 2017 project support for 64 bits
2683) libelf 0.8.13 library 64bits for VS 2017
5b652120 2694) libdwarf 20201201 library 64bits for VS 2017
2705) Qt 5.12.0 library 64bits for VS 2017
2716) Zlib 1.2.11 library 64bits for VS 2017
2727) SDL 1.2.15 library 64bits for VS 2017
2738) The original make files have been modified to follow the requirements and modifications
2749) The 'Rx' word has been added to the emulator name to make distinction with the official version
27510) The project is set at
27611) GPLv3 file document has been renamed as LICENSE, to fit better the GitHub requirements
1081a838 277-- Text / License terms are the same
adf158c7 27814) The x86 configuration has been removed in the VS 2017 project
281Download statistics
283jaguar64eu : 15 downloads for the Release 0 on the 12th Feb, 2017
284jaguar64eu : 18 downloads for the Release 1 on the 21st May, 2017
285No downloads statistics available for the Release 2
286No downloads statistics available for the Release 3