DWARF information support updates
[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
973347f3 2617) Show the SR value as a readable form in the M68K CPU browser
40692bae 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
cbd79f66 3522) Breakpoint list window is now refreshed after a new breakpoint is set
3623) Handle number of M68K cycles used when tracing in debugger mode
37-- The cycles are displayed in the emulator status window
1cd9e492 3824) Improve the DWARF source line number reporting
3925) Added a #line in the call stack window
4026) Add a search feature in the all watches window
96aa54e4 4127) Added video output display in a specific window
973347f3 4228) Fixed potential crash with the debugger tabs reset
7512bf05 4329) Added a search feature in the All Watch variables window
d0774971 4430) Support the structure's members in the Local variables window
c13e5416 4531) Code refactoring for the variables support in debugger mode
5c5de885 4632) Support the structure and union members from the DWARF information
48Release 4a (15th August 2019)
50Git commit: f04df4f185ed4f3cfc805d0f61b3c019a108ae2c
520) Fix specific breakpoint for ROM cartridge or unknown memory location writing
54Release 4 (10th August 2019)
56Git commit: 9b25d85d1ea4a9476b83476bcec65e05464f68da
580) The zoom value setting has been fixed in the registry
591) Debugger mode now shares the same alpine rom path setting
602) Local variables window displays register name now
613) Switch to Zlib 1.2.11 static library 64bits for VS 2017
624) Switch to SDL 1.2.15 static library 64bits for VS 2017
635) Local variables window displays values from function's parameters
646) Fixed the typedef's name display in Local and Watch variables window
657) Breakpoint may now occur in case of a ROM cartridge writing
66-- ROM cartridge writing detection follow the alpine "allow writes to cartridge rom"'s flag check
67-- 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
688) Local variables window detects now if a variable is used or not by the code
699) The address provided in the debugger memory windows is now verified to prevent crash
70-- Wrong address will be displayed in red
7110) UI changes
72-- Added new icons for the exit and status features
73-- Modified icons for the SP (Stack) browser
74-- Unified icons sizes depend on their usage (drop down menu and main menu)
75-- Underline the active M68K line in the disassembly window
76-- Allow the up/down navigation on the SP (Stack) browser
77-- Restart function cleans-up the SP (Stack) browser and the heap allocator system
78-- Fixed the up navigation on the memory window
7911) Added some log information for the emulator initialisations
8012) Breakpoint will happen in case of writing at unknown memory location
81-- Alert box will display a message and then the code will stop
8213) Added the DRAM size in the emulator status window
8314) Debugger sources code clean-up
8415) Added a call stack feature
8516) Follow platform requirement to prevent source file reading issue
8617) UI modifications
87-- Modified icon for the memory window to make a distinction with the memory browser
88-- The all watch, and Exception Vector Table windows, can be closed using keyboard
89-- Renamed the debugger dedicated icons to make a distinction
90-- Added the call stack window
9118) Fixed a crash in the all watch window after loading a new binary without ELF/DWARF information
92-- Previously used ELF/DWARF information was still accessible
9319) Fixed slash/backslash issue, in the Alpine tab, to follow platform requirement
9420) Heap allocation window uses the DRAM size limit option and detect if heap allocation shares space with SP (Stack)
9521) Added a Jaguar model and BIOS configuration tab
9622) Jaguar model and BIOS configuration integration
9723) Added LEB128 decoding functions
98-- It is used for the DWARF decoding information
9924) Debugger support improvement
100-- DWARF support for the enum type (partial), structure and subroutine type
101-- Debugger can report variable's unsigned char value
10225) UI modifications
103-- Added a status bar, better status report & information display for the heap allocation window
104-- Added a status bar, better status report & information display for the local variables window
105-- Added better information display for the exception vectors table window, and added some missing vectors
106-- Added a status bar, better status report & information display for the call stack window
107-- Added a status bar, better status report & information display for the all watches window
10826) Added screenshot feature
109-- Not accessible in debugger mode
110-- Added screenshot editable path in the general tab, and a key binding
11127) Minor misspellings fixes
11228) DWARF source code directory path clean-up
11329) Added a source code files list viewer
114-- List comes from the DWARF information
11530) Check potential variables missing/incomplete description found in the DWARF information
116-- No crash involved but can help to reduce such as variables duplicate or the blank ones
11731) Added a sorting filter in the all watches window
11832) Improve source code file reading to avoid additional text/bytes reading
11933) Help & content texts updates
12034) Fixed a crash legacy issue when emulator launches in Alpine mode without a valid rom
12135) Added the support for the used lines source's DWARF structure
122-- Mostly used to handle missing subprogram's lines information, and missing CU's low/high PC
12336) Added the Rx version's contact in the help text
12437) Added search paths in case of missing DWARF directories information
125-- Used to look for the file(s)
12638) Setup CU's low/high PC in case of the DWARF structures doesn't have it
127-- Used mostly to allow display the source assembled with vasm
12839) Added function name support from ELF structure
12940) Added the return address information in the call stack
8d705db0 13041) Added multiple breakpoints feature, and their key bindings, for functions only
24470541 13142) Added timer initialisation for the SDL setup
f99a6ebc 13243) Added a cartridge view menu
24470541 133-- Added a window to display my own directory and his files list
6642f781 13444) Debugger sources code clean-up
acd3342f 13545) Fix a crash when emulator, in non-debugger mode, opens the breakpoint UIs at launch
f951022b 13646) Fix crash with potential missing DWARF structure tag's type name
c57d3e56 13747) Added ELF sections check so a potential unknown section will stop, or not stop, the decoding
aae93d86 13848) Project has switched to Qt 5.12.0 library 64bits for VS 2017
3323d78b 13949) Added a Save Dump As... feature to save a memory zone to a file
14050) The -d command line option, dedicated to the debugger, has been renamed to avoid duplication with the dsp one
141-- -d has been renamed by -D because another -d was also used for the dsp command line option
8d705db0 14251) Removed the sorting filter in the all watches window
96bd5390 14352) Fix the support of the DRAM size limit option in the heap allocation window
f99a6ebc 14453) Set cartridge view menu for debugger mode only
8b11a1b0 14554) Prevent crash in case of call stack is out of range
147Release 3 (13th November 2017)
149Git commit: b1b673a3b0d19e3c2c45b6590b773b11e45bced7
1510) Fixed the windows respawning in the next emulator launch within --alpine or --debugger options
1521) Added an Exception Vector Table window
1532) Modified the About window to update the credits list in a more appropriate way
154-- Updated the emulator application credits line
1553) Added 'Rx' word to the emulator name
1564) Fixed a crash when reading the DWARF information in the case of the DWARF2 format has not been used
1575) Added ui, alpine and debugger groups in the settings
1586) Added the possibility to erase settings
1597) Added the --es-all, --es-ui, --es-alpine and --es-debugger options to erase specific settings
1608) Added a key bindings tab and adapted the configuration dialog tabs
161-- User can modify the key bindings where appropriate
162-- Key bindings UI is displayed based on the option used (--debugger, -- alpine)
1639) Fixed a crash, in Release mode, when the HW labels setting is turn on
16410) Solved an interference between the HW labels setting and the one used by the debugger
165-- The setting is now only the reference used
16611) Fixed the SP (Stack) browser UI potential missing data
16712) Create a directory for EEPROMs (based on the EEPROMs setting) if it doesn't already exist
16813) Keep the scrollbar position in accordance of the M68K PC pointer
169-- UI displays the source without the need to move down/up the scrollbar
17014) Fixed a crash when DWARF information report a source line number exceeding the number of lines present in a source file
171-- This may come from the linker vlink
17215) Improved the .heap section detection to avoid a detection error
173-- Depend vlink version, .heap section may have an Alloc flag
17416) Fixed a crash when DWARF information does references to missing source code files
17517) Added a local variables window
aae93d86 17618) Project has switched to Visual Studio 2017 and Qt 5.9.1 library
178Release 2 (3rd September 2017)
1800) Added some error detections when reading the ELF executable file
1811) Added all hardware labels (based on the document scans from the Version 2.4 - June 7, 1995)
1822) "Step Over" code function for BSR/JSR functions
1833) Added the .debug_ranges detection to avoid a detection error
1844) DWARF support
185-- TAG: Compilation Unit, Subprogram, Variables, Types
186-- Line numbers, symbols, functions
1875) Added an All Watch window for non-local variables
1886) Added a heap allocator window based on my own memory allocation functions
1897) Added additional 4 memory windows with address input based on hexa, decimal or symbol name
1908) Windows refreshing executed only if windows is visible
1919) Added a restart function
192-- Restart only the 68000 program counter to his original set
19310) Modified the icons color backgound for the "Step In" and "Step Over" functions
19411) Updated the About window to update the credits list
19512) 64 bits Release executable
19613) Fixed (hacking) the display of the SP (Stack) browser
19714) Set the emulator in Halt mode when launched in alpine debug mode without a loaded rom
198-- Otherwise the 68000 program counter will have a 0 value and will execute the code at this address
19915) Added some information in the --help/-h/-? option
20016) --debugger option no longer force the log file
20117) Added a --dram-max option to extend the DRAM size to 8MB
20218) Added the "enter" key support when setting the BPM (Breapoint)
20319) Save the windows positions, size and visibilities (show or hide) status
204-- Such windows will automatically respawn in the next emulator launch
206Release 1 (12th February 2017)
2080) BPM (Breapoint) now stop at the designated address and no longer stop after executing the code
2091) Clean-up the tracing / no-tracing flags for better U.I understanding
2102) Added SP (Stack) browser
2113) User can change now the number of lines of disassembly displayed in the tracing window
2124) User can turn on/off the op-codes associated in the disassembly lines displayed in the M68K tracing window
2135) Added an emulator status window (GPU status, M68K debugger and tracking status)
2146) Added a GPU disassembly tracing window - Display the current PC pointer
2157) Added a DSP disassembly tracing window - Display the current PC pointer
2168) Added possibility to change refresh rate of browsers when emulation is launched
2179) Display partial hardware labels (Internal Memory and Graphics sub-system address space) in the disassembly lines displayed in the M68K tracing window
218-- Display first the hardware labels (based from the Jag V8 dev. PDF) and then the ones possibly found in the ELF debug symbol
21910) Minor U.I cosmetic changes
22011) User can turn on/off the hardware labels associated in the disassembly lines displayed in the M68K tracing window
221-- It doesn't apply to the hardware labels possibly found in the ELF debug symbol
223Release 0 (5th January 2017)
2250) New option --debugger
2261) ELF format support
2272) ELF debug symbol support
2283) "Step Into" code function
2294) Menus layout dedicated to the debugger
2305) Added a dedicated main window for tracing (M68K)
2316) Added a Debugger tab in the config tab
2327) Visual Studio 2015 project support
2338) libelf-0.8.13 library support
2349) 64 bits debug executable only
237Known issues
aae93d86 2391) 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
2402) The BPM (Breapoint) remains stuck on his address when user wants to continue the code execution
241-- Need to trace over the BPM or unset the BPM
242-- The issue can be prevented if the code doesn't set IRQ, otherwise the IRQ will need to be traced to get back control
2433) DWARF 2 support
244-- With GCC: the code must be compiled with the -gdwarf-2 option
2454) The Local and Watch variables window may display not available type information or empty information
246-- Such missing information may be included in future release
247-- The 'const' type may not be reported correctly in the DWARF information
2485) The 2MB mirroring is no longer applied in case of --dram-max option usage
2496) Stack must reflect the --dram-max option usage otherwise the stack may be corrupted
250-- The application needs to set the SP (Stack) in accordance
2517) The Exception Vector Table window displays only 65 vectors
252-- Missing vectors may be added in future release
2538) User needs to manualy check if the Atari Jaguar executable match his source code files
254-- Otherwise, source code and assembly may not match or leads to instabilities
2559) The emulator needs to be restarted in case of the following actions occur
256-- Key bindings changes
257-- BIOS selection changes and without new executable load
25810) 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
25911) Emulator will crash in case of wrong address value provided in the memory browser
26012) The RAM access log is limited to the 2MB
26113) In various occasions, global variables may be duplicated or without name in the DWARF information
262-- It may come from the Vlink linker and/or GCC 7.1.0 or 8.2.0 compilation with -gdwarf-2 option
26314) Source code disply only assembled code from vasm with option -dwarf
26415) After a new breakpoint set, the breakpoint list window is not refreshed
265-- User must perform an operation, such code tracing, to see the breakpoints list update
26616) Some ASCII characters may be not displayed correctly
aae93d86 267-- Probably depend how the text is displayed, this is related to the Qt/HTML encoding done when reading DWARF file
24470541 26817) Potential legacy crash when leaving emulator in pause mode for a long period of time
aae93d86 269-- Need much investigation
271Cosmetic / UX issues
2731) The SP (Stack) icon color backgound doesn't look similar with the other ones
2742) The SP (Stack) browser size always open at a forced size no matter if the size has been changed
2753) Not every features have associated key bindings
277Legacy issues/hints
2791) Emulator seems to have easter egg(s)
280-- The option --yarrr displays a single message and end the application
281-- Pressing F8, while in the main window, will create an extra message in the log file
2822) The --alpine option force the log file but it can be override if --no-log option is set after the --alpine option
284Project information
2861) Code based on the Shamus Hammons source code available via Gethub by the 12th September 2017 (2.1.3 Final)
2872) Visual Studio 2017 project support for 64 bits
2883) libelf 0.8.13 library 64bits for VS 2017
40692bae 2894) libdwarf 20210305 library 64bits for VS 2017
2905) Qt 5.12.0 library 64bits for VS 2017
2916) Zlib 1.2.11 library 64bits for VS 2017
2927) SDL 1.2.15 library 64bits for VS 2017
2938) The original make files have been modified to follow the requirements and modifications
2949) The 'Rx' word has been added to the emulator name to make distinction with the official version
29510) The project is set at https://github.com/djipi/Virtual-Jaguar-Rx
29611) GPLv3 file document has been renamed as LICENSE, to fit better the GitHub requirements
1081a838 297-- Text / License terms are the same
adf158c7 29814) The x86 configuration has been removed in the VS 2017 project
301Download statistics
303jaguar64eu : 15 downloads for the Release 0 on the 12th Feb, 2017
304jaguar64eu : 18 downloads for the Release 1 on the 21st May, 2017
305No downloads statistics available for the Release 2
306No downloads statistics available for the Release 3