core: Fix libdwarf and Qt build failure
[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
03458eec 3925) Added a #line in the call stack window
4026) Added video output display in a specific window
4127) Fixed potential crash with the debugger tabs reset
4228) Added a search feature in the All Watch variables window
4329) Support the structure's members in the Local variables window
4430) Code refactoring for the variables support in debugger mode
4531) Support the structure and union members from the DWARF information
4632) Added a Virtual Jaguar Rx logo in the About window
4733) Fix compilation / link error for MSYS2 / MinGW64
4834) Documentation updates
50Release 4a (15th August 2019)
52Git commit: f04df4f185ed4f3cfc805d0f61b3c019a108ae2c
540) Fix specific breakpoint for ROM cartridge or unknown memory location writing
56Release 4 (10th August 2019)
58Git commit: 9b25d85d1ea4a9476b83476bcec65e05464f68da
600) The zoom value setting has been fixed in the registry
611) Debugger mode now shares the same alpine rom path setting
622) Local variables window displays register name now
633) Switch to Zlib 1.2.11 static library 64bits for VS 2017
644) Switch to SDL 1.2.15 static library 64bits for VS 2017
655) Local variables window displays values from function's parameters
666) Fixed the typedef's name display in Local and Watch variables window
677) Breakpoint may now occur in case of a ROM cartridge writing
68-- ROM cartridge writing detection follow the alpine "allow writes to cartridge rom"'s flag check
69-- 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
708) Local variables window detects now if a variable is used or not by the code
719) The address provided in the debugger memory windows is now verified to prevent crash
72-- Wrong address will be displayed in red
7310) UI changes
74-- Added new icons for the exit and status features
75-- Modified icons for the SP (Stack) browser
76-- Unified icons sizes depend on their usage (drop down menu and main menu)
77-- Underline the active M68K line in the disassembly window
78-- Allow the up/down navigation on the SP (Stack) browser
79-- Restart function cleans-up the SP (Stack) browser and the heap allocator system
80-- Fixed the up navigation on the memory window
8111) Added some log information for the emulator initialisations
8212) Breakpoint will happen in case of writing at unknown memory location
83-- Alert box will display a message and then the code will stop
8413) Added the DRAM size in the emulator status window
8514) Debugger sources code clean-up
8615) Added a call stack feature
8716) Follow platform requirement to prevent source file reading issue
8817) UI modifications
89-- Modified icon for the memory window to make a distinction with the memory browser
90-- The all watch, and Exception Vector Table windows, can be closed using keyboard
91-- Renamed the debugger dedicated icons to make a distinction
92-- Added the call stack window
9318) Fixed a crash in the all watch window after loading a new binary without ELF/DWARF information
94-- Previously used ELF/DWARF information was still accessible
9519) Fixed slash/backslash issue, in the Alpine tab, to follow platform requirement
9620) Heap allocation window uses the DRAM size limit option and detect if heap allocation shares space with SP (Stack)
9721) Added a Jaguar model and BIOS configuration tab
9822) Jaguar model and BIOS configuration integration
9923) Added LEB128 decoding functions
100-- It is used for the DWARF decoding information
10124) Debugger support improvement
102-- DWARF support for the enum type (partial), structure and subroutine type
103-- Debugger can report variable's unsigned char value
10425) UI modifications
105-- Added a status bar, better status report & information display for the heap allocation window
106-- Added a status bar, better status report & information display for the local variables window
107-- Added better information display for the exception vectors table window, and added some missing vectors
108-- Added a status bar, better status report & information display for the call stack window
109-- Added a status bar, better status report & information display for the all watches window
11026) Added screenshot feature
111-- Not accessible in debugger mode
112-- Added screenshot editable path in the general tab, and a key binding
11327) Minor misspellings fixes
11428) DWARF source code directory path clean-up
11529) Added a source code files list viewer
116-- List comes from the DWARF information
11730) Check potential variables missing/incomplete description found in the DWARF information
118-- No crash involved but can help to reduce such as variables duplicate or the blank ones
11931) Added a sorting filter in the all watches window
12032) Improve source code file reading to avoid additional text/bytes reading
12133) Help & content texts updates
12234) Fixed a crash legacy issue when emulator launches in Alpine mode without a valid rom
12335) Added the support for the used lines source's DWARF structure
124-- Mostly used to handle missing subprogram's lines information, and missing CU's low/high PC
12536) Added the Rx version's contact in the help text
12637) Added search paths in case of missing DWARF directories information
127-- Used to look for the file(s)
12838) Setup CU's low/high PC in case of the DWARF structures doesn't have it
129-- Used mostly to allow display the source assembled with vasm
13039) Added function name support from ELF structure
13140) Added the return address information in the call stack
8d705db0 13241) Added multiple breakpoints feature, and their key bindings, for functions only
24470541 13342) Added timer initialisation for the SDL setup
f99a6ebc 13443) Added a cartridge view menu
24470541 135-- Added a window to display my own directory and his files list
6642f781 13644) Debugger sources code clean-up
acd3342f 13745) Fix a crash when emulator, in non-debugger mode, opens the breakpoint UIs at launch
f951022b 13846) Fix crash with potential missing DWARF structure tag's type name
c57d3e56 13947) Added ELF sections check so a potential unknown section will stop, or not stop, the decoding
aae93d86 14048) Project has switched to Qt 5.12.0 library 64bits for VS 2017
3323d78b 14149) Added a Save Dump As... feature to save a memory zone to a file
14250) The -d command line option, dedicated to the debugger, has been renamed to avoid duplication with the dsp one
143-- -d has been renamed by -D because another -d was also used for the dsp command line option
8d705db0 14451) Removed the sorting filter in the all watches window
96bd5390 14552) Fix the support of the DRAM size limit option in the heap allocation window
f99a6ebc 14653) Set cartridge view menu for debugger mode only
8b11a1b0 14754) Prevent crash in case of call stack is out of range
149Release 3 (13th November 2017)
151Git commit: b1b673a3b0d19e3c2c45b6590b773b11e45bced7
1530) Fixed the windows respawning in the next emulator launch within --alpine or --debugger options
1541) Added an Exception Vector Table window
1552) Modified the About window to update the credits list in a more appropriate way
156-- Updated the emulator application credits line
1573) Added 'Rx' word to the emulator name
1584) Fixed a crash when reading the DWARF information in the case of the DWARF2 format has not been used
1595) Added ui, alpine and debugger groups in the settings
1606) Added the possibility to erase settings
1617) Added the --es-all, --es-ui, --es-alpine and --es-debugger options to erase specific settings
1628) Added a key bindings tab and adapted the configuration dialog tabs
163-- User can modify the key bindings where appropriate
164-- Key bindings UI is displayed based on the option used (--debugger, -- alpine)
1659) Fixed a crash, in Release mode, when the HW labels setting is turn on
16610) Solved an interference between the HW labels setting and the one used by the debugger
167-- The setting is now only the reference used
16811) Fixed the SP (Stack) browser UI potential missing data
16912) Create a directory for EEPROMs (based on the EEPROMs setting) if it doesn't already exist
17013) Keep the scrollbar position in accordance of the M68K PC pointer
171-- UI displays the source without the need to move down/up the scrollbar
17214) Fixed a crash when DWARF information report a source line number exceeding the number of lines present in a source file
173-- This may come from the linker vlink
17415) Improved the .heap section detection to avoid a detection error
175-- Depend vlink version, .heap section may have an Alloc flag
17616) Fixed a crash when DWARF information does references to missing source code files
17717) Added a local variables window
aae93d86 17818) Project has switched to Visual Studio 2017 and Qt 5.9.1 library
180Release 2 (3rd September 2017)
1820) Added some error detections when reading the ELF executable file
1831) Added all hardware labels (based on the document scans from the Version 2.4 - June 7, 1995)
1842) "Step Over" code function for BSR/JSR functions
1853) Added the .debug_ranges detection to avoid a detection error
1864) DWARF support
187-- TAG: Compilation Unit, Subprogram, Variables, Types
188-- Line numbers, symbols, functions
1895) Added an All Watch window for non-local variables
1906) Added a heap allocator window based on my own memory allocation functions
1917) Added additional 4 memory windows with address input based on hexa, decimal or symbol name
1928) Windows refreshing executed only if windows is visible
1939) Added a restart function
194-- Restart only the 68000 program counter to his original set
19510) Modified the icons color backgound for the "Step In" and "Step Over" functions
19611) Updated the About window to update the credits list
19712) 64 bits Release executable
19813) Fixed (hacking) the display of the SP (Stack) browser
19914) Set the emulator in Halt mode when launched in alpine debug mode without a loaded rom
200-- Otherwise the 68000 program counter will have a 0 value and will execute the code at this address
20115) Added some information in the --help/-h/-? option
20216) --debugger option no longer force the log file
20317) Added a --dram-max option to extend the DRAM size to 8MB
20418) Added the "enter" key support when setting the BPM (Breapoint)
20519) Save the windows positions, size and visibilities (show or hide) status
206-- Such windows will automatically respawn in the next emulator launch
208Release 1 (12th February 2017)
2100) BPM (Breapoint) now stop at the designated address and no longer stop after executing the code
2111) Clean-up the tracing / no-tracing flags for better U.I understanding
2122) Added SP (Stack) browser
2133) User can change now the number of lines of disassembly displayed in the tracing window
2144) User can turn on/off the op-codes associated in the disassembly lines displayed in the M68K tracing window
2155) Added an emulator status window (GPU status, M68K debugger and tracking status)
2166) Added a GPU disassembly tracing window - Display the current PC pointer
2177) Added a DSP disassembly tracing window - Display the current PC pointer
2188) Added possibility to change refresh rate of browsers when emulation is launched
2199) Display partial hardware labels (Internal Memory and Graphics sub-system address space) in the disassembly lines displayed in the M68K tracing window
220-- Display first the hardware labels (based from the Jag V8 dev. PDF) and then the ones possibly found in the ELF debug symbol
22110) Minor U.I cosmetic changes
22211) User can turn on/off the hardware labels associated in the disassembly lines displayed in the M68K tracing window
223-- It doesn't apply to the hardware labels possibly found in the ELF debug symbol
225Release 0 (5th January 2017)
2270) New option --debugger
2281) ELF format support
2292) ELF debug symbol support
2303) "Step Into" code function
2314) Menus layout dedicated to the debugger
2325) Added a dedicated main window for tracing (M68K)
2336) Added a Debugger tab in the config tab
2347) Visual Studio 2015 project support
2358) libelf-0.8.13 library support
2369) 64 bits debug executable only
239Known issues
aae93d86 2411) 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
2422) The BPM (Breapoint) remains stuck on his address when user wants to continue the code execution
243-- Need to trace over the BPM or unset the BPM
244-- The issue can be prevented if the code doesn't set IRQ, otherwise the IRQ will need to be traced to get back control
2453) DWARF 2 support
246-- With GCC: the code must be compiled with the -gdwarf-2 option
2474) The Local and Watch variables window may display not available type information or empty information
248-- Such missing information may be included in future release
249-- The 'const' type may not be reported correctly in the DWARF information
2505) The 2MB mirroring is no longer applied in case of --dram-max option usage
2516) Stack must reflect the --dram-max option usage otherwise the stack may be corrupted
252-- The application needs to set the SP (Stack) in accordance
2537) The Exception Vector Table window displays only 65 vectors
254-- Missing vectors may be added in future release
2558) User needs to manualy check if the Atari Jaguar executable match his source code files
256-- Otherwise, source code and assembly may not match or leads to instabilities
2579) The emulator needs to be restarted in case of the following actions occur
258-- Key bindings changes
259-- BIOS selection changes and without new executable load
26010) 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
26111) Emulator will crash in case of wrong address value provided in the memory browser
26212) The RAM access log is limited to the 2MB
26313) In various occasions, global variables may be duplicated or without name in the DWARF information
264-- It may come from the Vlink linker and/or GCC 7.1.0 or 8.2.0 compilation with -gdwarf-2 option
26514) Source code disply only assembled code from vasm with option -dwarf
26615) After a new breakpoint set, the breakpoint list window is not refreshed
267-- User must perform an operation, such code tracing, to see the breakpoints list update
26816) Some ASCII characters may be not displayed correctly
aae93d86 269-- Probably depend how the text is displayed, this is related to the Qt/HTML encoding done when reading DWARF file
24470541 27017) Potential legacy crash when leaving emulator in pause mode for a long period of time
aae93d86 271-- Need much investigation
273Cosmetic / UX issues
2751) The SP (Stack) icon color backgound doesn't look similar with the other ones
2762) The SP (Stack) browser size always open at a forced size no matter if the size has been changed
2773) Not every features have associated key bindings
279Legacy issues/hints
2811) Emulator seems to have easter egg(s)
282-- The option --yarrr displays a single message and end the application
283-- Pressing F8, while in the main window, will create an extra message in the log file
2842) The --alpine option force the log file but it can be override if --no-log option is set after the --alpine option
286Project information
2881) Code based on the Shamus Hammons source code available via Gethub by the 12th September 2017 (2.1.3 Final)
2892) Visual Studio 2017 project support for 64 bits
2903) libelf 0.8.13 library 64bits for VS 2017
40692bae 2914) libdwarf 20210305 library 64bits for VS 2017
2925) Qt 5.12.0 library 64bits for VS 2017
2936) Zlib 1.2.11 library 64bits for VS 2017
2947) SDL 1.2.15 library 64bits for VS 2017
2958) The original make files have been modified to follow the requirements and modifications
2969) The 'Rx' word has been added to the emulator name to make distinction with the official version
29710) The project is set at
29811) GPLv3 file document has been renamed as LICENSE, to fit better the GitHub requirements
1081a838 299-- Text / License terms are the same
adf158c7 30014) The x86 configuration has been removed in the VS 2017 project
303Download statistics
305jaguar64eu : 15 downloads for the Release 0 on the 12th Feb, 2017
306jaguar64eu : 18 downloads for the Release 1 on the 21st May, 2017
307No downloads statistics available for the Release 2
308No downloads statistics available for the Release 3