Added a source code file date check when reading DWARF information
[clinton/Virtual-Jaguar-Rx.git] / docs / vj_HistoryNotes.txt
CommitLineData
fe41cce0
JPM
1Release 5 (TBA)
2---------------
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
f6eb33e6
JPM
51) Added a specific breakpoint for the M68K illegal instruction exception
6-- Alert box will display a message and then the code will stop
0cbc132e
JPM
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
ef0da6de
JPM
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
009df4d7
JPM
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) Project has switched to libdwarf 20200114 library 64bits for VS 2017
2114) Set text conversion to Qt/HTML format for the M68K tracing window
2215) Added a source code file date check when reading DWARF information
23-- Will avoid source code mismatching with the ELF executable
fe41cce0
JPM
24
25Release 4a (15th August 2019)
26-----------------------------
27Git commit: f04df4f185ed4f3cfc805d0f61b3c019a108ae2c
f04df4f1
JPM
28-
290) Fix specific breakpoint for ROM cartridge or unknown memory location writing
30
31Release 4 (10th August 2019)
32----------------------------
33Git commit: 9b25d85d1ea4a9476b83476bcec65e05464f68da
1081a838
JPM
34-
350) The zoom value setting has been fixed in the registry
361) Debugger mode now shares the same alpine rom path setting
372) Local variables window displays register name now
383) Switch to Zlib 1.2.11 static library 64bits for VS 2017
394) Switch to SDL 1.2.15 static library 64bits for VS 2017
405) Local variables window displays values from function's parameters
416) Fixed the typedef's name display in Local and Watch variables window
427) Breakpoint may now occur in case of a ROM cartridge writing
43-- ROM cartridge writing detection follow the alpine "allow writes to cartridge rom"'s flag check
44-- 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
458) Local variables window detects now if a variable is used or not by the code
469) The address provided in the debugger memory windows is now verified to prevent crash
47-- Wrong address will be displayed in red
4810) UI changes
49-- Added new icons for the exit and status features
50-- Modified icons for the SP (Stack) browser
51-- Unified icons sizes depend on their usage (drop down menu and main menu)
52-- Underline the active M68K line in the disassembly window
53-- Allow the up/down navigation on the SP (Stack) browser
54-- Restart function cleans-up the SP (Stack) browser and the heap allocator system
55-- Fixed the up navigation on the memory window
5611) Added some log information for the emulator initialisations
5712) Breakpoint will happen in case of writing at unknown memory location
58-- Alert box will display a message and then the code will stop
5913) Added the DRAM size in the emulator status window
6014) Debugger sources code clean-up
6115) Added a call stack feature
6216) Follow platform requirement to prevent source file reading issue
6317) UI modifications
64-- Modified icon for the memory window to make a distinction with the memory browser
65-- The all watch, and Exception Vector Table windows, can be closed using keyboard
66-- Renamed the debugger dedicated icons to make a distinction
67-- Added the call stack window
6818) Fixed a crash in the all watch window after loading a new binary without ELF/DWARF information
69-- Previously used ELF/DWARF information was still accessible
7019) Fixed slash/backslash issue, in the Alpine tab, to follow platform requirement
7120) Heap allocation window uses the DRAM size limit option and detect if heap allocation shares space with SP (Stack)
7221) Added a Jaguar model and BIOS configuration tab
7322) Jaguar model and BIOS configuration integration
7423) Added LEB128 decoding functions
75-- It is used for the DWARF decoding information
7624) Debugger support improvement
77-- DWARF support for the enum type (partial), structure and subroutine type
78-- Debugger can report variable's unsigned char value
7925) UI modifications
80-- Added a status bar, better status report & information display for the heap allocation window
81-- Added a status bar, better status report & information display for the local variables window
82-- Added better information display for the exception vectors table window, and added some missing vectors
83-- Added a status bar, better status report & information display for the call stack window
84-- Added a status bar, better status report & information display for the all watches window
8526) Added screenshot feature
86-- Not accessible in debugger mode
87-- Added screenshot editable path in the general tab, and a key binding
8827) Minor misspellings fixes
8928) DWARF source code directory path clean-up
9029) Added a source code files list viewer
91-- List comes from the DWARF information
9230) Check potential variables missing/incomplete description found in the DWARF information
93-- No crash involved but can help to reduce such as variables duplicate or the blank ones
9431) Added a sorting filter in the all watches window
9532) Improve source code file reading to avoid additional text/bytes reading
9633) Help & content texts updates
9734) Fixed a crash legacy issue when emulator launches in Alpine mode without a valid rom
9835) Added the support for the used lines source's DWARF structure
99-- Mostly used to handle missing subprogram's lines information, and missing CU's low/high PC
10036) Added the Rx version's contact in the help text
10137) Added search paths in case of missing DWARF directories information
102-- Used to look for the file(s)
10338) Setup CU's low/high PC in case of the DWARF structures doesn't have it
104-- Used mostly to allow display the source assembled with vasm
10539) Added function name support from ELF structure
10640) Added the return address information in the call stack
8d705db0 10741) Added multiple breakpoints feature, and their key bindings, for functions only
24470541 10842) Added timer initialisation for the SDL setup
f99a6ebc 10943) Added a cartridge view menu
24470541 110-- Added a window to display my own directory and his files list
6642f781 11144) Debugger sources code clean-up
acd3342f 11245) Fix a crash when emulator, in non-debugger mode, opens the breakpoint UIs at launch
f951022b 11346) Fix crash with potential missing DWARF structure tag's type name
c57d3e56 11447) Added ELF sections check so a potential unknown section will stop, or not stop, the decoding
aae93d86 11548) Project has switched to Qt 5.12.0 library 64bits for VS 2017
3323d78b 11649) Added a Save Dump As... feature to save a memory zone to a file
9c4d8f10
JPM
11750) The -d command line option, dedicated to the debugger, has been renamed to avoid duplication with the dsp one
118-- -d has been renamed by -D because another -d was also used for the dsp command line option
8d705db0 11951) Removed the sorting filter in the all watches window
96bd5390 12052) Fix the support of the DRAM size limit option in the heap allocation window
f99a6ebc 12153) Set cartridge view menu for debugger mode only
8b11a1b0 12254) Prevent crash in case of call stack is out of range
1081a838
JPM
123
124Release 3 (13th November 2017)
125------------------------------
126Git commit: b1b673a3b0d19e3c2c45b6590b773b11e45bced7
127-
1280) Fixed the windows respawning in the next emulator launch within --alpine or --debugger options
1291) Added an Exception Vector Table window
1302) Modified the About window to update the credits list in a more appropriate way
131-- Updated the emulator application credits line
1323) Added 'Rx' word to the emulator name
1334) Fixed a crash when reading the DWARF information in the case of the DWARF2 format has not been used
1345) Added ui, alpine and debugger groups in the settings
1356) Added the possibility to erase settings
1367) Added the --es-all, --es-ui, --es-alpine and --es-debugger options to erase specific settings
1378) Added a key bindings tab and adapted the configuration dialog tabs
138-- User can modify the key bindings where appropriate
139-- Key bindings UI is displayed based on the option used (--debugger, -- alpine)
1409) Fixed a crash, in Release mode, when the HW labels setting is turn on
14110) Solved an interference between the HW labels setting and the one used by the debugger
142-- The setting is now only the reference used
14311) Fixed the SP (Stack) browser UI potential missing data
14412) Create a directory for EEPROMs (based on the EEPROMs setting) if it doesn't already exist
14513) Keep the scrollbar position in accordance of the M68K PC pointer
146-- UI displays the source without the need to move down/up the scrollbar
14714) Fixed a crash when DWARF information report a source line number exceeding the number of lines present in a source file
148-- This may come from the linker vlink
14915) Improved the .heap section detection to avoid a detection error
150-- Depend vlink version, .heap section may have an Alloc flag
15116) Fixed a crash when DWARF information does references to missing source code files
15217) Added a local variables window
aae93d86 15318) Project has switched to Visual Studio 2017 and Qt 5.9.1 library
1081a838
JPM
154
155Release 2 (3rd September 2017)
156------------------------------
1570) Added some error detections when reading the ELF executable file
1581) Added all hardware labels (based on the document scans from the Version 2.4 - June 7, 1995)
1592) "Step Over" code function for BSR/JSR functions
1603) Added the .debug_ranges detection to avoid a detection error
1614) DWARF support
162-- TAG: Compilation Unit, Subprogram, Variables, Types
163-- Line numbers, symbols, functions
1645) Added an All Watch window for non-local variables
1656) Added a heap allocator window based on my own memory allocation functions
1667) Added additional 4 memory windows with address input based on hexa, decimal or symbol name
1678) Windows refreshing executed only if windows is visible
1689) Added a restart function
169-- Restart only the 68000 program counter to his original set
17010) Modified the icons color backgound for the "Step In" and "Step Over" functions
17111) Updated the About window to update the credits list
17212) 64 bits Release executable
17313) Fixed (hacking) the display of the SP (Stack) browser
17414) Set the emulator in Halt mode when launched in alpine debug mode without a loaded rom
175-- Otherwise the 68000 program counter will have a 0 value and will execute the code at this address
17615) Added some information in the --help/-h/-? option
17716) --debugger option no longer force the log file
17817) Added a --dram-max option to extend the DRAM size to 8MB
17918) Added the "enter" key support when setting the BPM (Breapoint)
18019) Save the windows positions, size and visibilities (show or hide) status
181-- Such windows will automatically respawn in the next emulator launch
182
183Release 1 (12th February 2017)
184------------------------------
1850) BPM (Breapoint) now stop at the designated address and no longer stop after executing the code
1861) Clean-up the tracing / no-tracing flags for better U.I understanding
1872) Added SP (Stack) browser
1883) User can change now the number of lines of disassembly displayed in the tracing window
1894) User can turn on/off the op-codes associated in the disassembly lines displayed in the M68K tracing window
1905) Added an emulator status window (GPU status, M68K debugger and tracking status)
1916) Added a GPU disassembly tracing window - Display the current PC pointer
1927) Added a DSP disassembly tracing window - Display the current PC pointer
1938) Added possibility to change refresh rate of browsers when emulation is launched
1949) Display partial hardware labels (Internal Memory and Graphics sub-system address space) in the disassembly lines displayed in the M68K tracing window
195-- Display first the hardware labels (based from the Jag V8 dev. PDF) and then the ones possibly found in the ELF debug symbol
19610) Minor U.I cosmetic changes
19711) User can turn on/off the hardware labels associated in the disassembly lines displayed in the M68K tracing window
198-- It doesn't apply to the hardware labels possibly found in the ELF debug symbol
199
200Release 0 (5th January 2017)
201----------------------------
2020) New option --debugger
2031) ELF format support
2042) ELF debug symbol support
2053) "Step Into" code function
2064) Menus layout dedicated to the debugger
2075) Added a dedicated main window for tracing (M68K)
2086) Added a Debugger tab in the config tab
2097) Visual Studio 2015 project support
2108) libelf-0.8.13 library support
2119) 64 bits debug executable only
212
213
214Known issues
215============
aae93d86 2161) 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
1081a838
JPM
2172) The BPM (Breapoint) remains stuck on his address when user wants to continue the code execution
218-- Need to trace over the BPM or unset the BPM
219-- The issue can be prevented if the code doesn't set IRQ, otherwise the IRQ will need to be traced to get back control
2203) DWARF 2 support
221-- With GCC: the code must be compiled with the -gdwarf-2 option
2224) The Local and Watch variables window may display not available type information or empty information
223-- Such missing information may be included in future release
224-- The 'const' type may not be reported correctly in the DWARF information
2255) The 2MB mirroring is no longer applied in case of --dram-max option usage
2266) Stack must reflect the --dram-max option usage otherwise the stack may be corrupted
227-- The application needs to set the SP (Stack) in accordance
2287) The Exception Vector Table window displays only 65 vectors
229-- Missing vectors may be added in future release
2308) User needs to manualy check if the Atari Jaguar executable match his source code files
231-- Otherwise, source code and assembly may not match or leads to instabilities
2329) The emulator needs to be restarted in case of the following actions occur
233-- Key bindings changes
234-- BIOS selection changes and without new executable load
23510) 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
23611) Emulator will crash in case of wrong address value provided in the memory browser
23712) The RAM access log is limited to the 2MB
23813) In various occasions, global variables may be duplicated or without name in the DWARF information
239-- It may come from the Vlink linker and/or GCC 7.1.0 or 8.2.0 compilation with -gdwarf-2 option
24014) Source code disply only assembled code from vasm with option -dwarf
24115) After a new breakpoint set, the breakpoint list window is not refreshed
242-- User must perform an operation, such code tracing, to see the breakpoints list update
24316) Some ASCII characters may be not displayed correctly
aae93d86 244-- Probably depend how the text is displayed, this is related to the Qt/HTML encoding done when reading DWARF file
24470541 24517) Potential legacy crash when leaving emulator in pause mode for a long period of time
aae93d86 246-- Need much investigation
1081a838
JPM
247
248Cosmetic / UX issues
249====================
2501) The SP (Stack) icon color backgound doesn't look similar with the other ones
2512) The SP (Stack) browser size always open at a forced size no matter if the size has been changed
2523) Not every features have associated key bindings
253
254Legacy issues/hints
255===================
2561) Emulator seems to have easter egg(s)
257-- The option --yarrr displays a single message and end the application
258-- Pressing F8, while in the main window, will create an extra message in the log file
2592) The --alpine option force the log file but it can be override if --no-log option is set after the --alpine option
260
261Project information
262===================
2631) Code based on the Shamus Hammons source code available via Gethub by the 12th September 2017 (2.1.3 Final)
aae93d86
JPM
2642) Visual Studio 2017 project support for 64 bits
2653) libelf 0.8.13 library 64bits for VS 2017
2664) libdwarf 20200114 library 64bits for VS 2017
2675) Qt 5.12.0 library 64bits for VS 2017
2686) Zlib 1.2.11 library 64bits for VS 2017
2697) SDL 1.2.15 library 64bits for VS 2017
2708) The original make files have been modified to follow the requirements and modifications
2719) The 'Rx' word has been added to the emulator name to make distinction with the official version
27210) The project is set at https://github.com/djipi/Virtual-Jaguar-Rx
27311) GPLv3 file document has been renamed as LICENSE, to fit better the GitHub requirements
1081a838 274-- Text / License terms are the same
adf158c7 27514) The x86 configuration has been removed in the VS 2017 project
1081a838
JPM
276
277
278Download statistics
279-------------------
280jaguar64eu : 15 downloads for the Release 0 on the 12th Feb, 2017
281jaguar64eu : 18 downloads for the Release 1 on the 21st May, 2017
282No downloads statistics available for the Release 2
283No downloads statistics available for the Release 3