Project has switched to libdwarf 20210305
[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
2617) Show the SR value as a readable form in the CPU browser
2718) Potential fix to compile on Linux
8646ea44 28-- Added the relative directory path for the Qt include files
40692bae 2919) Merge the Linux build fixes from @richard42
c4fe5864 30-- Jaguar core's makefile and Qt pro file updates, fix filenames case sensitive & fixes for Linux
40692bae 3120) Updated the M68K exception catch
32-- Added a M68K exception catch check in the Alpine tab settings
33-- Added a specific breakpoint for the M68K bus error exception
40692bae 3421) Project has switched to libdwarf 20210305 library 64bits for VS 2017
36Release 4a (15th August 2019)
38Git commit: f04df4f185ed4f3cfc805d0f61b3c019a108ae2c
400) Fix specific breakpoint for ROM cartridge or unknown memory location writing
42Release 4 (10th August 2019)
44Git commit: 9b25d85d1ea4a9476b83476bcec65e05464f68da
460) The zoom value setting has been fixed in the registry
471) Debugger mode now shares the same alpine rom path setting
482) Local variables window displays register name now
493) Switch to Zlib 1.2.11 static library 64bits for VS 2017
504) Switch to SDL 1.2.15 static library 64bits for VS 2017
515) Local variables window displays values from function's parameters
526) Fixed the typedef's name display in Local and Watch variables window
537) Breakpoint may now occur in case of a ROM cartridge writing
54-- ROM cartridge writing detection follow the alpine "allow writes to cartridge rom"'s flag check
55-- 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
568) Local variables window detects now if a variable is used or not by the code
579) The address provided in the debugger memory windows is now verified to prevent crash
58-- Wrong address will be displayed in red
5910) UI changes
60-- Added new icons for the exit and status features
61-- Modified icons for the SP (Stack) browser
62-- Unified icons sizes depend on their usage (drop down menu and main menu)
63-- Underline the active M68K line in the disassembly window
64-- Allow the up/down navigation on the SP (Stack) browser
65-- Restart function cleans-up the SP (Stack) browser and the heap allocator system
66-- Fixed the up navigation on the memory window
6711) Added some log information for the emulator initialisations
6812) Breakpoint will happen in case of writing at unknown memory location
69-- Alert box will display a message and then the code will stop
7013) Added the DRAM size in the emulator status window
7114) Debugger sources code clean-up
7215) Added a call stack feature
7316) Follow platform requirement to prevent source file reading issue
7417) UI modifications
75-- Modified icon for the memory window to make a distinction with the memory browser
76-- The all watch, and Exception Vector Table windows, can be closed using keyboard
77-- Renamed the debugger dedicated icons to make a distinction
78-- Added the call stack window
7918) Fixed a crash in the all watch window after loading a new binary without ELF/DWARF information
80-- Previously used ELF/DWARF information was still accessible
8119) Fixed slash/backslash issue, in the Alpine tab, to follow platform requirement
8220) Heap allocation window uses the DRAM size limit option and detect if heap allocation shares space with SP (Stack)
8321) Added a Jaguar model and BIOS configuration tab
8422) Jaguar model and BIOS configuration integration
8523) Added LEB128 decoding functions
86-- It is used for the DWARF decoding information
8724) Debugger support improvement
88-- DWARF support for the enum type (partial), structure and subroutine type
89-- Debugger can report variable's unsigned char value
9025) UI modifications
91-- Added a status bar, better status report & information display for the heap allocation window
92-- Added a status bar, better status report & information display for the local variables window
93-- Added better information display for the exception vectors table window, and added some missing vectors
94-- Added a status bar, better status report & information display for the call stack window
95-- Added a status bar, better status report & information display for the all watches window
9626) Added screenshot feature
97-- Not accessible in debugger mode
98-- Added screenshot editable path in the general tab, and a key binding
9927) Minor misspellings fixes
10028) DWARF source code directory path clean-up
10129) Added a source code files list viewer
102-- List comes from the DWARF information
10330) Check potential variables missing/incomplete description found in the DWARF information
104-- No crash involved but can help to reduce such as variables duplicate or the blank ones
10531) Added a sorting filter in the all watches window
10632) Improve source code file reading to avoid additional text/bytes reading
10733) Help & content texts updates
10834) Fixed a crash legacy issue when emulator launches in Alpine mode without a valid rom
10935) Added the support for the used lines source's DWARF structure
110-- Mostly used to handle missing subprogram's lines information, and missing CU's low/high PC
11136) Added the Rx version's contact in the help text
11237) Added search paths in case of missing DWARF directories information
113-- Used to look for the file(s)
11438) Setup CU's low/high PC in case of the DWARF structures doesn't have it
115-- Used mostly to allow display the source assembled with vasm
11639) Added function name support from ELF structure
11740) Added the return address information in the call stack
8d705db0 11841) Added multiple breakpoints feature, and their key bindings, for functions only
24470541 11942) Added timer initialisation for the SDL setup
f99a6ebc 12043) Added a cartridge view menu
24470541 121-- Added a window to display my own directory and his files list
6642f781 12244) Debugger sources code clean-up
acd3342f 12345) Fix a crash when emulator, in non-debugger mode, opens the breakpoint UIs at launch
f951022b 12446) Fix crash with potential missing DWARF structure tag's type name
c57d3e56 12547) Added ELF sections check so a potential unknown section will stop, or not stop, the decoding
aae93d86 12648) Project has switched to Qt 5.12.0 library 64bits for VS 2017
3323d78b 12749) Added a Save Dump As... feature to save a memory zone to a file
12850) The -d command line option, dedicated to the debugger, has been renamed to avoid duplication with the dsp one
129-- -d has been renamed by -D because another -d was also used for the dsp command line option
8d705db0 13051) Removed the sorting filter in the all watches window
96bd5390 13152) Fix the support of the DRAM size limit option in the heap allocation window
f99a6ebc 13253) Set cartridge view menu for debugger mode only
8b11a1b0 13354) Prevent crash in case of call stack is out of range
135Release 3 (13th November 2017)
137Git commit: b1b673a3b0d19e3c2c45b6590b773b11e45bced7
1390) Fixed the windows respawning in the next emulator launch within --alpine or --debugger options
1401) Added an Exception Vector Table window
1412) Modified the About window to update the credits list in a more appropriate way
142-- Updated the emulator application credits line
1433) Added 'Rx' word to the emulator name
1444) Fixed a crash when reading the DWARF information in the case of the DWARF2 format has not been used
1455) Added ui, alpine and debugger groups in the settings
1466) Added the possibility to erase settings
1477) Added the --es-all, --es-ui, --es-alpine and --es-debugger options to erase specific settings
1488) Added a key bindings tab and adapted the configuration dialog tabs
149-- User can modify the key bindings where appropriate
150-- Key bindings UI is displayed based on the option used (--debugger, -- alpine)
1519) Fixed a crash, in Release mode, when the HW labels setting is turn on
15210) Solved an interference between the HW labels setting and the one used by the debugger
153-- The setting is now only the reference used
15411) Fixed the SP (Stack) browser UI potential missing data
15512) Create a directory for EEPROMs (based on the EEPROMs setting) if it doesn't already exist
15613) Keep the scrollbar position in accordance of the M68K PC pointer
157-- UI displays the source without the need to move down/up the scrollbar
15814) Fixed a crash when DWARF information report a source line number exceeding the number of lines present in a source file
159-- This may come from the linker vlink
16015) Improved the .heap section detection to avoid a detection error
161-- Depend vlink version, .heap section may have an Alloc flag
16216) Fixed a crash when DWARF information does references to missing source code files
16317) Added a local variables window
aae93d86 16418) Project has switched to Visual Studio 2017 and Qt 5.9.1 library
166Release 2 (3rd September 2017)
1680) Added some error detections when reading the ELF executable file
1691) Added all hardware labels (based on the document scans from the Version 2.4 - June 7, 1995)
1702) "Step Over" code function for BSR/JSR functions
1713) Added the .debug_ranges detection to avoid a detection error
1724) DWARF support
173-- TAG: Compilation Unit, Subprogram, Variables, Types
174-- Line numbers, symbols, functions
1755) Added an All Watch window for non-local variables
1766) Added a heap allocator window based on my own memory allocation functions
1777) Added additional 4 memory windows with address input based on hexa, decimal or symbol name
1788) Windows refreshing executed only if windows is visible
1799) Added a restart function
180-- Restart only the 68000 program counter to his original set
18110) Modified the icons color backgound for the "Step In" and "Step Over" functions
18211) Updated the About window to update the credits list
18312) 64 bits Release executable
18413) Fixed (hacking) the display of the SP (Stack) browser
18514) Set the emulator in Halt mode when launched in alpine debug mode without a loaded rom
186-- Otherwise the 68000 program counter will have a 0 value and will execute the code at this address
18715) Added some information in the --help/-h/-? option
18816) --debugger option no longer force the log file
18917) Added a --dram-max option to extend the DRAM size to 8MB
19018) Added the "enter" key support when setting the BPM (Breapoint)
19119) Save the windows positions, size and visibilities (show or hide) status
192-- Such windows will automatically respawn in the next emulator launch
194Release 1 (12th February 2017)
1960) BPM (Breapoint) now stop at the designated address and no longer stop after executing the code
1971) Clean-up the tracing / no-tracing flags for better U.I understanding
1982) Added SP (Stack) browser
1993) User can change now the number of lines of disassembly displayed in the tracing window
2004) User can turn on/off the op-codes associated in the disassembly lines displayed in the M68K tracing window
2015) Added an emulator status window (GPU status, M68K debugger and tracking status)
2026) Added a GPU disassembly tracing window - Display the current PC pointer
2037) Added a DSP disassembly tracing window - Display the current PC pointer
2048) Added possibility to change refresh rate of browsers when emulation is launched
2059) Display partial hardware labels (Internal Memory and Graphics sub-system address space) in the disassembly lines displayed in the M68K tracing window
206-- Display first the hardware labels (based from the Jag V8 dev. PDF) and then the ones possibly found in the ELF debug symbol
20710) Minor U.I cosmetic changes
20811) User can turn on/off the hardware labels associated in the disassembly lines displayed in the M68K tracing window
209-- It doesn't apply to the hardware labels possibly found in the ELF debug symbol
211Release 0 (5th January 2017)
2130) New option --debugger
2141) ELF format support
2152) ELF debug symbol support
2163) "Step Into" code function
2174) Menus layout dedicated to the debugger
2185) Added a dedicated main window for tracing (M68K)
2196) Added a Debugger tab in the config tab
2207) Visual Studio 2015 project support
2218) libelf-0.8.13 library support
2229) 64 bits debug executable only
225Known issues
aae93d86 2271) 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
2282) The BPM (Breapoint) remains stuck on his address when user wants to continue the code execution
229-- Need to trace over the BPM or unset the BPM
230-- The issue can be prevented if the code doesn't set IRQ, otherwise the IRQ will need to be traced to get back control
2313) DWARF 2 support
232-- With GCC: the code must be compiled with the -gdwarf-2 option
2334) The Local and Watch variables window may display not available type information or empty information
234-- Such missing information may be included in future release
235-- The 'const' type may not be reported correctly in the DWARF information
2365) The 2MB mirroring is no longer applied in case of --dram-max option usage
2376) Stack must reflect the --dram-max option usage otherwise the stack may be corrupted
238-- The application needs to set the SP (Stack) in accordance
2397) The Exception Vector Table window displays only 65 vectors
240-- Missing vectors may be added in future release
2418) User needs to manualy check if the Atari Jaguar executable match his source code files
242-- Otherwise, source code and assembly may not match or leads to instabilities
2439) The emulator needs to be restarted in case of the following actions occur
244-- Key bindings changes
245-- BIOS selection changes and without new executable load
24610) 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
24711) Emulator will crash in case of wrong address value provided in the memory browser
24812) The RAM access log is limited to the 2MB
24913) In various occasions, global variables may be duplicated or without name in the DWARF information
250-- It may come from the Vlink linker and/or GCC 7.1.0 or 8.2.0 compilation with -gdwarf-2 option
25114) Source code disply only assembled code from vasm with option -dwarf
25215) After a new breakpoint set, the breakpoint list window is not refreshed
253-- User must perform an operation, such code tracing, to see the breakpoints list update
25416) Some ASCII characters may be not displayed correctly
aae93d86 255-- Probably depend how the text is displayed, this is related to the Qt/HTML encoding done when reading DWARF file
24470541 25617) Potential legacy crash when leaving emulator in pause mode for a long period of time
aae93d86 257-- Need much investigation
259Cosmetic / UX issues
2611) The SP (Stack) icon color backgound doesn't look similar with the other ones
2622) The SP (Stack) browser size always open at a forced size no matter if the size has been changed
2633) Not every features have associated key bindings
265Legacy issues/hints
2671) Emulator seems to have easter egg(s)
268-- The option --yarrr displays a single message and end the application
269-- Pressing F8, while in the main window, will create an extra message in the log file
2702) The --alpine option force the log file but it can be override if --no-log option is set after the --alpine option
272Project information
2741) Code based on the Shamus Hammons source code available via Gethub by the 12th September 2017 (2.1.3 Final)
2752) Visual Studio 2017 project support for 64 bits
2763) libelf 0.8.13 library 64bits for VS 2017
40692bae 2774) libdwarf 20210305 library 64bits for VS 2017
2785) Qt 5.12.0 library 64bits for VS 2017
2796) Zlib 1.2.11 library 64bits for VS 2017
2807) SDL 1.2.15 library 64bits for VS 2017
2818) The original make files have been modified to follow the requirements and modifications
2829) The 'Rx' word has been added to the emulator name to make distinction with the official version
28310) The project is set at
28411) GPLv3 file document has been renamed as LICENSE, to fit better the GitHub requirements
1081a838 285-- Text / License terms are the same
adf158c7 28614) The x86 configuration has been removed in the VS 2017 project
289Download statistics
291jaguar64eu : 15 downloads for the Release 0 on the 12th Feb, 2017
292jaguar64eu : 18 downloads for the Release 1 on the 21st May, 2017
293No downloads statistics available for the Release 2
294No downloads statistics available for the Release 3