Project has switched to libdwarf 20201017
[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
2315) Remove Visual Studio 2015 support
2416) Project has switched to libdwarf 20201017 library 64bits for VS 2017
26Release 4a (15th August 2019)
28Git commit: f04df4f185ed4f3cfc805d0f61b3c019a108ae2c
300) Fix specific breakpoint for ROM cartridge or unknown memory location writing
32Release 4 (10th August 2019)
34Git commit: 9b25d85d1ea4a9476b83476bcec65e05464f68da
360) The zoom value setting has been fixed in the registry
371) Debugger mode now shares the same alpine rom path setting
382) Local variables window displays register name now
393) Switch to Zlib 1.2.11 static library 64bits for VS 2017
404) Switch to SDL 1.2.15 static library 64bits for VS 2017
415) Local variables window displays values from function's parameters
426) Fixed the typedef's name display in Local and Watch variables window
437) Breakpoint may now occur in case of a ROM cartridge writing
44-- ROM cartridge writing detection follow the alpine "allow writes to cartridge rom"'s flag check
45-- 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
468) Local variables window detects now if a variable is used or not by the code
479) The address provided in the debugger memory windows is now verified to prevent crash
48-- Wrong address will be displayed in red
4910) UI changes
50-- Added new icons for the exit and status features
51-- Modified icons for the SP (Stack) browser
52-- Unified icons sizes depend on their usage (drop down menu and main menu)
53-- Underline the active M68K line in the disassembly window
54-- Allow the up/down navigation on the SP (Stack) browser
55-- Restart function cleans-up the SP (Stack) browser and the heap allocator system
56-- Fixed the up navigation on the memory window
5711) Added some log information for the emulator initialisations
5812) Breakpoint will happen in case of writing at unknown memory location
59-- Alert box will display a message and then the code will stop
6013) Added the DRAM size in the emulator status window
6114) Debugger sources code clean-up
6215) Added a call stack feature
6316) Follow platform requirement to prevent source file reading issue
6417) UI modifications
65-- Modified icon for the memory window to make a distinction with the memory browser
66-- The all watch, and Exception Vector Table windows, can be closed using keyboard
67-- Renamed the debugger dedicated icons to make a distinction
68-- Added the call stack window
6918) Fixed a crash in the all watch window after loading a new binary without ELF/DWARF information
70-- Previously used ELF/DWARF information was still accessible
7119) Fixed slash/backslash issue, in the Alpine tab, to follow platform requirement
7220) Heap allocation window uses the DRAM size limit option and detect if heap allocation shares space with SP (Stack)
7321) Added a Jaguar model and BIOS configuration tab
7422) Jaguar model and BIOS configuration integration
7523) Added LEB128 decoding functions
76-- It is used for the DWARF decoding information
7724) Debugger support improvement
78-- DWARF support for the enum type (partial), structure and subroutine type
79-- Debugger can report variable's unsigned char value
8025) UI modifications
81-- Added a status bar, better status report & information display for the heap allocation window
82-- Added a status bar, better status report & information display for the local variables window
83-- Added better information display for the exception vectors table window, and added some missing vectors
84-- Added a status bar, better status report & information display for the call stack window
85-- Added a status bar, better status report & information display for the all watches window
8626) Added screenshot feature
87-- Not accessible in debugger mode
88-- Added screenshot editable path in the general tab, and a key binding
8927) Minor misspellings fixes
9028) DWARF source code directory path clean-up
9129) Added a source code files list viewer
92-- List comes from the DWARF information
9330) Check potential variables missing/incomplete description found in the DWARF information
94-- No crash involved but can help to reduce such as variables duplicate or the blank ones
9531) Added a sorting filter in the all watches window
9632) Improve source code file reading to avoid additional text/bytes reading
9733) Help & content texts updates
9834) Fixed a crash legacy issue when emulator launches in Alpine mode without a valid rom
9935) Added the support for the used lines source's DWARF structure
100-- Mostly used to handle missing subprogram's lines information, and missing CU's low/high PC
10136) Added the Rx version's contact in the help text
10237) Added search paths in case of missing DWARF directories information
103-- Used to look for the file(s)
10438) Setup CU's low/high PC in case of the DWARF structures doesn't have it
105-- Used mostly to allow display the source assembled with vasm
10639) Added function name support from ELF structure
10740) Added the return address information in the call stack
8d705db0 10841) Added multiple breakpoints feature, and their key bindings, for functions only
24470541 10942) Added timer initialisation for the SDL setup
f99a6ebc 11043) Added a cartridge view menu
24470541 111-- Added a window to display my own directory and his files list
6642f781 11244) Debugger sources code clean-up
acd3342f 11345) Fix a crash when emulator, in non-debugger mode, opens the breakpoint UIs at launch
f951022b 11446) Fix crash with potential missing DWARF structure tag's type name
c57d3e56 11547) Added ELF sections check so a potential unknown section will stop, or not stop, the decoding
aae93d86 11648) Project has switched to Qt 5.12.0 library 64bits for VS 2017
3323d78b 11749) Added a Save Dump As... feature to save a memory zone to a file
11850) The -d command line option, dedicated to the debugger, has been renamed to avoid duplication with the dsp one
119-- -d has been renamed by -D because another -d was also used for the dsp command line option
8d705db0 12051) Removed the sorting filter in the all watches window
96bd5390 12152) Fix the support of the DRAM size limit option in the heap allocation window
f99a6ebc 12253) Set cartridge view menu for debugger mode only
8b11a1b0 12354) Prevent crash in case of call stack is out of range
125Release 3 (13th November 2017)
127Git commit: b1b673a3b0d19e3c2c45b6590b773b11e45bced7
1290) Fixed the windows respawning in the next emulator launch within --alpine or --debugger options
1301) Added an Exception Vector Table window
1312) Modified the About window to update the credits list in a more appropriate way
132-- Updated the emulator application credits line
1333) Added 'Rx' word to the emulator name
1344) Fixed a crash when reading the DWARF information in the case of the DWARF2 format has not been used
1355) Added ui, alpine and debugger groups in the settings
1366) Added the possibility to erase settings
1377) Added the --es-all, --es-ui, --es-alpine and --es-debugger options to erase specific settings
1388) Added a key bindings tab and adapted the configuration dialog tabs
139-- User can modify the key bindings where appropriate
140-- Key bindings UI is displayed based on the option used (--debugger, -- alpine)
1419) Fixed a crash, in Release mode, when the HW labels setting is turn on
14210) Solved an interference between the HW labels setting and the one used by the debugger
143-- The setting is now only the reference used
14411) Fixed the SP (Stack) browser UI potential missing data
14512) Create a directory for EEPROMs (based on the EEPROMs setting) if it doesn't already exist
14613) Keep the scrollbar position in accordance of the M68K PC pointer
147-- UI displays the source without the need to move down/up the scrollbar
14814) Fixed a crash when DWARF information report a source line number exceeding the number of lines present in a source file
149-- This may come from the linker vlink
15015) Improved the .heap section detection to avoid a detection error
151-- Depend vlink version, .heap section may have an Alloc flag
15216) Fixed a crash when DWARF information does references to missing source code files
15317) Added a local variables window
aae93d86 15418) Project has switched to Visual Studio 2017 and Qt 5.9.1 library
156Release 2 (3rd September 2017)
1580) Added some error detections when reading the ELF executable file
1591) Added all hardware labels (based on the document scans from the Version 2.4 - June 7, 1995)
1602) "Step Over" code function for BSR/JSR functions
1613) Added the .debug_ranges detection to avoid a detection error
1624) DWARF support
163-- TAG: Compilation Unit, Subprogram, Variables, Types
164-- Line numbers, symbols, functions
1655) Added an All Watch window for non-local variables
1666) Added a heap allocator window based on my own memory allocation functions
1677) Added additional 4 memory windows with address input based on hexa, decimal or symbol name
1688) Windows refreshing executed only if windows is visible
1699) Added a restart function
170-- Restart only the 68000 program counter to his original set
17110) Modified the icons color backgound for the "Step In" and "Step Over" functions
17211) Updated the About window to update the credits list
17312) 64 bits Release executable
17413) Fixed (hacking) the display of the SP (Stack) browser
17514) Set the emulator in Halt mode when launched in alpine debug mode without a loaded rom
176-- Otherwise the 68000 program counter will have a 0 value and will execute the code at this address
17715) Added some information in the --help/-h/-? option
17816) --debugger option no longer force the log file
17917) Added a --dram-max option to extend the DRAM size to 8MB
18018) Added the "enter" key support when setting the BPM (Breapoint)
18119) Save the windows positions, size and visibilities (show or hide) status
182-- Such windows will automatically respawn in the next emulator launch
184Release 1 (12th February 2017)
1860) BPM (Breapoint) now stop at the designated address and no longer stop after executing the code
1871) Clean-up the tracing / no-tracing flags for better U.I understanding
1882) Added SP (Stack) browser
1893) User can change now the number of lines of disassembly displayed in the tracing window
1904) User can turn on/off the op-codes associated in the disassembly lines displayed in the M68K tracing window
1915) Added an emulator status window (GPU status, M68K debugger and tracking status)
1926) Added a GPU disassembly tracing window - Display the current PC pointer
1937) Added a DSP disassembly tracing window - Display the current PC pointer
1948) Added possibility to change refresh rate of browsers when emulation is launched
1959) Display partial hardware labels (Internal Memory and Graphics sub-system address space) in the disassembly lines displayed in the M68K tracing window
196-- Display first the hardware labels (based from the Jag V8 dev. PDF) and then the ones possibly found in the ELF debug symbol
19710) Minor U.I cosmetic changes
19811) User can turn on/off the hardware labels associated in the disassembly lines displayed in the M68K tracing window
199-- It doesn't apply to the hardware labels possibly found in the ELF debug symbol
201Release 0 (5th January 2017)
2030) New option --debugger
2041) ELF format support
2052) ELF debug symbol support
2063) "Step Into" code function
2074) Menus layout dedicated to the debugger
2085) Added a dedicated main window for tracing (M68K)
2096) Added a Debugger tab in the config tab
2107) Visual Studio 2015 project support
2118) libelf-0.8.13 library support
2129) 64 bits debug executable only
215Known issues
aae93d86 2171) 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
2182) The BPM (Breapoint) remains stuck on his address when user wants to continue the code execution
219-- Need to trace over the BPM or unset the BPM
220-- The issue can be prevented if the code doesn't set IRQ, otherwise the IRQ will need to be traced to get back control
2213) DWARF 2 support
222-- With GCC: the code must be compiled with the -gdwarf-2 option
2234) The Local and Watch variables window may display not available type information or empty information
224-- Such missing information may be included in future release
225-- The 'const' type may not be reported correctly in the DWARF information
2265) The 2MB mirroring is no longer applied in case of --dram-max option usage
2276) Stack must reflect the --dram-max option usage otherwise the stack may be corrupted
228-- The application needs to set the SP (Stack) in accordance
2297) The Exception Vector Table window displays only 65 vectors
230-- Missing vectors may be added in future release
2318) User needs to manualy check if the Atari Jaguar executable match his source code files
232-- Otherwise, source code and assembly may not match or leads to instabilities
2339) The emulator needs to be restarted in case of the following actions occur
234-- Key bindings changes
235-- BIOS selection changes and without new executable load
23610) 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
23711) Emulator will crash in case of wrong address value provided in the memory browser
23812) The RAM access log is limited to the 2MB
23913) In various occasions, global variables may be duplicated or without name in the DWARF information
240-- It may come from the Vlink linker and/or GCC 7.1.0 or 8.2.0 compilation with -gdwarf-2 option
24114) Source code disply only assembled code from vasm with option -dwarf
24215) After a new breakpoint set, the breakpoint list window is not refreshed
243-- User must perform an operation, such code tracing, to see the breakpoints list update
24416) Some ASCII characters may be not displayed correctly
aae93d86 245-- Probably depend how the text is displayed, this is related to the Qt/HTML encoding done when reading DWARF file
24470541 24617) Potential legacy crash when leaving emulator in pause mode for a long period of time
aae93d86 247-- Need much investigation
249Cosmetic / UX issues
2511) The SP (Stack) icon color backgound doesn't look similar with the other ones
2522) The SP (Stack) browser size always open at a forced size no matter if the size has been changed
2533) Not every features have associated key bindings
255Legacy issues/hints
2571) Emulator seems to have easter egg(s)
258-- The option --yarrr displays a single message and end the application
259-- Pressing F8, while in the main window, will create an extra message in the log file
2602) The --alpine option force the log file but it can be override if --no-log option is set after the --alpine option
262Project information
2641) Code based on the Shamus Hammons source code available via Gethub by the 12th September 2017 (2.1.3 Final)
2652) Visual Studio 2017 project support for 64 bits
2663) libelf 0.8.13 library 64bits for VS 2017
36452de8 2674) libdwarf 20201017 library 64bits for VS 2017
2685) Qt 5.12.0 library 64bits for VS 2017
2696) Zlib 1.2.11 library 64bits for VS 2017
2707) SDL 1.2.15 library 64bits for VS 2017
2718) The original make files have been modified to follow the requirements and modifications
2729) The 'Rx' word has been added to the emulator name to make distinction with the official version
27310) The project is set at
27411) GPLv3 file document has been renamed as LICENSE, to fit better the GitHub requirements
1081a838 275-- Text / License terms are the same
adf158c7 27614) The x86 configuration has been removed in the VS 2017 project
279Download statistics
281jaguar64eu : 15 downloads for the Release 0 on the 12th Feb, 2017
282jaguar64eu : 18 downloads for the Release 1 on the 21st May, 2017
283No downloads statistics available for the Release 2
284No downloads statistics available for the Release 3